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