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