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


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