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
14 #include <common/buffer-view.hpp>
15 #include <common/credentials.hpp>
16 #include <common/dynamic-array.hpp>
17 #include <common/hashtable/hashtable.hpp>
18 #include <common/index/ctf-index.hpp>
19 #include <common/pipe.hpp>
20 #include <common/sessiond-comm/sessiond-comm.hpp>
21 #include <common/trace-chunk-registry.hpp>
22 #include <common/uuid.hpp>
24 #include <lttng/lttng.h>
30 #include <urcu/list.h>
32 struct lttng_consumer_local_data;
34 /* Commands for consumer */
35 enum lttng_consumer_command {
36 LTTNG_CONSUMER_ADD_CHANNEL,
37 LTTNG_CONSUMER_ADD_STREAM,
38 /* pause, delete, active depending on fd state */
39 LTTNG_CONSUMER_UPDATE_STREAM,
40 /* inform the consumer to quit when all fd has hang up */
41 LTTNG_CONSUMER_STOP, /* deprecated */
42 LTTNG_CONSUMER_ADD_RELAYD_SOCKET,
43 /* Inform the consumer to kill a specific relayd connection */
44 LTTNG_CONSUMER_DESTROY_RELAYD,
45 /* Return to the sessiond if there is data pending for a session */
46 LTTNG_CONSUMER_DATA_PENDING,
47 /* Consumer creates a channel and returns it to sessiond. */
48 LTTNG_CONSUMER_ASK_CHANNEL_CREATION,
49 LTTNG_CONSUMER_GET_CHANNEL,
50 LTTNG_CONSUMER_DESTROY_CHANNEL,
51 LTTNG_CONSUMER_PUSH_METADATA,
52 LTTNG_CONSUMER_CLOSE_METADATA,
53 LTTNG_CONSUMER_SETUP_METADATA,
54 LTTNG_CONSUMER_FLUSH_CHANNEL,
55 LTTNG_CONSUMER_SNAPSHOT_CHANNEL,
56 LTTNG_CONSUMER_SNAPSHOT_METADATA,
57 LTTNG_CONSUMER_STREAMS_SENT,
58 LTTNG_CONSUMER_DISCARDED_EVENTS,
59 LTTNG_CONSUMER_LOST_PACKETS,
60 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL,
61 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE,
62 LTTNG_CONSUMER_ROTATE_CHANNEL,
64 LTTNG_CONSUMER_CREATE_TRACE_CHUNK,
65 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK,
66 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS,
67 LTTNG_CONSUMER_CLEAR_CHANNEL,
68 LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS,
71 enum lttng_consumer_type {
72 LTTNG_CONSUMER_UNKNOWN = 0,
73 LTTNG_CONSUMER_KERNEL,
78 enum consumer_endpoint_status {
79 CONSUMER_ENDPOINT_ACTIVE,
80 CONSUMER_ENDPOINT_INACTIVE,
83 enum consumer_channel_output {
84 CONSUMER_CHANNEL_MMAP = 0,
85 CONSUMER_CHANNEL_SPLICE = 1,
88 enum consumer_channel_type {
89 CONSUMER_CHANNEL_TYPE_METADATA = 0,
90 CONSUMER_CHANNEL_TYPE_DATA = 1,
93 enum sync_metadata_status {
94 SYNC_METADATA_STATUS_NEW_DATA,
95 SYNC_METADATA_STATUS_NO_DATA,
96 SYNC_METADATA_STATUS_ERROR,
99 extern struct lttng_consumer_global_data the_consumer_data;
102 struct cds_list_head head;
107 struct consumer_metadata_cache;
109 struct lttng_consumer_channel {
110 /* Is the channel published in the channel hash tables? */
113 * Was the channel deleted (logically) and waiting to be reclaimed?
114 * If this flag is set, no modification that is not cleaned-up by the
115 * RCU reclamation callback should be made
118 /* HT node used for consumer_data.channel_ht */
119 struct lttng_ht_node_u64 node;
120 /* HT node used for consumer_data.channels_by_session_id_ht */
121 struct lttng_ht_node_u64 channels_by_session_id_ht_node;
122 /* Indexed key. Incremented value in the consumer. */
124 /* Number of streams referencing this channel */
126 /* Tracing session id on the session daemon side. */
128 /* Current trace chunk of the session in which this channel exists. */
129 struct lttng_trace_chunk *trace_chunk;
131 * Session id when requesting metadata to the session daemon for
132 * a session with per-PID buffers.
134 uint64_t session_id_per_pid;
136 * In the case of local streams, this field contains the channel's
137 * output path; a path relative to the session's output path.
138 * e.g. ust/uid/1000/64-bit
140 * In the case of remote streams, the contents of this field depends
141 * on the version of the relay daemon peer. For 2.11+ peers, the
142 * contents are the same as in the local case. However, for legacy
143 * peers, this contains a path of the form:
144 * /hostname/session_path/ust/uid/1000/64-bit
146 char pathname[PATH_MAX];
148 char name[LTTNG_SYMBOL_NAME_LEN];
149 /* Relayd id of the channel. -1ULL if it does not apply. */
152 * Number of streams NOT initialized yet. This is used in order to not
153 * delete this channel if streams are getting initialized.
155 unsigned int nb_init_stream_left;
156 /* Output type (mmap or splice). */
157 enum consumer_channel_output output;
158 /* Channel type for stream */
159 enum consumer_channel_type type;
162 uid_t ust_app_uid; /* Application UID. */
163 struct lttng_ust_ctl_consumer_channel *uchan;
164 unsigned char uuid[LTTNG_UUID_STR_LEN];
166 * Temporary stream list used to store the streams once created and waiting
167 * to be sent to the session daemon by receiving the
168 * LTTNG_CONSUMER_GET_CHANNEL.
170 struct stream_list streams;
173 * Set if the channel is metadata. We keep a reference to the stream
174 * because we have to flush data once pushed by the session daemon. For a
175 * regular channel, this is always set to NULL.
177 struct lttng_consumer_stream *metadata_stream;
181 /* Node within channel thread ht */
182 struct lttng_ht_node_u64 wait_fd_node;
184 /* Metadata cache is metadata channel */
185 struct consumer_metadata_cache *metadata_cache;
187 /* For UST metadata periodical flush */
188 int switch_timer_enabled;
189 timer_t switch_timer;
190 int switch_timer_error;
192 /* For the live mode */
193 int live_timer_enabled;
195 int live_timer_error;
196 /* Channel is part of a live session ? */
199 /* For channel monitoring timer. */
200 int monitor_timer_enabled;
201 timer_t monitor_timer;
203 /* On-disk circular buffer */
204 uint64_t tracefile_size;
205 uint64_t tracefile_count;
207 * Monitor or not the streams of this channel meaning this indicates if the
208 * streams should be sent to the data/metadata thread or added to the no
209 * monitor list of the channel.
211 unsigned int monitor;
216 * This lock protects against concurrent update of channel.
218 * This is nested INSIDE the consumer data lock.
219 * This is nested OUTSIDE the channel timer lock.
220 * This is nested OUTSIDE the metadata cache lock.
221 * This is nested OUTSIDE stream lock.
222 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
224 pthread_mutex_t lock;
227 * Channel teardown lock.
229 * This lock protect against teardown of channel. It is _never_
230 * taken by the timer handler.
232 * This is nested INSIDE the consumer data lock.
233 * This is nested INSIDE the channel lock.
234 * This is nested OUTSIDE the metadata cache lock.
235 * This is nested OUTSIDE stream lock.
236 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
238 pthread_mutex_t timer_lock;
240 /* Timer value in usec for live streaming. */
241 unsigned int live_timer_interval;
245 char root_shm_path[PATH_MAX];
246 char shm_path[PATH_MAX];
247 /* Only set for UST channels. */
248 LTTNG_OPTIONAL(struct lttng_credentials) buffer_credentials;
249 /* Total number of discarded events for that channel. */
250 uint64_t discarded_events;
251 /* Total number of missed packets due to overwriting (overwrite). */
252 uint64_t lost_packets;
254 bool streams_sent_to_relayd;
255 uint64_t last_consumed_size_sample_sent;
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 using on_wake_up_cb = int (*)(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 using on_sleep_cb = int (*)(struct lttng_consumer_stream *, struct lttng_consumer_local_data *);
326 * Acquire the subbuffer at the current 'consumed' position.
328 * Stream and channel locks are acquired during this call.
330 using get_next_subbuffer_cb = enum get_next_subbuffer_status (*)(struct lttng_consumer_stream *,
331 struct stream_subbuffer *);
334 * Populate the stream_subbuffer's info member. The info to populate
335 * depends on the type (metadata/data) of the stream.
337 * Stream and channel locks are acquired during this call.
339 using extract_subbuffer_info_cb = int (*)(struct lttng_consumer_stream *,
340 struct stream_subbuffer *);
343 * Invoked after a subbuffer's info has been filled.
345 * Stream and channel locks are acquired during this call.
347 using pre_consume_subbuffer_cb = int (*)(struct lttng_consumer_stream *,
348 const struct stream_subbuffer *);
351 * Consume subbuffer contents.
353 * Stream and channel locks are acquired during this call.
355 using consume_subbuffer_cb = ssize_t (*)(struct lttng_consumer_local_data *,
356 struct lttng_consumer_stream *,
357 const struct stream_subbuffer *);
360 * Release the current subbuffer and advance the 'consumed' position by
363 * Stream and channel locks are acquired during this call.
365 using put_next_subbuffer_cb = int (*)(struct lttng_consumer_stream *, struct stream_subbuffer *);
368 * Invoked after consuming a subbuffer.
370 * Stream and channel locks are acquired during this call.
372 using post_consume_cb = int (*)(struct lttng_consumer_stream *,
373 const struct stream_subbuffer *,
374 struct lttng_consumer_local_data *);
377 * Send a live beacon if no data is available.
379 * Stream and channel locks are acquired during this call.
381 using send_live_beacon_cb = int (*)(struct lttng_consumer_stream *);
384 * Lock the stream and channel locks and any other stream-type specific
385 * lock that need to be acquired during the processing of an
386 * availability notification.
388 using lock_cb = void (*)(struct lttng_consumer_stream *);
391 * Unlock the stream and channel locks and any other stream-type specific
392 * lock before sleeping until the next availability notification.
394 * Stream and channel locks are acquired during this call.
396 using unlock_cb = void (*)(struct lttng_consumer_stream *);
399 * Assert that the stream and channel lock and any other stream type specific
400 * lock that need to be acquired during the processing of a read_subbuffer
401 * operation is acquired.
403 using assert_locked_cb = void (*)(struct lttng_consumer_stream *);
406 * Invoked when a subbuffer's metadata version does not match the last
407 * known metadata version.
409 * Stream and channel locks are acquired during this call.
411 using reset_metadata_cb = void (*)(struct lttng_consumer_stream *);
414 * Internal representation of the streams, sessiond_key is used to identify
417 struct lttng_consumer_stream {
418 /* HT node used by the data_ht and metadata_ht */
419 struct lttng_ht_node_u64 node;
420 /* stream indexed per channel key node */
421 struct lttng_ht_node_u64 node_channel_id;
422 /* HT node used in consumer_data.stream_list_ht */
423 struct lttng_ht_node_u64 node_session_id;
425 * List used by channels to reference streams that are not yet globally
428 struct cds_list_head send_node;
429 /* Pointer to associated channel. */
430 struct lttng_consumer_channel *chan;
432 * Current trace chunk. Holds a reference to the trace chunk.
433 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
434 * when it was created in the context of a no-output session.
436 struct lttng_trace_chunk *trace_chunk;
438 /* Key by which the stream is indexed for 'node'. */
441 * File descriptor of the data output file. This can be either a file or a
442 * socket fd for relayd streaming.
444 int out_fd; /* output file to write the data */
445 /* Write position in the output file descriptor */
447 /* Amount of bytes written to the output */
448 uint64_t output_written;
451 * When a stream's pipe is hung up, a final flush is performed (see hangup_flush_done). This
452 * indicates whether or not the data resulting from this flush is still to be consumed.
454 int has_data_left_to_be_read_before_teardown;
455 int hangup_flush_done;
458 * Whether the stream is in a "complete" state (e.g. it does not have a
459 * partially written sub-buffer.
461 * Initialized to "false" on stream creation (first packet is empty).
463 * The various transitions of the quiescent state are:
464 * - On "start" tracing: set to false, since the stream is not
466 * - On "stop" tracing: if !quiescent -> flush FINAL (update
467 * timestamp_end), and set to true; the stream has entered a
468 * complete/quiescent state.
469 * - On "destroy" or stream/application hang-up: if !quiescent ->
470 * flush FINAL, and set to true.
472 * NOTE: Update and read are protected by the stream lock.
477 * True if the sequence number is not available (lttng-modules < 2.8).
479 bool sequence_number_unavailable;
482 * metadata_timer_lock protects flags waiting_on_metadata and
483 * missed_metadata_flush.
485 pthread_mutex_t metadata_timer_lock;
487 * Flag set when awaiting metadata to be pushed. Used in the
488 * timer thread to skip waiting on the stream (and stream lock) to
489 * ensure we can proceed to flushing metadata in live mode.
491 bool waiting_on_metadata;
492 /* Raised when a timer misses a metadata flush. */
493 bool missed_metadata_flush;
495 enum lttng_event_output output;
496 /* Maximum subbuffer size (in bytes). */
497 unsigned long max_sb_size;
500 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
501 * used for the mmap base and offset.
504 unsigned long mmap_len;
509 /* Network sequence number. Indicating on which relayd socket it goes. */
510 uint64_t net_seq_idx;
512 * Indicate if this stream was successfully sent to a relayd. This is set
513 * after the refcount of the relayd is incremented and is checked when the
514 * stream is closed before decrementing the refcount in order to avoid an
517 unsigned int sent_to_relayd;
519 /* Identify if the stream is the metadata */
520 unsigned int metadata_flag;
522 * Last known metadata version, reset the metadata file in case
525 uint64_t metadata_version;
526 /* Used when the stream is set for network streaming */
527 uint64_t relayd_stream_id;
529 * When sending a stream packet to a relayd, this number is used to track
530 * the packet sent by the consumer and seen by the relayd. When sending the
531 * data header to the relayd, this number is sent and if the transmission
532 * was successful, it is incremented.
534 * Even if the full data is not fully transmitted it won't matter since
535 * only two possible error can happen after that where either the relayd
536 * died or a read error is detected on the stream making this value useless
539 * This value SHOULD be read/updated atomically or with the lock acquired.
541 uint64_t next_net_seq_num;
543 * Lock to use the stream FDs since they are used between threads.
545 * This is nested INSIDE the consumer_data lock.
546 * This is nested INSIDE the channel lock.
547 * This is nested INSIDE the channel timer lock.
548 * This is nested OUTSIDE the metadata cache lock.
549 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
551 pthread_mutex_t lock;
552 /* Tracing session id */
555 * Indicates if the stream end point is still active or not (network
556 * streaming or local file system). The thread "owning" the stream is
557 * handling this status and can be notified of a state change through the
558 * consumer data appropriate pipe.
560 enum consumer_endpoint_status endpoint_status;
561 /* Stream name. Format is: <channel_name>_<cpu_number> */
562 char name[LTTNG_SYMBOL_NAME_LEN];
563 /* Internal state of libustctl. */
564 struct lttng_ust_ctl_consumer_stream *ustream;
565 /* On-disk circular buffer */
566 uint64_t tracefile_size_current;
567 uint64_t tracefile_count_current;
569 * Monitor or not the streams of this channel meaning this indicates if the
570 * streams should be sent to the data/metadata thread or added to the no
571 * monitor list of the channel.
573 unsigned int monitor;
575 * Indicate if the stream is globally visible meaning that it has been
576 * added to the multiple hash tables. If *not* set, NO lock should be
577 * acquired in the destroy path.
579 unsigned int globally_visible;
581 * Pipe to wake up the metadata poll thread when the UST metadata
584 int ust_metadata_poll_pipe[2];
586 * How much metadata was read from the metadata cache and sent
589 uint64_t ust_metadata_pushed;
591 * Copy of the last discarded event value to detect the overflow of
594 uint64_t last_discarded_events;
595 /* Copy of the sequence number of the last packet extracted. */
596 uint64_t last_sequence_number;
598 * Index file object of the index file for this stream.
600 struct lttng_index_file *index_file;
603 * Local pipe to extract data when using splice.
608 * Rendez-vous point between data and metadata stream in live mode.
610 pthread_cond_t metadata_rdv;
611 pthread_mutex_t metadata_rdv_lock;
614 * rotate_position represents the packet sequence number of the last
615 * packet which belongs to the current trace chunk prior to the rotation.
616 * When that position is reached, this tracefile can be closed and a
617 * new one is created in channel_read_only_attributes.path.
619 uint64_t rotate_position;
621 /* Whether or not a packet was opened during the current trace chunk. */
622 bool opened_packet_in_current_trace_chunk;
625 * Read-only copies of channel values. We cannot safely access the
626 * channel from a stream, so we need to have a local copy of these
627 * fields in the stream object. These fields should be removed from
628 * the stream objects when we introduce refcounting.
631 uint64_t tracefile_size;
632 } channel_read_only_attributes;
635 * Flag to inform the data or metadata thread that a stream is
636 * ready to be rotated.
640 /* Indicate if the stream still has some data to be read. */
641 unsigned int has_data:1;
643 * Inform the consumer or relay to reset the metadata
644 * file before writing in it (regeneration).
646 unsigned int reset_metadata_flag:1;
649 * Invoked in the order of declaration.
650 * See callback type definitions.
653 on_wake_up_cb on_wake_up;
654 get_next_subbuffer_cb get_next_subbuffer;
655 extract_subbuffer_info_cb extract_subbuffer_info;
656 pre_consume_subbuffer_cb pre_consume_subbuffer;
657 reset_metadata_cb reset_metadata;
658 consume_subbuffer_cb consume_subbuffer;
659 put_next_subbuffer_cb put_next_subbuffer;
660 struct lttng_dynamic_array post_consume_cbs;
661 send_live_beacon_cb send_live_beacon;
662 on_sleep_cb on_sleep;
664 assert_locked_cb assert_locked;
665 } read_subbuffer_ops;
666 struct metadata_bucket *metadata_bucket;
670 * Internal representation of a relayd socket pair.
672 struct consumer_relayd_sock_pair {
673 /* Network sequence number. */
674 uint64_t net_seq_idx;
675 /* Number of stream associated with this relayd */
679 * This flag indicates whether or not we should destroy this object. The
680 * destruction should ONLY occurs when this flag is set and the refcount is
683 unsigned int destroy_flag;
686 * Mutex protecting the control socket to avoid out of order packets
687 * between threads sending data to the relayd. Since metadata data is sent
688 * over that socket, at least two sendmsg() are needed (header + data)
689 * creating a race for packets to overlap between threads using it.
691 * This is nested INSIDE the consumer_data lock.
692 * This is nested INSIDE the stream lock.
694 pthread_mutex_t ctrl_sock_mutex;
696 /* Control socket. Command and metadata are passed over it */
697 struct lttcomm_relayd_sock control_sock;
700 * We don't need a mutex at this point since we only splice or write single
701 * large chunk of data with a header appended at the begining. Moreover,
702 * this socket is for now only used in a single thread.
704 struct lttcomm_relayd_sock data_sock;
705 struct lttng_ht_node_u64 node;
707 /* Session id on both sides for the sockets. */
708 uint64_t relayd_session_id;
709 uint64_t sessiond_session_id;
710 struct lttng_consumer_local_data *ctx;
714 * UST consumer local data to the program. One or more instance per
717 struct lttng_consumer_local_data {
719 * Function to call when data is available on a buffer.
720 * Returns the number of bytes read, or negative error value.
722 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
723 struct lttng_consumer_local_data *ctx,
724 bool locked_by_caller);
726 * function to call when we receive a new channel, it receives a
727 * newly allocated channel, depending on the return code of this
728 * function, the new channel will be handled by the application
732 * > 0 (success, FD is kept by application)
733 * == 0 (success, FD is left to library)
736 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
738 * function to call when we receive a new stream, it receives a
739 * newly allocated stream, depending on the return code of this
740 * function, the new stream will be handled by the application
744 * > 0 (success, FD is kept by application)
745 * == 0 (success, FD is left to library)
748 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
750 * function to call when a stream is getting updated by the session
751 * daemon, this function receives the sessiond key and the new
752 * state, depending on the return code of this function the
753 * update of state for the stream is handled by the application
757 * > 0 (success, FD is kept by application)
758 * == 0 (success, FD is left to library)
761 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
762 enum lttng_consumer_type type;
763 /* socket to communicate errors with sessiond */
764 int consumer_error_socket;
765 /* socket to ask metadata to sessiond. */
766 int consumer_metadata_socket;
768 * Protect consumer_metadata_socket.
770 * This is nested OUTSIDE the metadata cache lock.
772 pthread_mutex_t metadata_socket_lock;
773 /* socket to exchange commands with sessiond */
774 char *consumer_command_sock_path;
775 /* communication with splice */
776 int consumer_channel_pipe[2];
777 /* Data stream poll thread pipe. To transfer data stream to the thread */
778 struct lttng_pipe *consumer_data_pipe;
781 * Data thread use that pipe to catch wakeup from read subbuffer that
782 * detects that there is still data to be read for the stream encountered.
783 * Before doing so, the stream is flagged to indicate that there is still
786 * Both pipes (read/write) are owned and used inside the data thread.
788 struct lttng_pipe *consumer_wakeup_pipe;
789 /* Indicate if the wakeup thread has been notified. */
790 unsigned int has_wakeup:1;
792 /* to let the signal handler wake up the fd receiver thread */
793 int consumer_should_quit[2];
794 /* Metadata poll thread pipe. Transfer metadata stream to it */
795 struct lttng_pipe *consumer_metadata_pipe;
797 * Pipe used by the channel monitoring timers to provide state samples
798 * to the session daemon (write-only).
800 int channel_monitor_pipe;
801 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
805 * Library-level data. One instance per process.
807 struct lttng_consumer_global_data {
809 * At this time, this lock is used to ensure coherence between the count
810 * and number of element in the hash table. It's also a protection for
811 * concurrent read/write between threads.
813 * This is nested OUTSIDE the stream lock.
814 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
816 pthread_mutex_t lock{};
819 * Number of streams in the data stream hash table declared outside.
820 * Protected by consumer_data.lock.
822 int stream_count = 0;
824 /* Channel hash table protected by consumer_data.lock. */
825 struct lttng_ht *channel_ht = nullptr;
826 /* Channel hash table indexed by session id. */
827 struct lttng_ht *channels_by_session_id_ht = nullptr;
829 * Flag specifying if the local array of FDs needs update in the
830 * poll function. Protected by consumer_data.lock.
832 unsigned int need_update = 1;
833 enum lttng_consumer_type type = LTTNG_CONSUMER_UNKNOWN;
836 * Relayd socket(s) hashtable indexed by network sequence number. Each
837 * stream has an index which associate the right relayd socket to use.
839 struct lttng_ht *relayd_ht = nullptr;
842 * This hash table contains all streams (metadata and data) indexed by
843 * session id. In other words, the ht is indexed by session id and each
844 * bucket contains the list of associated streams.
846 * This HT uses the "node_session_id" of the consumer stream.
848 struct lttng_ht *stream_list_ht = nullptr;
851 * This HT uses the "node_channel_id" of the consumer stream.
853 struct lttng_ht *stream_per_chan_id_ht = nullptr;
856 * Trace chunk registry indexed by (session_id, chunk_id).
858 struct lttng_trace_chunk_registry *chunk_registry = nullptr;
862 * Set to nonzero when the consumer is exiting. Updated by signal
863 * handler and thread exit, read by threads.
865 extern int consumer_quit;
868 * Set to nonzero when the consumer is exiting. Updated by signal
869 * handler and thread exit, read by threads.
871 extern int consumer_quit;
874 * Flag used to temporarily pause data consumption from testpoints.
876 * This variable is dlsym-ed from a test, so needs to be exported.
878 LTTNG_EXPORT extern int data_consumption_paused;
880 /* Return a human-readable consumer type string that is suitable for logging. */
881 static inline const char *lttng_consumer_type_str(enum lttng_consumer_type type)
884 case LTTNG_CONSUMER_UNKNOWN:
886 case LTTNG_CONSUMER_KERNEL:
888 case LTTNG_CONSUMER32_UST:
889 return "32-bit user space";
890 case LTTNG_CONSUMER64_UST:
891 return "64-bit user space";
898 * Init consumer data structures.
900 int lttng_consumer_init();
903 * Set the error socket for communication with a session daemon.
905 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx, int sock);
908 * Set the command socket path for communication with a session daemon.
910 void lttng_consumer_set_command_sock_path(struct lttng_consumer_local_data *ctx, char *sock);
913 * Send return code to session daemon.
915 * Returns the return code of sendmsg : the number of bytes transmitted or -1
918 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
921 * Called from signal handler to ensure a clean exit.
923 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
926 * Cleanup the daemon's socket on exit.
928 void lttng_consumer_cleanup();
931 * Poll on the should_quit pipe and the command socket return -1 on error and
932 * should exit, 0 if data is available on the command socket
934 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
937 * Copy the fields from the channel that need to be accessed (read-only)
938 * directly from the stream.
940 void consumer_stream_update_channel_attributes(struct lttng_consumer_stream *stream,
941 struct lttng_consumer_channel *channel);
943 struct lttng_consumer_stream *consumer_allocate_stream(struct lttng_consumer_channel *channel,
944 uint64_t channel_key,
946 const char *channel_name,
949 struct lttng_trace_chunk *trace_chunk,
952 enum consumer_channel_type type,
953 unsigned int monitor);
954 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
956 const uint64_t *chunk_id,
957 const char *pathname,
960 enum lttng_event_output output,
961 uint64_t tracefile_size,
962 uint64_t tracefile_count,
963 uint64_t session_id_per_pid,
964 unsigned int monitor,
965 unsigned int live_timer_interval,
966 bool is_in_live_session,
967 const char *root_shm_path,
968 const char *shm_path);
969 void consumer_del_stream(struct lttng_consumer_stream *stream, struct lttng_ht *ht);
970 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream, struct lttng_ht *ht);
971 int consumer_add_channel(struct lttng_consumer_channel *channel,
972 struct lttng_consumer_local_data *ctx);
973 void consumer_del_channel(struct lttng_consumer_channel *channel);
975 /* lttng-relayd consumer command */
976 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
977 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
978 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
979 void close_relayd_stream(struct lttng_consumer_stream *stream);
980 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
981 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream, size_t data_size);
982 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
984 struct lttng_consumer_local_data *
985 lttng_consumer_create(enum lttng_consumer_type type,
986 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
987 struct lttng_consumer_local_data *ctx,
988 bool locked_by_caller),
989 int (*recv_channel)(struct lttng_consumer_channel *channel),
990 int (*recv_stream)(struct lttng_consumer_stream *stream),
991 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
992 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
993 ssize_t lttng_consumer_on_read_subbuffer_mmap(struct lttng_consumer_stream *stream,
994 const struct lttng_buffer_view *buffer,
995 unsigned long padding);
996 ssize_t lttng_consumer_on_read_subbuffer_splice(struct lttng_consumer_local_data *ctx,
997 struct lttng_consumer_stream *stream,
999 unsigned long padding);
1000 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
1001 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
1002 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream, unsigned long *pos);
1003 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream, unsigned long *pos);
1004 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
1005 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
1006 void *consumer_thread_metadata_poll(void *data);
1007 void *consumer_thread_data_poll(void *data);
1008 void *consumer_thread_sessiond_poll(void *data);
1009 void *consumer_thread_channel_poll(void *data);
1010 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1012 struct pollfd *consumer_sockpoll);
1014 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1015 struct lttng_consumer_local_data *ctx,
1016 bool locked_by_caller);
1017 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1018 void consumer_add_relayd_socket(uint64_t net_seq_idx,
1020 struct lttng_consumer_local_data *ctx,
1022 struct pollfd *consumer_sockpoll,
1023 uint64_t sessiond_id,
1024 uint64_t relayd_session_id,
1025 uint32_t relayd_version_major,
1026 uint32_t relayd_version_minor,
1027 enum lttcomm_sock_proto relayd_socket_protocol);
1028 void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair *relayd);
1029 int consumer_data_pending(uint64_t id);
1030 int consumer_send_status_msg(int sock, int ret_code);
1031 int consumer_send_status_channel(int sock, struct lttng_consumer_channel *channel);
1032 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx, uint64_t key);
1033 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1034 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1035 unsigned long produced_pos,
1036 uint64_t nb_packets_per_stream,
1037 uint64_t max_sb_size);
1038 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1039 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1040 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1041 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1042 int consumer_create_index_file(struct lttng_consumer_stream *stream);
1043 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1045 uint64_t relayd_id);
1046 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1047 int lttng_consumer_rotate_stream(struct lttng_consumer_stream *stream);
1048 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel, uint64_t key);
1049 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1050 enum lttcomm_return_code
1051 lttng_consumer_create_trace_chunk(const uint64_t *relayd_id,
1052 uint64_t session_id,
1054 time_t chunk_creation_timestamp,
1055 const char *chunk_override_name,
1056 const struct lttng_credentials *credentials,
1057 struct lttng_directory_handle *chunk_directory_handle);
1058 enum lttcomm_return_code
1059 lttng_consumer_close_trace_chunk(const uint64_t *relayd_id,
1060 uint64_t session_id,
1062 time_t chunk_close_timestamp,
1063 const enum lttng_trace_chunk_command_type *close_command,
1065 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(const uint64_t *relayd_id,
1066 uint64_t session_id,
1068 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1069 enum lttcomm_return_code lttng_consumer_init_command(struct lttng_consumer_local_data *ctx,
1070 const lttng_uuid& sessiond_uuid);
1071 int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1072 enum lttcomm_return_code
1073 lttng_consumer_open_channel_packets(struct lttng_consumer_channel *channel);
1074 int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel);
1075 void lttng_consumer_sigbus_handle(void *addr);
1076 void sample_and_send_channel_buffer_stats(struct lttng_consumer_channel *channel);
1078 #endif /* LIB_CONSUMER_H */