Tests: add unix socket wrapper unit tests
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
1 /*
2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * SPDX-License-Identifier: GPL-2.0-only
7 *
8 */
9
10 /*
11 * This header is meant for liblttng and libust internal use ONLY. These
12 * declarations should NOT be considered stable API.
13 */
14
15 #ifndef _LTTNG_SESSIOND_COMM_H
16 #define _LTTNG_SESSIOND_COMM_H
17
18 #include <limits.h>
19 #include <lttng/lttng.h>
20 #include <lttng/snapshot-internal.h>
21 #include <lttng/save-internal.h>
22 #include <lttng/channel-internal.h>
23 #include <lttng/trigger/trigger-internal.h>
24 #include <lttng/rotate-internal.h>
25 #include <common/compat/socket.h>
26 #include <common/uri.h>
27 #include <common/defaults.h>
28 #include <common/uuid.h>
29 #include <common/macros.h>
30 #include <common/optional.h>
31
32 #include <arpa/inet.h>
33 #include <netinet/in.h>
34 #include <sys/un.h>
35
36 #include "inet.h"
37 #include "inet6.h"
38 #include <common/unix.h>
39
40 /* Queue size of listen(2) */
41 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
42
43 /* Maximum number of FDs that can be sent over a Unix socket */
44 #if defined(__linux__)
45 /* Based on the kernel's SCM_MAX_FD which is 253 since 2.6.38 (255 before) */
46 #define LTTCOMM_MAX_SEND_FDS 253
47 #else
48 #define LTTCOMM_MAX_SEND_FDS 16
49 #endif
50
51 /*
52 * Get the error code index from 0 since LTTCOMM_OK start at 1000
53 */
54 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
55
56 enum lttcomm_sessiond_command {
57 /* Tracer command */
58 LTTNG_ADD_CONTEXT = 0,
59 /* LTTNG_CALIBRATE used to be here */
60 LTTNG_DISABLE_CHANNEL = 2,
61 LTTNG_DISABLE_EVENT = 3,
62 LTTNG_LIST_SYSCALLS = 4,
63 LTTNG_ENABLE_CHANNEL = 5,
64 LTTNG_ENABLE_EVENT = 6,
65 /* 7 */
66 /* Session daemon command */
67 /* 8 */
68 LTTNG_DESTROY_SESSION = 9,
69 LTTNG_LIST_CHANNELS = 10,
70 LTTNG_LIST_DOMAINS = 11,
71 LTTNG_LIST_EVENTS = 12,
72 LTTNG_LIST_SESSIONS = 13,
73 LTTNG_LIST_TRACEPOINTS = 14,
74 LTTNG_REGISTER_CONSUMER = 15,
75 LTTNG_START_TRACE = 16,
76 LTTNG_STOP_TRACE = 17,
77 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
78
79 /* Consumer */
80 LTTNG_DISABLE_CONSUMER = 19,
81 LTTNG_ENABLE_CONSUMER = 20,
82 LTTNG_SET_CONSUMER_URI = 21,
83 /* 22 */
84 /* 23 */
85 LTTNG_DATA_PENDING = 24,
86 LTTNG_SNAPSHOT_ADD_OUTPUT = 25,
87 LTTNG_SNAPSHOT_DEL_OUTPUT = 26,
88 LTTNG_SNAPSHOT_LIST_OUTPUT = 27,
89 LTTNG_SNAPSHOT_RECORD = 28,
90 /* 29 */
91 /* 30 */
92 LTTNG_SAVE_SESSION = 31,
93 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE = 32,
94 LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE = 33,
95 LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY = 34,
96 LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY = 35,
97 LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET = 36,
98 LTTNG_SET_SESSION_SHM_PATH = 40,
99 LTTNG_REGENERATE_METADATA = 41,
100 LTTNG_REGENERATE_STATEDUMP = 42,
101 LTTNG_REGISTER_TRIGGER = 43,
102 LTTNG_UNREGISTER_TRIGGER = 44,
103 LTTNG_ROTATE_SESSION = 45,
104 LTTNG_ROTATION_GET_INFO = 46,
105 LTTNG_ROTATION_SET_SCHEDULE = 47,
106 LTTNG_SESSION_LIST_ROTATION_SCHEDULES = 48,
107 LTTNG_CREATE_SESSION_EXT = 49,
108 LTTNG_CLEAR_SESSION = 50,
109 };
110
111 enum lttcomm_relayd_command {
112 RELAYD_ADD_STREAM = 1,
113 RELAYD_CREATE_SESSION = 2,
114 RELAYD_START_DATA = 3,
115 RELAYD_UPDATE_SYNC_INFO = 4,
116 RELAYD_VERSION = 5,
117 RELAYD_SEND_METADATA = 6,
118 RELAYD_CLOSE_STREAM = 7,
119 RELAYD_DATA_PENDING = 8,
120 RELAYD_QUIESCENT_CONTROL = 9,
121 RELAYD_BEGIN_DATA_PENDING = 10,
122 RELAYD_END_DATA_PENDING = 11,
123 RELAYD_ADD_INDEX = 12,
124 RELAYD_SEND_INDEX = 13,
125 RELAYD_CLOSE_INDEX = 14,
126 /* Live-reading commands (2.4+). */
127 RELAYD_LIST_SESSIONS = 15,
128 /* All streams of the channel have been sent to the relayd (2.4+). */
129 RELAYD_STREAMS_SENT = 16,
130 /* Ask the relay to reset the metadata trace file (2.8+) */
131 RELAYD_RESET_METADATA = 17,
132 /* Ask the relay to rotate a set of stream files (2.11+) */
133 RELAYD_ROTATE_STREAMS = 18,
134 /* Ask the relay to create a trace chunk (2.11+) */
135 RELAYD_CREATE_TRACE_CHUNK = 19,
136 /* Ask the relay to close a trace chunk (2.11+) */
137 RELAYD_CLOSE_TRACE_CHUNK = 20,
138 /* Ask the relay whether a trace chunk exists (2.11+) */
139 RELAYD_TRACE_CHUNK_EXISTS = 21,
140 /* Get the current configuration of a relayd peer (2.12+) */
141 RELAYD_GET_CONFIGURATION = 22,
142
143 /* Feature branch specific commands start at 10000. */
144 };
145
146 /*
147 * lttcomm error code.
148 */
149 enum lttcomm_return_code {
150 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
151 /*
152 * Some code paths use -1 to express an error, others
153 * negate this consumer return code. Starting codes at
154 * 100 ensures there is no mix-up between this error value
155 * and legitimate status codes.
156 */
157 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
158 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
159 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
160 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
161 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
162 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
163 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
164 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
165 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
166 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
167 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
168 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
169 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
170 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
171 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
172 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
173 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
174 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
175 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
176 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
177 LTTCOMM_CONSUMERD_ALREADY_SET, /* Resource already set. */
178 LTTCOMM_CONSUMERD_ROTATION_FAIL, /* Rotation has failed. */
179 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED, /* snapshot has failed. */
180 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
181 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk creation failed. */
182 LTTCOMM_CONSUMERD_INVALID_PARAMETERS, /* Invalid parameters. */
183 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
184 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
185 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK, /* Unknown trace chunk. */
186 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED, /* Relayd does not accept clear command. */
187 LTTCOMM_CONSUMERD_UNKNOWN_ERROR, /* Unknown error. */
188
189 /* MUST be last element */
190 LTTCOMM_NR, /* Last element */
191 };
192
193 /* lttng socket protocol. */
194 enum lttcomm_sock_proto {
195 LTTCOMM_SOCK_UDP,
196 LTTCOMM_SOCK_TCP,
197 };
198
199 /*
200 * Index in the net_families array below. Please keep in sync!
201 */
202 enum lttcomm_sock_domain {
203 LTTCOMM_INET = 0,
204 LTTCOMM_INET6 = 1,
205 };
206
207 enum lttcomm_metadata_command {
208 LTTCOMM_METADATA_REQUEST = 1,
209 };
210
211 /*
212 * Commands sent from the consumerd to the sessiond to request if new metadata
213 * is available. This message is used to find the per UID _or_ per PID registry
214 * for the channel key. For per UID lookup, the triplet
215 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
216 * per PID registry indexed by session id ignoring the other values.
217 */
218 struct lttcomm_metadata_request_msg {
219 uint64_t session_id; /* Tracing session id */
220 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
221 uint32_t bits_per_long; /* Consumer ABI */
222 uint32_t uid;
223 uint64_t key; /* Metadata channel key. */
224 } LTTNG_PACKED;
225
226 struct lttcomm_sockaddr {
227 enum lttcomm_sock_domain type;
228 union {
229 struct sockaddr_in sin;
230 struct sockaddr_in6 sin6;
231 } addr;
232 } LTTNG_PACKED;
233
234 struct lttcomm_sock {
235 int32_t fd;
236 enum lttcomm_sock_proto proto;
237 struct lttcomm_sockaddr sockaddr;
238 const struct lttcomm_proto_ops *ops;
239 } LTTNG_PACKED;
240
241 /*
242 * Relayd sock. Adds the protocol version to use for the communications with
243 * the relayd.
244 */
245 struct lttcomm_relayd_sock {
246 struct lttcomm_sock sock;
247 uint32_t major;
248 uint32_t minor;
249 } LTTNG_PACKED;
250
251 struct lttcomm_net_family {
252 int family;
253 int (*create) (struct lttcomm_sock *sock, int type, int proto);
254 };
255
256 struct lttcomm_proto_ops {
257 int (*bind) (struct lttcomm_sock *sock);
258 int (*close) (struct lttcomm_sock *sock);
259 int (*connect) (struct lttcomm_sock *sock);
260 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
261 int (*listen) (struct lttcomm_sock *sock, int backlog);
262 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
263 int flags);
264 ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
265 size_t len, int flags);
266 };
267
268 struct process_attr_integral_value_comm {
269 union {
270 int64_t _signed;
271 uint64_t _unsigned;
272 } u;
273 } LTTNG_PACKED;
274
275 /*
276 * Data structure received from lttng client to session daemon.
277 */
278 struct lttcomm_session_msg {
279 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
280 struct lttng_session session;
281 struct lttng_domain domain;
282 union {
283 /* Event data */
284 struct {
285 char channel_name[LTTNG_SYMBOL_NAME_LEN];
286 struct lttng_event event LTTNG_PACKED;
287 /* Length of following filter expression. */
288 uint32_t expression_len;
289 /* Length of following bytecode for filter. */
290 uint32_t bytecode_len;
291 /* Exclusion count (fixed-size strings). */
292 uint32_t exclusion_count;
293 /* Userspace probe location size. */
294 uint32_t userspace_probe_location_len;
295 /*
296 * After this structure, the following variable-length
297 * items are transmitted:
298 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
299 * - char filter_expression[expression_len]
300 * - unsigned char filter_bytecode[bytecode_len]
301 */
302 } LTTNG_PACKED enable;
303 struct {
304 char channel_name[LTTNG_SYMBOL_NAME_LEN];
305 struct lttng_event event LTTNG_PACKED;
306 /* Length of following filter expression. */
307 uint32_t expression_len;
308 /* Length of following bytecode for filter. */
309 uint32_t bytecode_len;
310 /*
311 * After this structure, the following variable-length
312 * items are transmitted:
313 * - unsigned char filter_expression[expression_len]
314 * - unsigned char filter_bytecode[bytecode_len]
315 */
316 } LTTNG_PACKED disable;
317 /* Create channel */
318 struct {
319 struct lttng_channel chan LTTNG_PACKED;
320 /* struct lttng_channel_extended is already packed. */
321 struct lttng_channel_extended extended;
322 } LTTNG_PACKED channel;
323 /* Context */
324 struct {
325 char channel_name[LTTNG_SYMBOL_NAME_LEN];
326 struct lttng_event_context ctx LTTNG_PACKED;
327 uint32_t provider_name_len;
328 uint32_t context_name_len;
329 } LTTNG_PACKED context;
330 /* Use by register_consumer */
331 struct {
332 char path[PATH_MAX];
333 } LTTNG_PACKED reg;
334 /* List */
335 struct {
336 char channel_name[LTTNG_SYMBOL_NAME_LEN];
337 } LTTNG_PACKED list;
338 struct lttng_calibrate calibrate;
339 /* Used by the set_consumer_url and used by create_session also call */
340 struct {
341 /* Number of lttng_uri following */
342 uint32_t size;
343 } LTTNG_PACKED uri;
344 struct {
345 struct lttng_snapshot_output output LTTNG_PACKED;
346 } LTTNG_PACKED snapshot_output;
347 struct {
348 uint32_t wait;
349 struct lttng_snapshot_output output LTTNG_PACKED;
350 } LTTNG_PACKED snapshot_record;
351 struct {
352 uint32_t nb_uri;
353 unsigned int timer_interval; /* usec */
354 } LTTNG_PACKED session_live;
355 struct {
356 struct lttng_save_session_attr attr; /* struct already packed */
357 } LTTNG_PACKED save_session;
358 struct {
359 char shm_path[PATH_MAX];
360 } LTTNG_PACKED set_shm_path;
361 struct {
362 /* enum lttng_process_attr */
363 int32_t process_attr;
364 /* enum lttng_process_attr_value_type */
365 int32_t value_type;
366
367 struct process_attr_integral_value_comm integral_value;
368 /*
369 * For user/group names, a variable length,
370 * zero-terminated, string of length 'name_len'
371 * (including the terminator) follows.
372 *
373 * integral_value should not be used in those cases.
374 */
375 uint32_t name_len;
376 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
377 struct {
378 /* enum lttng_process_attr */
379 int32_t process_attr;
380 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
381 struct {
382 /* enum lttng_process_attr */
383 int32_t process_attr;
384 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
385 struct {
386 /* enum lttng_process_attr */
387 int32_t process_attr;
388 /* enum lttng_tracking_policy */
389 int32_t tracking_policy;
390 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
391 struct {
392 uint32_t length;
393 } LTTNG_PACKED trigger;
394 struct {
395 uint64_t rotation_id;
396 } LTTNG_PACKED get_rotation_info;
397 struct {
398 /* enum lttng_rotation_schedule_type */
399 uint8_t type;
400 /*
401 * If set == 1, set schedule to value, if set == 0,
402 * clear this schedule type.
403 */
404 uint8_t set;
405 uint64_t value;
406 } LTTNG_PACKED rotation_set_schedule;
407 struct {
408 /*
409 * Includes the null-terminator.
410 * Must be an absolute path.
411 *
412 * Size bounded by LTTNG_PATH_MAX.
413 */
414 uint16_t home_dir_size;
415 uint64_t session_descriptor_size;
416 /* An lttng_session_descriptor follows. */
417 } LTTNG_PACKED create_session;
418 } u;
419 } LTTNG_PACKED;
420
421 #define LTTNG_FILTER_MAX_LEN 65536
422 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
423
424 /*
425 * Filter bytecode data. The reloc table is located at the end of the
426 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
427 * starts at reloc_table_offset.
428 */
429 #define LTTNG_FILTER_PADDING 32
430 struct lttng_filter_bytecode {
431 uint32_t len; /* len of data */
432 uint32_t reloc_table_offset;
433 uint64_t seqnum;
434 char padding[LTTNG_FILTER_PADDING];
435 char data[0];
436 } LTTNG_PACKED;
437
438 /*
439 * Event exclusion data. At the end of the structure, there will actually
440 * by zero or more names, where the actual number of names is given by
441 * the 'count' item of the structure.
442 */
443 #define LTTNG_EVENT_EXCLUSION_PADDING 32
444 struct lttng_event_exclusion {
445 uint32_t count;
446 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
447 char names[0][LTTNG_SYMBOL_NAME_LEN];
448 } LTTNG_PACKED;
449
450 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
451 (&(_exclusion)->names[_i][0])
452
453 /*
454 * Event command header.
455 */
456 struct lttcomm_event_command_header {
457 /* Number of events */
458 uint32_t nb_events;
459 } LTTNG_PACKED;
460
461 /*
462 * Event extended info header. This is the structure preceding each
463 * extended info data.
464 */
465 struct lttcomm_event_extended_header {
466 /*
467 * Size of filter string immediately following this header.
468 * This size includes the terminal null character.
469 */
470 uint32_t filter_len;
471
472 /*
473 * Number of exclusion names, immediately following the filter
474 * string. Each exclusion name has a fixed length of
475 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
476 * character.
477 */
478 uint32_t nb_exclusions;
479
480 /*
481 * Size of the event's userspace probe location (if applicable).
482 */
483 uint32_t userspace_probe_location_len;
484 } LTTNG_PACKED;
485
486 /*
487 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
488 */
489 struct lttcomm_session_destroy_command_header {
490 /* enum lttng_session */
491 int32_t rotation_state;
492 };
493
494 /*
495 * tracker command header.
496 */
497 struct lttcomm_tracker_command_header {
498 uint32_t nb_tracker_id;
499 } LTTNG_PACKED;
500
501 /*
502 * Data structure for the response from sessiond to the lttng client.
503 */
504 struct lttcomm_lttng_msg {
505 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
506 uint32_t ret_code; /* enum lttcomm_return_code */
507 uint32_t pid; /* pid_t */
508 uint32_t cmd_header_size;
509 uint32_t data_size;
510 uint32_t fd_count;
511 } LTTNG_PACKED;
512
513 struct lttcomm_lttng_output_id {
514 uint32_t id;
515 } LTTNG_PACKED;
516
517 /*
518 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
519 * to either add a channel, add a stream, update a stream, or stop
520 * operation.
521 */
522 struct lttcomm_consumer_msg {
523 uint32_t cmd_type; /* enum lttng_consumer_command */
524 union {
525 struct {
526 uint64_t channel_key;
527 uint64_t session_id;
528 /* ID of the session's current trace chunk. */
529 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
530 char pathname[PATH_MAX];
531 uint64_t relayd_id;
532 /* nb_init_streams is the number of streams open initially. */
533 uint32_t nb_init_streams;
534 char name[LTTNG_SYMBOL_NAME_LEN];
535 /* Use splice or mmap to consume this fd */
536 enum lttng_event_output output;
537 int type; /* Per cpu or metadata. */
538 uint64_t tracefile_size; /* bytes */
539 uint32_t tracefile_count; /* number of tracefiles */
540 /* If the channel's streams have to be monitored or not. */
541 uint32_t monitor;
542 /* timer to check the streams usage in live mode (usec). */
543 unsigned int live_timer_interval;
544 /* is part of a live session */
545 uint8_t is_live;
546 /* timer to sample a channel's positions (usec). */
547 unsigned int monitor_timer_interval;
548 } LTTNG_PACKED channel; /* Only used by Kernel. */
549 struct {
550 uint64_t stream_key;
551 uint64_t channel_key;
552 int32_t cpu; /* On which CPU this stream is assigned. */
553 /* Tells the consumer if the stream should be or not monitored. */
554 uint32_t no_monitor;
555 } LTTNG_PACKED stream; /* Only used by Kernel. */
556 struct {
557 uint64_t net_index;
558 enum lttng_stream_type type;
559 /* Open socket to the relayd */
560 struct lttcomm_relayd_sock sock;
561 /* Tracing session id associated to the relayd. */
562 uint64_t session_id;
563 /* Relayd session id, only used with control socket. */
564 uint64_t relayd_session_id;
565 } LTTNG_PACKED relayd_sock;
566 struct {
567 uint64_t net_seq_idx;
568 } LTTNG_PACKED destroy_relayd;
569 struct {
570 uint64_t session_id;
571 } LTTNG_PACKED data_pending;
572 struct {
573 uint64_t subbuf_size; /* bytes */
574 uint64_t num_subbuf; /* power of 2 */
575 int32_t overwrite; /* 1: overwrite, 0: discard */
576 uint32_t switch_timer_interval; /* usec */
577 uint32_t read_timer_interval; /* usec */
578 unsigned int live_timer_interval; /* usec */
579 uint8_t is_live; /* is part of a live session */
580 uint32_t monitor_timer_interval; /* usec */
581 int32_t output; /* splice, mmap */
582 int32_t type; /* metadata or per_cpu */
583 uint64_t session_id; /* Tracing session id */
584 char pathname[PATH_MAX]; /* Channel file path. */
585 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
586 /* Credentials used to open the UST buffer shared mappings. */
587 struct {
588 uint32_t uid;
589 uint32_t gid;
590 } LTTNG_PACKED buffer_credentials;
591 uint64_t relayd_id; /* Relayd id if apply. */
592 uint64_t key; /* Unique channel key. */
593 /* ID of the session's current trace chunk. */
594 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
595 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
596 uint32_t chan_id; /* Channel ID on the tracer side. */
597 uint64_t tracefile_size; /* bytes */
598 uint32_t tracefile_count; /* number of tracefiles */
599 uint64_t session_id_per_pid; /* Per-pid session ID. */
600 /* Tells the consumer if the stream should be or not monitored. */
601 uint32_t monitor;
602 /*
603 * For UST per UID buffers, this is the application UID of the
604 * channel. This can be different from the user UID requesting the
605 * channel creation and used for the rights on the stream file
606 * because the application can be in the tracing for instance.
607 */
608 uint32_t ust_app_uid;
609 int64_t blocking_timeout;
610 char root_shm_path[PATH_MAX];
611 char shm_path[PATH_MAX];
612 } LTTNG_PACKED ask_channel;
613 struct {
614 uint64_t key;
615 } LTTNG_PACKED get_channel;
616 struct {
617 uint64_t key;
618 } LTTNG_PACKED destroy_channel;
619 struct {
620 uint64_t key; /* Metadata channel key. */
621 uint64_t target_offset; /* Offset in the consumer */
622 uint64_t len; /* Length of metadata to be received. */
623 uint64_t version; /* Version of the metadata. */
624 } LTTNG_PACKED push_metadata;
625 struct {
626 uint64_t key; /* Metadata channel key. */
627 } LTTNG_PACKED close_metadata;
628 struct {
629 uint64_t key; /* Metadata channel key. */
630 } LTTNG_PACKED setup_metadata;
631 struct {
632 uint64_t key; /* Channel key. */
633 } LTTNG_PACKED flush_channel;
634 struct {
635 uint64_t key; /* Channel key. */
636 } LTTNG_PACKED clear_quiescent_channel;
637 struct {
638 char pathname[PATH_MAX];
639 /* Indicate if the snapshot goes on the relayd or locally. */
640 uint32_t use_relayd;
641 uint32_t metadata; /* This a metadata snapshot. */
642 uint64_t relayd_id; /* Relayd id if apply. */
643 uint64_t key;
644 uint64_t nb_packets_per_stream;
645 } LTTNG_PACKED snapshot_channel;
646 struct {
647 uint64_t channel_key;
648 uint64_t net_seq_idx;
649 } LTTNG_PACKED sent_streams;
650 struct {
651 uint64_t session_id;
652 uint64_t channel_key;
653 } LTTNG_PACKED discarded_events;
654 struct {
655 uint64_t session_id;
656 uint64_t channel_key;
657 } LTTNG_PACKED lost_packets;
658 struct {
659 uint64_t session_id;
660 } LTTNG_PACKED regenerate_metadata;
661 struct {
662 uint32_t metadata; /* This is a metadata channel. */
663 uint64_t relayd_id; /* Relayd id if apply. */
664 uint64_t key;
665 } LTTNG_PACKED rotate_channel;
666 struct {
667 uint64_t session_id;
668 uint64_t chunk_id;
669 } LTTNG_PACKED check_rotation_pending_local;
670 struct {
671 uint64_t relayd_id;
672 uint64_t session_id;
673 uint64_t chunk_id;
674 } LTTNG_PACKED check_rotation_pending_relay;
675 struct {
676 /*
677 * Relayd id, if applicable (remote).
678 *
679 * A directory file descriptor referring to the chunk's
680 * output folder is transmitted if the chunk is local
681 * (relayd_id unset).
682 *
683 * `override_name` is left NULL (all-zeroes) if the
684 * chunk's name is not overridden.
685 */
686 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
687 char override_name[LTTNG_NAME_MAX];
688 uint64_t session_id;
689 uint64_t chunk_id;
690 uint64_t creation_timestamp;
691 LTTNG_OPTIONAL_COMM(struct {
692 uint32_t uid;
693 uint32_t gid;
694 } LTTNG_PACKED ) LTTNG_PACKED credentials;
695 } LTTNG_PACKED create_trace_chunk;
696 struct {
697 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
698 uint64_t session_id;
699 uint64_t chunk_id;
700 uint64_t close_timestamp;
701 /* enum lttng_trace_chunk_command_type */
702 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
703 } LTTNG_PACKED close_trace_chunk;
704 struct {
705 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
706 uint64_t session_id;
707 uint64_t chunk_id;
708 } LTTNG_PACKED trace_chunk_exists;
709 struct {
710 lttng_uuid sessiond_uuid;
711 } LTTNG_PACKED init;
712 struct {
713 uint64_t key;
714 } LTTNG_PACKED clear_channel;
715 struct {
716 uint64_t key;
717 } LTTNG_PACKED open_channel_packets;
718 } u;
719 } LTTNG_PACKED;
720
721 /*
722 * Channel monitoring message returned to the session daemon on every
723 * monitor timer expiration.
724 */
725 struct lttcomm_consumer_channel_monitor_msg {
726 /* Key of the sampled channel. */
727 uint64_t key;
728 /*
729 * Lowest and highest usage (bytes) at the moment the sample was taken.
730 */
731 uint64_t lowest, highest;
732 /*
733 * Sum of all the consumed positions for a channel.
734 */
735 uint64_t total_consumed;
736 } LTTNG_PACKED;
737
738 /*
739 * Status message returned to the sessiond after a received command.
740 */
741 struct lttcomm_consumer_status_msg {
742 enum lttcomm_return_code ret_code;
743 } LTTNG_PACKED;
744
745 struct lttcomm_consumer_status_channel {
746 enum lttcomm_return_code ret_code;
747 uint64_t key;
748 unsigned int stream_count;
749 } LTTNG_PACKED;
750
751 struct lttcomm_consumer_close_trace_chunk_reply {
752 enum lttcomm_return_code ret_code;
753 uint32_t path_length;
754 char path[];
755 };
756
757 #ifdef HAVE_LIBLTTNG_UST_CTL
758
759 #include <lttng/ust-abi.h>
760
761 /*
762 * Data structure for the commands sent from sessiond to UST.
763 */
764 struct lttcomm_ust_msg {
765 uint32_t handle;
766 uint32_t cmd;
767 union {
768 struct lttng_ust_channel channel;
769 struct lttng_ust_stream stream;
770 struct lttng_ust_event event;
771 struct lttng_ust_context context;
772 struct lttng_ust_tracer_version version;
773 } u;
774 } LTTNG_PACKED;
775
776 /*
777 * Data structure for the response from UST to the session daemon.
778 * cmd_type is sent back in the reply for validation.
779 */
780 struct lttcomm_ust_reply {
781 uint32_t handle;
782 uint32_t cmd;
783 uint32_t ret_code; /* enum lttcomm_return_code */
784 uint32_t ret_val; /* return value */
785 union {
786 struct {
787 uint64_t memory_map_size;
788 } LTTNG_PACKED channel;
789 struct {
790 uint64_t memory_map_size;
791 } LTTNG_PACKED stream;
792 struct lttng_ust_tracer_version version;
793 } u;
794 } LTTNG_PACKED;
795
796 #endif /* HAVE_LIBLTTNG_UST_CTL */
797
798 LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
799
800 LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
801 const char *ip, unsigned int port);
802 LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
803 const char *ip, unsigned int port);
804
805 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
806 LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
807 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
808 LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
809 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
810 LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
811 struct lttcomm_sock *src);
812
813 /* Relayd socket object. */
814 LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
815 struct lttng_uri *uri, uint32_t major, uint32_t minor);
816
817 LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
818 LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
819
820 LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
821 uint16_t *port);
822 /*
823 * Set a port to an lttcomm_sock. This will have no effect is the socket is
824 * already bound.
825 */
826 LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
827
828 LTTNG_HIDDEN void lttcomm_init(void);
829 /* Get network timeout, in milliseconds */
830 LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
831
832 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.07746 seconds and 5 git commands to generate.