2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2012 - David Goulet <dgoulet@efficios.com>
5 * 2018 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 2 only,
9 * as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #ifndef LIB_CONSUMER_H
22 #define LIB_CONSUMER_H
27 #include <urcu/list.h>
29 #include <lttng/lttng.h>
31 #include <common/hashtable/hashtable.h>
32 #include <common/compat/fcntl.h>
33 #include <common/compat/uuid.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35 #include <common/pipe.h>
36 #include <common/index/ctf-index.h>
38 /* Commands for consumer */
39 enum lttng_consumer_command
{
40 LTTNG_CONSUMER_ADD_CHANNEL
,
41 LTTNG_CONSUMER_ADD_STREAM
,
42 /* pause, delete, active depending on fd state */
43 LTTNG_CONSUMER_UPDATE_STREAM
,
44 /* inform the consumer to quit when all fd has hang up */
45 LTTNG_CONSUMER_STOP
, /* deprecated */
46 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
47 /* Inform the consumer to kill a specific relayd connection */
48 LTTNG_CONSUMER_DESTROY_RELAYD
,
49 /* Return to the sessiond if there is data pending for a session */
50 LTTNG_CONSUMER_DATA_PENDING
,
51 /* Consumer creates a channel and returns it to sessiond. */
52 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
53 LTTNG_CONSUMER_GET_CHANNEL
,
54 LTTNG_CONSUMER_DESTROY_CHANNEL
,
55 LTTNG_CONSUMER_PUSH_METADATA
,
56 LTTNG_CONSUMER_CLOSE_METADATA
,
57 LTTNG_CONSUMER_SETUP_METADATA
,
58 LTTNG_CONSUMER_FLUSH_CHANNEL
,
59 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
60 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
61 LTTNG_CONSUMER_STREAMS_SENT
,
62 LTTNG_CONSUMER_DISCARDED_EVENTS
,
63 LTTNG_CONSUMER_LOST_PACKETS
,
64 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
,
65 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
,
66 LTTNG_CONSUMER_ROTATE_CHANNEL
,
67 LTTNG_CONSUMER_ROTATE_RENAME
,
68 LTTNG_CONSUMER_CHECK_ROTATION_PENDING_LOCAL
,
69 LTTNG_CONSUMER_CHECK_ROTATION_PENDING_RELAY
,
71 LTTNG_CONSUMER_CLEAR_CHANNEL
,
74 /* State of each fd in consumer */
75 enum lttng_consumer_stream_state
{
76 LTTNG_CONSUMER_ACTIVE_STREAM
,
77 LTTNG_CONSUMER_PAUSE_STREAM
,
78 LTTNG_CONSUMER_DELETE_STREAM
,
81 enum lttng_consumer_type
{
82 LTTNG_CONSUMER_UNKNOWN
= 0,
83 LTTNG_CONSUMER_KERNEL
,
88 enum consumer_endpoint_status
{
89 CONSUMER_ENDPOINT_ACTIVE
,
90 CONSUMER_ENDPOINT_INACTIVE
,
93 enum consumer_channel_output
{
94 CONSUMER_CHANNEL_MMAP
= 0,
95 CONSUMER_CHANNEL_SPLICE
= 1,
98 enum consumer_channel_type
{
99 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
100 CONSUMER_CHANNEL_TYPE_DATA
= 1,
103 extern struct lttng_consumer_global_data consumer_data
;
106 struct cds_list_head head
;
111 struct consumer_metadata_cache
;
113 struct lttng_consumer_channel
{
114 /* HT node used for consumer_data.channel_ht */
115 struct lttng_ht_node_u64 node
;
116 /* Indexed key. Incremented value in the consumer. */
118 /* Number of streams referencing this channel */
120 /* Tracing session id on the session daemon side. */
123 * Session id when requesting metadata to the session daemon for
124 * a session with per-PID buffers.
126 uint64_t session_id_per_pid
;
127 /* Channel trace file path name. */
128 char pathname
[PATH_MAX
];
130 char name
[LTTNG_SYMBOL_NAME_LEN
];
131 /* UID and GID of the session owning this channel. */
134 /* Relayd id of the channel. -1ULL if it does not apply. */
137 * Number of streams NOT initialized yet. This is used in order to not
138 * delete this channel if streams are getting initialized.
140 unsigned int nb_init_stream_left
;
141 /* Output type (mmap or splice). */
142 enum consumer_channel_output output
;
143 /* Channel type for stream */
144 enum consumer_channel_type type
;
147 uid_t ust_app_uid
; /* Application UID. */
148 struct ustctl_consumer_channel
*uchan
;
149 unsigned char uuid
[UUID_STR_LEN
];
151 * Temporary stream list used to store the streams once created and waiting
152 * to be sent to the session daemon by receiving the
153 * LTTNG_CONSUMER_GET_CHANNEL.
155 struct stream_list streams
;
158 * Set if the channel is metadata. We keep a reference to the stream
159 * because we have to flush data once pushed by the session daemon. For a
160 * regular channel, this is always set to NULL.
162 struct lttng_consumer_stream
*metadata_stream
;
166 /* Node within channel thread ht */
167 struct lttng_ht_node_u64 wait_fd_node
;
169 /* Metadata cache is metadata channel */
170 struct consumer_metadata_cache
*metadata_cache
;
172 /* For UST metadata periodical flush */
173 int switch_timer_enabled
;
174 timer_t switch_timer
;
175 int switch_timer_error
;
177 /* For the live mode */
178 int live_timer_enabled
;
180 int live_timer_error
;
182 /* For channel monitoring timer. */
183 int monitor_timer_enabled
;
184 timer_t monitor_timer
;
186 /* On-disk circular buffer */
187 uint64_t tracefile_size
;
188 uint64_t tracefile_count
;
190 * Monitor or not the streams of this channel meaning this indicates if the
191 * streams should be sent to the data/metadata thread or added to the no
192 * monitor list of the channel.
194 unsigned int monitor
;
199 * This lock protects against concurrent update of channel.
201 * This is nested INSIDE the consumer data lock.
202 * This is nested OUTSIDE the channel timer lock.
203 * This is nested OUTSIDE the metadata cache lock.
204 * This is nested OUTSIDE stream lock.
205 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
207 pthread_mutex_t lock
;
210 * Channel teardown lock.
212 * This lock protect against teardown of channel. It is _never_
213 * taken by the timer handler.
215 * This is nested INSIDE the consumer data lock.
216 * This is nested INSIDE the channel lock.
217 * This is nested OUTSIDE the metadata cache lock.
218 * This is nested OUTSIDE stream lock.
219 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
221 pthread_mutex_t timer_lock
;
223 /* Timer value in usec for live streaming. */
224 unsigned int live_timer_interval
;
228 char root_shm_path
[PATH_MAX
];
229 char shm_path
[PATH_MAX
];
230 /* Total number of discarded events for that channel. */
231 uint64_t discarded_events
;
232 /* Total number of missed packets due to overwriting (overwrite). */
233 uint64_t lost_packets
;
235 bool streams_sent_to_relayd
;
238 * The chunk id where we currently write the data. This value is sent
239 * to the relay when we add a stream and when a stream rotates. This
240 * allows to keep track of where each stream on the relay is writing.
242 uint64_t current_chunk_id
;
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 /* Key by which the stream is indexed for 'node'. */
262 * File descriptor of the data output file. This can be either a file or a
263 * socket fd for relayd streaming.
265 int out_fd
; /* output file to write the data */
266 /* Write position in the output file descriptor */
268 /* Amount of bytes written to the output */
269 uint64_t output_written
;
270 enum lttng_consumer_stream_state state
;
273 int hangup_flush_done
;
276 * Whether the stream is in a "complete" state (e.g. it does not have a
277 * partially written sub-buffer.
279 * Initialized to "false" on stream creation (first packet is empty).
281 * The various transitions of the quiescent state are:
282 * - On "start" tracing: set to false, since the stream is not
284 * - On "stop" tracing: if !quiescent -> flush FINAL (update
285 * timestamp_end), and set to true; the stream has entered a
286 * complete/quiescent state.
287 * - On "destroy" or stream/application hang-up: if !quiescent ->
288 * flush FINAL, and set to true.
290 * NOTE: Update and read are protected by the stream lock.
295 * metadata_timer_lock protects flags waiting_on_metadata and
296 * missed_metadata_flush.
298 pthread_mutex_t metadata_timer_lock
;
300 * Flag set when awaiting metadata to be pushed. Used in the
301 * timer thread to skip waiting on the stream (and stream lock) to
302 * ensure we can proceed to flushing metadata in live mode.
304 bool waiting_on_metadata
;
305 /* Raised when a timer misses a metadata flush. */
306 bool missed_metadata_flush
;
308 enum lttng_event_output output
;
309 /* Maximum subbuffer size. */
310 unsigned long max_sb_size
;
313 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
314 * used for the mmap base and offset.
317 unsigned long mmap_len
;
322 /* UID/GID of the user owning the session to which stream belongs */
325 /* Network sequence number. Indicating on which relayd socket it goes. */
326 uint64_t net_seq_idx
;
328 * Indicate if this stream was successfully sent to a relayd. This is set
329 * after the refcount of the relayd is incremented and is checked when the
330 * stream is closed before decrementing the refcount in order to avoid an
333 unsigned int sent_to_relayd
;
335 /* Identify if the stream is the metadata */
336 unsigned int metadata_flag
;
338 * Last known metadata version, reset the metadata file in case
341 uint64_t metadata_version
;
342 /* Used when the stream is set for network streaming */
343 uint64_t relayd_stream_id
;
345 * When sending a stream packet to a relayd, this number is used to track
346 * the packet sent by the consumer and seen by the relayd. When sending the
347 * data header to the relayd, this number is sent and if the transmission
348 * was successful, it is incremented.
350 * Even if the full data is not fully transmitted it won't matter since
351 * only two possible error can happen after that where either the relayd
352 * died or a read error is detected on the stream making this value useless
355 * This value SHOULD be read/updated atomically or with the lock acquired.
357 uint64_t next_net_seq_num
;
359 * Lock to use the stream FDs since they are used between threads.
361 * This is nested INSIDE the consumer_data lock.
362 * This is nested INSIDE the channel lock.
363 * This is nested INSIDE the channel timer lock.
364 * This is nested OUTSIDE the metadata cache lock.
365 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
367 pthread_mutex_t lock
;
368 /* Tracing session id */
371 * Indicates if the stream end point is still active or not (network
372 * streaming or local file system). The thread "owning" the stream is
373 * handling this status and can be notified of a state change through the
374 * consumer data appropriate pipe.
376 enum consumer_endpoint_status endpoint_status
;
377 /* Stream name. Format is: <channel_name>_<cpu_number> */
378 char name
[LTTNG_SYMBOL_NAME_LEN
];
379 /* Internal state of libustctl. */
380 struct ustctl_consumer_stream
*ustream
;
381 struct cds_list_head send_node
;
382 /* On-disk circular buffer */
383 uint64_t tracefile_size_current
;
384 uint64_t tracefile_count_current
;
386 * Monitor or not the streams of this channel meaning this indicates if the
387 * streams should be sent to the data/metadata thread or added to the no
388 * monitor list of the channel.
390 unsigned int monitor
;
392 * Indicate if the stream is globally visible meaning that it has been
393 * added to the multiple hash tables. If *not* set, NO lock should be
394 * acquired in the destroy path.
396 unsigned int globally_visible
;
398 * Pipe to wake up the metadata poll thread when the UST metadata
401 int ust_metadata_poll_pipe
[2];
403 * How much metadata was read from the metadata cache and sent
406 uint64_t ust_metadata_pushed
;
408 * Copy of the last discarded event value to detect the overflow of
411 uint64_t last_discarded_events
;
412 /* Copy of the sequence number of the last packet extracted. */
413 uint64_t last_sequence_number
;
415 * A stream is created with a trace_archive_id matching the session's
416 * current trace archive id at the time of the creation of the stream.
417 * It is incremented when the rotate_position is reached.
419 uint64_t trace_archive_id
;
421 * Index file object of the index file for this stream.
423 struct lttng_index_file
*index_file
;
426 * Local pipe to extract data when using splice.
431 * Rendez-vous point between data and metadata stream in live mode.
433 pthread_cond_t metadata_rdv
;
434 pthread_mutex_t metadata_rdv_lock
;
437 * rotate_position represents the position in the ring-buffer that has to
438 * be flushed to disk to complete the ongoing rotation. When that position
439 * is reached, this tracefile can be closed and a new one is created in
440 * channel_read_only_attributes.path.
442 unsigned long rotate_position
;
445 * Read-only copies of channel values. We cannot safely access the
446 * channel from a stream, so we need to have a local copy of these
447 * fields in the stream object. These fields should be removed from
448 * the stream objects when we introduce refcounting.
451 char path
[LTTNG_PATH_MAX
];
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
;
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
;
668 /* Return a human-readable consumer type string that is suitable for logging. */
670 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
673 case LTTNG_CONSUMER_UNKNOWN
:
675 case LTTNG_CONSUMER_KERNEL
:
677 case LTTNG_CONSUMER32_UST
:
678 return "32-bit user space";
679 case LTTNG_CONSUMER64_UST
:
680 return "64-bit user space";
687 * Init consumer data structures.
689 int lttng_consumer_init(void);
692 * Set the error socket for communication with a session daemon.
694 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
698 * Set the command socket path for communication with a session daemon.
700 void lttng_consumer_set_command_sock_path(
701 struct lttng_consumer_local_data
*ctx
, char *sock
);
704 * Send return code to session daemon.
706 * Returns the return code of sendmsg : the number of bytes transmitted or -1
709 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
712 * Called from signal handler to ensure a clean exit.
714 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
717 * Cleanup the daemon's socket on exit.
719 void lttng_consumer_cleanup(void);
722 * Poll on the should_quit pipe and the command socket return -1 on error and
723 * should exit, 0 if data is available on the command socket
725 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
728 * Copy the fields from the channel that need to be accessed (read-only)
729 * directly from the stream.
731 void consumer_stream_update_channel_attributes(
732 struct lttng_consumer_stream
*stream
,
733 struct lttng_consumer_channel
*channel
);
735 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
737 enum lttng_consumer_stream_state state
,
738 const char *channel_name
,
745 enum consumer_channel_type type
,
746 unsigned int monitor
,
747 uint64_t trace_archive_id
);
748 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
750 const char *pathname
,
755 enum lttng_event_output output
,
756 uint64_t tracefile_size
,
757 uint64_t tracefile_count
,
758 uint64_t session_id_per_pid
,
759 unsigned int monitor
,
760 unsigned int live_timer_interval
,
761 const char *root_shm_path
,
762 const char *shm_path
);
763 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
764 struct lttng_ht
*ht
);
765 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
766 struct lttng_ht
*ht
);
767 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
768 struct lttng_consumer_local_data
*ctx
);
769 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
771 /* lttng-relayd consumer command */
772 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
773 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
774 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
775 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
776 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
777 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
779 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
781 struct lttng_consumer_local_data
*lttng_consumer_create(
782 enum lttng_consumer_type type
,
783 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
784 struct lttng_consumer_local_data
*ctx
),
785 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
786 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
787 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
788 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
789 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
790 struct lttng_consumer_local_data
*ctx
,
791 struct lttng_consumer_stream
*stream
, unsigned long len
,
792 unsigned long padding
,
793 struct ctf_packet_index
*index
);
794 ssize_t
lttng_consumer_on_read_subbuffer_splice(
795 struct lttng_consumer_local_data
*ctx
,
796 struct lttng_consumer_stream
*stream
, unsigned long len
,
797 unsigned long padding
,
798 struct ctf_packet_index
*index
);
799 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
800 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
801 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
803 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
805 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
806 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
807 void *consumer_thread_metadata_poll(void *data
);
808 void *consumer_thread_data_poll(void *data
);
809 void *consumer_thread_sessiond_poll(void *data
);
810 void *consumer_thread_channel_poll(void *data
);
811 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
812 int sock
, struct pollfd
*consumer_sockpoll
);
814 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
815 struct lttng_consumer_local_data
*ctx
);
816 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
817 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
818 struct lttng_consumer_local_data
*ctx
, int sock
,
819 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
820 uint64_t sessiond_id
, uint64_t relayd_session_id
);
821 void consumer_flag_relayd_for_destroy(
822 struct consumer_relayd_sock_pair
*relayd
);
823 int consumer_data_pending(uint64_t id
);
824 int consumer_send_status_msg(int sock
, int ret_code
);
825 int consumer_send_status_channel(int sock
,
826 struct lttng_consumer_channel
*channel
);
827 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
829 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
830 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
831 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
832 uint64_t max_sb_size
);
833 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
834 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
835 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
836 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
837 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
838 int lttng_consumer_rotate_sample_channel(struct lttng_consumer_channel
*channel
,
839 uint64_t key
, const char *path
, uint64_t relayd_id
,
840 uint32_t metadata
, uint64_t new_chunk_id
,
841 struct lttng_consumer_local_data
*ctx
);
842 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
843 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
844 struct lttng_consumer_stream
*stream
, bool *rotated
);
845 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
846 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
847 int lttng_consumer_rotate_rename(const char *current_path
, const char *new_path
,
848 uid_t uid
, gid_t gid
, uint64_t relayd_id
);
849 int lttng_consumer_check_rotation_pending_local(uint64_t session_id
,
851 int lttng_consumer_check_rotation_pending_relay(uint64_t session_id
,
852 uint64_t relayd_id
, uint64_t chunk_id
);
853 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
854 int lttng_consumer_mkdir(const char *path
, uid_t uid
, gid_t gid
,
856 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
857 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
);
859 #endif /* LIB_CONSUMER_H */