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;
258 struct stream_subbuffer {
261 * CONSUMER_CHANNEL_SPLICE
262 * No ownership assumed.
265 /* CONSUMER_CHANNEL_MMAP */
266 struct lttng_buffer_view buffer;
270 * Common members are fine to access through either
271 * union entries (as per C11, Common Initial Sequence).
274 unsigned long subbuf_size;
275 unsigned long padded_subbuf_size;
278 * Left unset when unsupported.
280 * Indicates that this is the last sub-buffer of
281 * a series of sub-buffer that makes-up a coherent
282 * (parseable) unit of metadata.
284 LTTNG_OPTIONAL(bool) coherent;
287 unsigned long subbuf_size;
288 unsigned long padded_subbuf_size;
289 uint64_t packet_size;
290 uint64_t content_size;
291 uint64_t timestamp_begin;
292 uint64_t timestamp_end;
293 uint64_t events_discarded;
294 /* Left unset when unsupported. */
295 LTTNG_OPTIONAL(uint64_t) sequence_number;
297 /* Left unset when unsupported. */
298 LTTNG_OPTIONAL(uint64_t) stream_instance_id;
303 enum get_next_subbuffer_status {
304 GET_NEXT_SUBBUFFER_STATUS_OK,
305 GET_NEXT_SUBBUFFER_STATUS_NO_DATA,
306 GET_NEXT_SUBBUFFER_STATUS_ERROR,
310 * Perform any operation required to acknowledge
311 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
313 * Stream and channel locks are acquired during this call.
315 typedef int (*on_wake_up_cb)(struct lttng_consumer_stream *);
318 * Perform any operation required before a consumer stream is put
319 * to sleep before awaiting a data availability notification.
321 * Stream and channel locks are acquired during this call.
323 typedef int (*on_sleep_cb)(struct lttng_consumer_stream *,
324 struct lttng_consumer_local_data *);
327 * Acquire the subbuffer at the current 'consumed' position.
329 * Stream and channel locks are acquired during this call.
331 typedef enum get_next_subbuffer_status (*get_next_subbuffer_cb)(
332 struct lttng_consumer_stream *, struct stream_subbuffer *);
335 * Populate the stream_subbuffer's info member. The info to populate
336 * depends on the type (metadata/data) of the stream.
338 * Stream and channel locks are acquired during this call.
340 typedef int (*extract_subbuffer_info_cb)(
341 struct lttng_consumer_stream *, struct stream_subbuffer *);
344 * Invoked after a subbuffer's info has been filled.
346 * Stream and channel locks are acquired during this call.
348 typedef int (*pre_consume_subbuffer_cb)(struct lttng_consumer_stream *,
349 const struct stream_subbuffer *);
352 * Consume subbuffer contents.
354 * Stream and channel locks are acquired during this call.
356 typedef ssize_t (*consume_subbuffer_cb)(struct lttng_consumer_local_data *,
357 struct lttng_consumer_stream *,
358 const struct stream_subbuffer *);
361 * Release the current subbuffer and advance the 'consumed' position by
364 * Stream and channel locks are acquired during this call.
366 typedef int (*put_next_subbuffer_cb)(struct lttng_consumer_stream *,
367 struct stream_subbuffer *);
370 * Invoked after consuming a subbuffer.
372 * Stream and channel locks are acquired during this call.
374 typedef int (*post_consume_cb)(struct lttng_consumer_stream *,
375 const struct stream_subbuffer *,
376 struct lttng_consumer_local_data *);
379 * Send a live beacon if no data is available.
381 * Stream and channel locks are acquired during this call.
383 typedef int (*send_live_beacon_cb)(struct lttng_consumer_stream *);
386 * Lock the stream and channel locks and any other stream-type specific
387 * lock that need to be acquired during the processing of an
388 * availability notification.
390 typedef void (*lock_cb)(struct lttng_consumer_stream *);
393 * Unlock the stream and channel locks and any other stream-type specific
394 * lock before sleeping until the next availability notification.
396 * Stream and channel locks are acquired during this call.
398 typedef void (*unlock_cb)(struct lttng_consumer_stream *);
401 * Assert that the stream and channel lock and any other stream type specific
402 * lock that need to be acquired during the processing of a read_subbuffer
403 * operation is acquired.
405 typedef void (*assert_locked_cb)(struct lttng_consumer_stream *);
408 * Invoked when a subbuffer's metadata version does not match the last
409 * known metadata version.
411 * Stream and channel locks are acquired during this call.
413 typedef void (*reset_metadata_cb)(struct lttng_consumer_stream *);
416 * Internal representation of the streams, sessiond_key is used to identify
419 struct lttng_consumer_stream {
420 /* HT node used by the data_ht and metadata_ht */
421 struct lttng_ht_node_u64 node;
422 /* stream indexed per channel key node */
423 struct lttng_ht_node_u64 node_channel_id;
424 /* HT node used in consumer_data.stream_list_ht */
425 struct lttng_ht_node_u64 node_session_id;
427 * List used by channels to reference streams that are not yet globally
430 struct cds_list_head send_node;
431 /* Pointer to associated channel. */
432 struct lttng_consumer_channel *chan;
434 * Current trace chunk. Holds a reference to the trace chunk.
435 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
436 * when it was created in the context of a no-output session.
438 struct lttng_trace_chunk *trace_chunk;
440 /* Key by which the stream is indexed for 'node'. */
443 * File descriptor of the data output file. This can be either a file or a
444 * socket fd for relayd streaming.
446 int out_fd; /* output file to write the data */
447 /* Write position in the output file descriptor */
449 /* Amount of bytes written to the output */
450 uint64_t output_written;
453 * When a stream's pipe is hung up, a final flush is performed (see hangup_flush_done). This
454 * indicates whether or not the data resulting from this flush is still to be consumed.
456 int has_data_left_to_be_read_before_teardown;
457 int hangup_flush_done;
460 * Whether the stream is in a "complete" state (e.g. it does not have a
461 * partially written sub-buffer.
463 * Initialized to "false" on stream creation (first packet is empty).
465 * The various transitions of the quiescent state are:
466 * - On "start" tracing: set to false, since the stream is not
468 * - On "stop" tracing: if !quiescent -> flush FINAL (update
469 * timestamp_end), and set to true; the stream has entered a
470 * complete/quiescent state.
471 * - On "destroy" or stream/application hang-up: if !quiescent ->
472 * flush FINAL, and set to true.
474 * NOTE: Update and read are protected by the stream lock.
479 * True if the sequence number is not available (lttng-modules < 2.8).
481 bool sequence_number_unavailable;
484 * metadata_timer_lock protects flags waiting_on_metadata and
485 * missed_metadata_flush.
487 pthread_mutex_t metadata_timer_lock;
489 * Flag set when awaiting metadata to be pushed. Used in the
490 * timer thread to skip waiting on the stream (and stream lock) to
491 * ensure we can proceed to flushing metadata in live mode.
493 bool waiting_on_metadata;
494 /* Raised when a timer misses a metadata flush. */
495 bool missed_metadata_flush;
497 enum lttng_event_output output;
498 /* Maximum subbuffer size (in bytes). */
499 unsigned long max_sb_size;
502 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
503 * used for the mmap base and offset.
506 unsigned long mmap_len;
511 /* Network sequence number. Indicating on which relayd socket it goes. */
512 uint64_t net_seq_idx;
514 * Indicate if this stream was successfully sent to a relayd. This is set
515 * after the refcount of the relayd is incremented and is checked when the
516 * stream is closed before decrementing the refcount in order to avoid an
519 unsigned int sent_to_relayd;
521 /* Identify if the stream is the metadata */
522 unsigned int metadata_flag;
524 * Last known metadata version, reset the metadata file in case
527 uint64_t metadata_version;
528 /* Used when the stream is set for network streaming */
529 uint64_t relayd_stream_id;
531 * When sending a stream packet to a relayd, this number is used to track
532 * the packet sent by the consumer and seen by the relayd. When sending the
533 * data header to the relayd, this number is sent and if the transmission
534 * was successful, it is incremented.
536 * Even if the full data is not fully transmitted it won't matter since
537 * only two possible error can happen after that where either the relayd
538 * died or a read error is detected on the stream making this value useless
541 * This value SHOULD be read/updated atomically or with the lock acquired.
543 uint64_t next_net_seq_num;
545 * Lock to use the stream FDs since they are used between threads.
547 * This is nested INSIDE the consumer_data lock.
548 * This is nested INSIDE the channel lock.
549 * This is nested INSIDE the channel timer lock.
550 * This is nested OUTSIDE the metadata cache lock.
551 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
553 pthread_mutex_t lock;
554 /* Tracing session id */
557 * Indicates if the stream end point is still active or not (network
558 * streaming or local file system). The thread "owning" the stream is
559 * handling this status and can be notified of a state change through the
560 * consumer data appropriate pipe.
562 enum consumer_endpoint_status endpoint_status;
563 /* Stream name. Format is: <channel_name>_<cpu_number> */
564 char name[LTTNG_SYMBOL_NAME_LEN];
565 /* Internal state of libustctl. */
566 struct lttng_ust_ctl_consumer_stream *ustream;
567 /* On-disk circular buffer */
568 uint64_t tracefile_size_current;
569 uint64_t tracefile_count_current;
571 * Monitor or not the streams of this channel meaning this indicates if the
572 * streams should be sent to the data/metadata thread or added to the no
573 * monitor list of the channel.
575 unsigned int monitor;
577 * Indicate if the stream is globally visible meaning that it has been
578 * added to the multiple hash tables. If *not* set, NO lock should be
579 * acquired in the destroy path.
581 unsigned int globally_visible;
583 * Pipe to wake up the metadata poll thread when the UST metadata
586 int ust_metadata_poll_pipe[2];
588 * How much metadata was read from the metadata cache and sent
591 uint64_t ust_metadata_pushed;
593 * Copy of the last discarded event value to detect the overflow of
596 uint64_t last_discarded_events;
597 /* Copy of the sequence number of the last packet extracted. */
598 uint64_t last_sequence_number;
600 * Index file object of the index file for this stream.
602 struct lttng_index_file *index_file;
605 * Local pipe to extract data when using splice.
610 * Rendez-vous point between data and metadata stream in live mode.
612 pthread_cond_t metadata_rdv;
613 pthread_mutex_t metadata_rdv_lock;
616 * rotate_position represents the packet sequence number of the last
617 * packet which belongs to the current trace chunk prior to the rotation.
618 * When that position is reached, this tracefile can be closed and a
619 * new one is created in channel_read_only_attributes.path.
621 uint64_t rotate_position;
623 /* Whether or not a packet was opened during the current trace chunk. */
624 bool opened_packet_in_current_trace_chunk;
627 * Read-only copies of channel values. We cannot safely access the
628 * channel from a stream, so we need to have a local copy of these
629 * fields in the stream object. These fields should be removed from
630 * the stream objects when we introduce refcounting.
633 uint64_t tracefile_size;
634 } channel_read_only_attributes;
637 * Flag to inform the data or metadata thread that a stream is
638 * ready to be rotated.
642 /* Indicate if the stream still has some data to be read. */
643 unsigned int has_data:1;
645 * Inform the consumer or relay to reset the metadata
646 * file before writing in it (regeneration).
648 unsigned int reset_metadata_flag:1;
651 * Invoked in the order of declaration.
652 * See callback type definitions.
655 on_wake_up_cb on_wake_up;
656 get_next_subbuffer_cb get_next_subbuffer;
657 extract_subbuffer_info_cb extract_subbuffer_info;
658 pre_consume_subbuffer_cb pre_consume_subbuffer;
659 reset_metadata_cb reset_metadata;
660 consume_subbuffer_cb consume_subbuffer;
661 put_next_subbuffer_cb put_next_subbuffer;
662 struct lttng_dynamic_array post_consume_cbs;
663 send_live_beacon_cb send_live_beacon;
664 on_sleep_cb on_sleep;
666 assert_locked_cb assert_locked;
667 } read_subbuffer_ops;
668 struct metadata_bucket *metadata_bucket;
672 * Internal representation of a relayd socket pair.
674 struct consumer_relayd_sock_pair {
675 /* Network sequence number. */
676 uint64_t net_seq_idx;
677 /* Number of stream associated with this relayd */
681 * This flag indicates whether or not we should destroy this object. The
682 * destruction should ONLY occurs when this flag is set and the refcount is
685 unsigned int destroy_flag;
688 * Mutex protecting the control socket to avoid out of order packets
689 * between threads sending data to the relayd. Since metadata data is sent
690 * over that socket, at least two sendmsg() are needed (header + data)
691 * creating a race for packets to overlap between threads using it.
693 * This is nested INSIDE the consumer_data lock.
694 * This is nested INSIDE the stream lock.
696 pthread_mutex_t ctrl_sock_mutex;
698 /* Control socket. Command and metadata are passed over it */
699 struct lttcomm_relayd_sock control_sock;
702 * We don't need a mutex at this point since we only splice or write single
703 * large chunk of data with a header appended at the begining. Moreover,
704 * this socket is for now only used in a single thread.
706 struct lttcomm_relayd_sock data_sock;
707 struct lttng_ht_node_u64 node;
709 /* Session id on both sides for the sockets. */
710 uint64_t relayd_session_id;
711 uint64_t sessiond_session_id;
712 struct lttng_consumer_local_data *ctx;
716 * UST consumer local data to the program. One or more instance per
719 struct lttng_consumer_local_data {
721 * Function to call when data is available on a buffer.
722 * Returns the number of bytes read, or negative error value.
724 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
725 struct lttng_consumer_local_data *ctx,
726 bool locked_by_caller);
728 * function to call when we receive a new channel, it receives a
729 * newly allocated channel, depending on the return code of this
730 * function, the new channel will be handled by the application
734 * > 0 (success, FD is kept by application)
735 * == 0 (success, FD is left to library)
738 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
740 * function to call when we receive a new stream, it receives a
741 * newly allocated stream, depending on the return code of this
742 * function, the new stream will be handled by the application
746 * > 0 (success, FD is kept by application)
747 * == 0 (success, FD is left to library)
750 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
752 * function to call when a stream is getting updated by the session
753 * daemon, this function receives the sessiond key and the new
754 * state, depending on the return code of this function the
755 * update of state for the stream is handled by the application
759 * > 0 (success, FD is kept by application)
760 * == 0 (success, FD is left to library)
763 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
764 enum lttng_consumer_type type;
765 /* socket to communicate errors with sessiond */
766 int consumer_error_socket;
767 /* socket to ask metadata to sessiond. */
768 int consumer_metadata_socket;
770 * Protect consumer_metadata_socket.
772 * This is nested OUTSIDE the metadata cache lock.
774 pthread_mutex_t metadata_socket_lock;
775 /* socket to exchange commands with sessiond */
776 char *consumer_command_sock_path;
777 /* communication with splice */
778 int consumer_channel_pipe[2];
779 /* Data stream poll thread pipe. To transfer data stream to the thread */
780 struct lttng_pipe *consumer_data_pipe;
783 * Data thread use that pipe to catch wakeup from read subbuffer that
784 * detects that there is still data to be read for the stream encountered.
785 * Before doing so, the stream is flagged to indicate that there is still
788 * Both pipes (read/write) are owned and used inside the data thread.
790 struct lttng_pipe *consumer_wakeup_pipe;
791 /* Indicate if the wakeup thread has been notified. */
792 unsigned int has_wakeup:1;
794 /* to let the signal handler wake up the fd receiver thread */
795 int consumer_should_quit[2];
796 /* Metadata poll thread pipe. Transfer metadata stream to it */
797 struct lttng_pipe *consumer_metadata_pipe;
799 * Pipe used by the channel monitoring timers to provide state samples
800 * to the session daemon (write-only).
802 int channel_monitor_pipe;
803 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
807 * Library-level data. One instance per process.
809 struct lttng_consumer_global_data {
811 * At this time, this lock is used to ensure coherence between the count
812 * and number of element in the hash table. It's also a protection for
813 * concurrent read/write between threads.
815 * This is nested OUTSIDE the stream lock.
816 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
818 pthread_mutex_t lock {};
821 * Number of streams in the data stream hash table declared outside.
822 * Protected by consumer_data.lock.
824 int stream_count = 0;
826 /* Channel hash table protected by consumer_data.lock. */
827 struct lttng_ht *channel_ht = nullptr;
828 /* Channel hash table indexed by session id. */
829 struct lttng_ht *channels_by_session_id_ht = nullptr;
831 * Flag specifying if the local array of FDs needs update in the
832 * poll function. Protected by consumer_data.lock.
834 unsigned int need_update = 1;
835 enum lttng_consumer_type type = LTTNG_CONSUMER_UNKNOWN;
838 * Relayd socket(s) hashtable indexed by network sequence number. Each
839 * stream has an index which associate the right relayd socket to use.
841 struct lttng_ht *relayd_ht = nullptr;
844 * This hash table contains all streams (metadata and data) indexed by
845 * session id. In other words, the ht is indexed by session id and each
846 * bucket contains the list of associated streams.
848 * This HT uses the "node_session_id" of the consumer stream.
850 struct lttng_ht *stream_list_ht = nullptr;
853 * This HT uses the "node_channel_id" of the consumer stream.
855 struct lttng_ht *stream_per_chan_id_ht = nullptr;
858 * Trace chunk registry indexed by (session_id, chunk_id).
860 struct lttng_trace_chunk_registry *chunk_registry = nullptr;
864 * Set to nonzero when the consumer is exiting. Updated by signal
865 * handler and thread exit, read by threads.
867 extern int consumer_quit;
870 * Set to nonzero when the consumer is exiting. Updated by signal
871 * handler and thread exit, read by threads.
873 extern int consumer_quit;
876 * Flag used to temporarily pause data consumption from testpoints.
878 * This variable is dlsym-ed from a test, so needs to be exported.
880 LTTNG_EXPORT extern int data_consumption_paused;
882 /* Return a human-readable consumer type string that is suitable for logging. */
884 const char *lttng_consumer_type_str(enum lttng_consumer_type type)
887 case LTTNG_CONSUMER_UNKNOWN:
889 case LTTNG_CONSUMER_KERNEL:
891 case LTTNG_CONSUMER32_UST:
892 return "32-bit user space";
893 case LTTNG_CONSUMER64_UST:
894 return "64-bit user space";
901 * Init consumer data structures.
903 int lttng_consumer_init(void);
906 * Set the error socket for communication with a session daemon.
908 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
912 * Set the command socket path for communication with a session daemon.
914 void lttng_consumer_set_command_sock_path(
915 struct lttng_consumer_local_data *ctx, char *sock);
918 * Send return code to session daemon.
920 * Returns the return code of sendmsg : the number of bytes transmitted or -1
923 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
926 * Called from signal handler to ensure a clean exit.
928 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
931 * Cleanup the daemon's socket on exit.
933 void lttng_consumer_cleanup(void);
936 * Poll on the should_quit pipe and the command socket return -1 on error and
937 * should exit, 0 if data is available on the command socket
939 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
942 * Copy the fields from the channel that need to be accessed (read-only)
943 * directly from the stream.
945 void consumer_stream_update_channel_attributes(
946 struct lttng_consumer_stream *stream,
947 struct lttng_consumer_channel *channel);
949 struct lttng_consumer_stream *consumer_allocate_stream(
950 struct lttng_consumer_channel *channel,
951 uint64_t channel_key,
953 const char *channel_name,
956 struct lttng_trace_chunk *trace_chunk,
959 enum consumer_channel_type type,
960 unsigned int monitor);
961 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
963 const uint64_t *chunk_id,
964 const char *pathname,
967 enum lttng_event_output output,
968 uint64_t tracefile_size,
969 uint64_t tracefile_count,
970 uint64_t session_id_per_pid,
971 unsigned int monitor,
972 unsigned int live_timer_interval,
973 bool is_in_live_session,
974 const char *root_shm_path,
975 const char *shm_path);
976 void consumer_del_stream(struct lttng_consumer_stream *stream,
977 struct lttng_ht *ht);
978 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
979 struct lttng_ht *ht);
980 int consumer_add_channel(struct lttng_consumer_channel *channel,
981 struct lttng_consumer_local_data *ctx);
982 void consumer_del_channel(struct lttng_consumer_channel *channel);
984 /* lttng-relayd consumer command */
985 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
986 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
987 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
988 void close_relayd_stream(struct lttng_consumer_stream *stream);
989 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
990 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
992 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
994 struct lttng_consumer_local_data *lttng_consumer_create(
995 enum lttng_consumer_type type,
996 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
997 struct lttng_consumer_local_data *ctx,
998 bool locked_by_caller),
999 int (*recv_channel)(struct lttng_consumer_channel *channel),
1000 int (*recv_stream)(struct lttng_consumer_stream *stream),
1001 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
1002 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
1003 ssize_t lttng_consumer_on_read_subbuffer_mmap(
1004 struct lttng_consumer_stream *stream,
1005 const struct lttng_buffer_view *buffer,
1006 unsigned long padding);
1007 ssize_t lttng_consumer_on_read_subbuffer_splice(
1008 struct lttng_consumer_local_data *ctx,
1009 struct lttng_consumer_stream *stream, unsigned long len,
1010 unsigned long padding);
1011 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
1012 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
1013 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
1014 unsigned long *pos);
1015 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
1016 unsigned long *pos);
1017 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
1018 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
1019 void *consumer_thread_metadata_poll(void *data);
1020 void *consumer_thread_data_poll(void *data);
1021 void *consumer_thread_sessiond_poll(void *data);
1022 void *consumer_thread_channel_poll(void *data);
1023 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1024 int sock, struct pollfd *consumer_sockpoll);
1026 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1027 struct lttng_consumer_local_data *ctx,
1028 bool locked_by_caller);
1029 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1030 void consumer_add_relayd_socket(uint64_t net_seq_idx,
1032 struct lttng_consumer_local_data *ctx,
1034 struct pollfd *consumer_sockpoll,
1035 uint64_t sessiond_id,
1036 uint64_t relayd_session_id,
1037 uint32_t relayd_version_major,
1038 uint32_t relayd_version_minor,
1039 enum lttcomm_sock_proto relayd_socket_protocol);
1040 void consumer_flag_relayd_for_destroy(
1041 struct consumer_relayd_sock_pair *relayd);
1042 int consumer_data_pending(uint64_t id);
1043 int consumer_send_status_msg(int sock, int ret_code);
1044 int consumer_send_status_channel(int sock,
1045 struct lttng_consumer_channel *channel);
1046 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
1048 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1049 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1050 unsigned long produced_pos, uint64_t nb_packets_per_stream,
1051 uint64_t max_sb_size);
1052 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1053 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1054 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1055 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1056 int consumer_create_index_file(struct lttng_consumer_stream *stream);
1057 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1058 uint64_t key, uint64_t relayd_id);
1059 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1060 int lttng_consumer_rotate_stream(struct lttng_consumer_stream *stream);
1061 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
1063 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1064 enum lttcomm_return_code lttng_consumer_create_trace_chunk(
1065 const uint64_t *relayd_id, uint64_t session_id,
1067 time_t chunk_creation_timestamp,
1068 const char *chunk_override_name,
1069 const struct lttng_credentials *credentials,
1070 struct lttng_directory_handle *chunk_directory_handle);
1071 enum lttcomm_return_code lttng_consumer_close_trace_chunk(
1072 const uint64_t *relayd_id, uint64_t session_id,
1073 uint64_t chunk_id, time_t chunk_close_timestamp,
1074 const enum lttng_trace_chunk_command_type *close_command,
1076 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
1077 const uint64_t *relayd_id, uint64_t session_id,
1079 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1080 enum lttcomm_return_code lttng_consumer_init_command(
1081 struct lttng_consumer_local_data *ctx,
1082 const lttng_uuid& sessiond_uuid);
1083 int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1084 enum lttcomm_return_code lttng_consumer_open_channel_packets(
1085 struct lttng_consumer_channel *channel);
1086 int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel);
1087 void lttng_consumer_sigbus_handle(void *addr);
1088 void sample_and_send_channel_buffer_stats(struct lttng_consumer_channel *channel);
1090 #endif /* LIB_CONSUMER_H */