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 int hangup_flush_done;
456 * Whether the stream is in a "complete" state (e.g. it does not have a
457 * partially written sub-buffer.
459 * Initialized to "false" on stream creation (first packet is empty).
461 * The various transitions of the quiescent state are:
462 * - On "start" tracing: set to false, since the stream is not
464 * - On "stop" tracing: if !quiescent -> flush FINAL (update
465 * timestamp_end), and set to true; the stream has entered a
466 * complete/quiescent state.
467 * - On "destroy" or stream/application hang-up: if !quiescent ->
468 * flush FINAL, and set to true.
470 * NOTE: Update and read are protected by the stream lock.
475 * True if the sequence number is not available (lttng-modules < 2.8).
477 bool sequence_number_unavailable;
480 * metadata_timer_lock protects flags waiting_on_metadata and
481 * missed_metadata_flush.
483 pthread_mutex_t metadata_timer_lock;
485 * Flag set when awaiting metadata to be pushed. Used in the
486 * timer thread to skip waiting on the stream (and stream lock) to
487 * ensure we can proceed to flushing metadata in live mode.
489 bool waiting_on_metadata;
490 /* Raised when a timer misses a metadata flush. */
491 bool missed_metadata_flush;
493 enum lttng_event_output output;
494 /* Maximum subbuffer size (in bytes). */
495 unsigned long max_sb_size;
498 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
499 * used for the mmap base and offset.
502 unsigned long mmap_len;
507 /* Network sequence number. Indicating on which relayd socket it goes. */
508 uint64_t net_seq_idx;
510 * Indicate if this stream was successfully sent to a relayd. This is set
511 * after the refcount of the relayd is incremented and is checked when the
512 * stream is closed before decrementing the refcount in order to avoid an
515 unsigned int sent_to_relayd;
517 /* Identify if the stream is the metadata */
518 unsigned int metadata_flag;
520 * Last known metadata version, reset the metadata file in case
523 uint64_t metadata_version;
524 /* Used when the stream is set for network streaming */
525 uint64_t relayd_stream_id;
527 * When sending a stream packet to a relayd, this number is used to track
528 * the packet sent by the consumer and seen by the relayd. When sending the
529 * data header to the relayd, this number is sent and if the transmission
530 * was successful, it is incremented.
532 * Even if the full data is not fully transmitted it won't matter since
533 * only two possible error can happen after that where either the relayd
534 * died or a read error is detected on the stream making this value useless
537 * This value SHOULD be read/updated atomically or with the lock acquired.
539 uint64_t next_net_seq_num;
541 * Lock to use the stream FDs since they are used between threads.
543 * This is nested INSIDE the consumer_data lock.
544 * This is nested INSIDE the channel lock.
545 * This is nested INSIDE the channel timer lock.
546 * This is nested OUTSIDE the metadata cache lock.
547 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
549 pthread_mutex_t lock;
550 /* Tracing session id */
553 * Indicates if the stream end point is still active or not (network
554 * streaming or local file system). The thread "owning" the stream is
555 * handling this status and can be notified of a state change through the
556 * consumer data appropriate pipe.
558 enum consumer_endpoint_status endpoint_status;
559 /* Stream name. Format is: <channel_name>_<cpu_number> */
560 char name[LTTNG_SYMBOL_NAME_LEN];
561 /* Internal state of libustctl. */
562 struct lttng_ust_ctl_consumer_stream *ustream;
563 /* On-disk circular buffer */
564 uint64_t tracefile_size_current;
565 uint64_t tracefile_count_current;
567 * Monitor or not the streams of this channel meaning this indicates if the
568 * streams should be sent to the data/metadata thread or added to the no
569 * monitor list of the channel.
571 unsigned int monitor;
573 * Indicate if the stream is globally visible meaning that it has been
574 * added to the multiple hash tables. If *not* set, NO lock should be
575 * acquired in the destroy path.
577 unsigned int globally_visible;
579 * Pipe to wake up the metadata poll thread when the UST metadata
582 int ust_metadata_poll_pipe[2];
584 * How much metadata was read from the metadata cache and sent
587 uint64_t ust_metadata_pushed;
589 * Copy of the last discarded event value to detect the overflow of
592 uint64_t last_discarded_events;
593 /* Copy of the sequence number of the last packet extracted. */
594 uint64_t last_sequence_number;
596 * Index file object of the index file for this stream.
598 struct lttng_index_file *index_file;
601 * Local pipe to extract data when using splice.
606 * Rendez-vous point between data and metadata stream in live mode.
608 pthread_cond_t metadata_rdv;
609 pthread_mutex_t metadata_rdv_lock;
612 * rotate_position represents the packet sequence number of the last
613 * packet which belongs to the current trace chunk prior to the rotation.
614 * When that position is reached, this tracefile can be closed and a
615 * new one is created in channel_read_only_attributes.path.
617 uint64_t rotate_position;
619 /* Whether or not a packet was opened during the current trace chunk. */
620 bool opened_packet_in_current_trace_chunk;
623 * Read-only copies of channel values. We cannot safely access the
624 * channel from a stream, so we need to have a local copy of these
625 * fields in the stream object. These fields should be removed from
626 * the stream objects when we introduce refcounting.
629 uint64_t tracefile_size;
630 } channel_read_only_attributes;
633 * Flag to inform the data or metadata thread that a stream is
634 * ready to be rotated.
638 /* Indicate if the stream still has some data to be read. */
639 unsigned int has_data:1;
641 * Inform the consumer or relay to reset the metadata
642 * file before writing in it (regeneration).
644 unsigned int reset_metadata_flag:1;
647 * Invoked in the order of declaration.
648 * See callback type definitions.
651 on_wake_up_cb on_wake_up;
652 get_next_subbuffer_cb get_next_subbuffer;
653 extract_subbuffer_info_cb extract_subbuffer_info;
654 pre_consume_subbuffer_cb pre_consume_subbuffer;
655 reset_metadata_cb reset_metadata;
656 consume_subbuffer_cb consume_subbuffer;
657 put_next_subbuffer_cb put_next_subbuffer;
658 struct lttng_dynamic_array post_consume_cbs;
659 send_live_beacon_cb send_live_beacon;
660 on_sleep_cb on_sleep;
662 assert_locked_cb assert_locked;
663 } read_subbuffer_ops;
664 struct metadata_bucket *metadata_bucket;
668 * Internal representation of a relayd socket pair.
670 struct consumer_relayd_sock_pair {
671 /* Network sequence number. */
672 uint64_t net_seq_idx;
673 /* Number of stream associated with this relayd */
677 * This flag indicates whether or not we should destroy this object. The
678 * destruction should ONLY occurs when this flag is set and the refcount is
681 unsigned int destroy_flag;
684 * Mutex protecting the control socket to avoid out of order packets
685 * between threads sending data to the relayd. Since metadata data is sent
686 * over that socket, at least two sendmsg() are needed (header + data)
687 * creating a race for packets to overlap between threads using it.
689 * This is nested INSIDE the consumer_data lock.
690 * This is nested INSIDE the stream lock.
692 pthread_mutex_t ctrl_sock_mutex;
694 /* Control socket. Command and metadata are passed over it */
695 struct lttcomm_relayd_sock control_sock;
698 * We don't need a mutex at this point since we only splice or write single
699 * large chunk of data with a header appended at the begining. Moreover,
700 * this socket is for now only used in a single thread.
702 struct lttcomm_relayd_sock data_sock;
703 struct lttng_ht_node_u64 node;
705 /* Session id on both sides for the sockets. */
706 uint64_t relayd_session_id;
707 uint64_t sessiond_session_id;
708 struct lttng_consumer_local_data *ctx;
712 * UST consumer local data to the program. One or more instance per
715 struct lttng_consumer_local_data {
717 * Function to call when data is available on a buffer.
718 * Returns the number of bytes read, or negative error value.
720 ssize_t (*on_buffer_ready)(struct lttng_consumer_stream *stream,
721 struct lttng_consumer_local_data *ctx,
722 bool locked_by_caller);
724 * function to call when we receive a new channel, it receives a
725 * newly allocated channel, depending on the return code of this
726 * function, the new channel will be handled by the application
730 * > 0 (success, FD is kept by application)
731 * == 0 (success, FD is left to library)
734 int (*on_recv_channel)(struct lttng_consumer_channel *channel);
736 * function to call when we receive a new stream, it receives a
737 * newly allocated stream, depending on the return code of this
738 * function, the new stream will be handled by the application
742 * > 0 (success, FD is kept by application)
743 * == 0 (success, FD is left to library)
746 int (*on_recv_stream)(struct lttng_consumer_stream *stream);
748 * function to call when a stream is getting updated by the session
749 * daemon, this function receives the sessiond key and the new
750 * state, depending on the return code of this function the
751 * update of state for the stream is handled by the application
755 * > 0 (success, FD is kept by application)
756 * == 0 (success, FD is left to library)
759 int (*on_update_stream)(uint64_t sessiond_key, uint32_t state);
760 enum lttng_consumer_type type;
761 /* socket to communicate errors with sessiond */
762 int consumer_error_socket;
763 /* socket to ask metadata to sessiond. */
764 int consumer_metadata_socket;
766 * Protect consumer_metadata_socket.
768 * This is nested OUTSIDE the metadata cache lock.
770 pthread_mutex_t metadata_socket_lock;
771 /* socket to exchange commands with sessiond */
772 char *consumer_command_sock_path;
773 /* communication with splice */
774 int consumer_channel_pipe[2];
775 /* Data stream poll thread pipe. To transfer data stream to the thread */
776 struct lttng_pipe *consumer_data_pipe;
779 * Data thread use that pipe to catch wakeup from read subbuffer that
780 * detects that there is still data to be read for the stream encountered.
781 * Before doing so, the stream is flagged to indicate that there is still
784 * Both pipes (read/write) are owned and used inside the data thread.
786 struct lttng_pipe *consumer_wakeup_pipe;
787 /* Indicate if the wakeup thread has been notified. */
788 unsigned int has_wakeup:1;
790 /* to let the signal handler wake up the fd receiver thread */
791 int consumer_should_quit[2];
792 /* Metadata poll thread pipe. Transfer metadata stream to it */
793 struct lttng_pipe *consumer_metadata_pipe;
795 * Pipe used by the channel monitoring timers to provide state samples
796 * to the session daemon (write-only).
798 int channel_monitor_pipe;
799 LTTNG_OPTIONAL(lttng_uuid) sessiond_uuid;
803 * Library-level data. One instance per process.
805 struct lttng_consumer_global_data {
807 * At this time, this lock is used to ensure coherence between the count
808 * and number of element in the hash table. It's also a protection for
809 * concurrent read/write between threads.
811 * This is nested OUTSIDE the stream lock.
812 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
814 pthread_mutex_t lock {};
817 * Number of streams in the data stream hash table declared outside.
818 * Protected by consumer_data.lock.
820 int stream_count = 0;
822 /* Channel hash table protected by consumer_data.lock. */
823 struct lttng_ht *channel_ht = nullptr;
824 /* Channel hash table indexed by session id. */
825 struct lttng_ht *channels_by_session_id_ht = nullptr;
827 * Flag specifying if the local array of FDs needs update in the
828 * poll function. Protected by consumer_data.lock.
830 unsigned int need_update = 1;
831 enum lttng_consumer_type type = LTTNG_CONSUMER_UNKNOWN;
834 * Relayd socket(s) hashtable indexed by network sequence number. Each
835 * stream has an index which associate the right relayd socket to use.
837 struct lttng_ht *relayd_ht = nullptr;
840 * This hash table contains all streams (metadata and data) indexed by
841 * session id. In other words, the ht is indexed by session id and each
842 * bucket contains the list of associated streams.
844 * This HT uses the "node_session_id" of the consumer stream.
846 struct lttng_ht *stream_list_ht = nullptr;
849 * This HT uses the "node_channel_id" of the consumer stream.
851 struct lttng_ht *stream_per_chan_id_ht = nullptr;
854 * Trace chunk registry indexed by (session_id, chunk_id).
856 struct lttng_trace_chunk_registry *chunk_registry = nullptr;
860 * Set to nonzero when the consumer is exiting. Updated by signal
861 * handler and thread exit, read by threads.
863 extern int consumer_quit;
866 * Set to nonzero when the consumer is exiting. Updated by signal
867 * handler and thread exit, read by threads.
869 extern int consumer_quit;
872 * Flag used to temporarily pause data consumption from testpoints.
874 * This variable is dlsym-ed from a test, so needs to be exported.
876 LTTNG_EXPORT extern int data_consumption_paused;
878 /* Return a human-readable consumer type string that is suitable for logging. */
880 const char *lttng_consumer_type_str(enum lttng_consumer_type type)
883 case LTTNG_CONSUMER_UNKNOWN:
885 case LTTNG_CONSUMER_KERNEL:
887 case LTTNG_CONSUMER32_UST:
888 return "32-bit user space";
889 case LTTNG_CONSUMER64_UST:
890 return "64-bit user space";
897 * Init consumer data structures.
899 int lttng_consumer_init(void);
902 * Set the error socket for communication with a session daemon.
904 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data *ctx,
908 * Set the command socket path for communication with a session daemon.
910 void lttng_consumer_set_command_sock_path(
911 struct lttng_consumer_local_data *ctx, char *sock);
914 * Send return code to session daemon.
916 * Returns the return code of sendmsg : the number of bytes transmitted or -1
919 int lttng_consumer_send_error(struct lttng_consumer_local_data *ctx, int cmd);
922 * Called from signal handler to ensure a clean exit.
924 void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx);
927 * Cleanup the daemon's socket on exit.
929 void lttng_consumer_cleanup(void);
932 * Poll on the should_quit pipe and the command socket return -1 on error and
933 * should exit, 0 if data is available on the command socket
935 int lttng_consumer_poll_socket(struct pollfd *kconsumer_sockpoll);
938 * Copy the fields from the channel that need to be accessed (read-only)
939 * directly from the stream.
941 void consumer_stream_update_channel_attributes(
942 struct lttng_consumer_stream *stream,
943 struct lttng_consumer_channel *channel);
945 struct lttng_consumer_stream *consumer_allocate_stream(
946 struct lttng_consumer_channel *channel,
947 uint64_t channel_key,
949 const char *channel_name,
952 struct lttng_trace_chunk *trace_chunk,
955 enum consumer_channel_type type,
956 unsigned int monitor);
957 struct lttng_consumer_channel *consumer_allocate_channel(uint64_t key,
959 const uint64_t *chunk_id,
960 const char *pathname,
963 enum lttng_event_output output,
964 uint64_t tracefile_size,
965 uint64_t tracefile_count,
966 uint64_t session_id_per_pid,
967 unsigned int monitor,
968 unsigned int live_timer_interval,
969 bool is_in_live_session,
970 const char *root_shm_path,
971 const char *shm_path);
972 void consumer_del_stream(struct lttng_consumer_stream *stream,
973 struct lttng_ht *ht);
974 void consumer_del_metadata_stream(struct lttng_consumer_stream *stream,
975 struct lttng_ht *ht);
976 int consumer_add_channel(struct lttng_consumer_channel *channel,
977 struct lttng_consumer_local_data *ctx);
978 void consumer_del_channel(struct lttng_consumer_channel *channel);
980 /* lttng-relayd consumer command */
981 struct consumer_relayd_sock_pair *consumer_find_relayd(uint64_t key);
982 int consumer_send_relayd_stream(struct lttng_consumer_stream *stream, char *path);
983 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx);
984 void close_relayd_stream(struct lttng_consumer_stream *stream);
985 struct lttng_consumer_channel *consumer_find_channel(uint64_t key);
986 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream *stream,
988 void consumer_steal_stream_key(int key, struct lttng_ht *ht);
990 struct lttng_consumer_local_data *lttng_consumer_create(
991 enum lttng_consumer_type type,
992 ssize_t (*buffer_ready)(struct lttng_consumer_stream *stream,
993 struct lttng_consumer_local_data *ctx,
994 bool locked_by_caller),
995 int (*recv_channel)(struct lttng_consumer_channel *channel),
996 int (*recv_stream)(struct lttng_consumer_stream *stream),
997 int (*update_stream)(uint64_t sessiond_key, uint32_t state));
998 void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx);
999 ssize_t lttng_consumer_on_read_subbuffer_mmap(
1000 struct lttng_consumer_stream *stream,
1001 const struct lttng_buffer_view *buffer,
1002 unsigned long padding);
1003 ssize_t lttng_consumer_on_read_subbuffer_splice(
1004 struct lttng_consumer_local_data *ctx,
1005 struct lttng_consumer_stream *stream, unsigned long len,
1006 unsigned long padding);
1007 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream *stream);
1008 int lttng_consumer_take_snapshot(struct lttng_consumer_stream *stream);
1009 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream *stream,
1010 unsigned long *pos);
1011 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream *stream,
1012 unsigned long *pos);
1013 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream);
1014 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream);
1015 void *consumer_thread_metadata_poll(void *data);
1016 void *consumer_thread_data_poll(void *data);
1017 void *consumer_thread_sessiond_poll(void *data);
1018 void *consumer_thread_channel_poll(void *data);
1019 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1020 int sock, struct pollfd *consumer_sockpoll);
1022 ssize_t lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1023 struct lttng_consumer_local_data *ctx,
1024 bool locked_by_caller);
1025 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream);
1026 void consumer_add_relayd_socket(uint64_t net_seq_idx,
1028 struct lttng_consumer_local_data *ctx,
1030 struct pollfd *consumer_sockpoll,
1031 uint64_t sessiond_id,
1032 uint64_t relayd_session_id,
1033 uint32_t relayd_version_major,
1034 uint32_t relayd_version_minor,
1035 enum lttcomm_sock_proto relayd_socket_protocol);
1036 void consumer_flag_relayd_for_destroy(
1037 struct consumer_relayd_sock_pair *relayd);
1038 int consumer_data_pending(uint64_t id);
1039 int consumer_send_status_msg(int sock, int ret_code);
1040 int consumer_send_status_channel(int sock,
1041 struct lttng_consumer_channel *channel);
1042 void notify_thread_del_channel(struct lttng_consumer_local_data *ctx,
1044 void consumer_destroy_relayd(struct consumer_relayd_sock_pair *relayd);
1045 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos,
1046 unsigned long produced_pos, uint64_t nb_packets_per_stream,
1047 uint64_t max_sb_size);
1048 void consumer_add_data_stream(struct lttng_consumer_stream *stream);
1049 void consumer_del_stream_for_data(struct lttng_consumer_stream *stream);
1050 void consumer_add_metadata_stream(struct lttng_consumer_stream *stream);
1051 void consumer_del_stream_for_metadata(struct lttng_consumer_stream *stream);
1052 int consumer_create_index_file(struct lttng_consumer_stream *stream);
1053 int lttng_consumer_rotate_channel(struct lttng_consumer_channel *channel,
1054 uint64_t key, uint64_t relayd_id);
1055 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream *stream);
1056 int lttng_consumer_rotate_stream(struct lttng_consumer_stream *stream);
1057 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel *channel,
1059 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream *stream);
1060 enum lttcomm_return_code lttng_consumer_create_trace_chunk(
1061 const uint64_t *relayd_id, uint64_t session_id,
1063 time_t chunk_creation_timestamp,
1064 const char *chunk_override_name,
1065 const struct lttng_credentials *credentials,
1066 struct lttng_directory_handle *chunk_directory_handle);
1067 enum lttcomm_return_code lttng_consumer_close_trace_chunk(
1068 const uint64_t *relayd_id, uint64_t session_id,
1069 uint64_t chunk_id, time_t chunk_close_timestamp,
1070 const enum lttng_trace_chunk_command_type *close_command,
1072 enum lttcomm_return_code lttng_consumer_trace_chunk_exists(
1073 const uint64_t *relayd_id, uint64_t session_id,
1075 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair *relayd);
1076 enum lttcomm_return_code lttng_consumer_init_command(
1077 struct lttng_consumer_local_data *ctx,
1078 const lttng_uuid sessiond_uuid);
1079 int lttng_consumer_clear_channel(struct lttng_consumer_channel *channel);
1080 enum lttcomm_return_code lttng_consumer_open_channel_packets(
1081 struct lttng_consumer_channel *channel);
1082 int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel *channel);
1083 void lttng_consumer_sigbus_handle(void *addr);
1085 #endif /* LIB_CONSUMER_H */