3 /* log - a generic logging facility in the spirit of log4j */
5 /* Copyright (c) 2003-2007 Martin Quinson. All rights reserved. */
7 /* This program is free software; you can redistribute it and/or modify it
8 * under the terms of the license (GNU LGPL) which comes with this package. */
13 #include <stdio.h> /* snprintf */
14 #include <stdlib.h> /* snprintf */
16 #include "portable.h" /* to get a working stdarg.h */
18 #include "xbt_modinter.h"
23 #include "xbt/sysdep.h"
24 #include "xbt/log_private.h"
25 #include "xbt/dynar.h"
27 XBT_PUBLIC_DATA(int) (*xbt_pid)();
29 /** \addtogroup XBT_log
31 * This section describes the API to the log functions used
32 * everywhere in this project.
34 \section XBT_log_toc Table of contents
44 - \ref log_API_isenabled
47 - \ref log_API_example
50 - \ref log_use_conf_thres
51 - \ref log_use_conf_multi
52 - \ref log_use_conf_fmt
53 - \ref log_use_conf_app
54 - \ref log_use_conf_add
61 \section log_overview 1. Introduction
63 This module is in charge of handling the log messages of every SimGrid
64 program. The main design goal are:
66 - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
67 what to hide, as well as how messages get displayed.
68 - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
69 and to the user (with command line options)
70 - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
71 - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
72 and the logging mechanism allows to syndicate each and every log source into the same place.
73 At least, its design would allow to, once we write the last missing pieces
75 There is three main concepts in SimGrid's logging mechanism: <i>category</i>,
76 <i>priority</i> and <i>appender</i>. These three concepts work together to
77 enable developers to log messages according to message type and priority, and
78 to control at runtime how these messages are formatted and where they are
81 \subsection log_cat 1.1 Category hierarchy
83 The first and foremost advantage of any logging API over plain printf()
84 resides in its ability to disable certain log statements while allowing
85 others to print unhindered. This capability assumes that the logging space,
86 that is, the space of all possible logging statements, is categorized
87 according to some developer-chosen criteria.
89 This observation led to choosing category as the central concept of the
90 system. In a certain sense, they can be considered as logging topics or
93 \subsection log_pri 1.2 Logging priorities
95 The user can naturally declare interest into this or that logging category, but
96 he also can specify the desired level of details for each of them. This is
97 controlled by the <i>priority</i> concept (which should maybe be renamed to
100 Empirically, the user can specify that he wants to see every debugging message
101 of GRAS while only being interested into the messages at level "error" or
102 higher about the XBT internals.
104 \subsection log_app 1.3 Message appenders
106 The message appenders are the elements in charge of actually displaying the
107 message to the user. For now, only two appenders exist: the default one prints
108 stuff on stderr while it is possible to create appenders printing to a specific
111 Other are planed (such as the one sending everything to a remote server,
112 or the one using only a fixed amount of lines in a file, and rotating content on
113 need). One day, for sure ;)
115 \subsection log_lay 1.4 Message layouts
117 The message layouts are the elements in charge of choosing how each message
118 will look like. Their result is a string which is then passed to the appender
119 attached to the category to be displayed.
121 For now, there is two layouts: The simple one, which is good for most cases,
122 and another one allowing users to specify the format they want.
123 \ref log_use_conf provides more info on this.
125 \subsection log_hist 1.5 History of this module
127 Historically, this module is an adaptation of the log4c project, which is dead
128 upstream, and which I was given the permission to fork under the LGPL licence
129 by the log4c's authors. The log4c project itself was loosely based on the
130 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
131 differs somehow from these projects anyway, because the C programming language
132 is not object oriented.
134 \section log_API 2. Programmer interface
136 \subsection log_API_cat 2.1 Constructing the category hierarchy
138 Every category is declared by providing a name and an optional
139 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
140 the category's parent.
142 A category is created by a macro call at the top level of a file. A
143 category can be created with any one of the following macros:
145 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
146 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
147 Create a new category being child of the category ParentCat
148 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
149 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
151 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
152 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
155 The parent cat can be defined in the same file or in another file (in
156 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
157 it visible in the current file), but each category may have only one
160 Typically, there will be a Category for each module and sub-module, so you
161 can independently control logging for each module.
163 For a list of all existing categories, please refer to the \ref XBT_log_cats
164 section. This file is generated automatically from the SimGrid source code, so
165 it should be complete and accurate.
167 \section log_API_pri 2.2 Declaring message priority
169 A category may be assigned a threshold priority. The set of priorities are
170 defined by the \ref e_xbt_log_priority_t enum. All logging request under
171 this priority will be discarded.
173 If a given category is not assigned a threshold priority, then it inherits
174 one from its closest ancestor with an assigned threshold. To ensure that all
175 categories can eventually inherit a threshold, the root category always has
176 an assigned threshold priority.
178 Logging requests are made by invoking a logging macro on a category. All of
179 the macros have a printf-style format string followed by arguments. If you
180 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
181 when you pass a pointer to a string where an integer was specified by the
182 format. This is usually a good idea.
184 Because some C compilers do not support vararg macros, there is a version of
185 the macro for any number of arguments from 0 to 6. The macro name ends with
186 the total number of arguments.
188 Here is an example of the most basic type of macro. This is a logging
189 request with priority <i>warning</i>.
191 <code>CLOG5(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
194 A logging request is said to be enabled if its priority is higher than or
195 equal to the threshold priority of its category. Otherwise, the request is
196 said to be disabled. A category without an assigned priority will inherit
197 one from the hierarchy.
199 It is possible to use any non-negative integer as a priority. If, as in the
200 example, one of the standard priorities is used, then there is a convenience
201 macro that is typically used instead. For example, the above example is
202 equivalent to the shorter:
204 <code>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
206 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
208 It is sometimes useful to check whether a particular category is
209 enabled at a particular priority. One example is when you want to do
210 some extra computation to prepare a nice debugging message. There is
211 no use of doing so if the message won't be used afterward because
212 debugging is turned off.
214 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
216 \section log_API_subcat 2.4 Using a default category (the easy interface)
218 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
219 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
220 category, then the even shorter form can be used:
222 <code>WARN3("Values are: %s and '%d'", 5, "oops");</code>
224 Only one default category can be created per file, though multiple
225 non-defaults can be created and used.
227 \section log_API_easy 2.5 Putting all together: the easy interface
229 First of all, each module should register its own category into the categories
230 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
232 Then, logging should be done with the DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
233 ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB10,
234 #INFO10, #WARN10, #ERROR10 and #CRITICAL10). For each group, there is at
235 least 11 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
236 DEBUG5, DEBUG6, DEBUG7, DEBUG8, DEBUG9, DEBUG10), only differing in the number of arguments passed along the format.
237 This is because we want SimGrid itself to keep compilable on ancient
238 compiler not supporting variable number of arguments to macros. But we
239 should provide a macro simpler to use for the users not interested in SP3
242 Under GCC, these macro check there arguments the same way than printf does. So,
243 if you compile with -Wall, the following code will issue a warning:
244 <code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
246 If you want to specify the category to log onto (for example because you
247 have more than one category per file, add a C before the name of the log
248 producing macro (ie, use #CDEBUG10, #CVERB10, #CINFO10, #CWARN10, #CERROR10 and
249 #CCRITICAL10 and friends), and pass the category name as first argument.
251 The TRACE priority is not used the same way than the other. You should use
252 the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
255 \section log_API_example 2.6 Example of use
257 Here is a more complete example:
262 / * create a category and a default subcategory * /
263 XBT_LOG_NEW_CATEGORY(VSS);
264 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
267 / * Now set the parent's priority. (the string would typcially be a runtime option) * /
268 xbt_log_control_set("SA.thresh:3");
270 / * This request is enabled, because WARNING >= INFO. * /
271 CWARN2(VSS, "Low fuel level.");
273 / * This request is disabled, because DEBUG < INFO. * /
274 CDEBUG2(VSS, "Starting search for nearest gas station.");
276 / * The default category SA inherits its priority from VSS. Thus,
277 the following request is enabled because INFO >= INFO. * /
278 INFO1("Located nearest gas station.");
280 / * This request is disabled, because DEBUG < INFO. * /
281 DEBUG1("Exiting gas station search");
285 Another example can be found in the relevant part of the GRAS tutorial:
286 \ref GRAS_tut_tour_logs.
288 \section log_user 3. User interface
290 \section log_use_conf 3.1 Configuration
292 Although rarely done, it is possible to configure the logs during
293 program initialization by invoking the xbt_log_control_set() method
294 manually. A more conventional way is to use the --log command line
295 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
296 checks and deals properly with such arguments.
298 The following command line arguments exist, but are deprecated and
299 may disappear in the future: --xbt-log, --gras-log, --msg-log and
302 \subsection log_use_conf_thres 3.1.1 Threshold configuration
304 The most common setting is to control which logging event will get
305 displayed by setting a threshold to each category through the
306 <tt>thres</tt> keyword.
308 For example, \verbatim --log=root.thres:debug\endverbatim will make
309 SimGrid <b>extremely</b> verbose while \verbatim
310 --log=root.thres:critical\endverbatim should shut it almost
313 \subsection log_use_conf_multi 3.1.2 Passing several settings
315 You can provide several of those arguments to change the setting of several
316 categories, they will be applied from left to right. So,
317 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
318 disable almost any logging.
320 Note that the quotes on above line are mandatory because there is a space in
321 the argument, so we are protecting ourselves from the shell, not from SimGrid.
322 We could also reach the same effect with this:
323 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
325 \subsection log_use_conf_fmt 3.1.3 Format configuration
327 As with SimGrid 3.3, it is possible to control the format of log
328 messages. This is done through the <tt>fmt</tt> keyword. For example,
329 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
330 user-message only, removing any decoration such as the date, or the
331 process ID, everything.
333 Here are the existing format directives:
336 - %%n: platform-dependent line separator (LOG4J compatible)
337 - %%e: plain old space (SimGrid extension)
339 - %%m: user-provided message
341 - %%c: Category name (LOG4J compatible)
342 - %%p: Priority name (LOG4J compatible)
344 - %%h: Hostname (SimGrid extension)
345 - %%P: Process name (SimGrid extension)
346 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
347 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
349 - %%F: file name where the log event was raised (LOG4J compatible)
350 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
351 - %%L: line number where the log event was raised (LOG4J compatible)
352 - %%M: function name (LOG4J compatible -- called method name here of course).
353 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
355 - %%b: full backtrace (Called %%throwable in LOG4J).
356 Defined only under windows or when using the GNU libc because backtrace() is not defined
357 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
358 - %%B: short backtrace (only the first line of the %%b).
359 Called %%throwable{short} in LOG4J; defined where %%b is.
361 - %%d: date (UNIX-like epoch)
362 - %%r: application age (time elapsed since the beginning of the application)
365 If you want to mimic the simple layout with the format one, you would use this
366 format: '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
367 because the simple layout do not display the message location for messages at
368 priority INFO (thus, the fmt is '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n' in this
369 case). Moreover, if there is no process name (ie, messages coming from the
370 library itself, or test programs doing strange things) do not display the
371 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
372 [%%c/%%p] %%m%%n' if they are at priority INFO).
374 For now, there is only one format modifier: the precision field. You
375 can for example specify %.4r to get the application age with 4
376 numbers after the radix. Another limitation is that you cannot set
377 specific layouts to the several priorities.
379 \subsection log_use_conf_app 3.1.4 Category appender
381 As with SimGrid 3.3, it is possible to control the appender of log
382 messages. This is done through the <tt>app</tt> keyword. For example,
383 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
384 to the file mylogfile.
386 Any appender setup this way have its own layout format (simple one by default),
387 so you may have to change it too afterward. Moreover, the additivity of the log category
388 is also set to false to prevent log event displayed by this appender to "leak" to any other
389 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
392 \subsection log_use_conf_add 3.1.5 Category additivity
394 The <tt>add</tt> keyword allows to specify the additivity of a
395 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
396 and 'off' are all valid values, with 'yes' as default.
398 The following example resets the additivity of the xbt category to true (which is its default value).
399 \verbatim --log=xbt.add:yes\endverbatim
401 \section log_use_misc 3.2 Misc and Caveats
403 - Do not use any of the macros that start with '_'.
404 - Log4J has a 'rolling file appender' which you can select with a run-time
405 option and specify the max file size. This would be a nice default for
406 non-kernel applications.
407 - Careful, category names are global variables.
409 \section log_internals 4. Internal considerations
411 This module is a mess of macro black magic, and when it goes wrong,
412 SimGrid studently loose its ability to explain its problems. When
413 messing around this module, I often find useful to define
414 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
415 of finding what's going wrong. But things are quite verbose when
416 everything is enabled...
418 \section log_in_perf 4.1 Performance
420 Except for the first invocation of a given category, a disabled logging request
421 requires an a single comparison of a static variable to a constant.
423 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
424 causes all logging requests with a lower priority to be optimized to 0 cost
425 by the compiler. By setting it to gras_log_priority_infinite, all logging
426 requests are statically disabled at compile time and cost nothing. Released executables
427 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
428 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
430 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
431 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
432 the requests of priority below INFO.
434 \todo Logging performance *may* be improved further by improving the message
435 propagation from appender to appender in the category tree.
437 \section log_in_app 4.2 Appenders
439 Each category has an optional appender. An appender is a pointer to a
440 structure which starts with a pointer to a do_append() function. do_append()
441 prints a message to a log.
443 When a category is passed a message by one of the logging macros, the
444 category performs the following actions:
446 - if the category has an appender, the message is passed to the
447 appender's do_append() function,
448 - if additivity is true for the category, the message is passed to
449 the category's parent. Additivity is true by default, and can be
450 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
451 Also, when you add an appender to a category, its additivity is automatically turned to off.
452 Turn it back on afterward if it is not what you wanted.
454 By default, only the root category have an appender, and any other category has
455 its additivity set to true. This causes all messages to be logged by the root
458 The default appender function currently prints to stderr, and the only other
459 existing one writes to the specified file. More would be needed, like the one
460 able to send the logs to a remote dedicated server.
461 This is on our TODO list for quite a while now, but your help would be
468 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
469 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
474 e_xbt_log_priority_t thresh;
477 xbt_log_appender_t appender;
478 } s_xbt_log_setting_t,*xbt_log_setting_t;
480 static xbt_dynar_t xbt_log_settings=NULL;
482 static void _free_setting(void *s) {
483 xbt_log_setting_t set=*(xbt_log_setting_t*)s;
491 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
492 xbt_log_setting_t setting);
494 const char *xbt_log_priority_names[8] = {
505 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
506 NULL /*parent*/, NULL /* firstChild */, NULL /* nextSibling */,
507 "root", xbt_log_priority_uninitialized /* threshold */,
508 0 /* isThreshInherited */,
509 NULL /* appender */, NULL /* layout */,
513 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
514 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
515 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
516 XBT_LOG_NEW_CATEGORY(simix,"All SIMIX categories");
518 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
520 /** @brief Get all logging settings from the command line
522 * xbt_log_control_set() is called on each string we got from cmd line
524 void xbt_log_init(int *argc,char **argv) {
528 /* create the default appender and install it in the root category,
529 which were already created (damnit. Too slow little beetle)*/
530 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
531 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
532 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
533 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
536 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
538 /* Set logs and init log submodule */
539 for (i=1; i<*argc; i++){
540 if (!strncmp(argv[i],"--log=",strlen("--log=")) ||
541 !strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
542 !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
543 !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
544 !strncmp(argv[i],"--simix-log=",strlen("--simix-log=")) ||
545 !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
547 if (strncmp(argv[i],"--log=",strlen("--log=")))
548 WARN2("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
549 (int)(strchr(argv[i],'=')-argv[i]),argv[i]);
551 opt=strchr(argv[i],'=');
553 xbt_log_control_set(opt);
554 DEBUG1("Did apply '%s' as log setting",opt);
555 /*remove this from argv*/
557 for (j=i+1; j<*argc; j++){
563 i--; /* compensate effect of next loop incrementation */
568 static void log_cat_exit(xbt_log_category_t cat) {
569 xbt_log_category_t child;
572 if (cat->appender->free_)
573 cat->appender->free_(cat->appender);
577 if (cat->layout->free_)
578 cat->layout->free_(cat->layout);
582 for(child=cat->firstChild ; child != NULL; child = child->nextSibling)
586 void xbt_log_exit(void) {
587 VERB0("Exiting log");
588 xbt_dynar_free(&xbt_log_settings);
589 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
593 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
595 xbt_log_category_t cat = ev->cat;
597 /* Make sure that the layouts have been malloced */
598 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
599 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
600 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
601 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
605 va_start(ev->ap, fmt);
606 va_start(ev->ap_copy, fmt);
608 xbt_log_appender_t appender = cat->appender;
609 if (appender != NULL) {
610 xbt_assert1(cat->layout,"No valid layout for the appender of category %s",cat->name);
611 cat->layout->do_layout(cat->layout, ev, fmt, appender);
613 if (!cat->additivity)
626 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
627 xbt_log_setting_t setting) {
629 s_xbt_log_event_t _log_ev;
631 if (setting->thresh != xbt_log_priority_uninitialized) {
632 xbt_log_threshold_set(category, setting->thresh);
634 if (category->threshold <= xbt_log_priority_debug) {
635 _log_ev.cat = category;
636 _log_ev.priority = xbt_log_priority_debug;
637 _log_ev.fileName = __FILE__ ;
638 _log_ev.functionName = _XBT_FUNCTION ;
639 _log_ev.lineNum = __LINE__ ;
641 _xbt_log_event_log(&_log_ev,
642 "Apply settings for category '%s': set threshold to %s (=%d)",
644 xbt_log_priority_names[category->threshold],
645 category->threshold);
650 xbt_log_layout_set(category,xbt_log_layout_format_new(setting->fmt));
652 if (category->threshold <= xbt_log_priority_debug) {
653 _log_ev.cat = category;
654 _log_ev.priority = xbt_log_priority_debug;
655 _log_ev.fileName = __FILE__ ;
656 _log_ev.functionName = _XBT_FUNCTION ;
657 _log_ev.lineNum = __LINE__ ;
659 _xbt_log_event_log(&_log_ev,
660 "Apply settings for category '%s': set format to %s",
666 if (setting->additivity != -1) {
667 xbt_log_additivity_set(category,setting->additivity);
669 if (category->threshold <= xbt_log_priority_debug) {
670 _log_ev.cat = category;
671 _log_ev.priority = xbt_log_priority_debug;
672 _log_ev.fileName = __FILE__ ;
673 _log_ev.functionName = _XBT_FUNCTION ;
674 _log_ev.lineNum = __LINE__ ;
676 _xbt_log_event_log(&_log_ev,
677 "Apply settings for category '%s': set additivity to %s",
679 (setting->additivity?"on":"off"));
682 if (setting->appender) {
683 xbt_log_appender_set(category,setting->appender);
684 if (!category->layout)
685 xbt_log_layout_set(category,xbt_log_layout_simple_new(NULL));
686 category->additivity = 0;
687 if (category->threshold <= xbt_log_priority_debug) {
688 _log_ev.cat = category;
689 _log_ev.priority = xbt_log_priority_debug;
690 _log_ev.fileName = __FILE__ ;
691 _log_ev.functionName = _XBT_FUNCTION ;
692 _log_ev.lineNum = __LINE__ ;
694 _xbt_log_event_log(&_log_ev,
695 "Set %p as appender of category '%s'",
703 * This gets called the first time a category is referenced and performs the
705 * Also resets threshold to inherited!
707 int _xbt_log_cat_init(xbt_log_category_t category,
708 e_xbt_log_priority_t priority) {
710 xbt_log_setting_t setting=NULL;
712 s_xbt_log_event_t _log_ev;
714 if (_XBT_LOGV(log).threshold <= xbt_log_priority_debug
715 && _XBT_LOGV(log).threshold != xbt_log_priority_uninitialized) {
716 _log_ev.cat = &_XBT_LOGV(log);
717 _log_ev.priority = xbt_log_priority_debug;
718 _log_ev.fileName = __FILE__ ;
719 _log_ev.functionName = _XBT_FUNCTION ;
720 _log_ev.lineNum = __LINE__ ;
721 _xbt_log_event_log(&_log_ev, "Initializing category '%s' (firstChild=%s, nextSibling=%s)",
723 (category->firstChild ?category->firstChild->name :"none"),
724 (category->nextSibling?category->nextSibling->name:"none"));
727 if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
728 category->threshold = xbt_log_priority_info;/* xbt_log_priority_debug*/;
729 category->appender = xbt_log_default_appender;
730 category->layout = xbt_log_default_layout;
733 if (!category->parent)
734 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
736 if (_XBT_LOGV(log).threshold <= xbt_log_priority_debug
737 && _XBT_LOGV(log).threshold != xbt_log_priority_uninitialized) {
738 _log_ev.lineNum = __LINE__ ;
739 _xbt_log_event_log(&_log_ev, "Set %s (%s) as father of %s ", category->parent->name,
740 (category->parent->threshold == xbt_log_priority_uninitialized ? "uninited":xbt_log_priority_names[category->parent->threshold]),
743 xbt_log_parent_set(category, category->parent);
745 if (_XBT_LOGV(log).threshold < xbt_log_priority_info
746 && _XBT_LOGV(log).threshold != xbt_log_priority_uninitialized) {
748 xbt_log_category_t cpp = category->parent->firstChild;
751 buf = bprintf("%s %s",res,cpp->name);
755 res = xbt_strdup(cpp->name);
757 cpp = cpp->nextSibling;
760 _log_ev.lineNum = __LINE__ ;
761 _xbt_log_event_log(&_log_ev,
762 "Childs of %s: %s; nextSibling: %s", category->parent->name,res,
763 (category->parent->nextSibling?category->parent->nextSibling->name:"none"));
770 /* Apply the control */
771 if (!xbt_log_settings)
772 return priority >= category->threshold;
774 xbt_assert0(category,"NULL category");
775 xbt_assert(category->name);
777 xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
778 xbt_assert0(setting,"Damnit, NULL cat in the list");
779 xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
781 if (!strcmp(setting->catname,category->name)) {
785 _xbt_log_cat_apply_set(category,setting);
787 xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
791 if (!found && category->threshold <= xbt_log_priority_verbose) {
793 _log_ev.cat = &_XBT_LOGV(log);
794 _log_ev.priority = xbt_log_priority_verbose;
795 _log_ev.fileName = __FILE__ ;
796 _log_ev.functionName = _XBT_FUNCTION ;
797 _log_ev.lineNum = __LINE__ ;
799 _xbt_log_event_log(&_log_ev,
800 "Category '%s': inherited threshold = %s (=%d)",
802 xbt_log_priority_names[category->threshold], category->threshold);
805 return priority >= category->threshold;
808 void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent) {
810 xbt_assert0(cat,"NULL category to be given a parent");
811 xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
814 * if the threshold is initialized
815 * unlink from current parent
817 if(cat->threshold != xbt_log_priority_uninitialized){
819 xbt_log_category_t* cpp = &parent->firstChild;
821 while(*cpp != cat && *cpp != NULL) {
822 cpp = &(*cpp)->nextSibling;
825 xbt_assert(*cpp == cat);
826 *cpp = cat->nextSibling;
829 cat->parent = parent;
830 cat->nextSibling = parent->firstChild;
832 parent->firstChild = cat;
834 if (parent->threshold == xbt_log_priority_uninitialized){
836 _xbt_log_cat_init(parent,
837 xbt_log_priority_uninitialized/* ignored*/);
840 cat->threshold = parent->threshold;
842 cat->isThreshInherited = 1;
846 static void _set_inherited_thresholds(xbt_log_category_t cat) {
848 xbt_log_category_t child = cat->firstChild;
850 for( ; child != NULL; child = child->nextSibling) {
851 if (child->isThreshInherited) {
852 if (cat != &_XBT_LOGV(log))
853 VERB3("Set category threshold of %s to %s (=%d)",
854 child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
855 child->threshold = cat->threshold;
856 _set_inherited_thresholds(child);
863 void xbt_log_threshold_set(xbt_log_category_t cat,
864 e_xbt_log_priority_t threshold) {
865 cat->threshold = threshold;
866 cat->isThreshInherited = 0;
868 _set_inherited_thresholds(cat);
872 static xbt_log_setting_t _xbt_log_parse_setting(const char* control_string) {
874 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t,1);
875 const char *name, *dot, *eq;
878 set->thresh = xbt_log_priority_uninitialized;
880 set->additivity = -1;
881 set->appender = NULL;
883 if (!*control_string)
885 DEBUG1("Parse log setting '%s'",control_string);
887 control_string += strspn(control_string, " ");
888 name = control_string;
889 control_string += strcspn(control_string, ".= ");
890 dot = control_string;
891 control_string += strcspn(control_string, ":= ");
893 control_string += strcspn(control_string, " ");
895 xbt_assert1(*dot == '.' && (*eq == '=' || *eq == ':'),
896 "Invalid control string '%s'",control_string);
898 if (!strncmp(dot + 1, "thresh", (size_t)(eq - dot - 1))) {
900 char *neweq=xbt_strdup(eq+1);
903 while (*(++p) != '\0') {
904 if (*p >= 'a' && *p <= 'z') {
909 DEBUG1("New priority name = %s",neweq);
910 for (i=0; i<xbt_log_priority_infinite; i++) {
911 if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
912 DEBUG1("This is priority %d",i);
916 if (i<xbt_log_priority_infinite) {
917 set->thresh= (e_xbt_log_priority_t) i;
920 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",eq+1);
923 } else if ( !strncmp(dot + 1, "add", (size_t)(eq - dot - 1)) ||
924 !strncmp(dot + 1, "additivity", (size_t)(eq - dot - 1)) ) {
926 char *neweq=xbt_strdup(eq+1);
929 while (*(++p) != '\0') {
930 if (*p >= 'a' && *p <= 'z') {
934 if ( !strcmp(neweq,"ON") ||
935 !strcmp(neweq,"YES") ||
936 !strcmp(neweq,"1") ) {
942 } else if ( !strncmp(dot + 1, "app", (size_t)(eq - dot - 1)) ||
943 !strncmp(dot + 1, "appender", (size_t)(eq - dot - 1)) ) {
945 char *neweq=xbt_strdup(eq+1);
947 if ( !strncmp(neweq,"file:",5) ) {
948 set->appender = xbt_log_appender_file_new(neweq+5);
950 THROW1(arg_error,0,"Unknown appender log type: '%s'",neweq);
953 } else if (!strncmp(dot + 1, "fmt", (size_t)(eq - dot - 1))) {
954 set->fmt = xbt_strdup(eq+1);
957 snprintf(buff,min(512,eq - dot),"%s",dot+1);
958 THROW1(arg_error,0,"Unknown setting of the log category: '%s'",buff);
960 set->catname=(char*)xbt_malloc(dot - name+1);
962 memcpy(set->catname,name,dot-name);
963 set->catname[dot-name]='\0'; /* Just in case */
964 DEBUG1("This is for cat '%s'", set->catname);
969 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
970 xbt_log_category_t child,res;
972 DEBUG4("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')",name,cat->name,
973 (cat->firstChild ? cat->firstChild->name :"none"),
974 (cat->nextSibling ? cat->nextSibling->name:"none"));
975 if (!strcmp(cat->name,name))
978 for (child=cat->firstChild ; child != NULL; child = child->nextSibling) {
979 DEBUG1("Dig into %s",child->name);
980 res = _xbt_log_cat_searchsub(child,name);
990 * \param control_string What to parse
992 * Typically passed a command-line argument. The string has the syntax:
994 * ( [category] "." [keyword] ":" value (" ")... )...
996 * where [category] is one the category names (see \ref XBT_log_cats for
997 * a complete list of the ones defined in the SimGrid library)
998 * and keyword is one of the following:
1000 * - thres: category's threshold priority. Possible values:
1001 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1002 * - add or additivity: whether the logging actions must be passed to
1003 * the parent category.
1004 * Possible values: 0, 1, no, yes, on, off.
1005 * Default value: yes.
1006 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1007 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1011 void xbt_log_control_set(const char* control_string) {
1012 xbt_log_setting_t set;
1014 /* To split the string in commands, and the cursors */
1015 xbt_dynar_t set_strings;
1019 if (!control_string)
1021 DEBUG1("Parse log settings '%s'",control_string);
1023 /* some initialization if this is the first time that this get called */
1024 if (xbt_log_settings == NULL)
1025 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1028 /* split the string, and remove empty entries */
1029 set_strings=xbt_str_split_quoted(control_string);
1031 if (xbt_dynar_length(set_strings) == 0) { /* vicious user! */
1032 xbt_dynar_free(&set_strings);
1036 /* Parse each entry and either use it right now (if the category was already
1037 created), or store it for further use */
1038 xbt_dynar_foreach(set_strings,cpt,str) {
1039 xbt_log_category_t cat=NULL;
1041 set = _xbt_log_parse_setting(str);
1042 cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT),set->catname);
1045 DEBUG0("Apply directly");
1046 _xbt_log_cat_apply_set(cat,set);
1047 _free_setting((void*)&set);
1050 DEBUG0("Store for further application");
1051 DEBUG1("push %p to the settings",(void*)set);
1052 xbt_dynar_push(xbt_log_settings,&set);
1055 xbt_dynar_free(&set_strings);
1058 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
1059 if (cat->appender) {
1060 if (cat->appender->free_)
1061 cat->appender->free_(cat->appender);
1062 free(cat->appender);
1064 cat->appender = app;
1066 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) {
1067 if (!cat->appender) {
1068 VERB1("No appender to category %s. Setting the file appender as default",
1070 xbt_log_appender_set(cat,xbt_log_appender_file_new(NULL));
1072 if (cat->layout && cat != &_XBT_LOGV(root)) {
1073 /* better leak the default layout than check every categories to
1075 if (cat->layout->free_) {
1076 cat->layout->free_(cat->layout);
1081 xbt_log_additivity_set(cat,0);
1084 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) {
1085 cat->additivity = additivity;