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>
30 #define RELAYD_VERSION_COMM_MAJOR VERSION_MAJOR
31 #define RELAYD_VERSION_COMM_MINOR VERSION_MINOR
33 #define RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4 64
34 #define RELAYD_COMM_LTTNG_NAME_MAX_2_4 255
35 #define RELAYD_COMM_LTTNG_PATH_MAX 4096
36 #define RELAYD_COMM_DEFAULT_STREAM_NAME_LEN 264 /* 256 + 8 */
39 * lttng-relayd communication header.
41 struct lttcomm_relayd_hdr
{
42 /* Circuit ID not used for now so always ignored */
44 uint64_t data_size
; /* data size following this header */
45 uint32_t cmd
; /* enum lttcomm_relayd_command */
46 uint32_t cmd_version
; /* command version */
50 * lttng-relayd data header.
52 struct lttcomm_relayd_data_hdr
{
53 /* Circuit ID not used for now so always ignored */
55 uint64_t stream_id
; /* Stream ID known by the relayd */
56 uint64_t net_seq_num
; /* Network sequence number, per stream. */
57 uint32_t data_size
; /* data size following this header */
58 uint32_t padding_size
; /* Size of 0 padding the data */
62 * Reply from a create session command.
64 struct lttcomm_relayd_status_session
{
70 * Used to add a stream on the relay daemon.
72 struct lttcomm_relayd_add_stream
{
73 char channel_name
[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN
];
74 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
78 * Used to add a stream on the relay daemon.
79 * Protocol version 2.2
81 struct lttcomm_relayd_add_stream_2_2
{
82 char channel_name
[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN
];
83 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
84 uint64_t tracefile_size
;
85 uint64_t tracefile_count
;
88 struct lttcomm_relayd_add_stream_2_11
{
89 uint32_t channel_name_len
;
90 uint32_t pathname_len
;
91 uint64_t tracefile_size
;
92 uint64_t tracefile_count
;
93 uint64_t trace_archive_id
;
98 * Answer from an add stream command.
100 struct lttcomm_relayd_status_stream
{
106 * Used to return command code for command not needing special data.
108 struct lttcomm_relayd_generic_reply
{
115 struct lttcomm_relayd_version
{
121 * Metadata payload used when metadata command is sent.
123 struct lttcomm_relayd_metadata_payload
{
125 uint32_t padding_size
;
130 * Used to indicate that a specific stream id can now be closed.
132 struct lttcomm_relayd_close_stream
{
134 uint64_t last_net_seq_num
; /* sequence number of last packet */
138 * Used to test if for a given stream id the data is pending on the relayd side
141 struct lttcomm_relayd_data_pending
{
143 uint64_t last_net_seq_num
; /* Sequence number of the last packet */
146 struct lttcomm_relayd_begin_data_pending
{
150 struct lttcomm_relayd_end_data_pending
{
154 struct lttcomm_relayd_quiescent_control
{
161 struct lttcomm_relayd_index
{
162 uint64_t relay_stream_id
;
163 uint64_t net_seq_num
;
164 uint64_t packet_size
;
165 uint64_t content_size
;
166 uint64_t timestamp_begin
;
167 uint64_t timestamp_end
;
168 uint64_t events_discarded
;
171 uint64_t stream_instance_id
;
172 uint64_t packet_seq_num
;
175 static inline size_t lttcomm_relayd_index_len(uint32_t major
, uint32_t minor
)
180 return offsetof(struct lttcomm_relayd_index
, stream_id
)
181 + member_sizeof(struct lttcomm_relayd_index
,
184 return offsetof(struct lttcomm_relayd_index
, packet_seq_num
)
185 + member_sizeof(struct lttcomm_relayd_index
,
195 * Create session in 2.4 adds additionnal parameters for live reading.
197 struct lttcomm_relayd_create_session_2_4
{
198 char session_name
[RELAYD_COMM_LTTNG_NAME_MAX_2_4
];
199 char hostname
[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4
];
204 struct lttcomm_relayd_create_session_2_11
{
205 uint32_t session_name_len
;
206 uint32_t hostname_len
;
209 /* Contains the session_name and hostname */
214 * Used to ask the relay to reset the metadata trace file (regeneration).
215 * Send the new version of the metadata (starts at 0).
217 struct lttcomm_relayd_reset_metadata
{
222 struct lttcomm_relayd_rotate_stream
{
224 /* Ignored for metadata streams. */
225 uint64_t rotate_at_seq_num
;
226 uint64_t new_chunk_id
;
227 /* Includes trailing NULL. */
228 uint32_t pathname_length
;
229 /* Must be the last member of this structure. */
233 struct lttcomm_relayd_rotate_rename
{
234 uint32_t old_path_length
;
235 uint32_t new_path_length
;
236 /* Concatenation of the old and new paths, separated by \0. */
240 struct lttcomm_relayd_rotate_pending
{
244 struct lttcomm_relayd_rotate_pending_reply
{
245 struct lttcomm_relayd_generic_reply generic
;
246 /* Valid values are [0, 1]. */
250 struct lttcomm_relayd_mkdir
{
251 /* Includes trailing NULL */
256 #endif /* _RELAYD_COMM */