src/xbt/xbt_log_layout_format.c

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