/* 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 <ctype.h>
-#include <mutex>
-#include <stdarg.h>
-#include <stdio.h> /* snprintf */
-#include <stdlib.h> /* snprintf */
-
-#include "src/internal_config.h"
-
#include "src/xbt_modinter.h"
-
#include "src/xbt/log_private.hpp"
#include "xbt/asserts.h"
#include "xbt/dynar.h"
-#include "xbt/ex.h"
-#include "xbt/misc.h"
#include "xbt/str.h"
-#include "xbt/sysdep.h"
-#ifndef MIN
-#define MIN(a, b) ((a) < (b) ? (a) : (b))
-#endif
-#ifndef MAX
-#define MAX(a, b) ((a) > (b) ? (a) : (b))
-#endif
+#include <algorithm>
+#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;
* For more information, please refer to @ref outcomes_logs Section.
*/
-xbt_log_appender_t xbt_log_default_appender = NULL; /* set in log_init */
-xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
-
-typedef struct {
- char *catname;
- char *fmt;
- e_xbt_log_priority_t thresh;
- int additivity;
- xbt_log_appender_t appender;
-} s_xbt_log_setting_t;
+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 */
-typedef s_xbt_log_setting_t* xbt_log_setting_t;
-
-static xbt_dynar_t xbt_log_settings = NULL;
-
-static void _free_setting(void *s)
-{
- xbt_log_setting_t set = *(xbt_log_setting_t *) s;
- if (set) {
- free(set->catname);
- free(set->fmt);
- free(set);
- }
-}
+struct xbt_log_setting_t {
+ std::string catname;
+ std::string fmt;
+ e_xbt_log_priority_t thresh = xbt_log_priority_uninitialized;
+ int additivity = -1;
+ xbt_log_appender_t appender = nullptr;
+};
-static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting);
+static std::vector<xbt_log_setting_t> xbt_log_settings;
const char *xbt_log_priority_names[8] = {
"NONE",
};
s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
- NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
- "root", "The common ancestor for all categories",
- 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
- 0 /* isThreshInherited */ ,
- NULL /* appender */ , NULL /* layout */ ,
- 0 /* additivity */
+ nullptr /*parent */,
+ nullptr /* firstChild */,
+ nullptr /* nextSibling */,
+ "root",
+ "The common ancestor for all categories",
+ 0 /*initialized */,
+ xbt_log_priority_uninitialized /* threshold */,
+ 0 /* isThreshInherited */,
+ nullptr /* appender */,
+ nullptr /* layout */,
+ 0 /* additivity */
};
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
which were already created (damnit. Too slow little beetle) */
void xbt_log_preinit(void)
{
- xbt_log_default_appender = xbt_log_appender_file_new(NULL);
- xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
+ 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();
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])) {
+ if (strcmp("--", argv[i]) == 0) {
parse_args = 0;
argv[j++] = argv[i]; // Keep the '--' for sg_config
- } else if (parse_args && !strncmp(argv[i], "--log=", strlen("--log="))) {
+ } else if (parse_args && strncmp(argv[i], "--log=", strlen("--log=")) == 0) {
char* opt = strchr(argv[i], '=');
opt++;
xbt_log_control_set(opt);
XBT_DEBUG("Did apply '%s' as log setting", opt);
- } else if (parse_args && !strcmp(argv[i], "--help-logs")) {
+ } else if (parse_args && strcmp(argv[i], "--help-logs") == 0) {
help_requested |= 1U;
- } else if (parse_args && !strcmp(argv[i], "--help-log-categories")) {
+ } else if (parse_args && strcmp(argv[i], "--help-log-categories") == 0) {
help_requested |= 2U;
} else {
argv[j++] = argv[i];
}
}
if (j < *argc) {
- argv[j] = NULL;
+ argv[j] = nullptr;
*argc = j;
}
if (cat->appender) {
if (cat->appender->free_)
cat->appender->free_(cat->appender);
- free(cat->appender);
+ xbt_free(cat->appender);
}
if (cat->layout) {
if (cat->layout->free_)
cat->layout->free_(cat->layout);
- free(cat->layout);
+ xbt_free(cat->layout);
}
- for (child = cat->firstChild; child != NULL; child = child->nextSibling)
+ for (child = cat->firstChild; child != nullptr; child = child->nextSibling)
log_cat_exit(child);
}
{
XBT_VERB("Exiting log");
delete log_cat_init_mutex;
- xbt_dynar_free(&xbt_log_settings);
log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
}
/* Size of the static string in which we build the log string */
-#define XBT_LOG_STATIC_BUFFER_SIZE 2048
+static constexpr size_t XBT_LOG_STATIC_BUFFER_SIZE = 2048;
/* Minimum size of the dynamic string in which we build the log string
(should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
-#define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
+static constexpr size_t XBT_LOG_DYNAMIC_BUFFER_SIZE = 4096;
void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
{
while (1) {
xbt_log_appender_t appender = cat->appender;
- if (appender != NULL) {
+ if (appender != nullptr) {
xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
/* First, try with a static buffer */
* To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
* macro has to be called at the beginning of the affected functions.
*/
-static int fake_xbt_log_cat_init(xbt_log_category_t XBT_ATTRIB_UNUSED category,
- e_xbt_log_priority_t XBT_ATTRIB_UNUSED priority)
+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;
-static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting)
+static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_setting_t& setting)
{
DISABLE_XBT_LOG_CAT_INIT();
- if (setting->thresh != xbt_log_priority_uninitialized) {
- xbt_log_threshold_set(category, setting->thresh);
+ if (setting.thresh != xbt_log_priority_uninitialized) {
+ xbt_log_threshold_set(category, setting.thresh);
XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
category->name, xbt_log_priority_names[category->threshold], category->threshold);
}
- if (setting->fmt) {
- xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
+ if (not setting.fmt.empty()) {
+ xbt_log_layout_set(category, xbt_log_layout_format_new(setting.fmt.c_str()));
- XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting->fmt);
+ XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting.fmt.c_str());
}
- if (setting->additivity != -1) {
- xbt_log_additivity_set(category, setting->additivity);
+ if (setting.additivity != -1) {
+ xbt_log_additivity_set(category, setting.additivity);
- XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
- category->name, (setting->additivity ? "on" : "off"));
+ XBT_DEBUG("Apply settings for category '%s': set additivity to %s", category->name,
+ (setting.additivity ? "on" : "off"));
}
- if (setting->appender) {
- xbt_log_appender_set(category, setting->appender);
+ if (setting.appender) {
+ xbt_log_appender_set(category, setting.appender);
if (!category->layout)
- xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
+ 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);
+ XBT_DEBUG("Set %p as appender of category '%s'", setting.appender, category->name);
}
}
int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
{
DISABLE_XBT_LOG_CAT_INIT();
- if (log_cat_init_mutex != NULL)
- log_cat_init_mutex->lock();
-
- if (category->initialized) {
- if (log_cat_init_mutex != NULL)
- log_cat_init_mutex->unlock();
+ if (category->initialized)
return priority >= category->threshold;
- }
- unsigned int cursor;
- xbt_log_setting_t setting = NULL;
+ if (log_cat_init_mutex != nullptr)
+ log_cat_init_mutex->lock();
XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
(category->firstChild ? category->firstChild->name : "none"),
xbt_log_parent_set(category, category->parent);
if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
- char *buf;
- char *res = NULL;
+ std::string res;
xbt_log_category_t cpp = category->parent->firstChild;
while (cpp) {
- if (res) {
- buf = bprintf("%s %s", res, cpp->name);
- free(res);
- res = buf;
- } else {
- res = xbt_strdup(cpp->name);
- }
+ res += std::string(" ") + cpp->name;
cpp = cpp->nextSibling;
}
- XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res,
- (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
-
- free(res);
+ XBT_DEBUG("Children of %s:%s; nextSibling: %s", category->parent->name, res.c_str(),
+ (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
}
}
/* Apply the control */
- if (xbt_log_settings) {
- xbt_assert(category, "NULL category");
- xbt_assert(category->name);
- int found = 0;
-
- xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
- xbt_assert(setting, "Damnit, NULL cat in the list");
- xbt_assert(setting->catname, "NULL setting(=%p)->catname", (void *) setting);
-
- if (!strcmp(setting->catname, category->name)) {
- found = 1;
- _xbt_log_cat_apply_set(category, setting);
- xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
- }
- }
-
- if (!found)
- XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
- category->name, xbt_log_priority_names[category->threshold], category->threshold);
+ 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()) {
+ _xbt_log_cat_apply_set(category, *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 != NULL)
+ if (log_cat_init_mutex != nullptr)
log_cat_init_mutex->unlock();
return priority >= category->threshold;
}
if (cat->initialized) {
xbt_log_category_t *cpp = &cat->parent->firstChild;
- while (*cpp != cat && *cpp != NULL) {
+ while (*cpp != cat && *cpp != nullptr) {
cpp = &(*cpp)->nextSibling;
}
{
xbt_log_category_t child = cat->firstChild;
- for (; child != NULL; child = child->nextSibling) {
+ for (; child != nullptr; child = child->nextSibling) {
if (child->isThreshInherited) {
if (cat != &_XBT_LOGV(log))
XBT_VERB("Set category threshold of %s to %s (=%d)",
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 = xbt_new(s_xbt_log_setting_t, 1);
-
- set->catname = NULL;
- set->thresh = xbt_log_priority_uninitialized;
- set->fmt = NULL;
- set->additivity = -1;
- set->appender = NULL;
+ xbt_log_setting_t set;
if (!*control_string)
return set;
XBT_DEBUG("Parse log setting '%s'", control_string);
control_string += strspn(control_string, " ");
- const char *name = control_string;
+ const char* name = control_string;
control_string += strcspn(control_string, ".:= ");
- const char *dot = control_string;
+ const char* option = control_string;
control_string += strcspn(control_string, ":= ");
- const char *eq = control_string;
+ const char* value = control_string;
- xbt_assert(*dot == '.' || (*eq != '=' && *eq != ':'), "Invalid control string '%s'", orig_control_string);
+ xbt_assert(*option == '.' && (*value == '=' || *value == ':'), "Invalid control string '%s'", orig_control_string);
- if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
- int i;
- char *neweq = xbt_strdup(eq + 1);
- char *p = neweq - 1;
+ size_t name_len = option - name;
+ ++option;
+ size_t option_len = value - option;
+ ++value;
- while (*(++p) != '\0') {
- if (*p >= 'a' && *p <= 'z') {
- *p -= 'a' - 'A';
- }
- }
-
- XBT_DEBUG("New priority name = %s", neweq);
+ if (strncmp(option, "threshold", option_len) == 0) {
+ XBT_DEBUG("New priority name = %s", value);
+ int i;
for (i = 0; i < xbt_log_priority_infinite; i++) {
- if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
+ if (strcasecmp(value, xbt_log_priority_names[i]) == 0) {
XBT_DEBUG("This is priority %d", i);
break;
}
}
if(i<XBT_LOG_STATIC_THRESHOLD){
- fprintf(stderr,
- "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
- "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
- "while -DNLOG forbids any logging, at any level.",
- eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
- exit(1);
+ fprintf(stderr, "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
+ "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
+ "while -DNLOG forbids any logging, at any level.",
+ value, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
+ exit(1);
}else if (i < xbt_log_priority_infinite) {
- set->thresh = (e_xbt_log_priority_t) i;
+ 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)", eq + 1);
+ "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value);
}
- free(neweq);
- } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
- !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
- char *neweq = xbt_strdup(eq + 1);
- char *p = neweq - 1;
-
- while (*(++p) != '\0') {
- if (*p >= 'a' && *p <= 'z') {
- *p -= 'a' - 'A';
- }
- }
- if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES") || !strcmp(neweq, "1")) {
- set->additivity = 1;
+ } else if (strncmp(option, "additivity", option_len) == 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);
+ } else if (strncmp(value, "rollfile:", 9) == 0) {
+ 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 {
- set->additivity = 0;
+ THROWF(arg_error, 0, "Unknown appender log type: '%s'", value);
}
- free(neweq);
- } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
- !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
- char *neweq = xbt_strdup(eq + 1);
-
- if (!strncmp(neweq, "file:", 5)) {
- set->appender = xbt_log_appender_file_new(neweq + 5);
- }else if (!strncmp(neweq, "rollfile:", 9)) {
- set->appender = xbt_log_appender2_file_new(neweq + 9,1);
- }else if (!strncmp(neweq, "splitfile:", 10)) {
- set->appender = xbt_log_appender2_file_new(neweq + 10,0);
- } else {
- THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
- }
- free(neweq);
- } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
- set->fmt = xbt_strdup(eq + 1);
+ } else if (strncmp(option, "fmt", option_len) == 0) {
+ set.fmt = std::string(value);
} else {
- char buff[512];
- snprintf(buff, MIN(512, eq - dot), "%s", dot + 1);
- xbt_die("Unknown setting of the log category: '%s'", buff);
+ xbt_die("Unknown setting of the log category: '%.*s'", static_cast<int>(option_len), option);
}
- set->catname = (char *) xbt_malloc(dot - name + 1);
+ set.catname = std::string(name, name_len);
- memcpy(set->catname, name, dot - name);
- set->catname[dot - name] = '\0'; /* Just in case */
- XBT_DEBUG("This is for cat '%s'", set->catname);
+ XBT_DEBUG("This is for cat '%s'", set.catname.c_str());
return set;
}
-static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, char *name)
+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))
+ if (strcmp(cat->name, name) == 0)
return cat;
- for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
+ for (child = cat->firstChild; child != nullptr; child = child->nextSibling) {
XBT_DEBUG("Dig into %s", child->name);
res = _xbt_log_cat_searchsub(child, name);
if (res)
return res;
}
- return NULL;
+ return nullptr;
}
/**
*/
void xbt_log_control_set(const char *control_string)
{
- xbt_log_setting_t set;
-
/* To split the string in commands, and the cursors */
xbt_dynar_t set_strings;
char *str;
XBT_DEBUG("Parse log settings '%s'", control_string);
/* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
- if (!strcmp(control_string, "no_loc")) {
+ if (strcmp(control_string, "no_loc") == 0) {
xbt_log_no_loc = 1;
return;
}
- /* some initialization if this is the first time that this get called */
- if (xbt_log_settings == NULL)
- xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), _free_setting);
-
/* split the string, and remove empty entries */
set_strings = xbt_str_split_quoted(control_string);
/* 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) {
- set = _xbt_log_parse_setting(str);
- xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
+ xbt_log_setting_t set = _xbt_log_parse_setting(str);
+ xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set.catname.c_str());
if (cat) {
XBT_DEBUG("Apply directly");
_xbt_log_cat_apply_set(cat, set);
- _free_setting((void *) &set);
} else {
XBT_DEBUG("Store for further application");
- XBT_DEBUG("push %p to the settings", (void *) set);
- xbt_dynar_push(xbt_log_settings, &set);
+ XBT_DEBUG("push %p to the settings", &set);
+ xbt_log_settings.emplace_back(std::move(set));
}
}
xbt_dynar_free(&set_strings);
if (cat->appender) {
if (cat->appender->free_)
cat->appender->free_(cat->appender);
- free(cat->appender);
+ xbt_free(cat->appender);
}
cat->appender = app;
}
DISABLE_XBT_LOG_CAT_INIT();
if (!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(NULL));
+ xbt_log_appender_set(cat, xbt_log_appender_file_new(nullptr));
}
if (cat->layout) {
if (cat->layout->free_) {
cat->layout->free_(cat->layout);
}
- free(cat->layout);
+ xbt_free(cat->layout);
}
cat->layout = lay;
xbt_log_additivity_set(cat, 0);
static void xbt_log_help(void)
{
- 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");
-}
-
-static int xbt_log_cat_cmp(const void *pa, const void *pb)
-{
- xbt_log_category_t a = *(xbt_log_category_t *)pa;
- xbt_log_category_t b = *(xbt_log_category_t *)pb;
- return strcmp(a->name, b->name);
+ 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 char *prefix)
+static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
{
- char *this_prefix;
- char *child_prefix;
- unsigned i;
- xbt_log_category_t cat;
-
if (!category)
return;
+ std::string this_prefix(prefix);
+ std::string child_prefix(prefix);
if (category->parent) {
- this_prefix = bprintf("%s \\_ ", prefix);
- child_prefix = bprintf("%s | ", prefix);
- } else {
- this_prefix = xbt_strdup(prefix);
- child_prefix = xbt_strdup(prefix);
+ this_prefix += " \\_ ";
+ child_prefix += " | ";
}
- xbt_dynar_t dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
- for (cat = category ; cat != NULL; cat = cat->nextSibling)
- xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
+ std::vector<xbt_log_category_t> cats;
+ for (xbt_log_category_t cat = category; cat != nullptr; cat = cat->nextSibling)
+ cats.push_back(cat);
- xbt_dynar_sort(dynar, xbt_log_cat_cmp);
+ std::sort(begin(cats), end(cats),
+ [](xbt_log_category_t a, xbt_log_category_t b) { return strcmp(a->name, b->name) < 0; });
- xbt_dynar_foreach(dynar, i, cat){
- if (i == xbt_dynar_length(dynar) - 1 && category->parent)
- *strrchr(child_prefix, '|') = ' ';
- printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
+ for (auto const& cat : cats) {
+ 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);
}
-
- xbt_dynar_free(&dynar);
- xbt_free(this_prefix);
- xbt_free(child_prefix);
}
static void xbt_log_help_categories(void)
{
- 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", "");
}
