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 #define LTTCOMM_MAX_SEND_FDS 4
47 * Get the error code index from 0 since LTTCOMM_OK start at 1000
49 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
51 enum lttcomm_sessiond_command
{
53 LTTNG_ADD_CONTEXT
= 0,
54 /* LTTNG_CALIBRATE used to be here */
55 LTTNG_DISABLE_CHANNEL
= 2,
56 LTTNG_DISABLE_EVENT
= 3,
57 LTTNG_LIST_SYSCALLS
= 4,
58 LTTNG_ENABLE_CHANNEL
= 5,
59 LTTNG_ENABLE_EVENT
= 6,
61 /* Session daemon command */
63 LTTNG_DESTROY_SESSION
= 9,
64 LTTNG_LIST_CHANNELS
= 10,
65 LTTNG_LIST_DOMAINS
= 11,
66 LTTNG_LIST_EVENTS
= 12,
67 LTTNG_LIST_SESSIONS
= 13,
68 LTTNG_LIST_TRACEPOINTS
= 14,
69 LTTNG_REGISTER_CONSUMER
= 15,
70 LTTNG_START_TRACE
= 16,
71 LTTNG_STOP_TRACE
= 17,
72 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
75 LTTNG_DISABLE_CONSUMER
= 19,
76 LTTNG_ENABLE_CONSUMER
= 20,
77 LTTNG_SET_CONSUMER_URI
= 21,
80 LTTNG_DATA_PENDING
= 24,
81 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
82 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
83 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
84 LTTNG_SNAPSHOT_RECORD
= 28,
87 LTTNG_SAVE_SESSION
= 31,
88 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE
= 32,
89 LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE
= 33,
90 LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY
= 34,
91 LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY
= 35,
92 LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET
= 36,
93 LTTNG_SET_SESSION_SHM_PATH
= 40,
94 LTTNG_REGENERATE_METADATA
= 41,
95 LTTNG_REGENERATE_STATEDUMP
= 42,
96 LTTNG_REGISTER_TRIGGER
= 43,
97 LTTNG_UNREGISTER_TRIGGER
= 44,
98 LTTNG_ROTATE_SESSION
= 45,
99 LTTNG_ROTATION_GET_INFO
= 46,
100 LTTNG_ROTATION_SET_SCHEDULE
= 47,
101 LTTNG_SESSION_LIST_ROTATION_SCHEDULES
= 48,
102 LTTNG_CREATE_SESSION_EXT
= 49,
103 LTTNG_CLEAR_SESSION
= 50,
106 enum lttcomm_relayd_command
{
107 RELAYD_ADD_STREAM
= 1,
108 RELAYD_CREATE_SESSION
= 2,
109 RELAYD_START_DATA
= 3,
110 RELAYD_UPDATE_SYNC_INFO
= 4,
112 RELAYD_SEND_METADATA
= 6,
113 RELAYD_CLOSE_STREAM
= 7,
114 RELAYD_DATA_PENDING
= 8,
115 RELAYD_QUIESCENT_CONTROL
= 9,
116 RELAYD_BEGIN_DATA_PENDING
= 10,
117 RELAYD_END_DATA_PENDING
= 11,
118 RELAYD_ADD_INDEX
= 12,
119 RELAYD_SEND_INDEX
= 13,
120 RELAYD_CLOSE_INDEX
= 14,
121 /* Live-reading commands (2.4+). */
122 RELAYD_LIST_SESSIONS
= 15,
123 /* All streams of the channel have been sent to the relayd (2.4+). */
124 RELAYD_STREAMS_SENT
= 16,
125 /* Ask the relay to reset the metadata trace file (2.8+) */
126 RELAYD_RESET_METADATA
= 17,
127 /* Ask the relay to rotate a set of stream files (2.11+) */
128 RELAYD_ROTATE_STREAMS
= 18,
129 /* Ask the relay to create a trace chunk (2.11+) */
130 RELAYD_CREATE_TRACE_CHUNK
= 19,
131 /* Ask the relay to close a trace chunk (2.11+) */
132 RELAYD_CLOSE_TRACE_CHUNK
= 20,
133 /* Ask the relay whether a trace chunk exists (2.11+) */
134 RELAYD_TRACE_CHUNK_EXISTS
= 21,
135 /* Get the current configuration of a relayd peer (2.12+) */
136 RELAYD_GET_CONFIGURATION
= 22,
138 /* Feature branch specific commands start at 10000. */
142 * lttcomm error code.
144 enum lttcomm_return_code
{
145 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
147 * Some code paths use -1 to express an error, others
148 * negate this consumer return code. Starting codes at
149 * 100 ensures there is no mix-up between this error value
150 * and legitimate status codes.
152 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 100, /* Command socket ready */
153 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
154 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
155 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
156 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
157 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
158 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
159 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
160 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
161 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
162 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
163 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
164 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
165 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
166 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
167 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
168 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
169 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
170 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
171 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
172 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
173 LTTCOMM_CONSUMERD_ROTATION_FAIL
, /* Rotation has failed. */
174 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
, /* snapshot has failed. */
175 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
,/* Trace chunk creation failed. */
176 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
, /* Trace chunk creation failed. */
177 LTTCOMM_CONSUMERD_INVALID_PARAMETERS
, /* Invalid parameters. */
178 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
, /* Trace chunk exists on consumer daemon. */
179 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
,/* Trace chunk exists on relay daemon. */
180 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
, /* Unknown trace chunk. */
181 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
, /* Relayd does not accept clear command. */
182 LTTCOMM_CONSUMERD_UNKNOWN_ERROR
, /* Unknown error. */
184 /* MUST be last element */
185 LTTCOMM_NR
, /* Last element */
188 /* lttng socket protocol. */
189 enum lttcomm_sock_proto
{
195 * Index in the net_families array below. Please keep in sync!
197 enum lttcomm_sock_domain
{
202 enum lttcomm_metadata_command
{
203 LTTCOMM_METADATA_REQUEST
= 1,
207 * Commands sent from the consumerd to the sessiond to request if new metadata
208 * is available. This message is used to find the per UID _or_ per PID registry
209 * for the channel key. For per UID lookup, the triplet
210 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
211 * per PID registry indexed by session id ignoring the other values.
213 struct lttcomm_metadata_request_msg
{
214 uint64_t session_id
; /* Tracing session id */
215 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
216 uint32_t bits_per_long
; /* Consumer ABI */
218 uint64_t key
; /* Metadata channel key. */
221 struct lttcomm_sockaddr
{
222 enum lttcomm_sock_domain type
;
224 struct sockaddr_in sin
;
225 struct sockaddr_in6 sin6
;
229 struct lttcomm_sock
{
231 enum lttcomm_sock_proto proto
;
232 struct lttcomm_sockaddr sockaddr
;
233 const struct lttcomm_proto_ops
*ops
;
237 * Relayd sock. Adds the protocol version to use for the communications with
240 struct lttcomm_relayd_sock
{
241 struct lttcomm_sock sock
;
246 struct lttcomm_net_family
{
248 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
251 struct lttcomm_proto_ops
{
252 int (*bind
) (struct lttcomm_sock
*sock
);
253 int (*close
) (struct lttcomm_sock
*sock
);
254 int (*connect
) (struct lttcomm_sock
*sock
);
255 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
256 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
257 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
259 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
260 size_t len
, int flags
);
263 struct process_attr_integral_value_comm
{
271 * Data structure received from lttng client to session daemon.
273 struct lttcomm_session_msg
{
274 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
275 struct lttng_session session
;
276 struct lttng_domain domain
;
280 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
281 struct lttng_event event LTTNG_PACKED
;
282 /* Length of following filter expression. */
283 uint32_t expression_len
;
284 /* Length of following bytecode for filter. */
285 uint32_t bytecode_len
;
286 /* Exclusion count (fixed-size strings). */
287 uint32_t exclusion_count
;
288 /* Userspace probe location size. */
289 uint32_t userspace_probe_location_len
;
291 * After this structure, the following variable-length
292 * items are transmitted:
293 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
294 * - char filter_expression[expression_len]
295 * - unsigned char filter_bytecode[bytecode_len]
297 } LTTNG_PACKED enable
;
299 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
300 struct lttng_event event LTTNG_PACKED
;
301 /* Length of following filter expression. */
302 uint32_t expression_len
;
303 /* Length of following bytecode for filter. */
304 uint32_t bytecode_len
;
306 * After this structure, the following variable-length
307 * items are transmitted:
308 * - unsigned char filter_expression[expression_len]
309 * - unsigned char filter_bytecode[bytecode_len]
311 } LTTNG_PACKED disable
;
314 struct lttng_channel chan LTTNG_PACKED
;
315 /* struct lttng_channel_extended is already packed. */
316 struct lttng_channel_extended extended
;
317 } LTTNG_PACKED channel
;
320 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
321 struct lttng_event_context ctx LTTNG_PACKED
;
322 uint32_t provider_name_len
;
323 uint32_t context_name_len
;
324 } LTTNG_PACKED context
;
325 /* Use by register_consumer */
331 char channel_name
[LTTNG_SYMBOL_NAME_LEN
];
333 struct lttng_calibrate calibrate
;
334 /* Used by the set_consumer_url and used by create_session also call */
336 /* Number of lttng_uri following */
340 struct lttng_snapshot_output output LTTNG_PACKED
;
341 } LTTNG_PACKED snapshot_output
;
344 struct lttng_snapshot_output output LTTNG_PACKED
;
345 } LTTNG_PACKED snapshot_record
;
348 unsigned int timer_interval
; /* usec */
349 } LTTNG_PACKED session_live
;
351 struct lttng_save_session_attr attr
; /* struct already packed */
352 } LTTNG_PACKED save_session
;
354 char shm_path
[PATH_MAX
];
355 } LTTNG_PACKED set_shm_path
;
357 /* enum lttng_process_attr */
358 int32_t process_attr
;
359 /* enum lttng_process_attr_value_type */
362 struct process_attr_integral_value_comm integral_value
;
364 * For user/group names, a variable length,
365 * zero-terminated, string of length 'name_len'
366 * (including the terminator) follows.
368 * integral_value should not be used in those cases.
371 } LTTNG_PACKED process_attr_tracker_add_remove_include_value
;
373 /* enum lttng_process_attr */
374 int32_t process_attr
;
375 } LTTNG_PACKED process_attr_tracker_get_inclusion_set
;
377 /* enum lttng_process_attr */
378 int32_t process_attr
;
379 } LTTNG_PACKED process_attr_tracker_get_tracking_policy
;
381 /* enum lttng_process_attr */
382 int32_t process_attr
;
383 /* enum lttng_tracking_policy */
384 int32_t tracking_policy
;
385 } LTTNG_PACKED process_attr_tracker_set_tracking_policy
;
388 } LTTNG_PACKED trigger
;
390 uint64_t rotation_id
;
391 } LTTNG_PACKED get_rotation_info
;
393 /* enum lttng_rotation_schedule_type */
396 * If set == 1, set schedule to value, if set == 0,
397 * clear this schedule type.
401 } LTTNG_PACKED rotation_set_schedule
;
404 * Includes the null-terminator.
405 * Must be an absolute path.
407 * Size bounded by LTTNG_PATH_MAX.
409 uint16_t home_dir_size
;
410 uint64_t session_descriptor_size
;
411 /* An lttng_session_descriptor follows. */
412 } LTTNG_PACKED create_session
;
416 #define LTTNG_FILTER_MAX_LEN 65536
417 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
420 * Filter bytecode data. The reloc table is located at the end of the
421 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
422 * starts at reloc_table_offset.
424 #define LTTNG_FILTER_PADDING 32
425 struct lttng_filter_bytecode
{
426 uint32_t len
; /* len of data */
427 uint32_t reloc_table_offset
;
429 char padding
[LTTNG_FILTER_PADDING
];
434 * Event exclusion data. At the end of the structure, there will actually
435 * by zero or more names, where the actual number of names is given by
436 * the 'count' item of the structure.
438 #define LTTNG_EVENT_EXCLUSION_PADDING 32
439 struct lttng_event_exclusion
{
441 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
442 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
445 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
446 (&(_exclusion)->names[_i][0])
449 * Event command header.
451 struct lttcomm_event_command_header
{
452 /* Number of events */
457 * Event extended info header. This is the structure preceding each
458 * extended info data.
460 struct lttcomm_event_extended_header
{
462 * Size of filter string immediately following this header.
463 * This size includes the terminal null character.
468 * Number of exclusion names, immediately following the filter
469 * string. Each exclusion name has a fixed length of
470 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
473 uint32_t nb_exclusions
;
476 * Size of the event's userspace probe location (if applicable).
478 uint32_t userspace_probe_location_len
;
482 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
484 struct lttcomm_session_destroy_command_header
{
485 /* enum lttng_session */
486 int32_t rotation_state
;
490 * tracker command header.
492 struct lttcomm_tracker_command_header
{
493 uint32_t nb_tracker_id
;
497 * Data structure for the response from sessiond to the lttng client.
499 struct lttcomm_lttng_msg
{
500 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
501 uint32_t ret_code
; /* enum lttcomm_return_code */
502 uint32_t pid
; /* pid_t */
503 uint32_t cmd_header_size
;
507 struct lttcomm_lttng_output_id
{
512 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
513 * to either add a channel, add a stream, update a stream, or stop
516 struct lttcomm_consumer_msg
{
517 uint32_t cmd_type
; /* enum lttng_consumer_command */
520 uint64_t channel_key
;
522 /* ID of the session's current trace chunk. */
523 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
524 char pathname
[PATH_MAX
];
526 /* nb_init_streams is the number of streams open initially. */
527 uint32_t nb_init_streams
;
528 char name
[LTTNG_SYMBOL_NAME_LEN
];
529 /* Use splice or mmap to consume this fd */
530 enum lttng_event_output output
;
531 int type
; /* Per cpu or metadata. */
532 uint64_t tracefile_size
; /* bytes */
533 uint32_t tracefile_count
; /* number of tracefiles */
534 /* If the channel's streams have to be monitored or not. */
536 /* timer to check the streams usage in live mode (usec). */
537 unsigned int live_timer_interval
;
538 /* is part of a live session */
540 /* timer to sample a channel's positions (usec). */
541 unsigned int monitor_timer_interval
;
542 } LTTNG_PACKED channel
; /* Only used by Kernel. */
545 uint64_t channel_key
;
546 int32_t cpu
; /* On which CPU this stream is assigned. */
547 /* Tells the consumer if the stream should be or not monitored. */
549 } LTTNG_PACKED stream
; /* Only used by Kernel. */
552 enum lttng_stream_type type
;
555 uint8_t relayd_socket_protocol
;
556 /* Tracing session id associated to the relayd. */
558 /* Relayd session id, only used with control socket. */
559 uint64_t relayd_session_id
;
560 } LTTNG_PACKED relayd_sock
;
562 uint64_t net_seq_idx
;
563 } LTTNG_PACKED destroy_relayd
;
566 } LTTNG_PACKED data_pending
;
568 uint64_t subbuf_size
; /* bytes */
569 uint64_t num_subbuf
; /* power of 2 */
570 int32_t overwrite
; /* 1: overwrite, 0: discard */
571 uint32_t switch_timer_interval
; /* usec */
572 uint32_t read_timer_interval
; /* usec */
573 unsigned int live_timer_interval
; /* usec */
574 uint8_t is_live
; /* is part of a live session */
575 uint32_t monitor_timer_interval
; /* usec */
576 int32_t output
; /* splice, mmap */
577 int32_t type
; /* metadata or per_cpu */
578 uint64_t session_id
; /* Tracing session id */
579 char pathname
[PATH_MAX
]; /* Channel file path. */
580 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
581 /* Credentials used to open the UST buffer shared mappings. */
585 } LTTNG_PACKED buffer_credentials
;
586 uint64_t relayd_id
; /* Relayd id if apply. */
587 uint64_t key
; /* Unique channel key. */
588 /* ID of the session's current trace chunk. */
589 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
590 unsigned char uuid
[LTTNG_UUID_LEN
]; /* uuid for ust tracer. */
591 uint32_t chan_id
; /* Channel ID on the tracer side. */
592 uint64_t tracefile_size
; /* bytes */
593 uint32_t tracefile_count
; /* number of tracefiles */
594 uint64_t session_id_per_pid
; /* Per-pid session ID. */
595 /* Tells the consumer if the stream should be or not monitored. */
598 * For UST per UID buffers, this is the application UID of the
599 * channel. This can be different from the user UID requesting the
600 * channel creation and used for the rights on the stream file
601 * because the application can be in the tracing for instance.
603 uint32_t ust_app_uid
;
604 int64_t blocking_timeout
;
605 char root_shm_path
[PATH_MAX
];
606 char shm_path
[PATH_MAX
];
607 } LTTNG_PACKED ask_channel
;
610 } LTTNG_PACKED get_channel
;
613 } LTTNG_PACKED destroy_channel
;
615 uint64_t key
; /* Metadata channel key. */
616 uint64_t target_offset
; /* Offset in the consumer */
617 uint64_t len
; /* Length of metadata to be received. */
618 uint64_t version
; /* Version of the metadata. */
619 } LTTNG_PACKED push_metadata
;
621 uint64_t key
; /* Metadata channel key. */
622 } LTTNG_PACKED close_metadata
;
624 uint64_t key
; /* Metadata channel key. */
625 } LTTNG_PACKED setup_metadata
;
627 uint64_t key
; /* Channel key. */
628 } LTTNG_PACKED flush_channel
;
630 uint64_t key
; /* Channel key. */
631 } LTTNG_PACKED clear_quiescent_channel
;
633 char pathname
[PATH_MAX
];
634 /* Indicate if the snapshot goes on the relayd or locally. */
636 uint32_t metadata
; /* This a metadata snapshot. */
637 uint64_t relayd_id
; /* Relayd id if apply. */
639 uint64_t nb_packets_per_stream
;
640 } LTTNG_PACKED snapshot_channel
;
642 uint64_t channel_key
;
643 uint64_t net_seq_idx
;
644 } LTTNG_PACKED sent_streams
;
647 uint64_t channel_key
;
648 } LTTNG_PACKED discarded_events
;
651 uint64_t channel_key
;
652 } LTTNG_PACKED lost_packets
;
655 } LTTNG_PACKED regenerate_metadata
;
657 uint32_t metadata
; /* This is a metadata channel. */
658 uint64_t relayd_id
; /* Relayd id if apply. */
660 } LTTNG_PACKED rotate_channel
;
664 } LTTNG_PACKED check_rotation_pending_local
;
669 } LTTNG_PACKED check_rotation_pending_relay
;
672 * Relayd id, if applicable (remote).
674 * A directory file descriptor referring to the chunk's
675 * output folder is transmitted if the chunk is local
678 * `override_name` is left NULL (all-zeroes) if the
679 * chunk's name is not overridden.
681 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
682 char override_name
[LTTNG_NAME_MAX
];
685 uint64_t creation_timestamp
;
686 LTTNG_OPTIONAL_COMM(struct {
689 } LTTNG_PACKED
) LTTNG_PACKED credentials
;
690 } LTTNG_PACKED create_trace_chunk
;
692 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
695 uint64_t close_timestamp
;
696 /* enum lttng_trace_chunk_command_type */
697 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
698 } LTTNG_PACKED close_trace_chunk
;
700 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
703 } LTTNG_PACKED trace_chunk_exists
;
705 lttng_uuid sessiond_uuid
;
709 } LTTNG_PACKED clear_channel
;
712 } LTTNG_PACKED open_channel_packets
;
717 * Channel monitoring message returned to the session daemon on every
718 * monitor timer expiration.
720 struct lttcomm_consumer_channel_monitor_msg
{
721 /* Key of the sampled channel. */
724 * Lowest and highest usage (bytes) at the moment the sample was taken.
726 uint64_t lowest
, highest
;
728 * Sum of all the consumed positions for a channel.
730 uint64_t total_consumed
;
734 * Status message returned to the sessiond after a received command.
736 struct lttcomm_consumer_status_msg
{
737 enum lttcomm_return_code ret_code
;
740 struct lttcomm_consumer_status_channel
{
741 enum lttcomm_return_code ret_code
;
743 unsigned int stream_count
;
746 struct lttcomm_consumer_close_trace_chunk_reply
{
747 enum lttcomm_return_code ret_code
;
748 uint32_t path_length
;
752 #ifdef HAVE_LIBLTTNG_UST_CTL
754 #include <lttng/ust-abi.h>
757 * Data structure for the commands sent from sessiond to UST.
759 struct lttcomm_ust_msg
{
763 struct lttng_ust_channel channel
;
764 struct lttng_ust_stream stream
;
765 struct lttng_ust_event event
;
766 struct lttng_ust_context context
;
767 struct lttng_ust_tracer_version version
;
772 * Data structure for the response from UST to the session daemon.
773 * cmd_type is sent back in the reply for validation.
775 struct lttcomm_ust_reply
{
778 uint32_t ret_code
; /* enum lttcomm_return_code */
779 uint32_t ret_val
; /* return value */
782 uint64_t memory_map_size
;
783 } LTTNG_PACKED channel
;
785 uint64_t memory_map_size
;
786 } LTTNG_PACKED stream
;
787 struct lttng_ust_tracer_version version
;
791 #endif /* HAVE_LIBLTTNG_UST_CTL */
793 LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
795 LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
796 const char *ip
, unsigned int port
);
797 LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
798 const char *ip
, unsigned int port
);
800 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
801 LTTNG_HIDDEN
int lttcomm_populate_sock_from_open_socket(
802 struct lttcomm_sock
*sock
,
804 enum lttcomm_sock_proto protocol
);
805 LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock
*sock
);
806 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
807 LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
808 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
809 LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
810 struct lttcomm_sock
*src
);
812 /* Relayd socket object. */
813 LTTNG_HIDDEN
struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
814 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
816 LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
817 LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
819 LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
822 * Set a port to an lttcomm_sock. This will have no effect is the socket is
825 LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
827 LTTNG_HIDDEN
void lttcomm_init(void);
828 /* Get network timeout, in milliseconds */
829 LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void);
831 #endif /* _LTTNG_SESSIOND_COMM_H */