Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
0450eb8c4eac2eda5dfacd00186e0122d43744be
[simgrid.git] / src / xbt / log.c
1 /* $Id$ */
2
3 /* log - a generic logging facility in the spirit of log4j                  */
4
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10
11 #include <stdarg.h>
12 #include <ctype.h>
13 #include <stdio.h> /* snprintf */
14 #include <stdlib.h> /* snprintf */
15
16 #include "portable.h" /* to get a working stdarg.h */
17
18 #include "xbt_modinter.h"
19
20 #include "xbt/misc.h"
21 #include "xbt/ex.h"
22 #include "xbt/sysdep.h"
23 #include "xbt/log.h"
24 #include "xbt/dynar.h"
25
26 XBT_PUBLIC_DATA(int) (*xbt_pid)();
27
28 /** \addtogroup XBT_log
29  *
30  *  This section describes the API to the log functions used 
31  *  everywhere in this project.
32
33 \section XBT_log_toc Table of contents
34  
35  - \ref log_overview
36    - \ref log_cat
37    - \ref log_pri
38    - \ref log_app
39    - \ref log_hist
40  - \ref log_API
41    - \ref log_API_cat
42    - \ref log_API_pri
43    - \ref log_API_isenabled
44    - \ref log_API_subcat
45    - \ref log_API_easy
46    - \ref log_API_example
47  - \ref log_user
48    - \ref log_use_conf
49      - \ref log_use_conf_thres
50      - \ref log_use_conf_multi
51      - \ref log_use_conf_fmt
52      - \ref log_use_conf_add
53    - \ref log_use_misc
54  - \ref log_internals
55    - \ref log_in_perf
56    - \ref log_in_app
57  - \ref XBT_log_cats
58      
59 \section log_overview 1. Introduction
60
61 This module is in charge of handling the log messages of every SimGrid
62 program. The main design goal are:
63
64   - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and 
65     what to hide, as well as how messages get displayed.
66   - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
67     and to the user (with command line options)
68   - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
69   - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones, 
70     and the logging mecanism allows to syndicate each and every log source into the same place.
71     At least, its design would allow to, once we write the last missing pieces
72      
73 There is three main concepts in SimGrid's logging mecanism: <i>category</i>,
74 <i>priority</i> and <i>appender</i>. These three concepts work together to
75 enable developers to log messages according to message type and priority, and
76 to control at runtime how these messages are formatted and where they are
77 reported. 
78
79 \subsection log_cat 1.1 Category hierarchy
80
81 The first and foremost advantage of any logging API over plain printf()
82 resides in its ability to disable certain log statements while allowing
83 others to print unhindered. This capability assumes that the logging space,
84 that is, the space of all possible logging statements, is categorized
85 according to some developer-chosen criteria. 
86           
87 This observation led to choosing category as the central concept of the
88 system. In a certain sense, they can be considered as logging topics or
89 channels.
90
91 \subsection log_pri 1.2 Logging priorities
92
93 The user can naturally declare interest into this or that logging category, but
94 he also can specify the desired level of details for each of them. This is
95 controled by the <i>priority</i> concept (which should maybe be renamed to
96 <i>severity</i>). 
97
98 Empirically, the user can specify that he wants to see every debuging message
99 of GRAS while only being interested into the messages at level "error" or
100 higher about the XBT internals.
101
102 \subsection log_app 1.3 Message appenders
103
104 The message appenders are the elements in charge of actually displaying the
105 message to the user. For now, there is only one appender: the one able to print
106 stuff on stderr. But everything is in place internally to write new ones, such
107 as the one able to send the strings to a central server in charge of
108 syndicating the logs of every distributed daemons on a well known location.
109
110 One day, for sure ;)
111
112 \subsection log_lay 1.4 Message layouts
113
114 The message layouts are the elements in charge of choosing how each message
115 will look like. Their result is a string which is then passed to the appender
116 attached to the category to be displayed. 
117
118 For now, there is two layouts: The simple one, which is good for most cases,
119 and another one allowing users to specify the format they want. 
120 \ref log_use_conf provides more info on this.
121
122 \subsection log_hist 1.5 History of this module
123
124 Historically, this module is an adaptation of the log4c project, which is dead
125 upstream, and which I was given the permission to fork under the LGPL licence
126 by the log4c's authors. The log4c project itself was loosely based on the
127 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
128 differs somehow from these projects anyway, because the C programming language
129 is not object oriented.
130
131 \section log_API 2. Programmer interface
132
133 \subsection log_API_cat 2.1 Constructing the category hierarchy
134
135 Every category is declared by providing a name and an optional
136 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
137 the category's parent. 
138       
139 A category is created by a macro call at the top level of a file.  A
140 category can be created with any one of the following macros:
141
142  - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
143  - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
144     Create a new category being child of the category ParentCat
145  - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
146     Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
147       in this file
148  -  \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
149     Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
150       in this file
151             
152 The parent cat can be defined in the same file or in another file (in
153 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
154 it visible in the current file), but each category may have only one
155 definition.
156       
157 Typically, there will be a Category for each module and sub-module, so you
158 can independently control logging for each module.
159
160 For a list of all existing categories, please refer to the \ref XBT_log_cats
161 section. This file is generated automatically from the SimGrid source code, so
162 it should be complete and accurate.
163
164 \section log_API_pri 2.2 Declaring message priority
165
166 A category may be assigned a threshold priorty. The set of priorites are
167 defined by the \ref e_xbt_log_priority_t enum. All logging request under
168 this priority will be discarded.
169           
170 If a given category is not assigned a threshold priority, then it inherits
171 one from its closest ancestor with an assigned threshold. To ensure that all
172 categories can eventually inherit a threshold, the root category always has
173 an assigned threshold priority.
174
175 Logging requests are made by invoking a logging macro on a category.  All of
176 the macros have a printf-style format string followed by arguments. If you
177 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
178 when you pass a pointer to a string where an integer was specified by the
179 format. This is usualy a good idea.
180
181 Because some C compilers do not support vararg macros, there is a version of
182 the macro for any number of arguments from 0 to 6. The macro name ends with
183 the total number of arguments.
184         
185 Here is an example of the most basic type of macro. This is a logging
186 request with priority <i>warning</i>.
187
188 <code>CLOG5(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
189 "oops");</code>
190
191 A logging request is said to be enabled if its priority is higher than or
192 equal to the threshold priority of its category. Otherwise, the request is
193 said to be disabled. A category without an assigned priority will inherit
194 one from the hierarchy. 
195       
196 It is possible to use any non-negative integer as a priority. If, as in the
197 example, one of the standard priorites is used, then there is a convenience
198 macro that is typically used instead. For example, the above example is
199 equivalent to the shorter:
200
201 <code>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
202
203 \section log_API_isenabled 2.3 Checking if a perticular category/priority is enabled
204
205 It is sometimes useful to check whether a perticular category is
206 enabled at a perticular priority. One example is when you want to do
207 some extra computation to prepare a nice debugging message. There is
208 no use of doing so if the message won't be used afterward because
209 debugging is turned off. 
210  
211 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
212
213 \section log_API_subcat 2.4 Using a default category (the easy interface)
214   
215 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
216 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
217 category, then the even shorter form can be used:
218
219 <code>WARN3("Values are: %s and '%d'", 5, "oops");</code>
220
221 Only one default category can be created per file, though multiple
222 non-defaults can be created and used.
223
224 \section log_API_easy 2.5 Putting all together: the easy interface
225
226 First of all, each module should register its own category into the categories
227 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
228
229 Then, logging should be done with the DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
230 ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB10,
231 #INFO10, #WARN10, #ERROR10 and #CRITICAL10). For each group, there is at
232 least 11 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
233 DEBUG5, DEBUG6, DEBUG7, DEBUG8, DEBUG9, DEBUG10), only differing in the number of arguments passed along the format.
234 This is because we want SimGrid itself to keep compilable on ancient
235 compiler not supporting variable number of arguments to macros. But we
236 should provide a macro simpler to use for the users not interested in SP3
237 machines (FIXME).
238   
239 Under GCC, these macro check there arguments the same way than printf does. So,
240 if you compile with -Wall, the folliwing code will issue a warning:
241 <code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
242
243 If you want to specify the category to log onto (for example because you
244 have more than one category per file, add a C before the name of the log
245 producing macro (ie, use #CDEBUG10, #CVERB10, #CINFO10, #CWARN10, #CERROR10 and
246 #CCRITICAL10 and friends), and pass the category name as first argument.
247   
248 The TRACE priority is not used the same way than the other. You should use
249 the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
250 instead.
251
252 \section log_API_example 2.6 Example of use
253
254 Here is a more complete example:
255
256 \verbatim
257 #include "xbt/log.h"
258
259 / * create a category and a default subcategory * /
260 XBT_LOG_NEW_CATEGORY(VSS);
261 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
262
263 int main() {
264        / * Now set the parent's priority.  (the string would typcially be a runtime option) * /
265        xbt_log_control_set("SA.thresh:3");
266
267        / * This request is enabled, because WARNING >= INFO. * /
268        CWARN2(VSS, "Low fuel level.");
269
270        / * This request is disabled, because DEBUG < INFO. * /
271        CDEBUG2(VSS, "Starting search for nearest gas station.");
272
273        / * The default category SA inherits its priority from VSS. Thus,
274           the following request is enabled because INFO >= INFO.  * /
275        INFO1("Located nearest gas station.");
276
277        / * This request is disabled, because DEBUG < INFO. * /
278        DEBUG1("Exiting gas station search"); 
279 }
280 \endverbatim
281
282 Another example can be found in the relevant part of the GRAS tutorial: 
283 \ref GRAS_tut_tour_logs.
284
285 \section log_user 3. User interface
286
287 \section log_use_conf 3.1 Configuration
288
289 Although rarely done, it is possible to configure the logs during
290 program initialization by invoking the xbt_log_control_set() method
291 manually. A more conventionnal way is to use the --log command line
292 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
293 checks and deals properly with such arguments.
294  
295 The following command line arguments exist, but are deprecated and
296 may disapear in the future: --xbt-log, --gras-log, --msg-log and
297 --surf-log.
298  
299 \subsection log_use_conf_thres 3.1.1 Thresold configuration
300  
301 The most common setting is to control which logging event will get
302 displayed by setting a threshold to each category through the
303 <tt>thres</tt> keyword.
304
305 For example, \verbatim --log=root.thres:debug\endverbatim will make
306 SimGrid <b>extremely</b> verbose while \verbatim
307 --log=root.thres:critical\endverbatim should shut it almost
308 completely off.
309
310 \subsection log_use_conf_multi 3.1.2 Passing several settings
311
312 You can provide several of those arguments to change the setting of several 
313 categories, they will be applied from left to right. So,
314 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
315 disable almost any logging.
316  
317 Note that the quotes on above line are mandatory because there is a space in
318 the argument, so we are protecting ourselves from the shell, not from SimGrid.
319 We could also reach the same effect with this:
320 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim 
321
322 \subsection log_use_conf_fmt 3.1.3 Format configuration
323
324 As with SimGrid 3.3, it is possible to control the format of log
325 messages. This is done through the <tt>fmt</tt> keyword. For example,
326 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
327 user-message only, removing any decoration such as the date, or the
328 process ID, everything.
329
330 Here are the existing format directives:
331
332  - %%: the % char
333  - %%n: platform-dependant line separator (LOG4J compliant)
334  - %%e: plain old space (SimGrid extension)
335
336  - %%m: user-provided message
337
338  - %%c: Category name (LOG4J compliant)
339  - %%p: Priority name (LOG4J compliant)
340
341  - %%h: Hostname (SimGrid extension)
342  - %%t: Process name (LOG4J compliant -- thread name in LOG4J)
343  - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
344
345  - %%F: file name where the log event was raised (LOG4J compliant)
346  - %%l: location where the log event was raised (LOG4J compliant, like '%%F:%%L' -- this is a l as in 'l'etter)
347  - %%L: line number where the log event was raised (LOG4J compliant)
348  - %%M: function name (LOG4J compliant -- called method name here of course). 
349    Defined only when using gcc because there is no __FUNCTION__ elsewhere.
350
351  - %%b: full backtrace (Called %%throwable in LOG4J). 
352    Defined only when using the GNU libc because backtrace() is not defined 
353    elsewhere.
354  - %%B: short backtrace (only the first line of the %%b). 
355    Called %%throwable{short} in LOG4J; defined where %%b is.
356
357  - %%d: date (UNIX-like epoch)
358  - %%r: application age (time elapsed since the beginning of the application)
359
360
361 If you want to mimick the simple layout with the format one, you would use this
362 format: '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
363 because the simple layout do not display the message location for messages at
364 priority INFO (thus, the fmt is '[%%h:%%i:(%%I) %%r] %%l: [%%c/%%p] %%m%%n' in this
365 case). Moreover, if there is no process name (ie, messages comming from the
366 library itself, or test programs doing strange things) do not display the
367 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
368 [%%c/%%p] %%m%%n' if they are at priority INFO).
369
370 For now, there is only one format modifyier: the precision field. You
371 can for example specify %.4r to get the application age with 4
372 numbers after the radix. Another limitation is that you cannot set
373 specific layouts to the several priorities.
374
375 \subsection log_use_conf_add 3.1.4 Category additivity
376
377 The <tt>add</tt> keyword allows to specify the additivity of a
378 category (see \ref log_in_app). This is rarely useful since you
379 cannot specify an alternative appender. Anyway, '0', '1', 'no',
380 'ye's, 'on' and 'off' are all valid values, with 'yes' as default.
381
382 \section log_use_misc 3.2 Misc and Caveats
383
384   - Do not use any of the macros that start with '_'.
385   - Log4J has a 'rolling file appender' which you can select with a run-time
386     option and specify the max file size. This would be a nice default for
387     non-kernel applications.
388   - Careful, category names are global variables.
389
390 \section log_internals 4. Internal considerations
391
392 This module is a mess of macro black magic, and when it goes wrong,
393 SimGrid studently loose its ability to explain its problems. When
394 messing around this module, I often find useful to define
395 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
396 of finding what's going wrong. But things are quite verbose when
397 everything is enabled...
398
399 \section log_in_perf 4.1 Performance
400
401 Except for the first invocation of a given category, a disabled logging request
402 requires an a single comparison of a static variable to a constant.
403
404 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
405 causes all logging requests with a lower priority to be optimized to 0 cost
406 by the compiler. By setting it to gras_log_priority_infinite, all logging
407 requests are statically disabled and cost nothing. Released executables
408 <i>might</i>  be compiled with (note that it will prevent users to debug their problems)
409 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
410
411 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging 
412 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables 
413 the requests of priority below INFO.
414
415 \todo Logging performance *may* be improved further by improving the message
416 propagation from appender to appender in the category tree.
417
418 \section log_in_app 4.2 Appenders
419
420 Each category has an optional appender. An appender is a pointer to a
421 structure which starts with a pointer to a doAppend() function. DoAppend()
422 prints a message to a log.
423
424 When a category is passed a message by one of the logging macros, the
425 category performs the following actions:
426
427   - if the category has an appender, the message is passed to the
428     appender's doAppend() function,
429   - if additivity is true for the category (which is the case by
430     default, and can be controlled by xbt_log_additivity_set()), the 
431     message is passed to the category's parent. 
432     
433 By default, only the root category have an appender, and any other category has
434 its additivity set to true. This causes all messages to be logged by the root
435 category's appender.
436
437 The default appender function currently prints to stderr, and no other one
438 exist, even if more would be needed, like the one able to send the logs to a
439 remote dedicated server, or other ones offering different output formats.
440 This is on our TODO list for quite a while now, but your help would be
441 welcome here, too.
442
443
444 *//*'*/
445
446 \f
447 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
448 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
449 int _log_usable = 0;
450
451 typedef struct {
452   char *catname;
453   e_xbt_log_priority_t thresh;
454   char *fmt;
455   int additivity;
456 } s_xbt_log_setting_t,*xbt_log_setting_t;
457
458 static xbt_dynar_t xbt_log_settings=NULL;
459
460 static void _free_setting(void *s) {
461   xbt_log_setting_t set=*(xbt_log_setting_t*)s;
462   if (set) {
463     free(set->catname);
464     if (set->fmt)
465       free(set->fmt);
466     free(set);
467   }
468 }
469 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
470                                    xbt_log_setting_t setting);
471
472 const char *xbt_log_priority_names[8] = {
473   "NONE",
474   "TRACE",
475   "DEBUG",
476   "VERBOSE",
477   "INFO",
478   "WARNING",
479   "ERROR",
480   "CRITICAL"
481 };
482
483 XBT_PUBLIC_DATA(s_xbt_log_category_t)  _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
484   0, 0, 0,
485   "root", xbt_log_priority_uninitialized, 0,
486   NULL, 0
487 };
488
489 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
490 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
491 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
492 XBT_LOG_NEW_CATEGORY(simix,"All SIMIX categories");
493 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
494
495 /** @brief Get all logging settings from the command line
496  * 
497  * xbt_log_control_set() is called on each string we got from cmd line
498  */
499 void xbt_log_init(int *argc,char **argv) {
500         int i,j;
501         char *opt;
502         
503         /* create the default appender and install it in the root category,
504            which were already created (damnit. Too slow little beetle)*/
505         xbt_log_default_appender = xbt_log_appender_file_new(NULL);
506         xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
507         _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
508         _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
509         _log_usable = 1;   
510
511         /* Set logs and init log submodule */
512         for (i=1; i<*argc; i++){
513                 if (!strncmp(argv[i],"--log=",strlen("--log=")) ||
514                     !strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
515                     !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
516                     !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
517                     !strncmp(argv[i],"--simix-log=",strlen("--simix-log=")) ||
518                     !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
519                         
520                   if (strncmp(argv[i],"--log=",strlen("--log=")))
521                       WARN2("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
522                             (int)(strchr(argv[i],'=')-argv[i]),argv[i]);
523
524                   opt=strchr(argv[i],'=');
525                   opt++;
526                   xbt_log_control_set(opt);
527                   DEBUG1("Did apply '%s' as log setting",opt);
528                   /*remove this from argv*/
529                   
530                   for (j=i+1; j<*argc; j++){
531                     argv[j-1] = argv[j];
532                   } 
533                   
534                   argv[j-1] = NULL;
535                   (*argc)--;
536                   i--; /* compensate effect of next loop incrementation */
537                 }
538         }
539 }
540
541 static void log_cat_exit(xbt_log_category_t cat) {
542   xbt_log_category_t child;
543
544   if (cat->appender) {
545     if (cat->appender->free_)
546       cat->appender->free_(cat->appender);
547     free(cat->appender);
548   }
549   if (cat->layout) {
550     if (cat->layout->free_)
551       cat->layout->free_(cat->layout);
552     free(cat->layout);
553   }    
554
555   for(child=cat->firstChild ; child != NULL; child = child->nextSibling) 
556     log_cat_exit(child);
557 }
558
559 void xbt_log_exit(void) {
560   VERB0("Exiting log");
561   xbt_dynar_free(&xbt_log_settings);
562   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
563   _log_usable = 0;
564 }
565
566 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
567   
568   xbt_log_category_t cat = ev->cat;
569   if (!_log_usable) {
570      fprintf(stderr,"XXXXXXXXXXXXXXXXXXX\nXXX Warning, logs not usable here. Either before xbt_init() or after xbt_exit().\nXXXXXXXXXXXXXXXXXXX\n");
571      va_start(ev->ap, fmt);
572      vfprintf(stderr,fmt,ev->ap);
573      va_end(ev->ap);
574      xbt_backtrace_display_current();
575      return;
576   }
577    
578   va_start(ev->ap, fmt);
579   while(1) {
580     xbt_log_appender_t appender = cat->appender;
581     if (appender != NULL) {
582       xbt_assert1(cat->layout,"No valid layout for the appender of category %s",cat->name);
583       char *str= cat->layout->do_layout(cat->layout, ev, fmt);    
584       appender->do_append(appender, str);
585     }
586     if (!cat->additivity)
587       break;
588
589     cat = cat->parent;
590   } 
591   va_end(ev->ap);
592 }
593
594 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
595                                    xbt_log_setting_t setting) { 
596
597   s_xbt_log_event_t _log_ev;
598
599   if (setting->thresh != xbt_log_priority_uninitialized) {
600     xbt_log_threshold_set(category, setting->thresh);
601     
602     if (category->threshold <= xbt_log_priority_debug) {
603       _log_ev.cat = category;
604       _log_ev.priority = xbt_log_priority_debug;
605       _log_ev.fileName = __FILE__ ;
606       _log_ev.functionName = _XBT_FUNCTION ;
607       _log_ev.lineNum = __LINE__ ;
608       
609       _xbt_log_event_log(&_log_ev,
610           "Apply settings for category '%s': set threshold to %s (=%d)",
611                          category->name,
612                          xbt_log_priority_names[category->threshold],
613                          category->threshold);
614     }
615   }
616
617   if (setting->fmt) {
618     xbt_log_layout_set(category,xbt_log_layout_format_new(setting->fmt));
619     
620     if (category->threshold <= xbt_log_priority_debug) {
621       _log_ev.cat = category;
622       _log_ev.priority = xbt_log_priority_debug;
623       _log_ev.fileName = __FILE__ ;
624       _log_ev.functionName = _XBT_FUNCTION ;
625       _log_ev.lineNum = __LINE__ ;
626       
627       _xbt_log_event_log(&_log_ev,
628               "Apply settings for category '%s': set format to %s",
629                          category->name,
630                          setting->fmt);
631     }
632   }
633
634   if (setting->additivity != -1) {
635     xbt_log_additivity_set(category,setting->additivity);
636     
637     if (category->threshold <= xbt_log_priority_debug) {
638       _log_ev.cat = category;
639       _log_ev.priority = xbt_log_priority_debug;
640       _log_ev.fileName = __FILE__ ;
641       _log_ev.functionName = _XBT_FUNCTION ;
642       _log_ev.lineNum = __LINE__ ;
643       
644       _xbt_log_event_log(&_log_ev,
645                     "Apply settings for category '%s': set additivity to %s",
646                          category->name,
647                          (setting->additivity?"on":"off"));
648     }
649   }
650 }
651 /*
652  * This gets called the first time a category is referenced and performs the
653  * initialization. 
654  * Also resets threshold to inherited!
655  */
656 int _xbt_log_cat_init(xbt_log_category_t category,
657                       e_xbt_log_priority_t priority) {
658   int cursor;
659   xbt_log_setting_t setting=NULL;
660   int found = 0;
661   s_xbt_log_event_t _log_ev;
662         
663   if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
664     category->threshold = xbt_log_priority_info;/* xbt_log_priority_debug*/;
665     category->appender = xbt_log_default_appender;
666     category->layout = xbt_log_default_layout;
667   } else {
668
669     if (!category->parent)
670       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
671     
672     xbt_log_parent_set(category, category->parent);
673   }
674
675   /* Apply the control */  
676   if (!xbt_log_settings)
677     return priority >= category->threshold;
678   
679   xbt_assert0(category,"NULL category");
680   xbt_assert(category->name);
681   
682   xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
683     xbt_assert0(setting,"Damnit, NULL cat in the list");
684     xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
685     
686     if (!strcmp(setting->catname,category->name)) {
687       
688       found = 1;
689       
690       _xbt_log_cat_apply_set(category,setting);
691
692       xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
693     }
694   }
695   
696   if (!found && category->threshold <= xbt_log_priority_verbose) {
697     
698     _log_ev.cat = category;
699     _log_ev.priority = xbt_log_priority_verbose;
700     _log_ev.fileName = __FILE__ ;
701     _log_ev.functionName = _XBT_FUNCTION ;
702     _log_ev.lineNum = __LINE__ ;
703     
704     _xbt_log_event_log(&_log_ev,
705                        "Category '%s': inherited threshold = %s (=%d)",
706                        category->name,
707             xbt_log_priority_names[category->threshold], category->threshold);
708   }
709     
710   return priority >= category->threshold;
711 }
712
713 void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent) 
714 {
715         
716         xbt_assert0(cat,"NULL category to be given a parent");
717         xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
718         
719         /* 
720          * if the threshold is initialized 
721          * unlink from current parent 
722          */
723         if(cat->threshold != xbt_log_priority_uninitialized){
724
725                 xbt_log_category_t* cpp = &parent->firstChild;
726         
727                 while(*cpp != cat && *cpp != NULL) {
728                         cpp = &(*cpp)->nextSibling;
729                 }
730                 
731                 xbt_assert(*cpp == cat);
732                 *cpp = cat->nextSibling;
733         }
734         
735         cat->parent = parent;
736         cat->nextSibling = parent->firstChild;
737         
738         parent->firstChild = cat;
739         
740         if (parent->threshold == xbt_log_priority_uninitialized){
741                 
742           _xbt_log_cat_init(parent,
743                             xbt_log_priority_uninitialized/* ignored*/);
744         }
745         
746         cat->threshold = parent->threshold;
747         
748         cat->isThreshInherited = 1;
749         
750 }
751
752 static void _set_inherited_thresholds(xbt_log_category_t cat) {
753         
754   xbt_log_category_t child = cat->firstChild;
755   
756   for( ; child != NULL; child = child->nextSibling) {
757     if (child->isThreshInherited) {
758       if (cat != &_XBT_LOGV(log))
759         VERB3("Set category threshold of %s to %s (=%d)",
760               child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
761       child->threshold = cat->threshold;
762       _set_inherited_thresholds(child);
763     }
764   }
765   
766  
767 }
768
769 void xbt_log_threshold_set(xbt_log_category_t   cat,
770                             e_xbt_log_priority_t threshold) {
771   cat->threshold = threshold;
772   cat->isThreshInherited = 0;
773  
774   _set_inherited_thresholds(cat);
775  
776 }
777
778 static xbt_log_setting_t _xbt_log_parse_setting(const char* control_string) {
779
780   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t,1);
781   const char *name, *dot, *eq;
782   
783   set->catname=NULL;
784   set->thresh = xbt_log_priority_uninitialized;
785   set->fmt = NULL;
786   set->additivity = -1;
787
788   if (!*control_string) 
789     return set;
790   DEBUG1("Parse log setting '%s'",control_string);
791
792   control_string += strspn(control_string, " ");
793   name = control_string;
794   control_string += strcspn(control_string, ".= ");
795   dot = control_string;
796   control_string += strcspn(control_string, ":= ");
797   eq = control_string;
798   control_string += strcspn(control_string, " ");
799
800   xbt_assert1(*dot == '.' && (*eq == '=' || *eq == ':'),
801                "Invalid control string '%s'",control_string);
802
803   if (!strncmp(dot + 1, "thresh", (size_t)(eq - dot - 1))) {
804     int i;
805     char *neweq=xbt_strdup(eq+1);
806     char *p=neweq-1;
807     
808     while (*(++p) != '\0') {
809       if (*p >= 'a' && *p <= 'z') {
810         *p-='a'-'A';
811       }
812     }
813     
814     DEBUG1("New priority name = %s",neweq);
815     for (i=0; i<xbt_log_priority_infinite; i++) {
816       if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
817         DEBUG1("This is priority %d",i);
818         break;
819       }
820     }
821     if (i<xbt_log_priority_infinite) {
822       set->thresh= (e_xbt_log_priority_t) i;
823     } else {
824       THROW1(arg_error,0,
825              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",eq+1);
826     }
827     free(neweq);
828   } else if ( !strncmp(dot + 1, "add", (size_t)(eq - dot - 1)) ||
829               !strncmp(dot + 1, "additivity", (size_t)(eq - dot - 1)) ) {
830
831     char *neweq=xbt_strdup(eq+1);
832     char *p=neweq-1;
833     
834     while (*(++p) != '\0') {
835       if (*p >= 'a' && *p <= 'z') {
836         *p-='a'-'A';
837       }
838     }
839     if ( !strcmp(neweq,"ON") ||
840          !strcmp(neweq,"YES") ||
841          !strcmp(neweq,"1") ) {
842       set->additivity = 1;      
843     } else {
844       set->additivity = 0;      
845     }
846     free(neweq);
847   } else if (!strncmp(dot + 1, "fmt", (size_t)(eq - dot - 1))) {
848     set->fmt = xbt_strdup(eq+1);
849   } else {
850     char buff[512];
851     snprintf(buff,min(512,eq - dot),"%s",dot+1);
852     THROW1(arg_error,0,"Unknown setting of the log category: '%s'",buff);
853   }
854   set->catname=(char*)xbt_malloc(dot - name+1);
855     
856   memcpy(set->catname,name,dot-name);
857   set->catname[dot-name]='\0'; /* Just in case */
858   DEBUG1("This is for cat '%s'", set->catname);
859   
860   return set;
861 }
862
863 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
864   xbt_log_category_t child;
865   
866   if (!strcmp(cat->name,name)) 
867     return cat;
868
869   for(child=cat->firstChild ; child != NULL; child = child->nextSibling) 
870     return _xbt_log_cat_searchsub(child,name);
871   
872   THROW1(not_found_error,0,"No such category: %s", name);
873 }
874
875 /**
876  * \ingroup XBT_log  
877  * \param control_string What to parse
878  *
879  * Typically passed a command-line argument. The string has the syntax:
880  *
881  *      ( [category] "." [keyword] ":" value (" ")... )...
882  *
883  * where [category] is one the category names (see \ref XBT_log_cats for 
884  * a complete list of the ones defined in the SimGrid library)  
885  * and keyword is one of the following:
886  *
887  *    - thres: category's threshold priority. Possible values:
888  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
889  *    - add or additivity: whether the logging actions must be passed to 
890  *      the parent category. 
891  *      Possible values: 0, 1, no, yes, on, off.
892  *      Default value: yes.
893  *    - fmt: the format to use. See \ref log_lay for more information.
894  *            
895  */
896 void xbt_log_control_set(const char* control_string) {
897   xbt_log_setting_t set;
898
899   /* To split the string in commands, and the cursors */
900   xbt_dynar_t set_strings;
901   char *str;
902   int cpt;
903
904   if (!control_string)
905     return;
906   DEBUG1("Parse log settings '%s'",control_string);
907
908   /* some initialization if this is the first time that this get called */
909   if (xbt_log_settings == NULL)
910     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
911                                      _free_setting);
912
913   /* split the string, and remove empty entries */
914   set_strings=xbt_str_split_quoted(control_string);
915
916   if (xbt_dynar_length(set_strings) == 0) { /* vicious user! */
917     xbt_dynar_free(&set_strings);
918     return; 
919   }
920
921   /* Parse each entry and either use it right now (if the category was already
922      created), or store it for further use */
923   xbt_dynar_foreach(set_strings,cpt,str) {
924     xbt_log_category_t cat=NULL;
925     int found=0;
926     xbt_ex_t e;
927     
928     set = _xbt_log_parse_setting(str);
929
930     TRY {
931       cat = _xbt_log_cat_searchsub(&_XBT_LOGV(root),set->catname);
932       found = 1;
933     } CATCH(e) {
934       if (e.category != not_found_error)
935         RETHROW;
936       xbt_ex_free(e);
937       found = 0;
938     } 
939
940     if (found) {
941       DEBUG0("Apply directly");
942       _xbt_log_cat_apply_set(cat,set);
943       _free_setting((void*)&set);
944     } else {
945
946       DEBUG0("Store for further application");
947       DEBUG1("push %p to the settings",(void*)set);
948       xbt_dynar_push(xbt_log_settings,&set);
949     }
950   }
951   xbt_dynar_free(&set_strings);
952
953
954 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
955   if (cat->appender) {
956     if (cat->appender->free_)
957       cat->appender->free_(cat->appender);
958     free(cat->appender);
959   }
960   cat->appender = app;
961 }
962 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) {
963   if (!cat->appender) {
964     VERB1("No appender to category %s. Setting the file appender as default",
965           cat->name);
966     xbt_log_appender_set(cat,xbt_log_appender_file_new(NULL));
967   }
968   if (cat->layout && cat != &_XBT_LOGV(root)) {
969     /* better leak the default layout than check every categories to 
970        change it */
971     if (cat->layout->free_) {
972       cat->layout->free_(cat->layout);
973       free(cat->layout);
974     }
975   }
976   cat->layout = lay;
977   xbt_log_additivity_set(cat,0);
978 }
979
980 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) {
981   cat->additivity = additivity;
982 }
983