Dynamic payload for relayd create session command
[lttng-tools.git] / src / common / sessiond-comm / relayd.h
CommitLineData
b8aa1682
JD
1/*
2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Julien Desfossez <julien.desfossez@efficios.com>
4 *
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.
8 *
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
12 * more details.
13 *
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.
17 */
18
19#ifndef _RELAYD_COMM
20#define _RELAYD_COMM
21
b8aa1682
JD
22#include <limits.h>
23#include <stdint.h>
24
25#include <lttng/lttng.h>
ce2a9e76 26#include <common/defaults.h>
50adc264 27#include <common/index/ctf-index.h>
b8aa1682 28
6947778e
MD
29#define RELAYD_VERSION_COMM_MAJOR VERSION_MAJOR
30#define RELAYD_VERSION_COMM_MINOR VERSION_MINOR
0a6b5085 31
1c17e424
JR
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 */
36
b8aa1682
JD
37/*
38 * lttng-relayd communication header.
39 */
40struct lttcomm_relayd_hdr {
41 /* Circuit ID not used for now so always ignored */
42 uint64_t circuit_id;
43 uint64_t data_size; /* data size following this header */
7c9534d6 44 uint32_t cmd; /* enum lttcomm_relayd_command */
b8aa1682 45 uint32_t cmd_version; /* command version */
a9e87764 46} LTTNG_PACKED;
b8aa1682
JD
47
48/*
49 * lttng-relayd data header.
50 */
51struct lttcomm_relayd_data_hdr {
52 /* Circuit ID not used for now so always ignored */
53 uint64_t circuit_id;
54 uint64_t stream_id; /* Stream ID known by the relayd */
173af62f 55 uint64_t net_seq_num; /* Network sequence number, per stream. */
b8aa1682 56 uint32_t data_size; /* data size following this header */
1d4dfdef 57 uint32_t padding_size; /* Size of 0 padding the data */
a9e87764 58} LTTNG_PACKED;
b8aa1682 59
c5b6f4f0
DG
60/*
61 * Reply from a create session command.
62 */
63struct lttcomm_relayd_status_session {
64 uint64_t session_id;
65 uint32_t ret_code;
a9e87764 66} LTTNG_PACKED;
c5b6f4f0 67
b8aa1682
JD
68/*
69 * Used to add a stream on the relay daemon.
70 */
71struct lttcomm_relayd_add_stream {
1c17e424
JR
72 char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
73 char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
a9e87764 74} LTTNG_PACKED;
b8aa1682 75
0f907de1
JD
76/*
77 * Used to add a stream on the relay daemon.
78 * Protocol version 2.2
79 */
80struct lttcomm_relayd_add_stream_2_2 {
1c17e424
JR
81 char channel_name[RELAYD_COMM_DEFAULT_STREAM_NAME_LEN];
82 char pathname[RELAYD_COMM_LTTNG_PATH_MAX];
0f907de1
JD
83 uint64_t tracefile_size;
84 uint64_t tracefile_count;
85} LTTNG_PACKED;
86
b8aa1682
JD
87/*
88 * Answer from an add stream command.
89 */
90struct lttcomm_relayd_status_stream {
91 uint64_t handle;
92 uint32_t ret_code;
a9e87764 93} LTTNG_PACKED;
b8aa1682
JD
94
95/*
96 * Used to return command code for command not needing special data.
97 */
98struct lttcomm_relayd_generic_reply {
99 uint32_t ret_code;
a9e87764 100} LTTNG_PACKED;
b8aa1682 101
b8aa1682
JD
102/*
103 * Version command.
104 */
105struct lttcomm_relayd_version {
106 uint32_t major;
107 uint32_t minor;
a9e87764 108} LTTNG_PACKED;
b8aa1682
JD
109
110/*
111 * Metadata payload used when metadata command is sent.
112 */
113struct lttcomm_relayd_metadata_payload {
114 uint64_t stream_id;
1d4dfdef 115 uint32_t padding_size;
b8aa1682 116 char payload[];
a9e87764 117} LTTNG_PACKED;
b8aa1682 118
173af62f
DG
119/*
120 * Used to indicate that a specific stream id can now be closed.
121 */
122struct lttcomm_relayd_close_stream {
123 uint64_t stream_id;
124 uint64_t last_net_seq_num; /* sequence number of last packet */
a9e87764 125} LTTNG_PACKED;
173af62f 126
c8f59ee5 127/*
6d805429
DG
128 * Used to test if for a given stream id the data is pending on the relayd side
129 * for reading.
c8f59ee5 130 */
6d805429 131struct lttcomm_relayd_data_pending {
c8f59ee5
DG
132 uint64_t stream_id;
133 uint64_t last_net_seq_num; /* Sequence number of the last packet */
a9e87764 134} LTTNG_PACKED;
c8f59ee5 135
f7079f67
DG
136struct lttcomm_relayd_begin_data_pending {
137 uint64_t session_id;
a9e87764 138} LTTNG_PACKED;
f7079f67
DG
139
140struct lttcomm_relayd_end_data_pending {
141 uint64_t session_id;
a9e87764 142} LTTNG_PACKED;
f7079f67 143
ad7051c0
DG
144struct lttcomm_relayd_quiescent_control {
145 uint64_t stream_id;
146} LTTNG_PACKED;
147
1c20f0e2
JD
148/*
149 * Index data.
150 */
151struct lttcomm_relayd_index {
152 uint64_t relay_stream_id;
153 uint64_t net_seq_num;
154 uint64_t packet_size;
155 uint64_t content_size;
156 uint64_t timestamp_begin;
157 uint64_t timestamp_end;
158 uint64_t events_discarded;
159 uint64_t stream_id;
f8f3885c 160 /* 2.8+ */
234cd636
JD
161 uint64_t stream_instance_id;
162 uint64_t packet_seq_num;
1c20f0e2
JD
163} LTTNG_PACKED;
164
f8f3885c
MD
165static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
166{
167 if (major == 1) {
168 switch (minor) {
169 case 0:
170 return offsetof(struct lttcomm_relayd_index, stream_id)
171 + member_sizeof(struct lttcomm_relayd_index,
172 stream_id);
173 case 1:
174 return offsetof(struct lttcomm_relayd_index, packet_seq_num)
175 + member_sizeof(struct lttcomm_relayd_index,
176 packet_seq_num);
177 default:
178 abort();
179 }
180 }
181 abort();
182}
183
d3e2ba59
JD
184/*
185 * Create session in 2.4 adds additionnal parameters for live reading.
186 */
187struct lttcomm_relayd_create_session_2_4 {
1c17e424
JR
188 char session_name[RELAYD_COMM_LTTNG_NAME_MAX_2_4];
189 char hostname[RELAYD_COMM_LTTNG_HOST_NAME_MAX_2_4];
d3e2ba59 190 uint32_t live_timer;
7d2f7452 191 uint32_t snapshot;
d3e2ba59
JD
192} LTTNG_PACKED;
193
f86f6389
JR
194struct lttcomm_relayd_create_session_2_11 {
195 uint32_t session_name_len;
196 uint32_t hostname_len;
197 uint32_t live_timer;
198 uint8_t snapshot;
199 /* Contains the session_name and hostname */
200 char names[];
201} LTTNG_PACKED;
202
93ec662e
JD
203/*
204 * Used to ask the relay to reset the metadata trace file (regeneration).
205 * Send the new version of the metadata (starts at 0).
206 */
207struct lttcomm_relayd_reset_metadata {
208 uint64_t stream_id;
209 uint64_t version;
210} LTTNG_PACKED;
211
d3ecc550
JD
212struct lttcomm_relayd_rotate_stream {
213 uint64_t stream_id;
d73bf3d7 214 /* Ignored for metadata streams. */
d3ecc550
JD
215 uint64_t rotate_at_seq_num;
216 uint64_t new_chunk_id;
217 /* Includes trailing NULL. */
218 uint32_t pathname_length;
219 /* Must be the last member of this structure. */
220 char new_pathname[];
221} LTTNG_PACKED;
222
00fb02ac
JD
223struct lttcomm_relayd_rotate_rename {
224 uint32_t old_path_length;
225 uint32_t new_path_length;
226 /* Concatenation of the old and new paths, separated by \0. */
227 char paths[];
228} LTTNG_PACKED;
229
e2acc8d2
JD
230struct lttcomm_relayd_rotate_pending {
231 uint64_t chunk_id;
232} LTTNG_PACKED;
233
d88744a4
JD
234struct lttcomm_relayd_rotate_pending_reply {
235 struct lttcomm_relayd_generic_reply generic;
236 /* Valid values are [0, 1]. */
237 uint8_t is_pending;
238} LTTNG_PACKED;
239
a1ae2ea5
JD
240struct lttcomm_relayd_mkdir {
241 /* Includes trailing NULL */
242 uint32_t length;
243 char path[];
244} LTTNG_PACKED;
245
b8aa1682 246#endif /* _RELAYD_COMM */
This page took 0.079416 seconds and 4 git commands to generate.