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>
39 #include <common/buffer-view.h>
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_SET_CHANNEL_MONITOR_PIPE
,
69 LTTNG_CONSUMER_ROTATE_CHANNEL
,
71 LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
72 LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
73 LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
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
[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
;
195 /* Channel is part of a live session ? */
198 /* For channel monitoring timer. */
199 int monitor_timer_enabled
;
200 timer_t monitor_timer
;
202 /* On-disk circular buffer */
203 uint64_t tracefile_size
;
204 uint64_t tracefile_count
;
206 * Monitor or not the streams of this channel meaning this indicates if the
207 * streams should be sent to the data/metadata thread or added to the no
208 * monitor list of the channel.
210 unsigned int monitor
;
215 * This lock protects against concurrent update of channel.
217 * This is nested INSIDE the consumer data lock.
218 * This is nested OUTSIDE the channel timer lock.
219 * This is nested OUTSIDE the metadata cache lock.
220 * This is nested OUTSIDE stream lock.
221 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
223 pthread_mutex_t lock
;
226 * Channel teardown lock.
228 * This lock protect against teardown of channel. It is _never_
229 * taken by the timer handler.
231 * This is nested INSIDE the consumer data lock.
232 * This is nested INSIDE the channel lock.
233 * This is nested OUTSIDE the metadata cache lock.
234 * This is nested OUTSIDE stream lock.
235 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
237 pthread_mutex_t timer_lock
;
239 /* Timer value in usec for live streaming. */
240 unsigned int live_timer_interval
;
244 char root_shm_path
[PATH_MAX
];
245 char shm_path
[PATH_MAX
];
246 /* Only set for UST channels. */
247 LTTNG_OPTIONAL(struct lttng_credentials
) buffer_credentials
;
248 /* Total number of discarded events for that channel. */
249 uint64_t discarded_events
;
250 /* Total number of missed packets due to overwriting (overwrite). */
251 uint64_t lost_packets
;
253 bool streams_sent_to_relayd
;
257 * Internal representation of the streams, sessiond_key is used to identify
260 struct lttng_consumer_stream
{
261 /* HT node used by the data_ht and metadata_ht */
262 struct lttng_ht_node_u64 node
;
263 /* stream indexed per channel key node */
264 struct lttng_ht_node_u64 node_channel_id
;
265 /* HT node used in consumer_data.stream_list_ht */
266 struct lttng_ht_node_u64 node_session_id
;
267 /* Pointer to associated channel. */
268 struct lttng_consumer_channel
*chan
;
270 * Current trace chunk. Holds a reference to the trace chunk.
271 * `chunk` can be NULL when a stream is not associated to a chunk, e.g.
272 * when it was created in the context of a no-output session.
274 struct lttng_trace_chunk
*trace_chunk
;
276 /* Key by which the stream is indexed for 'node'. */
279 * File descriptor of the data output file. This can be either a file or a
280 * socket fd for relayd streaming.
282 int out_fd
; /* output file to write the data */
283 /* Write position in the output file descriptor */
285 /* Amount of bytes written to the output */
286 uint64_t output_written
;
289 int hangup_flush_done
;
292 * Whether the stream is in a "complete" state (e.g. it does not have a
293 * partially written sub-buffer.
295 * Initialized to "false" on stream creation (first packet is empty).
297 * The various transitions of the quiescent state are:
298 * - On "start" tracing: set to false, since the stream is not
300 * - On "stop" tracing: if !quiescent -> flush FINAL (update
301 * timestamp_end), and set to true; the stream has entered a
302 * complete/quiescent state.
303 * - On "destroy" or stream/application hang-up: if !quiescent ->
304 * flush FINAL, and set to true.
306 * NOTE: Update and read are protected by the stream lock.
311 * True if the sequence number is not available (lttng-modules < 2.8).
313 bool sequence_number_unavailable
;
316 * metadata_timer_lock protects flags waiting_on_metadata and
317 * missed_metadata_flush.
319 pthread_mutex_t metadata_timer_lock
;
321 * Flag set when awaiting metadata to be pushed. Used in the
322 * timer thread to skip waiting on the stream (and stream lock) to
323 * ensure we can proceed to flushing metadata in live mode.
325 bool waiting_on_metadata
;
326 /* Raised when a timer misses a metadata flush. */
327 bool missed_metadata_flush
;
329 enum lttng_event_output output
;
330 /* Maximum subbuffer size (in bytes). */
331 unsigned long max_sb_size
;
334 * Still used by the kernel for MMAP output. For UST, the ustctl getter is
335 * used for the mmap base and offset.
338 unsigned long mmap_len
;
343 /* Network sequence number. Indicating on which relayd socket it goes. */
344 uint64_t net_seq_idx
;
346 * Indicate if this stream was successfully sent to a relayd. This is set
347 * after the refcount of the relayd is incremented and is checked when the
348 * stream is closed before decrementing the refcount in order to avoid an
351 unsigned int sent_to_relayd
;
353 /* Identify if the stream is the metadata */
354 unsigned int metadata_flag
;
356 * Last known metadata version, reset the metadata file in case
359 uint64_t metadata_version
;
360 /* Used when the stream is set for network streaming */
361 uint64_t relayd_stream_id
;
363 * When sending a stream packet to a relayd, this number is used to track
364 * the packet sent by the consumer and seen by the relayd. When sending the
365 * data header to the relayd, this number is sent and if the transmission
366 * was successful, it is incremented.
368 * Even if the full data is not fully transmitted it won't matter since
369 * only two possible error can happen after that where either the relayd
370 * died or a read error is detected on the stream making this value useless
373 * This value SHOULD be read/updated atomically or with the lock acquired.
375 uint64_t next_net_seq_num
;
377 * Lock to use the stream FDs since they are used between threads.
379 * This is nested INSIDE the consumer_data lock.
380 * This is nested INSIDE the channel lock.
381 * This is nested INSIDE the channel timer lock.
382 * This is nested OUTSIDE the metadata cache lock.
383 * This is nested OUTSIDE consumer_relayd_sock_pair lock.
385 pthread_mutex_t lock
;
386 /* Tracing session id */
389 * Indicates if the stream end point is still active or not (network
390 * streaming or local file system). The thread "owning" the stream is
391 * handling this status and can be notified of a state change through the
392 * consumer data appropriate pipe.
394 enum consumer_endpoint_status endpoint_status
;
395 /* Stream name. Format is: <channel_name>_<cpu_number> */
396 char name
[LTTNG_SYMBOL_NAME_LEN
];
397 /* Internal state of libustctl. */
398 struct ustctl_consumer_stream
*ustream
;
399 struct cds_list_head send_node
;
400 /* On-disk circular buffer */
401 uint64_t tracefile_size_current
;
402 uint64_t tracefile_count_current
;
404 * Monitor or not the streams of this channel meaning this indicates if the
405 * streams should be sent to the data/metadata thread or added to the no
406 * monitor list of the channel.
408 unsigned int monitor
;
410 * Indicate if the stream is globally visible meaning that it has been
411 * added to the multiple hash tables. If *not* set, NO lock should be
412 * acquired in the destroy path.
414 unsigned int globally_visible
;
416 * Pipe to wake up the metadata poll thread when the UST metadata
419 int ust_metadata_poll_pipe
[2];
421 * How much metadata was read from the metadata cache and sent
424 uint64_t ust_metadata_pushed
;
426 * Copy of the last discarded event value to detect the overflow of
429 uint64_t last_discarded_events
;
430 /* Copy of the sequence number of the last packet extracted. */
431 uint64_t last_sequence_number
;
433 * Index file object of the index file for this stream.
435 struct lttng_index_file
*index_file
;
438 * Local pipe to extract data when using splice.
443 * Rendez-vous point between data and metadata stream in live mode.
445 pthread_cond_t metadata_rdv
;
446 pthread_mutex_t metadata_rdv_lock
;
449 * rotate_position represents the packet sequence number of the last
450 * packet which belongs to the current trace chunk prior to the rotation.
451 * When that position is reached, this tracefile can be closed and a
452 * new one is created in channel_read_only_attributes.path.
454 uint64_t rotate_position
;
457 * Read-only copies of channel values. We cannot safely access the
458 * channel from a stream, so we need to have a local copy of these
459 * fields in the stream object. These fields should be removed from
460 * the stream objects when we introduce refcounting.
463 uint64_t tracefile_size
;
464 } channel_read_only_attributes
;
467 * Flag to inform the data or metadata thread that a stream is
468 * ready to be rotated.
472 /* Indicate if the stream still has some data to be read. */
473 unsigned int has_data
:1;
475 * Inform the consumer or relay to reset the metadata
476 * file before writing in it (regeneration).
478 unsigned int reset_metadata_flag
:1;
482 * Internal representation of a relayd socket pair.
484 struct consumer_relayd_sock_pair
{
485 /* Network sequence number. */
486 uint64_t net_seq_idx
;
487 /* Number of stream associated with this relayd */
491 * This flag indicates whether or not we should destroy this object. The
492 * destruction should ONLY occurs when this flag is set and the refcount is
495 unsigned int destroy_flag
;
498 * Mutex protecting the control socket to avoid out of order packets
499 * between threads sending data to the relayd. Since metadata data is sent
500 * over that socket, at least two sendmsg() are needed (header + data)
501 * creating a race for packets to overlap between threads using it.
503 * This is nested INSIDE the consumer_data lock.
504 * This is nested INSIDE the stream lock.
506 pthread_mutex_t ctrl_sock_mutex
;
508 /* Control socket. Command and metadata are passed over it */
509 struct lttcomm_relayd_sock control_sock
;
512 * We don't need a mutex at this point since we only splice or write single
513 * large chunk of data with a header appended at the begining. Moreover,
514 * this socket is for now only used in a single thread.
516 struct lttcomm_relayd_sock data_sock
;
517 struct lttng_ht_node_u64 node
;
519 /* Session id on both sides for the sockets. */
520 uint64_t relayd_session_id
;
521 uint64_t sessiond_session_id
;
522 struct lttng_consumer_local_data
*ctx
;
526 * UST consumer local data to the program. One or more instance per
529 struct lttng_consumer_local_data
{
531 * Function to call when data is available on a buffer.
532 * Returns the number of bytes read, or negative error value.
534 ssize_t (*on_buffer_ready
)(struct lttng_consumer_stream
*stream
,
535 struct lttng_consumer_local_data
*ctx
);
537 * function to call when we receive a new channel, it receives a
538 * newly allocated channel, depending on the return code of this
539 * function, the new channel will be handled by the application
543 * > 0 (success, FD is kept by application)
544 * == 0 (success, FD is left to library)
547 int (*on_recv_channel
)(struct lttng_consumer_channel
*channel
);
549 * function to call when we receive a new stream, it receives a
550 * newly allocated stream, depending on the return code of this
551 * function, the new stream will be handled by the application
555 * > 0 (success, FD is kept by application)
556 * == 0 (success, FD is left to library)
559 int (*on_recv_stream
)(struct lttng_consumer_stream
*stream
);
561 * function to call when a stream is getting updated by the session
562 * daemon, this function receives the sessiond key and the new
563 * state, depending on the return code of this function the
564 * update of state for the stream is handled by the application
568 * > 0 (success, FD is kept by application)
569 * == 0 (success, FD is left to library)
572 int (*on_update_stream
)(uint64_t sessiond_key
, uint32_t state
);
573 enum lttng_consumer_type type
;
574 /* socket to communicate errors with sessiond */
575 int consumer_error_socket
;
576 /* socket to ask metadata to sessiond. */
577 int consumer_metadata_socket
;
579 * Protect consumer_metadata_socket.
581 * This is nested OUTSIDE the metadata cache lock.
583 pthread_mutex_t metadata_socket_lock
;
584 /* socket to exchange commands with sessiond */
585 char *consumer_command_sock_path
;
586 /* communication with splice */
587 int consumer_channel_pipe
[2];
588 /* Data stream poll thread pipe. To transfer data stream to the thread */
589 struct lttng_pipe
*consumer_data_pipe
;
592 * Data thread use that pipe to catch wakeup from read subbuffer that
593 * detects that there is still data to be read for the stream encountered.
594 * Before doing so, the stream is flagged to indicate that there is still
597 * Both pipes (read/write) are owned and used inside the data thread.
599 struct lttng_pipe
*consumer_wakeup_pipe
;
600 /* Indicate if the wakeup thread has been notified. */
601 unsigned int has_wakeup
:1;
603 /* to let the signal handler wake up the fd receiver thread */
604 int consumer_should_quit
[2];
605 /* Metadata poll thread pipe. Transfer metadata stream to it */
606 struct lttng_pipe
*consumer_metadata_pipe
;
608 * Pipe used by the channel monitoring timers to provide state samples
609 * to the session daemon (write-only).
611 int channel_monitor_pipe
;
612 LTTNG_OPTIONAL(lttng_uuid
) sessiond_uuid
;
616 * Library-level data. One instance per process.
618 struct lttng_consumer_global_data
{
620 * At this time, this lock is used to ensure coherence between the count
621 * and number of element in the hash table. It's also a protection for
622 * concurrent read/write between threads.
624 * This is nested OUTSIDE the stream lock.
625 * This is nested OUTSIDE the consumer_relayd_sock_pair lock.
627 pthread_mutex_t lock
;
630 * Number of streams in the data stream hash table declared outside.
631 * Protected by consumer_data.lock.
635 /* Channel hash table protected by consumer_data.lock. */
636 struct lttng_ht
*channel_ht
;
637 /* Channel hash table indexed by session id. */
638 struct lttng_ht
*channels_by_session_id_ht
;
640 * Flag specifying if the local array of FDs needs update in the
641 * poll function. Protected by consumer_data.lock.
643 unsigned int need_update
;
644 enum lttng_consumer_type type
;
647 * Relayd socket(s) hashtable indexed by network sequence number. Each
648 * stream has an index which associate the right relayd socket to use.
650 struct lttng_ht
*relayd_ht
;
653 * This hash table contains all streams (metadata and data) indexed by
654 * session id. In other words, the ht is indexed by session id and each
655 * bucket contains the list of associated streams.
657 * This HT uses the "node_session_id" of the consumer stream.
659 struct lttng_ht
*stream_list_ht
;
662 * This HT uses the "node_channel_id" of the consumer stream.
664 struct lttng_ht
*stream_per_chan_id_ht
;
667 * Trace chunk registry indexed by (session_id, chunk_id).
669 struct lttng_trace_chunk_registry
*chunk_registry
;
673 * Set to nonzero when the consumer is exiting. Updated by signal
674 * handler and thread exit, read by threads.
676 extern int consumer_quit
;
679 * Set to nonzero when the consumer is exiting. Updated by signal
680 * handler and thread exit, read by threads.
682 extern int consumer_quit
;
684 /* Flag used to temporarily pause data consumption from testpoints. */
685 extern int data_consumption_paused
;
687 /* Return a human-readable consumer type string that is suitable for logging. */
689 const char *lttng_consumer_type_str(enum lttng_consumer_type type
)
692 case LTTNG_CONSUMER_UNKNOWN
:
694 case LTTNG_CONSUMER_KERNEL
:
696 case LTTNG_CONSUMER32_UST
:
697 return "32-bit user space";
698 case LTTNG_CONSUMER64_UST
:
699 return "64-bit user space";
706 * Init consumer data structures.
708 int lttng_consumer_init(void);
711 * Set the error socket for communication with a session daemon.
713 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
717 * Set the command socket path for communication with a session daemon.
719 void lttng_consumer_set_command_sock_path(
720 struct lttng_consumer_local_data
*ctx
, char *sock
);
723 * Send return code to session daemon.
725 * Returns the return code of sendmsg : the number of bytes transmitted or -1
728 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
);
731 * Called from signal handler to ensure a clean exit.
733 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
);
736 * Cleanup the daemon's socket on exit.
738 void lttng_consumer_cleanup(void);
741 * Poll on the should_quit pipe and the command socket return -1 on error and
742 * should exit, 0 if data is available on the command socket
744 int lttng_consumer_poll_socket(struct pollfd
*kconsumer_sockpoll
);
747 * Copy the fields from the channel that need to be accessed (read-only)
748 * directly from the stream.
750 void consumer_stream_update_channel_attributes(
751 struct lttng_consumer_stream
*stream
,
752 struct lttng_consumer_channel
*channel
);
754 struct lttng_consumer_stream
*consumer_allocate_stream(
755 struct lttng_consumer_channel
*channel
,
756 uint64_t channel_key
,
758 const char *channel_name
,
761 struct lttng_trace_chunk
*trace_chunk
,
764 enum consumer_channel_type type
,
765 unsigned int monitor
);
766 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
768 const uint64_t *chunk_id
,
769 const char *pathname
,
772 enum lttng_event_output output
,
773 uint64_t tracefile_size
,
774 uint64_t tracefile_count
,
775 uint64_t session_id_per_pid
,
776 unsigned int monitor
,
777 unsigned int live_timer_interval
,
778 bool is_in_live_session
,
779 const char *root_shm_path
,
780 const char *shm_path
);
781 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
782 struct lttng_ht
*ht
);
783 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
784 struct lttng_ht
*ht
);
785 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
786 struct lttng_consumer_local_data
*ctx
);
787 void consumer_del_channel(struct lttng_consumer_channel
*channel
);
789 /* lttng-relayd consumer command */
790 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
);
791 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
, char *path
);
792 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
);
793 void close_relayd_stream(struct lttng_consumer_stream
*stream
);
794 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
);
795 int consumer_handle_stream_before_relayd(struct lttng_consumer_stream
*stream
,
797 void consumer_steal_stream_key(int key
, struct lttng_ht
*ht
);
799 struct lttng_consumer_local_data
*lttng_consumer_create(
800 enum lttng_consumer_type type
,
801 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
802 struct lttng_consumer_local_data
*ctx
),
803 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
804 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
805 int (*update_stream
)(uint64_t sessiond_key
, uint32_t state
));
806 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
);
807 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
808 struct lttng_consumer_local_data
*ctx
,
809 struct lttng_consumer_stream
*stream
,
810 const struct lttng_buffer_view
*buffer
,
811 unsigned long padding
,
812 struct ctf_packet_index
*index
);
813 ssize_t
lttng_consumer_on_read_subbuffer_splice(
814 struct lttng_consumer_local_data
*ctx
,
815 struct lttng_consumer_stream
*stream
, unsigned long len
,
816 unsigned long padding
,
817 struct ctf_packet_index
*index
);
818 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
);
819 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
);
820 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
822 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
824 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
);
825 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
);
826 void *consumer_thread_metadata_poll(void *data
);
827 void *consumer_thread_data_poll(void *data
);
828 void *consumer_thread_sessiond_poll(void *data
);
829 void *consumer_thread_channel_poll(void *data
);
830 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
831 int sock
, struct pollfd
*consumer_sockpoll
);
833 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
834 struct lttng_consumer_local_data
*ctx
);
835 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
);
836 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
837 struct lttng_consumer_local_data
*ctx
, int sock
,
838 struct pollfd
*consumer_sockpoll
, struct lttcomm_relayd_sock
*relayd_sock
,
839 uint64_t sessiond_id
, uint64_t relayd_session_id
);
840 void consumer_flag_relayd_for_destroy(
841 struct consumer_relayd_sock_pair
*relayd
);
842 int consumer_data_pending(uint64_t id
);
843 int consumer_send_status_msg(int sock
, int ret_code
);
844 int consumer_send_status_channel(int sock
,
845 struct lttng_consumer_channel
*channel
);
846 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
848 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
);
849 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
850 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
851 uint64_t max_sb_size
);
852 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
);
853 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
);
854 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
);
855 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
);
856 int consumer_create_index_file(struct lttng_consumer_stream
*stream
);
857 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
858 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
859 struct lttng_consumer_local_data
*ctx
);
860 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
);
861 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
862 struct lttng_consumer_stream
*stream
);
863 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
864 uint64_t key
, struct lttng_consumer_local_data
*ctx
);
865 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
);
866 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
867 const uint64_t *relayd_id
, uint64_t session_id
,
869 time_t chunk_creation_timestamp
,
870 const char *chunk_override_name
,
871 const struct lttng_credentials
*credentials
,
872 struct lttng_directory_handle
*chunk_directory_handle
);
873 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
874 const uint64_t *relayd_id
, uint64_t session_id
,
875 uint64_t chunk_id
, time_t chunk_close_timestamp
,
876 const enum lttng_trace_chunk_command_type
*close_command
,
878 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
879 const uint64_t *relayd_id
, uint64_t session_id
,
881 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
);
882 enum lttcomm_return_code
lttng_consumer_init_command(
883 struct lttng_consumer_local_data
*ctx
,
884 const lttng_uuid sessiond_uuid
);
886 #endif /* LIB_CONSUMER_H */