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