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