/* 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. */
+/** @addtogroup XBT_log
+ * @brief A generic logging facility in the spirit of log4j (grounding feature)
+ *
+ *
+ */
+
+/** \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 was automatically extracted from the source code by
+ * the src/xbt_log_extract_hierarchy utility.
+ *
+ * You can thus be certain that it is uptodate, but it may somehow
+ * lack a final manual touch.
+ * Anyway, nothing's perfect ;)
+ */
+
/* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
printf function. Useful to debug the logging facilities themselves */
#undef XBT_LOG_MAYDAY
* 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;
/**
- * \def XBT_LOG_STATIC_THRESHOLD:
- * \ingroup XBT_log
+ * @def XBT_LOG_STATIC_THRESHOLD
+ * @ingroup XBT_log
*
* All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at
* compile time, i.e., compiled out.
/* 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.
* \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 \
#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_ */
