include/xbt/log.h

   1 /* log - a generic logging facility in the spirit of log4j                  */
   2
   3 /* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 /** @addtogroup XBT_log
   9  *  @brief A generic logging facility in the spirit of log4j (grounding feature)
  10  *
  11  */
  12
  13 /** @defgroup XBT_log_cats Existing log categories
  14  *  @ingroup XBT_log
  15  *  @brief (automatically extracted)
  16  *
  17  *  This is the list of all existing log categories in SimGrid.
  18  *  This list is automatically extracted from the source code by the tools/doxygen/xbt_log_extract_hierarchy.pl utility.
  19  *
  20  *  It should thus contain every categories that are defined in the SimGrid library.
  21  *  If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your
  22  * simulator.
  23  */
  24
  25 /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
  26    printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */
  27 //#define XBT_LOG_MAYDAY
  28
  29 #ifndef XBT_LOG_H
  30 #define XBT_LOG_H
  31
  32 #include <stdarg.h>
  33 #include <stddef.h> /* NULL */
  34 #include <stdio.h>  /* FILE */
  35 #include <xbt/misc.h>
  36 SG_BEGIN_DECL()
  37 /**@brief Log priorities
  38  * @ingroup XBT_log
  39  *
  40  * The different existing priorities.
  41  */
  42 typedef enum {
  43   //! @cond
  44   xbt_log_priority_none = 0,           /** used internally (don't poke with)*/
  45   //! @endcond
  46   xbt_log_priority_trace = 1,          /**< enter and return of some functions */
  47   xbt_log_priority_debug = 2,          /**< crufty output  */
  48   xbt_log_priority_verbose = 3,        /**< verbose output for the user wanting more */
  49   xbt_log_priority_info = 4,           /**< output about the regular functionning */
  50   xbt_log_priority_warning = 5,        /**< minor issue encountered */
  51   xbt_log_priority_error = 6,          /**< issue encountered */
  52   xbt_log_priority_critical = 7,       /**< major issue encountered */
  53
  54   xbt_log_priority_infinite = 8,       /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
  55
  56   //! @cond
  57   xbt_log_priority_uninitialized = -1  /* used internally (don't poke with) */
  58   //! @endcond
  59 } e_xbt_log_priority_t;
  60
  61 /*
  62  * define NLOG to disable at compilation time any logging request
  63  * define NDEBUG to disable at compilation time any logging request of priority below VERBOSE
  64  */
  65
  66 /**
  67  * @def XBT_LOG_STATIC_THRESHOLD
  68  * @ingroup XBT_log
  69  *
  70  * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out.
  71  */
  72 #ifdef NLOG
  73 #  define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_infinite
  74 #else
  75
  76 #  ifdef NDEBUG
  77 #    define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_verbose
  78 #  else                         /* !NLOG && !NDEBUG */
  79
  80 #    ifndef XBT_LOG_STATIC_THRESHOLD
  81 #      define XBT_LOG_STATIC_THRESHOLD xbt_log_priority_none
  82 #    endif                      /* !XBT_LOG_STATIC_THRESHOLD */
  83 #  endif                        /* NDEBUG */
  84 #endif                          /* !defined(NLOG) */
  85
  86 /* Transforms a category name to a global variable name. */
  87 #define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_simgrid_log_category__, cat)
  88 #define _XBT_LOGV_CTOR(cat) _XBT_LOG_CONCAT2(_XBT_LOGV(cat), __constructor__)
  89 #define _XBT_LOG_CONCAT(x, y) x ## y
  90 #define _XBT_LOG_CONCAT2(x, y) _XBT_LOG_CONCAT(x, y)
  91
  92 /* The root of the category hierarchy. */
  93 #define XBT_LOG_ROOT_CAT   root
  94
  95 /* The whole tree of categories is connected by setting the address of the parent category as a field of the child one.
  96  * This is normally done at the first use of the category.
  97  *
  98  * It is however necessary to make this connections as early as possible, if we want the category to be listed by
  99  * --help-log-categories. We use constructor attributes for these initializations to take place automatically before the
 100  * start of main().
 101  */
 102
 103 /* XBT_LOG_NEW_SUBCATEGORY_helper:
 104  * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition to avoid an extra
 105  * declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by XBT_LOG_NEW_CATEGORY */
 106 #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc)                                                          \
 107   SG_BEGIN_DECL()                                                                                                      \
 108   extern void _XBT_LOGV_CTOR(catName)(void) XBT_ATTRIB_CONSTRUCTOR(600);                                               \
 109   void _XBT_LOGV_CTOR(catName)(void)                                                                                   \
 110   {                                                                                                                    \
 111     XBT_LOG_EXTERNAL_CATEGORY(catName);                                                                                \
 112     if (!_XBT_LOGV(catName).initialized) {                                                                             \
 113       _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized);                                          \
 114     }                                                                                                                  \
 115   }                                                                                                                    \
 116   SG_END_DECL()                                                                                                        \
 117   XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = {                                                     \
 118       &_XBT_LOGV(parent),                                                                                              \
 119       NULL /* firstChild */,                                                                                           \
 120       NULL /* nextSibling */,                                                                                          \
 121       #catName,                                                                                                        \
 122       desc,                                                                                                            \
 123       0 /*initialized */,                                                                                              \
 124       xbt_log_priority_uninitialized /* threshold */,                                                                  \
 125       1 /* isThreshInherited */,                                                                                       \
 126       NULL /* appender */,                                                                                             \
 127       NULL /* layout */,                                                                                               \
 128       1 /* additivity */                                                                                               \
 129   }
 130
 131 /**
 132  * @ingroup XBT_log
 133  * @param catName name of new category
 134  * @param parent father of the new category in the tree
 135  * @param desc string describing the purpose of this category
 136  * @hideinitializer
 137  *
 138  * Defines a new subcategory of the parent.
 139  */
 140 #define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)    \
 141   XBT_LOG_EXTERNAL_CATEGORY(parent);                      \
 142   XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc)
 143
 144 /**
 145  * @ingroup XBT_log
 146  * @param catName name of new category
 147  * @param desc string describing the purpose of this category
 148  * @hideinitializer
 149  *
 150  * Creates a new subcategory of the root category.
 151  */
 152 # define XBT_LOG_NEW_CATEGORY(catName,desc)  \
 153    XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
 154
 155 /**
 156  * @ingroup XBT_log
 157  * @param cname name of the cat
 158  * @hideinitializer
 159  *
 160  * Indicates which category is the default one.
 161  */
 162
 163 #if defined(XBT_LOG_MAYDAY) /*|| defined (NLOG) * turning logging off */
 164 # define XBT_LOG_DEFAULT_CATEGORY(cname)
 165 #else
 166 #define XBT_LOG_DEFAULT_CATEGORY(cname)                                                                                \
 167   XBT_ATTRIB_UNUSED static xbt_log_category_t _XBT_LOGV(default) = &_XBT_LOGV(cname)
 168 #endif
 169
 170 /**
 171  * @ingroup XBT_log
 172  * @param cname name of the cat
 173  * @param desc string describing the purpose of this category
 174  * @hideinitializer
 175  *
 176  * Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly
 177  * specify a category).
 178  */
 179 # define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc)        \
 180     XBT_LOG_NEW_CATEGORY(cname,desc);                   \
 181     XBT_LOG_DEFAULT_CATEGORY(cname)
 182
 183 /**
 184  * @ingroup XBT_log
 185  * @param cname name of the cat
 186  * @param parent name of the parent
 187  * @param desc string describing the purpose of this category
 188  * @hideinitializer
 189  *
 190  * Creates a new subcategory of the parent category and makes it the default
 191  * (used by macros that don't explicitly specify a category).
 192  */
 193 #define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) \
 194     XBT_LOG_NEW_SUBCATEGORY(cname, parent, desc);            \
 195     XBT_LOG_DEFAULT_CATEGORY(cname)
 196
 197 /**
 198  * @ingroup XBT_log
 199  * @param cname name of the cat
 200  * @hideinitializer
 201  *
 202  * Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file.
 203  */
 204
 205 #define XBT_LOG_EXTERNAL_CATEGORY(cname) \
 206    extern s_xbt_log_category_t _XBT_LOGV(cname)
 207
 208 /**
 209  * @ingroup XBT_log
 210  * @param cname name of the cat
 211  * @hideinitializer
 212  *
 213  * Indicates that the default category of this file was declared in another file.
 214  */
 215
 216 #define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname) \
 217    XBT_LOG_EXTERNAL_CATEGORY(cname);\
 218    XBT_LOG_DEFAULT_CATEGORY(cname)
 219
 220 /* Functions you may call */
 221
 222 XBT_PUBLIC void xbt_log_control_set(const char* cs);
 223
 224 /* Forward declarations */
 225 typedef struct xbt_log_appender_s  s_xbt_log_appender_t;
 226 typedef s_xbt_log_appender_t* xbt_log_appender_t;
 227 typedef struct xbt_log_layout_s  s_xbt_log_layout_t;
 228 typedef s_xbt_log_layout_t* xbt_log_layout_t;
 229 typedef struct xbt_log_event_s  s_xbt_log_event_t;
 230 typedef s_xbt_log_event_t* xbt_log_event_t;
 231 typedef struct xbt_log_category_s  s_xbt_log_category_t;
 232 typedef s_xbt_log_category_t* xbt_log_category_t;
 233
 234 /* Do NOT access any members of this structure directly. FIXME: move to private? */
 235
 236 struct xbt_log_category_s {
 237   xbt_log_category_t parent;
 238   xbt_log_category_t firstChild;
 239   xbt_log_category_t nextSibling;
 240   const char *name;
 241   const char *description;
 242   int initialized;
 243   int threshold;
 244   int isThreshInherited;
 245   xbt_log_appender_t appender;
 246   xbt_log_layout_t layout;
 247   int additivity;
 248 };
 249
 250 struct xbt_log_event_s {
 251   xbt_log_category_t cat;
 252   e_xbt_log_priority_t priority;
 253   const char *fileName;
 254   const char *functionName;
 255   int lineNum;
 256   va_list ap;
 257   char *buffer;
 258   int buffer_size;
 259 };
 260
 261 /**
 262  * @ingroup XBT_log_implem
 263  * @param cat the category (not only its name, but the variable)
 264  * @param thresholdPriority the priority
 265  *
 266  * Programatically alters a category's threshold priority (don't use).
 267  */
 268 XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority);
 269
 270 /**
 271  * @ingroup XBT_log_implem
 272  * @param cat the category (not only its name, but the variable)
 273  * @param app the appender
 274  *
 275  * Programatically sets the category's appender. (the preferred interface is through xbt_log_control_set())
 276  */
 277 XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app);
 278 /**
 279  * @ingroup XBT_log_implem
 280  * @param cat the category (not only its name, but the variable)
 281  * @param lay the layout
 282  *
 283  * Programatically sets the category's layout. (the preferred interface is through xbt_log_control_set())
 284  */
 285 XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay);
 286
 287 /**
 288  * @ingroup XBT_log_implem
 289  * @param cat the category (not only its name, but the variable)
 290  * @param additivity whether logging actions must be passed to parent.
 291  *
 292  * Programatically sets whether the logging actions must be passed to the parent category.
 293  * (the preferred interface is through xbt_log_control_set())
 294  */
 295 XBT_PUBLIC void xbt_log_additivity_set(xbt_log_category_t cat, int additivity);
 296
 297 /** @brief create a new simple layout
 298  *
 299  * This layout is not as flexible as the pattern one
 300  */
 301 XBT_PUBLIC xbt_log_layout_t xbt_log_layout_simple_new(const char* arg);
 302 XBT_PUBLIC xbt_log_layout_t xbt_log_layout_format_new(const char* arg);
 303 XBT_PUBLIC xbt_log_appender_t xbt_log_appender_stream(FILE* f);
 304 XBT_PUBLIC xbt_log_appender_t xbt_log_appender_file_new(const char* arg);
 305 XBT_PUBLIC xbt_log_appender_t xbt_log_appender2_file_new(const char* arg, int roll);
 306
 307 /* ********************************** */
 308 /* Functions that you shouldn't call  */
 309 /* ********************************** */
 310 XBT_PUBLIC void xbt_log_init(int* argc, char** argv);
 311 XBT_PUBLIC void _xbt_log_event_log(xbt_log_event_t ev, const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
 312 XBT_PUBLIC int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority);
 313
 314 #ifdef DLL_EXPORT
 315 XBT_PUBLIC_DATA s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
 316 #else
 317 // If we `dllexport` the root log category, MinGW does not want us to take its address with the error:
 318 // > initializer element is not constant
 319 // When using auto-import, MinGW is happy.
 320 // We should handle this for non-root log categories as well.
 321 extern s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
 322 #endif
 323
 324 extern xbt_log_appender_t xbt_log_default_appender;
 325 extern xbt_log_layout_t xbt_log_default_layout;
 326
 327 /* ********************** */
 328 /* Public functions again */
 329 /* ********************** */
 330
 331 /**
 332  * @ingroup XBT_log
 333  * @param catName name of the category
 334  * @param priority minimal priority to be enabled to return true (must be #e_xbt_log_priority_t)
 335  * @hideinitializer
 336  *
 337  * Returns true if the given priority is enabled for the category.
 338  * If you have expensive expressions that are computed outside of the log command and used only within it, you should
 339  * make its evaluation conditional using this macro.
 340  */
 341 #define XBT_LOG_ISENABLED(catName, priority) \
 342             _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
 343
 344 /*
 345  * Helper function that implements XBT_LOG_ISENABLED.
 346  *
 347  * NOTES
 348  * First part is a compile-time constant.
 349  * Call to xbt_log_cat_init only happens once.
 350  */
 351 #define _XBT_LOG_ISENABLEDV(catv, priority)                  \
 352        (priority >= XBT_LOG_STATIC_THRESHOLD                 \
 353         && ((catv).initialized || _xbt_log_cat_init(&(catv), priority)) \
 354         && priority >= (catv).threshold)
 355
 356 /*
 357  * Internal Macros
 358  * Some kludge macros to ease maintenance. See how they're used below.
 359  *
 360  * IMPLEMENTATION NOTE: To reduce the parameter passing overhead of an enabled message, the many parameters passed to
 361  * the logging function are packed in a structure. Since these values will be usually be passed to at least 3 functions,
 362  * this is a win.
 363  * It also allows adding new values (such as a timestamp) without breaking code.
 364  * Setting the LogEvent's valist member is done inside _log_logEvent.
 365  */
 366
 367 /* Logging Macros */
 368
 369 #ifdef XBT_LOG_MAYDAY
 370 # define XBT_CLOG(cat, prio, ...) \
 371   _XBT_IF_ONE_ARG(_XBT_CLOG_ARG1, _XBT_CLOG_ARGN, __VA_ARGS__)(__VA_ARGS__)
 372 # define _XBT_CLOG_ARG1(f) \
 373   fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__)
 374 # define _XBT_CLOG_ARGN(f, ...) \
 375   fprintf(stderr,"%s:%d:\n" f, __FILE__, __LINE__, __VA_ARGS__)
 376 # define XBT_LOG(...) XBT_CLOG(0, __VA_ARGS__)
 377 #else
 378
 379 #define XBT_CLOG(category, prio, ...)                                                                                  \
 380   do {                                                                                                                 \
 381     if (_XBT_LOG_ISENABLEDV((category), prio)) {                                                                       \
 382       s_xbt_log_event_t _log_ev;                                                                                       \
 383       _log_ev.cat          = &(category);                                                                              \
 384       _log_ev.priority     = (prio);                                                                                   \
 385       _log_ev.fileName     = __FILE__;                                                                                 \
 386       _log_ev.functionName = __func__;                                                                                 \
 387       _log_ev.lineNum      = __LINE__;                                                                                 \
 388       _xbt_log_event_log(&_log_ev, __VA_ARGS__);                                                                       \
 389     }                                                                                                                  \
 390   } while (0)
 391
 392 #define XBT_LOG(prio, ...) XBT_CLOG(*_simgrid_log_category__default, prio, __VA_ARGS__)
 393
 394 #endif
 395
 396 /** @ingroup XBT_log
 397  *  @hideinitializer
 398  * @param categ the category on which to log
 399  * @param ... the format string and its arguments
 400  *  @brief Log an event at the DEBUG priority on the specified category with these args.
 401  */
 402 #define XBT_CDEBUG(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_debug, __VA_ARGS__)
 403
 404 /** @ingroup XBT_log
 405  *  @hideinitializer
 406  *  @brief Log an event at the VERB priority on the specified category with these args.
 407  */
 408 #define XBT_CVERB(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_verbose, __VA_ARGS__)
 409
 410 /** @ingroup XBT_log
 411  *  @hideinitializer
 412  *  @brief Log an event at the INFO priority on the specified category with these args.
 413  */
 414 #define XBT_CINFO(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_info, __VA_ARGS__)
 415
 416 /** @ingroup XBT_log
 417  *  @hideinitializer
 418  *  @brief Log an event at the WARN priority on the specified category with these args.
 419  */
 420 #define XBT_CWARN(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_warning, __VA_ARGS__)
 421
 422 /** @ingroup XBT_log
 423  *  @hideinitializer
 424  *  @brief Log an event at the ERROR priority on the specified category with these args.
 425  */
 426 #define XBT_CERROR(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_error, __VA_ARGS__)
 427
 428 /** @ingroup XBT_log
 429  *  @hideinitializer
 430  *  @brief Log an event at the CRITICAL priority on the specified category with these args.
 431  */
 432 #define XBT_CCRITICAL(categ, ...) XBT_CLOG(_XBT_LOGV(categ), xbt_log_priority_critical, __VA_ARGS__)
 433
 434 /** @ingroup XBT_log
 435  *  @hideinitializer
 436  *  @param ... the format string and its arguments
 437  *  @brief Log an event at the DEBUG priority on the default category with these args.
 438  */
 439 #define XBT_DEBUG(...) XBT_LOG(xbt_log_priority_debug, __VA_ARGS__)
 440
 441 /** @ingroup XBT_log
 442  *  @hideinitializer
 443  *  @brief Log an event at the VERB priority on the default category with these args.
 444  */
 445 #define XBT_VERB(...) XBT_LOG(xbt_log_priority_verbose, __VA_ARGS__)
 446
 447 /** @ingroup XBT_log
 448  *  @hideinitializer
 449  *  @brief Log an event at the INFO priority on the default category with these args.
 450  */
 451 #define XBT_INFO(...) XBT_LOG(xbt_log_priority_info, __VA_ARGS__)
 452
 453 /** @ingroup XBT_log
 454  *  @hideinitializer
 455  *  @brief Log an event at the WARN priority on the default category with these args.
 456  */
 457 #define XBT_WARN(...) XBT_LOG(xbt_log_priority_warning, __VA_ARGS__)
 458
 459 /** @ingroup XBT_log
 460  *  @hideinitializer
 461  *  @brief Log an event at the ERROR priority on the default category with these args.
 462  */
 463 #define XBT_ERROR(...) XBT_LOG(xbt_log_priority_error, __VA_ARGS__)
 464
 465 /** @ingroup XBT_log
 466  *  @hideinitializer
 467  *  @brief Log an event at the CRITICAL priority on the default category with these args.
 468  */
 469 #define XBT_CRITICAL(...) XBT_LOG(xbt_log_priority_critical, __VA_ARGS__)
 470
 471 #define _XBT_IN_OUT(...) \
 472   _XBT_IF_ONE_ARG(_XBT_IN_OUT_ARG1, _XBT_IN_OUT_ARGN, __VA_ARGS__)(__VA_ARGS__)
 473 #define _XBT_IN_OUT_ARG1(fmt) \
 474   XBT_LOG(xbt_log_priority_trace, fmt, __func__)
 475 #define _XBT_IN_OUT_ARGN(fmt, ...) \
 476   XBT_LOG(xbt_log_priority_trace, fmt, __func__, __VA_ARGS__)
 477
 478 /** @ingroup XBT_log
 479  *  @hideinitializer
 480  *  @brief Log at TRACE priority that we entered in current function, appending a user specified format.
 481  */
 482 #define XBT_IN(...) _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)
 483
 484 /** @ingroup XBT_log
 485  *  @hideinitializer
 486  *  @brief Log at TRACE priority that we exited the current function, appending a user specified format.
 487  */
 488 #define XBT_OUT(...) _XBT_IN_OUT("<< end of %s" __VA_ARGS__)
 489
 490 /** @ingroup XBT_log
 491  *  @hideinitializer
 492  *  @brief Log at TRACE priority a message indicating that we reached that point, appending a user specified format.
 493  */
 494 #define XBT_HERE(...) XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)
 495
 496 /** @ingroup XBT_log
 497  *  @hideinitializer
 498  *  @brief Log help messages through category xbt.xbt_help.
 499  */
 500 #define XBT_HELP(...) XBT_CINFO(xbt_help, __VA_ARGS__)
 501
 502 SG_END_DECL()
 503 #endif                          /* ! _XBT_LOG_H_ */