1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2015. 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. */
11 #include <stdio.h> /* snprintf */
12 #include <stdlib.h> /* snprintf */
14 #include "portable.h" /* to get a working stdarg.h */
16 #include "xbt_modinter.h"
21 #include "xbt/sysdep.h"
22 #include "xbt/log_private.h"
23 #include "xbt/dynar.h"
24 #include "xbt/xbt_os_thread.h"
26 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
27 static xbt_os_rmutex_t log_cat_init_mutex = NULL;
29 /** \addtogroup XBT_log
31 * This section describes the API to the log functions used
32 * everywhere in this project.
34 \section XBT_log_toc Table of contents
44 - \ref log_API_isenabled
47 - \ref log_API_example
50 - \ref log_use_conf_thres
51 - \ref log_use_conf_multi
52 - \ref log_use_conf_fmt
53 - \ref log_use_conf_app
54 - \ref log_use_conf_add
61 \section log_overview 1. Introduction
63 This module is in charge of handling the log messages of every SimGrid
64 program. The main design goal are:
66 - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
67 what to hide, as well as how messages get displayed.
68 - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
69 and to the user (with command line options)
70 - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
71 - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
72 and the logging mechanism allows to syndicate each and every log source into the same place.
73 At least, its design would allow to, once we write the last missing pieces
75 There is three main concepts in SimGrid's logging mechanism: <i>category</i>,
76 <i>priority</i> and <i>appender</i>. These three concepts work together to
77 enable developers to log messages according to message type and priority, and
78 to control at runtime how these messages are formatted and where they are
81 \subsection log_cat 1.1 Category hierarchy
83 The first and foremost advantage of any logging API over plain printf()
84 resides in its ability to disable certain log statements while allowing
85 others to print unhindered. This capability assumes that the logging space,
86 that is, the space of all possible logging statements, is categorized
87 according to some developer-chosen criteria.
89 This observation led to choosing category as the central concept of the
90 system. In a certain sense, they can be considered as logging topics or
93 \subsection log_pri 1.2 Logging priorities
95 The user can naturally declare interest into this or that logging category, but
96 he also can specify the desired level of details for each of them. This is
97 controlled by the <i>priority</i> concept (which should maybe be renamed to
100 Empirically, the user can specify that he wants to see every debugging message
101 of MSG while only being interested into the messages at level "error" or
102 higher about the XBT internals.
104 \subsection log_app 1.3 Message appenders
106 The message appenders are the elements in charge of actually displaying the
107 message to the user. For now, four appenders exist:
108 - the default one prints stuff on stderr
109 - file sends the data to a single file
110 - rollfile overwrites the file when the file grows too large
111 - splitfile creates new files with a specific maximum size
113 Other are planed (such as the one sending everything to a remote server)
116 \subsection log_lay 1.4 Message layouts
118 The message layouts are the elements in charge of choosing how each message
119 will look like. Their result is a string which is then passed to the appender
120 attached to the category to be displayed.
122 For now, there is two layouts: The simple one, which is good for most cases,
123 and another one allowing users to specify the format they want.
124 \ref log_use_conf provides more info on this.
126 \subsection log_hist 1.5 History of this module
128 Historically, this module is an adaptation of the log4c project, which is dead
129 upstream, and which I was given the permission to fork under the LGPL licence
130 by the log4c's authors. The log4c project itself was loosely based on the
131 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
132 differs somehow from these projects anyway, because the C programming language
133 is not object oriented.
135 \section log_API 2. Programmer interface
137 \subsection log_API_cat 2.1 Constructing the category hierarchy
139 Every category is declared by providing a name and an optional
140 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
141 the category's parent.
143 A category is created by a macro call at the top level of a file. A
144 category can be created with any one of the following macros:
146 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
147 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
148 Create a new category being child of the category ParentCat
149 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
150 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
152 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
153 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
156 The parent cat can be defined in the same file or in another file (in
157 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
158 it visible in the current file), but each category may have only one
159 definition. Likewise, you can use a category defined in another file as
160 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
162 Typically, there will be a Category for each module and sub-module, so you
163 can independently control logging for each module.
165 For a list of all existing categories, please refer to the \ref XBT_log_cats
166 section. This file is generated automatically from the SimGrid source code, so
167 it should be complete and accurate.
169 \section log_API_pri 2.2 Declaring message priority
171 A category may be assigned a threshold priority. The set of priorities are
172 defined by the \ref e_xbt_log_priority_t enum. All logging request under
173 this priority will be discarded.
175 If a given category is not assigned a threshold priority, then it inherits
176 one from its closest ancestor with an assigned threshold. To ensure that all
177 categories can eventually inherit a threshold, the root category always has
178 an assigned threshold priority.
180 Logging requests are made by invoking a logging macro on a category. All of
181 the macros have a printf-style format string followed by arguments. If you
182 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
183 when you pass a pointer to a string where an integer was specified by the
184 format. This is usually a good idea.
186 Here is an example of the most basic type of macro. This is a logging
187 request with priority <i>warning</i>.
189 <code>XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5,
192 A logging request is said to be enabled if its priority is higher than or
193 equal to the threshold priority of its category. Otherwise, the request is
194 said to be disabled. A category without an assigned priority will inherit
195 one from the hierarchy.
197 It is possible to use any non-negative integer as a priority. If, as in the
198 example, one of the standard priorities is used, then there is a convenience
199 macro that is typically used instead. For example, the above example is
200 equivalent to the shorter:
202 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
204 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
206 It is sometimes useful to check whether a particular category is
207 enabled at a particular priority. One example is when you want to do
208 some extra computation to prepare a nice debugging message. There is
209 no use of doing so if the message won't be used afterward because
210 debugging is turned off.
212 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
214 \section log_API_subcat 2.4 Using a default category (the easy interface)
216 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
217 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
218 category, then the even shorter form can be used:
220 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
222 Only one default category can be created per file, though multiple
223 non-defaults can be created and used.
225 \section log_API_easy 2.5 Putting all together: the easy interface
227 First of all, each module should register its own category into the categories
228 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
230 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
231 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
233 Under GCC, these macro check there arguments the same way than printf does. So,
234 if you compile with -Wall, the following code will issue a warning:
235 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
237 If you want to specify the category to log onto (for example because you
238 have more than one category per file, add a C before the name of the log
239 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
240 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
243 The TRACE priority is not used the same way than the other. You should use
244 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
246 \section log_API_example 2.6 Example of use
248 Here is a more complete example:
253 / * create a category and a default subcategory * /
254 XBT_LOG_NEW_CATEGORY(VSS);
255 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
258 / * Now set the parent's priority. (the string would typically be a runtime option) * /
259 xbt_log_control_set("SA.thresh:3");
261 / * This request is enabled, because WARNING >= INFO. * /
262 XBT_CWARN(VSS, "Low fuel level.");
264 / * This request is disabled, because DEBUG < INFO. * /
265 XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
267 / * The default category SA inherits its priority from VSS. Thus,
268 the following request is enabled because INFO >= INFO. * /
269 XBT_INFO("Located nearest gas station.");
271 / * This request is disabled, because DEBUG < INFO. * /
272 XBT_DEBUG("Exiting gas station search");
276 \section log_user 3. User interface
278 \section log_use_conf 3.1 Configuration
280 Although rarely done, it is possible to configure the logs during
281 program initialization by invoking the xbt_log_control_set() method
282 manually. A more conventional way is to use the --log command line
283 argument. xbt_init() (called by MSG_init() and friends)
284 checks and deals properly with such arguments.
286 \subsection log_use_conf_thres 3.1.1 Threshold configuration
288 The most common setting is to control which logging event will get
289 displayed by setting a threshold to each category through the
290 <tt>threshold</tt> keyword.
292 For example, \verbatim --log=root.threshold:debug\endverbatim will make
293 SimGrid <b>extremely</b> verbose while \verbatim
294 --log=root.thres:critical\endverbatim should shut it almost
297 Note that the <tt>threshold</tt> keyword can be abbreviated here. For example,
298 all the following notations have the same result.
300 --log=root.threshold:debug
301 --log=root.threshol:debug
302 --log=root.thresho:debug
303 --log=root.thresh:debug
304 --log=root.thres:debug
305 --log=root.thre:debug
309 --log=root.:debug <--- That's obviously really ugly, but it actually works.
312 The full list of recognized thresholds is the following:
314 - trace: enter and return of some functions
315 - debug: crufty output
316 - verbose: verbose output for the user wanting more
317 - info: output about the regular functionning
318 - warning: minor issue encountered
319 - error: issue encountered
320 - critical: major issue encountered
322 \subsection log_use_conf_multi 3.1.2 Passing several settings
324 You can provide several of those arguments to change the setting of several
325 categories, they will be applied from left to right. So,
326 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
327 disable almost any logging.
329 Note that the quotes on above line are mandatory because there is a space in
330 the argument, so we are protecting ourselves from the shell, not from SimGrid.
331 We could also reach the same effect with this:
332 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
334 \subsection log_use_conf_fmt 3.1.3 Format configuration
336 As with SimGrid 3.3, it is possible to control the format of log
337 messages. This is done through the <tt>fmt</tt> keyword. For example,
338 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
339 user-message only, removing any decoration such as the date, or the
340 process ID, everything.
342 Here are the existing format directives:
345 - %%n: platform-dependent line separator (LOG4J compatible)
346 - %%e: plain old space (SimGrid extension)
348 - %%m: user-provided message
350 - %%c: Category name (LOG4J compatible)
351 - %%p: Priority name (LOG4J compatible)
353 - %%h: Hostname (SimGrid extension)
354 - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank)
355 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
356 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
358 - %%F: file name where the log event was raised (LOG4J compatible)
359 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
360 - %%L: line number where the log event was raised (LOG4J compatible)
361 - %%M: function name (LOG4J compatible -- called method name here of course).
362 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
364 - %%b: full backtrace (Called %%throwable in LOG4J).
365 Defined only under windows or when using the GNU libc because backtrace() is not defined
366 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
367 - %%B: short backtrace (only the first line of the %%b).
368 Called %%throwable{short} in LOG4J; defined where %%b is.
370 - %%d: date (UNIX-like epoch)
371 - %%r: application age (time elapsed since the beginning of the application)
374 If you want to mimic the simple layout with the format one, you would use this
375 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
376 because the simple layout do not display the message location for messages at
377 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
378 case). Moreover, if there is no process name (ie, messages coming from the
379 library itself, or test programs doing strange things) do not display the
380 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
381 [%%c/%%p] %%m%%n' if they are at priority INFO).
383 For now, there is only two format modifiers: the precision and the
384 width fields. You can for example specify %.4r to get the application
385 age with 4 numbers after the radix, or %15p to get the process name
386 on 15 columns. Finally, you can specify %10.6r to get the time on at
387 most 10 columns, with 6 numbers after the radix.
389 Note that when specifying the width, it is filled with spaces. That
390 is to say that for example %5r in your format is converted to "% 5f"
391 for printf (note the extra space); there is no way to fill the empty
392 columns with 0 (ie, pass "%05f" to printf). Another limitation is
393 that you cannot set specific layouts to the several priorities.
395 \subsection log_use_conf_app 3.1.4 Category appender
397 As with SimGrid 3.3, it is possible to control the appender of log
398 messages. This is done through the <tt>app</tt> keyword. For example,
399 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
400 to the file mylogfile.
402 For splitfile appender, the format is
403 \verbatim --log=root.app:splitfile:size:mylogfile_%.format\endverbatim
405 The size is in bytes, and the % wildcard will be replaced by the number of the
406 file. If no % is present, it will be appended at the end.
408 rollfile appender is also available, it can be used as
409 \verbatim --log=root.app:rollfile:size:mylogfile\endverbatim
410 When the file grows to be larger than the size, it will be emptied and new log
411 events will be sent at its beginning
413 Any appender setup this way have its own layout format (simple one by default),
414 so you may have to change it too afterward. Moreover, the additivity of the log category
415 is also set to false to prevent log event displayed by this appender to "leak" to any other
416 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
419 \subsection log_use_conf_add 3.1.5 Category additivity
421 The <tt>add</tt> keyword allows to specify the additivity of a
422 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
423 and 'off' are all valid values, with 'yes' as default.
425 The following example resets the additivity of the xbt category to true (which is its default value).
426 \verbatim --log=xbt.add:yes\endverbatim
428 \section log_use_misc 3.2 Misc and Caveats
430 - Do not use any of the macros that start with '_'.
431 - Log4J has a 'rolling file appender' which you can select with a run-time
432 option and specify the max file size. This would be a nice default for
433 non-kernel applications.
434 - Careful, category names are global variables.
435 - When writing a log format, you often want to use spaces. If you don't
436 protect these spaces, they are used as configuration elements separators.
437 For example, if you want to remove the date from the logs, you want to pass the following
438 argument on the command line. The outer quotes are here to protect the string from the shell
439 interpretation while the inner ones are there to prevent simgrid from splitting the string
440 in several log parameters (that would be invalid).
441 \verbatim --log="'root.fmt:%l: [%p/%c]: %m%n'"\endverbatim
442 Another option is to use the SimGrid-specific format directive \%e for
443 spaces, like in the following.
444 \verbatim --log="root.fmt:%l:%e[%p/%c]:%e%m%n"\endverbatim
446 \section log_internals 4. Internal considerations
448 This module is a mess of macro black magic, and when it goes wrong,
449 SimGrid studently loose its ability to explain its problems. When
450 messing around this module, I often find useful to define
451 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
452 of finding what's going wrong. But things are quite verbose when
453 everything is enabled...
455 \section log_in_perf 4.1 Performance
457 Except for the first invocation of a given category, a disabled logging request
458 requires an a single comparison of a static variable to a constant.
460 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
461 causes all logging requests with a lower priority to be optimized to 0 cost
462 by the compiler. By setting it to xbt_log_priority_infinite, all logging
463 requests are statically disabled at compile time and cost nothing. Released executables
464 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
465 \verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
467 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
468 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
469 the requests of priority below INFO.
471 \todo Logging performance *may* be improved further by improving the message
472 propagation from appender to appender in the category tree.
474 \section log_in_app 4.2 Appenders
476 Each category has an optional appender. An appender is a pointer to a
477 structure which starts with a pointer to a do_append() function. do_append()
478 prints a message to a log.
480 When a category is passed a message by one of the logging macros, the
481 category performs the following actions:
483 - if the category has an appender, the message is passed to the
484 appender's do_append() function,
485 - if additivity is true for the category, the message is passed to
486 the category's parent. Additivity is true by default, and can be
487 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
488 Also, when you add an appender to a category, its additivity is automatically turned to off.
489 Turn it back on afterward if it is not what you wanted.
491 By default, only the root category have an appender, and any other category has
492 its additivity set to true. This causes all messages to be logged by the root
495 The default appender function currently prints to stderr
498 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
499 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
504 e_xbt_log_priority_t thresh;
506 xbt_log_appender_t appender;
507 } s_xbt_log_setting_t, *xbt_log_setting_t;
509 static xbt_dynar_t xbt_log_settings = NULL;
511 static void _free_setting(void *s)
513 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
521 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
522 xbt_log_setting_t setting);
524 const char *xbt_log_priority_names[8] = {
535 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
536 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
537 "root", "The common ancestor for all categories",
538 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
539 0 /* isThreshInherited */ ,
540 NULL /* appender */ , NULL /* layout */ ,
544 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
545 "Loggings from the logging mechanism itself");
547 /* create the default appender and install it in the root category,
548 which were already created (damnit. Too slow little beetle) */
549 void xbt_log_preinit(void)
551 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
552 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
553 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
554 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
555 log_cat_init_mutex = xbt_os_rmutex_init();
558 static void xbt_log_connect_categories(void)
560 /* Connect our log channels: that must be done manually under windows */
561 /* Also permit that they are correctly listed by xbt_log_help_categories() */
564 XBT_LOG_CONNECT(xbt);
565 XBT_LOG_CONNECT(graphxml_parse);
566 XBT_LOG_CONNECT(log);
567 XBT_LOG_CONNECT(module);
568 XBT_LOG_CONNECT(peer);
569 XBT_LOG_CONNECT(replay);
570 XBT_LOG_CONNECT(strbuff);
571 XBT_LOG_CONNECT(xbt_cfg);
572 XBT_LOG_CONNECT(xbt_dict);
573 XBT_LOG_CONNECT(xbt_dict_cursor);
574 XBT_LOG_CONNECT(xbt_dict_elm);
575 #ifdef XBT_USE_DEPRECATED
576 XBT_LOG_CONNECT(xbt_dict_multi);
578 XBT_LOG_CONNECT(xbt_dyn);
579 XBT_LOG_CONNECT(xbt_ex);
580 XBT_LOG_CONNECT(xbt_fifo);
581 XBT_LOG_CONNECT(xbt_graph);
582 XBT_LOG_CONNECT(xbt_heap);
583 XBT_LOG_CONNECT(xbt_lib);
584 XBT_LOG_CONNECT(xbt_mallocator);
585 XBT_LOG_CONNECT(xbt_matrix);
586 XBT_LOG_CONNECT(xbt_parmap);
587 XBT_LOG_CONNECT(xbt_queue);
588 XBT_LOG_CONNECT(xbt_set);
589 XBT_LOG_CONNECT(xbt_sync);
590 XBT_LOG_CONNECT(xbt_sync_os);
592 #ifdef simgrid_EXPORTS
593 /* The following categories are only defined in libsimgrid */
597 XBT_LOG_CONNECT(bindings);
598 XBT_LOG_CONNECT(lua);
599 XBT_LOG_CONNECT(lua_comm);
600 XBT_LOG_CONNECT(lua_host);
601 XBT_LOG_CONNECT(lua_platf);
602 XBT_LOG_CONNECT(lua_process);
603 XBT_LOG_CONNECT(lua_state_cloner);
604 XBT_LOG_CONNECT(lua_task);
605 XBT_LOG_CONNECT(lua_utils);
609 XBT_LOG_CONNECT(instr);
610 XBT_LOG_CONNECT(instr_api);
611 XBT_LOG_CONNECT(instr_config);
612 XBT_LOG_CONNECT(instr_msg);
613 XBT_LOG_CONNECT(instr_msg_process);
614 XBT_LOG_CONNECT(instr_msg_vm);
615 XBT_LOG_CONNECT(instr_paje_containers);
616 XBT_LOG_CONNECT(instr_paje_header);
617 XBT_LOG_CONNECT(instr_paje_trace);
618 XBT_LOG_CONNECT(instr_paje_types);
619 XBT_LOG_CONNECT(instr_paje_values);
620 XBT_LOG_CONNECT(instr_resource);
621 XBT_LOG_CONNECT(instr_routing);
622 XBT_LOG_CONNECT(instr_sd);
623 XBT_LOG_CONNECT(instr_surf);
624 XBT_LOG_CONNECT(instr_trace);
625 XBT_LOG_CONNECT(instr_TI_trace);
629 XBT_LOG_CONNECT(jedule);
630 XBT_LOG_CONNECT(jed_out);
631 XBT_LOG_CONNECT(jed_sd);
637 XBT_LOG_CONNECT(mc_checkpoint);
638 XBT_LOG_CONNECT(mc_comm_determinism);
639 XBT_LOG_CONNECT(mc_compare);
640 XBT_LOG_CONNECT(mc_diff);
641 XBT_LOG_CONNECT(mc_dwarf);
642 XBT_LOG_CONNECT(mc_hash);
643 XBT_LOG_CONNECT(mc_ignore);
644 XBT_LOG_CONNECT(mcer_ignore);
645 XBT_LOG_CONNECT(mc_liveness);
646 XBT_LOG_CONNECT(mc_memory);
647 XBT_LOG_CONNECT(mc_memory_map);
648 XBT_LOG_CONNECT(mc_page_snapshot);
649 XBT_LOG_CONNECT(mc_request);
650 XBT_LOG_CONNECT(mc_safety);
651 XBT_LOG_CONNECT(mc_visited);
652 XBT_LOG_CONNECT(mc_client);
653 XBT_LOG_CONNECT(mc_client_api);
654 XBT_LOG_CONNECT(mc_comm_pattern);
655 XBT_LOG_CONNECT(mc_process);
656 XBT_LOG_CONNECT(mc_protocol);
657 XBT_LOG_CONNECT(mc_RegionSnaphot);
658 XBT_LOG_CONNECT(mc_server);
659 XBT_LOG_CONNECT(mc_state);
661 XBT_LOG_CONNECT(mc_global);
662 XBT_LOG_CONNECT(mc_config);
663 XBT_LOG_CONNECT(mc_record);
666 XBT_LOG_CONNECT(msg);
667 XBT_LOG_CONNECT(msg_action);
668 XBT_LOG_CONNECT(msg_gos);
669 XBT_LOG_CONNECT(msg_io);
670 XBT_LOG_CONNECT(msg_kernel);
671 XBT_LOG_CONNECT(msg_mailbox);
672 XBT_LOG_CONNECT(msg_process);
673 XBT_LOG_CONNECT(msg_synchro);
674 XBT_LOG_CONNECT(msg_task);
675 XBT_LOG_CONNECT(msg_vm);
679 XBT_LOG_CONNECT(sd_daxparse);
681 XBT_LOG_CONNECT(sd_dotparse);
683 XBT_LOG_CONNECT(sd_kernel);
684 XBT_LOG_CONNECT(sd_task);
685 XBT_LOG_CONNECT(sd_workstation);
688 XBT_LOG_CONNECT(simix);
689 XBT_LOG_CONNECT(simix_context);
690 XBT_LOG_CONNECT(simix_deployment);
691 XBT_LOG_CONNECT(simix_environment);
692 XBT_LOG_CONNECT(simix_host);
693 XBT_LOG_CONNECT(simix_io);
694 XBT_LOG_CONNECT(simix_kernel);
695 XBT_LOG_CONNECT(simix_network);
696 XBT_LOG_CONNECT(simix_process);
697 XBT_LOG_CONNECT(simix_popping);
698 XBT_LOG_CONNECT(simix_synchro);
699 XBT_LOG_CONNECT(simix_vm);
702 /* SMPI categories are connected in smpi_global.c */
705 XBT_LOG_CONNECT(surf);
706 XBT_LOG_CONNECT(platf_generator);
707 XBT_LOG_CONNECT(random);
708 XBT_LOG_CONNECT(surf_config);
709 XBT_LOG_CONNECT(surf_cpu);
710 XBT_LOG_CONNECT(surf_cpu_cas);
711 XBT_LOG_CONNECT(surf_cpu_ti);
712 XBT_LOG_CONNECT(surf_energy);
713 XBT_LOG_CONNECT(surf_kernel);
714 XBT_LOG_CONNECT(surf_lagrange);
715 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
716 XBT_LOG_CONNECT(surf_maxmin);
717 XBT_LOG_CONNECT(surf_network);
719 XBT_LOG_CONNECT(ns3);
721 XBT_LOG_CONNECT(surf_parse);
722 XBT_LOG_CONNECT(surf_route);
723 XBT_LOG_CONNECT(surf_routing_generic);
724 XBT_LOG_CONNECT(surf_route_cluster);
725 XBT_LOG_CONNECT(surf_route_cluster_torus);
726 XBT_LOG_CONNECT(surf_route_dijkstra);
727 XBT_LOG_CONNECT(surf_route_fat_tree);
728 XBT_LOG_CONNECT(surf_route_floyd);
729 XBT_LOG_CONNECT(surf_route_full);
730 XBT_LOG_CONNECT(surf_route_none);
731 XBT_LOG_CONNECT(surf_route_vivaldi);
732 XBT_LOG_CONNECT(surf_storage);
733 XBT_LOG_CONNECT(surf_trace);
734 XBT_LOG_CONNECT(surf_vm);
735 XBT_LOG_CONNECT(surf_host);
737 #endif /* simgrid_EXPORTS */
740 static void xbt_log_help(void);
741 static void xbt_log_help_categories(void);
743 /** @brief Get all logging settings from the command line
745 * xbt_log_control_set() is called on each string we got from cmd line
747 void xbt_log_init(int *argc, char **argv)
749 unsigned help_requested = 0; /* 1: logs; 2: categories */
753 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
755 xbt_log_connect_categories();
757 /* Set logs and init log submodule */
758 for (j = i = 1; i < *argc; i++) {
759 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
760 opt = strchr(argv[i], '=');
762 xbt_log_control_set(opt);
763 XBT_DEBUG("Did apply '%s' as log setting", opt);
764 } else if (!strcmp(argv[i], "--help-logs")) {
766 } else if (!strcmp(argv[i], "--help-log-categories")) {
777 if (help_requested) {
778 if (help_requested & 1)
780 if (help_requested & 2)
781 xbt_log_help_categories();
786 static void log_cat_exit(xbt_log_category_t cat)
788 xbt_log_category_t child;
791 if (cat->appender->free_)
792 cat->appender->free_(cat->appender);
796 if (cat->layout->free_)
797 cat->layout->free_(cat->layout);
801 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
805 void xbt_log_postexit(void)
807 XBT_VERB("Exiting log");
808 xbt_os_rmutex_destroy(log_cat_init_mutex);
809 xbt_dynar_free(&xbt_log_settings);
810 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
813 /* Size of the static string in which we build the log string */
814 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
815 /* Minimum size of the dynamic string in which we build the log string
816 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
817 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
819 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
821 xbt_log_category_t cat = ev->cat;
823 xbt_assert(ev->priority >= 0,
824 "Negative logging priority naturally forbidden");
825 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
826 "Priority %d is greater than the biggest allowed value",
830 xbt_log_appender_t appender = cat->appender;
833 continue; /* No appender, try next */
835 xbt_assert(cat->layout,
836 "No valid layout for the appender of category %s", cat->name);
838 /* First, try with a static buffer */
839 if (XBT_LOG_STATIC_BUFFER_SIZE) {
840 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
843 ev->buffer_size = sizeof buff;
844 va_start(ev->ap, fmt);
845 done = cat->layout->do_layout(cat->layout, ev, fmt);
848 appender->do_append(appender, buff);
849 continue; /* Ok, that worked: go next */
853 /* The static buffer was too small, use a dynamically expanded one */
854 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
855 ev->buffer = xbt_malloc(ev->buffer_size);
858 va_start(ev->ap, fmt);
859 done = cat->layout->do_layout(cat->layout, ev, fmt);
863 ev->buffer_size *= 2;
864 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
866 appender->do_append(appender, ev->buffer);
867 xbt_free(ev->buffer);
869 } while (cat->additivity && (cat = cat->parent, 1));
872 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
873 #undef XBT_LOG_STATIC_BUFFER_SIZE
877 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
878 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
879 * recursion, we can not use the standard logging macros in
880 * _xbt_log_cat_init(), and in all functions called from it.
882 * To circumvent the problem, we define the macro_xbt_log_init() as
883 * (0) for the length of the affected functions, and we do not forget
884 * to undefine it at the end!
887 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
888 xbt_log_setting_t setting)
890 #define _xbt_log_cat_init(a, b) (0)
892 if (setting->thresh != xbt_log_priority_uninitialized) {
893 xbt_log_threshold_set(category, setting->thresh);
895 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
896 category->name, xbt_log_priority_names[category->threshold],
897 category->threshold);
901 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
903 XBT_DEBUG("Apply settings for category '%s': set format to %s",
904 category->name, setting->fmt);
907 if (setting->additivity != -1) {
908 xbt_log_additivity_set(category, setting->additivity);
910 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
911 category->name, (setting->additivity ? "on" : "off"));
913 if (setting->appender) {
914 xbt_log_appender_set(category, setting->appender);
915 if (!category->layout)
916 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
917 category->additivity = 0;
918 XBT_DEBUG("Set %p as appender of category '%s'",
919 setting->appender, category->name);
921 #undef _xbt_log_cat_init
925 * This gets called the first time a category is referenced and performs the
927 * Also resets threshold to inherited!
929 int _xbt_log_cat_init(xbt_log_category_t category,
930 e_xbt_log_priority_t priority)
932 #define _xbt_log_cat_init(a, b) (0)
934 if (log_cat_init_mutex != NULL) {
935 xbt_os_rmutex_acquire(log_cat_init_mutex);
938 if (category->initialized) {
939 if (log_cat_init_mutex != NULL) {
940 xbt_os_rmutex_release(log_cat_init_mutex);
942 return priority >= category->threshold;
946 xbt_log_setting_t setting = NULL;
949 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
951 (category->firstChild ? category->firstChild->name : "none"),
952 (category->nextSibling ? category->nextSibling->name : "none"));
954 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
955 category->threshold = xbt_log_priority_info;
956 category->appender = xbt_log_default_appender;
957 category->layout = xbt_log_default_layout;
960 if (!category->parent)
961 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
963 XBT_DEBUG("Set %s (%s) as father of %s ",
964 category->parent->name,
965 (category->parent->initialized ?
966 xbt_log_priority_names[category->parent->threshold] : "uninited"),
968 xbt_log_parent_set(category, category->parent);
970 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
971 char *buf, *res = NULL;
972 xbt_log_category_t cpp = category->parent->firstChild;
975 buf = bprintf("%s %s", res, cpp->name);
979 res = xbt_strdup(cpp->name);
981 cpp = cpp->nextSibling;
984 XBT_DEBUG("Children of %s: %s; nextSibling: %s",
985 category->parent->name, res,
986 (category->parent->nextSibling ?
987 category->parent->nextSibling->name : "none"));
994 /* Apply the control */
995 if (xbt_log_settings) {
996 xbt_assert(category, "NULL category");
997 xbt_assert(category->name);
999 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
1000 xbt_assert(setting, "Damnit, NULL cat in the list");
1001 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
1004 if (!strcmp(setting->catname, category->name)) {
1006 _xbt_log_cat_apply_set(category, setting);
1007 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
1012 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
1013 category->name, xbt_log_priority_names[category->threshold],
1014 category->threshold);
1017 category->initialized = 1;
1018 if (log_cat_init_mutex != NULL) {
1019 xbt_os_rmutex_release(log_cat_init_mutex);
1021 return priority >= category->threshold;
1023 #undef _xbt_log_cat_init
1026 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
1028 xbt_assert(cat, "NULL category to be given a parent");
1029 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1031 /* if the category is initialized, unlink from current parent */
1032 if (cat->initialized) {
1034 xbt_log_category_t *cpp = &cat->parent->firstChild;
1036 while (*cpp != cat && *cpp != NULL) {
1037 cpp = &(*cpp)->nextSibling;
1040 xbt_assert(*cpp == cat);
1041 *cpp = cat->nextSibling;
1044 cat->parent = parent;
1045 cat->nextSibling = parent->firstChild;
1047 parent->firstChild = cat;
1049 if (!parent->initialized)
1050 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1052 cat->threshold = parent->threshold;
1054 cat->isThreshInherited = 1;
1057 static void _set_inherited_thresholds(xbt_log_category_t cat)
1060 xbt_log_category_t child = cat->firstChild;
1062 for (; child != NULL; child = child->nextSibling) {
1063 if (child->isThreshInherited) {
1064 if (cat != &_XBT_LOGV(log))
1065 XBT_VERB("Set category threshold of %s to %s (=%d)",
1066 child->name, xbt_log_priority_names[cat->threshold],
1068 child->threshold = cat->threshold;
1069 _set_inherited_thresholds(child);
1076 void xbt_log_threshold_set(xbt_log_category_t cat,
1077 e_xbt_log_priority_t threshold)
1079 cat->threshold = threshold;
1080 cat->isThreshInherited = 0;
1082 _set_inherited_thresholds(cat);
1086 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1088 const char *orig_control_string = control_string;
1089 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1090 const char *name, *dot, *eq;
1092 set->catname = NULL;
1093 set->thresh = xbt_log_priority_uninitialized;
1095 set->additivity = -1;
1096 set->appender = NULL;
1098 if (!*control_string)
1100 XBT_DEBUG("Parse log setting '%s'", control_string);
1102 control_string += strspn(control_string, " ");
1103 name = control_string;
1104 control_string += strcspn(control_string, ".= ");
1105 dot = control_string;
1106 control_string += strcspn(control_string, ":= ");
1107 eq = control_string;
1108 control_string += strcspn(control_string, " ");
1110 if(*dot != '.' && (*eq == '=' || *eq == ':'))
1111 xbt_die ("Invalid control string '%s'", orig_control_string);
1113 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
1115 char *neweq = xbt_strdup(eq + 1);
1116 char *p = neweq - 1;
1118 while (*(++p) != '\0') {
1119 if (*p >= 'a' && *p <= 'z') {
1124 XBT_DEBUG("New priority name = %s", neweq);
1125 for (i = 0; i < xbt_log_priority_infinite; i++) {
1126 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1127 XBT_DEBUG("This is priority %d", i);
1132 if(i<XBT_LOG_STATIC_THRESHOLD){
1134 "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
1135 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
1136 "while -DNLOG forbids any logging, at any level.",
1137 eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
1139 }else if (i < xbt_log_priority_infinite) {
1140 set->thresh = (e_xbt_log_priority_t) i;
1142 THROWF(arg_error, 0,
1143 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1147 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1148 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1150 char *neweq = xbt_strdup(eq + 1);
1151 char *p = neweq - 1;
1153 while (*(++p) != '\0') {
1154 if (*p >= 'a' && *p <= 'z') {
1158 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1159 || !strcmp(neweq, "1")) {
1160 set->additivity = 1;
1162 set->additivity = 0;
1165 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1166 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1168 char *neweq = xbt_strdup(eq + 1);
1170 if (!strncmp(neweq, "file:", 5)) {
1171 set->appender = xbt_log_appender_file_new(neweq + 5);
1172 }else if (!strncmp(neweq, "rollfile:", 9)) {
1173 set->appender = xbt_log_appender2_file_new(neweq + 9,1);
1174 }else if (!strncmp(neweq, "splitfile:", 10)) {
1175 set->appender = xbt_log_appender2_file_new(neweq + 10,0);
1177 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1180 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1181 set->fmt = xbt_strdup(eq + 1);
1184 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1185 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1188 set->catname = (char *) xbt_malloc(dot - name + 1);
1190 memcpy(set->catname, name, dot - name);
1191 set->catname[dot - name] = '\0'; /* Just in case */
1192 XBT_DEBUG("This is for cat '%s'", set->catname);
1197 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1200 xbt_log_category_t child, res;
1202 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1203 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1204 (cat->nextSibling ? cat->nextSibling->name : "none"));
1205 if (!strcmp(cat->name, name))
1208 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1209 XBT_DEBUG("Dig into %s", child->name);
1210 res = _xbt_log_cat_searchsub(child, name);
1220 * \param control_string What to parse
1222 * Typically passed a command-line argument. The string has the syntax:
1224 * ( [category] "." [keyword] ":" value (" ")... )...
1226 * where [category] is one the category names (see \ref XBT_log_cats for
1227 * a complete list of the ones defined in the SimGrid library)
1228 * and keyword is one of the following:
1230 * - thres: category's threshold priority. Possible values:
1231 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1232 * - add or additivity: whether the logging actions must be passed to
1233 * the parent category.
1234 * Possible values: 0, 1, no, yes, on, off.
1235 * Default value: yes.
1236 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1237 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1241 void xbt_log_control_set(const char *control_string)
1243 xbt_log_setting_t set;
1245 /* To split the string in commands, and the cursors */
1246 xbt_dynar_t set_strings;
1250 if (!control_string)
1252 XBT_DEBUG("Parse log settings '%s'", control_string);
1254 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1255 if (!strcmp(control_string, "no_loc")) {
1259 /* some initialization if this is the first time that this get called */
1260 if (xbt_log_settings == NULL)
1261 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1264 /* split the string, and remove empty entries */
1265 set_strings = xbt_str_split_quoted(control_string);
1267 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1268 xbt_dynar_free(&set_strings);
1272 /* Parse each entry and either use it right now (if the category was already
1273 created), or store it for further use */
1274 xbt_dynar_foreach(set_strings, cpt, str) {
1275 xbt_log_category_t cat = NULL;
1277 set = _xbt_log_parse_setting(str);
1279 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1282 XBT_DEBUG("Apply directly");
1283 _xbt_log_cat_apply_set(cat, set);
1284 _free_setting((void *) &set);
1287 XBT_DEBUG("Store for further application");
1288 XBT_DEBUG("push %p to the settings", (void *) set);
1289 xbt_dynar_push(xbt_log_settings, &set);
1292 xbt_dynar_free(&set_strings);
1295 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1297 if (cat->appender) {
1298 if (cat->appender->free_)
1299 cat->appender->free_(cat->appender);
1300 free(cat->appender);
1302 cat->appender = app;
1305 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1307 #define _xbt_log_cat_init(a, b) (0)
1308 if (!cat->appender) {
1310 ("No appender to category %s. Setting the file appender as default",
1312 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1315 if (cat->layout->free_) {
1316 cat->layout->free_(cat->layout);
1321 xbt_log_additivity_set(cat, 0);
1322 #undef _xbt_log_cat_init
1325 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1327 cat->additivity = additivity;
1330 static void xbt_log_help(void)
1333 "Description of the logging output:\n"
1335 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1336 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1337 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1338 " -> trace: enter and return of some functions\n"
1339 " -> debug: crufty output\n"
1340 " -> verbose: verbose output for the user wanting more\n"
1341 " -> info: output about the regular functionning\n"
1342 " -> warning: minor issue encountered\n"
1343 " -> error: issue encountered\n"
1344 " -> critical: major issue encountered\n"
1346 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1347 " OPTIONS may be:\n"
1348 " -> %%%%: the %% char\n"
1349 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1350 " -> %%e: plain old space (SimGrid extension)\n"
1352 " -> %%m: user-provided message\n"
1354 " -> %%c: Category name (LOG4J compatible)\n"
1355 " -> %%p: Priority name (LOG4J compatible)\n"
1357 " -> %%h: Hostname (SimGrid extension)\n"
1358 " -> %%P: Process name (SimGrid extension)\n"
1359 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1360 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1362 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1363 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1364 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1365 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1366 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1368 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1369 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1370 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1372 " -> %%d: date (UNIX-like epoch)\n"
1373 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1376 " --help-log-categories Display the current hierarchy of log categories.\n"
1377 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
1382 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1384 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1385 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1386 return strcmp(a->name, b->name);
1389 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1396 xbt_log_category_t cat;
1401 if (category->parent) {
1402 this_prefix = bprintf("%s \\_ ", prefix);
1403 child_prefix = bprintf("%s | ", prefix);
1405 this_prefix = xbt_strdup(prefix);
1406 child_prefix = xbt_strdup(prefix);
1409 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1410 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1411 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1413 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1415 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1416 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1417 *strrchr(child_prefix, '|') = ' ';
1418 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1419 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1420 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1423 xbt_dynar_free(&dynar);
1424 xbt_free(this_prefix);
1425 xbt_free(child_prefix);
1428 static void xbt_log_help_categories(void)
1430 printf("Current log category hierarchy:\n");
1431 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");