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