trigger: implement listing of registered trigger
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
CommitLineData
6e3805e2 1/*
ab5be9fa
MJ
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>
fac6795d 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
ba999de0 7 *
fac6795d
DG
8 */
9
773168b7 10/*
990570ed
DG
11 * This header is meant for liblttng and libust internal use ONLY. These
12 * declarations should NOT be considered stable API.
773168b7 13 */
fac6795d 14
990570ed
DG
15#ifndef _LTTNG_SESSIOND_COMM_H
16#define _LTTNG_SESSIOND_COMM_H
17
fac6795d 18#include <limits.h>
f3ed775e 19#include <lttng/lttng.h>
da3c9ec1 20#include <lttng/snapshot-internal.h>
00c76cea 21#include <lttng/save-internal.h>
e9404c27
JG
22#include <lttng/channel-internal.h>
23#include <lttng/trigger/trigger-internal.h>
d88744a4 24#include <lttng/rotate-internal.h>
b17231c6 25#include <common/compat/socket.h>
a4b92340 26#include <common/uri.h>
ce2a9e76 27#include <common/defaults.h>
c70636a7 28#include <common/uuid.h>
aa52c986 29#include <common/macros.h>
d2956687 30#include <common/optional.h>
5e16da05 31
6364a07a
DG
32#include <arpa/inet.h>
33#include <netinet/in.h>
34#include <sys/un.h>
35
36#include "inet.h"
37#include "inet6.h"
2038dd6c 38#include <common/unix.h>
0d37f2bc 39
fac6795d 40/* Queue size of listen(2) */
f158a754 41#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 42
990570ed 43/* Maximum number of FDs that can be sent over a Unix socket */
0b5a4de9
JG
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
990570ed 50
3817e7df
DG
51/*
52 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 53 */
f73fabfd 54#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
fac6795d 55
6abb15de 56enum lttcomm_sessiond_command {
0d0c377a 57 /* Tracer command */
159b042f 58 LTTNG_ADD_CONTEXT = 0,
b812e5ca 59 /* LTTNG_CALIBRATE used to be here */
159b042f
JG
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,
18a720cd 65 /* 7 */
0d0c377a 66 /* Session daemon command */
b178f53e 67 /* 8 */
159b042f
JG
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,
53a80697 78
de5e9086 79 /* Consumer */
159b042f
JG
80 LTTNG_DISABLE_CONSUMER = 19,
81 LTTNG_ENABLE_CONSUMER = 20,
82 LTTNG_SET_CONSUMER_URI = 21,
67676bd8
DG
83 /* 22 */
84 /* 23 */
159b042f
JG
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,
b178f53e
JG
90 /* 29 */
91 /* 30 */
159b042f
JG
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,
fbc9f37d 109 LTTNG_LIST_TRIGGERS = 51,
7c9534d6
JD
110};
111
112enum lttcomm_relayd_command {
113 RELAYD_ADD_STREAM = 1,
114 RELAYD_CREATE_SESSION = 2,
115 RELAYD_START_DATA = 3,
116 RELAYD_UPDATE_SYNC_INFO = 4,
117 RELAYD_VERSION = 5,
118 RELAYD_SEND_METADATA = 6,
119 RELAYD_CLOSE_STREAM = 7,
120 RELAYD_DATA_PENDING = 8,
121 RELAYD_QUIESCENT_CONTROL = 9,
122 RELAYD_BEGIN_DATA_PENDING = 10,
123 RELAYD_END_DATA_PENDING = 11,
1c20f0e2
JD
124 RELAYD_ADD_INDEX = 12,
125 RELAYD_SEND_INDEX = 13,
126 RELAYD_CLOSE_INDEX = 14,
a4baae1b 127 /* Live-reading commands (2.4+). */
d3e2ba59 128 RELAYD_LIST_SESSIONS = 15,
a4baae1b
JD
129 /* All streams of the channel have been sent to the relayd (2.4+). */
130 RELAYD_STREAMS_SENT = 16,
93ec662e
JD
131 /* Ask the relay to reset the metadata trace file (2.8+) */
132 RELAYD_RESET_METADATA = 17,
c35f9726
JG
133 /* Ask the relay to rotate a set of stream files (2.11+) */
134 RELAYD_ROTATE_STREAMS = 18,
e5add6d0
JG
135 /* Ask the relay to create a trace chunk (2.11+) */
136 RELAYD_CREATE_TRACE_CHUNK = 19,
bbc4768c
JG
137 /* Ask the relay to close a trace chunk (2.11+) */
138 RELAYD_CLOSE_TRACE_CHUNK = 20,
c35f9726
JG
139 /* Ask the relay whether a trace chunk exists (2.11+) */
140 RELAYD_TRACE_CHUNK_EXISTS = 21,
8614e600
MD
141 /* Get the current configuration of a relayd peer (2.12+) */
142 RELAYD_GET_CONFIGURATION = 22,
3fe73a46
MD
143
144 /* Feature branch specific commands start at 10000. */
fac6795d
DG
145};
146
147/*
148 * lttcomm error code.
149 */
150enum lttcomm_return_code {
0c759fc9 151 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
d2956687
JG
152 /*
153 * Some code paths use -1 to express an error, others
154 * negate this consumer return code. Starting codes at
155 * 100 ensures there is no mix-up between this error value
156 * and legitimate status codes.
157 */
158 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
f73fabfd
DG
159 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
160 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
161 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
162 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
163 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
164 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
165 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
166 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
167 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
168 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
169 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
170 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
171 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
ffe60014 172 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
d88aee68
DG
173 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
174 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
618a6a28 175 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
0c759fc9 176 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
e462382a 177 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
e9404c27 178 LTTCOMM_CONSUMERD_ALREADY_SET, /* Resource already set. */
92b7a7f8 179 LTTCOMM_CONSUMERD_ROTATION_FAIL, /* Rotation has failed. */
3eb928aa 180 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED, /* snapshot has failed. */
d2956687
JG
181 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
182 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk creation failed. */
183 LTTCOMM_CONSUMERD_INVALID_PARAMETERS, /* Invalid parameters. */
184 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
185 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
186 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK, /* Unknown trace chunk. */
b01b201a 187 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED, /* Relayd does not accept clear command. */
04ed9e10 188 LTTCOMM_CONSUMERD_UNKNOWN_ERROR, /* Unknown error. */
80e327fa 189
20fe2104
DG
190 /* MUST be last element */
191 LTTCOMM_NR, /* Last element */
fac6795d
DG
192};
193
de5e9086
DG
194/* lttng socket protocol. */
195enum lttcomm_sock_proto {
196 LTTCOMM_SOCK_UDP,
197 LTTCOMM_SOCK_TCP,
198};
199
200/*
201 * Index in the net_families array below. Please keep in sync!
202 */
203enum lttcomm_sock_domain {
01d0a631
CB
204 LTTCOMM_INET = 0,
205 LTTCOMM_INET6 = 1,
de5e9086
DG
206};
207
331744e3
JD
208enum lttcomm_metadata_command {
209 LTTCOMM_METADATA_REQUEST = 1,
210};
211
212/*
213 * Commands sent from the consumerd to the sessiond to request if new metadata
214 * is available. This message is used to find the per UID _or_ per PID registry
215 * for the channel key. For per UID lookup, the triplet
216 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
217 * per PID registry indexed by session id ignoring the other values.
218 */
219struct lttcomm_metadata_request_msg {
1950109e
JD
220 uint64_t session_id; /* Tracing session id */
221 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
331744e3
JD
222 uint32_t bits_per_long; /* Consumer ABI */
223 uint32_t uid;
224 uint64_t key; /* Metadata channel key. */
225} LTTNG_PACKED;
226
de5e9086
DG
227struct lttcomm_sockaddr {
228 enum lttcomm_sock_domain type;
229 union {
230 struct sockaddr_in sin;
231 struct sockaddr_in6 sin6;
232 } addr;
fc5e05b7 233} LTTNG_PACKED;
de5e9086
DG
234
235struct lttcomm_sock {
d88aee68 236 int32_t fd;
de5e9086
DG
237 enum lttcomm_sock_proto proto;
238 struct lttcomm_sockaddr sockaddr;
239 const struct lttcomm_proto_ops *ops;
fc5e05b7 240} LTTNG_PACKED;
de5e9086 241
6151a90f
JD
242/*
243 * Relayd sock. Adds the protocol version to use for the communications with
244 * the relayd.
245 */
246struct lttcomm_relayd_sock {
247 struct lttcomm_sock sock;
248 uint32_t major;
249 uint32_t minor;
250} LTTNG_PACKED;
251
de5e9086
DG
252struct lttcomm_net_family {
253 int family;
254 int (*create) (struct lttcomm_sock *sock, int type, int proto);
255};
256
257struct lttcomm_proto_ops {
258 int (*bind) (struct lttcomm_sock *sock);
259 int (*close) (struct lttcomm_sock *sock);
260 int (*connect) (struct lttcomm_sock *sock);
261 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
262 int (*listen) (struct lttcomm_sock *sock, int backlog);
263 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
264 int flags);
c2d69327
JG
265 ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
266 size_t len, int flags);
de5e9086
DG
267};
268
159b042f
JG
269struct process_attr_integral_value_comm {
270 union {
271 int64_t _signed;
272 uint64_t _unsigned;
273 } u;
274} LTTNG_PACKED;
275
fac6795d 276/*
9bda164d 277 * Data structure received from lttng client to session daemon.
fac6795d
DG
278 */
279struct lttcomm_session_msg {
d0b96690 280 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 281 struct lttng_session session;
9f19cc17 282 struct lttng_domain domain;
fac6795d 283 union {
f3ed775e 284 /* Event data */
fac6795d 285 struct {
db8870ed 286 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7bd95aee 287 struct lttng_event event;
6b453b5e
JG
288 /* Length of following filter expression. */
289 uint32_t expression_len;
025faf73
DG
290 /* Length of following bytecode for filter. */
291 uint32_t bytecode_len;
15e37663 292 /* Exclusion count (fixed-size strings). */
a5516688 293 uint32_t exclusion_count;
15e37663
JG
294 /* Userspace probe location size. */
295 uint32_t userspace_probe_location_len;
a5516688
JI
296 /*
297 * After this structure, the following variable-length
298 * items are transmitted:
299 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
15e37663 300 * - char filter_expression[expression_len]
a5516688
JI
301 * - unsigned char filter_bytecode[bytecode_len]
302 */
fc5e05b7 303 } LTTNG_PACKED enable;
6e911cad
MD
304 struct {
305 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7bd95aee 306 struct lttng_event event;
6e911cad
MD
307 /* Length of following filter expression. */
308 uint32_t expression_len;
309 /* Length of following bytecode for filter. */
310 uint32_t bytecode_len;
311 /*
312 * After this structure, the following variable-length
313 * items are transmitted:
314 * - unsigned char filter_expression[expression_len]
315 * - unsigned char filter_bytecode[bytecode_len]
316 */
317 } LTTNG_PACKED disable;
f3ed775e
DG
318 /* Create channel */
319 struct {
7bd95aee 320 struct lttng_channel chan;
e9404c27 321 struct lttng_channel_extended extended;
fc5e05b7 322 } LTTNG_PACKED channel;
d65106b1
DG
323 /* Context */
324 struct {
db8870ed 325 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7bd95aee 326 struct lttng_event_context ctx;
2001793c
JG
327 uint32_t provider_name_len;
328 uint32_t context_name_len;
fc5e05b7 329 } LTTNG_PACKED context;
d9800920
DG
330 /* Use by register_consumer */
331 struct {
332 char path[PATH_MAX];
fc5e05b7 333 } LTTNG_PACKED reg;
9f19cc17
DG
334 /* List */
335 struct {
db8870ed 336 char channel_name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7 337 } LTTNG_PACKED list;
d0254c7c 338 struct lttng_calibrate calibrate;
a4b92340 339 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 340 struct {
a4b92340
DG
341 /* Number of lttng_uri following */
342 uint32_t size;
fc5e05b7 343 } LTTNG_PACKED uri;
da3c9ec1 344 struct {
7bd95aee 345 struct lttng_snapshot_output output;
da3c9ec1
DG
346 } LTTNG_PACKED snapshot_output;
347 struct {
348 uint32_t wait;
7bd95aee 349 struct lttng_snapshot_output output;
da3c9ec1 350 } LTTNG_PACKED snapshot_record;
ecc48a90
JD
351 struct {
352 uint32_t nb_uri;
353 unsigned int timer_interval; /* usec */
354 } LTTNG_PACKED session_live;
00c76cea 355 struct {
7bd95aee 356 struct lttng_save_session_attr attr;
00c76cea 357 } LTTNG_PACKED save_session;
d7ba1388
MD
358 struct {
359 char shm_path[PATH_MAX];
360 } LTTNG_PACKED set_shm_path;
ccf10263 361 struct {
159b042f
JG
362 /* enum lttng_process_attr */
363 int32_t process_attr;
364 /* enum lttng_process_attr_value_type */
365 int32_t value_type;
366
367 struct process_attr_integral_value_comm integral_value;
55c9e7ca 368 /*
159b042f
JG
369 * For user/group names, a variable length,
370 * zero-terminated, string of length 'name_len'
371 * (including the terminator) follows.
372 *
373 * integral_value should not be used in those cases.
55c9e7ca 374 */
159b042f
JG
375 uint32_t name_len;
376 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
55c9e7ca 377 struct {
159b042f
JG
378 /* enum lttng_process_attr */
379 int32_t process_attr;
380 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
381 struct {
382 /* enum lttng_process_attr */
383 int32_t process_attr;
384 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
385 struct {
386 /* enum lttng_process_attr */
387 int32_t process_attr;
388 /* enum lttng_tracking_policy */
389 int32_t tracking_policy;
390 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
e9404c27
JG
391 struct {
392 uint32_t length;
393 } LTTNG_PACKED trigger;
d88744a4 394 struct {
d68c9a04
JD
395 uint64_t rotation_id;
396 } LTTNG_PACKED get_rotation_info;
259c2674 397 struct {
66ea93b1
JG
398 /* enum lttng_rotation_schedule_type */
399 uint8_t type;
400 /*
401 * If set == 1, set schedule to value, if set == 0,
402 * clear this schedule type.
403 */
404 uint8_t set;
405 uint64_t value;
406 } LTTNG_PACKED rotation_set_schedule;
b178f53e
JG
407 struct {
408 /*
409 * Includes the null-terminator.
410 * Must be an absolute path.
411 *
412 * Size bounded by LTTNG_PATH_MAX.
413 */
414 uint16_t home_dir_size;
415 uint64_t session_descriptor_size;
416 /* An lttng_session_descriptor follows. */
417 } LTTNG_PACKED create_session;
fac6795d 418 } u;
99608320
JR
419 /* Count of fds sent. */
420 uint32_t fd_count;
fc5e05b7 421} LTTNG_PACKED;
fac6795d 422
d93c4f1f 423#define LTTNG_FILTER_MAX_LEN 65536
b178f53e 424#define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
53a80697
MD
425
426/*
427 * Filter bytecode data. The reloc table is located at the end of the
428 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
429 * starts at reloc_table_offset.
430 */
b6bbed5f 431#define LTTNG_FILTER_PADDING 32
53a80697 432struct lttng_filter_bytecode {
d93c4f1f
CB
433 uint32_t len; /* len of data */
434 uint32_t reloc_table_offset;
f3f0db50 435 uint64_t seqnum;
b6bbed5f 436 char padding[LTTNG_FILTER_PADDING];
53a80697 437 char data[0];
fc5e05b7 438} LTTNG_PACKED;
53a80697 439
579640f9
JI
440/*
441 * Event exclusion data. At the end of the structure, there will actually
442 * by zero or more names, where the actual number of names is given by
443 * the 'count' item of the structure.
444 */
445#define LTTNG_EVENT_EXCLUSION_PADDING 32
446struct lttng_event_exclusion {
447 uint32_t count;
448 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
caafa356 449 char names[0][LTTNG_SYMBOL_NAME_LEN];
579640f9
JI
450} LTTNG_PACKED;
451
d7af3565
PP
452#define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
453 (&(_exclusion)->names[_i][0])
454
b4e3ceb9
PP
455/*
456 * Event command header.
457 */
458struct lttcomm_event_command_header {
459 /* Number of events */
460 uint32_t nb_events;
461} LTTNG_PACKED;
462
463/*
464 * Event extended info header. This is the structure preceding each
465 * extended info data.
466 */
467struct lttcomm_event_extended_header {
468 /*
469 * Size of filter string immediately following this header.
470 * This size includes the terminal null character.
471 */
472 uint32_t filter_len;
795d57ce
PP
473
474 /*
475 * Number of exclusion names, immediately following the filter
476 * string. Each exclusion name has a fixed length of
477 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
478 * character.
479 */
480 uint32_t nb_exclusions;
56f0bc67
JG
481
482 /*
483 * Size of the event's userspace probe location (if applicable).
484 */
485 uint32_t userspace_probe_location_len;
b4e3ceb9
PP
486} LTTNG_PACKED;
487
3e3665b8
JG
488/*
489 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
490 */
491struct lttcomm_session_destroy_command_header {
492 /* enum lttng_session */
493 int32_t rotation_state;
494};
495
55c9e7ca
JR
496/*
497 * tracker command header.
498 */
499struct lttcomm_tracker_command_header {
500 uint32_t nb_tracker_id;
501} LTTNG_PACKED;
502
fac6795d 503/*
5e16da05 504 * Data structure for the response from sessiond to the lttng client.
fac6795d 505 */
5461b305 506struct lttcomm_lttng_msg {
d0b96690
DG
507 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
508 uint32_t ret_code; /* enum lttcomm_return_code */
509 uint32_t pid; /* pid_t */
795a978d 510 uint32_t cmd_header_size;
773168b7 511 uint32_t data_size;
e368fb43 512 uint32_t fd_count;
fc5e05b7 513} LTTNG_PACKED;
fac6795d 514
da3c9ec1
DG
515struct lttcomm_lttng_output_id {
516 uint32_t id;
517} LTTNG_PACKED;
518
6e3805e2 519/*
3bd1e081
MD
520 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
521 * to either add a channel, add a stream, update a stream, or stop
522 * operation.
6e3805e2 523 */
3bd1e081 524struct lttcomm_consumer_msg {
92816cc3 525 uint32_t cmd_type; /* enum lttng_consumer_command */
3bd1e081
MD
526 union {
527 struct {
d88aee68 528 uint64_t channel_key;
ffe60014 529 uint64_t session_id;
d2956687 530 /* ID of the session's current trace chunk. */
0a30bf9b 531 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
ffe60014 532 char pathname[PATH_MAX];
d88aee68 533 uint64_t relayd_id;
c30aaa51 534 /* nb_init_streams is the number of streams open initially. */
d88aee68 535 uint32_t nb_init_streams;
de5e9086 536 char name[LTTNG_SYMBOL_NAME_LEN];
ffe60014
DG
537 /* Use splice or mmap to consume this fd */
538 enum lttng_event_output output;
539 int type; /* Per cpu or metadata. */
1624d5b7
JD
540 uint64_t tracefile_size; /* bytes */
541 uint32_t tracefile_count; /* number of tracefiles */
2bba9e53
DG
542 /* If the channel's streams have to be monitored or not. */
543 uint32_t monitor;
ecc48a90
JD
544 /* timer to check the streams usage in live mode (usec). */
545 unsigned int live_timer_interval;
a2814ea7
JG
546 /* is part of a live session */
547 uint8_t is_live;
e9404c27
JG
548 /* timer to sample a channel's positions (usec). */
549 unsigned int monitor_timer_interval;
ffe60014 550 } LTTNG_PACKED channel; /* Only used by Kernel. */
3bd1e081 551 struct {
d88aee68
DG
552 uint64_t stream_key;
553 uint64_t channel_key;
554 int32_t cpu; /* On which CPU this stream is assigned. */
6dc3064a
DG
555 /* Tells the consumer if the stream should be or not monitored. */
556 uint32_t no_monitor;
ffe60014 557 } LTTNG_PACKED stream; /* Only used by Kernel. */
de5e9086 558 struct {
d88aee68 559 uint64_t net_index;
de5e9086
DG
560 enum lttng_stream_type type;
561 /* Open socket to the relayd */
6151a90f 562 struct lttcomm_relayd_sock sock;
46e6455f
DG
563 /* Tracing session id associated to the relayd. */
564 uint64_t session_id;
d3e2ba59
JD
565 /* Relayd session id, only used with control socket. */
566 uint64_t relayd_session_id;
fc5e05b7 567 } LTTNG_PACKED relayd_sock;
173af62f
DG
568 struct {
569 uint64_t net_seq_idx;
fc5e05b7 570 } LTTNG_PACKED destroy_relayd;
53632229
DG
571 struct {
572 uint64_t session_id;
fc5e05b7 573 } LTTNG_PACKED data_pending;
ffe60014 574 struct {
d0b96690
DG
575 uint64_t subbuf_size; /* bytes */
576 uint64_t num_subbuf; /* power of 2 */
d88aee68
DG
577 int32_t overwrite; /* 1: overwrite, 0: discard */
578 uint32_t switch_timer_interval; /* usec */
579 uint32_t read_timer_interval; /* usec */
e9404c27 580 unsigned int live_timer_interval; /* usec */
a2814ea7 581 uint8_t is_live; /* is part of a live session */
e9404c27 582 uint32_t monitor_timer_interval; /* usec */
d88aee68
DG
583 int32_t output; /* splice, mmap */
584 int32_t type; /* metadata or per_cpu */
d0b96690
DG
585 uint64_t session_id; /* Tracing session id */
586 char pathname[PATH_MAX]; /* Channel file path. */
ffe60014 587 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
d2956687
JG
588 /* Credentials used to open the UST buffer shared mappings. */
589 struct {
590 uint32_t uid;
591 uint32_t gid;
592 } LTTNG_PACKED buffer_credentials;
d88aee68
DG
593 uint64_t relayd_id; /* Relayd id if apply. */
594 uint64_t key; /* Unique channel key. */
d2956687 595 /* ID of the session's current trace chunk. */
0a30bf9b 596 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
c70636a7 597 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
7972aab2 598 uint32_t chan_id; /* Channel ID on the tracer side. */
1624d5b7
JD
599 uint64_t tracefile_size; /* bytes */
600 uint32_t tracefile_count; /* number of tracefiles */
1950109e 601 uint64_t session_id_per_pid; /* Per-pid session ID. */
2bba9e53
DG
602 /* Tells the consumer if the stream should be or not monitored. */
603 uint32_t monitor;
567eb353
DG
604 /*
605 * For UST per UID buffers, this is the application UID of the
606 * channel. This can be different from the user UID requesting the
607 * channel creation and used for the rights on the stream file
608 * because the application can be in the tracing for instance.
609 */
610 uint32_t ust_app_uid;
491d1539 611 int64_t blocking_timeout;
3d071855 612 char root_shm_path[PATH_MAX];
d7ba1388 613 char shm_path[PATH_MAX];
ffe60014
DG
614 } LTTNG_PACKED ask_channel;
615 struct {
d88aee68 616 uint64_t key;
ffe60014
DG
617 } LTTNG_PACKED get_channel;
618 struct {
d88aee68 619 uint64_t key;
ffe60014 620 } LTTNG_PACKED destroy_channel;
d88aee68
DG
621 struct {
622 uint64_t key; /* Metadata channel key. */
623 uint64_t target_offset; /* Offset in the consumer */
624 uint64_t len; /* Length of metadata to be received. */
93ec662e 625 uint64_t version; /* Version of the metadata. */
d88aee68
DG
626 } LTTNG_PACKED push_metadata;
627 struct {
628 uint64_t key; /* Metadata channel key. */
629 } LTTNG_PACKED close_metadata;
630 struct {
631 uint64_t key; /* Metadata channel key. */
632 } LTTNG_PACKED setup_metadata;
7972aab2
DG
633 struct {
634 uint64_t key; /* Channel key. */
635 } LTTNG_PACKED flush_channel;
0dd01979
MD
636 struct {
637 uint64_t key; /* Channel key. */
638 } LTTNG_PACKED clear_quiescent_channel;
6dc3064a
DG
639 struct {
640 char pathname[PATH_MAX];
641 /* Indicate if the snapshot goes on the relayd or locally. */
642 uint32_t use_relayd;
643 uint32_t metadata; /* This a metadata snapshot. */
644 uint64_t relayd_id; /* Relayd id if apply. */
645 uint64_t key;
d07ceecd 646 uint64_t nb_packets_per_stream;
6dc3064a 647 } LTTNG_PACKED snapshot_channel;
a4baae1b
JD
648 struct {
649 uint64_t channel_key;
650 uint64_t net_seq_idx;
651 } LTTNG_PACKED sent_streams;
fb83fe64
JD
652 struct {
653 uint64_t session_id;
654 uint64_t channel_key;
655 } LTTNG_PACKED discarded_events;
656 struct {
657 uint64_t session_id;
658 uint64_t channel_key;
659 } LTTNG_PACKED lost_packets;
93ec662e
JD
660 struct {
661 uint64_t session_id;
eded6438 662 } LTTNG_PACKED regenerate_metadata;
b99a8d42 663 struct {
b99a8d42
JD
664 uint32_t metadata; /* This is a metadata channel. */
665 uint64_t relayd_id; /* Relayd id if apply. */
666 uint64_t key;
b99a8d42 667 } LTTNG_PACKED rotate_channel;
92816cc3
JG
668 struct {
669 uint64_t session_id;
670 uint64_t chunk_id;
671 } LTTNG_PACKED check_rotation_pending_local;
d88744a4
JD
672 struct {
673 uint64_t relayd_id;
674 uint64_t session_id;
675 uint64_t chunk_id;
92816cc3 676 } LTTNG_PACKED check_rotation_pending_relay;
a1ae2ea5 677 struct {
d2956687
JG
678 /*
679 * Relayd id, if applicable (remote).
680 *
681 * A directory file descriptor referring to the chunk's
682 * output folder is transmitted if the chunk is local
683 * (relayd_id unset).
684 *
685 * `override_name` is left NULL (all-zeroes) if the
913a542b 686 * chunk's name is not overridden.
d2956687 687 */
0a30bf9b 688 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
d2956687
JG
689 char override_name[LTTNG_NAME_MAX];
690 uint64_t session_id;
691 uint64_t chunk_id;
692 uint64_t creation_timestamp;
e5add6d0 693 LTTNG_OPTIONAL_COMM(struct {
d2956687
JG
694 uint32_t uid;
695 uint32_t gid;
e5add6d0 696 } LTTNG_PACKED ) LTTNG_PACKED credentials;
d2956687
JG
697 } LTTNG_PACKED create_trace_chunk;
698 struct {
0a30bf9b 699 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
d2956687
JG
700 uint64_t session_id;
701 uint64_t chunk_id;
702 uint64_t close_timestamp;
bbc4768c
JG
703 /* enum lttng_trace_chunk_command_type */
704 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
d2956687
JG
705 } LTTNG_PACKED close_trace_chunk;
706 struct {
0a30bf9b 707 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
a1ae2ea5 708 uint64_t session_id;
d2956687
JG
709 uint64_t chunk_id;
710 } LTTNG_PACKED trace_chunk_exists;
711 struct {
712 lttng_uuid sessiond_uuid;
713 } LTTNG_PACKED init;
b01b201a
MD
714 struct {
715 uint64_t key;
716 } LTTNG_PACKED clear_channel;
04ed9e10
JG
717 struct {
718 uint64_t key;
719 } LTTNG_PACKED open_channel_packets;
3bd1e081 720 } u;
fc5e05b7 721} LTTNG_PACKED;
6e3805e2 722
e9404c27
JG
723/*
724 * Channel monitoring message returned to the session daemon on every
725 * monitor timer expiration.
726 */
727struct lttcomm_consumer_channel_monitor_msg {
728 /* Key of the sampled channel. */
729 uint64_t key;
730 /*
731 * Lowest and highest usage (bytes) at the moment the sample was taken.
732 */
733 uint64_t lowest, highest;
e8360425
JD
734 /*
735 * Sum of all the consumed positions for a channel.
736 */
737 uint64_t total_consumed;
e9404c27
JG
738} LTTNG_PACKED;
739
f50f23d9
DG
740/*
741 * Status message returned to the sessiond after a received command.
742 */
743struct lttcomm_consumer_status_msg {
0c759fc9 744 enum lttcomm_return_code ret_code;
fc5e05b7 745} LTTNG_PACKED;
f50f23d9 746
ffe60014 747struct lttcomm_consumer_status_channel {
0c759fc9 748 enum lttcomm_return_code ret_code;
d88aee68 749 uint64_t key;
ffe60014
DG
750 unsigned int stream_count;
751} LTTNG_PACKED;
752
ecd1a12f
MD
753struct lttcomm_consumer_close_trace_chunk_reply {
754 enum lttcomm_return_code ret_code;
755 uint32_t path_length;
756 char path[];
757};
758
51791532
JG
759#ifdef HAVE_LIBLTTNG_UST_CTL
760
9df8df5e 761#include <lttng/ust-abi.h>
6e3805e2 762
3817e7df
DG
763/*
764 * Data structure for the commands sent from sessiond to UST.
765 */
766struct lttcomm_ust_msg {
3817e7df
DG
767 uint32_t handle;
768 uint32_t cmd;
769 union {
3817e7df 770 struct lttng_ust_channel channel;
00a17c97 771 struct lttng_ust_stream stream;
3817e7df
DG
772 struct lttng_ust_event event;
773 struct lttng_ust_context context;
00a17c97 774 struct lttng_ust_tracer_version version;
3817e7df 775 } u;
fc5e05b7 776} LTTNG_PACKED;
3817e7df
DG
777
778/*
779 * Data structure for the response from UST to the session daemon.
780 * cmd_type is sent back in the reply for validation.
781 */
782struct lttcomm_ust_reply {
783 uint32_t handle;
784 uint32_t cmd;
785 uint32_t ret_code; /* enum lttcomm_return_code */
786 uint32_t ret_val; /* return value */
787 union {
2b0bf864
DG
788 struct {
789 uint64_t memory_map_size;
fc5e05b7 790 } LTTNG_PACKED channel;
2b0bf864
DG
791 struct {
792 uint64_t memory_map_size;
fc5e05b7 793 } LTTNG_PACKED stream;
00a17c97 794 struct lttng_ust_tracer_version version;
3817e7df 795 } u;
fc5e05b7 796} LTTNG_PACKED;
3817e7df 797
74d0b642 798#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 799
79445cf0 800LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
fac6795d 801
79445cf0 802LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
6364a07a 803 const char *ip, unsigned int port);
79445cf0 804LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
6364a07a
DG
805 const char *ip, unsigned int port);
806
79445cf0
JG
807LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
808LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
809LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
810LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
811LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
812LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
de5e9086 813 struct lttcomm_sock *src);
6364a07a 814
6151a90f 815/* Relayd socket object. */
79445cf0 816LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
6151a90f
JD
817 struct lttng_uri *uri, uint32_t major, uint32_t minor);
818
79445cf0
JG
819LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
820LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
783a3b9a 821
2288467f
JG
822LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
823 uint16_t *port);
824/*
825 * Set a port to an lttcomm_sock. This will have no effect is the socket is
826 * already bound.
827 */
828LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
829
79445cf0 830LTTNG_HIDDEN void lttcomm_init(void);
554831e7 831/* Get network timeout, in milliseconds */
79445cf0 832LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
554831e7 833
773168b7 834#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.176126 seconds and 4 git commands to generate.