src/xbt/xbt_log_layout_format.cpp

   1 /* layout_simple - a dumb log layout                                        */
   2
   3 /* Copyright (c) 2007-2019. 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 "simgrid/host.h"
   9 #include "simgrid/msg.h" /* MSG_get_clock */
  10 #include "src/xbt/log_private.hpp"
  11 #include "xbt/sysdep.h"
  12 #include <stdio.h>
  13
  14 #ifndef MIN
  15 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  16 #endif
  17 #ifndef MAX
  18 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  19 #endif
  20
  21 extern const char *xbt_log_priority_names[8];
  22
  23 #define ERRMSG                                                          \
  24   "Unknown %%%c sequence in layout format (%s).\n"                      \
  25   "Known sequences:\n"                                                  \
  26   "  what:        %%m: user message  %%c: log category  %%p: log priority\n" \
  27   "  where:\n"                                                          \
  28   "    source:    %%F: file          %%L: line          %%M: function  %%l: location (%%F:%%L)\n" \
  29   "    runtime:   %%h: hostname      %%t: thread        %%P: process   %%i: PID\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;                                                            \
  52     int wd;                                                             \
  53     if (length == -1) {                                                 \
  54       wd = 0;                                                           \
  55     } else {                                                            \
  56       wd = length;                                                      \
  57       length = -1;                                                      \
  58     }                                                                   \
  59     if (precision == -1) {                                              \
  60       len = snprintf(p, rem_size, "%*" letter, wd, data);               \
  61     } else {                                                            \
  62       len = snprintf(p, rem_size, "%*.*" letter, wd, precision, data);  \
  63       precision = -1;                                                   \
  64     }                                                                   \
  65     check_overflow(len);                                                \
  66   } else (void)0
  67
  68 #define show_string(data)                                               \
  69   if (1) {                                                              \
  70     const char *show_string_data = (data);                              \
  71     show_it(show_string_data ? show_string_data : "(null)", "s");       \
  72   } else (void)0
  73 #define show_int(data)    show_it(data, "d")
  74 #define show_double(data) show_it(data, "f")
  75
  76 static int xbt_log_layout_format_doit(xbt_log_layout_t l, xbt_log_event_t ev, const char *msg_fmt)
  77 {
  78   char *p = ev->buffer;
  79   int rem_size = ev->buffer_size;
  80   int precision = -1;
  81   int length = -1;
  82
  83   for (char* q = static_cast<char*>(l->data) ; *q != '\0' ; q++) {
  84     if (*q == '%') {
  85       q++;
  86       do {
  87         switch (*q) {
  88           case '\0':
  89             fprintf(stderr, "Layout format (%s) ending with %%\n", (char*)l->data);
  90             xbt_abort();
  91           case '%':
  92             *p = '%';
  93             check_overflow(1);
  94             break;
  95           case 'n': /* platform-dependant line separator; LOG4J compliant */
  96             *p = '\n';
  97             check_overflow(1);
  98             break;
  99           case 'e': /* plain space; SimGrid extension */
 100             *p = ' ';
 101             check_overflow(1);
 102             break;
 103           case '.': /* precision specifier */
 104             precision = strtol(q + 1, &q, 10);
 105             continue; /* conversion specifier still not found, continue reading */
 106           case '0':
 107           case '1':
 108           case '2':
 109           case '3':
 110           case '4':
 111           case '5':
 112           case '6':
 113           case '7':
 114           case '8':
 115           case '9': /* length modifier */
 116             length = strtol(q, &q, 10);
 117             continue; /* conversion specifier still not found, continue reading */
 118           case 'c':   /* category name; LOG4J compliant
 119                          should accept a precision postfix to show the hierarchy */
 120             show_string(ev->cat->name);
 121             break;
 122           case 'p': /* priority name; LOG4J compliant */
 123             show_string(xbt_log_priority_names[ev->priority]);
 124             break;
 125           case 'h': /* host name; SimGrid extension */
 126             show_string(sg_host_self_get_name());
 127             break;
 128           case 't': /* thread/process name; LOG4J compliant */
 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 sz;
 140             set_sz_from_precision();
 141             int 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 'd': /* date; LOG4J compliant */
 152             show_double(MSG_get_clock());
 153             break;
 154           case 'r': /* application age; LOG4J compliant */
 155             show_double(MSG_get_clock());
 156             break;
 157           case 'm': { /* user-provided message; LOG4J compliant */
 158             int sz;
 159             set_sz_from_precision();
 160             va_list ap;
 161             va_copy(ap, ev->ap);
 162             int len = vsnprintf(p, sz, msg_fmt, ap);
 163             va_end(ap);
 164             check_overflow(MIN(sz, len));
 165             break;
 166           }
 167           default:
 168             fprintf(stderr, ERRMSG, *q, (char*)l->data);
 169             xbt_abort();
 170         }
 171         break; /* done, continue normally */
 172       } while (1);
 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   return res;
 196 }