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