Use free running metadata channel key between sessiond and kernel consumer
[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
b8aa1682
JD
32/*
33 * lttng-relayd communication header.
34 */
35struct lttcomm_relayd_hdr {
36 /* Circuit ID not used for now so always ignored */
37 uint64_t circuit_id;
38 uint64_t data_size; /* data size following this header */
7c9534d6 39 uint32_t cmd; /* enum lttcomm_relayd_command */
b8aa1682 40 uint32_t cmd_version; /* command version */
a9e87764 41} LTTNG_PACKED;
b8aa1682
JD
42
43/*
44 * lttng-relayd data header.
45 */
46struct lttcomm_relayd_data_hdr {
47 /* Circuit ID not used for now so always ignored */
48 uint64_t circuit_id;
49 uint64_t stream_id; /* Stream ID known by the relayd */
173af62f 50 uint64_t net_seq_num; /* Network sequence number, per stream. */
b8aa1682 51 uint32_t data_size; /* data size following this header */
1d4dfdef 52 uint32_t padding_size; /* Size of 0 padding the data */
a9e87764 53} LTTNG_PACKED;
b8aa1682 54
c5b6f4f0
DG
55/*
56 * Reply from a create session command.
57 */
58struct lttcomm_relayd_status_session {
59 uint64_t session_id;
60 uint32_t ret_code;
a9e87764 61} LTTNG_PACKED;
c5b6f4f0 62
b8aa1682
JD
63/*
64 * Used to add a stream on the relay daemon.
65 */
66struct lttcomm_relayd_add_stream {
ce2a9e76 67 char channel_name[DEFAULT_STREAM_NAME_LEN];
ba86d0a7 68 char pathname[LTTNG_PATH_MAX];
a9e87764 69} LTTNG_PACKED;
b8aa1682 70
0f907de1
JD
71/*
72 * Used to add a stream on the relay daemon.
73 * Protocol version 2.2
74 */
75struct lttcomm_relayd_add_stream_2_2 {
76 char channel_name[DEFAULT_STREAM_NAME_LEN];
ba86d0a7 77 char pathname[LTTNG_PATH_MAX];
0f907de1
JD
78 uint64_t tracefile_size;
79 uint64_t tracefile_count;
80} LTTNG_PACKED;
81
b8aa1682
JD
82/*
83 * Answer from an add stream command.
84 */
85struct lttcomm_relayd_status_stream {
86 uint64_t handle;
87 uint32_t ret_code;
a9e87764 88} LTTNG_PACKED;
b8aa1682
JD
89
90/*
91 * Used to return command code for command not needing special data.
92 */
93struct lttcomm_relayd_generic_reply {
94 uint32_t ret_code;
a9e87764 95} LTTNG_PACKED;
b8aa1682 96
b8aa1682
JD
97/*
98 * Version command.
99 */
100struct lttcomm_relayd_version {
101 uint32_t major;
102 uint32_t minor;
a9e87764 103} LTTNG_PACKED;
b8aa1682
JD
104
105/*
106 * Metadata payload used when metadata command is sent.
107 */
108struct lttcomm_relayd_metadata_payload {
109 uint64_t stream_id;
1d4dfdef 110 uint32_t padding_size;
b8aa1682 111 char payload[];
a9e87764 112} LTTNG_PACKED;
b8aa1682 113
173af62f
DG
114/*
115 * Used to indicate that a specific stream id can now be closed.
116 */
117struct lttcomm_relayd_close_stream {
118 uint64_t stream_id;
119 uint64_t last_net_seq_num; /* sequence number of last packet */
a9e87764 120} LTTNG_PACKED;
173af62f 121
c8f59ee5 122/*
6d805429
DG
123 * Used to test if for a given stream id the data is pending on the relayd side
124 * for reading.
c8f59ee5 125 */
6d805429 126struct lttcomm_relayd_data_pending {
c8f59ee5
DG
127 uint64_t stream_id;
128 uint64_t last_net_seq_num; /* Sequence number of the last packet */
a9e87764 129} LTTNG_PACKED;
c8f59ee5 130
f7079f67
DG
131struct lttcomm_relayd_begin_data_pending {
132 uint64_t session_id;
a9e87764 133} LTTNG_PACKED;
f7079f67
DG
134
135struct lttcomm_relayd_end_data_pending {
136 uint64_t session_id;
a9e87764 137} LTTNG_PACKED;
f7079f67 138
ad7051c0
DG
139struct lttcomm_relayd_quiescent_control {
140 uint64_t stream_id;
141} LTTNG_PACKED;
142
1c20f0e2
JD
143/*
144 * Index data.
145 */
146struct lttcomm_relayd_index {
147 uint64_t relay_stream_id;
148 uint64_t net_seq_num;
149 uint64_t packet_size;
150 uint64_t content_size;
151 uint64_t timestamp_begin;
152 uint64_t timestamp_end;
153 uint64_t events_discarded;
154 uint64_t stream_id;
f8f3885c 155 /* 2.8+ */
234cd636
JD
156 uint64_t stream_instance_id;
157 uint64_t packet_seq_num;
1c20f0e2
JD
158} LTTNG_PACKED;
159
f8f3885c
MD
160static inline size_t lttcomm_relayd_index_len(uint32_t major, uint32_t minor)
161{
162 if (major == 1) {
163 switch (minor) {
164 case 0:
165 return offsetof(struct lttcomm_relayd_index, stream_id)
166 + member_sizeof(struct lttcomm_relayd_index,
167 stream_id);
168 case 1:
169 return offsetof(struct lttcomm_relayd_index, packet_seq_num)
170 + member_sizeof(struct lttcomm_relayd_index,
171 packet_seq_num);
172 default:
173 abort();
174 }
175 }
176 abort();
177}
178
d3e2ba59
JD
179/*
180 * Create session in 2.4 adds additionnal parameters for live reading.
181 */
182struct lttcomm_relayd_create_session_2_4 {
36d2e35d 183 char session_name[LTTNG_NAME_MAX];
9cf3eb20 184 char hostname[LTTNG_HOST_NAME_MAX];
d3e2ba59 185 uint32_t live_timer;
7d2f7452 186 uint32_t snapshot;
d3e2ba59
JD
187} LTTNG_PACKED;
188
93ec662e
JD
189/*
190 * Used to ask the relay to reset the metadata trace file (regeneration).
191 * Send the new version of the metadata (starts at 0).
192 */
193struct lttcomm_relayd_reset_metadata {
194 uint64_t stream_id;
195 uint64_t version;
196} LTTNG_PACKED;
197
b8aa1682 198#endif /* _RELAYD_COMM */
This page took 0.075184 seconds and 4 git commands to generate.