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/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
,
73 LTTNG_CONSUMER_CLEAR_CHANNEL
,
76 enum lttng_consumer_type
{
77 LTTNG_CONSUMER_UNKNOWN
= 0,
78 LTTNG_CONSUMER_KERNEL
,
83 enum consumer_endpoint_status
{
84 CONSUMER_ENDPOINT_ACTIVE
,
85 CONSUMER_ENDPOINT_INACTIVE
,
88 enum consumer_channel_output
{
89 CONSUMER_CHANNEL_MMAP
= 0,
90 CONSUMER_CHANNEL_SPLICE
= 1,
93 enum consumer_channel_type
{
94 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
95 CONSUMER_CHANNEL_TYPE_DATA
= 1,
98 extern struct lttng_consumer_global_data consumer_data
;
101 struct cds_list_head head
;
106 struct consumer_metadata_cache
;
108 struct lttng_consumer_channel
{
109 /* Is the channel published in the channel hash tables? */
112 * Was the channel deleted (logically) and waiting to be reclaimed?
113 * If this flag is set, no modification that is not cleaned-up by the
114 * RCU reclamation callback should be made
117 /* HT node used for consumer_data.channel_ht */
118 struct lttng_ht_node_u64 node
;
119 /* HT node used for consumer_data.channels_by_session_id_ht */
120 struct lttng_ht_node_u64 channels_by_session_id_ht_node
;
121 /* Indexed key. Incremented value in the consumer. */
123 /* Number of streams referencing this channel */
125 /* Tracing session id on the session daemon side. */
127 /* Current trace chunk of the session in which this channel exists. */
128 struct lttng_trace_chunk
*trace_chunk
;
130 * Session id when requesting metadata to the session daemon for
131 * a session with per-PID buffers.
133 uint64_t session_id_per_pid
;
135 * In the case of local streams, this field contains the channel's
136 * output path; a path relative to the session's output path.
137 * e.g. ust/uid/1000/64-bit
139 * In the case of remote streams, the contents of this field depends
140 * on the version of the relay daemon peer. For 2.11+ peers, the
141 * contents are the same as in the local case. However, for legacy
142 * peers, this contains a path of the form:
143 * /hostname/session_path/ust/uid/1000/64-bit
145 char pathname
[PATH_MAX
];
147 char name
[LTTNG_SYMBOL_NAME_LEN
];
148 /* Relayd id of the channel. -1ULL if it does not apply. */
151 * Number of streams NOT initialized yet. This is used in order to not
152 * delete this channel if streams are getting initialized.
154 unsigned int nb_init_stream_left
;
155 /* Output type (mmap or splice). */
156 enum consumer_channel_output output
;
157 /* Channel type for stream */
158 enum consumer_channel_type type
;
161 uid_t ust_app_uid
; /* Application UID. */
162 struct ustctl_consumer_channel
*uchan
;
163 unsigned char uuid
[LTTNG_UUID_STR_LEN
];
165 * Temporary stream list used to store the streams once created and waiting
166 * to be sent to the session daemon by receiving the
167 * LTTNG_CONSUMER_GET_CHANNEL.
169 struct stream_list streams
;
172 * Set if the channel is metadata. We keep a reference to the stream
173 * because we have to flush data once pushed by the session daemon. For a
174 * regular channel, this is always set to NULL.
176 struct lttng_consumer_stream
*metadata_stream
;
180 /* Node within channel thread ht */
181 struct lttng_ht_node_u64 wait_fd_node
;
183 /* Metadata cache is metadata channel */
184 struct consumer_metadata_cache
*metadata_cache
;
186 /* For UST metadata periodical flush */
187 int switch_timer_enabled
;
188 timer_t switch_timer
;
189 int switch_timer_error
;
191 /* For the live mode */
192 int live_timer_enabled
;
194 int live_timer_error
;
196 /* For channel monitoring timer. */
197 int monitor_timer_enabled
;
198 timer_t monitor_timer
;
200 /* On-disk circular buffer */
201 uint64_t tracefile_size
;
202 uint64_t tracefile_count
;
204 * Monitor or not the streams of this channel meaning this indicates if the
205 * streams should be sent to the data/metadata thread or added to the no
206 * monitor list of the channel.
208 unsigned int monitor
;
213 * This lock protects against concurrent update of channel.
215 * This is nested INSIDE the consumer data lock.
216 * This is nested OUTSIDE the channel timer 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 lock
;
224 * Channel teardown lock.
226 * This lock protect against teardown of channel. It is _never_
227 * taken by the timer handler.
229 * This is nested INSIDE the consumer data lock.
230 * This is nested INSIDE the channel lock.
231 * This is nested OUTSIDE the metadata cache lock.
232 * This is nested OUTSIDE stream lock.
233 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
235 pthread_mutex_t timer_lock
;
237 /* Timer value in usec for live streaming. */
238 unsigned int live_timer_interval
;
242 char root_shm_path
[PATH_MAX
];
243 char shm_path
[PATH_MAX
];
244 /* Only set for UST channels. */
245 LTTNG_OPTIONAL(struct lttng_credentials
) buffer_credentials
;
246 /* Total number of discarded events for that channel. */
247 uint64_t discarded_events
;
248 /* Total number of missed packets due to overwriting (overwrite). */
249 uint64_t lost_packets
;
251 bool streams_sent_to_relayd
;
255 * Internal representation of the streams, sessiond_key is used to identify
258 struct lttng_consumer_stream
{
259 /* HT node used by the data_ht and metadata_ht */
260 struct lttng_ht_node_u64 node
;
261 /* stream indexed per channel key node */
262 struct lttng_ht_node_u64 node_channel_id
;
263 /* HT node used in consumer_data.stream_list_ht */
264 struct lttng_ht_node_u64 node_session_id
;
265 /* Pointer to associated channel. */
266 struct lttng_consumer_channel
*chan
;
268 * Current trace chunk. Holds a reference to the trace chunk.
269 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
270 * when it was created in the context of a no-output session.
272 struct lttng_trace_chunk
*trace_chunk
;
274 /* Key by which the stream is indexed for 'node'. */
277 * File descriptor of the data output file. This can be either a file or a
278 * socket fd for relayd streaming.
280 int out_fd
; /* output file to write the data */
281 /* Write position in the output file descriptor */
283 /* Amount of bytes written to the output */
284 uint64_t output_written
;
287 int hangup_flush_done
;
290 * Whether the stream is in a "complete" state (e.g. it does not have a
291 * partially written sub-buffer.
293 * Initialized to "false" on stream creation (first packet is empty).
295 * The various transitions of the quiescent state are:
296 * - On "start" tracing: set to false, since the stream is not
298 * - On "stop" tracing: if !quiescent -> flush FINAL (update
299 * timestamp_end), and set to true; the stream has entered a
300 * complete/quiescent state.
301 * - On "destroy" or stream/application hang-up: if !quiescent ->
302 * flush FINAL, and set to true.
304 * NOTE: Update and read are protected by the stream lock.
309 * True if the sequence number is not available (lttng-modules < 2.8).
311 bool sequence_number_unavailable
;
314 * metadata_timer_lock protects flags waiting_on_metadata and
315 * missed_metadata_flush.
317 pthread_mutex_t metadata_timer_lock
;
319 * Flag set when awaiting metadata to be pushed. Used in the
320 * timer thread to skip waiting on the stream (and stream lock) to
321 * ensure we can proceed to flushing metadata in live mode.
323 bool waiting_on_metadata
;
324 /* Raised when a timer misses a metadata flush. */
325 bool missed_metadata_flush
;
327 enum lttng_event_output output
;
328 /* Maximum subbuffer size (in bytes). */
329 unsigned long max_sb_size
;
332 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
333 * used for the mmap base and offset.
336 unsigned long mmap_len
;
341 /* Network sequence number. Indicating on which relayd socket it goes. */
342 uint64_t net_seq_idx
;
344 * Indicate if this stream was successfully sent to a relayd. This is set
345 * after the refcount of the relayd is incremented and is checked when the
346 * stream is closed before decrementing the refcount in order to avoid an
349 unsigned int sent_to_relayd
;
351 /* Identify if the stream is the metadata */
352 unsigned int metadata_flag
;
354 * Last known metadata version, reset the metadata file in case
357 uint64_t metadata_version
;
358 /* Used when the stream is set for network streaming */
359 uint64_t relayd_stream_id
;
361 * When sending a stream packet to a relayd, this number is used to track
362 * the packet sent by the consumer and seen by the relayd. When sending the
363 * data header to the relayd, this number is sent and if the transmission
364 * was successful, it is incremented.
366 * Even if the full data is not fully transmitted it won't matter since
367 * only two possible error can happen after that where either the relayd
368 * died or a read error is detected on the stream making this value useless
371 * This value SHOULD be read/updated atomically or with the lock acquired.
373 uint64_t next_net_seq_num
;
375 * Lock to use the stream FDs since they are used between threads.
377 * This is nested INSIDE the consumer_data lock.
378 * This is nested INSIDE the channel lock.
379 * This is nested INSIDE the channel timer lock.
380 * This is nested OUTSIDE the metadata cache lock.
381 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
383 pthread_mutex_t lock
;
384 /* Tracing session id */
387 * Indicates if the stream end point is still active or not (network
388 * streaming or local file system). The thread "owning" the stream is
389 * handling this status and can be notified of a state change through the
390 * consumer data appropriate pipe.
392 enum consumer_endpoint_status endpoint_status
;
393 /* Stream name. Format is: <channel_name>_<cpu_number> */
394 char name
[LTTNG_SYMBOL_NAME_LEN
];
395 /* Internal state of libustctl. */
396 struct ustctl_consumer_stream
*ustream
;
397 struct cds_list_head send_node
;
398 /* On-disk circular buffer */
399 uint64_t tracefile_size_current
;
400 uint64_t tracefile_count_current
;
402 * Monitor or not the streams of this channel meaning this indicates if the
403 * streams should be sent to the data/metadata thread or added to the no
404 * monitor list of the channel.
406 unsigned int monitor
;
408 * Indicate if the stream is globally visible meaning that it has been
409 * added to the multiple hash tables. If *not* set, NO lock should be
410 * acquired in the destroy path.
412 unsigned int globally_visible
;
414 * Pipe to wake up the metadata poll thread when the UST metadata
417 int ust_metadata_poll_pipe
[2];
419 * How much metadata was read from the metadata cache and sent
422 uint64_t ust_metadata_pushed
;
424 * Copy of the last discarded event value to detect the overflow of
427 uint64_t last_discarded_events
;
428 /* Copy of the sequence number of the last packet extracted. */
429 uint64_t last_sequence_number
;
431 * Index file object of the index file for this stream.
433 struct lttng_index_file
*index_file
;
436 * Local pipe to extract data when using splice.
441 * Rendez-vous point between data and metadata stream in live mode.
443 pthread_cond_t metadata_rdv
;
444 pthread_mutex_t metadata_rdv_lock
;
447 * rotate_position represents the packet sequence number of the last
448 * packet which belongs to the current trace chunk prior to the rotation.
449 * When that position is reached, this tracefile can be closed and a
450 * new one is created in channel_read_only_attributes.path.
452 uint64_t rotate_position
;
455 * Read-only copies of channel values. We cannot safely access the
456 * channel from a stream, so we need to have a local copy of these
457 * fields in the stream object. These fields should be removed from
458 * the stream objects when we introduce refcounting.
461 uint64_t tracefile_size
;
462 } channel_read_only_attributes
;
465 * Flag to inform the data or metadata thread that a stream is
466 * ready to be rotated.
470 /* Indicate if the stream still has some data to be read. */
471 unsigned int has_data
:1;
473 * Inform the consumer or relay to reset the metadata
474 * file before writing in it (regeneration).
476 unsigned int reset_metadata_flag
:1;
480 * Internal representation of a relayd socket pair.
482 struct consumer_relayd_sock_pair
{
483 /* Network sequence number. */
484 uint64_t net_seq_idx
;
485 /* Number of stream associated with this relayd */
489 * This flag indicates whether or not we should destroy this object. The
490 * destruction should ONLY occurs when this flag is set and the refcount is
493 unsigned int destroy_flag
;
496 * Mutex protecting the control socket to avoid out of order packets
497 * between threads sending data to the relayd. Since metadata data is sent
498 * over that socket, at least two sendmsg() are needed (header + data)
499 * creating a race for packets to overlap between threads using it.
501 * This is nested INSIDE the consumer_data lock.
502 * This is nested INSIDE the stream lock.
504 pthread_mutex_t ctrl_sock_mutex
;
506 /* Control socket. Command and metadata are passed over it */
507 struct lttcomm_relayd_sock control_sock
;
510 * We don't need a mutex at this point since we only splice or write single
511 * large chunk of data with a header appended at the begining. Moreover,
512 * this socket is for now only used in a single thread.
514 struct lttcomm_relayd_sock data_sock
;
515 struct lttng_ht_node_u64 node
;
517 /* Session id on both sides for the sockets. */
518 uint64_t relayd_session_id
;
519 uint64_t sessiond_session_id
;
520 struct lttng_consumer_local_data
*ctx
;
524 * UST consumer local data to the program. One or more instance per
527 struct lttng_consumer_local_data
{
529 * Function to call when data is available on a buffer.
530 * Returns the number of bytes read, or negative error value.
532 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
533 struct lttng_consumer_local_data
*ctx
);
535 * function to call when we receive a new channel, it receives a
536 * newly allocated channel, depending on the return code of this
537 * function, the new channel will be handled by the application
541 * > 0 (success, FD is kept by application)
542 * == 0 (success, FD is left to library)
545 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
547 * function to call when we receive a new stream, it receives a
548 * newly allocated stream, depending on the return code of this
549 * function, the new stream will be handled by the application
553 * > 0 (success, FD is kept by application)
554 * == 0 (success, FD is left to library)
557 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
559 * function to call when a stream is getting updated by the session
560 * daemon, this function receives the sessiond key and the new
561 * state, depending on the return code of this function the
562 * update of state for the stream is handled by the application
566 * > 0 (success, FD is kept by application)
567 * == 0 (success, FD is left to library)
570 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
571 enum lttng_consumer_type type
;
572 /* socket to communicate errors with sessiond */
573 int consumer_error_socket
;
574 /* socket to ask metadata to sessiond. */
575 int consumer_metadata_socket
;
577 * Protect consumer_metadata_socket.
579 * This is nested OUTSIDE the metadata cache lock.
581 pthread_mutex_t metadata_socket_lock
;
582 /* socket to exchange commands with sessiond */
583 char *consumer_command_sock_path
;
584 /* communication with splice */
585 int consumer_channel_pipe
[2];
586 /* Data stream poll thread pipe. To transfer data stream to the thread */
587 struct lttng_pipe
*consumer_data_pipe
;
590 * Data thread use that pipe to catch wakeup from read subbuffer that
591 * detects that there is still data to be read for the stream encountered.
592 * Before doing so, the stream is flagged to indicate that there is still
595 * Both pipes (read/write) are owned and used inside the data thread.
597 struct lttng_pipe
*consumer_wakeup_pipe
;
598 /* Indicate if the wakeup thread has been notified. */
599 unsigned int has_wakeup
:1;
601 /* to let the signal handler wake up the fd receiver thread */
602 int consumer_should_quit
[2];
603 /* Metadata poll thread pipe. Transfer metadata stream to it */
604 struct lttng_pipe
*consumer_metadata_pipe
;
606 * Pipe used by the channel monitoring timers to provide state samples
607 * to the session daemon (write-only).
609 int channel_monitor_pipe
;
610 LTTNG_OPTIONAL(lttng_uuid
) sessiond_uuid
;
614 * Library-level data. One instance per process.
616 struct lttng_consumer_global_data
{
618 * At this time, this lock is used to ensure coherence between the count
619 * and number of element in the hash table. It's also a protection for
620 * concurrent read/write between threads.
622 * This is nested OUTSIDE the stream lock.
623 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
625 pthread_mutex_t lock
;
628 * Number of streams in the data stream hash table declared outside.
629 * Protected by consumer_data.lock.
633 /* Channel hash table protected by consumer_data.lock. */
634 struct lttng_ht
*channel_ht
;
635 /* Channel hash table indexed by session id. */
636 struct lttng_ht
*channels_by_session_id_ht
;
638 * Flag specifying if the local array of FDs needs update in the
639 * poll function. Protected by consumer_data.lock.
641 unsigned int need_update
;
642 enum lttng_consumer_type type
;
645 * Relayd socket(s) hashtable indexed by network sequence number. Each
646 * stream has an index which associate the right relayd socket to use.
648 struct lttng_ht
*relayd_ht
;
651 * This hash table contains all streams (metadata and data) indexed by
652 * session id. In other words, the ht is indexed by session id and each
653 * bucket contains the list of associated streams.
655 * This HT uses the "node_session_id" of the consumer stream.
657 struct lttng_ht
*stream_list_ht
;
660 * This HT uses the "node_channel_id" of the consumer stream.
662 struct lttng_ht
*stream_per_chan_id_ht
;
665 * Trace chunk registry indexed by (session_id, chunk_id).
667 struct lttng_trace_chunk_registry
*chunk_registry
;
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
;
677 * Set to nonzero when the consumer is exiting. Updated by signal
678 * handler and thread exit, read by threads.
680 extern int consumer_quit
;
682 /* Flag used to temporarily pause data consumption from testpoints. */
683 extern int data_consumption_paused
;
685 /* Return a human-readable consumer type string that is suitable for logging. */
687 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
690 case LTTNG_CONSUMER_UNKNOWN
:
692 case LTTNG_CONSUMER_KERNEL
:
694 case LTTNG_CONSUMER32_UST
:
695 return "32-bit user space";
696 case LTTNG_CONSUMER64_UST
:
697 return "64-bit user space";
704 * Init consumer data structures.
706 int lttng_consumer_init(void);
709 * Set the error socket for communication with a session daemon.
711 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
715 * Set the command socket path for communication with a session daemon.
717 void lttng_consumer_set_command_sock_path(
718 struct lttng_consumer_local_data
*ctx
, char *sock
);
721 * Send return code to session daemon.
723 * Returns the return code of sendmsg : the number of bytes transmitted or -1
726 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
729 * Called from signal handler to ensure a clean exit.
731 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
734 * Cleanup the daemon's socket on exit.
736 void lttng_consumer_cleanup(void);
739 * Poll on the should_quit pipe and the command socket return -1 on error and
740 * should exit, 0 if data is available on the command socket
742 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
745 * Copy the fields from the channel that need to be accessed (read-only)
746 * directly from the stream.
748 void consumer_stream_update_channel_attributes(
749 struct lttng_consumer_stream
*stream
,
750 struct lttng_consumer_channel
*channel
);
752 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
754 const char *channel_name
,
757 struct lttng_trace_chunk
*trace_chunk
,
760 enum consumer_channel_type type
,
761 unsigned int monitor
);
762 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
764 const uint64_t *chunk_id
,
765 const char *pathname
,
768 enum lttng_event_output output
,
769 uint64_t tracefile_size
,
770 uint64_t tracefile_count
,
771 uint64_t session_id_per_pid
,
772 unsigned int monitor
,
773 unsigned int live_timer_interval
,
774 const char *root_shm_path
,
775 const char *shm_path
);
776 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
777 struct lttng_ht
*ht
);
778 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
779 struct lttng_ht
*ht
);
780 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
781 struct lttng_consumer_local_data
*ctx
);
782 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
784 /* lttng-relayd consumer command */
785 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
786 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
787 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
788 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
789 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
790 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
792 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
794 struct lttng_consumer_local_data
*lttng_consumer_create(
795 enum lttng_consumer_type type
,
796 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
797 struct lttng_consumer_local_data
*ctx
),
798 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
799 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
800 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
801 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
802 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
803 struct lttng_consumer_local_data
*ctx
,
804 struct lttng_consumer_stream
*stream
, unsigned long len
,
805 unsigned long padding
,
806 struct ctf_packet_index
*index
);
807 ssize_t
lttng_consumer_on_read_subbuffer_splice(
808 struct lttng_consumer_local_data
*ctx
,
809 struct lttng_consumer_stream
*stream
, unsigned long len
,
810 unsigned long padding
,
811 struct ctf_packet_index
*index
);
812 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
813 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
814 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
816 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
818 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
819 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
820 void *consumer_thread_metadata_poll(void *data
);
821 void *consumer_thread_data_poll(void *data
);
822 void *consumer_thread_sessiond_poll(void *data
);
823 void *consumer_thread_channel_poll(void *data
);
824 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
825 int sock
, struct pollfd
*consumer_sockpoll
);
827 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
828 struct lttng_consumer_local_data
*ctx
);
829 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
830 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
831 struct lttng_consumer_local_data
*ctx
, int sock
,
832 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
833 uint64_t sessiond_id
, uint64_t relayd_session_id
);
834 void consumer_flag_relayd_for_destroy(
835 struct consumer_relayd_sock_pair
*relayd
);
836 int consumer_data_pending(uint64_t id
);
837 int consumer_send_status_msg(int sock
, int ret_code
);
838 int consumer_send_status_channel(int sock
,
839 struct lttng_consumer_channel
*channel
);
840 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
842 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
843 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
844 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
845 uint64_t max_sb_size
);
846 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
847 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
848 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
849 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
850 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
851 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
852 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
853 struct lttng_consumer_local_data
*ctx
);
854 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
855 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
856 struct lttng_consumer_stream
*stream
);
857 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
858 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
859 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
860 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
861 const uint64_t *relayd_id
, uint64_t session_id
,
863 time_t chunk_creation_timestamp
,
864 const char *chunk_override_name
,
865 const struct lttng_credentials
*credentials
,
866 struct lttng_directory_handle
*chunk_directory_handle
);
867 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
868 const uint64_t *relayd_id
, uint64_t session_id
,
869 uint64_t chunk_id
, time_t chunk_close_timestamp
,
870 const enum lttng_trace_chunk_command_type
*close_command
,
872 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
873 const uint64_t *relayd_id
, uint64_t session_id
,
875 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
876 enum lttcomm_return_code
lttng_consumer_init_command(
877 struct lttng_consumer_local_data
*ctx
,
878 const lttng_uuid sessiond_uuid
);
879 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
);
881 #endif /* LIB_CONSUMER_H */