Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Implement the field width in log formats
[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] [%%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 two format modifiers: the precision and the
376 width fields. You can for example specify %.4r to get the application
377 age with 4 numbers after the radix, or %15p to get the process name
378 on 15 columns. Finally, you can specify %10.6r to get the time on at
379 most 10 columns, with 6 numbers after the radix. 
380
381 Note that when specifying the width, it is filled with spaces. That
382 is to say that for example %5r in your format is converted to "% 5f"
383 for printf (note the extra space); there is no way to fill the empty
384 columns with 0 (ie, pass "%05f" to printf). Another limitation is
385 that you cannot set specific layouts to the several priorities.
386
387 \subsection log_use_conf_app 3.1.4 Category appender
388
389 As with SimGrid 3.3, it is possible to control the appender of log
390 messages. This is done through the <tt>app</tt> keyword. For example,
391 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
392 to the file mylogfile.
393
394 Any appender setup this way have its own layout format (simple one by default),
395 so you may have to change it too afterward. Moreover, the additivity of the log category
396 is also set to false to prevent log event displayed by this appender to "leak" to any other
397 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
398 manually.
399
400 \subsection log_use_conf_add 3.1.5 Category additivity
401
402 The <tt>add</tt> keyword allows to specify the additivity of a
403 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
404 and 'off' are all valid values, with 'yes' as default.
405
406 The following example resets the additivity of the xbt category to true (which is its default value).
407 \verbatim --log=xbt.add:yes\endverbatim
408
409 \section log_use_misc 3.2 Misc and Caveats
410
411   - Do not use any of the macros that start with '_'.
412   - Log4J has a 'rolling file appender' which you can select with a run-time
413     option and specify the max file size. This would be a nice default for
414     non-kernel applications.
415   - Careful, category names are global variables.
416
417 \section log_internals 4. Internal considerations
418
419 This module is a mess of macro black magic, and when it goes wrong,
420 SimGrid studently loose its ability to explain its problems. When
421 messing around this module, I often find useful to define
422 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
423 of finding what's going wrong. But things are quite verbose when
424 everything is enabled...
425
426 \section log_in_perf 4.1 Performance
427
428 Except for the first invocation of a given category, a disabled logging request
429 requires an a single comparison of a static variable to a constant.
430
431 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
432 causes all logging requests with a lower priority to be optimized to 0 cost
433 by the compiler. By setting it to gras_log_priority_infinite, all logging
434 requests are statically disabled at compile time and cost nothing. Released executables
435 <i>might</i>  be compiled with (note that it will prevent users to debug their problems)
436 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
437
438 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
439 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
440 the requests of priority below INFO.
441
442 \todo Logging performance *may* be improved further by improving the message
443 propagation from appender to appender in the category tree.
444
445 \section log_in_app 4.2 Appenders
446
447 Each category has an optional appender. An appender is a pointer to a
448 structure which starts with a pointer to a do_append() function. do_append()
449 prints a message to a log.
450
451 When a category is passed a message by one of the logging macros, the
452 category performs the following actions:
453
454   - if the category has an appender, the message is passed to the
455     appender's do_append() function,
456   - if additivity is true for the category, the message is passed to
457     the category's parent. Additivity is true by default, and can be
458     controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
459     Also, when you add an appender to a category, its additivity is automatically turned to off.
460     Turn it back on afterward if it is not what you wanted.
461
462 By default, only the root category have an appender, and any other category has
463 its additivity set to true. This causes all messages to be logged by the root
464 category's appender.
465
466 The default appender function currently prints to stderr, and the only other
467 existing one writes to the specified file. More would be needed, like the one
468 able to send the logs to a remote dedicated server.
469 This is on our TODO list for quite a while now, but your help would be
470 welcome here, too.
471
472
473                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               *//*' */
474
475
476 xbt_log_appender_t xbt_log_default_appender = NULL;     /* set in log_init */
477 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
478
479 typedef struct {
480   char *catname;
481   e_xbt_log_priority_t thresh;
482   char *fmt;
483   int additivity;
484   xbt_log_appender_t appender;
485 } s_xbt_log_setting_t, *xbt_log_setting_t;
486
487 static xbt_dynar_t xbt_log_settings = NULL;
488
489 static void _free_setting(void *s)
490 {
491   xbt_log_setting_t set = *(xbt_log_setting_t *) s;
492   if (set) {
493     free(set->catname);
494     if (set->fmt)
495       free(set->fmt);
496     free(set);
497   }
498 }
499
500 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
501                                    xbt_log_setting_t setting);
502
503 const char *xbt_log_priority_names[8] = {
504   "NONE",
505   "TRACE",
506   "DEBUG",
507   "VERBOSE",
508   "INFO",
509   "WARNING",
510   "ERROR",
511   "CRITICAL"
512 };
513
514 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
515   NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
516       "root", xbt_log_priority_uninitialized /* threshold */ ,
517       0 /* isThreshInherited */ ,
518       NULL /* appender */ , NULL /* layout */ ,
519       0                         /* additivity */
520 };
521
522 XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)");
523 XBT_LOG_NEW_CATEGORY(surf, "All SURF categories");
524 XBT_LOG_NEW_CATEGORY(msg, "All MSG categories");
525 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
526 XBT_LOG_NEW_CATEGORY(mc, "All MC categories");
527 XBT_LOG_NEW_CATEGORY(bindings, "All bindings categories");
528
529 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
530                                 "Loggings from the logging mechanism itself");
531
532 /* create the default appender and install it in the root category,
533    which were already created (damnit. Too slow little beetle) */
534 void xbt_log_preinit(void)
535 {
536   xbt_log_default_appender = xbt_log_appender_file_new(NULL);
537   xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
538   _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
539   _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
540 }
541
542 /** @brief Get all logging settings from the command line
543  *
544  * xbt_log_control_set() is called on each string we got from cmd line
545  */
546 void xbt_log_init(int *argc, char **argv)
547 {
548   int i, j;
549   char *opt;
550
551   //    _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
552
553   /* Set logs and init log submodule */
554   for (i = 1; i < *argc; i++) {
555     if (!strncmp(argv[i], "--log=", strlen("--log=")) ||
556         !strncmp(argv[i], "--gras-log=", strlen("--gras-log=")) ||
557         !strncmp(argv[i], "--surf-log=", strlen("--surf-log=")) ||
558         !strncmp(argv[i], "--msg-log=", strlen("--msg-log=")) ||
559         !strncmp(argv[i], "--simix-log=", strlen("--simix-log=")) ||
560         !strncmp(argv[i], "--xbt-log=", strlen("--xbt-log="))) {
561
562       if (strncmp(argv[i], "--log=", strlen("--log=")))
563         WARN2
564             ("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
565              (int) (strchr(argv[i], '=') - argv[i]), argv[i]);
566
567       opt = strchr(argv[i], '=');
568       opt++;
569       xbt_log_control_set(opt);
570       DEBUG1("Did apply '%s' as log setting", opt);
571       /*remove this from argv */
572
573       for (j = i + 1; j < *argc; j++) {
574         argv[j - 1] = argv[j];
575       }
576
577       argv[j - 1] = NULL;
578       (*argc)--;
579       i--;                      /* compensate effect of next loop incrementation */
580     }
581   }
582 }
583
584 static void log_cat_exit(xbt_log_category_t cat)
585 {
586   xbt_log_category_t child;
587
588   if (cat->appender) {
589     if (cat->appender->free_)
590       cat->appender->free_(cat->appender);
591     free(cat->appender);
592   }
593   if (cat->layout) {
594     if (cat->layout->free_)
595       cat->layout->free_(cat->layout);
596     free(cat->layout);
597   }
598
599   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
600     log_cat_exit(child);
601 }
602
603 void xbt_log_postexit(void)
604 {
605   VERB0("Exiting log");
606   xbt_dynar_free(&xbt_log_settings);
607   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
608 }
609
610 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
611 {
612
613   xbt_log_category_t cat = ev->cat;
614
615   va_start(ev->ap, fmt);
616   va_start(ev->ap_copy, fmt);
617   while (1) {
618     xbt_log_appender_t appender = cat->appender;
619     if (appender != NULL) {
620       xbt_assert1(cat->layout,
621                   "No valid layout for the appender of category %s",
622                   cat->name);
623       cat->layout->do_layout(cat->layout, ev, fmt, appender);
624     }
625     if (!cat->additivity)
626       break;
627
628     cat = cat->parent;
629   }
630   va_end(ev->ap);
631   va_end(ev->ap_copy);
632
633 #ifdef _XBT_WIN32
634   free(ev->buffer);
635 #endif
636 }
637
638 /* NOTE:
639  *
640  * The standard logging macros use _XBT_LOG_ISENABLED, which calls
641  * _xbt_log_cat_init().  Thus, if we want to avoid an infinite
642  * recursion, we can not use the standard logging macros in
643  * _xbt_log_cat_init(), and in all functions called from it.
644  *
645  * To circumvent the problem, we define the macro_xbt_log_init() as
646  * (0) for the length of the affected functions, and we do not forget
647  * to undefine it at the end!
648  */
649
650 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
651                                    xbt_log_setting_t setting)
652 {
653 #define _xbt_log_cat_init(a, b) (0)
654
655   if (setting->thresh != xbt_log_priority_uninitialized) {
656     xbt_log_threshold_set(category, setting->thresh);
657
658     DEBUG3("Apply settings for category '%s': set threshold to %s (=%d)",
659            category->name, xbt_log_priority_names[category->threshold],
660            category->threshold);
661   }
662
663   if (setting->fmt) {
664     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
665
666     DEBUG2("Apply settings for category '%s': set format to %s",
667            category->name, setting->fmt);
668   }
669
670   if (setting->additivity != -1) {
671     xbt_log_additivity_set(category, setting->additivity);
672
673     DEBUG2("Apply settings for category '%s': set additivity to %s",
674            category->name, (setting->additivity ? "on" : "off"));
675   }
676   if (setting->appender) {
677     xbt_log_appender_set(category, setting->appender);
678     if (!category->layout)
679       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
680     category->additivity = 0;
681     DEBUG2("Set %p as appender of category '%s'",
682            setting->appender, category->name);
683   }
684 #undef _xbt_log_cat_init
685 }
686
687 /*
688  * This gets called the first time a category is referenced and performs the
689  * initialization.
690  * Also resets threshold to inherited!
691  */
692 int _xbt_log_cat_init(xbt_log_category_t category,
693                       e_xbt_log_priority_t priority)
694 {
695 #define _xbt_log_cat_init(a, b) (0)
696
697   unsigned int cursor;
698   xbt_log_setting_t setting = NULL;
699   int found = 0;
700
701   DEBUG3("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
702          category->name,
703          (category->firstChild ? category->firstChild->name : "none"),
704          (category->nextSibling ? category->nextSibling->name : "none"));
705
706   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
707     category->threshold = xbt_log_priority_info;
708     /* xbt_log_priority_debug */ ;
709     category->appender = xbt_log_default_appender;
710     category->layout = xbt_log_default_layout;
711   } else {
712
713     if (!category->parent)
714       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
715
716     DEBUG3("Set %s (%s) as father of %s ",
717            category->parent->name,
718            (category->parent->threshold == xbt_log_priority_uninitialized ?
719             "uninited" : xbt_log_priority_names[category->
720                                                 parent->threshold]),
721            category->name);
722     xbt_log_parent_set(category, category->parent);
723
724     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
725       char *buf, *res = NULL;
726       xbt_log_category_t cpp = category->parent->firstChild;
727       while (cpp) {
728         if (res) {
729           buf = bprintf("%s %s", res, cpp->name);
730           free(res);
731           res = buf;
732         } else {
733           res = xbt_strdup(cpp->name);
734         }
735         cpp = cpp->nextSibling;
736       }
737
738       DEBUG3("Childs of %s: %s; nextSibling: %s",
739              category->parent->name, res,
740              (category->parent->nextSibling ?
741               category->parent->nextSibling->name : "none"));
742
743       free(res);
744     }
745
746   }
747
748   /* Apply the control */
749   if (!xbt_log_settings)
750     return priority >= category->threshold;
751
752   xbt_assert0(category, "NULL category");
753   xbt_assert(category->name);
754
755   xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
756     xbt_assert0(setting, "Damnit, NULL cat in the list");
757     xbt_assert1(setting->catname, "NULL setting(=%p)->catname",
758                 (void *) setting);
759
760     if (!strcmp(setting->catname, category->name)) {
761
762       found = 1;
763
764       _xbt_log_cat_apply_set(category, setting);
765
766       xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
767     }
768   }
769
770   if (!found)
771     DEBUG3("Category '%s': inherited threshold = %s (=%d)",
772            category->name, xbt_log_priority_names[category->threshold],
773            category->threshold);
774
775   return priority >= category->threshold;
776
777 #undef _xbt_log_cat_init
778 }
779
780 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
781 {
782
783   xbt_assert0(cat, "NULL category to be given a parent");
784   xbt_assert1(parent, "The parent category of %s is NULL", cat->name);
785
786   /*
787    * if the threshold is initialized
788    * unlink from current parent
789    */
790   if (cat->threshold != xbt_log_priority_uninitialized) {
791
792     xbt_log_category_t *cpp = &parent->firstChild;
793
794     while (*cpp != cat && *cpp != NULL) {
795       cpp = &(*cpp)->nextSibling;
796     }
797
798     xbt_assert(*cpp == cat);
799     *cpp = cat->nextSibling;
800   }
801
802   cat->parent = parent;
803   cat->nextSibling = parent->firstChild;
804
805   parent->firstChild = cat;
806
807   if (parent->threshold == xbt_log_priority_uninitialized) {
808
809     _xbt_log_cat_init(parent,
810                       xbt_log_priority_uninitialized /* ignored */ );
811   }
812
813   cat->threshold = parent->threshold;
814
815   cat->isThreshInherited = 1;
816
817 }
818
819 static void _set_inherited_thresholds(xbt_log_category_t cat)
820 {
821
822   xbt_log_category_t child = cat->firstChild;
823
824   for (; child != NULL; child = child->nextSibling) {
825     if (child->isThreshInherited) {
826       if (cat != &_XBT_LOGV(log))
827         VERB3("Set category threshold of %s to %s (=%d)",
828               child->name, xbt_log_priority_names[cat->threshold],
829               cat->threshold);
830       child->threshold = cat->threshold;
831       _set_inherited_thresholds(child);
832     }
833   }
834
835
836 }
837
838 void xbt_log_threshold_set(xbt_log_category_t cat,
839                            e_xbt_log_priority_t threshold)
840 {
841   cat->threshold = threshold;
842   cat->isThreshInherited = 0;
843
844   _set_inherited_thresholds(cat);
845
846 }
847
848 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
849 {
850
851   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
852   const char *name, *dot, *eq;
853
854   set->catname = NULL;
855   set->thresh = xbt_log_priority_uninitialized;
856   set->fmt = NULL;
857   set->additivity = -1;
858   set->appender = NULL;
859
860   if (!*control_string)
861     return set;
862   DEBUG1("Parse log setting '%s'", control_string);
863
864   control_string += strspn(control_string, " ");
865   name = control_string;
866   control_string += strcspn(control_string, ".= ");
867   dot = control_string;
868   control_string += strcspn(control_string, ":= ");
869   eq = control_string;
870   control_string += strcspn(control_string, " ");
871
872   xbt_assert1(*dot == '.' && (*eq == '=' || *eq == ':'),
873               "Invalid control string '%s'", control_string);
874
875   if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
876     int i;
877     char *neweq = xbt_strdup(eq + 1);
878     char *p = neweq - 1;
879
880     while (*(++p) != '\0') {
881       if (*p >= 'a' && *p <= 'z') {
882         *p -= 'a' - 'A';
883       }
884     }
885
886     DEBUG1("New priority name = %s", neweq);
887     for (i = 0; i < xbt_log_priority_infinite; i++) {
888       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
889         DEBUG1("This is priority %d", i);
890         break;
891       }
892     }
893     if (i < xbt_log_priority_infinite) {
894       set->thresh = (e_xbt_log_priority_t) i;
895     } else {
896       THROW1(arg_error, 0,
897              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
898              eq + 1);
899     }
900     free(neweq);
901   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
902              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
903
904     char *neweq = xbt_strdup(eq + 1);
905     char *p = neweq - 1;
906
907     while (*(++p) != '\0') {
908       if (*p >= 'a' && *p <= 'z') {
909         *p -= 'a' - 'A';
910       }
911     }
912     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
913         || !strcmp(neweq, "1")) {
914       set->additivity = 1;
915     } else {
916       set->additivity = 0;
917     }
918     free(neweq);
919   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
920              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
921
922     char *neweq = xbt_strdup(eq + 1);
923
924     if (!strncmp(neweq, "file:", 5)) {
925       set->appender = xbt_log_appender_file_new(neweq + 5);
926     } else {
927       THROW1(arg_error, 0, "Unknown appender log type: '%s'", neweq);
928     }
929     free(neweq);
930   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
931     set->fmt = xbt_strdup(eq + 1);
932   } else {
933     char buff[512];
934     snprintf(buff, min(512, eq - dot), "%s", dot + 1);
935     THROW1(arg_error, 0, "Unknown setting of the log category: '%s'",
936            buff);
937   }
938   set->catname = (char *) xbt_malloc(dot - name + 1);
939
940   memcpy(set->catname, name, dot - name);
941   set->catname[dot - name] = '\0';      /* Just in case */
942   DEBUG1("This is for cat '%s'", set->catname);
943
944   return set;
945 }
946
947 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
948                                                  char *name)
949 {
950   xbt_log_category_t child, res;
951
952   DEBUG4("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
953          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
954          (cat->nextSibling ? cat->nextSibling->name : "none"));
955   if (!strcmp(cat->name, name))
956     return cat;
957
958   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
959     DEBUG1("Dig into %s", child->name);
960     res = _xbt_log_cat_searchsub(child, name);
961     if (res)
962       return res;
963   }
964
965   return NULL;
966 }
967
968 /**
969  * \ingroup XBT_log
970  * \param control_string What to parse
971  *
972  * Typically passed a command-line argument. The string has the syntax:
973  *
974  *      ( [category] "." [keyword] ":" value (" ")... )...
975  *
976  * where [category] is one the category names (see \ref XBT_log_cats for
977  * a complete list of the ones defined in the SimGrid library)
978  * and keyword is one of the following:
979  *
980  *    - thres: category's threshold priority. Possible values:
981  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
982  *    - add or additivity: whether the logging actions must be passed to
983  *      the parent category.
984  *      Possible values: 0, 1, no, yes, on, off.
985  *      Default value: yes.
986  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
987  *    - app or appender: the appender to use. See \ref log_use_conf_app for more
988  *      information.
989  *
990  */
991 void xbt_log_control_set(const char *control_string)
992 {
993   xbt_log_setting_t set;
994
995   /* To split the string in commands, and the cursors */
996   xbt_dynar_t set_strings;
997   char *str;
998   unsigned int cpt;
999
1000   if (!control_string)
1001     return;
1002   DEBUG1("Parse log settings '%s'", control_string);
1003
1004   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1005   if (!strcmp(control_string, "no_loc")) {
1006     xbt_log_no_loc = 1;
1007     return;
1008   }
1009   /* some initialization if this is the first time that this get called */
1010   if (xbt_log_settings == NULL)
1011     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1012                                      _free_setting);
1013
1014   /* split the string, and remove empty entries */
1015   set_strings = xbt_str_split_quoted(control_string);
1016
1017   if (xbt_dynar_length(set_strings) == 0) {     /* vicious user! */
1018     xbt_dynar_free(&set_strings);
1019     return;
1020   }
1021
1022   /* Parse each entry and either use it right now (if the category was already
1023      created), or store it for further use */
1024   xbt_dynar_foreach(set_strings, cpt, str) {
1025     xbt_log_category_t cat = NULL;
1026
1027     set = _xbt_log_parse_setting(str);
1028     cat =
1029         _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1030
1031     if (cat) {
1032       DEBUG0("Apply directly");
1033       _xbt_log_cat_apply_set(cat, set);
1034       _free_setting((void *) &set);
1035     } else {
1036
1037       DEBUG0("Store for further application");
1038       DEBUG1("push %p to the settings", (void *) set);
1039       xbt_dynar_push(xbt_log_settings, &set);
1040     }
1041   }
1042   xbt_dynar_free(&set_strings);
1043 }
1044
1045 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1046 {
1047   if (cat->appender) {
1048     if (cat->appender->free_)
1049       cat->appender->free_(cat->appender);
1050     free(cat->appender);
1051   }
1052   cat->appender = app;
1053 }
1054
1055 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1056 {
1057   if (!cat->appender) {
1058     VERB1
1059         ("No appender to category %s. Setting the file appender as default",
1060          cat->name);
1061     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1062   }
1063   if (cat->layout && cat != &_XBT_LOGV(root)) {
1064     /* better leak the default layout than check every categories to
1065        change it */
1066     if (cat->layout->free_) {
1067       cat->layout->free_(cat->layout);
1068       free(cat->layout);
1069     }
1070   }
1071   cat->layout = lay;
1072   xbt_log_additivity_set(cat, 0);
1073 }
1074
1075 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1076 {
1077   cat->additivity = additivity;
1078 }