/* log - a generic logging facility in the spirit of log4j */
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
-#include "src/xbt_modinter.h"
#include "src/xbt/log_private.hpp"
+#include "src/xbt_modinter.h"
#include "xbt/asserts.h"
#include "xbt/dynar.h"
#include "xbt/str.h"
+#include "xbt/string.hpp"
#include <algorithm>
+#include <array>
#include <mutex>
#include <string>
#include <vector>
xbt_log_appender_t appender = nullptr;
};
-static std::vector<xbt_log_setting_t> xbt_log_settings;
-
-const char *xbt_log_priority_names[8] = {
- "NONE",
- "TRACE",
- "DEBUG",
- "VERBOSE",
- "INFO",
- "WARNING",
- "ERROR",
- "CRITICAL"
-};
+// This function is here to avoid static initialization order fiasco
+static auto& xbt_log_settings()
+{
+ static std::vector<xbt_log_setting_t> value;
+ return value;
+}
+
+constexpr std::array<const char*, 8> xbt_log_priority_names{
+ {"NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARNING", "ERROR", "CRITICAL"}};
s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
nullptr /*parent */,
which were already created (damnit. Too slow little beetle) */
void xbt_log_preinit(void)
{
- xbt_log_default_appender = xbt_log_appender_file_new(nullptr);
+ xbt_log_default_appender = xbt_log_appender_stream(stderr);
xbt_log_default_layout = xbt_log_layout_simple_new(nullptr);
_XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
_XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
log_cat_init_mutex = new std::recursive_mutex();
}
-static void xbt_log_help(void);
-static void xbt_log_help_categories(void);
+static void xbt_log_help();
+static void xbt_log_help_categories();
/** @brief Get all logging settings from the command line
*
int j = 1;
int parse_args = 1; // Stop parsing the parameters once we found '--'
+ xbt_log_control_set("xbt_help.app:stdout xbt_help.threshold:VERBOSE xbt_help.fmt:%m%n");
+
/* Set logs and init log submodule */
for (int i = 1; i < *argc; i++) {
if (strcmp("--", argv[i]) == 0) {
}
}
-static void log_cat_exit(xbt_log_category_t cat)
+static void log_cat_exit(const s_xbt_log_category_t* cat)
{
- xbt_log_category_t child;
-
if (cat->appender) {
if (cat->appender->free_)
cat->appender->free_(cat->appender);
xbt_free(cat->layout);
}
- for (child = cat->firstChild; child != nullptr; child = child->nextSibling)
+ for (auto const* child = cat->firstChild; child != nullptr; child = child->nextSibling)
log_cat_exit(child);
}
void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
{
- xbt_log_category_t cat = ev->cat;
+ const xbt_log_category_s* cat = ev->cat;
xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
- xbt_assert(static_cast<size_t>(ev->priority) < sizeof(xbt_log_priority_names)/sizeof(xbt_log_priority_names[0]),
+ xbt_assert(static_cast<size_t>(ev->priority) < xbt_log_priority_names.size(),
"Priority %d is greater than the biggest allowed value", ev->priority);
- while (1) {
- xbt_log_appender_t appender = cat->appender;
+ while (true) {
+ const s_xbt_log_appender_t* appender = cat->appender;
if (appender != nullptr) {
xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
/* First, try with a static buffer */
- int done = 0;
- char buff[XBT_LOG_STATIC_BUFFER_SIZE];
- ev->buffer = buff;
- ev->buffer_size = sizeof buff;
+ bool done = false;
+ std::array<char, XBT_LOG_STATIC_BUFFER_SIZE> buff;
+ ev->buffer = buff.data();
+ ev->buffer_size = buff.size();
va_start(ev->ap, fmt);
done = cat->layout->do_layout(cat->layout, ev, fmt);
va_end(ev->ap);
+ ev->buffer = nullptr; // Calm down, static analyzers, this pointer to local array won't leak out of the scope.
if (done) {
- appender->do_append(appender, buff);
+ appender->do_append(appender, buff.data());
} else {
-
/* The static buffer was too small, use a dynamically expanded one */
ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
ev->buffer = static_cast<char*>(xbt_malloc(ev->buffer_size));
- while (1) {
+ while (true) {
va_start(ev->ap, fmt);
done = cat->layout->do_layout(cat->layout, ev, fmt);
va_end(ev->ap);
if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
std::string res;
- xbt_log_category_t cpp = category->parent->firstChild;
+ const xbt_log_category_s* cpp = category->parent->firstChild;
while (cpp) {
res += std::string(" ") + cpp->name;
cpp = cpp->nextSibling;
}
/* Apply the control */
- auto iset = std::find_if(begin(xbt_log_settings), end(xbt_log_settings),
+ auto iset = std::find_if(begin(xbt_log_settings()), end(xbt_log_settings()),
[category](const xbt_log_setting_t& s) { return s.catname == category->name; });
- if (iset != xbt_log_settings.end()) {
+ if (iset != xbt_log_settings().end()) {
_xbt_log_cat_apply_set(category, *iset);
- xbt_log_settings.erase(iset);
+ xbt_log_settings().erase(iset);
} else {
XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)", category->name,
xbt_log_priority_names[category->threshold], category->threshold);
cat->isThreshInherited = 1;
}
-static void _set_inherited_thresholds(xbt_log_category_t cat)
+static void _set_inherited_thresholds(const s_xbt_log_category_t* cat)
{
xbt_log_category_t child = cat->firstChild;
}else if (i < xbt_log_priority_infinite) {
set.thresh = (e_xbt_log_priority_t)i;
} else {
- THROWF(arg_error, 0,
- "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value);
+ throw std::invalid_argument(simgrid::xbt::string_printf(
+ "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value));
}
} else if (strncmp(option, "additivity", option_len) == 0) {
- if (strcasecmp(value, "ON") == 0 || strcasecmp(value, "YES") == 0 || strcmp(value, "1") == 0) {
- set.additivity = 1;
- } else {
- set.additivity = 0;
- }
+ set.additivity = (strcasecmp(value, "ON") == 0 || strcasecmp(value, "YES") == 0 || strcmp(value, "1") == 0);
} else if (strncmp(option, "appender", option_len) == 0) {
if (strncmp(value, "file:", 5) == 0) {
set.appender = xbt_log_appender_file_new(value + 5);
set.appender = xbt_log_appender2_file_new(value + 9, 1);
} else if (strncmp(value, "splitfile:", 10) == 0) {
set.appender = xbt_log_appender2_file_new(value + 10, 0);
+ } else if (strcmp(value, "stderr") == 0) {
+ set.appender = xbt_log_appender_stream(stderr);
+ } else if (strcmp(value, "stdout") == 0) {
+ set.appender = xbt_log_appender_stream(stdout);
} else {
- THROWF(arg_error, 0, "Unknown appender log type: '%s'", value);
+ throw std::invalid_argument(simgrid::xbt::string_printf("Unknown appender log type: '%s'", value));
}
} else if (strncmp(option, "fmt", option_len) == 0) {
set.fmt = std::string(value);
static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, const char* name)
{
- xbt_log_category_t child;
- xbt_log_category_t res;
-
XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
(cat->nextSibling ? cat->nextSibling->name : "none"));
if (strcmp(cat->name, name) == 0)
return cat;
- for (child = cat->firstChild; child != nullptr; child = child->nextSibling) {
+ for (xbt_log_category_t child = cat->firstChild; child != nullptr; child = child->nextSibling) {
XBT_DEBUG("Dig into %s", child->name);
- res = _xbt_log_cat_searchsub(child, name);
+ xbt_log_category_t res = _xbt_log_cat_searchsub(child, name);
if (res)
return res;
}
} else {
XBT_DEBUG("Store for further application");
XBT_DEBUG("push %p to the settings", &set);
- xbt_log_settings.emplace_back(std::move(set));
+ xbt_log_settings().emplace_back(std::move(set));
}
}
xbt_dynar_free(&set_strings);
cat->additivity = additivity;
}
-static void xbt_log_help(void)
+static void xbt_log_help()
{
- printf("Description of the logging output:\n"
- "\n"
- " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
- " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
- " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
- " -> trace: enter and return of some functions\n"
- " -> debug: crufty output\n"
- " -> verbose: verbose output for the user wanting more\n"
- " -> info: output about the regular functioning\n"
- " -> warning: minor issue encountered\n"
- " -> error: issue encountered\n"
- " -> critical: major issue encountered\n"
- " The default priority level is 'info'.\n"
- "\n"
- " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
- " FORMAT string may contain:\n"
- " -> %%%%: the %% char\n"
- " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
- " -> %%e: plain old space (SimGrid extension)\n"
- "\n"
- " -> %%m: user-provided message\n"
- "\n"
- " -> %%c: Category name (LOG4J compatible)\n"
- " -> %%p: Priority name (LOG4J compatible)\n"
- "\n"
- " -> %%h: Hostname (SimGrid extension)\n"
- " -> %%P: Process name (SimGrid extension)\n"
- " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
- " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
- "\n"
- " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
- " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
- "in 'l'etter)\n"
- " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
- " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
- " Defined only when using gcc because there is no __func__ elsewhere.\n"
- "\n"
- " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
- "GNU libc because\n"
- " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
- "mac ones for example.\n"
- " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
- "defined where %%b is.\n"
- "\n"
- " -> %%d: date (UNIX-like epoch)\n"
- " -> %%r: application age (time elapsed since the beginning of the application)\n"
- "\n"
- " Miscellaneous:\n"
- " --help-log-categories Display the current hierarchy of log categories.\n"
- " --log=no_loc Don't print file names in messages (for tesh tests).\n"
- "\n");
+ XBT_HELP(
+ "Description of the logging output:\n"
+ "\n"
+ " Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
+ " CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
+ " PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
+ " -> trace: enter and return of some functions\n"
+ " -> debug: crufty output\n"
+ " -> verbose: verbose output for the user wanting more\n"
+ " -> info: output about the regular functioning\n"
+ " -> warning: minor issue encountered\n"
+ " -> error: issue encountered\n"
+ " -> critical: major issue encountered\n"
+ " The default priority level is 'info'.\n"
+ "\n"
+ " Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
+ " FORMAT string may contain:\n"
+ " -> %%%%: the %% char\n"
+ " -> %%n: platform-dependent line separator (LOG4J compatible)\n"
+ " -> %%e: plain old space (SimGrid extension)\n"
+ "\n"
+ " -> %%m: user-provided message\n"
+ "\n"
+ " -> %%c: Category name (LOG4J compatible)\n"
+ " -> %%p: Priority name (LOG4J compatible)\n"
+ "\n"
+ " -> %%h: Hostname (SimGrid extension)\n"
+ " -> %%P: Process name (SimGrid extension)\n"
+ " -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
+ " -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
+ "\n"
+ " -> %%F: file name where the log event was raised (LOG4J compatible)\n"
+ " -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
+ "in 'l'etter)\n"
+ " -> %%L: line number where the log event was raised (LOG4J compatible)\n"
+ " -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
+ "\n"
+ " -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
+ "GNU libc because\n"
+ " backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
+ "mac ones for example.\n"
+ " -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
+ "defined where %%b is.\n"
+ "\n"
+ " -> %%d: date (UNIX-like epoch)\n"
+ " -> %%r: application age (time elapsed since the beginning of the application)\n"
+ "\n"
+ " Category appender: --log=CATEGORY_NAME.app:APPENDER\n"
+ " APPENDER may be:\n"
+ " -> stdout or stderr: standard output streams\n"
+ " -> file:NAME: append to file with given name\n"
+ " -> splitfile:SIZE:NAME: append to files with maximum size SIZE per file.\n"
+ " NAME may contain the %% wildcard as a placeholder for the file number.\n"
+ " -> rollfile:SIZE:NAME: append to file with maximum size SIZE.\n"
+ "\n"
+ " Category additivity: --log=CATEGORY_NAME.add:VALUE\n"
+ " VALUE: '0', '1', 'no', 'yes', 'on', or 'off'\n"
+ "\n"
+ " Miscellaneous:\n"
+ " --help-log-categories Display the current hierarchy of log categories.\n"
+ " --log=no_loc Don't print file names in messages (for tesh tests).\n");
}
static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
cats.push_back(cat);
std::sort(begin(cats), end(cats),
- [](xbt_log_category_t a, xbt_log_category_t b) { return strcmp(a->name, b->name) < 0; });
+ [](const s_xbt_log_category_t* a, const s_xbt_log_category_t* b) { return strcmp(a->name, b->name) < 0; });
for (auto const& cat : cats) {
- printf("%s%s: %s\n", this_prefix.c_str(), cat->name, cat->description);
+ XBT_HELP("%s%s: %s", this_prefix.c_str(), cat->name, cat->description);
if (cat == cats.back() && category->parent)
child_prefix[child_prefix.rfind('|')] = ' ';
xbt_log_help_categories_rec(cat->firstChild, child_prefix);
}
}
-static void xbt_log_help_categories(void)
+static void xbt_log_help_categories()
{
- printf("Current log category hierarchy:\n");
+ XBT_HELP("Current log category hierarchy:");
xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");
- printf("\n");
+ XBT_HELP("%s", "");
}
