2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
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
17 #include <urcu/list.h>
19 #include <lttng/lttng.h>
21 #include <common/hashtable/hashtable.h>
22 #include <common/compat/fcntl.h>
23 #include <common/uuid.h>
24 #include <common/sessiond-comm/sessiond-comm.h>
25 #include <common/pipe.h>
26 #include <common/index/ctf-index.h>
27 #include <common/trace-chunk-registry.h>
28 #include <common/credentials.h>
29 #include <common/buffer-view.h>
31 struct lttng_consumer_local_data
;
33 /* Commands for consumer */
34 enum lttng_consumer_command
{
35 LTTNG_CONSUMER_ADD_CHANNEL
,
36 LTTNG_CONSUMER_ADD_STREAM
,
37 /* pause, delete, active depending on fd state */
38 LTTNG_CONSUMER_UPDATE_STREAM
,
39 /* inform the consumer to quit when all fd has hang up */
40 LTTNG_CONSUMER_STOP
, /* deprecated */
41 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
42 /* Inform the consumer to kill a specific relayd connection */
43 LTTNG_CONSUMER_DESTROY_RELAYD
,
44 /* Return to the sessiond if there is data pending for a session */
45 LTTNG_CONSUMER_DATA_PENDING
,
46 /* Consumer creates a channel and returns it to sessiond. */
47 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
48 LTTNG_CONSUMER_GET_CHANNEL
,
49 LTTNG_CONSUMER_DESTROY_CHANNEL
,
50 LTTNG_CONSUMER_PUSH_METADATA
,
51 LTTNG_CONSUMER_CLOSE_METADATA
,
52 LTTNG_CONSUMER_SETUP_METADATA
,
53 LTTNG_CONSUMER_FLUSH_CHANNEL
,
54 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
55 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
56 LTTNG_CONSUMER_STREAMS_SENT
,
57 LTTNG_CONSUMER_DISCARDED_EVENTS
,
58 LTTNG_CONSUMER_LOST_PACKETS
,
59 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
,
60 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
,
61 LTTNG_CONSUMER_ROTATE_CHANNEL
,
63 LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
64 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
65 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
66 LTTNG_CONSUMER_CLEAR_CHANNEL
,
69 enum lttng_consumer_type
{
70 LTTNG_CONSUMER_UNKNOWN
= 0,
71 LTTNG_CONSUMER_KERNEL
,
76 enum consumer_endpoint_status
{
77 CONSUMER_ENDPOINT_ACTIVE
,
78 CONSUMER_ENDPOINT_INACTIVE
,
81 enum consumer_channel_output
{
82 CONSUMER_CHANNEL_MMAP
= 0,
83 CONSUMER_CHANNEL_SPLICE
= 1,
86 enum consumer_channel_type
{
87 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
88 CONSUMER_CHANNEL_TYPE_DATA
= 1,
91 extern struct lttng_consumer_global_data consumer_data
;
94 struct cds_list_head head
;
99 struct consumer_metadata_cache
;
101 struct lttng_consumer_channel
{
102 /* Is the channel published in the channel hash tables? */
105 * Was the channel deleted (logically) and waiting to be reclaimed?
106 * If this flag is set, no modification that is not cleaned-up by the
107 * RCU reclamation callback should be made
110 /* HT node used for consumer_data.channel_ht */
111 struct lttng_ht_node_u64 node
;
112 /* HT node used for consumer_data.channels_by_session_id_ht */
113 struct lttng_ht_node_u64 channels_by_session_id_ht_node
;
114 /* Indexed key. Incremented value in the consumer. */
116 /* Number of streams referencing this channel */
118 /* Tracing session id on the session daemon side. */
120 /* Current trace chunk of the session in which this channel exists. */
121 struct lttng_trace_chunk
*trace_chunk
;
123 * Session id when requesting metadata to the session daemon for
124 * a session with per-PID buffers.
126 uint64_t session_id_per_pid
;
128 * In the case of local streams, this field contains the channel's
129 * output path; a path relative to the session's output path.
130 * e.g. ust/uid/1000/64-bit
132 * In the case of remote streams, the contents of this field depends
133 * on the version of the relay daemon peer. For 2.11+ peers, the
134 * contents are the same as in the local case. However, for legacy
135 * peers, this contains a path of the form:
136 * /hostname/session_path/ust/uid/1000/64-bit
138 char pathname
[PATH_MAX
];
140 char name
[LTTNG_SYMBOL_NAME_LEN
];
141 /* Relayd id of the channel. -1ULL if it does not apply. */
144 * Number of streams NOT initialized yet. This is used in order to not
145 * delete this channel if streams are getting initialized.
147 unsigned int nb_init_stream_left
;
148 /* Output type (mmap or splice). */
149 enum consumer_channel_output output
;
150 /* Channel type for stream */
151 enum consumer_channel_type type
;
154 uid_t ust_app_uid
; /* Application UID. */
155 struct ustctl_consumer_channel
*uchan
;
156 unsigned char uuid
[LTTNG_UUID_STR_LEN
];
158 * Temporary stream list used to store the streams once created and waiting
159 * to be sent to the session daemon by receiving the
160 * LTTNG_CONSUMER_GET_CHANNEL.
162 struct stream_list streams
;
165 * Set if the channel is metadata. We keep a reference to the stream
166 * because we have to flush data once pushed by the session daemon. For a
167 * regular channel, this is always set to NULL.
169 struct lttng_consumer_stream
*metadata_stream
;
173 /* Node within channel thread ht */
174 struct lttng_ht_node_u64 wait_fd_node
;
176 /* Metadata cache is metadata channel */
177 struct consumer_metadata_cache
*metadata_cache
;
179 /* For UST metadata periodical flush */
180 int switch_timer_enabled
;
181 timer_t switch_timer
;
182 int switch_timer_error
;
184 /* For the live mode */
185 int live_timer_enabled
;
187 int live_timer_error
;
188 /* Channel is part of a live session ? */
191 /* For channel monitoring timer. */
192 int monitor_timer_enabled
;
193 timer_t monitor_timer
;
195 /* On-disk circular buffer */
196 uint64_t tracefile_size
;
197 uint64_t tracefile_count
;
199 * Monitor or not the streams of this channel meaning this indicates if the
200 * streams should be sent to the data/metadata thread or added to the no
201 * monitor list of the channel.
203 unsigned int monitor
;
208 * This lock protects against concurrent update of channel.
210 * This is nested INSIDE the consumer data lock.
211 * This is nested OUTSIDE the channel timer lock.
212 * This is nested OUTSIDE the metadata cache lock.
213 * This is nested OUTSIDE stream lock.
214 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
216 pthread_mutex_t lock
;
219 * Channel teardown lock.
221 * This lock protect against teardown of channel. It is _never_
222 * taken by the timer handler.
224 * This is nested INSIDE the consumer data lock.
225 * This is nested INSIDE the channel lock.
226 * This is nested OUTSIDE the metadata cache lock.
227 * This is nested OUTSIDE stream lock.
228 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
230 pthread_mutex_t timer_lock
;
232 /* Timer value in usec for live streaming. */
233 unsigned int live_timer_interval
;
237 char root_shm_path
[PATH_MAX
];
238 char shm_path
[PATH_MAX
];
239 /* Only set for UST channels. */
240 LTTNG_OPTIONAL(struct lttng_credentials
) buffer_credentials
;
241 /* Total number of discarded events for that channel. */
242 uint64_t discarded_events
;
243 /* Total number of missed packets due to overwriting (overwrite). */
244 uint64_t lost_packets
;
246 bool streams_sent_to_relayd
;
249 struct stream_subbuffer
{
252 * CONSUMER_CHANNEL_SPLICE
253 * No ownership assumed.
256 /* CONSUMER_CHANNEL_MMAP */
257 struct lttng_buffer_view buffer
;
261 * Common members are fine to access through either
262 * union entries (as per C11, Common Initial Sequence).
265 unsigned long subbuf_size
;
266 unsigned long padded_subbuf_size
;
270 unsigned long subbuf_size
;
271 unsigned long padded_subbuf_size
;
272 uint64_t packet_size
;
273 uint64_t content_size
;
274 uint64_t timestamp_begin
;
275 uint64_t timestamp_end
;
276 uint64_t events_discarded
;
277 /* Left unset when unsupported. */
278 LTTNG_OPTIONAL(uint64_t) sequence_number
;
280 /* Left unset when unsupported. */
281 LTTNG_OPTIONAL(uint64_t) stream_instance_id
;
287 * Perform any operation required to acknowledge
288 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
290 * Stream and channel locks are acquired during this call.
292 typedef int (*on_wake_up_cb
)(struct lttng_consumer_stream
*);
295 * Perform any operation required before a consumer stream is put
296 * to sleep before awaiting a data availability notification.
298 * Stream and channel locks are acquired during this call.
300 typedef int (*on_sleep_cb
)(struct lttng_consumer_stream
*,
301 struct lttng_consumer_local_data
*);
304 * Acquire the subbuffer at the current 'consumed' position.
306 * Stream and channel locks are acquired during this call.
308 typedef int (*get_next_subbuffer_cb
)(struct lttng_consumer_stream
*,
309 struct stream_subbuffer
*);
312 * Populate the stream_subbuffer's info member. The info to populate
313 * depends on the type (metadata/data) of the stream.
315 * Stream and channel locks are acquired during this call.
317 typedef int (*extract_subbuffer_info_cb
)(
318 struct lttng_consumer_stream
*, struct stream_subbuffer
*);
321 * Invoked after a subbuffer's info has been filled.
323 * Stream and channel locks are acquired during this call.
325 typedef int (*pre_consume_subbuffer_cb
)(struct lttng_consumer_stream
*,
326 const struct stream_subbuffer
*);
329 * Consume subbuffer contents.
331 * Stream and channel locks are acquired during this call.
333 typedef ssize_t (*consume_subbuffer_cb
)(struct lttng_consumer_local_data
*,
334 struct lttng_consumer_stream
*,
335 const struct stream_subbuffer
*);
338 * Release the current subbuffer and advance the 'consumed' position by
341 * Stream and channel locks are acquired during this call.
343 typedef int (*put_next_subbuffer_cb
)(struct lttng_consumer_stream
*,
344 struct stream_subbuffer
*);
347 * Invoked after consuming a subbuffer.
349 * Stream and channel locks are acquired during this call.
351 typedef int (*post_consume_cb
)(struct lttng_consumer_stream
*,
352 const struct stream_subbuffer
*,
353 struct lttng_consumer_local_data
*);
356 * Send a live beacon if no data is available.
358 * Stream and channel locks are acquired during this call.
360 typedef int (*send_live_beacon_cb
)(struct lttng_consumer_stream
*);
363 * Lock the stream and channel locks and any other stream-type specific
364 * lock that need to be acquired during the processing of an
365 * availability notification.
367 typedef void (*lock_cb
)(struct lttng_consumer_stream
*);
370 * Unlock the stream and channel locks and any other stream-type specific
371 * lock before sleeping until the next availability notification.
373 * Stream and channel locks are acquired during this call.
375 typedef void (*unlock_cb
)(struct lttng_consumer_stream
*);
378 * Invoked when a subbuffer's metadata version does not match the last
379 * known metadata version.
381 * Stream and channel locks are acquired during this call.
383 typedef void (*reset_metadata_cb
)(struct lttng_consumer_stream
*);
386 * Internal representation of the streams, sessiond_key is used to identify
389 struct lttng_consumer_stream
{
390 /* HT node used by the data_ht and metadata_ht */
391 struct lttng_ht_node_u64 node
;
392 /* stream indexed per channel key node */
393 struct lttng_ht_node_u64 node_channel_id
;
394 /* HT node used in consumer_data.stream_list_ht */
395 struct lttng_ht_node_u64 node_session_id
;
396 /* Pointer to associated channel. */
397 struct lttng_consumer_channel
*chan
;
399 * Current trace chunk. Holds a reference to the trace chunk.
400 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
401 * when it was created in the context of a no-output session.
403 struct lttng_trace_chunk
*trace_chunk
;
405 /* Key by which the stream is indexed for 'node'. */
408 * File descriptor of the data output file. This can be either a file or a
409 * socket fd for relayd streaming.
411 int out_fd
; /* output file to write the data */
412 /* Write position in the output file descriptor */
414 /* Amount of bytes written to the output */
415 uint64_t output_written
;
418 int hangup_flush_done
;
421 * Whether the stream is in a "complete" state (e.g. it does not have a
422 * partially written sub-buffer.
424 * Initialized to "false" on stream creation (first packet is empty).
426 * The various transitions of the quiescent state are:
427 * - On "start" tracing: set to false, since the stream is not
429 * - On "stop" tracing: if !quiescent -> flush FINAL (update
430 * timestamp_end), and set to true; the stream has entered a
431 * complete/quiescent state.
432 * - On "destroy" or stream/application hang-up: if !quiescent ->
433 * flush FINAL, and set to true.
435 * NOTE: Update and read are protected by the stream lock.
440 * True if the sequence number is not available (lttng-modules < 2.8).
442 bool sequence_number_unavailable
;
445 * metadata_timer_lock protects flags waiting_on_metadata and
446 * missed_metadata_flush.
448 pthread_mutex_t metadata_timer_lock
;
450 * Flag set when awaiting metadata to be pushed. Used in the
451 * timer thread to skip waiting on the stream (and stream lock) to
452 * ensure we can proceed to flushing metadata in live mode.
454 bool waiting_on_metadata
;
455 /* Raised when a timer misses a metadata flush. */
456 bool missed_metadata_flush
;
458 enum lttng_event_output output
;
459 /* Maximum subbuffer size (in bytes). */
460 unsigned long max_sb_size
;
463 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
464 * used for the mmap base and offset.
467 unsigned long mmap_len
;
472 /* Network sequence number. Indicating on which relayd socket it goes. */
473 uint64_t net_seq_idx
;
475 * Indicate if this stream was successfully sent to a relayd. This is set
476 * after the refcount of the relayd is incremented and is checked when the
477 * stream is closed before decrementing the refcount in order to avoid an
480 unsigned int sent_to_relayd
;
482 /* Identify if the stream is the metadata */
483 unsigned int metadata_flag
;
485 * Last known metadata version, reset the metadata file in case
488 uint64_t metadata_version
;
489 /* Used when the stream is set for network streaming */
490 uint64_t relayd_stream_id
;
492 * When sending a stream packet to a relayd, this number is used to track
493 * the packet sent by the consumer and seen by the relayd. When sending the
494 * data header to the relayd, this number is sent and if the transmission
495 * was successful, it is incremented.
497 * Even if the full data is not fully transmitted it won't matter since
498 * only two possible error can happen after that where either the relayd
499 * died or a read error is detected on the stream making this value useless
502 * This value SHOULD be read/updated atomically or with the lock acquired.
504 uint64_t next_net_seq_num
;
506 * Lock to use the stream FDs since they are used between threads.
508 * This is nested INSIDE the consumer_data lock.
509 * This is nested INSIDE the channel lock.
510 * This is nested INSIDE the channel timer lock.
511 * This is nested OUTSIDE the metadata cache lock.
512 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
514 pthread_mutex_t lock
;
515 /* Tracing session id */
518 * Indicates if the stream end point is still active or not (network
519 * streaming or local file system). The thread "owning" the stream is
520 * handling this status and can be notified of a state change through the
521 * consumer data appropriate pipe.
523 enum consumer_endpoint_status endpoint_status
;
524 /* Stream name. Format is: <channel_name>_<cpu_number> */
525 char name
[LTTNG_SYMBOL_NAME_LEN
];
526 /* Internal state of libustctl. */
527 struct ustctl_consumer_stream
*ustream
;
528 struct cds_list_head send_node
;
529 /* On-disk circular buffer */
530 uint64_t tracefile_size_current
;
531 uint64_t tracefile_count_current
;
533 * Monitor or not the streams of this channel meaning this indicates if the
534 * streams should be sent to the data/metadata thread or added to the no
535 * monitor list of the channel.
537 unsigned int monitor
;
539 * Indicate if the stream is globally visible meaning that it has been
540 * added to the multiple hash tables. If *not* set, NO lock should be
541 * acquired in the destroy path.
543 unsigned int globally_visible
;
545 * Pipe to wake up the metadata poll thread when the UST metadata
548 int ust_metadata_poll_pipe
[2];
550 * How much metadata was read from the metadata cache and sent
553 uint64_t ust_metadata_pushed
;
555 * Copy of the last discarded event value to detect the overflow of
558 uint64_t last_discarded_events
;
559 /* Copy of the sequence number of the last packet extracted. */
560 uint64_t last_sequence_number
;
562 * Index file object of the index file for this stream.
564 struct lttng_index_file
*index_file
;
567 * Local pipe to extract data when using splice.
572 * Rendez-vous point between data and metadata stream in live mode.
574 pthread_cond_t metadata_rdv
;
575 pthread_mutex_t metadata_rdv_lock
;
578 * rotate_position represents the packet sequence number of the last
579 * packet which belongs to the current trace chunk prior to the rotation.
580 * When that position is reached, this tracefile can be closed and a
581 * new one is created in channel_read_only_attributes.path.
583 uint64_t rotate_position
;
586 * Read-only copies of channel values. We cannot safely access the
587 * channel from a stream, so we need to have a local copy of these
588 * fields in the stream object. These fields should be removed from
589 * the stream objects when we introduce refcounting.
592 uint64_t tracefile_size
;
593 } channel_read_only_attributes
;
596 * Flag to inform the data or metadata thread that a stream is
597 * ready to be rotated.
601 /* Indicate if the stream still has some data to be read. */
602 unsigned int has_data
:1;
604 * Inform the consumer or relay to reset the metadata
605 * file before writing in it (regeneration).
607 unsigned int reset_metadata_flag
:1;
610 * Invoked in the order of declaration.
611 * See callback type definitions.
614 on_wake_up_cb on_wake_up
;
615 get_next_subbuffer_cb get_next_subbuffer
;
616 extract_subbuffer_info_cb extract_subbuffer_info
;
617 pre_consume_subbuffer_cb pre_consume_subbuffer
;
618 reset_metadata_cb reset_metadata
;
619 consume_subbuffer_cb consume_subbuffer
;
620 put_next_subbuffer_cb put_next_subbuffer
;
621 post_consume_cb post_consume
;
622 send_live_beacon_cb send_live_beacon
;
623 on_sleep_cb on_sleep
;
625 } read_subbuffer_ops
;
629 * Internal representation of a relayd socket pair.
631 struct consumer_relayd_sock_pair
{
632 /* Network sequence number. */
633 uint64_t net_seq_idx
;
634 /* Number of stream associated with this relayd */
638 * This flag indicates whether or not we should destroy this object. The
639 * destruction should ONLY occurs when this flag is set and the refcount is
642 unsigned int destroy_flag
;
645 * Mutex protecting the control socket to avoid out of order packets
646 * between threads sending data to the relayd. Since metadata data is sent
647 * over that socket, at least two sendmsg() are needed (header + data)
648 * creating a race for packets to overlap between threads using it.
650 * This is nested INSIDE the consumer_data lock.
651 * This is nested INSIDE the stream lock.
653 pthread_mutex_t ctrl_sock_mutex
;
655 /* Control socket. Command and metadata are passed over it */
656 struct lttcomm_relayd_sock control_sock
;
659 * We don't need a mutex at this point since we only splice or write single
660 * large chunk of data with a header appended at the begining. Moreover,
661 * this socket is for now only used in a single thread.
663 struct lttcomm_relayd_sock data_sock
;
664 struct lttng_ht_node_u64 node
;
666 /* Session id on both sides for the sockets. */
667 uint64_t relayd_session_id
;
668 uint64_t sessiond_session_id
;
669 struct lttng_consumer_local_data
*ctx
;
673 * UST consumer local data to the program. One or more instance per
676 struct lttng_consumer_local_data
{
678 * Function to call when data is available on a buffer.
679 * Returns the number of bytes read, or negative error value.
681 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
682 struct lttng_consumer_local_data
*ctx
,
683 bool locked_by_caller
);
685 * function to call when we receive a new channel, it receives a
686 * newly allocated channel, depending on the return code of this
687 * function, the new channel will be handled by the application
691 * > 0 (success, FD is kept by application)
692 * == 0 (success, FD is left to library)
695 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
697 * function to call when we receive a new stream, it receives a
698 * newly allocated stream, depending on the return code of this
699 * function, the new stream will be handled by the application
703 * > 0 (success, FD is kept by application)
704 * == 0 (success, FD is left to library)
707 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
709 * function to call when a stream is getting updated by the session
710 * daemon, this function receives the sessiond key and the new
711 * state, depending on the return code of this function the
712 * update of state for the stream is handled by the application
716 * > 0 (success, FD is kept by application)
717 * == 0 (success, FD is left to library)
720 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
721 enum lttng_consumer_type type
;
722 /* socket to communicate errors with sessiond */
723 int consumer_error_socket
;
724 /* socket to ask metadata to sessiond. */
725 int consumer_metadata_socket
;
727 * Protect consumer_metadata_socket.
729 * This is nested OUTSIDE the metadata cache lock.
731 pthread_mutex_t metadata_socket_lock
;
732 /* socket to exchange commands with sessiond */
733 char *consumer_command_sock_path
;
734 /* communication with splice */
735 int consumer_channel_pipe
[2];
736 /* Data stream poll thread pipe. To transfer data stream to the thread */
737 struct lttng_pipe
*consumer_data_pipe
;
740 * Data thread use that pipe to catch wakeup from read subbuffer that
741 * detects that there is still data to be read for the stream encountered.
742 * Before doing so, the stream is flagged to indicate that there is still
745 * Both pipes (read/write) are owned and used inside the data thread.
747 struct lttng_pipe
*consumer_wakeup_pipe
;
748 /* Indicate if the wakeup thread has been notified. */
749 unsigned int has_wakeup
:1;
751 /* to let the signal handler wake up the fd receiver thread */
752 int consumer_should_quit
[2];
753 /* Metadata poll thread pipe. Transfer metadata stream to it */
754 struct lttng_pipe
*consumer_metadata_pipe
;
756 * Pipe used by the channel monitoring timers to provide state samples
757 * to the session daemon (write-only).
759 int channel_monitor_pipe
;
760 LTTNG_OPTIONAL(lttng_uuid
) sessiond_uuid
;
764 * Library-level data. One instance per process.
766 struct lttng_consumer_global_data
{
768 * At this time, this lock is used to ensure coherence between the count
769 * and number of element in the hash table. It's also a protection for
770 * concurrent read/write between threads.
772 * This is nested OUTSIDE the stream lock.
773 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
775 pthread_mutex_t lock
;
778 * Number of streams in the data stream hash table declared outside.
779 * Protected by consumer_data.lock.
783 /* Channel hash table protected by consumer_data.lock. */
784 struct lttng_ht
*channel_ht
;
785 /* Channel hash table indexed by session id. */
786 struct lttng_ht
*channels_by_session_id_ht
;
788 * Flag specifying if the local array of FDs needs update in the
789 * poll function. Protected by consumer_data.lock.
791 unsigned int need_update
;
792 enum lttng_consumer_type type
;
795 * Relayd socket(s) hashtable indexed by network sequence number. Each
796 * stream has an index which associate the right relayd socket to use.
798 struct lttng_ht
*relayd_ht
;
801 * This hash table contains all streams (metadata and data) indexed by
802 * session id. In other words, the ht is indexed by session id and each
803 * bucket contains the list of associated streams.
805 * This HT uses the "node_session_id" of the consumer stream.
807 struct lttng_ht
*stream_list_ht
;
810 * This HT uses the "node_channel_id" of the consumer stream.
812 struct lttng_ht
*stream_per_chan_id_ht
;
815 * Trace chunk registry indexed by (session_id, chunk_id).
817 struct lttng_trace_chunk_registry
*chunk_registry
;
821 * Set to nonzero when the consumer is exiting. Updated by signal
822 * handler and thread exit, read by threads.
824 extern int consumer_quit
;
827 * Set to nonzero when the consumer is exiting. Updated by signal
828 * handler and thread exit, read by threads.
830 extern int consumer_quit
;
832 /* Flag used to temporarily pause data consumption from testpoints. */
833 extern int data_consumption_paused
;
835 /* Return a human-readable consumer type string that is suitable for logging. */
837 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
840 case LTTNG_CONSUMER_UNKNOWN
:
842 case LTTNG_CONSUMER_KERNEL
:
844 case LTTNG_CONSUMER32_UST
:
845 return "32-bit user space";
846 case LTTNG_CONSUMER64_UST
:
847 return "64-bit user space";
854 * Init consumer data structures.
856 int lttng_consumer_init(void);
859 * Set the error socket for communication with a session daemon.
861 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
865 * Set the command socket path for communication with a session daemon.
867 void lttng_consumer_set_command_sock_path(
868 struct lttng_consumer_local_data
*ctx
, char *sock
);
871 * Send return code to session daemon.
873 * Returns the return code of sendmsg : the number of bytes transmitted or -1
876 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
879 * Called from signal handler to ensure a clean exit.
881 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
884 * Cleanup the daemon's socket on exit.
886 void lttng_consumer_cleanup(void);
889 * Poll on the should_quit pipe and the command socket return -1 on error and
890 * should exit, 0 if data is available on the command socket
892 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
895 * Copy the fields from the channel that need to be accessed (read-only)
896 * directly from the stream.
898 void consumer_stream_update_channel_attributes(
899 struct lttng_consumer_stream
*stream
,
900 struct lttng_consumer_channel
*channel
);
902 struct lttng_consumer_stream
*consumer_allocate_stream(
903 struct lttng_consumer_channel
*channel
,
904 uint64_t channel_key
,
906 const char *channel_name
,
909 struct lttng_trace_chunk
*trace_chunk
,
912 enum consumer_channel_type type
,
913 unsigned int monitor
);
914 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
916 const uint64_t *chunk_id
,
917 const char *pathname
,
920 enum lttng_event_output output
,
921 uint64_t tracefile_size
,
922 uint64_t tracefile_count
,
923 uint64_t session_id_per_pid
,
924 unsigned int monitor
,
925 unsigned int live_timer_interval
,
926 bool is_in_live_session
,
927 const char *root_shm_path
,
928 const char *shm_path
);
929 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
930 struct lttng_ht
*ht
);
931 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
932 struct lttng_ht
*ht
);
933 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
934 struct lttng_consumer_local_data
*ctx
);
935 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
937 /* lttng-relayd consumer command */
938 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
939 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
940 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
941 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
942 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
943 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
945 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
947 struct lttng_consumer_local_data
*lttng_consumer_create(
948 enum lttng_consumer_type type
,
949 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
950 struct lttng_consumer_local_data
*ctx
,
951 bool locked_by_caller
),
952 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
953 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
954 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
955 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
956 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
957 struct lttng_consumer_local_data
*ctx
,
958 struct lttng_consumer_stream
*stream
,
959 const struct lttng_buffer_view
*buffer
,
960 unsigned long padding
);
961 ssize_t
lttng_consumer_on_read_subbuffer_splice(
962 struct lttng_consumer_local_data
*ctx
,
963 struct lttng_consumer_stream
*stream
, unsigned long len
,
964 unsigned long padding
);
965 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
966 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
967 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
969 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
971 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
972 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
973 void *consumer_thread_metadata_poll(void *data
);
974 void *consumer_thread_data_poll(void *data
);
975 void *consumer_thread_sessiond_poll(void *data
);
976 void *consumer_thread_channel_poll(void *data
);
977 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
978 int sock
, struct pollfd
*consumer_sockpoll
);
980 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
981 struct lttng_consumer_local_data
*ctx
,
982 bool locked_by_caller
);
983 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
984 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
985 struct lttng_consumer_local_data
*ctx
, int sock
,
986 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
987 uint64_t sessiond_id
, uint64_t relayd_session_id
);
988 void consumer_flag_relayd_for_destroy(
989 struct consumer_relayd_sock_pair
*relayd
);
990 int consumer_data_pending(uint64_t id
);
991 int consumer_send_status_msg(int sock
, int ret_code
);
992 int consumer_send_status_channel(int sock
,
993 struct lttng_consumer_channel
*channel
);
994 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
996 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
997 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
998 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
999 uint64_t max_sb_size
);
1000 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
1001 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
1002 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
1003 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
1004 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
1005 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
1006 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
1007 struct lttng_consumer_local_data
*ctx
);
1008 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
1009 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
1010 struct lttng_consumer_stream
*stream
);
1011 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
1012 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
1013 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
1014 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
1015 const uint64_t *relayd_id
, uint64_t session_id
,
1017 time_t chunk_creation_timestamp
,
1018 const char *chunk_override_name
,
1019 const struct lttng_credentials
*credentials
,
1020 struct lttng_directory_handle
*chunk_directory_handle
);
1021 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
1022 const uint64_t *relayd_id
, uint64_t session_id
,
1023 uint64_t chunk_id
, time_t chunk_close_timestamp
,
1024 const enum lttng_trace_chunk_command_type
*close_command
,
1026 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
1027 const uint64_t *relayd_id
, uint64_t session_id
,
1029 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
1030 enum lttcomm_return_code
lttng_consumer_init_command(
1031 struct lttng_consumer_local_data
*ctx
,
1032 const lttng_uuid sessiond_uuid
);
1033 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
);
1035 #endif /* LIB_CONSUMER_H */