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


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