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