Logo AND Algorithmique Numérique Distribuée

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