Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
eb9772ed9774979877044241c52b58d2fb110534
[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 /** \addtogroup XBT_log
27  *
28  *  This section describes the API to the log functions used 
29  *  everywhere in this project.
30
31 \section XBT_log_toc Table of contents
32  
33  - \ref log_overview
34    - \ref log_cat
35    - \ref log_pri
36    - \ref log_app
37    - \ref log_hist
38  - \ref log_API
39    - \ref log_API_cat
40    - \ref log_API_pri
41    - \ref log_API_subcat
42    - \ref log_API_easy
43    - \ref log_API_example
44  - \ref log_user
45    - \ref log_use_conf
46    - \ref log_use_misc
47  - \ref log_internals
48    - \ref log_in_perf
49    - \ref log_in_app
50  - \ref XBT_log_cats
51      
52 \section log_overview 1. Introduction
53
54 This module is in charge of handling the log messages of every SimGrid
55 program. The main design goal are:
56
57   - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and 
58     what to hide, as well as how messages get displayed.
59   - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
60     and to the user (with command line options)
61   - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
62   - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones, 
63     and the logging mecanism allows to syndicate each and every log source into the same place.
64     At least, its design would allow to, once we write the last missing pieces
65      
66 There is three main concepts in SimGrid's logging mecanism: <i>category</i>,
67 <i>priority</i> and <i>appender</i>. These three concepts work together to
68 enable developers to log messages according to message type and priority, and
69 to control at runtime how these messages are formatted and where they are
70 reported. 
71
72 \subsection log_cat 1.1 Category hierarchy
73
74 The first and foremost advantage of any logging API over plain printf()
75 resides in its ability to disable certain log statements while allowing
76 others to print unhindered. This capability assumes that the logging space,
77 that is, the space of all possible logging statements, is categorized
78 according to some developer-chosen criteria. 
79           
80 This observation led to choosing category as the central concept of the
81 system. In a certain sense, they can be considered as logging topics or
82 channels.
83
84 \subsection log_pri 1.2 Logging priorities
85
86 The user can naturally declare interest into this or that logging category, but
87 he also can specify the desired level of details for each of them. This is
88 controled by the <i>priority</i> concept (which should maybe be renamed to
89 <i>severity</i>). 
90
91 Empirically, the user can specify that he wants to see every debuging message
92 of GRAS while only being interested into the messages at level "error" or
93 higher about the XBT internals.
94
95 \subsection log_app 1.3 Message appenders
96
97 The message appenders are the elements in charge of actually displaying the
98 message to the user. For now, there is only one appender: the one able to print
99 stuff on stderr. But everything is in place internally to write new ones, such
100 as the one able to send the strings to a central server in charge of
101 syndicating the logs of every distributed daemons on a well known location.
102
103 It should also be possible to pass configuration informations to the appenders,
104 specifying for example that the message location (file and line number) is only
105 relevant to debugging information, not to critical error messages.
106
107 One day, for sure ;)
108
109 \subsection log_hist 1.4 History of this module
110
111 Historically, this module is an adaptation of the log4c project, which is dead
112 upstream, and which I was given the permission to fork under the LGPL licence
113 by the log4c's authors. The log4c project itself was loosely based on the
114 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
115 differs somehow from these projects anyway, because the C programming language
116 is not object oriented.
117
118 \section log_API 2. Programmer interface
119
120 \subsection log_API_cat 2.1 Constructing the category hierarchy
121
122 Every category is declared by providing a name and an optional
123 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
124 the category's parent. 
125       
126 A category is created by a macro call at the top level of a file.  A
127 category can be created with any one of the following macros:
128
129  - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
130  - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
131     Create a new category being child of the category ParentCat
132  - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
133     Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
134       in this file
135  -  \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
136     Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
137       in this file
138             
139 The parent cat can be defined in the same file or in another file (in
140 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
141 it visible in the current file), but each category may have only one
142 definition.
143       
144 Typically, there will be a Category for each module and sub-module, so you
145 can independently control logging for each module.
146
147 For a list of all existing categories, please refer to the \ref XBT_log_cats
148 section. This file is generated automatically from the SimGrid source code, so
149 it should be complete and accurate.
150
151 \section log_API_pri 2.2 Declaring message priority
152
153 A category may be assigned a threshold priorty. The set of priorites are
154 defined by the \ref e_xbt_log_priority_t enum. All logging request under
155 this priority will be discarded.
156           
157 If a given category is not assigned a threshold priority, then it inherits
158 one from its closest ancestor with an assigned threshold. To ensure that all
159 categories can eventually inherit a threshold, the root category always has
160 an assigned threshold priority.
161
162 Logging requests are made by invoking a logging macro on a category.  All of
163 the macros have a printf-style format string followed by arguments. If you
164 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
165 when you pass a pointer to a string where an integer was specified by the
166 format. This is usualy a good idea.
167
168 Because some C compilers do not support vararg macros, there is a version of
169 the macro for any number of arguments from 0 to 6. The macro name ends with
170 the total number of arguments.
171         
172 Here is an example of the most basic type of macro. This is a logging
173 request with priority <i>warning</i>.
174
175 <code>CLOG5(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
176 "oops");</code>
177
178 A logging request is said to be enabled if its priority is higher than or
179 equal to the threshold priority of its category. Otherwise, the request is
180 said to be disabled. A category without an assigned priority will inherit
181 one from the hierarchy. 
182       
183 It is possible to use any non-negative integer as a priority. If, as in the
184 example, one of the standard priorites is used, then there is a convenience
185 macro that is typically used instead. For example, the above example is
186 equivalent to the shorter:
187
188 <code>CWARN4(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
189
190 \section log_API_subcat 2.3 Using a default category (the easy interface)
191   
192 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
193 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
194 category, then the even shorter form can be used:
195
196 <code>WARN3("Values are: %d and '%s'", 5, "oops");</code>
197
198 Only one default category can be created per file, though multiple
199 non-defaults can be created and used.
200
201 \section log_API_easy 2.4 Putting all together: the easy interface
202
203 First of all, each module should register its own category into the categories
204 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
205
206 Then, logging should be done with the DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
207 ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB6,
208 #INFO8, #WARN6, #ERROR6 and #CRITICAL6). For each group, there is at
209 least 6 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
210 DEBUG5), only differing in the number of arguments passed along the format.
211 This is because we want SimGrid itself to keep compilable on ancient
212 compiler not supporting variable number of arguments to macros. But we
213 should provide a macro simpler to use for the users not interested in SP3
214 machines (FIXME).
215   
216 Under GCC, these macro check there arguments the same way than printf does. So,
217 if you compile with -Wall, the folliwing code will issue a warning:
218 <code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
219
220 If you want to specify the category to log onto (for example because you
221 have more than one category per file, add a C before the name of the log
222 producing macro (ie, use #CDEBUG10, #CVERB6, #CINFO8, #CWARN6, #CERROR6 and
223 #CCRITICAL6 and friends), and pass the category name as first argument.
224   
225 The TRACE priority is not used the same way than the other. You should use
226 the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
227 instead.
228
229 \section log_API_example 2.5 Example of use
230
231 Here is a more complete example:
232
233 \verbatim
234 #include "xbt/log.h"
235
236 / * create a category and a default subcategory * /
237 XBT_LOG_NEW_CATEGORY(VSS);
238 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
239
240 int main() {
241        / * Now set the parent's priority.  (the string would typcially be a runtime option) * /
242        xbt_log_control_set("SA.thresh=3");
243
244        / * This request is enabled, because WARNING &gt;= INFO. * /
245        CWARN2(VSS, "Low fuel level.");
246
247        / * This request is disabled, because DEBUG &lt; INFO. * /
248        CDEBUG2(VSS, "Starting search for nearest gas station.");
249
250        / * The default category SA inherits its priority from VSS. Thus,
251           the following request is enabled because INFO &gt;= INFO.  * /
252        INFO1("Located nearest gas station.");
253
254        / * This request is disabled, because DEBUG &lt; INFO. * /
255        DEBUG1("Exiting gas station search"); 
256 }
257 \endverbatim
258
259
260 \section log_user 3. User interface
261
262 \section log_use_conf 3.1 Configuration
263 Configuration is typically done during program initialization by invoking
264 the xbt_log_control_set() method. The control string passed to it typically
265 comes from the command line. Look at the documentation for that function for
266 the format of the control string.
267
268 Any SimGrid program can furthermore be configured at run time by passing a
269 --xbt-log argument on the command line (--gras-log, --msg-log and --surf-log
270 are synonyms provided by aestheticism). You can provide several of those
271 arguments to change the setting of several categories, they will be applied
272 from left to right. So, 
273 \verbatim --xbt-log="root.thres=debug root.thres=critical"\endverbatim 
274 should disable any logging.
275
276 Note that the quotes on above line are mandatory because there is a space in
277 the argument, so we are protecting ourselves from the shell, not from SimGrid.
278 We could also reach the same effect with this:
279 \verbatim --xbt-log=root.thres=debug --xbt-log=root.thres=critical\endverbatim 
280
281 \section log_use_misc 3.2 Misc and Caveats
282
283   - Do not use any of the macros that start with '_'.
284   - Log4J has a 'rolling file appender' which you can select with a run-time
285     option and specify the max file size. This would be a nice default for
286     non-kernel applications.
287   - Careful, category names are global variables.
288
289 \section log_internals 4. Internal considerations
290
291 This module is a mess of macro black magic, and when it goes wrong, SimGrid
292 studently loose its ability to explain its problems. When messing around this
293 module, I often find useful to define XBT_LOG_MAYDAY (which turns it back to
294 good old printf) for the time of finding what's going wrong.
295
296 \section log_in_perf 4.1 Performance
297
298 Except for the first invocation of a given category, a disabled logging request
299 requires an a single comparison of a static variable to a constant.
300
301 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
302 causes all logging requests with a lower priority to be optimized to 0 cost
303 by the compiler. By setting it to gras_log_priority_infinite, all logging
304 requests are statically disabled and cost nothing. Released executables
305 might be compiled with
306 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
307
308 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging 
309 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables 
310 the requests of priority below INFO.
311
312 \todo Logging performance *may* be improved further by improving the message
313 propagation from appender to appender in the category tree.
314
315 \section log_in_app 4.2 Appenders
316
317 Each category has an optional appender. An appender is a pointer to a
318 structure which starts with a pointer to a doAppend() function. DoAppend()
319 prints a message to a log.
320
321 When a category is passed a message by one of the logging macros, the
322 category performs the following actions:
323
324   - if the category has an appender, the message is passed to the
325     appender's doAppend() function,
326   - if 'willLogToParent' is true for the category, the message is passed
327     to the category's parent.
328     
329 By default, only the root category have an appender, and 'willLogToParent'
330 is true for any other category. This situation causes all messages to be
331 logged by the root category's appender.
332
333 The default appender function currently prints to stderr, and no other one
334 exist, even if more would be needed, like the one able to send the logs to a
335 remote dedicated server, or other ones offering different output formats.
336 This is on our TODO list for quite a while now, but your help would be
337 welcome here, too.
338
339
340 */
341
342
343 typedef struct {
344   char *catname;
345   e_xbt_log_priority_t thresh;
346 } s_xbt_log_setting_t,*xbt_log_setting_t;
347
348 static xbt_dynar_t xbt_log_settings=NULL;
349 static void _free_setting(void *s) {
350   xbt_log_setting_t set=(xbt_log_setting_t)s;
351   if (set) {
352     free(set->catname);
353 /*    free(set); FIXME: uncommenting this leads to segfault when more than one chunk is passed as gras-log */
354   }
355 }
356
357 const char *xbt_log_priority_names[8] = {
358   "NONE",
359   "TRACE",
360   "DEBUG",
361   "VERBOSE",
362   "INFO",
363   "WARNING",
364   "ERROR",
365   "CRITICAL"
366 };
367
368 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
369   0, 0, 0,
370   "root", xbt_log_priority_uninitialized, 0,
371   NULL, 0
372 };
373
374 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
375 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
376 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
377 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
378
379 void xbt_log_init(int *argc,char **argv) {
380   int i,j;
381   char *opt;
382
383   /* Set logs and init log submodule */
384   for (i=1; i<*argc; i++) {
385     if (!strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
386         !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
387         !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
388         !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))) {
389       opt=strchr(argv[i],'=');
390       opt++;
391       xbt_log_control_set(opt);
392       DEBUG1("Did apply '%s' as log setting",opt);
393       /*remove this from argv*/
394       for (j=i+1; j<*argc; j++) {
395         argv[j-1] = argv[j];
396       } 
397       argv[j-1] = NULL;
398       (*argc)--;
399       i--; /* compensate effect of next loop incrementation */
400     }
401   }
402 }
403
404 void xbt_log_exit(void) {
405   VERB0("Exiting log");
406   xbt_dynar_free(&xbt_log_settings);
407   VERB0("Exited log");
408 }
409
410 static void _apply_control(xbt_log_category_t cat) {
411   int cursor;
412   xbt_log_setting_t setting=NULL;
413   int found = 0;
414   s_xbt_log_event_t _log_ev;
415
416   if (!xbt_log_settings)
417     return;
418
419   xbt_assert0(cat,"NULL category");
420   xbt_assert(cat->name);
421
422   xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
423     xbt_assert0(setting,"Damnit, NULL cat in the list");
424     xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
425
426     if (!strcmp(setting->catname,cat->name)) {
427       found = 1;
428
429       xbt_log_threshold_set(cat, setting->thresh);
430       xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
431
432       if (cat->threshold <= xbt_log_priority_debug)
433       {
434         /*s_xbt_log_event_t _log_ev ={cat, xbt_log_priority_debug,__FILE__,_XBT_FUNCTION,__LINE__};*/
435
436         _log_ev.cat = cat;
437         _log_ev.priority = xbt_log_priority_debug;
438         _log_ev.fileName = __FILE__ ;
439         _log_ev.functionName = _XBT_FUNCTION ;
440         _log_ev.lineNum = __LINE__ ;
441
442         _xbt_log_event_log(&_log_ev,
443                  "Apply settings for category '%s': set threshold to %s (=%d)",
444                  cat->name,
445                  xbt_log_priority_names[cat->threshold], cat->threshold);
446       }
447     }
448   }
449   if (!found && cat->threshold <= xbt_log_priority_verbose) {
450     /* s_xbt_log_event_t _log_ev ={cat,xbt_log_priority_verbose,__FILE__,_XBT_FUNCTION,__LINE__}; */
451     _log_ev.cat = cat;
452         _log_ev.priority = xbt_log_priority_verbose;
453         _log_ev.fileName = __FILE__ ;
454         _log_ev.functionName = _XBT_FUNCTION ;
455         _log_ev.lineNum = __LINE__ ;
456
457     _xbt_log_event_log(&_log_ev,
458                         "Category '%s': inherited threshold = %s (=%d)",
459                         cat->name,
460                         xbt_log_priority_names[cat->threshold], cat->threshold);
461   }
462
463 }
464
465 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
466   xbt_log_category_t cat = ev->cat;
467   va_start(ev->ap, fmt);
468   while(1) {
469     xbt_log_appender_t appender = cat->appender;
470     if (appender != NULL) {
471       appender->do_append(appender, ev, fmt);
472     }
473     if (!cat->willLogToParent)
474       break;
475
476     cat = cat->parent;
477   } 
478   va_end(ev->ap);
479 }
480
481 static void _cat_init(xbt_log_category_t category) {
482   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
483     category->threshold = xbt_log_priority_info;
484     category->appender = xbt_log_default_appender;
485   } else {
486     xbt_log_parent_set(category, category->parent);
487   }
488   _apply_control(category);
489 }
490
491 /*
492  * This gets called the first time a category is referenced and performs the
493  * initialization. 
494  * Also resets threshold to inherited!
495  */
496 int _xbt_log_cat_init(e_xbt_log_priority_t priority,
497                        xbt_log_category_t   category) {
498     
499   _cat_init(category);
500         
501   return priority >= category->threshold;
502 }
503
504 void xbt_log_parent_set(xbt_log_category_t cat,
505                          xbt_log_category_t parent) {
506
507   xbt_assert0(cat,"NULL category to be given a parent");
508   xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
509
510   /* unlink from current parent */
511   if (cat->threshold != xbt_log_priority_uninitialized) {
512     xbt_log_category_t* cpp = &parent->firstChild;
513     while(*cpp != cat && *cpp != NULL) {
514       cpp = &(*cpp)->nextSibling;
515     }
516     xbt_assert(*cpp == cat);
517     *cpp = cat->nextSibling;
518   }
519
520   /* Set new parent */
521   cat->parent = parent;
522   cat->nextSibling = parent->firstChild;
523   parent->firstChild = cat;
524
525   /* Make sure parent is initialized */
526   if (parent->threshold == xbt_log_priority_uninitialized) {
527     _cat_init(parent);
528   }
529     
530   /* Reset priority */
531   cat->threshold = parent->threshold;
532   cat->isThreshInherited = 1;
533 } /* log_setParent */
534
535 static void _set_inherited_thresholds(xbt_log_category_t cat) {
536   xbt_log_category_t child = cat->firstChild;
537   for( ; child != NULL; child = child->nextSibling) {
538     if (child->isThreshInherited) {
539       if (cat != &_XBT_LOGV(log))
540         VERB3("Set category threshold of %s to %s (=%d)",
541               child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
542       child->threshold = cat->threshold;
543       _set_inherited_thresholds(child);
544     }
545   }
546 }
547
548 void xbt_log_threshold_set(xbt_log_category_t   cat,
549                             e_xbt_log_priority_t threshold) {
550   cat->threshold = threshold;
551   cat->isThreshInherited = 0;
552   _set_inherited_thresholds(cat);
553 }
554
555 static void _xbt_log_parse_setting(const char*        control_string,
556                                     xbt_log_setting_t set) {
557   const char *name, *dot, *eq;
558   
559   set->catname=NULL;
560   if (!*control_string) 
561     return;
562   DEBUG1("Parse log setting '%s'",control_string);
563
564   control_string += strspn(control_string, " ");
565   name = control_string;
566   control_string += strcspn(control_string, ".= ");
567   dot = control_string;
568   control_string += strcspn(control_string, "= ");
569   eq = control_string;
570   control_string += strcspn(control_string, " ");
571
572   xbt_assert1(*dot == '.' && *eq == '=',
573                "Invalid control string '%s'",control_string);
574
575   if (!strncmp(dot + 1, "thresh", min((size_t)(eq - dot - 1),strlen("thresh")))) {
576     int i;
577     char *neweq=xbt_strdup(eq+1);
578     char *p=neweq-1;
579     
580     while (*(++p) != '\0') {
581       if (*p >= 'a' && *p <= 'z') {
582         *p-='a'-'A';
583       }
584     }
585     
586     DEBUG1("New priority name = %s",neweq);
587     for (i=0; i<xbt_log_priority_infinite-1; i++) {
588       if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
589         DEBUG1("This is priority %d",i);
590         break;
591       }
592     }
593     if (i<xbt_log_priority_infinite-1) {
594       set->thresh= (e_xbt_log_priority_t) i;
595     } else {
596       xbt_assert1(FALSE,"Unknown priority name: %s",eq+1);
597     }
598     free(neweq);
599   } else {
600     char buff[512];
601     snprintf(buff,min(512,eq - dot - 1),"%s",dot+1);
602     xbt_assert1(FALSE,"Unknown setting of the log category: %s",buff);
603   }
604   set->catname=(char*)xbt_malloc(dot - name+1);
605     
606   strncpy(set->catname,name,dot-name);
607   set->catname[dot-name]='\0'; /* Just in case */
608   DEBUG1("This is for cat '%s'", set->catname);
609 }
610
611 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
612   xbt_log_category_t child;
613   
614   if (!strcmp(cat->name,name)) {
615     return cat;
616   }
617   for(child=cat->firstChild ; child != NULL; child = child->nextSibling) {
618     return _xbt_log_cat_searchsub(child,name);
619   }
620   THROW0(not_found_error,0,"No such category");
621 }
622
623 static void _cleanup_double_spaces(char *s) {
624   char *p = s;
625   int   e = 0;
626   
627   while (1) {
628     if (!*p)
629       goto end;
630     
631     if (!isspace(*p))
632       break;
633     
634     p++;
635   }
636   
637   e = 1;
638   
639   do {
640     if (e)
641       *s++ = *p;
642     
643     if (!*++p)
644       goto end;
645     
646     if (e ^ !isspace(*p))
647       if ((e = !e))
648         *s++ = ' ';
649   } while (1);
650
651  end:
652   *s = '\0';
653 }
654
655 /**
656  * \ingroup XBT_log  
657  * \param control_string What to parse
658  *
659  * Typically passed a command-line argument. The string has the syntax:
660  *
661  *      ( [category] "." [keyword] "=" value (" ")... )...
662  *
663  * where [category] is one the category names (see \ref XBT_log_cats for a complete list) 
664  * and keyword is one of the following:
665  *
666  *    - thres: category's threshold priority. Possible values:
667  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
668  *             
669  *
670  * \warning
671  * This routine may only be called once and that must be before any other
672  * logging command! Typically, this is done from main().
673  * \todo the previous warning seems a bit old and need double checking
674  */
675 void xbt_log_control_set(const char* control_string) {
676   xbt_log_setting_t set;
677   char *cs;
678   char *p;
679   int done = 0;
680   
681   DEBUG1("Parse log settings '%s'",control_string);
682   if (control_string == NULL)
683     return;
684   if (xbt_log_settings == NULL)
685     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
686                                        _free_setting);
687
688   set = xbt_new(s_xbt_log_setting_t,1);
689   cs=xbt_strdup(control_string);
690
691   _cleanup_double_spaces(cs);
692
693   while (!done) {
694     xbt_log_category_t cat=NULL;
695     int found=0;
696     xbt_ex_t e;
697     
698     p=strrchr(cs,' ');
699     if (p) {
700       *p='\0';
701       p++;
702     } else {
703       p=cs;
704       done = 1;
705     }
706     _xbt_log_parse_setting(p,set);
707
708     TRY {
709       cat = _xbt_log_cat_searchsub(&_XBT_LOGV(root),set->catname);
710       found = 1;
711     } CATCH(e) {
712       if (e.category != not_found_error)
713         RETHROW;
714       xbt_ex_free(e);
715       found = 0;
716
717       DEBUG0("Store for further application");
718       DEBUG1("push %p to the settings",(void*)set);
719       xbt_dynar_push(xbt_log_settings,&set);
720       /* malloc in advance the next slot */
721       set = xbt_new(s_xbt_log_setting_t,1);
722     } 
723
724     if (found) {
725       DEBUG0("Apply directly");
726       free(set->catname);
727       xbt_log_threshold_set(cat,set->thresh);
728     }
729   }
730   free(set);
731   free(cs);
732
733
734 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
735   cat->appender = app;
736 }
737