52369dc625d565a1e8c26d31520caecea48f5cd8
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 /*
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
23 */
24
25 #ifndef _LTTNG_SESSIOND_COMM_H
26 #define _LTTNG_SESSIOND_COMM_H
27
28 #define _GNU_SOURCE
29 #include <limits.h>
30 #include <lttng/lttng.h>
31 #include <common/compat/socket.h>
32
33 #include <arpa/inet.h>
34 #include <netinet/in.h>
35 #include <sys/un.h>
36
37 #include "inet.h"
38 #include "inet6.h"
39 #include "unix.h"
40
41 /* Queue size of listen(2) */
42 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
43
44 /* Maximum number of FDs that can be sent over a Unix socket */
45 #define LTTCOMM_MAX_SEND_FDS 4
46
47 /*
48 * Get the error code index from 0 since LTTCOMM_OK start at 1000
49 */
50 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
51
52 enum lttcomm_sessiond_command {
53 /* Tracer command */
54 LTTNG_ADD_CONTEXT,
55 LTTNG_CALIBRATE,
56 LTTNG_DISABLE_CHANNEL,
57 LTTNG_DISABLE_EVENT,
58 LTTNG_DISABLE_ALL_EVENT,
59 LTTNG_ENABLE_CHANNEL,
60 LTTNG_ENABLE_EVENT,
61 LTTNG_ENABLE_ALL_EVENT,
62 /* Session daemon command */
63 LTTNG_CREATE_SESSION,
64 LTTNG_DESTROY_SESSION,
65 LTTNG_LIST_CHANNELS,
66 LTTNG_LIST_DOMAINS,
67 LTTNG_LIST_EVENTS,
68 LTTNG_LIST_SESSIONS,
69 LTTNG_LIST_TRACEPOINTS,
70 LTTNG_REGISTER_CONSUMER,
71 LTTNG_START_TRACE,
72 LTTNG_STOP_TRACE,
73 LTTNG_LIST_TRACEPOINT_FIELDS,
74 };
75
76 /*
77 * lttcomm error code.
78 */
79 enum lttcomm_return_code {
80 LTTCOMM_OK = 10, /* Ok */
81 LTTCOMM_ERR, /* Unknown Error */
82 LTTCOMM_UND, /* Undefine command */
83 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
84 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
85 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
86 LTTCOMM_NO_SESSION, /* No session found */
87 LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */
88 LTTCOMM_SESSION_FAIL, /* Create session fail */
89 LTTCOMM_START_FAIL, /* Start tracing fail */
90 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
91 LTTCOMM_LIST_FAIL, /* Listing apps fail */
92 LTTCOMM_NO_APPS, /* No traceable application */
93 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
94 LTTCOMM_NO_TRACE, /* No trace exist */
95 LTTCOMM_FATAL, /* Session daemon had a fatal error */
96 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
97 LTTCOMM_SELECT_SESS, /* Must select a session */
98 LTTCOMM_EXIST_SESS, /* Session name already exist */
99 LTTCOMM_NO_EVENT, /* No event found */
100 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
101 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
102 LTTCOMM_EPERM, /* Permission denied */
103 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
104 LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */
105 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
106 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
107 LTTCOMM_KERN_CHAN_EXIST, /* Kernel channel already exists */
108 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
109 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
110 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
111 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
112 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
113 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
114 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
115 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
116 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
117 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
118 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
119 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
120 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
121 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
122 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
123 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
124 LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */
125 LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */
126 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
127 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
128 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
129 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
130 LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
131 LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
132 LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
133 LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
134 LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
135 LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
136 LTTCOMM_UST_START_FAIL, /* UST start trace failed */
137 LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
138 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
139 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
140 LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
141 LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
142 LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
143 LTTCOMM_UST_NO_SESSION, /* No UST session found */
144 LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
145 LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
146 LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
147 LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
148 LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */
149 LTTCOMM_NEED_ROOT_SESSIOND, /* root sessiond is needed */
150 LTTCOMM_TRACE_ALREADY_STARTED, /* Tracing already started */
151 LTTCOMM_TRACE_ALREADY_STOPPED, /* Tracing already stopped */
152 LTTCOMM_KERN_EVENT_ENOSYS, /* Kernel event type not supported */
153
154 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
155 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
156 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
157 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
158 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
159 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
160 CONSUMERD_POLL_HUP, /* All fds have hungup */
161 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
162 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
163 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
164 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
165 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
166 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
167 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
168 LTTCOMM_INVALID, /* Invalid parameter */
169 LTTCOMM_NO_USTCONSUMERD, /* No UST consumer detected */
170 LTTCOMM_NO_KERNCONSUMERD, /* No Kernel consumer detected */
171 LTTCOMM_EVENT_EXIST_LOGLEVEL, /* Event already enabled with different loglevel */
172
173 /* MUST be last element */
174 LTTCOMM_NR, /* Last element */
175 };
176
177 /*
178 * Data structure received from lttng client to session daemon.
179 */
180 struct lttcomm_session_msg {
181 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
182 struct lttng_session session;
183 struct lttng_domain domain;
184 union {
185 struct {
186 char channel_name[NAME_MAX];
187 char name[NAME_MAX];
188 } disable;
189 /* Event data */
190 struct {
191 char channel_name[NAME_MAX];
192 struct lttng_event event;
193 } enable;
194 /* Create channel */
195 struct {
196 struct lttng_channel chan;
197 } channel;
198 /* Context */
199 struct {
200 char channel_name[NAME_MAX];
201 char event_name[NAME_MAX];
202 struct lttng_event_context ctx;
203 } context;
204 /* Use by register_consumer */
205 struct {
206 char path[PATH_MAX];
207 } reg;
208 /* List */
209 struct {
210 char channel_name[NAME_MAX];
211 } list;
212 struct lttng_calibrate calibrate;
213 } u;
214 };
215
216 /*
217 * Data structure for the response from sessiond to the lttng client.
218 */
219 struct lttcomm_lttng_msg {
220 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
221 uint32_t ret_code; /* enum lttcomm_return_code */
222 uint32_t pid; /* pid_t */
223 uint32_t data_size;
224 /* Contains: trace_name + data */
225 char payload[];
226 };
227
228 /*
229 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
230 * to either add a channel, add a stream, update a stream, or stop
231 * operation.
232 */
233 struct lttcomm_consumer_msg {
234 uint32_t cmd_type; /* enum consumerd_command */
235 union {
236 struct {
237 int channel_key;
238 uint64_t max_sb_size; /* the subbuffer size for this channel */
239 /* shm_fd and wait_fd are sent as ancillary data */
240 uint64_t mmap_len;
241 } channel;
242 struct {
243 int channel_key;
244 int stream_key;
245 /* shm_fd and wait_fd are sent as ancillary data */
246 uint32_t state; /* enum lttcomm_consumer_fd_state */
247 enum lttng_event_output output; /* use splice or mmap to consume this fd */
248 uint64_t mmap_len;
249 uid_t uid; /* User ID owning the session */
250 gid_t gid; /* Group ID owning the session */
251 char path_name[PATH_MAX];
252 } stream;
253 } u;
254 };
255
256 #ifdef HAVE_LIBLTTNG_UST_CTL
257
258 #include <lttng/ust-abi.h>
259
260 /*
261 * Data structure for the commands sent from sessiond to UST.
262 */
263 struct lttcomm_ust_msg {
264 uint32_t handle;
265 uint32_t cmd;
266 union {
267 struct lttng_ust_channel channel;
268 struct lttng_ust_stream stream;
269 struct lttng_ust_event event;
270 struct lttng_ust_context context;
271 struct lttng_ust_tracer_version version;
272 } u;
273 };
274
275 /*
276 * Data structure for the response from UST to the session daemon.
277 * cmd_type is sent back in the reply for validation.
278 */
279 struct lttcomm_ust_reply {
280 uint32_t handle;
281 uint32_t cmd;
282 uint32_t ret_code; /* enum lttcomm_return_code */
283 uint32_t ret_val; /* return value */
284 union {
285 struct {
286 uint64_t memory_map_size;
287 } channel;
288 struct {
289 uint64_t memory_map_size;
290 } stream;
291 struct lttng_ust_tracer_version version;
292 } u;
293 };
294
295 #endif /* HAVE_LIBLTTNG_UST_CTL */
296
297 /* lttng socket protocol. */
298 enum lttcomm_sock_proto {
299 LTTCOMM_SOCK_UDP,
300 LTTCOMM_SOCK_TCP,
301 };
302
303 /*
304 * Index in the net_families array below. Please keep in sync!
305 */
306 enum lttcomm_sock_domain {
307 LTTCOMM_INET,
308 LTTCOMM_INET6,
309 };
310
311 struct lttcomm_sockaddr {
312 enum lttcomm_sock_domain type;
313 union {
314 struct sockaddr_in sin;
315 struct sockaddr_in6 sin6;
316 } addr;
317 };
318
319 struct lttcomm_sock {
320 int fd;
321 enum lttcomm_sock_proto proto;
322 struct lttcomm_sockaddr sockaddr;
323 const struct lttcomm_proto_ops *ops;
324 };
325
326 struct lttcomm_net_family {
327 int family;
328 int (*create) (struct lttcomm_sock *sock, int type, int proto);
329 };
330
331 struct lttcomm_proto_ops {
332 int (*bind) (struct lttcomm_sock *sock);
333 int (*close) (struct lttcomm_sock *sock);
334 int (*connect) (struct lttcomm_sock *sock);
335 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
336 int (*listen) (struct lttcomm_sock *sock, int backlog);
337 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
338 int flags);
339 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
340 int flags);
341 };
342
343 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
344
345 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
346 const char *ip, unsigned int port);
347 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
348 const char *ip, unsigned int port);
349
350 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_domain domain,
351 enum lttcomm_sock_proto proto);
352 extern int lttcomm_create_sock(struct lttcomm_sock *sock,
353 enum lttcomm_sock_domain domain, enum lttcomm_sock_proto proto);
354
355 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.054795 seconds and 3 git commands to generate.