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.h>
23 #include <common/compat/fcntl.h>
24 #include <common/uuid.h>
25 #include <common/sessiond-comm/sessiond-comm.h>
26 #include <common/pipe.h>
27 #include <common/index/ctf-index.h>
28 #include <common/trace-chunk-registry.h>
29 #include <common/credentials.h>
30 #include <common/buffer-view.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 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 ustctl_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
;
257 struct stream_subbuffer
{
260 * CONSUMER_CHANNEL_SPLICE
261 * No ownership assumed.
264 /* CONSUMER_CHANNEL_MMAP */
265 struct lttng_buffer_view buffer
;
269 * Common members are fine to access through either
270 * union entries (as per C11, Common Initial Sequence).
273 unsigned long subbuf_size
;
274 unsigned long padded_subbuf_size
;
277 * Left unset when unsupported.
279 * Indicates that this is the last sub-buffer of
280 * a series of sub-buffer that makes-up a coherent
281 * (parseable) unit of metadata.
283 LTTNG_OPTIONAL(bool) coherent
;
286 unsigned long subbuf_size
;
287 unsigned long padded_subbuf_size
;
288 uint64_t packet_size
;
289 uint64_t content_size
;
290 uint64_t timestamp_begin
;
291 uint64_t timestamp_end
;
292 uint64_t events_discarded
;
293 /* Left unset when unsupported. */
294 LTTNG_OPTIONAL(uint64_t) sequence_number
;
296 /* Left unset when unsupported. */
297 LTTNG_OPTIONAL(uint64_t) stream_instance_id
;
303 * Perform any operation required to acknowledge
304 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
306 * Stream and channel locks are acquired during this call.
308 typedef int (*on_wake_up_cb
)(struct lttng_consumer_stream
*);
311 * Perform any operation required before a consumer stream is put
312 * to sleep before awaiting a data availability notification.
314 * Stream and channel locks are acquired during this call.
316 typedef int (*on_sleep_cb
)(struct lttng_consumer_stream
*,
317 struct lttng_consumer_local_data
*);
320 * Acquire the subbuffer at the current 'consumed' position.
322 * Stream and channel locks are acquired during this call.
324 typedef int (*get_next_subbuffer_cb
)(struct lttng_consumer_stream
*,
325 struct stream_subbuffer
*);
328 * Populate the stream_subbuffer's info member. The info to populate
329 * depends on the type (metadata/data) of the stream.
331 * Stream and channel locks are acquired during this call.
333 typedef int (*extract_subbuffer_info_cb
)(
334 struct lttng_consumer_stream
*, struct stream_subbuffer
*);
337 * Invoked after a subbuffer's info has been filled.
339 * Stream and channel locks are acquired during this call.
341 typedef int (*pre_consume_subbuffer_cb
)(struct lttng_consumer_stream
*,
342 const struct stream_subbuffer
*);
345 * Consume subbuffer contents.
347 * Stream and channel locks are acquired during this call.
349 typedef ssize_t (*consume_subbuffer_cb
)(struct lttng_consumer_local_data
*,
350 struct lttng_consumer_stream
*,
351 const struct stream_subbuffer
*);
354 * Release the current subbuffer and advance the 'consumed' position by
357 * Stream and channel locks are acquired during this call.
359 typedef int (*put_next_subbuffer_cb
)(struct lttng_consumer_stream
*,
360 struct stream_subbuffer
*);
363 * Invoked after consuming a subbuffer.
365 * Stream and channel locks are acquired during this call.
367 typedef int (*post_consume_cb
)(struct lttng_consumer_stream
*,
368 const struct stream_subbuffer
*,
369 struct lttng_consumer_local_data
*);
372 * Send a live beacon if no data is available.
374 * Stream and channel locks are acquired during this call.
376 typedef int (*send_live_beacon_cb
)(struct lttng_consumer_stream
*);
379 * Lock the stream and channel locks and any other stream-type specific
380 * lock that need to be acquired during the processing of an
381 * availability notification.
383 typedef void (*lock_cb
)(struct lttng_consumer_stream
*);
386 * Unlock the stream and channel locks and any other stream-type specific
387 * lock before sleeping until the next availability notification.
389 * Stream and channel locks are acquired during this call.
391 typedef void (*unlock_cb
)(struct lttng_consumer_stream
*);
394 * Assert that the stream and channel lock and any other stream type specific
395 * lock that need to be acquired during the processing of a read_subbuffer
396 * operation is acquired.
398 typedef void (*assert_locked_cb
)(struct lttng_consumer_stream
*);
401 * Invoked when a subbuffer's metadata version does not match the last
402 * known metadata version.
404 * Stream and channel locks are acquired during this call.
406 typedef void (*reset_metadata_cb
)(struct lttng_consumer_stream
*);
409 * Internal representation of the streams, sessiond_key is used to identify
412 struct lttng_consumer_stream
{
413 /* HT node used by the data_ht and metadata_ht */
414 struct lttng_ht_node_u64 node
;
415 /* stream indexed per channel key node */
416 struct lttng_ht_node_u64 node_channel_id
;
417 /* HT node used in consumer_data.stream_list_ht */
418 struct lttng_ht_node_u64 node_session_id
;
419 /* Pointer to associated channel. */
420 struct lttng_consumer_channel
*chan
;
422 * Current trace chunk. Holds a reference to the trace chunk.
423 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
424 * when it was created in the context of a no-output session.
426 struct lttng_trace_chunk
*trace_chunk
;
428 /* Key by which the stream is indexed for 'node'. */
431 * File descriptor of the data output file. This can be either a file or a
432 * socket fd for relayd streaming.
434 int out_fd
; /* output file to write the data */
435 /* Write position in the output file descriptor */
437 /* Amount of bytes written to the output */
438 uint64_t output_written
;
441 int hangup_flush_done
;
444 * Whether the stream is in a "complete" state (e.g. it does not have a
445 * partially written sub-buffer.
447 * Initialized to "false" on stream creation (first packet is empty).
449 * The various transitions of the quiescent state are:
450 * - On "start" tracing: set to false, since the stream is not
452 * - On "stop" tracing: if !quiescent -> flush FINAL (update
453 * timestamp_end), and set to true; the stream has entered a
454 * complete/quiescent state.
455 * - On "destroy" or stream/application hang-up: if !quiescent ->
456 * flush FINAL, and set to true.
458 * NOTE: Update and read are protected by the stream lock.
463 * True if the sequence number is not available (lttng-modules < 2.8).
465 bool sequence_number_unavailable
;
468 * metadata_timer_lock protects flags waiting_on_metadata and
469 * missed_metadata_flush.
471 pthread_mutex_t metadata_timer_lock
;
473 * Flag set when awaiting metadata to be pushed. Used in the
474 * timer thread to skip waiting on the stream (and stream lock) to
475 * ensure we can proceed to flushing metadata in live mode.
477 bool waiting_on_metadata
;
478 /* Raised when a timer misses a metadata flush. */
479 bool missed_metadata_flush
;
481 enum lttng_event_output output
;
482 /* Maximum subbuffer size (in bytes). */
483 unsigned long max_sb_size
;
486 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
487 * used for the mmap base and offset.
490 unsigned long mmap_len
;
495 /* Network sequence number. Indicating on which relayd socket it goes. */
496 uint64_t net_seq_idx
;
498 * Indicate if this stream was successfully sent to a relayd. This is set
499 * after the refcount of the relayd is incremented and is checked when the
500 * stream is closed before decrementing the refcount in order to avoid an
503 unsigned int sent_to_relayd
;
505 /* Identify if the stream is the metadata */
506 unsigned int metadata_flag
;
508 * Last known metadata version, reset the metadata file in case
511 uint64_t metadata_version
;
512 /* Used when the stream is set for network streaming */
513 uint64_t relayd_stream_id
;
515 * When sending a stream packet to a relayd, this number is used to track
516 * the packet sent by the consumer and seen by the relayd. When sending the
517 * data header to the relayd, this number is sent and if the transmission
518 * was successful, it is incremented.
520 * Even if the full data is not fully transmitted it won't matter since
521 * only two possible error can happen after that where either the relayd
522 * died or a read error is detected on the stream making this value useless
525 * This value SHOULD be read/updated atomically or with the lock acquired.
527 uint64_t next_net_seq_num
;
529 * Lock to use the stream FDs since they are used between threads.
531 * This is nested INSIDE the consumer_data lock.
532 * This is nested INSIDE the channel lock.
533 * This is nested INSIDE the channel timer lock.
534 * This is nested OUTSIDE the metadata cache lock.
535 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
537 pthread_mutex_t lock
;
538 /* Tracing session id */
541 * Indicates if the stream end point is still active or not (network
542 * streaming or local file system). The thread "owning" the stream is
543 * handling this status and can be notified of a state change through the
544 * consumer data appropriate pipe.
546 enum consumer_endpoint_status endpoint_status
;
547 /* Stream name. Format is: <channel_name>_<cpu_number> */
548 char name
[LTTNG_SYMBOL_NAME_LEN
];
549 /* Internal state of libustctl. */
550 struct ustctl_consumer_stream
*ustream
;
551 struct cds_list_head send_node
;
552 /* On-disk circular buffer */
553 uint64_t tracefile_size_current
;
554 uint64_t tracefile_count_current
;
556 * Monitor or not the streams of this channel meaning this indicates if the
557 * streams should be sent to the data/metadata thread or added to the no
558 * monitor list of the channel.
560 unsigned int monitor
;
562 * Indicate if the stream is globally visible meaning that it has been
563 * added to the multiple hash tables. If *not* set, NO lock should be
564 * acquired in the destroy path.
566 unsigned int globally_visible
;
568 * Pipe to wake up the metadata poll thread when the UST metadata
571 int ust_metadata_poll_pipe
[2];
573 * How much metadata was read from the metadata cache and sent
576 uint64_t ust_metadata_pushed
;
578 * Copy of the last discarded event value to detect the overflow of
581 uint64_t last_discarded_events
;
582 /* Copy of the sequence number of the last packet extracted. */
583 uint64_t last_sequence_number
;
585 * Index file object of the index file for this stream.
587 struct lttng_index_file
*index_file
;
590 * Local pipe to extract data when using splice.
595 * Rendez-vous point between data and metadata stream in live mode.
597 pthread_cond_t metadata_rdv
;
598 pthread_mutex_t metadata_rdv_lock
;
601 * rotate_position represents the packet sequence number of the last
602 * packet which belongs to the current trace chunk prior to the rotation.
603 * When that position is reached, this tracefile can be closed and a
604 * new one is created in channel_read_only_attributes.path.
606 uint64_t rotate_position
;
608 /* Whether or not a packet was opened during the current trace chunk. */
609 bool opened_packet_in_current_trace_chunk
;
612 * Read-only copies of channel values. We cannot safely access the
613 * channel from a stream, so we need to have a local copy of these
614 * fields in the stream object. These fields should be removed from
615 * the stream objects when we introduce refcounting.
618 uint64_t tracefile_size
;
619 } channel_read_only_attributes
;
622 * Flag to inform the data or metadata thread that a stream is
623 * ready to be rotated.
627 /* Indicate if the stream still has some data to be read. */
628 unsigned int has_data
:1;
630 * Inform the consumer or relay to reset the metadata
631 * file before writing in it (regeneration).
633 unsigned int reset_metadata_flag
:1;
636 * Invoked in the order of declaration.
637 * See callback type definitions.
640 on_wake_up_cb on_wake_up
;
641 get_next_subbuffer_cb get_next_subbuffer
;
642 extract_subbuffer_info_cb extract_subbuffer_info
;
643 pre_consume_subbuffer_cb pre_consume_subbuffer
;
644 reset_metadata_cb reset_metadata
;
645 consume_subbuffer_cb consume_subbuffer
;
646 put_next_subbuffer_cb put_next_subbuffer
;
647 post_consume_cb post_consume
;
648 send_live_beacon_cb send_live_beacon
;
649 on_sleep_cb on_sleep
;
651 assert_locked_cb assert_locked
;
652 } read_subbuffer_ops
;
653 struct metadata_bucket
*metadata_bucket
;
657 * Internal representation of a relayd socket pair.
659 struct consumer_relayd_sock_pair
{
660 /* Network sequence number. */
661 uint64_t net_seq_idx
;
662 /* Number of stream associated with this relayd */
666 * This flag indicates whether or not we should destroy this object. The
667 * destruction should ONLY occurs when this flag is set and the refcount is
670 unsigned int destroy_flag
;
673 * Mutex protecting the control socket to avoid out of order packets
674 * between threads sending data to the relayd. Since metadata data is sent
675 * over that socket, at least two sendmsg() are needed (header + data)
676 * creating a race for packets to overlap between threads using it.
678 * This is nested INSIDE the consumer_data lock.
679 * This is nested INSIDE the stream lock.
681 pthread_mutex_t ctrl_sock_mutex
;
683 /* Control socket. Command and metadata are passed over it */
684 struct lttcomm_relayd_sock control_sock
;
687 * We don't need a mutex at this point since we only splice or write single
688 * large chunk of data with a header appended at the begining. Moreover,
689 * this socket is for now only used in a single thread.
691 struct lttcomm_relayd_sock data_sock
;
692 struct lttng_ht_node_u64 node
;
694 /* Session id on both sides for the sockets. */
695 uint64_t relayd_session_id
;
696 uint64_t sessiond_session_id
;
697 struct lttng_consumer_local_data
*ctx
;
701 * UST consumer local data to the program. One or more instance per
704 struct lttng_consumer_local_data
{
706 * Function to call when data is available on a buffer.
707 * Returns the number of bytes read, or negative error value.
709 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
710 struct lttng_consumer_local_data
*ctx
,
711 bool locked_by_caller
);
713 * function to call when we receive a new channel, it receives a
714 * newly allocated channel, depending on the return code of this
715 * function, the new channel will be handled by the application
719 * > 0 (success, FD is kept by application)
720 * == 0 (success, FD is left to library)
723 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
725 * function to call when we receive a new stream, it receives a
726 * newly allocated stream, depending on the return code of this
727 * function, the new stream will be handled by the application
731 * > 0 (success, FD is kept by application)
732 * == 0 (success, FD is left to library)
735 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
737 * function to call when a stream is getting updated by the session
738 * daemon, this function receives the sessiond key and the new
739 * state, depending on the return code of this function the
740 * update of state for the stream is handled by the application
744 * > 0 (success, FD is kept by application)
745 * == 0 (success, FD is left to library)
748 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
749 enum lttng_consumer_type type
;
750 /* socket to communicate errors with sessiond */
751 int consumer_error_socket
;
752 /* socket to ask metadata to sessiond. */
753 int consumer_metadata_socket
;
755 * Protect consumer_metadata_socket.
757 * This is nested OUTSIDE the metadata cache lock.
759 pthread_mutex_t metadata_socket_lock
;
760 /* socket to exchange commands with sessiond */
761 char *consumer_command_sock_path
;
762 /* communication with splice */
763 int consumer_channel_pipe
[2];
764 /* Data stream poll thread pipe. To transfer data stream to the thread */
765 struct lttng_pipe
*consumer_data_pipe
;
768 * Data thread use that pipe to catch wakeup from read subbuffer that
769 * detects that there is still data to be read for the stream encountered.
770 * Before doing so, the stream is flagged to indicate that there is still
773 * Both pipes (read/write) are owned and used inside the data thread.
775 struct lttng_pipe
*consumer_wakeup_pipe
;
776 /* Indicate if the wakeup thread has been notified. */
777 unsigned int has_wakeup
:1;
779 /* to let the signal handler wake up the fd receiver thread */
780 int consumer_should_quit
[2];
781 /* Metadata poll thread pipe. Transfer metadata stream to it */
782 struct lttng_pipe
*consumer_metadata_pipe
;
784 * Pipe used by the channel monitoring timers to provide state samples
785 * to the session daemon (write-only).
787 int channel_monitor_pipe
;
788 LTTNG_OPTIONAL(lttng_uuid
) sessiond_uuid
;
792 * Library-level data. One instance per process.
794 struct lttng_consumer_global_data
{
796 * At this time, this lock is used to ensure coherence between the count
797 * and number of element in the hash table. It's also a protection for
798 * concurrent read/write between threads.
800 * This is nested OUTSIDE the stream lock.
801 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
803 pthread_mutex_t lock
;
806 * Number of streams in the data stream hash table declared outside.
807 * Protected by consumer_data.lock.
811 /* Channel hash table protected by consumer_data.lock. */
812 struct lttng_ht
*channel_ht
;
813 /* Channel hash table indexed by session id. */
814 struct lttng_ht
*channels_by_session_id_ht
;
816 * Flag specifying if the local array of FDs needs update in the
817 * poll function. Protected by consumer_data.lock.
819 unsigned int need_update
;
820 enum lttng_consumer_type type
;
823 * Relayd socket(s) hashtable indexed by network sequence number. Each
824 * stream has an index which associate the right relayd socket to use.
826 struct lttng_ht
*relayd_ht
;
829 * This hash table contains all streams (metadata and data) indexed by
830 * session id. In other words, the ht is indexed by session id and each
831 * bucket contains the list of associated streams.
833 * This HT uses the "node_session_id" of the consumer stream.
835 struct lttng_ht
*stream_list_ht
;
838 * This HT uses the "node_channel_id" of the consumer stream.
840 struct lttng_ht
*stream_per_chan_id_ht
;
843 * Trace chunk registry indexed by (session_id, chunk_id).
845 struct lttng_trace_chunk_registry
*chunk_registry
;
849 * Set to nonzero when the consumer is exiting. Updated by signal
850 * handler and thread exit, read by threads.
852 extern int consumer_quit
;
855 * Set to nonzero when the consumer is exiting. Updated by signal
856 * handler and thread exit, read by threads.
858 extern int consumer_quit
;
860 /* Flag used to temporarily pause data consumption from testpoints. */
861 extern int data_consumption_paused
;
863 /* Return a human-readable consumer type string that is suitable for logging. */
865 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
868 case LTTNG_CONSUMER_UNKNOWN
:
870 case LTTNG_CONSUMER_KERNEL
:
872 case LTTNG_CONSUMER32_UST
:
873 return "32-bit user space";
874 case LTTNG_CONSUMER64_UST
:
875 return "64-bit user space";
882 * Init consumer data structures.
884 int lttng_consumer_init(void);
887 * Set the error socket for communication with a session daemon.
889 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
893 * Set the command socket path for communication with a session daemon.
895 void lttng_consumer_set_command_sock_path(
896 struct lttng_consumer_local_data
*ctx
, char *sock
);
899 * Send return code to session daemon.
901 * Returns the return code of sendmsg : the number of bytes transmitted or -1
904 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
907 * Called from signal handler to ensure a clean exit.
909 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
912 * Cleanup the daemon's socket on exit.
914 void lttng_consumer_cleanup(void);
917 * Poll on the should_quit pipe and the command socket return -1 on error and
918 * should exit, 0 if data is available on the command socket
920 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
923 * Copy the fields from the channel that need to be accessed (read-only)
924 * directly from the stream.
926 void consumer_stream_update_channel_attributes(
927 struct lttng_consumer_stream
*stream
,
928 struct lttng_consumer_channel
*channel
);
930 struct lttng_consumer_stream
*consumer_allocate_stream(
931 struct lttng_consumer_channel
*channel
,
932 uint64_t channel_key
,
934 const char *channel_name
,
937 struct lttng_trace_chunk
*trace_chunk
,
940 enum consumer_channel_type type
,
941 unsigned int monitor
);
942 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
944 const uint64_t *chunk_id
,
945 const char *pathname
,
948 enum lttng_event_output output
,
949 uint64_t tracefile_size
,
950 uint64_t tracefile_count
,
951 uint64_t session_id_per_pid
,
952 unsigned int monitor
,
953 unsigned int live_timer_interval
,
954 bool is_in_live_session
,
955 const char *root_shm_path
,
956 const char *shm_path
);
957 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
958 struct lttng_ht
*ht
);
959 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
960 struct lttng_ht
*ht
);
961 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
962 struct lttng_consumer_local_data
*ctx
);
963 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
965 /* lttng-relayd consumer command */
966 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
967 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
968 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
969 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
970 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
971 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
973 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
975 struct lttng_consumer_local_data
*lttng_consumer_create(
976 enum lttng_consumer_type type
,
977 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
978 struct lttng_consumer_local_data
*ctx
,
979 bool locked_by_caller
),
980 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
981 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
982 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
983 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
984 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
985 struct lttng_consumer_stream
*stream
,
986 const struct lttng_buffer_view
*buffer
,
987 unsigned long padding
);
988 ssize_t
lttng_consumer_on_read_subbuffer_splice(
989 struct lttng_consumer_local_data
*ctx
,
990 struct lttng_consumer_stream
*stream
, unsigned long len
,
991 unsigned long padding
);
992 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
993 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
994 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
996 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
998 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
999 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
1000 void *consumer_thread_metadata_poll(void *data
);
1001 void *consumer_thread_data_poll(void *data
);
1002 void *consumer_thread_sessiond_poll(void *data
);
1003 void *consumer_thread_channel_poll(void *data
);
1004 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1005 int sock
, struct pollfd
*consumer_sockpoll
);
1007 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1008 struct lttng_consumer_local_data
*ctx
,
1009 bool locked_by_caller
);
1010 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
1011 void consumer_add_relayd_socket(uint64_t net_seq_idx
,
1013 struct lttng_consumer_local_data
*ctx
,
1015 struct pollfd
*consumer_sockpoll
,
1016 uint64_t sessiond_id
,
1017 uint64_t relayd_session_id
,
1018 uint32_t relayd_version_major
,
1019 uint32_t relayd_version_minor
,
1020 enum lttcomm_sock_proto relayd_socket_protocol
);
1021 void consumer_flag_relayd_for_destroy(
1022 struct consumer_relayd_sock_pair
*relayd
);
1023 int consumer_data_pending(uint64_t id
);
1024 int consumer_send_status_msg(int sock
, int ret_code
);
1025 int consumer_send_status_channel(int sock
,
1026 struct lttng_consumer_channel
*channel
);
1027 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
1029 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
1030 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
1031 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
1032 uint64_t max_sb_size
);
1033 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
1034 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
1035 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
1036 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
1037 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
1038 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
1039 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
1040 struct lttng_consumer_local_data
*ctx
);
1041 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
1042 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
1043 struct lttng_consumer_stream
*stream
);
1044 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
1045 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
1046 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
1047 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
1048 const uint64_t *relayd_id
, uint64_t session_id
,
1050 time_t chunk_creation_timestamp
,
1051 const char *chunk_override_name
,
1052 const struct lttng_credentials
*credentials
,
1053 struct lttng_directory_handle
*chunk_directory_handle
);
1054 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
1055 const uint64_t *relayd_id
, uint64_t session_id
,
1056 uint64_t chunk_id
, time_t chunk_close_timestamp
,
1057 const enum lttng_trace_chunk_command_type
*close_command
,
1059 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
1060 const uint64_t *relayd_id
, uint64_t session_id
,
1062 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
1063 enum lttcomm_return_code
lttng_consumer_init_command(
1064 struct lttng_consumer_local_data
*ctx
,
1065 const lttng_uuid sessiond_uuid
);
1066 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
);
1067 enum lttcomm_return_code
lttng_consumer_open_channel_packets(
1068 struct lttng_consumer_channel
*channel
);
1069 int consumer_metadata_wakeup_pipe(const struct lttng_consumer_channel
*channel
);
1071 #endif /* LIB_CONSUMER_H */