3 /* log - a generic logging facility in the spirit of log4j */
5 /* Copyright (c) 2003, 2004 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"
22 #include "xbt/sysdep.h"
24 #include "xbt/dynar.h"
26 XBT_PUBLIC_DATA(int) (*xbt_pid)();
28 /** \addtogroup XBT_log
30 * This section describes the API to the log functions used
31 * everywhere in this project.
33 \section XBT_log_toc Table of contents
43 - \ref log_API_isenabled
46 - \ref log_API_example
49 - \ref log_use_conf_thres
50 - \ref log_use_conf_multi
51 - \ref log_use_conf_fmt
52 - \ref log_use_conf_add
59 \section log_overview 1. Introduction
61 This module is in charge of handling the log messages of every SimGrid
62 program. The main design goal are:
64 - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
65 what to hide, as well as how messages get displayed.
66 - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
67 and to the user (with command line options)
68 - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
69 - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
70 and the logging mecanism allows to syndicate each and every log source into the same place.
71 At least, its design would allow to, once we write the last missing pieces
73 There is three main concepts in SimGrid's logging mecanism: <i>category</i>,
74 <i>priority</i> and <i>appender</i>. These three concepts work together to
75 enable developers to log messages according to message type and priority, and
76 to control at runtime how these messages are formatted and where they are
79 \subsection log_cat 1.1 Category hierarchy
81 The first and foremost advantage of any logging API over plain printf()
82 resides in its ability to disable certain log statements while allowing
83 others to print unhindered. This capability assumes that the logging space,
84 that is, the space of all possible logging statements, is categorized
85 according to some developer-chosen criteria.
87 This observation led to choosing category as the central concept of the
88 system. In a certain sense, they can be considered as logging topics or
91 \subsection log_pri 1.2 Logging priorities
93 The user can naturally declare interest into this or that logging category, but
94 he also can specify the desired level of details for each of them. This is
95 controled by the <i>priority</i> concept (which should maybe be renamed to
98 Empirically, the user can specify that he wants to see every debuging message
99 of GRAS while only being interested into the messages at level "error" or
100 higher about the XBT internals.
102 \subsection log_app 1.3 Message appenders
104 The message appenders are the elements in charge of actually displaying the
105 message to the user. For now, there is only one appender: the one able to print
106 stuff on stderr. But everything is in place internally to write new ones, such
107 as the one able to send the strings to a central server in charge of
108 syndicating the logs of every distributed daemons on a well known location.
112 \subsection log_lay 1.4 Message layouts
114 The message layouts are the elements in charge of choosing how each message
115 will look like. Their result is a string which is then passed to the appender
116 attached to the category to be displayed.
118 For now, there is two layouts: The simple one, which is good for most cases,
119 and another one allowing users to specify the format they want.
120 \ref log_use_conf provides more info on this.
122 \subsection log_hist 1.5 History of this module
124 Historically, this module is an adaptation of the log4c project, which is dead
125 upstream, and which I was given the permission to fork under the LGPL licence
126 by the log4c's authors. The log4c project itself was loosely based on the
127 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
128 differs somehow from these projects anyway, because the C programming language
129 is not object oriented.
131 \section log_API 2. Programmer interface
133 \subsection log_API_cat 2.1 Constructing the category hierarchy
135 Every category is declared by providing a name and an optional
136 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
137 the category's parent.
139 A category is created by a macro call at the top level of a file. A
140 category can be created with any one of the following macros:
142 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
143 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
144 Create a new category being child of the category ParentCat
145 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
146 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
148 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
149 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
152 The parent cat can be defined in the same file or in another file (in
153 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
154 it visible in the current file), but each category may have only one
157 Typically, there will be a Category for each module and sub-module, so you
158 can independently control logging for each module.
160 For a list of all existing categories, please refer to the \ref XBT_log_cats
161 section. This file is generated automatically from the SimGrid source code, so
162 it should be complete and accurate.
164 \section log_API_pri 2.2 Declaring message priority
166 A category may be assigned a threshold priorty. The set of priorites are
167 defined by the \ref e_xbt_log_priority_t enum. All logging request under
168 this priority will be discarded.
170 If a given category is not assigned a threshold priority, then it inherits
171 one from its closest ancestor with an assigned threshold. To ensure that all
172 categories can eventually inherit a threshold, the root category always has
173 an assigned threshold priority.
175 Logging requests are made by invoking a logging macro on a category. All of
176 the macros have a printf-style format string followed by arguments. If you
177 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
178 when you pass a pointer to a string where an integer was specified by the
179 format. This is usualy a good idea.
181 Because some C compilers do not support vararg macros, there is a version of
182 the macro for any number of arguments from 0 to 6. The macro name ends with
183 the total number of arguments.
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>CLOG5(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 priorites 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>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
203 \section log_API_isenabled 2.3 Checking if a perticular category/priority is enabled
205 It is sometimes useful to check whether a perticular category is
206 enabled at a perticular 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>WARN3("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 DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
230 ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB10,
231 #INFO10, #WARN10, #ERROR10 and #CRITICAL10). For each group, there is at
232 least 11 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
233 DEBUG5, DEBUG6, DEBUG7, DEBUG8, DEBUG9, DEBUG10), only differing in the number of arguments passed along the format.
234 This is because we want SimGrid itself to keep compilable on ancient
235 compiler not supporting variable number of arguments to macros. But we
236 should provide a macro simpler to use for the users not interested in SP3
239 Under GCC, these macro check there arguments the same way than printf does. So,
240 if you compile with -Wall, the folliwing code will issue a warning:
241 <code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
243 If you want to specify the category to log onto (for example because you
244 have more than one category per file, add a C before the name of the log
245 producing macro (ie, use #CDEBUG10, #CVERB10, #CINFO10, #CWARN10, #CERROR10 and
246 #CCRITICAL10 and friends), and pass the category name as first argument.
248 The TRACE priority is not used the same way than the other. You should use
249 the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
252 \section log_API_example 2.6 Example of use
254 Here is a more complete example:
259 / * create a category and a default subcategory * /
260 XBT_LOG_NEW_CATEGORY(VSS);
261 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
264 / * Now set the parent's priority. (the string would typcially be a runtime option) * /
265 xbt_log_control_set("SA.thresh:3");
267 / * This request is enabled, because WARNING >= INFO. * /
268 CWARN2(VSS, "Low fuel level.");
270 / * This request is disabled, because DEBUG < INFO. * /
271 CDEBUG2(VSS, "Starting search for nearest gas station.");
273 / * The default category SA inherits its priority from VSS. Thus,
274 the following request is enabled because INFO >= INFO. * /
275 INFO1("Located nearest gas station.");
277 / * This request is disabled, because DEBUG < INFO. * /
278 DEBUG1("Exiting gas station search");
282 Another example can be found in the relevant part of the GRAS tutorial:
283 \ref GRAS_tut_tour_logs.
285 \section log_user 3. User interface
287 \section log_use_conf 3.1 Configuration
289 Although rarely done, it is possible to configure the logs during
290 program initialization by invoking the xbt_log_control_set() method
291 manually. A more conventionnal way is to use the --log command line
292 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
293 checks and deals properly with such arguments.
295 The following command line arguments exist, but are deprecated and
296 may disapear in the future: --xbt-log, --gras-log, --msg-log and
299 \subsection log_use_conf_thres 3.1.1 Thresold configuration
301 The most common setting is to control which logging event will get
302 displayed by setting a threshold to each category through the
303 <tt>thres</tt> keyword.
305 For example, \verbatim --log=root.thres:debug\endverbatim will make
306 SimGrid <b>extremely</b> verbose while \verbatim
307 --log=root.thres:critical\endverbatim should shut it almost
310 \subsection log_use_conf_multi 3.1.2 Passing several settings
312 You can provide several of those arguments to change the setting of several
313 categories, they will be applied from left to right. So,
314 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
315 disable almost any logging.
317 Note that the quotes on above line are mandatory because there is a space in
318 the argument, so we are protecting ourselves from the shell, not from SimGrid.
319 We could also reach the same effect with this:
320 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
322 \subsection log_use_conf_fmt 3.1.3 Format configuration
324 As with SimGrid 3.3, it is possible to control the format of log
325 messages. This is done through the <tt>fmt</tt> keyword. For example,
326 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
327 user-message only, removing any decoration such as the date, or the
328 process ID, everything.
330 Here are the existing format directives:
333 - %%n: platform-dependant line separator (LOG4J compliant)
334 - %%e: plain old space (SimGrid extension)
336 - %%m: user-provided message
338 - %%c: Category name (LOG4J compliant)
339 - %%p: Priority name (LOG4J compliant)
341 - %%h: Hostname (SimGrid extension)
342 - %%P: Process name (SimGrid extension)
343 - %%t: Thread "name" (LOG4J compliant -- actually the address of the thread in memory)
344 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
346 - %%F: file name where the log event was raised (LOG4J compliant)
347 - %%l: location where the log event was raised (LOG4J compliant, like '%%F:%%L' -- this is a l as in 'l'etter)
348 - %%L: line number where the log event was raised (LOG4J compliant)
349 - %%M: function name (LOG4J compliant -- called method name here of course).
350 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
352 - %%b: full backtrace (Called %%throwable in LOG4J).
353 Defined only when using the GNU libc because backtrace() is not defined
355 - %%B: short backtrace (only the first line of the %%b).
356 Called %%throwable{short} in LOG4J; defined where %%b is.
358 - %%d: date (UNIX-like epoch)
359 - %%r: application age (time elapsed since the beginning of the application)
362 If you want to mimick the simple layout with the format one, you would use this
363 format: '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
364 because the simple layout do not display the message location for messages at
365 priority INFO (thus, the fmt is '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n' in this
366 case). Moreover, if there is no process name (ie, messages comming from the
367 library itself, or test programs doing strange things) do not display the
368 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
369 [%%c/%%p] %%m%%n' if they are at priority INFO).
371 For now, there is only one format modifyier: the precision field. You
372 can for example specify %.4r to get the application age with 4
373 numbers after the radix. Another limitation is that you cannot set
374 specific layouts to the several priorities.
376 \subsection log_use_conf_add 3.1.4 Category additivity
378 The <tt>add</tt> keyword allows to specify the additivity of a
379 category (see \ref log_in_app). This is rarely useful since you
380 cannot specify an alternative appender. Anyway, '0', '1', 'no',
381 'ye's, 'on' and 'off' are all valid values, with 'yes' as default.
383 \section log_use_misc 3.2 Misc and Caveats
385 - Do not use any of the macros that start with '_'.
386 - Log4J has a 'rolling file appender' which you can select with a run-time
387 option and specify the max file size. This would be a nice default for
388 non-kernel applications.
389 - Careful, category names are global variables.
391 \section log_internals 4. Internal considerations
393 This module is a mess of macro black magic, and when it goes wrong,
394 SimGrid studently loose its ability to explain its problems. When
395 messing around this module, I often find useful to define
396 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
397 of finding what's going wrong. But things are quite verbose when
398 everything is enabled...
400 \section log_in_perf 4.1 Performance
402 Except for the first invocation of a given category, a disabled logging request
403 requires an a single comparison of a static variable to a constant.
405 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
406 causes all logging requests with a lower priority to be optimized to 0 cost
407 by the compiler. By setting it to gras_log_priority_infinite, all logging
408 requests are statically disabled and cost nothing. Released executables
409 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
410 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
412 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
413 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
414 the requests of priority below INFO.
416 \todo Logging performance *may* be improved further by improving the message
417 propagation from appender to appender in the category tree.
419 \section log_in_app 4.2 Appenders
421 Each category has an optional appender. An appender is a pointer to a
422 structure which starts with a pointer to a doAppend() function. DoAppend()
423 prints a message to a log.
425 When a category is passed a message by one of the logging macros, the
426 category performs the following actions:
428 - if the category has an appender, the message is passed to the
429 appender's doAppend() function,
430 - if additivity is true for the category (which is the case by
431 default, and can be controlled by xbt_log_additivity_set()), the
432 message is passed to the category's parent.
434 By default, only the root category have an appender, and any other category has
435 its additivity set to true. This causes all messages to be logged by the root
438 The default appender function currently prints to stderr, and no other one
439 exist, even if more would be needed, like the one able to send the logs to a
440 remote dedicated server, or other ones offering different output formats.
441 This is on our TODO list for quite a while now, but your help would be
448 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
449 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
454 e_xbt_log_priority_t thresh;
457 } s_xbt_log_setting_t,*xbt_log_setting_t;
459 static xbt_dynar_t xbt_log_settings=NULL;
461 static void _free_setting(void *s) {
462 xbt_log_setting_t set=*(xbt_log_setting_t*)s;
470 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
471 xbt_log_setting_t setting);
473 const char *xbt_log_priority_names[8] = {
484 XBT_PUBLIC_DATA(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
486 "root", xbt_log_priority_uninitialized, 0,
490 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
491 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
492 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
493 XBT_LOG_NEW_CATEGORY(simix,"All SIMIX categories");
494 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
496 /** @brief Get all logging settings from the command line
498 * xbt_log_control_set() is called on each string we got from cmd line
500 void xbt_log_init(int *argc,char **argv) {
504 /* create the default appender and install it in the root category,
505 which were already created (damnit. Too slow little beetle)*/
506 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
507 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
508 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
509 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
512 /* Set logs and init log submodule */
513 for (i=1; i<*argc; i++){
514 if (!strncmp(argv[i],"--log=",strlen("--log=")) ||
515 !strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
516 !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
517 !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
518 !strncmp(argv[i],"--simix-log=",strlen("--simix-log=")) ||
519 !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
521 if (strncmp(argv[i],"--log=",strlen("--log=")))
522 WARN2("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
523 (int)(strchr(argv[i],'=')-argv[i]),argv[i]);
525 opt=strchr(argv[i],'=');
527 xbt_log_control_set(opt);
528 DEBUG1("Did apply '%s' as log setting",opt);
529 /*remove this from argv*/
531 for (j=i+1; j<*argc; j++){
537 i--; /* compensate effect of next loop incrementation */
542 static void log_cat_exit(xbt_log_category_t cat) {
543 xbt_log_category_t child;
546 if (cat->appender->free_)
547 cat->appender->free_(cat->appender);
551 if (cat->layout->free_)
552 cat->layout->free_(cat->layout);
556 for(child=cat->firstChild ; child != NULL; child = child->nextSibling)
560 void xbt_log_exit(void) {
561 VERB0("Exiting log");
562 xbt_dynar_free(&xbt_log_settings);
563 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
567 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
569 xbt_log_category_t cat = ev->cat;
571 fprintf(stderr,"XXXXXXXXXXXXXXXXXXX\nXXX Warning, logs not usable here. Either before xbt_init() or after xbt_exit().\nXXXXXXXXXXXXXXXXXXX\n");
572 va_start(ev->ap, fmt);
573 vfprintf(stderr,fmt,ev->ap);
575 xbt_backtrace_display_current();
579 va_start(ev->ap, fmt);
581 xbt_log_appender_t appender = cat->appender;
582 if (appender != NULL) {
583 xbt_assert1(cat->layout,"No valid layout for the appender of category %s",cat->name);
584 cat->layout->do_layout(cat->layout, ev, fmt);
585 appender->do_append(appender, ev->buffer);
587 if (!cat->additivity)
595 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
596 xbt_log_setting_t setting) {
598 s_xbt_log_event_t _log_ev;
600 if (setting->thresh != xbt_log_priority_uninitialized) {
601 xbt_log_threshold_set(category, setting->thresh);
603 if (category->threshold <= xbt_log_priority_debug) {
604 _log_ev.cat = category;
605 _log_ev.priority = xbt_log_priority_debug;
606 _log_ev.fileName = __FILE__ ;
607 _log_ev.functionName = _XBT_FUNCTION ;
608 _log_ev.lineNum = __LINE__ ;
610 _xbt_log_event_log(&_log_ev,
611 "Apply settings for category '%s': set threshold to %s (=%d)",
613 xbt_log_priority_names[category->threshold],
614 category->threshold);
619 xbt_log_layout_set(category,xbt_log_layout_format_new(setting->fmt));
621 if (category->threshold <= xbt_log_priority_debug) {
622 _log_ev.cat = category;
623 _log_ev.priority = xbt_log_priority_debug;
624 _log_ev.fileName = __FILE__ ;
625 _log_ev.functionName = _XBT_FUNCTION ;
626 _log_ev.lineNum = __LINE__ ;
628 _xbt_log_event_log(&_log_ev,
629 "Apply settings for category '%s': set format to %s",
635 if (setting->additivity != -1) {
636 xbt_log_additivity_set(category,setting->additivity);
638 if (category->threshold <= xbt_log_priority_debug) {
639 _log_ev.cat = category;
640 _log_ev.priority = xbt_log_priority_debug;
641 _log_ev.fileName = __FILE__ ;
642 _log_ev.functionName = _XBT_FUNCTION ;
643 _log_ev.lineNum = __LINE__ ;
645 _xbt_log_event_log(&_log_ev,
646 "Apply settings for category '%s': set additivity to %s",
648 (setting->additivity?"on":"off"));
653 * This gets called the first time a category is referenced and performs the
655 * Also resets threshold to inherited!
657 int _xbt_log_cat_init(xbt_log_category_t category,
658 e_xbt_log_priority_t priority) {
660 xbt_log_setting_t setting=NULL;
662 s_xbt_log_event_t _log_ev;
664 if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
665 category->threshold = xbt_log_priority_info;/* xbt_log_priority_debug*/;
666 category->appender = xbt_log_default_appender;
667 category->layout = xbt_log_default_layout;
670 if (!category->parent)
671 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
673 xbt_log_parent_set(category, category->parent);
676 /* Apply the control */
677 if (!xbt_log_settings)
678 return priority >= category->threshold;
680 xbt_assert0(category,"NULL category");
681 xbt_assert(category->name);
683 xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
684 xbt_assert0(setting,"Damnit, NULL cat in the list");
685 xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
687 if (!strcmp(setting->catname,category->name)) {
691 _xbt_log_cat_apply_set(category,setting);
693 xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
697 if (!found && category->threshold <= xbt_log_priority_verbose) {
699 _log_ev.cat = category;
700 _log_ev.priority = xbt_log_priority_verbose;
701 _log_ev.fileName = __FILE__ ;
702 _log_ev.functionName = _XBT_FUNCTION ;
703 _log_ev.lineNum = __LINE__ ;
705 _xbt_log_event_log(&_log_ev,
706 "Category '%s': inherited threshold = %s (=%d)",
708 xbt_log_priority_names[category->threshold], category->threshold);
711 return priority >= category->threshold;
714 void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent)
717 xbt_assert0(cat,"NULL category to be given a parent");
718 xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
721 * if the threshold is initialized
722 * unlink from current parent
724 if(cat->threshold != xbt_log_priority_uninitialized){
726 xbt_log_category_t* cpp = &parent->firstChild;
728 while(*cpp != cat && *cpp != NULL) {
729 cpp = &(*cpp)->nextSibling;
732 xbt_assert(*cpp == cat);
733 *cpp = cat->nextSibling;
736 cat->parent = parent;
737 cat->nextSibling = parent->firstChild;
739 parent->firstChild = cat;
741 if (parent->threshold == xbt_log_priority_uninitialized){
743 _xbt_log_cat_init(parent,
744 xbt_log_priority_uninitialized/* ignored*/);
747 cat->threshold = parent->threshold;
749 cat->isThreshInherited = 1;
753 static void _set_inherited_thresholds(xbt_log_category_t cat) {
755 xbt_log_category_t child = cat->firstChild;
757 for( ; child != NULL; child = child->nextSibling) {
758 if (child->isThreshInherited) {
759 if (cat != &_XBT_LOGV(log))
760 VERB3("Set category threshold of %s to %s (=%d)",
761 child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
762 child->threshold = cat->threshold;
763 _set_inherited_thresholds(child);
770 void xbt_log_threshold_set(xbt_log_category_t cat,
771 e_xbt_log_priority_t threshold) {
772 cat->threshold = threshold;
773 cat->isThreshInherited = 0;
775 _set_inherited_thresholds(cat);
779 static xbt_log_setting_t _xbt_log_parse_setting(const char* control_string) {
781 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t,1);
782 const char *name, *dot, *eq;
785 set->thresh = xbt_log_priority_uninitialized;
787 set->additivity = -1;
789 if (!*control_string)
791 DEBUG1("Parse log setting '%s'",control_string);
793 control_string += strspn(control_string, " ");
794 name = control_string;
795 control_string += strcspn(control_string, ".= ");
796 dot = control_string;
797 control_string += strcspn(control_string, ":= ");
799 control_string += strcspn(control_string, " ");
801 xbt_assert1(*dot == '.' && (*eq == '=' || *eq == ':'),
802 "Invalid control string '%s'",control_string);
804 if (!strncmp(dot + 1, "thresh", (size_t)(eq - dot - 1))) {
806 char *neweq=xbt_strdup(eq+1);
809 while (*(++p) != '\0') {
810 if (*p >= 'a' && *p <= 'z') {
815 DEBUG1("New priority name = %s",neweq);
816 for (i=0; i<xbt_log_priority_infinite; i++) {
817 if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
818 DEBUG1("This is priority %d",i);
822 if (i<xbt_log_priority_infinite) {
823 set->thresh= (e_xbt_log_priority_t) i;
826 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",eq+1);
829 } else if ( !strncmp(dot + 1, "add", (size_t)(eq - dot - 1)) ||
830 !strncmp(dot + 1, "additivity", (size_t)(eq - dot - 1)) ) {
832 char *neweq=xbt_strdup(eq+1);
835 while (*(++p) != '\0') {
836 if (*p >= 'a' && *p <= 'z') {
840 if ( !strcmp(neweq,"ON") ||
841 !strcmp(neweq,"YES") ||
842 !strcmp(neweq,"1") ) {
848 } else if (!strncmp(dot + 1, "fmt", (size_t)(eq - dot - 1))) {
849 set->fmt = xbt_strdup(eq+1);
852 snprintf(buff,min(512,eq - dot),"%s",dot+1);
853 THROW1(arg_error,0,"Unknown setting of the log category: '%s'",buff);
855 set->catname=(char*)xbt_malloc(dot - name+1);
857 memcpy(set->catname,name,dot-name);
858 set->catname[dot-name]='\0'; /* Just in case */
859 DEBUG1("This is for cat '%s'", set->catname);
864 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
865 xbt_log_category_t child;
867 if (!strcmp(cat->name,name))
870 for(child=cat->firstChild ; child != NULL; child = child->nextSibling)
871 return _xbt_log_cat_searchsub(child,name);
873 THROW1(not_found_error,0,"No such category: %s", name);
878 * \param control_string What to parse
880 * Typically passed a command-line argument. The string has the syntax:
882 * ( [category] "." [keyword] ":" value (" ")... )...
884 * where [category] is one the category names (see \ref XBT_log_cats for
885 * a complete list of the ones defined in the SimGrid library)
886 * and keyword is one of the following:
888 * - thres: category's threshold priority. Possible values:
889 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
890 * - add or additivity: whether the logging actions must be passed to
891 * the parent category.
892 * Possible values: 0, 1, no, yes, on, off.
893 * Default value: yes.
894 * - fmt: the format to use. See \ref log_lay for more information.
897 void xbt_log_control_set(const char* control_string) {
898 xbt_log_setting_t set;
900 /* To split the string in commands, and the cursors */
901 xbt_dynar_t set_strings;
907 DEBUG1("Parse log settings '%s'",control_string);
909 /* some initialization if this is the first time that this get called */
910 if (xbt_log_settings == NULL)
911 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
914 /* split the string, and remove empty entries */
915 set_strings=xbt_str_split_quoted(control_string);
917 if (xbt_dynar_length(set_strings) == 0) { /* vicious user! */
918 xbt_dynar_free(&set_strings);
922 /* Parse each entry and either use it right now (if the category was already
923 created), or store it for further use */
924 xbt_dynar_foreach(set_strings,cpt,str) {
925 xbt_log_category_t cat=NULL;
929 set = _xbt_log_parse_setting(str);
932 cat = _xbt_log_cat_searchsub(&_XBT_LOGV(root),set->catname);
935 if (e.category != not_found_error)
942 DEBUG0("Apply directly");
943 _xbt_log_cat_apply_set(cat,set);
944 _free_setting((void*)&set);
947 DEBUG0("Store for further application");
948 DEBUG1("push %p to the settings",(void*)set);
949 xbt_dynar_push(xbt_log_settings,&set);
952 xbt_dynar_free(&set_strings);
955 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
957 if (cat->appender->free_)
958 cat->appender->free_(cat->appender);
963 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) {
964 if (!cat->appender) {
965 VERB1("No appender to category %s. Setting the file appender as default",
967 xbt_log_appender_set(cat,xbt_log_appender_file_new(NULL));
969 if (cat->layout && cat != &_XBT_LOGV(root)) {
970 /* better leak the default layout than check every categories to
972 if (cat->layout->free_) {
973 cat->layout->free_(cat->layout);
978 xbt_log_additivity_set(cat,0);
981 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) {
982 cat->additivity = additivity;