include/xbt/log.h

   1 /* $Id$ */
   2
   3 /* log - a generic logging facility in the spirit of log4j                  */
   4
   5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 /** @addtogroup XBT_log
  11  *  @brief A generic logging facility in the spirit of log4j (grounding feature)
  12  *
  13  *
  14  */
  15
  16 /** \defgroup XBT_log_cats Existing log categories
  17  *  \ingroup XBT_log
  18  *  \brief (automatically extracted)
  19  *
  20  *  This is the list of all existing log categories in SimGrid.
  21  *  This list was automatically extracted from the source code by
  22  *  the src/xbt_log_extract_hierarchy utility.
  23  *
  24  *  You can thus be certain that it is uptodate, but it may somehow
  25  *  lack a final manual touch.
  26  *  Anyway, nothing's perfect ;)
  27  */
  28
  29 /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
  30    printf function. Useful to debug the logging facilities themselves */
  31 #undef XBT_LOG_MAYDAY
  32 /*#define XBT_LOG_MAYDAY*/
  33
  34 #ifndef _XBT_LOG_H_
  35 #define _XBT_LOG_H_
  36
  37 #include "xbt/misc.h"
  38
  39 #include <stdarg.h>
  40 SG_BEGIN_DECL()
  41 /**\brief Log priorities
  42  * \ingroup XBT_log
  43  *
  44  * The different existing priorities.
  45 */
  46 typedef enum {
  47   xbt_log_priority_none          = 0,  /* used internally (don't poke with) */
  48   xbt_log_priority_trace         = 1,  /**< enter and return of some functions */
  49   xbt_log_priority_debug         = 2,  /**< crufty output  */
  50   xbt_log_priority_verbose       = 3,  /**< verbose output for the user wanting more */
  51   xbt_log_priority_info          = 4,  /**< output about the regular functionning */
  52   xbt_log_priority_warning       = 5,  /**< minor issue encountered */
  53   xbt_log_priority_error         = 6,  /**< issue encountered */
  54   xbt_log_priority_critical      = 7,  /**< major issue encountered */
  55
  56   xbt_log_priority_infinite      = 8,  /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
  57
  58   xbt_log_priority_uninitialized = -1  /* used internally (don't poke with) */
  59 } e_xbt_log_priority_t;
  60
  61
  62 /*
  63  * define NLOG to disable at compilation time any logging request
  64  * define NDEBUG to disable at compilation time any logging request of priority below INFO
  65  */
  66
  67
  68 /**
  69  * @def XBT_LOG_STATIC_THRESHOLD
  70  * @ingroup XBT_log
  71  *
  72  * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at
  73  * compile time, i.e., compiled out.
  74  */
  75 #ifdef NLOG
  76 #  define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_infinite
  77 #else
  78
  79 #  ifdef NDEBUG
  80 #    define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_verbose
  81 #  else /* !NLOG && !NDEBUG */
  82
  83 #    ifndef XBT_LOG_STATIC_THRESHOLD
  84 #      define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_none
  85 #    endif /* !XBT_LOG_STATIC_THRESHOLD */
  86 #  endif /* NDEBUG */
  87 #endif /* !defined(NLOG) */
  88
  89 /* Transforms a category name to a global variable name. */
  90 #define _XBT_LOGV(cat)   _XBT_LOG_CONCAT(_simgrid_this_log_category_does_not_exist__, cat)
  91 #define _XBT_LOG_CONCAT(x,y) x ## y
  92
  93 /* The root of the category hierarchy. */
  94 #define XBT_LOG_ROOT_CAT   root
  95
  96 /* XBT_LOG_NEW_SUBCATEGORY_helper:
  97  * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition
  98  * to avoid an extra declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by
  99  * XBT_LOG_NEW_CATEGORY */
 100 #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
 101     XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = {       \
 102         &_XBT_LOGV(parent), 0, 0,                    \
 103         #catName, xbt_log_priority_uninitialized, 1, \
 104         0, 1                                          \
 105     }
 106 /**
 107  * \ingroup XBT_log
 108  * \param catName name of new category
 109  * \param parent father of the new category in the tree
 110  * \param desc string describing the purpose of this category
 111  * \hideinitializer
 112  *
 113  * Defines a new subcategory of the parent.
 114  */
 115 #define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)    \
 116     extern s_xbt_log_category_t _XBT_LOGV(parent); \
 117     XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
 118
 119 /**
 120  * \ingroup XBT_log
 121  * \param catName name of new category
 122  * \param desc string describing the purpose of this category
 123  * \hideinitializer
 124  *
 125  * Creates a new subcategory of the root category.
 126  */
 127
 128 #if (defined(_WIN32) && !defined(DLL_STATIC))
 129 # define XBT_LOG_NEW_CATEGORY(catName,desc)  \
 130         XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = {       \
 131         0, 0, 0,                    \
 132                 #catName, xbt_log_priority_uninitialized, 1, \
 133         0, 1                                          \
 134     }
 135 #else
 136 # define XBT_LOG_NEW_CATEGORY(catName,desc)  XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
 137 #endif
 138
 139 /**
 140  * \ingroup XBT_log
 141  * \param cname name of the cat
 142  * \hideinitializer
 143  *
 144  * Indicates which category is the default one.
 145  */
 146
 147 #if defined(XBT_LOG_MAYDAY) /*|| defined (NLOG) * turning logging off */
 148 # define XBT_LOG_DEFAULT_CATEGORY(cname)
 149 #else
 150 # define XBT_LOG_DEFAULT_CATEGORY(cname) \
 151          static xbt_log_category_t _XBT_LOGV(default) _XBT_GNUC_UNUSED = &_XBT_LOGV(cname)
 152 #endif
 153
 154 /**
 155  * \ingroup XBT_log
 156  * \param cname name of the cat
 157  * \param desc string describing the purpose of this category
 158  * \hideinitializer
 159  *
 160  * Creates a new subcategory of the root category and makes it the default
 161  * (used by macros that don't explicitly specify a category).
 162  */
 163
 164 #if (defined(_WIN32) && !defined(DLL_STATIC))
 165 # define XBT_LOG_NEW_ROOT_SUBCATEGORY(cname,desc) \
 166         XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(cname) = {       \
 167         0, 0, 0,                    \
 168                 #cname, xbt_log_priority_uninitialized, 1, \
 169         0, 1                                          \
 170     }
 171
 172 # define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc)        \
 173         XBT_LOG_NEW_ROOT_SUBCATEGORY(cname,desc); \
 174         XBT_LOG_DEFAULT_CATEGORY(cname)
 175
 176 #else
 177 # define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc)        \
 178     XBT_LOG_NEW_CATEGORY(cname,desc);                   \
 179     XBT_LOG_DEFAULT_CATEGORY(cname)
 180 #endif
 181
 182
 183
 184 /**
 185  * \ingroup XBT_log
 186  * \param cname name of the cat
 187  * \param parent name of the parent
 188  * \param desc string describing the purpose of this category
 189  * \hideinitializer
 190  *
 191  * Creates a new subcategory of the parent category and makes it the default
 192  * (used by macros that don't explicitly specify a category).
 193  */
 194 #define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) \
 195     XBT_LOG_NEW_SUBCATEGORY(cname, parent, desc);            \
 196     XBT_LOG_DEFAULT_CATEGORY(cname)
 197
 198 /**
 199  * \ingroup XBT_log
 200  * \param cname name of the cat
 201  * \hideinitializer
 202  *
 203  * Indicates that a category you'll use in this file (to get subcategories of it,
 204  * for example) really lives in another file.
 205  */
 206
 207 #define XBT_LOG_EXTERNAL_CATEGORY(cname) \
 208    extern s_xbt_log_category_t _XBT_LOGV(cname)
 209
 210 /**
 211  * \ingroup XBT_log
 212  * \param cname name of the cat
 213  * \hideinitializer
 214  *
 215  * Indicates that the default category of this file was declared in another file.
 216  */
 217
 218 #define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname) \
 219    XBT_LOG_EXTERNAL_CATEGORY(cname);\
 220    XBT_LOG_DEFAULT_CATEGORY(cname)
 221
 222 /* Functions you may call */
 223
 224 XBT_PUBLIC(void) xbt_log_control_set(const char* cs);
 225
 226 /* Forward declarations */
 227 typedef struct xbt_log_appender_s s_xbt_log_appender_t,*xbt_log_appender_t;
 228 typedef struct xbt_log_layout_s   s_xbt_log_layout_t,  *xbt_log_layout_t;
 229 typedef struct xbt_log_event_s    s_xbt_log_event_t,   *xbt_log_event_t;
 230 typedef struct xbt_log_category_s s_xbt_log_category_t,*xbt_log_category_t;
 231
 232 /*
 233  * Do NOT access any members of this structure directly. FIXME: move to private?
 234  */
 235 struct xbt_log_category_s {
 236   xbt_log_category_t parent;
 237   xbt_log_category_t firstChild;
 238   xbt_log_category_t nextSibling;
 239   const char *name;
 240   int threshold;
 241   int isThreshInherited;
 242   xbt_log_appender_t appender;
 243   int additivity;
 244 };
 245
 246 struct xbt_log_appender_s {
 247   void (*do_append) (xbt_log_appender_t this_appender,
 248                      char *event);
 249   void (*free_) (xbt_log_appender_t this_);
 250   xbt_log_layout_t layout;
 251   void *data;
 252 };
 253
 254 struct xbt_log_layout_s {
 255   char *(*do_layout)(xbt_log_layout_t l,
 256                      xbt_log_event_t event, const char *fmt);
 257   void (*free_) (xbt_log_layout_t l);
 258   void *data;
 259 } ;
 260
 261 struct xbt_log_event_s {
 262   xbt_log_category_t cat;
 263   e_xbt_log_priority_t priority;
 264   const char* fileName;
 265   const char* functionName;
 266   int lineNum;
 267   va_list ap;
 268 };
 269
 270 /**
 271  * \ingroup XBT_log_implem
 272  * \param cat the category (not only its name, but the variable)
 273  * \param thresholdPriority the priority
 274  *
 275  * Programatically alters a category's threshold priority (don't use).
 276  */
 277 XBT_PUBLIC(void) xbt_log_threshold_set(xbt_log_category_t cat,
 278                                        e_xbt_log_priority_t thresholdPriority);
 279
 280 /**
 281  * \ingroup XBT_log_implem
 282  * \param cat the category (not only its name, but the variable)
 283  * \param parent the parent cat
 284  *
 285  * Programatically alter a category's parent (don't use).
 286  */
 287 XBT_PUBLIC(void) xbt_log_parent_set(xbt_log_category_t cat,
 288                                 xbt_log_category_t parent);
 289
 290 /**
 291  * \ingroup XBT_log_implem
 292  * \param cat the category (not only its name, but the variable)
 293  * \param app the appender
 294  *
 295  * Programatically sets the category's appender.
 296  * (the prefered interface is throught xbt_log_control_set())
 297  *
 298  */
 299 XBT_PUBLIC(void) xbt_log_appender_set(xbt_log_category_t cat,
 300                                       xbt_log_appender_t app);
 301
 302 /**
 303  * \ingroup XBT_log_implem
 304  * \param cat the category (not only its name, but the variable)
 305  * \param additivity whether logging actions must be passed to parent.
 306  *
 307  * Programatically sets whether the logging actions must be passed to
 308  * the parent category.
 309  * (the prefered interface is throught xbt_log_control_set())
 310  *
 311  */
 312 XBT_PUBLIC(void) xbt_log_additivity_set(xbt_log_category_t cat,
 313                                         int additivity);
 314
 315 /** @brief create a new simple layout
 316  *
 317  * This layout is not as flexible as the pattern one
 318  */
 319 XBT_PUBLIC(xbt_log_layout_t) xbt_log_layout_simple_new(void);
 320 XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender_file_new(xbt_log_layout_t layout);
 321
 322
 323 /* ********************************** */
 324 /* Functions that you shouldn't call  */
 325 /* ********************************** */
 326 XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev,
 327                                 const char *fmt,
 328                                 ...) _XBT_GNUC_PRINTF(2,3);
 329
 330 XBT_PUBLIC(int) _xbt_log_cat_init(xbt_log_category_t   category,
 331                                   e_xbt_log_priority_t priority);
 332
 333
 334 extern XBT_IMPORT_NO_EXPORT(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT);
 335
 336 XBT_LOG_EXTERNAL_CATEGORY(GRAS);
 337
 338 extern xbt_log_appender_t xbt_log_default_appender;
 339
 340 /* ********************** */
 341 /* Public functions again */
 342 /* ********************** */
 343
 344 /**
 345  * \ingroup XBT_log
 346  * \param catName name of the category
 347  * \param priority minimal priority to be enabled to return true
 348  * \hideinitializer
 349  *
 350  * Returns true if the given priority is enabled for the category.
 351  * If you have expensive expressions that are computed outside of the log
 352  * command and used only within it, you should make its evaluation conditional
 353  * using this macro.
 354  */
 355 #define XBT_LOG_ISENABLED(catName, priority) \
 356             _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
 357
 358 /*
 359  * Helper function that implements XBT_LOG_ISENABLED.
 360  *
 361  * NOTES
 362  * First part is a compile-time constant.
 363  * Call to _log_initCat only happens once.
 364  */
 365 #define _XBT_LOG_ISENABLEDV(catv, priority)                  \
 366        (priority >= XBT_LOG_STATIC_THRESHOLD                 \
 367         && priority >= catv.threshold                         \
 368         && (catv.threshold != xbt_log_priority_uninitialized \
 369             || _xbt_log_cat_init(&catv, priority)) )
 370
 371 /*
 372  * Internal Macros
 373  * Some kludge macros to ease maintenance. See how they're used below.
 374  *
 375  * IMPLEMENTATION NOTE: To reduce the parameter passing overhead of an enabled
 376  * message, the many parameters passed to the logging function are packed in a
 377  * structure. Since these values will be usually be passed to at least 3
 378  * functions, this is a win.
 379  * It also allows adding new values (such as a timestamp) without breaking
 380  * code.
 381  * Setting the LogEvent's valist member is done inside _log_logEvent.
 382  */
 383
 384 #define _XBT_LOG_PRE(catv, priority) do {                        \
 385      if (_XBT_LOG_ISENABLEDV(catv, priority)) {                  \
 386          s_xbt_log_event_t _log_ev =                             \
 387              {NULL,priority,__FILE__,_XBT_FUNCTION,__LINE__};    \
 388                 _log_ev.cat = &(catv);                           \
 389               _xbt_log_event_log(&_log_ev                        \
 390
 391
 392 #define _XBT_LOG_POST                          \
 393                         );                      \
 394      } } while(0)
 395
 396
 397 /* Logging Macros */
 398
 399 #ifdef XBT_LOG_MAYDAY
 400 # define CLOG0(c, p, f)                   fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__)
 401 # define CLOG1(c, p, f,a1)                fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1)
 402 # define CLOG2(c, p, f,a1,a2)             fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2)
 403 # define CLOG3(c, p, f,a1,a2,a3)          fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3)
 404 # define CLOG4(c, p, f,a1,a2,a3,a4)       fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4)
 405 # define CLOG5(c, p, f,a1,a2,a3,a4,a5)    fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5)
 406 # 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)
 407 # 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)
 408 # 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)
 409 # 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)
 410 # 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)
 411 #else
 412 # define CLOG0(c, p, f)                   _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f _XBT_LOG_POST
 413 # define CLOG1(c, p, f,a1)                _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1 _XBT_LOG_POST
 414 # define CLOG2(c, p, f,a1,a2)             _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2 _XBT_LOG_POST
 415 # define CLOG3(c, p, f,a1,a2,a3)          _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3 _XBT_LOG_POST
 416 # define CLOG4(c, p, f,a1,a2,a3,a4)       _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4 _XBT_LOG_POST
 417 # define CLOG5(c, p, f,a1,a2,a3,a4,a5)    _XBT_LOG_PRE(_XBT_LOGV(c),p) ,f,a1,a2,a3,a4,a5 _XBT_LOG_POST
 418 # 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
 419 # 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
 420 # 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
 421 # 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
 422 # 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
 423 #endif
 424 #define CDEBUG0(c, f)                   CLOG0(c, xbt_log_priority_debug, f)
 425 #define CDEBUG1(c, f,a1)                CLOG1(c, xbt_log_priority_debug, f,a1)
 426 #define CDEBUG2(c, f,a1,a2)             CLOG2(c, xbt_log_priority_debug, f,a1,a2)
 427 #define CDEBUG3(c, f,a1,a2,a3)          CLOG3(c, xbt_log_priority_debug, f,a1,a2,a3)
 428 #define CDEBUG4(c, f,a1,a2,a3,a4)       CLOG4(c, xbt_log_priority_debug, f,a1,a2,a3,a4)
 429 #define CDEBUG5(c, f,a1,a2,a3,a4,a5)    CLOG5(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5)
 430 #define CDEBUG6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6)
 431 #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)
 432 #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)
 433 #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)
 434 /** @ingroup XBT_log
 435  *  @hideinitializer
 436  * \param c the category on which to log
 437  * \param f the format string
 438  * \param a1 first argument of the format
 439  * \param a2 second argument of the format
 440  * \param a3 third argument of the format
 441  * \param a4 fourth argument of the format
 442  * \param a5 fifth argument of the format
 443  * \param a6 sixth argument of the format
 444  * \param a7 seventh argument of the format
 445  * \param a8 eighth argument of the format
 446  * \param a9 ninth argument of the format
 447  * \param a10 tenth argument of the format
 448  *  @brief Log an event at the DEBUG priority on the specified category with these args (CDEBUGn exists for any n<10).
 449  */
 450 #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)
 451
 452 #define CVERB0(c, f)                   CLOG0(c, xbt_log_priority_verbose, f)
 453 #define CVERB1(c, f,a1)                CLOG1(c, xbt_log_priority_verbose, f,a1)
 454 #define CVERB2(c, f,a1,a2)             CLOG2(c, xbt_log_priority_verbose, f,a1,a2)
 455 #define CVERB3(c, f,a1,a2,a3)          CLOG3(c, xbt_log_priority_verbose, f,a1,a2,a3)
 456 #define CVERB4(c, f,a1,a2,a3,a4)       CLOG4(c, xbt_log_priority_verbose, f,a1,a2,a3,a4)
 457 #define CVERB5(c, f,a1,a2,a3,a4,a5)    CLOG5(c, xbt_log_priority_verbose, f,a1,a2,a3,a4,a5)
 458 /** @ingroup XBT_log
 459  *  @hideinitializer
 460  *  @brief Log an event at the VERB priority on the specified category with these args (CVERBn exists for any n<6).
 461  */
 462 #define CVERB6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6)
 463
 464 #define CINFO0(c, f)                   CLOG0(c, xbt_log_priority_info, f)
 465 #define CINFO1(c, f,a1)                CLOG1(c, xbt_log_priority_info, f,a1)
 466 #define CINFO2(c, f,a1,a2)             CLOG2(c, xbt_log_priority_info, f,a1,a2)
 467 #define CINFO3(c, f,a1,a2,a3)          CLOG3(c, xbt_log_priority_info, f,a1,a2,a3)
 468 #define CINFO4(c, f,a1,a2,a3,a4)       CLOG4(c, xbt_log_priority_info, f,a1,a2,a3,a4)
 469 #define CINFO5(c, f,a1,a2,a3,a4,a5)    CLOG5(c, xbt_log_priority_info, f,a1,a2,a3,a4,a5)
 470 #define CINFO6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6)
 471 #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)
 472 /** @ingroup XBT_log
 473  *  @hideinitializer
 474  *  @brief Log an event at the INFO priority on the specified category with these args (CINFOn exists for any n<8).
 475  */
 476 #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)
 477
 478 #define CWARN0(c, f)                   CLOG0(c, xbt_log_priority_warning, f)
 479 #define CWARN1(c, f,a1)                CLOG1(c, xbt_log_priority_warning, f,a1)
 480 #define CWARN2(c, f,a1,a2)             CLOG2(c, xbt_log_priority_warning, f,a1,a2)
 481 #define CWARN3(c, f,a1,a2,a3)          CLOG3(c, xbt_log_priority_warning, f,a1,a2,a3)
 482 #define CWARN4(c, f,a1,a2,a3,a4)       CLOG4(c, xbt_log_priority_warning, f,a1,a2,a3,a4)
 483 #define CWARN5(c, f,a1,a2,a3,a4,a5)    CLOG5(c, xbt_log_priority_warning, f,a1,a2,a3,a4,a5)
 484 /** @ingroup XBT_log
 485  *  @hideinitializer
 486  *  @brief Log an event at the WARN priority on the specified category with these args (CWARNn exists for any n<6).
 487  */
 488 #define CWARN6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6)
 489
 490 #define CERROR0(c, f)                   CLOG0(c, xbt_log_priority_error, f)
 491 #define CERROR1(c, f,a1)                CLOG1(c, xbt_log_priority_error, f,a1)
 492 #define CERROR2(c, f,a1,a2)             CLOG2(c, xbt_log_priority_error, f,a1,a2)
 493 #define CERROR3(c, f,a1,a2,a3)          CLOG3(c, xbt_log_priority_error, f,a1,a2,a3)
 494 #define CERROR4(c, f,a1,a2,a3,a4)       CLOG4(c, xbt_log_priority_error, f,a1,a2,a3,a4)
 495 #define CERROR5(c, f,a1,a2,a3,a4,a5)    CLOG5(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5)
 496 /** @ingroup XBT_log
 497  *  @hideinitializer
 498  *  @brief Log an event at the ERROR priority on the specified category with these args (CERRORn exists for any n<6).
 499  */
 500 #define CERROR6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6)
 501
 502 #define CCRITICAL0(c, f)                   CLOG0(c, xbt_log_priority_critical, f)
 503 #define CCRITICAL1(c, f,a1)                CLOG1(c, xbt_log_priority_critical, f,a1)
 504 #define CCRITICAL2(c, f,a1,a2)             CLOG2(c, xbt_log_priority_critical, f,a1,a2)
 505 #define CCRITICAL3(c, f,a1,a2,a3)          CLOG3(c, xbt_log_priority_critical, f,a1,a2,a3)
 506 #define CCRITICAL4(c, f,a1,a2,a3,a4)       CLOG4(c, xbt_log_priority_critical, f,a1,a2,a3,a4)
 507 #define CCRITICAL5(c, f,a1,a2,a3,a4,a5)    CLOG5(c, xbt_log_priority_critical, f,a1,a2,a3,a4,a5)
 508 /** @ingroup XBT_log
 509  *  @hideinitializer
 510  *  @brief Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<6).
 511  */
 512 #define CCRITICAL6(c, f,a1,a2,a3,a4,a5,a6) CLOG6(c, xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6)
 513
 514 #ifdef XBT_LOG_MAYDAY
 515 # define LOG0(p, f)                   fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__)
 516 # define LOG1(p, f,a1)                fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1)
 517 # define LOG2(p, f,a1,a2)             fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2)
 518 # define LOG3(p, f,a1,a2,a3)          fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3)
 519 # define LOG4(p, f,a1,a2,a3,a4)       fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4)
 520 # define LOG5(p, f,a1,a2,a3,a4,a5)    fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5)
 521 # define LOG6(p, f,a1,a2,a3,a4,a5,a6) fprintf(stderr,"%s:%d:" f "\n",__FILE__,__LINE__,a1,a2,a3,a4,a5,a6)
 522 # 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)
 523 # 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)
 524 # 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)
 525 # 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)
 526 #else
 527 # define LOG0(p, f)                   _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f _XBT_LOG_POST
 528 # define LOG1(p, f,a1)                _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1 _XBT_LOG_POST
 529 # define LOG2(p, f,a1,a2)             _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2 _XBT_LOG_POST
 530 # define LOG3(p, f,a1,a2,a3)          _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3 _XBT_LOG_POST
 531 # define LOG4(p, f,a1,a2,a3,a4)       _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4 _XBT_LOG_POST
 532 # define LOG5(p, f,a1,a2,a3,a4,a5)    _XBT_LOG_PRE((*_XBT_LOGV(default)),p) ,f,a1,a2,a3,a4,a5 _XBT_LOG_POST
 533 # 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
 534 # 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
 535 # 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
 536 # 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
 537 # 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
 538 #endif
 539
 540 #define DEBUG0(f)                   LOG0(xbt_log_priority_debug, f)
 541 #define DEBUG1(f,a1)                LOG1(xbt_log_priority_debug, f,a1)
 542 #define DEBUG2(f,a1,a2)             LOG2(xbt_log_priority_debug, f,a1,a2)
 543 #define DEBUG3(f,a1,a2,a3)          LOG3(xbt_log_priority_debug, f,a1,a2,a3)
 544 #define DEBUG4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_debug, f,a1,a2,a3,a4)
 545 #define DEBUG5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_debug, f,a1,a2,a3,a4,a5)
 546 #define DEBUG6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6)
 547 #define DEBUG7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7)
 548 #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)
 549 #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)
 550 /** @ingroup XBT_log
 551  *  @hideinitializer
 552  * \param f the format string
 553  * \param a1 first argument of the format
 554  * \param a2 second argument of the format
 555  * \param a3 third argument of the format
 556  * \param a4 fourth argument of the format
 557  * \param a5 fifth argument of the format
 558  * \param a6 sixth argument of the format
 559  * \param a7 seventh argument of the format
 560  * \param a8 eighth argument of the format
 561  * \param a9 ninth argument of the format
 562  * \param a10 tenth argument of the format
 563  *  @brief Log an event at the DEBUG priority on the default category with these args (DEBUGn exists for any n<10)
 564  */
 565 #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)
 566
 567 #define VERB0(f)                   LOG0(xbt_log_priority_verbose, f)
 568 #define VERB1(f,a1)                LOG1(xbt_log_priority_verbose, f,a1)
 569 #define VERB2(f,a1,a2)             LOG2(xbt_log_priority_verbose, f,a1,a2)
 570 #define VERB3(f,a1,a2,a3)          LOG3(xbt_log_priority_verbose, f,a1,a2,a3)
 571 #define VERB4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_verbose, f,a1,a2,a3,a4)
 572 #define VERB5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5)
 573 /** @ingroup XBT_log
 574  *  @hideinitializer
 575  *  @brief Log an event at the VERB priority on the default category with these args (VERBn exists for any n<6).
 576  */
 577 #define VERB6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6)
 578
 579 #define INFO0(f)                   LOG0(xbt_log_priority_info, f)
 580 #define INFO1(f,a1)                LOG1(xbt_log_priority_info, f,a1)
 581 #define INFO2(f,a1,a2)             LOG2(xbt_log_priority_info, f,a1,a2)
 582 #define INFO3(f,a1,a2,a3)          LOG3(xbt_log_priority_info, f,a1,a2,a3)
 583 #define INFO4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_info, f,a1,a2,a3,a4)
 584 #define INFO5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_info, f,a1,a2,a3,a4,a5)
 585 #define INFO6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6)
 586 #define INFO7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6,a7)
 587 /** @ingroup XBT_log
 588  *  @hideinitializer
 589  *  @brief Log an event at the INFO priority on the default category with these args (INFOn exists for any n<8).
 590  */
 591 #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)
 592
 593 #define WARN0(f)                   LOG0(xbt_log_priority_warning, f)
 594 #define WARN1(f,a1)                LOG1(xbt_log_priority_warning, f,a1)
 595 #define WARN2(f,a1,a2)             LOG2(xbt_log_priority_warning, f,a1,a2)
 596 #define WARN3(f,a1,a2,a3)          LOG3(xbt_log_priority_warning, f,a1,a2,a3)
 597 #define WARN4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_warning, f,a1,a2,a3,a4)
 598 #define WARN5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_warning, f,a1,a2,a3,a4,a5)
 599 /** @ingroup XBT_log
 600  *  @hideinitializer
 601  *  @brief Log an event at the WARN priority on the default category with these args (WARNn exists for any n<6).
 602  */
 603 #define WARN6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6)
 604
 605 #define ERROR0(f)                   LOG0(xbt_log_priority_error, f)
 606 #define ERROR1(f,a1)                LOG1(xbt_log_priority_error, f,a1)
 607 #define ERROR2(f,a1,a2)             LOG2(xbt_log_priority_error, f,a1,a2)
 608 #define ERROR3(f,a1,a2,a3)          LOG3(xbt_log_priority_error, f,a1,a2,a3)
 609 #define ERROR4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_error, f,a1,a2,a3,a4)
 610 #define ERROR5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_error, f,a1,a2,a3,a4,a5)
 611 /** @ingroup XBT_log
 612  *  @hideinitializer
 613  *  @brief Log an event at the ERROR priority on the default category with these args (ERRORn exists for any n<6).
 614  */
 615 #define ERROR6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6)
 616
 617 #define CRITICAL0(f)                   LOG0(xbt_log_priority_critical, f)
 618 #define CRITICAL1(f,a1)                LOG1(xbt_log_priority_critical, f,a1)
 619 #define CRITICAL2(f,a1,a2)             LOG2(xbt_log_priority_critical, f,a1,a2)
 620 #define CRITICAL3(f,a1,a2,a3)          LOG3(xbt_log_priority_critical, f,a1,a2,a3)
 621 #define CRITICAL4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_critical, f,a1,a2,a3,a4)
 622 #define CRITICAL5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_critical, f,a1,a2,a3,a4,a5)
 623 /** @ingroup XBT_log
 624  *  @hideinitializer
 625  *  @brief Log an event at the CRITICAL priority on the default category with these args (CRITICALn exists for any n<6).
 626  */
 627 #define CRITICAL6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6)
 628
 629 /** @ingroup XBT_log
 630  *  @hideinitializer
 631  *  @brief Log at TRACE priority that we entered in current function.
 632  */
 633 #define XBT_IN               LOG1(xbt_log_priority_trace, ">> begin of %s",     _XBT_FUNCTION)
 634 #define XBT_IN1(fmt,a)       LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a)
 635 #define XBT_IN2(fmt,a,b)     LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b)
 636 #define XBT_IN3(fmt,a,b,c)   LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c)
 637 #define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c,d)
 638 /** @ingroup XBT_log
 639  *  @hideinitializer
 640  *  @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])
 641  */
 642 #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)
 643 /** @ingroup XBT_log
 644  *  @hideinitializer
 645  *  @brief Log at TRACE priority that we exited the current function.
 646  */
 647 #define XBT_OUT              LOG1(xbt_log_priority_trace, "<< end of %s",       _XBT_FUNCTION)
 648 /** @ingroup XBT_log
 649  *  @hideinitializer
 650  *  @brief Log at TRACE priority a message indicating that we reached that point.
 651  */
 652 #define XBT_HERE             LOG0(xbt_log_priority_trace, "-- was here")
 653
 654
 655 SG_END_DECL()
 656
 657 #endif /* ! _XBT_LOG_H_ */