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 "src/portable.h" /* to get a working stdarg.h */
16 #include "src/xbt_modinter.h"
21 #include "xbt/sysdep.h"
22 #include "src/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(replay);
569 XBT_LOG_CONNECT(strbuff);
570 XBT_LOG_CONNECT(xbt_cfg);
571 XBT_LOG_CONNECT(xbt_dict);
572 XBT_LOG_CONNECT(xbt_dict_cursor);
573 XBT_LOG_CONNECT(xbt_dict_elm);
574 #ifdef XBT_USE_DEPRECATED
575 XBT_LOG_CONNECT(xbt_dict_multi);
577 XBT_LOG_CONNECT(xbt_dyn);
578 XBT_LOG_CONNECT(xbt_ex);
579 XBT_LOG_CONNECT(xbt_fifo);
580 XBT_LOG_CONNECT(xbt_graph);
581 XBT_LOG_CONNECT(xbt_heap);
582 XBT_LOG_CONNECT(xbt_lib);
583 XBT_LOG_CONNECT(xbt_mallocator);
584 XBT_LOG_CONNECT(xbt_matrix);
585 XBT_LOG_CONNECT(xbt_parmap);
586 XBT_LOG_CONNECT(xbt_set);
587 XBT_LOG_CONNECT(xbt_sync);
588 XBT_LOG_CONNECT(xbt_sync_os);
590 #ifdef simgrid_EXPORTS
591 /* The following categories are only defined in libsimgrid */
595 XBT_LOG_CONNECT(bindings);
596 XBT_LOG_CONNECT(lua);
597 XBT_LOG_CONNECT(lua_host);
598 XBT_LOG_CONNECT(lua_platf);
599 XBT_LOG_CONNECT(lua_debug);
603 XBT_LOG_CONNECT(instr);
604 XBT_LOG_CONNECT(instr_api);
605 XBT_LOG_CONNECT(instr_config);
606 XBT_LOG_CONNECT(instr_msg);
607 XBT_LOG_CONNECT(instr_msg_process);
608 XBT_LOG_CONNECT(instr_msg_vm);
609 XBT_LOG_CONNECT(instr_paje_containers);
610 XBT_LOG_CONNECT(instr_paje_header);
611 XBT_LOG_CONNECT(instr_paje_trace);
612 XBT_LOG_CONNECT(instr_paje_types);
613 XBT_LOG_CONNECT(instr_paje_values);
614 XBT_LOG_CONNECT(instr_resource);
615 XBT_LOG_CONNECT(instr_routing);
616 XBT_LOG_CONNECT(instr_sd);
617 XBT_LOG_CONNECT(instr_surf);
618 XBT_LOG_CONNECT(instr_trace);
619 XBT_LOG_CONNECT(instr_TI_trace);
623 XBT_LOG_CONNECT(jedule);
624 XBT_LOG_CONNECT(jed_out);
625 XBT_LOG_CONNECT(jed_sd);
631 XBT_LOG_CONNECT(mc_checkpoint);
632 XBT_LOG_CONNECT(mc_comm_determinism);
633 XBT_LOG_CONNECT(mc_compare);
634 XBT_LOG_CONNECT(mc_diff);
635 XBT_LOG_CONNECT(mc_dwarf);
636 XBT_LOG_CONNECT(mc_hash);
637 XBT_LOG_CONNECT(mc_ignore);
638 XBT_LOG_CONNECT(mc_liveness);
639 XBT_LOG_CONNECT(mc_memory);
640 XBT_LOG_CONNECT(mc_page_snapshot);
641 XBT_LOG_CONNECT(mc_request);
642 XBT_LOG_CONNECT(mc_safety);
643 XBT_LOG_CONNECT(mc_visited);
644 XBT_LOG_CONNECT(mc_client);
645 XBT_LOG_CONNECT(mc_client_api);
646 XBT_LOG_CONNECT(mc_comm_pattern);
647 XBT_LOG_CONNECT(mc_process);
648 XBT_LOG_CONNECT(mc_protocol);
649 XBT_LOG_CONNECT(mc_RegionSnaphot);
650 XBT_LOG_CONNECT(mc_ModelChecker);
651 XBT_LOG_CONNECT(mc_state);
653 XBT_LOG_CONNECT(mc_global);
654 XBT_LOG_CONNECT(mc_config);
655 XBT_LOG_CONNECT(mc_record);
658 XBT_LOG_CONNECT(msg);
659 XBT_LOG_CONNECT(msg_action);
660 XBT_LOG_CONNECT(msg_gos);
661 XBT_LOG_CONNECT(msg_io);
662 XBT_LOG_CONNECT(msg_kernel);
663 XBT_LOG_CONNECT(msg_mailbox);
664 XBT_LOG_CONNECT(msg_process);
665 XBT_LOG_CONNECT(msg_synchro);
666 XBT_LOG_CONNECT(msg_task);
667 XBT_LOG_CONNECT(msg_vm);
671 XBT_LOG_CONNECT(sd_daxparse);
673 XBT_LOG_CONNECT(sd_dotparse);
675 XBT_LOG_CONNECT(sd_kernel);
676 XBT_LOG_CONNECT(sd_task);
677 XBT_LOG_CONNECT(sd_workstation);
680 XBT_LOG_CONNECT(simix);
681 XBT_LOG_CONNECT(simix_context);
682 XBT_LOG_CONNECT(simix_deployment);
683 XBT_LOG_CONNECT(simix_environment);
684 XBT_LOG_CONNECT(simix_host);
685 XBT_LOG_CONNECT(simix_io);
686 XBT_LOG_CONNECT(simix_kernel);
687 XBT_LOG_CONNECT(simix_network);
688 XBT_LOG_CONNECT(simix_process);
689 XBT_LOG_CONNECT(simix_popping);
690 XBT_LOG_CONNECT(simix_synchro);
691 XBT_LOG_CONNECT(simix_vm);
694 /* SMPI categories are connected in smpi_global.c */
697 XBT_LOG_CONNECT(surf);
698 XBT_LOG_CONNECT(platf_generator);
699 XBT_LOG_CONNECT(random);
700 XBT_LOG_CONNECT(surf_config);
701 XBT_LOG_CONNECT(surf_cpu);
702 XBT_LOG_CONNECT(surf_cpu_cas);
703 XBT_LOG_CONNECT(surf_cpu_ti);
704 XBT_LOG_CONNECT(surf_energy);
705 XBT_LOG_CONNECT(surf_kernel);
706 XBT_LOG_CONNECT(surf_lagrange);
707 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
708 XBT_LOG_CONNECT(surf_maxmin);
709 XBT_LOG_CONNECT(surf_network);
711 XBT_LOG_CONNECT(ns3);
713 XBT_LOG_CONNECT(surf_parse);
714 XBT_LOG_CONNECT(surf_route);
715 XBT_LOG_CONNECT(surf_routing_generic);
716 XBT_LOG_CONNECT(surf_route_cluster);
717 XBT_LOG_CONNECT(surf_route_cluster_torus);
718 XBT_LOG_CONNECT(surf_route_dijkstra);
719 XBT_LOG_CONNECT(surf_route_fat_tree);
720 XBT_LOG_CONNECT(surf_route_floyd);
721 XBT_LOG_CONNECT(surf_route_full);
722 XBT_LOG_CONNECT(surf_route_none);
723 XBT_LOG_CONNECT(surf_route_vivaldi);
724 XBT_LOG_CONNECT(surf_storage);
725 XBT_LOG_CONNECT(surf_trace);
726 XBT_LOG_CONNECT(surf_vm);
727 XBT_LOG_CONNECT(surf_host);
729 #endif /* simgrid_EXPORTS */
732 static void xbt_log_help(void);
733 static void xbt_log_help_categories(void);
735 /** @brief Get all logging settings from the command line
737 * xbt_log_control_set() is called on each string we got from cmd line
739 void xbt_log_init(int *argc, char **argv)
741 unsigned help_requested = 0; /* 1: logs; 2: categories */
745 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
747 xbt_log_connect_categories();
749 /* Set logs and init log submodule */
750 for (j = i = 1; i < *argc; i++) {
751 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
752 opt = strchr(argv[i], '=');
754 xbt_log_control_set(opt);
755 XBT_DEBUG("Did apply '%s' as log setting", opt);
756 } else if (!strcmp(argv[i], "--help-logs")) {
758 } else if (!strcmp(argv[i], "--help-log-categories")) {
769 if (help_requested) {
770 if (help_requested & 1)
772 if (help_requested & 2)
773 xbt_log_help_categories();
778 static void log_cat_exit(xbt_log_category_t cat)
780 xbt_log_category_t child;
783 if (cat->appender->free_)
784 cat->appender->free_(cat->appender);
788 if (cat->layout->free_)
789 cat->layout->free_(cat->layout);
793 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
797 void xbt_log_postexit(void)
799 XBT_VERB("Exiting log");
800 xbt_os_rmutex_destroy(log_cat_init_mutex);
801 xbt_dynar_free(&xbt_log_settings);
802 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
805 /* Size of the static string in which we build the log string */
806 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
807 /* Minimum size of the dynamic string in which we build the log string
808 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
809 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
811 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
813 xbt_log_category_t cat = ev->cat;
815 xbt_assert(ev->priority >= 0,
816 "Negative logging priority naturally forbidden");
817 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
818 "Priority %d is greater than the biggest allowed value",
822 xbt_log_appender_t appender = cat->appender;
825 continue; /* No appender, try next */
827 xbt_assert(cat->layout,
828 "No valid layout for the appender of category %s", cat->name);
830 /* First, try with a static buffer */
831 if (XBT_LOG_STATIC_BUFFER_SIZE) {
832 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
835 ev->buffer_size = sizeof buff;
836 va_start(ev->ap, fmt);
837 done = cat->layout->do_layout(cat->layout, ev, fmt);
840 appender->do_append(appender, buff);
841 continue; /* Ok, that worked: go next */
845 /* The static buffer was too small, use a dynamically expanded one */
846 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
847 ev->buffer = xbt_malloc(ev->buffer_size);
850 va_start(ev->ap, fmt);
851 done = cat->layout->do_layout(cat->layout, ev, fmt);
855 ev->buffer_size *= 2;
856 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
858 appender->do_append(appender, ev->buffer);
859 xbt_free(ev->buffer);
861 } while (cat->additivity && (cat = cat->parent, 1));
864 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
865 #undef XBT_LOG_STATIC_BUFFER_SIZE
869 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
870 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
871 * recursion, we can not use the standard logging macros in
872 * _xbt_log_cat_init(), and in all functions called from it.
874 * To circumvent the problem, we define the macro_xbt_log_init() as
875 * (0) for the length of the affected functions, and we do not forget
876 * to undefine it at the end!
879 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
880 xbt_log_setting_t setting)
882 #define _xbt_log_cat_init(a, b) (0)
884 if (setting->thresh != xbt_log_priority_uninitialized) {
885 xbt_log_threshold_set(category, setting->thresh);
887 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
888 category->name, xbt_log_priority_names[category->threshold],
889 category->threshold);
893 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
895 XBT_DEBUG("Apply settings for category '%s': set format to %s",
896 category->name, setting->fmt);
899 if (setting->additivity != -1) {
900 xbt_log_additivity_set(category, setting->additivity);
902 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
903 category->name, (setting->additivity ? "on" : "off"));
905 if (setting->appender) {
906 xbt_log_appender_set(category, setting->appender);
907 if (!category->layout)
908 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
909 category->additivity = 0;
910 XBT_DEBUG("Set %p as appender of category '%s'",
911 setting->appender, category->name);
913 #undef _xbt_log_cat_init
917 * This gets called the first time a category is referenced and performs the
919 * Also resets threshold to inherited!
921 int _xbt_log_cat_init(xbt_log_category_t category,
922 e_xbt_log_priority_t priority)
924 #define _xbt_log_cat_init(a, b) (0)
926 if (log_cat_init_mutex != NULL) {
927 xbt_os_rmutex_acquire(log_cat_init_mutex);
930 if (category->initialized) {
931 if (log_cat_init_mutex != NULL) {
932 xbt_os_rmutex_release(log_cat_init_mutex);
934 return priority >= category->threshold;
938 xbt_log_setting_t setting = NULL;
941 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
943 (category->firstChild ? category->firstChild->name : "none"),
944 (category->nextSibling ? category->nextSibling->name : "none"));
946 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
947 category->threshold = xbt_log_priority_info;
948 category->appender = xbt_log_default_appender;
949 category->layout = xbt_log_default_layout;
952 if (!category->parent)
953 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
955 XBT_DEBUG("Set %s (%s) as father of %s ",
956 category->parent->name,
957 (category->parent->initialized ?
958 xbt_log_priority_names[category->parent->threshold] : "uninited"),
960 xbt_log_parent_set(category, category->parent);
962 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
963 char *buf, *res = NULL;
964 xbt_log_category_t cpp = category->parent->firstChild;
967 buf = bprintf("%s %s", res, cpp->name);
971 res = xbt_strdup(cpp->name);
973 cpp = cpp->nextSibling;
976 XBT_DEBUG("Children of %s: %s; nextSibling: %s",
977 category->parent->name, res,
978 (category->parent->nextSibling ?
979 category->parent->nextSibling->name : "none"));
986 /* Apply the control */
987 if (xbt_log_settings) {
988 xbt_assert(category, "NULL category");
989 xbt_assert(category->name);
991 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
992 xbt_assert(setting, "Damnit, NULL cat in the list");
993 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
996 if (!strcmp(setting->catname, category->name)) {
998 _xbt_log_cat_apply_set(category, setting);
999 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
1004 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
1005 category->name, xbt_log_priority_names[category->threshold],
1006 category->threshold);
1009 category->initialized = 1;
1010 if (log_cat_init_mutex != NULL) {
1011 xbt_os_rmutex_release(log_cat_init_mutex);
1013 return priority >= category->threshold;
1015 #undef _xbt_log_cat_init
1018 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
1020 xbt_assert(cat, "NULL category to be given a parent");
1021 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1023 /* if the category is initialized, unlink from current parent */
1024 if (cat->initialized) {
1026 xbt_log_category_t *cpp = &cat->parent->firstChild;
1028 while (*cpp != cat && *cpp != NULL) {
1029 cpp = &(*cpp)->nextSibling;
1032 xbt_assert(*cpp == cat);
1033 *cpp = cat->nextSibling;
1036 cat->parent = parent;
1037 cat->nextSibling = parent->firstChild;
1039 parent->firstChild = cat;
1041 if (!parent->initialized)
1042 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1044 cat->threshold = parent->threshold;
1046 cat->isThreshInherited = 1;
1049 static void _set_inherited_thresholds(xbt_log_category_t cat)
1052 xbt_log_category_t child = cat->firstChild;
1054 for (; child != NULL; child = child->nextSibling) {
1055 if (child->isThreshInherited) {
1056 if (cat != &_XBT_LOGV(log))
1057 XBT_VERB("Set category threshold of %s to %s (=%d)",
1058 child->name, xbt_log_priority_names[cat->threshold],
1060 child->threshold = cat->threshold;
1061 _set_inherited_thresholds(child);
1068 void xbt_log_threshold_set(xbt_log_category_t cat,
1069 e_xbt_log_priority_t threshold)
1071 cat->threshold = threshold;
1072 cat->isThreshInherited = 0;
1074 _set_inherited_thresholds(cat);
1078 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1080 const char *orig_control_string = control_string;
1081 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1082 const char *name, *dot, *eq;
1084 set->catname = NULL;
1085 set->thresh = xbt_log_priority_uninitialized;
1087 set->additivity = -1;
1088 set->appender = NULL;
1090 if (!*control_string)
1092 XBT_DEBUG("Parse log setting '%s'", control_string);
1094 control_string += strspn(control_string, " ");
1095 name = control_string;
1096 control_string += strcspn(control_string, ".= ");
1097 dot = control_string;
1098 control_string += strcspn(control_string, ":= ");
1099 eq = control_string;
1100 control_string += strcspn(control_string, " ");
1102 if(*dot != '.' && (*eq == '=' || *eq == ':'))
1103 xbt_die ("Invalid control string '%s'", orig_control_string);
1105 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
1107 char *neweq = xbt_strdup(eq + 1);
1108 char *p = neweq - 1;
1110 while (*(++p) != '\0') {
1111 if (*p >= 'a' && *p <= 'z') {
1116 XBT_DEBUG("New priority name = %s", neweq);
1117 for (i = 0; i < xbt_log_priority_infinite; i++) {
1118 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1119 XBT_DEBUG("This is priority %d", i);
1124 if(i<XBT_LOG_STATIC_THRESHOLD){
1126 "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
1127 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
1128 "while -DNLOG forbids any logging, at any level.",
1129 eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
1131 }else if (i < xbt_log_priority_infinite) {
1132 set->thresh = (e_xbt_log_priority_t) i;
1134 THROWF(arg_error, 0,
1135 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1139 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1140 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1142 char *neweq = xbt_strdup(eq + 1);
1143 char *p = neweq - 1;
1145 while (*(++p) != '\0') {
1146 if (*p >= 'a' && *p <= 'z') {
1150 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1151 || !strcmp(neweq, "1")) {
1152 set->additivity = 1;
1154 set->additivity = 0;
1157 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1158 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1160 char *neweq = xbt_strdup(eq + 1);
1162 if (!strncmp(neweq, "file:", 5)) {
1163 set->appender = xbt_log_appender_file_new(neweq + 5);
1164 }else if (!strncmp(neweq, "rollfile:", 9)) {
1165 set->appender = xbt_log_appender2_file_new(neweq + 9,1);
1166 }else if (!strncmp(neweq, "splitfile:", 10)) {
1167 set->appender = xbt_log_appender2_file_new(neweq + 10,0);
1169 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1172 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1173 set->fmt = xbt_strdup(eq + 1);
1176 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1177 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1180 set->catname = (char *) xbt_malloc(dot - name + 1);
1182 memcpy(set->catname, name, dot - name);
1183 set->catname[dot - name] = '\0'; /* Just in case */
1184 XBT_DEBUG("This is for cat '%s'", set->catname);
1189 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1192 xbt_log_category_t child, res;
1194 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1195 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1196 (cat->nextSibling ? cat->nextSibling->name : "none"));
1197 if (!strcmp(cat->name, name))
1200 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1201 XBT_DEBUG("Dig into %s", child->name);
1202 res = _xbt_log_cat_searchsub(child, name);
1212 * \param control_string What to parse
1214 * Typically passed a command-line argument. The string has the syntax:
1216 * ( [category] "." [keyword] ":" value (" ")... )...
1218 * where [category] is one the category names (see \ref XBT_log_cats for
1219 * a complete list of the ones defined in the SimGrid library)
1220 * and keyword is one of the following:
1222 * - thres: category's threshold priority. Possible values:
1223 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1224 * - add or additivity: whether the logging actions must be passed to
1225 * the parent category.
1226 * Possible values: 0, 1, no, yes, on, off.
1227 * Default value: yes.
1228 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1229 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1233 void xbt_log_control_set(const char *control_string)
1235 xbt_log_setting_t set;
1237 /* To split the string in commands, and the cursors */
1238 xbt_dynar_t set_strings;
1242 if (!control_string)
1244 XBT_DEBUG("Parse log settings '%s'", control_string);
1246 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1247 if (!strcmp(control_string, "no_loc")) {
1251 /* some initialization if this is the first time that this get called */
1252 if (xbt_log_settings == NULL)
1253 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1256 /* split the string, and remove empty entries */
1257 set_strings = xbt_str_split_quoted(control_string);
1259 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1260 xbt_dynar_free(&set_strings);
1264 /* Parse each entry and either use it right now (if the category was already
1265 created), or store it for further use */
1266 xbt_dynar_foreach(set_strings, cpt, str) {
1267 xbt_log_category_t cat = NULL;
1269 set = _xbt_log_parse_setting(str);
1271 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1274 XBT_DEBUG("Apply directly");
1275 _xbt_log_cat_apply_set(cat, set);
1276 _free_setting((void *) &set);
1279 XBT_DEBUG("Store for further application");
1280 XBT_DEBUG("push %p to the settings", (void *) set);
1281 xbt_dynar_push(xbt_log_settings, &set);
1284 xbt_dynar_free(&set_strings);
1287 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1289 if (cat->appender) {
1290 if (cat->appender->free_)
1291 cat->appender->free_(cat->appender);
1292 free(cat->appender);
1294 cat->appender = app;
1297 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1299 #define _xbt_log_cat_init(a, b) (0)
1300 if (!cat->appender) {
1302 ("No appender to category %s. Setting the file appender as default",
1304 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1307 if (cat->layout->free_) {
1308 cat->layout->free_(cat->layout);
1313 xbt_log_additivity_set(cat, 0);
1314 #undef _xbt_log_cat_init
1317 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1319 cat->additivity = additivity;
1322 static void xbt_log_help(void)
1325 "Description of the logging output:\n"
1327 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1328 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1329 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1330 " -> trace: enter and return of some functions\n"
1331 " -> debug: crufty output\n"
1332 " -> verbose: verbose output for the user wanting more\n"
1333 " -> info: output about the regular functionning\n"
1334 " -> warning: minor issue encountered\n"
1335 " -> error: issue encountered\n"
1336 " -> critical: major issue encountered\n"
1338 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1339 " OPTIONS may be:\n"
1340 " -> %%%%: the %% char\n"
1341 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1342 " -> %%e: plain old space (SimGrid extension)\n"
1344 " -> %%m: user-provided message\n"
1346 " -> %%c: Category name (LOG4J compatible)\n"
1347 " -> %%p: Priority name (LOG4J compatible)\n"
1349 " -> %%h: Hostname (SimGrid extension)\n"
1350 " -> %%P: Process name (SimGrid extension)\n"
1351 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1352 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1354 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1355 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1356 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1357 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1358 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1360 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1361 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1362 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1364 " -> %%d: date (UNIX-like epoch)\n"
1365 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1368 " --help-log-categories Display the current hierarchy of log categories.\n"
1369 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
1374 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1376 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1377 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1378 return strcmp(a->name, b->name);
1381 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1388 xbt_log_category_t cat;
1393 if (category->parent) {
1394 this_prefix = bprintf("%s \\_ ", prefix);
1395 child_prefix = bprintf("%s | ", prefix);
1397 this_prefix = xbt_strdup(prefix);
1398 child_prefix = xbt_strdup(prefix);
1401 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1402 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1403 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1405 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1407 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1408 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1409 *strrchr(child_prefix, '|') = ' ';
1410 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1411 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1412 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1415 xbt_dynar_free(&dynar);
1416 xbt_free(this_prefix);
1417 xbt_free(child_prefix);
1420 static void xbt_log_help_categories(void)
1422 printf("Current log category hierarchy:\n");
1423 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");