1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2011. The SimGrid Team.
4 * All rights reserved. */
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. */
12 #include <stdio.h> /* snprintf */
13 #include <stdlib.h> /* snprintf */
15 #include "portable.h" /* to get a working stdarg.h */
17 #include "xbt_modinter.h"
22 #include "xbt/sysdep.h"
23 #include "xbt/log_private.h"
24 #include "xbt/dynar.h"
25 #include "xbt/xbt_os_thread.h"
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 static xbt_os_rmutex_t log_cat_init_mutex = NULL;
31 /** \addtogroup XBT_log
33 * This section describes the API to the log functions used
34 * everywhere in this project.
36 \section XBT_log_toc Table of contents
46 - \ref log_API_isenabled
49 - \ref log_API_example
52 - \ref log_use_conf_thres
53 - \ref log_use_conf_multi
54 - \ref log_use_conf_fmt
55 - \ref log_use_conf_app
56 - \ref log_use_conf_add
63 \section log_overview 1. Introduction
65 This module is in charge of handling the log messages of every SimGrid
66 program. The main design goal are:
68 - <b>configurability</b>: the user can choose <i>at runtime</i> what messages to show and
69 what to hide, as well as how messages get displayed.
70 - <b>ease of use</b>: both to the programmer (using preprocessor macros black magic)
71 and to the user (with command line options)
72 - <b>performances</b>: logging shouldn't slow down the program when turned off, for example
73 - deal with <b>distributed settings</b>: SimGrid programs are [often] distributed ones,
74 and the logging mechanism allows to syndicate each and every log source into the same place.
75 At least, its design would allow to, once we write the last missing pieces
77 There is three main concepts in SimGrid's logging mechanism: <i>category</i>,
78 <i>priority</i> and <i>appender</i>. These three concepts work together to
79 enable developers to log messages according to message type and priority, and
80 to control at runtime how these messages are formatted and where they are
83 \subsection log_cat 1.1 Category hierarchy
85 The first and foremost advantage of any logging API over plain printf()
86 resides in its ability to disable certain log statements while allowing
87 others to print unhindered. This capability assumes that the logging space,
88 that is, the space of all possible logging statements, is categorized
89 according to some developer-chosen criteria.
91 This observation led to choosing category as the central concept of the
92 system. In a certain sense, they can be considered as logging topics or
95 \subsection log_pri 1.2 Logging priorities
97 The user can naturally declare interest into this or that logging category, but
98 he also can specify the desired level of details for each of them. This is
99 controlled by the <i>priority</i> concept (which should maybe be renamed to
102 Empirically, the user can specify that he wants to see every debugging message
103 of MSG while only being interested into the messages at level "error" or
104 higher about the XBT internals.
106 \subsection log_app 1.3 Message appenders
108 The message appenders are the elements in charge of actually displaying the
109 message to the user. For now, only two appenders exist: the default one prints
110 stuff on stderr while it is possible to create appenders printing to a specific
113 Other are planed (such as the one sending everything to a remote server,
114 or the one using only a fixed amount of lines in a file, and rotating content on
115 need). One day, for sure ;)
117 \subsection log_lay 1.4 Message layouts
119 The message layouts are the elements in charge of choosing how each message
120 will look like. Their result is a string which is then passed to the appender
121 attached to the category to be displayed.
123 For now, there is two layouts: The simple one, which is good for most cases,
124 and another one allowing users to specify the format they want.
125 \ref log_use_conf provides more info on this.
127 \subsection log_hist 1.5 History of this module
129 Historically, this module is an adaptation of the log4c project, which is dead
130 upstream, and which I was given the permission to fork under the LGPL licence
131 by the log4c's authors. The log4c project itself was loosely based on the
132 Apache project's Log4J, which also inspired Log4CC, Log4py and so on. Our work
133 differs somehow from these projects anyway, because the C programming language
134 is not object oriented.
136 \section log_API 2. Programmer interface
138 \subsection log_API_cat 2.1 Constructing the category hierarchy
140 Every category is declared by providing a name and an optional
141 parent. If no parent is explicitly named, the root category, LOG_ROOT_CAT is
142 the category's parent.
144 A category is created by a macro call at the top level of a file. A
145 category can be created with any one of the following macros:
147 - \ref XBT_LOG_NEW_CATEGORY(MyCat,desc); Create a new root
148 - \ref XBT_LOG_NEW_SUBCATEGORY(MyCat, ParentCat,desc);
149 Create a new category being child of the category ParentCat
150 - \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat,desc);
151 Like XBT_LOG_NEW_CATEGORY, but the new category is the default one
153 - \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, ParentCat,desc);
154 Like XBT_LOG_NEW_SUBCATEGORY, but the new category is the default one
157 The parent cat can be defined in the same file or in another file (in
158 which case you want to use the \ref XBT_LOG_EXTERNAL_CATEGORY macro to make
159 it visible in the current file), but each category may have only one
160 definition. Likewise, you can use a category defined in another file as
161 default one using \ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY
163 Typically, there will be a Category for each module and sub-module, so you
164 can independently control logging for each module.
166 For a list of all existing categories, please refer to the \ref XBT_log_cats
167 section. This file is generated automatically from the SimGrid source code, so
168 it should be complete and accurate.
170 \section log_API_pri 2.2 Declaring message priority
172 A category may be assigned a threshold priority. The set of priorities are
173 defined by the \ref e_xbt_log_priority_t enum. All logging request under
174 this priority will be discarded.
176 If a given category is not assigned a threshold priority, then it inherits
177 one from its closest ancestor with an assigned threshold. To ensure that all
178 categories can eventually inherit a threshold, the root category always has
179 an assigned threshold priority.
181 Logging requests are made by invoking a logging macro on a category. All of
182 the macros have a printf-style format string followed by arguments. If you
183 compile with the -Wall option, gcc will warn you for unmatched arguments, ie
184 when you pass a pointer to a string where an integer was specified by the
185 format. This is usually a good idea.
187 Here is an example of the most basic type of macro. This is a logging
188 request with priority <i>warning</i>.
190 <code>XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5,
193 A logging request is said to be enabled if its priority is higher than or
194 equal to the threshold priority of its category. Otherwise, the request is
195 said to be disabled. A category without an assigned priority will inherit
196 one from the hierarchy.
198 It is possible to use any non-negative integer as a priority. If, as in the
199 example, one of the standard priorities is used, then there is a convenience
200 macro that is typically used instead. For example, the above example is
201 equivalent to the shorter:
203 <code>XBT_CWARN(MyCat, "Values are: %d and '%s'", 5, "oops");</code>
205 \section log_API_isenabled 2.3 Checking if a particular category/priority is enabled
207 It is sometimes useful to check whether a particular category is
208 enabled at a particular priority. One example is when you want to do
209 some extra computation to prepare a nice debugging message. There is
210 no use of doing so if the message won't be used afterward because
211 debugging is turned off.
213 Doing so is extremely easy, thanks to the XBT_LOG_ISENABLED(category, priority).
215 \section log_API_subcat 2.4 Using a default category (the easy interface)
217 If \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY(MyCat, Parent) or
218 \ref XBT_LOG_NEW_DEFAULT_CATEGORY(MyCat) is used to create the
219 category, then the even shorter form can be used:
221 <code>XBT_WARN("Values are: %s and '%d'", 5, "oops");</code>
223 Only one default category can be created per file, though multiple
224 non-defaults can be created and used.
226 \section log_API_easy 2.5 Putting all together: the easy interface
228 First of all, each module should register its own category into the categories
229 tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
231 Then, logging should be done with the #XBT_DEBUG, #XBT_VERB, #XBT_INFO,
232 #XBT_WARN, #XBT_ERROR and #XBT_CRITICAL macros.
234 Under GCC, these macro check there arguments the same way than printf does. So,
235 if you compile with -Wall, the following code will issue a warning:
236 <code>XBT_DEBUG("Found %s (id %d)", some_string, a_double)</code>
238 If you want to specify the category to log onto (for example because you
239 have more than one category per file, add a C before the name of the log
240 producing macro (ie, use #XBT_CDEBUG, #XBT_CVERB, #XBT_CINFO, #XBT_CWARN,
241 #XBT_CERROR and #XBT_CCRITICAL and friends), and pass the category name as
244 The TRACE priority is not used the same way than the other. You should use
245 the #XBT_IN, #XBT_OUT and #XBT_HERE macros instead.
247 \section log_API_example 2.6 Example of use
249 Here is a more complete example:
254 / * create a category and a default subcategory * /
255 XBT_LOG_NEW_CATEGORY(VSS);
256 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS);
259 / * Now set the parent's priority. (the string would typically be a runtime option) * /
260 xbt_log_control_set("SA.thresh:3");
262 / * This request is enabled, because WARNING >= INFO. * /
263 XBT_CWARN(VSS, "Low fuel level.");
265 / * This request is disabled, because DEBUG < INFO. * /
266 XBT_CDEBUG(VSS, "Starting search for nearest gas station.");
268 / * The default category SA inherits its priority from VSS. Thus,
269 the following request is enabled because INFO >= INFO. * /
270 XBT_INFO("Located nearest gas station.");
272 / * This request is disabled, because DEBUG < INFO. * /
273 XBT_DEBUG("Exiting gas station search");
277 \section log_user 3. User interface
279 \section log_use_conf 3.1 Configuration
281 Although rarely done, it is possible to configure the logs during
282 program initialization by invoking the xbt_log_control_set() method
283 manually. A more conventional way is to use the --log command line
284 argument. xbt_init() (called by MSG_init() and friends)
285 checks and deals properly with such arguments.
287 \subsection log_use_conf_thres 3.1.1 Threshold configuration
289 The most common setting is to control which logging event will get
290 displayed by setting a threshold to each category through the
291 <tt>threshold</tt> keyword.
293 For example, \verbatim --log=root.threshold:debug\endverbatim will make
294 SimGrid <b>extremely</b> verbose while \verbatim
295 --log=root.thres:critical\endverbatim should shut it almost
298 Note that the <tt>threshold</tt> keyword can be abbreviated here. For example,
299 all the following notations have the same result.
301 --log=root.threshold:debug
302 --log=root.threshol:debug
303 --log=root.thresho:debug
304 --log=root.thresh:debug
305 --log=root.thres:debug
306 --log=root.thre:debug
310 --log=root.:debug <--- That's obviously really ugly, but it actually works.
313 The full list of recognized thresholds is the following:
315 - trace: enter and return of some functions
316 - debug: crufty output
317 - verbose: verbose output for the user wanting more
318 - info: output about the regular functionning
319 - warning: minor issue encountered
320 - error: issue encountered
321 - critical: major issue encountered
323 \subsection log_use_conf_multi 3.1.2 Passing several settings
325 You can provide several of those arguments to change the setting of several
326 categories, they will be applied from left to right. So,
327 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
328 disable almost any logging.
330 Note that the quotes on above line are mandatory because there is a space in
331 the argument, so we are protecting ourselves from the shell, not from SimGrid.
332 We could also reach the same effect with this:
333 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
335 \subsection log_use_conf_fmt 3.1.3 Format configuration
337 As with SimGrid 3.3, it is possible to control the format of log
338 messages. This is done through the <tt>fmt</tt> keyword. For example,
339 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
340 user-message only, removing any decoration such as the date, or the
341 process ID, everything.
343 Here are the existing format directives:
346 - %%n: platform-dependent line separator (LOG4J compatible)
347 - %%e: plain old space (SimGrid extension)
349 - %%m: user-provided message
351 - %%c: Category name (LOG4J compatible)
352 - %%p: Priority name (LOG4J compatible)
354 - %%h: Hostname (SimGrid extension)
355 - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank)
356 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
357 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
359 - %%F: file name where the log event was raised (LOG4J compatible)
360 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
361 - %%L: line number where the log event was raised (LOG4J compatible)
362 - %%M: function name (LOG4J compatible -- called method name here of course).
363 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
365 - %%b: full backtrace (Called %%throwable in LOG4J).
366 Defined only under windows or when using the GNU libc because backtrace() is not defined
367 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
368 - %%B: short backtrace (only the first line of the %%b).
369 Called %%throwable{short} in LOG4J; defined where %%b is.
371 - %%d: date (UNIX-like epoch)
372 - %%r: application age (time elapsed since the beginning of the application)
375 If you want to mimic the simple layout with the format one, you would use this
376 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
377 because the simple layout do not display the message location for messages at
378 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
379 case). Moreover, if there is no process name (ie, messages coming from the
380 library itself, or test programs doing strange things) do not display the
381 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
382 [%%c/%%p] %%m%%n' if they are at priority INFO).
384 For now, there is only two format modifiers: the precision and the
385 width fields. You can for example specify %.4r to get the application
386 age with 4 numbers after the radix, or %15p to get the process name
387 on 15 columns. Finally, you can specify %10.6r to get the time on at
388 most 10 columns, with 6 numbers after the radix.
390 Note that when specifying the width, it is filled with spaces. That
391 is to say that for example %5r in your format is converted to "% 5f"
392 for printf (note the extra space); there is no way to fill the empty
393 columns with 0 (ie, pass "%05f" to printf). Another limitation is
394 that you cannot set specific layouts to the several priorities.
396 \subsection log_use_conf_app 3.1.4 Category appender
398 As with SimGrid 3.3, it is possible to control the appender of log
399 messages. This is done through the <tt>app</tt> keyword. For example,
400 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
401 to the file mylogfile.
403 Any appender setup this way have its own layout format (simple one by default),
404 so you may have to change it too afterward. Moreover, the additivity of the log category
405 is also set to false to prevent log event displayed by this appender to "leak" to any other
406 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
409 \subsection log_use_conf_add 3.1.5 Category additivity
411 The <tt>add</tt> keyword allows to specify the additivity of a
412 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
413 and 'off' are all valid values, with 'yes' as default.
415 The following example resets the additivity of the xbt category to true (which is its default value).
416 \verbatim --log=xbt.add:yes\endverbatim
418 \section log_use_misc 3.2 Misc and Caveats
420 - Do not use any of the macros that start with '_'.
421 - Log4J has a 'rolling file appender' which you can select with a run-time
422 option and specify the max file size. This would be a nice default for
423 non-kernel applications.
424 - Careful, category names are global variables.
426 \section log_internals 4. Internal considerations
428 This module is a mess of macro black magic, and when it goes wrong,
429 SimGrid studently loose its ability to explain its problems. When
430 messing around this module, I often find useful to define
431 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
432 of finding what's going wrong. But things are quite verbose when
433 everything is enabled...
435 \section log_in_perf 4.1 Performance
437 Except for the first invocation of a given category, a disabled logging request
438 requires an a single comparison of a static variable to a constant.
440 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
441 causes all logging requests with a lower priority to be optimized to 0 cost
442 by the compiler. By setting it to xbt_log_priority_infinite, all logging
443 requests are statically disabled at compile time and cost nothing. Released executables
444 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
445 \verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
447 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
448 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
449 the requests of priority below INFO.
451 \todo Logging performance *may* be improved further by improving the message
452 propagation from appender to appender in the category tree.
454 \section log_in_app 4.2 Appenders
456 Each category has an optional appender. An appender is a pointer to a
457 structure which starts with a pointer to a do_append() function. do_append()
458 prints a message to a log.
460 When a category is passed a message by one of the logging macros, the
461 category performs the following actions:
463 - if the category has an appender, the message is passed to the
464 appender's do_append() function,
465 - if additivity is true for the category, the message is passed to
466 the category's parent. Additivity is true by default, and can be
467 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
468 Also, when you add an appender to a category, its additivity is automatically turned to off.
469 Turn it back on afterward if it is not what you wanted.
471 By default, only the root category have an appender, and any other category has
472 its additivity set to true. This causes all messages to be logged by the root
475 The default appender function currently prints to stderr, and the only other
476 existing one writes to the specified file. More would be needed, like the one
477 able to send the logs to a remote dedicated server.
478 This is on our TODO list for quite a while now, but your help would be
479 welcome here, too. */
481 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
482 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
487 e_xbt_log_priority_t thresh;
489 xbt_log_appender_t appender;
490 } s_xbt_log_setting_t, *xbt_log_setting_t;
492 static xbt_dynar_t xbt_log_settings = NULL;
494 static void _free_setting(void *s)
496 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
504 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
505 xbt_log_setting_t setting);
507 const char *xbt_log_priority_names[8] = {
518 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
519 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
520 "root", "The common ancestor for all categories",
521 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
522 0 /* isThreshInherited */ ,
523 NULL /* appender */ , NULL /* layout */ ,
527 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
528 "Loggings from the logging mechanism itself");
530 /* create the default appender and install it in the root category,
531 which were already created (damnit. Too slow little beetle) */
532 void xbt_log_preinit(void)
534 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
535 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
536 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
537 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
538 log_cat_init_mutex = xbt_os_rmutex_init();
541 static void xbt_log_connect_categories(void)
543 /* Connect our log channels: that must be done manually under windows */
544 /* Also permit that they are correctly listed by xbt_log_help_categories() */
547 XBT_LOG_CONNECT(xbt);
548 XBT_LOG_CONNECT(graphxml_parse);
549 XBT_LOG_CONNECT(log);
551 XBT_LOG_CONNECT(mm_diff);
553 XBT_LOG_CONNECT(module);
554 XBT_LOG_CONNECT(peer);
555 XBT_LOG_CONNECT(replay);
556 XBT_LOG_CONNECT(strbuff);
557 XBT_LOG_CONNECT(xbt_cfg);
558 XBT_LOG_CONNECT(xbt_dict);
559 XBT_LOG_CONNECT(xbt_dict_cursor);
560 XBT_LOG_CONNECT(xbt_dict_elm);
561 #ifdef XBT_USE_DEPRECATED
562 XBT_LOG_CONNECT(xbt_dict_multi);
564 XBT_LOG_CONNECT(xbt_dyn);
565 XBT_LOG_CONNECT(xbt_ex);
566 XBT_LOG_CONNECT(xbt_fifo);
567 XBT_LOG_CONNECT(xbt_graph);
568 XBT_LOG_CONNECT(xbt_heap);
569 XBT_LOG_CONNECT(xbt_lib);
570 XBT_LOG_CONNECT(xbt_mallocator);
571 XBT_LOG_CONNECT(xbt_matrix);
572 XBT_LOG_CONNECT(xbt_parmap);
573 XBT_LOG_CONNECT(xbt_queue);
574 XBT_LOG_CONNECT(xbt_set);
575 XBT_LOG_CONNECT(xbt_sync);
576 XBT_LOG_CONNECT(xbt_sync_os);
578 #ifdef simgrid_EXPORTS
579 /* The following categories are only defined in libsimgrid */
583 XBT_LOG_CONNECT(bindings);
584 XBT_LOG_CONNECT(lua);
585 XBT_LOG_CONNECT(lua_comm);
586 XBT_LOG_CONNECT(lua_host);
587 XBT_LOG_CONNECT(lua_platf);
588 XBT_LOG_CONNECT(lua_process);
589 XBT_LOG_CONNECT(lua_state_cloner);
590 XBT_LOG_CONNECT(lua_task);
591 XBT_LOG_CONNECT(lua_utils);
596 XBT_LOG_CONNECT(instr);
597 XBT_LOG_CONNECT(instr_api);
598 XBT_LOG_CONNECT(instr_config);
599 XBT_LOG_CONNECT(instr_msg);
600 XBT_LOG_CONNECT(instr_msg_process);
601 XBT_LOG_CONNECT(instr_msg_vm);
602 XBT_LOG_CONNECT(instr_paje_containers);
603 XBT_LOG_CONNECT(instr_paje_header);
604 XBT_LOG_CONNECT(instr_paje_trace);
605 XBT_LOG_CONNECT(instr_paje_types);
606 XBT_LOG_CONNECT(instr_paje_values);
607 XBT_LOG_CONNECT(instr_resource);
608 XBT_LOG_CONNECT(instr_routing);
609 XBT_LOG_CONNECT(instr_sd);
610 XBT_LOG_CONNECT(instr_surf);
615 XBT_LOG_CONNECT(jedule);
616 XBT_LOG_CONNECT(jed_out);
617 XBT_LOG_CONNECT(jed_sd);
623 XBT_LOG_CONNECT(mc_checkpoint);
624 XBT_LOG_CONNECT(mc_compare);
625 XBT_LOG_CONNECT(mc_dpor);
626 XBT_LOG_CONNECT(mc_global);
627 XBT_LOG_CONNECT(mc_liveness);
628 XBT_LOG_CONNECT(mc_memory);
629 XBT_LOG_CONNECT(mc_memory_map);
630 XBT_LOG_CONNECT(mc_request);
634 XBT_LOG_CONNECT(msg);
635 XBT_LOG_CONNECT(msg_action);
636 XBT_LOG_CONNECT(msg_gos);
637 XBT_LOG_CONNECT(msg_io);
638 XBT_LOG_CONNECT(msg_kernel);
639 XBT_LOG_CONNECT(msg_mailbox);
640 XBT_LOG_CONNECT(msg_new_API);
641 XBT_LOG_CONNECT(msg_process);
642 XBT_LOG_CONNECT(msg_task);
643 XBT_LOG_CONNECT(msg_vm);
647 XBT_LOG_CONNECT(sd_daxparse);
649 XBT_LOG_CONNECT(sd_dotparse);
651 XBT_LOG_CONNECT(sd_kernel);
652 XBT_LOG_CONNECT(sd_task);
653 XBT_LOG_CONNECT(sd_workstation);
656 XBT_LOG_CONNECT(simix);
657 XBT_LOG_CONNECT(simix_context);
658 XBT_LOG_CONNECT(simix_deployment);
659 XBT_LOG_CONNECT(simix_environment);
660 XBT_LOG_CONNECT(simix_host);
661 XBT_LOG_CONNECT(simix_io);
662 XBT_LOG_CONNECT(simix_kernel);
663 XBT_LOG_CONNECT(simix_network);
664 XBT_LOG_CONNECT(simix_new_api);
665 XBT_LOG_CONNECT(simix_process);
666 XBT_LOG_CONNECT(simix_smurf);
667 XBT_LOG_CONNECT(simix_synchro);
670 /* SMPI categories are connected in smpi_global.c */
673 XBT_LOG_CONNECT(surf);
674 XBT_LOG_CONNECT(platf_generator);
675 XBT_LOG_CONNECT(random);
676 XBT_LOG_CONNECT(surf_config);
677 XBT_LOG_CONNECT(surf_cpu);
678 XBT_LOG_CONNECT(surf_cpu_ti);
679 XBT_LOG_CONNECT(surf_kernel);
680 XBT_LOG_CONNECT(surf_lagrange);
681 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
682 XBT_LOG_CONNECT(surf_maxmin);
683 XBT_LOG_CONNECT(surf_network);
684 XBT_LOG_CONNECT(surf_new_model);
686 XBT_LOG_CONNECT(surf_network_gtnets);
687 XBT_LOG_CONNECT(surf_network_gtnets_interface);
688 XBT_LOG_CONNECT(surf_network_gtnets_simulator);
689 XBT_LOG_CONNECT(surf_network_gtnets_topology);
692 XBT_LOG_CONNECT(surf_network_ns3);
693 XBT_LOG_CONNECT(interface_ns3);
694 XBT_LOG_CONNECT(simulator_ns3);
696 XBT_LOG_CONNECT(surf_parse);
697 XBT_LOG_CONNECT(surf_route);
698 XBT_LOG_CONNECT(surf_routing_generic);
699 XBT_LOG_CONNECT(surf_route_cluster);
700 XBT_LOG_CONNECT(surf_route_dijkstra);
701 XBT_LOG_CONNECT(surf_route_floyd);
702 XBT_LOG_CONNECT(surf_route_full);
703 XBT_LOG_CONNECT(surf_route_none);
704 XBT_LOG_CONNECT(surf_route_vivaldi);
705 XBT_LOG_CONNECT(surf_storage);
706 XBT_LOG_CONNECT(surf_trace);
707 XBT_LOG_CONNECT(surf_workstation);
709 #endif /* simgrid_EXPORTS */
712 static void xbt_log_help(void);
713 static void xbt_log_help_categories(void);
715 /** @brief Get all logging settings from the command line
717 * xbt_log_control_set() is called on each string we got from cmd line
719 void xbt_log_init(int *argc, char **argv)
721 unsigned help_requested = 0; /* 1: logs; 2: categories */
725 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
727 xbt_log_connect_categories();
729 /* Set logs and init log submodule */
730 for (j = i = 1; i < *argc; i++) {
731 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
732 opt = strchr(argv[i], '=');
734 xbt_log_control_set(opt);
735 XBT_DEBUG("Did apply '%s' as log setting", opt);
736 } else if (!strcmp(argv[i], "--help-logs")) {
738 } else if (!strcmp(argv[i], "--help-log-categories")) {
749 if (help_requested) {
750 if (help_requested & 1)
752 if (help_requested & 2)
753 xbt_log_help_categories();
758 static void log_cat_exit(xbt_log_category_t cat)
760 xbt_log_category_t child;
763 if (cat->appender->free_)
764 cat->appender->free_(cat->appender);
768 if (cat->layout->free_)
769 cat->layout->free_(cat->layout);
773 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
777 void xbt_log_postexit(void)
779 XBT_VERB("Exiting log");
780 xbt_os_rmutex_destroy(log_cat_init_mutex);
781 xbt_dynar_free(&xbt_log_settings);
782 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
785 /* Size of the static string in which we build the log string */
786 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
787 /* Minimum size of the dynamic string in which we build the log string
788 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
789 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
791 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
793 xbt_log_category_t cat = ev->cat;
795 xbt_assert(ev->priority >= 0,
796 "Negative logging priority naturally forbidden");
797 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
798 "Priority %d is greater than the biggest allowed value",
802 xbt_log_appender_t appender = cat->appender;
805 continue; /* No appender, try next */
807 xbt_assert(cat->layout,
808 "No valid layout for the appender of category %s", cat->name);
810 /* First, try with a static buffer */
811 if (XBT_LOG_STATIC_BUFFER_SIZE) {
812 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
815 ev->buffer_size = sizeof buff;
816 va_start(ev->ap, fmt);
817 done = cat->layout->do_layout(cat->layout, ev, fmt);
820 appender->do_append(appender, buff);
821 continue; /* Ok, that worked: go next */
825 /* The static buffer was too small, use a dynamically expanded one */
826 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
827 ev->buffer = xbt_malloc(ev->buffer_size);
830 va_start(ev->ap, fmt);
831 done = cat->layout->do_layout(cat->layout, ev, fmt);
835 ev->buffer_size *= 2;
836 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
838 appender->do_append(appender, ev->buffer);
839 xbt_free(ev->buffer);
841 } while (cat->additivity && (cat = cat->parent, 1));
844 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
845 #undef XBT_LOG_STATIC_BUFFER_SIZE
849 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
850 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
851 * recursion, we can not use the standard logging macros in
852 * _xbt_log_cat_init(), and in all functions called from it.
854 * To circumvent the problem, we define the macro_xbt_log_init() as
855 * (0) for the length of the affected functions, and we do not forget
856 * to undefine it at the end!
859 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
860 xbt_log_setting_t setting)
862 #define _xbt_log_cat_init(a, b) (0)
864 if (setting->thresh != xbt_log_priority_uninitialized) {
865 xbt_log_threshold_set(category, setting->thresh);
867 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
868 category->name, xbt_log_priority_names[category->threshold],
869 category->threshold);
873 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
875 XBT_DEBUG("Apply settings for category '%s': set format to %s",
876 category->name, setting->fmt);
879 if (setting->additivity != -1) {
880 xbt_log_additivity_set(category, setting->additivity);
882 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
883 category->name, (setting->additivity ? "on" : "off"));
885 if (setting->appender) {
886 xbt_log_appender_set(category, setting->appender);
887 if (!category->layout)
888 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
889 category->additivity = 0;
890 XBT_DEBUG("Set %p as appender of category '%s'",
891 setting->appender, category->name);
893 #undef _xbt_log_cat_init
897 * This gets called the first time a category is referenced and performs the
899 * Also resets threshold to inherited!
901 int _xbt_log_cat_init(xbt_log_category_t category,
902 e_xbt_log_priority_t priority)
904 #define _xbt_log_cat_init(a, b) (0)
906 if (log_cat_init_mutex != NULL) {
907 xbt_os_rmutex_acquire(log_cat_init_mutex);
910 if (category->initialized) {
911 if (log_cat_init_mutex != NULL) {
912 xbt_os_rmutex_release(log_cat_init_mutex);
914 return priority >= category->threshold;
918 xbt_log_setting_t setting = NULL;
921 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
923 (category->firstChild ? category->firstChild->name : "none"),
924 (category->nextSibling ? category->nextSibling->name : "none"));
926 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
927 category->threshold = xbt_log_priority_info;
928 category->appender = xbt_log_default_appender;
929 category->layout = xbt_log_default_layout;
932 if (!category->parent)
933 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
935 XBT_DEBUG("Set %s (%s) as father of %s ",
936 category->parent->name,
937 (category->parent->initialized ?
938 xbt_log_priority_names[category->parent->threshold] : "uninited"),
940 xbt_log_parent_set(category, category->parent);
942 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
943 char *buf, *res = NULL;
944 xbt_log_category_t cpp = category->parent->firstChild;
947 buf = bprintf("%s %s", res, cpp->name);
951 res = xbt_strdup(cpp->name);
953 cpp = cpp->nextSibling;
956 XBT_DEBUG("Children of %s: %s; nextSibling: %s",
957 category->parent->name, res,
958 (category->parent->nextSibling ?
959 category->parent->nextSibling->name : "none"));
966 /* Apply the control */
967 if (xbt_log_settings) {
968 xbt_assert(category, "NULL category");
969 xbt_assert(category->name);
971 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
972 xbt_assert(setting, "Damnit, NULL cat in the list");
973 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
976 if (!strcmp(setting->catname, category->name)) {
978 _xbt_log_cat_apply_set(category, setting);
979 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
984 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
985 category->name, xbt_log_priority_names[category->threshold],
986 category->threshold);
989 category->initialized = 1;
990 if (log_cat_init_mutex != NULL) {
991 xbt_os_rmutex_release(log_cat_init_mutex);
993 return priority >= category->threshold;
995 #undef _xbt_log_cat_init
998 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
1000 xbt_assert(cat, "NULL category to be given a parent");
1001 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1003 /* if the category is initialized, unlink from current parent */
1004 if (cat->initialized) {
1006 xbt_log_category_t *cpp = &cat->parent->firstChild;
1008 while (*cpp != cat && *cpp != NULL) {
1009 cpp = &(*cpp)->nextSibling;
1012 xbt_assert(*cpp == cat);
1013 *cpp = cat->nextSibling;
1016 cat->parent = parent;
1017 cat->nextSibling = parent->firstChild;
1019 parent->firstChild = cat;
1021 if (!parent->initialized)
1022 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1024 cat->threshold = parent->threshold;
1026 cat->isThreshInherited = 1;
1029 static void _set_inherited_thresholds(xbt_log_category_t cat)
1032 xbt_log_category_t child = cat->firstChild;
1034 for (; child != NULL; child = child->nextSibling) {
1035 if (child->isThreshInherited) {
1036 if (cat != &_XBT_LOGV(log))
1037 XBT_VERB("Set category threshold of %s to %s (=%d)",
1038 child->name, xbt_log_priority_names[cat->threshold],
1040 child->threshold = cat->threshold;
1041 _set_inherited_thresholds(child);
1048 void xbt_log_threshold_set(xbt_log_category_t cat,
1049 e_xbt_log_priority_t threshold)
1051 cat->threshold = threshold;
1052 cat->isThreshInherited = 0;
1054 _set_inherited_thresholds(cat);
1058 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1061 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1062 const char *name, *dot, *eq;
1064 set->catname = NULL;
1065 set->thresh = xbt_log_priority_uninitialized;
1067 set->additivity = -1;
1068 set->appender = NULL;
1070 if (!*control_string)
1072 XBT_DEBUG("Parse log setting '%s'", control_string);
1074 control_string += strspn(control_string, " ");
1075 name = control_string;
1076 control_string += strcspn(control_string, ".= ");
1077 dot = control_string;
1078 control_string += strcspn(control_string, ":= ");
1079 eq = control_string;
1080 control_string += strcspn(control_string, " ");
1082 xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
1083 "Invalid control string '%s'", control_string);
1085 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
1087 char *neweq = xbt_strdup(eq + 1);
1088 char *p = neweq - 1;
1090 while (*(++p) != '\0') {
1091 if (*p >= 'a' && *p <= 'z') {
1096 XBT_DEBUG("New priority name = %s", neweq);
1097 for (i = 0; i < xbt_log_priority_infinite; i++) {
1098 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1099 XBT_DEBUG("This is priority %d", i);
1103 if (i < xbt_log_priority_infinite) {
1104 set->thresh = (e_xbt_log_priority_t) i;
1106 THROWF(arg_error, 0,
1107 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1111 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1112 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1114 char *neweq = xbt_strdup(eq + 1);
1115 char *p = neweq - 1;
1117 while (*(++p) != '\0') {
1118 if (*p >= 'a' && *p <= 'z') {
1122 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1123 || !strcmp(neweq, "1")) {
1124 set->additivity = 1;
1126 set->additivity = 0;
1129 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1130 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1132 char *neweq = xbt_strdup(eq + 1);
1134 if (!strncmp(neweq, "file:", 5)) {
1135 set->appender = xbt_log_appender_file_new(neweq + 5);
1137 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1140 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1141 set->fmt = xbt_strdup(eq + 1);
1144 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1145 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1148 set->catname = (char *) xbt_malloc(dot - name + 1);
1150 memcpy(set->catname, name, dot - name);
1151 set->catname[dot - name] = '\0'; /* Just in case */
1152 XBT_DEBUG("This is for cat '%s'", set->catname);
1157 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1160 xbt_log_category_t child, res;
1162 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1163 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1164 (cat->nextSibling ? cat->nextSibling->name : "none"));
1165 if (!strcmp(cat->name, name))
1168 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1169 XBT_DEBUG("Dig into %s", child->name);
1170 res = _xbt_log_cat_searchsub(child, name);
1180 * \param control_string What to parse
1182 * Typically passed a command-line argument. The string has the syntax:
1184 * ( [category] "." [keyword] ":" value (" ")... )...
1186 * where [category] is one the category names (see \ref XBT_log_cats for
1187 * a complete list of the ones defined in the SimGrid library)
1188 * and keyword is one of the following:
1190 * - thres: category's threshold priority. Possible values:
1191 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1192 * - add or additivity: whether the logging actions must be passed to
1193 * the parent category.
1194 * Possible values: 0, 1, no, yes, on, off.
1195 * Default value: yes.
1196 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1197 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1201 void xbt_log_control_set(const char *control_string)
1203 xbt_log_setting_t set;
1205 /* To split the string in commands, and the cursors */
1206 xbt_dynar_t set_strings;
1210 if (!control_string)
1212 XBT_DEBUG("Parse log settings '%s'", control_string);
1214 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1215 if (!strcmp(control_string, "no_loc")) {
1219 /* some initialization if this is the first time that this get called */
1220 if (xbt_log_settings == NULL)
1221 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1224 /* split the string, and remove empty entries */
1225 set_strings = xbt_str_split_quoted(control_string);
1227 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1228 xbt_dynar_free(&set_strings);
1232 /* Parse each entry and either use it right now (if the category was already
1233 created), or store it for further use */
1234 xbt_dynar_foreach(set_strings, cpt, str) {
1235 xbt_log_category_t cat = NULL;
1237 set = _xbt_log_parse_setting(str);
1239 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1242 XBT_DEBUG("Apply directly");
1243 _xbt_log_cat_apply_set(cat, set);
1244 _free_setting((void *) &set);
1247 XBT_DEBUG("Store for further application");
1248 XBT_DEBUG("push %p to the settings", (void *) set);
1249 xbt_dynar_push(xbt_log_settings, &set);
1252 xbt_dynar_free(&set_strings);
1255 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1257 if (cat->appender) {
1258 if (cat->appender->free_)
1259 cat->appender->free_(cat->appender);
1260 free(cat->appender);
1262 cat->appender = app;
1265 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1267 #define _xbt_log_cat_init(a, b) (0)
1268 if (!cat->appender) {
1270 ("No appender to category %s. Setting the file appender as default",
1272 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1275 if (cat->layout->free_) {
1276 cat->layout->free_(cat->layout);
1281 xbt_log_additivity_set(cat, 0);
1282 #undef _xbt_log_cat_init
1285 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1287 cat->additivity = additivity;
1290 static void xbt_log_help(void)
1293 "Description of the logging output:\n"
1295 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1296 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1297 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1298 " -> trace: enter and return of some functions\n"
1299 " -> debug: crufty output\n"
1300 " -> verbose: verbose output for the user wanting more\n"
1301 " -> info: output about the regular functionning\n"
1302 " -> warning: minor issue encountered\n"
1303 " -> error: issue encountered\n"
1304 " -> critical: major issue encountered\n"
1306 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1307 " OPTIONS may be:\n"
1308 " -> %%%%: the %% char\n"
1309 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1310 " -> %%e: plain old space (SimGrid extension)\n"
1312 " -> %%m: user-provided message\n"
1314 " -> %%c: Category name (LOG4J compatible)\n"
1315 " -> %%p: Priority name (LOG4J compatible)\n"
1317 " -> %%h: Hostname (SimGrid extension)\n"
1318 " -> %%P: Process name (SimGrid extension)\n"
1319 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1320 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1322 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1323 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1324 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1325 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1326 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1328 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1329 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1330 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1332 " -> %%d: date (UNIX-like epoch)\n"
1333 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1336 " --help-log-categories Display the current hierarchy of log categories.\n"
1337 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
1342 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1344 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1345 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1346 return strcmp(a->name, b->name);
1349 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1356 xbt_log_category_t cat;
1361 if (category->parent) {
1362 this_prefix = bprintf("%s \\_ ", prefix);
1363 child_prefix = bprintf("%s | ", prefix);
1365 this_prefix = xbt_strdup(prefix);
1366 child_prefix = xbt_strdup(prefix);
1369 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1370 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1371 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1373 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1375 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1376 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1377 *strrchr(child_prefix, '|') = ' ';
1378 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1379 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1380 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1383 xbt_dynar_free(&dynar);
1384 xbt_free(this_prefix);
1385 xbt_free(child_prefix);
1388 static void xbt_log_help_categories(void)
1390 printf("Current log category hierarchy:\n");
1391 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");