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