X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8c354c48ec90c997cc7213ce96ca97d882934166..cfc534f877804bee49c17b392d6c1c54a82257ae:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index 35b233ad41..a5ce65c7e8 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -2,11 +2,30 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004 Martin Quinson. All rights reserved. */ +/* Copyright (c) 2003, 2004 Martin Quinson. 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. */ +/** @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,51 +34,42 @@ #ifndef _XBT_LOG_H_ #define _XBT_LOG_H_ -#include - -#include "xbt/sysdep.h" +#include "xbt/misc.h" -/** - * e_xbt_log_priority_t: - * @xbt_log_priority_none: used internally (don't poke with) - * @xbt_log_priority_debug: crufty output - * @xbt_log_priority_verbose: verbose output for the user wanting more - * @xbt_log_priority_info: output about the regular functionning - * @xbt_log_priority_warning: minor issue encountered - * @xbt_log_priority_error: issue encountered - * @xbt_log_priority_critical: major issue encountered - * @xbt_log_priority_infinite: value for XBT_LOG_STATIC_THRESHOLD to not log - * @xbt_log_priority_uninitialized: used internally (don't poke with) +#include +SG_BEGIN_DECL() +/**\brief Log priorities + * \ingroup XBT_log * * The different existing priorities. - */ +*/ typedef enum { - xbt_log_priority_none = 0, - xbt_log_priority_trace = 1, - xbt_log_priority_debug = 2, - xbt_log_priority_verbose = 3, - xbt_log_priority_info = 4, - xbt_log_priority_warning = 5, - xbt_log_priority_error = 6, - xbt_log_priority_critical = 7, - - xbt_log_priority_infinite = 8, - - xbt_log_priority_uninitialized = -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 */ + xbt_log_priority_warning = 5, /**< minor issue encountered */ + xbt_log_priority_error = 6, /**< issue encountered */ + xbt_log_priority_critical = 7, /**< major issue encountered */ + + 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) */ } e_xbt_log_priority_t; -/** - * NLOG: - * - * All logging facilities are disabled at compilation time +/* + * define NLOG to disable at compilation time any logging request + * define NDEBUG to disable at compilation time any logging request of priority below INFO */ /** - * XBT_LOG_STATIC_THRESHOLD: + * @def XBT_LOG_STATIC_THRESHOLD + * @ingroup XBT_log * - * All logging with priority < XBT_LOG_STATIC_THRESHOLD is disabled at + * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at * compile time, i.e., compiled out. */ #ifdef NLOG @@ -83,34 +93,43 @@ typedef enum { /* The root of the category hierarchy. */ #define XBT_LOG_ROOT_CAT root -/** - * XBT_LOG_NEW_SUBCATEGORY: - * @catName: name of new category - * @parent: father of the new category in the tree - * @desc: string describing the purpose of this category - * - * Defines a new subcategory of the parent. - */ -#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ - extern s_xbt_log_category_t _XBT_LOGV(parent); \ +/* 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); \ + XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ /** - * XBT_LOG_NEW_CATEGORY: - * @catName: name of new category - * @desc: string describing the purpose of this category + * \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) /** - * XBT_LOG_DEFAULT_CATEGORY: - * @cname: name of the cat + * \ingroup XBT_log + * \param cname name of the cat + * \hideinitializer * * Indicates which category is the default one. */ @@ -119,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 /** - * XBT_LOG_NEW_DEFAULT_CATEGORY: - * @cname: name of the cat - * @desc: string describing the purpose of this category + * \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). @@ -135,10 +155,11 @@ typedef enum { XBT_LOG_DEFAULT_CATEGORY(cname) /** - * XBT_LOG_NEW_DEFAULT_SUBCATEGORY: - * @cname: name of the cat - * @parent: name of the parent - * @desc: string describing the purpose of this category + * \ingroup XBT_log + * \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). @@ -148,8 +169,9 @@ typedef enum { XBT_LOG_DEFAULT_CATEGORY(cname) /** - * XBT_LOG_EXTERNAL_CATEGORY: - * @cname: name of the cat + * \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. @@ -158,6 +180,18 @@ 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); @@ -167,7 +201,7 @@ typedef struct xbt_log_appender_s s_xbt_log_appender_t,*xbt_log_appender_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; -/** +/* * Do NOT access any members of this structure directly. FIXME: move to private? */ struct xbt_log_category_s { @@ -198,9 +232,9 @@ struct xbt_log_event_s { }; /** - * xbt_log_threshold_set: - * @cat: the category (not only its name, but the variable) - * @thresholdPriority: the priority + * \ingroup XBT_log_implem + * \param cat the category (not only its name, but the variable) + * \param thresholdPriority the priority * * Programatically alters a category's threshold priority (don't use). */ @@ -208,9 +242,9 @@ extern void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); /** - * xbt_log_parent_set: - * @cat: the category (not only its name, but the variable) - * @parent: the parent cat + * \ingroup XBT_log_implem + * \param cat the category (not only its name, but the variable) + * \param parent the parent cat * * Programatically alter a category's parent (don't use). */ @@ -218,9 +252,9 @@ extern void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent); /** - * xbt_log_appender_set: - * @cat: the category (not only its name, but the variable) - * @app: the appender + * \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 (don't use). */ @@ -241,9 +275,10 @@ XBT_LOG_EXTERNAL_CATEGORY(GRAS); extern xbt_log_appender_t xbt_log_default_appender; /** - * XBT_LOG_ISENABLED: - * @catName: name of the category - * @priority: minimal priority to be enabled to return true + * \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 @@ -282,7 +317,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 \ @@ -302,6 +337,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 @@ -312,6 +349,8 @@ 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) @@ -323,6 +362,8 @@ 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) +#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) @@ -339,6 +380,8 @@ 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) +#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) @@ -356,24 +399,6 @@ extern xbt_log_appender_t xbt_log_default_appender; #define CERROR5(c, f,a1,a2,a3,a4,a5) CLOG5(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5) #define CERROR6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6) -/** - * CCRITICAL6: - * @c: the category to log into - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * - * Log something to the current default category under the warning priority. - * - * The macros CCRITICAL0 ... CCRITICAL5 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 CCRITICAL0(c, f) CLOG0(c, xbt_log_priority_critical, f) #define CCRITICAL1(c, f,a1) CLOG1(c, xbt_log_priority_critical, f,a1) #define CCRITICAL2(c, f,a1,a2) CLOG2(c, xbt_log_priority_critical, f,a1,a2) @@ -392,6 +417,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 @@ -402,25 +429,26 @@ 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 -/** - * DEBUG6: - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * +/** \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) @@ -430,24 +458,26 @@ 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) +#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) +#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) +/* @} */ -/** - * VERB6: - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * +/** \name VERB + * \ingroup XBT_log * Log something to the current default category under the verbose 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 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. */ - +/* @{ */ #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) @@ -455,24 +485,24 @@ 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) +/* @} */ -/** - * INFO6: - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * +/** \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) @@ -480,24 +510,26 @@ 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) +#define INFO7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6,a7) +#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) +/* @} */ -/** - * WARN6: - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * +/** \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 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) @@ -505,24 +537,24 @@ 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) +/* @} */ -/** - * ERROR6: - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * +/** \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) @@ -530,23 +562,24 @@ 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) +/* @} */ -/** - * CRITICAL6: - * @f: the format string - * @a1: first argument of the format - * @a2: second argument of the format - * @a3: third argument of the format - * @a4: fourth argument of the format - * @a5: fifth argument of the format - * @a6: sixth argument of the format - * +/** \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) @@ -554,12 +587,16 @@ 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_IN5(fmt,a,b,c,d,e) LOG6(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c,d,e) +#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_FUNCTION) +#define XBT_HERE LOG0(xbt_log_priority_trace, "-- was here") +SG_END_DECL() #endif /* ! _XBT_LOG_H_ */