Implement support for lttng-modules syscall filtering
[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 <lttng/snapshot-internal.h>
32 #include <lttng/save-internal.h>
33 #include <common/compat/socket.h>
34 #include <common/uri.h>
35 #include <common/defaults.h>
36 #include <common/compat/uuid.h>
37
38 #include <arpa/inet.h>
39 #include <netinet/in.h>
40 #include <sys/un.h>
41
42 #include "inet.h"
43 #include "inet6.h"
44 #include "unix.h"
45
46 /* Queue size of listen(2) */
47 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
48
49 /* Maximum number of FDs that can be sent over a Unix socket */
50 #define LTTCOMM_MAX_SEND_FDS 4
51
52 /*
53 * Get the error code index from 0 since LTTCOMM_OK start at 1000
54 */
55 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
56
57 enum lttcomm_sessiond_command {
58 /* Tracer command */
59 LTTNG_ADD_CONTEXT = 0,
60 LTTNG_CALIBRATE = 1,
61 LTTNG_DISABLE_CHANNEL = 2,
62 LTTNG_DISABLE_EVENT = 3,
63 LTTNG_DISABLE_ALL_EVENT = 4,
64 LTTNG_ENABLE_CHANNEL = 5,
65 LTTNG_ENABLE_EVENT = 6,
66 LTTNG_ENABLE_ALL_EVENT = 7,
67 /* Session daemon command */
68 LTTNG_CREATE_SESSION = 8,
69 LTTNG_DESTROY_SESSION = 9,
70 LTTNG_LIST_CHANNELS = 10,
71 LTTNG_LIST_DOMAINS = 11,
72 LTTNG_LIST_EVENTS = 12,
73 LTTNG_LIST_SESSIONS = 13,
74 LTTNG_LIST_TRACEPOINTS = 14,
75 LTTNG_REGISTER_CONSUMER = 15,
76 LTTNG_START_TRACE = 16,
77 LTTNG_STOP_TRACE = 17,
78 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
79
80 /* Consumer */
81 LTTNG_DISABLE_CONSUMER = 19,
82 LTTNG_ENABLE_CONSUMER = 20,
83 LTTNG_SET_CONSUMER_URI = 21,
84 /* 22 */
85 /* 23 */
86 LTTNG_DATA_PENDING = 24,
87 LTTNG_SNAPSHOT_ADD_OUTPUT = 25,
88 LTTNG_SNAPSHOT_DEL_OUTPUT = 26,
89 LTTNG_SNAPSHOT_LIST_OUTPUT = 27,
90 LTTNG_SNAPSHOT_RECORD = 28,
91 LTTNG_CREATE_SESSION_SNAPSHOT = 29,
92 LTTNG_CREATE_SESSION_LIVE = 30,
93 LTTNG_SAVE_SESSION = 31,
94 };
95
96 enum lttcomm_relayd_command {
97 RELAYD_ADD_STREAM = 1,
98 RELAYD_CREATE_SESSION = 2,
99 RELAYD_START_DATA = 3,
100 RELAYD_UPDATE_SYNC_INFO = 4,
101 RELAYD_VERSION = 5,
102 RELAYD_SEND_METADATA = 6,
103 RELAYD_CLOSE_STREAM = 7,
104 RELAYD_DATA_PENDING = 8,
105 RELAYD_QUIESCENT_CONTROL = 9,
106 RELAYD_BEGIN_DATA_PENDING = 10,
107 RELAYD_END_DATA_PENDING = 11,
108 RELAYD_ADD_INDEX = 12,
109 RELAYD_SEND_INDEX = 13,
110 RELAYD_CLOSE_INDEX = 14,
111 /* Live-reading commands (2.4+). */
112 RELAYD_LIST_SESSIONS = 15,
113 /* All streams of the channel have been sent to the relayd (2.4+). */
114 RELAYD_STREAMS_SENT = 16,
115 };
116
117 /*
118 * lttcomm error code.
119 */
120 enum lttcomm_return_code {
121 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
122 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
123 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
124 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
125 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
126 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
127 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
128 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
129 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
130 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
131 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
132 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
133 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
134 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
135 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
136 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
137 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
138 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
139 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
140 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
141 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
142
143 /* MUST be last element */
144 LTTCOMM_NR, /* Last element */
145 };
146
147 /* lttng socket protocol. */
148 enum lttcomm_sock_proto {
149 LTTCOMM_SOCK_UDP,
150 LTTCOMM_SOCK_TCP,
151 };
152
153 /*
154 * Index in the net_families array below. Please keep in sync!
155 */
156 enum lttcomm_sock_domain {
157 LTTCOMM_INET = 0,
158 LTTCOMM_INET6 = 1,
159 };
160
161 enum lttcomm_metadata_command {
162 LTTCOMM_METADATA_REQUEST = 1,
163 };
164
165 /*
166 * Commands sent from the consumerd to the sessiond to request if new metadata
167 * is available. This message is used to find the per UID _or_ per PID registry
168 * for the channel key. For per UID lookup, the triplet
169 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
170 * per PID registry indexed by session id ignoring the other values.
171 */
172 struct lttcomm_metadata_request_msg {
173 uint64_t session_id; /* Tracing session id */
174 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
175 uint32_t bits_per_long; /* Consumer ABI */
176 uint32_t uid;
177 uint64_t key; /* Metadata channel key. */
178 } LTTNG_PACKED;
179
180 struct lttcomm_sockaddr {
181 enum lttcomm_sock_domain type;
182 union {
183 struct sockaddr_in sin;
184 struct sockaddr_in6 sin6;
185 } addr;
186 } LTTNG_PACKED;
187
188 struct lttcomm_sock {
189 int32_t fd;
190 enum lttcomm_sock_proto proto;
191 struct lttcomm_sockaddr sockaddr;
192 const struct lttcomm_proto_ops *ops;
193 } LTTNG_PACKED;
194
195 /*
196 * Relayd sock. Adds the protocol version to use for the communications with
197 * the relayd.
198 */
199 struct lttcomm_relayd_sock {
200 struct lttcomm_sock sock;
201 uint32_t major;
202 uint32_t minor;
203 } LTTNG_PACKED;
204
205 struct lttcomm_net_family {
206 int family;
207 int (*create) (struct lttcomm_sock *sock, int type, int proto);
208 };
209
210 struct lttcomm_proto_ops {
211 int (*bind) (struct lttcomm_sock *sock);
212 int (*close) (struct lttcomm_sock *sock);
213 int (*connect) (struct lttcomm_sock *sock);
214 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
215 int (*listen) (struct lttcomm_sock *sock, int backlog);
216 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
217 int flags);
218 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
219 int flags);
220 };
221
222 /*
223 * Data structure received from lttng client to session daemon.
224 */
225 struct lttcomm_session_msg {
226 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
227 struct lttng_session session;
228 struct lttng_domain domain;
229 union {
230 /* Event data */
231 struct {
232 char channel_name[LTTNG_SYMBOL_NAME_LEN];
233 struct lttng_event event LTTNG_PACKED;
234 /* Length of following filter expression. */
235 uint32_t expression_len;
236 /* Length of following bytecode for filter. */
237 uint32_t bytecode_len;
238 /* exclusion data */
239 uint32_t exclusion_count;
240 /*
241 * After this structure, the following variable-length
242 * items are transmitted:
243 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
244 * - unsigned char filter_expression[expression_len]
245 * - unsigned char filter_bytecode[bytecode_len]
246 */
247 } LTTNG_PACKED enable;
248 struct {
249 char channel_name[LTTNG_SYMBOL_NAME_LEN];
250 struct lttng_event event LTTNG_PACKED;
251 /* Length of following filter expression. */
252 uint32_t expression_len;
253 /* Length of following bytecode for filter. */
254 uint32_t bytecode_len;
255 /*
256 * After this structure, the following variable-length
257 * items are transmitted:
258 * - unsigned char filter_expression[expression_len]
259 * - unsigned char filter_bytecode[bytecode_len]
260 */
261 } LTTNG_PACKED disable;
262 /* Create channel */
263 struct {
264 struct lttng_channel chan LTTNG_PACKED;
265 } LTTNG_PACKED channel;
266 /* Context */
267 struct {
268 char channel_name[LTTNG_SYMBOL_NAME_LEN];
269 struct lttng_event_context ctx LTTNG_PACKED;
270 } LTTNG_PACKED context;
271 /* Use by register_consumer */
272 struct {
273 char path[PATH_MAX];
274 } LTTNG_PACKED reg;
275 /* List */
276 struct {
277 char channel_name[LTTNG_SYMBOL_NAME_LEN];
278 } LTTNG_PACKED list;
279 struct lttng_calibrate calibrate;
280 /* Used by the set_consumer_url and used by create_session also call */
281 struct {
282 /* Number of lttng_uri following */
283 uint32_t size;
284 } LTTNG_PACKED uri;
285 struct {
286 struct lttng_snapshot_output output LTTNG_PACKED;
287 } LTTNG_PACKED snapshot_output;
288 struct {
289 uint32_t wait;
290 struct lttng_snapshot_output output LTTNG_PACKED;
291 } LTTNG_PACKED snapshot_record;
292 struct {
293 uint32_t nb_uri;
294 unsigned int timer_interval; /* usec */
295 } LTTNG_PACKED session_live;
296 struct {
297 struct lttng_save_session_attr attr; /* struct already packed */
298 } LTTNG_PACKED save_session;
299 } u;
300 } LTTNG_PACKED;
301
302 #define LTTNG_FILTER_MAX_LEN 65536
303
304 /*
305 * Filter bytecode data. The reloc table is located at the end of the
306 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
307 * starts at reloc_table_offset.
308 */
309 #define LTTNG_FILTER_PADDING 32
310 struct lttng_filter_bytecode {
311 uint32_t len; /* len of data */
312 uint32_t reloc_table_offset;
313 uint64_t seqnum;
314 char padding[LTTNG_FILTER_PADDING];
315 char data[0];
316 } LTTNG_PACKED;
317
318 /*
319 * Event exclusion data. At the end of the structure, there will actually
320 * by zero or more names, where the actual number of names is given by
321 * the 'count' item of the structure.
322 */
323 #define LTTNG_EVENT_EXCLUSION_PADDING 32
324 struct lttng_event_exclusion {
325 uint32_t count;
326 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
327 char names[LTTNG_SYMBOL_NAME_LEN][0];
328 } LTTNG_PACKED;
329
330 /*
331 * Data structure for the response from sessiond to the lttng client.
332 */
333 struct lttcomm_lttng_msg {
334 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
335 uint32_t ret_code; /* enum lttcomm_return_code */
336 uint32_t pid; /* pid_t */
337 uint32_t data_size;
338 /* Contains: trace_name + data */
339 char payload[];
340 } LTTNG_PACKED;
341
342 struct lttcomm_lttng_output_id {
343 uint32_t id;
344 } LTTNG_PACKED;
345
346 /*
347 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
348 * to either add a channel, add a stream, update a stream, or stop
349 * operation.
350 */
351 struct lttcomm_consumer_msg {
352 uint32_t cmd_type; /* enum consumerd_command */
353 union {
354 struct {
355 uint64_t channel_key;
356 uint64_t session_id;
357 char pathname[PATH_MAX];
358 uint32_t uid;
359 uint32_t gid;
360 uint64_t relayd_id;
361 /* nb_init_streams is the number of streams open initially. */
362 uint32_t nb_init_streams;
363 char name[LTTNG_SYMBOL_NAME_LEN];
364 /* Use splice or mmap to consume this fd */
365 enum lttng_event_output output;
366 int type; /* Per cpu or metadata. */
367 uint64_t tracefile_size; /* bytes */
368 uint32_t tracefile_count; /* number of tracefiles */
369 /* If the channel's streams have to be monitored or not. */
370 uint32_t monitor;
371 /* timer to check the streams usage in live mode (usec). */
372 unsigned int live_timer_interval;
373 } LTTNG_PACKED channel; /* Only used by Kernel. */
374 struct {
375 uint64_t stream_key;
376 uint64_t channel_key;
377 int32_t cpu; /* On which CPU this stream is assigned. */
378 /* Tells the consumer if the stream should be or not monitored. */
379 uint32_t no_monitor;
380 } LTTNG_PACKED stream; /* Only used by Kernel. */
381 struct {
382 uint64_t net_index;
383 enum lttng_stream_type type;
384 /* Open socket to the relayd */
385 struct lttcomm_relayd_sock sock;
386 /* Tracing session id associated to the relayd. */
387 uint64_t session_id;
388 /* Relayd session id, only used with control socket. */
389 uint64_t relayd_session_id;
390 } LTTNG_PACKED relayd_sock;
391 struct {
392 uint64_t net_seq_idx;
393 } LTTNG_PACKED destroy_relayd;
394 struct {
395 uint64_t session_id;
396 } LTTNG_PACKED data_pending;
397 struct {
398 uint64_t subbuf_size; /* bytes */
399 uint64_t num_subbuf; /* power of 2 */
400 int32_t overwrite; /* 1: overwrite, 0: discard */
401 uint32_t switch_timer_interval; /* usec */
402 uint32_t read_timer_interval; /* usec */
403 unsigned int live_timer_interval; /* usec */
404 int32_t output; /* splice, mmap */
405 int32_t type; /* metadata or per_cpu */
406 uint64_t session_id; /* Tracing session id */
407 char pathname[PATH_MAX]; /* Channel file path. */
408 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
409 uint32_t uid; /* User ID of the session */
410 uint32_t gid; /* Group ID ot the session */
411 uint64_t relayd_id; /* Relayd id if apply. */
412 uint64_t key; /* Unique channel key. */
413 unsigned char uuid[UUID_LEN]; /* uuid for ust tracer. */
414 uint32_t chan_id; /* Channel ID on the tracer side. */
415 uint64_t tracefile_size; /* bytes */
416 uint32_t tracefile_count; /* number of tracefiles */
417 uint64_t session_id_per_pid; /* Per-pid session ID. */
418 /* Tells the consumer if the stream should be or not monitored. */
419 uint32_t monitor;
420 /*
421 * For UST per UID buffers, this is the application UID of the
422 * channel. This can be different from the user UID requesting the
423 * channel creation and used for the rights on the stream file
424 * because the application can be in the tracing for instance.
425 */
426 uint32_t ust_app_uid;
427 } LTTNG_PACKED ask_channel;
428 struct {
429 uint64_t key;
430 } LTTNG_PACKED get_channel;
431 struct {
432 uint64_t key;
433 } LTTNG_PACKED destroy_channel;
434 struct {
435 uint64_t key; /* Metadata channel key. */
436 uint64_t target_offset; /* Offset in the consumer */
437 uint64_t len; /* Length of metadata to be received. */
438 } LTTNG_PACKED push_metadata;
439 struct {
440 uint64_t key; /* Metadata channel key. */
441 } LTTNG_PACKED close_metadata;
442 struct {
443 uint64_t key; /* Metadata channel key. */
444 } LTTNG_PACKED setup_metadata;
445 struct {
446 uint64_t key; /* Channel key. */
447 } LTTNG_PACKED flush_channel;
448 struct {
449 char pathname[PATH_MAX];
450 /* Indicate if the snapshot goes on the relayd or locally. */
451 uint32_t use_relayd;
452 uint32_t metadata; /* This a metadata snapshot. */
453 uint64_t relayd_id; /* Relayd id if apply. */
454 uint64_t key;
455 uint64_t max_stream_size;
456 } LTTNG_PACKED snapshot_channel;
457 struct {
458 uint64_t channel_key;
459 uint64_t net_seq_idx;
460 } LTTNG_PACKED sent_streams;
461 } u;
462 } LTTNG_PACKED;
463
464 /*
465 * Status message returned to the sessiond after a received command.
466 */
467 struct lttcomm_consumer_status_msg {
468 enum lttcomm_return_code ret_code;
469 } LTTNG_PACKED;
470
471 struct lttcomm_consumer_status_channel {
472 enum lttcomm_return_code ret_code;
473 uint64_t key;
474 unsigned int stream_count;
475 } LTTNG_PACKED;
476
477 #ifdef HAVE_LIBLTTNG_UST_CTL
478
479 #include <lttng/ust-abi.h>
480
481 /*
482 * Data structure for the commands sent from sessiond to UST.
483 */
484 struct lttcomm_ust_msg {
485 uint32_t handle;
486 uint32_t cmd;
487 union {
488 struct lttng_ust_channel channel;
489 struct lttng_ust_stream stream;
490 struct lttng_ust_event event;
491 struct lttng_ust_context context;
492 struct lttng_ust_tracer_version version;
493 } u;
494 } LTTNG_PACKED;
495
496 /*
497 * Data structure for the response from UST to the session daemon.
498 * cmd_type is sent back in the reply for validation.
499 */
500 struct lttcomm_ust_reply {
501 uint32_t handle;
502 uint32_t cmd;
503 uint32_t ret_code; /* enum lttcomm_return_code */
504 uint32_t ret_val; /* return value */
505 union {
506 struct {
507 uint64_t memory_map_size;
508 } LTTNG_PACKED channel;
509 struct {
510 uint64_t memory_map_size;
511 } LTTNG_PACKED stream;
512 struct lttng_ust_tracer_version version;
513 } u;
514 } LTTNG_PACKED;
515
516 #endif /* HAVE_LIBLTTNG_UST_CTL */
517
518 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
519
520 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
521 const char *ip, unsigned int port);
522 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
523 const char *ip, unsigned int port);
524
525 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
526 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
527 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
528 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
529 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
530 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
531 struct lttcomm_sock *src);
532
533 /* Relayd socket object. */
534 extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
535 struct lttng_uri *uri, uint32_t major, uint32_t minor);
536
537 extern int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
538 extern int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
539
540 extern void lttcomm_init(void);
541 /* Get network timeout, in milliseconds */
542 extern unsigned long lttcomm_get_network_timeout(void);
543
544 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.040118 seconds and 5 git commands to generate.