Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Pull changes to push BitTorrent fix
[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 GRAS 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(), gras_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   /* amok */
530   XBT_LOG_CONNECT(amok);
531   XBT_LOG_CONNECT(amok_bw);
532   XBT_LOG_CONNECT(amok_bw_sat);
533   XBT_LOG_CONNECT(amok_pm);
534
535   /* gras */
536   XBT_LOG_CONNECT(gras);
537   XBT_LOG_CONNECT(gras_modules);
538   XBT_LOG_CONNECT(gras_msg);
539   XBT_LOG_CONNECT(gras_msg_read);
540   XBT_LOG_CONNECT(gras_msg_rpc);
541   XBT_LOG_CONNECT(gras_timer);
542   XBT_LOG_CONNECT(gras_trp);
543   XBT_LOG_CONNECT(gras_trp_file);
544   XBT_LOG_CONNECT(gras_virtu);
545   XBT_LOG_CONNECT(gras_virtu_emul);
546   XBT_LOG_CONNECT(gras_virtu_process);
547
548   /* xbt */
549   XBT_LOG_CONNECT(xbt);
550   XBT_LOG_CONNECT(graphxml_parse);
551   XBT_LOG_CONNECT(log);
552 #if HAVE_MMAP
553   XBT_LOG_CONNECT(mm_diff);
554 #endif
555   XBT_LOG_CONNECT(module);
556   XBT_LOG_CONNECT(peer);
557   XBT_LOG_CONNECT(replay);
558   XBT_LOG_CONNECT(strbuff);
559   XBT_LOG_CONNECT(xbt_cfg);
560   XBT_LOG_CONNECT(xbt_dict);
561   XBT_LOG_CONNECT(xbt_dict_cursor);
562   XBT_LOG_CONNECT(xbt_dict_elm);
563 #ifdef XBT_USE_DEPRECATED
564   XBT_LOG_CONNECT(xbt_dict_multi);
565 #endif
566   XBT_LOG_CONNECT(xbt_ddt);
567   XBT_LOG_CONNECT(xbt_ddt_cbps);
568   XBT_LOG_CONNECT(xbt_ddt_convert);
569   XBT_LOG_CONNECT(xbt_ddt_create);
570   XBT_LOG_CONNECT(xbt_ddt_exchange);
571   XBT_LOG_CONNECT(xbt_ddt_parse);
572   XBT_LOG_CONNECT(xbt_ddt_lexer);
573   XBT_LOG_CONNECT(xbt_dyn);
574   XBT_LOG_CONNECT(xbt_ex);
575   XBT_LOG_CONNECT(xbt_fifo);
576   XBT_LOG_CONNECT(xbt_graph);
577   XBT_LOG_CONNECT(xbt_lib);
578   XBT_LOG_CONNECT(xbt_mallocator);
579   XBT_LOG_CONNECT(xbt_matrix);
580   XBT_LOG_CONNECT(xbt_parmap);
581   XBT_LOG_CONNECT(xbt_parmap_unit);
582   XBT_LOG_CONNECT(xbt_queue);
583   XBT_LOG_CONNECT(xbt_set);
584   XBT_LOG_CONNECT(xbt_sync);
585   XBT_LOG_CONNECT(xbt_sync_os);
586   XBT_LOG_CONNECT(xbt_trp);
587   XBT_LOG_CONNECT(xbt_trp_meas);
588   XBT_LOG_CONNECT(xbt_trp_tcp);
589
590 #ifdef simgrid_EXPORTS
591   /* The following categories are only defined in libsimgrid */
592
593   /* gras (sg) */
594   XBT_LOG_CONNECT(gras_trp_sg);
595
596   /* bindings */
597 #ifdef HAVE_LUA
598   XBT_LOG_CONNECT(bindings);
599   XBT_LOG_CONNECT(lua);
600   XBT_LOG_CONNECT(lua_comm);
601   XBT_LOG_CONNECT(lua_host);
602   XBT_LOG_CONNECT(lua_platf);
603   XBT_LOG_CONNECT(lua_process);
604   XBT_LOG_CONNECT(lua_state_cloner);
605   XBT_LOG_CONNECT(lua_task);
606   XBT_LOG_CONNECT(lua_utils);
607 #endif
608
609   /* instr */
610 #ifdef HAVE_TRACING
611   XBT_LOG_CONNECT(instr);
612   XBT_LOG_CONNECT(instr_api);
613   XBT_LOG_CONNECT(instr_config);
614   XBT_LOG_CONNECT(instr_msg);
615   XBT_LOG_CONNECT(instr_msg_process);
616   XBT_LOG_CONNECT(instr_paje_containers);
617   XBT_LOG_CONNECT(instr_paje_header);
618   XBT_LOG_CONNECT(instr_paje_trace);
619   XBT_LOG_CONNECT(instr_paje_types);
620   XBT_LOG_CONNECT(instr_paje_values);
621   XBT_LOG_CONNECT(instr_resource);
622   XBT_LOG_CONNECT(instr_routing);
623   XBT_LOG_CONNECT(instr_smpi);
624   XBT_LOG_CONNECT(instr_surf);
625 #endif
626
627   /* jedule */
628 #ifdef HAVE_JEDULE
629   XBT_LOG_CONNECT(jedule);
630   XBT_LOG_CONNECT(jed_out);
631   XBT_LOG_CONNECT(jed_sd);
632 #endif
633
634   /* mc */
635 #ifdef HAVE_MC
636   XBT_LOG_CONNECT(mc);
637   XBT_LOG_CONNECT(mc_checkpoint);
638   XBT_LOG_CONNECT(mc_compare);
639   XBT_LOG_CONNECT(mc_dpor);
640   XBT_LOG_CONNECT(mc_global);
641   XBT_LOG_CONNECT(mc_liveness);
642   XBT_LOG_CONNECT(mc_memory);
643   XBT_LOG_CONNECT(mc_memory_map);
644   XBT_LOG_CONNECT(mc_request);
645 #endif
646
647   /* msg */
648   XBT_LOG_CONNECT(msg);
649   XBT_LOG_CONNECT(msg_action);
650   XBT_LOG_CONNECT(msg_gos);
651   XBT_LOG_CONNECT(msg_io);
652   XBT_LOG_CONNECT(msg_kernel);
653   XBT_LOG_CONNECT(msg_mailbox);
654   XBT_LOG_CONNECT(msg_new_API);
655   XBT_LOG_CONNECT(msg_process);
656   XBT_LOG_CONNECT(msg_task);
657   XBT_LOG_CONNECT(msg_vm);
658    
659   /* simdag */
660   XBT_LOG_CONNECT(sd);
661   XBT_LOG_CONNECT(sd_daxparse);
662 #ifdef HAVE_GRAPHVIZ
663   XBT_LOG_CONNECT(sd_dotparse);
664 #endif
665   XBT_LOG_CONNECT(sd_kernel);
666   XBT_LOG_CONNECT(sd_task);
667   XBT_LOG_CONNECT(sd_workstation);
668
669   /* simix */
670   XBT_LOG_CONNECT(simix);
671   XBT_LOG_CONNECT(simix_context);
672   XBT_LOG_CONNECT(simix_deployment);
673   XBT_LOG_CONNECT(simix_environment);
674   XBT_LOG_CONNECT(simix_host);
675   XBT_LOG_CONNECT(simix_io);
676   XBT_LOG_CONNECT(simix_kernel);
677   XBT_LOG_CONNECT(simix_network);
678   XBT_LOG_CONNECT(simix_new_api);
679   XBT_LOG_CONNECT(simix_process);
680   XBT_LOG_CONNECT(simix_smurf);
681   XBT_LOG_CONNECT(simix_synchro);
682
683   /* smpi */
684   /* SMPI categories are connected in smpi_global.c */
685
686   /* surf */
687   XBT_LOG_CONNECT(surf);
688   XBT_LOG_CONNECT(platf_generator);
689   XBT_LOG_CONNECT(random);
690   XBT_LOG_CONNECT(surf_config);
691   XBT_LOG_CONNECT(surf_cpu);
692   XBT_LOG_CONNECT(surf_cpu_ti);
693   XBT_LOG_CONNECT(surf_kernel);
694   XBT_LOG_CONNECT(surf_lagrange);
695   XBT_LOG_CONNECT(surf_lagrange_dichotomy);
696   XBT_LOG_CONNECT(surf_maxmin);
697   XBT_LOG_CONNECT(surf_network);
698   XBT_LOG_CONNECT(surf_new_model);
699 #ifdef HAVE_GTNETS
700   XBT_LOG_CONNECT(surf_network_gtnets);
701   XBT_LOG_CONNECT(surf_network_gtnets_interface);
702   XBT_LOG_CONNECT(surf_network_gtnets_simulator);
703   XBT_LOG_CONNECT(surf_network_gtnets_topology);
704 #endif
705 #ifdef HAVE_NS3
706   XBT_LOG_CONNECT(surf_network_ns3);
707   XBT_LOG_CONNECT(interface_ns3);
708   XBT_LOG_CONNECT(simulator_ns3);
709 #endif
710   XBT_LOG_CONNECT(surf_parse);
711   XBT_LOG_CONNECT(surf_route);
712   XBT_LOG_CONNECT(surf_routing_generic);
713   XBT_LOG_CONNECT(surf_route_cluster);
714   XBT_LOG_CONNECT(surf_route_dijkstra);
715   XBT_LOG_CONNECT(surf_route_floyd);
716   XBT_LOG_CONNECT(surf_route_full);
717   XBT_LOG_CONNECT(surf_route_none);
718   XBT_LOG_CONNECT(surf_route_rulebased);
719   XBT_LOG_CONNECT(surf_route_vivaldi);
720   XBT_LOG_CONNECT(surf_storage);
721   XBT_LOG_CONNECT(surf_trace);
722   XBT_LOG_CONNECT(surf_workstation);
723
724 #endif /* simgrid_EXPORTS */
725 }
726
727 static void xbt_log_help(void);
728 static void xbt_log_help_categories(void);
729
730 /** @brief Get all logging settings from the command line
731  *
732  * xbt_log_control_set() is called on each string we got from cmd line
733  */
734 void xbt_log_init(int *argc, char **argv)
735 {
736   unsigned help_requested = 0;  /* 1: logs; 2: categories */
737   int i, j;
738   char *opt;
739
740   //    _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
741
742   xbt_log_connect_categories();
743
744   /* Set logs and init log submodule */
745   for (j = i = 1; i < *argc; i++) {
746     if (!strncmp(argv[i], "--log=", strlen("--log="))) {
747       opt = strchr(argv[i], '=');
748       opt++;
749       xbt_log_control_set(opt);
750       XBT_DEBUG("Did apply '%s' as log setting", opt);
751     } else if (!strcmp(argv[i], "--help-logs")) {
752       help_requested |= 1;
753     } else if (!strcmp(argv[i], "--help-log-categories")) {
754       help_requested |= 2;
755     } else {
756       argv[j++] = argv[i];
757     }
758   }
759   if (j < *argc) {
760     argv[j] = NULL;
761     *argc = j;
762   }
763
764   if (help_requested) {
765     if (help_requested & 1)
766       xbt_log_help();
767     if (help_requested & 2)
768       xbt_log_help_categories();
769     exit(0);
770   }
771 }
772
773 static void log_cat_exit(xbt_log_category_t cat)
774 {
775   xbt_log_category_t child;
776
777   if (cat->appender) {
778     if (cat->appender->free_)
779       cat->appender->free_(cat->appender);
780     free(cat->appender);
781   }
782   if (cat->layout) {
783     if (cat->layout->free_)
784       cat->layout->free_(cat->layout);
785     free(cat->layout);
786   }
787
788   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
789     log_cat_exit(child);
790 }
791
792 void xbt_log_postexit(void)
793 {
794   XBT_VERB("Exiting log");
795   xbt_os_rmutex_destroy(log_cat_init_mutex);
796   xbt_dynar_free(&xbt_log_settings);
797   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
798 }
799
800  /* Size of the static string in which we  build the log string */
801 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
802 /* Minimum size of the dynamic string in which we build the log string
803    (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
804 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
805
806 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
807 {
808   xbt_log_category_t cat = ev->cat;
809
810   xbt_assert(ev->priority >= 0,
811              "Negative logging priority naturally forbidden");
812   xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
813              "Priority %d is greater than the biggest allowed value",
814              ev->priority);
815
816   do {
817     xbt_log_appender_t appender = cat->appender;
818
819     if (!appender)
820       continue;                 /* No appender, try next */
821
822     xbt_assert(cat->layout,
823                "No valid layout for the appender of category %s", cat->name);
824
825     /* First, try with a static buffer */
826     if (XBT_LOG_STATIC_BUFFER_SIZE) {
827       char buff[XBT_LOG_STATIC_BUFFER_SIZE];
828       int done;
829       ev->buffer = buff;
830       ev->buffer_size = sizeof buff;
831       va_start(ev->ap, fmt);
832       done = cat->layout->do_layout(cat->layout, ev, fmt);
833       va_end(ev->ap);
834       if (done) {
835         appender->do_append(appender, buff);
836         continue;               /* Ok, that worked: go next */
837       }
838     }
839
840     /* The static buffer was too small, use a dynamically expanded one */
841     ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
842     ev->buffer = xbt_malloc(ev->buffer_size);
843     while (1) {
844       int done;
845       va_start(ev->ap, fmt);
846       done = cat->layout->do_layout(cat->layout, ev, fmt);
847       va_end(ev->ap);
848       if (done)
849         break;                  /* Got it */
850       ev->buffer_size *= 2;
851       ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
852     }
853     appender->do_append(appender, ev->buffer);
854     xbt_free(ev->buffer);
855
856   } while (cat->additivity && (cat = cat->parent, 1));
857 }
858
859 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
860 #undef XBT_LOG_STATIC_BUFFER_SIZE
861
862 /* NOTE:
863  *
864  * The standard logging macros use _XBT_LOG_ISENABLED, which calls
865  * _xbt_log_cat_init().  Thus, if we want to avoid an infinite
866  * recursion, we can not use the standard logging macros in
867  * _xbt_log_cat_init(), and in all functions called from it.
868  *
869  * To circumvent the problem, we define the macro_xbt_log_init() as
870  * (0) for the length of the affected functions, and we do not forget
871  * to undefine it at the end!
872  */
873
874 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
875                                    xbt_log_setting_t setting)
876 {
877 #define _xbt_log_cat_init(a, b) (0)
878
879   if (setting->thresh != xbt_log_priority_uninitialized) {
880     xbt_log_threshold_set(category, setting->thresh);
881
882     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
883            category->name, xbt_log_priority_names[category->threshold],
884            category->threshold);
885   }
886
887   if (setting->fmt) {
888     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
889
890     XBT_DEBUG("Apply settings for category '%s': set format to %s",
891            category->name, setting->fmt);
892   }
893
894   if (setting->additivity != -1) {
895     xbt_log_additivity_set(category, setting->additivity);
896
897     XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
898            category->name, (setting->additivity ? "on" : "off"));
899   }
900   if (setting->appender) {
901     xbt_log_appender_set(category, setting->appender);
902     if (!category->layout)
903       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
904     category->additivity = 0;
905     XBT_DEBUG("Set %p as appender of category '%s'",
906            setting->appender, category->name);
907   }
908 #undef _xbt_log_cat_init
909 }
910
911 /*
912  * This gets called the first time a category is referenced and performs the
913  * initialization.
914  * Also resets threshold to inherited!
915  */
916 int _xbt_log_cat_init(xbt_log_category_t category,
917                       e_xbt_log_priority_t priority)
918 {
919 #define _xbt_log_cat_init(a, b) (0)
920
921   if (log_cat_init_mutex != NULL) {
922     xbt_os_rmutex_acquire(log_cat_init_mutex);
923   }
924
925   if (category->initialized) {
926     if (log_cat_init_mutex != NULL) {
927       xbt_os_rmutex_release(log_cat_init_mutex);
928     }
929     return priority >= category->threshold;
930   }
931
932   unsigned int cursor;
933   xbt_log_setting_t setting = NULL;
934   int found = 0;
935
936   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
937          category->name,
938          (category->firstChild ? category->firstChild->name : "none"),
939          (category->nextSibling ? category->nextSibling->name : "none"));
940
941   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
942     category->threshold = xbt_log_priority_info;
943     category->appender = xbt_log_default_appender;
944     category->layout = xbt_log_default_layout;
945   } else {
946
947     if (!category->parent)
948       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
949
950     XBT_DEBUG("Set %s (%s) as father of %s ",
951            category->parent->name,
952            (category->parent->initialized ?
953             xbt_log_priority_names[category->parent->threshold] : "uninited"),
954            category->name);
955     xbt_log_parent_set(category, category->parent);
956
957     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
958       char *buf, *res = NULL;
959       xbt_log_category_t cpp = category->parent->firstChild;
960       while (cpp) {
961         if (res) {
962           buf = bprintf("%s %s", res, cpp->name);
963           free(res);
964           res = buf;
965         } else {
966           res = xbt_strdup(cpp->name);
967         }
968         cpp = cpp->nextSibling;
969       }
970
971       XBT_DEBUG("Children of %s: %s; nextSibling: %s",
972              category->parent->name, res,
973              (category->parent->nextSibling ?
974               category->parent->nextSibling->name : "none"));
975
976       free(res);
977     }
978
979   }
980
981   /* Apply the control */
982   if (xbt_log_settings) {
983     xbt_assert(category, "NULL category");
984     xbt_assert(category->name);
985
986     xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
987       xbt_assert(setting, "Damnit, NULL cat in the list");
988       xbt_assert(setting->catname, "NULL setting(=%p)->catname",
989                  (void *) setting);
990
991       if (!strcmp(setting->catname, category->name)) {
992         found = 1;
993         _xbt_log_cat_apply_set(category, setting);
994         xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
995       }
996     }
997
998     if (!found)
999       XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
1000                 category->name, xbt_log_priority_names[category->threshold],
1001                 category->threshold);
1002   }
1003
1004   category->initialized = 1;
1005   if (log_cat_init_mutex != NULL) {
1006     xbt_os_rmutex_release(log_cat_init_mutex);
1007   }
1008   return priority >= category->threshold;
1009
1010 #undef _xbt_log_cat_init
1011 }
1012
1013 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
1014 {
1015   xbt_assert(cat, "NULL category to be given a parent");
1016   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1017
1018   /* if the category is initialized, unlink from current parent */
1019   if (cat->initialized) {
1020
1021     xbt_log_category_t *cpp = &cat->parent->firstChild;
1022
1023     while (*cpp != cat && *cpp != NULL) {
1024       cpp = &(*cpp)->nextSibling;
1025     }
1026
1027     xbt_assert(*cpp == cat);
1028     *cpp = cat->nextSibling;
1029   }
1030
1031   cat->parent = parent;
1032   cat->nextSibling = parent->firstChild;
1033
1034   parent->firstChild = cat;
1035
1036   if (!parent->initialized)
1037     _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1038
1039   cat->threshold = parent->threshold;
1040
1041   cat->isThreshInherited = 1;
1042 }
1043
1044 static void _set_inherited_thresholds(xbt_log_category_t cat)
1045 {
1046
1047   xbt_log_category_t child = cat->firstChild;
1048
1049   for (; child != NULL; child = child->nextSibling) {
1050     if (child->isThreshInherited) {
1051       if (cat != &_XBT_LOGV(log))
1052         XBT_VERB("Set category threshold of %s to %s (=%d)",
1053               child->name, xbt_log_priority_names[cat->threshold],
1054               cat->threshold);
1055       child->threshold = cat->threshold;
1056       _set_inherited_thresholds(child);
1057     }
1058   }
1059
1060
1061 }
1062
1063 void xbt_log_threshold_set(xbt_log_category_t cat,
1064                            e_xbt_log_priority_t threshold)
1065 {
1066   cat->threshold = threshold;
1067   cat->isThreshInherited = 0;
1068
1069   _set_inherited_thresholds(cat);
1070
1071 }
1072
1073 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1074 {
1075
1076   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1077   const char *name, *dot, *eq;
1078
1079   set->catname = NULL;
1080   set->thresh = xbt_log_priority_uninitialized;
1081   set->fmt = NULL;
1082   set->additivity = -1;
1083   set->appender = NULL;
1084
1085   if (!*control_string)
1086     return set;
1087   XBT_DEBUG("Parse log setting '%s'", control_string);
1088
1089   control_string += strspn(control_string, " ");
1090   name = control_string;
1091   control_string += strcspn(control_string, ".= ");
1092   dot = control_string;
1093   control_string += strcspn(control_string, ":= ");
1094   eq = control_string;
1095   control_string += strcspn(control_string, " ");
1096
1097   xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
1098               "Invalid control string '%s'", control_string);
1099
1100   if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
1101     int i;
1102     char *neweq = xbt_strdup(eq + 1);
1103     char *p = neweq - 1;
1104
1105     while (*(++p) != '\0') {
1106       if (*p >= 'a' && *p <= 'z') {
1107         *p -= 'a' - 'A';
1108       }
1109     }
1110
1111     XBT_DEBUG("New priority name = %s", neweq);
1112     for (i = 0; i < xbt_log_priority_infinite; i++) {
1113       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1114         XBT_DEBUG("This is priority %d", i);
1115         break;
1116       }
1117     }
1118     if (i < xbt_log_priority_infinite) {
1119       set->thresh = (e_xbt_log_priority_t) i;
1120     } else {
1121       THROWF(arg_error, 0,
1122              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1123              eq + 1);
1124     }
1125     free(neweq);
1126   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1127              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1128
1129     char *neweq = xbt_strdup(eq + 1);
1130     char *p = neweq - 1;
1131
1132     while (*(++p) != '\0') {
1133       if (*p >= 'a' && *p <= 'z') {
1134         *p -= 'a' - 'A';
1135       }
1136     }
1137     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1138         || !strcmp(neweq, "1")) {
1139       set->additivity = 1;
1140     } else {
1141       set->additivity = 0;
1142     }
1143     free(neweq);
1144   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1145              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1146
1147     char *neweq = xbt_strdup(eq + 1);
1148
1149     if (!strncmp(neweq, "file:", 5)) {
1150       set->appender = xbt_log_appender_file_new(neweq + 5);
1151     } else {
1152       THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1153     }
1154     free(neweq);
1155   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1156     set->fmt = xbt_strdup(eq + 1);
1157   } else {
1158     char buff[512];
1159     snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1160     THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1161            buff);
1162   }
1163   set->catname = (char *) xbt_malloc(dot - name + 1);
1164
1165   memcpy(set->catname, name, dot - name);
1166   set->catname[dot - name] = '\0';      /* Just in case */
1167   XBT_DEBUG("This is for cat '%s'", set->catname);
1168
1169   return set;
1170 }
1171
1172 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1173                                                  char *name)
1174 {
1175   xbt_log_category_t child, res;
1176
1177   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1178          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1179          (cat->nextSibling ? cat->nextSibling->name : "none"));
1180   if (!strcmp(cat->name, name))
1181     return cat;
1182
1183   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1184     XBT_DEBUG("Dig into %s", child->name);
1185     res = _xbt_log_cat_searchsub(child, name);
1186     if (res)
1187       return res;
1188   }
1189
1190   return NULL;
1191 }
1192
1193 /**
1194  * \ingroup XBT_log
1195  * \param control_string What to parse
1196  *
1197  * Typically passed a command-line argument. The string has the syntax:
1198  *
1199  *      ( [category] "." [keyword] ":" value (" ")... )...
1200  *
1201  * where [category] is one the category names (see \ref XBT_log_cats for
1202  * a complete list of the ones defined in the SimGrid library)
1203  * and keyword is one of the following:
1204  *
1205  *    - thres: category's threshold priority. Possible values:
1206  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1207  *    - add or additivity: whether the logging actions must be passed to
1208  *      the parent category.
1209  *      Possible values: 0, 1, no, yes, on, off.
1210  *      Default value: yes.
1211  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1212  *    - app or appender: the appender to use. See \ref log_use_conf_app for more
1213  *      information.
1214  *
1215  */
1216 void xbt_log_control_set(const char *control_string)
1217 {
1218   xbt_log_setting_t set;
1219
1220   /* To split the string in commands, and the cursors */
1221   xbt_dynar_t set_strings;
1222   char *str;
1223   unsigned int cpt;
1224
1225   if (!control_string)
1226     return;
1227   XBT_DEBUG("Parse log settings '%s'", control_string);
1228
1229   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1230   if (!strcmp(control_string, "no_loc")) {
1231     xbt_log_no_loc = 1;
1232     return;
1233   }
1234   /* some initialization if this is the first time that this get called */
1235   if (xbt_log_settings == NULL)
1236     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1237                                      _free_setting);
1238
1239   /* split the string, and remove empty entries */
1240   set_strings = xbt_str_split_quoted(control_string);
1241
1242   if (xbt_dynar_is_empty(set_strings)) {     /* vicious user! */
1243     xbt_dynar_free(&set_strings);
1244     return;
1245   }
1246
1247   /* Parse each entry and either use it right now (if the category was already
1248      created), or store it for further use */
1249   xbt_dynar_foreach(set_strings, cpt, str) {
1250     xbt_log_category_t cat = NULL;
1251
1252     set = _xbt_log_parse_setting(str);
1253     cat =
1254         _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1255
1256     if (cat) {
1257       XBT_DEBUG("Apply directly");
1258       _xbt_log_cat_apply_set(cat, set);
1259       _free_setting((void *) &set);
1260     } else {
1261
1262       XBT_DEBUG("Store for further application");
1263       XBT_DEBUG("push %p to the settings", (void *) set);
1264       xbt_dynar_push(xbt_log_settings, &set);
1265     }
1266   }
1267   xbt_dynar_free(&set_strings);
1268 }
1269
1270 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1271 {
1272   if (cat->appender) {
1273     if (cat->appender->free_)
1274       cat->appender->free_(cat->appender);
1275     free(cat->appender);
1276   }
1277   cat->appender = app;
1278 }
1279
1280 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1281 {
1282 #define _xbt_log_cat_init(a, b) (0)
1283   if (!cat->appender) {
1284     XBT_VERB
1285         ("No appender to category %s. Setting the file appender as default",
1286          cat->name);
1287     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1288   }
1289   if (cat->layout) {
1290     if (cat->layout->free_) {
1291       cat->layout->free_(cat->layout);
1292     }
1293     free(cat->layout);
1294   }
1295   cat->layout = lay;
1296   xbt_log_additivity_set(cat, 0);
1297 #undef _xbt_log_cat_init
1298 }
1299
1300 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1301 {
1302   cat->additivity = additivity;
1303 }
1304
1305 static void xbt_log_help(void)
1306 {
1307   printf(
1308 "Description of the logging output:\n"
1309 "\n"
1310 "   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1311 "      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1312 "      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1313 "         -> trace: enter and return of some functions\n"
1314 "         -> debug: crufty output\n"
1315 "         -> verbose: verbose output for the user wanting more\n"
1316 "         -> info: output about the regular functionning\n"
1317 "         -> warning: minor issue encountered\n"
1318 "         -> error: issue encountered\n"
1319 "         -> critical: major issue encountered\n"
1320 "\n"
1321 "   Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1322 "      OPTIONS may be:\n"
1323 "         -> %%%%: the %% char\n"
1324 "         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1325 "         -> %%e: plain old space (SimGrid extension)\n"
1326 "\n"
1327 "         -> %%m: user-provided message\n"
1328 "\n"
1329 "         -> %%c: Category name (LOG4J compatible)\n"
1330 "         -> %%p: Priority name (LOG4J compatible)\n"
1331 "\n"
1332 "         -> %%h: Hostname (SimGrid extension)\n"
1333 "         -> %%P: Process name (SimGrid extension)\n"
1334 "         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1335 "         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1336 "\n"
1337 "         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1338 "         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1339 "         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1340 "         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1341 "                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1342 "\n"
1343 "         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1344 "                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1345 "         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1346 "\n"
1347 "         -> %%d: date (UNIX-like epoch)\n"
1348 "         -> %%r: application age (time elapsed since the beginning of the application)\n"
1349 "\n"
1350 "   Miscellaneous:\n"
1351 "      --help-log-categories    Display the current hierarchy of log categories.\n"
1352 "      --log=no_loc             Don't print file names in messages (for tesh tests).\n"
1353 "\n"
1354     );
1355 }
1356
1357 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1358 {
1359   xbt_log_category_t a = *(xbt_log_category_t *)pa;
1360   xbt_log_category_t b = *(xbt_log_category_t *)pb;
1361   return strcmp(a->name, b->name);
1362 }
1363
1364 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1365                                         const char *prefix)
1366 {
1367   char *this_prefix;
1368   char *child_prefix;
1369   xbt_dynar_t dynar;
1370   unsigned i;
1371   xbt_log_category_t cat;
1372
1373   if (!category)
1374     return;
1375
1376   if (category->parent) {
1377     this_prefix = bprintf("%s \\_ ", prefix);
1378     child_prefix = bprintf("%s |  ", prefix);
1379   } else {
1380     this_prefix = bprintf("%s", prefix);
1381     child_prefix = bprintf("%s", prefix);
1382   }
1383
1384   dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1385   for (cat = category ; cat != NULL; cat = cat->nextSibling)
1386     xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1387
1388   xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1389
1390   for (i = 0; i < xbt_dynar_length(dynar); i++) {
1391     if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1392       *strrchr(child_prefix, '|') = ' ';
1393     cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1394     printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1395     xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1396   }
1397
1398   xbt_dynar_free(&dynar);
1399   xbt_free(this_prefix);
1400   xbt_free(child_prefix);
1401 }
1402
1403 static void xbt_log_help_categories(void)
1404 {
1405   printf("Current log category hierarchy:\n");
1406   xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), "   ");
1407   printf("\n");
1408 }