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,
111 LTTNG_ENABLE_MAP
= 53,
112 LTTNG_DISABLE_MAP
= 54,
113 LTTNG_LIST_MAPS
= 55,
114 LTTNG_LIST_MAP_VALUES
= 56,
118 const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd
)
121 case LTTNG_ADD_CONTEXT
:
122 return "LTTNG_ADD_CONTEXT";
123 case LTTNG_DISABLE_CHANNEL
:
124 return "LTTNG_DISABLE_CHANNEL";
125 case LTTNG_DISABLE_EVENT
:
126 return "LTTNG_DISABLE_EVENT";
127 case LTTNG_LIST_SYSCALLS
:
128 return "LTTNG_LIST_SYSCALLS";
129 case LTTNG_ENABLE_CHANNEL
:
130 return "LTTNG_ENABLE_CHANNEL";
131 case LTTNG_ENABLE_EVENT
:
132 return "LTTNG_ENABLE_EVENT";
133 case LTTNG_DESTROY_SESSION
:
134 return "LTTNG_DESTROY_SESSION";
135 case LTTNG_LIST_CHANNELS
:
136 return "LTTNG_LIST_CHANNELS";
137 case LTTNG_LIST_DOMAINS
:
138 return "LTTNG_LIST_DOMAINS";
139 case LTTNG_LIST_EVENTS
:
140 return "LTTNG_LIST_EVENTS";
141 case LTTNG_LIST_SESSIONS
:
142 return "LTTNG_LIST_SESSIONS";
143 case LTTNG_LIST_TRACEPOINTS
:
144 return "LTTNG_LIST_TRACEPOINTS";
145 case LTTNG_REGISTER_CONSUMER
:
146 return "LTTNG_REGISTER_CONSUMER";
147 case LTTNG_START_TRACE
:
148 return "LTTNG_START_TRACE";
149 case LTTNG_STOP_TRACE
:
150 return "LTTNG_STOP_TRACE";
151 case LTTNG_LIST_TRACEPOINT_FIELDS
:
152 return "LTTNG_LIST_TRACEPOINT_FIELDS";
153 case LTTNG_DISABLE_CONSUMER
:
154 return "LTTNG_DISABLE_CONSUMER";
155 case LTTNG_ENABLE_CONSUMER
:
156 return "LTTNG_ENABLE_CONSUMER";
157 case LTTNG_SET_CONSUMER_URI
:
158 return "LTTNG_SET_CONSUMER_URI";
159 case LTTNG_DATA_PENDING
:
160 return "LTTNG_DATA_PENDING";
161 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
162 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
163 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
164 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
165 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
166 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
167 case LTTNG_SNAPSHOT_RECORD
:
168 return "LTTNG_SNAPSHOT_RECORD";
169 case LTTNG_SAVE_SESSION
:
170 return "LTTNG_SAVE_SESSION";
171 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
172 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
173 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
174 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
175 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
176 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
177 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
178 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
179 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
180 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
181 case LTTNG_SET_SESSION_SHM_PATH
:
182 return "LTTNG_SET_SESSION_SHM_PATH";
183 case LTTNG_REGENERATE_METADATA
:
184 return "LTTNG_REGENERATE_METADATA";
185 case LTTNG_REGENERATE_STATEDUMP
:
186 return "LTTNG_REGENERATE_STATEDUMP";
187 case LTTNG_REGISTER_TRIGGER
:
188 return "LTTNG_REGISTER_TRIGGER";
189 case LTTNG_UNREGISTER_TRIGGER
:
190 return "LTTNG_UNREGISTER_TRIGGER";
191 case LTTNG_ROTATE_SESSION
:
192 return "LTTNG_ROTATE_SESSION";
193 case LTTNG_ROTATION_GET_INFO
:
194 return "LTTNG_ROTATION_GET_INFO";
195 case LTTNG_ROTATION_SET_SCHEDULE
:
196 return "LTTNG_ROTATION_SET_SCHEDULE";
197 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
198 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
199 case LTTNG_CREATE_SESSION_EXT
:
200 return "LTTNG_CREATE_SESSION_EXT";
201 case LTTNG_CLEAR_SESSION
:
202 return "LTTNG_CLEAR_SESSION";
203 case LTTNG_LIST_TRIGGERS
:
204 return "LTTNG_LIST_TRIGGERS";
206 return "LTTNG_ADD_MAP";
207 case LTTNG_ENABLE_MAP
:
208 return "LTTNG_ENABLE_MAP";
209 case LTTNG_DISABLE_MAP
:
210 return "LTTNG_DISABLE_MAP";
211 case LTTNG_LIST_MAPS
:
212 return "LTTNG_LIST_MAPS";
213 case LTTNG_LIST_MAP_VALUES
:
214 return "LTTNG_LIST_MAP_VALUES";
220 enum lttcomm_relayd_command
{
221 RELAYD_ADD_STREAM
= 1,
222 RELAYD_CREATE_SESSION
= 2,
223 RELAYD_START_DATA
= 3,
224 RELAYD_UPDATE_SYNC_INFO
= 4,
226 RELAYD_SEND_METADATA
= 6,
227 RELAYD_CLOSE_STREAM
= 7,
228 RELAYD_DATA_PENDING
= 8,
229 RELAYD_QUIESCENT_CONTROL
= 9,
230 RELAYD_BEGIN_DATA_PENDING
= 10,
231 RELAYD_END_DATA_PENDING
= 11,
232 RELAYD_ADD_INDEX
= 12,
233 RELAYD_SEND_INDEX
= 13,
234 RELAYD_CLOSE_INDEX
= 14,
235 /* Live-reading commands (2.4+). */
236 RELAYD_LIST_SESSIONS
= 15,
237 /* All streams of the channel have been sent to the relayd (2.4+). */
238 RELAYD_STREAMS_SENT
= 16,
239 /* Ask the relay to reset the metadata trace file (2.8+) */
240 RELAYD_RESET_METADATA
= 17,
241 /* Ask the relay to rotate a set of stream files (2.11+) */
242 RELAYD_ROTATE_STREAMS
= 18,
243 /* Ask the relay to create a trace chunk (2.11+) */
244 RELAYD_CREATE_TRACE_CHUNK
= 19,
245 /* Ask the relay to close a trace chunk (2.11+) */
246 RELAYD_CLOSE_TRACE_CHUNK
= 20,
247 /* Ask the relay whether a trace chunk exists (2.11+) */
248 RELAYD_TRACE_CHUNK_EXISTS
= 21,
249 /* Get the current configuration of a relayd peer (2.12+) */
250 RELAYD_GET_CONFIGURATION
= 22,
252 /* Feature branch specific commands start at 10000. */
256 * lttcomm error code.
258 enum lttcomm_return_code
{
259 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
261 * Some code paths use -1 to express an error, others
262 * negate this consumer return code. Starting codes at
263 * 100 ensures there is no mix-up between this error value
264 * and legitimate status codes.
266 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 100, /* Command socket ready */
267 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
268 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
269 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
270 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
271 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
272 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
273 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
274 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
275 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
276 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
277 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
278 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
279 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
280 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
281 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
282 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
283 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
284 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
285 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
286 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
287 LTTCOMM_CONSUMERD_ROTATION_FAIL
, /* Rotation has failed. */
288 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
, /* snapshot has failed. */
289 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
,/* Trace chunk creation failed. */
290 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
, /* Trace chunk creation failed. */
291 LTTCOMM_CONSUMERD_INVALID_PARAMETERS
, /* Invalid parameters. */
292 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
, /* Trace chunk exists on consumer daemon. */
293 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
,/* Trace chunk exists on relay daemon. */
294 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
, /* Unknown trace chunk. */
295 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
, /* Relayd does not accept clear command. */
296 LTTCOMM_CONSUMERD_UNKNOWN_ERROR
, /* Unknown error. */
298 /* MUST be last element */
299 LTTCOMM_NR
, /* Last element */
302 /* lttng socket protocol. */
303 enum lttcomm_sock_proto
{
309 * Index in the net_families array below. Please keep in sync!
311 enum lttcomm_sock_domain
{
316 enum lttcomm_metadata_command
{
317 LTTCOMM_METADATA_REQUEST
= 1,
321 * Commands sent from the consumerd to the sessiond to request if new metadata
322 * is available. This message is used to find the per UID _or_ per PID registry
323 * for the channel key. For per UID lookup, the triplet
324 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
325 * per PID registry indexed by session id ignoring the other values.
327 struct lttcomm_metadata_request_msg
{
328 uint64_t session_id
; /* Tracing session id */
329 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
330 uint32_t bits_per_long
; /* Consumer ABI */
332 uint64_t key
; /* Metadata channel key. */
335 struct lttcomm_sockaddr
{
336 enum lttcomm_sock_domain type
;
338 struct sockaddr_in sin
;
339 struct sockaddr_in6 sin6
;
343 struct lttcomm_sock
{
345 enum lttcomm_sock_proto proto
;
346 struct lttcomm_sockaddr sockaddr
;
347 const struct lttcomm_proto_ops
*ops
;
351 * Relayd sock. Adds the protocol version to use for the communications with
354 struct lttcomm_relayd_sock
{
355 struct lttcomm_sock sock
;
360 struct lttcomm_net_family
{
362 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
365 struct lttcomm_proto_ops
{
366 int (*bind
) (struct lttcomm_sock
*sock
);
367 int (*close
) (struct lttcomm_sock
*sock
);
368 int (*connect
) (struct lttcomm_sock
*sock
);
369 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
370 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
371 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
373 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
374 size_t len
, int flags
);
377 struct process_attr_integral_value_comm
{
385 * Data structure received from lttng client to session daemon.
387 struct lttcomm_session_msg
{
388 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
389 struct lttng_session session
;
390 struct lttng_domain domain
;
394 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
395 struct lttng_event event
;
396 /* Length of following filter expression. */
397 uint32_t expression_len
;
398 /* Length of following bytecode for filter. */
399 uint32_t bytecode_len
;
400 /* Exclusion count (fixed-size strings). */
401 uint32_t exclusion_count
;
402 /* Userspace probe location size. */
403 uint32_t userspace_probe_location_len
;
405 * After this structure, the following variable-length
406 * items are transmitted:
407 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
408 * - char filter_expression[expression_len]
409 * - unsigned char filter_bytecode[bytecode_len]
411 } LTTNG_PACKED enable
;
413 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
414 struct lttng_event event
;
415 /* Length of following filter expression. */
416 uint32_t expression_len
;
417 /* Length of following bytecode for filter. */
418 uint32_t bytecode_len
;
420 * After this structure, the following variable-length
421 * items are transmitted:
422 * - unsigned char filter_expression[expression_len]
423 * - unsigned char filter_bytecode[bytecode_len]
425 } LTTNG_PACKED disable
;
428 struct lttng_channel chan
;
429 struct lttng_channel_extended extended
;
430 } LTTNG_PACKED channel
;
434 } LTTNG_PACKED add_map
;
437 char map_name
[LTTNG_SYMBOL_NAME_LEN
];
438 } LTTNG_PACKED enable_map
;
441 char map_name
[LTTNG_SYMBOL_NAME_LEN
];
442 } LTTNG_PACKED disable_map
;
445 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
446 struct lttng_event_context ctx
;
447 uint32_t provider_name_len
;
448 uint32_t context_name_len
;
449 } LTTNG_PACKED context
;
450 /* Use by register_consumer */
456 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
458 struct lttng_calibrate calibrate
;
459 /* Used by the set_consumer_url and used by create_session also call */
461 /* Number of lttng_uri following */
465 struct lttng_snapshot_output output
;
466 } LTTNG_PACKED snapshot_output
;
469 struct lttng_snapshot_output output
;
470 } LTTNG_PACKED snapshot_record
;
473 unsigned int timer_interval
; /* usec */
474 } LTTNG_PACKED session_live
;
476 struct lttng_save_session_attr attr
;
477 } LTTNG_PACKED save_session
;
479 char shm_path
[PATH_MAX
];
480 } LTTNG_PACKED set_shm_path
;
482 /* enum lttng_process_attr */
483 int32_t process_attr
;
484 /* enum lttng_process_attr_value_type */
487 struct process_attr_integral_value_comm integral_value
;
489 * For user/group names, a variable length,
490 * zero-terminated, string of length 'name_len'
491 * (including the terminator) follows.
493 * integral_value should not be used in those cases.
496 } LTTNG_PACKED process_attr_tracker_add_remove_include_value
;
498 /* enum lttng_process_attr */
499 int32_t process_attr
;
500 } LTTNG_PACKED process_attr_tracker_get_inclusion_set
;
502 /* enum lttng_process_attr */
503 int32_t process_attr
;
504 } LTTNG_PACKED process_attr_tracker_get_tracking_policy
;
506 /* enum lttng_process_attr */
507 int32_t process_attr
;
508 /* enum lttng_tracking_policy */
509 int32_t tracking_policy
;
510 } LTTNG_PACKED process_attr_tracker_set_tracking_policy
;
513 } LTTNG_PACKED trigger
;
515 uint64_t rotation_id
;
516 } LTTNG_PACKED get_rotation_info
;
518 /* enum lttng_rotation_schedule_type */
521 * If set == 1, set schedule to value, if set == 0,
522 * clear this schedule type.
526 } LTTNG_PACKED rotation_set_schedule
;
529 * Includes the null-terminator.
530 * Must be an absolute path.
532 * Size bounded by LTTNG_PATH_MAX.
534 uint16_t home_dir_size
;
535 uint64_t session_descriptor_size
;
536 /* An lttng_session_descriptor follows. */
537 } LTTNG_PACKED create_session
;
540 uint32_t query_length
;
541 } LTTNG_PACKED list_map_values
;
543 /* Count of fds sent. */
547 #define LTTNG_FILTER_MAX_LEN 65536
548 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
551 * Filter bytecode data. The reloc table is located at the end of the
552 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
553 * starts at reloc_table_offset.
555 #define LTTNG_FILTER_PADDING 32
556 struct lttng_bytecode
{
557 uint32_t len
; /* len of data */
558 uint32_t reloc_table_offset
;
560 char padding
[LTTNG_FILTER_PADDING
];
565 * Event exclusion data. At the end of the structure, there will actually
566 * by zero or more names, where the actual number of names is given by
567 * the 'count' item of the structure.
569 #define LTTNG_EVENT_EXCLUSION_PADDING 32
570 struct lttng_event_exclusion
{
572 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
573 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
576 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
577 (&(_exclusion)->names[_i][0])
580 * Event command header.
582 struct lttcomm_event_command_header
{
583 /* Number of events */
588 * Event extended info header. This is the structure preceding each
589 * extended info data.
591 struct lttcomm_event_extended_header
{
593 * Size of filter string immediately following this header.
594 * This size includes the terminal null character.
599 * Number of exclusion names, immediately following the filter
600 * string. Each exclusion name has a fixed length of
601 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
604 uint32_t nb_exclusions
;
607 * Size of the event's userspace probe location (if applicable).
609 uint32_t userspace_probe_location_len
;
613 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
615 struct lttcomm_session_destroy_command_header
{
616 /* enum lttng_session */
617 int32_t rotation_state
;
621 * tracker command header.
623 struct lttcomm_tracker_command_header
{
624 uint32_t nb_tracker_id
;
628 * Data structure for the response from sessiond to the lttng client.
630 struct lttcomm_lttng_msg
{
631 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
632 uint32_t ret_code
; /* enum lttcomm_return_code */
633 uint32_t pid
; /* pid_t */
634 uint32_t cmd_header_size
;
639 struct lttcomm_lttng_output_id
{
644 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
645 * to either add a channel, add a stream, update a stream, or stop
648 struct lttcomm_consumer_msg
{
649 uint32_t cmd_type
; /* enum lttng_consumer_command */
652 uint64_t channel_key
;
654 /* ID of the session's current trace chunk. */
655 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
656 char pathname
[PATH_MAX
];
658 /* nb_init_streams is the number of streams open initially. */
659 uint32_t nb_init_streams
;
660 char name
[LTTNG_SYMBOL_NAME_LEN
];
661 /* Use splice or mmap to consume this fd */
662 enum lttng_event_output output
;
663 int type
; /* Per cpu or metadata. */
664 uint64_t tracefile_size
; /* bytes */
665 uint32_t tracefile_count
; /* number of tracefiles */
666 /* If the channel's streams have to be monitored or not. */
668 /* timer to check the streams usage in live mode (usec). */
669 unsigned int live_timer_interval
;
670 /* is part of a live session */
672 /* timer to sample a channel's positions (usec). */
673 unsigned int monitor_timer_interval
;
674 } LTTNG_PACKED channel
; /* Only used by Kernel. */
677 uint64_t channel_key
;
678 int32_t cpu
; /* On which CPU this stream is assigned. */
679 /* Tells the consumer if the stream should be or not monitored. */
681 } LTTNG_PACKED stream
; /* Only used by Kernel. */
684 enum lttng_stream_type type
;
685 /* Open socket to the relayd */
686 struct lttcomm_relayd_sock sock
;
687 /* Tracing session id associated to the relayd. */
689 /* Relayd session id, only used with control socket. */
690 uint64_t relayd_session_id
;
691 } LTTNG_PACKED relayd_sock
;
693 uint64_t net_seq_idx
;
694 } LTTNG_PACKED destroy_relayd
;
697 } LTTNG_PACKED data_pending
;
699 uint64_t subbuf_size
; /* bytes */
700 uint64_t num_subbuf
; /* power of 2 */
701 int32_t overwrite
; /* 1: overwrite, 0: discard */
702 uint32_t switch_timer_interval
; /* usec */
703 uint32_t read_timer_interval
; /* usec */
704 unsigned int live_timer_interval
; /* usec */
705 uint8_t is_live
; /* is part of a live session */
706 uint32_t monitor_timer_interval
; /* usec */
707 int32_t output
; /* splice, mmap */
708 int32_t type
; /* metadata or per_cpu */
709 uint64_t session_id
; /* Tracing session id */
710 char pathname
[PATH_MAX
]; /* Channel file path. */
711 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
712 /* Credentials used to open the UST buffer shared mappings. */
716 } LTTNG_PACKED buffer_credentials
;
717 uint64_t relayd_id
; /* Relayd id if apply. */
718 uint64_t key
; /* Unique channel key. */
719 /* ID of the session's current trace chunk. */
720 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
721 unsigned char uuid
[LTTNG_UUID_LEN
]; /* uuid for ust tracer. */
722 uint32_t chan_id
; /* Channel ID on the tracer side. */
723 uint64_t tracefile_size
; /* bytes */
724 uint32_t tracefile_count
; /* number of tracefiles */
725 uint64_t session_id_per_pid
; /* Per-pid session ID. */
726 /* Tells the consumer if the stream should be or not monitored. */
729 * For UST per UID buffers, this is the application UID of the
730 * channel. This can be different from the user UID requesting the
731 * channel creation and used for the rights on the stream file
732 * because the application can be in the tracing for instance.
734 uint32_t ust_app_uid
;
735 int64_t blocking_timeout
;
736 char root_shm_path
[PATH_MAX
];
737 char shm_path
[PATH_MAX
];
738 } LTTNG_PACKED ask_channel
;
741 } LTTNG_PACKED get_channel
;
744 } LTTNG_PACKED destroy_channel
;
746 uint64_t key
; /* Metadata channel key. */
747 uint64_t target_offset
; /* Offset in the consumer */
748 uint64_t len
; /* Length of metadata to be received. */
749 uint64_t version
; /* Version of the metadata. */
750 } LTTNG_PACKED push_metadata
;
752 uint64_t key
; /* Metadata channel key. */
753 } LTTNG_PACKED close_metadata
;
755 uint64_t key
; /* Metadata channel key. */
756 } LTTNG_PACKED setup_metadata
;
758 uint64_t key
; /* Channel key. */
759 } LTTNG_PACKED flush_channel
;
761 uint64_t key
; /* Channel key. */
762 } LTTNG_PACKED clear_quiescent_channel
;
764 char pathname
[PATH_MAX
];
765 /* Indicate if the snapshot goes on the relayd or locally. */
767 uint32_t metadata
; /* This a metadata snapshot. */
768 uint64_t relayd_id
; /* Relayd id if apply. */
770 uint64_t nb_packets_per_stream
;
771 } LTTNG_PACKED snapshot_channel
;
773 uint64_t channel_key
;
774 uint64_t net_seq_idx
;
775 } LTTNG_PACKED sent_streams
;
778 uint64_t channel_key
;
779 } LTTNG_PACKED discarded_events
;
782 uint64_t channel_key
;
783 } LTTNG_PACKED lost_packets
;
786 } LTTNG_PACKED regenerate_metadata
;
788 uint32_t metadata
; /* This is a metadata channel. */
789 uint64_t relayd_id
; /* Relayd id if apply. */
791 } LTTNG_PACKED rotate_channel
;
795 } LTTNG_PACKED check_rotation_pending_local
;
800 } LTTNG_PACKED check_rotation_pending_relay
;
803 * Relayd id, if applicable (remote).
805 * A directory file descriptor referring to the chunk's
806 * output folder is transmitted if the chunk is local
809 * `override_name` is left NULL (all-zeroes) if the
810 * chunk's name is not overridden.
812 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
813 char override_name
[LTTNG_NAME_MAX
];
816 uint64_t creation_timestamp
;
817 LTTNG_OPTIONAL_COMM(struct {
820 } LTTNG_PACKED
) LTTNG_PACKED credentials
;
821 } LTTNG_PACKED create_trace_chunk
;
823 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
826 uint64_t close_timestamp
;
827 /* enum lttng_trace_chunk_command_type */
828 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
829 } LTTNG_PACKED close_trace_chunk
;
831 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
834 } LTTNG_PACKED trace_chunk_exists
;
836 lttng_uuid sessiond_uuid
;
840 } LTTNG_PACKED clear_channel
;
843 } LTTNG_PACKED open_channel_packets
;
848 * Channel monitoring message returned to the session daemon on every
849 * monitor timer expiration.
851 struct lttcomm_consumer_channel_monitor_msg
{
852 /* Key of the sampled channel. */
855 * Lowest and highest usage (bytes) at the moment the sample was taken.
857 uint64_t lowest
, highest
;
859 * Sum of all the consumed positions for a channel.
861 uint64_t total_consumed
;
865 * Status message returned to the sessiond after a received command.
867 struct lttcomm_consumer_status_msg
{
868 enum lttcomm_return_code ret_code
;
871 struct lttcomm_consumer_status_channel
{
872 enum lttcomm_return_code ret_code
;
874 unsigned int stream_count
;
877 struct lttcomm_consumer_close_trace_chunk_reply
{
878 enum lttcomm_return_code ret_code
;
879 uint32_t path_length
;
883 #ifdef HAVE_LIBLTTNG_UST_CTL
885 #include <lttng/ust-abi.h>
888 * Data structure for the commands sent from sessiond to UST.
890 struct lttcomm_ust_msg
{
894 struct lttng_ust_channel channel
;
895 struct lttng_ust_stream stream
;
896 struct lttng_ust_event event
;
897 struct lttng_ust_context context
;
898 struct lttng_ust_tracer_version version
;
903 * Data structure for the response from UST to the session daemon.
904 * cmd_type is sent back in the reply for validation.
906 struct lttcomm_ust_reply
{
909 uint32_t ret_code
; /* enum lttcomm_return_code */
910 uint32_t ret_val
; /* return value */
913 uint64_t memory_map_size
;
914 } LTTNG_PACKED channel
;
916 uint64_t memory_map_size
;
917 } LTTNG_PACKED stream
;
918 struct lttng_ust_tracer_version version
;
922 #endif /* HAVE_LIBLTTNG_UST_CTL */
924 LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
926 LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
927 const char *ip
, unsigned int port
);
928 LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
929 const char *ip
, unsigned int port
);
931 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
932 LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock
*sock
);
933 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
934 LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
935 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
936 LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
937 struct lttcomm_sock
*src
);
939 /* Relayd socket object. */
940 LTTNG_HIDDEN
struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
941 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
943 LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
944 LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
946 LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
949 * Set a port to an lttcomm_sock. This will have no effect is the socket is
952 LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
954 LTTNG_HIDDEN
void lttcomm_init(void);
955 /* Get network timeout, in milliseconds */
956 LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void);
958 #endif /* _LTTNG_SESSIOND_COMM_H */