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