src/xbt/xbt_log_layout_format.c

   1 /* layout_simple - a dumb log layout                                        */
   2
   3 /* Copyright (c) 2007-2011. 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 "portable.h"           /* execinfo when available */
  10 #include "xbt/sysdep.h"
  11 #include "xbt/strbuff.h"
  12 #include "xbt/log_private.h"
  13 #include "gras/virtu.h"         /* gras_os_myname (KILLME) */
  14 #include "xbt/synchro.h"        /* xbt_thread_self_name */
  15 #include <stdio.h>
  16
  17 extern const char *xbt_log_priority_names[8];
  18
  19 static double format_begin_of_time = -1;
  20
  21 #define ERRMSG "Unknown %%%c sequence in layout format (%s).\nKnown 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   "    backtrace: %%b: full          %%B: short\n"                                                \
  27   "  when:        %%d: date          %%r: app. age\n"                                             \
  28   "  other:       %%%%: %%             %%n: new line      %%e: plain space\n"
  29
  30 #define XBT_LOG_BUFF_SIZE (ev->buffer_size)
  31
  32 #undef check_overflow
  33 #define check_overflow \
  34   if (p - ev->buffer >= XBT_LOG_BUFF_SIZE) { /* buffer overflow */ \
  35     return 0;                                                      \
  36   } else ((void)0)
  37
  38 #define show_it(data,letter) \
  39   do { \
  40     if (precision == -1 && length == -1) { \
  41       p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%" letter, data); \
  42     } else if (precision == -1) { \
  43       sprintf(tmpfmt,"%%%d" letter,length); \
  44       p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), tmpfmt, data); \
  45       length = -1; \
  46     } else if (length == -1) { \
  47       p += sprintf(p, "%.*" letter, \
  48                    (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer), precision), \
  49                    data);\
  50       precision = -1; \
  51     } else { \
  52       sprintf(tmpfmt,"%%%d.%d" letter,length, \
  53           (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer), precision));\
  54       p += sprintf(p, tmpfmt, data);\
  55       length = precision = -1; \
  56     } \
  57     check_overflow; \
  58   } while (0)
  59
  60 #define show_string(data) show_it(data, "s")
  61 #define show_int(data)    show_it(data, "d")
  62 #define show_double(data) show_it(data, "f")
  63
  64 static int xbt_log_layout_format_doit(xbt_log_layout_t l,
  65                                       xbt_log_event_t ev,
  66                                       const char *msg_fmt)
  67 {
  68   char *p, *q;
  69   char tmpfmt[50];
  70   int precision = -1;
  71   int length = -1;
  72
  73
  74   p = ev->buffer;
  75   q = l->data;
  76
  77   while (*q != '\0') {
  78     if (*q == '%') {
  79       q++;
  80     handle_modifier:
  81       switch (*q) {
  82       case '\0':
  83         fprintf(stderr, "Layout format (%s) ending with %%\n",
  84                 (char *) l->data);
  85         abort();
  86       case '%':
  87         *p++ = '%';
  88         break;
  89       case 'n':                /* platform-dependant line separator (LOG4J compliant) */
  90         p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "\n");
  91         check_overflow;
  92         break;
  93       case 'e':                /* plain space (SimGrid extension) */
  94         p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), " ");
  95         check_overflow;
  96         break;
  97
  98       case '.':                /* precision specifyier */
  99         q++;
 100         sscanf(q, "%d", &precision);
 101         q += (precision>9?2:1);
 102         goto handle_modifier;
 103
 104       case '0':
 105       case '1':
 106       case '2':
 107       case '3':
 108       case '4':
 109       case '5':
 110       case '6':
 111       case '7':
 112       case '8':
 113       case '9': /* length modifier */
 114         sscanf(q, "%d", &length);
 115         q += (length>9?2:1);
 116         goto handle_modifier;
 117
 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
 126       case 'h':                /* host name; SimGrid extension */
 127         show_string(gras_os_myname());
 128         break;
 129       case 't':                /* thread name; LOG4J compliant */
 130         show_string(xbt_thread_self_name());
 131         break;
 132       case 'P':                /* process name; SimGrid extension */
 133         show_string(xbt_procname());
 134         break;
 135       case 'i':                /* process PID name; SimGrid extension */
 136         show_int((*xbt_getpid) ());
 137         break;
 138
 139       case 'F':                /* file name; LOG4J compliant */
 140         show_string(ev->fileName);
 141         break;
 142       case 'l':                /* location; LOG4J compliant */
 143         if (precision == -1) {
 144           p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s:%d",
 145                         ev->fileName, ev->lineNum);
 146           check_overflow;
 147         } else {
 148           p += snprintf(p,
 149                         (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
 150                                   precision), "%s:%d", ev->fileName,
 151                         ev->lineNum);
 152           check_overflow;
 153           precision = -1;
 154         }
 155         break;
 156       case 'L':                /* line number; LOG4J compliant */
 157         show_int(ev->lineNum);
 158         break;
 159       case 'M':                /* method (ie, function) name; LOG4J compliant */
 160         show_string(ev->functionName);
 161         break;
 162       case 'b':                /* backtrace; called %throwable in LOG4J */
 163       case 'B':                /* short backtrace; called %throwable{short} in LOG4J */
 164 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 165         {
 166           xbt_ex_t e;
 167           int i;
 168
 169           e.used = backtrace((void **) e.bt, XBT_BACKTRACE_SIZE);
 170           e.bt_strings = NULL;
 171           e.msg = NULL;
 172           e.remote = 0;
 173           xbt_backtrace_current(&e);
 174           if (*q == 'B') {
 175             show_string(e.bt_strings[2] + 8);
 176           } else {
 177             for (i = 2; i < e.used; i++)
 178               if (precision == -1) {
 179                 p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer),
 180                               "%s\n", e.bt_strings[i] + 8);
 181                 check_overflow;
 182               } else {
 183                 p += sprintf(p, "%.*s\n",
 184                              (int) MIN(XBT_LOG_BUFF_SIZE -
 185                                        (p - ev->buffer), precision),
 186                              e.bt_strings[i] + 8);
 187                 check_overflow;
 188                 precision = -1;
 189               }
 190           }
 191
 192           xbt_ex_free(e);
 193         }
 194 #else
 195         p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer),
 196                       "(no backtrace on this arch)");
 197         check_overflow;
 198 #endif
 199         break;
 200
 201       case 'd':                /* date; LOG4J compliant */
 202         show_double(gras_os_time());
 203         break;
 204       case 'r':                /* application age; LOG4J compliant */
 205         show_double(gras_os_time() - format_begin_of_time);
 206         break;
 207
 208       case 'm':                /* user-provided message; LOG4J compliant */
 209         if (precision == -1) {
 210           p += vsnprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), msg_fmt,
 211                          ev->ap);
 212           check_overflow;
 213         } else {
 214           p += vsnprintf(p,
 215                          (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
 216                                    precision), msg_fmt, ev->ap);
 217           check_overflow;
 218           precision = -1;
 219         }
 220         break;
 221
 222       default:
 223         fprintf(stderr, ERRMSG, *q, (char *) l->data);
 224         abort();
 225       }
 226       q++;
 227     } else {
 228       *(p++) = *(q++);
 229       check_overflow;
 230     }
 231   }
 232   *p = '\0';
 233
 234   return 1;
 235 }
 236
 237 static void xbt_log_layout_format_free(xbt_log_layout_t lay)
 238 {
 239   free(lay->data);
 240 }
 241
 242 xbt_log_layout_t xbt_log_layout_format_new(char *arg)
 243 {
 244   xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
 245   res->do_layout = xbt_log_layout_format_doit;
 246   res->free_ = xbt_log_layout_format_free;
 247   res->data = xbt_strdup((char *) arg);
 248
 249   if (format_begin_of_time < 0)
 250     format_begin_of_time = gras_os_time();
 251
 252   return res;
 253 }