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