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>
6 * SPDX-License-Identifier: GPL-2.0-only
11 * This header is meant for liblttng and libust internal use ONLY. These
12 * declarations should NOT be considered stable API.
15 #ifndef _LTTNG_SESSIOND_COMM_H
16 #define _LTTNG_SESSIOND_COMM_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>
32 #include <arpa/inet.h>
33 #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
{
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,
66 /* Session daemon command */
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,
80 LTTNG_DISABLE_CONSUMER
= 19,
81 LTTNG_ENABLE_CONSUMER
= 20,
82 LTTNG_SET_CONSUMER_URI
= 21,
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,
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 LTTNG_EXECUTE_ERROR_QUERY
= 52,
114 const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd
)
117 case LTTNG_ADD_CONTEXT
:
118 return "LTTNG_ADD_CONTEXT";
119 case LTTNG_DISABLE_CHANNEL
:
120 return "LTTNG_DISABLE_CHANNEL";
121 case LTTNG_DISABLE_EVENT
:
122 return "LTTNG_DISABLE_EVENT";
123 case LTTNG_LIST_SYSCALLS
:
124 return "LTTNG_LIST_SYSCALLS";
125 case LTTNG_ENABLE_CHANNEL
:
126 return "LTTNG_ENABLE_CHANNEL";
127 case LTTNG_ENABLE_EVENT
:
128 return "LTTNG_ENABLE_EVENT";
129 case LTTNG_DESTROY_SESSION
:
130 return "LTTNG_DESTROY_SESSION";
131 case LTTNG_LIST_CHANNELS
:
132 return "LTTNG_LIST_CHANNELS";
133 case LTTNG_LIST_DOMAINS
:
134 return "LTTNG_LIST_DOMAINS";
135 case LTTNG_LIST_EVENTS
:
136 return "LTTNG_LIST_EVENTS";
137 case LTTNG_LIST_SESSIONS
:
138 return "LTTNG_LIST_SESSIONS";
139 case LTTNG_LIST_TRACEPOINTS
:
140 return "LTTNG_LIST_TRACEPOINTS";
141 case LTTNG_REGISTER_CONSUMER
:
142 return "LTTNG_REGISTER_CONSUMER";
143 case LTTNG_START_TRACE
:
144 return "LTTNG_START_TRACE";
145 case LTTNG_STOP_TRACE
:
146 return "LTTNG_STOP_TRACE";
147 case LTTNG_LIST_TRACEPOINT_FIELDS
:
148 return "LTTNG_LIST_TRACEPOINT_FIELDS";
149 case LTTNG_DISABLE_CONSUMER
:
150 return "LTTNG_DISABLE_CONSUMER";
151 case LTTNG_ENABLE_CONSUMER
:
152 return "LTTNG_ENABLE_CONSUMER";
153 case LTTNG_SET_CONSUMER_URI
:
154 return "LTTNG_SET_CONSUMER_URI";
155 case LTTNG_DATA_PENDING
:
156 return "LTTNG_DATA_PENDING";
157 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
158 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
159 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
160 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
161 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
162 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
163 case LTTNG_SNAPSHOT_RECORD
:
164 return "LTTNG_SNAPSHOT_RECORD";
165 case LTTNG_SAVE_SESSION
:
166 return "LTTNG_SAVE_SESSION";
167 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
168 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
169 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
170 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
171 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
172 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
173 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
174 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
175 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
176 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
177 case LTTNG_SET_SESSION_SHM_PATH
:
178 return "LTTNG_SET_SESSION_SHM_PATH";
179 case LTTNG_REGENERATE_METADATA
:
180 return "LTTNG_REGENERATE_METADATA";
181 case LTTNG_REGENERATE_STATEDUMP
:
182 return "LTTNG_REGENERATE_STATEDUMP";
183 case LTTNG_REGISTER_TRIGGER
:
184 return "LTTNG_REGISTER_TRIGGER";
185 case LTTNG_UNREGISTER_TRIGGER
:
186 return "LTTNG_UNREGISTER_TRIGGER";
187 case LTTNG_ROTATE_SESSION
:
188 return "LTTNG_ROTATE_SESSION";
189 case LTTNG_ROTATION_GET_INFO
:
190 return "LTTNG_ROTATION_GET_INFO";
191 case LTTNG_ROTATION_SET_SCHEDULE
:
192 return "LTTNG_ROTATION_SET_SCHEDULE";
193 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
194 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
195 case LTTNG_CREATE_SESSION_EXT
:
196 return "LTTNG_CREATE_SESSION_EXT";
197 case LTTNG_CLEAR_SESSION
:
198 return "LTTNG_CLEAR_SESSION";
199 case LTTNG_LIST_TRIGGERS
:
200 return "LTTNG_LIST_TRIGGERS";
201 case LTTNG_EXECUTE_ERROR_QUERY
:
202 return "LTTNG_EXECUTE_ERROR_QUERY";
208 enum lttcomm_relayd_command
{
209 RELAYD_ADD_STREAM
= 1,
210 RELAYD_CREATE_SESSION
= 2,
211 RELAYD_START_DATA
= 3,
212 RELAYD_UPDATE_SYNC_INFO
= 4,
214 RELAYD_SEND_METADATA
= 6,
215 RELAYD_CLOSE_STREAM
= 7,
216 RELAYD_DATA_PENDING
= 8,
217 RELAYD_QUIESCENT_CONTROL
= 9,
218 RELAYD_BEGIN_DATA_PENDING
= 10,
219 RELAYD_END_DATA_PENDING
= 11,
220 RELAYD_ADD_INDEX
= 12,
221 RELAYD_SEND_INDEX
= 13,
222 RELAYD_CLOSE_INDEX
= 14,
223 /* Live-reading commands (2.4+). */
224 RELAYD_LIST_SESSIONS
= 15,
225 /* All streams of the channel have been sent to the relayd (2.4+). */
226 RELAYD_STREAMS_SENT
= 16,
227 /* Ask the relay to reset the metadata trace file (2.8+) */
228 RELAYD_RESET_METADATA
= 17,
229 /* Ask the relay to rotate a set of stream files (2.11+) */
230 RELAYD_ROTATE_STREAMS
= 18,
231 /* Ask the relay to create a trace chunk (2.11+) */
232 RELAYD_CREATE_TRACE_CHUNK
= 19,
233 /* Ask the relay to close a trace chunk (2.11+) */
234 RELAYD_CLOSE_TRACE_CHUNK
= 20,
235 /* Ask the relay whether a trace chunk exists (2.11+) */
236 RELAYD_TRACE_CHUNK_EXISTS
= 21,
237 /* Get the current configuration of a relayd peer (2.12+) */
238 RELAYD_GET_CONFIGURATION
= 22,
240 /* Feature branch specific commands start at 10000. */
244 * lttcomm error code.
246 enum lttcomm_return_code
{
247 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
249 * Some code paths use -1 to express an error, others
250 * negate this consumer return code. Starting codes at
251 * 100 ensures there is no mix-up between this error value
252 * and legitimate status codes.
254 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 100, /* Command socket ready */
255 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
256 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
257 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
258 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
259 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
260 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
261 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
262 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
263 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
264 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
265 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
266 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
267 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
268 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
269 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
270 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
271 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
272 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
273 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
274 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
275 LTTCOMM_CONSUMERD_ROTATION_FAIL
, /* Rotation has failed. */
276 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
, /* snapshot has failed. */
277 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
,/* Trace chunk creation failed. */
278 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
, /* Trace chunk creation failed. */
279 LTTCOMM_CONSUMERD_INVALID_PARAMETERS
, /* Invalid parameters. */
280 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
, /* Trace chunk exists on consumer daemon. */
281 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
,/* Trace chunk exists on relay daemon. */
282 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
, /* Unknown trace chunk. */
283 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
, /* Relayd does not accept clear command. */
284 LTTCOMM_CONSUMERD_UNKNOWN_ERROR
, /* Unknown error. */
286 /* MUST be last element */
287 LTTCOMM_NR
, /* Last element */
290 /* lttng socket protocol. */
291 enum lttcomm_sock_proto
{
297 * Index in the net_families array below. Please keep in sync!
299 enum lttcomm_sock_domain
{
304 enum lttcomm_metadata_command
{
305 LTTCOMM_METADATA_REQUEST
= 1,
309 * Commands sent from the consumerd to the sessiond to request if new metadata
310 * is available. This message is used to find the per UID _or_ per PID registry
311 * for the channel key. For per UID lookup, the triplet
312 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
313 * per PID registry indexed by session id ignoring the other values.
315 struct lttcomm_metadata_request_msg
{
316 uint64_t session_id
; /* Tracing session id */
317 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
318 uint32_t bits_per_long
; /* Consumer ABI */
320 uint64_t key
; /* Metadata channel key. */
323 struct lttcomm_sockaddr
{
324 enum lttcomm_sock_domain type
;
326 struct sockaddr_in sin
;
327 struct sockaddr_in6 sin6
;
331 struct lttcomm_sock
{
333 enum lttcomm_sock_proto proto
;
334 struct lttcomm_sockaddr sockaddr
;
335 const struct lttcomm_proto_ops
*ops
;
339 * Relayd sock. Adds the protocol version to use for the communications with
342 struct lttcomm_relayd_sock
{
343 struct lttcomm_sock sock
;
348 struct lttcomm_net_family
{
350 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
353 struct lttcomm_proto_ops
{
354 int (*bind
) (struct lttcomm_sock
*sock
);
355 int (*close
) (struct lttcomm_sock
*sock
);
356 int (*connect
) (struct lttcomm_sock
*sock
);
357 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
358 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
359 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
361 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
362 size_t len
, int flags
);
365 struct process_attr_integral_value_comm
{
373 * Data structure received from lttng client to session daemon.
375 struct lttcomm_session_msg
{
376 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
377 struct lttng_session session
;
378 struct lttng_domain domain
;
382 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
383 struct lttng_event event
;
384 /* Length of following filter expression. */
385 uint32_t expression_len
;
386 /* Length of following bytecode for filter. */
387 uint32_t bytecode_len
;
388 /* Exclusion count (fixed-size strings). */
389 uint32_t exclusion_count
;
390 /* Userspace probe location size. */
391 uint32_t userspace_probe_location_len
;
393 * After this structure, the following variable-length
394 * items are transmitted:
395 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
396 * - char filter_expression[expression_len]
397 * - unsigned char filter_bytecode[bytecode_len]
399 } LTTNG_PACKED enable
;
401 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
402 struct lttng_event event
;
403 /* Length of following filter expression. */
404 uint32_t expression_len
;
405 /* Length of following bytecode for filter. */
406 uint32_t bytecode_len
;
408 * After this structure, the following variable-length
409 * items are transmitted:
410 * - unsigned char filter_expression[expression_len]
411 * - unsigned char filter_bytecode[bytecode_len]
413 } LTTNG_PACKED disable
;
416 struct lttng_channel chan
;
417 struct lttng_channel_extended extended
;
418 } LTTNG_PACKED channel
;
421 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
422 struct lttng_event_context ctx
;
423 uint32_t provider_name_len
;
424 uint32_t context_name_len
;
425 } LTTNG_PACKED context
;
426 /* Use by register_consumer */
432 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
434 struct lttng_calibrate calibrate
;
435 /* Used by the set_consumer_url and used by create_session also call */
437 /* Number of lttng_uri following */
441 struct lttng_snapshot_output output
;
442 } LTTNG_PACKED snapshot_output
;
445 struct lttng_snapshot_output output
;
446 } LTTNG_PACKED snapshot_record
;
449 unsigned int timer_interval
; /* usec */
450 } LTTNG_PACKED session_live
;
452 struct lttng_save_session_attr attr
;
453 } LTTNG_PACKED save_session
;
455 char shm_path
[PATH_MAX
];
456 } LTTNG_PACKED set_shm_path
;
458 /* enum lttng_process_attr */
459 int32_t process_attr
;
460 /* enum lttng_process_attr_value_type */
463 struct process_attr_integral_value_comm integral_value
;
465 * For user/group names, a variable length,
466 * zero-terminated, string of length 'name_len'
467 * (including the terminator) follows.
469 * integral_value should not be used in those cases.
472 } LTTNG_PACKED process_attr_tracker_add_remove_include_value
;
474 /* enum lttng_process_attr */
475 int32_t process_attr
;
476 } LTTNG_PACKED process_attr_tracker_get_inclusion_set
;
478 /* enum lttng_process_attr */
479 int32_t process_attr
;
480 } LTTNG_PACKED process_attr_tracker_get_tracking_policy
;
482 /* enum lttng_process_attr */
483 int32_t process_attr
;
484 /* enum lttng_tracking_policy */
485 int32_t tracking_policy
;
486 } LTTNG_PACKED process_attr_tracker_set_tracking_policy
;
489 } LTTNG_PACKED trigger
;
492 } LTTNG_PACKED error_query
;
494 uint64_t rotation_id
;
495 } LTTNG_PACKED get_rotation_info
;
497 /* enum lttng_rotation_schedule_type */
500 * If set == 1, set schedule to value, if set == 0,
501 * clear this schedule type.
505 } LTTNG_PACKED rotation_set_schedule
;
508 * Includes the null-terminator.
509 * Must be an absolute path.
511 * Size bounded by LTTNG_PATH_MAX.
513 uint16_t home_dir_size
;
514 uint64_t session_descriptor_size
;
515 /* An lttng_session_descriptor follows. */
516 } LTTNG_PACKED create_session
;
518 /* Count of fds sent. */
522 #define LTTNG_FILTER_MAX_LEN 65536
523 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
526 * Filter bytecode data. The reloc table is located at the end of the
527 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
528 * starts at reloc_table_offset.
530 #define LTTNG_FILTER_PADDING 32
531 struct lttng_bytecode
{
532 uint32_t len
; /* len of data */
533 uint32_t reloc_table_offset
;
535 char padding
[LTTNG_FILTER_PADDING
];
540 * Event exclusion data. At the end of the structure, there will actually
541 * by zero or more names, where the actual number of names is given by
542 * the 'count' item of the structure.
544 #define LTTNG_EVENT_EXCLUSION_PADDING 32
545 struct lttng_event_exclusion
{
547 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
548 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
551 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
552 (&(_exclusion)->names[_i][0])
555 * Event command header.
557 struct lttcomm_event_command_header
{
558 /* Number of events */
563 * Event extended info header. This is the structure preceding each
564 * extended info data.
566 struct lttcomm_event_extended_header
{
568 * Size of filter string immediately following this header.
569 * This size includes the terminal null character.
574 * Number of exclusion names, immediately following the filter
575 * string. Each exclusion name has a fixed length of
576 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
579 uint32_t nb_exclusions
;
582 * Size of the event's userspace probe location (if applicable).
584 uint32_t userspace_probe_location_len
;
588 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
590 struct lttcomm_session_destroy_command_header
{
591 /* enum lttng_session */
592 int32_t rotation_state
;
596 * tracker command header.
598 struct lttcomm_tracker_command_header
{
599 uint32_t nb_tracker_id
;
603 * Data structure for the response from sessiond to the lttng client.
605 struct lttcomm_lttng_msg
{
606 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
607 uint32_t ret_code
; /* enum lttcomm_return_code */
608 uint32_t pid
; /* pid_t */
609 uint32_t cmd_header_size
;
614 struct lttcomm_lttng_output_id
{
619 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
620 * to either add a channel, add a stream, update a stream, or stop
623 struct lttcomm_consumer_msg
{
624 uint32_t cmd_type
; /* enum lttng_consumer_command */
627 uint64_t channel_key
;
629 /* ID of the session's current trace chunk. */
630 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
631 char pathname
[PATH_MAX
];
633 /* nb_init_streams is the number of streams open initially. */
634 uint32_t nb_init_streams
;
635 char name
[LTTNG_SYMBOL_NAME_LEN
];
636 /* Use splice or mmap to consume this fd */
637 enum lttng_event_output output
;
638 int type
; /* Per cpu or metadata. */
639 uint64_t tracefile_size
; /* bytes */
640 uint32_t tracefile_count
; /* number of tracefiles */
641 /* If the channel's streams have to be monitored or not. */
643 /* timer to check the streams usage in live mode (usec). */
644 unsigned int live_timer_interval
;
645 /* is part of a live session */
647 /* timer to sample a channel's positions (usec). */
648 unsigned int monitor_timer_interval
;
649 } LTTNG_PACKED channel
; /* Only used by Kernel. */
652 uint64_t channel_key
;
653 int32_t cpu
; /* On which CPU this stream is assigned. */
654 /* Tells the consumer if the stream should be or not monitored. */
656 } LTTNG_PACKED stream
; /* Only used by Kernel. */
659 enum lttng_stream_type type
;
660 /* Open socket to the relayd */
661 struct lttcomm_relayd_sock sock
;
662 /* Tracing session id associated to the relayd. */
664 /* Relayd session id, only used with control socket. */
665 uint64_t relayd_session_id
;
666 } LTTNG_PACKED relayd_sock
;
668 uint64_t net_seq_idx
;
669 } LTTNG_PACKED destroy_relayd
;
672 } LTTNG_PACKED data_pending
;
674 uint64_t subbuf_size
; /* bytes */
675 uint64_t num_subbuf
; /* power of 2 */
676 int32_t overwrite
; /* 1: overwrite, 0: discard */
677 uint32_t switch_timer_interval
; /* usec */
678 uint32_t read_timer_interval
; /* usec */
679 unsigned int live_timer_interval
; /* usec */
680 uint8_t is_live
; /* is part of a live session */
681 uint32_t monitor_timer_interval
; /* usec */
682 int32_t output
; /* splice, mmap */
683 int32_t type
; /* metadata or per_cpu */
684 uint64_t session_id
; /* Tracing session id */
685 char pathname
[PATH_MAX
]; /* Channel file path. */
686 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
687 /* Credentials used to open the UST buffer shared mappings. */
691 } LTTNG_PACKED buffer_credentials
;
692 uint64_t relayd_id
; /* Relayd id if apply. */
693 uint64_t key
; /* Unique channel key. */
694 /* ID of the session's current trace chunk. */
695 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
696 unsigned char uuid
[LTTNG_UUID_LEN
]; /* uuid for ust tracer. */
697 uint32_t chan_id
; /* Channel ID on the tracer side. */
698 uint64_t tracefile_size
; /* bytes */
699 uint32_t tracefile_count
; /* number of tracefiles */
700 uint64_t session_id_per_pid
; /* Per-pid session ID. */
701 /* Tells the consumer if the stream should be or not monitored. */
704 * For UST per UID buffers, this is the application UID of the
705 * channel. This can be different from the user UID requesting the
706 * channel creation and used for the rights on the stream file
707 * because the application can be in the tracing for instance.
709 uint32_t ust_app_uid
;
710 int64_t blocking_timeout
;
711 char root_shm_path
[PATH_MAX
];
712 char shm_path
[PATH_MAX
];
713 } LTTNG_PACKED ask_channel
;
716 } LTTNG_PACKED get_channel
;
719 } LTTNG_PACKED destroy_channel
;
721 uint64_t key
; /* Metadata channel key. */
722 uint64_t target_offset
; /* Offset in the consumer */
723 uint64_t len
; /* Length of metadata to be received. */
724 uint64_t version
; /* Version of the metadata. */
725 } LTTNG_PACKED push_metadata
;
727 uint64_t key
; /* Metadata channel key. */
728 } LTTNG_PACKED close_metadata
;
730 uint64_t key
; /* Metadata channel key. */
731 } LTTNG_PACKED setup_metadata
;
733 uint64_t key
; /* Channel key. */
734 } LTTNG_PACKED flush_channel
;
736 uint64_t key
; /* Channel key. */
737 } LTTNG_PACKED clear_quiescent_channel
;
739 char pathname
[PATH_MAX
];
740 /* Indicate if the snapshot goes on the relayd or locally. */
742 uint32_t metadata
; /* This a metadata snapshot. */
743 uint64_t relayd_id
; /* Relayd id if apply. */
745 uint64_t nb_packets_per_stream
;
746 } LTTNG_PACKED snapshot_channel
;
748 uint64_t channel_key
;
749 uint64_t net_seq_idx
;
750 } LTTNG_PACKED sent_streams
;
753 uint64_t channel_key
;
754 } LTTNG_PACKED discarded_events
;
757 uint64_t channel_key
;
758 } LTTNG_PACKED lost_packets
;
761 } LTTNG_PACKED regenerate_metadata
;
763 uint32_t metadata
; /* This is a metadata channel. */
764 uint64_t relayd_id
; /* Relayd id if apply. */
766 } LTTNG_PACKED rotate_channel
;
770 } LTTNG_PACKED check_rotation_pending_local
;
775 } LTTNG_PACKED check_rotation_pending_relay
;
778 * Relayd id, if applicable (remote).
780 * A directory file descriptor referring to the chunk's
781 * output folder is transmitted if the chunk is local
784 * `override_name` is left NULL (all-zeroes) if the
785 * chunk's name is not overridden.
787 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
788 char override_name
[LTTNG_NAME_MAX
];
791 uint64_t creation_timestamp
;
792 LTTNG_OPTIONAL_COMM(struct {
795 } LTTNG_PACKED
) LTTNG_PACKED credentials
;
796 } LTTNG_PACKED create_trace_chunk
;
798 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
801 uint64_t close_timestamp
;
802 /* enum lttng_trace_chunk_command_type */
803 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
804 } LTTNG_PACKED close_trace_chunk
;
806 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
809 } LTTNG_PACKED trace_chunk_exists
;
811 lttng_uuid sessiond_uuid
;
815 } LTTNG_PACKED clear_channel
;
818 } LTTNG_PACKED open_channel_packets
;
823 * Channel monitoring message returned to the session daemon on every
824 * monitor timer expiration.
826 struct lttcomm_consumer_channel_monitor_msg
{
827 /* Key of the sampled channel. */
830 * Lowest and highest usage (bytes) at the moment the sample was taken.
832 uint64_t lowest
, highest
;
834 * Sum of all the consumed positions for a channel.
836 uint64_t total_consumed
;
840 * Status message returned to the sessiond after a received command.
842 struct lttcomm_consumer_status_msg
{
843 enum lttcomm_return_code ret_code
;
846 struct lttcomm_consumer_status_channel
{
847 enum lttcomm_return_code ret_code
;
849 unsigned int stream_count
;
852 struct lttcomm_consumer_close_trace_chunk_reply
{
853 enum lttcomm_return_code ret_code
;
854 uint32_t path_length
;
858 #ifdef HAVE_LIBLTTNG_UST_CTL
860 #include <lttng/ust-abi.h>
863 * Data structure for the commands sent from sessiond to UST.
865 struct lttcomm_ust_msg
{
869 struct lttng_ust_abi_channel channel
;
870 struct lttng_ust_abi_stream stream
;
871 struct lttng_ust_abi_event event
;
872 struct lttng_ust_abi_context context
;
873 struct lttng_ust_abi_tracer_version version
;
878 * Data structure for the response from UST to the session daemon.
879 * cmd_type is sent back in the reply for validation.
881 struct lttcomm_ust_reply
{
884 uint32_t ret_code
; /* enum lttcomm_return_code */
885 uint32_t ret_val
; /* return value */
888 uint64_t memory_map_size
;
889 } LTTNG_PACKED channel
;
891 uint64_t memory_map_size
;
892 } LTTNG_PACKED stream
;
893 struct lttng_ust_abi_tracer_version version
;
897 #endif /* HAVE_LIBLTTNG_UST_CTL */
899 LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
901 LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
902 const char *ip
, unsigned int port
);
903 LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
904 const char *ip
, unsigned int port
);
906 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
907 LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock
*sock
);
908 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
909 LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
910 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
911 LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
912 struct lttcomm_sock
*src
);
914 /* Relayd socket object. */
915 LTTNG_HIDDEN
struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
916 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
918 LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
919 LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
921 LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
924 * Set a port to an lttcomm_sock. This will have no effect is the socket is
927 LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
929 LTTNG_HIDDEN
void lttcomm_init(void);
930 /* Get network timeout, in milliseconds */
931 LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void);
933 #endif /* _LTTNG_SESSIOND_COMM_H */