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