X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c46aba70aa4ccf22cc19fac31d451c7158e922dd..db176451b42c9d524f82e6bb9951447e098dd492:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index 72cdf84266..3ec9eb4569 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -1,7 +1,6 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2015. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -9,29 +8,25 @@ /** @addtogroup XBT_log * @brief A generic logging facility in the spirit of log4j (grounding feature) * - * */ /** \defgroup XBT_log_cats Existing log categories * \ingroup XBT_log * \brief (automatically extracted) - * + * * This is the list of all existing log categories in SimGrid. - * This list was automatically extracted from the source code by - * the tools/doxygen/xbt_log_extract_hierarchy.pl utility. - * - * You can thus be certain that it is uptodate, but it may somehow - * lack a final manual touch. - * Anyway, nothing's perfect ;) + * This list is automatically extracted from the source code by the tools/doxygen/xbt_log_extract_hierarchy.pl utility. + * + * It should thus contain every categories that are defined in the SimGrid library. + * If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your simulator. */ /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic - printf function. Useful to debug the logging facilities themselves */ -#undef XBT_LOG_MAYDAY + printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */ //#define XBT_LOG_MAYDAY -#ifndef _XBT_LOG_H_ -#define _XBT_LOG_H_ +#ifndef XBT_LOG_H +#define XBT_LOG_H #include "xbt/misc.h" #include @@ -61,19 +56,16 @@ typedef enum { //! @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 VERBOSE */ - /** * @def XBT_LOG_STATIC_THRESHOLD * @ingroup XBT_log * - * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at - * compile time, i.e., compiled out. + * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out. */ #ifdef NLOG # define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_infinite @@ -104,19 +96,17 @@ typedef enum { /* 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. This is normally done at the - * first use of the category. +/* 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. * - * It is however necessary to make this connections as early as possible, if we - * want the category to be listed by --help-log-categories. + * 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. + * 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(). + * 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) \ @@ -126,9 +116,8 @@ typedef enum { } else ((void)0) /* XBT_LOG_NEW_SUBCATEGORY_helper: - * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition - * to avoid an extra declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by - * XBT_LOG_NEW_CATEGORY */ + * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition 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) \ SG_BEGIN_DECL() \ extern void _XBT_LOGV_CTOR(catName)(void) _XBT_LOGV_CTOR_ATTRIBUTE; \ @@ -178,7 +167,6 @@ typedef enum { # define XBT_LOG_NEW_CATEGORY(catName,desc) \ XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc) - /** * \ingroup XBT_log * \param cname name of the cat @@ -200,8 +188,8 @@ typedef enum { * \param desc string describing the purpose of this category * \hideinitializer * - * Creates a new subcategory of the root category and makes it the default - * (used by macros that don't explicitly specify a category). + * Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly + * specify a category). */ # define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc) \ XBT_LOG_NEW_CATEGORY(cname,desc); \ @@ -226,8 +214,7 @@ typedef enum { * \param cname name of the cat * \hideinitializer * - * Indicates that a category you'll use in this file (to get subcategories of it, - * for example) really lives in another file. + * Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file. */ #define XBT_LOG_EXTERNAL_CATEGORY(cname) \ @@ -250,16 +237,16 @@ typedef enum { XBT_PUBLIC(void) xbt_log_control_set(const char *cs); /* Forward declarations */ -typedef struct xbt_log_appender_s s_xbt_log_appender_t, - *xbt_log_appender_t; -typedef struct xbt_log_layout_s s_xbt_log_layout_t, *xbt_log_layout_t; -typedef struct xbt_log_event_s s_xbt_log_event_t, *xbt_log_event_t; -typedef struct xbt_log_category_s s_xbt_log_category_t, - *xbt_log_category_t; +typedef struct xbt_log_appender_s s_xbt_log_appender_t; +typedef struct xbt_log_appender_s* xbt_log_appender_t; +typedef struct xbt_log_layout_s s_xbt_log_layout_t; +typedef struct xbt_log_layout_s* xbt_log_layout_t; +typedef struct xbt_log_event_s s_xbt_log_event_t; +typedef struct xbt_log_event_s* xbt_log_event_t; +typedef struct xbt_log_category_s s_xbt_log_category_t; +typedef struct xbt_log_category_s* xbt_log_category_t; -/* - * Do NOT access any members of this structure directly. FIXME: move to private? - */ +/* Do NOT access any members of this structure directly. FIXME: move to private? */ struct xbt_log_category_s { xbt_log_category_t parent; @@ -293,45 +280,34 @@ struct xbt_log_event_s { * * Programatically alters a category's threshold priority (don't use). */ -XBT_PUBLIC(void) xbt_log_threshold_set(xbt_log_category_t cat, - e_xbt_log_priority_t - thresholdPriority); +XBT_PUBLIC(void) xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); /** * \ingroup XBT_log_implem * \param cat the category (not only its name, but the variable) * \param app the appender * - * Programatically sets the category's appender. - * (the prefered interface is throught xbt_log_control_set()) - * + * Programatically sets the category's appender. (the preferred interface is through xbt_log_control_set()) */ -XBT_PUBLIC(void) xbt_log_appender_set(xbt_log_category_t cat, - xbt_log_appender_t app); +XBT_PUBLIC(void) xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app); /** * \ingroup XBT_log_implem * \param cat the category (not only its name, but the variable) * \param lay the layout * - * Programatically sets the category's layout. - * (the prefered interface is throught xbt_log_control_set()) - * + * Programatically sets the category's layout. (the preferred interface is through xbt_log_control_set()) */ -XBT_PUBLIC(void) xbt_log_layout_set(xbt_log_category_t cat, - xbt_log_layout_t lay); +XBT_PUBLIC(void) xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay); /** * \ingroup XBT_log_implem * \param cat the category (not only its name, but the variable) * \param additivity whether logging actions must be passed to parent. * - * Programatically sets whether the logging actions must be passed to - * the parent category. - * (the prefered interface is throught xbt_log_control_set()) - * + * Programatically sets whether the logging actions must be passed to the parent category. + * (the preferred interface is through xbt_log_control_set()) */ -XBT_PUBLIC(void) xbt_log_additivity_set(xbt_log_category_t cat, - int additivity); +XBT_PUBLIC(void) xbt_log_additivity_set(xbt_log_category_t cat, int additivity); /** @brief create a new simple layout * @@ -342,23 +318,16 @@ 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); - /* ********************************** */ /* Functions that you shouldn't call */ /* ********************************** */ -XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, - const char *fmt, - ...) XBT_ATTRIB_PRINTF(2, 3); - -XBT_PUBLIC(int) _xbt_log_cat_init(xbt_log_category_t category, - e_xbt_log_priority_t priority); - +XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...) 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: +// 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. @@ -379,9 +348,8 @@ extern xbt_log_layout_t xbt_log_default_layout; * \hideinitializer * * Returns true if the given priority is enabled for the category. - * If you have expensive expressions that are computed outside of the log - * command and used only within it, you should make its evaluation conditional - * using this macro. + * If you have expensive expressions that are computed outside of the log command and used only within it, you should + * make its evaluation conditional using this macro. */ #define XBT_LOG_ISENABLED(catName, priority) \ _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority) @@ -402,12 +370,10 @@ extern xbt_log_layout_t xbt_log_default_layout; * Internal Macros * Some kludge macros to ease maintenance. See how they're used below. * - * IMPLEMENTATION NOTE: To reduce the parameter passing overhead of an enabled - * message, the many parameters passed to the logging function are packed in a - * structure. Since these values will be usually be passed to at least 3 - * functions, this is a win. - * It also allows adding new values (such as a timestamp) without breaking - * code. + * IMPLEMENTATION NOTE: To reduce the parameter passing overhead of an enabled message, the many parameters passed to + * the logging function are packed in a structure. Since these values will be usually be passed to at least 3 functions, + * this is a win. + * It also allows adding new values (such as a timestamp) without breaking code. * Setting the LogEvent's valist member is done inside _log_logEvent. */ @@ -433,7 +399,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(category); \ _log_ev.priority = (prio); \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -446,7 +412,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = _simgrid_log_category__default; \ _log_ev.priority = (prio); \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -466,7 +432,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(_XBT_LOGV(categ)); \ _log_ev.priority = xbt_log_priority_debug; \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -483,7 +449,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(_XBT_LOGV(categ)); \ _log_ev.priority = xbt_log_priority_verbose; \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -500,7 +466,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(_XBT_LOGV(categ)); \ _log_ev.priority = xbt_log_priority_info; \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -518,7 +484,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(_XBT_LOGV(categ)); \ _log_ev.priority = xbt_log_priority_warning; \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -536,7 +502,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(_XBT_LOGV(categ)); \ _log_ev.priority = xbt_log_priority_error; \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -553,7 +519,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _log_ev.cat = &(_XBT_LOGV(categ)); \ _log_ev.priority = xbt_log_priority_critical; \ _log_ev.fileName = __FILE__; \ - _log_ev.functionName = _XBT_FUNCTION; \ + _log_ev.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -572,7 +538,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _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.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -590,7 +556,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _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.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -608,7 +574,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _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.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -626,7 +592,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _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.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -644,7 +610,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _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.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -662,7 +628,7 @@ extern xbt_log_layout_t xbt_log_default_layout; _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.functionName = __func__; \ _log_ev.lineNum = __LINE__; \ _xbt_log_event_log(&_log_ev, __VA_ARGS__); \ } \ @@ -671,9 +637,9 @@ extern xbt_log_layout_t xbt_log_default_layout; #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) + XBT_LOG(xbt_log_priority_trace, fmt, __func__) #define _XBT_IN_OUT_ARGN(fmt, ...) \ - XBT_LOG(xbt_log_priority_trace, fmt, _XBT_FUNCTION, __VA_ARGS__) + XBT_LOG(xbt_log_priority_trace, fmt, __func__, __VA_ARGS__) /** @ingroup XBT_log * @hideinitializer