2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
25 #ifndef _LTTNG_SESSIOND_COMM_H
26 #define _LTTNG_SESSIOND_COMM_H
29 #include <lttng/lttng.h>
30 #include <lttng/snapshot-internal.h>
31 #include <lttng/save-internal.h>
32 #include <lttng/channel-internal.h>
33 #include <lttng/trigger/trigger-internal.h>
34 #include <lttng/rotate-internal.h>
35 #include <common/compat/socket.h>
36 #include <common/uri.h>
37 #include <common/defaults.h>
38 #include <common/uuid.h>
39 #include <common/macros.h>
40 #include <common/optional.h>
42 #include <arpa/inet.h>
43 #include <netinet/in.h>
48 #include <common/unix.h>
50 /* Queue size of listen(2) */
51 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
53 /* Maximum number of FDs that can be sent over a Unix socket */
54 #define LTTCOMM_MAX_SEND_FDS 4
57 * Get the error code index from 0 since LTTCOMM_OK start at 1000
59 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
61 enum lttcomm_sessiond_command
{
63 LTTNG_ADD_CONTEXT
= 0,
64 /* LTTNG_CALIBRATE used to be here */
65 LTTNG_DISABLE_CHANNEL
= 2,
66 LTTNG_DISABLE_EVENT
= 3,
67 LTTNG_LIST_SYSCALLS
= 4,
68 LTTNG_ENABLE_CHANNEL
= 5,
69 LTTNG_ENABLE_EVENT
= 6,
71 /* Session daemon command */
73 LTTNG_DESTROY_SESSION
= 9,
74 LTTNG_LIST_CHANNELS
= 10,
75 LTTNG_LIST_DOMAINS
= 11,
76 LTTNG_LIST_EVENTS
= 12,
77 LTTNG_LIST_SESSIONS
= 13,
78 LTTNG_LIST_TRACEPOINTS
= 14,
79 LTTNG_REGISTER_CONSUMER
= 15,
80 LTTNG_START_TRACE
= 16,
81 LTTNG_STOP_TRACE
= 17,
82 LTTNG_LIST_TRACEPOINT_FIELDS
= 18,
85 LTTNG_DISABLE_CONSUMER
= 19,
86 LTTNG_ENABLE_CONSUMER
= 20,
87 LTTNG_SET_CONSUMER_URI
= 21,
90 LTTNG_DATA_PENDING
= 24,
91 LTTNG_SNAPSHOT_ADD_OUTPUT
= 25,
92 LTTNG_SNAPSHOT_DEL_OUTPUT
= 26,
93 LTTNG_SNAPSHOT_LIST_OUTPUT
= 27,
94 LTTNG_SNAPSHOT_RECORD
= 28,
97 LTTNG_SAVE_SESSION
= 31,
99 LTTNG_UNTRACK_ID
= 33,
100 LTTNG_LIST_TRACKER_IDS
= 34,
101 LTTNG_SET_SESSION_SHM_PATH
= 40,
102 LTTNG_REGENERATE_METADATA
= 41,
103 LTTNG_REGENERATE_STATEDUMP
= 42,
104 LTTNG_REGISTER_TRIGGER
= 43,
105 LTTNG_UNREGISTER_TRIGGER
= 44,
106 LTTNG_ROTATE_SESSION
= 45,
107 LTTNG_ROTATION_GET_INFO
= 46,
108 LTTNG_ROTATION_SET_SCHEDULE
= 47,
109 LTTNG_SESSION_LIST_ROTATION_SCHEDULES
= 48,
110 LTTNG_CREATE_SESSION_EXT
= 49,
111 LTTNG_CLEAR_SESSION
= 50,
114 enum lttcomm_relayd_command
{
115 RELAYD_ADD_STREAM
= 1,
116 RELAYD_CREATE_SESSION
= 2,
117 RELAYD_START_DATA
= 3,
118 RELAYD_UPDATE_SYNC_INFO
= 4,
120 RELAYD_SEND_METADATA
= 6,
121 RELAYD_CLOSE_STREAM
= 7,
122 RELAYD_DATA_PENDING
= 8,
123 RELAYD_QUIESCENT_CONTROL
= 9,
124 RELAYD_BEGIN_DATA_PENDING
= 10,
125 RELAYD_END_DATA_PENDING
= 11,
126 RELAYD_ADD_INDEX
= 12,
127 RELAYD_SEND_INDEX
= 13,
128 RELAYD_CLOSE_INDEX
= 14,
129 /* Live-reading commands (2.4+). */
130 RELAYD_LIST_SESSIONS
= 15,
131 /* All streams of the channel have been sent to the relayd (2.4+). */
132 RELAYD_STREAMS_SENT
= 16,
133 /* Ask the relay to reset the metadata trace file (2.8+) */
134 RELAYD_RESET_METADATA
= 17,
135 /* Ask the relay to rotate a set of stream files (2.11+) */
136 RELAYD_ROTATE_STREAMS
= 18,
137 /* Ask the relay to create a trace chunk (2.11+) */
138 RELAYD_CREATE_TRACE_CHUNK
= 19,
139 /* Ask the relay to close a trace chunk (2.11+) */
140 RELAYD_CLOSE_TRACE_CHUNK
= 20,
141 /* Ask the relay whether a trace chunk exists (2.11+) */
142 RELAYD_TRACE_CHUNK_EXISTS
= 21,
143 /* Get the current configuration of a relayd peer (2.12+) */
144 RELAYD_GET_CONFIGURATION
= 22,
146 /* Feature branch specific commands start at 10000. */
150 * lttcomm error code.
152 enum lttcomm_return_code
{
153 LTTCOMM_CONSUMERD_SUCCESS
= 0, /* Everything went fine. */
155 * Some code paths use -1 to express an error, others
156 * negate this consumer return code. Starting codes at
157 * 100 ensures there is no mix-up between this error value
158 * and legitimate status codes.
160 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
= 100, /* Command socket ready */
161 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD
, /* Success on receiving fds */
162 LTTCOMM_CONSUMERD_ERROR_RECV_FD
, /* Error on receiving fds */
163 LTTCOMM_CONSUMERD_ERROR_RECV_CMD
, /* Error on receiving command */
164 LTTCOMM_CONSUMERD_POLL_ERROR
, /* Error in polling thread */
165 LTTCOMM_CONSUMERD_POLL_NVAL
, /* Poll on closed fd */
166 LTTCOMM_CONSUMERD_POLL_HUP
, /* All fds have hungup */
167 LTTCOMM_CONSUMERD_EXIT_SUCCESS
, /* Consumerd exiting normally */
168 LTTCOMM_CONSUMERD_EXIT_FAILURE
, /* Consumerd exiting on error */
169 LTTCOMM_CONSUMERD_OUTFD_ERROR
, /* Error opening the tracefile */
170 LTTCOMM_CONSUMERD_SPLICE_EBADF
, /* EBADF from splice(2) */
171 LTTCOMM_CONSUMERD_SPLICE_EINVAL
, /* EINVAL from splice(2) */
172 LTTCOMM_CONSUMERD_SPLICE_ENOMEM
, /* ENOMEM from splice(2) */
173 LTTCOMM_CONSUMERD_SPLICE_ESPIPE
, /* ESPIPE from splice(2) */
174 LTTCOMM_CONSUMERD_ENOMEM
, /* Consumer is out of memory */
175 LTTCOMM_CONSUMERD_ERROR_METADATA
, /* Error with metadata. */
176 LTTCOMM_CONSUMERD_FATAL
, /* Fatal error. */
177 LTTCOMM_CONSUMERD_RELAYD_FAIL
, /* Error on remote relayd */
178 LTTCOMM_CONSUMERD_CHANNEL_FAIL
, /* Channel creation failed. */
179 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
, /* Channel not found. */
180 LTTCOMM_CONSUMERD_ALREADY_SET
, /* Resource already set. */
181 LTTCOMM_CONSUMERD_ROTATION_FAIL
, /* Rotation has failed. */
182 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED
, /* snapshot has failed. */
183 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
,/* Trace chunk creation failed. */
184 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
, /* Trace chunk creation failed. */
185 LTTCOMM_CONSUMERD_INVALID_PARAMETERS
, /* Invalid parameters. */
186 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
, /* Trace chunk exists on consumer daemon. */
187 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
,/* Trace chunk exists on relay daemon. */
188 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
, /* Unknown trace chunk. */
189 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
, /* Relayd does not accept clear command. */
191 /* MUST be last element */
192 LTTCOMM_NR
, /* Last element */
195 /* lttng socket protocol. */
196 enum lttcomm_sock_proto
{
202 * Index in the net_families array below. Please keep in sync!
204 enum lttcomm_sock_domain
{
209 enum lttcomm_metadata_command
{
210 LTTCOMM_METADATA_REQUEST
= 1,
214 * Commands sent from the consumerd to the sessiond to request if new metadata
215 * is available. This message is used to find the per UID _or_ per PID registry
216 * for the channel key. For per UID lookup, the triplet
217 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
218 * per PID registry indexed by session id ignoring the other values.
220 struct lttcomm_metadata_request_msg
{
221 uint64_t session_id
; /* Tracing session id */
222 uint64_t session_id_per_pid
; /* Tracing session id for per-pid */
223 uint32_t bits_per_long
; /* Consumer ABI */
225 uint64_t key
; /* Metadata channel key. */
228 struct lttcomm_sockaddr
{
229 enum lttcomm_sock_domain type
;
231 struct sockaddr_in sin
;
232 struct sockaddr_in6 sin6
;
236 struct lttcomm_sock
{
238 enum lttcomm_sock_proto proto
;
239 struct lttcomm_sockaddr sockaddr
;
240 const struct lttcomm_proto_ops
*ops
;
244 * Relayd sock. Adds the protocol version to use for the communications with
247 struct lttcomm_relayd_sock
{
248 struct lttcomm_sock sock
;
253 struct lttcomm_net_family
{
255 int (*create
) (struct lttcomm_sock
*sock
, int type
, int proto
);
258 struct lttcomm_proto_ops
{
259 int (*bind
) (struct lttcomm_sock
*sock
);
260 int (*close
) (struct lttcomm_sock
*sock
);
261 int (*connect
) (struct lttcomm_sock
*sock
);
262 struct lttcomm_sock
*(*accept
) (struct lttcomm_sock
*sock
);
263 int (*listen
) (struct lttcomm_sock
*sock
, int backlog
);
264 ssize_t (*recvmsg
) (struct lttcomm_sock
*sock
, void *buf
, size_t len
,
266 ssize_t (*sendmsg
) (struct lttcomm_sock
*sock
, const void *buf
,
267 size_t len
, int flags
);
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 uint32_t tracker_type
; /* enum lttng_tracker_type */
358 uint32_t id_type
; /* enum lttng_tracker_id_type */
364 * for LTTNG_ID_STRING, followed by a variable length
365 * zero-terminated string of length "var_len", which
366 * includes the final \0.
368 } LTTNG_PACKED id_tracker
;
370 uint32_t tracker_type
; /* enum lttng_tracker_type */
371 } LTTNG_PACKED id_tracker_list
;
374 } LTTNG_PACKED trigger
;
376 uint64_t rotation_id
;
377 } LTTNG_PACKED get_rotation_info
;
379 /* enum lttng_rotation_schedule_type */
382 * If set == 1, set schedule to value, if set == 0,
383 * clear this schedule type.
387 } LTTNG_PACKED rotation_set_schedule
;
390 * Includes the null-terminator.
391 * Must be an absolute path.
393 * Size bounded by LTTNG_PATH_MAX.
395 uint16_t home_dir_size
;
396 uint64_t session_descriptor_size
;
397 /* An lttng_session_descriptor follows. */
398 } LTTNG_PACKED create_session
;
402 #define LTTNG_FILTER_MAX_LEN 65536
403 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
406 * Filter bytecode data. The reloc table is located at the end of the
407 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
408 * starts at reloc_table_offset.
410 #define LTTNG_FILTER_PADDING 32
411 struct lttng_filter_bytecode
{
412 uint32_t len
; /* len of data */
413 uint32_t reloc_table_offset
;
415 char padding
[LTTNG_FILTER_PADDING
];
420 * Event exclusion data. At the end of the structure, there will actually
421 * by zero or more names, where the actual number of names is given by
422 * the 'count' item of the structure.
424 #define LTTNG_EVENT_EXCLUSION_PADDING 32
425 struct lttng_event_exclusion
{
427 char padding
[LTTNG_EVENT_EXCLUSION_PADDING
];
428 char names
[0][LTTNG_SYMBOL_NAME_LEN
];
431 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
432 (&(_exclusion)->names[_i][0])
435 * Event command header.
437 struct lttcomm_event_command_header
{
438 /* Number of events */
443 * Event extended info header. This is the structure preceding each
444 * extended info data.
446 struct lttcomm_event_extended_header
{
448 * Size of filter string immediately following this header.
449 * This size includes the terminal null character.
454 * Number of exclusion names, immediately following the filter
455 * string. Each exclusion name has a fixed length of
456 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
459 uint32_t nb_exclusions
;
462 * Size of the event's userspace probe location (if applicable).
464 uint32_t userspace_probe_location_len
;
468 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
470 struct lttcomm_session_destroy_command_header
{
471 /* enum lttng_session */
472 int32_t rotation_state
;
476 * tracker command header.
478 struct lttcomm_tracker_command_header
{
479 uint32_t nb_tracker_id
;
482 struct lttcomm_tracker_id_header
{
483 uint32_t type
; /* enum lttng_tracker_id_type */
486 uint32_t var_data_len
;
491 * Data structure for the response from sessiond to the lttng client.
493 struct lttcomm_lttng_msg
{
494 uint32_t cmd_type
; /* enum lttcomm_sessiond_command */
495 uint32_t ret_code
; /* enum lttcomm_return_code */
496 uint32_t pid
; /* pid_t */
497 uint32_t cmd_header_size
;
501 struct lttcomm_lttng_output_id
{
506 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
507 * to either add a channel, add a stream, update a stream, or stop
510 struct lttcomm_consumer_msg
{
511 uint32_t cmd_type
; /* enum lttng_consumer_command */
514 uint64_t channel_key
;
516 /* ID of the session's current trace chunk. */
517 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
518 char pathname
[PATH_MAX
];
520 /* nb_init_streams is the number of streams open initially. */
521 uint32_t nb_init_streams
;
522 char name
[LTTNG_SYMBOL_NAME_LEN
];
523 /* Use splice or mmap to consume this fd */
524 enum lttng_event_output output
;
525 int type
; /* Per cpu or metadata. */
526 uint64_t tracefile_size
; /* bytes */
527 uint32_t tracefile_count
; /* number of tracefiles */
528 /* If the channel's streams have to be monitored or not. */
530 /* timer to check the streams usage in live mode (usec). */
531 unsigned int live_timer_interval
;
532 /* timer to sample a channel's positions (usec). */
533 unsigned int monitor_timer_interval
;
534 } LTTNG_PACKED channel
; /* Only used by Kernel. */
537 uint64_t channel_key
;
538 int32_t cpu
; /* On which CPU this stream is assigned. */
539 /* Tells the consumer if the stream should be or not monitored. */
541 } LTTNG_PACKED stream
; /* Only used by Kernel. */
544 enum lttng_stream_type type
;
545 /* Open socket to the relayd */
546 struct lttcomm_relayd_sock sock
;
547 /* Tracing session id associated to the relayd. */
549 /* Relayd session id, only used with control socket. */
550 uint64_t relayd_session_id
;
551 } LTTNG_PACKED relayd_sock
;
553 uint64_t net_seq_idx
;
554 } LTTNG_PACKED destroy_relayd
;
557 } LTTNG_PACKED data_pending
;
559 uint64_t subbuf_size
; /* bytes */
560 uint64_t num_subbuf
; /* power of 2 */
561 int32_t overwrite
; /* 1: overwrite, 0: discard */
562 uint32_t switch_timer_interval
; /* usec */
563 uint32_t read_timer_interval
; /* usec */
564 unsigned int live_timer_interval
; /* usec */
565 uint32_t monitor_timer_interval
; /* usec */
566 int32_t output
; /* splice, mmap */
567 int32_t type
; /* metadata or per_cpu */
568 uint64_t session_id
; /* Tracing session id */
569 char pathname
[PATH_MAX
]; /* Channel file path. */
570 char name
[LTTNG_SYMBOL_NAME_LEN
]; /* Channel name. */
571 /* Credentials used to open the UST buffer shared mappings. */
575 } LTTNG_PACKED buffer_credentials
;
576 uint64_t relayd_id
; /* Relayd id if apply. */
577 uint64_t key
; /* Unique channel key. */
578 /* ID of the session's current trace chunk. */
579 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id
;
580 unsigned char uuid
[LTTNG_UUID_LEN
]; /* uuid for ust tracer. */
581 uint32_t chan_id
; /* Channel ID on the tracer side. */
582 uint64_t tracefile_size
; /* bytes */
583 uint32_t tracefile_count
; /* number of tracefiles */
584 uint64_t session_id_per_pid
; /* Per-pid session ID. */
585 /* Tells the consumer if the stream should be or not monitored. */
588 * For UST per UID buffers, this is the application UID of the
589 * channel. This can be different from the user UID requesting the
590 * channel creation and used for the rights on the stream file
591 * because the application can be in the tracing for instance.
593 uint32_t ust_app_uid
;
594 int64_t blocking_timeout
;
595 char root_shm_path
[PATH_MAX
];
596 char shm_path
[PATH_MAX
];
597 } LTTNG_PACKED ask_channel
;
600 } LTTNG_PACKED get_channel
;
603 } LTTNG_PACKED destroy_channel
;
605 uint64_t key
; /* Metadata channel key. */
606 uint64_t target_offset
; /* Offset in the consumer */
607 uint64_t len
; /* Length of metadata to be received. */
608 uint64_t version
; /* Version of the metadata. */
609 } LTTNG_PACKED push_metadata
;
611 uint64_t key
; /* Metadata channel key. */
612 } LTTNG_PACKED close_metadata
;
614 uint64_t key
; /* Metadata channel key. */
615 } LTTNG_PACKED setup_metadata
;
617 uint64_t key
; /* Channel key. */
618 } LTTNG_PACKED flush_channel
;
620 uint64_t key
; /* Channel key. */
621 } LTTNG_PACKED clear_quiescent_channel
;
623 char pathname
[PATH_MAX
];
624 /* Indicate if the snapshot goes on the relayd or locally. */
626 uint32_t metadata
; /* This a metadata snapshot. */
627 uint64_t relayd_id
; /* Relayd id if apply. */
629 uint64_t nb_packets_per_stream
;
630 } LTTNG_PACKED snapshot_channel
;
632 uint64_t channel_key
;
633 uint64_t net_seq_idx
;
634 } LTTNG_PACKED sent_streams
;
637 uint64_t channel_key
;
638 } LTTNG_PACKED discarded_events
;
641 uint64_t channel_key
;
642 } LTTNG_PACKED lost_packets
;
645 } LTTNG_PACKED regenerate_metadata
;
647 uint32_t metadata
; /* This is a metadata channel. */
648 uint64_t relayd_id
; /* Relayd id if apply. */
650 } LTTNG_PACKED rotate_channel
;
654 } LTTNG_PACKED check_rotation_pending_local
;
659 } LTTNG_PACKED check_rotation_pending_relay
;
662 * Relayd id, if applicable (remote).
664 * A directory file descriptor referring to the chunk's
665 * output folder is transmitted if the chunk is local
668 * `override_name` is left NULL (all-zeroes) if the
669 * chunk's name is not overridden.
671 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
672 char override_name
[LTTNG_NAME_MAX
];
675 uint64_t creation_timestamp
;
676 LTTNG_OPTIONAL_COMM(struct {
679 } LTTNG_PACKED
) LTTNG_PACKED credentials
;
680 } LTTNG_PACKED create_trace_chunk
;
682 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
685 uint64_t close_timestamp
;
686 /* enum lttng_trace_chunk_command_type */
687 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
688 } LTTNG_PACKED close_trace_chunk
;
690 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id
;
693 } LTTNG_PACKED trace_chunk_exists
;
695 lttng_uuid sessiond_uuid
;
699 } LTTNG_PACKED clear_channel
;
704 * Channel monitoring message returned to the session daemon on every
705 * monitor timer expiration.
707 struct lttcomm_consumer_channel_monitor_msg
{
708 /* Key of the sampled channel. */
711 * Lowest and highest usage (bytes) at the moment the sample was taken.
713 uint64_t lowest
, highest
;
715 * Sum of all the consumed positions for a channel.
717 uint64_t total_consumed
;
721 * Status message returned to the sessiond after a received command.
723 struct lttcomm_consumer_status_msg
{
724 enum lttcomm_return_code ret_code
;
727 struct lttcomm_consumer_status_channel
{
728 enum lttcomm_return_code ret_code
;
730 unsigned int stream_count
;
733 struct lttcomm_consumer_close_trace_chunk_reply
{
734 enum lttcomm_return_code ret_code
;
735 uint32_t path_length
;
739 #ifdef HAVE_LIBLTTNG_UST_CTL
741 #include <lttng/ust-abi.h>
744 * Data structure for the commands sent from sessiond to UST.
746 struct lttcomm_ust_msg
{
750 struct lttng_ust_channel channel
;
751 struct lttng_ust_stream stream
;
752 struct lttng_ust_event event
;
753 struct lttng_ust_context context
;
754 struct lttng_ust_tracer_version version
;
759 * Data structure for the response from UST to the session daemon.
760 * cmd_type is sent back in the reply for validation.
762 struct lttcomm_ust_reply
{
765 uint32_t ret_code
; /* enum lttcomm_return_code */
766 uint32_t ret_val
; /* return value */
769 uint64_t memory_map_size
;
770 } LTTNG_PACKED channel
;
772 uint64_t memory_map_size
;
773 } LTTNG_PACKED stream
;
774 struct lttng_ust_tracer_version version
;
778 #endif /* HAVE_LIBLTTNG_UST_CTL */
780 LTTNG_HIDDEN
const char *lttcomm_get_readable_code(enum lttcomm_return_code code
);
782 LTTNG_HIDDEN
int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
783 const char *ip
, unsigned int port
);
784 LTTNG_HIDDEN
int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr
*sockaddr
,
785 const char *ip
, unsigned int port
);
787 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock(enum lttcomm_sock_proto proto
);
788 LTTNG_HIDDEN
int lttcomm_create_sock(struct lttcomm_sock
*sock
);
789 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_sock_from_uri(struct lttng_uri
*uri
);
790 LTTNG_HIDDEN
void lttcomm_destroy_sock(struct lttcomm_sock
*sock
);
791 LTTNG_HIDDEN
struct lttcomm_sock
*lttcomm_alloc_copy_sock(struct lttcomm_sock
*src
);
792 LTTNG_HIDDEN
void lttcomm_copy_sock(struct lttcomm_sock
*dst
,
793 struct lttcomm_sock
*src
);
795 /* Relayd socket object. */
796 LTTNG_HIDDEN
struct lttcomm_relayd_sock
*lttcomm_alloc_relayd_sock(
797 struct lttng_uri
*uri
, uint32_t major
, uint32_t minor
);
799 LTTNG_HIDDEN
int lttcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
800 LTTNG_HIDDEN
int lttcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
802 LTTNG_HIDDEN
int lttcomm_sock_get_port(const struct lttcomm_sock
*sock
,
805 * Set a port to an lttcomm_sock. This will have no effect is the socket is
808 LTTNG_HIDDEN
int lttcomm_sock_set_port(struct lttcomm_sock
*sock
, uint16_t port
);
810 LTTNG_HIDDEN
void lttcomm_init(void);
811 /* Get network timeout, in milliseconds */
812 LTTNG_HIDDEN
unsigned long lttcomm_get_network_timeout(void);
814 #endif /* _LTTNG_SESSIOND_COMM_H */