1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */
5 /* This program is free software; you can redistribute it and/or modify it
6 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "src/xbt/log_private.hpp"
9 #include "src/xbt_modinter.h"
10 #include "xbt/asserts.h"
11 #include "xbt/dynar.h"
13 #include "xbt/string.hpp"
20 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
21 static std::recursive_mutex* log_cat_init_mutex = nullptr;
23 /** @addtogroup XBT_log
25 * For more information, please refer to @ref outcomes_logs Section.
28 xbt_log_appender_t xbt_log_default_appender = nullptr; /* set in log_init */
29 xbt_log_layout_t xbt_log_default_layout = nullptr; /* set in log_init */
31 struct xbt_log_setting_t {
34 e_xbt_log_priority_t thresh = xbt_log_priority_uninitialized;
36 xbt_log_appender_t appender = nullptr;
39 static std::vector<xbt_log_setting_t> xbt_log_settings;
41 const char *xbt_log_priority_names[8] = {
52 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
54 nullptr /* firstChild */,
55 nullptr /* nextSibling */,
57 "The common ancestor for all categories",
59 xbt_log_priority_uninitialized /* threshold */,
60 0 /* isThreshInherited */,
61 nullptr /* appender */,
66 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
68 /* create the default appender and install it in the root category,
69 which were already created (damnit. Too slow little beetle) */
70 void xbt_log_preinit(void)
72 xbt_log_default_appender = xbt_log_appender_stream(stderr);
73 xbt_log_default_layout = xbt_log_layout_simple_new(nullptr);
74 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
75 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
76 log_cat_init_mutex = new std::recursive_mutex();
79 static void xbt_log_help(void);
80 static void xbt_log_help_categories(void);
82 /** @brief Get all logging settings from the command line
84 * xbt_log_control_set() is called on each string we got from cmd line
86 void xbt_log_init(int *argc, char **argv)
88 unsigned help_requested = 0; /* 1: logs; 2: categories */
90 int parse_args = 1; // Stop parsing the parameters once we found '--'
92 xbt_log_control_set("xbt_help.app:stdout xbt_help.threshold:VERBOSE xbt_help.fmt:%m%n");
94 /* Set logs and init log submodule */
95 for (int i = 1; i < *argc; i++) {
96 if (strcmp("--", argv[i]) == 0) {
98 argv[j++] = argv[i]; // Keep the '--' for sg_config
99 } else if (parse_args && strncmp(argv[i], "--log=", strlen("--log=")) == 0) {
100 char* opt = strchr(argv[i], '=');
102 xbt_log_control_set(opt);
103 XBT_DEBUG("Did apply '%s' as log setting", opt);
104 } else if (parse_args && strcmp(argv[i], "--help-logs") == 0) {
105 help_requested |= 1U;
106 } else if (parse_args && strcmp(argv[i], "--help-log-categories") == 0) {
107 help_requested |= 2U;
117 if (help_requested) {
118 if (help_requested & 1)
120 if (help_requested & 2)
121 xbt_log_help_categories();
126 static void log_cat_exit(const s_xbt_log_category_t* cat)
129 if (cat->appender->free_)
130 cat->appender->free_(cat->appender);
131 xbt_free(cat->appender);
134 if (cat->layout->free_)
135 cat->layout->free_(cat->layout);
136 xbt_free(cat->layout);
139 for (auto const* child = cat->firstChild; child != nullptr; child = child->nextSibling)
143 void xbt_log_postexit(void)
145 XBT_VERB("Exiting log");
146 delete log_cat_init_mutex;
147 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
150 /* Size of the static string in which we build the log string */
151 static constexpr size_t XBT_LOG_STATIC_BUFFER_SIZE = 2048;
152 /* Minimum size of the dynamic string in which we build the log string
153 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
154 static constexpr size_t XBT_LOG_DYNAMIC_BUFFER_SIZE = 4096;
156 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
158 const xbt_log_category_s* cat = ev->cat;
160 xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
161 xbt_assert(static_cast<size_t>(ev->priority) < sizeof(xbt_log_priority_names)/sizeof(xbt_log_priority_names[0]),
162 "Priority %d is greater than the biggest allowed value", ev->priority);
165 const s_xbt_log_appender_t* appender = cat->appender;
167 if (appender != nullptr) {
168 xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
170 /* First, try with a static buffer */
172 char buff[XBT_LOG_STATIC_BUFFER_SIZE];
174 ev->buffer_size = sizeof buff;
175 va_start(ev->ap, fmt);
176 done = cat->layout->do_layout(cat->layout, ev, fmt);
178 ev->buffer = nullptr; // Calm down, static analyzers, this pointer to local array wont leak out of the scope.
180 appender->do_append(appender, buff);
182 /* The static buffer was too small, use a dynamically expanded one */
183 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
184 ev->buffer = static_cast<char*>(xbt_malloc(ev->buffer_size));
186 va_start(ev->ap, fmt);
187 done = cat->layout->do_layout(cat->layout, ev, fmt);
191 ev->buffer_size *= 2;
192 ev->buffer = static_cast<char*>(xbt_realloc(ev->buffer, ev->buffer_size));
194 appender->do_append(appender, ev->buffer);
195 xbt_free(ev->buffer);
199 if (!cat->additivity)
207 * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init(). Thus, if we want to avoid an
208 * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
211 * To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
212 * macro has to be called at the beginning of the affected functions.
214 static int fake_xbt_log_cat_init(xbt_log_category_t, e_xbt_log_priority_t)
218 #define DISABLE_XBT_LOG_CAT_INIT() \
219 int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) XBT_ATTRIB_UNUSED = fake_xbt_log_cat_init;
221 static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_setting_t& setting)
223 DISABLE_XBT_LOG_CAT_INIT();
224 if (setting.thresh != xbt_log_priority_uninitialized) {
225 xbt_log_threshold_set(category, setting.thresh);
227 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
228 category->name, xbt_log_priority_names[category->threshold], category->threshold);
231 if (not setting.fmt.empty()) {
232 xbt_log_layout_set(category, xbt_log_layout_format_new(setting.fmt.c_str()));
234 XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting.fmt.c_str());
237 if (setting.additivity != -1) {
238 xbt_log_additivity_set(category, setting.additivity);
240 XBT_DEBUG("Apply settings for category '%s': set additivity to %s", category->name,
241 (setting.additivity ? "on" : "off"));
243 if (setting.appender) {
244 xbt_log_appender_set(category, setting.appender);
245 if (!category->layout)
246 xbt_log_layout_set(category, xbt_log_layout_simple_new(nullptr));
247 category->additivity = 0;
248 XBT_DEBUG("Set %p as appender of category '%s'", setting.appender, category->name);
253 * This gets called the first time a category is referenced and performs the initialization.
254 * Also resets threshold to inherited!
256 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
258 DISABLE_XBT_LOG_CAT_INIT();
259 if (category->initialized)
260 return priority >= category->threshold;
262 if (log_cat_init_mutex != nullptr)
263 log_cat_init_mutex->lock();
265 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
266 (category->firstChild ? category->firstChild->name : "none"),
267 (category->nextSibling ? category->nextSibling->name : "none"));
269 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
270 category->threshold = xbt_log_priority_info;
271 category->appender = xbt_log_default_appender;
272 category->layout = xbt_log_default_layout;
274 if (!category->parent)
275 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
277 XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
278 (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
280 xbt_log_parent_set(category, category->parent);
282 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
284 const xbt_log_category_s* cpp = category->parent->firstChild;
286 res += std::string(" ") + cpp->name;
287 cpp = cpp->nextSibling;
290 XBT_DEBUG("Children of %s:%s; nextSibling: %s", category->parent->name, res.c_str(),
291 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
295 /* Apply the control */
296 auto iset = std::find_if(begin(xbt_log_settings), end(xbt_log_settings),
297 [category](const xbt_log_setting_t& s) { return s.catname == category->name; });
298 if (iset != xbt_log_settings.end()) {
299 _xbt_log_cat_apply_set(category, *iset);
300 xbt_log_settings.erase(iset);
302 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)", category->name,
303 xbt_log_priority_names[category->threshold], category->threshold);
306 category->initialized = 1;
307 if (log_cat_init_mutex != nullptr)
308 log_cat_init_mutex->unlock();
309 return priority >= category->threshold;
312 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
314 xbt_assert(cat, "NULL category to be given a parent");
315 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
317 /* if the category is initialized, unlink from current parent */
318 if (cat->initialized) {
319 xbt_log_category_t *cpp = &cat->parent->firstChild;
321 while (*cpp != cat && *cpp != nullptr) {
322 cpp = &(*cpp)->nextSibling;
325 xbt_assert(*cpp == cat);
326 *cpp = cat->nextSibling;
329 cat->parent = parent;
330 cat->nextSibling = parent->firstChild;
332 parent->firstChild = cat;
334 if (!parent->initialized)
335 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
337 cat->threshold = parent->threshold;
339 cat->isThreshInherited = 1;
342 static void _set_inherited_thresholds(const s_xbt_log_category_t* cat)
344 xbt_log_category_t child = cat->firstChild;
346 for (; child != nullptr; child = child->nextSibling) {
347 if (child->isThreshInherited) {
348 if (cat != &_XBT_LOGV(log))
349 XBT_VERB("Set category threshold of %s to %s (=%d)",
350 child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
351 child->threshold = cat->threshold;
352 _set_inherited_thresholds(child);
357 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
359 cat->threshold = threshold;
360 cat->isThreshInherited = 0;
362 _set_inherited_thresholds(cat);
365 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
367 const char *orig_control_string = control_string;
368 xbt_log_setting_t set;
370 if (!*control_string)
372 XBT_DEBUG("Parse log setting '%s'", control_string);
374 control_string += strspn(control_string, " ");
375 const char* name = control_string;
376 control_string += strcspn(control_string, ".:= ");
377 const char* option = control_string;
378 control_string += strcspn(control_string, ":= ");
379 const char* value = control_string;
381 xbt_assert(*option == '.' && (*value == '=' || *value == ':'), "Invalid control string '%s'", orig_control_string);
383 size_t name_len = option - name;
385 size_t option_len = value - option;
388 if (strncmp(option, "threshold", option_len) == 0) {
389 XBT_DEBUG("New priority name = %s", value);
391 for (i = 0; i < xbt_log_priority_infinite; i++) {
392 if (strcasecmp(value, xbt_log_priority_names[i]) == 0) {
393 XBT_DEBUG("This is priority %d", i);
398 if(i<XBT_LOG_STATIC_THRESHOLD){
399 fprintf(stderr, "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
400 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
401 "while -DNLOG forbids any logging, at any level.",
402 value, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
404 }else if (i < xbt_log_priority_infinite) {
405 set.thresh = (e_xbt_log_priority_t)i;
407 throw std::invalid_argument(simgrid::xbt::string_printf(
408 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value));
410 } else if (strncmp(option, "additivity", option_len) == 0) {
411 set.additivity = (strcasecmp(value, "ON") == 0 || strcasecmp(value, "YES") == 0 || strcmp(value, "1") == 0);
412 } else if (strncmp(option, "appender", option_len) == 0) {
413 if (strncmp(value, "file:", 5) == 0) {
414 set.appender = xbt_log_appender_file_new(value + 5);
415 } else if (strncmp(value, "rollfile:", 9) == 0) {
416 set.appender = xbt_log_appender2_file_new(value + 9, 1);
417 } else if (strncmp(value, "splitfile:", 10) == 0) {
418 set.appender = xbt_log_appender2_file_new(value + 10, 0);
419 } else if (strcmp(value, "stderr") == 0) {
420 set.appender = xbt_log_appender_stream(stderr);
421 } else if (strcmp(value, "stdout") == 0) {
422 set.appender = xbt_log_appender_stream(stdout);
424 throw std::invalid_argument(simgrid::xbt::string_printf("Unknown appender log type: '%s'", value));
426 } else if (strncmp(option, "fmt", option_len) == 0) {
427 set.fmt = std::string(value);
429 xbt_die("Unknown setting of the log category: '%.*s'", static_cast<int>(option_len), option);
431 set.catname = std::string(name, name_len);
433 XBT_DEBUG("This is for cat '%s'", set.catname.c_str());
438 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, const char* name)
440 xbt_log_category_t child;
441 xbt_log_category_t res;
443 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
444 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
445 (cat->nextSibling ? cat->nextSibling->name : "none"));
446 if (strcmp(cat->name, name) == 0)
449 for (child = cat->firstChild; child != nullptr; child = child->nextSibling) {
450 XBT_DEBUG("Dig into %s", child->name);
451 res = _xbt_log_cat_searchsub(child, name);
461 * @param control_string What to parse
463 * Typically passed a command-line argument. The string has the syntax:
465 * ( [category] "." [keyword] ":" value (" ")... )...
467 * where [category] is one the category names (see @ref XBT_log_cats for a complete list of the ones defined in the
468 * SimGrid library) and keyword is one of the following:
470 * - thres: category's threshold priority. Possible values:
471 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
472 * - add or additivity: whether the logging actions must be passed to the parent category.
473 * Possible values: 0, 1, no, yes, on, off.
474 * Default value: yes.
475 * - fmt: the format to use. See @ref log_use_conf_fmt for more information.
476 * - app or appender: the appender to use. See @ref log_use_conf_app for more information.
478 void xbt_log_control_set(const char *control_string)
480 /* To split the string in commands, and the cursors */
481 xbt_dynar_t set_strings;
487 XBT_DEBUG("Parse log settings '%s'", control_string);
489 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
490 if (strcmp(control_string, "no_loc") == 0) {
494 /* split the string, and remove empty entries */
495 set_strings = xbt_str_split_quoted(control_string);
497 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
498 xbt_dynar_free(&set_strings);
502 /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
503 xbt_dynar_foreach(set_strings, cpt, str) {
504 xbt_log_setting_t set = _xbt_log_parse_setting(str);
505 xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set.catname.c_str());
508 XBT_DEBUG("Apply directly");
509 _xbt_log_cat_apply_set(cat, set);
511 XBT_DEBUG("Store for further application");
512 XBT_DEBUG("push %p to the settings", &set);
513 xbt_log_settings.emplace_back(std::move(set));
516 xbt_dynar_free(&set_strings);
519 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
522 if (cat->appender->free_)
523 cat->appender->free_(cat->appender);
524 xbt_free(cat->appender);
529 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
531 DISABLE_XBT_LOG_CAT_INIT();
532 if (!cat->appender) {
533 XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
534 xbt_log_appender_set(cat, xbt_log_appender_file_new(nullptr));
537 if (cat->layout->free_) {
538 cat->layout->free_(cat->layout);
540 xbt_free(cat->layout);
543 xbt_log_additivity_set(cat, 0);
546 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
548 cat->additivity = additivity;
551 static void xbt_log_help(void)
554 "Description of the logging output:\n"
556 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
557 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
558 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
559 " -> trace: enter and return of some functions\n"
560 " -> debug: crufty output\n"
561 " -> verbose: verbose output for the user wanting more\n"
562 " -> info: output about the regular functioning\n"
563 " -> warning: minor issue encountered\n"
564 " -> error: issue encountered\n"
565 " -> critical: major issue encountered\n"
566 " The default priority level is 'info'.\n"
568 " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
569 " FORMAT string may contain:\n"
570 " -> %%%%: the %% char\n"
571 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
572 " -> %%e: plain old space (SimGrid extension)\n"
574 " -> %%m: user-provided message\n"
576 " -> %%c: Category name (LOG4J compatible)\n"
577 " -> %%p: Priority name (LOG4J compatible)\n"
579 " -> %%h: Hostname (SimGrid extension)\n"
580 " -> %%P: Process name (SimGrid extension)\n"
581 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
582 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
584 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
585 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
587 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
588 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
590 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
592 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
593 "mac ones for example.\n"
594 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
595 "defined where %%b is.\n"
597 " -> %%d: date (UNIX-like epoch)\n"
598 " -> %%r: application age (time elapsed since the beginning of the application)\n"
600 " Category appender: --log=CATEGORY_NAME.app:APPENDER\n"
601 " APPENDER may be:\n"
602 " -> stdout or stderr: standard output streams\n"
603 " -> file:NAME: append to file with given name\n"
604 " -> splitfile:SIZE:NAME: append to files with maximum size SIZE per file.\n"
605 " NAME may contain the %% wildcard as a placeholder for the file number.\n"
606 " -> rollfile:SIZE:NAME: append to file with maximum size SIZE.\n"
608 " Category additivity: --log=CATEGORY_NAME.add:VALUE\n"
609 " VALUE: '0', '1', 'no', 'yes', 'on', or 'off'\n"
612 " --help-log-categories Display the current hierarchy of log categories.\n"
613 " --log=no_loc Don't print file names in messages (for tesh tests).\n");
616 static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
621 std::string this_prefix(prefix);
622 std::string child_prefix(prefix);
623 if (category->parent) {
624 this_prefix += " \\_ ";
625 child_prefix += " | ";
628 std::vector<xbt_log_category_t> cats;
629 for (xbt_log_category_t cat = category; cat != nullptr; cat = cat->nextSibling)
632 std::sort(begin(cats), end(cats),
633 [](const s_xbt_log_category_t* a, const s_xbt_log_category_t* b) { return strcmp(a->name, b->name) < 0; });
635 for (auto const& cat : cats) {
636 XBT_HELP("%s%s: %s", this_prefix.c_str(), cat->name, cat->description);
637 if (cat == cats.back() && category->parent)
638 child_prefix[child_prefix.rfind('|')] = ' ';
639 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
643 static void xbt_log_help_categories(void)
645 XBT_HELP("Current log category hierarchy:");
646 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");