1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2021. 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"
19 #include <unordered_set>
22 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
23 static std::recursive_mutex* log_cat_init_mutex = nullptr;
25 /** @addtogroup XBT_log
27 * For more information, please refer to @ref outcomes_logs Section.
30 xbt_log_appender_t xbt_log_default_appender = nullptr; /* set in log_init */
31 xbt_log_layout_t xbt_log_default_layout = nullptr; /* set in log_init */
33 struct xbt_log_setting_t {
36 e_xbt_log_priority_t thresh = xbt_log_priority_uninitialized;
38 xbt_log_appender_t appender = nullptr;
41 // This function is here to avoid static initialization order fiasco
42 static auto& xbt_log_settings()
44 static std::vector<xbt_log_setting_t> value;
48 constexpr std::array<const char*, 8> xbt_log_priority_names{
49 {"NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARNING", "ERROR", "CRITICAL"}};
51 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
53 nullptr /* firstChild */,
54 nullptr /* nextSibling */,
56 "The common ancestor for all categories",
58 xbt_log_priority_uninitialized /* threshold */,
59 0 /* isThreshInherited */,
60 nullptr /* appender */,
65 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
67 /* create the default appender and install it in the root category,
68 which were already created (damnit. Too slow little beetle) */
69 void xbt_log_preinit(void)
71 xbt_log_default_appender = xbt_log_appender_stream(stderr);
72 xbt_log_default_layout = xbt_log_layout_simple_new(nullptr);
73 _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
74 _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
75 log_cat_init_mutex = new std::recursive_mutex();
78 static void xbt_log_help();
79 static void xbt_log_help_categories();
81 /** @brief Get all logging settings from the command line
83 * xbt_log_control_set() is called on each string we got from cmd line
85 void xbt_log_init(int *argc, char **argv)
87 unsigned help_requested = 0; /* 1: logs; 2: categories */
89 int parse_args = 1; // Stop parsing the parameters once we found '--'
91 xbt_log_control_set("xbt_help.app:stdout xbt_help.threshold:VERBOSE xbt_help.fmt:%m%n");
93 /* Set logs and init log submodule */
94 for (int i = 1; i < *argc; i++) {
95 if (strcmp("--", argv[i]) == 0) {
97 argv[j++] = argv[i]; // Keep the '--' for sg_config
98 } else if (parse_args && strncmp(argv[i], "--log=", strlen("--log=")) == 0) {
99 char* opt = strchr(argv[i], '=');
101 xbt_log_control_set(opt);
102 XBT_DEBUG("Did apply '%s' as log setting", opt);
103 } else if (parse_args && strcmp(argv[i], "--help-logs") == 0) {
104 help_requested |= 1U;
105 } else if (parse_args && strcmp(argv[i], "--help-log-categories") == 0) {
106 help_requested |= 2U;
116 if (help_requested) {
117 if (help_requested & 1)
119 if (help_requested & 2)
120 xbt_log_help_categories();
125 static void log_cat_exit(const s_xbt_log_category_t* cat)
128 if (cat->appender->free_)
129 cat->appender->free_(cat->appender);
130 xbt_free(cat->appender);
133 if (cat->layout->free_)
134 cat->layout->free_(cat->layout);
135 xbt_free(cat->layout);
138 for (auto const* child = cat->firstChild; child != nullptr; child = child->nextSibling)
142 void xbt_log_postexit(void)
144 XBT_VERB("Exiting log");
145 delete log_cat_init_mutex;
146 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
149 /* Size of the static string in which we build the log string */
150 static constexpr size_t XBT_LOG_STATIC_BUFFER_SIZE = 2048;
151 /* Minimum size of the dynamic string in which we build the log string
152 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
153 static constexpr size_t XBT_LOG_DYNAMIC_BUFFER_SIZE = 4096;
155 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
157 const xbt_log_category_s* cat = ev->cat;
159 xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
160 xbt_assert(static_cast<size_t>(ev->priority) < xbt_log_priority_names.size(),
161 "Priority %d is greater than the biggest allowed value", ev->priority);
164 const s_xbt_log_appender_t* appender = cat->appender;
166 if (appender != nullptr) {
167 xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
169 /* First, try with a static buffer */
171 std::array<char, XBT_LOG_STATIC_BUFFER_SIZE> buff;
172 ev->buffer = buff.data();
173 ev->buffer_size = buff.size();
174 va_start(ev->ap, fmt);
175 done = cat->layout->do_layout(cat->layout, ev, fmt);
177 ev->buffer = nullptr; // Calm down, static analyzers, this pointer to local array won't leak out of the scope.
179 appender->do_append(appender, buff.data());
181 /* The static buffer was too small, use a dynamically expanded one */
182 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
183 ev->buffer = static_cast<char*>(xbt_malloc(ev->buffer_size));
185 va_start(ev->ap, fmt);
186 done = cat->layout->do_layout(cat->layout, ev, fmt);
190 ev->buffer_size *= 2;
191 ev->buffer = static_cast<char*>(xbt_realloc(ev->buffer, ev->buffer_size));
193 appender->do_append(appender, ev->buffer);
194 xbt_free(ev->buffer);
198 if (!cat->additivity)
206 * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init(). Thus, if we want to avoid an
207 * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
210 * To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
211 * macro has to be called at the beginning of the affected functions.
213 static int fake_xbt_log_cat_init(xbt_log_category_t, e_xbt_log_priority_t)
217 #define DISABLE_XBT_LOG_CAT_INIT() \
218 int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) XBT_ATTRIB_UNUSED = fake_xbt_log_cat_init;
220 static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_setting_t& setting)
222 DISABLE_XBT_LOG_CAT_INIT();
223 if (setting.thresh != xbt_log_priority_uninitialized) {
224 xbt_log_threshold_set(category, setting.thresh);
226 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
227 category->name, xbt_log_priority_names[category->threshold], category->threshold);
230 if (not setting.fmt.empty()) {
231 xbt_log_layout_set(category, xbt_log_layout_format_new(setting.fmt.c_str()));
233 XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting.fmt.c_str());
236 if (setting.additivity != -1) {
237 xbt_log_additivity_set(category, setting.additivity);
239 XBT_DEBUG("Apply settings for category '%s': set additivity to %s", category->name,
240 (setting.additivity ? "on" : "off"));
242 if (setting.appender) {
243 xbt_log_appender_set(category, setting.appender);
244 if (!category->layout)
245 xbt_log_layout_set(category, xbt_log_layout_simple_new(nullptr));
246 category->additivity = 0;
247 XBT_DEBUG("Set %p as appender of category '%s'", setting.appender, category->name);
251 /** Asserts that the provided name is unique */
252 void _xbt_log_is_name_unique(const char* name, const char* file, int line)
254 static std::unordered_set<std::string> used_names;
256 if (used_names.find(name) != used_names.end())
257 XBT_WARN("%s:%d: log category redefined: %s", file, line, name);
258 used_names.insert(std::string(name));
262 * This gets called the first time a category is referenced and performs the initialization.
263 * Also resets threshold to inherited!
265 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
267 DISABLE_XBT_LOG_CAT_INIT();
269 if (category->initialized)
270 return priority >= category->threshold;
272 if (log_cat_init_mutex != nullptr)
273 log_cat_init_mutex->lock();
275 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
276 (category->firstChild ? category->firstChild->name : "none"),
277 (category->nextSibling ? category->nextSibling->name : "none"));
279 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
280 category->threshold = xbt_log_priority_info;
281 category->appender = xbt_log_default_appender;
282 category->layout = xbt_log_default_layout;
284 if (!category->parent)
285 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
287 XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
288 (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
290 xbt_log_parent_set(category, category->parent);
292 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
294 const xbt_log_category_s* cpp = category->parent->firstChild;
296 res += std::string(" ") + cpp->name;
297 cpp = cpp->nextSibling;
300 XBT_DEBUG("Children of %s:%s; nextSibling: %s", category->parent->name, res.c_str(),
301 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
305 /* Apply the control */
306 auto iset = std::find_if(begin(xbt_log_settings()), end(xbt_log_settings()),
307 [category](const xbt_log_setting_t& s) { return s.catname == category->name; });
308 if (iset != xbt_log_settings().end()) {
309 _xbt_log_cat_apply_set(category, *iset);
310 xbt_log_settings().erase(iset);
312 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)", category->name,
313 xbt_log_priority_names[category->threshold], category->threshold);
316 category->initialized = 1;
317 if (log_cat_init_mutex != nullptr)
318 log_cat_init_mutex->unlock();
319 return priority >= category->threshold;
322 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
324 xbt_assert(cat, "NULL category to be given a parent");
325 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
327 /* if the category is initialized, unlink from current parent */
328 if (cat->initialized) {
329 xbt_log_category_t *cpp = &cat->parent->firstChild;
331 while (*cpp != cat && *cpp != nullptr) {
332 cpp = &(*cpp)->nextSibling;
335 xbt_assert(*cpp == cat);
336 *cpp = cat->nextSibling;
339 cat->parent = parent;
340 cat->nextSibling = parent->firstChild;
342 parent->firstChild = cat;
344 if (!parent->initialized)
345 _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
347 cat->threshold = parent->threshold;
349 cat->isThreshInherited = 1;
352 static void _set_inherited_thresholds(const s_xbt_log_category_t* cat)
354 xbt_log_category_t child = cat->firstChild;
356 for (; child != nullptr; child = child->nextSibling) {
357 if (child->isThreshInherited) {
358 if (cat != &_XBT_LOGV(log))
359 XBT_VERB("Set category threshold of %s to %s (=%d)",
360 child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
361 child->threshold = cat->threshold;
362 _set_inherited_thresholds(child);
367 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
369 cat->threshold = threshold;
370 cat->isThreshInherited = 0;
372 _set_inherited_thresholds(cat);
375 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
377 const char *orig_control_string = control_string;
378 xbt_log_setting_t set;
380 if (!*control_string)
382 XBT_DEBUG("Parse log setting '%s'", control_string);
384 control_string += strspn(control_string, " ");
385 const char* name = control_string;
386 control_string += strcspn(control_string, ".:= ");
387 const char* option = control_string;
388 control_string += strcspn(control_string, ":= ");
389 const char* value = control_string;
391 xbt_assert(*option == '.' && (*value == '=' || *value == ':'), "Invalid control string '%s'", orig_control_string);
393 size_t name_len = option - name;
395 size_t option_len = value - option;
398 if (strncmp(option, "threshold", option_len) == 0) {
399 XBT_DEBUG("New priority name = %s", value);
401 for (i = 0; i < xbt_log_priority_infinite; i++) {
402 if (strcasecmp(value, xbt_log_priority_names[i]) == 0) {
403 XBT_DEBUG("This is priority %d", i);
408 if(i<XBT_LOG_STATIC_THRESHOLD){
409 fprintf(stderr, "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
410 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
411 "while -DNLOG forbids any logging, at any level.",
412 value, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
414 }else if (i < xbt_log_priority_infinite) {
415 set.thresh = (e_xbt_log_priority_t)i;
417 throw std::invalid_argument(simgrid::xbt::string_printf(
418 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value));
420 } else if (strncmp(option, "additivity", option_len) == 0) {
421 set.additivity = (strcasecmp(value, "ON") == 0 || strcasecmp(value, "YES") == 0 || strcmp(value, "1") == 0);
422 } else if (strncmp(option, "appender", option_len) == 0) {
423 if (strncmp(value, "file:", 5) == 0) {
424 set.appender = xbt_log_appender_file_new(value + 5);
425 } else if (strncmp(value, "rollfile:", 9) == 0) {
426 set.appender = xbt_log_appender2_file_new(value + 9, 1);
427 } else if (strncmp(value, "splitfile:", 10) == 0) {
428 set.appender = xbt_log_appender2_file_new(value + 10, 0);
429 } else if (strcmp(value, "stderr") == 0) {
430 set.appender = xbt_log_appender_stream(stderr);
431 } else if (strcmp(value, "stdout") == 0) {
432 set.appender = xbt_log_appender_stream(stdout);
434 throw std::invalid_argument(simgrid::xbt::string_printf("Unknown appender log type: '%s'", value));
436 } else if (strncmp(option, "fmt", option_len) == 0) {
437 set.fmt = std::string(value);
439 xbt_die("Unknown setting of the log category: '%.*s'", static_cast<int>(option_len), option);
441 set.catname = std::string(name, name_len);
443 XBT_DEBUG("This is for cat '%s'", set.catname.c_str());
448 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, const char* name)
450 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
451 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
452 (cat->nextSibling ? cat->nextSibling->name : "none"));
453 if (strcmp(cat->name, name) == 0)
456 for (xbt_log_category_t child = cat->firstChild; child != nullptr; child = child->nextSibling) {
457 XBT_DEBUG("Dig into %s", child->name);
458 xbt_log_category_t res = _xbt_log_cat_searchsub(child, name);
468 * @param control_string What to parse
470 * Typically passed a command-line argument. The string has the syntax:
472 * ( [category] "." [keyword] ":" value (" ")... )...
474 * where [category] is one the category names (see @ref XBT_log_cats for a complete list of the ones defined in the
475 * SimGrid library) and keyword is one of the following:
477 * - thres: category's threshold priority. Possible values:
478 * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
479 * - add or additivity: whether the logging actions must be passed to the parent category.
480 * Possible values: 0, 1, no, yes, on, off.
481 * Default value: yes.
482 * - fmt: the format to use. See @ref log_use_conf_fmt for more information.
483 * - app or appender: the appender to use. See @ref log_use_conf_app for more information.
485 void xbt_log_control_set(const char *control_string)
487 /* To split the string in commands, and the cursors */
488 xbt_dynar_t set_strings;
494 XBT_DEBUG("Parse log settings '%s'", control_string);
496 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
497 if (strcmp(control_string, "no_loc") == 0) {
501 /* split the string, and remove empty entries */
502 set_strings = xbt_str_split_quoted(control_string);
504 if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
505 xbt_dynar_free(&set_strings);
509 /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
510 xbt_dynar_foreach(set_strings, cpt, str) {
511 xbt_log_setting_t set = _xbt_log_parse_setting(str);
512 xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set.catname.c_str());
515 XBT_DEBUG("Apply directly");
516 _xbt_log_cat_apply_set(cat, set);
518 XBT_DEBUG("Store for further application");
519 XBT_DEBUG("push %p to the settings", &set);
520 xbt_log_settings().emplace_back(std::move(set));
523 xbt_dynar_free(&set_strings);
526 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
529 if (cat->appender->free_)
530 cat->appender->free_(cat->appender);
531 xbt_free(cat->appender);
536 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
538 DISABLE_XBT_LOG_CAT_INIT();
539 if (!cat->appender) {
540 XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
541 xbt_log_appender_set(cat, xbt_log_appender_file_new(nullptr));
544 if (cat->layout->free_) {
545 cat->layout->free_(cat->layout);
547 xbt_free(cat->layout);
550 xbt_log_additivity_set(cat, 0);
553 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
555 cat->additivity = additivity;
558 static void xbt_log_help()
561 "Description of the logging output:\n"
563 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
564 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
565 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
566 " -> trace: enter and return of some functions\n"
567 " -> debug: crufty output\n"
568 " -> verbose: verbose output for the user wanting more\n"
569 " -> info: output about the regular functioning\n"
570 " -> warning: minor issue encountered\n"
571 " -> error: issue encountered\n"
572 " -> critical: major issue encountered\n"
573 " The default priority level is 'info'.\n"
575 " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
576 " FORMAT string may contain:\n"
577 " -> %%%%: the %% char\n"
578 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
579 " -> %%e: plain old space (SimGrid extension)\n"
581 " -> %%m: user-provided message\n"
583 " -> %%c: Category name (LOG4J compatible)\n"
584 " -> %%p: Priority name (LOG4J compatible)\n"
586 " -> %%h: Hostname (SimGrid extension)\n"
587 " -> %%P: Process name (SimGrid extension)\n"
588 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
589 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
591 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
592 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
594 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
595 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
597 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
599 " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
600 "mac ones for example.\n"
601 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
602 "defined where %%b is.\n"
604 " -> %%d: date (UNIX-like epoch)\n"
605 " -> %%r: application age (time elapsed since the beginning of the application)\n"
607 " Category appender: --log=CATEGORY_NAME.app:APPENDER\n"
608 " APPENDER may be:\n"
609 " -> stdout or stderr: standard output streams\n"
610 " -> file:NAME: append to file with given name\n"
611 " -> splitfile:SIZE:NAME: append to files with maximum size SIZE per file.\n"
612 " NAME may contain the %% wildcard as a placeholder for the file number.\n"
613 " -> rollfile:SIZE:NAME: append to file with maximum size SIZE.\n"
615 " Category additivity: --log=CATEGORY_NAME.add:VALUE\n"
616 " VALUE: '0', '1', 'no', 'yes', 'on', or 'off'\n"
619 " --help-log-categories Display the current hierarchy of log categories.\n"
620 " --log=no_loc Don't print file names in messages (for tesh tests).\n");
623 static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
628 std::string this_prefix(prefix);
629 std::string child_prefix(prefix);
630 if (category->parent) {
631 this_prefix += " \\_ ";
632 child_prefix += " | ";
635 std::vector<xbt_log_category_t> cats;
636 for (xbt_log_category_t cat = category; cat != nullptr; cat = cat->nextSibling)
639 std::sort(begin(cats), end(cats),
640 [](const s_xbt_log_category_t* a, const s_xbt_log_category_t* b) { return strcmp(a->name, b->name) < 0; });
642 for (auto const& cat : cats) {
643 XBT_HELP("%s%s: %s", this_prefix.c_str(), cat->name, cat->description);
644 if (cat == cats.back() && category->parent)
645 child_prefix[child_prefix.rfind('|')] = ' ';
646 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
650 static void xbt_log_help_categories()
652 XBT_HELP("Current log category hierarchy:");
653 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");