src/xbt/xbt_log_layout_format.c

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