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>
37 #include <common/unix.h>
39 /* Queue size of listen(2) */
40 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
42 /* Maximum number of FDs that can be sent over a Unix socket */
43 #if defined(__linux__)
44 /* Based on the kernel's SCM_MAX_FD which is 253 since 2.6.38 (255 before) */
45 #define LTTCOMM_MAX_SEND_FDS 253
47 #define LTTCOMM_MAX_SEND_FDS 16
50 enum lttcomm_sessiond_command
{
52 LTTNG_ADD_CONTEXT
= 0,
53 /* LTTNG_CALIBRATE used to be here */
54 LTTNG_DISABLE_CHANNEL
= 2,
55 LTTNG_DISABLE_EVENT
= 3,
56 LTTNG_LIST_SYSCALLS
= 4,
57 LTTNG_ENABLE_CHANNEL
= 5,
58 LTTNG_ENABLE_EVENT
= 6,
60 /* Session daemon command */
62 LTTNG_DESTROY_SESSION
= 9,
63 LTTNG_LIST_CHANNELS
= 10,
64 LTTNG_LIST_DOMAINS
= 11,
65 LTTNG_LIST_EVENTS
= 12,
66 LTTNG_LIST_SESSIONS
= 13,
67 LTTNG_LIST_TRACEPOINTS
= 14,
68 LTTNG_REGISTER_CONSUMER
= 15,
69 LTTNG_START_TRACE
= 16,
70 LTTNG_STOP_TRACE
= 17,
71 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
74 LTTNG_DISABLE_CONSUMER
= 19,
75 LTTNG_ENABLE_CONSUMER
= 20,
76 LTTNG_SET_CONSUMER_URI
= 21,
79 LTTNG_DATA_PENDING
= 24,
80 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
81 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
82 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
83 LTTNG_SNAPSHOT_RECORD
= 28,
86 LTTNG_SAVE_SESSION
= 31,
87 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
= 32,
88 LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
= 33,
89 LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
= 34,
90 LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
= 35,
91 LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
= 36,
92 LTTNG_SET_SESSION_SHM_PATH
= 40,
93 LTTNG_REGENERATE_METADATA
= 41,
94 LTTNG_REGENERATE_STATEDUMP
= 42,
95 LTTNG_REGISTER_TRIGGER
= 43,
96 LTTNG_UNREGISTER_TRIGGER
= 44,
97 LTTNG_ROTATE_SESSION
= 45,
98 LTTNG_ROTATION_GET_INFO
= 46,
99 LTTNG_ROTATION_SET_SCHEDULE
= 47,
100 LTTNG_SESSION_LIST_ROTATION_SCHEDULES
= 48,
101 LTTNG_CREATE_SESSION_EXT
= 49,
102 LTTNG_CLEAR_SESSION
= 50,
103 LTTNG_LIST_TRIGGERS
= 51,
104 LTTNG_EXECUTE_ERROR_QUERY
= 52,
108 const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd
)
111 case LTTNG_ADD_CONTEXT
:
112 return "LTTNG_ADD_CONTEXT";
113 case LTTNG_DISABLE_CHANNEL
:
114 return "LTTNG_DISABLE_CHANNEL";
115 case LTTNG_DISABLE_EVENT
:
116 return "LTTNG_DISABLE_EVENT";
117 case LTTNG_LIST_SYSCALLS
:
118 return "LTTNG_LIST_SYSCALLS";
119 case LTTNG_ENABLE_CHANNEL
:
120 return "LTTNG_ENABLE_CHANNEL";
121 case LTTNG_ENABLE_EVENT
:
122 return "LTTNG_ENABLE_EVENT";
123 case LTTNG_DESTROY_SESSION
:
124 return "LTTNG_DESTROY_SESSION";
125 case LTTNG_LIST_CHANNELS
:
126 return "LTTNG_LIST_CHANNELS";
127 case LTTNG_LIST_DOMAINS
:
128 return "LTTNG_LIST_DOMAINS";
129 case LTTNG_LIST_EVENTS
:
130 return "LTTNG_LIST_EVENTS";
131 case LTTNG_LIST_SESSIONS
:
132 return "LTTNG_LIST_SESSIONS";
133 case LTTNG_LIST_TRACEPOINTS
:
134 return "LTTNG_LIST_TRACEPOINTS";
135 case LTTNG_REGISTER_CONSUMER
:
136 return "LTTNG_REGISTER_CONSUMER";
137 case LTTNG_START_TRACE
:
138 return "LTTNG_START_TRACE";
139 case LTTNG_STOP_TRACE
:
140 return "LTTNG_STOP_TRACE";
141 case LTTNG_LIST_TRACEPOINT_FIELDS
:
142 return "LTTNG_LIST_TRACEPOINT_FIELDS";
143 case LTTNG_DISABLE_CONSUMER
:
144 return "LTTNG_DISABLE_CONSUMER";
145 case LTTNG_ENABLE_CONSUMER
:
146 return "LTTNG_ENABLE_CONSUMER";
147 case LTTNG_SET_CONSUMER_URI
:
148 return "LTTNG_SET_CONSUMER_URI";
149 case LTTNG_DATA_PENDING
:
150 return "LTTNG_DATA_PENDING";
151 case LTTNG_SNAPSHOT_ADD_OUTPUT
:
152 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
153 case LTTNG_SNAPSHOT_DEL_OUTPUT
:
154 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
155 case LTTNG_SNAPSHOT_LIST_OUTPUT
:
156 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
157 case LTTNG_SNAPSHOT_RECORD
:
158 return "LTTNG_SNAPSHOT_RECORD";
159 case LTTNG_SAVE_SESSION
:
160 return "LTTNG_SAVE_SESSION";
161 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
:
162 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
163 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
:
164 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
165 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
:
166 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
167 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
:
168 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
169 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
:
170 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
171 case LTTNG_SET_SESSION_SHM_PATH
:
172 return "LTTNG_SET_SESSION_SHM_PATH";
173 case LTTNG_REGENERATE_METADATA
:
174 return "LTTNG_REGENERATE_METADATA";
175 case LTTNG_REGENERATE_STATEDUMP
:
176 return "LTTNG_REGENERATE_STATEDUMP";
177 case LTTNG_REGISTER_TRIGGER
:
178 return "LTTNG_REGISTER_TRIGGER";
179 case LTTNG_UNREGISTER_TRIGGER
:
180 return "LTTNG_UNREGISTER_TRIGGER";
181 case LTTNG_ROTATE_SESSION
:
182 return "LTTNG_ROTATE_SESSION";
183 case LTTNG_ROTATION_GET_INFO
:
184 return "LTTNG_ROTATION_GET_INFO";
185 case LTTNG_ROTATION_SET_SCHEDULE
:
186 return "LTTNG_ROTATION_SET_SCHEDULE";
187 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES
:
188 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
189 case LTTNG_CREATE_SESSION_EXT
:
190 return "LTTNG_CREATE_SESSION_EXT";
191 case LTTNG_CLEAR_SESSION
:
192 return "LTTNG_CLEAR_SESSION";
193 case LTTNG_LIST_TRIGGERS
:
194 return "LTTNG_LIST_TRIGGERS";
195 case LTTNG_EXECUTE_ERROR_QUERY
:
196 return "LTTNG_EXECUTE_ERROR_QUERY";
202 enum lttcomm_relayd_command
{
203 RELAYD_ADD_STREAM
= 1,
204 RELAYD_CREATE_SESSION
= 2,
205 RELAYD_START_DATA
= 3,
206 RELAYD_UPDATE_SYNC_INFO
= 4,
208 RELAYD_SEND_METADATA
= 6,
209 RELAYD_CLOSE_STREAM
= 7,
210 RELAYD_DATA_PENDING
= 8,
211 RELAYD_QUIESCENT_CONTROL
= 9,
212 RELAYD_BEGIN_DATA_PENDING
= 10,
213 RELAYD_END_DATA_PENDING
= 11,
214 RELAYD_ADD_INDEX
= 12,
215 RELAYD_SEND_INDEX
= 13,
216 RELAYD_CLOSE_INDEX
= 14,
217 /* Live-reading commands (2.4+). */
218 RELAYD_LIST_SESSIONS
= 15,
219 /* All streams of the channel have been sent to the relayd (2.4+). */
220 RELAYD_STREAMS_SENT
= 16,
221 /* Ask the relay to reset the metadata trace file (2.8+) */
222 RELAYD_RESET_METADATA
= 17,
223 /* Ask the relay to rotate a set of stream files (2.11+) */
224 RELAYD_ROTATE_STREAMS
= 18,
225 /* Ask the relay to create a trace chunk (2.11+) */
226 RELAYD_CREATE_TRACE_CHUNK
= 19,
227 /* Ask the relay to close a trace chunk (2.11+) */
228 RELAYD_CLOSE_TRACE_CHUNK
= 20,
229 /* Ask the relay whether a trace chunk exists (2.11+) */
230 RELAYD_TRACE_CHUNK_EXISTS
= 21,
231 /* Get the current configuration of a relayd peer (2.12+) */
232 RELAYD_GET_CONFIGURATION
= 22,
234 /* Feature branch specific commands start at 10000. */
238 const char *lttcomm_relayd_command_str(lttcomm_relayd_command cmd
)
241 case RELAYD_ADD_STREAM
:
242 return "RELAYD_ADD_STREAM";
243 case RELAYD_CREATE_SESSION
:
244 return "RELAYD_CREATE_SESSION";
245 case RELAYD_START_DATA
:
246 return "RELAYD_START_DATA";
247 case RELAYD_UPDATE_SYNC_INFO
:
248 return "RELAYD_UPDATE_SYNC_INFO";
250 return "RELAYD_VERSION";
251 case RELAYD_SEND_METADATA
:
252 return "RELAYD_SEND_METADATA";
253 case RELAYD_CLOSE_STREAM
:
254 return "RELAYD_CLOSE_STREAM";
255 case RELAYD_DATA_PENDING
:
256 return "RELAYD_DATA_PENDING";
257 case RELAYD_QUIESCENT_CONTROL
:
258 return "RELAYD_QUIESCENT_CONTROL";
259 case RELAYD_BEGIN_DATA_PENDING
:
260 return "RELAYD_BEGIN_DATA_PENDING";
261 case RELAYD_END_DATA_PENDING
:
262 return "RELAYD_END_DATA_PENDING";
263 case RELAYD_ADD_INDEX
:
264 return "RELAYD_ADD_INDEX";
265 case RELAYD_SEND_INDEX
:
266 return "RELAYD_SEND_INDEX";
267 case RELAYD_CLOSE_INDEX
:
268 return "RELAYD_CLOSE_INDEX";
269 case RELAYD_LIST_SESSIONS
:
270 return "RELAYD_LIST_SESSIONS";
271 case RELAYD_STREAMS_SENT
:
272 return "RELAYD_STREAMS_SENT";
273 case RELAYD_RESET_METADATA
:
274 return "RELAYD_RESET_METADATA";
275 case RELAYD_ROTATE_STREAMS
:
276 return "RELAYD_ROTATE_STREAMS";
277 case RELAYD_CREATE_TRACE_CHUNK
:
278 return "RELAYD_CREATE_TRACE_CHUNK";
279 case RELAYD_CLOSE_TRACE_CHUNK
:
280 return "RELAYD_CLOSE_TRACE_CHUNK";
281 case RELAYD_TRACE_CHUNK_EXISTS
:
282 return "RELAYD_TRACE_CHUNK_EXISTS";
283 case RELAYD_GET_CONFIGURATION
:
284 return "RELAYD_GET_CONFIGURATION";
291 * lttcomm error code.
293 enum lttcomm_return_code
{
294 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
296 * Some code paths use -1 to express an error, others
297 * negate this consumer return code. Starting codes at
298 * 100 ensures there is no mix-up between this error value
299 * and legitimate status codes.
301 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 100, /* Command socket ready */
302 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
303 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
304 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
305 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
306 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
307 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
308 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
309 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
310 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
311 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
312 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
313 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
314 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
315 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
316 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
317 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
318 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
319 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
320 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
321 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
322 LTTCOMM_CONSUMERD_ROTATION_FAIL
, /* Rotation has failed. */
323 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
, /* snapshot has failed. */
324 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
,/* Trace chunk creation failed. */
325 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
, /* Trace chunk close failed. */
326 LTTCOMM_CONSUMERD_INVALID_PARAMETERS
, /* Invalid parameters. */
327 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
, /* Trace chunk exists on consumer daemon. */
328 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
,/* Trace chunk exists on relay daemon. */
329 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
, /* Unknown trace chunk. */
330 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
, /* Relayd does not accept clear command. */
331 LTTCOMM_CONSUMERD_UNKNOWN_ERROR
, /* Unknown error. */
333 /* MUST be last element */
334 LTTCOMM_NR
, /* Last element */
337 /* lttng socket protocol. */
338 enum lttcomm_sock_proto
{
344 * Index in the net_families array below. Please keep in sync!
346 enum lttcomm_sock_domain
{
351 enum lttcomm_metadata_command
{
352 LTTCOMM_METADATA_REQUEST
= 1,
356 * Commands sent from the consumerd to the sessiond to request if new metadata
357 * is available. This message is used to find the per UID _or_ per PID registry
358 * for the channel key. For per UID lookup, the triplet
359 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
360 * per PID registry indexed by session id ignoring the other values.
362 struct lttcomm_metadata_request_msg
{
363 uint64_t session_id
; /* Tracing session id */
364 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
365 uint32_t bits_per_long
; /* Consumer ABI */
367 uint64_t key
; /* Metadata channel key. */
370 struct lttcomm_sockaddr
{
371 enum lttcomm_sock_domain type
;
373 struct sockaddr_in sin
;
374 struct sockaddr_in6 sin6
;
378 struct lttcomm_sock
{
380 enum lttcomm_sock_proto proto
;
381 struct lttcomm_sockaddr sockaddr
;
382 const struct lttcomm_proto_ops
*ops
;
386 * Relayd sock. Adds the protocol version to use for the communications with
389 struct lttcomm_relayd_sock
{
390 struct lttcomm_sock sock
;
395 struct lttcomm_net_family
{
397 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
400 struct lttcomm_proto_ops
{
401 int (*bind
) (struct lttcomm_sock
*sock
);
402 int (*close
) (struct lttcomm_sock
*sock
);
403 int (*connect
) (struct lttcomm_sock
*sock
);
404 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
405 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
406 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
408 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
409 size_t len
, int flags
);
412 struct process_attr_integral_value_comm
{
420 * Data structure received from lttng client to session daemon.
422 struct lttcomm_session_msg
{
423 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
424 struct lttng_session session
;
425 struct lttng_domain domain
;
429 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
430 struct lttng_event event
;
431 /* Length of following filter expression. */
432 uint32_t expression_len
;
433 /* Length of following bytecode for filter. */
434 uint32_t bytecode_len
;
435 /* Exclusion count (fixed-size strings). */
436 uint32_t exclusion_count
;
437 /* Userspace probe location size. */
438 uint32_t userspace_probe_location_len
;
440 * After this structure, the following variable-length
441 * items are transmitted:
442 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
443 * - char filter_expression[expression_len]
444 * - unsigned char filter_bytecode[bytecode_len]
446 } LTTNG_PACKED enable
;
448 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
449 struct lttng_event event
;
450 /* Length of following filter expression. */
451 uint32_t expression_len
;
452 /* Length of following bytecode for filter. */
453 uint32_t bytecode_len
;
455 * After this structure, the following variable-length
456 * items are transmitted:
457 * - unsigned char filter_expression[expression_len]
458 * - unsigned char filter_bytecode[bytecode_len]
460 } LTTNG_PACKED disable
;
463 struct lttng_channel chan
;
464 struct lttng_channel_extended extended
;
465 } LTTNG_PACKED channel
;
468 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
469 struct lttng_event_context ctx
;
470 uint32_t provider_name_len
;
471 uint32_t context_name_len
;
472 } LTTNG_PACKED context
;
473 /* Use by register_consumer */
479 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
481 struct lttng_calibrate calibrate
;
482 /* Used by the set_consumer_url and used by create_session also call */
484 /* Number of lttng_uri following */
488 struct lttng_snapshot_output output
;
489 } LTTNG_PACKED snapshot_output
;
492 struct lttng_snapshot_output output
;
493 } LTTNG_PACKED snapshot_record
;
496 unsigned int timer_interval
; /* usec */
497 } LTTNG_PACKED session_live
;
499 struct lttng_save_session_attr attr
;
500 } LTTNG_PACKED save_session
;
502 char shm_path
[PATH_MAX
];
503 } LTTNG_PACKED set_shm_path
;
505 /* enum lttng_process_attr */
506 int32_t process_attr
;
507 /* enum lttng_process_attr_value_type */
510 struct process_attr_integral_value_comm integral_value
;
512 * For user/group names, a variable length,
513 * zero-terminated, string of length 'name_len'
514 * (including the terminator) follows.
516 * integral_value should not be used in those cases.
519 } LTTNG_PACKED process_attr_tracker_add_remove_include_value
;
521 /* enum lttng_process_attr */
522 int32_t process_attr
;
523 } LTTNG_PACKED process_attr_tracker_get_inclusion_set
;
525 /* enum lttng_process_attr */
526 int32_t process_attr
;
527 } LTTNG_PACKED process_attr_tracker_get_tracking_policy
;
529 /* enum lttng_process_attr */
530 int32_t process_attr
;
531 /* enum lttng_tracking_policy */
532 int32_t tracking_policy
;
533 } LTTNG_PACKED process_attr_tracker_set_tracking_policy
;
536 uint8_t is_trigger_anonymous
;
537 } LTTNG_PACKED trigger
;
540 } LTTNG_PACKED error_query
;
542 uint64_t rotation_id
;
543 } LTTNG_PACKED get_rotation_info
;
545 /* enum lttng_rotation_schedule_type */
548 * If set == 1, set schedule to value, if set == 0,
549 * clear this schedule type.
553 } LTTNG_PACKED rotation_set_schedule
;
556 * Includes the null-terminator.
557 * Must be an absolute path.
559 * Size bounded by LTTNG_PATH_MAX.
561 uint16_t home_dir_size
;
562 uint64_t session_descriptor_size
;
563 /* An lttng_session_descriptor follows. */
564 } LTTNG_PACKED create_session
;
566 /* Count of fds sent. */
570 #define LTTNG_FILTER_MAX_LEN 65536
571 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
574 * Filter bytecode data. The reloc table is located at the end of the
575 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
576 * starts at reloc_table_offset.
578 #define LTTNG_FILTER_PADDING 32
579 struct lttng_bytecode
{
580 uint32_t len
; /* len of data */
581 uint32_t reloc_table_offset
;
583 char padding
[LTTNG_FILTER_PADDING
];
588 * Event exclusion data. At the end of the structure, there will actually
589 * by zero or more names, where the actual number of names is given by
590 * the 'count' item of the structure.
592 #define LTTNG_EVENT_EXCLUSION_PADDING 32
593 struct lttng_event_exclusion
{
595 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
596 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
599 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
600 (&(_exclusion)->names[_i][0])
603 * Event command header.
605 struct lttcomm_event_command_header
{
606 /* Number of events */
611 * Event extended info header. This is the structure preceding each
612 * extended info data.
614 struct lttcomm_event_extended_header
{
616 * Size of filter string immediately following this header.
617 * This size includes the terminal null character.
622 * Number of exclusion names, immediately following the filter
623 * string. Each exclusion name has a fixed length of
624 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
627 uint32_t nb_exclusions
;
630 * Size of the event's userspace probe location (if applicable).
632 uint32_t userspace_probe_location_len
;
636 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
638 struct lttcomm_session_destroy_command_header
{
639 /* enum lttng_session */
640 int32_t rotation_state
;
644 * tracker command header.
646 struct lttcomm_tracker_command_header
{
647 uint32_t nb_tracker_id
;
651 * Data structure for the response from sessiond to the lttng client.
653 struct lttcomm_lttng_msg
{
654 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
655 uint32_t ret_code
; /* enum lttcomm_return_code */
656 uint32_t pid
; /* pid_t */
657 uint32_t cmd_header_size
;
662 struct lttcomm_lttng_output_id
{
667 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
668 * to either add a channel, add a stream, update a stream, or stop
671 struct lttcomm_consumer_msg
{
672 uint32_t cmd_type
; /* enum lttng_consumer_command */
675 uint64_t channel_key
;
677 /* ID of the session's current trace chunk. */
678 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
679 char pathname
[PATH_MAX
];
681 /* nb_init_streams is the number of streams open initially. */
682 uint32_t nb_init_streams
;
683 char name
[LTTNG_SYMBOL_NAME_LEN
];
684 /* Use splice or mmap to consume this fd */
685 enum lttng_event_output output
;
686 int type
; /* Per cpu or metadata. */
687 uint64_t tracefile_size
; /* bytes */
688 uint32_t tracefile_count
; /* number of tracefiles */
689 /* If the channel's streams have to be monitored or not. */
691 /* timer to check the streams usage in live mode (usec). */
692 unsigned int live_timer_interval
;
693 /* is part of a live session */
695 /* timer to sample a channel's positions (usec). */
696 unsigned int monitor_timer_interval
;
697 } LTTNG_PACKED channel
; /* Only used by Kernel. */
700 uint64_t channel_key
;
701 int32_t cpu
; /* On which CPU this stream is assigned. */
702 /* Tells the consumer if the stream should be or not monitored. */
704 } LTTNG_PACKED stream
; /* Only used by Kernel. */
707 enum lttng_stream_type type
;
708 /* Open socket to the relayd */
709 struct lttcomm_relayd_sock sock
;
710 /* Tracing session id associated to the relayd. */
712 /* Relayd session id, only used with control socket. */
713 uint64_t relayd_session_id
;
714 } LTTNG_PACKED relayd_sock
;
716 uint64_t net_seq_idx
;
717 } LTTNG_PACKED destroy_relayd
;
720 } LTTNG_PACKED data_pending
;
722 uint64_t subbuf_size
; /* bytes */
723 uint64_t num_subbuf
; /* power of 2 */
724 int32_t overwrite
; /* 1: overwrite, 0: discard */
725 uint32_t switch_timer_interval
; /* usec */
726 uint32_t read_timer_interval
; /* usec */
727 unsigned int live_timer_interval
; /* usec */
728 uint8_t is_live
; /* is part of a live session */
729 uint32_t monitor_timer_interval
; /* usec */
730 int32_t output
; /* splice, mmap */
731 int32_t type
; /* metadata or per_cpu */
732 uint64_t session_id
; /* Tracing session id */
733 char pathname
[PATH_MAX
]; /* Channel file path. */
734 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
735 /* Credentials used to open the UST buffer shared mappings. */
739 } LTTNG_PACKED buffer_credentials
;
740 uint64_t relayd_id
; /* Relayd id if apply. */
741 uint64_t key
; /* Unique channel key. */
742 /* ID of the session's current trace chunk. */
743 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
744 unsigned char uuid
[LTTNG_UUID_LEN
]; /* uuid for ust tracer. */
745 uint32_t chan_id
; /* Channel ID on the tracer side. */
746 uint64_t tracefile_size
; /* bytes */
747 uint32_t tracefile_count
; /* number of tracefiles */
748 uint64_t session_id_per_pid
; /* Per-pid session ID. */
749 /* Tells the consumer if the stream should be or not monitored. */
752 * For UST per UID buffers, this is the application UID of the
753 * channel. This can be different from the user UID requesting the
754 * channel creation and used for the rights on the stream file
755 * because the application can be in the tracing for instance.
757 uint32_t ust_app_uid
;
758 int64_t blocking_timeout
;
759 char root_shm_path
[PATH_MAX
];
760 char shm_path
[PATH_MAX
];
761 } LTTNG_PACKED ask_channel
;
764 } LTTNG_PACKED get_channel
;
767 } LTTNG_PACKED destroy_channel
;
769 uint64_t key
; /* Metadata channel key. */
770 uint64_t target_offset
; /* Offset in the consumer */
771 uint64_t len
; /* Length of metadata to be received. */
772 uint64_t version
; /* Version of the metadata. */
773 } LTTNG_PACKED push_metadata
;
775 uint64_t key
; /* Metadata channel key. */
776 } LTTNG_PACKED close_metadata
;
778 uint64_t key
; /* Metadata channel key. */
779 } LTTNG_PACKED setup_metadata
;
781 uint64_t key
; /* Channel key. */
782 } LTTNG_PACKED flush_channel
;
784 uint64_t key
; /* Channel key. */
785 } LTTNG_PACKED clear_quiescent_channel
;
787 char pathname
[PATH_MAX
];
788 /* Indicate if the snapshot goes on the relayd or locally. */
790 uint32_t metadata
; /* This a metadata snapshot. */
791 uint64_t relayd_id
; /* Relayd id if apply. */
793 uint64_t nb_packets_per_stream
;
794 } LTTNG_PACKED snapshot_channel
;
796 uint64_t channel_key
;
797 uint64_t net_seq_idx
;
798 } LTTNG_PACKED sent_streams
;
801 uint64_t channel_key
;
802 } LTTNG_PACKED discarded_events
;
805 uint64_t channel_key
;
806 } LTTNG_PACKED lost_packets
;
809 } LTTNG_PACKED regenerate_metadata
;
811 uint32_t metadata
; /* This is a metadata channel. */
812 uint64_t relayd_id
; /* Relayd id if apply. */
814 } LTTNG_PACKED rotate_channel
;
818 } LTTNG_PACKED check_rotation_pending_local
;
823 } LTTNG_PACKED check_rotation_pending_relay
;
826 * Relayd id, if applicable (remote).
828 * A directory file descriptor referring to the chunk's
829 * output folder is transmitted if the chunk is local
832 * `override_name` is left NULL (all-zeroes) if the
833 * chunk's name is not overridden.
835 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
836 char override_name
[LTTNG_NAME_MAX
];
839 uint64_t creation_timestamp
;
840 LTTNG_OPTIONAL_COMM(struct {
843 } LTTNG_PACKED
) LTTNG_PACKED credentials
;
844 } LTTNG_PACKED create_trace_chunk
;
846 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
849 uint64_t close_timestamp
;
850 /* enum lttng_trace_chunk_command_type */
851 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
852 } LTTNG_PACKED close_trace_chunk
;
854 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
857 } LTTNG_PACKED trace_chunk_exists
;
859 lttng_uuid sessiond_uuid
;
863 } LTTNG_PACKED clear_channel
;
866 } LTTNG_PACKED open_channel_packets
;
871 * Channel monitoring message returned to the session daemon on every
872 * monitor timer expiration.
874 struct lttcomm_consumer_channel_monitor_msg
{
875 /* Key of the sampled channel. */
878 * Lowest and highest usage (bytes) at the moment the sample was taken.
880 uint64_t lowest
, highest
;
882 * Sum of all the consumed positions for a channel.
884 uint64_t total_consumed
;
888 * Status message returned to the sessiond after a received command.
890 struct lttcomm_consumer_status_msg
{
891 enum lttcomm_return_code ret_code
;
894 struct lttcomm_consumer_status_channel
{
895 enum lttcomm_return_code ret_code
;
897 unsigned int stream_count
;
900 struct lttcomm_consumer_close_trace_chunk_reply
{
901 enum lttcomm_return_code ret_code
;
902 uint32_t path_length
;
906 #ifdef HAVE_LIBLTTNG_UST_CTL
908 #include <lttng/ust-abi.h>
911 * Data structure for the commands sent from sessiond to UST.
913 struct lttcomm_ust_msg
{
917 struct lttng_ust_abi_channel channel
;
918 struct lttng_ust_abi_stream stream
;
919 struct lttng_ust_abi_event event
;
920 struct lttng_ust_abi_context context
;
921 struct lttng_ust_abi_tracer_version version
;
926 * Data structure for the response from UST to the session daemon.
927 * cmd_type is sent back in the reply for validation.
929 struct lttcomm_ust_reply
{
932 uint32_t ret_code
; /* enum lttcomm_return_code */
933 uint32_t ret_val
; /* return value */
936 uint64_t memory_map_size
;
937 } LTTNG_PACKED channel
;
939 uint64_t memory_map_size
;
940 } LTTNG_PACKED stream
;
941 struct lttng_ust_abi_tracer_version version
;
945 #endif /* HAVE_LIBLTTNG_UST_CTL */
947 const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
949 int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
950 const char *ip
, unsigned int port
);
951 int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
952 const char *ip
, unsigned int port
);
954 struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
955 int lttcomm_create_sock(struct lttcomm_sock
*sock
);
956 struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
957 void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
958 struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
959 void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
960 struct lttcomm_sock
*src
);
962 /* Relayd socket object. */
963 struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
964 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
966 int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
967 int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
969 int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
972 * Set a port to an lttcomm_sock. This will have no effect is the socket is
975 int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
977 void lttcomm_init(void);
978 /* Get network timeout, in milliseconds */
979 unsigned long lttcomm_get_network_timeout(void);
981 #endif /* _LTTNG_SESSIOND_COMM_H */