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