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