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 typcially 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>thres</tt> keyword.
293 For example, \verbatim --log=root.thres:debug\endverbatim will make
294 SimGrid <b>extremely</b> verbose while \verbatim
295 --log=root.thres:critical\endverbatim should shut it almost
296 completely off. The full list of recognized thresholds is the following:
298 - trace: enter and return of some functions
299 - debug: crufty output
300 - verbose: verbose output for the user wanting more
301 - info: output about the regular functionning
302 - warning: minor issue encountered
303 - error: issue encountered
304 - critical: major issue encountered
306 \subsection log_use_conf_multi 3.1.2 Passing several settings
308 You can provide several of those arguments to change the setting of several
309 categories, they will be applied from left to right. So,
310 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
311 disable almost any logging.
313 Note that the quotes on above line are mandatory because there is a space in
314 the argument, so we are protecting ourselves from the shell, not from SimGrid.
315 We could also reach the same effect with this:
316 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
318 \subsection log_use_conf_fmt 3.1.3 Format configuration
320 As with SimGrid 3.3, it is possible to control the format of log
321 messages. This is done through the <tt>fmt</tt> keyword. For example,
322 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
323 user-message only, removing any decoration such as the date, or the
324 process ID, everything.
326 Here are the existing format directives:
329 - %%n: platform-dependent line separator (LOG4J compatible)
330 - %%e: plain old space (SimGrid extension)
332 - %%m: user-provided message
334 - %%c: Category name (LOG4J compatible)
335 - %%p: Priority name (LOG4J compatible)
337 - %%h: Hostname (SimGrid extension)
338 - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank)
339 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
340 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
342 - %%F: file name where the log event was raised (LOG4J compatible)
343 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
344 - %%L: line number where the log event was raised (LOG4J compatible)
345 - %%M: function name (LOG4J compatible -- called method name here of course).
346 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
348 - %%b: full backtrace (Called %%throwable in LOG4J).
349 Defined only under windows or when using the GNU libc because backtrace() is not defined
350 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
351 - %%B: short backtrace (only the first line of the %%b).
352 Called %%throwable{short} in LOG4J; defined where %%b is.
354 - %%d: date (UNIX-like epoch)
355 - %%r: application age (time elapsed since the beginning of the application)
358 If you want to mimic the simple layout with the format one, you would use this
359 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
360 because the simple layout do not display the message location for messages at
361 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
362 case). Moreover, if there is no process name (ie, messages coming from the
363 library itself, or test programs doing strange things) do not display the
364 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
365 [%%c/%%p] %%m%%n' if they are at priority INFO).
367 For now, there is only two format modifiers: the precision and the
368 width fields. You can for example specify %.4r to get the application
369 age with 4 numbers after the radix, or %15p to get the process name
370 on 15 columns. Finally, you can specify %10.6r to get the time on at
371 most 10 columns, with 6 numbers after the radix.
373 Note that when specifying the width, it is filled with spaces. That
374 is to say that for example %5r in your format is converted to "% 5f"
375 for printf (note the extra space); there is no way to fill the empty
376 columns with 0 (ie, pass "%05f" to printf). Another limitation is
377 that you cannot set specific layouts to the several priorities.
379 \subsection log_use_conf_app 3.1.4 Category appender
381 As with SimGrid 3.3, it is possible to control the appender of log
382 messages. This is done through the <tt>app</tt> keyword. For example,
383 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
384 to the file mylogfile.
386 Any appender setup this way have its own layout format (simple one by default),
387 so you may have to change it too afterward. Moreover, the additivity of the log category
388 is also set to false to prevent log event displayed by this appender to "leak" to any other
389 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
392 \subsection log_use_conf_add 3.1.5 Category additivity
394 The <tt>add</tt> keyword allows to specify the additivity of a
395 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
396 and 'off' are all valid values, with 'yes' as default.
398 The following example resets the additivity of the xbt category to true (which is its default value).
399 \verbatim --log=xbt.add:yes\endverbatim
401 \section log_use_misc 3.2 Misc and Caveats
403 - Do not use any of the macros that start with '_'.
404 - Log4J has a 'rolling file appender' which you can select with a run-time
405 option and specify the max file size. This would be a nice default for
406 non-kernel applications.
407 - Careful, category names are global variables.
409 \section log_internals 4. Internal considerations
411 This module is a mess of macro black magic, and when it goes wrong,
412 SimGrid studently loose its ability to explain its problems. When
413 messing around this module, I often find useful to define
414 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
415 of finding what's going wrong. But things are quite verbose when
416 everything is enabled...
418 \section log_in_perf 4.1 Performance
420 Except for the first invocation of a given category, a disabled logging request
421 requires an a single comparison of a static variable to a constant.
423 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
424 causes all logging requests with a lower priority to be optimized to 0 cost
425 by the compiler. By setting it to xbt_log_priority_infinite, all logging
426 requests are statically disabled at compile time and cost nothing. Released executables
427 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
428 \verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
430 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
431 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
432 the requests of priority below INFO.
434 \todo Logging performance *may* be improved further by improving the message
435 propagation from appender to appender in the category tree.
437 \section log_in_app 4.2 Appenders
439 Each category has an optional appender. An appender is a pointer to a
440 structure which starts with a pointer to a do_append() function. do_append()
441 prints a message to a log.
443 When a category is passed a message by one of the logging macros, the
444 category performs the following actions:
446 - if the category has an appender, the message is passed to the
447 appender's do_append() function,
448 - if additivity is true for the category, the message is passed to
449 the category's parent. Additivity is true by default, and can be
450 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
451 Also, when you add an appender to a category, its additivity is automatically turned to off.
452 Turn it back on afterward if it is not what you wanted.
454 By default, only the root category have an appender, and any other category has
455 its additivity set to true. This causes all messages to be logged by the root
458 The default appender function currently prints to stderr, and the only other
459 existing one writes to the specified file. More would be needed, like the one
460 able to send the logs to a remote dedicated server.
461 This is on our TODO list for quite a while now, but your help would be
462 welcome here, too. */
464 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
465 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
470 e_xbt_log_priority_t thresh;
472 xbt_log_appender_t appender;
473 } s_xbt_log_setting_t, *xbt_log_setting_t;
475 static xbt_dynar_t xbt_log_settings = NULL;
477 static void _free_setting(void *s)
479 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
487 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
488 xbt_log_setting_t setting);
490 const char *xbt_log_priority_names[8] = {
501 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
502 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
503 "root", "The common ancestor for all categories",
504 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
505 0 /* isThreshInherited */ ,
506 NULL /* appender */ , NULL /* layout */ ,
510 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
511 "Loggings from the logging mechanism itself");
513 /* create the default appender and install it in the root category,
514 which were already created (damnit. Too slow little beetle) */
515 void xbt_log_preinit(void)
517 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
518 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
519 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
520 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
521 log_cat_init_mutex = xbt_os_rmutex_init();
524 static void xbt_log_connect_categories(void)
526 /* Connect our log channels: that must be done manually under windows */
527 /* Also permit that they are correctly listed by xbt_log_help_categories() */
530 XBT_LOG_CONNECT(xbt);
531 XBT_LOG_CONNECT(graphxml_parse);
532 XBT_LOG_CONNECT(log);
534 XBT_LOG_CONNECT(mm_diff);
536 XBT_LOG_CONNECT(module);
537 XBT_LOG_CONNECT(peer);
538 XBT_LOG_CONNECT(replay);
539 XBT_LOG_CONNECT(strbuff);
540 XBT_LOG_CONNECT(xbt_cfg);
541 XBT_LOG_CONNECT(xbt_dict);
542 XBT_LOG_CONNECT(xbt_dict_cursor);
543 XBT_LOG_CONNECT(xbt_dict_elm);
544 #ifdef XBT_USE_DEPRECATED
545 XBT_LOG_CONNECT(xbt_dict_multi);
547 XBT_LOG_CONNECT(xbt_dyn);
548 XBT_LOG_CONNECT(xbt_ex);
549 XBT_LOG_CONNECT(xbt_fifo);
550 XBT_LOG_CONNECT(xbt_graph);
551 XBT_LOG_CONNECT(xbt_heap);
552 XBT_LOG_CONNECT(xbt_lib);
553 XBT_LOG_CONNECT(xbt_mallocator);
554 XBT_LOG_CONNECT(xbt_matrix);
555 XBT_LOG_CONNECT(xbt_parmap);
556 XBT_LOG_CONNECT(xbt_parmap_unit);
557 XBT_LOG_CONNECT(xbt_queue);
558 XBT_LOG_CONNECT(xbt_set);
559 XBT_LOG_CONNECT(xbt_sync);
560 XBT_LOG_CONNECT(xbt_sync_os);
562 #ifdef simgrid_EXPORTS
563 /* The following categories are only defined in libsimgrid */
567 XBT_LOG_CONNECT(bindings);
568 XBT_LOG_CONNECT(lua);
569 XBT_LOG_CONNECT(lua_comm);
570 XBT_LOG_CONNECT(lua_host);
571 XBT_LOG_CONNECT(lua_platf);
572 XBT_LOG_CONNECT(lua_process);
573 XBT_LOG_CONNECT(lua_state_cloner);
574 XBT_LOG_CONNECT(lua_task);
575 XBT_LOG_CONNECT(lua_utils);
580 XBT_LOG_CONNECT(instr);
581 XBT_LOG_CONNECT(instr_api);
582 XBT_LOG_CONNECT(instr_config);
583 XBT_LOG_CONNECT(instr_msg);
584 XBT_LOG_CONNECT(instr_msg_process);
585 XBT_LOG_CONNECT(instr_msg_vm);
586 XBT_LOG_CONNECT(instr_paje_containers);
587 XBT_LOG_CONNECT(instr_paje_header);
588 XBT_LOG_CONNECT(instr_paje_trace);
589 XBT_LOG_CONNECT(instr_paje_types);
590 XBT_LOG_CONNECT(instr_paje_values);
591 XBT_LOG_CONNECT(instr_resource);
592 XBT_LOG_CONNECT(instr_routing);
593 XBT_LOG_CONNECT(instr_sd);
594 XBT_LOG_CONNECT(instr_surf);
599 XBT_LOG_CONNECT(jedule);
600 XBT_LOG_CONNECT(jed_out);
601 XBT_LOG_CONNECT(jed_sd);
607 XBT_LOG_CONNECT(mc_checkpoint);
608 XBT_LOG_CONNECT(mc_compare);
609 XBT_LOG_CONNECT(mc_dpor);
610 XBT_LOG_CONNECT(mc_global);
611 XBT_LOG_CONNECT(mc_liveness);
612 XBT_LOG_CONNECT(mc_memory);
613 XBT_LOG_CONNECT(mc_memory_map);
614 XBT_LOG_CONNECT(mc_request);
618 XBT_LOG_CONNECT(msg);
619 XBT_LOG_CONNECT(msg_action);
620 XBT_LOG_CONNECT(msg_gos);
621 XBT_LOG_CONNECT(msg_io);
622 XBT_LOG_CONNECT(msg_kernel);
623 XBT_LOG_CONNECT(msg_mailbox);
624 XBT_LOG_CONNECT(msg_new_API);
625 XBT_LOG_CONNECT(msg_process);
626 XBT_LOG_CONNECT(msg_task);
627 XBT_LOG_CONNECT(msg_vm);
631 XBT_LOG_CONNECT(sd_daxparse);
633 XBT_LOG_CONNECT(sd_dotparse);
635 XBT_LOG_CONNECT(sd_kernel);
636 XBT_LOG_CONNECT(sd_task);
637 XBT_LOG_CONNECT(sd_workstation);
640 XBT_LOG_CONNECT(simix);
641 XBT_LOG_CONNECT(simix_context);
642 XBT_LOG_CONNECT(simix_deployment);
643 XBT_LOG_CONNECT(simix_environment);
644 XBT_LOG_CONNECT(simix_host);
645 XBT_LOG_CONNECT(simix_io);
646 XBT_LOG_CONNECT(simix_kernel);
647 XBT_LOG_CONNECT(simix_network);
648 XBT_LOG_CONNECT(simix_new_api);
649 XBT_LOG_CONNECT(simix_process);
650 XBT_LOG_CONNECT(simix_smurf);
651 XBT_LOG_CONNECT(simix_synchro);
654 /* SMPI categories are connected in smpi_global.c */
657 XBT_LOG_CONNECT(surf);
658 XBT_LOG_CONNECT(platf_generator);
659 XBT_LOG_CONNECT(random);
660 XBT_LOG_CONNECT(surf_config);
661 XBT_LOG_CONNECT(surf_cpu);
662 XBT_LOG_CONNECT(surf_cpu_ti);
663 XBT_LOG_CONNECT(surf_kernel);
664 XBT_LOG_CONNECT(surf_lagrange);
665 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
666 XBT_LOG_CONNECT(surf_maxmin);
667 XBT_LOG_CONNECT(surf_network);
668 XBT_LOG_CONNECT(surf_new_model);
670 XBT_LOG_CONNECT(surf_network_gtnets);
671 XBT_LOG_CONNECT(surf_network_gtnets_interface);
672 XBT_LOG_CONNECT(surf_network_gtnets_simulator);
673 XBT_LOG_CONNECT(surf_network_gtnets_topology);
676 XBT_LOG_CONNECT(surf_network_ns3);
677 XBT_LOG_CONNECT(interface_ns3);
678 XBT_LOG_CONNECT(simulator_ns3);
680 XBT_LOG_CONNECT(surf_parse);
681 XBT_LOG_CONNECT(surf_route);
682 XBT_LOG_CONNECT(surf_routing_generic);
683 XBT_LOG_CONNECT(surf_route_cluster);
684 XBT_LOG_CONNECT(surf_route_dijkstra);
685 XBT_LOG_CONNECT(surf_route_floyd);
686 XBT_LOG_CONNECT(surf_route_full);
687 XBT_LOG_CONNECT(surf_route_none);
688 XBT_LOG_CONNECT(surf_route_rulebased);
689 XBT_LOG_CONNECT(surf_route_vivaldi);
690 XBT_LOG_CONNECT(surf_storage);
691 XBT_LOG_CONNECT(surf_trace);
692 XBT_LOG_CONNECT(surf_workstation);
694 #endif /* simgrid_EXPORTS */
697 static void xbt_log_help(void);
698 static void xbt_log_help_categories(void);
700 /** @brief Get all logging settings from the command line
702 * xbt_log_control_set() is called on each string we got from cmd line
704 void xbt_log_init(int *argc, char **argv)
706 unsigned help_requested = 0; /* 1: logs; 2: categories */
710 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
712 xbt_log_connect_categories();
714 /* Set logs and init log submodule */
715 for (j = i = 1; i < *argc; i++) {
716 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
717 opt = strchr(argv[i], '=');
719 xbt_log_control_set(opt);
720 XBT_DEBUG("Did apply '%s' as log setting", opt);
721 } else if (!strcmp(argv[i], "--help-logs")) {
723 } else if (!strcmp(argv[i], "--help-log-categories")) {
734 if (help_requested) {
735 if (help_requested & 1)
737 if (help_requested & 2)
738 xbt_log_help_categories();
743 static void log_cat_exit(xbt_log_category_t cat)
745 xbt_log_category_t child;
748 if (cat->appender->free_)
749 cat->appender->free_(cat->appender);
753 if (cat->layout->free_)
754 cat->layout->free_(cat->layout);
758 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
762 void xbt_log_postexit(void)
764 XBT_VERB("Exiting log");
765 xbt_os_rmutex_destroy(log_cat_init_mutex);
766 xbt_dynar_free(&xbt_log_settings);
767 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
770 /* Size of the static string in which we build the log string */
771 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
772 /* Minimum size of the dynamic string in which we build the log string
773 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
774 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
776 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
778 xbt_log_category_t cat = ev->cat;
780 xbt_assert(ev->priority >= 0,
781 "Negative logging priority naturally forbidden");
782 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
783 "Priority %d is greater than the biggest allowed value",
787 xbt_log_appender_t appender = cat->appender;
790 continue; /* No appender, try next */
792 xbt_assert(cat->layout,
793 "No valid layout for the appender of category %s", cat->name);
795 /* First, try with a static buffer */
796 if (XBT_LOG_STATIC_BUFFER_SIZE) {
797 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
800 ev->buffer_size = sizeof buff;
801 va_start(ev->ap, fmt);
802 done = cat->layout->do_layout(cat->layout, ev, fmt);
805 appender->do_append(appender, buff);
806 continue; /* Ok, that worked: go next */
810 /* The static buffer was too small, use a dynamically expanded one */
811 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
812 ev->buffer = xbt_malloc(ev->buffer_size);
815 va_start(ev->ap, fmt);
816 done = cat->layout->do_layout(cat->layout, ev, fmt);
820 ev->buffer_size *= 2;
821 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
823 appender->do_append(appender, ev->buffer);
824 xbt_free(ev->buffer);
826 } while (cat->additivity && (cat = cat->parent, 1));
829 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
830 #undef XBT_LOG_STATIC_BUFFER_SIZE
834 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
835 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
836 * recursion, we can not use the standard logging macros in
837 * _xbt_log_cat_init(), and in all functions called from it.
839 * To circumvent the problem, we define the macro_xbt_log_init() as
840 * (0) for the length of the affected functions, and we do not forget
841 * to undefine it at the end!
844 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
845 xbt_log_setting_t setting)
847 #define _xbt_log_cat_init(a, b) (0)
849 if (setting->thresh != xbt_log_priority_uninitialized) {
850 xbt_log_threshold_set(category, setting->thresh);
852 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
853 category->name, xbt_log_priority_names[category->threshold],
854 category->threshold);
858 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
860 XBT_DEBUG("Apply settings for category '%s': set format to %s",
861 category->name, setting->fmt);
864 if (setting->additivity != -1) {
865 xbt_log_additivity_set(category, setting->additivity);
867 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
868 category->name, (setting->additivity ? "on" : "off"));
870 if (setting->appender) {
871 xbt_log_appender_set(category, setting->appender);
872 if (!category->layout)
873 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
874 category->additivity = 0;
875 XBT_DEBUG("Set %p as appender of category '%s'",
876 setting->appender, category->name);
878 #undef _xbt_log_cat_init
882 * This gets called the first time a category is referenced and performs the
884 * Also resets threshold to inherited!
886 int _xbt_log_cat_init(xbt_log_category_t category,
887 e_xbt_log_priority_t priority)
889 #define _xbt_log_cat_init(a, b) (0)
891 if (log_cat_init_mutex != NULL) {
892 xbt_os_rmutex_acquire(log_cat_init_mutex);
895 if (category->initialized) {
896 if (log_cat_init_mutex != NULL) {
897 xbt_os_rmutex_release(log_cat_init_mutex);
899 return priority >= category->threshold;
903 xbt_log_setting_t setting = NULL;
906 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
908 (category->firstChild ? category->firstChild->name : "none"),
909 (category->nextSibling ? category->nextSibling->name : "none"));
911 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
912 category->threshold = xbt_log_priority_info;
913 category->appender = xbt_log_default_appender;
914 category->layout = xbt_log_default_layout;
917 if (!category->parent)
918 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
920 XBT_DEBUG("Set %s (%s) as father of %s ",
921 category->parent->name,
922 (category->parent->initialized ?
923 xbt_log_priority_names[category->parent->threshold] : "uninited"),
925 xbt_log_parent_set(category, category->parent);
927 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
928 char *buf, *res = NULL;
929 xbt_log_category_t cpp = category->parent->firstChild;
932 buf = bprintf("%s %s", res, cpp->name);
936 res = xbt_strdup(cpp->name);
938 cpp = cpp->nextSibling;
941 XBT_DEBUG("Children of %s: %s; nextSibling: %s",
942 category->parent->name, res,
943 (category->parent->nextSibling ?
944 category->parent->nextSibling->name : "none"));
951 /* Apply the control */
952 if (xbt_log_settings) {
953 xbt_assert(category, "NULL category");
954 xbt_assert(category->name);
956 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
957 xbt_assert(setting, "Damnit, NULL cat in the list");
958 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
961 if (!strcmp(setting->catname, category->name)) {
963 _xbt_log_cat_apply_set(category, setting);
964 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
969 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
970 category->name, xbt_log_priority_names[category->threshold],
971 category->threshold);
974 category->initialized = 1;
975 if (log_cat_init_mutex != NULL) {
976 xbt_os_rmutex_release(log_cat_init_mutex);
978 return priority >= category->threshold;
980 #undef _xbt_log_cat_init
983 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
985 xbt_assert(cat, "NULL category to be given a parent");
986 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
988 /* if the category is initialized, unlink from current parent */
989 if (cat->initialized) {
991 xbt_log_category_t *cpp = &cat->parent->firstChild;
993 while (*cpp != cat && *cpp != NULL) {
994 cpp = &(*cpp)->nextSibling;
997 xbt_assert(*cpp == cat);
998 *cpp = cat->nextSibling;
1001 cat->parent = parent;
1002 cat->nextSibling = parent->firstChild;
1004 parent->firstChild = cat;
1006 if (!parent->initialized)
1007 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1009 cat->threshold = parent->threshold;
1011 cat->isThreshInherited = 1;
1014 static void _set_inherited_thresholds(xbt_log_category_t cat)
1017 xbt_log_category_t child = cat->firstChild;
1019 for (; child != NULL; child = child->nextSibling) {
1020 if (child->isThreshInherited) {
1021 if (cat != &_XBT_LOGV(log))
1022 XBT_VERB("Set category threshold of %s to %s (=%d)",
1023 child->name, xbt_log_priority_names[cat->threshold],
1025 child->threshold = cat->threshold;
1026 _set_inherited_thresholds(child);
1033 void xbt_log_threshold_set(xbt_log_category_t cat,
1034 e_xbt_log_priority_t threshold)
1036 cat->threshold = threshold;
1037 cat->isThreshInherited = 0;
1039 _set_inherited_thresholds(cat);
1043 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1046 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1047 const char *name, *dot, *eq;
1049 set->catname = NULL;
1050 set->thresh = xbt_log_priority_uninitialized;
1052 set->additivity = -1;
1053 set->appender = NULL;
1055 if (!*control_string)
1057 XBT_DEBUG("Parse log setting '%s'", control_string);
1059 control_string += strspn(control_string, " ");
1060 name = control_string;
1061 control_string += strcspn(control_string, ".= ");
1062 dot = control_string;
1063 control_string += strcspn(control_string, ":= ");
1064 eq = control_string;
1065 control_string += strcspn(control_string, " ");
1067 xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
1068 "Invalid control string '%s'", control_string);
1070 if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
1072 char *neweq = xbt_strdup(eq + 1);
1073 char *p = neweq - 1;
1075 while (*(++p) != '\0') {
1076 if (*p >= 'a' && *p <= 'z') {
1081 XBT_DEBUG("New priority name = %s", neweq);
1082 for (i = 0; i < xbt_log_priority_infinite; i++) {
1083 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1084 XBT_DEBUG("This is priority %d", i);
1088 if (i < xbt_log_priority_infinite) {
1089 set->thresh = (e_xbt_log_priority_t) i;
1091 THROWF(arg_error, 0,
1092 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1096 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1097 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1099 char *neweq = xbt_strdup(eq + 1);
1100 char *p = neweq - 1;
1102 while (*(++p) != '\0') {
1103 if (*p >= 'a' && *p <= 'z') {
1107 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1108 || !strcmp(neweq, "1")) {
1109 set->additivity = 1;
1111 set->additivity = 0;
1114 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1115 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1117 char *neweq = xbt_strdup(eq + 1);
1119 if (!strncmp(neweq, "file:", 5)) {
1120 set->appender = xbt_log_appender_file_new(neweq + 5);
1122 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1125 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1126 set->fmt = xbt_strdup(eq + 1);
1129 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1130 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1133 set->catname = (char *) xbt_malloc(dot - name + 1);
1135 memcpy(set->catname, name, dot - name);
1136 set->catname[dot - name] = '\0'; /* Just in case */
1137 XBT_DEBUG("This is for cat '%s'", set->catname);
1142 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1145 xbt_log_category_t child, res;
1147 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1148 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1149 (cat->nextSibling ? cat->nextSibling->name : "none"));
1150 if (!strcmp(cat->name, name))
1153 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1154 XBT_DEBUG("Dig into %s", child->name);
1155 res = _xbt_log_cat_searchsub(child, name);
1165 * \param control_string What to parse
1167 * Typically passed a command-line argument. The string has the syntax:
1169 * ( [category] "." [keyword] ":" value (" ")... )...
1171 * where [category] is one the category names (see \ref XBT_log_cats for
1172 * a complete list of the ones defined in the SimGrid library)
1173 * and keyword is one of the following:
1175 * - thres: category's threshold priority. Possible values:
1176 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1177 * - add or additivity: whether the logging actions must be passed to
1178 * the parent category.
1179 * Possible values: 0, 1, no, yes, on, off.
1180 * Default value: yes.
1181 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1182 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1186 void xbt_log_control_set(const char *control_string)
1188 xbt_log_setting_t set;
1190 /* To split the string in commands, and the cursors */
1191 xbt_dynar_t set_strings;
1195 if (!control_string)
1197 XBT_DEBUG("Parse log settings '%s'", control_string);
1199 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1200 if (!strcmp(control_string, "no_loc")) {
1204 /* some initialization if this is the first time that this get called */
1205 if (xbt_log_settings == NULL)
1206 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1209 /* split the string, and remove empty entries */
1210 set_strings = xbt_str_split_quoted(control_string);
1212 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1213 xbt_dynar_free(&set_strings);
1217 /* Parse each entry and either use it right now (if the category was already
1218 created), or store it for further use */
1219 xbt_dynar_foreach(set_strings, cpt, str) {
1220 xbt_log_category_t cat = NULL;
1222 set = _xbt_log_parse_setting(str);
1224 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1227 XBT_DEBUG("Apply directly");
1228 _xbt_log_cat_apply_set(cat, set);
1229 _free_setting((void *) &set);
1232 XBT_DEBUG("Store for further application");
1233 XBT_DEBUG("push %p to the settings", (void *) set);
1234 xbt_dynar_push(xbt_log_settings, &set);
1237 xbt_dynar_free(&set_strings);
1240 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1242 if (cat->appender) {
1243 if (cat->appender->free_)
1244 cat->appender->free_(cat->appender);
1245 free(cat->appender);
1247 cat->appender = app;
1250 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1252 #define _xbt_log_cat_init(a, b) (0)
1253 if (!cat->appender) {
1255 ("No appender to category %s. Setting the file appender as default",
1257 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1260 if (cat->layout->free_) {
1261 cat->layout->free_(cat->layout);
1266 xbt_log_additivity_set(cat, 0);
1267 #undef _xbt_log_cat_init
1270 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1272 cat->additivity = additivity;
1275 static void xbt_log_help(void)
1278 "Description of the logging output:\n"
1280 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1281 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1282 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1283 " -> trace: enter and return of some functions\n"
1284 " -> debug: crufty output\n"
1285 " -> verbose: verbose output for the user wanting more\n"
1286 " -> info: output about the regular functionning\n"
1287 " -> warning: minor issue encountered\n"
1288 " -> error: issue encountered\n"
1289 " -> critical: major issue encountered\n"
1291 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1292 " OPTIONS may be:\n"
1293 " -> %%%%: the %% char\n"
1294 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1295 " -> %%e: plain old space (SimGrid extension)\n"
1297 " -> %%m: user-provided message\n"
1299 " -> %%c: Category name (LOG4J compatible)\n"
1300 " -> %%p: Priority name (LOG4J compatible)\n"
1302 " -> %%h: Hostname (SimGrid extension)\n"
1303 " -> %%P: Process name (SimGrid extension)\n"
1304 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1305 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1307 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1308 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1309 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1310 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1311 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1313 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1314 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1315 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1317 " -> %%d: date (UNIX-like epoch)\n"
1318 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1321 " --help-log-categories Display the current hierarchy of log categories.\n"
1322 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
1327 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1329 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1330 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1331 return strcmp(a->name, b->name);
1334 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1341 xbt_log_category_t cat;
1346 if (category->parent) {
1347 this_prefix = bprintf("%s \\_ ", prefix);
1348 child_prefix = bprintf("%s | ", prefix);
1350 this_prefix = xbt_strdup(prefix);
1351 child_prefix = xbt_strdup(prefix);
1354 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1355 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1356 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1358 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1360 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1361 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1362 *strrchr(child_prefix, '|') = ' ';
1363 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1364 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1365 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1368 xbt_dynar_free(&dynar);
1369 xbt_free(this_prefix);
1370 xbt_free(child_prefix);
1373 static void xbt_log_help_categories(void)
1375 printf("Current log category hierarchy:\n");
1376 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");