1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2011. 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"
25 #include "xbt/xbt_os_thread.h"
27 XBT_PUBLIC_DATA(int) (*xbt_pid) ();
28 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
29 static xbt_os_rmutex_t log_cat_init_mutex = NULL;
31 /** \addtogroup XBT_log
33 * This section describes the API to the log functions used
34 * everywhere in this project.
36 \section XBT_log_toc Table of contents
46 - \ref log_API_isenabled
49 - \ref log_API_example
52 - \ref log_use_conf_thres
53 - \ref log_use_conf_multi
54 - \ref log_use_conf_fmt
55 - \ref log_use_conf_app
56 - \ref log_use_conf_add
63 \section log_overview 1. Introduction
65 This module is in charge of handling the log messages of every SimGrid
66 program. The main design goal are:
68 - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
69 what to hide, as well as how messages get displayed.
70 - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
71 and to the user (with command line options)
72 - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
73 - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
74 and the logging mechanism allows to syndicate each and every log source into the same place.
75 At least, its design would allow to, once we write the last missing pieces
77 There is three main concepts in SimGrid's logging mechanism: <i>category</i>,
78 <i>priority</i> and <i>appender</i>. These three concepts work together to
79 enable developers to log messages according to message type and priority, and
80 to control at runtime how these messages are formatted and where they are
83 \subsection log_cat 1.1 Category hierarchy
85 The first and foremost advantage of any logging API over plain printf()
86 resides in its ability to disable certain log statements while allowing
87 others to print unhindered. This capability assumes that the logging space,
88 that is, the space of all possible logging statements, is categorized
89 according to some developer-chosen criteria.
91 This observation led to choosing category as the central concept of the
92 system. In a certain sense, they can be considered as logging topics or
95 \subsection log_pri 1.2 Logging priorities
97 The user can naturally declare interest into this or that logging category, but
98 he also can specify the desired level of details for each of them. This is
99 controlled by the <i>priority</i> concept (which should maybe be renamed to
102 Empirically, the user can specify that he wants to see every debugging message
103 of GRAS while only being interested into the messages at level "error" or
104 higher about the XBT internals.
106 \subsection log_app 1.3 Message appenders
108 The message appenders are the elements in charge of actually displaying the
109 message to the user. For now, only two appenders exist: the default one prints
110 stuff on stderr while it is possible to create appenders printing to a specific
113 Other are planed (such as the one sending everything to a remote server,
114 or the one using only a fixed amount of lines in a file, and rotating content on
115 need). One day, for sure ;)
117 \subsection log_lay 1.4 Message layouts
119 The message layouts are the elements in charge of choosing how each message
120 will look like. Their result is a string which is then passed to the appender
121 attached to the category to be displayed.
123 For now, there is two layouts: The simple one, which is good for most cases,
124 and another one allowing users to specify the format they want.
125 \ref log_use_conf provides more info on this.
127 \subsection log_hist 1.5 History of this module
129 Historically, this module is an adaptation of the log4c project, which is dead
130 upstream, and which I was given the permission to fork under the LGPL licence
131 by the log4c's authors. The log4c project itself was loosely based on the
132 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
133 differs somehow from these projects anyway, because the C programming language
134 is not object oriented.
136 \section log_API 2. Programmer interface
138 \subsection log_API_cat 2.1 Constructing the category hierarchy
140 Every category is declared by providing a name and an optional
141 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
142 the category's parent.
144 A category is created by a macro call at the top level of a file. A
145 category can be created with any one of the following macros:
147 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
148 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
149 Create a new category being child of the category ParentCat
150 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
151 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
153 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
154 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
157 The parent cat can be defined in the same file or in another file (in
158 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
159 it visible in the current file), but each category may have only one
160 definition. Likewise, you can use a category defined in another file as
161 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
163 Typically, there will be a Category for each module and sub-module, so you
164 can independently control logging for each module.
166 For a list of all existing categories, please refer to the \ref XBT_log_cats
167 section. This file is generated automatically from the SimGrid source code, so
168 it should be complete and accurate.
170 \section log_API_pri 2.2 Declaring message priority
172 A category may be assigned a threshold priority. The set of priorities are
173 defined by the \ref e_xbt_log_priority_t enum. All logging request under
174 this priority will be discarded.
176 If a given category is not assigned a threshold priority, then it inherits
177 one from its closest ancestor with an assigned threshold. To ensure that all
178 categories can eventually inherit a threshold, the root category always has
179 an assigned threshold priority.
181 Logging requests are made by invoking a logging macro on a category. All of
182 the macros have a printf-style format string followed by arguments. If you
183 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
184 when you pass a pointer to a string where an integer was specified by the
185 format. This is usually a good idea.
187 Here is an example of the most basic type of macro. This is a logging
188 request with priority <i>warning</i>.
190 <code>XBT_CLOG(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
193 A logging request is said to be enabled if its priority is higher than or
194 equal to the threshold priority of its category. Otherwise, the request is
195 said to be disabled. A category without an assigned priority will inherit
196 one from the hierarchy.
198 It is possible to use any non-negative integer as a priority. If, as in the
199 example, one of the standard priorities is used, then there is a convenience
200 macro that is typically used instead. For example, the above example is
201 equivalent to the shorter:
203 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
205 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
207 It is sometimes useful to check whether a particular category is
208 enabled at a particular priority. One example is when you want to do
209 some extra computation to prepare a nice debugging message. There is
210 no use of doing so if the message won't be used afterward because
211 debugging is turned off.
213 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
215 \section log_API_subcat 2.4 Using a default category (the easy interface)
217 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
218 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
219 category, then the even shorter form can be used:
221 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
223 Only one default category can be created per file, though multiple
224 non-defaults can be created and used.
226 \section log_API_easy 2.5 Putting all together: the easy interface
228 First of all, each module should register its own category into the categories
229 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
231 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
232 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
234 Under GCC, these macro check there arguments the same way than printf does. So,
235 if you compile with -Wall, the following code will issue a warning:
236 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
238 If you want to specify the category to log onto (for example because you
239 have more than one category per file, add a C before the name of the log
240 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
241 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
244 The TRACE priority is not used the same way than the other. You should use
245 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
247 \section log_API_example 2.6 Example of use
249 Here is a more complete example:
254 / * create a category and a default subcategory * /
255 XBT_LOG_NEW_CATEGORY(VSS);
256 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
259 / * Now set the parent's priority. (the string would typcially be a runtime option) * /
260 xbt_log_control_set("SA.thresh:3");
262 / * This request is enabled, because WARNING >= INFO. * /
263 XBT_CWARN(VSS, "Low fuel level.");
265 / * This request is disabled, because DEBUG < INFO. * /
266 XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
268 / * The default category SA inherits its priority from VSS. Thus,
269 the following request is enabled because INFO >= INFO. * /
270 XBT_INFO("Located nearest gas station.");
272 / * This request is disabled, because DEBUG < INFO. * /
273 XBT_DEBUG("Exiting gas station search");
277 Another example can be found in the relevant part of the GRAS tutorial:
278 \ref GRAS_tut_tour_logs.
280 \section log_user 3. User interface
282 \section log_use_conf 3.1 Configuration
284 Although rarely done, it is possible to configure the logs during
285 program initialization by invoking the xbt_log_control_set() method
286 manually. A more conventional way is to use the --log command line
287 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
288 checks and deals properly with such arguments.
290 The following command line arguments exist, but are deprecated and
291 may disappear in the future: --xbt-log, --gras-log, --msg-log and
294 \subsection log_use_conf_thres 3.1.1 Threshold configuration
296 The most common setting is to control which logging event will get
297 displayed by setting a threshold to each category through the
298 <tt>thres</tt> keyword.
300 For example, \verbatim --log=root.thres:debug\endverbatim will make
301 SimGrid <b>extremely</b> verbose while \verbatim
302 --log=root.thres:critical\endverbatim should shut it almost
303 completely off. The full list of recognized thresholds is the following:
305 - trace: enter and return of some functions
306 - debug: crufty output
307 - verbose: verbose output for the user wanting more
308 - info: output about the regular functionning
309 - warning: minor issue encountered
310 - error: issue encountered
311 - critical: major issue encountered
313 \subsection log_use_conf_multi 3.1.2 Passing several settings
315 You can provide several of those arguments to change the setting of several
316 categories, they will be applied from left to right. So,
317 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
318 disable almost any logging.
320 Note that the quotes on above line are mandatory because there is a space in
321 the argument, so we are protecting ourselves from the shell, not from SimGrid.
322 We could also reach the same effect with this:
323 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
325 \subsection log_use_conf_fmt 3.1.3 Format configuration
327 As with SimGrid 3.3, it is possible to control the format of log
328 messages. This is done through the <tt>fmt</tt> keyword. For example,
329 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
330 user-message only, removing any decoration such as the date, or the
331 process ID, everything.
333 Here are the existing format directives:
336 - %%n: platform-dependent line separator (LOG4J compatible)
337 - %%e: plain old space (SimGrid extension)
339 - %%m: user-provided message
341 - %%c: Category name (LOG4J compatible)
342 - %%p: Priority name (LOG4J compatible)
344 - %%h: Hostname (SimGrid extension)
345 - %%P: Process name (SimGrid extension)
346 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
347 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
349 - %%F: file name where the log event was raised (LOG4J compatible)
350 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
351 - %%L: line number where the log event was raised (LOG4J compatible)
352 - %%M: function name (LOG4J compatible -- called method name here of course).
353 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
355 - %%b: full backtrace (Called %%throwable in LOG4J).
356 Defined only under windows or when using the GNU libc because backtrace() is not defined
357 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
358 - %%B: short backtrace (only the first line of the %%b).
359 Called %%throwable{short} in LOG4J; defined where %%b is.
361 - %%d: date (UNIX-like epoch)
362 - %%r: application age (time elapsed since the beginning of the application)
365 If you want to mimic the simple layout with the format one, you would use this
366 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
367 because the simple layout do not display the message location for messages at
368 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
369 case). Moreover, if there is no process name (ie, messages coming from the
370 library itself, or test programs doing strange things) do not display the
371 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
372 [%%c/%%p] %%m%%n' if they are at priority INFO).
374 For now, there is only two format modifiers: the precision and the
375 width fields. You can for example specify %.4r to get the application
376 age with 4 numbers after the radix, or %15p to get the process name
377 on 15 columns. Finally, you can specify %10.6r to get the time on at
378 most 10 columns, with 6 numbers after the radix.
380 Note that when specifying the width, it is filled with spaces. That
381 is to say that for example %5r in your format is converted to "% 5f"
382 for printf (note the extra space); there is no way to fill the empty
383 columns with 0 (ie, pass "%05f" to printf). Another limitation is
384 that you cannot set specific layouts to the several priorities.
386 \subsection log_use_conf_app 3.1.4 Category appender
388 As with SimGrid 3.3, it is possible to control the appender of log
389 messages. This is done through the <tt>app</tt> keyword. For example,
390 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
391 to the file mylogfile.
393 Any appender setup this way have its own layout format (simple one by default),
394 so you may have to change it too afterward. Moreover, the additivity of the log category
395 is also set to false to prevent log event displayed by this appender to "leak" to any other
396 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
399 \subsection log_use_conf_add 3.1.5 Category additivity
401 The <tt>add</tt> keyword allows to specify the additivity of a
402 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
403 and 'off' are all valid values, with 'yes' as default.
405 The following example resets the additivity of the xbt category to true (which is its default value).
406 \verbatim --log=xbt.add:yes\endverbatim
408 \section log_use_misc 3.2 Misc and Caveats
410 - Do not use any of the macros that start with '_'.
411 - Log4J has a 'rolling file appender' which you can select with a run-time
412 option and specify the max file size. This would be a nice default for
413 non-kernel applications.
414 - Careful, category names are global variables.
416 \section log_internals 4. Internal considerations
418 This module is a mess of macro black magic, and when it goes wrong,
419 SimGrid studently loose its ability to explain its problems. When
420 messing around this module, I often find useful to define
421 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
422 of finding what's going wrong. But things are quite verbose when
423 everything is enabled...
425 \section log_in_perf 4.1 Performance
427 Except for the first invocation of a given category, a disabled logging request
428 requires an a single comparison of a static variable to a constant.
430 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
431 causes all logging requests with a lower priority to be optimized to 0 cost
432 by the compiler. By setting it to gras_log_priority_infinite, all logging
433 requests are statically disabled at compile time and cost nothing. Released executables
434 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
435 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
437 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
438 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
439 the requests of priority below INFO.
441 \todo Logging performance *may* be improved further by improving the message
442 propagation from appender to appender in the category tree.
444 \section log_in_app 4.2 Appenders
446 Each category has an optional appender. An appender is a pointer to a
447 structure which starts with a pointer to a do_append() function. do_append()
448 prints a message to a log.
450 When a category is passed a message by one of the logging macros, the
451 category performs the following actions:
453 - if the category has an appender, the message is passed to the
454 appender's do_append() function,
455 - if additivity is true for the category, the message is passed to
456 the category's parent. Additivity is true by default, and can be
457 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
458 Also, when you add an appender to a category, its additivity is automatically turned to off.
459 Turn it back on afterward if it is not what you wanted.
461 By default, only the root category have an appender, and any other category has
462 its additivity set to true. This causes all messages to be logged by the root
465 The default appender function currently prints to stderr, and the only other
466 existing one writes to the specified file. More would be needed, like the one
467 able to send the logs to a remote dedicated server.
468 This is on our TODO list for quite a while now, but your help would be
469 welcome here, too. */
471 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
472 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
477 e_xbt_log_priority_t thresh;
479 xbt_log_appender_t appender;
480 } s_xbt_log_setting_t, *xbt_log_setting_t;
482 static xbt_dynar_t xbt_log_settings = NULL;
484 static void _free_setting(void *s)
486 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
494 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
495 xbt_log_setting_t setting);
497 const char *xbt_log_priority_names[8] = {
508 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
509 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
510 "root", "The common ancestor for all categories",
511 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
512 0 /* isThreshInherited */ ,
513 NULL /* appender */ , NULL /* layout */ ,
517 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
518 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
519 XBT_LOG_NEW_CATEGORY(msg, "All MSG categories");
520 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
521 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
522 XBT_LOG_NEW_CATEGORY(bindings, "All bindings categories");
524 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
525 "Loggings from the logging mechanism itself");
527 /* create the default appender and install it in the root category,
528 which were already created (damnit. Too slow little beetle) */
529 void xbt_log_preinit(void)
531 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
532 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
533 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
534 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
535 log_cat_init_mutex = xbt_os_rmutex_init();
538 /** @brief Get all logging settings from the command line
540 * xbt_log_control_set() is called on each string we got from cmd line
542 void xbt_log_init(int *argc, char **argv)
547 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
549 /* Set logs and init log submodule */
550 for (j = i = 1; i < *argc; i++) {
551 if (!strncmp(argv[i], "--log=", strlen("--log=")) ||
552 !strncmp(argv[i], "--gras-log=", strlen("--gras-log=")) ||
553 !strncmp(argv[i], "--surf-log=", strlen("--surf-log=")) ||
554 !strncmp(argv[i], "--msg-log=", strlen("--msg-log=")) ||
555 !strncmp(argv[i], "--simix-log=", strlen("--simix-log=")) ||
556 !strncmp(argv[i], "--xbt-log=", strlen("--xbt-log="))) {
558 if (strncmp(argv[i], "--log=", strlen("--log=")))
560 ("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
561 (int) (strchr(argv[i], '=') - argv[i]), argv[i]);
563 opt = strchr(argv[i], '=');
565 xbt_log_control_set(opt);
566 XBT_DEBUG("Did apply '%s' as log setting", opt);
577 static void log_cat_exit(xbt_log_category_t cat)
579 xbt_log_category_t child;
582 if (cat->appender->free_)
583 cat->appender->free_(cat->appender);
587 if (cat->layout->free_)
588 cat->layout->free_(cat->layout);
592 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
596 void xbt_log_postexit(void)
598 XBT_VERB("Exiting log");
599 xbt_os_rmutex_destroy(log_cat_init_mutex);
600 xbt_dynar_free(&xbt_log_settings);
601 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
604 /* Size of the static string in which we build the log string */
605 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
606 /* Minimum size of the dynamic string in which we build the log string
607 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
608 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
610 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
612 xbt_log_category_t cat = ev->cat;
614 xbt_assert(ev->priority >= 0,
615 "Negative logging priority naturally forbidden");
616 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
617 "Priority %d is greater than the biggest allowed value",
621 xbt_log_appender_t appender = cat->appender;
624 continue; /* No appender, try next */
626 xbt_assert(cat->layout,
627 "No valid layout for the appender of category %s", cat->name);
629 /* First, try with a static buffer */
630 if (XBT_LOG_STATIC_BUFFER_SIZE) {
631 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
634 ev->buffer_size = sizeof buff;
635 va_start(ev->ap, fmt);
636 done = cat->layout->do_layout(cat->layout, ev, fmt);
639 appender->do_append(appender, buff);
640 continue; /* Ok, that worked: go next */
644 /* The static buffer was too small, use a dynamically expanded one */
645 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
646 ev->buffer = xbt_malloc(ev->buffer_size);
649 va_start(ev->ap, fmt);
650 done = cat->layout->do_layout(cat->layout, ev, fmt);
654 ev->buffer_size *= 2;
655 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
657 appender->do_append(appender, ev->buffer);
658 xbt_free(ev->buffer);
660 } while (cat->additivity && (cat = cat->parent, 1));
663 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
664 #undef XBT_LOG_STATIC_BUFFER_SIZE
668 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
669 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
670 * recursion, we can not use the standard logging macros in
671 * _xbt_log_cat_init(), and in all functions called from it.
673 * To circumvent the problem, we define the macro_xbt_log_init() as
674 * (0) for the length of the affected functions, and we do not forget
675 * to undefine it at the end!
678 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
679 xbt_log_setting_t setting)
681 #define _xbt_log_cat_init(a, b) (0)
683 if (setting->thresh != xbt_log_priority_uninitialized) {
684 xbt_log_threshold_set(category, setting->thresh);
686 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
687 category->name, xbt_log_priority_names[category->threshold],
688 category->threshold);
692 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
694 XBT_DEBUG("Apply settings for category '%s': set format to %s",
695 category->name, setting->fmt);
698 if (setting->additivity != -1) {
699 xbt_log_additivity_set(category, setting->additivity);
701 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
702 category->name, (setting->additivity ? "on" : "off"));
704 if (setting->appender) {
705 xbt_log_appender_set(category, setting->appender);
706 if (!category->layout)
707 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
708 category->additivity = 0;
709 XBT_DEBUG("Set %p as appender of category '%s'",
710 setting->appender, category->name);
712 #undef _xbt_log_cat_init
716 * This gets called the first time a category is referenced and performs the
718 * Also resets threshold to inherited!
720 int _xbt_log_cat_init(xbt_log_category_t category,
721 e_xbt_log_priority_t priority)
723 #define _xbt_log_cat_init(a, b) (0)
725 if (log_cat_init_mutex != NULL) {
726 xbt_os_rmutex_acquire(log_cat_init_mutex);
729 if (category->initialized) {
730 if (log_cat_init_mutex != NULL) {
731 xbt_os_rmutex_release(log_cat_init_mutex);
733 return priority >= category->threshold;
737 xbt_log_setting_t setting = NULL;
740 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
742 (category->firstChild ? category->firstChild->name : "none"),
743 (category->nextSibling ? category->nextSibling->name : "none"));
745 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
746 category->threshold = xbt_log_priority_info;
747 category->appender = xbt_log_default_appender;
748 category->layout = xbt_log_default_layout;
751 if (!category->parent)
752 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
754 XBT_DEBUG("Set %s (%s) as father of %s ",
755 category->parent->name,
756 (category->parent->initialized ?
757 xbt_log_priority_names[category->parent->threshold] : "uninited"),
759 xbt_log_parent_set(category, category->parent);
761 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
762 char *buf, *res = NULL;
763 xbt_log_category_t cpp = category->parent->firstChild;
766 buf = bprintf("%s %s", res, cpp->name);
770 res = xbt_strdup(cpp->name);
772 cpp = cpp->nextSibling;
775 XBT_DEBUG("Childs of %s: %s; nextSibling: %s",
776 category->parent->name, res,
777 (category->parent->nextSibling ?
778 category->parent->nextSibling->name : "none"));
785 /* Apply the control */
786 if (xbt_log_settings) {
787 xbt_assert(category, "NULL category");
788 xbt_assert(category->name);
790 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
791 xbt_assert(setting, "Damnit, NULL cat in the list");
792 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
795 if (!strcmp(setting->catname, category->name)) {
797 _xbt_log_cat_apply_set(category, setting);
798 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
803 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
804 category->name, xbt_log_priority_names[category->threshold],
805 category->threshold);
808 category->initialized = 1;
809 if (log_cat_init_mutex != NULL) {
810 xbt_os_rmutex_release(log_cat_init_mutex);
812 return priority >= category->threshold;
814 #undef _xbt_log_cat_init
817 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
819 xbt_assert(cat, "NULL category to be given a parent");
820 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
822 /* if the category is initialized, unlink from current parent */
823 if (cat->initialized) {
825 xbt_log_category_t *cpp = &cat->parent->firstChild;
827 while (*cpp != cat && *cpp != NULL) {
828 cpp = &(*cpp)->nextSibling;
831 xbt_assert(*cpp == cat);
832 *cpp = cat->nextSibling;
835 cat->parent = parent;
836 cat->nextSibling = parent->firstChild;
838 parent->firstChild = cat;
840 if (!parent->initialized)
841 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
843 cat->threshold = parent->threshold;
845 cat->isThreshInherited = 1;
848 static void _set_inherited_thresholds(xbt_log_category_t cat)
851 xbt_log_category_t child = cat->firstChild;
853 for (; child != NULL; child = child->nextSibling) {
854 if (child->isThreshInherited) {
855 if (cat != &_XBT_LOGV(log))
856 XBT_VERB("Set category threshold of %s to %s (=%d)",
857 child->name, xbt_log_priority_names[cat->threshold],
859 child->threshold = cat->threshold;
860 _set_inherited_thresholds(child);
867 void xbt_log_threshold_set(xbt_log_category_t cat,
868 e_xbt_log_priority_t threshold)
870 cat->threshold = threshold;
871 cat->isThreshInherited = 0;
873 _set_inherited_thresholds(cat);
877 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
880 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
881 const char *name, *dot, *eq;
884 set->thresh = xbt_log_priority_uninitialized;
886 set->additivity = -1;
887 set->appender = NULL;
889 if (!*control_string)
891 XBT_DEBUG("Parse log setting '%s'", control_string);
893 control_string += strspn(control_string, " ");
894 name = control_string;
895 control_string += strcspn(control_string, ".= ");
896 dot = control_string;
897 control_string += strcspn(control_string, ":= ");
899 control_string += strcspn(control_string, " ");
901 xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
902 "Invalid control string '%s'", control_string);
904 if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
906 char *neweq = xbt_strdup(eq + 1);
909 while (*(++p) != '\0') {
910 if (*p >= 'a' && *p <= 'z') {
915 XBT_DEBUG("New priority name = %s", neweq);
916 for (i = 0; i < xbt_log_priority_infinite; i++) {
917 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
918 XBT_DEBUG("This is priority %d", i);
922 if (i < xbt_log_priority_infinite) {
923 set->thresh = (e_xbt_log_priority_t) i;
926 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
930 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
931 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
933 char *neweq = xbt_strdup(eq + 1);
936 while (*(++p) != '\0') {
937 if (*p >= 'a' && *p <= 'z') {
941 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
942 || !strcmp(neweq, "1")) {
948 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
949 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
951 char *neweq = xbt_strdup(eq + 1);
953 if (!strncmp(neweq, "file:", 5)) {
954 set->appender = xbt_log_appender_file_new(neweq + 5);
956 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
959 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
960 set->fmt = xbt_strdup(eq + 1);
963 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
964 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
967 set->catname = (char *) xbt_malloc(dot - name + 1);
969 memcpy(set->catname, name, dot - name);
970 set->catname[dot - name] = '\0'; /* Just in case */
971 XBT_DEBUG("This is for cat '%s'", set->catname);
976 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
979 xbt_log_category_t child, res;
981 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
982 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
983 (cat->nextSibling ? cat->nextSibling->name : "none"));
984 if (!strcmp(cat->name, name))
987 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
988 XBT_DEBUG("Dig into %s", child->name);
989 res = _xbt_log_cat_searchsub(child, name);
999 * \param control_string What to parse
1001 * Typically passed a command-line argument. The string has the syntax:
1003 * ( [category] "." [keyword] ":" value (" ")... )...
1005 * where [category] is one the category names (see \ref XBT_log_cats for
1006 * a complete list of the ones defined in the SimGrid library)
1007 * and keyword is one of the following:
1009 * - thres: category's threshold priority. Possible values:
1010 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1011 * - add or additivity: whether the logging actions must be passed to
1012 * the parent category.
1013 * Possible values: 0, 1, no, yes, on, off.
1014 * Default value: yes.
1015 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1016 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1020 void xbt_log_control_set(const char *control_string)
1022 xbt_log_setting_t set;
1024 /* To split the string in commands, and the cursors */
1025 xbt_dynar_t set_strings;
1029 if (!control_string)
1031 XBT_DEBUG("Parse log settings '%s'", control_string);
1033 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1034 if (!strcmp(control_string, "no_loc")) {
1038 /* some initialization if this is the first time that this get called */
1039 if (xbt_log_settings == NULL)
1040 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1043 /* split the string, and remove empty entries */
1044 set_strings = xbt_str_split_quoted(control_string);
1046 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1047 xbt_dynar_free(&set_strings);
1051 /* Parse each entry and either use it right now (if the category was already
1052 created), or store it for further use */
1053 xbt_dynar_foreach(set_strings, cpt, str) {
1054 xbt_log_category_t cat = NULL;
1056 set = _xbt_log_parse_setting(str);
1058 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1061 XBT_DEBUG("Apply directly");
1062 _xbt_log_cat_apply_set(cat, set);
1063 _free_setting((void *) &set);
1066 XBT_DEBUG("Store for further application");
1067 XBT_DEBUG("push %p to the settings", (void *) set);
1068 xbt_dynar_push(xbt_log_settings, &set);
1071 xbt_dynar_free(&set_strings);
1074 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1076 if (cat->appender) {
1077 if (cat->appender->free_)
1078 cat->appender->free_(cat->appender);
1079 free(cat->appender);
1081 cat->appender = app;
1084 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1086 #define _xbt_log_cat_init(a, b) (0)
1087 if (!cat->appender) {
1089 ("No appender to category %s. Setting the file appender as default",
1091 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1094 if (cat->layout->free_) {
1095 cat->layout->free_(cat->layout);
1100 xbt_log_additivity_set(cat, 0);
1101 #undef _xbt_log_cat_init
1104 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1106 cat->additivity = additivity;
1109 void xbt_log_help(void)
1112 "Description of the logging output:\n"
1114 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1115 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1116 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1117 " -> trace: enter and return of some functions\n"
1118 " -> debug: crufty output\n"
1119 " -> verbose: verbose output for the user wanting more\n"
1120 " -> info: output about the regular functionning\n"
1121 " -> warning: minor issue encountered\n"
1122 " -> error: issue encountered\n"
1123 " -> critical: major issue encountered\n"
1125 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1126 " OPTIONS may be:\n"
1127 " -> %%%%: the %% char\n"
1128 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1129 " -> %%e: plain old space (SimGrid extension)\n"
1131 " -> %%m: user-provided message\n"
1133 " -> %%c: Category name (LOG4J compatible)\n"
1134 " -> %%p: Priority name (LOG4J compatible)\n"
1136 " -> %%h: Hostname (SimGrid extension)\n"
1137 " -> %%P: Process name (SimGrid extension)\n"
1138 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1139 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1141 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1142 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1143 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1144 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1145 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1147 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1148 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1149 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1151 " -> %%d: date (UNIX-like epoch)\n"
1152 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1157 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1159 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1160 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1161 return strcmp(a->name, b->name);
1164 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1171 xbt_log_category_t cat;
1176 if (category->parent) {
1177 this_prefix = bprintf("%s \\_ ", prefix);
1178 child_prefix = bprintf("%s | ", prefix);
1180 this_prefix = bprintf("%s", prefix);
1181 child_prefix = bprintf("%s", prefix);
1184 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1185 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1186 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1188 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1190 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1191 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1192 *strrchr(child_prefix, '|') = ' ';
1193 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1194 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1195 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1198 xbt_dynar_free(&dynar);
1199 xbt_free(this_prefix);
1200 xbt_free(child_prefix);
1203 void xbt_log_help_categories(void)
1205 printf("Current log category hierarchy:\n");
1206 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");