[lttng-ust.git] / libringbuffer / frontend_types.h

/*
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Ring Buffer Library Synchronization Header (types).
 *
 * See ring_buffer_frontend.c for more information on wait-free algorithms.
 */

#ifndef _LTTNG_RING_BUFFER_FRONTEND_TYPES_H
#define _LTTNG_RING_BUFFER_FRONTEND_TYPES_H

#include <stdint.h>
#include <string.h>
#include <time.h>	/* for timer_t */

#include <urcu/list.h>
#include <urcu/uatomic.h>

#include <lttng/ringbuffer-context.h>
#include "ringbuffer-config.h"
#include <usterr-signal-safe.h>
#include "backend_types.h"
#include "shm_internal.h"
#include "shm_types.h"
#include "vatomic.h"

/*
 * A switch is done during tracing or as a final flush after tracing (so it
 * won't write in the new sub-buffer).
 */
enum switch_mode { SWITCH_ACTIVE, SWITCH_FLUSH };

/* channel: collection of per-cpu ring buffers. */
#define RB_CHANNEL_PADDING		32
struct lttng_ust_lib_ring_buffer_channel {
	int record_disabled;
	unsigned long commit_count_mask;	/*
						 * Commit count mask, removing
						 * the MSBs corresponding to
						 * bits used to represent the
						 * subbuffer index.
						 */

	unsigned long switch_timer_interval;	/* Buffer flush (us) */
	timer_t switch_timer;
	int switch_timer_enabled;

	unsigned long read_timer_interval;	/* Reader wakeup (us) */
	timer_t read_timer;
	int read_timer_enabled;

	int finalized;				/* Has channel been finalized */
	size_t priv_data_offset;		/* Offset of private data channel config */
	unsigned int nr_streams;		/* Number of streams */
	struct lttng_ust_shm_handle *handle;
	/* Extended options. */
	union {
		struct {
			int32_t blocking_timeout_ms;
			void *priv;		/* Private data pointer. */
		} s;
		char padding[RB_CHANNEL_PADDING];
	} u;
	/*
	 * Associated backend contains a variable-length array. Needs to
	 * be last member.
	 */
	struct channel_backend backend;		/* Associated backend */
} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));

/* Per-subbuffer commit counters used on the hot path */
#define RB_COMMIT_COUNT_HOT_PADDING	16
struct commit_counters_hot {
	union v_atomic cc;		/* Commit counter */
	union v_atomic seq;		/* Consecutive commits */
	char padding[RB_COMMIT_COUNT_HOT_PADDING];
} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));

/* Per-subbuffer commit counters used only on cold paths */
#define RB_COMMIT_COUNT_COLD_PADDING	24
struct commit_counters_cold {
	union v_atomic cc_sb;		/* Incremented _once_ at sb switch */
	char padding[RB_COMMIT_COUNT_COLD_PADDING];
} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));

/* ring buffer state */
#define RB_CRASH_DUMP_ABI_LEN		256
#define RB_RING_BUFFER_PADDING		60

#define RB_CRASH_DUMP_ABI_MAGIC_LEN	16

/*
 * The 128-bit magic number is xor'd in the process data so it does not
 * cause a false positive when searching for buffers by scanning memory.
 * The actual magic number is:
 *   0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17, 0x7B, 0xF1,
 *   0x77, 0xBF, 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17,
 */
#define RB_CRASH_DUMP_ABI_MAGIC_XOR					\
	{								\
		0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, 0x77 ^ 0xFF,	\
		0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF,	\
		0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF,	\
		0xF1 ^ 0xFF, 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF,	\
	}

#define RB_CRASH_ENDIAN			0x1234

#define RB_CRASH_DUMP_ABI_MAJOR		0
#define RB_CRASH_DUMP_ABI_MINOR		0

enum lttng_crash_type {
	LTTNG_CRASH_TYPE_UST = 0,
	LTTNG_CRASH_TYPE_KERNEL = 1,
};

struct lttng_crash_abi {
	uint8_t magic[RB_CRASH_DUMP_ABI_MAGIC_LEN];
	uint64_t mmap_length;	/* Overall lenght of crash record */
	uint16_t endian;	/*
				 * { 0x12, 0x34 }: big endian
				 * { 0x34, 0x12 }: little endian
				 */
	uint16_t major;		/* Major number. */
	uint16_t minor;		/* Minor number. */
	uint8_t word_size;	/* Word size (bytes). */
	uint8_t layout_type;	/* enum lttng_crash_type */

	struct {
		uint32_t prod_offset;
		uint32_t consumed_offset;
		uint32_t commit_hot_array;
		uint32_t commit_hot_seq;
		uint32_t buf_wsb_array;
		uint32_t buf_wsb_id;
		uint32_t sb_array;
		uint32_t sb_array_shmp_offset;
		uint32_t sb_backend_p_offset;
		uint32_t content_size;
		uint32_t packet_size;
	} __attribute__((packed)) offset;
	struct {
		uint8_t prod_offset;
		uint8_t consumed_offset;
		uint8_t commit_hot_seq;
		uint8_t buf_wsb_id;
		uint8_t sb_array_shmp_offset;
		uint8_t sb_backend_p_offset;
		uint8_t content_size;
		uint8_t packet_size;
	} __attribute__((packed)) length;
	struct {
		uint32_t commit_hot_array;
		uint32_t buf_wsb_array;
		uint32_t sb_array;
	} __attribute__((packed)) stride;

	uint64_t buf_size;	/* Size of the buffer */
	uint64_t subbuf_size;	/* Sub-buffer size */
	uint64_t num_subbuf;	/* Number of sub-buffers for writer */
	uint32_t mode;		/* Buffer mode: 0: overwrite, 1: discard */
} __attribute__((packed));

struct lttng_ust_lib_ring_buffer {
	/* First 32 bytes are for the buffer crash dump ABI */
	struct lttng_crash_abi crash_abi;

	/* 32 bytes cache-hot cacheline */
	union v_atomic __attribute__((aligned(32))) offset;
					/* Current offset in the buffer */
	DECLARE_SHMP(struct commit_counters_hot, commit_hot);
					/* Commit count per sub-buffer */
	long consumed;			/*
					 * Current offset in the buffer
					 * standard atomic access (shared)
					 */
	int record_disabled;
	/* End of cache-hot 32 bytes cacheline */

	union v_atomic last_tsc;	/*
					 * Last timestamp written in the buffer.
					 */

	struct lttng_ust_lib_ring_buffer_backend backend;
					/* Associated backend */

	DECLARE_SHMP(struct commit_counters_cold, commit_cold);
					/* Commit count per sub-buffer */
	DECLARE_SHMP(uint64_t, ts_end);	/*
					 * timestamp_end per sub-buffer.
					 * Time is sampled by the
					 * switch_*_end() callbacks
					 * which are the last space
					 * reservation performed in the
					 * sub-buffer before it can be
					 * fully committed and
					 * delivered. This time value is
					 * then read by the deliver
					 * callback, performed by the
					 * last commit before the buffer
					 * becomes readable.
					 */
	long active_readers;		/*
					 * Active readers count
					 * standard atomic access (shared)
					 */
					/* Dropped records */
	union v_atomic records_lost_full;	/* Buffer full */
	union v_atomic records_lost_wrap;	/* Nested wrap-around */
	union v_atomic records_lost_big;	/* Events too big */
	union v_atomic records_count;	/* Number of records written */
	union v_atomic records_overrun;	/* Number of overwritten records */
	//wait_queue_head_t read_wait;	/* reader buffer-level wait queue */
	int finalized;			/* buffer has been finalized */
	unsigned long get_subbuf_consumed;	/* Read-side consumed */
	unsigned long prod_snapshot;	/* Producer count snapshot */
	unsigned long cons_snapshot;	/* Consumer count snapshot */
	unsigned int get_subbuf:1;	/* Sub-buffer being held by reader */
	/* shmp pointer to self */
	DECLARE_SHMP(struct lttng_ust_lib_ring_buffer, self);
	char padding[RB_RING_BUFFER_PADDING];
} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));

static inline
void *channel_get_private_config(struct lttng_ust_lib_ring_buffer_channel *chan)
{
	return ((char *) chan) + chan->priv_data_offset;
}

static inline
void *channel_get_private(struct lttng_ust_lib_ring_buffer_channel *chan)
{
	return chan->u.s.priv;
}

static inline
void channel_set_private(struct lttng_ust_lib_ring_buffer_channel *chan, void *priv)
{
	chan->u.s.priv = priv;
}

#ifndef __rb_same_type
#define __rb_same_type(a, b)	__builtin_types_compatible_p(typeof(a), typeof(b))
#endif

/*
 * Issue warnings and disable channels upon internal error.
 * Can receive struct lttng_ust_lib_ring_buffer or struct lttng_ust_lib_ring_buffer_backend
 * parameters.
 */
#define CHAN_WARN_ON(c, cond)						\
	({								\
		struct lttng_ust_lib_ring_buffer_channel *__chan;	\
		int _____ret = caa_unlikely(cond);				\
		if (_____ret) {						\
			if (__rb_same_type(*(c), struct channel_backend))	\
				__chan = caa_container_of((void *) (c),	\
					struct lttng_ust_lib_ring_buffer_channel, \
					backend);			\
			else if (__rb_same_type(*(c),			\
					struct lttng_ust_lib_ring_buffer_channel)) \
				__chan = (void *) (c);			\
			else						\
				BUG_ON(1);				\
			uatomic_inc(&__chan->record_disabled);		\
			WARN_ON(1);					\
		}							\
		_____ret = _____ret; /* For clang "unused result". */	\
	})

#endif /* _LTTNG_RING_BUFFER_FRONTEND_TYPES_H */
Commit	Line	Data
852c2936	1	/*
c0c0989a	2	* SPDX-License-Identifier: LGPL-2.1-only
852c2936	3	*
e92f3e28 MD	4	* Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
e92f3e28 MD	5	*
c0c0989a	6	* Ring Buffer Library Synchronization Header (types).
852c2936 MD	7	*
852c2936 MD	8	* See ring_buffer_frontend.c for more information on wait-free algorithms.
852c2936 MD	9	*/
852c2936 MD	10
c0c0989a MJ	11	#ifndef _LTTNG_RING_BUFFER_FRONTEND_TYPES_H
	12	#define _LTTNG_RING_BUFFER_FRONTEND_TYPES_H
	13
fb31eb73	14	#include <stdint.h>
a6352fd4	15	#include <string.h>
03d2d293	16	#include <time.h> /* for timer_t */
a6352fd4	17
14641deb MD	18	#include <urcu/list.h>
14641deb MD	19	#include <urcu/uatomic.h>
14641deb	20
0466ac28 MD	21	#include <lttng/ringbuffer-context.h>
0466ac28 MD	22	#include "ringbuffer-config.h"
44c72f10	23	#include <usterr-signal-safe.h>
4931a13e	24	#include "backend_types.h"
1d498196	25	#include "shm_internal.h"
03d2d293	26	#include "shm_types.h"
a3bb4b27	27	#include "vatomic.h"
852c2936 MD	28
	29	/*
	30	* A switch is done during tracing or as a final flush after tracing (so it
	31	* won't write in the new sub-buffer).
	32	*/
	33	enum switch_mode { SWITCH_ACTIVE, SWITCH_FLUSH };
	34
852c2936	35	/* channel: collection of per-cpu ring buffers. */
74d81a6c	36	#define RB_CHANNEL_PADDING 32
5198080d	37	struct lttng_ust_lib_ring_buffer_channel {
14641deb	38	int record_disabled;
852c2936 MD	39	unsigned long commit_count_mask; /*
	40	* Commit count mask, removing
	41	* the MSBs corresponding to
	42	* bits used to represent the
	43	* subbuffer index.
	44	*/
	45
03d2d293 MD	46	unsigned long switch_timer_interval; /* Buffer flush (us) */
	47	timer_t switch_timer;
	48	int switch_timer_enabled;
	49
	50	unsigned long read_timer_interval; /* Reader wakeup (us) */
34a91bdb MD	51	timer_t read_timer;
	52	int read_timer_enabled;
	53
852c2936	54	int finalized; /* Has channel been finalized */
f0fde1c3	55	size_t priv_data_offset; /* Offset of private data channel config */
74d81a6c	56	unsigned int nr_streams; /* Number of streams */
03d2d293	57	struct lttng_ust_shm_handle *handle;
b2c5f61a MD	58	/* Extended options. */
	59	union {
	60	struct {
	61	int32_t blocking_timeout_ms;
f0fde1c3	62	void priv; / Private data pointer. */
b2c5f61a MD	63	} s;
	64	char padding[RB_CHANNEL_PADDING];
	65	} u;
de85e7c3 MD	66	/*
	67	* Associated backend contains a variable-length array. Needs to
	68	* be last member.
	69	*/
	70	struct channel_backend backend; /* Associated backend */
b728d87e	71	} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));
852c2936 MD	72
852c2936 MD	73	/* Per-subbuffer commit counters used on the hot path */
3c8964ba	74	#define RB_COMMIT_COUNT_HOT_PADDING 16
852c2936 MD	75	struct commit_counters_hot {
	76	union v_atomic cc; /* Commit counter */
	77	union v_atomic seq; /* Consecutive commits */
3c8964ba	78	char padding[RB_COMMIT_COUNT_HOT_PADDING];
b728d87e	79	} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));
852c2936 MD	80
852c2936 MD	81	/* Per-subbuffer commit counters used only on cold paths */
3c8964ba	82	#define RB_COMMIT_COUNT_COLD_PADDING 24
852c2936 MD	83	struct commit_counters_cold {
852c2936 MD	84	union v_atomic cc_sb; /* Incremented _once_ at sb switch */
3c8964ba	85	char padding[RB_COMMIT_COUNT_COLD_PADDING];
b728d87e	86	} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));
852c2936	87
852c2936	88	/* ring buffer state */
a9ff648c MD	89	#define RB_CRASH_DUMP_ABI_LEN 256
	90	#define RB_RING_BUFFER_PADDING 60
	91
	92	#define RB_CRASH_DUMP_ABI_MAGIC_LEN 16
	93
	94	/*
	95	* The 128-bit magic number is xor'd in the process data so it does not
	96	* cause a false positive when searching for buffers by scanning memory.
	97	* The actual magic number is:
	98	* 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17, 0x7B, 0xF1,
	99	* 0x77, 0xBF, 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17,
	100	*/
	101	#define RB_CRASH_DUMP_ABI_MAGIC_XOR \
	102	{ \
	103	0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, 0x77 ^ 0xFF, \
	104	0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, \
	105	0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, \
	106	0xF1 ^ 0xFF, 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, \
	107	}
	108
	109	#define RB_CRASH_ENDIAN 0x1234
	110
	111	#define RB_CRASH_DUMP_ABI_MAJOR 0
	112	#define RB_CRASH_DUMP_ABI_MINOR 0
	113
	114	enum lttng_crash_type {
	115	LTTNG_CRASH_TYPE_UST = 0,
	116	LTTNG_CRASH_TYPE_KERNEL = 1,
	117	};
	118
	119	struct lttng_crash_abi {
	120	uint8_t magic[RB_CRASH_DUMP_ABI_MAGIC_LEN];
	121	uint64_t mmap_length; /* Overall lenght of crash record */
	122	uint16_t endian; /*
	123	* { 0x12, 0x34 }: big endian
	124	* { 0x34, 0x12 }: little endian
	125	*/
	126	uint16_t major; /* Major number. */
	127	uint16_t minor; /* Minor number. */
	128	uint8_t word_size; /* Word size (bytes). */
	129	uint8_t layout_type; /* enum lttng_crash_type */
	130
	131	struct {
	132	uint32_t prod_offset;
	133	uint32_t consumed_offset;
	134	uint32_t commit_hot_array;
	135	uint32_t commit_hot_seq;
	136	uint32_t buf_wsb_array;
	137	uint32_t buf_wsb_id;
	138	uint32_t sb_array;
	139	uint32_t sb_array_shmp_offset;
	140	uint32_t sb_backend_p_offset;
	141	uint32_t content_size;
	142	uint32_t packet_size;
	143	} __attribute__((packed)) offset;
	144	struct {
	145	uint8_t prod_offset;
	146	uint8_t consumed_offset;
	147	uint8_t commit_hot_seq;
	148	uint8_t buf_wsb_id;
	149	uint8_t sb_array_shmp_offset;
	150	uint8_t sb_backend_p_offset;
	151	uint8_t content_size;
	152	uint8_t packet_size;
153	} __attribute__((packed)) length;
154	struct {
155	uint32_t commit_hot_array;
156	uint32_t buf_wsb_array;
157	uint32_t sb_array;
158	} __attribute__((packed)) stride;
159
160	uint64_t buf_size; /* Size of the buffer */
161	uint64_t subbuf_size; /* Sub-buffer size */
162	uint64_t num_subbuf; /* Number of sub-buffers for writer */
163	uint32_t mode; /* Buffer mode: 0: overwrite, 1: discard */
164	} __attribute__((packed));
165
4cfec15c	166	struct lttng_ust_lib_ring_buffer {
a9ff648c MD	167	/* First 32 bytes are for the buffer crash dump ABI */
	168	struct lttng_crash_abi crash_abi;
	169
	170	/* 32 bytes cache-hot cacheline */
	171	union v_atomic __attribute__((aligned(32))) offset;
	172	/* Current offset in the buffer */
a6352fd4	173	DECLARE_SHMP(struct commit_counters_hot, commit_hot);
852c2936	174	/* Commit count per sub-buffer */
14641deb	175	long consumed; /*
852c2936 MD	176	* Current offset in the buffer
	177	* standard atomic access (shared)
	178	*/
14641deb	179	int record_disabled;
a9ff648c MD	180	/* End of cache-hot 32 bytes cacheline */
a9ff648c MD	181
852c2936 MD	182	union v_atomic last_tsc; /*
	183	* Last timestamp written in the buffer.
	184	*/
	185
a9ff648c MD	186	struct lttng_ust_lib_ring_buffer_backend backend;
a9ff648c MD	187	/* Associated backend */
852c2936	188
a6352fd4	189	DECLARE_SHMP(struct commit_counters_cold, commit_cold);
852c2936	190	/* Commit count per sub-buffer */
6c737d05 MD	191	DECLARE_SHMP(uint64_t, ts_end); /*
	192	* timestamp_end per sub-buffer.
	193	* Time is sampled by the
	194	* switch_*_end() callbacks
	195	* which are the last space
	196	* reservation performed in the
	197	* sub-buffer before it can be
	198	* fully committed and
	199	* delivered. This time value is
	200	* then read by the deliver
	201	* callback, performed by the
	202	* last commit before the buffer
	203	* becomes readable.
	204	*/
14641deb	205	long active_readers; /*
852c2936 MD	206	* Active readers count
	207	* standard atomic access (shared)
	208	*/
	209	/* Dropped records */
	210	union v_atomic records_lost_full; /* Buffer full */
	211	union v_atomic records_lost_wrap; /* Nested wrap-around */
	212	union v_atomic records_lost_big; /* Events too big */
	213	union v_atomic records_count; /* Number of records written */
	214	union v_atomic records_overrun; /* Number of overwritten records */
14641deb	215	//wait_queue_head_t read_wait; /* reader buffer-level wait queue */
852c2936	216	int finalized; /* buffer has been finalized */
852c2936 MD	217	unsigned long get_subbuf_consumed; /* Read-side consumed */
	218	unsigned long prod_snapshot; /* Producer count snapshot */
	219	unsigned long cons_snapshot; /* Consumer count snapshot */
34a91bdb	220	unsigned int get_subbuf:1; /* Sub-buffer being held by reader */
5d61a504	221	/* shmp pointer to self */
4cfec15c	222	DECLARE_SHMP(struct lttng_ust_lib_ring_buffer, self);
3c8964ba	223	char padding[RB_RING_BUFFER_PADDING];
b728d87e	224	} __attribute__((aligned(CAA_CACHE_LINE_SIZE)));
852c2936 MD	225
852c2936 MD	226	static inline
f0fde1c3	227	void channel_get_private_config(struct lttng_ust_lib_ring_buffer_channel chan)
852c2936	228	{
a3f61e7f	229	return ((char *) chan) + chan->priv_data_offset;
852c2936 MD	230	}
852c2936 MD	231
f0fde1c3 MD	232	static inline
	233	void channel_get_private(struct lttng_ust_lib_ring_buffer_channel chan)
	234	{
	235	return chan->u.s.priv;
	236	}
	237
	238	static inline
	239	void channel_set_private(struct lttng_ust_lib_ring_buffer_channel chan, void priv)
	240	{
	241	chan->u.s.priv = priv;
	242	}
	243
0d4aa2df MD	244	#ifndef __rb_same_type
	245	#define __rb_same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
	246	#endif
	247
852c2936 MD	248	/*
852c2936 MD	249	* Issue warnings and disable channels upon internal error.
4cfec15c	250	* Can receive struct lttng_ust_lib_ring_buffer or struct lttng_ust_lib_ring_buffer_backend
852c2936 MD	251	* parameters.
	252	*/
	253	#define CHAN_WARN_ON(c, cond) \
	254	({ \
5198080d	255	struct lttng_ust_lib_ring_buffer_channel *__chan; \
b5a3dfa5	256	int _____ret = caa_unlikely(cond); \
852c2936	257	if (_____ret) { \
0d4aa2df	258	if (__rb_same_type(*(c), struct channel_backend)) \
14641deb	259	__chan = caa_container_of((void *) (c), \
5198080d MJ	260	struct lttng_ust_lib_ring_buffer_channel, \
	261	backend); \
	262	else if (__rb_same_type(*(c), \
	263	struct lttng_ust_lib_ring_buffer_channel)) \
852c2936 MD	264	__chan = (void *) (c); \
	265	else \
	266	BUG_ON(1); \
14641deb	267	uatomic_inc(&__chan->record_disabled); \
852c2936 MD	268	WARN_ON(1); \
852c2936 MD	269	} \
257ecc17	270	_____ret = _____ret; /* For clang "unused result". */ \
852c2936 MD	271	})
852c2936 MD	272
e92f3e28	273	#endif /* _LTTNG_RING_BUFFER_FRONTEND_TYPES_H */