X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3a8e2482063363c58098e170e6a7c250f62c7711..f2792e5909cc863fb914f60a25a0cfe007e213dd:/src/xbt/log.cpp diff --git a/src/xbt/log.cpp b/src/xbt/log.cpp index 54722001d4..11681b205a 100644 --- a/src/xbt/log.cpp +++ b/src/xbt/log.cpp @@ -1,17 +1,20 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2022. 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/sthread/sthread.h" // sthread_inside_simgrid #include "src/xbt/log_private.hpp" -#include "xbt/asserts.h" -#include "xbt/dynar.h" -#include "xbt/str.h" +#include "xbt/string.hpp" +#include "xbt/sysdep.h" +#include "xbt/xbt_modinter.h" #include +#include +#include +#include #include #include #include @@ -19,11 +22,6 @@ 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 */ @@ -35,18 +33,15 @@ struct xbt_log_setting_t { xbt_log_appender_t appender = nullptr; }; -static std::vector 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 value; + return value; +} + +constexpr std::array 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 */, @@ -75,13 +70,9 @@ void xbt_log_preinit(void) 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 - * - * 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 */ @@ -122,10 +113,8 @@ void xbt_log_init(int *argc, char **argv) } } -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); @@ -137,7 +126,7 @@ static void log_cat_exit(xbt_log_category_t cat) 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); } @@ -156,34 +145,32 @@ static constexpr size_t XBT_LOG_DYNAMIC_BUFFER_SIZE = 4096; 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(ev->priority) < sizeof(xbt_log_priority_names)/sizeof(xbt_log_priority_names[0]), + xbt_assert(static_cast(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; - - if (appender != nullptr) { + while (true) { + 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 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(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); @@ -197,7 +184,7 @@ void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...) } } - if (!cat->additivity) + if (not cat->additivity) break; cat = cat->parent; } @@ -217,7 +204,7 @@ static int fake_xbt_log_cat_init(xbt_log_category_t, e_xbt_log_priority_t) 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) { @@ -243,7 +230,7 @@ static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_se } 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); @@ -272,7 +259,7 @@ int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority category->appender = xbt_log_default_appender; category->layout = xbt_log_default_layout; } 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, @@ -282,7 +269,7 @@ int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority 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; @@ -294,11 +281,11 @@ int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority } /* 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); @@ -332,15 +319,15 @@ void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent) 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; 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; @@ -368,7 +355,7 @@ static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string) 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); @@ -405,15 +392,11 @@ static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string) }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); @@ -426,7 +409,7 @@ static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string) } 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); @@ -442,18 +425,15 @@ static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string) 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; } @@ -461,33 +441,9 @@ static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, const c 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); @@ -496,17 +452,16 @@ void xbt_log_control_set(const char *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 sep("\\", " ", "\"'"); + boost::tokenizer> 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) { @@ -515,10 +470,9 @@ void xbt_log_control_set(const char *control_string) } 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) @@ -534,7 +488,7 @@ 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)); } @@ -553,7 +507,7 @@ void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) cat->additivity = additivity; } -static void xbt_log_help(void) +static void xbt_log_help() { XBT_HELP( "Description of the logging output:\n" @@ -582,7 +536,7 @@ static void xbt_log_help(void) " -> %%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" @@ -602,6 +556,17 @@ static void xbt_log_help(void) " -> %%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"); @@ -609,7 +574,7 @@ static void xbt_log_help(void) 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); @@ -624,7 +589,7 @@ static void xbt_log_help_categories_rec(xbt_log_category_t category, const std:: 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) { XBT_HELP("%s%s: %s", this_prefix.c_str(), cat->name, cat->description); @@ -634,7 +599,7 @@ static void xbt_log_help_categories_rec(xbt_log_category_t category, const std:: } } -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), " ");