src/xbt/log.c

   1 /* log - a generic logging facility in the spirit of log4j                  */
   2
   3 /* Copyright (c) 2004-2017. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include <stdarg.h>
  10 #include <ctype.h>
  11 #include <stdio.h>              /* snprintf */
  12 #include <stdlib.h>             /* snprintf */
  13
  14 #include "src/internal_config.h"
  15
  16 #include "src/xbt_modinter.h"
  17
  18 #include "src/xbt/log_private.h"
  19 #include "xbt/asserts.h"
  20 #include "xbt/dynar.h"
  21 #include "xbt/ex.h"
  22 #include "xbt/misc.h"
  23 #include "xbt/str.h"
  24 #include "xbt/sysdep.h"
  25 #include "xbt/xbt_os_thread.h"
  26
  27 int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */
  28 static xbt_os_mutex_t log_cat_init_mutex = NULL;
  29
  30 /** \addtogroup XBT_log
  31  *
  32  *  For more information, please refer to @ref outcomes_logs Section.
  33  */
  34
  35 xbt_log_appender_t xbt_log_default_appender = NULL;     /* set in log_init */
  36 xbt_log_layout_t xbt_log_default_layout = NULL; /* set in log_init */
  37
  38 typedef struct {
  39   char *catname;
  40   char *fmt;
  41   e_xbt_log_priority_t thresh;
  42   int additivity;
  43   xbt_log_appender_t appender;
  44 } s_xbt_log_setting_t;
  45
  46 typedef s_xbt_log_setting_t* xbt_log_setting_t;
  47
  48 static xbt_dynar_t xbt_log_settings = NULL;
  49
  50 static void _free_setting(void *s)
  51 {
  52   xbt_log_setting_t set = *(xbt_log_setting_t *) s;
  53   if (set) {
  54     free(set->catname);
  55     free(set->fmt);
  56     free(set);
  57   }
  58 }
  59
  60 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting);
  61
  62 const char *xbt_log_priority_names[8] = {
  63   "NONE",
  64   "TRACE",
  65   "DEBUG",
  66   "VERBOSE",
  67   "INFO",
  68   "WARNING",
  69   "ERROR",
  70   "CRITICAL"
  71 };
  72
  73 s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = {
  74   NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ ,
  75       "root", "The common ancestor for all categories",
  76       0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ ,
  77       0 /* isThreshInherited */ ,
  78       NULL /* appender */ , NULL /* layout */ ,
  79       0                         /* additivity */
  80 };
  81
  82 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself");
  83
  84 /* create the default appender and install it in the root category,
  85    which were already created (damnit. Too slow little beetle) */
  86 void xbt_log_preinit(void)
  87 {
  88   xbt_log_default_appender = xbt_log_appender_file_new(NULL);
  89   xbt_log_default_layout = xbt_log_layout_simple_new(NULL);
  90   _XBT_LOGV(XBT_LOG_ROOT_CAT).appender = xbt_log_default_appender;
  91   _XBT_LOGV(XBT_LOG_ROOT_CAT).layout = xbt_log_default_layout;
  92   log_cat_init_mutex = xbt_os_mutex_init();
  93 }
  94
  95 static void xbt_log_connect_categories(void)
  96 {
  97   /* Connect our log channels: that must be done manually under windows */
  98   /* Also permit that they are correctly listed by xbt_log_help_categories() */
  99
 100   /* xbt */
 101   XBT_LOG_CONNECT(xbt);
 102   XBT_LOG_CONNECT(log);
 103   XBT_LOG_CONNECT(module);
 104   XBT_LOG_CONNECT(replay);
 105   XBT_LOG_CONNECT(xbt_cfg);
 106   XBT_LOG_CONNECT(xbt_dict);
 107   XBT_LOG_CONNECT(xbt_dict_cursor);
 108   XBT_LOG_CONNECT(xbt_dict_elm);
 109   XBT_LOG_CONNECT(xbt_dyn);
 110   XBT_LOG_CONNECT(xbt_ex);
 111   XBT_LOG_CONNECT(xbt_backtrace);
 112   XBT_LOG_CONNECT(xbt_exception);
 113   XBT_LOG_CONNECT(xbt_graph);
 114   XBT_LOG_CONNECT(xbt_heap);
 115   XBT_LOG_CONNECT(xbt_mallocator);
 116   XBT_LOG_CONNECT(xbt_memory_map);
 117   XBT_LOG_CONNECT(xbt_parmap);
 118   XBT_LOG_CONNECT(xbt_sync);
 119   XBT_LOG_CONNECT(xbt_sync_os);
 120
 121 #ifdef simgrid_EXPORTS
 122   /* The following categories are only defined in libsimgrid */
 123
 124   /* bindings */
 125 #if SIMGRID_HAVE_LUA
 126   XBT_LOG_CONNECT(lua);
 127   XBT_LOG_CONNECT(lua_host);
 128   XBT_LOG_CONNECT(lua_platf);
 129   XBT_LOG_CONNECT(lua_debug);
 130 #endif
 131
 132   /* instr */
 133   XBT_LOG_CONNECT(instr);
 134   XBT_LOG_CONNECT(instr_api);
 135   XBT_LOG_CONNECT(instr_config);
 136   XBT_LOG_CONNECT(instr_msg);
 137   XBT_LOG_CONNECT(instr_msg_process);
 138   XBT_LOG_CONNECT(instr_paje_containers);
 139   XBT_LOG_CONNECT(instr_paje_header);
 140   XBT_LOG_CONNECT(instr_paje_trace);
 141   XBT_LOG_CONNECT(instr_paje_types);
 142   XBT_LOG_CONNECT(instr_paje_values);
 143   XBT_LOG_CONNECT(instr_resource);
 144   XBT_LOG_CONNECT(instr_routing);
 145   XBT_LOG_CONNECT(instr_surf);
 146
 147   /* jedule */
 148 #if SIMGRID_HAVE_JEDULE
 149   XBT_LOG_CONNECT(jedule);
 150   XBT_LOG_CONNECT(jed_sd);
 151 #endif
 152
 153   /* mc */
 154 #if SIMGRID_HAVE_MC
 155   XBT_LOG_CONNECT(mc);
 156   XBT_LOG_CONNECT(mc_checkpoint);
 157   XBT_LOG_CONNECT(mc_comm_determinism);
 158   XBT_LOG_CONNECT(mc_compare);
 159   XBT_LOG_CONNECT(mc_dwarf);
 160   XBT_LOG_CONNECT(mc_hash);
 161   XBT_LOG_CONNECT(mc_liveness);
 162   XBT_LOG_CONNECT(mc_memory);
 163   XBT_LOG_CONNECT(mc_page_snapshot);
 164   XBT_LOG_CONNECT(mc_request);
 165   XBT_LOG_CONNECT(mc_safety);
 166   XBT_LOG_CONNECT(mc_VisitedState);
 167   XBT_LOG_CONNECT(mc_client);
 168   XBT_LOG_CONNECT(mc_client_api);
 169   XBT_LOG_CONNECT(mc_comm_pattern);
 170   XBT_LOG_CONNECT(mc_process);
 171   XBT_LOG_CONNECT(mc_protocol);
 172   XBT_LOG_CONNECT(mc_Channel);
 173   XBT_LOG_CONNECT(mc_ModelChecker);
 174   XBT_LOG_CONNECT(mc_RegionSnaphot);
 175   XBT_LOG_CONNECT(mc_Session);
 176   XBT_LOG_CONNECT(mc_state);
 177 #endif
 178   XBT_LOG_CONNECT(mc_global);
 179   XBT_LOG_CONNECT(mc_config);
 180   XBT_LOG_CONNECT(mc_record);
 181
 182   /* msg */
 183   XBT_LOG_CONNECT(msg);
 184   XBT_LOG_CONNECT(msg_action);
 185   XBT_LOG_CONNECT(msg_gos);
 186   XBT_LOG_CONNECT(msg_io);
 187   XBT_LOG_CONNECT(msg_kernel);
 188   XBT_LOG_CONNECT(msg_mailbox);
 189   XBT_LOG_CONNECT(msg_process);
 190   XBT_LOG_CONNECT(msg_synchro);
 191   XBT_LOG_CONNECT(msg_task);
 192   XBT_LOG_CONNECT(msg_vm);
 193
 194   /* s4u */
 195   XBT_LOG_CONNECT(s4u);
 196   XBT_LOG_CONNECT(s4u_activity);
 197   XBT_LOG_CONNECT(s4u_actor);
 198   XBT_LOG_CONNECT(s4u_netzone);
 199   XBT_LOG_CONNECT(s4u_channel);
 200   XBT_LOG_CONNECT(s4u_comm);
 201   XBT_LOG_CONNECT(s4u_file);
 202   XBT_LOG_CONNECT(s4u_link);
 203   XBT_LOG_CONNECT(s4u_vm);
 204
 205   /* sg */
 206   XBT_LOG_CONNECT(sg_host);
 207
 208   /* simdag */
 209   XBT_LOG_CONNECT(sd);
 210   XBT_LOG_CONNECT(sd_daxparse);
 211 #if HAVE_GRAPHVIZ
 212   XBT_LOG_CONNECT(sd_dotparse);
 213 #endif
 214   XBT_LOG_CONNECT(sd_kernel);
 215   XBT_LOG_CONNECT(sd_task);
 216
 217   /* simix */
 218   XBT_LOG_CONNECT(simix);
 219   XBT_LOG_CONNECT(simix_context);
 220   XBT_LOG_CONNECT(simix_deployment);
 221   XBT_LOG_CONNECT(simix_environment);
 222   XBT_LOG_CONNECT(simix_host);
 223   XBT_LOG_CONNECT(simix_io);
 224   XBT_LOG_CONNECT(simix_kernel);
 225   XBT_LOG_CONNECT(simix_mailbox);
 226   XBT_LOG_CONNECT(simix_network);
 227   XBT_LOG_CONNECT(simix_process);
 228   XBT_LOG_CONNECT(simix_popping);
 229   XBT_LOG_CONNECT(simix_synchro);
 230
 231   /* smpi */
 232   /* SMPI categories are connected in smpi_global.c */
 233
 234   /* surf */
 235   XBT_LOG_CONNECT(surf);
 236   XBT_LOG_CONNECT(surf_config);
 237   XBT_LOG_CONNECT(surf_cpu);
 238   XBT_LOG_CONNECT(surf_cpu_cas);
 239   XBT_LOG_CONNECT(surf_cpu_ti);
 240   XBT_LOG_CONNECT(surf_energy);
 241   XBT_LOG_CONNECT(surf_file);
 242   XBT_LOG_CONNECT(surf_kernel);
 243   XBT_LOG_CONNECT(surf_lagrange);
 244   XBT_LOG_CONNECT(surf_lagrange_dichotomy);
 245   XBT_LOG_CONNECT(surf_maxmin);
 246   XBT_LOG_CONNECT(surf_network);
 247 #if SIMGRID_HAVE_NS3
 248   XBT_LOG_CONNECT(ns3);
 249 #endif
 250   XBT_LOG_CONNECT(surf_parse);
 251   XBT_LOG_CONNECT(surf_plugin_load);
 252   XBT_LOG_CONNECT(surf_route);
 253   XBT_LOG_CONNECT(surf_routing_generic);
 254   XBT_LOG_CONNECT(surf_route_cluster);
 255   XBT_LOG_CONNECT(surf_route_cluster_torus);
 256   XBT_LOG_CONNECT(surf_route_cluster_dragonfly);
 257   XBT_LOG_CONNECT(surf_route_dijkstra);
 258   XBT_LOG_CONNECT(surf_route_fat_tree);
 259   XBT_LOG_CONNECT(surf_route_floyd);
 260   XBT_LOG_CONNECT(surf_route_full);
 261   XBT_LOG_CONNECT(surf_route_none);
 262   XBT_LOG_CONNECT(surf_route_vivaldi);
 263   XBT_LOG_CONNECT(surf_storage);
 264   XBT_LOG_CONNECT(surf_trace);
 265   XBT_LOG_CONNECT(surf_vm);
 266   XBT_LOG_CONNECT(surf_host);
 267
 268 #endif /* simgrid_EXPORTS */
 269 }
 270
 271 static void xbt_log_help(void);
 272 static void xbt_log_help_categories(void);
 273
 274 /** @brief Get all logging settings from the command line
 275  *
 276  * xbt_log_control_set() is called on each string we got from cmd line
 277  */
 278 void xbt_log_init(int *argc, char **argv)
 279 {
 280   unsigned help_requested = 0;  /* 1: logs; 2: categories */
 281   int j                   = 1;
 282
 283   /* uncomment to set the LOG category to debug directly */
 284   //    _XBT_LOGV(log).threshold = xbt_log_priority_debug;
 285
 286   xbt_log_connect_categories();
 287
 288   /* Set logs and init log submodule */
 289   for (int i = 1; i < *argc; i++) {
 290     if (!strncmp(argv[i], "--log=", strlen("--log="))) {
 291       char* opt = strchr(argv[i], '=');
 292       opt++;
 293       xbt_log_control_set(opt);
 294       XBT_DEBUG("Did apply '%s' as log setting", opt);
 295     } else if (!strcmp(argv[i], "--help-logs")) {
 296       help_requested |= 1U;
 297     } else if (!strcmp(argv[i], "--help-log-categories")) {
 298       help_requested |= 2U;
 299     } else {
 300       argv[j++] = argv[i];
 301     }
 302   }
 303   if (j < *argc) {
 304     argv[j] = NULL;
 305     *argc = j;
 306   }
 307
 308   if (help_requested) {
 309     if (help_requested & 1)
 310       xbt_log_help();
 311     if (help_requested & 2)
 312       xbt_log_help_categories();
 313     exit(0);
 314   }
 315 }
 316
 317 static void log_cat_exit(xbt_log_category_t cat)
 318 {
 319   xbt_log_category_t child;
 320
 321   if (cat->appender) {
 322     if (cat->appender->free_)
 323       cat->appender->free_(cat->appender);
 324     free(cat->appender);
 325   }
 326   if (cat->layout) {
 327     if (cat->layout->free_)
 328       cat->layout->free_(cat->layout);
 329     free(cat->layout);
 330   }
 331
 332   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
 333     log_cat_exit(child);
 334 }
 335
 336 void xbt_log_postexit(void)
 337 {
 338   XBT_VERB("Exiting log");
 339   xbt_os_mutex_destroy(log_cat_init_mutex);
 340   xbt_dynar_free(&xbt_log_settings);
 341   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
 342 }
 343
 344  /* Size of the static string in which we  build the log string */
 345 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
 346 /* Minimum size of the dynamic string in which we build the log string
 347    (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
 348 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
 349
 350 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
 351 {
 352   xbt_log_category_t cat = ev->cat;
 353
 354   xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
 355   xbt_assert(ev->priority < sizeof(xbt_log_priority_names), "Priority %d is greater than the biggest allowed value",
 356              ev->priority);
 357
 358   do {
 359     xbt_log_appender_t appender = cat->appender;
 360
 361     if (!appender)
 362       continue;                 /* No appender, try next */
 363
 364     xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
 365
 366     /* First, try with a static buffer */
 367     if (XBT_LOG_STATIC_BUFFER_SIZE) {
 368       char buff[XBT_LOG_STATIC_BUFFER_SIZE];
 369       ev->buffer = buff;
 370       ev->buffer_size = sizeof buff;
 371       va_start(ev->ap, fmt);
 372       int done = cat->layout->do_layout(cat->layout, ev, fmt);
 373       va_end(ev->ap);
 374       if (done) {
 375         appender->do_append(appender, buff);
 376         continue;               /* Ok, that worked: go next */
 377       }
 378     }
 379
 380     /* The static buffer was too small, use a dynamically expanded one */
 381     ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
 382     ev->buffer = xbt_malloc(ev->buffer_size);
 383     while (1) {
 384       va_start(ev->ap, fmt);
 385       int done = cat->layout->do_layout(cat->layout, ev, fmt);
 386       va_end(ev->ap);
 387       if (done)
 388         break;                  /* Got it */
 389       ev->buffer_size *= 2;
 390       ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
 391     }
 392     appender->do_append(appender, ev->buffer);
 393     xbt_free(ev->buffer);
 394
 395   } while (cat->additivity && (cat = cat->parent, 1));
 396 }
 397
 398 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
 399 #undef XBT_LOG_STATIC_BUFFER_SIZE
 400
 401 /* NOTE:
 402  *
 403  * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init().  Thus, if we want to avoid an
 404  * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
 405  * from it.
 406  *
 407  * To circumvent the problem, we define the macro_xbt_log_init() as (0) for the length of the affected functions, and
 408  * we do not forget to undefine it at the end!
 409  */
 410
 411 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting)
 412 {
 413 #define _xbt_log_cat_init(a, b) (0)
 414
 415   if (setting->thresh != xbt_log_priority_uninitialized) {
 416     xbt_log_threshold_set(category, setting->thresh);
 417
 418     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
 419            category->name, xbt_log_priority_names[category->threshold], category->threshold);
 420   }
 421
 422   if (setting->fmt) {
 423     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
 424
 425     XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting->fmt);
 426   }
 427
 428   if (setting->additivity != -1) {
 429     xbt_log_additivity_set(category, setting->additivity);
 430
 431     XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
 432            category->name, (setting->additivity ? "on" : "off"));
 433   }
 434   if (setting->appender) {
 435     xbt_log_appender_set(category, setting->appender);
 436     if (!category->layout)
 437       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
 438     category->additivity = 0;
 439     XBT_DEBUG("Set %p as appender of category '%s'", setting->appender, category->name);
 440   }
 441 #undef _xbt_log_cat_init
 442 }
 443
 444 /*
 445  * This gets called the first time a category is referenced and performs the initialization.
 446  * Also resets threshold to inherited!
 447  */
 448 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
 449 {
 450 #define _xbt_log_cat_init(a, b) (0)
 451
 452   if (log_cat_init_mutex != NULL)
 453     xbt_os_mutex_acquire(log_cat_init_mutex);
 454
 455   if (category->initialized) {
 456     if (log_cat_init_mutex != NULL)
 457       xbt_os_mutex_release(log_cat_init_mutex);
 458     return priority >= category->threshold;
 459   }
 460
 461   unsigned int cursor;
 462   xbt_log_setting_t setting = NULL;
 463
 464   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
 465          (category->firstChild ? category->firstChild->name : "none"),
 466          (category->nextSibling ? category->nextSibling->name : "none"));
 467
 468   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
 469     category->threshold = xbt_log_priority_info;
 470     category->appender = xbt_log_default_appender;
 471     category->layout = xbt_log_default_layout;
 472   } else {
 473     if (!category->parent)
 474       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
 475
 476     XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
 477            (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
 478            category->name);
 479     xbt_log_parent_set(category, category->parent);
 480
 481     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
 482       char *buf;
 483       char *res = NULL;
 484       xbt_log_category_t cpp = category->parent->firstChild;
 485       while (cpp) {
 486         if (res) {
 487           buf = bprintf("%s %s", res, cpp->name);
 488           free(res);
 489           res = buf;
 490         } else {
 491           res = xbt_strdup(cpp->name);
 492         }
 493         cpp = cpp->nextSibling;
 494       }
 495
 496       XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res,
 497              (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
 498
 499       free(res);
 500     }
 501   }
 502
 503   /* Apply the control */
 504   if (xbt_log_settings) {
 505     xbt_assert(category, "NULL category");
 506     xbt_assert(category->name);
 507     int found = 0;
 508
 509     xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
 510       xbt_assert(setting, "Damnit, NULL cat in the list");
 511       xbt_assert(setting->catname, "NULL setting(=%p)->catname", (void *) setting);
 512
 513       if (!strcmp(setting->catname, category->name)) {
 514         found = 1;
 515         _xbt_log_cat_apply_set(category, setting);
 516         xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
 517       }
 518     }
 519
 520     if (!found)
 521       XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
 522                 category->name, xbt_log_priority_names[category->threshold], category->threshold);
 523   }
 524
 525   category->initialized = 1;
 526   if (log_cat_init_mutex != NULL)
 527     xbt_os_mutex_release(log_cat_init_mutex);
 528   return priority >= category->threshold;
 529
 530 #undef _xbt_log_cat_init
 531 }
 532
 533 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
 534 {
 535   xbt_assert(cat, "NULL category to be given a parent");
 536   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
 537
 538   /* if the category is initialized, unlink from current parent */
 539   if (cat->initialized) {
 540     xbt_log_category_t *cpp = &cat->parent->firstChild;
 541
 542     while (*cpp != cat && *cpp != NULL) {
 543       cpp = &(*cpp)->nextSibling;
 544     }
 545
 546     xbt_assert(*cpp == cat);
 547     *cpp = cat->nextSibling;
 548   }
 549
 550   cat->parent = parent;
 551   cat->nextSibling = parent->firstChild;
 552
 553   parent->firstChild = cat;
 554
 555   if (!parent->initialized)
 556     _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
 557
 558   cat->threshold = parent->threshold;
 559
 560   cat->isThreshInherited = 1;
 561 }
 562
 563 static void _set_inherited_thresholds(xbt_log_category_t cat)
 564 {
 565   xbt_log_category_t child = cat->firstChild;
 566
 567   for (; child != NULL; child = child->nextSibling) {
 568     if (child->isThreshInherited) {
 569       if (cat != &_XBT_LOGV(log))
 570         XBT_VERB("Set category threshold of %s to %s (=%d)",
 571               child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
 572       child->threshold = cat->threshold;
 573       _set_inherited_thresholds(child);
 574     }
 575   }
 576 }
 577
 578 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
 579 {
 580   cat->threshold = threshold;
 581   cat->isThreshInherited = 0;
 582
 583   _set_inherited_thresholds(cat);
 584 }
 585
 586 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
 587 {
 588   const char *orig_control_string = control_string;
 589   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
 590
 591   set->catname = NULL;
 592   set->thresh = xbt_log_priority_uninitialized;
 593   set->fmt = NULL;
 594   set->additivity = -1;
 595   set->appender = NULL;
 596
 597   if (!*control_string)
 598     return set;
 599   XBT_DEBUG("Parse log setting '%s'", control_string);
 600
 601   control_string += strspn(control_string, " ");
 602   const char *name = control_string;
 603   control_string += strcspn(control_string, ".:= ");
 604   const char *dot = control_string;
 605   control_string += strcspn(control_string, ":= ");
 606   const char *eq = control_string;
 607
 608   xbt_assert(*dot == '.' || (*eq != '=' && *eq != ':'), "Invalid control string '%s'", orig_control_string);
 609
 610   if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
 611     int i;
 612     char *neweq = xbt_strdup(eq + 1);
 613     char *p = neweq - 1;
 614
 615     while (*(++p) != '\0') {
 616       if (*p >= 'a' && *p <= 'z') {
 617         *p -= 'a' - 'A';
 618       }
 619     }
 620
 621     XBT_DEBUG("New priority name = %s", neweq);
 622     for (i = 0; i < xbt_log_priority_infinite; i++) {
 623       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
 624         XBT_DEBUG("This is priority %d", i);
 625         break;
 626       }
 627     }
 628
 629     if(i<XBT_LOG_STATIC_THRESHOLD){
 630      fprintf(stderr,
 631          "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
 632          "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
 633          "while -DNLOG forbids any logging, at any level.",
 634              eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
 635      exit(1);
 636     }else if (i < xbt_log_priority_infinite) {
 637       set->thresh = (e_xbt_log_priority_t) i;
 638     } else {
 639       THROWF(arg_error, 0,
 640              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", eq + 1);
 641     }
 642     free(neweq);
 643   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
 644              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
 645     char *neweq = xbt_strdup(eq + 1);
 646     char *p = neweq - 1;
 647
 648     while (*(++p) != '\0') {
 649       if (*p >= 'a' && *p <= 'z') {
 650         *p -= 'a' - 'A';
 651       }
 652     }
 653     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES") || !strcmp(neweq, "1")) {
 654       set->additivity = 1;
 655     } else {
 656       set->additivity = 0;
 657     }
 658     free(neweq);
 659   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
 660              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
 661     char *neweq = xbt_strdup(eq + 1);
 662
 663     if (!strncmp(neweq, "file:", 5)) {
 664       set->appender = xbt_log_appender_file_new(neweq + 5);
 665     }else if (!strncmp(neweq, "rollfile:", 9)) {
 666       set->appender = xbt_log_appender2_file_new(neweq + 9,1);
 667     }else if (!strncmp(neweq, "splitfile:", 10)) {
 668       set->appender = xbt_log_appender2_file_new(neweq + 10,0);
 669     } else {
 670       THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
 671     }
 672     free(neweq);
 673   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
 674     set->fmt = xbt_strdup(eq + 1);
 675   } else {
 676     char buff[512];
 677     snprintf(buff, MIN(512, eq - dot), "%s", dot + 1);
 678     xbt_die("Unknown setting of the log category: '%s'", buff);
 679   }
 680   set->catname = (char *) xbt_malloc(dot - name + 1);
 681
 682   memcpy(set->catname, name, dot - name);
 683   set->catname[dot - name] = '\0';      /* Just in case */
 684   XBT_DEBUG("This is for cat '%s'", set->catname);
 685
 686   return set;
 687 }
 688
 689 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, char *name)
 690 {
 691   xbt_log_category_t child;
 692   xbt_log_category_t res;
 693
 694   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
 695          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
 696          (cat->nextSibling ? cat->nextSibling->name : "none"));
 697   if (!strcmp(cat->name, name))
 698     return cat;
 699
 700   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
 701     XBT_DEBUG("Dig into %s", child->name);
 702     res = _xbt_log_cat_searchsub(child, name);
 703     if (res)
 704       return res;
 705   }
 706
 707   return NULL;
 708 }
 709
 710 /**
 711  * \ingroup XBT_log
 712  * \param control_string What to parse
 713  *
 714  * Typically passed a command-line argument. The string has the syntax:
 715  *
 716  *      ( [category] "." [keyword] ":" value (" ")... )...
 717  *
 718  * where [category] is one the category names (see \ref XBT_log_cats for a complete list of the ones defined in the
 719  * SimGrid library) and keyword is one of the following:
 720  *
 721  *    - thres: category's threshold priority. Possible values:
 722  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
 723  *    - add or additivity: whether the logging actions must be passed to the parent category.
 724  *      Possible values: 0, 1, no, yes, on, off.
 725  *      Default value: yes.
 726  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
 727  *    - app or appender: the appender to use. See \ref log_use_conf_app for more information.
 728  */
 729 void xbt_log_control_set(const char *control_string)
 730 {
 731   xbt_log_setting_t set;
 732
 733   /* To split the string in commands, and the cursors */
 734   xbt_dynar_t set_strings;
 735   char *str;
 736   unsigned int cpt;
 737
 738   if (!control_string)
 739     return;
 740   XBT_DEBUG("Parse log settings '%s'", control_string);
 741
 742   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
 743   if (!strcmp(control_string, "no_loc")) {
 744     xbt_log_no_loc = 1;
 745     return;
 746   }
 747   /* some initialization if this is the first time that this get called */
 748   if (xbt_log_settings == NULL)
 749     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), _free_setting);
 750
 751   /* split the string, and remove empty entries */
 752   set_strings = xbt_str_split_quoted(control_string);
 753
 754   if (xbt_dynar_is_empty(set_strings)) {     /* vicious user! */
 755     xbt_dynar_free(&set_strings);
 756     return;
 757   }
 758
 759   /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
 760   xbt_dynar_foreach(set_strings, cpt, str) {
 761     set = _xbt_log_parse_setting(str);
 762     xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
 763
 764     if (cat) {
 765       XBT_DEBUG("Apply directly");
 766       _xbt_log_cat_apply_set(cat, set);
 767       _free_setting((void *) &set);
 768     } else {
 769       XBT_DEBUG("Store for further application");
 770       XBT_DEBUG("push %p to the settings", (void *) set);
 771       xbt_dynar_push(xbt_log_settings, &set);
 772     }
 773   }
 774   xbt_dynar_free(&set_strings);
 775 }
 776
 777 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
 778 {
 779   if (cat->appender) {
 780     if (cat->appender->free_)
 781       cat->appender->free_(cat->appender);
 782     free(cat->appender);
 783   }
 784   cat->appender = app;
 785 }
 786
 787 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
 788 {
 789 #define _xbt_log_cat_init(a, b) (0)
 790   if (!cat->appender) {
 791     XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
 792     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
 793   }
 794   if (cat->layout) {
 795     if (cat->layout->free_) {
 796       cat->layout->free_(cat->layout);
 797     }
 798     free(cat->layout);
 799   }
 800   cat->layout = lay;
 801   xbt_log_additivity_set(cat, 0);
 802 #undef _xbt_log_cat_init
 803 }
 804
 805 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
 806 {
 807   cat->additivity = additivity;
 808 }
 809
 810 static void xbt_log_help(void)
 811 {
 812   printf("Description of the logging output:\n"
 813          "\n"
 814          "   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
 815          "      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
 816          "      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
 817          "         -> trace: enter and return of some functions\n"
 818          "         -> debug: crufty output\n"
 819          "         -> verbose: verbose output for the user wanting more\n"
 820          "         -> info: output about the regular functioning\n"
 821          "         -> warning: minor issue encountered\n"
 822          "         -> error: issue encountered\n"
 823          "         -> critical: major issue encountered\n"
 824          "\n"
 825          "   Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n"
 826          "      OPTIONS may be:\n"
 827          "         -> %%%%: the %% char\n"
 828          "         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
 829          "         -> %%e: plain old space (SimGrid extension)\n"
 830          "\n"
 831          "         -> %%m: user-provided message\n"
 832          "\n"
 833          "         -> %%c: Category name (LOG4J compatible)\n"
 834          "         -> %%p: Priority name (LOG4J compatible)\n"
 835          "\n"
 836          "         -> %%h: Hostname (SimGrid extension)\n"
 837          "         -> %%P: Process name (SimGrid extension)\n"
 838          "         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
 839          "         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
 840          "\n"
 841          "         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
 842          "         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
 843          "in 'l'etter)\n"
 844          "         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
 845          "         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
 846          "                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
 847          "\n"
 848          "         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
 849          "GNU libc because\n"
 850          "                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
 851          "mac ones for example.\n"
 852          "         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
 853          "defined where %%b is.\n"
 854          "\n"
 855          "         -> %%d: date (UNIX-like epoch)\n"
 856          "         -> %%r: application age (time elapsed since the beginning of the application)\n"
 857          "\n"
 858          "   Miscellaneous:\n"
 859          "      --help-log-categories    Display the current hierarchy of log categories.\n"
 860          "      --log=no_loc             Don't print file names in messages (for tesh tests).\n"
 861          "\n");
 862 }
 863
 864 static int xbt_log_cat_cmp(const void *pa, const void *pb)
 865 {
 866   xbt_log_category_t a = *(xbt_log_category_t *)pa;
 867   xbt_log_category_t b = *(xbt_log_category_t *)pb;
 868   return strcmp(a->name, b->name);
 869 }
 870
 871 static void xbt_log_help_categories_rec(xbt_log_category_t category, const char *prefix)
 872 {
 873   char *this_prefix;
 874   char *child_prefix;
 875   unsigned i;
 876   xbt_log_category_t cat;
 877
 878   if (!category)
 879     return;
 880
 881   if (category->parent) {
 882     this_prefix = bprintf("%s \\_ ", prefix);
 883     child_prefix = bprintf("%s |  ", prefix);
 884   } else {
 885     this_prefix = xbt_strdup(prefix);
 886     child_prefix = xbt_strdup(prefix);
 887   }
 888
 889   xbt_dynar_t dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
 890   for (cat = category ; cat != NULL; cat = cat->nextSibling)
 891     xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
 892
 893   xbt_dynar_sort(dynar, xbt_log_cat_cmp);
 894
 895   xbt_dynar_foreach(dynar, i, cat){
 896     if (i == xbt_dynar_length(dynar) - 1 && category->parent)
 897       *strrchr(child_prefix, '|') = ' ';
 898     printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
 899     xbt_log_help_categories_rec(cat->firstChild, child_prefix);
 900   }
 901
 902   xbt_dynar_free(&dynar);
 903   xbt_free(this_prefix);
 904   xbt_free(child_prefix);
 905 }
 906
 907 static void xbt_log_help_categories(void)
 908 {
 909   printf("Current log category hierarchy:\n");
 910   xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), "   ");
 911   printf("\n");
 912 }