cbb79821d5f42b917c2195c48e283c36eda2bef6
[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 #include <limits.h>
29 #include <lttng/lttng.h>
30 #include <lttng/snapshot-internal.h>
31 #include <lttng/save-internal.h>
32 #include <lttng/channel-internal.h>
33 #include <lttng/trigger/trigger-internal.h>
34 #include <lttng/rotate-internal.h>
35 #include <common/compat/socket.h>
36 #include <common/uri.h>
37 #include <common/defaults.h>
38 #include <common/uuid.h>
39 #include <common/macros.h>
40 #include <common/optional.h>
41
42 #include <arpa/inet.h>
43 #include <netinet/in.h>
44 #include <sys/un.h>
45
46 #include "inet.h"
47 #include "inet6.h"
48 #include <common/unix.h>
49
50 /* Queue size of listen(2) */
51 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
52
53 /* Maximum number of FDs that can be sent over a Unix socket */
54 #define LTTCOMM_MAX_SEND_FDS 4
55
56 /*
57 * Get the error code index from 0 since LTTCOMM_OK start at 1000
58 */
59 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_CONSUMERD_COMMAND_SOCK_READY)
60
61 enum lttcomm_sessiond_command {
62 /* Tracer command */
63 LTTNG_ADD_CONTEXT = 0,
64 /* LTTNG_CALIBRATE used to be here */
65 LTTNG_DISABLE_CHANNEL = 2,
66 LTTNG_DISABLE_EVENT = 3,
67 LTTNG_LIST_SYSCALLS = 4,
68 LTTNG_ENABLE_CHANNEL = 5,
69 LTTNG_ENABLE_EVENT = 6,
70 /* 7 */
71 /* Session daemon command */
72 /* 8 */
73 LTTNG_DESTROY_SESSION = 9,
74 LTTNG_LIST_CHANNELS = 10,
75 LTTNG_LIST_DOMAINS = 11,
76 LTTNG_LIST_EVENTS = 12,
77 LTTNG_LIST_SESSIONS = 13,
78 LTTNG_LIST_TRACEPOINTS = 14,
79 LTTNG_REGISTER_CONSUMER = 15,
80 LTTNG_START_TRACE = 16,
81 LTTNG_STOP_TRACE = 17,
82 LTTNG_LIST_TRACEPOINT_FIELDS = 18,
83
84 /* Consumer */
85 LTTNG_DISABLE_CONSUMER = 19,
86 LTTNG_ENABLE_CONSUMER = 20,
87 LTTNG_SET_CONSUMER_URI = 21,
88 /* 22 */
89 /* 23 */
90 LTTNG_DATA_PENDING = 24,
91 LTTNG_SNAPSHOT_ADD_OUTPUT = 25,
92 LTTNG_SNAPSHOT_DEL_OUTPUT = 26,
93 LTTNG_SNAPSHOT_LIST_OUTPUT = 27,
94 LTTNG_SNAPSHOT_RECORD = 28,
95 /* 29 */
96 /* 30 */
97 LTTNG_SAVE_SESSION = 31,
98 LTTNG_TRACK_PID = 32,
99 LTTNG_UNTRACK_PID = 33,
100 LTTNG_LIST_TRACKER_PIDS = 34,
101 LTTNG_SET_SESSION_SHM_PATH = 40,
102 LTTNG_REGENERATE_METADATA = 41,
103 LTTNG_REGENERATE_STATEDUMP = 42,
104 LTTNG_REGISTER_TRIGGER = 43,
105 LTTNG_UNREGISTER_TRIGGER = 44,
106 LTTNG_ROTATE_SESSION = 45,
107 LTTNG_ROTATION_GET_INFO = 46,
108 LTTNG_ROTATION_SET_SCHEDULE = 47,
109 LTTNG_SESSION_LIST_ROTATION_SCHEDULES = 48,
110 LTTNG_CREATE_SESSION_EXT = 49,
111 LTTNG_CLEAR_SESSION = 50,
112 };
113
114 enum lttcomm_relayd_command {
115 RELAYD_ADD_STREAM = 1,
116 RELAYD_CREATE_SESSION = 2,
117 RELAYD_START_DATA = 3,
118 RELAYD_UPDATE_SYNC_INFO = 4,
119 RELAYD_VERSION = 5,
120 RELAYD_SEND_METADATA = 6,
121 RELAYD_CLOSE_STREAM = 7,
122 RELAYD_DATA_PENDING = 8,
123 RELAYD_QUIESCENT_CONTROL = 9,
124 RELAYD_BEGIN_DATA_PENDING = 10,
125 RELAYD_END_DATA_PENDING = 11,
126 RELAYD_ADD_INDEX = 12,
127 RELAYD_SEND_INDEX = 13,
128 RELAYD_CLOSE_INDEX = 14,
129 /* Live-reading commands (2.4+). */
130 RELAYD_LIST_SESSIONS = 15,
131 /* All streams of the channel have been sent to the relayd (2.4+). */
132 RELAYD_STREAMS_SENT = 16,
133 /* Ask the relay to reset the metadata trace file (2.8+) */
134 RELAYD_RESET_METADATA = 17,
135 /* Ask the relay to rotate a set of stream files (2.11+) */
136 RELAYD_ROTATE_STREAMS = 18,
137 /* Ask the relay to create a trace chunk (2.11+) */
138 RELAYD_CREATE_TRACE_CHUNK = 19,
139 /* Ask the relay to close a trace chunk (2.11+) */
140 RELAYD_CLOSE_TRACE_CHUNK = 20,
141 /* Ask the relay whether a trace chunk exists (2.11+) */
142 RELAYD_TRACE_CHUNK_EXISTS = 21,
143 };
144
145 /*
146 * lttcomm error code.
147 */
148 enum lttcomm_return_code {
149 LTTCOMM_CONSUMERD_SUCCESS = 0, /* Everything went fine. */
150 /*
151 * Some code paths use -1 to express an error, others
152 * negate this consumer return code. Starting codes at
153 * 100 ensures there is no mix-up between this error value
154 * and legitimate status codes.
155 */
156 LTTCOMM_CONSUMERD_COMMAND_SOCK_READY = 100, /* Command socket ready */
157 LTTCOMM_CONSUMERD_SUCCESS_RECV_FD, /* Success on receiving fds */
158 LTTCOMM_CONSUMERD_ERROR_RECV_FD, /* Error on receiving fds */
159 LTTCOMM_CONSUMERD_ERROR_RECV_CMD, /* Error on receiving command */
160 LTTCOMM_CONSUMERD_POLL_ERROR, /* Error in polling thread */
161 LTTCOMM_CONSUMERD_POLL_NVAL, /* Poll on closed fd */
162 LTTCOMM_CONSUMERD_POLL_HUP, /* All fds have hungup */
163 LTTCOMM_CONSUMERD_EXIT_SUCCESS, /* Consumerd exiting normally */
164 LTTCOMM_CONSUMERD_EXIT_FAILURE, /* Consumerd exiting on error */
165 LTTCOMM_CONSUMERD_OUTFD_ERROR, /* Error opening the tracefile */
166 LTTCOMM_CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
167 LTTCOMM_CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
168 LTTCOMM_CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
169 LTTCOMM_CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
170 LTTCOMM_CONSUMERD_ENOMEM, /* Consumer is out of memory */
171 LTTCOMM_CONSUMERD_ERROR_METADATA, /* Error with metadata. */
172 LTTCOMM_CONSUMERD_FATAL, /* Fatal error. */
173 LTTCOMM_CONSUMERD_RELAYD_FAIL, /* Error on remote relayd */
174 LTTCOMM_CONSUMERD_CHANNEL_FAIL, /* Channel creation failed. */
175 LTTCOMM_CONSUMERD_CHAN_NOT_FOUND, /* Channel not found. */
176 LTTCOMM_CONSUMERD_ALREADY_SET, /* Resource already set. */
177 LTTCOMM_CONSUMERD_ROTATION_FAIL, /* Rotation has failed. */
178 LTTCOMM_CONSUMERD_SNAPSHOT_FAILED, /* snapshot has failed. */
179 LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED,/* Trace chunk creation failed. */
180 LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED, /* Trace chunk creation failed. */
181 LTTCOMM_CONSUMERD_INVALID_PARAMETERS, /* Invalid parameters. */
182 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL, /* Trace chunk exists on consumer daemon. */
183 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE,/* Trace chunk exists on relay daemon. */
184 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK, /* Unknown trace chunk. */
185
186 /* MUST be last element */
187 LTTCOMM_NR, /* Last element */
188 };
189
190 /* lttng socket protocol. */
191 enum lttcomm_sock_proto {
192 LTTCOMM_SOCK_UDP,
193 LTTCOMM_SOCK_TCP,
194 };
195
196 /*
197 * Index in the net_families array below. Please keep in sync!
198 */
199 enum lttcomm_sock_domain {
200 LTTCOMM_INET = 0,
201 LTTCOMM_INET6 = 1,
202 };
203
204 enum lttcomm_metadata_command {
205 LTTCOMM_METADATA_REQUEST = 1,
206 };
207
208 /*
209 * Commands sent from the consumerd to the sessiond to request if new metadata
210 * is available. This message is used to find the per UID _or_ per PID registry
211 * for the channel key. For per UID lookup, the triplet
212 * bits_per_long/uid/session_id is used. On lookup failure, we search for the
213 * per PID registry indexed by session id ignoring the other values.
214 */
215 struct lttcomm_metadata_request_msg {
216 uint64_t session_id; /* Tracing session id */
217 uint64_t session_id_per_pid; /* Tracing session id for per-pid */
218 uint32_t bits_per_long; /* Consumer ABI */
219 uint32_t uid;
220 uint64_t key; /* Metadata channel key. */
221 } LTTNG_PACKED;
222
223 struct lttcomm_sockaddr {
224 enum lttcomm_sock_domain type;
225 union {
226 struct sockaddr_in sin;
227 struct sockaddr_in6 sin6;
228 } addr;
229 } LTTNG_PACKED;
230
231 struct lttcomm_sock {
232 int32_t fd;
233 enum lttcomm_sock_proto proto;
234 struct lttcomm_sockaddr sockaddr;
235 const struct lttcomm_proto_ops *ops;
236 } LTTNG_PACKED;
237
238 /*
239 * Relayd sock. Adds the protocol version to use for the communications with
240 * the relayd.
241 */
242 struct lttcomm_relayd_sock {
243 struct lttcomm_sock sock;
244 uint32_t major;
245 uint32_t minor;
246 } LTTNG_PACKED;
247
248 struct lttcomm_net_family {
249 int family;
250 int (*create) (struct lttcomm_sock *sock, int type, int proto);
251 };
252
253 struct lttcomm_proto_ops {
254 int (*bind) (struct lttcomm_sock *sock);
255 int (*close) (struct lttcomm_sock *sock);
256 int (*connect) (struct lttcomm_sock *sock);
257 struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock);
258 int (*listen) (struct lttcomm_sock *sock, int backlog);
259 ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len,
260 int flags);
261 ssize_t (*sendmsg) (struct lttcomm_sock *sock, const void *buf,
262 size_t len, int flags);
263 };
264
265 /*
266 * Data structure received from lttng client to session daemon.
267 */
268 struct lttcomm_session_msg {
269 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
270 struct lttng_session session;
271 struct lttng_domain domain;
272 union {
273 /* Event data */
274 struct {
275 char channel_name[LTTNG_SYMBOL_NAME_LEN];
276 struct lttng_event event LTTNG_PACKED;
277 /* Length of following filter expression. */
278 uint32_t expression_len;
279 /* Length of following bytecode for filter. */
280 uint32_t bytecode_len;
281 /* Exclusion count (fixed-size strings). */
282 uint32_t exclusion_count;
283 /* Userspace probe location size. */
284 uint32_t userspace_probe_location_len;
285 /*
286 * After this structure, the following variable-length
287 * items are transmitted:
288 * - char exclusion_names[LTTNG_SYMBOL_NAME_LEN][exclusion_count]
289 * - char filter_expression[expression_len]
290 * - unsigned char filter_bytecode[bytecode_len]
291 */
292 } LTTNG_PACKED enable;
293 struct {
294 char channel_name[LTTNG_SYMBOL_NAME_LEN];
295 struct lttng_event event LTTNG_PACKED;
296 /* Length of following filter expression. */
297 uint32_t expression_len;
298 /* Length of following bytecode for filter. */
299 uint32_t bytecode_len;
300 /*
301 * After this structure, the following variable-length
302 * items are transmitted:
303 * - unsigned char filter_expression[expression_len]
304 * - unsigned char filter_bytecode[bytecode_len]
305 */
306 } LTTNG_PACKED disable;
307 /* Create channel */
308 struct {
309 struct lttng_channel chan LTTNG_PACKED;
310 /* struct lttng_channel_extended is already packed. */
311 struct lttng_channel_extended extended;
312 } LTTNG_PACKED channel;
313 /* Context */
314 struct {
315 char channel_name[LTTNG_SYMBOL_NAME_LEN];
316 struct lttng_event_context ctx LTTNG_PACKED;
317 uint32_t provider_name_len;
318 uint32_t context_name_len;
319 } LTTNG_PACKED context;
320 /* Use by register_consumer */
321 struct {
322 char path[PATH_MAX];
323 } LTTNG_PACKED reg;
324 /* List */
325 struct {
326 char channel_name[LTTNG_SYMBOL_NAME_LEN];
327 } LTTNG_PACKED list;
328 struct lttng_calibrate calibrate;
329 /* Used by the set_consumer_url and used by create_session also call */
330 struct {
331 /* Number of lttng_uri following */
332 uint32_t size;
333 } LTTNG_PACKED uri;
334 struct {
335 struct lttng_snapshot_output output LTTNG_PACKED;
336 } LTTNG_PACKED snapshot_output;
337 struct {
338 uint32_t wait;
339 struct lttng_snapshot_output output LTTNG_PACKED;
340 } LTTNG_PACKED snapshot_record;
341 struct {
342 uint32_t nb_uri;
343 unsigned int timer_interval; /* usec */
344 } LTTNG_PACKED session_live;
345 struct {
346 struct lttng_save_session_attr attr; /* struct already packed */
347 } LTTNG_PACKED save_session;
348 struct {
349 char shm_path[PATH_MAX];
350 } LTTNG_PACKED set_shm_path;
351 struct {
352 uint32_t pid;
353 } LTTNG_PACKED pid_tracker;
354 struct {
355 uint32_t length;
356 } LTTNG_PACKED trigger;
357 struct {
358 uint64_t rotation_id;
359 } LTTNG_PACKED get_rotation_info;
360 struct {
361 /* enum lttng_rotation_schedule_type */
362 uint8_t type;
363 /*
364 * If set == 1, set schedule to value, if set == 0,
365 * clear this schedule type.
366 */
367 uint8_t set;
368 uint64_t value;
369 } LTTNG_PACKED rotation_set_schedule;
370 struct {
371 /*
372 * Includes the null-terminator.
373 * Must be an absolute path.
374 *
375 * Size bounded by LTTNG_PATH_MAX.
376 */
377 uint16_t home_dir_size;
378 uint64_t session_descriptor_size;
379 /* An lttng_session_descriptor follows. */
380 } LTTNG_PACKED create_session;
381 } u;
382 } LTTNG_PACKED;
383
384 #define LTTNG_FILTER_MAX_LEN 65536
385 #define LTTNG_SESSION_DESCRIPTOR_MAX_LEN 65536
386
387 /*
388 * Filter bytecode data. The reloc table is located at the end of the
389 * bytecode. It is made of tuples: (uint16_t, var. len. string). It
390 * starts at reloc_table_offset.
391 */
392 #define LTTNG_FILTER_PADDING 32
393 struct lttng_filter_bytecode {
394 uint32_t len; /* len of data */
395 uint32_t reloc_table_offset;
396 uint64_t seqnum;
397 char padding[LTTNG_FILTER_PADDING];
398 char data[0];
399 } LTTNG_PACKED;
400
401 /*
402 * Event exclusion data. At the end of the structure, there will actually
403 * by zero or more names, where the actual number of names is given by
404 * the 'count' item of the structure.
405 */
406 #define LTTNG_EVENT_EXCLUSION_PADDING 32
407 struct lttng_event_exclusion {
408 uint32_t count;
409 char padding[LTTNG_EVENT_EXCLUSION_PADDING];
410 char names[0][LTTNG_SYMBOL_NAME_LEN];
411 } LTTNG_PACKED;
412
413 #define LTTNG_EVENT_EXCLUSION_NAME_AT(_exclusion, _i) \
414 (&(_exclusion)->names[_i][0])
415
416 /*
417 * Event command header.
418 */
419 struct lttcomm_event_command_header {
420 /* Number of events */
421 uint32_t nb_events;
422 } LTTNG_PACKED;
423
424 /*
425 * Event extended info header. This is the structure preceding each
426 * extended info data.
427 */
428 struct lttcomm_event_extended_header {
429 /*
430 * Size of filter string immediately following this header.
431 * This size includes the terminal null character.
432 */
433 uint32_t filter_len;
434
435 /*
436 * Number of exclusion names, immediately following the filter
437 * string. Each exclusion name has a fixed length of
438 * LTTNG_SYMBOL_NAME_LEN bytes, including the terminal null
439 * character.
440 */
441 uint32_t nb_exclusions;
442
443 /*
444 * Size of the event's userspace probe location (if applicable).
445 */
446 uint32_t userspace_probe_location_len;
447 } LTTNG_PACKED;
448
449 /*
450 * Command header of the reply to an LTTNG_DESTROY_SESSION command.
451 */
452 struct lttcomm_session_destroy_command_header {
453 /* enum lttng_session */
454 int32_t rotation_state;
455 };
456
457 /*
458 * Data structure for the response from sessiond to the lttng client.
459 */
460 struct lttcomm_lttng_msg {
461 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
462 uint32_t ret_code; /* enum lttcomm_return_code */
463 uint32_t pid; /* pid_t */
464 uint32_t cmd_header_size;
465 uint32_t data_size;
466 } LTTNG_PACKED;
467
468 struct lttcomm_lttng_output_id {
469 uint32_t id;
470 } LTTNG_PACKED;
471
472 /*
473 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
474 * to either add a channel, add a stream, update a stream, or stop
475 * operation.
476 */
477 struct lttcomm_consumer_msg {
478 uint32_t cmd_type; /* enum lttng_consumer_command */
479 union {
480 struct {
481 uint64_t channel_key;
482 uint64_t session_id;
483 /* ID of the session's current trace chunk. */
484 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
485 char pathname[PATH_MAX];
486 uint64_t relayd_id;
487 /* nb_init_streams is the number of streams open initially. */
488 uint32_t nb_init_streams;
489 char name[LTTNG_SYMBOL_NAME_LEN];
490 /* Use splice or mmap to consume this fd */
491 enum lttng_event_output output;
492 int type; /* Per cpu or metadata. */
493 uint64_t tracefile_size; /* bytes */
494 uint32_t tracefile_count; /* number of tracefiles */
495 /* If the channel's streams have to be monitored or not. */
496 uint32_t monitor;
497 /* timer to check the streams usage in live mode (usec). */
498 unsigned int live_timer_interval;
499 /* timer to sample a channel's positions (usec). */
500 unsigned int monitor_timer_interval;
501 } LTTNG_PACKED channel; /* Only used by Kernel. */
502 struct {
503 uint64_t stream_key;
504 uint64_t channel_key;
505 int32_t cpu; /* On which CPU this stream is assigned. */
506 /* Tells the consumer if the stream should be or not monitored. */
507 uint32_t no_monitor;
508 } LTTNG_PACKED stream; /* Only used by Kernel. */
509 struct {
510 uint64_t net_index;
511 enum lttng_stream_type type;
512 /* Open socket to the relayd */
513 struct lttcomm_relayd_sock sock;
514 /* Tracing session id associated to the relayd. */
515 uint64_t session_id;
516 /* Relayd session id, only used with control socket. */
517 uint64_t relayd_session_id;
518 } LTTNG_PACKED relayd_sock;
519 struct {
520 uint64_t net_seq_idx;
521 } LTTNG_PACKED destroy_relayd;
522 struct {
523 uint64_t session_id;
524 } LTTNG_PACKED data_pending;
525 struct {
526 uint64_t subbuf_size; /* bytes */
527 uint64_t num_subbuf; /* power of 2 */
528 int32_t overwrite; /* 1: overwrite, 0: discard */
529 uint32_t switch_timer_interval; /* usec */
530 uint32_t read_timer_interval; /* usec */
531 unsigned int live_timer_interval; /* usec */
532 uint32_t monitor_timer_interval; /* usec */
533 int32_t output; /* splice, mmap */
534 int32_t type; /* metadata or per_cpu */
535 uint64_t session_id; /* Tracing session id */
536 char pathname[PATH_MAX]; /* Channel file path. */
537 char name[LTTNG_SYMBOL_NAME_LEN]; /* Channel name. */
538 /* Credentials used to open the UST buffer shared mappings. */
539 struct {
540 uint32_t uid;
541 uint32_t gid;
542 } LTTNG_PACKED buffer_credentials;
543 uint64_t relayd_id; /* Relayd id if apply. */
544 uint64_t key; /* Unique channel key. */
545 /* ID of the session's current trace chunk. */
546 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED chunk_id;
547 unsigned char uuid[LTTNG_UUID_LEN]; /* uuid for ust tracer. */
548 uint32_t chan_id; /* Channel ID on the tracer side. */
549 uint64_t tracefile_size; /* bytes */
550 uint32_t tracefile_count; /* number of tracefiles */
551 uint64_t session_id_per_pid; /* Per-pid session ID. */
552 /* Tells the consumer if the stream should be or not monitored. */
553 uint32_t monitor;
554 /*
555 * For UST per UID buffers, this is the application UID of the
556 * channel. This can be different from the user UID requesting the
557 * channel creation and used for the rights on the stream file
558 * because the application can be in the tracing for instance.
559 */
560 uint32_t ust_app_uid;
561 int64_t blocking_timeout;
562 char root_shm_path[PATH_MAX];
563 char shm_path[PATH_MAX];
564 } LTTNG_PACKED ask_channel;
565 struct {
566 uint64_t key;
567 } LTTNG_PACKED get_channel;
568 struct {
569 uint64_t key;
570 } LTTNG_PACKED destroy_channel;
571 struct {
572 uint64_t key; /* Metadata channel key. */
573 uint64_t target_offset; /* Offset in the consumer */
574 uint64_t len; /* Length of metadata to be received. */
575 uint64_t version; /* Version of the metadata. */
576 } LTTNG_PACKED push_metadata;
577 struct {
578 uint64_t key; /* Metadata channel key. */
579 } LTTNG_PACKED close_metadata;
580 struct {
581 uint64_t key; /* Metadata channel key. */
582 } LTTNG_PACKED setup_metadata;
583 struct {
584 uint64_t key; /* Channel key. */
585 } LTTNG_PACKED flush_channel;
586 struct {
587 uint64_t key; /* Channel key. */
588 } LTTNG_PACKED clear_quiescent_channel;
589 struct {
590 char pathname[PATH_MAX];
591 /* Indicate if the snapshot goes on the relayd or locally. */
592 uint32_t use_relayd;
593 uint32_t metadata; /* This a metadata snapshot. */
594 uint64_t relayd_id; /* Relayd id if apply. */
595 uint64_t key;
596 uint64_t nb_packets_per_stream;
597 } LTTNG_PACKED snapshot_channel;
598 struct {
599 uint64_t channel_key;
600 uint64_t net_seq_idx;
601 } LTTNG_PACKED sent_streams;
602 struct {
603 uint64_t session_id;
604 uint64_t channel_key;
605 } LTTNG_PACKED discarded_events;
606 struct {
607 uint64_t session_id;
608 uint64_t channel_key;
609 } LTTNG_PACKED lost_packets;
610 struct {
611 uint64_t session_id;
612 } LTTNG_PACKED regenerate_metadata;
613 struct {
614 uint32_t metadata; /* This is a metadata channel. */
615 uint64_t relayd_id; /* Relayd id if apply. */
616 uint64_t key;
617 } LTTNG_PACKED rotate_channel;
618 struct {
619 uint64_t session_id;
620 uint64_t chunk_id;
621 } LTTNG_PACKED check_rotation_pending_local;
622 struct {
623 uint64_t relayd_id;
624 uint64_t session_id;
625 uint64_t chunk_id;
626 } LTTNG_PACKED check_rotation_pending_relay;
627 struct {
628 /*
629 * Relayd id, if applicable (remote).
630 *
631 * A directory file descriptor referring to the chunk's
632 * output folder is transmitted if the chunk is local
633 * (relayd_id unset).
634 *
635 * `override_name` is left NULL (all-zeroes) if the
636 * chunk's name is not overridden.
637 */
638 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
639 char override_name[LTTNG_NAME_MAX];
640 uint64_t session_id;
641 uint64_t chunk_id;
642 uint64_t creation_timestamp;
643 LTTNG_OPTIONAL_COMM(struct {
644 uint32_t uid;
645 uint32_t gid;
646 } LTTNG_PACKED ) LTTNG_PACKED credentials;
647 } LTTNG_PACKED create_trace_chunk;
648 struct {
649 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
650 uint64_t session_id;
651 uint64_t chunk_id;
652 uint64_t close_timestamp;
653 /* enum lttng_trace_chunk_command_type */
654 LTTNG_OPTIONAL_COMM(uint32_t) LTTNG_PACKED close_command;
655 } LTTNG_PACKED close_trace_chunk;
656 struct {
657 LTTNG_OPTIONAL_COMM(uint64_t) LTTNG_PACKED relayd_id;
658 uint64_t session_id;
659 uint64_t chunk_id;
660 } LTTNG_PACKED trace_chunk_exists;
661 struct {
662 lttng_uuid sessiond_uuid;
663 } LTTNG_PACKED init;
664 } u;
665 } LTTNG_PACKED;
666
667 /*
668 * Channel monitoring message returned to the session daemon on every
669 * monitor timer expiration.
670 */
671 struct lttcomm_consumer_channel_monitor_msg {
672 /* Key of the sampled channel. */
673 uint64_t key;
674 /*
675 * Lowest and highest usage (bytes) at the moment the sample was taken.
676 */
677 uint64_t lowest, highest;
678 /*
679 * Sum of all the consumed positions for a channel.
680 */
681 uint64_t total_consumed;
682 } LTTNG_PACKED;
683
684 /*
685 * Status message returned to the sessiond after a received command.
686 */
687 struct lttcomm_consumer_status_msg {
688 enum lttcomm_return_code ret_code;
689 } LTTNG_PACKED;
690
691 struct lttcomm_consumer_status_channel {
692 enum lttcomm_return_code ret_code;
693 uint64_t key;
694 unsigned int stream_count;
695 } LTTNG_PACKED;
696
697 struct lttcomm_consumer_close_trace_chunk_reply {
698 enum lttcomm_return_code ret_code;
699 uint32_t path_length;
700 char path[];
701 };
702
703 #ifdef HAVE_LIBLTTNG_UST_CTL
704
705 #include <lttng/ust-abi.h>
706
707 /*
708 * Data structure for the commands sent from sessiond to UST.
709 */
710 struct lttcomm_ust_msg {
711 uint32_t handle;
712 uint32_t cmd;
713 union {
714 struct lttng_ust_channel channel;
715 struct lttng_ust_stream stream;
716 struct lttng_ust_event event;
717 struct lttng_ust_context context;
718 struct lttng_ust_tracer_version version;
719 } u;
720 } LTTNG_PACKED;
721
722 /*
723 * Data structure for the response from UST to the session daemon.
724 * cmd_type is sent back in the reply for validation.
725 */
726 struct lttcomm_ust_reply {
727 uint32_t handle;
728 uint32_t cmd;
729 uint32_t ret_code; /* enum lttcomm_return_code */
730 uint32_t ret_val; /* return value */
731 union {
732 struct {
733 uint64_t memory_map_size;
734 } LTTNG_PACKED channel;
735 struct {
736 uint64_t memory_map_size;
737 } LTTNG_PACKED stream;
738 struct lttng_ust_tracer_version version;
739 } u;
740 } LTTNG_PACKED;
741
742 #endif /* HAVE_LIBLTTNG_UST_CTL */
743
744 LTTNG_HIDDEN const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
745
746 LTTNG_HIDDEN int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
747 const char *ip, unsigned int port);
748 LTTNG_HIDDEN int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
749 const char *ip, unsigned int port);
750
751 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto);
752 LTTNG_HIDDEN int lttcomm_create_sock(struct lttcomm_sock *sock);
753 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri);
754 LTTNG_HIDDEN void lttcomm_destroy_sock(struct lttcomm_sock *sock);
755 LTTNG_HIDDEN struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src);
756 LTTNG_HIDDEN void lttcomm_copy_sock(struct lttcomm_sock *dst,
757 struct lttcomm_sock *src);
758
759 /* Relayd socket object. */
760 LTTNG_HIDDEN struct lttcomm_relayd_sock *lttcomm_alloc_relayd_sock(
761 struct lttng_uri *uri, uint32_t major, uint32_t minor);
762
763 LTTNG_HIDDEN int lttcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
764 LTTNG_HIDDEN int lttcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
765
766 LTTNG_HIDDEN int lttcomm_sock_get_port(const struct lttcomm_sock *sock,
767 uint16_t *port);
768 /*
769 * Set a port to an lttcomm_sock. This will have no effect is the socket is
770 * already bound.
771 */
772 LTTNG_HIDDEN int lttcomm_sock_set_port(struct lttcomm_sock *sock, uint16_t port);
773
774 LTTNG_HIDDEN void lttcomm_init(void);
775 /* Get network timeout, in milliseconds */
776 LTTNG_HIDDEN unsigned long lttcomm_get_network_timeout(void);
777
778 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.070967 seconds and 3 git commands to generate.