1 /* log - a generic logging facility in the spirit of log4j */
3 /* Copyright (c) 2004-2023. 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 "xbt/string.hpp"
10 #include "xbt/sysdep.h"
14 #include <boost/tokenizer.hpp>
20 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
22 struct xbt_log_setting_t {
25 e_xbt_log_priority_t thresh = xbt_log_priority_uninitialized;
27 xbt_log_appender_t appender = nullptr;
30 // This function is here to avoid static initialization order fiasco
31 static auto& xbt_log_settings()
33 static std::vector<xbt_log_setting_t> value;
37 constexpr std::array<const char*, xbt_log_priority_infinite> xbt_log_priority_names{
38 {"NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARNING", "ERROR", "CRITICAL"}};
40 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
42 nullptr /* firstChild */,
43 nullptr /* nextSibling */,
45 "The common ancestor for all categories",
47 xbt_log_priority_uninitialized /* threshold */,
48 0 /* isThreshInherited */,
49 nullptr /* appender */,
54 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
56 static void xbt_log_help();
57 static void xbt_log_help_categories();
58 static void xbt_log_postexit();
60 void xbt_log_init(int *argc, char **argv)
62 unsigned help_requested = 0; /* 1: logs; 2: categories */
64 int parse_args = 1; // Stop parsing the parameters once we found '--'
66 xbt_log_control_set("xbt_help.app:stdout xbt_help.threshold:VERBOSE xbt_help.fmt:%m%n");
67 atexit(xbt_log_postexit);
69 /* Set logs and init log submodule */
70 for (int i = 1; i < *argc; i++) {
71 if (strcmp("--", argv[i]) == 0) {
73 argv[j++] = argv[i]; // Keep the '--' for sg_config
74 } else if (parse_args && strncmp(argv[i], "--log=", strlen("--log=")) == 0) {
75 char* opt = strchr(argv[i], '=');
77 xbt_log_control_set(opt);
78 XBT_DEBUG("Did apply '%s' as log setting", opt);
79 } else if (parse_args && strcmp(argv[i], "--help-logs") == 0) {
81 } else if (parse_args && strcmp(argv[i], "--help-log-categories") == 0) {
93 if (help_requested & 1)
95 if (help_requested & 2)
96 xbt_log_help_categories();
101 static void log_cat_exit(xbt_log_category_t cat)
104 if (cat->appender->free_)
105 cat->appender->free_(cat->appender);
106 xbt_free(cat->appender);
107 cat->appender = nullptr;
110 if (cat->layout->free_)
111 cat->layout->free_(cat->layout);
112 xbt_free(cat->layout);
113 cat->layout = nullptr;
116 for (auto* child = cat->firstChild; child != nullptr; child = child->nextSibling)
118 cat->firstChild = nullptr;
121 static void xbt_log_postexit(void)
123 XBT_VERB("Exiting log");
124 log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
127 /* Size of the static string in which we build the log string */
128 static constexpr size_t XBT_LOG_STATIC_BUFFER_SIZE = 2048;
129 /* Minimum size of the dynamic string in which we build the log string
130 (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
131 static constexpr size_t XBT_LOG_DYNAMIC_BUFFER_SIZE = 4096;
133 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
135 const xbt_log_category_s* cat = ev->cat;
137 xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
138 xbt_assert(static_cast<size_t>(ev->priority) < xbt_log_priority_names.size(),
139 "Priority %d is greater than the biggest allowed value", ev->priority);
142 if (const s_xbt_log_appender_t* appender = cat->appender) {
143 xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
145 /* First, try with a static buffer */
147 std::array<char, XBT_LOG_STATIC_BUFFER_SIZE> buff;
148 ev->buffer = buff.data();
149 ev->buffer_size = buff.size();
150 va_start(ev->ap, fmt);
151 done = cat->layout->do_layout(cat->layout, ev, fmt);
153 ev->buffer = nullptr; // Calm down, static analyzers, this pointer to local array won't leak out of the scope.
155 appender->do_append(appender, buff.data());
157 /* The static buffer was too small, use a dynamically expanded one */
158 ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
159 ev->buffer = static_cast<char*>(xbt_malloc(ev->buffer_size));
161 va_start(ev->ap, fmt);
162 done = cat->layout->do_layout(cat->layout, ev, fmt);
166 ev->buffer_size *= 2;
167 ev->buffer = static_cast<char*>(xbt_realloc(ev->buffer, ev->buffer_size));
169 appender->do_append(appender, ev->buffer);
170 xbt_free(ev->buffer);
174 if (not cat->additivity)
182 * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init(). Thus, if we want to avoid an
183 * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
186 * To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
187 * macro has to be called at the beginning of the affected functions.
189 static int fake_xbt_log_cat_init(xbt_log_category_t, e_xbt_log_priority_t)
193 #define DISABLE_XBT_LOG_CAT_INIT() \
194 XBT_ATTRIB_UNUSED int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) = fake_xbt_log_cat_init
196 static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_setting_t& setting)
198 DISABLE_XBT_LOG_CAT_INIT();
199 if (setting.thresh != xbt_log_priority_uninitialized) {
200 xbt_log_threshold_set(category, setting.thresh);
202 XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
203 category->name, xbt_log_priority_names[category->threshold], category->threshold);
206 if (not setting.fmt.empty()) {
207 xbt_log_layout_set(category, xbt_log_layout_format_new(setting.fmt.c_str()));
209 XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting.fmt.c_str());
212 if (setting.additivity != -1) {
213 xbt_log_additivity_set(category, setting.additivity);
215 XBT_DEBUG("Apply settings for category '%s': set additivity to %s", category->name,
216 (setting.additivity ? "on" : "off"));
218 if (setting.appender) {
219 xbt_log_appender_set(category, setting.appender);
220 if (not category->layout)
221 xbt_log_layout_set(category, xbt_log_layout_simple_new(nullptr));
222 category->additivity = 0;
223 XBT_DEBUG("Set %p as appender of category '%s'", setting.appender, category->name);
228 * This gets called the first time a category is referenced and performs the initialization.
229 * Also resets threshold to inherited!
231 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
233 DISABLE_XBT_LOG_CAT_INIT();
234 if (category->initialized)
235 return priority >= category->threshold;
237 static std::recursive_mutex log_cat_init_mutex;
238 const std::scoped_lock lock(log_cat_init_mutex);
240 XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
241 (category->firstChild ? category->firstChild->name : "none"),
242 (category->nextSibling ? category->nextSibling->name : "none"));
244 if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
245 category->threshold = xbt_log_priority_info;
246 category->appender = xbt_log_appender_stream(stderr);
247 category->layout = xbt_log_layout_simple_new(nullptr);
249 if (not category->parent)
250 category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
252 XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
253 (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
255 xbt_log_parent_set(category, category->parent);
257 if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
259 const xbt_log_category_s* cpp = category->parent->firstChild;
261 res += std::string(" ") + cpp->name;
262 cpp = cpp->nextSibling;
265 XBT_DEBUG("Children of %s:%s; nextSibling: %s", category->parent->name, res.c_str(),
266 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
270 /* Apply the control */
271 if (auto iset = std::find_if(begin(xbt_log_settings()), end(xbt_log_settings()),
272 [category](const xbt_log_setting_t& s) { return s.catname == category->name; });
273 iset != xbt_log_settings().end()) {
274 _xbt_log_cat_apply_set(category, *iset);
275 xbt_log_settings().erase(iset);
277 XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)", category->name,
278 xbt_log_priority_names[category->threshold], category->threshold);
281 category->initialized = 1;
282 return priority >= category->threshold;
285 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
287 xbt_assert(cat, "NULL category to be given a parent");
288 xbt_assert(parent, "The parent category of %s is NULL", cat->name);
290 /* if the category is initialized, unlink from current parent */
291 if (cat->initialized) {
292 xbt_log_category_t *cpp = &cat->parent->firstChild;
294 while (*cpp != cat && *cpp != nullptr) {
295 cpp = &(*cpp)->nextSibling;
298 xbt_assert(*cpp == cat);
299 *cpp = cat->nextSibling;
302 cat->parent = parent;
303 cat->nextSibling = parent->firstChild;
305 parent->firstChild = cat;
307 if (not parent->initialized)
308 (void)_xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */);
310 cat->threshold = parent->threshold;
312 cat->isThreshInherited = 1;
315 static void _set_inherited_thresholds(const s_xbt_log_category_t* cat)
317 xbt_log_category_t child = cat->firstChild;
319 for (; child != nullptr; child = child->nextSibling) {
320 if (child->isThreshInherited) {
321 if (cat != &_XBT_LOGV(log))
322 XBT_VERB("Set category threshold of %s to %s (=%d)",
323 child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
324 child->threshold = cat->threshold;
325 _set_inherited_thresholds(child);
330 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
332 cat->threshold = threshold;
333 cat->isThreshInherited = 0;
335 _set_inherited_thresholds(cat);
338 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
340 const char *orig_control_string = control_string;
341 xbt_log_setting_t set;
343 if (not*control_string)
345 XBT_DEBUG("Parse log setting '%s'", control_string);
347 control_string += strspn(control_string, " ");
348 const char* name = control_string;
349 control_string += strcspn(control_string, ".:= ");
350 const char* option = control_string;
351 control_string += strcspn(control_string, ":= ");
352 const char* value = control_string;
354 xbt_assert(*option == '.' && (*value == '=' || *value == ':'), "Invalid control string '%s'", orig_control_string);
356 size_t name_len = option - name;
358 size_t option_len = value - option;
361 if (strncmp(option, "threshold", option_len) == 0) {
362 XBT_DEBUG("New priority name = %s", value);
364 for (i = 0; i < xbt_log_priority_infinite; i++) {
365 if (strcasecmp(value, xbt_log_priority_names[i]) == 0) {
366 XBT_DEBUG("This is priority %d", i);
371 if(i<XBT_LOG_STATIC_THRESHOLD){
372 fprintf(stderr, "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
373 "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
374 "while -DNLOG forbids any logging, at any level.",
375 value, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
377 }else if (i < xbt_log_priority_infinite) {
378 set.thresh = (e_xbt_log_priority_t)i;
380 throw std::invalid_argument(simgrid::xbt::string_printf(
381 "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value));
383 } else if (strncmp(option, "additivity", option_len) == 0) {
384 set.additivity = (strcasecmp(value, "ON") == 0 || strcasecmp(value, "YES") == 0 || strcmp(value, "1") == 0);
385 } else if (strncmp(option, "appender", option_len) == 0) {
386 if (strncmp(value, "file:", 5) == 0) {
387 set.appender = xbt_log_appender_file_new(value + 5);
388 } else if (strncmp(value, "rollfile:", 9) == 0) {
389 set.appender = xbt_log_appender2_file_new(value + 9, 1);
390 } else if (strncmp(value, "splitfile:", 10) == 0) {
391 set.appender = xbt_log_appender2_file_new(value + 10, 0);
392 } else if (strcmp(value, "stderr") == 0) {
393 set.appender = xbt_log_appender_stream(stderr);
394 } else if (strcmp(value, "stdout") == 0) {
395 set.appender = xbt_log_appender_stream(stdout);
397 throw std::invalid_argument(simgrid::xbt::string_printf("Unknown appender log type: '%s'", value));
399 } else if (strncmp(option, "fmt", option_len) == 0) {
402 xbt_die("Unknown setting of the log category: '%.*s'", static_cast<int>(option_len), option);
404 set.catname = std::string(name, name_len);
406 XBT_DEBUG("This is for cat '%s'", set.catname.c_str());
411 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, const char* name)
413 XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
414 cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
415 (cat->nextSibling ? cat->nextSibling->name : "none"));
416 if (strcmp(cat->name, name) == 0)
419 for (xbt_log_category_t child = cat->firstChild; child != nullptr; child = child->nextSibling) {
420 XBT_DEBUG("Dig into %s", child->name);
421 xbt_log_category_t res = _xbt_log_cat_searchsub(child, name);
429 void xbt_log_control_set(const char *control_string)
431 if (not control_string)
433 XBT_DEBUG("Parse log settings '%s'", control_string);
435 /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
436 if (strcmp(control_string, "no_loc") == 0) {
440 /* Split the string, and remove empty entries
441 Parse each entry and either use it right now (if the category was already created), or store it for further use */
442 std::string parsed_control_string(control_string);
443 boost::escaped_list_separator<char> sep("\\", " ", "\"'");
444 boost::tokenizer<boost::escaped_list_separator<char>> tok(parsed_control_string, sep);
445 for (const auto& str : tok) {
449 xbt_log_setting_t set = _xbt_log_parse_setting(str.c_str());
450 xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set.catname.c_str());
453 XBT_DEBUG("Apply directly");
454 _xbt_log_cat_apply_set(cat, set);
456 XBT_DEBUG("Store for further application");
457 XBT_DEBUG("push %p to the settings", &set);
458 xbt_log_settings().emplace_back(std::move(set));
463 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
466 if (cat->appender->free_)
467 cat->appender->free_(cat->appender);
468 xbt_free(cat->appender);
473 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
475 DISABLE_XBT_LOG_CAT_INIT();
476 if (not cat->appender) {
477 XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
478 xbt_log_appender_set(cat, xbt_log_appender_file_new(nullptr));
481 if (cat->layout->free_) {
482 cat->layout->free_(cat->layout);
484 xbt_free(cat->layout);
487 xbt_log_additivity_set(cat, 0);
490 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
492 cat->additivity = additivity;
495 static void xbt_log_help()
498 "Description of the logging output:\n"
500 " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
501 " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
502 " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
503 " -> trace: enter and return of some functions\n"
504 " -> debug: crufty output\n"
505 " -> verbose: verbose output for the user wanting more\n"
506 " -> info: output about the regular functioning\n"
507 " -> warning: minor issue encountered\n"
508 " -> error: issue encountered\n"
509 " -> critical: major issue encountered\n"
510 " The default priority level is 'info'.\n"
512 " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
513 " FORMAT string may contain:\n"
514 " -> %%%%: the %% char\n"
515 " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
516 " -> %%e: plain old space (SimGrid extension)\n"
518 " -> %%m: user-provided message\n"
520 " -> %%c: Category name (LOG4J compatible)\n"
521 " -> %%p: Priority name (LOG4J compatible)\n"
523 " -> %%h: Hostname (SimGrid extension)\n"
524 " -> %%a: Actor name (SimGrid extension)\n"
525 " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
526 " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
528 " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
529 " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
531 " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
532 " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
534 " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only when using the GNU libc because\n"
535 " backtrace() is not defined elsewhere.\n"
536 " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
537 "defined where %%b is.\n"
539 " -> %%d: date (UNIX-like epoch)\n"
540 " -> %%r: application age (time elapsed since the beginning of the application)\n"
542 " Category appender: --log=CATEGORY_NAME.app:APPENDER\n"
543 " APPENDER may be:\n"
544 " -> stdout or stderr: standard output streams\n"
545 " -> file:NAME: append to file with given name\n"
546 " -> splitfile:SIZE:NAME: append to files with maximum size SIZE per file.\n"
547 " NAME may contain the %% wildcard as a placeholder for the file number.\n"
548 " -> rollfile:SIZE:NAME: append to file with maximum size SIZE.\n"
550 " Category additivity: --log=CATEGORY_NAME.add:VALUE\n"
551 " VALUE: '0', '1', 'no', 'yes', 'on', or 'off'\n"
554 " --help-log-categories Display the current hierarchy of log categories.\n"
555 " --log=no_loc Don't print file names in messages (for tesh tests).\n");
558 static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
563 std::string this_prefix(prefix);
564 std::string child_prefix(prefix);
565 if (category->parent) {
566 this_prefix += " \\_ ";
567 child_prefix += " | ";
570 std::vector<xbt_log_category_t> cats;
571 for (xbt_log_category_t cat = category; cat != nullptr; cat = cat->nextSibling)
574 std::sort(begin(cats), end(cats),
575 [](const s_xbt_log_category_t* a, const s_xbt_log_category_t* b) { return strcmp(a->name, b->name) < 0; });
577 for (auto const& cat : cats) {
578 XBT_HELP("%s%s: %s", this_prefix.c_str(), cat->name, cat->description);
579 if (cat == cats.back() && category->parent)
580 child_prefix[child_prefix.rfind('|')] = ' ';
581 xbt_log_help_categories_rec(cat->firstChild, child_prefix);
585 static void xbt_log_help_categories()
587 XBT_HELP("Current log category hierarchy:");
588 xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");