/* log - a generic logging facility in the spirit of log4j */
-/* Copyright (c) 2004-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2004-2023. 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/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 "xbt/sysdep.h"
#include <algorithm>
+#include <array>
+#include <boost/tokenizer.hpp>
+#include <cstring>
#include <mutex>
#include <string>
#include <vector>
int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
-static std::recursive_mutex* log_cat_init_mutex = nullptr;
-
-/** @addtogroup XBT_log
- *
- * For more information, please refer to @ref outcomes_logs Section.
- */
-
-xbt_log_appender_t xbt_log_default_appender = nullptr; /* set in log_init */
-xbt_log_layout_t xbt_log_default_layout = nullptr; /* set in log_init */
struct xbt_log_setting_t {
std::string catname;
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*, xbt_log_priority_infinite> 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 */,
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
-/* create the default appender and install it in the root category,
- which were already created (damnit. Too slow little beetle) */
-void xbt_log_preinit(void)
-{
- 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();
static void xbt_log_help_categories();
+static void xbt_log_postexit();
-/** @brief Get all logging settings from the command line
- *
- * xbt_log_control_set() is called on each string we got from cmd line
- */
void xbt_log_init(int *argc, char **argv)
{
unsigned help_requested = 0; /* 1: logs; 2: categories */
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");
+ atexit(xbt_log_postexit);
/* Set logs and init log submodule */
for (int i = 1; i < *argc; i++) {
}
}
-static void log_cat_exit(const s_xbt_log_category_t* cat)
+static void log_cat_exit(xbt_log_category_t cat)
{
if (cat->appender) {
if (cat->appender->free_)
cat->appender->free_(cat->appender);
xbt_free(cat->appender);
+ cat->appender = nullptr;
}
if (cat->layout) {
if (cat->layout->free_)
cat->layout->free_(cat->layout);
xbt_free(cat->layout);
+ cat->layout = nullptr;
}
- for (auto const* child = cat->firstChild; child != nullptr; child = child->nextSibling)
+ for (auto* child = cat->firstChild; child != nullptr; child = child->nextSibling)
log_cat_exit(child);
+ cat->firstChild = nullptr;
}
-void xbt_log_postexit(void)
+static void xbt_log_postexit(void)
{
XBT_VERB("Exiting log");
- delete log_cat_init_mutex;
log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_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 (true) {
- const s_xbt_log_appender_t* appender = cat->appender;
-
- if (appender != nullptr) {
+ if (const s_xbt_log_appender_t* appender = cat->appender) {
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;
}
}
- if (!cat->additivity)
+ if (not cat->additivity)
break;
cat = cat->parent;
}
return 0;
}
#define DISABLE_XBT_LOG_CAT_INIT() \
- int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) XBT_ATTRIB_UNUSED = fake_xbt_log_cat_init;
+ XBT_ATTRIB_UNUSED int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) = fake_xbt_log_cat_init
static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_setting_t& setting)
{
}
if (setting.appender) {
xbt_log_appender_set(category, setting.appender);
- if (!category->layout)
+ if (not category->layout)
xbt_log_layout_set(category, xbt_log_layout_simple_new(nullptr));
category->additivity = 0;
XBT_DEBUG("Set %p as appender of category '%s'", setting.appender, category->name);
if (category->initialized)
return priority >= category->threshold;
- if (log_cat_init_mutex != nullptr)
- log_cat_init_mutex->lock();
+ static std::recursive_mutex log_cat_init_mutex;
+ const std::scoped_lock lock(log_cat_init_mutex);
XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
(category->firstChild ? category->firstChild->name : "none"),
if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
category->threshold = xbt_log_priority_info;
- category->appender = xbt_log_default_appender;
- category->layout = xbt_log_default_layout;
+ category->appender = xbt_log_appender_stream(stderr);
+ category->layout = xbt_log_layout_simple_new(nullptr);
} else {
- if (!category->parent)
+ if (not category->parent)
category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
}
/* Apply the control */
- 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 (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; });
+ 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);
}
category->initialized = 1;
- if (log_cat_init_mutex != nullptr)
- log_cat_init_mutex->unlock();
return priority >= category->threshold;
}
parent->firstChild = cat;
- if (!parent->initialized)
- _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
+ if (not parent->initialized)
+ (void)_xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */);
cat->threshold = parent->threshold;
const char *orig_control_string = control_string;
xbt_log_setting_t set;
- if (!*control_string)
+ if (not*control_string)
return set;
XBT_DEBUG("Parse log setting '%s'", control_string);
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);
+ set.fmt = value;
} else {
xbt_die("Unknown setting of the log category: '%.*s'", static_cast<int>(option_len), option);
}
return nullptr;
}
-/**
- * @ingroup XBT_log
- * @param control_string What to parse
- *
- * Typically passed a command-line argument. The string has the syntax:
- *
- * ( [category] "." [keyword] ":" value (" ")... )...
- *
- * where [category] is one the category names (see @ref XBT_log_cats for a complete list of the ones defined in the
- * SimGrid library) and keyword is one of the following:
- *
- * - thres: category's threshold priority. Possible values:
- * TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
- * - add or additivity: whether the logging actions must be passed to the parent category.
- * Possible values: 0, 1, no, yes, on, off.
- * Default value: yes.
- * - fmt: the format to use. See @ref log_use_conf_fmt for more information.
- * - app or appender: the appender to use. See @ref log_use_conf_app for more information.
- */
void xbt_log_control_set(const char *control_string)
{
- /* To split the string in commands, and the cursors */
- xbt_dynar_t set_strings;
- char *str;
- unsigned int cpt;
-
- if (!control_string)
+ if (not control_string)
return;
XBT_DEBUG("Parse log settings '%s'", control_string);
xbt_log_no_loc = 1;
return;
}
- /* split the string, and remove empty entries */
- set_strings = xbt_str_split_quoted(control_string);
-
- if (xbt_dynar_is_empty(set_strings)) { /* vicious user! */
- xbt_dynar_free(&set_strings);
- return;
- }
-
- /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
- xbt_dynar_foreach(set_strings, cpt, str) {
- xbt_log_setting_t set = _xbt_log_parse_setting(str);
+ /* Split the string, and remove empty entries
+ Parse each entry and either use it right now (if the category was already created), or store it for further use */
+ std::string parsed_control_string(control_string);
+ boost::escaped_list_separator<char> sep("\\", " ", "\"'");
+ boost::tokenizer<boost::escaped_list_separator<char>> tok(parsed_control_string, sep);
+ for (const auto& str : tok) {
+ if (str.empty())
+ continue;
+
+ xbt_log_setting_t set = _xbt_log_parse_setting(str.c_str());
xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set.catname.c_str());
if (cat) {
} 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);
}
void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
{
DISABLE_XBT_LOG_CAT_INIT();
- if (!cat->appender) {
+ if (not cat->appender) {
XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
xbt_log_appender_set(cat, xbt_log_appender_file_new(nullptr));
}
" -> %%p: Priority name (LOG4J compatible)\n"
"\n"
" -> %%h: Hostname (SimGrid extension)\n"
- " -> %%P: Process name (SimGrid extension)\n"
+ " -> %%a: Actor 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"
" -> %%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: full backtrace (Called %%throwable in LOG4J). Defined only when using the GNU libc because\n"
+ " backtrace() is not defined elsewhere.\n"
" -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
"defined where %%b is.\n"
"\n"
static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
{
- if (!category)
+ if (not category)
return;
std::string this_prefix(prefix);
