1 /* layout_simple - a dumb log layout */
3 /* Copyright (c) 2007-2016. The SimGrid Team. */
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. */
8 #include "src/internal_config.h" /* execinfo when available */
9 #include "xbt/sysdep.h"
10 #include "xbt/strbuff.h"
11 #include "src/xbt/log_private.h"
12 #include "simgrid/simix.h" /* SIMIX_host_self_get_name */
13 #include "surf/surf.h"
17 # include <execinfo.h> /* Function backtrace */
20 extern const char *xbt_log_priority_names[8];
22 static double format_begin_of_time = -1;
25 "Unknown %%%c sequence in layout format (%s).\n" \
26 "Known sequences:\n" \
27 " what: %%m: user message %%c: log category %%p: log priority\n" \
29 " source: %%F: file %%L: line %%M: function %%l: location (%%F:%%L)\n" \
30 " runtime: %%h: hostname %%t: thread %%P: process %%i: PID\n" \
31 " backtrace: %%b: full %%B: short\n" \
32 " when: %%d: date %%r: app. age\n" \
33 " other: %%%%: %% %%n: new line %%e: plain space\n"
35 #define check_overflow(len) \
36 if ((rem_size -= (len)) > 0) { \
41 #define set_sz_from_precision() \
44 if (precision != -1) { \
46 sz = precision + 1; /* +1 for the final '\0' */ \
51 #define show_it(data, letter) \
60 if (precision == -1) { \
61 len = snprintf(p, rem_size, "%*" letter, wd, data); \
63 len = snprintf(p, rem_size, "%*.*" letter, wd, precision, data); \
66 check_overflow(len); \
69 #define show_string(data) \
71 const char *show_string_data = (data); \
72 show_it(show_string_data ? show_string_data : "(null)", "s"); \
74 #define show_int(data) show_it(data, "d")
75 #define show_double(data) show_it(data, "f")
77 static int xbt_log_layout_format_doit(xbt_log_layout_t l, xbt_log_event_t ev, const char *msg_fmt)
80 int rem_size = ev->buffer_size;
85 for (q = l->data ; *q != '\0' ; q++) {
91 fprintf(stderr, "Layout format (%s) ending with %%\n", (char *)l->data);
97 case 'n': /* platform-dependant line separator; LOG4J compliant */
101 case 'e': /* plain space; SimGrid extension */
105 case '.': /* precision specifier */
106 precision = strtol(q + 1, &q, 10);
107 goto handle_modifier;
117 case '9': /* length modifier */
118 length = strtol(q, &q, 10);
119 goto handle_modifier;
120 case 'c': /* category name; LOG4J compliant
121 should accept a precision postfix to show the hierarchy */
122 show_string(ev->cat->name);
124 case 'p': /* priority name; LOG4J compliant */
125 show_string(xbt_log_priority_names[ev->priority]);
127 case 'h': /* host name; SimGrid extension */
128 show_string(SIMIX_host_self_get_name());
130 case 't': /* thread name; LOG4J compliant */
131 show_string(SIMIX_process_self_get_name());
133 case 'P': /* process name; SimGrid extension */
134 show_string(xbt_procname());
136 case 'i': /* process PID name; SimGrid extension */
137 show_int(xbt_getpid());
139 case 'F': /* file name; LOG4J compliant */
140 show_string(ev->fileName);
142 case 'l': { /* location; LOG4J compliant */
144 set_sz_from_precision();
145 len = snprintf(p, sz, "%s:%d", ev->fileName, ev->lineNum);
146 check_overflow(MIN(sz, len));
149 case 'L': /* line number; LOG4J compliant */
150 show_int(ev->lineNum);
152 case 'M': /* method (ie, function) name; LOG4J compliant */
153 show_string(ev->functionName);
155 case 'b': /* backtrace; called %throwable in LOG4J */
156 case 'B': /* short backtrace; called %throwable{short} in LOG4J */
158 #if 0 && HAVE_BACKTRACE && HAVE_EXECINFO_H && HAVE_POPEN && defined(ADDR2LINE)
162 e.used = backtrace((void **) e.bt, XBT_BACKTRACE_SIZE);
164 xbt_ex_setup_backtrace(&e);
166 show_string(e.bt_strings[1] + 8);
168 xbt_strbuff_t buff = xbt_strbuff_new();
170 xbt_strbuff_append(buff, e.bt_strings[1] + 8);
171 for (i = 2; i < e.used; i++) {
172 xbt_strbuff_append(buff, "\n");
173 xbt_strbuff_append(buff, e.bt_strings[i] + 8);
175 show_string(buff->data);
176 xbt_strbuff_free(buff);
180 show_string("(no backtrace on this arch)");
183 case 'd': /* date; LOG4J compliant */
184 show_double(surf_get_clock());
186 case 'r': /* application age; LOG4J compliant */
187 show_double(surf_get_clock() - format_begin_of_time);
189 case 'm': { /* user-provided message; LOG4J compliant */
191 set_sz_from_precision();
192 len = vsnprintf(p, sz, msg_fmt, ev->ap);
193 check_overflow(MIN(sz, len));
197 fprintf(stderr, ERRMSG, *q, (char *)l->data);
210 static void xbt_log_layout_format_free(xbt_log_layout_t lay)
215 xbt_log_layout_t xbt_log_layout_format_new(char *arg)
217 xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
218 res->do_layout = &xbt_log_layout_format_doit;
219 res->free_ = &xbt_log_layout_format_free;
220 res->data = xbt_strdup((char *) arg);
222 if (format_begin_of_time < 0)
223 format_begin_of_time = surf_get_clock();