2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
10 * This header is meant for liblttng and libust internal use ONLY. These
11 * declarations should NOT be considered stable API.
14 #ifndef _LTTNG_SESSIOND_COMM_H
15 #define _LTTNG_SESSIOND_COMM_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>
31 #include <arpa/inet.h>
32 #include <netinet/in.h>
38 #include <common/unix.h>
40 /* Queue size of listen(2) */
41 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
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
48 #define LTTCOMM_MAX_SEND_FDS 16
52 * Get the error code index from 0 since LTTCOMM_OK start at 1000
54 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
56 enum lttcomm_sessiond_command
{
57 LTTCOMM_SESSIOND_COMMAND_MIN
= -1,
59 LTTNG_ADD_CONTEXT
= 0,
60 /* LTTNG_CALIBRATE used to be here */
61 LTTNG_DISABLE_CHANNEL
= 2,
62 LTTNG_DISABLE_EVENT
= 3,
63 LTTNG_LIST_SYSCALLS
= 4,
64 LTTNG_ENABLE_CHANNEL
= 5,
65 LTTNG_ENABLE_EVENT
= 6,
67 /* Session daemon command */
69 LTTNG_DESTROY_SESSION
= 9,
70 LTTNG_LIST_CHANNELS
= 10,
71 LTTNG_LIST_DOMAINS
= 11,
72 LTTNG_LIST_EVENTS
= 12,
73 LTTNG_LIST_SESSIONS
= 13,
74 LTTNG_LIST_TRACEPOINTS
= 14,
75 LTTNG_REGISTER_CONSUMER
= 15,
76 LTTNG_START_TRACE
= 16,
77 LTTNG_STOP_TRACE
= 17,
78 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
81 LTTNG_DISABLE_CONSUMER
= 19,
82 LTTNG_ENABLE_CONSUMER
= 20,
83 LTTNG_SET_CONSUMER_URI
= 21,
86 LTTNG_DATA_PENDING
= 24,
87 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
88 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
89 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
90 LTTNG_SNAPSHOT_RECORD
= 28,
93 LTTNG_SAVE_SESSION
= 31,
94 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
= 32,
95 LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
= 33,
96 LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
= 34,
97 LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
= 35,
98 LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
= 36,
99 LTTNG_SET_SESSION_SHM_PATH
= 40,
100 LTTNG_REGENERATE_METADATA
= 41,
101 LTTNG_REGENERATE_STATEDUMP
= 42,
102 LTTNG_REGISTER_TRIGGER
= 43,
103 LTTNG_UNREGISTER_TRIGGER
= 44,
104 LTTNG_ROTATE_SESSION
= 45,
105 LTTNG_ROTATION_GET_INFO
= 46,
106 LTTNG_ROTATION_SET_SCHEDULE
= 47,
107 LTTNG_SESSION_LIST_ROTATION_SCHEDULES
= 48,
108 LTTNG_CREATE_SESSION_EXT
= 49,
109 LTTNG_CLEAR_SESSION
= 50,
110 LTTNG_LIST_TRIGGERS
= 51,
111 LTTNG_EXECUTE_ERROR_QUERY
= 52,
112 LTTCOMM_SESSIOND_COMMAND_MAX
,
116 bool lttcomm_sessiond_command_is_valid(enum lttcomm_sessiond_command cmd
)
118 return cmd
> LTTCOMM_SESSIOND_COMMAND_MIN
&& cmd
< LTTCOMM_SESSIOND_COMMAND_MAX
;
122 const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd
)
125 case LTTNG_ADD_CONTEXT
:
126 return "LTTNG_ADD_CONTEXT";
127 case LTTNG_DISABLE_CHANNEL
:
128 return "LTTNG_DISABLE_CHANNEL";
129 case LTTNG_DISABLE_EVENT
:
130 return "LTTNG_DISABLE_EVENT";
131 case LTTNG_LIST_SYSCALLS
:
132 return "LTTNG_LIST_SYSCALLS";
133 case LTTNG_ENABLE_CHANNEL
:
134 return "LTTNG_ENABLE_CHANNEL";
135 case LTTNG_ENABLE_EVENT
:
136 return "LTTNG_ENABLE_EVENT";
137 case LTTNG_DESTROY_SESSION
:
138 return "LTTNG_DESTROY_SESSION";
139 case LTTNG_LIST_CHANNELS
:
140 return "LTTNG_LIST_CHANNELS";
141 case LTTNG_LIST_DOMAINS
:
142 return "LTTNG_LIST_DOMAINS";
143 case LTTNG_LIST_EVENTS
:
144 return "LTTNG_LIST_EVENTS";
145 case LTTNG_LIST_SESSIONS
:
146 return "LTTNG_LIST_SESSIONS";
147 case LTTNG_LIST_TRACEPOINTS
:
148 return "LTTNG_LIST_TRACEPOINTS";
149 case LTTNG_REGISTER_CONSUMER
:
150 return "LTTNG_REGISTER_CONSUMER";
151 case LTTNG_START_TRACE
:
152 return "LTTNG_START_TRACE";
153 case LTTNG_STOP_TRACE
:
154 return "LTTNG_STOP_TRACE";
155 case LTTNG_LIST_TRACEPOINT_FIELDS
:
156 return "LTTNG_LIST_TRACEPOINT_FIELDS";
157 case LTTNG_DISABLE_CONSUMER
:
158 return "LTTNG_DISABLE_CONSUMER";
159 case LTTNG_ENABLE_CONSUMER
:
160 return "LTTNG_ENABLE_CONSUMER";
161 case LTTNG_SET_CONSUMER_URI
:
162 return "LTTNG_SET_CONSUMER_URI";
163 case LTTNG_DATA_PENDING
:
164 return "LTTNG_DATA_PENDING";
165 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
166 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
167 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
168 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
169 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
170 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
171 case LTTNG_SNAPSHOT_RECORD
:
172 return "LTTNG_SNAPSHOT_RECORD";
173 case LTTNG_SAVE_SESSION
:
174 return "LTTNG_SAVE_SESSION";
175 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
176 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
177 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
178 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
179 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
180 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
181 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
182 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
183 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
184 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
185 case LTTNG_SET_SESSION_SHM_PATH
:
186 return "LTTNG_SET_SESSION_SHM_PATH";
187 case LTTNG_REGENERATE_METADATA
:
188 return "LTTNG_REGENERATE_METADATA";
189 case LTTNG_REGENERATE_STATEDUMP
:
190 return "LTTNG_REGENERATE_STATEDUMP";
191 case LTTNG_REGISTER_TRIGGER
:
192 return "LTTNG_REGISTER_TRIGGER";
193 case LTTNG_UNREGISTER_TRIGGER
:
194 return "LTTNG_UNREGISTER_TRIGGER";
195 case LTTNG_ROTATE_SESSION
:
196 return "LTTNG_ROTATE_SESSION";
197 case LTTNG_ROTATION_GET_INFO
:
198 return "LTTNG_ROTATION_GET_INFO";
199 case LTTNG_ROTATION_SET_SCHEDULE
:
200 return "LTTNG_ROTATION_SET_SCHEDULE";
201 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
202 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
203 case LTTNG_CREATE_SESSION_EXT
:
204 return "LTTNG_CREATE_SESSION_EXT";
205 case LTTNG_CLEAR_SESSION
:
206 return "LTTNG_CLEAR_SESSION";
207 case LTTNG_LIST_TRIGGERS
:
208 return "LTTNG_LIST_TRIGGERS";
209 case LTTNG_EXECUTE_ERROR_QUERY
:
210 return "LTTNG_EXECUTE_ERROR_QUERY";
216 enum lttcomm_relayd_command
{
217 RELAYD_ADD_STREAM
= 1,
218 RELAYD_CREATE_SESSION
= 2,
219 RELAYD_START_DATA
= 3,
220 RELAYD_UPDATE_SYNC_INFO
= 4,
222 RELAYD_SEND_METADATA
= 6,
223 RELAYD_CLOSE_STREAM
= 7,
224 RELAYD_DATA_PENDING
= 8,
225 RELAYD_QUIESCENT_CONTROL
= 9,
226 RELAYD_BEGIN_DATA_PENDING
= 10,
227 RELAYD_END_DATA_PENDING
= 11,
228 RELAYD_ADD_INDEX
= 12,
229 RELAYD_SEND_INDEX
= 13,
230 RELAYD_CLOSE_INDEX
= 14,
231 /* Live-reading commands (2.4+). */
232 RELAYD_LIST_SESSIONS
= 15,
233 /* All streams of the channel have been sent to the relayd (2.4+). */
234 RELAYD_STREAMS_SENT
= 16,
235 /* Ask the relay to reset the metadata trace file (2.8+) */
236 RELAYD_RESET_METADATA
= 17,
237 /* Ask the relay to rotate a set of stream files (2.11+) */
238 RELAYD_ROTATE_STREAMS
= 18,
239 /* Ask the relay to create a trace chunk (2.11+) */
240 RELAYD_CREATE_TRACE_CHUNK
= 19,
241 /* Ask the relay to close a trace chunk (2.11+) */
242 RELAYD_CLOSE_TRACE_CHUNK
= 20,
243 /* Ask the relay whether a trace chunk exists (2.11+) */
244 RELAYD_TRACE_CHUNK_EXISTS
= 21,
245 /* Get the current configuration of a relayd peer (2.12+) */
246 RELAYD_GET_CONFIGURATION
= 22,
248 /* Feature branch specific commands start at 10000. */
252 * lttcomm error code.
254 enum lttcomm_return_code
{
255 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
257 * Some code paths use -1 to express an error, others
258 * negate this consumer return code. Starting codes at
259 * 100 ensures there is no mix-up between this error value
260 * and legitimate status codes.
262 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 100, /* Command socket ready */
263 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
264 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
265 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
266 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
267 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
268 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
269 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
270 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
271 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
272 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
273 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
274 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
275 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
276 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
277 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
278 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
279 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
280 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
281 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
282 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
283 LTTCOMM_CONSUMERD_ROTATION_FAIL
, /* Rotation has failed. */
284 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
, /* snapshot has failed. */
285 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
,/* Trace chunk creation failed. */
286 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
, /* Trace chunk creation failed. */
287 LTTCOMM_CONSUMERD_INVALID_PARAMETERS
, /* Invalid parameters. */
288 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
, /* Trace chunk exists on consumer daemon. */
289 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
,/* Trace chunk exists on relay daemon. */
290 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
, /* Unknown trace chunk. */
291 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
, /* Relayd does not accept clear command. */
292 LTTCOMM_CONSUMERD_UNKNOWN_ERROR
, /* Unknown error. */
294 /* MUST be last element */
295 LTTCOMM_NR
, /* Last element */
298 /* lttng socket protocol. */
299 enum lttcomm_sock_proto
{
305 * Index in the net_families array below. Please keep in sync!
307 enum lttcomm_sock_domain
{
312 enum lttcomm_metadata_command
{
313 LTTCOMM_METADATA_REQUEST
= 1,
317 * Commands sent from the consumerd to the sessiond to request if new metadata
318 * is available. This message is used to find the per UID _or_ per PID registry
319 * for the channel key. For per UID lookup, the triplet
320 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
321 * per PID registry indexed by session id ignoring the other values.
323 struct lttcomm_metadata_request_msg
{
324 uint64_t session_id
; /* Tracing session id */
325 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
326 uint32_t bits_per_long
; /* Consumer ABI */
328 uint64_t key
; /* Metadata channel key. */
331 struct lttcomm_sockaddr
{
332 enum lttcomm_sock_domain type
;
334 struct sockaddr_in sin
;
335 struct sockaddr_in6 sin6
;
339 struct lttcomm_sock
{
341 enum lttcomm_sock_proto proto
;
342 struct lttcomm_sockaddr sockaddr
;
343 const struct lttcomm_proto_ops
*ops
;
347 * Relayd sock. Adds the protocol version to use for the communications with
350 struct lttcomm_relayd_sock
{
351 struct lttcomm_sock sock
;
356 struct lttcomm_net_family
{
358 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
361 struct lttcomm_proto_ops
{
362 int (*bind
) (struct lttcomm_sock
*sock
);
363 int (*close
) (struct lttcomm_sock
*sock
);
364 int (*connect
) (struct lttcomm_sock
*sock
);
365 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
366 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
367 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
369 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
370 size_t len
, int flags
);
373 struct process_attr_integral_value_comm
{
381 * Data structure received from lttng client to session daemon.
383 struct lttcomm_session_msg
{
384 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
385 struct lttng_session session
;
386 struct lttng_domain domain
;
390 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
392 } LTTNG_PACKED enable
;
394 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
396 } LTTNG_PACKED disable
;
400 } LTTNG_PACKED channel
;
403 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
405 } LTTNG_PACKED context
;
406 /* Use by register_consumer */
412 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
414 struct lttng_calibrate calibrate
;
415 /* Used by the set_consumer_url and used by create_session also call */
417 /* Number of lttng_uri following */
421 struct lttng_snapshot_output output
;
422 } LTTNG_PACKED snapshot_output
;
425 struct lttng_snapshot_output output
;
426 } LTTNG_PACKED snapshot_record
;
429 unsigned int timer_interval
; /* usec */
430 } LTTNG_PACKED session_live
;
432 struct lttng_save_session_attr attr
;
433 } LTTNG_PACKED save_session
;
435 char shm_path
[PATH_MAX
];
436 } LTTNG_PACKED set_shm_path
;
438 /* enum lttng_process_attr */
439 int32_t process_attr
;
440 /* enum lttng_process_attr_value_type */
443 struct process_attr_integral_value_comm integral_value
;
445 * For user/group names, a variable length,
446 * zero-terminated, string of length 'name_len'
447 * (including the terminator) follows.
449 * integral_value should not be used in those cases.
452 } LTTNG_PACKED process_attr_tracker_add_remove_include_value
;
454 /* enum lttng_process_attr */
455 int32_t process_attr
;
456 } LTTNG_PACKED process_attr_tracker_get_inclusion_set
;
458 /* enum lttng_process_attr */
459 int32_t process_attr
;
460 } LTTNG_PACKED process_attr_tracker_get_tracking_policy
;
462 /* enum lttng_process_attr */
463 int32_t process_attr
;
464 /* enum lttng_tracking_policy */
465 int32_t tracking_policy
;
466 } LTTNG_PACKED process_attr_tracker_set_tracking_policy
;
469 uint8_t is_trigger_anonymous
;
470 } LTTNG_PACKED trigger
;
473 } LTTNG_PACKED error_query
;
475 uint64_t rotation_id
;
476 } LTTNG_PACKED get_rotation_info
;
478 /* enum lttng_rotation_schedule_type */
481 * If set == 1, set schedule to value, if set == 0,
482 * clear this schedule type.
486 } LTTNG_PACKED rotation_set_schedule
;
489 * Includes the null-terminator.
490 * Must be an absolute path.
492 * Size bounded by LTTNG_PATH_MAX.
494 uint16_t home_dir_size
;
495 uint64_t session_descriptor_size
;
496 /* An lttng_session_descriptor follows. */
497 } LTTNG_PACKED create_session
;
499 /* Count of fds sent. */
503 #define LTTNG_FILTER_MAX_LEN 65536
504 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
507 * Filter bytecode data. The reloc table is located at the end of the
508 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
509 * starts at reloc_table_offset.
511 #define LTTNG_FILTER_PADDING 32
512 struct lttng_bytecode
{
513 uint32_t len
; /* len of data */
514 uint32_t reloc_table_offset
;
516 char padding
[LTTNG_FILTER_PADDING
];
521 * Event exclusion data. At the end of the structure, there will actually
522 * by zero or more names, where the actual number of names is given by
523 * the 'count' item of the structure.
525 #define LTTNG_EVENT_EXCLUSION_PADDING 32
526 struct lttng_event_exclusion
{
528 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
529 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
532 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
533 (&(_exclusion)->names[_i][0])
536 * Listing command header.
538 struct lttcomm_list_command_header
{
539 /* Number of elements */
544 * Event extended info header. This is the structure preceding each
545 * extended info data.
547 struct lttcomm_event_extended_header
{
549 * Size of filter string immediately following this header.
550 * This size includes the terminal null character.
555 * Number of exclusion names, immediately following the filter
556 * string. Each exclusion name has a fixed length of
557 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
560 uint32_t nb_exclusions
;
563 * Size of the event's userspace probe location (if applicable).
565 uint32_t userspace_probe_location_len
;
569 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
571 struct lttcomm_session_destroy_command_header
{
572 /* enum lttng_session */
573 int32_t rotation_state
;
577 * tracker command header.
579 struct lttcomm_tracker_command_header
{
580 uint32_t nb_tracker_id
;
584 * Data structure for the response from sessiond to the lttng client.
586 struct lttcomm_lttng_msg
{
587 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
588 uint32_t ret_code
; /* enum lttcomm_return_code */
589 uint32_t pid
; /* pid_t */
590 uint32_t cmd_header_size
;
595 struct lttcomm_lttng_output_id
{
600 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
601 * to either add a channel, add a stream, update a stream, or stop
604 struct lttcomm_consumer_msg
{
605 uint32_t cmd_type
; /* enum lttng_consumer_command */
608 uint64_t channel_key
;
610 /* ID of the session's current trace chunk. */
611 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
612 char pathname
[PATH_MAX
];
614 /* nb_init_streams is the number of streams open initially. */
615 uint32_t nb_init_streams
;
616 char name
[LTTNG_SYMBOL_NAME_LEN
];
617 /* Use splice or mmap to consume this fd */
618 enum lttng_event_output output
;
619 int type
; /* Per cpu or metadata. */
620 uint64_t tracefile_size
; /* bytes */
621 uint32_t tracefile_count
; /* number of tracefiles */
622 /* If the channel's streams have to be monitored or not. */
624 /* timer to check the streams usage in live mode (usec). */
625 unsigned int live_timer_interval
;
626 /* is part of a live session */
628 /* timer to sample a channel's positions (usec). */
629 unsigned int monitor_timer_interval
;
630 } LTTNG_PACKED channel
; /* Only used by Kernel. */
633 uint64_t channel_key
;
634 int32_t cpu
; /* On which CPU this stream is assigned. */
635 /* Tells the consumer if the stream should be or not monitored. */
637 } LTTNG_PACKED stream
; /* Only used by Kernel. */
640 enum lttng_stream_type type
;
643 uint8_t relayd_socket_protocol
;
644 /* Tracing session id associated to the relayd. */
646 /* Relayd session id, only used with control socket. */
647 uint64_t relayd_session_id
;
648 } LTTNG_PACKED relayd_sock
;
650 uint64_t net_seq_idx
;
651 } LTTNG_PACKED destroy_relayd
;
654 } LTTNG_PACKED data_pending
;
656 uint64_t subbuf_size
; /* bytes */
657 uint64_t num_subbuf
; /* power of 2 */
658 int32_t overwrite
; /* 1: overwrite, 0: discard */
659 uint32_t switch_timer_interval
; /* usec */
660 uint32_t read_timer_interval
; /* usec */
661 unsigned int live_timer_interval
; /* usec */
662 uint8_t is_live
; /* is part of a live session */
663 uint32_t monitor_timer_interval
; /* usec */
664 int32_t output
; /* splice, mmap */
665 int32_t type
; /* metadata or per_cpu */
666 uint64_t session_id
; /* Tracing session id */
667 char pathname
[PATH_MAX
]; /* Channel file path. */
668 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
669 /* Credentials used to open the UST buffer shared mappings. */
673 } LTTNG_PACKED buffer_credentials
;
674 uint64_t relayd_id
; /* Relayd id if apply. */
675 uint64_t key
; /* Unique channel key. */
676 /* ID of the session's current trace chunk. */
677 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
678 unsigned char uuid
[LTTNG_UUID_LEN
]; /* uuid for ust tracer. */
679 uint32_t chan_id
; /* Channel ID on the tracer side. */
680 uint64_t tracefile_size
; /* bytes */
681 uint32_t tracefile_count
; /* number of tracefiles */
682 uint64_t session_id_per_pid
; /* Per-pid session ID. */
683 /* Tells the consumer if the stream should be or not monitored. */
686 * For UST per UID buffers, this is the application UID of the
687 * channel. This can be different from the user UID requesting the
688 * channel creation and used for the rights on the stream file
689 * because the application can be in the tracing for instance.
691 uint32_t ust_app_uid
;
692 int64_t blocking_timeout
;
693 char root_shm_path
[PATH_MAX
];
694 char shm_path
[PATH_MAX
];
695 } LTTNG_PACKED ask_channel
;
698 } LTTNG_PACKED get_channel
;
701 } LTTNG_PACKED destroy_channel
;
703 uint64_t key
; /* Metadata channel key. */
704 uint64_t target_offset
; /* Offset in the consumer */
705 uint64_t len
; /* Length of metadata to be received. */
706 uint64_t version
; /* Version of the metadata. */
707 } LTTNG_PACKED push_metadata
;
709 uint64_t key
; /* Metadata channel key. */
710 } LTTNG_PACKED close_metadata
;
712 uint64_t key
; /* Metadata channel key. */
713 } LTTNG_PACKED setup_metadata
;
715 uint64_t key
; /* Channel key. */
716 } LTTNG_PACKED flush_channel
;
718 uint64_t key
; /* Channel key. */
719 } LTTNG_PACKED clear_quiescent_channel
;
721 char pathname
[PATH_MAX
];
722 /* Indicate if the snapshot goes on the relayd or locally. */
724 uint32_t metadata
; /* This a metadata snapshot. */
725 uint64_t relayd_id
; /* Relayd id if apply. */
727 uint64_t nb_packets_per_stream
;
728 } LTTNG_PACKED snapshot_channel
;
730 uint64_t channel_key
;
731 uint64_t net_seq_idx
;
732 } LTTNG_PACKED sent_streams
;
735 uint64_t channel_key
;
736 } LTTNG_PACKED discarded_events
;
739 uint64_t channel_key
;
740 } LTTNG_PACKED lost_packets
;
743 } LTTNG_PACKED regenerate_metadata
;
745 uint32_t metadata
; /* This is a metadata channel. */
746 uint64_t relayd_id
; /* Relayd id if apply. */
748 } LTTNG_PACKED rotate_channel
;
752 } LTTNG_PACKED check_rotation_pending_local
;
757 } LTTNG_PACKED check_rotation_pending_relay
;
760 * Relayd id, if applicable (remote).
762 * A directory file descriptor referring to the chunk's
763 * output folder is transmitted if the chunk is local
766 * `override_name` is left NULL (all-zeroes) if the
767 * chunk's name is not overridden.
769 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
770 char override_name
[LTTNG_NAME_MAX
];
773 uint64_t creation_timestamp
;
774 LTTNG_OPTIONAL_COMM(struct {
777 } LTTNG_PACKED
) LTTNG_PACKED credentials
;
778 } LTTNG_PACKED create_trace_chunk
;
780 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
783 uint64_t close_timestamp
;
784 /* enum lttng_trace_chunk_command_type */
785 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
786 } LTTNG_PACKED close_trace_chunk
;
788 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
791 } LTTNG_PACKED trace_chunk_exists
;
793 lttng_uuid sessiond_uuid
;
797 } LTTNG_PACKED clear_channel
;
800 } LTTNG_PACKED open_channel_packets
;
805 * Channel monitoring message returned to the session daemon on every
806 * monitor timer expiration.
808 struct lttcomm_consumer_channel_monitor_msg
{
809 /* Key of the sampled channel. */
812 * Lowest and highest usage (bytes) at the moment the sample was taken.
814 uint64_t lowest
, highest
;
816 * Sum of all the consumed positions for a channel.
818 uint64_t total_consumed
;
822 * Status message returned to the sessiond after a received command.
824 struct lttcomm_consumer_status_msg
{
825 enum lttcomm_return_code ret_code
;
828 struct lttcomm_consumer_status_channel
{
829 enum lttcomm_return_code ret_code
;
831 unsigned int stream_count
;
834 struct lttcomm_consumer_close_trace_chunk_reply
{
835 enum lttcomm_return_code ret_code
;
836 uint32_t path_length
;
840 #ifdef HAVE_LIBLTTNG_UST_CTL
842 #include <lttng/ust-abi.h>
845 * Data structure for the commands sent from sessiond to UST.
847 struct lttcomm_ust_msg
{
851 struct lttng_ust_abi_channel channel
;
852 struct lttng_ust_abi_stream stream
;
853 struct lttng_ust_abi_event event
;
854 struct lttng_ust_abi_context context
;
855 struct lttng_ust_abi_tracer_version version
;
860 * Data structure for the response from UST to the session daemon.
861 * cmd_type is sent back in the reply for validation.
863 struct lttcomm_ust_reply
{
866 uint32_t ret_code
; /* enum lttcomm_return_code */
867 uint32_t ret_val
; /* return value */
870 uint64_t memory_map_size
;
871 } LTTNG_PACKED channel
;
873 uint64_t memory_map_size
;
874 } LTTNG_PACKED stream
;
875 struct lttng_ust_abi_tracer_version version
;
879 #endif /* HAVE_LIBLTTNG_UST_CTL */
881 LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
883 LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
884 const char *ip
, unsigned int port
);
885 LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
886 const char *ip
, unsigned int port
);
888 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
889 LTTNG_HIDDEN
int lttcomm_populate_sock_from_open_socket(struct lttcomm_sock
*sock
,
891 enum lttcomm_sock_proto protocol
);
892 LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock
*sock
);
893 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
894 LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
895 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
896 LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
897 struct lttcomm_sock
*src
);
899 /* Relayd socket object. */
900 LTTNG_HIDDEN
struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
901 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
903 LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
904 LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
906 LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
909 * Set a port to an lttcomm_sock. This will have no effect is the socket is
912 LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
914 LTTNG_HIDDEN
void lttcomm_init(void);
915 /* Get network timeout, in milliseconds */
916 LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void);
918 #endif /* _LTTNG_SESSIOND_COMM_H */