Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Reduce cognitive complexity (sonar).
[simgrid.git] / 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   if (0) {
285     _XBT_LOGV(log).threshold = xbt_log_priority_debug;
286   }
287   xbt_log_connect_categories();
288
289   /* Set logs and init log submodule */
290   for (int i = 1; i < *argc; i++) {
291     if (!strncmp(argv[i], "--log=", strlen("--log="))) {
292       char* opt = strchr(argv[i], '=');
293       opt++;
294       xbt_log_control_set(opt);
295       XBT_DEBUG("Did apply '%s' as log setting", opt);
296     } else if (!strcmp(argv[i], "--help-logs")) {
297       help_requested |= 1U;
298     } else if (!strcmp(argv[i], "--help-log-categories")) {
299       help_requested |= 2U;
300     } else {
301       argv[j++] = argv[i];
302     }
303   }
304   if (j < *argc) {
305     argv[j] = NULL;
306     *argc = j;
307   }
308
309   if (help_requested) {
310     if (help_requested & 1)
311       xbt_log_help();
312     if (help_requested & 2)
313       xbt_log_help_categories();
314     exit(0);
315   }
316 }
317
318 static void log_cat_exit(xbt_log_category_t cat)
319 {
320   xbt_log_category_t child;
321
322   if (cat->appender) {
323     if (cat->appender->free_)
324       cat->appender->free_(cat->appender);
325     free(cat->appender);
326   }
327   if (cat->layout) {
328     if (cat->layout->free_)
329       cat->layout->free_(cat->layout);
330     free(cat->layout);
331   }
332
333   for (child = cat->firstChild; child != NULL; child = child->nextSibling)
334     log_cat_exit(child);
335 }
336
337 void xbt_log_postexit(void)
338 {
339   XBT_VERB("Exiting log");
340   xbt_os_mutex_destroy(log_cat_init_mutex);
341   xbt_dynar_free(&xbt_log_settings);
342   log_cat_exit(&_XBT_LOGV(XBT_LOG_ROOT_CAT));
343 }
344
345  /* Size of the static string in which we  build the log string */
346 #define XBT_LOG_STATIC_BUFFER_SIZE 2048
347 /* Minimum size of the dynamic string in which we build the log string
348    (should be greater than XBT_LOG_STATIC_BUFFER_SIZE) */
349 #define XBT_LOG_DYNAMIC_BUFFER_SIZE 4096
350
351 void _xbt_log_event_log(xbt_log_event_t ev, const char *fmt, ...)
352 {
353   xbt_log_category_t cat = ev->cat;
354
355   xbt_assert(ev->priority >= 0, "Negative logging priority naturally forbidden");
356   xbt_assert(ev->priority < sizeof(xbt_log_priority_names), "Priority %d is greater than the biggest allowed value",
357              ev->priority);
358
359   while (1) {
360     xbt_log_appender_t appender = cat->appender;
361
362     if (appender != NULL) {
363       xbt_assert(cat->layout, "No valid layout for the appender of category %s", cat->name);
364
365       /* First, try with a static buffer */
366       int done = 0;
367       char buff[XBT_LOG_STATIC_BUFFER_SIZE];
368       ev->buffer      = buff;
369       ev->buffer_size = sizeof buff;
370       va_start(ev->ap, fmt);
371       done = cat->layout->do_layout(cat->layout, ev, fmt);
372       va_end(ev->ap);
373       if (done) {
374         appender->do_append(appender, buff);
375       } else {
376
377         /* The static buffer was too small, use a dynamically expanded one */
378         ev->buffer_size = XBT_LOG_DYNAMIC_BUFFER_SIZE;
379         ev->buffer      = xbt_malloc(ev->buffer_size);
380         while (1) {
381           va_start(ev->ap, fmt);
382           done = cat->layout->do_layout(cat->layout, ev, fmt);
383           va_end(ev->ap);
384           if (done)
385             break; /* Got it */
386           ev->buffer_size *= 2;
387           ev->buffer = xbt_realloc(ev->buffer, ev->buffer_size);
388         }
389         appender->do_append(appender, ev->buffer);
390         xbt_free(ev->buffer);
391       }
392     }
393
394     if (!cat->additivity)
395       break;
396     cat = cat->parent;
397   }
398 }
399
400 #undef XBT_LOG_DYNAMIC_BUFFER_SIZE
401 #undef XBT_LOG_STATIC_BUFFER_SIZE
402
403 /* NOTE:
404  *
405  * The standard logging macros use _XBT_LOG_ISENABLED, which calls _xbt_log_cat_init().  Thus, if we want to avoid an
406  * infinite recursion, we can not use the standard logging macros in _xbt_log_cat_init(), and in all functions called
407  * from it.
408  *
409  * To circumvent the problem, we define the macro_xbt_log_init() as (0) for the length of the affected functions, and
410  * we do not forget to undefine it at the end!
411  */
412
413 static void _xbt_log_cat_apply_set(xbt_log_category_t category, xbt_log_setting_t setting)
414 {
415 #define _xbt_log_cat_init(a, b) (0)
416
417   if (setting->thresh != xbt_log_priority_uninitialized) {
418     xbt_log_threshold_set(category, setting->thresh);
419
420     XBT_DEBUG("Apply settings for category '%s': set threshold to %s (=%d)",
421            category->name, xbt_log_priority_names[category->threshold], category->threshold);
422   }
423
424   if (setting->fmt) {
425     xbt_log_layout_set(category, xbt_log_layout_format_new(setting->fmt));
426
427     XBT_DEBUG("Apply settings for category '%s': set format to %s", category->name, setting->fmt);
428   }
429
430   if (setting->additivity != -1) {
431     xbt_log_additivity_set(category, setting->additivity);
432
433     XBT_DEBUG("Apply settings for category '%s': set additivity to %s",
434            category->name, (setting->additivity ? "on" : "off"));
435   }
436   if (setting->appender) {
437     xbt_log_appender_set(category, setting->appender);
438     if (!category->layout)
439       xbt_log_layout_set(category, xbt_log_layout_simple_new(NULL));
440     category->additivity = 0;
441     XBT_DEBUG("Set %p as appender of category '%s'", setting->appender, category->name);
442   }
443 #undef _xbt_log_cat_init
444 }
445
446 /*
447  * This gets called the first time a category is referenced and performs the initialization.
448  * Also resets threshold to inherited!
449  */
450 int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority)
451 {
452 #define _xbt_log_cat_init(a, b) (0)
453
454   if (log_cat_init_mutex != NULL)
455     xbt_os_mutex_acquire(log_cat_init_mutex);
456
457   if (category->initialized) {
458     if (log_cat_init_mutex != NULL)
459       xbt_os_mutex_release(log_cat_init_mutex);
460     return priority >= category->threshold;
461   }
462
463   unsigned int cursor;
464   xbt_log_setting_t setting = NULL;
465
466   XBT_DEBUG("Initializing category '%s' (firstChild=%s, nextSibling=%s)", category->name,
467          (category->firstChild ? category->firstChild->name : "none"),
468          (category->nextSibling ? category->nextSibling->name : "none"));
469
470   if (category == &_XBT_LOGV(XBT_LOG_ROOT_CAT)) {
471     category->threshold = xbt_log_priority_info;
472     category->appender = xbt_log_default_appender;
473     category->layout = xbt_log_default_layout;
474   } else {
475     if (!category->parent)
476       category->parent = &_XBT_LOGV(XBT_LOG_ROOT_CAT);
477
478     XBT_DEBUG("Set %s (%s) as father of %s ", category->parent->name,
479            (category->parent->initialized ? xbt_log_priority_names[category->parent->threshold] : "uninited"),
480            category->name);
481     xbt_log_parent_set(category, category->parent);
482
483     if (XBT_LOG_ISENABLED(log, xbt_log_priority_debug)) {
484       char *buf;
485       char *res = NULL;
486       xbt_log_category_t cpp = category->parent->firstChild;
487       while (cpp) {
488         if (res) {
489           buf = bprintf("%s %s", res, cpp->name);
490           free(res);
491           res = buf;
492         } else {
493           res = xbt_strdup(cpp->name);
494         }
495         cpp = cpp->nextSibling;
496       }
497
498       XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res,
499              (category->parent->nextSibling ? category->parent->nextSibling->name : "none"));
500
501       free(res);
502     }
503   }
504
505   /* Apply the control */
506   if (xbt_log_settings) {
507     xbt_assert(category, "NULL category");
508     xbt_assert(category->name);
509     int found = 0;
510
511     xbt_dynar_foreach(xbt_log_settings, cursor, setting) {
512       xbt_assert(setting, "Damnit, NULL cat in the list");
513       xbt_assert(setting->catname, "NULL setting(=%p)->catname", (void *) setting);
514
515       if (!strcmp(setting->catname, category->name)) {
516         found = 1;
517         _xbt_log_cat_apply_set(category, setting);
518         xbt_dynar_cursor_rm(xbt_log_settings, &cursor);
519       }
520     }
521
522     if (!found)
523       XBT_DEBUG("Category '%s': inherited threshold = %s (=%d)",
524                 category->name, xbt_log_priority_names[category->threshold], category->threshold);
525   }
526
527   category->initialized = 1;
528   if (log_cat_init_mutex != NULL)
529     xbt_os_mutex_release(log_cat_init_mutex);
530   return priority >= category->threshold;
531
532 #undef _xbt_log_cat_init
533 }
534
535 void xbt_log_parent_set(xbt_log_category_t cat, xbt_log_category_t parent)
536 {
537   xbt_assert(cat, "NULL category to be given a parent");
538   xbt_assert(parent, "The parent category of %s is NULL", cat->name);
539
540   /* if the category is initialized, unlink from current parent */
541   if (cat->initialized) {
542     xbt_log_category_t *cpp = &cat->parent->firstChild;
543
544     while (*cpp != cat && *cpp != NULL) {
545       cpp = &(*cpp)->nextSibling;
546     }
547
548     xbt_assert(*cpp == cat);
549     *cpp = cat->nextSibling;
550   }
551
552   cat->parent = parent;
553   cat->nextSibling = parent->firstChild;
554
555   parent->firstChild = cat;
556
557   if (!parent->initialized)
558     _xbt_log_cat_init(parent, xbt_log_priority_uninitialized /* ignored */ );
559
560   cat->threshold = parent->threshold;
561
562   cat->isThreshInherited = 1;
563 }
564
565 static void _set_inherited_thresholds(xbt_log_category_t cat)
566 {
567   xbt_log_category_t child = cat->firstChild;
568
569   for (; child != NULL; child = child->nextSibling) {
570     if (child->isThreshInherited) {
571       if (cat != &_XBT_LOGV(log))
572         XBT_VERB("Set category threshold of %s to %s (=%d)",
573               child->name, xbt_log_priority_names[cat->threshold], cat->threshold);
574       child->threshold = cat->threshold;
575       _set_inherited_thresholds(child);
576     }
577   }
578 }
579
580 void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t threshold)
581 {
582   cat->threshold = threshold;
583   cat->isThreshInherited = 0;
584
585   _set_inherited_thresholds(cat);
586 }
587
588 static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string)
589 {
590   const char *orig_control_string = control_string;
591   xbt_log_setting_t set = xbt_new(s_xbt_log_setting_t, 1);
592
593   set->catname = NULL;
594   set->thresh = xbt_log_priority_uninitialized;
595   set->fmt = NULL;
596   set->additivity = -1;
597   set->appender = NULL;
598
599   if (!*control_string)
600     return set;
601   XBT_DEBUG("Parse log setting '%s'", control_string);
602
603   control_string += strspn(control_string, " ");
604   const char *name = control_string;
605   control_string += strcspn(control_string, ".:= ");
606   const char *dot = control_string;
607   control_string += strcspn(control_string, ":= ");
608   const char *eq = control_string;
609
610   xbt_assert(*dot == '.' || (*eq != '=' && *eq != ':'), "Invalid control string '%s'", orig_control_string);
611
612   if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) {
613     int i;
614     char *neweq = xbt_strdup(eq + 1);
615     char *p = neweq - 1;
616
617     while (*(++p) != '\0') {
618       if (*p >= 'a' && *p <= 'z') {
619         *p -= 'a' - 'A';
620       }
621     }
622
623     XBT_DEBUG("New priority name = %s", neweq);
624     for (i = 0; i < xbt_log_priority_infinite; i++) {
625       if (!strncmp(xbt_log_priority_names[i], neweq, p - eq)) {
626         XBT_DEBUG("This is priority %d", i);
627         break;
628       }
629     }
630
631     if(i<XBT_LOG_STATIC_THRESHOLD){
632      fprintf(stderr,
633          "Priority '%s' (in setting '%s') is above allowed priority '%s'.\n\n"
634          "Compiling SimGrid with -DNDEBUG forbids the levels 'trace' and 'debug'\n"
635          "while -DNLOG forbids any logging, at any level.",
636              eq + 1, name, xbt_log_priority_names[XBT_LOG_STATIC_THRESHOLD]);
637      exit(1);
638     }else if (i < xbt_log_priority_infinite) {
639       set->thresh = (e_xbt_log_priority_t) i;
640     } else {
641       THROWF(arg_error, 0,
642              "Unknown priority name: %s (must be one of: trace,debug,verbose,info,warning,error,critical)", eq + 1);
643     }
644     free(neweq);
645   } else if (!strncmp(dot + 1, "add", (size_t) (eq - dot - 1)) ||
646              !strncmp(dot + 1, "additivity", (size_t) (eq - dot - 1))) {
647     char *neweq = xbt_strdup(eq + 1);
648     char *p = neweq - 1;
649
650     while (*(++p) != '\0') {
651       if (*p >= 'a' && *p <= 'z') {
652         *p -= 'a' - 'A';
653       }
654     }
655     if (!strcmp(neweq, "ON") || !strcmp(neweq, "YES") || !strcmp(neweq, "1")) {
656       set->additivity = 1;
657     } else {
658       set->additivity = 0;
659     }
660     free(neweq);
661   } else if (!strncmp(dot + 1, "app", (size_t) (eq - dot - 1)) ||
662              !strncmp(dot + 1, "appender", (size_t) (eq - dot - 1))) {
663     char *neweq = xbt_strdup(eq + 1);
664
665     if (!strncmp(neweq, "file:", 5)) {
666       set->appender = xbt_log_appender_file_new(neweq + 5);
667     }else if (!strncmp(neweq, "rollfile:", 9)) {
668       set->appender = xbt_log_appender2_file_new(neweq + 9,1);
669     }else if (!strncmp(neweq, "splitfile:", 10)) {
670       set->appender = xbt_log_appender2_file_new(neweq + 10,0);
671     } else {
672       THROWF(arg_error, 0, "Unknown appender log type: '%s'", neweq);
673     }
674     free(neweq);
675   } else if (!strncmp(dot + 1, "fmt", (size_t) (eq - dot - 1))) {
676     set->fmt = xbt_strdup(eq + 1);
677   } else {
678     char buff[512];
679     snprintf(buff, MIN(512, eq - dot), "%s", dot + 1);
680     xbt_die("Unknown setting of the log category: '%s'", buff);
681   }
682   set->catname = (char *) xbt_malloc(dot - name + 1);
683
684   memcpy(set->catname, name, dot - name);
685   set->catname[dot - name] = '\0';      /* Just in case */
686   XBT_DEBUG("This is for cat '%s'", set->catname);
687
688   return set;
689 }
690
691 static xbt_log_category_t _xbt_log_cat_searchsub(xbt_log_category_t cat, char *name)
692 {
693   xbt_log_category_t child;
694   xbt_log_category_t res;
695
696   XBT_DEBUG("Search '%s' into '%s' (firstChild='%s'; nextSibling='%s')", name,
697          cat->name, (cat->firstChild ? cat->firstChild->name : "none"),
698          (cat->nextSibling ? cat->nextSibling->name : "none"));
699   if (!strcmp(cat->name, name))
700     return cat;
701
702   for (child = cat->firstChild; child != NULL; child = child->nextSibling) {
703     XBT_DEBUG("Dig into %s", child->name);
704     res = _xbt_log_cat_searchsub(child, name);
705     if (res)
706       return res;
707   }
708
709   return NULL;
710 }
711
712 /**
713  * \ingroup XBT_log
714  * \param control_string What to parse
715  *
716  * Typically passed a command-line argument. The string has the syntax:
717  *
718  *      ( [category] "." [keyword] ":" value (" ")... )...
719  *
720  * where [category] is one the category names (see \ref XBT_log_cats for a complete list of the ones defined in the
721  * SimGrid library) and keyword is one of the following:
722  *
723  *    - thres: category's threshold priority. Possible values:
724  *             TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
725  *    - add or additivity: whether the logging actions must be passed to the parent category.
726  *      Possible values: 0, 1, no, yes, on, off.
727  *      Default value: yes.
728  *    - fmt: the format to use. See \ref log_use_conf_fmt for more information.
729  *    - app or appender: the appender to use. See \ref log_use_conf_app for more information.
730  */
731 void xbt_log_control_set(const char *control_string)
732 {
733   xbt_log_setting_t set;
734
735   /* To split the string in commands, and the cursors */
736   xbt_dynar_t set_strings;
737   char *str;
738   unsigned int cpt;
739
740   if (!control_string)
741     return;
742   XBT_DEBUG("Parse log settings '%s'", control_string);
743
744   /* Special handling of no_loc request, which asks for any file localization to be omitted (for tesh runs) */
745   if (!strcmp(control_string, "no_loc")) {
746     xbt_log_no_loc = 1;
747     return;
748   }
749   /* some initialization if this is the first time that this get called */
750   if (xbt_log_settings == NULL)
751     xbt_log_settings = xbt_dynar_new(sizeof(xbt_log_setting_t), _free_setting);
752
753   /* split the string, and remove empty entries */
754   set_strings = xbt_str_split_quoted(control_string);
755
756   if (xbt_dynar_is_empty(set_strings)) {     /* vicious user! */
757     xbt_dynar_free(&set_strings);
758     return;
759   }
760
761   /* Parse each entry and either use it right now (if the category was already created), or store it for further use */
762   xbt_dynar_foreach(set_strings, cpt, str) {
763     set = _xbt_log_parse_setting(str);
764     xbt_log_category_t cat = _xbt_log_cat_searchsub(&_XBT_LOGV(XBT_LOG_ROOT_CAT), set->catname);
765
766     if (cat) {
767       XBT_DEBUG("Apply directly");
768       _xbt_log_cat_apply_set(cat, set);
769       _free_setting((void *) &set);
770     } else {
771       XBT_DEBUG("Store for further application");
772       XBT_DEBUG("push %p to the settings", (void *) set);
773       xbt_dynar_push(xbt_log_settings, &set);
774     }
775   }
776   xbt_dynar_free(&set_strings);
777 }
778
779 void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app)
780 {
781   if (cat->appender) {
782     if (cat->appender->free_)
783       cat->appender->free_(cat->appender);
784     free(cat->appender);
785   }
786   cat->appender = app;
787 }
788
789 void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay)
790 {
791 #define _xbt_log_cat_init(a, b) (0)
792   if (!cat->appender) {
793     XBT_VERB ("No appender to category %s. Setting the file appender as default", cat->name);
794     xbt_log_appender_set(cat, xbt_log_appender_file_new(NULL));
795   }
796   if (cat->layout) {
797     if (cat->layout->free_) {
798       cat->layout->free_(cat->layout);
799     }
800     free(cat->layout);
801   }
802   cat->layout = lay;
803   xbt_log_additivity_set(cat, 0);
804 #undef _xbt_log_cat_init
805 }
806
807 void xbt_log_additivity_set(xbt_log_category_t cat, int additivity)
808 {
809   cat->additivity = additivity;
810 }
811
812 static void xbt_log_help(void)
813 {
814   printf("Description of the logging output:\n"
815          "\n"
816          "   Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n"
817          "      CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n"
818          "      PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n"
819          "         -> trace: enter and return of some functions\n"
820          "         -> debug: crufty output\n"
821          "         -> verbose: verbose output for the user wanting more\n"
822          "         -> info: output about the regular functioning\n"
823          "         -> warning: minor issue encountered\n"
824          "         -> error: issue encountered\n"
825          "         -> critical: major issue encountered\n"
826          "      The default priority level is 'info'.\n"
827          "\n"
828          "   Format configuration: --log=CATEGORY_NAME.fmt:FORMAT\n"
829          "      FORMAT string may contain:\n"
830          "         -> %%%%: the %% char\n"
831          "         -> %%n: platform-dependent line separator (LOG4J compatible)\n"
832          "         -> %%e: plain old space (SimGrid extension)\n"
833          "\n"
834          "         -> %%m: user-provided message\n"
835          "\n"
836          "         -> %%c: Category name (LOG4J compatible)\n"
837          "         -> %%p: Priority name (LOG4J compatible)\n"
838          "\n"
839          "         -> %%h: Hostname (SimGrid extension)\n"
840          "         -> %%P: Process name (SimGrid extension)\n"
841          "         -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n"
842          "         -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n"
843          "\n"
844          "         -> %%F: file name where the log event was raised (LOG4J compatible)\n"
845          "         -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as "
846          "in 'l'etter)\n"
847          "         -> %%L: line number where the log event was raised (LOG4J compatible)\n"
848          "         -> %%M: function name (LOG4J compatible -- called method name here of course).\n"
849          "                 Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n"
850          "\n"
851          "         -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the "
852          "GNU libc because\n"
853          "                 backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not "
854          "mac ones for example.\n"
855          "         -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; "
856          "defined where %%b is.\n"
857          "\n"
858          "         -> %%d: date (UNIX-like epoch)\n"
859          "         -> %%r: application age (time elapsed since the beginning of the application)\n"
860          "\n"
861          "   Miscellaneous:\n"
862          "      --help-log-categories    Display the current hierarchy of log categories.\n"
863          "      --log=no_loc             Don't print file names in messages (for tesh tests).\n"
864          "\n");
865 }
866
867 static int xbt_log_cat_cmp(const void *pa, const void *pb)
868 {
869   xbt_log_category_t a = *(xbt_log_category_t *)pa;
870   xbt_log_category_t b = *(xbt_log_category_t *)pb;
871   return strcmp(a->name, b->name);
872 }
873
874 static void xbt_log_help_categories_rec(xbt_log_category_t category, const char *prefix)
875 {
876   char *this_prefix;
877   char *child_prefix;
878   unsigned i;
879   xbt_log_category_t cat;
880
881   if (!category)
882     return;
883
884   if (category->parent) {
885     this_prefix = bprintf("%s \\_ ", prefix);
886     child_prefix = bprintf("%s |  ", prefix);
887   } else {
888     this_prefix = xbt_strdup(prefix);
889     child_prefix = xbt_strdup(prefix);
890   }
891
892   xbt_dynar_t dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL);
893   for (cat = category ; cat != NULL; cat = cat->nextSibling)
894     xbt_dynar_push_as(dynar, xbt_log_category_t, cat);
895
896   xbt_dynar_sort(dynar, xbt_log_cat_cmp);
897
898   xbt_dynar_foreach(dynar, i, cat){
899     if (i == xbt_dynar_length(dynar) - 1 && category->parent)
900       *strrchr(child_prefix, '|') = ' ';
901     printf("%s%s: %s\n", this_prefix, cat->name, cat->description);
902     xbt_log_help_categories_rec(cat->firstChild, child_prefix);
903   }
904
905   xbt_dynar_free(&dynar);
906   xbt_free(this_prefix);
907   xbt_free(child_prefix);
908 }
909
910 static void xbt_log_help_categories(void)
911 {
912   printf("Current log category hierarchy:\n");
913   xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), "   ");
914   printf("\n");
915 }