Commit | Line | Data |
---|---|---|
f73fabfd DG |
1 | /* |
2 | * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com> | |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify it | |
5 | * under the terms of the GNU General Public License, version 2 only, as | |
6 | * published by the Free Software Foundation. | |
7 | * | |
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. | |
12 | * | |
13 | * You should have received a copy of the GNU General Public License along with | |
14 | * this program; if not, write to the Free Software Foundation, Inc., 51 | |
15 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
16 | */ | |
17 | ||
6c1c0768 | 18 | #define _LGPL_SOURCE |
f73fabfd | 19 | #include <assert.h> |
a0b439da | 20 | #include <inttypes.h> |
9bbd8e06 MD |
21 | #include <stdlib.h> |
22 | #include <string.h> | |
f73fabfd DG |
23 | |
24 | #include <lttng/lttng-error.h> | |
90e535ef | 25 | #include <common/common.h> |
9bbd8e06 | 26 | #include <common/compat/getenv.h> |
f73fabfd DG |
27 | |
28 | #include "error.h" | |
29 | ||
30 | #define ERROR_INDEX(code) (code - LTTNG_OK) | |
31 | ||
9bbd8e06 MD |
32 | /* |
33 | * lttng_opt_abort_on_error: unset: -1, disabled: 0, enabled: 1. | |
34 | * Controlled by the LTTNG_ABORT_ON_ERROR environment variable. | |
35 | */ | |
36 | static int lttng_opt_abort_on_error = -1; | |
37 | ||
a0b439da DG |
38 | /* TLS variable that contains the time of one single log entry. */ |
39 | DEFINE_URCU_TLS(struct log_time, error_log_time); | |
40 | ||
b2035012 | 41 | LTTNG_HIDDEN |
a0b439da DG |
42 | const char *log_add_time(void) |
43 | { | |
44 | int ret; | |
45 | struct tm tm, *res; | |
46 | struct timespec tp; | |
47 | time_t now; | |
48 | ||
389fbf04 | 49 | ret = lttng_clock_gettime(CLOCK_REALTIME, &tp); |
a0b439da DG |
50 | if (ret < 0) { |
51 | goto error; | |
52 | } | |
53 | now = (time_t) tp.tv_sec; | |
54 | ||
55 | res = localtime_r(&now, &tm); | |
56 | if (!res) { | |
57 | goto error; | |
58 | } | |
59 | ||
60 | /* Format time in the TLS variable. */ | |
327115d8 | 61 | ret = snprintf(URCU_TLS(error_log_time).str, sizeof(URCU_TLS(error_log_time).str), |
870bdaf9 | 62 | "%02d:%02d:%02d.%09ld", |
a0b439da DG |
63 | tm.tm_hour, tm.tm_min, tm.tm_sec, tp.tv_nsec); |
64 | if (ret < 0) { | |
65 | goto error; | |
66 | } | |
67 | ||
f79e29fe | 68 | return URCU_TLS(error_log_time).str; |
a0b439da DG |
69 | |
70 | error: | |
71 | /* Return an empty string on error so logging is not affected. */ | |
72 | return ""; | |
73 | } | |
74 | ||
f73fabfd DG |
75 | /* |
76 | * Human readable error message. | |
77 | */ | |
78 | static const char *error_string_array[] = { | |
79 | /* LTTNG_OK code MUST be at the top for the ERROR_INDEX macro to work */ | |
80 | [ ERROR_INDEX(LTTNG_OK) ] = "Success", | |
81 | [ ERROR_INDEX(LTTNG_ERR_UNK) ] = "Unknown error", | |
82 | [ ERROR_INDEX(LTTNG_ERR_UND) ] = "Undefined command", | |
83 | [ ERROR_INDEX(LTTNG_ERR_UNKNOWN_DOMAIN) ] = "Unknown tracing domain", | |
84 | [ ERROR_INDEX(LTTNG_ERR_NO_SESSION) ] = "No session found", | |
85 | [ ERROR_INDEX(LTTNG_ERR_CREATE_DIR_FAIL) ] = "Create directory failed", | |
86 | [ ERROR_INDEX(LTTNG_ERR_SESSION_FAIL) ] = "Create session failed", | |
87 | [ ERROR_INDEX(LTTNG_ERR_SESS_NOT_FOUND) ] = "Session name not found", | |
88 | [ ERROR_INDEX(LTTNG_ERR_FATAL) ] = "Fatal error of the session daemon", | |
89 | [ ERROR_INDEX(LTTNG_ERR_SELECT_SESS) ] = "A session MUST be selected", | |
552c8777 | 90 | [ ERROR_INDEX(LTTNG_ERR_EXIST_SESS) ] = "Session name already exists", |
f73fabfd DG |
91 | [ ERROR_INDEX(LTTNG_ERR_NO_EVENT) ] = "Event not found", |
92 | [ ERROR_INDEX(LTTNG_ERR_CONNECT_FAIL) ] = "Unable to connect to Unix socket", | |
93 | [ ERROR_INDEX(LTTNG_ERR_EPERM) ] = "Permission denied", | |
94 | [ ERROR_INDEX(LTTNG_ERR_KERN_NA) ] = "Kernel tracer not available", | |
95 | [ ERROR_INDEX(LTTNG_ERR_KERN_VERSION) ] = "Kernel tracer version is not compatible", | |
96 | [ ERROR_INDEX(LTTNG_ERR_KERN_EVENT_EXIST) ] = "Kernel event already exists", | |
97 | [ ERROR_INDEX(LTTNG_ERR_KERN_SESS_FAIL) ] = "Kernel create session failed", | |
98 | [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_EXIST) ] = "Kernel channel already exists", | |
99 | [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_FAIL) ] = "Kernel create channel failed", | |
100 | [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_NOT_FOUND) ] = "Kernel channel not found", | |
101 | [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_DISABLE_FAIL) ] = "Disable kernel channel failed", | |
102 | [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_ENABLE_FAIL) ] = "Enable kernel channel failed", | |
103 | [ ERROR_INDEX(LTTNG_ERR_KERN_CONTEXT_FAIL) ] = "Add kernel context failed", | |
104 | [ ERROR_INDEX(LTTNG_ERR_KERN_ENABLE_FAIL) ] = "Enable kernel event failed", | |
105 | [ ERROR_INDEX(LTTNG_ERR_KERN_DISABLE_FAIL) ] = "Disable kernel event failed", | |
106 | [ ERROR_INDEX(LTTNG_ERR_KERN_META_FAIL) ] = "Opening metadata failed", | |
107 | [ ERROR_INDEX(LTTNG_ERR_KERN_START_FAIL) ] = "Starting kernel trace failed", | |
552c8777 | 108 | [ ERROR_INDEX(LTTNG_ERR_KERN_STOP_FAIL) ] = "Stopping kernel trace failed", |
f73fabfd DG |
109 | [ ERROR_INDEX(LTTNG_ERR_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed", |
110 | [ ERROR_INDEX(LTTNG_ERR_KERN_STREAM_FAIL) ] = "Kernel create stream failed", | |
111 | [ ERROR_INDEX(LTTNG_ERR_KERN_LIST_FAIL) ] = "Listing kernel events failed", | |
112 | [ ERROR_INDEX(LTTNG_ERR_UST_CALIBRATE_FAIL) ] = "UST calibration failed", | |
113 | [ ERROR_INDEX(LTTNG_ERR_UST_SESS_FAIL) ] = "UST create session failed", | |
114 | [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_FAIL) ] = "UST create channel failed", | |
115 | [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_EXIST) ] = "UST channel already exist", | |
116 | [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_NOT_FOUND) ] = "UST channel not found", | |
117 | [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_DISABLE_FAIL) ] = "Disable UST channel failed", | |
118 | [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_ENABLE_FAIL) ] = "Enable UST channel failed", | |
119 | [ ERROR_INDEX(LTTNG_ERR_UST_ENABLE_FAIL) ] = "Enable UST event failed", | |
120 | [ ERROR_INDEX(LTTNG_ERR_UST_DISABLE_FAIL) ] = "Disable UST event failed", | |
121 | [ ERROR_INDEX(LTTNG_ERR_UST_META_FAIL) ] = "Opening metadata failed", | |
122 | [ ERROR_INDEX(LTTNG_ERR_UST_START_FAIL) ] = "Starting UST trace failed", | |
552c8777 | 123 | [ ERROR_INDEX(LTTNG_ERR_UST_STOP_FAIL) ] = "Stopping UST trace failed", |
f73fabfd DG |
124 | [ ERROR_INDEX(LTTNG_ERR_UST_CONSUMER64_FAIL) ] = "64-bit UST consumer start failed", |
125 | [ ERROR_INDEX(LTTNG_ERR_UST_CONSUMER32_FAIL) ] = "32-bit UST consumer start failed", | |
126 | [ ERROR_INDEX(LTTNG_ERR_UST_STREAM_FAIL) ] = "UST create stream failed", | |
127 | [ ERROR_INDEX(LTTNG_ERR_UST_LIST_FAIL) ] = "Listing UST events failed", | |
128 | [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_EXIST) ] = "UST event already exist", | |
129 | [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_NOT_FOUND)] = "UST event not found", | |
130 | [ ERROR_INDEX(LTTNG_ERR_UST_CONTEXT_EXIST)] = "UST context already exist", | |
131 | [ ERROR_INDEX(LTTNG_ERR_UST_CONTEXT_INVAL)] = "UST invalid context", | |
1052de37 | 132 | [ ERROR_INDEX(LTTNG_ERR_NEED_ROOT_SESSIOND) ] = "Tracing the kernel requires a root lttng-sessiond daemon, as well as \"tracing\" group membership or root user ID for the lttng client.", |
b51ec5b4 | 133 | [ ERROR_INDEX(LTTNG_ERR_NO_UST) ] = "LTTng-UST tracer is not supported. Please rebuild lttng-tools with lttng-ust support enabled.", |
45d5d421 CB |
134 | [ ERROR_INDEX(LTTNG_ERR_TRACE_ALREADY_STARTED) ] = "Tracing has already been started once", |
135 | [ ERROR_INDEX(LTTNG_ERR_TRACE_ALREADY_STOPPED) ] = "Tracing has already been stopped", | |
f73fabfd | 136 | [ ERROR_INDEX(LTTNG_ERR_KERN_EVENT_ENOSYS) ] = "Kernel event type not supported", |
85076754 | 137 | [ ERROR_INDEX(LTTNG_ERR_NEED_CHANNEL_NAME) ] = "Non-default channel exists within session: channel name needs to be specified with '-c name'", |
f73fabfd DG |
138 | [ ERROR_INDEX(LTTNG_ERR_INVALID) ] = "Invalid parameter", |
139 | [ ERROR_INDEX(LTTNG_ERR_NO_USTCONSUMERD) ] = "No UST consumer detected", | |
140 | [ ERROR_INDEX(LTTNG_ERR_NO_KERNCONSUMERD) ] = "No kernel consumer detected", | |
141 | [ ERROR_INDEX(LTTNG_ERR_EVENT_EXIST_LOGLEVEL) ] = "Event already enabled with different loglevel", | |
142 | [ ERROR_INDEX(LTTNG_ERR_URL_DATA_MISS) ] = "Missing data path URL", | |
552c8777 | 143 | [ ERROR_INDEX(LTTNG_ERR_URL_CTRL_MISS) ] = "Missing control path URL", |
f73fabfd DG |
144 | [ ERROR_INDEX(LTTNG_ERR_ENABLE_CONSUMER_FAIL) ] = "Enabling consumer failed", |
145 | [ ERROR_INDEX(LTTNG_ERR_RELAYD_CONNECT_FAIL) ] = "Unable to connect to lttng-relayd", | |
146 | [ ERROR_INDEX(LTTNG_ERR_RELAYD_VERSION_FAIL) ] = "Relay daemon not compatible", | |
147 | [ ERROR_INDEX(LTTNG_ERR_FILTER_INVAL) ] = "Invalid filter bytecode", | |
148 | [ ERROR_INDEX(LTTNG_ERR_FILTER_NOMEM) ] = "Not enough memory for filter bytecode", | |
149 | [ ERROR_INDEX(LTTNG_ERR_FILTER_EXIST) ] = "Filter already exist", | |
150 | [ ERROR_INDEX(LTTNG_ERR_NO_CONSUMER) ] = "Consumer not found for tracing session", | |
2f70b271 | 151 | [ ERROR_INDEX(LTTNG_ERR_NO_SESSIOND) ] = "No session daemon is available", |
806e2684 | 152 | [ ERROR_INDEX(LTTNG_ERR_SESSION_STARTED) ] = "Session is running", |
a79d84dd | 153 | [ ERROR_INDEX(LTTNG_ERR_NOT_SUPPORTED) ] = "Operation not supported", |
5bcdda4f | 154 | [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_ENABLED) ] = "UST event already enabled", |
785d2d0d DG |
155 | [ ERROR_INDEX(LTTNG_ERR_SET_URL) ] = "Error setting URL", |
156 | [ ERROR_INDEX(LTTNG_ERR_URL_EXIST) ] = "URL already exists", | |
7972aab2 DG |
157 | [ ERROR_INDEX(LTTNG_ERR_BUFFER_NOT_SUPPORTED)] = "Buffer type not supported", |
158 | [ ERROR_INDEX(LTTNG_ERR_BUFFER_TYPE_MISMATCH)] = "Buffer type mismatch for session", | |
a74934ba | 159 | [ ERROR_INDEX(LTTNG_ERR_NOMEM)] = "Not enough memory", |
6dc3064a DG |
160 | [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST) ] = "Snapshot output already exists", |
161 | [ ERROR_INDEX(LTTNG_ERR_START_SESSION_ONCE) ] = "Session needs to be started once", | |
5c786ded | 162 | [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_FAIL) ] = "Snapshot record failed", |
b9dfb167 | 163 | [ ERROR_INDEX(LTTNG_ERR_CHAN_EXIST) ] = "Channel already exists", |
7badf927 | 164 | [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_NODATA) ] = "No data available in snapshot", |
cde3e505 | 165 | [ ERROR_INDEX(LTTNG_ERR_NO_CHANNEL) ] = "No channel found in the session", |
1c1c3634 | 166 | [ ERROR_INDEX(LTTNG_ERR_SESSION_INVALID_CHAR) ] = "Invalid character found in session name", |
f9b57ab2 | 167 | [ ERROR_INDEX(LTTNG_ERR_SAVE_FILE_EXIST) ] = "Session file already exists", |
b61eecd6 | 168 | [ ERROR_INDEX(LTTNG_ERR_SAVE_IO_FAIL) ] = "IO error while writing session configuration", |
a96bc65d DG |
169 | [ ERROR_INDEX(LTTNG_ERR_LOAD_INVALID_CONFIG) ] = "Invalid session configuration", |
170 | [ ERROR_INDEX(LTTNG_ERR_LOAD_IO_FAIL) ] = "IO error while reading a session configuration", | |
171 | [ ERROR_INDEX(LTTNG_ERR_LOAD_SESSION_NOENT) ] = "Session file not found", | |
68808f4e | 172 | [ ERROR_INDEX(LTTNG_ERR_MAX_SIZE_INVALID) ] = "Snapshot max size is invalid", |
c7e35b03 JR |
173 | [ ERROR_INDEX(LTTNG_ERR_MI_OUTPUT_TYPE) ] = "Invalid MI output format", |
174 | [ ERROR_INDEX(LTTNG_ERR_MI_IO_FAIL) ] = "IO error while writing MI output", | |
175 | [ ERROR_INDEX(LTTNG_ERR_MI_NOT_IMPLEMENTED) ] = "Mi feature not implemented", | |
930a2e99 | 176 | [ ERROR_INDEX(LTTNG_ERR_INVALID_EVENT_NAME) ] = "Invalid event name", |
1f345e94 | 177 | [ ERROR_INDEX(LTTNG_ERR_INVALID_CHANNEL_NAME) ] = "Invalid channel name", |
b93a4a13 MJ |
178 | [ ERROR_INDEX(LTTNG_ERR_PID_TRACKED) ] = "PID already tracked", |
179 | [ ERROR_INDEX(LTTNG_ERR_PID_NOT_TRACKED) ] = "PID not tracked", | |
141feb8c | 180 | [ ERROR_INDEX(LTTNG_ERR_INVALID_CHANNEL_DOMAIN) ] = "Invalid channel domain", |
83f4233d | 181 | [ ERROR_INDEX(LTTNG_ERR_OVERFLOW) ] = "Overflow occurred", |
93ec662e JD |
182 | [ ERROR_INDEX(LTTNG_ERR_SESSION_NOT_STARTED) ] = "Session not started", |
183 | [ ERROR_INDEX(LTTNG_ERR_LIVE_SESSION) ] = "Live sessions are not supported", | |
184 | [ ERROR_INDEX(LTTNG_ERR_PER_PID_SESSION) ] = "Per-PID tracing sessions are not supported", | |
1ae5e83e | 185 | [ ERROR_INDEX(LTTNG_ERR_KERN_CONTEXT_UNAVAILABLE) ] = "Context unavailable on this kernel", |
c2561365 JD |
186 | [ ERROR_INDEX(LTTNG_ERR_REGEN_STATEDUMP_FAIL) ] = "Failed to regenerate the state dump", |
187 | [ ERROR_INDEX(LTTNG_ERR_REGEN_STATEDUMP_NOMEM) ] = "Failed to regenerate the state dump, not enough memory", | |
903ef685 | 188 | [ ERROR_INDEX(LTTNG_ERR_NOT_SNAPSHOT_SESSION) ] = "Snapshot command can't be applied to a non-snapshot session", |
a58c490f JG |
189 | [ ERROR_INDEX(LTTNG_ERR_INVALID_TRIGGER) ] = "Invalid trigger", |
190 | [ ERROR_INDEX(LTTNG_ERR_TRIGGER_EXISTS) ] = "Trigger already registered", | |
191 | [ ERROR_INDEX(LTTNG_ERR_TRIGGER_NOT_FOUND) ] = "Trigger not found", | |
192 | [ ERROR_INDEX(LTTNG_ERR_COMMAND_CANCELLED) ] = "Command cancelled", | |
5c408ad8 JD |
193 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_PENDING) ] = "Rotation already pending for this session", |
194 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_NOT_AVAILABLE) ] = "Rotation feature not available for this session's creation mode", | |
259c2674 JD |
195 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_TIMER_SET) ] = "Automatic timer-based rotation schedule already set for this session", |
196 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_SIZE_SET) ] = "Automatic size-based rotation schedule already set for this session", | |
197 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_NO_TIMER_SET) ] = "No automatic timer-based rotation schedule set for this session", | |
198 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_NO_SIZE_SET) ] = "No automatic size-based rotation schedule set for this session", | |
5c408ad8 | 199 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP) ] = "Session was already rotated once since it became inactive", |
259c2674 | 200 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_WRONG_VERSION) ] = "Session rotation is not supported by this kernel tracer version", |
d68c9a04 | 201 | [ ERROR_INDEX(LTTNG_ERR_NO_SESSION_OUTPUT) ] = "Session has no output", |
504521ea | 202 | [ ERROR_INDEX(LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY) ] = "Rotation feature not available on the relay", |
f28f9e44 | 203 | [ ERROR_INDEX(LTTNG_ERR_AGENT_TRACING_DISABLED) ] = "Session daemon agent tracing is disabled", |
f73fabfd DG |
204 | |
205 | /* Last element */ | |
206 | [ ERROR_INDEX(LTTNG_ERR_NR) ] = "Unknown error code" | |
207 | }; | |
208 | ||
209 | /* | |
210 | * Return ptr to string representing a human readable error code from the | |
211 | * lttng_error_code enum. | |
212 | * | |
213 | * These code MUST be negative in other to treat that as an error value. | |
214 | */ | |
90e535ef | 215 | LTTNG_HIDDEN |
f73fabfd DG |
216 | const char *error_get_str(int32_t code) |
217 | { | |
218 | code = -code; | |
219 | ||
220 | if (code < LTTNG_OK || code > LTTNG_ERR_NR) { | |
221 | code = LTTNG_ERR_NR; | |
222 | } | |
223 | ||
224 | return error_string_array[ERROR_INDEX(code)]; | |
225 | } | |
9bbd8e06 MD |
226 | |
227 | LTTNG_HIDDEN | |
228 | void lttng_abort_on_error(void) | |
229 | { | |
230 | if (lttng_opt_abort_on_error < 0) { | |
231 | /* Use lttng_secure_getenv() to query its state. */ | |
232 | const char *value; | |
233 | ||
234 | value = lttng_secure_getenv("LTTNG_ABORT_ON_ERROR"); | |
235 | if (value && !strcmp(value, "1")) { | |
236 | lttng_opt_abort_on_error = 1; | |
237 | } else { | |
238 | lttng_opt_abort_on_error = 0; | |
239 | } | |
240 | } | |
241 | if (lttng_opt_abort_on_error > 0) { | |
242 | abort(); | |
243 | } | |
244 | } |