X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3a8e2482063363c58098e170e6a7c250f62c7711..a27340a44ca0010cef5e5134627dd7774cc911c3:/src/xbt/log.cpp

diff --git a/src/xbt/log.cpp b/src/xbt/log.cpp
index 54722001d4..5b16eff25b 100644
--- a/src/xbt/log.cpp
+++ b/src/xbt/log.cpp
@@ -1,15 +1,16 @@
 /* log - a generic logging facility in the spirit of log4j                  */
 
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2020. 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/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>
@@ -122,10 +123,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 +136,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,14 +155,14 @@ 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<size_t>(ev->priority) < sizeof(xbt_log_priority_names)/sizeof(xbt_log_priority_names[0]),
              "Priority %d is greater than the biggest allowed value", ev->priority);
 
-  while (1) {
-    xbt_log_appender_t appender = cat->appender;
+  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);
@@ -176,14 +175,14 @@ void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
       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);
       } 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);
@@ -282,7 +281,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;
@@ -340,7 +339,7 @@ void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
   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;
 
@@ -405,15 +404,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 +421,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 +437,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;
   }
@@ -602,6 +594,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");
@@ -624,7 +627,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);