2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
15 #include <lttng/lttng-error.h>
16 #include <common/common.h>
17 #include <common/compat/getenv.h>
21 #define ERROR_INDEX(code) (code - LTTNG_OK)
24 * lttng_opt_abort_on_error: unset: -1, disabled: 0, enabled: 1.
25 * Controlled by the LTTNG_ABORT_ON_ERROR environment variable.
27 static int lttng_opt_abort_on_error
= -1;
29 /* TLS variable that contains the time of one single log entry. */
30 DEFINE_URCU_TLS(struct log_time
, error_log_time
);
33 const char *log_add_time(void)
39 const int errsv
= errno
;
41 ret
= lttng_clock_gettime(CLOCK_REALTIME
, &tp
);
45 now
= (time_t) tp
.tv_sec
;
47 res
= localtime_r(&now
, &tm
);
52 /* Format time in the TLS variable. */
53 ret
= snprintf(URCU_TLS(error_log_time
).str
, sizeof(URCU_TLS(error_log_time
).str
),
54 "%02d:%02d:%02d.%09ld",
55 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, tp
.tv_nsec
);
61 return URCU_TLS(error_log_time
).str
;
64 /* Return an empty string on error so logging is not affected. */
70 * Human readable error message.
72 static const char *error_string_array
[] = {
73 /* LTTNG_OK code MUST be at the top for the ERROR_INDEX macro to work */
74 [ ERROR_INDEX(LTTNG_OK
) ] = "Success",
75 [ ERROR_INDEX(LTTNG_ERR_UNK
) ] = "Unknown error",
76 [ ERROR_INDEX(LTTNG_ERR_UND
) ] = "Undefined command",
77 [ ERROR_INDEX(LTTNG_ERR_UNKNOWN_DOMAIN
) ] = "Unknown tracing domain",
78 [ ERROR_INDEX(LTTNG_ERR_NO_SESSION
) ] = "No session found",
79 [ ERROR_INDEX(LTTNG_ERR_CREATE_DIR_FAIL
) ] = "Create directory failed",
80 [ ERROR_INDEX(LTTNG_ERR_SESSION_FAIL
) ] = "Create session failed",
81 [ ERROR_INDEX(LTTNG_ERR_SESS_NOT_FOUND
) ] = "Session name not found",
82 [ ERROR_INDEX(LTTNG_ERR_FATAL
) ] = "Fatal error of the session daemon",
83 [ ERROR_INDEX(LTTNG_ERR_SELECT_SESS
) ] = "A session MUST be selected",
84 [ ERROR_INDEX(LTTNG_ERR_EXIST_SESS
) ] = "Session name already exists",
85 [ ERROR_INDEX(LTTNG_ERR_NO_EVENT
) ] = "Event not found",
86 [ ERROR_INDEX(LTTNG_ERR_CONNECT_FAIL
) ] = "Unable to connect to Unix socket",
87 [ ERROR_INDEX(LTTNG_ERR_EPERM
) ] = "Permission denied",
88 [ ERROR_INDEX(LTTNG_ERR_KERN_NA
) ] = "Kernel tracer not available",
89 [ ERROR_INDEX(LTTNG_ERR_KERN_VERSION
) ] = "Kernel tracer version is not compatible",
90 [ ERROR_INDEX(LTTNG_ERR_KERN_EVENT_EXIST
) ] = "Kernel event already exists",
91 [ ERROR_INDEX(LTTNG_ERR_KERN_SESS_FAIL
) ] = "Kernel create session failed",
92 [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_EXIST
) ] = "Kernel channel already exists",
93 [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_FAIL
) ] = "Kernel create channel failed",
94 [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_NOT_FOUND
) ] = "Kernel channel not found",
95 [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_DISABLE_FAIL
) ] = "Disable kernel channel failed",
96 [ ERROR_INDEX(LTTNG_ERR_KERN_CHAN_ENABLE_FAIL
) ] = "Enable kernel channel failed",
97 [ ERROR_INDEX(LTTNG_ERR_KERN_CONTEXT_FAIL
) ] = "Add kernel context failed",
98 [ ERROR_INDEX(LTTNG_ERR_KERN_ENABLE_FAIL
) ] = "Enable kernel event failed",
99 [ ERROR_INDEX(LTTNG_ERR_KERN_DISABLE_FAIL
) ] = "Disable kernel event failed",
100 [ ERROR_INDEX(LTTNG_ERR_KERN_META_FAIL
) ] = "Opening metadata failed",
101 [ ERROR_INDEX(LTTNG_ERR_KERN_START_FAIL
) ] = "Starting kernel trace failed",
102 [ ERROR_INDEX(LTTNG_ERR_KERN_STOP_FAIL
) ] = "Stopping kernel trace failed",
103 [ ERROR_INDEX(LTTNG_ERR_KERN_CONSUMER_FAIL
) ] = "Kernel consumer start failed",
104 [ ERROR_INDEX(LTTNG_ERR_KERN_STREAM_FAIL
) ] = "Kernel create stream failed",
105 [ ERROR_INDEX(LTTNG_ERR_KERN_LIST_FAIL
) ] = "Listing kernel events failed",
106 [ ERROR_INDEX(LTTNG_ERR_UST_CALIBRATE_FAIL
) ] = "UST calibration failed",
107 [ ERROR_INDEX(LTTNG_ERR_UST_SESS_FAIL
) ] = "UST create session failed",
108 [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_FAIL
) ] = "UST create channel failed",
109 [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_EXIST
) ] = "UST channel already exist",
110 [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_NOT_FOUND
) ] = "UST channel not found",
111 [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_DISABLE_FAIL
) ] = "Disable UST channel failed",
112 [ ERROR_INDEX(LTTNG_ERR_UST_CHAN_ENABLE_FAIL
) ] = "Enable UST channel failed",
113 [ ERROR_INDEX(LTTNG_ERR_UST_ENABLE_FAIL
) ] = "Enable UST event failed",
114 [ ERROR_INDEX(LTTNG_ERR_UST_DISABLE_FAIL
) ] = "Disable UST event failed",
115 [ ERROR_INDEX(LTTNG_ERR_UST_META_FAIL
) ] = "Opening metadata failed",
116 [ ERROR_INDEX(LTTNG_ERR_UST_START_FAIL
) ] = "Starting UST trace failed",
117 [ ERROR_INDEX(LTTNG_ERR_UST_STOP_FAIL
) ] = "Stopping UST trace failed",
118 [ ERROR_INDEX(LTTNG_ERR_UST_CONSUMER64_FAIL
) ] = "64-bit UST consumer start failed",
119 [ ERROR_INDEX(LTTNG_ERR_UST_CONSUMER32_FAIL
) ] = "32-bit UST consumer start failed",
120 [ ERROR_INDEX(LTTNG_ERR_UST_STREAM_FAIL
) ] = "UST create stream failed",
121 [ ERROR_INDEX(LTTNG_ERR_UST_LIST_FAIL
) ] = "Listing UST events failed",
122 [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_EXIST
) ] = "UST event already exist",
123 [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_NOT_FOUND
)] = "UST event not found",
124 [ ERROR_INDEX(LTTNG_ERR_UST_CONTEXT_EXIST
)] = "UST context already exist",
125 [ ERROR_INDEX(LTTNG_ERR_UST_CONTEXT_INVAL
)] = "UST invalid context",
126 [ 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.",
127 [ ERROR_INDEX(LTTNG_ERR_NO_UST
) ] = "LTTng-UST tracer is not supported. Please rebuild lttng-tools with lttng-ust support enabled.",
128 [ ERROR_INDEX(LTTNG_ERR_TRACE_ALREADY_STARTED
) ] = "Tracing has already been started once",
129 [ ERROR_INDEX(LTTNG_ERR_TRACE_ALREADY_STOPPED
) ] = "Tracing has already been stopped",
130 [ ERROR_INDEX(LTTNG_ERR_KERN_EVENT_ENOSYS
) ] = "Kernel event type not supported",
131 [ ERROR_INDEX(LTTNG_ERR_NEED_CHANNEL_NAME
) ] = "Non-default channel exists within session: channel name needs to be specified with '-c name'",
132 [ ERROR_INDEX(LTTNG_ERR_INVALID
) ] = "Invalid parameter",
133 [ ERROR_INDEX(LTTNG_ERR_NO_USTCONSUMERD
) ] = "No UST consumer detected",
134 [ ERROR_INDEX(LTTNG_ERR_NO_KERNCONSUMERD
) ] = "No kernel consumer detected",
135 [ ERROR_INDEX(LTTNG_ERR_EVENT_EXIST_LOGLEVEL
) ] = "Event already enabled with different loglevel",
136 [ ERROR_INDEX(LTTNG_ERR_URL_DATA_MISS
) ] = "Missing data path URL",
137 [ ERROR_INDEX(LTTNG_ERR_URL_CTRL_MISS
) ] = "Missing control path URL",
138 [ ERROR_INDEX(LTTNG_ERR_ENABLE_CONSUMER_FAIL
) ] = "Enabling consumer failed",
139 [ ERROR_INDEX(LTTNG_ERR_RELAYD_CONNECT_FAIL
) ] = "Unable to connect to lttng-relayd",
140 [ ERROR_INDEX(LTTNG_ERR_RELAYD_VERSION_FAIL
) ] = "Relay daemon not compatible",
141 [ ERROR_INDEX(LTTNG_ERR_FILTER_INVAL
) ] = "Invalid filter bytecode",
142 [ ERROR_INDEX(LTTNG_ERR_FILTER_NOMEM
) ] = "Not enough memory for filter bytecode",
143 [ ERROR_INDEX(LTTNG_ERR_FILTER_EXIST
) ] = "Filter already exist",
144 [ ERROR_INDEX(LTTNG_ERR_NO_CONSUMER
) ] = "Consumer not found for tracing session",
145 [ ERROR_INDEX(LTTNG_ERR_NO_SESSIOND
) ] = "No session daemon is available",
146 [ ERROR_INDEX(LTTNG_ERR_SESSION_STARTED
) ] = "Session is running",
147 [ ERROR_INDEX(LTTNG_ERR_NOT_SUPPORTED
) ] = "Operation not supported",
148 [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_ENABLED
) ] = "UST event already enabled",
149 [ ERROR_INDEX(LTTNG_ERR_SET_URL
) ] = "Error setting URL",
150 [ ERROR_INDEX(LTTNG_ERR_URL_EXIST
) ] = "URL already exists",
151 [ ERROR_INDEX(LTTNG_ERR_BUFFER_NOT_SUPPORTED
)] = "Buffer type not supported",
152 [ ERROR_INDEX(LTTNG_ERR_BUFFER_TYPE_MISMATCH
)] = "Buffer type mismatch for session",
153 [ ERROR_INDEX(LTTNG_ERR_NOMEM
)] = "Not enough memory",
154 [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
) ] = "Snapshot output already exists",
155 [ ERROR_INDEX(LTTNG_ERR_START_SESSION_ONCE
) ] = "Session needs to be started once",
156 [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_FAIL
) ] = "Snapshot record failed",
157 [ ERROR_INDEX(LTTNG_ERR_CHAN_EXIST
) ] = "Channel already exists",
158 [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_NODATA
) ] = "No data available in snapshot",
159 [ ERROR_INDEX(LTTNG_ERR_NO_CHANNEL
) ] = "No channel found in the session",
160 [ ERROR_INDEX(LTTNG_ERR_SESSION_INVALID_CHAR
) ] = "Invalid character found in session name",
161 [ ERROR_INDEX(LTTNG_ERR_SAVE_FILE_EXIST
) ] = "Session file already exists",
162 [ ERROR_INDEX(LTTNG_ERR_SAVE_IO_FAIL
) ] = "IO error while writing session configuration",
163 [ ERROR_INDEX(LTTNG_ERR_LOAD_INVALID_CONFIG
) ] = "Invalid session configuration",
164 [ ERROR_INDEX(LTTNG_ERR_LOAD_IO_FAIL
) ] = "IO error while reading a session configuration",
165 [ ERROR_INDEX(LTTNG_ERR_LOAD_SESSION_NOENT
) ] = "Session file not found",
166 [ ERROR_INDEX(LTTNG_ERR_MAX_SIZE_INVALID
) ] = "Snapshot max size is invalid",
167 [ ERROR_INDEX(LTTNG_ERR_MI_OUTPUT_TYPE
) ] = "Invalid MI output format",
168 [ ERROR_INDEX(LTTNG_ERR_MI_IO_FAIL
) ] = "IO error while writing MI output",
169 [ ERROR_INDEX(LTTNG_ERR_MI_NOT_IMPLEMENTED
) ] = "Mi feature not implemented",
170 [ ERROR_INDEX(LTTNG_ERR_INVALID_EVENT_NAME
) ] = "Invalid event name",
171 [ ERROR_INDEX(LTTNG_ERR_INVALID_CHANNEL_NAME
) ] = "Invalid channel name",
172 [ ERROR_INDEX(LTTNG_ERR_PROCESS_ATTR_EXISTS
) ] = "Process attribute is already tracked",
173 [ ERROR_INDEX(LTTNG_ERR_PROCESS_ATTR_MISSING
) ] = "Process attribute was not tracked",
174 [ ERROR_INDEX(LTTNG_ERR_INVALID_CHANNEL_DOMAIN
) ] = "Invalid channel domain",
175 [ ERROR_INDEX(LTTNG_ERR_OVERFLOW
) ] = "Overflow occurred",
176 [ ERROR_INDEX(LTTNG_ERR_SESSION_NOT_STARTED
) ] = "Session not started",
177 [ ERROR_INDEX(LTTNG_ERR_LIVE_SESSION
) ] = "Live sessions are not supported",
178 [ ERROR_INDEX(LTTNG_ERR_PER_PID_SESSION
) ] = "Per-PID tracing sessions are not supported",
179 [ ERROR_INDEX(LTTNG_ERR_KERN_CONTEXT_UNAVAILABLE
) ] = "Context unavailable on this kernel",
180 [ ERROR_INDEX(LTTNG_ERR_REGEN_STATEDUMP_FAIL
) ] = "Failed to regenerate the state dump",
181 [ ERROR_INDEX(LTTNG_ERR_REGEN_STATEDUMP_NOMEM
) ] = "Failed to regenerate the state dump, not enough memory",
182 [ ERROR_INDEX(LTTNG_ERR_NOT_SNAPSHOT_SESSION
) ] = "Snapshot command can't be applied to a non-snapshot session",
183 [ ERROR_INDEX(LTTNG_ERR_INVALID_TRIGGER
) ] = "Invalid trigger",
184 [ ERROR_INDEX(LTTNG_ERR_TRIGGER_EXISTS
) ] = "Trigger already registered",
185 [ ERROR_INDEX(LTTNG_ERR_TRIGGER_NOT_FOUND
) ] = "Trigger not found",
186 [ ERROR_INDEX(LTTNG_ERR_COMMAND_CANCELLED
) ] = "Command cancelled",
187 [ ERROR_INDEX(LTTNG_ERR_ROTATION_PENDING
) ] = "Rotation already pending for this session",
188 [ ERROR_INDEX(LTTNG_ERR_ROTATION_NOT_AVAILABLE
) ] = "Rotation feature not available for this session's creation mode",
189 [ ERROR_INDEX(LTTNG_ERR_ROTATION_SCHEDULE_SET
) ] = "A session rotation schedule of this type is already set on the session",
190 [ ERROR_INDEX(LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
) ] = "No session rotation schedule of this type is set on the session",
191 [ ERROR_INDEX(LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
) ] = "Session was already rotated once since it became inactive",
192 [ ERROR_INDEX(LTTNG_ERR_ROTATION_WRONG_VERSION
) ] = "Session rotation is not supported by this kernel tracer version",
193 [ ERROR_INDEX(LTTNG_ERR_NO_SESSION_OUTPUT
) ] = "Session has no output",
194 [ ERROR_INDEX(LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
) ] = "Rotation feature not available on the relay",
195 [ ERROR_INDEX(LTTNG_ERR_AGENT_TRACING_DISABLED
) ] = "Session daemon agent tracing is disabled",
196 [ ERROR_INDEX(LTTNG_ERR_PROBE_LOCATION_INVAL
) ] = "Invalid userspace probe location",
197 [ ERROR_INDEX(LTTNG_ERR_ELF_PARSING
) ] = "ELF parsing error",
198 [ ERROR_INDEX(LTTNG_ERR_SDT_PROBE_SEMAPHORE
) ] = "SDT probe guarded by a semaphore",
199 [ ERROR_INDEX(LTTNG_ERR_ROTATION_FAIL_CONSUMER
) ] = "Rotation failure on consumer",
200 [ ERROR_INDEX(LTTNG_ERR_ROTATE_RENAME_FAIL_CONSUMER
) ] = "Rotation rename failure on consumer",
201 [ ERROR_INDEX(LTTNG_ERR_ROTATION_PENDING_LOCAL_FAIL_CONSUMER
) ] = "Rotation pending check (local) failure on consumer",
202 [ ERROR_INDEX(LTTNG_ERR_ROTATION_PENDING_RELAY_FAIL_CONSUMER
) ] = "Rotation pending check (relay) failure on consumer",
203 [ ERROR_INDEX(LTTNG_ERR_MKDIR_FAIL_CONSUMER
) ] = "Directory creation failure on consumer",
204 [ ERROR_INDEX(LTTNG_ERR_CHAN_NOT_FOUND
) ] = "Channel not found",
205 [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_UNSUPPORTED
) ] = "Session configuration does not allow the use of snapshots",
206 [ ERROR_INDEX(LTTNG_ERR_SESSION_NOT_EXIST
) ] = "Tracing session does not exist",
207 [ ERROR_INDEX(LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
) ] = "Trace chunk creation failed on consumer",
208 [ ERROR_INDEX(LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
) ] = "Trace chunk close failed on consumer",
209 [ ERROR_INDEX(LTTNG_ERR_TRACE_CHUNK_EXISTS_FAIL_CONSUMER
) ] = "Failed to query consumer for trace chunk existence",
210 [ ERROR_INDEX(LTTNG_ERR_INVALID_PROTOCOL
) ] = "Protocol error occurred",
211 [ ERROR_INDEX(LTTNG_ERR_FILE_CREATION_ERROR
) ] = "Failed to create file",
212 [ ERROR_INDEX(LTTNG_ERR_TIMER_STOP_ERROR
) ] = "Failed to stop a timer",
213 [ ERROR_INDEX(LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) ] = "Rotation feature not supported by the kernel tracer.",
214 [ ERROR_INDEX(LTTNG_ERR_CLEAR_RELAY_DISALLOWED
) ] = "Relayd daemon peer does not allow sessions to be cleared",
215 [ ERROR_INDEX(LTTNG_ERR_CLEAR_NOT_AVAILABLE_RELAY
) ] = "Clearing a session is not supported by the relay daemon",
216 [ ERROR_INDEX(LTTNG_ERR_CLEAR_FAIL_CONSUMER
) ] = "Consumer failed to clear the session",
217 [ ERROR_INDEX(LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
) ] = "Session was already cleared since it became inactive",
218 [ ERROR_INDEX(LTTNG_ERR_USER_NOT_FOUND
) ] = "User not found",
219 [ ERROR_INDEX(LTTNG_ERR_GROUP_NOT_FOUND
) ] = "Group not found",
220 [ ERROR_INDEX(LTTNG_ERR_UNSUPPORTED_DOMAIN
) ] = "Unsupported domain used",
221 [ ERROR_INDEX(LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
) ] = "Operation does not apply to the process attribute tracker's tracking policy",
224 [ ERROR_INDEX(LTTNG_ERR_NR
) ] = "Unknown error code"
228 * Return ptr to string representing a human readable error code from the
229 * lttng_error_code enum.
231 * These code MUST be negative in other to treat that as an error value.
234 const char *error_get_str(int32_t code
)
238 if (code
< LTTNG_OK
|| code
> LTTNG_ERR_NR
) {
242 return error_string_array
[ERROR_INDEX(code
)];
246 void lttng_abort_on_error(void)
248 if (lttng_opt_abort_on_error
< 0) {
249 /* Use lttng_secure_getenv() to query its state. */
252 value
= lttng_secure_getenv("LTTNG_ABORT_ON_ERROR");
253 if (value
&& !strcmp(value
, "1")) {
254 lttng_opt_abort_on_error
= 1;
256 lttng_opt_abort_on_error
= 0;
259 if (lttng_opt_abort_on_error
> 0) {