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
158 definition. Likewise, you can use a category defined in another file as
159 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
161 Typically, there will be a Category for each module and sub-module, so you
162 can independently control logging for each module.
164 For a list of all existing categories, please refer to the \ref XBT_log_cats
165 section. This file is generated automatically from the SimGrid source code, so
166 it should be complete and accurate.
168 \section log_API_pri 2.2 Declaring message priority
170 A category may be assigned a threshold priority. The set of priorities are
171 defined by the \ref e_xbt_log_priority_t enum. All logging request under
172 this priority will be discarded.
174 If a given category is not assigned a threshold priority, then it inherits
175 one from its closest ancestor with an assigned threshold. To ensure that all
176 categories can eventually inherit a threshold, the root category always has
177 an assigned threshold priority.
179 Logging requests are made by invoking a logging macro on a category. All of
180 the macros have a printf-style format string followed by arguments. If you
181 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
182 when you pass a pointer to a string where an integer was specified by the
183 format. This is usually a good idea.
185 Because some C compilers do not support vararg macros, there is a version of
186 the macro for any number of arguments from 0 to 6. The macro name ends with
187 the total number of arguments.
189 Here is an example of the most basic type of macro. This is a logging
190 request with priority <i>warning</i>.
192 <code>CLOG5(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
195 A logging request is said to be enabled if its priority is higher than or
196 equal to the threshold priority of its category. Otherwise, the request is
197 said to be disabled. A category without an assigned priority will inherit
198 one from the hierarchy.
200 It is possible to use any non-negative integer as a priority. If, as in the
201 example, one of the standard priorities is used, then there is a convenience
202 macro that is typically used instead. For example, the above example is
203 equivalent to the shorter:
205 <code>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
207 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
209 It is sometimes useful to check whether a particular category is
210 enabled at a particular priority. One example is when you want to do
211 some extra computation to prepare a nice debugging message. There is
212 no use of doing so if the message won't be used afterward because
213 debugging is turned off.
215 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
217 \section log_API_subcat 2.4 Using a default category (the easy interface)
219 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
220 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
221 category, then the even shorter form can be used:
223 <code>WARN3("Values are: %s and '%d'", 5, "oops");</code>
225 Only one default category can be created per file, though multiple
226 non-defaults can be created and used.
228 \section log_API_easy 2.5 Putting all together: the easy interface
230 First of all, each module should register its own category into the categories
231 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
233 Then, logging should be done with the DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
234 ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB10,
235 #INFO10, #WARN10, #ERROR10 and #CRITICAL10). For each group, there is at
236 least 11 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
237 DEBUG5, DEBUG6, DEBUG7, DEBUG8, DEBUG9, DEBUG10), only differing in the number of arguments passed along the format.
238 This is because we want SimGrid itself to keep compilable on ancient
239 compiler not supporting variable number of arguments to macros. But we
240 should provide a macro simpler to use for the users not interested in SP3
243 Under GCC, these macro check there arguments the same way than printf does. So,
244 if you compile with -Wall, the following code will issue a warning:
245 <code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
247 If you want to specify the category to log onto (for example because you
248 have more than one category per file, add a C before the name of the log
249 producing macro (ie, use #CDEBUG10, #CVERB10, #CINFO10, #CWARN10, #CERROR10 and
250 #CCRITICAL10 and friends), and pass the category name as first argument.
252 The TRACE priority is not used the same way than the other. You should use
253 the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
256 \section log_API_example 2.6 Example of use
258 Here is a more complete example:
263 / * create a category and a default subcategory * /
264 XBT_LOG_NEW_CATEGORY(VSS);
265 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
268 / * Now set the parent's priority. (the string would typcially be a runtime option) * /
269 xbt_log_control_set("SA.thresh:3");
271 / * This request is enabled, because WARNING >= INFO. * /
272 CWARN2(VSS, "Low fuel level.");
274 / * This request is disabled, because DEBUG < INFO. * /
275 CDEBUG2(VSS, "Starting search for nearest gas station.");
277 / * The default category SA inherits its priority from VSS. Thus,
278 the following request is enabled because INFO >= INFO. * /
279 INFO1("Located nearest gas station.");
281 / * This request is disabled, because DEBUG < INFO. * /
282 DEBUG1("Exiting gas station search");
286 Another example can be found in the relevant part of the GRAS tutorial:
287 \ref GRAS_tut_tour_logs.
289 \section log_user 3. User interface
291 \section log_use_conf 3.1 Configuration
293 Although rarely done, it is possible to configure the logs during
294 program initialization by invoking the xbt_log_control_set() method
295 manually. A more conventional way is to use the --log command line
296 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
297 checks and deals properly with such arguments.
299 The following command line arguments exist, but are deprecated and
300 may disappear in the future: --xbt-log, --gras-log, --msg-log and
303 \subsection log_use_conf_thres 3.1.1 Threshold configuration
305 The most common setting is to control which logging event will get
306 displayed by setting a threshold to each category through the
307 <tt>thres</tt> keyword.
309 For example, \verbatim --log=root.thres:debug\endverbatim will make
310 SimGrid <b>extremely</b> verbose while \verbatim
311 --log=root.thres:critical\endverbatim should shut it almost
314 \subsection log_use_conf_multi 3.1.2 Passing several settings
316 You can provide several of those arguments to change the setting of several
317 categories, they will be applied from left to right. So,
318 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
319 disable almost any logging.
321 Note that the quotes on above line are mandatory because there is a space in
322 the argument, so we are protecting ourselves from the shell, not from SimGrid.
323 We could also reach the same effect with this:
324 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
326 \subsection log_use_conf_fmt 3.1.3 Format configuration
328 As with SimGrid 3.3, it is possible to control the format of log
329 messages. This is done through the <tt>fmt</tt> keyword. For example,
330 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
331 user-message only, removing any decoration such as the date, or the
332 process ID, everything.
334 Here are the existing format directives:
337 - %%n: platform-dependent line separator (LOG4J compatible)
338 - %%e: plain old space (SimGrid extension)
340 - %%m: user-provided message
342 - %%c: Category name (LOG4J compatible)
343 - %%p: Priority name (LOG4J compatible)
345 - %%h: Hostname (SimGrid extension)
346 - %%P: Process name (SimGrid extension)
347 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
348 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
350 - %%F: file name where the log event was raised (LOG4J compatible)
351 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
352 - %%L: line number where the log event was raised (LOG4J compatible)
353 - %%M: function name (LOG4J compatible -- called method name here of course).
354 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
356 - %%b: full backtrace (Called %%throwable in LOG4J).
357 Defined only under windows or when using the GNU libc because backtrace() is not defined
358 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
359 - %%B: short backtrace (only the first line of the %%b).
360 Called %%throwable{short} in LOG4J; defined where %%b is.
362 - %%d: date (UNIX-like epoch)
363 - %%r: application age (time elapsed since the beginning of the application)
366 If you want to mimic the simple layout with the format one, you would use this
367 format: '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
368 because the simple layout do not display the message location for messages at
369 priority INFO (thus, the fmt is '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n' in this
370 case). Moreover, if there is no process name (ie, messages coming from the
371 library itself, or test programs doing strange things) do not display the
372 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
373 [%%c/%%p] %%m%%n' if they are at priority INFO).
375 For now, there is only one format modifier: the precision field. You
376 can for example specify %.4r to get the application age with 4
377 numbers after the radix. Another limitation is that you cannot set
378 specific layouts to the several priorities.
380 \subsection log_use_conf_app 3.1.4 Category appender
382 As with SimGrid 3.3, it is possible to control the appender of log
383 messages. This is done through the <tt>app</tt> keyword. For example,
384 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
385 to the file mylogfile.
387 Any appender setup this way have its own layout format (simple one by default),
388 so you may have to change it too afterward. Moreover, the additivity of the log category
389 is also set to false to prevent log event displayed by this appender to "leak" to any other
390 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
393 \subsection log_use_conf_add 3.1.5 Category additivity
395 The <tt>add</tt> keyword allows to specify the additivity of a
396 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
397 and 'off' are all valid values, with 'yes' as default.
399 The following example resets the additivity of the xbt category to true (which is its default value).
400 \verbatim --log=xbt.add:yes\endverbatim
402 \section log_use_misc 3.2 Misc and Caveats
404 - Do not use any of the macros that start with '_'.
405 - Log4J has a 'rolling file appender' which you can select with a run-time
406 option and specify the max file size. This would be a nice default for
407 non-kernel applications.
408 - Careful, category names are global variables.
410 \section log_internals 4. Internal considerations
412 This module is a mess of macro black magic, and when it goes wrong,
413 SimGrid studently loose its ability to explain its problems. When
414 messing around this module, I often find useful to define
415 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
416 of finding what's going wrong. But things are quite verbose when
417 everything is enabled...
419 \section log_in_perf 4.1 Performance
421 Except for the first invocation of a given category, a disabled logging request
422 requires an a single comparison of a static variable to a constant.
424 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
425 causes all logging requests with a lower priority to be optimized to 0 cost
426 by the compiler. By setting it to gras_log_priority_infinite, all logging
427 requests are statically disabled at compile time and cost nothing. Released executables
428 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
429 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
431 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
432 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
433 the requests of priority below INFO.
435 \todo Logging performance *may* be improved further by improving the message
436 propagation from appender to appender in the category tree.
438 \section log_in_app 4.2 Appenders
440 Each category has an optional appender. An appender is a pointer to a
441 structure which starts with a pointer to a do_append() function. do_append()
442 prints a message to a log.
444 When a category is passed a message by one of the logging macros, the
445 category performs the following actions:
447 - if the category has an appender, the message is passed to the
448 appender's do_append() function,
449 - if additivity is true for the category, the message is passed to
450 the category's parent. Additivity is true by default, and can be
451 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
452 Also, when you add an appender to a category, its additivity is automatically turned to off.
453 Turn it back on afterward if it is not what you wanted.
455 By default, only the root category have an appender, and any other category has
456 its additivity set to true. This causes all messages to be logged by the root
459 The default appender function currently prints to stderr, and the only other
460 existing one writes to the specified file. More would be needed, like the one
461 able to send the logs to a remote dedicated server.
462 This is on our TODO list for quite a while now, but your help would be
469 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
470 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
475 e_xbt_log_priority_t thresh;
478 xbt_log_appender_t appender;
479 } s_xbt_log_setting_t,*xbt_log_setting_t;
481 static xbt_dynar_t xbt_log_settings=NULL;
483 static void _free_setting(void *s) {
484 xbt_log_setting_t set=*(xbt_log_setting_t*)s;
492 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
493 xbt_log_setting_t setting);
495 const char *xbt_log_priority_names[8] = {
506 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
507 NULL /*parent*/, NULL /* firstChild */, NULL /* nextSibling */,
508 "root", xbt_log_priority_uninitialized /* threshold */,
509 0 /* isThreshInherited */,
510 NULL /* appender */, NULL /* layout */,
514 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
515 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
516 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
517 XBT_LOG_NEW_CATEGORY(simix,"All SIMIX categories");
519 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
521 /** @brief Get all logging settings from the command line
523 * xbt_log_control_set() is called on each string we got from cmd line
525 void xbt_log_init(int *argc,char **argv) {
529 /* create the default appender and install it in the root category,
530 which were already created (damnit. Too slow little beetle)*/
531 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
532 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
533 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
534 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
537 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
539 /* Set logs and init log submodule */
540 for (i=1; i<*argc; i++){
541 if (!strncmp(argv[i],"--log=",strlen("--log=")) ||
542 !strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
543 !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
544 !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
545 !strncmp(argv[i],"--simix-log=",strlen("--simix-log=")) ||
546 !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
548 if (strncmp(argv[i],"--log=",strlen("--log=")))
549 WARN2("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
550 (int)(strchr(argv[i],'=')-argv[i]),argv[i]);
552 opt=strchr(argv[i],'=');
554 xbt_log_control_set(opt);
555 DEBUG1("Did apply '%s' as log setting",opt);
556 /*remove this from argv*/
558 for (j=i+1; j<*argc; j++){
564 i--; /* compensate effect of next loop incrementation */
569 static void log_cat_exit(xbt_log_category_t cat) {
570 xbt_log_category_t child;
573 if (cat->appender->free_)
574 cat->appender->free_(cat->appender);
578 if (cat->layout->free_)
579 cat->layout->free_(cat->layout);
583 for(child=cat->firstChild ; child != NULL; child = child->nextSibling)
587 void xbt_log_exit(void) {
588 VERB0("Exiting log");
589 xbt_dynar_free(&xbt_log_settings);
590 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
594 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
596 xbt_log_category_t cat = ev->cat;
598 /* Make sure that the layouts have been malloced */
599 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
600 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
601 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
602 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
606 va_start(ev->ap, fmt);
607 va_start(ev->ap_copy, fmt);
609 xbt_log_appender_t appender = cat->appender;
610 if (appender != NULL) {
611 xbt_assert1(cat->layout,"No valid layout for the appender of category %s",cat->name);
612 cat->layout->do_layout(cat->layout, ev, fmt, appender);
614 if (!cat->additivity)
627 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
628 xbt_log_setting_t setting) {
630 s_xbt_log_event_t _log_ev;
632 if (setting->thresh != xbt_log_priority_uninitialized) {
633 xbt_log_threshold_set(category, setting->thresh);
635 if (category->threshold <= xbt_log_priority_debug) {
636 _log_ev.cat = category;
637 _log_ev.priority = xbt_log_priority_debug;
638 _log_ev.fileName = __FILE__ ;
639 _log_ev.functionName = _XBT_FUNCTION ;
640 _log_ev.lineNum = __LINE__ ;
642 _xbt_log_event_log(&_log_ev,
643 "Apply settings for category '%s': set threshold to %s (=%d)",
645 xbt_log_priority_names[category->threshold],
646 category->threshold);
651 xbt_log_layout_set(category,xbt_log_layout_format_new(setting->fmt));
653 if (category->threshold <= xbt_log_priority_debug) {
654 _log_ev.cat = category;
655 _log_ev.priority = xbt_log_priority_debug;
656 _log_ev.fileName = __FILE__ ;
657 _log_ev.functionName = _XBT_FUNCTION ;
658 _log_ev.lineNum = __LINE__ ;
660 _xbt_log_event_log(&_log_ev,
661 "Apply settings for category '%s': set format to %s",
667 if (setting->additivity != -1) {
668 xbt_log_additivity_set(category,setting->additivity);
670 if (category->threshold <= xbt_log_priority_debug) {
671 _log_ev.cat = category;
672 _log_ev.priority = xbt_log_priority_debug;
673 _log_ev.fileName = __FILE__ ;
674 _log_ev.functionName = _XBT_FUNCTION ;
675 _log_ev.lineNum = __LINE__ ;
677 _xbt_log_event_log(&_log_ev,
678 "Apply settings for category '%s': set additivity to %s",
680 (setting->additivity?"on":"off"));
683 if (setting->appender) {
684 xbt_log_appender_set(category,setting->appender);
685 if (!category->layout)
686 xbt_log_layout_set(category,xbt_log_layout_simple_new(NULL));
687 category->additivity = 0;
688 if (category->threshold <= xbt_log_priority_debug) {
689 _log_ev.cat = category;
690 _log_ev.priority = xbt_log_priority_debug;
691 _log_ev.fileName = __FILE__ ;
692 _log_ev.functionName = _XBT_FUNCTION ;
693 _log_ev.lineNum = __LINE__ ;
695 _xbt_log_event_log(&_log_ev,
696 "Set %p as appender of category '%s'",
704 * This gets called the first time a category is referenced and performs the
706 * Also resets threshold to inherited!
708 int _xbt_log_cat_init(xbt_log_category_t category,
709 e_xbt_log_priority_t priority) {
711 xbt_log_setting_t setting=NULL;
713 s_xbt_log_event_t _log_ev;
715 if (_XBT_LOGV(log).threshold <= xbt_log_priority_debug
716 && _XBT_LOGV(log).threshold != xbt_log_priority_uninitialized) {
717 _log_ev.cat = &_XBT_LOGV(log);
718 _log_ev.priority = xbt_log_priority_debug;
719 _log_ev.fileName = __FILE__ ;
720 _log_ev.functionName = _XBT_FUNCTION ;
721 _log_ev.lineNum = __LINE__ ;
722 _xbt_log_event_log(&_log_ev, "Initializing category '%s' (firstChild=%s, nextSibling=%s)",
724 (category->firstChild ?category->firstChild->name :"none"),
725 (category->nextSibling?category->nextSibling->name:"none"));
728 if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
729 category->threshold = xbt_log_priority_info;/* xbt_log_priority_debug*/;
730 category->appender = xbt_log_default_appender;
731 category->layout = xbt_log_default_layout;
734 if (!category->parent)
735 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
737 if (_XBT_LOGV(log).threshold <= xbt_log_priority_debug
738 && _XBT_LOGV(log).threshold != xbt_log_priority_uninitialized) {
739 _log_ev.lineNum = __LINE__ ;
740 _xbt_log_event_log(&_log_ev, "Set %s (%s) as father of %s ", category->parent->name,
741 (category->parent->threshold == xbt_log_priority_uninitialized ? "uninited":xbt_log_priority_names[category->parent->threshold]),
744 xbt_log_parent_set(category, category->parent);
746 if (_XBT_LOGV(log).threshold < xbt_log_priority_info
747 && _XBT_LOGV(log).threshold != xbt_log_priority_uninitialized) {
749 xbt_log_category_t cpp = category->parent->firstChild;
752 buf = bprintf("%s %s",res,cpp->name);
756 res = xbt_strdup(cpp->name);
758 cpp = cpp->nextSibling;
761 _log_ev.lineNum = __LINE__ ;
762 _xbt_log_event_log(&_log_ev,
763 "Childs of %s: %s; nextSibling: %s", category->parent->name,res,
764 (category->parent->nextSibling?category->parent->nextSibling->name:"none"));
771 /* Apply the control */
772 if (!xbt_log_settings)
773 return priority >= category->threshold;
775 xbt_assert0(category,"NULL category");
776 xbt_assert(category->name);
778 xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
779 xbt_assert0(setting,"Damnit, NULL cat in the list");
780 xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
782 if (!strcmp(setting->catname,category->name)) {
786 _xbt_log_cat_apply_set(category,setting);
788 xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
792 if (!found && category->threshold <= xbt_log_priority_verbose) {
794 _log_ev.cat = &_XBT_LOGV(log);
795 _log_ev.priority = xbt_log_priority_verbose;
796 _log_ev.fileName = __FILE__ ;
797 _log_ev.functionName = _XBT_FUNCTION ;
798 _log_ev.lineNum = __LINE__ ;
800 _xbt_log_event_log(&_log_ev,
801 "Category '%s': inherited threshold = %s (=%d)",
803 xbt_log_priority_names[category->threshold], category->threshold);
806 return priority >= category->threshold;
809 void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent) {
811 xbt_assert0(cat,"NULL category to be given a parent");
812 xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
815 * if the threshold is initialized
816 * unlink from current parent
818 if(cat->threshold != xbt_log_priority_uninitialized){
820 xbt_log_category_t* cpp = &parent->firstChild;
822 while(*cpp != cat && *cpp != NULL) {
823 cpp = &(*cpp)->nextSibling;
826 xbt_assert(*cpp == cat);
827 *cpp = cat->nextSibling;
830 cat->parent = parent;
831 cat->nextSibling = parent->firstChild;
833 parent->firstChild = cat;
835 if (parent->threshold == xbt_log_priority_uninitialized){
837 _xbt_log_cat_init(parent,
838 xbt_log_priority_uninitialized/* ignored*/);
841 cat->threshold = parent->threshold;
843 cat->isThreshInherited = 1;
847 static void _set_inherited_thresholds(xbt_log_category_t cat) {
849 xbt_log_category_t child = cat->firstChild;
851 for( ; child != NULL; child = child->nextSibling) {
852 if (child->isThreshInherited) {
853 if (cat != &_XBT_LOGV(log))
854 VERB3("Set category threshold of %s to %s (=%d)",
855 child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
856 child->threshold = cat->threshold;
857 _set_inherited_thresholds(child);
864 void xbt_log_threshold_set(xbt_log_category_t cat,
865 e_xbt_log_priority_t threshold) {
866 cat->threshold = threshold;
867 cat->isThreshInherited = 0;
869 _set_inherited_thresholds(cat);
873 static xbt_log_setting_t _xbt_log_parse_setting(const char* control_string) {
875 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t,1);
876 const char *name, *dot, *eq;
879 set->thresh = xbt_log_priority_uninitialized;
881 set->additivity = -1;
882 set->appender = NULL;
884 if (!*control_string)
886 DEBUG1("Parse log setting '%s'",control_string);
888 control_string += strspn(control_string, " ");
889 name = control_string;
890 control_string += strcspn(control_string, ".= ");
891 dot = control_string;
892 control_string += strcspn(control_string, ":= ");
894 control_string += strcspn(control_string, " ");
896 xbt_assert1(*dot == '.' && (*eq == '=' || *eq == ':'),
897 "Invalid control string '%s'",control_string);
899 if (!strncmp(dot + 1, "thresh", (size_t)(eq - dot - 1))) {
901 char *neweq=xbt_strdup(eq+1);
904 while (*(++p) != '\0') {
905 if (*p >= 'a' && *p <= 'z') {
910 DEBUG1("New priority name = %s",neweq);
911 for (i=0; i<xbt_log_priority_infinite; i++) {
912 if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
913 DEBUG1("This is priority %d",i);
917 if (i<xbt_log_priority_infinite) {
918 set->thresh= (e_xbt_log_priority_t) i;
921 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",eq+1);
924 } else if ( !strncmp(dot + 1, "add", (size_t)(eq - dot - 1)) ||
925 !strncmp(dot + 1, "additivity", (size_t)(eq - dot - 1)) ) {
927 char *neweq=xbt_strdup(eq+1);
930 while (*(++p) != '\0') {
931 if (*p >= 'a' && *p <= 'z') {
935 if ( !strcmp(neweq,"ON") ||
936 !strcmp(neweq,"YES") ||
937 !strcmp(neweq,"1") ) {
943 } else if ( !strncmp(dot + 1, "app", (size_t)(eq - dot - 1)) ||
944 !strncmp(dot + 1, "appender", (size_t)(eq - dot - 1)) ) {
946 char *neweq=xbt_strdup(eq+1);
948 if ( !strncmp(neweq,"file:",5) ) {
949 set->appender = xbt_log_appender_file_new(neweq+5);
951 THROW1(arg_error,0,"Unknown appender log type: '%s'",neweq);
954 } else if (!strncmp(dot + 1, "fmt", (size_t)(eq - dot - 1))) {
955 set->fmt = xbt_strdup(eq+1);
958 snprintf(buff,min(512,eq - dot),"%s",dot+1);
959 THROW1(arg_error,0,"Unknown setting of the log category: '%s'",buff);
961 set->catname=(char*)xbt_malloc(dot - name+1);
963 memcpy(set->catname,name,dot-name);
964 set->catname[dot-name]='\0'; /* Just in case */
965 DEBUG1("This is for cat '%s'", set->catname);
970 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
971 xbt_log_category_t child,res;
973 DEBUG4("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')",name,cat->name,
974 (cat->firstChild ? cat->firstChild->name :"none"),
975 (cat->nextSibling ? cat->nextSibling->name:"none"));
976 if (!strcmp(cat->name,name))
979 for (child=cat->firstChild ; child != NULL; child = child->nextSibling) {
980 DEBUG1("Dig into %s",child->name);
981 res = _xbt_log_cat_searchsub(child,name);
991 * \param control_string What to parse
993 * Typically passed a command-line argument. The string has the syntax:
995 * ( [category] "." [keyword] ":" value (" ")... )...
997 * where [category] is one the category names (see \ref XBT_log_cats for
998 * a complete list of the ones defined in the SimGrid library)
999 * and keyword is one of the following:
1001 * - thres: category's threshold priority. Possible values:
1002 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1003 * - add or additivity: whether the logging actions must be passed to
1004 * the parent category.
1005 * Possible values: 0, 1, no, yes, on, off.
1006 * Default value: yes.
1007 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1008 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1012 void xbt_log_control_set(const char* control_string) {
1013 xbt_log_setting_t set;
1015 /* To split the string in commands, and the cursors */
1016 xbt_dynar_t set_strings;
1020 if (!control_string)
1022 DEBUG1("Parse log settings '%s'",control_string);
1024 /* some initialization if this is the first time that this get called */
1025 if (xbt_log_settings == NULL)
1026 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1029 /* split the string, and remove empty entries */
1030 set_strings=xbt_str_split_quoted(control_string);
1032 if (xbt_dynar_length(set_strings) == 0) { /* vicious user! */
1033 xbt_dynar_free(&set_strings);
1037 /* Parse each entry and either use it right now (if the category was already
1038 created), or store it for further use */
1039 xbt_dynar_foreach(set_strings,cpt,str) {
1040 xbt_log_category_t cat=NULL;
1042 set = _xbt_log_parse_setting(str);
1043 cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT),set->catname);
1046 DEBUG0("Apply directly");
1047 _xbt_log_cat_apply_set(cat,set);
1048 _free_setting((void*)&set);
1051 DEBUG0("Store for further application");
1052 DEBUG1("push %p to the settings",(void*)set);
1053 xbt_dynar_push(xbt_log_settings,&set);
1056 xbt_dynar_free(&set_strings);
1059 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
1060 if (cat->appender) {
1061 if (cat->appender->free_)
1062 cat->appender->free_(cat->appender);
1063 free(cat->appender);
1065 cat->appender = app;
1067 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) {
1068 if (!cat->appender) {
1069 VERB1("No appender to category %s. Setting the file appender as default",
1071 xbt_log_appender_set(cat,xbt_log_appender_file_new(NULL));
1073 if (cat->layout && cat != &_XBT_LOGV(root)) {
1074 /* better leak the default layout than check every categories to
1076 if (cat->layout->free_) {
1077 cat->layout->free_(cat->layout);
1082 xbt_log_additivity_set(cat,0);
1085 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) {
1086 cat->additivity = additivity;