Implement the RELAYD_ROTATE_STREAM relay daemon 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>
b17231c6 34#include <common/compat/socket.h>
a4b92340 35#include <common/uri.h>
ce2a9e76 36#include <common/defaults.h>
ffe60014 37#include <common/compat/uuid.h>
5e16da05 38
6364a07a
DG
39#include <arpa/inet.h>
40#include <netinet/in.h>
41#include <sys/un.h>
42
43#include "inet.h"
44#include "inet6.h"
2038dd6c 45#include <common/unix.h>
0d37f2bc 46
fac6795d 47/* Queue size of listen(2) */
f158a754 48#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 49
990570ed
DG
50/* Maximum number of FDs that can be sent over a Unix socket */
51#define LTTCOMM_MAX_SEND_FDS 4
52
3817e7df
DG
53/*
54 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 55 */
f73fabfd 56#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
fac6795d 57
6abb15de 58enum lttcomm_sessiond_command {
0d0c377a 59 /* Tracer command */
7c9534d6 60 LTTNG_ADD_CONTEXT = 0,
b812e5ca 61 /* LTTNG_CALIBRATE used to be here */
7c9534d6
JD
62 LTTNG_DISABLE_CHANNEL = 2,
63 LTTNG_DISABLE_EVENT = 3,
834978fd 64 LTTNG_LIST_SYSCALLS = 4,
7c9534d6
JD
65 LTTNG_ENABLE_CHANNEL = 5,
66 LTTNG_ENABLE_EVENT = 6,
18a720cd 67 /* 7 */
0d0c377a 68 /* Session daemon command */
7c9534d6
JD
69 LTTNG_CREATE_SESSION = 8,
70 LTTNG_DESTROY_SESSION = 9,
71 LTTNG_LIST_CHANNELS = 10,
72 LTTNG_LIST_DOMAINS = 11,
73 LTTNG_LIST_EVENTS = 12,
74 LTTNG_LIST_SESSIONS = 13,
75 LTTNG_LIST_TRACEPOINTS = 14,
76 LTTNG_REGISTER_CONSUMER = 15,
77 LTTNG_START_TRACE = 16,
78 LTTNG_STOP_TRACE = 17,
79 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
53a80697 80
de5e9086 81 /* Consumer */
7c9534d6
JD
82 LTTNG_DISABLE_CONSUMER = 19,
83 LTTNG_ENABLE_CONSUMER = 20,
84 LTTNG_SET_CONSUMER_URI = 21,
67676bd8
DG
85 /* 22 */
86 /* 23 */
7c9534d6 87 LTTNG_DATA_PENDING = 24,
da3c9ec1
DG
88 LTTNG_SNAPSHOT_ADD_OUTPUT = 25,
89 LTTNG_SNAPSHOT_DEL_OUTPUT = 26,
90 LTTNG_SNAPSHOT_LIST_OUTPUT = 27,
91 LTTNG_SNAPSHOT_RECORD = 28,
27babd3a 92 LTTNG_CREATE_SESSION_SNAPSHOT = 29,
ecc48a90 93 LTTNG_CREATE_SESSION_LIVE = 30,
00c76cea 94 LTTNG_SAVE_SESSION = 31,
ccf10263
MD
95 LTTNG_TRACK_PID = 32,
96 LTTNG_UNTRACK_PID = 33,
a5dfbb9d 97 LTTNG_LIST_TRACKER_PIDS = 34,
d7ba1388 98 LTTNG_SET_SESSION_SHM_PATH = 40,
eded6438 99 LTTNG_REGENERATE_METADATA = 41,
c2561365 100 LTTNG_REGENERATE_STATEDUMP = 42,
e9404c27
JG
101 LTTNG_REGISTER_TRIGGER = 43,
102 LTTNG_UNREGISTER_TRIGGER = 44,
7c9534d6
JD
103};
104
105enum lttcomm_relayd_command {
106 RELAYD_ADD_STREAM = 1,
107 RELAYD_CREATE_SESSION = 2,
108 RELAYD_START_DATA = 3,
109 RELAYD_UPDATE_SYNC_INFO = 4,
110 RELAYD_VERSION = 5,
111 RELAYD_SEND_METADATA = 6,
112 RELAYD_CLOSE_STREAM = 7,
113 RELAYD_DATA_PENDING = 8,
114 RELAYD_QUIESCENT_CONTROL = 9,
115 RELAYD_BEGIN_DATA_PENDING = 10,
116 RELAYD_END_DATA_PENDING = 11,
1c20f0e2
JD
117 RELAYD_ADD_INDEX = 12,
118 RELAYD_SEND_INDEX = 13,
119 RELAYD_CLOSE_INDEX = 14,
a4baae1b 120 /* Live-reading commands (2.4+). */
d3e2ba59 121 RELAYD_LIST_SESSIONS = 15,
a4baae1b
JD
122 /* All streams of the channel have been sent to the relayd (2.4+). */
123 RELAYD_STREAMS_SENT = 16,
93ec662e
JD
124 /* Ask the relay to reset the metadata trace file (2.8+) */
125 RELAYD_RESET_METADATA = 17,
d3ecc550
JD
126 /* Ask the relay to rotate a stream file (2.11+) */
127 RELAYD_ROTATE_STREAM = 18,
00fb02ac
JD
128 /* Rename a chunk after the rotation is completed (2.11+) */
129 RELAYD_ROTATE_RENAME = 19,
a1ae2ea5
JD
130 /* Create a folder on the relayd FS (2.11+) */
131 RELAYD_MKDIR = 21,
fac6795d
DG
132};
133
134/*
135 * lttcomm error code.
136 */
137enum lttcomm_return_code {
0c759fc9 138 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
f73fabfd
DG
139 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
140 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
141 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
142 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
143 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
144 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
145 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
146 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
147 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
148 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
149 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
150 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
151 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
152 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
ffe60014 153 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
d88aee68
DG
154 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
155 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
618a6a28 156 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
0c759fc9 157 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
e462382a 158 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
e9404c27 159 LTTCOMM_CONSUMERD_ALREADY_SET, /* Resource already set. */
80e327fa 160
20fe2104
DG
161 /* MUST be last element */
162 LTTCOMM_NR, /* Last element */
fac6795d
DG
163};
164
de5e9086
DG
165/* lttng socket protocol. */
166enum lttcomm_sock_proto {
167 LTTCOMM_SOCK_UDP,
168 LTTCOMM_SOCK_TCP,
169};
170
171/*
172 * Index in the net_families array below. Please keep in sync!
173 */
174enum lttcomm_sock_domain {
01d0a631
CB
175 LTTCOMM_INET = 0,
176 LTTCOMM_INET6 = 1,
de5e9086
DG
177};
178
331744e3
JD
179enum lttcomm_metadata_command {
180 LTTCOMM_METADATA_REQUEST = 1,
181};
182
183/*
184 * Commands sent from the consumerd to the sessiond to request if new metadata
185 * is available. This message is used to find the per UID _or_ per PID registry
186 * for the channel key. For per UID lookup, the triplet
187 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
188 * per PID registry indexed by session id ignoring the other values.
189 */
190struct lttcomm_metadata_request_msg {
1950109e
JD
191 uint64_t session_id; /* Tracing session id */
192 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
331744e3
JD
193 uint32_t bits_per_long; /* Consumer ABI */
194 uint32_t uid;
195 uint64_t key; /* Metadata channel key. */
196} LTTNG_PACKED;
197
de5e9086
DG
198struct lttcomm_sockaddr {
199 enum lttcomm_sock_domain type;
200 union {
201 struct sockaddr_in sin;
202 struct sockaddr_in6 sin6;
203 } addr;
fc5e05b7 204} LTTNG_PACKED;
de5e9086
DG
205
206struct lttcomm_sock {
d88aee68 207 int32_t fd;
de5e9086
DG
208 enum lttcomm_sock_proto proto;
209 struct lttcomm_sockaddr sockaddr;
210 const struct lttcomm_proto_ops *ops;
fc5e05b7 211} LTTNG_PACKED;
de5e9086 212
6151a90f
JD
213/*
214 * Relayd sock. Adds the protocol version to use for the communications with
215 * the relayd.
216 */
217struct lttcomm_relayd_sock {
218 struct lttcomm_sock sock;
219 uint32_t major;
220 uint32_t minor;
221} LTTNG_PACKED;
222
de5e9086
DG
223struct lttcomm_net_family {
224 int family;
225 int (*create) (struct lttcomm_sock *sock, int type, int proto);
226};
227
228struct lttcomm_proto_ops {
229 int (*bind) (struct lttcomm_sock *sock);
230 int (*close) (struct lttcomm_sock *sock);
231 int (*connect) (struct lttcomm_sock *sock);
232 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
233 int (*listen) (struct lttcomm_sock *sock, int backlog);
234 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
235 int flags);
c2d69327
JG
236 ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
237 size_t len, int flags);
de5e9086
DG
238};
239
fac6795d 240/*
9bda164d 241 * Data structure received from lttng client to session daemon.
fac6795d
DG
242 */
243struct lttcomm_session_msg {
d0b96690 244 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 245 struct lttng_session session;
9f19cc17 246 struct lttng_domain domain;
fac6795d 247 union {
f3ed775e 248 /* Event data */
fac6795d 249 struct {
db8870ed 250 char channel_name[LTTNG_SYMBOL_NAME_LEN];
1179a48f 251 struct lttng_event event LTTNG_PACKED;
6b453b5e
JG
252 /* Length of following filter expression. */
253 uint32_t expression_len;
025faf73
DG
254 /* Length of following bytecode for filter. */
255 uint32_t bytecode_len;
a5516688
JI
256 /* exclusion data */
257 uint32_t exclusion_count;
258 /*
259 * After this structure, the following variable-length
260 * items are transmitted:
261 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
6b453b5e 262 * - unsigned char filter_expression[expression_len]
a5516688
JI
263 * - unsigned char filter_bytecode[bytecode_len]
264 */
fc5e05b7 265 } LTTNG_PACKED enable;
6e911cad
MD
266 struct {
267 char channel_name[LTTNG_SYMBOL_NAME_LEN];
268 struct lttng_event event LTTNG_PACKED;
269 /* Length of following filter expression. */
270 uint32_t expression_len;
271 /* Length of following bytecode for filter. */
272 uint32_t bytecode_len;
273 /*
274 * After this structure, the following variable-length
275 * items are transmitted:
276 * - unsigned char filter_expression[expression_len]
277 * - unsigned char filter_bytecode[bytecode_len]
278 */
279 } LTTNG_PACKED disable;
f3ed775e
DG
280 /* Create channel */
281 struct {
1179a48f 282 struct lttng_channel chan LTTNG_PACKED;
e9404c27
JG
283 /* struct lttng_channel_extended is already packed. */
284 struct lttng_channel_extended extended;
fc5e05b7 285 } LTTNG_PACKED channel;
d65106b1
DG
286 /* Context */
287 struct {
db8870ed 288 char channel_name[LTTNG_SYMBOL_NAME_LEN];
1179a48f 289 struct lttng_event_context ctx LTTNG_PACKED;
2001793c
JG
290 uint32_t provider_name_len;
291 uint32_t context_name_len;
fc5e05b7 292 } LTTNG_PACKED context;
d9800920
DG
293 /* Use by register_consumer */
294 struct {
295 char path[PATH_MAX];
fc5e05b7 296 } LTTNG_PACKED reg;
9f19cc17
DG
297 /* List */
298 struct {
db8870ed 299 char channel_name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7 300 } LTTNG_PACKED list;
d0254c7c 301 struct lttng_calibrate calibrate;
a4b92340 302 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 303 struct {
a4b92340
DG
304 /* Number of lttng_uri following */
305 uint32_t size;
fc5e05b7 306 } LTTNG_PACKED uri;
da3c9ec1 307 struct {
1179a48f 308 struct lttng_snapshot_output output LTTNG_PACKED;
da3c9ec1
DG
309 } LTTNG_PACKED snapshot_output;
310 struct {
311 uint32_t wait;
1179a48f 312 struct lttng_snapshot_output output LTTNG_PACKED;
da3c9ec1 313 } LTTNG_PACKED snapshot_record;
ecc48a90
JD
314 struct {
315 uint32_t nb_uri;
316 unsigned int timer_interval; /* usec */
317 } LTTNG_PACKED session_live;
00c76cea 318 struct {
1179a48f 319 struct lttng_save_session_attr attr; /* struct already packed */
00c76cea 320 } LTTNG_PACKED save_session;
d7ba1388
MD
321 struct {
322 char shm_path[PATH_MAX];
323 } LTTNG_PACKED set_shm_path;
ccf10263
MD
324 struct {
325 uint32_t pid;
326 } LTTNG_PACKED pid_tracker;
e9404c27
JG
327 struct {
328 uint32_t length;
329 } LTTNG_PACKED trigger;
fac6795d 330 } u;
fc5e05b7 331} LTTNG_PACKED;
fac6795d 332
d93c4f1f 333#define LTTNG_FILTER_MAX_LEN 65536
53a80697
MD
334
335/*
336 * Filter bytecode data. The reloc table is located at the end of the
337 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
338 * starts at reloc_table_offset.
339 */
b6bbed5f 340#define LTTNG_FILTER_PADDING 32
53a80697 341struct lttng_filter_bytecode {
d93c4f1f
CB
342 uint32_t len; /* len of data */
343 uint32_t reloc_table_offset;
f3f0db50 344 uint64_t seqnum;
b6bbed5f 345 char padding[LTTNG_FILTER_PADDING];
53a80697 346 char data[0];
fc5e05b7 347} LTTNG_PACKED;
53a80697 348
579640f9
JI
349/*
350 * Event exclusion data. At the end of the structure, there will actually
351 * by zero or more names, where the actual number of names is given by
352 * the 'count' item of the structure.
353 */
354#define LTTNG_EVENT_EXCLUSION_PADDING 32
355struct lttng_event_exclusion {
356 uint32_t count;
357 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
caafa356 358 char names[0][LTTNG_SYMBOL_NAME_LEN];
579640f9
JI
359} LTTNG_PACKED;
360
d7af3565
PP
361#define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
362 (&(_exclusion)->names[_i][0])
363
b4e3ceb9
PP
364/*
365 * Event command header.
366 */
367struct lttcomm_event_command_header {
368 /* Number of events */
369 uint32_t nb_events;
370} LTTNG_PACKED;
371
372/*
373 * Event extended info header. This is the structure preceding each
374 * extended info data.
375 */
376struct lttcomm_event_extended_header {
377 /*
378 * Size of filter string immediately following this header.
379 * This size includes the terminal null character.
380 */
381 uint32_t filter_len;
795d57ce
PP
382
383 /*
384 * Number of exclusion names, immediately following the filter
385 * string. Each exclusion name has a fixed length of
386 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
387 * character.
388 */
389 uint32_t nb_exclusions;
b4e3ceb9
PP
390} LTTNG_PACKED;
391
fac6795d 392/*
5e16da05 393 * Data structure for the response from sessiond to the lttng client.
fac6795d 394 */
5461b305 395struct lttcomm_lttng_msg {
d0b96690
DG
396 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
397 uint32_t ret_code; /* enum lttcomm_return_code */
398 uint32_t pid; /* pid_t */
795a978d 399 uint32_t cmd_header_size;
773168b7 400 uint32_t data_size;
fc5e05b7 401} LTTNG_PACKED;
fac6795d 402
da3c9ec1
DG
403struct lttcomm_lttng_output_id {
404 uint32_t id;
405} LTTNG_PACKED;
406
6e3805e2 407/*
3bd1e081
MD
408 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
409 * to either add a channel, add a stream, update a stream, or stop
410 * operation.
6e3805e2 411 */
3bd1e081
MD
412struct lttcomm_consumer_msg {
413 uint32_t cmd_type; /* enum consumerd_command */
414 union {
415 struct {
d88aee68 416 uint64_t channel_key;
ffe60014
DG
417 uint64_t session_id;
418 char pathname[PATH_MAX];
d88aee68
DG
419 uint32_t uid;
420 uint32_t gid;
421 uint64_t relayd_id;
c30aaa51 422 /* nb_init_streams is the number of streams open initially. */
d88aee68 423 uint32_t nb_init_streams;
de5e9086 424 char name[LTTNG_SYMBOL_NAME_LEN];
ffe60014
DG
425 /* Use splice or mmap to consume this fd */
426 enum lttng_event_output output;
427 int type; /* Per cpu or metadata. */
1624d5b7
JD
428 uint64_t tracefile_size; /* bytes */
429 uint32_t tracefile_count; /* number of tracefiles */
2bba9e53
DG
430 /* If the channel's streams have to be monitored or not. */
431 uint32_t monitor;
ecc48a90
JD
432 /* timer to check the streams usage in live mode (usec). */
433 unsigned int live_timer_interval;
e9404c27
JG
434 /* timer to sample a channel's positions (usec). */
435 unsigned int monitor_timer_interval;
ffe60014 436 } LTTNG_PACKED channel; /* Only used by Kernel. */
3bd1e081 437 struct {
d88aee68
DG
438 uint64_t stream_key;
439 uint64_t channel_key;
440 int32_t cpu; /* On which CPU this stream is assigned. */
6dc3064a
DG
441 /* Tells the consumer if the stream should be or not monitored. */
442 uint32_t no_monitor;
ffe60014 443 } LTTNG_PACKED stream; /* Only used by Kernel. */
de5e9086 444 struct {
d88aee68 445 uint64_t net_index;
de5e9086
DG
446 enum lttng_stream_type type;
447 /* Open socket to the relayd */
6151a90f 448 struct lttcomm_relayd_sock sock;
46e6455f
DG
449 /* Tracing session id associated to the relayd. */
450 uint64_t session_id;
d3e2ba59
JD
451 /* Relayd session id, only used with control socket. */
452 uint64_t relayd_session_id;
fc5e05b7 453 } LTTNG_PACKED relayd_sock;
173af62f
DG
454 struct {
455 uint64_t net_seq_idx;
fc5e05b7 456 } LTTNG_PACKED destroy_relayd;
53632229
DG
457 struct {
458 uint64_t session_id;
fc5e05b7 459 } LTTNG_PACKED data_pending;
ffe60014 460 struct {
d0b96690
DG
461 uint64_t subbuf_size; /* bytes */
462 uint64_t num_subbuf; /* power of 2 */
d88aee68
DG
463 int32_t overwrite; /* 1: overwrite, 0: discard */
464 uint32_t switch_timer_interval; /* usec */
465 uint32_t read_timer_interval; /* usec */
e9404c27
JG
466 unsigned int live_timer_interval; /* usec */
467 uint32_t monitor_timer_interval; /* usec */
d88aee68
DG
468 int32_t output; /* splice, mmap */
469 int32_t type; /* metadata or per_cpu */
d0b96690
DG
470 uint64_t session_id; /* Tracing session id */
471 char pathname[PATH_MAX]; /* Channel file path. */
ffe60014 472 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
d88aee68
DG
473 uint32_t uid; /* User ID of the session */
474 uint32_t gid; /* Group ID ot the session */
475 uint64_t relayd_id; /* Relayd id if apply. */
476 uint64_t key; /* Unique channel key. */
b6d38284 477 unsigned char uuid[UUID_LEN]; /* uuid for ust tracer. */
7972aab2 478 uint32_t chan_id; /* Channel ID on the tracer side. */
1624d5b7
JD
479 uint64_t tracefile_size; /* bytes */
480 uint32_t tracefile_count; /* number of tracefiles */
1950109e 481 uint64_t session_id_per_pid; /* Per-pid session ID. */
2bba9e53
DG
482 /* Tells the consumer if the stream should be or not monitored. */
483 uint32_t monitor;
567eb353
DG
484 /*
485 * For UST per UID buffers, this is the application UID of the
486 * channel. This can be different from the user UID requesting the
487 * channel creation and used for the rights on the stream file
488 * because the application can be in the tracing for instance.
489 */
490 uint32_t ust_app_uid;
491d1539 491 int64_t blocking_timeout;
3d071855 492 char root_shm_path[PATH_MAX];
d7ba1388 493 char shm_path[PATH_MAX];
ffe60014
DG
494 } LTTNG_PACKED ask_channel;
495 struct {
d88aee68 496 uint64_t key;
ffe60014
DG
497 } LTTNG_PACKED get_channel;
498 struct {
d88aee68 499 uint64_t key;
ffe60014 500 } LTTNG_PACKED destroy_channel;
d88aee68
DG
501 struct {
502 uint64_t key; /* Metadata channel key. */
503 uint64_t target_offset; /* Offset in the consumer */
504 uint64_t len; /* Length of metadata to be received. */
93ec662e 505 uint64_t version; /* Version of the metadata. */
d88aee68
DG
506 } LTTNG_PACKED push_metadata;
507 struct {
508 uint64_t key; /* Metadata channel key. */
509 } LTTNG_PACKED close_metadata;
510 struct {
511 uint64_t key; /* Metadata channel key. */
512 } LTTNG_PACKED setup_metadata;
7972aab2
DG
513 struct {
514 uint64_t key; /* Channel key. */
515 } LTTNG_PACKED flush_channel;
0dd01979
MD
516 struct {
517 uint64_t key; /* Channel key. */
518 } LTTNG_PACKED clear_quiescent_channel;
6dc3064a
DG
519 struct {
520 char pathname[PATH_MAX];
521 /* Indicate if the snapshot goes on the relayd or locally. */
522 uint32_t use_relayd;
523 uint32_t metadata; /* This a metadata snapshot. */
524 uint64_t relayd_id; /* Relayd id if apply. */
525 uint64_t key;
d07ceecd 526 uint64_t nb_packets_per_stream;
6dc3064a 527 } LTTNG_PACKED snapshot_channel;
a4baae1b
JD
528 struct {
529 uint64_t channel_key;
530 uint64_t net_seq_idx;
531 } LTTNG_PACKED sent_streams;
fb83fe64
JD
532 struct {
533 uint64_t session_id;
534 uint64_t channel_key;
535 } LTTNG_PACKED discarded_events;
536 struct {
537 uint64_t session_id;
538 uint64_t channel_key;
539 } LTTNG_PACKED lost_packets;
93ec662e
JD
540 struct {
541 uint64_t session_id;
eded6438 542 } LTTNG_PACKED regenerate_metadata;
00fb02ac
JD
543 struct {
544 char old_path[LTTNG_PATH_MAX];
545 char new_path[LTTNG_PATH_MAX];
546 uint64_t relayd_id; /* Relayd id if apply. */
547 uint64_t session_id;
548 uint32_t uid;
549 uint32_t gid;
550 } LTTNG_PACKED rotate_rename;
a1ae2ea5
JD
551 struct {
552 char path[LTTNG_PATH_MAX];
553 uint64_t relayd_id; /* Relayd id if apply. */
554 uint64_t session_id;
555 uint32_t uid;
556 uint32_t gid;
557 } LTTNG_PACKED mkdir;
3bd1e081 558 } u;
fc5e05b7 559} LTTNG_PACKED;
6e3805e2 560
e9404c27
JG
561/*
562 * Channel monitoring message returned to the session daemon on every
563 * monitor timer expiration.
564 */
565struct lttcomm_consumer_channel_monitor_msg {
566 /* Key of the sampled channel. */
567 uint64_t key;
568 /*
569 * Lowest and highest usage (bytes) at the moment the sample was taken.
570 */
571 uint64_t lowest, highest;
572} LTTNG_PACKED;
573
f50f23d9
DG
574/*
575 * Status message returned to the sessiond after a received command.
576 */
577struct lttcomm_consumer_status_msg {
0c759fc9 578 enum lttcomm_return_code ret_code;
fc5e05b7 579} LTTNG_PACKED;
f50f23d9 580
ffe60014 581struct lttcomm_consumer_status_channel {
0c759fc9 582 enum lttcomm_return_code ret_code;
d88aee68 583 uint64_t key;
ffe60014
DG
584 unsigned int stream_count;
585} LTTNG_PACKED;
586
74d0b642 587#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 588
9df8df5e 589#include <lttng/ust-abi.h>
6e3805e2 590
3817e7df
DG
591/*
592 * Data structure for the commands sent from sessiond to UST.
593 */
594struct lttcomm_ust_msg {
3817e7df
DG
595 uint32_t handle;
596 uint32_t cmd;
597 union {
3817e7df 598 struct lttng_ust_channel channel;
00a17c97 599 struct lttng_ust_stream stream;
3817e7df
DG
600 struct lttng_ust_event event;
601 struct lttng_ust_context context;
00a17c97 602 struct lttng_ust_tracer_version version;
3817e7df 603 } u;
fc5e05b7 604} LTTNG_PACKED;
3817e7df
DG
605
606/*
607 * Data structure for the response from UST to the session daemon.
608 * cmd_type is sent back in the reply for validation.
609 */
610struct lttcomm_ust_reply {
611 uint32_t handle;
612 uint32_t cmd;
613 uint32_t ret_code; /* enum lttcomm_return_code */
614 uint32_t ret_val; /* return value */
615 union {
2b0bf864
DG
616 struct {
617 uint64_t memory_map_size;
fc5e05b7 618 } LTTNG_PACKED channel;
2b0bf864
DG
619 struct {
620 uint64_t memory_map_size;
fc5e05b7 621 } LTTNG_PACKED stream;
00a17c97 622 struct lttng_ust_tracer_version version;
3817e7df 623 } u;
fc5e05b7 624} LTTNG_PACKED;
3817e7df 625
74d0b642 626#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 627
fac6795d
DG
628extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
629
6364a07a
DG
630extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
631 const char *ip, unsigned int port);
632extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
633 const char *ip, unsigned int port);
634
de5e9086
DG
635extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
636extern int lttcomm_create_sock(struct lttcomm_sock *sock);
637extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
638extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
639extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
640extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
641 struct lttcomm_sock *src);
6364a07a 642
6151a90f
JD
643/* Relayd socket object. */
644extern struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
645 struct lttng_uri *uri, uint32_t major, uint32_t minor);
646
783a3b9a
MD
647extern int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
648extern int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
649
554831e7
MD
650extern void lttcomm_init(void);
651/* Get network timeout, in milliseconds */
652extern unsigned long lttcomm_get_network_timeout(void);
653
773168b7 654#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.083585 seconds and 4 git commands to generate.