/* log - a generic logging facility in the spirit of log4j */
-/* Copyright (c) 2004-2020. 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 "xbt/string.hpp"
#include <algorithm>
+#include <array>
#include <mutex>
#include <string>
+#include <unordered_set>
#include <vector>
int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
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 std::vector<xbt_log_setting_t>& 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 */,
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
*
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) {
+ 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);
}
}
+/** Asserts that the provided name is unique */
+void _xbt_log_is_name_unique(const char* name, const char* file, int line)
+{
+ static std::unordered_set<std::string> used_names;
+
+ if (used_names.find(name) != used_names.end())
+ XBT_WARN("%s:%d: log category redefined: %s", file, line, name);
+ used_names.insert(std::string(name));
+}
+
/*
* This gets called the first time a category is referenced and performs the initialization.
* Also resets threshold to inherited!
int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
{
DISABLE_XBT_LOG_CAT_INIT();
+
if (category->initialized)
return priority >= category->threshold;
}
/* 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);
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()
{
XBT_HELP(
"Description of the logging output:\n"
}
}
-static void xbt_log_help_categories(void)
+static void xbt_log_help_categories()
{
XBT_HELP("Current log category hierarchy:");
xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " ");