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