src/xbt/log.c

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