Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
91da92ed9495e542eec877c7115e0c91e14d8b31
[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
350 static void _free_setting(void *s) {
351   xbt_log_setting_t set=(xbt_log_setting_t)s;
352   if (set) {
353     free(set->catname);
354 /*    free(set); FIXME: uncommenting this leads to segfault when more than one chunk is passed as gras-log */
355   }
356 }
357
358 const char *xbt_log_priority_names[8] = {
359   "NONE",
360   "TRACE",
361   "DEBUG",
362   "VERBOSE",
363   "INFO",
364   "WARNING",
365   "ERROR",
366   "CRITICAL"
367 };
368
369 XBT_PUBLIC_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
370   0, 0, 0,
371   "root", xbt_log_priority_uninitialized, 0,
372   NULL, 0
373 };
374
375 XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
376 XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
377 XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
378 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
379
380 void xbt_log_init(int *argc,char **argv) {
381         int i,j;
382         char *opt;
383         
384         /* Set logs and init log submodule */
385         for (i=1; i<*argc; i++){
386                 if (!strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
387                         !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
388                         !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
389                         !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
390                                 
391                                 opt=strchr(argv[i],'=');
392                                 opt++;
393                                 xbt_log_control_set(opt);
394                                 DEBUG1("Did apply '%s' as log setting",opt);
395                                 /*remove this from argv*/
396                                 
397                                 for (j=i+1; j<*argc; j++){
398                                         argv[j-1] = argv[j];
399                                 } 
400                                 
401                                 argv[j-1] = NULL;
402                                 (*argc)--;
403                                 i--; /* compensate effect of next loop incrementation */
404                 }
405         }
406 }
407
408 void xbt_log_exit(void) {
409   VERB0("Exiting log");
410   xbt_dynar_free(&xbt_log_settings);
411   VERB0("Exited log");
412 }
413
414 static void _apply_control(xbt_log_category_t cat) {
415   int cursor;
416   xbt_log_setting_t setting=NULL;
417   int found = 0;
418   s_xbt_log_event_t _log_ev;
419   
420   
421   if (!xbt_log_settings)
422     return;
423
424   xbt_assert0(cat,"NULL category");
425   xbt_assert(cat->name);
426
427   xbt_dynar_foreach(xbt_log_settings,cursor,setting) {
428     xbt_assert0(setting,"Damnit, NULL cat in the list");
429     xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
430
431     if (!strcmp(setting->catname,cat->name)) {
432         
433     
434       found = 1;
435
436       xbt_log_threshold_set(cat, setting->thresh);
437       xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
438
439
440       if (cat->threshold <= xbt_log_priority_debug) {
441         _log_ev.cat = cat;
442         _log_ev.priority = xbt_log_priority_debug;
443         _log_ev.fileName = __FILE__ ;
444         _log_ev.functionName = _XBT_FUNCTION ;
445         _log_ev.lineNum = __LINE__ ;
446
447         _xbt_log_event_log(&_log_ev,
448                  "Apply settings for category '%s': set threshold to %s (=%d)",
449                  cat->name,
450                  xbt_log_priority_names[cat->threshold], cat->threshold);
451       }
452     }
453    
454   }
455   
456   if (!found && cat->threshold <= xbt_log_priority_verbose) {
457         
458     _log_ev.cat = cat;
459     _log_ev.priority = xbt_log_priority_verbose;
460     _log_ev.fileName = __FILE__ ;
461     _log_ev.functionName = _XBT_FUNCTION ;
462     _log_ev.lineNum = __LINE__ ;
463
464     _xbt_log_event_log(&_log_ev,
465                         "Category '%s': inherited threshold = %s (=%d)",
466                         cat->name,
467                         xbt_log_priority_names[cat->threshold], cat->threshold);
468   }
469   
470  
471
472 }
473
474 void _xbt_log_event_log( xbt_log_event_t ev, const char *fmt, ...) {
475   xbt_log_category_t cat = ev->cat;
476   va_start(ev->ap, fmt);
477   while(1) {
478     xbt_log_appender_t appender = cat->appender;
479     if (appender != NULL) {
480       appender->do_append(appender, ev, fmt);
481     }
482     if (!cat->willLogToParent)
483       break;
484
485     cat = cat->parent;
486   } 
487   va_end(ev->ap);
488 }
489
490 static void _cat_init(xbt_log_category_t category) 
491 {
492         
493         if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
494         category->threshold = xbt_log_priority_info;
495         category->appender = xbt_log_default_appender;
496         } 
497         else 
498         {
499                 #if (defined(_WIN32) && !defined(DLL_STATIC))
500                 if(!category->parent)
501                         category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
502                 #endif
503         
504         xbt_log_parent_set(category, category->parent);
505         }
506   
507   _apply_control(category);
508  
509 }
510
511 /*
512  * This gets called the first time a category is referenced and performs the
513  * initialization. 
514  * Also resets threshold to inherited!
515  */
516 int _xbt_log_cat_init(e_xbt_log_priority_t priority,xbt_log_category_t category) 
517 {
518     
519         _cat_init(category);
520         
521         return priority >= category->threshold;
522 }
523
524 void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent) 
525 {
526         xbt_assert0(cat,"NULL category to be given a parent");
527         xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
528         
529         /* 
530          * if the threshold is initialized 
531          * unlink from current parent 
532          */
533         if(cat->threshold != xbt_log_priority_uninitialized){
534
535                 xbt_log_category_t* cpp = &parent->firstChild;
536         
537                 while(*cpp != cat && *cpp != NULL) {
538                         cpp = &(*cpp)->nextSibling;
539                 }
540                 
541                 xbt_assert(*cpp == cat);
542                 *cpp = cat->nextSibling;
543         }
544         
545         cat->parent = parent;
546         cat->nextSibling = parent->firstChild;
547         
548         parent->firstChild = cat;
549         
550         if (parent->threshold == xbt_log_priority_uninitialized){
551                 
552                 _cat_init(parent);
553         }
554         
555         cat->threshold = parent->threshold;
556         
557         cat->isThreshInherited = 1;
558         
559 } /* log_setParent */
560
561 static void _set_inherited_thresholds(xbt_log_category_t cat) {
562   xbt_log_category_t child = cat->firstChild;
563   for( ; child != NULL; child = child->nextSibling) {
564     if (child->isThreshInherited) {
565       if (cat != &_XBT_LOGV(log))
566         VERB3("Set category threshold of %s to %s (=%d)",
567               child->name,xbt_log_priority_names[cat->threshold],cat->threshold);
568       child->threshold = cat->threshold;
569       _set_inherited_thresholds(child);
570     }
571   }
572 }
573
574 void xbt_log_threshold_set(xbt_log_category_t   cat,
575                             e_xbt_log_priority_t threshold) {
576   cat->threshold = threshold;
577   cat->isThreshInherited = 0;
578   _set_inherited_thresholds(cat);
579 }
580
581 static void _xbt_log_parse_setting(const char*        control_string,
582                                     xbt_log_setting_t set) {
583   const char *name, *dot, *eq;
584   
585   set->catname=NULL;
586   if (!*control_string) 
587     return;
588   DEBUG1("Parse log setting '%s'",control_string);
589
590   control_string += strspn(control_string, " ");
591   name = control_string;
592   control_string += strcspn(control_string, ".= ");
593   dot = control_string;
594   control_string += strcspn(control_string, "= ");
595   eq = control_string;
596   control_string += strcspn(control_string, " ");
597
598   xbt_assert1(*dot == '.' && *eq == '=',
599                "Invalid control string '%s'",control_string);
600
601   if (!strncmp(dot + 1, "thresh", min((size_t)(eq - dot - 1),strlen("thresh")))) {
602     int i;
603     char *neweq=xbt_strdup(eq+1);
604     char *p=neweq-1;
605     
606     while (*(++p) != '\0') {
607       if (*p >= 'a' && *p <= 'z') {
608         *p-='a'-'A';
609       }
610     }
611     
612     DEBUG1("New priority name = %s",neweq);
613     for (i=0; i<xbt_log_priority_infinite; i++) {
614       if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
615         DEBUG1("This is priority %d",i);
616         break;
617       }
618     }
619     if (i<xbt_log_priority_infinite) {
620       set->thresh= (e_xbt_log_priority_t) i;
621     } else {
622       xbt_assert1(FALSE,"Unknown priority name: %s",eq+1);
623     }
624     free(neweq);
625   } else {
626     char buff[512];
627     snprintf(buff,min(512,eq - dot - 1),"%s",dot+1);
628     xbt_assert1(FALSE,"Unknown setting of the log category: %s",buff);
629   }
630   set->catname=(char*)xbt_malloc(dot - name+1);
631     
632   strncpy(set->catname,name,dot-name);
633   set->catname[dot-name]='\0'; /* Just in case */
634   DEBUG1("This is for cat '%s'", set->catname);
635 }
636
637 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,char *name) {
638   xbt_log_category_t child;
639   
640   if (!strcmp(cat->name,name)) {
641     return cat;
642   }
643   for(child=cat->firstChild ; child != NULL; child = child->nextSibling) {
644     return _xbt_log_cat_searchsub(child,name);
645   }
646   THROW0(not_found_error,0,"No such category");
647 }
648
649 static void _cleanup_double_spaces(char *s) {
650   char *p = s;
651   int   e = 0;
652   
653   while (1) {
654     if (!*p)
655       goto end;
656     
657     if (!isspace(*p))
658       break;
659     
660     p++;
661   }
662   
663   e = 1;
664   
665   do {
666     if (e)
667       *s++ = *p;
668     
669     if (!*++p)
670       goto end;
671     
672     if (e ^ !isspace(*p))
673       if ((e = !e))
674         *s++ = ' ';
675   } while (1);
676
677  end:
678   *s = '\0';
679 }
680
681 /**
682  * \ingroup XBT_log  
683  * \param control_string What to parse
684  *
685  * Typically passed a command-line argument. The string has the syntax:
686  *
687  *      ( [category] "." [keyword] "=" value (" ")... )...
688  *
689  * where [category] is one the category names (see \ref XBT_log_cats for a complete list) 
690  * and keyword is one of the following:
691  *
692  *    - thres: category's threshold priority. Possible values:
693  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
694  *             
695  *
696  * \warning
697  * This routine may only be called once and that must be before any other
698  * logging command! Typically, this is done from main().
699  * \todo the previous warning seems a bit old and need double checking
700  */
701 void xbt_log_control_set(const char* control_string) {
702   xbt_log_setting_t set;
703   char *cs;
704   char *p;
705   int done = 0;
706   
707   DEBUG1("Parse log settings '%s'",control_string);
708   if (control_string == NULL)
709     return;
710   if (xbt_log_settings == NULL)
711     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
712                                        _free_setting);
713
714   set = xbt_new(s_xbt_log_setting_t,1);
715   cs=xbt_strdup(control_string);
716
717   _cleanup_double_spaces(cs);
718
719   while (!done) {
720     xbt_log_category_t cat=NULL;
721     int found=0;
722     xbt_ex_t e;
723     
724     p=strrchr(cs,' ');
725     if (p) {
726       *p='\0';
727       p++;
728     } else {
729       p=cs;
730       done = 1;
731     }
732     _xbt_log_parse_setting(p,set);
733
734     TRY {
735       cat = _xbt_log_cat_searchsub(&_XBT_LOGV(root),set->catname);
736       found = 1;
737     } CATCH(e) {
738       if (e.category != not_found_error)
739         RETHROW;
740       xbt_ex_free(e);
741       found = 0;
742
743       DEBUG0("Store for further application");
744       DEBUG1("push %p to the settings",(void*)set);
745       xbt_dynar_push(xbt_log_settings,&set);
746       /* malloc in advance the next slot */
747       set = xbt_new(s_xbt_log_setting_t,1);
748     } 
749
750     if (found) {
751       DEBUG0("Apply directly");
752       free(set->catname);
753       xbt_log_threshold_set(cat,set->thresh);
754     }
755   }
756   free(set);
757   free(cs);
758
759
760 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app) {
761   cat->appender = app;
762 }
763