Logo AND Algorithmique Numérique Distribuée

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