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 /* Commands for consumer */
32 enum lttng_consumer_command
{
33 LTTNG_CONSUMER_ADD_CHANNEL
,
34 LTTNG_CONSUMER_ADD_STREAM
,
35 /* pause, delete, active depending on fd state */
36 LTTNG_CONSUMER_UPDATE_STREAM
,
37 /* inform the consumer to quit when all fd has hang up */
38 LTTNG_CONSUMER_STOP
, /* deprecated */
39 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
40 /* Inform the consumer to kill a specific relayd connection */
41 LTTNG_CONSUMER_DESTROY_RELAYD
,
42 /* Return to the sessiond if there is data pending for a session */
43 LTTNG_CONSUMER_DATA_PENDING
,
44 /* Consumer creates a channel and returns it to sessiond. */
45 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
46 LTTNG_CONSUMER_GET_CHANNEL
,
47 LTTNG_CONSUMER_DESTROY_CHANNEL
,
48 LTTNG_CONSUMER_PUSH_METADATA
,
49 LTTNG_CONSUMER_CLOSE_METADATA
,
50 LTTNG_CONSUMER_SETUP_METADATA
,
51 LTTNG_CONSUMER_FLUSH_CHANNEL
,
52 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
53 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
54 LTTNG_CONSUMER_STREAMS_SENT
,
55 LTTNG_CONSUMER_DISCARDED_EVENTS
,
56 LTTNG_CONSUMER_LOST_PACKETS
,
57 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
,
58 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
,
59 LTTNG_CONSUMER_ROTATE_CHANNEL
,
61 LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
62 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
63 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
64 LTTNG_CONSUMER_CLEAR_CHANNEL
,
67 enum lttng_consumer_type
{
68 LTTNG_CONSUMER_UNKNOWN
= 0,
69 LTTNG_CONSUMER_KERNEL
,
74 enum consumer_endpoint_status
{
75 CONSUMER_ENDPOINT_ACTIVE
,
76 CONSUMER_ENDPOINT_INACTIVE
,
79 enum consumer_channel_output
{
80 CONSUMER_CHANNEL_MMAP
= 0,
81 CONSUMER_CHANNEL_SPLICE
= 1,
84 enum consumer_channel_type
{
85 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
86 CONSUMER_CHANNEL_TYPE_DATA
= 1,
89 extern struct lttng_consumer_global_data consumer_data
;
92 struct cds_list_head head
;
97 struct consumer_metadata_cache
;
99 struct lttng_consumer_channel
{
100 /* Is the channel published in the channel hash tables? */
103 * Was the channel deleted (logically) and waiting to be reclaimed?
104 * If this flag is set, no modification that is not cleaned-up by the
105 * RCU reclamation callback should be made
108 /* HT node used for consumer_data.channel_ht */
109 struct lttng_ht_node_u64 node
;
110 /* HT node used for consumer_data.channels_by_session_id_ht */
111 struct lttng_ht_node_u64 channels_by_session_id_ht_node
;
112 /* Indexed key. Incremented value in the consumer. */
114 /* Number of streams referencing this channel */
116 /* Tracing session id on the session daemon side. */
118 /* Current trace chunk of the session in which this channel exists. */
119 struct lttng_trace_chunk
*trace_chunk
;
121 * Session id when requesting metadata to the session daemon for
122 * a session with per-PID buffers.
124 uint64_t session_id_per_pid
;
126 * In the case of local streams, this field contains the channel's
127 * output path; a path relative to the session's output path.
128 * e.g. ust/uid/1000/64-bit
130 * In the case of remote streams, the contents of this field depends
131 * on the version of the relay daemon peer. For 2.11+ peers, the
132 * contents are the same as in the local case. However, for legacy
133 * peers, this contains a path of the form:
134 * /hostname/session_path/ust/uid/1000/64-bit
136 char pathname
[PATH_MAX
];
138 char name
[LTTNG_SYMBOL_NAME_LEN
];
139 /* Relayd id of the channel. -1ULL if it does not apply. */
142 * Number of streams NOT initialized yet. This is used in order to not
143 * delete this channel if streams are getting initialized.
145 unsigned int nb_init_stream_left
;
146 /* Output type (mmap or splice). */
147 enum consumer_channel_output output
;
148 /* Channel type for stream */
149 enum consumer_channel_type type
;
152 uid_t ust_app_uid
; /* Application UID. */
153 struct ustctl_consumer_channel
*uchan
;
154 unsigned char uuid
[LTTNG_UUID_STR_LEN
];
156 * Temporary stream list used to store the streams once created and waiting
157 * to be sent to the session daemon by receiving the
158 * LTTNG_CONSUMER_GET_CHANNEL.
160 struct stream_list streams
;
163 * Set if the channel is metadata. We keep a reference to the stream
164 * because we have to flush data once pushed by the session daemon. For a
165 * regular channel, this is always set to NULL.
167 struct lttng_consumer_stream
*metadata_stream
;
171 /* Node within channel thread ht */
172 struct lttng_ht_node_u64 wait_fd_node
;
174 /* Metadata cache is metadata channel */
175 struct consumer_metadata_cache
*metadata_cache
;
177 /* For UST metadata periodical flush */
178 int switch_timer_enabled
;
179 timer_t switch_timer
;
180 int switch_timer_error
;
182 /* For the live mode */
183 int live_timer_enabled
;
185 int live_timer_error
;
187 /* For channel monitoring timer. */
188 int monitor_timer_enabled
;
189 timer_t monitor_timer
;
191 /* On-disk circular buffer */
192 uint64_t tracefile_size
;
193 uint64_t tracefile_count
;
195 * Monitor or not the streams of this channel meaning this indicates if the
196 * streams should be sent to the data/metadata thread or added to the no
197 * monitor list of the channel.
199 unsigned int monitor
;
204 * This lock protects against concurrent update of channel.
206 * This is nested INSIDE the consumer data lock.
207 * This is nested OUTSIDE the channel timer lock.
208 * This is nested OUTSIDE the metadata cache lock.
209 * This is nested OUTSIDE stream lock.
210 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
212 pthread_mutex_t lock
;
215 * Channel teardown lock.
217 * This lock protect against teardown of channel. It is _never_
218 * taken by the timer handler.
220 * This is nested INSIDE the consumer data lock.
221 * This is nested INSIDE the channel lock.
222 * This is nested OUTSIDE the metadata cache lock.
223 * This is nested OUTSIDE stream lock.
224 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
226 pthread_mutex_t timer_lock
;
228 /* Timer value in usec for live streaming. */
229 unsigned int live_timer_interval
;
233 char root_shm_path
[PATH_MAX
];
234 char shm_path
[PATH_MAX
];
235 /* Only set for UST channels. */
236 LTTNG_OPTIONAL(struct lttng_credentials
) buffer_credentials
;
237 /* Total number of discarded events for that channel. */
238 uint64_t discarded_events
;
239 /* Total number of missed packets due to overwriting (overwrite). */
240 uint64_t lost_packets
;
242 bool streams_sent_to_relayd
;
246 * Internal representation of the streams, sessiond_key is used to identify
249 struct lttng_consumer_stream
{
250 /* HT node used by the data_ht and metadata_ht */
251 struct lttng_ht_node_u64 node
;
252 /* stream indexed per channel key node */
253 struct lttng_ht_node_u64 node_channel_id
;
254 /* HT node used in consumer_data.stream_list_ht */
255 struct lttng_ht_node_u64 node_session_id
;
256 /* Pointer to associated channel. */
257 struct lttng_consumer_channel
*chan
;
259 * Current trace chunk. Holds a reference to the trace chunk.
260 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
261 * when it was created in the context of a no-output session.
263 struct lttng_trace_chunk
*trace_chunk
;
265 /* Key by which the stream is indexed for 'node'. */
268 * File descriptor of the data output file. This can be either a file or a
269 * socket fd for relayd streaming.
271 int out_fd
; /* output file to write the data */
272 /* Write position in the output file descriptor */
274 /* Amount of bytes written to the output */
275 uint64_t output_written
;
278 int hangup_flush_done
;
281 * Whether the stream is in a "complete" state (e.g. it does not have a
282 * partially written sub-buffer.
284 * Initialized to "false" on stream creation (first packet is empty).
286 * The various transitions of the quiescent state are:
287 * - On "start" tracing: set to false, since the stream is not
289 * - On "stop" tracing: if !quiescent -> flush FINAL (update
290 * timestamp_end), and set to true; the stream has entered a
291 * complete/quiescent state.
292 * - On "destroy" or stream/application hang-up: if !quiescent ->
293 * flush FINAL, and set to true.
295 * NOTE: Update and read are protected by the stream lock.
300 * True if the sequence number is not available (lttng-modules < 2.8).
302 bool sequence_number_unavailable
;
305 * metadata_timer_lock protects flags waiting_on_metadata and
306 * missed_metadata_flush.
308 pthread_mutex_t metadata_timer_lock
;
310 * Flag set when awaiting metadata to be pushed. Used in the
311 * timer thread to skip waiting on the stream (and stream lock) to
312 * ensure we can proceed to flushing metadata in live mode.
314 bool waiting_on_metadata
;
315 /* Raised when a timer misses a metadata flush. */
316 bool missed_metadata_flush
;
318 enum lttng_event_output output
;
319 /* Maximum subbuffer size (in bytes). */
320 unsigned long max_sb_size
;
323 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
324 * used for the mmap base and offset.
327 unsigned long mmap_len
;
332 /* Network sequence number. Indicating on which relayd socket it goes. */
333 uint64_t net_seq_idx
;
335 * Indicate if this stream was successfully sent to a relayd. This is set
336 * after the refcount of the relayd is incremented and is checked when the
337 * stream is closed before decrementing the refcount in order to avoid an
340 unsigned int sent_to_relayd
;
342 /* Identify if the stream is the metadata */
343 unsigned int metadata_flag
;
345 * Last known metadata version, reset the metadata file in case
348 uint64_t metadata_version
;
349 /* Used when the stream is set for network streaming */
350 uint64_t relayd_stream_id
;
352 * When sending a stream packet to a relayd, this number is used to track
353 * the packet sent by the consumer and seen by the relayd. When sending the
354 * data header to the relayd, this number is sent and if the transmission
355 * was successful, it is incremented.
357 * Even if the full data is not fully transmitted it won't matter since
358 * only two possible error can happen after that where either the relayd
359 * died or a read error is detected on the stream making this value useless
362 * This value SHOULD be read/updated atomically or with the lock acquired.
364 uint64_t next_net_seq_num
;
366 * Lock to use the stream FDs since they are used between threads.
368 * This is nested INSIDE the consumer_data lock.
369 * This is nested INSIDE the channel lock.
370 * This is nested INSIDE the channel timer lock.
371 * This is nested OUTSIDE the metadata cache lock.
372 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
374 pthread_mutex_t lock
;
375 /* Tracing session id */
378 * Indicates if the stream end point is still active or not (network
379 * streaming or local file system). The thread "owning" the stream is
380 * handling this status and can be notified of a state change through the
381 * consumer data appropriate pipe.
383 enum consumer_endpoint_status endpoint_status
;
384 /* Stream name. Format is: <channel_name>_<cpu_number> */
385 char name
[LTTNG_SYMBOL_NAME_LEN
];
386 /* Internal state of libustctl. */
387 struct ustctl_consumer_stream
*ustream
;
388 struct cds_list_head send_node
;
389 /* On-disk circular buffer */
390 uint64_t tracefile_size_current
;
391 uint64_t tracefile_count_current
;
393 * Monitor or not the streams of this channel meaning this indicates if the
394 * streams should be sent to the data/metadata thread or added to the no
395 * monitor list of the channel.
397 unsigned int monitor
;
399 * Indicate if the stream is globally visible meaning that it has been
400 * added to the multiple hash tables. If *not* set, NO lock should be
401 * acquired in the destroy path.
403 unsigned int globally_visible
;
405 * Pipe to wake up the metadata poll thread when the UST metadata
408 int ust_metadata_poll_pipe
[2];
410 * How much metadata was read from the metadata cache and sent
413 uint64_t ust_metadata_pushed
;
415 * Copy of the last discarded event value to detect the overflow of
418 uint64_t last_discarded_events
;
419 /* Copy of the sequence number of the last packet extracted. */
420 uint64_t last_sequence_number
;
422 * Index file object of the index file for this stream.
424 struct lttng_index_file
*index_file
;
427 * Local pipe to extract data when using splice.
432 * Rendez-vous point between data and metadata stream in live mode.
434 pthread_cond_t metadata_rdv
;
435 pthread_mutex_t metadata_rdv_lock
;
438 * rotate_position represents the packet sequence number of the last
439 * packet which belongs to the current trace chunk prior to the rotation.
440 * When that position is reached, this tracefile can be closed and a
441 * new one is created in channel_read_only_attributes.path.
443 uint64_t rotate_position
;
446 * Read-only copies of channel values. We cannot safely access the
447 * channel from a stream, so we need to have a local copy of these
448 * fields in the stream object. These fields should be removed from
449 * the stream objects when we introduce refcounting.
452 uint64_t tracefile_size
;
453 } channel_read_only_attributes
;
456 * Flag to inform the data or metadata thread that a stream is
457 * ready to be rotated.
461 /* Indicate if the stream still has some data to be read. */
462 unsigned int has_data
:1;
464 * Inform the consumer or relay to reset the metadata
465 * file before writing in it (regeneration).
467 unsigned int reset_metadata_flag
:1;
471 * Internal representation of a relayd socket pair.
473 struct consumer_relayd_sock_pair
{
474 /* Network sequence number. */
475 uint64_t net_seq_idx
;
476 /* Number of stream associated with this relayd */
480 * This flag indicates whether or not we should destroy this object. The
481 * destruction should ONLY occurs when this flag is set and the refcount is
484 unsigned int destroy_flag
;
487 * Mutex protecting the control socket to avoid out of order packets
488 * between threads sending data to the relayd. Since metadata data is sent
489 * over that socket, at least two sendmsg() are needed (header + data)
490 * creating a race for packets to overlap between threads using it.
492 * This is nested INSIDE the consumer_data lock.
493 * This is nested INSIDE the stream lock.
495 pthread_mutex_t ctrl_sock_mutex
;
497 /* Control socket. Command and metadata are passed over it */
498 struct lttcomm_relayd_sock control_sock
;
501 * We don't need a mutex at this point since we only splice or write single
502 * large chunk of data with a header appended at the begining. Moreover,
503 * this socket is for now only used in a single thread.
505 struct lttcomm_relayd_sock data_sock
;
506 struct lttng_ht_node_u64 node
;
508 /* Session id on both sides for the sockets. */
509 uint64_t relayd_session_id
;
510 uint64_t sessiond_session_id
;
511 struct lttng_consumer_local_data
*ctx
;
515 * UST consumer local data to the program. One or more instance per
518 struct lttng_consumer_local_data
{
520 * Function to call when data is available on a buffer.
521 * Returns the number of bytes read, or negative error value.
523 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
524 struct lttng_consumer_local_data
*ctx
);
526 * function to call when we receive a new channel, it receives a
527 * newly allocated channel, depending on the return code of this
528 * function, the new channel will be handled by the application
532 * > 0 (success, FD is kept by application)
533 * == 0 (success, FD is left to library)
536 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
538 * function to call when we receive a new stream, it receives a
539 * newly allocated stream, depending on the return code of this
540 * function, the new stream will be handled by the application
544 * > 0 (success, FD is kept by application)
545 * == 0 (success, FD is left to library)
548 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
550 * function to call when a stream is getting updated by the session
551 * daemon, this function receives the sessiond key and the new
552 * state, depending on the return code of this function the
553 * update of state for the stream is handled by the application
557 * > 0 (success, FD is kept by application)
558 * == 0 (success, FD is left to library)
561 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
562 enum lttng_consumer_type type
;
563 /* socket to communicate errors with sessiond */
564 int consumer_error_socket
;
565 /* socket to ask metadata to sessiond. */
566 int consumer_metadata_socket
;
568 * Protect consumer_metadata_socket.
570 * This is nested OUTSIDE the metadata cache lock.
572 pthread_mutex_t metadata_socket_lock
;
573 /* socket to exchange commands with sessiond */
574 char *consumer_command_sock_path
;
575 /* communication with splice */
576 int consumer_channel_pipe
[2];
577 /* Data stream poll thread pipe. To transfer data stream to the thread */
578 struct lttng_pipe
*consumer_data_pipe
;
581 * Data thread use that pipe to catch wakeup from read subbuffer that
582 * detects that there is still data to be read for the stream encountered.
583 * Before doing so, the stream is flagged to indicate that there is still
586 * Both pipes (read/write) are owned and used inside the data thread.
588 struct lttng_pipe
*consumer_wakeup_pipe
;
589 /* Indicate if the wakeup thread has been notified. */
590 unsigned int has_wakeup
:1;
592 /* to let the signal handler wake up the fd receiver thread */
593 int consumer_should_quit
[2];
594 /* Metadata poll thread pipe. Transfer metadata stream to it */
595 struct lttng_pipe
*consumer_metadata_pipe
;
597 * Pipe used by the channel monitoring timers to provide state samples
598 * to the session daemon (write-only).
600 int channel_monitor_pipe
;
601 LTTNG_OPTIONAL(lttng_uuid
) sessiond_uuid
;
605 * Library-level data. One instance per process.
607 struct lttng_consumer_global_data
{
609 * At this time, this lock is used to ensure coherence between the count
610 * and number of element in the hash table. It's also a protection for
611 * concurrent read/write between threads.
613 * This is nested OUTSIDE the stream lock.
614 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
616 pthread_mutex_t lock
;
619 * Number of streams in the data stream hash table declared outside.
620 * Protected by consumer_data.lock.
624 /* Channel hash table protected by consumer_data.lock. */
625 struct lttng_ht
*channel_ht
;
626 /* Channel hash table indexed by session id. */
627 struct lttng_ht
*channels_by_session_id_ht
;
629 * Flag specifying if the local array of FDs needs update in the
630 * poll function. Protected by consumer_data.lock.
632 unsigned int need_update
;
633 enum lttng_consumer_type type
;
636 * Relayd socket(s) hashtable indexed by network sequence number. Each
637 * stream has an index which associate the right relayd socket to use.
639 struct lttng_ht
*relayd_ht
;
642 * This hash table contains all streams (metadata and data) indexed by
643 * session id. In other words, the ht is indexed by session id and each
644 * bucket contains the list of associated streams.
646 * This HT uses the "node_session_id" of the consumer stream.
648 struct lttng_ht
*stream_list_ht
;
651 * This HT uses the "node_channel_id" of the consumer stream.
653 struct lttng_ht
*stream_per_chan_id_ht
;
656 * Trace chunk registry indexed by (session_id, chunk_id).
658 struct lttng_trace_chunk_registry
*chunk_registry
;
662 * Set to nonzero when the consumer is exiting. Updated by signal
663 * handler and thread exit, read by threads.
665 extern int consumer_quit
;
668 * Set to nonzero when the consumer is exiting. Updated by signal
669 * handler and thread exit, read by threads.
671 extern int consumer_quit
;
673 /* Flag used to temporarily pause data consumption from testpoints. */
674 extern int data_consumption_paused
;
676 /* Return a human-readable consumer type string that is suitable for logging. */
678 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
681 case LTTNG_CONSUMER_UNKNOWN
:
683 case LTTNG_CONSUMER_KERNEL
:
685 case LTTNG_CONSUMER32_UST
:
686 return "32-bit user space";
687 case LTTNG_CONSUMER64_UST
:
688 return "64-bit user space";
695 * Init consumer data structures.
697 int lttng_consumer_init(void);
700 * Set the error socket for communication with a session daemon.
702 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
706 * Set the command socket path for communication with a session daemon.
708 void lttng_consumer_set_command_sock_path(
709 struct lttng_consumer_local_data
*ctx
, char *sock
);
712 * Send return code to session daemon.
714 * Returns the return code of sendmsg : the number of bytes transmitted or -1
717 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
720 * Called from signal handler to ensure a clean exit.
722 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
725 * Cleanup the daemon's socket on exit.
727 void lttng_consumer_cleanup(void);
730 * Poll on the should_quit pipe and the command socket return -1 on error and
731 * should exit, 0 if data is available on the command socket
733 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
736 * Copy the fields from the channel that need to be accessed (read-only)
737 * directly from the stream.
739 void consumer_stream_update_channel_attributes(
740 struct lttng_consumer_stream
*stream
,
741 struct lttng_consumer_channel
*channel
);
743 struct lttng_consumer_stream
*consumer_allocate_stream(
744 struct lttng_consumer_channel
*channel
,
745 uint64_t channel_key
,
747 const char *channel_name
,
750 struct lttng_trace_chunk
*trace_chunk
,
753 enum consumer_channel_type type
,
754 unsigned int monitor
);
755 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
757 const uint64_t *chunk_id
,
758 const char *pathname
,
761 enum lttng_event_output output
,
762 uint64_t tracefile_size
,
763 uint64_t tracefile_count
,
764 uint64_t session_id_per_pid
,
765 unsigned int monitor
,
766 unsigned int live_timer_interval
,
767 const char *root_shm_path
,
768 const char *shm_path
);
769 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
770 struct lttng_ht
*ht
);
771 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
772 struct lttng_ht
*ht
);
773 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
774 struct lttng_consumer_local_data
*ctx
);
775 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
777 /* lttng-relayd consumer command */
778 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
779 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
780 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
781 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
782 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
783 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
785 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
787 struct lttng_consumer_local_data
*lttng_consumer_create(
788 enum lttng_consumer_type type
,
789 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
790 struct lttng_consumer_local_data
*ctx
),
791 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
792 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
793 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
794 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
795 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
796 struct lttng_consumer_local_data
*ctx
,
797 struct lttng_consumer_stream
*stream
,
798 const struct lttng_buffer_view
*buffer
,
799 unsigned long padding
,
800 struct ctf_packet_index
*index
);
801 ssize_t
lttng_consumer_on_read_subbuffer_splice(
802 struct lttng_consumer_local_data
*ctx
,
803 struct lttng_consumer_stream
*stream
, unsigned long len
,
804 unsigned long padding
,
805 struct ctf_packet_index
*index
);
806 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
807 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
808 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
810 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
812 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
813 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
814 void *consumer_thread_metadata_poll(void *data
);
815 void *consumer_thread_data_poll(void *data
);
816 void *consumer_thread_sessiond_poll(void *data
);
817 void *consumer_thread_channel_poll(void *data
);
818 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
819 int sock
, struct pollfd
*consumer_sockpoll
);
821 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
822 struct lttng_consumer_local_data
*ctx
);
823 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
824 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
825 struct lttng_consumer_local_data
*ctx
, int sock
,
826 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
827 uint64_t sessiond_id
, uint64_t relayd_session_id
);
828 void consumer_flag_relayd_for_destroy(
829 struct consumer_relayd_sock_pair
*relayd
);
830 int consumer_data_pending(uint64_t id
);
831 int consumer_send_status_msg(int sock
, int ret_code
);
832 int consumer_send_status_channel(int sock
,
833 struct lttng_consumer_channel
*channel
);
834 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
836 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
837 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
838 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
839 uint64_t max_sb_size
);
840 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
841 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
842 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
843 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
844 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
845 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
846 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
847 struct lttng_consumer_local_data
*ctx
);
848 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
849 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
850 struct lttng_consumer_stream
*stream
);
851 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
852 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
853 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
854 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
855 const uint64_t *relayd_id
, uint64_t session_id
,
857 time_t chunk_creation_timestamp
,
858 const char *chunk_override_name
,
859 const struct lttng_credentials
*credentials
,
860 struct lttng_directory_handle
*chunk_directory_handle
);
861 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
862 const uint64_t *relayd_id
, uint64_t session_id
,
863 uint64_t chunk_id
, time_t chunk_close_timestamp
,
864 const enum lttng_trace_chunk_command_type
*close_command
,
866 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
867 const uint64_t *relayd_id
, uint64_t session_id
,
869 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
870 enum lttcomm_return_code
lttng_consumer_init_command(
871 struct lttng_consumer_local_data
*ctx
,
872 const lttng_uuid sessiond_uuid
);
873 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
);
875 #endif /* LIB_CONSUMER_H */