1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
12 #include <stdio.h> /* snprintf */
13 #include <stdlib.h> /* snprintf */
15 #include "portable.h" /* to get a working stdarg.h */
17 #include "xbt_modinter.h"
22 #include "xbt/sysdep.h"
23 #include "xbt/log_private.h"
24 #include "xbt/dynar.h"
26 XBT_PUBLIC_DATA(int) (*xbt_pid) ();
27 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
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 Here is an example of the most basic type of macro. This is a logging
186 request with priority <i>warning</i>.
188 <code>XBT_CLOG(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
191 A logging request is said to be enabled if its priority is higher than or
192 equal to the threshold priority of its category. Otherwise, the request is
193 said to be disabled. A category without an assigned priority will inherit
194 one from the hierarchy.
196 It is possible to use any non-negative integer as a priority. If, as in the
197 example, one of the standard priorities is used, then there is a convenience
198 macro that is typically used instead. For example, the above example is
199 equivalent to the shorter:
201 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
203 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
205 It is sometimes useful to check whether a particular category is
206 enabled at a particular priority. One example is when you want to do
207 some extra computation to prepare a nice debugging message. There is
208 no use of doing so if the message won't be used afterward because
209 debugging is turned off.
211 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
213 \section log_API_subcat 2.4 Using a default category (the easy interface)
215 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
216 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
217 category, then the even shorter form can be used:
219 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
221 Only one default category can be created per file, though multiple
222 non-defaults can be created and used.
224 \section log_API_easy 2.5 Putting all together: the easy interface
226 First of all, each module should register its own category into the categories
227 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
229 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
230 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
232 Under GCC, these macro check there arguments the same way than printf does. So,
233 if you compile with -Wall, the following code will issue a warning:
234 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
236 If you want to specify the category to log onto (for example because you
237 have more than one category per file, add a C before the name of the log
238 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
239 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
242 The TRACE priority is not used the same way than the other. You should use
243 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
245 \section log_API_example 2.6 Example of use
247 Here is a more complete example:
252 / * create a category and a default subcategory * /
253 XBT_LOG_NEW_CATEGORY(VSS);
254 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
257 / * Now set the parent's priority. (the string would typcially be a runtime option) * /
258 xbt_log_control_set("SA.thresh:3");
260 / * This request is enabled, because WARNING >= INFO. * /
261 XBT_CWARN(VSS, "Low fuel level.");
263 / * This request is disabled, because DEBUG < INFO. * /
264 XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
266 / * The default category SA inherits its priority from VSS. Thus,
267 the following request is enabled because INFO >= INFO. * /
268 XBT_INFO("Located nearest gas station.");
270 / * This request is disabled, because DEBUG < INFO. * /
271 XBT_DEBUG("Exiting gas station search");
275 Another example can be found in the relevant part of the GRAS tutorial:
276 \ref GRAS_tut_tour_logs.
278 \section log_user 3. User interface
280 \section log_use_conf 3.1 Configuration
282 Although rarely done, it is possible to configure the logs during
283 program initialization by invoking the xbt_log_control_set() method
284 manually. A more conventional way is to use the --log command line
285 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
286 checks and deals properly with such arguments.
288 The following command line arguments exist, but are deprecated and
289 may disappear in the future: --xbt-log, --gras-log, --msg-log and
292 \subsection log_use_conf_thres 3.1.1 Threshold configuration
294 The most common setting is to control which logging event will get
295 displayed by setting a threshold to each category through the
296 <tt>thres</tt> keyword.
298 For example, \verbatim --log=root.thres:debug\endverbatim will make
299 SimGrid <b>extremely</b> verbose while \verbatim
300 --log=root.thres:critical\endverbatim should shut it almost
303 \subsection log_use_conf_multi 3.1.2 Passing several settings
305 You can provide several of those arguments to change the setting of several
306 categories, they will be applied from left to right. So,
307 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
308 disable almost any logging.
310 Note that the quotes on above line are mandatory because there is a space in
311 the argument, so we are protecting ourselves from the shell, not from SimGrid.
312 We could also reach the same effect with this:
313 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
315 \subsection log_use_conf_fmt 3.1.3 Format configuration
317 As with SimGrid 3.3, it is possible to control the format of log
318 messages. This is done through the <tt>fmt</tt> keyword. For example,
319 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
320 user-message only, removing any decoration such as the date, or the
321 process ID, everything.
323 Here are the existing format directives:
326 - %%n: platform-dependent line separator (LOG4J compatible)
327 - %%e: plain old space (SimGrid extension)
329 - %%m: user-provided message
331 - %%c: Category name (LOG4J compatible)
332 - %%p: Priority name (LOG4J compatible)
334 - %%h: Hostname (SimGrid extension)
335 - %%P: Process name (SimGrid extension)
336 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
337 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
339 - %%F: file name where the log event was raised (LOG4J compatible)
340 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
341 - %%L: line number where the log event was raised (LOG4J compatible)
342 - %%M: function name (LOG4J compatible -- called method name here of course).
343 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
345 - %%b: full backtrace (Called %%throwable in LOG4J).
346 Defined only under windows or when using the GNU libc because backtrace() is not defined
347 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
348 - %%B: short backtrace (only the first line of the %%b).
349 Called %%throwable{short} in LOG4J; defined where %%b is.
351 - %%d: date (UNIX-like epoch)
352 - %%r: application age (time elapsed since the beginning of the application)
355 If you want to mimic the simple layout with the format one, you would use this
356 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
357 because the simple layout do not display the message location for messages at
358 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
359 case). Moreover, if there is no process name (ie, messages coming from the
360 library itself, or test programs doing strange things) do not display the
361 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
362 [%%c/%%p] %%m%%n' if they are at priority INFO).
364 For now, there is only two format modifiers: the precision and the
365 width fields. You can for example specify %.4r to get the application
366 age with 4 numbers after the radix, or %15p to get the process name
367 on 15 columns. Finally, you can specify %10.6r to get the time on at
368 most 10 columns, with 6 numbers after the radix.
370 Note that when specifying the width, it is filled with spaces. That
371 is to say that for example %5r in your format is converted to "% 5f"
372 for printf (note the extra space); there is no way to fill the empty
373 columns with 0 (ie, pass "%05f" to printf). Another limitation is
374 that you cannot set specific layouts to the several priorities.
376 \subsection log_use_conf_app 3.1.4 Category appender
378 As with SimGrid 3.3, it is possible to control the appender of log
379 messages. This is done through the <tt>app</tt> keyword. For example,
380 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
381 to the file mylogfile.
383 Any appender setup this way have its own layout format (simple one by default),
384 so you may have to change it too afterward. Moreover, the additivity of the log category
385 is also set to false to prevent log event displayed by this appender to "leak" to any other
386 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
389 \subsection log_use_conf_add 3.1.5 Category additivity
391 The <tt>add</tt> keyword allows to specify the additivity of a
392 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
393 and 'off' are all valid values, with 'yes' as default.
395 The following example resets the additivity of the xbt category to true (which is its default value).
396 \verbatim --log=xbt.add:yes\endverbatim
398 \section log_use_misc 3.2 Misc and Caveats
400 - Do not use any of the macros that start with '_'.
401 - Log4J has a 'rolling file appender' which you can select with a run-time
402 option and specify the max file size. This would be a nice default for
403 non-kernel applications.
404 - Careful, category names are global variables.
406 \section log_internals 4. Internal considerations
408 This module is a mess of macro black magic, and when it goes wrong,
409 SimGrid studently loose its ability to explain its problems. When
410 messing around this module, I often find useful to define
411 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
412 of finding what's going wrong. But things are quite verbose when
413 everything is enabled...
415 \section log_in_perf 4.1 Performance
417 Except for the first invocation of a given category, a disabled logging request
418 requires an a single comparison of a static variable to a constant.
420 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
421 causes all logging requests with a lower priority to be optimized to 0 cost
422 by the compiler. By setting it to gras_log_priority_infinite, all logging
423 requests are statically disabled at compile time and cost nothing. Released executables
424 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
425 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
427 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
428 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
429 the requests of priority below INFO.
431 \todo Logging performance *may* be improved further by improving the message
432 propagation from appender to appender in the category tree.
434 \section log_in_app 4.2 Appenders
436 Each category has an optional appender. An appender is a pointer to a
437 structure which starts with a pointer to a do_append() function. do_append()
438 prints a message to a log.
440 When a category is passed a message by one of the logging macros, the
441 category performs the following actions:
443 - if the category has an appender, the message is passed to the
444 appender's do_append() function,
445 - if additivity is true for the category, the message is passed to
446 the category's parent. Additivity is true by default, and can be
447 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
448 Also, when you add an appender to a category, its additivity is automatically turned to off.
449 Turn it back on afterward if it is not what you wanted.
451 By default, only the root category have an appender, and any other category has
452 its additivity set to true. This causes all messages to be logged by the root
455 The default appender function currently prints to stderr, and the only other
456 existing one writes to the specified file. More would be needed, like the one
457 able to send the logs to a remote dedicated server.
458 This is on our TODO list for quite a while now, but your help would be
465 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
466 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
470 e_xbt_log_priority_t thresh;
473 xbt_log_appender_t appender;
474 } s_xbt_log_setting_t, *xbt_log_setting_t;
476 static xbt_dynar_t xbt_log_settings = NULL;
478 static void _free_setting(void *s)
480 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
489 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
490 xbt_log_setting_t setting);
492 const char *xbt_log_priority_names[8] = {
503 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
504 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
505 "root", xbt_log_priority_uninitialized /* threshold */ ,
506 0 /* isThreshInherited */ ,
507 NULL /* appender */ , NULL /* layout */ ,
511 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
512 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
513 XBT_LOG_NEW_CATEGORY(msg, "All MSG categories");
514 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
515 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
516 XBT_LOG_NEW_CATEGORY(bindings, "All bindings categories");
518 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
519 "Loggings from the logging mechanism itself");
521 /* create the default appender and install it in the root category,
522 which were already created (damnit. Too slow little beetle) */
523 void xbt_log_preinit(void)
525 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
526 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
527 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
528 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
531 /** @brief Get all logging settings from the command line
533 * xbt_log_control_set() is called on each string we got from cmd line
535 void xbt_log_init(int *argc, char **argv)
540 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
542 /* Set logs and init log submodule */
543 for (i = 1; i < *argc; i++) {
544 if (!strncmp(argv[i], "--log=", strlen("--log=")) ||
545 !strncmp(argv[i], "--gras-log=", strlen("--gras-log=")) ||
546 !strncmp(argv[i], "--surf-log=", strlen("--surf-log=")) ||
547 !strncmp(argv[i], "--msg-log=", strlen("--msg-log=")) ||
548 !strncmp(argv[i], "--simix-log=", strlen("--simix-log=")) ||
549 !strncmp(argv[i], "--xbt-log=", strlen("--xbt-log="))) {
551 if (strncmp(argv[i], "--log=", strlen("--log=")))
553 ("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
554 (int) (strchr(argv[i], '=') - argv[i]), argv[i]);
556 opt = strchr(argv[i], '=');
558 xbt_log_control_set(opt);
559 XBT_DEBUG("Did apply '%s' as log setting", opt);
560 /*remove this from argv */
562 for (j = i + 1; j < *argc; j++) {
563 argv[j - 1] = argv[j];
568 i--; /* compensate effect of next loop incrementation */
573 static void log_cat_exit(xbt_log_category_t cat)
575 xbt_log_category_t child;
578 if (cat->appender->free_)
579 cat->appender->free_(cat->appender);
583 if (cat->layout->free_)
584 cat->layout->free_(cat->layout);
588 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
592 void xbt_log_postexit(void)
594 XBT_VERB("Exiting log");
595 xbt_dynar_free(&xbt_log_settings);
596 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
599 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
602 xbt_log_category_t cat = ev->cat;
604 va_start(ev->ap, fmt);
605 va_start(ev->ap_copy, fmt);
607 xbt_log_appender_t appender = cat->appender;
608 if (appender != NULL) {
609 xbt_assert(cat->layout,
610 "No valid layout for the appender of category %s",
612 cat->layout->do_layout(cat->layout, ev, fmt, appender);
614 if (!cat->additivity)
629 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
630 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
631 * recursion, we can not use the standard logging macros in
632 * _xbt_log_cat_init(), and in all functions called from it.
634 * To circumvent the problem, we define the macro_xbt_log_init() as
635 * (0) for the length of the affected functions, and we do not forget
636 * to undefine it at the end!
639 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
640 xbt_log_setting_t setting)
642 #define _xbt_log_cat_init(a, b) (0)
644 if (setting->thresh != xbt_log_priority_uninitialized) {
645 xbt_log_threshold_set(category, setting->thresh);
647 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
648 category->name, xbt_log_priority_names[category->threshold],
649 category->threshold);
653 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
655 XBT_DEBUG("Apply settings for category '%s': set format to %s",
656 category->name, setting->fmt);
659 if (setting->additivity != -1) {
660 xbt_log_additivity_set(category, setting->additivity);
662 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
663 category->name, (setting->additivity ? "on" : "off"));
665 if (setting->appender) {
666 xbt_log_appender_set(category, setting->appender);
667 if (!category->layout)
668 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
669 category->additivity = 0;
670 XBT_DEBUG("Set %p as appender of category '%s'",
671 setting->appender, category->name);
673 #undef _xbt_log_cat_init
677 * This gets called the first time a category is referenced and performs the
679 * Also resets threshold to inherited!
681 int _xbt_log_cat_init(xbt_log_category_t category,
682 e_xbt_log_priority_t priority)
684 #define _xbt_log_cat_init(a, b) (0)
687 xbt_log_setting_t setting = NULL;
690 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
692 (category->firstChild ? category->firstChild->name : "none"),
693 (category->nextSibling ? category->nextSibling->name : "none"));
695 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
696 category->threshold = xbt_log_priority_info;
697 /* xbt_log_priority_debug */ ;
698 category->appender = xbt_log_default_appender;
699 category->layout = xbt_log_default_layout;
702 if (!category->parent)
703 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
705 XBT_DEBUG("Set %s (%s) as father of %s ",
706 category->parent->name,
707 (category->parent->threshold == xbt_log_priority_uninitialized ?
708 "uninited" : xbt_log_priority_names[category->
711 xbt_log_parent_set(category, category->parent);
713 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
714 char *buf, *res = NULL;
715 xbt_log_category_t cpp = category->parent->firstChild;
718 buf = bprintf("%s %s", res, cpp->name);
722 res = xbt_strdup(cpp->name);
724 cpp = cpp->nextSibling;
727 XBT_DEBUG("Childs of %s: %s; nextSibling: %s",
728 category->parent->name, res,
729 (category->parent->nextSibling ?
730 category->parent->nextSibling->name : "none"));
737 /* Apply the control */
738 if (!xbt_log_settings)
739 return priority >= category->threshold;
741 xbt_assert(category, "NULL category");
742 xbt_assert(category->name);
744 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
745 xbt_assert(setting, "Damnit, NULL cat in the list");
746 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
749 if (!strcmp(setting->catname, category->name)) {
753 _xbt_log_cat_apply_set(category, setting);
755 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
760 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
761 category->name, xbt_log_priority_names[category->threshold],
762 category->threshold);
764 return priority >= category->threshold;
766 #undef _xbt_log_cat_init
769 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
772 xbt_assert(cat, "NULL category to be given a parent");
773 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
776 * if the threshold is initialized
777 * unlink from current parent
779 if (cat->threshold != xbt_log_priority_uninitialized) {
781 xbt_log_category_t *cpp = &parent->firstChild;
783 while (*cpp != cat && *cpp != NULL) {
784 cpp = &(*cpp)->nextSibling;
787 xbt_assert(*cpp == cat);
788 *cpp = cat->nextSibling;
791 cat->parent = parent;
792 cat->nextSibling = parent->firstChild;
794 parent->firstChild = cat;
796 if (parent->threshold == xbt_log_priority_uninitialized) {
798 _xbt_log_cat_init(parent,
799 xbt_log_priority_uninitialized /* ignored */ );
802 cat->threshold = parent->threshold;
804 cat->isThreshInherited = 1;
808 static void _set_inherited_thresholds(xbt_log_category_t cat)
811 xbt_log_category_t child = cat->firstChild;
813 for (; child != NULL; child = child->nextSibling) {
814 if (child->isThreshInherited) {
815 if (cat != &_XBT_LOGV(log))
816 XBT_VERB("Set category threshold of %s to %s (=%d)",
817 child->name, xbt_log_priority_names[cat->threshold],
819 child->threshold = cat->threshold;
820 _set_inherited_thresholds(child);
827 void xbt_log_threshold_set(xbt_log_category_t cat,
828 e_xbt_log_priority_t threshold)
830 cat->threshold = threshold;
831 cat->isThreshInherited = 0;
833 _set_inherited_thresholds(cat);
837 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
840 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
841 const char *name, *dot, *eq;
844 set->thresh = xbt_log_priority_uninitialized;
846 set->additivity = -1;
847 set->appender = NULL;
849 if (!*control_string)
851 XBT_DEBUG("Parse log setting '%s'", control_string);
853 control_string += strspn(control_string, " ");
854 name = control_string;
855 control_string += strcspn(control_string, ".= ");
856 dot = control_string;
857 control_string += strcspn(control_string, ":= ");
859 control_string += strcspn(control_string, " ");
861 xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
862 "Invalid control string '%s'", control_string);
864 if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
866 char *neweq = xbt_strdup(eq + 1);
869 while (*(++p) != '\0') {
870 if (*p >= 'a' && *p <= 'z') {
875 XBT_DEBUG("New priority name = %s", neweq);
876 for (i = 0; i < xbt_log_priority_infinite; i++) {
877 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
878 XBT_DEBUG("This is priority %d", i);
882 if (i < xbt_log_priority_infinite) {
883 set->thresh = (e_xbt_log_priority_t) i;
886 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
890 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
891 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
893 char *neweq = xbt_strdup(eq + 1);
896 while (*(++p) != '\0') {
897 if (*p >= 'a' && *p <= 'z') {
901 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
902 || !strcmp(neweq, "1")) {
908 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
909 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
911 char *neweq = xbt_strdup(eq + 1);
913 if (!strncmp(neweq, "file:", 5)) {
914 set->appender = xbt_log_appender_file_new(neweq + 5);
916 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
919 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
920 set->fmt = xbt_strdup(eq + 1);
923 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
924 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
927 set->catname = (char *) xbt_malloc(dot - name + 1);
929 memcpy(set->catname, name, dot - name);
930 set->catname[dot - name] = '\0'; /* Just in case */
931 XBT_DEBUG("This is for cat '%s'", set->catname);
936 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
939 xbt_log_category_t child, res;
941 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
942 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
943 (cat->nextSibling ? cat->nextSibling->name : "none"));
944 if (!strcmp(cat->name, name))
947 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
948 XBT_DEBUG("Dig into %s", child->name);
949 res = _xbt_log_cat_searchsub(child, name);
959 * \param control_string What to parse
961 * Typically passed a command-line argument. The string has the syntax:
963 * ( [category] "." [keyword] ":" value (" ")... )...
965 * where [category] is one the category names (see \ref XBT_log_cats for
966 * a complete list of the ones defined in the SimGrid library)
967 * and keyword is one of the following:
969 * - thres: category's threshold priority. Possible values:
970 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
971 * - add or additivity: whether the logging actions must be passed to
972 * the parent category.
973 * Possible values: 0, 1, no, yes, on, off.
974 * Default value: yes.
975 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
976 * - app or appender: the appender to use. See \ref log_use_conf_app for more
980 void xbt_log_control_set(const char *control_string)
982 xbt_log_setting_t set;
984 /* To split the string in commands, and the cursors */
985 xbt_dynar_t set_strings;
991 XBT_DEBUG("Parse log settings '%s'", control_string);
993 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
994 if (!strcmp(control_string, "no_loc")) {
998 /* some initialization if this is the first time that this get called */
999 if (xbt_log_settings == NULL)
1000 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1003 /* split the string, and remove empty entries */
1004 set_strings = xbt_str_split_quoted(control_string);
1006 if (xbt_dynar_length(set_strings) == 0) { /* vicious user! */
1007 xbt_dynar_free(&set_strings);
1011 /* Parse each entry and either use it right now (if the category was already
1012 created), or store it for further use */
1013 xbt_dynar_foreach(set_strings, cpt, str) {
1014 xbt_log_category_t cat = NULL;
1016 set = _xbt_log_parse_setting(str);
1018 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1021 XBT_DEBUG("Apply directly");
1022 _xbt_log_cat_apply_set(cat, set);
1023 _free_setting((void *) &set);
1026 XBT_DEBUG("Store for further application");
1027 XBT_DEBUG("push %p to the settings", (void *) set);
1028 xbt_dynar_push(xbt_log_settings, &set);
1031 xbt_dynar_free(&set_strings);
1034 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1036 if (cat->appender) {
1037 if (cat->appender->free_)
1038 cat->appender->free_(cat->appender);
1039 free(cat->appender);
1041 cat->appender = app;
1044 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1046 #define _xbt_log_cat_init(a, b) (0)
1047 if (!cat->appender) {
1049 ("No appender to category %s. Setting the file appender as default",
1051 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1054 if (cat->layout->free_) {
1055 cat->layout->free_(cat->layout);
1060 xbt_log_additivity_set(cat, 0);
1061 #undef _xbt_log_cat_init
1064 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1066 cat->additivity = additivity;