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