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 GRAS 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, gras_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 Another example can be found in the relevant part of the GRAS tutorial:
278 \ref GRAS_tut_tour_logs.
280 \section log_user 3. User interface
282 \section log_use_conf 3.1 Configuration
284 Although rarely done, it is possible to configure the logs during
285 program initialization by invoking the xbt_log_control_set() method
286 manually. A more conventional way is to use the --log command line
287 argument. xbt_init() (called by MSG_init(), gras_init() and friends)
288 checks and deals properly with such arguments.
290 \subsection log_use_conf_thres 3.1.1 Threshold configuration
292 The most common setting is to control which logging event will get
293 displayed by setting a threshold to each category through the
294 <tt>thres</tt> keyword.
296 For example, \verbatim --log=root.thres:debug\endverbatim will make
297 SimGrid <b>extremely</b> verbose while \verbatim
298 --log=root.thres:critical\endverbatim should shut it almost
299 completely off. The full list of recognized thresholds is the following:
301 - trace: enter and return of some functions
302 - debug: crufty output
303 - verbose: verbose output for the user wanting more
304 - info: output about the regular functionning
305 - warning: minor issue encountered
306 - error: issue encountered
307 - critical: major issue encountered
309 \subsection log_use_conf_multi 3.1.2 Passing several settings
311 You can provide several of those arguments to change the setting of several
312 categories, they will be applied from left to right. So,
313 \verbatim --log="root.thres:debug root.thres:critical"\endverbatim should
314 disable almost any logging.
316 Note that the quotes on above line are mandatory because there is a space in
317 the argument, so we are protecting ourselves from the shell, not from SimGrid.
318 We could also reach the same effect with this:
319 \verbatim --log=root.thres:debug --log=root.thres:critical\endverbatim
321 \subsection log_use_conf_fmt 3.1.3 Format configuration
323 As with SimGrid 3.3, it is possible to control the format of log
324 messages. This is done through the <tt>fmt</tt> keyword. For example,
325 \verbatim --log=root.fmt:%m\endverbatim reduces the output to the
326 user-message only, removing any decoration such as the date, or the
327 process ID, everything.
329 Here are the existing format directives:
332 - %%n: platform-dependent line separator (LOG4J compatible)
333 - %%e: plain old space (SimGrid extension)
335 - %%m: user-provided message
337 - %%c: Category name (LOG4J compatible)
338 - %%p: Priority name (LOG4J compatible)
340 - %%h: Hostname (SimGrid extension)
341 - %%P: Process name (SimGrid extension)
342 - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
343 - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
345 - %%F: file name where the log event was raised (LOG4J compatible)
346 - %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)
347 - %%L: line number where the log event was raised (LOG4J compatible)
348 - %%M: function name (LOG4J compatible -- called method name here of course).
349 Defined only when using gcc because there is no __FUNCTION__ elsewhere.
351 - %%b: full backtrace (Called %%throwable in LOG4J).
352 Defined only under windows or when using the GNU libc because backtrace() is not defined
353 elsewhere, and we only have a fallback for windows boxes, not mac ones for example.
354 - %%B: short backtrace (only the first line of the %%b).
355 Called %%throwable{short} in LOG4J; defined where %%b is.
357 - %%d: date (UNIX-like epoch)
358 - %%r: application age (time elapsed since the beginning of the application)
361 If you want to mimic the simple layout with the format one, you would use this
362 format: '[%%h:%%i:(%%i) %%r] %%l: [%%c/%%p] %%m%%n'. This is not completely correct
363 because the simple layout do not display the message location for messages at
364 priority INFO (thus, the fmt is '[%%h:%%i:(%%i) %%r] [%%c/%%p] %%m%%n' in this
365 case). Moreover, if there is no process name (ie, messages coming from the
366 library itself, or test programs doing strange things) do not display the
367 process identity (thus, fmt is '[%%r] %%l: [%%c/%%p] %%m%%n' in that case, and '[%%r]
368 [%%c/%%p] %%m%%n' if they are at priority INFO).
370 For now, there is only two format modifiers: the precision and the
371 width fields. You can for example specify %.4r to get the application
372 age with 4 numbers after the radix, or %15p to get the process name
373 on 15 columns. Finally, you can specify %10.6r to get the time on at
374 most 10 columns, with 6 numbers after the radix.
376 Note that when specifying the width, it is filled with spaces. That
377 is to say that for example %5r in your format is converted to "% 5f"
378 for printf (note the extra space); there is no way to fill the empty
379 columns with 0 (ie, pass "%05f" to printf). Another limitation is
380 that you cannot set specific layouts to the several priorities.
382 \subsection log_use_conf_app 3.1.4 Category appender
384 As with SimGrid 3.3, it is possible to control the appender of log
385 messages. This is done through the <tt>app</tt> keyword. For example,
386 \verbatim --log=root.app:file:mylogfile\endverbatim redirects the output
387 to the file mylogfile.
389 Any appender setup this way have its own layout format (simple one by default),
390 so you may have to change it too afterward. Moreover, the additivity of the log category
391 is also set to false to prevent log event displayed by this appender to "leak" to any other
392 appender higher in the hierarchy. If it is not what you wanted, you can naturally change it
395 \subsection log_use_conf_add 3.1.5 Category additivity
397 The <tt>add</tt> keyword allows to specify the additivity of a
398 category (see \ref log_in_app). '0', '1', 'no', 'yes', 'on'
399 and 'off' are all valid values, with 'yes' as default.
401 The following example resets the additivity of the xbt category to true (which is its default value).
402 \verbatim --log=xbt.add:yes\endverbatim
404 \section log_use_misc 3.2 Misc and Caveats
406 - Do not use any of the macros that start with '_'.
407 - Log4J has a 'rolling file appender' which you can select with a run-time
408 option and specify the max file size. This would be a nice default for
409 non-kernel applications.
410 - Careful, category names are global variables.
412 \section log_internals 4. Internal considerations
414 This module is a mess of macro black magic, and when it goes wrong,
415 SimGrid studently loose its ability to explain its problems. When
416 messing around this module, I often find useful to define
417 XBT_LOG_MAYDAY (which turns it back to good old printf) for the time
418 of finding what's going wrong. But things are quite verbose when
419 everything is enabled...
421 \section log_in_perf 4.1 Performance
423 Except for the first invocation of a given category, a disabled logging request
424 requires an a single comparison of a static variable to a constant.
426 There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
427 causes all logging requests with a lower priority to be optimized to 0 cost
428 by the compiler. By setting it to gras_log_priority_infinite, all logging
429 requests are statically disabled at compile time and cost nothing. Released executables
430 <i>might</i> be compiled with (note that it will prevent users to debug their problems)
431 \verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
433 Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
434 requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
435 the requests of priority below INFO.
437 \todo Logging performance *may* be improved further by improving the message
438 propagation from appender to appender in the category tree.
440 \section log_in_app 4.2 Appenders
442 Each category has an optional appender. An appender is a pointer to a
443 structure which starts with a pointer to a do_append() function. do_append()
444 prints a message to a log.
446 When a category is passed a message by one of the logging macros, the
447 category performs the following actions:
449 - if the category has an appender, the message is passed to the
450 appender's do_append() function,
451 - if additivity is true for the category, the message is passed to
452 the category's parent. Additivity is true by default, and can be
453 controlled by xbt_log_additivity_set() or something like --log=root.add:1 (see \ref log_use_conf_add).
454 Also, when you add an appender to a category, its additivity is automatically turned to off.
455 Turn it back on afterward if it is not what you wanted.
457 By default, only the root category have an appender, and any other category has
458 its additivity set to true. This causes all messages to be logged by the root
461 The default appender function currently prints to stderr, and the only other
462 existing one writes to the specified file. More would be needed, like the one
463 able to send the logs to a remote dedicated server.
464 This is on our TODO list for quite a while now, but your help would be
465 welcome here, too. */
467 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
468 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
473 e_xbt_log_priority_t thresh;
475 xbt_log_appender_t appender;
476 } s_xbt_log_setting_t, *xbt_log_setting_t;
478 static xbt_dynar_t xbt_log_settings = NULL;
480 static void _free_setting(void *s)
482 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
490 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
491 xbt_log_setting_t setting);
493 const char *xbt_log_priority_names[8] = {
504 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
505 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
506 "root", "The common ancestor for all categories",
507 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
508 0 /* isThreshInherited */ ,
509 NULL /* appender */ , NULL /* layout */ ,
513 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
514 "Loggings from the logging mechanism itself");
516 /* create the default appender and install it in the root category,
517 which were already created (damnit. Too slow little beetle) */
518 void xbt_log_preinit(void)
520 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
521 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
522 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
523 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
524 log_cat_init_mutex = xbt_os_rmutex_init();
527 static void xbt_log_connect_categories(void)
529 /* Connect our log channels: that must be done manually under windows */
530 /* Also permit that they are correctly listed by xbt_log_help_categories() */
533 XBT_LOG_CONNECT(amok);
534 XBT_LOG_CONNECT(amok_bw);
535 XBT_LOG_CONNECT(amok_bw_sat);
536 XBT_LOG_CONNECT(amok_pm);
539 XBT_LOG_CONNECT(gras);
540 XBT_LOG_CONNECT(gras_modules);
541 XBT_LOG_CONNECT(gras_msg);
542 XBT_LOG_CONNECT(gras_msg_read);
543 XBT_LOG_CONNECT(gras_msg_rpc);
544 XBT_LOG_CONNECT(gras_timer);
545 XBT_LOG_CONNECT(gras_trp);
546 XBT_LOG_CONNECT(gras_trp_file);
547 XBT_LOG_CONNECT(gras_virtu);
548 XBT_LOG_CONNECT(gras_virtu_emul);
549 XBT_LOG_CONNECT(gras_virtu_process);
552 XBT_LOG_CONNECT(xbt);
553 XBT_LOG_CONNECT(graphxml_parse);
554 XBT_LOG_CONNECT(log);
556 XBT_LOG_CONNECT(mm_diff);
558 XBT_LOG_CONNECT(module);
559 XBT_LOG_CONNECT(peer);
560 XBT_LOG_CONNECT(replay);
561 XBT_LOG_CONNECT(strbuff);
562 XBT_LOG_CONNECT(xbt_cfg);
563 XBT_LOG_CONNECT(xbt_dict);
564 XBT_LOG_CONNECT(xbt_dict_cursor);
565 XBT_LOG_CONNECT(xbt_dict_elm);
566 #ifdef XBT_USE_DEPRECATED
567 XBT_LOG_CONNECT(xbt_dict_multi);
569 XBT_LOG_CONNECT(xbt_ddt);
570 XBT_LOG_CONNECT(xbt_ddt_cbps);
571 XBT_LOG_CONNECT(xbt_ddt_convert);
572 XBT_LOG_CONNECT(xbt_ddt_create);
573 XBT_LOG_CONNECT(xbt_ddt_exchange);
574 XBT_LOG_CONNECT(xbt_ddt_parse);
575 XBT_LOG_CONNECT(xbt_ddt_lexer);
576 XBT_LOG_CONNECT(xbt_dyn);
577 XBT_LOG_CONNECT(xbt_ex);
578 XBT_LOG_CONNECT(xbt_fifo);
579 XBT_LOG_CONNECT(xbt_graph);
580 XBT_LOG_CONNECT(xbt_lib);
581 XBT_LOG_CONNECT(xbt_mallocator);
582 XBT_LOG_CONNECT(xbt_matrix);
583 XBT_LOG_CONNECT(xbt_parmap);
584 XBT_LOG_CONNECT(xbt_parmap_unit);
585 XBT_LOG_CONNECT(xbt_queue);
586 XBT_LOG_CONNECT(xbt_set);
587 XBT_LOG_CONNECT(xbt_sync);
588 XBT_LOG_CONNECT(xbt_sync_os);
589 XBT_LOG_CONNECT(xbt_trp);
590 XBT_LOG_CONNECT(xbt_trp_meas);
591 XBT_LOG_CONNECT(xbt_trp_tcp);
593 #ifdef simgrid_EXPORTS
594 /* The following categories are only defined in libsimgrid */
597 XBT_LOG_CONNECT(gras_trp_sg);
601 XBT_LOG_CONNECT(bindings);
602 XBT_LOG_CONNECT(lua);
603 XBT_LOG_CONNECT(lua_comm);
604 XBT_LOG_CONNECT(lua_host);
605 XBT_LOG_CONNECT(lua_platf);
606 XBT_LOG_CONNECT(lua_process);
607 XBT_LOG_CONNECT(lua_state_cloner);
608 XBT_LOG_CONNECT(lua_task);
609 XBT_LOG_CONNECT(lua_utils);
614 XBT_LOG_CONNECT(instr);
615 XBT_LOG_CONNECT(instr_paje_trace);
616 XBT_LOG_CONNECT(instr_smpi);
617 XBT_LOG_CONNECT(instr_surf);
622 XBT_LOG_CONNECT(jedule);
623 XBT_LOG_CONNECT(jed_out);
624 XBT_LOG_CONNECT(jed_sd);
630 XBT_LOG_CONNECT(mc_checkpoint);
631 XBT_LOG_CONNECT(mc_dpor);
632 XBT_LOG_CONNECT(mc_global);
633 XBT_LOG_CONNECT(mc_liveness);
634 XBT_LOG_CONNECT(mc_memory);
635 XBT_LOG_CONNECT(mc_memory_map);
636 XBT_LOG_CONNECT(mc_request);
640 XBT_LOG_CONNECT(msg);
641 XBT_LOG_CONNECT(msg_action);
642 XBT_LOG_CONNECT(msg_gos);
643 XBT_LOG_CONNECT(msg_io);
644 XBT_LOG_CONNECT(msg_kernel);
645 XBT_LOG_CONNECT(msg_mailbox);
646 XBT_LOG_CONNECT(msg_process);
647 XBT_LOG_CONNECT(msg_task);
648 XBT_LOG_CONNECT(msg_vm);
652 XBT_LOG_CONNECT(sd_daxparse);
654 XBT_LOG_CONNECT(sd_dotparse);
656 XBT_LOG_CONNECT(sd_kernel);
657 XBT_LOG_CONNECT(sd_task);
658 XBT_LOG_CONNECT(sd_workstation);
661 XBT_LOG_CONNECT(simix);
662 XBT_LOG_CONNECT(simix_context);
663 XBT_LOG_CONNECT(simix_deployment);
664 XBT_LOG_CONNECT(simix_environment);
665 XBT_LOG_CONNECT(simix_host);
666 XBT_LOG_CONNECT(simix_io);
667 XBT_LOG_CONNECT(simix_kernel);
668 XBT_LOG_CONNECT(simix_network);
669 XBT_LOG_CONNECT(simix_process);
670 XBT_LOG_CONNECT(simix_smurf);
671 XBT_LOG_CONNECT(simix_synchro);
674 /* SMPI categories are connected in smpi_global.c */
677 XBT_LOG_CONNECT(surf);
678 XBT_LOG_CONNECT(random);
679 XBT_LOG_CONNECT(surf_config);
680 XBT_LOG_CONNECT(surf_cpu);
681 XBT_LOG_CONNECT(surf_cpu_ti);
682 XBT_LOG_CONNECT(surf_kernel);
683 XBT_LOG_CONNECT(surf_lagrange);
684 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
685 XBT_LOG_CONNECT(surf_maxmin);
686 XBT_LOG_CONNECT(surf_network);
688 XBT_LOG_CONNECT(surf_network_gtnets);
691 XBT_LOG_CONNECT(surf_network_ns3);
693 XBT_LOG_CONNECT(surf_parse);
694 XBT_LOG_CONNECT(surf_route);
695 XBT_LOG_CONNECT(surf_routing_generic);
696 XBT_LOG_CONNECT(surf_route_cluster);
697 XBT_LOG_CONNECT(surf_route_dijkstra);
698 XBT_LOG_CONNECT(surf_route_floyd);
699 XBT_LOG_CONNECT(surf_route_full);
700 XBT_LOG_CONNECT(surf_route_none);
701 XBT_LOG_CONNECT(surf_route_rulebased);
702 XBT_LOG_CONNECT(surf_route_vivaldi);
703 XBT_LOG_CONNECT(surf_storage);
704 XBT_LOG_CONNECT(surf_trace);
705 XBT_LOG_CONNECT(surf_workstation);
707 #endif /* simgrid_EXPORTS */
710 static void xbt_log_help(void);
711 static void xbt_log_help_categories(void);
713 /** @brief Get all logging settings from the command line
715 * xbt_log_control_set() is called on each string we got from cmd line
717 void xbt_log_init(int *argc, char **argv)
719 unsigned help_requested = 0; /* 1: logs; 2: categories */
723 // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
725 xbt_log_connect_categories();
727 /* Set logs and init log submodule */
728 for (j = i = 1; i < *argc; i++) {
729 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
730 opt = strchr(argv[i], '=');
732 xbt_log_control_set(opt);
733 XBT_DEBUG("Did apply '%s' as log setting", opt);
734 } else if (!strcmp(argv[i], "--help-logs")) {
736 } else if (!strcmp(argv[i], "--help-log-categories")) {
747 if (help_requested) {
748 if (help_requested & 1)
750 if (help_requested & 2)
751 xbt_log_help_categories();
756 static void log_cat_exit(xbt_log_category_t cat)
758 xbt_log_category_t child;
761 if (cat->appender->free_)
762 cat->appender->free_(cat->appender);
766 if (cat->layout->free_)
767 cat->layout->free_(cat->layout);
771 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
775 void xbt_log_postexit(void)
777 XBT_VERB("Exiting log");
778 xbt_os_rmutex_destroy(log_cat_init_mutex);
779 xbt_dynar_free(&xbt_log_settings);
780 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
783 /* Size of the static string in which we build the log string */
784 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
785 /* Minimum size of the dynamic string in which we build the log string
786 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
787 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
789 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
791 xbt_log_category_t cat = ev->cat;
793 xbt_assert(ev->priority >= 0,
794 "Negative logging priority naturally forbidden");
795 xbt_assert(ev->priority < sizeof(xbt_log_priority_names),
796 "Priority %d is greater than the biggest allowed value",
800 xbt_log_appender_t appender = cat->appender;
803 continue; /* No appender, try next */
805 xbt_assert(cat->layout,
806 "No valid layout for the appender of category %s", cat->name);
808 /* First, try with a static buffer */
809 if (XBT_LOG_STATIC_BUFFER_SIZE) {
810 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
813 ev->buffer_size = sizeof buff;
814 va_start(ev->ap, fmt);
815 done = cat->layout->do_layout(cat->layout, ev, fmt);
818 appender->do_append(appender, buff);
819 continue; /* Ok, that worked: go next */
823 /* The static buffer was too small, use a dynamically expanded one */
824 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
825 ev->buffer = xbt_malloc(ev->buffer_size);
828 va_start(ev->ap, fmt);
829 done = cat->layout->do_layout(cat->layout, ev, fmt);
833 ev->buffer_size *= 2;
834 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
836 appender->do_append(appender, ev->buffer);
837 xbt_free(ev->buffer);
839 } while (cat->additivity && (cat = cat->parent, 1));
842 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
843 #undef XBT_LOG_STATIC_BUFFER_SIZE
847 * The standard logging macros use _XBT_LOG_ISENABLED, which calls
848 * _xbt_log_cat_init(). Thus, if we want to avoid an infinite
849 * recursion, we can not use the standard logging macros in
850 * _xbt_log_cat_init(), and in all functions called from it.
852 * To circumvent the problem, we define the macro_xbt_log_init() as
853 * (0) for the length of the affected functions, and we do not forget
854 * to undefine it at the end!
857 static void _xbt_log_cat_apply_set(xbt_log_category_t category,
858 xbt_log_setting_t setting)
860 #define _xbt_log_cat_init(a, b) (0)
862 if (setting->thresh != xbt_log_priority_uninitialized) {
863 xbt_log_threshold_set(category, setting->thresh);
865 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
866 category->name, xbt_log_priority_names[category->threshold],
867 category->threshold);
871 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
873 XBT_DEBUG("Apply settings for category '%s': set format to %s",
874 category->name, setting->fmt);
877 if (setting->additivity != -1) {
878 xbt_log_additivity_set(category, setting->additivity);
880 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
881 category->name, (setting->additivity ? "on" : "off"));
883 if (setting->appender) {
884 xbt_log_appender_set(category, setting->appender);
885 if (!category->layout)
886 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
887 category->additivity = 0;
888 XBT_DEBUG("Set %p as appender of category '%s'",
889 setting->appender, category->name);
891 #undef _xbt_log_cat_init
895 * This gets called the first time a category is referenced and performs the
897 * Also resets threshold to inherited!
899 int _xbt_log_cat_init(xbt_log_category_t category,
900 e_xbt_log_priority_t priority)
902 #define _xbt_log_cat_init(a, b) (0)
904 if (log_cat_init_mutex != NULL) {
905 xbt_os_rmutex_acquire(log_cat_init_mutex);
908 if (category->initialized) {
909 if (log_cat_init_mutex != NULL) {
910 xbt_os_rmutex_release(log_cat_init_mutex);
912 return priority >= category->threshold;
916 xbt_log_setting_t setting = NULL;
919 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)",
921 (category->firstChild ? category->firstChild->name : "none"),
922 (category->nextSibling ? category->nextSibling->name : "none"));
924 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
925 category->threshold = xbt_log_priority_info;
926 category->appender = xbt_log_default_appender;
927 category->layout = xbt_log_default_layout;
930 if (!category->parent)
931 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
933 XBT_DEBUG("Set %s (%s) as father of %s ",
934 category->parent->name,
935 (category->parent->initialized ?
936 xbt_log_priority_names[category->parent->threshold] : "uninited"),
938 xbt_log_parent_set(category, category->parent);
940 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
941 char *buf, *res = NULL;
942 xbt_log_category_t cpp = category->parent->firstChild;
945 buf = bprintf("%s %s", res, cpp->name);
949 res = xbt_strdup(cpp->name);
951 cpp = cpp->nextSibling;
954 XBT_DEBUG("Children of %s: %s; nextSibling: %s",
955 category->parent->name, res,
956 (category->parent->nextSibling ?
957 category->parent->nextSibling->name : "none"));
964 /* Apply the control */
965 if (xbt_log_settings) {
966 xbt_assert(category, "NULL category");
967 xbt_assert(category->name);
969 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
970 xbt_assert(setting, "Damnit, NULL cat in the list");
971 xbt_assert(setting->catname, "NULL setting(=%p)->catname",
974 if (!strcmp(setting->catname, category->name)) {
976 _xbt_log_cat_apply_set(category, setting);
977 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
982 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
983 category->name, xbt_log_priority_names[category->threshold],
984 category->threshold);
987 category->initialized = 1;
988 if (log_cat_init_mutex != NULL) {
989 xbt_os_rmutex_release(log_cat_init_mutex);
991 return priority >= category->threshold;
993 #undef _xbt_log_cat_init
996 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
998 xbt_assert(cat, "NULL category to be given a parent");
999 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
1001 /* if the category is initialized, unlink from current parent */
1002 if (cat->initialized) {
1004 xbt_log_category_t *cpp = &cat->parent->firstChild;
1006 while (*cpp != cat && *cpp != NULL) {
1007 cpp = &(*cpp)->nextSibling;
1010 xbt_assert(*cpp == cat);
1011 *cpp = cat->nextSibling;
1014 cat->parent = parent;
1015 cat->nextSibling = parent->firstChild;
1017 parent->firstChild = cat;
1019 if (!parent->initialized)
1020 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
1022 cat->threshold = parent->threshold;
1024 cat->isThreshInherited = 1;
1027 static void _set_inherited_thresholds(xbt_log_category_t cat)
1030 xbt_log_category_t child = cat->firstChild;
1032 for (; child != NULL; child = child->nextSibling) {
1033 if (child->isThreshInherited) {
1034 if (cat != &_XBT_LOGV(log))
1035 XBT_VERB("Set category threshold of %s to %s (=%d)",
1036 child->name, xbt_log_priority_names[cat->threshold],
1038 child->threshold = cat->threshold;
1039 _set_inherited_thresholds(child);
1046 void xbt_log_threshold_set(xbt_log_category_t cat,
1047 e_xbt_log_priority_t threshold)
1049 cat->threshold = threshold;
1050 cat->isThreshInherited = 0;
1052 _set_inherited_thresholds(cat);
1056 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
1059 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
1060 const char *name, *dot, *eq;
1062 set->catname = NULL;
1063 set->thresh = xbt_log_priority_uninitialized;
1065 set->additivity = -1;
1066 set->appender = NULL;
1068 if (!*control_string)
1070 XBT_DEBUG("Parse log setting '%s'", control_string);
1072 control_string += strspn(control_string, " ");
1073 name = control_string;
1074 control_string += strcspn(control_string, ".= ");
1075 dot = control_string;
1076 control_string += strcspn(control_string, ":= ");
1077 eq = control_string;
1078 control_string += strcspn(control_string, " ");
1080 xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'),
1081 "Invalid control string '%s'", control_string);
1083 if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) {
1085 char *neweq = xbt_strdup(eq + 1);
1086 char *p = neweq - 1;
1088 while (*(++p) != '\0') {
1089 if (*p >= 'a' && *p <= 'z') {
1094 XBT_DEBUG("New priority name = %s", neweq);
1095 for (i = 0; i < xbt_log_priority_infinite; i++) {
1096 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
1097 XBT_DEBUG("This is priority %d", i);
1101 if (i < xbt_log_priority_infinite) {
1102 set->thresh = (e_xbt_log_priority_t) i;
1104 THROWF(arg_error, 0,
1105 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)",
1109 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
1110 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
1112 char *neweq = xbt_strdup(eq + 1);
1113 char *p = neweq - 1;
1115 while (*(++p) != '\0') {
1116 if (*p >= 'a' && *p <= 'z') {
1120 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES")
1121 || !strcmp(neweq, "1")) {
1122 set->additivity = 1;
1124 set->additivity = 0;
1127 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
1128 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
1130 char *neweq = xbt_strdup(eq + 1);
1132 if (!strncmp(neweq, "file:", 5)) {
1133 set->appender = xbt_log_appender_file_new(neweq + 5);
1135 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
1138 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
1139 set->fmt = xbt_strdup(eq + 1);
1142 snprintf(buff, min(512, eq - dot), "%s", dot + 1);
1143 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'",
1146 set->catname = (char *) xbt_malloc(dot - name + 1);
1148 memcpy(set->catname, name, dot - name);
1149 set->catname[dot - name] = '\0'; /* Just in case */
1150 XBT_DEBUG("This is for cat '%s'", set->catname);
1155 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat,
1158 xbt_log_category_t child, res;
1160 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
1161 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
1162 (cat->nextSibling ? cat->nextSibling->name : "none"));
1163 if (!strcmp(cat->name, name))
1166 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
1167 XBT_DEBUG("Dig into %s", child->name);
1168 res = _xbt_log_cat_searchsub(child, name);
1178 * \param control_string What to parse
1180 * Typically passed a command-line argument. The string has the syntax:
1182 * ( [category] "." [keyword] ":" value (" ")... )...
1184 * where [category] is one the category names (see \ref XBT_log_cats for
1185 * a complete list of the ones defined in the SimGrid library)
1186 * and keyword is one of the following:
1188 * - thres: category's threshold priority. Possible values:
1189 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
1190 * - add or additivity: whether the logging actions must be passed to
1191 * the parent category.
1192 * Possible values: 0, 1, no, yes, on, off.
1193 * Default value: yes.
1194 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
1195 * - app or appender: the appender to use. See \ref log_use_conf_app for more
1199 void xbt_log_control_set(const char *control_string)
1201 xbt_log_setting_t set;
1203 /* To split the string in commands, and the cursors */
1204 xbt_dynar_t set_strings;
1208 if (!control_string)
1210 XBT_DEBUG("Parse log settings '%s'", control_string);
1212 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
1213 if (!strcmp(control_string, "no_loc")) {
1217 /* some initialization if this is the first time that this get called */
1218 if (xbt_log_settings == NULL)
1219 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t),
1222 /* split the string, and remove empty entries */
1223 set_strings = xbt_str_split_quoted(control_string);
1225 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
1226 xbt_dynar_free(&set_strings);
1230 /* Parse each entry and either use it right now (if the category was already
1231 created), or store it for further use */
1232 xbt_dynar_foreach(set_strings, cpt, str) {
1233 xbt_log_category_t cat = NULL;
1235 set = _xbt_log_parse_setting(str);
1237 _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
1240 XBT_DEBUG("Apply directly");
1241 _xbt_log_cat_apply_set(cat, set);
1242 _free_setting((void *) &set);
1245 XBT_DEBUG("Store for further application");
1246 XBT_DEBUG("push %p to the settings", (void *) set);
1247 xbt_dynar_push(xbt_log_settings, &set);
1250 xbt_dynar_free(&set_strings);
1253 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
1255 if (cat->appender) {
1256 if (cat->appender->free_)
1257 cat->appender->free_(cat->appender);
1258 free(cat->appender);
1260 cat->appender = app;
1263 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
1265 #define _xbt_log_cat_init(a, b) (0)
1266 if (!cat->appender) {
1268 ("No appender to category %s. Setting the file appender as default",
1270 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
1273 if (cat->layout->free_) {
1274 cat->layout->free_(cat->layout);
1279 xbt_log_additivity_set(cat, 0);
1280 #undef _xbt_log_cat_init
1283 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
1285 cat->additivity = additivity;
1288 static void xbt_log_help(void)
1291 "Description of the logging output:\n"
1293 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
1294 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
1295 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
1296 " -> trace: enter and return of some functions\n"
1297 " -> debug: crufty output\n"
1298 " -> verbose: verbose output for the user wanting more\n"
1299 " -> info: output about the regular functionning\n"
1300 " -> warning: minor issue encountered\n"
1301 " -> error: issue encountered\n"
1302 " -> critical: major issue encountered\n"
1304 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
1305 " OPTIONS may be:\n"
1306 " -> %%%%: the %% char\n"
1307 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
1308 " -> %%e: plain old space (SimGrid extension)\n"
1310 " -> %%m: user-provided message\n"
1312 " -> %%c: Category name (LOG4J compatible)\n"
1313 " -> %%p: Priority name (LOG4J compatible)\n"
1315 " -> %%h: Hostname (SimGrid extension)\n"
1316 " -> %%P: Process name (SimGrid extension)\n"
1317 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
1318 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
1320 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
1321 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
1322 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
1323 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
1324 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
1326 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
1327 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
1328 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
1330 " -> %%d: date (UNIX-like epoch)\n"
1331 " -> %%r: application age (time elapsed since the beginning of the application)\n"
1336 static int xbt_log_cat_cmp(const void *pa, const void *pb)
1338 xbt_log_category_t a = *(xbt_log_category_t *)pa;
1339 xbt_log_category_t b = *(xbt_log_category_t *)pb;
1340 return strcmp(a->name, b->name);
1343 static void xbt_log_help_categories_rec(xbt_log_category_t category,
1350 xbt_log_category_t cat;
1355 if (category->parent) {
1356 this_prefix = bprintf("%s \\_ ", prefix);
1357 child_prefix = bprintf("%s | ", prefix);
1359 this_prefix = bprintf("%s", prefix);
1360 child_prefix = bprintf("%s", prefix);
1363 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
1364 for (cat = category ; cat != NULL; cat = cat->nextSibling)
1365 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
1367 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
1369 for (i = 0; i < xbt_dynar_length(dynar); i++) {
1370 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
1371 *strrchr(child_prefix, '|') = ' ';
1372 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
1373 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
1374 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
1377 xbt_dynar_free(&dynar);
1378 xbt_free(this_prefix);
1379 xbt_free(child_prefix);
1382 static void xbt_log_help_categories(void)
1384 printf("Current log category hierarchy:\n");
1385 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");