blob: cf8d11e91efdf92d95dad58d6fa771d2ac998786 [file] [log] [blame]
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001/*
2 * Generic ring buffer
3 *
4 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
5 */
6#include <linux/ring_buffer.h>
Ingo Molnar14131f22009-02-26 18:47:11 +01007#include <linux/trace_clock.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04008#include <linux/spinlock.h>
9#include <linux/debugfs.h>
10#include <linux/uaccess.h>
Steven Rostedta81bd802009-02-06 01:45:16 -050011#include <linux/hardirq.h>
Vegard Nossum1744a212009-02-28 08:29:44 +010012#include <linux/kmemcheck.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040013#include <linux/module.h>
14#include <linux/percpu.h>
15#include <linux/mutex.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090016#include <linux/slab.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040017#include <linux/init.h>
18#include <linux/hash.h>
19#include <linux/list.h>
Steven Rostedt554f7862009-03-11 22:00:13 -040020#include <linux/cpu.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040021#include <linux/fs.h>
22
Christoph Lameter79615762010-01-05 15:34:50 +090023#include <asm/local.h>
Steven Rostedt182e9f52008-11-03 23:15:56 -050024#include "trace.h"
25
Steven Rostedt033601a2008-11-21 12:41:55 -050026/*
Steven Rostedtd1b182a2009-04-15 16:53:47 -040027 * The ring buffer header is special. We must manually up keep it.
28 */
29int ring_buffer_print_entry_header(struct trace_seq *s)
30{
31 int ret;
32
Lai Jiangshan334d4162009-04-24 11:27:05 +080033 ret = trace_seq_printf(s, "# compressed entry header\n");
34 ret = trace_seq_printf(s, "\ttype_len : 5 bits\n");
Steven Rostedtd1b182a2009-04-15 16:53:47 -040035 ret = trace_seq_printf(s, "\ttime_delta : 27 bits\n");
36 ret = trace_seq_printf(s, "\tarray : 32 bits\n");
37 ret = trace_seq_printf(s, "\n");
38 ret = trace_seq_printf(s, "\tpadding : type == %d\n",
39 RINGBUF_TYPE_PADDING);
40 ret = trace_seq_printf(s, "\ttime_extend : type == %d\n",
41 RINGBUF_TYPE_TIME_EXTEND);
Lai Jiangshan334d4162009-04-24 11:27:05 +080042 ret = trace_seq_printf(s, "\tdata max type_len == %d\n",
43 RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
Steven Rostedtd1b182a2009-04-15 16:53:47 -040044
45 return ret;
46}
47
48/*
Steven Rostedt5cc98542009-03-12 22:24:17 -040049 * The ring buffer is made up of a list of pages. A separate list of pages is
50 * allocated for each CPU. A writer may only write to a buffer that is
51 * associated with the CPU it is currently executing on. A reader may read
52 * from any per cpu buffer.
53 *
54 * The reader is special. For each per cpu buffer, the reader has its own
55 * reader page. When a reader has read the entire reader page, this reader
56 * page is swapped with another page in the ring buffer.
57 *
58 * Now, as long as the writer is off the reader page, the reader can do what
59 * ever it wants with that page. The writer will never write to that page
60 * again (as long as it is out of the ring buffer).
61 *
62 * Here's some silly ASCII art.
63 *
64 * +------+
65 * |reader| RING BUFFER
66 * |page |
67 * +------+ +---+ +---+ +---+
68 * | |-->| |-->| |
69 * +---+ +---+ +---+
70 * ^ |
71 * | |
72 * +---------------+
73 *
74 *
75 * +------+
76 * |reader| RING BUFFER
77 * |page |------------------v
78 * +------+ +---+ +---+ +---+
79 * | |-->| |-->| |
80 * +---+ +---+ +---+
81 * ^ |
82 * | |
83 * +---------------+
84 *
85 *
86 * +------+
87 * |reader| RING BUFFER
88 * |page |------------------v
89 * +------+ +---+ +---+ +---+
90 * ^ | |-->| |-->| |
91 * | +---+ +---+ +---+
92 * | |
93 * | |
94 * +------------------------------+
95 *
96 *
97 * +------+
98 * |buffer| RING BUFFER
99 * |page |------------------v
100 * +------+ +---+ +---+ +---+
101 * ^ | | | |-->| |
102 * | New +---+ +---+ +---+
103 * | Reader------^ |
104 * | page |
105 * +------------------------------+
106 *
107 *
108 * After we make this swap, the reader can hand this page off to the splice
109 * code and be done with it. It can even allocate a new page if it needs to
110 * and swap that into the ring buffer.
111 *
112 * We will be using cmpxchg soon to make all this lockless.
113 *
114 */
115
116/*
Steven Rostedt033601a2008-11-21 12:41:55 -0500117 * A fast way to enable or disable all ring buffers is to
118 * call tracing_on or tracing_off. Turning off the ring buffers
119 * prevents all ring buffers from being recorded to.
120 * Turning this switch on, makes it OK to write to the
121 * ring buffer, if the ring buffer is enabled itself.
122 *
123 * There's three layers that must be on in order to write
124 * to the ring buffer.
125 *
126 * 1) This global flag must be set.
127 * 2) The ring buffer must be enabled for recording.
128 * 3) The per cpu buffer must be enabled for recording.
129 *
130 * In case of an anomaly, this global flag has a bit set that
131 * will permantly disable all ring buffers.
132 */
133
134/*
135 * Global flag to disable all recording to ring buffers
136 * This has two bits: ON, DISABLED
137 *
138 * ON DISABLED
139 * ---- ----------
140 * 0 0 : ring buffers are off
141 * 1 0 : ring buffers are on
142 * X 1 : ring buffers are permanently disabled
143 */
144
145enum {
146 RB_BUFFERS_ON_BIT = 0,
147 RB_BUFFERS_DISABLED_BIT = 1,
148};
149
150enum {
151 RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
152 RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
153};
154
Hannes Eder5e398412009-02-10 19:44:34 +0100155static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
Steven Rostedta3583242008-11-11 15:01:42 -0500156
Steven Rostedt499e5472012-02-22 15:50:28 -0500157/* Used for individual buffers (after the counter) */
158#define RB_BUFFER_OFF (1 << 20)
159
Steven Rostedt474d32b2009-03-03 19:51:40 -0500160#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
161
Steven Rostedta3583242008-11-11 15:01:42 -0500162/**
Steven Rostedt033601a2008-11-21 12:41:55 -0500163 * tracing_off_permanent - permanently disable ring buffers
164 *
165 * This function, once called, will disable all ring buffers
Wenji Huangc3706f02009-02-10 01:03:18 -0500166 * permanently.
Steven Rostedt033601a2008-11-21 12:41:55 -0500167 */
168void tracing_off_permanent(void)
169{
170 set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -0500171}
172
Steven Rostedte3d6bf02009-03-03 13:53:07 -0500173#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
Andrew Morton67d34722009-01-09 12:27:09 -0800174#define RB_ALIGNMENT 4U
Lai Jiangshan334d4162009-04-24 11:27:05 +0800175#define RB_MAX_SMALL_DATA (RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Steven Rostedtc7b09302009-06-11 11:12:00 -0400176#define RB_EVNT_MIN_SIZE 8U /* two 32bit words */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800177
Steven Rostedt22710482010-03-18 17:54:19 -0400178#if !defined(CONFIG_64BIT) || defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
179# define RB_FORCE_8BYTE_ALIGNMENT 0
180# define RB_ARCH_ALIGNMENT RB_ALIGNMENT
181#else
182# define RB_FORCE_8BYTE_ALIGNMENT 1
183# define RB_ARCH_ALIGNMENT 8U
184#endif
185
Lai Jiangshan334d4162009-04-24 11:27:05 +0800186/* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
187#define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400188
189enum {
190 RB_LEN_TIME_EXTEND = 8,
191 RB_LEN_TIME_STAMP = 16,
192};
193
Steven Rostedt69d1b832010-10-07 18:18:05 -0400194#define skip_time_extend(event) \
195 ((struct ring_buffer_event *)((char *)event + RB_LEN_TIME_EXTEND))
196
Tom Zanussi2d622712009-03-22 03:30:49 -0500197static inline int rb_null_event(struct ring_buffer_event *event)
198{
Steven Rostedta1863c22009-09-03 10:23:58 -0400199 return event->type_len == RINGBUF_TYPE_PADDING && !event->time_delta;
Tom Zanussi2d622712009-03-22 03:30:49 -0500200}
201
202static void rb_event_set_padding(struct ring_buffer_event *event)
203{
Steven Rostedta1863c22009-09-03 10:23:58 -0400204 /* padding has a NULL time_delta */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800205 event->type_len = RINGBUF_TYPE_PADDING;
Tom Zanussi2d622712009-03-22 03:30:49 -0500206 event->time_delta = 0;
207}
208
Tom Zanussi2d622712009-03-22 03:30:49 -0500209static unsigned
210rb_event_data_length(struct ring_buffer_event *event)
211{
212 unsigned length;
213
Lai Jiangshan334d4162009-04-24 11:27:05 +0800214 if (event->type_len)
215 length = event->type_len * RB_ALIGNMENT;
Tom Zanussi2d622712009-03-22 03:30:49 -0500216 else
217 length = event->array[0];
218 return length + RB_EVNT_HDR_SIZE;
219}
220
Steven Rostedt69d1b832010-10-07 18:18:05 -0400221/*
222 * Return the length of the given event. Will return
223 * the length of the time extend if the event is a
224 * time extend.
225 */
226static inline unsigned
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400227rb_event_length(struct ring_buffer_event *event)
228{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800229 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400230 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -0500231 if (rb_null_event(event))
232 /* undefined */
233 return -1;
Lai Jiangshan334d4162009-04-24 11:27:05 +0800234 return event->array[0] + RB_EVNT_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400235
236 case RINGBUF_TYPE_TIME_EXTEND:
237 return RB_LEN_TIME_EXTEND;
238
239 case RINGBUF_TYPE_TIME_STAMP:
240 return RB_LEN_TIME_STAMP;
241
242 case RINGBUF_TYPE_DATA:
Tom Zanussi2d622712009-03-22 03:30:49 -0500243 return rb_event_data_length(event);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400244 default:
245 BUG();
246 }
247 /* not hit */
248 return 0;
249}
250
Steven Rostedt69d1b832010-10-07 18:18:05 -0400251/*
252 * Return total length of time extend and data,
253 * or just the event length for all other events.
254 */
255static inline unsigned
256rb_event_ts_length(struct ring_buffer_event *event)
257{
258 unsigned len = 0;
259
260 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
261 /* time extends include the data event after it */
262 len = RB_LEN_TIME_EXTEND;
263 event = skip_time_extend(event);
264 }
265 return len + rb_event_length(event);
266}
267
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400268/**
269 * ring_buffer_event_length - return the length of the event
270 * @event: the event to get the length of
Steven Rostedt69d1b832010-10-07 18:18:05 -0400271 *
272 * Returns the size of the data load of a data event.
273 * If the event is something other than a data event, it
274 * returns the size of the event itself. With the exception
275 * of a TIME EXTEND, where it still returns the size of the
276 * data load of the data event after it.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400277 */
278unsigned ring_buffer_event_length(struct ring_buffer_event *event)
279{
Steven Rostedt69d1b832010-10-07 18:18:05 -0400280 unsigned length;
281
282 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
283 event = skip_time_extend(event);
284
285 length = rb_event_length(event);
Lai Jiangshan334d4162009-04-24 11:27:05 +0800286 if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Robert Richter465634a2009-01-07 15:32:11 +0100287 return length;
288 length -= RB_EVNT_HDR_SIZE;
289 if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
290 length -= sizeof(event->array[0]);
291 return length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400292}
Robert Richterc4f50182008-12-11 16:49:22 +0100293EXPORT_SYMBOL_GPL(ring_buffer_event_length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400294
295/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800296static void *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400297rb_event_data(struct ring_buffer_event *event)
298{
Steven Rostedt69d1b832010-10-07 18:18:05 -0400299 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
300 event = skip_time_extend(event);
Lai Jiangshan334d4162009-04-24 11:27:05 +0800301 BUG_ON(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400302 /* If length is in len field, then array[0] has the data */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800303 if (event->type_len)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400304 return (void *)&event->array[0];
305 /* Otherwise length is in array[0] and array[1] has the data */
306 return (void *)&event->array[1];
307}
308
309/**
310 * ring_buffer_event_data - return the data of the event
311 * @event: the event to get the data from
312 */
313void *ring_buffer_event_data(struct ring_buffer_event *event)
314{
315 return rb_event_data(event);
316}
Robert Richterc4f50182008-12-11 16:49:22 +0100317EXPORT_SYMBOL_GPL(ring_buffer_event_data);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400318
319#define for_each_buffer_cpu(buffer, cpu) \
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030320 for_each_cpu(cpu, buffer->cpumask)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400321
322#define TS_SHIFT 27
323#define TS_MASK ((1ULL << TS_SHIFT) - 1)
324#define TS_DELTA_TEST (~TS_MASK)
325
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400326/* Flag when events were overwritten */
327#define RB_MISSED_EVENTS (1 << 31)
Steven Rostedtff0ff842010-03-31 22:11:42 -0400328/* Missed count stored at end */
329#define RB_MISSED_STORED (1 << 30)
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400330
Steven Rostedtabc9b562008-12-02 15:34:06 -0500331struct buffer_data_page {
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400332 u64 time_stamp; /* page time stamp */
Wenji Huangc3706f02009-02-10 01:03:18 -0500333 local_t commit; /* write committed index */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500334 unsigned char data[]; /* data of buffer page */
335};
336
Steven Rostedt77ae3652009-03-27 11:00:29 -0400337/*
338 * Note, the buffer_page list must be first. The buffer pages
339 * are allocated in cache lines, which means that each buffer
340 * page will be at the beginning of a cache line, and thus
341 * the least significant bits will be zero. We use this to
342 * add flags in the list struct pointers, to make the ring buffer
343 * lockless.
344 */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500345struct buffer_page {
Steven Rostedt778c55d2009-05-01 18:44:45 -0400346 struct list_head list; /* list of buffer pages */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500347 local_t write; /* index for next write */
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400348 unsigned read; /* index for next read */
Steven Rostedt778c55d2009-05-01 18:44:45 -0400349 local_t entries; /* entries on this page */
Steven Rostedtff0ff842010-03-31 22:11:42 -0400350 unsigned long real_end; /* real end of data */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500351 struct buffer_data_page *page; /* Actual data page */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400352};
353
Steven Rostedt77ae3652009-03-27 11:00:29 -0400354/*
355 * The buffer page counters, write and entries, must be reset
356 * atomically when crossing page boundaries. To synchronize this
357 * update, two counters are inserted into the number. One is
358 * the actual counter for the write position or count on the page.
359 *
360 * The other is a counter of updaters. Before an update happens
361 * the update partition of the counter is incremented. This will
362 * allow the updater to update the counter atomically.
363 *
364 * The counter is 20 bits, and the state data is 12.
365 */
366#define RB_WRITE_MASK 0xfffff
367#define RB_WRITE_INTCNT (1 << 20)
368
Steven Rostedt044fa782008-12-02 23:50:03 -0500369static void rb_init_page(struct buffer_data_page *bpage)
Steven Rostedtabc9b562008-12-02 15:34:06 -0500370{
Steven Rostedt044fa782008-12-02 23:50:03 -0500371 local_set(&bpage->commit, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500372}
373
Steven Rostedt474d32b2009-03-03 19:51:40 -0500374/**
375 * ring_buffer_page_len - the size of data on the page.
376 * @page: The page to read
377 *
378 * Returns the amount of data on the page, including buffer page header.
379 */
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500380size_t ring_buffer_page_len(void *page)
381{
Steven Rostedt474d32b2009-03-03 19:51:40 -0500382 return local_read(&((struct buffer_data_page *)page)->commit)
383 + BUF_PAGE_HDR_SIZE;
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500384}
385
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400386/*
Steven Rostedted568292008-09-29 23:02:40 -0400387 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
388 * this issue out.
389 */
Andrew Morton34a148b2009-01-09 12:27:09 -0800390static void free_buffer_page(struct buffer_page *bpage)
Steven Rostedted568292008-09-29 23:02:40 -0400391{
Andrew Morton34a148b2009-01-09 12:27:09 -0800392 free_page((unsigned long)bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400393 kfree(bpage);
Steven Rostedted568292008-09-29 23:02:40 -0400394}
395
396/*
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400397 * We need to fit the time_stamp delta into 27 bits.
398 */
399static inline int test_time_stamp(u64 delta)
400{
401 if (delta & TS_DELTA_TEST)
402 return 1;
403 return 0;
404}
405
Steven Rostedt474d32b2009-03-03 19:51:40 -0500406#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400407
Steven Rostedtbe957c42009-05-11 14:42:53 -0400408/* Max payload is BUF_PAGE_SIZE - header (8bytes) */
409#define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))
410
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400411int ring_buffer_print_page_header(struct trace_seq *s)
412{
413 struct buffer_data_page field;
414 int ret;
415
416 ret = trace_seq_printf(s, "\tfield: u64 timestamp;\t"
Tom Zanussi26a50742009-10-06 01:09:50 -0500417 "offset:0;\tsize:%u;\tsigned:%u;\n",
418 (unsigned int)sizeof(field.time_stamp),
419 (unsigned int)is_signed_type(u64));
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400420
421 ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
Tom Zanussi26a50742009-10-06 01:09:50 -0500422 "offset:%u;\tsize:%u;\tsigned:%u;\n",
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400423 (unsigned int)offsetof(typeof(field), commit),
Tom Zanussi26a50742009-10-06 01:09:50 -0500424 (unsigned int)sizeof(field.commit),
425 (unsigned int)is_signed_type(long));
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400426
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400427 ret = trace_seq_printf(s, "\tfield: int overwrite;\t"
428 "offset:%u;\tsize:%u;\tsigned:%u;\n",
429 (unsigned int)offsetof(typeof(field), commit),
430 1,
431 (unsigned int)is_signed_type(long));
432
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400433 ret = trace_seq_printf(s, "\tfield: char data;\t"
Tom Zanussi26a50742009-10-06 01:09:50 -0500434 "offset:%u;\tsize:%u;\tsigned:%u;\n",
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400435 (unsigned int)offsetof(typeof(field), data),
Tom Zanussi26a50742009-10-06 01:09:50 -0500436 (unsigned int)BUF_PAGE_SIZE,
437 (unsigned int)is_signed_type(char));
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400438
439 return ret;
440}
441
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400442/*
443 * head_page == tail_page && head == tail then buffer is empty.
444 */
445struct ring_buffer_per_cpu {
446 int cpu;
Richard Kennedy985023d2010-03-25 11:27:36 +0000447 atomic_t record_disabled;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400448 struct ring_buffer *buffer;
Thomas Gleixner5389f6f2009-07-25 17:13:33 +0200449 raw_spinlock_t reader_lock; /* serialize readers */
Thomas Gleixner445c8952009-12-02 19:49:50 +0100450 arch_spinlock_t lock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400451 struct lock_class_key lock_key;
Steven Rostedt3adc54f2009-03-30 15:32:01 -0400452 struct list_head *pages;
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400453 struct buffer_page *head_page; /* read from head */
454 struct buffer_page *tail_page; /* write to tail */
Wenji Huangc3706f02009-02-10 01:03:18 -0500455 struct buffer_page *commit_page; /* committed pages */
Steven Rostedtd7690412008-10-01 00:29:53 -0400456 struct buffer_page *reader_page;
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400457 unsigned long lost_events;
458 unsigned long last_overrun;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -0700459 local_t entries_bytes;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400460 local_t commit_overrun;
461 local_t overrun;
Steven Rostedte4906ef2009-04-30 20:49:44 -0400462 local_t entries;
Steven Rostedtfa743952009-06-16 12:37:57 -0400463 local_t committing;
464 local_t commits;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400465 unsigned long read;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -0700466 unsigned long read_bytes;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400467 u64 write_stamp;
468 u64 read_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400469};
470
471struct ring_buffer {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400472 unsigned pages;
473 unsigned flags;
474 int cpus;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400475 atomic_t record_disabled;
Arnaldo Carvalho de Melo00f62f62009-02-09 17:04:06 -0200476 cpumask_var_t cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400477
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200478 struct lock_class_key *reader_lock_key;
479
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400480 struct mutex mutex;
481
482 struct ring_buffer_per_cpu **buffers;
Steven Rostedt554f7862009-03-11 22:00:13 -0400483
Steven Rostedt59222ef2009-03-12 11:46:03 -0400484#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400485 struct notifier_block cpu_notify;
486#endif
Steven Rostedt37886f62009-03-17 17:22:06 -0400487 u64 (*clock)(void);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400488};
489
490struct ring_buffer_iter {
491 struct ring_buffer_per_cpu *cpu_buffer;
492 unsigned long head;
493 struct buffer_page *head_page;
Steven Rostedt492a74f2010-01-25 15:17:47 -0500494 struct buffer_page *cache_reader_page;
495 unsigned long cache_read;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400496 u64 read_stamp;
497};
498
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500499/* buffer may be either ring_buffer or ring_buffer_per_cpu */
Steven Rostedt077c5402009-09-03 19:53:46 -0400500#define RB_WARN_ON(b, cond) \
501 ({ \
502 int _____ret = unlikely(cond); \
503 if (_____ret) { \
504 if (__same_type(*(b), struct ring_buffer_per_cpu)) { \
505 struct ring_buffer_per_cpu *__b = \
506 (void *)b; \
507 atomic_inc(&__b->buffer->record_disabled); \
508 } else \
509 atomic_inc(&b->record_disabled); \
510 WARN_ON(1); \
511 } \
512 _____ret; \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500513 })
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500514
Steven Rostedt37886f62009-03-17 17:22:06 -0400515/* Up this if you want to test the TIME_EXTENTS and normalization */
516#define DEBUG_SHIFT 0
517
Jiri Olsa6d3f1e12009-10-23 19:36:19 -0400518static inline u64 rb_time_stamp(struct ring_buffer *buffer)
Steven Rostedt88eb0122009-05-11 16:28:23 -0400519{
520 /* shift to debug/test normalization and TIME_EXTENTS */
521 return buffer->clock() << DEBUG_SHIFT;
522}
523
Steven Rostedt37886f62009-03-17 17:22:06 -0400524u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
525{
526 u64 time;
527
528 preempt_disable_notrace();
Jiri Olsa6d3f1e12009-10-23 19:36:19 -0400529 time = rb_time_stamp(buffer);
Steven Rostedt37886f62009-03-17 17:22:06 -0400530 preempt_enable_no_resched_notrace();
531
532 return time;
533}
534EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
535
536void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
537 int cpu, u64 *ts)
538{
539 /* Just stupid testing the normalize function and deltas */
540 *ts >>= DEBUG_SHIFT;
541}
542EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
543
Steven Rostedt77ae3652009-03-27 11:00:29 -0400544/*
545 * Making the ring buffer lockless makes things tricky.
546 * Although writes only happen on the CPU that they are on,
547 * and they only need to worry about interrupts. Reads can
548 * happen on any CPU.
549 *
550 * The reader page is always off the ring buffer, but when the
551 * reader finishes with a page, it needs to swap its page with
552 * a new one from the buffer. The reader needs to take from
553 * the head (writes go to the tail). But if a writer is in overwrite
554 * mode and wraps, it must push the head page forward.
555 *
556 * Here lies the problem.
557 *
558 * The reader must be careful to replace only the head page, and
559 * not another one. As described at the top of the file in the
560 * ASCII art, the reader sets its old page to point to the next
561 * page after head. It then sets the page after head to point to
562 * the old reader page. But if the writer moves the head page
563 * during this operation, the reader could end up with the tail.
564 *
565 * We use cmpxchg to help prevent this race. We also do something
566 * special with the page before head. We set the LSB to 1.
567 *
568 * When the writer must push the page forward, it will clear the
569 * bit that points to the head page, move the head, and then set
570 * the bit that points to the new head page.
571 *
572 * We also don't want an interrupt coming in and moving the head
573 * page on another writer. Thus we use the second LSB to catch
574 * that too. Thus:
575 *
576 * head->list->prev->next bit 1 bit 0
577 * ------- -------
578 * Normal page 0 0
579 * Points to head page 0 1
580 * New head page 1 0
581 *
582 * Note we can not trust the prev pointer of the head page, because:
583 *
584 * +----+ +-----+ +-----+
585 * | |------>| T |---X--->| N |
586 * | |<------| | | |
587 * +----+ +-----+ +-----+
588 * ^ ^ |
589 * | +-----+ | |
590 * +----------| R |----------+ |
591 * | |<-----------+
592 * +-----+
593 *
594 * Key: ---X--> HEAD flag set in pointer
595 * T Tail page
596 * R Reader page
597 * N Next page
598 *
599 * (see __rb_reserve_next() to see where this happens)
600 *
601 * What the above shows is that the reader just swapped out
602 * the reader page with a page in the buffer, but before it
603 * could make the new header point back to the new page added
604 * it was preempted by a writer. The writer moved forward onto
605 * the new page added by the reader and is about to move forward
606 * again.
607 *
608 * You can see, it is legitimate for the previous pointer of
609 * the head (or any page) not to point back to itself. But only
610 * temporarially.
611 */
612
613#define RB_PAGE_NORMAL 0UL
614#define RB_PAGE_HEAD 1UL
615#define RB_PAGE_UPDATE 2UL
616
617
618#define RB_FLAG_MASK 3UL
619
620/* PAGE_MOVED is not part of the mask */
621#define RB_PAGE_MOVED 4UL
622
623/*
624 * rb_list_head - remove any bit
625 */
626static struct list_head *rb_list_head(struct list_head *list)
627{
628 unsigned long val = (unsigned long)list;
629
630 return (struct list_head *)(val & ~RB_FLAG_MASK);
631}
632
633/*
Jiri Olsa6d3f1e12009-10-23 19:36:19 -0400634 * rb_is_head_page - test if the given page is the head page
Steven Rostedt77ae3652009-03-27 11:00:29 -0400635 *
636 * Because the reader may move the head_page pointer, we can
637 * not trust what the head page is (it may be pointing to
638 * the reader page). But if the next page is a header page,
639 * its flags will be non zero.
640 */
Jesper Juhl42b16b32011-01-17 00:09:38 +0100641static inline int
Steven Rostedt77ae3652009-03-27 11:00:29 -0400642rb_is_head_page(struct ring_buffer_per_cpu *cpu_buffer,
643 struct buffer_page *page, struct list_head *list)
644{
645 unsigned long val;
646
647 val = (unsigned long)list->next;
648
649 if ((val & ~RB_FLAG_MASK) != (unsigned long)&page->list)
650 return RB_PAGE_MOVED;
651
652 return val & RB_FLAG_MASK;
653}
654
655/*
656 * rb_is_reader_page
657 *
658 * The unique thing about the reader page, is that, if the
659 * writer is ever on it, the previous pointer never points
660 * back to the reader page.
661 */
662static int rb_is_reader_page(struct buffer_page *page)
663{
664 struct list_head *list = page->list.prev;
665
666 return rb_list_head(list->next) != &page->list;
667}
668
669/*
670 * rb_set_list_to_head - set a list_head to be pointing to head.
671 */
672static void rb_set_list_to_head(struct ring_buffer_per_cpu *cpu_buffer,
673 struct list_head *list)
674{
675 unsigned long *ptr;
676
677 ptr = (unsigned long *)&list->next;
678 *ptr |= RB_PAGE_HEAD;
679 *ptr &= ~RB_PAGE_UPDATE;
680}
681
682/*
683 * rb_head_page_activate - sets up head page
684 */
685static void rb_head_page_activate(struct ring_buffer_per_cpu *cpu_buffer)
686{
687 struct buffer_page *head;
688
689 head = cpu_buffer->head_page;
690 if (!head)
691 return;
692
693 /*
694 * Set the previous list pointer to have the HEAD flag.
695 */
696 rb_set_list_to_head(cpu_buffer, head->list.prev);
697}
698
699static void rb_list_head_clear(struct list_head *list)
700{
701 unsigned long *ptr = (unsigned long *)&list->next;
702
703 *ptr &= ~RB_FLAG_MASK;
704}
705
706/*
707 * rb_head_page_dactivate - clears head page ptr (for free list)
708 */
709static void
710rb_head_page_deactivate(struct ring_buffer_per_cpu *cpu_buffer)
711{
712 struct list_head *hd;
713
714 /* Go through the whole list and clear any pointers found. */
715 rb_list_head_clear(cpu_buffer->pages);
716
717 list_for_each(hd, cpu_buffer->pages)
718 rb_list_head_clear(hd);
719}
720
721static int rb_head_page_set(struct ring_buffer_per_cpu *cpu_buffer,
722 struct buffer_page *head,
723 struct buffer_page *prev,
724 int old_flag, int new_flag)
725{
726 struct list_head *list;
727 unsigned long val = (unsigned long)&head->list;
728 unsigned long ret;
729
730 list = &prev->list;
731
732 val &= ~RB_FLAG_MASK;
733
Steven Rostedt08a40812009-09-14 09:31:35 -0400734 ret = cmpxchg((unsigned long *)&list->next,
735 val | old_flag, val | new_flag);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400736
737 /* check if the reader took the page */
738 if ((ret & ~RB_FLAG_MASK) != val)
739 return RB_PAGE_MOVED;
740
741 return ret & RB_FLAG_MASK;
742}
743
744static int rb_head_page_set_update(struct ring_buffer_per_cpu *cpu_buffer,
745 struct buffer_page *head,
746 struct buffer_page *prev,
747 int old_flag)
748{
749 return rb_head_page_set(cpu_buffer, head, prev,
750 old_flag, RB_PAGE_UPDATE);
751}
752
753static int rb_head_page_set_head(struct ring_buffer_per_cpu *cpu_buffer,
754 struct buffer_page *head,
755 struct buffer_page *prev,
756 int old_flag)
757{
758 return rb_head_page_set(cpu_buffer, head, prev,
759 old_flag, RB_PAGE_HEAD);
760}
761
762static int rb_head_page_set_normal(struct ring_buffer_per_cpu *cpu_buffer,
763 struct buffer_page *head,
764 struct buffer_page *prev,
765 int old_flag)
766{
767 return rb_head_page_set(cpu_buffer, head, prev,
768 old_flag, RB_PAGE_NORMAL);
769}
770
771static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
772 struct buffer_page **bpage)
773{
774 struct list_head *p = rb_list_head((*bpage)->list.next);
775
776 *bpage = list_entry(p, struct buffer_page, list);
777}
778
779static struct buffer_page *
780rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer)
781{
782 struct buffer_page *head;
783 struct buffer_page *page;
784 struct list_head *list;
785 int i;
786
787 if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page))
788 return NULL;
789
790 /* sanity check */
791 list = cpu_buffer->pages;
792 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev->next) != list))
793 return NULL;
794
795 page = head = cpu_buffer->head_page;
796 /*
797 * It is possible that the writer moves the header behind
798 * where we started, and we miss in one loop.
799 * A second loop should grab the header, but we'll do
800 * three loops just because I'm paranoid.
801 */
802 for (i = 0; i < 3; i++) {
803 do {
804 if (rb_is_head_page(cpu_buffer, page, page->list.prev)) {
805 cpu_buffer->head_page = page;
806 return page;
807 }
808 rb_inc_page(cpu_buffer, &page);
809 } while (page != head);
810 }
811
812 RB_WARN_ON(cpu_buffer, 1);
813
814 return NULL;
815}
816
817static int rb_head_page_replace(struct buffer_page *old,
818 struct buffer_page *new)
819{
820 unsigned long *ptr = (unsigned long *)&old->list.prev->next;
821 unsigned long val;
822 unsigned long ret;
823
824 val = *ptr & ~RB_FLAG_MASK;
825 val |= RB_PAGE_HEAD;
826
Steven Rostedt08a40812009-09-14 09:31:35 -0400827 ret = cmpxchg(ptr, val, (unsigned long)&new->list);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400828
829 return ret == val;
830}
831
832/*
833 * rb_tail_page_update - move the tail page forward
834 *
835 * Returns 1 if moved tail page, 0 if someone else did.
836 */
837static int rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer,
838 struct buffer_page *tail_page,
839 struct buffer_page *next_page)
840{
841 struct buffer_page *old_tail;
842 unsigned long old_entries;
843 unsigned long old_write;
844 int ret = 0;
845
846 /*
847 * The tail page now needs to be moved forward.
848 *
849 * We need to reset the tail page, but without messing
850 * with possible erasing of data brought in by interrupts
851 * that have moved the tail page and are currently on it.
852 *
853 * We add a counter to the write field to denote this.
854 */
855 old_write = local_add_return(RB_WRITE_INTCNT, &next_page->write);
856 old_entries = local_add_return(RB_WRITE_INTCNT, &next_page->entries);
857
858 /*
859 * Just make sure we have seen our old_write and synchronize
860 * with any interrupts that come in.
861 */
862 barrier();
863
864 /*
865 * If the tail page is still the same as what we think
866 * it is, then it is up to us to update the tail
867 * pointer.
868 */
869 if (tail_page == cpu_buffer->tail_page) {
870 /* Zero the write counter */
871 unsigned long val = old_write & ~RB_WRITE_MASK;
872 unsigned long eval = old_entries & ~RB_WRITE_MASK;
873
874 /*
875 * This will only succeed if an interrupt did
876 * not come in and change it. In which case, we
877 * do not want to modify it.
Lai Jiangshanda706d82009-07-15 16:27:30 +0800878 *
879 * We add (void) to let the compiler know that we do not care
880 * about the return value of these functions. We use the
881 * cmpxchg to only update if an interrupt did not already
882 * do it for us. If the cmpxchg fails, we don't care.
Steven Rostedt77ae3652009-03-27 11:00:29 -0400883 */
Lai Jiangshanda706d82009-07-15 16:27:30 +0800884 (void)local_cmpxchg(&next_page->write, old_write, val);
885 (void)local_cmpxchg(&next_page->entries, old_entries, eval);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400886
887 /*
888 * No need to worry about races with clearing out the commit.
889 * it only can increment when a commit takes place. But that
890 * only happens in the outer most nested commit.
891 */
892 local_set(&next_page->page->commit, 0);
893
894 old_tail = cmpxchg(&cpu_buffer->tail_page,
895 tail_page, next_page);
896
897 if (old_tail == tail_page)
898 ret = 1;
899 }
900
901 return ret;
902}
903
904static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer,
905 struct buffer_page *bpage)
906{
907 unsigned long val = (unsigned long)bpage;
908
909 if (RB_WARN_ON(cpu_buffer, val & RB_FLAG_MASK))
910 return 1;
911
912 return 0;
913}
914
915/**
916 * rb_check_list - make sure a pointer to a list has the last bits zero
917 */
918static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
919 struct list_head *list)
920{
921 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev) != list->prev))
922 return 1;
923 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->next) != list->next))
924 return 1;
925 return 0;
926}
927
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400928/**
929 * check_pages - integrity check of buffer pages
930 * @cpu_buffer: CPU buffer with pages to test
931 *
Wenji Huangc3706f02009-02-10 01:03:18 -0500932 * As a safety measure we check to make sure the data pages have not
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400933 * been corrupted.
934 */
935static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
936{
Steven Rostedt3adc54f2009-03-30 15:32:01 -0400937 struct list_head *head = cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500938 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400939
Steven Rostedt77ae3652009-03-27 11:00:29 -0400940 rb_head_page_deactivate(cpu_buffer);
941
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500942 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
943 return -1;
944 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
945 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400946
Steven Rostedt77ae3652009-03-27 11:00:29 -0400947 if (rb_check_list(cpu_buffer, head))
948 return -1;
949
Steven Rostedt044fa782008-12-02 23:50:03 -0500950 list_for_each_entry_safe(bpage, tmp, head, list) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500951 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500952 bpage->list.next->prev != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500953 return -1;
954 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500955 bpage->list.prev->next != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500956 return -1;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400957 if (rb_check_list(cpu_buffer, &bpage->list))
958 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400959 }
960
Steven Rostedt77ae3652009-03-27 11:00:29 -0400961 rb_head_page_activate(cpu_buffer);
962
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400963 return 0;
964}
965
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400966static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
967 unsigned nr_pages)
968{
Steven Rostedt044fa782008-12-02 23:50:03 -0500969 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400970 LIST_HEAD(pages);
971 unsigned i;
972
Steven Rostedt3adc54f2009-03-30 15:32:01 -0400973 WARN_ON(!nr_pages);
974
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400975 for (i = 0; i < nr_pages; i++) {
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -0700976 struct page *page;
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -0700977 /*
978 * __GFP_NORETRY flag makes sure that the allocation fails
979 * gracefully without invoking oom-killer and the system is
980 * not destabilized.
981 */
Steven Rostedt044fa782008-12-02 23:50:03 -0500982 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -0700983 GFP_KERNEL | __GFP_NORETRY,
984 cpu_to_node(cpu_buffer->cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500985 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400986 goto free_pages;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400987
988 rb_check_bpage(cpu_buffer, bpage);
989
Steven Rostedt044fa782008-12-02 23:50:03 -0500990 list_add(&bpage->list, &pages);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400991
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -0700992 page = alloc_pages_node(cpu_to_node(cpu_buffer->cpu),
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -0700993 GFP_KERNEL | __GFP_NORETRY, 0);
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -0700994 if (!page)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400995 goto free_pages;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -0700996 bpage->page = page_address(page);
Steven Rostedt044fa782008-12-02 23:50:03 -0500997 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400998 }
999
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001000 /*
1001 * The ring buffer page list is a circular list that does not
1002 * start and end with a list head. All page list items point to
1003 * other pages.
1004 */
1005 cpu_buffer->pages = pages.next;
1006 list_del(&pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001007
1008 rb_check_pages(cpu_buffer);
1009
1010 return 0;
1011
1012 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -05001013 list_for_each_entry_safe(bpage, tmp, &pages, list) {
1014 list_del_init(&bpage->list);
1015 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001016 }
1017 return -ENOMEM;
1018}
1019
1020static struct ring_buffer_per_cpu *
1021rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
1022{
1023 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt044fa782008-12-02 23:50:03 -05001024 struct buffer_page *bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001025 struct page *page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001026 int ret;
1027
1028 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
1029 GFP_KERNEL, cpu_to_node(cpu));
1030 if (!cpu_buffer)
1031 return NULL;
1032
1033 cpu_buffer->cpu = cpu;
1034 cpu_buffer->buffer = buffer;
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001035 raw_spin_lock_init(&cpu_buffer->reader_lock);
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001036 lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
Thomas Gleixneredc35bd2009-12-03 12:38:57 +01001037 cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001038
Steven Rostedt044fa782008-12-02 23:50:03 -05001039 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001040 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -05001041 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001042 goto fail_free_buffer;
1043
Steven Rostedt77ae3652009-03-27 11:00:29 -04001044 rb_check_bpage(cpu_buffer, bpage);
1045
Steven Rostedt044fa782008-12-02 23:50:03 -05001046 cpu_buffer->reader_page = bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001047 page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
1048 if (!page)
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001049 goto fail_free_reader;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001050 bpage->page = page_address(page);
Steven Rostedt044fa782008-12-02 23:50:03 -05001051 rb_init_page(bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001052
Steven Rostedtd7690412008-10-01 00:29:53 -04001053 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -04001054
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001055 ret = rb_allocate_pages(cpu_buffer, buffer->pages);
1056 if (ret < 0)
Steven Rostedtd7690412008-10-01 00:29:53 -04001057 goto fail_free_reader;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001058
1059 cpu_buffer->head_page
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001060 = list_entry(cpu_buffer->pages, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001061 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001062
Steven Rostedt77ae3652009-03-27 11:00:29 -04001063 rb_head_page_activate(cpu_buffer);
1064
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001065 return cpu_buffer;
1066
Steven Rostedtd7690412008-10-01 00:29:53 -04001067 fail_free_reader:
1068 free_buffer_page(cpu_buffer->reader_page);
1069
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001070 fail_free_buffer:
1071 kfree(cpu_buffer);
1072 return NULL;
1073}
1074
1075static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
1076{
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001077 struct list_head *head = cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -05001078 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001079
Steven Rostedtd7690412008-10-01 00:29:53 -04001080 free_buffer_page(cpu_buffer->reader_page);
1081
Steven Rostedt77ae3652009-03-27 11:00:29 -04001082 rb_head_page_deactivate(cpu_buffer);
1083
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001084 if (head) {
1085 list_for_each_entry_safe(bpage, tmp, head, list) {
1086 list_del_init(&bpage->list);
1087 free_buffer_page(bpage);
1088 }
1089 bpage = list_entry(head, struct buffer_page, list);
Steven Rostedt044fa782008-12-02 23:50:03 -05001090 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001091 }
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001092
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001093 kfree(cpu_buffer);
1094}
1095
Steven Rostedt59222ef2009-03-12 11:46:03 -04001096#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01001097static int rb_cpu_notify(struct notifier_block *self,
1098 unsigned long action, void *hcpu);
Steven Rostedt554f7862009-03-11 22:00:13 -04001099#endif
1100
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001101/**
1102 * ring_buffer_alloc - allocate a new ring_buffer
Robert Richter68814b52008-11-24 12:24:12 +01001103 * @size: the size in bytes per cpu that is needed.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001104 * @flags: attributes to set for the ring buffer.
1105 *
1106 * Currently the only flag that is available is the RB_FL_OVERWRITE
1107 * flag. This flag means that the buffer will overwrite old data
1108 * when the buffer wraps. If this flag is not set, the buffer will
1109 * drop data when the tail hits the head.
1110 */
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001111struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
1112 struct lock_class_key *key)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001113{
1114 struct ring_buffer *buffer;
1115 int bsize;
1116 int cpu;
1117
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001118 /* keep it in its own cache line */
1119 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
1120 GFP_KERNEL);
1121 if (!buffer)
1122 return NULL;
1123
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301124 if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
1125 goto fail_free_buffer;
1126
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001127 buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1128 buffer->flags = flags;
Steven Rostedt37886f62009-03-17 17:22:06 -04001129 buffer->clock = trace_clock_local;
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001130 buffer->reader_lock_key = key;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001131
1132 /* need at least two pages */
Steven Rostedt5f78abe2009-06-17 14:11:10 -04001133 if (buffer->pages < 2)
1134 buffer->pages = 2;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001135
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +01001136 /*
1137 * In case of non-hotplug cpu, if the ring-buffer is allocated
1138 * in early initcall, it will not be notified of secondary cpus.
1139 * In that off case, we need to allocate for all possible cpus.
1140 */
1141#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -04001142 get_online_cpus();
1143 cpumask_copy(buffer->cpumask, cpu_online_mask);
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +01001144#else
1145 cpumask_copy(buffer->cpumask, cpu_possible_mask);
1146#endif
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001147 buffer->cpus = nr_cpu_ids;
1148
1149 bsize = sizeof(void *) * nr_cpu_ids;
1150 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
1151 GFP_KERNEL);
1152 if (!buffer->buffers)
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301153 goto fail_free_cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001154
1155 for_each_buffer_cpu(buffer, cpu) {
1156 buffer->buffers[cpu] =
1157 rb_allocate_cpu_buffer(buffer, cpu);
1158 if (!buffer->buffers[cpu])
1159 goto fail_free_buffers;
1160 }
1161
Steven Rostedt59222ef2009-03-12 11:46:03 -04001162#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -04001163 buffer->cpu_notify.notifier_call = rb_cpu_notify;
1164 buffer->cpu_notify.priority = 0;
1165 register_cpu_notifier(&buffer->cpu_notify);
1166#endif
1167
1168 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001169 mutex_init(&buffer->mutex);
1170
1171 return buffer;
1172
1173 fail_free_buffers:
1174 for_each_buffer_cpu(buffer, cpu) {
1175 if (buffer->buffers[cpu])
1176 rb_free_cpu_buffer(buffer->buffers[cpu]);
1177 }
1178 kfree(buffer->buffers);
1179
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301180 fail_free_cpumask:
1181 free_cpumask_var(buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -04001182 put_online_cpus();
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301183
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001184 fail_free_buffer:
1185 kfree(buffer);
1186 return NULL;
1187}
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001188EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001189
1190/**
1191 * ring_buffer_free - free a ring buffer.
1192 * @buffer: the buffer to free.
1193 */
1194void
1195ring_buffer_free(struct ring_buffer *buffer)
1196{
1197 int cpu;
1198
Steven Rostedt554f7862009-03-11 22:00:13 -04001199 get_online_cpus();
1200
Steven Rostedt59222ef2009-03-12 11:46:03 -04001201#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -04001202 unregister_cpu_notifier(&buffer->cpu_notify);
1203#endif
1204
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001205 for_each_buffer_cpu(buffer, cpu)
1206 rb_free_cpu_buffer(buffer->buffers[cpu]);
1207
Steven Rostedt554f7862009-03-11 22:00:13 -04001208 put_online_cpus();
1209
Eric Dumazetbd3f0222009-08-07 12:49:29 +02001210 kfree(buffer->buffers);
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301211 free_cpumask_var(buffer->cpumask);
1212
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001213 kfree(buffer);
1214}
Robert Richterc4f50182008-12-11 16:49:22 +01001215EXPORT_SYMBOL_GPL(ring_buffer_free);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001216
Steven Rostedt37886f62009-03-17 17:22:06 -04001217void ring_buffer_set_clock(struct ring_buffer *buffer,
1218 u64 (*clock)(void))
1219{
1220 buffer->clock = clock;
1221}
1222
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001223static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
1224
1225static void
1226rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
1227{
Steven Rostedt044fa782008-12-02 23:50:03 -05001228 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001229 struct list_head *p;
1230 unsigned i;
1231
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001232 raw_spin_lock_irq(&cpu_buffer->reader_lock);
Steven Rostedt77ae3652009-03-27 11:00:29 -04001233 rb_head_page_deactivate(cpu_buffer);
1234
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001235 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001236 if (RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages)))
Julia Lawall292f60c2010-03-29 17:37:02 +02001237 goto out;
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001238 p = cpu_buffer->pages->next;
Steven Rostedt044fa782008-12-02 23:50:03 -05001239 bpage = list_entry(p, struct buffer_page, list);
1240 list_del_init(&bpage->list);
1241 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001242 }
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001243 if (RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages)))
Julia Lawall292f60c2010-03-29 17:37:02 +02001244 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001245
1246 rb_reset_cpu(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001247 rb_check_pages(cpu_buffer);
1248
Julia Lawall292f60c2010-03-29 17:37:02 +02001249out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001250 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001251}
1252
1253static void
1254rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
1255 struct list_head *pages, unsigned nr_pages)
1256{
Steven Rostedt044fa782008-12-02 23:50:03 -05001257 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001258 struct list_head *p;
1259 unsigned i;
1260
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001261 raw_spin_lock_irq(&cpu_buffer->reader_lock);
Steven Rostedt77ae3652009-03-27 11:00:29 -04001262 rb_head_page_deactivate(cpu_buffer);
1263
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001264 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001265 if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
Julia Lawall292f60c2010-03-29 17:37:02 +02001266 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001267 p = pages->next;
Steven Rostedt044fa782008-12-02 23:50:03 -05001268 bpage = list_entry(p, struct buffer_page, list);
1269 list_del_init(&bpage->list);
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001270 list_add_tail(&bpage->list, cpu_buffer->pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001271 }
1272 rb_reset_cpu(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001273 rb_check_pages(cpu_buffer);
1274
Julia Lawall292f60c2010-03-29 17:37:02 +02001275out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001276 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001277}
1278
1279/**
1280 * ring_buffer_resize - resize the ring buffer
1281 * @buffer: the buffer to resize.
1282 * @size: the new size.
1283 *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001284 * Minimum size is 2 * BUF_PAGE_SIZE.
1285 *
1286 * Returns -1 on failure.
1287 */
1288int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
1289{
1290 struct ring_buffer_per_cpu *cpu_buffer;
1291 unsigned nr_pages, rm_pages, new_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -05001292 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001293 unsigned long buffer_size;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001294 LIST_HEAD(pages);
1295 int i, cpu;
1296
Ingo Molnaree51a1d2008-11-13 14:58:31 +01001297 /*
1298 * Always succeed at resizing a non-existent buffer:
1299 */
1300 if (!buffer)
1301 return size;
1302
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001303 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1304 size *= BUF_PAGE_SIZE;
1305 buffer_size = buffer->pages * BUF_PAGE_SIZE;
1306
1307 /* we need a minimum of two pages */
1308 if (size < BUF_PAGE_SIZE * 2)
1309 size = BUF_PAGE_SIZE * 2;
1310
1311 if (size == buffer_size)
1312 return size;
1313
Steven Rostedt18421012009-12-10 22:54:27 -05001314 atomic_inc(&buffer->record_disabled);
1315
1316 /* Make sure all writers are done with this buffer. */
1317 synchronize_sched();
1318
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001319 mutex_lock(&buffer->mutex);
Steven Rostedt554f7862009-03-11 22:00:13 -04001320 get_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001321
1322 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1323
1324 if (size < buffer_size) {
1325
1326 /* easy case, just free pages */
Steven Rostedt554f7862009-03-11 22:00:13 -04001327 if (RB_WARN_ON(buffer, nr_pages >= buffer->pages))
1328 goto out_fail;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001329
1330 rm_pages = buffer->pages - nr_pages;
1331
1332 for_each_buffer_cpu(buffer, cpu) {
1333 cpu_buffer = buffer->buffers[cpu];
1334 rb_remove_pages(cpu_buffer, rm_pages);
1335 }
1336 goto out;
1337 }
1338
1339 /*
1340 * This is a bit more difficult. We only want to add pages
1341 * when we can allocate enough for all CPUs. We do this
1342 * by allocating all the pages and storing them on a local
1343 * link list. If we succeed in our allocation, then we
1344 * add these pages to the cpu_buffers. Otherwise we just free
1345 * them all and return -ENOMEM;
1346 */
Steven Rostedt554f7862009-03-11 22:00:13 -04001347 if (RB_WARN_ON(buffer, nr_pages <= buffer->pages))
1348 goto out_fail;
Steven Rostedtf536aaf2008-11-10 23:07:30 -05001349
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001350 new_pages = nr_pages - buffer->pages;
1351
1352 for_each_buffer_cpu(buffer, cpu) {
1353 for (i = 0; i < new_pages; i++) {
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001354 struct page *page;
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001355 /*
1356 * __GFP_NORETRY flag makes sure that the allocation
1357 * fails gracefully without invoking oom-killer and
1358 * the system is not destabilized.
1359 */
Steven Rostedt044fa782008-12-02 23:50:03 -05001360 bpage = kzalloc_node(ALIGN(sizeof(*bpage),
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001361 cache_line_size()),
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001362 GFP_KERNEL | __GFP_NORETRY,
1363 cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -05001364 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001365 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -05001366 list_add(&bpage->list, &pages);
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001367 page = alloc_pages_node(cpu_to_node(cpu),
1368 GFP_KERNEL | __GFP_NORETRY, 0);
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001369 if (!page)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001370 goto free_pages;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001371 bpage->page = page_address(page);
Steven Rostedt044fa782008-12-02 23:50:03 -05001372 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001373 }
1374 }
1375
1376 for_each_buffer_cpu(buffer, cpu) {
1377 cpu_buffer = buffer->buffers[cpu];
1378 rb_insert_pages(cpu_buffer, &pages, new_pages);
1379 }
1380
Steven Rostedt554f7862009-03-11 22:00:13 -04001381 if (RB_WARN_ON(buffer, !list_empty(&pages)))
1382 goto out_fail;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001383
1384 out:
1385 buffer->pages = nr_pages;
Steven Rostedt554f7862009-03-11 22:00:13 -04001386 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001387 mutex_unlock(&buffer->mutex);
1388
Steven Rostedt18421012009-12-10 22:54:27 -05001389 atomic_dec(&buffer->record_disabled);
1390
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001391 return size;
1392
1393 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -05001394 list_for_each_entry_safe(bpage, tmp, &pages, list) {
1395 list_del_init(&bpage->list);
1396 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001397 }
Steven Rostedt554f7862009-03-11 22:00:13 -04001398 put_online_cpus();
Vegard Nossum641d2f62008-11-18 19:22:13 +01001399 mutex_unlock(&buffer->mutex);
Steven Rostedt18421012009-12-10 22:54:27 -05001400 atomic_dec(&buffer->record_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001401 return -ENOMEM;
Steven Rostedt554f7862009-03-11 22:00:13 -04001402
1403 /*
1404 * Something went totally wrong, and we are too paranoid
1405 * to even clean up the mess.
1406 */
1407 out_fail:
1408 put_online_cpus();
1409 mutex_unlock(&buffer->mutex);
Steven Rostedt18421012009-12-10 22:54:27 -05001410 atomic_dec(&buffer->record_disabled);
Steven Rostedt554f7862009-03-11 22:00:13 -04001411 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001412}
Robert Richterc4f50182008-12-11 16:49:22 +01001413EXPORT_SYMBOL_GPL(ring_buffer_resize);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001414
David Sharp750912f2010-12-08 13:46:47 -08001415void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
1416{
1417 mutex_lock(&buffer->mutex);
1418 if (val)
1419 buffer->flags |= RB_FL_OVERWRITE;
1420 else
1421 buffer->flags &= ~RB_FL_OVERWRITE;
1422 mutex_unlock(&buffer->mutex);
1423}
1424EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
1425
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001426static inline void *
Steven Rostedt044fa782008-12-02 23:50:03 -05001427__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001428{
Steven Rostedt044fa782008-12-02 23:50:03 -05001429 return bpage->data + index;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001430}
1431
Steven Rostedt044fa782008-12-02 23:50:03 -05001432static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001433{
Steven Rostedt044fa782008-12-02 23:50:03 -05001434 return bpage->page->data + index;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001435}
1436
1437static inline struct ring_buffer_event *
Steven Rostedtd7690412008-10-01 00:29:53 -04001438rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001439{
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001440 return __rb_page_index(cpu_buffer->reader_page,
1441 cpu_buffer->reader_page->read);
1442}
1443
1444static inline struct ring_buffer_event *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001445rb_iter_head_event(struct ring_buffer_iter *iter)
1446{
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001447 return __rb_page_index(iter->head_page, iter->head);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001448}
1449
Steven Rostedt77ae3652009-03-27 11:00:29 -04001450static inline unsigned long rb_page_write(struct buffer_page *bpage)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001451{
Steven Rostedt77ae3652009-03-27 11:00:29 -04001452 return local_read(&bpage->write) & RB_WRITE_MASK;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001453}
1454
1455static inline unsigned rb_page_commit(struct buffer_page *bpage)
1456{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001457 return local_read(&bpage->page->commit);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001458}
1459
Steven Rostedt77ae3652009-03-27 11:00:29 -04001460static inline unsigned long rb_page_entries(struct buffer_page *bpage)
1461{
1462 return local_read(&bpage->entries) & RB_WRITE_MASK;
1463}
1464
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001465/* Size is determined by what has been committed */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001466static inline unsigned rb_page_size(struct buffer_page *bpage)
1467{
1468 return rb_page_commit(bpage);
1469}
1470
1471static inline unsigned
1472rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
1473{
1474 return rb_page_commit(cpu_buffer->commit_page);
1475}
1476
Steven Rostedtbf41a152008-10-04 02:00:59 -04001477static inline unsigned
1478rb_event_index(struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001479{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001480 unsigned long addr = (unsigned long)event;
1481
Steven Rostedt22f470f2009-06-11 09:29:58 -04001482 return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001483}
1484
Steven Rostedt0f0c85f2009-05-11 16:08:00 -04001485static inline int
Steven Rostedtfa743952009-06-16 12:37:57 -04001486rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
1487 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001488{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001489 unsigned long addr = (unsigned long)event;
1490 unsigned long index;
1491
1492 index = rb_event_index(event);
1493 addr &= PAGE_MASK;
1494
1495 return cpu_buffer->commit_page->page == (void *)addr &&
1496 rb_commit_index(cpu_buffer) == index;
1497}
1498
Andrew Morton34a148b2009-01-09 12:27:09 -08001499static void
Steven Rostedtbf41a152008-10-04 02:00:59 -04001500rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
1501{
Steven Rostedt77ae3652009-03-27 11:00:29 -04001502 unsigned long max_count;
1503
Steven Rostedtbf41a152008-10-04 02:00:59 -04001504 /*
1505 * We only race with interrupts and NMIs on this CPU.
1506 * If we own the commit event, then we can commit
1507 * all others that interrupted us, since the interruptions
1508 * are in stack format (they finish before they come
1509 * back to us). This allows us to do a simple loop to
1510 * assign the commit to the tail.
1511 */
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001512 again:
Steven Rostedt77ae3652009-03-27 11:00:29 -04001513 max_count = cpu_buffer->buffer->pages * 100;
1514
Steven Rostedtbf41a152008-10-04 02:00:59 -04001515 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001516 if (RB_WARN_ON(cpu_buffer, !(--max_count)))
1517 return;
1518 if (RB_WARN_ON(cpu_buffer,
1519 rb_is_reader_page(cpu_buffer->tail_page)))
1520 return;
1521 local_set(&cpu_buffer->commit_page->page->commit,
1522 rb_page_write(cpu_buffer->commit_page));
Steven Rostedtbf41a152008-10-04 02:00:59 -04001523 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001524 cpu_buffer->write_stamp =
1525 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001526 /* add barrier to keep gcc from optimizing too much */
1527 barrier();
1528 }
1529 while (rb_commit_index(cpu_buffer) !=
1530 rb_page_write(cpu_buffer->commit_page)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001531
1532 local_set(&cpu_buffer->commit_page->page->commit,
1533 rb_page_write(cpu_buffer->commit_page));
1534 RB_WARN_ON(cpu_buffer,
1535 local_read(&cpu_buffer->commit_page->page->commit) &
1536 ~RB_WRITE_MASK);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001537 barrier();
1538 }
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001539
1540 /* again, keep gcc from optimizing */
1541 barrier();
1542
1543 /*
1544 * If an interrupt came in just after the first while loop
1545 * and pushed the tail page forward, we will be left with
1546 * a dangling commit that will never go forward.
1547 */
1548 if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
1549 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001550}
1551
Steven Rostedtd7690412008-10-01 00:29:53 -04001552static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001553{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001554 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001555 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04001556}
1557
Andrew Morton34a148b2009-01-09 12:27:09 -08001558static void rb_inc_iter(struct ring_buffer_iter *iter)
Steven Rostedtd7690412008-10-01 00:29:53 -04001559{
1560 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1561
1562 /*
1563 * The iterator could be on the reader page (it starts there).
1564 * But the head could have moved, since the reader was
1565 * found. Check for this case and assign the iterator
1566 * to the head page instead of next.
1567 */
1568 if (iter->head_page == cpu_buffer->reader_page)
Steven Rostedt77ae3652009-03-27 11:00:29 -04001569 iter->head_page = rb_set_head_page(cpu_buffer);
Steven Rostedtd7690412008-10-01 00:29:53 -04001570 else
1571 rb_inc_page(cpu_buffer, &iter->head_page);
1572
Steven Rostedtabc9b562008-12-02 15:34:06 -05001573 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001574 iter->head = 0;
1575}
1576
Steven Rostedt69d1b832010-10-07 18:18:05 -04001577/* Slow path, do not inline */
1578static noinline struct ring_buffer_event *
1579rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
1580{
1581 event->type_len = RINGBUF_TYPE_TIME_EXTEND;
1582
1583 /* Not the first event on the page? */
1584 if (rb_event_index(event)) {
1585 event->time_delta = delta & TS_MASK;
1586 event->array[0] = delta >> TS_SHIFT;
1587 } else {
1588 /* nope, just zero it */
1589 event->time_delta = 0;
1590 event->array[0] = 0;
1591 }
1592
1593 return skip_time_extend(event);
1594}
1595
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001596/**
1597 * ring_buffer_update_event - update event type and data
1598 * @event: the even to update
1599 * @type: the type of event
1600 * @length: the size of the event field in the ring buffer
1601 *
1602 * Update the type and data fields of the event. The length
1603 * is the actual size that is written to the ring buffer,
1604 * and with this, we can determine what to place into the
1605 * data field.
1606 */
Andrew Morton34a148b2009-01-09 12:27:09 -08001607static void
Steven Rostedt69d1b832010-10-07 18:18:05 -04001608rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
1609 struct ring_buffer_event *event, unsigned length,
1610 int add_timestamp, u64 delta)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001611{
Steven Rostedt69d1b832010-10-07 18:18:05 -04001612 /* Only a commit updates the timestamp */
1613 if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
1614 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001615
Steven Rostedt69d1b832010-10-07 18:18:05 -04001616 /*
1617 * If we need to add a timestamp, then we
1618 * add it to the start of the resevered space.
1619 */
1620 if (unlikely(add_timestamp)) {
1621 event = rb_add_time_stamp(event, delta);
1622 length -= RB_LEN_TIME_EXTEND;
1623 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001624 }
Steven Rostedt69d1b832010-10-07 18:18:05 -04001625
1626 event->time_delta = delta;
1627 length -= RB_EVNT_HDR_SIZE;
1628 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
1629 event->type_len = 0;
1630 event->array[0] = length;
1631 } else
1632 event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001633}
1634
Steven Rostedt77ae3652009-03-27 11:00:29 -04001635/*
1636 * rb_handle_head_page - writer hit the head page
1637 *
1638 * Returns: +1 to retry page
1639 * 0 to continue
1640 * -1 on error
1641 */
1642static int
1643rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
1644 struct buffer_page *tail_page,
1645 struct buffer_page *next_page)
1646{
1647 struct buffer_page *new_head;
1648 int entries;
1649 int type;
1650 int ret;
1651
1652 entries = rb_page_entries(next_page);
1653
1654 /*
1655 * The hard part is here. We need to move the head
1656 * forward, and protect against both readers on
1657 * other CPUs and writers coming in via interrupts.
1658 */
1659 type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
1660 RB_PAGE_HEAD);
1661
1662 /*
1663 * type can be one of four:
1664 * NORMAL - an interrupt already moved it for us
1665 * HEAD - we are the first to get here.
1666 * UPDATE - we are the interrupt interrupting
1667 * a current move.
1668 * MOVED - a reader on another CPU moved the next
1669 * pointer to its reader page. Give up
1670 * and try again.
1671 */
1672
1673 switch (type) {
1674 case RB_PAGE_HEAD:
1675 /*
1676 * We changed the head to UPDATE, thus
1677 * it is our responsibility to update
1678 * the counters.
1679 */
1680 local_add(entries, &cpu_buffer->overrun);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07001681 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
Steven Rostedt77ae3652009-03-27 11:00:29 -04001682
1683 /*
1684 * The entries will be zeroed out when we move the
1685 * tail page.
1686 */
1687
1688 /* still more to do */
1689 break;
1690
1691 case RB_PAGE_UPDATE:
1692 /*
1693 * This is an interrupt that interrupt the
1694 * previous update. Still more to do.
1695 */
1696 break;
1697 case RB_PAGE_NORMAL:
1698 /*
1699 * An interrupt came in before the update
1700 * and processed this for us.
1701 * Nothing left to do.
1702 */
1703 return 1;
1704 case RB_PAGE_MOVED:
1705 /*
1706 * The reader is on another CPU and just did
1707 * a swap with our next_page.
1708 * Try again.
1709 */
1710 return 1;
1711 default:
1712 RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
1713 return -1;
1714 }
1715
1716 /*
1717 * Now that we are here, the old head pointer is
1718 * set to UPDATE. This will keep the reader from
1719 * swapping the head page with the reader page.
1720 * The reader (on another CPU) will spin till
1721 * we are finished.
1722 *
1723 * We just need to protect against interrupts
1724 * doing the job. We will set the next pointer
1725 * to HEAD. After that, we set the old pointer
1726 * to NORMAL, but only if it was HEAD before.
1727 * otherwise we are an interrupt, and only
1728 * want the outer most commit to reset it.
1729 */
1730 new_head = next_page;
1731 rb_inc_page(cpu_buffer, &new_head);
1732
1733 ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
1734 RB_PAGE_NORMAL);
1735
1736 /*
1737 * Valid returns are:
1738 * HEAD - an interrupt came in and already set it.
1739 * NORMAL - One of two things:
1740 * 1) We really set it.
1741 * 2) A bunch of interrupts came in and moved
1742 * the page forward again.
1743 */
1744 switch (ret) {
1745 case RB_PAGE_HEAD:
1746 case RB_PAGE_NORMAL:
1747 /* OK */
1748 break;
1749 default:
1750 RB_WARN_ON(cpu_buffer, 1);
1751 return -1;
1752 }
1753
1754 /*
1755 * It is possible that an interrupt came in,
1756 * set the head up, then more interrupts came in
1757 * and moved it again. When we get back here,
1758 * the page would have been set to NORMAL but we
1759 * just set it back to HEAD.
1760 *
1761 * How do you detect this? Well, if that happened
1762 * the tail page would have moved.
1763 */
1764 if (ret == RB_PAGE_NORMAL) {
1765 /*
1766 * If the tail had moved passed next, then we need
1767 * to reset the pointer.
1768 */
1769 if (cpu_buffer->tail_page != tail_page &&
1770 cpu_buffer->tail_page != next_page)
1771 rb_head_page_set_normal(cpu_buffer, new_head,
1772 next_page,
1773 RB_PAGE_HEAD);
1774 }
1775
1776 /*
1777 * If this was the outer most commit (the one that
1778 * changed the original pointer from HEAD to UPDATE),
1779 * then it is up to us to reset it to NORMAL.
1780 */
1781 if (type == RB_PAGE_HEAD) {
1782 ret = rb_head_page_set_normal(cpu_buffer, next_page,
1783 tail_page,
1784 RB_PAGE_UPDATE);
1785 if (RB_WARN_ON(cpu_buffer,
1786 ret != RB_PAGE_UPDATE))
1787 return -1;
1788 }
1789
1790 return 0;
1791}
1792
Andrew Morton34a148b2009-01-09 12:27:09 -08001793static unsigned rb_calculate_event_length(unsigned length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001794{
1795 struct ring_buffer_event event; /* Used only for sizeof array */
1796
1797 /* zero length can cause confusions */
1798 if (!length)
1799 length = 1;
1800
Steven Rostedt22710482010-03-18 17:54:19 -04001801 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001802 length += sizeof(event.array[0]);
1803
1804 length += RB_EVNT_HDR_SIZE;
Steven Rostedt22710482010-03-18 17:54:19 -04001805 length = ALIGN(length, RB_ARCH_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001806
1807 return length;
1808}
1809
Steven Rostedtc7b09302009-06-11 11:12:00 -04001810static inline void
1811rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
1812 struct buffer_page *tail_page,
1813 unsigned long tail, unsigned long length)
1814{
1815 struct ring_buffer_event *event;
1816
1817 /*
1818 * Only the event that crossed the page boundary
1819 * must fill the old tail_page with padding.
1820 */
1821 if (tail >= BUF_PAGE_SIZE) {
Steven Rostedtb3230c82010-05-21 11:55:21 -04001822 /*
1823 * If the page was filled, then we still need
1824 * to update the real_end. Reset it to zero
1825 * and the reader will ignore it.
1826 */
1827 if (tail == BUF_PAGE_SIZE)
1828 tail_page->real_end = 0;
1829
Steven Rostedtc7b09302009-06-11 11:12:00 -04001830 local_sub(length, &tail_page->write);
1831 return;
1832 }
1833
1834 event = __rb_page_index(tail_page, tail);
Linus Torvaldsb0b70652009-06-20 10:56:46 -07001835 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedtc7b09302009-06-11 11:12:00 -04001836
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07001837 /* account for padding bytes */
1838 local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
1839
Steven Rostedtc7b09302009-06-11 11:12:00 -04001840 /*
Steven Rostedtff0ff842010-03-31 22:11:42 -04001841 * Save the original length to the meta data.
1842 * This will be used by the reader to add lost event
1843 * counter.
1844 */
1845 tail_page->real_end = tail;
1846
1847 /*
Steven Rostedtc7b09302009-06-11 11:12:00 -04001848 * If this event is bigger than the minimum size, then
1849 * we need to be careful that we don't subtract the
1850 * write counter enough to allow another writer to slip
1851 * in on this page.
1852 * We put in a discarded commit instead, to make sure
1853 * that this space is not used again.
1854 *
1855 * If we are less than the minimum size, we don't need to
1856 * worry about it.
1857 */
1858 if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
1859 /* No room for any events */
1860
1861 /* Mark the rest of the page with padding */
1862 rb_event_set_padding(event);
1863
1864 /* Set the write back to the previous setting */
1865 local_sub(length, &tail_page->write);
1866 return;
1867 }
1868
1869 /* Put in a discarded event */
1870 event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
1871 event->type_len = RINGBUF_TYPE_PADDING;
1872 /* time delta must be non zero */
1873 event->time_delta = 1;
Steven Rostedtc7b09302009-06-11 11:12:00 -04001874
1875 /* Set write to end of buffer */
1876 length = (tail + length) - BUF_PAGE_SIZE;
1877 local_sub(length, &tail_page->write);
1878}
Steven Rostedt6634ff22009-05-06 15:30:07 -04001879
Steven Rostedt747e94a2010-10-08 13:51:48 -04001880/*
1881 * This is the slow path, force gcc not to inline it.
1882 */
1883static noinline struct ring_buffer_event *
Steven Rostedt6634ff22009-05-06 15:30:07 -04001884rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
1885 unsigned long length, unsigned long tail,
Steven Rostedte8bc43e2010-10-20 10:58:02 -04001886 struct buffer_page *tail_page, u64 ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001887{
Steven Rostedt5a50e332009-11-17 08:43:01 -05001888 struct buffer_page *commit_page = cpu_buffer->commit_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001889 struct ring_buffer *buffer = cpu_buffer->buffer;
Steven Rostedt77ae3652009-03-27 11:00:29 -04001890 struct buffer_page *next_page;
1891 int ret;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001892
1893 next_page = tail_page;
1894
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001895 rb_inc_page(cpu_buffer, &next_page);
1896
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001897 /*
1898 * If for some reason, we had an interrupt storm that made
1899 * it all the way around the buffer, bail, and warn
1900 * about it.
1901 */
1902 if (unlikely(next_page == commit_page)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001903 local_inc(&cpu_buffer->commit_overrun);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001904 goto out_reset;
1905 }
1906
Steven Rostedt77ae3652009-03-27 11:00:29 -04001907 /*
1908 * This is where the fun begins!
1909 *
1910 * We are fighting against races between a reader that
1911 * could be on another CPU trying to swap its reader
1912 * page with the buffer head.
1913 *
1914 * We are also fighting against interrupts coming in and
1915 * moving the head or tail on us as well.
1916 *
1917 * If the next page is the head page then we have filled
1918 * the buffer, unless the commit page is still on the
1919 * reader page.
1920 */
1921 if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001922
Steven Rostedt77ae3652009-03-27 11:00:29 -04001923 /*
1924 * If the commit is not on the reader page, then
1925 * move the header page.
1926 */
1927 if (!rb_is_reader_page(cpu_buffer->commit_page)) {
1928 /*
1929 * If we are not in overwrite mode,
1930 * this is easy, just stop here.
1931 */
1932 if (!(buffer->flags & RB_FL_OVERWRITE))
1933 goto out_reset;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001934
Steven Rostedt77ae3652009-03-27 11:00:29 -04001935 ret = rb_handle_head_page(cpu_buffer,
1936 tail_page,
1937 next_page);
1938 if (ret < 0)
1939 goto out_reset;
1940 if (ret)
1941 goto out_again;
1942 } else {
1943 /*
1944 * We need to be careful here too. The
1945 * commit page could still be on the reader
1946 * page. We could have a small buffer, and
1947 * have filled up the buffer with events
1948 * from interrupts and such, and wrapped.
1949 *
1950 * Note, if the tail page is also the on the
1951 * reader_page, we let it move out.
1952 */
1953 if (unlikely((cpu_buffer->commit_page !=
1954 cpu_buffer->tail_page) &&
1955 (cpu_buffer->commit_page ==
1956 cpu_buffer->reader_page))) {
1957 local_inc(&cpu_buffer->commit_overrun);
1958 goto out_reset;
1959 }
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001960 }
1961 }
1962
Steven Rostedt77ae3652009-03-27 11:00:29 -04001963 ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
1964 if (ret) {
1965 /*
1966 * Nested commits always have zero deltas, so
1967 * just reread the time stamp
1968 */
Steven Rostedte8bc43e2010-10-20 10:58:02 -04001969 ts = rb_time_stamp(buffer);
1970 next_page->page->time_stamp = ts;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001971 }
1972
Steven Rostedt77ae3652009-03-27 11:00:29 -04001973 out_again:
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001974
Steven Rostedt77ae3652009-03-27 11:00:29 -04001975 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001976
1977 /* fail and let the caller try again */
1978 return ERR_PTR(-EAGAIN);
1979
Steven Rostedt45141d42009-02-12 13:19:48 -05001980 out_reset:
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001981 /* reset write */
Steven Rostedtc7b09302009-06-11 11:12:00 -04001982 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001983
Steven Rostedtbf41a152008-10-04 02:00:59 -04001984 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001985}
1986
Steven Rostedt6634ff22009-05-06 15:30:07 -04001987static struct ring_buffer_event *
1988__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt69d1b832010-10-07 18:18:05 -04001989 unsigned long length, u64 ts,
1990 u64 delta, int add_timestamp)
Steven Rostedt6634ff22009-05-06 15:30:07 -04001991{
Steven Rostedt5a50e332009-11-17 08:43:01 -05001992 struct buffer_page *tail_page;
Steven Rostedt6634ff22009-05-06 15:30:07 -04001993 struct ring_buffer_event *event;
1994 unsigned long tail, write;
1995
Steven Rostedt69d1b832010-10-07 18:18:05 -04001996 /*
1997 * If the time delta since the last event is too big to
1998 * hold in the time field of the event, then we append a
1999 * TIME EXTEND event ahead of the data event.
2000 */
2001 if (unlikely(add_timestamp))
2002 length += RB_LEN_TIME_EXTEND;
2003
Steven Rostedt6634ff22009-05-06 15:30:07 -04002004 tail_page = cpu_buffer->tail_page;
2005 write = local_add_return(length, &tail_page->write);
Steven Rostedt77ae3652009-03-27 11:00:29 -04002006
2007 /* set write to only the index of the write */
2008 write &= RB_WRITE_MASK;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002009 tail = write - length;
2010
2011 /* See if we shot pass the end of this buffer page */
Steven Rostedt747e94a2010-10-08 13:51:48 -04002012 if (unlikely(write > BUF_PAGE_SIZE))
Steven Rostedt6634ff22009-05-06 15:30:07 -04002013 return rb_move_tail(cpu_buffer, length, tail,
Steven Rostedt5a50e332009-11-17 08:43:01 -05002014 tail_page, ts);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002015
2016 /* We reserved something on the buffer */
2017
Steven Rostedt6634ff22009-05-06 15:30:07 -04002018 event = __rb_page_index(tail_page, tail);
Vegard Nossum1744a212009-02-28 08:29:44 +01002019 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedt69d1b832010-10-07 18:18:05 -04002020 rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002021
Steven Rostedt69d1b832010-10-07 18:18:05 -04002022 local_inc(&tail_page->entries);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002023
2024 /*
Steven Rostedtfa743952009-06-16 12:37:57 -04002025 * If this is the first commit on the page, then update
2026 * its timestamp.
Steven Rostedt6634ff22009-05-06 15:30:07 -04002027 */
Steven Rostedtfa743952009-06-16 12:37:57 -04002028 if (!tail)
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002029 tail_page->page->time_stamp = ts;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002030
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002031 /* account for these added bytes */
2032 local_add(length, &cpu_buffer->entries_bytes);
2033
Steven Rostedt6634ff22009-05-06 15:30:07 -04002034 return event;
2035}
2036
Steven Rostedtedd813b2009-06-02 23:00:53 -04002037static inline int
2038rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
2039 struct ring_buffer_event *event)
2040{
2041 unsigned long new_index, old_index;
2042 struct buffer_page *bpage;
2043 unsigned long index;
2044 unsigned long addr;
2045
2046 new_index = rb_event_index(event);
Steven Rostedt69d1b832010-10-07 18:18:05 -04002047 old_index = new_index + rb_event_ts_length(event);
Steven Rostedtedd813b2009-06-02 23:00:53 -04002048 addr = (unsigned long)event;
2049 addr &= PAGE_MASK;
2050
2051 bpage = cpu_buffer->tail_page;
2052
2053 if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04002054 unsigned long write_mask =
2055 local_read(&bpage->write) & ~RB_WRITE_MASK;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002056 unsigned long event_length = rb_event_length(event);
Steven Rostedtedd813b2009-06-02 23:00:53 -04002057 /*
2058 * This is on the tail page. It is possible that
2059 * a write could come in and move the tail page
2060 * and write to the next page. That is fine
2061 * because we just shorten what is on this page.
2062 */
Steven Rostedt77ae3652009-03-27 11:00:29 -04002063 old_index += write_mask;
2064 new_index += write_mask;
Steven Rostedtedd813b2009-06-02 23:00:53 -04002065 index = local_cmpxchg(&bpage->write, old_index, new_index);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002066 if (index == old_index) {
2067 /* update counters */
2068 local_sub(event_length, &cpu_buffer->entries_bytes);
Steven Rostedtedd813b2009-06-02 23:00:53 -04002069 return 1;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002070 }
Steven Rostedtedd813b2009-06-02 23:00:53 -04002071 }
2072
2073 /* could not discard */
2074 return 0;
2075}
2076
Steven Rostedtfa743952009-06-16 12:37:57 -04002077static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
2078{
2079 local_inc(&cpu_buffer->committing);
2080 local_inc(&cpu_buffer->commits);
2081}
2082
Steven Rostedtd9abde22010-10-19 13:17:08 -04002083static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtfa743952009-06-16 12:37:57 -04002084{
2085 unsigned long commits;
2086
2087 if (RB_WARN_ON(cpu_buffer,
2088 !local_read(&cpu_buffer->committing)))
2089 return;
2090
2091 again:
2092 commits = local_read(&cpu_buffer->commits);
2093 /* synchronize with interrupts */
2094 barrier();
2095 if (local_read(&cpu_buffer->committing) == 1)
2096 rb_set_commit_to_write(cpu_buffer);
2097
2098 local_dec(&cpu_buffer->committing);
2099
2100 /* synchronize with interrupts */
2101 barrier();
2102
2103 /*
2104 * Need to account for interrupts coming in between the
2105 * updating of the commit page and the clearing of the
2106 * committing counter.
2107 */
2108 if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
2109 !local_read(&cpu_buffer->committing)) {
2110 local_inc(&cpu_buffer->committing);
2111 goto again;
2112 }
2113}
2114
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002115static struct ring_buffer_event *
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002116rb_reserve_next_event(struct ring_buffer *buffer,
2117 struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt1cd8d732009-05-11 14:08:09 -04002118 unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002119{
2120 struct ring_buffer_event *event;
Steven Rostedt69d1b832010-10-07 18:18:05 -04002121 u64 ts, delta;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002122 int nr_loops = 0;
Steven Rostedt69d1b832010-10-07 18:18:05 -04002123 int add_timestamp;
Steven Rostedt140ff892010-10-08 10:50:30 -04002124 u64 diff;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002125
Steven Rostedtfa743952009-06-16 12:37:57 -04002126 rb_start_commit(cpu_buffer);
2127
Steven Rostedt85bac322009-09-04 14:24:40 -04002128#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002129 /*
2130 * Due to the ability to swap a cpu buffer from a buffer
2131 * it is possible it was swapped before we committed.
2132 * (committing stops a swap). We check for it here and
2133 * if it happened, we have to fail the write.
2134 */
2135 barrier();
2136 if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
2137 local_dec(&cpu_buffer->committing);
2138 local_dec(&cpu_buffer->commits);
2139 return NULL;
2140 }
Steven Rostedt85bac322009-09-04 14:24:40 -04002141#endif
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002142
Steven Rostedtbe957c42009-05-11 14:42:53 -04002143 length = rb_calculate_event_length(length);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002144 again:
Steven Rostedt69d1b832010-10-07 18:18:05 -04002145 add_timestamp = 0;
2146 delta = 0;
2147
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002148 /*
2149 * We allow for interrupts to reenter here and do a trace.
2150 * If one does, it will cause this original code to loop
2151 * back here. Even with heavy interrupts happening, this
2152 * should only happen a few times in a row. If this happens
2153 * 1000 times in a row, there must be either an interrupt
2154 * storm or we have something buggy.
2155 * Bail!
2156 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002157 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
Steven Rostedtfa743952009-06-16 12:37:57 -04002158 goto out_fail;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002159
Jiri Olsa6d3f1e12009-10-23 19:36:19 -04002160 ts = rb_time_stamp(cpu_buffer->buffer);
Steven Rostedt140ff892010-10-08 10:50:30 -04002161 diff = ts - cpu_buffer->write_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002162
Steven Rostedt140ff892010-10-08 10:50:30 -04002163 /* make sure this diff is calculated here */
2164 barrier();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002165
Steven Rostedt140ff892010-10-08 10:50:30 -04002166 /* Did the write stamp get updated already? */
2167 if (likely(ts >= cpu_buffer->write_stamp)) {
Steven Rostedt168b6b12009-05-11 22:11:05 -04002168 delta = diff;
2169 if (unlikely(test_time_stamp(delta))) {
Jiri Olsa31274d72011-02-18 15:52:19 +01002170 int local_clock_stable = 1;
2171#ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
2172 local_clock_stable = sched_clock_stable;
2173#endif
Steven Rostedt69d1b832010-10-07 18:18:05 -04002174 WARN_ONCE(delta > (1ULL << 59),
Jiri Olsa31274d72011-02-18 15:52:19 +01002175 KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
Steven Rostedt69d1b832010-10-07 18:18:05 -04002176 (unsigned long long)delta,
2177 (unsigned long long)ts,
Jiri Olsa31274d72011-02-18 15:52:19 +01002178 (unsigned long long)cpu_buffer->write_stamp,
2179 local_clock_stable ? "" :
2180 "If you just came from a suspend/resume,\n"
2181 "please switch to the trace global clock:\n"
2182 " echo global > /sys/kernel/debug/tracing/trace_clock\n");
Steven Rostedt69d1b832010-10-07 18:18:05 -04002183 add_timestamp = 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002184 }
Steven Rostedt168b6b12009-05-11 22:11:05 -04002185 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002186
Steven Rostedt69d1b832010-10-07 18:18:05 -04002187 event = __rb_reserve_next(cpu_buffer, length, ts,
2188 delta, add_timestamp);
Steven Rostedt168b6b12009-05-11 22:11:05 -04002189 if (unlikely(PTR_ERR(event) == -EAGAIN))
Steven Rostedtbf41a152008-10-04 02:00:59 -04002190 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002191
Steven Rostedtfa743952009-06-16 12:37:57 -04002192 if (!event)
2193 goto out_fail;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002194
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002195 return event;
Steven Rostedtfa743952009-06-16 12:37:57 -04002196
2197 out_fail:
2198 rb_end_commit(cpu_buffer);
2199 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002200}
2201
Paul Mundt1155de42009-06-25 14:30:12 +09002202#ifdef CONFIG_TRACING
2203
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002204#define TRACE_RECURSIVE_DEPTH 16
Steven Rostedt261842b2009-04-16 21:41:52 -04002205
Steven Rostedtd9abde22010-10-19 13:17:08 -04002206/* Keep this code out of the fast path cache */
2207static noinline void trace_recursive_fail(void)
Steven Rostedt261842b2009-04-16 21:41:52 -04002208{
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002209 /* Disable all tracing before we do anything else */
2210 tracing_off_permanent();
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02002211
Steven Rostedt7d7d2b82009-04-27 12:37:49 -04002212 printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002213 "HC[%lu]:SC[%lu]:NMI[%lu]\n",
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002214 trace_recursion_buffer(),
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002215 hardirq_count() >> HARDIRQ_SHIFT,
2216 softirq_count() >> SOFTIRQ_SHIFT,
2217 in_nmi());
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02002218
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002219 WARN_ON_ONCE(1);
Steven Rostedtd9abde22010-10-19 13:17:08 -04002220}
2221
2222static inline int trace_recursive_lock(void)
2223{
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002224 trace_recursion_inc();
Steven Rostedtd9abde22010-10-19 13:17:08 -04002225
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002226 if (likely(trace_recursion_buffer() < TRACE_RECURSIVE_DEPTH))
Steven Rostedtd9abde22010-10-19 13:17:08 -04002227 return 0;
2228
2229 trace_recursive_fail();
2230
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002231 return -1;
Steven Rostedt261842b2009-04-16 21:41:52 -04002232}
2233
Steven Rostedtd9abde22010-10-19 13:17:08 -04002234static inline void trace_recursive_unlock(void)
Steven Rostedt261842b2009-04-16 21:41:52 -04002235{
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002236 WARN_ON_ONCE(!trace_recursion_buffer());
Steven Rostedt261842b2009-04-16 21:41:52 -04002237
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002238 trace_recursion_dec();
Steven Rostedt261842b2009-04-16 21:41:52 -04002239}
2240
Paul Mundt1155de42009-06-25 14:30:12 +09002241#else
2242
2243#define trace_recursive_lock() (0)
2244#define trace_recursive_unlock() do { } while (0)
2245
2246#endif
2247
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002248/**
2249 * ring_buffer_lock_reserve - reserve a part of the buffer
2250 * @buffer: the ring buffer to reserve from
2251 * @length: the length of the data to reserve (excluding event header)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002252 *
2253 * Returns a reseverd event on the ring buffer to copy directly to.
2254 * The user of this interface will need to get the body to write into
2255 * and can use the ring_buffer_event_data() interface.
2256 *
2257 * The length is the length of the data needed, not the event length
2258 * which also includes the event header.
2259 *
2260 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
2261 * If NULL is returned, then nothing has been allocated or locked.
2262 */
2263struct ring_buffer_event *
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02002264ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002265{
2266 struct ring_buffer_per_cpu *cpu_buffer;
2267 struct ring_buffer_event *event;
Steven Rostedt5168ae52010-06-03 09:36:50 -04002268 int cpu;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002269
Steven Rostedt033601a2008-11-21 12:41:55 -05002270 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05002271 return NULL;
2272
Steven Rostedtbf41a152008-10-04 02:00:59 -04002273 /* If we are tracing schedule, we don't want to recurse */
Steven Rostedt5168ae52010-06-03 09:36:50 -04002274 preempt_disable_notrace();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002275
Lai Jiangshan52fbe9c2010-03-08 14:50:43 +08002276 if (atomic_read(&buffer->record_disabled))
2277 goto out_nocheck;
2278
Steven Rostedt261842b2009-04-16 21:41:52 -04002279 if (trace_recursive_lock())
2280 goto out_nocheck;
2281
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002282 cpu = raw_smp_processor_id();
2283
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302284 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04002285 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002286
2287 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002288
2289 if (atomic_read(&cpu_buffer->record_disabled))
Steven Rostedtd7690412008-10-01 00:29:53 -04002290 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002291
Steven Rostedtbe957c42009-05-11 14:42:53 -04002292 if (length > BUF_MAX_DATA_SIZE)
Steven Rostedtbf41a152008-10-04 02:00:59 -04002293 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002294
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002295 event = rb_reserve_next_event(buffer, cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002296 if (!event)
Steven Rostedtd7690412008-10-01 00:29:53 -04002297 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002298
2299 return event;
2300
Steven Rostedtd7690412008-10-01 00:29:53 -04002301 out:
Steven Rostedt261842b2009-04-16 21:41:52 -04002302 trace_recursive_unlock();
2303
2304 out_nocheck:
Steven Rostedt5168ae52010-06-03 09:36:50 -04002305 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002306 return NULL;
2307}
Robert Richterc4f50182008-12-11 16:49:22 +01002308EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002309
Steven Rostedta1863c22009-09-03 10:23:58 -04002310static void
2311rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002312 struct ring_buffer_event *event)
2313{
Steven Rostedt69d1b832010-10-07 18:18:05 -04002314 u64 delta;
2315
Steven Rostedtfa743952009-06-16 12:37:57 -04002316 /*
2317 * The event first in the commit queue updates the
2318 * time stamp.
2319 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04002320 if (rb_event_is_commit(cpu_buffer, event)) {
2321 /*
2322 * A commit event that is first on a page
2323 * updates the write timestamp with the page stamp
2324 */
2325 if (!rb_event_index(event))
2326 cpu_buffer->write_stamp =
2327 cpu_buffer->commit_page->page->time_stamp;
2328 else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
2329 delta = event->array[0];
2330 delta <<= TS_SHIFT;
2331 delta += event->time_delta;
2332 cpu_buffer->write_stamp += delta;
2333 } else
2334 cpu_buffer->write_stamp += event->time_delta;
2335 }
Steven Rostedta1863c22009-09-03 10:23:58 -04002336}
Steven Rostedtbf41a152008-10-04 02:00:59 -04002337
Steven Rostedta1863c22009-09-03 10:23:58 -04002338static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
2339 struct ring_buffer_event *event)
2340{
2341 local_inc(&cpu_buffer->entries);
2342 rb_update_write_stamp(cpu_buffer, event);
Steven Rostedtfa743952009-06-16 12:37:57 -04002343 rb_end_commit(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002344}
2345
2346/**
2347 * ring_buffer_unlock_commit - commit a reserved
2348 * @buffer: The buffer to commit to
2349 * @event: The event pointer to commit.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002350 *
2351 * This commits the data to the ring buffer, and releases any locks held.
2352 *
2353 * Must be paired with ring_buffer_lock_reserve.
2354 */
2355int ring_buffer_unlock_commit(struct ring_buffer *buffer,
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02002356 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002357{
2358 struct ring_buffer_per_cpu *cpu_buffer;
2359 int cpu = raw_smp_processor_id();
2360
2361 cpu_buffer = buffer->buffers[cpu];
2362
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002363 rb_commit(cpu_buffer, event);
2364
Steven Rostedt261842b2009-04-16 21:41:52 -04002365 trace_recursive_unlock();
2366
Steven Rostedt5168ae52010-06-03 09:36:50 -04002367 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002368
2369 return 0;
2370}
Robert Richterc4f50182008-12-11 16:49:22 +01002371EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002372
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002373static inline void rb_event_discard(struct ring_buffer_event *event)
2374{
Steven Rostedt69d1b832010-10-07 18:18:05 -04002375 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
2376 event = skip_time_extend(event);
2377
Lai Jiangshan334d4162009-04-24 11:27:05 +08002378 /* array[0] holds the actual length for the discarded event */
2379 event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
2380 event->type_len = RINGBUF_TYPE_PADDING;
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002381 /* time delta must be non zero */
2382 if (!event->time_delta)
2383 event->time_delta = 1;
2384}
2385
Steven Rostedta1863c22009-09-03 10:23:58 -04002386/*
2387 * Decrement the entries to the page that an event is on.
2388 * The event does not even need to exist, only the pointer
2389 * to the page it is on. This may only be called before the commit
2390 * takes place.
2391 */
2392static inline void
2393rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
2394 struct ring_buffer_event *event)
2395{
2396 unsigned long addr = (unsigned long)event;
2397 struct buffer_page *bpage = cpu_buffer->commit_page;
2398 struct buffer_page *start;
2399
2400 addr &= PAGE_MASK;
2401
2402 /* Do the likely case first */
2403 if (likely(bpage->page == (void *)addr)) {
2404 local_dec(&bpage->entries);
2405 return;
2406 }
2407
2408 /*
2409 * Because the commit page may be on the reader page we
2410 * start with the next page and check the end loop there.
2411 */
2412 rb_inc_page(cpu_buffer, &bpage);
2413 start = bpage;
2414 do {
2415 if (bpage->page == (void *)addr) {
2416 local_dec(&bpage->entries);
2417 return;
2418 }
2419 rb_inc_page(cpu_buffer, &bpage);
2420 } while (bpage != start);
2421
2422 /* commit not part of this buffer?? */
2423 RB_WARN_ON(cpu_buffer, 1);
2424}
2425
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002426/**
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002427 * ring_buffer_commit_discard - discard an event that has not been committed
2428 * @buffer: the ring buffer
2429 * @event: non committed event to discard
2430 *
Steven Rostedtdc892f72009-09-03 15:33:41 -04002431 * Sometimes an event that is in the ring buffer needs to be ignored.
2432 * This function lets the user discard an event in the ring buffer
2433 * and then that event will not be read later.
2434 *
2435 * This function only works if it is called before the the item has been
2436 * committed. It will try to free the event from the ring buffer
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002437 * if another event has not been added behind it.
2438 *
2439 * If another event has been added behind it, it will set the event
2440 * up as discarded, and perform the commit.
2441 *
2442 * If this function is called, do not call ring_buffer_unlock_commit on
2443 * the event.
2444 */
2445void ring_buffer_discard_commit(struct ring_buffer *buffer,
2446 struct ring_buffer_event *event)
2447{
2448 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002449 int cpu;
2450
2451 /* The event is discarded regardless */
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002452 rb_event_discard(event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002453
Steven Rostedtfa743952009-06-16 12:37:57 -04002454 cpu = smp_processor_id();
2455 cpu_buffer = buffer->buffers[cpu];
2456
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002457 /*
2458 * This must only be called if the event has not been
2459 * committed yet. Thus we can assume that preemption
2460 * is still disabled.
2461 */
Steven Rostedtfa743952009-06-16 12:37:57 -04002462 RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002463
Steven Rostedta1863c22009-09-03 10:23:58 -04002464 rb_decrement_entry(cpu_buffer, event);
Steven Rostedt0f2541d2009-08-05 12:02:48 -04002465 if (rb_try_to_discard(cpu_buffer, event))
Steven Rostedtedd813b2009-06-02 23:00:53 -04002466 goto out;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002467
2468 /*
2469 * The commit is still visible by the reader, so we
Steven Rostedta1863c22009-09-03 10:23:58 -04002470 * must still update the timestamp.
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002471 */
Steven Rostedta1863c22009-09-03 10:23:58 -04002472 rb_update_write_stamp(cpu_buffer, event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002473 out:
Steven Rostedtfa743952009-06-16 12:37:57 -04002474 rb_end_commit(cpu_buffer);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002475
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002476 trace_recursive_unlock();
2477
Steven Rostedt5168ae52010-06-03 09:36:50 -04002478 preempt_enable_notrace();
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002479
2480}
2481EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
2482
2483/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002484 * ring_buffer_write - write data to the buffer without reserving
2485 * @buffer: The ring buffer to write to.
2486 * @length: The length of the data being written (excluding the event header)
2487 * @data: The data to write to the buffer.
2488 *
2489 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
2490 * one function. If you already have the data to write to the buffer, it
2491 * may be easier to simply call this function.
2492 *
2493 * Note, like ring_buffer_lock_reserve, the length is the length of the data
2494 * and not the length of the event which would hold the header.
2495 */
2496int ring_buffer_write(struct ring_buffer *buffer,
2497 unsigned long length,
2498 void *data)
2499{
2500 struct ring_buffer_per_cpu *cpu_buffer;
2501 struct ring_buffer_event *event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002502 void *body;
2503 int ret = -EBUSY;
Steven Rostedt5168ae52010-06-03 09:36:50 -04002504 int cpu;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002505
Steven Rostedt033601a2008-11-21 12:41:55 -05002506 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05002507 return -EBUSY;
2508
Steven Rostedt5168ae52010-06-03 09:36:50 -04002509 preempt_disable_notrace();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002510
Lai Jiangshan52fbe9c2010-03-08 14:50:43 +08002511 if (atomic_read(&buffer->record_disabled))
2512 goto out;
2513
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002514 cpu = raw_smp_processor_id();
2515
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302516 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04002517 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002518
2519 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002520
2521 if (atomic_read(&cpu_buffer->record_disabled))
2522 goto out;
2523
Steven Rostedtbe957c42009-05-11 14:42:53 -04002524 if (length > BUF_MAX_DATA_SIZE)
2525 goto out;
2526
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002527 event = rb_reserve_next_event(buffer, cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002528 if (!event)
2529 goto out;
2530
2531 body = rb_event_data(event);
2532
2533 memcpy(body, data, length);
2534
2535 rb_commit(cpu_buffer, event);
2536
2537 ret = 0;
2538 out:
Steven Rostedt5168ae52010-06-03 09:36:50 -04002539 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002540
2541 return ret;
2542}
Robert Richterc4f50182008-12-11 16:49:22 +01002543EXPORT_SYMBOL_GPL(ring_buffer_write);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002544
Andrew Morton34a148b2009-01-09 12:27:09 -08002545static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtbf41a152008-10-04 02:00:59 -04002546{
2547 struct buffer_page *reader = cpu_buffer->reader_page;
Steven Rostedt77ae3652009-03-27 11:00:29 -04002548 struct buffer_page *head = rb_set_head_page(cpu_buffer);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002549 struct buffer_page *commit = cpu_buffer->commit_page;
2550
Steven Rostedt77ae3652009-03-27 11:00:29 -04002551 /* In case of error, head will be NULL */
2552 if (unlikely(!head))
2553 return 1;
2554
Steven Rostedtbf41a152008-10-04 02:00:59 -04002555 return reader->read == rb_page_commit(reader) &&
2556 (commit == reader ||
2557 (commit == head &&
2558 head->read == rb_page_commit(commit)));
2559}
2560
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002561/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002562 * ring_buffer_record_disable - stop all writes into the buffer
2563 * @buffer: The ring buffer to stop writes to.
2564 *
2565 * This prevents all writes to the buffer. Any attempt to write
2566 * to the buffer after this will fail and return NULL.
2567 *
2568 * The caller should call synchronize_sched() after this.
2569 */
2570void ring_buffer_record_disable(struct ring_buffer *buffer)
2571{
2572 atomic_inc(&buffer->record_disabled);
2573}
Robert Richterc4f50182008-12-11 16:49:22 +01002574EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002575
2576/**
2577 * ring_buffer_record_enable - enable writes to the buffer
2578 * @buffer: The ring buffer to enable writes
2579 *
2580 * Note, multiple disables will need the same number of enables
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05002581 * to truly enable the writing (much like preempt_disable).
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002582 */
2583void ring_buffer_record_enable(struct ring_buffer *buffer)
2584{
2585 atomic_dec(&buffer->record_disabled);
2586}
Robert Richterc4f50182008-12-11 16:49:22 +01002587EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002588
2589/**
Steven Rostedt499e5472012-02-22 15:50:28 -05002590 * ring_buffer_record_off - stop all writes into the buffer
2591 * @buffer: The ring buffer to stop writes to.
2592 *
2593 * This prevents all writes to the buffer. Any attempt to write
2594 * to the buffer after this will fail and return NULL.
2595 *
2596 * This is different than ring_buffer_record_disable() as
2597 * it works like an on/off switch, where as the disable() verison
2598 * must be paired with a enable().
2599 */
2600void ring_buffer_record_off(struct ring_buffer *buffer)
2601{
2602 unsigned int rd;
2603 unsigned int new_rd;
2604
2605 do {
2606 rd = atomic_read(&buffer->record_disabled);
2607 new_rd = rd | RB_BUFFER_OFF;
2608 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
2609}
2610EXPORT_SYMBOL_GPL(ring_buffer_record_off);
2611
2612/**
2613 * ring_buffer_record_on - restart writes into the buffer
2614 * @buffer: The ring buffer to start writes to.
2615 *
2616 * This enables all writes to the buffer that was disabled by
2617 * ring_buffer_record_off().
2618 *
2619 * This is different than ring_buffer_record_enable() as
2620 * it works like an on/off switch, where as the enable() verison
2621 * must be paired with a disable().
2622 */
2623void ring_buffer_record_on(struct ring_buffer *buffer)
2624{
2625 unsigned int rd;
2626 unsigned int new_rd;
2627
2628 do {
2629 rd = atomic_read(&buffer->record_disabled);
2630 new_rd = rd & ~RB_BUFFER_OFF;
2631 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
2632}
2633EXPORT_SYMBOL_GPL(ring_buffer_record_on);
2634
2635/**
2636 * ring_buffer_record_is_on - return true if the ring buffer can write
2637 * @buffer: The ring buffer to see if write is enabled
2638 *
2639 * Returns true if the ring buffer is in a state that it accepts writes.
2640 */
2641int ring_buffer_record_is_on(struct ring_buffer *buffer)
2642{
2643 return !atomic_read(&buffer->record_disabled);
2644}
2645
2646/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002647 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
2648 * @buffer: The ring buffer to stop writes to.
2649 * @cpu: The CPU buffer to stop
2650 *
2651 * This prevents all writes to the buffer. Any attempt to write
2652 * to the buffer after this will fail and return NULL.
2653 *
2654 * The caller should call synchronize_sched() after this.
2655 */
2656void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
2657{
2658 struct ring_buffer_per_cpu *cpu_buffer;
2659
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302660 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002661 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002662
2663 cpu_buffer = buffer->buffers[cpu];
2664 atomic_inc(&cpu_buffer->record_disabled);
2665}
Robert Richterc4f50182008-12-11 16:49:22 +01002666EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002667
2668/**
2669 * ring_buffer_record_enable_cpu - enable writes to the buffer
2670 * @buffer: The ring buffer to enable writes
2671 * @cpu: The CPU to enable.
2672 *
2673 * Note, multiple disables will need the same number of enables
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05002674 * to truly enable the writing (much like preempt_disable).
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002675 */
2676void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
2677{
2678 struct ring_buffer_per_cpu *cpu_buffer;
2679
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302680 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002681 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002682
2683 cpu_buffer = buffer->buffers[cpu];
2684 atomic_dec(&cpu_buffer->record_disabled);
2685}
Robert Richterc4f50182008-12-11 16:49:22 +01002686EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002687
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002688/*
2689 * The total entries in the ring buffer is the running counter
2690 * of entries entered into the ring buffer, minus the sum of
2691 * the entries read from the ring buffer and the number of
2692 * entries that were overwritten.
2693 */
2694static inline unsigned long
2695rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
2696{
2697 return local_read(&cpu_buffer->entries) -
2698 (local_read(&cpu_buffer->overrun) + cpu_buffer->read);
2699}
2700
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002701/**
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002702 * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
2703 * @buffer: The ring buffer
2704 * @cpu: The per CPU buffer to read from.
2705 */
2706unsigned long ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
2707{
2708 unsigned long flags;
2709 struct ring_buffer_per_cpu *cpu_buffer;
2710 struct buffer_page *bpage;
2711 unsigned long ret;
2712
2713 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2714 return 0;
2715
2716 cpu_buffer = buffer->buffers[cpu];
Linus Torvalds7115e3f2011-10-26 17:03:38 +02002717 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002718 /*
2719 * if the tail is on reader_page, oldest time stamp is on the reader
2720 * page
2721 */
2722 if (cpu_buffer->tail_page == cpu_buffer->reader_page)
2723 bpage = cpu_buffer->reader_page;
2724 else
2725 bpage = rb_set_head_page(cpu_buffer);
2726 ret = bpage->page->time_stamp;
Linus Torvalds7115e3f2011-10-26 17:03:38 +02002727 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002728
2729 return ret;
2730}
2731EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
2732
2733/**
2734 * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
2735 * @buffer: The ring buffer
2736 * @cpu: The per CPU buffer to read from.
2737 */
2738unsigned long ring_buffer_bytes_cpu(struct ring_buffer *buffer, int cpu)
2739{
2740 struct ring_buffer_per_cpu *cpu_buffer;
2741 unsigned long ret;
2742
2743 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2744 return 0;
2745
2746 cpu_buffer = buffer->buffers[cpu];
2747 ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
2748
2749 return ret;
2750}
2751EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
2752
2753/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002754 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
2755 * @buffer: The ring buffer
2756 * @cpu: The per CPU buffer to get the entries from.
2757 */
2758unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
2759{
2760 struct ring_buffer_per_cpu *cpu_buffer;
2761
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302762 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002763 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002764
2765 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04002766
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002767 return rb_num_of_entries(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002768}
Robert Richterc4f50182008-12-11 16:49:22 +01002769EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002770
2771/**
2772 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
2773 * @buffer: The ring buffer
2774 * @cpu: The per CPU buffer to get the number of overruns from
2775 */
2776unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
2777{
2778 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04002779 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002780
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302781 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002782 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002783
2784 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04002785 ret = local_read(&cpu_buffer->overrun);
Steven Rostedt554f7862009-03-11 22:00:13 -04002786
2787 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002788}
Robert Richterc4f50182008-12-11 16:49:22 +01002789EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002790
2791/**
Steven Rostedtf0d2c682009-04-29 13:43:37 -04002792 * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
2793 * @buffer: The ring buffer
2794 * @cpu: The per CPU buffer to get the number of overruns from
2795 */
2796unsigned long
2797ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
2798{
2799 struct ring_buffer_per_cpu *cpu_buffer;
2800 unsigned long ret;
2801
2802 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2803 return 0;
2804
2805 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04002806 ret = local_read(&cpu_buffer->commit_overrun);
Steven Rostedtf0d2c682009-04-29 13:43:37 -04002807
2808 return ret;
2809}
2810EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
2811
2812/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002813 * ring_buffer_entries - get the number of entries in a buffer
2814 * @buffer: The ring buffer
2815 *
2816 * Returns the total number of entries in the ring buffer
2817 * (all CPU entries)
2818 */
2819unsigned long ring_buffer_entries(struct ring_buffer *buffer)
2820{
2821 struct ring_buffer_per_cpu *cpu_buffer;
2822 unsigned long entries = 0;
2823 int cpu;
2824
2825 /* if you care about this being correct, lock the buffer */
2826 for_each_buffer_cpu(buffer, cpu) {
2827 cpu_buffer = buffer->buffers[cpu];
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002828 entries += rb_num_of_entries(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002829 }
2830
2831 return entries;
2832}
Robert Richterc4f50182008-12-11 16:49:22 +01002833EXPORT_SYMBOL_GPL(ring_buffer_entries);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002834
2835/**
Jiri Olsa67b394f2009-10-23 19:36:18 -04002836 * ring_buffer_overruns - get the number of overruns in buffer
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002837 * @buffer: The ring buffer
2838 *
2839 * Returns the total number of overruns in the ring buffer
2840 * (all CPU entries)
2841 */
2842unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
2843{
2844 struct ring_buffer_per_cpu *cpu_buffer;
2845 unsigned long overruns = 0;
2846 int cpu;
2847
2848 /* if you care about this being correct, lock the buffer */
2849 for_each_buffer_cpu(buffer, cpu) {
2850 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04002851 overruns += local_read(&cpu_buffer->overrun);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002852 }
2853
2854 return overruns;
2855}
Robert Richterc4f50182008-12-11 16:49:22 +01002856EXPORT_SYMBOL_GPL(ring_buffer_overruns);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002857
Steven Rostedt642edba2008-11-12 00:01:26 -05002858static void rb_iter_reset(struct ring_buffer_iter *iter)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002859{
2860 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2861
Steven Rostedtd7690412008-10-01 00:29:53 -04002862 /* Iterator usage is expected to have record disabled */
2863 if (list_empty(&cpu_buffer->reader_page->list)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04002864 iter->head_page = rb_set_head_page(cpu_buffer);
2865 if (unlikely(!iter->head_page))
2866 return;
2867 iter->head = iter->head_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04002868 } else {
2869 iter->head_page = cpu_buffer->reader_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002870 iter->head = cpu_buffer->reader_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04002871 }
2872 if (iter->head)
2873 iter->read_stamp = cpu_buffer->read_stamp;
2874 else
Steven Rostedtabc9b562008-12-02 15:34:06 -05002875 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt492a74f2010-01-25 15:17:47 -05002876 iter->cache_reader_page = cpu_buffer->reader_page;
2877 iter->cache_read = cpu_buffer->read;
Steven Rostedt642edba2008-11-12 00:01:26 -05002878}
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002879
Steven Rostedt642edba2008-11-12 00:01:26 -05002880/**
2881 * ring_buffer_iter_reset - reset an iterator
2882 * @iter: The iterator to reset
2883 *
2884 * Resets the iterator, so that it will start from the beginning
2885 * again.
2886 */
2887void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
2888{
Steven Rostedt554f7862009-03-11 22:00:13 -04002889 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt642edba2008-11-12 00:01:26 -05002890 unsigned long flags;
2891
Steven Rostedt554f7862009-03-11 22:00:13 -04002892 if (!iter)
2893 return;
2894
2895 cpu_buffer = iter->cpu_buffer;
2896
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02002897 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt642edba2008-11-12 00:01:26 -05002898 rb_iter_reset(iter);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02002899 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002900}
Robert Richterc4f50182008-12-11 16:49:22 +01002901EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002902
2903/**
2904 * ring_buffer_iter_empty - check if an iterator has no more to read
2905 * @iter: The iterator to check
2906 */
2907int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
2908{
2909 struct ring_buffer_per_cpu *cpu_buffer;
2910
2911 cpu_buffer = iter->cpu_buffer;
2912
Steven Rostedtbf41a152008-10-04 02:00:59 -04002913 return iter->head_page == cpu_buffer->commit_page &&
2914 iter->head == rb_commit_index(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002915}
Robert Richterc4f50182008-12-11 16:49:22 +01002916EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002917
2918static void
2919rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
2920 struct ring_buffer_event *event)
2921{
2922 u64 delta;
2923
Lai Jiangshan334d4162009-04-24 11:27:05 +08002924 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002925 case RINGBUF_TYPE_PADDING:
2926 return;
2927
2928 case RINGBUF_TYPE_TIME_EXTEND:
2929 delta = event->array[0];
2930 delta <<= TS_SHIFT;
2931 delta += event->time_delta;
2932 cpu_buffer->read_stamp += delta;
2933 return;
2934
2935 case RINGBUF_TYPE_TIME_STAMP:
2936 /* FIXME: not implemented */
2937 return;
2938
2939 case RINGBUF_TYPE_DATA:
2940 cpu_buffer->read_stamp += event->time_delta;
2941 return;
2942
2943 default:
2944 BUG();
2945 }
2946 return;
2947}
2948
2949static void
2950rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
2951 struct ring_buffer_event *event)
2952{
2953 u64 delta;
2954
Lai Jiangshan334d4162009-04-24 11:27:05 +08002955 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002956 case RINGBUF_TYPE_PADDING:
2957 return;
2958
2959 case RINGBUF_TYPE_TIME_EXTEND:
2960 delta = event->array[0];
2961 delta <<= TS_SHIFT;
2962 delta += event->time_delta;
2963 iter->read_stamp += delta;
2964 return;
2965
2966 case RINGBUF_TYPE_TIME_STAMP:
2967 /* FIXME: not implemented */
2968 return;
2969
2970 case RINGBUF_TYPE_DATA:
2971 iter->read_stamp += event->time_delta;
2972 return;
2973
2974 default:
2975 BUG();
2976 }
2977 return;
2978}
2979
Steven Rostedtd7690412008-10-01 00:29:53 -04002980static struct buffer_page *
2981rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002982{
Steven Rostedtd7690412008-10-01 00:29:53 -04002983 struct buffer_page *reader = NULL;
Steven Rostedt66a8cb92010-03-31 13:21:56 -04002984 unsigned long overwrite;
Steven Rostedtd7690412008-10-01 00:29:53 -04002985 unsigned long flags;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002986 int nr_loops = 0;
Steven Rostedt77ae3652009-03-27 11:00:29 -04002987 int ret;
Steven Rostedtd7690412008-10-01 00:29:53 -04002988
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002989 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01002990 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedtd7690412008-10-01 00:29:53 -04002991
2992 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002993 /*
2994 * This should normally only loop twice. But because the
2995 * start of the reader inserts an empty page, it causes
2996 * a case where we will loop three times. There should be no
2997 * reason to loop four times (that I know of).
2998 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002999 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003000 reader = NULL;
3001 goto out;
3002 }
3003
Steven Rostedtd7690412008-10-01 00:29:53 -04003004 reader = cpu_buffer->reader_page;
3005
3006 /* If there's more to read, return this page */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003007 if (cpu_buffer->reader_page->read < rb_page_size(reader))
Steven Rostedtd7690412008-10-01 00:29:53 -04003008 goto out;
3009
3010 /* Never should we have an index greater than the size */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003011 if (RB_WARN_ON(cpu_buffer,
3012 cpu_buffer->reader_page->read > rb_page_size(reader)))
3013 goto out;
Steven Rostedtd7690412008-10-01 00:29:53 -04003014
3015 /* check if we caught up to the tail */
3016 reader = NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003017 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
Steven Rostedtd7690412008-10-01 00:29:53 -04003018 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003019
3020 /*
Steven Rostedtd7690412008-10-01 00:29:53 -04003021 * Reset the reader page to size zero.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003022 */
Steven Rostedt77ae3652009-03-27 11:00:29 -04003023 local_set(&cpu_buffer->reader_page->write, 0);
3024 local_set(&cpu_buffer->reader_page->entries, 0);
3025 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedtff0ff842010-03-31 22:11:42 -04003026 cpu_buffer->reader_page->real_end = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003027
Steven Rostedt77ae3652009-03-27 11:00:29 -04003028 spin:
3029 /*
3030 * Splice the empty reader page into the list around the head.
3031 */
3032 reader = rb_set_head_page(cpu_buffer);
Steven Rostedt0e1ff5d2010-01-06 20:40:44 -05003033 cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
Steven Rostedtd7690412008-10-01 00:29:53 -04003034 cpu_buffer->reader_page->list.prev = reader->list.prev;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003035
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003036 /*
3037 * cpu_buffer->pages just needs to point to the buffer, it
3038 * has no specific buffer page to point to. Lets move it out
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003039 * of our way so we don't accidentally swap it.
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003040 */
3041 cpu_buffer->pages = reader->list.prev;
3042
Steven Rostedt77ae3652009-03-27 11:00:29 -04003043 /* The reader page will be pointing to the new head */
3044 rb_set_list_to_head(cpu_buffer, &cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -04003045
3046 /*
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003047 * We want to make sure we read the overruns after we set up our
3048 * pointers to the next object. The writer side does a
3049 * cmpxchg to cross pages which acts as the mb on the writer
3050 * side. Note, the reader will constantly fail the swap
3051 * while the writer is updating the pointers, so this
3052 * guarantees that the overwrite recorded here is the one we
3053 * want to compare with the last_overrun.
3054 */
3055 smp_mb();
3056 overwrite = local_read(&(cpu_buffer->overrun));
3057
3058 /*
Steven Rostedt77ae3652009-03-27 11:00:29 -04003059 * Here's the tricky part.
3060 *
3061 * We need to move the pointer past the header page.
3062 * But we can only do that if a writer is not currently
3063 * moving it. The page before the header page has the
3064 * flag bit '1' set if it is pointing to the page we want.
3065 * but if the writer is in the process of moving it
3066 * than it will be '2' or already moved '0'.
Steven Rostedtd7690412008-10-01 00:29:53 -04003067 */
Steven Rostedtd7690412008-10-01 00:29:53 -04003068
Steven Rostedt77ae3652009-03-27 11:00:29 -04003069 ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
3070
3071 /*
3072 * If we did not convert it, then we must try again.
3073 */
3074 if (!ret)
3075 goto spin;
3076
3077 /*
3078 * Yeah! We succeeded in replacing the page.
3079 *
3080 * Now make the new head point back to the reader page.
3081 */
David Sharp5ded3dc2010-01-06 17:12:07 -08003082 rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003083 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
Steven Rostedtd7690412008-10-01 00:29:53 -04003084
3085 /* Finally update the reader page to the new head */
3086 cpu_buffer->reader_page = reader;
3087 rb_reset_reader_page(cpu_buffer);
3088
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003089 if (overwrite != cpu_buffer->last_overrun) {
3090 cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
3091 cpu_buffer->last_overrun = overwrite;
3092 }
3093
Steven Rostedtd7690412008-10-01 00:29:53 -04003094 goto again;
3095
3096 out:
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003097 arch_spin_unlock(&cpu_buffer->lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05003098 local_irq_restore(flags);
Steven Rostedtd7690412008-10-01 00:29:53 -04003099
3100 return reader;
3101}
3102
3103static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
3104{
3105 struct ring_buffer_event *event;
3106 struct buffer_page *reader;
3107 unsigned length;
3108
3109 reader = rb_get_reader_page(cpu_buffer);
3110
3111 /* This function should not be called when buffer is empty */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003112 if (RB_WARN_ON(cpu_buffer, !reader))
3113 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04003114
3115 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003116
Steven Rostedta1863c22009-09-03 10:23:58 -04003117 if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Steven Rostedte4906ef2009-04-30 20:49:44 -04003118 cpu_buffer->read++;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003119
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003120 rb_update_read_stamp(cpu_buffer, event);
3121
Steven Rostedtd7690412008-10-01 00:29:53 -04003122 length = rb_event_length(event);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003123 cpu_buffer->reader_page->read += length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003124}
3125
3126static void rb_advance_iter(struct ring_buffer_iter *iter)
3127{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003128 struct ring_buffer_per_cpu *cpu_buffer;
3129 struct ring_buffer_event *event;
3130 unsigned length;
3131
3132 cpu_buffer = iter->cpu_buffer;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003133
3134 /*
3135 * Check if we are at the end of the buffer.
3136 */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003137 if (iter->head >= rb_page_size(iter->head_page)) {
Steven Rostedtea05b572009-06-03 09:30:10 -04003138 /* discarded commits can make the page empty */
3139 if (iter->head_page == cpu_buffer->commit_page)
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003140 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04003141 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003142 return;
3143 }
3144
3145 event = rb_iter_head_event(iter);
3146
3147 length = rb_event_length(event);
3148
3149 /*
3150 * This should not be called to advance the header if we are
3151 * at the tail of the buffer.
3152 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003153 if (RB_WARN_ON(cpu_buffer,
Steven Rostedtf536aaf2008-11-10 23:07:30 -05003154 (iter->head_page == cpu_buffer->commit_page) &&
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003155 (iter->head + length > rb_commit_index(cpu_buffer))))
3156 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003157
3158 rb_update_iter_read_stamp(iter, event);
3159
3160 iter->head += length;
3161
3162 /* check for end of page padding */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003163 if ((iter->head >= rb_page_size(iter->head_page)) &&
3164 (iter->head_page != cpu_buffer->commit_page))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003165 rb_advance_iter(iter);
3166}
3167
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003168static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
3169{
3170 return cpu_buffer->lost_events;
3171}
3172
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003173static struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003174rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
3175 unsigned long *lost_events)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003176{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003177 struct ring_buffer_event *event;
Steven Rostedtd7690412008-10-01 00:29:53 -04003178 struct buffer_page *reader;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003179 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003180
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003181 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003182 /*
Steven Rostedt69d1b832010-10-07 18:18:05 -04003183 * We repeat when a time extend is encountered.
3184 * Since the time extend is always attached to a data event,
3185 * we should never loop more than once.
3186 * (We never hit the following condition more than twice).
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003187 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04003188 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003189 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003190
Steven Rostedtd7690412008-10-01 00:29:53 -04003191 reader = rb_get_reader_page(cpu_buffer);
3192 if (!reader)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003193 return NULL;
3194
Steven Rostedtd7690412008-10-01 00:29:53 -04003195 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003196
Lai Jiangshan334d4162009-04-24 11:27:05 +08003197 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003198 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05003199 if (rb_null_event(event))
3200 RB_WARN_ON(cpu_buffer, 1);
3201 /*
3202 * Because the writer could be discarding every
3203 * event it creates (which would probably be bad)
3204 * if we were to go back to "again" then we may never
3205 * catch up, and will trigger the warn on, or lock
3206 * the box. Return the padding, and we will release
3207 * the current locks, and try again.
3208 */
Tom Zanussi2d622712009-03-22 03:30:49 -05003209 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003210
3211 case RINGBUF_TYPE_TIME_EXTEND:
3212 /* Internal data, OK to advance */
Steven Rostedtd7690412008-10-01 00:29:53 -04003213 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003214 goto again;
3215
3216 case RINGBUF_TYPE_TIME_STAMP:
3217 /* FIXME: not implemented */
Steven Rostedtd7690412008-10-01 00:29:53 -04003218 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003219 goto again;
3220
3221 case RINGBUF_TYPE_DATA:
3222 if (ts) {
3223 *ts = cpu_buffer->read_stamp + event->time_delta;
Robert Richterd8eeb2d2009-07-31 14:58:04 +02003224 ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
Steven Rostedt37886f62009-03-17 17:22:06 -04003225 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003226 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003227 if (lost_events)
3228 *lost_events = rb_lost_events(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003229 return event;
3230
3231 default:
3232 BUG();
3233 }
3234
3235 return NULL;
3236}
Robert Richterc4f50182008-12-11 16:49:22 +01003237EXPORT_SYMBOL_GPL(ring_buffer_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003238
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003239static struct ring_buffer_event *
3240rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003241{
3242 struct ring_buffer *buffer;
3243 struct ring_buffer_per_cpu *cpu_buffer;
3244 struct ring_buffer_event *event;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003245 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003246
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003247 cpu_buffer = iter->cpu_buffer;
3248 buffer = cpu_buffer->buffer;
3249
Steven Rostedt492a74f2010-01-25 15:17:47 -05003250 /*
3251 * Check if someone performed a consuming read to
3252 * the buffer. A consuming read invalidates the iterator
3253 * and we need to reset the iterator in this case.
3254 */
3255 if (unlikely(iter->cache_read != cpu_buffer->read ||
3256 iter->cache_reader_page != cpu_buffer->reader_page))
3257 rb_iter_reset(iter);
3258
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003259 again:
Steven Rostedt3c05d742010-01-26 16:14:08 -05003260 if (ring_buffer_iter_empty(iter))
3261 return NULL;
3262
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003263 /*
Steven Rostedt69d1b832010-10-07 18:18:05 -04003264 * We repeat when a time extend is encountered.
3265 * Since the time extend is always attached to a data event,
3266 * we should never loop more than once.
3267 * (We never hit the following condition more than twice).
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003268 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04003269 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003270 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003271
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003272 if (rb_per_cpu_empty(cpu_buffer))
3273 return NULL;
3274
Steven Rostedt3c05d742010-01-26 16:14:08 -05003275 if (iter->head >= local_read(&iter->head_page->page->commit)) {
3276 rb_inc_iter(iter);
3277 goto again;
3278 }
3279
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003280 event = rb_iter_head_event(iter);
3281
Lai Jiangshan334d4162009-04-24 11:27:05 +08003282 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003283 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05003284 if (rb_null_event(event)) {
3285 rb_inc_iter(iter);
3286 goto again;
3287 }
3288 rb_advance_iter(iter);
3289 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003290
3291 case RINGBUF_TYPE_TIME_EXTEND:
3292 /* Internal data, OK to advance */
3293 rb_advance_iter(iter);
3294 goto again;
3295
3296 case RINGBUF_TYPE_TIME_STAMP:
3297 /* FIXME: not implemented */
3298 rb_advance_iter(iter);
3299 goto again;
3300
3301 case RINGBUF_TYPE_DATA:
3302 if (ts) {
3303 *ts = iter->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04003304 ring_buffer_normalize_time_stamp(buffer,
3305 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003306 }
3307 return event;
3308
3309 default:
3310 BUG();
3311 }
3312
3313 return NULL;
3314}
Robert Richterc4f50182008-12-11 16:49:22 +01003315EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003316
Steven Rostedt8d707e82009-06-16 21:22:48 -04003317static inline int rb_ok_to_lock(void)
3318{
3319 /*
3320 * If an NMI die dumps out the content of the ring buffer
3321 * do not grab locks. We also permanently disable the ring
3322 * buffer too. A one time deal is all you get from reading
3323 * the ring buffer from an NMI.
3324 */
Steven Rostedt464e85e2009-08-05 15:26:37 -04003325 if (likely(!in_nmi()))
Steven Rostedt8d707e82009-06-16 21:22:48 -04003326 return 1;
3327
3328 tracing_off_permanent();
3329 return 0;
3330}
3331
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003332/**
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003333 * ring_buffer_peek - peek at the next event to be read
3334 * @buffer: The ring buffer to read
3335 * @cpu: The cpu to peak at
3336 * @ts: The timestamp counter of this event.
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003337 * @lost_events: a variable to store if events were lost (may be NULL)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003338 *
3339 * This will return the event that will be read next, but does
3340 * not consume the data.
3341 */
3342struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003343ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts,
3344 unsigned long *lost_events)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003345{
3346 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8aabee52009-03-12 13:13:49 -04003347 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003348 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003349 int dolock;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003350
Steven Rostedt554f7862009-03-11 22:00:13 -04003351 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003352 return NULL;
Steven Rostedt554f7862009-03-11 22:00:13 -04003353
Steven Rostedt8d707e82009-06-16 21:22:48 -04003354 dolock = rb_ok_to_lock();
Tom Zanussi2d622712009-03-22 03:30:49 -05003355 again:
Steven Rostedt8d707e82009-06-16 21:22:48 -04003356 local_irq_save(flags);
3357 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003358 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003359 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
Robert Richter469535a2009-07-30 19:19:18 +02003360 if (event && event->type_len == RINGBUF_TYPE_PADDING)
3361 rb_advance_reader(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003362 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003363 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003364 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003365
Steven Rostedt1b959e12009-09-03 10:12:13 -04003366 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003367 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003368
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003369 return event;
3370}
3371
3372/**
3373 * ring_buffer_iter_peek - peek at the next event to be read
3374 * @iter: The ring buffer iterator
3375 * @ts: The timestamp counter of this event.
3376 *
3377 * This will return the event that will be read next, but does
3378 * not increment the iterator.
3379 */
3380struct ring_buffer_event *
3381ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
3382{
3383 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3384 struct ring_buffer_event *event;
3385 unsigned long flags;
3386
Tom Zanussi2d622712009-03-22 03:30:49 -05003387 again:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003388 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003389 event = rb_iter_peek(iter, ts);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003390 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003391
Steven Rostedt1b959e12009-09-03 10:12:13 -04003392 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003393 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003394
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003395 return event;
3396}
3397
3398/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003399 * ring_buffer_consume - return an event and consume it
3400 * @buffer: The ring buffer to get the next event from
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003401 * @cpu: the cpu to read the buffer from
3402 * @ts: a variable to store the timestamp (may be NULL)
3403 * @lost_events: a variable to store if events were lost (may be NULL)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003404 *
3405 * Returns the next event in the ring buffer, and that event is consumed.
3406 * Meaning, that sequential reads will keep returning a different event,
3407 * and eventually empty the ring buffer if the producer is slower.
3408 */
3409struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003410ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts,
3411 unsigned long *lost_events)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003412{
Steven Rostedt554f7862009-03-11 22:00:13 -04003413 struct ring_buffer_per_cpu *cpu_buffer;
3414 struct ring_buffer_event *event = NULL;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003415 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003416 int dolock;
3417
3418 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003419
Tom Zanussi2d622712009-03-22 03:30:49 -05003420 again:
Steven Rostedt554f7862009-03-11 22:00:13 -04003421 /* might be called in atomic */
3422 preempt_disable();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003423
Steven Rostedt554f7862009-03-11 22:00:13 -04003424 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3425 goto out;
3426
3427 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003428 local_irq_save(flags);
3429 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003430 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003431
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003432 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
3433 if (event) {
3434 cpu_buffer->lost_events = 0;
Robert Richter469535a2009-07-30 19:19:18 +02003435 rb_advance_reader(cpu_buffer);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003436 }
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003437
Steven Rostedt8d707e82009-06-16 21:22:48 -04003438 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003439 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003440 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003441
Steven Rostedt554f7862009-03-11 22:00:13 -04003442 out:
3443 preempt_enable();
3444
Steven Rostedt1b959e12009-09-03 10:12:13 -04003445 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003446 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003447
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003448 return event;
3449}
Robert Richterc4f50182008-12-11 16:49:22 +01003450EXPORT_SYMBOL_GPL(ring_buffer_consume);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003451
3452/**
David Miller72c9ddf2010-04-20 15:47:11 -07003453 * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003454 * @buffer: The ring buffer to read from
3455 * @cpu: The cpu buffer to iterate over
3456 *
David Miller72c9ddf2010-04-20 15:47:11 -07003457 * This performs the initial preparations necessary to iterate
3458 * through the buffer. Memory is allocated, buffer recording
3459 * is disabled, and the iterator pointer is returned to the caller.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003460 *
David Miller72c9ddf2010-04-20 15:47:11 -07003461 * Disabling buffer recordng prevents the reading from being
3462 * corrupted. This is not a consuming read, so a producer is not
3463 * expected.
3464 *
3465 * After a sequence of ring_buffer_read_prepare calls, the user is
3466 * expected to make at least one call to ring_buffer_prepare_sync.
3467 * Afterwards, ring_buffer_read_start is invoked to get things going
3468 * for real.
3469 *
3470 * This overall must be paired with ring_buffer_finish.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003471 */
3472struct ring_buffer_iter *
David Miller72c9ddf2010-04-20 15:47:11 -07003473ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003474{
3475 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003476 struct ring_buffer_iter *iter;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003477
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303478 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003479 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003480
3481 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
3482 if (!iter)
Steven Rostedt8aabee52009-03-12 13:13:49 -04003483 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003484
3485 cpu_buffer = buffer->buffers[cpu];
3486
3487 iter->cpu_buffer = cpu_buffer;
3488
3489 atomic_inc(&cpu_buffer->record_disabled);
David Miller72c9ddf2010-04-20 15:47:11 -07003490
3491 return iter;
3492}
3493EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);
3494
3495/**
3496 * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
3497 *
3498 * All previously invoked ring_buffer_read_prepare calls to prepare
3499 * iterators will be synchronized. Afterwards, read_buffer_read_start
3500 * calls on those iterators are allowed.
3501 */
3502void
3503ring_buffer_read_prepare_sync(void)
3504{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003505 synchronize_sched();
David Miller72c9ddf2010-04-20 15:47:11 -07003506}
3507EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
3508
3509/**
3510 * ring_buffer_read_start - start a non consuming read of the buffer
3511 * @iter: The iterator returned by ring_buffer_read_prepare
3512 *
3513 * This finalizes the startup of an iteration through the buffer.
3514 * The iterator comes from a call to ring_buffer_read_prepare and
3515 * an intervening ring_buffer_read_prepare_sync must have been
3516 * performed.
3517 *
3518 * Must be paired with ring_buffer_finish.
3519 */
3520void
3521ring_buffer_read_start(struct ring_buffer_iter *iter)
3522{
3523 struct ring_buffer_per_cpu *cpu_buffer;
3524 unsigned long flags;
3525
3526 if (!iter)
3527 return;
3528
3529 cpu_buffer = iter->cpu_buffer;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003530
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003531 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003532 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedt642edba2008-11-12 00:01:26 -05003533 rb_iter_reset(iter);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003534 arch_spin_unlock(&cpu_buffer->lock);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003535 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003536}
Robert Richterc4f50182008-12-11 16:49:22 +01003537EXPORT_SYMBOL_GPL(ring_buffer_read_start);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003538
3539/**
3540 * ring_buffer_finish - finish reading the iterator of the buffer
3541 * @iter: The iterator retrieved by ring_buffer_start
3542 *
3543 * This re-enables the recording to the buffer, and frees the
3544 * iterator.
3545 */
3546void
3547ring_buffer_read_finish(struct ring_buffer_iter *iter)
3548{
3549 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3550
3551 atomic_dec(&cpu_buffer->record_disabled);
3552 kfree(iter);
3553}
Robert Richterc4f50182008-12-11 16:49:22 +01003554EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003555
3556/**
3557 * ring_buffer_read - read the next item in the ring buffer by the iterator
3558 * @iter: The ring buffer iterator
3559 * @ts: The time stamp of the event read.
3560 *
3561 * This reads the next event in the ring buffer and increments the iterator.
3562 */
3563struct ring_buffer_event *
3564ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
3565{
3566 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003567 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3568 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003569
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003570 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt7e9391c2009-09-03 10:02:09 -04003571 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003572 event = rb_iter_peek(iter, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003573 if (!event)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003574 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003575
Steven Rostedt7e9391c2009-09-03 10:02:09 -04003576 if (event->type_len == RINGBUF_TYPE_PADDING)
3577 goto again;
3578
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003579 rb_advance_iter(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003580 out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003581 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003582
3583 return event;
3584}
Robert Richterc4f50182008-12-11 16:49:22 +01003585EXPORT_SYMBOL_GPL(ring_buffer_read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003586
3587/**
3588 * ring_buffer_size - return the size of the ring buffer (in bytes)
3589 * @buffer: The ring buffer.
3590 */
3591unsigned long ring_buffer_size(struct ring_buffer *buffer)
3592{
3593 return BUF_PAGE_SIZE * buffer->pages;
3594}
Robert Richterc4f50182008-12-11 16:49:22 +01003595EXPORT_SYMBOL_GPL(ring_buffer_size);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003596
3597static void
3598rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
3599{
Steven Rostedt77ae3652009-03-27 11:00:29 -04003600 rb_head_page_deactivate(cpu_buffer);
3601
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003602 cpu_buffer->head_page
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003603 = list_entry(cpu_buffer->pages, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04003604 local_set(&cpu_buffer->head_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003605 local_set(&cpu_buffer->head_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05003606 local_set(&cpu_buffer->head_page->page->commit, 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003607
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003608 cpu_buffer->head_page->read = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003609
3610 cpu_buffer->tail_page = cpu_buffer->head_page;
3611 cpu_buffer->commit_page = cpu_buffer->head_page;
3612
3613 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
3614 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003615 local_set(&cpu_buffer->reader_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05003616 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003617 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04003618
Steven Rostedt77ae3652009-03-27 11:00:29 -04003619 local_set(&cpu_buffer->commit_overrun, 0);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07003620 local_set(&cpu_buffer->entries_bytes, 0);
Steven Rostedt77ae3652009-03-27 11:00:29 -04003621 local_set(&cpu_buffer->overrun, 0);
Steven Rostedte4906ef2009-04-30 20:49:44 -04003622 local_set(&cpu_buffer->entries, 0);
Steven Rostedtfa743952009-06-16 12:37:57 -04003623 local_set(&cpu_buffer->committing, 0);
3624 local_set(&cpu_buffer->commits, 0);
Steven Rostedt77ae3652009-03-27 11:00:29 -04003625 cpu_buffer->read = 0;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07003626 cpu_buffer->read_bytes = 0;
Steven Rostedt69507c02009-01-21 18:45:57 -05003627
3628 cpu_buffer->write_stamp = 0;
3629 cpu_buffer->read_stamp = 0;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003630
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003631 cpu_buffer->lost_events = 0;
3632 cpu_buffer->last_overrun = 0;
3633
Steven Rostedt77ae3652009-03-27 11:00:29 -04003634 rb_head_page_activate(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003635}
3636
3637/**
3638 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
3639 * @buffer: The ring buffer to reset a per cpu buffer of
3640 * @cpu: The CPU buffer to be reset
3641 */
3642void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
3643{
3644 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
3645 unsigned long flags;
3646
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303647 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003648 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003649
Steven Rostedt41ede232009-05-01 20:26:54 -04003650 atomic_inc(&cpu_buffer->record_disabled);
3651
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003652 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003653
Steven Rostedt41b6a952009-09-02 09:59:48 -04003654 if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
3655 goto out;
3656
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003657 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003658
3659 rb_reset_cpu(cpu_buffer);
3660
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003661 arch_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003662
Steven Rostedt41b6a952009-09-02 09:59:48 -04003663 out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003664 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt41ede232009-05-01 20:26:54 -04003665
3666 atomic_dec(&cpu_buffer->record_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003667}
Robert Richterc4f50182008-12-11 16:49:22 +01003668EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003669
3670/**
3671 * ring_buffer_reset - reset a ring buffer
3672 * @buffer: The ring buffer to reset all cpu buffers
3673 */
3674void ring_buffer_reset(struct ring_buffer *buffer)
3675{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003676 int cpu;
3677
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003678 for_each_buffer_cpu(buffer, cpu)
Steven Rostedtd7690412008-10-01 00:29:53 -04003679 ring_buffer_reset_cpu(buffer, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003680}
Robert Richterc4f50182008-12-11 16:49:22 +01003681EXPORT_SYMBOL_GPL(ring_buffer_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003682
3683/**
3684 * rind_buffer_empty - is the ring buffer empty?
3685 * @buffer: The ring buffer to test
3686 */
3687int ring_buffer_empty(struct ring_buffer *buffer)
3688{
3689 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04003690 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003691 int dolock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003692 int cpu;
Steven Rostedtd4788202009-06-17 00:39:43 -04003693 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003694
Steven Rostedt8d707e82009-06-16 21:22:48 -04003695 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003696
3697 /* yes this is racy, but if you don't like the race, lock the buffer */
3698 for_each_buffer_cpu(buffer, cpu) {
3699 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003700 local_irq_save(flags);
3701 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003702 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedtd4788202009-06-17 00:39:43 -04003703 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003704 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003705 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003706 local_irq_restore(flags);
3707
Steven Rostedtd4788202009-06-17 00:39:43 -04003708 if (!ret)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003709 return 0;
3710 }
Steven Rostedt554f7862009-03-11 22:00:13 -04003711
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003712 return 1;
3713}
Robert Richterc4f50182008-12-11 16:49:22 +01003714EXPORT_SYMBOL_GPL(ring_buffer_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003715
3716/**
3717 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
3718 * @buffer: The ring buffer
3719 * @cpu: The CPU buffer to test
3720 */
3721int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
3722{
3723 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04003724 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003725 int dolock;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003726 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003727
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303728 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003729 return 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003730
Steven Rostedt8d707e82009-06-16 21:22:48 -04003731 dolock = rb_ok_to_lock();
Steven Rostedt554f7862009-03-11 22:00:13 -04003732
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003733 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003734 local_irq_save(flags);
3735 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003736 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt554f7862009-03-11 22:00:13 -04003737 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003738 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003739 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003740 local_irq_restore(flags);
Steven Rostedt554f7862009-03-11 22:00:13 -04003741
3742 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003743}
Robert Richterc4f50182008-12-11 16:49:22 +01003744EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003745
Steven Rostedt85bac322009-09-04 14:24:40 -04003746#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003747/**
3748 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
3749 * @buffer_a: One buffer to swap with
3750 * @buffer_b: The other buffer to swap with
3751 *
3752 * This function is useful for tracers that want to take a "snapshot"
3753 * of a CPU buffer and has another back up buffer lying around.
3754 * it is expected that the tracer handles the cpu buffer not being
3755 * used at the moment.
3756 */
3757int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
3758 struct ring_buffer *buffer_b, int cpu)
3759{
3760 struct ring_buffer_per_cpu *cpu_buffer_a;
3761 struct ring_buffer_per_cpu *cpu_buffer_b;
Steven Rostedt554f7862009-03-11 22:00:13 -04003762 int ret = -EINVAL;
3763
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303764 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
3765 !cpumask_test_cpu(cpu, buffer_b->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04003766 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003767
3768 /* At least make sure the two buffers are somewhat the same */
Lai Jiangshan6d102bc2008-12-17 17:48:23 +08003769 if (buffer_a->pages != buffer_b->pages)
Steven Rostedt554f7862009-03-11 22:00:13 -04003770 goto out;
3771
3772 ret = -EAGAIN;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003773
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003774 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedt554f7862009-03-11 22:00:13 -04003775 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003776
3777 if (atomic_read(&buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04003778 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003779
3780 if (atomic_read(&buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04003781 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003782
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003783 cpu_buffer_a = buffer_a->buffers[cpu];
3784 cpu_buffer_b = buffer_b->buffers[cpu];
3785
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003786 if (atomic_read(&cpu_buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04003787 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003788
3789 if (atomic_read(&cpu_buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04003790 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05003791
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003792 /*
3793 * We can't do a synchronize_sched here because this
3794 * function can be called in atomic context.
3795 * Normally this will be called from the same CPU as cpu.
3796 * If not it's up to the caller to protect this.
3797 */
3798 atomic_inc(&cpu_buffer_a->record_disabled);
3799 atomic_inc(&cpu_buffer_b->record_disabled);
3800
Steven Rostedt98277992009-09-02 10:56:15 -04003801 ret = -EBUSY;
3802 if (local_read(&cpu_buffer_a->committing))
3803 goto out_dec;
3804 if (local_read(&cpu_buffer_b->committing))
3805 goto out_dec;
3806
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003807 buffer_a->buffers[cpu] = cpu_buffer_b;
3808 buffer_b->buffers[cpu] = cpu_buffer_a;
3809
3810 cpu_buffer_b->buffer = buffer_a;
3811 cpu_buffer_a->buffer = buffer_b;
3812
Steven Rostedt98277992009-09-02 10:56:15 -04003813 ret = 0;
3814
3815out_dec:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003816 atomic_dec(&cpu_buffer_a->record_disabled);
3817 atomic_dec(&cpu_buffer_b->record_disabled);
Steven Rostedt554f7862009-03-11 22:00:13 -04003818out:
Steven Rostedt554f7862009-03-11 22:00:13 -04003819 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003820}
Robert Richterc4f50182008-12-11 16:49:22 +01003821EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
Steven Rostedt85bac322009-09-04 14:24:40 -04003822#endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003823
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003824/**
3825 * ring_buffer_alloc_read_page - allocate a page to read from buffer
3826 * @buffer: the buffer to allocate for.
3827 *
3828 * This function is used in conjunction with ring_buffer_read_page.
3829 * When reading a full page from the ring buffer, these functions
3830 * can be used to speed up the process. The calling function should
3831 * allocate a few pages first with this function. Then when it
3832 * needs to get pages from the ring buffer, it passes the result
3833 * of this function into ring_buffer_read_page, which will swap
3834 * the page that was allocated, with the read page of the buffer.
3835 *
3836 * Returns:
3837 * The page allocated, or NULL on error.
3838 */
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07003839void *ring_buffer_alloc_read_page(struct ring_buffer *buffer, int cpu)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003840{
Steven Rostedt044fa782008-12-02 23:50:03 -05003841 struct buffer_data_page *bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07003842 struct page *page;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003843
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07003844 page = alloc_pages_node(cpu_to_node(cpu),
3845 GFP_KERNEL | __GFP_NORETRY, 0);
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07003846 if (!page)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003847 return NULL;
3848
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07003849 bpage = page_address(page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003850
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003851 rb_init_page(bpage);
3852
Steven Rostedt044fa782008-12-02 23:50:03 -05003853 return bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003854}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04003855EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003856
3857/**
3858 * ring_buffer_free_read_page - free an allocated read page
3859 * @buffer: the buffer the page was allocate for
3860 * @data: the page to free
3861 *
3862 * Free a page allocated from ring_buffer_alloc_read_page.
3863 */
3864void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
3865{
3866 free_page((unsigned long)data);
3867}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04003868EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003869
3870/**
3871 * ring_buffer_read_page - extract a page from the ring buffer
3872 * @buffer: buffer to extract from
3873 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003874 * @len: amount to extract
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003875 * @cpu: the cpu of the buffer to extract
3876 * @full: should the extraction only happen when the page is full.
3877 *
3878 * This function will pull out a page from the ring buffer and consume it.
3879 * @data_page must be the address of the variable that was returned
3880 * from ring_buffer_alloc_read_page. This is because the page might be used
3881 * to swap with a page in the ring buffer.
3882 *
3883 * for example:
Lai Jiangshanb85fa012009-02-09 14:21:14 +08003884 * rpage = ring_buffer_alloc_read_page(buffer);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003885 * if (!rpage)
3886 * return error;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003887 * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
Lai Jiangshan667d2412009-02-09 14:21:17 +08003888 * if (ret >= 0)
3889 * process_page(rpage, ret);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003890 *
3891 * When @full is set, the function will not return true unless
3892 * the writer is off the reader page.
3893 *
3894 * Note: it is up to the calling functions to handle sleeps and wakeups.
3895 * The ring buffer can be used anywhere in the kernel and can not
3896 * blindly call wake_up. The layer that uses the ring buffer must be
3897 * responsible for that.
3898 *
3899 * Returns:
Lai Jiangshan667d2412009-02-09 14:21:17 +08003900 * >=0 if data has been transferred, returns the offset of consumed data.
3901 * <0 if no data has been transferred.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003902 */
3903int ring_buffer_read_page(struct ring_buffer *buffer,
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003904 void **data_page, size_t len, int cpu, int full)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003905{
3906 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
3907 struct ring_buffer_event *event;
Steven Rostedt044fa782008-12-02 23:50:03 -05003908 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003909 struct buffer_page *reader;
Steven Rostedtff0ff842010-03-31 22:11:42 -04003910 unsigned long missed_events;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003911 unsigned long flags;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003912 unsigned int commit;
Lai Jiangshan667d2412009-02-09 14:21:17 +08003913 unsigned int read;
Steven Rostedt4f3640f2009-03-03 23:52:42 -05003914 u64 save_timestamp;
Lai Jiangshan667d2412009-02-09 14:21:17 +08003915 int ret = -1;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003916
Steven Rostedt554f7862009-03-11 22:00:13 -04003917 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3918 goto out;
3919
Steven Rostedt474d32b2009-03-03 19:51:40 -05003920 /*
3921 * If len is not big enough to hold the page header, then
3922 * we can not copy anything.
3923 */
3924 if (len <= BUF_PAGE_HDR_SIZE)
Steven Rostedt554f7862009-03-11 22:00:13 -04003925 goto out;
Steven Rostedt474d32b2009-03-03 19:51:40 -05003926
3927 len -= BUF_PAGE_HDR_SIZE;
3928
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003929 if (!data_page)
Steven Rostedt554f7862009-03-11 22:00:13 -04003930 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003931
Steven Rostedt044fa782008-12-02 23:50:03 -05003932 bpage = *data_page;
3933 if (!bpage)
Steven Rostedt554f7862009-03-11 22:00:13 -04003934 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003935
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003936 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003937
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003938 reader = rb_get_reader_page(cpu_buffer);
3939 if (!reader)
Steven Rostedt554f7862009-03-11 22:00:13 -04003940 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003941
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003942 event = rb_reader_event(cpu_buffer);
Lai Jiangshan667d2412009-02-09 14:21:17 +08003943
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003944 read = reader->read;
3945 commit = rb_page_commit(reader);
3946
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003947 /* Check if any events were dropped */
Steven Rostedtff0ff842010-03-31 22:11:42 -04003948 missed_events = cpu_buffer->lost_events;
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003949
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003950 /*
Steven Rostedt474d32b2009-03-03 19:51:40 -05003951 * If this page has been partially read or
3952 * if len is not big enough to read the rest of the page or
3953 * a writer is still on the page, then
3954 * we must copy the data from the page to the buffer.
3955 * Otherwise, we can simply swap the page with the one passed in.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003956 */
Steven Rostedt474d32b2009-03-03 19:51:40 -05003957 if (read || (len < (commit - read)) ||
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003958 cpu_buffer->reader_page == cpu_buffer->commit_page) {
Lai Jiangshan667d2412009-02-09 14:21:17 +08003959 struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
Steven Rostedt474d32b2009-03-03 19:51:40 -05003960 unsigned int rpos = read;
3961 unsigned int pos = 0;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003962 unsigned int size;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003963
3964 if (full)
Steven Rostedt554f7862009-03-11 22:00:13 -04003965 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003966
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003967 if (len > (commit - read))
3968 len = (commit - read);
3969
Steven Rostedt69d1b832010-10-07 18:18:05 -04003970 /* Always keep the time extend and data together */
3971 size = rb_event_ts_length(event);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003972
3973 if (len < size)
Steven Rostedt554f7862009-03-11 22:00:13 -04003974 goto out_unlock;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003975
Steven Rostedt4f3640f2009-03-03 23:52:42 -05003976 /* save the current timestamp, since the user will need it */
3977 save_timestamp = cpu_buffer->read_stamp;
3978
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003979 /* Need to copy one event at a time */
3980 do {
David Sharpe1e35922010-12-22 16:38:24 -08003981 /* We need the size of one event, because
3982 * rb_advance_reader only advances by one event,
3983 * whereas rb_event_ts_length may include the size of
3984 * one or two events.
3985 * We have already ensured there's enough space if this
3986 * is a time extend. */
3987 size = rb_event_length(event);
Steven Rostedt474d32b2009-03-03 19:51:40 -05003988 memcpy(bpage->data + pos, rpage->data + rpos, size);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003989
3990 len -= size;
3991
3992 rb_advance_reader(cpu_buffer);
Steven Rostedt474d32b2009-03-03 19:51:40 -05003993 rpos = reader->read;
3994 pos += size;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003995
Huang Ying18fab912010-07-28 14:14:01 +08003996 if (rpos >= commit)
3997 break;
3998
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003999 event = rb_reader_event(cpu_buffer);
Steven Rostedt69d1b832010-10-07 18:18:05 -04004000 /* Always keep the time extend and data together */
4001 size = rb_event_ts_length(event);
David Sharpe1e35922010-12-22 16:38:24 -08004002 } while (len >= size);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004003
4004 /* update bpage */
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004005 local_set(&bpage->commit, pos);
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004006 bpage->time_stamp = save_timestamp;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004007
Steven Rostedt474d32b2009-03-03 19:51:40 -05004008 /* we copied everything to the beginning */
4009 read = 0;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004010 } else {
Steven Rostedtafbab762009-05-01 19:40:05 -04004011 /* update the entry counter */
Steven Rostedt77ae3652009-03-27 11:00:29 -04004012 cpu_buffer->read += rb_page_entries(reader);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07004013 cpu_buffer->read_bytes += BUF_PAGE_SIZE;
Steven Rostedtafbab762009-05-01 19:40:05 -04004014
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004015 /* swap the pages */
Steven Rostedt044fa782008-12-02 23:50:03 -05004016 rb_init_page(bpage);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004017 bpage = reader->page;
4018 reader->page = *data_page;
4019 local_set(&reader->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04004020 local_set(&reader->entries, 0);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004021 reader->read = 0;
Steven Rostedt044fa782008-12-02 23:50:03 -05004022 *data_page = bpage;
Steven Rostedtff0ff842010-03-31 22:11:42 -04004023
4024 /*
4025 * Use the real_end for the data size,
4026 * This gives us a chance to store the lost events
4027 * on the page.
4028 */
4029 if (reader->real_end)
4030 local_set(&bpage->commit, reader->real_end);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004031 }
Lai Jiangshan667d2412009-02-09 14:21:17 +08004032 ret = read;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004033
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004034 cpu_buffer->lost_events = 0;
Steven Rostedt2711ca22010-05-21 13:32:26 -04004035
4036 commit = local_read(&bpage->commit);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004037 /*
4038 * Set a flag in the commit field if we lost events
4039 */
Steven Rostedtff0ff842010-03-31 22:11:42 -04004040 if (missed_events) {
Steven Rostedtff0ff842010-03-31 22:11:42 -04004041 /* If there is room at the end of the page to save the
4042 * missed events, then record it there.
4043 */
4044 if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
4045 memcpy(&bpage->data[commit], &missed_events,
4046 sizeof(missed_events));
4047 local_add(RB_MISSED_STORED, &bpage->commit);
Steven Rostedt2711ca22010-05-21 13:32:26 -04004048 commit += sizeof(missed_events);
Steven Rostedtff0ff842010-03-31 22:11:42 -04004049 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004050 local_add(RB_MISSED_EVENTS, &bpage->commit);
Steven Rostedtff0ff842010-03-31 22:11:42 -04004051 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004052
Steven Rostedt2711ca22010-05-21 13:32:26 -04004053 /*
4054 * This page may be off to user land. Zero it out here.
4055 */
4056 if (commit < BUF_PAGE_SIZE)
4057 memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);
4058
Steven Rostedt554f7862009-03-11 22:00:13 -04004059 out_unlock:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02004060 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004061
Steven Rostedt554f7862009-03-11 22:00:13 -04004062 out:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004063 return ret;
4064}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004065EXPORT_SYMBOL_GPL(ring_buffer_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004066
Steven Rostedt59222ef2009-03-12 11:46:03 -04004067#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01004068static int rb_cpu_notify(struct notifier_block *self,
4069 unsigned long action, void *hcpu)
Steven Rostedt554f7862009-03-11 22:00:13 -04004070{
4071 struct ring_buffer *buffer =
4072 container_of(self, struct ring_buffer, cpu_notify);
4073 long cpu = (long)hcpu;
4074
4075 switch (action) {
4076 case CPU_UP_PREPARE:
4077 case CPU_UP_PREPARE_FROZEN:
Rusty Russell3f237a72009-06-12 21:15:30 +09304078 if (cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04004079 return NOTIFY_OK;
4080
4081 buffer->buffers[cpu] =
4082 rb_allocate_cpu_buffer(buffer, cpu);
4083 if (!buffer->buffers[cpu]) {
4084 WARN(1, "failed to allocate ring buffer on CPU %ld\n",
4085 cpu);
4086 return NOTIFY_OK;
4087 }
4088 smp_wmb();
Rusty Russell3f237a72009-06-12 21:15:30 +09304089 cpumask_set_cpu(cpu, buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -04004090 break;
4091 case CPU_DOWN_PREPARE:
4092 case CPU_DOWN_PREPARE_FROZEN:
4093 /*
4094 * Do nothing.
4095 * If we were to free the buffer, then the user would
4096 * lose any trace that was in the buffer.
4097 */
4098 break;
4099 default:
4100 break;
4101 }
4102 return NOTIFY_OK;
4103}
4104#endif