Logo AND Algorithmique Numérique Distribuée

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