3 /* layout_simple - a dumb log layout */
5 /* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved. */
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. */
10 #include "portable.h" /* execinfo when available */
11 #include "xbt/sysdep.h"
12 #include "xbt/strbuff.h"
13 #include "xbt/log_private.h"
14 #include "gras/virtu.h" /* gras_os_myname (KILLME) */
15 #include "xbt/synchro.h" /* xbt_thread_self_name */
18 extern const char *xbt_log_priority_names[7];
20 static double begin_of_time = -1;
22 #define append1(fmt,fmt2,elm) \
24 if (precision == -1) { \
25 xbt_strbuff_append(buff, tmp=bprintf(fmt,elm)); \
28 xbt_strbuff_append(buff, tmp=bprintf(fmt2,precision,elm)); \
33 #define append2(fmt,elm,elm2) \
35 xbt_strbuff_append(buff, tmp=bprintf(fmt,elm,elm2)); \
40 #define ERRMSG "Unknown %%%c sequence in layout format (%s).\nKnown sequences:\n" \
41 " what: %%m: user message %%c: log category %%p: log priority\n" \
43 " source: %%F: file %%L: line %%M: function %%l: location (%%F:%%L)\n" \
44 " runtime: %%h: hostname %%t: thread %%P: process %%i: PID\n" \
45 " backtrace: %%b: full %%B: short\n" \
46 " when: %%d: date %%r: app. age\n" \
47 " other: %%%%: %% %%n: new line %%e: plain space\n"
50 static void xbt_log_layout_format_dynamic(xbt_log_layout_t l,
53 xbt_log_appender_t app)
55 xbt_strbuff_t buff = xbt_strbuff_new();
60 int vres; /* shut gcc up, but ignored */
68 fprintf(stderr, "Layout format (%s) ending with %%\n",
72 xbt_strbuff_append(buff, "%");
74 case 'n': /* platform-dependant line separator (LOG4J compliant) */
75 xbt_strbuff_append(buff, "\n");
77 case 'e': /* plain space (SimGrid extension) */
78 xbt_strbuff_append(buff, " ");
81 case '.': /* precision specifyier */
83 q += sscanf(q, "%d", &precision);
86 case 'c': /* category name; LOG4J compliant
87 should accept a precision postfix to show the hierarchy */
88 append1("%s", "%.*s", ev->cat->name);
90 case 'p': /* priority name; LOG4J compliant */
91 append1("%s", "%.*s", xbt_log_priority_names[ev->priority]);
94 case 'h': /* host name; SimGrid extension */
95 append1("%s", "%.*s", gras_os_myname());
97 case 't': /* thread name; LOG4J compliant */
98 append1("%s", "%.*s", xbt_thread_self_name());
100 case 'P': /* process name; SimGrid extension */
101 append1("%s", "%.*s", xbt_procname());
103 case 'i': /* process PID name; SimGrid extension */
104 append1("%d", "%.*d", (*xbt_getpid) ());
107 case 'F': /* file name; LOG4J compliant */
108 append1("%s", "%.*s", ev->fileName);
110 case 'l': /* location; LOG4J compliant */
111 append2("%s:%d", ev->fileName, ev->lineNum);
112 precision = -1; /* Ignored */
114 case 'L': /* line number; LOG4J compliant */
115 append1("%d", "%.*d", ev->lineNum);
117 case 'M': /* method (ie, function) name; LOG4J compliant */
118 append1("%s", "%.*s", ev->functionName);
120 case 'b': /* backtrace; called %throwable in LOG4J */
121 case 'B': /* short backtrace; called %throwable{short} in LOG4J */
122 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
127 e.used = backtrace((void **) e.bt, XBT_BACKTRACE_SIZE);
131 xbt_backtrace_current(&e);
133 append1("%s", "%.*s", e.bt_strings[2] + 8);
135 for (i = 2; i < e.used; i++)
136 append1("%s\n", "%.*s\n", e.bt_strings[i] + 8);
142 append1("%s", "%.*s", "(no backtrace on this arch)");
146 case 'd': /* date; LOG4J compliant */
147 append1("%f", "%.*f", gras_os_time());
149 case 'r': /* application age; LOG4J compliant */
150 append1("%f", "%.*f", gras_os_time() - begin_of_time);
153 case 'm': /* user-provided message; LOG4J compliant */
154 vres = vasprintf(&tmp2, fmt, ev->ap_copy);
155 append1("%s", "%.*s", tmp2);
160 fprintf(stderr, ERRMSG, *q, (char *) l->data);
168 xbt_strbuff_append(buff, tmp2);
171 app->do_append(app, buff->data);
172 xbt_strbuff_free(buff);
175 #define check_overflow \
176 if (p-ev->buffer > XBT_LOG_BUFF_SIZE) { /* buffer overflow */ \
177 xbt_log_layout_format_dynamic(l,ev,msg_fmt,app); \
180 static void xbt_log_layout_format_doit(xbt_log_layout_t l,
183 xbt_log_appender_t app)
188 if (begin_of_time < 0)
189 begin_of_time = gras_os_time();
200 fprintf(stderr, "Layout format (%s) ending with %%\n",
206 case 'n': /* platform-dependant line separator (LOG4J compliant) */
207 p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "\n");
210 case 'e': /* plain space (SimGrid extension) */
211 p += snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), " ");
215 case '.': /* precision specifyier */
217 q += sscanf(q, "%d", &precision);
218 goto handle_modifier;
220 case 'c': /* category name; LOG4J compliant
221 should accept a precision postfix to show the hierarchy */
222 if (precision == -1) {
224 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
230 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
231 precision), ev->cat->name);
236 case 'p': /* priority name; LOG4J compliant */
237 if (precision == -1) {
239 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
240 xbt_log_priority_names[ev->priority]);
245 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
247 xbt_log_priority_names[ev->priority]);
253 case 'h': /* host name; SimGrid extension */
254 if (precision == -1) {
256 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
262 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
263 precision), gras_os_myname());
268 case 't': /* thread name; LOG4J compliant */
269 if (precision == -1) {
271 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
272 xbt_thread_self_name());
277 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
278 precision), xbt_thread_self_name());
283 case 'P': /* process name; SimGrid extension */
284 if (precision == -1) {
286 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
292 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
293 precision), xbt_procname());
298 case 'i': /* process PID name; SimGrid extension */
299 if (precision == -1) {
301 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%d",
307 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
308 precision), (*xbt_getpid) ());
314 case 'F': /* file name; LOG4J compliant */
315 if (precision == -1) {
317 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
323 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
324 precision), ev->fileName);
329 case 'l': /* location; LOG4J compliant */
330 if (precision == -1) {
332 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s:%d",
333 ev->fileName, ev->lineNum);
338 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
339 precision), "%s:%d", ev->fileName,
345 case 'L': /* line number; LOG4J compliant */
346 if (precision == -1) {
348 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%d",
354 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
355 precision), ev->lineNum);
360 case 'M': /* method (ie, function) name; LOG4J compliant */
361 if (precision == -1) {
363 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
369 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
370 precision), ev->functionName);
375 case 'b': /* backtrace; called %throwable in LOG4J */
376 case 'B': /* short backtrace; called %throwable{short} in LOG4J */
377 #if defined(HAVE_EXECINFO_H) && defined(HAVE_POPEN) && defined(ADDR2LINE)
382 e.used = backtrace((void **) e.bt, XBT_BACKTRACE_SIZE);
386 xbt_backtrace_current(&e);
388 if (precision == -1) {
390 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s",
391 e.bt_strings[2] + 8);
396 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
397 precision), e.bt_strings[2] + 8);
402 for (i = 2; i < e.used; i++)
403 if (precision == -1) {
405 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%s\n",
406 e.bt_strings[i] + 8);
411 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
412 precision), e.bt_strings[i] + 8);
422 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer),
423 "(no backtrace on this arch)");
428 case 'd': /* date; LOG4J compliant */
429 if (precision == -1) {
431 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%f",
437 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
438 precision), gras_os_time());
443 case 'r': /* application age; LOG4J compliant */
444 if (precision == -1) {
446 snprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), "%f",
447 gras_os_time() - begin_of_time);
452 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
453 precision), gras_os_time() - begin_of_time);
459 case 'm': /* user-provided message; LOG4J compliant */
460 if (precision == -1) {
462 vsnprintf(p, XBT_LOG_BUFF_SIZE - (p - ev->buffer), msg_fmt,
468 (int) MIN(XBT_LOG_BUFF_SIZE - (p - ev->buffer),
469 precision), msg_fmt, ev->ap);
476 fprintf(stderr, ERRMSG, *q, (char *) l->data);
486 app->do_append(app, ev->buffer);
489 static void xbt_log_layout_format_free(xbt_log_layout_t lay)
494 xbt_log_layout_t xbt_log_layout_format_new(char *arg)
496 xbt_log_layout_t res = xbt_new0(s_xbt_log_layout_t, 1);
497 res->do_layout = xbt_log_layout_format_doit;
498 res->free_ = xbt_log_layout_format_free;
499 res->data = xbt_strdup((char *) arg);