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>
7 * SPDX-License-Identifier: GPL-2.0-only
11 #ifndef LIB_CONSUMER_H
12 #define LIB_CONSUMER_H
18 #include <urcu/list.h>
20 #include <lttng/lttng.h>
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>
33 struct lttng_consumer_local_data;
35 /* Commands for consumer */
36 enum 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,
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,
72 enum lttng_consumer_type {
73 LTTNG_CONSUMER_UNKNOWN = 0,
74 LTTNG_CONSUMER_KERNEL,
79 enum consumer_endpoint_status {
80 CONSUMER_ENDPOINT_ACTIVE,
81 CONSUMER_ENDPOINT_INACTIVE,
84 enum consumer_channel_output {
85 CONSUMER_CHANNEL_MMAP = 0,
86 CONSUMER_CHANNEL_SPLICE = 1,
89 enum consumer_channel_type {
90 CONSUMER_CHANNEL_TYPE_METADATA = 0,
91 CONSUMER_CHANNEL_TYPE_DATA = 1,
94 enum sync_metadata_status {
95 SYNC_METADATA_STATUS_NEW_DATA,
96 SYNC_METADATA_STATUS_NO_DATA,
97 SYNC_METADATA_STATUS_ERROR,
100 extern struct lttng_consumer_global_data the_consumer_data;
103 struct cds_list_head head;
108 struct consumer_metadata_cache;
110 struct lttng_consumer_channel {
111 /* Is the channel published in the channel hash tables? */
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
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. */
125 /* Number of streams referencing this channel */
127 /* Tracing session id on the session daemon side. */
129 /* Current trace chunk of the session in which this channel exists. */
130 struct lttng_trace_chunk *trace_chunk;
132 * Session id when requesting metadata to the session daemon for
133 * a session with per-PID buffers.
135 uint64_t session_id_per_pid;
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
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
147 char pathname[PATH_MAX];
149 char name[LTTNG_SYMBOL_NAME_LEN];
150 /* Relayd id of the channel. -1ULL if it does not apply. */
153 * Number of streams NOT initialized yet. This is used in order to not
154 * delete this channel if streams are getting initialized.
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;
163 uid_t ust_app_uid; /* Application UID. */
164 struct lttng_ust_ctl_consumer_channel *uchan;
165 unsigned char uuid[LTTNG_UUID_STR_LEN];
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.
171 struct stream_list streams;
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.
178 struct lttng_consumer_stream *metadata_stream;
182 /* Node within channel thread ht */
183 struct lttng_ht_node_u64 wait_fd_node;
185 /* Metadata cache is metadata channel */
186 struct consumer_metadata_cache *metadata_cache;
188 /* For UST metadata periodical flush */
189 int switch_timer_enabled;
190 timer_t switch_timer;
191 int switch_timer_error;
193 /* For the live mode */
194 int live_timer_enabled;
196 int live_timer_error;
197 /* Channel is part of a live session ? */
200 /* For channel monitoring timer. */
201 int monitor_timer_enabled;
202 timer_t monitor_timer;
204 /* On-disk circular buffer */
205 uint64_t tracefile_size;
206 uint64_t tracefile_count;
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.
212 unsigned int monitor;
217 * This lock protects against concurrent update of channel.
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.
225 pthread_mutex_t lock;
228 * Channel teardown lock.
230 * This lock protect against teardown of channel. It is _never_
231 * taken by the timer handler.
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.
239 pthread_mutex_t timer_lock;
241 /* Timer value in usec for live streaming. */
242 unsigned int live_timer_interval;
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;
255 bool streams_sent_to_relayd;
256 uint64_t last_consumed_size_sample_sent;
259 struct stream_subbuffer {
262 * CONSUMER_CHANNEL_SPLICE
263 * No ownership assumed.
266 /* CONSUMER_CHANNEL_MMAP */
267 struct lttng_buffer_view buffer;
271 * Common members are fine to access through either
272 * union entries (as per C11, Common Initial Sequence).
275 unsigned long subbuf_size;
276 unsigned long padded_subbuf_size;
279 * Left unset when unsupported.
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.
285 LTTNG_OPTIONAL(bool) coherent;
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;
298 /* Left unset when unsupported. */
299 LTTNG_OPTIONAL(uint64_t) stream_instance_id;
304 enum get_next_subbuffer_status {
305 GET_NEXT_SUBBUFFER_STATUS_OK,
306 GET_NEXT_SUBBUFFER_STATUS_NO_DATA,
307 GET_NEXT_SUBBUFFER_STATUS_ERROR,
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).
314 * Stream and channel locks are acquired during this call.
316 typedef int (*on_wake_up_cb)(struct lttng_consumer_stream *);
319 * Perform any operation required before a consumer stream is put
320 * to sleep before awaiting a data availability notification.
322 * Stream and channel locks are acquired during this call.
324 typedef int (*on_sleep_cb)(struct lttng_consumer_stream *,
325 struct lttng_consumer_local_data *);
328 * Acquire the subbuffer at the current 'consumed' position.
330 * Stream and channel locks are acquired during this call.
332 typedef enum get_next_subbuffer_status (*get_next_subbuffer_cb)(
333 struct lttng_consumer_stream *, struct stream_subbuffer *);
336 * Populate the stream_subbuffer's info member. The info to populate
337 * depends on the type (metadata/data) of the stream.
339 * Stream and channel locks are acquired during this call.
341 typedef int (*extract_subbuffer_info_cb)(
342 struct lttng_consumer_stream *, struct stream_subbuffer *);
345 * Invoked after a subbuffer's info has been filled.
347 * Stream and channel locks are acquired during this call.
349 typedef int (*pre_consume_subbuffer_cb)(struct lttng_consumer_stream *,
350 const struct stream_subbuffer *);
353 * Consume subbuffer contents.
355 * Stream and channel locks are acquired during this call.
357 typedef ssize_t (*consume_subbuffer_cb)(struct lttng_consumer_local_data *,
358 struct lttng_consumer_stream *,
359 const struct stream_subbuffer *);
362 * Release the current subbuffer and advance the 'consumed' position by
365 * Stream and channel locks are acquired during this call.
367 typedef int (*put_next_subbuffer_cb)(struct lttng_consumer_stream *,
368 struct stream_subbuffer *);
371 * Invoked after consuming a subbuffer.
373 * Stream and channel locks are acquired during this call.
375 typedef int (*post_consume_cb)(struct lttng_consumer_stream *,
376 const struct stream_subbuffer *,
377 struct lttng_consumer_local_data *);
380 * Send a live beacon if no data is available.
382 * Stream and channel locks are acquired during this call.
384 typedef int (*send_live_beacon_cb)(struct lttng_consumer_stream *);
387 * Lock the stream and channel locks and any other stream-type specific
388 * lock that need to be acquired during the processing of an
389 * availability notification.
391 typedef void (*lock_cb)(struct lttng_consumer_stream *);
394 * Unlock the stream and channel locks and any other stream-type specific
395 * lock before sleeping until the next availability notification.
397 * Stream and channel locks are acquired during this call.
399 typedef void (*unlock_cb)(struct lttng_consumer_stream *);
402 * Assert that the stream and channel lock and any other stream type specific
403 * lock that need to be acquired during the processing of a read_subbuffer
404 * operation is acquired.
406 typedef void (*assert_locked_cb)(struct lttng_consumer_stream *);
409 * Invoked when a subbuffer's metadata version does not match the last
410 * known metadata version.
412 * Stream and channel locks are acquired during this call.
414 typedef void (*reset_metadata_cb)(struct lttng_consumer_stream *);
417 * Internal representation of the streams, sessiond_key is used to identify
420 struct lttng_consumer_stream {
421 /* HT node used by the data_ht and metadata_ht */
422 struct lttng_ht_node_u64 node;
423 /* stream indexed per channel key node */
424 struct lttng_ht_node_u64 node_channel_id;
425 /* HT node used in consumer_data.stream_list_ht */
426 struct lttng_ht_node_u64 node_session_id;
428 * List used by channels to reference streams that are not yet globally
431 struct cds_list_head send_node;
432 /* Pointer to associated channel. */
433 struct lttng_consumer_channel *chan;
435 * Current trace chunk. Holds a reference to the trace chunk.
436 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
437 * when it was created in the context of a no-output session.
439 struct lttng_trace_chunk *trace_chunk;
441 /* Key by which the stream is indexed for 'node'. */
444 * File descriptor of the data output file. This can be either a file or a
445 * socket fd for relayd streaming.
447 int out_fd; /* output file to write the data */
448 /* Write position in the output file descriptor */
450 /* Amount of bytes written to the output */
451 uint64_t output_written;
454 * When a stream's pipe is hung up, a final flush is performed (see hangup_flush_done). This
455 * indicates whether or not the data resulting from this flush is still to be consumed.
457 int has_data_left_to_be_read_before_teardown;
458 int hangup_flush_done;
461 * Whether the stream is in a "complete" state (e.g. it does not have a
462 * partially written sub-buffer.
464 * Initialized to "false" on stream creation (first packet is empty).
466 * The various transitions of the quiescent state are:
467 * - On "start" tracing: set to false, since the stream is not
469 * - On "stop" tracing: if !quiescent -> flush FINAL (update
470 * timestamp_end), and set to true; the stream has entered a
471 * complete/quiescent state.
472 * - On "destroy" or stream/application hang-up: if !quiescent ->
473 * flush FINAL, and set to true.
475 * NOTE: Update and read are protected by the stream lock.
480 * True if the sequence number is not available (lttng-modules < 2.8).
482 bool sequence_number_unavailable;
485 * metadata_timer_lock protects flags waiting_on_metadata and
486 * missed_metadata_flush.
488 pthread_mutex_t metadata_timer_lock;
490 * Flag set when awaiting metadata to be pushed. Used in the
491 * timer thread to skip waiting on the stream (and stream lock) to
492 * ensure we can proceed to flushing metadata in live mode.
494 bool waiting_on_metadata;
495 /* Raised when a timer misses a metadata flush. */
496 bool missed_metadata_flush;
498 enum lttng_event_output output;
499 /* Maximum subbuffer size (in bytes). */
500 unsigned long max_sb_size;
503 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
504 * used for the mmap base and offset.
507 unsigned long mmap_len;
512 /* Network sequence number. Indicating on which relayd socket it goes. */
513 uint64_t net_seq_idx;
515 * Indicate if this stream was successfully sent to a relayd. This is set
516 * after the refcount of the relayd is incremented and is checked when the
517 * stream is closed before decrementing the refcount in order to avoid an
520 unsigned int sent_to_relayd;
522 /* Identify if the stream is the metadata */
523 unsigned int metadata_flag;
525 * Last known metadata version, reset the metadata file in case
528 uint64_t metadata_version;
529 /* Used when the stream is set for network streaming */
530 uint64_t relayd_stream_id;
532 * When sending a stream packet to a relayd, this number is used to track
533 * the packet sent by the consumer and seen by the relayd. When sending the
534 * data header to the relayd, this number is sent and if the transmission
535 * was successful, it is incremented.
537 * Even if the full data is not fully transmitted it won't matter since
538 * only two possible error can happen after that where either the relayd
539 * died or a read error is detected on the stream making this value useless
542 * This value SHOULD be read/updated atomically or with the lock acquired.
544 uint64_t next_net_seq_num;
546 * Lock to use the stream FDs since they are used between threads.
548 * This is nested INSIDE the consumer_data lock.
549 * This is nested INSIDE the channel lock.
550 * This is nested INSIDE the channel timer lock.
551 * This is nested OUTSIDE the metadata cache lock.
552 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
554 pthread_mutex_t lock;
555 /* Tracing session id */
558 * Indicates if the stream end point is still active or not (network
559 * streaming or local file system). The thread "owning" the stream is
560 * handling this status and can be notified of a state change through the
561 * consumer data appropriate pipe.
563 enum consumer_endpoint_status endpoint_status;
564 /* Stream name. Format is: <channel_name>_<cpu_number> */
565 char name[LTTNG_SYMBOL_NAME_LEN];
566 /* Internal state of libustctl. */
567 struct lttng_ust_ctl_consumer_stream *ustream;
568 /* On-disk circular buffer */
569 uint64_t tracefile_size_current;
570 uint64_t tracefile_count_current;
572 * Monitor or not the streams of this channel meaning this indicates if the
573 * streams should be sent to the data/metadata thread or added to the no
574 * monitor list of the channel.
576 unsigned int monitor;
578 * Indicate if the stream is globally visible meaning that it has been
579 * added to the multiple hash tables. If *not* set, NO lock should be
580 * acquired in the destroy path.
582 unsigned int globally_visible;
584 * Pipe to wake up the metadata poll thread when the UST metadata
587 int ust_metadata_poll_pipe[2];
589 * How much metadata was read from the metadata cache and sent
592 uint64_t ust_metadata_pushed;
594 * Copy of the last discarded event value to detect the overflow of
597 uint64_t last_discarded_events;
598 /* Copy of the sequence number of the last packet extracted. */
599 uint64_t last_sequence_number;
601 * Index file object of the index file for this stream.
603 struct lttng_index_file *index_file;
606 * Local pipe to extract data when using splice.
611 * Rendez-vous point between data and metadata stream in live mode.
613 pthread_cond_t metadata_rdv;
614 pthread_mutex_t metadata_rdv_lock;
617 * rotate_position represents the packet sequence number of the last
618 * packet which belongs to the current trace chunk prior to the rotation.
619 * When that position is reached, this tracefile can be closed and a
620 * new one is created in channel_read_only_attributes.path.
622 uint64_t rotate_position;
624 /* Whether or not a packet was opened during the current trace chunk. */
625 bool opened_packet_in_current_trace_chunk;
628 * Read-only copies of channel values. We cannot safely access the
629 * channel from a stream, so we need to have a local copy of these
630 * fields in the stream object. These fields should be removed from
631 * the stream objects when we introduce refcounting.
634 uint64_t tracefile_size;
635 } channel_read_only_attributes;
638 * Flag to inform the data or metadata thread that a stream is
639 * ready to be rotated.
643 /* Indicate if the stream still has some data to be read. */
644 unsigned int has_data:1;
646 * Inform the consumer or relay to reset the metadata
647 * file before writing in it (regeneration).
649 unsigned int reset_metadata_flag:1;
652 * Invoked in the order of declaration.
653 * See callback type definitions.
656 on_wake_up_cb on_wake_up;
657 get_next_subbuffer_cb get_next_subbuffer;
658 extract_subbuffer_info_cb extract_subbuffer_info;
659 pre_consume_subbuffer_cb pre_consume_subbuffer;
660 reset_metadata_cb reset_metadata;
661 consume_subbuffer_cb consume_subbuffer;
662 put_next_subbuffer_cb put_next_subbuffer;
663 struct lttng_dynamic_array post_consume_cbs;
664 send_live_beacon_cb send_live_beacon;
665 on_sleep_cb on_sleep;
667 assert_locked_cb assert_locked;
668 } read_subbuffer_ops;
669 struct metadata_bucket *metadata_bucket;
673 * Internal representation of a relayd socket pair.
675 struct consumer_relayd_sock_pair {
676 /* Network sequence number. */
677 uint64_t net_seq_idx;
678 /* Number of stream associated with this relayd */
682 * This flag indicates whether or not we should destroy this object. The
683 * destruction should ONLY occurs when this flag is set and the refcount is
686 unsigned int destroy_flag;
689 * Mutex protecting the control socket to avoid out of order packets
690 * between threads sending data to the relayd. Since metadata data is sent
691 * over that socket, at least two sendmsg() are needed (header + data)
692 * creating a race for packets to overlap between threads using it.
694 * This is nested INSIDE the consumer_data lock.
695 * This is nested INSIDE the stream lock.
697 pthread_mutex_t ctrl_sock_mutex;
699 /* Control socket. Command and metadata are passed over it */
700 struct lttcomm_relayd_sock control_sock;
703 * We don't need a mutex at this point since we only splice or write single
704 * large chunk of data with a header appended at the begining. Moreover,
705 * this socket is for now only used in a single thread.
707 struct lttcomm_relayd_sock data_sock;
708 struct lttng_ht_node_u64 node;
710 /* Session id on both sides for the sockets. */
711 uint64_t relayd_session_id;
712 uint64_t sessiond_session_id;
713 struct lttng_consumer_local_data *ctx;
717 * UST consumer local data to the program. One or more instance per
720 struct lttng_consumer_local_data {
722 * Function to call when data is available on a buffer.
723 * Returns the number of bytes read, or negative error value.
725 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
726 struct lttng_consumer_local_data *ctx,
727 bool locked_by_caller);
729 * function to call when we receive a new channel, it receives a
730 * newly allocated channel, depending on the return code of this
731 * function, the new channel will be handled by the application
735 * > 0 (success, FD is kept by application)
736 * == 0 (success, FD is left to library)
739 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
741 * function to call when we receive a new stream, it receives a
742 * newly allocated stream, depending on the return code of this
743 * function, the new stream will be handled by the application
747 * > 0 (success, FD is kept by application)
748 * == 0 (success, FD is left to library)
751 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
753 * function to call when a stream is getting updated by the session
754 * daemon, this function receives the sessiond key and the new
755 * state, depending on the return code of this function the
756 * update of state for the stream is handled by the application
760 * > 0 (success, FD is kept by application)
761 * == 0 (success, FD is left to library)
764 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
765 enum lttng_consumer_type type;
766 /* socket to communicate errors with sessiond */
767 int consumer_error_socket;
768 /* socket to ask metadata to sessiond. */
769 int consumer_metadata_socket;
771 * Protect consumer_metadata_socket.
773 * This is nested OUTSIDE the metadata cache lock.
775 pthread_mutex_t metadata_socket_lock;
776 /* socket to exchange commands with sessiond */
777 char *consumer_command_sock_path;
778 /* communication with splice */
779 int consumer_channel_pipe[2];
780 /* Data stream poll thread pipe. To transfer data stream to the thread */
781 struct lttng_pipe *consumer_data_pipe;
784 * Data thread use that pipe to catch wakeup from read subbuffer that
785 * detects that there is still data to be read for the stream encountered.
786 * Before doing so, the stream is flagged to indicate that there is still
789 * Both pipes (read/write) are owned and used inside the data thread.
791 struct lttng_pipe *consumer_wakeup_pipe;
792 /* Indicate if the wakeup thread has been notified. */
793 unsigned int has_wakeup:1;
795 /* to let the signal handler wake up the fd receiver thread */
796 int consumer_should_quit[2];
797 /* Metadata poll thread pipe. Transfer metadata stream to it */
798 struct lttng_pipe *consumer_metadata_pipe;
800 * Pipe used by the channel monitoring timers to provide state samples
801 * to the session daemon (write-only).
803 int channel_monitor_pipe;
804 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
808 * Library-level data. One instance per process.
810 struct lttng_consumer_global_data {
812 * At this time, this lock is used to ensure coherence between the count
813 * and number of element in the hash table. It's also a protection for
814 * concurrent read/write between threads.
816 * This is nested OUTSIDE the stream lock.
817 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
819 pthread_mutex_t lock {};
822 * Number of streams in the data stream hash table declared outside.
823 * Protected by consumer_data.lock.
825 int stream_count = 0;
827 /* Channel hash table protected by consumer_data.lock. */
828 struct lttng_ht *channel_ht = nullptr;
829 /* Channel hash table indexed by session id. */
830 struct lttng_ht *channels_by_session_id_ht = nullptr;
832 * Flag specifying if the local array of FDs needs update in the
833 * poll function. Protected by consumer_data.lock.
835 unsigned int need_update = 1;
836 enum lttng_consumer_type type = LTTNG_CONSUMER_UNKNOWN;
839 * Relayd socket(s) hashtable indexed by network sequence number. Each
840 * stream has an index which associate the right relayd socket to use.
842 struct lttng_ht *relayd_ht = nullptr;
845 * This hash table contains all streams (metadata and data) indexed by
846 * session id. In other words, the ht is indexed by session id and each
847 * bucket contains the list of associated streams.
849 * This HT uses the "node_session_id" of the consumer stream.
851 struct lttng_ht *stream_list_ht = nullptr;
854 * This HT uses the "node_channel_id" of the consumer stream.
856 struct lttng_ht *stream_per_chan_id_ht = nullptr;
859 * Trace chunk registry indexed by (session_id, chunk_id).
861 struct lttng_trace_chunk_registry *chunk_registry = nullptr;
865 * Set to nonzero when the consumer is exiting. Updated by signal
866 * handler and thread exit, read by threads.
868 extern int consumer_quit;
871 * Set to nonzero when the consumer is exiting. Updated by signal
872 * handler and thread exit, read by threads.
874 extern int consumer_quit;
877 * Flag used to temporarily pause data consumption from testpoints.
879 * This variable is dlsym-ed from a test, so needs to be exported.
881 LTTNG_EXPORT extern int data_consumption_paused;
883 /* Return a human-readable consumer type string that is suitable for logging. */
885 const char *lttng_consumer_type_str(enum lttng_consumer_type type)
888 case LTTNG_CONSUMER_UNKNOWN:
890 case LTTNG_CONSUMER_KERNEL:
892 case LTTNG_CONSUMER32_UST:
893 return "32-bit user space";
894 case LTTNG_CONSUMER64_UST:
895 return "64-bit user space";
902 * Init consumer data structures.
904 int lttng_consumer_init(void);
907 * Set the error socket for communication with a session daemon.
909 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
913 * Set the command socket path for communication with a session daemon.
915 void lttng_consumer_set_command_sock_path(
916 struct lttng_consumer_local_data *ctx, char *sock);
919 * Send return code to session daemon.
921 * Returns the return code of sendmsg : the number of bytes transmitted or -1
924 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
927 * Called from signal handler to ensure a clean exit.
929 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
932 * Cleanup the daemon's socket on exit.
934 void lttng_consumer_cleanup(void);
937 * Poll on the should_quit pipe and the command socket return -1 on error and
938 * should exit, 0 if data is available on the command socket
940 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
943 * Copy the fields from the channel that need to be accessed (read-only)
944 * directly from the stream.
946 void consumer_stream_update_channel_attributes(
947 struct lttng_consumer_stream *stream,
948 struct lttng_consumer_channel *channel);
950 struct lttng_consumer_stream *consumer_allocate_stream(
951 struct lttng_consumer_channel *channel,
952 uint64_t channel_key,
954 const char *channel_name,
957 struct lttng_trace_chunk *trace_chunk,
960 enum consumer_channel_type type,
961 unsigned int monitor);
962 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
964 const uint64_t *chunk_id,
965 const char *pathname,
968 enum lttng_event_output output,
969 uint64_t tracefile_size,
970 uint64_t tracefile_count,
971 uint64_t session_id_per_pid,
972 unsigned int monitor,
973 unsigned int live_timer_interval,
974 bool is_in_live_session,
975 const char *root_shm_path,
976 const char *shm_path);
977 void consumer_del_stream(struct lttng_consumer_stream *stream,
978 struct lttng_ht *ht);
979 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
980 struct lttng_ht *ht);
981 int consumer_add_channel(struct lttng_consumer_channel *channel,
982 struct lttng_consumer_local_data *ctx);
983 void consumer_del_channel(struct lttng_consumer_channel *channel);
985 /* lttng-relayd consumer command */
986 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
987 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
988 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
989 void close_relayd_stream(struct lttng_consumer_stream *stream);
990 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
991 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
993 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
995 struct lttng_consumer_local_data *lttng_consumer_create(
996 enum lttng_consumer_type type,
997 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
998 struct lttng_consumer_local_data *ctx,
999 bool locked_by_caller),
1000 int (*recv_channel)(struct lttng_consumer_channel *channel),
1001 int (*recv_stream)(struct lttng_consumer_stream *stream),
1002 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
1003 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
1004 ssize_t lttng_consumer_on_read_subbuffer_mmap(
1005 struct lttng_consumer_stream *stream,
1006 const struct lttng_buffer_view *buffer,
1007 unsigned long padding);
1008 ssize_t lttng_consumer_on_read_subbuffer_splice(
1009 struct lttng_consumer_local_data *ctx,
1010 struct lttng_consumer_stream *stream, unsigned long len,
1011 unsigned long padding);
1012 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
1013 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
1014 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
1015 unsigned long *pos);
1016 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
1017 unsigned long *pos);
1018 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
1019 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
1020 void *consumer_thread_metadata_poll(void *data);
1021 void *consumer_thread_data_poll(void *data);
1022 void *consumer_thread_sessiond_poll(void *data);
1023 void *consumer_thread_channel_poll(void *data);
1024 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1025 int sock, struct pollfd *consumer_sockpoll);
1027 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1028 struct lttng_consumer_local_data *ctx,
1029 bool locked_by_caller);
1030 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1031 void consumer_add_relayd_socket(uint64_t net_seq_idx,
1033 struct lttng_consumer_local_data *ctx,
1035 struct pollfd *consumer_sockpoll,
1036 uint64_t sessiond_id,
1037 uint64_t relayd_session_id,
1038 uint32_t relayd_version_major,
1039 uint32_t relayd_version_minor,
1040 enum lttcomm_sock_proto relayd_socket_protocol);
1041 void consumer_flag_relayd_for_destroy(
1042 struct consumer_relayd_sock_pair *relayd);
1043 int consumer_data_pending(uint64_t id);
1044 int consumer_send_status_msg(int sock, int ret_code);
1045 int consumer_send_status_channel(int sock,
1046 struct lttng_consumer_channel *channel);
1047 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
1049 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1050 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1051 unsigned long produced_pos, uint64_t nb_packets_per_stream,
1052 uint64_t max_sb_size);
1053 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1054 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1055 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1056 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1057 int consumer_create_index_file(struct lttng_consumer_stream *stream);
1058 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1059 uint64_t key, uint64_t relayd_id);
1060 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1061 int lttng_consumer_rotate_stream(struct lttng_consumer_stream *stream);
1062 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
1064 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1065 enum lttcomm_return_code lttng_consumer_create_trace_chunk(
1066 const uint64_t *relayd_id, uint64_t session_id,
1068 time_t chunk_creation_timestamp,
1069 const char *chunk_override_name,
1070 const struct lttng_credentials *credentials,
1071 struct lttng_directory_handle *chunk_directory_handle);
1072 enum lttcomm_return_code lttng_consumer_close_trace_chunk(
1073 const uint64_t *relayd_id, uint64_t session_id,
1074 uint64_t chunk_id, time_t chunk_close_timestamp,
1075 const enum lttng_trace_chunk_command_type *close_command,
1077 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
1078 const uint64_t *relayd_id, uint64_t session_id,
1080 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1081 enum lttcomm_return_code lttng_consumer_init_command(
1082 struct lttng_consumer_local_data *ctx,
1083 const lttng_uuid& sessiond_uuid);
1084 int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1085 enum lttcomm_return_code lttng_consumer_open_channel_packets(
1086 struct lttng_consumer_channel *channel);
1087 int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel);
1088 void lttng_consumer_sigbus_handle(void *addr);
1089 void sample_and_send_channel_buffer_stats(struct lttng_consumer_channel *channel);
1091 #endif /* LIB_CONSUMER_H */