Fix: off-by-one in comm proto between lttng-ctl and sessiond
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 /*
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
23 */
24
25 #ifndef _LTTNG_SESSIOND_COMM_H
26 #define _LTTNG_SESSIOND_COMM_H
27
28 #define _GNU_SOURCE
29 #include <limits.h>
30 #include <lttng/lttng.h>
31 #include <common/compat/socket.h>
32 #include <common/uri.h>
33
34 #include <arpa/inet.h>
35 #include <netinet/in.h>
36 #include <sys/un.h>
37
38 #include "inet.h"
39 #include "inet6.h"
40 #include "unix.h"
41
42 /* Queue size of listen(2) */
43 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
44
45 /* Maximum number of FDs that can be sent over a Unix socket */
46 #define LTTCOMM_MAX_SEND_FDS 4
47
48 /*
49 * Get the error code index from 0 since LTTCOMM_OK start at 1000
50 */
51 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
52
53 enum lttcomm_sessiond_command {
54 /* Tracer command */
55 LTTNG_ADD_CONTEXT,
56 LTTNG_CALIBRATE,
57 LTTNG_DISABLE_CHANNEL,
58 LTTNG_DISABLE_EVENT,
59 LTTNG_DISABLE_ALL_EVENT,
60 LTTNG_ENABLE_CHANNEL,
61 LTTNG_ENABLE_EVENT,
62 LTTNG_ENABLE_ALL_EVENT,
63 /* Session daemon command */
64 LTTNG_CREATE_SESSION,
65 LTTNG_DESTROY_SESSION,
66 LTTNG_LIST_CHANNELS,
67 LTTNG_LIST_DOMAINS,
68 LTTNG_LIST_EVENTS,
69 LTTNG_LIST_SESSIONS,
70 LTTNG_LIST_TRACEPOINTS,
71 LTTNG_REGISTER_CONSUMER,
72 LTTNG_START_TRACE,
73 LTTNG_STOP_TRACE,
74 LTTNG_LIST_TRACEPOINT_FIELDS,
75
76 /* Consumer */
77 LTTNG_DISABLE_CONSUMER,
78 LTTNG_ENABLE_CONSUMER,
79 LTTNG_SET_CONSUMER_URI,
80 /* Relay daemon */
81 RELAYD_ADD_STREAM,
82 RELAYD_CREATE_SESSION,
83 RELAYD_START_DATA,
84 RELAYD_UPDATE_SYNC_INFO,
85 RELAYD_VERSION,
86 RELAYD_SEND_METADATA,
87 RELAYD_CLOSE_STREAM,
88 LTTNG_SET_FILTER,
89 LTTNG_HEALTH_CHECK,
90 };
91
92 /*
93 * lttcomm error code.
94 */
95 enum lttcomm_return_code {
96 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
97 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
98 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
99 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
100 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
101 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
102 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
103 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
104 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
105 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
106 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
107 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
108 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
109 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
110
111 /* MUST be last element */
112 LTTCOMM_NR, /* Last element */
113 };
114
115 /* lttng socket protocol. */
116 enum lttcomm_sock_proto {
117 LTTCOMM_SOCK_UDP,
118 LTTCOMM_SOCK_TCP,
119 };
120
121 /*
122 * Index in the net_families array below. Please keep in sync!
123 */
124 enum lttcomm_sock_domain {
125 LTTCOMM_INET = 0,
126 LTTCOMM_INET6 = 1,
127 };
128
129 struct lttcomm_sockaddr {
130 enum lttcomm_sock_domain type;
131 union {
132 struct sockaddr_in sin;
133 struct sockaddr_in6 sin6;
134 } addr;
135 };
136
137 struct lttcomm_sock {
138 int fd;
139 enum lttcomm_sock_proto proto;
140 struct lttcomm_sockaddr sockaddr;
141 const struct lttcomm_proto_ops *ops;
142 };
143
144 struct lttcomm_net_family {
145 int family;
146 int (*create) (struct lttcomm_sock *sock, int type, int proto);
147 };
148
149 struct lttcomm_proto_ops {
150 int (*bind) (struct lttcomm_sock *sock);
151 int (*close) (struct lttcomm_sock *sock);
152 int (*connect) (struct lttcomm_sock *sock);
153 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
154 int (*listen) (struct lttcomm_sock *sock, int backlog);
155 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
156 int flags);
157 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
158 int flags);
159 };
160
161 /*
162 * Data structure received from lttng client to session daemon.
163 */
164 struct lttcomm_session_msg {
165 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
166 struct lttng_session session;
167 struct lttng_domain domain;
168 union {
169 struct {
170 char channel_name[LTTNG_SYMBOL_NAME_LEN];
171 char name[NAME_MAX];
172 } disable;
173 /* Event data */
174 struct {
175 char channel_name[LTTNG_SYMBOL_NAME_LEN];
176 struct lttng_event event;
177 } enable;
178 /* Create channel */
179 struct {
180 struct lttng_channel chan;
181 } channel;
182 /* Context */
183 struct {
184 char channel_name[LTTNG_SYMBOL_NAME_LEN];
185 char event_name[LTTNG_SYMBOL_NAME_LEN];
186 struct lttng_event_context ctx;
187 } context;
188 /* Use by register_consumer */
189 struct {
190 char path[PATH_MAX];
191 } reg;
192 /* List */
193 struct {
194 char channel_name[LTTNG_SYMBOL_NAME_LEN];
195 } list;
196 struct lttng_calibrate calibrate;
197 /* Used by the set_consumer_url and used by create_session also call */
198 struct {
199 /* Number of lttng_uri following */
200 uint32_t size;
201 } uri;
202 struct {
203 char channel_name[LTTNG_SYMBOL_NAME_LEN];
204 char event_name[LTTNG_SYMBOL_NAME_LEN];
205 /* Length of following bytecode */
206 uint32_t bytecode_len;
207 } filter;
208 } u;
209 };
210
211 #define LTTNG_FILTER_MAX_LEN 65536
212
213 /*
214 * Filter bytecode data. The reloc table is located at the end of the
215 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
216 * starts at reloc_table_offset.
217 */
218 struct lttng_filter_bytecode {
219 uint32_t len; /* len of data */
220 uint32_t reloc_table_offset;
221 char data[0];
222 };
223
224 /*
225 * Data structure for the response from sessiond to the lttng client.
226 */
227 struct lttcomm_lttng_msg {
228 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
229 uint32_t ret_code; /* enum lttcomm_return_code */
230 uint32_t pid; /* pid_t */
231 uint32_t data_size;
232 /* Contains: trace_name + data */
233 char payload[];
234 };
235
236 struct lttcomm_health_msg {
237 uint32_t component;
238 uint32_t cmd;
239 };
240
241 struct lttcomm_health_data {
242 uint32_t ret_code;
243 };
244
245 /*
246 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
247 * to either add a channel, add a stream, update a stream, or stop
248 * operation.
249 */
250 struct lttcomm_consumer_msg {
251 uint32_t cmd_type; /* enum consumerd_command */
252 union {
253 struct {
254 int channel_key;
255 uint64_t max_sb_size; /* the subbuffer size for this channel */
256 /* shm_fd and wait_fd are sent as ancillary data */
257 uint64_t mmap_len;
258 /* nb_init_streams is the number of streams open initially. */
259 unsigned int nb_init_streams;
260 char name[LTTNG_SYMBOL_NAME_LEN];
261 } channel;
262 struct {
263 int channel_key;
264 int stream_key;
265 /* shm_fd and wait_fd are sent as ancillary data */
266 uint32_t state; /* enum lttcomm_consumer_fd_state */
267 enum lttng_event_output output; /* use splice or mmap to consume this fd */
268 uint64_t mmap_len;
269 uid_t uid; /* User ID owning the session */
270 gid_t gid; /* Group ID owning the session */
271 char path_name[PATH_MAX];
272 int net_index;
273 unsigned int metadata_flag;
274 char name[LTTNG_SYMBOL_NAME_LEN]; /* Name string of the stream */
275 } stream;
276 struct {
277 int net_index;
278 enum lttng_stream_type type;
279 /* Open socket to the relayd */
280 struct lttcomm_sock sock;
281 } relayd_sock;
282 struct {
283 uint64_t net_seq_idx;
284 } destroy_relayd;
285 } u;
286 };
287
288 #ifdef HAVE_LIBLTTNG_UST_CTL
289
290 #include <lttng/ust-abi.h>
291
292 /*
293 * Data structure for the commands sent from sessiond to UST.
294 */
295 struct lttcomm_ust_msg {
296 uint32_t handle;
297 uint32_t cmd;
298 union {
299 struct lttng_ust_channel channel;
300 struct lttng_ust_stream stream;
301 struct lttng_ust_event event;
302 struct lttng_ust_context context;
303 struct lttng_ust_tracer_version version;
304 } u;
305 };
306
307 /*
308 * Data structure for the response from UST to the session daemon.
309 * cmd_type is sent back in the reply for validation.
310 */
311 struct lttcomm_ust_reply {
312 uint32_t handle;
313 uint32_t cmd;
314 uint32_t ret_code; /* enum lttcomm_return_code */
315 uint32_t ret_val; /* return value */
316 union {
317 struct {
318 uint64_t memory_map_size;
319 } channel;
320 struct {
321 uint64_t memory_map_size;
322 } stream;
323 struct lttng_ust_tracer_version version;
324 } u;
325 };
326
327 #endif /* HAVE_LIBLTTNG_UST_CTL */
328
329 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
330
331 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
332 const char *ip, unsigned int port);
333 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
334 const char *ip, unsigned int port);
335
336 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
337 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
338 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
339 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
340 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
341 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
342 struct lttcomm_sock *src);
343
344 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.054823 seconds and 4 git commands to generate.