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