/* 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 <mutex>
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;
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];
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;
-
- while (*(++p) != '\0') {
- if (*p >= 'a' && *p <= 'z') {
- *p -= 'a' - 'A';
- }
- }
+ size_t name_len = option - name;
+ ++option;
+ size_t option_len = value - option;
+ ++value;
- 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;
} else {
- THROWF(arg_error, 0,
- "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", eq + 1);
- }
- xbt_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 {
- set.additivity = 0;
+ throw std::invalid_argument(simgrid::xbt::string_printf(
+ "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value));
}
- xbt_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 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 {
- THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
+ throw std::invalid_argument(simgrid::xbt::string_printf("Unknown appender log type: '%s'", value));
}
- xbt_free(neweq);
- } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
- set.fmt = std::string(eq + 1);
+ } else if (strncmp(option, "fmt", option_len) == 0) {
+ set.fmt = std::string(value);
} else {
- char buff[512];
- snprintf(buff, std::min<int>(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 = std::string(name, dot - name);
+ set.catname = std::string(name, name_len);
XBT_DEBUG("This is for cat '%s'", set.catname.c_str());
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 != nullptr; child = child->nextSibling) {
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;
}
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");
+ 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) == -1; });
+ [](xbt_log_category_t a, 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)
{
- 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", "");
}