Update ChangeLog with 2.4.2 and 2.5.0 release
[lttng-tools.git] / src / common / error.h
CommitLineData
826d496d
MD
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
fac6795d 3 *
d14d33bf
AM
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
7 *
db758600
DG
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
d14d33bf
AM
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
fac6795d
DG
16 */
17
db758600
DG
18#ifndef _ERROR_H
19#define _ERROR_H
fac6795d
DG
20
21#include <errno.h>
d738ac16 22#include <stdio.h>
f73fabfd 23#include <stdint.h>
d05ea5da 24#include <string.h>
a0b439da
DG
25#include <urcu/tls-compat.h>
26#include <time.h>
fac6795d 27
4c462e79
MD
28#ifndef _GNU_SOURCE
29#error "lttng-tools error.h needs _GNU_SOURCE"
30#endif
31
f73fabfd 32#include <lttng/lttng-error.h>
ffe60014 33#include <common/compat/tid.h>
f73fabfd 34
57d0d501
DG
35/* Stringify the expansion of a define */
36#define XSTR(d) STR(d)
37#define STR(s) #s
38
a0b439da
DG
39/*
40 * Contains the string of the log entry time. This is used as a thread local
41 * storage so we don't race between thread and also avoid memory allocation
42 * every time a log is fired.
43 */
44struct log_time {
45 /* Format: 00:00:00.000000 plus NULL byte. */
46 char str[16];
47};
48extern DECLARE_URCU_TLS(struct log_time, error_log_time);
49
97e19046
DG
50extern int lttng_opt_quiet;
51extern int lttng_opt_verbose;
fac6795d 52
ffe60014 53/* Error type. */
75dea654
DG
54#define PRINT_ERR 0x1
55#define PRINT_WARN 0x2
56#define PRINT_BUG 0x3
57#define PRINT_MSG 0x4
58#define PRINT_DBG 0x10
59#define PRINT_DBG2 0x20
60#define PRINT_DBG3 0x30
fac6795d
DG
61
62/*
75dea654 63 * Macro for printing message depending on command line option and verbosity.
fac6795d 64 */
97e19046
DG
65#define __lttng_print(type, fmt, args...) \
66 do { \
67 if (lttng_opt_quiet == 0 && type == PRINT_MSG) { \
68 fprintf(stdout, fmt, ## args); \
69 } else if (lttng_opt_quiet == 0 && \
70 (((type & PRINT_DBG) && lttng_opt_verbose == 1) || \
71 ((type & (PRINT_DBG | PRINT_DBG2)) && \
72 lttng_opt_verbose == 2) || \
73 ((type & (PRINT_DBG | PRINT_DBG2 | PRINT_DBG3)) && \
74 lttng_opt_verbose == 3))) { \
75 fprintf(stderr, fmt, ## args); \
76 } else if (lttng_opt_quiet == 0 && (type & (PRINT_WARN))) { \
77 fprintf(stderr, fmt, ## args); \
78 } else if (type & (PRINT_ERR | PRINT_BUG)) { \
79 fprintf(stderr, fmt, ## args); \
80 } \
3ce7388b 81 } while (0);
fac6795d 82
ffe60014
DG
83/* Three level of debug. Use -v, -vv or -vvv for the levels */
84#define _ERRMSG(msg, type, fmt, args...) __lttng_print(type, msg \
a0b439da
DG
85 " - %s [%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", \
86 log_add_time(), (long) getpid(), (long) gettid(), ## args, __func__)
ffe60014 87
75dea654
DG
88#define MSG(fmt, args...) \
89 __lttng_print(PRINT_MSG, fmt "\n", ## args)
f37d259d
MD
90#define _MSG(fmt, args...) \
91 __lttng_print(PRINT_MSG, fmt, ## args)
75dea654 92#define ERR(fmt, args...) \
c66f2a27 93 __lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args)
75dea654 94#define WARN(fmt, args...) \
c66f2a27 95 __lttng_print(PRINT_ERR, "Warning: " fmt "\n", ## args)
75dea654 96
ffe60014
DG
97#define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args)
98
99#define DBG(fmt, args...) _ERRMSG("DEBUG1", PRINT_DBG, fmt, ## args)
100#define DBG2(fmt, args...) _ERRMSG("DEBUG2", PRINT_DBG2, fmt, ## args)
101#define DBG3(fmt, args...) _ERRMSG("DEBUG3", PRINT_DBG3, fmt, ## args)
102
103#define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args)
75dea654 104
818d276f 105#if !defined(__linux__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE))
97e19046 106
818d276f
MD
107/*
108 * Version using XSI strerror_r.
109 */
110#define PERROR(call, args...) \
111 do { \
112 char buf[200]; \
113 strerror_r(errno, buf, sizeof(buf)); \
114 _PERROR(call ": %s", ## args, buf); \
115 } while(0);
116#else
117/*
118 * Version using GNU strerror_r, for linux with appropriate defines.
119 */
75dea654 120#define PERROR(call, args...) \
818d276f 121 do { \
75dea654
DG
122 char *buf; \
123 char tmp[200]; \
124 buf = strerror_r(errno, tmp, sizeof(tmp)); \
125 _PERROR(call ": %s", ## args, buf); \
126 } while(0);
818d276f 127#endif
fac6795d 128
f73fabfd
DG
129const char *error_get_str(int32_t code);
130
a0b439da
DG
131/*
132 * Function that format the time and return the reference of log_time.str to
133 * the caller. On error, an empty string is returned thus no time will be
134 * printed in the log.
135 */
136const char *log_add_time();
137
db758600 138#endif /* _ERROR_H */
This page took 0.05878 seconds and 4 git commands to generate.