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
,
67 LTTNG_CONSUMER_ROTATE_RENAME
,
68 LTTNG_CONSUMER_ROTATE_PENDING_RELAY
,
72 /* State of each fd in consumer */
73 enum lttng_consumer_stream_state
{
74 LTTNG_CONSUMER_ACTIVE_STREAM
,
75 LTTNG_CONSUMER_PAUSE_STREAM
,
76 LTTNG_CONSUMER_DELETE_STREAM
,
79 enum lttng_consumer_type
{
80 LTTNG_CONSUMER_UNKNOWN
= 0,
81 LTTNG_CONSUMER_KERNEL
,
86 enum consumer_endpoint_status
{
87 CONSUMER_ENDPOINT_ACTIVE
,
88 CONSUMER_ENDPOINT_INACTIVE
,
91 enum consumer_channel_output
{
92 CONSUMER_CHANNEL_MMAP
= 0,
93 CONSUMER_CHANNEL_SPLICE
= 1,
96 enum consumer_channel_type
{
97 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
98 CONSUMER_CHANNEL_TYPE_DATA
= 1,
101 extern struct lttng_consumer_global_data consumer_data
;
104 struct cds_list_head head
;
109 struct consumer_metadata_cache
;
111 struct lttng_consumer_channel
{
112 /* HT node used for consumer_data.channel_ht */
113 struct lttng_ht_node_u64 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. */
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
;
125 /* Channel trace file path name. */
126 char pathname
[PATH_MAX
];
128 char name
[LTTNG_SYMBOL_NAME_LEN
];
129 /* UID and GID of the session owning this channel. */
132 /* Relayd id of the channel. -1ULL if it does not apply. */
135 * Number of streams NOT initialized yet. This is used in order to not
136 * delete this channel if streams are getting initialized.
138 unsigned int nb_init_stream_left
;
139 /* Output type (mmap or splice). */
140 enum consumer_channel_output output
;
141 /* Channel type for stream */
142 enum consumer_channel_type type
;
145 uid_t ust_app_uid
; /* Application UID. */
146 struct ustctl_consumer_channel
*uchan
;
147 unsigned char uuid
[UUID_STR_LEN
];
149 * Temporary stream list used to store the streams once created and waiting
150 * to be sent to the session daemon by receiving the
151 * LTTNG_CONSUMER_GET_CHANNEL.
153 struct stream_list streams
;
156 * Set if the channel is metadata. We keep a reference to the stream
157 * because we have to flush data once pushed by the session daemon. For a
158 * regular channel, this is always set to NULL.
160 struct lttng_consumer_stream
*metadata_stream
;
164 /* Node within channel thread ht */
165 struct lttng_ht_node_u64 wait_fd_node
;
167 /* Metadata cache is metadata channel */
168 struct consumer_metadata_cache
*metadata_cache
;
170 /* For UST metadata periodical flush */
171 int switch_timer_enabled
;
172 timer_t switch_timer
;
173 int switch_timer_error
;
175 /* For the live mode */
176 int live_timer_enabled
;
178 int live_timer_error
;
180 /* For channel monitoring timer. */
181 int monitor_timer_enabled
;
182 timer_t monitor_timer
;
184 /* On-disk circular buffer */
185 uint64_t tracefile_size
;
186 uint64_t tracefile_count
;
188 * Monitor or not the streams of this channel meaning this indicates if the
189 * streams should be sent to the data/metadata thread or added to the no
190 * monitor list of the channel.
192 unsigned int monitor
;
197 * This lock protects against concurrent update of channel.
199 * This is nested INSIDE the consumer data lock.
200 * This is nested OUTSIDE the channel timer lock.
201 * This is nested OUTSIDE the metadata cache lock.
202 * This is nested OUTSIDE stream lock.
203 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
205 pthread_mutex_t lock
;
208 * Channel teardown lock.
210 * This lock protect against teardown of channel. It is _never_
211 * taken by the timer handler.
213 * This is nested INSIDE the consumer data lock.
214 * This is nested INSIDE the channel lock.
215 * This is nested OUTSIDE the metadata cache lock.
216 * This is nested OUTSIDE stream lock.
217 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
219 pthread_mutex_t timer_lock
;
221 /* Timer value in usec for live streaming. */
222 unsigned int live_timer_interval
;
226 char root_shm_path
[PATH_MAX
];
227 char shm_path
[PATH_MAX
];
228 /* Total number of discarded events for that channel. */
229 uint64_t discarded_events
;
230 /* Total number of missed packets due to overwriting (overwrite). */
231 uint64_t lost_packets
;
233 bool streams_sent_to_relayd
;
236 * Account how many streams are waiting for their rotation to be
237 * complete. When this number reaches 0, we inform the session
238 * daemon that this channel has finished its rotation.
240 uint64_t nr_stream_rotate_pending
;
243 * The chunk id where we currently write the data. This value is sent
244 * to the relay when we add a stream and when a stream rotates. This
245 * allows to keep track of where each stream on the relay is writing.
247 uint64_t current_chunk_id
;
251 * Internal representation of the streams, sessiond_key is used to identify
254 struct lttng_consumer_stream
{
255 /* HT node used by the data_ht and metadata_ht */
256 struct lttng_ht_node_u64 node
;
257 /* stream indexed per channel key node */
258 struct lttng_ht_node_u64 node_channel_id
;
259 /* HT node used in consumer_data.stream_list_ht */
260 struct lttng_ht_node_u64 node_session_id
;
261 /* Pointer to associated channel. */
262 struct lttng_consumer_channel
*chan
;
264 /* Key by which the stream is indexed for 'node'. */
267 * File descriptor of the data output file. This can be either a file or a
268 * socket fd for relayd streaming.
270 int out_fd
; /* output file to write the data */
271 /* Write position in the output file descriptor */
273 /* Amount of bytes written to the output */
274 uint64_t output_written
;
275 enum lttng_consumer_stream_state state
;
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 * metadata_timer_lock protects flags waiting_on_metadata and
301 * missed_metadata_flush.
303 pthread_mutex_t metadata_timer_lock
;
305 * Flag set when awaiting metadata to be pushed. Used in the
306 * timer thread to skip waiting on the stream (and stream lock) to
307 * ensure we can proceed to flushing metadata in live mode.
309 bool waiting_on_metadata
;
310 /* Raised when a timer misses a metadata flush. */
311 bool missed_metadata_flush
;
313 enum lttng_event_output output
;
314 /* Maximum subbuffer size. */
315 unsigned long max_sb_size
;
318 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
319 * used for the mmap base and offset.
322 unsigned long mmap_len
;
327 /* UID/GID of the user owning the session to which stream belongs */
330 /* Network sequence number. Indicating on which relayd socket it goes. */
331 uint64_t net_seq_idx
;
333 * Indicate if this stream was successfully sent to a relayd. This is set
334 * after the refcount of the relayd is incremented and is checked when the
335 * stream is closed before decrementing the refcount in order to avoid an
338 unsigned int sent_to_relayd
;
340 /* Identify if the stream is the metadata */
341 unsigned int metadata_flag
;
343 * Last known metadata version, reset the metadata file in case
346 uint64_t metadata_version
;
347 /* Used when the stream is set for network streaming */
348 uint64_t relayd_stream_id
;
350 * When sending a stream packet to a relayd, this number is used to track
351 * the packet sent by the consumer and seen by the relayd. When sending the
352 * data header to the relayd, this number is sent and if the transmission
353 * was successful, it is incremented.
355 * Even if the full data is not fully transmitted it won't matter since
356 * only two possible error can happen after that where either the relayd
357 * died or a read error is detected on the stream making this value useless
360 * This value SHOULD be read/updated atomically or with the lock acquired.
362 uint64_t next_net_seq_num
;
364 * Lock to use the stream FDs since they are used between threads.
366 * This is nested INSIDE the consumer_data lock.
367 * This is nested INSIDE the channel lock.
368 * This is nested INSIDE the channel timer lock.
369 * This is nested OUTSIDE the metadata cache lock.
370 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
372 pthread_mutex_t lock
;
373 /* Tracing session id */
376 * Indicates if the stream end point is still active or not (network
377 * streaming or local file system). The thread "owning" the stream is
378 * handling this status and can be notified of a state change through the
379 * consumer data appropriate pipe.
381 enum consumer_endpoint_status endpoint_status
;
382 /* Stream name. Format is: <channel_name>_<cpu_number> */
383 char name
[LTTNG_SYMBOL_NAME_LEN
];
384 /* Internal state of libustctl. */
385 struct ustctl_consumer_stream
*ustream
;
386 struct cds_list_head send_node
;
387 /* On-disk circular buffer */
388 uint64_t tracefile_size_current
;
389 uint64_t tracefile_count_current
;
391 * Monitor or not the streams of this channel meaning this indicates if the
392 * streams should be sent to the data/metadata thread or added to the no
393 * monitor list of the channel.
395 unsigned int monitor
;
397 * Indicate if the stream is globally visible meaning that it has been
398 * added to the multiple hash tables. If *not* set, NO lock should be
399 * acquired in the destroy path.
401 unsigned int globally_visible
;
403 * Pipe to wake up the metadata poll thread when the UST metadata
406 int ust_metadata_poll_pipe
[2];
408 * How much metadata was read from the metadata cache and sent
411 uint64_t ust_metadata_pushed
;
413 * Copy of the last discarded event value to detect the overflow of
416 uint64_t last_discarded_events
;
417 /* Copy of the sequence number of the last packet extracted. */
418 uint64_t last_sequence_number
;
420 * Index file object of the index file for this stream.
422 struct lttng_index_file
*index_file
;
425 * Local pipe to extract data when using splice.
430 * Rendez-vous point between data and metadata stream in live mode.
432 pthread_cond_t metadata_rdv
;
433 pthread_mutex_t metadata_rdv_lock
;
436 * rotate_position represents the position in the ring-buffer that has to
437 * be flushed to disk to complete the ongoing rotation. When that position
438 * is reached, this tracefile can be closed and a new one is created in
439 * channel_read_only_attributes.path.
441 unsigned long rotate_position
;
444 * Read-only copies of channel values. We cannot safely access the
445 * channel from a stream, so we need to have a local copy of these
446 * fields in the stream object. These fields should be removed from
447 * the stream objects when we introduce refcounting.
450 char path
[LTTNG_PATH_MAX
];
451 uint64_t tracefile_size
;
452 } channel_read_only_attributes
;
455 * Flag to inform the data or metadata thread that a stream is
456 * ready to be rotated.
460 /* Indicate if the stream still has some data to be read. */
461 unsigned int has_data
:1;
463 * Inform the consumer or relay to reset the metadata
464 * file before writing in it (regeneration).
466 unsigned int reset_metadata_flag
:1;
470 * Internal representation of a relayd socket pair.
472 struct consumer_relayd_sock_pair
{
473 /* Network sequence number. */
474 uint64_t net_seq_idx
;
475 /* Number of stream associated with this relayd */
476 unsigned int refcount
;
479 * This flag indicates whether or not we should destroy this object. The
480 * destruction should ONLY occurs when this flag is set and the refcount is
483 unsigned int destroy_flag
;
486 * Mutex protecting the control socket to avoid out of order packets
487 * between threads sending data to the relayd. Since metadata data is sent
488 * over that socket, at least two sendmsg() are needed (header + data)
489 * creating a race for packets to overlap between threads using it.
491 * This is nested INSIDE the consumer_data lock.
492 * This is nested INSIDE the stream lock.
494 pthread_mutex_t ctrl_sock_mutex
;
496 /* Control socket. Command and metadata are passed over it */
497 struct lttcomm_relayd_sock control_sock
;
500 * We don't need a mutex at this point since we only splice or write single
501 * large chunk of data with a header appended at the begining. Moreover,
502 * this socket is for now only used in a single thread.
504 struct lttcomm_relayd_sock data_sock
;
505 struct lttng_ht_node_u64 node
;
507 /* Session id on both sides for the sockets. */
508 uint64_t relayd_session_id
;
509 uint64_t sessiond_session_id
;
513 * UST consumer local data to the program. One or more instance per
516 struct lttng_consumer_local_data
{
518 * Function to call when data is available on a buffer.
519 * Returns the number of bytes read, or negative error value.
521 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
522 struct lttng_consumer_local_data
*ctx
);
524 * function to call when we receive a new channel, it receives a
525 * newly allocated channel, depending on the return code of this
526 * function, the new channel will be handled by the application
530 * > 0 (success, FD is kept by application)
531 * == 0 (success, FD is left to library)
534 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
536 * function to call when we receive a new stream, it receives a
537 * newly allocated stream, depending on the return code of this
538 * function, the new stream will be handled by the application
542 * > 0 (success, FD is kept by application)
543 * == 0 (success, FD is left to library)
546 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
548 * function to call when a stream is getting updated by the session
549 * daemon, this function receives the sessiond key and the new
550 * state, depending on the return code of this function the
551 * update of state for the stream is handled by the application
555 * > 0 (success, FD is kept by application)
556 * == 0 (success, FD is left to library)
559 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
560 enum lttng_consumer_type type
;
561 /* socket to communicate errors with sessiond */
562 int consumer_error_socket
;
563 /* socket to ask metadata to sessiond. */
564 int consumer_metadata_socket
;
566 * Protect consumer_metadata_socket.
568 * This is nested OUTSIDE the metadata cache lock.
570 pthread_mutex_t metadata_socket_lock
;
571 /* socket to exchange commands with sessiond */
572 char *consumer_command_sock_path
;
573 /* communication with splice */
574 int consumer_channel_pipe
[2];
575 /* Data stream poll thread pipe. To transfer data stream to the thread */
576 struct lttng_pipe
*consumer_data_pipe
;
579 * Data thread use that pipe to catch wakeup from read subbuffer that
580 * detects that there is still data to be read for the stream encountered.
581 * Before doing so, the stream is flagged to indicate that there is still
584 * Both pipes (read/write) are owned and used inside the data thread.
586 struct lttng_pipe
*consumer_wakeup_pipe
;
587 /* Indicate if the wakeup thread has been notified. */
588 unsigned int has_wakeup
:1;
590 /* to let the signal handler wake up the fd receiver thread */
591 int consumer_should_quit
[2];
592 /* Metadata poll thread pipe. Transfer metadata stream to it */
593 struct lttng_pipe
*consumer_metadata_pipe
;
595 * Pipe used by the channel monitoring timers to provide state samples
596 * to the session daemon (write-only).
598 int channel_monitor_pipe
;
600 * Pipe used to inform the session daemon that a stream has finished
601 * its rotation (write-only).
603 int channel_rotate_pipe
;
607 * Library-level data. One instance per process.
609 struct lttng_consumer_global_data
{
611 * At this time, this lock is used to ensure coherence between the count
612 * and number of element in the hash table. It's also a protection for
613 * concurrent read/write between threads.
615 * This is nested OUTSIDE the stream lock.
616 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
618 pthread_mutex_t lock
;
621 * Number of streams in the data stream hash table declared outside.
622 * Protected by consumer_data.lock.
626 /* Channel hash table protected by consumer_data.lock. */
627 struct lttng_ht
*channel_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
;
657 * Set to nonzero when the consumer is exiting. Updated by signal
658 * handler and thread exit, read by threads.
660 extern int consumer_quit
;
663 * Set to nonzero when the consumer is exiting. Updated by signal
664 * handler and thread exit, read by threads.
666 extern int consumer_quit
;
668 /* Flag used to temporarily pause data consumption from testpoints. */
669 extern int data_consumption_paused
;
672 * Init consumer data structures.
674 int lttng_consumer_init(void);
677 * Set the error socket for communication with a session daemon.
679 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
683 * Set the command socket path for communication with a session daemon.
685 void lttng_consumer_set_command_sock_path(
686 struct lttng_consumer_local_data
*ctx
, char *sock
);
689 * Send return code to session daemon.
691 * Returns the return code of sendmsg : the number of bytes transmitted or -1
694 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
697 * Called from signal handler to ensure a clean exit.
699 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
702 * Cleanup the daemon's socket on exit.
704 void lttng_consumer_cleanup(void);
707 * Poll on the should_quit pipe and the command socket return -1 on error and
708 * should exit, 0 if data is available on the command socket
710 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
713 * Copy the fields from the channel that need to be accessed (read-only)
714 * directly from the stream.
716 void consumer_stream_update_channel_attributes(
717 struct lttng_consumer_stream
*stream
,
718 struct lttng_consumer_channel
*channel
);
720 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
722 enum lttng_consumer_stream_state state
,
723 const char *channel_name
,
730 enum consumer_channel_type type
,
731 unsigned int monitor
);
732 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
734 const char *pathname
,
739 enum lttng_event_output output
,
740 uint64_t tracefile_size
,
741 uint64_t tracefile_count
,
742 uint64_t session_id_per_pid
,
743 unsigned int monitor
,
744 unsigned int live_timer_interval
,
745 const char *root_shm_path
,
746 const char *shm_path
);
747 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
748 struct lttng_ht
*ht
);
749 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
750 struct lttng_ht
*ht
);
751 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
752 struct lttng_consumer_local_data
*ctx
);
753 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
755 /* lttng-relayd consumer command */
756 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
757 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
758 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
759 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
760 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
761 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
763 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
765 struct lttng_consumer_local_data
*lttng_consumer_create(
766 enum lttng_consumer_type type
,
767 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
768 struct lttng_consumer_local_data
*ctx
),
769 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
770 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
771 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
772 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
773 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
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 ssize_t
lttng_consumer_on_read_subbuffer_splice(
779 struct lttng_consumer_local_data
*ctx
,
780 struct lttng_consumer_stream
*stream
, unsigned long len
,
781 unsigned long padding
,
782 struct ctf_packet_index
*index
);
783 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
784 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
785 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
787 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
789 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
790 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
791 void *consumer_thread_metadata_poll(void *data
);
792 void *consumer_thread_data_poll(void *data
);
793 void *consumer_thread_sessiond_poll(void *data
);
794 void *consumer_thread_channel_poll(void *data
);
795 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
796 int sock
, struct pollfd
*consumer_sockpoll
);
798 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
799 struct lttng_consumer_local_data
*ctx
);
800 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
801 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
802 struct lttng_consumer_local_data
*ctx
, int sock
,
803 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
804 uint64_t sessiond_id
, uint64_t relayd_session_id
);
805 void consumer_flag_relayd_for_destroy(
806 struct consumer_relayd_sock_pair
*relayd
);
807 int consumer_data_pending(uint64_t id
);
808 int consumer_send_status_msg(int sock
, int ret_code
);
809 int consumer_send_status_channel(int sock
,
810 struct lttng_consumer_channel
*channel
);
811 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
813 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
814 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
815 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
816 uint64_t max_sb_size
);
817 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
818 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
819 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
820 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
821 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
822 int lttng_consumer_rotate_channel(uint64_t key
, const char *path
,
823 uint64_t relayd_id
, uint32_t metadata
,
824 uint64_t new_chunk_id
, struct lttng_consumer_local_data
*ctx
);
825 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
826 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
827 struct lttng_consumer_stream
*stream
, bool *rotated
);
828 int lttng_consumer_rotate_ready_streams(uint64_t key
,
829 struct lttng_consumer_local_data
*ctx
);
830 int lttng_consumer_rotate_rename(const char *current_path
, const char *new_path
,
831 uid_t uid
, gid_t gid
, uint64_t relayd_id
);
832 int lttng_consumer_rotate_pending_relay( uint64_t session_id
,
833 uint64_t relayd_id
, uint64_t chunk_id
);
834 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
835 int lttng_consumer_mkdir(const char *path
, uid_t uid
, gid_t gid
,
838 #endif /* LIB_CONSUMER_H */