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