src/xbt/xbt_log_layout_format.cpp

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