X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5657b6cbb51a403dbc777e905664dc17ec49f327..4a6b0a991a67e6f2f67c03fed43529e078da7115:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index a398c405e2..fbde8e2efa 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -1,6 +1,6 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004-2011. The SimGrid Team. +/* Copyright (c) 2004-2015. The SimGrid Team. * All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it @@ -43,7 +43,9 @@ SG_BEGIN_DECL() * The different existing priorities. */ typedef enum { - xbt_log_priority_none = 0, /* used internally (don't poke with) */ + //! @cond + xbt_log_priority_none = 0, /** used internally (don't poke with)*/ + //! @endcond xbt_log_priority_trace = 1, /**< enter and return of some functions */ xbt_log_priority_debug = 2, /**< crufty output */ xbt_log_priority_verbose = 3, /**< verbose output for the user wanting more */ @@ -54,13 +56,15 @@ typedef enum { xbt_log_priority_infinite = 8, /**< value for XBT_LOG_STATIC_THRESHOLD to not log */ - xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */ + //! @cond + xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */ + //! @endcond } e_xbt_log_priority_t; /* * define NLOG to disable at compilation time any logging request - * define NDEBUG to disable at compilation time any logging request of priority below INFO + * define NDEBUG to disable at compilation time any logging request of priority below VERBOSE */ @@ -90,40 +94,30 @@ typedef enum { #define _XBT_LOGV_CTOR(cat) _XBT_LOG_CONCAT2(_XBT_LOGV(cat), __constructor__) #define _XBT_LOG_CONCAT(x, y) x ## y #define _XBT_LOG_CONCAT2(x, y) _XBT_LOG_CONCAT(x, y) +/* Apparently, constructor priorities are not supported by gcc on Macs */ +#if defined(__GNUC__) && defined(__APPLE__) +# define _XBT_LOGV_CTOR_ATTRIBUTE +#else +# define _XBT_LOGV_CTOR_ATTRIBUTE _XBT_GNUC_CONSTRUCTOR(600) +#endif /* The root of the category hierarchy. */ #define XBT_LOG_ROOT_CAT root -/* The whole tree of categories is connected by setting the address of - * the parent category as a field of the child one. +/* The whole tree of categories is connected by setting the address of the + * parent category as a field of the child one. This is normally done at the + * first use of the category. * - * In strict ansi C, we are allowed to initialize a variable with "a - * pointer to an lvalue designating an object of static storage - * duration" [ISO/IEC 9899:1999, Section 6.6]. - * - * Unfortunately, Visual C builder does not target any standard - * compliance, and C99 is not an exception to this unfortunate rule. - * - * So, we work this around by adding a XBT_LOG_CONNECT_PARENT() macro, - * allowing to connect a child to its parent. It should be used - * during the initialization of the code, before the child category - * gets used. - * - * When compiling with gcc, this is not necessary (XBT_LOG_CONNECT_PARENT - * defines to nothing). When compiling with MSVC, this is needed if - * you don't want to see your child category become a child of root - * directly. - */ -#if defined(_MSC_VER) -# define _XBT_LOG_PARENT_INITIALIZER(parent) NULL -# define XBT_LOG_CONNECT_PARENT(child, parent_cat) \ - _XBT_LOGV(child).parent = &_XBT_LOGV(parent_cat) -#else -# define _XBT_LOG_PARENT_INITIALIZER(parent) &_XBT_LOGV(parent) -# define XBT_LOG_CONNECT_PARENT(child, parent_cat) \ - /* xbt_assert(_XBT_LOGV(child).parent == &_XBT_LOGV(parent_cat)); */ \ - ((void)0) -#endif + * It is however necessary to make this connections as early as possible, if we + * want the category to be listed by --help-log-categories. + * + * When possible, the initializations takes place automatically before the start + * of main(). It's the case when compiling with gcc. + * + * For the other cases, you can use the XBT_LOG_CONNECT(cat) macro to force + * early initialization. See, for example, in xbt/log.c, the function + * xbt_log_connect_categories(). + */ #define XBT_LOG_CONNECT(cat) \ if (1) { \ @@ -136,16 +130,18 @@ typedef enum { * to avoid an extra declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by * XBT_LOG_NEW_CATEGORY */ #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ - XBT_PUBLIC(void) _XBT_LOGV_CTOR(catName)(void) _XBT_GNUC_CONSTRUCTOR(600); \ + SG_BEGIN_DECL() \ + extern void _XBT_LOGV_CTOR(catName)(void) _XBT_LOGV_CTOR_ATTRIBUTE; \ void _XBT_LOGV_CTOR(catName)(void) \ { \ XBT_LOG_EXTERNAL_CATEGORY(catName); \ - /* Note: _XBT_LOGV(parent) should be already declared here. */ \ - XBT_LOG_CONNECT_PARENT(catName, parent); \ - _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \ + if (!_XBT_LOGV(catName).initialized) { \ + _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \ + } \ } \ + SG_END_DECL() \ XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = { \ - _XBT_LOG_PARENT_INITIALIZER(parent), \ + &_XBT_LOGV(parent), \ NULL /* firstChild */, \ NULL /* nextSibling */, \ #catName, \ @@ -191,11 +187,11 @@ typedef enum { * Indicates which category is the default one. */ -#if defined(XBT_LOG_MAYDAY) || defined(SUPERNOVAE_MODE) /*|| defined (NLOG) * turning logging off */ +#if defined(XBT_LOG_MAYDAY) /*|| defined (NLOG) * turning logging off */ # define XBT_LOG_DEFAULT_CATEGORY(cname) #else # define XBT_LOG_DEFAULT_CATEGORY(cname) \ - static xbt_log_category_t _XBT_LOGV(default) _XBT_GNUC_UNUSED = &_XBT_LOGV(cname) + static xbt_log_category_t _XBT_LOGV(default) XBT_ATTRIB_UNUSED = &_XBT_LOGV(cname) #endif /** @@ -344,6 +340,7 @@ XBT_PUBLIC(void) xbt_log_additivity_set(xbt_log_category_t cat, XBT_PUBLIC(xbt_log_layout_t) xbt_log_layout_simple_new(char *arg); XBT_PUBLIC(xbt_log_layout_t) xbt_log_layout_format_new(char *arg); XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender_file_new(char *arg); +XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender2_file_new(char *arg,int roll); /* ********************************** */ @@ -351,14 +348,22 @@ XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender_file_new(char *arg); /* ********************************** */ XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, - ...) _XBT_GNUC_PRINTF(2, 3); + ...) XBT_ATTRIB_PRINTF(2, 3); XBT_PUBLIC(int) _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority); +#ifdef DLL_EXPORT XBT_PUBLIC_DATA(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT); - +#else +// If we `dllexport` the root log category, MinGW does not want us to +// take its address with the error: +// > initializer element is not constant +// When using auto-import, MinGW is happy. +// We should handle this for non-root log categories as well. +extern s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT); +#endif extern xbt_log_appender_t xbt_log_default_appender; extern xbt_log_layout_t xbt_log_default_layout; @@ -390,8 +395,8 @@ extern xbt_log_layout_t xbt_log_default_layout; */ #define _XBT_LOG_ISENABLEDV(catv, priority) \ (priority >= XBT_LOG_STATIC_THRESHOLD \ - && (catv.initialized || _xbt_log_cat_init(&catv, priority)) \ - && priority >= catv.threshold) + && ((catv).initialized || _xbt_log_cat_init(&(catv), priority)) \ + && priority >= (catv).threshold) /* * Internal Macros @@ -417,11 +422,28 @@ extern xbt_log_layout_t xbt_log_default_layout; fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__, __VA_ARGS__) # define XBT_LOG(...) XBT_CLOG(0, __VA_ARGS__) #else -# define XBT_CLOG_(catv, prio, ...) \ + +// This code is duplicated to remove one level of indirection, working around a MSVC bug +// See: http://stackoverflow.com/questions/9183993/msvc-variadic-macro-expansion + +# define XBT_CLOG(category, prio, ...) \ do { \ - if (_XBT_LOG_ISENABLEDV(catv, prio)) { \ + if (_XBT_LOG_ISENABLEDV((category), prio)) { \ s_xbt_log_event_t _log_ev; \ - _log_ev.cat = &(catv); \ + _log_ev.cat = &(category); \ + _log_ev.priority = (prio); \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) + +# define XBT_LOG(prio,...) \ + do { \ + if (_XBT_LOG_ISENABLEDV((*_simgrid_log_category__default), prio)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ _log_ev.priority = (prio); \ _log_ev.fileName = __FILE__; \ _log_ev.functionName = _XBT_FUNCTION; \ @@ -429,107 +451,247 @@ extern xbt_log_layout_t xbt_log_default_layout; _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ } while (0) -# define XBT_CLOG(cat, prio, ...) XBT_CLOG_(_XBT_LOGV(cat), prio, __VA_ARGS__) -# define XBT_LOG(...) XBT_CLOG_((*_XBT_LOGV(default)), __VA_ARGS__) #endif /** @ingroup XBT_log * @hideinitializer - * \param c the category on which to log + * \param categ the category on which to log * \param ... the format string and its arguments * @brief Log an event at the DEBUG priority on the specified category with these args. */ -#define XBT_CDEBUG(c, ...) XBT_CLOG(c, xbt_log_priority_debug, __VA_ARGS__) +#define XBT_CDEBUG(categ, ...) \ + do { \ + if (XBT_LOG_ISENABLED (categ, xbt_log_priority_debug)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = &(_XBT_LOGV(categ)); \ + _log_ev.priority = xbt_log_priority_debug; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the VERB priority on the specified category with these args. */ -#define XBT_CVERB(c, ...) XBT_CLOG(c, xbt_log_priority_verbose, __VA_ARGS__) +#define XBT_CVERB(categ, ...) \ + do { \ + if (XBT_LOG_ISENABLED (categ, xbt_log_priority_verbose)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = &(_XBT_LOGV(categ)); \ + _log_ev.priority = xbt_log_priority_verbose; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the INFO priority on the specified category with these args. */ -#define XBT_CINFO(c, ...) XBT_CLOG(c, xbt_log_priority_info, __VA_ARGS__) +#define XBT_CINFO(categ, ...) \ + do { \ + if (XBT_LOG_ISENABLED (categ, xbt_log_priority_info)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = &(_XBT_LOGV(categ)); \ + _log_ev.priority = xbt_log_priority_info; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) + /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the WARN priority on the specified category with these args. */ -#define XBT_CWARN(c, ...) XBT_CLOG(c, xbt_log_priority_warning, __VA_ARGS__) +#define XBT_CWARN(categ, ...) \ + do { \ + if (XBT_LOG_ISENABLED (categ, xbt_log_priority_warning)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = &(_XBT_LOGV(categ)); \ + _log_ev.priority = xbt_log_priority_warning; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) + /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the ERROR priority on the specified category with these args. */ -#define XBT_CERROR(c, ...) XBT_CLOG(c, xbt_log_priority_error, __VA_ARGS__) +#define XBT_CERROR(categ, ...) \ + do { \ + if (XBT_LOG_ISENABLED (categ, xbt_log_priority_error)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = &(_XBT_LOGV(categ)); \ + _log_ev.priority = xbt_log_priority_error; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10). */ -#define XBT_CCRITICAL(c, ...) XBT_CLOG(c, xbt_log_priority_critical, __VA_ARGS__) +#define XBT_CCRITICAL(categ, ...) \ + do { \ + if (XBT_LOG_ISENABLED (categ, xbt_log_priority_critical)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = &(_XBT_LOGV(categ)); \ + _log_ev.priority = xbt_log_priority_critical; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * \param ... the format string and its arguments * @brief Log an event at the DEBUG priority on the default category with these args. */ -#define XBT_DEBUG(...) XBT_LOG(xbt_log_priority_debug, __VA_ARGS__) +#define XBT_DEBUG(...) \ + do { \ + if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \ + xbt_log_priority_debug)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ + _log_ev.priority = xbt_log_priority_debug; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the VERB priority on the default category with these args. */ -#define XBT_VERB(...) XBT_LOG(xbt_log_priority_verbose, __VA_ARGS__) +#define XBT_VERB(...) \ + do { \ + if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \ + xbt_log_priority_verbose)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ + _log_ev.priority = xbt_log_priority_verbose; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the INFO priority on the default category with these args. */ -#define XBT_INFO(...) XBT_LOG(xbt_log_priority_info, __VA_ARGS__) +#define XBT_INFO(...) \ + do { \ + if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \ + xbt_log_priority_info)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ + _log_ev.priority = xbt_log_priority_info; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the WARN priority on the default category with these args. */ -#define XBT_WARN(...) XBT_LOG(xbt_log_priority_warning, __VA_ARGS__) +#define XBT_WARN(...) \ + do { \ + if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \ + xbt_log_priority_warning)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ + _log_ev.priority = xbt_log_priority_warning; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the ERROR priority on the default category with these args. */ -#define XBT_ERROR(...) XBT_LOG(xbt_log_priority_error, __VA_ARGS__) +#define XBT_ERROR(...) \ + do { \ + if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \ + xbt_log_priority_error)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ + _log_ev.priority = xbt_log_priority_error; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) /** @ingroup XBT_log * @hideinitializer * @brief Log an event at the CRITICAL priority on the default category with these args. */ -#define XBT_CRITICAL(...) XBT_LOG(xbt_log_priority_critical, __VA_ARGS__) +#define XBT_CRITICAL(...) \ + do { \ + if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \ + xbt_log_priority_critical)) { \ + s_xbt_log_event_t _log_ev; \ + _log_ev.cat = _simgrid_log_category__default; \ + _log_ev.priority = xbt_log_priority_critical; \ + _log_ev.fileName = __FILE__; \ + _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.lineNum = __LINE__; \ + _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ + } \ + } while (0) + +#define _XBT_IN_OUT(...) \ + _XBT_IF_ONE_ARG(_XBT_IN_OUT_ARG1, _XBT_IN_OUT_ARGN, __VA_ARGS__)(__VA_ARGS__) +#define _XBT_IN_OUT_ARG1(fmt) \ + XBT_LOG(xbt_log_priority_trace, fmt, _XBT_FUNCTION) +#define _XBT_IN_OUT_ARGN(fmt, ...) \ + XBT_LOG(xbt_log_priority_trace, fmt, _XBT_FUNCTION, __VA_ARGS__) /** @ingroup XBT_log * @hideinitializer * @brief Log at TRACE priority that we entered in current function, appending a user specified format. */ -#define XBT_IN(...) \ - _XBT_IF_ONE_ARG(_XBT_IN_ARG1, _XBT_IN_ARGN, __VA_ARGS__)(__VA_ARGS__) -#define _XBT_IN_ARG1(fmt) \ - XBT_LOG(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION) -#define _XBT_IN_ARGN(fmt, ...) \ - XBT_LOG(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, __VA_ARGS__) +#define XBT_IN(...) _XBT_IN_OUT(">> begin of %s" __VA_ARGS__) /** @ingroup XBT_log * @hideinitializer - * @brief Log at TRACE priority that we exited the current function. + * @brief Log at TRACE priority that we exited the current function, appending a user specified format. */ -#define XBT_OUT() XBT_LOG(xbt_log_priority_trace, "<< end of %s", _XBT_FUNCTION) +#define XBT_OUT(...) _XBT_IN_OUT("<< end of %s" __VA_ARGS__) /** @ingroup XBT_log * @hideinitializer - * @brief Log at TRACE priority a message indicating that we reached that point. + * @brief Log at TRACE priority a message indicating that we reached that point, appending a user specified format. */ -#define XBT_HERE() XBT_LOG(xbt_log_priority_trace, "-- was here") +#define XBT_HERE(...) XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__) #ifdef XBT_USE_DEPRECATED