src/xbt/xbt_log_layout_format.c

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