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
,
70 /* State of each fd in consumer */
71 enum lttng_consumer_stream_state
{
72 LTTNG_CONSUMER_ACTIVE_STREAM
,
73 LTTNG_CONSUMER_PAUSE_STREAM
,
74 LTTNG_CONSUMER_DELETE_STREAM
,
77 enum lttng_consumer_type
{
78 LTTNG_CONSUMER_UNKNOWN
= 0,
79 LTTNG_CONSUMER_KERNEL
,
84 enum consumer_endpoint_status
{
85 CONSUMER_ENDPOINT_ACTIVE
,
86 CONSUMER_ENDPOINT_INACTIVE
,
89 enum consumer_channel_output
{
90 CONSUMER_CHANNEL_MMAP
= 0,
91 CONSUMER_CHANNEL_SPLICE
= 1,
94 enum consumer_channel_type
{
95 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
96 CONSUMER_CHANNEL_TYPE_DATA
= 1,
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 /* HT node used for consumer_data.channel_ht */
111 struct lttng_ht_node_u64 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. */
119 * Session id when requesting metadata to the session daemon for
120 * a session with per-PID buffers.
122 uint64_t session_id_per_pid
;
123 /* Channel trace file path name. */
124 char pathname
[PATH_MAX
];
126 char name
[LTTNG_SYMBOL_NAME_LEN
];
127 /* UID and GID of the session owning this channel. */
130 /* Relayd id of the channel. -1ULL if it does not apply. */
133 * Number of streams NOT initialized yet. This is used in order to not
134 * delete this channel if streams are getting initialized.
136 unsigned int nb_init_stream_left
;
137 /* Output type (mmap or splice). */
138 enum consumer_channel_output output
;
139 /* Channel type for stream */
140 enum consumer_channel_type type
;
143 uid_t ust_app_uid
; /* Application UID. */
144 struct ustctl_consumer_channel
*uchan
;
145 unsigned char uuid
[UUID_STR_LEN
];
147 * Temporary stream list used to store the streams once created and waiting
148 * to be sent to the session daemon by receiving the
149 * LTTNG_CONSUMER_GET_CHANNEL.
151 struct stream_list streams
;
154 * Set if the channel is metadata. We keep a reference to the stream
155 * because we have to flush data once pushed by the session daemon. For a
156 * regular channel, this is always set to NULL.
158 struct lttng_consumer_stream
*metadata_stream
;
162 /* Node within channel thread ht */
163 struct lttng_ht_node_u64 wait_fd_node
;
165 /* Metadata cache is metadata channel */
166 struct consumer_metadata_cache
*metadata_cache
;
168 /* For UST metadata periodical flush */
169 int switch_timer_enabled
;
170 timer_t switch_timer
;
171 int switch_timer_error
;
173 /* For the live mode */
174 int live_timer_enabled
;
176 int live_timer_error
;
178 /* For channel monitoring timer. */
179 int monitor_timer_enabled
;
180 timer_t monitor_timer
;
182 /* On-disk circular buffer */
183 uint64_t tracefile_size
;
184 uint64_t tracefile_count
;
186 * Monitor or not the streams of this channel meaning this indicates if the
187 * streams should be sent to the data/metadata thread or added to the no
188 * monitor list of the channel.
190 unsigned int monitor
;
195 * This lock protects against concurrent update of channel.
197 * This is nested INSIDE the consumer data lock.
198 * This is nested OUTSIDE the channel timer lock.
199 * This is nested OUTSIDE the metadata cache lock.
200 * This is nested OUTSIDE stream lock.
201 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
203 pthread_mutex_t lock
;
206 * Channel teardown lock.
208 * This lock protect against teardown of channel. It is _never_
209 * taken by the timer handler.
211 * This is nested INSIDE the consumer data lock.
212 * This is nested INSIDE the channel lock.
213 * This is nested OUTSIDE the metadata cache lock.
214 * This is nested OUTSIDE stream lock.
215 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
217 pthread_mutex_t timer_lock
;
219 /* Timer value in usec for live streaming. */
220 unsigned int live_timer_interval
;
224 char root_shm_path
[PATH_MAX
];
225 char shm_path
[PATH_MAX
];
226 /* Total number of discarded events for that channel. */
227 uint64_t discarded_events
;
228 /* Total number of missed packets due to overwriting (overwrite). */
229 uint64_t lost_packets
;
231 bool streams_sent_to_relayd
;
234 * Account how many streams are waiting for their rotation to be
235 * complete. When this number reaches 0, we inform the session
236 * daemon that this channel has finished its rotation.
238 uint64_t nr_stream_rotate_pending
;
242 * Internal representation of the streams, sessiond_key is used to identify
245 struct lttng_consumer_stream
{
246 /* HT node used by the data_ht and metadata_ht */
247 struct lttng_ht_node_u64 node
;
248 /* stream indexed per channel key node */
249 struct lttng_ht_node_u64 node_channel_id
;
250 /* HT node used in consumer_data.stream_list_ht */
251 struct lttng_ht_node_u64 node_session_id
;
252 /* Pointer to associated channel. */
253 struct lttng_consumer_channel
*chan
;
255 /* Key by which the stream is indexed for 'node'. */
258 * File descriptor of the data output file. This can be either a file or a
259 * socket fd for relayd streaming.
261 int out_fd
; /* output file to write the data */
262 /* Write position in the output file descriptor */
264 /* Amount of bytes written to the output */
265 uint64_t output_written
;
266 enum lttng_consumer_stream_state state
;
269 int hangup_flush_done
;
272 * Whether the stream is in a "complete" state (e.g. it does not have a
273 * partially written sub-buffer.
275 * Initialized to "false" on stream creation (first packet is empty).
277 * The various transitions of the quiescent state are:
278 * - On "start" tracing: set to false, since the stream is not
280 * - On "stop" tracing: if !quiescent -> flush FINAL (update
281 * timestamp_end), and set to true; the stream has entered a
282 * complete/quiescent state.
283 * - On "destroy" or stream/application hang-up: if !quiescent ->
284 * flush FINAL, and set to true.
286 * NOTE: Update and read are protected by the stream lock.
291 * metadata_timer_lock protects flags waiting_on_metadata and
292 * missed_metadata_flush.
294 pthread_mutex_t metadata_timer_lock
;
296 * Flag set when awaiting metadata to be pushed. Used in the
297 * timer thread to skip waiting on the stream (and stream lock) to
298 * ensure we can proceed to flushing metadata in live mode.
300 bool waiting_on_metadata
;
301 /* Raised when a timer misses a metadata flush. */
302 bool missed_metadata_flush
;
304 enum lttng_event_output output
;
305 /* Maximum subbuffer size. */
306 unsigned long max_sb_size
;
309 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
310 * used for the mmap base and offset.
313 unsigned long mmap_len
;
318 /* UID/GID of the user owning the session to which stream belongs */
321 /* Network sequence number. Indicating on which relayd socket it goes. */
322 uint64_t net_seq_idx
;
324 * Indicate if this stream was successfully sent to a relayd. This is set
325 * after the refcount of the relayd is incremented and is checked when the
326 * stream is closed before decrementing the refcount in order to avoid an
329 unsigned int sent_to_relayd
;
331 /* Identify if the stream is the metadata */
332 unsigned int metadata_flag
;
334 * Last known metadata version, reset the metadata file in case
337 uint64_t metadata_version
;
338 /* Used when the stream is set for network streaming */
339 uint64_t relayd_stream_id
;
341 * When sending a stream packet to a relayd, this number is used to track
342 * the packet sent by the consumer and seen by the relayd. When sending the
343 * data header to the relayd, this number is sent and if the transmission
344 * was successful, it is incremented.
346 * Even if the full data is not fully transmitted it won't matter since
347 * only two possible error can happen after that where either the relayd
348 * died or a read error is detected on the stream making this value useless
351 * This value SHOULD be read/updated atomically or with the lock acquired.
353 uint64_t next_net_seq_num
;
355 * Lock to use the stream FDs since they are used between threads.
357 * This is nested INSIDE the consumer_data lock.
358 * This is nested INSIDE the channel lock.
359 * This is nested INSIDE the channel timer lock.
360 * This is nested OUTSIDE the metadata cache lock.
361 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
363 pthread_mutex_t lock
;
364 /* Tracing session id */
367 * Indicates if the stream end point is still active or not (network
368 * streaming or local file system). The thread "owning" the stream is
369 * handling this status and can be notified of a state change through the
370 * consumer data appropriate pipe.
372 enum consumer_endpoint_status endpoint_status
;
373 /* Stream name. Format is: <channel_name>_<cpu_number> */
374 char name
[LTTNG_SYMBOL_NAME_LEN
];
375 /* Internal state of libustctl. */
376 struct ustctl_consumer_stream
*ustream
;
377 struct cds_list_head send_node
;
378 /* On-disk circular buffer */
379 uint64_t tracefile_size_current
;
380 uint64_t tracefile_count_current
;
382 * Monitor or not the streams of this channel meaning this indicates if the
383 * streams should be sent to the data/metadata thread or added to the no
384 * monitor list of the channel.
386 unsigned int monitor
;
388 * Indicate if the stream is globally visible meaning that it has been
389 * added to the multiple hash tables. If *not* set, NO lock should be
390 * acquired in the destroy path.
392 unsigned int globally_visible
;
394 * Pipe to wake up the metadata poll thread when the UST metadata
397 int ust_metadata_poll_pipe
[2];
399 * How much metadata was read from the metadata cache and sent
402 uint64_t ust_metadata_pushed
;
404 * Copy of the last discarded event value to detect the overflow of
407 uint64_t last_discarded_events
;
408 /* Copy of the sequence number of the last packet extracted. */
409 uint64_t last_sequence_number
;
411 * Index file object of the index file for this stream.
413 struct lttng_index_file
*index_file
;
416 * Local pipe to extract data when using splice.
421 * Rendez-vous point between data and metadata stream in live mode.
423 pthread_cond_t metadata_rdv
;
424 pthread_mutex_t metadata_rdv_lock
;
427 * If rotate_position != 0, when we reach this position in the
428 * ring-buffer, close this tracefile and create a new one in
431 uint64_t rotate_position
;
434 * Read-only copies of channel values. We cannot safely access the
435 * channel from a stream, so we need to have a local copy of these
436 * fields in the stream object. These fields should be removed from
437 * the stream objects when we introduce refcounting.
439 char channel_ro_pathname
[PATH_MAX
];
440 uint64_t channel_ro_tracefile_size
;
443 * If rotate_ready is set to 1, rotate the stream the next time data
444 * need to be extracted, regardless of the rotate_position. This is
445 * used if all the metadata has been consumed when we rotate. In this
446 * case, the snapshot of the positions returns -EAGAIN and we cannot
447 * use the produced/consumed positions as reference.
449 unsigned int rotate_ready
:1;
451 * Flag set to 1 if the stream just got rotated. This is used to
452 * perform actions on the channel after a rotation without needing
453 * to nest the channel lock inside the stream lock.
455 unsigned int rotated
:1;
457 /* Indicate if the stream still has some data to be read. */
458 unsigned int has_data
:1;
460 * Inform the consumer or relay to reset the metadata
461 * file before writing in it (regeneration).
463 unsigned int reset_metadata_flag
:1;
467 * Internal representation of a relayd socket pair.
469 struct consumer_relayd_sock_pair
{
470 /* Network sequence number. */
471 uint64_t net_seq_idx
;
472 /* Number of stream associated with this relayd */
473 unsigned int refcount
;
476 * This flag indicates whether or not we should destroy this object. The
477 * destruction should ONLY occurs when this flag is set and the refcount is
480 unsigned int destroy_flag
;
483 * Mutex protecting the control socket to avoid out of order packets
484 * between threads sending data to the relayd. Since metadata data is sent
485 * over that socket, at least two sendmsg() are needed (header + data)
486 * creating a race for packets to overlap between threads using it.
488 * This is nested INSIDE the consumer_data lock.
489 * This is nested INSIDE the stream lock.
491 pthread_mutex_t ctrl_sock_mutex
;
493 /* Control socket. Command and metadata are passed over it */
494 struct lttcomm_relayd_sock control_sock
;
497 * We don't need a mutex at this point since we only splice or write single
498 * large chunk of data with a header appended at the begining. Moreover,
499 * this socket is for now only used in a single thread.
501 struct lttcomm_relayd_sock data_sock
;
502 struct lttng_ht_node_u64 node
;
504 /* Session id on both sides for the sockets. */
505 uint64_t relayd_session_id
;
506 uint64_t sessiond_session_id
;
510 * UST consumer local data to the program. One or more instance per
513 struct lttng_consumer_local_data
{
515 * Function to call when data is available on a buffer.
516 * Returns the number of bytes read, or negative error value.
518 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
519 struct lttng_consumer_local_data
*ctx
);
521 * function to call when we receive a new channel, it receives a
522 * newly allocated channel, depending on the return code of this
523 * function, the new channel will be handled by the application
527 * > 0 (success, FD is kept by application)
528 * == 0 (success, FD is left to library)
531 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
533 * function to call when we receive a new stream, it receives a
534 * newly allocated stream, depending on the return code of this
535 * function, the new stream will be handled by the application
539 * > 0 (success, FD is kept by application)
540 * == 0 (success, FD is left to library)
543 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
545 * function to call when a stream is getting updated by the session
546 * daemon, this function receives the sessiond key and the new
547 * state, depending on the return code of this function the
548 * update of state for the stream is handled by the application
552 * > 0 (success, FD is kept by application)
553 * == 0 (success, FD is left to library)
556 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
557 enum lttng_consumer_type type
;
558 /* socket to communicate errors with sessiond */
559 int consumer_error_socket
;
560 /* socket to ask metadata to sessiond. */
561 int consumer_metadata_socket
;
563 * Protect consumer_metadata_socket.
565 * This is nested OUTSIDE the metadata cache lock.
567 pthread_mutex_t metadata_socket_lock
;
568 /* socket to exchange commands with sessiond */
569 char *consumer_command_sock_path
;
570 /* communication with splice */
571 int consumer_channel_pipe
[2];
572 /* Data stream poll thread pipe. To transfer data stream to the thread */
573 struct lttng_pipe
*consumer_data_pipe
;
576 * Data thread use that pipe to catch wakeup from read subbuffer that
577 * detects that there is still data to be read for the stream encountered.
578 * Before doing so, the stream is flagged to indicate that there is still
581 * Both pipes (read/write) are owned and used inside the data thread.
583 struct lttng_pipe
*consumer_wakeup_pipe
;
584 /* Indicate if the wakeup thread has been notified. */
585 unsigned int has_wakeup
:1;
587 /* to let the signal handler wake up the fd receiver thread */
588 int consumer_should_quit
[2];
589 /* Metadata poll thread pipe. Transfer metadata stream to it */
590 struct lttng_pipe
*consumer_metadata_pipe
;
592 * Pipe used by the channel monitoring timers to provide state samples
593 * to the session daemon (write-only).
595 int channel_monitor_pipe
;
597 * Pipe used to inform the session daemon that a stream has finished
598 * its rotation (write-only).
600 int channel_rotate_pipe
;
604 * Library-level data. One instance per process.
606 struct lttng_consumer_global_data
{
608 * At this time, this lock is used to ensure coherence between the count
609 * and number of element in the hash table. It's also a protection for
610 * concurrent read/write between threads.
612 * This is nested OUTSIDE the stream lock.
613 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
615 pthread_mutex_t lock
;
618 * Number of streams in the data stream hash table declared outside.
619 * Protected by consumer_data.lock.
623 /* Channel hash table protected by consumer_data.lock. */
624 struct lttng_ht
*channel_ht
;
626 * Flag specifying if the local array of FDs needs update in the
627 * poll function. Protected by consumer_data.lock.
629 unsigned int need_update
;
630 enum lttng_consumer_type type
;
633 * Relayd socket(s) hashtable indexed by network sequence number. Each
634 * stream has an index which associate the right relayd socket to use.
636 struct lttng_ht
*relayd_ht
;
639 * This hash table contains all streams (metadata and data) indexed by
640 * session id. In other words, the ht is indexed by session id and each
641 * bucket contains the list of associated streams.
643 * This HT uses the "node_session_id" of the consumer stream.
645 struct lttng_ht
*stream_list_ht
;
648 * This HT uses the "node_channel_id" of the consumer stream.
650 struct lttng_ht
*stream_per_chan_id_ht
;
654 * Set to nonzero when the consumer is exiting. Updated by signal
655 * handler and thread exit, read by threads.
657 extern int consumer_quit
;
660 * Set to nonzero when the consumer is exiting. Updated by signal
661 * handler and thread exit, read by threads.
663 extern int consumer_quit
;
665 /* Flag used to temporarily pause data consumption from testpoints. */
666 extern int data_consumption_paused
;
669 * Init consumer data structures.
671 int lttng_consumer_init(void);
674 * Set the error socket for communication with a session daemon.
676 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
680 * Set the command socket path for communication with a session daemon.
682 void lttng_consumer_set_command_sock_path(
683 struct lttng_consumer_local_data
*ctx
, char *sock
);
686 * Send return code to session daemon.
688 * Returns the return code of sendmsg : the number of bytes transmitted or -1
691 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
694 * Called from signal handler to ensure a clean exit.
696 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
699 * Cleanup the daemon's socket on exit.
701 void lttng_consumer_cleanup(void);
704 * Poll on the should_quit pipe and the command socket return -1 on error and
705 * should exit, 0 if data is available on the command socket
707 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
710 * Copy the fields from the channel that need to be accessed in read-only
711 * directly from the stream.
713 void consumer_stream_copy_ro_channel_values(struct lttng_consumer_stream
*stream
,
714 struct lttng_consumer_channel
*channel
);
716 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
718 enum lttng_consumer_stream_state state
,
719 const char *channel_name
,
726 enum consumer_channel_type type
,
727 unsigned int monitor
);
728 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
730 const char *pathname
,
735 enum lttng_event_output output
,
736 uint64_t tracefile_size
,
737 uint64_t tracefile_count
,
738 uint64_t session_id_per_pid
,
739 unsigned int monitor
,
740 unsigned int live_timer_interval
,
741 const char *root_shm_path
,
742 const char *shm_path
);
743 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
744 struct lttng_ht
*ht
);
745 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
746 struct lttng_ht
*ht
);
747 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
748 struct lttng_consumer_local_data
*ctx
);
749 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
751 /* lttng-relayd consumer command */
752 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
753 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
754 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
755 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
756 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
757 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
759 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
761 struct lttng_consumer_local_data
*lttng_consumer_create(
762 enum lttng_consumer_type type
,
763 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
764 struct lttng_consumer_local_data
*ctx
),
765 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
766 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
767 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
768 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
769 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
770 struct lttng_consumer_local_data
*ctx
,
771 struct lttng_consumer_stream
*stream
, unsigned long len
,
772 unsigned long padding
,
773 struct ctf_packet_index
*index
);
774 ssize_t
lttng_consumer_on_read_subbuffer_splice(
775 struct lttng_consumer_local_data
*ctx
,
776 struct lttng_consumer_stream
*stream
, unsigned long len
,
777 unsigned long padding
,
778 struct ctf_packet_index
*index
);
779 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
780 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
781 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
783 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
785 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
786 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
787 void *consumer_thread_metadata_poll(void *data
);
788 void *consumer_thread_data_poll(void *data
);
789 void *consumer_thread_sessiond_poll(void *data
);
790 void *consumer_thread_channel_poll(void *data
);
791 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
792 int sock
, struct pollfd
*consumer_sockpoll
);
794 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
795 struct lttng_consumer_local_data
*ctx
);
796 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
797 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
798 struct lttng_consumer_local_data
*ctx
, int sock
,
799 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
800 uint64_t sessiond_id
, uint64_t relayd_session_id
);
801 void consumer_flag_relayd_for_destroy(
802 struct consumer_relayd_sock_pair
*relayd
);
803 int consumer_data_pending(uint64_t id
);
804 int consumer_send_status_msg(int sock
, int ret_code
);
805 int consumer_send_status_channel(int sock
,
806 struct lttng_consumer_channel
*channel
);
807 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
809 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
810 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
811 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
812 uint64_t max_sb_size
);
813 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
814 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
815 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
816 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
817 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
818 int lttng_consumer_rotate_channel(uint64_t key
, char *path
,
819 uint64_t relayd_id
, uint32_t metadata
,
820 struct lttng_consumer_local_data
*ctx
);
821 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
,
823 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
824 struct lttng_consumer_stream
*stream
);
825 int lttng_consumer_rotate_ready_streams(uint64_t key
,
826 struct lttng_consumer_local_data
*ctx
);
827 int lttng_consumer_rotate_rename(char *current_path
, char *new_path
,
828 uid_t uid
, gid_t gid
, uint64_t relayd_id
);
829 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
831 #endif /* LIB_CONSUMER_H */