X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/19bdb25835da6ee353675dfb995cf9ca886361b2..5c80d460aa6de6fc6b03496b29a3acbc23d333f4:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index 9bb6e7723e..26efd1358b 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 @@ -18,15 +37,15 @@ #include "xbt/misc.h" #include - +SG_BEGIN_DECL() /**\brief Log priorities * \ingroup XBT_log * * 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) \ + XBT_PUBLIC_NO_IMPORT(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. */ @@ -110,13 +138,14 @@ typedef enum { # define XBT_LOG_DEFAULT_CATEGORY(cname) #else # define XBT_LOG_DEFAULT_CATEGORY(cname) \ - static xbt_log_category_t _XBT_LOGV(default) = &_XBT_LOGV(cname) + static xbt_log_category_t _XBT_LOGV(default) _XBT_GNUC_UNUSED = &_XBT_LOGV(cname) #endif /** * \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. @@ -149,9 +180,21 @@ typedef enum { #define XBT_LOG_EXTERNAL_CATEGORY(cname) \ extern s_xbt_log_category_t _XBT_LOGV(cname) +/** + * \ingroup XBT_log + * \param cname name of the cat + * \hideinitializer + * + * Indicates that the default category of this file was declared in another file. + */ + +#define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname) \ + XBT_LOG_EXTERNAL_CATEGORY(cname);\ + XBT_LOG_DEFAULT_CATEGORY(cname) + /* Functions you may call */ -extern void xbt_log_control_set(const char* cs); +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; @@ -195,7 +238,7 @@ struct xbt_log_event_s { * * Programatically alters a category's threshold priority (don't use). */ -extern void xbt_log_threshold_set(xbt_log_category_t cat, +XBT_PUBLIC(void) xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); /** @@ -205,7 +248,7 @@ extern void xbt_log_threshold_set(xbt_log_category_t cat, * * Programatically alter a category's parent (don't use). */ -extern void xbt_log_parent_set(xbt_log_category_t cat, +XBT_PUBLIC(void) xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent); /** @@ -215,15 +258,15 @@ extern void xbt_log_parent_set(xbt_log_category_t cat, * * Programatically sets the category's appender (don't use). */ -extern void xbt_log_appender_set(xbt_log_category_t cat, +XBT_PUBLIC(void) xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app); /* Functions that you shouldn't call. */ -extern void _xbt_log_event_log(xbt_log_event_t ev, +XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...) _XBT_GNUC_PRINTF(2,3); -extern int _xbt_log_cat_init(e_xbt_log_priority_t priority, +XBT_PUBLIC(int) _xbt_log_cat_init(e_xbt_log_priority_t priority, xbt_log_category_t category); @@ -235,6 +278,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 @@ -270,11 +314,13 @@ extern xbt_log_appender_t xbt_log_default_appender; * Setting the LogEvent's valist member is done inside _log_logEvent. */ -#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__}; \ - _xbt_log_event_log(&_log_ev +#define _XBT_LOG_PRE(catv, priority) do { \ + if (_XBT_LOG_ISENABLEDV(catv, priority)) { \ + s_xbt_log_event_t _log_ev = \ + {NULL,priority,__FILE__,_XBT_FUNCTION,__LINE__}; \ + _log_ev.cat = &(catv); \ + _xbt_log_event_log(&_log_ev \ + #define _XBT_LOG_POST \ ); \ @@ -293,6 +339,8 @@ extern xbt_log_appender_t xbt_log_default_appender; # define CLOG6(c, p, f,a1,a2,a3,a4,a5,a6) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6) # define CLOG7(c, p, f,a1,a2,a3,a4,a5,a6,a7) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7) # define CLOG8(c, p, f,a1,a2,a3,a4,a5,a6,a7,a8) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7,a8) +# define CLOG9(c, p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7,a8,a9) +# define CLOG10(c, p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) #else # define CLOG0(c, p, f) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f _XBT_LOG_POST # define CLOG1(c, p, f,a1) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1 _XBT_LOG_POST @@ -303,8 +351,9 @@ extern xbt_log_appender_t xbt_log_default_appender; # define CLOG6(c, p, f,a1,a2,a3,a4,a5,a6) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4,a5,a6 _XBT_LOG_POST # define CLOG7(c, p, f,a1,a2,a3,a4,a5,a6,a7) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4,a5,a6,a7 _XBT_LOG_POST # define CLOG8(c, p, f,a1,a2,a3,a4,a5,a6,a7,a8) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8 _XBT_LOG_POST +# define CLOG9(c, p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8,a9 _XBT_LOG_POST +# define CLOG10(c, p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10 _XBT_LOG_POST #endif - #define CDEBUG0(c, f) CLOG0(c, xbt_log_priority_debug, f) #define CDEBUG1(c, f,a1) CLOG1(c, xbt_log_priority_debug, f,a1) #define CDEBUG2(c, f,a1,a2) CLOG2(c, xbt_log_priority_debug, f,a1,a2) @@ -314,6 +363,24 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CDEBUG6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6) #define CDEBUG7(c, f,a1,a2,a3,a4,a5,a6,a7) CLOG7(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7) #define CDEBUG8(c, f,a1,a2,a3,a4,a5,a6,a7,a8) CLOG8(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8) +#define CDEBUG9(c, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) CLOG9(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) +/** @ingroup XBT_log + * @hideinitializer + * \param c the category on which to log + * \param f the format string + * \param a1 first argument of the format + * \param a2 second argument of the format + * \param a3 third argument of the format + * \param a4 fourth argument of the format + * \param a5 fifth argument of the format + * \param a6 sixth argument of the format + * \param a7 seventh argument of the format + * \param a8 eighth argument of the format + * \param a9 ninth argument of the format + * \param a10 tenth argument of the format + * @brief Log an event at the DEBUG priority on the specified category with these args (CDEBUGn exists for any n<10). + */ +#define CDEBUG10(c, f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) CLOG10(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) #define CVERB0(c, f) CLOG0(c, xbt_log_priority_verbose, f) #define CVERB1(c, f,a1) CLOG1(c, xbt_log_priority_verbose, f,a1) @@ -321,6 +388,10 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CVERB3(c, f,a1,a2,a3) CLOG3(c, xbt_log_priority_verbose, f,a1,a2,a3) #define CVERB4(c, f,a1,a2,a3,a4) CLOG4(c, xbt_log_priority_verbose, f,a1,a2,a3,a4) #define CVERB5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_verbose, f,a1,a2,a3,a4,a5) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the VERB priority on the specified category with these args (CVERBn exists for any n<6). + */ #define CVERB6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6) #define CINFO0(c, f) CLOG0(c, xbt_log_priority_info, f) @@ -330,6 +401,12 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CINFO4(c, f,a1,a2,a3,a4) CLOG4(c, xbt_log_priority_info, f,a1,a2,a3,a4) #define CINFO5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_info, f,a1,a2,a3,a4,a5) #define CINFO6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6) +#define CINFO7(c, f,a1,a2,a3,a4,a5,a6,a7) CLOG7(c, xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6,a7) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the INFO priority on the specified category with these args (CINFOn exists for any n<8). + */ +#define CINFO8(c, f,a1,a2,a3,a4,a5,a6,a7,a8) CLOG8(c, xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6,a7,a8) #define CWARN0(c, f) CLOG0(c, xbt_log_priority_warning, f) #define CWARN1(c, f,a1) CLOG1(c, xbt_log_priority_warning, f,a1) @@ -337,6 +414,10 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CWARN3(c, f,a1,a2,a3) CLOG3(c, xbt_log_priority_warning, f,a1,a2,a3) #define CWARN4(c, f,a1,a2,a3,a4) CLOG4(c, xbt_log_priority_warning, f,a1,a2,a3,a4) #define CWARN5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_warning, f,a1,a2,a3,a4,a5) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the WARN priority on the specified category with these args (CWARNn exists for any n<6). + */ #define CWARN6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6) #define CERROR0(c, f) CLOG0(c, xbt_log_priority_error, f) @@ -345,6 +426,10 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CERROR3(c, f,a1,a2,a3) CLOG3(c, xbt_log_priority_error, f,a1,a2,a3) #define CERROR4(c, f,a1,a2,a3,a4) CLOG4(c, xbt_log_priority_error, f,a1,a2,a3,a4) #define CERROR5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the ERROR priority on the specified category with these args (CERRORn exists for any n<6). + */ #define CERROR6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6) #define CCRITICAL0(c, f) CLOG0(c, xbt_log_priority_critical, f) @@ -353,6 +438,10 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CCRITICAL3(c, f,a1,a2,a3) CLOG3(c, xbt_log_priority_critical, f,a1,a2,a3) #define CCRITICAL4(c, f,a1,a2,a3,a4) CLOG4(c, xbt_log_priority_critical, f,a1,a2,a3,a4) #define CCRITICAL5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_critical, f,a1,a2,a3,a4,a5) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<6). + */ #define CCRITICAL6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6) #ifdef XBT_LOG_MAYDAY @@ -365,6 +454,8 @@ extern xbt_log_appender_t xbt_log_default_appender; # define LOG6(p, f,a1,a2,a3,a4,a5,a6) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6) # define LOG7(p, f,a1,a2,a3,a4,a5,a6,a7) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7) # define LOG8(p, f,a1,a2,a3,a4,a5,a6,a7,a8) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7,a8) +# define LOG9(p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7,a8,a9) +# define LOG10(p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) #else # define LOG0(p, f) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f _XBT_LOG_POST # define LOG1(p, f,a1) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1 _XBT_LOG_POST @@ -375,24 +466,10 @@ extern xbt_log_appender_t xbt_log_default_appender; # define LOG6(p, f,a1,a2,a3,a4,a5,a6) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5,a6 _XBT_LOG_POST # define LOG7(p, f,a1,a2,a3,a4,a5,a6,a7) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5,a6,a7 _XBT_LOG_POST # define LOG8(p, f,a1,a2,a3,a4,a5,a6,a7,a8) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8 _XBT_LOG_POST +# define LOG9(p, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8,a9 _XBT_LOG_POST +# define LOG10(p,f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10 _XBT_LOG_POST #endif -/** \name DEBUG - * \ingroup XBT_log - * Log something to the current default category under the debug priority. - * \param f the format string - * \param a1 first argument of the format - * \param a2 second argument of the format - * \param a3 third argument of the format - * \param a4 fourth argument of the format - * \param a5 fifth argument of the format - * \param a6 sixth argument of the format - * - * The macros DEBUG0 ... DEBUG5 naturally also exist, but are not listed here - * 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,11 +479,9 @@ 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 - * Log something to the current default category under the verbose priority. +#define DEBUG9(f,a1,a2,a3,a4,a5,a6,a7,a8,a9) LOG9(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8,a9) +/** @ingroup XBT_log + * @hideinitializer * \param f the format string * \param a1 first argument of the format * \param a2 second argument of the format @@ -414,37 +489,26 @@ extern xbt_log_appender_t xbt_log_default_appender; * \param a4 fourth argument of the format * \param a5 fifth argument of the format * \param a6 sixth argument of the format - * - * The macros VERB0 ... VERB5 naturally also exist, but are not listed here - * for sake of clarity. They just differ in the number of arguments passed - * along with the format string. + * \param a7 seventh argument of the format + * \param a8 eighth argument of the format + * \param a9 ninth argument of the format + * \param a10 tenth argument of the format + * @brief Log an event at the DEBUG priority on the default category with these args (DEBUGn exists for any n<10) */ -/* @{ */ +#define DEBUG10(f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) LOG10(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10) + #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) #define VERB3(f,a1,a2,a3) LOG3(xbt_log_priority_verbose, f,a1,a2,a3) #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) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the VERB priority on the default category with these args (VERBn exists for any n<6). + */ #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 - * Log something to the current default category under the info priority. - * \param f the format string - * \param a1 first argument of the format - * \param a2 second argument of the format - * \param a3 third argument of the format - * \param a4 fourth argument of the format - * \param a5 fifth argument of the format - * \param a6 sixth argument of the format - * - * The macros INFO0 ... INFO5 naturally also exist, but are not listed here - * 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,89 +516,73 @@ 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 - * Log something to the current default category under the warning priority. - * \param f the format string - * \param a1 first argument of the format - * \param a2 second argument of the format - * \param a3 third argument of the format - * \param a4 fourth argument of the format - * \param a5 fifth argument of the format - * \param a6 sixth argument of the format - * - * The macros WARN0 ... WARN5 naturally also exist, but are not listed here - * for sake of clarity. They just differ in the number of arguments passed - * along with the format string. +#define INFO7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6,a7) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the INFO priority on the default category with these args (INFOn exists for any n<8). */ -/* @{ */ +#define INFO8(f,a1,a2,a3,a4,a5,a6,a7,a8) LOG8(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6,a7,a8) + #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) #define WARN3(f,a1,a2,a3) LOG3(xbt_log_priority_warning, f,a1,a2,a3) #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) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the WARN priority on the default category with these args (WARNn exists for any n<6). + */ #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 - * Log something to the current default category under the error priority. - * \param f the format string - * \param a1 first argument of the format - * \param a2 second argument of the format - * \param a3 third argument of the format - * \param a4 fourth argument of the format - * \param a5 fifth argument of the format - * \param a6 sixth argument of the format - * - * The macros ERROR0 ... ERROR5 naturally also exist, but are not listed here - * 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) #define ERROR3(f,a1,a2,a3) LOG3(xbt_log_priority_error, f,a1,a2,a3) #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) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the ERROR priority on the default category with these args (ERRORn exists for any n<6). + */ #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 - * Log something to the current default category under the critical priority. - * \param f the format string - * \param a1 first argument of the format - * \param a2 second argument of the format - * \param a3 third argument of the format - * \param a4 fourth argument of the format - * \param a5 fifth argument of the format - * \param a6 sixth argument of the format - * - * The macros CRITICAL0 ... CRITICAL5 naturally also exist, but are not listed here - * 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) #define CRITICAL3(f,a1,a2,a3) LOG3(xbt_log_priority_critical, f,a1,a2,a3) #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) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log an event at the CRITICAL priority on the default category with these args (CRITICALn exists for any n<6). + */ #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) + +/** @ingroup XBT_log + * @hideinitializer + * @brief Log at TRACE priority that we entered in current 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) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log at TRACE priority that we entered in current function, appending a user specified format taking 5 args (XBT_INn exists for all n in [1,6]) + */ +#define XBT_IN5(fmt,a,b,c,d,e) LOG6(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c,d,e) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log at TRACE priority that we exited the current function. + */ +#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_FUNCTION) +/** @ingroup XBT_log + * @hideinitializer + * @brief Log at TRACE priority a message indicating that we reached that point. + */ #define XBT_HERE LOG0(xbt_log_priority_trace, "-- was here") +SG_END_DECL() #endif /* ! _XBT_LOG_H_ */