X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/595e59c568ff5f8510de201bfd800951cdc2adcb..3297da9f47ce18371941b2b48a2f4018b4793ced:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index a6be428cf5..6c7991f5c3 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -1,6 +1,6 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004-2015. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2018. The SimGrid Team. 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. */ @@ -10,15 +10,16 @@ * */ -/** \defgroup XBT_log_cats Existing log categories - * \ingroup XBT_log - * \brief (automatically extracted) +/** @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 is automatically extracted from the source code by the tools/doxygen/xbt_log_extract_hierarchy.pl utility. * - * It should thus contain every categories that are defined in the SimGrid library. - * If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your simulator. + * It should thus contain every categories that are defined in the SimGrid library. + * If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your + * simulator. */ /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic @@ -28,15 +29,15 @@ #ifndef XBT_LOG_H #define XBT_LOG_H -#include "xbt/misc.h" #include -#include /* NULL */ +#include /* NULL */ +#include SG_BEGIN_DECL() -/**\brief Log priorities - * \ingroup XBT_log +/**@brief Log priorities + * @ingroup XBT_log * * The different existing priorities. -*/ + */ typedef enum { //! @cond xbt_log_priority_none = 0, /** used internally (don't poke with)*/ @@ -86,12 +87,6 @@ typedef enum { #define _XBT_LOGV_CTOR(cat) _XBT_LOG_CONCAT2(_XBT_LOGV(cat), __constructor__) #define _XBT_LOG_CONCAT(x, y) x ## y #define _XBT_LOG_CONCAT2(x, y) _XBT_LOG_CONCAT(x, y) -/* Apparently, constructor priorities are not supported by gcc on Macs */ -#if defined(__GNUC__) && defined(__APPLE__) -# define _XBT_LOGV_CTOR_ATTRIBUTE -#else -# define _XBT_LOGV_CTOR_ATTRIBUTE _XBT_GNUC_CONSTRUCTOR(600) -#endif /* The root of the category hierarchy. */ #define XBT_LOG_ROOT_CAT root @@ -100,67 +95,56 @@ typedef enum { * This is normally done at the first use of the category. * * It is however necessary to make this connections as early as possible, if we want the category to be listed by - * --help-log-categories. - * - * When possible, the initializations takes place automatically before the start of main(). It's the case when - * compiling with gcc. - * - * For the other cases, you can use the XBT_LOG_CONNECT(cat) macro to force early initialization. See, for example, - * in xbt/log.c, the function xbt_log_connect_categories(). + * --help-log-categories. We use constructor attributes for these initializations to take place automatically before the + * start of main(). */ -#define XBT_LOG_CONNECT(cat) \ - if (1) { \ - extern void _XBT_LOGV_CTOR(cat)(void); \ - _XBT_LOGV_CTOR(cat)(); \ - } else ((void)0) - /* 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) \ - SG_BEGIN_DECL() \ - extern void _XBT_LOGV_CTOR(catName)(void) _XBT_LOGV_CTOR_ATTRIBUTE; \ - void _XBT_LOGV_CTOR(catName)(void) \ - { \ - XBT_LOG_EXTERNAL_CATEGORY(catName); \ - if (!_XBT_LOGV(catName).initialized) { \ - _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \ - } \ - } \ - SG_END_DECL() \ - XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = { \ - &_XBT_LOGV(parent), \ - NULL /* firstChild */, \ - NULL /* nextSibling */, \ - #catName, \ - desc, \ - 0 /*initialized */, \ - xbt_log_priority_uninitialized /* threshold */, \ - 1 /* isThreshInherited */, \ - NULL /* appender */, \ - NULL /* layout */, \ - 1 /* additivity */ \ +#define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ + SG_BEGIN_DECL() \ + extern void _XBT_LOGV_CTOR(catName)(void) XBT_ATTRIB_CONSTRUCTOR(600); \ + void _XBT_LOGV_CTOR(catName)(void) \ + { \ + XBT_LOG_EXTERNAL_CATEGORY(catName); \ + if (!_XBT_LOGV(catName).initialized) { \ + _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \ + } \ + } \ + SG_END_DECL() \ + XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = { \ + &_XBT_LOGV(parent), \ + NULL /* firstChild */, \ + NULL /* nextSibling */, \ + #catName, \ + desc, \ + 0 /*initialized */, \ + xbt_log_priority_uninitialized /* threshold */, \ + 1 /* isThreshInherited */, \ + NULL /* appender */, \ + NULL /* layout */, \ + 1 /* additivity */ \ } /** - * \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 + * @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. + * Defines a new subcategory of the parent. */ #define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ XBT_LOG_EXTERNAL_CATEGORY(parent); \ - XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ + XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) /** - * \ingroup XBT_log - * \param catName name of new category - * \param desc string describing the purpose of this category - * \hideinitializer + * @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. */ @@ -168,9 +152,9 @@ typedef enum { XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc) /** - * \ingroup XBT_log - * \param cname name of the cat - * \hideinitializer + * @ingroup XBT_log + * @param cname name of the cat + * @hideinitializer * * Indicates which category is the default one. */ @@ -178,15 +162,15 @@ typedef enum { #if defined(XBT_LOG_MAYDAY) /*|| defined (NLOG) * turning logging off */ # define XBT_LOG_DEFAULT_CATEGORY(cname) #else -# define XBT_LOG_DEFAULT_CATEGORY(cname) \ - static xbt_log_category_t _XBT_LOGV(default) XBT_ATTRIB_UNUSED = &_XBT_LOGV(cname) +#define XBT_LOG_DEFAULT_CATEGORY(cname) \ + XBT_ATTRIB_UNUSED static xbt_log_category_t _XBT_LOGV(default) = &_XBT_LOGV(cname) #endif /** - * \ingroup XBT_log - * \param cname name of the cat - * \param desc string describing the purpose of this category - * \hideinitializer + * @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). @@ -196,11 +180,11 @@ typedef enum { XBT_LOG_DEFAULT_CATEGORY(cname) /** - * \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 + * @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). @@ -210,9 +194,9 @@ typedef enum { XBT_LOG_DEFAULT_CATEGORY(cname) /** - * \ingroup XBT_log - * \param cname name of the cat - * \hideinitializer + * @ingroup XBT_log + * @param cname name of the cat + * @hideinitializer * * Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file. */ @@ -221,9 +205,9 @@ typedef enum { extern s_xbt_log_category_t _XBT_LOGV(cname) /** - * \ingroup XBT_log - * \param cname name of the cat - * \hideinitializer + * @ingroup XBT_log + * @param cname name of the cat + * @hideinitializer * * Indicates that the default category of this file was declared in another file. */ @@ -234,17 +218,17 @@ typedef enum { /* Functions you may call */ -XBT_PUBLIC(void) xbt_log_control_set(const char *cs); +XBT_PUBLIC void xbt_log_control_set(const char* cs); /* Forward declarations */ typedef struct xbt_log_appender_s s_xbt_log_appender_t; -typedef struct xbt_log_appender_s* xbt_log_appender_t; +typedef s_xbt_log_appender_t* xbt_log_appender_t; typedef struct xbt_log_layout_s s_xbt_log_layout_t; -typedef struct xbt_log_layout_s* xbt_log_layout_t; +typedef s_xbt_log_layout_t* xbt_log_layout_t; typedef struct xbt_log_event_s s_xbt_log_event_t; -typedef struct xbt_log_event_s* xbt_log_event_t; +typedef s_xbt_log_event_t* xbt_log_event_t; typedef struct xbt_log_category_s s_xbt_log_category_t; -typedef struct xbt_log_category_s* xbt_log_category_t; +typedef s_xbt_log_category_t* xbt_log_category_t; /* Do NOT access any members of this structure directly. FIXME: move to private? */ @@ -274,59 +258,59 @@ struct xbt_log_event_s { }; /** - * \ingroup XBT_log_implem - * \param cat the category (not only its name, but the variable) - * \param 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). */ -XBT_PUBLIC(void) xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); +XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); /** - * \ingroup XBT_log_implem - * \param cat the category (not only its name, but the variable) - * \param 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. (the preferred interface is through xbt_log_control_set()) */ -XBT_PUBLIC(void) xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app); +XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app); /** - * \ingroup XBT_log_implem - * \param cat the category (not only its name, but the variable) - * \param lay the layout + * @ingroup XBT_log_implem + * @param cat the category (not only its name, but the variable) + * @param lay the layout * * Programatically sets the category's layout. (the preferred interface is through xbt_log_control_set()) */ -XBT_PUBLIC(void) xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay); +XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay); /** - * \ingroup XBT_log_implem - * \param cat the category (not only its name, but the variable) - * \param additivity whether logging actions must be passed to parent. + * @ingroup XBT_log_implem + * @param cat the category (not only its name, but the variable) + * @param additivity whether logging actions must be passed to parent. * * Programatically sets whether the logging actions must be passed to the parent category. * (the preferred interface is through xbt_log_control_set()) */ -XBT_PUBLIC(void) xbt_log_additivity_set(xbt_log_category_t cat, int additivity); +XBT_PUBLIC void xbt_log_additivity_set(xbt_log_category_t cat, int additivity); -/** @brief create a new simple layout +/** @brief create a new simple layout * * This layout is not as flexible as the pattern one */ -XBT_PUBLIC(xbt_log_layout_t) xbt_log_layout_simple_new(char *arg); -XBT_PUBLIC(xbt_log_layout_t) xbt_log_layout_format_new(char *arg); -XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender_file_new(char *arg); -XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender2_file_new(char *arg,int roll); +XBT_PUBLIC xbt_log_layout_t xbt_log_layout_simple_new(char* arg); +XBT_PUBLIC xbt_log_layout_t xbt_log_layout_format_new(char* arg); +XBT_PUBLIC xbt_log_appender_t xbt_log_appender_file_new(char* arg); +XBT_PUBLIC xbt_log_appender_t xbt_log_appender2_file_new(char* arg, int roll); /* ********************************** */ /* Functions that you shouldn't call */ /* ********************************** */ -XBT_PUBLIC(void) xbt_log_init(int *argc, char **argv); -XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...) XBT_ATTRIB_PRINTF(2, 3); -XBT_PUBLIC(int) _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority); +XBT_PUBLIC void xbt_log_init(int* argc, char** argv); +XBT_PUBLIC void _xbt_log_event_log(xbt_log_event_t ev, const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3); +XBT_PUBLIC int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority); #ifdef DLL_EXPORT -XBT_PUBLIC_DATA(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT); +XBT_PUBLIC_DATA s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT); #else // If we `dllexport` the root log category, MinGW does not want us to take its address with the error: // > initializer element is not constant @@ -343,10 +327,10 @@ extern xbt_log_layout_t xbt_log_default_layout; /* ********************** */ /** - * \ingroup XBT_log - * \param catName name of the category - * \param priority minimal priority to be enabled to return true (must be #e_xbt_log_priority_t) - * \hideinitializer + * @ingroup XBT_log + * @param catName name of the category + * @param priority minimal priority to be enabled to return true (must be #e_xbt_log_priority_t) + * @hideinitializer * * Returns true if the given priority is enabled for the category. * If you have expensive expressions that are computed outside of the log command and used only within it, you should @@ -422,8 +406,8 @@ extern xbt_log_layout_t xbt_log_default_layout; /** @ingroup XBT_log * @hideinitializer - * \param categ the category on which to log - * \param ... the format string and its arguments + * @param categ the category on which to log + * @param ... the format string and its arguments * @brief Log an event at the DEBUG priority on the specified category with these args. */ #define XBT_CDEBUG(categ, ...) \ @@ -528,7 +512,7 @@ extern xbt_log_layout_t xbt_log_default_layout; /** @ingroup XBT_log * @hideinitializer - * \param ... the format string and its arguments + * @param ... the format string and its arguments * @brief Log an event at the DEBUG priority on the default category with these args. */ #define XBT_DEBUG(...) \