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>
36 #include <common/buffer-view.h>
37 #include <common/optional.h>
39 struct lttng_consumer_local_data
;
41 /* Commands for consumer */
42 enum lttng_consumer_command
{
43 LTTNG_CONSUMER_ADD_CHANNEL
,
44 LTTNG_CONSUMER_ADD_STREAM
,
45 /* pause, delete, active depending on fd state */
46 LTTNG_CONSUMER_UPDATE_STREAM
,
47 /* inform the consumer to quit when all fd has hang up */
48 LTTNG_CONSUMER_STOP
, /* deprecated */
49 LTTNG_CONSUMER_ADD_RELAYD_SOCKET
,
50 /* Inform the consumer to kill a specific relayd connection */
51 LTTNG_CONSUMER_DESTROY_RELAYD
,
52 /* Return to the sessiond if there is data pending for a session */
53 LTTNG_CONSUMER_DATA_PENDING
,
54 /* Consumer creates a channel and returns it to sessiond. */
55 LTTNG_CONSUMER_ASK_CHANNEL_CREATION
,
56 LTTNG_CONSUMER_GET_CHANNEL
,
57 LTTNG_CONSUMER_DESTROY_CHANNEL
,
58 LTTNG_CONSUMER_PUSH_METADATA
,
59 LTTNG_CONSUMER_CLOSE_METADATA
,
60 LTTNG_CONSUMER_SETUP_METADATA
,
61 LTTNG_CONSUMER_FLUSH_CHANNEL
,
62 LTTNG_CONSUMER_SNAPSHOT_CHANNEL
,
63 LTTNG_CONSUMER_SNAPSHOT_METADATA
,
64 LTTNG_CONSUMER_STREAMS_SENT
,
65 LTTNG_CONSUMER_DISCARDED_EVENTS
,
66 LTTNG_CONSUMER_LOST_PACKETS
,
67 LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
,
68 LTTNG_CONSUMER_CHANNEL_STOP_LIVE_TIMER
,
69 LTTNG_CONSUMER_CHANNEL_START_LIVE_TIMER
,
72 /* State of each fd in consumer */
73 enum lttng_consumer_stream_state
{
74 LTTNG_CONSUMER_ACTIVE_STREAM
,
75 LTTNG_CONSUMER_PAUSE_STREAM
,
76 LTTNG_CONSUMER_DELETE_STREAM
,
79 enum lttng_consumer_type
{
80 LTTNG_CONSUMER_UNKNOWN
= 0,
81 LTTNG_CONSUMER_KERNEL
,
86 enum consumer_endpoint_status
{
87 CONSUMER_ENDPOINT_ACTIVE
,
88 CONSUMER_ENDPOINT_INACTIVE
,
91 enum consumer_channel_output
{
92 CONSUMER_CHANNEL_MMAP
= 0,
93 CONSUMER_CHANNEL_SPLICE
= 1,
96 enum consumer_channel_type
{
97 CONSUMER_CHANNEL_TYPE_METADATA
= 0,
98 CONSUMER_CHANNEL_TYPE_DATA
= 1,
101 extern struct lttng_consumer_global_data consumer_data
;
104 struct cds_list_head head
;
109 struct consumer_metadata_cache
;
111 struct lttng_consumer_channel
{
112 /* HT node used for consumer_data.channel_ht */
113 struct lttng_ht_node_u64 node
;
114 /* Indexed key. Incremented value in the consumer. */
116 /* Number of streams referencing this channel */
118 /* Tracing session id on the session daemon side. */
121 * Session id when requesting metadata to the session daemon for
122 * a session with per-PID buffers.
124 uint64_t session_id_per_pid
;
125 /* Channel trace file path name. */
126 char pathname
[PATH_MAX
];
128 char name
[LTTNG_SYMBOL_NAME_LEN
];
129 /* UID and GID of the session owning this channel. */
132 /* Relayd id of the channel. -1ULL if it does not apply. */
135 * Number of streams NOT initialized yet. This is used in order to not
136 * delete this channel if streams are getting initialized.
138 unsigned int nb_init_stream_left
;
139 /* Output type (mmap or splice). */
140 enum consumer_channel_output output
;
141 /* Channel type for stream */
142 enum consumer_channel_type type
;
145 uid_t ust_app_uid
; /* Application UID. */
146 struct ustctl_consumer_channel
*uchan
;
147 unsigned char uuid
[UUID_STR_LEN
];
149 * Temporary stream list used to store the streams once created and waiting
150 * to be sent to the session daemon by receiving the
151 * LTTNG_CONSUMER_GET_CHANNEL.
153 struct stream_list streams
;
156 * Set if the channel is metadata. We keep a reference to the stream
157 * because we have to flush data once pushed by the session daemon. For a
158 * regular channel, this is always set to NULL.
160 struct lttng_consumer_stream
*metadata_stream
;
164 /* Node within channel thread ht */
165 struct lttng_ht_node_u64 wait_fd_node
;
167 /* Metadata cache is metadata channel */
168 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
;
178 /* Channel is part of a live session ? */
181 /* On-disk circular buffer */
182 uint64_t tracefile_size
;
183 uint64_t tracefile_count
;
185 * Monitor or not the streams of this channel meaning this indicates if the
186 * streams should be sent to the data/metadata thread or added to the no
187 * monitor list of the channel.
189 unsigned int monitor
;
194 * This lock protects against concurrent update of channel.
196 * This is nested INSIDE the consumer data lock.
197 * This is nested OUTSIDE the channel timer lock.
198 * This is nested OUTSIDE the metadata cache lock.
199 * This is nested OUTSIDE stream lock.
200 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
202 pthread_mutex_t lock
;
205 * Channel teardown lock.
207 * This lock protect against teardown of channel. It is _never_
208 * taken by the timer handler.
210 * This is nested INSIDE the consumer data lock.
211 * This is nested INSIDE the channel lock.
212 * This is nested OUTSIDE the metadata cache lock.
213 * This is nested OUTSIDE stream lock.
214 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
216 pthread_mutex_t timer_lock
;
218 /* Timer value in usec for live streaming. */
219 unsigned int live_timer_interval
;
223 char root_shm_path
[PATH_MAX
];
224 char shm_path
[PATH_MAX
];
225 /* Total number of discarded events for that channel. */
226 uint64_t discarded_events
;
227 /* Total number of missed packets due to overwriting (overwrite). */
228 uint64_t lost_packets
;
230 bool streams_sent_to_relayd
;
233 struct stream_subbuffer
{
236 * CONSUMER_CHANNEL_SPLICE
237 * No ownership assumed.
240 /* CONSUMER_CHANNEL_MMAP */
241 struct lttng_buffer_view buffer
;
245 * Common members are fine to access through either
246 * union entries (as per C11, Common Initial Sequence).
249 unsigned long subbuf_size
;
250 unsigned long padded_subbuf_size
;
253 * Left unset when unsupported.
255 * Indicates that this is the last sub-buffer of
256 * a series of sub-buffer that makes-up a coherent
257 * (parseable) unit of metadata.
259 LTTNG_OPTIONAL(bool) coherent
;
262 unsigned long subbuf_size
;
263 unsigned long padded_subbuf_size
;
264 uint64_t packet_size
;
265 uint64_t content_size
;
266 uint64_t timestamp_begin
;
267 uint64_t timestamp_end
;
268 uint64_t events_discarded
;
269 /* Left unset when unsupported. */
270 LTTNG_OPTIONAL(uint64_t) sequence_number
;
272 /* Left unset when unsupported. */
273 LTTNG_OPTIONAL(uint64_t) stream_instance_id
;
279 * Perform any operation required to acknowledge
280 * the wake-up of a consumer stream (e.g. consume a byte on a wake-up pipe).
282 * Stream and channel locks are acquired during this call.
284 typedef int (*on_wake_up_cb
)(struct lttng_consumer_stream
*);
287 * Perform any operation required before a consumer stream is put
288 * to sleep before awaiting a data availability notification.
290 * Stream and channel locks are acquired during this call.
292 typedef int (*on_sleep_cb
)(struct lttng_consumer_stream
*,
293 struct lttng_consumer_local_data
*);
296 * Acquire the subbuffer at the current 'consumed' position.
298 * Stream and channel locks are acquired during this call.
300 typedef int (*get_next_subbuffer_cb
)(struct lttng_consumer_stream
*,
301 struct stream_subbuffer
*);
304 * Populate the stream_subbuffer's info member. The info to populate
305 * depends on the type (metadata/data) of the stream.
307 * Stream and channel locks are acquired during this call.
309 typedef int (*extract_subbuffer_info_cb
)(
310 struct lttng_consumer_stream
*, struct stream_subbuffer
*);
313 * Invoked after a subbuffer's info has been filled.
315 * Stream and channel locks are acquired during this call.
317 typedef int (*pre_consume_subbuffer_cb
)(struct lttng_consumer_stream
*,
318 const struct stream_subbuffer
*);
321 * Consume subbuffer contents.
323 * Stream and channel locks are acquired during this call.
325 typedef ssize_t (*consume_subbuffer_cb
)(struct lttng_consumer_local_data
*,
326 struct lttng_consumer_stream
*,
327 const struct stream_subbuffer
*);
330 * Release the current subbuffer and advance the 'consumed' position by
333 * Stream and channel locks are acquired during this call.
335 typedef int (*put_next_subbuffer_cb
)(struct lttng_consumer_stream
*,
336 struct stream_subbuffer
*);
339 * Invoked after consuming a subbuffer.
341 * Stream and channel locks are acquired during this call.
343 typedef int (*post_consume_cb
)(struct lttng_consumer_stream
*,
344 const struct stream_subbuffer
*,
345 struct lttng_consumer_local_data
*);
348 * Send a live beacon if no data is available.
350 * Stream and channel locks are acquired during this call.
352 typedef int (*send_live_beacon_cb
)(struct lttng_consumer_stream
*);
355 * Lock the stream and channel locks and any other stream-type specific
356 * lock that need to be acquired during the processing of an
357 * availability notification.
359 typedef void (*lock_cb
)(struct lttng_consumer_stream
*);
362 * Unlock the stream and channel locks and any other stream-type specific
363 * lock before sleeping until the next availability notification.
365 * Stream and channel locks are acquired during this call.
367 typedef void (*unlock_cb
)(struct lttng_consumer_stream
*);
370 * Invoked when a subbuffer's metadata version does not match the last
371 * known metadata version.
373 * Stream and channel locks are acquired during this call.
375 typedef void (*reset_metadata_cb
)(struct lttng_consumer_stream
*);
378 * Internal representation of the streams, sessiond_key is used to identify
381 struct lttng_consumer_stream
{
382 /* HT node used by the data_ht and metadata_ht */
383 struct lttng_ht_node_u64 node
;
384 /* stream indexed per channel key node */
385 struct lttng_ht_node_u64 node_channel_id
;
386 /* HT node used in consumer_data.stream_list_ht */
387 struct lttng_ht_node_u64 node_session_id
;
388 /* Pointer to associated channel. */
389 struct lttng_consumer_channel
*chan
;
391 /* Key by which the stream is indexed for 'node'. */
394 * File descriptor of the data output file. This can be either a file or a
395 * socket fd for relayd streaming.
397 int out_fd
; /* output file to write the data */
398 /* Write position in the output file descriptor */
400 /* Amount of bytes written to the output */
401 uint64_t output_written
;
402 enum lttng_consumer_stream_state state
;
405 int hangup_flush_done
;
408 * Whether the stream is in a "complete" state (e.g. it does not have a
409 * partially written sub-buffer.
411 * Initialized to "false" on stream creation (first packet is empty).
413 * The various transitions of the quiescent state are:
414 * - On "start" tracing: set to false, since the stream is not
416 * - On "stop" tracing: if !quiescent -> flush FINAL (update
417 * timestamp_end), and set to true; the stream has entered a
418 * complete/quiescent state.
419 * - On "destroy" or stream/application hang-up: if !quiescent ->
420 * flush FINAL, and set to true.
422 * NOTE: Update and read are protected by the stream lock.
427 * metadata_timer_lock protects flags waiting_on_metadata and
428 * missed_metadata_flush.
430 pthread_mutex_t metadata_timer_lock
;
432 * Flag set when awaiting metadata to be pushed. Used in the
433 * timer thread to skip waiting on the stream (and stream lock) to
434 * ensure we can proceed to flushing metadata in live mode.
436 bool waiting_on_metadata
;
437 /* Raised when a timer misses a metadata flush. */
438 bool missed_metadata_flush
;
440 enum lttng_event_output output
;
441 /* Maximum subbuffer size. */
442 unsigned long max_sb_size
;
445 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
446 * used for the mmap base and offset.
449 unsigned long mmap_len
;
454 /* UID/GID of the user owning the session to which stream belongs */
458 * Relayd id, indicating on which relayd socket it goes. Set to -1ULL if
459 * not the stream is not associated to a relay daemon.
463 * Indicate if this stream was successfully sent to a relayd. This is set
464 * after the refcount of the relayd is incremented and is checked when the
465 * stream is closed before decrementing the refcount in order to avoid an
468 unsigned int sent_to_relayd
;
470 /* Identify if the stream is the metadata */
471 unsigned int metadata_flag
;
473 * Last known metadata version, reset the metadata file in case
476 uint64_t metadata_version
;
477 /* Used when the stream is set for network streaming */
478 uint64_t relayd_stream_id
;
480 * When sending a stream packet to a relayd, this number is used to track
481 * the packet sent by the consumer and seen by the relayd. When sending the
482 * data header to the relayd, this number is sent and if the transmission
483 * was successful, it is incremented.
485 * Even if the full data is not fully transmitted it won't matter since
486 * only two possible error can happen after that where either the relayd
487 * died or a read error is detected on the stream making this value useless
490 * This value SHOULD be read/updated atomically or with the lock acquired.
492 uint64_t next_net_seq_num
;
494 * Lock to use the stream FDs since they are used between threads.
496 * This is nested INSIDE the consumer_data lock.
497 * This is nested INSIDE the channel lock.
498 * This is nested INSIDE the channel timer lock.
499 * This is nested OUTSIDE the metadata cache lock.
500 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
502 pthread_mutex_t lock
;
503 /* Tracing session id */
506 * Indicates if the stream end point is still active or not (network
507 * streaming or local file system). The thread "owning" the stream is
508 * handling this status and can be notified of a state change through the
509 * consumer data appropriate pipe.
511 enum consumer_endpoint_status endpoint_status
;
512 /* Stream name. Format is: <channel_name>_<cpu_number> */
513 char name
[LTTNG_SYMBOL_NAME_LEN
];
514 /* Internal state of libustctl. */
515 struct ustctl_consumer_stream
*ustream
;
516 struct cds_list_head send_node
;
517 /* On-disk circular buffer */
518 uint64_t tracefile_size_current
;
519 uint64_t tracefile_count_current
;
521 * Monitor or not the streams of this channel meaning this indicates if the
522 * streams should be sent to the data/metadata thread or added to the no
523 * monitor list of the channel.
525 unsigned int monitor
;
527 * Indicate if the stream is globally visible meaning that it has been
528 * added to the multiple hash tables. If *not* set, NO lock should be
529 * acquired in the destroy path.
531 unsigned int globally_visible
;
533 * Pipe to wake up the metadata poll thread when the UST metadata
536 int ust_metadata_poll_pipe
[2];
538 * How much metadata was read from the metadata cache and sent
541 uint64_t ust_metadata_pushed
;
543 * Copy of the last discarded event value to detect the overflow of
546 uint64_t last_discarded_events
;
547 /* Copy of the sequence number of the last packet extracted. */
548 uint64_t last_sequence_number
;
550 * Index file object of the index file for this stream.
552 struct lttng_index_file
*index_file
;
555 * Local pipe to extract data when using splice.
560 * Rendez-vous point between data and metadata stream in live mode.
562 pthread_cond_t metadata_rdv
;
563 pthread_mutex_t metadata_rdv_lock
;
565 /* Indicate if the stream still has some data to be read. */
566 unsigned int has_data
:1;
568 * Inform the consumer or relay to reset the metadata
569 * file before writing in it (regeneration).
571 unsigned int reset_metadata_flag
:1;
574 * Invoked in the order of declaration.
575 * See callback type definitions.
578 on_wake_up_cb on_wake_up
;
579 get_next_subbuffer_cb get_next_subbuffer
;
580 extract_subbuffer_info_cb extract_subbuffer_info
;
581 pre_consume_subbuffer_cb pre_consume_subbuffer
;
582 reset_metadata_cb reset_metadata
;
583 consume_subbuffer_cb consume_subbuffer
;
584 put_next_subbuffer_cb put_next_subbuffer
;
585 post_consume_cb post_consume
;
586 send_live_beacon_cb send_live_beacon
;
587 on_sleep_cb on_sleep
;
589 } read_subbuffer_ops
;
590 struct metadata_bucket
*metadata_bucket
;
594 * Internal representation of a relayd socket pair.
596 struct consumer_relayd_sock_pair
{
597 /* Network sequence number. */
599 /* Number of stream associated with this relayd */
603 * This flag indicates whether or not we should destroy this object. The
604 * destruction should ONLY occurs when this flag is set and the refcount is
607 unsigned int destroy_flag
;
610 * Mutex protecting the control socket to avoid out of order packets
611 * between threads sending data to the relayd. Since metadata data is sent
612 * over that socket, at least two sendmsg() are needed (header + data)
613 * creating a race for packets to overlap between threads using it.
615 * This is nested INSIDE the consumer_data lock.
616 * This is nested INSIDE the stream lock.
618 pthread_mutex_t ctrl_sock_mutex
;
620 /* Control socket. Command and metadata are passed over it */
621 struct lttcomm_relayd_sock control_sock
;
624 * We don't need a mutex at this point since we only splice or write single
625 * large chunk of data with a header appended at the begining. Moreover,
626 * this socket is for now only used in a single thread.
628 struct lttcomm_relayd_sock data_sock
;
629 struct lttng_ht_node_u64 node
;
631 /* Session id on both sides for the sockets. */
632 uint64_t relayd_session_id
;
633 uint64_t sessiond_session_id
;
634 struct lttng_consumer_local_data
*ctx
;
638 * UST consumer local data to the program. One or more instance per
641 struct lttng_consumer_local_data
{
643 * Function to call when data is available on a buffer.
644 * Returns the number of bytes read, or negative error value.
646 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
647 struct lttng_consumer_local_data
*ctx
,
648 bool locked_by_caller
);
650 * function to call when we receive a new channel, it receives a
651 * newly allocated channel, depending on the return code of this
652 * function, the new channel will be handled by the application
656 * > 0 (success, FD is kept by application)
657 * == 0 (success, FD is left to library)
660 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
662 * function to call when we receive a new stream, it receives a
663 * newly allocated stream, depending on the return code of this
664 * function, the new stream will be handled by the application
668 * > 0 (success, FD is kept by application)
669 * == 0 (success, FD is left to library)
672 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
674 * function to call when a stream is getting updated by the session
675 * daemon, this function receives the sessiond key and the new
676 * state, depending on the return code of this function the
677 * update of state for the stream is handled by the application
681 * > 0 (success, FD is kept by application)
682 * == 0 (success, FD is left to library)
685 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
686 enum lttng_consumer_type type
;
687 /* socket to communicate errors with sessiond */
688 int consumer_error_socket
;
689 /* socket to ask metadata to sessiond. */
690 int consumer_metadata_socket
;
692 * Protect consumer_metadata_socket.
694 * This is nested OUTSIDE the metadata cache lock.
696 pthread_mutex_t metadata_socket_lock
;
697 /* socket to exchange commands with sessiond */
698 char *consumer_command_sock_path
;
699 /* communication with splice */
700 int consumer_channel_pipe
[2];
701 /* Data stream poll thread pipe. To transfer data stream to the thread */
702 struct lttng_pipe
*consumer_data_pipe
;
705 * Data thread use that pipe to catch wakeup from read subbuffer that
706 * detects that there is still data to be read for the stream encountered.
707 * Before doing so, the stream is flagged to indicate that there is still
710 * Both pipes (read/write) are owned and used inside the data thread.
712 struct lttng_pipe
*consumer_wakeup_pipe
;
713 /* Indicate if the wakeup thread has been notified. */
714 unsigned int has_wakeup
:1;
716 /* to let the signal handler wake up the fd receiver thread */
717 int consumer_should_quit
[2];
718 /* Metadata poll thread pipe. Transfer metadata stream to it */
719 struct lttng_pipe
*consumer_metadata_pipe
;
723 * Library-level data. One instance per process.
725 struct lttng_consumer_global_data
{
727 * At this time, this lock is used to ensure coherence between the count
728 * and number of element in the hash table. It's also a protection for
729 * concurrent read/write between threads.
731 * This is nested OUTSIDE the stream lock.
732 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
734 pthread_mutex_t lock
;
737 * Number of streams in the data stream hash table declared outside.
738 * Protected by consumer_data.lock.
742 /* Channel hash table protected by consumer_data.lock. */
743 struct lttng_ht
*channel_ht
;
745 * Flag specifying if the local array of FDs needs update in the
746 * poll function. Protected by consumer_data.lock.
748 unsigned int need_update
;
749 enum lttng_consumer_type type
;
752 * Relayd socket(s) hashtable indexed by network sequence number. Each
753 * stream has an index which associate the right relayd socket to use.
755 struct lttng_ht
*relayd_ht
;
758 * This hash table contains all streams (metadata and data) indexed by
759 * session id. In other words, the ht is indexed by session id and each
760 * bucket contains the list of associated streams.
762 * This HT uses the "node_session_id" of the consumer stream.
764 struct lttng_ht
*stream_list_ht
;
767 * This HT uses the "node_channel_id" of the consumer stream.
769 struct lttng_ht
*stream_per_chan_id_ht
;
773 * Set to nonzero when the consumer is exiting. Updated by signal
774 * handler and thread exit, read by threads.
776 extern volatile int consumer_quit
;
779 * Init consumer data structures.
781 int lttng_consumer_init(void);
784 * Set the error socket for communication with a session daemon.
786 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
790 * Set the command socket path for communication with a session daemon.
792 void lttng_consumer_set_command_sock_path(
793 struct lttng_consumer_local_data
*ctx
, char *sock
);
796 * Send return code to session daemon.
798 * Returns the return code of sendmsg : the number of bytes transmitted or -1
801 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
804 * Called from signal handler to ensure a clean exit.
806 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
809 * Cleanup the daemon's socket on exit.
811 void lttng_consumer_cleanup(void);
814 * Poll on the should_quit pipe and the command socket return -1 on error and
815 * should exit, 0 if data is available on the command socket
817 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
819 struct lttng_consumer_stream
*consumer_allocate_stream(
820 struct lttng_consumer_channel
*channel
,
821 uint64_t channel_key
,
823 enum lttng_consumer_stream_state state
,
824 const char *channel_name
,
831 enum consumer_channel_type type
,
832 unsigned int monitor
);
833 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
835 const char *pathname
,
840 enum lttng_event_output output
,
841 uint64_t tracefile_size
,
842 uint64_t tracefile_count
,
843 uint64_t session_id_per_pid
,
844 unsigned int monitor
,
845 unsigned int live_timer_interval
,
846 bool is_in_live_session
,
847 const char *root_shm_path
,
848 const char *shm_path
);
849 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
850 struct lttng_ht
*ht
);
851 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
852 struct lttng_ht
*ht
);
853 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
854 struct lttng_consumer_local_data
*ctx
);
855 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
857 /* lttng-relayd consumer command */
858 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
859 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
860 int consumer_send_relayd_streams_sent(uint64_t relayd_id
);
861 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
862 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
863 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
865 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
867 struct lttng_consumer_local_data
*lttng_consumer_create(
868 enum lttng_consumer_type type
,
869 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
870 struct lttng_consumer_local_data
*ctx
,
871 bool locked_by_caller
),
872 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
873 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
874 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
875 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
876 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
877 struct lttng_consumer_stream
*stream
,
878 const struct lttng_buffer_view
*buffer
,
879 unsigned long padding
);
880 ssize_t
lttng_consumer_on_read_subbuffer_splice(
881 struct lttng_consumer_local_data
*ctx
,
882 struct lttng_consumer_stream
*stream
, unsigned long len
,
883 unsigned long padding
);
884 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
885 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
887 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
888 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
889 void *consumer_thread_metadata_poll(void *data
);
890 void *consumer_thread_data_poll(void *data
);
891 void *consumer_thread_sessiond_poll(void *data
);
892 void *consumer_thread_channel_poll(void *data
);
893 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
894 int sock
, struct pollfd
*consumer_sockpoll
);
896 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
897 struct lttng_consumer_local_data
*ctx
,
898 bool locked_by_caller
);
899 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
900 void consumer_add_relayd_socket(uint64_t relayd_id
, int sock_type
,
901 struct lttng_consumer_local_data
*ctx
, int sock
,
902 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
903 uint64_t sessiond_id
, uint64_t relayd_session_id
);
904 void consumer_flag_relayd_for_destroy(
905 struct consumer_relayd_sock_pair
*relayd
);
906 int consumer_data_pending(uint64_t id
);
907 int consumer_send_status_msg(int sock
, int ret_code
);
908 int consumer_send_status_channel(int sock
,
909 struct lttng_consumer_channel
*channel
);
910 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
912 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
913 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
914 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
915 uint64_t max_sb_size
);
916 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
917 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
918 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
919 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
920 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
921 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
922 int consumer_send_relayd_channel_bulk(struct lttng_consumer_channel
*channel
);
924 #endif /* LIB_CONSUMER_H */