Add UST event exist error code
[lttng-tools.git] / include / lttng-sessiond-comm.h
1 #ifndef _LTTNG_SESSIOND_COMM_H
2 #define _LTTNG_SESSIOND_COMM_H
3
4 /*
5 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
6 * Julien Desfossez <julien.desfossez@polymtl.ca>
7 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; only version 2
12 * of the License.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 */
23
24 /*
25 * This header is meant for liblttng and libust internal use ONLY.
26 * These declarations should NOT be considered stable API.
27 */
28
29 #include <limits.h>
30 #include <lttng/lttng.h>
31
32 #define LTTNG_RUNDIR "/var/run/lttng"
33
34 /* Default unix socket path */
35 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond"
36 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond"
37 #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-lttng-sessiond"
38 #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-lttng-sessiond"
39
40 /* Queue size of listen(2) */
41 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
42
43 /*
44 * Get the error code index from 0 since LTTCOMM_OK start at 1000
45 */
46 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
47
48 enum lttcomm_sessiond_command {
49 /* Tracer command */
50 LTTNG_ADD_CONTEXT,
51 LTTNG_CALIBRATE,
52 LTTNG_DISABLE_CHANNEL,
53 LTTNG_DISABLE_EVENT,
54 LTTNG_DISABLE_ALL_EVENT,
55 LTTNG_ENABLE_CHANNEL,
56 LTTNG_ENABLE_EVENT,
57 LTTNG_ENABLE_ALL_EVENT,
58 /* Session daemon command */
59 LTTNG_CREATE_SESSION,
60 LTTNG_DESTROY_SESSION,
61 LTTNG_LIST_CHANNELS,
62 LTTNG_LIST_DOMAINS,
63 LTTNG_LIST_EVENTS,
64 LTTNG_LIST_SESSIONS,
65 LTTNG_LIST_TRACEPOINTS,
66 LTTNG_REGISTER_CONSUMER,
67 LTTNG_START_TRACE,
68 LTTNG_STOP_TRACE,
69 };
70
71 /*
72 * lttcomm error code.
73 */
74 enum lttcomm_return_code {
75 LTTCOMM_OK = 1000, /* Ok */
76 LTTCOMM_ERR, /* Unknown Error */
77 LTTCOMM_UND, /* Undefine command */
78 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
79 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
80 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
81 LTTCOMM_NO_SESSION, /* No session found */
82 LTTCOMM_CREATE_FAIL, /* Create trace fail */
83 LTTCOMM_SESSION_FAIL, /* Create session fail */
84 LTTCOMM_START_FAIL, /* Start tracing fail */
85 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
86 LTTCOMM_LIST_FAIL, /* Listing apps fail */
87 LTTCOMM_NO_APPS, /* No traceable application */
88 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
89 LTTCOMM_NO_TRACE, /* No trace exist */
90 LTTCOMM_FATAL, /* Session daemon had a fatal error */
91 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
92 LTTCOMM_SELECT_SESS, /* Must select a session */
93 LTTCOMM_EXIST_SESS, /* Session name already exist */
94 LTTCOMM_NO_EVENT, /* No event found */
95 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
96 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
97 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
98 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
99 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
100 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
101 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
102 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
103 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
104 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
105 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
106 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
107 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
108 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
109 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
110 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
111 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
112 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
113 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
114 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
115 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
116 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
117 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
118 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
119 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
120 LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
121 LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
122 LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
123 LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
124 LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
125 LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
126 LTTCOMM_UST_START_FAIL, /* UST start trace failed */
127 LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
128 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
129 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
130 LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
131 LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
132 LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
133 LTTCOMM_UST_NO_SESSION, /* No UST session found */
134 LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
135 LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
136
137 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
138 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
139 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
140 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
141 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
142 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
143 CONSUMERD_POLL_HUP, /* All fds have hungup */
144 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
145 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
146 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
147 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
148 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
149 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
150 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
151 /* MUST be last element */
152 LTTCOMM_NR, /* Last element */
153 };
154
155 /*
156 * Data structure received from lttng client to session daemon.
157 */
158 struct lttcomm_session_msg {
159 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
160 struct lttng_session session;
161 struct lttng_domain domain;
162 union {
163 struct {
164 char channel_name[NAME_MAX];
165 char name[NAME_MAX];
166 } disable;
167 /* Event data */
168 struct {
169 char channel_name[NAME_MAX];
170 struct lttng_event event;
171 } enable;
172 /* Create channel */
173 struct {
174 struct lttng_channel chan;
175 } channel;
176 /* Context */
177 struct {
178 char channel_name[NAME_MAX];
179 char event_name[NAME_MAX];
180 struct lttng_event_context ctx;
181 } context;
182 /* Use by register_consumer */
183 struct {
184 char path[PATH_MAX];
185 } reg;
186 /* List */
187 struct {
188 char channel_name[NAME_MAX];
189 } list;
190 struct lttng_calibrate calibrate;
191 } u;
192 };
193
194 /*
195 * Data structure for the response from sessiond to the lttng client.
196 */
197 struct lttcomm_lttng_msg {
198 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
199 uint32_t ret_code; /* enum lttcomm_return_code */
200 uint32_t pid; /* pid_t */
201 uint32_t data_size;
202 /* Contains: trace_name + data */
203 char payload[];
204 };
205
206 /*
207 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
208 * to either add a channel, add a stream, update a stream, or stop
209 * operation.
210 */
211 struct lttcomm_consumer_msg {
212 uint32_t cmd_type; /* enum consumerd_command */
213 union {
214 struct {
215 int channel_key;
216 uint64_t max_sb_size; /* the subbuffer size for this channel */
217 /* shm_fd and wait_fd are sent as ancillary data */
218 uint64_t mmap_len;
219 } channel;
220 struct {
221 int channel_key;
222 int stream_key;
223 /* shm_fd and wait_fd are sent as ancillary data */
224 uint32_t state; /* enum lttcomm_consumer_fd_state */
225 enum lttng_event_output output; /* use splice or mmap to consume this fd */
226 uint64_t mmap_len;
227 char path_name[PATH_MAX];
228 } stream;
229 } u;
230 };
231
232 #ifdef HAVE_LIBLTTNG_UST_CTL
233
234 #include <lttng/ust-abi.h>
235
236 /*
237 * Data structure for the commands sent from sessiond to UST.
238 */
239 struct lttcomm_ust_msg {
240 uint32_t handle;
241 uint32_t cmd;
242 union {
243 struct lttng_ust_channel channel;
244 struct lttng_ust_stream stream;
245 struct lttng_ust_event event;
246 struct lttng_ust_context context;
247 struct lttng_ust_tracer_version version;
248 } u;
249 };
250
251 /*
252 * Data structure for the response from UST to the session daemon.
253 * cmd_type is sent back in the reply for validation.
254 */
255 struct lttcomm_ust_reply {
256 uint32_t handle;
257 uint32_t cmd;
258 uint32_t ret_code; /* enum lttcomm_return_code */
259 uint32_t ret_val; /* return value */
260 union {
261 struct {
262 uint64_t memory_map_size;
263 } channel;
264 struct {
265 uint64_t memory_map_size;
266 } stream;
267 struct lttng_ust_tracer_version version;
268 } u;
269 };
270
271 #endif /* HAVE_LIBLTTNG_UST_CTL */
272
273 extern int lttcomm_create_unix_sock(const char *pathname);
274 extern int lttcomm_connect_unix_sock(const char *pathname);
275 extern int lttcomm_accept_unix_sock(int sock);
276 extern int lttcomm_listen_unix_sock(int sock);
277 extern int lttcomm_close_unix_sock(int sock);
278
279 #define LTTCOMM_MAX_SEND_FDS 4
280 /* Send a message accompanied by fd(s) over a unix socket. */
281 extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
282 /* Recv a message accompanied by fd(s) from a unix socket */
283 extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
284
285 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
286 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
287 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
288
289 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.050054 seconds and 4 git commands to generate.