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;                                                            \
  54     int wd;                                                             \
  55     if (length == -1) {                                                 \
  56       wd = 0;                                                           \
  57     } else {                                                            \
  58       wd = length;                                                      \
  59       length = -1;                                                      \
  60     }                                                                   \
  61     if (precision == -1) {                                              \
  62       len = snprintf(p, rem_size, "%*" letter, wd, data);               \
  63     } else {                                                            \
  64       len = snprintf(p, rem_size, "%*.*" letter, wd, precision, data);  \
  65       precision = -1;                                                   \
  66     }                                                                   \
  67     check_overflow(len);                                                \
  68   } else (void)0
  69
  70 #define show_string(data)                                               \
  71   if (1) {                                                              \
  72     const char *show_string_data = (data);                              \
  73     show_it(show_string_data ? show_string_data : "(null)", "s");       \
  74   } else (void)0
  75 #define show_int(data)    show_it(data, "d")
  76 #define show_double(data) show_it(data, "f")
  77
  78 static int xbt_log_layout_format_doit(xbt_log_layout_t l, xbt_log_event_t ev, const char *msg_fmt)
  79 {
  80   char *p = ev->buffer;
  81   int rem_size = ev->buffer_size;
  82   int precision = -1;
  83   int length = -1;
  84
  85   for (char* 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         break;
  94       case '%':
  95         *p = '%';
  96         check_overflow(1);
  97         break;
  98       case 'n':         /* platform-dependant line separator; LOG4J compliant */
  99         *p = '\n';
 100         check_overflow(1);
 101         break;
 102       case 'e':                 /* plain space; SimGrid extension */
 103         *p = ' ';
 104         check_overflow(1);
 105         break;
 106       case '.':                 /* precision specifier */
 107         precision = strtol(q + 1, &q, 10);
 108         goto handle_modifier;
 109       case '0':
 110       case '1':
 111       case '2':
 112       case '3':
 113       case '4':
 114       case '5':
 115       case '6':
 116       case '7':
 117       case '8':
 118       case '9':                 /* length modifier */
 119         length = strtol(q, &q, 10);
 120         goto handle_modifier;
 121       case 'c':                 /* category name; LOG4J compliant
 122                                    should accept a precision postfix to show the hierarchy */
 123         show_string(ev->cat->name);
 124         break;
 125       case 'p':                 /* priority name; LOG4J compliant */
 126         show_string(xbt_log_priority_names[ev->priority]);
 127         break;
 128       case 'h':                 /* host name; SimGrid extension */
 129         show_string(SIMIX_host_self_get_name());
 130         break;
 131       case 't':                 /* thread name; LOG4J compliant */
 132         show_string(SIMIX_process_self_get_name());
 133         break;
 134       case 'P':                 /* process name; SimGrid extension */
 135         show_string(xbt_procname());
 136         break;
 137       case 'i':                 /* process PID name; SimGrid extension */
 138         show_int(xbt_getpid());
 139         break;
 140       case 'F':                 /* file name; LOG4J compliant */
 141         show_string(ev->fileName);
 142         break;
 143       case 'l': {               /* location; LOG4J compliant */
 144         int sz;
 145         set_sz_from_precision();
 146         int len = snprintf(p, sz, "%s:%d", ev->fileName, ev->lineNum);
 147         check_overflow(MIN(sz, len));
 148         break;
 149       }
 150       case 'L':                 /* line number; LOG4J compliant */
 151         show_int(ev->lineNum);
 152         break;
 153       case 'M':                /* method (ie, function) name; LOG4J compliant */
 154         show_string(ev->functionName);
 155         break;
 156       case 'd':                 /* date; LOG4J compliant */
 157         show_double(surf_get_clock());
 158         break;
 159       case 'r':                 /* application age; LOG4J compliant */
 160         show_double(surf_get_clock() - format_begin_of_time);
 161         break;
 162       case 'm': {               /* user-provided message; LOG4J compliant */
 163         int sz;
 164         set_sz_from_precision();
 165         int len = vsnprintf(p, sz, msg_fmt, ev->ap);
 166         check_overflow(MIN(sz, len));
 167         break;
 168       }
 169       default:
 170         fprintf(stderr, ERRMSG, *q, (char *)l->data);
 171         xbt_abort();
 172       }
 173     } else {
 174       *p = *q;
 175       check_overflow(1);
 176     }
 177   }
 178   *p = '\0';
 179
 180   return 1;
 181 }
 182
 183 static void xbt_log_layout_format_free(xbt_log_layout_t lay)
 184 {
 185   free(lay->data);
 186 }
 187
 188 xbt_log_layout_t xbt_log_layout_format_new(char *arg)
 189 {
 190   xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
 191   res->do_layout       = &xbt_log_layout_format_doit;
 192   res->free_           = &xbt_log_layout_format_free;
 193   res->data = xbt_strdup((char *) arg);
 194
 195   if (format_begin_of_time < 0)
 196     format_begin_of_time = surf_get_clock();
 197
 198   return res;
 199 }