src/xbt/xbt_log_layout_format.c

   1 /* $Id$ */
   2
   3 /* layout_simple - a dumb log layout                                        */
   4
   5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
   6
   7 /* This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the license (GNU LGPL) which comes with this package. */
   9
  10 #include "portable.h" /* execinfo when available */
  11 #include "xbt/sysdep.h"
  12 #include "xbt/log.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[7];
  18
  19 /* Get serious about checking buffer overflows during log construction */
  20 #define check_overflow \
  21   if (p-ev->buffer > XBT_LOG_BUFF_SIZE) { /* buffer overflow */ \
  22      p=ev->buffer + XBT_LOG_BUFF_SIZE - strlen(" >> OUTPUT TRUNCATED <<\n"); \
  23      p+=sprintf(p," >> OUTPUT TRUNCATED <<\n");  \
  24      return;\
  25   }
  26
  27 static void xbt_log_layout_format_doit(xbt_log_layout_t l,
  28                                        xbt_log_event_t ev,
  29                                        const char *msg_fmt) {
  30   static double begin_of_time = -1;
  31   char *p,*q;
  32   int precision=-1;
  33
  34   if (begin_of_time<0)
  35     begin_of_time=gras_os_time();
  36
  37   p = ev->buffer;
  38   q = l->data;
  39
  40   while (*q != '\0') {
  41     if (*q == '%') {
  42       q++;
  43        handle_modifier:
  44       switch (*q) {
  45       case '\0':
  46         fprintf(stderr,"Layout format (%s) ending with %%\n",(char*)l->data);
  47         abort();
  48       case '%':
  49         *p++ = '%';
  50         break;
  51       case 'n': /* platform-dependant line separator (LOG4J compliant) */
  52         p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"\n");
  53         check_overflow;
  54         break;
  55       case 'e': /* plain space (SimGrid extension) */
  56         p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer)," ");
  57         check_overflow;
  58         break;
  59
  60       case '.': /* precision specifyier */
  61         q++;
  62         q += sscanf(q,"%d",&precision);
  63         goto handle_modifier;
  64
  65       case 'c': /* category name; LOG4J compliant
  66                    should accept a precision postfix to show the hierarchy */
  67         if (precision == -1) {
  68            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"%s",ev->cat->name);
  69            check_overflow;
  70         } else {
  71            p += sprintf(p,"%.*s",(int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision),ev->cat->name);
  72            check_overflow;
  73            precision = -1;
  74         }
  75         break;
  76       case 'p': /* priority name; LOG4J compliant */
  77         if (precision == -1) {
  78            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%s", xbt_log_priority_names[ev->priority] );
  79            check_overflow;
  80         } else {
  81            p += sprintf(p, "%.*s", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), xbt_log_priority_names[ev->priority] );
  82            check_overflow;
  83            precision = -1;
  84         }
  85         break;
  86
  87       case 'h': /* host name; SimGrid extension */
  88         if (precision == -1) {
  89            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%s", gras_os_myname());
  90            check_overflow;
  91         } else {
  92            p += sprintf(p, "%.*s", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), gras_os_myname());
  93            check_overflow;
  94            precision = -1;
  95         }
  96         break;
  97       case 't': /* thread name; LOG4J compliant */
  98         if (precision == -1) {
  99            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%s", xbt_thread_self_name());
 100            check_overflow;
 101         } else {
 102            p += sprintf(p, "%.*s", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), xbt_thread_self_name());
 103            check_overflow;
 104            precision = -1;
 105         }
 106         break;
 107       case 'P': /* process name; SimGrid extension */
 108         if (precision == -1) {
 109            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%s", xbt_procname());
 110            check_overflow;
 111         } else {
 112            p += sprintf(p, "%.*s", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision),xbt_procname());
 113            check_overflow;
 114            precision = -1;
 115         }
 116         break;
 117       case 'i': /* process PID name; SimGrid extension */
 118         if (precision == -1) {
 119            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%d", (*xbt_getpid)());
 120            check_overflow;
 121         } else {
 122            p += sprintf(p, "%.*d", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), (*xbt_getpid)());
 123            check_overflow;
 124            precision = -1;
 125         }
 126         break;
 127
 128       case 'F': /* file name; LOG4J compliant */
 129         if (precision == -1) {
 130            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"%s",ev->fileName);
 131            check_overflow;
 132         } else {
 133            p += sprintf(p,"%.*s",(int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), ev->fileName);
 134            check_overflow;
 135            precision = -1;
 136         }
 137         break;
 138       case 'l': /* location; LOG4J compliant */
 139         if (precision == -1) {
 140            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%s:%d", ev->fileName, ev->lineNum);
 141            check_overflow;
 142         } else {
 143            p += snprintf(p, (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), "%s:%d", ev->fileName, ev->lineNum);
 144            check_overflow;
 145            precision = -1;
 146         }
 147         break;
 148       case 'L': /* line number; LOG4J compliant */
 149         if (precision == -1) {
 150            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%d", ev->lineNum);
 151            check_overflow;
 152         } else {
 153            p += sprintf(p, "%.*d", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), ev->lineNum);
 154            check_overflow;
 155            precision = -1;
 156         }
 157         break;
 158       case 'M': /* method (ie, function) name; LOG4J compliant */
 159         if (precision == -1) {
 160            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), "%s", ev->functionName);
 161            check_overflow;
 162         } else {
 163            p += sprintf(p, "%.*s", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), ev->functionName);
 164            check_overflow;
 165            precision = -1;
 166         }
 167         break;
 168       case 'b': /* backtrace; called %throwable in LOG4J */
 169       case 'B': /* short backtrace; called %throwable{short} in LOG4J */
 170 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
 171         {
 172           xbt_ex_t e;
 173           int i;
 174
 175           e.used     = backtrace((void**)e.bt,XBT_BACKTRACE_SIZE);
 176           e.bt_strings = NULL;
 177           e.msg=NULL;
 178           e.remote=0;
 179           xbt_backtrace_current(&e);
 180           if (*q=='B') {
 181              if (precision == -1) {
 182                p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"%s",e.bt_strings[2]+8);
 183                check_overflow;
 184              } else {
 185                 p += sprintf(p,"%.*s",(int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), e.bt_strings[2]+8);
 186                 check_overflow;
 187                 precision = -1;
 188              }
 189           } else {
 190             for (i=2; i<e.used; i++)
 191                if (precision == -1) {
 192                  p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"%s\n",e.bt_strings[i]+8);
 193                  check_overflow;
 194                } else {
 195                  p += sprintf(p,"%.*s\n",(int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision),e.bt_strings[i]+8);
 196                  check_overflow;
 197                  precision = -1;
 198              }
 199           }
 200
 201           xbt_ex_free(e);
 202         }
 203 #else
 204         p+=snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"(no backtrace on this arch)");
 205         check_overflow;
 206 #endif
 207         break;
 208
 209       case 'd': /* date; LOG4J compliant */
 210         if (precision == -1) {
 211            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"%f", gras_os_time());
 212            check_overflow;
 213         } else {
 214            p += sprintf(p,"%.*f", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), gras_os_time());
 215            check_overflow;
 216            precision = -1;
 217         }
 218         break;
 219       case 'r': /* application age; LOG4J compliant */
 220         if (precision == -1) {
 221            p += snprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer),"%f", gras_os_time()-begin_of_time);
 222            check_overflow;
 223         } else {
 224            p += sprintf(p,"%.*f", (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), gras_os_time()-begin_of_time);
 225            check_overflow;
 226            precision = -1;
 227         }
 228         break;
 229
 230       case 'm': /* user-provided message; LOG4J compliant */
 231         if (precision == -1) {
 232            p += vsnprintf(p,XBT_LOG_BUFF_SIZE-(p-ev->buffer), msg_fmt, ev->ap);
 233            check_overflow;
 234         } else {
 235            p += vsnprintf(p, (int)MIN(XBT_LOG_BUFF_SIZE-(p-ev->buffer),precision), msg_fmt, ev->ap);
 236            check_overflow;
 237            precision = -1;
 238         }
 239         break;
 240
 241       default:
 242         fprintf(stderr,"Unknown %%%c sequence in layout format (%s)\n",
 243                 *q,(char*)l->data);
 244         abort();
 245       }
 246       q++;
 247     } else {
 248       *(p++) = *(q++);
 249     }
 250   }
 251   *p = '\0';
 252 }
 253
 254 static void xbt_log_layout_format_free(xbt_log_layout_t lay) {
 255   free(lay->data);
 256 }
 257 xbt_log_layout_t xbt_log_layout_format_new(char *arg) {
 258   xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t,1);
 259   res->do_layout = xbt_log_layout_format_doit;
 260   res->free_     = xbt_log_layout_format_free;
 261   res->data = xbt_strdup((char*)arg);
 262   return res;
 263 }