xref: /linux-6.15/kernel/trace/ring_buffer.c (revision 80a9b64e)
17a8e76a3SSteven Rostedt /*
27a8e76a3SSteven Rostedt  * Generic ring buffer
37a8e76a3SSteven Rostedt  *
47a8e76a3SSteven Rostedt  * Copyright (C) 2008 Steven Rostedt <[email protected]>
57a8e76a3SSteven Rostedt  */
60b07436dSSteven Rostedt #include <linux/ftrace_event.h>
77a8e76a3SSteven Rostedt #include <linux/ring_buffer.h>
814131f2fSIngo Molnar #include <linux/trace_clock.h>
90b07436dSSteven Rostedt #include <linux/trace_seq.h>
107a8e76a3SSteven Rostedt #include <linux/spinlock.h>
1115693458SSteven Rostedt (Red Hat) #include <linux/irq_work.h>
127a8e76a3SSteven Rostedt #include <linux/uaccess.h>
13a81bd80aSSteven Rostedt #include <linux/hardirq.h>
146c43e554SSteven Rostedt (Red Hat) #include <linux/kthread.h>	/* for self test */
151744a21dSVegard Nossum #include <linux/kmemcheck.h>
167a8e76a3SSteven Rostedt #include <linux/module.h>
177a8e76a3SSteven Rostedt #include <linux/percpu.h>
187a8e76a3SSteven Rostedt #include <linux/mutex.h>
196c43e554SSteven Rostedt (Red Hat) #include <linux/delay.h>
205a0e3ad6STejun Heo #include <linux/slab.h>
217a8e76a3SSteven Rostedt #include <linux/init.h>
227a8e76a3SSteven Rostedt #include <linux/hash.h>
237a8e76a3SSteven Rostedt #include <linux/list.h>
24554f786eSSteven Rostedt #include <linux/cpu.h>
257a8e76a3SSteven Rostedt 
2679615760SChristoph Lameter #include <asm/local.h>
27182e9f5fSSteven Rostedt 
2883f40318SVaibhav Nagarnaik static void update_pages_handler(struct work_struct *work);
2983f40318SVaibhav Nagarnaik 
30033601a3SSteven Rostedt /*
31d1b182a8SSteven Rostedt  * The ring buffer header is special. We must manually up keep it.
32d1b182a8SSteven Rostedt  */
33d1b182a8SSteven Rostedt int ring_buffer_print_entry_header(struct trace_seq *s)
34d1b182a8SSteven Rostedt {
35c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_puts(s, "# compressed entry header\n");
36c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_puts(s, "\ttype_len    :    5 bits\n");
37c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_puts(s, "\ttime_delta  :   27 bits\n");
38c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_puts(s, "\tarray       :   32 bits\n");
39c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_putc(s, '\n');
40c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\tpadding     : type == %d\n",
41d1b182a8SSteven Rostedt 			 RINGBUF_TYPE_PADDING);
42c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\ttime_extend : type == %d\n",
43d1b182a8SSteven Rostedt 			 RINGBUF_TYPE_TIME_EXTEND);
44c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\tdata max type_len  == %d\n",
45334d4169SLai Jiangshan 			 RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
46d1b182a8SSteven Rostedt 
47c0cd93aaSSteven Rostedt (Red Hat) 	return !trace_seq_has_overflowed(s);
48d1b182a8SSteven Rostedt }
49d1b182a8SSteven Rostedt 
50d1b182a8SSteven Rostedt /*
515cc98548SSteven Rostedt  * The ring buffer is made up of a list of pages. A separate list of pages is
525cc98548SSteven Rostedt  * allocated for each CPU. A writer may only write to a buffer that is
535cc98548SSteven Rostedt  * associated with the CPU it is currently executing on.  A reader may read
545cc98548SSteven Rostedt  * from any per cpu buffer.
555cc98548SSteven Rostedt  *
565cc98548SSteven Rostedt  * The reader is special. For each per cpu buffer, the reader has its own
575cc98548SSteven Rostedt  * reader page. When a reader has read the entire reader page, this reader
585cc98548SSteven Rostedt  * page is swapped with another page in the ring buffer.
595cc98548SSteven Rostedt  *
605cc98548SSteven Rostedt  * Now, as long as the writer is off the reader page, the reader can do what
615cc98548SSteven Rostedt  * ever it wants with that page. The writer will never write to that page
625cc98548SSteven Rostedt  * again (as long as it is out of the ring buffer).
635cc98548SSteven Rostedt  *
645cc98548SSteven Rostedt  * Here's some silly ASCII art.
655cc98548SSteven Rostedt  *
665cc98548SSteven Rostedt  *   +------+
675cc98548SSteven Rostedt  *   |reader|          RING BUFFER
685cc98548SSteven Rostedt  *   |page  |
695cc98548SSteven Rostedt  *   +------+        +---+   +---+   +---+
705cc98548SSteven Rostedt  *                   |   |-->|   |-->|   |
715cc98548SSteven Rostedt  *                   +---+   +---+   +---+
725cc98548SSteven Rostedt  *                     ^               |
735cc98548SSteven Rostedt  *                     |               |
745cc98548SSteven Rostedt  *                     +---------------+
755cc98548SSteven Rostedt  *
765cc98548SSteven Rostedt  *
775cc98548SSteven Rostedt  *   +------+
785cc98548SSteven Rostedt  *   |reader|          RING BUFFER
795cc98548SSteven Rostedt  *   |page  |------------------v
805cc98548SSteven Rostedt  *   +------+        +---+   +---+   +---+
815cc98548SSteven Rostedt  *                   |   |-->|   |-->|   |
825cc98548SSteven Rostedt  *                   +---+   +---+   +---+
835cc98548SSteven Rostedt  *                     ^               |
845cc98548SSteven Rostedt  *                     |               |
855cc98548SSteven Rostedt  *                     +---------------+
865cc98548SSteven Rostedt  *
875cc98548SSteven Rostedt  *
885cc98548SSteven Rostedt  *   +------+
895cc98548SSteven Rostedt  *   |reader|          RING BUFFER
905cc98548SSteven Rostedt  *   |page  |------------------v
915cc98548SSteven Rostedt  *   +------+        +---+   +---+   +---+
925cc98548SSteven Rostedt  *      ^            |   |-->|   |-->|   |
935cc98548SSteven Rostedt  *      |            +---+   +---+   +---+
945cc98548SSteven Rostedt  *      |                              |
955cc98548SSteven Rostedt  *      |                              |
965cc98548SSteven Rostedt  *      +------------------------------+
975cc98548SSteven Rostedt  *
985cc98548SSteven Rostedt  *
995cc98548SSteven Rostedt  *   +------+
1005cc98548SSteven Rostedt  *   |buffer|          RING BUFFER
1015cc98548SSteven Rostedt  *   |page  |------------------v
1025cc98548SSteven Rostedt  *   +------+        +---+   +---+   +---+
1035cc98548SSteven Rostedt  *      ^            |   |   |   |-->|   |
1045cc98548SSteven Rostedt  *      |   New      +---+   +---+   +---+
1055cc98548SSteven Rostedt  *      |  Reader------^               |
1065cc98548SSteven Rostedt  *      |   page                       |
1075cc98548SSteven Rostedt  *      +------------------------------+
1085cc98548SSteven Rostedt  *
1095cc98548SSteven Rostedt  *
1105cc98548SSteven Rostedt  * After we make this swap, the reader can hand this page off to the splice
1115cc98548SSteven Rostedt  * code and be done with it. It can even allocate a new page if it needs to
1125cc98548SSteven Rostedt  * and swap that into the ring buffer.
1135cc98548SSteven Rostedt  *
1145cc98548SSteven Rostedt  * We will be using cmpxchg soon to make all this lockless.
1155cc98548SSteven Rostedt  *
1165cc98548SSteven Rostedt  */
1175cc98548SSteven Rostedt 
1185cc98548SSteven Rostedt /*
119033601a3SSteven Rostedt  * A fast way to enable or disable all ring buffers is to
120033601a3SSteven Rostedt  * call tracing_on or tracing_off. Turning off the ring buffers
121033601a3SSteven Rostedt  * prevents all ring buffers from being recorded to.
122033601a3SSteven Rostedt  * Turning this switch on, makes it OK to write to the
123033601a3SSteven Rostedt  * ring buffer, if the ring buffer is enabled itself.
124033601a3SSteven Rostedt  *
125033601a3SSteven Rostedt  * There's three layers that must be on in order to write
126033601a3SSteven Rostedt  * to the ring buffer.
127033601a3SSteven Rostedt  *
128033601a3SSteven Rostedt  * 1) This global flag must be set.
129033601a3SSteven Rostedt  * 2) The ring buffer must be enabled for recording.
130033601a3SSteven Rostedt  * 3) The per cpu buffer must be enabled for recording.
131033601a3SSteven Rostedt  *
132033601a3SSteven Rostedt  * In case of an anomaly, this global flag has a bit set that
133033601a3SSteven Rostedt  * will permantly disable all ring buffers.
134033601a3SSteven Rostedt  */
135033601a3SSteven Rostedt 
136033601a3SSteven Rostedt /*
137033601a3SSteven Rostedt  * Global flag to disable all recording to ring buffers
138033601a3SSteven Rostedt  *  This has two bits: ON, DISABLED
139033601a3SSteven Rostedt  *
140033601a3SSteven Rostedt  *  ON   DISABLED
141033601a3SSteven Rostedt  * ---- ----------
142033601a3SSteven Rostedt  *   0      0        : ring buffers are off
143033601a3SSteven Rostedt  *   1      0        : ring buffers are on
144033601a3SSteven Rostedt  *   X      1        : ring buffers are permanently disabled
145033601a3SSteven Rostedt  */
146033601a3SSteven Rostedt 
147033601a3SSteven Rostedt enum {
148033601a3SSteven Rostedt 	RB_BUFFERS_ON_BIT	= 0,
149033601a3SSteven Rostedt 	RB_BUFFERS_DISABLED_BIT	= 1,
150033601a3SSteven Rostedt };
151033601a3SSteven Rostedt 
152033601a3SSteven Rostedt enum {
153033601a3SSteven Rostedt 	RB_BUFFERS_ON		= 1 << RB_BUFFERS_ON_BIT,
154033601a3SSteven Rostedt 	RB_BUFFERS_DISABLED	= 1 << RB_BUFFERS_DISABLED_BIT,
155033601a3SSteven Rostedt };
156033601a3SSteven Rostedt 
1575e39841cSHannes Eder static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
158a3583244SSteven Rostedt 
159499e5470SSteven Rostedt /* Used for individual buffers (after the counter) */
160499e5470SSteven Rostedt #define RB_BUFFER_OFF		(1 << 20)
161499e5470SSteven Rostedt 
162474d32b6SSteven Rostedt #define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
163474d32b6SSteven Rostedt 
164a3583244SSteven Rostedt /**
165033601a3SSteven Rostedt  * tracing_off_permanent - permanently disable ring buffers
166033601a3SSteven Rostedt  *
167033601a3SSteven Rostedt  * This function, once called, will disable all ring buffers
168c3706f00SWenji Huang  * permanently.
169033601a3SSteven Rostedt  */
170033601a3SSteven Rostedt void tracing_off_permanent(void)
171033601a3SSteven Rostedt {
172033601a3SSteven Rostedt 	set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
173a3583244SSteven Rostedt }
174a3583244SSteven Rostedt 
175e3d6bf0aSSteven Rostedt #define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
17667d34724SAndrew Morton #define RB_ALIGNMENT		4U
177334d4169SLai Jiangshan #define RB_MAX_SMALL_DATA	(RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
178c7b09308SSteven Rostedt #define RB_EVNT_MIN_SIZE	8U	/* two 32bit words */
179334d4169SLai Jiangshan 
180649508f6SJames Hogan #ifndef CONFIG_HAVE_64BIT_ALIGNED_ACCESS
1812271048dSSteven Rostedt # define RB_FORCE_8BYTE_ALIGNMENT	0
1822271048dSSteven Rostedt # define RB_ARCH_ALIGNMENT		RB_ALIGNMENT
1832271048dSSteven Rostedt #else
1842271048dSSteven Rostedt # define RB_FORCE_8BYTE_ALIGNMENT	1
1852271048dSSteven Rostedt # define RB_ARCH_ALIGNMENT		8U
1862271048dSSteven Rostedt #endif
1872271048dSSteven Rostedt 
188649508f6SJames Hogan #define RB_ALIGN_DATA		__aligned(RB_ARCH_ALIGNMENT)
189649508f6SJames Hogan 
190334d4169SLai Jiangshan /* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
191334d4169SLai Jiangshan #define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
1927a8e76a3SSteven Rostedt 
1937a8e76a3SSteven Rostedt enum {
1947a8e76a3SSteven Rostedt 	RB_LEN_TIME_EXTEND = 8,
1957a8e76a3SSteven Rostedt 	RB_LEN_TIME_STAMP = 16,
1967a8e76a3SSteven Rostedt };
1977a8e76a3SSteven Rostedt 
19869d1b839SSteven Rostedt #define skip_time_extend(event) \
19969d1b839SSteven Rostedt 	((struct ring_buffer_event *)((char *)event + RB_LEN_TIME_EXTEND))
20069d1b839SSteven Rostedt 
2012d622719STom Zanussi static inline int rb_null_event(struct ring_buffer_event *event)
2022d622719STom Zanussi {
203a1863c21SSteven Rostedt 	return event->type_len == RINGBUF_TYPE_PADDING && !event->time_delta;
2042d622719STom Zanussi }
2052d622719STom Zanussi 
2062d622719STom Zanussi static void rb_event_set_padding(struct ring_buffer_event *event)
2072d622719STom Zanussi {
208a1863c21SSteven Rostedt 	/* padding has a NULL time_delta */
209334d4169SLai Jiangshan 	event->type_len = RINGBUF_TYPE_PADDING;
2102d622719STom Zanussi 	event->time_delta = 0;
2112d622719STom Zanussi }
2122d622719STom Zanussi 
2132d622719STom Zanussi static unsigned
2142d622719STom Zanussi rb_event_data_length(struct ring_buffer_event *event)
2152d622719STom Zanussi {
2162d622719STom Zanussi 	unsigned length;
2172d622719STom Zanussi 
218334d4169SLai Jiangshan 	if (event->type_len)
219334d4169SLai Jiangshan 		length = event->type_len * RB_ALIGNMENT;
2202d622719STom Zanussi 	else
2212d622719STom Zanussi 		length = event->array[0];
2222d622719STom Zanussi 	return length + RB_EVNT_HDR_SIZE;
2232d622719STom Zanussi }
2242d622719STom Zanussi 
22569d1b839SSteven Rostedt /*
22669d1b839SSteven Rostedt  * Return the length of the given event. Will return
22769d1b839SSteven Rostedt  * the length of the time extend if the event is a
22869d1b839SSteven Rostedt  * time extend.
22969d1b839SSteven Rostedt  */
23069d1b839SSteven Rostedt static inline unsigned
2317a8e76a3SSteven Rostedt rb_event_length(struct ring_buffer_event *event)
2327a8e76a3SSteven Rostedt {
233334d4169SLai Jiangshan 	switch (event->type_len) {
2347a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_PADDING:
2352d622719STom Zanussi 		if (rb_null_event(event))
2367a8e76a3SSteven Rostedt 			/* undefined */
2377a8e76a3SSteven Rostedt 			return -1;
238334d4169SLai Jiangshan 		return  event->array[0] + RB_EVNT_HDR_SIZE;
2397a8e76a3SSteven Rostedt 
2407a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_EXTEND:
2417a8e76a3SSteven Rostedt 		return RB_LEN_TIME_EXTEND;
2427a8e76a3SSteven Rostedt 
2437a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_STAMP:
2447a8e76a3SSteven Rostedt 		return RB_LEN_TIME_STAMP;
2457a8e76a3SSteven Rostedt 
2467a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_DATA:
2472d622719STom Zanussi 		return rb_event_data_length(event);
2487a8e76a3SSteven Rostedt 	default:
2497a8e76a3SSteven Rostedt 		BUG();
2507a8e76a3SSteven Rostedt 	}
2517a8e76a3SSteven Rostedt 	/* not hit */
2527a8e76a3SSteven Rostedt 	return 0;
2537a8e76a3SSteven Rostedt }
2547a8e76a3SSteven Rostedt 
25569d1b839SSteven Rostedt /*
25669d1b839SSteven Rostedt  * Return total length of time extend and data,
25769d1b839SSteven Rostedt  *   or just the event length for all other events.
25869d1b839SSteven Rostedt  */
25969d1b839SSteven Rostedt static inline unsigned
26069d1b839SSteven Rostedt rb_event_ts_length(struct ring_buffer_event *event)
26169d1b839SSteven Rostedt {
26269d1b839SSteven Rostedt 	unsigned len = 0;
26369d1b839SSteven Rostedt 
26469d1b839SSteven Rostedt 	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
26569d1b839SSteven Rostedt 		/* time extends include the data event after it */
26669d1b839SSteven Rostedt 		len = RB_LEN_TIME_EXTEND;
26769d1b839SSteven Rostedt 		event = skip_time_extend(event);
26869d1b839SSteven Rostedt 	}
26969d1b839SSteven Rostedt 	return len + rb_event_length(event);
27069d1b839SSteven Rostedt }
27169d1b839SSteven Rostedt 
2727a8e76a3SSteven Rostedt /**
2737a8e76a3SSteven Rostedt  * ring_buffer_event_length - return the length of the event
2747a8e76a3SSteven Rostedt  * @event: the event to get the length of
27569d1b839SSteven Rostedt  *
27669d1b839SSteven Rostedt  * Returns the size of the data load of a data event.
27769d1b839SSteven Rostedt  * If the event is something other than a data event, it
27869d1b839SSteven Rostedt  * returns the size of the event itself. With the exception
27969d1b839SSteven Rostedt  * of a TIME EXTEND, where it still returns the size of the
28069d1b839SSteven Rostedt  * data load of the data event after it.
2817a8e76a3SSteven Rostedt  */
2827a8e76a3SSteven Rostedt unsigned ring_buffer_event_length(struct ring_buffer_event *event)
2837a8e76a3SSteven Rostedt {
28469d1b839SSteven Rostedt 	unsigned length;
28569d1b839SSteven Rostedt 
28669d1b839SSteven Rostedt 	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
28769d1b839SSteven Rostedt 		event = skip_time_extend(event);
28869d1b839SSteven Rostedt 
28969d1b839SSteven Rostedt 	length = rb_event_length(event);
290334d4169SLai Jiangshan 	if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
291465634adSRobert Richter 		return length;
292465634adSRobert Richter 	length -= RB_EVNT_HDR_SIZE;
293465634adSRobert Richter 	if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
294465634adSRobert Richter                 length -= sizeof(event->array[0]);
295465634adSRobert Richter 	return length;
2967a8e76a3SSteven Rostedt }
297c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_event_length);
2987a8e76a3SSteven Rostedt 
2997a8e76a3SSteven Rostedt /* inline for ring buffer fast paths */
30034a148bfSAndrew Morton static void *
3017a8e76a3SSteven Rostedt rb_event_data(struct ring_buffer_event *event)
3027a8e76a3SSteven Rostedt {
30369d1b839SSteven Rostedt 	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
30469d1b839SSteven Rostedt 		event = skip_time_extend(event);
305334d4169SLai Jiangshan 	BUG_ON(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
3067a8e76a3SSteven Rostedt 	/* If length is in len field, then array[0] has the data */
307334d4169SLai Jiangshan 	if (event->type_len)
3087a8e76a3SSteven Rostedt 		return (void *)&event->array[0];
3097a8e76a3SSteven Rostedt 	/* Otherwise length is in array[0] and array[1] has the data */
3107a8e76a3SSteven Rostedt 	return (void *)&event->array[1];
3117a8e76a3SSteven Rostedt }
3127a8e76a3SSteven Rostedt 
3137a8e76a3SSteven Rostedt /**
3147a8e76a3SSteven Rostedt  * ring_buffer_event_data - return the data of the event
3157a8e76a3SSteven Rostedt  * @event: the event to get the data from
3167a8e76a3SSteven Rostedt  */
3177a8e76a3SSteven Rostedt void *ring_buffer_event_data(struct ring_buffer_event *event)
3187a8e76a3SSteven Rostedt {
3197a8e76a3SSteven Rostedt 	return rb_event_data(event);
3207a8e76a3SSteven Rostedt }
321c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_event_data);
3227a8e76a3SSteven Rostedt 
3237a8e76a3SSteven Rostedt #define for_each_buffer_cpu(buffer, cpu)		\
3249e01c1b7SRusty Russell 	for_each_cpu(cpu, buffer->cpumask)
3257a8e76a3SSteven Rostedt 
3267a8e76a3SSteven Rostedt #define TS_SHIFT	27
3277a8e76a3SSteven Rostedt #define TS_MASK		((1ULL << TS_SHIFT) - 1)
3287a8e76a3SSteven Rostedt #define TS_DELTA_TEST	(~TS_MASK)
3297a8e76a3SSteven Rostedt 
33066a8cb95SSteven Rostedt /* Flag when events were overwritten */
33166a8cb95SSteven Rostedt #define RB_MISSED_EVENTS	(1 << 31)
332ff0ff84aSSteven Rostedt /* Missed count stored at end */
333ff0ff84aSSteven Rostedt #define RB_MISSED_STORED	(1 << 30)
33466a8cb95SSteven Rostedt 
335abc9b56dSSteven Rostedt struct buffer_data_page {
3367a8e76a3SSteven Rostedt 	u64		 time_stamp;	/* page time stamp */
337c3706f00SWenji Huang 	local_t		 commit;	/* write committed index */
338649508f6SJames Hogan 	unsigned char	 data[] RB_ALIGN_DATA;	/* data of buffer page */
339abc9b56dSSteven Rostedt };
340abc9b56dSSteven Rostedt 
34177ae365eSSteven Rostedt /*
34277ae365eSSteven Rostedt  * Note, the buffer_page list must be first. The buffer pages
34377ae365eSSteven Rostedt  * are allocated in cache lines, which means that each buffer
34477ae365eSSteven Rostedt  * page will be at the beginning of a cache line, and thus
34577ae365eSSteven Rostedt  * the least significant bits will be zero. We use this to
34677ae365eSSteven Rostedt  * add flags in the list struct pointers, to make the ring buffer
34777ae365eSSteven Rostedt  * lockless.
34877ae365eSSteven Rostedt  */
349abc9b56dSSteven Rostedt struct buffer_page {
350778c55d4SSteven Rostedt 	struct list_head list;		/* list of buffer pages */
351abc9b56dSSteven Rostedt 	local_t		 write;		/* index for next write */
3526f807acdSSteven Rostedt 	unsigned	 read;		/* index for next read */
353778c55d4SSteven Rostedt 	local_t		 entries;	/* entries on this page */
354ff0ff84aSSteven Rostedt 	unsigned long	 real_end;	/* real end of data */
355abc9b56dSSteven Rostedt 	struct buffer_data_page *page;	/* Actual data page */
3567a8e76a3SSteven Rostedt };
3577a8e76a3SSteven Rostedt 
35877ae365eSSteven Rostedt /*
35977ae365eSSteven Rostedt  * The buffer page counters, write and entries, must be reset
36077ae365eSSteven Rostedt  * atomically when crossing page boundaries. To synchronize this
36177ae365eSSteven Rostedt  * update, two counters are inserted into the number. One is
36277ae365eSSteven Rostedt  * the actual counter for the write position or count on the page.
36377ae365eSSteven Rostedt  *
36477ae365eSSteven Rostedt  * The other is a counter of updaters. Before an update happens
36577ae365eSSteven Rostedt  * the update partition of the counter is incremented. This will
36677ae365eSSteven Rostedt  * allow the updater to update the counter atomically.
36777ae365eSSteven Rostedt  *
36877ae365eSSteven Rostedt  * The counter is 20 bits, and the state data is 12.
36977ae365eSSteven Rostedt  */
37077ae365eSSteven Rostedt #define RB_WRITE_MASK		0xfffff
37177ae365eSSteven Rostedt #define RB_WRITE_INTCNT		(1 << 20)
37277ae365eSSteven Rostedt 
373044fa782SSteven Rostedt static void rb_init_page(struct buffer_data_page *bpage)
374abc9b56dSSteven Rostedt {
375044fa782SSteven Rostedt 	local_set(&bpage->commit, 0);
376abc9b56dSSteven Rostedt }
377abc9b56dSSteven Rostedt 
378474d32b6SSteven Rostedt /**
379474d32b6SSteven Rostedt  * ring_buffer_page_len - the size of data on the page.
380474d32b6SSteven Rostedt  * @page: The page to read
381474d32b6SSteven Rostedt  *
382474d32b6SSteven Rostedt  * Returns the amount of data on the page, including buffer page header.
383474d32b6SSteven Rostedt  */
384ef7a4a16SSteven Rostedt size_t ring_buffer_page_len(void *page)
385ef7a4a16SSteven Rostedt {
386474d32b6SSteven Rostedt 	return local_read(&((struct buffer_data_page *)page)->commit)
387474d32b6SSteven Rostedt 		+ BUF_PAGE_HDR_SIZE;
388ef7a4a16SSteven Rostedt }
389ef7a4a16SSteven Rostedt 
3907a8e76a3SSteven Rostedt /*
391ed56829cSSteven Rostedt  * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
392ed56829cSSteven Rostedt  * this issue out.
393ed56829cSSteven Rostedt  */
39434a148bfSAndrew Morton static void free_buffer_page(struct buffer_page *bpage)
395ed56829cSSteven Rostedt {
3966ae2a076SSteven Rostedt 	free_page((unsigned long)bpage->page);
397e4c2ce82SSteven Rostedt 	kfree(bpage);
398ed56829cSSteven Rostedt }
399ed56829cSSteven Rostedt 
400ed56829cSSteven Rostedt /*
4017a8e76a3SSteven Rostedt  * We need to fit the time_stamp delta into 27 bits.
4027a8e76a3SSteven Rostedt  */
4037a8e76a3SSteven Rostedt static inline int test_time_stamp(u64 delta)
4047a8e76a3SSteven Rostedt {
4057a8e76a3SSteven Rostedt 	if (delta & TS_DELTA_TEST)
4067a8e76a3SSteven Rostedt 		return 1;
4077a8e76a3SSteven Rostedt 	return 0;
4087a8e76a3SSteven Rostedt }
4097a8e76a3SSteven Rostedt 
410474d32b6SSteven Rostedt #define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
4117a8e76a3SSteven Rostedt 
412be957c44SSteven Rostedt /* Max payload is BUF_PAGE_SIZE - header (8bytes) */
413be957c44SSteven Rostedt #define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))
414be957c44SSteven Rostedt 
415d1b182a8SSteven Rostedt int ring_buffer_print_page_header(struct trace_seq *s)
416d1b182a8SSteven Rostedt {
417d1b182a8SSteven Rostedt 	struct buffer_data_page field;
418d1b182a8SSteven Rostedt 
419c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\tfield: u64 timestamp;\t"
42026a50744STom Zanussi 			 "offset:0;\tsize:%u;\tsigned:%u;\n",
42126a50744STom Zanussi 			 (unsigned int)sizeof(field.time_stamp),
42226a50744STom Zanussi 			 (unsigned int)is_signed_type(u64));
423d1b182a8SSteven Rostedt 
424c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\tfield: local_t commit;\t"
42526a50744STom Zanussi 			 "offset:%u;\tsize:%u;\tsigned:%u;\n",
426d1b182a8SSteven Rostedt 			 (unsigned int)offsetof(typeof(field), commit),
42726a50744STom Zanussi 			 (unsigned int)sizeof(field.commit),
42826a50744STom Zanussi 			 (unsigned int)is_signed_type(long));
429d1b182a8SSteven Rostedt 
430c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\tfield: int overwrite;\t"
43166a8cb95SSteven Rostedt 			 "offset:%u;\tsize:%u;\tsigned:%u;\n",
43266a8cb95SSteven Rostedt 			 (unsigned int)offsetof(typeof(field), commit),
43366a8cb95SSteven Rostedt 			 1,
43466a8cb95SSteven Rostedt 			 (unsigned int)is_signed_type(long));
43566a8cb95SSteven Rostedt 
436c0cd93aaSSteven Rostedt (Red Hat) 	trace_seq_printf(s, "\tfield: char data;\t"
43726a50744STom Zanussi 			 "offset:%u;\tsize:%u;\tsigned:%u;\n",
438d1b182a8SSteven Rostedt 			 (unsigned int)offsetof(typeof(field), data),
43926a50744STom Zanussi 			 (unsigned int)BUF_PAGE_SIZE,
44026a50744STom Zanussi 			 (unsigned int)is_signed_type(char));
441d1b182a8SSteven Rostedt 
442c0cd93aaSSteven Rostedt (Red Hat) 	return !trace_seq_has_overflowed(s);
443d1b182a8SSteven Rostedt }
444d1b182a8SSteven Rostedt 
44515693458SSteven Rostedt (Red Hat) struct rb_irq_work {
44615693458SSteven Rostedt (Red Hat) 	struct irq_work			work;
44715693458SSteven Rostedt (Red Hat) 	wait_queue_head_t		waiters;
4481e0d6714SSteven Rostedt (Red Hat) 	wait_queue_head_t		full_waiters;
44915693458SSteven Rostedt (Red Hat) 	bool				waiters_pending;
4501e0d6714SSteven Rostedt (Red Hat) 	bool				full_waiters_pending;
4511e0d6714SSteven Rostedt (Red Hat) 	bool				wakeup_full;
45215693458SSteven Rostedt (Red Hat) };
45315693458SSteven Rostedt (Red Hat) 
4547a8e76a3SSteven Rostedt /*
4557a8e76a3SSteven Rostedt  * head_page == tail_page && head == tail then buffer is empty.
4567a8e76a3SSteven Rostedt  */
4577a8e76a3SSteven Rostedt struct ring_buffer_per_cpu {
4587a8e76a3SSteven Rostedt 	int				cpu;
459985023deSRichard Kennedy 	atomic_t			record_disabled;
4607a8e76a3SSteven Rostedt 	struct ring_buffer		*buffer;
4615389f6faSThomas Gleixner 	raw_spinlock_t			reader_lock;	/* serialize readers */
462445c8951SThomas Gleixner 	arch_spinlock_t			lock;
4637a8e76a3SSteven Rostedt 	struct lock_class_key		lock_key;
464438ced17SVaibhav Nagarnaik 	unsigned int			nr_pages;
4653adc54faSSteven Rostedt 	struct list_head		*pages;
4666f807acdSSteven Rostedt 	struct buffer_page		*head_page;	/* read from head */
4676f807acdSSteven Rostedt 	struct buffer_page		*tail_page;	/* write to tail */
468c3706f00SWenji Huang 	struct buffer_page		*commit_page;	/* committed pages */
469d769041fSSteven Rostedt 	struct buffer_page		*reader_page;
47066a8cb95SSteven Rostedt 	unsigned long			lost_events;
47166a8cb95SSteven Rostedt 	unsigned long			last_overrun;
472c64e148aSVaibhav Nagarnaik 	local_t				entries_bytes;
473e4906effSSteven Rostedt 	local_t				entries;
474884bfe89SSlava Pestov 	local_t				overrun;
475884bfe89SSlava Pestov 	local_t				commit_overrun;
476884bfe89SSlava Pestov 	local_t				dropped_events;
477fa743953SSteven Rostedt 	local_t				committing;
478fa743953SSteven Rostedt 	local_t				commits;
47977ae365eSSteven Rostedt 	unsigned long			read;
480c64e148aSVaibhav Nagarnaik 	unsigned long			read_bytes;
4817a8e76a3SSteven Rostedt 	u64				write_stamp;
4827a8e76a3SSteven Rostedt 	u64				read_stamp;
483438ced17SVaibhav Nagarnaik 	/* ring buffer pages to update, > 0 to add, < 0 to remove */
484438ced17SVaibhav Nagarnaik 	int				nr_pages_to_update;
485438ced17SVaibhav Nagarnaik 	struct list_head		new_pages; /* new pages to add */
48683f40318SVaibhav Nagarnaik 	struct work_struct		update_pages_work;
48705fdd70dSVaibhav Nagarnaik 	struct completion		update_done;
48815693458SSteven Rostedt (Red Hat) 
48915693458SSteven Rostedt (Red Hat) 	struct rb_irq_work		irq_work;
4907a8e76a3SSteven Rostedt };
4917a8e76a3SSteven Rostedt 
4927a8e76a3SSteven Rostedt struct ring_buffer {
4937a8e76a3SSteven Rostedt 	unsigned			flags;
4947a8e76a3SSteven Rostedt 	int				cpus;
4957a8e76a3SSteven Rostedt 	atomic_t			record_disabled;
49683f40318SVaibhav Nagarnaik 	atomic_t			resize_disabled;
49700f62f61SArnaldo Carvalho de Melo 	cpumask_var_t			cpumask;
4987a8e76a3SSteven Rostedt 
4991f8a6a10SPeter Zijlstra 	struct lock_class_key		*reader_lock_key;
5001f8a6a10SPeter Zijlstra 
5017a8e76a3SSteven Rostedt 	struct mutex			mutex;
5027a8e76a3SSteven Rostedt 
5037a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu	**buffers;
504554f786eSSteven Rostedt 
50559222efeSSteven Rostedt #ifdef CONFIG_HOTPLUG_CPU
506554f786eSSteven Rostedt 	struct notifier_block		cpu_notify;
507554f786eSSteven Rostedt #endif
50837886f6aSSteven Rostedt 	u64				(*clock)(void);
50915693458SSteven Rostedt (Red Hat) 
51015693458SSteven Rostedt (Red Hat) 	struct rb_irq_work		irq_work;
5117a8e76a3SSteven Rostedt };
5127a8e76a3SSteven Rostedt 
5137a8e76a3SSteven Rostedt struct ring_buffer_iter {
5147a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu	*cpu_buffer;
5157a8e76a3SSteven Rostedt 	unsigned long			head;
5167a8e76a3SSteven Rostedt 	struct buffer_page		*head_page;
517492a74f4SSteven Rostedt 	struct buffer_page		*cache_reader_page;
518492a74f4SSteven Rostedt 	unsigned long			cache_read;
5197a8e76a3SSteven Rostedt 	u64				read_stamp;
5207a8e76a3SSteven Rostedt };
5217a8e76a3SSteven Rostedt 
52215693458SSteven Rostedt (Red Hat) /*
52315693458SSteven Rostedt (Red Hat)  * rb_wake_up_waiters - wake up tasks waiting for ring buffer input
52415693458SSteven Rostedt (Red Hat)  *
52515693458SSteven Rostedt (Red Hat)  * Schedules a delayed work to wake up any task that is blocked on the
52615693458SSteven Rostedt (Red Hat)  * ring buffer waiters queue.
52715693458SSteven Rostedt (Red Hat)  */
52815693458SSteven Rostedt (Red Hat) static void rb_wake_up_waiters(struct irq_work *work)
52915693458SSteven Rostedt (Red Hat) {
53015693458SSteven Rostedt (Red Hat) 	struct rb_irq_work *rbwork = container_of(work, struct rb_irq_work, work);
53115693458SSteven Rostedt (Red Hat) 
53215693458SSteven Rostedt (Red Hat) 	wake_up_all(&rbwork->waiters);
5331e0d6714SSteven Rostedt (Red Hat) 	if (rbwork->wakeup_full) {
5341e0d6714SSteven Rostedt (Red Hat) 		rbwork->wakeup_full = false;
5351e0d6714SSteven Rostedt (Red Hat) 		wake_up_all(&rbwork->full_waiters);
5361e0d6714SSteven Rostedt (Red Hat) 	}
53715693458SSteven Rostedt (Red Hat) }
53815693458SSteven Rostedt (Red Hat) 
53915693458SSteven Rostedt (Red Hat) /**
54015693458SSteven Rostedt (Red Hat)  * ring_buffer_wait - wait for input to the ring buffer
54115693458SSteven Rostedt (Red Hat)  * @buffer: buffer to wait on
54215693458SSteven Rostedt (Red Hat)  * @cpu: the cpu buffer to wait on
543e30f53aaSRabin Vincent  * @full: wait until a full page is available, if @cpu != RING_BUFFER_ALL_CPUS
54415693458SSteven Rostedt (Red Hat)  *
54515693458SSteven Rostedt (Red Hat)  * If @cpu == RING_BUFFER_ALL_CPUS then the task will wake up as soon
54615693458SSteven Rostedt (Red Hat)  * as data is added to any of the @buffer's cpu buffers. Otherwise
54715693458SSteven Rostedt (Red Hat)  * it will wait for data to be added to a specific cpu buffer.
54815693458SSteven Rostedt (Red Hat)  */
549e30f53aaSRabin Vincent int ring_buffer_wait(struct ring_buffer *buffer, int cpu, bool full)
55015693458SSteven Rostedt (Red Hat) {
551e30f53aaSRabin Vincent 	struct ring_buffer_per_cpu *uninitialized_var(cpu_buffer);
55215693458SSteven Rostedt (Red Hat) 	DEFINE_WAIT(wait);
55315693458SSteven Rostedt (Red Hat) 	struct rb_irq_work *work;
554e30f53aaSRabin Vincent 	int ret = 0;
55515693458SSteven Rostedt (Red Hat) 
55615693458SSteven Rostedt (Red Hat) 	/*
55715693458SSteven Rostedt (Red Hat) 	 * Depending on what the caller is waiting for, either any
55815693458SSteven Rostedt (Red Hat) 	 * data in any cpu buffer, or a specific buffer, put the
55915693458SSteven Rostedt (Red Hat) 	 * caller on the appropriate wait queue.
56015693458SSteven Rostedt (Red Hat) 	 */
5611e0d6714SSteven Rostedt (Red Hat) 	if (cpu == RING_BUFFER_ALL_CPUS) {
56215693458SSteven Rostedt (Red Hat) 		work = &buffer->irq_work;
5631e0d6714SSteven Rostedt (Red Hat) 		/* Full only makes sense on per cpu reads */
5641e0d6714SSteven Rostedt (Red Hat) 		full = false;
5651e0d6714SSteven Rostedt (Red Hat) 	} else {
5668b8b3683SSteven Rostedt (Red Hat) 		if (!cpumask_test_cpu(cpu, buffer->cpumask))
5678b8b3683SSteven Rostedt (Red Hat) 			return -ENODEV;
56815693458SSteven Rostedt (Red Hat) 		cpu_buffer = buffer->buffers[cpu];
56915693458SSteven Rostedt (Red Hat) 		work = &cpu_buffer->irq_work;
57015693458SSteven Rostedt (Red Hat) 	}
57115693458SSteven Rostedt (Red Hat) 
57215693458SSteven Rostedt (Red Hat) 
573e30f53aaSRabin Vincent 	while (true) {
5741e0d6714SSteven Rostedt (Red Hat) 		if (full)
5751e0d6714SSteven Rostedt (Red Hat) 			prepare_to_wait(&work->full_waiters, &wait, TASK_INTERRUPTIBLE);
5761e0d6714SSteven Rostedt (Red Hat) 		else
57715693458SSteven Rostedt (Red Hat) 			prepare_to_wait(&work->waiters, &wait, TASK_INTERRUPTIBLE);
57815693458SSteven Rostedt (Red Hat) 
57915693458SSteven Rostedt (Red Hat) 		/*
58015693458SSteven Rostedt (Red Hat) 		 * The events can happen in critical sections where
58115693458SSteven Rostedt (Red Hat) 		 * checking a work queue can cause deadlocks.
58215693458SSteven Rostedt (Red Hat) 		 * After adding a task to the queue, this flag is set
58315693458SSteven Rostedt (Red Hat) 		 * only to notify events to try to wake up the queue
58415693458SSteven Rostedt (Red Hat) 		 * using irq_work.
58515693458SSteven Rostedt (Red Hat) 		 *
58615693458SSteven Rostedt (Red Hat) 		 * We don't clear it even if the buffer is no longer
58715693458SSteven Rostedt (Red Hat) 		 * empty. The flag only causes the next event to run
58815693458SSteven Rostedt (Red Hat) 		 * irq_work to do the work queue wake up. The worse
58915693458SSteven Rostedt (Red Hat) 		 * that can happen if we race with !trace_empty() is that
59015693458SSteven Rostedt (Red Hat) 		 * an event will cause an irq_work to try to wake up
59115693458SSteven Rostedt (Red Hat) 		 * an empty queue.
59215693458SSteven Rostedt (Red Hat) 		 *
59315693458SSteven Rostedt (Red Hat) 		 * There's no reason to protect this flag either, as
59415693458SSteven Rostedt (Red Hat) 		 * the work queue and irq_work logic will do the necessary
59515693458SSteven Rostedt (Red Hat) 		 * synchronization for the wake ups. The only thing
59615693458SSteven Rostedt (Red Hat) 		 * that is necessary is that the wake up happens after
59715693458SSteven Rostedt (Red Hat) 		 * a task has been queued. It's OK for spurious wake ups.
59815693458SSteven Rostedt (Red Hat) 		 */
5991e0d6714SSteven Rostedt (Red Hat) 		if (full)
6001e0d6714SSteven Rostedt (Red Hat) 			work->full_waiters_pending = true;
6011e0d6714SSteven Rostedt (Red Hat) 		else
60215693458SSteven Rostedt (Red Hat) 			work->waiters_pending = true;
60315693458SSteven Rostedt (Red Hat) 
604e30f53aaSRabin Vincent 		if (signal_pending(current)) {
605e30f53aaSRabin Vincent 			ret = -EINTR;
606e30f53aaSRabin Vincent 			break;
607e30f53aaSRabin Vincent 		}
608e30f53aaSRabin Vincent 
609e30f53aaSRabin Vincent 		if (cpu == RING_BUFFER_ALL_CPUS && !ring_buffer_empty(buffer))
610e30f53aaSRabin Vincent 			break;
611e30f53aaSRabin Vincent 
612e30f53aaSRabin Vincent 		if (cpu != RING_BUFFER_ALL_CPUS &&
613e30f53aaSRabin Vincent 		    !ring_buffer_empty_cpu(buffer, cpu)) {
614e30f53aaSRabin Vincent 			unsigned long flags;
615e30f53aaSRabin Vincent 			bool pagebusy;
616e30f53aaSRabin Vincent 
617e30f53aaSRabin Vincent 			if (!full)
618e30f53aaSRabin Vincent 				break;
619e30f53aaSRabin Vincent 
620e30f53aaSRabin Vincent 			raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
621e30f53aaSRabin Vincent 			pagebusy = cpu_buffer->reader_page == cpu_buffer->commit_page;
622e30f53aaSRabin Vincent 			raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
623e30f53aaSRabin Vincent 
624e30f53aaSRabin Vincent 			if (!pagebusy)
625e30f53aaSRabin Vincent 				break;
626e30f53aaSRabin Vincent 		}
627e30f53aaSRabin Vincent 
62815693458SSteven Rostedt (Red Hat) 		schedule();
629e30f53aaSRabin Vincent 	}
63015693458SSteven Rostedt (Red Hat) 
6311e0d6714SSteven Rostedt (Red Hat) 	if (full)
6321e0d6714SSteven Rostedt (Red Hat) 		finish_wait(&work->full_waiters, &wait);
6331e0d6714SSteven Rostedt (Red Hat) 	else
63415693458SSteven Rostedt (Red Hat) 		finish_wait(&work->waiters, &wait);
635e30f53aaSRabin Vincent 
636e30f53aaSRabin Vincent 	return ret;
63715693458SSteven Rostedt (Red Hat) }
63815693458SSteven Rostedt (Red Hat) 
63915693458SSteven Rostedt (Red Hat) /**
64015693458SSteven Rostedt (Red Hat)  * ring_buffer_poll_wait - poll on buffer input
64115693458SSteven Rostedt (Red Hat)  * @buffer: buffer to wait on
64215693458SSteven Rostedt (Red Hat)  * @cpu: the cpu buffer to wait on
64315693458SSteven Rostedt (Red Hat)  * @filp: the file descriptor
64415693458SSteven Rostedt (Red Hat)  * @poll_table: The poll descriptor
64515693458SSteven Rostedt (Red Hat)  *
64615693458SSteven Rostedt (Red Hat)  * If @cpu == RING_BUFFER_ALL_CPUS then the task will wake up as soon
64715693458SSteven Rostedt (Red Hat)  * as data is added to any of the @buffer's cpu buffers. Otherwise
64815693458SSteven Rostedt (Red Hat)  * it will wait for data to be added to a specific cpu buffer.
64915693458SSteven Rostedt (Red Hat)  *
65015693458SSteven Rostedt (Red Hat)  * Returns POLLIN | POLLRDNORM if data exists in the buffers,
65115693458SSteven Rostedt (Red Hat)  * zero otherwise.
65215693458SSteven Rostedt (Red Hat)  */
65315693458SSteven Rostedt (Red Hat) int ring_buffer_poll_wait(struct ring_buffer *buffer, int cpu,
65415693458SSteven Rostedt (Red Hat) 			  struct file *filp, poll_table *poll_table)
65515693458SSteven Rostedt (Red Hat) {
65615693458SSteven Rostedt (Red Hat) 	struct ring_buffer_per_cpu *cpu_buffer;
65715693458SSteven Rostedt (Red Hat) 	struct rb_irq_work *work;
65815693458SSteven Rostedt (Red Hat) 
65915693458SSteven Rostedt (Red Hat) 	if (cpu == RING_BUFFER_ALL_CPUS)
66015693458SSteven Rostedt (Red Hat) 		work = &buffer->irq_work;
66115693458SSteven Rostedt (Red Hat) 	else {
6626721cb60SSteven Rostedt (Red Hat) 		if (!cpumask_test_cpu(cpu, buffer->cpumask))
6636721cb60SSteven Rostedt (Red Hat) 			return -EINVAL;
6646721cb60SSteven Rostedt (Red Hat) 
66515693458SSteven Rostedt (Red Hat) 		cpu_buffer = buffer->buffers[cpu];
66615693458SSteven Rostedt (Red Hat) 		work = &cpu_buffer->irq_work;
66715693458SSteven Rostedt (Red Hat) 	}
66815693458SSteven Rostedt (Red Hat) 
66915693458SSteven Rostedt (Red Hat) 	poll_wait(filp, &work->waiters, poll_table);
6704ce97dbfSJosef Bacik 	work->waiters_pending = true;
6714ce97dbfSJosef Bacik 	/*
6724ce97dbfSJosef Bacik 	 * There's a tight race between setting the waiters_pending and
6734ce97dbfSJosef Bacik 	 * checking if the ring buffer is empty.  Once the waiters_pending bit
6744ce97dbfSJosef Bacik 	 * is set, the next event will wake the task up, but we can get stuck
6754ce97dbfSJosef Bacik 	 * if there's only a single event in.
6764ce97dbfSJosef Bacik 	 *
6774ce97dbfSJosef Bacik 	 * FIXME: Ideally, we need a memory barrier on the writer side as well,
6784ce97dbfSJosef Bacik 	 * but adding a memory barrier to all events will cause too much of a
6794ce97dbfSJosef Bacik 	 * performance hit in the fast path.  We only need a memory barrier when
6804ce97dbfSJosef Bacik 	 * the buffer goes from empty to having content.  But as this race is
6814ce97dbfSJosef Bacik 	 * extremely small, and it's not a problem if another event comes in, we
6824ce97dbfSJosef Bacik 	 * will fix it later.
6834ce97dbfSJosef Bacik 	 */
6844ce97dbfSJosef Bacik 	smp_mb();
68515693458SSteven Rostedt (Red Hat) 
68615693458SSteven Rostedt (Red Hat) 	if ((cpu == RING_BUFFER_ALL_CPUS && !ring_buffer_empty(buffer)) ||
68715693458SSteven Rostedt (Red Hat) 	    (cpu != RING_BUFFER_ALL_CPUS && !ring_buffer_empty_cpu(buffer, cpu)))
68815693458SSteven Rostedt (Red Hat) 		return POLLIN | POLLRDNORM;
68915693458SSteven Rostedt (Red Hat) 	return 0;
69015693458SSteven Rostedt (Red Hat) }
69115693458SSteven Rostedt (Red Hat) 
692f536aafcSSteven Rostedt /* buffer may be either ring_buffer or ring_buffer_per_cpu */
693077c5407SSteven Rostedt #define RB_WARN_ON(b, cond)						\
6943e89c7bbSSteven Rostedt 	({								\
6953e89c7bbSSteven Rostedt 		int _____ret = unlikely(cond);				\
6963e89c7bbSSteven Rostedt 		if (_____ret) {						\
697077c5407SSteven Rostedt 			if (__same_type(*(b), struct ring_buffer_per_cpu)) { \
698077c5407SSteven Rostedt 				struct ring_buffer_per_cpu *__b =	\
699077c5407SSteven Rostedt 					(void *)b;			\
700077c5407SSteven Rostedt 				atomic_inc(&__b->buffer->record_disabled); \
701077c5407SSteven Rostedt 			} else						\
702077c5407SSteven Rostedt 				atomic_inc(&b->record_disabled);	\
703bf41a158SSteven Rostedt 			WARN_ON(1);					\
704bf41a158SSteven Rostedt 		}							\
7053e89c7bbSSteven Rostedt 		_____ret;						\
7063e89c7bbSSteven Rostedt 	})
707f536aafcSSteven Rostedt 
70837886f6aSSteven Rostedt /* Up this if you want to test the TIME_EXTENTS and normalization */
70937886f6aSSteven Rostedt #define DEBUG_SHIFT 0
71037886f6aSSteven Rostedt 
7116d3f1e12SJiri Olsa static inline u64 rb_time_stamp(struct ring_buffer *buffer)
71288eb0125SSteven Rostedt {
71388eb0125SSteven Rostedt 	/* shift to debug/test normalization and TIME_EXTENTS */
71488eb0125SSteven Rostedt 	return buffer->clock() << DEBUG_SHIFT;
71588eb0125SSteven Rostedt }
71688eb0125SSteven Rostedt 
71737886f6aSSteven Rostedt u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
71837886f6aSSteven Rostedt {
71937886f6aSSteven Rostedt 	u64 time;
72037886f6aSSteven Rostedt 
72137886f6aSSteven Rostedt 	preempt_disable_notrace();
7226d3f1e12SJiri Olsa 	time = rb_time_stamp(buffer);
72337886f6aSSteven Rostedt 	preempt_enable_no_resched_notrace();
72437886f6aSSteven Rostedt 
72537886f6aSSteven Rostedt 	return time;
72637886f6aSSteven Rostedt }
72737886f6aSSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
72837886f6aSSteven Rostedt 
72937886f6aSSteven Rostedt void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
73037886f6aSSteven Rostedt 				      int cpu, u64 *ts)
73137886f6aSSteven Rostedt {
73237886f6aSSteven Rostedt 	/* Just stupid testing the normalize function and deltas */
73337886f6aSSteven Rostedt 	*ts >>= DEBUG_SHIFT;
73437886f6aSSteven Rostedt }
73537886f6aSSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
73637886f6aSSteven Rostedt 
73777ae365eSSteven Rostedt /*
73877ae365eSSteven Rostedt  * Making the ring buffer lockless makes things tricky.
73977ae365eSSteven Rostedt  * Although writes only happen on the CPU that they are on,
74077ae365eSSteven Rostedt  * and they only need to worry about interrupts. Reads can
74177ae365eSSteven Rostedt  * happen on any CPU.
74277ae365eSSteven Rostedt  *
74377ae365eSSteven Rostedt  * The reader page is always off the ring buffer, but when the
74477ae365eSSteven Rostedt  * reader finishes with a page, it needs to swap its page with
74577ae365eSSteven Rostedt  * a new one from the buffer. The reader needs to take from
74677ae365eSSteven Rostedt  * the head (writes go to the tail). But if a writer is in overwrite
74777ae365eSSteven Rostedt  * mode and wraps, it must push the head page forward.
74877ae365eSSteven Rostedt  *
74977ae365eSSteven Rostedt  * Here lies the problem.
75077ae365eSSteven Rostedt  *
75177ae365eSSteven Rostedt  * The reader must be careful to replace only the head page, and
75277ae365eSSteven Rostedt  * not another one. As described at the top of the file in the
75377ae365eSSteven Rostedt  * ASCII art, the reader sets its old page to point to the next
75477ae365eSSteven Rostedt  * page after head. It then sets the page after head to point to
75577ae365eSSteven Rostedt  * the old reader page. But if the writer moves the head page
75677ae365eSSteven Rostedt  * during this operation, the reader could end up with the tail.
75777ae365eSSteven Rostedt  *
75877ae365eSSteven Rostedt  * We use cmpxchg to help prevent this race. We also do something
75977ae365eSSteven Rostedt  * special with the page before head. We set the LSB to 1.
76077ae365eSSteven Rostedt  *
76177ae365eSSteven Rostedt  * When the writer must push the page forward, it will clear the
76277ae365eSSteven Rostedt  * bit that points to the head page, move the head, and then set
76377ae365eSSteven Rostedt  * the bit that points to the new head page.
76477ae365eSSteven Rostedt  *
76577ae365eSSteven Rostedt  * We also don't want an interrupt coming in and moving the head
76677ae365eSSteven Rostedt  * page on another writer. Thus we use the second LSB to catch
76777ae365eSSteven Rostedt  * that too. Thus:
76877ae365eSSteven Rostedt  *
76977ae365eSSteven Rostedt  * head->list->prev->next        bit 1          bit 0
77077ae365eSSteven Rostedt  *                              -------        -------
77177ae365eSSteven Rostedt  * Normal page                     0              0
77277ae365eSSteven Rostedt  * Points to head page             0              1
77377ae365eSSteven Rostedt  * New head page                   1              0
77477ae365eSSteven Rostedt  *
77577ae365eSSteven Rostedt  * Note we can not trust the prev pointer of the head page, because:
77677ae365eSSteven Rostedt  *
77777ae365eSSteven Rostedt  * +----+       +-----+        +-----+
77877ae365eSSteven Rostedt  * |    |------>|  T  |---X--->|  N  |
77977ae365eSSteven Rostedt  * |    |<------|     |        |     |
78077ae365eSSteven Rostedt  * +----+       +-----+        +-----+
78177ae365eSSteven Rostedt  *   ^                           ^ |
78277ae365eSSteven Rostedt  *   |          +-----+          | |
78377ae365eSSteven Rostedt  *   +----------|  R  |----------+ |
78477ae365eSSteven Rostedt  *              |     |<-----------+
78577ae365eSSteven Rostedt  *              +-----+
78677ae365eSSteven Rostedt  *
78777ae365eSSteven Rostedt  * Key:  ---X-->  HEAD flag set in pointer
78877ae365eSSteven Rostedt  *         T      Tail page
78977ae365eSSteven Rostedt  *         R      Reader page
79077ae365eSSteven Rostedt  *         N      Next page
79177ae365eSSteven Rostedt  *
79277ae365eSSteven Rostedt  * (see __rb_reserve_next() to see where this happens)
79377ae365eSSteven Rostedt  *
79477ae365eSSteven Rostedt  *  What the above shows is that the reader just swapped out
79577ae365eSSteven Rostedt  *  the reader page with a page in the buffer, but before it
79677ae365eSSteven Rostedt  *  could make the new header point back to the new page added
79777ae365eSSteven Rostedt  *  it was preempted by a writer. The writer moved forward onto
79877ae365eSSteven Rostedt  *  the new page added by the reader and is about to move forward
79977ae365eSSteven Rostedt  *  again.
80077ae365eSSteven Rostedt  *
80177ae365eSSteven Rostedt  *  You can see, it is legitimate for the previous pointer of
80277ae365eSSteven Rostedt  *  the head (or any page) not to point back to itself. But only
80377ae365eSSteven Rostedt  *  temporarially.
80477ae365eSSteven Rostedt  */
80577ae365eSSteven Rostedt 
80677ae365eSSteven Rostedt #define RB_PAGE_NORMAL		0UL
80777ae365eSSteven Rostedt #define RB_PAGE_HEAD		1UL
80877ae365eSSteven Rostedt #define RB_PAGE_UPDATE		2UL
80977ae365eSSteven Rostedt 
81077ae365eSSteven Rostedt 
81177ae365eSSteven Rostedt #define RB_FLAG_MASK		3UL
81277ae365eSSteven Rostedt 
81377ae365eSSteven Rostedt /* PAGE_MOVED is not part of the mask */
81477ae365eSSteven Rostedt #define RB_PAGE_MOVED		4UL
81577ae365eSSteven Rostedt 
81677ae365eSSteven Rostedt /*
81777ae365eSSteven Rostedt  * rb_list_head - remove any bit
81877ae365eSSteven Rostedt  */
81977ae365eSSteven Rostedt static struct list_head *rb_list_head(struct list_head *list)
82077ae365eSSteven Rostedt {
82177ae365eSSteven Rostedt 	unsigned long val = (unsigned long)list;
82277ae365eSSteven Rostedt 
82377ae365eSSteven Rostedt 	return (struct list_head *)(val & ~RB_FLAG_MASK);
82477ae365eSSteven Rostedt }
82577ae365eSSteven Rostedt 
82677ae365eSSteven Rostedt /*
8276d3f1e12SJiri Olsa  * rb_is_head_page - test if the given page is the head page
82877ae365eSSteven Rostedt  *
82977ae365eSSteven Rostedt  * Because the reader may move the head_page pointer, we can
83077ae365eSSteven Rostedt  * not trust what the head page is (it may be pointing to
83177ae365eSSteven Rostedt  * the reader page). But if the next page is a header page,
83277ae365eSSteven Rostedt  * its flags will be non zero.
83377ae365eSSteven Rostedt  */
83442b16b3fSJesper Juhl static inline int
83577ae365eSSteven Rostedt rb_is_head_page(struct ring_buffer_per_cpu *cpu_buffer,
83677ae365eSSteven Rostedt 		struct buffer_page *page, struct list_head *list)
83777ae365eSSteven Rostedt {
83877ae365eSSteven Rostedt 	unsigned long val;
83977ae365eSSteven Rostedt 
84077ae365eSSteven Rostedt 	val = (unsigned long)list->next;
84177ae365eSSteven Rostedt 
84277ae365eSSteven Rostedt 	if ((val & ~RB_FLAG_MASK) != (unsigned long)&page->list)
84377ae365eSSteven Rostedt 		return RB_PAGE_MOVED;
84477ae365eSSteven Rostedt 
84577ae365eSSteven Rostedt 	return val & RB_FLAG_MASK;
84677ae365eSSteven Rostedt }
84777ae365eSSteven Rostedt 
84877ae365eSSteven Rostedt /*
84977ae365eSSteven Rostedt  * rb_is_reader_page
85077ae365eSSteven Rostedt  *
85177ae365eSSteven Rostedt  * The unique thing about the reader page, is that, if the
85277ae365eSSteven Rostedt  * writer is ever on it, the previous pointer never points
85377ae365eSSteven Rostedt  * back to the reader page.
85477ae365eSSteven Rostedt  */
85577ae365eSSteven Rostedt static int rb_is_reader_page(struct buffer_page *page)
85677ae365eSSteven Rostedt {
85777ae365eSSteven Rostedt 	struct list_head *list = page->list.prev;
85877ae365eSSteven Rostedt 
85977ae365eSSteven Rostedt 	return rb_list_head(list->next) != &page->list;
86077ae365eSSteven Rostedt }
86177ae365eSSteven Rostedt 
86277ae365eSSteven Rostedt /*
86377ae365eSSteven Rostedt  * rb_set_list_to_head - set a list_head to be pointing to head.
86477ae365eSSteven Rostedt  */
86577ae365eSSteven Rostedt static void rb_set_list_to_head(struct ring_buffer_per_cpu *cpu_buffer,
86677ae365eSSteven Rostedt 				struct list_head *list)
86777ae365eSSteven Rostedt {
86877ae365eSSteven Rostedt 	unsigned long *ptr;
86977ae365eSSteven Rostedt 
87077ae365eSSteven Rostedt 	ptr = (unsigned long *)&list->next;
87177ae365eSSteven Rostedt 	*ptr |= RB_PAGE_HEAD;
87277ae365eSSteven Rostedt 	*ptr &= ~RB_PAGE_UPDATE;
87377ae365eSSteven Rostedt }
87477ae365eSSteven Rostedt 
87577ae365eSSteven Rostedt /*
87677ae365eSSteven Rostedt  * rb_head_page_activate - sets up head page
87777ae365eSSteven Rostedt  */
87877ae365eSSteven Rostedt static void rb_head_page_activate(struct ring_buffer_per_cpu *cpu_buffer)
87977ae365eSSteven Rostedt {
88077ae365eSSteven Rostedt 	struct buffer_page *head;
88177ae365eSSteven Rostedt 
88277ae365eSSteven Rostedt 	head = cpu_buffer->head_page;
88377ae365eSSteven Rostedt 	if (!head)
88477ae365eSSteven Rostedt 		return;
88577ae365eSSteven Rostedt 
88677ae365eSSteven Rostedt 	/*
88777ae365eSSteven Rostedt 	 * Set the previous list pointer to have the HEAD flag.
88877ae365eSSteven Rostedt 	 */
88977ae365eSSteven Rostedt 	rb_set_list_to_head(cpu_buffer, head->list.prev);
89077ae365eSSteven Rostedt }
89177ae365eSSteven Rostedt 
89277ae365eSSteven Rostedt static void rb_list_head_clear(struct list_head *list)
89377ae365eSSteven Rostedt {
89477ae365eSSteven Rostedt 	unsigned long *ptr = (unsigned long *)&list->next;
89577ae365eSSteven Rostedt 
89677ae365eSSteven Rostedt 	*ptr &= ~RB_FLAG_MASK;
89777ae365eSSteven Rostedt }
89877ae365eSSteven Rostedt 
89977ae365eSSteven Rostedt /*
90077ae365eSSteven Rostedt  * rb_head_page_dactivate - clears head page ptr (for free list)
90177ae365eSSteven Rostedt  */
90277ae365eSSteven Rostedt static void
90377ae365eSSteven Rostedt rb_head_page_deactivate(struct ring_buffer_per_cpu *cpu_buffer)
90477ae365eSSteven Rostedt {
90577ae365eSSteven Rostedt 	struct list_head *hd;
90677ae365eSSteven Rostedt 
90777ae365eSSteven Rostedt 	/* Go through the whole list and clear any pointers found. */
90877ae365eSSteven Rostedt 	rb_list_head_clear(cpu_buffer->pages);
90977ae365eSSteven Rostedt 
91077ae365eSSteven Rostedt 	list_for_each(hd, cpu_buffer->pages)
91177ae365eSSteven Rostedt 		rb_list_head_clear(hd);
91277ae365eSSteven Rostedt }
91377ae365eSSteven Rostedt 
91477ae365eSSteven Rostedt static int rb_head_page_set(struct ring_buffer_per_cpu *cpu_buffer,
91577ae365eSSteven Rostedt 			    struct buffer_page *head,
91677ae365eSSteven Rostedt 			    struct buffer_page *prev,
91777ae365eSSteven Rostedt 			    int old_flag, int new_flag)
91877ae365eSSteven Rostedt {
91977ae365eSSteven Rostedt 	struct list_head *list;
92077ae365eSSteven Rostedt 	unsigned long val = (unsigned long)&head->list;
92177ae365eSSteven Rostedt 	unsigned long ret;
92277ae365eSSteven Rostedt 
92377ae365eSSteven Rostedt 	list = &prev->list;
92477ae365eSSteven Rostedt 
92577ae365eSSteven Rostedt 	val &= ~RB_FLAG_MASK;
92677ae365eSSteven Rostedt 
92708a40816SSteven Rostedt 	ret = cmpxchg((unsigned long *)&list->next,
92877ae365eSSteven Rostedt 		      val | old_flag, val | new_flag);
92977ae365eSSteven Rostedt 
93077ae365eSSteven Rostedt 	/* check if the reader took the page */
93177ae365eSSteven Rostedt 	if ((ret & ~RB_FLAG_MASK) != val)
93277ae365eSSteven Rostedt 		return RB_PAGE_MOVED;
93377ae365eSSteven Rostedt 
93477ae365eSSteven Rostedt 	return ret & RB_FLAG_MASK;
93577ae365eSSteven Rostedt }
93677ae365eSSteven Rostedt 
93777ae365eSSteven Rostedt static int rb_head_page_set_update(struct ring_buffer_per_cpu *cpu_buffer,
93877ae365eSSteven Rostedt 				   struct buffer_page *head,
93977ae365eSSteven Rostedt 				   struct buffer_page *prev,
94077ae365eSSteven Rostedt 				   int old_flag)
94177ae365eSSteven Rostedt {
94277ae365eSSteven Rostedt 	return rb_head_page_set(cpu_buffer, head, prev,
94377ae365eSSteven Rostedt 				old_flag, RB_PAGE_UPDATE);
94477ae365eSSteven Rostedt }
94577ae365eSSteven Rostedt 
94677ae365eSSteven Rostedt static int rb_head_page_set_head(struct ring_buffer_per_cpu *cpu_buffer,
94777ae365eSSteven Rostedt 				 struct buffer_page *head,
94877ae365eSSteven Rostedt 				 struct buffer_page *prev,
94977ae365eSSteven Rostedt 				 int old_flag)
95077ae365eSSteven Rostedt {
95177ae365eSSteven Rostedt 	return rb_head_page_set(cpu_buffer, head, prev,
95277ae365eSSteven Rostedt 				old_flag, RB_PAGE_HEAD);
95377ae365eSSteven Rostedt }
95477ae365eSSteven Rostedt 
95577ae365eSSteven Rostedt static int rb_head_page_set_normal(struct ring_buffer_per_cpu *cpu_buffer,
95677ae365eSSteven Rostedt 				   struct buffer_page *head,
95777ae365eSSteven Rostedt 				   struct buffer_page *prev,
95877ae365eSSteven Rostedt 				   int old_flag)
95977ae365eSSteven Rostedt {
96077ae365eSSteven Rostedt 	return rb_head_page_set(cpu_buffer, head, prev,
96177ae365eSSteven Rostedt 				old_flag, RB_PAGE_NORMAL);
96277ae365eSSteven Rostedt }
96377ae365eSSteven Rostedt 
96477ae365eSSteven Rostedt static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
96577ae365eSSteven Rostedt 			       struct buffer_page **bpage)
96677ae365eSSteven Rostedt {
96777ae365eSSteven Rostedt 	struct list_head *p = rb_list_head((*bpage)->list.next);
96877ae365eSSteven Rostedt 
96977ae365eSSteven Rostedt 	*bpage = list_entry(p, struct buffer_page, list);
97077ae365eSSteven Rostedt }
97177ae365eSSteven Rostedt 
97277ae365eSSteven Rostedt static struct buffer_page *
97377ae365eSSteven Rostedt rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer)
97477ae365eSSteven Rostedt {
97577ae365eSSteven Rostedt 	struct buffer_page *head;
97677ae365eSSteven Rostedt 	struct buffer_page *page;
97777ae365eSSteven Rostedt 	struct list_head *list;
97877ae365eSSteven Rostedt 	int i;
97977ae365eSSteven Rostedt 
98077ae365eSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page))
98177ae365eSSteven Rostedt 		return NULL;
98277ae365eSSteven Rostedt 
98377ae365eSSteven Rostedt 	/* sanity check */
98477ae365eSSteven Rostedt 	list = cpu_buffer->pages;
98577ae365eSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev->next) != list))
98677ae365eSSteven Rostedt 		return NULL;
98777ae365eSSteven Rostedt 
98877ae365eSSteven Rostedt 	page = head = cpu_buffer->head_page;
98977ae365eSSteven Rostedt 	/*
99077ae365eSSteven Rostedt 	 * It is possible that the writer moves the header behind
99177ae365eSSteven Rostedt 	 * where we started, and we miss in one loop.
99277ae365eSSteven Rostedt 	 * A second loop should grab the header, but we'll do
99377ae365eSSteven Rostedt 	 * three loops just because I'm paranoid.
99477ae365eSSteven Rostedt 	 */
99577ae365eSSteven Rostedt 	for (i = 0; i < 3; i++) {
99677ae365eSSteven Rostedt 		do {
99777ae365eSSteven Rostedt 			if (rb_is_head_page(cpu_buffer, page, page->list.prev)) {
99877ae365eSSteven Rostedt 				cpu_buffer->head_page = page;
99977ae365eSSteven Rostedt 				return page;
100077ae365eSSteven Rostedt 			}
100177ae365eSSteven Rostedt 			rb_inc_page(cpu_buffer, &page);
100277ae365eSSteven Rostedt 		} while (page != head);
100377ae365eSSteven Rostedt 	}
100477ae365eSSteven Rostedt 
100577ae365eSSteven Rostedt 	RB_WARN_ON(cpu_buffer, 1);
100677ae365eSSteven Rostedt 
100777ae365eSSteven Rostedt 	return NULL;
100877ae365eSSteven Rostedt }
100977ae365eSSteven Rostedt 
101077ae365eSSteven Rostedt static int rb_head_page_replace(struct buffer_page *old,
101177ae365eSSteven Rostedt 				struct buffer_page *new)
101277ae365eSSteven Rostedt {
101377ae365eSSteven Rostedt 	unsigned long *ptr = (unsigned long *)&old->list.prev->next;
101477ae365eSSteven Rostedt 	unsigned long val;
101577ae365eSSteven Rostedt 	unsigned long ret;
101677ae365eSSteven Rostedt 
101777ae365eSSteven Rostedt 	val = *ptr & ~RB_FLAG_MASK;
101877ae365eSSteven Rostedt 	val |= RB_PAGE_HEAD;
101977ae365eSSteven Rostedt 
102008a40816SSteven Rostedt 	ret = cmpxchg(ptr, val, (unsigned long)&new->list);
102177ae365eSSteven Rostedt 
102277ae365eSSteven Rostedt 	return ret == val;
102377ae365eSSteven Rostedt }
102477ae365eSSteven Rostedt 
102577ae365eSSteven Rostedt /*
102677ae365eSSteven Rostedt  * rb_tail_page_update - move the tail page forward
102777ae365eSSteven Rostedt  *
102877ae365eSSteven Rostedt  * Returns 1 if moved tail page, 0 if someone else did.
102977ae365eSSteven Rostedt  */
103077ae365eSSteven Rostedt static int rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer,
103177ae365eSSteven Rostedt 			       struct buffer_page *tail_page,
103277ae365eSSteven Rostedt 			       struct buffer_page *next_page)
103377ae365eSSteven Rostedt {
103477ae365eSSteven Rostedt 	struct buffer_page *old_tail;
103577ae365eSSteven Rostedt 	unsigned long old_entries;
103677ae365eSSteven Rostedt 	unsigned long old_write;
103777ae365eSSteven Rostedt 	int ret = 0;
103877ae365eSSteven Rostedt 
103977ae365eSSteven Rostedt 	/*
104077ae365eSSteven Rostedt 	 * The tail page now needs to be moved forward.
104177ae365eSSteven Rostedt 	 *
104277ae365eSSteven Rostedt 	 * We need to reset the tail page, but without messing
104377ae365eSSteven Rostedt 	 * with possible erasing of data brought in by interrupts
104477ae365eSSteven Rostedt 	 * that have moved the tail page and are currently on it.
104577ae365eSSteven Rostedt 	 *
104677ae365eSSteven Rostedt 	 * We add a counter to the write field to denote this.
104777ae365eSSteven Rostedt 	 */
104877ae365eSSteven Rostedt 	old_write = local_add_return(RB_WRITE_INTCNT, &next_page->write);
104977ae365eSSteven Rostedt 	old_entries = local_add_return(RB_WRITE_INTCNT, &next_page->entries);
105077ae365eSSteven Rostedt 
105177ae365eSSteven Rostedt 	/*
105277ae365eSSteven Rostedt 	 * Just make sure we have seen our old_write and synchronize
105377ae365eSSteven Rostedt 	 * with any interrupts that come in.
105477ae365eSSteven Rostedt 	 */
105577ae365eSSteven Rostedt 	barrier();
105677ae365eSSteven Rostedt 
105777ae365eSSteven Rostedt 	/*
105877ae365eSSteven Rostedt 	 * If the tail page is still the same as what we think
105977ae365eSSteven Rostedt 	 * it is, then it is up to us to update the tail
106077ae365eSSteven Rostedt 	 * pointer.
106177ae365eSSteven Rostedt 	 */
106277ae365eSSteven Rostedt 	if (tail_page == cpu_buffer->tail_page) {
106377ae365eSSteven Rostedt 		/* Zero the write counter */
106477ae365eSSteven Rostedt 		unsigned long val = old_write & ~RB_WRITE_MASK;
106577ae365eSSteven Rostedt 		unsigned long eval = old_entries & ~RB_WRITE_MASK;
106677ae365eSSteven Rostedt 
106777ae365eSSteven Rostedt 		/*
106877ae365eSSteven Rostedt 		 * This will only succeed if an interrupt did
106977ae365eSSteven Rostedt 		 * not come in and change it. In which case, we
107077ae365eSSteven Rostedt 		 * do not want to modify it.
1071da706d8bSLai Jiangshan 		 *
1072da706d8bSLai Jiangshan 		 * We add (void) to let the compiler know that we do not care
1073da706d8bSLai Jiangshan 		 * about the return value of these functions. We use the
1074da706d8bSLai Jiangshan 		 * cmpxchg to only update if an interrupt did not already
1075da706d8bSLai Jiangshan 		 * do it for us. If the cmpxchg fails, we don't care.
107677ae365eSSteven Rostedt 		 */
1077da706d8bSLai Jiangshan 		(void)local_cmpxchg(&next_page->write, old_write, val);
1078da706d8bSLai Jiangshan 		(void)local_cmpxchg(&next_page->entries, old_entries, eval);
107977ae365eSSteven Rostedt 
108077ae365eSSteven Rostedt 		/*
108177ae365eSSteven Rostedt 		 * No need to worry about races with clearing out the commit.
108277ae365eSSteven Rostedt 		 * it only can increment when a commit takes place. But that
108377ae365eSSteven Rostedt 		 * only happens in the outer most nested commit.
108477ae365eSSteven Rostedt 		 */
108577ae365eSSteven Rostedt 		local_set(&next_page->page->commit, 0);
108677ae365eSSteven Rostedt 
108777ae365eSSteven Rostedt 		old_tail = cmpxchg(&cpu_buffer->tail_page,
108877ae365eSSteven Rostedt 				   tail_page, next_page);
108977ae365eSSteven Rostedt 
109077ae365eSSteven Rostedt 		if (old_tail == tail_page)
109177ae365eSSteven Rostedt 			ret = 1;
109277ae365eSSteven Rostedt 	}
109377ae365eSSteven Rostedt 
109477ae365eSSteven Rostedt 	return ret;
109577ae365eSSteven Rostedt }
109677ae365eSSteven Rostedt 
109777ae365eSSteven Rostedt static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer,
109877ae365eSSteven Rostedt 			  struct buffer_page *bpage)
109977ae365eSSteven Rostedt {
110077ae365eSSteven Rostedt 	unsigned long val = (unsigned long)bpage;
110177ae365eSSteven Rostedt 
110277ae365eSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, val & RB_FLAG_MASK))
110377ae365eSSteven Rostedt 		return 1;
110477ae365eSSteven Rostedt 
110577ae365eSSteven Rostedt 	return 0;
110677ae365eSSteven Rostedt }
110777ae365eSSteven Rostedt 
110877ae365eSSteven Rostedt /**
110977ae365eSSteven Rostedt  * rb_check_list - make sure a pointer to a list has the last bits zero
111077ae365eSSteven Rostedt  */
111177ae365eSSteven Rostedt static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
111277ae365eSSteven Rostedt 			 struct list_head *list)
111377ae365eSSteven Rostedt {
111477ae365eSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev) != list->prev))
111577ae365eSSteven Rostedt 		return 1;
111677ae365eSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, rb_list_head(list->next) != list->next))
111777ae365eSSteven Rostedt 		return 1;
111877ae365eSSteven Rostedt 	return 0;
111977ae365eSSteven Rostedt }
112077ae365eSSteven Rostedt 
11217a8e76a3SSteven Rostedt /**
1122d611851bSzhangwei(Jovi)  * rb_check_pages - integrity check of buffer pages
11237a8e76a3SSteven Rostedt  * @cpu_buffer: CPU buffer with pages to test
11247a8e76a3SSteven Rostedt  *
1125c3706f00SWenji Huang  * As a safety measure we check to make sure the data pages have not
11267a8e76a3SSteven Rostedt  * been corrupted.
11277a8e76a3SSteven Rostedt  */
11287a8e76a3SSteven Rostedt static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
11297a8e76a3SSteven Rostedt {
11303adc54faSSteven Rostedt 	struct list_head *head = cpu_buffer->pages;
1131044fa782SSteven Rostedt 	struct buffer_page *bpage, *tmp;
11327a8e76a3SSteven Rostedt 
1133308f7eebSSteven Rostedt 	/* Reset the head page if it exists */
1134308f7eebSSteven Rostedt 	if (cpu_buffer->head_page)
1135308f7eebSSteven Rostedt 		rb_set_head_page(cpu_buffer);
1136308f7eebSSteven Rostedt 
113777ae365eSSteven Rostedt 	rb_head_page_deactivate(cpu_buffer);
113877ae365eSSteven Rostedt 
11393e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
11403e89c7bbSSteven Rostedt 		return -1;
11413e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
11423e89c7bbSSteven Rostedt 		return -1;
11437a8e76a3SSteven Rostedt 
114477ae365eSSteven Rostedt 	if (rb_check_list(cpu_buffer, head))
114577ae365eSSteven Rostedt 		return -1;
114677ae365eSSteven Rostedt 
1147044fa782SSteven Rostedt 	list_for_each_entry_safe(bpage, tmp, head, list) {
11483e89c7bbSSteven Rostedt 		if (RB_WARN_ON(cpu_buffer,
1149044fa782SSteven Rostedt 			       bpage->list.next->prev != &bpage->list))
11503e89c7bbSSteven Rostedt 			return -1;
11513e89c7bbSSteven Rostedt 		if (RB_WARN_ON(cpu_buffer,
1152044fa782SSteven Rostedt 			       bpage->list.prev->next != &bpage->list))
11533e89c7bbSSteven Rostedt 			return -1;
115477ae365eSSteven Rostedt 		if (rb_check_list(cpu_buffer, &bpage->list))
115577ae365eSSteven Rostedt 			return -1;
11567a8e76a3SSteven Rostedt 	}
11577a8e76a3SSteven Rostedt 
115877ae365eSSteven Rostedt 	rb_head_page_activate(cpu_buffer);
115977ae365eSSteven Rostedt 
11607a8e76a3SSteven Rostedt 	return 0;
11617a8e76a3SSteven Rostedt }
11627a8e76a3SSteven Rostedt 
1163438ced17SVaibhav Nagarnaik static int __rb_allocate_pages(int nr_pages, struct list_head *pages, int cpu)
11647a8e76a3SSteven Rostedt {
1165438ced17SVaibhav Nagarnaik 	int i;
1166044fa782SSteven Rostedt 	struct buffer_page *bpage, *tmp;
11673adc54faSSteven Rostedt 
11687a8e76a3SSteven Rostedt 	for (i = 0; i < nr_pages; i++) {
11697ea59064SVaibhav Nagarnaik 		struct page *page;
1170d7ec4bfeSVaibhav Nagarnaik 		/*
1171d7ec4bfeSVaibhav Nagarnaik 		 * __GFP_NORETRY flag makes sure that the allocation fails
1172d7ec4bfeSVaibhav Nagarnaik 		 * gracefully without invoking oom-killer and the system is
1173d7ec4bfeSVaibhav Nagarnaik 		 * not destabilized.
1174d7ec4bfeSVaibhav Nagarnaik 		 */
1175044fa782SSteven Rostedt 		bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
1176d7ec4bfeSVaibhav Nagarnaik 				    GFP_KERNEL | __GFP_NORETRY,
1177438ced17SVaibhav Nagarnaik 				    cpu_to_node(cpu));
1178044fa782SSteven Rostedt 		if (!bpage)
1179e4c2ce82SSteven Rostedt 			goto free_pages;
118077ae365eSSteven Rostedt 
1181438ced17SVaibhav Nagarnaik 		list_add(&bpage->list, pages);
118277ae365eSSteven Rostedt 
1183438ced17SVaibhav Nagarnaik 		page = alloc_pages_node(cpu_to_node(cpu),
1184d7ec4bfeSVaibhav Nagarnaik 					GFP_KERNEL | __GFP_NORETRY, 0);
11857ea59064SVaibhav Nagarnaik 		if (!page)
11867a8e76a3SSteven Rostedt 			goto free_pages;
11877ea59064SVaibhav Nagarnaik 		bpage->page = page_address(page);
1188044fa782SSteven Rostedt 		rb_init_page(bpage->page);
11897a8e76a3SSteven Rostedt 	}
11907a8e76a3SSteven Rostedt 
1191438ced17SVaibhav Nagarnaik 	return 0;
1192438ced17SVaibhav Nagarnaik 
1193438ced17SVaibhav Nagarnaik free_pages:
1194438ced17SVaibhav Nagarnaik 	list_for_each_entry_safe(bpage, tmp, pages, list) {
1195438ced17SVaibhav Nagarnaik 		list_del_init(&bpage->list);
1196438ced17SVaibhav Nagarnaik 		free_buffer_page(bpage);
1197438ced17SVaibhav Nagarnaik 	}
1198438ced17SVaibhav Nagarnaik 
1199438ced17SVaibhav Nagarnaik 	return -ENOMEM;
1200438ced17SVaibhav Nagarnaik }
1201438ced17SVaibhav Nagarnaik 
1202438ced17SVaibhav Nagarnaik static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
1203438ced17SVaibhav Nagarnaik 			     unsigned nr_pages)
1204438ced17SVaibhav Nagarnaik {
1205438ced17SVaibhav Nagarnaik 	LIST_HEAD(pages);
1206438ced17SVaibhav Nagarnaik 
1207438ced17SVaibhav Nagarnaik 	WARN_ON(!nr_pages);
1208438ced17SVaibhav Nagarnaik 
1209438ced17SVaibhav Nagarnaik 	if (__rb_allocate_pages(nr_pages, &pages, cpu_buffer->cpu))
1210438ced17SVaibhav Nagarnaik 		return -ENOMEM;
1211438ced17SVaibhav Nagarnaik 
12123adc54faSSteven Rostedt 	/*
12133adc54faSSteven Rostedt 	 * The ring buffer page list is a circular list that does not
12143adc54faSSteven Rostedt 	 * start and end with a list head. All page list items point to
12153adc54faSSteven Rostedt 	 * other pages.
12163adc54faSSteven Rostedt 	 */
12173adc54faSSteven Rostedt 	cpu_buffer->pages = pages.next;
12183adc54faSSteven Rostedt 	list_del(&pages);
12197a8e76a3SSteven Rostedt 
1220438ced17SVaibhav Nagarnaik 	cpu_buffer->nr_pages = nr_pages;
1221438ced17SVaibhav Nagarnaik 
12227a8e76a3SSteven Rostedt 	rb_check_pages(cpu_buffer);
12237a8e76a3SSteven Rostedt 
12247a8e76a3SSteven Rostedt 	return 0;
12257a8e76a3SSteven Rostedt }
12267a8e76a3SSteven Rostedt 
12277a8e76a3SSteven Rostedt static struct ring_buffer_per_cpu *
1228438ced17SVaibhav Nagarnaik rb_allocate_cpu_buffer(struct ring_buffer *buffer, int nr_pages, int cpu)
12297a8e76a3SSteven Rostedt {
12307a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
1231044fa782SSteven Rostedt 	struct buffer_page *bpage;
12327ea59064SVaibhav Nagarnaik 	struct page *page;
12337a8e76a3SSteven Rostedt 	int ret;
12347a8e76a3SSteven Rostedt 
12357a8e76a3SSteven Rostedt 	cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
12367a8e76a3SSteven Rostedt 				  GFP_KERNEL, cpu_to_node(cpu));
12377a8e76a3SSteven Rostedt 	if (!cpu_buffer)
12387a8e76a3SSteven Rostedt 		return NULL;
12397a8e76a3SSteven Rostedt 
12407a8e76a3SSteven Rostedt 	cpu_buffer->cpu = cpu;
12417a8e76a3SSteven Rostedt 	cpu_buffer->buffer = buffer;
12425389f6faSThomas Gleixner 	raw_spin_lock_init(&cpu_buffer->reader_lock);
12431f8a6a10SPeter Zijlstra 	lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
1244edc35bd7SThomas Gleixner 	cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
124583f40318SVaibhav Nagarnaik 	INIT_WORK(&cpu_buffer->update_pages_work, update_pages_handler);
124605fdd70dSVaibhav Nagarnaik 	init_completion(&cpu_buffer->update_done);
124715693458SSteven Rostedt (Red Hat) 	init_irq_work(&cpu_buffer->irq_work.work, rb_wake_up_waiters);
1248f1dc6725SSteven Rostedt (Red Hat) 	init_waitqueue_head(&cpu_buffer->irq_work.waiters);
12491e0d6714SSteven Rostedt (Red Hat) 	init_waitqueue_head(&cpu_buffer->irq_work.full_waiters);
12507a8e76a3SSteven Rostedt 
1251044fa782SSteven Rostedt 	bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
1252e4c2ce82SSteven Rostedt 			    GFP_KERNEL, cpu_to_node(cpu));
1253044fa782SSteven Rostedt 	if (!bpage)
1254e4c2ce82SSteven Rostedt 		goto fail_free_buffer;
1255e4c2ce82SSteven Rostedt 
125677ae365eSSteven Rostedt 	rb_check_bpage(cpu_buffer, bpage);
125777ae365eSSteven Rostedt 
1258044fa782SSteven Rostedt 	cpu_buffer->reader_page = bpage;
12597ea59064SVaibhav Nagarnaik 	page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
12607ea59064SVaibhav Nagarnaik 	if (!page)
1261e4c2ce82SSteven Rostedt 		goto fail_free_reader;
12627ea59064SVaibhav Nagarnaik 	bpage->page = page_address(page);
1263044fa782SSteven Rostedt 	rb_init_page(bpage->page);
1264e4c2ce82SSteven Rostedt 
1265d769041fSSteven Rostedt 	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
126644b99462SVaibhav Nagarnaik 	INIT_LIST_HEAD(&cpu_buffer->new_pages);
1267d769041fSSteven Rostedt 
1268438ced17SVaibhav Nagarnaik 	ret = rb_allocate_pages(cpu_buffer, nr_pages);
12697a8e76a3SSteven Rostedt 	if (ret < 0)
1270d769041fSSteven Rostedt 		goto fail_free_reader;
12717a8e76a3SSteven Rostedt 
12727a8e76a3SSteven Rostedt 	cpu_buffer->head_page
12733adc54faSSteven Rostedt 		= list_entry(cpu_buffer->pages, struct buffer_page, list);
1274bf41a158SSteven Rostedt 	cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
12757a8e76a3SSteven Rostedt 
127677ae365eSSteven Rostedt 	rb_head_page_activate(cpu_buffer);
127777ae365eSSteven Rostedt 
12787a8e76a3SSteven Rostedt 	return cpu_buffer;
12797a8e76a3SSteven Rostedt 
1280d769041fSSteven Rostedt  fail_free_reader:
1281d769041fSSteven Rostedt 	free_buffer_page(cpu_buffer->reader_page);
1282d769041fSSteven Rostedt 
12837a8e76a3SSteven Rostedt  fail_free_buffer:
12847a8e76a3SSteven Rostedt 	kfree(cpu_buffer);
12857a8e76a3SSteven Rostedt 	return NULL;
12867a8e76a3SSteven Rostedt }
12877a8e76a3SSteven Rostedt 
12887a8e76a3SSteven Rostedt static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
12897a8e76a3SSteven Rostedt {
12903adc54faSSteven Rostedt 	struct list_head *head = cpu_buffer->pages;
1291044fa782SSteven Rostedt 	struct buffer_page *bpage, *tmp;
12927a8e76a3SSteven Rostedt 
1293d769041fSSteven Rostedt 	free_buffer_page(cpu_buffer->reader_page);
1294d769041fSSteven Rostedt 
129577ae365eSSteven Rostedt 	rb_head_page_deactivate(cpu_buffer);
129677ae365eSSteven Rostedt 
12973adc54faSSteven Rostedt 	if (head) {
1298044fa782SSteven Rostedt 		list_for_each_entry_safe(bpage, tmp, head, list) {
1299044fa782SSteven Rostedt 			list_del_init(&bpage->list);
1300044fa782SSteven Rostedt 			free_buffer_page(bpage);
13017a8e76a3SSteven Rostedt 		}
13023adc54faSSteven Rostedt 		bpage = list_entry(head, struct buffer_page, list);
13033adc54faSSteven Rostedt 		free_buffer_page(bpage);
13043adc54faSSteven Rostedt 	}
13053adc54faSSteven Rostedt 
13067a8e76a3SSteven Rostedt 	kfree(cpu_buffer);
13077a8e76a3SSteven Rostedt }
13087a8e76a3SSteven Rostedt 
130959222efeSSteven Rostedt #ifdef CONFIG_HOTPLUG_CPU
131009c9e84dSFrederic Weisbecker static int rb_cpu_notify(struct notifier_block *self,
1311554f786eSSteven Rostedt 			 unsigned long action, void *hcpu);
1312554f786eSSteven Rostedt #endif
1313554f786eSSteven Rostedt 
13147a8e76a3SSteven Rostedt /**
1315d611851bSzhangwei(Jovi)  * __ring_buffer_alloc - allocate a new ring_buffer
131668814b58SRobert Richter  * @size: the size in bytes per cpu that is needed.
13177a8e76a3SSteven Rostedt  * @flags: attributes to set for the ring buffer.
13187a8e76a3SSteven Rostedt  *
13197a8e76a3SSteven Rostedt  * Currently the only flag that is available is the RB_FL_OVERWRITE
13207a8e76a3SSteven Rostedt  * flag. This flag means that the buffer will overwrite old data
13217a8e76a3SSteven Rostedt  * when the buffer wraps. If this flag is not set, the buffer will
13227a8e76a3SSteven Rostedt  * drop data when the tail hits the head.
13237a8e76a3SSteven Rostedt  */
13241f8a6a10SPeter Zijlstra struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
13251f8a6a10SPeter Zijlstra 					struct lock_class_key *key)
13267a8e76a3SSteven Rostedt {
13277a8e76a3SSteven Rostedt 	struct ring_buffer *buffer;
13287a8e76a3SSteven Rostedt 	int bsize;
1329438ced17SVaibhav Nagarnaik 	int cpu, nr_pages;
13307a8e76a3SSteven Rostedt 
13317a8e76a3SSteven Rostedt 	/* keep it in its own cache line */
13327a8e76a3SSteven Rostedt 	buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
13337a8e76a3SSteven Rostedt 			 GFP_KERNEL);
13347a8e76a3SSteven Rostedt 	if (!buffer)
13357a8e76a3SSteven Rostedt 		return NULL;
13367a8e76a3SSteven Rostedt 
13379e01c1b7SRusty Russell 	if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
13389e01c1b7SRusty Russell 		goto fail_free_buffer;
13399e01c1b7SRusty Russell 
1340438ced17SVaibhav Nagarnaik 	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
13417a8e76a3SSteven Rostedt 	buffer->flags = flags;
134237886f6aSSteven Rostedt 	buffer->clock = trace_clock_local;
13431f8a6a10SPeter Zijlstra 	buffer->reader_lock_key = key;
13447a8e76a3SSteven Rostedt 
134515693458SSteven Rostedt (Red Hat) 	init_irq_work(&buffer->irq_work.work, rb_wake_up_waiters);
1346f1dc6725SSteven Rostedt (Red Hat) 	init_waitqueue_head(&buffer->irq_work.waiters);
134715693458SSteven Rostedt (Red Hat) 
13487a8e76a3SSteven Rostedt 	/* need at least two pages */
1349438ced17SVaibhav Nagarnaik 	if (nr_pages < 2)
1350438ced17SVaibhav Nagarnaik 		nr_pages = 2;
13517a8e76a3SSteven Rostedt 
13523bf832ceSFrederic Weisbecker 	/*
13533bf832ceSFrederic Weisbecker 	 * In case of non-hotplug cpu, if the ring-buffer is allocated
13543bf832ceSFrederic Weisbecker 	 * in early initcall, it will not be notified of secondary cpus.
13553bf832ceSFrederic Weisbecker 	 * In that off case, we need to allocate for all possible cpus.
13563bf832ceSFrederic Weisbecker 	 */
13573bf832ceSFrederic Weisbecker #ifdef CONFIG_HOTPLUG_CPU
1358d39ad278SSrivatsa S. Bhat 	cpu_notifier_register_begin();
1359554f786eSSteven Rostedt 	cpumask_copy(buffer->cpumask, cpu_online_mask);
13603bf832ceSFrederic Weisbecker #else
13613bf832ceSFrederic Weisbecker 	cpumask_copy(buffer->cpumask, cpu_possible_mask);
13623bf832ceSFrederic Weisbecker #endif
13637a8e76a3SSteven Rostedt 	buffer->cpus = nr_cpu_ids;
13647a8e76a3SSteven Rostedt 
13657a8e76a3SSteven Rostedt 	bsize = sizeof(void *) * nr_cpu_ids;
13667a8e76a3SSteven Rostedt 	buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
13677a8e76a3SSteven Rostedt 				  GFP_KERNEL);
13687a8e76a3SSteven Rostedt 	if (!buffer->buffers)
13699e01c1b7SRusty Russell 		goto fail_free_cpumask;
13707a8e76a3SSteven Rostedt 
13717a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu) {
13727a8e76a3SSteven Rostedt 		buffer->buffers[cpu] =
1373438ced17SVaibhav Nagarnaik 			rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
13747a8e76a3SSteven Rostedt 		if (!buffer->buffers[cpu])
13757a8e76a3SSteven Rostedt 			goto fail_free_buffers;
13767a8e76a3SSteven Rostedt 	}
13777a8e76a3SSteven Rostedt 
137859222efeSSteven Rostedt #ifdef CONFIG_HOTPLUG_CPU
1379554f786eSSteven Rostedt 	buffer->cpu_notify.notifier_call = rb_cpu_notify;
1380554f786eSSteven Rostedt 	buffer->cpu_notify.priority = 0;
1381d39ad278SSrivatsa S. Bhat 	__register_cpu_notifier(&buffer->cpu_notify);
1382d39ad278SSrivatsa S. Bhat 	cpu_notifier_register_done();
1383554f786eSSteven Rostedt #endif
1384554f786eSSteven Rostedt 
13857a8e76a3SSteven Rostedt 	mutex_init(&buffer->mutex);
13867a8e76a3SSteven Rostedt 
13877a8e76a3SSteven Rostedt 	return buffer;
13887a8e76a3SSteven Rostedt 
13897a8e76a3SSteven Rostedt  fail_free_buffers:
13907a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu) {
13917a8e76a3SSteven Rostedt 		if (buffer->buffers[cpu])
13927a8e76a3SSteven Rostedt 			rb_free_cpu_buffer(buffer->buffers[cpu]);
13937a8e76a3SSteven Rostedt 	}
13947a8e76a3SSteven Rostedt 	kfree(buffer->buffers);
13957a8e76a3SSteven Rostedt 
13969e01c1b7SRusty Russell  fail_free_cpumask:
13979e01c1b7SRusty Russell 	free_cpumask_var(buffer->cpumask);
1398d39ad278SSrivatsa S. Bhat #ifdef CONFIG_HOTPLUG_CPU
1399d39ad278SSrivatsa S. Bhat 	cpu_notifier_register_done();
1400d39ad278SSrivatsa S. Bhat #endif
14019e01c1b7SRusty Russell 
14027a8e76a3SSteven Rostedt  fail_free_buffer:
14037a8e76a3SSteven Rostedt 	kfree(buffer);
14047a8e76a3SSteven Rostedt 	return NULL;
14057a8e76a3SSteven Rostedt }
14061f8a6a10SPeter Zijlstra EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
14077a8e76a3SSteven Rostedt 
14087a8e76a3SSteven Rostedt /**
14097a8e76a3SSteven Rostedt  * ring_buffer_free - free a ring buffer.
14107a8e76a3SSteven Rostedt  * @buffer: the buffer to free.
14117a8e76a3SSteven Rostedt  */
14127a8e76a3SSteven Rostedt void
14137a8e76a3SSteven Rostedt ring_buffer_free(struct ring_buffer *buffer)
14147a8e76a3SSteven Rostedt {
14157a8e76a3SSteven Rostedt 	int cpu;
14167a8e76a3SSteven Rostedt 
141759222efeSSteven Rostedt #ifdef CONFIG_HOTPLUG_CPU
1418d39ad278SSrivatsa S. Bhat 	cpu_notifier_register_begin();
1419d39ad278SSrivatsa S. Bhat 	__unregister_cpu_notifier(&buffer->cpu_notify);
1420554f786eSSteven Rostedt #endif
1421554f786eSSteven Rostedt 
14227a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu)
14237a8e76a3SSteven Rostedt 		rb_free_cpu_buffer(buffer->buffers[cpu]);
14247a8e76a3SSteven Rostedt 
1425d39ad278SSrivatsa S. Bhat #ifdef CONFIG_HOTPLUG_CPU
1426d39ad278SSrivatsa S. Bhat 	cpu_notifier_register_done();
1427d39ad278SSrivatsa S. Bhat #endif
1428554f786eSSteven Rostedt 
1429bd3f0221SEric Dumazet 	kfree(buffer->buffers);
14309e01c1b7SRusty Russell 	free_cpumask_var(buffer->cpumask);
14319e01c1b7SRusty Russell 
14327a8e76a3SSteven Rostedt 	kfree(buffer);
14337a8e76a3SSteven Rostedt }
1434c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_free);
14357a8e76a3SSteven Rostedt 
143637886f6aSSteven Rostedt void ring_buffer_set_clock(struct ring_buffer *buffer,
143737886f6aSSteven Rostedt 			   u64 (*clock)(void))
143837886f6aSSteven Rostedt {
143937886f6aSSteven Rostedt 	buffer->clock = clock;
144037886f6aSSteven Rostedt }
144137886f6aSSteven Rostedt 
14427a8e76a3SSteven Rostedt static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
14437a8e76a3SSteven Rostedt 
144483f40318SVaibhav Nagarnaik static inline unsigned long rb_page_entries(struct buffer_page *bpage)
14457a8e76a3SSteven Rostedt {
144683f40318SVaibhav Nagarnaik 	return local_read(&bpage->entries) & RB_WRITE_MASK;
144783f40318SVaibhav Nagarnaik }
144883f40318SVaibhav Nagarnaik 
144983f40318SVaibhav Nagarnaik static inline unsigned long rb_page_write(struct buffer_page *bpage)
145083f40318SVaibhav Nagarnaik {
145183f40318SVaibhav Nagarnaik 	return local_read(&bpage->write) & RB_WRITE_MASK;
145283f40318SVaibhav Nagarnaik }
145383f40318SVaibhav Nagarnaik 
14545040b4b7SVaibhav Nagarnaik static int
145583f40318SVaibhav Nagarnaik rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned int nr_pages)
145683f40318SVaibhav Nagarnaik {
145783f40318SVaibhav Nagarnaik 	struct list_head *tail_page, *to_remove, *next_page;
145883f40318SVaibhav Nagarnaik 	struct buffer_page *to_remove_page, *tmp_iter_page;
145983f40318SVaibhav Nagarnaik 	struct buffer_page *last_page, *first_page;
146083f40318SVaibhav Nagarnaik 	unsigned int nr_removed;
146183f40318SVaibhav Nagarnaik 	unsigned long head_bit;
146283f40318SVaibhav Nagarnaik 	int page_entries;
146383f40318SVaibhav Nagarnaik 
146483f40318SVaibhav Nagarnaik 	head_bit = 0;
14657a8e76a3SSteven Rostedt 
14665389f6faSThomas Gleixner 	raw_spin_lock_irq(&cpu_buffer->reader_lock);
146783f40318SVaibhav Nagarnaik 	atomic_inc(&cpu_buffer->record_disabled);
146883f40318SVaibhav Nagarnaik 	/*
146983f40318SVaibhav Nagarnaik 	 * We don't race with the readers since we have acquired the reader
147083f40318SVaibhav Nagarnaik 	 * lock. We also don't race with writers after disabling recording.
147183f40318SVaibhav Nagarnaik 	 * This makes it easy to figure out the first and the last page to be
147283f40318SVaibhav Nagarnaik 	 * removed from the list. We unlink all the pages in between including
147383f40318SVaibhav Nagarnaik 	 * the first and last pages. This is done in a busy loop so that we
147483f40318SVaibhav Nagarnaik 	 * lose the least number of traces.
147583f40318SVaibhav Nagarnaik 	 * The pages are freed after we restart recording and unlock readers.
147683f40318SVaibhav Nagarnaik 	 */
147783f40318SVaibhav Nagarnaik 	tail_page = &cpu_buffer->tail_page->list;
147877ae365eSSteven Rostedt 
147983f40318SVaibhav Nagarnaik 	/*
148083f40318SVaibhav Nagarnaik 	 * tail page might be on reader page, we remove the next page
148183f40318SVaibhav Nagarnaik 	 * from the ring buffer
148283f40318SVaibhav Nagarnaik 	 */
148383f40318SVaibhav Nagarnaik 	if (cpu_buffer->tail_page == cpu_buffer->reader_page)
148483f40318SVaibhav Nagarnaik 		tail_page = rb_list_head(tail_page->next);
148583f40318SVaibhav Nagarnaik 	to_remove = tail_page;
148683f40318SVaibhav Nagarnaik 
148783f40318SVaibhav Nagarnaik 	/* start of pages to remove */
148883f40318SVaibhav Nagarnaik 	first_page = list_entry(rb_list_head(to_remove->next),
148983f40318SVaibhav Nagarnaik 				struct buffer_page, list);
149083f40318SVaibhav Nagarnaik 
149183f40318SVaibhav Nagarnaik 	for (nr_removed = 0; nr_removed < nr_pages; nr_removed++) {
149283f40318SVaibhav Nagarnaik 		to_remove = rb_list_head(to_remove)->next;
149383f40318SVaibhav Nagarnaik 		head_bit |= (unsigned long)to_remove & RB_PAGE_HEAD;
14947a8e76a3SSteven Rostedt 	}
14957a8e76a3SSteven Rostedt 
149683f40318SVaibhav Nagarnaik 	next_page = rb_list_head(to_remove)->next;
14977a8e76a3SSteven Rostedt 
149883f40318SVaibhav Nagarnaik 	/*
149983f40318SVaibhav Nagarnaik 	 * Now we remove all pages between tail_page and next_page.
150083f40318SVaibhav Nagarnaik 	 * Make sure that we have head_bit value preserved for the
150183f40318SVaibhav Nagarnaik 	 * next page
150283f40318SVaibhav Nagarnaik 	 */
150383f40318SVaibhav Nagarnaik 	tail_page->next = (struct list_head *)((unsigned long)next_page |
150483f40318SVaibhav Nagarnaik 						head_bit);
150583f40318SVaibhav Nagarnaik 	next_page = rb_list_head(next_page);
150683f40318SVaibhav Nagarnaik 	next_page->prev = tail_page;
150783f40318SVaibhav Nagarnaik 
150883f40318SVaibhav Nagarnaik 	/* make sure pages points to a valid page in the ring buffer */
150983f40318SVaibhav Nagarnaik 	cpu_buffer->pages = next_page;
151083f40318SVaibhav Nagarnaik 
151183f40318SVaibhav Nagarnaik 	/* update head page */
151283f40318SVaibhav Nagarnaik 	if (head_bit)
151383f40318SVaibhav Nagarnaik 		cpu_buffer->head_page = list_entry(next_page,
151483f40318SVaibhav Nagarnaik 						struct buffer_page, list);
151583f40318SVaibhav Nagarnaik 
151683f40318SVaibhav Nagarnaik 	/*
151783f40318SVaibhav Nagarnaik 	 * change read pointer to make sure any read iterators reset
151883f40318SVaibhav Nagarnaik 	 * themselves
151983f40318SVaibhav Nagarnaik 	 */
152083f40318SVaibhav Nagarnaik 	cpu_buffer->read = 0;
152183f40318SVaibhav Nagarnaik 
152283f40318SVaibhav Nagarnaik 	/* pages are removed, resume tracing and then free the pages */
152383f40318SVaibhav Nagarnaik 	atomic_dec(&cpu_buffer->record_disabled);
15245389f6faSThomas Gleixner 	raw_spin_unlock_irq(&cpu_buffer->reader_lock);
152583f40318SVaibhav Nagarnaik 
152683f40318SVaibhav Nagarnaik 	RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages));
152783f40318SVaibhav Nagarnaik 
152883f40318SVaibhav Nagarnaik 	/* last buffer page to remove */
152983f40318SVaibhav Nagarnaik 	last_page = list_entry(rb_list_head(to_remove), struct buffer_page,
153083f40318SVaibhav Nagarnaik 				list);
153183f40318SVaibhav Nagarnaik 	tmp_iter_page = first_page;
153283f40318SVaibhav Nagarnaik 
153383f40318SVaibhav Nagarnaik 	do {
153483f40318SVaibhav Nagarnaik 		to_remove_page = tmp_iter_page;
153583f40318SVaibhav Nagarnaik 		rb_inc_page(cpu_buffer, &tmp_iter_page);
153683f40318SVaibhav Nagarnaik 
153783f40318SVaibhav Nagarnaik 		/* update the counters */
153883f40318SVaibhav Nagarnaik 		page_entries = rb_page_entries(to_remove_page);
153983f40318SVaibhav Nagarnaik 		if (page_entries) {
154083f40318SVaibhav Nagarnaik 			/*
154183f40318SVaibhav Nagarnaik 			 * If something was added to this page, it was full
154283f40318SVaibhav Nagarnaik 			 * since it is not the tail page. So we deduct the
154383f40318SVaibhav Nagarnaik 			 * bytes consumed in ring buffer from here.
154448fdc72fSVaibhav Nagarnaik 			 * Increment overrun to account for the lost events.
154583f40318SVaibhav Nagarnaik 			 */
154648fdc72fSVaibhav Nagarnaik 			local_add(page_entries, &cpu_buffer->overrun);
154783f40318SVaibhav Nagarnaik 			local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
154883f40318SVaibhav Nagarnaik 		}
154983f40318SVaibhav Nagarnaik 
155083f40318SVaibhav Nagarnaik 		/*
155183f40318SVaibhav Nagarnaik 		 * We have already removed references to this list item, just
155283f40318SVaibhav Nagarnaik 		 * free up the buffer_page and its page
155383f40318SVaibhav Nagarnaik 		 */
155483f40318SVaibhav Nagarnaik 		free_buffer_page(to_remove_page);
155583f40318SVaibhav Nagarnaik 		nr_removed--;
155683f40318SVaibhav Nagarnaik 
155783f40318SVaibhav Nagarnaik 	} while (to_remove_page != last_page);
155883f40318SVaibhav Nagarnaik 
155983f40318SVaibhav Nagarnaik 	RB_WARN_ON(cpu_buffer, nr_removed);
15605040b4b7SVaibhav Nagarnaik 
15615040b4b7SVaibhav Nagarnaik 	return nr_removed == 0;
15627a8e76a3SSteven Rostedt }
15637a8e76a3SSteven Rostedt 
15645040b4b7SVaibhav Nagarnaik static int
15655040b4b7SVaibhav Nagarnaik rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer)
15667a8e76a3SSteven Rostedt {
15675040b4b7SVaibhav Nagarnaik 	struct list_head *pages = &cpu_buffer->new_pages;
15685040b4b7SVaibhav Nagarnaik 	int retries, success;
15697a8e76a3SSteven Rostedt 
15705389f6faSThomas Gleixner 	raw_spin_lock_irq(&cpu_buffer->reader_lock);
15715040b4b7SVaibhav Nagarnaik 	/*
15725040b4b7SVaibhav Nagarnaik 	 * We are holding the reader lock, so the reader page won't be swapped
15735040b4b7SVaibhav Nagarnaik 	 * in the ring buffer. Now we are racing with the writer trying to
15745040b4b7SVaibhav Nagarnaik 	 * move head page and the tail page.
15755040b4b7SVaibhav Nagarnaik 	 * We are going to adapt the reader page update process where:
15765040b4b7SVaibhav Nagarnaik 	 * 1. We first splice the start and end of list of new pages between
15775040b4b7SVaibhav Nagarnaik 	 *    the head page and its previous page.
15785040b4b7SVaibhav Nagarnaik 	 * 2. We cmpxchg the prev_page->next to point from head page to the
15795040b4b7SVaibhav Nagarnaik 	 *    start of new pages list.
15805040b4b7SVaibhav Nagarnaik 	 * 3. Finally, we update the head->prev to the end of new list.
15815040b4b7SVaibhav Nagarnaik 	 *
15825040b4b7SVaibhav Nagarnaik 	 * We will try this process 10 times, to make sure that we don't keep
15835040b4b7SVaibhav Nagarnaik 	 * spinning.
15845040b4b7SVaibhav Nagarnaik 	 */
15855040b4b7SVaibhav Nagarnaik 	retries = 10;
15865040b4b7SVaibhav Nagarnaik 	success = 0;
15875040b4b7SVaibhav Nagarnaik 	while (retries--) {
15885040b4b7SVaibhav Nagarnaik 		struct list_head *head_page, *prev_page, *r;
15895040b4b7SVaibhav Nagarnaik 		struct list_head *last_page, *first_page;
15905040b4b7SVaibhav Nagarnaik 		struct list_head *head_page_with_bit;
159177ae365eSSteven Rostedt 
15925040b4b7SVaibhav Nagarnaik 		head_page = &rb_set_head_page(cpu_buffer)->list;
159354f7be5bSSteven Rostedt 		if (!head_page)
159454f7be5bSSteven Rostedt 			break;
15955040b4b7SVaibhav Nagarnaik 		prev_page = head_page->prev;
15965040b4b7SVaibhav Nagarnaik 
15975040b4b7SVaibhav Nagarnaik 		first_page = pages->next;
15985040b4b7SVaibhav Nagarnaik 		last_page  = pages->prev;
15995040b4b7SVaibhav Nagarnaik 
16005040b4b7SVaibhav Nagarnaik 		head_page_with_bit = (struct list_head *)
16015040b4b7SVaibhav Nagarnaik 				     ((unsigned long)head_page | RB_PAGE_HEAD);
16025040b4b7SVaibhav Nagarnaik 
16035040b4b7SVaibhav Nagarnaik 		last_page->next = head_page_with_bit;
16045040b4b7SVaibhav Nagarnaik 		first_page->prev = prev_page;
16055040b4b7SVaibhav Nagarnaik 
16065040b4b7SVaibhav Nagarnaik 		r = cmpxchg(&prev_page->next, head_page_with_bit, first_page);
16075040b4b7SVaibhav Nagarnaik 
16085040b4b7SVaibhav Nagarnaik 		if (r == head_page_with_bit) {
16095040b4b7SVaibhav Nagarnaik 			/*
16105040b4b7SVaibhav Nagarnaik 			 * yay, we replaced the page pointer to our new list,
16115040b4b7SVaibhav Nagarnaik 			 * now, we just have to update to head page's prev
16125040b4b7SVaibhav Nagarnaik 			 * pointer to point to end of list
16135040b4b7SVaibhav Nagarnaik 			 */
16145040b4b7SVaibhav Nagarnaik 			head_page->prev = last_page;
16155040b4b7SVaibhav Nagarnaik 			success = 1;
16165040b4b7SVaibhav Nagarnaik 			break;
16177a8e76a3SSteven Rostedt 		}
16185040b4b7SVaibhav Nagarnaik 	}
16197a8e76a3SSteven Rostedt 
16205040b4b7SVaibhav Nagarnaik 	if (success)
16215040b4b7SVaibhav Nagarnaik 		INIT_LIST_HEAD(pages);
16225040b4b7SVaibhav Nagarnaik 	/*
16235040b4b7SVaibhav Nagarnaik 	 * If we weren't successful in adding in new pages, warn and stop
16245040b4b7SVaibhav Nagarnaik 	 * tracing
16255040b4b7SVaibhav Nagarnaik 	 */
16265040b4b7SVaibhav Nagarnaik 	RB_WARN_ON(cpu_buffer, !success);
16275389f6faSThomas Gleixner 	raw_spin_unlock_irq(&cpu_buffer->reader_lock);
16285040b4b7SVaibhav Nagarnaik 
16295040b4b7SVaibhav Nagarnaik 	/* free pages if they weren't inserted */
16305040b4b7SVaibhav Nagarnaik 	if (!success) {
16315040b4b7SVaibhav Nagarnaik 		struct buffer_page *bpage, *tmp;
16325040b4b7SVaibhav Nagarnaik 		list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
16335040b4b7SVaibhav Nagarnaik 					 list) {
16345040b4b7SVaibhav Nagarnaik 			list_del_init(&bpage->list);
16355040b4b7SVaibhav Nagarnaik 			free_buffer_page(bpage);
16365040b4b7SVaibhav Nagarnaik 		}
16375040b4b7SVaibhav Nagarnaik 	}
16385040b4b7SVaibhav Nagarnaik 	return success;
16397a8e76a3SSteven Rostedt }
16407a8e76a3SSteven Rostedt 
164183f40318SVaibhav Nagarnaik static void rb_update_pages(struct ring_buffer_per_cpu *cpu_buffer)
1642438ced17SVaibhav Nagarnaik {
16435040b4b7SVaibhav Nagarnaik 	int success;
164483f40318SVaibhav Nagarnaik 
16455040b4b7SVaibhav Nagarnaik 	if (cpu_buffer->nr_pages_to_update > 0)
16465040b4b7SVaibhav Nagarnaik 		success = rb_insert_pages(cpu_buffer);
16475040b4b7SVaibhav Nagarnaik 	else
16485040b4b7SVaibhav Nagarnaik 		success = rb_remove_pages(cpu_buffer,
16495040b4b7SVaibhav Nagarnaik 					-cpu_buffer->nr_pages_to_update);
16505040b4b7SVaibhav Nagarnaik 
16515040b4b7SVaibhav Nagarnaik 	if (success)
1652438ced17SVaibhav Nagarnaik 		cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
165383f40318SVaibhav Nagarnaik }
165483f40318SVaibhav Nagarnaik 
165583f40318SVaibhav Nagarnaik static void update_pages_handler(struct work_struct *work)
165683f40318SVaibhav Nagarnaik {
165783f40318SVaibhav Nagarnaik 	struct ring_buffer_per_cpu *cpu_buffer = container_of(work,
165883f40318SVaibhav Nagarnaik 			struct ring_buffer_per_cpu, update_pages_work);
165983f40318SVaibhav Nagarnaik 	rb_update_pages(cpu_buffer);
166005fdd70dSVaibhav Nagarnaik 	complete(&cpu_buffer->update_done);
1661438ced17SVaibhav Nagarnaik }
1662438ced17SVaibhav Nagarnaik 
16637a8e76a3SSteven Rostedt /**
16647a8e76a3SSteven Rostedt  * ring_buffer_resize - resize the ring buffer
16657a8e76a3SSteven Rostedt  * @buffer: the buffer to resize.
16667a8e76a3SSteven Rostedt  * @size: the new size.
1667d611851bSzhangwei(Jovi)  * @cpu_id: the cpu buffer to resize
16687a8e76a3SSteven Rostedt  *
16697a8e76a3SSteven Rostedt  * Minimum size is 2 * BUF_PAGE_SIZE.
16707a8e76a3SSteven Rostedt  *
167183f40318SVaibhav Nagarnaik  * Returns 0 on success and < 0 on failure.
16727a8e76a3SSteven Rostedt  */
1673438ced17SVaibhav Nagarnaik int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size,
1674438ced17SVaibhav Nagarnaik 			int cpu_id)
16757a8e76a3SSteven Rostedt {
16767a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
1677438ced17SVaibhav Nagarnaik 	unsigned nr_pages;
167883f40318SVaibhav Nagarnaik 	int cpu, err = 0;
16797a8e76a3SSteven Rostedt 
1680ee51a1deSIngo Molnar 	/*
1681ee51a1deSIngo Molnar 	 * Always succeed at resizing a non-existent buffer:
1682ee51a1deSIngo Molnar 	 */
1683ee51a1deSIngo Molnar 	if (!buffer)
1684ee51a1deSIngo Molnar 		return size;
1685ee51a1deSIngo Molnar 
16866a31e1f1SSteven Rostedt 	/* Make sure the requested buffer exists */
16876a31e1f1SSteven Rostedt 	if (cpu_id != RING_BUFFER_ALL_CPUS &&
16886a31e1f1SSteven Rostedt 	    !cpumask_test_cpu(cpu_id, buffer->cpumask))
16896a31e1f1SSteven Rostedt 		return size;
16906a31e1f1SSteven Rostedt 
16917a8e76a3SSteven Rostedt 	size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
16927a8e76a3SSteven Rostedt 	size *= BUF_PAGE_SIZE;
16937a8e76a3SSteven Rostedt 
16947a8e76a3SSteven Rostedt 	/* we need a minimum of two pages */
16957a8e76a3SSteven Rostedt 	if (size < BUF_PAGE_SIZE * 2)
16967a8e76a3SSteven Rostedt 		size = BUF_PAGE_SIZE * 2;
16977a8e76a3SSteven Rostedt 
16987a8e76a3SSteven Rostedt 	nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
16997a8e76a3SSteven Rostedt 
170083f40318SVaibhav Nagarnaik 	/*
170183f40318SVaibhav Nagarnaik 	 * Don't succeed if resizing is disabled, as a reader might be
170283f40318SVaibhav Nagarnaik 	 * manipulating the ring buffer and is expecting a sane state while
170383f40318SVaibhav Nagarnaik 	 * this is true.
170483f40318SVaibhav Nagarnaik 	 */
170583f40318SVaibhav Nagarnaik 	if (atomic_read(&buffer->resize_disabled))
170683f40318SVaibhav Nagarnaik 		return -EBUSY;
170783f40318SVaibhav Nagarnaik 
170883f40318SVaibhav Nagarnaik 	/* prevent another thread from changing buffer sizes */
170983f40318SVaibhav Nagarnaik 	mutex_lock(&buffer->mutex);
171083f40318SVaibhav Nagarnaik 
1711438ced17SVaibhav Nagarnaik 	if (cpu_id == RING_BUFFER_ALL_CPUS) {
1712438ced17SVaibhav Nagarnaik 		/* calculate the pages to update */
17137a8e76a3SSteven Rostedt 		for_each_buffer_cpu(buffer, cpu) {
17147a8e76a3SSteven Rostedt 			cpu_buffer = buffer->buffers[cpu];
1715438ced17SVaibhav Nagarnaik 
1716438ced17SVaibhav Nagarnaik 			cpu_buffer->nr_pages_to_update = nr_pages -
1717438ced17SVaibhav Nagarnaik 							cpu_buffer->nr_pages;
1718438ced17SVaibhav Nagarnaik 			/*
1719438ced17SVaibhav Nagarnaik 			 * nothing more to do for removing pages or no update
1720438ced17SVaibhav Nagarnaik 			 */
1721438ced17SVaibhav Nagarnaik 			if (cpu_buffer->nr_pages_to_update <= 0)
1722438ced17SVaibhav Nagarnaik 				continue;
1723438ced17SVaibhav Nagarnaik 			/*
1724438ced17SVaibhav Nagarnaik 			 * to add pages, make sure all new pages can be
1725438ced17SVaibhav Nagarnaik 			 * allocated without receiving ENOMEM
1726438ced17SVaibhav Nagarnaik 			 */
1727438ced17SVaibhav Nagarnaik 			INIT_LIST_HEAD(&cpu_buffer->new_pages);
1728438ced17SVaibhav Nagarnaik 			if (__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
172983f40318SVaibhav Nagarnaik 						&cpu_buffer->new_pages, cpu)) {
1730438ced17SVaibhav Nagarnaik 				/* not enough memory for new pages */
173183f40318SVaibhav Nagarnaik 				err = -ENOMEM;
173283f40318SVaibhav Nagarnaik 				goto out_err;
173383f40318SVaibhav Nagarnaik 			}
173483f40318SVaibhav Nagarnaik 		}
173583f40318SVaibhav Nagarnaik 
173683f40318SVaibhav Nagarnaik 		get_online_cpus();
173783f40318SVaibhav Nagarnaik 		/*
173883f40318SVaibhav Nagarnaik 		 * Fire off all the required work handlers
173905fdd70dSVaibhav Nagarnaik 		 * We can't schedule on offline CPUs, but it's not necessary
174083f40318SVaibhav Nagarnaik 		 * since we can change their buffer sizes without any race.
174183f40318SVaibhav Nagarnaik 		 */
174283f40318SVaibhav Nagarnaik 		for_each_buffer_cpu(buffer, cpu) {
174383f40318SVaibhav Nagarnaik 			cpu_buffer = buffer->buffers[cpu];
174405fdd70dSVaibhav Nagarnaik 			if (!cpu_buffer->nr_pages_to_update)
174583f40318SVaibhav Nagarnaik 				continue;
174683f40318SVaibhav Nagarnaik 
1747021c5b34SCorey Minyard 			/* Can't run something on an offline CPU. */
1748021c5b34SCorey Minyard 			if (!cpu_online(cpu)) {
1749f5eb5588SSteven Rostedt (Red Hat) 				rb_update_pages(cpu_buffer);
1750f5eb5588SSteven Rostedt (Red Hat) 				cpu_buffer->nr_pages_to_update = 0;
1751f5eb5588SSteven Rostedt (Red Hat) 			} else {
175205fdd70dSVaibhav Nagarnaik 				schedule_work_on(cpu,
175305fdd70dSVaibhav Nagarnaik 						&cpu_buffer->update_pages_work);
1754f5eb5588SSteven Rostedt (Red Hat) 			}
17557a8e76a3SSteven Rostedt 		}
1756438ced17SVaibhav Nagarnaik 
1757438ced17SVaibhav Nagarnaik 		/* wait for all the updates to complete */
1758438ced17SVaibhav Nagarnaik 		for_each_buffer_cpu(buffer, cpu) {
1759438ced17SVaibhav Nagarnaik 			cpu_buffer = buffer->buffers[cpu];
176005fdd70dSVaibhav Nagarnaik 			if (!cpu_buffer->nr_pages_to_update)
176183f40318SVaibhav Nagarnaik 				continue;
176283f40318SVaibhav Nagarnaik 
176305fdd70dSVaibhav Nagarnaik 			if (cpu_online(cpu))
176405fdd70dSVaibhav Nagarnaik 				wait_for_completion(&cpu_buffer->update_done);
176583f40318SVaibhav Nagarnaik 			cpu_buffer->nr_pages_to_update = 0;
1766438ced17SVaibhav Nagarnaik 		}
176783f40318SVaibhav Nagarnaik 
176883f40318SVaibhav Nagarnaik 		put_online_cpus();
1769438ced17SVaibhav Nagarnaik 	} else {
17708e49f418SVaibhav Nagarnaik 		/* Make sure this CPU has been intitialized */
17718e49f418SVaibhav Nagarnaik 		if (!cpumask_test_cpu(cpu_id, buffer->cpumask))
17728e49f418SVaibhav Nagarnaik 			goto out;
17738e49f418SVaibhav Nagarnaik 
1774438ced17SVaibhav Nagarnaik 		cpu_buffer = buffer->buffers[cpu_id];
177583f40318SVaibhav Nagarnaik 
1776438ced17SVaibhav Nagarnaik 		if (nr_pages == cpu_buffer->nr_pages)
17777a8e76a3SSteven Rostedt 			goto out;
1778438ced17SVaibhav Nagarnaik 
1779438ced17SVaibhav Nagarnaik 		cpu_buffer->nr_pages_to_update = nr_pages -
1780438ced17SVaibhav Nagarnaik 						cpu_buffer->nr_pages;
1781438ced17SVaibhav Nagarnaik 
1782438ced17SVaibhav Nagarnaik 		INIT_LIST_HEAD(&cpu_buffer->new_pages);
1783438ced17SVaibhav Nagarnaik 		if (cpu_buffer->nr_pages_to_update > 0 &&
1784438ced17SVaibhav Nagarnaik 			__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
178583f40318SVaibhav Nagarnaik 					    &cpu_buffer->new_pages, cpu_id)) {
178683f40318SVaibhav Nagarnaik 			err = -ENOMEM;
178783f40318SVaibhav Nagarnaik 			goto out_err;
178883f40318SVaibhav Nagarnaik 		}
1789438ced17SVaibhav Nagarnaik 
179083f40318SVaibhav Nagarnaik 		get_online_cpus();
179183f40318SVaibhav Nagarnaik 
1792021c5b34SCorey Minyard 		/* Can't run something on an offline CPU. */
1793021c5b34SCorey Minyard 		if (!cpu_online(cpu_id))
1794f5eb5588SSteven Rostedt (Red Hat) 			rb_update_pages(cpu_buffer);
1795f5eb5588SSteven Rostedt (Red Hat) 		else {
179683f40318SVaibhav Nagarnaik 			schedule_work_on(cpu_id,
179783f40318SVaibhav Nagarnaik 					 &cpu_buffer->update_pages_work);
179805fdd70dSVaibhav Nagarnaik 			wait_for_completion(&cpu_buffer->update_done);
1799f5eb5588SSteven Rostedt (Red Hat) 		}
180083f40318SVaibhav Nagarnaik 
180183f40318SVaibhav Nagarnaik 		cpu_buffer->nr_pages_to_update = 0;
180205fdd70dSVaibhav Nagarnaik 		put_online_cpus();
18037a8e76a3SSteven Rostedt 	}
18047a8e76a3SSteven Rostedt 
18057a8e76a3SSteven Rostedt  out:
1806659f451fSSteven Rostedt 	/*
1807659f451fSSteven Rostedt 	 * The ring buffer resize can happen with the ring buffer
1808659f451fSSteven Rostedt 	 * enabled, so that the update disturbs the tracing as little
1809659f451fSSteven Rostedt 	 * as possible. But if the buffer is disabled, we do not need
1810659f451fSSteven Rostedt 	 * to worry about that, and we can take the time to verify
1811659f451fSSteven Rostedt 	 * that the buffer is not corrupt.
1812659f451fSSteven Rostedt 	 */
1813659f451fSSteven Rostedt 	if (atomic_read(&buffer->record_disabled)) {
1814659f451fSSteven Rostedt 		atomic_inc(&buffer->record_disabled);
1815659f451fSSteven Rostedt 		/*
1816659f451fSSteven Rostedt 		 * Even though the buffer was disabled, we must make sure
1817659f451fSSteven Rostedt 		 * that it is truly disabled before calling rb_check_pages.
1818659f451fSSteven Rostedt 		 * There could have been a race between checking
1819659f451fSSteven Rostedt 		 * record_disable and incrementing it.
1820659f451fSSteven Rostedt 		 */
1821659f451fSSteven Rostedt 		synchronize_sched();
1822659f451fSSteven Rostedt 		for_each_buffer_cpu(buffer, cpu) {
1823659f451fSSteven Rostedt 			cpu_buffer = buffer->buffers[cpu];
1824659f451fSSteven Rostedt 			rb_check_pages(cpu_buffer);
1825659f451fSSteven Rostedt 		}
1826659f451fSSteven Rostedt 		atomic_dec(&buffer->record_disabled);
1827659f451fSSteven Rostedt 	}
1828659f451fSSteven Rostedt 
18297a8e76a3SSteven Rostedt 	mutex_unlock(&buffer->mutex);
18307a8e76a3SSteven Rostedt 	return size;
18317a8e76a3SSteven Rostedt 
183283f40318SVaibhav Nagarnaik  out_err:
1833438ced17SVaibhav Nagarnaik 	for_each_buffer_cpu(buffer, cpu) {
1834438ced17SVaibhav Nagarnaik 		struct buffer_page *bpage, *tmp;
183583f40318SVaibhav Nagarnaik 
1836438ced17SVaibhav Nagarnaik 		cpu_buffer = buffer->buffers[cpu];
1837438ced17SVaibhav Nagarnaik 		cpu_buffer->nr_pages_to_update = 0;
183883f40318SVaibhav Nagarnaik 
1839438ced17SVaibhav Nagarnaik 		if (list_empty(&cpu_buffer->new_pages))
1840438ced17SVaibhav Nagarnaik 			continue;
184183f40318SVaibhav Nagarnaik 
1842438ced17SVaibhav Nagarnaik 		list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
1843438ced17SVaibhav Nagarnaik 					list) {
1844044fa782SSteven Rostedt 			list_del_init(&bpage->list);
1845044fa782SSteven Rostedt 			free_buffer_page(bpage);
18467a8e76a3SSteven Rostedt 		}
1847438ced17SVaibhav Nagarnaik 	}
1848641d2f63SVegard Nossum 	mutex_unlock(&buffer->mutex);
184983f40318SVaibhav Nagarnaik 	return err;
18507a8e76a3SSteven Rostedt }
1851c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_resize);
18527a8e76a3SSteven Rostedt 
1853750912faSDavid Sharp void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
1854750912faSDavid Sharp {
1855750912faSDavid Sharp 	mutex_lock(&buffer->mutex);
1856750912faSDavid Sharp 	if (val)
1857750912faSDavid Sharp 		buffer->flags |= RB_FL_OVERWRITE;
1858750912faSDavid Sharp 	else
1859750912faSDavid Sharp 		buffer->flags &= ~RB_FL_OVERWRITE;
1860750912faSDavid Sharp 	mutex_unlock(&buffer->mutex);
1861750912faSDavid Sharp }
1862750912faSDavid Sharp EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
1863750912faSDavid Sharp 
18648789a9e7SSteven Rostedt static inline void *
1865044fa782SSteven Rostedt __rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
18668789a9e7SSteven Rostedt {
1867044fa782SSteven Rostedt 	return bpage->data + index;
18688789a9e7SSteven Rostedt }
18698789a9e7SSteven Rostedt 
1870044fa782SSteven Rostedt static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
18717a8e76a3SSteven Rostedt {
1872044fa782SSteven Rostedt 	return bpage->page->data + index;
18737a8e76a3SSteven Rostedt }
18747a8e76a3SSteven Rostedt 
18757a8e76a3SSteven Rostedt static inline struct ring_buffer_event *
1876d769041fSSteven Rostedt rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
18777a8e76a3SSteven Rostedt {
18786f807acdSSteven Rostedt 	return __rb_page_index(cpu_buffer->reader_page,
18796f807acdSSteven Rostedt 			       cpu_buffer->reader_page->read);
18806f807acdSSteven Rostedt }
18816f807acdSSteven Rostedt 
18826f807acdSSteven Rostedt static inline struct ring_buffer_event *
18837a8e76a3SSteven Rostedt rb_iter_head_event(struct ring_buffer_iter *iter)
18847a8e76a3SSteven Rostedt {
18856f807acdSSteven Rostedt 	return __rb_page_index(iter->head_page, iter->head);
18867a8e76a3SSteven Rostedt }
18877a8e76a3SSteven Rostedt 
1888bf41a158SSteven Rostedt static inline unsigned rb_page_commit(struct buffer_page *bpage)
1889bf41a158SSteven Rostedt {
1890abc9b56dSSteven Rostedt 	return local_read(&bpage->page->commit);
1891bf41a158SSteven Rostedt }
1892bf41a158SSteven Rostedt 
189325985edcSLucas De Marchi /* Size is determined by what has been committed */
1894bf41a158SSteven Rostedt static inline unsigned rb_page_size(struct buffer_page *bpage)
1895bf41a158SSteven Rostedt {
1896bf41a158SSteven Rostedt 	return rb_page_commit(bpage);
1897bf41a158SSteven Rostedt }
1898bf41a158SSteven Rostedt 
1899bf41a158SSteven Rostedt static inline unsigned
1900bf41a158SSteven Rostedt rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
1901bf41a158SSteven Rostedt {
1902bf41a158SSteven Rostedt 	return rb_page_commit(cpu_buffer->commit_page);
1903bf41a158SSteven Rostedt }
1904bf41a158SSteven Rostedt 
1905bf41a158SSteven Rostedt static inline unsigned
1906bf41a158SSteven Rostedt rb_event_index(struct ring_buffer_event *event)
19077a8e76a3SSteven Rostedt {
1908bf41a158SSteven Rostedt 	unsigned long addr = (unsigned long)event;
1909bf41a158SSteven Rostedt 
191022f470f8SSteven Rostedt 	return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
19117a8e76a3SSteven Rostedt }
19127a8e76a3SSteven Rostedt 
19130f0c85fcSSteven Rostedt static inline int
1914fa743953SSteven Rostedt rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
1915bf41a158SSteven Rostedt 		   struct ring_buffer_event *event)
19167a8e76a3SSteven Rostedt {
1917bf41a158SSteven Rostedt 	unsigned long addr = (unsigned long)event;
1918bf41a158SSteven Rostedt 	unsigned long index;
1919bf41a158SSteven Rostedt 
1920bf41a158SSteven Rostedt 	index = rb_event_index(event);
1921bf41a158SSteven Rostedt 	addr &= PAGE_MASK;
1922bf41a158SSteven Rostedt 
1923bf41a158SSteven Rostedt 	return cpu_buffer->commit_page->page == (void *)addr &&
1924bf41a158SSteven Rostedt 		rb_commit_index(cpu_buffer) == index;
1925bf41a158SSteven Rostedt }
1926bf41a158SSteven Rostedt 
192734a148bfSAndrew Morton static void
1928bf41a158SSteven Rostedt rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
1929bf41a158SSteven Rostedt {
193077ae365eSSteven Rostedt 	unsigned long max_count;
193177ae365eSSteven Rostedt 
1932bf41a158SSteven Rostedt 	/*
1933bf41a158SSteven Rostedt 	 * We only race with interrupts and NMIs on this CPU.
1934bf41a158SSteven Rostedt 	 * If we own the commit event, then we can commit
1935bf41a158SSteven Rostedt 	 * all others that interrupted us, since the interruptions
1936bf41a158SSteven Rostedt 	 * are in stack format (they finish before they come
1937bf41a158SSteven Rostedt 	 * back to us). This allows us to do a simple loop to
1938bf41a158SSteven Rostedt 	 * assign the commit to the tail.
1939bf41a158SSteven Rostedt 	 */
1940a8ccf1d6SSteven Rostedt  again:
1941438ced17SVaibhav Nagarnaik 	max_count = cpu_buffer->nr_pages * 100;
194277ae365eSSteven Rostedt 
1943bf41a158SSteven Rostedt 	while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
194477ae365eSSteven Rostedt 		if (RB_WARN_ON(cpu_buffer, !(--max_count)))
194577ae365eSSteven Rostedt 			return;
194677ae365eSSteven Rostedt 		if (RB_WARN_ON(cpu_buffer,
194777ae365eSSteven Rostedt 			       rb_is_reader_page(cpu_buffer->tail_page)))
194877ae365eSSteven Rostedt 			return;
194977ae365eSSteven Rostedt 		local_set(&cpu_buffer->commit_page->page->commit,
195077ae365eSSteven Rostedt 			  rb_page_write(cpu_buffer->commit_page));
1951bf41a158SSteven Rostedt 		rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
1952abc9b56dSSteven Rostedt 		cpu_buffer->write_stamp =
1953abc9b56dSSteven Rostedt 			cpu_buffer->commit_page->page->time_stamp;
1954bf41a158SSteven Rostedt 		/* add barrier to keep gcc from optimizing too much */
1955bf41a158SSteven Rostedt 		barrier();
1956bf41a158SSteven Rostedt 	}
1957bf41a158SSteven Rostedt 	while (rb_commit_index(cpu_buffer) !=
1958bf41a158SSteven Rostedt 	       rb_page_write(cpu_buffer->commit_page)) {
195977ae365eSSteven Rostedt 
196077ae365eSSteven Rostedt 		local_set(&cpu_buffer->commit_page->page->commit,
196177ae365eSSteven Rostedt 			  rb_page_write(cpu_buffer->commit_page));
196277ae365eSSteven Rostedt 		RB_WARN_ON(cpu_buffer,
196377ae365eSSteven Rostedt 			   local_read(&cpu_buffer->commit_page->page->commit) &
196477ae365eSSteven Rostedt 			   ~RB_WRITE_MASK);
1965bf41a158SSteven Rostedt 		barrier();
1966bf41a158SSteven Rostedt 	}
1967a8ccf1d6SSteven Rostedt 
1968a8ccf1d6SSteven Rostedt 	/* again, keep gcc from optimizing */
1969a8ccf1d6SSteven Rostedt 	barrier();
1970a8ccf1d6SSteven Rostedt 
1971a8ccf1d6SSteven Rostedt 	/*
1972a8ccf1d6SSteven Rostedt 	 * If an interrupt came in just after the first while loop
1973a8ccf1d6SSteven Rostedt 	 * and pushed the tail page forward, we will be left with
1974a8ccf1d6SSteven Rostedt 	 * a dangling commit that will never go forward.
1975a8ccf1d6SSteven Rostedt 	 */
1976a8ccf1d6SSteven Rostedt 	if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
1977a8ccf1d6SSteven Rostedt 		goto again;
19787a8e76a3SSteven Rostedt }
19797a8e76a3SSteven Rostedt 
1980d769041fSSteven Rostedt static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
19817a8e76a3SSteven Rostedt {
1982abc9b56dSSteven Rostedt 	cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
19836f807acdSSteven Rostedt 	cpu_buffer->reader_page->read = 0;
1984d769041fSSteven Rostedt }
1985d769041fSSteven Rostedt 
198634a148bfSAndrew Morton static void rb_inc_iter(struct ring_buffer_iter *iter)
1987d769041fSSteven Rostedt {
1988d769041fSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1989d769041fSSteven Rostedt 
1990d769041fSSteven Rostedt 	/*
1991d769041fSSteven Rostedt 	 * The iterator could be on the reader page (it starts there).
1992d769041fSSteven Rostedt 	 * But the head could have moved, since the reader was
1993d769041fSSteven Rostedt 	 * found. Check for this case and assign the iterator
1994d769041fSSteven Rostedt 	 * to the head page instead of next.
1995d769041fSSteven Rostedt 	 */
1996d769041fSSteven Rostedt 	if (iter->head_page == cpu_buffer->reader_page)
199777ae365eSSteven Rostedt 		iter->head_page = rb_set_head_page(cpu_buffer);
1998d769041fSSteven Rostedt 	else
1999d769041fSSteven Rostedt 		rb_inc_page(cpu_buffer, &iter->head_page);
2000d769041fSSteven Rostedt 
2001abc9b56dSSteven Rostedt 	iter->read_stamp = iter->head_page->page->time_stamp;
20027a8e76a3SSteven Rostedt 	iter->head = 0;
20037a8e76a3SSteven Rostedt }
20047a8e76a3SSteven Rostedt 
200569d1b839SSteven Rostedt /* Slow path, do not inline */
200669d1b839SSteven Rostedt static noinline struct ring_buffer_event *
200769d1b839SSteven Rostedt rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
200869d1b839SSteven Rostedt {
200969d1b839SSteven Rostedt 	event->type_len = RINGBUF_TYPE_TIME_EXTEND;
201069d1b839SSteven Rostedt 
201169d1b839SSteven Rostedt 	/* Not the first event on the page? */
201269d1b839SSteven Rostedt 	if (rb_event_index(event)) {
201369d1b839SSteven Rostedt 		event->time_delta = delta & TS_MASK;
201469d1b839SSteven Rostedt 		event->array[0] = delta >> TS_SHIFT;
201569d1b839SSteven Rostedt 	} else {
201669d1b839SSteven Rostedt 		/* nope, just zero it */
201769d1b839SSteven Rostedt 		event->time_delta = 0;
201869d1b839SSteven Rostedt 		event->array[0] = 0;
201969d1b839SSteven Rostedt 	}
202069d1b839SSteven Rostedt 
202169d1b839SSteven Rostedt 	return skip_time_extend(event);
202269d1b839SSteven Rostedt }
202369d1b839SSteven Rostedt 
20247a8e76a3SSteven Rostedt /**
202501e3e710SDavid Sharp  * rb_update_event - update event type and data
2026021de3d9SSteven Rostedt (Red Hat)  * @event: the event to update
20277a8e76a3SSteven Rostedt  * @type: the type of event
20287a8e76a3SSteven Rostedt  * @length: the size of the event field in the ring buffer
20297a8e76a3SSteven Rostedt  *
20307a8e76a3SSteven Rostedt  * Update the type and data fields of the event. The length
20317a8e76a3SSteven Rostedt  * is the actual size that is written to the ring buffer,
20327a8e76a3SSteven Rostedt  * and with this, we can determine what to place into the
20337a8e76a3SSteven Rostedt  * data field.
20347a8e76a3SSteven Rostedt  */
203534a148bfSAndrew Morton static void
203669d1b839SSteven Rostedt rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
203769d1b839SSteven Rostedt 		struct ring_buffer_event *event, unsigned length,
203869d1b839SSteven Rostedt 		int add_timestamp, u64 delta)
20397a8e76a3SSteven Rostedt {
204069d1b839SSteven Rostedt 	/* Only a commit updates the timestamp */
204169d1b839SSteven Rostedt 	if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
204269d1b839SSteven Rostedt 		delta = 0;
20437a8e76a3SSteven Rostedt 
204469d1b839SSteven Rostedt 	/*
204569d1b839SSteven Rostedt 	 * If we need to add a timestamp, then we
204669d1b839SSteven Rostedt 	 * add it to the start of the resevered space.
204769d1b839SSteven Rostedt 	 */
204869d1b839SSteven Rostedt 	if (unlikely(add_timestamp)) {
204969d1b839SSteven Rostedt 		event = rb_add_time_stamp(event, delta);
205069d1b839SSteven Rostedt 		length -= RB_LEN_TIME_EXTEND;
205169d1b839SSteven Rostedt 		delta = 0;
20527a8e76a3SSteven Rostedt 	}
205369d1b839SSteven Rostedt 
205469d1b839SSteven Rostedt 	event->time_delta = delta;
205569d1b839SSteven Rostedt 	length -= RB_EVNT_HDR_SIZE;
205669d1b839SSteven Rostedt 	if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
205769d1b839SSteven Rostedt 		event->type_len = 0;
205869d1b839SSteven Rostedt 		event->array[0] = length;
205969d1b839SSteven Rostedt 	} else
206069d1b839SSteven Rostedt 		event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
20617a8e76a3SSteven Rostedt }
20627a8e76a3SSteven Rostedt 
206377ae365eSSteven Rostedt /*
206477ae365eSSteven Rostedt  * rb_handle_head_page - writer hit the head page
206577ae365eSSteven Rostedt  *
206677ae365eSSteven Rostedt  * Returns: +1 to retry page
206777ae365eSSteven Rostedt  *           0 to continue
206877ae365eSSteven Rostedt  *          -1 on error
206977ae365eSSteven Rostedt  */
207077ae365eSSteven Rostedt static int
207177ae365eSSteven Rostedt rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
207277ae365eSSteven Rostedt 		    struct buffer_page *tail_page,
207377ae365eSSteven Rostedt 		    struct buffer_page *next_page)
207477ae365eSSteven Rostedt {
207577ae365eSSteven Rostedt 	struct buffer_page *new_head;
207677ae365eSSteven Rostedt 	int entries;
207777ae365eSSteven Rostedt 	int type;
207877ae365eSSteven Rostedt 	int ret;
207977ae365eSSteven Rostedt 
208077ae365eSSteven Rostedt 	entries = rb_page_entries(next_page);
208177ae365eSSteven Rostedt 
208277ae365eSSteven Rostedt 	/*
208377ae365eSSteven Rostedt 	 * The hard part is here. We need to move the head
208477ae365eSSteven Rostedt 	 * forward, and protect against both readers on
208577ae365eSSteven Rostedt 	 * other CPUs and writers coming in via interrupts.
208677ae365eSSteven Rostedt 	 */
208777ae365eSSteven Rostedt 	type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
208877ae365eSSteven Rostedt 				       RB_PAGE_HEAD);
208977ae365eSSteven Rostedt 
209077ae365eSSteven Rostedt 	/*
209177ae365eSSteven Rostedt 	 * type can be one of four:
209277ae365eSSteven Rostedt 	 *  NORMAL - an interrupt already moved it for us
209377ae365eSSteven Rostedt 	 *  HEAD   - we are the first to get here.
209477ae365eSSteven Rostedt 	 *  UPDATE - we are the interrupt interrupting
209577ae365eSSteven Rostedt 	 *           a current move.
209677ae365eSSteven Rostedt 	 *  MOVED  - a reader on another CPU moved the next
209777ae365eSSteven Rostedt 	 *           pointer to its reader page. Give up
209877ae365eSSteven Rostedt 	 *           and try again.
209977ae365eSSteven Rostedt 	 */
210077ae365eSSteven Rostedt 
210177ae365eSSteven Rostedt 	switch (type) {
210277ae365eSSteven Rostedt 	case RB_PAGE_HEAD:
210377ae365eSSteven Rostedt 		/*
210477ae365eSSteven Rostedt 		 * We changed the head to UPDATE, thus
210577ae365eSSteven Rostedt 		 * it is our responsibility to update
210677ae365eSSteven Rostedt 		 * the counters.
210777ae365eSSteven Rostedt 		 */
210877ae365eSSteven Rostedt 		local_add(entries, &cpu_buffer->overrun);
2109c64e148aSVaibhav Nagarnaik 		local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
211077ae365eSSteven Rostedt 
211177ae365eSSteven Rostedt 		/*
211277ae365eSSteven Rostedt 		 * The entries will be zeroed out when we move the
211377ae365eSSteven Rostedt 		 * tail page.
211477ae365eSSteven Rostedt 		 */
211577ae365eSSteven Rostedt 
211677ae365eSSteven Rostedt 		/* still more to do */
211777ae365eSSteven Rostedt 		break;
211877ae365eSSteven Rostedt 
211977ae365eSSteven Rostedt 	case RB_PAGE_UPDATE:
212077ae365eSSteven Rostedt 		/*
212177ae365eSSteven Rostedt 		 * This is an interrupt that interrupt the
212277ae365eSSteven Rostedt 		 * previous update. Still more to do.
212377ae365eSSteven Rostedt 		 */
212477ae365eSSteven Rostedt 		break;
212577ae365eSSteven Rostedt 	case RB_PAGE_NORMAL:
212677ae365eSSteven Rostedt 		/*
212777ae365eSSteven Rostedt 		 * An interrupt came in before the update
212877ae365eSSteven Rostedt 		 * and processed this for us.
212977ae365eSSteven Rostedt 		 * Nothing left to do.
213077ae365eSSteven Rostedt 		 */
213177ae365eSSteven Rostedt 		return 1;
213277ae365eSSteven Rostedt 	case RB_PAGE_MOVED:
213377ae365eSSteven Rostedt 		/*
213477ae365eSSteven Rostedt 		 * The reader is on another CPU and just did
213577ae365eSSteven Rostedt 		 * a swap with our next_page.
213677ae365eSSteven Rostedt 		 * Try again.
213777ae365eSSteven Rostedt 		 */
213877ae365eSSteven Rostedt 		return 1;
213977ae365eSSteven Rostedt 	default:
214077ae365eSSteven Rostedt 		RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
214177ae365eSSteven Rostedt 		return -1;
214277ae365eSSteven Rostedt 	}
214377ae365eSSteven Rostedt 
214477ae365eSSteven Rostedt 	/*
214577ae365eSSteven Rostedt 	 * Now that we are here, the old head pointer is
214677ae365eSSteven Rostedt 	 * set to UPDATE. This will keep the reader from
214777ae365eSSteven Rostedt 	 * swapping the head page with the reader page.
214877ae365eSSteven Rostedt 	 * The reader (on another CPU) will spin till
214977ae365eSSteven Rostedt 	 * we are finished.
215077ae365eSSteven Rostedt 	 *
215177ae365eSSteven Rostedt 	 * We just need to protect against interrupts
215277ae365eSSteven Rostedt 	 * doing the job. We will set the next pointer
215377ae365eSSteven Rostedt 	 * to HEAD. After that, we set the old pointer
215477ae365eSSteven Rostedt 	 * to NORMAL, but only if it was HEAD before.
215577ae365eSSteven Rostedt 	 * otherwise we are an interrupt, and only
215677ae365eSSteven Rostedt 	 * want the outer most commit to reset it.
215777ae365eSSteven Rostedt 	 */
215877ae365eSSteven Rostedt 	new_head = next_page;
215977ae365eSSteven Rostedt 	rb_inc_page(cpu_buffer, &new_head);
216077ae365eSSteven Rostedt 
216177ae365eSSteven Rostedt 	ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
216277ae365eSSteven Rostedt 				    RB_PAGE_NORMAL);
216377ae365eSSteven Rostedt 
216477ae365eSSteven Rostedt 	/*
216577ae365eSSteven Rostedt 	 * Valid returns are:
216677ae365eSSteven Rostedt 	 *  HEAD   - an interrupt came in and already set it.
216777ae365eSSteven Rostedt 	 *  NORMAL - One of two things:
216877ae365eSSteven Rostedt 	 *            1) We really set it.
216977ae365eSSteven Rostedt 	 *            2) A bunch of interrupts came in and moved
217077ae365eSSteven Rostedt 	 *               the page forward again.
217177ae365eSSteven Rostedt 	 */
217277ae365eSSteven Rostedt 	switch (ret) {
217377ae365eSSteven Rostedt 	case RB_PAGE_HEAD:
217477ae365eSSteven Rostedt 	case RB_PAGE_NORMAL:
217577ae365eSSteven Rostedt 		/* OK */
217677ae365eSSteven Rostedt 		break;
217777ae365eSSteven Rostedt 	default:
217877ae365eSSteven Rostedt 		RB_WARN_ON(cpu_buffer, 1);
217977ae365eSSteven Rostedt 		return -1;
218077ae365eSSteven Rostedt 	}
218177ae365eSSteven Rostedt 
218277ae365eSSteven Rostedt 	/*
218377ae365eSSteven Rostedt 	 * It is possible that an interrupt came in,
218477ae365eSSteven Rostedt 	 * set the head up, then more interrupts came in
218577ae365eSSteven Rostedt 	 * and moved it again. When we get back here,
218677ae365eSSteven Rostedt 	 * the page would have been set to NORMAL but we
218777ae365eSSteven Rostedt 	 * just set it back to HEAD.
218877ae365eSSteven Rostedt 	 *
218977ae365eSSteven Rostedt 	 * How do you detect this? Well, if that happened
219077ae365eSSteven Rostedt 	 * the tail page would have moved.
219177ae365eSSteven Rostedt 	 */
219277ae365eSSteven Rostedt 	if (ret == RB_PAGE_NORMAL) {
219377ae365eSSteven Rostedt 		/*
219477ae365eSSteven Rostedt 		 * If the tail had moved passed next, then we need
219577ae365eSSteven Rostedt 		 * to reset the pointer.
219677ae365eSSteven Rostedt 		 */
219777ae365eSSteven Rostedt 		if (cpu_buffer->tail_page != tail_page &&
219877ae365eSSteven Rostedt 		    cpu_buffer->tail_page != next_page)
219977ae365eSSteven Rostedt 			rb_head_page_set_normal(cpu_buffer, new_head,
220077ae365eSSteven Rostedt 						next_page,
220177ae365eSSteven Rostedt 						RB_PAGE_HEAD);
220277ae365eSSteven Rostedt 	}
220377ae365eSSteven Rostedt 
220477ae365eSSteven Rostedt 	/*
220577ae365eSSteven Rostedt 	 * If this was the outer most commit (the one that
220677ae365eSSteven Rostedt 	 * changed the original pointer from HEAD to UPDATE),
220777ae365eSSteven Rostedt 	 * then it is up to us to reset it to NORMAL.
220877ae365eSSteven Rostedt 	 */
220977ae365eSSteven Rostedt 	if (type == RB_PAGE_HEAD) {
221077ae365eSSteven Rostedt 		ret = rb_head_page_set_normal(cpu_buffer, next_page,
221177ae365eSSteven Rostedt 					      tail_page,
221277ae365eSSteven Rostedt 					      RB_PAGE_UPDATE);
221377ae365eSSteven Rostedt 		if (RB_WARN_ON(cpu_buffer,
221477ae365eSSteven Rostedt 			       ret != RB_PAGE_UPDATE))
221577ae365eSSteven Rostedt 			return -1;
221677ae365eSSteven Rostedt 	}
221777ae365eSSteven Rostedt 
221877ae365eSSteven Rostedt 	return 0;
221977ae365eSSteven Rostedt }
222077ae365eSSteven Rostedt 
222134a148bfSAndrew Morton static unsigned rb_calculate_event_length(unsigned length)
22227a8e76a3SSteven Rostedt {
22237a8e76a3SSteven Rostedt 	struct ring_buffer_event event; /* Used only for sizeof array */
22247a8e76a3SSteven Rostedt 
22257a8e76a3SSteven Rostedt 	/* zero length can cause confusions */
22267a8e76a3SSteven Rostedt 	if (!length)
22277a8e76a3SSteven Rostedt 		length = 1;
22287a8e76a3SSteven Rostedt 
22292271048dSSteven Rostedt 	if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
22307a8e76a3SSteven Rostedt 		length += sizeof(event.array[0]);
22317a8e76a3SSteven Rostedt 
22327a8e76a3SSteven Rostedt 	length += RB_EVNT_HDR_SIZE;
22332271048dSSteven Rostedt 	length = ALIGN(length, RB_ARCH_ALIGNMENT);
22347a8e76a3SSteven Rostedt 
22357a8e76a3SSteven Rostedt 	return length;
22367a8e76a3SSteven Rostedt }
22377a8e76a3SSteven Rostedt 
2238c7b09308SSteven Rostedt static inline void
2239c7b09308SSteven Rostedt rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
2240c7b09308SSteven Rostedt 	      struct buffer_page *tail_page,
2241c7b09308SSteven Rostedt 	      unsigned long tail, unsigned long length)
2242c7b09308SSteven Rostedt {
2243c7b09308SSteven Rostedt 	struct ring_buffer_event *event;
2244c7b09308SSteven Rostedt 
2245c7b09308SSteven Rostedt 	/*
2246c7b09308SSteven Rostedt 	 * Only the event that crossed the page boundary
2247c7b09308SSteven Rostedt 	 * must fill the old tail_page with padding.
2248c7b09308SSteven Rostedt 	 */
2249c7b09308SSteven Rostedt 	if (tail >= BUF_PAGE_SIZE) {
2250b3230c8bSSteven Rostedt 		/*
2251b3230c8bSSteven Rostedt 		 * If the page was filled, then we still need
2252b3230c8bSSteven Rostedt 		 * to update the real_end. Reset it to zero
2253b3230c8bSSteven Rostedt 		 * and the reader will ignore it.
2254b3230c8bSSteven Rostedt 		 */
2255b3230c8bSSteven Rostedt 		if (tail == BUF_PAGE_SIZE)
2256b3230c8bSSteven Rostedt 			tail_page->real_end = 0;
2257b3230c8bSSteven Rostedt 
2258c7b09308SSteven Rostedt 		local_sub(length, &tail_page->write);
2259c7b09308SSteven Rostedt 		return;
2260c7b09308SSteven Rostedt 	}
2261c7b09308SSteven Rostedt 
2262c7b09308SSteven Rostedt 	event = __rb_page_index(tail_page, tail);
2263b0b7065bSLinus Torvalds 	kmemcheck_annotate_bitfield(event, bitfield);
2264c7b09308SSteven Rostedt 
2265c64e148aSVaibhav Nagarnaik 	/* account for padding bytes */
2266c64e148aSVaibhav Nagarnaik 	local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
2267c64e148aSVaibhav Nagarnaik 
2268c7b09308SSteven Rostedt 	/*
2269ff0ff84aSSteven Rostedt 	 * Save the original length to the meta data.
2270ff0ff84aSSteven Rostedt 	 * This will be used by the reader to add lost event
2271ff0ff84aSSteven Rostedt 	 * counter.
2272ff0ff84aSSteven Rostedt 	 */
2273ff0ff84aSSteven Rostedt 	tail_page->real_end = tail;
2274ff0ff84aSSteven Rostedt 
2275ff0ff84aSSteven Rostedt 	/*
2276c7b09308SSteven Rostedt 	 * If this event is bigger than the minimum size, then
2277c7b09308SSteven Rostedt 	 * we need to be careful that we don't subtract the
2278c7b09308SSteven Rostedt 	 * write counter enough to allow another writer to slip
2279c7b09308SSteven Rostedt 	 * in on this page.
2280c7b09308SSteven Rostedt 	 * We put in a discarded commit instead, to make sure
2281c7b09308SSteven Rostedt 	 * that this space is not used again.
2282c7b09308SSteven Rostedt 	 *
2283c7b09308SSteven Rostedt 	 * If we are less than the minimum size, we don't need to
2284c7b09308SSteven Rostedt 	 * worry about it.
2285c7b09308SSteven Rostedt 	 */
2286c7b09308SSteven Rostedt 	if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
2287c7b09308SSteven Rostedt 		/* No room for any events */
2288c7b09308SSteven Rostedt 
2289c7b09308SSteven Rostedt 		/* Mark the rest of the page with padding */
2290c7b09308SSteven Rostedt 		rb_event_set_padding(event);
2291c7b09308SSteven Rostedt 
2292c7b09308SSteven Rostedt 		/* Set the write back to the previous setting */
2293c7b09308SSteven Rostedt 		local_sub(length, &tail_page->write);
2294c7b09308SSteven Rostedt 		return;
2295c7b09308SSteven Rostedt 	}
2296c7b09308SSteven Rostedt 
2297c7b09308SSteven Rostedt 	/* Put in a discarded event */
2298c7b09308SSteven Rostedt 	event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
2299c7b09308SSteven Rostedt 	event->type_len = RINGBUF_TYPE_PADDING;
2300c7b09308SSteven Rostedt 	/* time delta must be non zero */
2301c7b09308SSteven Rostedt 	event->time_delta = 1;
2302c7b09308SSteven Rostedt 
2303c7b09308SSteven Rostedt 	/* Set write to end of buffer */
2304c7b09308SSteven Rostedt 	length = (tail + length) - BUF_PAGE_SIZE;
2305c7b09308SSteven Rostedt 	local_sub(length, &tail_page->write);
2306c7b09308SSteven Rostedt }
23076634ff26SSteven Rostedt 
2308747e94aeSSteven Rostedt /*
2309747e94aeSSteven Rostedt  * This is the slow path, force gcc not to inline it.
2310747e94aeSSteven Rostedt  */
2311747e94aeSSteven Rostedt static noinline struct ring_buffer_event *
23126634ff26SSteven Rostedt rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
23136634ff26SSteven Rostedt 	     unsigned long length, unsigned long tail,
2314e8bc43e8SSteven Rostedt 	     struct buffer_page *tail_page, u64 ts)
23157a8e76a3SSteven Rostedt {
23165a50e33cSSteven Rostedt 	struct buffer_page *commit_page = cpu_buffer->commit_page;
23177a8e76a3SSteven Rostedt 	struct ring_buffer *buffer = cpu_buffer->buffer;
231877ae365eSSteven Rostedt 	struct buffer_page *next_page;
231977ae365eSSteven Rostedt 	int ret;
2320aa20ae84SSteven Rostedt 
2321aa20ae84SSteven Rostedt 	next_page = tail_page;
23227a8e76a3SSteven Rostedt 
23237a8e76a3SSteven Rostedt 	rb_inc_page(cpu_buffer, &next_page);
23247a8e76a3SSteven Rostedt 
2325bf41a158SSteven Rostedt 	/*
2326bf41a158SSteven Rostedt 	 * If for some reason, we had an interrupt storm that made
2327bf41a158SSteven Rostedt 	 * it all the way around the buffer, bail, and warn
2328bf41a158SSteven Rostedt 	 * about it.
2329bf41a158SSteven Rostedt 	 */
233098db8df7SSteven Rostedt 	if (unlikely(next_page == commit_page)) {
233177ae365eSSteven Rostedt 		local_inc(&cpu_buffer->commit_overrun);
233245141d46SSteven Rostedt 		goto out_reset;
2333bf41a158SSteven Rostedt 	}
2334d769041fSSteven Rostedt 
2335bf41a158SSteven Rostedt 	/*
233677ae365eSSteven Rostedt 	 * This is where the fun begins!
233777ae365eSSteven Rostedt 	 *
233877ae365eSSteven Rostedt 	 * We are fighting against races between a reader that
233977ae365eSSteven Rostedt 	 * could be on another CPU trying to swap its reader
234077ae365eSSteven Rostedt 	 * page with the buffer head.
234177ae365eSSteven Rostedt 	 *
234277ae365eSSteven Rostedt 	 * We are also fighting against interrupts coming in and
234377ae365eSSteven Rostedt 	 * moving the head or tail on us as well.
234477ae365eSSteven Rostedt 	 *
234577ae365eSSteven Rostedt 	 * If the next page is the head page then we have filled
234677ae365eSSteven Rostedt 	 * the buffer, unless the commit page is still on the
234777ae365eSSteven Rostedt 	 * reader page.
2348bf41a158SSteven Rostedt 	 */
234977ae365eSSteven Rostedt 	if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
2350bf41a158SSteven Rostedt 
235177ae365eSSteven Rostedt 		/*
235277ae365eSSteven Rostedt 		 * If the commit is not on the reader page, then
235377ae365eSSteven Rostedt 		 * move the header page.
235477ae365eSSteven Rostedt 		 */
235577ae365eSSteven Rostedt 		if (!rb_is_reader_page(cpu_buffer->commit_page)) {
235677ae365eSSteven Rostedt 			/*
235777ae365eSSteven Rostedt 			 * If we are not in overwrite mode,
235877ae365eSSteven Rostedt 			 * this is easy, just stop here.
235977ae365eSSteven Rostedt 			 */
2360884bfe89SSlava Pestov 			if (!(buffer->flags & RB_FL_OVERWRITE)) {
2361884bfe89SSlava Pestov 				local_inc(&cpu_buffer->dropped_events);
236277ae365eSSteven Rostedt 				goto out_reset;
2363884bfe89SSlava Pestov 			}
236477ae365eSSteven Rostedt 
236577ae365eSSteven Rostedt 			ret = rb_handle_head_page(cpu_buffer,
236677ae365eSSteven Rostedt 						  tail_page,
236777ae365eSSteven Rostedt 						  next_page);
236877ae365eSSteven Rostedt 			if (ret < 0)
236977ae365eSSteven Rostedt 				goto out_reset;
237077ae365eSSteven Rostedt 			if (ret)
237177ae365eSSteven Rostedt 				goto out_again;
237277ae365eSSteven Rostedt 		} else {
237377ae365eSSteven Rostedt 			/*
237477ae365eSSteven Rostedt 			 * We need to be careful here too. The
237577ae365eSSteven Rostedt 			 * commit page could still be on the reader
237677ae365eSSteven Rostedt 			 * page. We could have a small buffer, and
237777ae365eSSteven Rostedt 			 * have filled up the buffer with events
237877ae365eSSteven Rostedt 			 * from interrupts and such, and wrapped.
237977ae365eSSteven Rostedt 			 *
238077ae365eSSteven Rostedt 			 * Note, if the tail page is also the on the
238177ae365eSSteven Rostedt 			 * reader_page, we let it move out.
238277ae365eSSteven Rostedt 			 */
238377ae365eSSteven Rostedt 			if (unlikely((cpu_buffer->commit_page !=
238477ae365eSSteven Rostedt 				      cpu_buffer->tail_page) &&
238577ae365eSSteven Rostedt 				     (cpu_buffer->commit_page ==
238677ae365eSSteven Rostedt 				      cpu_buffer->reader_page))) {
238777ae365eSSteven Rostedt 				local_inc(&cpu_buffer->commit_overrun);
238877ae365eSSteven Rostedt 				goto out_reset;
238977ae365eSSteven Rostedt 			}
239077ae365eSSteven Rostedt 		}
2391bf41a158SSteven Rostedt 	}
2392bf41a158SSteven Rostedt 
239377ae365eSSteven Rostedt 	ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
239477ae365eSSteven Rostedt 	if (ret) {
239577ae365eSSteven Rostedt 		/*
239677ae365eSSteven Rostedt 		 * Nested commits always have zero deltas, so
239777ae365eSSteven Rostedt 		 * just reread the time stamp
239877ae365eSSteven Rostedt 		 */
2399e8bc43e8SSteven Rostedt 		ts = rb_time_stamp(buffer);
2400e8bc43e8SSteven Rostedt 		next_page->page->time_stamp = ts;
240177ae365eSSteven Rostedt 	}
24027a8e76a3SSteven Rostedt 
240377ae365eSSteven Rostedt  out_again:
240477ae365eSSteven Rostedt 
240577ae365eSSteven Rostedt 	rb_reset_tail(cpu_buffer, tail_page, tail, length);
2406bf41a158SSteven Rostedt 
2407bf41a158SSteven Rostedt 	/* fail and let the caller try again */
2408bf41a158SSteven Rostedt 	return ERR_PTR(-EAGAIN);
2409bf41a158SSteven Rostedt 
241045141d46SSteven Rostedt  out_reset:
24116f3b3440SLai Jiangshan 	/* reset write */
2412c7b09308SSteven Rostedt 	rb_reset_tail(cpu_buffer, tail_page, tail, length);
24136f3b3440SLai Jiangshan 
2414bf41a158SSteven Rostedt 	return NULL;
24157a8e76a3SSteven Rostedt }
24167a8e76a3SSteven Rostedt 
24176634ff26SSteven Rostedt static struct ring_buffer_event *
24186634ff26SSteven Rostedt __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
241969d1b839SSteven Rostedt 		  unsigned long length, u64 ts,
242069d1b839SSteven Rostedt 		  u64 delta, int add_timestamp)
24216634ff26SSteven Rostedt {
24225a50e33cSSteven Rostedt 	struct buffer_page *tail_page;
24236634ff26SSteven Rostedt 	struct ring_buffer_event *event;
24246634ff26SSteven Rostedt 	unsigned long tail, write;
24256634ff26SSteven Rostedt 
242669d1b839SSteven Rostedt 	/*
242769d1b839SSteven Rostedt 	 * If the time delta since the last event is too big to
242869d1b839SSteven Rostedt 	 * hold in the time field of the event, then we append a
242969d1b839SSteven Rostedt 	 * TIME EXTEND event ahead of the data event.
243069d1b839SSteven Rostedt 	 */
243169d1b839SSteven Rostedt 	if (unlikely(add_timestamp))
243269d1b839SSteven Rostedt 		length += RB_LEN_TIME_EXTEND;
243369d1b839SSteven Rostedt 
24346634ff26SSteven Rostedt 	tail_page = cpu_buffer->tail_page;
24356634ff26SSteven Rostedt 	write = local_add_return(length, &tail_page->write);
243677ae365eSSteven Rostedt 
243777ae365eSSteven Rostedt 	/* set write to only the index of the write */
243877ae365eSSteven Rostedt 	write &= RB_WRITE_MASK;
24396634ff26SSteven Rostedt 	tail = write - length;
24406634ff26SSteven Rostedt 
2441d651aa1dSSteven Rostedt (Red Hat) 	/*
2442d651aa1dSSteven Rostedt (Red Hat) 	 * If this is the first commit on the page, then it has the same
2443d651aa1dSSteven Rostedt (Red Hat) 	 * timestamp as the page itself.
2444d651aa1dSSteven Rostedt (Red Hat) 	 */
2445d651aa1dSSteven Rostedt (Red Hat) 	if (!tail)
2446d651aa1dSSteven Rostedt (Red Hat) 		delta = 0;
2447d651aa1dSSteven Rostedt (Red Hat) 
24486634ff26SSteven Rostedt 	/* See if we shot pass the end of this buffer page */
2449747e94aeSSteven Rostedt 	if (unlikely(write > BUF_PAGE_SIZE))
24506634ff26SSteven Rostedt 		return rb_move_tail(cpu_buffer, length, tail,
24515a50e33cSSteven Rostedt 				    tail_page, ts);
24526634ff26SSteven Rostedt 
24536634ff26SSteven Rostedt 	/* We reserved something on the buffer */
24546634ff26SSteven Rostedt 
24556634ff26SSteven Rostedt 	event = __rb_page_index(tail_page, tail);
24561744a21dSVegard Nossum 	kmemcheck_annotate_bitfield(event, bitfield);
245769d1b839SSteven Rostedt 	rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
24586634ff26SSteven Rostedt 
24596634ff26SSteven Rostedt 	local_inc(&tail_page->entries);
24606634ff26SSteven Rostedt 
24616634ff26SSteven Rostedt 	/*
2462fa743953SSteven Rostedt 	 * If this is the first commit on the page, then update
2463fa743953SSteven Rostedt 	 * its timestamp.
24646634ff26SSteven Rostedt 	 */
2465fa743953SSteven Rostedt 	if (!tail)
2466e8bc43e8SSteven Rostedt 		tail_page->page->time_stamp = ts;
24676634ff26SSteven Rostedt 
2468c64e148aSVaibhav Nagarnaik 	/* account for these added bytes */
2469c64e148aSVaibhav Nagarnaik 	local_add(length, &cpu_buffer->entries_bytes);
2470c64e148aSVaibhav Nagarnaik 
24716634ff26SSteven Rostedt 	return event;
24726634ff26SSteven Rostedt }
24736634ff26SSteven Rostedt 
2474edd813bfSSteven Rostedt static inline int
2475edd813bfSSteven Rostedt rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
2476edd813bfSSteven Rostedt 		  struct ring_buffer_event *event)
2477edd813bfSSteven Rostedt {
2478edd813bfSSteven Rostedt 	unsigned long new_index, old_index;
2479edd813bfSSteven Rostedt 	struct buffer_page *bpage;
2480edd813bfSSteven Rostedt 	unsigned long index;
2481edd813bfSSteven Rostedt 	unsigned long addr;
2482edd813bfSSteven Rostedt 
2483edd813bfSSteven Rostedt 	new_index = rb_event_index(event);
248469d1b839SSteven Rostedt 	old_index = new_index + rb_event_ts_length(event);
2485edd813bfSSteven Rostedt 	addr = (unsigned long)event;
2486edd813bfSSteven Rostedt 	addr &= PAGE_MASK;
2487edd813bfSSteven Rostedt 
2488edd813bfSSteven Rostedt 	bpage = cpu_buffer->tail_page;
2489edd813bfSSteven Rostedt 
2490edd813bfSSteven Rostedt 	if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
249177ae365eSSteven Rostedt 		unsigned long write_mask =
249277ae365eSSteven Rostedt 			local_read(&bpage->write) & ~RB_WRITE_MASK;
2493c64e148aSVaibhav Nagarnaik 		unsigned long event_length = rb_event_length(event);
2494edd813bfSSteven Rostedt 		/*
2495edd813bfSSteven Rostedt 		 * This is on the tail page. It is possible that
2496edd813bfSSteven Rostedt 		 * a write could come in and move the tail page
2497edd813bfSSteven Rostedt 		 * and write to the next page. That is fine
2498edd813bfSSteven Rostedt 		 * because we just shorten what is on this page.
2499edd813bfSSteven Rostedt 		 */
250077ae365eSSteven Rostedt 		old_index += write_mask;
250177ae365eSSteven Rostedt 		new_index += write_mask;
2502edd813bfSSteven Rostedt 		index = local_cmpxchg(&bpage->write, old_index, new_index);
2503c64e148aSVaibhav Nagarnaik 		if (index == old_index) {
2504c64e148aSVaibhav Nagarnaik 			/* update counters */
2505c64e148aSVaibhav Nagarnaik 			local_sub(event_length, &cpu_buffer->entries_bytes);
2506edd813bfSSteven Rostedt 			return 1;
2507edd813bfSSteven Rostedt 		}
2508c64e148aSVaibhav Nagarnaik 	}
2509edd813bfSSteven Rostedt 
2510edd813bfSSteven Rostedt 	/* could not discard */
2511edd813bfSSteven Rostedt 	return 0;
2512edd813bfSSteven Rostedt }
2513edd813bfSSteven Rostedt 
2514fa743953SSteven Rostedt static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
2515fa743953SSteven Rostedt {
2516fa743953SSteven Rostedt 	local_inc(&cpu_buffer->committing);
2517fa743953SSteven Rostedt 	local_inc(&cpu_buffer->commits);
2518fa743953SSteven Rostedt }
2519fa743953SSteven Rostedt 
2520d9abde21SSteven Rostedt static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
2521fa743953SSteven Rostedt {
2522fa743953SSteven Rostedt 	unsigned long commits;
2523fa743953SSteven Rostedt 
2524fa743953SSteven Rostedt 	if (RB_WARN_ON(cpu_buffer,
2525fa743953SSteven Rostedt 		       !local_read(&cpu_buffer->committing)))
2526fa743953SSteven Rostedt 		return;
2527fa743953SSteven Rostedt 
2528fa743953SSteven Rostedt  again:
2529fa743953SSteven Rostedt 	commits = local_read(&cpu_buffer->commits);
2530fa743953SSteven Rostedt 	/* synchronize with interrupts */
2531fa743953SSteven Rostedt 	barrier();
2532fa743953SSteven Rostedt 	if (local_read(&cpu_buffer->committing) == 1)
2533fa743953SSteven Rostedt 		rb_set_commit_to_write(cpu_buffer);
2534fa743953SSteven Rostedt 
2535fa743953SSteven Rostedt 	local_dec(&cpu_buffer->committing);
2536fa743953SSteven Rostedt 
2537fa743953SSteven Rostedt 	/* synchronize with interrupts */
2538fa743953SSteven Rostedt 	barrier();
2539fa743953SSteven Rostedt 
2540fa743953SSteven Rostedt 	/*
2541fa743953SSteven Rostedt 	 * Need to account for interrupts coming in between the
2542fa743953SSteven Rostedt 	 * updating of the commit page and the clearing of the
2543fa743953SSteven Rostedt 	 * committing counter.
2544fa743953SSteven Rostedt 	 */
2545fa743953SSteven Rostedt 	if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
2546fa743953SSteven Rostedt 	    !local_read(&cpu_buffer->committing)) {
2547fa743953SSteven Rostedt 		local_inc(&cpu_buffer->committing);
2548fa743953SSteven Rostedt 		goto again;
2549fa743953SSteven Rostedt 	}
2550fa743953SSteven Rostedt }
2551fa743953SSteven Rostedt 
25527a8e76a3SSteven Rostedt static struct ring_buffer_event *
255362f0b3ebSSteven Rostedt rb_reserve_next_event(struct ring_buffer *buffer,
255462f0b3ebSSteven Rostedt 		      struct ring_buffer_per_cpu *cpu_buffer,
25551cd8d735SSteven Rostedt 		      unsigned long length)
25567a8e76a3SSteven Rostedt {
25577a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
255869d1b839SSteven Rostedt 	u64 ts, delta;
2559818e3dd3SSteven Rostedt 	int nr_loops = 0;
256069d1b839SSteven Rostedt 	int add_timestamp;
2561140ff891SSteven Rostedt 	u64 diff;
25627a8e76a3SSteven Rostedt 
2563fa743953SSteven Rostedt 	rb_start_commit(cpu_buffer);
2564fa743953SSteven Rostedt 
256585bac32cSSteven Rostedt #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
256662f0b3ebSSteven Rostedt 	/*
256762f0b3ebSSteven Rostedt 	 * Due to the ability to swap a cpu buffer from a buffer
256862f0b3ebSSteven Rostedt 	 * it is possible it was swapped before we committed.
256962f0b3ebSSteven Rostedt 	 * (committing stops a swap). We check for it here and
257062f0b3ebSSteven Rostedt 	 * if it happened, we have to fail the write.
257162f0b3ebSSteven Rostedt 	 */
257262f0b3ebSSteven Rostedt 	barrier();
257362f0b3ebSSteven Rostedt 	if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
257462f0b3ebSSteven Rostedt 		local_dec(&cpu_buffer->committing);
257562f0b3ebSSteven Rostedt 		local_dec(&cpu_buffer->commits);
257662f0b3ebSSteven Rostedt 		return NULL;
257762f0b3ebSSteven Rostedt 	}
257885bac32cSSteven Rostedt #endif
257962f0b3ebSSteven Rostedt 
2580be957c44SSteven Rostedt 	length = rb_calculate_event_length(length);
2581bf41a158SSteven Rostedt  again:
258269d1b839SSteven Rostedt 	add_timestamp = 0;
258369d1b839SSteven Rostedt 	delta = 0;
258469d1b839SSteven Rostedt 
2585818e3dd3SSteven Rostedt 	/*
2586818e3dd3SSteven Rostedt 	 * We allow for interrupts to reenter here and do a trace.
2587818e3dd3SSteven Rostedt 	 * If one does, it will cause this original code to loop
2588818e3dd3SSteven Rostedt 	 * back here. Even with heavy interrupts happening, this
2589818e3dd3SSteven Rostedt 	 * should only happen a few times in a row. If this happens
2590818e3dd3SSteven Rostedt 	 * 1000 times in a row, there must be either an interrupt
2591818e3dd3SSteven Rostedt 	 * storm or we have something buggy.
2592818e3dd3SSteven Rostedt 	 * Bail!
2593818e3dd3SSteven Rostedt 	 */
25943e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
2595fa743953SSteven Rostedt 		goto out_fail;
2596818e3dd3SSteven Rostedt 
25976d3f1e12SJiri Olsa 	ts = rb_time_stamp(cpu_buffer->buffer);
2598168b6b1dSSteven Rostedt 	diff = ts - cpu_buffer->write_stamp;
25997a8e76a3SSteven Rostedt 
2600168b6b1dSSteven Rostedt 	/* make sure this diff is calculated here */
2601bf41a158SSteven Rostedt 	barrier();
26027a8e76a3SSteven Rostedt 
2603bf41a158SSteven Rostedt 	/* Did the write stamp get updated already? */
2604140ff891SSteven Rostedt 	if (likely(ts >= cpu_buffer->write_stamp)) {
2605168b6b1dSSteven Rostedt 		delta = diff;
2606168b6b1dSSteven Rostedt 		if (unlikely(test_time_stamp(delta))) {
260731274d72SJiri Olsa 			int local_clock_stable = 1;
260831274d72SJiri Olsa #ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
260935af99e6SPeter Zijlstra 			local_clock_stable = sched_clock_stable();
261031274d72SJiri Olsa #endif
261169d1b839SSteven Rostedt 			WARN_ONCE(delta > (1ULL << 59),
261231274d72SJiri Olsa 				  KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
261369d1b839SSteven Rostedt 				  (unsigned long long)delta,
261469d1b839SSteven Rostedt 				  (unsigned long long)ts,
261531274d72SJiri Olsa 				  (unsigned long long)cpu_buffer->write_stamp,
261631274d72SJiri Olsa 				  local_clock_stable ? "" :
261731274d72SJiri Olsa 				  "If you just came from a suspend/resume,\n"
261831274d72SJiri Olsa 				  "please switch to the trace global clock:\n"
261931274d72SJiri Olsa 				  "  echo global > /sys/kernel/debug/tracing/trace_clock\n");
262069d1b839SSteven Rostedt 			add_timestamp = 1;
26217a8e76a3SSteven Rostedt 		}
2622168b6b1dSSteven Rostedt 	}
26237a8e76a3SSteven Rostedt 
262469d1b839SSteven Rostedt 	event = __rb_reserve_next(cpu_buffer, length, ts,
262569d1b839SSteven Rostedt 				  delta, add_timestamp);
2626168b6b1dSSteven Rostedt 	if (unlikely(PTR_ERR(event) == -EAGAIN))
2627bf41a158SSteven Rostedt 		goto again;
26287a8e76a3SSteven Rostedt 
2629fa743953SSteven Rostedt 	if (!event)
2630fa743953SSteven Rostedt 		goto out_fail;
2631bf41a158SSteven Rostedt 
26327a8e76a3SSteven Rostedt 	return event;
2633fa743953SSteven Rostedt 
2634fa743953SSteven Rostedt  out_fail:
2635fa743953SSteven Rostedt 	rb_end_commit(cpu_buffer);
2636fa743953SSteven Rostedt 	return NULL;
26377a8e76a3SSteven Rostedt }
26387a8e76a3SSteven Rostedt 
26391155de47SPaul Mundt #ifdef CONFIG_TRACING
26401155de47SPaul Mundt 
2641567cd4daSSteven Rostedt /*
2642567cd4daSSteven Rostedt  * The lock and unlock are done within a preempt disable section.
2643567cd4daSSteven Rostedt  * The current_context per_cpu variable can only be modified
2644567cd4daSSteven Rostedt  * by the current task between lock and unlock. But it can
2645567cd4daSSteven Rostedt  * be modified more than once via an interrupt. To pass this
2646567cd4daSSteven Rostedt  * information from the lock to the unlock without having to
2647567cd4daSSteven Rostedt  * access the 'in_interrupt()' functions again (which do show
2648567cd4daSSteven Rostedt  * a bit of overhead in something as critical as function tracing,
2649567cd4daSSteven Rostedt  * we use a bitmask trick.
2650567cd4daSSteven Rostedt  *
2651567cd4daSSteven Rostedt  *  bit 0 =  NMI context
2652567cd4daSSteven Rostedt  *  bit 1 =  IRQ context
2653567cd4daSSteven Rostedt  *  bit 2 =  SoftIRQ context
2654567cd4daSSteven Rostedt  *  bit 3 =  normal context.
2655567cd4daSSteven Rostedt  *
2656567cd4daSSteven Rostedt  * This works because this is the order of contexts that can
2657567cd4daSSteven Rostedt  * preempt other contexts. A SoftIRQ never preempts an IRQ
2658567cd4daSSteven Rostedt  * context.
2659567cd4daSSteven Rostedt  *
2660567cd4daSSteven Rostedt  * When the context is determined, the corresponding bit is
2661567cd4daSSteven Rostedt  * checked and set (if it was set, then a recursion of that context
2662567cd4daSSteven Rostedt  * happened).
2663567cd4daSSteven Rostedt  *
2664567cd4daSSteven Rostedt  * On unlock, we need to clear this bit. To do so, just subtract
2665567cd4daSSteven Rostedt  * 1 from the current_context and AND it to itself.
2666567cd4daSSteven Rostedt  *
2667567cd4daSSteven Rostedt  * (binary)
2668567cd4daSSteven Rostedt  *  101 - 1 = 100
2669567cd4daSSteven Rostedt  *  101 & 100 = 100 (clearing bit zero)
2670567cd4daSSteven Rostedt  *
2671567cd4daSSteven Rostedt  *  1010 - 1 = 1001
2672567cd4daSSteven Rostedt  *  1010 & 1001 = 1000 (clearing bit 1)
2673567cd4daSSteven Rostedt  *
2674567cd4daSSteven Rostedt  * The least significant bit can be cleared this way, and it
2675567cd4daSSteven Rostedt  * just so happens that it is the same bit corresponding to
2676567cd4daSSteven Rostedt  * the current context.
2677567cd4daSSteven Rostedt  */
2678567cd4daSSteven Rostedt static DEFINE_PER_CPU(unsigned int, current_context);
2679261842b7SSteven Rostedt 
2680567cd4daSSteven Rostedt static __always_inline int trace_recursive_lock(void)
2681261842b7SSteven Rostedt {
2682*80a9b64eSSteven Rostedt 	unsigned int val = __this_cpu_read(current_context);
2683567cd4daSSteven Rostedt 	int bit;
2684e057a5e5SFrederic Weisbecker 
2685567cd4daSSteven Rostedt 	if (in_interrupt()) {
2686567cd4daSSteven Rostedt 		if (in_nmi())
2687567cd4daSSteven Rostedt 			bit = 0;
2688567cd4daSSteven Rostedt 		else if (in_irq())
2689567cd4daSSteven Rostedt 			bit = 1;
2690567cd4daSSteven Rostedt 		else
2691567cd4daSSteven Rostedt 			bit = 2;
2692567cd4daSSteven Rostedt 	} else
2693567cd4daSSteven Rostedt 		bit = 3;
2694e057a5e5SFrederic Weisbecker 
2695567cd4daSSteven Rostedt 	if (unlikely(val & (1 << bit)))
2696567cd4daSSteven Rostedt 		return 1;
2697d9abde21SSteven Rostedt 
2698567cd4daSSteven Rostedt 	val |= (1 << bit);
2699*80a9b64eSSteven Rostedt 	__this_cpu_write(current_context, val);
2700d9abde21SSteven Rostedt 
2701d9abde21SSteven Rostedt 	return 0;
2702261842b7SSteven Rostedt }
2703261842b7SSteven Rostedt 
2704567cd4daSSteven Rostedt static __always_inline void trace_recursive_unlock(void)
2705261842b7SSteven Rostedt {
2706*80a9b64eSSteven Rostedt 	unsigned int val = __this_cpu_read(current_context);
2707261842b7SSteven Rostedt 
2708*80a9b64eSSteven Rostedt 	val &= val & (val - 1);
2709*80a9b64eSSteven Rostedt 	__this_cpu_write(current_context, val);
2710261842b7SSteven Rostedt }
2711261842b7SSteven Rostedt 
27121155de47SPaul Mundt #else
27131155de47SPaul Mundt 
27141155de47SPaul Mundt #define trace_recursive_lock()		(0)
27151155de47SPaul Mundt #define trace_recursive_unlock()	do { } while (0)
27161155de47SPaul Mundt 
27171155de47SPaul Mundt #endif
27181155de47SPaul Mundt 
27197a8e76a3SSteven Rostedt /**
27207a8e76a3SSteven Rostedt  * ring_buffer_lock_reserve - reserve a part of the buffer
27217a8e76a3SSteven Rostedt  * @buffer: the ring buffer to reserve from
27227a8e76a3SSteven Rostedt  * @length: the length of the data to reserve (excluding event header)
27237a8e76a3SSteven Rostedt  *
27247a8e76a3SSteven Rostedt  * Returns a reseverd event on the ring buffer to copy directly to.
27257a8e76a3SSteven Rostedt  * The user of this interface will need to get the body to write into
27267a8e76a3SSteven Rostedt  * and can use the ring_buffer_event_data() interface.
27277a8e76a3SSteven Rostedt  *
27287a8e76a3SSteven Rostedt  * The length is the length of the data needed, not the event length
27297a8e76a3SSteven Rostedt  * which also includes the event header.
27307a8e76a3SSteven Rostedt  *
27317a8e76a3SSteven Rostedt  * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
27327a8e76a3SSteven Rostedt  * If NULL is returned, then nothing has been allocated or locked.
27337a8e76a3SSteven Rostedt  */
27347a8e76a3SSteven Rostedt struct ring_buffer_event *
27350a987751SArnaldo Carvalho de Melo ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
27367a8e76a3SSteven Rostedt {
27377a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
27387a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
27395168ae50SSteven Rostedt 	int cpu;
27407a8e76a3SSteven Rostedt 
2741033601a3SSteven Rostedt 	if (ring_buffer_flags != RB_BUFFERS_ON)
2742a3583244SSteven Rostedt 		return NULL;
2743a3583244SSteven Rostedt 
2744bf41a158SSteven Rostedt 	/* If we are tracing schedule, we don't want to recurse */
27455168ae50SSteven Rostedt 	preempt_disable_notrace();
2746bf41a158SSteven Rostedt 
274752fbe9cdSLai Jiangshan 	if (atomic_read(&buffer->record_disabled))
274852fbe9cdSLai Jiangshan 		goto out_nocheck;
274952fbe9cdSLai Jiangshan 
2750261842b7SSteven Rostedt 	if (trace_recursive_lock())
2751261842b7SSteven Rostedt 		goto out_nocheck;
2752261842b7SSteven Rostedt 
27537a8e76a3SSteven Rostedt 	cpu = raw_smp_processor_id();
27547a8e76a3SSteven Rostedt 
27559e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
2756d769041fSSteven Rostedt 		goto out;
27577a8e76a3SSteven Rostedt 
27587a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
27597a8e76a3SSteven Rostedt 
27607a8e76a3SSteven Rostedt 	if (atomic_read(&cpu_buffer->record_disabled))
2761d769041fSSteven Rostedt 		goto out;
27627a8e76a3SSteven Rostedt 
2763be957c44SSteven Rostedt 	if (length > BUF_MAX_DATA_SIZE)
2764bf41a158SSteven Rostedt 		goto out;
27657a8e76a3SSteven Rostedt 
276662f0b3ebSSteven Rostedt 	event = rb_reserve_next_event(buffer, cpu_buffer, length);
27677a8e76a3SSteven Rostedt 	if (!event)
2768d769041fSSteven Rostedt 		goto out;
27697a8e76a3SSteven Rostedt 
27707a8e76a3SSteven Rostedt 	return event;
27717a8e76a3SSteven Rostedt 
2772d769041fSSteven Rostedt  out:
2773261842b7SSteven Rostedt 	trace_recursive_unlock();
2774261842b7SSteven Rostedt 
2775261842b7SSteven Rostedt  out_nocheck:
27765168ae50SSteven Rostedt 	preempt_enable_notrace();
27777a8e76a3SSteven Rostedt 	return NULL;
27787a8e76a3SSteven Rostedt }
2779c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
27807a8e76a3SSteven Rostedt 
2781a1863c21SSteven Rostedt static void
2782a1863c21SSteven Rostedt rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
27837a8e76a3SSteven Rostedt 		      struct ring_buffer_event *event)
27847a8e76a3SSteven Rostedt {
278569d1b839SSteven Rostedt 	u64 delta;
278669d1b839SSteven Rostedt 
2787fa743953SSteven Rostedt 	/*
2788fa743953SSteven Rostedt 	 * The event first in the commit queue updates the
2789fa743953SSteven Rostedt 	 * time stamp.
2790fa743953SSteven Rostedt 	 */
279169d1b839SSteven Rostedt 	if (rb_event_is_commit(cpu_buffer, event)) {
279269d1b839SSteven Rostedt 		/*
279369d1b839SSteven Rostedt 		 * A commit event that is first on a page
279469d1b839SSteven Rostedt 		 * updates the write timestamp with the page stamp
279569d1b839SSteven Rostedt 		 */
279669d1b839SSteven Rostedt 		if (!rb_event_index(event))
279769d1b839SSteven Rostedt 			cpu_buffer->write_stamp =
279869d1b839SSteven Rostedt 				cpu_buffer->commit_page->page->time_stamp;
279969d1b839SSteven Rostedt 		else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
280069d1b839SSteven Rostedt 			delta = event->array[0];
280169d1b839SSteven Rostedt 			delta <<= TS_SHIFT;
280269d1b839SSteven Rostedt 			delta += event->time_delta;
280369d1b839SSteven Rostedt 			cpu_buffer->write_stamp += delta;
280469d1b839SSteven Rostedt 		} else
2805bf41a158SSteven Rostedt 			cpu_buffer->write_stamp += event->time_delta;
2806a1863c21SSteven Rostedt 	}
280769d1b839SSteven Rostedt }
2808bf41a158SSteven Rostedt 
2809a1863c21SSteven Rostedt static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
2810a1863c21SSteven Rostedt 		      struct ring_buffer_event *event)
2811a1863c21SSteven Rostedt {
2812a1863c21SSteven Rostedt 	local_inc(&cpu_buffer->entries);
2813a1863c21SSteven Rostedt 	rb_update_write_stamp(cpu_buffer, event);
2814fa743953SSteven Rostedt 	rb_end_commit(cpu_buffer);
28157a8e76a3SSteven Rostedt }
28167a8e76a3SSteven Rostedt 
281715693458SSteven Rostedt (Red Hat) static __always_inline void
281815693458SSteven Rostedt (Red Hat) rb_wakeups(struct ring_buffer *buffer, struct ring_buffer_per_cpu *cpu_buffer)
281915693458SSteven Rostedt (Red Hat) {
28201e0d6714SSteven Rostedt (Red Hat) 	bool pagebusy;
28211e0d6714SSteven Rostedt (Red Hat) 
282215693458SSteven Rostedt (Red Hat) 	if (buffer->irq_work.waiters_pending) {
282315693458SSteven Rostedt (Red Hat) 		buffer->irq_work.waiters_pending = false;
282415693458SSteven Rostedt (Red Hat) 		/* irq_work_queue() supplies it's own memory barriers */
282515693458SSteven Rostedt (Red Hat) 		irq_work_queue(&buffer->irq_work.work);
282615693458SSteven Rostedt (Red Hat) 	}
282715693458SSteven Rostedt (Red Hat) 
282815693458SSteven Rostedt (Red Hat) 	if (cpu_buffer->irq_work.waiters_pending) {
282915693458SSteven Rostedt (Red Hat) 		cpu_buffer->irq_work.waiters_pending = false;
283015693458SSteven Rostedt (Red Hat) 		/* irq_work_queue() supplies it's own memory barriers */
283115693458SSteven Rostedt (Red Hat) 		irq_work_queue(&cpu_buffer->irq_work.work);
283215693458SSteven Rostedt (Red Hat) 	}
28331e0d6714SSteven Rostedt (Red Hat) 
28341e0d6714SSteven Rostedt (Red Hat) 	pagebusy = cpu_buffer->reader_page == cpu_buffer->commit_page;
28351e0d6714SSteven Rostedt (Red Hat) 
28361e0d6714SSteven Rostedt (Red Hat) 	if (!pagebusy && cpu_buffer->irq_work.full_waiters_pending) {
28371e0d6714SSteven Rostedt (Red Hat) 		cpu_buffer->irq_work.wakeup_full = true;
28381e0d6714SSteven Rostedt (Red Hat) 		cpu_buffer->irq_work.full_waiters_pending = false;
28391e0d6714SSteven Rostedt (Red Hat) 		/* irq_work_queue() supplies it's own memory barriers */
28401e0d6714SSteven Rostedt (Red Hat) 		irq_work_queue(&cpu_buffer->irq_work.work);
28411e0d6714SSteven Rostedt (Red Hat) 	}
284215693458SSteven Rostedt (Red Hat) }
284315693458SSteven Rostedt (Red Hat) 
28447a8e76a3SSteven Rostedt /**
28457a8e76a3SSteven Rostedt  * ring_buffer_unlock_commit - commit a reserved
28467a8e76a3SSteven Rostedt  * @buffer: The buffer to commit to
28477a8e76a3SSteven Rostedt  * @event: The event pointer to commit.
28487a8e76a3SSteven Rostedt  *
28497a8e76a3SSteven Rostedt  * This commits the data to the ring buffer, and releases any locks held.
28507a8e76a3SSteven Rostedt  *
28517a8e76a3SSteven Rostedt  * Must be paired with ring_buffer_lock_reserve.
28527a8e76a3SSteven Rostedt  */
28537a8e76a3SSteven Rostedt int ring_buffer_unlock_commit(struct ring_buffer *buffer,
28540a987751SArnaldo Carvalho de Melo 			      struct ring_buffer_event *event)
28557a8e76a3SSteven Rostedt {
28567a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
28577a8e76a3SSteven Rostedt 	int cpu = raw_smp_processor_id();
28587a8e76a3SSteven Rostedt 
28597a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
28607a8e76a3SSteven Rostedt 
28617a8e76a3SSteven Rostedt 	rb_commit(cpu_buffer, event);
28627a8e76a3SSteven Rostedt 
286315693458SSteven Rostedt (Red Hat) 	rb_wakeups(buffer, cpu_buffer);
286415693458SSteven Rostedt (Red Hat) 
2865261842b7SSteven Rostedt 	trace_recursive_unlock();
2866261842b7SSteven Rostedt 
28675168ae50SSteven Rostedt 	preempt_enable_notrace();
28687a8e76a3SSteven Rostedt 
28697a8e76a3SSteven Rostedt 	return 0;
28707a8e76a3SSteven Rostedt }
2871c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
28727a8e76a3SSteven Rostedt 
2873f3b9aae1SFrederic Weisbecker static inline void rb_event_discard(struct ring_buffer_event *event)
2874f3b9aae1SFrederic Weisbecker {
287569d1b839SSteven Rostedt 	if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
287669d1b839SSteven Rostedt 		event = skip_time_extend(event);
287769d1b839SSteven Rostedt 
2878334d4169SLai Jiangshan 	/* array[0] holds the actual length for the discarded event */
2879334d4169SLai Jiangshan 	event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
2880334d4169SLai Jiangshan 	event->type_len = RINGBUF_TYPE_PADDING;
2881f3b9aae1SFrederic Weisbecker 	/* time delta must be non zero */
2882f3b9aae1SFrederic Weisbecker 	if (!event->time_delta)
2883f3b9aae1SFrederic Weisbecker 		event->time_delta = 1;
2884f3b9aae1SFrederic Weisbecker }
2885f3b9aae1SFrederic Weisbecker 
2886a1863c21SSteven Rostedt /*
2887a1863c21SSteven Rostedt  * Decrement the entries to the page that an event is on.
2888a1863c21SSteven Rostedt  * The event does not even need to exist, only the pointer
2889a1863c21SSteven Rostedt  * to the page it is on. This may only be called before the commit
2890a1863c21SSteven Rostedt  * takes place.
2891a1863c21SSteven Rostedt  */
2892a1863c21SSteven Rostedt static inline void
2893a1863c21SSteven Rostedt rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
2894a1863c21SSteven Rostedt 		   struct ring_buffer_event *event)
2895a1863c21SSteven Rostedt {
2896a1863c21SSteven Rostedt 	unsigned long addr = (unsigned long)event;
2897a1863c21SSteven Rostedt 	struct buffer_page *bpage = cpu_buffer->commit_page;
2898a1863c21SSteven Rostedt 	struct buffer_page *start;
2899a1863c21SSteven Rostedt 
2900a1863c21SSteven Rostedt 	addr &= PAGE_MASK;
2901a1863c21SSteven Rostedt 
2902a1863c21SSteven Rostedt 	/* Do the likely case first */
2903a1863c21SSteven Rostedt 	if (likely(bpage->page == (void *)addr)) {
2904a1863c21SSteven Rostedt 		local_dec(&bpage->entries);
2905a1863c21SSteven Rostedt 		return;
2906a1863c21SSteven Rostedt 	}
2907a1863c21SSteven Rostedt 
2908a1863c21SSteven Rostedt 	/*
2909a1863c21SSteven Rostedt 	 * Because the commit page may be on the reader page we
2910a1863c21SSteven Rostedt 	 * start with the next page and check the end loop there.
2911a1863c21SSteven Rostedt 	 */
2912a1863c21SSteven Rostedt 	rb_inc_page(cpu_buffer, &bpage);
2913a1863c21SSteven Rostedt 	start = bpage;
2914a1863c21SSteven Rostedt 	do {
2915a1863c21SSteven Rostedt 		if (bpage->page == (void *)addr) {
2916a1863c21SSteven Rostedt 			local_dec(&bpage->entries);
2917a1863c21SSteven Rostedt 			return;
2918a1863c21SSteven Rostedt 		}
2919a1863c21SSteven Rostedt 		rb_inc_page(cpu_buffer, &bpage);
2920a1863c21SSteven Rostedt 	} while (bpage != start);
2921a1863c21SSteven Rostedt 
2922a1863c21SSteven Rostedt 	/* commit not part of this buffer?? */
2923a1863c21SSteven Rostedt 	RB_WARN_ON(cpu_buffer, 1);
2924a1863c21SSteven Rostedt }
2925a1863c21SSteven Rostedt 
29267a8e76a3SSteven Rostedt /**
2927fa1b47ddSSteven Rostedt  * ring_buffer_commit_discard - discard an event that has not been committed
2928fa1b47ddSSteven Rostedt  * @buffer: the ring buffer
2929fa1b47ddSSteven Rostedt  * @event: non committed event to discard
2930fa1b47ddSSteven Rostedt  *
2931dc892f73SSteven Rostedt  * Sometimes an event that is in the ring buffer needs to be ignored.
2932dc892f73SSteven Rostedt  * This function lets the user discard an event in the ring buffer
2933dc892f73SSteven Rostedt  * and then that event will not be read later.
2934dc892f73SSteven Rostedt  *
2935dc892f73SSteven Rostedt  * This function only works if it is called before the the item has been
2936dc892f73SSteven Rostedt  * committed. It will try to free the event from the ring buffer
2937fa1b47ddSSteven Rostedt  * if another event has not been added behind it.
2938fa1b47ddSSteven Rostedt  *
2939fa1b47ddSSteven Rostedt  * If another event has been added behind it, it will set the event
2940fa1b47ddSSteven Rostedt  * up as discarded, and perform the commit.
2941fa1b47ddSSteven Rostedt  *
2942fa1b47ddSSteven Rostedt  * If this function is called, do not call ring_buffer_unlock_commit on
2943fa1b47ddSSteven Rostedt  * the event.
2944fa1b47ddSSteven Rostedt  */
2945fa1b47ddSSteven Rostedt void ring_buffer_discard_commit(struct ring_buffer *buffer,
2946fa1b47ddSSteven Rostedt 				struct ring_buffer_event *event)
2947fa1b47ddSSteven Rostedt {
2948fa1b47ddSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
2949fa1b47ddSSteven Rostedt 	int cpu;
2950fa1b47ddSSteven Rostedt 
2951fa1b47ddSSteven Rostedt 	/* The event is discarded regardless */
2952f3b9aae1SFrederic Weisbecker 	rb_event_discard(event);
2953fa1b47ddSSteven Rostedt 
2954fa743953SSteven Rostedt 	cpu = smp_processor_id();
2955fa743953SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
2956fa743953SSteven Rostedt 
2957fa1b47ddSSteven Rostedt 	/*
2958fa1b47ddSSteven Rostedt 	 * This must only be called if the event has not been
2959fa1b47ddSSteven Rostedt 	 * committed yet. Thus we can assume that preemption
2960fa1b47ddSSteven Rostedt 	 * is still disabled.
2961fa1b47ddSSteven Rostedt 	 */
2962fa743953SSteven Rostedt 	RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
2963fa1b47ddSSteven Rostedt 
2964a1863c21SSteven Rostedt 	rb_decrement_entry(cpu_buffer, event);
29650f2541d2SSteven Rostedt 	if (rb_try_to_discard(cpu_buffer, event))
2966fa1b47ddSSteven Rostedt 		goto out;
2967fa1b47ddSSteven Rostedt 
2968fa1b47ddSSteven Rostedt 	/*
2969fa1b47ddSSteven Rostedt 	 * The commit is still visible by the reader, so we
2970a1863c21SSteven Rostedt 	 * must still update the timestamp.
2971fa1b47ddSSteven Rostedt 	 */
2972a1863c21SSteven Rostedt 	rb_update_write_stamp(cpu_buffer, event);
2973fa1b47ddSSteven Rostedt  out:
2974fa743953SSteven Rostedt 	rb_end_commit(cpu_buffer);
2975fa1b47ddSSteven Rostedt 
2976f3b9aae1SFrederic Weisbecker 	trace_recursive_unlock();
2977f3b9aae1SFrederic Weisbecker 
29785168ae50SSteven Rostedt 	preempt_enable_notrace();
2979fa1b47ddSSteven Rostedt 
2980fa1b47ddSSteven Rostedt }
2981fa1b47ddSSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
2982fa1b47ddSSteven Rostedt 
2983fa1b47ddSSteven Rostedt /**
29847a8e76a3SSteven Rostedt  * ring_buffer_write - write data to the buffer without reserving
29857a8e76a3SSteven Rostedt  * @buffer: The ring buffer to write to.
29867a8e76a3SSteven Rostedt  * @length: The length of the data being written (excluding the event header)
29877a8e76a3SSteven Rostedt  * @data: The data to write to the buffer.
29887a8e76a3SSteven Rostedt  *
29897a8e76a3SSteven Rostedt  * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
29907a8e76a3SSteven Rostedt  * one function. If you already have the data to write to the buffer, it
29917a8e76a3SSteven Rostedt  * may be easier to simply call this function.
29927a8e76a3SSteven Rostedt  *
29937a8e76a3SSteven Rostedt  * Note, like ring_buffer_lock_reserve, the length is the length of the data
29947a8e76a3SSteven Rostedt  * and not the length of the event which would hold the header.
29957a8e76a3SSteven Rostedt  */
29967a8e76a3SSteven Rostedt int ring_buffer_write(struct ring_buffer *buffer,
29977a8e76a3SSteven Rostedt 		      unsigned long length,
29987a8e76a3SSteven Rostedt 		      void *data)
29997a8e76a3SSteven Rostedt {
30007a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
30017a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
30027a8e76a3SSteven Rostedt 	void *body;
30037a8e76a3SSteven Rostedt 	int ret = -EBUSY;
30045168ae50SSteven Rostedt 	int cpu;
30057a8e76a3SSteven Rostedt 
3006033601a3SSteven Rostedt 	if (ring_buffer_flags != RB_BUFFERS_ON)
3007a3583244SSteven Rostedt 		return -EBUSY;
3008a3583244SSteven Rostedt 
30095168ae50SSteven Rostedt 	preempt_disable_notrace();
3010bf41a158SSteven Rostedt 
301152fbe9cdSLai Jiangshan 	if (atomic_read(&buffer->record_disabled))
301252fbe9cdSLai Jiangshan 		goto out;
301352fbe9cdSLai Jiangshan 
30147a8e76a3SSteven Rostedt 	cpu = raw_smp_processor_id();
30157a8e76a3SSteven Rostedt 
30169e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3017d769041fSSteven Rostedt 		goto out;
30187a8e76a3SSteven Rostedt 
30197a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
30207a8e76a3SSteven Rostedt 
30217a8e76a3SSteven Rostedt 	if (atomic_read(&cpu_buffer->record_disabled))
30227a8e76a3SSteven Rostedt 		goto out;
30237a8e76a3SSteven Rostedt 
3024be957c44SSteven Rostedt 	if (length > BUF_MAX_DATA_SIZE)
3025be957c44SSteven Rostedt 		goto out;
3026be957c44SSteven Rostedt 
302762f0b3ebSSteven Rostedt 	event = rb_reserve_next_event(buffer, cpu_buffer, length);
30287a8e76a3SSteven Rostedt 	if (!event)
30297a8e76a3SSteven Rostedt 		goto out;
30307a8e76a3SSteven Rostedt 
30317a8e76a3SSteven Rostedt 	body = rb_event_data(event);
30327a8e76a3SSteven Rostedt 
30337a8e76a3SSteven Rostedt 	memcpy(body, data, length);
30347a8e76a3SSteven Rostedt 
30357a8e76a3SSteven Rostedt 	rb_commit(cpu_buffer, event);
30367a8e76a3SSteven Rostedt 
303715693458SSteven Rostedt (Red Hat) 	rb_wakeups(buffer, cpu_buffer);
303815693458SSteven Rostedt (Red Hat) 
30397a8e76a3SSteven Rostedt 	ret = 0;
30407a8e76a3SSteven Rostedt  out:
30415168ae50SSteven Rostedt 	preempt_enable_notrace();
30427a8e76a3SSteven Rostedt 
30437a8e76a3SSteven Rostedt 	return ret;
30447a8e76a3SSteven Rostedt }
3045c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_write);
30467a8e76a3SSteven Rostedt 
304734a148bfSAndrew Morton static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
3048bf41a158SSteven Rostedt {
3049bf41a158SSteven Rostedt 	struct buffer_page *reader = cpu_buffer->reader_page;
305077ae365eSSteven Rostedt 	struct buffer_page *head = rb_set_head_page(cpu_buffer);
3051bf41a158SSteven Rostedt 	struct buffer_page *commit = cpu_buffer->commit_page;
3052bf41a158SSteven Rostedt 
305377ae365eSSteven Rostedt 	/* In case of error, head will be NULL */
305477ae365eSSteven Rostedt 	if (unlikely(!head))
305577ae365eSSteven Rostedt 		return 1;
305677ae365eSSteven Rostedt 
3057bf41a158SSteven Rostedt 	return reader->read == rb_page_commit(reader) &&
3058bf41a158SSteven Rostedt 		(commit == reader ||
3059bf41a158SSteven Rostedt 		 (commit == head &&
3060bf41a158SSteven Rostedt 		  head->read == rb_page_commit(commit)));
3061bf41a158SSteven Rostedt }
3062bf41a158SSteven Rostedt 
30637a8e76a3SSteven Rostedt /**
30647a8e76a3SSteven Rostedt  * ring_buffer_record_disable - stop all writes into the buffer
30657a8e76a3SSteven Rostedt  * @buffer: The ring buffer to stop writes to.
30667a8e76a3SSteven Rostedt  *
30677a8e76a3SSteven Rostedt  * This prevents all writes to the buffer. Any attempt to write
30687a8e76a3SSteven Rostedt  * to the buffer after this will fail and return NULL.
30697a8e76a3SSteven Rostedt  *
30707a8e76a3SSteven Rostedt  * The caller should call synchronize_sched() after this.
30717a8e76a3SSteven Rostedt  */
30727a8e76a3SSteven Rostedt void ring_buffer_record_disable(struct ring_buffer *buffer)
30737a8e76a3SSteven Rostedt {
30747a8e76a3SSteven Rostedt 	atomic_inc(&buffer->record_disabled);
30757a8e76a3SSteven Rostedt }
3076c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
30777a8e76a3SSteven Rostedt 
30787a8e76a3SSteven Rostedt /**
30797a8e76a3SSteven Rostedt  * ring_buffer_record_enable - enable writes to the buffer
30807a8e76a3SSteven Rostedt  * @buffer: The ring buffer to enable writes
30817a8e76a3SSteven Rostedt  *
30827a8e76a3SSteven Rostedt  * Note, multiple disables will need the same number of enables
3083c41b20e7SAdam Buchbinder  * to truly enable the writing (much like preempt_disable).
30847a8e76a3SSteven Rostedt  */
30857a8e76a3SSteven Rostedt void ring_buffer_record_enable(struct ring_buffer *buffer)
30867a8e76a3SSteven Rostedt {
30877a8e76a3SSteven Rostedt 	atomic_dec(&buffer->record_disabled);
30887a8e76a3SSteven Rostedt }
3089c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
30907a8e76a3SSteven Rostedt 
30917a8e76a3SSteven Rostedt /**
3092499e5470SSteven Rostedt  * ring_buffer_record_off - stop all writes into the buffer
3093499e5470SSteven Rostedt  * @buffer: The ring buffer to stop writes to.
3094499e5470SSteven Rostedt  *
3095499e5470SSteven Rostedt  * This prevents all writes to the buffer. Any attempt to write
3096499e5470SSteven Rostedt  * to the buffer after this will fail and return NULL.
3097499e5470SSteven Rostedt  *
3098499e5470SSteven Rostedt  * This is different than ring_buffer_record_disable() as
309987abb3b1SWang Tianhong  * it works like an on/off switch, where as the disable() version
3100499e5470SSteven Rostedt  * must be paired with a enable().
3101499e5470SSteven Rostedt  */
3102499e5470SSteven Rostedt void ring_buffer_record_off(struct ring_buffer *buffer)
3103499e5470SSteven Rostedt {
3104499e5470SSteven Rostedt 	unsigned int rd;
3105499e5470SSteven Rostedt 	unsigned int new_rd;
3106499e5470SSteven Rostedt 
3107499e5470SSteven Rostedt 	do {
3108499e5470SSteven Rostedt 		rd = atomic_read(&buffer->record_disabled);
3109499e5470SSteven Rostedt 		new_rd = rd | RB_BUFFER_OFF;
3110499e5470SSteven Rostedt 	} while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
3111499e5470SSteven Rostedt }
3112499e5470SSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_record_off);
3113499e5470SSteven Rostedt 
3114499e5470SSteven Rostedt /**
3115499e5470SSteven Rostedt  * ring_buffer_record_on - restart writes into the buffer
3116499e5470SSteven Rostedt  * @buffer: The ring buffer to start writes to.
3117499e5470SSteven Rostedt  *
3118499e5470SSteven Rostedt  * This enables all writes to the buffer that was disabled by
3119499e5470SSteven Rostedt  * ring_buffer_record_off().
3120499e5470SSteven Rostedt  *
3121499e5470SSteven Rostedt  * This is different than ring_buffer_record_enable() as
312287abb3b1SWang Tianhong  * it works like an on/off switch, where as the enable() version
3123499e5470SSteven Rostedt  * must be paired with a disable().
3124499e5470SSteven Rostedt  */
3125499e5470SSteven Rostedt void ring_buffer_record_on(struct ring_buffer *buffer)
3126499e5470SSteven Rostedt {
3127499e5470SSteven Rostedt 	unsigned int rd;
3128499e5470SSteven Rostedt 	unsigned int new_rd;
3129499e5470SSteven Rostedt 
3130499e5470SSteven Rostedt 	do {
3131499e5470SSteven Rostedt 		rd = atomic_read(&buffer->record_disabled);
3132499e5470SSteven Rostedt 		new_rd = rd & ~RB_BUFFER_OFF;
3133499e5470SSteven Rostedt 	} while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
3134499e5470SSteven Rostedt }
3135499e5470SSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_record_on);
3136499e5470SSteven Rostedt 
3137499e5470SSteven Rostedt /**
3138499e5470SSteven Rostedt  * ring_buffer_record_is_on - return true if the ring buffer can write
3139499e5470SSteven Rostedt  * @buffer: The ring buffer to see if write is enabled
3140499e5470SSteven Rostedt  *
3141499e5470SSteven Rostedt  * Returns true if the ring buffer is in a state that it accepts writes.
3142499e5470SSteven Rostedt  */
3143499e5470SSteven Rostedt int ring_buffer_record_is_on(struct ring_buffer *buffer)
3144499e5470SSteven Rostedt {
3145499e5470SSteven Rostedt 	return !atomic_read(&buffer->record_disabled);
3146499e5470SSteven Rostedt }
3147499e5470SSteven Rostedt 
3148499e5470SSteven Rostedt /**
31497a8e76a3SSteven Rostedt  * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
31507a8e76a3SSteven Rostedt  * @buffer: The ring buffer to stop writes to.
31517a8e76a3SSteven Rostedt  * @cpu: The CPU buffer to stop
31527a8e76a3SSteven Rostedt  *
31537a8e76a3SSteven Rostedt  * This prevents all writes to the buffer. Any attempt to write
31547a8e76a3SSteven Rostedt  * to the buffer after this will fail and return NULL.
31557a8e76a3SSteven Rostedt  *
31567a8e76a3SSteven Rostedt  * The caller should call synchronize_sched() after this.
31577a8e76a3SSteven Rostedt  */
31587a8e76a3SSteven Rostedt void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
31597a8e76a3SSteven Rostedt {
31607a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
31617a8e76a3SSteven Rostedt 
31629e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
31638aabee57SSteven Rostedt 		return;
31647a8e76a3SSteven Rostedt 
31657a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
31667a8e76a3SSteven Rostedt 	atomic_inc(&cpu_buffer->record_disabled);
31677a8e76a3SSteven Rostedt }
3168c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
31697a8e76a3SSteven Rostedt 
31707a8e76a3SSteven Rostedt /**
31717a8e76a3SSteven Rostedt  * ring_buffer_record_enable_cpu - enable writes to the buffer
31727a8e76a3SSteven Rostedt  * @buffer: The ring buffer to enable writes
31737a8e76a3SSteven Rostedt  * @cpu: The CPU to enable.
31747a8e76a3SSteven Rostedt  *
31757a8e76a3SSteven Rostedt  * Note, multiple disables will need the same number of enables
3176c41b20e7SAdam Buchbinder  * to truly enable the writing (much like preempt_disable).
31777a8e76a3SSteven Rostedt  */
31787a8e76a3SSteven Rostedt void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
31797a8e76a3SSteven Rostedt {
31807a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
31817a8e76a3SSteven Rostedt 
31829e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
31838aabee57SSteven Rostedt 		return;
31847a8e76a3SSteven Rostedt 
31857a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
31867a8e76a3SSteven Rostedt 	atomic_dec(&cpu_buffer->record_disabled);
31877a8e76a3SSteven Rostedt }
3188c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
31897a8e76a3SSteven Rostedt 
3190f6195aa0SSteven Rostedt /*
3191f6195aa0SSteven Rostedt  * The total entries in the ring buffer is the running counter
3192f6195aa0SSteven Rostedt  * of entries entered into the ring buffer, minus the sum of
3193f6195aa0SSteven Rostedt  * the entries read from the ring buffer and the number of
3194f6195aa0SSteven Rostedt  * entries that were overwritten.
3195f6195aa0SSteven Rostedt  */
3196f6195aa0SSteven Rostedt static inline unsigned long
3197f6195aa0SSteven Rostedt rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
3198f6195aa0SSteven Rostedt {
3199f6195aa0SSteven Rostedt 	return local_read(&cpu_buffer->entries) -
3200f6195aa0SSteven Rostedt 		(local_read(&cpu_buffer->overrun) + cpu_buffer->read);
3201f6195aa0SSteven Rostedt }
3202f6195aa0SSteven Rostedt 
32037a8e76a3SSteven Rostedt /**
3204c64e148aSVaibhav Nagarnaik  * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
3205c64e148aSVaibhav Nagarnaik  * @buffer: The ring buffer
3206c64e148aSVaibhav Nagarnaik  * @cpu: The per CPU buffer to read from.
3207c64e148aSVaibhav Nagarnaik  */
320850ecf2c3SYoshihiro YUNOMAE u64 ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
3209c64e148aSVaibhav Nagarnaik {
3210c64e148aSVaibhav Nagarnaik 	unsigned long flags;
3211c64e148aSVaibhav Nagarnaik 	struct ring_buffer_per_cpu *cpu_buffer;
3212c64e148aSVaibhav Nagarnaik 	struct buffer_page *bpage;
3213da830e58SLinus Torvalds 	u64 ret = 0;
3214c64e148aSVaibhav Nagarnaik 
3215c64e148aSVaibhav Nagarnaik 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3216c64e148aSVaibhav Nagarnaik 		return 0;
3217c64e148aSVaibhav Nagarnaik 
3218c64e148aSVaibhav Nagarnaik 	cpu_buffer = buffer->buffers[cpu];
32197115e3fcSLinus Torvalds 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3220c64e148aSVaibhav Nagarnaik 	/*
3221c64e148aSVaibhav Nagarnaik 	 * if the tail is on reader_page, oldest time stamp is on the reader
3222c64e148aSVaibhav Nagarnaik 	 * page
3223c64e148aSVaibhav Nagarnaik 	 */
3224c64e148aSVaibhav Nagarnaik 	if (cpu_buffer->tail_page == cpu_buffer->reader_page)
3225c64e148aSVaibhav Nagarnaik 		bpage = cpu_buffer->reader_page;
3226c64e148aSVaibhav Nagarnaik 	else
3227c64e148aSVaibhav Nagarnaik 		bpage = rb_set_head_page(cpu_buffer);
322854f7be5bSSteven Rostedt 	if (bpage)
3229c64e148aSVaibhav Nagarnaik 		ret = bpage->page->time_stamp;
32307115e3fcSLinus Torvalds 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
3231c64e148aSVaibhav Nagarnaik 
3232c64e148aSVaibhav Nagarnaik 	return ret;
3233c64e148aSVaibhav Nagarnaik }
3234c64e148aSVaibhav Nagarnaik EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
3235c64e148aSVaibhav Nagarnaik 
3236c64e148aSVaibhav Nagarnaik /**
3237c64e148aSVaibhav Nagarnaik  * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
3238c64e148aSVaibhav Nagarnaik  * @buffer: The ring buffer
3239c64e148aSVaibhav Nagarnaik  * @cpu: The per CPU buffer to read from.
3240c64e148aSVaibhav Nagarnaik  */
3241c64e148aSVaibhav Nagarnaik unsigned long ring_buffer_bytes_cpu(struct ring_buffer *buffer, int cpu)
3242c64e148aSVaibhav Nagarnaik {
3243c64e148aSVaibhav Nagarnaik 	struct ring_buffer_per_cpu *cpu_buffer;
3244c64e148aSVaibhav Nagarnaik 	unsigned long ret;
3245c64e148aSVaibhav Nagarnaik 
3246c64e148aSVaibhav Nagarnaik 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3247c64e148aSVaibhav Nagarnaik 		return 0;
3248c64e148aSVaibhav Nagarnaik 
3249c64e148aSVaibhav Nagarnaik 	cpu_buffer = buffer->buffers[cpu];
3250c64e148aSVaibhav Nagarnaik 	ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
3251c64e148aSVaibhav Nagarnaik 
3252c64e148aSVaibhav Nagarnaik 	return ret;
3253c64e148aSVaibhav Nagarnaik }
3254c64e148aSVaibhav Nagarnaik EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
3255c64e148aSVaibhav Nagarnaik 
3256c64e148aSVaibhav Nagarnaik /**
32577a8e76a3SSteven Rostedt  * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
32587a8e76a3SSteven Rostedt  * @buffer: The ring buffer
32597a8e76a3SSteven Rostedt  * @cpu: The per CPU buffer to get the entries from.
32607a8e76a3SSteven Rostedt  */
32617a8e76a3SSteven Rostedt unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
32627a8e76a3SSteven Rostedt {
32637a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
32647a8e76a3SSteven Rostedt 
32659e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
32668aabee57SSteven Rostedt 		return 0;
32677a8e76a3SSteven Rostedt 
32687a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
3269554f786eSSteven Rostedt 
3270f6195aa0SSteven Rostedt 	return rb_num_of_entries(cpu_buffer);
32717a8e76a3SSteven Rostedt }
3272c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
32737a8e76a3SSteven Rostedt 
32747a8e76a3SSteven Rostedt /**
3275884bfe89SSlava Pestov  * ring_buffer_overrun_cpu - get the number of overruns caused by the ring
3276884bfe89SSlava Pestov  * buffer wrapping around (only if RB_FL_OVERWRITE is on).
32777a8e76a3SSteven Rostedt  * @buffer: The ring buffer
32787a8e76a3SSteven Rostedt  * @cpu: The per CPU buffer to get the number of overruns from
32797a8e76a3SSteven Rostedt  */
32807a8e76a3SSteven Rostedt unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
32817a8e76a3SSteven Rostedt {
32827a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
32838aabee57SSteven Rostedt 	unsigned long ret;
32847a8e76a3SSteven Rostedt 
32859e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
32868aabee57SSteven Rostedt 		return 0;
32877a8e76a3SSteven Rostedt 
32887a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
328977ae365eSSteven Rostedt 	ret = local_read(&cpu_buffer->overrun);
3290554f786eSSteven Rostedt 
3291554f786eSSteven Rostedt 	return ret;
32927a8e76a3SSteven Rostedt }
3293c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
32947a8e76a3SSteven Rostedt 
32957a8e76a3SSteven Rostedt /**
3296884bfe89SSlava Pestov  * ring_buffer_commit_overrun_cpu - get the number of overruns caused by
3297884bfe89SSlava Pestov  * commits failing due to the buffer wrapping around while there are uncommitted
3298884bfe89SSlava Pestov  * events, such as during an interrupt storm.
3299f0d2c681SSteven Rostedt  * @buffer: The ring buffer
3300f0d2c681SSteven Rostedt  * @cpu: The per CPU buffer to get the number of overruns from
3301f0d2c681SSteven Rostedt  */
3302f0d2c681SSteven Rostedt unsigned long
3303f0d2c681SSteven Rostedt ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
3304f0d2c681SSteven Rostedt {
3305f0d2c681SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
3306f0d2c681SSteven Rostedt 	unsigned long ret;
3307f0d2c681SSteven Rostedt 
3308f0d2c681SSteven Rostedt 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3309f0d2c681SSteven Rostedt 		return 0;
3310f0d2c681SSteven Rostedt 
3311f0d2c681SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
331277ae365eSSteven Rostedt 	ret = local_read(&cpu_buffer->commit_overrun);
3313f0d2c681SSteven Rostedt 
3314f0d2c681SSteven Rostedt 	return ret;
3315f0d2c681SSteven Rostedt }
3316f0d2c681SSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
3317f0d2c681SSteven Rostedt 
3318f0d2c681SSteven Rostedt /**
3319884bfe89SSlava Pestov  * ring_buffer_dropped_events_cpu - get the number of dropped events caused by
3320884bfe89SSlava Pestov  * the ring buffer filling up (only if RB_FL_OVERWRITE is off).
3321884bfe89SSlava Pestov  * @buffer: The ring buffer
3322884bfe89SSlava Pestov  * @cpu: The per CPU buffer to get the number of overruns from
3323884bfe89SSlava Pestov  */
3324884bfe89SSlava Pestov unsigned long
3325884bfe89SSlava Pestov ring_buffer_dropped_events_cpu(struct ring_buffer *buffer, int cpu)
3326884bfe89SSlava Pestov {
3327884bfe89SSlava Pestov 	struct ring_buffer_per_cpu *cpu_buffer;
3328884bfe89SSlava Pestov 	unsigned long ret;
3329884bfe89SSlava Pestov 
3330884bfe89SSlava Pestov 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3331884bfe89SSlava Pestov 		return 0;
3332884bfe89SSlava Pestov 
3333884bfe89SSlava Pestov 	cpu_buffer = buffer->buffers[cpu];
3334884bfe89SSlava Pestov 	ret = local_read(&cpu_buffer->dropped_events);
3335884bfe89SSlava Pestov 
3336884bfe89SSlava Pestov 	return ret;
3337884bfe89SSlava Pestov }
3338884bfe89SSlava Pestov EXPORT_SYMBOL_GPL(ring_buffer_dropped_events_cpu);
3339884bfe89SSlava Pestov 
3340884bfe89SSlava Pestov /**
3341ad964704SSteven Rostedt (Red Hat)  * ring_buffer_read_events_cpu - get the number of events successfully read
3342ad964704SSteven Rostedt (Red Hat)  * @buffer: The ring buffer
3343ad964704SSteven Rostedt (Red Hat)  * @cpu: The per CPU buffer to get the number of events read
3344ad964704SSteven Rostedt (Red Hat)  */
3345ad964704SSteven Rostedt (Red Hat) unsigned long
3346ad964704SSteven Rostedt (Red Hat) ring_buffer_read_events_cpu(struct ring_buffer *buffer, int cpu)
3347ad964704SSteven Rostedt (Red Hat) {
3348ad964704SSteven Rostedt (Red Hat) 	struct ring_buffer_per_cpu *cpu_buffer;
3349ad964704SSteven Rostedt (Red Hat) 
3350ad964704SSteven Rostedt (Red Hat) 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3351ad964704SSteven Rostedt (Red Hat) 		return 0;
3352ad964704SSteven Rostedt (Red Hat) 
3353ad964704SSteven Rostedt (Red Hat) 	cpu_buffer = buffer->buffers[cpu];
3354ad964704SSteven Rostedt (Red Hat) 	return cpu_buffer->read;
3355ad964704SSteven Rostedt (Red Hat) }
3356ad964704SSteven Rostedt (Red Hat) EXPORT_SYMBOL_GPL(ring_buffer_read_events_cpu);
3357ad964704SSteven Rostedt (Red Hat) 
3358ad964704SSteven Rostedt (Red Hat) /**
33597a8e76a3SSteven Rostedt  * ring_buffer_entries - get the number of entries in a buffer
33607a8e76a3SSteven Rostedt  * @buffer: The ring buffer
33617a8e76a3SSteven Rostedt  *
33627a8e76a3SSteven Rostedt  * Returns the total number of entries in the ring buffer
33637a8e76a3SSteven Rostedt  * (all CPU entries)
33647a8e76a3SSteven Rostedt  */
33657a8e76a3SSteven Rostedt unsigned long ring_buffer_entries(struct ring_buffer *buffer)
33667a8e76a3SSteven Rostedt {
33677a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
33687a8e76a3SSteven Rostedt 	unsigned long entries = 0;
33697a8e76a3SSteven Rostedt 	int cpu;
33707a8e76a3SSteven Rostedt 
33717a8e76a3SSteven Rostedt 	/* if you care about this being correct, lock the buffer */
33727a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu) {
33737a8e76a3SSteven Rostedt 		cpu_buffer = buffer->buffers[cpu];
3374f6195aa0SSteven Rostedt 		entries += rb_num_of_entries(cpu_buffer);
33757a8e76a3SSteven Rostedt 	}
33767a8e76a3SSteven Rostedt 
33777a8e76a3SSteven Rostedt 	return entries;
33787a8e76a3SSteven Rostedt }
3379c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_entries);
33807a8e76a3SSteven Rostedt 
33817a8e76a3SSteven Rostedt /**
338267b394f7SJiri Olsa  * ring_buffer_overruns - get the number of overruns in buffer
33837a8e76a3SSteven Rostedt  * @buffer: The ring buffer
33847a8e76a3SSteven Rostedt  *
33857a8e76a3SSteven Rostedt  * Returns the total number of overruns in the ring buffer
33867a8e76a3SSteven Rostedt  * (all CPU entries)
33877a8e76a3SSteven Rostedt  */
33887a8e76a3SSteven Rostedt unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
33897a8e76a3SSteven Rostedt {
33907a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
33917a8e76a3SSteven Rostedt 	unsigned long overruns = 0;
33927a8e76a3SSteven Rostedt 	int cpu;
33937a8e76a3SSteven Rostedt 
33947a8e76a3SSteven Rostedt 	/* if you care about this being correct, lock the buffer */
33957a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu) {
33967a8e76a3SSteven Rostedt 		cpu_buffer = buffer->buffers[cpu];
339777ae365eSSteven Rostedt 		overruns += local_read(&cpu_buffer->overrun);
33987a8e76a3SSteven Rostedt 	}
33997a8e76a3SSteven Rostedt 
34007a8e76a3SSteven Rostedt 	return overruns;
34017a8e76a3SSteven Rostedt }
3402c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_overruns);
34037a8e76a3SSteven Rostedt 
3404642edba5SSteven Rostedt static void rb_iter_reset(struct ring_buffer_iter *iter)
34057a8e76a3SSteven Rostedt {
34067a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
34077a8e76a3SSteven Rostedt 
3408d769041fSSteven Rostedt 	/* Iterator usage is expected to have record disabled */
3409d769041fSSteven Rostedt 	iter->head_page = cpu_buffer->reader_page;
34106f807acdSSteven Rostedt 	iter->head = cpu_buffer->reader_page->read;
3411651e22f2SSteven Rostedt (Red Hat) 
3412651e22f2SSteven Rostedt (Red Hat) 	iter->cache_reader_page = iter->head_page;
341324607f11SSteven Rostedt (Red Hat) 	iter->cache_read = cpu_buffer->read;
3414651e22f2SSteven Rostedt (Red Hat) 
3415d769041fSSteven Rostedt 	if (iter->head)
3416d769041fSSteven Rostedt 		iter->read_stamp = cpu_buffer->read_stamp;
3417d769041fSSteven Rostedt 	else
3418abc9b56dSSteven Rostedt 		iter->read_stamp = iter->head_page->page->time_stamp;
3419642edba5SSteven Rostedt }
3420f83c9d0fSSteven Rostedt 
3421642edba5SSteven Rostedt /**
3422642edba5SSteven Rostedt  * ring_buffer_iter_reset - reset an iterator
3423642edba5SSteven Rostedt  * @iter: The iterator to reset
3424642edba5SSteven Rostedt  *
3425642edba5SSteven Rostedt  * Resets the iterator, so that it will start from the beginning
3426642edba5SSteven Rostedt  * again.
3427642edba5SSteven Rostedt  */
3428642edba5SSteven Rostedt void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
3429642edba5SSteven Rostedt {
3430554f786eSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
3431642edba5SSteven Rostedt 	unsigned long flags;
3432642edba5SSteven Rostedt 
3433554f786eSSteven Rostedt 	if (!iter)
3434554f786eSSteven Rostedt 		return;
3435554f786eSSteven Rostedt 
3436554f786eSSteven Rostedt 	cpu_buffer = iter->cpu_buffer;
3437554f786eSSteven Rostedt 
34385389f6faSThomas Gleixner 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3439642edba5SSteven Rostedt 	rb_iter_reset(iter);
34405389f6faSThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
34417a8e76a3SSteven Rostedt }
3442c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
34437a8e76a3SSteven Rostedt 
34447a8e76a3SSteven Rostedt /**
34457a8e76a3SSteven Rostedt  * ring_buffer_iter_empty - check if an iterator has no more to read
34467a8e76a3SSteven Rostedt  * @iter: The iterator to check
34477a8e76a3SSteven Rostedt  */
34487a8e76a3SSteven Rostedt int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
34497a8e76a3SSteven Rostedt {
34507a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
34517a8e76a3SSteven Rostedt 
34527a8e76a3SSteven Rostedt 	cpu_buffer = iter->cpu_buffer;
34537a8e76a3SSteven Rostedt 
3454bf41a158SSteven Rostedt 	return iter->head_page == cpu_buffer->commit_page &&
3455bf41a158SSteven Rostedt 		iter->head == rb_commit_index(cpu_buffer);
34567a8e76a3SSteven Rostedt }
3457c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
34587a8e76a3SSteven Rostedt 
34597a8e76a3SSteven Rostedt static void
34607a8e76a3SSteven Rostedt rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
34617a8e76a3SSteven Rostedt 		     struct ring_buffer_event *event)
34627a8e76a3SSteven Rostedt {
34637a8e76a3SSteven Rostedt 	u64 delta;
34647a8e76a3SSteven Rostedt 
3465334d4169SLai Jiangshan 	switch (event->type_len) {
34667a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_PADDING:
34677a8e76a3SSteven Rostedt 		return;
34687a8e76a3SSteven Rostedt 
34697a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_EXTEND:
34707a8e76a3SSteven Rostedt 		delta = event->array[0];
34717a8e76a3SSteven Rostedt 		delta <<= TS_SHIFT;
34727a8e76a3SSteven Rostedt 		delta += event->time_delta;
34737a8e76a3SSteven Rostedt 		cpu_buffer->read_stamp += delta;
34747a8e76a3SSteven Rostedt 		return;
34757a8e76a3SSteven Rostedt 
34767a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_STAMP:
34777a8e76a3SSteven Rostedt 		/* FIXME: not implemented */
34787a8e76a3SSteven Rostedt 		return;
34797a8e76a3SSteven Rostedt 
34807a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_DATA:
34817a8e76a3SSteven Rostedt 		cpu_buffer->read_stamp += event->time_delta;
34827a8e76a3SSteven Rostedt 		return;
34837a8e76a3SSteven Rostedt 
34847a8e76a3SSteven Rostedt 	default:
34857a8e76a3SSteven Rostedt 		BUG();
34867a8e76a3SSteven Rostedt 	}
34877a8e76a3SSteven Rostedt 	return;
34887a8e76a3SSteven Rostedt }
34897a8e76a3SSteven Rostedt 
34907a8e76a3SSteven Rostedt static void
34917a8e76a3SSteven Rostedt rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
34927a8e76a3SSteven Rostedt 			  struct ring_buffer_event *event)
34937a8e76a3SSteven Rostedt {
34947a8e76a3SSteven Rostedt 	u64 delta;
34957a8e76a3SSteven Rostedt 
3496334d4169SLai Jiangshan 	switch (event->type_len) {
34977a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_PADDING:
34987a8e76a3SSteven Rostedt 		return;
34997a8e76a3SSteven Rostedt 
35007a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_EXTEND:
35017a8e76a3SSteven Rostedt 		delta = event->array[0];
35027a8e76a3SSteven Rostedt 		delta <<= TS_SHIFT;
35037a8e76a3SSteven Rostedt 		delta += event->time_delta;
35047a8e76a3SSteven Rostedt 		iter->read_stamp += delta;
35057a8e76a3SSteven Rostedt 		return;
35067a8e76a3SSteven Rostedt 
35077a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_STAMP:
35087a8e76a3SSteven Rostedt 		/* FIXME: not implemented */
35097a8e76a3SSteven Rostedt 		return;
35107a8e76a3SSteven Rostedt 
35117a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_DATA:
35127a8e76a3SSteven Rostedt 		iter->read_stamp += event->time_delta;
35137a8e76a3SSteven Rostedt 		return;
35147a8e76a3SSteven Rostedt 
35157a8e76a3SSteven Rostedt 	default:
35167a8e76a3SSteven Rostedt 		BUG();
35177a8e76a3SSteven Rostedt 	}
35187a8e76a3SSteven Rostedt 	return;
35197a8e76a3SSteven Rostedt }
35207a8e76a3SSteven Rostedt 
3521d769041fSSteven Rostedt static struct buffer_page *
3522d769041fSSteven Rostedt rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
35237a8e76a3SSteven Rostedt {
3524d769041fSSteven Rostedt 	struct buffer_page *reader = NULL;
352566a8cb95SSteven Rostedt 	unsigned long overwrite;
3526d769041fSSteven Rostedt 	unsigned long flags;
3527818e3dd3SSteven Rostedt 	int nr_loops = 0;
352877ae365eSSteven Rostedt 	int ret;
3529d769041fSSteven Rostedt 
35303e03fb7fSSteven Rostedt 	local_irq_save(flags);
35310199c4e6SThomas Gleixner 	arch_spin_lock(&cpu_buffer->lock);
3532d769041fSSteven Rostedt 
3533d769041fSSteven Rostedt  again:
3534818e3dd3SSteven Rostedt 	/*
3535818e3dd3SSteven Rostedt 	 * This should normally only loop twice. But because the
3536818e3dd3SSteven Rostedt 	 * start of the reader inserts an empty page, it causes
3537818e3dd3SSteven Rostedt 	 * a case where we will loop three times. There should be no
3538818e3dd3SSteven Rostedt 	 * reason to loop four times (that I know of).
3539818e3dd3SSteven Rostedt 	 */
35403e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
3541818e3dd3SSteven Rostedt 		reader = NULL;
3542818e3dd3SSteven Rostedt 		goto out;
3543818e3dd3SSteven Rostedt 	}
3544818e3dd3SSteven Rostedt 
3545d769041fSSteven Rostedt 	reader = cpu_buffer->reader_page;
3546d769041fSSteven Rostedt 
3547d769041fSSteven Rostedt 	/* If there's more to read, return this page */
3548bf41a158SSteven Rostedt 	if (cpu_buffer->reader_page->read < rb_page_size(reader))
3549d769041fSSteven Rostedt 		goto out;
3550d769041fSSteven Rostedt 
3551d769041fSSteven Rostedt 	/* Never should we have an index greater than the size */
35523e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer,
35533e89c7bbSSteven Rostedt 		       cpu_buffer->reader_page->read > rb_page_size(reader)))
35543e89c7bbSSteven Rostedt 		goto out;
3555d769041fSSteven Rostedt 
3556d769041fSSteven Rostedt 	/* check if we caught up to the tail */
3557d769041fSSteven Rostedt 	reader = NULL;
3558bf41a158SSteven Rostedt 	if (cpu_buffer->commit_page == cpu_buffer->reader_page)
3559d769041fSSteven Rostedt 		goto out;
35607a8e76a3SSteven Rostedt 
3561a5fb8331SSteven Rostedt 	/* Don't bother swapping if the ring buffer is empty */
3562a5fb8331SSteven Rostedt 	if (rb_num_of_entries(cpu_buffer) == 0)
3563a5fb8331SSteven Rostedt 		goto out;
3564a5fb8331SSteven Rostedt 
35657a8e76a3SSteven Rostedt 	/*
3566d769041fSSteven Rostedt 	 * Reset the reader page to size zero.
35677a8e76a3SSteven Rostedt 	 */
356877ae365eSSteven Rostedt 	local_set(&cpu_buffer->reader_page->write, 0);
356977ae365eSSteven Rostedt 	local_set(&cpu_buffer->reader_page->entries, 0);
357077ae365eSSteven Rostedt 	local_set(&cpu_buffer->reader_page->page->commit, 0);
3571ff0ff84aSSteven Rostedt 	cpu_buffer->reader_page->real_end = 0;
3572d769041fSSteven Rostedt 
357377ae365eSSteven Rostedt  spin:
357477ae365eSSteven Rostedt 	/*
357577ae365eSSteven Rostedt 	 * Splice the empty reader page into the list around the head.
357677ae365eSSteven Rostedt 	 */
357777ae365eSSteven Rostedt 	reader = rb_set_head_page(cpu_buffer);
357854f7be5bSSteven Rostedt 	if (!reader)
357954f7be5bSSteven Rostedt 		goto out;
35800e1ff5d7SSteven Rostedt 	cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
3581d769041fSSteven Rostedt 	cpu_buffer->reader_page->list.prev = reader->list.prev;
3582bf41a158SSteven Rostedt 
35833adc54faSSteven Rostedt 	/*
35843adc54faSSteven Rostedt 	 * cpu_buffer->pages just needs to point to the buffer, it
35853adc54faSSteven Rostedt 	 *  has no specific buffer page to point to. Lets move it out
358625985edcSLucas De Marchi 	 *  of our way so we don't accidentally swap it.
35873adc54faSSteven Rostedt 	 */
35883adc54faSSteven Rostedt 	cpu_buffer->pages = reader->list.prev;
35893adc54faSSteven Rostedt 
359077ae365eSSteven Rostedt 	/* The reader page will be pointing to the new head */
359177ae365eSSteven Rostedt 	rb_set_list_to_head(cpu_buffer, &cpu_buffer->reader_page->list);
3592d769041fSSteven Rostedt 
3593d769041fSSteven Rostedt 	/*
359466a8cb95SSteven Rostedt 	 * We want to make sure we read the overruns after we set up our
359566a8cb95SSteven Rostedt 	 * pointers to the next object. The writer side does a
359666a8cb95SSteven Rostedt 	 * cmpxchg to cross pages which acts as the mb on the writer
359766a8cb95SSteven Rostedt 	 * side. Note, the reader will constantly fail the swap
359866a8cb95SSteven Rostedt 	 * while the writer is updating the pointers, so this
359966a8cb95SSteven Rostedt 	 * guarantees that the overwrite recorded here is the one we
360066a8cb95SSteven Rostedt 	 * want to compare with the last_overrun.
360166a8cb95SSteven Rostedt 	 */
360266a8cb95SSteven Rostedt 	smp_mb();
360366a8cb95SSteven Rostedt 	overwrite = local_read(&(cpu_buffer->overrun));
360466a8cb95SSteven Rostedt 
360566a8cb95SSteven Rostedt 	/*
360677ae365eSSteven Rostedt 	 * Here's the tricky part.
360777ae365eSSteven Rostedt 	 *
360877ae365eSSteven Rostedt 	 * We need to move the pointer past the header page.
360977ae365eSSteven Rostedt 	 * But we can only do that if a writer is not currently
361077ae365eSSteven Rostedt 	 * moving it. The page before the header page has the
361177ae365eSSteven Rostedt 	 * flag bit '1' set if it is pointing to the page we want.
361277ae365eSSteven Rostedt 	 * but if the writer is in the process of moving it
361377ae365eSSteven Rostedt 	 * than it will be '2' or already moved '0'.
3614d769041fSSteven Rostedt 	 */
3615d769041fSSteven Rostedt 
361677ae365eSSteven Rostedt 	ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
361777ae365eSSteven Rostedt 
361877ae365eSSteven Rostedt 	/*
361977ae365eSSteven Rostedt 	 * If we did not convert it, then we must try again.
362077ae365eSSteven Rostedt 	 */
362177ae365eSSteven Rostedt 	if (!ret)
362277ae365eSSteven Rostedt 		goto spin;
362377ae365eSSteven Rostedt 
362477ae365eSSteven Rostedt 	/*
362577ae365eSSteven Rostedt 	 * Yeah! We succeeded in replacing the page.
362677ae365eSSteven Rostedt 	 *
362777ae365eSSteven Rostedt 	 * Now make the new head point back to the reader page.
362877ae365eSSteven Rostedt 	 */
36295ded3dc6SDavid Sharp 	rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
36307a8e76a3SSteven Rostedt 	rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
3631d769041fSSteven Rostedt 
3632d769041fSSteven Rostedt 	/* Finally update the reader page to the new head */
3633d769041fSSteven Rostedt 	cpu_buffer->reader_page = reader;
3634d769041fSSteven Rostedt 	rb_reset_reader_page(cpu_buffer);
3635d769041fSSteven Rostedt 
363666a8cb95SSteven Rostedt 	if (overwrite != cpu_buffer->last_overrun) {
363766a8cb95SSteven Rostedt 		cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
363866a8cb95SSteven Rostedt 		cpu_buffer->last_overrun = overwrite;
363966a8cb95SSteven Rostedt 	}
364066a8cb95SSteven Rostedt 
3641d769041fSSteven Rostedt 	goto again;
3642d769041fSSteven Rostedt 
3643d769041fSSteven Rostedt  out:
36440199c4e6SThomas Gleixner 	arch_spin_unlock(&cpu_buffer->lock);
36453e03fb7fSSteven Rostedt 	local_irq_restore(flags);
3646d769041fSSteven Rostedt 
3647d769041fSSteven Rostedt 	return reader;
36487a8e76a3SSteven Rostedt }
36497a8e76a3SSteven Rostedt 
3650d769041fSSteven Rostedt static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
3651d769041fSSteven Rostedt {
3652d769041fSSteven Rostedt 	struct ring_buffer_event *event;
3653d769041fSSteven Rostedt 	struct buffer_page *reader;
3654d769041fSSteven Rostedt 	unsigned length;
3655d769041fSSteven Rostedt 
3656d769041fSSteven Rostedt 	reader = rb_get_reader_page(cpu_buffer);
3657d769041fSSteven Rostedt 
3658d769041fSSteven Rostedt 	/* This function should not be called when buffer is empty */
36593e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, !reader))
36603e89c7bbSSteven Rostedt 		return;
3661d769041fSSteven Rostedt 
3662d769041fSSteven Rostedt 	event = rb_reader_event(cpu_buffer);
36637a8e76a3SSteven Rostedt 
3664a1863c21SSteven Rostedt 	if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
3665e4906effSSteven Rostedt 		cpu_buffer->read++;
36667a8e76a3SSteven Rostedt 
36677a8e76a3SSteven Rostedt 	rb_update_read_stamp(cpu_buffer, event);
36687a8e76a3SSteven Rostedt 
3669d769041fSSteven Rostedt 	length = rb_event_length(event);
36706f807acdSSteven Rostedt 	cpu_buffer->reader_page->read += length;
36717a8e76a3SSteven Rostedt }
36727a8e76a3SSteven Rostedt 
36737a8e76a3SSteven Rostedt static void rb_advance_iter(struct ring_buffer_iter *iter)
36747a8e76a3SSteven Rostedt {
36757a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
36767a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
36777a8e76a3SSteven Rostedt 	unsigned length;
36787a8e76a3SSteven Rostedt 
36797a8e76a3SSteven Rostedt 	cpu_buffer = iter->cpu_buffer;
36807a8e76a3SSteven Rostedt 
36817a8e76a3SSteven Rostedt 	/*
36827a8e76a3SSteven Rostedt 	 * Check if we are at the end of the buffer.
36837a8e76a3SSteven Rostedt 	 */
3684bf41a158SSteven Rostedt 	if (iter->head >= rb_page_size(iter->head_page)) {
3685ea05b57cSSteven Rostedt 		/* discarded commits can make the page empty */
3686ea05b57cSSteven Rostedt 		if (iter->head_page == cpu_buffer->commit_page)
36873e89c7bbSSteven Rostedt 			return;
3688d769041fSSteven Rostedt 		rb_inc_iter(iter);
36897a8e76a3SSteven Rostedt 		return;
36907a8e76a3SSteven Rostedt 	}
36917a8e76a3SSteven Rostedt 
36927a8e76a3SSteven Rostedt 	event = rb_iter_head_event(iter);
36937a8e76a3SSteven Rostedt 
36947a8e76a3SSteven Rostedt 	length = rb_event_length(event);
36957a8e76a3SSteven Rostedt 
36967a8e76a3SSteven Rostedt 	/*
36977a8e76a3SSteven Rostedt 	 * This should not be called to advance the header if we are
36987a8e76a3SSteven Rostedt 	 * at the tail of the buffer.
36997a8e76a3SSteven Rostedt 	 */
37003e89c7bbSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer,
3701f536aafcSSteven Rostedt 		       (iter->head_page == cpu_buffer->commit_page) &&
37023e89c7bbSSteven Rostedt 		       (iter->head + length > rb_commit_index(cpu_buffer))))
37033e89c7bbSSteven Rostedt 		return;
37047a8e76a3SSteven Rostedt 
37057a8e76a3SSteven Rostedt 	rb_update_iter_read_stamp(iter, event);
37067a8e76a3SSteven Rostedt 
37077a8e76a3SSteven Rostedt 	iter->head += length;
37087a8e76a3SSteven Rostedt 
37097a8e76a3SSteven Rostedt 	/* check for end of page padding */
3710bf41a158SSteven Rostedt 	if ((iter->head >= rb_page_size(iter->head_page)) &&
3711bf41a158SSteven Rostedt 	    (iter->head_page != cpu_buffer->commit_page))
3712771e0384SSteven Rostedt 		rb_inc_iter(iter);
37137a8e76a3SSteven Rostedt }
37147a8e76a3SSteven Rostedt 
371566a8cb95SSteven Rostedt static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
371666a8cb95SSteven Rostedt {
371766a8cb95SSteven Rostedt 	return cpu_buffer->lost_events;
371866a8cb95SSteven Rostedt }
371966a8cb95SSteven Rostedt 
3720f83c9d0fSSteven Rostedt static struct ring_buffer_event *
372166a8cb95SSteven Rostedt rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
372266a8cb95SSteven Rostedt 	       unsigned long *lost_events)
37237a8e76a3SSteven Rostedt {
37247a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
3725d769041fSSteven Rostedt 	struct buffer_page *reader;
3726818e3dd3SSteven Rostedt 	int nr_loops = 0;
37277a8e76a3SSteven Rostedt 
37287a8e76a3SSteven Rostedt  again:
3729818e3dd3SSteven Rostedt 	/*
373069d1b839SSteven Rostedt 	 * We repeat when a time extend is encountered.
373169d1b839SSteven Rostedt 	 * Since the time extend is always attached to a data event,
373269d1b839SSteven Rostedt 	 * we should never loop more than once.
373369d1b839SSteven Rostedt 	 * (We never hit the following condition more than twice).
3734818e3dd3SSteven Rostedt 	 */
373569d1b839SSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
3736818e3dd3SSteven Rostedt 		return NULL;
3737818e3dd3SSteven Rostedt 
3738d769041fSSteven Rostedt 	reader = rb_get_reader_page(cpu_buffer);
3739d769041fSSteven Rostedt 	if (!reader)
37407a8e76a3SSteven Rostedt 		return NULL;
37417a8e76a3SSteven Rostedt 
3742d769041fSSteven Rostedt 	event = rb_reader_event(cpu_buffer);
37437a8e76a3SSteven Rostedt 
3744334d4169SLai Jiangshan 	switch (event->type_len) {
37457a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_PADDING:
37462d622719STom Zanussi 		if (rb_null_event(event))
3747bf41a158SSteven Rostedt 			RB_WARN_ON(cpu_buffer, 1);
37482d622719STom Zanussi 		/*
37492d622719STom Zanussi 		 * Because the writer could be discarding every
37502d622719STom Zanussi 		 * event it creates (which would probably be bad)
37512d622719STom Zanussi 		 * if we were to go back to "again" then we may never
37522d622719STom Zanussi 		 * catch up, and will trigger the warn on, or lock
37532d622719STom Zanussi 		 * the box. Return the padding, and we will release
37542d622719STom Zanussi 		 * the current locks, and try again.
37552d622719STom Zanussi 		 */
37562d622719STom Zanussi 		return event;
37577a8e76a3SSteven Rostedt 
37587a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_EXTEND:
37597a8e76a3SSteven Rostedt 		/* Internal data, OK to advance */
3760d769041fSSteven Rostedt 		rb_advance_reader(cpu_buffer);
37617a8e76a3SSteven Rostedt 		goto again;
37627a8e76a3SSteven Rostedt 
37637a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_STAMP:
37647a8e76a3SSteven Rostedt 		/* FIXME: not implemented */
3765d769041fSSteven Rostedt 		rb_advance_reader(cpu_buffer);
37667a8e76a3SSteven Rostedt 		goto again;
37677a8e76a3SSteven Rostedt 
37687a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_DATA:
37697a8e76a3SSteven Rostedt 		if (ts) {
37707a8e76a3SSteven Rostedt 			*ts = cpu_buffer->read_stamp + event->time_delta;
3771d8eeb2d3SRobert Richter 			ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
377237886f6aSSteven Rostedt 							 cpu_buffer->cpu, ts);
37737a8e76a3SSteven Rostedt 		}
377466a8cb95SSteven Rostedt 		if (lost_events)
377566a8cb95SSteven Rostedt 			*lost_events = rb_lost_events(cpu_buffer);
37767a8e76a3SSteven Rostedt 		return event;
37777a8e76a3SSteven Rostedt 
37787a8e76a3SSteven Rostedt 	default:
37797a8e76a3SSteven Rostedt 		BUG();
37807a8e76a3SSteven Rostedt 	}
37817a8e76a3SSteven Rostedt 
37827a8e76a3SSteven Rostedt 	return NULL;
37837a8e76a3SSteven Rostedt }
3784c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_peek);
37857a8e76a3SSteven Rostedt 
3786f83c9d0fSSteven Rostedt static struct ring_buffer_event *
3787f83c9d0fSSteven Rostedt rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
37887a8e76a3SSteven Rostedt {
37897a8e76a3SSteven Rostedt 	struct ring_buffer *buffer;
37907a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
37917a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
3792818e3dd3SSteven Rostedt 	int nr_loops = 0;
37937a8e76a3SSteven Rostedt 
37947a8e76a3SSteven Rostedt 	cpu_buffer = iter->cpu_buffer;
37957a8e76a3SSteven Rostedt 	buffer = cpu_buffer->buffer;
37967a8e76a3SSteven Rostedt 
3797492a74f4SSteven Rostedt 	/*
3798492a74f4SSteven Rostedt 	 * Check if someone performed a consuming read to
3799492a74f4SSteven Rostedt 	 * the buffer. A consuming read invalidates the iterator
3800492a74f4SSteven Rostedt 	 * and we need to reset the iterator in this case.
3801492a74f4SSteven Rostedt 	 */
3802492a74f4SSteven Rostedt 	if (unlikely(iter->cache_read != cpu_buffer->read ||
3803492a74f4SSteven Rostedt 		     iter->cache_reader_page != cpu_buffer->reader_page))
3804492a74f4SSteven Rostedt 		rb_iter_reset(iter);
3805492a74f4SSteven Rostedt 
38067a8e76a3SSteven Rostedt  again:
38073c05d748SSteven Rostedt 	if (ring_buffer_iter_empty(iter))
38083c05d748SSteven Rostedt 		return NULL;
38093c05d748SSteven Rostedt 
3810818e3dd3SSteven Rostedt 	/*
3811021de3d9SSteven Rostedt (Red Hat) 	 * We repeat when a time extend is encountered or we hit
3812021de3d9SSteven Rostedt (Red Hat) 	 * the end of the page. Since the time extend is always attached
3813021de3d9SSteven Rostedt (Red Hat) 	 * to a data event, we should never loop more than three times.
3814021de3d9SSteven Rostedt (Red Hat) 	 * Once for going to next page, once on time extend, and
3815021de3d9SSteven Rostedt (Red Hat) 	 * finally once to get the event.
3816021de3d9SSteven Rostedt (Red Hat) 	 * (We never hit the following condition more than thrice).
3817818e3dd3SSteven Rostedt 	 */
3818021de3d9SSteven Rostedt (Red Hat) 	if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3))
3819818e3dd3SSteven Rostedt 		return NULL;
3820818e3dd3SSteven Rostedt 
38217a8e76a3SSteven Rostedt 	if (rb_per_cpu_empty(cpu_buffer))
38227a8e76a3SSteven Rostedt 		return NULL;
38237a8e76a3SSteven Rostedt 
382410e83fd0SSteven Rostedt (Red Hat) 	if (iter->head >= rb_page_size(iter->head_page)) {
38253c05d748SSteven Rostedt 		rb_inc_iter(iter);
38263c05d748SSteven Rostedt 		goto again;
38273c05d748SSteven Rostedt 	}
38283c05d748SSteven Rostedt 
38297a8e76a3SSteven Rostedt 	event = rb_iter_head_event(iter);
38307a8e76a3SSteven Rostedt 
3831334d4169SLai Jiangshan 	switch (event->type_len) {
38327a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_PADDING:
38332d622719STom Zanussi 		if (rb_null_event(event)) {
3834d769041fSSteven Rostedt 			rb_inc_iter(iter);
38357a8e76a3SSteven Rostedt 			goto again;
38362d622719STom Zanussi 		}
38372d622719STom Zanussi 		rb_advance_iter(iter);
38382d622719STom Zanussi 		return event;
38397a8e76a3SSteven Rostedt 
38407a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_EXTEND:
38417a8e76a3SSteven Rostedt 		/* Internal data, OK to advance */
38427a8e76a3SSteven Rostedt 		rb_advance_iter(iter);
38437a8e76a3SSteven Rostedt 		goto again;
38447a8e76a3SSteven Rostedt 
38457a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_TIME_STAMP:
38467a8e76a3SSteven Rostedt 		/* FIXME: not implemented */
38477a8e76a3SSteven Rostedt 		rb_advance_iter(iter);
38487a8e76a3SSteven Rostedt 		goto again;
38497a8e76a3SSteven Rostedt 
38507a8e76a3SSteven Rostedt 	case RINGBUF_TYPE_DATA:
38517a8e76a3SSteven Rostedt 		if (ts) {
38527a8e76a3SSteven Rostedt 			*ts = iter->read_stamp + event->time_delta;
385337886f6aSSteven Rostedt 			ring_buffer_normalize_time_stamp(buffer,
385437886f6aSSteven Rostedt 							 cpu_buffer->cpu, ts);
38557a8e76a3SSteven Rostedt 		}
38567a8e76a3SSteven Rostedt 		return event;
38577a8e76a3SSteven Rostedt 
38587a8e76a3SSteven Rostedt 	default:
38597a8e76a3SSteven Rostedt 		BUG();
38607a8e76a3SSteven Rostedt 	}
38617a8e76a3SSteven Rostedt 
38627a8e76a3SSteven Rostedt 	return NULL;
38637a8e76a3SSteven Rostedt }
3864c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
38657a8e76a3SSteven Rostedt 
38668d707e8eSSteven Rostedt static inline int rb_ok_to_lock(void)
38678d707e8eSSteven Rostedt {
38688d707e8eSSteven Rostedt 	/*
38698d707e8eSSteven Rostedt 	 * If an NMI die dumps out the content of the ring buffer
38708d707e8eSSteven Rostedt 	 * do not grab locks. We also permanently disable the ring
38718d707e8eSSteven Rostedt 	 * buffer too. A one time deal is all you get from reading
38728d707e8eSSteven Rostedt 	 * the ring buffer from an NMI.
38738d707e8eSSteven Rostedt 	 */
3874464e85ebSSteven Rostedt 	if (likely(!in_nmi()))
38758d707e8eSSteven Rostedt 		return 1;
38768d707e8eSSteven Rostedt 
38778d707e8eSSteven Rostedt 	tracing_off_permanent();
38788d707e8eSSteven Rostedt 	return 0;
38798d707e8eSSteven Rostedt }
38808d707e8eSSteven Rostedt 
38817a8e76a3SSteven Rostedt /**
3882f83c9d0fSSteven Rostedt  * ring_buffer_peek - peek at the next event to be read
3883f83c9d0fSSteven Rostedt  * @buffer: The ring buffer to read
3884f83c9d0fSSteven Rostedt  * @cpu: The cpu to peak at
3885f83c9d0fSSteven Rostedt  * @ts: The timestamp counter of this event.
388666a8cb95SSteven Rostedt  * @lost_events: a variable to store if events were lost (may be NULL)
3887f83c9d0fSSteven Rostedt  *
3888f83c9d0fSSteven Rostedt  * This will return the event that will be read next, but does
3889f83c9d0fSSteven Rostedt  * not consume the data.
3890f83c9d0fSSteven Rostedt  */
3891f83c9d0fSSteven Rostedt struct ring_buffer_event *
389266a8cb95SSteven Rostedt ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts,
389366a8cb95SSteven Rostedt 		 unsigned long *lost_events)
3894f83c9d0fSSteven Rostedt {
3895f83c9d0fSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
38968aabee57SSteven Rostedt 	struct ring_buffer_event *event;
3897f83c9d0fSSteven Rostedt 	unsigned long flags;
38988d707e8eSSteven Rostedt 	int dolock;
3899f83c9d0fSSteven Rostedt 
3900554f786eSSteven Rostedt 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
39018aabee57SSteven Rostedt 		return NULL;
3902554f786eSSteven Rostedt 
39038d707e8eSSteven Rostedt 	dolock = rb_ok_to_lock();
39042d622719STom Zanussi  again:
39058d707e8eSSteven Rostedt 	local_irq_save(flags);
39068d707e8eSSteven Rostedt 	if (dolock)
39075389f6faSThomas Gleixner 		raw_spin_lock(&cpu_buffer->reader_lock);
390866a8cb95SSteven Rostedt 	event = rb_buffer_peek(cpu_buffer, ts, lost_events);
3909469535a5SRobert Richter 	if (event && event->type_len == RINGBUF_TYPE_PADDING)
3910469535a5SRobert Richter 		rb_advance_reader(cpu_buffer);
39118d707e8eSSteven Rostedt 	if (dolock)
39125389f6faSThomas Gleixner 		raw_spin_unlock(&cpu_buffer->reader_lock);
39138d707e8eSSteven Rostedt 	local_irq_restore(flags);
3914f83c9d0fSSteven Rostedt 
39151b959e18SSteven Rostedt 	if (event && event->type_len == RINGBUF_TYPE_PADDING)
39162d622719STom Zanussi 		goto again;
39172d622719STom Zanussi 
3918f83c9d0fSSteven Rostedt 	return event;
3919f83c9d0fSSteven Rostedt }
3920f83c9d0fSSteven Rostedt 
3921f83c9d0fSSteven Rostedt /**
3922f83c9d0fSSteven Rostedt  * ring_buffer_iter_peek - peek at the next event to be read
3923f83c9d0fSSteven Rostedt  * @iter: The ring buffer iterator
3924f83c9d0fSSteven Rostedt  * @ts: The timestamp counter of this event.
3925f83c9d0fSSteven Rostedt  *
3926f83c9d0fSSteven Rostedt  * This will return the event that will be read next, but does
3927f83c9d0fSSteven Rostedt  * not increment the iterator.
3928f83c9d0fSSteven Rostedt  */
3929f83c9d0fSSteven Rostedt struct ring_buffer_event *
3930f83c9d0fSSteven Rostedt ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
3931f83c9d0fSSteven Rostedt {
3932f83c9d0fSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3933f83c9d0fSSteven Rostedt 	struct ring_buffer_event *event;
3934f83c9d0fSSteven Rostedt 	unsigned long flags;
3935f83c9d0fSSteven Rostedt 
39362d622719STom Zanussi  again:
39375389f6faSThomas Gleixner 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3938f83c9d0fSSteven Rostedt 	event = rb_iter_peek(iter, ts);
39395389f6faSThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
3940f83c9d0fSSteven Rostedt 
39411b959e18SSteven Rostedt 	if (event && event->type_len == RINGBUF_TYPE_PADDING)
39422d622719STom Zanussi 		goto again;
39432d622719STom Zanussi 
3944f83c9d0fSSteven Rostedt 	return event;
3945f83c9d0fSSteven Rostedt }
3946f83c9d0fSSteven Rostedt 
3947f83c9d0fSSteven Rostedt /**
39487a8e76a3SSteven Rostedt  * ring_buffer_consume - return an event and consume it
39497a8e76a3SSteven Rostedt  * @buffer: The ring buffer to get the next event from
395066a8cb95SSteven Rostedt  * @cpu: the cpu to read the buffer from
395166a8cb95SSteven Rostedt  * @ts: a variable to store the timestamp (may be NULL)
395266a8cb95SSteven Rostedt  * @lost_events: a variable to store if events were lost (may be NULL)
39537a8e76a3SSteven Rostedt  *
39547a8e76a3SSteven Rostedt  * Returns the next event in the ring buffer, and that event is consumed.
39557a8e76a3SSteven Rostedt  * Meaning, that sequential reads will keep returning a different event,
39567a8e76a3SSteven Rostedt  * and eventually empty the ring buffer if the producer is slower.
39577a8e76a3SSteven Rostedt  */
39587a8e76a3SSteven Rostedt struct ring_buffer_event *
395966a8cb95SSteven Rostedt ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts,
396066a8cb95SSteven Rostedt 		    unsigned long *lost_events)
39617a8e76a3SSteven Rostedt {
3962554f786eSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
3963554f786eSSteven Rostedt 	struct ring_buffer_event *event = NULL;
3964f83c9d0fSSteven Rostedt 	unsigned long flags;
39658d707e8eSSteven Rostedt 	int dolock;
39668d707e8eSSteven Rostedt 
39678d707e8eSSteven Rostedt 	dolock = rb_ok_to_lock();
39687a8e76a3SSteven Rostedt 
39692d622719STom Zanussi  again:
3970554f786eSSteven Rostedt 	/* might be called in atomic */
3971554f786eSSteven Rostedt 	preempt_disable();
39727a8e76a3SSteven Rostedt 
3973554f786eSSteven Rostedt 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
3974554f786eSSteven Rostedt 		goto out;
3975554f786eSSteven Rostedt 
3976554f786eSSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
39778d707e8eSSteven Rostedt 	local_irq_save(flags);
39788d707e8eSSteven Rostedt 	if (dolock)
39795389f6faSThomas Gleixner 		raw_spin_lock(&cpu_buffer->reader_lock);
39807a8e76a3SSteven Rostedt 
398166a8cb95SSteven Rostedt 	event = rb_buffer_peek(cpu_buffer, ts, lost_events);
398266a8cb95SSteven Rostedt 	if (event) {
398366a8cb95SSteven Rostedt 		cpu_buffer->lost_events = 0;
3984d769041fSSteven Rostedt 		rb_advance_reader(cpu_buffer);
398566a8cb95SSteven Rostedt 	}
39867a8e76a3SSteven Rostedt 
39878d707e8eSSteven Rostedt 	if (dolock)
39885389f6faSThomas Gleixner 		raw_spin_unlock(&cpu_buffer->reader_lock);
39898d707e8eSSteven Rostedt 	local_irq_restore(flags);
3990f83c9d0fSSteven Rostedt 
3991554f786eSSteven Rostedt  out:
3992554f786eSSteven Rostedt 	preempt_enable();
3993554f786eSSteven Rostedt 
39941b959e18SSteven Rostedt 	if (event && event->type_len == RINGBUF_TYPE_PADDING)
39952d622719STom Zanussi 		goto again;
39962d622719STom Zanussi 
39977a8e76a3SSteven Rostedt 	return event;
39987a8e76a3SSteven Rostedt }
3999c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_consume);
40007a8e76a3SSteven Rostedt 
40017a8e76a3SSteven Rostedt /**
400272c9ddfdSDavid Miller  * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
40037a8e76a3SSteven Rostedt  * @buffer: The ring buffer to read from
40047a8e76a3SSteven Rostedt  * @cpu: The cpu buffer to iterate over
40057a8e76a3SSteven Rostedt  *
400672c9ddfdSDavid Miller  * This performs the initial preparations necessary to iterate
400772c9ddfdSDavid Miller  * through the buffer.  Memory is allocated, buffer recording
400872c9ddfdSDavid Miller  * is disabled, and the iterator pointer is returned to the caller.
40097a8e76a3SSteven Rostedt  *
401072c9ddfdSDavid Miller  * Disabling buffer recordng prevents the reading from being
401172c9ddfdSDavid Miller  * corrupted. This is not a consuming read, so a producer is not
401272c9ddfdSDavid Miller  * expected.
401372c9ddfdSDavid Miller  *
401472c9ddfdSDavid Miller  * After a sequence of ring_buffer_read_prepare calls, the user is
4015d611851bSzhangwei(Jovi)  * expected to make at least one call to ring_buffer_read_prepare_sync.
401672c9ddfdSDavid Miller  * Afterwards, ring_buffer_read_start is invoked to get things going
401772c9ddfdSDavid Miller  * for real.
401872c9ddfdSDavid Miller  *
4019d611851bSzhangwei(Jovi)  * This overall must be paired with ring_buffer_read_finish.
40207a8e76a3SSteven Rostedt  */
40217a8e76a3SSteven Rostedt struct ring_buffer_iter *
402272c9ddfdSDavid Miller ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
40237a8e76a3SSteven Rostedt {
40247a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
40258aabee57SSteven Rostedt 	struct ring_buffer_iter *iter;
40267a8e76a3SSteven Rostedt 
40279e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
40288aabee57SSteven Rostedt 		return NULL;
40297a8e76a3SSteven Rostedt 
40307a8e76a3SSteven Rostedt 	iter = kmalloc(sizeof(*iter), GFP_KERNEL);
40317a8e76a3SSteven Rostedt 	if (!iter)
40328aabee57SSteven Rostedt 		return NULL;
40337a8e76a3SSteven Rostedt 
40347a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
40357a8e76a3SSteven Rostedt 
40367a8e76a3SSteven Rostedt 	iter->cpu_buffer = cpu_buffer;
40377a8e76a3SSteven Rostedt 
403883f40318SVaibhav Nagarnaik 	atomic_inc(&buffer->resize_disabled);
40397a8e76a3SSteven Rostedt 	atomic_inc(&cpu_buffer->record_disabled);
404072c9ddfdSDavid Miller 
404172c9ddfdSDavid Miller 	return iter;
404272c9ddfdSDavid Miller }
404372c9ddfdSDavid Miller EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);
404472c9ddfdSDavid Miller 
404572c9ddfdSDavid Miller /**
404672c9ddfdSDavid Miller  * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
404772c9ddfdSDavid Miller  *
404872c9ddfdSDavid Miller  * All previously invoked ring_buffer_read_prepare calls to prepare
404972c9ddfdSDavid Miller  * iterators will be synchronized.  Afterwards, read_buffer_read_start
405072c9ddfdSDavid Miller  * calls on those iterators are allowed.
405172c9ddfdSDavid Miller  */
405272c9ddfdSDavid Miller void
405372c9ddfdSDavid Miller ring_buffer_read_prepare_sync(void)
405472c9ddfdSDavid Miller {
40557a8e76a3SSteven Rostedt 	synchronize_sched();
405672c9ddfdSDavid Miller }
405772c9ddfdSDavid Miller EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
405872c9ddfdSDavid Miller 
405972c9ddfdSDavid Miller /**
406072c9ddfdSDavid Miller  * ring_buffer_read_start - start a non consuming read of the buffer
406172c9ddfdSDavid Miller  * @iter: The iterator returned by ring_buffer_read_prepare
406272c9ddfdSDavid Miller  *
406372c9ddfdSDavid Miller  * This finalizes the startup of an iteration through the buffer.
406472c9ddfdSDavid Miller  * The iterator comes from a call to ring_buffer_read_prepare and
406572c9ddfdSDavid Miller  * an intervening ring_buffer_read_prepare_sync must have been
406672c9ddfdSDavid Miller  * performed.
406772c9ddfdSDavid Miller  *
4068d611851bSzhangwei(Jovi)  * Must be paired with ring_buffer_read_finish.
406972c9ddfdSDavid Miller  */
407072c9ddfdSDavid Miller void
407172c9ddfdSDavid Miller ring_buffer_read_start(struct ring_buffer_iter *iter)
407272c9ddfdSDavid Miller {
407372c9ddfdSDavid Miller 	struct ring_buffer_per_cpu *cpu_buffer;
407472c9ddfdSDavid Miller 	unsigned long flags;
407572c9ddfdSDavid Miller 
407672c9ddfdSDavid Miller 	if (!iter)
407772c9ddfdSDavid Miller 		return;
407872c9ddfdSDavid Miller 
407972c9ddfdSDavid Miller 	cpu_buffer = iter->cpu_buffer;
40807a8e76a3SSteven Rostedt 
40815389f6faSThomas Gleixner 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
40820199c4e6SThomas Gleixner 	arch_spin_lock(&cpu_buffer->lock);
4083642edba5SSteven Rostedt 	rb_iter_reset(iter);
40840199c4e6SThomas Gleixner 	arch_spin_unlock(&cpu_buffer->lock);
40855389f6faSThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
40867a8e76a3SSteven Rostedt }
4087c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_read_start);
40887a8e76a3SSteven Rostedt 
40897a8e76a3SSteven Rostedt /**
4090d611851bSzhangwei(Jovi)  * ring_buffer_read_finish - finish reading the iterator of the buffer
40917a8e76a3SSteven Rostedt  * @iter: The iterator retrieved by ring_buffer_start
40927a8e76a3SSteven Rostedt  *
40937a8e76a3SSteven Rostedt  * This re-enables the recording to the buffer, and frees the
40947a8e76a3SSteven Rostedt  * iterator.
40957a8e76a3SSteven Rostedt  */
40967a8e76a3SSteven Rostedt void
40977a8e76a3SSteven Rostedt ring_buffer_read_finish(struct ring_buffer_iter *iter)
40987a8e76a3SSteven Rostedt {
40997a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
41009366c1baSSteven Rostedt 	unsigned long flags;
41017a8e76a3SSteven Rostedt 
4102659f451fSSteven Rostedt 	/*
4103659f451fSSteven Rostedt 	 * Ring buffer is disabled from recording, here's a good place
4104659f451fSSteven Rostedt 	 * to check the integrity of the ring buffer.
41059366c1baSSteven Rostedt 	 * Must prevent readers from trying to read, as the check
41069366c1baSSteven Rostedt 	 * clears the HEAD page and readers require it.
4107659f451fSSteven Rostedt 	 */
41089366c1baSSteven Rostedt 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4109659f451fSSteven Rostedt 	rb_check_pages(cpu_buffer);
41109366c1baSSteven Rostedt 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
4111659f451fSSteven Rostedt 
41127a8e76a3SSteven Rostedt 	atomic_dec(&cpu_buffer->record_disabled);
411383f40318SVaibhav Nagarnaik 	atomic_dec(&cpu_buffer->buffer->resize_disabled);
41147a8e76a3SSteven Rostedt 	kfree(iter);
41157a8e76a3SSteven Rostedt }
4116c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
41177a8e76a3SSteven Rostedt 
41187a8e76a3SSteven Rostedt /**
41197a8e76a3SSteven Rostedt  * ring_buffer_read - read the next item in the ring buffer by the iterator
41207a8e76a3SSteven Rostedt  * @iter: The ring buffer iterator
41217a8e76a3SSteven Rostedt  * @ts: The time stamp of the event read.
41227a8e76a3SSteven Rostedt  *
41237a8e76a3SSteven Rostedt  * This reads the next event in the ring buffer and increments the iterator.
41247a8e76a3SSteven Rostedt  */
41257a8e76a3SSteven Rostedt struct ring_buffer_event *
41267a8e76a3SSteven Rostedt ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
41277a8e76a3SSteven Rostedt {
41287a8e76a3SSteven Rostedt 	struct ring_buffer_event *event;
4129f83c9d0fSSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
4130f83c9d0fSSteven Rostedt 	unsigned long flags;
41317a8e76a3SSteven Rostedt 
41325389f6faSThomas Gleixner 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
41337e9391cfSSteven Rostedt  again:
4134f83c9d0fSSteven Rostedt 	event = rb_iter_peek(iter, ts);
41357a8e76a3SSteven Rostedt 	if (!event)
4136f83c9d0fSSteven Rostedt 		goto out;
41377a8e76a3SSteven Rostedt 
41387e9391cfSSteven Rostedt 	if (event->type_len == RINGBUF_TYPE_PADDING)
41397e9391cfSSteven Rostedt 		goto again;
41407e9391cfSSteven Rostedt 
41417a8e76a3SSteven Rostedt 	rb_advance_iter(iter);
4142f83c9d0fSSteven Rostedt  out:
41435389f6faSThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
41447a8e76a3SSteven Rostedt 
41457a8e76a3SSteven Rostedt 	return event;
41467a8e76a3SSteven Rostedt }
4147c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_read);
41487a8e76a3SSteven Rostedt 
41497a8e76a3SSteven Rostedt /**
41507a8e76a3SSteven Rostedt  * ring_buffer_size - return the size of the ring buffer (in bytes)
41517a8e76a3SSteven Rostedt  * @buffer: The ring buffer.
41527a8e76a3SSteven Rostedt  */
4153438ced17SVaibhav Nagarnaik unsigned long ring_buffer_size(struct ring_buffer *buffer, int cpu)
41547a8e76a3SSteven Rostedt {
4155438ced17SVaibhav Nagarnaik 	/*
4156438ced17SVaibhav Nagarnaik 	 * Earlier, this method returned
4157438ced17SVaibhav Nagarnaik 	 *	BUF_PAGE_SIZE * buffer->nr_pages
4158438ced17SVaibhav Nagarnaik 	 * Since the nr_pages field is now removed, we have converted this to
4159438ced17SVaibhav Nagarnaik 	 * return the per cpu buffer value.
4160438ced17SVaibhav Nagarnaik 	 */
4161438ced17SVaibhav Nagarnaik 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
4162438ced17SVaibhav Nagarnaik 		return 0;
4163438ced17SVaibhav Nagarnaik 
4164438ced17SVaibhav Nagarnaik 	return BUF_PAGE_SIZE * buffer->buffers[cpu]->nr_pages;
41657a8e76a3SSteven Rostedt }
4166c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_size);
41677a8e76a3SSteven Rostedt 
41687a8e76a3SSteven Rostedt static void
41697a8e76a3SSteven Rostedt rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
41707a8e76a3SSteven Rostedt {
417177ae365eSSteven Rostedt 	rb_head_page_deactivate(cpu_buffer);
417277ae365eSSteven Rostedt 
41737a8e76a3SSteven Rostedt 	cpu_buffer->head_page
41743adc54faSSteven Rostedt 		= list_entry(cpu_buffer->pages, struct buffer_page, list);
4175bf41a158SSteven Rostedt 	local_set(&cpu_buffer->head_page->write, 0);
4176778c55d4SSteven Rostedt 	local_set(&cpu_buffer->head_page->entries, 0);
4177abc9b56dSSteven Rostedt 	local_set(&cpu_buffer->head_page->page->commit, 0);
41787a8e76a3SSteven Rostedt 
41796f807acdSSteven Rostedt 	cpu_buffer->head_page->read = 0;
4180bf41a158SSteven Rostedt 
4181bf41a158SSteven Rostedt 	cpu_buffer->tail_page = cpu_buffer->head_page;
4182bf41a158SSteven Rostedt 	cpu_buffer->commit_page = cpu_buffer->head_page;
4183bf41a158SSteven Rostedt 
4184bf41a158SSteven Rostedt 	INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
41855040b4b7SVaibhav Nagarnaik 	INIT_LIST_HEAD(&cpu_buffer->new_pages);
4186bf41a158SSteven Rostedt 	local_set(&cpu_buffer->reader_page->write, 0);
4187778c55d4SSteven Rostedt 	local_set(&cpu_buffer->reader_page->entries, 0);
4188abc9b56dSSteven Rostedt 	local_set(&cpu_buffer->reader_page->page->commit, 0);
41896f807acdSSteven Rostedt 	cpu_buffer->reader_page->read = 0;
4190d769041fSSteven Rostedt 
4191c64e148aSVaibhav Nagarnaik 	local_set(&cpu_buffer->entries_bytes, 0);
419277ae365eSSteven Rostedt 	local_set(&cpu_buffer->overrun, 0);
4193884bfe89SSlava Pestov 	local_set(&cpu_buffer->commit_overrun, 0);
4194884bfe89SSlava Pestov 	local_set(&cpu_buffer->dropped_events, 0);
4195e4906effSSteven Rostedt 	local_set(&cpu_buffer->entries, 0);
4196fa743953SSteven Rostedt 	local_set(&cpu_buffer->committing, 0);
4197fa743953SSteven Rostedt 	local_set(&cpu_buffer->commits, 0);
419877ae365eSSteven Rostedt 	cpu_buffer->read = 0;
4199c64e148aSVaibhav Nagarnaik 	cpu_buffer->read_bytes = 0;
420069507c06SSteven Rostedt 
420169507c06SSteven Rostedt 	cpu_buffer->write_stamp = 0;
420269507c06SSteven Rostedt 	cpu_buffer->read_stamp = 0;
420377ae365eSSteven Rostedt 
420466a8cb95SSteven Rostedt 	cpu_buffer->lost_events = 0;
420566a8cb95SSteven Rostedt 	cpu_buffer->last_overrun = 0;
420666a8cb95SSteven Rostedt 
420777ae365eSSteven Rostedt 	rb_head_page_activate(cpu_buffer);
42087a8e76a3SSteven Rostedt }
42097a8e76a3SSteven Rostedt 
42107a8e76a3SSteven Rostedt /**
42117a8e76a3SSteven Rostedt  * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
42127a8e76a3SSteven Rostedt  * @buffer: The ring buffer to reset a per cpu buffer of
42137a8e76a3SSteven Rostedt  * @cpu: The CPU buffer to be reset
42147a8e76a3SSteven Rostedt  */
42157a8e76a3SSteven Rostedt void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
42167a8e76a3SSteven Rostedt {
42177a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
42187a8e76a3SSteven Rostedt 	unsigned long flags;
42197a8e76a3SSteven Rostedt 
42209e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
42218aabee57SSteven Rostedt 		return;
42227a8e76a3SSteven Rostedt 
422383f40318SVaibhav Nagarnaik 	atomic_inc(&buffer->resize_disabled);
422441ede23eSSteven Rostedt 	atomic_inc(&cpu_buffer->record_disabled);
422541ede23eSSteven Rostedt 
422683f40318SVaibhav Nagarnaik 	/* Make sure all commits have finished */
422783f40318SVaibhav Nagarnaik 	synchronize_sched();
422883f40318SVaibhav Nagarnaik 
42295389f6faSThomas Gleixner 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4230f83c9d0fSSteven Rostedt 
423141b6a95dSSteven Rostedt 	if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
423241b6a95dSSteven Rostedt 		goto out;
423341b6a95dSSteven Rostedt 
42340199c4e6SThomas Gleixner 	arch_spin_lock(&cpu_buffer->lock);
42357a8e76a3SSteven Rostedt 
42367a8e76a3SSteven Rostedt 	rb_reset_cpu(cpu_buffer);
42377a8e76a3SSteven Rostedt 
42380199c4e6SThomas Gleixner 	arch_spin_unlock(&cpu_buffer->lock);
4239f83c9d0fSSteven Rostedt 
424041b6a95dSSteven Rostedt  out:
42415389f6faSThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
424241ede23eSSteven Rostedt 
424341ede23eSSteven Rostedt 	atomic_dec(&cpu_buffer->record_disabled);
424483f40318SVaibhav Nagarnaik 	atomic_dec(&buffer->resize_disabled);
42457a8e76a3SSteven Rostedt }
4246c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
42477a8e76a3SSteven Rostedt 
42487a8e76a3SSteven Rostedt /**
42497a8e76a3SSteven Rostedt  * ring_buffer_reset - reset a ring buffer
42507a8e76a3SSteven Rostedt  * @buffer: The ring buffer to reset all cpu buffers
42517a8e76a3SSteven Rostedt  */
42527a8e76a3SSteven Rostedt void ring_buffer_reset(struct ring_buffer *buffer)
42537a8e76a3SSteven Rostedt {
42547a8e76a3SSteven Rostedt 	int cpu;
42557a8e76a3SSteven Rostedt 
42567a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu)
4257d769041fSSteven Rostedt 		ring_buffer_reset_cpu(buffer, cpu);
42587a8e76a3SSteven Rostedt }
4259c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_reset);
42607a8e76a3SSteven Rostedt 
42617a8e76a3SSteven Rostedt /**
42627a8e76a3SSteven Rostedt  * rind_buffer_empty - is the ring buffer empty?
42637a8e76a3SSteven Rostedt  * @buffer: The ring buffer to test
42647a8e76a3SSteven Rostedt  */
42657a8e76a3SSteven Rostedt int ring_buffer_empty(struct ring_buffer *buffer)
42667a8e76a3SSteven Rostedt {
42677a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
4268d4788207SSteven Rostedt 	unsigned long flags;
42698d707e8eSSteven Rostedt 	int dolock;
42707a8e76a3SSteven Rostedt 	int cpu;
4271d4788207SSteven Rostedt 	int ret;
42727a8e76a3SSteven Rostedt 
42738d707e8eSSteven Rostedt 	dolock = rb_ok_to_lock();
42747a8e76a3SSteven Rostedt 
42757a8e76a3SSteven Rostedt 	/* yes this is racy, but if you don't like the race, lock the buffer */
42767a8e76a3SSteven Rostedt 	for_each_buffer_cpu(buffer, cpu) {
42777a8e76a3SSteven Rostedt 		cpu_buffer = buffer->buffers[cpu];
42788d707e8eSSteven Rostedt 		local_irq_save(flags);
42798d707e8eSSteven Rostedt 		if (dolock)
42805389f6faSThomas Gleixner 			raw_spin_lock(&cpu_buffer->reader_lock);
4281d4788207SSteven Rostedt 		ret = rb_per_cpu_empty(cpu_buffer);
42828d707e8eSSteven Rostedt 		if (dolock)
42835389f6faSThomas Gleixner 			raw_spin_unlock(&cpu_buffer->reader_lock);
42848d707e8eSSteven Rostedt 		local_irq_restore(flags);
42858d707e8eSSteven Rostedt 
4286d4788207SSteven Rostedt 		if (!ret)
42877a8e76a3SSteven Rostedt 			return 0;
42887a8e76a3SSteven Rostedt 	}
4289554f786eSSteven Rostedt 
42907a8e76a3SSteven Rostedt 	return 1;
42917a8e76a3SSteven Rostedt }
4292c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_empty);
42937a8e76a3SSteven Rostedt 
42947a8e76a3SSteven Rostedt /**
42957a8e76a3SSteven Rostedt  * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
42967a8e76a3SSteven Rostedt  * @buffer: The ring buffer
42977a8e76a3SSteven Rostedt  * @cpu: The CPU buffer to test
42987a8e76a3SSteven Rostedt  */
42997a8e76a3SSteven Rostedt int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
43007a8e76a3SSteven Rostedt {
43017a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer;
4302d4788207SSteven Rostedt 	unsigned long flags;
43038d707e8eSSteven Rostedt 	int dolock;
43048aabee57SSteven Rostedt 	int ret;
43057a8e76a3SSteven Rostedt 
43069e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
43078aabee57SSteven Rostedt 		return 1;
43087a8e76a3SSteven Rostedt 
43098d707e8eSSteven Rostedt 	dolock = rb_ok_to_lock();
4310554f786eSSteven Rostedt 
43117a8e76a3SSteven Rostedt 	cpu_buffer = buffer->buffers[cpu];
43128d707e8eSSteven Rostedt 	local_irq_save(flags);
43138d707e8eSSteven Rostedt 	if (dolock)
43145389f6faSThomas Gleixner 		raw_spin_lock(&cpu_buffer->reader_lock);
4315554f786eSSteven Rostedt 	ret = rb_per_cpu_empty(cpu_buffer);
43168d707e8eSSteven Rostedt 	if (dolock)
43175389f6faSThomas Gleixner 		raw_spin_unlock(&cpu_buffer->reader_lock);
43188d707e8eSSteven Rostedt 	local_irq_restore(flags);
4319554f786eSSteven Rostedt 
4320554f786eSSteven Rostedt 	return ret;
43217a8e76a3SSteven Rostedt }
4322c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
43237a8e76a3SSteven Rostedt 
432485bac32cSSteven Rostedt #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
43257a8e76a3SSteven Rostedt /**
43267a8e76a3SSteven Rostedt  * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
43277a8e76a3SSteven Rostedt  * @buffer_a: One buffer to swap with
43287a8e76a3SSteven Rostedt  * @buffer_b: The other buffer to swap with
43297a8e76a3SSteven Rostedt  *
43307a8e76a3SSteven Rostedt  * This function is useful for tracers that want to take a "snapshot"
43317a8e76a3SSteven Rostedt  * of a CPU buffer and has another back up buffer lying around.
43327a8e76a3SSteven Rostedt  * it is expected that the tracer handles the cpu buffer not being
43337a8e76a3SSteven Rostedt  * used at the moment.
43347a8e76a3SSteven Rostedt  */
43357a8e76a3SSteven Rostedt int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
43367a8e76a3SSteven Rostedt 			 struct ring_buffer *buffer_b, int cpu)
43377a8e76a3SSteven Rostedt {
43387a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer_a;
43397a8e76a3SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer_b;
4340554f786eSSteven Rostedt 	int ret = -EINVAL;
4341554f786eSSteven Rostedt 
43429e01c1b7SRusty Russell 	if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
43439e01c1b7SRusty Russell 	    !cpumask_test_cpu(cpu, buffer_b->cpumask))
4344554f786eSSteven Rostedt 		goto out;
43457a8e76a3SSteven Rostedt 
4346438ced17SVaibhav Nagarnaik 	cpu_buffer_a = buffer_a->buffers[cpu];
4347438ced17SVaibhav Nagarnaik 	cpu_buffer_b = buffer_b->buffers[cpu];
4348438ced17SVaibhav Nagarnaik 
43497a8e76a3SSteven Rostedt 	/* At least make sure the two buffers are somewhat the same */
4350438ced17SVaibhav Nagarnaik 	if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages)
4351554f786eSSteven Rostedt 		goto out;
4352554f786eSSteven Rostedt 
4353554f786eSSteven Rostedt 	ret = -EAGAIN;
43547a8e76a3SSteven Rostedt 
435597b17efeSSteven Rostedt 	if (ring_buffer_flags != RB_BUFFERS_ON)
4356554f786eSSteven Rostedt 		goto out;
435797b17efeSSteven Rostedt 
435897b17efeSSteven Rostedt 	if (atomic_read(&buffer_a->record_disabled))
4359554f786eSSteven Rostedt 		goto out;
436097b17efeSSteven Rostedt 
436197b17efeSSteven Rostedt 	if (atomic_read(&buffer_b->record_disabled))
4362554f786eSSteven Rostedt 		goto out;
436397b17efeSSteven Rostedt 
436497b17efeSSteven Rostedt 	if (atomic_read(&cpu_buffer_a->record_disabled))
4365554f786eSSteven Rostedt 		goto out;
436697b17efeSSteven Rostedt 
436797b17efeSSteven Rostedt 	if (atomic_read(&cpu_buffer_b->record_disabled))
4368554f786eSSteven Rostedt 		goto out;
436997b17efeSSteven Rostedt 
43707a8e76a3SSteven Rostedt 	/*
43717a8e76a3SSteven Rostedt 	 * We can't do a synchronize_sched here because this
43727a8e76a3SSteven Rostedt 	 * function can be called in atomic context.
43737a8e76a3SSteven Rostedt 	 * Normally this will be called from the same CPU as cpu.
43747a8e76a3SSteven Rostedt 	 * If not it's up to the caller to protect this.
43757a8e76a3SSteven Rostedt 	 */
43767a8e76a3SSteven Rostedt 	atomic_inc(&cpu_buffer_a->record_disabled);
43777a8e76a3SSteven Rostedt 	atomic_inc(&cpu_buffer_b->record_disabled);
43787a8e76a3SSteven Rostedt 
437998277991SSteven Rostedt 	ret = -EBUSY;
438098277991SSteven Rostedt 	if (local_read(&cpu_buffer_a->committing))
438198277991SSteven Rostedt 		goto out_dec;
438298277991SSteven Rostedt 	if (local_read(&cpu_buffer_b->committing))
438398277991SSteven Rostedt 		goto out_dec;
438498277991SSteven Rostedt 
43857a8e76a3SSteven Rostedt 	buffer_a->buffers[cpu] = cpu_buffer_b;
43867a8e76a3SSteven Rostedt 	buffer_b->buffers[cpu] = cpu_buffer_a;
43877a8e76a3SSteven Rostedt 
43887a8e76a3SSteven Rostedt 	cpu_buffer_b->buffer = buffer_a;
43897a8e76a3SSteven Rostedt 	cpu_buffer_a->buffer = buffer_b;
43907a8e76a3SSteven Rostedt 
439198277991SSteven Rostedt 	ret = 0;
439298277991SSteven Rostedt 
439398277991SSteven Rostedt out_dec:
43947a8e76a3SSteven Rostedt 	atomic_dec(&cpu_buffer_a->record_disabled);
43957a8e76a3SSteven Rostedt 	atomic_dec(&cpu_buffer_b->record_disabled);
4396554f786eSSteven Rostedt out:
4397554f786eSSteven Rostedt 	return ret;
43987a8e76a3SSteven Rostedt }
4399c4f50183SRobert Richter EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
440085bac32cSSteven Rostedt #endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
44017a8e76a3SSteven Rostedt 
44028789a9e7SSteven Rostedt /**
44038789a9e7SSteven Rostedt  * ring_buffer_alloc_read_page - allocate a page to read from buffer
44048789a9e7SSteven Rostedt  * @buffer: the buffer to allocate for.
4405d611851bSzhangwei(Jovi)  * @cpu: the cpu buffer to allocate.
44068789a9e7SSteven Rostedt  *
44078789a9e7SSteven Rostedt  * This function is used in conjunction with ring_buffer_read_page.
44088789a9e7SSteven Rostedt  * When reading a full page from the ring buffer, these functions
44098789a9e7SSteven Rostedt  * can be used to speed up the process. The calling function should
44108789a9e7SSteven Rostedt  * allocate a few pages first with this function. Then when it
44118789a9e7SSteven Rostedt  * needs to get pages from the ring buffer, it passes the result
44128789a9e7SSteven Rostedt  * of this function into ring_buffer_read_page, which will swap
44138789a9e7SSteven Rostedt  * the page that was allocated, with the read page of the buffer.
44148789a9e7SSteven Rostedt  *
44158789a9e7SSteven Rostedt  * Returns:
44168789a9e7SSteven Rostedt  *  The page allocated, or NULL on error.
44178789a9e7SSteven Rostedt  */
44187ea59064SVaibhav Nagarnaik void *ring_buffer_alloc_read_page(struct ring_buffer *buffer, int cpu)
44198789a9e7SSteven Rostedt {
4420044fa782SSteven Rostedt 	struct buffer_data_page *bpage;
44217ea59064SVaibhav Nagarnaik 	struct page *page;
44228789a9e7SSteven Rostedt 
4423d7ec4bfeSVaibhav Nagarnaik 	page = alloc_pages_node(cpu_to_node(cpu),
4424d7ec4bfeSVaibhav Nagarnaik 				GFP_KERNEL | __GFP_NORETRY, 0);
44257ea59064SVaibhav Nagarnaik 	if (!page)
44268789a9e7SSteven Rostedt 		return NULL;
44278789a9e7SSteven Rostedt 
44287ea59064SVaibhav Nagarnaik 	bpage = page_address(page);
44298789a9e7SSteven Rostedt 
4430ef7a4a16SSteven Rostedt 	rb_init_page(bpage);
4431ef7a4a16SSteven Rostedt 
4432044fa782SSteven Rostedt 	return bpage;
44338789a9e7SSteven Rostedt }
4434d6ce96daSSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
44358789a9e7SSteven Rostedt 
44368789a9e7SSteven Rostedt /**
44378789a9e7SSteven Rostedt  * ring_buffer_free_read_page - free an allocated read page
44388789a9e7SSteven Rostedt  * @buffer: the buffer the page was allocate for
44398789a9e7SSteven Rostedt  * @data: the page to free
44408789a9e7SSteven Rostedt  *
44418789a9e7SSteven Rostedt  * Free a page allocated from ring_buffer_alloc_read_page.
44428789a9e7SSteven Rostedt  */
44438789a9e7SSteven Rostedt void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
44448789a9e7SSteven Rostedt {
44458789a9e7SSteven Rostedt 	free_page((unsigned long)data);
44468789a9e7SSteven Rostedt }
4447d6ce96daSSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
44488789a9e7SSteven Rostedt 
44498789a9e7SSteven Rostedt /**
44508789a9e7SSteven Rostedt  * ring_buffer_read_page - extract a page from the ring buffer
44518789a9e7SSteven Rostedt  * @buffer: buffer to extract from
44528789a9e7SSteven Rostedt  * @data_page: the page to use allocated from ring_buffer_alloc_read_page
4453ef7a4a16SSteven Rostedt  * @len: amount to extract
44548789a9e7SSteven Rostedt  * @cpu: the cpu of the buffer to extract
44558789a9e7SSteven Rostedt  * @full: should the extraction only happen when the page is full.
44568789a9e7SSteven Rostedt  *
44578789a9e7SSteven Rostedt  * This function will pull out a page from the ring buffer and consume it.
44588789a9e7SSteven Rostedt  * @data_page must be the address of the variable that was returned
44598789a9e7SSteven Rostedt  * from ring_buffer_alloc_read_page. This is because the page might be used
44608789a9e7SSteven Rostedt  * to swap with a page in the ring buffer.
44618789a9e7SSteven Rostedt  *
44628789a9e7SSteven Rostedt  * for example:
4463d611851bSzhangwei(Jovi)  *	rpage = ring_buffer_alloc_read_page(buffer, cpu);
44648789a9e7SSteven Rostedt  *	if (!rpage)
44658789a9e7SSteven Rostedt  *		return error;
4466ef7a4a16SSteven Rostedt  *	ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
4467667d2412SLai Jiangshan  *	if (ret >= 0)
4468667d2412SLai Jiangshan  *		process_page(rpage, ret);
44698789a9e7SSteven Rostedt  *
44708789a9e7SSteven Rostedt  * When @full is set, the function will not return true unless
44718789a9e7SSteven Rostedt  * the writer is off the reader page.
44728789a9e7SSteven Rostedt  *
44738789a9e7SSteven Rostedt  * Note: it is up to the calling functions to handle sleeps and wakeups.
44748789a9e7SSteven Rostedt  *  The ring buffer can be used anywhere in the kernel and can not
44758789a9e7SSteven Rostedt  *  blindly call wake_up. The layer that uses the ring buffer must be
44768789a9e7SSteven Rostedt  *  responsible for that.
44778789a9e7SSteven Rostedt  *
44788789a9e7SSteven Rostedt  * Returns:
4479667d2412SLai Jiangshan  *  >=0 if data has been transferred, returns the offset of consumed data.
4480667d2412SLai Jiangshan  *  <0 if no data has been transferred.
44818789a9e7SSteven Rostedt  */
44828789a9e7SSteven Rostedt int ring_buffer_read_page(struct ring_buffer *buffer,
4483ef7a4a16SSteven Rostedt 			  void **data_page, size_t len, int cpu, int full)
44848789a9e7SSteven Rostedt {
44858789a9e7SSteven Rostedt 	struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
44868789a9e7SSteven Rostedt 	struct ring_buffer_event *event;
4487044fa782SSteven Rostedt 	struct buffer_data_page *bpage;
4488ef7a4a16SSteven Rostedt 	struct buffer_page *reader;
4489ff0ff84aSSteven Rostedt 	unsigned long missed_events;
44908789a9e7SSteven Rostedt 	unsigned long flags;
4491ef7a4a16SSteven Rostedt 	unsigned int commit;
4492667d2412SLai Jiangshan 	unsigned int read;
44934f3640f8SSteven Rostedt 	u64 save_timestamp;
4494667d2412SLai Jiangshan 	int ret = -1;
44958789a9e7SSteven Rostedt 
4496554f786eSSteven Rostedt 	if (!cpumask_test_cpu(cpu, buffer->cpumask))
4497554f786eSSteven Rostedt 		goto out;
4498554f786eSSteven Rostedt 
4499474d32b6SSteven Rostedt 	/*
4500474d32b6SSteven Rostedt 	 * If len is not big enough to hold the page header, then
4501474d32b6SSteven Rostedt 	 * we can not copy anything.
4502474d32b6SSteven Rostedt 	 */
4503474d32b6SSteven Rostedt 	if (len <= BUF_PAGE_HDR_SIZE)
4504554f786eSSteven Rostedt 		goto out;
4505474d32b6SSteven Rostedt 
4506474d32b6SSteven Rostedt 	len -= BUF_PAGE_HDR_SIZE;
4507474d32b6SSteven Rostedt 
45088789a9e7SSteven Rostedt 	if (!data_page)
4509554f786eSSteven Rostedt 		goto out;
45108789a9e7SSteven Rostedt 
4511044fa782SSteven Rostedt 	bpage = *data_page;
4512044fa782SSteven Rostedt 	if (!bpage)
4513554f786eSSteven Rostedt 		goto out;
45148789a9e7SSteven Rostedt 
45155389f6faSThomas Gleixner 	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
45168789a9e7SSteven Rostedt 
4517ef7a4a16SSteven Rostedt 	reader = rb_get_reader_page(cpu_buffer);
4518ef7a4a16SSteven Rostedt 	if (!reader)
4519554f786eSSteven Rostedt 		goto out_unlock;
45208789a9e7SSteven Rostedt 
4521ef7a4a16SSteven Rostedt 	event = rb_reader_event(cpu_buffer);
4522667d2412SLai Jiangshan 
4523ef7a4a16SSteven Rostedt 	read = reader->read;
4524ef7a4a16SSteven Rostedt 	commit = rb_page_commit(reader);
4525ef7a4a16SSteven Rostedt 
452666a8cb95SSteven Rostedt 	/* Check if any events were dropped */
4527ff0ff84aSSteven Rostedt 	missed_events = cpu_buffer->lost_events;
452866a8cb95SSteven Rostedt 
45298789a9e7SSteven Rostedt 	/*
4530474d32b6SSteven Rostedt 	 * If this page has been partially read or
4531474d32b6SSteven Rostedt 	 * if len is not big enough to read the rest of the page or
4532474d32b6SSteven Rostedt 	 * a writer is still on the page, then
4533474d32b6SSteven Rostedt 	 * we must copy the data from the page to the buffer.
4534474d32b6SSteven Rostedt 	 * Otherwise, we can simply swap the page with the one passed in.
45358789a9e7SSteven Rostedt 	 */
4536474d32b6SSteven Rostedt 	if (read || (len < (commit - read)) ||
4537ef7a4a16SSteven Rostedt 	    cpu_buffer->reader_page == cpu_buffer->commit_page) {
4538667d2412SLai Jiangshan 		struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
4539474d32b6SSteven Rostedt 		unsigned int rpos = read;
4540474d32b6SSteven Rostedt 		unsigned int pos = 0;
4541ef7a4a16SSteven Rostedt 		unsigned int size;
45428789a9e7SSteven Rostedt 
45438789a9e7SSteven Rostedt 		if (full)
4544554f786eSSteven Rostedt 			goto out_unlock;
45458789a9e7SSteven Rostedt 
4546ef7a4a16SSteven Rostedt 		if (len > (commit - read))
4547ef7a4a16SSteven Rostedt 			len = (commit - read);
4548ef7a4a16SSteven Rostedt 
454969d1b839SSteven Rostedt 		/* Always keep the time extend and data together */
455069d1b839SSteven Rostedt 		size = rb_event_ts_length(event);
4551ef7a4a16SSteven Rostedt 
4552ef7a4a16SSteven Rostedt 		if (len < size)
4553554f786eSSteven Rostedt 			goto out_unlock;
4554ef7a4a16SSteven Rostedt 
45554f3640f8SSteven Rostedt 		/* save the current timestamp, since the user will need it */
45564f3640f8SSteven Rostedt 		save_timestamp = cpu_buffer->read_stamp;
45574f3640f8SSteven Rostedt 
4558ef7a4a16SSteven Rostedt 		/* Need to copy one event at a time */
4559ef7a4a16SSteven Rostedt 		do {
4560e1e35927SDavid Sharp 			/* We need the size of one event, because
4561e1e35927SDavid Sharp 			 * rb_advance_reader only advances by one event,
4562e1e35927SDavid Sharp 			 * whereas rb_event_ts_length may include the size of
4563e1e35927SDavid Sharp 			 * one or two events.
4564e1e35927SDavid Sharp 			 * We have already ensured there's enough space if this
4565e1e35927SDavid Sharp 			 * is a time extend. */
4566e1e35927SDavid Sharp 			size = rb_event_length(event);
4567474d32b6SSteven Rostedt 			memcpy(bpage->data + pos, rpage->data + rpos, size);
4568ef7a4a16SSteven Rostedt 
4569ef7a4a16SSteven Rostedt 			len -= size;
4570ef7a4a16SSteven Rostedt 
4571ef7a4a16SSteven Rostedt 			rb_advance_reader(cpu_buffer);
4572474d32b6SSteven Rostedt 			rpos = reader->read;
4573474d32b6SSteven Rostedt 			pos += size;
4574ef7a4a16SSteven Rostedt 
457518fab912SHuang Ying 			if (rpos >= commit)
457618fab912SHuang Ying 				break;
457718fab912SHuang Ying 
4578ef7a4a16SSteven Rostedt 			event = rb_reader_event(cpu_buffer);
457969d1b839SSteven Rostedt 			/* Always keep the time extend and data together */
458069d1b839SSteven Rostedt 			size = rb_event_ts_length(event);
4581e1e35927SDavid Sharp 		} while (len >= size);
4582667d2412SLai Jiangshan 
4583667d2412SLai Jiangshan 		/* update bpage */
4584ef7a4a16SSteven Rostedt 		local_set(&bpage->commit, pos);
45854f3640f8SSteven Rostedt 		bpage->time_stamp = save_timestamp;
4586ef7a4a16SSteven Rostedt 
4587474d32b6SSteven Rostedt 		/* we copied everything to the beginning */
4588474d32b6SSteven Rostedt 		read = 0;
45898789a9e7SSteven Rostedt 	} else {
4590afbab76aSSteven Rostedt 		/* update the entry counter */
459177ae365eSSteven Rostedt 		cpu_buffer->read += rb_page_entries(reader);
4592c64e148aSVaibhav Nagarnaik 		cpu_buffer->read_bytes += BUF_PAGE_SIZE;
4593afbab76aSSteven Rostedt 
45948789a9e7SSteven Rostedt 		/* swap the pages */
4595044fa782SSteven Rostedt 		rb_init_page(bpage);
4596ef7a4a16SSteven Rostedt 		bpage = reader->page;
4597ef7a4a16SSteven Rostedt 		reader->page = *data_page;
4598ef7a4a16SSteven Rostedt 		local_set(&reader->write, 0);
4599778c55d4SSteven Rostedt 		local_set(&reader->entries, 0);
4600ef7a4a16SSteven Rostedt 		reader->read = 0;
4601044fa782SSteven Rostedt 		*data_page = bpage;
4602ff0ff84aSSteven Rostedt 
4603ff0ff84aSSteven Rostedt 		/*
4604ff0ff84aSSteven Rostedt 		 * Use the real_end for the data size,
4605ff0ff84aSSteven Rostedt 		 * This gives us a chance to store the lost events
4606ff0ff84aSSteven Rostedt 		 * on the page.
4607ff0ff84aSSteven Rostedt 		 */
4608ff0ff84aSSteven Rostedt 		if (reader->real_end)
4609ff0ff84aSSteven Rostedt 			local_set(&bpage->commit, reader->real_end);
4610ef7a4a16SSteven Rostedt 	}
4611ef7a4a16SSteven Rostedt 	ret = read;
4612ef7a4a16SSteven Rostedt 
461366a8cb95SSteven Rostedt 	cpu_buffer->lost_events = 0;
46142711ca23SSteven Rostedt 
46152711ca23SSteven Rostedt 	commit = local_read(&bpage->commit);
461666a8cb95SSteven Rostedt 	/*
461766a8cb95SSteven Rostedt 	 * Set a flag in the commit field if we lost events
461866a8cb95SSteven Rostedt 	 */
4619ff0ff84aSSteven Rostedt 	if (missed_events) {
4620ff0ff84aSSteven Rostedt 		/* If there is room at the end of the page to save the
4621ff0ff84aSSteven Rostedt 		 * missed events, then record it there.
4622ff0ff84aSSteven Rostedt 		 */
4623ff0ff84aSSteven Rostedt 		if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
4624ff0ff84aSSteven Rostedt 			memcpy(&bpage->data[commit], &missed_events,
4625ff0ff84aSSteven Rostedt 			       sizeof(missed_events));
4626ff0ff84aSSteven Rostedt 			local_add(RB_MISSED_STORED, &bpage->commit);
46272711ca23SSteven Rostedt 			commit += sizeof(missed_events);
4628ff0ff84aSSteven Rostedt 		}
462966a8cb95SSteven Rostedt 		local_add(RB_MISSED_EVENTS, &bpage->commit);
4630ff0ff84aSSteven Rostedt 	}
463166a8cb95SSteven Rostedt 
46322711ca23SSteven Rostedt 	/*
46332711ca23SSteven Rostedt 	 * This page may be off to user land. Zero it out here.
46342711ca23SSteven Rostedt 	 */
46352711ca23SSteven Rostedt 	if (commit < BUF_PAGE_SIZE)
46362711ca23SSteven Rostedt 		memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);
46372711ca23SSteven Rostedt 
4638554f786eSSteven Rostedt  out_unlock:
46395389f6faSThomas Gleixner 	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
46408789a9e7SSteven Rostedt 
4641554f786eSSteven Rostedt  out:
46428789a9e7SSteven Rostedt 	return ret;
46438789a9e7SSteven Rostedt }
4644d6ce96daSSteven Rostedt EXPORT_SYMBOL_GPL(ring_buffer_read_page);
46458789a9e7SSteven Rostedt 
464659222efeSSteven Rostedt #ifdef CONFIG_HOTPLUG_CPU
464709c9e84dSFrederic Weisbecker static int rb_cpu_notify(struct notifier_block *self,
4648554f786eSSteven Rostedt 			 unsigned long action, void *hcpu)
4649554f786eSSteven Rostedt {
4650554f786eSSteven Rostedt 	struct ring_buffer *buffer =
4651554f786eSSteven Rostedt 		container_of(self, struct ring_buffer, cpu_notify);
4652554f786eSSteven Rostedt 	long cpu = (long)hcpu;
4653438ced17SVaibhav Nagarnaik 	int cpu_i, nr_pages_same;
4654438ced17SVaibhav Nagarnaik 	unsigned int nr_pages;
4655554f786eSSteven Rostedt 
4656554f786eSSteven Rostedt 	switch (action) {
4657554f786eSSteven Rostedt 	case CPU_UP_PREPARE:
4658554f786eSSteven Rostedt 	case CPU_UP_PREPARE_FROZEN:
46593f237a79SRusty Russell 		if (cpumask_test_cpu(cpu, buffer->cpumask))
4660554f786eSSteven Rostedt 			return NOTIFY_OK;
4661554f786eSSteven Rostedt 
4662438ced17SVaibhav Nagarnaik 		nr_pages = 0;
4663438ced17SVaibhav Nagarnaik 		nr_pages_same = 1;
4664438ced17SVaibhav Nagarnaik 		/* check if all cpu sizes are same */
4665438ced17SVaibhav Nagarnaik 		for_each_buffer_cpu(buffer, cpu_i) {
4666438ced17SVaibhav Nagarnaik 			/* fill in the size from first enabled cpu */
4667438ced17SVaibhav Nagarnaik 			if (nr_pages == 0)
4668438ced17SVaibhav Nagarnaik 				nr_pages = buffer->buffers[cpu_i]->nr_pages;
4669438ced17SVaibhav Nagarnaik 			if (nr_pages != buffer->buffers[cpu_i]->nr_pages) {
4670438ced17SVaibhav Nagarnaik 				nr_pages_same = 0;
4671438ced17SVaibhav Nagarnaik 				break;
4672438ced17SVaibhav Nagarnaik 			}
4673438ced17SVaibhav Nagarnaik 		}
4674438ced17SVaibhav Nagarnaik 		/* allocate minimum pages, user can later expand it */
4675438ced17SVaibhav Nagarnaik 		if (!nr_pages_same)
4676438ced17SVaibhav Nagarnaik 			nr_pages = 2;
4677554f786eSSteven Rostedt 		buffer->buffers[cpu] =
4678438ced17SVaibhav Nagarnaik 			rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
4679554f786eSSteven Rostedt 		if (!buffer->buffers[cpu]) {
4680554f786eSSteven Rostedt 			WARN(1, "failed to allocate ring buffer on CPU %ld\n",
4681554f786eSSteven Rostedt 			     cpu);
4682554f786eSSteven Rostedt 			return NOTIFY_OK;
4683554f786eSSteven Rostedt 		}
4684554f786eSSteven Rostedt 		smp_wmb();
46853f237a79SRusty Russell 		cpumask_set_cpu(cpu, buffer->cpumask);
4686554f786eSSteven Rostedt 		break;
4687554f786eSSteven Rostedt 	case CPU_DOWN_PREPARE:
4688554f786eSSteven Rostedt 	case CPU_DOWN_PREPARE_FROZEN:
4689554f786eSSteven Rostedt 		/*
4690554f786eSSteven Rostedt 		 * Do nothing.
4691554f786eSSteven Rostedt 		 *  If we were to free the buffer, then the user would
4692554f786eSSteven Rostedt 		 *  lose any trace that was in the buffer.
4693554f786eSSteven Rostedt 		 */
4694554f786eSSteven Rostedt 		break;
4695554f786eSSteven Rostedt 	default:
4696554f786eSSteven Rostedt 		break;
4697554f786eSSteven Rostedt 	}
4698554f786eSSteven Rostedt 	return NOTIFY_OK;
4699554f786eSSteven Rostedt }
4700554f786eSSteven Rostedt #endif
47016c43e554SSteven Rostedt (Red Hat) 
47026c43e554SSteven Rostedt (Red Hat) #ifdef CONFIG_RING_BUFFER_STARTUP_TEST
47036c43e554SSteven Rostedt (Red Hat) /*
47046c43e554SSteven Rostedt (Red Hat)  * This is a basic integrity check of the ring buffer.
47056c43e554SSteven Rostedt (Red Hat)  * Late in the boot cycle this test will run when configured in.
47066c43e554SSteven Rostedt (Red Hat)  * It will kick off a thread per CPU that will go into a loop
47076c43e554SSteven Rostedt (Red Hat)  * writing to the per cpu ring buffer various sizes of data.
47086c43e554SSteven Rostedt (Red Hat)  * Some of the data will be large items, some small.
47096c43e554SSteven Rostedt (Red Hat)  *
47106c43e554SSteven Rostedt (Red Hat)  * Another thread is created that goes into a spin, sending out
47116c43e554SSteven Rostedt (Red Hat)  * IPIs to the other CPUs to also write into the ring buffer.
47126c43e554SSteven Rostedt (Red Hat)  * this is to test the nesting ability of the buffer.
47136c43e554SSteven Rostedt (Red Hat)  *
47146c43e554SSteven Rostedt (Red Hat)  * Basic stats are recorded and reported. If something in the
47156c43e554SSteven Rostedt (Red Hat)  * ring buffer should happen that's not expected, a big warning
47166c43e554SSteven Rostedt (Red Hat)  * is displayed and all ring buffers are disabled.
47176c43e554SSteven Rostedt (Red Hat)  */
47186c43e554SSteven Rostedt (Red Hat) static struct task_struct *rb_threads[NR_CPUS] __initdata;
47196c43e554SSteven Rostedt (Red Hat) 
47206c43e554SSteven Rostedt (Red Hat) struct rb_test_data {
47216c43e554SSteven Rostedt (Red Hat) 	struct ring_buffer	*buffer;
47226c43e554SSteven Rostedt (Red Hat) 	unsigned long		events;
47236c43e554SSteven Rostedt (Red Hat) 	unsigned long		bytes_written;
47246c43e554SSteven Rostedt (Red Hat) 	unsigned long		bytes_alloc;
47256c43e554SSteven Rostedt (Red Hat) 	unsigned long		bytes_dropped;
47266c43e554SSteven Rostedt (Red Hat) 	unsigned long		events_nested;
47276c43e554SSteven Rostedt (Red Hat) 	unsigned long		bytes_written_nested;
47286c43e554SSteven Rostedt (Red Hat) 	unsigned long		bytes_alloc_nested;
47296c43e554SSteven Rostedt (Red Hat) 	unsigned long		bytes_dropped_nested;
47306c43e554SSteven Rostedt (Red Hat) 	int			min_size_nested;
47316c43e554SSteven Rostedt (Red Hat) 	int			max_size_nested;
47326c43e554SSteven Rostedt (Red Hat) 	int			max_size;
47336c43e554SSteven Rostedt (Red Hat) 	int			min_size;
47346c43e554SSteven Rostedt (Red Hat) 	int			cpu;
47356c43e554SSteven Rostedt (Red Hat) 	int			cnt;
47366c43e554SSteven Rostedt (Red Hat) };
47376c43e554SSteven Rostedt (Red Hat) 
47386c43e554SSteven Rostedt (Red Hat) static struct rb_test_data rb_data[NR_CPUS] __initdata;
47396c43e554SSteven Rostedt (Red Hat) 
47406c43e554SSteven Rostedt (Red Hat) /* 1 meg per cpu */
47416c43e554SSteven Rostedt (Red Hat) #define RB_TEST_BUFFER_SIZE	1048576
47426c43e554SSteven Rostedt (Red Hat) 
47436c43e554SSteven Rostedt (Red Hat) static char rb_string[] __initdata =
47446c43e554SSteven Rostedt (Red Hat) 	"abcdefghijklmnopqrstuvwxyz1234567890!@#$%^&*()?+\\"
47456c43e554SSteven Rostedt (Red Hat) 	"?+|:';\",.<>/?abcdefghijklmnopqrstuvwxyz1234567890"
47466c43e554SSteven Rostedt (Red Hat) 	"!@#$%^&*()?+\\?+|:';\",.<>/?abcdefghijklmnopqrstuv";
47476c43e554SSteven Rostedt (Red Hat) 
47486c43e554SSteven Rostedt (Red Hat) static bool rb_test_started __initdata;
47496c43e554SSteven Rostedt (Red Hat) 
47506c43e554SSteven Rostedt (Red Hat) struct rb_item {
47516c43e554SSteven Rostedt (Red Hat) 	int size;
47526c43e554SSteven Rostedt (Red Hat) 	char str[];
47536c43e554SSteven Rostedt (Red Hat) };
47546c43e554SSteven Rostedt (Red Hat) 
47556c43e554SSteven Rostedt (Red Hat) static __init int rb_write_something(struct rb_test_data *data, bool nested)
47566c43e554SSteven Rostedt (Red Hat) {
47576c43e554SSteven Rostedt (Red Hat) 	struct ring_buffer_event *event;
47586c43e554SSteven Rostedt (Red Hat) 	struct rb_item *item;
47596c43e554SSteven Rostedt (Red Hat) 	bool started;
47606c43e554SSteven Rostedt (Red Hat) 	int event_len;
47616c43e554SSteven Rostedt (Red Hat) 	int size;
47626c43e554SSteven Rostedt (Red Hat) 	int len;
47636c43e554SSteven Rostedt (Red Hat) 	int cnt;
47646c43e554SSteven Rostedt (Red Hat) 
47656c43e554SSteven Rostedt (Red Hat) 	/* Have nested writes different that what is written */
47666c43e554SSteven Rostedt (Red Hat) 	cnt = data->cnt + (nested ? 27 : 0);
47676c43e554SSteven Rostedt (Red Hat) 
47686c43e554SSteven Rostedt (Red Hat) 	/* Multiply cnt by ~e, to make some unique increment */
47696c43e554SSteven Rostedt (Red Hat) 	size = (data->cnt * 68 / 25) % (sizeof(rb_string) - 1);
47706c43e554SSteven Rostedt (Red Hat) 
47716c43e554SSteven Rostedt (Red Hat) 	len = size + sizeof(struct rb_item);
47726c43e554SSteven Rostedt (Red Hat) 
47736c43e554SSteven Rostedt (Red Hat) 	started = rb_test_started;
47746c43e554SSteven Rostedt (Red Hat) 	/* read rb_test_started before checking buffer enabled */
47756c43e554SSteven Rostedt (Red Hat) 	smp_rmb();
47766c43e554SSteven Rostedt (Red Hat) 
47776c43e554SSteven Rostedt (Red Hat) 	event = ring_buffer_lock_reserve(data->buffer, len);
47786c43e554SSteven Rostedt (Red Hat) 	if (!event) {
47796c43e554SSteven Rostedt (Red Hat) 		/* Ignore dropped events before test starts. */
47806c43e554SSteven Rostedt (Red Hat) 		if (started) {
47816c43e554SSteven Rostedt (Red Hat) 			if (nested)
47826c43e554SSteven Rostedt (Red Hat) 				data->bytes_dropped += len;
47836c43e554SSteven Rostedt (Red Hat) 			else
47846c43e554SSteven Rostedt (Red Hat) 				data->bytes_dropped_nested += len;
47856c43e554SSteven Rostedt (Red Hat) 		}
47866c43e554SSteven Rostedt (Red Hat) 		return len;
47876c43e554SSteven Rostedt (Red Hat) 	}
47886c43e554SSteven Rostedt (Red Hat) 
47896c43e554SSteven Rostedt (Red Hat) 	event_len = ring_buffer_event_length(event);
47906c43e554SSteven Rostedt (Red Hat) 
47916c43e554SSteven Rostedt (Red Hat) 	if (RB_WARN_ON(data->buffer, event_len < len))
47926c43e554SSteven Rostedt (Red Hat) 		goto out;
47936c43e554SSteven Rostedt (Red Hat) 
47946c43e554SSteven Rostedt (Red Hat) 	item = ring_buffer_event_data(event);
47956c43e554SSteven Rostedt (Red Hat) 	item->size = size;
47966c43e554SSteven Rostedt (Red Hat) 	memcpy(item->str, rb_string, size);
47976c43e554SSteven Rostedt (Red Hat) 
47986c43e554SSteven Rostedt (Red Hat) 	if (nested) {
47996c43e554SSteven Rostedt (Red Hat) 		data->bytes_alloc_nested += event_len;
48006c43e554SSteven Rostedt (Red Hat) 		data->bytes_written_nested += len;
48016c43e554SSteven Rostedt (Red Hat) 		data->events_nested++;
48026c43e554SSteven Rostedt (Red Hat) 		if (!data->min_size_nested || len < data->min_size_nested)
48036c43e554SSteven Rostedt (Red Hat) 			data->min_size_nested = len;
48046c43e554SSteven Rostedt (Red Hat) 		if (len > data->max_size_nested)
48056c43e554SSteven Rostedt (Red Hat) 			data->max_size_nested = len;
48066c43e554SSteven Rostedt (Red Hat) 	} else {
48076c43e554SSteven Rostedt (Red Hat) 		data->bytes_alloc += event_len;
48086c43e554SSteven Rostedt (Red Hat) 		data->bytes_written += len;
48096c43e554SSteven Rostedt (Red Hat) 		data->events++;
48106c43e554SSteven Rostedt (Red Hat) 		if (!data->min_size || len < data->min_size)
48116c43e554SSteven Rostedt (Red Hat) 			data->max_size = len;
48126c43e554SSteven Rostedt (Red Hat) 		if (len > data->max_size)
48136c43e554SSteven Rostedt (Red Hat) 			data->max_size = len;
48146c43e554SSteven Rostedt (Red Hat) 	}
48156c43e554SSteven Rostedt (Red Hat) 
48166c43e554SSteven Rostedt (Red Hat)  out:
48176c43e554SSteven Rostedt (Red Hat) 	ring_buffer_unlock_commit(data->buffer, event);
48186c43e554SSteven Rostedt (Red Hat) 
48196c43e554SSteven Rostedt (Red Hat) 	return 0;
48206c43e554SSteven Rostedt (Red Hat) }
48216c43e554SSteven Rostedt (Red Hat) 
48226c43e554SSteven Rostedt (Red Hat) static __init int rb_test(void *arg)
48236c43e554SSteven Rostedt (Red Hat) {
48246c43e554SSteven Rostedt (Red Hat) 	struct rb_test_data *data = arg;
48256c43e554SSteven Rostedt (Red Hat) 
48266c43e554SSteven Rostedt (Red Hat) 	while (!kthread_should_stop()) {
48276c43e554SSteven Rostedt (Red Hat) 		rb_write_something(data, false);
48286c43e554SSteven Rostedt (Red Hat) 		data->cnt++;
48296c43e554SSteven Rostedt (Red Hat) 
48306c43e554SSteven Rostedt (Red Hat) 		set_current_state(TASK_INTERRUPTIBLE);
48316c43e554SSteven Rostedt (Red Hat) 		/* Now sleep between a min of 100-300us and a max of 1ms */
48326c43e554SSteven Rostedt (Red Hat) 		usleep_range(((data->cnt % 3) + 1) * 100, 1000);
48336c43e554SSteven Rostedt (Red Hat) 	}
48346c43e554SSteven Rostedt (Red Hat) 
48356c43e554SSteven Rostedt (Red Hat) 	return 0;
48366c43e554SSteven Rostedt (Red Hat) }
48376c43e554SSteven Rostedt (Red Hat) 
48386c43e554SSteven Rostedt (Red Hat) static __init void rb_ipi(void *ignore)
48396c43e554SSteven Rostedt (Red Hat) {
48406c43e554SSteven Rostedt (Red Hat) 	struct rb_test_data *data;
48416c43e554SSteven Rostedt (Red Hat) 	int cpu = smp_processor_id();
48426c43e554SSteven Rostedt (Red Hat) 
48436c43e554SSteven Rostedt (Red Hat) 	data = &rb_data[cpu];
48446c43e554SSteven Rostedt (Red Hat) 	rb_write_something(data, true);
48456c43e554SSteven Rostedt (Red Hat) }
48466c43e554SSteven Rostedt (Red Hat) 
48476c43e554SSteven Rostedt (Red Hat) static __init int rb_hammer_test(void *arg)
48486c43e554SSteven Rostedt (Red Hat) {
48496c43e554SSteven Rostedt (Red Hat) 	while (!kthread_should_stop()) {
48506c43e554SSteven Rostedt (Red Hat) 
48516c43e554SSteven Rostedt (Red Hat) 		/* Send an IPI to all cpus to write data! */
48526c43e554SSteven Rostedt (Red Hat) 		smp_call_function(rb_ipi, NULL, 1);
48536c43e554SSteven Rostedt (Red Hat) 		/* No sleep, but for non preempt, let others run */
48546c43e554SSteven Rostedt (Red Hat) 		schedule();
48556c43e554SSteven Rostedt (Red Hat) 	}
48566c43e554SSteven Rostedt (Red Hat) 
48576c43e554SSteven Rostedt (Red Hat) 	return 0;
48586c43e554SSteven Rostedt (Red Hat) }
48596c43e554SSteven Rostedt (Red Hat) 
48606c43e554SSteven Rostedt (Red Hat) static __init int test_ringbuffer(void)
48616c43e554SSteven Rostedt (Red Hat) {
48626c43e554SSteven Rostedt (Red Hat) 	struct task_struct *rb_hammer;
48636c43e554SSteven Rostedt (Red Hat) 	struct ring_buffer *buffer;
48646c43e554SSteven Rostedt (Red Hat) 	int cpu;
48656c43e554SSteven Rostedt (Red Hat) 	int ret = 0;
48666c43e554SSteven Rostedt (Red Hat) 
48676c43e554SSteven Rostedt (Red Hat) 	pr_info("Running ring buffer tests...\n");
48686c43e554SSteven Rostedt (Red Hat) 
48696c43e554SSteven Rostedt (Red Hat) 	buffer = ring_buffer_alloc(RB_TEST_BUFFER_SIZE, RB_FL_OVERWRITE);
48706c43e554SSteven Rostedt (Red Hat) 	if (WARN_ON(!buffer))
48716c43e554SSteven Rostedt (Red Hat) 		return 0;
48726c43e554SSteven Rostedt (Red Hat) 
48736c43e554SSteven Rostedt (Red Hat) 	/* Disable buffer so that threads can't write to it yet */
48746c43e554SSteven Rostedt (Red Hat) 	ring_buffer_record_off(buffer);
48756c43e554SSteven Rostedt (Red Hat) 
48766c43e554SSteven Rostedt (Red Hat) 	for_each_online_cpu(cpu) {
48776c43e554SSteven Rostedt (Red Hat) 		rb_data[cpu].buffer = buffer;
48786c43e554SSteven Rostedt (Red Hat) 		rb_data[cpu].cpu = cpu;
48796c43e554SSteven Rostedt (Red Hat) 		rb_data[cpu].cnt = cpu;
48806c43e554SSteven Rostedt (Red Hat) 		rb_threads[cpu] = kthread_create(rb_test, &rb_data[cpu],
48816c43e554SSteven Rostedt (Red Hat) 						 "rbtester/%d", cpu);
48826c43e554SSteven Rostedt (Red Hat) 		if (WARN_ON(!rb_threads[cpu])) {
48836c43e554SSteven Rostedt (Red Hat) 			pr_cont("FAILED\n");
48846c43e554SSteven Rostedt (Red Hat) 			ret = -1;
48856c43e554SSteven Rostedt (Red Hat) 			goto out_free;
48866c43e554SSteven Rostedt (Red Hat) 		}
48876c43e554SSteven Rostedt (Red Hat) 
48886c43e554SSteven Rostedt (Red Hat) 		kthread_bind(rb_threads[cpu], cpu);
48896c43e554SSteven Rostedt (Red Hat)  		wake_up_process(rb_threads[cpu]);
48906c43e554SSteven Rostedt (Red Hat) 	}
48916c43e554SSteven Rostedt (Red Hat) 
48926c43e554SSteven Rostedt (Red Hat) 	/* Now create the rb hammer! */
48936c43e554SSteven Rostedt (Red Hat) 	rb_hammer = kthread_run(rb_hammer_test, NULL, "rbhammer");
48946c43e554SSteven Rostedt (Red Hat) 	if (WARN_ON(!rb_hammer)) {
48956c43e554SSteven Rostedt (Red Hat) 		pr_cont("FAILED\n");
48966c43e554SSteven Rostedt (Red Hat) 		ret = -1;
48976c43e554SSteven Rostedt (Red Hat) 		goto out_free;
48986c43e554SSteven Rostedt (Red Hat) 	}
48996c43e554SSteven Rostedt (Red Hat) 
49006c43e554SSteven Rostedt (Red Hat) 	ring_buffer_record_on(buffer);
49016c43e554SSteven Rostedt (Red Hat) 	/*
49026c43e554SSteven Rostedt (Red Hat) 	 * Show buffer is enabled before setting rb_test_started.
49036c43e554SSteven Rostedt (Red Hat) 	 * Yes there's a small race window where events could be
49046c43e554SSteven Rostedt (Red Hat) 	 * dropped and the thread wont catch it. But when a ring
49056c43e554SSteven Rostedt (Red Hat) 	 * buffer gets enabled, there will always be some kind of
49066c43e554SSteven Rostedt (Red Hat) 	 * delay before other CPUs see it. Thus, we don't care about
49076c43e554SSteven Rostedt (Red Hat) 	 * those dropped events. We care about events dropped after
49086c43e554SSteven Rostedt (Red Hat) 	 * the threads see that the buffer is active.
49096c43e554SSteven Rostedt (Red Hat) 	 */
49106c43e554SSteven Rostedt (Red Hat) 	smp_wmb();
49116c43e554SSteven Rostedt (Red Hat) 	rb_test_started = true;
49126c43e554SSteven Rostedt (Red Hat) 
49136c43e554SSteven Rostedt (Red Hat) 	set_current_state(TASK_INTERRUPTIBLE);
49146c43e554SSteven Rostedt (Red Hat) 	/* Just run for 10 seconds */;
49156c43e554SSteven Rostedt (Red Hat) 	schedule_timeout(10 * HZ);
49166c43e554SSteven Rostedt (Red Hat) 
49176c43e554SSteven Rostedt (Red Hat) 	kthread_stop(rb_hammer);
49186c43e554SSteven Rostedt (Red Hat) 
49196c43e554SSteven Rostedt (Red Hat)  out_free:
49206c43e554SSteven Rostedt (Red Hat) 	for_each_online_cpu(cpu) {
49216c43e554SSteven Rostedt (Red Hat) 		if (!rb_threads[cpu])
49226c43e554SSteven Rostedt (Red Hat) 			break;
49236c43e554SSteven Rostedt (Red Hat) 		kthread_stop(rb_threads[cpu]);
49246c43e554SSteven Rostedt (Red Hat) 	}
49256c43e554SSteven Rostedt (Red Hat) 	if (ret) {
49266c43e554SSteven Rostedt (Red Hat) 		ring_buffer_free(buffer);
49276c43e554SSteven Rostedt (Red Hat) 		return ret;
49286c43e554SSteven Rostedt (Red Hat) 	}
49296c43e554SSteven Rostedt (Red Hat) 
49306c43e554SSteven Rostedt (Red Hat) 	/* Report! */
49316c43e554SSteven Rostedt (Red Hat) 	pr_info("finished\n");
49326c43e554SSteven Rostedt (Red Hat) 	for_each_online_cpu(cpu) {
49336c43e554SSteven Rostedt (Red Hat) 		struct ring_buffer_event *event;
49346c43e554SSteven Rostedt (Red Hat) 		struct rb_test_data *data = &rb_data[cpu];
49356c43e554SSteven Rostedt (Red Hat) 		struct rb_item *item;
49366c43e554SSteven Rostedt (Red Hat) 		unsigned long total_events;
49376c43e554SSteven Rostedt (Red Hat) 		unsigned long total_dropped;
49386c43e554SSteven Rostedt (Red Hat) 		unsigned long total_written;
49396c43e554SSteven Rostedt (Red Hat) 		unsigned long total_alloc;
49406c43e554SSteven Rostedt (Red Hat) 		unsigned long total_read = 0;
49416c43e554SSteven Rostedt (Red Hat) 		unsigned long total_size = 0;
49426c43e554SSteven Rostedt (Red Hat) 		unsigned long total_len = 0;
49436c43e554SSteven Rostedt (Red Hat) 		unsigned long total_lost = 0;
49446c43e554SSteven Rostedt (Red Hat) 		unsigned long lost;
49456c43e554SSteven Rostedt (Red Hat) 		int big_event_size;
49466c43e554SSteven Rostedt (Red Hat) 		int small_event_size;
49476c43e554SSteven Rostedt (Red Hat) 
49486c43e554SSteven Rostedt (Red Hat) 		ret = -1;
49496c43e554SSteven Rostedt (Red Hat) 
49506c43e554SSteven Rostedt (Red Hat) 		total_events = data->events + data->events_nested;
49516c43e554SSteven Rostedt (Red Hat) 		total_written = data->bytes_written + data->bytes_written_nested;
49526c43e554SSteven Rostedt (Red Hat) 		total_alloc = data->bytes_alloc + data->bytes_alloc_nested;
49536c43e554SSteven Rostedt (Red Hat) 		total_dropped = data->bytes_dropped + data->bytes_dropped_nested;
49546c43e554SSteven Rostedt (Red Hat) 
49556c43e554SSteven Rostedt (Red Hat) 		big_event_size = data->max_size + data->max_size_nested;
49566c43e554SSteven Rostedt (Red Hat) 		small_event_size = data->min_size + data->min_size_nested;
49576c43e554SSteven Rostedt (Red Hat) 
49586c43e554SSteven Rostedt (Red Hat) 		pr_info("CPU %d:\n", cpu);
49596c43e554SSteven Rostedt (Red Hat) 		pr_info("              events:    %ld\n", total_events);
49606c43e554SSteven Rostedt (Red Hat) 		pr_info("       dropped bytes:    %ld\n", total_dropped);
49616c43e554SSteven Rostedt (Red Hat) 		pr_info("       alloced bytes:    %ld\n", total_alloc);
49626c43e554SSteven Rostedt (Red Hat) 		pr_info("       written bytes:    %ld\n", total_written);
49636c43e554SSteven Rostedt (Red Hat) 		pr_info("       biggest event:    %d\n", big_event_size);
49646c43e554SSteven Rostedt (Red Hat) 		pr_info("      smallest event:    %d\n", small_event_size);
49656c43e554SSteven Rostedt (Red Hat) 
49666c43e554SSteven Rostedt (Red Hat) 		if (RB_WARN_ON(buffer, total_dropped))
49676c43e554SSteven Rostedt (Red Hat) 			break;
49686c43e554SSteven Rostedt (Red Hat) 
49696c43e554SSteven Rostedt (Red Hat) 		ret = 0;
49706c43e554SSteven Rostedt (Red Hat) 
49716c43e554SSteven Rostedt (Red Hat) 		while ((event = ring_buffer_consume(buffer, cpu, NULL, &lost))) {
49726c43e554SSteven Rostedt (Red Hat) 			total_lost += lost;
49736c43e554SSteven Rostedt (Red Hat) 			item = ring_buffer_event_data(event);
49746c43e554SSteven Rostedt (Red Hat) 			total_len += ring_buffer_event_length(event);
49756c43e554SSteven Rostedt (Red Hat) 			total_size += item->size + sizeof(struct rb_item);
49766c43e554SSteven Rostedt (Red Hat) 			if (memcmp(&item->str[0], rb_string, item->size) != 0) {
49776c43e554SSteven Rostedt (Red Hat) 				pr_info("FAILED!\n");
49786c43e554SSteven Rostedt (Red Hat) 				pr_info("buffer had: %.*s\n", item->size, item->str);
49796c43e554SSteven Rostedt (Red Hat) 				pr_info("expected:   %.*s\n", item->size, rb_string);
49806c43e554SSteven Rostedt (Red Hat) 				RB_WARN_ON(buffer, 1);
49816c43e554SSteven Rostedt (Red Hat) 				ret = -1;
49826c43e554SSteven Rostedt (Red Hat) 				break;
49836c43e554SSteven Rostedt (Red Hat) 			}
49846c43e554SSteven Rostedt (Red Hat) 			total_read++;
49856c43e554SSteven Rostedt (Red Hat) 		}
49866c43e554SSteven Rostedt (Red Hat) 		if (ret)
49876c43e554SSteven Rostedt (Red Hat) 			break;
49886c43e554SSteven Rostedt (Red Hat) 
49896c43e554SSteven Rostedt (Red Hat) 		ret = -1;
49906c43e554SSteven Rostedt (Red Hat) 
49916c43e554SSteven Rostedt (Red Hat) 		pr_info("         read events:   %ld\n", total_read);
49926c43e554SSteven Rostedt (Red Hat) 		pr_info("         lost events:   %ld\n", total_lost);
49936c43e554SSteven Rostedt (Red Hat) 		pr_info("        total events:   %ld\n", total_lost + total_read);
49946c43e554SSteven Rostedt (Red Hat) 		pr_info("  recorded len bytes:   %ld\n", total_len);
49956c43e554SSteven Rostedt (Red Hat) 		pr_info(" recorded size bytes:   %ld\n", total_size);
49966c43e554SSteven Rostedt (Red Hat) 		if (total_lost)
49976c43e554SSteven Rostedt (Red Hat) 			pr_info(" With dropped events, record len and size may not match\n"
49986c43e554SSteven Rostedt (Red Hat) 				" alloced and written from above\n");
49996c43e554SSteven Rostedt (Red Hat) 		if (!total_lost) {
50006c43e554SSteven Rostedt (Red Hat) 			if (RB_WARN_ON(buffer, total_len != total_alloc ||
50016c43e554SSteven Rostedt (Red Hat) 				       total_size != total_written))
50026c43e554SSteven Rostedt (Red Hat) 				break;
50036c43e554SSteven Rostedt (Red Hat) 		}
50046c43e554SSteven Rostedt (Red Hat) 		if (RB_WARN_ON(buffer, total_lost + total_read != total_events))
50056c43e554SSteven Rostedt (Red Hat) 			break;
50066c43e554SSteven Rostedt (Red Hat) 
50076c43e554SSteven Rostedt (Red Hat) 		ret = 0;
50086c43e554SSteven Rostedt (Red Hat) 	}
50096c43e554SSteven Rostedt (Red Hat) 	if (!ret)
50106c43e554SSteven Rostedt (Red Hat) 		pr_info("Ring buffer PASSED!\n");
50116c43e554SSteven Rostedt (Red Hat) 
50126c43e554SSteven Rostedt (Red Hat) 	ring_buffer_free(buffer);
50136c43e554SSteven Rostedt (Red Hat) 	return 0;
50146c43e554SSteven Rostedt (Red Hat) }
50156c43e554SSteven Rostedt (Red Hat) 
50166c43e554SSteven Rostedt (Red Hat) late_initcall(test_ringbuffer);
50176c43e554SSteven Rostedt (Red Hat) #endif /* CONFIG_RING_BUFFER_STARTUP_TEST */
5018