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


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