1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2020. 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
25 /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
26 printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */
27 //#define XBT_LOG_MAYDAY
33 #include <stddef.h> /* NULL */
34 #include <stdio.h> /* FILE */
37 /**@brief Log priorities
40 * The different existing priorities.
44 xbt_log_priority_none = 0, /** used internally (don't poke with)*/
46 xbt_log_priority_trace = 1, /**< enter and return of some functions */
47 xbt_log_priority_debug = 2, /**< crufty output */
48 xbt_log_priority_verbose = 3, /**< verbose output for the user wanting more */
49 xbt_log_priority_info = 4, /**< output about the regular functionning */
50 xbt_log_priority_warning = 5, /**< minor issue encountered */
51 xbt_log_priority_error = 6, /**< issue encountered */
52 xbt_log_priority_critical = 7, /**< major issue encountered */
54 xbt_log_priority_infinite = 8, /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
57 xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */
59 } e_xbt_log_priority_t;
62 * define NLOG to disable at compilation time any logging request
63 * define NDEBUG to disable at compilation time any logging request of priority below VERBOSE
67 * @def XBT_LOG_STATIC_THRESHOLD
70 * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out.
73 # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_infinite
77 # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_verbose
78 # else /* !NLOG && !NDEBUG */
80 # ifndef XBT_LOG_STATIC_THRESHOLD
81 # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_none
82 # endif /* !XBT_LOG_STATIC_THRESHOLD */
84 #endif /* !defined(NLOG) */
86 /* Transforms a category name to a global variable name. */
87 #define _XBT_LOGV(cat) _XBT_CONCAT(_simgrid_log_category__, cat)
88 #define _XBT_LOGV_CTOR(cat) _XBT_CONCAT2(_XBT_LOGV(cat), __constructor__)
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); \
108 void _XBT_LOGV_CTOR(catName)(void) \
110 XBT_LOG_EXTERNAL_CATEGORY(catName); \
111 if (!_XBT_LOGV(catName).initialized) { \
112 _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 */, \
119 _XBT_STRINGIFY(catName), \
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) XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, (desc))
154 * @param cname name of the cat
157 * Indicates which category is the default one.
160 #if defined(XBT_LOG_MAYDAY) /*|| defined (NLOG) * turning logging off */
161 # define XBT_LOG_DEFAULT_CATEGORY(cname)
163 #define XBT_LOG_DEFAULT_CATEGORY(cname) \
164 XBT_ATTRIB_UNUSED static xbt_log_category_t _XBT_LOGV(default) = &_XBT_LOGV(cname)
169 * @param cname name of the cat
170 * @param desc string describing the purpose of this category
173 * Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly
174 * specify a category).
176 #define XBT_LOG_NEW_DEFAULT_CATEGORY(cname, desc) \
177 XBT_LOG_NEW_CATEGORY(cname, (desc)); \
178 XBT_LOG_DEFAULT_CATEGORY(cname)
182 * @param cname name of the cat
183 * @param parent name of the parent
184 * @param desc string describing the purpose of this category
187 * Creates a new subcategory of the parent category and makes it the default
188 * (used by macros that don't explicitly specify a category).
190 #define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) \
191 XBT_LOG_NEW_SUBCATEGORY(cname, parent, (desc)); \
192 XBT_LOG_DEFAULT_CATEGORY(cname)
196 * @param cname name of the cat
199 * Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file.
202 #define XBT_LOG_EXTERNAL_CATEGORY(cname) \
203 extern s_xbt_log_category_t _XBT_LOGV(cname)
207 * @param cname name of the cat
210 * Indicates that the default category of this file was declared in another file.
213 #define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname) \
214 XBT_LOG_EXTERNAL_CATEGORY(cname);\
215 XBT_LOG_DEFAULT_CATEGORY(cname)
217 /* Functions you may call */
219 XBT_PUBLIC void xbt_log_control_set(const char* cs);
221 /* Forward declarations */
222 typedef struct xbt_log_appender_s s_xbt_log_appender_t;
223 typedef s_xbt_log_appender_t* xbt_log_appender_t;
224 typedef struct xbt_log_layout_s s_xbt_log_layout_t;
225 typedef s_xbt_log_layout_t* xbt_log_layout_t;
226 typedef struct xbt_log_event_s s_xbt_log_event_t;
227 typedef s_xbt_log_event_t* xbt_log_event_t;
228 typedef struct xbt_log_category_s s_xbt_log_category_t;
229 typedef s_xbt_log_category_t* xbt_log_category_t;
231 /* Do NOT access any members of this structure directly. FIXME: move to private? */
233 struct xbt_log_category_s {
234 xbt_log_category_t parent;
235 xbt_log_category_t firstChild;
236 xbt_log_category_t nextSibling;
238 const char *description;
241 int isThreshInherited;
242 xbt_log_appender_t appender;
243 xbt_log_layout_t layout;
247 struct xbt_log_event_s {
248 xbt_log_category_t cat;
249 e_xbt_log_priority_t priority;
250 const char *fileName;
251 const char *functionName;
259 * @ingroup XBT_log_implem
260 * @param cat the category (not only its name, but the variable)
261 * @param thresholdPriority the priority
263 * Programmatically alters a category's threshold priority (don't use).
265 XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority);
268 * @ingroup XBT_log_implem
269 * @param cat the category (not only its name, but the variable)
270 * @param app the appender
272 * Programmatically sets the category's appender. (the preferred interface is through xbt_log_control_set())
274 XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app);
276 * @ingroup XBT_log_implem
277 * @param cat the category (not only its name, but the variable)
278 * @param lay the layout
280 * Programmatically sets the category's layout. (the preferred interface is through xbt_log_control_set())
282 XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay);
285 * @ingroup XBT_log_implem
286 * @param cat the category (not only its name, but the variable)
287 * @param additivity whether logging actions must be passed to parent.
289 * Programmatically sets whether the logging actions must be passed to the parent category.
290 * (the preferred interface is through xbt_log_control_set())
292 XBT_PUBLIC void xbt_log_additivity_set(xbt_log_category_t cat, int additivity);
294 /** @brief create a new simple layout
296 * This layout is not as flexible as the pattern one
298 XBT_PUBLIC xbt_log_layout_t xbt_log_layout_simple_new(const char* arg);
299 XBT_PUBLIC xbt_log_layout_t xbt_log_layout_format_new(const char* arg);
300 XBT_PUBLIC xbt_log_appender_t xbt_log_appender_stream(FILE* f);
301 XBT_PUBLIC xbt_log_appender_t xbt_log_appender_file_new(const char* arg);
302 XBT_PUBLIC xbt_log_appender_t xbt_log_appender2_file_new(const 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) _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), (priority))
341 * Helper function that implements XBT_LOG_ISENABLED.
344 * First part is a compile-time constant.
345 * Call to xbt_log_cat_init only happens once.
347 #define _XBT_LOG_ISENABLEDV(catv, priority) \
348 ((priority) >= XBT_LOG_STATIC_THRESHOLD && ((catv).initialized || _xbt_log_cat_init(&(catv), (priority))) && \
349 (priority) >= (catv).threshold)
353 * Some kludge macros to ease maintenance. See how they're used below.
355 * IMPLEMENTATION NOTE: To reduce the parameter passing overhead of an enabled message, the many parameters passed to
356 * the logging function are packed in a structure. Since these values will be usually be passed to at least 3 functions,
358 * It also allows adding new values (such as a timestamp) without breaking code.
359 * Setting the LogEvent's valist member is done inside _log_logEvent.
364 #ifdef XBT_LOG_MAYDAY
365 # define XBT_CLOG(cat, prio, ...) \
366 _XBT_IF_ONE_ARG(_XBT_CLOG_ARG1, _XBT_CLOG_ARGN, __VA_ARGS__)(__VA_ARGS__)
367 # define _XBT_CLOG_ARG1(f) \
368 fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__)
369 # define _XBT_CLOG_ARGN(f, ...) \
370 fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__, __VA_ARGS__)
371 # define XBT_LOG(...) XBT_CLOG(0, __VA_ARGS__)
374 #define XBT_CLOG(category, prio, ...) \
376 if (_XBT_LOG_ISENABLEDV((category), (prio))) { \
377 s_xbt_log_event_t _log_ev; \
378 _log_ev.cat = &(category); \
379 _log_ev.priority = (prio); \
380 _log_ev.fileName = __FILE__; \
381 _log_ev.functionName = __func__; \
382 _log_ev.lineNum = __LINE__; \
383 _xbt_log_event_log(&_log_ev, __VA_ARGS__); \
387 #define XBT_LOG(prio, ...) XBT_CLOG(*_simgrid_log_category__default, (prio), __VA_ARGS__)
393 * @param categ the category on which to log
394 * @param ... the format string and its arguments
395 * @brief Log an event at the DEBUG priority on the specified category with these args.
397 #define XBT_CDEBUG(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_debug, __VA_ARGS__)
401 * @brief Log an event at the VERB priority on the specified category with these args.
403 #define XBT_CVERB(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_verbose, __VA_ARGS__)
407 * @brief Log an event at the INFO priority on the specified category with these args.
409 #define XBT_CINFO(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_info, __VA_ARGS__)
413 * @brief Log an event at the WARN priority on the specified category with these args.
415 #define XBT_CWARN(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_warning, __VA_ARGS__)
419 * @brief Log an event at the ERROR priority on the specified category with these args.
421 #define XBT_CERROR(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_error, __VA_ARGS__)
425 * @brief Log an event at the CRITICAL priority on the specified category with these args.
427 #define XBT_CCRITICAL(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_critical, __VA_ARGS__)
431 * @param ... the format string and its arguments
432 * @brief Log an event at the DEBUG priority on the default category with these args.
434 #define XBT_DEBUG(...) XBT_LOG(xbt_log_priority_debug, __VA_ARGS__)
438 * @brief Log an event at the VERB priority on the default category with these args.
440 #define XBT_VERB(...) XBT_LOG(xbt_log_priority_verbose, __VA_ARGS__)
444 * @brief Log an event at the INFO priority on the default category with these args.
446 #define XBT_INFO(...) XBT_LOG(xbt_log_priority_info, __VA_ARGS__)
450 * @brief Log an event at the WARN priority on the default category with these args.
452 #define XBT_WARN(...) XBT_LOG(xbt_log_priority_warning, __VA_ARGS__)
456 * @brief Log an event at the ERROR priority on the default category with these args.
458 #define XBT_ERROR(...) XBT_LOG(xbt_log_priority_error, __VA_ARGS__)
462 * @brief Log an event at the CRITICAL priority on the default category with these args.
464 #define XBT_CRITICAL(...) XBT_LOG(xbt_log_priority_critical, __VA_ARGS__)
466 #define _XBT_IN_OUT(...) \
467 _XBT_IF_ONE_ARG(_XBT_IN_OUT_ARG1, _XBT_IN_OUT_ARGN, __VA_ARGS__)(__VA_ARGS__)
468 #define _XBT_IN_OUT_ARG1(fmt) XBT_LOG(xbt_log_priority_trace, (fmt), __func__)
469 #define _XBT_IN_OUT_ARGN(fmt, ...) XBT_LOG(xbt_log_priority_trace, (fmt), __func__, __VA_ARGS__)
473 * @brief Log at TRACE priority that we entered in current function, appending a user specified format.
475 #define XBT_IN(...) _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)
479 * @brief Log at TRACE priority that we exited the current function, appending a user specified format.
481 #define XBT_OUT(...) _XBT_IN_OUT("<< end of %s" __VA_ARGS__)
485 * @brief Log at TRACE priority a message indicating that we reached that point, appending a user specified format.
487 #define XBT_HERE(...) XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)
491 * @brief Log help messages through category xbt.xbt_help.
493 #define XBT_HELP(...) XBT_CINFO(xbt_help, __VA_ARGS__)
496 #endif /* XBT_LOG_H */