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


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