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>
37 #include <common/trace-chunk-registry.h>
38 #include <common/credentials.h>
40 /* Commands for consumer */
41 enum lttng_consumer_command
{
42 LTTNG_CONSUMER_ADD_CHANNEL
,
43 LTTNG_CONSUMER_ADD_STREAM
,
44 /* pause, delete, active depending on fd state */
45 LTTNG_CONSUMER_UPDATE_STREAM
,
46 /* inform the consumer to quit when all fd has hang up */
47 LTTNG_CONSUMER_STOP
, /* deprecated */
48 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
49 /* Inform the consumer to kill a specific relayd connection */
50 LTTNG_CONSUMER_DESTROY_RELAYD
,
51 /* Return to the sessiond if there is data pending for a session */
52 LTTNG_CONSUMER_DATA_PENDING
,
53 /* Consumer creates a channel and returns it to sessiond. */
54 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
55 LTTNG_CONSUMER_GET_CHANNEL
,
56 LTTNG_CONSUMER_DESTROY_CHANNEL
,
57 LTTNG_CONSUMER_PUSH_METADATA
,
58 LTTNG_CONSUMER_CLOSE_METADATA
,
59 LTTNG_CONSUMER_SETUP_METADATA
,
60 LTTNG_CONSUMER_FLUSH_CHANNEL
,
61 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
62 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
63 LTTNG_CONSUMER_STREAMS_SENT
,
64 LTTNG_CONSUMER_DISCARDED_EVENTS
,
65 LTTNG_CONSUMER_LOST_PACKETS
,
66 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
,
67 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
,
68 LTTNG_CONSUMER_ROTATE_CHANNEL
,
70 LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
71 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
72 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
75 enum lttng_consumer_type
{
76 LTTNG_CONSUMER_UNKNOWN
= 0,
77 LTTNG_CONSUMER_KERNEL
,
82 enum consumer_endpoint_status
{
83 CONSUMER_ENDPOINT_ACTIVE
,
84 CONSUMER_ENDPOINT_INACTIVE
,
87 enum consumer_channel_output
{
88 CONSUMER_CHANNEL_MMAP
= 0,
89 CONSUMER_CHANNEL_SPLICE
= 1,
92 enum consumer_channel_type
{
93 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
94 CONSUMER_CHANNEL_TYPE_DATA
= 1,
97 extern struct lttng_consumer_global_data consumer_data
;
100 struct cds_list_head head
;
105 struct consumer_metadata_cache
;
107 struct lttng_consumer_channel
{
108 /* Is the channel published in the channel hash tables? */
111 * Was the channel deleted (logically) and waiting to be reclaimed?
112 * If this flag is set, no modification that is not cleaned-up by the
113 * RCU reclamation callback should be made
116 /* HT node used for consumer_data.channel_ht */
117 struct lttng_ht_node_u64 node
;
118 /* HT node used for consumer_data.channels_by_session_id_ht */
119 struct lttng_ht_node_u64 channels_by_session_id_ht_node
;
120 /* Indexed key. Incremented value in the consumer. */
122 /* Number of streams referencing this channel */
124 /* Tracing session id on the session daemon side. */
126 /* Current trace chunk of the session in which this channel exists. */
127 struct lttng_trace_chunk
*trace_chunk
;
129 * Session id when requesting metadata to the session daemon for
130 * a session with per-PID buffers.
132 uint64_t session_id_per_pid
;
134 * In the case of local streams, this field contains the channel's
135 * output path; a path relative to the session's output path.
136 * e.g. ust/uid/1000/64-bit
138 * In the case of remote streams, the contents of this field depends
139 * on the version of the relay daemon peer. For 2.11+ peers, the
140 * contents are the same as in the local case. However, for legacy
141 * peers, this contains a path of the form:
142 * /hostname/session_path/ust/uid/1000/64-bit
144 char pathname
[PATH_MAX
];
146 char name
[LTTNG_SYMBOL_NAME_LEN
];
147 /* Relayd id of the channel. -1ULL if it does not apply. */
150 * Number of streams NOT initialized yet. This is used in order to not
151 * delete this channel if streams are getting initialized.
153 unsigned int nb_init_stream_left
;
154 /* Output type (mmap or splice). */
155 enum consumer_channel_output output
;
156 /* Channel type for stream */
157 enum consumer_channel_type type
;
160 uid_t ust_app_uid
; /* Application UID. */
161 struct ustctl_consumer_channel
*uchan
;
162 unsigned char uuid
[UUID_STR_LEN
];
164 * Temporary stream list used to store the streams once created and waiting
165 * to be sent to the session daemon by receiving the
166 * LTTNG_CONSUMER_GET_CHANNEL.
168 struct stream_list streams
;
171 * Set if the channel is metadata. We keep a reference to the stream
172 * because we have to flush data once pushed by the session daemon. For a
173 * regular channel, this is always set to NULL.
175 struct lttng_consumer_stream
*metadata_stream
;
179 /* Node within channel thread ht */
180 struct lttng_ht_node_u64 wait_fd_node
;
182 /* Metadata cache is metadata channel */
183 struct consumer_metadata_cache
*metadata_cache
;
185 /* For UST metadata periodical flush */
186 int switch_timer_enabled
;
187 timer_t switch_timer
;
188 int switch_timer_error
;
190 /* For the live mode */
191 int live_timer_enabled
;
193 int live_timer_error
;
195 /* For channel monitoring timer. */
196 int monitor_timer_enabled
;
197 timer_t monitor_timer
;
199 /* On-disk circular buffer */
200 uint64_t tracefile_size
;
201 uint64_t tracefile_count
;
203 * Monitor or not the streams of this channel meaning this indicates if the
204 * streams should be sent to the data/metadata thread or added to the no
205 * monitor list of the channel.
207 unsigned int monitor
;
212 * This lock protects against concurrent update of channel.
214 * This is nested INSIDE the consumer data lock.
215 * This is nested OUTSIDE the channel timer lock.
216 * This is nested OUTSIDE the metadata cache lock.
217 * This is nested OUTSIDE stream lock.
218 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
220 pthread_mutex_t lock
;
223 * Channel teardown lock.
225 * This lock protect against teardown of channel. It is _never_
226 * taken by the timer handler.
228 * This is nested INSIDE the consumer data lock.
229 * This is nested INSIDE the channel lock.
230 * This is nested OUTSIDE the metadata cache lock.
231 * This is nested OUTSIDE stream lock.
232 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
234 pthread_mutex_t timer_lock
;
236 /* Timer value in usec for live streaming. */
237 unsigned int live_timer_interval
;
241 char root_shm_path
[PATH_MAX
];
242 char shm_path
[PATH_MAX
];
243 /* Only set for UST channels. */
244 LTTNG_OPTIONAL(struct lttng_credentials
) buffer_credentials
;
245 /* Total number of discarded events for that channel. */
246 uint64_t discarded_events
;
247 /* Total number of missed packets due to overwriting (overwrite). */
248 uint64_t lost_packets
;
250 bool streams_sent_to_relayd
;
254 * Internal representation of the streams, sessiond_key is used to identify
257 struct lttng_consumer_stream
{
258 /* HT node used by the data_ht and metadata_ht */
259 struct lttng_ht_node_u64 node
;
260 /* stream indexed per channel key node */
261 struct lttng_ht_node_u64 node_channel_id
;
262 /* HT node used in consumer_data.stream_list_ht */
263 struct lttng_ht_node_u64 node_session_id
;
264 /* Pointer to associated channel. */
265 struct lttng_consumer_channel
*chan
;
267 * Current trace chunk. Holds a reference to the trace chunk.
268 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
269 * when it was created in the context of a no-output session.
271 struct lttng_trace_chunk
*trace_chunk
;
273 /* Key by which the stream is indexed for 'node'. */
276 * File descriptor of the data output file. This can be either a file or a
277 * socket fd for relayd streaming.
279 int out_fd
; /* output file to write the data */
280 /* Write position in the output file descriptor */
282 /* Amount of bytes written to the output */
283 uint64_t output_written
;
286 int hangup_flush_done
;
289 * Whether the stream is in a "complete" state (e.g. it does not have a
290 * partially written sub-buffer.
292 * Initialized to "false" on stream creation (first packet is empty).
294 * The various transitions of the quiescent state are:
295 * - On "start" tracing: set to false, since the stream is not
297 * - On "stop" tracing: if !quiescent -> flush FINAL (update
298 * timestamp_end), and set to true; the stream has entered a
299 * complete/quiescent state.
300 * - On "destroy" or stream/application hang-up: if !quiescent ->
301 * flush FINAL, and set to true.
303 * NOTE: Update and read are protected by the stream lock.
308 * metadata_timer_lock protects flags waiting_on_metadata and
309 * missed_metadata_flush.
311 pthread_mutex_t metadata_timer_lock
;
313 * Flag set when awaiting metadata to be pushed. Used in the
314 * timer thread to skip waiting on the stream (and stream lock) to
315 * ensure we can proceed to flushing metadata in live mode.
317 bool waiting_on_metadata
;
318 /* Raised when a timer misses a metadata flush. */
319 bool missed_metadata_flush
;
321 enum lttng_event_output output
;
322 /* Maximum subbuffer size (in bytes). */
323 unsigned long max_sb_size
;
326 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
327 * used for the mmap base and offset.
330 unsigned long mmap_len
;
335 /* Network sequence number. Indicating on which relayd socket it goes. */
336 uint64_t net_seq_idx
;
338 * Indicate if this stream was successfully sent to a relayd. This is set
339 * after the refcount of the relayd is incremented and is checked when the
340 * stream is closed before decrementing the refcount in order to avoid an
343 unsigned int sent_to_relayd
;
345 /* Identify if the stream is the metadata */
346 unsigned int metadata_flag
;
348 * Last known metadata version, reset the metadata file in case
351 uint64_t metadata_version
;
352 /* Used when the stream is set for network streaming */
353 uint64_t relayd_stream_id
;
355 * When sending a stream packet to a relayd, this number is used to track
356 * the packet sent by the consumer and seen by the relayd. When sending the
357 * data header to the relayd, this number is sent and if the transmission
358 * was successful, it is incremented.
360 * Even if the full data is not fully transmitted it won't matter since
361 * only two possible error can happen after that where either the relayd
362 * died or a read error is detected on the stream making this value useless
365 * This value SHOULD be read/updated atomically or with the lock acquired.
367 uint64_t next_net_seq_num
;
369 * Lock to use the stream FDs since they are used between threads.
371 * This is nested INSIDE the consumer_data lock.
372 * This is nested INSIDE the channel lock.
373 * This is nested INSIDE the channel timer lock.
374 * This is nested OUTSIDE the metadata cache lock.
375 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
377 pthread_mutex_t lock
;
378 /* Tracing session id */
381 * Indicates if the stream end point is still active or not (network
382 * streaming or local file system). The thread "owning" the stream is
383 * handling this status and can be notified of a state change through the
384 * consumer data appropriate pipe.
386 enum consumer_endpoint_status endpoint_status
;
387 /* Stream name. Format is: <channel_name>_<cpu_number> */
388 char name
[LTTNG_SYMBOL_NAME_LEN
];
389 /* Internal state of libustctl. */
390 struct ustctl_consumer_stream
*ustream
;
391 struct cds_list_head send_node
;
392 /* On-disk circular buffer */
393 uint64_t tracefile_size_current
;
394 uint64_t tracefile_count_current
;
396 * Monitor or not the streams of this channel meaning this indicates if the
397 * streams should be sent to the data/metadata thread or added to the no
398 * monitor list of the channel.
400 unsigned int monitor
;
402 * Indicate if the stream is globally visible meaning that it has been
403 * added to the multiple hash tables. If *not* set, NO lock should be
404 * acquired in the destroy path.
406 unsigned int globally_visible
;
408 * Pipe to wake up the metadata poll thread when the UST metadata
411 int ust_metadata_poll_pipe
[2];
413 * How much metadata was read from the metadata cache and sent
416 uint64_t ust_metadata_pushed
;
418 * Copy of the last discarded event value to detect the overflow of
421 uint64_t last_discarded_events
;
422 /* Copy of the sequence number of the last packet extracted. */
423 uint64_t last_sequence_number
;
425 * Index file object of the index file for this stream.
427 struct lttng_index_file
*index_file
;
430 * Local pipe to extract data when using splice.
435 * Rendez-vous point between data and metadata stream in live mode.
437 pthread_cond_t metadata_rdv
;
438 pthread_mutex_t metadata_rdv_lock
;
441 * rotate_position represents the position in the ring-buffer that has to
442 * be flushed to disk to complete the ongoing rotation. When that position
443 * is reached, this tracefile can be closed and a new one is created in
444 * channel_read_only_attributes.path.
446 unsigned long rotate_position
;
449 * Read-only copies of channel values. We cannot safely access the
450 * channel from a stream, so we need to have a local copy of these
451 * fields in the stream object. These fields should be removed from
452 * the stream objects when we introduce refcounting.
455 uint64_t tracefile_size
;
456 } channel_read_only_attributes
;
459 * Flag to inform the data or metadata thread that a stream is
460 * ready to be rotated.
464 /* Indicate if the stream still has some data to be read. */
465 unsigned int has_data
:1;
467 * Inform the consumer or relay to reset the metadata
468 * file before writing in it (regeneration).
470 unsigned int reset_metadata_flag
:1;
474 * Internal representation of a relayd socket pair.
476 struct consumer_relayd_sock_pair
{
477 /* Network sequence number. */
478 uint64_t net_seq_idx
;
479 /* Number of stream associated with this relayd */
483 * This flag indicates whether or not we should destroy this object. The
484 * destruction should ONLY occurs when this flag is set and the refcount is
487 unsigned int destroy_flag
;
490 * Mutex protecting the control socket to avoid out of order packets
491 * between threads sending data to the relayd. Since metadata data is sent
492 * over that socket, at least two sendmsg() are needed (header + data)
493 * creating a race for packets to overlap between threads using it.
495 * This is nested INSIDE the consumer_data lock.
496 * This is nested INSIDE the stream lock.
498 pthread_mutex_t ctrl_sock_mutex
;
500 /* Control socket. Command and metadata are passed over it */
501 struct lttcomm_relayd_sock control_sock
;
504 * We don't need a mutex at this point since we only splice or write single
505 * large chunk of data with a header appended at the begining. Moreover,
506 * this socket is for now only used in a single thread.
508 struct lttcomm_relayd_sock data_sock
;
509 struct lttng_ht_node_u64 node
;
511 /* Session id on both sides for the sockets. */
512 uint64_t relayd_session_id
;
513 uint64_t sessiond_session_id
;
514 struct lttng_consumer_local_data
*ctx
;
518 * UST consumer local data to the program. One or more instance per
521 struct lttng_consumer_local_data
{
523 * Function to call when data is available on a buffer.
524 * Returns the number of bytes read, or negative error value.
526 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
527 struct lttng_consumer_local_data
*ctx
);
529 * function to call when we receive a new channel, it receives a
530 * newly allocated channel, depending on the return code of this
531 * function, the new channel will be handled by the application
535 * > 0 (success, FD is kept by application)
536 * == 0 (success, FD is left to library)
539 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
541 * function to call when we receive a new stream, it receives a
542 * newly allocated stream, depending on the return code of this
543 * function, the new stream will be handled by the application
547 * > 0 (success, FD is kept by application)
548 * == 0 (success, FD is left to library)
551 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
553 * function to call when a stream is getting updated by the session
554 * daemon, this function receives the sessiond key and the new
555 * state, depending on the return code of this function the
556 * update of state for the stream is handled by the application
560 * > 0 (success, FD is kept by application)
561 * == 0 (success, FD is left to library)
564 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
565 enum lttng_consumer_type type
;
566 /* socket to communicate errors with sessiond */
567 int consumer_error_socket
;
568 /* socket to ask metadata to sessiond. */
569 int consumer_metadata_socket
;
571 * Protect consumer_metadata_socket.
573 * This is nested OUTSIDE the metadata cache lock.
575 pthread_mutex_t metadata_socket_lock
;
576 /* socket to exchange commands with sessiond */
577 char *consumer_command_sock_path
;
578 /* communication with splice */
579 int consumer_channel_pipe
[2];
580 /* Data stream poll thread pipe. To transfer data stream to the thread */
581 struct lttng_pipe
*consumer_data_pipe
;
584 * Data thread use that pipe to catch wakeup from read subbuffer that
585 * detects that there is still data to be read for the stream encountered.
586 * Before doing so, the stream is flagged to indicate that there is still
589 * Both pipes (read/write) are owned and used inside the data thread.
591 struct lttng_pipe
*consumer_wakeup_pipe
;
592 /* Indicate if the wakeup thread has been notified. */
593 unsigned int has_wakeup
:1;
595 /* to let the signal handler wake up the fd receiver thread */
596 int consumer_should_quit
[2];
597 /* Metadata poll thread pipe. Transfer metadata stream to it */
598 struct lttng_pipe
*consumer_metadata_pipe
;
600 * Pipe used by the channel monitoring timers to provide state samples
601 * to the session daemon (write-only).
603 int channel_monitor_pipe
;
604 LTTNG_OPTIONAL(lttng_uuid
) sessiond_uuid
;
608 * Library-level data. One instance per process.
610 struct lttng_consumer_global_data
{
612 * At this time, this lock is used to ensure coherence between the count
613 * and number of element in the hash table. It's also a protection for
614 * concurrent read/write between threads.
616 * This is nested OUTSIDE the stream lock.
617 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
619 pthread_mutex_t lock
;
622 * Number of streams in the data stream hash table declared outside.
623 * Protected by consumer_data.lock.
627 /* Channel hash table protected by consumer_data.lock. */
628 struct lttng_ht
*channel_ht
;
629 /* Channel hash table indexed by session id. */
630 struct lttng_ht
*channels_by_session_id_ht
;
632 * Flag specifying if the local array of FDs needs update in the
633 * poll function. Protected by consumer_data.lock.
635 unsigned int need_update
;
636 enum lttng_consumer_type type
;
639 * Relayd socket(s) hashtable indexed by network sequence number. Each
640 * stream has an index which associate the right relayd socket to use.
642 struct lttng_ht
*relayd_ht
;
645 * This hash table contains all streams (metadata and data) indexed by
646 * session id. In other words, the ht is indexed by session id and each
647 * bucket contains the list of associated streams.
649 * This HT uses the "node_session_id" of the consumer stream.
651 struct lttng_ht
*stream_list_ht
;
654 * This HT uses the "node_channel_id" of the consumer stream.
656 struct lttng_ht
*stream_per_chan_id_ht
;
659 * Trace chunk registry indexed by (session_id, chunk_id).
661 struct lttng_trace_chunk_registry
*chunk_registry
;
665 * Set to nonzero when the consumer is exiting. Updated by signal
666 * handler and thread exit, read by threads.
668 extern int consumer_quit
;
671 * Set to nonzero when the consumer is exiting. Updated by signal
672 * handler and thread exit, read by threads.
674 extern int consumer_quit
;
676 /* Flag used to temporarily pause data consumption from testpoints. */
677 extern int data_consumption_paused
;
679 /* Return a human-readable consumer type string that is suitable for logging. */
681 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
684 case LTTNG_CONSUMER_UNKNOWN
:
686 case LTTNG_CONSUMER_KERNEL
:
688 case LTTNG_CONSUMER32_UST
:
689 return "32-bit user space";
690 case LTTNG_CONSUMER64_UST
:
691 return "64-bit user space";
698 * Init consumer data structures.
700 int lttng_consumer_init(void);
703 * Set the error socket for communication with a session daemon.
705 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
709 * Set the command socket path for communication with a session daemon.
711 void lttng_consumer_set_command_sock_path(
712 struct lttng_consumer_local_data
*ctx
, char *sock
);
715 * Send return code to session daemon.
717 * Returns the return code of sendmsg : the number of bytes transmitted or -1
720 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
723 * Called from signal handler to ensure a clean exit.
725 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
728 * Cleanup the daemon's socket on exit.
730 void lttng_consumer_cleanup(void);
733 * Poll on the should_quit pipe and the command socket return -1 on error and
734 * should exit, 0 if data is available on the command socket
736 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
739 * Copy the fields from the channel that need to be accessed (read-only)
740 * directly from the stream.
742 void consumer_stream_update_channel_attributes(
743 struct lttng_consumer_stream
*stream
,
744 struct lttng_consumer_channel
*channel
);
746 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
748 const char *channel_name
,
751 struct lttng_trace_chunk
*trace_chunk
,
754 enum consumer_channel_type type
,
755 unsigned int monitor
);
756 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
758 const uint64_t *chunk_id
,
759 const char *pathname
,
762 enum lttng_event_output output
,
763 uint64_t tracefile_size
,
764 uint64_t tracefile_count
,
765 uint64_t session_id_per_pid
,
766 unsigned int monitor
,
767 unsigned int live_timer_interval
,
768 const char *root_shm_path
,
769 const char *shm_path
);
770 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
771 struct lttng_ht
*ht
);
772 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
773 struct lttng_ht
*ht
);
774 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
775 struct lttng_consumer_local_data
*ctx
);
776 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
778 /* lttng-relayd consumer command */
779 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
780 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
781 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
782 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
783 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
784 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
786 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
788 struct lttng_consumer_local_data
*lttng_consumer_create(
789 enum lttng_consumer_type type
,
790 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
791 struct lttng_consumer_local_data
*ctx
),
792 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
793 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
794 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
795 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
796 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
797 struct lttng_consumer_local_data
*ctx
,
798 struct lttng_consumer_stream
*stream
, unsigned long len
,
799 unsigned long padding
,
800 struct ctf_packet_index
*index
);
801 ssize_t
lttng_consumer_on_read_subbuffer_splice(
802 struct lttng_consumer_local_data
*ctx
,
803 struct lttng_consumer_stream
*stream
, unsigned long len
,
804 unsigned long padding
,
805 struct ctf_packet_index
*index
);
806 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
807 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
808 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
810 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
812 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
813 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
814 void *consumer_thread_metadata_poll(void *data
);
815 void *consumer_thread_data_poll(void *data
);
816 void *consumer_thread_sessiond_poll(void *data
);
817 void *consumer_thread_channel_poll(void *data
);
818 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
819 int sock
, struct pollfd
*consumer_sockpoll
);
821 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
822 struct lttng_consumer_local_data
*ctx
);
823 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
824 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
825 struct lttng_consumer_local_data
*ctx
, int sock
,
826 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
827 uint64_t sessiond_id
, uint64_t relayd_session_id
);
828 void consumer_flag_relayd_for_destroy(
829 struct consumer_relayd_sock_pair
*relayd
);
830 int consumer_data_pending(uint64_t id
);
831 int consumer_send_status_msg(int sock
, int ret_code
);
832 int consumer_send_status_channel(int sock
,
833 struct lttng_consumer_channel
*channel
);
834 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
836 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
837 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
838 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
839 uint64_t max_sb_size
);
840 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
841 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
842 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
843 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
844 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
845 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
846 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
847 struct lttng_consumer_local_data
*ctx
);
848 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
849 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
850 struct lttng_consumer_stream
*stream
);
851 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
852 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
853 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
854 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
855 const uint64_t *relayd_id
, uint64_t session_id
,
857 time_t chunk_creation_timestamp
,
858 const char *chunk_override_name
,
859 const struct lttng_credentials
*credentials
,
860 struct lttng_directory_handle
*chunk_directory_handle
);
861 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
862 const uint64_t *relayd_id
, uint64_t session_id
,
863 uint64_t chunk_id
, time_t chunk_close_timestamp
,
864 const enum lttng_trace_chunk_command_type
*close_command
,
866 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
867 const uint64_t *relayd_id
, uint64_t session_id
,
869 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
870 enum lttcomm_return_code
lttng_consumer_init_command(
871 struct lttng_consumer_local_data
*ctx
,
872 const lttng_uuid sessiond_uuid
);
874 #endif /* LIB_CONSUMER_H */