#include <ctype.h>
#include <stdio.h> /* snprintf */
#include <stdlib.h> /* snprintf */
-#include "gras_config.h" /* to get a working stdarg.h */
+
#include "portable.h" /* to get a working stdarg.h */
#include "xbt_modinter.h"
#include "xbt/misc.h"
#include "xbt/ex.h"
#include "xbt/sysdep.h"
-#include "xbt/log.h"
+#include <xbt/log.h>
#include "xbt/dynar.h"
/** \addtogroup XBT_log
tree using \ref XBT_LOG_NEW_DEFAULT_SUBCATEGORY.
Then, logging should be done with the DEBUG<n>, VERB<n>, INFO<n>, WARN<n>,
-ERROR<n> or CRITICAL<n> macro families. For each group, there is 6 different
-macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and DEBUG5), only differing
-in the number of arguments passed along the format. This is because we want
-SimGrid itself to keep compilable on ancient compiler not supporting variable
-number of arguments to macros. But we should provide a macro simpler to use for
-the users not interested in SP3 machines (FIXME).
-
+ERROR<n> or CRITICAL<n> macro families (such as #DEBUG10, #VERB6,
+#INFO8, #WARN6, #ERROR6 and #CRITICAL6). For each group, there is at
+least 6 different macros (like DEBUG0, DEBUG1, DEBUG2, DEBUG3, DEBUG4 and
+DEBUG5), only differing in the number of arguments passed along the format.
+This is because we want SimGrid itself to keep compilable on ancient
+compiler not supporting variable number of arguments to macros. But we
+should provide a macro simpler to use for the users not interested in SP3
+machines (FIXME).
+
Under GCC, these macro check there arguments the same way than printf does. So,
if you compile with -Wall, the folliwing code will issue a warning:
<code>DEBUG2("Found %s (id %f)", some_string, a_double)</code>
+If you want to specify the category to log onto (for example because you
+have more than one category per file, add a C before the name of the log
+producing macro (ie, use #CDEBUG10, #CVERB6, #CINFO8, #CWARN6, #CERROR6 and
+#CCRITICAL6 and friends), and pass the category name as first argument.
+
+The TRACE priority is not used the same way than the other. You should use
+the #XBT_IN, XBT_IN<n> (up to #XBT_IN5), #XBT_OUT and #XBT_HERE macros
+instead.
+
\section log_API_example 2.5 Example of use
Here is a more complete example:
} s_xbt_log_setting_t,*xbt_log_setting_t;
static xbt_dynar_t xbt_log_settings=NULL;
+
static void _free_setting(void *s) {
xbt_log_setting_t set=(xbt_log_setting_t)s;
if (set) {
XBT_LOG_NEW_CATEGORY(xbt,"All XBT categories (simgrid toolbox)");
XBT_LOG_NEW_CATEGORY(surf,"All SURF categories");
XBT_LOG_NEW_CATEGORY(msg,"All MSG categories");
+XBT_LOG_NEW_CATEGORY(simix,"All SIMIX categories");
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log,xbt,"Loggings from the logging mechanism itself");
void xbt_log_init(int *argc,char **argv) {
- int i,j;
- char *opt;
-
- /* Set logs and init log submodule */
- for (i=1; i<*argc; i++) {
- if (!strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
- !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
- !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
- !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))) {
- opt=strchr(argv[i],'=');
- opt++;
- xbt_log_control_set(opt);
- DEBUG1("Did apply '%s' as log setting",opt);
- /*remove this from argv*/
- for (j=i+1; j<*argc; j++) {
- argv[j-1] = argv[j];
- }
- argv[j-1] = NULL;
- (*argc)--;
- i--; /* compensate effect of next loop incrementation */
- }
- }
+ int i,j;
+ char *opt;
+
+ /* Set logs and init log submodule */
+ for (i=1; i<*argc; i++){
+ if (!strncmp(argv[i],"--gras-log=",strlen("--gras-log=")) ||
+ !strncmp(argv[i],"--surf-log=",strlen("--surf-log=")) ||
+ !strncmp(argv[i],"--msg-log=",strlen("--msg-log=")) ||
+ !strncmp(argv[i],"--simix-log=",strlen("--simix-log=")) ||
+ !strncmp(argv[i],"--xbt-log=",strlen("--xbt-log="))){
+
+ opt=strchr(argv[i],'=');
+ opt++;
+ xbt_log_control_set(opt);
+ DEBUG1("Did apply '%s' as log setting",opt);
+ /*remove this from argv*/
+
+ for (j=i+1; j<*argc; j++){
+ argv[j-1] = argv[j];
+ }
+
+ argv[j-1] = NULL;
+ (*argc)--;
+ i--; /* compensate effect of next loop incrementation */
+ }
+ }
}
void xbt_log_exit(void) {
int cursor;
xbt_log_setting_t setting=NULL;
int found = 0;
-
+ s_xbt_log_event_t _log_ev;
+
+
if (!xbt_log_settings)
return;
xbt_assert1(setting->catname,"NULL setting(=%p)->catname",(void*)setting);
if (!strcmp(setting->catname,cat->name)) {
+
+
found = 1;
xbt_log_threshold_set(cat, setting->thresh);
xbt_dynar_cursor_rm(xbt_log_settings,&cursor);
+
if (cat->threshold <= xbt_log_priority_debug) {
- s_xbt_log_event_t _log_ev =
- {cat,xbt_log_priority_debug,__FILE__,_XBT_FUNCTION,__LINE__};
+ _log_ev.cat = cat;
+ _log_ev.priority = xbt_log_priority_debug;
+ _log_ev.fileName = __FILE__ ;
+ _log_ev.functionName = _XBT_FUNCTION ;
+ _log_ev.lineNum = __LINE__ ;
+
_xbt_log_event_log(&_log_ev,
"Apply settings for category '%s': set threshold to %s (=%d)",
- cat->name,
+ cat->name,
xbt_log_priority_names[cat->threshold], cat->threshold);
}
}
+
}
+
if (!found && cat->threshold <= xbt_log_priority_verbose) {
- s_xbt_log_event_t _log_ev =
- {cat,xbt_log_priority_verbose,__FILE__,_XBT_FUNCTION,__LINE__};
+
+ _log_ev.cat = cat;
+ _log_ev.priority = xbt_log_priority_verbose;
+ _log_ev.fileName = __FILE__ ;
+ _log_ev.functionName = _XBT_FUNCTION ;
+ _log_ev.lineNum = __LINE__ ;
+
_xbt_log_event_log(&_log_ev,
"Category '%s': inherited threshold = %s (=%d)",
cat->name,
xbt_log_priority_names[cat->threshold], cat->threshold);
}
+
+
}
va_end(ev->ap);
}
-static void _cat_init(xbt_log_category_t category) {
- if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
- category->threshold = xbt_log_priority_info;
- category->appender = xbt_log_default_appender;
- } else {
- xbt_log_parent_set(category, category->parent);
- }
+static void _cat_init(xbt_log_category_t category)
+{
+
+ if(category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)){
+ category->threshold = xbt_log_priority_info;
+ category->appender = xbt_log_default_appender;
+ }
+ else
+ {
+ #if (defined(_WIN32) && !defined(DLL_STATIC))
+ if(!category->parent)
+ category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
+ #endif
+
+ xbt_log_parent_set(category, category->parent);
+ }
+
_apply_control(category);
+
}
/*
* initialization.
* Also resets threshold to inherited!
*/
-int _xbt_log_cat_init(e_xbt_log_priority_t priority,
- xbt_log_category_t category) {
+int _xbt_log_cat_init(e_xbt_log_priority_t priority,xbt_log_category_t category)
+{
- _cat_init(category);
-
- return priority >= category->threshold;
+ _cat_init(category);
+
+ return priority >= category->threshold;
}
-void xbt_log_parent_set(xbt_log_category_t cat,
- xbt_log_category_t parent) {
-
- xbt_assert0(cat,"NULL category to be given a parent");
- xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
-
- /* unlink from current parent */
- if (cat->threshold != xbt_log_priority_uninitialized) {
- xbt_log_category_t* cpp = &parent->firstChild;
- while(*cpp != cat && *cpp != NULL) {
- cpp = &(*cpp)->nextSibling;
- }
- xbt_assert(*cpp == cat);
- *cpp = cat->nextSibling;
- }
-
- /* Set new parent */
- cat->parent = parent;
- cat->nextSibling = parent->firstChild;
- parent->firstChild = cat;
+void xbt_log_parent_set(xbt_log_category_t cat,xbt_log_category_t parent)
+{
+ xbt_assert0(cat,"NULL category to be given a parent");
+ xbt_assert1(parent,"The parent category of %s is NULL",cat->name);
+
+ /*
+ * if the threshold is initialized
+ * unlink from current parent
+ */
+ if(cat->threshold != xbt_log_priority_uninitialized){
- /* Make sure parent is initialized */
- if (parent->threshold == xbt_log_priority_uninitialized) {
- _cat_init(parent);
- }
-
- /* Reset priority */
- cat->threshold = parent->threshold;
- cat->isThreshInherited = 1;
+ xbt_log_category_t* cpp = &parent->firstChild;
+
+ while(*cpp != cat && *cpp != NULL) {
+ cpp = &(*cpp)->nextSibling;
+ }
+
+ xbt_assert(*cpp == cat);
+ *cpp = cat->nextSibling;
+ }
+
+ cat->parent = parent;
+ cat->nextSibling = parent->firstChild;
+
+ parent->firstChild = cat;
+
+ if (parent->threshold == xbt_log_priority_uninitialized){
+
+ _cat_init(parent);
+ }
+
+ cat->threshold = parent->threshold;
+
+ cat->isThreshInherited = 1;
+
} /* log_setParent */
static void _set_inherited_thresholds(xbt_log_category_t cat) {
}
DEBUG1("New priority name = %s",neweq);
- for (i=0; i<xbt_log_priority_infinite-1; i++) {
+ for (i=0; i<xbt_log_priority_infinite; i++) {
if (!strncmp(xbt_log_priority_names[i],neweq,p-eq)) {
DEBUG1("This is priority %d",i);
break;
}
}
- if (i<xbt_log_priority_infinite-1) {
+ if (i<xbt_log_priority_infinite) {
set->thresh= (e_xbt_log_priority_t) i;
} else {
xbt_assert1(FALSE,"Unknown priority name: %s",eq+1);
p=strrchr(cs,' ');
if (p) {
*p='\0';
- *p++;
+ p++;
} else {
p=cs;
done = 1;
} CATCH(e) {
if (e.category != not_found_error)
RETHROW;
- xbt_ex_free(&e);
+ xbt_ex_free(e);
found = 0;
DEBUG0("Store for further application");
