63d4eda078866b17342089aae7382e5aebf243a2
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
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.
9 *
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
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * more details.
14 *
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.
18 */
19
20 /*
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
23 */
24
25 #ifndef _LTTNG_SESSIOND_COMM_H
26 #define _LTTNG_SESSIOND_COMM_H
27
28 #define _GNU_SOURCE
29 #include <limits.h>
30 #include <lttng/lttng.h>
31 #include <common/compat/socket.h>
32 #include <common/uri.h>
33 #include <common/defaults.h>
34 #include <common/compat/uuid.h>
35
36 #include <arpa/inet.h>
37 #include <netinet/in.h>
38 #include <sys/un.h>
39
40 #include "inet.h"
41 #include "inet6.h"
42 #include "unix.h"
43
44 /* Queue size of listen(2) */
45 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
46
47 /* Maximum number of FDs that can be sent over a Unix socket */
48 #define LTTCOMM_MAX_SEND_FDS 4
49
50 /*
51 * Get the error code index from 0 since LTTCOMM_OK start at 1000
52 */
53 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
54
55 enum lttcomm_sessiond_command {
56 /* Tracer command */
57 LTTNG_ADD_CONTEXT = 0,
58 LTTNG_CALIBRATE = 1,
59 LTTNG_DISABLE_CHANNEL = 2,
60 LTTNG_DISABLE_EVENT = 3,
61 LTTNG_DISABLE_ALL_EVENT = 4,
62 LTTNG_ENABLE_CHANNEL = 5,
63 LTTNG_ENABLE_EVENT = 6,
64 LTTNG_ENABLE_ALL_EVENT = 7,
65 /* Session daemon command */
66 LTTNG_CREATE_SESSION = 8,
67 LTTNG_DESTROY_SESSION = 9,
68 LTTNG_LIST_CHANNELS = 10,
69 LTTNG_LIST_DOMAINS = 11,
70 LTTNG_LIST_EVENTS = 12,
71 LTTNG_LIST_SESSIONS = 13,
72 LTTNG_LIST_TRACEPOINTS = 14,
73 LTTNG_REGISTER_CONSUMER = 15,
74 LTTNG_START_TRACE = 16,
75 LTTNG_STOP_TRACE = 17,
76 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
77
78 /* Consumer */
79 LTTNG_DISABLE_CONSUMER = 19,
80 LTTNG_ENABLE_CONSUMER = 20,
81 LTTNG_SET_CONSUMER_URI = 21,
82 LTTNG_ENABLE_EVENT_WITH_FILTER = 22,
83 LTTNG_HEALTH_CHECK = 23,
84 LTTNG_DATA_PENDING = 24,
85 };
86
87 enum lttcomm_relayd_command {
88 RELAYD_ADD_STREAM = 1,
89 RELAYD_CREATE_SESSION = 2,
90 RELAYD_START_DATA = 3,
91 RELAYD_UPDATE_SYNC_INFO = 4,
92 RELAYD_VERSION = 5,
93 RELAYD_SEND_METADATA = 6,
94 RELAYD_CLOSE_STREAM = 7,
95 RELAYD_DATA_PENDING = 8,
96 RELAYD_QUIESCENT_CONTROL = 9,
97 RELAYD_BEGIN_DATA_PENDING = 10,
98 RELAYD_END_DATA_PENDING = 11,
99 };
100
101 /*
102 * lttcomm error code.
103 */
104 enum lttcomm_return_code {
105 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 1, /* Command socket ready */
106 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
107 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
108 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
109 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
110 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
111 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
112 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
113 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
114 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
115 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
116 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
117 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
118 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
119 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
120 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
121 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
122
123 /* MUST be last element */
124 LTTCOMM_NR, /* Last element */
125 };
126
127 /* lttng socket protocol. */
128 enum lttcomm_sock_proto {
129 LTTCOMM_SOCK_UDP,
130 LTTCOMM_SOCK_TCP,
131 };
132
133 /*
134 * Index in the net_families array below. Please keep in sync!
135 */
136 enum lttcomm_sock_domain {
137 LTTCOMM_INET = 0,
138 LTTCOMM_INET6 = 1,
139 };
140
141 enum lttcomm_metadata_command {
142 LTTCOMM_METADATA_REQUEST = 1,
143 };
144
145 /*
146 * Commands sent from the consumerd to the sessiond to request if new metadata
147 * is available. This message is used to find the per UID _or_ per PID registry
148 * for the channel key. For per UID lookup, the triplet
149 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
150 * per PID registry indexed by session id ignoring the other values.
151 */
152 struct lttcomm_metadata_request_msg {
153 unsigned int session_id; /* Tracing session id */
154 uint32_t bits_per_long; /* Consumer ABI */
155 uint32_t uid;
156 uint64_t key; /* Metadata channel key. */
157 } LTTNG_PACKED;
158
159 struct lttcomm_sockaddr {
160 enum lttcomm_sock_domain type;
161 union {
162 struct sockaddr_in sin;
163 struct sockaddr_in6 sin6;
164 } addr;
165 } LTTNG_PACKED;
166
167 struct lttcomm_sock {
168 int32_t fd;
169 enum lttcomm_sock_proto proto;
170 struct lttcomm_sockaddr sockaddr;
171 const struct lttcomm_proto_ops *ops;
172 } LTTNG_PACKED;
173
174 struct lttcomm_net_family {
175 int family;
176 int (*create) (struct lttcomm_sock *sock, int type, int proto);
177 };
178
179 struct lttcomm_proto_ops {
180 int (*bind) (struct lttcomm_sock *sock);
181 int (*close) (struct lttcomm_sock *sock);
182 int (*connect) (struct lttcomm_sock *sock);
183 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
184 int (*listen) (struct lttcomm_sock *sock, int backlog);
185 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
186 int flags);
187 ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
188 int flags);
189 };
190
191 /*
192 * Data structure received from lttng client to session daemon.
193 */
194 struct lttcomm_session_msg {
195 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
196 struct lttng_session session;
197 struct lttng_domain domain;
198 union {
199 struct {
200 char channel_name[LTTNG_SYMBOL_NAME_LEN];
201 char name[NAME_MAX];
202 } LTTNG_PACKED disable;
203 /* Event data */
204 struct {
205 char channel_name[LTTNG_SYMBOL_NAME_LEN];
206 struct lttng_event event;
207 /* Length of following bytecode for filter. */
208 uint32_t bytecode_len;
209 } LTTNG_PACKED enable;
210 /* Create channel */
211 struct {
212 struct lttng_channel chan;
213 } LTTNG_PACKED channel;
214 /* Context */
215 struct {
216 char channel_name[LTTNG_SYMBOL_NAME_LEN];
217 struct lttng_event_context ctx;
218 } LTTNG_PACKED context;
219 /* Use by register_consumer */
220 struct {
221 char path[PATH_MAX];
222 } LTTNG_PACKED reg;
223 /* List */
224 struct {
225 char channel_name[LTTNG_SYMBOL_NAME_LEN];
226 } LTTNG_PACKED list;
227 struct lttng_calibrate calibrate;
228 /* Used by the set_consumer_url and used by create_session also call */
229 struct {
230 /* Number of lttng_uri following */
231 uint32_t size;
232 } LTTNG_PACKED uri;
233 } u;
234 } LTTNG_PACKED;
235
236 #define LTTNG_FILTER_MAX_LEN 65536
237
238 /*
239 * Filter bytecode data. The reloc table is located at the end of the
240 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
241 * starts at reloc_table_offset.
242 */
243 #define LTTNG_FILTER_PADDING 32
244 struct lttng_filter_bytecode {
245 uint32_t len; /* len of data */
246 uint32_t reloc_table_offset;
247 uint64_t seqnum;
248 char padding[LTTNG_FILTER_PADDING];
249 char data[0];
250 } LTTNG_PACKED;
251
252 /*
253 * Data structure for the response from sessiond to the lttng client.
254 */
255 struct lttcomm_lttng_msg {
256 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
257 uint32_t ret_code; /* enum lttcomm_return_code */
258 uint32_t pid; /* pid_t */
259 uint32_t data_size;
260 /* Contains: trace_name + data */
261 char payload[];
262 } LTTNG_PACKED;
263
264 struct lttcomm_health_msg {
265 uint32_t component;
266 uint32_t cmd;
267 } LTTNG_PACKED;
268
269 struct lttcomm_health_data {
270 uint32_t ret_code;
271 } LTTNG_PACKED;
272
273 /*
274 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
275 * to either add a channel, add a stream, update a stream, or stop
276 * operation.
277 */
278 struct lttcomm_consumer_msg {
279 uint32_t cmd_type; /* enum consumerd_command */
280 union {
281 struct {
282 uint64_t channel_key;
283 uint64_t session_id;
284 char pathname[PATH_MAX];
285 uint32_t uid;
286 uint32_t gid;
287 uint64_t relayd_id;
288 /* nb_init_streams is the number of streams open initially. */
289 uint32_t nb_init_streams;
290 char name[LTTNG_SYMBOL_NAME_LEN];
291 /* Use splice or mmap to consume this fd */
292 enum lttng_event_output output;
293 int type; /* Per cpu or metadata. */
294 } LTTNG_PACKED channel; /* Only used by Kernel. */
295 struct {
296 uint64_t stream_key;
297 uint64_t channel_key;
298 int32_t cpu; /* On which CPU this stream is assigned. */
299 } LTTNG_PACKED stream; /* Only used by Kernel. */
300 struct {
301 uint64_t net_index;
302 enum lttng_stream_type type;
303 /* Open socket to the relayd */
304 struct lttcomm_sock sock;
305 /* Tracing session id associated to the relayd. */
306 uint64_t session_id;
307 } LTTNG_PACKED relayd_sock;
308 struct {
309 uint64_t net_seq_idx;
310 } LTTNG_PACKED destroy_relayd;
311 struct {
312 uint64_t session_id;
313 } LTTNG_PACKED data_pending;
314 struct {
315 uint64_t subbuf_size; /* bytes */
316 uint64_t num_subbuf; /* power of 2 */
317 int32_t overwrite; /* 1: overwrite, 0: discard */
318 uint32_t switch_timer_interval; /* usec */
319 uint32_t read_timer_interval; /* usec */
320 int32_t output; /* splice, mmap */
321 int32_t type; /* metadata or per_cpu */
322 uint64_t session_id; /* Tracing session id */
323 char pathname[PATH_MAX]; /* Channel file path. */
324 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
325 uint32_t uid; /* User ID of the session */
326 uint32_t gid; /* Group ID ot the session */
327 uint64_t relayd_id; /* Relayd id if apply. */
328 uint64_t key; /* Unique channel key. */
329 unsigned char uuid[UUID_STR_LEN]; /* uuid for ust tracer. */
330 uint32_t chan_id; /* Channel ID on the tracer side. */
331 } LTTNG_PACKED ask_channel;
332 struct {
333 uint64_t key;
334 } LTTNG_PACKED get_channel;
335 struct {
336 uint64_t key;
337 } LTTNG_PACKED destroy_channel;
338 struct {
339 uint64_t key; /* Metadata channel key. */
340 uint64_t target_offset; /* Offset in the consumer */
341 uint64_t len; /* Length of metadata to be received. */
342 } LTTNG_PACKED push_metadata;
343 struct {
344 uint64_t key; /* Metadata channel key. */
345 } LTTNG_PACKED close_metadata;
346 struct {
347 uint64_t key; /* Metadata channel key. */
348 } LTTNG_PACKED setup_metadata;
349 struct {
350 uint64_t key; /* Channel key. */
351 } LTTNG_PACKED flush_channel;
352 } u;
353 } LTTNG_PACKED;
354
355 /*
356 * Status message returned to the sessiond after a received command.
357 */
358 struct lttcomm_consumer_status_msg {
359 enum lttng_error_code ret_code;
360 } LTTNG_PACKED;
361
362 struct lttcomm_consumer_status_channel {
363 enum lttng_error_code ret_code;
364 uint64_t key;
365 unsigned int stream_count;
366 } LTTNG_PACKED;
367
368 #ifdef HAVE_LIBLTTNG_UST_CTL
369
370 #include <lttng/ust-abi.h>
371
372 /*
373 * Data structure for the commands sent from sessiond to UST.
374 */
375 struct lttcomm_ust_msg {
376 uint32_t handle;
377 uint32_t cmd;
378 union {
379 struct lttng_ust_channel channel;
380 struct lttng_ust_stream stream;
381 struct lttng_ust_event event;
382 struct lttng_ust_context context;
383 struct lttng_ust_tracer_version version;
384 } u;
385 } LTTNG_PACKED;
386
387 /*
388 * Data structure for the response from UST to the session daemon.
389 * cmd_type is sent back in the reply for validation.
390 */
391 struct lttcomm_ust_reply {
392 uint32_t handle;
393 uint32_t cmd;
394 uint32_t ret_code; /* enum lttcomm_return_code */
395 uint32_t ret_val; /* return value */
396 union {
397 struct {
398 uint64_t memory_map_size;
399 } LTTNG_PACKED channel;
400 struct {
401 uint64_t memory_map_size;
402 } LTTNG_PACKED stream;
403 struct lttng_ust_tracer_version version;
404 } u;
405 } LTTNG_PACKED;
406
407 #endif /* HAVE_LIBLTTNG_UST_CTL */
408
409 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
410
411 extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
412 const char *ip, unsigned int port);
413 extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
414 const char *ip, unsigned int port);
415
416 extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
417 extern int lttcomm_create_sock(struct lttcomm_sock *sock);
418 extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
419 extern void lttcomm_destroy_sock(struct lttcomm_sock *sock);
420 extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
421 extern void lttcomm_copy_sock(struct lttcomm_sock *dst,
422 struct lttcomm_sock *src);
423
424 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.053979 seconds and 4 git commands to generate.