src/xbt/log.cpp

   1 /* log - a generic logging facility in the spirit of log4j                  */
   2
   3 /* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include "src/xbt/log_private.hpp"
   9 #include "src/xbt/xbt_modinter.h"
  10 #include "xbt/string.hpp"
  11 #include "xbt/sysdep.h"
  12
  13 #include <algorithm>
  14 #include <array>
  15 #include <boost/tokenizer.hpp>
  16 #include <cstring>
  17 #include <mutex>
  18 #include <string>
  19 #include <vector>
  20
  21 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
  22
  23 struct xbt_log_setting_t {
  24   std::string catname;
  25   std::string fmt;
  26   e_xbt_log_priority_t thresh = xbt_log_priority_uninitialized;
  27   int additivity              = -1;
  28   xbt_log_appender_t appender = nullptr;
  29 };
  30
  31 // This function is here to avoid static initialization order fiasco
  32 static auto& xbt_log_settings()
  33 {
  34   static std::vector<xbt_log_setting_t> value;
  35   return value;
  36 }
  37
  38 constexpr std::array<const char*, xbt_log_priority_infinite> xbt_log_priority_names{
  39     {"NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARNING", "ERROR", "CRITICAL"}};
  40
  41 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
  42     nullptr /*parent */,
  43     nullptr /* firstChild */,
  44     nullptr /* nextSibling */,
  45     "root",
  46     "The common ancestor for all categories",
  47     0 /*initialized */,
  48     xbt_log_priority_uninitialized /* threshold */,
  49     0 /* isThreshInherited */,
  50     nullptr /* appender */,
  51     nullptr /* layout */,
  52     0 /* additivity */
  53 };
  54
  55 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
  56
  57 static void xbt_log_help();
  58 static void xbt_log_help_categories();
  59
  60 void xbt_log_init(int *argc, char **argv)
  61 {
  62   unsigned help_requested = 0;  /* 1: logs; 2: categories */
  63   int j                   = 1;
  64   int parse_args          = 1; // Stop parsing the parameters once we found '--'
  65
  66   xbt_log_control_set("xbt_help.app:stdout xbt_help.threshold:VERBOSE xbt_help.fmt:%m%n");
  67
  68   /* Set logs and init log submodule */
  69   for (int i = 1; i < *argc; i++) {
  70     if (strcmp("--", argv[i]) == 0) {
  71       parse_args = 0;
  72       argv[j++]  = argv[i]; // Keep the '--' for sg_config
  73     } else if (parse_args && strncmp(argv[i], "--log=", strlen("--log=")) == 0) {
  74       char* opt = strchr(argv[i], '=');
  75       opt++;
  76       xbt_log_control_set(opt);
  77       XBT_DEBUG("Did apply '%s' as log setting", opt);
  78     } else if (parse_args && strcmp(argv[i], "--help-logs") == 0) {
  79       help_requested |= 1U;
  80     } else if (parse_args && strcmp(argv[i], "--help-log-categories") == 0) {
  81       help_requested |= 2U;
  82     } else {
  83       argv[j++] = argv[i];
  84     }
  85   }
  86   if (j < *argc) {
  87     argv[j] = nullptr;
  88     *argc = j;
  89   }
  90
  91   if (help_requested) {
  92     if (help_requested & 1)
  93       xbt_log_help();
  94     if (help_requested & 2)
  95       xbt_log_help_categories();
  96     exit(0);
  97   }
  98 }
  99
 100 static void log_cat_exit(const s_xbt_log_category_t* cat)
 101 {
 102   if (cat->appender) {
 103     if (cat->appender->free_)
 104       cat->appender->free_(cat->appender);
 105     xbt_free(cat->appender);
 106   }
 107   if (cat->layout) {
 108     if (cat->layout->free_)
 109       cat->layout->free_(cat->layout);
 110     xbt_free(cat->layout);
 111   }
 112
 113   for (auto const* child = cat->firstChild; child != nullptr; child = child->nextSibling)
 114     log_cat_exit(child);
 115 }
 116
 117 void xbt_log_postexit(void)
 118 {
 119   XBT_VERB("Exiting log");
 120   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
 121 }
 122
 123 /* Size of the static string in which we build the log string */
 124 static constexpr size_t XBT_LOG_STATIC_BUFFER_SIZE = 2048;
 125 /* Minimum size of the dynamic string in which we build the log string
 126    (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
 127 static constexpr size_t XBT_LOG_DYNAMIC_BUFFER_SIZE = 4096;
 128
 129 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
 130 {
 131   const xbt_log_category_s* cat = ev->cat;
 132
 133   xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
 134   xbt_assert(static_cast<size_t>(ev->priority) < xbt_log_priority_names.size(),
 135              "Priority %d is greater than the biggest allowed value", ev->priority);
 136
 137   while (true) {
 138     if (const s_xbt_log_appender_t* appender = cat->appender) {
 139       xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
 140
 141       /* First, try with a static buffer */
 142       bool done = false;
 143       std::array<char, XBT_LOG_STATIC_BUFFER_SIZE> buff;
 144       ev->buffer      = buff.data();
 145       ev->buffer_size = buff.size();
 146       va_start(ev->ap, fmt);
 147       done = cat->layout->do_layout(cat->layout, ev, fmt);
 148       va_end(ev->ap);
 149       ev->buffer = nullptr; // Calm down, static analyzers, this pointer to local array won't leak out of the scope.
 150       if (done) {
 151         appender->do_append(appender, buff.data());
 152       } else {
 153         /* The static buffer was too small, use a dynamically expanded one */
 154         ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
 155         ev->buffer      = static_cast<char*>(xbt_malloc(ev->buffer_size));
 156         while (true) {
 157           va_start(ev->ap, fmt);
 158           done = cat->layout->do_layout(cat->layout, ev, fmt);
 159           va_end(ev->ap);
 160           if (done)
 161             break; /* Got it */
 162           ev->buffer_size *= 2;
 163           ev->buffer = static_cast<char*>(xbt_realloc(ev->buffer, ev->buffer_size));
 164         }
 165         appender->do_append(appender, ev->buffer);
 166         xbt_free(ev->buffer);
 167       }
 168     }
 169
 170     if (not cat->additivity)
 171       break;
 172     cat = cat->parent;
 173   }
 174 }
 175
 176 /* NOTE:
 177  *
 178  * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init().  Thus, if we want to avoid an
 179  * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
 180  * from it.
 181  *
 182  * To circumvent the problem, we define the macro DISABLE_XBT_LOG_CAT_INIT() to hide the real _xbt_log_cat_init(). The
 183  * macro has to be called at the beginning of the affected functions.
 184  */
 185 static int fake_xbt_log_cat_init(xbt_log_category_t, e_xbt_log_priority_t)
 186 {
 187   return 0;
 188 }
 189 #define DISABLE_XBT_LOG_CAT_INIT()                                                                                     \
 190  XBT_ATTRIB_UNUSED int (*_xbt_log_cat_init)(xbt_log_category_t, e_xbt_log_priority_t) = fake_xbt_log_cat_init
 191
 192 static void _xbt_log_cat_apply_set(xbt_log_category_t category, const xbt_log_setting_t& setting)
 193 {
 194   DISABLE_XBT_LOG_CAT_INIT();
 195   if (setting.thresh != xbt_log_priority_uninitialized) {
 196     xbt_log_threshold_set(category, setting.thresh);
 197
 198     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
 199            category->name, xbt_log_priority_names[category->threshold], category->threshold);
 200   }
 201
 202   if (not setting.fmt.empty()) {
 203     xbt_log_layout_set(category, xbt_log_layout_format_new(setting.fmt.c_str()));
 204
 205     XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting.fmt.c_str());
 206   }
 207
 208   if (setting.additivity != -1) {
 209     xbt_log_additivity_set(category, setting.additivity);
 210
 211     XBT_DEBUG("Apply settings for category '%s': set additivity to %s", category->name,
 212               (setting.additivity ? "on" : "off"));
 213   }
 214   if (setting.appender) {
 215     xbt_log_appender_set(category, setting.appender);
 216     if (not category->layout)
 217       xbt_log_layout_set(category, xbt_log_layout_simple_new(nullptr));
 218     category->additivity = 0;
 219     XBT_DEBUG("Set %p as appender of category '%s'", setting.appender, category->name);
 220   }
 221 }
 222
 223 /*
 224  * This gets called the first time a category is referenced and performs the initialization.
 225  * Also resets threshold to inherited!
 226  */
 227 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
 228 {
 229   DISABLE_XBT_LOG_CAT_INIT();
 230   if (category->initialized)
 231     return priority >= category->threshold;
 232
 233   static std::recursive_mutex log_cat_init_mutex;
 234   log_cat_init_mutex.lock();
 235
 236   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
 237          (category->firstChild ? category->firstChild->name : "none"),
 238          (category->nextSibling ? category->nextSibling->name : "none"));
 239
 240   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
 241     category->threshold = xbt_log_priority_info;
 242     category->appender  = xbt_log_appender_stream(stderr);
 243     category->layout    = xbt_log_layout_simple_new(nullptr);
 244   } else {
 245     if (not category->parent)
 246       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
 247
 248     XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
 249            (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
 250            category->name);
 251     xbt_log_parent_set(category, category->parent);
 252
 253     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
 254       std::string res;
 255       const xbt_log_category_s* cpp = category->parent->firstChild;
 256       while (cpp) {
 257         res += std::string(" ") + cpp->name;
 258         cpp = cpp->nextSibling;
 259       }
 260
 261       XBT_DEBUG("Children of %s:%s; nextSibling: %s", category->parent->name, res.c_str(),
 262                 (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
 263     }
 264   }
 265
 266   /* Apply the control */
 267   if (auto iset = std::find_if(begin(xbt_log_settings()), end(xbt_log_settings()),
 268                                [category](const xbt_log_setting_t& s) { return s.catname == category->name; });
 269       iset != xbt_log_settings().end()) {
 270     _xbt_log_cat_apply_set(category, *iset);
 271     xbt_log_settings().erase(iset);
 272   } else {
 273     XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)", category->name,
 274               xbt_log_priority_names[category->threshold], category->threshold);
 275   }
 276
 277   category->initialized = 1;
 278   log_cat_init_mutex.unlock();
 279   return priority >= category->threshold;
 280 }
 281
 282 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
 283 {
 284   xbt_assert(cat, "NULL category to be given a parent");
 285   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
 286
 287   /* if the category is initialized, unlink from current parent */
 288   if (cat->initialized) {
 289     xbt_log_category_t *cpp = &cat->parent->firstChild;
 290
 291     while (*cpp != cat && *cpp != nullptr) {
 292       cpp = &(*cpp)->nextSibling;
 293     }
 294
 295     xbt_assert(*cpp == cat);
 296     *cpp = cat->nextSibling;
 297   }
 298
 299   cat->parent = parent;
 300   cat->nextSibling = parent->firstChild;
 301
 302   parent->firstChild = cat;
 303
 304   if (not parent->initialized)
 305     (void)_xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */);
 306
 307   cat->threshold = parent->threshold;
 308
 309   cat->isThreshInherited = 1;
 310 }
 311
 312 static void _set_inherited_thresholds(const s_xbt_log_category_t* cat)
 313 {
 314   xbt_log_category_t child = cat->firstChild;
 315
 316   for (; child != nullptr; child = child->nextSibling) {
 317     if (child->isThreshInherited) {
 318       if (cat != &_XBT_LOGV(log))
 319         XBT_VERB("Set category threshold of %s to %s (=%d)",
 320               child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
 321       child->threshold = cat->threshold;
 322       _set_inherited_thresholds(child);
 323     }
 324   }
 325 }
 326
 327 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
 328 {
 329   cat->threshold = threshold;
 330   cat->isThreshInherited = 0;
 331
 332   _set_inherited_thresholds(cat);
 333 }
 334
 335 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
 336 {
 337   const char *orig_control_string = control_string;
 338   xbt_log_setting_t set;
 339
 340   if (not*control_string)
 341     return set;
 342   XBT_DEBUG("Parse log setting '%s'", control_string);
 343
 344   control_string += strspn(control_string, " ");
 345   const char* name = control_string;
 346   control_string += strcspn(control_string, ".:= ");
 347   const char* option = control_string;
 348   control_string += strcspn(control_string, ":= ");
 349   const char* value = control_string;
 350
 351   xbt_assert(*option == '.' && (*value == '=' || *value == ':'), "Invalid control string '%s'", orig_control_string);
 352
 353   size_t name_len = option - name;
 354   ++option;
 355   size_t option_len = value - option;
 356   ++value;
 357
 358   if (strncmp(option, "threshold", option_len) == 0) {
 359     XBT_DEBUG("New priority name = %s", value);
 360     int i;
 361     for (i = 0; i < xbt_log_priority_infinite; i++) {
 362       if (strcasecmp(value, xbt_log_priority_names[i]) == 0) {
 363         XBT_DEBUG("This is priority %d", i);
 364         break;
 365       }
 366     }
 367
 368     if(i<XBT_LOG_STATIC_THRESHOLD){
 369       fprintf(stderr, "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
 370                       "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
 371                       "while -DNLOG forbids any logging, at any level.",
 372               value, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
 373       exit(1);
 374     }else if (i < xbt_log_priority_infinite) {
 375       set.thresh = (e_xbt_log_priority_t)i;
 376     } else {
 377       throw std::invalid_argument(simgrid::xbt::string_printf(
 378           "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", value));
 379     }
 380   } else if (strncmp(option, "additivity", option_len) == 0) {
 381     set.additivity = (strcasecmp(value, "ON") == 0 || strcasecmp(value, "YES") == 0 || strcmp(value, "1") == 0);
 382   } else if (strncmp(option, "appender", option_len) == 0) {
 383     if (strncmp(value, "file:", 5) == 0) {
 384       set.appender = xbt_log_appender_file_new(value + 5);
 385     } else if (strncmp(value, "rollfile:", 9) == 0) {
 386       set.appender = xbt_log_appender2_file_new(value + 9, 1);
 387     } else if (strncmp(value, "splitfile:", 10) == 0) {
 388       set.appender = xbt_log_appender2_file_new(value + 10, 0);
 389     } else if (strcmp(value, "stderr") == 0) {
 390       set.appender = xbt_log_appender_stream(stderr);
 391     } else if (strcmp(value, "stdout") == 0) {
 392       set.appender = xbt_log_appender_stream(stdout);
 393     } else {
 394       throw std::invalid_argument(simgrid::xbt::string_printf("Unknown appender log type: '%s'", value));
 395     }
 396   } else if (strncmp(option, "fmt", option_len) == 0) {
 397     set.fmt = value;
 398   } else {
 399     xbt_die("Unknown setting of the log category: '%.*s'", static_cast<int>(option_len), option);
 400   }
 401   set.catname = std::string(name, name_len);
 402
 403   XBT_DEBUG("This is for cat '%s'", set.catname.c_str());
 404
 405   return set;
 406 }
 407
 408 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, const char* name)
 409 {
 410   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
 411          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
 412          (cat->nextSibling ? cat->nextSibling->name : "none"));
 413   if (strcmp(cat->name, name) == 0)
 414     return cat;
 415
 416   for (xbt_log_category_t child = cat->firstChild; child != nullptr; child = child->nextSibling) {
 417     XBT_DEBUG("Dig into %s", child->name);
 418     xbt_log_category_t res = _xbt_log_cat_searchsub(child, name);
 419     if (res)
 420       return res;
 421   }
 422
 423   return nullptr;
 424 }
 425
 426 void xbt_log_control_set(const char *control_string)
 427 {
 428   if (not control_string)
 429     return;
 430   XBT_DEBUG("Parse log settings '%s'", control_string);
 431
 432   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
 433   if (strcmp(control_string, "no_loc") == 0) {
 434     xbt_log_no_loc = 1;
 435     return;
 436   }
 437   /* Split the string, and remove empty entries
 438      Parse each entry and either use it right now (if the category was already created), or store it for further use */
 439   std::string parsed_control_string(control_string);
 440   boost::escaped_list_separator<char> sep("\\", " ", "\"'");
 441   boost::tokenizer<boost::escaped_list_separator<char>> tok(parsed_control_string, sep);
 442   for (const auto& str : tok) {
 443     if (str.empty())
 444       continue;
 445
 446     xbt_log_setting_t set  = _xbt_log_parse_setting(str.c_str());
 447     xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set.catname.c_str());
 448
 449     if (cat) {
 450       XBT_DEBUG("Apply directly");
 451       _xbt_log_cat_apply_set(cat, set);
 452     } else {
 453       XBT_DEBUG("Store for further application");
 454       XBT_DEBUG("push %p to the settings", &set);
 455       xbt_log_settings().emplace_back(std::move(set));
 456     }
 457   }
 458 }
 459
 460 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
 461 {
 462   if (cat->appender) {
 463     if (cat->appender->free_)
 464       cat->appender->free_(cat->appender);
 465     xbt_free(cat->appender);
 466   }
 467   cat->appender = app;
 468 }
 469
 470 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
 471 {
 472   DISABLE_XBT_LOG_CAT_INIT();
 473   if (not cat->appender) {
 474     XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
 475     xbt_log_appender_set(cat, xbt_log_appender_file_new(nullptr));
 476   }
 477   if (cat->layout) {
 478     if (cat->layout->free_) {
 479       cat->layout->free_(cat->layout);
 480     }
 481     xbt_free(cat->layout);
 482   }
 483   cat->layout = lay;
 484   xbt_log_additivity_set(cat, 0);
 485 }
 486
 487 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
 488 {
 489   cat->additivity = additivity;
 490 }
 491
 492 static void xbt_log_help()
 493 {
 494   XBT_HELP(
 495       "Description of the logging output:\n"
 496       "\n"
 497       "   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
 498       "      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
 499       "      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
 500       "         -> trace: enter and return of some functions\n"
 501       "         -> debug: crufty output\n"
 502       "         -> verbose: verbose output for the user wanting more\n"
 503       "         -> info: output about the regular functioning\n"
 504       "         -> warning: minor issue encountered\n"
 505       "         -> error: issue encountered\n"
 506       "         -> critical: major issue encountered\n"
 507       "      The default priority level is 'info'.\n"
 508       "\n"
 509       "   Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
 510       "      FORMAT string may contain:\n"
 511       "         -> %%%%: the %% char\n"
 512       "         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
 513       "         -> %%e: plain old space (SimGrid extension)\n"
 514       "\n"
 515       "         -> %%m: user-provided message\n"
 516       "\n"
 517       "         -> %%c: Category name (LOG4J compatible)\n"
 518       "         -> %%p: Priority name (LOG4J compatible)\n"
 519       "\n"
 520       "         -> %%h: Hostname (SimGrid extension)\n"
 521       "         -> %%a: Actor name (SimGrid extension)\n"
 522       "         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
 523       "         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
 524       "\n"
 525       "         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
 526       "         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
 527       "in 'l'etter)\n"
 528       "         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
 529       "         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
 530       "\n"
 531       "         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only when using the GNU libc because\n"
 532       "                 backtrace() is not defined elsewhere.\n"
 533       "         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
 534       "defined where %%b is.\n"
 535       "\n"
 536       "         -> %%d: date (UNIX-like epoch)\n"
 537       "         -> %%r: application age (time elapsed since the beginning of the application)\n"
 538       "\n"
 539       "   Category appender: --log=CATEGORY_NAME.app:APPENDER\n"
 540       "      APPENDER may be:\n"
 541       "         -> stdout or stderr: standard output streams\n"
 542       "         -> file:NAME: append to file with given name\n"
 543       "         -> splitfile:SIZE:NAME: append to files with maximum size SIZE per file.\n"
 544       "                                 NAME may contain the %% wildcard as a placeholder for the file number.\n"
 545       "         -> rollfile:SIZE:NAME: append to file with maximum size SIZE.\n"
 546       "\n"
 547       "   Category additivity: --log=CATEGORY_NAME.add:VALUE\n"
 548       "      VALUE:  '0', '1', 'no', 'yes', 'on', or 'off'\n"
 549       "\n"
 550       "   Miscellaneous:\n"
 551       "      --help-log-categories    Display the current hierarchy of log categories.\n"
 552       "      --log=no_loc             Don't print file names in messages (for tesh tests).\n");
 553 }
 554
 555 static void xbt_log_help_categories_rec(xbt_log_category_t category, const std::string& prefix)
 556 {
 557   if (not category)
 558     return;
 559
 560   std::string this_prefix(prefix);
 561   std::string child_prefix(prefix);
 562   if (category->parent) {
 563     this_prefix  += " \\_ ";
 564     child_prefix += " |  ";
 565   }
 566
 567   std::vector<xbt_log_category_t> cats;
 568   for (xbt_log_category_t cat = category; cat != nullptr; cat = cat->nextSibling)
 569     cats.push_back(cat);
 570
 571   std::sort(begin(cats), end(cats),
 572             [](const s_xbt_log_category_t* a, const s_xbt_log_category_t* b) { return strcmp(a->name, b->name) < 0; });
 573
 574   for (auto const& cat : cats) {
 575     XBT_HELP("%s%s: %s", this_prefix.c_str(), cat->name, cat->description);
 576     if (cat == cats.back() && category->parent)
 577       child_prefix[child_prefix.rfind('|')] = ' ';
 578     xbt_log_help_categories_rec(cat->firstChild, child_prefix);
 579   }
 580 }
 581
 582 static void xbt_log_help_categories()
 583 {
 584   XBT_HELP("Current log category hierarchy:");
 585   xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), "   ");
 586   XBT_HELP("%s", "");
 587 }