2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2012 - David Goulet <dgoulet@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef LIB_CONSUMER_H
21 #define LIB_CONSUMER_H
26 #include <urcu/list.h>
28 #include <lttng/lttng.h>
30 #include <common/hashtable/hashtable.h>
31 #include <common/compat/fcntl.h>
32 #include <common/compat/uuid.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
34 #include <common/pipe.h>
35 #include <common/index/ctf-index.h>
37 /* Commands for consumer */
38 enum lttng_consumer_command
{
39 LTTNG_CONSUMER_ADD_CHANNEL
,
40 LTTNG_CONSUMER_ADD_STREAM
,
41 /* pause, delete, active depending on fd state */
42 LTTNG_CONSUMER_UPDATE_STREAM
,
43 /* inform the consumer to quit when all fd has hang up */
44 LTTNG_CONSUMER_STOP
, /* deprecated */
45 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
46 /* Inform the consumer to kill a specific relayd connection */
47 LTTNG_CONSUMER_DESTROY_RELAYD
,
48 /* Return to the sessiond if there is data pending for a session */
49 LTTNG_CONSUMER_DATA_PENDING
,
50 /* Consumer creates a channel and returns it to sessiond. */
51 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
52 LTTNG_CONSUMER_GET_CHANNEL
,
53 LTTNG_CONSUMER_DESTROY_CHANNEL
,
54 LTTNG_CONSUMER_PUSH_METADATA
,
55 LTTNG_CONSUMER_CLOSE_METADATA
,
56 LTTNG_CONSUMER_SETUP_METADATA
,
57 LTTNG_CONSUMER_FLUSH_CHANNEL
,
58 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
59 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
60 LTTNG_CONSUMER_STREAMS_SENT
,
61 LTTNG_CONSUMER_DISCARDED_EVENTS
,
62 LTTNG_CONSUMER_LOST_PACKETS
,
63 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
,
64 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
,
65 LTTNG_CONSUMER_SET_CHANNEL_ROTATE_PIPE
,
66 LTTNG_CONSUMER_ROTATE_CHANNEL
,
69 /* State of each fd in consumer */
70 enum lttng_consumer_stream_state
{
71 LTTNG_CONSUMER_ACTIVE_STREAM
,
72 LTTNG_CONSUMER_PAUSE_STREAM
,
73 LTTNG_CONSUMER_DELETE_STREAM
,
76 enum lttng_consumer_type
{
77 LTTNG_CONSUMER_UNKNOWN
= 0,
78 LTTNG_CONSUMER_KERNEL
,
83 enum consumer_endpoint_status
{
84 CONSUMER_ENDPOINT_ACTIVE
,
85 CONSUMER_ENDPOINT_INACTIVE
,
88 enum consumer_channel_output
{
89 CONSUMER_CHANNEL_MMAP
= 0,
90 CONSUMER_CHANNEL_SPLICE
= 1,
93 enum consumer_channel_type
{
94 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
95 CONSUMER_CHANNEL_TYPE_DATA
= 1,
98 extern struct lttng_consumer_global_data consumer_data
;
101 struct cds_list_head head
;
106 struct consumer_metadata_cache
;
108 struct lttng_consumer_channel
{
109 /* HT node used for consumer_data.channel_ht */
110 struct lttng_ht_node_u64 node
;
111 /* Indexed key. Incremented value in the consumer. */
113 /* Number of streams referencing this channel */
115 /* Tracing session id on the session daemon side. */
118 * Session id when requesting metadata to the session daemon for
119 * a session with per-PID buffers.
121 uint64_t session_id_per_pid
;
122 /* Channel trace file path name. */
123 char pathname
[PATH_MAX
];
125 char name
[LTTNG_SYMBOL_NAME_LEN
];
126 /* UID and GID of the session owning this channel. */
129 /* Relayd id of the channel. -1ULL if it does not apply. */
132 * Number of streams NOT initialized yet. This is used in order to not
133 * delete this channel if streams are getting initialized.
135 unsigned int nb_init_stream_left
;
136 /* Output type (mmap or splice). */
137 enum consumer_channel_output output
;
138 /* Channel type for stream */
139 enum consumer_channel_type type
;
142 uid_t ust_app_uid
; /* Application UID. */
143 struct ustctl_consumer_channel
*uchan
;
144 unsigned char uuid
[UUID_STR_LEN
];
146 * Temporary stream list used to store the streams once created and waiting
147 * to be sent to the session daemon by receiving the
148 * LTTNG_CONSUMER_GET_CHANNEL.
150 struct stream_list streams
;
153 * Set if the channel is metadata. We keep a reference to the stream
154 * because we have to flush data once pushed by the session daemon. For a
155 * regular channel, this is always set to NULL.
157 struct lttng_consumer_stream
*metadata_stream
;
161 /* Node within channel thread ht */
162 struct lttng_ht_node_u64 wait_fd_node
;
164 /* Metadata cache is metadata channel */
165 struct consumer_metadata_cache
*metadata_cache
;
167 /* For UST metadata periodical flush */
168 int switch_timer_enabled
;
169 timer_t switch_timer
;
170 int switch_timer_error
;
172 /* For the live mode */
173 int live_timer_enabled
;
175 int live_timer_error
;
177 /* For channel monitoring timer. */
178 int monitor_timer_enabled
;
179 timer_t monitor_timer
;
181 /* On-disk circular buffer */
182 uint64_t tracefile_size
;
183 uint64_t tracefile_count
;
185 * Monitor or not the streams of this channel meaning this indicates if the
186 * streams should be sent to the data/metadata thread or added to the no
187 * monitor list of the channel.
189 unsigned int monitor
;
194 * This lock protects against concurrent update of channel.
196 * This is nested INSIDE the consumer data lock.
197 * This is nested OUTSIDE the channel timer lock.
198 * This is nested OUTSIDE the metadata cache lock.
199 * This is nested OUTSIDE stream lock.
200 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
202 pthread_mutex_t lock
;
205 * Channel teardown lock.
207 * This lock protect against teardown of channel. It is _never_
208 * taken by the timer handler.
210 * This is nested INSIDE the consumer data lock.
211 * This is nested INSIDE the channel 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 timer_lock
;
218 /* Timer value in usec for live streaming. */
219 unsigned int live_timer_interval
;
223 char root_shm_path
[PATH_MAX
];
224 char shm_path
[PATH_MAX
];
225 /* Total number of discarded events for that channel. */
226 uint64_t discarded_events
;
227 /* Total number of missed packets due to overwriting (overwrite). */
228 uint64_t lost_packets
;
230 bool streams_sent_to_relayd
;
233 * Account how many streams are waiting for their rotation to be
234 * complete. When this number reaches 0, we inform the session
235 * daemon that this channel has finished its rotation.
237 uint64_t nr_stream_rotate_pending
;
241 * Internal representation of the streams, sessiond_key is used to identify
244 struct lttng_consumer_stream
{
245 /* HT node used by the data_ht and metadata_ht */
246 struct lttng_ht_node_u64 node
;
247 /* stream indexed per channel key node */
248 struct lttng_ht_node_u64 node_channel_id
;
249 /* HT node used in consumer_data.stream_list_ht */
250 struct lttng_ht_node_u64 node_session_id
;
251 /* Pointer to associated channel. */
252 struct lttng_consumer_channel
*chan
;
254 /* Key by which the stream is indexed for 'node'. */
257 * File descriptor of the data output file. This can be either a file or a
258 * socket fd for relayd streaming.
260 int out_fd
; /* output file to write the data */
261 /* Write position in the output file descriptor */
263 /* Amount of bytes written to the output */
264 uint64_t output_written
;
265 enum lttng_consumer_stream_state state
;
268 int hangup_flush_done
;
271 * Whether the stream is in a "complete" state (e.g. it does not have a
272 * partially written sub-buffer.
274 * Initialized to "false" on stream creation (first packet is empty).
276 * The various transitions of the quiescent state are:
277 * - On "start" tracing: set to false, since the stream is not
279 * - On "stop" tracing: if !quiescent -> flush FINAL (update
280 * timestamp_end), and set to true; the stream has entered a
281 * complete/quiescent state.
282 * - On "destroy" or stream/application hang-up: if !quiescent ->
283 * flush FINAL, and set to true.
285 * NOTE: Update and read are protected by the stream lock.
290 * metadata_timer_lock protects flags waiting_on_metadata and
291 * missed_metadata_flush.
293 pthread_mutex_t metadata_timer_lock
;
295 * Flag set when awaiting metadata to be pushed. Used in the
296 * timer thread to skip waiting on the stream (and stream lock) to
297 * ensure we can proceed to flushing metadata in live mode.
299 bool waiting_on_metadata
;
300 /* Raised when a timer misses a metadata flush. */
301 bool missed_metadata_flush
;
303 enum lttng_event_output output
;
304 /* Maximum subbuffer size. */
305 unsigned long max_sb_size
;
308 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
309 * used for the mmap base and offset.
312 unsigned long mmap_len
;
317 /* UID/GID of the user owning the session to which stream belongs */
320 /* Network sequence number. Indicating on which relayd socket it goes. */
321 uint64_t net_seq_idx
;
323 * Indicate if this stream was successfully sent to a relayd. This is set
324 * after the refcount of the relayd is incremented and is checked when the
325 * stream is closed before decrementing the refcount in order to avoid an
328 unsigned int sent_to_relayd
;
330 /* Identify if the stream is the metadata */
331 unsigned int metadata_flag
;
333 * Last known metadata version, reset the metadata file in case
336 uint64_t metadata_version
;
337 /* Used when the stream is set for network streaming */
338 uint64_t relayd_stream_id
;
340 * When sending a stream packet to a relayd, this number is used to track
341 * the packet sent by the consumer and seen by the relayd. When sending the
342 * data header to the relayd, this number is sent and if the transmission
343 * was successful, it is incremented.
345 * Even if the full data is not fully transmitted it won't matter since
346 * only two possible error can happen after that where either the relayd
347 * died or a read error is detected on the stream making this value useless
350 * This value SHOULD be read/updated atomically or with the lock acquired.
352 uint64_t next_net_seq_num
;
354 * Lock to use the stream FDs since they are used between threads.
356 * This is nested INSIDE the consumer_data lock.
357 * This is nested INSIDE the channel lock.
358 * This is nested INSIDE the channel timer lock.
359 * This is nested OUTSIDE the metadata cache lock.
360 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
362 pthread_mutex_t lock
;
363 /* Tracing session id */
366 * Indicates if the stream end point is still active or not (network
367 * streaming or local file system). The thread "owning" the stream is
368 * handling this status and can be notified of a state change through the
369 * consumer data appropriate pipe.
371 enum consumer_endpoint_status endpoint_status
;
372 /* Stream name. Format is: <channel_name>_<cpu_number> */
373 char name
[LTTNG_SYMBOL_NAME_LEN
];
374 /* Internal state of libustctl. */
375 struct ustctl_consumer_stream
*ustream
;
376 struct cds_list_head send_node
;
377 /* On-disk circular buffer */
378 uint64_t tracefile_size_current
;
379 uint64_t tracefile_count_current
;
381 * Monitor or not the streams of this channel meaning this indicates if the
382 * streams should be sent to the data/metadata thread or added to the no
383 * monitor list of the channel.
385 unsigned int monitor
;
387 * Indicate if the stream is globally visible meaning that it has been
388 * added to the multiple hash tables. If *not* set, NO lock should be
389 * acquired in the destroy path.
391 unsigned int globally_visible
;
393 * Pipe to wake up the metadata poll thread when the UST metadata
396 int ust_metadata_poll_pipe
[2];
398 * How much metadata was read from the metadata cache and sent
401 uint64_t ust_metadata_pushed
;
403 * Copy of the last discarded event value to detect the overflow of
406 uint64_t last_discarded_events
;
407 /* Copy of the sequence number of the last packet extracted. */
408 uint64_t last_sequence_number
;
410 * Index file object of the index file for this stream.
412 struct lttng_index_file
*index_file
;
415 * Local pipe to extract data when using splice.
420 * Rendez-vous point between data and metadata stream in live mode.
422 pthread_cond_t metadata_rdv
;
423 pthread_mutex_t metadata_rdv_lock
;
426 * If rotate_position != 0, when we reach this position in the
427 * ring-buffer, close this tracefile and create a new one in
430 uint64_t rotate_position
;
433 * Read-only copies of channel values. We cannot safely access the
434 * channel from a stream, so we need to have a local copy of these
435 * fields in the stream object. These fields should be removed from
436 * the stream objects when we introduce refcounting.
438 char channel_ro_pathname
[PATH_MAX
];
439 uint64_t channel_ro_tracefile_size
;
442 * If rotate_ready is set to 1, rotate the stream the next time data
443 * need to be extracted, regardless of the rotate_position. This is
444 * used if all the metadata has been consumed when we rotate. In this
445 * case, the snapshot of the positions returns -EAGAIN and we cannot
446 * use the produced/consumed positions as reference.
448 unsigned int rotate_ready
:1;
450 * Flag set to 1 if the stream just got rotated. This is used to
451 * perform actions on the channel after a rotation without needing
452 * to nest the channel lock inside the stream lock.
454 unsigned int rotated
:1;
456 /* Indicate if the stream still has some data to be read. */
457 unsigned int has_data
:1;
459 * Inform the consumer or relay to reset the metadata
460 * file before writing in it (regeneration).
462 unsigned int reset_metadata_flag
:1;
466 * Internal representation of a relayd socket pair.
468 struct consumer_relayd_sock_pair
{
469 /* Network sequence number. */
470 uint64_t net_seq_idx
;
471 /* Number of stream associated with this relayd */
472 unsigned int refcount
;
475 * This flag indicates whether or not we should destroy this object. The
476 * destruction should ONLY occurs when this flag is set and the refcount is
479 unsigned int destroy_flag
;
482 * Mutex protecting the control socket to avoid out of order packets
483 * between threads sending data to the relayd. Since metadata data is sent
484 * over that socket, at least two sendmsg() are needed (header + data)
485 * creating a race for packets to overlap between threads using it.
487 * This is nested INSIDE the consumer_data lock.
488 * This is nested INSIDE the stream lock.
490 pthread_mutex_t ctrl_sock_mutex
;
492 /* Control socket. Command and metadata are passed over it */
493 struct lttcomm_relayd_sock control_sock
;
496 * We don't need a mutex at this point since we only splice or write single
497 * large chunk of data with a header appended at the begining. Moreover,
498 * this socket is for now only used in a single thread.
500 struct lttcomm_relayd_sock data_sock
;
501 struct lttng_ht_node_u64 node
;
503 /* Session id on both sides for the sockets. */
504 uint64_t relayd_session_id
;
505 uint64_t sessiond_session_id
;
509 * UST consumer local data to the program. One or more instance per
512 struct lttng_consumer_local_data
{
514 * Function to call when data is available on a buffer.
515 * Returns the number of bytes read, or negative error value.
517 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
518 struct lttng_consumer_local_data
*ctx
);
520 * function to call when we receive a new channel, it receives a
521 * newly allocated channel, depending on the return code of this
522 * function, the new channel will be handled by the application
526 * > 0 (success, FD is kept by application)
527 * == 0 (success, FD is left to library)
530 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
532 * function to call when we receive a new stream, it receives a
533 * newly allocated stream, depending on the return code of this
534 * function, the new stream will be handled by the application
538 * > 0 (success, FD is kept by application)
539 * == 0 (success, FD is left to library)
542 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
544 * function to call when a stream is getting updated by the session
545 * daemon, this function receives the sessiond key and the new
546 * state, depending on the return code of this function the
547 * update of state for the stream is handled by the application
551 * > 0 (success, FD is kept by application)
552 * == 0 (success, FD is left to library)
555 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
556 enum lttng_consumer_type type
;
557 /* socket to communicate errors with sessiond */
558 int consumer_error_socket
;
559 /* socket to ask metadata to sessiond. */
560 int consumer_metadata_socket
;
562 * Protect consumer_metadata_socket.
564 * This is nested OUTSIDE the metadata cache lock.
566 pthread_mutex_t metadata_socket_lock
;
567 /* socket to exchange commands with sessiond */
568 char *consumer_command_sock_path
;
569 /* communication with splice */
570 int consumer_channel_pipe
[2];
571 /* Data stream poll thread pipe. To transfer data stream to the thread */
572 struct lttng_pipe
*consumer_data_pipe
;
575 * Data thread use that pipe to catch wakeup from read subbuffer that
576 * detects that there is still data to be read for the stream encountered.
577 * Before doing so, the stream is flagged to indicate that there is still
580 * Both pipes (read/write) are owned and used inside the data thread.
582 struct lttng_pipe
*consumer_wakeup_pipe
;
583 /* Indicate if the wakeup thread has been notified. */
584 unsigned int has_wakeup
:1;
586 /* to let the signal handler wake up the fd receiver thread */
587 int consumer_should_quit
[2];
588 /* Metadata poll thread pipe. Transfer metadata stream to it */
589 struct lttng_pipe
*consumer_metadata_pipe
;
591 * Pipe used by the channel monitoring timers to provide state samples
592 * to the session daemon (write-only).
594 int channel_monitor_pipe
;
596 * Pipe used to inform the session daemon that a stream has finished
597 * its rotation (write-only).
599 int channel_rotate_pipe
;
603 * Library-level data. One instance per process.
605 struct lttng_consumer_global_data
{
607 * At this time, this lock is used to ensure coherence between the count
608 * and number of element in the hash table. It's also a protection for
609 * concurrent read/write between threads.
611 * This is nested OUTSIDE the stream lock.
612 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
614 pthread_mutex_t lock
;
617 * Number of streams in the data stream hash table declared outside.
618 * Protected by consumer_data.lock.
622 /* Channel hash table protected by consumer_data.lock. */
623 struct lttng_ht
*channel_ht
;
625 * Flag specifying if the local array of FDs needs update in the
626 * poll function. Protected by consumer_data.lock.
628 unsigned int need_update
;
629 enum lttng_consumer_type type
;
632 * Relayd socket(s) hashtable indexed by network sequence number. Each
633 * stream has an index which associate the right relayd socket to use.
635 struct lttng_ht
*relayd_ht
;
638 * This hash table contains all streams (metadata and data) indexed by
639 * session id. In other words, the ht is indexed by session id and each
640 * bucket contains the list of associated streams.
642 * This HT uses the "node_session_id" of the consumer stream.
644 struct lttng_ht
*stream_list_ht
;
647 * This HT uses the "node_channel_id" of the consumer stream.
649 struct lttng_ht
*stream_per_chan_id_ht
;
653 * Set to nonzero when the consumer is exiting. Updated by signal
654 * handler and thread exit, read by threads.
656 extern int consumer_quit
;
659 * Set to nonzero when the consumer is exiting. Updated by signal
660 * handler and thread exit, read by threads.
662 extern int consumer_quit
;
664 /* Flag used to temporarily pause data consumption from testpoints. */
665 extern int data_consumption_paused
;
668 * Init consumer data structures.
670 int lttng_consumer_init(void);
673 * Set the error socket for communication with a session daemon.
675 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
679 * Set the command socket path for communication with a session daemon.
681 void lttng_consumer_set_command_sock_path(
682 struct lttng_consumer_local_data
*ctx
, char *sock
);
685 * Send return code to session daemon.
687 * Returns the return code of sendmsg : the number of bytes transmitted or -1
690 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
693 * Called from signal handler to ensure a clean exit.
695 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
698 * Cleanup the daemon's socket on exit.
700 void lttng_consumer_cleanup(void);
703 * Poll on the should_quit pipe and the command socket return -1 on error and
704 * should exit, 0 if data is available on the command socket
706 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
709 * Copy the fields from the channel that need to be accessed in read-only
710 * directly from the stream.
712 void consumer_stream_copy_ro_channel_values(struct lttng_consumer_stream
*stream
,
713 struct lttng_consumer_channel
*channel
);
715 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
717 enum lttng_consumer_stream_state state
,
718 const char *channel_name
,
725 enum consumer_channel_type type
,
726 unsigned int monitor
);
727 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
729 const char *pathname
,
734 enum lttng_event_output output
,
735 uint64_t tracefile_size
,
736 uint64_t tracefile_count
,
737 uint64_t session_id_per_pid
,
738 unsigned int monitor
,
739 unsigned int live_timer_interval
,
740 const char *root_shm_path
,
741 const char *shm_path
);
742 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
743 struct lttng_ht
*ht
);
744 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
745 struct lttng_ht
*ht
);
746 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
747 struct lttng_consumer_local_data
*ctx
);
748 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
750 /* lttng-relayd consumer command */
751 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
752 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
753 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
754 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
755 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
756 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
758 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
760 struct lttng_consumer_local_data
*lttng_consumer_create(
761 enum lttng_consumer_type type
,
762 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
763 struct lttng_consumer_local_data
*ctx
),
764 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
765 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
766 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
767 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
768 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
769 struct lttng_consumer_local_data
*ctx
,
770 struct lttng_consumer_stream
*stream
, unsigned long len
,
771 unsigned long padding
,
772 struct ctf_packet_index
*index
);
773 ssize_t
lttng_consumer_on_read_subbuffer_splice(
774 struct lttng_consumer_local_data
*ctx
,
775 struct lttng_consumer_stream
*stream
, unsigned long len
,
776 unsigned long padding
,
777 struct ctf_packet_index
*index
);
778 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
779 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
780 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
782 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
784 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
785 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
786 void *consumer_thread_metadata_poll(void *data
);
787 void *consumer_thread_data_poll(void *data
);
788 void *consumer_thread_sessiond_poll(void *data
);
789 void *consumer_thread_channel_poll(void *data
);
790 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
791 int sock
, struct pollfd
*consumer_sockpoll
);
793 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
794 struct lttng_consumer_local_data
*ctx
);
795 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
796 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
797 struct lttng_consumer_local_data
*ctx
, int sock
,
798 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
799 uint64_t sessiond_id
, uint64_t relayd_session_id
);
800 void consumer_flag_relayd_for_destroy(
801 struct consumer_relayd_sock_pair
*relayd
);
802 int consumer_data_pending(uint64_t id
);
803 int consumer_send_status_msg(int sock
, int ret_code
);
804 int consumer_send_status_channel(int sock
,
805 struct lttng_consumer_channel
*channel
);
806 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
808 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
809 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
810 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
811 uint64_t max_sb_size
);
812 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
813 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
814 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
815 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
816 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
817 int lttng_consumer_rotate_channel(uint64_t key
, char *path
,
818 uint64_t relayd_id
, uint32_t metadata
,
819 struct lttng_consumer_local_data
*ctx
);
820 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
821 struct lttng_consumer_stream
*stream
);
822 int lttng_consumer_rotate_ready_streams(uint64_t key
,
823 struct lttng_consumer_local_data
*ctx
);
825 #endif /* LIB_CONSUMER_H */