Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
revalidate tesh file with dump output
[simgrid.git] / src / xbt / log.c
1 /* log - a generic logging facility in the spirit of log4j                  */
2
3 /* Copyright (c) 2004-2011. The SimGrid Team.
4  * All rights reserved.                                                     */
5
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. */
8
9
10 #include <stdarg.h>
11 #include <ctype.h>
12 #include <stdio.h>              /* snprintf */
13 #include <stdlib.h>             /* snprintf */
14
15 #include "portable.h"           /* to get a working stdarg.h */
16
17 #include "xbt_modinter.h"
18
19 #include "xbt/misc.h"
20 #include "xbt/ex.h"
21 #include "xbt/str.h"
22 #include "xbt/sysdep.h"
23 #include "xbt/log_private.h"
24 #include "xbt/dynar.h"
25 #include "xbt/xbt_os_thread.h"
26
27 int xbt_log_no_loc = 0;         /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
28 static xbt_os_rmutex_t log_cat_init_mutex = NULL;
29
30 /** \addtogroup XBT_log
31  *
32  *  This section describes the API to the log functions used
33  *  everywhere in this project.
34
35 \section XBT_log_toc Table of contents
36
37  - \ref log_overview
38    - \ref log_cat
39    - \ref log_pri
40    - \ref log_app
41    - \ref log_hist
42  - \ref log_API
43    - \ref log_API_cat
44    - \ref log_API_pri
45    - \ref log_API_isenabled
46    - \ref log_API_subcat
47    - \ref log_API_easy
48    - \ref log_API_example
49  - \ref log_user
50    - \ref log_use_conf
51      - \ref log_use_conf_thres
52      - \ref log_use_conf_multi
53      - \ref log_use_conf_fmt
54      - \ref log_use_conf_app
55      - \ref log_use_conf_add
56    - \ref log_use_misc
57  - \ref log_internals
58    - \ref log_in_perf
59    - \ref log_in_app
60  - \ref XBT_log_cats
61
62 \section log_overview 1. Introduction
63
64 This module is in charge of handling the log messages of every SimGrid
65 program. The main design goal are:
66
67   - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
68     what to hide, as well as how messages get displayed.
69   - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
70     and to the user (with command line options)
71   - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
72   - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
73     and the logging mechanism allows to syndicate each and every log source into the same place.
74     At least, its design would allow to, once we write the last missing pieces
75
76 There is three main concepts in SimGrid's logging mechanism: <i>category</i>,
77 <i>priority</i> and <i>appender</i>. These three concepts work together to
78 enable developers to log messages according to message type and priority, and
79 to control at runtime how these messages are formatted and where they are
80 reported.
81
82 \subsection log_cat 1.1 Category hierarchy
83
84 The first and foremost advantage of any logging API over plain printf()
85 resides in its ability to disable certain log statements while allowing
86 others to print unhindered. This capability assumes that the logging space,
87 that is, the space of all possible logging statements, is categorized
88 according to some developer-chosen criteria.
89
90 This observation led to choosing category as the central concept of the
91 system. In a certain sense, they can be considered as logging topics or
92 channels.
93
94 \subsection log_pri 1.2 Logging priorities
95
96 The user can naturally declare interest into this or that logging category, but
97 he also can specify the desired level of details for each of them. This is
98 controlled by the <i>priority</i> concept (which should maybe be renamed to
99 <i>severity</i>).
100
101 Empirically, the user can specify that he wants to see every debugging message
102 of MSG while only being interested into the messages at level "error" or
103 higher about the XBT internals.
104
105 \subsection log_app 1.3 Message appenders
106
107 The message appenders are the elements in charge of actually displaying the
108 message to the user. For now, only two appenders exist: the default one prints
109 stuff on stderr while it is possible to create appenders printing to a specific
110 file.
111
112 Other are planed (such as the one sending everything to a remote server,
113 or the one using only a fixed amount of lines in a file, and rotating content on
114 need). One day, for sure ;)
115
116 \subsection log_lay 1.4 Message layouts
117
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.
121
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.
125
126 \subsection log_hist 1.5 History of this module
127
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.
134
135 \section log_API 2. Programmer interface
136
137 \subsection log_API_cat 2.1 Constructing the category hierarchy
138
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.
142
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:
145
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
151       in this file
152  -  \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
153     Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
154       in this file
155
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
161
162 Typically, there will be a Category for each module and sub-module, so you
163 can independently control logging for each module.
164
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.
168
169 \section log_API_pri 2.2 Declaring message priority
170
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.
174
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.
179
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.
185
186 Here is an example of the most basic type of macro. This is a logging
187 request with priority <i>warning</i>.
188
189 <code>XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5,
190 "oops");</code>
191
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.
196
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:
201
202 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
203
204 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
205
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.
211
212 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
213
214 \section log_API_subcat 2.4 Using a default category (the easy interface)
215
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:
219
220 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
221
222 Only one default category can be created per file, though multiple
223 non-defaults can be created and used.
224
225 \section log_API_easy 2.5 Putting all together: the easy interface
226
227 First of all, each module should register its own category into the categories
228 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
229
230 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
231 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
232
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>
236
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
241 first argument.
242
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.
245
246 \section log_API_example 2.6 Example of use
247
248 Here is a more complete example:
249
250 \verbatim
251 #include "xbt/log.h"
252
253 / * create a category and a default subcategory * /
254 XBT_LOG_NEW_CATEGORY(VSS);
255 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
256
257 int main() {
258        / * Now set the parent's priority.  (the string would typically be a runtime option) * /
259        xbt_log_control_set("SA.thresh:3");
260
261        / * This request is enabled, because WARNING >= INFO. * /
262        XBT_CWARN(VSS, "Low fuel level.");
263
264        / * This request is disabled, because DEBUG < INFO. * /
265        XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
266
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.");
270
271        / * This request is disabled, because DEBUG < INFO. * /
272        XBT_DEBUG("Exiting gas station search");
273 }
274 \endverbatim
275
276 \section log_user 3. User interface
277
278 \section log_use_conf 3.1 Configuration
279
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.
285
286 \subsection log_use_conf_thres 3.1.1 Threshold configuration
287
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.
291
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
295 completely off.
296
297 Note that the <tt>threshold</tt> keyword can be abbreviated here. For example,
298 all the following notations have the same result.
299 \verbatim
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
306 --log=root.thr:debug
307 --log=root.th:debug
308 --log=root.t:debug
309 --log=root.:debug     <--- That's obviously really ugly, but it actually works.
310 \endverbatim
311
312 The full list of recognized thresholds is the following:
313
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 
321
322 \subsection log_use_conf_multi 3.1.2 Passing several settings
323
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.
328
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
333
334 \subsection log_use_conf_fmt 3.1.3 Format configuration
335
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.
341
342 Here are the existing format directives:
343
344  - %%: the % char
345  - %%n: platform-dependent line separator (LOG4J compatible)
346  - %%e: plain old space (SimGrid extension)
347
348  - %%m: user-provided message
349
350  - %%c: Category name (LOG4J compatible)
351  - %%p: Priority name (LOG4J compatible)
352
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)
357
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.
363
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.
369
370  - %%d: date (UNIX-like epoch)
371  - %%r: application age (time elapsed since the beginning of the application)
372
373
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).
382
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. 
388
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.
394
395 \subsection log_use_conf_app 3.1.4 Category appender
396
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.
401
402 Any appender setup this way have its own layout format (simple one by default),
403 so you may have to change it too afterward. Moreover, the additivity of the log category
404 is also set to false to prevent log event displayed by this appender to "leak" to any other
405 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
406 manually.
407
408 \subsection log_use_conf_add 3.1.5 Category additivity
409
410 The <tt>add</tt> keyword allows to specify the additivity of a
411 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
412 and 'off' are all valid values, with 'yes' as default.
413
414 The following example resets the additivity of the xbt category to true (which is its default value).
415 \verbatim --log=xbt.add:yes\endverbatim
416
417 \section log_use_misc 3.2 Misc and Caveats
418
419   - Do not use any of the macros that start with '_'.
420   - Log4J has a 'rolling file appender' which you can select with a run-time
421     option and specify the max file size. This would be a nice default for
422     non-kernel applications.
423   - Careful, category names are global variables.
424
425 \section log_internals 4. Internal considerations
426
427 This module is a mess of macro black magic, and when it goes wrong,
428 SimGrid studently loose its ability to explain its problems. When
429 messing around this module, I often find useful to define
430 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
431 of finding what's going wrong. But things are quite verbose when
432 everything is enabled...
433
434 \section log_in_perf 4.1 Performance
435
436 Except for the first invocation of a given category, a disabled logging request
437 requires an a single comparison of a static variable to a constant.
438
439 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
440 causes all logging requests with a lower priority to be optimized to 0 cost
441 by the compiler. By setting it to xbt_log_priority_infinite, all logging
442 requests are statically disabled at compile time and cost nothing. Released executables
443 <i>might</i>  be compiled with (note that it will prevent users to debug their problems)
444 \verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
445
446 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
447 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
448 the requests of priority below INFO.
449
450 \todo Logging performance *may* be improved further by improving the message
451 propagation from appender to appender in the category tree.
452
453 \section log_in_app 4.2 Appenders
454
455 Each category has an optional appender. An appender is a pointer to a
456 structure which starts with a pointer to a do_append() function. do_append()
457 prints a message to a log.
458
459 When a category is passed a message by one of the logging macros, the
460 category performs the following actions:
461
462   - if the category has an appender, the message is passed to the
463     appender's do_append() function,
464   - if additivity is true for the category, the message is passed to
465     the category's parent. Additivity is true by default, and can be
466     controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
467     Also, when you add an appender to a category, its additivity is automatically turned to off.
468     Turn it back on afterward if it is not what you wanted.
469
470 By default, only the root category have an appender, and any other category has
471 its additivity set to true. This causes all messages to be logged by the root
472 category's appender.
473
474 The default appender function currently prints to stderr, and the only other
475 existing one writes to the specified file. More would be needed, like the one
476 able to send the logs to a remote dedicated server.
477 This is on our TODO list for quite a while now, but your help would be
478 welcome here, too. */
479
480 xbt_log_appender_t xbt_log_default_appender = NULL;     /* set in log_init */
481 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
482
483 typedef struct {
484   char *catname;
485   char *fmt;
486   e_xbt_log_priority_t thresh;
487   int additivity;
488   xbt_log_appender_t appender;
489 } s_xbt_log_setting_t, *xbt_log_setting_t;
490
491 static xbt_dynar_t xbt_log_settings = NULL;
492
493 static void _free_setting(void *s)
494 {
495   xbt_log_setting_t set = *(xbt_log_setting_t *) s;
496   if (set) {
497     free(set->catname);
498     free(set->fmt);
499     free(set);
500   }
501 }
502
503 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
504                                    xbt_log_setting_t setting);
505
506 const char *xbt_log_priority_names[8] = {
507   "NONE",
508   "TRACE",
509   "DEBUG",
510   "VERBOSE",
511   "INFO",
512   "WARNING",
513   "ERROR",
514   "CRITICAL"
515 };
516
517 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
518   NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
519       "root", "The common ancestor for all categories",
520       0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
521       0 /* isThreshInherited */ ,
522       NULL /* appender */ , NULL /* layout */ ,
523       0                         /* additivity */
524 };
525
526 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
527                                 "Loggings from the logging mechanism itself");
528
529 /* create the default appender and install it in the root category,
530    which were already created (damnit. Too slow little beetle) */
531 void xbt_log_preinit(void)
532 {
533   xbt_log_default_appender = xbt_log_appender_file_new(NULL);
534   xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
535   _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
536   _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
537   log_cat_init_mutex = xbt_os_rmutex_init();
538 }
539
540 static void xbt_log_connect_categories(void)
541 {
542   /* Connect our log channels: that must be done manually under windows */
543   /* Also permit that they are correctly listed by xbt_log_help_categories() */
544
545   /* xbt */
546   XBT_LOG_CONNECT(xbt);
547   XBT_LOG_CONNECT(graphxml_parse);
548   XBT_LOG_CONNECT(log);
549 #if HAVE_MMAP
550   XBT_LOG_CONNECT(mm_diff);
551 #endif
552   XBT_LOG_CONNECT(module);
553   XBT_LOG_CONNECT(peer);
554   XBT_LOG_CONNECT(replay);
555   XBT_LOG_CONNECT(strbuff);
556   XBT_LOG_CONNECT(xbt_cfg);
557   XBT_LOG_CONNECT(xbt_dict);
558   XBT_LOG_CONNECT(xbt_dict_cursor);
559   XBT_LOG_CONNECT(xbt_dict_elm);
560 #ifdef XBT_USE_DEPRECATED
561   XBT_LOG_CONNECT(xbt_dict_multi);
562 #endif
563   XBT_LOG_CONNECT(xbt_dyn);
564   XBT_LOG_CONNECT(xbt_ex);
565   XBT_LOG_CONNECT(xbt_fifo);
566   XBT_LOG_CONNECT(xbt_graph);
567   XBT_LOG_CONNECT(xbt_heap);
568   XBT_LOG_CONNECT(xbt_lib);
569   XBT_LOG_CONNECT(xbt_mallocator);
570   XBT_LOG_CONNECT(xbt_matrix);
571   XBT_LOG_CONNECT(xbt_parmap);
572   XBT_LOG_CONNECT(xbt_queue);
573   XBT_LOG_CONNECT(xbt_set);
574   XBT_LOG_CONNECT(xbt_sync);
575   XBT_LOG_CONNECT(xbt_sync_os);
576
577 #ifdef simgrid_EXPORTS
578   /* The following categories are only defined in libsimgrid */
579
580   /* bindings */
581 #ifdef HAVE_LUA
582   XBT_LOG_CONNECT(bindings);
583   XBT_LOG_CONNECT(lua);
584   XBT_LOG_CONNECT(lua_comm);
585   XBT_LOG_CONNECT(lua_host);
586   XBT_LOG_CONNECT(lua_platf);
587   XBT_LOG_CONNECT(lua_process);
588   XBT_LOG_CONNECT(lua_state_cloner);
589   XBT_LOG_CONNECT(lua_task);
590   XBT_LOG_CONNECT(lua_utils);
591 #endif
592
593   /* instr */
594 #ifdef HAVE_TRACING
595   XBT_LOG_CONNECT(instr);
596   XBT_LOG_CONNECT(instr_api);
597   XBT_LOG_CONNECT(instr_config);
598   XBT_LOG_CONNECT(instr_msg);
599   XBT_LOG_CONNECT(instr_msg_process);
600   XBT_LOG_CONNECT(instr_msg_vm);
601   XBT_LOG_CONNECT(instr_paje_containers);
602   XBT_LOG_CONNECT(instr_paje_header);
603   XBT_LOG_CONNECT(instr_paje_trace);
604   XBT_LOG_CONNECT(instr_paje_types);
605   XBT_LOG_CONNECT(instr_paje_values);
606   XBT_LOG_CONNECT(instr_resource);
607   XBT_LOG_CONNECT(instr_routing);
608   XBT_LOG_CONNECT(instr_sd);
609   XBT_LOG_CONNECT(instr_surf);
610 #endif
611
612   /* jedule */
613 #ifdef HAVE_JEDULE
614   XBT_LOG_CONNECT(jedule);
615   XBT_LOG_CONNECT(jed_out);
616   XBT_LOG_CONNECT(jed_sd);
617 #endif
618
619   /* mc */
620 #ifdef HAVE_MC
621   XBT_LOG_CONNECT(mc);
622   XBT_LOG_CONNECT(mc_checkpoint);
623   XBT_LOG_CONNECT(mc_compare);
624   XBT_LOG_CONNECT(mc_dpor);
625   XBT_LOG_CONNECT(mc_global);
626   XBT_LOG_CONNECT(mc_liveness);
627   XBT_LOG_CONNECT(mc_memory);
628   XBT_LOG_CONNECT(mc_memory_map);
629   XBT_LOG_CONNECT(mc_request);
630 #endif
631
632   /* msg */
633   XBT_LOG_CONNECT(msg);
634   XBT_LOG_CONNECT(msg_action);
635   XBT_LOG_CONNECT(msg_gos);
636   XBT_LOG_CONNECT(msg_io);
637   XBT_LOG_CONNECT(msg_kernel);
638   XBT_LOG_CONNECT(msg_mailbox);
639   XBT_LOG_CONNECT(msg_new_API);
640   XBT_LOG_CONNECT(msg_process);
641   XBT_LOG_CONNECT(msg_synchro);
642   XBT_LOG_CONNECT(msg_task);
643   XBT_LOG_CONNECT(msg_vm);
644    
645   /* simdag */
646   XBT_LOG_CONNECT(sd);
647   XBT_LOG_CONNECT(sd_daxparse);
648 #ifdef HAVE_GRAPHVIZ
649   XBT_LOG_CONNECT(sd_dotparse);
650 #endif
651   XBT_LOG_CONNECT(sd_kernel);
652   XBT_LOG_CONNECT(sd_task);
653   XBT_LOG_CONNECT(sd_workstation);
654
655   /* simix */
656   XBT_LOG_CONNECT(simix);
657   XBT_LOG_CONNECT(simix_context);
658   XBT_LOG_CONNECT(simix_deployment);
659   XBT_LOG_CONNECT(simix_environment);
660   XBT_LOG_CONNECT(simix_host);
661   XBT_LOG_CONNECT(simix_io);
662   XBT_LOG_CONNECT(simix_kernel);
663   XBT_LOG_CONNECT(simix_network);
664   XBT_LOG_CONNECT(simix_new_api);
665   XBT_LOG_CONNECT(simix_process);
666   XBT_LOG_CONNECT(simix_smurf);
667   XBT_LOG_CONNECT(simix_synchro);
668
669   /* smpi */
670   /* SMPI categories are connected in smpi_global.c */
671
672   /* surf */
673   XBT_LOG_CONNECT(surf);
674   XBT_LOG_CONNECT(platf_generator);
675   XBT_LOG_CONNECT(random);
676   XBT_LOG_CONNECT(surf_config);
677   XBT_LOG_CONNECT(surf_cpu);
678   XBT_LOG_CONNECT(surf_cpu_ti);
679   XBT_LOG_CONNECT(surf_kernel);
680   XBT_LOG_CONNECT(surf_lagrange);
681   XBT_LOG_CONNECT(surf_lagrange_dichotomy);
682   XBT_LOG_CONNECT(surf_maxmin);
683   XBT_LOG_CONNECT(surf_network);
684   XBT_LOG_CONNECT(surf_new_model);
685 #ifdef HAVE_GTNETS
686   XBT_LOG_CONNECT(surf_network_gtnets);
687   XBT_LOG_CONNECT(surf_network_gtnets_interface);
688   XBT_LOG_CONNECT(surf_network_gtnets_simulator);
689   XBT_LOG_CONNECT(surf_network_gtnets_topology);
690 #endif
691 #ifdef HAVE_NS3
692   XBT_LOG_CONNECT(surf_network_ns3);
693   XBT_LOG_CONNECT(interface_ns3);
694   XBT_LOG_CONNECT(simulator_ns3);
695 #endif
696   XBT_LOG_CONNECT(surf_parse);
697   XBT_LOG_CONNECT(surf_route);
698   XBT_LOG_CONNECT(surf_routing_generic);
699   XBT_LOG_CONNECT(surf_route_cluster);
700   XBT_LOG_CONNECT(surf_route_dijkstra);
701   XBT_LOG_CONNECT(surf_route_floyd);
702   XBT_LOG_CONNECT(surf_route_full);
703   XBT_LOG_CONNECT(surf_route_none);
704   XBT_LOG_CONNECT(surf_route_vivaldi);
705   XBT_LOG_CONNECT(surf_storage);
706   XBT_LOG_CONNECT(surf_trace);
707   XBT_LOG_CONNECT(surf_workstation);
708
709 #endif /* simgrid_EXPORTS */
710 }
711
712 static void xbt_log_help(void);
713 static void xbt_log_help_categories(void);
714
715 /** @brief Get all logging settings from the command line
716  *
717  * xbt_log_control_set() is called on each string we got from cmd line
718  */
719 void xbt_log_init(int *argc, char **argv)
720 {
721   unsigned help_requested = 0;  /* 1: logs; 2: categories */
722   int i, j;
723   char *opt;
724
725   //    _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
726
727   xbt_log_connect_categories();
728
729   /* Set logs and init log submodule */
730   for (j = i = 1; i < *argc; i++) {
731     if (!strncmp(argv[i], "--log=", strlen("--log="))) {
732       opt = strchr(argv[i], '=');
733       opt++;
734       xbt_log_control_set(opt);
735       XBT_DEBUG("Did apply '%s' as log setting", opt);
736     } else if (!strcmp(argv[i], "--help-logs")) {
737       help_requested |= 1;
738     } else if (!strcmp(argv[i], "--help-log-categories")) {
739       help_requested |= 2;
740     } else {
741       argv[j++] = argv[i];
742     }
743   }
744   if (j < *argc) {
745     argv[j] = NULL;
746     *argc = j;
747   }
748
749   if (help_requested) {
750     if (help_requested & 1)
751       xbt_log_help();
752     if (help_requested & 2)
753       xbt_log_help_categories();
754     exit(0);
755   }
756 }
757
758 static void log_cat_exit(xbt_log_category_t cat)
759 {
760   xbt_log_category_t child;
761
762   if (cat->appender) {
763     if (cat->appender->free_)
764       cat->appender->free_(cat->appender);
765     free(cat->appender);
766   }
767   if (cat->layout) {
768     if (cat->layout->free_)
769       cat->layout->free_(cat->layout);
770     free(cat->layout);
771   }
772
773   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
774     log_cat_exit(child);
775 }
776
777 void xbt_log_postexit(void)
778 {
779   XBT_VERB("Exiting log");
780   xbt_os_rmutex_destroy(log_cat_init_mutex);
781   xbt_dynar_free(&xbt_log_settings);
782   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
783 }
784
785  /* Size of the static string in which we  build the log string */
786 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
787 /* Minimum size of the dynamic string in which we build the log string
788    (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
789 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
790
791 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
792 {
793   xbt_log_category_t cat = ev->cat;
794
795   xbt_assert(ev->priority >= 0,
796              "Negative logging priority naturally forbidden");
797   xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
798              "Priority %d is greater than the biggest allowed value",
799              ev->priority);
800
801   do {
802     xbt_log_appender_t appender = cat->appender;
803
804     if (!appender)
805       continue;                 /* No appender, try next */
806
807     xbt_assert(cat->layout,
808                "No valid layout for the appender of category %s", cat->name);
809
810     /* First, try with a static buffer */
811     if (XBT_LOG_STATIC_BUFFER_SIZE) {
812       char buff[XBT_LOG_STATIC_BUFFER_SIZE];
813       int done;
814       ev->buffer = buff;
815       ev->buffer_size = sizeof buff;
816       va_start(ev->ap, fmt);
817       done = cat->layout->do_layout(cat->layout, ev, fmt);
818       va_end(ev->ap);
819       if (done) {
820         appender->do_append(appender, buff);
821         continue;               /* Ok, that worked: go next */
822       }
823     }
824
825     /* The static buffer was too small, use a dynamically expanded one */
826     ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
827     ev->buffer = xbt_malloc(ev->buffer_size);
828     while (1) {
829       int done;
830       va_start(ev->ap, fmt);
831       done = cat->layout->do_layout(cat->layout, ev, fmt);
832       va_end(ev->ap);
833       if (done)
834         break;                  /* Got it */
835       ev->buffer_size *= 2;
836       ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
837     }
838     appender->do_append(appender, ev->buffer);
839     xbt_free(ev->buffer);
840
841   } while (cat->additivity && (cat = cat->parent, 1));
842 }
843
844 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
845 #undef XBT_LOG_STATIC_BUFFER_SIZE
846
847 /* NOTE:
848  *
849  * The standard logging macros use _XBT_LOG_ISENABLED, which calls
850  * _xbt_log_cat_init().  Thus, if we want to avoid an infinite
851  * recursion, we can not use the standard logging macros in
852  * _xbt_log_cat_init(), and in all functions called from it.
853  *
854  * To circumvent the problem, we define the macro_xbt_log_init() as
855  * (0) for the length of the affected functions, and we do not forget
856  * to undefine it at the end!
857  */
858
859 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
860                                    xbt_log_setting_t setting)
861 {
862 #define _xbt_log_cat_init(a, b) (0)
863
864   if (setting->thresh != xbt_log_priority_uninitialized) {
865     xbt_log_threshold_set(category, setting->thresh);
866
867     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
868            category->name, xbt_log_priority_names[category->threshold],
869            category->threshold);
870   }
871
872   if (setting->fmt) {
873     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
874
875     XBT_DEBUG("Apply settings for category '%s': set format to %s",
876            category->name, setting->fmt);
877   }
878
879   if (setting->additivity != -1) {
880     xbt_log_additivity_set(category, setting->additivity);
881
882     XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
883            category->name, (setting->additivity ? "on" : "off"));
884   }
885   if (setting->appender) {
886     xbt_log_appender_set(category, setting->appender);
887     if (!category->layout)
888       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
889     category->additivity = 0;
890     XBT_DEBUG("Set %p as appender of category '%s'",
891            setting->appender, category->name);
892   }
893 #undef _xbt_log_cat_init
894 }
895
896 /*
897  * This gets called the first time a category is referenced and performs the
898  * initialization.
899  * Also resets threshold to inherited!
900  */
901 int _xbt_log_cat_init(xbt_log_category_t category,
902                       e_xbt_log_priority_t priority)
903 {
904 #define _xbt_log_cat_init(a, b) (0)
905
906   if (log_cat_init_mutex != NULL) {
907     xbt_os_rmutex_acquire(log_cat_init_mutex);
908   }
909
910   if (category->initialized) {
911     if (log_cat_init_mutex != NULL) {
912       xbt_os_rmutex_release(log_cat_init_mutex);
913     }
914     return priority >= category->threshold;
915   }
916
917   unsigned int cursor;
918   xbt_log_setting_t setting = NULL;
919   int found = 0;
920
921   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
922          category->name,
923          (category->firstChild ? category->firstChild->name : "none"),
924          (category->nextSibling ? category->nextSibling->name : "none"));
925
926   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
927     category->threshold = xbt_log_priority_info;
928     category->appender = xbt_log_default_appender;
929     category->layout = xbt_log_default_layout;
930   } else {
931
932     if (!category->parent)
933       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
934
935     XBT_DEBUG("Set %s (%s) as father of %s ",
936            category->parent->name,
937            (category->parent->initialized ?
938             xbt_log_priority_names[category->parent->threshold] : "uninited"),
939            category->name);
940     xbt_log_parent_set(category, category->parent);
941
942     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
943       char *buf, *res = NULL;
944       xbt_log_category_t cpp = category->parent->firstChild;
945       while (cpp) {
946         if (res) {
947           buf = bprintf("%s %s", res, cpp->name);
948           free(res);
949           res = buf;
950         } else {
951           res = xbt_strdup(cpp->name);
952         }
953         cpp = cpp->nextSibling;
954       }
955
956       XBT_DEBUG("Children of %s: %s; nextSibling: %s",
957              category->parent->name, res,
958              (category->parent->nextSibling ?
959               category->parent->nextSibling->name : "none"));
960
961       free(res);
962     }
963
964   }
965
966   /* Apply the control */
967   if (xbt_log_settings) {
968     xbt_assert(category, "NULL category");
969     xbt_assert(category->name);
970
971     xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
972       xbt_assert(setting, "Damnit, NULL cat in the list");
973       xbt_assert(setting->catname, "NULL setting(=%p)->catname",
974                  (void *) setting);
975
976       if (!strcmp(setting->catname, category->name)) {
977         found = 1;
978         _xbt_log_cat_apply_set(category, setting);
979         xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
980       }
981     }
982
983     if (!found)
984       XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
985                 category->name, xbt_log_priority_names[category->threshold],
986                 category->threshold);
987   }
988
989   category->initialized = 1;
990   if (log_cat_init_mutex != NULL) {
991     xbt_os_rmutex_release(log_cat_init_mutex);
992   }
993   return priority >= category->threshold;
994
995 #undef _xbt_log_cat_init
996 }
997
998 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
999 {
1000   xbt_assert(cat, "NULL category to be given a parent");
1001   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1002
1003   /* if the category is initialized, unlink from current parent */
1004   if (cat->initialized) {
1005
1006     xbt_log_category_t *cpp = &cat->parent->firstChild;
1007
1008     while (*cpp != cat && *cpp != NULL) {
1009       cpp = &(*cpp)->nextSibling;
1010     }
1011
1012     xbt_assert(*cpp == cat);
1013     *cpp = cat->nextSibling;
1014   }
1015
1016   cat->parent = parent;
1017   cat->nextSibling = parent->firstChild;
1018
1019   parent->firstChild = cat;
1020
1021   if (!parent->initialized)
1022     _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1023
1024   cat->threshold = parent->threshold;
1025
1026   cat->isThreshInherited = 1;
1027 }
1028
1029 static void _set_inherited_thresholds(xbt_log_category_t cat)
1030 {
1031
1032   xbt_log_category_t child = cat->firstChild;
1033
1034   for (; child != NULL; child = child->nextSibling) {
1035     if (child->isThreshInherited) {
1036       if (cat != &_XBT_LOGV(log))
1037         XBT_VERB("Set category threshold of %s to %s (=%d)",
1038               child->name, xbt_log_priority_names[cat->threshold],
1039               cat->threshold);
1040       child->threshold = cat->threshold;
1041       _set_inherited_thresholds(child);
1042     }
1043   }
1044
1045
1046 }
1047
1048 void xbt_log_threshold_set(xbt_log_category_t cat,
1049                            e_xbt_log_priority_t threshold)
1050 {
1051   cat->threshold = threshold;
1052   cat->isThreshInherited = 0;
1053
1054   _set_inherited_thresholds(cat);
1055
1056 }
1057
1058 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1059 {
1060
1061   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1062   const char *name, *dot, *eq;
1063
1064   set->catname = NULL;
1065   set->thresh = xbt_log_priority_uninitialized;
1066   set->fmt = NULL;
1067   set->additivity = -1;
1068   set->appender = NULL;
1069
1070   if (!*control_string)
1071     return set;
1072   XBT_DEBUG("Parse log setting '%s'", control_string);
1073
1074   control_string += strspn(control_string, " ");
1075   name = control_string;
1076   control_string += strcspn(control_string, ".= ");
1077   dot = control_string;
1078   control_string += strcspn(control_string, ":= ");
1079   eq = control_string;
1080   control_string += strcspn(control_string, " ");
1081
1082   xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
1083               "Invalid control string '%s'", control_string);
1084
1085   if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
1086     int i;
1087     char *neweq = xbt_strdup(eq + 1);
1088     char *p = neweq - 1;
1089
1090     while (*(++p) != '\0') {
1091       if (*p >= 'a' && *p <= 'z') {
1092         *p -= 'a' - 'A';
1093       }
1094     }
1095
1096     XBT_DEBUG("New priority name = %s", neweq);
1097     for (i = 0; i < xbt_log_priority_infinite; i++) {
1098       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1099         XBT_DEBUG("This is priority %d", i);
1100         break;
1101       }
1102     }
1103     if (i < xbt_log_priority_infinite) {
1104       set->thresh = (e_xbt_log_priority_t) i;
1105     } else {
1106       THROWF(arg_error, 0,
1107              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1108              eq + 1);
1109     }
1110     free(neweq);
1111   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1112              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1113
1114     char *neweq = xbt_strdup(eq + 1);
1115     char *p = neweq - 1;
1116
1117     while (*(++p) != '\0') {
1118       if (*p >= 'a' && *p <= 'z') {
1119         *p -= 'a' - 'A';
1120       }
1121     }
1122     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1123         || !strcmp(neweq, "1")) {
1124       set->additivity = 1;
1125     } else {
1126       set->additivity = 0;
1127     }
1128     free(neweq);
1129   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1130              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1131
1132     char *neweq = xbt_strdup(eq + 1);
1133
1134     if (!strncmp(neweq, "file:", 5)) {
1135       set->appender = xbt_log_appender_file_new(neweq + 5);
1136     } else {
1137       THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1138     }
1139     free(neweq);
1140   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1141     set->fmt = xbt_strdup(eq + 1);
1142   } else {
1143     char buff[512];
1144     snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1145     THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1146            buff);
1147   }
1148   set->catname = (char *) xbt_malloc(dot - name + 1);
1149
1150   memcpy(set->catname, name, dot - name);
1151   set->catname[dot - name] = '\0';      /* Just in case */
1152   XBT_DEBUG("This is for cat '%s'", set->catname);
1153
1154   return set;
1155 }
1156
1157 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1158                                                  char *name)
1159 {
1160   xbt_log_category_t child, res;
1161
1162   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1163          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1164          (cat->nextSibling ? cat->nextSibling->name : "none"));
1165   if (!strcmp(cat->name, name))
1166     return cat;
1167
1168   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1169     XBT_DEBUG("Dig into %s", child->name);
1170     res = _xbt_log_cat_searchsub(child, name);
1171     if (res)
1172       return res;
1173   }
1174
1175   return NULL;
1176 }
1177
1178 /**
1179  * \ingroup XBT_log
1180  * \param control_string What to parse
1181  *
1182  * Typically passed a command-line argument. The string has the syntax:
1183  *
1184  *      ( [category] "." [keyword] ":" value (" ")... )...
1185  *
1186  * where [category] is one the category names (see \ref XBT_log_cats for
1187  * a complete list of the ones defined in the SimGrid library)
1188  * and keyword is one of the following:
1189  *
1190  *    - thres: category's threshold priority. Possible values:
1191  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1192  *    - add or additivity: whether the logging actions must be passed to
1193  *      the parent category.
1194  *      Possible values: 0, 1, no, yes, on, off.
1195  *      Default value: yes.
1196  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1197  *    - app or appender: the appender to use. See \ref log_use_conf_app for more
1198  *      information.
1199  *
1200  */
1201 void xbt_log_control_set(const char *control_string)
1202 {
1203   xbt_log_setting_t set;
1204
1205   /* To split the string in commands, and the cursors */
1206   xbt_dynar_t set_strings;
1207   char *str;
1208   unsigned int cpt;
1209
1210   if (!control_string)
1211     return;
1212   XBT_DEBUG("Parse log settings '%s'", control_string);
1213
1214   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1215   if (!strcmp(control_string, "no_loc")) {
1216     xbt_log_no_loc = 1;
1217     return;
1218   }
1219   /* some initialization if this is the first time that this get called */
1220   if (xbt_log_settings == NULL)
1221     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1222                                      _free_setting);
1223
1224   /* split the string, and remove empty entries */
1225   set_strings = xbt_str_split_quoted(control_string);
1226
1227   if (xbt_dynar_is_empty(set_strings)) {     /* vicious user! */
1228     xbt_dynar_free(&set_strings);
1229     return;
1230   }
1231
1232   /* Parse each entry and either use it right now (if the category was already
1233      created), or store it for further use */
1234   xbt_dynar_foreach(set_strings, cpt, str) {
1235     xbt_log_category_t cat = NULL;
1236
1237     set = _xbt_log_parse_setting(str);
1238     cat =
1239         _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1240
1241     if (cat) {
1242       XBT_DEBUG("Apply directly");
1243       _xbt_log_cat_apply_set(cat, set);
1244       _free_setting((void *) &set);
1245     } else {
1246
1247       XBT_DEBUG("Store for further application");
1248       XBT_DEBUG("push %p to the settings", (void *) set);
1249       xbt_dynar_push(xbt_log_settings, &set);
1250     }
1251   }
1252   xbt_dynar_free(&set_strings);
1253 }
1254
1255 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1256 {
1257   if (cat->appender) {
1258     if (cat->appender->free_)
1259       cat->appender->free_(cat->appender);
1260     free(cat->appender);
1261   }
1262   cat->appender = app;
1263 }
1264
1265 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1266 {
1267 #define _xbt_log_cat_init(a, b) (0)
1268   if (!cat->appender) {
1269     XBT_VERB
1270         ("No appender to category %s. Setting the file appender as default",
1271          cat->name);
1272     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1273   }
1274   if (cat->layout) {
1275     if (cat->layout->free_) {
1276       cat->layout->free_(cat->layout);
1277     }
1278     free(cat->layout);
1279   }
1280   cat->layout = lay;
1281   xbt_log_additivity_set(cat, 0);
1282 #undef _xbt_log_cat_init
1283 }
1284
1285 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1286 {
1287   cat->additivity = additivity;
1288 }
1289
1290 static void xbt_log_help(void)
1291 {
1292   printf(
1293 "Description of the logging output:\n"
1294 "\n"
1295 "   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1296 "      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1297 "      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1298 "         -> trace: enter and return of some functions\n"
1299 "         -> debug: crufty output\n"
1300 "         -> verbose: verbose output for the user wanting more\n"
1301 "         -> info: output about the regular functionning\n"
1302 "         -> warning: minor issue encountered\n"
1303 "         -> error: issue encountered\n"
1304 "         -> critical: major issue encountered\n"
1305 "\n"
1306 "   Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1307 "      OPTIONS may be:\n"
1308 "         -> %%%%: the %% char\n"
1309 "         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1310 "         -> %%e: plain old space (SimGrid extension)\n"
1311 "\n"
1312 "         -> %%m: user-provided message\n"
1313 "\n"
1314 "         -> %%c: Category name (LOG4J compatible)\n"
1315 "         -> %%p: Priority name (LOG4J compatible)\n"
1316 "\n"
1317 "         -> %%h: Hostname (SimGrid extension)\n"
1318 "         -> %%P: Process name (SimGrid extension)\n"
1319 "         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1320 "         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1321 "\n"
1322 "         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1323 "         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1324 "         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1325 "         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1326 "                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1327 "\n"
1328 "         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1329 "                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1330 "         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1331 "\n"
1332 "         -> %%d: date (UNIX-like epoch)\n"
1333 "         -> %%r: application age (time elapsed since the beginning of the application)\n"
1334 "\n"
1335 "   Miscellaneous:\n"
1336 "      --help-log-categories    Display the current hierarchy of log categories.\n"
1337 "      --log=no_loc             Don't print file names in messages (for tesh tests).\n"
1338 "\n"
1339     );
1340 }
1341
1342 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1343 {
1344   xbt_log_category_t a = *(xbt_log_category_t *)pa;
1345   xbt_log_category_t b = *(xbt_log_category_t *)pb;
1346   return strcmp(a->name, b->name);
1347 }
1348
1349 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1350                                         const char *prefix)
1351 {
1352   char *this_prefix;
1353   char *child_prefix;
1354   xbt_dynar_t dynar;
1355   unsigned i;
1356   xbt_log_category_t cat;
1357
1358   if (!category)
1359     return;
1360
1361   if (category->parent) {
1362     this_prefix = bprintf("%s \\_ ", prefix);
1363     child_prefix = bprintf("%s |  ", prefix);
1364   } else {
1365     this_prefix = xbt_strdup(prefix);
1366     child_prefix = xbt_strdup(prefix);
1367   }
1368
1369   dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1370   for (cat = category ; cat != NULL; cat = cat->nextSibling)
1371     xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1372
1373   xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1374
1375   for (i = 0; i < xbt_dynar_length(dynar); i++) {
1376     if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1377       *strrchr(child_prefix, '|') = ' ';
1378     cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1379     printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1380     xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1381   }
1382
1383   xbt_dynar_free(&dynar);
1384   xbt_free(this_prefix);
1385   xbt_free(child_prefix);
1386 }
1387
1388 static void xbt_log_help_categories(void)
1389 {
1390   printf("Current log category hierarchy:\n");
1391   xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), "   ");
1392   printf("\n");
1393 }