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>
29 #define RELAYD_VERSION_COMM_MAJOR VERSION_MAJOR
30 #define RELAYD_VERSION_COMM_MINOR VERSION_MINOR
32 #define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4 64
33 #define RELAYD_COMM_LTTNG_NAME_MAX_2_4 255
34 #define RELAYD_COMM_LTTNG_PATH_MAX 4096
35 #define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN 264 /* 256 + 8 */
38 * lttng-relayd communication header.
40 struct lttcomm_relayd_hdr
{
41 /* Circuit ID not used for now so always ignored */
43 uint64_t data_size
; /* data size following this header */
44 uint32_t cmd
; /* enum lttcomm_relayd_command */
45 uint32_t cmd_version
; /* command version */
49 * lttng-relayd data header.
51 struct lttcomm_relayd_data_hdr
{
52 /* Circuit ID not used for now so always ignored */
54 uint64_t stream_id
; /* Stream ID known by the relayd */
55 uint64_t net_seq_num
; /* Network sequence number, per stream. */
56 uint32_t data_size
; /* data size following this header */
57 uint32_t padding_size
; /* Size of 0 padding the data */
61 * Reply from a create session command.
63 struct lttcomm_relayd_status_session
{
69 * Used to add a stream on the relay daemon.
71 struct lttcomm_relayd_add_stream
{
72 char channel_name
[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN
];
73 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
77 * Used to add a stream on the relay daemon.
78 * Protocol version 2.2
80 struct lttcomm_relayd_add_stream_2_2
{
81 char channel_name
[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN
];
82 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
83 uint64_t tracefile_size
;
84 uint64_t tracefile_count
;
87 struct lttcomm_relayd_add_stream_2_11
{
88 uint32_t channel_name_len
;
89 uint32_t pathname_len
;
90 uint64_t tracefile_size
;
91 uint64_t tracefile_count
;
92 uint64_t trace_archive_id
;
97 * Answer from an add stream command.
99 struct lttcomm_relayd_status_stream
{
105 * Used to return command code for command not needing special data.
107 struct lttcomm_relayd_generic_reply
{
114 struct lttcomm_relayd_version
{
120 * Metadata payload used when metadata command is sent.
122 struct lttcomm_relayd_metadata_payload
{
124 uint32_t padding_size
;
129 * Used to indicate that a specific stream id can now be closed.
131 struct lttcomm_relayd_close_stream
{
133 uint64_t last_net_seq_num
; /* sequence number of last packet */
137 * Used to test if for a given stream id the data is pending on the relayd side
140 struct lttcomm_relayd_data_pending
{
142 uint64_t last_net_seq_num
; /* Sequence number of the last packet */
145 struct lttcomm_relayd_begin_data_pending
{
149 struct lttcomm_relayd_end_data_pending
{
153 struct lttcomm_relayd_quiescent_control
{
160 struct lttcomm_relayd_index
{
161 uint64_t relay_stream_id
;
162 uint64_t net_seq_num
;
163 uint64_t packet_size
;
164 uint64_t content_size
;
165 uint64_t timestamp_begin
;
166 uint64_t timestamp_end
;
167 uint64_t events_discarded
;
170 uint64_t stream_instance_id
;
171 uint64_t packet_seq_num
;
174 static inline size_t lttcomm_relayd_index_len(uint32_t major
, uint32_t minor
)
179 return offsetof(struct lttcomm_relayd_index
, stream_id
)
180 + member_sizeof(struct lttcomm_relayd_index
,
183 return offsetof(struct lttcomm_relayd_index
, packet_seq_num
)
184 + member_sizeof(struct lttcomm_relayd_index
,
194 * Create session in 2.4 adds additionnal parameters for live reading.
196 struct lttcomm_relayd_create_session_2_4
{
197 char session_name
[RELAYD_COMM_LTTNG_NAME_MAX_2_4
];
198 char hostname
[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4
];
203 struct lttcomm_relayd_create_session_2_11
{
204 uint32_t session_name_len
;
205 uint32_t hostname_len
;
208 /* Contains the session_name and hostname */
213 * Used to ask the relay to reset the metadata trace file (regeneration).
214 * Send the new version of the metadata (starts at 0).
216 struct lttcomm_relayd_reset_metadata
{
221 struct lttcomm_relayd_rotate_stream
{
223 /* Ignored for metadata streams. */
224 uint64_t rotate_at_seq_num
;
225 uint64_t new_chunk_id
;
226 /* Includes trailing NULL. */
227 uint32_t pathname_length
;
228 /* Must be the last member of this structure. */
232 struct lttcomm_relayd_rotate_rename
{
233 uint32_t old_path_length
;
234 uint32_t new_path_length
;
235 /* Concatenation of the old and new paths, separated by \0. */
239 struct lttcomm_relayd_rotate_pending
{
243 struct lttcomm_relayd_rotate_pending_reply
{
244 struct lttcomm_relayd_generic_reply generic
;
245 /* Valid values are [0, 1]. */
249 struct lttcomm_relayd_mkdir
{
250 /* Includes trailing NULL */
255 #endif /* _RELAYD_COMM */