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