src/xbt/xbt_log_layout_format.cpp

   1 /* layout_simple - a dumb log layout                                        */
   2
   3 /* Copyright (c) 2007-2020. 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/engine.h" /* simgrid_get_clock */
   9 #include "simgrid/host.h"
  10 #include "src/xbt/log_private.hpp"
  11 #include "xbt/sysdep.h"
  12 #include <algorithm>
  13 #include <cstdio>
  14
  15 extern const char *xbt_log_priority_names[8];
  16
  17 static constexpr const char* ERRMSG =
  18     "Unknown %%%c sequence in layout format (%s).\n"
  19     "Known sequences:\n"
  20     "  what:        %%m: user message  %%c: log category  %%p: log priority\n"
  21     "  where:\n"
  22     "    source:    %%F: file          %%L: line          %%M: function  %%l: location (%%F:%%L)\n"
  23     "    runtime:   %%h: hostname      %%t: thread        %%P: process   %%i: PID\n"
  24     "  when:        %%d: date          %%r: app. age\n"
  25     "  other:       %%%%: %%             %%n: new line      %%e: plain space\n";
  26
  27 #define check_overflow(len)                                             \
  28   if ((rem_size -= (len)) > 0) {                                        \
  29     p += (len);                                                         \
  30   } else                                                                \
  31     return 0
  32
  33 #define set_sz_from_precision()                                         \
  34   if (1) {                                                              \
  35     sz = rem_size;                                                      \
  36     if (precision != -1) {                                              \
  37       if (precision < sz)                                               \
  38         sz = precision + 1;     /* +1 for the final '\0' */             \
  39       precision = -1;                                                   \
  40     }                                                                   \
  41   } else (void)0
  42
  43 #define show_it(data, letter)                                                                                          \
  44   if (1) {                                                                                                             \
  45     int len;                                                                                                           \
  46     int wd;                                                                                                            \
  47     if (length == -1) {                                                                                                \
  48       wd = 0;                                                                                                          \
  49     } else {                                                                                                           \
  50       wd     = length;                                                                                                 \
  51       length = -1;                                                                                                     \
  52     }                                                                                                                  \
  53     if (precision == -1) {                                                                                             \
  54       len = snprintf(p, rem_size, "%*" letter, wd, (data));                                                            \
  55     } else {                                                                                                           \
  56       len       = snprintf(p, rem_size, "%*.*" letter, wd, precision, (data));                                         \
  57       precision = -1;                                                                                                  \
  58     }                                                                                                                  \
  59     check_overflow(len);                                                                                               \
  60   } else                                                                                                               \
  61   (void)0
  62
  63 #define show_string(data)                                               \
  64   if (1) {                                                              \
  65     const char *show_string_data = (data);                              \
  66     show_it(show_string_data ? show_string_data : "(null)", "s");       \
  67   } else (void)0
  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(const s_xbt_log_layout_t* l, xbt_log_event_t ev, const char* msg_fmt)
  72 {
  73   char *p = ev->buffer;
  74   int rem_size = ev->buffer_size;
  75   int precision = -1;
  76   int length = -1;
  77
  78   for (char* q = static_cast<char*>(l->data) ; *q != '\0' ; q++) {
  79     if (*q == '%') {
  80       q++;
  81       do {
  82         switch (*q) {
  83           case '\0':
  84             fprintf(stderr, "Layout format (%s) ending with %%\n", (char*)l->data);
  85             xbt_abort();
  86           case '%':
  87             *p = '%';
  88             check_overflow(1);
  89             break;
  90           case 'n': /* platform-dependant line separator; LOG4J compliant */
  91             *p = '\n';
  92             check_overflow(1);
  93             break;
  94           case 'e': /* plain space; SimGrid extension */
  95             *p = ' ';
  96             check_overflow(1);
  97             break;
  98           case '.': /* precision specifier */
  99             precision = strtol(q + 1, &q, 10);
 100             continue; /* conversion specifier still not found, continue reading */
 101           case '0':
 102           case '1':
 103           case '2':
 104           case '3':
 105           case '4':
 106           case '5':
 107           case '6':
 108           case '7':
 109           case '8':
 110           case '9': /* length modifier */
 111             length = strtol(q, &q, 10);
 112             continue; /* conversion specifier still not found, continue reading */
 113           case 'c':   /* category name; LOG4J compliant
 114                          should accept a precision postfix to show the hierarchy */
 115             show_string(ev->cat->name);
 116             break;
 117           case 'p': /* priority name; LOG4J compliant */
 118             show_string(xbt_log_priority_names[ev->priority]);
 119             break;
 120           case 'h': /* host name; SimGrid extension */
 121             show_string(sg_host_self_get_name());
 122             break;
 123           case 't': /* thread/process name; LOG4J compliant */
 124           case 'P': /* process name; SimGrid extension */
 125             show_string(xbt_procname());
 126             break;
 127           case 'i': /* process PID name; SimGrid extension */
 128             show_int(xbt_getpid());
 129             break;
 130           case 'F': /* file name; LOG4J compliant */
 131             show_string(ev->fileName);
 132             break;
 133           case 'l': { /* location; LOG4J compliant */
 134             int sz;
 135             set_sz_from_precision();
 136             int len = snprintf(p, sz, "%s:%d", ev->fileName, ev->lineNum);
 137             check_overflow(std::min(sz, len));
 138             break;
 139           }
 140           case 'L': /* line number; LOG4J compliant */
 141             show_int(ev->lineNum);
 142             break;
 143           case 'M': /* method (ie, function) name; LOG4J compliant */
 144             show_string(ev->functionName);
 145             break;
 146           case 'd': /* date; LOG4J compliant */
 147             show_double(simgrid_get_clock());
 148             break;
 149           case 'r': /* application age; LOG4J compliant */
 150             show_double(simgrid_get_clock());
 151             break;
 152           case 'm': { /* user-provided message; LOG4J compliant */
 153             int sz;
 154             set_sz_from_precision();
 155             va_list ap;
 156             va_copy(ap, ev->ap);
 157             int len = vsnprintf(p, sz, msg_fmt, ap);
 158             va_end(ap);
 159             check_overflow(std::min(sz, len));
 160             break;
 161           }
 162           default:
 163             fprintf(stderr, ERRMSG, *q, (char*)l->data);
 164             xbt_abort();
 165         }
 166         break; /* done, continue normally */
 167       } while (1);
 168     } else {
 169       *p = *q;
 170       check_overflow(1);
 171     }
 172   }
 173   *p = '\0';
 174
 175   return 1;
 176 }
 177
 178 static void xbt_log_layout_format_free(const s_xbt_log_layout_t* lay)
 179 {
 180   xbt_free(lay->data);
 181 }
 182
 183 xbt_log_layout_t xbt_log_layout_format_new(const char* arg)
 184 {
 185   xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
 186   res->do_layout       = &xbt_log_layout_format_doit;
 187   res->free_           = &xbt_log_layout_format_free;
 188   res->data            = xbt_strdup(arg);
 189
 190   return res;
 191 }