[lttng-tools.git] / src / common / consumer / consumer-stream.h

/*
 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef LTTNG_CONSUMER_STREAM_H
#define LTTNG_CONSUMER_STREAM_H

#include "consumer.h"

enum consumer_stream_open_packet_status {
	CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED,
	CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE,
	CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR,
};

/*
 * Create a consumer stream.
 *
 * The channel lock MUST be acquired.
 */
struct lttng_consumer_stream *consumer_stream_create(
		struct lttng_consumer_channel *channel,
		uint64_t channel_key,
		uint64_t stream_key,
		const char *channel_name,
		uint64_t relayd_id,
		uint64_t session_id,
		struct lttng_trace_chunk *trace_chunk,
		int cpu,
		int *alloc_ret,
		enum consumer_channel_type type,
		unsigned int monitor);

/*
 * Close stream's file descriptors and, if needed, close stream also on the
 * relayd side.
 *
 * The stream lock MUST be acquired.
 * The consumer data lock MUST be acquired.
 */
void consumer_stream_close(struct lttng_consumer_stream *stream);

/*
 * Close stream on the relayd side. This call can destroy a relayd if the
 * conditions are met.
 *
 * A RCU read side lock MUST be acquired if the relayd object was looked up in
 * a hash table before calling this.
 */
void consumer_stream_relayd_close(struct lttng_consumer_stream *stream,
		struct consumer_relayd_sock_pair *relayd);

/*
 * Delete the stream from all possible hash tables.
 *
 * The consumer data lock MUST be acquired.
 */
void consumer_stream_delete(struct lttng_consumer_stream *stream,
		struct lttng_ht *ht);

/*
 * Free the given stream within a RCU call.
 */
void consumer_stream_free(struct lttng_consumer_stream *stream);

/*
 * Destroy a stream completely. This will delete, close and free the stream.
 * Once return, the stream is NO longer usable. Its channel may get destroyed
 * if conditions are met.
 *
 * This MUST be called WITHOUT the consumer data and stream lock acquired.
 */
void consumer_stream_destroy(struct lttng_consumer_stream *stream,
		struct lttng_ht *ht);

/*
 * Destroy the stream's buffers on the tracer side. This is also called in a
 * stream destroy.
 */
void consumer_stream_destroy_buffers(struct lttng_consumer_stream *stream);

/*
 * Write index of a specific stream either on the relayd or local disk.
 */
int consumer_stream_write_index(struct lttng_consumer_stream *stream,
		struct ctf_packet_index *index);

int consumer_stream_sync_metadata(struct lttng_consumer_local_data *ctx,
		uint64_t session_id);

/*
 * Create the output files of a local stream.
 *
 * This must be called with the channel's and the stream's lock held.
 */
int consumer_stream_create_output_files(struct lttng_consumer_stream *stream,
		bool create_index);

/*
 * Rotate the output files of a local stream. This will change the
 * active output files of both the binary and index in accordance
 * with the stream's configuration (stream file count).
 *
 * This must be called with the channel's and the stream's lock held.
 */
int consumer_stream_rotate_output_files(struct lttng_consumer_stream *stream);

/*
 * Indicates whether or not a stream is logically deleted. A deleted stream
 * should no longer be used; its existence is only garanteed by the RCU lock
 * held by the caller.
 *
 * This function must be called with the RCU read side lock held.
 */
bool consumer_stream_is_deleted(struct lttng_consumer_stream *stream);

/*
 * Enable metadata bucketization. This must only be enabled if the tracer
 * provides a reliable metadata `coherent` flag.
 *
 * This must be called on initialization before any subbuffer is consumed.
 */
int consumer_stream_enable_metadata_bucketization(
		struct lttng_consumer_stream *stream);

/*
 * Set the version of a metadata stream (i.e. following a metadata
 * regeneration).
 *
 * Changing the version of a metadata stream will cause any bucketized metadata
 * to be discarded and will mark the metadata stream for future `reset`.
 */
void consumer_stream_metadata_set_version(
		struct lttng_consumer_stream *stream, uint64_t new_version);

/*
 * Set the version of a metadata stream (i.e. following a metadata
 * regeneration).
 *
 * Changing the version of a metadata stream will cause any bucketized metadata
 * to be discarded and will mark the metadata stream for future `reset`.
 */
void consumer_stream_metadata_set_version(
		struct lttng_consumer_stream *stream, uint64_t new_version);

/*
 * Attempt to open a packet in a stream.
 *
 * This function must be called with the stream and channel locks held.
 */
enum consumer_stream_open_packet_status consumer_stream_open_packet(
	        struct lttng_consumer_stream *stream);

/*
 * Flush a stream's buffer.
 *
 * producer_active: if true, causes a flush to occur only if there is
 * content present in the current sub-buffer. If false, forces a flush to take
 * place (otherwise known as "flush_empty").
 *
 * This function must be called with the stream and channel locks held.
 */
int consumer_stream_flush_buffer(struct lttng_consumer_stream *stream,
		bool producer_active);

#endif /* LTTNG_CONSUMER_STREAM_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
	3	*
	4	* SPDX-License-Identifier: GPL-2.0-only
	5	*
	6	*/
	7
	8	#ifndef LTTNG_CONSUMER_STREAM_H
	9	#define LTTNG_CONSUMER_STREAM_H
	10
	11	#include "consumer.h"
	12
	13	enum consumer_stream_open_packet_status {
	14	CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED,
	15	CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE,
	16	CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR,
	17	};
	18
	19	/*
	20	* Create a consumer stream.
	21	*
	22	* The channel lock MUST be acquired.
	23	*/
	24	struct lttng_consumer_stream *consumer_stream_create(
	25	struct lttng_consumer_channel *channel,
	26	uint64_t channel_key,
	27	uint64_t stream_key,
	28	const char *channel_name,
	29	uint64_t relayd_id,
	30	uint64_t session_id,
	31	struct lttng_trace_chunk *trace_chunk,
	32	int cpu,
	33	int *alloc_ret,
	34	enum consumer_channel_type type,
	35	unsigned int monitor);
	36
	37	/*
	38	* Close stream's file descriptors and, if needed, close stream also on the
	39	* relayd side.
	40	*
	41	* The stream lock MUST be acquired.
	42	* The consumer data lock MUST be acquired.
	43	*/
	44	void consumer_stream_close(struct lttng_consumer_stream *stream);
	45
	46	/*
	47	* Close stream on the relayd side. This call can destroy a relayd if the
	48	* conditions are met.
	49	*
	50	* A RCU read side lock MUST be acquired if the relayd object was looked up in
	51	* a hash table before calling this.
	52	*/
	53	void consumer_stream_relayd_close(struct lttng_consumer_stream *stream,
	54	struct consumer_relayd_sock_pair *relayd);
	55
	56	/*
	57	* Delete the stream from all possible hash tables.
	58	*
	59	* The consumer data lock MUST be acquired.
	60	*/
	61	void consumer_stream_delete(struct lttng_consumer_stream *stream,
	62	struct lttng_ht *ht);
	63
	64	/*
	65	* Free the given stream within a RCU call.
	66	*/
	67	void consumer_stream_free(struct lttng_consumer_stream *stream);
	68
	69	/*
	70	* Destroy a stream completely. This will delete, close and free the stream.
	71	* Once return, the stream is NO longer usable. Its channel may get destroyed
	72	* if conditions are met.
	73	*
	74	* This MUST be called WITHOUT the consumer data and stream lock acquired.
	75	*/
	76	void consumer_stream_destroy(struct lttng_consumer_stream *stream,
	77	struct lttng_ht *ht);
	78
	79	/*
	80	* Destroy the stream's buffers on the tracer side. This is also called in a
	81	* stream destroy.
	82	*/
	83	void consumer_stream_destroy_buffers(struct lttng_consumer_stream *stream);
	84
	85	/*
	86	* Write index of a specific stream either on the relayd or local disk.
	87	*/
	88	int consumer_stream_write_index(struct lttng_consumer_stream *stream,
	89	struct ctf_packet_index *index);
	90
	91	int consumer_stream_sync_metadata(struct lttng_consumer_local_data *ctx,
	92	uint64_t session_id);
	93
	94	/*
	95	* Create the output files of a local stream.
	96	*
	97	* This must be called with the channel's and the stream's lock held.
	98	*/
	99	int consumer_stream_create_output_files(struct lttng_consumer_stream *stream,
	100	bool create_index);
	101
	102	/*
	103	* Rotate the output files of a local stream. This will change the
	104	* active output files of both the binary and index in accordance
	105	* with the stream's configuration (stream file count).
	106	*
	107	* This must be called with the channel's and the stream's lock held.
	108	*/
	109	int consumer_stream_rotate_output_files(struct lttng_consumer_stream *stream);
	110
	111	/*
	112	* Indicates whether or not a stream is logically deleted. A deleted stream
	113	* should no longer be used; its existence is only garanteed by the RCU lock
	114	* held by the caller.
	115	*
	116	* This function must be called with the RCU read side lock held.
	117	*/
	118	bool consumer_stream_is_deleted(struct lttng_consumer_stream *stream);
	119
	120	/*
	121	* Enable metadata bucketization. This must only be enabled if the tracer
	122	* provides a reliable metadata `coherent` flag.
	123	*
	124	* This must be called on initialization before any subbuffer is consumed.
	125	*/
	126	int consumer_stream_enable_metadata_bucketization(
	127	struct lttng_consumer_stream *stream);
	128
	129	/*
	130	* Set the version of a metadata stream (i.e. following a metadata
	131	* regeneration).
	132	*
	133	* Changing the version of a metadata stream will cause any bucketized metadata
	134	* to be discarded and will mark the metadata stream for future `reset`.
	135	*/
	136	void consumer_stream_metadata_set_version(
	137	struct lttng_consumer_stream *stream, uint64_t new_version);
	138
	139	/*
	140	* Set the version of a metadata stream (i.e. following a metadata
	141	* regeneration).
	142	*
	143	* Changing the version of a metadata stream will cause any bucketized metadata
	144	* to be discarded and will mark the metadata stream for future `reset`.
	145	*/
	146	void consumer_stream_metadata_set_version(
	147	struct lttng_consumer_stream *stream, uint64_t new_version);
	148
	149	/*
	150	* Attempt to open a packet in a stream.
	151	*
	152	* This function must be called with the stream and channel locks held.
	153	*/
	154	enum consumer_stream_open_packet_status consumer_stream_open_packet(
	155	struct lttng_consumer_stream *stream);
	156
	157	/*
	158	* Flush a stream's buffer.
	159	*
	160	* producer_active: if true, causes a flush to occur only if there is
	161	* content present in the current sub-buffer. If false, forces a flush to take
	162	* place (otherwise known as "flush_empty").
	163	*
	164	* This function must be called with the stream and channel locks held.
	165	*/
	166	int consumer_stream_flush_buffer(struct lttng_consumer_stream *stream,
	167	bool producer_active);
	168
	169	#endif /* LTTNG_CONSUMER_STREAM_H */