projects / lttng-tools.git / blob
? search:


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