Logo AND Algorithmique Numérique Distribuée

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