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