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