Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
28e25061b7907834d2a68ea7bbb7387c38c459b0
[simgrid.git] / src / xbt / log.c
1 /* log - a generic logging facility in the spirit of log4j                  */
2
3 /* Copyright (c) 2004-2014. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #include <stdarg.h>
10 #include <ctype.h>
11 #include <stdio.h>              /* snprintf */
12 #include <stdlib.h>             /* snprintf */
13
14 #include "portable.h"           /* to get a working stdarg.h */
15
16 #include "xbt_modinter.h"
17
18 #include "xbt/misc.h"
19 #include "xbt/ex.h"
20 #include "xbt/str.h"
21 #include "xbt/sysdep.h"
22 #include "xbt/log_private.h"
23 #include "xbt/dynar.h"
24 #include "xbt/xbt_os_thread.h"
25
26 int xbt_log_no_loc = 0;         /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
27 static xbt_os_rmutex_t log_cat_init_mutex = NULL;
28
29 /** \addtogroup XBT_log
30  *
31  *  This section describes the API to the log functions used
32  *  everywhere in this project.
33
34 \section XBT_log_toc Table of contents
35
36  - \ref log_overview
37    - \ref log_cat
38    - \ref log_pri
39    - \ref log_app
40    - \ref log_hist
41  - \ref log_API
42    - \ref log_API_cat
43    - \ref log_API_pri
44    - \ref log_API_isenabled
45    - \ref log_API_subcat
46    - \ref log_API_easy
47    - \ref log_API_example
48  - \ref log_user
49    - \ref log_use_conf
50      - \ref log_use_conf_thres
51      - \ref log_use_conf_multi
52      - \ref log_use_conf_fmt
53      - \ref log_use_conf_app
54      - \ref log_use_conf_add
55    - \ref log_use_misc
56  - \ref log_internals
57    - \ref log_in_perf
58    - \ref log_in_app
59  - \ref XBT_log_cats
60
61 \section log_overview 1. Introduction
62
63 This module is in charge of handling the log messages of every SimGrid
64 program. The main design goal are:
65
66   - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
67     what to hide, as well as how messages get displayed.
68   - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
69     and to the user (with command line options)
70   - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
71   - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
72     and the logging mechanism allows to syndicate each and every log source into the same place.
73     At least, its design would allow to, once we write the last missing pieces
74
75 There is three main concepts in SimGrid's logging mechanism: <i>category</i>,
76 <i>priority</i> and <i>appender</i>. These three concepts work together to
77 enable developers to log messages according to message type and priority, and
78 to control at runtime how these messages are formatted and where they are
79 reported.
80
81 \subsection log_cat 1.1 Category hierarchy
82
83 The first and foremost advantage of any logging API over plain printf()
84 resides in its ability to disable certain log statements while allowing
85 others to print unhindered. This capability assumes that the logging space,
86 that is, the space of all possible logging statements, is categorized
87 according to some developer-chosen criteria.
88
89 This observation led to choosing category as the central concept of the
90 system. In a certain sense, they can be considered as logging topics or
91 channels.
92
93 \subsection log_pri 1.2 Logging priorities
94
95 The user can naturally declare interest into this or that logging category, but
96 he also can specify the desired level of details for each of them. This is
97 controlled by the <i>priority</i> concept (which should maybe be renamed to
98 <i>severity</i>).
99
100 Empirically, the user can specify that he wants to see every debugging message
101 of MSG while only being interested into the messages at level "error" or
102 higher about the XBT internals.
103
104 \subsection log_app 1.3 Message appenders
105
106 The message appenders are the elements in charge of actually displaying the
107 message to the user. For now, four appenders exist: 
108 - the default one prints stuff on stderr 
109 - file sends the data to a single file
110 - rollfile overwrites the file when the file grows too large
111 - splitfile creates new files with a specific maximum size
112
113 Other are planed (such as the one sending everything to a remote server) 
114 One day, for sure ;)
115
116 \subsection log_lay 1.4 Message layouts
117
118 The message layouts are the elements in charge of choosing how each message
119 will look like. Their result is a string which is then passed to the appender
120 attached to the category to be displayed.
121
122 For now, there is two layouts: The simple one, which is good for most cases,
123 and another one allowing users to specify the format they want.
124 \ref log_use_conf provides more info on this.
125
126 \subsection log_hist 1.5 History of this module
127
128 Historically, this module is an adaptation of the log4c project, which is dead
129 upstream, and which I was given the permission to fork under the LGPL licence
130 by the log4c's authors. The log4c project itself was loosely based on the
131 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
132 differs somehow from these projects anyway, because the C programming language
133 is not object oriented.
134
135 \section log_API 2. Programmer interface
136
137 \subsection log_API_cat 2.1 Constructing the category hierarchy
138
139 Every category is declared by providing a name and an optional
140 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
141 the category's parent.
142
143 A category is created by a macro call at the top level of a file.  A
144 category can be created with any one of the following macros:
145
146  - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
147  - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
148     Create a new category being child of the category ParentCat
149  - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
150     Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
151       in this file
152  -  \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
153     Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
154       in this file
155
156 The parent cat can be defined in the same file or in another file (in
157 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
158 it visible in the current file), but each category may have only one
159 definition. Likewise, you can use a category defined in another file as 
160 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
161
162 Typically, there will be a Category for each module and sub-module, so you
163 can independently control logging for each module.
164
165 For a list of all existing categories, please refer to the \ref XBT_log_cats
166 section. This file is generated automatically from the SimGrid source code, so
167 it should be complete and accurate.
168
169 \section log_API_pri 2.2 Declaring message priority
170
171 A category may be assigned a threshold priority. The set of priorities are
172 defined by the \ref e_xbt_log_priority_t enum. All logging request under
173 this priority will be discarded.
174
175 If a given category is not assigned a threshold priority, then it inherits
176 one from its closest ancestor with an assigned threshold. To ensure that all
177 categories can eventually inherit a threshold, the root category always has
178 an assigned threshold priority.
179
180 Logging requests are made by invoking a logging macro on a category.  All of
181 the macros have a printf-style format string followed by arguments. If you
182 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
183 when you pass a pointer to a string where an integer was specified by the
184 format. This is usually a good idea.
185
186 Here is an example of the most basic type of macro. This is a logging
187 request with priority <i>warning</i>.
188
189 <code>XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5,
190 "oops");</code>
191
192 A logging request is said to be enabled if its priority is higher than or
193 equal to the threshold priority of its category. Otherwise, the request is
194 said to be disabled. A category without an assigned priority will inherit
195 one from the hierarchy.
196
197 It is possible to use any non-negative integer as a priority. If, as in the
198 example, one of the standard priorities is used, then there is a convenience
199 macro that is typically used instead. For example, the above example is
200 equivalent to the shorter:
201
202 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
203
204 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
205
206 It is sometimes useful to check whether a particular category is
207 enabled at a particular priority. One example is when you want to do
208 some extra computation to prepare a nice debugging message. There is
209 no use of doing so if the message won't be used afterward because
210 debugging is turned off.
211
212 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
213
214 \section log_API_subcat 2.4 Using a default category (the easy interface)
215
216 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
217 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
218 category, then the even shorter form can be used:
219
220 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
221
222 Only one default category can be created per file, though multiple
223 non-defaults can be created and used.
224
225 \section log_API_easy 2.5 Putting all together: the easy interface
226
227 First of all, each module should register its own category into the categories
228 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
229
230 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
231 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
232
233 Under GCC, these macro check there arguments the same way than printf does. So,
234 if you compile with -Wall, the following code will issue a warning:
235 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
236
237 If you want to specify the category to log onto (for example because you
238 have more than one category per file, add a C before the name of the log
239 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
240 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
241 first argument.
242
243 The TRACE priority is not used the same way than the other. You should use
244 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
245
246 \section log_API_example 2.6 Example of use
247
248 Here is a more complete example:
249
250 \verbatim
251 #include "xbt/log.h"
252
253 / * create a category and a default subcategory * /
254 XBT_LOG_NEW_CATEGORY(VSS);
255 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
256
257 int main() {
258        / * Now set the parent's priority.  (the string would typically be a runtime option) * /
259        xbt_log_control_set("SA.thresh:3");
260
261        / * This request is enabled, because WARNING >= INFO. * /
262        XBT_CWARN(VSS, "Low fuel level.");
263
264        / * This request is disabled, because DEBUG < INFO. * /
265        XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
266
267        / * The default category SA inherits its priority from VSS. Thus,
268           the following request is enabled because INFO >= INFO.  * /
269        XBT_INFO("Located nearest gas station.");
270
271        / * This request is disabled, because DEBUG < INFO. * /
272        XBT_DEBUG("Exiting gas station search");
273 }
274 \endverbatim
275
276 \section log_user 3. User interface
277
278 \section log_use_conf 3.1 Configuration
279
280 Although rarely done, it is possible to configure the logs during
281 program initialization by invoking the xbt_log_control_set() method
282 manually. A more conventional way is to use the --log command line
283 argument. xbt_init() (called by MSG_init() and friends)
284 checks and deals properly with such arguments.
285
286 \subsection log_use_conf_thres 3.1.1 Threshold configuration
287
288 The most common setting is to control which logging event will get
289 displayed by setting a threshold to each category through the
290 <tt>threshold</tt> keyword.
291
292 For example, \verbatim --log=root.threshold:debug\endverbatim will make
293 SimGrid <b>extremely</b> verbose while \verbatim
294 --log=root.thres:critical\endverbatim should shut it almost
295 completely off.
296
297 Note that the <tt>threshold</tt> keyword can be abbreviated here. For example,
298 all the following notations have the same result.
299 \verbatim
300 --log=root.threshold:debug
301 --log=root.threshol:debug
302 --log=root.thresho:debug
303 --log=root.thresh:debug
304 --log=root.thres:debug
305 --log=root.thre:debug
306 --log=root.thr:debug
307 --log=root.th:debug
308 --log=root.t:debug
309 --log=root.:debug     <--- That's obviously really ugly, but it actually works.
310 \endverbatim
311
312 The full list of recognized thresholds is the following:
313
314  - trace: enter and return of some functions
315  - debug: crufty output
316  - verbose: verbose output for the user wanting more
317  - info: output about the regular functionning
318  - warning: minor issue encountered
319  - error: issue encountered
320  - critical: major issue encountered 
321
322 \subsection log_use_conf_multi 3.1.2 Passing several settings
323
324 You can provide several of those arguments to change the setting of several
325 categories, they will be applied from left to right. So,
326 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
327 disable almost any logging.
328
329 Note that the quotes on above line are mandatory because there is a space in
330 the argument, so we are protecting ourselves from the shell, not from SimGrid.
331 We could also reach the same effect with this:
332 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
333
334 \subsection log_use_conf_fmt 3.1.3 Format configuration
335
336 As with SimGrid 3.3, it is possible to control the format of log
337 messages. This is done through the <tt>fmt</tt> keyword. For example,
338 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
339 user-message only, removing any decoration such as the date, or the
340 process ID, everything.
341
342 Here are the existing format directives:
343
344  - %%: the % char
345  - %%n: platform-dependent line separator (LOG4J compatible)
346  - %%e: plain old space (SimGrid extension)
347
348  - %%m: user-provided message
349
350  - %%c: Category name (LOG4J compatible)
351  - %%p: Priority name (LOG4J compatible)
352
353  - %%h: Hostname (SimGrid extension)
354  - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank)
355  - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
356  - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
357
358  - %%F: file name where the log event was raised (LOG4J compatible)
359  - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
360  - %%L: line number where the log event was raised (LOG4J compatible)
361  - %%M: function name (LOG4J compatible -- called method name here of course).
362    Defined only when using gcc because there is no __FUNCTION__ elsewhere.
363
364  - %%b: full backtrace (Called %%throwable in LOG4J).
365    Defined only under windows or when using the GNU libc because backtrace() is not defined
366    elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
367  - %%B: short backtrace (only the first line of the %%b).
368    Called %%throwable{short} in LOG4J; defined where %%b is.
369
370  - %%d: date (UNIX-like epoch)
371  - %%r: application age (time elapsed since the beginning of the application)
372
373
374 If you want to mimic the simple layout with the format one, you would use this
375 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
376 because the simple layout do not display the message location for messages at
377 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
378 case). Moreover, if there is no process name (ie, messages coming from the
379 library itself, or test programs doing strange things) do not display the
380 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
381 [%%c/%%p] %%m%%n' if they are at priority INFO).
382
383 For now, there is only two format modifiers: the precision and the
384 width fields. You can for example specify %.4r to get the application
385 age with 4 numbers after the radix, or %15p to get the process name
386 on 15 columns. Finally, you can specify %10.6r to get the time on at
387 most 10 columns, with 6 numbers after the radix. 
388
389 Note that when specifying the width, it is filled with spaces. That
390 is to say that for example %5r in your format is converted to "% 5f"
391 for printf (note the extra space); there is no way to fill the empty
392 columns with 0 (ie, pass "%05f" to printf). Another limitation is
393 that you cannot set specific layouts to the several priorities.
394
395 \subsection log_use_conf_app 3.1.4 Category appender
396
397 As with SimGrid 3.3, it is possible to control the appender of log
398 messages. This is done through the <tt>app</tt> keyword. For example,
399 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
400 to the file mylogfile.
401
402 For splitfile appender, the format is 
403 \verbatim --log=root.app:splitfile:size:mylogfile_%.format\endverbatim
404
405 The size is in bytes, and the % wildcard will be replaced by the number of the
406 file. If no % is present, it will be appended at the end.
407
408 rollfile appender is also available, it can be used as
409 \verbatim --log=root.app:rollfile:size:mylogfile\endverbatim
410 When the file grows to be larger than the size, it will be emptied and new log 
411 events will be sent at its beginning 
412
413 Any appender setup this way have its own layout format (simple one by default),
414 so you may have to change it too afterward. Moreover, the additivity of the log category
415 is also set to false to prevent log event displayed by this appender to "leak" to any other
416 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
417 manually.
418
419 \subsection log_use_conf_add 3.1.5 Category additivity
420
421 The <tt>add</tt> keyword allows to specify the additivity of a
422 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
423 and 'off' are all valid values, with 'yes' as default.
424
425 The following example resets the additivity of the xbt category to true (which is its default value).
426 \verbatim --log=xbt.add:yes\endverbatim
427
428 \section log_use_misc 3.2 Misc and Caveats
429
430   - Do not use any of the macros that start with '_'.
431   - Log4J has a 'rolling file appender' which you can select with a run-time
432     option and specify the max file size. This would be a nice default for
433     non-kernel applications.
434   - Careful, category names are global variables.
435   - When writing a log format, you often want to use spaces. If you don't
436     protect these spaces, they are used as configuration elements separators.
437     For example, if you want to remove the date from the logs, you want to pass the following 
438     argument on the command line. The outer quotes are here to protect the string from the shell 
439     interpretation while the inner ones are there to prevent simgrid from splitting the string 
440     in several log parameters (that would be invalid).
441     \verbatim --log="'root.fmt:%l: [%p/%c]: %m%n'"\endverbatim
442     Another option is to use the SimGrid-specific format directive \%e for
443     spaces, like in the following.
444     \verbatim --log="root.fmt:%l:%e[%p/%c]:%e%m%n"\endverbatim
445
446 \section log_internals 4. Internal considerations
447
448 This module is a mess of macro black magic, and when it goes wrong,
449 SimGrid studently loose its ability to explain its problems. When
450 messing around this module, I often find useful to define
451 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
452 of finding what's going wrong. But things are quite verbose when
453 everything is enabled...
454
455 \section log_in_perf 4.1 Performance
456
457 Except for the first invocation of a given category, a disabled logging request
458 requires an a single comparison of a static variable to a constant.
459
460 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
461 causes all logging requests with a lower priority to be optimized to 0 cost
462 by the compiler. By setting it to xbt_log_priority_infinite, all logging
463 requests are statically disabled at compile time and cost nothing. Released executables
464 <i>might</i>  be compiled with (note that it will prevent users to debug their problems)
465 \verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
466
467 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
468 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
469 the requests of priority below INFO.
470
471 \todo Logging performance *may* be improved further by improving the message
472 propagation from appender to appender in the category tree.
473
474 \section log_in_app 4.2 Appenders
475
476 Each category has an optional appender. An appender is a pointer to a
477 structure which starts with a pointer to a do_append() function. do_append()
478 prints a message to a log.
479
480 When a category is passed a message by one of the logging macros, the
481 category performs the following actions:
482
483   - if the category has an appender, the message is passed to the
484     appender's do_append() function,
485   - if additivity is true for the category, the message is passed to
486     the category's parent. Additivity is true by default, and can be
487     controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
488     Also, when you add an appender to a category, its additivity is automatically turned to off.
489     Turn it back on afterward if it is not what you wanted.
490
491 By default, only the root category have an appender, and any other category has
492 its additivity set to true. This causes all messages to be logged by the root
493 category's appender.
494
495 The default appender function currently prints to stderr
496 */
497
498 xbt_log_appender_t xbt_log_default_appender = NULL;     /* set in log_init */
499 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
500
501 typedef struct {
502   char *catname;
503   char *fmt;
504   e_xbt_log_priority_t thresh;
505   int additivity;
506   xbt_log_appender_t appender;
507 } s_xbt_log_setting_t, *xbt_log_setting_t;
508
509 static xbt_dynar_t xbt_log_settings = NULL;
510
511 static void _free_setting(void *s)
512 {
513   xbt_log_setting_t set = *(xbt_log_setting_t *) s;
514   if (set) {
515     free(set->catname);
516     free(set->fmt);
517     free(set);
518   }
519 }
520
521 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
522                                    xbt_log_setting_t setting);
523
524 const char *xbt_log_priority_names[8] = {
525   "NONE",
526   "TRACE",
527   "DEBUG",
528   "VERBOSE",
529   "INFO",
530   "WARNING",
531   "ERROR",
532   "CRITICAL"
533 };
534
535 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
536   NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
537       "root", "The common ancestor for all categories",
538       0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
539       0 /* isThreshInherited */ ,
540       NULL /* appender */ , NULL /* layout */ ,
541       0                         /* additivity */
542 };
543
544 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
545                                 "Loggings from the logging mechanism itself");
546
547 /* create the default appender and install it in the root category,
548    which were already created (damnit. Too slow little beetle) */
549 void xbt_log_preinit(void)
550 {
551   xbt_log_default_appender = xbt_log_appender_file_new(NULL);
552   xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
553   _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
554   _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
555   log_cat_init_mutex = xbt_os_rmutex_init();
556 }
557
558 static void xbt_log_connect_categories(void)
559 {
560   /* Connect our log channels: that must be done manually under windows */
561   /* Also permit that they are correctly listed by xbt_log_help_categories() */
562
563   /* xbt */
564   XBT_LOG_CONNECT(xbt);
565   XBT_LOG_CONNECT(graphxml_parse);
566   XBT_LOG_CONNECT(log);
567   XBT_LOG_CONNECT(module);
568   XBT_LOG_CONNECT(peer);
569   XBT_LOG_CONNECT(replay);
570   XBT_LOG_CONNECT(strbuff);
571   XBT_LOG_CONNECT(xbt_cfg);
572   XBT_LOG_CONNECT(xbt_dict);
573   XBT_LOG_CONNECT(xbt_dict_cursor);
574   XBT_LOG_CONNECT(xbt_dict_elm);
575 #ifdef XBT_USE_DEPRECATED
576   XBT_LOG_CONNECT(xbt_dict_multi);
577 #endif
578   XBT_LOG_CONNECT(xbt_dyn);
579   XBT_LOG_CONNECT(xbt_ex);
580   XBT_LOG_CONNECT(xbt_fifo);
581   XBT_LOG_CONNECT(xbt_graph);
582   XBT_LOG_CONNECT(xbt_heap);
583   XBT_LOG_CONNECT(xbt_lib);
584   XBT_LOG_CONNECT(xbt_mallocator);
585   XBT_LOG_CONNECT(xbt_matrix);
586   XBT_LOG_CONNECT(xbt_parmap);
587   XBT_LOG_CONNECT(xbt_queue);
588   XBT_LOG_CONNECT(xbt_set);
589   XBT_LOG_CONNECT(xbt_sync);
590   XBT_LOG_CONNECT(xbt_sync_os);
591
592 #ifdef simgrid_EXPORTS
593   /* The following categories are only defined in libsimgrid */
594
595   /* bindings */
596 #ifdef HAVE_LUA
597   XBT_LOG_CONNECT(bindings);
598   XBT_LOG_CONNECT(lua);
599   XBT_LOG_CONNECT(lua_comm);
600   XBT_LOG_CONNECT(lua_host);
601   XBT_LOG_CONNECT(lua_platf);
602   XBT_LOG_CONNECT(lua_process);
603   XBT_LOG_CONNECT(lua_state_cloner);
604   XBT_LOG_CONNECT(lua_task);
605   XBT_LOG_CONNECT(lua_utils);
606 #endif
607
608   /* instr */
609   XBT_LOG_CONNECT(instr);
610   XBT_LOG_CONNECT(instr_api);
611   XBT_LOG_CONNECT(instr_config);
612   XBT_LOG_CONNECT(instr_msg);
613   XBT_LOG_CONNECT(instr_msg_process);
614   XBT_LOG_CONNECT(instr_msg_vm);
615   XBT_LOG_CONNECT(instr_paje_containers);
616   XBT_LOG_CONNECT(instr_paje_header);
617   XBT_LOG_CONNECT(instr_paje_trace);
618   XBT_LOG_CONNECT(instr_paje_types);
619   XBT_LOG_CONNECT(instr_paje_values);
620   XBT_LOG_CONNECT(instr_resource);
621   XBT_LOG_CONNECT(instr_routing);
622   XBT_LOG_CONNECT(instr_sd);
623   XBT_LOG_CONNECT(instr_surf);
624   XBT_LOG_CONNECT(instr_trace);
625   XBT_LOG_CONNECT(instr_TI_trace);
626
627   /* jedule */
628 #ifdef HAVE_JEDULE
629   XBT_LOG_CONNECT(jedule);
630   XBT_LOG_CONNECT(jed_out);
631   XBT_LOG_CONNECT(jed_sd);
632 #endif
633
634   /* mc */
635 #ifdef HAVE_MC
636   XBT_LOG_CONNECT(mc);
637   XBT_LOG_CONNECT(mc_checkpoint);
638   XBT_LOG_CONNECT(mc_comm_determinism);
639   XBT_LOG_CONNECT(mc_compare);
640   XBT_LOG_CONNECT(mc_diff);
641   XBT_LOG_CONNECT(mc_dwarf);
642   XBT_LOG_CONNECT(mc_hash);
643   XBT_LOG_CONNECT(mc_ignore);
644   XBT_LOG_CONNECT(mcer_ignore);
645   XBT_LOG_CONNECT(mc_liveness);
646   // This one is not in libsimgrid:
647   // XBT_LOG_CONNECT(mc_main);
648   XBT_LOG_CONNECT(mc_memory);
649   XBT_LOG_CONNECT(mc_memory_map);
650   XBT_LOG_CONNECT(mc_page_snapshot);
651   XBT_LOG_CONNECT(mc_request);
652   XBT_LOG_CONNECT(mc_safety);
653   XBT_LOG_CONNECT(mc_visited);
654   XBT_LOG_CONNECT(mc_client);
655   XBT_LOG_CONNECT(mc_client_api);
656   XBT_LOG_CONNECT(mc_comm_pattern);
657   XBT_LOG_CONNECT(mc_process);
658   XBT_LOG_CONNECT(mc_protocol);
659   XBT_LOG_CONNECT(mc_RegionSnaphot);
660   XBT_LOG_CONNECT(mc_server);
661   XBT_LOG_CONNECT(mc_state);
662 #endif
663   XBT_LOG_CONNECT(mc_global);
664   XBT_LOG_CONNECT(mc_config);
665   XBT_LOG_CONNECT(mc_record);
666
667   /* msg */
668   XBT_LOG_CONNECT(msg);
669   XBT_LOG_CONNECT(msg_action);
670   XBT_LOG_CONNECT(msg_gos);
671   XBT_LOG_CONNECT(msg_io);
672   XBT_LOG_CONNECT(msg_kernel);
673   XBT_LOG_CONNECT(msg_mailbox);
674   XBT_LOG_CONNECT(msg_process);
675   XBT_LOG_CONNECT(msg_synchro);
676   XBT_LOG_CONNECT(msg_task);
677   XBT_LOG_CONNECT(msg_vm);
678    
679   /* simdag */
680   XBT_LOG_CONNECT(sd);
681   XBT_LOG_CONNECT(sd_daxparse);
682 #ifdef HAVE_GRAPHVIZ
683   XBT_LOG_CONNECT(sd_dotparse);
684 #endif
685   XBT_LOG_CONNECT(sd_kernel);
686   XBT_LOG_CONNECT(sd_task);
687   XBT_LOG_CONNECT(sd_workstation);
688
689   /* simix */
690   XBT_LOG_CONNECT(simix);
691   XBT_LOG_CONNECT(simix_context);
692   XBT_LOG_CONNECT(simix_deployment);
693   XBT_LOG_CONNECT(simix_environment);
694   XBT_LOG_CONNECT(simix_host);
695   XBT_LOG_CONNECT(simix_io);
696   XBT_LOG_CONNECT(simix_kernel);
697   XBT_LOG_CONNECT(simix_network);
698   XBT_LOG_CONNECT(simix_process);
699   XBT_LOG_CONNECT(simix_popping);
700   XBT_LOG_CONNECT(simix_synchro);
701   XBT_LOG_CONNECT(simix_vm);
702
703   /* smpi */
704   /* SMPI categories are connected in smpi_global.c */
705
706   /* surf */
707   XBT_LOG_CONNECT(surf);
708   XBT_LOG_CONNECT(platf_generator);
709   XBT_LOG_CONNECT(random);
710   XBT_LOG_CONNECT(surf_config);
711   XBT_LOG_CONNECT(surf_cpu);
712   XBT_LOG_CONNECT(surf_cpu_cas);
713   XBT_LOG_CONNECT(surf_cpu_ti);
714   XBT_LOG_CONNECT(surf_energy);
715   XBT_LOG_CONNECT(surf_kernel);
716   XBT_LOG_CONNECT(surf_lagrange);
717   XBT_LOG_CONNECT(surf_lagrange_dichotomy);
718   XBT_LOG_CONNECT(surf_maxmin);
719   XBT_LOG_CONNECT(surf_network);
720 #ifdef HAVE_GTNETS
721   XBT_LOG_CONNECT(surf_network_gtnets);
722   XBT_LOG_CONNECT(surf_network_gtnets_interface);
723   XBT_LOG_CONNECT(surf_network_gtnets_simulator);
724   XBT_LOG_CONNECT(surf_network_gtnets_topology);
725 #endif
726 #ifdef HAVE_NS3
727   XBT_LOG_CONNECT(ns3);
728 #endif
729   XBT_LOG_CONNECT(surf_parse);
730   XBT_LOG_CONNECT(surf_route);
731   XBT_LOG_CONNECT(surf_routing_generic);
732   XBT_LOG_CONNECT(surf_route_cluster);
733   XBT_LOG_CONNECT(surf_route_cluster_torus);
734   XBT_LOG_CONNECT(surf_route_dijkstra);
735   XBT_LOG_CONNECT(surf_route_fat_tree);
736   XBT_LOG_CONNECT(surf_route_floyd);
737   XBT_LOG_CONNECT(surf_route_full);
738   XBT_LOG_CONNECT(surf_route_none);
739   XBT_LOG_CONNECT(surf_route_vivaldi);
740   XBT_LOG_CONNECT(surf_storage);
741   XBT_LOG_CONNECT(surf_trace);
742   XBT_LOG_CONNECT(surf_vm);
743   XBT_LOG_CONNECT(surf_host);
744
745 #endif /* simgrid_EXPORTS */
746 }
747
748 static void xbt_log_help(void);
749 static void xbt_log_help_categories(void);
750
751 /** @brief Get all logging settings from the command line
752  *
753  * xbt_log_control_set() is called on each string we got from cmd line
754  */
755 void xbt_log_init(int *argc, char **argv)
756 {
757   unsigned help_requested = 0;  /* 1: logs; 2: categories */
758   int i, j;
759   char *opt;
760
761   //    _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
762
763   xbt_log_connect_categories();
764
765   /* Set logs and init log submodule */
766   for (j = i = 1; i < *argc; i++) {
767     if (!strncmp(argv[i], "--log=", strlen("--log="))) {
768       opt = strchr(argv[i], '=');
769       opt++;
770       xbt_log_control_set(opt);
771       XBT_DEBUG("Did apply '%s' as log setting", opt);
772     } else if (!strcmp(argv[i], "--help-logs")) {
773       help_requested |= 1;
774     } else if (!strcmp(argv[i], "--help-log-categories")) {
775       help_requested |= 2;
776     } else {
777       argv[j++] = argv[i];
778     }
779   }
780   if (j < *argc) {
781     argv[j] = NULL;
782     *argc = j;
783   }
784
785   if (help_requested) {
786     if (help_requested & 1)
787       xbt_log_help();
788     if (help_requested & 2)
789       xbt_log_help_categories();
790     exit(0);
791   }
792 }
793
794 static void log_cat_exit(xbt_log_category_t cat)
795 {
796   xbt_log_category_t child;
797
798   if (cat->appender) {
799     if (cat->appender->free_)
800       cat->appender->free_(cat->appender);
801     free(cat->appender);
802   }
803   if (cat->layout) {
804     if (cat->layout->free_)
805       cat->layout->free_(cat->layout);
806     free(cat->layout);
807   }
808
809   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
810     log_cat_exit(child);
811 }
812
813 void xbt_log_postexit(void)
814 {
815   XBT_VERB("Exiting log");
816   xbt_os_rmutex_destroy(log_cat_init_mutex);
817   xbt_dynar_free(&xbt_log_settings);
818   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
819 }
820
821  /* Size of the static string in which we  build the log string */
822 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
823 /* Minimum size of the dynamic string in which we build the log string
824    (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
825 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
826
827 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
828 {
829   xbt_log_category_t cat = ev->cat;
830
831   xbt_assert(ev->priority >= 0,
832              "Negative logging priority naturally forbidden");
833   xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
834              "Priority %d is greater than the biggest allowed value",
835              ev->priority);
836
837   do {
838     xbt_log_appender_t appender = cat->appender;
839
840     if (!appender)
841       continue;                 /* No appender, try next */
842
843     xbt_assert(cat->layout,
844                "No valid layout for the appender of category %s", cat->name);
845
846     /* First, try with a static buffer */
847     if (XBT_LOG_STATIC_BUFFER_SIZE) {
848       char buff[XBT_LOG_STATIC_BUFFER_SIZE];
849       int done;
850       ev->buffer = buff;
851       ev->buffer_size = sizeof buff;
852       va_start(ev->ap, fmt);
853       done = cat->layout->do_layout(cat->layout, ev, fmt);
854       va_end(ev->ap);
855       if (done) {
856         appender->do_append(appender, buff);
857         continue;               /* Ok, that worked: go next */
858       }
859     }
860
861     /* The static buffer was too small, use a dynamically expanded one */
862     ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
863     ev->buffer = xbt_malloc(ev->buffer_size);
864     while (1) {
865       int done;
866       va_start(ev->ap, fmt);
867       done = cat->layout->do_layout(cat->layout, ev, fmt);
868       va_end(ev->ap);
869       if (done)
870         break;                  /* Got it */
871       ev->buffer_size *= 2;
872       ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
873     }
874     appender->do_append(appender, ev->buffer);
875     xbt_free(ev->buffer);
876
877   } while (cat->additivity && (cat = cat->parent, 1));
878 }
879
880 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
881 #undef XBT_LOG_STATIC_BUFFER_SIZE
882
883 /* NOTE:
884  *
885  * The standard logging macros use _XBT_LOG_ISENABLED, which calls
886  * _xbt_log_cat_init().  Thus, if we want to avoid an infinite
887  * recursion, we can not use the standard logging macros in
888  * _xbt_log_cat_init(), and in all functions called from it.
889  *
890  * To circumvent the problem, we define the macro_xbt_log_init() as
891  * (0) for the length of the affected functions, and we do not forget
892  * to undefine it at the end!
893  */
894
895 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
896                                    xbt_log_setting_t setting)
897 {
898 #define _xbt_log_cat_init(a, b) (0)
899
900   if (setting->thresh != xbt_log_priority_uninitialized) {
901     xbt_log_threshold_set(category, setting->thresh);
902
903     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
904            category->name, xbt_log_priority_names[category->threshold],
905            category->threshold);
906   }
907
908   if (setting->fmt) {
909     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
910
911     XBT_DEBUG("Apply settings for category '%s': set format to %s",
912            category->name, setting->fmt);
913   }
914
915   if (setting->additivity != -1) {
916     xbt_log_additivity_set(category, setting->additivity);
917
918     XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
919            category->name, (setting->additivity ? "on" : "off"));
920   }
921   if (setting->appender) {
922     xbt_log_appender_set(category, setting->appender);
923     if (!category->layout)
924       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
925     category->additivity = 0;
926     XBT_DEBUG("Set %p as appender of category '%s'",
927            setting->appender, category->name);
928   }
929 #undef _xbt_log_cat_init
930 }
931
932 /*
933  * This gets called the first time a category is referenced and performs the
934  * initialization.
935  * Also resets threshold to inherited!
936  */
937 int _xbt_log_cat_init(xbt_log_category_t category,
938                       e_xbt_log_priority_t priority)
939 {
940 #define _xbt_log_cat_init(a, b) (0)
941
942   if (log_cat_init_mutex != NULL) {
943     xbt_os_rmutex_acquire(log_cat_init_mutex);
944   }
945
946   if (category->initialized) {
947     if (log_cat_init_mutex != NULL) {
948       xbt_os_rmutex_release(log_cat_init_mutex);
949     }
950     return priority >= category->threshold;
951   }
952
953   unsigned int cursor;
954   xbt_log_setting_t setting = NULL;
955   int found = 0;
956
957   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
958          category->name,
959          (category->firstChild ? category->firstChild->name : "none"),
960          (category->nextSibling ? category->nextSibling->name : "none"));
961
962   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
963     category->threshold = xbt_log_priority_info;
964     category->appender = xbt_log_default_appender;
965     category->layout = xbt_log_default_layout;
966   } else {
967
968     if (!category->parent)
969       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
970
971     XBT_DEBUG("Set %s (%s) as father of %s ",
972            category->parent->name,
973            (category->parent->initialized ?
974             xbt_log_priority_names[category->parent->threshold] : "uninited"),
975            category->name);
976     xbt_log_parent_set(category, category->parent);
977
978     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
979       char *buf, *res = NULL;
980       xbt_log_category_t cpp = category->parent->firstChild;
981       while (cpp) {
982         if (res) {
983           buf = bprintf("%s %s", res, cpp->name);
984           free(res);
985           res = buf;
986         } else {
987           res = xbt_strdup(cpp->name);
988         }
989         cpp = cpp->nextSibling;
990       }
991
992       XBT_DEBUG("Children of %s: %s; nextSibling: %s",
993              category->parent->name, res,
994              (category->parent->nextSibling ?
995               category->parent->nextSibling->name : "none"));
996
997       free(res);
998     }
999
1000   }
1001
1002   /* Apply the control */
1003   if (xbt_log_settings) {
1004     xbt_assert(category, "NULL category");
1005     xbt_assert(category->name);
1006
1007     xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
1008       xbt_assert(setting, "Damnit, NULL cat in the list");
1009       xbt_assert(setting->catname, "NULL setting(=%p)->catname",
1010                  (void *) setting);
1011
1012       if (!strcmp(setting->catname, category->name)) {
1013         found = 1;
1014         _xbt_log_cat_apply_set(category, setting);
1015         xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
1016       }
1017     }
1018
1019     if (!found)
1020       XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
1021                 category->name, xbt_log_priority_names[category->threshold],
1022                 category->threshold);
1023   }
1024
1025   category->initialized = 1;
1026   if (log_cat_init_mutex != NULL) {
1027     xbt_os_rmutex_release(log_cat_init_mutex);
1028   }
1029   return priority >= category->threshold;
1030
1031 #undef _xbt_log_cat_init
1032 }
1033
1034 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
1035 {
1036   xbt_assert(cat, "NULL category to be given a parent");
1037   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1038
1039   /* if the category is initialized, unlink from current parent */
1040   if (cat->initialized) {
1041
1042     xbt_log_category_t *cpp = &cat->parent->firstChild;
1043
1044     while (*cpp != cat && *cpp != NULL) {
1045       cpp = &(*cpp)->nextSibling;
1046     }
1047
1048     xbt_assert(*cpp == cat);
1049     *cpp = cat->nextSibling;
1050   }
1051
1052   cat->parent = parent;
1053   cat->nextSibling = parent->firstChild;
1054
1055   parent->firstChild = cat;
1056
1057   if (!parent->initialized)
1058     _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1059
1060   cat->threshold = parent->threshold;
1061
1062   cat->isThreshInherited = 1;
1063 }
1064
1065 static void _set_inherited_thresholds(xbt_log_category_t cat)
1066 {
1067
1068   xbt_log_category_t child = cat->firstChild;
1069
1070   for (; child != NULL; child = child->nextSibling) {
1071     if (child->isThreshInherited) {
1072       if (cat != &_XBT_LOGV(log))
1073         XBT_VERB("Set category threshold of %s to %s (=%d)",
1074               child->name, xbt_log_priority_names[cat->threshold],
1075               cat->threshold);
1076       child->threshold = cat->threshold;
1077       _set_inherited_thresholds(child);
1078     }
1079   }
1080
1081
1082 }
1083
1084 void xbt_log_threshold_set(xbt_log_category_t cat,
1085                            e_xbt_log_priority_t threshold)
1086 {
1087   cat->threshold = threshold;
1088   cat->isThreshInherited = 0;
1089
1090   _set_inherited_thresholds(cat);
1091
1092 }
1093
1094 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1095 {
1096   const char *orig_control_string = control_string;
1097   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1098   const char *name, *dot, *eq;
1099
1100   set->catname = NULL;
1101   set->thresh = xbt_log_priority_uninitialized;
1102   set->fmt = NULL;
1103   set->additivity = -1;
1104   set->appender = NULL;
1105
1106   if (!*control_string)
1107     return set;
1108   XBT_DEBUG("Parse log setting '%s'", control_string);
1109
1110   control_string += strspn(control_string, " ");
1111   name = control_string;
1112   control_string += strcspn(control_string, ".= ");
1113   dot = control_string;
1114   control_string += strcspn(control_string, ":= ");
1115   eq = control_string;
1116   control_string += strcspn(control_string, " ");
1117
1118   if(*dot != '.' && (*eq == '=' || *eq == ':'))
1119     xbt_die ("Invalid control string '%s'", orig_control_string);
1120
1121   if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
1122     int i;
1123     char *neweq = xbt_strdup(eq + 1);
1124     char *p = neweq - 1;
1125
1126     while (*(++p) != '\0') {
1127       if (*p >= 'a' && *p <= 'z') {
1128         *p -= 'a' - 'A';
1129       }
1130     }
1131
1132     XBT_DEBUG("New priority name = %s", neweq);
1133     for (i = 0; i < xbt_log_priority_infinite; i++) {
1134       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1135         XBT_DEBUG("This is priority %d", i);
1136         break;
1137       }
1138     }
1139
1140     if(i<XBT_LOG_STATIC_THRESHOLD){
1141      fprintf(stderr,
1142                  "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
1143                  "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
1144                  "while -DNLOG forbids any logging, at any level.",
1145              eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
1146      exit(1);
1147     }else if (i < xbt_log_priority_infinite) {
1148       set->thresh = (e_xbt_log_priority_t) i;
1149     } else {
1150       THROWF(arg_error, 0,
1151              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1152              eq + 1);
1153     }
1154     free(neweq);
1155   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1156              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1157
1158     char *neweq = xbt_strdup(eq + 1);
1159     char *p = neweq - 1;
1160
1161     while (*(++p) != '\0') {
1162       if (*p >= 'a' && *p <= 'z') {
1163         *p -= 'a' - 'A';
1164       }
1165     }
1166     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1167         || !strcmp(neweq, "1")) {
1168       set->additivity = 1;
1169     } else {
1170       set->additivity = 0;
1171     }
1172     free(neweq);
1173   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1174              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1175
1176     char *neweq = xbt_strdup(eq + 1);
1177
1178     if (!strncmp(neweq, "file:", 5)) {
1179       set->appender = xbt_log_appender_file_new(neweq + 5);
1180     }else if (!strncmp(neweq, "rollfile:", 9)) {
1181                 set->appender = xbt_log_appender2_file_new(neweq + 9,1);
1182     }else if (!strncmp(neweq, "splitfile:", 10)) {
1183                 set->appender = xbt_log_appender2_file_new(neweq + 10,0);
1184     } else {
1185       THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1186     }
1187     free(neweq);
1188   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1189     set->fmt = xbt_strdup(eq + 1);
1190   } else {
1191     char buff[512];
1192     snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1193     THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1194            buff);
1195   }
1196   set->catname = (char *) xbt_malloc(dot - name + 1);
1197
1198   memcpy(set->catname, name, dot - name);
1199   set->catname[dot - name] = '\0';      /* Just in case */
1200   XBT_DEBUG("This is for cat '%s'", set->catname);
1201
1202   return set;
1203 }
1204
1205 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1206                                                  char *name)
1207 {
1208   xbt_log_category_t child, res;
1209
1210   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1211          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1212          (cat->nextSibling ? cat->nextSibling->name : "none"));
1213   if (!strcmp(cat->name, name))
1214     return cat;
1215
1216   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1217     XBT_DEBUG("Dig into %s", child->name);
1218     res = _xbt_log_cat_searchsub(child, name);
1219     if (res)
1220       return res;
1221   }
1222
1223   return NULL;
1224 }
1225
1226 /**
1227  * \ingroup XBT_log
1228  * \param control_string What to parse
1229  *
1230  * Typically passed a command-line argument. The string has the syntax:
1231  *
1232  *      ( [category] "." [keyword] ":" value (" ")... )...
1233  *
1234  * where [category] is one the category names (see \ref XBT_log_cats for
1235  * a complete list of the ones defined in the SimGrid library)
1236  * and keyword is one of the following:
1237  *
1238  *    - thres: category's threshold priority. Possible values:
1239  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1240  *    - add or additivity: whether the logging actions must be passed to
1241  *      the parent category.
1242  *      Possible values: 0, 1, no, yes, on, off.
1243  *      Default value: yes.
1244  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1245  *    - app or appender: the appender to use. See \ref log_use_conf_app for more
1246  *      information.
1247  *
1248  */
1249 void xbt_log_control_set(const char *control_string)
1250 {
1251   xbt_log_setting_t set;
1252
1253   /* To split the string in commands, and the cursors */
1254   xbt_dynar_t set_strings;
1255   char *str;
1256   unsigned int cpt;
1257
1258   if (!control_string)
1259     return;
1260   XBT_DEBUG("Parse log settings '%s'", control_string);
1261
1262   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1263   if (!strcmp(control_string, "no_loc")) {
1264     xbt_log_no_loc = 1;
1265     return;
1266   }
1267   /* some initialization if this is the first time that this get called */
1268   if (xbt_log_settings == NULL)
1269     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1270                                      _free_setting);
1271
1272   /* split the string, and remove empty entries */
1273   set_strings = xbt_str_split_quoted(control_string);
1274
1275   if (xbt_dynar_is_empty(set_strings)) {     /* vicious user! */
1276     xbt_dynar_free(&set_strings);
1277     return;
1278   }
1279
1280   /* Parse each entry and either use it right now (if the category was already
1281      created), or store it for further use */
1282   xbt_dynar_foreach(set_strings, cpt, str) {
1283     xbt_log_category_t cat = NULL;
1284
1285     set = _xbt_log_parse_setting(str);
1286     cat =
1287         _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1288
1289     if (cat) {
1290       XBT_DEBUG("Apply directly");
1291       _xbt_log_cat_apply_set(cat, set);
1292       _free_setting((void *) &set);
1293     } else {
1294
1295       XBT_DEBUG("Store for further application");
1296       XBT_DEBUG("push %p to the settings", (void *) set);
1297       xbt_dynar_push(xbt_log_settings, &set);
1298     }
1299   }
1300   xbt_dynar_free(&set_strings);
1301 }
1302
1303 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1304 {
1305   if (cat->appender) {
1306     if (cat->appender->free_)
1307       cat->appender->free_(cat->appender);
1308     free(cat->appender);
1309   }
1310   cat->appender = app;
1311 }
1312
1313 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1314 {
1315 #define _xbt_log_cat_init(a, b) (0)
1316   if (!cat->appender) {
1317     XBT_VERB
1318         ("No appender to category %s. Setting the file appender as default",
1319          cat->name);
1320     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1321   }
1322   if (cat->layout) {
1323     if (cat->layout->free_) {
1324       cat->layout->free_(cat->layout);
1325     }
1326     free(cat->layout);
1327   }
1328   cat->layout = lay;
1329   xbt_log_additivity_set(cat, 0);
1330 #undef _xbt_log_cat_init
1331 }
1332
1333 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1334 {
1335   cat->additivity = additivity;
1336 }
1337
1338 static void xbt_log_help(void)
1339 {
1340   printf(
1341 "Description of the logging output:\n"
1342 "\n"
1343 "   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1344 "      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1345 "      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1346 "         -> trace: enter and return of some functions\n"
1347 "         -> debug: crufty output\n"
1348 "         -> verbose: verbose output for the user wanting more\n"
1349 "         -> info: output about the regular functionning\n"
1350 "         -> warning: minor issue encountered\n"
1351 "         -> error: issue encountered\n"
1352 "         -> critical: major issue encountered\n"
1353 "\n"
1354 "   Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1355 "      OPTIONS may be:\n"
1356 "         -> %%%%: the %% char\n"
1357 "         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1358 "         -> %%e: plain old space (SimGrid extension)\n"
1359 "\n"
1360 "         -> %%m: user-provided message\n"
1361 "\n"
1362 "         -> %%c: Category name (LOG4J compatible)\n"
1363 "         -> %%p: Priority name (LOG4J compatible)\n"
1364 "\n"
1365 "         -> %%h: Hostname (SimGrid extension)\n"
1366 "         -> %%P: Process name (SimGrid extension)\n"
1367 "         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1368 "         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1369 "\n"
1370 "         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1371 "         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1372 "         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1373 "         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1374 "                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1375 "\n"
1376 "         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1377 "                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1378 "         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1379 "\n"
1380 "         -> %%d: date (UNIX-like epoch)\n"
1381 "         -> %%r: application age (time elapsed since the beginning of the application)\n"
1382 "\n"
1383 "   Miscellaneous:\n"
1384 "      --help-log-categories    Display the current hierarchy of log categories.\n"
1385 "      --log=no_loc             Don't print file names in messages (for tesh tests).\n"
1386 "\n"
1387     );
1388 }
1389
1390 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1391 {
1392   xbt_log_category_t a = *(xbt_log_category_t *)pa;
1393   xbt_log_category_t b = *(xbt_log_category_t *)pb;
1394   return strcmp(a->name, b->name);
1395 }
1396
1397 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1398                                         const char *prefix)
1399 {
1400   char *this_prefix;
1401   char *child_prefix;
1402   xbt_dynar_t dynar;
1403   unsigned i;
1404   xbt_log_category_t cat;
1405
1406   if (!category)
1407     return;
1408
1409   if (category->parent) {
1410     this_prefix = bprintf("%s \\_ ", prefix);
1411     child_prefix = bprintf("%s |  ", prefix);
1412   } else {
1413     this_prefix = xbt_strdup(prefix);
1414     child_prefix = xbt_strdup(prefix);
1415   }
1416
1417   dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1418   for (cat = category ; cat != NULL; cat = cat->nextSibling)
1419     xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1420
1421   xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1422
1423   for (i = 0; i < xbt_dynar_length(dynar); i++) {
1424     if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1425       *strrchr(child_prefix, '|') = ' ';
1426     cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1427     printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1428     xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1429   }
1430
1431   xbt_dynar_free(&dynar);
1432   xbt_free(this_prefix);
1433   xbt_free(child_prefix);
1434 }
1435
1436 static void xbt_log_help_categories(void)
1437 {
1438   printf("Current log category hierarchy:\n");
1439   xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), "   ");
1440   printf("\n");
1441 }