s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
- "root",
+ "root", "The common ancestor for all categories",
0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
0 /* isThreshInherited */ ,
NULL /* appender */ , NULL /* layout */ ,
{
cat->additivity = additivity;
}
+
+void xbt_log_help(void)
+{
+ printf(
+"Description of the logging output:\n"
+"\n"
+" Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
+" CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
+" PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
+" -> trace: enter and return of some functions\n"
+" -> debug: crufty output\n"
+" -> verbose: verbose output for the user wanting more\n"
+" -> info: output about the regular functionning\n"
+" -> warning: minor issue encountered\n"
+" -> error: issue encountered\n"
+" -> critical: major issue encountered\n"
+"\n"
+" Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
+" OPTIONS may be:\n"
+" -> %%%%: the %% char\n"
+" -> %%n: platform-dependent line separator (LOG4J compatible)\n"
+" -> %%e: plain old space (SimGrid extension)\n"
+"\n"
+" -> %%m: user-provided message\n"
+"\n"
+" -> %%c: Category name (LOG4J compatible)\n"
+" -> %%p: Priority name (LOG4J compatible)\n"
+"\n"
+" -> %%h: Hostname (SimGrid extension)\n"
+" -> %%P: Process name (SimGrid extension)\n"
+" -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
+" -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
+"\n"
+" -> %%F: file name where the log event was raised (LOG4J compatible)\n"
+" -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
+" -> %%L: line number where the log event was raised (LOG4J compatible)\n"
+" -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
+" Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
+"\n"
+" -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
+" backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
+" -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
+"\n"
+" -> %%d: date (UNIX-like epoch)\n"
+" -> %%r: application age (time elapsed since the beginning of the application)\n"
+"\n"
+ );
+}
+
+static int xbt_log_cat_cmp(const void *pa, const void *pb)
+{
+ xbt_log_category_t a = *(xbt_log_category_t *)pa;
+ xbt_log_category_t b = *(xbt_log_category_t *)pb;
+ return strcmp(a->name, b->name);
+}
+
+static void xbt_log_help_categories_rec(xbt_log_category_t category,
+ const char *prefix)
+{
+ char *this_prefix;
+ char *child_prefix;
+ xbt_dynar_t dynar;
+ unsigned i;
+ xbt_log_category_t cat;
+
+ if (!category)
+ return;
+
+ if (category->parent) {
+ this_prefix = bprintf("%s \\_ ", prefix);
+ child_prefix = bprintf("%s | ", prefix);
+ } else {
+ this_prefix = bprintf("%s", prefix);
+ child_prefix = bprintf("%s", prefix);
+ }
+
+ dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
+ for (cat = category ; cat != NULL; cat = cat->nextSibling)
+ xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
+
+ xbt_dynar_sort(dynar, xbt_log_cat_cmp);
+
+ for (i = 0; i < xbt_dynar_length(dynar); i++) {
+ if (i == xbt_dynar_length(dynar) - 1 && category->parent)
+ *strrchr(child_prefix, '|') = ' ';
+ cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
+ printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
+ xbt_log_help_categories_rec(cat->firstChild, child_prefix);
+ }
+
+ xbt_dynar_free(&dynar);
+ xbt_free(this_prefix);
+ xbt_free(child_prefix);
+}
+
+void xbt_log_help_categories(void)
+{
+ printf("Current log category hierarchy:\n");
+ xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");
+ printf("\n");
+}
