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