1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 /** @addtogroup XBT_log
9 * @brief A generic logging facility in the spirit of log4j (grounding feature)
13 /** \defgroup XBT_log_cats Existing log categories
15 * \brief (automatically extracted)
17 * This is the list of all existing log categories in SimGrid.
18 * This list is automatically extracted from the source code by the tools/doxygen/xbt_log_extract_hierarchy.pl utility.
20 * It should thus contain every categories that are defined in the SimGrid library.
21 * If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your simulator.
24 /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
25 printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */
26 //#define XBT_LOG_MAYDAY
32 #include <stddef.h> /* NULL */
35 /**\brief Log priorities
38 * The different existing priorities.
42 xbt_log_priority_none = 0, /** used internally (don't poke with)*/
44 xbt_log_priority_trace = 1, /**< enter and return of some functions */
45 xbt_log_priority_debug = 2, /**< crufty output */
46 xbt_log_priority_verbose = 3, /**< verbose output for the user wanting more */
47 xbt_log_priority_info = 4, /**< output about the regular functionning */
48 xbt_log_priority_warning = 5, /**< minor issue encountered */
49 xbt_log_priority_error = 6, /**< issue encountered */
50 xbt_log_priority_critical = 7, /**< major issue encountered */
52 xbt_log_priority_infinite = 8, /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
55 xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */
57 } e_xbt_log_priority_t;
60 * define NLOG to disable at compilation time any logging request
61 * define NDEBUG to disable at compilation time any logging request of priority below VERBOSE
65 * @def XBT_LOG_STATIC_THRESHOLD
68 * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out.
71 # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_infinite
75 # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_verbose
76 # else /* !NLOG && !NDEBUG */
78 # ifndef XBT_LOG_STATIC_THRESHOLD
79 # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_none
80 # endif /* !XBT_LOG_STATIC_THRESHOLD */
82 #endif /* !defined(NLOG) */
84 /* Transforms a category name to a global variable name. */
85 #define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_simgrid_log_category__, cat)
86 #define _XBT_LOGV_CTOR(cat) _XBT_LOG_CONCAT2(_XBT_LOGV(cat), __constructor__)
87 #define _XBT_LOG_CONCAT(x, y) x ## y
88 #define _XBT_LOG_CONCAT2(x, y) _XBT_LOG_CONCAT(x, y)
90 /* The root of the category hierarchy. */
91 #define XBT_LOG_ROOT_CAT root
93 /* The whole tree of categories is connected by setting the address of the parent category as a field of the child one.
94 * This is normally done at the first use of the category.
96 * It is however necessary to make this connections as early as possible, if we want the category to be listed by
97 * --help-log-categories. We use constructor attributes for these initializations to take place automatically before the
101 /* XBT_LOG_NEW_SUBCATEGORY_helper:
102 * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition to avoid an extra
103 * declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by XBT_LOG_NEW_CATEGORY */
104 #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
106 extern void _XBT_LOGV_CTOR(catName)(void) XBT_ATTRIB_CONSTRUCTOR(600); \
107 void _XBT_LOGV_CTOR(catName)(void) \
109 XBT_LOG_EXTERNAL_CATEGORY(catName); \
110 if (!_XBT_LOGV(catName).initialized) { \
111 _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \
115 XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = { \
116 &_XBT_LOGV(parent), \
117 NULL /* firstChild */, \
118 NULL /* nextSibling */, \
121 0 /*initialized */, \
122 xbt_log_priority_uninitialized /* threshold */, \
123 1 /* isThreshInherited */, \
124 NULL /* appender */, \
131 * \param catName name of new category
132 * \param parent father of the new category in the tree
133 * \param desc string describing the purpose of this category
136 * Defines a new subcategory of the parent.
138 #define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \
139 XBT_LOG_EXTERNAL_CATEGORY(parent); \
140 XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
144 * \param catName name of new category
145 * \param desc string describing the purpose of this category
148 * Creates a new subcategory of the root category.
150 # define XBT_LOG_NEW_CATEGORY(catName,desc) \
151 XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
155 * \param cname name of the cat
158 * Indicates which category is the default one.
161 #if defined(XBT_LOG_MAYDAY) /*|| defined (NLOG) * turning logging off */
162 # define XBT_LOG_DEFAULT_CATEGORY(cname)
164 #define XBT_LOG_DEFAULT_CATEGORY(cname) \
165 XBT_ATTRIB_UNUSED static xbt_log_category_t _XBT_LOGV(default) = &_XBT_LOGV(cname)
170 * \param cname name of the cat
171 * \param desc string describing the purpose of this category
174 * Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly
175 * specify a category).
177 # define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc) \
178 XBT_LOG_NEW_CATEGORY(cname,desc); \
179 XBT_LOG_DEFAULT_CATEGORY(cname)
183 * \param cname name of the cat
184 * \param parent name of the parent
185 * \param desc string describing the purpose of this category
188 * Creates a new subcategory of the parent category and makes it the default
189 * (used by macros that don't explicitly specify a category).
191 #define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) \
192 XBT_LOG_NEW_SUBCATEGORY(cname, parent, desc); \
193 XBT_LOG_DEFAULT_CATEGORY(cname)
197 * \param cname name of the cat
200 * Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file.
203 #define XBT_LOG_EXTERNAL_CATEGORY(cname) \
204 extern s_xbt_log_category_t _XBT_LOGV(cname)
208 * \param cname name of the cat
211 * Indicates that the default category of this file was declared in another file.
214 #define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname) \
215 XBT_LOG_EXTERNAL_CATEGORY(cname);\
216 XBT_LOG_DEFAULT_CATEGORY(cname)
218 /* Functions you may call */
220 XBT_PUBLIC void xbt_log_control_set(const char* cs);
222 /* Forward declarations */
223 typedef struct xbt_log_appender_s s_xbt_log_appender_t;
224 typedef s_xbt_log_appender_t* xbt_log_appender_t;
225 typedef struct xbt_log_layout_s s_xbt_log_layout_t;
226 typedef s_xbt_log_layout_t* xbt_log_layout_t;
227 typedef struct xbt_log_event_s s_xbt_log_event_t;
228 typedef s_xbt_log_event_t* xbt_log_event_t;
229 typedef struct xbt_log_category_s s_xbt_log_category_t;
230 typedef s_xbt_log_category_t* xbt_log_category_t;
232 /* Do NOT access any members of this structure directly. FIXME: move to private? */
234 struct xbt_log_category_s {
235 xbt_log_category_t parent;
236 xbt_log_category_t firstChild;
237 xbt_log_category_t nextSibling;
239 const char *description;
242 int isThreshInherited;
243 xbt_log_appender_t appender;
244 xbt_log_layout_t layout;
248 struct xbt_log_event_s {
249 xbt_log_category_t cat;
250 e_xbt_log_priority_t priority;
251 const char *fileName;
252 const char *functionName;
260 * \ingroup XBT_log_implem
261 * \param cat the category (not only its name, but the variable)
262 * \param thresholdPriority the priority
264 * Programatically alters a category's threshold priority (don't use).
266 XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority);
269 * \ingroup XBT_log_implem
270 * \param cat the category (not only its name, but the variable)
271 * \param app the appender
273 * Programatically sets the category's appender. (the preferred interface is through xbt_log_control_set())
275 XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app);
277 * \ingroup XBT_log_implem
278 * \param cat the category (not only its name, but the variable)
279 * \param lay the layout
281 * Programatically sets the category's layout. (the preferred interface is through xbt_log_control_set())
283 XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay);
286 * \ingroup XBT_log_implem
287 * \param cat the category (not only its name, but the variable)
288 * \param additivity whether logging actions must be passed to parent.
290 * Programatically sets whether the logging actions must be passed to the parent category.
291 * (the preferred interface is through xbt_log_control_set())
293 XBT_PUBLIC void xbt_log_additivity_set(xbt_log_category_t cat, int additivity);
295 /** @brief create a new simple layout
297 * This layout is not as flexible as the pattern one
299 XBT_PUBLIC xbt_log_layout_t xbt_log_layout_simple_new(char* arg);
300 XBT_PUBLIC xbt_log_layout_t xbt_log_layout_format_new(char* arg);
301 XBT_PUBLIC xbt_log_appender_t xbt_log_appender_file_new(char* arg);
302 XBT_PUBLIC xbt_log_appender_t xbt_log_appender2_file_new(char* arg, int roll);
304 /* ********************************** */
305 /* Functions that you shouldn't call */
306 /* ********************************** */
307 XBT_PUBLIC void xbt_log_init(int* argc, char** argv);
308 XBT_PUBLIC void _xbt_log_event_log(xbt_log_event_t ev, const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
309 XBT_PUBLIC int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority);
312 XBT_PUBLIC_DATA s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
314 // If we `dllexport` the root log category, MinGW does not want us to take its address with the error:
315 // > initializer element is not constant
316 // When using auto-import, MinGW is happy.
317 // We should handle this for non-root log categories as well.
318 extern s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
321 extern xbt_log_appender_t xbt_log_default_appender;
322 extern xbt_log_layout_t xbt_log_default_layout;
324 /* ********************** */
325 /* Public functions again */
326 /* ********************** */
330 * \param catName name of the category
331 * \param priority minimal priority to be enabled to return true (must be #e_xbt_log_priority_t)
334 * Returns true if the given priority is enabled for the category.
335 * If you have expensive expressions that are computed outside of the log command and used only within it, you should
336 * make its evaluation conditional using this macro.
338 #define XBT_LOG_ISENABLED(catName, priority) \
339 _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
342 * Helper function that implements XBT_LOG_ISENABLED.
345 * First part is a compile-time constant.
346 * Call to xbt_log_cat_init only happens once.
348 #define _XBT_LOG_ISENABLEDV(catv, priority) \
349 (priority >= XBT_LOG_STATIC_THRESHOLD \
350 && ((catv).initialized || _xbt_log_cat_init(&(catv), priority)) \
351 && priority >= (catv).threshold)
355 * Some kludge macros to ease maintenance. See how they're used below.
357 * IMPLEMENTATION NOTE: To reduce the parameter passing overhead of an enabled message, the many parameters passed to
358 * the logging function are packed in a structure. Since these values will be usually be passed to at least 3 functions,
360 * It also allows adding new values (such as a timestamp) without breaking code.
361 * Setting the LogEvent's valist member is done inside _log_logEvent.
366 #ifdef XBT_LOG_MAYDAY
367 # define XBT_CLOG(cat, prio, ...) \
368 _XBT_IF_ONE_ARG(_XBT_CLOG_ARG1, _XBT_CLOG_ARGN, __VA_ARGS__)(__VA_ARGS__)
369 # define _XBT_CLOG_ARG1(f) \
370 fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__)
371 # define _XBT_CLOG_ARGN(f, ...) \
372 fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__, __VA_ARGS__)
373 # define XBT_LOG(...) XBT_CLOG(0, __VA_ARGS__)
376 // This code is duplicated to remove one level of indirection, working around a MSVC bug
377 // See: http://stackoverflow.com/questions/9183993/msvc-variadic-macro-expansion
379 # define XBT_CLOG(category, prio, ...) \
381 if (_XBT_LOG_ISENABLEDV((category), prio)) { \
382 s_xbt_log_event_t _log_ev; \
383 _log_ev.cat = &(category); \
384 _log_ev.priority = (prio); \
385 _log_ev.fileName = __FILE__; \
386 _log_ev.functionName = __func__; \
387 _log_ev.lineNum = __LINE__; \
388 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
392 # define XBT_LOG(prio,...) \
394 if (_XBT_LOG_ISENABLEDV((*_simgrid_log_category__default), prio)) { \
395 s_xbt_log_event_t _log_ev; \
396 _log_ev.cat = _simgrid_log_category__default; \
397 _log_ev.priority = (prio); \
398 _log_ev.fileName = __FILE__; \
399 _log_ev.functionName = __func__; \
400 _log_ev.lineNum = __LINE__; \
401 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
408 * \param categ the category on which to log
409 * \param ... the format string and its arguments
410 * @brief Log an event at the DEBUG priority on the specified category with these args.
412 #define XBT_CDEBUG(categ, ...) \
414 if (XBT_LOG_ISENABLED (categ, xbt_log_priority_debug)) { \
415 s_xbt_log_event_t _log_ev; \
416 _log_ev.cat = &(_XBT_LOGV(categ)); \
417 _log_ev.priority = xbt_log_priority_debug; \
418 _log_ev.fileName = __FILE__; \
419 _log_ev.functionName = __func__; \
420 _log_ev.lineNum = __LINE__; \
421 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
427 * @brief Log an event at the VERB priority on the specified category with these args.
429 #define XBT_CVERB(categ, ...) \
431 if (XBT_LOG_ISENABLED (categ, xbt_log_priority_verbose)) { \
432 s_xbt_log_event_t _log_ev; \
433 _log_ev.cat = &(_XBT_LOGV(categ)); \
434 _log_ev.priority = xbt_log_priority_verbose; \
435 _log_ev.fileName = __FILE__; \
436 _log_ev.functionName = __func__; \
437 _log_ev.lineNum = __LINE__; \
438 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
444 * @brief Log an event at the INFO priority on the specified category with these args.
446 #define XBT_CINFO(categ, ...) \
448 if (XBT_LOG_ISENABLED (categ, xbt_log_priority_info)) { \
449 s_xbt_log_event_t _log_ev; \
450 _log_ev.cat = &(_XBT_LOGV(categ)); \
451 _log_ev.priority = xbt_log_priority_info; \
452 _log_ev.fileName = __FILE__; \
453 _log_ev.functionName = __func__; \
454 _log_ev.lineNum = __LINE__; \
455 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
462 * @brief Log an event at the WARN priority on the specified category with these args.
464 #define XBT_CWARN(categ, ...) \
466 if (XBT_LOG_ISENABLED (categ, xbt_log_priority_warning)) { \
467 s_xbt_log_event_t _log_ev; \
468 _log_ev.cat = &(_XBT_LOGV(categ)); \
469 _log_ev.priority = xbt_log_priority_warning; \
470 _log_ev.fileName = __FILE__; \
471 _log_ev.functionName = __func__; \
472 _log_ev.lineNum = __LINE__; \
473 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
480 * @brief Log an event at the ERROR priority on the specified category with these args.
482 #define XBT_CERROR(categ, ...) \
484 if (XBT_LOG_ISENABLED (categ, xbt_log_priority_error)) { \
485 s_xbt_log_event_t _log_ev; \
486 _log_ev.cat = &(_XBT_LOGV(categ)); \
487 _log_ev.priority = xbt_log_priority_error; \
488 _log_ev.fileName = __FILE__; \
489 _log_ev.functionName = __func__; \
490 _log_ev.lineNum = __LINE__; \
491 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
497 * @brief Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10).
499 #define XBT_CCRITICAL(categ, ...) \
501 if (XBT_LOG_ISENABLED (categ, xbt_log_priority_critical)) { \
502 s_xbt_log_event_t _log_ev; \
503 _log_ev.cat = &(_XBT_LOGV(categ)); \
504 _log_ev.priority = xbt_log_priority_critical; \
505 _log_ev.fileName = __FILE__; \
506 _log_ev.functionName = __func__; \
507 _log_ev.lineNum = __LINE__; \
508 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
514 * \param ... the format string and its arguments
515 * @brief Log an event at the DEBUG priority on the default category with these args.
517 #define XBT_DEBUG(...) \
519 if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
520 xbt_log_priority_debug)) { \
521 s_xbt_log_event_t _log_ev; \
522 _log_ev.cat = _simgrid_log_category__default; \
523 _log_ev.priority = xbt_log_priority_debug; \
524 _log_ev.fileName = __FILE__; \
525 _log_ev.functionName = __func__; \
526 _log_ev.lineNum = __LINE__; \
527 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
533 * @brief Log an event at the VERB priority on the default category with these args.
535 #define XBT_VERB(...) \
537 if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
538 xbt_log_priority_verbose)) { \
539 s_xbt_log_event_t _log_ev; \
540 _log_ev.cat = _simgrid_log_category__default; \
541 _log_ev.priority = xbt_log_priority_verbose; \
542 _log_ev.fileName = __FILE__; \
543 _log_ev.functionName = __func__; \
544 _log_ev.lineNum = __LINE__; \
545 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
551 * @brief Log an event at the INFO priority on the default category with these args.
553 #define XBT_INFO(...) \
555 if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
556 xbt_log_priority_info)) { \
557 s_xbt_log_event_t _log_ev; \
558 _log_ev.cat = _simgrid_log_category__default; \
559 _log_ev.priority = xbt_log_priority_info; \
560 _log_ev.fileName = __FILE__; \
561 _log_ev.functionName = __func__; \
562 _log_ev.lineNum = __LINE__; \
563 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
569 * @brief Log an event at the WARN priority on the default category with these args.
571 #define XBT_WARN(...) \
573 if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
574 xbt_log_priority_warning)) { \
575 s_xbt_log_event_t _log_ev; \
576 _log_ev.cat = _simgrid_log_category__default; \
577 _log_ev.priority = xbt_log_priority_warning; \
578 _log_ev.fileName = __FILE__; \
579 _log_ev.functionName = __func__; \
580 _log_ev.lineNum = __LINE__; \
581 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
587 * @brief Log an event at the ERROR priority on the default category with these args.
589 #define XBT_ERROR(...) \
591 if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
592 xbt_log_priority_error)) { \
593 s_xbt_log_event_t _log_ev; \
594 _log_ev.cat = _simgrid_log_category__default; \
595 _log_ev.priority = xbt_log_priority_error; \
596 _log_ev.fileName = __FILE__; \
597 _log_ev.functionName = __func__; \
598 _log_ev.lineNum = __LINE__; \
599 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
605 * @brief Log an event at the CRITICAL priority on the default category with these args.
607 #define XBT_CRITICAL(...) \
609 if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
610 xbt_log_priority_critical)) { \
611 s_xbt_log_event_t _log_ev; \
612 _log_ev.cat = _simgrid_log_category__default; \
613 _log_ev.priority = xbt_log_priority_critical; \
614 _log_ev.fileName = __FILE__; \
615 _log_ev.functionName = __func__; \
616 _log_ev.lineNum = __LINE__; \
617 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
621 #define _XBT_IN_OUT(...) \
622 _XBT_IF_ONE_ARG(_XBT_IN_OUT_ARG1, _XBT_IN_OUT_ARGN, __VA_ARGS__)(__VA_ARGS__)
623 #define _XBT_IN_OUT_ARG1(fmt) \
624 XBT_LOG(xbt_log_priority_trace, fmt, __func__)
625 #define _XBT_IN_OUT_ARGN(fmt, ...) \
626 XBT_LOG(xbt_log_priority_trace, fmt, __func__, __VA_ARGS__)
630 * @brief Log at TRACE priority that we entered in current function, appending a user specified format.
632 #define XBT_IN(...) _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)
636 * @brief Log at TRACE priority that we exited the current function, appending a user specified format.
638 #define XBT_OUT(...) _XBT_IN_OUT("<< end of %s" __VA_ARGS__)
642 * @brief Log at TRACE priority a message indicating that we reached that point, appending a user specified format.
644 #define XBT_HERE(...) XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)
647 #endif /* ! _XBT_LOG_H_ */