Commit | Line | Data |
---|---|---|
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 | */ | |
44 | struct log_time { | |
45 | /* Format: 00:00:00.000000 plus NULL byte. */ | |
46 | char str[16]; | |
47 | }; | |
48 | extern DECLARE_URCU_TLS(struct log_time, error_log_time); | |
49 | ||
97e19046 DG |
50 | extern int lttng_opt_quiet; |
51 | extern int lttng_opt_verbose; | |
c7e35b03 | 52 | extern int lttng_opt_mi; |
fac6795d | 53 | |
ffe60014 | 54 | /* Error type. */ |
75dea654 DG |
55 | #define PRINT_ERR 0x1 |
56 | #define PRINT_WARN 0x2 | |
57 | #define PRINT_BUG 0x3 | |
58 | #define PRINT_MSG 0x4 | |
59 | #define PRINT_DBG 0x10 | |
60 | #define PRINT_DBG2 0x20 | |
61 | #define PRINT_DBG3 0x30 | |
fac6795d DG |
62 | |
63 | /* | |
75dea654 | 64 | * Macro for printing message depending on command line option and verbosity. |
c7e35b03 JR |
65 | * |
66 | * Machine interface: | |
67 | * We use lttng_opt_mi to suppress all normal msg to stdout. We don't | |
68 | * want any nested msg to show up when printing mi to stdout(if it's the case). | |
69 | * All warnings and errors should be printed to stderr as normal. | |
fac6795d | 70 | */ |
97e19046 DG |
71 | #define __lttng_print(type, fmt, args...) \ |
72 | do { \ | |
c7e35b03 JR |
73 | if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 && \ |
74 | type == PRINT_MSG) { \ | |
97e19046 | 75 | fprintf(stdout, fmt, ## args); \ |
c7e35b03 | 76 | } else if (lttng_opt_quiet == 0 && lttng_opt_mi == 0 && \ |
97e19046 DG |
77 | (((type & PRINT_DBG) && lttng_opt_verbose == 1) || \ |
78 | ((type & (PRINT_DBG | PRINT_DBG2)) && \ | |
79 | lttng_opt_verbose == 2) || \ | |
80 | ((type & (PRINT_DBG | PRINT_DBG2 | PRINT_DBG3)) && \ | |
81 | lttng_opt_verbose == 3))) { \ | |
82 | fprintf(stderr, fmt, ## args); \ | |
83 | } else if (lttng_opt_quiet == 0 && (type & (PRINT_WARN))) { \ | |
84 | fprintf(stderr, fmt, ## args); \ | |
85 | } else if (type & (PRINT_ERR | PRINT_BUG)) { \ | |
86 | fprintf(stderr, fmt, ## args); \ | |
87 | } \ | |
3ce7388b | 88 | } while (0); |
fac6795d | 89 | |
ffe60014 DG |
90 | /* Three level of debug. Use -v, -vv or -vvv for the levels */ |
91 | #define _ERRMSG(msg, type, fmt, args...) __lttng_print(type, msg \ | |
a0b439da DG |
92 | " - %s [%ld/%ld]: " fmt " (in %s() at " __FILE__ ":" XSTR(__LINE__) ")\n", \ |
93 | log_add_time(), (long) getpid(), (long) gettid(), ## args, __func__) | |
ffe60014 | 94 | |
75dea654 DG |
95 | #define MSG(fmt, args...) \ |
96 | __lttng_print(PRINT_MSG, fmt "\n", ## args) | |
f37d259d MD |
97 | #define _MSG(fmt, args...) \ |
98 | __lttng_print(PRINT_MSG, fmt, ## args) | |
75dea654 | 99 | #define ERR(fmt, args...) \ |
c66f2a27 | 100 | __lttng_print(PRINT_ERR, "Error: " fmt "\n", ## args) |
75dea654 | 101 | #define WARN(fmt, args...) \ |
c66f2a27 | 102 | __lttng_print(PRINT_ERR, "Warning: " fmt "\n", ## args) |
75dea654 | 103 | |
ffe60014 DG |
104 | #define BUG(fmt, args...) _ERRMSG("BUG", PRINT_BUG, fmt, ## args) |
105 | ||
106 | #define DBG(fmt, args...) _ERRMSG("DEBUG1", PRINT_DBG, fmt, ## args) | |
107 | #define DBG2(fmt, args...) _ERRMSG("DEBUG2", PRINT_DBG2, fmt, ## args) | |
108 | #define DBG3(fmt, args...) _ERRMSG("DEBUG3", PRINT_DBG3, fmt, ## args) | |
7d9ad880 JG |
109 | #define LOG(type, fmt, args...) \ |
110 | do { \ | |
111 | switch (type) { \ | |
112 | case PRINT_ERR: \ | |
113 | ERR(fmt, ## args); \ | |
114 | break; \ | |
115 | case PRINT_WARN: \ | |
116 | WARN(fmt, ## args); \ | |
117 | break; \ | |
118 | case PRINT_BUG: \ | |
119 | BUG(fmt, ## args); \ | |
120 | break; \ | |
121 | case PRINT_MSG: \ | |
122 | MSG(fmt, ## args); \ | |
123 | break; \ | |
124 | case PRINT_DBG: \ | |
125 | DBG(fmt, ## args); \ | |
126 | break; \ | |
127 | case PRINT_DBG2: \ | |
128 | DBG2(fmt, ## args); \ | |
129 | break; \ | |
130 | case PRINT_DBG3: \ | |
131 | DBG3(fmt, ## args); \ | |
132 | break; \ | |
133 | default: \ | |
134 | assert(0); \ | |
135 | } \ | |
136 | } while(0); | |
ffe60014 DG |
137 | |
138 | #define _PERROR(fmt, args...) _ERRMSG("PERROR", PRINT_ERR, fmt, ## args) | |
75dea654 | 139 | |
818d276f | 140 | #if !defined(__linux__) || ((_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) && !defined(_GNU_SOURCE)) |
97e19046 | 141 | |
818d276f MD |
142 | /* |
143 | * Version using XSI strerror_r. | |
144 | */ | |
145 | #define PERROR(call, args...) \ | |
146 | do { \ | |
147 | char buf[200]; \ | |
148 | strerror_r(errno, buf, sizeof(buf)); \ | |
149 | _PERROR(call ": %s", ## args, buf); \ | |
150 | } while(0); | |
151 | #else | |
152 | /* | |
153 | * Version using GNU strerror_r, for linux with appropriate defines. | |
154 | */ | |
75dea654 | 155 | #define PERROR(call, args...) \ |
818d276f | 156 | do { \ |
75dea654 DG |
157 | char *buf; \ |
158 | char tmp[200]; \ | |
159 | buf = strerror_r(errno, tmp, sizeof(tmp)); \ | |
160 | _PERROR(call ": %s", ## args, buf); \ | |
161 | } while(0); | |
818d276f | 162 | #endif |
fac6795d | 163 | |
f73fabfd DG |
164 | const char *error_get_str(int32_t code); |
165 | ||
a0b439da DG |
166 | /* |
167 | * Function that format the time and return the reference of log_time.str to | |
168 | * the caller. On error, an empty string is returned thus no time will be | |
169 | * printed in the log. | |
170 | */ | |
171 | const char *log_add_time(); | |
172 | ||
db758600 | 173 | #endif /* _ERROR_H */ |