<i>severity</i>).
Empirically, the user can specify that he wants to see every debugging message
-of GRAS while only being interested into the messages at level "error" or
+of MSG while only being interested into the messages at level "error" or
higher about the XBT internals.
\subsection log_app 1.3 Message appenders
Here is an example of the most basic type of macro. This is a logging
request with priority <i>warning</i>.
-<code>XBT_CLOG(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5,
+<code>XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5,
"oops");</code>
A logging request is said to be enabled if its priority is higher than or
}
\endverbatim
-Another example can be found in the relevant part of the GRAS tutorial:
-\ref GRAS_tut_tour_logs.
-
\section log_user 3. User interface
\section log_use_conf 3.1 Configuration
Although rarely done, it is possible to configure the logs during
program initialization by invoking the xbt_log_control_set() method
manually. A more conventional way is to use the --log command line
-argument. xbt_init() (called by MSG_init(), gras_init() and friends)
+argument. xbt_init() (called by MSG_init() and friends)
checks and deals properly with such arguments.
-The following command line arguments exist, but are deprecated and
-may disappear in the future: --xbt-log, --gras-log, --msg-log and
---surf-log.
-
\subsection log_use_conf_thres 3.1.1 Threshold configuration
The most common setting is to control which logging event will get
- %%p: Priority name (LOG4J compatible)
- %%h: Hostname (SimGrid extension)
- - %%P: Process name (SimGrid extension)
+ - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank)
- %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory)
- %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)
There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which
causes all logging requests with a lower priority to be optimized to 0 cost
-by the compiler. By setting it to gras_log_priority_infinite, all logging
+by the compiler. By setting it to xbt_log_priority_infinite, all logging
requests are statically disabled at compile time and cost nothing. Released executables
<i>might</i> be compiled with (note that it will prevent users to debug their problems)
-\verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim
+\verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim
Compiling with the \verbatim-DNLOG\endverbatim option disables all logging
requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables
0 /* additivity */
};
-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_CATEGORY(mc, "All MC categories");
-XBT_LOG_NEW_CATEGORY(bindings, "All bindings categories");
-
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt,
"Loggings from the logging mechanism itself");
/* Connect our log channels: that must be done manually under windows */
/* Also permit that they are correctly listed by xbt_log_help_categories() */
- /* gras */
- XBT_LOG_CONNECT(gras_modules, gras);
- XBT_LOG_CONNECT(gras_msg, gras);
- XBT_LOG_CONNECT(gras_msg_read, gras_msg);
- XBT_LOG_CONNECT(gras_msg_rpc, gras_msg);
- XBT_LOG_CONNECT(gras_timer, gras);
- XBT_LOG_CONNECT(gras_virtu, gras);
- XBT_LOG_CONNECT(gras_virtu_emul, gras_virtu);
- XBT_LOG_CONNECT(gras_virtu_process, gras_virtu);
-
/* xbt */
- XBT_LOG_CONNECT(graphxml_parse, xbt);
- XBT_LOG_CONNECT(log, xbt);
- XBT_LOG_CONNECT(module, xbt);
- XBT_LOG_CONNECT(peer, xbt);
- XBT_LOG_CONNECT(strbuff, xbt);
- XBT_LOG_CONNECT(xbt_cfg, xbt);
- XBT_LOG_CONNECT(xbt_dict, xbt);
- XBT_LOG_CONNECT(xbt_dict_cursor, xbt_dict);
- XBT_LOG_CONNECT(xbt_dict_elm, xbt_dict);
+ XBT_LOG_CONNECT(xbt);
+ XBT_LOG_CONNECT(graphxml_parse);
+ XBT_LOG_CONNECT(log);
+#if HAVE_MMAP
+ XBT_LOG_CONNECT(mm_diff);
+#endif
+ XBT_LOG_CONNECT(module);
+ XBT_LOG_CONNECT(peer);
+ XBT_LOG_CONNECT(replay);
+ XBT_LOG_CONNECT(strbuff);
+ XBT_LOG_CONNECT(xbt_cfg);
+ XBT_LOG_CONNECT(xbt_dict);
+ XBT_LOG_CONNECT(xbt_dict_cursor);
+ XBT_LOG_CONNECT(xbt_dict_elm);
#ifdef XBT_USE_DEPRECATED
- XBT_LOG_CONNECT(xbt_dict_multi, xbt_dict);
+ XBT_LOG_CONNECT(xbt_dict_multi);
#endif
- XBT_LOG_CONNECT(xbt_ddt, xbt);
- XBT_LOG_CONNECT(xbt_ddt_cbps, xbt_ddt);
- XBT_LOG_CONNECT(xbt_ddt_convert, xbt_ddt);
- XBT_LOG_CONNECT(xbt_ddt_create, xbt_ddt);
- XBT_LOG_CONNECT(xbt_ddt_exchange, xbt_ddt);
- XBT_LOG_CONNECT(xbt_ddt_parse, xbt_ddt);
- XBT_LOG_CONNECT(xbt_ddt_lexer, xbt_ddt_parse);
- XBT_LOG_CONNECT(xbt_dyn, xbt);
- XBT_LOG_CONNECT(xbt_ex, xbt);
- XBT_LOG_CONNECT(xbt_fifo, xbt);
- XBT_LOG_CONNECT(xbt_graph, xbt);
- XBT_LOG_CONNECT(xbt_matrix, xbt);
- XBT_LOG_CONNECT(xbt_parmap, xbt);
- XBT_LOG_CONNECT(xbt_parmap_unit, xbt_parmap);
- XBT_LOG_CONNECT(xbt_queue, xbt);
- XBT_LOG_CONNECT(xbt_set, xbt);
- XBT_LOG_CONNECT(xbt_sync_os, xbt);
- XBT_LOG_CONNECT(xbt_trp, xbt);
- XBT_LOG_CONNECT(xbt_trp_meas, xbt_trp);
+ XBT_LOG_CONNECT(xbt_dyn);
+ XBT_LOG_CONNECT(xbt_ex);
+ XBT_LOG_CONNECT(xbt_fifo);
+ XBT_LOG_CONNECT(xbt_graph);
+ XBT_LOG_CONNECT(xbt_heap);
+ XBT_LOG_CONNECT(xbt_lib);
+ XBT_LOG_CONNECT(xbt_mallocator);
+ XBT_LOG_CONNECT(xbt_matrix);
+ XBT_LOG_CONNECT(xbt_parmap);
+ XBT_LOG_CONNECT(xbt_parmap_unit);
+ XBT_LOG_CONNECT(xbt_queue);
+ XBT_LOG_CONNECT(xbt_set);
+ XBT_LOG_CONNECT(xbt_sync);
+ XBT_LOG_CONNECT(xbt_sync_os);
#ifdef simgrid_EXPORTS
/* The following categories are only defined in libsimgrid */
- /* gras (sg) */
- XBT_LOG_CONNECT(gras_trp_sg, gras_trp);
+ /* bindings */
+#ifdef HAVE_LUA
+ XBT_LOG_CONNECT(bindings);
+ XBT_LOG_CONNECT(lua);
+ XBT_LOG_CONNECT(lua_comm);
+ XBT_LOG_CONNECT(lua_host);
+ XBT_LOG_CONNECT(lua_platf);
+ XBT_LOG_CONNECT(lua_process);
+ XBT_LOG_CONNECT(lua_state_cloner);
+ XBT_LOG_CONNECT(lua_task);
+ XBT_LOG_CONNECT(lua_utils);
+#endif
+
+ /* instr */
+#ifdef HAVE_TRACING
+ XBT_LOG_CONNECT(instr);
+ XBT_LOG_CONNECT(instr_api);
+ XBT_LOG_CONNECT(instr_config);
+ XBT_LOG_CONNECT(instr_msg);
+ XBT_LOG_CONNECT(instr_msg_process);
+ XBT_LOG_CONNECT(instr_paje_containers);
+ XBT_LOG_CONNECT(instr_paje_header);
+ XBT_LOG_CONNECT(instr_paje_trace);
+ XBT_LOG_CONNECT(instr_paje_types);
+ XBT_LOG_CONNECT(instr_paje_values);
+ XBT_LOG_CONNECT(instr_resource);
+ XBT_LOG_CONNECT(instr_routing);
+ XBT_LOG_CONNECT(instr_surf);
+#endif
/* jedule */
#ifdef HAVE_JEDULE
- XBT_LOG_CONNECT(jed_sd, jedule);
+ XBT_LOG_CONNECT(jedule);
+ XBT_LOG_CONNECT(jed_out);
+ XBT_LOG_CONNECT(jed_sd);
#endif
- /* msg */
- XBT_LOG_CONNECT(msg_gos, msg);
- XBT_LOG_CONNECT(msg_kernel, msg);
- XBT_LOG_CONNECT(msg_mailbox, msg);
- XBT_LOG_CONNECT(msg_process, msg);
+ /* mc */
+#ifdef HAVE_MC
+ XBT_LOG_CONNECT(mc);
+ XBT_LOG_CONNECT(mc_checkpoint);
+ XBT_LOG_CONNECT(mc_compare);
+ XBT_LOG_CONNECT(mc_dpor);
+ XBT_LOG_CONNECT(mc_global);
+ XBT_LOG_CONNECT(mc_liveness);
+ XBT_LOG_CONNECT(mc_memory);
+ XBT_LOG_CONNECT(mc_memory_map);
+ XBT_LOG_CONNECT(mc_request);
+#endif
- /* sd */
- XBT_LOG_CONNECT(sd_kernel, sd);
- XBT_LOG_CONNECT(sd_task, sd);
- XBT_LOG_CONNECT(sd_workstation, sd);
+ /* msg */
+ XBT_LOG_CONNECT(msg);
+ XBT_LOG_CONNECT(msg_action);
+ XBT_LOG_CONNECT(msg_gos);
+ XBT_LOG_CONNECT(msg_io);
+ XBT_LOG_CONNECT(msg_kernel);
+ XBT_LOG_CONNECT(msg_mailbox);
+ XBT_LOG_CONNECT(msg_new_API);
+ XBT_LOG_CONNECT(msg_process);
+ XBT_LOG_CONNECT(msg_task);
+ XBT_LOG_CONNECT(msg_vm);
+
+ /* simdag */
+ XBT_LOG_CONNECT(sd);
+ XBT_LOG_CONNECT(sd_daxparse);
+#ifdef HAVE_GRAPHVIZ
+ XBT_LOG_CONNECT(sd_dotparse);
+#endif
+ XBT_LOG_CONNECT(sd_kernel);
+ XBT_LOG_CONNECT(sd_task);
+ XBT_LOG_CONNECT(sd_workstation);
/* simix */
- XBT_LOG_CONNECT(simix_context, simix);
- XBT_LOG_CONNECT(simix_deployment, simix);
- XBT_LOG_CONNECT(simix_environment, simix);
- XBT_LOG_CONNECT(simix_host, simix);
- XBT_LOG_CONNECT(simix_kernel, simix);
- XBT_LOG_CONNECT(simix_process, simix);
- XBT_LOG_CONNECT(simix_synchro, simix);
+ XBT_LOG_CONNECT(simix);
+ XBT_LOG_CONNECT(simix_context);
+ XBT_LOG_CONNECT(simix_deployment);
+ XBT_LOG_CONNECT(simix_environment);
+ XBT_LOG_CONNECT(simix_host);
+ XBT_LOG_CONNECT(simix_io);
+ XBT_LOG_CONNECT(simix_kernel);
+ XBT_LOG_CONNECT(simix_network);
+ XBT_LOG_CONNECT(simix_new_api);
+ XBT_LOG_CONNECT(simix_process);
+ XBT_LOG_CONNECT(simix_smurf);
+ XBT_LOG_CONNECT(simix_synchro);
+
+ /* smpi */
+ /* SMPI categories are connected in smpi_global.c */
/* surf */
- XBT_LOG_CONNECT(surf_config, surf);
- XBT_LOG_CONNECT(surf_cpu, surf);
- XBT_LOG_CONNECT(surf_kernel, surf);
- XBT_LOG_CONNECT(surf_lagrange, surf);
- XBT_LOG_CONNECT(surf_lagrange_dichotomy, surf_lagrange);
- XBT_LOG_CONNECT(surf_maxmin, surf);
- XBT_LOG_CONNECT(surf_network, surf);
+ XBT_LOG_CONNECT(surf);
+ XBT_LOG_CONNECT(platf_generator);
+ XBT_LOG_CONNECT(random);
+ XBT_LOG_CONNECT(surf_config);
+ XBT_LOG_CONNECT(surf_cpu);
+ XBT_LOG_CONNECT(surf_cpu_ti);
+ XBT_LOG_CONNECT(surf_kernel);
+ XBT_LOG_CONNECT(surf_lagrange);
+ XBT_LOG_CONNECT(surf_lagrange_dichotomy);
+ XBT_LOG_CONNECT(surf_maxmin);
+ XBT_LOG_CONNECT(surf_network);
+ XBT_LOG_CONNECT(surf_new_model);
#ifdef HAVE_GTNETS
- XBT_LOG_CONNECT(surf_network_gtnets, surf);
+ XBT_LOG_CONNECT(surf_network_gtnets);
+ XBT_LOG_CONNECT(surf_network_gtnets_interface);
+ XBT_LOG_CONNECT(surf_network_gtnets_simulator);
+ XBT_LOG_CONNECT(surf_network_gtnets_topology);
+#endif
+#ifdef HAVE_NS3
+ XBT_LOG_CONNECT(surf_network_ns3);
+ XBT_LOG_CONNECT(interface_ns3);
+ XBT_LOG_CONNECT(simulator_ns3);
#endif
- XBT_LOG_CONNECT(surf_parse, surf);
- XBT_LOG_CONNECT(surf_route, surf);
- XBT_LOG_CONNECT(surf_trace, surf);
- XBT_LOG_CONNECT(surf_workstation, surf);
+ XBT_LOG_CONNECT(surf_parse);
+ XBT_LOG_CONNECT(surf_route);
+ XBT_LOG_CONNECT(surf_routing_generic);
+ XBT_LOG_CONNECT(surf_route_cluster);
+ XBT_LOG_CONNECT(surf_route_dijkstra);
+ XBT_LOG_CONNECT(surf_route_floyd);
+ XBT_LOG_CONNECT(surf_route_full);
+ XBT_LOG_CONNECT(surf_route_none);
+ XBT_LOG_CONNECT(surf_route_rulebased);
+ XBT_LOG_CONNECT(surf_route_vivaldi);
+ XBT_LOG_CONNECT(surf_storage);
+ XBT_LOG_CONNECT(surf_trace);
+ XBT_LOG_CONNECT(surf_workstation);
#endif /* simgrid_EXPORTS */
}
+static void xbt_log_help(void);
+static void xbt_log_help_categories(void);
+
/** @brief Get all logging settings from the command line
*
* xbt_log_control_set() is called on each string we got from cmd line
*/
void xbt_log_init(int *argc, char **argv)
{
+ unsigned help_requested = 0; /* 1: logs; 2: categories */
int i, j;
char *opt;
// _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */
+ xbt_log_connect_categories();
+
/* Set logs and init log submodule */
for (j = i = 1; i < *argc; i++) {
- if (!strncmp(argv[i], "--log=", strlen("--log=")) ||
- !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="))) {
-
- if (strncmp(argv[i], "--log=", strlen("--log=")))
- XBT_WARN
- ("Option %.*s is deprecated and will disapear in the future. Use --log instead.",
- (int) (strchr(argv[i], '=') - argv[i]), argv[i]);
-
+ if (!strncmp(argv[i], "--log=", strlen("--log="))) {
opt = strchr(argv[i], '=');
opt++;
xbt_log_control_set(opt);
XBT_DEBUG("Did apply '%s' as log setting", opt);
+ } else if (!strcmp(argv[i], "--help-logs")) {
+ help_requested |= 1;
+ } else if (!strcmp(argv[i], "--help-log-categories")) {
+ help_requested |= 2;
} else {
argv[j++] = argv[i];
}
*argc = j;
}
- xbt_log_connect_categories();
+ if (help_requested) {
+ if (help_requested & 1)
+ xbt_log_help();
+ if (help_requested & 2)
+ xbt_log_help_categories();
+ exit(0);
+ }
}
static void log_cat_exit(xbt_log_category_t cat)
cpp = cpp->nextSibling;
}
- XBT_DEBUG("Childs of %s: %s; nextSibling: %s",
+ XBT_DEBUG("Children of %s: %s; nextSibling: %s",
category->parent->name, res,
(category->parent->nextSibling ?
category->parent->nextSibling->name : "none"));
cat->additivity = additivity;
}
-void xbt_log_help(void)
+static void xbt_log_help(void)
{
printf(
"Description of the logging output:\n"
"\n"
" -> %%d: date (UNIX-like epoch)\n"
" -> %%r: application age (time elapsed since the beginning of the application)\n"
+"\n"
+" Miscellaneous:\n"
+" --help-log-categories Display the current hierarchy of log categories.\n"
+" --log=no_loc Don't print file names in messages (for tesh tests).\n"
"\n"
);
}
xbt_free(child_prefix);
}
-void xbt_log_help_categories(void)
+static void xbt_log_help_categories(void)
{
printf("Current log category hierarchy:\n");
xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");