1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2014. 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, only two appenders exist: the default one prints
108 stuff on stderr while it is possible to create appenders printing to a specific
111 Other are planed (such as the one sending everything to a remote server,
112 or the one using only a fixed amount of lines in a file, and rotating content on
113 need). One day, for sure ;)
115 \subsection log_lay 1.4 Message layouts
117 The message layouts are the elements in charge of choosing how each message
118 will look like. Their result is a string which is then passed to the appender
119 attached to the category to be displayed.
121 For now, there is two layouts: The simple one, which is good for most cases,
122 and another one allowing users to specify the format they want.
123 \ref log_use_conf provides more info on this.
125 \subsection log_hist 1.5 History of this module
127 Historically, this module is an adaptation of the log4c project, which is dead
128 upstream, and which I was given the permission to fork under the LGPL licence
129 by the log4c's authors. The log4c project itself was loosely based on the
130 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
131 differs somehow from these projects anyway, because the C programming language
132 is not object oriented.
134 \section log_API 2. Programmer interface
136 \subsection log_API_cat 2.1 Constructing the category hierarchy
138 Every category is declared by providing a name and an optional
139 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
140 the category's parent.
142 A category is created by a macro call at the top level of a file. A
143 category can be created with any one of the following macros:
145 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
146 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
147 Create a new category being child of the category ParentCat
148 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
149 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
151 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
152 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
155 The parent cat can be defined in the same file or in another file (in
156 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
157 it visible in the current file), but each category may have only one
158 definition. Likewise, you can use a category defined in another file as
159 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
161 Typically, there will be a Category for each module and sub-module, so you
162 can independently control logging for each module.
164 For a list of all existing categories, please refer to the \ref XBT_log_cats
165 section. This file is generated automatically from the SimGrid source code, so
166 it should be complete and accurate.
168 \section log_API_pri 2.2 Declaring message priority
170 A category may be assigned a threshold priority. The set of priorities are
171 defined by the \ref e_xbt_log_priority_t enum. All logging request under
172 this priority will be discarded.
174 If a given category is not assigned a threshold priority, then it inherits
175 one from its closest ancestor with an assigned threshold. To ensure that all
176 categories can eventually inherit a threshold, the root category always has
177 an assigned threshold priority.
179 Logging requests are made by invoking a logging macro on a category. All of
180 the macros have a printf-style format string followed by arguments. If you
181 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
182 when you pass a pointer to a string where an integer was specified by the
183 format. This is usually a good idea.
185 Here is an example of the most basic type of macro. This is a logging
186 request with priority <i>warning</i>.
188 <code>XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5,
191 A logging request is said to be enabled if its priority is higher than or
192 equal to the threshold priority of its category. Otherwise, the request is
193 said to be disabled. A category without an assigned priority will inherit
194 one from the hierarchy.
196 It is possible to use any non-negative integer as a priority. If, as in the
197 example, one of the standard priorities is used, then there is a convenience
198 macro that is typically used instead. For example, the above example is
199 equivalent to the shorter:
201 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
203 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
205 It is sometimes useful to check whether a particular category is
206 enabled at a particular priority. One example is when you want to do
207 some extra computation to prepare a nice debugging message. There is
208 no use of doing so if the message won't be used afterward because
209 debugging is turned off.
211 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
213 \section log_API_subcat 2.4 Using a default category (the easy interface)
215 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
216 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
217 category, then the even shorter form can be used:
219 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
221 Only one default category can be created per file, though multiple
222 non-defaults can be created and used.
224 \section log_API_easy 2.5 Putting all together: the easy interface
226 First of all, each module should register its own category into the categories
227 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
229 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
230 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
232 Under GCC, these macro check there arguments the same way than printf does. So,
233 if you compile with -Wall, the following code will issue a warning:
234 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
236 If you want to specify the category to log onto (for example because you
237 have more than one category per file, add a C before the name of the log
238 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
239 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
242 The TRACE priority is not used the same way than the other. You should use
243 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
245 \section log_API_example 2.6 Example of use
247 Here is a more complete example:
252 / * create a category and a default subcategory * /
253 XBT_LOG_NEW_CATEGORY(VSS);
254 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
257 / * Now set the parent's priority. (the string would typically be a runtime option) * /
258 xbt_log_control_set("SA.thresh:3");
260 / * This request is enabled, because WARNING >= INFO. * /
261 XBT_CWARN(VSS, "Low fuel level.");
263 / * This request is disabled, because DEBUG < INFO. * /
264 XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
266 / * The default category SA inherits its priority from VSS. Thus,
267 the following request is enabled because INFO >= INFO. * /
268 XBT_INFO("Located nearest gas station.");
270 / * This request is disabled, because DEBUG < INFO. * /
271 XBT_DEBUG("Exiting gas station search");
275 \section log_user 3. User interface
277 \section log_use_conf 3.1 Configuration
279 Although rarely done, it is possible to configure the logs during
280 program initialization by invoking the xbt_log_control_set() method
281 manually. A more conventional way is to use the --log command line
282 argument. xbt_init() (called by MSG_init() and friends)
283 checks and deals properly with such arguments.
285 \subsection log_use_conf_thres 3.1.1 Threshold configuration
287 The most common setting is to control which logging event will get
288 displayed by setting a threshold to each category through the
289 <tt>threshold</tt> keyword.
291 For example, \verbatim --log=root.threshold:debug\endverbatim will make
292 SimGrid <b>extremely</b> verbose while \verbatim
293 --log=root.thres:critical\endverbatim should shut it almost
296 Note that the <tt>threshold</tt> keyword can be abbreviated here. For example,
297 all the following notations have the same result.
299 --log=root.threshold:debug
300 --log=root.threshol:debug
301 --log=root.thresho:debug
302 --log=root.thresh:debug
303 --log=root.thres:debug
304 --log=root.thre:debug
308 --log=root.:debug <--- That's obviously really ugly, but it actually works.
311 The full list of recognized thresholds is the following:
313 - trace: enter and return of some functions
314 - debug: crufty output
315 - verbose: verbose output for the user wanting more
316 - info: output about the regular functionning
317 - warning: minor issue encountered
318 - error: issue encountered
319 - critical: major issue encountered
321 \subsection log_use_conf_multi 3.1.2 Passing several settings
323 You can provide several of those arguments to change the setting of several
324 categories, they will be applied from left to right. So,
325 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
326 disable almost any logging.
328 Note that the quotes on above line are mandatory because there is a space in
329 the argument, so we are protecting ourselves from the shell, not from SimGrid.
330 We could also reach the same effect with this:
331 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
333 \subsection log_use_conf_fmt 3.1.3 Format configuration
335 As with SimGrid 3.3, it is possible to control the format of log
336 messages. This is done through the <tt>fmt</tt> keyword. For example,
337 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
338 user-message only, removing any decoration such as the date, or the
339 process ID, everything.
341 Here are the existing format directives:
344 - %%n: platform-dependent line separator (LOG4J compatible)
345 - %%e: plain old space (SimGrid extension)
347 - %%m: user-provided message
349 - %%c: Category name (LOG4J compatible)
350 - %%p: Priority name (LOG4J compatible)
352 - %%h: Hostname (SimGrid extension)
353 - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank)
354 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
355 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
357 - %%F: file name where the log event was raised (LOG4J compatible)
358 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
359 - %%L: line number where the log event was raised (LOG4J compatible)
360 - %%M: function name (LOG4J compatible -- called method name here of course).
361 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
363 - %%b: full backtrace (Called %%throwable in LOG4J).
364 Defined only under windows or when using the GNU libc because backtrace() is not defined
365 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
366 - %%B: short backtrace (only the first line of the %%b).
367 Called %%throwable{short} in LOG4J; defined where %%b is.
369 - %%d: date (UNIX-like epoch)
370 - %%r: application age (time elapsed since the beginning of the application)
373 If you want to mimic the simple layout with the format one, you would use this
374 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
375 because the simple layout do not display the message location for messages at
376 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
377 case). Moreover, if there is no process name (ie, messages coming from the
378 library itself, or test programs doing strange things) do not display the
379 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
380 [%%c/%%p] %%m%%n' if they are at priority INFO).
382 For now, there is only two format modifiers: the precision and the
383 width fields. You can for example specify %.4r to get the application
384 age with 4 numbers after the radix, or %15p to get the process name
385 on 15 columns. Finally, you can specify %10.6r to get the time on at
386 most 10 columns, with 6 numbers after the radix.
388 Note that when specifying the width, it is filled with spaces. That
389 is to say that for example %5r in your format is converted to "% 5f"
390 for printf (note the extra space); there is no way to fill the empty
391 columns with 0 (ie, pass "%05f" to printf). Another limitation is
392 that you cannot set specific layouts to the several priorities.
394 \subsection log_use_conf_app 3.1.4 Category appender
396 As with SimGrid 3.3, it is possible to control the appender of log
397 messages. This is done through the <tt>app</tt> keyword. For example,
398 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
399 to the file mylogfile.
401 Any appender setup this way have its own layout format (simple one by default),
402 so you may have to change it too afterward. Moreover, the additivity of the log category
403 is also set to false to prevent log event displayed by this appender to "leak" to any other
404 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
407 \subsection log_use_conf_add 3.1.5 Category additivity
409 The <tt>add</tt> keyword allows to specify the additivity of a
410 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
411 and 'off' are all valid values, with 'yes' as default.
413 The following example resets the additivity of the xbt category to true (which is its default value).
414 \verbatim --log=xbt.add:yes\endverbatim
416 \section log_use_misc 3.2 Misc and Caveats
418 - Do not use any of the macros that start with '_'.
419 - Log4J has a 'rolling file appender' which you can select with a run-time
420 option and specify the max file size. This would be a nice default for
421 non-kernel applications.
422 - Careful, category names are global variables.
423 - When writting a log format, you often want to use spaces. If you don't protect these spaces, they are used as configuration elements separators.
424 For example, if you want to remove the date from the logs, you want to pass the following
425 argument on the command line. The outer quotes are here to protect the string from the shell
426 interpretation while the inner ones are there to prevent simgrid from splitting the string
427 in several log parameters (that would be invalid).
429 \verbatim --log="'root.fmt:%l: [%p/%c]: %m%n'"\endverbatim
431 \section log_internals 4. Internal considerations
433 This module is a mess of macro black magic, and when it goes wrong,
434 SimGrid studently loose its ability to explain its problems. When
435 messing around this module, I often find useful to define
436 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
437 of finding what's going wrong. But things are quite verbose when
438 everything is enabled...
440 \section log_in_perf 4.1 Performance
442 Except for the first invocation of a given category, a disabled logging request
443 requires an a single comparison of a static variable to a constant.
445 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
446 causes all logging requests with a lower priority to be optimized to 0 cost
447 by the compiler. By setting it to xbt_log_priority_infinite, all logging
448 requests are statically disabled at compile time and cost nothing. Released executables
449 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
450 \verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
452 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
453 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
454 the requests of priority below INFO.
456 \todo Logging performance *may* be improved further by improving the message
457 propagation from appender to appender in the category tree.
459 \section log_in_app 4.2 Appenders
461 Each category has an optional appender. An appender is a pointer to a
462 structure which starts with a pointer to a do_append() function. do_append()
463 prints a message to a log.
465 When a category is passed a message by one of the logging macros, the
466 category performs the following actions:
468 - if the category has an appender, the message is passed to the
469 appender's do_append() function,
470 - if additivity is true for the category, the message is passed to
471 the category's parent. Additivity is true by default, and can be
472 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
473 Also, when you add an appender to a category, its additivity is automatically turned to off.
474 Turn it back on afterward if it is not what you wanted.
476 By default, only the root category have an appender, and any other category has
477 its additivity set to true. This causes all messages to be logged by the root
480 The default appender function currently prints to stderr, and the only other
481 existing one writes to the specified file. More would be needed, like the one
482 able to send the logs to a remote dedicated server.
483 This is on our TODO list for quite a while now, but your help would be
484 welcome here, too. */
486 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
487 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
492 e_xbt_log_priority_t thresh;
494 xbt_log_appender_t appender;
495 } s_xbt_log_setting_t, *xbt_log_setting_t;
497 static xbt_dynar_t xbt_log_settings = NULL;
499 static void _free_setting(void *s)
501 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
509 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
510 xbt_log_setting_t setting);
512 const char *xbt_log_priority_names[8] = {
523 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
524 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
525 "root", "The common ancestor for all categories",
526 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
527 0 /* isThreshInherited */ ,
528 NULL /* appender */ , NULL /* layout */ ,
532 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
533 "Loggings from the logging mechanism itself");
535 /* create the default appender and install it in the root category,
536 which were already created (damnit. Too slow little beetle) */
537 void xbt_log_preinit(void)
539 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
540 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
541 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
542 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
543 log_cat_init_mutex = xbt_os_rmutex_init();
546 static void xbt_log_connect_categories(void)
548 /* Connect our log channels: that must be done manually under windows */
549 /* Also permit that they are correctly listed by xbt_log_help_categories() */
552 XBT_LOG_CONNECT(xbt);
553 XBT_LOG_CONNECT(graphxml_parse);
554 XBT_LOG_CONNECT(log);
556 XBT_LOG_CONNECT(mm_diff);
558 XBT_LOG_CONNECT(module);
559 XBT_LOG_CONNECT(peer);
560 XBT_LOG_CONNECT(replay);
561 XBT_LOG_CONNECT(strbuff);
562 XBT_LOG_CONNECT(xbt_cfg);
563 XBT_LOG_CONNECT(xbt_dict);
564 XBT_LOG_CONNECT(xbt_dict_cursor);
565 XBT_LOG_CONNECT(xbt_dict_elm);
566 #ifdef XBT_USE_DEPRECATED
567 XBT_LOG_CONNECT(xbt_dict_multi);
569 XBT_LOG_CONNECT(xbt_dyn);
570 XBT_LOG_CONNECT(xbt_ex);
571 XBT_LOG_CONNECT(xbt_fifo);
572 XBT_LOG_CONNECT(xbt_graph);
573 XBT_LOG_CONNECT(xbt_heap);
574 XBT_LOG_CONNECT(xbt_lib);
575 XBT_LOG_CONNECT(xbt_mallocator);
576 XBT_LOG_CONNECT(xbt_matrix);
577 XBT_LOG_CONNECT(xbt_parmap);
578 XBT_LOG_CONNECT(xbt_queue);
579 XBT_LOG_CONNECT(xbt_set);
580 XBT_LOG_CONNECT(xbt_sync);
581 XBT_LOG_CONNECT(xbt_sync_os);
583 #ifdef simgrid_EXPORTS
584 /* The following categories are only defined in libsimgrid */
588 XBT_LOG_CONNECT(bindings);
589 XBT_LOG_CONNECT(lua);
590 XBT_LOG_CONNECT(lua_comm);
591 XBT_LOG_CONNECT(lua_host);
592 XBT_LOG_CONNECT(lua_platf);
593 XBT_LOG_CONNECT(lua_process);
594 XBT_LOG_CONNECT(lua_state_cloner);
595 XBT_LOG_CONNECT(lua_task);
596 XBT_LOG_CONNECT(lua_utils);
601 XBT_LOG_CONNECT(instr);
602 XBT_LOG_CONNECT(instr_api);
603 XBT_LOG_CONNECT(instr_config);
604 XBT_LOG_CONNECT(instr_msg);
605 XBT_LOG_CONNECT(instr_msg_process);
606 XBT_LOG_CONNECT(instr_msg_vm);
607 XBT_LOG_CONNECT(instr_paje_containers);
608 XBT_LOG_CONNECT(instr_paje_header);
609 XBT_LOG_CONNECT(instr_paje_trace);
610 XBT_LOG_CONNECT(instr_paje_types);
611 XBT_LOG_CONNECT(instr_paje_values);
612 XBT_LOG_CONNECT(instr_resource);
613 XBT_LOG_CONNECT(instr_routing);
614 XBT_LOG_CONNECT(instr_sd);
615 XBT_LOG_CONNECT(instr_surf);
616 XBT_LOG_CONNECT(instr_trace);
617 XBT_LOG_CONNECT(instr_TI_trace);
622 XBT_LOG_CONNECT(jedule);
623 XBT_LOG_CONNECT(jed_out);
624 XBT_LOG_CONNECT(jed_sd);
630 XBT_LOG_CONNECT(mc_checkpoint);
631 XBT_LOG_CONNECT(mc_compare);
632 XBT_LOG_CONNECT(mc_dpor);
633 XBT_LOG_CONNECT(mc_dwarf);
634 XBT_LOG_CONNECT(mc_global);
635 XBT_LOG_CONNECT(mc_hash);
636 XBT_LOG_CONNECT(mc_liveness);
637 XBT_LOG_CONNECT(mc_memory);
638 XBT_LOG_CONNECT(mc_memory_map);
639 XBT_LOG_CONNECT(mc_request);
643 XBT_LOG_CONNECT(msg);
644 XBT_LOG_CONNECT(msg_action);
645 XBT_LOG_CONNECT(msg_gos);
646 XBT_LOG_CONNECT(msg_io);
647 XBT_LOG_CONNECT(msg_kernel);
648 XBT_LOG_CONNECT(msg_mailbox);
649 XBT_LOG_CONNECT(msg_new_API);
650 XBT_LOG_CONNECT(msg_process);
651 XBT_LOG_CONNECT(msg_synchro);
652 XBT_LOG_CONNECT(msg_task);
653 XBT_LOG_CONNECT(msg_vm);
657 XBT_LOG_CONNECT(sd_daxparse);
659 XBT_LOG_CONNECT(sd_dotparse);
661 XBT_LOG_CONNECT(sd_kernel);
662 XBT_LOG_CONNECT(sd_task);
663 XBT_LOG_CONNECT(sd_workstation);
666 XBT_LOG_CONNECT(simix);
667 XBT_LOG_CONNECT(simix_context);
668 XBT_LOG_CONNECT(simix_deployment);
669 XBT_LOG_CONNECT(simix_environment);
670 XBT_LOG_CONNECT(simix_host);
671 XBT_LOG_CONNECT(simix_io);
672 XBT_LOG_CONNECT(simix_kernel);
673 XBT_LOG_CONNECT(simix_network);
674 XBT_LOG_CONNECT(simix_new_api);
675 XBT_LOG_CONNECT(simix_process);
676 XBT_LOG_CONNECT(simix_smurf);
677 XBT_LOG_CONNECT(simix_synchro);
678 XBT_LOG_CONNECT(simix_vm);
681 /* SMPI categories are connected in smpi_global.c */
684 XBT_LOG_CONNECT(surf);
685 XBT_LOG_CONNECT(platf_generator);
686 XBT_LOG_CONNECT(random);
687 XBT_LOG_CONNECT(surf_config);
688 XBT_LOG_CONNECT(surf_cpu);
689 XBT_LOG_CONNECT(surf_cpu_cas);
690 XBT_LOG_CONNECT(surf_cpu_ti);
691 XBT_LOG_CONNECT(surf_energy);
692 XBT_LOG_CONNECT(surf_kernel);
693 XBT_LOG_CONNECT(surf_lagrange);
694 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
695 XBT_LOG_CONNECT(surf_maxmin);
696 XBT_LOG_CONNECT(surf_network);
698 XBT_LOG_CONNECT(surf_network_gtnets);
699 XBT_LOG_CONNECT(surf_network_gtnets_interface);
700 XBT_LOG_CONNECT(surf_network_gtnets_simulator);
701 XBT_LOG_CONNECT(surf_network_gtnets_topology);
704 XBT_LOG_CONNECT(surf_network_ns3);
705 XBT_LOG_CONNECT(interface_ns3);
706 XBT_LOG_CONNECT(simulator_ns3);
708 XBT_LOG_CONNECT(surf_parse);
709 XBT_LOG_CONNECT(surf_route);
710 XBT_LOG_CONNECT(surf_routing_generic);
711 XBT_LOG_CONNECT(surf_route_cluster);
712 XBT_LOG_CONNECT(surf_route_cluster_torus);
713 XBT_LOG_CONNECT(surf_route_dijkstra);
714 XBT_LOG_CONNECT(surf_route_floyd);
715 XBT_LOG_CONNECT(surf_route_full);
716 XBT_LOG_CONNECT(surf_route_none);
717 XBT_LOG_CONNECT(surf_route_vivaldi);
718 XBT_LOG_CONNECT(surf_storage);
719 XBT_LOG_CONNECT(surf_trace);
720 XBT_LOG_CONNECT(surf_vm_workstation);
721 XBT_LOG_CONNECT(surf_workstation);
723 #endif /* simgrid_EXPORTS */
726 static void xbt_log_help(void);
727 static void xbt_log_help_categories(void);
729 /** @brief Get all logging settings from the command line
731 * xbt_log_control_set() is called on each string we got from cmd line
733 void xbt_log_init(int *argc, char **argv)
735 unsigned help_requested = 0; /* 1: logs; 2: categories */
739 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
741 xbt_log_connect_categories();
743 /* Set logs and init log submodule */
744 for (j = i = 1; i < *argc; i++) {
745 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
746 opt = strchr(argv[i], '=');
748 xbt_log_control_set(opt);
749 XBT_DEBUG("Did apply '%s' as log setting", opt);
750 } else if (!strcmp(argv[i], "--help-logs")) {
752 } else if (!strcmp(argv[i], "--help-log-categories")) {
763 if (help_requested) {
764 if (help_requested & 1)
766 if (help_requested & 2)
767 xbt_log_help_categories();
772 static void log_cat_exit(xbt_log_category_t cat)
774 xbt_log_category_t child;
777 if (cat->appender->free_)
778 cat->appender->free_(cat->appender);
782 if (cat->layout->free_)
783 cat->layout->free_(cat->layout);
787 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
791 void xbt_log_postexit(void)
793 XBT_VERB("Exiting log");
794 xbt_os_rmutex_destroy(log_cat_init_mutex);
795 xbt_dynar_free(&xbt_log_settings);
796 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
799 /* Size of the static string in which we build the log string */
800 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
801 /* Minimum size of the dynamic string in which we build the log string
802 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
803 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
805 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
807 xbt_log_category_t cat = ev->cat;
809 xbt_assert(ev->priority >= 0,
810 "Negative logging priority naturally forbidden");
811 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
812 "Priority %d is greater than the biggest allowed value",
816 xbt_log_appender_t appender = cat->appender;
819 continue; /* No appender, try next */
821 xbt_assert(cat->layout,
822 "No valid layout for the appender of category %s", cat->name);
824 /* First, try with a static buffer */
825 if (XBT_LOG_STATIC_BUFFER_SIZE) {
826 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
829 ev->buffer_size = sizeof buff;
830 va_start(ev->ap, fmt);
831 done = cat->layout->do_layout(cat->layout, ev, fmt);
834 appender->do_append(appender, buff);
835 continue; /* Ok, that worked: go next */
839 /* The static buffer was too small, use a dynamically expanded one */
840 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
841 ev->buffer = xbt_malloc(ev->buffer_size);
844 va_start(ev->ap, fmt);
845 done = cat->layout->do_layout(cat->layout, ev, fmt);
849 ev->buffer_size *= 2;
850 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
852 appender->do_append(appender, ev->buffer);
853 xbt_free(ev->buffer);
855 } while (cat->additivity && (cat = cat->parent, 1));
858 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
859 #undef XBT_LOG_STATIC_BUFFER_SIZE
863 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
864 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
865 * recursion, we can not use the standard logging macros in
866 * _xbt_log_cat_init(), and in all functions called from it.
868 * To circumvent the problem, we define the macro_xbt_log_init() as
869 * (0) for the length of the affected functions, and we do not forget
870 * to undefine it at the end!
873 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
874 xbt_log_setting_t setting)
876 #define _xbt_log_cat_init(a, b) (0)
878 if (setting->thresh != xbt_log_priority_uninitialized) {
879 xbt_log_threshold_set(category, setting->thresh);
881 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
882 category->name, xbt_log_priority_names[category->threshold],
883 category->threshold);
887 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
889 XBT_DEBUG("Apply settings for category '%s': set format to %s",
890 category->name, setting->fmt);
893 if (setting->additivity != -1) {
894 xbt_log_additivity_set(category, setting->additivity);
896 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
897 category->name, (setting->additivity ? "on" : "off"));
899 if (setting->appender) {
900 xbt_log_appender_set(category, setting->appender);
901 if (!category->layout)
902 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
903 category->additivity = 0;
904 XBT_DEBUG("Set %p as appender of category '%s'",
905 setting->appender, category->name);
907 #undef _xbt_log_cat_init
911 * This gets called the first time a category is referenced and performs the
913 * Also resets threshold to inherited!
915 int _xbt_log_cat_init(xbt_log_category_t category,
916 e_xbt_log_priority_t priority)
918 #define _xbt_log_cat_init(a, b) (0)
920 if (log_cat_init_mutex != NULL) {
921 xbt_os_rmutex_acquire(log_cat_init_mutex);
924 if (category->initialized) {
925 if (log_cat_init_mutex != NULL) {
926 xbt_os_rmutex_release(log_cat_init_mutex);
928 return priority >= category->threshold;
932 xbt_log_setting_t setting = NULL;
935 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
937 (category->firstChild ? category->firstChild->name : "none"),
938 (category->nextSibling ? category->nextSibling->name : "none"));
940 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
941 category->threshold = xbt_log_priority_info;
942 category->appender = xbt_log_default_appender;
943 category->layout = xbt_log_default_layout;
946 if (!category->parent)
947 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
949 XBT_DEBUG("Set %s (%s) as father of %s ",
950 category->parent->name,
951 (category->parent->initialized ?
952 xbt_log_priority_names[category->parent->threshold] : "uninited"),
954 xbt_log_parent_set(category, category->parent);
956 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
957 char *buf, *res = NULL;
958 xbt_log_category_t cpp = category->parent->firstChild;
961 buf = bprintf("%s %s", res, cpp->name);
965 res = xbt_strdup(cpp->name);
967 cpp = cpp->nextSibling;
970 XBT_DEBUG("Children of %s: %s; nextSibling: %s",
971 category->parent->name, res,
972 (category->parent->nextSibling ?
973 category->parent->nextSibling->name : "none"));
980 /* Apply the control */
981 if (xbt_log_settings) {
982 xbt_assert(category, "NULL category");
983 xbt_assert(category->name);
985 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
986 xbt_assert(setting, "Damnit, NULL cat in the list");
987 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
990 if (!strcmp(setting->catname, category->name)) {
992 _xbt_log_cat_apply_set(category, setting);
993 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
998 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
999 category->name, xbt_log_priority_names[category->threshold],
1000 category->threshold);
1003 category->initialized = 1;
1004 if (log_cat_init_mutex != NULL) {
1005 xbt_os_rmutex_release(log_cat_init_mutex);
1007 return priority >= category->threshold;
1009 #undef _xbt_log_cat_init
1012 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
1014 xbt_assert(cat, "NULL category to be given a parent");
1015 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1017 /* if the category is initialized, unlink from current parent */
1018 if (cat->initialized) {
1020 xbt_log_category_t *cpp = &cat->parent->firstChild;
1022 while (*cpp != cat && *cpp != NULL) {
1023 cpp = &(*cpp)->nextSibling;
1026 xbt_assert(*cpp == cat);
1027 *cpp = cat->nextSibling;
1030 cat->parent = parent;
1031 cat->nextSibling = parent->firstChild;
1033 parent->firstChild = cat;
1035 if (!parent->initialized)
1036 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1038 cat->threshold = parent->threshold;
1040 cat->isThreshInherited = 1;
1043 static void _set_inherited_thresholds(xbt_log_category_t cat)
1046 xbt_log_category_t child = cat->firstChild;
1048 for (; child != NULL; child = child->nextSibling) {
1049 if (child->isThreshInherited) {
1050 if (cat != &_XBT_LOGV(log))
1051 XBT_VERB("Set category threshold of %s to %s (=%d)",
1052 child->name, xbt_log_priority_names[cat->threshold],
1054 child->threshold = cat->threshold;
1055 _set_inherited_thresholds(child);
1062 void xbt_log_threshold_set(xbt_log_category_t cat,
1063 e_xbt_log_priority_t threshold)
1065 cat->threshold = threshold;
1066 cat->isThreshInherited = 0;
1068 _set_inherited_thresholds(cat);
1072 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1074 const char *orig_control_string = control_string;
1075 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1076 const char *name, *dot, *eq;
1078 set->catname = NULL;
1079 set->thresh = xbt_log_priority_uninitialized;
1081 set->additivity = -1;
1082 set->appender = NULL;
1084 if (!*control_string)
1086 XBT_DEBUG("Parse log setting '%s'", control_string);
1088 control_string += strspn(control_string, " ");
1089 name = control_string;
1090 control_string += strcspn(control_string, ".= ");
1091 dot = control_string;
1092 control_string += strcspn(control_string, ":= ");
1093 eq = control_string;
1094 control_string += strcspn(control_string, " ");
1096 xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
1097 "Invalid control string '%s'", orig_control_string);
1099 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
1101 char *neweq = xbt_strdup(eq + 1);
1102 char *p = neweq - 1;
1104 while (*(++p) != '\0') {
1105 if (*p >= 'a' && *p <= 'z') {
1110 XBT_DEBUG("New priority name = %s", neweq);
1111 for (i = 0; i < xbt_log_priority_infinite; i++) {
1112 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1113 XBT_DEBUG("This is priority %d", i);
1118 if(i<XBT_LOG_STATIC_THRESHOLD){
1119 THROWF(arg_error, 0,
1120 "Priority: %s is above allowed priority : %s (for debug and trace levels, recompile SimGrid with -Denable_debug=ON)",
1121 eq + 1, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
1122 }else if (i < xbt_log_priority_infinite) {
1123 set->thresh = (e_xbt_log_priority_t) i;
1125 THROWF(arg_error, 0,
1126 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1130 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1131 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1133 char *neweq = xbt_strdup(eq + 1);
1134 char *p = neweq - 1;
1136 while (*(++p) != '\0') {
1137 if (*p >= 'a' && *p <= 'z') {
1141 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1142 || !strcmp(neweq, "1")) {
1143 set->additivity = 1;
1145 set->additivity = 0;
1148 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1149 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1151 char *neweq = xbt_strdup(eq + 1);
1153 if (!strncmp(neweq, "file:", 5)) {
1154 set->appender = xbt_log_appender_file_new(neweq + 5);
1156 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1159 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1160 set->fmt = xbt_strdup(eq + 1);
1163 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1164 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1167 set->catname = (char *) xbt_malloc(dot - name + 1);
1169 memcpy(set->catname, name, dot - name);
1170 set->catname[dot - name] = '\0'; /* Just in case */
1171 XBT_DEBUG("This is for cat '%s'", set->catname);
1176 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1179 xbt_log_category_t child, res;
1181 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1182 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1183 (cat->nextSibling ? cat->nextSibling->name : "none"));
1184 if (!strcmp(cat->name, name))
1187 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1188 XBT_DEBUG("Dig into %s", child->name);
1189 res = _xbt_log_cat_searchsub(child, name);
1199 * \param control_string What to parse
1201 * Typically passed a command-line argument. The string has the syntax:
1203 * ( [category] "." [keyword] ":" value (" ")... )...
1205 * where [category] is one the category names (see \ref XBT_log_cats for
1206 * a complete list of the ones defined in the SimGrid library)
1207 * and keyword is one of the following:
1209 * - thres: category's threshold priority. Possible values:
1210 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1211 * - add or additivity: whether the logging actions must be passed to
1212 * the parent category.
1213 * Possible values: 0, 1, no, yes, on, off.
1214 * Default value: yes.
1215 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1216 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1220 void xbt_log_control_set(const char *control_string)
1222 xbt_log_setting_t set;
1224 /* To split the string in commands, and the cursors */
1225 xbt_dynar_t set_strings;
1229 if (!control_string)
1231 XBT_DEBUG("Parse log settings '%s'", control_string);
1233 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1234 if (!strcmp(control_string, "no_loc")) {
1238 /* some initialization if this is the first time that this get called */
1239 if (xbt_log_settings == NULL)
1240 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1243 /* split the string, and remove empty entries */
1244 set_strings = xbt_str_split_quoted(control_string);
1246 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1247 xbt_dynar_free(&set_strings);
1251 /* Parse each entry and either use it right now (if the category was already
1252 created), or store it for further use */
1253 xbt_dynar_foreach(set_strings, cpt, str) {
1254 xbt_log_category_t cat = NULL;
1256 set = _xbt_log_parse_setting(str);
1258 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1261 XBT_DEBUG("Apply directly");
1262 _xbt_log_cat_apply_set(cat, set);
1263 _free_setting((void *) &set);
1266 XBT_DEBUG("Store for further application");
1267 XBT_DEBUG("push %p to the settings", (void *) set);
1268 xbt_dynar_push(xbt_log_settings, &set);
1271 xbt_dynar_free(&set_strings);
1274 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1276 if (cat->appender) {
1277 if (cat->appender->free_)
1278 cat->appender->free_(cat->appender);
1279 free(cat->appender);
1281 cat->appender = app;
1284 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1286 #define _xbt_log_cat_init(a, b) (0)
1287 if (!cat->appender) {
1289 ("No appender to category %s. Setting the file appender as default",
1291 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1294 if (cat->layout->free_) {
1295 cat->layout->free_(cat->layout);
1300 xbt_log_additivity_set(cat, 0);
1301 #undef _xbt_log_cat_init
1304 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1306 cat->additivity = additivity;
1309 static void xbt_log_help(void)
1312 "Description of the logging output:\n"
1314 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1315 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1316 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1317 " -> trace: enter and return of some functions\n"
1318 " -> debug: crufty output\n"
1319 " -> verbose: verbose output for the user wanting more\n"
1320 " -> info: output about the regular functionning\n"
1321 " -> warning: minor issue encountered\n"
1322 " -> error: issue encountered\n"
1323 " -> critical: major issue encountered\n"
1325 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1326 " OPTIONS may be:\n"
1327 " -> %%%%: the %% char\n"
1328 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1329 " -> %%e: plain old space (SimGrid extension)\n"
1331 " -> %%m: user-provided message\n"
1333 " -> %%c: Category name (LOG4J compatible)\n"
1334 " -> %%p: Priority name (LOG4J compatible)\n"
1336 " -> %%h: Hostname (SimGrid extension)\n"
1337 " -> %%P: Process name (SimGrid extension)\n"
1338 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1339 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1341 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1342 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1343 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1344 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1345 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1347 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1348 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1349 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1351 " -> %%d: date (UNIX-like epoch)\n"
1352 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1355 " --help-log-categories Display the current hierarchy of log categories.\n"
1356 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
1361 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1363 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1364 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1365 return strcmp(a->name, b->name);
1368 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1375 xbt_log_category_t cat;
1380 if (category->parent) {
1381 this_prefix = bprintf("%s \\_ ", prefix);
1382 child_prefix = bprintf("%s | ", prefix);
1384 this_prefix = xbt_strdup(prefix);
1385 child_prefix = xbt_strdup(prefix);
1388 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1389 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1390 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1392 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1394 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1395 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1396 *strrchr(child_prefix, '|') = ' ';
1397 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1398 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1399 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1402 xbt_dynar_free(&dynar);
1403 xbt_free(this_prefix);
1404 xbt_free(child_prefix);
1407 static void xbt_log_help_categories(void)
1409 printf("Current log category hierarchy:\n");
1410 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");