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