/* log - a generic logging facility in the spirit of log4j */
-/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
*
* This is the list of all existing log categories in SimGrid.
* This list was automatically extracted from the source code by
- * the src/xbt_log_extract_hierarchy utility.
+ * the tools/doxygen/xbt_log_extract_hierarchy.pl utility.
*
* You can thus be certain that it is uptodate, but it may somehow
* lack a final manual touch.
#include "xbt/misc.h"
#include <stdarg.h>
+#include <stddef.h> /* NULL */
SG_BEGIN_DECL()
/**\brief Log priorities
* \ingroup XBT_log
* The different existing priorities.
*/
typedef enum {
- xbt_log_priority_none = 0, /* used internally (don't poke with) */
+ //! @cond
+ xbt_log_priority_none = 0, /** used internally (don't poke with)*/
+ //! @endcond
xbt_log_priority_trace = 1, /**< enter and return of some functions */
xbt_log_priority_debug = 2, /**< crufty output */
xbt_log_priority_verbose = 3, /**< verbose output for the user wanting more */
xbt_log_priority_infinite = 8, /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
- xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */
+ //! @cond
+ xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */
+ //! @endcond
} e_xbt_log_priority_t;
/*
* define NLOG to disable at compilation time any logging request
- * define NDEBUG to disable at compilation time any logging request of priority below INFO
+ * define NDEBUG to disable at compilation time any logging request of priority below VERBOSE
*/
#endif /* !defined(NLOG) */
/* Transforms a category name to a global variable name. */
-#define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_simgrid_log_category__, cat)
-#define _XBT_LOG_CONCAT(x,y) x ## y
+#define _XBT_LOGV(cat) _XBT_LOG_CONCAT(_simgrid_log_category__, cat)
+#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
-/* The whole tree of categories is connected by setting the address of
- * the parent category as a field of the child one.
+/* The whole tree of categories is connected by setting the address of the
+ * parent category as a field of the child one. This is normally done at the
+ * first use of the category.
*
- * In strict ansi C, we are allowed to initialize a variable with "a
- * pointer to an lvalue designating an object of static storage
- * duration" [ISO/IEC 9899:1999, Section 6.6].
- *
- * Unfortunately, Visual C builder does not target any standard
- * compliance, and C99 is not an exception to this unfortunate rule.
- *
- * So, we work this around by adding a XBT_LOG_CONNECT() macro,
- * allowing to connect a child to its parent. It should be used
- * during the initialization of the code, before the child category
- * gets used.
- *
- * When compiling with gcc, this is not necessary (XBT_LOG_CONNECT
- * defines to nothing). When compiling with MSVC, this is needed if
- * you don't want to see your child category become a child of root
- * directly.
- */
-#if defined(_MSC_VER)
-# define _XBT_LOG_PARENT_INITIALIZER(parent) NULL
-# define XBT_LOG_CONNECT(parent_cat,child) _XBT_LOGV(child).parent = &_XBT_LOGV(parent_cat)
-#else
-# define _XBT_LOG_PARENT_INITIALIZER(parent) &_XBT_LOGV(parent)
-# define XBT_LOG_CONNECT(parent_cat,child) /* xbt_assert(_XBT_LOGV(child).parent == &_XBT_LOGV(parent_cat)) */
-#endif
+ * 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().
+ */
+
+#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) \
- XBT_EXPORT_NO_IMPORT(s_xbt_log_category_t) _XBT_LOGV(catName) = { \
- _XBT_LOG_PARENT_INITIALIZER(parent), \
- NULL /* firstChild */, \
- NULL /* nextSibling */, \
- #catName, \
- 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_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 */ \
+ }
+
/**
* \ingroup XBT_log
* \param catName name of new category
* Defines a new subcategory of the parent.
*/
#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \
- extern s_xbt_log_category_t _XBT_LOGV(parent); \
- XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
+ XBT_LOG_EXTERNAL_CATEGORY(parent); \
+ XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
/**
* \ingroup XBT_log
* Indicates which category is the default one.
*/
-#if defined(XBT_LOG_MAYDAY) || defined(SUPERNOVAE_MODE) /*|| defined (NLOG) * turning logging off */
+#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_GNUC_UNUSED = &_XBT_LOGV(cname)
+ static xbt_log_category_t _XBT_LOGV(default) _XBT_GNUC_UNUSED = &_XBT_LOGV(cname)
#endif
/**
* Do NOT access any members of this structure directly. FIXME: move to private?
*/
-#define XBT_LOG_BUFF_SIZE 2048 /* Size of the static string in which we build the log string */
-
struct xbt_log_category_s {
xbt_log_category_t parent;
xbt_log_category_t firstChild;
xbt_log_category_t nextSibling;
const char *name;
+ const char *description;
+ int initialized;
int threshold;
int isThreshInherited;
xbt_log_appender_t appender;
const char *functionName;
int lineNum;
va_list ap;
- va_list ap_copy; /* need a copy to launch dynamic layouts when the static ones overflowed */
- char buffer[XBT_LOG_BUFF_SIZE];
+ char *buffer;
+ int buffer_size;
};
/**
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);
/* ********************************** */
e_xbt_log_priority_t priority);
+#ifdef DLL_EXPORT
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
+// When using auto-import, MinGW is happy.
+// We should handle this for non-root log categories as well.
+extern s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
+#endif
extern xbt_log_appender_t xbt_log_default_appender;
extern xbt_log_layout_t xbt_log_default_layout;
*
* NOTES
* First part is a compile-time constant.
- * Call to _log_initCat only happens once.
+ * Call to xbt_log_cat_init only happens once.
*/
#define _XBT_LOG_ISENABLEDV(catv, priority) \
(priority >= XBT_LOG_STATIC_THRESHOLD \
- && priority >= catv.threshold \
- && (catv.threshold != xbt_log_priority_uninitialized \
- || _xbt_log_cat_init(&catv, priority)) )
+ && (catv.initialized || _xbt_log_cat_init(&catv, priority)) \
+ && priority >= catv.threshold)
/*
* Internal Macros
* Setting the LogEvent's valist member is done inside _log_logEvent.
*/
-#include <string.h> /* memset */
-#define _XBT_LOG_EV_BUFFER_ZERO() \
- memset(_log_ev.buffer, 0, XBT_LOG_BUFF_SIZE)
-
/* Logging Macros */
#ifdef XBT_LOG_MAYDAY
_log_ev.fileName = __FILE__; \
_log_ev.functionName = _XBT_FUNCTION; \
_log_ev.lineNum = __LINE__; \
- _XBT_LOG_EV_BUFFER_ZERO(); \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
*/
#define XBT_CRITICAL(...) XBT_LOG(xbt_log_priority_critical, __VA_ARGS__)
+#define _XBT_IN_OUT(...) \
+ _XBT_IF_ONE_ARG(_XBT_IN_OUT_ARG1, _XBT_IN_OUT_ARGN, __VA_ARGS__)(__VA_ARGS__)
+#define _XBT_IN_OUT_ARG1(fmt) \
+ XBT_LOG(xbt_log_priority_trace, fmt, _XBT_FUNCTION)
+#define _XBT_IN_OUT_ARGN(fmt, ...) \
+ XBT_LOG(xbt_log_priority_trace, fmt, _XBT_FUNCTION, __VA_ARGS__)
+
/** @ingroup XBT_log
* @hideinitializer
* @brief Log at TRACE priority that we entered in current function, appending a user specified format.
*/
-#define XBT_IN(...) \
- _XBT_IF_ONE_ARG(_XBT_IN_ARG1, _XBT_IN_ARGN, __VA_ARGS__)(__VA_ARGS__)
-#define _XBT_IN_ARG1(fmt) \
- XBT_LOG(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION)
-#define _XBT_IN_ARGN(fmt, ...) \
- XBT_LOG(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, __VA_ARGS__)
+#define XBT_IN(...) _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)
/** @ingroup XBT_log
* @hideinitializer
- * @brief Log at TRACE priority that we exited the current function.
+ * @brief Log at TRACE priority that we exited the current function, appending a user specified format.
*/
-#define XBT_OUT() XBT_LOG(xbt_log_priority_trace, "<< end of %s", _XBT_FUNCTION)
+#define XBT_OUT(...) _XBT_IN_OUT("<< end of %s" __VA_ARGS__)
/** @ingroup XBT_log
* @hideinitializer
- * @brief Log at TRACE priority a message indicating that we reached that point.
+ * @brief Log at TRACE priority a message indicating that we reached that point, appending a user specified format.
*/
-#define XBT_HERE() XBT_LOG(xbt_log_priority_trace, "-- was here")
+#define XBT_HERE(...) XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)
#ifdef XBT_USE_DEPRECATED