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
,
71 /* State of each fd in consumer */
72 enum lttng_consumer_stream_state
{
73 LTTNG_CONSUMER_ACTIVE_STREAM
,
74 LTTNG_CONSUMER_PAUSE_STREAM
,
75 LTTNG_CONSUMER_DELETE_STREAM
,
78 enum lttng_consumer_type
{
79 LTTNG_CONSUMER_UNKNOWN
= 0,
80 LTTNG_CONSUMER_KERNEL
,
85 enum consumer_endpoint_status
{
86 CONSUMER_ENDPOINT_ACTIVE
,
87 CONSUMER_ENDPOINT_INACTIVE
,
90 enum consumer_channel_output
{
91 CONSUMER_CHANNEL_MMAP
= 0,
92 CONSUMER_CHANNEL_SPLICE
= 1,
95 enum consumer_channel_type
{
96 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
97 CONSUMER_CHANNEL_TYPE_DATA
= 1,
100 extern struct lttng_consumer_global_data consumer_data
;
103 struct cds_list_head head
;
108 struct consumer_metadata_cache
;
110 struct lttng_consumer_channel
{
111 /* HT node used for consumer_data.channel_ht */
112 struct lttng_ht_node_u64 node
;
113 /* Indexed key. Incremented value in the consumer. */
115 /* Number of streams referencing this channel */
117 /* Tracing session id on the session daemon side. */
120 * Session id when requesting metadata to the session daemon for
121 * a session with per-PID buffers.
123 uint64_t session_id_per_pid
;
124 /* Channel trace file path name. */
125 char pathname
[PATH_MAX
];
127 char name
[LTTNG_SYMBOL_NAME_LEN
];
128 /* UID and GID of the session owning this channel. */
131 /* Relayd id of the channel. -1ULL if it does not apply. */
134 * Number of streams NOT initialized yet. This is used in order to not
135 * delete this channel if streams are getting initialized.
137 unsigned int nb_init_stream_left
;
138 /* Output type (mmap or splice). */
139 enum consumer_channel_output output
;
140 /* Channel type for stream */
141 enum consumer_channel_type type
;
144 uid_t ust_app_uid
; /* Application UID. */
145 struct ustctl_consumer_channel
*uchan
;
146 unsigned char uuid
[UUID_STR_LEN
];
148 * Temporary stream list used to store the streams once created and waiting
149 * to be sent to the session daemon by receiving the
150 * LTTNG_CONSUMER_GET_CHANNEL.
152 struct stream_list streams
;
155 * Set if the channel is metadata. We keep a reference to the stream
156 * because we have to flush data once pushed by the session daemon. For a
157 * regular channel, this is always set to NULL.
159 struct lttng_consumer_stream
*metadata_stream
;
163 /* Node within channel thread ht */
164 struct lttng_ht_node_u64 wait_fd_node
;
166 /* Metadata cache is metadata channel */
167 struct consumer_metadata_cache
*metadata_cache
;
169 /* For UST metadata periodical flush */
170 int switch_timer_enabled
;
171 timer_t switch_timer
;
172 int switch_timer_error
;
174 /* For the live mode */
175 int live_timer_enabled
;
177 int live_timer_error
;
179 /* For channel monitoring timer. */
180 int monitor_timer_enabled
;
181 timer_t monitor_timer
;
183 /* On-disk circular buffer */
184 uint64_t tracefile_size
;
185 uint64_t tracefile_count
;
187 * Monitor or not the streams of this channel meaning this indicates if the
188 * streams should be sent to the data/metadata thread or added to the no
189 * monitor list of the channel.
191 unsigned int monitor
;
196 * This lock protects against concurrent update of channel.
198 * This is nested INSIDE the consumer data lock.
199 * This is nested OUTSIDE the channel timer lock.
200 * This is nested OUTSIDE the metadata cache lock.
201 * This is nested OUTSIDE stream lock.
202 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
204 pthread_mutex_t lock
;
207 * Channel teardown lock.
209 * This lock protect against teardown of channel. It is _never_
210 * taken by the timer handler.
212 * This is nested INSIDE the consumer data lock.
213 * This is nested INSIDE the channel lock.
214 * This is nested OUTSIDE the metadata cache lock.
215 * This is nested OUTSIDE stream lock.
216 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
218 pthread_mutex_t timer_lock
;
220 /* Timer value in usec for live streaming. */
221 unsigned int live_timer_interval
;
225 char root_shm_path
[PATH_MAX
];
226 char shm_path
[PATH_MAX
];
227 /* Total number of discarded events for that channel. */
228 uint64_t discarded_events
;
229 /* Total number of missed packets due to overwriting (overwrite). */
230 uint64_t lost_packets
;
232 bool streams_sent_to_relayd
;
235 * Account how many streams are waiting for their rotation to be
236 * complete. When this number reaches 0, we inform the session
237 * daemon that this channel has finished its rotation.
239 uint64_t nr_stream_rotate_pending
;
242 * The chunk id where we currently write the data. This value is sent
243 * to the relay when we add a stream and when a stream rotates. This
244 * allows to keep track of where each stream on the relay is writing.
246 uint64_t current_chunk_id
;
250 * Internal representation of the streams, sessiond_key is used to identify
253 struct lttng_consumer_stream
{
254 /* HT node used by the data_ht and metadata_ht */
255 struct lttng_ht_node_u64 node
;
256 /* stream indexed per channel key node */
257 struct lttng_ht_node_u64 node_channel_id
;
258 /* HT node used in consumer_data.stream_list_ht */
259 struct lttng_ht_node_u64 node_session_id
;
260 /* Pointer to associated channel. */
261 struct lttng_consumer_channel
*chan
;
263 /* Key by which the stream is indexed for 'node'. */
266 * File descriptor of the data output file. This can be either a file or a
267 * socket fd for relayd streaming.
269 int out_fd
; /* output file to write the data */
270 /* Write position in the output file descriptor */
272 /* Amount of bytes written to the output */
273 uint64_t output_written
;
274 enum lttng_consumer_stream_state state
;
277 int hangup_flush_done
;
280 * Whether the stream is in a "complete" state (e.g. it does not have a
281 * partially written sub-buffer.
283 * Initialized to "false" on stream creation (first packet is empty).
285 * The various transitions of the quiescent state are:
286 * - On "start" tracing: set to false, since the stream is not
288 * - On "stop" tracing: if !quiescent -> flush FINAL (update
289 * timestamp_end), and set to true; the stream has entered a
290 * complete/quiescent state.
291 * - On "destroy" or stream/application hang-up: if !quiescent ->
292 * flush FINAL, and set to true.
294 * NOTE: Update and read are protected by the stream lock.
299 * metadata_timer_lock protects flags waiting_on_metadata and
300 * missed_metadata_flush.
302 pthread_mutex_t metadata_timer_lock
;
304 * Flag set when awaiting metadata to be pushed. Used in the
305 * timer thread to skip waiting on the stream (and stream lock) to
306 * ensure we can proceed to flushing metadata in live mode.
308 bool waiting_on_metadata
;
309 /* Raised when a timer misses a metadata flush. */
310 bool missed_metadata_flush
;
312 enum lttng_event_output output
;
313 /* Maximum subbuffer size. */
314 unsigned long max_sb_size
;
317 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
318 * used for the mmap base and offset.
321 unsigned long mmap_len
;
326 /* UID/GID of the user owning the session to which stream belongs */
329 /* Network sequence number. Indicating on which relayd socket it goes. */
330 uint64_t net_seq_idx
;
332 * Indicate if this stream was successfully sent to a relayd. This is set
333 * after the refcount of the relayd is incremented and is checked when the
334 * stream is closed before decrementing the refcount in order to avoid an
337 unsigned int sent_to_relayd
;
339 /* Identify if the stream is the metadata */
340 unsigned int metadata_flag
;
342 * Last known metadata version, reset the metadata file in case
345 uint64_t metadata_version
;
346 /* Used when the stream is set for network streaming */
347 uint64_t relayd_stream_id
;
349 * When sending a stream packet to a relayd, this number is used to track
350 * the packet sent by the consumer and seen by the relayd. When sending the
351 * data header to the relayd, this number is sent and if the transmission
352 * was successful, it is incremented.
354 * Even if the full data is not fully transmitted it won't matter since
355 * only two possible error can happen after that where either the relayd
356 * died or a read error is detected on the stream making this value useless
359 * This value SHOULD be read/updated atomically or with the lock acquired.
361 uint64_t next_net_seq_num
;
363 * Lock to use the stream FDs since they are used between threads.
365 * This is nested INSIDE the consumer_data lock.
366 * This is nested INSIDE the channel lock.
367 * This is nested INSIDE the channel timer lock.
368 * This is nested OUTSIDE the metadata cache lock.
369 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
371 pthread_mutex_t lock
;
372 /* Tracing session id */
375 * Indicates if the stream end point is still active or not (network
376 * streaming or local file system). The thread "owning" the stream is
377 * handling this status and can be notified of a state change through the
378 * consumer data appropriate pipe.
380 enum consumer_endpoint_status endpoint_status
;
381 /* Stream name. Format is: <channel_name>_<cpu_number> */
382 char name
[LTTNG_SYMBOL_NAME_LEN
];
383 /* Internal state of libustctl. */
384 struct ustctl_consumer_stream
*ustream
;
385 struct cds_list_head send_node
;
386 /* On-disk circular buffer */
387 uint64_t tracefile_size_current
;
388 uint64_t tracefile_count_current
;
390 * Monitor or not the streams of this channel meaning this indicates if the
391 * streams should be sent to the data/metadata thread or added to the no
392 * monitor list of the channel.
394 unsigned int monitor
;
396 * Indicate if the stream is globally visible meaning that it has been
397 * added to the multiple hash tables. If *not* set, NO lock should be
398 * acquired in the destroy path.
400 unsigned int globally_visible
;
402 * Pipe to wake up the metadata poll thread when the UST metadata
405 int ust_metadata_poll_pipe
[2];
407 * How much metadata was read from the metadata cache and sent
410 uint64_t ust_metadata_pushed
;
412 * Copy of the last discarded event value to detect the overflow of
415 uint64_t last_discarded_events
;
416 /* Copy of the sequence number of the last packet extracted. */
417 uint64_t last_sequence_number
;
419 * Index file object of the index file for this stream.
421 struct lttng_index_file
*index_file
;
424 * Local pipe to extract data when using splice.
429 * Rendez-vous point between data and metadata stream in live mode.
431 pthread_cond_t metadata_rdv
;
432 pthread_mutex_t metadata_rdv_lock
;
435 * If rotate_position != 0, when we reach this position in the
436 * ring-buffer, close this tracefile and create a new one in
439 uint64_t rotate_position
;
442 * Read-only copies of channel values. We cannot safely access the
443 * channel from a stream, so we need to have a local copy of these
444 * fields in the stream object. These fields should be removed from
445 * the stream objects when we introduce refcounting.
447 char channel_ro_pathname
[PATH_MAX
];
448 uint64_t channel_ro_tracefile_size
;
451 * Flag to inform the data or metadata thread that a stream is
452 * ready to be rotated.
454 unsigned int rotate_ready
:1;
456 * Flag set to 1 if the stream just got rotated. This is used to
457 * perform actions on the channel after a rotation without needing
458 * to nest the channel lock inside the stream lock.
460 unsigned int rotated
:1;
462 /* Indicate if the stream still has some data to be read. */
463 unsigned int has_data
:1;
465 * Inform the consumer or relay to reset the metadata
466 * file before writing in it (regeneration).
468 unsigned int reset_metadata_flag
:1;
472 * Internal representation of a relayd socket pair.
474 struct consumer_relayd_sock_pair
{
475 /* Network sequence number. */
476 uint64_t net_seq_idx
;
477 /* Number of stream associated with this relayd */
478 unsigned int refcount
;
481 * This flag indicates whether or not we should destroy this object. The
482 * destruction should ONLY occurs when this flag is set and the refcount is
485 unsigned int destroy_flag
;
488 * Mutex protecting the control socket to avoid out of order packets
489 * between threads sending data to the relayd. Since metadata data is sent
490 * over that socket, at least two sendmsg() are needed (header + data)
491 * creating a race for packets to overlap between threads using it.
493 * This is nested INSIDE the consumer_data lock.
494 * This is nested INSIDE the stream lock.
496 pthread_mutex_t ctrl_sock_mutex
;
498 /* Control socket. Command and metadata are passed over it */
499 struct lttcomm_relayd_sock control_sock
;
502 * We don't need a mutex at this point since we only splice or write single
503 * large chunk of data with a header appended at the begining. Moreover,
504 * this socket is for now only used in a single thread.
506 struct lttcomm_relayd_sock data_sock
;
507 struct lttng_ht_node_u64 node
;
509 /* Session id on both sides for the sockets. */
510 uint64_t relayd_session_id
;
511 uint64_t sessiond_session_id
;
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
;
602 * Pipe used to inform the session daemon that a stream has finished
603 * its rotation (write-only).
605 int channel_rotate_pipe
;
607 * Pipe to wakeup the data thread if a stream needs to rotated
608 * immediately (vs waiting for more data).
610 struct lttng_pipe
*consumer_data_rotate_pipe
;
612 * Pipe to wakeup the metadata thread if a stream needs to rotated
613 * immediately (vs waiting for more data).
615 struct lttng_pipe
*consumer_metadata_rotate_pipe
;
619 * Library-level data. One instance per process.
621 struct lttng_consumer_global_data
{
623 * At this time, this lock is used to ensure coherence between the count
624 * and number of element in the hash table. It's also a protection for
625 * concurrent read/write between threads.
627 * This is nested OUTSIDE the stream lock.
628 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
630 pthread_mutex_t lock
;
633 * Number of streams in the data stream hash table declared outside.
634 * Protected by consumer_data.lock.
638 /* Channel hash table protected by consumer_data.lock. */
639 struct lttng_ht
*channel_ht
;
641 * Flag specifying if the local array of FDs needs update in the
642 * poll function. Protected by consumer_data.lock.
644 unsigned int need_update
;
645 enum lttng_consumer_type type
;
648 * Relayd socket(s) hashtable indexed by network sequence number. Each
649 * stream has an index which associate the right relayd socket to use.
651 struct lttng_ht
*relayd_ht
;
654 * This hash table contains all streams (metadata and data) indexed by
655 * session id. In other words, the ht is indexed by session id and each
656 * bucket contains the list of associated streams.
658 * This HT uses the "node_session_id" of the consumer stream.
660 struct lttng_ht
*stream_list_ht
;
663 * This HT uses the "node_channel_id" of the consumer stream.
665 struct lttng_ht
*stream_per_chan_id_ht
;
669 * Set to nonzero when the consumer is exiting. Updated by signal
670 * handler and thread exit, read by threads.
672 extern int consumer_quit
;
675 * Set to nonzero when the consumer is exiting. Updated by signal
676 * handler and thread exit, read by threads.
678 extern int consumer_quit
;
680 /* Flag used to temporarily pause data consumption from testpoints. */
681 extern int data_consumption_paused
;
684 * Init consumer data structures.
686 int lttng_consumer_init(void);
689 * Set the error socket for communication with a session daemon.
691 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
695 * Set the command socket path for communication with a session daemon.
697 void lttng_consumer_set_command_sock_path(
698 struct lttng_consumer_local_data
*ctx
, char *sock
);
701 * Send return code to session daemon.
703 * Returns the return code of sendmsg : the number of bytes transmitted or -1
706 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
709 * Called from signal handler to ensure a clean exit.
711 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
714 * Cleanup the daemon's socket on exit.
716 void lttng_consumer_cleanup(void);
719 * Poll on the should_quit pipe and the command socket return -1 on error and
720 * should exit, 0 if data is available on the command socket
722 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
725 * Copy the fields from the channel that need to be accessed in read-only
726 * directly from the stream.
728 void consumer_stream_copy_ro_channel_values(struct lttng_consumer_stream
*stream
,
729 struct lttng_consumer_channel
*channel
);
731 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
733 enum lttng_consumer_stream_state state
,
734 const char *channel_name
,
741 enum consumer_channel_type type
,
742 unsigned int monitor
);
743 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
745 const char *pathname
,
750 enum lttng_event_output output
,
751 uint64_t tracefile_size
,
752 uint64_t tracefile_count
,
753 uint64_t session_id_per_pid
,
754 unsigned int monitor
,
755 unsigned int live_timer_interval
,
756 const char *root_shm_path
,
757 const char *shm_path
);
758 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
759 struct lttng_ht
*ht
);
760 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
761 struct lttng_ht
*ht
);
762 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
763 struct lttng_consumer_local_data
*ctx
);
764 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
766 /* lttng-relayd consumer command */
767 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
768 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
,
769 enum lttng_domain_type domain
);
770 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
771 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
772 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
773 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
775 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
777 struct lttng_consumer_local_data
*lttng_consumer_create(
778 enum lttng_consumer_type type
,
779 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
780 struct lttng_consumer_local_data
*ctx
),
781 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
782 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
783 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
784 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
785 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
786 struct lttng_consumer_local_data
*ctx
,
787 struct lttng_consumer_stream
*stream
, unsigned long len
,
788 unsigned long padding
,
789 struct ctf_packet_index
*index
);
790 ssize_t
lttng_consumer_on_read_subbuffer_splice(
791 struct lttng_consumer_local_data
*ctx
,
792 struct lttng_consumer_stream
*stream
, unsigned long len
,
793 unsigned long padding
,
794 struct ctf_packet_index
*index
);
795 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
796 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
797 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
799 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
801 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
802 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
803 void *consumer_thread_metadata_poll(void *data
);
804 void *consumer_thread_data_poll(void *data
);
805 void *consumer_thread_sessiond_poll(void *data
);
806 void *consumer_thread_channel_poll(void *data
);
807 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
808 int sock
, struct pollfd
*consumer_sockpoll
);
810 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
811 struct lttng_consumer_local_data
*ctx
);
812 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
813 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
814 struct lttng_consumer_local_data
*ctx
, int sock
,
815 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
816 uint64_t sessiond_id
, uint64_t relayd_session_id
);
817 void consumer_flag_relayd_for_destroy(
818 struct consumer_relayd_sock_pair
*relayd
);
819 int consumer_data_pending(uint64_t id
);
820 int consumer_send_status_msg(int sock
, int ret_code
);
821 int consumer_send_status_channel(int sock
,
822 struct lttng_consumer_channel
*channel
);
823 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
825 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
826 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
827 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
828 uint64_t max_sb_size
);
829 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
830 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
831 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
832 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
833 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
834 int lttng_consumer_rotate_channel(uint64_t key
, char *path
,
835 uint64_t relayd_id
, uint32_t metadata
,
836 uint64_t new_chunk_id
, struct lttng_consumer_local_data
*ctx
);
837 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
838 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
839 struct lttng_consumer_stream
*stream
);
840 int lttng_consumer_rotate_ready_streams(uint64_t key
,
841 struct lttng_consumer_local_data
*ctx
);
842 int lttng_consumer_rotate_rename(char *current_path
, char *new_path
,
843 uid_t uid
, gid_t gid
, uint64_t relayd_id
);
844 int lttng_consumer_rotate_pending_relay( uint64_t session_id
,
845 uint64_t relayd_id
, uint64_t chunk_id
);
846 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
848 #endif /* LIB_CONSUMER_H */