Logo AND Algorithmique Numérique Distribuée

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