1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2015. 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, *xbt_log_setting_t;
46 static xbt_dynar_t xbt_log_settings = NULL;
48 static void _free_setting(void *s)
50 xbt_log_setting_t set = *(xbt_log_setting_t *) s;
58 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting);
60 const char *xbt_log_priority_names[8] = {
71 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
72 NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
73 "root", "The common ancestor for all categories",
74 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
75 0 /* isThreshInherited */ ,
76 NULL /* appender */ , NULL /* layout */ ,
80 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
82 /* create the default appender and install it in the root category,
83 which were already created (damnit. Too slow little beetle) */
84 void xbt_log_preinit(void)
86 xbt_log_default_appender = xbt_log_appender_file_new(NULL);
87 xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
88 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
89 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
90 log_cat_init_mutex = xbt_os_mutex_init();
93 static void xbt_log_connect_categories(void)
95 /* Connect our log channels: that must be done manually under windows */
96 /* Also permit that they are correctly listed by xbt_log_help_categories() */
100 XBT_LOG_CONNECT(log);
101 XBT_LOG_CONNECT(module);
102 XBT_LOG_CONNECT(replay);
103 XBT_LOG_CONNECT(strbuff);
104 XBT_LOG_CONNECT(xbt_cfg);
105 XBT_LOG_CONNECT(xbt_dict);
106 XBT_LOG_CONNECT(xbt_dict_cursor);
107 XBT_LOG_CONNECT(xbt_dict_elm);
108 XBT_LOG_CONNECT(xbt_dyn);
109 XBT_LOG_CONNECT(xbt_ex);
110 XBT_LOG_CONNECT(xbt_backtrace);
111 XBT_LOG_CONNECT(xbt_exception);
112 XBT_LOG_CONNECT(xbt_fifo);
113 XBT_LOG_CONNECT(xbt_graph);
114 XBT_LOG_CONNECT(xbt_heap);
115 XBT_LOG_CONNECT(xbt_lib);
116 XBT_LOG_CONNECT(xbt_mallocator);
117 XBT_LOG_CONNECT(xbt_matrix);
118 XBT_LOG_CONNECT(xbt_memory_map);
119 XBT_LOG_CONNECT(xbt_parmap);
120 XBT_LOG_CONNECT(xbt_sync);
121 XBT_LOG_CONNECT(xbt_sync_os);
123 #ifdef simgrid_EXPORTS
124 /* The following categories are only defined in libsimgrid */
128 XBT_LOG_CONNECT(lua);
129 XBT_LOG_CONNECT(lua_host);
130 XBT_LOG_CONNECT(lua_platf);
131 XBT_LOG_CONNECT(lua_debug);
135 XBT_LOG_CONNECT(instr);
136 XBT_LOG_CONNECT(instr_api);
137 XBT_LOG_CONNECT(instr_config);
138 XBT_LOG_CONNECT(instr_msg);
139 XBT_LOG_CONNECT(instr_msg_process);
140 XBT_LOG_CONNECT(instr_paje_containers);
141 XBT_LOG_CONNECT(instr_paje_header);
142 XBT_LOG_CONNECT(instr_paje_trace);
143 XBT_LOG_CONNECT(instr_paje_types);
144 XBT_LOG_CONNECT(instr_paje_values);
145 XBT_LOG_CONNECT(instr_resource);
146 XBT_LOG_CONNECT(instr_routing);
147 XBT_LOG_CONNECT(instr_surf);
148 XBT_LOG_CONNECT(instr_trace);
149 XBT_LOG_CONNECT(instr_TI_trace);
153 XBT_LOG_CONNECT(jedule);
154 XBT_LOG_CONNECT(jed_sd);
160 XBT_LOG_CONNECT(mc_checkpoint);
161 XBT_LOG_CONNECT(mc_comm_determinism);
162 XBT_LOG_CONNECT(mc_compare);
163 XBT_LOG_CONNECT(mc_dwarf);
164 XBT_LOG_CONNECT(mc_hash);
165 XBT_LOG_CONNECT(mc_liveness);
166 XBT_LOG_CONNECT(mc_memory);
167 XBT_LOG_CONNECT(mc_page_snapshot);
168 XBT_LOG_CONNECT(mc_request);
169 XBT_LOG_CONNECT(mc_safety);
170 XBT_LOG_CONNECT(mc_VisitedState);
171 XBT_LOG_CONNECT(mc_client);
172 XBT_LOG_CONNECT(mc_client_api);
173 XBT_LOG_CONNECT(mc_comm_pattern);
174 XBT_LOG_CONNECT(mc_process);
175 XBT_LOG_CONNECT(mc_protocol);
176 XBT_LOG_CONNECT(mc_Channel);
177 XBT_LOG_CONNECT(mc_ModelChecker);
178 XBT_LOG_CONNECT(mc_RegionSnaphot);
179 XBT_LOG_CONNECT(mc_Session);
180 XBT_LOG_CONNECT(mc_state);
182 XBT_LOG_CONNECT(mc_global);
183 XBT_LOG_CONNECT(mc_config);
184 XBT_LOG_CONNECT(mc_record);
187 XBT_LOG_CONNECT(msg);
188 XBT_LOG_CONNECT(msg_action);
189 XBT_LOG_CONNECT(msg_gos);
190 XBT_LOG_CONNECT(msg_io);
191 XBT_LOG_CONNECT(msg_kernel);
192 XBT_LOG_CONNECT(msg_mailbox);
193 XBT_LOG_CONNECT(msg_process);
194 XBT_LOG_CONNECT(msg_synchro);
195 XBT_LOG_CONNECT(msg_task);
196 XBT_LOG_CONNECT(msg_vm);
199 XBT_LOG_CONNECT(s4u);
200 XBT_LOG_CONNECT(s4u_activity);
201 XBT_LOG_CONNECT(s4u_actor);
202 XBT_LOG_CONNECT(s4u_as);
203 XBT_LOG_CONNECT(s4u_channel);
204 XBT_LOG_CONNECT(s4u_comm);
205 XBT_LOG_CONNECT(s4u_file);
208 XBT_LOG_CONNECT(sg_host);
212 XBT_LOG_CONNECT(sd_daxparse);
214 XBT_LOG_CONNECT(sd_dotparse);
216 XBT_LOG_CONNECT(sd_kernel);
217 XBT_LOG_CONNECT(sd_task);
220 XBT_LOG_CONNECT(simix);
221 XBT_LOG_CONNECT(simix_context);
222 XBT_LOG_CONNECT(simix_deployment);
223 XBT_LOG_CONNECT(simix_environment);
224 XBT_LOG_CONNECT(simix_host);
225 XBT_LOG_CONNECT(simix_io);
226 XBT_LOG_CONNECT(simix_kernel);
227 XBT_LOG_CONNECT(simix_network);
228 XBT_LOG_CONNECT(simix_process);
229 XBT_LOG_CONNECT(simix_popping);
230 XBT_LOG_CONNECT(simix_synchro);
231 XBT_LOG_CONNECT(simix_vm);
234 /* SMPI categories are connected in smpi_global.c */
237 XBT_LOG_CONNECT(surf);
238 XBT_LOG_CONNECT(surf_config);
239 XBT_LOG_CONNECT(surf_cpu);
240 XBT_LOG_CONNECT(surf_cpu_cas);
241 XBT_LOG_CONNECT(surf_cpu_ti);
242 XBT_LOG_CONNECT(surf_energy);
243 XBT_LOG_CONNECT(surf_kernel);
244 XBT_LOG_CONNECT(surf_lagrange);
245 XBT_LOG_CONNECT(surf_lagrange_dichotomy);
246 XBT_LOG_CONNECT(surf_maxmin);
247 XBT_LOG_CONNECT(surf_network);
249 XBT_LOG_CONNECT(ns3);
251 XBT_LOG_CONNECT(surf_parse);
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);
269 XBT_LOG_CONNECT(AsImpl);
271 #endif /* simgrid_EXPORTS */
274 static void xbt_log_help(void);
275 static void xbt_log_help_categories(void);
277 /** @brief Get all logging settings from the command line
279 * xbt_log_control_set() is called on each string we got from cmd line
281 void xbt_log_init(int *argc, char **argv)
283 unsigned help_requested = 0; /* 1: logs; 2: categories */
287 /* uncomment to set the LOG category to debug directly */
288 // _XBT_LOGV(log).threshold = xbt_log_priority_debug;
290 xbt_log_connect_categories();
292 /* Set logs and init log submodule */
293 for (j = i = 1; i < *argc; i++) {
294 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
295 opt = strchr(argv[i], '=');
297 xbt_log_control_set(opt);
298 XBT_DEBUG("Did apply '%s' as log setting", opt);
299 } else if (!strcmp(argv[i], "--help-logs")) {
301 } else if (!strcmp(argv[i], "--help-log-categories")) {
312 if (help_requested) {
313 if (help_requested & 1)
315 if (help_requested & 2)
316 xbt_log_help_categories();
321 static void log_cat_exit(xbt_log_category_t cat)
323 xbt_log_category_t child;
326 if (cat->appender->free_)
327 cat->appender->free_(cat->appender);
331 if (cat->layout->free_)
332 cat->layout->free_(cat->layout);
336 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
340 void xbt_log_postexit(void)
342 XBT_VERB("Exiting log");
343 xbt_os_mutex_destroy(log_cat_init_mutex);
344 xbt_dynar_free(&xbt_log_settings);
345 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
348 /* Size of the static string in which we build the log string */
349 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
350 /* Minimum size of the dynamic string in which we build the log string
351 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
352 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
354 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
356 xbt_log_category_t cat = ev->cat;
358 xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
359 xbt_assert(ev->priority < sizeof(xbt_log_priority_names), "Priority %d is greater than the biggest allowed value",
363 xbt_log_appender_t appender = cat->appender;
366 continue; /* No appender, try next */
368 xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
370 /* First, try with a static buffer */
371 if (XBT_LOG_STATIC_BUFFER_SIZE) {
372 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
375 ev->buffer_size = sizeof buff;
376 va_start(ev->ap, fmt);
377 done = cat->layout->do_layout(cat->layout, ev, fmt);
380 appender->do_append(appender, buff);
381 continue; /* Ok, that worked: go next */
385 /* The static buffer was too small, use a dynamically expanded one */
386 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
387 ev->buffer = xbt_malloc(ev->buffer_size);
390 va_start(ev->ap, fmt);
391 done = cat->layout->do_layout(cat->layout, ev, fmt);
395 ev->buffer_size *= 2;
396 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
398 appender->do_append(appender, ev->buffer);
399 xbt_free(ev->buffer);
401 } while (cat->additivity && (cat = cat->parent, 1));
404 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
405 #undef XBT_LOG_STATIC_BUFFER_SIZE
409 * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init(). Thus, if we want to avoid an
410 * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
413 * To circumvent the problem, we define the macro_xbt_log_init() as (0) for the length of the affected functions, and
414 * we do not forget to undefine it at the end!
417 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting)
419 #define _xbt_log_cat_init(a, b) (0)
421 if (setting->thresh != xbt_log_priority_uninitialized) {
422 xbt_log_threshold_set(category, setting->thresh);
424 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
425 category->name, xbt_log_priority_names[category->threshold], category->threshold);
429 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
431 XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting->fmt);
434 if (setting->additivity != -1) {
435 xbt_log_additivity_set(category, setting->additivity);
437 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
438 category->name, (setting->additivity ? "on" : "off"));
440 if (setting->appender) {
441 xbt_log_appender_set(category, setting->appender);
442 if (!category->layout)
443 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
444 category->additivity = 0;
445 XBT_DEBUG("Set %p as appender of category '%s'", setting->appender, category->name);
447 #undef _xbt_log_cat_init
451 * This gets called the first time a category is referenced and performs the initialization.
452 * Also resets threshold to inherited!
454 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
456 #define _xbt_log_cat_init(a, b) (0)
458 if (log_cat_init_mutex != NULL)
459 xbt_os_mutex_acquire(log_cat_init_mutex);
461 if (category->initialized) {
462 if (log_cat_init_mutex != NULL)
463 xbt_os_mutex_release(log_cat_init_mutex);
464 return priority >= category->threshold;
468 xbt_log_setting_t setting = NULL;
471 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
472 (category->firstChild ? category->firstChild->name : "none"),
473 (category->nextSibling ? category->nextSibling->name : "none"));
475 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
476 category->threshold = xbt_log_priority_info;
477 category->appender = xbt_log_default_appender;
478 category->layout = xbt_log_default_layout;
480 if (!category->parent)
481 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
483 XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
484 (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
486 xbt_log_parent_set(category, category->parent);
488 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
489 char *buf, *res = NULL;
490 xbt_log_category_t cpp = category->parent->firstChild;
493 buf = bprintf("%s %s", res, cpp->name);
497 res = xbt_strdup(cpp->name);
499 cpp = cpp->nextSibling;
502 XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res,
503 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
509 /* Apply the control */
510 if (xbt_log_settings) {
511 xbt_assert(category, "NULL category");
512 xbt_assert(category->name);
514 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
515 xbt_assert(setting, "Damnit, NULL cat in the list");
516 xbt_assert(setting->catname, "NULL setting(=%p)->catname", (void *) setting);
518 if (!strcmp(setting->catname, category->name)) {
520 _xbt_log_cat_apply_set(category, setting);
521 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
526 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
527 category->name, xbt_log_priority_names[category->threshold], category->threshold);
530 category->initialized = 1;
531 if (log_cat_init_mutex != NULL)
532 xbt_os_mutex_release(log_cat_init_mutex);
533 return priority >= category->threshold;
535 #undef _xbt_log_cat_init
538 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
540 xbt_assert(cat, "NULL category to be given a parent");
541 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
543 /* if the category is initialized, unlink from current parent */
544 if (cat->initialized) {
545 xbt_log_category_t *cpp = &cat->parent->firstChild;
547 while (*cpp != cat && *cpp != NULL) {
548 cpp = &(*cpp)->nextSibling;
551 xbt_assert(*cpp == cat);
552 *cpp = cat->nextSibling;
555 cat->parent = parent;
556 cat->nextSibling = parent->firstChild;
558 parent->firstChild = cat;
560 if (!parent->initialized)
561 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
563 cat->threshold = parent->threshold;
565 cat->isThreshInherited = 1;
568 static void _set_inherited_thresholds(xbt_log_category_t cat)
570 xbt_log_category_t child = cat->firstChild;
572 for (; child != NULL; child = child->nextSibling) {
573 if (child->isThreshInherited) {
574 if (cat != &_XBT_LOGV(log))
575 XBT_VERB("Set category threshold of %s to %s (=%d)",
576 child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
577 child->threshold = cat->threshold;
578 _set_inherited_thresholds(child);
583 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
585 cat->threshold = threshold;
586 cat->isThreshInherited = 0;
588 _set_inherited_thresholds(cat);
591 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
593 const char *orig_control_string = control_string;
594 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
595 const char *name, *dot, *eq;
598 set->thresh = xbt_log_priority_uninitialized;
600 set->additivity = -1;
601 set->appender = NULL;
603 if (!*control_string)
605 XBT_DEBUG("Parse log setting '%s'", control_string);
607 control_string += strspn(control_string, " ");
608 name = control_string;
609 control_string += strcspn(control_string, ".= ");
610 dot = control_string;
611 control_string += strcspn(control_string, ":= ");
614 if(*dot != '.' && (*eq == '=' || *eq == ':'))
615 xbt_die ("Invalid control string '%s'", orig_control_string);
617 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
619 char *neweq = xbt_strdup(eq + 1);
622 while (*(++p) != '\0') {
623 if (*p >= 'a' && *p <= 'z') {
628 XBT_DEBUG("New priority name = %s", neweq);
629 for (i = 0; i < xbt_log_priority_infinite; i++) {
630 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
631 XBT_DEBUG("This is priority %d", i);
636 if(i<XBT_LOG_STATIC_THRESHOLD){
638 "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
639 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
640 "while -DNLOG forbids any logging, at any level.",
641 eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
643 }else if (i < xbt_log_priority_infinite) {
644 set->thresh = (e_xbt_log_priority_t) i;
647 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", eq + 1);
650 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
651 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
652 char *neweq = xbt_strdup(eq + 1);
655 while (*(++p) != '\0') {
656 if (*p >= 'a' && *p <= 'z') {
660 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES") || !strcmp(neweq, "1")) {
666 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
667 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
668 char *neweq = xbt_strdup(eq + 1);
670 if (!strncmp(neweq, "file:", 5)) {
671 set->appender = xbt_log_appender_file_new(neweq + 5);
672 }else if (!strncmp(neweq, "rollfile:", 9)) {
673 set->appender = xbt_log_appender2_file_new(neweq + 9,1);
674 }else if (!strncmp(neweq, "splitfile:", 10)) {
675 set->appender = xbt_log_appender2_file_new(neweq + 10,0);
677 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
680 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
681 set->fmt = xbt_strdup(eq + 1);
684 snprintf(buff, MIN(512, eq - dot), "%s", dot + 1);
685 THROWF(arg_error, 0, "Unknown setting of the log category: '%s'", buff);
687 set->catname = (char *) xbt_malloc(dot - name + 1);
689 memcpy(set->catname, name, dot - name);
690 set->catname[dot - name] = '\0'; /* Just in case */
691 XBT_DEBUG("This is for cat '%s'", set->catname);
696 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, char *name)
698 xbt_log_category_t child, res;
700 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
701 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
702 (cat->nextSibling ? cat->nextSibling->name : "none"));
703 if (!strcmp(cat->name, name))
706 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
707 XBT_DEBUG("Dig into %s", child->name);
708 res = _xbt_log_cat_searchsub(child, name);
718 * \param control_string What to parse
720 * Typically passed a command-line argument. The string has the syntax:
722 * ( [category] "." [keyword] ":" value (" ")... )...
724 * where [category] is one the category names (see \ref XBT_log_cats for a complete list of the ones defined in the
725 * SimGrid library) and keyword is one of the following:
727 * - thres: category's threshold priority. Possible values:
728 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
729 * - add or additivity: whether the logging actions must be passed to the parent category.
730 * Possible values: 0, 1, no, yes, on, off.
731 * Default value: yes.
732 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
733 * - app or appender: the appender to use. See \ref log_use_conf_app for more information.
735 void xbt_log_control_set(const char *control_string)
737 xbt_log_setting_t set;
739 /* To split the string in commands, and the cursors */
740 xbt_dynar_t set_strings;
746 XBT_DEBUG("Parse log settings '%s'", control_string);
748 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
749 if (!strcmp(control_string, "no_loc")) {
753 /* some initialization if this is the first time that this get called */
754 if (xbt_log_settings == NULL)
755 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), _free_setting);
757 /* split the string, and remove empty entries */
758 set_strings = xbt_str_split_quoted(control_string);
760 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
761 xbt_dynar_free(&set_strings);
765 /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
766 xbt_dynar_foreach(set_strings, cpt, str) {
767 xbt_log_category_t cat = NULL;
769 set = _xbt_log_parse_setting(str);
770 cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
773 XBT_DEBUG("Apply directly");
774 _xbt_log_cat_apply_set(cat, set);
775 _free_setting((void *) &set);
777 XBT_DEBUG("Store for further application");
778 XBT_DEBUG("push %p to the settings", (void *) set);
779 xbt_dynar_push(xbt_log_settings, &set);
782 xbt_dynar_free(&set_strings);
785 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
788 if (cat->appender->free_)
789 cat->appender->free_(cat->appender);
795 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
797 #define _xbt_log_cat_init(a, b) (0)
798 if (!cat->appender) {
799 XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
800 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
803 if (cat->layout->free_) {
804 cat->layout->free_(cat->layout);
809 xbt_log_additivity_set(cat, 0);
810 #undef _xbt_log_cat_init
813 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
815 cat->additivity = additivity;
818 static void xbt_log_help(void)
821 "Description of the logging output:\n"
823 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
824 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
825 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
826 " -> trace: enter and return of some functions\n"
827 " -> debug: crufty output\n"
828 " -> verbose: verbose output for the user wanting more\n"
829 " -> info: output about the regular functionning\n"
830 " -> warning: minor issue encountered\n"
831 " -> error: issue encountered\n"
832 " -> critical: major issue encountered\n"
834 " Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
836 " -> %%%%: the %% char\n"
837 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
838 " -> %%e: plain old space (SimGrid extension)\n"
840 " -> %%m: user-provided message\n"
842 " -> %%c: Category name (LOG4J compatible)\n"
843 " -> %%p: Priority name (LOG4J compatible)\n"
845 " -> %%h: Hostname (SimGrid extension)\n"
846 " -> %%P: Process name (SimGrid extension)\n"
847 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
848 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
850 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
851 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n"
852 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
853 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
854 " Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
856 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n"
857 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n"
858 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n"
860 " -> %%d: date (UNIX-like epoch)\n"
861 " -> %%r: application age (time elapsed since the beginning of the application)\n"
864 " --help-log-categories Display the current hierarchy of log categories.\n"
865 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
870 static int xbt_log_cat_cmp(const void *pa, const void *pb)
872 xbt_log_category_t a = *(xbt_log_category_t *)pa;
873 xbt_log_category_t b = *(xbt_log_category_t *)pb;
874 return strcmp(a->name, b->name);
877 static void xbt_log_help_categories_rec(xbt_log_category_t category, const char *prefix)
883 xbt_log_category_t cat;
888 if (category->parent) {
889 this_prefix = bprintf("%s \\_ ", prefix);
890 child_prefix = bprintf("%s | ", prefix);
892 this_prefix = xbt_strdup(prefix);
893 child_prefix = xbt_strdup(prefix);
896 dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
897 for (cat = category ; cat != NULL; cat = cat->nextSibling)
898 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
900 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
902 for (i = 0; i < xbt_dynar_length(dynar); i++) {
903 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
904 *strrchr(child_prefix, '|') = ' ';
905 cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t);
906 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
907 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
910 xbt_dynar_free(&dynar);
911 xbt_free(this_prefix);
912 xbt_free(child_prefix);
915 static void xbt_log_help_categories(void)
917 printf("Current log category hierarchy:\n");
918 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");