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


7b3e0f509ac945b0af26bc7bbe31b7b304ef2b41
[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 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 } LTTNG_PACKED;
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 } LTTNG_PACKED;
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 } LTTNG_PACKED;
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 struct lttng_event event;
384 /* Length of following filter expression. */
385 uint32_t expression_len;
386 /* Length of following bytecode for filter. */
387 uint32_t bytecode_len;
388 /* Exclusion count (fixed-size strings). */
389 uint32_t exclusion_count;
390 /* Userspace probe location size. */
391 uint32_t userspace_probe_location_len;
392 /*
393 * After this structure, the following variable-length
394 * items are transmitted:
395 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
396 * - char filter_expression[expression_len]
397 * - unsigned char filter_bytecode[bytecode_len]
398 */
399 } LTTNG_PACKED enable;
400 struct {
401 char channel_name[LTTNG_SYMBOL_NAME_LEN];
402 struct lttng_event event;
403 /* Length of following filter expression. */
404 uint32_t expression_len;
405 /* Length of following bytecode for filter. */
406 uint32_t bytecode_len;
407 /*
408 * After this structure, the following variable-length
409 * items are transmitted:
410 * - unsigned char filter_expression[expression_len]
411 * - unsigned char filter_bytecode[bytecode_len]
412 */
413 } LTTNG_PACKED disable;
414 /* Create channel */
415 struct {
416 struct lttng_channel chan;
417 struct lttng_channel_extended extended;
418 } LTTNG_PACKED channel;
419 /* Context */
420 struct {
421 char channel_name[LTTNG_SYMBOL_NAME_LEN];
422 struct lttng_event_context ctx;
423 uint32_t provider_name_len;
424 uint32_t context_name_len;
425 } LTTNG_PACKED context;
426 /* Use by register_consumer */
427 struct {
428 char path[PATH_MAX];
429 } LTTNG_PACKED reg;
430 /* List */
431 struct {
432 char channel_name[LTTNG_SYMBOL_NAME_LEN];
433 } LTTNG_PACKED list;
434 struct lttng_calibrate calibrate;
435 /* Used by the set_consumer_url and used by create_session also call */
436 struct {
437 /* Number of lttng_uri following */
438 uint32_t size;
439 } LTTNG_PACKED uri;
440 struct {
441 struct lttng_snapshot_output output;
442 } LTTNG_PACKED snapshot_output;
443 struct {
444 uint32_t wait;
445 struct lttng_snapshot_output output;
446 } LTTNG_PACKED snapshot_record;
447 struct {
448 uint32_t nb_uri;
449 unsigned int timer_interval; /* usec */
450 } LTTNG_PACKED session_live;
451 struct {
452 struct lttng_save_session_attr attr;
453 } LTTNG_PACKED save_session;
454 struct {
455 char shm_path[PATH_MAX];
456 } LTTNG_PACKED set_shm_path;
457 struct {
458 /* enum lttng_process_attr */
459 int32_t process_attr;
460 /* enum lttng_process_attr_value_type */
461 int32_t value_type;
462
463 struct process_attr_integral_value_comm integral_value;
464 /*
465 * For user/group names, a variable length,
466 * zero-terminated, string of length 'name_len'
467 * (including the terminator) follows.
468 *
469 * integral_value should not be used in those cases.
470 */
471 uint32_t name_len;
472 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
473 struct {
474 /* enum lttng_process_attr */
475 int32_t process_attr;
476 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
477 struct {
478 /* enum lttng_process_attr */
479 int32_t process_attr;
480 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
481 struct {
482 /* enum lttng_process_attr */
483 int32_t process_attr;
484 /* enum lttng_tracking_policy */
485 int32_t tracking_policy;
486 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
487 struct {
488 uint32_t length;
489 uint8_t is_trigger_anonymous;
490 } LTTNG_PACKED trigger;
491 struct {
492 uint32_t length;
493 } LTTNG_PACKED error_query;
494 struct {
495 uint64_t rotation_id;
496 } LTTNG_PACKED get_rotation_info;
497 struct {
498 /* enum lttng_rotation_schedule_type */
499 uint8_t type;
500 /*
501 * If set == 1, set schedule to value, if set == 0,
502 * clear this schedule type.
503 */
504 uint8_t set;
505 uint64_t value;
506 } LTTNG_PACKED rotation_set_schedule;
507 struct {
508 /*
509 * Includes the null-terminator.
510 * Must be an absolute path.
511 *
512 * Size bounded by LTTNG_PATH_MAX.
513 */
514 uint16_t home_dir_size;
515 uint64_t session_descriptor_size;
516 /* An lttng_session_descriptor follows. */
517 } LTTNG_PACKED create_session;
518 } u;
519 /* Count of fds sent. */
520 uint32_t fd_count;
521 } LTTNG_PACKED;
522
523 #define LTTNG_FILTER_MAX_LEN 65536
524 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
525
526 /*
527 * Filter bytecode data. The reloc table is located at the end of the
528 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
529 * starts at reloc_table_offset.
530 */
531 #define LTTNG_FILTER_PADDING 32
532 struct lttng_bytecode {
533 uint32_t len; /* len of data */
534 uint32_t reloc_table_offset;
535 uint64_t seqnum;
536 char padding[LTTNG_FILTER_PADDING];
537 char data[0];
538 } LTTNG_PACKED;
539
540 /*
541 * Event exclusion data. At the end of the structure, there will actually
542 * by zero or more names, where the actual number of names is given by
543 * the 'count' item of the structure.
544 */
545 #define LTTNG_EVENT_EXCLUSION_PADDING 32
546 struct lttng_event_exclusion {
547 uint32_t count;
548 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
549 char names[0][LTTNG_SYMBOL_NAME_LEN];
550 } LTTNG_PACKED;
551
552 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
553 (&(_exclusion)->names[_i][0])
554
555 /*
556 * Event command header.
557 */
558 struct lttcomm_event_command_header {
559 /* Number of events */
560 uint32_t nb_events;
561 } LTTNG_PACKED;
562
563 /*
564 * Event extended info header. This is the structure preceding each
565 * extended info data.
566 */
567 struct lttcomm_event_extended_header {
568 /*
569 * Size of filter string immediately following this header.
570 * This size includes the terminal null character.
571 */
572 uint32_t filter_len;
573
574 /*
575 * Number of exclusion names, immediately following the filter
576 * string. Each exclusion name has a fixed length of
577 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
578 * character.
579 */
580 uint32_t nb_exclusions;
581
582 /*
583 * Size of the event's userspace probe location (if applicable).
584 */
585 uint32_t userspace_probe_location_len;
586 } LTTNG_PACKED;
587
588 /*
589 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
590 */
591 struct lttcomm_session_destroy_command_header {
592 /* enum lttng_session */
593 int32_t rotation_state;
594 };
595
596 /*
597 * tracker command header.
598 */
599 struct lttcomm_tracker_command_header {
600 uint32_t nb_tracker_id;
601 } LTTNG_PACKED;
602
603 /*
604 * Data structure for the response from sessiond to the lttng client.
605 */
606 struct lttcomm_lttng_msg {
607 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
608 uint32_t ret_code; /* enum lttcomm_return_code */
609 uint32_t pid; /* pid_t */
610 uint32_t cmd_header_size;
611 uint32_t data_size;
612 uint32_t fd_count;
613 } LTTNG_PACKED;
614
615 struct lttcomm_lttng_output_id {
616 uint32_t id;
617 } LTTNG_PACKED;
618
619 /*
620 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
621 * to either add a channel, add a stream, update a stream, or stop
622 * operation.
623 */
624 struct lttcomm_consumer_msg {
625 uint32_t cmd_type; /* enum lttng_consumer_command */
626 union {
627 struct {
628 uint64_t channel_key;
629 uint64_t session_id;
630 /* ID of the session's current trace chunk. */
631 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
632 char pathname[PATH_MAX];
633 uint64_t relayd_id;
634 /* nb_init_streams is the number of streams open initially. */
635 uint32_t nb_init_streams;
636 char name[LTTNG_SYMBOL_NAME_LEN];
637 /* Use splice or mmap to consume this fd */
638 enum lttng_event_output output;
639 int type; /* Per cpu or metadata. */
640 uint64_t tracefile_size; /* bytes */
641 uint32_t tracefile_count; /* number of tracefiles */
642 /* If the channel's streams have to be monitored or not. */
643 uint32_t monitor;
644 /* timer to check the streams usage in live mode (usec). */
645 unsigned int live_timer_interval;
646 /* is part of a live session */
647 uint8_t is_live;
648 /* timer to sample a channel's positions (usec). */
649 unsigned int monitor_timer_interval;
650 } LTTNG_PACKED channel; /* Only used by Kernel. */
651 struct {
652 uint64_t stream_key;
653 uint64_t channel_key;
654 int32_t cpu; /* On which CPU this stream is assigned. */
655 /* Tells the consumer if the stream should be or not monitored. */
656 uint32_t no_monitor;
657 } LTTNG_PACKED stream; /* Only used by Kernel. */
658 struct {
659 uint64_t net_index;
660 enum lttng_stream_type type;
661 /* Open socket to the relayd */
662 struct lttcomm_relayd_sock sock;
663 /* Tracing session id associated to the relayd. */
664 uint64_t session_id;
665 /* Relayd session id, only used with control socket. */
666 uint64_t relayd_session_id;
667 } LTTNG_PACKED relayd_sock;
668 struct {
669 uint64_t net_seq_idx;
670 } LTTNG_PACKED destroy_relayd;
671 struct {
672 uint64_t session_id;
673 } LTTNG_PACKED data_pending;
674 struct {
675 uint64_t subbuf_size; /* bytes */
676 uint64_t num_subbuf; /* power of 2 */
677 int32_t overwrite; /* 1: overwrite, 0: discard */
678 uint32_t switch_timer_interval; /* usec */
679 uint32_t read_timer_interval; /* usec */
680 unsigned int live_timer_interval; /* usec */
681 uint8_t is_live; /* is part of a live session */
682 uint32_t monitor_timer_interval; /* usec */
683 int32_t output; /* splice, mmap */
684 int32_t type; /* metadata or per_cpu */
685 uint64_t session_id; /* Tracing session id */
686 char pathname[PATH_MAX]; /* Channel file path. */
687 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
688 /* Credentials used to open the UST buffer shared mappings. */
689 struct {
690 uint32_t uid;
691 uint32_t gid;
692 } LTTNG_PACKED buffer_credentials;
693 uint64_t relayd_id; /* Relayd id if apply. */
694 uint64_t key; /* Unique channel key. */
695 /* ID of the session's current trace chunk. */
696 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
697 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
698 uint32_t chan_id; /* Channel ID on the tracer side. */
699 uint64_t tracefile_size; /* bytes */
700 uint32_t tracefile_count; /* number of tracefiles */
701 uint64_t session_id_per_pid; /* Per-pid session ID. */
702 /* Tells the consumer if the stream should be or not monitored. */
703 uint32_t monitor;
704 /*
705 * For UST per UID buffers, this is the application UID of the
706 * channel. This can be different from the user UID requesting the
707 * channel creation and used for the rights on the stream file
708 * because the application can be in the tracing for instance.
709 */
710 uint32_t ust_app_uid;
711 int64_t blocking_timeout;
712 char root_shm_path[PATH_MAX];
713 char shm_path[PATH_MAX];
714 } LTTNG_PACKED ask_channel;
715 struct {
716 uint64_t key;
717 } LTTNG_PACKED get_channel;
718 struct {
719 uint64_t key;
720 } LTTNG_PACKED destroy_channel;
721 struct {
722 uint64_t key; /* Metadata channel key. */
723 uint64_t target_offset; /* Offset in the consumer */
724 uint64_t len; /* Length of metadata to be received. */
725 uint64_t version; /* Version of the metadata. */
726 } LTTNG_PACKED push_metadata;
727 struct {
728 uint64_t key; /* Metadata channel key. */
729 } LTTNG_PACKED close_metadata;
730 struct {
731 uint64_t key; /* Metadata channel key. */
732 } LTTNG_PACKED setup_metadata;
733 struct {
734 uint64_t key; /* Channel key. */
735 } LTTNG_PACKED flush_channel;
736 struct {
737 uint64_t key; /* Channel key. */
738 } LTTNG_PACKED clear_quiescent_channel;
739 struct {
740 char pathname[PATH_MAX];
741 /* Indicate if the snapshot goes on the relayd or locally. */
742 uint32_t use_relayd;
743 uint32_t metadata; /* This a metadata snapshot. */
744 uint64_t relayd_id; /* Relayd id if apply. */
745 uint64_t key;
746 uint64_t nb_packets_per_stream;
747 } LTTNG_PACKED snapshot_channel;
748 struct {
749 uint64_t channel_key;
750 uint64_t net_seq_idx;
751 } LTTNG_PACKED sent_streams;
752 struct {
753 uint64_t session_id;
754 uint64_t channel_key;
755 } LTTNG_PACKED discarded_events;
756 struct {
757 uint64_t session_id;
758 uint64_t channel_key;
759 } LTTNG_PACKED lost_packets;
760 struct {
761 uint64_t session_id;
762 } LTTNG_PACKED regenerate_metadata;
763 struct {
764 uint32_t metadata; /* This is a metadata channel. */
765 uint64_t relayd_id; /* Relayd id if apply. */
766 uint64_t key;
767 } LTTNG_PACKED rotate_channel;
768 struct {
769 uint64_t session_id;
770 uint64_t chunk_id;
771 } LTTNG_PACKED check_rotation_pending_local;
772 struct {
773 uint64_t relayd_id;
774 uint64_t session_id;
775 uint64_t chunk_id;
776 } LTTNG_PACKED check_rotation_pending_relay;
777 struct {
778 /*
779 * Relayd id, if applicable (remote).
780 *
781 * A directory file descriptor referring to the chunk's
782 * output folder is transmitted if the chunk is local
783 * (relayd_id unset).
784 *
785 * `override_name` is left NULL (all-zeroes) if the
786 * chunk's name is not overridden.
787 */
788 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
789 char override_name[LTTNG_NAME_MAX];
790 uint64_t session_id;
791 uint64_t chunk_id;
792 uint64_t creation_timestamp;
793 LTTNG_OPTIONAL_COMM(struct {
794 uint32_t uid;
795 uint32_t gid;
796 } LTTNG_PACKED ) LTTNG_PACKED credentials;
797 } LTTNG_PACKED create_trace_chunk;
798 struct {
799 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
800 uint64_t session_id;
801 uint64_t chunk_id;
802 uint64_t close_timestamp;
803 /* enum lttng_trace_chunk_command_type */
804 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
805 } LTTNG_PACKED close_trace_chunk;
806 struct {
807 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
808 uint64_t session_id;
809 uint64_t chunk_id;
810 } LTTNG_PACKED trace_chunk_exists;
811 struct {
812 lttng_uuid sessiond_uuid;
813 } LTTNG_PACKED init;
814 struct {
815 uint64_t key;
816 } LTTNG_PACKED clear_channel;
817 struct {
818 uint64_t key;
819 } LTTNG_PACKED open_channel_packets;
820 } u;
821 } LTTNG_PACKED;
822
823 /*
824 * Channel monitoring message returned to the session daemon on every
825 * monitor timer expiration.
826 */
827 struct lttcomm_consumer_channel_monitor_msg {
828 /* Key of the sampled channel. */
829 uint64_t key;
830 /*
831 * Lowest and highest usage (bytes) at the moment the sample was taken.
832 */
833 uint64_t lowest, highest;
834 /*
835 * Sum of all the consumed positions for a channel.
836 */
837 uint64_t total_consumed;
838 } LTTNG_PACKED;
839
840 /*
841 * Status message returned to the sessiond after a received command.
842 */
843 struct lttcomm_consumer_status_msg {
844 enum lttcomm_return_code ret_code;
845 } LTTNG_PACKED;
846
847 struct lttcomm_consumer_status_channel {
848 enum lttcomm_return_code ret_code;
849 uint64_t key;
850 unsigned int stream_count;
851 } LTTNG_PACKED;
852
853 struct lttcomm_consumer_close_trace_chunk_reply {
854 enum lttcomm_return_code ret_code;
855 uint32_t path_length;
856 char path[];
857 };
858
859 #ifdef HAVE_LIBLTTNG_UST_CTL
860
861 #include <lttng/ust-abi.h>
862
863 /*
864 * Data structure for the commands sent from sessiond to UST.
865 */
866 struct lttcomm_ust_msg {
867 uint32_t handle;
868 uint32_t cmd;
869 union {
870 struct lttng_ust_abi_channel channel;
871 struct lttng_ust_abi_stream stream;
872 struct lttng_ust_abi_event event;
873 struct lttng_ust_abi_context context;
874 struct lttng_ust_abi_tracer_version version;
875 } u;
876 } LTTNG_PACKED;
877
878 /*
879 * Data structure for the response from UST to the session daemon.
880 * cmd_type is sent back in the reply for validation.
881 */
882 struct lttcomm_ust_reply {
883 uint32_t handle;
884 uint32_t cmd;
885 uint32_t ret_code; /* enum lttcomm_return_code */
886 uint32_t ret_val; /* return value */
887 union {
888 struct {
889 uint64_t memory_map_size;
890 } LTTNG_PACKED channel;
891 struct {
892 uint64_t memory_map_size;
893 } LTTNG_PACKED stream;
894 struct lttng_ust_abi_tracer_version version;
895 } u;
896 } LTTNG_PACKED;
897
898 #endif /* HAVE_LIBLTTNG_UST_CTL */
899
900 LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
901
902 LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
903 const char *ip, unsigned int port);
904 LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
905 const char *ip, unsigned int port);
906
907 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
908 LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
909 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
910 LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
911 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
912 LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
913 struct lttcomm_sock *src);
914
915 /* Relayd socket object. */
916 LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
917 struct lttng_uri *uri, uint32_t major, uint32_t minor);
918
919 LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
920 LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
921
922 LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
923 uint16_t *port);
924 /*
925 * Set a port to an lttcomm_sock. This will have no effect is the socket is
926 * already bound.
927 */
928 LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
929
930 LTTNG_HIDDEN void lttcomm_init(void);
931 /* Get network timeout, in milliseconds */
932 LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
933
934 #endif /* _LTTNG_SESSIOND_COMM_H */
LTTng 2.0 tools and control repository
This page took 0.050191 seconds and 4 git commands to generate.