Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
d712637542d67913e3cc0dde1c3497643bbd9268
[simgrid.git] / src / xbt / log.c
1 /* log - a generic logging facility in the spirit of log4j                  */
2
3 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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
26 XBT_PUBLIC_DATA(int) (*xbt_pid) ();
27 int xbt_log_no_loc = 0;         /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
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 GRAS 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, only two appenders exist: the default one prints
108 stuff on stderr while it is possible to create appenders printing to a specific
109 file.
110
111 Other are planed (such as the one sending everything to a remote server,
112 or the one using only a fixed amount of lines in a file, and rotating content on
113 need). One day, for sure ;)
114
115 \subsection log_lay 1.4 Message layouts
116
117 The message layouts are the elements in charge of choosing how each message
118 will look like. Their result is a string which is then passed to the appender
119 attached to the category to be displayed.
120
121 For now, there is two layouts: The simple one, which is good for most cases,
122 and another one allowing users to specify the format they want.
123 \ref log_use_conf provides more info on this.
124
125 \subsection log_hist 1.5 History of this module
126
127 Historically, this module is an adaptation of the log4c project, which is dead
128 upstream, and which I was given the permission to fork under the LGPL licence
129 by the log4c's authors. The log4c project itself was loosely based on the
130 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
131 differs somehow from these projects anyway, because the C programming language
132 is not object oriented.
133
134 \section log_API 2. Programmer interface
135
136 \subsection log_API_cat 2.1 Constructing the category hierarchy
137
138 Every category is declared by providing a name and an optional
139 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
140 the category's parent.
141
142 A category is created by a macro call at the top level of a file.  A
143 category can be created with any one of the following macros:
144
145  - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
146  - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
147     Create a new category being child of the category ParentCat
148  - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
149     Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
150       in this file
151  -  \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
152     Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
153       in this file
154
155 The parent cat can be defined in the same file or in another file (in
156 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
157 it visible in the current file), but each category may have only one
158 definition. Likewise, you can use a category defined in another file as 
159 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
160
161 Typically, there will be a Category for each module and sub-module, so you
162 can independently control logging for each module.
163
164 For a list of all existing categories, please refer to the \ref XBT_log_cats
165 section. This file is generated automatically from the SimGrid source code, so
166 it should be complete and accurate.
167
168 \section log_API_pri 2.2 Declaring message priority
169
170 A category may be assigned a threshold priority. The set of priorities are
171 defined by the \ref e_xbt_log_priority_t enum. All logging request under
172 this priority will be discarded.
173
174 If a given category is not assigned a threshold priority, then it inherits
175 one from its closest ancestor with an assigned threshold. To ensure that all
176 categories can eventually inherit a threshold, the root category always has
177 an assigned threshold priority.
178
179 Logging requests are made by invoking a logging macro on a category.  All of
180 the macros have a printf-style format string followed by arguments. If you
181 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
182 when you pass a pointer to a string where an integer was specified by the
183 format. This is usually a good idea.
184
185 Here is an example of the most basic type of macro. This is a logging
186 request with priority <i>warning</i>.
187
188 <code>XBT_CLOG(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
189 "oops");</code>
190
191 A logging request is said to be enabled if its priority is higher than or
192 equal to the threshold priority of its category. Otherwise, the request is
193 said to be disabled. A category without an assigned priority will inherit
194 one from the hierarchy.
195
196 It is possible to use any non-negative integer as a priority. If, as in the
197 example, one of the standard priorities is used, then there is a convenience
198 macro that is typically used instead. For example, the above example is
199 equivalent to the shorter:
200
201 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
202
203 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
204
205 It is sometimes useful to check whether a particular category is
206 enabled at a particular priority. One example is when you want to do
207 some extra computation to prepare a nice debugging message. There is
208 no use of doing so if the message won't be used afterward because
209 debugging is turned off.
210
211 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
212
213 \section log_API_subcat 2.4 Using a default category (the easy interface)
214
215 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
216 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
217 category, then the even shorter form can be used:
218
219 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
220
221 Only one default category can be created per file, though multiple
222 non-defaults can be created and used.
223
224 \section log_API_easy 2.5 Putting all together: the easy interface
225
226 First of all, each module should register its own category into the categories
227 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
228
229 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
230 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
231
232 Under GCC, these macro check there arguments the same way than printf does. So,
233 if you compile with -Wall, the following code will issue a warning:
234 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
235
236 If you want to specify the category to log onto (for example because you
237 have more than one category per file, add a C before the name of the log
238 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
239 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
240 first argument.
241
242 The TRACE priority is not used the same way than the other. You should use
243 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
244
245 \section log_API_example 2.6 Example of use
246
247 Here is a more complete example:
248
249 \verbatim
250 #include "xbt/log.h"
251
252 / * create a category and a default subcategory * /
253 XBT_LOG_NEW_CATEGORY(VSS);
254 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
255
256 int main() {
257        / * Now set the parent's priority.  (the string would typcially be a runtime option) * /
258        xbt_log_control_set("SA.thresh:3");
259
260        / * This request is enabled, because WARNING >= INFO. * /
261        XBT_CWARN(VSS, "Low fuel level.");
262
263        / * This request is disabled, because DEBUG < INFO. * /
264        XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
265
266        / * The default category SA inherits its priority from VSS. Thus,
267           the following request is enabled because INFO >= INFO.  * /
268        XBT_INFO("Located nearest gas station.");
269
270        / * This request is disabled, because DEBUG < INFO. * /
271        XBT_DEBUG("Exiting gas station search");
272 }
273 \endverbatim
274
275 Another example can be found in the relevant part of the GRAS tutorial:
276 \ref GRAS_tut_tour_logs.
277
278 \section log_user 3. User interface
279
280 \section log_use_conf 3.1 Configuration
281
282 Although rarely done, it is possible to configure the logs during
283 program initialization by invoking the xbt_log_control_set() method
284 manually. A more conventional way is to use the --log command line
285 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
286 checks and deals properly with such arguments.
287
288 The following command line arguments exist, but are deprecated and
289 may disappear in the future: --xbt-log, --gras-log, --msg-log and
290 --surf-log.
291
292 \subsection log_use_conf_thres 3.1.1 Threshold configuration
293
294 The most common setting is to control which logging event will get
295 displayed by setting a threshold to each category through the
296 <tt>thres</tt> keyword.
297
298 For example, \verbatim --log=root.thres:debug\endverbatim will make
299 SimGrid <b>extremely</b> verbose while \verbatim
300 --log=root.thres:critical\endverbatim should shut it almost
301 completely off. The full list of recognized thresholds is the following:
302
303  - trace: enter and return of some functions
304  - debug: crufty output
305  - verbose: verbose output for the user wanting more
306  - info: output about the regular functionning
307  - warning: minor issue encountered
308  - error: issue encountered
309  - critical: major issue encountered 
310
311 \subsection log_use_conf_multi 3.1.2 Passing several settings
312
313 You can provide several of those arguments to change the setting of several
314 categories, they will be applied from left to right. So,
315 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
316 disable almost any logging.
317
318 Note that the quotes on above line are mandatory because there is a space in
319 the argument, so we are protecting ourselves from the shell, not from SimGrid.
320 We could also reach the same effect with this:
321 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
322
323 \subsection log_use_conf_fmt 3.1.3 Format configuration
324
325 As with SimGrid 3.3, it is possible to control the format of log
326 messages. This is done through the <tt>fmt</tt> keyword. For example,
327 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
328 user-message only, removing any decoration such as the date, or the
329 process ID, everything.
330
331 Here are the existing format directives:
332
333  - %%: the % char
334  - %%n: platform-dependent line separator (LOG4J compatible)
335  - %%e: plain old space (SimGrid extension)
336
337  - %%m: user-provided message
338
339  - %%c: Category name (LOG4J compatible)
340  - %%p: Priority name (LOG4J compatible)
341
342  - %%h: Hostname (SimGrid extension)
343  - %%P: Process name (SimGrid extension)
344  - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
345  - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
346
347  - %%F: file name where the log event was raised (LOG4J compatible)
348  - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
349  - %%L: line number where the log event was raised (LOG4J compatible)
350  - %%M: function name (LOG4J compatible -- called method name here of course).
351    Defined only when using gcc because there is no __FUNCTION__ elsewhere.
352
353  - %%b: full backtrace (Called %%throwable in LOG4J).
354    Defined only under windows or when using the GNU libc because backtrace() is not defined
355    elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
356  - %%B: short backtrace (only the first line of the %%b).
357    Called %%throwable{short} in LOG4J; defined where %%b is.
358
359  - %%d: date (UNIX-like epoch)
360  - %%r: application age (time elapsed since the beginning of the application)
361
362
363 If you want to mimic the simple layout with the format one, you would use this
364 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
365 because the simple layout do not display the message location for messages at
366 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
367 case). Moreover, if there is no process name (ie, messages coming from the
368 library itself, or test programs doing strange things) do not display the
369 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
370 [%%c/%%p] %%m%%n' if they are at priority INFO).
371
372 For now, there is only two format modifiers: the precision and the
373 width fields. You can for example specify %.4r to get the application
374 age with 4 numbers after the radix, or %15p to get the process name
375 on 15 columns. Finally, you can specify %10.6r to get the time on at
376 most 10 columns, with 6 numbers after the radix. 
377
378 Note that when specifying the width, it is filled with spaces. That
379 is to say that for example %5r in your format is converted to "% 5f"
380 for printf (note the extra space); there is no way to fill the empty
381 columns with 0 (ie, pass "%05f" to printf). Another limitation is
382 that you cannot set specific layouts to the several priorities.
383
384 \subsection log_use_conf_app 3.1.4 Category appender
385
386 As with SimGrid 3.3, it is possible to control the appender of log
387 messages. This is done through the <tt>app</tt> keyword. For example,
388 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
389 to the file mylogfile.
390
391 Any appender setup this way have its own layout format (simple one by default),
392 so you may have to change it too afterward. Moreover, the additivity of the log category
393 is also set to false to prevent log event displayed by this appender to "leak" to any other
394 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
395 manually.
396
397 \subsection log_use_conf_add 3.1.5 Category additivity
398
399 The <tt>add</tt> keyword allows to specify the additivity of a
400 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
401 and 'off' are all valid values, with 'yes' as default.
402
403 The following example resets the additivity of the xbt category to true (which is its default value).
404 \verbatim --log=xbt.add:yes\endverbatim
405
406 \section log_use_misc 3.2 Misc and Caveats
407
408   - Do not use any of the macros that start with '_'.
409   - Log4J has a 'rolling file appender' which you can select with a run-time
410     option and specify the max file size. This would be a nice default for
411     non-kernel applications.
412   - Careful, category names are global variables.
413
414 \section log_internals 4. Internal considerations
415
416 This module is a mess of macro black magic, and when it goes wrong,
417 SimGrid studently loose its ability to explain its problems. When
418 messing around this module, I often find useful to define
419 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
420 of finding what's going wrong. But things are quite verbose when
421 everything is enabled...
422
423 \section log_in_perf 4.1 Performance
424
425 Except for the first invocation of a given category, a disabled logging request
426 requires an a single comparison of a static variable to a constant.
427
428 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
429 causes all logging requests with a lower priority to be optimized to 0 cost
430 by the compiler. By setting it to gras_log_priority_infinite, all logging
431 requests are statically disabled at compile time and cost nothing. Released executables
432 <i>might</i>  be compiled with (note that it will prevent users to debug their problems)
433 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
434
435 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
436 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
437 the requests of priority below INFO.
438
439 \todo Logging performance *may* be improved further by improving the message
440 propagation from appender to appender in the category tree.
441
442 \section log_in_app 4.2 Appenders
443
444 Each category has an optional appender. An appender is a pointer to a
445 structure which starts with a pointer to a do_append() function. do_append()
446 prints a message to a log.
447
448 When a category is passed a message by one of the logging macros, the
449 category performs the following actions:
450
451   - if the category has an appender, the message is passed to the
452     appender's do_append() function,
453   - if additivity is true for the category, the message is passed to
454     the category's parent. Additivity is true by default, and can be
455     controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
456     Also, when you add an appender to a category, its additivity is automatically turned to off.
457     Turn it back on afterward if it is not what you wanted.
458
459 By default, only the root category have an appender, and any other category has
460 its additivity set to true. This causes all messages to be logged by the root
461 category's appender.
462
463 The default appender function currently prints to stderr, and the only other
464 existing one writes to the specified file. More would be needed, like the one
465 able to send the logs to a remote dedicated server.
466 This is on our TODO list for quite a while now, but your help would be
467 welcome here, too. */
468
469 xbt_log_appender_t xbt_log_default_appender = NULL;     /* set in log_init */
470 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
471
472 typedef struct {
473   char *catname;
474   e_xbt_log_priority_t thresh;
475   char *fmt;
476   int additivity;
477   xbt_log_appender_t appender;
478 } s_xbt_log_setting_t, *xbt_log_setting_t;
479
480 static xbt_dynar_t xbt_log_settings = NULL;
481
482 static void _free_setting(void *s)
483 {
484   xbt_log_setting_t set = *(xbt_log_setting_t *) s;
485   if (set) {
486     free(set->catname);
487     if (set->fmt)
488       free(set->fmt);
489     free(set);
490   }
491 }
492
493 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
494                                    xbt_log_setting_t setting);
495
496 const char *xbt_log_priority_names[8] = {
497   "NONE",
498   "TRACE",
499   "DEBUG",
500   "VERBOSE",
501   "INFO",
502   "WARNING",
503   "ERROR",
504   "CRITICAL"
505 };
506
507 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
508   NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
509       "root", xbt_log_priority_uninitialized /* threshold */ ,
510       0 /* isThreshInherited */ ,
511       NULL /* appender */ , NULL /* layout */ ,
512       0                         /* additivity */
513 };
514
515 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
516 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
517 XBT_LOG_NEW_CATEGORY(msg, "All MSG categories");
518 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
519 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
520 XBT_LOG_NEW_CATEGORY(bindings, "All bindings categories");
521
522 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
523                                 "Loggings from the logging mechanism itself");
524
525 /* create the default appender and install it in the root category,
526    which were already created (damnit. Too slow little beetle) */
527 void xbt_log_preinit(void)
528 {
529   xbt_log_default_appender = xbt_log_appender_file_new(NULL);
530   xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
531   _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
532   _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
533 }
534
535 /** @brief Get all logging settings from the command line
536  *
537  * xbt_log_control_set() is called on each string we got from cmd line
538  */
539 void xbt_log_init(int *argc, char **argv)
540 {
541   int i, j;
542   char *opt;
543
544   //    _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
545
546   /* Set logs and init log submodule */
547   for (i = 1; i < *argc; i++) {
548     if (!strncmp(argv[i], "--log=", strlen("--log=")) ||
549         !strncmp(argv[i], "--gras-log=", strlen("--gras-log=")) ||
550         !strncmp(argv[i], "--surf-log=", strlen("--surf-log=")) ||
551         !strncmp(argv[i], "--msg-log=", strlen("--msg-log=")) ||
552         !strncmp(argv[i], "--simix-log=", strlen("--simix-log=")) ||
553         !strncmp(argv[i], "--xbt-log=", strlen("--xbt-log="))) {
554
555       if (strncmp(argv[i], "--log=", strlen("--log=")))
556         XBT_WARN
557             ("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
558              (int) (strchr(argv[i], '=') - argv[i]), argv[i]);
559
560       opt = strchr(argv[i], '=');
561       opt++;
562       xbt_log_control_set(opt);
563       XBT_DEBUG("Did apply '%s' as log setting", opt);
564       /*remove this from argv */
565
566       for (j = i + 1; j < *argc; j++) {
567         argv[j - 1] = argv[j];
568       }
569
570       argv[j - 1] = NULL;
571       (*argc)--;
572       i--;                      /* compensate effect of next loop incrementation */
573     }
574   }
575 }
576
577 static void log_cat_exit(xbt_log_category_t cat)
578 {
579   xbt_log_category_t child;
580
581   if (cat->appender) {
582     if (cat->appender->free_)
583       cat->appender->free_(cat->appender);
584     free(cat->appender);
585   }
586   if (cat->layout) {
587     if (cat->layout->free_)
588       cat->layout->free_(cat->layout);
589     free(cat->layout);
590   }
591
592   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
593     log_cat_exit(child);
594 }
595
596 void xbt_log_postexit(void)
597 {
598   XBT_VERB("Exiting log");
599   xbt_dynar_free(&xbt_log_settings);
600   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
601 }
602
603 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
604 {
605
606   xbt_log_category_t cat = ev->cat;
607
608   va_start(ev->ap, fmt);
609   va_start(ev->ap_copy, fmt);
610   while (1) {
611     xbt_log_appender_t appender = cat->appender;
612     if (appender != NULL) {
613       xbt_assert(cat->layout,
614                   "No valid layout for the appender of category %s",
615                   cat->name);
616       cat->layout->do_layout(cat->layout, ev, fmt, appender);
617     }
618     if (!cat->additivity)
619       break;
620
621     cat = cat->parent;
622   }
623   va_end(ev->ap);
624   va_end(ev->ap_copy);
625
626 #ifdef _XBT_WIN32
627   free(ev->buffer);
628 #endif
629 }
630
631 /* NOTE:
632  *
633  * The standard logging macros use _XBT_LOG_ISENABLED, which calls
634  * _xbt_log_cat_init().  Thus, if we want to avoid an infinite
635  * recursion, we can not use the standard logging macros in
636  * _xbt_log_cat_init(), and in all functions called from it.
637  *
638  * To circumvent the problem, we define the macro_xbt_log_init() as
639  * (0) for the length of the affected functions, and we do not forget
640  * to undefine it at the end!
641  */
642
643 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
644                                    xbt_log_setting_t setting)
645 {
646 #define _xbt_log_cat_init(a, b) (0)
647
648   if (setting->thresh != xbt_log_priority_uninitialized) {
649     xbt_log_threshold_set(category, setting->thresh);
650
651     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
652            category->name, xbt_log_priority_names[category->threshold],
653            category->threshold);
654   }
655
656   if (setting->fmt) {
657     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
658
659     XBT_DEBUG("Apply settings for category '%s': set format to %s",
660            category->name, setting->fmt);
661   }
662
663   if (setting->additivity != -1) {
664     xbt_log_additivity_set(category, setting->additivity);
665
666     XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
667            category->name, (setting->additivity ? "on" : "off"));
668   }
669   if (setting->appender) {
670     xbt_log_appender_set(category, setting->appender);
671     if (!category->layout)
672       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
673     category->additivity = 0;
674     XBT_DEBUG("Set %p as appender of category '%s'",
675            setting->appender, category->name);
676   }
677 #undef _xbt_log_cat_init
678 }
679
680 /*
681  * This gets called the first time a category is referenced and performs the
682  * initialization.
683  * Also resets threshold to inherited!
684  */
685 int _xbt_log_cat_init(xbt_log_category_t category,
686                       e_xbt_log_priority_t priority)
687 {
688 #define _xbt_log_cat_init(a, b) (0)
689
690   unsigned int cursor;
691   xbt_log_setting_t setting = NULL;
692   int found = 0;
693
694   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
695          category->name,
696          (category->firstChild ? category->firstChild->name : "none"),
697          (category->nextSibling ? category->nextSibling->name : "none"));
698
699   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
700     category->threshold = xbt_log_priority_info;
701     /* xbt_log_priority_debug */ ;
702     category->appender = xbt_log_default_appender;
703     category->layout = xbt_log_default_layout;
704   } else {
705
706     if (!category->parent)
707       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
708
709     XBT_DEBUG("Set %s (%s) as father of %s ",
710            category->parent->name,
711            (category->parent->threshold == xbt_log_priority_uninitialized ?
712             "uninited" : xbt_log_priority_names[category->
713                                                 parent->threshold]),
714            category->name);
715     xbt_log_parent_set(category, category->parent);
716
717     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
718       char *buf, *res = NULL;
719       xbt_log_category_t cpp = category->parent->firstChild;
720       while (cpp) {
721         if (res) {
722           buf = bprintf("%s %s", res, cpp->name);
723           free(res);
724           res = buf;
725         } else {
726           res = xbt_strdup(cpp->name);
727         }
728         cpp = cpp->nextSibling;
729       }
730
731       XBT_DEBUG("Childs of %s: %s; nextSibling: %s",
732              category->parent->name, res,
733              (category->parent->nextSibling ?
734               category->parent->nextSibling->name : "none"));
735
736       free(res);
737     }
738
739   }
740
741   /* Apply the control */
742   if (!xbt_log_settings)
743     return priority >= category->threshold;
744
745   xbt_assert(category, "NULL category");
746   xbt_assert(category->name);
747
748   xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
749     xbt_assert(setting, "Damnit, NULL cat in the list");
750     xbt_assert(setting->catname, "NULL setting(=%p)->catname",
751                 (void *) setting);
752
753     if (!strcmp(setting->catname, category->name)) {
754
755       found = 1;
756
757       _xbt_log_cat_apply_set(category, setting);
758
759       xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
760     }
761   }
762
763   if (!found)
764     XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
765            category->name, xbt_log_priority_names[category->threshold],
766            category->threshold);
767
768   return priority >= category->threshold;
769
770 #undef _xbt_log_cat_init
771 }
772
773 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
774 {
775
776   xbt_assert(cat, "NULL category to be given a parent");
777   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
778
779   /*
780    * if the threshold is initialized
781    * unlink from current parent
782    */
783   if (cat->threshold != xbt_log_priority_uninitialized) {
784
785     xbt_log_category_t *cpp = &parent->firstChild;
786
787     while (*cpp != cat && *cpp != NULL) {
788       cpp = &(*cpp)->nextSibling;
789     }
790
791     xbt_assert(*cpp == cat);
792     *cpp = cat->nextSibling;
793   }
794
795   cat->parent = parent;
796   cat->nextSibling = parent->firstChild;
797
798   parent->firstChild = cat;
799
800   if (parent->threshold == xbt_log_priority_uninitialized) {
801
802     _xbt_log_cat_init(parent,
803                       xbt_log_priority_uninitialized /* ignored */ );
804   }
805
806   cat->threshold = parent->threshold;
807
808   cat->isThreshInherited = 1;
809
810 }
811
812 static void _set_inherited_thresholds(xbt_log_category_t cat)
813 {
814
815   xbt_log_category_t child = cat->firstChild;
816
817   for (; child != NULL; child = child->nextSibling) {
818     if (child->isThreshInherited) {
819       if (cat != &_XBT_LOGV(log))
820         XBT_VERB("Set category threshold of %s to %s (=%d)",
821               child->name, xbt_log_priority_names[cat->threshold],
822               cat->threshold);
823       child->threshold = cat->threshold;
824       _set_inherited_thresholds(child);
825     }
826   }
827
828
829 }
830
831 void xbt_log_threshold_set(xbt_log_category_t cat,
832                            e_xbt_log_priority_t threshold)
833 {
834   cat->threshold = threshold;
835   cat->isThreshInherited = 0;
836
837   _set_inherited_thresholds(cat);
838
839 }
840
841 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
842 {
843
844   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
845   const char *name, *dot, *eq;
846
847   set->catname = NULL;
848   set->thresh = xbt_log_priority_uninitialized;
849   set->fmt = NULL;
850   set->additivity = -1;
851   set->appender = NULL;
852
853   if (!*control_string)
854     return set;
855   XBT_DEBUG("Parse log setting '%s'", control_string);
856
857   control_string += strspn(control_string, " ");
858   name = control_string;
859   control_string += strcspn(control_string, ".= ");
860   dot = control_string;
861   control_string += strcspn(control_string, ":= ");
862   eq = control_string;
863   control_string += strcspn(control_string, " ");
864
865   xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
866               "Invalid control string '%s'", control_string);
867
868   if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
869     int i;
870     char *neweq = xbt_strdup(eq + 1);
871     char *p = neweq - 1;
872
873     while (*(++p) != '\0') {
874       if (*p >= 'a' && *p <= 'z') {
875         *p -= 'a' - 'A';
876       }
877     }
878
879     XBT_DEBUG("New priority name = %s", neweq);
880     for (i = 0; i < xbt_log_priority_infinite; i++) {
881       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
882         XBT_DEBUG("This is priority %d", i);
883         break;
884       }
885     }
886     if (i < xbt_log_priority_infinite) {
887       set->thresh = (e_xbt_log_priority_t) i;
888     } else {
889       THROWF(arg_error, 0,
890              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
891              eq + 1);
892     }
893     free(neweq);
894   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
895              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
896
897     char *neweq = xbt_strdup(eq + 1);
898     char *p = neweq - 1;
899
900     while (*(++p) != '\0') {
901       if (*p >= 'a' && *p <= 'z') {
902         *p -= 'a' - 'A';
903       }
904     }
905     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
906         || !strcmp(neweq, "1")) {
907       set->additivity = 1;
908     } else {
909       set->additivity = 0;
910     }
911     free(neweq);
912   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
913              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
914
915     char *neweq = xbt_strdup(eq + 1);
916
917     if (!strncmp(neweq, "file:", 5)) {
918       set->appender = xbt_log_appender_file_new(neweq + 5);
919     } else {
920       THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
921     }
922     free(neweq);
923   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
924     set->fmt = xbt_strdup(eq + 1);
925   } else {
926     char buff[512];
927     snprintf(buff, min(512, eq - dot), "%s", dot + 1);
928     THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
929            buff);
930   }
931   set->catname = (char *) xbt_malloc(dot - name + 1);
932
933   memcpy(set->catname, name, dot - name);
934   set->catname[dot - name] = '\0';      /* Just in case */
935   XBT_DEBUG("This is for cat '%s'", set->catname);
936
937   return set;
938 }
939
940 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
941                                                  char *name)
942 {
943   xbt_log_category_t child, res;
944
945   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
946          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
947          (cat->nextSibling ? cat->nextSibling->name : "none"));
948   if (!strcmp(cat->name, name))
949     return cat;
950
951   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
952     XBT_DEBUG("Dig into %s", child->name);
953     res = _xbt_log_cat_searchsub(child, name);
954     if (res)
955       return res;
956   }
957
958   return NULL;
959 }
960
961 /**
962  * \ingroup XBT_log
963  * \param control_string What to parse
964  *
965  * Typically passed a command-line argument. The string has the syntax:
966  *
967  *      ( [category] "." [keyword] ":" value (" ")... )...
968  *
969  * where [category] is one the category names (see \ref XBT_log_cats for
970  * a complete list of the ones defined in the SimGrid library)
971  * and keyword is one of the following:
972  *
973  *    - thres: category's threshold priority. Possible values:
974  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
975  *    - add or additivity: whether the logging actions must be passed to
976  *      the parent category.
977  *      Possible values: 0, 1, no, yes, on, off.
978  *      Default value: yes.
979  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
980  *    - app or appender: the appender to use. See \ref log_use_conf_app for more
981  *      information.
982  *
983  */
984 void xbt_log_control_set(const char *control_string)
985 {
986   xbt_log_setting_t set;
987
988   /* To split the string in commands, and the cursors */
989   xbt_dynar_t set_strings;
990   char *str;
991   unsigned int cpt;
992
993   if (!control_string)
994     return;
995   XBT_DEBUG("Parse log settings '%s'", control_string);
996
997   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
998   if (!strcmp(control_string, "no_loc")) {
999     xbt_log_no_loc = 1;
1000     return;
1001   }
1002   /* some initialization if this is the first time that this get called */
1003   if (xbt_log_settings == NULL)
1004     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1005                                      _free_setting);
1006
1007   /* split the string, and remove empty entries */
1008   set_strings = xbt_str_split_quoted(control_string);
1009
1010   if (xbt_dynar_length(set_strings) == 0) {     /* vicious user! */
1011     xbt_dynar_free(&set_strings);
1012     return;
1013   }
1014
1015   /* Parse each entry and either use it right now (if the category was already
1016      created), or store it for further use */
1017   xbt_dynar_foreach(set_strings, cpt, str) {
1018     xbt_log_category_t cat = NULL;
1019
1020     set = _xbt_log_parse_setting(str);
1021     cat =
1022         _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1023
1024     if (cat) {
1025       XBT_DEBUG("Apply directly");
1026       _xbt_log_cat_apply_set(cat, set);
1027       _free_setting((void *) &set);
1028     } else {
1029
1030       XBT_DEBUG("Store for further application");
1031       XBT_DEBUG("push %p to the settings", (void *) set);
1032       xbt_dynar_push(xbt_log_settings, &set);
1033     }
1034   }
1035   xbt_dynar_free(&set_strings);
1036 }
1037
1038 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1039 {
1040   if (cat->appender) {
1041     if (cat->appender->free_)
1042       cat->appender->free_(cat->appender);
1043     free(cat->appender);
1044   }
1045   cat->appender = app;
1046 }
1047
1048 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1049 {
1050 #define _xbt_log_cat_init(a, b) (0)
1051   if (!cat->appender) {
1052     XBT_VERB
1053         ("No appender to category %s. Setting the file appender as default",
1054          cat->name);
1055     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1056   }
1057   if (cat->layout) {
1058     if (cat->layout->free_) {
1059       cat->layout->free_(cat->layout);
1060     }
1061     free(cat->layout);
1062   }
1063   cat->layout = lay;
1064   xbt_log_additivity_set(cat, 0);
1065 #undef _xbt_log_cat_init
1066 }
1067
1068 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1069 {
1070   cat->additivity = additivity;
1071 }