Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
5d03f6ff34f99c60d9ac3f8c254edc5d1e353d8f
[simgrid.git] / 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/ex_interface.h"
11 #include "xbt/sysdep.h"
12 #include "xbt/strbuff.h"
13 #include "xbt/log_private.h"
14 #include "xbt/synchro.h"        /* xbt_thread_self_name */
15 #include "simgrid/simix.h"      /* SIMIX_host_self_get_name */
16 #include "surf/surf.h"
17 #include <stdio.h>
18
19 extern const char *xbt_log_priority_names[8];
20
21 static double format_begin_of_time = -1;
22
23 #define ERRMSG                                                          \
24   "Unknown %%%c sequence in layout format (%s).\n"                      \
25   "Known sequences:\n"                                                  \
26   "  what:        %%m: user message  %%c: log category  %%p: log priority\n" \
27   "  where:\n"                                                          \
28   "    source:    %%F: file          %%L: line          %%M: function  %%l: location (%%F:%%L)\n" \
29   "    runtime:   %%h: hostname      %%t: thread        %%P: process   %%i: PID\n" \
30   "    backtrace: %%b: full          %%B: short\n"                      \
31   "  when:        %%d: date          %%r: app. age\n"                   \
32   "  other:       %%%%: %%             %%n: new line      %%e: plain space\n"
33
34 #define check_overflow(len)                                             \
35   if ((rem_size -= (len)) > 0) {                                        \
36     p += (len);                                                         \
37   } else                                                                \
38     return 0
39
40 #define set_sz_from_precision()                                         \
41   if (1) {                                                              \
42     sz = rem_size;                                                      \
43     if (precision != -1) {                                              \
44       if (precision < sz)                                               \
45         sz = precision + 1;     /* +1 for the final '\0' */             \
46       precision = -1;                                                   \
47     }                                                                   \
48   } else (void)0
49
50 #define show_it(data, letter)                                           \
51   if (1) {                                                              \
52     int len, wd;                                                        \
53     if (length == -1) {                                                 \
54       wd = 0;                                                           \
55     } else {                                                            \
56       wd = length;                                                      \
57       length = -1;                                                      \
58     }                                                                   \
59     if (precision == -1) {                                              \
60       len = snprintf(p, rem_size, "%*" letter, wd, data);               \
61     } else {                                                            \
62       len = snprintf(p, rem_size, "%*.*" letter, wd, precision, data);  \
63       precision = -1;                                                   \
64     }                                                                   \
65     check_overflow(len);                                                \
66   } else (void)0
67
68 #define show_string(data)                                               \
69   if (1) {                                                              \
70     const char *show_string_data = (data);                              \
71     show_it(show_string_data ? show_string_data : "(null)", "s");       \
72   } else (void)0
73 #define show_int(data)    show_it(data, "d")
74 #define show_double(data) show_it(data, "f")
75
76 static int xbt_log_layout_format_doit(xbt_log_layout_t l,
77                                       xbt_log_event_t ev,
78                                       const char *msg_fmt)
79 {
80   char *p = ev->buffer;
81   int rem_size = ev->buffer_size;
82   int precision = -1;
83   int length = -1;
84   char *q;
85
86   for (q = l->data ; *q != '\0' ; q++) {
87     if (*q == '%') {
88       q++;
89     handle_modifier:
90       switch (*q) {
91       case '\0':
92         fprintf(stderr, "Layout format (%s) ending with %%\n", (char *)l->data);
93         xbt_abort();
94       case '%':
95         *p = '%';
96         check_overflow(1);
97         break;
98       case 'n':         /* platform-dependant line separator; LOG4J compliant */
99         *p = '\n';
100         check_overflow(1);
101         break;
102       case 'e':                 /* plain space; SimGrid extension */
103         *p = ' ';
104         check_overflow(1);
105         break;
106       case '.':                 /* precision specifier */
107         precision = strtol(q + 1, &q, 10);
108         goto handle_modifier;
109       case '0':
110       case '1':
111       case '2':
112       case '3':
113       case '4':
114       case '5':
115       case '6':
116       case '7':
117       case '8':
118       case '9':                 /* length modifier */
119         length = strtol(q, &q, 10);
120         goto handle_modifier;
121       case 'c':                 /* category name; LOG4J compliant
122                                    should accept a precision postfix to show the
123                                    hierarchy */
124         show_string(ev->cat->name);
125         break;
126       case 'p':                 /* priority name; LOG4J compliant */
127         show_string(xbt_log_priority_names[ev->priority]);
128         break;
129       case 'h':                 /* host name; SimGrid extension */
130         show_string(SIMIX_host_self_get_name());
131         break;
132       case 't':                 /* thread name; LOG4J compliant */
133         show_string(xbt_thread_self_name());
134         break;
135       case 'P':                 /* process name; SimGrid extension */
136         show_string(xbt_procname());
137         break;
138       case 'i':                 /* process PID name; SimGrid extension */
139         show_int(xbt_getpid());
140         break;
141       case 'F':                 /* file name; LOG4J compliant */
142         show_string(ev->fileName);
143         break;
144       case 'l': {               /* location; LOG4J compliant */
145         int len, sz;
146         set_sz_from_precision();
147         len = snprintf(p, sz, "%s:%d", ev->fileName, ev->lineNum);
148         check_overflow(MIN(sz, len));
149         break;
150       }
151       case 'L':                 /* line number; LOG4J compliant */
152         show_int(ev->lineNum);
153         break;
154       case 'M':                /* method (ie, function) name; LOG4J compliant */
155         show_string(ev->functionName);
156         break;
157       case 'b':                 /* backtrace; called %throwable in LOG4J */
158       case 'B':         /* short backtrace; called %throwable{short} in LOG4J */
159 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
160         {
161           xbt_ex_t e;
162
163           e.used = backtrace((void **) e.bt, XBT_BACKTRACE_SIZE);
164           e.bt_strings = NULL;
165           e.msg = NULL;
166           e.remote = 0;
167           xbt_ex_setup_backtrace(&e);
168           if (*q == 'B') {
169             show_string(e.bt_strings[1] + 8);
170           } else {
171             xbt_strbuff_t buff = xbt_strbuff_new();
172             int i;
173             xbt_strbuff_append(buff, e.bt_strings[1] + 8);
174             for (i = 2; i < e.used; i++) {
175               xbt_strbuff_append(buff, "\n");
176               xbt_strbuff_append(buff, e.bt_strings[i] + 8);
177             }
178             show_string(buff->data);
179             xbt_strbuff_free(buff);
180           }
181           xbt_ex_free(e);
182         }
183 #else
184         show_string("(no backtrace on this arch)");
185 #endif
186         break;
187       case 'd':                 /* date; LOG4J compliant */
188         show_double(surf_get_clock());
189         break;
190       case 'r':                 /* application age; LOG4J compliant */
191         show_double(surf_get_clock() - format_begin_of_time);
192         break;
193       case 'm': {               /* user-provided message; LOG4J compliant */
194         int len, sz;
195         set_sz_from_precision();
196         len = vsnprintf(p, sz, msg_fmt, ev->ap);
197         check_overflow(MIN(sz, len));
198         break;
199       }
200       default:
201         fprintf(stderr, ERRMSG, *q, (char *)l->data);
202         xbt_abort();
203       }
204     } else {
205       *p = *q;
206       check_overflow(1);
207     }
208   }
209   *p = '\0';
210
211   return 1;
212 }
213
214 static void xbt_log_layout_format_free(xbt_log_layout_t lay)
215 {
216   free(lay->data);
217 }
218
219 xbt_log_layout_t xbt_log_layout_format_new(char *arg)
220 {
221   xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
222   res->do_layout = xbt_log_layout_format_doit;
223   res->free_ = xbt_log_layout_format_free;
224   res->data = xbt_strdup((char *) arg);
225
226   if (format_begin_of_time < 0)
227     format_begin_of_time = surf_get_clock();
228
229   return res;
230 }