1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2018. 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_help(void);
96 static void xbt_log_help_categories(void);
98 /** @brief Get all logging settings from the command line
100 * xbt_log_control_set() is called on each string we got from cmd line
102 void xbt_log_init(int *argc, char **argv)
104 unsigned help_requested = 0; /* 1: logs; 2: categories */
107 /* Set logs and init log submodule */
108 for (int i = 1; i < *argc; i++) {
109 if (!strncmp(argv[i], "--log=", strlen("--log="))) {
110 char* opt = strchr(argv[i], '=');
112 xbt_log_control_set(opt);
113 XBT_DEBUG("Did apply '%s' as log setting", opt);
114 } else if (!strcmp(argv[i], "--help-logs")) {
115 help_requested |= 1U;
116 } else if (!strcmp(argv[i], "--help-log-categories")) {
117 help_requested |= 2U;
127 if (help_requested) {
128 if (help_requested & 1)
130 if (help_requested & 2)
131 xbt_log_help_categories();
136 static void log_cat_exit(xbt_log_category_t cat)
138 xbt_log_category_t child;
141 if (cat->appender->free_)
142 cat->appender->free_(cat->appender);
146 if (cat->layout->free_)
147 cat->layout->free_(cat->layout);
151 for (child = cat->firstChild; child != NULL; child = child->nextSibling)
155 void xbt_log_postexit(void)
157 XBT_VERB("Exiting log");
158 xbt_os_mutex_destroy(log_cat_init_mutex);
159 xbt_dynar_free(&xbt_log_settings);
160 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
163 /* Size of the static string in which we build the log string */
164 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
165 /* Minimum size of the dynamic string in which we build the log string
166 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
167 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
169 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
171 xbt_log_category_t cat = ev->cat;
173 xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
174 xbt_assert(ev->priority < sizeof(xbt_log_priority_names), "Priority %d is greater than the biggest allowed value",
178 xbt_log_appender_t appender = cat->appender;
180 if (appender != NULL) {
181 xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
183 /* First, try with a static buffer */
185 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
187 ev->buffer_size = sizeof buff;
188 va_start(ev->ap, fmt);
189 done = cat->layout->do_layout(cat->layout, ev, fmt);
192 appender->do_append(appender, buff);
195 /* The static buffer was too small, use a dynamically expanded one */
196 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
197 ev->buffer = xbt_malloc(ev->buffer_size);
199 va_start(ev->ap, fmt);
200 done = cat->layout->do_layout(cat->layout, ev, fmt);
204 ev->buffer_size *= 2;
205 ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
207 appender->do_append(appender, ev->buffer);
208 xbt_free(ev->buffer);
212 if (!cat->additivity)
220 * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init(). Thus, if we want to avoid an
221 * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
224 * To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
225 * macro has to be called at the beginning of the affected functions.
227 static int fake_xbt_log_cat_init(xbt_log_category_t XBT_ATTRIB_UNUSED category,
228 e_xbt_log_priority_t XBT_ATTRIB_UNUSED priority)
232 #define DISABLE_XBT_LOG_CAT_INIT() \
233 int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) XBT_ATTRIB_UNUSED = fake_xbt_log_cat_init;
235 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting)
237 DISABLE_XBT_LOG_CAT_INIT();
238 if (setting->thresh != xbt_log_priority_uninitialized) {
239 xbt_log_threshold_set(category, setting->thresh);
241 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
242 category->name, xbt_log_priority_names[category->threshold], category->threshold);
246 xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
248 XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting->fmt);
251 if (setting->additivity != -1) {
252 xbt_log_additivity_set(category, setting->additivity);
254 XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
255 category->name, (setting->additivity ? "on" : "off"));
257 if (setting->appender) {
258 xbt_log_appender_set(category, setting->appender);
259 if (!category->layout)
260 xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
261 category->additivity = 0;
262 XBT_DEBUG("Set %p as appender of category '%s'", setting->appender, category->name);
267 * This gets called the first time a category is referenced and performs the initialization.
268 * Also resets threshold to inherited!
270 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
272 DISABLE_XBT_LOG_CAT_INIT();
273 if (log_cat_init_mutex != NULL)
274 xbt_os_mutex_acquire(log_cat_init_mutex);
276 if (category->initialized) {
277 if (log_cat_init_mutex != NULL)
278 xbt_os_mutex_release(log_cat_init_mutex);
279 return priority >= category->threshold;
283 xbt_log_setting_t setting = NULL;
285 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
286 (category->firstChild ? category->firstChild->name : "none"),
287 (category->nextSibling ? category->nextSibling->name : "none"));
289 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
290 category->threshold = xbt_log_priority_info;
291 category->appender = xbt_log_default_appender;
292 category->layout = xbt_log_default_layout;
294 if (!category->parent)
295 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
297 XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
298 (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
300 xbt_log_parent_set(category, category->parent);
302 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
305 xbt_log_category_t cpp = category->parent->firstChild;
308 buf = bprintf("%s %s", res, cpp->name);
312 res = xbt_strdup(cpp->name);
314 cpp = cpp->nextSibling;
317 XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res,
318 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
324 /* Apply the control */
325 if (xbt_log_settings) {
326 xbt_assert(category, "NULL category");
327 xbt_assert(category->name);
330 xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
331 xbt_assert(setting, "Damnit, NULL cat in the list");
332 xbt_assert(setting->catname, "NULL setting(=%p)->catname", (void *) setting);
334 if (!strcmp(setting->catname, category->name)) {
336 _xbt_log_cat_apply_set(category, setting);
337 xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
342 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
343 category->name, xbt_log_priority_names[category->threshold], category->threshold);
346 category->initialized = 1;
347 if (log_cat_init_mutex != NULL)
348 xbt_os_mutex_release(log_cat_init_mutex);
349 return priority >= category->threshold;
352 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
354 xbt_assert(cat, "NULL category to be given a parent");
355 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
357 /* if the category is initialized, unlink from current parent */
358 if (cat->initialized) {
359 xbt_log_category_t *cpp = &cat->parent->firstChild;
361 while (*cpp != cat && *cpp != NULL) {
362 cpp = &(*cpp)->nextSibling;
365 xbt_assert(*cpp == cat);
366 *cpp = cat->nextSibling;
369 cat->parent = parent;
370 cat->nextSibling = parent->firstChild;
372 parent->firstChild = cat;
374 if (!parent->initialized)
375 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
377 cat->threshold = parent->threshold;
379 cat->isThreshInherited = 1;
382 static void _set_inherited_thresholds(xbt_log_category_t cat)
384 xbt_log_category_t child = cat->firstChild;
386 for (; child != NULL; child = child->nextSibling) {
387 if (child->isThreshInherited) {
388 if (cat != &_XBT_LOGV(log))
389 XBT_VERB("Set category threshold of %s to %s (=%d)",
390 child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
391 child->threshold = cat->threshold;
392 _set_inherited_thresholds(child);
397 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
399 cat->threshold = threshold;
400 cat->isThreshInherited = 0;
402 _set_inherited_thresholds(cat);
405 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
407 const char *orig_control_string = control_string;
408 xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
411 set->thresh = xbt_log_priority_uninitialized;
413 set->additivity = -1;
414 set->appender = NULL;
416 if (!*control_string)
418 XBT_DEBUG("Parse log setting '%s'", control_string);
420 control_string += strspn(control_string, " ");
421 const char *name = control_string;
422 control_string += strcspn(control_string, ".:= ");
423 const char *dot = control_string;
424 control_string += strcspn(control_string, ":= ");
425 const char *eq = control_string;
427 xbt_assert(*dot == '.' || (*eq != '=' && *eq != ':'), "Invalid control string '%s'", orig_control_string);
429 if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
431 char *neweq = xbt_strdup(eq + 1);
434 while (*(++p) != '\0') {
435 if (*p >= 'a' && *p <= 'z') {
440 XBT_DEBUG("New priority name = %s", neweq);
441 for (i = 0; i < xbt_log_priority_infinite; i++) {
442 if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
443 XBT_DEBUG("This is priority %d", i);
448 if(i<XBT_LOG_STATIC_THRESHOLD){
450 "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
451 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
452 "while -DNLOG forbids any logging, at any level.",
453 eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
455 }else if (i < xbt_log_priority_infinite) {
456 set->thresh = (e_xbt_log_priority_t) i;
459 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", eq + 1);
462 } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
463 !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
464 char *neweq = xbt_strdup(eq + 1);
467 while (*(++p) != '\0') {
468 if (*p >= 'a' && *p <= 'z') {
472 if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES") || !strcmp(neweq, "1")) {
478 } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
479 !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
480 char *neweq = xbt_strdup(eq + 1);
482 if (!strncmp(neweq, "file:", 5)) {
483 set->appender = xbt_log_appender_file_new(neweq + 5);
484 }else if (!strncmp(neweq, "rollfile:", 9)) {
485 set->appender = xbt_log_appender2_file_new(neweq + 9,1);
486 }else if (!strncmp(neweq, "splitfile:", 10)) {
487 set->appender = xbt_log_appender2_file_new(neweq + 10,0);
489 THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
492 } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
493 set->fmt = xbt_strdup(eq + 1);
496 snprintf(buff, MIN(512, eq - dot), "%s", dot + 1);
497 xbt_die("Unknown setting of the log category: '%s'", buff);
499 set->catname = (char *) xbt_malloc(dot - name + 1);
501 memcpy(set->catname, name, dot - name);
502 set->catname[dot - name] = '\0'; /* Just in case */
503 XBT_DEBUG("This is for cat '%s'", set->catname);
508 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, char *name)
510 xbt_log_category_t child;
511 xbt_log_category_t res;
513 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
514 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
515 (cat->nextSibling ? cat->nextSibling->name : "none"));
516 if (!strcmp(cat->name, name))
519 for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
520 XBT_DEBUG("Dig into %s", child->name);
521 res = _xbt_log_cat_searchsub(child, name);
531 * \param control_string What to parse
533 * Typically passed a command-line argument. The string has the syntax:
535 * ( [category] "." [keyword] ":" value (" ")... )...
537 * where [category] is one the category names (see \ref XBT_log_cats for a complete list of the ones defined in the
538 * SimGrid library) and keyword is one of the following:
540 * - thres: category's threshold priority. Possible values:
541 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
542 * - add or additivity: whether the logging actions must be passed to the parent category.
543 * Possible values: 0, 1, no, yes, on, off.
544 * Default value: yes.
545 * - fmt: the format to use. See \ref log_use_conf_fmt for more information.
546 * - app or appender: the appender to use. See \ref log_use_conf_app for more information.
548 void xbt_log_control_set(const char *control_string)
550 xbt_log_setting_t set;
552 /* To split the string in commands, and the cursors */
553 xbt_dynar_t set_strings;
559 XBT_DEBUG("Parse log settings '%s'", control_string);
561 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
562 if (!strcmp(control_string, "no_loc")) {
566 /* some initialization if this is the first time that this get called */
567 if (xbt_log_settings == NULL)
568 xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), _free_setting);
570 /* split the string, and remove empty entries */
571 set_strings = xbt_str_split_quoted(control_string);
573 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
574 xbt_dynar_free(&set_strings);
578 /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
579 xbt_dynar_foreach(set_strings, cpt, str) {
580 set = _xbt_log_parse_setting(str);
581 xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
584 XBT_DEBUG("Apply directly");
585 _xbt_log_cat_apply_set(cat, set);
586 _free_setting((void *) &set);
588 XBT_DEBUG("Store for further application");
589 XBT_DEBUG("push %p to the settings", (void *) set);
590 xbt_dynar_push(xbt_log_settings, &set);
593 xbt_dynar_free(&set_strings);
596 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
599 if (cat->appender->free_)
600 cat->appender->free_(cat->appender);
606 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
608 DISABLE_XBT_LOG_CAT_INIT();
609 if (!cat->appender) {
610 XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
611 xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
614 if (cat->layout->free_) {
615 cat->layout->free_(cat->layout);
620 xbt_log_additivity_set(cat, 0);
623 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
625 cat->additivity = additivity;
628 static void xbt_log_help(void)
630 printf("Description of the logging output:\n"
632 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
633 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
634 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
635 " -> trace: enter and return of some functions\n"
636 " -> debug: crufty output\n"
637 " -> verbose: verbose output for the user wanting more\n"
638 " -> info: output about the regular functioning\n"
639 " -> warning: minor issue encountered\n"
640 " -> error: issue encountered\n"
641 " -> critical: major issue encountered\n"
642 " The default priority level is 'info'.\n"
644 " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
645 " FORMAT string may contain:\n"
646 " -> %%%%: the %% char\n"
647 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
648 " -> %%e: plain old space (SimGrid extension)\n"
650 " -> %%m: user-provided message\n"
652 " -> %%c: Category name (LOG4J compatible)\n"
653 " -> %%p: Priority name (LOG4J compatible)\n"
655 " -> %%h: Hostname (SimGrid extension)\n"
656 " -> %%P: Process name (SimGrid extension)\n"
657 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
658 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
660 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
661 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
663 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
664 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
665 " Defined only when using gcc because there is no __func__ elsewhere.\n"
667 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
669 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
670 "mac ones for example.\n"
671 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
672 "defined where %%b is.\n"
674 " -> %%d: date (UNIX-like epoch)\n"
675 " -> %%r: application age (time elapsed since the beginning of the application)\n"
678 " --help-log-categories Display the current hierarchy of log categories.\n"
679 " --log=no_loc Don't print file names in messages (for tesh tests).\n"
683 static int xbt_log_cat_cmp(const void *pa, const void *pb)
685 xbt_log_category_t a = *(xbt_log_category_t *)pa;
686 xbt_log_category_t b = *(xbt_log_category_t *)pb;
687 return strcmp(a->name, b->name);
690 static void xbt_log_help_categories_rec(xbt_log_category_t category, const char *prefix)
695 xbt_log_category_t cat;
700 if (category->parent) {
701 this_prefix = bprintf("%s \\_ ", prefix);
702 child_prefix = bprintf("%s | ", prefix);
704 this_prefix = xbt_strdup(prefix);
705 child_prefix = xbt_strdup(prefix);
708 xbt_dynar_t dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
709 for (cat = category ; cat != NULL; cat = cat->nextSibling)
710 xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
712 xbt_dynar_sort(dynar, xbt_log_cat_cmp);
714 xbt_dynar_foreach(dynar, i, cat){
715 if (i == xbt_dynar_length(dynar) - 1 && category->parent)
716 *strrchr(child_prefix, '|') = ' ';
717 printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
718 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
721 xbt_dynar_free(&dynar);
722 xbt_free(this_prefix);
723 xbt_free(child_prefix);
726 static void xbt_log_help_categories(void)
728 printf("Current log category hierarchy:\n");
729 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");