X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/61eea4d2a96e8804b2d0cecc2ef5bece461255d6..59a9c6e9853d52baf117e2ce392173047e864743:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index adb13a1068..44d4b79389 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -87,7 +87,7 @@ typedef enum { #endif /* !defined(NLOG) */ /* Transforms a category name to a global variable name. */ -#define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_gras_this_log_category_does_not_exist__, cat) +#define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_simgrid_this_log_category_does_not_exist__, cat) #define _XBT_LOG_CONCAT(x,y) x ## y /* The root of the category hierarchy. */ @@ -98,7 +98,7 @@ typedef enum { * to avoid an extra declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by * XBT_LOG_NEW_CATEGORY */ #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ - s_xbt_log_category_t _XBT_LOGV(catName) = { \ + XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = { \ &_XBT_LOGV(parent), 0, 0, \ #catName, xbt_log_priority_uninitialized, 1, \ 0, 1 \ @@ -113,7 +113,7 @@ typedef enum { * Defines a new subcategory of the parent. */ #define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \ - extern s_xbt_log_category_t _XBT_LOGV(parent); \ + extern s_xbt_log_category_t _XBT_LOGV(parent); \ XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ /** @@ -124,7 +124,17 @@ typedef enum { * * Creates a new subcategory of the root category. */ -#define XBT_LOG_NEW_CATEGORY(catName,desc) XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc) + +#if (defined(_WIN32) && !defined(DLL_STATIC)) +# define XBT_LOG_NEW_CATEGORY(catName,desc) \ + XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = { \ + 0, 0, 0, \ + #catName, xbt_log_priority_uninitialized, 1, \ + 0, 1 \ + } +#else +# define XBT_LOG_NEW_CATEGORY(catName,desc) XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc) +#endif /** * \ingroup XBT_log @@ -150,9 +160,26 @@ typedef enum { * Creates a new subcategory of the root category and makes it the default * (used by macros that don't explicitly specify a category). */ -#define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc) \ + +#if (defined(_WIN32) && !defined(DLL_STATIC)) +# define XBT_LOG_NEW_ROOT_SUBCATEGORY(cname,desc) \ + XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(cname) = { \ + 0, 0, 0, \ + #cname, xbt_log_priority_uninitialized, 1, \ + 0, 1 \ + } + +# define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc) \ + XBT_LOG_NEW_ROOT_SUBCATEGORY(cname,desc); \ + XBT_LOG_DEFAULT_CATEGORY(cname) + +#else +# define XBT_LOG_NEW_DEFAULT_CATEGORY(cname,desc) \ XBT_LOG_NEW_CATEGORY(cname,desc); \ - XBT_LOG_DEFAULT_CATEGORY(cname) + XBT_LOG_DEFAULT_CATEGORY(cname) +#endif + + /** * \ingroup XBT_log @@ -194,10 +221,11 @@ typedef enum { /* Functions you may call */ -XBT_PUBLIC extern 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,*xbt_log_appender_t; +typedef struct xbt_log_layout_s s_xbt_log_layout_t, *xbt_log_layout_t; typedef struct xbt_log_event_s s_xbt_log_event_t, *xbt_log_event_t; typedef struct xbt_log_category_s s_xbt_log_category_t,*xbt_log_category_t; @@ -205,23 +233,31 @@ typedef struct xbt_log_category_s s_xbt_log_category_t,*xbt_log_category_t; * Do NOT access any members of this structure directly. FIXME: move to private? */ struct xbt_log_category_s { - xbt_log_category_t parent; -/*@null@*/ xbt_log_category_t firstChild; -/*@null@*/ xbt_log_category_t nextSibling; - const char *name; - int threshold; - int isThreshInherited; -/*@null@*/ xbt_log_appender_t appender; - int willLogToParent; - /* TODO: Formats? */ + xbt_log_category_t parent; + xbt_log_category_t firstChild; + xbt_log_category_t nextSibling; + const char *name; + int threshold; + int isThreshInherited; + xbt_log_appender_t appender; + int additivity; }; struct xbt_log_appender_s { - void (*do_append) (xbt_log_appender_t thisLogAppender, - xbt_log_event_t event, const char *fmt); - void *appender_data; + void (*do_append) (xbt_log_appender_t this_appender, + char *event); + void (*free_) (xbt_log_appender_t this_); + xbt_log_layout_t layout; + void *data; }; +struct xbt_log_layout_s { + char *(*do_layout)(xbt_log_layout_t l, + xbt_log_event_t event, const char *fmt); + void (*free_) (xbt_log_layout_t l); + void *data; +} ; + struct xbt_log_event_s { xbt_log_category_t cat; e_xbt_log_priority_t priority; @@ -238,8 +274,8 @@ struct xbt_log_event_s { * * Programatically alters a category's threshold priority (don't use). */ -XBT_PUBLIC extern 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 @@ -248,7 +284,7 @@ XBT_PUBLIC extern void xbt_log_threshold_set(xbt_log_category_t cat, * * Programatically alter a category's parent (don't use). */ -XBT_PUBLIC extern void xbt_log_parent_set(xbt_log_category_t cat, +XBT_PUBLIC(void) xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent); /** @@ -256,24 +292,55 @@ XBT_PUBLIC extern void xbt_log_parent_set(xbt_log_category_t cat, * \param cat the category (not only its name, but the variable) * \param app the appender * - * Programatically sets the category's appender (don't use). + * Programatically sets the category's appender. + * (the prefered interface is throught xbt_log_control_set()) + * */ -XBT_PUBLIC extern 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); -/* Functions that you shouldn't call. */ -XBT_PUBLIC extern void _xbt_log_event_log(xbt_log_event_t ev, +/** + * \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 prefered interface is throught xbt_log_control_set()) + * + */ +XBT_PUBLIC(void) xbt_log_additivity_set(xbt_log_category_t cat, + int additivity); + +/** @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(void); +XBT_PUBLIC(xbt_log_appender_t) xbt_log_appender_file_new(xbt_log_layout_t layout); + + +/* ********************************** */ +/* Functions that you shouldn't call */ +/* ********************************** */ +XBT_PUBLIC(void) _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...) _XBT_GNUC_PRINTF(2,3); -XBT_PUBLIC extern int _xbt_log_cat_init(e_xbt_log_priority_t priority, - xbt_log_category_t category); +XBT_PUBLIC(int) _xbt_log_cat_init(xbt_log_category_t category, + e_xbt_log_priority_t priority); -extern s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT); +extern XBT_IMPORT_NO_EXPORT(s_xbt_log_category_t) _XBT_LOGV(XBT_LOG_ROOT_CAT); + XBT_LOG_EXTERNAL_CATEGORY(GRAS); + extern xbt_log_appender_t xbt_log_default_appender; +/* ********************** */ +/* Public functions again */ +/* ********************** */ + /** * \ingroup XBT_log * \param catName name of the category @@ -299,7 +366,7 @@ extern xbt_log_appender_t xbt_log_default_appender; (priority >= XBT_LOG_STATIC_THRESHOLD \ && priority >= catv.threshold \ && (catv.threshold != xbt_log_priority_uninitialized \ - || _xbt_log_cat_init(priority, &catv)) ) + || _xbt_log_cat_init(&catv, priority)) ) /* * Internal Macros @@ -583,6 +650,8 @@ extern xbt_log_appender_t xbt_log_default_appender; * @brief Log at TRACE priority a message indicating that we reached that point. */ #define XBT_HERE LOG0(xbt_log_priority_trace, "-- was here") + + SG_END_DECL() #endif /* ! _XBT_LOG_H_ */