sessiond-comm: add clear command support to consumer protocol
[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,
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. */
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
fac6795d 268/*
9bda164d 269 * Data structure received from lttng client to session daemon.
fac6795d
DG
270 */
271struct lttcomm_session_msg {
d0b96690 272 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 273 struct lttng_session session;
9f19cc17 274 struct lttng_domain domain;
fac6795d 275 union {
f3ed775e 276 /* Event data */
fac6795d 277 struct {
db8870ed 278 char channel_name[LTTNG_SYMBOL_NAME_LEN];
1179a48f 279 struct lttng_event event LTTNG_PACKED;
6b453b5e
JG
280 /* Length of following filter expression. */
281 uint32_t expression_len;
025faf73
DG
282 /* Length of following bytecode for filter. */
283 uint32_t bytecode_len;
15e37663 284 /* Exclusion count (fixed-size strings). */
a5516688 285 uint32_t exclusion_count;
15e37663
JG
286 /* Userspace probe location size. */
287 uint32_t userspace_probe_location_len;
a5516688
JI
288 /*
289 * After this structure, the following variable-length
290 * items are transmitted:
291 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
15e37663 292 * - char filter_expression[expression_len]
a5516688
JI
293 * - unsigned char filter_bytecode[bytecode_len]
294 */
fc5e05b7 295 } LTTNG_PACKED enable;
6e911cad
MD
296 struct {
297 char channel_name[LTTNG_SYMBOL_NAME_LEN];
298 struct lttng_event event LTTNG_PACKED;
299 /* Length of following filter expression. */
300 uint32_t expression_len;
301 /* Length of following bytecode for filter. */
302 uint32_t bytecode_len;
303 /*
304 * After this structure, the following variable-length
305 * items are transmitted:
306 * - unsigned char filter_expression[expression_len]
307 * - unsigned char filter_bytecode[bytecode_len]
308 */
309 } LTTNG_PACKED disable;
f3ed775e
DG
310 /* Create channel */
311 struct {
1179a48f 312 struct lttng_channel chan LTTNG_PACKED;
e9404c27
JG
313 /* struct lttng_channel_extended is already packed. */
314 struct lttng_channel_extended extended;
fc5e05b7 315 } LTTNG_PACKED channel;
d65106b1
DG
316 /* Context */
317 struct {
db8870ed 318 char channel_name[LTTNG_SYMBOL_NAME_LEN];
1179a48f 319 struct lttng_event_context ctx LTTNG_PACKED;
2001793c
JG
320 uint32_t provider_name_len;
321 uint32_t context_name_len;
fc5e05b7 322 } LTTNG_PACKED context;
d9800920
DG
323 /* Use by register_consumer */
324 struct {
325 char path[PATH_MAX];
fc5e05b7 326 } LTTNG_PACKED reg;
9f19cc17
DG
327 /* List */
328 struct {
db8870ed 329 char channel_name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7 330 } LTTNG_PACKED list;
d0254c7c 331 struct lttng_calibrate calibrate;
a4b92340 332 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 333 struct {
a4b92340
DG
334 /* Number of lttng_uri following */
335 uint32_t size;
fc5e05b7 336 } LTTNG_PACKED uri;
da3c9ec1 337 struct {
1179a48f 338 struct lttng_snapshot_output output LTTNG_PACKED;
da3c9ec1
DG
339 } LTTNG_PACKED snapshot_output;
340 struct {
341 uint32_t wait;
1179a48f 342 struct lttng_snapshot_output output LTTNG_PACKED;
da3c9ec1 343 } LTTNG_PACKED snapshot_record;
ecc48a90
JD
344 struct {
345 uint32_t nb_uri;
346 unsigned int timer_interval; /* usec */
347 } LTTNG_PACKED session_live;
00c76cea 348 struct {
1179a48f 349 struct lttng_save_session_attr attr; /* struct already packed */
00c76cea 350 } LTTNG_PACKED save_session;
d7ba1388
MD
351 struct {
352 char shm_path[PATH_MAX];
353 } LTTNG_PACKED set_shm_path;
ccf10263
MD
354 struct {
355 uint32_t pid;
356 } LTTNG_PACKED pid_tracker;
e9404c27
JG
357 struct {
358 uint32_t length;
359 } LTTNG_PACKED trigger;
d88744a4 360 struct {
d68c9a04
JD
361 uint64_t rotation_id;
362 } LTTNG_PACKED get_rotation_info;
259c2674 363 struct {
66ea93b1
JG
364 /* enum lttng_rotation_schedule_type */
365 uint8_t type;
366 /*
367 * If set == 1, set schedule to value, if set == 0,
368 * clear this schedule type.
369 */
370 uint8_t set;
371 uint64_t value;
372 } LTTNG_PACKED rotation_set_schedule;
b178f53e
JG
373 struct {
374 /*
375 * Includes the null-terminator.
376 * Must be an absolute path.
377 *
378 * Size bounded by LTTNG_PATH_MAX.
379 */
380 uint16_t home_dir_size;
381 uint64_t session_descriptor_size;
382 /* An lttng_session_descriptor follows. */
383 } LTTNG_PACKED create_session;
fac6795d 384 } u;
fc5e05b7 385} LTTNG_PACKED;
fac6795d 386
d93c4f1f 387#define LTTNG_FILTER_MAX_LEN 65536
b178f53e 388#define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
53a80697
MD
389
390/*
391 * Filter bytecode data. The reloc table is located at the end of the
392 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
393 * starts at reloc_table_offset.
394 */
b6bbed5f 395#define LTTNG_FILTER_PADDING 32
53a80697 396struct lttng_filter_bytecode {
d93c4f1f
CB
397 uint32_t len; /* len of data */
398 uint32_t reloc_table_offset;
f3f0db50 399 uint64_t seqnum;
b6bbed5f 400 char padding[LTTNG_FILTER_PADDING];
53a80697 401 char data[0];
fc5e05b7 402} LTTNG_PACKED;
53a80697 403
579640f9
JI
404/*
405 * Event exclusion data. At the end of the structure, there will actually
406 * by zero or more names, where the actual number of names is given by
407 * the 'count' item of the structure.
408 */
409#define LTTNG_EVENT_EXCLUSION_PADDING 32
410struct lttng_event_exclusion {
411 uint32_t count;
412 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
caafa356 413 char names[0][LTTNG_SYMBOL_NAME_LEN];
579640f9
JI
414} LTTNG_PACKED;
415
d7af3565
PP
416#define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
417 (&(_exclusion)->names[_i][0])
418
b4e3ceb9
PP
419/*
420 * Event command header.
421 */
422struct lttcomm_event_command_header {
423 /* Number of events */
424 uint32_t nb_events;
425} LTTNG_PACKED;
426
427/*
428 * Event extended info header. This is the structure preceding each
429 * extended info data.
430 */
431struct lttcomm_event_extended_header {
432 /*
433 * Size of filter string immediately following this header.
434 * This size includes the terminal null character.
435 */
436 uint32_t filter_len;
795d57ce
PP
437
438 /*
439 * Number of exclusion names, immediately following the filter
440 * string. Each exclusion name has a fixed length of
441 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
442 * character.
443 */
444 uint32_t nb_exclusions;
56f0bc67
JG
445
446 /*
447 * Size of the event's userspace probe location (if applicable).
448 */
449 uint32_t userspace_probe_location_len;
b4e3ceb9
PP
450} LTTNG_PACKED;
451
3e3665b8
JG
452/*
453 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
454 */
455struct lttcomm_session_destroy_command_header {
456 /* enum lttng_session */
457 int32_t rotation_state;
458};
459
fac6795d 460/*
5e16da05 461 * Data structure for the response from sessiond to the lttng client.
fac6795d 462 */
5461b305 463struct lttcomm_lttng_msg {
d0b96690
DG
464 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
465 uint32_t ret_code; /* enum lttcomm_return_code */
466 uint32_t pid; /* pid_t */
795a978d 467 uint32_t cmd_header_size;
773168b7 468 uint32_t data_size;
fc5e05b7 469} LTTNG_PACKED;
fac6795d 470
da3c9ec1
DG
471struct lttcomm_lttng_output_id {
472 uint32_t id;
473} LTTNG_PACKED;
474
6e3805e2 475/*
3bd1e081
MD
476 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
477 * to either add a channel, add a stream, update a stream, or stop
478 * operation.
6e3805e2 479 */
3bd1e081 480struct lttcomm_consumer_msg {
92816cc3 481 uint32_t cmd_type; /* enum lttng_consumer_command */
3bd1e081
MD
482 union {
483 struct {
d88aee68 484 uint64_t channel_key;
ffe60014 485 uint64_t session_id;
d2956687 486 /* ID of the session's current trace chunk. */
0a30bf9b 487 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
ffe60014 488 char pathname[PATH_MAX];
d88aee68 489 uint64_t relayd_id;
c30aaa51 490 /* nb_init_streams is the number of streams open initially. */
d88aee68 491 uint32_t nb_init_streams;
de5e9086 492 char name[LTTNG_SYMBOL_NAME_LEN];
ffe60014
DG
493 /* Use splice or mmap to consume this fd */
494 enum lttng_event_output output;
495 int type; /* Per cpu or metadata. */
1624d5b7
JD
496 uint64_t tracefile_size; /* bytes */
497 uint32_t tracefile_count; /* number of tracefiles */
2bba9e53
DG
498 /* If the channel's streams have to be monitored or not. */
499 uint32_t monitor;
ecc48a90
JD
500 /* timer to check the streams usage in live mode (usec). */
501 unsigned int live_timer_interval;
e9404c27
JG
502 /* timer to sample a channel's positions (usec). */
503 unsigned int monitor_timer_interval;
ffe60014 504 } LTTNG_PACKED channel; /* Only used by Kernel. */
3bd1e081 505 struct {
d88aee68
DG
506 uint64_t stream_key;
507 uint64_t channel_key;
508 int32_t cpu; /* On which CPU this stream is assigned. */
6dc3064a
DG
509 /* Tells the consumer if the stream should be or not monitored. */
510 uint32_t no_monitor;
ffe60014 511 } LTTNG_PACKED stream; /* Only used by Kernel. */
de5e9086 512 struct {
d88aee68 513 uint64_t net_index;
de5e9086
DG
514 enum lttng_stream_type type;
515 /* Open socket to the relayd */
6151a90f 516 struct lttcomm_relayd_sock sock;
46e6455f
DG
517 /* Tracing session id associated to the relayd. */
518 uint64_t session_id;
d3e2ba59
JD
519 /* Relayd session id, only used with control socket. */
520 uint64_t relayd_session_id;
fc5e05b7 521 } LTTNG_PACKED relayd_sock;
173af62f
DG
522 struct {
523 uint64_t net_seq_idx;
fc5e05b7 524 } LTTNG_PACKED destroy_relayd;
53632229
DG
525 struct {
526 uint64_t session_id;
fc5e05b7 527 } LTTNG_PACKED data_pending;
ffe60014 528 struct {
d0b96690
DG
529 uint64_t subbuf_size; /* bytes */
530 uint64_t num_subbuf; /* power of 2 */
d88aee68
DG
531 int32_t overwrite; /* 1: overwrite, 0: discard */
532 uint32_t switch_timer_interval; /* usec */
533 uint32_t read_timer_interval; /* usec */
e9404c27
JG
534 unsigned int live_timer_interval; /* usec */
535 uint32_t monitor_timer_interval; /* usec */
d88aee68
DG
536 int32_t output; /* splice, mmap */
537 int32_t type; /* metadata or per_cpu */
d0b96690
DG
538 uint64_t session_id; /* Tracing session id */
539 char pathname[PATH_MAX]; /* Channel file path. */
ffe60014 540 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
d2956687
JG
541 /* Credentials used to open the UST buffer shared mappings. */
542 struct {
543 uint32_t uid;
544 uint32_t gid;
545 } LTTNG_PACKED buffer_credentials;
d88aee68
DG
546 uint64_t relayd_id; /* Relayd id if apply. */
547 uint64_t key; /* Unique channel key. */
d2956687 548 /* ID of the session's current trace chunk. */
0a30bf9b 549 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
c70636a7 550 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
7972aab2 551 uint32_t chan_id; /* Channel ID on the tracer side. */
1624d5b7
JD
552 uint64_t tracefile_size; /* bytes */
553 uint32_t tracefile_count; /* number of tracefiles */
1950109e 554 uint64_t session_id_per_pid; /* Per-pid session ID. */
2bba9e53
DG
555 /* Tells the consumer if the stream should be or not monitored. */
556 uint32_t monitor;
567eb353
DG
557 /*
558 * For UST per UID buffers, this is the application UID of the
559 * channel. This can be different from the user UID requesting the
560 * channel creation and used for the rights on the stream file
561 * because the application can be in the tracing for instance.
562 */
563 uint32_t ust_app_uid;
491d1539 564 int64_t blocking_timeout;
3d071855 565 char root_shm_path[PATH_MAX];
d7ba1388 566 char shm_path[PATH_MAX];
ffe60014
DG
567 } LTTNG_PACKED ask_channel;
568 struct {
d88aee68 569 uint64_t key;
ffe60014
DG
570 } LTTNG_PACKED get_channel;
571 struct {
d88aee68 572 uint64_t key;
ffe60014 573 } LTTNG_PACKED destroy_channel;
d88aee68
DG
574 struct {
575 uint64_t key; /* Metadata channel key. */
576 uint64_t target_offset; /* Offset in the consumer */
577 uint64_t len; /* Length of metadata to be received. */
93ec662e 578 uint64_t version; /* Version of the metadata. */
d88aee68
DG
579 } LTTNG_PACKED push_metadata;
580 struct {
581 uint64_t key; /* Metadata channel key. */
582 } LTTNG_PACKED close_metadata;
583 struct {
584 uint64_t key; /* Metadata channel key. */
585 } LTTNG_PACKED setup_metadata;
7972aab2
DG
586 struct {
587 uint64_t key; /* Channel key. */
588 } LTTNG_PACKED flush_channel;
0dd01979
MD
589 struct {
590 uint64_t key; /* Channel key. */
591 } LTTNG_PACKED clear_quiescent_channel;
6dc3064a
DG
592 struct {
593 char pathname[PATH_MAX];
594 /* Indicate if the snapshot goes on the relayd or locally. */
595 uint32_t use_relayd;
596 uint32_t metadata; /* This a metadata snapshot. */
597 uint64_t relayd_id; /* Relayd id if apply. */
598 uint64_t key;
d07ceecd 599 uint64_t nb_packets_per_stream;
6dc3064a 600 } LTTNG_PACKED snapshot_channel;
a4baae1b
JD
601 struct {
602 uint64_t channel_key;
603 uint64_t net_seq_idx;
604 } LTTNG_PACKED sent_streams;
fb83fe64
JD
605 struct {
606 uint64_t session_id;
607 uint64_t channel_key;
608 } LTTNG_PACKED discarded_events;
609 struct {
610 uint64_t session_id;
611 uint64_t channel_key;
612 } LTTNG_PACKED lost_packets;
93ec662e
JD
613 struct {
614 uint64_t session_id;
eded6438 615 } LTTNG_PACKED regenerate_metadata;
b99a8d42 616 struct {
b99a8d42
JD
617 uint32_t metadata; /* This is a metadata channel. */
618 uint64_t relayd_id; /* Relayd id if apply. */
619 uint64_t key;
b99a8d42 620 } LTTNG_PACKED rotate_channel;
92816cc3
JG
621 struct {
622 uint64_t session_id;
623 uint64_t chunk_id;
624 } LTTNG_PACKED check_rotation_pending_local;
d88744a4
JD
625 struct {
626 uint64_t relayd_id;
627 uint64_t session_id;
628 uint64_t chunk_id;
92816cc3 629 } LTTNG_PACKED check_rotation_pending_relay;
a1ae2ea5 630 struct {
d2956687
JG
631 /*
632 * Relayd id, if applicable (remote).
633 *
634 * A directory file descriptor referring to the chunk's
635 * output folder is transmitted if the chunk is local
636 * (relayd_id unset).
637 *
638 * `override_name` is left NULL (all-zeroes) if the
913a542b 639 * chunk's name is not overridden.
d2956687 640 */
0a30bf9b 641 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
d2956687
JG
642 char override_name[LTTNG_NAME_MAX];
643 uint64_t session_id;
644 uint64_t chunk_id;
645 uint64_t creation_timestamp;
e5add6d0 646 LTTNG_OPTIONAL_COMM(struct {
d2956687
JG
647 uint32_t uid;
648 uint32_t gid;
e5add6d0 649 } LTTNG_PACKED ) LTTNG_PACKED credentials;
d2956687
JG
650 } LTTNG_PACKED create_trace_chunk;
651 struct {
0a30bf9b 652 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
d2956687
JG
653 uint64_t session_id;
654 uint64_t chunk_id;
655 uint64_t close_timestamp;
bbc4768c
JG
656 /* enum lttng_trace_chunk_command_type */
657 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
d2956687
JG
658 } LTTNG_PACKED close_trace_chunk;
659 struct {
0a30bf9b 660 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
a1ae2ea5 661 uint64_t session_id;
d2956687
JG
662 uint64_t chunk_id;
663 } LTTNG_PACKED trace_chunk_exists;
664 struct {
665 lttng_uuid sessiond_uuid;
666 } LTTNG_PACKED init;
b01b201a
MD
667 struct {
668 uint64_t key;
669 } LTTNG_PACKED clear_channel;
3bd1e081 670 } u;
fc5e05b7 671} LTTNG_PACKED;
6e3805e2 672
e9404c27
JG
673/*
674 * Channel monitoring message returned to the session daemon on every
675 * monitor timer expiration.
676 */
677struct lttcomm_consumer_channel_monitor_msg {
678 /* Key of the sampled channel. */
679 uint64_t key;
680 /*
681 * Lowest and highest usage (bytes) at the moment the sample was taken.
682 */
683 uint64_t lowest, highest;
e8360425
JD
684 /*
685 * Sum of all the consumed positions for a channel.
686 */
687 uint64_t total_consumed;
e9404c27
JG
688} LTTNG_PACKED;
689
f50f23d9
DG
690/*
691 * Status message returned to the sessiond after a received command.
692 */
693struct lttcomm_consumer_status_msg {
0c759fc9 694 enum lttcomm_return_code ret_code;
fc5e05b7 695} LTTNG_PACKED;
f50f23d9 696
ffe60014 697struct lttcomm_consumer_status_channel {
0c759fc9 698 enum lttcomm_return_code ret_code;
d88aee68 699 uint64_t key;
ffe60014
DG
700 unsigned int stream_count;
701} LTTNG_PACKED;
702
ecd1a12f
MD
703struct lttcomm_consumer_close_trace_chunk_reply {
704 enum lttcomm_return_code ret_code;
705 uint32_t path_length;
706 char path[];
707};
708
51791532
JG
709#ifdef HAVE_LIBLTTNG_UST_CTL
710
9df8df5e 711#include <lttng/ust-abi.h>
6e3805e2 712
3817e7df
DG
713/*
714 * Data structure for the commands sent from sessiond to UST.
715 */
716struct lttcomm_ust_msg {
3817e7df
DG
717 uint32_t handle;
718 uint32_t cmd;
719 union {
3817e7df 720 struct lttng_ust_channel channel;
00a17c97 721 struct lttng_ust_stream stream;
3817e7df
DG
722 struct lttng_ust_event event;
723 struct lttng_ust_context context;
00a17c97 724 struct lttng_ust_tracer_version version;
3817e7df 725 } u;
fc5e05b7 726} LTTNG_PACKED;
3817e7df
DG
727
728/*
729 * Data structure for the response from UST to the session daemon.
730 * cmd_type is sent back in the reply for validation.
731 */
732struct lttcomm_ust_reply {
733 uint32_t handle;
734 uint32_t cmd;
735 uint32_t ret_code; /* enum lttcomm_return_code */
736 uint32_t ret_val; /* return value */
737 union {
2b0bf864
DG
738 struct {
739 uint64_t memory_map_size;
fc5e05b7 740 } LTTNG_PACKED channel;
2b0bf864
DG
741 struct {
742 uint64_t memory_map_size;
fc5e05b7 743 } LTTNG_PACKED stream;
00a17c97 744 struct lttng_ust_tracer_version version;
3817e7df 745 } u;
fc5e05b7 746} LTTNG_PACKED;
3817e7df 747
74d0b642 748#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 749
79445cf0 750LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
fac6795d 751
79445cf0 752LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
6364a07a 753 const char *ip, unsigned int port);
79445cf0 754LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
6364a07a
DG
755 const char *ip, unsigned int port);
756
79445cf0
JG
757LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
758LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
759LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
760LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
761LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
762LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
de5e9086 763 struct lttcomm_sock *src);
6364a07a 764
6151a90f 765/* Relayd socket object. */
79445cf0 766LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
6151a90f
JD
767 struct lttng_uri *uri, uint32_t major, uint32_t minor);
768
79445cf0
JG
769LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
770LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
783a3b9a 771
2288467f
JG
772LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
773 uint16_t *port);
774/*
775 * Set a port to an lttcomm_sock. This will have no effect is the socket is
776 * already bound.
777 */
778LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
779
79445cf0 780LTTNG_HIDDEN void lttcomm_init(void);
554831e7 781/* Get network timeout, in milliseconds */
79445cf0 782LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
554831e7 783
773168b7 784#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.164171 seconds and 4 git commands to generate.