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