X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/98fcf9f030a152fb946c3860abc7b7d748d6f1a5..0ca27f465b3af0a69ec3731b2f44527cc9cc1d72:/src/xbt/log.c diff --git a/src/xbt/log.c b/src/xbt/log.c index 3b415be648..23d0f2d474 100644 --- a/src/xbt/log.c +++ b/src/xbt/log.c @@ -2,34 +2,138 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Authors: Martin Quinson */ -/* Copyright (C) 2003, 2004 Martin Quinson. */ +/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it - under the terms of the license (GNU LGPL) which comes with this package. */ + * under the terms of the license (GNU LGPL) which comes with this package. */ - -#include "gros_interface.h" -#include "gras_private.h" #include -#include #include +#include "xbt_modinter.h" + +#include "xbt/misc.h" +#include "xbt/sysdep.h" +#include "xbt/log.h" +#include "xbt/error.h" +#include "xbt/dynar.h" + + +/* +FAIRE DES ZOLIS LOGS +-------------------- +Dans gras, tu ne te contente pas d'écrire des choses à l'écran, mais tu +écris sur un sujet particulier (notion de canal) des choses d'une gravité +particulière. Il y a 7 niveaux de gravité. + trace: tracer les entrées dans une fonction, retour de fonction + (famille de macros XBT_IN/XBT_OUT) + debug: pour t'aider à mettre au point le module, potentiellement tres bavard + verbose: quelques infos succintes sur les internals du module + info: niveau normal, ton de la conversation + warning: problème potentiel, mais auquel on a su faire face + error: problème qui t'as empêché de faire ton job + critical: juste avant de mourir + +Quand on compile avec -DNDEBUG (par défaut dans le paquet Debian), tout ce +qui est '>= verbose' est supprimé au moment de la compilation. Retiré du +binaire, killé. + +Ensuite, tu écris dans un canal particulier. Tous les canaux sont rangés en +arbre. Il faudrait faire un ptit script qui fouille les sources à la +recherche des macros XBT_LOG_NEW_* utilisées pour créer des canaux. Le +dernier argument de ces macros est ignoré dans le source. Il est destiné à +être la documentation de la chose en une ligne. En gros, ca fait: +root + +--xbt + | +--config + | +--dict + | | +--dict_cursor + | | +--dict_elm + | | ... + | +--dynar + | +--set + | +--log + | +--module + +--gras + +--datadesc + | +--ddt_cbps + | +--ddt_convert + | +--ddt_exchange + | +--ddt_parse + | +--lexer + +--msg + +--transport + +--raw_trp (Je devrais tuer ce module, un jour) + +--trp_buf + +--trp_sg + +--trp_file + +--trp_tcp + +Et ensuite les utilisateurs peuvent choisir le niveau de gravité qui les +interresse sur tel ou tel sujet. + +Toute la mécanique de logging repose sur des variables statiques dont le nom +dépend du nom du canal. + => attention aux conflits de nom de canal + => il faut une macro XBT_LOG dans chaque fichier où tu fais des logs. + +XBT_LOG_NEW_CATEGORY: nouveau canal sous "root". Rare, donc. +XBT_LOG_NEW_SUBCATEGORY: nouveau canal dont on précise le père. +XBT_LOG_DEFAULT_CATEGORY: indique quel est le canal par défaut dans ce fichier +XBT_LOG_NEW_DEFAULT_CATEGORY: Crèe un canal et l'utilise par défaut +XBT_LOG_NEW_DEFAULT_SUBCATEGORY: devine +XBT_LOG_EXTERNAL_CATEGORY: quand tu veux utiliser par défaut un canal créé + dans un autre fichier. + +Une fois que ton canal est créé, tu l'utilise avec les macros LOG, DEBUG, +VERB, WARN, ERROR et CRITICAL. Il faut que tu donne le nombre d'arguments +après le nom de macro. Exemple: LOG2("My name is %s %s","Martin","Quinson") +Si tu veux préciser explicitement le canal où écrire, ajoute un C devant le +nom de la macro. Exemple: CCRITICAL0(module, "Cannot initialize GRAS") + +Toutes ces macros (enfin, ce en quoi elles se réécrivent) vérifient leurs +arguments comme printf le fait lorsqu'on compile avec gcc. +LOG1("name: %d","toto"); donne un warning, et donc une erreur en mode +mainteneur. + +Enfin, tu peux tester si un canal est ouvert à une priorité donnée (pour +préparer plus de débug, par exemple. Dans le parseur, je fais du pretty +printing sur ce qu'il faut parser dans ce cas). +XBT_LOG_ISENABLED(catName, priority) Le second argument doit être une valeur +de e_xbt_log_priority_t (log.h). Par exemple: xbt_log_priority_verbose + +Voila sur comment mettre des logs dans ton code. N'hesite pas à faire pleins +de canaux différents pour des aspects différents de ton code. En +particulier, dans les dict, j'ai un canal pour l'ajout, le retrait, le +netoyage du code après suppression et ainsi de suite. De cette façon, je +peux choisir qui m'interresse. + + +Pour utiliser les logs, tu déjà faire, non ? Tu colle sur la ligne de +commande un ou plusieurs arguments de la forme + --gras-log=" [+]" (ou sans " si t'as pas d'espace) +chaque réglage étant de la forme: + .thres= +Les différents réglages sont lus de gauche à droite. +"root.thres=debug root.thres=critical" ferme tout, normalement. + +*/ + typedef struct { char *catname; - gras_log_priority_t thresh; -} gras_log_setting_t; + e_xbt_log_priority_t thresh; +} s_xbt_log_setting_t,*xbt_log_setting_t; -static gras_dynar_t *gras_log_settings=NULL; +static xbt_dynar_t xbt_log_settings=NULL; static void _free_setting(void *s) { - gras_log_setting_t *set=(gras_log_setting_t*)s; + xbt_log_setting_t set=(xbt_log_setting_t)s; if (set) { - gras_free(set->catname); -// free(set); FIXME: uncommenting this leads to segfault when more than one chunk is passed as gras-log + xbt_free(set->catname); +/* xbt_free(set); FIXME: uncommenting this leads to segfault when more than one chunk is passed as gras-log */ } } -const char *gras_log_priority_names[8] = { +const char *xbt_log_priority_names[8] = { "NONE", "TRACE", "DEBUG", @@ -40,63 +144,99 @@ const char *gras_log_priority_names[8] = { "CRITICAL" }; -gras_log_category_t _GRAS_LOGV(GRAS_LOG_ROOT_CAT) = { +s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = { 0, 0, 0, - "root", gras_log_priority_uninitialized, 0, + "root", xbt_log_priority_uninitialized, 0, NULL, 0 }; -GRAS_LOG_NEW_SUBCATEGORY(gras,GRAS_LOG_ROOT_CAT,"All GRAS categories"); -GRAS_LOG_NEW_SUBCATEGORY(gros,GRAS_LOG_ROOT_CAT,"All GROS categories (gras toolbox)"); -GRAS_LOG_NEW_DEFAULT_SUBCATEGORY(log,gros,"Loggings from the logging mecanism itself"); +XBT_LOG_NEW_SUBCATEGORY(xbt,XBT_LOG_ROOT_CAT,"All XBT categories (simgrid toolbox)"); +XBT_LOG_NEW_SUBCATEGORY(surf,XBT_LOG_ROOT_CAT,"All SURF categories"); +XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mecanism itself"); + +void xbt_log_init(int *argc,char **argv, const char *defaultlog) { + int i,j; + char *opt; + int found=0; + + /** Set logs and init log submodule */ + for (i=1; i<*argc; i++) { + if (!strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) || + !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) || + !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) || + !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))) { + found = 1; + opt=strchr(argv[i],'='); + opt++; + xbt_log_control_set(opt); + DEBUG1("Did apply '%s' as log setting",opt); + /*remove this from argv*/ + for (j=i+1; j<*argc; j++) { + argv[j-1] = argv[j]; + } + argv[j-1] = NULL; + (*argc)--; + i--; /* compensate effect of next loop incrementation */ + } + } + if (!found && defaultlog) { + xbt_log_control_set(defaultlog); + } +} + +void xbt_log_exit(void) { + VERB0("Exiting log"); + xbt_dynar_free(&xbt_log_settings); + VERB0("Exited log"); +} -static void _apply_control(gras_log_category_t* cat) { +static void _apply_control(xbt_log_category_t cat) { int cursor; - gras_log_setting_t *setting=NULL; + xbt_log_setting_t setting=NULL; int found = 0; - if (!gras_log_settings) + if (!xbt_log_settings) return; - gras_assert0(cat,"NULL category"); - gras_assert(cat->name); + xbt_assert0(cat,"NULL category"); + xbt_assert(cat->name); - gras_dynar_foreach(gras_log_settings,cursor,setting) { - gras_assert0(setting,"Damnit, NULL cat in the list"); - gras_assert1(setting->catname,"NULL setting(=%p)->catname",setting); + xbt_dynar_foreach(xbt_log_settings,cursor,setting) { + xbt_assert0(setting,"Damnit, NULL cat in the list"); + xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting); if (!strcmp(setting->catname,cat->name)) { found = 1; - gras_log_threshold_set(cat, setting->thresh); - gras_dynar_cursor_rm(gras_log_settings,&cursor); + xbt_log_threshold_set(cat, setting->thresh); + xbt_dynar_cursor_rm(xbt_log_settings,&cursor); - if (cat->threshold <= gras_log_priority_verbose) { - gras_log_event_t _log_ev = - {cat,gras_log_priority_verbose,__FILE__,__FUNCTION__,__LINE__}; - _gras_log_event_log(&_log_ev, + if (cat->threshold <= xbt_log_priority_verbose) { + s_xbt_log_event_t _log_ev = + {cat,xbt_log_priority_verbose,__FILE__,_XBT_GNUC_FUNCTION,__LINE__}; + _xbt_log_event_log(&_log_ev, "Apply settings for category '%s': set threshold to %s (=%d)", cat->name, - gras_log_priority_names[cat->threshold], cat->threshold); + xbt_log_priority_names[cat->threshold], cat->threshold); } } } - if (!found && cat->threshold <= gras_log_priority_verbose) { - gras_log_event_t _log_ev = - {cat,gras_log_priority_verbose,__FILE__,__FUNCTION__,__LINE__}; - _gras_log_event_log(&_log_ev, + if (!found && cat->threshold <= xbt_log_priority_verbose) { + s_xbt_log_event_t _log_ev = + {cat,xbt_log_priority_verbose,__FILE__,_XBT_GNUC_FUNCTION,__LINE__}; + _xbt_log_event_log(&_log_ev, "Category '%s': inherited threshold = %s (=%d)", cat->name, - gras_log_priority_names[cat->threshold], cat->threshold); + xbt_log_priority_names[cat->threshold], cat->threshold); } } -void _gras_log_event_log( gras_log_event_t* ev, const char *fmt, ...) { - gras_log_category_t* cat = ev->cat; +void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) { + xbt_log_category_t cat = ev->cat; va_start(ev->ap, fmt); while(1) { - gras_log_appender_t* appender = cat->appender; + xbt_log_appender_t appender = cat->appender; if (appender != NULL) { appender->do_append(appender, ev, fmt); } @@ -108,12 +248,12 @@ void _gras_log_event_log( gras_log_event_t* ev, const char *fmt, ...) { va_end(ev->ap); } -static void _cat_init(gras_log_category_t* category) { - if (category == &_GRAS_LOGV(GRAS_LOG_ROOT_CAT)) { - category->threshold = gras_log_priority_info; - category->appender = gras_log_default_appender; +static void _cat_init(xbt_log_category_t category) { + if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) { + category->threshold = xbt_log_priority_info; + category->appender = xbt_log_default_appender; } else { - gras_log_parent_set(category, category->parent); + xbt_log_parent_set(category, category->parent); } _apply_control(category); } @@ -123,72 +263,72 @@ static void _cat_init(gras_log_category_t* category) { * initialization. * Also resets threshold to inherited! */ -int _gras_log_cat_init(gras_log_priority_t priority, - gras_log_category_t* category) { +int _xbt_log_cat_init(e_xbt_log_priority_t priority, + xbt_log_category_t category) { _cat_init(category); return priority >= category->threshold; } -void gras_log_parent_set(gras_log_category_t* cat, - gras_log_category_t* parent) { +void xbt_log_parent_set(xbt_log_category_t cat, + xbt_log_category_t parent) { - gras_assert0(cat,"NULL category to be given a parent"); - gras_assert1(parent,"The parent category of %s is NULL",cat->name); + xbt_assert0(cat,"NULL category to be given a parent"); + xbt_assert1(parent,"The parent category of %s is NULL",cat->name); - // unlink from current parent - if (cat->threshold != gras_log_priority_uninitialized) { - gras_log_category_t** cpp = &parent->firstChild; + /* unlink from current parent */ + if (cat->threshold != xbt_log_priority_uninitialized) { + xbt_log_category_t* cpp = &parent->firstChild; while(*cpp != cat && *cpp != NULL) { cpp = &(*cpp)->nextSibling; } - assert(*cpp == cat); + xbt_assert(*cpp == cat); *cpp = cat->nextSibling; } - // Set new parent + /* Set new parent */ cat->parent = parent; cat->nextSibling = parent->firstChild; parent->firstChild = cat; - // Make sure parent is initialized - if (parent->threshold == gras_log_priority_uninitialized) { + /* Make sure parent is initialized */ + if (parent->threshold == xbt_log_priority_uninitialized) { _cat_init(parent); } - // Reset priority + /* Reset priority */ cat->threshold = parent->threshold; cat->isThreshInherited = 1; -} // log_setParent +} /* log_setParent */ -static void _set_inherited_thresholds(gras_log_category_t* cat) { - gras_log_category_t* child = cat->firstChild; +static void _set_inherited_thresholds(xbt_log_category_t cat) { + xbt_log_category_t child = cat->firstChild; for( ; child != NULL; child = child->nextSibling) { if (child->isThreshInherited) { - if (cat != &_GRAS_LOGV(log)) + if (cat != &_XBT_LOGV(log)) VERB3("Set category threshold of %s to %s (=%d)", - child->name,gras_log_priority_names[cat->threshold],cat->threshold); + child->name,xbt_log_priority_names[cat->threshold],cat->threshold); child->threshold = cat->threshold; _set_inherited_thresholds(child); } } } -void gras_log_threshold_set(gras_log_category_t* cat, - gras_log_priority_t threshold) { +void xbt_log_threshold_set(xbt_log_category_t cat, + e_xbt_log_priority_t threshold) { cat->threshold = threshold; cat->isThreshInherited = 0; _set_inherited_thresholds(cat); } -static gras_error_t _gras_log_parse_setting(const char* control_string, - gras_log_setting_t *set) { +static void _xbt_log_parse_setting(const char* control_string, + xbt_log_setting_t set) { const char *name, *dot, *eq; set->catname=NULL; if (!*control_string) - return no_error; + return; DEBUG1("Parse log setting '%s'",control_string); control_string += strspn(control_string, " "); @@ -199,12 +339,12 @@ static gras_error_t _gras_log_parse_setting(const char* control_string, eq = control_string; control_string += strcspn(control_string, " "); - gras_assert1(*dot == '.' && *eq == '=', + xbt_assert1(*dot == '.' && *eq == '=', "Invalid control string '%s'",control_string); if (!strncmp(dot + 1, "thresh", min(eq - dot - 1,strlen("thresh")))) { int i; - char *neweq=strdup(eq+1); + char *neweq=xbt_strdup(eq+1); char *p=neweq-1; while (*(++p) != '\0') { @@ -214,42 +354,41 @@ static gras_error_t _gras_log_parse_setting(const char* control_string, } DEBUG1("New priority name = %s",neweq); - for (i=0; ithresh=i; } else { - gras_assert1(FALSE,"Unknown priority name: %s",eq+1); + xbt_assert1(FALSE,"Unknown priority name: %s",eq+1); } - gras_free(neweq); + xbt_free(neweq); } else { char buff[512]; snprintf(buff,min(512,eq - dot - 1),"%s",dot+1); - gras_assert1(FALSE,"Unknown setting of the log category: %s",buff); + xbt_assert1(FALSE,"Unknown setting of the log category: %s",buff); } - if (!(set->catname=(char*)gras_malloc(dot - name+1))) - RAISE_MALLOC; + set->catname=(char*)xbt_malloc(dot - name+1); strncpy(set->catname,name,dot-name); set->catname[dot-name]='\0'; /* Just in case */ DEBUG1("This is for cat '%s'", set->catname); - return no_error; } -static gras_error_t _gras_log_cat_searchsub(gras_log_category_t *cat,char *name,gras_log_category_t**whereto) { - gras_error_t errcode; - gras_log_category_t *child; +static xbt_error_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name, + /*OUT*/xbt_log_category_t*whereto) { + xbt_error_t errcode; + xbt_log_category_t child; if (!strcmp(cat->name,name)) { *whereto=cat; return no_error; } for(child=cat->firstChild ; child != NULL; child = child->nextSibling) { - errcode=_gras_log_cat_searchsub(child,name,whereto); + errcode=_xbt_log_cat_searchsub(child,name,whereto); if (errcode==no_error) return no_error; } @@ -289,9 +428,8 @@ static void _cleanup_double_spaces(char *s) { } /** - * gras_log_control_set: - * @cs: What to parse - * @Returns: malloc_error or no_error + * \ingroup XBT_log + * \param control_string What to parse * * Typically passed a command-line argument. The string has the syntax: * @@ -303,33 +441,31 @@ static void _cleanup_double_spaces(char *s) { * thresh value is an integer priority level. Sets the category's * threshold priority. * - * @warning + * \warning * This routine may only be called once and that must be before any other * logging command! Typically, this is done from main(). */ -gras_error_t gras_log_control_set(const char* control_string) { - gras_error_t errcode; - gras_log_setting_t *set; +void xbt_log_control_set(const char* control_string) { + xbt_error_t errcode; + xbt_log_setting_t set; char *cs; char *p; int done = 0; DEBUG1("Parse log settings '%s'",control_string); if (control_string == NULL) - return no_error; - if (gras_log_settings == NULL) - TRY(gras_dynar_new(&gras_log_settings,sizeof(gras_log_setting_t*), - _free_setting)); + return; + if (xbt_log_settings == NULL) + xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), + _free_setting); - if (! (set = gras_new(gras_log_setting_t,1)) ) - RAISE_MALLOC; + set = xbt_new(s_xbt_log_setting_t,1); + cs=xbt_strdup(control_string); - if (!(cs=strdup(control_string))) - RAISE_MALLOC; _cleanup_double_spaces(cs); while (!done) { - gras_log_category_t *cat; + xbt_log_category_t cat; p=strrchr(cs,' '); if (p) { @@ -339,40 +475,26 @@ gras_error_t gras_log_control_set(const char* control_string) { p=cs; done = 1; } - errcode = _gras_log_parse_setting(p,set); - if (errcode != no_error) { - gras_free(set); - gras_free(cs); - } + _xbt_log_parse_setting(p,set); - TRYCATCH(_gras_log_cat_searchsub(&_GRAS_LOGV(root),set->catname,&cat), - mismatch_error); + errcode = _xbt_log_cat_searchsub(&_XBT_LOGV(root),set->catname,&cat); if (errcode == mismatch_error) { DEBUG0("Store for further application"); - DEBUG1("push %p to the settings",set); - TRY(gras_dynar_push(gras_log_settings,&set)); + DEBUG1("push %p to the settings",(void*)set); + xbt_dynar_push(xbt_log_settings,&set); /* malloc in advance the next slot */ - if (!(set = gras_new(gras_log_setting_t,1))) { - gras_free(cs); - RAISE_MALLOC; - } + set = xbt_new(s_xbt_log_setting_t,1); } else { DEBUG0("Apply directly"); - gras_free(set->catname); - gras_log_threshold_set(cat,set->thresh); + xbt_free(set->catname); + xbt_log_threshold_set(cat,set->thresh); } } - gras_free(set); - gras_free(cs); - return no_error; + xbt_free(set); + xbt_free(cs); } -void gras_log_appender_set(gras_log_category_t* cat, gras_log_appender_t* app) { +void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) { cat->appender = app; } -void gras_log_exit(void) { - VERB0("Exiting log"); - gras_dynar_free(gras_log_settings); - VERB0("Exited log"); -}