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


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