1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2017. The SimGrid Team.
4 * All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
11 #include <stdio.h> /* snprintf */
12 #include <stdlib.h> /* snprintf */
14 #include "src/internal_config.h"
16 #include "src/xbt_modinter.h"
18 #include "src/xbt/log_private.h"
19 #include "xbt/asserts.h"
20 #include "xbt/dynar.h"
24 #include "xbt/sysdep.h"
25 #include "xbt/xbt_os_thread.h"
27 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
28 static xbt_os_mutex_t log_cat_init_mutex = NULL;
30 /** \addtogroup XBT_log
32 * For more information, please refer to @ref outcomes_logs Section.
35 xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
36 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
41 e_xbt_log_priority_t thresh;
43 xbt_log_appender_t appender;
44 } s_xbt_log_setting_t;
46 typedef s_xbt_log_setting_t* xbt_log_setting_t;
48 static xbt_dynar_t xbt_log_settings = NULL;
50 static void _free_setting(void *s)
52 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
60 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting);
62 const char *xbt_log_priority_names[8] = {
73 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
74 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
75 "root", "The common ancestor for all categories",
76 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
77 0 /* isThreshInherited */ ,
78 NULL /* appender */ , NULL /* layout */ ,
82 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
84 /* create the default appender and install it in the root category,
85 which were already created (damnit. Too slow little beetle) */
86 void xbt_log_preinit(void)
88 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
89 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
90 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
91 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
92 log_cat_init_mutex = xbt_os_mutex_init();
95 static void xbt_log_connect_categories(void)
97 /* Connect our log channels: that must be done manually under windows */
98 /* Also permit that they are correctly listed by xbt_log_help_categories() */
101 XBT_LOG_CONNECT(xbt);
102 XBT_LOG_CONNECT(log);
103 XBT_LOG_CONNECT(module);
104 XBT_LOG_CONNECT(replay);
105 XBT_LOG_CONNECT(xbt_cfg);
106 XBT_LOG_CONNECT(xbt_dict);
107 XBT_LOG_CONNECT(xbt_dict_cursor);
108 XBT_LOG_CONNECT(xbt_dict_elm);
109 XBT_LOG_CONNECT(xbt_dyn);
110 XBT_LOG_CONNECT(xbt_ex);
111 XBT_LOG_CONNECT(xbt_backtrace);
112 XBT_LOG_CONNECT(xbt_exception);
113 XBT_LOG_CONNECT(xbt_graph);
114 XBT_LOG_CONNECT(xbt_heap);
115 XBT_LOG_CONNECT(xbt_mallocator);
116 XBT_LOG_CONNECT(xbt_memory_map);
117 XBT_LOG_CONNECT(xbt_parmap);
118 XBT_LOG_CONNECT(xbt_sync);
119 XBT_LOG_CONNECT(xbt_sync_os);
121 #ifdef simgrid_EXPORTS
122 /* The following categories are only defined in libsimgrid */
126 XBT_LOG_CONNECT(lua);
127 XBT_LOG_CONNECT(lua_host);
128 XBT_LOG_CONNECT(lua_platf);
129 XBT_LOG_CONNECT(lua_debug);
133 XBT_LOG_CONNECT(instr);
134 XBT_LOG_CONNECT(instr_api);
135 XBT_LOG_CONNECT(instr_config);
136 XBT_LOG_CONNECT(instr_msg);
137 XBT_LOG_CONNECT(instr_msg_process);
138 XBT_LOG_CONNECT(instr_paje_containers);
139 XBT_LOG_CONNECT(instr_paje_header);
140 XBT_LOG_CONNECT(instr_paje_trace);
141 XBT_LOG_CONNECT(instr_paje_types);
142 XBT_LOG_CONNECT(instr_paje_values);
143 XBT_LOG_CONNECT(instr_resource);
144 XBT_LOG_CONNECT(instr_routing);
145 XBT_LOG_CONNECT(instr_surf);
148 #if SIMGRID_HAVE_JEDULE
149 XBT_LOG_CONNECT(jedule);
150 XBT_LOG_CONNECT(jed_sd);
156 XBT_LOG_CONNECT(mc_checkpoint);
157 XBT_LOG_CONNECT(mc_comm_determinism);
158 XBT_LOG_CONNECT(mc_compare);
159 XBT_LOG_CONNECT(mc_dwarf);
160 XBT_LOG_CONNECT(mc_hash);
161 XBT_LOG_CONNECT(mc_liveness);
162 XBT_LOG_CONNECT(mc_memory);
163 XBT_LOG_CONNECT(mc_page_snapshot);
164 XBT_LOG_CONNECT(mc_request);
165 XBT_LOG_CONNECT(mc_safety);
166 XBT_LOG_CONNECT(mc_VisitedState);
167 XBT_LOG_CONNECT(mc_client);
168 XBT_LOG_CONNECT(mc_client_api);
169 XBT_LOG_CONNECT(mc_comm_pattern);
170 XBT_LOG_CONNECT(mc_process);
171 XBT_LOG_CONNECT(mc_protocol);
172 XBT_LOG_CONNECT(mc_Channel);
173 XBT_LOG_CONNECT(mc_ModelChecker);
174 XBT_LOG_CONNECT(mc_RegionSnaphot);
175 XBT_LOG_CONNECT(mc_Session);
176 XBT_LOG_CONNECT(mc_state);
178 XBT_LOG_CONNECT(mc_global);
179 XBT_LOG_CONNECT(mc_config);
180 XBT_LOG_CONNECT(mc_record);
183 XBT_LOG_CONNECT(msg);
184 XBT_LOG_CONNECT(msg_action);
185 XBT_LOG_CONNECT(msg_gos);
186 XBT_LOG_CONNECT(msg_io);
187 XBT_LOG_CONNECT(msg_kernel);
188 XBT_LOG_CONNECT(msg_mailbox);
189 XBT_LOG_CONNECT(msg_process);
190 XBT_LOG_CONNECT(msg_synchro);
191 XBT_LOG_CONNECT(msg_task);
192 XBT_LOG_CONNECT(msg_vm);
195 XBT_LOG_CONNECT(s4u);
196 XBT_LOG_CONNECT(s4u_activity);
197 XBT_LOG_CONNECT(s4u_actor);
198 XBT_LOG_CONNECT(s4u_netzone);
199 XBT_LOG_CONNECT(s4u_channel);
200 XBT_LOG_CONNECT(s4u_comm);
201 XBT_LOG_CONNECT(s4u_file);
202 XBT_LOG_CONNECT(s4u_link);
203 XBT_LOG_CONNECT(s4u_vm);
206 XBT_LOG_CONNECT(sg_host);
210 XBT_LOG_CONNECT(sd_daxparse);
212 XBT_LOG_CONNECT(sd_dotparse);
214 XBT_LOG_CONNECT(sd_kernel);
215 XBT_LOG_CONNECT(sd_task);
218 XBT_LOG_CONNECT(simix);
219 XBT_LOG_CONNECT(simix_context);
220 XBT_LOG_CONNECT(simix_deployment);
221 XBT_LOG_CONNECT(simix_environment);
222 XBT_LOG_CONNECT(simix_host);
223 XBT_LOG_CONNECT(simix_io);
224 XBT_LOG_CONNECT(simix_kernel);
225 XBT_LOG_CONNECT(simix_mailbox);
226 XBT_LOG_CONNECT(simix_network);
227 XBT_LOG_CONNECT(simix_process);
228 XBT_LOG_CONNECT(simix_popping);
229 XBT_LOG_CONNECT(simix_synchro);
232 /* SMPI categories are connected in smpi_global.c */
235 XBT_LOG_CONNECT(surf);
236 XBT_LOG_CONNECT(surf_config);
237 XBT_LOG_CONNECT(surf_cpu);
238 XBT_LOG_CONNECT(surf_cpu_cas);
239 XBT_LOG_CONNECT(surf_cpu_ti);
240 XBT_LOG_CONNECT(surf_energy);
241 XBT_LOG_CONNECT(surf_file);
242 XBT_LOG_CONNECT(surf_kernel);
243 XBT_LOG_CONNECT(surf_lagrange);
244 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
245 XBT_LOG_CONNECT(surf_maxmin);
246 XBT_LOG_CONNECT(surf_network);
248 XBT_LOG_CONNECT(ns3);
250 XBT_LOG_CONNECT(surf_parse);
251 XBT_LOG_CONNECT(surf_plugin_load);
252 XBT_LOG_CONNECT(surf_route);
253 XBT_LOG_CONNECT(surf_routing_generic);
254 XBT_LOG_CONNECT(surf_route_cluster);
255 XBT_LOG_CONNECT(surf_route_cluster_torus);
256 XBT_LOG_CONNECT(surf_route_cluster_dragonfly);
257 XBT_LOG_CONNECT(surf_route_dijkstra);
258 XBT_LOG_CONNECT(surf_route_fat_tree);
259 XBT_LOG_CONNECT(surf_route_floyd);
260 XBT_LOG_CONNECT(surf_route_full);
261 XBT_LOG_CONNECT(surf_route_none);
262 XBT_LOG_CONNECT(surf_route_vivaldi);
263 XBT_LOG_CONNECT(surf_storage);
264 XBT_LOG_CONNECT(surf_trace);
265 XBT_LOG_CONNECT(surf_vm);
266 XBT_LOG_CONNECT(surf_host);
268 #endif /* simgrid_EXPORTS */
271 static void xbt_log_help(void);
272 static void xbt_log_help_categories(void);
274 /** @brief Get all logging settings from the command line
276 * xbt_log_control_set() is called on each string we got from cmd line
278 void xbt_log_init(int *argc, char **argv)
280 unsigned help_requested = 0; /* 1: logs; 2: categories */
283 /* Set logs and init log submodule */
284 for (int i = 1; i < *argc; i++) {
285 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
286 char* opt = strchr(argv[i], '=');
288 xbt_log_control_set(opt);
289 XBT_DEBUG("Did apply '%s' as log setting", opt);
290 } else if (!strcmp(argv[i], "--help-logs")) {
291 help_requested |= 1U;
292 } else if (!strcmp(argv[i], "--help-log-categories")) {
293 help_requested |= 2U;
303 if (help_requested) {
304 if (help_requested & 1)
306 if (help_requested & 2)
307 xbt_log_help_categories();
312 static void log_cat_exit(xbt_log_category_t cat)
314 xbt_log_category_t child;
317 if (cat->appender->free_)
318 cat->appender->free_(cat->appender);
322 if (cat->layout->free_)
323 cat->layout->free_(cat->layout);
327 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
331 void xbt_log_postexit(void)
333 XBT_VERB("Exiting log");
334 xbt_os_mutex_destroy(log_cat_init_mutex);
335 xbt_dynar_free(&xbt_log_settings);
336 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
339 /* Size of the static string in which we build the log string */
340 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
341 /* Minimum size of the dynamic string in which we build the log string
342 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
343 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
345 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
347 xbt_log_category_t cat = ev->cat;
349 xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
350 xbt_assert(ev->priority < sizeof(xbt_log_priority_names), "Priority %d is greater than the biggest allowed value",
354 xbt_log_appender_t appender = cat->appender;
356 if (appender != NULL) {
357 xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
359 /* First, try with a static buffer */
361 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
363 ev->buffer_size = sizeof buff;
364 va_start(ev->ap, fmt);
365 done = cat->layout->do_layout(cat->layout, ev, fmt);
368 appender->do_append(appender, buff);
371 /* The static buffer was too small, use a dynamically expanded one */
372 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
373 ev->buffer = xbt_malloc(ev->buffer_size);
375 va_start(ev->ap, fmt);
376 done = cat->layout->do_layout(cat->layout, ev, fmt);
380 ev->buffer_size *= 2;
381 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
383 appender->do_append(appender, ev->buffer);
384 xbt_free(ev->buffer);
388 if (!cat->additivity)
396 * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init(). Thus, if we want to avoid an
397 * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
400 * To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
401 * macro has to be called at the beginning of the affected functions.
403 static int fake_xbt_log_cat_init(xbt_log_category_t XBT_ATTRIB_UNUSED category,
404 e_xbt_log_priority_t XBT_ATTRIB_UNUSED priority)
408 #define DISABLE_XBT_LOG_CAT_INIT() \
409 int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) XBT_ATTRIB_UNUSED = fake_xbt_log_cat_init;
411 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting)
413 DISABLE_XBT_LOG_CAT_INIT();
414 if (setting->thresh != xbt_log_priority_uninitialized) {
415 xbt_log_threshold_set(category, setting->thresh);
417 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
418 category->name, xbt_log_priority_names[category->threshold], category->threshold);
422 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
424 XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting->fmt);
427 if (setting->additivity != -1) {
428 xbt_log_additivity_set(category, setting->additivity);
430 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
431 category->name, (setting->additivity ? "on" : "off"));
433 if (setting->appender) {
434 xbt_log_appender_set(category, setting->appender);
435 if (!category->layout)
436 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
437 category->additivity = 0;
438 XBT_DEBUG("Set %p as appender of category '%s'", setting->appender, category->name);
443 * This gets called the first time a category is referenced and performs the initialization.
444 * Also resets threshold to inherited!
446 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
448 DISABLE_XBT_LOG_CAT_INIT();
449 if (log_cat_init_mutex != NULL)
450 xbt_os_mutex_acquire(log_cat_init_mutex);
452 if (category->initialized) {
453 if (log_cat_init_mutex != NULL)
454 xbt_os_mutex_release(log_cat_init_mutex);
455 return priority >= category->threshold;
459 xbt_log_setting_t setting = NULL;
461 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
462 (category->firstChild ? category->firstChild->name : "none"),
463 (category->nextSibling ? category->nextSibling->name : "none"));
465 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
466 category->threshold = xbt_log_priority_info;
467 category->appender = xbt_log_default_appender;
468 category->layout = xbt_log_default_layout;
470 if (!category->parent)
471 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
473 XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
474 (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
476 xbt_log_parent_set(category, category->parent);
478 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
481 xbt_log_category_t cpp = category->parent->firstChild;
484 buf = bprintf("%s %s", res, cpp->name);
488 res = xbt_strdup(cpp->name);
490 cpp = cpp->nextSibling;
493 XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res,
494 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
500 /* Apply the control */
501 if (xbt_log_settings) {
502 xbt_assert(category, "NULL category");
503 xbt_assert(category->name);
506 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
507 xbt_assert(setting, "Damnit, NULL cat in the list");
508 xbt_assert(setting->catname, "NULL setting(=%p)->catname", (void *) setting);
510 if (!strcmp(setting->catname, category->name)) {
512 _xbt_log_cat_apply_set(category, setting);
513 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
518 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
519 category->name, xbt_log_priority_names[category->threshold], category->threshold);
522 category->initialized = 1;
523 if (log_cat_init_mutex != NULL)
524 xbt_os_mutex_release(log_cat_init_mutex);
525 return priority >= category->threshold;
528 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
530 xbt_assert(cat, "NULL category to be given a parent");
531 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
533 /* if the category is initialized, unlink from current parent */
534 if (cat->initialized) {
535 xbt_log_category_t *cpp = &cat->parent->firstChild;
537 while (*cpp != cat && *cpp != NULL) {
538 cpp = &(*cpp)->nextSibling;
541 xbt_assert(*cpp == cat);
542 *cpp = cat->nextSibling;
545 cat->parent = parent;
546 cat->nextSibling = parent->firstChild;
548 parent->firstChild = cat;
550 if (!parent->initialized)
551 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
553 cat->threshold = parent->threshold;
555 cat->isThreshInherited = 1;
558 static void _set_inherited_thresholds(xbt_log_category_t cat)
560 xbt_log_category_t child = cat->firstChild;
562 for (; child != NULL; child = child->nextSibling) {
563 if (child->isThreshInherited) {
564 if (cat != &_XBT_LOGV(log))
565 XBT_VERB("Set category threshold of %s to %s (=%d)",
566 child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
567 child->threshold = cat->threshold;
568 _set_inherited_thresholds(child);
573 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
575 cat->threshold = threshold;
576 cat->isThreshInherited = 0;
578 _set_inherited_thresholds(cat);
581 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
583 const char *orig_control_string = control_string;
584 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
587 set->thresh = xbt_log_priority_uninitialized;
589 set->additivity = -1;
590 set->appender = NULL;
592 if (!*control_string)
594 XBT_DEBUG("Parse log setting '%s'", control_string);
596 control_string += strspn(control_string, " ");
597 const char *name = control_string;
598 control_string += strcspn(control_string, ".:= ");
599 const char *dot = control_string;
600 control_string += strcspn(control_string, ":= ");
601 const char *eq = control_string;
603 xbt_assert(*dot == '.' || (*eq != '=' && *eq != ':'), "Invalid control string '%s'", orig_control_string);
605 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
607 char *neweq = xbt_strdup(eq + 1);
610 while (*(++p) != '\0') {
611 if (*p >= 'a' && *p <= 'z') {
616 XBT_DEBUG("New priority name = %s", neweq);
617 for (i = 0; i < xbt_log_priority_infinite; i++) {
618 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
619 XBT_DEBUG("This is priority %d", i);
624 if(i<XBT_LOG_STATIC_THRESHOLD){
626 "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
627 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
628 "while -DNLOG forbids any logging, at any level.",
629 eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
631 }else if (i < xbt_log_priority_infinite) {
632 set->thresh = (e_xbt_log_priority_t) i;
635 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", eq + 1);
638 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
639 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
640 char *neweq = xbt_strdup(eq + 1);
643 while (*(++p) != '\0') {
644 if (*p >= 'a' && *p <= 'z') {
648 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES") || !strcmp(neweq, "1")) {
654 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
655 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
656 char *neweq = xbt_strdup(eq + 1);
658 if (!strncmp(neweq, "file:", 5)) {
659 set->appender = xbt_log_appender_file_new(neweq + 5);
660 }else if (!strncmp(neweq, "rollfile:", 9)) {
661 set->appender = xbt_log_appender2_file_new(neweq + 9,1);
662 }else if (!strncmp(neweq, "splitfile:", 10)) {
663 set->appender = xbt_log_appender2_file_new(neweq + 10,0);
665 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
668 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
669 set->fmt = xbt_strdup(eq + 1);
672 snprintf(buff, MIN(512, eq - dot), "%s", dot + 1);
673 xbt_die("Unknown setting of the log category: '%s'", buff);
675 set->catname = (char *) xbt_malloc(dot - name + 1);
677 memcpy(set->catname, name, dot - name);
678 set->catname[dot - name] = '\0'; /* Just in case */
679 XBT_DEBUG("This is for cat '%s'", set->catname);
684 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, char *name)
686 xbt_log_category_t child;
687 xbt_log_category_t res;
689 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
690 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
691 (cat->nextSibling ? cat->nextSibling->name : "none"));
692 if (!strcmp(cat->name, name))
695 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
696 XBT_DEBUG("Dig into %s", child->name);
697 res = _xbt_log_cat_searchsub(child, name);
707 * \param control_string What to parse
709 * Typically passed a command-line argument. The string has the syntax:
711 * ( [category] "." [keyword] ":" value (" ")... )...
713 * where [category] is one the category names (see \ref XBT_log_cats for a complete list of the ones defined in the
714 * SimGrid library) and keyword is one of the following:
716 * - thres: category's threshold priority. Possible values:
717 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
718 * - add or additivity: whether the logging actions must be passed to the parent category.
719 * Possible values: 0, 1, no, yes, on, off.
720 * Default value: yes.
721 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
722 * - app or appender: the appender to use. See \ref log_use_conf_app for more information.
724 void xbt_log_control_set(const char *control_string)
726 xbt_log_setting_t set;
728 /* To split the string in commands, and the cursors */
729 xbt_dynar_t set_strings;
735 XBT_DEBUG("Parse log settings '%s'", control_string);
737 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
738 if (!strcmp(control_string, "no_loc")) {
742 /* some initialization if this is the first time that this get called */
743 if (xbt_log_settings == NULL)
744 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), _free_setting);
746 /* split the string, and remove empty entries */
747 set_strings = xbt_str_split_quoted(control_string);
749 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
750 xbt_dynar_free(&set_strings);
754 /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
755 xbt_dynar_foreach(set_strings, cpt, str) {
756 set = _xbt_log_parse_setting(str);
757 xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
760 XBT_DEBUG("Apply directly");
761 _xbt_log_cat_apply_set(cat, set);
762 _free_setting((void *) &set);
764 XBT_DEBUG("Store for further application");
765 XBT_DEBUG("push %p to the settings", (void *) set);
766 xbt_dynar_push(xbt_log_settings, &set);
769 xbt_dynar_free(&set_strings);
772 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
775 if (cat->appender->free_)
776 cat->appender->free_(cat->appender);
782 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
784 DISABLE_XBT_LOG_CAT_INIT();
785 if (!cat->appender) {
786 XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
787 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
790 if (cat->layout->free_) {
791 cat->layout->free_(cat->layout);
796 xbt_log_additivity_set(cat, 0);
799 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
801 cat->additivity = additivity;
804 static void xbt_log_help(void)
806 printf("Description of the logging output:\n"
808 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
809 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
810 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
811 " -> trace: enter and return of some functions\n"
812 " -> debug: crufty output\n"
813 " -> verbose: verbose output for the user wanting more\n"
814 " -> info: output about the regular functioning\n"
815 " -> warning: minor issue encountered\n"
816 " -> error: issue encountered\n"
817 " -> critical: major issue encountered\n"
818 " The default priority level is 'info'.\n"
820 " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
821 " FORMAT string may contain:\n"
822 " -> %%%%: the %% char\n"
823 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
824 " -> %%e: plain old space (SimGrid extension)\n"
826 " -> %%m: user-provided message\n"
828 " -> %%c: Category name (LOG4J compatible)\n"
829 " -> %%p: Priority name (LOG4J compatible)\n"
831 " -> %%h: Hostname (SimGrid extension)\n"
832 " -> %%P: Process name (SimGrid extension)\n"
833 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
834 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
836 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
837 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
839 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
840 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
841 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
843 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
845 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
846 "mac ones for example.\n"
847 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
848 "defined where %%b is.\n"
850 " -> %%d: date (UNIX-like epoch)\n"
851 " -> %%r: application age (time elapsed since the beginning of the application)\n"
854 " --help-log-categories Display the current hierarchy of log categories.\n"
855 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
859 static int xbt_log_cat_cmp(const void *pa, const void *pb)
861 xbt_log_category_t a = *(xbt_log_category_t *)pa;
862 xbt_log_category_t b = *(xbt_log_category_t *)pb;
863 return strcmp(a->name, b->name);
866 static void xbt_log_help_categories_rec(xbt_log_category_t category, const char *prefix)
871 xbt_log_category_t cat;
876 if (category->parent) {
877 this_prefix = bprintf("%s \\_ ", prefix);
878 child_prefix = bprintf("%s | ", prefix);
880 this_prefix = xbt_strdup(prefix);
881 child_prefix = xbt_strdup(prefix);
884 xbt_dynar_t dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
885 for (cat = category ; cat != NULL; cat = cat->nextSibling)
886 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
888 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
890 xbt_dynar_foreach(dynar, i, cat){
891 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
892 *strrchr(child_prefix, '|') = ' ';
893 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
894 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
897 xbt_dynar_free(&dynar);
898 xbt_free(this_prefix);
899 xbt_free(child_prefix);
902 static void xbt_log_help_categories(void)
904 printf("Current log category hierarchy:\n");
905 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");