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