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