#ifndef _XBT_LOG_H_
#define _XBT_LOG_H_
-#include <stdarg.h>
+#include "xbt/misc.h"
-#include "xbt/sysdep.h"
+#include <stdarg.h>
/**\brief Log priorities
* \ingroup XBT_log
* The different existing priorities.
*/
typedef enum {
- xbt_log_priority_none = 0, /**< used internally (don't poke with) */
- xbt_log_priority_trace = 1,
+ xbt_log_priority_none = 0, /* used internally (don't poke with) */
+ 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_info = 4, /**< output about the regular functionning */
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) */
+ xbt_log_priority_uninitialized = -1 /* used internally (don't poke with) */
} e_xbt_log_priority_t;
-/**
- * \define NLOG
- *
- * \note All logging facilities are disabled at compilation time
+/*
+ * define NLOG to disable at compilation time any logging request
+ * define NDEBUG to disable at compilation time any logging request of priority below INFO
*/
/**
- * XBT_LOG_STATIC_THRESHOLD:
+ * @def XBT_LOG_STATIC_THRESHOLD
+ * @ingroup XBT_log
*
- * All logging with priority < XBT_LOG_STATIC_THRESHOLD is disabled at
+ * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at
* compile time, i.e., compiled out.
*/
#ifdef NLOG
/* The root of the category hierarchy. */
#define XBT_LOG_ROOT_CAT root
+/* 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) \
+ s_xbt_log_category_t _XBT_LOGV(catName) = { \
+ &_XBT_LOGV(parent), 0, 0, \
+ #catName, xbt_log_priority_uninitialized, 1, \
+ 0, 1 \
+ }
/**
* \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.
*/
-#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \
- extern s_xbt_log_category_t _XBT_LOGV(parent); \
- s_xbt_log_category_t _XBT_LOGV(catName) = { \
- &_XBT_LOGV(parent), 0, 0, \
- #catName, xbt_log_priority_uninitialized, 1, \
- 0, 1 \
- }
+#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) \
/**
* \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.
*/
-#define XBT_LOG_NEW_CATEGORY(catName,desc) XBT_LOG_NEW_SUBCATEGORY(catName, XBT_LOG_ROOT_CAT, desc)
+#define XBT_LOG_NEW_CATEGORY(catName,desc) XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
/**
* \ingroup XBT_log
* \param cname name of the cat
+ * \hideinitializer
*
* Indicates which category is the default one.
*/
* \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).
* \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).
/**
* \ingroup XBT_log
* \param cname name of the cat
+ * \hideinitializer
*
* Indicates that a category you'll use in this file (to get subcategories of it,
* for example) really lives in another file.
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;
-/**
+/*
* Do NOT access any members of this structure directly. FIXME: move to private?
*/
struct xbt_log_category_s {
};
/**
- * \ingroup XBT_log
+ * \ingroup XBT_log_implem
* \param cat the category (not only its name, but the variable)
* \param thresholdPriority the priority
*
e_xbt_log_priority_t thresholdPriority);
/**
- * \ingroup XBT_log
+ * \ingroup XBT_log_implem
* \param cat the category (not only its name, but the variable)
* \param parent the parent cat
*
xbt_log_category_t parent);
/**
- * \ingroup XBT_log
+ * \ingroup XBT_log_implem
* \param cat the category (not only its name, but the variable)
* \param app the appender
*
* \ingroup XBT_log
* \param catName name of the category
* \param priority minimal priority to be enabled to return true
+ * \hideinitializer
*
* Returns true if the given priority is enabled for the category.
* If you have expensive expressions that are computed outside of the log
#define _XBT_LOG_PRE(catv, priority) do { \
if (_XBT_LOG_ISENABLEDV(catv, priority)) { \
s_xbt_log_event_t _log_ev = \
- {&(catv),priority,__FILE__,_XBT_GNUC_FUNCTION,__LINE__}; \
+ {&(catv),priority,__FILE__,_XBT_FUNCTION,__LINE__}; \
_xbt_log_event_log(&_log_ev
#define _XBT_LOG_POST \
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-/*@{*/
+/* @{ */
#define DEBUG0(f) LOG0(xbt_log_priority_debug, f)
#define DEBUG1(f,a1) LOG1(xbt_log_priority_debug, f,a1)
#define DEBUG2(f,a1,a2) LOG2(xbt_log_priority_debug, f,a1,a2)
#define DEBUG6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6)
#define DEBUG7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7)
#define DEBUG8(f,a1,a2,a3,a4,a5,a6,a7,a8) LOG8(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8)
-/*@}*/
+/* @} */
/** \name VERB
* \ingroup XBT_log
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-/*@{*/
+/* @{ */
#define VERB0(f) LOG0(xbt_log_priority_verbose, f)
#define VERB1(f,a1) LOG1(xbt_log_priority_verbose, f,a1)
#define VERB2(f,a1,a2) LOG2(xbt_log_priority_verbose, f,a1,a2)
#define VERB4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_verbose, f,a1,a2,a3,a4)
#define VERB5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5)
#define VERB6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
/** \name INFO
* \ingroup XBT_log
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-/*@{*/
+/* @{ */
#define INFO0(f) LOG0(xbt_log_priority_info, f)
#define INFO1(f,a1) LOG1(xbt_log_priority_info, f,a1)
#define INFO2(f,a1,a2) LOG2(xbt_log_priority_info, f,a1,a2)
#define INFO4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_info, f,a1,a2,a3,a4)
#define INFO5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_info, f,a1,a2,a3,a4,a5)
#define INFO6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
/** \name WARN
* \ingroup XBT_log
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-/*@{*/
+/* @{ */
#define WARN0(f) LOG0(xbt_log_priority_warning, f)
#define WARN1(f,a1) LOG1(xbt_log_priority_warning, f,a1)
#define WARN2(f,a1,a2) LOG2(xbt_log_priority_warning, f,a1,a2)
#define WARN4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_warning, f,a1,a2,a3,a4)
#define WARN5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_warning, f,a1,a2,a3,a4,a5)
#define WARN6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
/** \name ERROR
* \ingroup XBT_log
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-/*@{*/
+/* @{ */
#define ERROR0(f) LOG0(xbt_log_priority_error, f)
#define ERROR1(f,a1) LOG1(xbt_log_priority_error, f,a1)
#define ERROR2(f,a1,a2) LOG2(xbt_log_priority_error, f,a1,a2)
#define ERROR4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_error, f,a1,a2,a3,a4)
#define ERROR5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_error, f,a1,a2,a3,a4,a5)
#define ERROR6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
/** \name CRITICAL
* \ingroup XBT_log
* for sake of clarity. They just differ in the number of arguments passed
* along with the format string.
*/
-/*@{*/
+/* @{ */
#define CRITICAL0(f) LOG0(xbt_log_priority_critical, f)
#define CRITICAL1(f,a1) LOG1(xbt_log_priority_critical, f,a1)
#define CRITICAL2(f,a1,a2) LOG2(xbt_log_priority_critical, f,a1,a2)
#define CRITICAL4(f,a1,a2,a3,a4) LOG4(xbt_log_priority_critical, f,a1,a2,a3,a4)
#define CRITICAL5(f,a1,a2,a3,a4,a5) LOG5(xbt_log_priority_critical, f,a1,a2,a3,a4,a5)
#define CRITICAL6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
-
-#define XBT_IN LOG1(xbt_log_priority_trace, ">> begin of %s", _XBT_GNUC_FUNCTION)
-#define XBT_IN1(fmt,a) LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a)
-#define XBT_IN2(fmt,a,b) LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b)
-#define XBT_IN3(fmt,a,b,c) LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c)
-#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c,d)
-#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_GNUC_FUNCTION)
+/* @} */
+
+#define XBT_IN LOG1(xbt_log_priority_trace, ">> begin of %s", _XBT_FUNCTION)
+#define XBT_IN1(fmt,a) LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a)
+#define XBT_IN2(fmt,a,b) LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b)
+#define XBT_IN3(fmt,a,b,c) LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c)
+#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c,d)
+#define XBT_OUT LOG1(xbt_log_priority_trace, "<< end of %s", _XBT_FUNCTION)
#define XBT_HERE LOG0(xbt_log_priority_trace, "-- was here")
#endif /* ! _XBT_LOG_H_ */
