projects / lttng-tools.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
SoW-2020-0003: Trace Hit Counters
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
CommitLineData
6e3805e2 1/*
ab5be9fa
MJ		 2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
ba999de0 7 *
fac6795d
DG		 8 */
9
773168b7 10/*
990570ed
DG		 11 * This header is meant for liblttng and libust internal use ONLY. These
12 * declarations should NOT be considered stable API.
773168b7 13 */
fac6795d 14
990570ed
DG		 15#ifndef _LTTNG_SESSIOND_COMM_H
16#define _LTTNG_SESSIOND_COMM_H
17
fac6795d 18#include <limits.h>
f3ed775e 19#include <lttng/lttng.h>
da3c9ec1 20#include <lttng/snapshot-internal.h>
00c76cea 21#include <lttng/save-internal.h>
e9404c27
JG		 22#include <lttng/channel-internal.h>
23#include <lttng/trigger/trigger-internal.h>
d88744a4 24#include <lttng/rotate-internal.h>
b17231c6 25#include <common/compat/socket.h>
a4b92340 26#include <common/uri.h>
ce2a9e76 27#include <common/defaults.h>
c70636a7 28#include <common/uuid.h>
aa52c986 29#include <common/macros.h>
d2956687 30#include <common/optional.h>
5e16da05 31
6364a07a
DG		 32#include <arpa/inet.h>
33#include <netinet/in.h>
34#include <sys/un.h>
35
36#include "inet.h"
37#include "inet6.h"
2038dd6c 38#include <common/unix.h>
0d37f2bc 39
fac6795d 40/* Queue size of listen(2) */
f158a754 41#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 42
990570ed 43/* Maximum number of FDs that can be sent over a Unix socket */
0b5a4de9
JG		 44#if defined(__linux__)
45/* Based on the kernel's SCM_MAX_FD which is 253 since 2.6.38 (255 before) */
46#define LTTCOMM_MAX_SEND_FDS 253
47#else
48#define LTTCOMM_MAX_SEND_FDS 16
49#endif
990570ed 50
3817e7df
DG		 51/*
52 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 53 */
f73fabfd 54#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
fac6795d 55
6abb15de 56enum lttcomm_sessiond_command {
0d0c377a 57 /* Tracer command */
159b042f 58 LTTNG_ADD_CONTEXT = 0,
b812e5ca 59 /* LTTNG_CALIBRATE used to be here */
159b042f
JG		 60 LTTNG_DISABLE_CHANNEL = 2,
61 LTTNG_DISABLE_EVENT = 3,
62 LTTNG_LIST_SYSCALLS = 4,
63 LTTNG_ENABLE_CHANNEL = 5,
64 LTTNG_ENABLE_EVENT = 6,
18a720cd 65 /* 7 */
0d0c377a 66 /* Session daemon command */
b178f53e 67 /* 8 */
159b042f
JG		 68 LTTNG_DESTROY_SESSION = 9,
69 LTTNG_LIST_CHANNELS = 10,
70 LTTNG_LIST_DOMAINS = 11,
71 LTTNG_LIST_EVENTS = 12,
72 LTTNG_LIST_SESSIONS = 13,
73 LTTNG_LIST_TRACEPOINTS = 14,
74 LTTNG_REGISTER_CONSUMER = 15,
75 LTTNG_START_TRACE = 16,
76 LTTNG_STOP_TRACE = 17,
77 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
53a80697 78
de5e9086 79 /* Consumer */
159b042f
JG		 80 LTTNG_DISABLE_CONSUMER = 19,
81 LTTNG_ENABLE_CONSUMER = 20,
82 LTTNG_SET_CONSUMER_URI = 21,
67676bd8
DG		 83 /* 22 */
84 /* 23 */
159b042f
JG		 85 LTTNG_DATA_PENDING = 24,
86 LTTNG_SNAPSHOT_ADD_OUTPUT = 25,
87 LTTNG_SNAPSHOT_DEL_OUTPUT = 26,
88 LTTNG_SNAPSHOT_LIST_OUTPUT = 27,
89 LTTNG_SNAPSHOT_RECORD = 28,
b178f53e
JG		 90 /* 29 */
91 /* 30 */
159b042f
JG		 92 LTTNG_SAVE_SESSION = 31,
93 LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE = 32,
94 LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE = 33,
95 LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY = 34,
96 LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY = 35,
97 LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET = 36,
98 LTTNG_SET_SESSION_SHM_PATH = 40,
99 LTTNG_REGENERATE_METADATA = 41,
100 LTTNG_REGENERATE_STATEDUMP = 42,
101 LTTNG_REGISTER_TRIGGER = 43,
102 LTTNG_UNREGISTER_TRIGGER = 44,
103 LTTNG_ROTATE_SESSION = 45,
104 LTTNG_ROTATION_GET_INFO = 46,
105 LTTNG_ROTATION_SET_SCHEDULE = 47,
106 LTTNG_SESSION_LIST_ROTATION_SCHEDULES = 48,
107 LTTNG_CREATE_SESSION_EXT = 49,
108 LTTNG_CLEAR_SESSION = 50,
fbc9f37d 109 LTTNG_LIST_TRIGGERS = 51,
ebdb334b
JR		 110 LTTNG_ADD_MAP = 52,
111 LTTNG_ENABLE_MAP = 53,
112 LTTNG_DISABLE_MAP = 54,
113 LTTNG_LIST_MAPS = 55,
114 LTTNG_LIST_MAP_VALUES = 56,
7c9534d6
JD		 115};
116
19f912db
FD		 117static inline
118const char *lttcomm_sessiond_command_str(enum lttcomm_sessiond_command cmd)
119{
120 switch (cmd) {
121 case LTTNG_ADD_CONTEXT:
122 return "LTTNG_ADD_CONTEXT";
123 case LTTNG_DISABLE_CHANNEL:
124 return "LTTNG_DISABLE_CHANNEL";
125 case LTTNG_DISABLE_EVENT:
126 return "LTTNG_DISABLE_EVENT";
127 case LTTNG_LIST_SYSCALLS:
128 return "LTTNG_LIST_SYSCALLS";
129 case LTTNG_ENABLE_CHANNEL:
130 return "LTTNG_ENABLE_CHANNEL";
131 case LTTNG_ENABLE_EVENT:
132 return "LTTNG_ENABLE_EVENT";
133 case LTTNG_DESTROY_SESSION:
134 return "LTTNG_DESTROY_SESSION";
135 case LTTNG_LIST_CHANNELS:
136 return "LTTNG_LIST_CHANNELS";
137 case LTTNG_LIST_DOMAINS:
138 return "LTTNG_LIST_DOMAINS";
139 case LTTNG_LIST_EVENTS:
140 return "LTTNG_LIST_EVENTS";
141 case LTTNG_LIST_SESSIONS:
142 return "LTTNG_LIST_SESSIONS";
143 case LTTNG_LIST_TRACEPOINTS:
144 return "LTTNG_LIST_TRACEPOINTS";
145 case LTTNG_REGISTER_CONSUMER:
146 return "LTTNG_REGISTER_CONSUMER";
147 case LTTNG_START_TRACE:
148 return "LTTNG_START_TRACE";
149 case LTTNG_STOP_TRACE:
150 return "LTTNG_STOP_TRACE";
151 case LTTNG_LIST_TRACEPOINT_FIELDS:
152 return "LTTNG_LIST_TRACEPOINT_FIELDS";
153 case LTTNG_DISABLE_CONSUMER:
154 return "LTTNG_DISABLE_CONSUMER";
155 case LTTNG_ENABLE_CONSUMER:
156 return "LTTNG_ENABLE_CONSUMER";
157 case LTTNG_SET_CONSUMER_URI:
158 return "LTTNG_SET_CONSUMER_URI";
159 case LTTNG_DATA_PENDING:
160 return "LTTNG_DATA_PENDING";
161 case LTTNG_SNAPSHOT_ADD_OUTPUT:
162 return "LTTNG_SNAPSHOT_ADD_OUTPUT";
163 case LTTNG_SNAPSHOT_DEL_OUTPUT:
164 return "LTTNG_SNAPSHOT_DEL_OUTPUT";
165 case LTTNG_SNAPSHOT_LIST_OUTPUT:
166 return "LTTNG_SNAPSHOT_LIST_OUTPUT";
167 case LTTNG_SNAPSHOT_RECORD:
168 return "LTTNG_SNAPSHOT_RECORD";
169 case LTTNG_SAVE_SESSION:
170 return "LTTNG_SAVE_SESSION";
171 case LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE:
172 return "LTTNG_PROCESS_ATTR_TRACKER_ADD_INCLUDE_VALUE";
173 case LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE:
174 return "LTTNG_PROCESS_ATTR_TRACKER_REMOVE_INCLUDE_VALUE";
175 case LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY:
176 return "LTTNG_PROCESS_ATTR_TRACKER_GET_POLICY";
177 case LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY:
178 return "LTTNG_PROCESS_ATTR_TRACKER_SET_POLICY";
179 case LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET:
180 return "LTTNG_PROCESS_ATTR_TRACKER_GET_INCLUSION_SET";
181 case LTTNG_SET_SESSION_SHM_PATH:
182 return "LTTNG_SET_SESSION_SHM_PATH";
183 case LTTNG_REGENERATE_METADATA:
184 return "LTTNG_REGENERATE_METADATA";
185 case LTTNG_REGENERATE_STATEDUMP:
186 return "LTTNG_REGENERATE_STATEDUMP";
187 case LTTNG_REGISTER_TRIGGER:
188 return "LTTNG_REGISTER_TRIGGER";
189 case LTTNG_UNREGISTER_TRIGGER:
190 return "LTTNG_UNREGISTER_TRIGGER";
191 case LTTNG_ROTATE_SESSION:
192 return "LTTNG_ROTATE_SESSION";
193 case LTTNG_ROTATION_GET_INFO:
194 return "LTTNG_ROTATION_GET_INFO";
195 case LTTNG_ROTATION_SET_SCHEDULE:
196 return "LTTNG_ROTATION_SET_SCHEDULE";
197 case LTTNG_SESSION_LIST_ROTATION_SCHEDULES:
198 return "LTTNG_SESSION_LIST_ROTATION_SCHEDULES";
199 case LTTNG_CREATE_SESSION_EXT:
200 return "LTTNG_CREATE_SESSION_EXT";
201 case LTTNG_CLEAR_SESSION:
202 return "LTTNG_CLEAR_SESSION";
203 case LTTNG_LIST_TRIGGERS:
204 return "LTTNG_LIST_TRIGGERS";
ebdb334b
JR		 205 case LTTNG_ADD_MAP:
206 return "LTTNG_ADD_MAP";
207 case LTTNG_ENABLE_MAP:
208 return "LTTNG_ENABLE_MAP";
209 case LTTNG_DISABLE_MAP:
210 return "LTTNG_DISABLE_MAP";
211 case LTTNG_LIST_MAPS:
212 return "LTTNG_LIST_MAPS";
213 case LTTNG_LIST_MAP_VALUES:
214 return "LTTNG_LIST_MAP_VALUES";
19f912db
FD		 215 default:
216 abort();
217 }
218}
219
7c9534d6
JD		 220enum lttcomm_relayd_command {
221 RELAYD_ADD_STREAM = 1,
222 RELAYD_CREATE_SESSION = 2,
223 RELAYD_START_DATA = 3,
224 RELAYD_UPDATE_SYNC_INFO = 4,
225 RELAYD_VERSION = 5,
226 RELAYD_SEND_METADATA = 6,
227 RELAYD_CLOSE_STREAM = 7,
228 RELAYD_DATA_PENDING = 8,
229 RELAYD_QUIESCENT_CONTROL = 9,
230 RELAYD_BEGIN_DATA_PENDING = 10,
231 RELAYD_END_DATA_PENDING = 11,
1c20f0e2
JD		 232 RELAYD_ADD_INDEX = 12,
233 RELAYD_SEND_INDEX = 13,
234 RELAYD_CLOSE_INDEX = 14,
a4baae1b 235 /* Live-reading commands (2.4+). */
d3e2ba59 236 RELAYD_LIST_SESSIONS = 15,
a4baae1b
JD		 237 /* All streams of the channel have been sent to the relayd (2.4+). */
238 RELAYD_STREAMS_SENT = 16,
93ec662e
JD		 239 /* Ask the relay to reset the metadata trace file (2.8+) */
240 RELAYD_RESET_METADATA = 17,
c35f9726
JG		 241 /* Ask the relay to rotate a set of stream files (2.11+) */
242 RELAYD_ROTATE_STREAMS = 18,
e5add6d0
JG		 243 /* Ask the relay to create a trace chunk (2.11+) */
244 RELAYD_CREATE_TRACE_CHUNK = 19,
bbc4768c
JG		 245 /* Ask the relay to close a trace chunk (2.11+) */
246 RELAYD_CLOSE_TRACE_CHUNK = 20,
c35f9726
JG		 247 /* Ask the relay whether a trace chunk exists (2.11+) */
248 RELAYD_TRACE_CHUNK_EXISTS = 21,
8614e600
MD		 249 /* Get the current configuration of a relayd peer (2.12+) */
250 RELAYD_GET_CONFIGURATION = 22,
3fe73a46
MD		 251
252 /* Feature branch specific commands start at 10000. */
fac6795d
DG		 253};
254
255/*
256 * lttcomm error code.
257 */
258enum lttcomm_return_code {
0c759fc9 259 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
d2956687
JG		 260 /*
261 * Some code paths use -1 to express an error, others
262 * negate this consumer return code. Starting codes at
263 * 100 ensures there is no mix-up between this error value
264 * and legitimate status codes.
265 */
266 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
f73fabfd
DG		 267 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
268 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
269 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
270 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
271 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
272 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
273 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
274 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
275 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
276 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
277 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
278 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
279 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
ffe60014 280 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
d88aee68
DG		 281 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
282 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
618a6a28 283 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
0c759fc9 284 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
e462382a 285 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
e9404c27 286 LTTCOMM_CONSUMERD_ALREADY_SET, /* Resource already set. */
92b7a7f8 287 LTTCOMM_CONSUMERD_ROTATION_FAIL, /* Rotation has failed. */
3eb928aa 288 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED, /* snapshot has failed. */
d2956687
JG		 289 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
290 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk creation failed. */
291 LTTCOMM_CONSUMERD_INVALID_PARAMETERS, /* Invalid parameters. */
292 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
293 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
294 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK, /* Unknown trace chunk. */
b01b201a 295 LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED, /* Relayd does not accept clear command. */
04ed9e10 296 LTTCOMM_CONSUMERD_UNKNOWN_ERROR, /* Unknown error. */
80e327fa 297
20fe2104
DG		 298 /* MUST be last element */
299 LTTCOMM_NR, /* Last element */
fac6795d
DG		 300};
301
de5e9086
DG		 302/* lttng socket protocol. */
303enum lttcomm_sock_proto {
304 LTTCOMM_SOCK_UDP,
305 LTTCOMM_SOCK_TCP,
306};
307
308/*
309 * Index in the net_families array below. Please keep in sync!
310 */
311enum lttcomm_sock_domain {
01d0a631
CB		 312 LTTCOMM_INET = 0,
313 LTTCOMM_INET6 = 1,
de5e9086
DG		 314};
315
331744e3
JD		 316enum lttcomm_metadata_command {
317 LTTCOMM_METADATA_REQUEST = 1,
318};
319
320/*
321 * Commands sent from the consumerd to the sessiond to request if new metadata
322 * is available. This message is used to find the per UID _or_ per PID registry
323 * for the channel key. For per UID lookup, the triplet
324 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
325 * per PID registry indexed by session id ignoring the other values.
326 */
327struct lttcomm_metadata_request_msg {
1950109e
JD		 328 uint64_t session_id; /* Tracing session id */
329 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
331744e3
JD		 330 uint32_t bits_per_long; /* Consumer ABI */
331 uint32_t uid;
332 uint64_t key; /* Metadata channel key. */
333} LTTNG_PACKED;
334
de5e9086
DG		 335struct lttcomm_sockaddr {
336 enum lttcomm_sock_domain type;
337 union {
338 struct sockaddr_in sin;
339 struct sockaddr_in6 sin6;
340 } addr;
fc5e05b7 341} LTTNG_PACKED;
de5e9086
DG		 342
343struct lttcomm_sock {
d88aee68 344 int32_t fd;
de5e9086
DG		 345 enum lttcomm_sock_proto proto;
346 struct lttcomm_sockaddr sockaddr;
347 const struct lttcomm_proto_ops *ops;
fc5e05b7 348} LTTNG_PACKED;
de5e9086 349
6151a90f
JD		 350/*
351 * Relayd sock. Adds the protocol version to use for the communications with
352 * the relayd.
353 */
354struct lttcomm_relayd_sock {
355 struct lttcomm_sock sock;
356 uint32_t major;
357 uint32_t minor;
358} LTTNG_PACKED;
359
de5e9086
DG		 360struct lttcomm_net_family {
361 int family;
362 int (*create) (struct lttcomm_sock *sock, int type, int proto);
363};
364
365struct lttcomm_proto_ops {
366 int (*bind) (struct lttcomm_sock *sock);
367 int (*close) (struct lttcomm_sock *sock);
368 int (*connect) (struct lttcomm_sock *sock);
369 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
370 int (*listen) (struct lttcomm_sock *sock, int backlog);
371 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
372 int flags);
c2d69327
JG		 373 ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
374 size_t len, int flags);
de5e9086
DG		 375};
376
159b042f
JG		 377struct process_attr_integral_value_comm {
378 union {
379 int64_t _signed;
380 uint64_t _unsigned;
381 } u;
382} LTTNG_PACKED;
383
fac6795d 384/*
9bda164d 385 * Data structure received from lttng client to session daemon.
fac6795d
DG		 386 */
387struct lttcomm_session_msg {
d0b96690 388 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 389 struct lttng_session session;
9f19cc17 390 struct lttng_domain domain;
fac6795d 391 union {
f3ed775e 392 /* Event data */
fac6795d 393 struct {
db8870ed 394 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7bd95aee 395 struct lttng_event event;
6b453b5e
JG		 396 /* Length of following filter expression. */
397 uint32_t expression_len;
025faf73
DG		 398 /* Length of following bytecode for filter. */
399 uint32_t bytecode_len;
15e37663 400 /* Exclusion count (fixed-size strings). */
a5516688 401 uint32_t exclusion_count;
15e37663
JG		 402 /* Userspace probe location size. */
403 uint32_t userspace_probe_location_len;
a5516688
JI		 404 /*
405 * After this structure, the following variable-length
406 * items are transmitted:
407 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
15e37663 408 * - char filter_expression[expression_len]
a5516688
JI		 409 * - unsigned char filter_bytecode[bytecode_len]
410 */
fc5e05b7 411 } LTTNG_PACKED enable;
6e911cad
MD		 412 struct {
413 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7bd95aee 414 struct lttng_event event;
6e911cad
MD		 415 /* Length of following filter expression. */
416 uint32_t expression_len;
417 /* Length of following bytecode for filter. */
418 uint32_t bytecode_len;
419 /*
420 * After this structure, the following variable-length
421 * items are transmitted:
422 * - unsigned char filter_expression[expression_len]
423 * - unsigned char filter_bytecode[bytecode_len]
424 */
425 } LTTNG_PACKED disable;
f3ed775e
DG		 426 /* Create channel */
427 struct {
7bd95aee 428 struct lttng_channel chan;
e9404c27 429 struct lttng_channel_extended extended;
fc5e05b7 430 } LTTNG_PACKED channel;
ebdb334b
JR		 431 /* Add map */
432 struct {
433 uint32_t length;
434 } LTTNG_PACKED add_map;
435 /* Enable map */
436 struct {
437 char map_name[LTTNG_SYMBOL_NAME_LEN];
438 } LTTNG_PACKED enable_map;
439 /* Disable map */
440 struct {
441 char map_name[LTTNG_SYMBOL_NAME_LEN];
442 } LTTNG_PACKED disable_map;
d65106b1
DG		 443 /* Context */
444 struct {
db8870ed 445 char channel_name[LTTNG_SYMBOL_NAME_LEN];
7bd95aee 446 struct lttng_event_context ctx;
2001793c
JG		 447 uint32_t provider_name_len;
448 uint32_t context_name_len;
fc5e05b7 449 } LTTNG_PACKED context;
d9800920
DG		 450 /* Use by register_consumer */
451 struct {
452 char path[PATH_MAX];
fc5e05b7 453 } LTTNG_PACKED reg;
9f19cc17
DG		 454 /* List */
455 struct {
db8870ed 456 char channel_name[LTTNG_SYMBOL_NAME_LEN];
fc5e05b7 457 } LTTNG_PACKED list;
d0254c7c 458 struct lttng_calibrate calibrate;
a4b92340 459 /* Used by the set_consumer_url and used by create_session also call */
de5e9086 460 struct {
a4b92340
DG		 461 /* Number of lttng_uri following */
462 uint32_t size;
fc5e05b7 463 } LTTNG_PACKED uri;
da3c9ec1 464 struct {
7bd95aee 465 struct lttng_snapshot_output output;
da3c9ec1
DG		 466 } LTTNG_PACKED snapshot_output;
467 struct {
468 uint32_t wait;
7bd95aee 469 struct lttng_snapshot_output output;
da3c9ec1 470 } LTTNG_PACKED snapshot_record;
ecc48a90
JD		 471 struct {
472 uint32_t nb_uri;
473 unsigned int timer_interval; /* usec */
474 } LTTNG_PACKED session_live;
00c76cea 475 struct {
7bd95aee 476 struct lttng_save_session_attr attr;
00c76cea 477 } LTTNG_PACKED save_session;
d7ba1388
MD		 478 struct {
479 char shm_path[PATH_MAX];
480 } LTTNG_PACKED set_shm_path;
ccf10263 481 struct {
159b042f
JG		 482 /* enum lttng_process_attr */
483 int32_t process_attr;
484 /* enum lttng_process_attr_value_type */
485 int32_t value_type;
486
487 struct process_attr_integral_value_comm integral_value;
55c9e7ca 488 /*
159b042f
JG		 489 * For user/group names, a variable length,
490 * zero-terminated, string of length 'name_len'
491 * (including the terminator) follows.
492 *
493 * integral_value should not be used in those cases.
55c9e7ca 494 */
159b042f
JG		 495 uint32_t name_len;
496 } LTTNG_PACKED process_attr_tracker_add_remove_include_value;
55c9e7ca 497 struct {
159b042f
JG		 498 /* enum lttng_process_attr */
499 int32_t process_attr;
500 } LTTNG_PACKED process_attr_tracker_get_inclusion_set;
501 struct {
502 /* enum lttng_process_attr */
503 int32_t process_attr;
504 } LTTNG_PACKED process_attr_tracker_get_tracking_policy;
505 struct {
506 /* enum lttng_process_attr */
507 int32_t process_attr;
508 /* enum lttng_tracking_policy */
509 int32_t tracking_policy;
510 } LTTNG_PACKED process_attr_tracker_set_tracking_policy;
e9404c27
JG		 511 struct {
512 uint32_t length;
513 } LTTNG_PACKED trigger;
d88744a4 514 struct {
d68c9a04
JD		 515 uint64_t rotation_id;
516 } LTTNG_PACKED get_rotation_info;
259c2674 517 struct {
66ea93b1
JG		 518 /* enum lttng_rotation_schedule_type */
519 uint8_t type;
520 /*
521 * If set == 1, set schedule to value, if set == 0,
522 * clear this schedule type.
523 */
524 uint8_t set;
525 uint64_t value;
526 } LTTNG_PACKED rotation_set_schedule;
b178f53e
JG		 527 struct {
528 /*
529 * Includes the null-terminator.
530 * Must be an absolute path.
531 *
532 * Size bounded by LTTNG_PATH_MAX.
533 */
534 uint16_t home_dir_size;
535 uint64_t session_descriptor_size;
536 /* An lttng_session_descriptor follows. */
537 } LTTNG_PACKED create_session;
ebdb334b
JR		 538 struct {
539 uint32_t map_length;
540 uint32_t query_length;
541 } LTTNG_PACKED list_map_values;
fac6795d 542 } u;
99608320
JR		 543 /* Count of fds sent. */
544 uint32_t fd_count;
fc5e05b7 545} LTTNG_PACKED;
fac6795d 546
d93c4f1f 547#define LTTNG_FILTER_MAX_LEN 65536
b178f53e 548#define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
53a80697
MD		 549
550/*
551 * Filter bytecode data. The reloc table is located at the end of the
552 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
553 * starts at reloc_table_offset.
554 */
b6bbed5f 555#define LTTNG_FILTER_PADDING 32
2b00d462 556struct lttng_bytecode {
d93c4f1f
CB		 557 uint32_t len; /* len of data */
558 uint32_t reloc_table_offset;
f3f0db50 559 uint64_t seqnum;
b6bbed5f 560 char padding[LTTNG_FILTER_PADDING];
53a80697 561 char data[0];
fc5e05b7 562} LTTNG_PACKED;
53a80697 563
579640f9
JI		 564/*
565 * Event exclusion data. At the end of the structure, there will actually
566 * by zero or more names, where the actual number of names is given by
567 * the 'count' item of the structure.
568 */
569#define LTTNG_EVENT_EXCLUSION_PADDING 32
570struct lttng_event_exclusion {
571 uint32_t count;
572 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
caafa356 573 char names[0][LTTNG_SYMBOL_NAME_LEN];
579640f9
JI		 574} LTTNG_PACKED;
575
d7af3565
PP		 576#define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
577 (&(_exclusion)->names[_i][0])
578
b4e3ceb9
PP		 579/*
580 * Event command header.
581 */
582struct lttcomm_event_command_header {
583 /* Number of events */
584 uint32_t nb_events;
585} LTTNG_PACKED;
586
587/*
588 * Event extended info header. This is the structure preceding each
589 * extended info data.
590 */
591struct lttcomm_event_extended_header {
592 /*
593 * Size of filter string immediately following this header.
594 * This size includes the terminal null character.
595 */
596 uint32_t filter_len;
795d57ce
PP		 597
598 /*
599 * Number of exclusion names, immediately following the filter
600 * string. Each exclusion name has a fixed length of
601 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
602 * character.
603 */
604 uint32_t nb_exclusions;
56f0bc67
JG		 605
606 /*
607 * Size of the event's userspace probe location (if applicable).
608 */
609 uint32_t userspace_probe_location_len;
b4e3ceb9
PP		 610} LTTNG_PACKED;
611
3e3665b8
JG		 612/*
613 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
614 */
615struct lttcomm_session_destroy_command_header {
616 /* enum lttng_session */
617 int32_t rotation_state;
618};
619
55c9e7ca
JR		 620/*
621 * tracker command header.
622 */
623struct lttcomm_tracker_command_header {
624 uint32_t nb_tracker_id;
625} LTTNG_PACKED;
626
fac6795d 627/*
5e16da05 628 * Data structure for the response from sessiond to the lttng client.
fac6795d 629 */
5461b305 630struct lttcomm_lttng_msg {
d0b96690
DG		 631 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
632 uint32_t ret_code; /* enum lttcomm_return_code */
633 uint32_t pid; /* pid_t */
795a978d 634 uint32_t cmd_header_size;
773168b7 635 uint32_t data_size;
e368fb43 636 uint32_t fd_count;
fc5e05b7 637} LTTNG_PACKED;
fac6795d 638
da3c9ec1
DG		 639struct lttcomm_lttng_output_id {
640 uint32_t id;
641} LTTNG_PACKED;
642
6e3805e2 643/*
3bd1e081
MD		 644 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
645 * to either add a channel, add a stream, update a stream, or stop
646 * operation.
6e3805e2 647 */
3bd1e081 648struct lttcomm_consumer_msg {
92816cc3 649 uint32_t cmd_type; /* enum lttng_consumer_command */
3bd1e081
MD		 650 union {
651 struct {
d88aee68 652 uint64_t channel_key;
ffe60014 653 uint64_t session_id;
d2956687 654 /* ID of the session's current trace chunk. */
0a30bf9b 655 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
ffe60014 656 char pathname[PATH_MAX];
d88aee68 657 uint64_t relayd_id;
c30aaa51 658 /* nb_init_streams is the number of streams open initially. */
d88aee68 659 uint32_t nb_init_streams;
de5e9086 660 char name[LTTNG_SYMBOL_NAME_LEN];
ffe60014
DG		 661 /* Use splice or mmap to consume this fd */
662 enum lttng_event_output output;
663 int type; /* Per cpu or metadata. */
1624d5b7
JD		 664 uint64_t tracefile_size; /* bytes */
665 uint32_t tracefile_count; /* number of tracefiles */
2bba9e53
DG		 666 /* If the channel's streams have to be monitored or not. */
667 uint32_t monitor;
ecc48a90
JD		 668 /* timer to check the streams usage in live mode (usec). */
669 unsigned int live_timer_interval;
a2814ea7
JG		 670 /* is part of a live session */
671 uint8_t is_live;
e9404c27
JG		 672 /* timer to sample a channel's positions (usec). */
673 unsigned int monitor_timer_interval;
ffe60014 674 } LTTNG_PACKED channel; /* Only used by Kernel. */
3bd1e081 675 struct {
d88aee68
DG		 676 uint64_t stream_key;
677 uint64_t channel_key;
678 int32_t cpu; /* On which CPU this stream is assigned. */
6dc3064a
DG		 679 /* Tells the consumer if the stream should be or not monitored. */
680 uint32_t no_monitor;
ffe60014 681 } LTTNG_PACKED stream; /* Only used by Kernel. */
de5e9086 682 struct {
d88aee68 683 uint64_t net_index;
de5e9086
DG		 684 enum lttng_stream_type type;
685 /* Open socket to the relayd */
6151a90f 686 struct lttcomm_relayd_sock sock;
46e6455f
DG		 687 /* Tracing session id associated to the relayd. */
688 uint64_t session_id;
d3e2ba59
JD		 689 /* Relayd session id, only used with control socket. */
690 uint64_t relayd_session_id;
fc5e05b7 691 } LTTNG_PACKED relayd_sock;
173af62f
DG		 692 struct {
693 uint64_t net_seq_idx;
fc5e05b7 694 } LTTNG_PACKED destroy_relayd;
53632229
DG		 695 struct {
696 uint64_t session_id;
fc5e05b7 697 } LTTNG_PACKED data_pending;
ffe60014 698 struct {
d0b96690
DG		 699 uint64_t subbuf_size; /* bytes */
700 uint64_t num_subbuf; /* power of 2 */
d88aee68
DG		 701 int32_t overwrite; /* 1: overwrite, 0: discard */
702 uint32_t switch_timer_interval; /* usec */
703 uint32_t read_timer_interval; /* usec */
e9404c27 704 unsigned int live_timer_interval; /* usec */
a2814ea7 705 uint8_t is_live; /* is part of a live session */
e9404c27 706 uint32_t monitor_timer_interval; /* usec */
d88aee68
DG		 707 int32_t output; /* splice, mmap */
708 int32_t type; /* metadata or per_cpu */
d0b96690
DG		 709 uint64_t session_id; /* Tracing session id */
710 char pathname[PATH_MAX]; /* Channel file path. */
ffe60014 711 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
d2956687
JG		 712 /* Credentials used to open the UST buffer shared mappings. */
713 struct {
714 uint32_t uid;
715 uint32_t gid;
716 } LTTNG_PACKED buffer_credentials;
d88aee68
DG		 717 uint64_t relayd_id; /* Relayd id if apply. */
718 uint64_t key; /* Unique channel key. */
d2956687 719 /* ID of the session's current trace chunk. */
0a30bf9b 720 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
c70636a7 721 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
7972aab2 722 uint32_t chan_id; /* Channel ID on the tracer side. */
1624d5b7
JD		 723 uint64_t tracefile_size; /* bytes */
724 uint32_t tracefile_count; /* number of tracefiles */
1950109e 725 uint64_t session_id_per_pid; /* Per-pid session ID. */
2bba9e53
DG		 726 /* Tells the consumer if the stream should be or not monitored. */
727 uint32_t monitor;
567eb353
DG		 728 /*
729 * For UST per UID buffers, this is the application UID of the
730 * channel. This can be different from the user UID requesting the
731 * channel creation and used for the rights on the stream file
732 * because the application can be in the tracing for instance.
733 */
734 uint32_t ust_app_uid;
491d1539 735 int64_t blocking_timeout;
3d071855 736 char root_shm_path[PATH_MAX];
d7ba1388 737 char shm_path[PATH_MAX];
ffe60014
DG		 738 } LTTNG_PACKED ask_channel;
739 struct {
d88aee68 740 uint64_t key;
ffe60014
DG		 741 } LTTNG_PACKED get_channel;
742 struct {
d88aee68 743 uint64_t key;
ffe60014 744 } LTTNG_PACKED destroy_channel;
d88aee68
DG		 745 struct {
746 uint64_t key; /* Metadata channel key. */
747 uint64_t target_offset; /* Offset in the consumer */
748 uint64_t len; /* Length of metadata to be received. */
93ec662e 749 uint64_t version; /* Version of the metadata. */
d88aee68
DG		 750 } LTTNG_PACKED push_metadata;
751 struct {
752 uint64_t key; /* Metadata channel key. */
753 } LTTNG_PACKED close_metadata;
754 struct {
755 uint64_t key; /* Metadata channel key. */
756 } LTTNG_PACKED setup_metadata;
7972aab2
DG		 757 struct {
758 uint64_t key; /* Channel key. */
759 } LTTNG_PACKED flush_channel;
0dd01979
MD		 760 struct {
761 uint64_t key; /* Channel key. */
762 } LTTNG_PACKED clear_quiescent_channel;
6dc3064a
DG		 763 struct {
764 char pathname[PATH_MAX];
765 /* Indicate if the snapshot goes on the relayd or locally. */
766 uint32_t use_relayd;
767 uint32_t metadata; /* This a metadata snapshot. */
768 uint64_t relayd_id; /* Relayd id if apply. */
769 uint64_t key;
d07ceecd 770 uint64_t nb_packets_per_stream;
6dc3064a 771 } LTTNG_PACKED snapshot_channel;
a4baae1b
JD		 772 struct {
773 uint64_t channel_key;
774 uint64_t net_seq_idx;
775 } LTTNG_PACKED sent_streams;
fb83fe64
JD		 776 struct {
777 uint64_t session_id;
778 uint64_t channel_key;
779 } LTTNG_PACKED discarded_events;
780 struct {
781 uint64_t session_id;
782 uint64_t channel_key;
783 } LTTNG_PACKED lost_packets;
93ec662e
JD		 784 struct {
785 uint64_t session_id;
eded6438 786 } LTTNG_PACKED regenerate_metadata;
b99a8d42 787 struct {
b99a8d42
JD		 788 uint32_t metadata; /* This is a metadata channel. */
789 uint64_t relayd_id; /* Relayd id if apply. */
790 uint64_t key;
b99a8d42 791 } LTTNG_PACKED rotate_channel;
92816cc3
JG		 792 struct {
793 uint64_t session_id;
794 uint64_t chunk_id;
795 } LTTNG_PACKED check_rotation_pending_local;
d88744a4
JD		 796 struct {
797 uint64_t relayd_id;
798 uint64_t session_id;
799 uint64_t chunk_id;
92816cc3 800 } LTTNG_PACKED check_rotation_pending_relay;
a1ae2ea5 801 struct {
d2956687
JG		 802 /*
803 * Relayd id, if applicable (remote).
804 *
805 * A directory file descriptor referring to the chunk's
806 * output folder is transmitted if the chunk is local
807 * (relayd_id unset).
808 *
809 * `override_name` is left NULL (all-zeroes) if the
913a542b 810 * chunk's name is not overridden.
d2956687 811 */
0a30bf9b 812 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
d2956687
JG		 813 char override_name[LTTNG_NAME_MAX];
814 uint64_t session_id;
815 uint64_t chunk_id;
816 uint64_t creation_timestamp;
e5add6d0 817 LTTNG_OPTIONAL_COMM(struct {
d2956687
JG		 818 uint32_t uid;
819 uint32_t gid;
e5add6d0 820 } LTTNG_PACKED ) LTTNG_PACKED credentials;
d2956687
JG		 821 } LTTNG_PACKED create_trace_chunk;
822 struct {
0a30bf9b 823 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
d2956687
JG		 824 uint64_t session_id;
825 uint64_t chunk_id;
826 uint64_t close_timestamp;
bbc4768c
JG		 827 /* enum lttng_trace_chunk_command_type */
828 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
d2956687
JG		 829 } LTTNG_PACKED close_trace_chunk;
830 struct {
0a30bf9b 831 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
a1ae2ea5 832 uint64_t session_id;
d2956687
JG		 833 uint64_t chunk_id;
834 } LTTNG_PACKED trace_chunk_exists;
835 struct {
836 lttng_uuid sessiond_uuid;
837 } LTTNG_PACKED init;
b01b201a
MD		 838 struct {
839 uint64_t key;
840 } LTTNG_PACKED clear_channel;
04ed9e10
JG		 841 struct {
842 uint64_t key;
843 } LTTNG_PACKED open_channel_packets;
3bd1e081 844 } u;
fc5e05b7 845} LTTNG_PACKED;
6e3805e2 846
e9404c27
JG		 847/*
848 * Channel monitoring message returned to the session daemon on every
849 * monitor timer expiration.
850 */
851struct lttcomm_consumer_channel_monitor_msg {
852 /* Key of the sampled channel. */
853 uint64_t key;
854 /*
855 * Lowest and highest usage (bytes) at the moment the sample was taken.
856 */
857 uint64_t lowest, highest;
e8360425
JD		 858 /*
859 * Sum of all the consumed positions for a channel.
860 */
861 uint64_t total_consumed;
e9404c27
JG		 862} LTTNG_PACKED;
863
f50f23d9
DG		 864/*
865 * Status message returned to the sessiond after a received command.
866 */
867struct lttcomm_consumer_status_msg {
0c759fc9 868 enum lttcomm_return_code ret_code;
fc5e05b7 869} LTTNG_PACKED;
f50f23d9 870
ffe60014 871struct lttcomm_consumer_status_channel {
0c759fc9 872 enum lttcomm_return_code ret_code;
d88aee68 873 uint64_t key;
ffe60014
DG		 874 unsigned int stream_count;
875} LTTNG_PACKED;
876
ecd1a12f
MD		 877struct lttcomm_consumer_close_trace_chunk_reply {
878 enum lttcomm_return_code ret_code;
879 uint32_t path_length;
880 char path[];
881};
882
51791532
JG		 883#ifdef HAVE_LIBLTTNG_UST_CTL
884
9df8df5e 885#include <lttng/ust-abi.h>
6e3805e2 886
3817e7df
DG		 887/*
888 * Data structure for the commands sent from sessiond to UST.
889 */
890struct lttcomm_ust_msg {
3817e7df
DG		 891 uint32_t handle;
892 uint32_t cmd;
893 union {
3817e7df 894 struct lttng_ust_channel channel;
00a17c97 895 struct lttng_ust_stream stream;
3817e7df
DG		 896 struct lttng_ust_event event;
897 struct lttng_ust_context context;
00a17c97 898 struct lttng_ust_tracer_version version;
3817e7df 899 } u;
fc5e05b7 900} LTTNG_PACKED;
3817e7df
DG		 901
902/*
903 * Data structure for the response from UST to the session daemon.
904 * cmd_type is sent back in the reply for validation.
905 */
906struct lttcomm_ust_reply {
907 uint32_t handle;
908 uint32_t cmd;
909 uint32_t ret_code; /* enum lttcomm_return_code */
910 uint32_t ret_val; /* return value */
911 union {
2b0bf864
DG		 912 struct {
913 uint64_t memory_map_size;
fc5e05b7 914 } LTTNG_PACKED channel;
2b0bf864
DG		 915 struct {
916 uint64_t memory_map_size;
fc5e05b7 917 } LTTNG_PACKED stream;
00a17c97 918 struct lttng_ust_tracer_version version;
3817e7df 919 } u;
fc5e05b7 920} LTTNG_PACKED;
3817e7df 921
74d0b642 922#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 923
79445cf0 924LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
fac6795d 925
79445cf0 926LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
6364a07a 927 const char *ip, unsigned int port);
79445cf0 928LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
6364a07a
DG		 929 const char *ip, unsigned int port);
930
79445cf0
JG		 931LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
932LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
933LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
934LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
935LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
936LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
de5e9086 937 struct lttcomm_sock *src);
6364a07a 938
6151a90f 939/* Relayd socket object. */
79445cf0 940LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
6151a90f
JD		 941 struct lttng_uri *uri, uint32_t major, uint32_t minor);
942
79445cf0
JG		 943LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
944LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
783a3b9a 945
2288467f
JG		 946LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
947 uint16_t *port);
948/*
949 * Set a port to an lttcomm_sock. This will have no effect is the socket is
950 * already bound.
951 */
952LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
953
79445cf0 954LTTNG_HIDDEN void lttcomm_init(void);
554831e7 955/* Get network timeout, in milliseconds */
79445cf0 956LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
554831e7 957
773168b7 958#endif /* _LTTNG_SESSIOND_COMM_H */
LTTng tools - Deliverables
This page took 0.138895 seconds and 5 git commands to generate.