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