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