bbc7ce5a8e403156e1bedc38ba574ffdccc390ea
[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 <lttng/snapshot-internal.h>
32 #include <lttng/save-internal.h>
33 #include <common/compat/socket.h>
34 #include <common/uri.h>
35 #include <common/defaults.h>
36 #include <common/compat/uuid.h>
37
38 #include <arpa/inet.h>
39 #include <netinet/in.h>
40 #include <sys/un.h>
41
42 #include "inet.h"
43 #include "inet6.h"
44 #include "unix.h"
45
46 /* Queue size of listen(2) */
47 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
48
49 /* Maximum number of FDs that can be sent over a Unix socket */
50 #define LTTCOMM_MAX_SEND_FDS 4
51
52 /*
53 * Get the error code index from 0 since LTTCOMM_OK start at 1000
54 */
55 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
56
57 enum lttcomm_sessiond_command {
58 /* Tracer command */
59 LTTNG_ADD_CONTEXT = 0,
60 LTTNG_CALIBRATE = 1,
61 LTTNG_DISABLE_CHANNEL = 2,
62 LTTNG_DISABLE_EVENT = 3,
63 LTTNG_DISABLE_ALL_EVENT = 4,
64 LTTNG_ENABLE_CHANNEL = 5,
65 LTTNG_ENABLE_EVENT = 6,
66 LTTNG_ENABLE_ALL_EVENT = 7,
67 /* Session daemon command */
68 LTTNG_CREATE_SESSION = 8,
69 LTTNG_DESTROY_SESSION = 9,
70 LTTNG_LIST_CHANNELS = 10,
71 LTTNG_LIST_DOMAINS = 11,
72 LTTNG_LIST_EVENTS = 12,
73 LTTNG_LIST_SESSIONS = 13,
74 LTTNG_LIST_TRACEPOINTS = 14,
75 LTTNG_REGISTER_CONSUMER = 15,
76 LTTNG_START_TRACE = 16,
77 LTTNG_STOP_TRACE = 17,
78 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
79
80 /* Consumer */
81 LTTNG_DISABLE_CONSUMER = 19,
82 LTTNG_ENABLE_CONSUMER = 20,
83 LTTNG_SET_CONSUMER_URI = 21,
84 /* 22 */
85 /* 23 */
86 LTTNG_DATA_PENDING = 24,
87 LTTNG_SNAPSHOT_ADD_OUTPUT = 25,
88 LTTNG_SNAPSHOT_DEL_OUTPUT = 26,
89 LTTNG_SNAPSHOT_LIST_OUTPUT = 27,
90 LTTNG_SNAPSHOT_RECORD = 28,
91 LTTNG_CREATE_SESSION_SNAPSHOT = 29,
92 LTTNG_CREATE_SESSION_LIVE = 30,
93 LTTNG_SAVE_SESSION = 31,
94 };
95
96 enum lttcomm_relayd_command {
97 RELAYD_ADD_STREAM = 1,
98 RELAYD_CREATE_SESSION = 2,
99 RELAYD_START_DATA = 3,
100 RELAYD_UPDATE_SYNC_INFO = 4,
101 RELAYD_VERSION = 5,
102 RELAYD_SEND_METADATA = 6,
103 RELAYD_CLOSE_STREAM = 7,
104 RELAYD_DATA_PENDING = 8,
105 RELAYD_QUIESCENT_CONTROL = 9,
106 RELAYD_BEGIN_DATA_PENDING = 10,
107 RELAYD_END_DATA_PENDING = 11,
108 RELAYD_ADD_INDEX = 12,
109 RELAYD_SEND_INDEX = 13,
110 RELAYD_CLOSE_INDEX = 14,
111 /* Live-reading commands (2.4+). */
112 RELAYD_LIST_SESSIONS = 15,
113 /* All streams of the channel have been sent to the relayd (2.4+). */
114 RELAYD_STREAMS_SENT = 16,
115 };
116
117 /*
118 * lttcomm error code.
119 */
120 enum lttcomm_return_code {
121 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
122 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
123 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
124 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
125 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
126 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
127 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
128 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
129 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
130 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
131 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
132 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
133 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
134 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
135 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
136 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
137 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
138 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
139 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
140 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
141
142 /* MUST be last element */
143 LTTCOMM_NR, /* Last element */
144 };
145
146 /* lttng socket protocol. */
147 enum lttcomm_sock_proto {
148 LTTCOMM_SOCK_UDP,
149 LTTCOMM_SOCK_TCP,
150 };
151
152 /*
153 * Index in the net_families array below. Please keep in sync!
154 */
155 enum lttcomm_sock_domain {
156 LTTCOMM_INET = 0,
157 LTTCOMM_INET6 = 1,
158 };
159
160 enum lttcomm_metadata_command {
161 LTTCOMM_METADATA_REQUEST = 1,
162 };
163
164 /*
165 * Commands sent from the consumerd to the sessiond to request if new metadata
166 * is available. This message is used to find the per UID _or_ per PID registry
167 * for the channel key. For per UID lookup, the triplet
168 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
169 * per PID registry indexed by session id ignoring the other values.
170 */
171 struct lttcomm_metadata_request_msg {
172 uint64_t session_id; /* Tracing session id */
173 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
174 uint32_t bits_per_long; /* Consumer ABI */
175 uint32_t uid;
176 uint64_t key; /* Metadata channel key. */
177 } LTTNG_PACKED;
178
179 struct lttcomm_sockaddr {
180 enum lttcomm_sock_domain type;
181 union {
182 struct sockaddr_in sin;
183 struct sockaddr_in6 sin6;
184 } addr;
185 } LTTNG_PACKED;
186
187 struct lttcomm_sock {
188 int32_t fd;
189 enum lttcomm_sock_proto proto;
190 struct lttcomm_sockaddr sockaddr;
191 const struct lttcomm_proto_ops *ops;
192 } LTTNG_PACKED;
193
194 /*
195 * Relayd sock. Adds the protocol version to use for the communications with
196 * the relayd.
197 */
198 struct lttcomm_relayd_sock {
199 struct lttcomm_sock sock;
200 uint32_t major;
201 uint32_t minor;
202 } LTTNG_PACKED;
203
204 struct lttcomm_net_family {
205 int family;
206 int (*create) (struct lttcomm_sock *sock, int type, int proto);
207 };
208
209 struct lttcomm_proto_ops {
210 int (*bind) (struct lttcomm_sock *sock);
211 int (*close) (struct lttcomm_sock *sock);
212 int (*connect) (struct lttcomm_sock *sock);
213 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
214 int (*listen) (struct lttcomm_sock *sock, int backlog);
215 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
216 int flags);
217 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
218 int flags);
219 };
220
221 /*
222 * Data structure received from lttng client to session daemon.
223 */
224 struct lttcomm_session_msg {
225 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
226 struct lttng_session session;
227 struct lttng_domain domain;
228 union {
229 struct {
230 char channel_name[LTTNG_SYMBOL_NAME_LEN];
231 char name[NAME_MAX];
232 } LTTNG_PACKED disable;
233 /* Event data */
234 struct {
235 char channel_name[LTTNG_SYMBOL_NAME_LEN];
236 struct lttng_event event;
237 /* Length of following filter expression. */
238 uint32_t expression_len;
239 /* Length of following bytecode for filter. */
240 uint32_t bytecode_len;
241 /* exclusion data */
242 uint32_t exclusion_count;
243 /*
244 * After this structure, the following variable-length
245 * items are transmitted:
246 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
247 * - unsigned char filter_expression[expression_len]
248 * - unsigned char filter_bytecode[bytecode_len]
249 */
250 } LTTNG_PACKED enable;
251 /* Create channel */
252 struct {
253 struct lttng_channel chan;
254 } LTTNG_PACKED channel;
255 /* Context */
256 struct {
257 char channel_name[LTTNG_SYMBOL_NAME_LEN];
258 struct lttng_event_context ctx;
259 } LTTNG_PACKED context;
260 /* Use by register_consumer */
261 struct {
262 char path[PATH_MAX];
263 } LTTNG_PACKED reg;
264 /* List */
265 struct {
266 char channel_name[LTTNG_SYMBOL_NAME_LEN];
267 } LTTNG_PACKED list;
268 struct lttng_calibrate calibrate;
269 /* Used by the set_consumer_url and used by create_session also call */
270 struct {
271 /* Number of lttng_uri following */
272 uint32_t size;
273 } LTTNG_PACKED uri;
274 struct {
275 struct lttng_snapshot_output output;
276 } LTTNG_PACKED snapshot_output;
277 struct {
278 uint32_t wait;
279 struct lttng_snapshot_output output;
280 } LTTNG_PACKED snapshot_record;
281 struct {
282 uint32_t nb_uri;
283 unsigned int timer_interval; /* usec */
284 } LTTNG_PACKED session_live;
285 struct {
286 struct lttng_save_session_attr attr;
287 } LTTNG_PACKED save_session;
288 } u;
289 } LTTNG_PACKED;
290
291 #define LTTNG_FILTER_MAX_LEN 65536
292
293 /*
294 * Filter bytecode data. The reloc table is located at the end of the
295 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
296 * starts at reloc_table_offset.
297 */
298 #define LTTNG_FILTER_PADDING 32
299 struct lttng_filter_bytecode {
300 uint32_t len; /* len of data */
301 uint32_t reloc_table_offset;
302 uint64_t seqnum;
303 char padding[LTTNG_FILTER_PADDING];
304 char data[0];
305 } LTTNG_PACKED;
306
307 /*
308 * Event exclusion data. At the end of the structure, there will actually
309 * by zero or more names, where the actual number of names is given by
310 * the 'count' item of the structure.
311 */
312 #define LTTNG_EVENT_EXCLUSION_PADDING 32
313 struct lttng_event_exclusion {
314 uint32_t count;
315 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
316 char names[LTTNG_SYMBOL_NAME_LEN][0];
317 } LTTNG_PACKED;
318
319 /*
320 * Data structure for the response from sessiond to the lttng client.
321 */
322 struct lttcomm_lttng_msg {
323 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
324 uint32_t ret_code; /* enum lttcomm_return_code */
325 uint32_t pid; /* pid_t */
326 uint32_t data_size;
327 /* Contains: trace_name + data */
328 char payload[];
329 } LTTNG_PACKED;
330
331 struct lttcomm_lttng_output_id {
332 uint32_t id;
333 } LTTNG_PACKED;
334
335 /*
336 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
337 * to either add a channel, add a stream, update a stream, or stop
338 * operation.
339 */
340 struct lttcomm_consumer_msg {
341 uint32_t cmd_type; /* enum consumerd_command */
342 union {
343 struct {
344 uint64_t channel_key;
345 uint64_t session_id;
346 char pathname[PATH_MAX];
347 uint32_t uid;
348 uint32_t gid;
349 uint64_t relayd_id;
350 /* nb_init_streams is the number of streams open initially. */
351 uint32_t nb_init_streams;
352 char name[LTTNG_SYMBOL_NAME_LEN];
353 /* Use splice or mmap to consume this fd */
354 enum lttng_event_output output;
355 int type; /* Per cpu or metadata. */
356 uint64_t tracefile_size; /* bytes */
357 uint32_t tracefile_count; /* number of tracefiles */
358 /* If the channel's streams have to be monitored or not. */
359 uint32_t monitor;
360 /* timer to check the streams usage in live mode (usec). */
361 unsigned int live_timer_interval;
362 } LTTNG_PACKED channel; /* Only used by Kernel. */
363 struct {
364 uint64_t stream_key;
365 uint64_t channel_key;
366 int32_t cpu; /* On which CPU this stream is assigned. */
367 /* Tells the consumer if the stream should be or not monitored. */
368 uint32_t no_monitor;
369 } LTTNG_PACKED stream; /* Only used by Kernel. */
370 struct {
371 uint64_t net_index;
372 enum lttng_stream_type type;
373 /* Open socket to the relayd */
374 struct lttcomm_relayd_sock sock;
375 /* Tracing session id associated to the relayd. */
376 uint64_t session_id;
377 /* Relayd session id, only used with control socket. */
378 uint64_t relayd_session_id;
379 } LTTNG_PACKED relayd_sock;
380 struct {
381 uint64_t net_seq_idx;
382 } LTTNG_PACKED destroy_relayd;
383 struct {
384 uint64_t session_id;
385 } LTTNG_PACKED data_pending;
386 struct {
387 uint64_t subbuf_size; /* bytes */
388 uint64_t num_subbuf; /* power of 2 */
389 int32_t overwrite; /* 1: overwrite, 0: discard */
390 uint32_t switch_timer_interval; /* usec */
391 uint32_t read_timer_interval; /* usec */
392 unsigned int live_timer_interval; /* usec */
393 int32_t output; /* splice, mmap */
394 int32_t type; /* metadata or per_cpu */
395 uint64_t session_id; /* Tracing session id */
396 char pathname[PATH_MAX]; /* Channel file path. */
397 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
398 uint32_t uid; /* User ID of the session */
399 uint32_t gid; /* Group ID ot the session */
400 uint64_t relayd_id; /* Relayd id if apply. */
401 uint64_t key; /* Unique channel key. */
402 unsigned char uuid[UUID_LEN]; /* uuid for ust tracer. */
403 uint32_t chan_id; /* Channel ID on the tracer side. */
404 uint64_t tracefile_size; /* bytes */
405 uint32_t tracefile_count; /* number of tracefiles */
406 uint64_t session_id_per_pid; /* Per-pid session ID. */
407 /* Tells the consumer if the stream should be or not monitored. */
408 uint32_t monitor;
409 /*
410 * For UST per UID buffers, this is the application UID of the
411 * channel. This can be different from the user UID requesting the
412 * channel creation and used for the rights on the stream file
413 * because the application can be in the tracing for instance.
414 */
415 uint32_t ust_app_uid;
416 } LTTNG_PACKED ask_channel;
417 struct {
418 uint64_t key;
419 } LTTNG_PACKED get_channel;
420 struct {
421 uint64_t key;
422 } LTTNG_PACKED destroy_channel;
423 struct {
424 uint64_t key; /* Metadata channel key. */
425 uint64_t target_offset; /* Offset in the consumer */
426 uint64_t len; /* Length of metadata to be received. */
427 } LTTNG_PACKED push_metadata;
428 struct {
429 uint64_t key; /* Metadata channel key. */
430 } LTTNG_PACKED close_metadata;
431 struct {
432 uint64_t key; /* Metadata channel key. */
433 } LTTNG_PACKED setup_metadata;
434 struct {
435 uint64_t key; /* Channel key. */
436 } LTTNG_PACKED flush_channel;
437 struct {
438 char pathname[PATH_MAX];
439 /* Indicate if the snapshot goes on the relayd or locally. */
440 uint32_t use_relayd;
441 uint32_t metadata; /* This a metadata snapshot. */
442 uint64_t relayd_id; /* Relayd id if apply. */
443 uint64_t key;
444 uint64_t max_stream_size;
445 } LTTNG_PACKED snapshot_channel;
446 struct {
447 uint64_t channel_key;
448 uint64_t net_seq_idx;
449 } LTTNG_PACKED sent_streams;
450 } u;
451 } LTTNG_PACKED;
452
453 /*
454 * Status message returned to the sessiond after a received command.
455 */
456 struct lttcomm_consumer_status_msg {
457 enum lttcomm_return_code ret_code;
458 } LTTNG_PACKED;
459
460 struct lttcomm_consumer_status_channel {
461 enum lttcomm_return_code ret_code;
462 uint64_t key;
463 unsigned int stream_count;
464 } LTTNG_PACKED;
465
466 #ifdef HAVE_LIBLTTNG_UST_CTL
467
468 #include <lttng/ust-abi.h>
469
470 /*
471 * Data structure for the commands sent from sessiond to UST.
472 */
473 struct lttcomm_ust_msg {
474 uint32_t handle;
475 uint32_t cmd;
476 union {
477 struct lttng_ust_channel channel;
478 struct lttng_ust_stream stream;
479 struct lttng_ust_event event;
480 struct lttng_ust_context context;
481 struct lttng_ust_tracer_version version;
482 } u;
483 } LTTNG_PACKED;
484
485 /*
486 * Data structure for the response from UST to the session daemon.
487 * cmd_type is sent back in the reply for validation.
488 */
489 struct lttcomm_ust_reply {
490 uint32_t handle;
491 uint32_t cmd;
492 uint32_t ret_code; /* enum lttcomm_return_code */
493 uint32_t ret_val; /* return value */
494 union {
495 struct {
496 uint64_t memory_map_size;
497 } LTTNG_PACKED channel;
498 struct {
499 uint64_t memory_map_size;
500 } LTTNG_PACKED stream;
501 struct lttng_ust_tracer_version version;
502 } u;
503 } LTTNG_PACKED;
504
505 #endif /* HAVE_LIBLTTNG_UST_CTL */
506
507 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
508
509 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
510 const char *ip, unsigned int port);
511 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
512 const char *ip, unsigned int port);
513
514 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
515 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
516 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
517 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
518 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
519 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
520 struct lttcomm_sock *src);
521
522 /* Relayd socket object. */
523 extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
524 struct lttng_uri *uri, uint32_t major, uint32_t minor);
525
526 extern int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
527 extern int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
528
529 extern void lttcomm_init(void);
530 /* Get network timeout, in milliseconds */
531 extern unsigned long lttcomm_get_network_timeout(void);
532
533 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.042432 seconds and 5 git commands to generate.