Logo AND Algorithmique Numérique Distribuée

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