src/xbt/xbt_log_layout_format.c

   1 /* layout_simple - a dumb log layout                                        */
   2
   3 /* Copyright (c) 2007-2014. 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 "src/portable.h"       /* execinfo when available */
  10 #include "xbt/synchro_core.h"   /* xbt_thread_self_name */
  11 #include "src/xbt/ex_interface.h"
  12 #include "xbt/sysdep.h"
  13 #include "xbt/strbuff.h"
  14 #include "src/xbt/log_private.h"
  15 #include "simgrid/simix.h"      /* SIMIX_host_self_get_name */
  16 #include "surf/surf.h"
  17 #include <stdio.h>
  18
  19 #ifdef HAVE_EXECINFO_H
  20 #  include <execinfo.h> /* Function backtrace */
  21 #endif
  22
  23 extern const char *xbt_log_priority_names[8];
  24
  25 static double format_begin_of_time = -1;
  26
  27 #define ERRMSG                                                          \
  28   "Unknown %%%c sequence in layout format (%s).\n"                      \
  29   "Known sequences:\n"                                                  \
  30   "  what:        %%m: user message  %%c: log category  %%p: log priority\n" \
  31   "  where:\n"                                                          \
  32   "    source:    %%F: file          %%L: line          %%M: function  %%l: location (%%F:%%L)\n" \
  33   "    runtime:   %%h: hostname      %%t: thread        %%P: process   %%i: PID\n" \
  34   "    backtrace: %%b: full          %%B: short\n"                      \
  35   "  when:        %%d: date          %%r: app. age\n"                   \
  36   "  other:       %%%%: %%             %%n: new line      %%e: plain space\n"
  37
  38 #define check_overflow(len)                                             \
  39   if ((rem_size -= (len)) > 0) {                                        \
  40     p += (len);                                                         \
  41   } else                                                                \
  42     return 0
  43
  44 #define set_sz_from_precision()                                         \
  45   if (1) {                                                              \
  46     sz = rem_size;                                                      \
  47     if (precision != -1) {                                              \
  48       if (precision < sz)                                               \
  49         sz = precision + 1;     /* +1 for the final '\0' */             \
  50       precision = -1;                                                   \
  51     }                                                                   \
  52   } else (void)0
  53
  54 #define show_it(data, letter)                                           \
  55   if (1) {                                                              \
  56     int len, wd;                                                        \
  57     if (length == -1) {                                                 \
  58       wd = 0;                                                           \
  59     } else {                                                            \
  60       wd = length;                                                      \
  61       length = -1;                                                      \
  62     }                                                                   \
  63     if (precision == -1) {                                              \
  64       len = snprintf(p, rem_size, "%*" letter, wd, data);               \
  65     } else {                                                            \
  66       len = snprintf(p, rem_size, "%*.*" letter, wd, precision, data);  \
  67       precision = -1;                                                   \
  68     }                                                                   \
  69     check_overflow(len);                                                \
  70   } else (void)0
  71
  72 #define show_string(data)                                               \
  73   if (1) {                                                              \
  74     const char *show_string_data = (data);                              \
  75     show_it(show_string_data ? show_string_data : "(null)", "s");       \
  76   } else (void)0
  77 #define show_int(data)    show_it(data, "d")
  78 #define show_double(data) show_it(data, "f")
  79
  80 static int xbt_log_layout_format_doit(xbt_log_layout_t l,
  81                                       xbt_log_event_t ev,
  82                                       const char *msg_fmt)
  83 {
  84   char *p = ev->buffer;
  85   int rem_size = ev->buffer_size;
  86   int precision = -1;
  87   int length = -1;
  88   char *q;
  89
  90   for (q = l->data ; *q != '\0' ; q++) {
  91     if (*q == '%') {
  92       q++;
  93     handle_modifier:
  94       switch (*q) {
  95       case '\0':
  96         fprintf(stderr, "Layout format (%s) ending with %%\n", (char *)l->data);
  97         xbt_abort();
  98       case '%':
  99         *p = '%';
 100         check_overflow(1);
 101         break;
 102       case 'n':         /* platform-dependant line separator; LOG4J compliant */
 103         *p = '\n';
 104         check_overflow(1);
 105         break;
 106       case 'e':                 /* plain space; SimGrid extension */
 107         *p = ' ';
 108         check_overflow(1);
 109         break;
 110       case '.':                 /* precision specifier */
 111         precision = strtol(q + 1, &q, 10);
 112         goto handle_modifier;
 113       case '0':
 114       case '1':
 115       case '2':
 116       case '3':
 117       case '4':
 118       case '5':
 119       case '6':
 120       case '7':
 121       case '8':
 122       case '9':                 /* length modifier */
 123         length = strtol(q, &q, 10);
 124         goto handle_modifier;
 125       case 'c':                 /* category name; LOG4J compliant
 126                                    should accept a precision postfix to show the
 127                                    hierarchy */
 128         show_string(ev->cat->name);
 129         break;
 130       case 'p':                 /* priority name; LOG4J compliant */
 131         show_string(xbt_log_priority_names[ev->priority]);
 132         break;
 133       case 'h':                 /* host name; SimGrid extension */
 134         show_string(SIMIX_host_self_get_name());
 135         break;
 136       case 't':                 /* thread name; LOG4J compliant */
 137         show_string(SIMIX_process_self_get_name());
 138         break;
 139       case 'P':                 /* process name; SimGrid extension */
 140         show_string(xbt_procname());
 141         break;
 142       case 'i':                 /* process PID name; SimGrid extension */
 143         show_int(xbt_getpid());
 144         break;
 145       case 'F':                 /* file name; LOG4J compliant */
 146         show_string(ev->fileName);
 147         break;
 148       case 'l': {               /* location; LOG4J compliant */
 149         int len, sz;
 150         set_sz_from_precision();
 151         len = snprintf(p, sz, "%s:%d", ev->fileName, ev->lineNum);
 152         check_overflow(MIN(sz, len));
 153         break;
 154       }
 155       case 'L':                 /* line number; LOG4J compliant */
 156         show_int(ev->lineNum);
 157         break;
 158       case 'M':                /* method (ie, function) name; LOG4J compliant */
 159         show_string(ev->functionName);
 160         break;
 161       case 'b':                 /* backtrace; called %throwable in LOG4J */
 162       case 'B':         /* short backtrace; called %throwable{short} in LOG4J */
 163 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 164         {
 165           xbt_ex_t e;
 166
 167           e.used = backtrace((void **) e.bt, XBT_BACKTRACE_SIZE);
 168           e.bt_strings = NULL;
 169           e.msg = NULL;
 170           xbt_ex_setup_backtrace(&e);
 171           if (*q == 'B') {
 172             show_string(e.bt_strings[1] + 8);
 173           } else {
 174             xbt_strbuff_t buff = xbt_strbuff_new();
 175             int i;
 176             xbt_strbuff_append(buff, e.bt_strings[1] + 8);
 177             for (i = 2; i < e.used; i++) {
 178               xbt_strbuff_append(buff, "\n");
 179               xbt_strbuff_append(buff, e.bt_strings[i] + 8);
 180             }
 181             show_string(buff->data);
 182             xbt_strbuff_free(buff);
 183           }
 184           xbt_ex_free(e);
 185         }
 186 #else
 187         show_string("(no backtrace on this arch)");
 188 #endif
 189         break;
 190       case 'd':                 /* date; LOG4J compliant */
 191         show_double(surf_get_clock());
 192         break;
 193       case 'r':                 /* application age; LOG4J compliant */
 194         show_double(surf_get_clock() - format_begin_of_time);
 195         break;
 196       case 'm': {               /* user-provided message; LOG4J compliant */
 197         int len, sz;
 198         set_sz_from_precision();
 199         len = vsnprintf(p, sz, msg_fmt, ev->ap);
 200         check_overflow(MIN(sz, len));
 201         break;
 202       }
 203       default:
 204         fprintf(stderr, ERRMSG, *q, (char *)l->data);
 205         xbt_abort();
 206       }
 207     } else {
 208       *p = *q;
 209       check_overflow(1);
 210     }
 211   }
 212   *p = '\0';
 213
 214   return 1;
 215 }
 216
 217 static void xbt_log_layout_format_free(xbt_log_layout_t lay)
 218 {
 219   free(lay->data);
 220 }
 221
 222 xbt_log_layout_t xbt_log_layout_format_new(char *arg)
 223 {
 224   xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
 225   res->do_layout = xbt_log_layout_format_doit;
 226   res->free_ = xbt_log_layout_format_free;
 227   res->data = xbt_strdup((char *) arg);
 228
 229   if (format_begin_of_time < 0)
 230     format_begin_of_time = surf_get_clock();
 231
 232   return res;
 233 }