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
45 - \ref log_API_example
54 \section log_overview 1. Introduction
56 This module is in charge of handling the log messages of every SimGrid
57 program. The main design goal are:
59 - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
60 what to hide, as well as how messages get displayed.
61 - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
62 and to the user (with command line options)
63 - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
64 - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
65 and the logging mecanism allows to syndicate each and every log source into the same place.
66 At least, its design would allow to, once we write the last missing pieces
68 There is three main concepts in SimGrid's logging mecanism: <i>category</i>,
69 <i>priority</i> and <i>appender</i>. These three concepts work together to
70 enable developers to log messages according to message type and priority, and
71 to control at runtime how these messages are formatted and where they are
74 \subsection log_cat 1.1 Category hierarchy
76 The first and foremost advantage of any logging API over plain printf()
77 resides in its ability to disable certain log statements while allowing
78 others to print unhindered. This capability assumes that the logging space,
79 that is, the space of all possible logging statements, is categorized
80 according to some developer-chosen criteria.
82 This observation led to choosing category as the central concept of the
83 system. In a certain sense, they can be considered as logging topics or
86 \subsection log_pri 1.2 Logging priorities
88 The user can naturally declare interest into this or that logging category, but
89 he also can specify the desired level of details for each of them. This is
90 controled by the <i>priority</i> concept (which should maybe be renamed to
93 Empirically, the user can specify that he wants to see every debuging message
94 of GRAS while only being interested into the messages at level "error" or
95 higher about the XBT internals.
97 \subsection log_app 1.3 Message appenders
99 The message appenders are the elements in charge of actually displaying the
100 message to the user. For now, there is only one appender: the one able to print
101 stuff on stderr. But everything is in place internally to write new ones, such
102 as the one able to send the strings to a central server in charge of
103 syndicating the logs of every distributed daemons on a well known location.
105 It should also be possible to pass configuration informations to the appenders,
106 specifying for example that the message location (file and line number) is only
107 relevant to debugging information, not to critical error messages.
111 \subsection log_lay 1.4 Message layouts
113 The message layouts are the elements in charge of choosing how each message
114 will look like. Their result is a string which is then passed to the appender
115 attached to the category to be displayed.
117 For now, there is two layouts: The simple one, which is good for most cases,
118 and another one allowing users to specify the format they want.
120 Here are the existing format directives:
123 - %n: platform-dependant line separator (LOG4J compliant)
124 - %e: plain old space (SimGrid extension)
126 - %m: user-provided message
128 - %c: Category name (LOG4J compliant)
129 - %p: Priority name (LOG4J compliant)
131 - %h: Hostname (SimGrid extension)
132 - %t: Process name (LOG4J compliant -- thread name in LOG4J)
133 - %I: Process PID (SimGrid extension)
135 - %F: file name where the log event was raised (LOG4J compliant)
136 - %l: location where the log event was raised (LOG4J compliant, like '%F:%L')
137 - %L: line number where the log event was raised (LOG4J compliant)
138 - %M: function name (LOG4J compliant -- called method name here of course).
139 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
141 - %b: full backtrace (Called %throwable in LOG4J).
142 Defined only when using the GNU libc because backtrace() is not defined
144 - %B: short backtrace (only the first line of the %b).
145 Called %throwable{short} in LOG4J, defined where %b is.
147 - %d: date (UNIX epoch)
148 - %r: application age (time elapsed since the beginning of the application)
151 If you want to mimick the simple layout with the format one, you would use this
152 format: '[%h:%i:(%I) %r] %l: [%c/%p] %m%n'. This is not completely correct
153 because the simple layout do not display the message location for messages at
154 priority INFO (thus, the fmt is '[%h:%i:(%I) %r] %l: [%c/%p] %m%n' in this
155 case). Moreover, if there is no process name (ie, messages comming from the
156 library itself, or test programs doing strange things) do not display the
157 process identity (thus, fmt is '[%r] %l: [%c/%p] %m%n' in that case, and '[%r]
158 [%c/%p] %m%n' if they are at priority INFO).
160 For now, there is only one format modifyier: the precision field. You can for
161 example specify %.4r to get the application age with 4 numbers after the radix.
163 \subsection log_hist 1.5 History of this module
165 Historically, this module is an adaptation of the log4c project, which is dead
166 upstream, and which I was given the permission to fork under the LGPL licence
167 by the log4c's authors. The log4c project itself was loosely based on the
168 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
169 differs somehow from these projects anyway, because the C programming language
170 is not object oriented.
172 \section log_API 2. Programmer interface
174 \subsection log_API_cat 2.1 Constructing the category hierarchy
176 Every category is declared by providing a name and an optional
177 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
178 the category's parent.
180 A category is created by a macro call at the top level of a file. A
181 category can be created with any one of the following macros:
183 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
184 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
185 Create a new category being child of the category ParentCat
186 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
187 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
189 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
190 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
193 The parent cat can be defined in the same file or in another file (in
194 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
195 it visible in the current file), but each category may have only one
198 Typically, there will be a Category for each module and sub-module, so you
199 can independently control logging for each module.
201 For a list of all existing categories, please refer to the \ref XBT_log_cats
202 section. This file is generated automatically from the SimGrid source code, so
203 it should be complete and accurate.
205 \section log_API_pri 2.2 Declaring message priority
207 A category may be assigned a threshold priorty. The set of priorites are
208 defined by the \ref e_xbt_log_priority_t enum. All logging request under
209 this priority will be discarded.
211 If a given category is not assigned a threshold priority, then it inherits
212 one from its closest ancestor with an assigned threshold. To ensure that all
213 categories can eventually inherit a threshold, the root category always has
214 an assigned threshold priority.
216 Logging requests are made by invoking a logging macro on a category. All of
217 the macros have a printf-style format string followed by arguments. If you
218 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
219 when you pass a pointer to a string where an integer was specified by the
220 format. This is usualy a good idea.
222 Because some C compilers do not support vararg macros, there is a version of
223 the macro for any number of arguments from 0 to 6. The macro name ends with
224 the total number of arguments.
226 Here is an example of the most basic type of macro. This is a logging
227 request with priority <i>warning</i>.
229 <code>CLOG5(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
232 A logging request is said to be enabled if its priority is higher than or
233 equal to the threshold priority of its category. Otherwise, the request is
234 said to be disabled. A category without an assigned priority will inherit
235 one from the hierarchy.
237 It is possible to use any non-negative integer as a priority. If, as in the
238 example, one of the standard priorites is used, then there is a convenience
239 macro that is typically used instead. For example, the above example is
240 equivalent to the shorter:
242 <code>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
244 \section log_API_subcat 2.3 Using a default category (the easy interface)
246 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
247 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
248 category, then the even shorter form can be used:
250 <code>WARN3("Values are: %d and '%s'", 5, "oops");</code>
252 Only one default category can be created per file, though multiple
253 non-defaults can be created and used.
255 \section log_API_easy 2.4 Putting all together: the easy interface
257 First of all, each module should register its own category into the categories
258 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
260 Then, logging should be done with the DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
261 ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB10,
262 #INFO10, #WARN10, #ERROR10 and #CRITICAL10). For each group, there is at
263 least 11 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
264 DEBUG5, DEBUG6, DEBUG7, DEBUG8, DEBUG9, DEBUG10), only differing in the number of arguments passed along the format.
265 This is because we want SimGrid itself to keep compilable on ancient
266 compiler not supporting variable number of arguments to macros. But we
267 should provide a macro simpler to use for the users not interested in SP3
270 Under GCC, these macro check there arguments the same way than printf does. So,
271 if you compile with -Wall, the folliwing code will issue a warning:
272 <code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
274 If you want to specify the category to log onto (for example because you
275 have more than one category per file, add a C before the name of the log
276 producing macro (ie, use #CDEBUG10, #CVERB10, #CINFO10, #CWARN10, #CERROR10 and
277 #CCRITICAL10 and friends), and pass the category name as first argument.
279 The TRACE priority is not used the same way than the other. You should use
280 the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
283 \section log_API_example 2.5 Example of use
285 Here is a more complete example:
290 / * create a category and a default subcategory * /
291 XBT_LOG_NEW_CATEGORY(VSS);
292 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
295 / * Now set the parent's priority. (the string would typcially be a runtime option) * /
296 xbt_log_control_set("SA.thresh:3");
298 / * This request is enabled, because WARNING >= INFO. * /
299 CWARN2(VSS, "Low fuel level.");
301 / * This request is disabled, because DEBUG < INFO. * /
302 CDEBUG2(VSS, "Starting search for nearest gas station.");
304 / * The default category SA inherits its priority from VSS. Thus,
305 the following request is enabled because INFO >= INFO. * /
306 INFO1("Located nearest gas station.");
308 / * This request is disabled, because DEBUG < INFO. * /
309 DEBUG1("Exiting gas station search");
313 Another example can be found in the relevant part of the GRAS tutorial:
314 \ref GRAS_tut_tour_logs.
316 \section log_user 3. User interface
318 \section log_use_conf 3.1 Configuration
319 Configuration is typically done during program initialization by invoking
320 the xbt_log_control_set() method. The control string passed to it typically
321 comes from the command line. Look at the documentation for that function for
322 the format of the control string.
324 Any SimGrid program can furthermore be configured at run time by passing a
325 --xbt-log argument on the command line (--gras-log, --msg-log and --surf-log
326 are synonyms provided by aestheticism). You can provide several of those
327 arguments to change the setting of several categories, they will be applied
328 from left to right. So,
329 \verbatim --xbt-log="root.thres:debug root.thres:critical"\endverbatim
330 should disable any logging.
332 Note that the quotes on above line are mandatory because there is a space in
333 the argument, so we are protecting ourselves from the shell, not from SimGrid.
334 We could also reach the same effect with this:
335 \verbatim --xbt-log=root.thres:debug --xbt-log=root.thres:critical\endverbatim
337 \section log_use_misc 3.2 Misc and Caveats
339 - Do not use any of the macros that start with '_'.
340 - Log4J has a 'rolling file appender' which you can select with a run-time
341 option and specify the max file size. This would be a nice default for
342 non-kernel applications.
343 - Careful, category names are global variables.
345 \section log_internals 4. Internal considerations
347 This module is a mess of macro black magic, and when it goes wrong, SimGrid
348 studently loose its ability to explain its problems. When messing around this
349 module, I often find useful to define XBT_LOG_MAYDAY (which turns it back to
350 good old printf) for the time of finding what's going wrong.
352 \section log_in_perf 4.1 Performance
354 Except for the first invocation of a given category, a disabled logging request
355 requires an a single comparison of a static variable to a constant.
357 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
358 causes all logging requests with a lower priority to be optimized to 0 cost
359 by the compiler. By setting it to gras_log_priority_infinite, all logging
360 requests are statically disabled and cost nothing. Released executables
361 might be compiled with
362 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
364 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
365 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
366 the requests of priority below INFO.
368 \todo Logging performance *may* be improved further by improving the message
369 propagation from appender to appender in the category tree.
371 \section log_in_app 4.2 Appenders
373 Each category has an optional appender. An appender is a pointer to a
374 structure which starts with a pointer to a doAppend() function. DoAppend()
375 prints a message to a log.
377 When a category is passed a message by one of the logging macros, the
378 category performs the following actions:
380 - if the category has an appender, the message is passed to the
381 appender's doAppend() function,
382 - if additivity is true for the category (which is the case by
383 default, and can be controlled by xbt_log_additivity_set()), the
384 message is passed to the category's parent.
386 By default, only the root category have an appender, and any other category has
387 its additivity set to true. This causes all messages to be logged by the root
390 The default appender function currently prints to stderr, and no other one
391 exist, even if more would be needed, like the one able to send the logs to a
392 remote dedicated server, or other ones offering different output formats.
393 This is on our TODO list for quite a while now, but your help would be
400 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
401 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
406 e_xbt_log_priority_t thresh;
409 } s_xbt_log_setting_t,*xbt_log_setting_t;
411 static xbt_dynar_t xbt_log_settings=NULL;
413 static void _free_setting(void *s) {
414 xbt_log_setting_t set=*(xbt_log_setting_t*)s;
422 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
423 xbt_log_setting_t setting);
425 const char *xbt_log_priority_names[8] = {
436 XBT_PUBLIC_DATA(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
438 "root", xbt_log_priority_uninitialized, 0,
442 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
443 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
444 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
445 XBT_LOG_NEW_CATEGORY(simix,"All SIMIX categories");
446 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
448 /** @brief Get all logging settings from the command line
450 * xbt_log_control_set() is called on each string we got from cmd line
452 void xbt_log_init(int *argc,char **argv) {
456 /* create the default appender and install it in the root category,
457 which were already created (damnit. Too slow little beetle)*/
458 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
459 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
460 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
461 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
464 /* Set logs and init log submodule */
465 for (i=1; i<*argc; i++){
466 if (!strncmp(argv[i],"--log=",strlen("--log=")) ||
467 !strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
468 !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
469 !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
470 !strncmp(argv[i],"--simix-log=",strlen("--simix-log=")) ||
471 !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
473 if (strncmp(argv[i],"--log=",strlen("--log=")))
474 WARN2("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
475 (int)(strchr(argv[i],'=')-argv[i]),argv[i]);
477 opt=strchr(argv[i],'=');
479 xbt_log_control_set(opt);
480 DEBUG1("Did apply '%s' as log setting",opt);
481 /*remove this from argv*/
483 for (j=i+1; j<*argc; j++){
489 i--; /* compensate effect of next loop incrementation */
494 static void log_cat_exit(xbt_log_category_t cat) {
495 xbt_log_category_t child;
498 if (cat->appender->free_)
499 cat->appender->free_(cat->appender);
503 if (cat->layout->free_)
504 cat->layout->free_(cat->layout);
508 for(child=cat->firstChild ; child != NULL; child = child->nextSibling)
512 void xbt_log_exit(void) {
513 VERB0("Exiting log");
514 xbt_dynar_free(&xbt_log_settings);
515 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
519 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
521 xbt_log_category_t cat = ev->cat;
523 fprintf(stderr,"XXXXXXXXXXXXXXXXXXX\nXXX Warning, logs not usable here. Either before xbt_init() or after xbt_exit().\nXXXXXXXXXXXXXXXXXXX\n");
524 va_start(ev->ap, fmt);
525 vfprintf(stderr,fmt,ev->ap);
527 xbt_backtrace_display();
531 va_start(ev->ap, fmt);
533 xbt_log_appender_t appender = cat->appender;
534 if (appender != NULL) {
535 xbt_assert1(cat->layout,"No valid layout for the appender of category %s",cat->name);
536 char *str= cat->layout->do_layout(cat->layout, ev, fmt);
537 appender->do_append(appender, str);
539 if (!cat->additivity)
547 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
548 xbt_log_setting_t setting) {
550 s_xbt_log_event_t _log_ev;
552 if (setting->thresh != xbt_log_priority_uninitialized) {
553 xbt_log_threshold_set(category, setting->thresh);
555 if (category->threshold <= xbt_log_priority_debug) {
556 _log_ev.cat = category;
557 _log_ev.priority = xbt_log_priority_debug;
558 _log_ev.fileName = __FILE__ ;
559 _log_ev.functionName = _XBT_FUNCTION ;
560 _log_ev.lineNum = __LINE__ ;
562 _xbt_log_event_log(&_log_ev,
563 "Apply settings for category '%s': set threshold to %s (=%d)",
565 xbt_log_priority_names[category->threshold],
566 category->threshold);
571 xbt_log_layout_set(category,xbt_log_layout_format_new(setting->fmt));
573 if (category->threshold <= xbt_log_priority_debug) {
574 _log_ev.cat = category;
575 _log_ev.priority = xbt_log_priority_debug;
576 _log_ev.fileName = __FILE__ ;
577 _log_ev.functionName = _XBT_FUNCTION ;
578 _log_ev.lineNum = __LINE__ ;
580 _xbt_log_event_log(&_log_ev,
581 "Apply settings for category '%s': set format to %s",
587 if (setting->additivity != -1) {
588 xbt_log_additivity_set(category,setting->additivity);
590 if (category->threshold <= xbt_log_priority_debug) {
591 _log_ev.cat = category;
592 _log_ev.priority = xbt_log_priority_debug;
593 _log_ev.fileName = __FILE__ ;
594 _log_ev.functionName = _XBT_FUNCTION ;
595 _log_ev.lineNum = __LINE__ ;
597 _xbt_log_event_log(&_log_ev,
598 "Apply settings for category '%s': set additivity to %s",
600 (setting->additivity?"on":"off"));
605 * This gets called the first time a category is referenced and performs the
607 * Also resets threshold to inherited!
609 int _xbt_log_cat_init(xbt_log_category_t category,
610 e_xbt_log_priority_t priority) {
612 xbt_log_setting_t setting=NULL;
614 s_xbt_log_event_t _log_ev;
616 if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
617 category->threshold = xbt_log_priority_info;/* xbt_log_priority_debug*/;
618 category->appender = xbt_log_default_appender;
619 category->layout = xbt_log_default_layout;
622 if (!category->parent)
623 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
625 xbt_log_parent_set(category, category->parent);
628 /* Apply the control */
629 if (!xbt_log_settings)
630 return priority >= category->threshold;
632 xbt_assert0(category,"NULL category");
633 xbt_assert(category->name);
635 xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
636 xbt_assert0(setting,"Damnit, NULL cat in the list");
637 xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
639 if (!strcmp(setting->catname,category->name)) {
643 _xbt_log_cat_apply_set(category,setting);
645 xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
649 if (!found && category->threshold <= xbt_log_priority_verbose) {
651 _log_ev.cat = category;
652 _log_ev.priority = xbt_log_priority_verbose;
653 _log_ev.fileName = __FILE__ ;
654 _log_ev.functionName = _XBT_FUNCTION ;
655 _log_ev.lineNum = __LINE__ ;
657 _xbt_log_event_log(&_log_ev,
658 "Category '%s': inherited threshold = %s (=%d)",
660 xbt_log_priority_names[category->threshold], category->threshold);
663 return priority >= category->threshold;
666 void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent)
669 xbt_assert0(cat,"NULL category to be given a parent");
670 xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
673 * if the threshold is initialized
674 * unlink from current parent
676 if(cat->threshold != xbt_log_priority_uninitialized){
678 xbt_log_category_t* cpp = &parent->firstChild;
680 while(*cpp != cat && *cpp != NULL) {
681 cpp = &(*cpp)->nextSibling;
684 xbt_assert(*cpp == cat);
685 *cpp = cat->nextSibling;
688 cat->parent = parent;
689 cat->nextSibling = parent->firstChild;
691 parent->firstChild = cat;
693 if (parent->threshold == xbt_log_priority_uninitialized){
695 _xbt_log_cat_init(parent,
696 xbt_log_priority_uninitialized/* ignored*/);
699 cat->threshold = parent->threshold;
701 cat->isThreshInherited = 1;
705 static void _set_inherited_thresholds(xbt_log_category_t cat) {
707 xbt_log_category_t child = cat->firstChild;
709 for( ; child != NULL; child = child->nextSibling) {
710 if (child->isThreshInherited) {
711 if (cat != &_XBT_LOGV(log))
712 VERB3("Set category threshold of %s to %s (=%d)",
713 child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
714 child->threshold = cat->threshold;
715 _set_inherited_thresholds(child);
722 void xbt_log_threshold_set(xbt_log_category_t cat,
723 e_xbt_log_priority_t threshold) {
724 cat->threshold = threshold;
725 cat->isThreshInherited = 0;
727 _set_inherited_thresholds(cat);
731 static xbt_log_setting_t _xbt_log_parse_setting(const char* control_string) {
733 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t,1);
734 const char *name, *dot, *eq;
737 set->thresh = xbt_log_priority_uninitialized;
739 set->additivity = -1;
741 if (!*control_string)
743 DEBUG1("Parse log setting '%s'",control_string);
745 control_string += strspn(control_string, " ");
746 name = control_string;
747 control_string += strcspn(control_string, ".= ");
748 dot = control_string;
749 control_string += strcspn(control_string, ":= ");
751 control_string += strcspn(control_string, " ");
753 xbt_assert1(*dot == '.' && (*eq == '=' || *eq == ':'),
754 "Invalid control string '%s'",control_string);
756 if (!strncmp(dot + 1, "thresh", (size_t)(eq - dot - 1))) {
758 char *neweq=xbt_strdup(eq+1);
761 while (*(++p) != '\0') {
762 if (*p >= 'a' && *p <= 'z') {
767 DEBUG1("New priority name = %s",neweq);
768 for (i=0; i<xbt_log_priority_infinite; i++) {
769 if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
770 DEBUG1("This is priority %d",i);
774 if (i<xbt_log_priority_infinite) {
775 set->thresh= (e_xbt_log_priority_t) i;
778 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",eq+1);
781 } else if ( !strncmp(dot + 1, "add", (size_t)(eq - dot - 1)) ||
782 !strncmp(dot + 1, "additivity", (size_t)(eq - dot - 1)) ) {
784 char *neweq=xbt_strdup(eq+1);
787 while (*(++p) != '\0') {
788 if (*p >= 'a' && *p <= 'z') {
792 if ( !strcmp(neweq,"ON") ||
793 !strcmp(neweq,"YES") ||
794 !strcmp(neweq,"1") ) {
800 } else if (!strncmp(dot + 1, "fmt", (size_t)(eq - dot - 1))) {
801 set->fmt = xbt_strdup(eq+1);
804 snprintf(buff,min(512,eq - dot),"%s",dot+1);
805 THROW1(arg_error,0,"Unknown setting of the log category: '%s'",buff);
807 set->catname=(char*)xbt_malloc(dot - name+1);
809 memcpy(set->catname,name,dot-name);
810 set->catname[dot-name]='\0'; /* Just in case */
811 DEBUG1("This is for cat '%s'", set->catname);
816 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
817 xbt_log_category_t child;
819 if (!strcmp(cat->name,name))
822 for(child=cat->firstChild ; child != NULL; child = child->nextSibling)
823 return _xbt_log_cat_searchsub(child,name);
825 THROW1(not_found_error,0,"No such category: %s", name);
830 * \param control_string What to parse
832 * Typically passed a command-line argument. The string has the syntax:
834 * ( [category] "." [keyword] ":" value (" ")... )...
836 * where [category] is one the category names (see \ref XBT_log_cats for
837 * a complete list of the ones defined in the SimGrid library)
838 * and keyword is one of the following:
840 * - thres: category's threshold priority. Possible values:
841 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
842 * - add or additivity: whether the logging actions must be passed to
843 * the parent category.
844 * Possible values: 0, 1, no, yes, on, off.
845 * Default value: yes.
846 * - fmt: the format to use. See \ref log_lay for more information.
849 void xbt_log_control_set(const char* control_string) {
850 xbt_log_setting_t set;
852 /* To split the string in commands, and the cursors */
853 xbt_dynar_t set_strings;
859 DEBUG1("Parse log settings '%s'",control_string);
861 /* some initialization if this is the first time that this get called */
862 if (xbt_log_settings == NULL)
863 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
866 /* split the string, and remove empty entries */
867 set_strings=xbt_str_split_quoted(control_string);
869 if (xbt_dynar_length(set_strings) == 0) { /* vicious user! */
870 xbt_dynar_free(&set_strings);
874 /* Parse each entry and either use it right now (if the category was already
875 created), or store it for further use */
876 xbt_dynar_foreach(set_strings,cpt,str) {
877 xbt_log_category_t cat=NULL;
881 set = _xbt_log_parse_setting(str);
884 cat = _xbt_log_cat_searchsub(&_XBT_LOGV(root),set->catname);
887 if (e.category != not_found_error)
894 DEBUG0("Apply directly");
895 _xbt_log_cat_apply_set(cat,set);
896 _free_setting((void*)&set);
899 DEBUG0("Store for further application");
900 DEBUG1("push %p to the settings",(void*)set);
901 xbt_dynar_push(xbt_log_settings,&set);
904 xbt_dynar_free(&set_strings);
907 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
909 if (cat->appender->free_)
910 cat->appender->free_(cat->appender);
915 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) {
916 if (!cat->appender) {
917 VERB1("No appender to category %s. Setting the file appender as default",
919 xbt_log_appender_set(cat,xbt_log_appender_file_new(NULL));
921 if (cat->layout && cat != &_XBT_LOGV(root)) {
922 /* better leak the default layout than check every categories to
924 if (cat->layout->free_) {
925 cat->layout->free_(cat->layout);
930 xbt_log_additivity_set(cat,0);
933 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) {
934 cat->additivity = additivity;