2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
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.
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
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.
24 #include <lttng/lttng-error.h>
25 #include <common/common.h>
26 #include <common/compat/getenv.h>
30 #define ERROR_INDEX(code) (code - LTTNG_OK)
33 * lttng_opt_abort_on_error: unset: -1, disabled: 0, enabled: 1.
34 * Controlled by the LTTNG_ABORT_ON_ERROR environment variable.
36 static int lttng_opt_abort_on_error
= -1;
38 /* TLS variable that contains the time of one single log entry. */
39 DEFINE_URCU_TLS(struct log_time
, error_log_time
);
42 const char *log_add_time(void)
49 ret
= lttng_clock_gettime(CLOCK_REALTIME
, &tp
);
53 now
= (time_t) tp
.tv_sec
;
55 res
= localtime_r(&now
, &tm
);
60 /* Format time in the TLS variable. */
61 ret
= snprintf(URCU_TLS(error_log_time
).str
, sizeof(URCU_TLS(error_log_time
).str
),
62 "%02d:%02d:%02d.%06ld",
63 tm
.tm_hour
, tm
.tm_min
, tm
.tm_sec
, tp
.tv_nsec
);
68 return URCU_TLS(error_log_time
).str
;
71 /* Return an empty string on error so logging is not affected. */
76 * Human readable error message.
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",
90 [ ERROR_INDEX(LTTNG_ERR_EXIST_SESS
) ] = "Session name already exists",
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",
108 [ ERROR_INDEX(LTTNG_ERR_KERN_STOP_FAIL
) ] = "Stopping kernel trace failed",
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",
123 [ ERROR_INDEX(LTTNG_ERR_UST_STOP_FAIL
) ] = "Stopping UST trace failed",
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",
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.",
133 [ ERROR_INDEX(LTTNG_ERR_NO_UST
) ] = "LTTng-UST tracer is not supported. Please rebuild lttng-tools with lttng-ust support enabled.",
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",
136 [ ERROR_INDEX(LTTNG_ERR_KERN_EVENT_ENOSYS
) ] = "Kernel event type not supported",
137 [ ERROR_INDEX(LTTNG_ERR_NEED_CHANNEL_NAME
) ] = "Non-default channel exists within session: channel name needs to be specified with '-c name'",
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",
143 [ ERROR_INDEX(LTTNG_ERR_URL_CTRL_MISS
) ] = "Missing control path URL",
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",
151 [ ERROR_INDEX(LTTNG_ERR_NO_SESSIOND
) ] = "No session daemon is available",
152 [ ERROR_INDEX(LTTNG_ERR_SESSION_STARTED
) ] = "Session is running",
153 [ ERROR_INDEX(LTTNG_ERR_NOT_SUPPORTED
) ] = "Operation not supported",
154 [ ERROR_INDEX(LTTNG_ERR_UST_EVENT_ENABLED
) ] = "UST event already enabled",
155 [ ERROR_INDEX(LTTNG_ERR_SET_URL
) ] = "Error setting URL",
156 [ ERROR_INDEX(LTTNG_ERR_URL_EXIST
) ] = "URL already exists",
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",
159 [ ERROR_INDEX(LTTNG_ERR_NOMEM
)] = "Not enough memory",
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",
162 [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_FAIL
) ] = "Snapshot record failed",
163 [ ERROR_INDEX(LTTNG_ERR_CHAN_EXIST
) ] = "Channel already exists",
164 [ ERROR_INDEX(LTTNG_ERR_SNAPSHOT_NODATA
) ] = "No data available in snapshot",
165 [ ERROR_INDEX(LTTNG_ERR_NO_CHANNEL
) ] = "No channel found in the session",
166 [ ERROR_INDEX(LTTNG_ERR_SESSION_INVALID_CHAR
) ] = "Invalid character found in session name",
167 [ ERROR_INDEX(LTTNG_ERR_SAVE_FILE_EXIST
) ] = "Session file already exists",
168 [ ERROR_INDEX(LTTNG_ERR_SAVE_IO_FAIL
) ] = "IO error while writing session configuration",
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",
172 [ ERROR_INDEX(LTTNG_ERR_MAX_SIZE_INVALID
) ] = "Snapshot max size is invalid",
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",
176 [ ERROR_INDEX(LTTNG_ERR_INVALID_EVENT_NAME
) ] = "Invalid event name",
177 [ ERROR_INDEX(LTTNG_ERR_INVALID_CHANNEL_NAME
) ] = "Invalid channel name",
178 [ ERROR_INDEX(LTTNG_ERR_PID_TRACKED
) ] = "PID already tracked",
179 [ ERROR_INDEX(LTTNG_ERR_PID_NOT_TRACKED
) ] = "PID not tracked",
180 [ ERROR_INDEX(LTTNG_ERR_INVALID_CHANNEL_DOMAIN
) ] = "Invalid channel domain",
181 [ ERROR_INDEX(LTTNG_ERR_OVERFLOW
) ] = "Overflow occurred",
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",
185 [ ERROR_INDEX(LTTNG_ERR_KERN_CONTEXT_UNAVAILABLE
) ] = "Context unavailable on this kernel",
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",
188 [ ERROR_INDEX(LTTNG_ERR_NOT_SNAPSHOT_SESSION
) ] = "Snapshot command can't be applied to a non-snapshot session",
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",
195 [ ERROR_INDEX(LTTNG_ERR_NR
) ] = "Unknown error code"
199 * Return ptr to string representing a human readable error code from the
200 * lttng_error_code enum.
202 * These code MUST be negative in other to treat that as an error value.
205 const char *error_get_str(int32_t code
)
209 if (code
< LTTNG_OK
|| code
> LTTNG_ERR_NR
) {
213 return error_string_array
[ERROR_INDEX(code
)];
217 void lttng_abort_on_error(void)
219 if (lttng_opt_abort_on_error
< 0) {
220 /* Use lttng_secure_getenv() to query its state. */
223 value
= lttng_secure_getenv("LTTNG_ABORT_ON_ERROR");
224 if (value
&& !strcmp(value
, "1")) {
225 lttng_opt_abort_on_error
= 1;
227 lttng_opt_abort_on_error
= 0;
230 if (lttng_opt_abort_on_error
> 0) {