2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Julien Desfossez <julien.desfossez@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <lttng/lttng.h>
26 #include <common/defaults.h>
27 #include <common/index/ctf-index.h>
28 #include <common/macros.h>
29 #include <common/compat/uuid.h>
30 #include <common/optional.h>
32 #define RELAYD_VERSION_COMM_MAJOR VERSION_MAJOR
33 #define RELAYD_VERSION_COMM_MINOR VERSION_MINOR
35 #define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4 64
36 #define RELAYD_COMM_LTTNG_NAME_MAX_2_4 255
37 #define RELAYD_COMM_LTTNG_PATH_MAX 4096
38 #define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN 264 /* 256 + 8 */
41 * lttng-relayd communication header.
43 struct lttcomm_relayd_hdr
{
44 /* Circuit ID not used for now so always ignored */
46 uint64_t data_size
; /* data size following this header */
47 uint32_t cmd
; /* enum lttcomm_relayd_command */
48 uint32_t cmd_version
; /* command version */
52 * lttng-relayd data header.
54 struct lttcomm_relayd_data_hdr
{
55 /* Circuit ID not used for now so always ignored */
57 uint64_t stream_id
; /* Stream ID known by the relayd */
58 uint64_t net_seq_num
; /* Network sequence number, per stream. */
59 uint32_t data_size
; /* data size following this header */
60 uint32_t padding_size
; /* Size of 0 padding the data */
64 * Reply from a create session command.
66 struct lttcomm_relayd_status_session
{
72 * Used to add a stream on the relay daemon.
74 struct lttcomm_relayd_add_stream
{
75 char channel_name
[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN
];
76 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
80 * Used to add a stream on the relay daemon.
81 * Protocol version 2.2
83 struct lttcomm_relayd_add_stream_2_2
{
84 char channel_name
[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN
];
85 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
86 uint64_t tracefile_size
;
87 uint64_t tracefile_count
;
90 struct lttcomm_relayd_add_stream_2_11
{
91 uint32_t channel_name_len
;
92 uint32_t pathname_len
;
93 uint64_t tracefile_size
;
94 uint64_t tracefile_count
;
95 uint64_t trace_chunk_id
;
100 * Answer from an add stream command.
102 struct lttcomm_relayd_status_stream
{
108 * Used to return command code for command not needing special data.
110 struct lttcomm_relayd_generic_reply
{
117 struct lttcomm_relayd_version
{
123 * Metadata payload used when metadata command is sent.
125 struct lttcomm_relayd_metadata_payload
{
127 uint32_t padding_size
;
132 * Used to indicate that a specific stream id can now be closed.
134 struct lttcomm_relayd_close_stream
{
136 uint64_t last_net_seq_num
; /* sequence number of last packet */
140 * Used to test if for a given stream id the data is pending on the relayd side
143 struct lttcomm_relayd_data_pending
{
145 uint64_t last_net_seq_num
; /* Sequence number of the last packet */
148 struct lttcomm_relayd_begin_data_pending
{
152 struct lttcomm_relayd_end_data_pending
{
156 struct lttcomm_relayd_quiescent_control
{
163 struct lttcomm_relayd_index
{
164 uint64_t relay_stream_id
;
165 uint64_t net_seq_num
;
166 uint64_t packet_size
;
167 uint64_t content_size
;
168 uint64_t timestamp_begin
;
169 uint64_t timestamp_end
;
170 uint64_t events_discarded
;
173 uint64_t stream_instance_id
;
174 uint64_t packet_seq_num
;
177 static inline size_t lttcomm_relayd_index_len(uint32_t major
, uint32_t minor
)
182 return offsetof(struct lttcomm_relayd_index
, stream_id
)
183 + member_sizeof(struct lttcomm_relayd_index
,
186 return offsetof(struct lttcomm_relayd_index
, packet_seq_num
)
187 + member_sizeof(struct lttcomm_relayd_index
,
197 * Create session in 2.4 adds additionnal parameters for live reading.
199 struct lttcomm_relayd_create_session_2_4
{
200 char session_name
[RELAYD_COMM_LTTNG_NAME_MAX_2_4
];
201 char hostname
[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4
];
206 struct lttcomm_relayd_create_session_2_11
{
207 uint32_t session_name_len
;
208 uint32_t hostname_len
;
209 /* Optional, set to 0 to indicate it is not user-specified. */
210 uint32_t base_path_len
;
213 uint8_t session_name_contains_creation_time
;
214 /* Sessiond instance UUID */
215 lttng_uuid sessiond_uuid
;
216 /* Sessiond session id */
218 /* Session creation time, in seconds since UNIX Epoch. */
219 uint64_t creation_time
;
220 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED current_chunk_id
;
221 /* Contains the session_name, hostname, base_path. */
225 struct lttcomm_relayd_create_session_reply_2_11
{
226 struct lttcomm_relayd_status_session generic
;
227 /* Includes the '\0' terminator. */
228 uint32_t output_path_length
;
233 * Used to ask the relay to reset the metadata trace file (regeneration).
234 * Send the new version of the metadata (starts at 0).
236 struct lttcomm_relayd_reset_metadata
{
241 struct lttcomm_relayd_stream_rotation_position
{
244 * Sequence number of the first packet belonging to the new
245 * "destination" trace chunk to which the stream is rotating.
247 * Ignored for metadata streams.
249 uint64_t rotate_at_seq_num
;
252 struct lttcomm_relayd_rotate_streams
{
253 uint32_t stream_count
;
255 * Streams can be rotated outside of a chunk but not be parented to
258 LTTNG_OPTIONAL_COMM(uint64_t) new_chunk_id
;
259 /* `stream_count` positions follow. */
260 struct lttcomm_relayd_stream_rotation_position rotation_positions
[];
263 struct lttcomm_relayd_create_trace_chunk
{
265 /* Seconds since EPOCH. */
266 uint64_t creation_timestamp
;
267 /* Includes trailing NULL. */
268 uint32_t override_name_length
;
269 char override_name
[];
272 struct lttcomm_relayd_close_trace_chunk
{
274 /* Seconds since EPOCH. */
275 uint64_t close_timestamp
;
276 /* enum lttng_trace_chunk_command_type */
277 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command
;
280 struct lttcomm_relayd_close_trace_chunk_reply
{
281 struct lttcomm_relayd_generic_reply generic
;
282 /* Includes trailing NULL. */
283 uint32_t path_length
;
287 struct lttcomm_relayd_trace_chunk_exists
{
291 struct lttcomm_relayd_trace_chunk_exists_reply
{
292 struct lttcomm_relayd_generic_reply generic
;
293 uint8_t trace_chunk_exists
;
296 #endif /* _RELAYD_COMM */