clang-format: specify bitfield spacing to fit with the existing code
[lttng-tools.git] / src / common / consumer / consumer.hpp
... / ...
CommitLineData
1/*
2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
5 * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * SPDX-License-Identifier: GPL-2.0-only
8 *
9 */
10
11#ifndef LIB_CONSUMER_H
12#define LIB_CONSUMER_H
13
14#include <limits.h>
15#include <poll.h>
16#include <stdint.h>
17#include <unistd.h>
18#include <urcu/list.h>
19
20#include <lttng/lttng.h>
21
22#include <common/hashtable/hashtable.hpp>
23#include <common/compat/fcntl.hpp>
24#include <common/uuid.hpp>
25#include <common/sessiond-comm/sessiond-comm.hpp>
26#include <common/pipe.hpp>
27#include <common/index/ctf-index.hpp>
28#include <common/trace-chunk-registry.hpp>
29#include <common/credentials.hpp>
30#include <common/buffer-view.hpp>
31#include <common/dynamic-array.hpp>
32
33struct lttng_consumer_local_data;
34
35/* Commands for consumer */
36enum lttng_consumer_command {
37 LTTNG_CONSUMER_ADD_CHANNEL,
38 LTTNG_CONSUMER_ADD_STREAM,
39 /* pause, delete, active depending on fd state */
40 LTTNG_CONSUMER_UPDATE_STREAM,
41 /* inform the consumer to quit when all fd has hang up */
42 LTTNG_CONSUMER_STOP, /* deprecated */
43 LTTNG_CONSUMER_ADD_RELAYD_SOCKET,
44 /* Inform the consumer to kill a specific relayd connection */
45 LTTNG_CONSUMER_DESTROY_RELAYD,
46 /* Return to the sessiond if there is data pending for a session */
47 LTTNG_CONSUMER_DATA_PENDING,
48 /* Consumer creates a channel and returns it to sessiond. */
49 LTTNG_CONSUMER_ASK_CHANNEL_CREATION,
50 LTTNG_CONSUMER_GET_CHANNEL,
51 LTTNG_CONSUMER_DESTROY_CHANNEL,
52 LTTNG_CONSUMER_PUSH_METADATA,
53 LTTNG_CONSUMER_CLOSE_METADATA,
54 LTTNG_CONSUMER_SETUP_METADATA,
55 LTTNG_CONSUMER_FLUSH_CHANNEL,
56 LTTNG_CONSUMER_SNAPSHOT_CHANNEL,
57 LTTNG_CONSUMER_SNAPSHOT_METADATA,
58 LTTNG_CONSUMER_STREAMS_SENT,
59 LTTNG_CONSUMER_DISCARDED_EVENTS,
60 LTTNG_CONSUMER_LOST_PACKETS,
61 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL,
62 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE,
63 LTTNG_CONSUMER_ROTATE_CHANNEL,
64 LTTNG_CONSUMER_INIT,
65 LTTNG_CONSUMER_CREATE_TRACE_CHUNK,
66 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK,
67 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS,
68 LTTNG_CONSUMER_CLEAR_CHANNEL,
69 LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS,
70};
71
72enum lttng_consumer_type {
73 LTTNG_CONSUMER_UNKNOWN = 0,
74 LTTNG_CONSUMER_KERNEL,
75 LTTNG_CONSUMER64_UST,
76 LTTNG_CONSUMER32_UST,
77};
78
79enum consumer_endpoint_status {
80 CONSUMER_ENDPOINT_ACTIVE,
81 CONSUMER_ENDPOINT_INACTIVE,
82};
83
84enum consumer_channel_output {
85 CONSUMER_CHANNEL_MMAP = 0,
86 CONSUMER_CHANNEL_SPLICE = 1,
87};
88
89enum consumer_channel_type {
90 CONSUMER_CHANNEL_TYPE_METADATA = 0,
91 CONSUMER_CHANNEL_TYPE_DATA = 1,
92};
93
94enum sync_metadata_status {
95 SYNC_METADATA_STATUS_NEW_DATA,
96 SYNC_METADATA_STATUS_NO_DATA,
97 SYNC_METADATA_STATUS_ERROR,
98};
99
100extern struct lttng_consumer_global_data the_consumer_data;
101
102struct stream_list {
103 struct cds_list_head head;
104 unsigned int count;
105};
106
107/* Stub. */
108struct consumer_metadata_cache;
109
110struct lttng_consumer_channel {
111 /* Is the channel published in the channel hash tables? */
112 bool is_published;
113 /*
114 * Was the channel deleted (logically) and waiting to be reclaimed?
115 * If this flag is set, no modification that is not cleaned-up by the
116 * RCU reclamation callback should be made
117 */
118 bool is_deleted;
119 /* HT node used for consumer_data.channel_ht */
120 struct lttng_ht_node_u64 node;
121 /* HT node used for consumer_data.channels_by_session_id_ht */
122 struct lttng_ht_node_u64 channels_by_session_id_ht_node;
123 /* Indexed key. Incremented value in the consumer. */
124 uint64_t key;
125 /* Number of streams referencing this channel */
126 int refcount;
127 /* Tracing session id on the session daemon side. */
128 uint64_t session_id;
129 /* Current trace chunk of the session in which this channel exists. */
130 struct lttng_trace_chunk *trace_chunk;
131 /*
132 * Session id when requesting metadata to the session daemon for
133 * a session with per-PID buffers.
134 */
135 uint64_t session_id_per_pid;
136 /*
137 * In the case of local streams, this field contains the channel's
138 * output path; a path relative to the session's output path.
139 * e.g. ust/uid/1000/64-bit
140 *
141 * In the case of remote streams, the contents of this field depends
142 * on the version of the relay daemon peer. For 2.11+ peers, the
143 * contents are the same as in the local case. However, for legacy
144 * peers, this contains a path of the form:
145 * /hostname/session_path/ust/uid/1000/64-bit
146 */
147 char pathname[PATH_MAX];
148 /* Channel name. */
149 char name[LTTNG_SYMBOL_NAME_LEN];
150 /* Relayd id of the channel. -1ULL if it does not apply. */
151 uint64_t relayd_id;
152 /*
153 * Number of streams NOT initialized yet. This is used in order to not
154 * delete this channel if streams are getting initialized.
155 */
156 unsigned int nb_init_stream_left;
157 /* Output type (mmap or splice). */
158 enum consumer_channel_output output;
159 /* Channel type for stream */
160 enum consumer_channel_type type;
161
162 /* For UST */
163 uid_t ust_app_uid; /* Application UID. */
164 struct lttng_ust_ctl_consumer_channel *uchan;
165 unsigned char uuid[LTTNG_UUID_STR_LEN];
166 /*
167 * Temporary stream list used to store the streams once created and waiting
168 * to be sent to the session daemon by receiving the
169 * LTTNG_CONSUMER_GET_CHANNEL.
170 */
171 struct stream_list streams;
172
173 /*
174 * Set if the channel is metadata. We keep a reference to the stream
175 * because we have to flush data once pushed by the session daemon. For a
176 * regular channel, this is always set to NULL.
177 */
178 struct lttng_consumer_stream *metadata_stream;
179
180 /* for UST */
181 int wait_fd;
182 /* Node within channel thread ht */
183 struct lttng_ht_node_u64 wait_fd_node;
184
185 /* Metadata cache is metadata channel */
186 struct consumer_metadata_cache *metadata_cache;
187
188 /* For UST metadata periodical flush */
189 int switch_timer_enabled;
190 timer_t switch_timer;
191 int switch_timer_error;
192
193 /* For the live mode */
194 int live_timer_enabled;
195 timer_t live_timer;
196 int live_timer_error;
197 /* Channel is part of a live session ? */
198 bool is_live;
199
200 /* For channel monitoring timer. */
201 int monitor_timer_enabled;
202 timer_t monitor_timer;
203
204 /* On-disk circular buffer */
205 uint64_t tracefile_size;
206 uint64_t tracefile_count;
207 /*
208 * Monitor or not the streams of this channel meaning this indicates if the
209 * streams should be sent to the data/metadata thread or added to the no
210 * monitor list of the channel.
211 */
212 unsigned int monitor;
213
214 /*
215 * Channel lock.
216 *
217 * This lock protects against concurrent update of channel.
218 *
219 * This is nested INSIDE the consumer data lock.
220 * This is nested OUTSIDE the channel timer lock.
221 * This is nested OUTSIDE the metadata cache lock.
222 * This is nested OUTSIDE stream lock.
223 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
224 */
225 pthread_mutex_t lock;
226
227 /*
228 * Channel teardown lock.
229 *
230 * This lock protect against teardown of channel. It is _never_
231 * taken by the timer handler.
232 *
233 * This is nested INSIDE the consumer data lock.
234 * This is nested INSIDE the channel lock.
235 * This is nested OUTSIDE the metadata cache lock.
236 * This is nested OUTSIDE stream lock.
237 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
238 */
239 pthread_mutex_t timer_lock;
240
241 /* Timer value in usec for live streaming. */
242 unsigned int live_timer_interval;
243
244 int *stream_fds;
245 int nr_stream_fds;
246 char root_shm_path[PATH_MAX];
247 char shm_path[PATH_MAX];
248 /* Only set for UST channels. */
249 LTTNG_OPTIONAL(struct lttng_credentials) buffer_credentials;
250 /* Total number of discarded events for that channel. */
251 uint64_t discarded_events;
252 /* Total number of missed packets due to overwriting (overwrite). */
253 uint64_t lost_packets;
254
255 bool streams_sent_to_relayd;
256 uint64_t last_consumed_size_sample_sent;
257};
258
259struct stream_subbuffer {
260 union {
261 /*
262 * CONSUMER_CHANNEL_SPLICE
263 * No ownership assumed.
264 */
265 int fd;
266 /* CONSUMER_CHANNEL_MMAP */
267 struct lttng_buffer_view buffer;
268 } buffer;
269 union {
270 /*
271 * Common members are fine to access through either
272 * union entries (as per C11, Common Initial Sequence).
273 */
274 struct {
275 unsigned long subbuf_size;
276 unsigned long padded_subbuf_size;
277 uint64_t version;
278 /*
279 * Left unset when unsupported.
280 *
281 * Indicates that this is the last sub-buffer of
282 * a series of sub-buffer that makes-up a coherent
283 * (parseable) unit of metadata.
284 */
285 LTTNG_OPTIONAL(bool) coherent;
286 } metadata;
287 struct {
288 unsigned long subbuf_size;
289 unsigned long padded_subbuf_size;
290 uint64_t packet_size;
291 uint64_t content_size;
292 uint64_t timestamp_begin;
293 uint64_t timestamp_end;
294 uint64_t events_discarded;
295 /* Left unset when unsupported. */
296 LTTNG_OPTIONAL(uint64_t) sequence_number;
297 uint64_t stream_id;
298 /* Left unset when unsupported. */
299 LTTNG_OPTIONAL(uint64_t) stream_instance_id;
300 } data;
301 } info;
302};
303
304enum get_next_subbuffer_status {
305 GET_NEXT_SUBBUFFER_STATUS_OK,
306 GET_NEXT_SUBBUFFER_STATUS_NO_DATA,
307 GET_NEXT_SUBBUFFER_STATUS_ERROR,
308};
309
310/*
311 * Perform any operation required to acknowledge
312 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
313 *
314 * Stream and channel locks are acquired during this call.
315 */
316using on_wake_up_cb = int (*)(struct lttng_consumer_stream *);
317
318/*
319 * Perform any operation required before a consumer stream is put
320 * to sleep before awaiting a data availability notification.
321 *
322 * Stream and channel locks are acquired during this call.
323 */
324using on_sleep_cb = int (*)(struct lttng_consumer_stream *, struct lttng_consumer_local_data *);
325
326/*
327 * Acquire the subbuffer at the current 'consumed' position.
328 *
329 * Stream and channel locks are acquired during this call.
330 */
331using get_next_subbuffer_cb = enum get_next_subbuffer_status (*)(struct lttng_consumer_stream *,
332 struct stream_subbuffer *);
333
334/*
335 * Populate the stream_subbuffer's info member. The info to populate
336 * depends on the type (metadata/data) of the stream.
337 *
338 * Stream and channel locks are acquired during this call.
339 */
340using extract_subbuffer_info_cb = int (*)(struct lttng_consumer_stream *,
341 struct stream_subbuffer *);
342
343/*
344 * Invoked after a subbuffer's info has been filled.
345 *
346 * Stream and channel locks are acquired during this call.
347 */
348using pre_consume_subbuffer_cb = int (*)(struct lttng_consumer_stream *,
349 const struct stream_subbuffer *);
350
351/*
352 * Consume subbuffer contents.
353 *
354 * Stream and channel locks are acquired during this call.
355 */
356using consume_subbuffer_cb = ssize_t (*)(struct lttng_consumer_local_data *,
357 struct lttng_consumer_stream *,
358 const struct stream_subbuffer *);
359
360/*
361 * Release the current subbuffer and advance the 'consumed' position by
362 * one subbuffer.
363 *
364 * Stream and channel locks are acquired during this call.
365 */
366using put_next_subbuffer_cb = int (*)(struct lttng_consumer_stream *, struct stream_subbuffer *);
367
368/*
369 * Invoked after consuming a subbuffer.
370 *
371 * Stream and channel locks are acquired during this call.
372 */
373using post_consume_cb = int (*)(struct lttng_consumer_stream *,
374 const struct stream_subbuffer *,
375 struct lttng_consumer_local_data *);
376
377/*
378 * Send a live beacon if no data is available.
379 *
380 * Stream and channel locks are acquired during this call.
381 */
382using send_live_beacon_cb = int (*)(struct lttng_consumer_stream *);
383
384/*
385 * Lock the stream and channel locks and any other stream-type specific
386 * lock that need to be acquired during the processing of an
387 * availability notification.
388 */
389using lock_cb = void (*)(struct lttng_consumer_stream *);
390
391/*
392 * Unlock the stream and channel locks and any other stream-type specific
393 * lock before sleeping until the next availability notification.
394 *
395 * Stream and channel locks are acquired during this call.
396 */
397using unlock_cb = void (*)(struct lttng_consumer_stream *);
398
399/*
400 * Assert that the stream and channel lock and any other stream type specific
401 * lock that need to be acquired during the processing of a read_subbuffer
402 * operation is acquired.
403 */
404using assert_locked_cb = void (*)(struct lttng_consumer_stream *);
405
406/*
407 * Invoked when a subbuffer's metadata version does not match the last
408 * known metadata version.
409 *
410 * Stream and channel locks are acquired during this call.
411 */
412using reset_metadata_cb = void (*)(struct lttng_consumer_stream *);
413
414/*
415 * Internal representation of the streams, sessiond_key is used to identify
416 * uniquely a stream.
417 */
418struct lttng_consumer_stream {
419 /* HT node used by the data_ht and metadata_ht */
420 struct lttng_ht_node_u64 node;
421 /* stream indexed per channel key node */
422 struct lttng_ht_node_u64 node_channel_id;
423 /* HT node used in consumer_data.stream_list_ht */
424 struct lttng_ht_node_u64 node_session_id;
425 /*
426 * List used by channels to reference streams that are not yet globally
427 * visible.
428 */
429 struct cds_list_head send_node;
430 /* Pointer to associated channel. */
431 struct lttng_consumer_channel *chan;
432 /*
433 * Current trace chunk. Holds a reference to the trace chunk.
434 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
435 * when it was created in the context of a no-output session.
436 */
437 struct lttng_trace_chunk *trace_chunk;
438
439 /* Key by which the stream is indexed for 'node'. */
440 uint64_t key;
441 /*
442 * File descriptor of the data output file. This can be either a file or a
443 * socket fd for relayd streaming.
444 */
445 int out_fd; /* output file to write the data */
446 /* Write position in the output file descriptor */
447 off_t out_fd_offset;
448 /* Amount of bytes written to the output */
449 uint64_t output_written;
450 int shm_fd_is_copy;
451 /*
452 * When a stream's pipe is hung up, a final flush is performed (see hangup_flush_done). This
453 * indicates whether or not the data resulting from this flush is still to be consumed.
454 */
455 int has_data_left_to_be_read_before_teardown;
456 int hangup_flush_done;
457
458 /*
459 * Whether the stream is in a "complete" state (e.g. it does not have a
460 * partially written sub-buffer.
461 *
462 * Initialized to "false" on stream creation (first packet is empty).
463 *
464 * The various transitions of the quiescent state are:
465 * - On "start" tracing: set to false, since the stream is not
466 * "complete".
467 * - On "stop" tracing: if !quiescent -> flush FINAL (update
468 * timestamp_end), and set to true; the stream has entered a
469 * complete/quiescent state.
470 * - On "destroy" or stream/application hang-up: if !quiescent ->
471 * flush FINAL, and set to true.
472 *
473 * NOTE: Update and read are protected by the stream lock.
474 */
475 bool quiescent;
476
477 /*
478 * True if the sequence number is not available (lttng-modules < 2.8).
479 */
480 bool sequence_number_unavailable;
481
482 /*
483 * metadata_timer_lock protects flags waiting_on_metadata and
484 * missed_metadata_flush.
485 */
486 pthread_mutex_t metadata_timer_lock;
487 /*
488 * Flag set when awaiting metadata to be pushed. Used in the
489 * timer thread to skip waiting on the stream (and stream lock) to
490 * ensure we can proceed to flushing metadata in live mode.
491 */
492 bool waiting_on_metadata;
493 /* Raised when a timer misses a metadata flush. */
494 bool missed_metadata_flush;
495
496 enum lttng_event_output output;
497 /* Maximum subbuffer size (in bytes). */
498 unsigned long max_sb_size;
499
500 /*
501 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
502 * used for the mmap base and offset.
503 */
504 void *mmap_base;
505 unsigned long mmap_len;
506
507 /* For UST */
508
509 int wait_fd;
510 /* Network sequence number. Indicating on which relayd socket it goes. */
511 uint64_t net_seq_idx;
512 /*
513 * Indicate if this stream was successfully sent to a relayd. This is set
514 * after the refcount of the relayd is incremented and is checked when the
515 * stream is closed before decrementing the refcount in order to avoid an
516 * unbalanced state.
517 */
518 unsigned int sent_to_relayd;
519
520 /* Identify if the stream is the metadata */
521 unsigned int metadata_flag;
522 /*
523 * Last known metadata version, reset the metadata file in case
524 * of change.
525 */
526 uint64_t metadata_version;
527 /* Used when the stream is set for network streaming */
528 uint64_t relayd_stream_id;
529 /*
530 * When sending a stream packet to a relayd, this number is used to track
531 * the packet sent by the consumer and seen by the relayd. When sending the
532 * data header to the relayd, this number is sent and if the transmission
533 * was successful, it is incremented.
534 *
535 * Even if the full data is not fully transmitted it won't matter since
536 * only two possible error can happen after that where either the relayd
537 * died or a read error is detected on the stream making this value useless
538 * after that.
539 *
540 * This value SHOULD be read/updated atomically or with the lock acquired.
541 */
542 uint64_t next_net_seq_num;
543 /*
544 * Lock to use the stream FDs since they are used between threads.
545 *
546 * This is nested INSIDE the consumer_data lock.
547 * This is nested INSIDE the channel lock.
548 * This is nested INSIDE the channel timer lock.
549 * This is nested OUTSIDE the metadata cache lock.
550 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
551 */
552 pthread_mutex_t lock;
553 /* Tracing session id */
554 uint64_t session_id;
555 /*
556 * Indicates if the stream end point is still active or not (network
557 * streaming or local file system). The thread "owning" the stream is
558 * handling this status and can be notified of a state change through the
559 * consumer data appropriate pipe.
560 */
561 enum consumer_endpoint_status endpoint_status;
562 /* Stream name. Format is: <channel_name>_<cpu_number> */
563 char name[LTTNG_SYMBOL_NAME_LEN];
564 /* Internal state of libustctl. */
565 struct lttng_ust_ctl_consumer_stream *ustream;
566 /* On-disk circular buffer */
567 uint64_t tracefile_size_current;
568 uint64_t tracefile_count_current;
569 /*
570 * Monitor or not the streams of this channel meaning this indicates if the
571 * streams should be sent to the data/metadata thread or added to the no
572 * monitor list of the channel.
573 */
574 unsigned int monitor;
575 /*
576 * Indicate if the stream is globally visible meaning that it has been
577 * added to the multiple hash tables. If *not* set, NO lock should be
578 * acquired in the destroy path.
579 */
580 unsigned int globally_visible;
581 /*
582 * Pipe to wake up the metadata poll thread when the UST metadata
583 * cache is updated.
584 */
585 int ust_metadata_poll_pipe[2];
586 /*
587 * How much metadata was read from the metadata cache and sent
588 * to the channel.
589 */
590 uint64_t ust_metadata_pushed;
591 /*
592 * Copy of the last discarded event value to detect the overflow of
593 * the counter.
594 */
595 uint64_t last_discarded_events;
596 /* Copy of the sequence number of the last packet extracted. */
597 uint64_t last_sequence_number;
598 /*
599 * Index file object of the index file for this stream.
600 */
601 struct lttng_index_file *index_file;
602
603 /*
604 * Local pipe to extract data when using splice.
605 */
606 int splice_pipe[2];
607
608 /*
609 * Rendez-vous point between data and metadata stream in live mode.
610 */
611 pthread_cond_t metadata_rdv;
612 pthread_mutex_t metadata_rdv_lock;
613
614 /*
615 * rotate_position represents the packet sequence number of the last
616 * packet which belongs to the current trace chunk prior to the rotation.
617 * When that position is reached, this tracefile can be closed and a
618 * new one is created in channel_read_only_attributes.path.
619 */
620 uint64_t rotate_position;
621
622 /* Whether or not a packet was opened during the current trace chunk. */
623 bool opened_packet_in_current_trace_chunk;
624
625 /*
626 * Read-only copies of channel values. We cannot safely access the
627 * channel from a stream, so we need to have a local copy of these
628 * fields in the stream object. These fields should be removed from
629 * the stream objects when we introduce refcounting.
630 */
631 struct {
632 uint64_t tracefile_size;
633 } channel_read_only_attributes;
634
635 /*
636 * Flag to inform the data or metadata thread that a stream is
637 * ready to be rotated.
638 */
639 bool rotate_ready;
640
641 /* Indicate if the stream still has some data to be read. */
642 unsigned int has_data:1;
643 /*
644 * Inform the consumer or relay to reset the metadata
645 * file before writing in it (regeneration).
646 */
647 unsigned int reset_metadata_flag:1;
648 struct {
649 /*
650 * Invoked in the order of declaration.
651 * See callback type definitions.
652 */
653 lock_cb lock;
654 on_wake_up_cb on_wake_up;
655 get_next_subbuffer_cb get_next_subbuffer;
656 extract_subbuffer_info_cb extract_subbuffer_info;
657 pre_consume_subbuffer_cb pre_consume_subbuffer;
658 reset_metadata_cb reset_metadata;
659 consume_subbuffer_cb consume_subbuffer;
660 put_next_subbuffer_cb put_next_subbuffer;
661 struct lttng_dynamic_array post_consume_cbs;
662 send_live_beacon_cb send_live_beacon;
663 on_sleep_cb on_sleep;
664 unlock_cb unlock;
665 assert_locked_cb assert_locked;
666 } read_subbuffer_ops;
667 struct metadata_bucket *metadata_bucket;
668};
669
670/*
671 * Internal representation of a relayd socket pair.
672 */
673struct consumer_relayd_sock_pair {
674 /* Network sequence number. */
675 uint64_t net_seq_idx;
676 /* Number of stream associated with this relayd */
677 int refcount;
678
679 /*
680 * This flag indicates whether or not we should destroy this object. The
681 * destruction should ONLY occurs when this flag is set and the refcount is
682 * set to zero.
683 */
684 unsigned int destroy_flag;
685
686 /*
687 * Mutex protecting the control socket to avoid out of order packets
688 * between threads sending data to the relayd. Since metadata data is sent
689 * over that socket, at least two sendmsg() are needed (header + data)
690 * creating a race for packets to overlap between threads using it.
691 *
692 * This is nested INSIDE the consumer_data lock.
693 * This is nested INSIDE the stream lock.
694 */
695 pthread_mutex_t ctrl_sock_mutex;
696
697 /* Control socket. Command and metadata are passed over it */
698 struct lttcomm_relayd_sock control_sock;
699
700 /*
701 * We don't need a mutex at this point since we only splice or write single
702 * large chunk of data with a header appended at the begining. Moreover,
703 * this socket is for now only used in a single thread.
704 */
705 struct lttcomm_relayd_sock data_sock;
706 struct lttng_ht_node_u64 node;
707
708 /* Session id on both sides for the sockets. */
709 uint64_t relayd_session_id;
710 uint64_t sessiond_session_id;
711 struct lttng_consumer_local_data *ctx;
712};
713
714/*
715 * UST consumer local data to the program. One or more instance per
716 * process.
717 */
718struct lttng_consumer_local_data {
719 /*
720 * Function to call when data is available on a buffer.
721 * Returns the number of bytes read, or negative error value.
722 */
723 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
724 struct lttng_consumer_local_data *ctx,
725 bool locked_by_caller);
726 /*
727 * function to call when we receive a new channel, it receives a
728 * newly allocated channel, depending on the return code of this
729 * function, the new channel will be handled by the application
730 * or the library.
731 *
732 * Returns:
733 * > 0 (success, FD is kept by application)
734 * == 0 (success, FD is left to library)
735 * < 0 (error)
736 */
737 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
738 /*
739 * function to call when we receive a new stream, it receives a
740 * newly allocated stream, depending on the return code of this
741 * function, the new stream will be handled by the application
742 * or the library.
743 *
744 * Returns:
745 * > 0 (success, FD is kept by application)
746 * == 0 (success, FD is left to library)
747 * < 0 (error)
748 */
749 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
750 /*
751 * function to call when a stream is getting updated by the session
752 * daemon, this function receives the sessiond key and the new
753 * state, depending on the return code of this function the
754 * update of state for the stream is handled by the application
755 * or the library.
756 *
757 * Returns:
758 * > 0 (success, FD is kept by application)
759 * == 0 (success, FD is left to library)
760 * < 0 (error)
761 */
762 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
763 enum lttng_consumer_type type;
764 /* socket to communicate errors with sessiond */
765 int consumer_error_socket;
766 /* socket to ask metadata to sessiond. */
767 int consumer_metadata_socket;
768 /*
769 * Protect consumer_metadata_socket.
770 *
771 * This is nested OUTSIDE the metadata cache lock.
772 */
773 pthread_mutex_t metadata_socket_lock;
774 /* socket to exchange commands with sessiond */
775 char *consumer_command_sock_path;
776 /* communication with splice */
777 int consumer_channel_pipe[2];
778 /* Data stream poll thread pipe. To transfer data stream to the thread */
779 struct lttng_pipe *consumer_data_pipe;
780
781 /*
782 * Data thread use that pipe to catch wakeup from read subbuffer that
783 * detects that there is still data to be read for the stream encountered.
784 * Before doing so, the stream is flagged to indicate that there is still
785 * data to be read.
786 *
787 * Both pipes (read/write) are owned and used inside the data thread.
788 */
789 struct lttng_pipe *consumer_wakeup_pipe;
790 /* Indicate if the wakeup thread has been notified. */
791 unsigned int has_wakeup:1;
792
793 /* to let the signal handler wake up the fd receiver thread */
794 int consumer_should_quit[2];
795 /* Metadata poll thread pipe. Transfer metadata stream to it */
796 struct lttng_pipe *consumer_metadata_pipe;
797 /*
798 * Pipe used by the channel monitoring timers to provide state samples
799 * to the session daemon (write-only).
800 */
801 int channel_monitor_pipe;
802 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
803};
804
805/*
806 * Library-level data. One instance per process.
807 */
808struct lttng_consumer_global_data {
809 /*
810 * At this time, this lock is used to ensure coherence between the count
811 * and number of element in the hash table. It's also a protection for
812 * concurrent read/write between threads.
813 *
814 * This is nested OUTSIDE the stream lock.
815 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
816 */
817 pthread_mutex_t lock {};
818
819 /*
820 * Number of streams in the data stream hash table declared outside.
821 * Protected by consumer_data.lock.
822 */
823 int stream_count = 0;
824
825 /* Channel hash table protected by consumer_data.lock. */
826 struct lttng_ht *channel_ht = nullptr;
827 /* Channel hash table indexed by session id. */
828 struct lttng_ht *channels_by_session_id_ht = nullptr;
829 /*
830 * Flag specifying if the local array of FDs needs update in the
831 * poll function. Protected by consumer_data.lock.
832 */
833 unsigned int need_update = 1;
834 enum lttng_consumer_type type = LTTNG_CONSUMER_UNKNOWN;
835
836 /*
837 * Relayd socket(s) hashtable indexed by network sequence number. Each
838 * stream has an index which associate the right relayd socket to use.
839 */
840 struct lttng_ht *relayd_ht = nullptr;
841
842 /*
843 * This hash table contains all streams (metadata and data) indexed by
844 * session id. In other words, the ht is indexed by session id and each
845 * bucket contains the list of associated streams.
846 *
847 * This HT uses the "node_session_id" of the consumer stream.
848 */
849 struct lttng_ht *stream_list_ht = nullptr;
850
851 /*
852 * This HT uses the "node_channel_id" of the consumer stream.
853 */
854 struct lttng_ht *stream_per_chan_id_ht = nullptr;
855
856 /*
857 * Trace chunk registry indexed by (session_id, chunk_id).
858 */
859 struct lttng_trace_chunk_registry *chunk_registry = nullptr;
860};
861
862/*
863 * Set to nonzero when the consumer is exiting. Updated by signal
864 * handler and thread exit, read by threads.
865 */
866extern int consumer_quit;
867
868/*
869 * Set to nonzero when the consumer is exiting. Updated by signal
870 * handler and thread exit, read by threads.
871 */
872extern int consumer_quit;
873
874/*
875 * Flag used to temporarily pause data consumption from testpoints.
876 *
877 * This variable is dlsym-ed from a test, so needs to be exported.
878 */
879LTTNG_EXPORT extern int data_consumption_paused;
880
881/* Return a human-readable consumer type string that is suitable for logging. */
882static inline
883const char *lttng_consumer_type_str(enum lttng_consumer_type type)
884{
885 switch (type) {
886 case LTTNG_CONSUMER_UNKNOWN:
887 return "unknown";
888 case LTTNG_CONSUMER_KERNEL:
889 return "kernel";
890 case LTTNG_CONSUMER32_UST:
891 return "32-bit user space";
892 case LTTNG_CONSUMER64_UST:
893 return "64-bit user space";
894 default:
895 abort();
896 }
897}
898
899/*
900 * Init consumer data structures.
901 */
902int lttng_consumer_init();
903
904/*
905 * Set the error socket for communication with a session daemon.
906 */
907void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
908 int sock);
909
910/*
911 * Set the command socket path for communication with a session daemon.
912 */
913void lttng_consumer_set_command_sock_path(
914 struct lttng_consumer_local_data *ctx, char *sock);
915
916/*
917 * Send return code to session daemon.
918 *
919 * Returns the return code of sendmsg : the number of bytes transmitted or -1
920 * on error.
921 */
922int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
923
924/*
925 * Called from signal handler to ensure a clean exit.
926 */
927void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
928
929/*
930 * Cleanup the daemon's socket on exit.
931 */
932void lttng_consumer_cleanup();
933
934/*
935 * Poll on the should_quit pipe and the command socket return -1 on error and
936 * should exit, 0 if data is available on the command socket
937 */
938int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
939
940/*
941 * Copy the fields from the channel that need to be accessed (read-only)
942 * directly from the stream.
943 */
944void consumer_stream_update_channel_attributes(
945 struct lttng_consumer_stream *stream,
946 struct lttng_consumer_channel *channel);
947
948struct lttng_consumer_stream *consumer_allocate_stream(
949 struct lttng_consumer_channel *channel,
950 uint64_t channel_key,
951 uint64_t stream_key,
952 const char *channel_name,
953 uint64_t relayd_id,
954 uint64_t session_id,
955 struct lttng_trace_chunk *trace_chunk,
956 int cpu,
957 int *alloc_ret,
958 enum consumer_channel_type type,
959 unsigned int monitor);
960struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
961 uint64_t session_id,
962 const uint64_t *chunk_id,
963 const char *pathname,
964 const char *name,
965 uint64_t relayd_id,
966 enum lttng_event_output output,
967 uint64_t tracefile_size,
968 uint64_t tracefile_count,
969 uint64_t session_id_per_pid,
970 unsigned int monitor,
971 unsigned int live_timer_interval,
972 bool is_in_live_session,
973 const char *root_shm_path,
974 const char *shm_path);
975void consumer_del_stream(struct lttng_consumer_stream *stream,
976 struct lttng_ht *ht);
977void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
978 struct lttng_ht *ht);
979int consumer_add_channel(struct lttng_consumer_channel *channel,
980 struct lttng_consumer_local_data *ctx);
981void consumer_del_channel(struct lttng_consumer_channel *channel);
982
983/* lttng-relayd consumer command */
984struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
985int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
986int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
987void close_relayd_stream(struct lttng_consumer_stream *stream);
988struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
989int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
990 size_t data_size);
991void consumer_steal_stream_key(int key, struct lttng_ht *ht);
992
993struct lttng_consumer_local_data *lttng_consumer_create(
994 enum lttng_consumer_type type,
995 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
996 struct lttng_consumer_local_data *ctx,
997 bool locked_by_caller),
998 int (*recv_channel)(struct lttng_consumer_channel *channel),
999 int (*recv_stream)(struct lttng_consumer_stream *stream),
1000 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
1001void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
1002ssize_t lttng_consumer_on_read_subbuffer_mmap(
1003 struct lttng_consumer_stream *stream,
1004 const struct lttng_buffer_view *buffer,
1005 unsigned long padding);
1006ssize_t lttng_consumer_on_read_subbuffer_splice(
1007 struct lttng_consumer_local_data *ctx,
1008 struct lttng_consumer_stream *stream, unsigned long len,
1009 unsigned long padding);
1010int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
1011int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
1012int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
1013 unsigned long *pos);
1014int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
1015 unsigned long *pos);
1016int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
1017int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
1018void *consumer_thread_metadata_poll(void *data);
1019void *consumer_thread_data_poll(void *data);
1020void *consumer_thread_sessiond_poll(void *data);
1021void *consumer_thread_channel_poll(void *data);
1022int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1023 int sock, struct pollfd *consumer_sockpoll);
1024
1025ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1026 struct lttng_consumer_local_data *ctx,
1027 bool locked_by_caller);
1028int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1029void consumer_add_relayd_socket(uint64_t net_seq_idx,
1030 int sock_type,
1031 struct lttng_consumer_local_data *ctx,
1032 int sock,
1033 struct pollfd *consumer_sockpoll,
1034 uint64_t sessiond_id,
1035 uint64_t relayd_session_id,
1036 uint32_t relayd_version_major,
1037 uint32_t relayd_version_minor,
1038 enum lttcomm_sock_proto relayd_socket_protocol);
1039void consumer_flag_relayd_for_destroy(
1040 struct consumer_relayd_sock_pair *relayd);
1041int consumer_data_pending(uint64_t id);
1042int consumer_send_status_msg(int sock, int ret_code);
1043int consumer_send_status_channel(int sock,
1044 struct lttng_consumer_channel *channel);
1045void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
1046 uint64_t key);
1047void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1048unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1049 unsigned long produced_pos, uint64_t nb_packets_per_stream,
1050 uint64_t max_sb_size);
1051void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1052void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1053void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1054void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1055int consumer_create_index_file(struct lttng_consumer_stream *stream);
1056int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1057 uint64_t key, uint64_t relayd_id);
1058int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1059int lttng_consumer_rotate_stream(struct lttng_consumer_stream *stream);
1060int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
1061 uint64_t key);
1062void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1063enum lttcomm_return_code lttng_consumer_create_trace_chunk(
1064 const uint64_t *relayd_id, uint64_t session_id,
1065 uint64_t chunk_id,
1066 time_t chunk_creation_timestamp,
1067 const char *chunk_override_name,
1068 const struct lttng_credentials *credentials,
1069 struct lttng_directory_handle *chunk_directory_handle);
1070enum lttcomm_return_code lttng_consumer_close_trace_chunk(
1071 const uint64_t *relayd_id, uint64_t session_id,
1072 uint64_t chunk_id, time_t chunk_close_timestamp,
1073 const enum lttng_trace_chunk_command_type *close_command,
1074 char *path);
1075enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
1076 const uint64_t *relayd_id, uint64_t session_id,
1077 uint64_t chunk_id);
1078void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1079enum lttcomm_return_code lttng_consumer_init_command(
1080 struct lttng_consumer_local_data *ctx,
1081 const lttng_uuid& sessiond_uuid);
1082int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1083enum lttcomm_return_code lttng_consumer_open_channel_packets(
1084 struct lttng_consumer_channel *channel);
1085int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel);
1086void lttng_consumer_sigbus_handle(void *addr);
1087void sample_and_send_channel_buffer_stats(struct lttng_consumer_channel *channel);
1088
1089#endif /* LIB_CONSUMER_H */
This page took 0.026682 seconds and 4 git commands to generate.