uprobe: transmit binary file descritptor through lttng_payload
[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 #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 } LTTNG_PACKED;
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 } LTTNG_PACKED;
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 } LTTNG_PACKED;
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 struct lttng_channel chan LTTNG_PACKED;
315 /* struct lttng_channel_extended is already packed. */
316 struct lttng_channel_extended extended;
317 } LTTNG_PACKED channel;
318 /* Context */
319 struct {
320 char channel_name[LTTNG_SYMBOL_NAME_LEN];
321 struct lttng_event_context ctx LTTNG_PACKED;
322 uint32_t provider_name_len;
323 uint32_t context_name_len;
324 } LTTNG_PACKED context;
325 /* Use by register_consumer */
326 struct {
327 char path[PATH_MAX];
328 } LTTNG_PACKED reg;
329 /* List */
330 struct {
331 char channel_name[LTTNG_SYMBOL_NAME_LEN];
332 } LTTNG_PACKED list;
333 struct lttng_calibrate calibrate;
334 /* Used by the set_consumer_url and used by create_session also call */
335 struct {
336 /* Number of lttng_uri following */
337 uint32_t size;
338 } LTTNG_PACKED uri;
339 struct {
340 struct lttng_snapshot_output output LTTNG_PACKED;
341 } LTTNG_PACKED snapshot_output;
342 struct {
343 uint32_t wait;
344 struct lttng_snapshot_output output LTTNG_PACKED;
345 } LTTNG_PACKED snapshot_record;
346 struct {
347 uint32_t nb_uri;
348 unsigned int timer_interval; /* usec */
349 } LTTNG_PACKED session_live;
350 struct {
351 struct lttng_save_session_attr attr; /* struct already packed */
352 } LTTNG_PACKED save_session;
353 struct {
354 char shm_path[PATH_MAX];
355 } LTTNG_PACKED set_shm_path;
356 struct {
357 /* enum lttng_process_attr */
358 int32_t process_attr;
359 /* enum lttng_process_attr_value_type */
360 int32_t value_type;
361
362 struct process_attr_integral_value_comm integral_value;
363 /*
364 * For user/group names, a variable length,
365 * zero-terminated, string of length 'name_len'
366 * (including the terminator) follows.
367 *
368 * integral_value should not be used in those cases.
369 */
370 uint32_t name_len;
371 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
372 struct {
373 /* enum lttng_process_attr */
374 int32_t process_attr;
375 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
376 struct {
377 /* enum lttng_process_attr */
378 int32_t process_attr;
379 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
380 struct {
381 /* enum lttng_process_attr */
382 int32_t process_attr;
383 /* enum lttng_tracking_policy */
384 int32_t tracking_policy;
385 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
386 struct {
387 uint32_t length;
388 } LTTNG_PACKED trigger;
389 struct {
390 uint64_t rotation_id;
391 } LTTNG_PACKED get_rotation_info;
392 struct {
393 /* enum lttng_rotation_schedule_type */
394 uint8_t type;
395 /*
396 * If set == 1, set schedule to value, if set == 0,
397 * clear this schedule type.
398 */
399 uint8_t set;
400 uint64_t value;
401 } LTTNG_PACKED rotation_set_schedule;
402 struct {
403 /*
404 * Includes the null-terminator.
405 * Must be an absolute path.
406 *
407 * Size bounded by LTTNG_PATH_MAX.
408 */
409 uint16_t home_dir_size;
410 uint64_t session_descriptor_size;
411 /* An lttng_session_descriptor follows. */
412 } LTTNG_PACKED create_session;
413 } u;
414 } LTTNG_PACKED;
415
416 #define LTTNG_FILTER_MAX_LEN 65536
417 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
418
419 /*
420 * Filter bytecode data. The reloc table is located at the end of the
421 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
422 * starts at reloc_table_offset.
423 */
424 #define LTTNG_FILTER_PADDING 32
425 struct lttng_filter_bytecode {
426 uint32_t len; /* len of data */
427 uint32_t reloc_table_offset;
428 uint64_t seqnum;
429 char padding[LTTNG_FILTER_PADDING];
430 char data[0];
431 } LTTNG_PACKED;
432
433 /*
434 * Event exclusion data. At the end of the structure, there will actually
435 * by zero or more names, where the actual number of names is given by
436 * the 'count' item of the structure.
437 */
438 #define LTTNG_EVENT_EXCLUSION_PADDING 32
439 struct lttng_event_exclusion {
440 uint32_t count;
441 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
442 char names[0][LTTNG_SYMBOL_NAME_LEN];
443 } LTTNG_PACKED;
444
445 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
446 (&(_exclusion)->names[_i][0])
447
448 /*
449 * Event command header.
450 */
451 struct lttcomm_event_command_header {
452 /* Number of events */
453 uint32_t nb_events;
454 } LTTNG_PACKED;
455
456 /*
457 * Event extended info header. This is the structure preceding each
458 * extended info data.
459 */
460 struct lttcomm_event_extended_header {
461 /*
462 * Size of filter string immediately following this header.
463 * This size includes the terminal null character.
464 */
465 uint32_t filter_len;
466
467 /*
468 * Number of exclusion names, immediately following the filter
469 * string. Each exclusion name has a fixed length of
470 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
471 * character.
472 */
473 uint32_t nb_exclusions;
474
475 /*
476 * Size of the event's userspace probe location (if applicable).
477 */
478 uint32_t userspace_probe_location_len;
479 } LTTNG_PACKED;
480
481 /*
482 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
483 */
484 struct lttcomm_session_destroy_command_header {
485 /* enum lttng_session */
486 int32_t rotation_state;
487 };
488
489 /*
490 * tracker command header.
491 */
492 struct lttcomm_tracker_command_header {
493 uint32_t nb_tracker_id;
494 } LTTNG_PACKED;
495
496 /*
497 * Data structure for the response from sessiond to the lttng client.
498 */
499 struct lttcomm_lttng_msg {
500 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
501 uint32_t ret_code; /* enum lttcomm_return_code */
502 uint32_t pid; /* pid_t */
503 uint32_t cmd_header_size;
504 uint32_t data_size;
505 uint32_t fd_count;
506 } LTTNG_PACKED;
507
508 struct lttcomm_lttng_output_id {
509 uint32_t id;
510 } LTTNG_PACKED;
511
512 /*
513 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
514 * to either add a channel, add a stream, update a stream, or stop
515 * operation.
516 */
517 struct lttcomm_consumer_msg {
518 uint32_t cmd_type; /* enum lttng_consumer_command */
519 union {
520 struct {
521 uint64_t channel_key;
522 uint64_t session_id;
523 /* ID of the session's current trace chunk. */
524 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
525 char pathname[PATH_MAX];
526 uint64_t relayd_id;
527 /* nb_init_streams is the number of streams open initially. */
528 uint32_t nb_init_streams;
529 char name[LTTNG_SYMBOL_NAME_LEN];
530 /* Use splice or mmap to consume this fd */
531 enum lttng_event_output output;
532 int type; /* Per cpu or metadata. */
533 uint64_t tracefile_size; /* bytes */
534 uint32_t tracefile_count; /* number of tracefiles */
535 /* If the channel's streams have to be monitored or not. */
536 uint32_t monitor;
537 /* timer to check the streams usage in live mode (usec). */
538 unsigned int live_timer_interval;
539 /* is part of a live session */
540 uint8_t is_live;
541 /* timer to sample a channel's positions (usec). */
542 unsigned int monitor_timer_interval;
543 } LTTNG_PACKED channel; /* Only used by Kernel. */
544 struct {
545 uint64_t stream_key;
546 uint64_t channel_key;
547 int32_t cpu; /* On which CPU this stream is assigned. */
548 /* Tells the consumer if the stream should be or not monitored. */
549 uint32_t no_monitor;
550 } LTTNG_PACKED stream; /* Only used by Kernel. */
551 struct {
552 uint64_t net_index;
553 enum lttng_stream_type type;
554 /* Open socket to the relayd */
555 struct lttcomm_relayd_sock sock;
556 /* Tracing session id associated to the relayd. */
557 uint64_t session_id;
558 /* Relayd session id, only used with control socket. */
559 uint64_t relayd_session_id;
560 } LTTNG_PACKED relayd_sock;
561 struct {
562 uint64_t net_seq_idx;
563 } LTTNG_PACKED destroy_relayd;
564 struct {
565 uint64_t session_id;
566 } LTTNG_PACKED data_pending;
567 struct {
568 uint64_t subbuf_size; /* bytes */
569 uint64_t num_subbuf; /* power of 2 */
570 int32_t overwrite; /* 1: overwrite, 0: discard */
571 uint32_t switch_timer_interval; /* usec */
572 uint32_t read_timer_interval; /* usec */
573 unsigned int live_timer_interval; /* usec */
574 uint8_t is_live; /* is part of a live session */
575 uint32_t monitor_timer_interval; /* usec */
576 int32_t output; /* splice, mmap */
577 int32_t type; /* metadata or per_cpu */
578 uint64_t session_id; /* Tracing session id */
579 char pathname[PATH_MAX]; /* Channel file path. */
580 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
581 /* Credentials used to open the UST buffer shared mappings. */
582 struct {
583 uint32_t uid;
584 uint32_t gid;
585 } LTTNG_PACKED buffer_credentials;
586 uint64_t relayd_id; /* Relayd id if apply. */
587 uint64_t key; /* Unique channel key. */
588 /* ID of the session's current trace chunk. */
589 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
590 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
591 uint32_t chan_id; /* Channel ID on the tracer side. */
592 uint64_t tracefile_size; /* bytes */
593 uint32_t tracefile_count; /* number of tracefiles */
594 uint64_t session_id_per_pid; /* Per-pid session ID. */
595 /* Tells the consumer if the stream should be or not monitored. */
596 uint32_t monitor;
597 /*
598 * For UST per UID buffers, this is the application UID of the
599 * channel. This can be different from the user UID requesting the
600 * channel creation and used for the rights on the stream file
601 * because the application can be in the tracing for instance.
602 */
603 uint32_t ust_app_uid;
604 int64_t blocking_timeout;
605 char root_shm_path[PATH_MAX];
606 char shm_path[PATH_MAX];
607 } LTTNG_PACKED ask_channel;
608 struct {
609 uint64_t key;
610 } LTTNG_PACKED get_channel;
611 struct {
612 uint64_t key;
613 } LTTNG_PACKED destroy_channel;
614 struct {
615 uint64_t key; /* Metadata channel key. */
616 uint64_t target_offset; /* Offset in the consumer */
617 uint64_t len; /* Length of metadata to be received. */
618 uint64_t version; /* Version of the metadata. */
619 } LTTNG_PACKED push_metadata;
620 struct {
621 uint64_t key; /* Metadata channel key. */
622 } LTTNG_PACKED close_metadata;
623 struct {
624 uint64_t key; /* Metadata channel key. */
625 } LTTNG_PACKED setup_metadata;
626 struct {
627 uint64_t key; /* Channel key. */
628 } LTTNG_PACKED flush_channel;
629 struct {
630 uint64_t key; /* Channel key. */
631 } LTTNG_PACKED clear_quiescent_channel;
632 struct {
633 char pathname[PATH_MAX];
634 /* Indicate if the snapshot goes on the relayd or locally. */
635 uint32_t use_relayd;
636 uint32_t metadata; /* This a metadata snapshot. */
637 uint64_t relayd_id; /* Relayd id if apply. */
638 uint64_t key;
639 uint64_t nb_packets_per_stream;
640 } LTTNG_PACKED snapshot_channel;
641 struct {
642 uint64_t channel_key;
643 uint64_t net_seq_idx;
644 } LTTNG_PACKED sent_streams;
645 struct {
646 uint64_t session_id;
647 uint64_t channel_key;
648 } LTTNG_PACKED discarded_events;
649 struct {
650 uint64_t session_id;
651 uint64_t channel_key;
652 } LTTNG_PACKED lost_packets;
653 struct {
654 uint64_t session_id;
655 } LTTNG_PACKED regenerate_metadata;
656 struct {
657 uint32_t metadata; /* This is a metadata channel. */
658 uint64_t relayd_id; /* Relayd id if apply. */
659 uint64_t key;
660 } LTTNG_PACKED rotate_channel;
661 struct {
662 uint64_t session_id;
663 uint64_t chunk_id;
664 } LTTNG_PACKED check_rotation_pending_local;
665 struct {
666 uint64_t relayd_id;
667 uint64_t session_id;
668 uint64_t chunk_id;
669 } LTTNG_PACKED check_rotation_pending_relay;
670 struct {
671 /*
672 * Relayd id, if applicable (remote).
673 *
674 * A directory file descriptor referring to the chunk's
675 * output folder is transmitted if the chunk is local
676 * (relayd_id unset).
677 *
678 * `override_name` is left NULL (all-zeroes) if the
679 * chunk's name is not overridden.
680 */
681 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
682 char override_name[LTTNG_NAME_MAX];
683 uint64_t session_id;
684 uint64_t chunk_id;
685 uint64_t creation_timestamp;
686 LTTNG_OPTIONAL_COMM(struct {
687 uint32_t uid;
688 uint32_t gid;
689 } LTTNG_PACKED ) LTTNG_PACKED credentials;
690 } LTTNG_PACKED create_trace_chunk;
691 struct {
692 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
693 uint64_t session_id;
694 uint64_t chunk_id;
695 uint64_t close_timestamp;
696 /* enum lttng_trace_chunk_command_type */
697 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
698 } LTTNG_PACKED close_trace_chunk;
699 struct {
700 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
701 uint64_t session_id;
702 uint64_t chunk_id;
703 } LTTNG_PACKED trace_chunk_exists;
704 struct {
705 lttng_uuid sessiond_uuid;
706 } LTTNG_PACKED init;
707 struct {
708 uint64_t key;
709 } LTTNG_PACKED clear_channel;
710 struct {
711 uint64_t key;
712 } LTTNG_PACKED open_channel_packets;
713 } u;
714 } LTTNG_PACKED;
715
716 /*
717 * Channel monitoring message returned to the session daemon on every
718 * monitor timer expiration.
719 */
720 struct lttcomm_consumer_channel_monitor_msg {
721 /* Key of the sampled channel. */
722 uint64_t key;
723 /*
724 * Lowest and highest usage (bytes) at the moment the sample was taken.
725 */
726 uint64_t lowest, highest;
727 /*
728 * Sum of all the consumed positions for a channel.
729 */
730 uint64_t total_consumed;
731 } LTTNG_PACKED;
732
733 /*
734 * Status message returned to the sessiond after a received command.
735 */
736 struct lttcomm_consumer_status_msg {
737 enum lttcomm_return_code ret_code;
738 } LTTNG_PACKED;
739
740 struct lttcomm_consumer_status_channel {
741 enum lttcomm_return_code ret_code;
742 uint64_t key;
743 unsigned int stream_count;
744 } LTTNG_PACKED;
745
746 struct lttcomm_consumer_close_trace_chunk_reply {
747 enum lttcomm_return_code ret_code;
748 uint32_t path_length;
749 char path[];
750 };
751
752 #ifdef HAVE_LIBLTTNG_UST_CTL
753
754 #include <lttng/ust-abi.h>
755
756 /*
757 * Data structure for the commands sent from sessiond to UST.
758 */
759 struct lttcomm_ust_msg {
760 uint32_t handle;
761 uint32_t cmd;
762 union {
763 struct lttng_ust_channel channel;
764 struct lttng_ust_stream stream;
765 struct lttng_ust_event event;
766 struct lttng_ust_context context;
767 struct lttng_ust_tracer_version version;
768 } u;
769 } LTTNG_PACKED;
770
771 /*
772 * Data structure for the response from UST to the session daemon.
773 * cmd_type is sent back in the reply for validation.
774 */
775 struct lttcomm_ust_reply {
776 uint32_t handle;
777 uint32_t cmd;
778 uint32_t ret_code; /* enum lttcomm_return_code */
779 uint32_t ret_val; /* return value */
780 union {
781 struct {
782 uint64_t memory_map_size;
783 } LTTNG_PACKED channel;
784 struct {
785 uint64_t memory_map_size;
786 } LTTNG_PACKED stream;
787 struct lttng_ust_tracer_version version;
788 } u;
789 } LTTNG_PACKED;
790
791 #endif /* HAVE_LIBLTTNG_UST_CTL */
792
793 LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
794
795 LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
796 const char *ip, unsigned int port);
797 LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
798 const char *ip, unsigned int port);
799
800 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
801 LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
802 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
803 LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
804 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
805 LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
806 struct lttcomm_sock *src);
807
808 /* Relayd socket object. */
809 LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
810 struct lttng_uri *uri, uint32_t major, uint32_t minor);
811
812 LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
813 LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
814
815 LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
816 uint16_t *port);
817 /*
818 * Set a port to an lttcomm_sock. This will have no effect is the socket is
819 * already bound.
820 */
821 LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
822
823 LTTNG_HIDDEN void lttcomm_init(void);
824 /* Get network timeout, in milliseconds */
825 LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
826
827 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.073813 seconds and 4 git commands to generate.