X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d73750d4032cc6768f10f2778846d367f3360196..1e18ccad74ce3d49299f1da9022c5d5e4ee76918:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index 0de57388f1..bf2025e083 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -7,6 +7,25 @@ /* 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. */ +/** @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 src/xbt_log_extract_hierarchy utility. + * + * You can thus be certain that it is uptodate, but it may somehow + * lack a final manual touch. + * Anyway, nothing's perfect ;) + */ + /* 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 @@ -15,9 +34,9 @@ #ifndef _XBT_LOG_H_ #define _XBT_LOG_H_ -#include +#include "xbt/misc.h" -#include "xbt/sysdep.h" +#include /**\brief Log priorities * \ingroup XBT_log @@ -25,8 +44,8 @@ * The different existing priorities. */ typedef enum { - xbt_log_priority_none = 0, /**< used internally (don't poke with) */ - xbt_log_priority_trace = 1, + xbt_log_priority_none = 0, /* used internally (don't poke with) */ + 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 */ xbt_log_priority_info = 4, /**< output about the regular functionning */ @@ -36,7 +55,7 @@ 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) */ + xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */ } e_xbt_log_priority_t; @@ -47,8 +66,8 @@ typedef enum { /** - * \def XBT_LOG_STATIC_THRESHOLD: - * \ingroup XBT_log + * @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. @@ -74,34 +93,43 @@ typedef enum { /* The root of the category hierarchy. */ #define XBT_LOG_ROOT_CAT root +/* 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 */ +#define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ + s_xbt_log_category_t _XBT_LOGV(catName) = { \ + &_XBT_LOGV(parent), 0, 0, \ + #catName, xbt_log_priority_uninitialized, 1, \ + 0, 1 \ + } /** * \ingroup XBT_log * \param catName name of new category * \param parent father of the new category in the tree * \param desc string describing the purpose of this category + * \hideinitializer * * Defines a new subcategory of the parent. */ -#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ - extern s_xbt_log_category_t _XBT_LOGV(parent); \ - s_xbt_log_category_t _XBT_LOGV(catName) = { \ - &_XBT_LOGV(parent), 0, 0, \ - #catName, xbt_log_priority_uninitialized, 1, \ - 0, 1 \ - } +#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ + extern s_xbt_log_category_t _XBT_LOGV(parent); \ + XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ /** * \ingroup XBT_log * \param catName name of new category * \param desc string describing the purpose of this category + * \hideinitializer * * Creates a new subcategory of the root category. */ -#define XBT_LOG_NEW_CATEGORY(catName,desc) XBT_LOG_NEW_SUBCATEGORY(catName, XBT_LOG_ROOT_CAT, desc) +#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 + * \hideinitializer * * Indicates which category is the default one. */ @@ -117,6 +145,7 @@ typedef enum { * \ingroup XBT_log * \param cname name of the cat * \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). @@ -130,6 +159,7 @@ typedef enum { * \param cname name of the cat * \param parent name of the parent * \param desc string describing the purpose of this category + * \hideinitializer * * Creates a new subcategory of the parent category and makes it the default * (used by macros that don't explicitly specify a category). @@ -141,6 +171,7 @@ typedef enum { /** * \ingroup XBT_log * \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. @@ -235,6 +266,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * \ingroup XBT_log * \param catName name of the category * \param priority minimal priority to be enabled to return true + * \hideinitializer * * Returns true if the given priority is enabled for the category. * If you have expensive expressions that are computed outside of the log @@ -273,7 +305,7 @@ extern xbt_log_appender_t xbt_log_default_appender; #define _XBT_LOG_PRE(catv, priority) do { \ if (_XBT_LOG_ISENABLEDV(catv, priority)) { \ s_xbt_log_event_t _log_ev = \ - {&(catv),priority,__FILE__,_XBT_GNUC_FUNCTION,__LINE__}; \ + {&(catv),priority,__FILE__,_XBT_FUNCTION,__LINE__}; \ _xbt_log_event_log(&_log_ev #define _XBT_LOG_POST \ @@ -392,7 +424,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * for sake of clarity. They just differ in the number of arguments passed * along with the format string. */ -/*@{*/ +/* @{ */ #define DEBUG0(f) LOG0(xbt_log_priority_debug, f) #define DEBUG1(f,a1) LOG1(xbt_log_priority_debug, f,a1) #define DEBUG2(f,a1,a2) LOG2(xbt_log_priority_debug, f,a1,a2) @@ -402,7 +434,7 @@ extern xbt_log_appender_t xbt_log_default_appender; #define DEBUG6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6) #define DEBUG7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7) #define DEBUG8(f,a1,a2,a3,a4,a5,a6,a7,a8) LOG8(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8) -/*@}*/ +/* @} */ /** \name VERB * \ingroup XBT_log @@ -419,7 +451,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * for sake of clarity. They just differ in the number of arguments passed * along with the format string. */ -/*@{*/ +/* @{ */ #define VERB0(f) LOG0(xbt_log_priority_verbose, f) #define VERB1(f,a1) LOG1(xbt_log_priority_verbose, f,a1) #define VERB2(f,a1,a2) LOG2(xbt_log_priority_verbose, f,a1,a2) @@ -427,7 +459,7 @@ extern xbt_log_appender_t xbt_log_default_appender; #define VERB4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_verbose, f,a1,a2,a3,a4) #define VERB5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5) #define VERB6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6) -/*@}*/ +/* @} */ /** \name INFO * \ingroup XBT_log @@ -444,7 +476,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * for sake of clarity. They just differ in the number of arguments passed * along with the format string. */ -/*@{*/ +/* @{ */ #define INFO0(f) LOG0(xbt_log_priority_info, f) #define INFO1(f,a1) LOG1(xbt_log_priority_info, f,a1) #define INFO2(f,a1,a2) LOG2(xbt_log_priority_info, f,a1,a2) @@ -452,7 +484,7 @@ extern xbt_log_appender_t xbt_log_default_appender; #define INFO4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_info, f,a1,a2,a3,a4) #define INFO5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_info, f,a1,a2,a3,a4,a5) #define INFO6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6) -/*@}*/ +/* @} */ /** \name WARN * \ingroup XBT_log @@ -469,7 +501,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * for sake of clarity. They just differ in the number of arguments passed * along with the format string. */ -/*@{*/ +/* @{ */ #define WARN0(f) LOG0(xbt_log_priority_warning, f) #define WARN1(f,a1) LOG1(xbt_log_priority_warning, f,a1) #define WARN2(f,a1,a2) LOG2(xbt_log_priority_warning, f,a1,a2) @@ -477,7 +509,7 @@ extern xbt_log_appender_t xbt_log_default_appender; #define WARN4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_warning, f,a1,a2,a3,a4) #define WARN5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_warning, f,a1,a2,a3,a4,a5) #define WARN6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6) -/*@}*/ +/* @} */ /** \name ERROR * \ingroup XBT_log @@ -494,7 +526,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * for sake of clarity. They just differ in the number of arguments passed * along with the format string. */ -/*@{*/ +/* @{ */ #define ERROR0(f) LOG0(xbt_log_priority_error, f) #define ERROR1(f,a1) LOG1(xbt_log_priority_error, f,a1) #define ERROR2(f,a1,a2) LOG2(xbt_log_priority_error, f,a1,a2) @@ -502,7 +534,7 @@ extern xbt_log_appender_t xbt_log_default_appender; #define ERROR4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_error, f,a1,a2,a3,a4) #define ERROR5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_error, f,a1,a2,a3,a4,a5) #define ERROR6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6) -/*@}*/ +/* @} */ /** \name CRITICAL * \ingroup XBT_log @@ -519,7 +551,7 @@ extern xbt_log_appender_t xbt_log_default_appender; * for sake of clarity. They just differ in the number of arguments passed * along with the format string. */ -/*@{*/ +/* @{ */ #define CRITICAL0(f) LOG0(xbt_log_priority_critical, f) #define CRITICAL1(f,a1) LOG1(xbt_log_priority_critical, f,a1) #define CRITICAL2(f,a1,a2) LOG2(xbt_log_priority_critical, f,a1,a2) @@ -527,14 +559,14 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CRITICAL4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_critical, f,a1,a2,a3,a4) #define CRITICAL5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_critical, f,a1,a2,a3,a4,a5) #define CRITICAL6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6) -/*@}*/ - -#define XBT_IN LOG1(xbt_log_priority_trace, ">> begin of %s", _XBT_GNUC_FUNCTION) -#define XBT_IN1(fmt,a) LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a) -#define XBT_IN2(fmt,a,b) LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b) -#define XBT_IN3(fmt,a,b,c) LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c) -#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c,d) -#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_GNUC_FUNCTION) +/* @} */ + +#define XBT_IN LOG1(xbt_log_priority_trace, ">> begin of %s", _XBT_FUNCTION) +#define XBT_IN1(fmt,a) LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a) +#define XBT_IN2(fmt,a,b) LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b) +#define XBT_IN3(fmt,a,b,c) LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c) +#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c,d) +#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_FUNCTION) #define XBT_HERE LOG0(xbt_log_priority_trace, "-- was here") #endif /* ! _XBT_LOG_H_ */