projects / lttng-tools.git / blob
? search:


d946aa3a3074b8979bdc36478d3a8fe633d713db
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
1 /*
2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * SPDX-License-Identifier: GPL-2.0-only
7 *
8 */
9
10 /*
11 * This header is meant for liblttng and libust internal use ONLY. These
12 * declarations should NOT be considered stable API.
13 */
14
15 #ifndef _LTTNG_SESSIOND_COMM_H
16 #define _LTTNG_SESSIOND_COMM_H
17
18 #include <limits.h>
19 #include <lttng/lttng.h>
20 #include <lttng/snapshot-internal.h>
21 #include <lttng/save-internal.h>
22 #include <lttng/channel-internal.h>
23 #include <lttng/trigger/trigger-internal.h>
24 #include <lttng/rotate-internal.h>
25 #include <common/compat/socket.h>
26 #include <common/uri.h>
27 #include <common/defaults.h>
28 #include <common/uuid.h>
29 #include <common/macros.h>
30 #include <common/optional.h>
31
32 #include <arpa/inet.h>
33 #include <netinet/in.h>
34 #include <sys/un.h>
35
36 #include "inet.h"
37 #include "inet6.h"
38 #include <common/unix.h>
39
40 /* Queue size of listen(2) */
41 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
42
43 /* Maximum number of FDs that can be sent over a Unix socket */
44 #if defined(__linux__)
45 /* Based on the kernel's SCM_MAX_FD which is 253 since 2.6.38 (255 before) */
46 #define LTTCOMM_MAX_SEND_FDS 253
47 #else
48 #define LTTCOMM_MAX_SEND_FDS 16
49 #endif
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 used to be here */
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 /* 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 /* 29 */
91 /* 30 */
92 LTTNG_SAVE_SESSION = 31,
93 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE = 32,
94 LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE = 33,
95 LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY = 34,
96 LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY = 35,
97 LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET = 36,
98 LTTNG_SET_SESSION_SHM_PATH = 40,
99 LTTNG_REGENERATE_METADATA = 41,
100 LTTNG_REGENERATE_STATEDUMP = 42,
101 LTTNG_REGISTER_TRIGGER = 43,
102 LTTNG_UNREGISTER_TRIGGER = 44,
103 LTTNG_ROTATE_SESSION = 45,
104 LTTNG_ROTATION_GET_INFO = 46,
105 LTTNG_ROTATION_SET_SCHEDULE = 47,
106 LTTNG_SESSION_LIST_ROTATION_SCHEDULES = 48,
107 LTTNG_CREATE_SESSION_EXT = 49,
108 LTTNG_CLEAR_SESSION = 50,
109 LTTNG_LIST_TRIGGERS = 51,
110 };
111
112 static inline
113 const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd)
114 {
115 switch (cmd) {
116 case LTTNG_ADD_CONTEXT:
117 return "LTTNG_ADD_CONTEXT";
118 case LTTNG_DISABLE_CHANNEL:
119 return "LTTNG_DISABLE_CHANNEL";
120 case LTTNG_DISABLE_EVENT:
121 return "LTTNG_DISABLE_EVENT";
122 case LTTNG_LIST_SYSCALLS:
123 return "LTTNG_LIST_SYSCALLS";
124 case LTTNG_ENABLE_CHANNEL:
125 return "LTTNG_ENABLE_CHANNEL";
126 case LTTNG_ENABLE_EVENT:
127 return "LTTNG_ENABLE_EVENT";
128 case LTTNG_DESTROY_SESSION:
129 return "LTTNG_DESTROY_SESSION";
130 case LTTNG_LIST_CHANNELS:
131 return "LTTNG_LIST_CHANNELS";
132 case LTTNG_LIST_DOMAINS:
133 return "LTTNG_LIST_DOMAINS";
134 case LTTNG_LIST_EVENTS:
135 return "LTTNG_LIST_EVENTS";
136 case LTTNG_LIST_SESSIONS:
137 return "LTTNG_LIST_SESSIONS";
138 case LTTNG_LIST_TRACEPOINTS:
139 return "LTTNG_LIST_TRACEPOINTS";
140 case LTTNG_REGISTER_CONSUMER:
141 return "LTTNG_REGISTER_CONSUMER";
142 case LTTNG_START_TRACE:
143 return "LTTNG_START_TRACE";
144 case LTTNG_STOP_TRACE:
145 return "LTTNG_STOP_TRACE";
146 case LTTNG_LIST_TRACEPOINT_FIELDS:
147 return "LTTNG_LIST_TRACEPOINT_FIELDS";
148 case LTTNG_DISABLE_CONSUMER:
149 return "LTTNG_DISABLE_CONSUMER";
150 case LTTNG_ENABLE_CONSUMER:
151 return "LTTNG_ENABLE_CONSUMER";
152 case LTTNG_SET_CONSUMER_URI:
153 return "LTTNG_SET_CONSUMER_URI";
154 case LTTNG_DATA_PENDING:
155 return "LTTNG_DATA_PENDING";
156 case LTTNG_SNAPSHOT_ADD_OUTPUT:
157 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
158 case LTTNG_SNAPSHOT_DEL_OUTPUT:
159 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
160 case LTTNG_SNAPSHOT_LIST_OUTPUT:
161 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
162 case LTTNG_SNAPSHOT_RECORD:
163 return "LTTNG_SNAPSHOT_RECORD";
164 case LTTNG_SAVE_SESSION:
165 return "LTTNG_SAVE_SESSION";
166 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE:
167 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
168 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE:
169 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
170 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY:
171 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
172 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY:
173 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
174 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET:
175 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
176 case LTTNG_SET_SESSION_SHM_PATH:
177 return "LTTNG_SET_SESSION_SHM_PATH";
178 case LTTNG_REGENERATE_METADATA:
179 return "LTTNG_REGENERATE_METADATA";
180 case LTTNG_REGENERATE_STATEDUMP:
181 return "LTTNG_REGENERATE_STATEDUMP";
182 case LTTNG_REGISTER_TRIGGER:
183 return "LTTNG_REGISTER_TRIGGER";
184 case LTTNG_UNREGISTER_TRIGGER:
185 return "LTTNG_UNREGISTER_TRIGGER";
186 case LTTNG_ROTATE_SESSION:
187 return "LTTNG_ROTATE_SESSION";
188 case LTTNG_ROTATION_GET_INFO:
189 return "LTTNG_ROTATION_GET_INFO";
190 case LTTNG_ROTATION_SET_SCHEDULE:
191 return "LTTNG_ROTATION_SET_SCHEDULE";
192 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES:
193 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
194 case LTTNG_CREATE_SESSION_EXT:
195 return "LTTNG_CREATE_SESSION_EXT";
196 case LTTNG_CLEAR_SESSION:
197 return "LTTNG_CLEAR_SESSION";
198 case LTTNG_LIST_TRIGGERS:
199 return "LTTNG_LIST_TRIGGERS";
200 default:
201 abort();
202 }
203 }
204
205 enum lttcomm_relayd_command {
206 RELAYD_ADD_STREAM = 1,
207 RELAYD_CREATE_SESSION = 2,
208 RELAYD_START_DATA = 3,
209 RELAYD_UPDATE_SYNC_INFO = 4,
210 RELAYD_VERSION = 5,
211 RELAYD_SEND_METADATA = 6,
212 RELAYD_CLOSE_STREAM = 7,
213 RELAYD_DATA_PENDING = 8,
214 RELAYD_QUIESCENT_CONTROL = 9,
215 RELAYD_BEGIN_DATA_PENDING = 10,
216 RELAYD_END_DATA_PENDING = 11,
217 RELAYD_ADD_INDEX = 12,
218 RELAYD_SEND_INDEX = 13,
219 RELAYD_CLOSE_INDEX = 14,
220 /* Live-reading commands (2.4+). */
221 RELAYD_LIST_SESSIONS = 15,
222 /* All streams of the channel have been sent to the relayd (2.4+). */
223 RELAYD_STREAMS_SENT = 16,
224 /* Ask the relay to reset the metadata trace file (2.8+) */
225 RELAYD_RESET_METADATA = 17,
226 /* Ask the relay to rotate a set of stream files (2.11+) */
227 RELAYD_ROTATE_STREAMS = 18,
228 /* Ask the relay to create a trace chunk (2.11+) */
229 RELAYD_CREATE_TRACE_CHUNK = 19,
230 /* Ask the relay to close a trace chunk (2.11+) */
231 RELAYD_CLOSE_TRACE_CHUNK = 20,
232 /* Ask the relay whether a trace chunk exists (2.11+) */
233 RELAYD_TRACE_CHUNK_EXISTS = 21,
234 /* Get the current configuration of a relayd peer (2.12+) */
235 RELAYD_GET_CONFIGURATION = 22,
236
237 /* Feature branch specific commands start at 10000. */
238 };
239
240 /*
241 * lttcomm error code.
242 */
243 enum lttcomm_return_code {
244 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
245 /*
246 * Some code paths use -1 to express an error, others
247 * negate this consumer return code. Starting codes at
248 * 100 ensures there is no mix-up between this error value
249 * and legitimate status codes.
250 */
251 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
252 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
253 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
254 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
255 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
256 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
257 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
258 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
259 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
260 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
261 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
262 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
263 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
264 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
265 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
266 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
267 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
268 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
269 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
270 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
271 LTTCOMM_CONSUMERD_ALREADY_SET, /* Resource already set. */
272 LTTCOMM_CONSUMERD_ROTATION_FAIL, /* Rotation has failed. */
273 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED, /* snapshot has failed. */
274 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
275 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk creation failed. */
276 LTTCOMM_CONSUMERD_INVALID_PARAMETERS, /* Invalid parameters. */
277 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
278 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
279 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK, /* Unknown trace chunk. */
280 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED, /* Relayd does not accept clear command. */
281 LTTCOMM_CONSUMERD_UNKNOWN_ERROR, /* Unknown error. */
282
283 /* MUST be last element */
284 LTTCOMM_NR, /* Last element */
285 };
286
287 /* lttng socket protocol. */
288 enum lttcomm_sock_proto {
289 LTTCOMM_SOCK_UDP,
290 LTTCOMM_SOCK_TCP,
291 };
292
293 /*
294 * Index in the net_families array below. Please keep in sync!
295 */
296 enum lttcomm_sock_domain {
297 LTTCOMM_INET = 0,
298 LTTCOMM_INET6 = 1,
299 };
300
301 enum lttcomm_metadata_command {
302 LTTCOMM_METADATA_REQUEST = 1,
303 };
304
305 /*
306 * Commands sent from the consumerd to the sessiond to request if new metadata
307 * is available. This message is used to find the per UID _or_ per PID registry
308 * for the channel key. For per UID lookup, the triplet
309 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
310 * per PID registry indexed by session id ignoring the other values.
311 */
312 struct lttcomm_metadata_request_msg {
313 uint64_t session_id; /* Tracing session id */
314 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
315 uint32_t bits_per_long; /* Consumer ABI */
316 uint32_t uid;
317 uint64_t key; /* Metadata channel key. */
318 } LTTNG_PACKED;
319
320 struct lttcomm_sockaddr {
321 enum lttcomm_sock_domain type;
322 union {
323 struct sockaddr_in sin;
324 struct sockaddr_in6 sin6;
325 } addr;
326 } LTTNG_PACKED;
327
328 struct lttcomm_sock {
329 int32_t fd;
330 enum lttcomm_sock_proto proto;
331 struct lttcomm_sockaddr sockaddr;
332 const struct lttcomm_proto_ops *ops;
333 } LTTNG_PACKED;
334
335 /*
336 * Relayd sock. Adds the protocol version to use for the communications with
337 * the relayd.
338 */
339 struct lttcomm_relayd_sock {
340 struct lttcomm_sock sock;
341 uint32_t major;
342 uint32_t minor;
343 } LTTNG_PACKED;
344
345 struct lttcomm_net_family {
346 int family;
347 int (*create) (struct lttcomm_sock *sock, int type, int proto);
348 };
349
350 struct lttcomm_proto_ops {
351 int (*bind) (struct lttcomm_sock *sock);
352 int (*close) (struct lttcomm_sock *sock);
353 int (*connect) (struct lttcomm_sock *sock);
354 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
355 int (*listen) (struct lttcomm_sock *sock, int backlog);
356 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
357 int flags);
358 ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
359 size_t len, int flags);
360 };
361
362 struct process_attr_integral_value_comm {
363 union {
364 int64_t _signed;
365 uint64_t _unsigned;
366 } u;
367 } LTTNG_PACKED;
368
369 /*
370 * Data structure received from lttng client to session daemon.
371 */
372 struct lttcomm_session_msg {
373 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
374 struct lttng_session session;
375 struct lttng_domain domain;
376 union {
377 /* Event data */
378 struct {
379 char channel_name[LTTNG_SYMBOL_NAME_LEN];
380 struct lttng_event event;
381 /* Length of following filter expression. */
382 uint32_t expression_len;
383 /* Length of following bytecode for filter. */
384 uint32_t bytecode_len;
385 /* Exclusion count (fixed-size strings). */
386 uint32_t exclusion_count;
387 /* Userspace probe location size. */
388 uint32_t userspace_probe_location_len;
389 /*
390 * After this structure, the following variable-length
391 * items are transmitted:
392 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
393 * - char filter_expression[expression_len]
394 * - unsigned char filter_bytecode[bytecode_len]
395 */
396 } LTTNG_PACKED enable;
397 struct {
398 char channel_name[LTTNG_SYMBOL_NAME_LEN];
399 struct lttng_event event;
400 /* Length of following filter expression. */
401 uint32_t expression_len;
402 /* Length of following bytecode for filter. */
403 uint32_t bytecode_len;
404 /*
405 * After this structure, the following variable-length
406 * items are transmitted:
407 * - unsigned char filter_expression[expression_len]
408 * - unsigned char filter_bytecode[bytecode_len]
409 */
410 } LTTNG_PACKED disable;
411 /* Create channel */
412 struct {
413 struct lttng_channel chan;
414 struct lttng_channel_extended extended;
415 } LTTNG_PACKED channel;
416 /* Context */
417 struct {
418 char channel_name[LTTNG_SYMBOL_NAME_LEN];
419 struct lttng_event_context ctx;
420 uint32_t provider_name_len;
421 uint32_t context_name_len;
422 } LTTNG_PACKED context;
423 /* Use by register_consumer */
424 struct {
425 char path[PATH_MAX];
426 } LTTNG_PACKED reg;
427 /* List */
428 struct {
429 char channel_name[LTTNG_SYMBOL_NAME_LEN];
430 } LTTNG_PACKED list;
431 struct lttng_calibrate calibrate;
432 /* Used by the set_consumer_url and used by create_session also call */
433 struct {
434 /* Number of lttng_uri following */
435 uint32_t size;
436 } LTTNG_PACKED uri;
437 struct {
438 struct lttng_snapshot_output output;
439 } LTTNG_PACKED snapshot_output;
440 struct {
441 uint32_t wait;
442 struct lttng_snapshot_output output;
443 } LTTNG_PACKED snapshot_record;
444 struct {
445 uint32_t nb_uri;
446 unsigned int timer_interval; /* usec */
447 } LTTNG_PACKED session_live;
448 struct {
449 struct lttng_save_session_attr attr;
450 } LTTNG_PACKED save_session;
451 struct {
452 char shm_path[PATH_MAX];
453 } LTTNG_PACKED set_shm_path;
454 struct {
455 /* enum lttng_process_attr */
456 int32_t process_attr;
457 /* enum lttng_process_attr_value_type */
458 int32_t value_type;
459
460 struct process_attr_integral_value_comm integral_value;
461 /*
462 * For user/group names, a variable length,
463 * zero-terminated, string of length 'name_len'
464 * (including the terminator) follows.
465 *
466 * integral_value should not be used in those cases.
467 */
468 uint32_t name_len;
469 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
470 struct {
471 /* enum lttng_process_attr */
472 int32_t process_attr;
473 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
474 struct {
475 /* enum lttng_process_attr */
476 int32_t process_attr;
477 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
478 struct {
479 /* enum lttng_process_attr */
480 int32_t process_attr;
481 /* enum lttng_tracking_policy */
482 int32_t tracking_policy;
483 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
484 struct {
485 uint32_t length;
486 } LTTNG_PACKED trigger;
487 struct {
488 uint64_t rotation_id;
489 } LTTNG_PACKED get_rotation_info;
490 struct {
491 /* enum lttng_rotation_schedule_type */
492 uint8_t type;
493 /*
494 * If set == 1, set schedule to value, if set == 0,
495 * clear this schedule type.
496 */
497 uint8_t set;
498 uint64_t value;
499 } LTTNG_PACKED rotation_set_schedule;
500 struct {
501 /*
502 * Includes the null-terminator.
503 * Must be an absolute path.
504 *
505 * Size bounded by LTTNG_PATH_MAX.
506 */
507 uint16_t home_dir_size;
508 uint64_t session_descriptor_size;
509 /* An lttng_session_descriptor follows. */
510 } LTTNG_PACKED create_session;
511 } u;
512 /* Count of fds sent. */
513 uint32_t fd_count;
514 } LTTNG_PACKED;
515
516 #define LTTNG_FILTER_MAX_LEN 65536
517 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
518
519 /*
520 * Filter bytecode data. The reloc table is located at the end of the
521 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
522 * starts at reloc_table_offset.
523 */
524 #define LTTNG_FILTER_PADDING 32
525 struct lttng_filter_bytecode {
526 uint32_t len; /* len of data */
527 uint32_t reloc_table_offset;
528 uint64_t seqnum;
529 char padding[LTTNG_FILTER_PADDING];
530 char data[0];
531 } LTTNG_PACKED;
532
533 /*
534 * Event exclusion data. At the end of the structure, there will actually
535 * by zero or more names, where the actual number of names is given by
536 * the 'count' item of the structure.
537 */
538 #define LTTNG_EVENT_EXCLUSION_PADDING 32
539 struct lttng_event_exclusion {
540 uint32_t count;
541 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
542 char names[0][LTTNG_SYMBOL_NAME_LEN];
543 } LTTNG_PACKED;
544
545 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
546 (&(_exclusion)->names[_i][0])
547
548 /*
549 * Event command header.
550 */
551 struct lttcomm_event_command_header {
552 /* Number of events */
553 uint32_t nb_events;
554 } LTTNG_PACKED;
555
556 /*
557 * Event extended info header. This is the structure preceding each
558 * extended info data.
559 */
560 struct lttcomm_event_extended_header {
561 /*
562 * Size of filter string immediately following this header.
563 * This size includes the terminal null character.
564 */
565 uint32_t filter_len;
566
567 /*
568 * Number of exclusion names, immediately following the filter
569 * string. Each exclusion name has a fixed length of
570 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
571 * character.
572 */
573 uint32_t nb_exclusions;
574
575 /*
576 * Size of the event's userspace probe location (if applicable).
577 */
578 uint32_t userspace_probe_location_len;
579 } LTTNG_PACKED;
580
581 /*
582 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
583 */
584 struct lttcomm_session_destroy_command_header {
585 /* enum lttng_session */
586 int32_t rotation_state;
587 };
588
589 /*
590 * tracker command header.
591 */
592 struct lttcomm_tracker_command_header {
593 uint32_t nb_tracker_id;
594 } LTTNG_PACKED;
595
596 /*
597 * Data structure for the response from sessiond to the lttng client.
598 */
599 struct lttcomm_lttng_msg {
600 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
601 uint32_t ret_code; /* enum lttcomm_return_code */
602 uint32_t pid; /* pid_t */
603 uint32_t cmd_header_size;
604 uint32_t data_size;
605 uint32_t fd_count;
606 } LTTNG_PACKED;
607
608 struct lttcomm_lttng_output_id {
609 uint32_t id;
610 } LTTNG_PACKED;
611
612 /*
613 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
614 * to either add a channel, add a stream, update a stream, or stop
615 * operation.
616 */
617 struct lttcomm_consumer_msg {
618 uint32_t cmd_type; /* enum lttng_consumer_command */
619 union {
620 struct {
621 uint64_t channel_key;
622 uint64_t session_id;
623 /* ID of the session's current trace chunk. */
624 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
625 char pathname[PATH_MAX];
626 uint64_t relayd_id;
627 /* nb_init_streams is the number of streams open initially. */
628 uint32_t nb_init_streams;
629 char name[LTTNG_SYMBOL_NAME_LEN];
630 /* Use splice or mmap to consume this fd */
631 enum lttng_event_output output;
632 int type; /* Per cpu or metadata. */
633 uint64_t tracefile_size; /* bytes */
634 uint32_t tracefile_count; /* number of tracefiles */
635 /* If the channel's streams have to be monitored or not. */
636 uint32_t monitor;
637 /* timer to check the streams usage in live mode (usec). */
638 unsigned int live_timer_interval;
639 /* is part of a live session */
640 uint8_t is_live;
641 /* timer to sample a channel's positions (usec). */
642 unsigned int monitor_timer_interval;
643 } LTTNG_PACKED channel; /* Only used by Kernel. */
644 struct {
645 uint64_t stream_key;
646 uint64_t channel_key;
647 int32_t cpu; /* On which CPU this stream is assigned. */
648 /* Tells the consumer if the stream should be or not monitored. */
649 uint32_t no_monitor;
650 } LTTNG_PACKED stream; /* Only used by Kernel. */
651 struct {
652 uint64_t net_index;
653 enum lttng_stream_type type;
654 /* Open socket to the relayd */
655 struct lttcomm_relayd_sock sock;
656 /* Tracing session id associated to the relayd. */
657 uint64_t session_id;
658 /* Relayd session id, only used with control socket. */
659 uint64_t relayd_session_id;
660 } LTTNG_PACKED relayd_sock;
661 struct {
662 uint64_t net_seq_idx;
663 } LTTNG_PACKED destroy_relayd;
664 struct {
665 uint64_t session_id;
666 } LTTNG_PACKED data_pending;
667 struct {
668 uint64_t subbuf_size; /* bytes */
669 uint64_t num_subbuf; /* power of 2 */
670 int32_t overwrite; /* 1: overwrite, 0: discard */
671 uint32_t switch_timer_interval; /* usec */
672 uint32_t read_timer_interval; /* usec */
673 unsigned int live_timer_interval; /* usec */
674 uint8_t is_live; /* is part of a live session */
675 uint32_t monitor_timer_interval; /* usec */
676 int32_t output; /* splice, mmap */
677 int32_t type; /* metadata or per_cpu */
678 uint64_t session_id; /* Tracing session id */
679 char pathname[PATH_MAX]; /* Channel file path. */
680 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
681 /* Credentials used to open the UST buffer shared mappings. */
682 struct {
683 uint32_t uid;
684 uint32_t gid;
685 } LTTNG_PACKED buffer_credentials;
686 uint64_t relayd_id; /* Relayd id if apply. */
687 uint64_t key; /* Unique channel key. */
688 /* ID of the session's current trace chunk. */
689 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
690 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
691 uint32_t chan_id; /* Channel ID on the tracer side. */
692 uint64_t tracefile_size; /* bytes */
693 uint32_t tracefile_count; /* number of tracefiles */
694 uint64_t session_id_per_pid; /* Per-pid session ID. */
695 /* Tells the consumer if the stream should be or not monitored. */
696 uint32_t monitor;
697 /*
698 * For UST per UID buffers, this is the application UID of the
699 * channel. This can be different from the user UID requesting the
700 * channel creation and used for the rights on the stream file
701 * because the application can be in the tracing for instance.
702 */
703 uint32_t ust_app_uid;
704 int64_t blocking_timeout;
705 char root_shm_path[PATH_MAX];
706 char shm_path[PATH_MAX];
707 } LTTNG_PACKED ask_channel;
708 struct {
709 uint64_t key;
710 } LTTNG_PACKED get_channel;
711 struct {
712 uint64_t key;
713 } LTTNG_PACKED destroy_channel;
714 struct {
715 uint64_t key; /* Metadata channel key. */
716 uint64_t target_offset; /* Offset in the consumer */
717 uint64_t len; /* Length of metadata to be received. */
718 uint64_t version; /* Version of the metadata. */
719 } LTTNG_PACKED push_metadata;
720 struct {
721 uint64_t key; /* Metadata channel key. */
722 } LTTNG_PACKED close_metadata;
723 struct {
724 uint64_t key; /* Metadata channel key. */
725 } LTTNG_PACKED setup_metadata;
726 struct {
727 uint64_t key; /* Channel key. */
728 } LTTNG_PACKED flush_channel;
729 struct {
730 uint64_t key; /* Channel key. */
731 } LTTNG_PACKED clear_quiescent_channel;
732 struct {
733 char pathname[PATH_MAX];
734 /* Indicate if the snapshot goes on the relayd or locally. */
735 uint32_t use_relayd;
736 uint32_t metadata; /* This a metadata snapshot. */
737 uint64_t relayd_id; /* Relayd id if apply. */
738 uint64_t key;
739 uint64_t nb_packets_per_stream;
740 } LTTNG_PACKED snapshot_channel;
741 struct {
742 uint64_t channel_key;
743 uint64_t net_seq_idx;
744 } LTTNG_PACKED sent_streams;
745 struct {
746 uint64_t session_id;
747 uint64_t channel_key;
748 } LTTNG_PACKED discarded_events;
749 struct {
750 uint64_t session_id;
751 uint64_t channel_key;
752 } LTTNG_PACKED lost_packets;
753 struct {
754 uint64_t session_id;
755 } LTTNG_PACKED regenerate_metadata;
756 struct {
757 uint32_t metadata; /* This is a metadata channel. */
758 uint64_t relayd_id; /* Relayd id if apply. */
759 uint64_t key;
760 } LTTNG_PACKED rotate_channel;
761 struct {
762 uint64_t session_id;
763 uint64_t chunk_id;
764 } LTTNG_PACKED check_rotation_pending_local;
765 struct {
766 uint64_t relayd_id;
767 uint64_t session_id;
768 uint64_t chunk_id;
769 } LTTNG_PACKED check_rotation_pending_relay;
770 struct {
771 /*
772 * Relayd id, if applicable (remote).
773 *
774 * A directory file descriptor referring to the chunk's
775 * output folder is transmitted if the chunk is local
776 * (relayd_id unset).
777 *
778 * `override_name` is left NULL (all-zeroes) if the
779 * chunk's name is not overridden.
780 */
781 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
782 char override_name[LTTNG_NAME_MAX];
783 uint64_t session_id;
784 uint64_t chunk_id;
785 uint64_t creation_timestamp;
786 LTTNG_OPTIONAL_COMM(struct {
787 uint32_t uid;
788 uint32_t gid;
789 } LTTNG_PACKED ) LTTNG_PACKED credentials;
790 } LTTNG_PACKED create_trace_chunk;
791 struct {
792 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
793 uint64_t session_id;
794 uint64_t chunk_id;
795 uint64_t close_timestamp;
796 /* enum lttng_trace_chunk_command_type */
797 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
798 } LTTNG_PACKED close_trace_chunk;
799 struct {
800 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
801 uint64_t session_id;
802 uint64_t chunk_id;
803 } LTTNG_PACKED trace_chunk_exists;
804 struct {
805 lttng_uuid sessiond_uuid;
806 } LTTNG_PACKED init;
807 struct {
808 uint64_t key;
809 } LTTNG_PACKED clear_channel;
810 struct {
811 uint64_t key;
812 } LTTNG_PACKED open_channel_packets;
813 } u;
814 } LTTNG_PACKED;
815
816 /*
817 * Channel monitoring message returned to the session daemon on every
818 * monitor timer expiration.
819 */
820 struct lttcomm_consumer_channel_monitor_msg {
821 /* Key of the sampled channel. */
822 uint64_t key;
823 /*
824 * Lowest and highest usage (bytes) at the moment the sample was taken.
825 */
826 uint64_t lowest, highest;
827 /*
828 * Sum of all the consumed positions for a channel.
829 */
830 uint64_t total_consumed;
831 } LTTNG_PACKED;
832
833 /*
834 * Status message returned to the sessiond after a received command.
835 */
836 struct lttcomm_consumer_status_msg {
837 enum lttcomm_return_code ret_code;
838 } LTTNG_PACKED;
839
840 struct lttcomm_consumer_status_channel {
841 enum lttcomm_return_code ret_code;
842 uint64_t key;
843 unsigned int stream_count;
844 } LTTNG_PACKED;
845
846 struct lttcomm_consumer_close_trace_chunk_reply {
847 enum lttcomm_return_code ret_code;
848 uint32_t path_length;
849 char path[];
850 };
851
852 #ifdef HAVE_LIBLTTNG_UST_CTL
853
854 #include <lttng/ust-abi.h>
855
856 /*
857 * Data structure for the commands sent from sessiond to UST.
858 */
859 struct lttcomm_ust_msg {
860 uint32_t handle;
861 uint32_t cmd;
862 union {
863 struct lttng_ust_channel channel;
864 struct lttng_ust_stream stream;
865 struct lttng_ust_event event;
866 struct lttng_ust_context context;
867 struct lttng_ust_tracer_version version;
868 } u;
869 } LTTNG_PACKED;
870
871 /*
872 * Data structure for the response from UST to the session daemon.
873 * cmd_type is sent back in the reply for validation.
874 */
875 struct lttcomm_ust_reply {
876 uint32_t handle;
877 uint32_t cmd;
878 uint32_t ret_code; /* enum lttcomm_return_code */
879 uint32_t ret_val; /* return value */
880 union {
881 struct {
882 uint64_t memory_map_size;
883 } LTTNG_PACKED channel;
884 struct {
885 uint64_t memory_map_size;
886 } LTTNG_PACKED stream;
887 struct lttng_ust_tracer_version version;
888 } u;
889 } LTTNG_PACKED;
890
891 #endif /* HAVE_LIBLTTNG_UST_CTL */
892
893 LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
894
895 LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
896 const char *ip, unsigned int port);
897 LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
898 const char *ip, unsigned int port);
899
900 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
901 LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
902 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
903 LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
904 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
905 LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
906 struct lttcomm_sock *src);
907
908 /* Relayd socket object. */
909 LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
910 struct lttng_uri *uri, uint32_t major, uint32_t minor);
911
912 LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
913 LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
914
915 LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
916 uint16_t *port);
917 /*
918 * Set a port to an lttcomm_sock. This will have no effect is the socket is
919 * already bound.
920 */
921 LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
922
923 LTTNG_HIDDEN void lttcomm_init(void);
924 /* Get network timeout, in milliseconds */
925 LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
926
927 #endif /* _LTTNG_SESSIOND_COMM_H */
LTTng 2.0 tools and control repository
This page took 0.046158 seconds and 3 git commands to generate.