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. | |
fac6795d | 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. |
fac6795d | 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 | ||
d19d9ada | 28 | #define _GNU_SOURCE |
fac6795d | 29 | #include <limits.h> |
f3ed775e | 30 | #include <lttng/lttng.h> |
b17231c6 | 31 | #include <common/compat/socket.h> |
a4b92340 | 32 | #include <common/uri.h> |
ce2a9e76 | 33 | #include <common/defaults.h> |
5e16da05 | 34 | |
6364a07a DG |
35 | #include <arpa/inet.h> |
36 | #include <netinet/in.h> | |
37 | #include <sys/un.h> | |
38 | ||
39 | #include "inet.h" | |
40 | #include "inet6.h" | |
0d37f2bc DG |
41 | #include "unix.h" |
42 | ||
fac6795d | 43 | /* Queue size of listen(2) */ |
f158a754 | 44 | #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64 |
fac6795d | 45 | |
990570ed DG |
46 | /* Maximum number of FDs that can be sent over a Unix socket */ |
47 | #define LTTCOMM_MAX_SEND_FDS 4 | |
48 | ||
3817e7df DG |
49 | /* |
50 | * Get the error code index from 0 since LTTCOMM_OK start at 1000 | |
fac6795d | 51 | */ |
f73fabfd | 52 | #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY) |
fac6795d | 53 | |
6abb15de | 54 | enum lttcomm_sessiond_command { |
0d0c377a | 55 | /* Tracer command */ |
b579acd9 | 56 | LTTNG_ADD_CONTEXT, |
f4688807 | 57 | LTTNG_CALIBRATE, |
0b97ec54 | 58 | LTTNG_DISABLE_CHANNEL, |
f5177a38 DG |
59 | LTTNG_DISABLE_EVENT, |
60 | LTTNG_DISABLE_ALL_EVENT, | |
0d0c377a DG |
61 | LTTNG_ENABLE_CHANNEL, |
62 | LTTNG_ENABLE_EVENT, | |
63 | LTTNG_ENABLE_ALL_EVENT, | |
64 | /* Session daemon command */ | |
fac6795d DG |
65 | LTTNG_CREATE_SESSION, |
66 | LTTNG_DESTROY_SESSION, | |
9f19cc17 DG |
67 | LTTNG_LIST_CHANNELS, |
68 | LTTNG_LIST_DOMAINS, | |
f3ed775e | 69 | LTTNG_LIST_EVENTS, |
9f19cc17 | 70 | LTTNG_LIST_SESSIONS, |
052da939 | 71 | LTTNG_LIST_TRACEPOINTS, |
d9800920 | 72 | LTTNG_REGISTER_CONSUMER, |
f3ed775e DG |
73 | LTTNG_START_TRACE, |
74 | LTTNG_STOP_TRACE, | |
f37d259d | 75 | LTTNG_LIST_TRACEPOINT_FIELDS, |
53a80697 | 76 | |
de5e9086 DG |
77 | /* Consumer */ |
78 | LTTNG_DISABLE_CONSUMER, | |
79 | LTTNG_ENABLE_CONSUMER, | |
80 | LTTNG_SET_CONSUMER_URI, | |
81 | /* Relay daemon */ | |
82 | RELAYD_ADD_STREAM, | |
83 | RELAYD_CREATE_SESSION, | |
84 | RELAYD_START_DATA, | |
85 | RELAYD_UPDATE_SYNC_INFO, | |
86 | RELAYD_VERSION, | |
87 | RELAYD_SEND_METADATA, | |
173af62f | 88 | RELAYD_CLOSE_STREAM, |
6d805429 | 89 | RELAYD_DATA_PENDING, |
c8f59ee5 | 90 | RELAYD_QUIESCENT_CONTROL, |
53a80697 | 91 | LTTNG_SET_FILTER, |
44a5e5eb | 92 | LTTNG_HEALTH_CHECK, |
6d805429 | 93 | LTTNG_DATA_PENDING, |
fac6795d DG |
94 | }; |
95 | ||
96 | /* | |
97 | * lttcomm error code. | |
98 | */ | |
99 | enum lttcomm_return_code { | |
f73fabfd DG |
100 | LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */ |
101 | LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */ | |
102 | LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */ | |
103 | LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */ | |
104 | LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */ | |
105 | LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */ | |
106 | LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */ | |
107 | LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */ | |
108 | LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */ | |
109 | LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */ | |
110 | LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */ | |
111 | LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */ | |
112 | LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */ | |
113 | LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */ | |
80e327fa | 114 | |
20fe2104 DG |
115 | /* MUST be last element */ |
116 | LTTCOMM_NR, /* Last element */ | |
fac6795d DG |
117 | }; |
118 | ||
de5e9086 DG |
119 | /* lttng socket protocol. */ |
120 | enum lttcomm_sock_proto { | |
121 | LTTCOMM_SOCK_UDP, | |
122 | LTTCOMM_SOCK_TCP, | |
123 | }; | |
124 | ||
125 | /* | |
126 | * Index in the net_families array below. Please keep in sync! | |
127 | */ | |
128 | enum lttcomm_sock_domain { | |
01d0a631 CB |
129 | LTTCOMM_INET = 0, |
130 | LTTCOMM_INET6 = 1, | |
de5e9086 DG |
131 | }; |
132 | ||
133 | struct lttcomm_sockaddr { | |
134 | enum lttcomm_sock_domain type; | |
135 | union { | |
136 | struct sockaddr_in sin; | |
137 | struct sockaddr_in6 sin6; | |
138 | } addr; | |
139 | }; | |
140 | ||
141 | struct lttcomm_sock { | |
142 | int fd; | |
143 | enum lttcomm_sock_proto proto; | |
144 | struct lttcomm_sockaddr sockaddr; | |
145 | const struct lttcomm_proto_ops *ops; | |
146 | }; | |
147 | ||
148 | struct lttcomm_net_family { | |
149 | int family; | |
150 | int (*create) (struct lttcomm_sock *sock, int type, int proto); | |
151 | }; | |
152 | ||
153 | struct lttcomm_proto_ops { | |
154 | int (*bind) (struct lttcomm_sock *sock); | |
155 | int (*close) (struct lttcomm_sock *sock); | |
156 | int (*connect) (struct lttcomm_sock *sock); | |
157 | struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock); | |
158 | int (*listen) (struct lttcomm_sock *sock, int backlog); | |
159 | ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len, | |
160 | int flags); | |
161 | ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len, | |
162 | int flags); | |
163 | }; | |
164 | ||
fac6795d | 165 | /* |
9bda164d | 166 | * Data structure received from lttng client to session daemon. |
fac6795d DG |
167 | */ |
168 | struct lttcomm_session_msg { | |
773168b7 | 169 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
42abccdb | 170 | struct lttng_session session; |
9f19cc17 | 171 | struct lttng_domain domain; |
fac6795d DG |
172 | union { |
173 | struct { | |
db8870ed | 174 | char channel_name[LTTNG_SYMBOL_NAME_LEN]; |
f3ed775e DG |
175 | char name[NAME_MAX]; |
176 | } disable; | |
177 | /* Event data */ | |
fac6795d | 178 | struct { |
db8870ed | 179 | char channel_name[LTTNG_SYMBOL_NAME_LEN]; |
f3ed775e DG |
180 | struct lttng_event event; |
181 | } enable; | |
182 | /* Create channel */ | |
183 | struct { | |
184 | struct lttng_channel chan; | |
185 | } channel; | |
d65106b1 DG |
186 | /* Context */ |
187 | struct { | |
db8870ed MD |
188 | char channel_name[LTTNG_SYMBOL_NAME_LEN]; |
189 | char event_name[LTTNG_SYMBOL_NAME_LEN]; | |
7d29a247 | 190 | struct lttng_event_context ctx; |
d65106b1 | 191 | } context; |
d9800920 DG |
192 | /* Use by register_consumer */ |
193 | struct { | |
194 | char path[PATH_MAX]; | |
195 | } reg; | |
9f19cc17 DG |
196 | /* List */ |
197 | struct { | |
db8870ed | 198 | char channel_name[LTTNG_SYMBOL_NAME_LEN]; |
9f19cc17 | 199 | } list; |
d0254c7c | 200 | struct lttng_calibrate calibrate; |
a4b92340 | 201 | /* Used by the set_consumer_url and used by create_session also call */ |
de5e9086 | 202 | struct { |
a4b92340 DG |
203 | /* Number of lttng_uri following */ |
204 | uint32_t size; | |
205 | } uri; | |
53a80697 | 206 | struct { |
db8870ed MD |
207 | char channel_name[LTTNG_SYMBOL_NAME_LEN]; |
208 | char event_name[LTTNG_SYMBOL_NAME_LEN]; | |
53a80697 MD |
209 | /* Length of following bytecode */ |
210 | uint32_t bytecode_len; | |
211 | } filter; | |
fac6795d DG |
212 | } u; |
213 | }; | |
214 | ||
d93c4f1f | 215 | #define LTTNG_FILTER_MAX_LEN 65536 |
53a80697 MD |
216 | |
217 | /* | |
218 | * Filter bytecode data. The reloc table is located at the end of the | |
219 | * bytecode. It is made of tuples: (uint16_t, var. len. string). It | |
220 | * starts at reloc_table_offset. | |
221 | */ | |
222 | struct lttng_filter_bytecode { | |
d93c4f1f CB |
223 | uint32_t len; /* len of data */ |
224 | uint32_t reloc_table_offset; | |
f3f0db50 | 225 | uint64_t seqnum; |
53a80697 MD |
226 | char data[0]; |
227 | }; | |
228 | ||
fac6795d | 229 | /* |
5e16da05 | 230 | * Data structure for the response from sessiond to the lttng client. |
fac6795d | 231 | */ |
5461b305 | 232 | struct lttcomm_lttng_msg { |
773168b7 MD |
233 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
234 | uint32_t ret_code; /* enum lttcomm_return_code */ | |
235 | uint32_t pid; /* pid_t */ | |
236 | uint32_t data_size; | |
5461b305 DG |
237 | /* Contains: trace_name + data */ |
238 | char payload[]; | |
fac6795d DG |
239 | }; |
240 | ||
44a5e5eb DG |
241 | struct lttcomm_health_msg { |
242 | uint32_t component; | |
243 | uint32_t cmd; | |
244 | }; | |
245 | ||
246 | struct lttcomm_health_data { | |
247 | uint32_t ret_code; | |
248 | }; | |
249 | ||
6e3805e2 | 250 | /* |
3bd1e081 MD |
251 | * lttcomm_consumer_msg is the message sent from sessiond to consumerd |
252 | * to either add a channel, add a stream, update a stream, or stop | |
253 | * operation. | |
6e3805e2 | 254 | */ |
3bd1e081 MD |
255 | struct lttcomm_consumer_msg { |
256 | uint32_t cmd_type; /* enum consumerd_command */ | |
257 | union { | |
258 | struct { | |
259 | int channel_key; | |
260 | uint64_t max_sb_size; /* the subbuffer size for this channel */ | |
261 | /* shm_fd and wait_fd are sent as ancillary data */ | |
262 | uint64_t mmap_len; | |
c30aaa51 MD |
263 | /* nb_init_streams is the number of streams open initially. */ |
264 | unsigned int nb_init_streams; | |
de5e9086 | 265 | char name[LTTNG_SYMBOL_NAME_LEN]; |
3bd1e081 MD |
266 | } channel; |
267 | struct { | |
268 | int channel_key; | |
269 | int stream_key; | |
270 | /* shm_fd and wait_fd are sent as ancillary data */ | |
271 | uint32_t state; /* enum lttcomm_consumer_fd_state */ | |
272 | enum lttng_event_output output; /* use splice or mmap to consume this fd */ | |
273 | uint64_t mmap_len; | |
6df2e2c9 MD |
274 | uid_t uid; /* User ID owning the session */ |
275 | gid_t gid; /* Group ID owning the session */ | |
3bd1e081 | 276 | char path_name[PATH_MAX]; |
de5e9086 DG |
277 | int net_index; |
278 | unsigned int metadata_flag; | |
ce2a9e76 | 279 | char name[DEFAULT_STREAM_NAME_LEN]; /* Name string of the stream */ |
53632229 | 280 | uint64_t session_id; /* Tracing session id of the stream */ |
3bd1e081 | 281 | } stream; |
de5e9086 DG |
282 | struct { |
283 | int net_index; | |
284 | enum lttng_stream_type type; | |
285 | /* Open socket to the relayd */ | |
286 | struct lttcomm_sock sock; | |
287 | } relayd_sock; | |
173af62f DG |
288 | struct { |
289 | uint64_t net_seq_idx; | |
290 | } destroy_relayd; | |
53632229 DG |
291 | struct { |
292 | uint64_t session_id; | |
6d805429 | 293 | } data_pending; |
3bd1e081 | 294 | } u; |
6e3805e2 DG |
295 | }; |
296 | ||
74d0b642 | 297 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 298 | |
9df8df5e | 299 | #include <lttng/ust-abi.h> |
6e3805e2 | 300 | |
3817e7df DG |
301 | /* |
302 | * Data structure for the commands sent from sessiond to UST. | |
303 | */ | |
304 | struct lttcomm_ust_msg { | |
3817e7df DG |
305 | uint32_t handle; |
306 | uint32_t cmd; | |
307 | union { | |
3817e7df | 308 | struct lttng_ust_channel channel; |
00a17c97 | 309 | struct lttng_ust_stream stream; |
3817e7df DG |
310 | struct lttng_ust_event event; |
311 | struct lttng_ust_context context; | |
00a17c97 | 312 | struct lttng_ust_tracer_version version; |
3817e7df DG |
313 | } u; |
314 | }; | |
315 | ||
316 | /* | |
317 | * Data structure for the response from UST to the session daemon. | |
318 | * cmd_type is sent back in the reply for validation. | |
319 | */ | |
320 | struct lttcomm_ust_reply { | |
321 | uint32_t handle; | |
322 | uint32_t cmd; | |
323 | uint32_t ret_code; /* enum lttcomm_return_code */ | |
324 | uint32_t ret_val; /* return value */ | |
325 | union { | |
2b0bf864 DG |
326 | struct { |
327 | uint64_t memory_map_size; | |
328 | } channel; | |
329 | struct { | |
330 | uint64_t memory_map_size; | |
331 | } stream; | |
00a17c97 | 332 | struct lttng_ust_tracer_version version; |
3817e7df DG |
333 | } u; |
334 | }; | |
335 | ||
74d0b642 | 336 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 337 | |
fac6795d DG |
338 | extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code); |
339 | ||
6364a07a DG |
340 | extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr, |
341 | const char *ip, unsigned int port); | |
342 | extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr, | |
343 | const char *ip, unsigned int port); | |
344 | ||
de5e9086 DG |
345 | extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto); |
346 | extern int lttcomm_create_sock(struct lttcomm_sock *sock); | |
347 | extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri); | |
348 | extern void lttcomm_destroy_sock(struct lttcomm_sock *sock); | |
349 | extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src); | |
350 | extern void lttcomm_copy_sock(struct lttcomm_sock *dst, | |
351 | struct lttcomm_sock *src); | |
6364a07a | 352 | |
773168b7 | 353 | #endif /* _LTTNG_SESSIOND_COMM_H */ |