blob: ba39cbabdc9fe6f1b94a19047ee994c9f1a511fa [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
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -070026static void update_pages_handler(struct work_struct *work);
27
Steven Rostedt033601a2008-11-21 12:41:55 -050028/*
Steven Rostedtd1b182a2009-04-15 16:53:47 -040029 * The ring buffer header is special. We must manually up keep it.
30 */
31int ring_buffer_print_entry_header(struct trace_seq *s)
32{
33 int ret;
34
Lai Jiangshan334d4162009-04-24 11:27:05 +080035 ret = trace_seq_printf(s, "# compressed entry header\n");
36 ret = trace_seq_printf(s, "\ttype_len : 5 bits\n");
Steven Rostedtd1b182a2009-04-15 16:53:47 -040037 ret = trace_seq_printf(s, "\ttime_delta : 27 bits\n");
38 ret = trace_seq_printf(s, "\tarray : 32 bits\n");
39 ret = trace_seq_printf(s, "\n");
40 ret = trace_seq_printf(s, "\tpadding : type == %d\n",
41 RINGBUF_TYPE_PADDING);
42 ret = trace_seq_printf(s, "\ttime_extend : type == %d\n",
43 RINGBUF_TYPE_TIME_EXTEND);
Lai Jiangshan334d4162009-04-24 11:27:05 +080044 ret = trace_seq_printf(s, "\tdata max type_len == %d\n",
45 RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
Steven Rostedtd1b182a2009-04-15 16:53:47 -040046
47 return ret;
48}
49
50/*
Steven Rostedt5cc98542009-03-12 22:24:17 -040051 * The ring buffer is made up of a list of pages. A separate list of pages is
52 * allocated for each CPU. A writer may only write to a buffer that is
53 * associated with the CPU it is currently executing on. A reader may read
54 * from any per cpu buffer.
55 *
56 * The reader is special. For each per cpu buffer, the reader has its own
57 * reader page. When a reader has read the entire reader page, this reader
58 * page is swapped with another page in the ring buffer.
59 *
60 * Now, as long as the writer is off the reader page, the reader can do what
61 * ever it wants with that page. The writer will never write to that page
62 * again (as long as it is out of the ring buffer).
63 *
64 * Here's some silly ASCII art.
65 *
66 * +------+
67 * |reader| RING BUFFER
68 * |page |
69 * +------+ +---+ +---+ +---+
70 * | |-->| |-->| |
71 * +---+ +---+ +---+
72 * ^ |
73 * | |
74 * +---------------+
75 *
76 *
77 * +------+
78 * |reader| RING BUFFER
79 * |page |------------------v
80 * +------+ +---+ +---+ +---+
81 * | |-->| |-->| |
82 * +---+ +---+ +---+
83 * ^ |
84 * | |
85 * +---------------+
86 *
87 *
88 * +------+
89 * |reader| RING BUFFER
90 * |page |------------------v
91 * +------+ +---+ +---+ +---+
92 * ^ | |-->| |-->| |
93 * | +---+ +---+ +---+
94 * | |
95 * | |
96 * +------------------------------+
97 *
98 *
99 * +------+
100 * |buffer| RING BUFFER
101 * |page |------------------v
102 * +------+ +---+ +---+ +---+
103 * ^ | | | |-->| |
104 * | New +---+ +---+ +---+
105 * | Reader------^ |
106 * | page |
107 * +------------------------------+
108 *
109 *
110 * After we make this swap, the reader can hand this page off to the splice
111 * code and be done with it. It can even allocate a new page if it needs to
112 * and swap that into the ring buffer.
113 *
114 * We will be using cmpxchg soon to make all this lockless.
115 *
116 */
117
118/*
Steven Rostedt033601a2008-11-21 12:41:55 -0500119 * A fast way to enable or disable all ring buffers is to
120 * call tracing_on or tracing_off. Turning off the ring buffers
121 * prevents all ring buffers from being recorded to.
122 * Turning this switch on, makes it OK to write to the
123 * ring buffer, if the ring buffer is enabled itself.
124 *
125 * There's three layers that must be on in order to write
126 * to the ring buffer.
127 *
128 * 1) This global flag must be set.
129 * 2) The ring buffer must be enabled for recording.
130 * 3) The per cpu buffer must be enabled for recording.
131 *
132 * In case of an anomaly, this global flag has a bit set that
133 * will permantly disable all ring buffers.
134 */
135
136/*
137 * Global flag to disable all recording to ring buffers
138 * This has two bits: ON, DISABLED
139 *
140 * ON DISABLED
141 * ---- ----------
142 * 0 0 : ring buffers are off
143 * 1 0 : ring buffers are on
144 * X 1 : ring buffers are permanently disabled
145 */
146
147enum {
148 RB_BUFFERS_ON_BIT = 0,
149 RB_BUFFERS_DISABLED_BIT = 1,
150};
151
152enum {
153 RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
154 RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
155};
156
Hannes Eder5e398412009-02-10 19:44:34 +0100157static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
Steven Rostedta3583242008-11-11 15:01:42 -0500158
Steven Rostedt499e5472012-02-22 15:50:28 -0500159/* Used for individual buffers (after the counter) */
160#define RB_BUFFER_OFF (1 << 20)
161
Steven Rostedt474d32b2009-03-03 19:51:40 -0500162#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
163
Steven Rostedta3583242008-11-11 15:01:42 -0500164/**
Steven Rostedt033601a2008-11-21 12:41:55 -0500165 * tracing_off_permanent - permanently disable ring buffers
166 *
167 * This function, once called, will disable all ring buffers
Wenji Huangc3706f02009-02-10 01:03:18 -0500168 * permanently.
Steven Rostedt033601a2008-11-21 12:41:55 -0500169 */
170void tracing_off_permanent(void)
171{
172 set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -0500173}
174
Steven Rostedte3d6bf02009-03-03 13:53:07 -0500175#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
Andrew Morton67d34722009-01-09 12:27:09 -0800176#define RB_ALIGNMENT 4U
Lai Jiangshan334d4162009-04-24 11:27:05 +0800177#define RB_MAX_SMALL_DATA (RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Steven Rostedtc7b09302009-06-11 11:12:00 -0400178#define RB_EVNT_MIN_SIZE 8U /* two 32bit words */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800179
Steven Rostedt22710482010-03-18 17:54:19 -0400180#if !defined(CONFIG_64BIT) || defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
181# define RB_FORCE_8BYTE_ALIGNMENT 0
182# define RB_ARCH_ALIGNMENT RB_ALIGNMENT
183#else
184# define RB_FORCE_8BYTE_ALIGNMENT 1
185# define RB_ARCH_ALIGNMENT 8U
186#endif
187
Lai Jiangshan334d4162009-04-24 11:27:05 +0800188/* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
189#define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400190
191enum {
192 RB_LEN_TIME_EXTEND = 8,
193 RB_LEN_TIME_STAMP = 16,
194};
195
Steven Rostedt69d1b832010-10-07 18:18:05 -0400196#define skip_time_extend(event) \
197 ((struct ring_buffer_event *)((char *)event + RB_LEN_TIME_EXTEND))
198
Tom Zanussi2d622712009-03-22 03:30:49 -0500199static inline int rb_null_event(struct ring_buffer_event *event)
200{
Steven Rostedta1863c22009-09-03 10:23:58 -0400201 return event->type_len == RINGBUF_TYPE_PADDING && !event->time_delta;
Tom Zanussi2d622712009-03-22 03:30:49 -0500202}
203
204static void rb_event_set_padding(struct ring_buffer_event *event)
205{
Steven Rostedta1863c22009-09-03 10:23:58 -0400206 /* padding has a NULL time_delta */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800207 event->type_len = RINGBUF_TYPE_PADDING;
Tom Zanussi2d622712009-03-22 03:30:49 -0500208 event->time_delta = 0;
209}
210
Tom Zanussi2d622712009-03-22 03:30:49 -0500211static unsigned
212rb_event_data_length(struct ring_buffer_event *event)
213{
214 unsigned length;
215
Lai Jiangshan334d4162009-04-24 11:27:05 +0800216 if (event->type_len)
217 length = event->type_len * RB_ALIGNMENT;
Tom Zanussi2d622712009-03-22 03:30:49 -0500218 else
219 length = event->array[0];
220 return length + RB_EVNT_HDR_SIZE;
221}
222
Steven Rostedt69d1b832010-10-07 18:18:05 -0400223/*
224 * Return the length of the given event. Will return
225 * the length of the time extend if the event is a
226 * time extend.
227 */
228static inline unsigned
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400229rb_event_length(struct ring_buffer_event *event)
230{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800231 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400232 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -0500233 if (rb_null_event(event))
234 /* undefined */
235 return -1;
Lai Jiangshan334d4162009-04-24 11:27:05 +0800236 return event->array[0] + RB_EVNT_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400237
238 case RINGBUF_TYPE_TIME_EXTEND:
239 return RB_LEN_TIME_EXTEND;
240
241 case RINGBUF_TYPE_TIME_STAMP:
242 return RB_LEN_TIME_STAMP;
243
244 case RINGBUF_TYPE_DATA:
Tom Zanussi2d622712009-03-22 03:30:49 -0500245 return rb_event_data_length(event);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400246 default:
247 BUG();
248 }
249 /* not hit */
250 return 0;
251}
252
Steven Rostedt69d1b832010-10-07 18:18:05 -0400253/*
254 * Return total length of time extend and data,
255 * or just the event length for all other events.
256 */
257static inline unsigned
258rb_event_ts_length(struct ring_buffer_event *event)
259{
260 unsigned len = 0;
261
262 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
263 /* time extends include the data event after it */
264 len = RB_LEN_TIME_EXTEND;
265 event = skip_time_extend(event);
266 }
267 return len + rb_event_length(event);
268}
269
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400270/**
271 * ring_buffer_event_length - return the length of the event
272 * @event: the event to get the length of
Steven Rostedt69d1b832010-10-07 18:18:05 -0400273 *
274 * Returns the size of the data load of a data event.
275 * If the event is something other than a data event, it
276 * returns the size of the event itself. With the exception
277 * of a TIME EXTEND, where it still returns the size of the
278 * data load of the data event after it.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400279 */
280unsigned ring_buffer_event_length(struct ring_buffer_event *event)
281{
Steven Rostedt69d1b832010-10-07 18:18:05 -0400282 unsigned length;
283
284 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
285 event = skip_time_extend(event);
286
287 length = rb_event_length(event);
Lai Jiangshan334d4162009-04-24 11:27:05 +0800288 if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Robert Richter465634a2009-01-07 15:32:11 +0100289 return length;
290 length -= RB_EVNT_HDR_SIZE;
291 if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
292 length -= sizeof(event->array[0]);
293 return length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400294}
Robert Richterc4f50182008-12-11 16:49:22 +0100295EXPORT_SYMBOL_GPL(ring_buffer_event_length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400296
297/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800298static void *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400299rb_event_data(struct ring_buffer_event *event)
300{
Steven Rostedt69d1b832010-10-07 18:18:05 -0400301 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
302 event = skip_time_extend(event);
Lai Jiangshan334d4162009-04-24 11:27:05 +0800303 BUG_ON(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400304 /* If length is in len field, then array[0] has the data */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800305 if (event->type_len)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400306 return (void *)&event->array[0];
307 /* Otherwise length is in array[0] and array[1] has the data */
308 return (void *)&event->array[1];
309}
310
311/**
312 * ring_buffer_event_data - return the data of the event
313 * @event: the event to get the data from
314 */
315void *ring_buffer_event_data(struct ring_buffer_event *event)
316{
317 return rb_event_data(event);
318}
Robert Richterc4f50182008-12-11 16:49:22 +0100319EXPORT_SYMBOL_GPL(ring_buffer_event_data);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400320
321#define for_each_buffer_cpu(buffer, cpu) \
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030322 for_each_cpu(cpu, buffer->cpumask)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400323
324#define TS_SHIFT 27
325#define TS_MASK ((1ULL << TS_SHIFT) - 1)
326#define TS_DELTA_TEST (~TS_MASK)
327
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400328/* Flag when events were overwritten */
329#define RB_MISSED_EVENTS (1 << 31)
Steven Rostedtff0ff842010-03-31 22:11:42 -0400330/* Missed count stored at end */
331#define RB_MISSED_STORED (1 << 30)
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400332
Steven Rostedtabc9b562008-12-02 15:34:06 -0500333struct buffer_data_page {
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400334 u64 time_stamp; /* page time stamp */
Wenji Huangc3706f02009-02-10 01:03:18 -0500335 local_t commit; /* write committed index */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500336 unsigned char data[]; /* data of buffer page */
337};
338
Steven Rostedt77ae3652009-03-27 11:00:29 -0400339/*
340 * Note, the buffer_page list must be first. The buffer pages
341 * are allocated in cache lines, which means that each buffer
342 * page will be at the beginning of a cache line, and thus
343 * the least significant bits will be zero. We use this to
344 * add flags in the list struct pointers, to make the ring buffer
345 * lockless.
346 */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500347struct buffer_page {
Steven Rostedt778c55d2009-05-01 18:44:45 -0400348 struct list_head list; /* list of buffer pages */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500349 local_t write; /* index for next write */
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400350 unsigned read; /* index for next read */
Steven Rostedt778c55d2009-05-01 18:44:45 -0400351 local_t entries; /* entries on this page */
Steven Rostedtff0ff842010-03-31 22:11:42 -0400352 unsigned long real_end; /* real end of data */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500353 struct buffer_data_page *page; /* Actual data page */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400354};
355
Steven Rostedt77ae3652009-03-27 11:00:29 -0400356/*
357 * The buffer page counters, write and entries, must be reset
358 * atomically when crossing page boundaries. To synchronize this
359 * update, two counters are inserted into the number. One is
360 * the actual counter for the write position or count on the page.
361 *
362 * The other is a counter of updaters. Before an update happens
363 * the update partition of the counter is incremented. This will
364 * allow the updater to update the counter atomically.
365 *
366 * The counter is 20 bits, and the state data is 12.
367 */
368#define RB_WRITE_MASK 0xfffff
369#define RB_WRITE_INTCNT (1 << 20)
370
Steven Rostedt044fa782008-12-02 23:50:03 -0500371static void rb_init_page(struct buffer_data_page *bpage)
Steven Rostedtabc9b562008-12-02 15:34:06 -0500372{
Steven Rostedt044fa782008-12-02 23:50:03 -0500373 local_set(&bpage->commit, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500374}
375
Steven Rostedt474d32b2009-03-03 19:51:40 -0500376/**
377 * ring_buffer_page_len - the size of data on the page.
378 * @page: The page to read
379 *
380 * Returns the amount of data on the page, including buffer page header.
381 */
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500382size_t ring_buffer_page_len(void *page)
383{
Steven Rostedt474d32b2009-03-03 19:51:40 -0500384 return local_read(&((struct buffer_data_page *)page)->commit)
385 + BUF_PAGE_HDR_SIZE;
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500386}
387
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400388/*
Steven Rostedted568292008-09-29 23:02:40 -0400389 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
390 * this issue out.
391 */
Andrew Morton34a148b2009-01-09 12:27:09 -0800392static void free_buffer_page(struct buffer_page *bpage)
Steven Rostedted568292008-09-29 23:02:40 -0400393{
Andrew Morton34a148b2009-01-09 12:27:09 -0800394 free_page((unsigned long)bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400395 kfree(bpage);
Steven Rostedted568292008-09-29 23:02:40 -0400396}
397
398/*
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400399 * We need to fit the time_stamp delta into 27 bits.
400 */
401static inline int test_time_stamp(u64 delta)
402{
403 if (delta & TS_DELTA_TEST)
404 return 1;
405 return 0;
406}
407
Steven Rostedt474d32b2009-03-03 19:51:40 -0500408#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400409
Steven Rostedtbe957c42009-05-11 14:42:53 -0400410/* Max payload is BUF_PAGE_SIZE - header (8bytes) */
411#define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))
412
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400413int ring_buffer_print_page_header(struct trace_seq *s)
414{
415 struct buffer_data_page field;
416 int ret;
417
418 ret = trace_seq_printf(s, "\tfield: u64 timestamp;\t"
Tom Zanussi26a50742009-10-06 01:09:50 -0500419 "offset:0;\tsize:%u;\tsigned:%u;\n",
420 (unsigned int)sizeof(field.time_stamp),
421 (unsigned int)is_signed_type(u64));
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400422
423 ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
Tom Zanussi26a50742009-10-06 01:09:50 -0500424 "offset:%u;\tsize:%u;\tsigned:%u;\n",
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400425 (unsigned int)offsetof(typeof(field), commit),
Tom Zanussi26a50742009-10-06 01:09:50 -0500426 (unsigned int)sizeof(field.commit),
427 (unsigned int)is_signed_type(long));
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400428
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400429 ret = trace_seq_printf(s, "\tfield: int overwrite;\t"
430 "offset:%u;\tsize:%u;\tsigned:%u;\n",
431 (unsigned int)offsetof(typeof(field), commit),
432 1,
433 (unsigned int)is_signed_type(long));
434
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400435 ret = trace_seq_printf(s, "\tfield: char data;\t"
Tom Zanussi26a50742009-10-06 01:09:50 -0500436 "offset:%u;\tsize:%u;\tsigned:%u;\n",
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400437 (unsigned int)offsetof(typeof(field), data),
Tom Zanussi26a50742009-10-06 01:09:50 -0500438 (unsigned int)BUF_PAGE_SIZE,
439 (unsigned int)is_signed_type(char));
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400440
441 return ret;
442}
443
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400444/*
445 * head_page == tail_page && head == tail then buffer is empty.
446 */
447struct ring_buffer_per_cpu {
448 int cpu;
Richard Kennedy985023d2010-03-25 11:27:36 +0000449 atomic_t record_disabled;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400450 struct ring_buffer *buffer;
Thomas Gleixner5389f6f2009-07-25 17:13:33 +0200451 raw_spinlock_t reader_lock; /* serialize readers */
Thomas Gleixner445c8952009-12-02 19:49:50 +0100452 arch_spinlock_t lock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400453 struct lock_class_key lock_key;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800454 unsigned int nr_pages;
Steven Rostedt3adc54f2009-03-30 15:32:01 -0400455 struct list_head *pages;
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400456 struct buffer_page *head_page; /* read from head */
457 struct buffer_page *tail_page; /* write to tail */
Wenji Huangc3706f02009-02-10 01:03:18 -0500458 struct buffer_page *commit_page; /* committed pages */
Steven Rostedtd7690412008-10-01 00:29:53 -0400459 struct buffer_page *reader_page;
Steven Rostedt66a8cb92010-03-31 13:21:56 -0400460 unsigned long lost_events;
461 unsigned long last_overrun;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -0700462 local_t entries_bytes;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400463 local_t commit_overrun;
464 local_t overrun;
Steven Rostedte4906ef2009-04-30 20:49:44 -0400465 local_t entries;
Steven Rostedtfa743952009-06-16 12:37:57 -0400466 local_t committing;
467 local_t commits;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400468 unsigned long read;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -0700469 unsigned long read_bytes;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400470 u64 write_stamp;
471 u64 read_stamp;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800472 /* ring buffer pages to update, > 0 to add, < 0 to remove */
473 int nr_pages_to_update;
474 struct list_head new_pages; /* new pages to add */
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -0700475 struct work_struct update_pages_work;
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -0700476 struct completion update_done;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400477};
478
479struct ring_buffer {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400480 unsigned flags;
481 int cpus;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400482 atomic_t record_disabled;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -0700483 atomic_t resize_disabled;
Arnaldo Carvalho de Melo00f62f62009-02-09 17:04:06 -0200484 cpumask_var_t cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400485
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200486 struct lock_class_key *reader_lock_key;
487
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400488 struct mutex mutex;
489
490 struct ring_buffer_per_cpu **buffers;
Steven Rostedt554f7862009-03-11 22:00:13 -0400491
Steven Rostedt59222ef2009-03-12 11:46:03 -0400492#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400493 struct notifier_block cpu_notify;
494#endif
Steven Rostedt37886f62009-03-17 17:22:06 -0400495 u64 (*clock)(void);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400496};
497
498struct ring_buffer_iter {
499 struct ring_buffer_per_cpu *cpu_buffer;
500 unsigned long head;
501 struct buffer_page *head_page;
Steven Rostedt492a74f2010-01-25 15:17:47 -0500502 struct buffer_page *cache_reader_page;
503 unsigned long cache_read;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400504 u64 read_stamp;
505};
506
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500507/* buffer may be either ring_buffer or ring_buffer_per_cpu */
Steven Rostedt077c5402009-09-03 19:53:46 -0400508#define RB_WARN_ON(b, cond) \
509 ({ \
510 int _____ret = unlikely(cond); \
511 if (_____ret) { \
512 if (__same_type(*(b), struct ring_buffer_per_cpu)) { \
513 struct ring_buffer_per_cpu *__b = \
514 (void *)b; \
515 atomic_inc(&__b->buffer->record_disabled); \
516 } else \
517 atomic_inc(&b->record_disabled); \
518 WARN_ON(1); \
519 } \
520 _____ret; \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500521 })
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500522
Steven Rostedt37886f62009-03-17 17:22:06 -0400523/* Up this if you want to test the TIME_EXTENTS and normalization */
524#define DEBUG_SHIFT 0
525
Jiri Olsa6d3f1e12009-10-23 19:36:19 -0400526static inline u64 rb_time_stamp(struct ring_buffer *buffer)
Steven Rostedt88eb0122009-05-11 16:28:23 -0400527{
528 /* shift to debug/test normalization and TIME_EXTENTS */
529 return buffer->clock() << DEBUG_SHIFT;
530}
531
Steven Rostedt37886f62009-03-17 17:22:06 -0400532u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
533{
534 u64 time;
535
536 preempt_disable_notrace();
Jiri Olsa6d3f1e12009-10-23 19:36:19 -0400537 time = rb_time_stamp(buffer);
Steven Rostedt37886f62009-03-17 17:22:06 -0400538 preempt_enable_no_resched_notrace();
539
540 return time;
541}
542EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
543
544void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
545 int cpu, u64 *ts)
546{
547 /* Just stupid testing the normalize function and deltas */
548 *ts >>= DEBUG_SHIFT;
549}
550EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
551
Steven Rostedt77ae3652009-03-27 11:00:29 -0400552/*
553 * Making the ring buffer lockless makes things tricky.
554 * Although writes only happen on the CPU that they are on,
555 * and they only need to worry about interrupts. Reads can
556 * happen on any CPU.
557 *
558 * The reader page is always off the ring buffer, but when the
559 * reader finishes with a page, it needs to swap its page with
560 * a new one from the buffer. The reader needs to take from
561 * the head (writes go to the tail). But if a writer is in overwrite
562 * mode and wraps, it must push the head page forward.
563 *
564 * Here lies the problem.
565 *
566 * The reader must be careful to replace only the head page, and
567 * not another one. As described at the top of the file in the
568 * ASCII art, the reader sets its old page to point to the next
569 * page after head. It then sets the page after head to point to
570 * the old reader page. But if the writer moves the head page
571 * during this operation, the reader could end up with the tail.
572 *
573 * We use cmpxchg to help prevent this race. We also do something
574 * special with the page before head. We set the LSB to 1.
575 *
576 * When the writer must push the page forward, it will clear the
577 * bit that points to the head page, move the head, and then set
578 * the bit that points to the new head page.
579 *
580 * We also don't want an interrupt coming in and moving the head
581 * page on another writer. Thus we use the second LSB to catch
582 * that too. Thus:
583 *
584 * head->list->prev->next bit 1 bit 0
585 * ------- -------
586 * Normal page 0 0
587 * Points to head page 0 1
588 * New head page 1 0
589 *
590 * Note we can not trust the prev pointer of the head page, because:
591 *
592 * +----+ +-----+ +-----+
593 * | |------>| T |---X--->| N |
594 * | |<------| | | |
595 * +----+ +-----+ +-----+
596 * ^ ^ |
597 * | +-----+ | |
598 * +----------| R |----------+ |
599 * | |<-----------+
600 * +-----+
601 *
602 * Key: ---X--> HEAD flag set in pointer
603 * T Tail page
604 * R Reader page
605 * N Next page
606 *
607 * (see __rb_reserve_next() to see where this happens)
608 *
609 * What the above shows is that the reader just swapped out
610 * the reader page with a page in the buffer, but before it
611 * could make the new header point back to the new page added
612 * it was preempted by a writer. The writer moved forward onto
613 * the new page added by the reader and is about to move forward
614 * again.
615 *
616 * You can see, it is legitimate for the previous pointer of
617 * the head (or any page) not to point back to itself. But only
618 * temporarially.
619 */
620
621#define RB_PAGE_NORMAL 0UL
622#define RB_PAGE_HEAD 1UL
623#define RB_PAGE_UPDATE 2UL
624
625
626#define RB_FLAG_MASK 3UL
627
628/* PAGE_MOVED is not part of the mask */
629#define RB_PAGE_MOVED 4UL
630
631/*
632 * rb_list_head - remove any bit
633 */
634static struct list_head *rb_list_head(struct list_head *list)
635{
636 unsigned long val = (unsigned long)list;
637
638 return (struct list_head *)(val & ~RB_FLAG_MASK);
639}
640
641/*
Jiri Olsa6d3f1e12009-10-23 19:36:19 -0400642 * rb_is_head_page - test if the given page is the head page
Steven Rostedt77ae3652009-03-27 11:00:29 -0400643 *
644 * Because the reader may move the head_page pointer, we can
645 * not trust what the head page is (it may be pointing to
646 * the reader page). But if the next page is a header page,
647 * its flags will be non zero.
648 */
Jesper Juhl42b16b32011-01-17 00:09:38 +0100649static inline int
Steven Rostedt77ae3652009-03-27 11:00:29 -0400650rb_is_head_page(struct ring_buffer_per_cpu *cpu_buffer,
651 struct buffer_page *page, struct list_head *list)
652{
653 unsigned long val;
654
655 val = (unsigned long)list->next;
656
657 if ((val & ~RB_FLAG_MASK) != (unsigned long)&page->list)
658 return RB_PAGE_MOVED;
659
660 return val & RB_FLAG_MASK;
661}
662
663/*
664 * rb_is_reader_page
665 *
666 * The unique thing about the reader page, is that, if the
667 * writer is ever on it, the previous pointer never points
668 * back to the reader page.
669 */
670static int rb_is_reader_page(struct buffer_page *page)
671{
672 struct list_head *list = page->list.prev;
673
674 return rb_list_head(list->next) != &page->list;
675}
676
677/*
678 * rb_set_list_to_head - set a list_head to be pointing to head.
679 */
680static void rb_set_list_to_head(struct ring_buffer_per_cpu *cpu_buffer,
681 struct list_head *list)
682{
683 unsigned long *ptr;
684
685 ptr = (unsigned long *)&list->next;
686 *ptr |= RB_PAGE_HEAD;
687 *ptr &= ~RB_PAGE_UPDATE;
688}
689
690/*
691 * rb_head_page_activate - sets up head page
692 */
693static void rb_head_page_activate(struct ring_buffer_per_cpu *cpu_buffer)
694{
695 struct buffer_page *head;
696
697 head = cpu_buffer->head_page;
698 if (!head)
699 return;
700
701 /*
702 * Set the previous list pointer to have the HEAD flag.
703 */
704 rb_set_list_to_head(cpu_buffer, head->list.prev);
705}
706
707static void rb_list_head_clear(struct list_head *list)
708{
709 unsigned long *ptr = (unsigned long *)&list->next;
710
711 *ptr &= ~RB_FLAG_MASK;
712}
713
714/*
715 * rb_head_page_dactivate - clears head page ptr (for free list)
716 */
717static void
718rb_head_page_deactivate(struct ring_buffer_per_cpu *cpu_buffer)
719{
720 struct list_head *hd;
721
722 /* Go through the whole list and clear any pointers found. */
723 rb_list_head_clear(cpu_buffer->pages);
724
725 list_for_each(hd, cpu_buffer->pages)
726 rb_list_head_clear(hd);
727}
728
729static int rb_head_page_set(struct ring_buffer_per_cpu *cpu_buffer,
730 struct buffer_page *head,
731 struct buffer_page *prev,
732 int old_flag, int new_flag)
733{
734 struct list_head *list;
735 unsigned long val = (unsigned long)&head->list;
736 unsigned long ret;
737
738 list = &prev->list;
739
740 val &= ~RB_FLAG_MASK;
741
Steven Rostedt08a40812009-09-14 09:31:35 -0400742 ret = cmpxchg((unsigned long *)&list->next,
743 val | old_flag, val | new_flag);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400744
745 /* check if the reader took the page */
746 if ((ret & ~RB_FLAG_MASK) != val)
747 return RB_PAGE_MOVED;
748
749 return ret & RB_FLAG_MASK;
750}
751
752static int rb_head_page_set_update(struct ring_buffer_per_cpu *cpu_buffer,
753 struct buffer_page *head,
754 struct buffer_page *prev,
755 int old_flag)
756{
757 return rb_head_page_set(cpu_buffer, head, prev,
758 old_flag, RB_PAGE_UPDATE);
759}
760
761static int rb_head_page_set_head(struct ring_buffer_per_cpu *cpu_buffer,
762 struct buffer_page *head,
763 struct buffer_page *prev,
764 int old_flag)
765{
766 return rb_head_page_set(cpu_buffer, head, prev,
767 old_flag, RB_PAGE_HEAD);
768}
769
770static int rb_head_page_set_normal(struct ring_buffer_per_cpu *cpu_buffer,
771 struct buffer_page *head,
772 struct buffer_page *prev,
773 int old_flag)
774{
775 return rb_head_page_set(cpu_buffer, head, prev,
776 old_flag, RB_PAGE_NORMAL);
777}
778
779static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
780 struct buffer_page **bpage)
781{
782 struct list_head *p = rb_list_head((*bpage)->list.next);
783
784 *bpage = list_entry(p, struct buffer_page, list);
785}
786
787static struct buffer_page *
788rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer)
789{
790 struct buffer_page *head;
791 struct buffer_page *page;
792 struct list_head *list;
793 int i;
794
795 if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page))
796 return NULL;
797
798 /* sanity check */
799 list = cpu_buffer->pages;
800 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev->next) != list))
801 return NULL;
802
803 page = head = cpu_buffer->head_page;
804 /*
805 * It is possible that the writer moves the header behind
806 * where we started, and we miss in one loop.
807 * A second loop should grab the header, but we'll do
808 * three loops just because I'm paranoid.
809 */
810 for (i = 0; i < 3; i++) {
811 do {
812 if (rb_is_head_page(cpu_buffer, page, page->list.prev)) {
813 cpu_buffer->head_page = page;
814 return page;
815 }
816 rb_inc_page(cpu_buffer, &page);
817 } while (page != head);
818 }
819
820 RB_WARN_ON(cpu_buffer, 1);
821
822 return NULL;
823}
824
825static int rb_head_page_replace(struct buffer_page *old,
826 struct buffer_page *new)
827{
828 unsigned long *ptr = (unsigned long *)&old->list.prev->next;
829 unsigned long val;
830 unsigned long ret;
831
832 val = *ptr & ~RB_FLAG_MASK;
833 val |= RB_PAGE_HEAD;
834
Steven Rostedt08a40812009-09-14 09:31:35 -0400835 ret = cmpxchg(ptr, val, (unsigned long)&new->list);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400836
837 return ret == val;
838}
839
840/*
841 * rb_tail_page_update - move the tail page forward
842 *
843 * Returns 1 if moved tail page, 0 if someone else did.
844 */
845static int rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer,
846 struct buffer_page *tail_page,
847 struct buffer_page *next_page)
848{
849 struct buffer_page *old_tail;
850 unsigned long old_entries;
851 unsigned long old_write;
852 int ret = 0;
853
854 /*
855 * The tail page now needs to be moved forward.
856 *
857 * We need to reset the tail page, but without messing
858 * with possible erasing of data brought in by interrupts
859 * that have moved the tail page and are currently on it.
860 *
861 * We add a counter to the write field to denote this.
862 */
863 old_write = local_add_return(RB_WRITE_INTCNT, &next_page->write);
864 old_entries = local_add_return(RB_WRITE_INTCNT, &next_page->entries);
865
866 /*
867 * Just make sure we have seen our old_write and synchronize
868 * with any interrupts that come in.
869 */
870 barrier();
871
872 /*
873 * If the tail page is still the same as what we think
874 * it is, then it is up to us to update the tail
875 * pointer.
876 */
877 if (tail_page == cpu_buffer->tail_page) {
878 /* Zero the write counter */
879 unsigned long val = old_write & ~RB_WRITE_MASK;
880 unsigned long eval = old_entries & ~RB_WRITE_MASK;
881
882 /*
883 * This will only succeed if an interrupt did
884 * not come in and change it. In which case, we
885 * do not want to modify it.
Lai Jiangshanda706d82009-07-15 16:27:30 +0800886 *
887 * We add (void) to let the compiler know that we do not care
888 * about the return value of these functions. We use the
889 * cmpxchg to only update if an interrupt did not already
890 * do it for us. If the cmpxchg fails, we don't care.
Steven Rostedt77ae3652009-03-27 11:00:29 -0400891 */
Lai Jiangshanda706d82009-07-15 16:27:30 +0800892 (void)local_cmpxchg(&next_page->write, old_write, val);
893 (void)local_cmpxchg(&next_page->entries, old_entries, eval);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400894
895 /*
896 * No need to worry about races with clearing out the commit.
897 * it only can increment when a commit takes place. But that
898 * only happens in the outer most nested commit.
899 */
900 local_set(&next_page->page->commit, 0);
901
902 old_tail = cmpxchg(&cpu_buffer->tail_page,
903 tail_page, next_page);
904
905 if (old_tail == tail_page)
906 ret = 1;
907 }
908
909 return ret;
910}
911
912static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer,
913 struct buffer_page *bpage)
914{
915 unsigned long val = (unsigned long)bpage;
916
917 if (RB_WARN_ON(cpu_buffer, val & RB_FLAG_MASK))
918 return 1;
919
920 return 0;
921}
922
923/**
924 * rb_check_list - make sure a pointer to a list has the last bits zero
925 */
926static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
927 struct list_head *list)
928{
929 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev) != list->prev))
930 return 1;
931 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->next) != list->next))
932 return 1;
933 return 0;
934}
935
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400936/**
937 * check_pages - integrity check of buffer pages
938 * @cpu_buffer: CPU buffer with pages to test
939 *
Wenji Huangc3706f02009-02-10 01:03:18 -0500940 * As a safety measure we check to make sure the data pages have not
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400941 * been corrupted.
942 */
943static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
944{
Steven Rostedt3adc54f2009-03-30 15:32:01 -0400945 struct list_head *head = cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500946 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400947
Steven Rostedt308f7ee2012-05-16 19:46:32 -0400948 /* Reset the head page if it exists */
949 if (cpu_buffer->head_page)
950 rb_set_head_page(cpu_buffer);
951
Steven Rostedt77ae3652009-03-27 11:00:29 -0400952 rb_head_page_deactivate(cpu_buffer);
953
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500954 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
955 return -1;
956 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
957 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400958
Steven Rostedt77ae3652009-03-27 11:00:29 -0400959 if (rb_check_list(cpu_buffer, head))
960 return -1;
961
Steven Rostedt044fa782008-12-02 23:50:03 -0500962 list_for_each_entry_safe(bpage, tmp, head, list) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500963 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500964 bpage->list.next->prev != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500965 return -1;
966 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500967 bpage->list.prev->next != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500968 return -1;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400969 if (rb_check_list(cpu_buffer, &bpage->list))
970 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400971 }
972
Steven Rostedt77ae3652009-03-27 11:00:29 -0400973 rb_head_page_activate(cpu_buffer);
974
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400975 return 0;
976}
977
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800978static int __rb_allocate_pages(int nr_pages, struct list_head *pages, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400979{
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800980 int i;
Steven Rostedt044fa782008-12-02 23:50:03 -0500981 struct buffer_page *bpage, *tmp;
Steven Rostedt3adc54f2009-03-30 15:32:01 -0400982
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400983 for (i = 0; i < nr_pages; i++) {
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -0700984 struct page *page;
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -0700985 /*
986 * __GFP_NORETRY flag makes sure that the allocation fails
987 * gracefully without invoking oom-killer and the system is
988 * not destabilized.
989 */
Steven Rostedt044fa782008-12-02 23:50:03 -0500990 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -0700991 GFP_KERNEL | __GFP_NORETRY,
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800992 cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500993 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400994 goto free_pages;
Steven Rostedt77ae3652009-03-27 11:00:29 -0400995
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800996 list_add(&bpage->list, pages);
Steven Rostedt77ae3652009-03-27 11:00:29 -0400997
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -0800998 page = alloc_pages_node(cpu_to_node(cpu),
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -0700999 GFP_KERNEL | __GFP_NORETRY, 0);
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001000 if (!page)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001001 goto free_pages;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001002 bpage->page = page_address(page);
Steven Rostedt044fa782008-12-02 23:50:03 -05001003 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001004 }
1005
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001006 return 0;
1007
1008free_pages:
1009 list_for_each_entry_safe(bpage, tmp, pages, list) {
1010 list_del_init(&bpage->list);
1011 free_buffer_page(bpage);
1012 }
1013
1014 return -ENOMEM;
1015}
1016
1017static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
1018 unsigned nr_pages)
1019{
1020 LIST_HEAD(pages);
1021
1022 WARN_ON(!nr_pages);
1023
1024 if (__rb_allocate_pages(nr_pages, &pages, cpu_buffer->cpu))
1025 return -ENOMEM;
1026
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001027 /*
1028 * The ring buffer page list is a circular list that does not
1029 * start and end with a list head. All page list items point to
1030 * other pages.
1031 */
1032 cpu_buffer->pages = pages.next;
1033 list_del(&pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001034
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001035 cpu_buffer->nr_pages = nr_pages;
1036
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001037 rb_check_pages(cpu_buffer);
1038
1039 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001040}
1041
1042static struct ring_buffer_per_cpu *
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001043rb_allocate_cpu_buffer(struct ring_buffer *buffer, int nr_pages, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001044{
1045 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt044fa782008-12-02 23:50:03 -05001046 struct buffer_page *bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001047 struct page *page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001048 int ret;
1049
1050 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
1051 GFP_KERNEL, cpu_to_node(cpu));
1052 if (!cpu_buffer)
1053 return NULL;
1054
1055 cpu_buffer->cpu = cpu;
1056 cpu_buffer->buffer = buffer;
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001057 raw_spin_lock_init(&cpu_buffer->reader_lock);
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001058 lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
Thomas Gleixneredc35bd2009-12-03 12:38:57 +01001059 cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001060 INIT_WORK(&cpu_buffer->update_pages_work, update_pages_handler);
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001061 init_completion(&cpu_buffer->update_done);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001062
Steven Rostedt044fa782008-12-02 23:50:03 -05001063 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001064 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -05001065 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001066 goto fail_free_buffer;
1067
Steven Rostedt77ae3652009-03-27 11:00:29 -04001068 rb_check_bpage(cpu_buffer, bpage);
1069
Steven Rostedt044fa782008-12-02 23:50:03 -05001070 cpu_buffer->reader_page = bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001071 page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
1072 if (!page)
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001073 goto fail_free_reader;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07001074 bpage->page = page_address(page);
Steven Rostedt044fa782008-12-02 23:50:03 -05001075 rb_init_page(bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -04001076
Steven Rostedtd7690412008-10-01 00:29:53 -04001077 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Vaibhav Nagarnaik44b99462012-06-22 11:50:05 -07001078 INIT_LIST_HEAD(&cpu_buffer->new_pages);
Steven Rostedtd7690412008-10-01 00:29:53 -04001079
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001080 ret = rb_allocate_pages(cpu_buffer, nr_pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001081 if (ret < 0)
Steven Rostedtd7690412008-10-01 00:29:53 -04001082 goto fail_free_reader;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001083
1084 cpu_buffer->head_page
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001085 = list_entry(cpu_buffer->pages, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001086 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001087
Steven Rostedt77ae3652009-03-27 11:00:29 -04001088 rb_head_page_activate(cpu_buffer);
1089
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001090 return cpu_buffer;
1091
Steven Rostedtd7690412008-10-01 00:29:53 -04001092 fail_free_reader:
1093 free_buffer_page(cpu_buffer->reader_page);
1094
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001095 fail_free_buffer:
1096 kfree(cpu_buffer);
1097 return NULL;
1098}
1099
1100static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
1101{
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001102 struct list_head *head = cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -05001103 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001104
Steven Rostedtd7690412008-10-01 00:29:53 -04001105 free_buffer_page(cpu_buffer->reader_page);
1106
Steven Rostedt77ae3652009-03-27 11:00:29 -04001107 rb_head_page_deactivate(cpu_buffer);
1108
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001109 if (head) {
1110 list_for_each_entry_safe(bpage, tmp, head, list) {
1111 list_del_init(&bpage->list);
1112 free_buffer_page(bpage);
1113 }
1114 bpage = list_entry(head, struct buffer_page, list);
Steven Rostedt044fa782008-12-02 23:50:03 -05001115 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001116 }
Steven Rostedt3adc54f2009-03-30 15:32:01 -04001117
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001118 kfree(cpu_buffer);
1119}
1120
Steven Rostedt59222ef2009-03-12 11:46:03 -04001121#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01001122static int rb_cpu_notify(struct notifier_block *self,
1123 unsigned long action, void *hcpu);
Steven Rostedt554f7862009-03-11 22:00:13 -04001124#endif
1125
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001126/**
1127 * ring_buffer_alloc - allocate a new ring_buffer
Robert Richter68814b52008-11-24 12:24:12 +01001128 * @size: the size in bytes per cpu that is needed.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001129 * @flags: attributes to set for the ring buffer.
1130 *
1131 * Currently the only flag that is available is the RB_FL_OVERWRITE
1132 * flag. This flag means that the buffer will overwrite old data
1133 * when the buffer wraps. If this flag is not set, the buffer will
1134 * drop data when the tail hits the head.
1135 */
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001136struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
1137 struct lock_class_key *key)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001138{
1139 struct ring_buffer *buffer;
1140 int bsize;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001141 int cpu, nr_pages;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001142
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001143 /* keep it in its own cache line */
1144 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
1145 GFP_KERNEL);
1146 if (!buffer)
1147 return NULL;
1148
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301149 if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
1150 goto fail_free_buffer;
1151
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001152 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001153 buffer->flags = flags;
Steven Rostedt37886f62009-03-17 17:22:06 -04001154 buffer->clock = trace_clock_local;
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001155 buffer->reader_lock_key = key;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001156
1157 /* need at least two pages */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001158 if (nr_pages < 2)
1159 nr_pages = 2;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001160
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +01001161 /*
1162 * In case of non-hotplug cpu, if the ring-buffer is allocated
1163 * in early initcall, it will not be notified of secondary cpus.
1164 * In that off case, we need to allocate for all possible cpus.
1165 */
1166#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -04001167 get_online_cpus();
1168 cpumask_copy(buffer->cpumask, cpu_online_mask);
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +01001169#else
1170 cpumask_copy(buffer->cpumask, cpu_possible_mask);
1171#endif
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001172 buffer->cpus = nr_cpu_ids;
1173
1174 bsize = sizeof(void *) * nr_cpu_ids;
1175 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
1176 GFP_KERNEL);
1177 if (!buffer->buffers)
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301178 goto fail_free_cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001179
1180 for_each_buffer_cpu(buffer, cpu) {
1181 buffer->buffers[cpu] =
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001182 rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001183 if (!buffer->buffers[cpu])
1184 goto fail_free_buffers;
1185 }
1186
Steven Rostedt59222ef2009-03-12 11:46:03 -04001187#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -04001188 buffer->cpu_notify.notifier_call = rb_cpu_notify;
1189 buffer->cpu_notify.priority = 0;
1190 register_cpu_notifier(&buffer->cpu_notify);
1191#endif
1192
1193 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001194 mutex_init(&buffer->mutex);
1195
1196 return buffer;
1197
1198 fail_free_buffers:
1199 for_each_buffer_cpu(buffer, cpu) {
1200 if (buffer->buffers[cpu])
1201 rb_free_cpu_buffer(buffer->buffers[cpu]);
1202 }
1203 kfree(buffer->buffers);
1204
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301205 fail_free_cpumask:
1206 free_cpumask_var(buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -04001207 put_online_cpus();
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301208
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001209 fail_free_buffer:
1210 kfree(buffer);
1211 return NULL;
1212}
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +02001213EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001214
1215/**
1216 * ring_buffer_free - free a ring buffer.
1217 * @buffer: the buffer to free.
1218 */
1219void
1220ring_buffer_free(struct ring_buffer *buffer)
1221{
1222 int cpu;
1223
Steven Rostedt554f7862009-03-11 22:00:13 -04001224 get_online_cpus();
1225
Steven Rostedt59222ef2009-03-12 11:46:03 -04001226#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -04001227 unregister_cpu_notifier(&buffer->cpu_notify);
1228#endif
1229
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001230 for_each_buffer_cpu(buffer, cpu)
1231 rb_free_cpu_buffer(buffer->buffers[cpu]);
1232
Steven Rostedt554f7862009-03-11 22:00:13 -04001233 put_online_cpus();
1234
Eric Dumazetbd3f0222009-08-07 12:49:29 +02001235 kfree(buffer->buffers);
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301236 free_cpumask_var(buffer->cpumask);
1237
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001238 kfree(buffer);
1239}
Robert Richterc4f50182008-12-11 16:49:22 +01001240EXPORT_SYMBOL_GPL(ring_buffer_free);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001241
Steven Rostedt37886f62009-03-17 17:22:06 -04001242void ring_buffer_set_clock(struct ring_buffer *buffer,
1243 u64 (*clock)(void))
1244{
1245 buffer->clock = clock;
1246}
1247
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001248static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
1249
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001250static inline unsigned long rb_page_entries(struct buffer_page *bpage)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001251{
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001252 return local_read(&bpage->entries) & RB_WRITE_MASK;
1253}
1254
1255static inline unsigned long rb_page_write(struct buffer_page *bpage)
1256{
1257 return local_read(&bpage->write) & RB_WRITE_MASK;
1258}
1259
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001260static int
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001261rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned int nr_pages)
1262{
1263 struct list_head *tail_page, *to_remove, *next_page;
1264 struct buffer_page *to_remove_page, *tmp_iter_page;
1265 struct buffer_page *last_page, *first_page;
1266 unsigned int nr_removed;
1267 unsigned long head_bit;
1268 int page_entries;
1269
1270 head_bit = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001271
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001272 raw_spin_lock_irq(&cpu_buffer->reader_lock);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001273 atomic_inc(&cpu_buffer->record_disabled);
1274 /*
1275 * We don't race with the readers since we have acquired the reader
1276 * lock. We also don't race with writers after disabling recording.
1277 * This makes it easy to figure out the first and the last page to be
1278 * removed from the list. We unlink all the pages in between including
1279 * the first and last pages. This is done in a busy loop so that we
1280 * lose the least number of traces.
1281 * The pages are freed after we restart recording and unlock readers.
1282 */
1283 tail_page = &cpu_buffer->tail_page->list;
Steven Rostedt77ae3652009-03-27 11:00:29 -04001284
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001285 /*
1286 * tail page might be on reader page, we remove the next page
1287 * from the ring buffer
1288 */
1289 if (cpu_buffer->tail_page == cpu_buffer->reader_page)
1290 tail_page = rb_list_head(tail_page->next);
1291 to_remove = tail_page;
1292
1293 /* start of pages to remove */
1294 first_page = list_entry(rb_list_head(to_remove->next),
1295 struct buffer_page, list);
1296
1297 for (nr_removed = 0; nr_removed < nr_pages; nr_removed++) {
1298 to_remove = rb_list_head(to_remove)->next;
1299 head_bit |= (unsigned long)to_remove & RB_PAGE_HEAD;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001300 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001301
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001302 next_page = rb_list_head(to_remove)->next;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001303
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001304 /*
1305 * Now we remove all pages between tail_page and next_page.
1306 * Make sure that we have head_bit value preserved for the
1307 * next page
1308 */
1309 tail_page->next = (struct list_head *)((unsigned long)next_page |
1310 head_bit);
1311 next_page = rb_list_head(next_page);
1312 next_page->prev = tail_page;
1313
1314 /* make sure pages points to a valid page in the ring buffer */
1315 cpu_buffer->pages = next_page;
1316
1317 /* update head page */
1318 if (head_bit)
1319 cpu_buffer->head_page = list_entry(next_page,
1320 struct buffer_page, list);
1321
1322 /*
1323 * change read pointer to make sure any read iterators reset
1324 * themselves
1325 */
1326 cpu_buffer->read = 0;
1327
1328 /* pages are removed, resume tracing and then free the pages */
1329 atomic_dec(&cpu_buffer->record_disabled);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001330 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001331
1332 RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages));
1333
1334 /* last buffer page to remove */
1335 last_page = list_entry(rb_list_head(to_remove), struct buffer_page,
1336 list);
1337 tmp_iter_page = first_page;
1338
1339 do {
1340 to_remove_page = tmp_iter_page;
1341 rb_inc_page(cpu_buffer, &tmp_iter_page);
1342
1343 /* update the counters */
1344 page_entries = rb_page_entries(to_remove_page);
1345 if (page_entries) {
1346 /*
1347 * If something was added to this page, it was full
1348 * since it is not the tail page. So we deduct the
1349 * bytes consumed in ring buffer from here.
1350 * No need to update overruns, since this page is
1351 * deleted from ring buffer and its entries are
1352 * already accounted for.
1353 */
1354 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
1355 }
1356
1357 /*
1358 * We have already removed references to this list item, just
1359 * free up the buffer_page and its page
1360 */
1361 free_buffer_page(to_remove_page);
1362 nr_removed--;
1363
1364 } while (to_remove_page != last_page);
1365
1366 RB_WARN_ON(cpu_buffer, nr_removed);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001367
1368 return nr_removed == 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001369}
1370
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001371static int
1372rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001373{
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001374 struct list_head *pages = &cpu_buffer->new_pages;
1375 int retries, success;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001376
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001377 raw_spin_lock_irq(&cpu_buffer->reader_lock);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001378 /*
1379 * We are holding the reader lock, so the reader page won't be swapped
1380 * in the ring buffer. Now we are racing with the writer trying to
1381 * move head page and the tail page.
1382 * We are going to adapt the reader page update process where:
1383 * 1. We first splice the start and end of list of new pages between
1384 * the head page and its previous page.
1385 * 2. We cmpxchg the prev_page->next to point from head page to the
1386 * start of new pages list.
1387 * 3. Finally, we update the head->prev to the end of new list.
1388 *
1389 * We will try this process 10 times, to make sure that we don't keep
1390 * spinning.
1391 */
1392 retries = 10;
1393 success = 0;
1394 while (retries--) {
1395 struct list_head *head_page, *prev_page, *r;
1396 struct list_head *last_page, *first_page;
1397 struct list_head *head_page_with_bit;
Steven Rostedt77ae3652009-03-27 11:00:29 -04001398
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001399 head_page = &rb_set_head_page(cpu_buffer)->list;
1400 prev_page = head_page->prev;
1401
1402 first_page = pages->next;
1403 last_page = pages->prev;
1404
1405 head_page_with_bit = (struct list_head *)
1406 ((unsigned long)head_page | RB_PAGE_HEAD);
1407
1408 last_page->next = head_page_with_bit;
1409 first_page->prev = prev_page;
1410
1411 r = cmpxchg(&prev_page->next, head_page_with_bit, first_page);
1412
1413 if (r == head_page_with_bit) {
1414 /*
1415 * yay, we replaced the page pointer to our new list,
1416 * now, we just have to update to head page's prev
1417 * pointer to point to end of list
1418 */
1419 head_page->prev = last_page;
1420 success = 1;
1421 break;
1422 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001423 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001424
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001425 if (success)
1426 INIT_LIST_HEAD(pages);
1427 /*
1428 * If we weren't successful in adding in new pages, warn and stop
1429 * tracing
1430 */
1431 RB_WARN_ON(cpu_buffer, !success);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001432 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001433
1434 /* free pages if they weren't inserted */
1435 if (!success) {
1436 struct buffer_page *bpage, *tmp;
1437 list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
1438 list) {
1439 list_del_init(&bpage->list);
1440 free_buffer_page(bpage);
1441 }
1442 }
1443 return success;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001444}
1445
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001446static void rb_update_pages(struct ring_buffer_per_cpu *cpu_buffer)
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001447{
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001448 int success;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001449
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001450 if (cpu_buffer->nr_pages_to_update > 0)
1451 success = rb_insert_pages(cpu_buffer);
1452 else
1453 success = rb_remove_pages(cpu_buffer,
1454 -cpu_buffer->nr_pages_to_update);
1455
1456 if (success)
1457 cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001458}
1459
1460static void update_pages_handler(struct work_struct *work)
1461{
1462 struct ring_buffer_per_cpu *cpu_buffer = container_of(work,
1463 struct ring_buffer_per_cpu, update_pages_work);
1464 rb_update_pages(cpu_buffer);
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001465 complete(&cpu_buffer->update_done);
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001466}
1467
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001468/**
1469 * ring_buffer_resize - resize the ring buffer
1470 * @buffer: the buffer to resize.
1471 * @size: the new size.
1472 *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001473 * Minimum size is 2 * BUF_PAGE_SIZE.
1474 *
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001475 * Returns 0 on success and < 0 on failure.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001476 */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001477int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size,
1478 int cpu_id)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001479{
1480 struct ring_buffer_per_cpu *cpu_buffer;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001481 unsigned nr_pages;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001482 int cpu, err = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001483
Ingo Molnaree51a1d2008-11-13 14:58:31 +01001484 /*
1485 * Always succeed at resizing a non-existent buffer:
1486 */
1487 if (!buffer)
1488 return size;
1489
Steven Rostedt6a31e1f2012-05-23 15:35:17 -04001490 /* Make sure the requested buffer exists */
1491 if (cpu_id != RING_BUFFER_ALL_CPUS &&
1492 !cpumask_test_cpu(cpu_id, buffer->cpumask))
1493 return size;
1494
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001495 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1496 size *= BUF_PAGE_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001497
1498 /* we need a minimum of two pages */
1499 if (size < BUF_PAGE_SIZE * 2)
1500 size = BUF_PAGE_SIZE * 2;
1501
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001502 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1503
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001504 /*
1505 * Don't succeed if resizing is disabled, as a reader might be
1506 * manipulating the ring buffer and is expecting a sane state while
1507 * this is true.
1508 */
1509 if (atomic_read(&buffer->resize_disabled))
1510 return -EBUSY;
1511
1512 /* prevent another thread from changing buffer sizes */
1513 mutex_lock(&buffer->mutex);
1514
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001515 if (cpu_id == RING_BUFFER_ALL_CPUS) {
1516 /* calculate the pages to update */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001517 for_each_buffer_cpu(buffer, cpu) {
1518 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001519
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001520 cpu_buffer->nr_pages_to_update = nr_pages -
1521 cpu_buffer->nr_pages;
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001522 /*
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001523 * nothing more to do for removing pages or no update
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001524 */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001525 if (cpu_buffer->nr_pages_to_update <= 0)
1526 continue;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001527 /*
1528 * to add pages, make sure all new pages can be
1529 * allocated without receiving ENOMEM
1530 */
1531 INIT_LIST_HEAD(&cpu_buffer->new_pages);
1532 if (__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001533 &cpu_buffer->new_pages, cpu)) {
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001534 /* not enough memory for new pages */
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001535 err = -ENOMEM;
1536 goto out_err;
1537 }
1538 }
1539
1540 get_online_cpus();
1541 /*
1542 * Fire off all the required work handlers
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001543 * We can't schedule on offline CPUs, but it's not necessary
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001544 * since we can change their buffer sizes without any race.
1545 */
1546 for_each_buffer_cpu(buffer, cpu) {
1547 cpu_buffer = buffer->buffers[cpu];
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001548 if (!cpu_buffer->nr_pages_to_update)
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001549 continue;
1550
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001551 if (cpu_online(cpu))
1552 schedule_work_on(cpu,
1553 &cpu_buffer->update_pages_work);
1554 else
1555 rb_update_pages(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001556 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001557
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001558 /* wait for all the updates to complete */
1559 for_each_buffer_cpu(buffer, cpu) {
1560 cpu_buffer = buffer->buffers[cpu];
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001561 if (!cpu_buffer->nr_pages_to_update)
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001562 continue;
1563
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001564 if (cpu_online(cpu))
1565 wait_for_completion(&cpu_buffer->update_done);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001566 cpu_buffer->nr_pages_to_update = 0;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001567 }
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001568
1569 put_online_cpus();
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001570 } else {
1571 cpu_buffer = buffer->buffers[cpu_id];
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001572
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001573 if (nr_pages == cpu_buffer->nr_pages)
1574 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001575
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001576 cpu_buffer->nr_pages_to_update = nr_pages -
1577 cpu_buffer->nr_pages;
1578
1579 INIT_LIST_HEAD(&cpu_buffer->new_pages);
1580 if (cpu_buffer->nr_pages_to_update > 0 &&
1581 __rb_allocate_pages(cpu_buffer->nr_pages_to_update,
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001582 &cpu_buffer->new_pages, cpu_id)) {
1583 err = -ENOMEM;
1584 goto out_err;
1585 }
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001586
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001587 get_online_cpus();
1588
1589 if (cpu_online(cpu_id)) {
1590 schedule_work_on(cpu_id,
1591 &cpu_buffer->update_pages_work);
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001592 wait_for_completion(&cpu_buffer->update_done);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001593 } else
1594 rb_update_pages(cpu_buffer);
1595
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001596 cpu_buffer->nr_pages_to_update = 0;
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001597 put_online_cpus();
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001598 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001599
1600 out:
Steven Rostedt659f4512012-05-14 17:02:33 -04001601 /*
1602 * The ring buffer resize can happen with the ring buffer
1603 * enabled, so that the update disturbs the tracing as little
1604 * as possible. But if the buffer is disabled, we do not need
1605 * to worry about that, and we can take the time to verify
1606 * that the buffer is not corrupt.
1607 */
1608 if (atomic_read(&buffer->record_disabled)) {
1609 atomic_inc(&buffer->record_disabled);
1610 /*
1611 * Even though the buffer was disabled, we must make sure
1612 * that it is truly disabled before calling rb_check_pages.
1613 * There could have been a race between checking
1614 * record_disable and incrementing it.
1615 */
1616 synchronize_sched();
1617 for_each_buffer_cpu(buffer, cpu) {
1618 cpu_buffer = buffer->buffers[cpu];
1619 rb_check_pages(cpu_buffer);
1620 }
1621 atomic_dec(&buffer->record_disabled);
1622 }
1623
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001624 mutex_unlock(&buffer->mutex);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001625 return size;
1626
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001627 out_err:
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001628 for_each_buffer_cpu(buffer, cpu) {
1629 struct buffer_page *bpage, *tmp;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001630
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001631 cpu_buffer = buffer->buffers[cpu];
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001632 cpu_buffer->nr_pages_to_update = 0;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001633
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001634 if (list_empty(&cpu_buffer->new_pages))
1635 continue;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001636
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001637 list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
1638 list) {
1639 list_del_init(&bpage->list);
1640 free_buffer_page(bpage);
1641 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001642 }
Vegard Nossum641d2f62008-11-18 19:22:13 +01001643 mutex_unlock(&buffer->mutex);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001644 return err;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001645}
Robert Richterc4f50182008-12-11 16:49:22 +01001646EXPORT_SYMBOL_GPL(ring_buffer_resize);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001647
David Sharp750912f2010-12-08 13:46:47 -08001648void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
1649{
1650 mutex_lock(&buffer->mutex);
1651 if (val)
1652 buffer->flags |= RB_FL_OVERWRITE;
1653 else
1654 buffer->flags &= ~RB_FL_OVERWRITE;
1655 mutex_unlock(&buffer->mutex);
1656}
1657EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
1658
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001659static inline void *
Steven Rostedt044fa782008-12-02 23:50:03 -05001660__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001661{
Steven Rostedt044fa782008-12-02 23:50:03 -05001662 return bpage->data + index;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001663}
1664
Steven Rostedt044fa782008-12-02 23:50:03 -05001665static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001666{
Steven Rostedt044fa782008-12-02 23:50:03 -05001667 return bpage->page->data + index;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001668}
1669
1670static inline struct ring_buffer_event *
Steven Rostedtd7690412008-10-01 00:29:53 -04001671rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001672{
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001673 return __rb_page_index(cpu_buffer->reader_page,
1674 cpu_buffer->reader_page->read);
1675}
1676
1677static inline struct ring_buffer_event *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001678rb_iter_head_event(struct ring_buffer_iter *iter)
1679{
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001680 return __rb_page_index(iter->head_page, iter->head);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001681}
1682
Steven Rostedtbf41a152008-10-04 02:00:59 -04001683static inline unsigned rb_page_commit(struct buffer_page *bpage)
1684{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001685 return local_read(&bpage->page->commit);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001686}
1687
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001688/* Size is determined by what has been committed */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001689static inline unsigned rb_page_size(struct buffer_page *bpage)
1690{
1691 return rb_page_commit(bpage);
1692}
1693
1694static inline unsigned
1695rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
1696{
1697 return rb_page_commit(cpu_buffer->commit_page);
1698}
1699
Steven Rostedtbf41a152008-10-04 02:00:59 -04001700static inline unsigned
1701rb_event_index(struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001702{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001703 unsigned long addr = (unsigned long)event;
1704
Steven Rostedt22f470f2009-06-11 09:29:58 -04001705 return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001706}
1707
Steven Rostedt0f0c85f2009-05-11 16:08:00 -04001708static inline int
Steven Rostedtfa743952009-06-16 12:37:57 -04001709rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
1710 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001711{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001712 unsigned long addr = (unsigned long)event;
1713 unsigned long index;
1714
1715 index = rb_event_index(event);
1716 addr &= PAGE_MASK;
1717
1718 return cpu_buffer->commit_page->page == (void *)addr &&
1719 rb_commit_index(cpu_buffer) == index;
1720}
1721
Andrew Morton34a148b2009-01-09 12:27:09 -08001722static void
Steven Rostedtbf41a152008-10-04 02:00:59 -04001723rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
1724{
Steven Rostedt77ae3652009-03-27 11:00:29 -04001725 unsigned long max_count;
1726
Steven Rostedtbf41a152008-10-04 02:00:59 -04001727 /*
1728 * We only race with interrupts and NMIs on this CPU.
1729 * If we own the commit event, then we can commit
1730 * all others that interrupted us, since the interruptions
1731 * are in stack format (they finish before they come
1732 * back to us). This allows us to do a simple loop to
1733 * assign the commit to the tail.
1734 */
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001735 again:
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001736 max_count = cpu_buffer->nr_pages * 100;
Steven Rostedt77ae3652009-03-27 11:00:29 -04001737
Steven Rostedtbf41a152008-10-04 02:00:59 -04001738 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001739 if (RB_WARN_ON(cpu_buffer, !(--max_count)))
1740 return;
1741 if (RB_WARN_ON(cpu_buffer,
1742 rb_is_reader_page(cpu_buffer->tail_page)))
1743 return;
1744 local_set(&cpu_buffer->commit_page->page->commit,
1745 rb_page_write(cpu_buffer->commit_page));
Steven Rostedtbf41a152008-10-04 02:00:59 -04001746 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001747 cpu_buffer->write_stamp =
1748 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001749 /* add barrier to keep gcc from optimizing too much */
1750 barrier();
1751 }
1752 while (rb_commit_index(cpu_buffer) !=
1753 rb_page_write(cpu_buffer->commit_page)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001754
1755 local_set(&cpu_buffer->commit_page->page->commit,
1756 rb_page_write(cpu_buffer->commit_page));
1757 RB_WARN_ON(cpu_buffer,
1758 local_read(&cpu_buffer->commit_page->page->commit) &
1759 ~RB_WRITE_MASK);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001760 barrier();
1761 }
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001762
1763 /* again, keep gcc from optimizing */
1764 barrier();
1765
1766 /*
1767 * If an interrupt came in just after the first while loop
1768 * and pushed the tail page forward, we will be left with
1769 * a dangling commit that will never go forward.
1770 */
1771 if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
1772 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001773}
1774
Steven Rostedtd7690412008-10-01 00:29:53 -04001775static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001776{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001777 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001778 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04001779}
1780
Andrew Morton34a148b2009-01-09 12:27:09 -08001781static void rb_inc_iter(struct ring_buffer_iter *iter)
Steven Rostedtd7690412008-10-01 00:29:53 -04001782{
1783 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1784
1785 /*
1786 * The iterator could be on the reader page (it starts there).
1787 * But the head could have moved, since the reader was
1788 * found. Check for this case and assign the iterator
1789 * to the head page instead of next.
1790 */
1791 if (iter->head_page == cpu_buffer->reader_page)
Steven Rostedt77ae3652009-03-27 11:00:29 -04001792 iter->head_page = rb_set_head_page(cpu_buffer);
Steven Rostedtd7690412008-10-01 00:29:53 -04001793 else
1794 rb_inc_page(cpu_buffer, &iter->head_page);
1795
Steven Rostedtabc9b562008-12-02 15:34:06 -05001796 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001797 iter->head = 0;
1798}
1799
Steven Rostedt69d1b832010-10-07 18:18:05 -04001800/* Slow path, do not inline */
1801static noinline struct ring_buffer_event *
1802rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
1803{
1804 event->type_len = RINGBUF_TYPE_TIME_EXTEND;
1805
1806 /* Not the first event on the page? */
1807 if (rb_event_index(event)) {
1808 event->time_delta = delta & TS_MASK;
1809 event->array[0] = delta >> TS_SHIFT;
1810 } else {
1811 /* nope, just zero it */
1812 event->time_delta = 0;
1813 event->array[0] = 0;
1814 }
1815
1816 return skip_time_extend(event);
1817}
1818
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001819/**
1820 * ring_buffer_update_event - update event type and data
1821 * @event: the even to update
1822 * @type: the type of event
1823 * @length: the size of the event field in the ring buffer
1824 *
1825 * Update the type and data fields of the event. The length
1826 * is the actual size that is written to the ring buffer,
1827 * and with this, we can determine what to place into the
1828 * data field.
1829 */
Andrew Morton34a148b2009-01-09 12:27:09 -08001830static void
Steven Rostedt69d1b832010-10-07 18:18:05 -04001831rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
1832 struct ring_buffer_event *event, unsigned length,
1833 int add_timestamp, u64 delta)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001834{
Steven Rostedt69d1b832010-10-07 18:18:05 -04001835 /* Only a commit updates the timestamp */
1836 if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
1837 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001838
Steven Rostedt69d1b832010-10-07 18:18:05 -04001839 /*
1840 * If we need to add a timestamp, then we
1841 * add it to the start of the resevered space.
1842 */
1843 if (unlikely(add_timestamp)) {
1844 event = rb_add_time_stamp(event, delta);
1845 length -= RB_LEN_TIME_EXTEND;
1846 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001847 }
Steven Rostedt69d1b832010-10-07 18:18:05 -04001848
1849 event->time_delta = delta;
1850 length -= RB_EVNT_HDR_SIZE;
1851 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
1852 event->type_len = 0;
1853 event->array[0] = length;
1854 } else
1855 event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001856}
1857
Steven Rostedt77ae3652009-03-27 11:00:29 -04001858/*
1859 * rb_handle_head_page - writer hit the head page
1860 *
1861 * Returns: +1 to retry page
1862 * 0 to continue
1863 * -1 on error
1864 */
1865static int
1866rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
1867 struct buffer_page *tail_page,
1868 struct buffer_page *next_page)
1869{
1870 struct buffer_page *new_head;
1871 int entries;
1872 int type;
1873 int ret;
1874
1875 entries = rb_page_entries(next_page);
1876
1877 /*
1878 * The hard part is here. We need to move the head
1879 * forward, and protect against both readers on
1880 * other CPUs and writers coming in via interrupts.
1881 */
1882 type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
1883 RB_PAGE_HEAD);
1884
1885 /*
1886 * type can be one of four:
1887 * NORMAL - an interrupt already moved it for us
1888 * HEAD - we are the first to get here.
1889 * UPDATE - we are the interrupt interrupting
1890 * a current move.
1891 * MOVED - a reader on another CPU moved the next
1892 * pointer to its reader page. Give up
1893 * and try again.
1894 */
1895
1896 switch (type) {
1897 case RB_PAGE_HEAD:
1898 /*
1899 * We changed the head to UPDATE, thus
1900 * it is our responsibility to update
1901 * the counters.
1902 */
1903 local_add(entries, &cpu_buffer->overrun);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07001904 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
Steven Rostedt77ae3652009-03-27 11:00:29 -04001905
1906 /*
1907 * The entries will be zeroed out when we move the
1908 * tail page.
1909 */
1910
1911 /* still more to do */
1912 break;
1913
1914 case RB_PAGE_UPDATE:
1915 /*
1916 * This is an interrupt that interrupt the
1917 * previous update. Still more to do.
1918 */
1919 break;
1920 case RB_PAGE_NORMAL:
1921 /*
1922 * An interrupt came in before the update
1923 * and processed this for us.
1924 * Nothing left to do.
1925 */
1926 return 1;
1927 case RB_PAGE_MOVED:
1928 /*
1929 * The reader is on another CPU and just did
1930 * a swap with our next_page.
1931 * Try again.
1932 */
1933 return 1;
1934 default:
1935 RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
1936 return -1;
1937 }
1938
1939 /*
1940 * Now that we are here, the old head pointer is
1941 * set to UPDATE. This will keep the reader from
1942 * swapping the head page with the reader page.
1943 * The reader (on another CPU) will spin till
1944 * we are finished.
1945 *
1946 * We just need to protect against interrupts
1947 * doing the job. We will set the next pointer
1948 * to HEAD. After that, we set the old pointer
1949 * to NORMAL, but only if it was HEAD before.
1950 * otherwise we are an interrupt, and only
1951 * want the outer most commit to reset it.
1952 */
1953 new_head = next_page;
1954 rb_inc_page(cpu_buffer, &new_head);
1955
1956 ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
1957 RB_PAGE_NORMAL);
1958
1959 /*
1960 * Valid returns are:
1961 * HEAD - an interrupt came in and already set it.
1962 * NORMAL - One of two things:
1963 * 1) We really set it.
1964 * 2) A bunch of interrupts came in and moved
1965 * the page forward again.
1966 */
1967 switch (ret) {
1968 case RB_PAGE_HEAD:
1969 case RB_PAGE_NORMAL:
1970 /* OK */
1971 break;
1972 default:
1973 RB_WARN_ON(cpu_buffer, 1);
1974 return -1;
1975 }
1976
1977 /*
1978 * It is possible that an interrupt came in,
1979 * set the head up, then more interrupts came in
1980 * and moved it again. When we get back here,
1981 * the page would have been set to NORMAL but we
1982 * just set it back to HEAD.
1983 *
1984 * How do you detect this? Well, if that happened
1985 * the tail page would have moved.
1986 */
1987 if (ret == RB_PAGE_NORMAL) {
1988 /*
1989 * If the tail had moved passed next, then we need
1990 * to reset the pointer.
1991 */
1992 if (cpu_buffer->tail_page != tail_page &&
1993 cpu_buffer->tail_page != next_page)
1994 rb_head_page_set_normal(cpu_buffer, new_head,
1995 next_page,
1996 RB_PAGE_HEAD);
1997 }
1998
1999 /*
2000 * If this was the outer most commit (the one that
2001 * changed the original pointer from HEAD to UPDATE),
2002 * then it is up to us to reset it to NORMAL.
2003 */
2004 if (type == RB_PAGE_HEAD) {
2005 ret = rb_head_page_set_normal(cpu_buffer, next_page,
2006 tail_page,
2007 RB_PAGE_UPDATE);
2008 if (RB_WARN_ON(cpu_buffer,
2009 ret != RB_PAGE_UPDATE))
2010 return -1;
2011 }
2012
2013 return 0;
2014}
2015
Andrew Morton34a148b2009-01-09 12:27:09 -08002016static unsigned rb_calculate_event_length(unsigned length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002017{
2018 struct ring_buffer_event event; /* Used only for sizeof array */
2019
2020 /* zero length can cause confusions */
2021 if (!length)
2022 length = 1;
2023
Steven Rostedt22710482010-03-18 17:54:19 -04002024 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002025 length += sizeof(event.array[0]);
2026
2027 length += RB_EVNT_HDR_SIZE;
Steven Rostedt22710482010-03-18 17:54:19 -04002028 length = ALIGN(length, RB_ARCH_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002029
2030 return length;
2031}
2032
Steven Rostedtc7b09302009-06-11 11:12:00 -04002033static inline void
2034rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
2035 struct buffer_page *tail_page,
2036 unsigned long tail, unsigned long length)
2037{
2038 struct ring_buffer_event *event;
2039
2040 /*
2041 * Only the event that crossed the page boundary
2042 * must fill the old tail_page with padding.
2043 */
2044 if (tail >= BUF_PAGE_SIZE) {
Steven Rostedtb3230c82010-05-21 11:55:21 -04002045 /*
2046 * If the page was filled, then we still need
2047 * to update the real_end. Reset it to zero
2048 * and the reader will ignore it.
2049 */
2050 if (tail == BUF_PAGE_SIZE)
2051 tail_page->real_end = 0;
2052
Steven Rostedtc7b09302009-06-11 11:12:00 -04002053 local_sub(length, &tail_page->write);
2054 return;
2055 }
2056
2057 event = __rb_page_index(tail_page, tail);
Linus Torvaldsb0b70652009-06-20 10:56:46 -07002058 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedtc7b09302009-06-11 11:12:00 -04002059
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002060 /* account for padding bytes */
2061 local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
2062
Steven Rostedtc7b09302009-06-11 11:12:00 -04002063 /*
Steven Rostedtff0ff842010-03-31 22:11:42 -04002064 * Save the original length to the meta data.
2065 * This will be used by the reader to add lost event
2066 * counter.
2067 */
2068 tail_page->real_end = tail;
2069
2070 /*
Steven Rostedtc7b09302009-06-11 11:12:00 -04002071 * If this event is bigger than the minimum size, then
2072 * we need to be careful that we don't subtract the
2073 * write counter enough to allow another writer to slip
2074 * in on this page.
2075 * We put in a discarded commit instead, to make sure
2076 * that this space is not used again.
2077 *
2078 * If we are less than the minimum size, we don't need to
2079 * worry about it.
2080 */
2081 if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
2082 /* No room for any events */
2083
2084 /* Mark the rest of the page with padding */
2085 rb_event_set_padding(event);
2086
2087 /* Set the write back to the previous setting */
2088 local_sub(length, &tail_page->write);
2089 return;
2090 }
2091
2092 /* Put in a discarded event */
2093 event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
2094 event->type_len = RINGBUF_TYPE_PADDING;
2095 /* time delta must be non zero */
2096 event->time_delta = 1;
Steven Rostedtc7b09302009-06-11 11:12:00 -04002097
2098 /* Set write to end of buffer */
2099 length = (tail + length) - BUF_PAGE_SIZE;
2100 local_sub(length, &tail_page->write);
2101}
Steven Rostedt6634ff22009-05-06 15:30:07 -04002102
Steven Rostedt747e94a2010-10-08 13:51:48 -04002103/*
2104 * This is the slow path, force gcc not to inline it.
2105 */
2106static noinline struct ring_buffer_event *
Steven Rostedt6634ff22009-05-06 15:30:07 -04002107rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
2108 unsigned long length, unsigned long tail,
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002109 struct buffer_page *tail_page, u64 ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002110{
Steven Rostedt5a50e332009-11-17 08:43:01 -05002111 struct buffer_page *commit_page = cpu_buffer->commit_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002112 struct ring_buffer *buffer = cpu_buffer->buffer;
Steven Rostedt77ae3652009-03-27 11:00:29 -04002113 struct buffer_page *next_page;
2114 int ret;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002115
2116 next_page = tail_page;
2117
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002118 rb_inc_page(cpu_buffer, &next_page);
2119
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002120 /*
2121 * If for some reason, we had an interrupt storm that made
2122 * it all the way around the buffer, bail, and warn
2123 * about it.
2124 */
2125 if (unlikely(next_page == commit_page)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04002126 local_inc(&cpu_buffer->commit_overrun);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002127 goto out_reset;
2128 }
2129
Steven Rostedt77ae3652009-03-27 11:00:29 -04002130 /*
2131 * This is where the fun begins!
2132 *
2133 * We are fighting against races between a reader that
2134 * could be on another CPU trying to swap its reader
2135 * page with the buffer head.
2136 *
2137 * We are also fighting against interrupts coming in and
2138 * moving the head or tail on us as well.
2139 *
2140 * If the next page is the head page then we have filled
2141 * the buffer, unless the commit page is still on the
2142 * reader page.
2143 */
2144 if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002145
Steven Rostedt77ae3652009-03-27 11:00:29 -04002146 /*
2147 * If the commit is not on the reader page, then
2148 * move the header page.
2149 */
2150 if (!rb_is_reader_page(cpu_buffer->commit_page)) {
2151 /*
2152 * If we are not in overwrite mode,
2153 * this is easy, just stop here.
2154 */
2155 if (!(buffer->flags & RB_FL_OVERWRITE))
2156 goto out_reset;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002157
Steven Rostedt77ae3652009-03-27 11:00:29 -04002158 ret = rb_handle_head_page(cpu_buffer,
2159 tail_page,
2160 next_page);
2161 if (ret < 0)
2162 goto out_reset;
2163 if (ret)
2164 goto out_again;
2165 } else {
2166 /*
2167 * We need to be careful here too. The
2168 * commit page could still be on the reader
2169 * page. We could have a small buffer, and
2170 * have filled up the buffer with events
2171 * from interrupts and such, and wrapped.
2172 *
2173 * Note, if the tail page is also the on the
2174 * reader_page, we let it move out.
2175 */
2176 if (unlikely((cpu_buffer->commit_page !=
2177 cpu_buffer->tail_page) &&
2178 (cpu_buffer->commit_page ==
2179 cpu_buffer->reader_page))) {
2180 local_inc(&cpu_buffer->commit_overrun);
2181 goto out_reset;
2182 }
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002183 }
2184 }
2185
Steven Rostedt77ae3652009-03-27 11:00:29 -04002186 ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
2187 if (ret) {
2188 /*
2189 * Nested commits always have zero deltas, so
2190 * just reread the time stamp
2191 */
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002192 ts = rb_time_stamp(buffer);
2193 next_page->page->time_stamp = ts;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002194 }
2195
Steven Rostedt77ae3652009-03-27 11:00:29 -04002196 out_again:
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002197
Steven Rostedt77ae3652009-03-27 11:00:29 -04002198 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002199
2200 /* fail and let the caller try again */
2201 return ERR_PTR(-EAGAIN);
2202
Steven Rostedt45141d42009-02-12 13:19:48 -05002203 out_reset:
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08002204 /* reset write */
Steven Rostedtc7b09302009-06-11 11:12:00 -04002205 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08002206
Steven Rostedtbf41a152008-10-04 02:00:59 -04002207 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002208}
2209
Steven Rostedt6634ff22009-05-06 15:30:07 -04002210static struct ring_buffer_event *
2211__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt69d1b832010-10-07 18:18:05 -04002212 unsigned long length, u64 ts,
2213 u64 delta, int add_timestamp)
Steven Rostedt6634ff22009-05-06 15:30:07 -04002214{
Steven Rostedt5a50e332009-11-17 08:43:01 -05002215 struct buffer_page *tail_page;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002216 struct ring_buffer_event *event;
2217 unsigned long tail, write;
2218
Steven Rostedt69d1b832010-10-07 18:18:05 -04002219 /*
2220 * If the time delta since the last event is too big to
2221 * hold in the time field of the event, then we append a
2222 * TIME EXTEND event ahead of the data event.
2223 */
2224 if (unlikely(add_timestamp))
2225 length += RB_LEN_TIME_EXTEND;
2226
Steven Rostedt6634ff22009-05-06 15:30:07 -04002227 tail_page = cpu_buffer->tail_page;
2228 write = local_add_return(length, &tail_page->write);
Steven Rostedt77ae3652009-03-27 11:00:29 -04002229
2230 /* set write to only the index of the write */
2231 write &= RB_WRITE_MASK;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002232 tail = write - length;
2233
2234 /* See if we shot pass the end of this buffer page */
Steven Rostedt747e94a2010-10-08 13:51:48 -04002235 if (unlikely(write > BUF_PAGE_SIZE))
Steven Rostedt6634ff22009-05-06 15:30:07 -04002236 return rb_move_tail(cpu_buffer, length, tail,
Steven Rostedt5a50e332009-11-17 08:43:01 -05002237 tail_page, ts);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002238
2239 /* We reserved something on the buffer */
2240
Steven Rostedt6634ff22009-05-06 15:30:07 -04002241 event = __rb_page_index(tail_page, tail);
Vegard Nossum1744a212009-02-28 08:29:44 +01002242 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedt69d1b832010-10-07 18:18:05 -04002243 rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002244
Steven Rostedt69d1b832010-10-07 18:18:05 -04002245 local_inc(&tail_page->entries);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002246
2247 /*
Steven Rostedtfa743952009-06-16 12:37:57 -04002248 * If this is the first commit on the page, then update
2249 * its timestamp.
Steven Rostedt6634ff22009-05-06 15:30:07 -04002250 */
Steven Rostedtfa743952009-06-16 12:37:57 -04002251 if (!tail)
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002252 tail_page->page->time_stamp = ts;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002253
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002254 /* account for these added bytes */
2255 local_add(length, &cpu_buffer->entries_bytes);
2256
Steven Rostedt6634ff22009-05-06 15:30:07 -04002257 return event;
2258}
2259
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002260static inline int
2261rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
2262 struct ring_buffer_event *event)
2263{
2264 unsigned long new_index, old_index;
2265 struct buffer_page *bpage;
2266 unsigned long index;
2267 unsigned long addr;
2268
2269 new_index = rb_event_index(event);
Steven Rostedt69d1b832010-10-07 18:18:05 -04002270 old_index = new_index + rb_event_ts_length(event);
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002271 addr = (unsigned long)event;
2272 addr &= PAGE_MASK;
2273
2274 bpage = cpu_buffer->tail_page;
2275
2276 if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04002277 unsigned long write_mask =
2278 local_read(&bpage->write) & ~RB_WRITE_MASK;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002279 unsigned long event_length = rb_event_length(event);
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002280 /*
2281 * This is on the tail page. It is possible that
2282 * a write could come in and move the tail page
2283 * and write to the next page. That is fine
2284 * because we just shorten what is on this page.
2285 */
Steven Rostedt77ae3652009-03-27 11:00:29 -04002286 old_index += write_mask;
2287 new_index += write_mask;
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002288 index = local_cmpxchg(&bpage->write, old_index, new_index);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002289 if (index == old_index) {
2290 /* update counters */
2291 local_sub(event_length, &cpu_buffer->entries_bytes);
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002292 return 1;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002293 }
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002294 }
2295
2296 /* could not discard */
2297 return 0;
2298}
2299
Steven Rostedtfa743952009-06-16 12:37:57 -04002300static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
2301{
2302 local_inc(&cpu_buffer->committing);
2303 local_inc(&cpu_buffer->commits);
2304}
2305
Steven Rostedtd9abde22010-10-19 13:17:08 -04002306static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtfa743952009-06-16 12:37:57 -04002307{
2308 unsigned long commits;
2309
2310 if (RB_WARN_ON(cpu_buffer,
2311 !local_read(&cpu_buffer->committing)))
2312 return;
2313
2314 again:
2315 commits = local_read(&cpu_buffer->commits);
2316 /* synchronize with interrupts */
2317 barrier();
2318 if (local_read(&cpu_buffer->committing) == 1)
2319 rb_set_commit_to_write(cpu_buffer);
2320
2321 local_dec(&cpu_buffer->committing);
2322
2323 /* synchronize with interrupts */
2324 barrier();
2325
2326 /*
2327 * Need to account for interrupts coming in between the
2328 * updating of the commit page and the clearing of the
2329 * committing counter.
2330 */
2331 if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
2332 !local_read(&cpu_buffer->committing)) {
2333 local_inc(&cpu_buffer->committing);
2334 goto again;
2335 }
2336}
2337
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002338static struct ring_buffer_event *
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002339rb_reserve_next_event(struct ring_buffer *buffer,
2340 struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt1cd8d732009-05-11 14:08:09 -04002341 unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002342{
2343 struct ring_buffer_event *event;
Steven Rostedt69d1b832010-10-07 18:18:05 -04002344 u64 ts, delta;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002345 int nr_loops = 0;
Steven Rostedt69d1b832010-10-07 18:18:05 -04002346 int add_timestamp;
Steven Rostedt140ff892010-10-08 10:50:30 -04002347 u64 diff;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002348
Steven Rostedtfa743952009-06-16 12:37:57 -04002349 rb_start_commit(cpu_buffer);
2350
Steven Rostedt85bac322009-09-04 14:24:40 -04002351#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002352 /*
2353 * Due to the ability to swap a cpu buffer from a buffer
2354 * it is possible it was swapped before we committed.
2355 * (committing stops a swap). We check for it here and
2356 * if it happened, we have to fail the write.
2357 */
2358 barrier();
2359 if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
2360 local_dec(&cpu_buffer->committing);
2361 local_dec(&cpu_buffer->commits);
2362 return NULL;
2363 }
Steven Rostedt85bac322009-09-04 14:24:40 -04002364#endif
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002365
Steven Rostedtbe957c42009-05-11 14:42:53 -04002366 length = rb_calculate_event_length(length);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002367 again:
Steven Rostedt69d1b832010-10-07 18:18:05 -04002368 add_timestamp = 0;
2369 delta = 0;
2370
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002371 /*
2372 * We allow for interrupts to reenter here and do a trace.
2373 * If one does, it will cause this original code to loop
2374 * back here. Even with heavy interrupts happening, this
2375 * should only happen a few times in a row. If this happens
2376 * 1000 times in a row, there must be either an interrupt
2377 * storm or we have something buggy.
2378 * Bail!
2379 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002380 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
Steven Rostedtfa743952009-06-16 12:37:57 -04002381 goto out_fail;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002382
Jiri Olsa6d3f1e12009-10-23 19:36:19 -04002383 ts = rb_time_stamp(cpu_buffer->buffer);
Steven Rostedt140ff892010-10-08 10:50:30 -04002384 diff = ts - cpu_buffer->write_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002385
Steven Rostedt140ff892010-10-08 10:50:30 -04002386 /* make sure this diff is calculated here */
2387 barrier();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002388
Steven Rostedt140ff892010-10-08 10:50:30 -04002389 /* Did the write stamp get updated already? */
2390 if (likely(ts >= cpu_buffer->write_stamp)) {
Steven Rostedt168b6b12009-05-11 22:11:05 -04002391 delta = diff;
2392 if (unlikely(test_time_stamp(delta))) {
Jiri Olsa31274d72011-02-18 15:52:19 +01002393 int local_clock_stable = 1;
2394#ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
2395 local_clock_stable = sched_clock_stable;
2396#endif
Steven Rostedt69d1b832010-10-07 18:18:05 -04002397 WARN_ONCE(delta > (1ULL << 59),
Jiri Olsa31274d72011-02-18 15:52:19 +01002398 KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
Steven Rostedt69d1b832010-10-07 18:18:05 -04002399 (unsigned long long)delta,
2400 (unsigned long long)ts,
Jiri Olsa31274d72011-02-18 15:52:19 +01002401 (unsigned long long)cpu_buffer->write_stamp,
2402 local_clock_stable ? "" :
2403 "If you just came from a suspend/resume,\n"
2404 "please switch to the trace global clock:\n"
2405 " echo global > /sys/kernel/debug/tracing/trace_clock\n");
Steven Rostedt69d1b832010-10-07 18:18:05 -04002406 add_timestamp = 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002407 }
Steven Rostedt168b6b12009-05-11 22:11:05 -04002408 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002409
Steven Rostedt69d1b832010-10-07 18:18:05 -04002410 event = __rb_reserve_next(cpu_buffer, length, ts,
2411 delta, add_timestamp);
Steven Rostedt168b6b12009-05-11 22:11:05 -04002412 if (unlikely(PTR_ERR(event) == -EAGAIN))
Steven Rostedtbf41a152008-10-04 02:00:59 -04002413 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002414
Steven Rostedtfa743952009-06-16 12:37:57 -04002415 if (!event)
2416 goto out_fail;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002417
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002418 return event;
Steven Rostedtfa743952009-06-16 12:37:57 -04002419
2420 out_fail:
2421 rb_end_commit(cpu_buffer);
2422 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002423}
2424
Paul Mundt1155de42009-06-25 14:30:12 +09002425#ifdef CONFIG_TRACING
2426
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002427#define TRACE_RECURSIVE_DEPTH 16
Steven Rostedt261842b2009-04-16 21:41:52 -04002428
Steven Rostedtd9abde22010-10-19 13:17:08 -04002429/* Keep this code out of the fast path cache */
2430static noinline void trace_recursive_fail(void)
Steven Rostedt261842b2009-04-16 21:41:52 -04002431{
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002432 /* Disable all tracing before we do anything else */
2433 tracing_off_permanent();
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02002434
Steven Rostedt7d7d2b82009-04-27 12:37:49 -04002435 printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002436 "HC[%lu]:SC[%lu]:NMI[%lu]\n",
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002437 trace_recursion_buffer(),
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002438 hardirq_count() >> HARDIRQ_SHIFT,
2439 softirq_count() >> SOFTIRQ_SHIFT,
2440 in_nmi());
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02002441
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002442 WARN_ON_ONCE(1);
Steven Rostedtd9abde22010-10-19 13:17:08 -04002443}
2444
2445static inline int trace_recursive_lock(void)
2446{
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002447 trace_recursion_inc();
Steven Rostedtd9abde22010-10-19 13:17:08 -04002448
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002449 if (likely(trace_recursion_buffer() < TRACE_RECURSIVE_DEPTH))
Steven Rostedtd9abde22010-10-19 13:17:08 -04002450 return 0;
2451
2452 trace_recursive_fail();
2453
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002454 return -1;
Steven Rostedt261842b2009-04-16 21:41:52 -04002455}
2456
Steven Rostedtd9abde22010-10-19 13:17:08 -04002457static inline void trace_recursive_unlock(void)
Steven Rostedt261842b2009-04-16 21:41:52 -04002458{
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002459 WARN_ON_ONCE(!trace_recursion_buffer());
Steven Rostedt261842b2009-04-16 21:41:52 -04002460
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002461 trace_recursion_dec();
Steven Rostedt261842b2009-04-16 21:41:52 -04002462}
2463
Paul Mundt1155de42009-06-25 14:30:12 +09002464#else
2465
2466#define trace_recursive_lock() (0)
2467#define trace_recursive_unlock() do { } while (0)
2468
2469#endif
2470
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002471/**
2472 * ring_buffer_lock_reserve - reserve a part of the buffer
2473 * @buffer: the ring buffer to reserve from
2474 * @length: the length of the data to reserve (excluding event header)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002475 *
2476 * Returns a reseverd event on the ring buffer to copy directly to.
2477 * The user of this interface will need to get the body to write into
2478 * and can use the ring_buffer_event_data() interface.
2479 *
2480 * The length is the length of the data needed, not the event length
2481 * which also includes the event header.
2482 *
2483 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
2484 * If NULL is returned, then nothing has been allocated or locked.
2485 */
2486struct ring_buffer_event *
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02002487ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002488{
2489 struct ring_buffer_per_cpu *cpu_buffer;
2490 struct ring_buffer_event *event;
Steven Rostedt5168ae52010-06-03 09:36:50 -04002491 int cpu;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002492
Steven Rostedt033601a2008-11-21 12:41:55 -05002493 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05002494 return NULL;
2495
Steven Rostedtbf41a152008-10-04 02:00:59 -04002496 /* If we are tracing schedule, we don't want to recurse */
Steven Rostedt5168ae52010-06-03 09:36:50 -04002497 preempt_disable_notrace();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002498
Lai Jiangshan52fbe9c2010-03-08 14:50:43 +08002499 if (atomic_read(&buffer->record_disabled))
2500 goto out_nocheck;
2501
Steven Rostedt261842b2009-04-16 21:41:52 -04002502 if (trace_recursive_lock())
2503 goto out_nocheck;
2504
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002505 cpu = raw_smp_processor_id();
2506
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302507 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04002508 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002509
2510 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002511
2512 if (atomic_read(&cpu_buffer->record_disabled))
Steven Rostedtd7690412008-10-01 00:29:53 -04002513 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002514
Steven Rostedtbe957c42009-05-11 14:42:53 -04002515 if (length > BUF_MAX_DATA_SIZE)
Steven Rostedtbf41a152008-10-04 02:00:59 -04002516 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002517
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002518 event = rb_reserve_next_event(buffer, cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002519 if (!event)
Steven Rostedtd7690412008-10-01 00:29:53 -04002520 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002521
2522 return event;
2523
Steven Rostedtd7690412008-10-01 00:29:53 -04002524 out:
Steven Rostedt261842b2009-04-16 21:41:52 -04002525 trace_recursive_unlock();
2526
2527 out_nocheck:
Steven Rostedt5168ae52010-06-03 09:36:50 -04002528 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002529 return NULL;
2530}
Robert Richterc4f50182008-12-11 16:49:22 +01002531EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002532
Steven Rostedta1863c22009-09-03 10:23:58 -04002533static void
2534rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002535 struct ring_buffer_event *event)
2536{
Steven Rostedt69d1b832010-10-07 18:18:05 -04002537 u64 delta;
2538
Steven Rostedtfa743952009-06-16 12:37:57 -04002539 /*
2540 * The event first in the commit queue updates the
2541 * time stamp.
2542 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04002543 if (rb_event_is_commit(cpu_buffer, event)) {
2544 /*
2545 * A commit event that is first on a page
2546 * updates the write timestamp with the page stamp
2547 */
2548 if (!rb_event_index(event))
2549 cpu_buffer->write_stamp =
2550 cpu_buffer->commit_page->page->time_stamp;
2551 else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
2552 delta = event->array[0];
2553 delta <<= TS_SHIFT;
2554 delta += event->time_delta;
2555 cpu_buffer->write_stamp += delta;
2556 } else
2557 cpu_buffer->write_stamp += event->time_delta;
2558 }
Steven Rostedta1863c22009-09-03 10:23:58 -04002559}
Steven Rostedtbf41a152008-10-04 02:00:59 -04002560
Steven Rostedta1863c22009-09-03 10:23:58 -04002561static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
2562 struct ring_buffer_event *event)
2563{
2564 local_inc(&cpu_buffer->entries);
2565 rb_update_write_stamp(cpu_buffer, event);
Steven Rostedtfa743952009-06-16 12:37:57 -04002566 rb_end_commit(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002567}
2568
2569/**
2570 * ring_buffer_unlock_commit - commit a reserved
2571 * @buffer: The buffer to commit to
2572 * @event: The event pointer to commit.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002573 *
2574 * This commits the data to the ring buffer, and releases any locks held.
2575 *
2576 * Must be paired with ring_buffer_lock_reserve.
2577 */
2578int ring_buffer_unlock_commit(struct ring_buffer *buffer,
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02002579 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002580{
2581 struct ring_buffer_per_cpu *cpu_buffer;
2582 int cpu = raw_smp_processor_id();
2583
2584 cpu_buffer = buffer->buffers[cpu];
2585
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002586 rb_commit(cpu_buffer, event);
2587
Steven Rostedt261842b2009-04-16 21:41:52 -04002588 trace_recursive_unlock();
2589
Steven Rostedt5168ae52010-06-03 09:36:50 -04002590 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002591
2592 return 0;
2593}
Robert Richterc4f50182008-12-11 16:49:22 +01002594EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002595
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002596static inline void rb_event_discard(struct ring_buffer_event *event)
2597{
Steven Rostedt69d1b832010-10-07 18:18:05 -04002598 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
2599 event = skip_time_extend(event);
2600
Lai Jiangshan334d4162009-04-24 11:27:05 +08002601 /* array[0] holds the actual length for the discarded event */
2602 event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
2603 event->type_len = RINGBUF_TYPE_PADDING;
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002604 /* time delta must be non zero */
2605 if (!event->time_delta)
2606 event->time_delta = 1;
2607}
2608
Steven Rostedta1863c22009-09-03 10:23:58 -04002609/*
2610 * Decrement the entries to the page that an event is on.
2611 * The event does not even need to exist, only the pointer
2612 * to the page it is on. This may only be called before the commit
2613 * takes place.
2614 */
2615static inline void
2616rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
2617 struct ring_buffer_event *event)
2618{
2619 unsigned long addr = (unsigned long)event;
2620 struct buffer_page *bpage = cpu_buffer->commit_page;
2621 struct buffer_page *start;
2622
2623 addr &= PAGE_MASK;
2624
2625 /* Do the likely case first */
2626 if (likely(bpage->page == (void *)addr)) {
2627 local_dec(&bpage->entries);
2628 return;
2629 }
2630
2631 /*
2632 * Because the commit page may be on the reader page we
2633 * start with the next page and check the end loop there.
2634 */
2635 rb_inc_page(cpu_buffer, &bpage);
2636 start = bpage;
2637 do {
2638 if (bpage->page == (void *)addr) {
2639 local_dec(&bpage->entries);
2640 return;
2641 }
2642 rb_inc_page(cpu_buffer, &bpage);
2643 } while (bpage != start);
2644
2645 /* commit not part of this buffer?? */
2646 RB_WARN_ON(cpu_buffer, 1);
2647}
2648
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002649/**
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002650 * ring_buffer_commit_discard - discard an event that has not been committed
2651 * @buffer: the ring buffer
2652 * @event: non committed event to discard
2653 *
Steven Rostedtdc892f72009-09-03 15:33:41 -04002654 * Sometimes an event that is in the ring buffer needs to be ignored.
2655 * This function lets the user discard an event in the ring buffer
2656 * and then that event will not be read later.
2657 *
2658 * This function only works if it is called before the the item has been
2659 * committed. It will try to free the event from the ring buffer
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002660 * if another event has not been added behind it.
2661 *
2662 * If another event has been added behind it, it will set the event
2663 * up as discarded, and perform the commit.
2664 *
2665 * If this function is called, do not call ring_buffer_unlock_commit on
2666 * the event.
2667 */
2668void ring_buffer_discard_commit(struct ring_buffer *buffer,
2669 struct ring_buffer_event *event)
2670{
2671 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002672 int cpu;
2673
2674 /* The event is discarded regardless */
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002675 rb_event_discard(event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002676
Steven Rostedtfa743952009-06-16 12:37:57 -04002677 cpu = smp_processor_id();
2678 cpu_buffer = buffer->buffers[cpu];
2679
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002680 /*
2681 * This must only be called if the event has not been
2682 * committed yet. Thus we can assume that preemption
2683 * is still disabled.
2684 */
Steven Rostedtfa743952009-06-16 12:37:57 -04002685 RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002686
Steven Rostedta1863c22009-09-03 10:23:58 -04002687 rb_decrement_entry(cpu_buffer, event);
Steven Rostedt0f2541d2009-08-05 12:02:48 -04002688 if (rb_try_to_discard(cpu_buffer, event))
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002689 goto out;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002690
2691 /*
2692 * The commit is still visible by the reader, so we
Steven Rostedta1863c22009-09-03 10:23:58 -04002693 * must still update the timestamp.
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002694 */
Steven Rostedta1863c22009-09-03 10:23:58 -04002695 rb_update_write_stamp(cpu_buffer, event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002696 out:
Steven Rostedtfa743952009-06-16 12:37:57 -04002697 rb_end_commit(cpu_buffer);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002698
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002699 trace_recursive_unlock();
2700
Steven Rostedt5168ae52010-06-03 09:36:50 -04002701 preempt_enable_notrace();
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002702
2703}
2704EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
2705
2706/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002707 * ring_buffer_write - write data to the buffer without reserving
2708 * @buffer: The ring buffer to write to.
2709 * @length: The length of the data being written (excluding the event header)
2710 * @data: The data to write to the buffer.
2711 *
2712 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
2713 * one function. If you already have the data to write to the buffer, it
2714 * may be easier to simply call this function.
2715 *
2716 * Note, like ring_buffer_lock_reserve, the length is the length of the data
2717 * and not the length of the event which would hold the header.
2718 */
2719int ring_buffer_write(struct ring_buffer *buffer,
2720 unsigned long length,
2721 void *data)
2722{
2723 struct ring_buffer_per_cpu *cpu_buffer;
2724 struct ring_buffer_event *event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002725 void *body;
2726 int ret = -EBUSY;
Steven Rostedt5168ae52010-06-03 09:36:50 -04002727 int cpu;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002728
Steven Rostedt033601a2008-11-21 12:41:55 -05002729 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05002730 return -EBUSY;
2731
Steven Rostedt5168ae52010-06-03 09:36:50 -04002732 preempt_disable_notrace();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002733
Lai Jiangshan52fbe9c2010-03-08 14:50:43 +08002734 if (atomic_read(&buffer->record_disabled))
2735 goto out;
2736
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002737 cpu = raw_smp_processor_id();
2738
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302739 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04002740 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002741
2742 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002743
2744 if (atomic_read(&cpu_buffer->record_disabled))
2745 goto out;
2746
Steven Rostedtbe957c42009-05-11 14:42:53 -04002747 if (length > BUF_MAX_DATA_SIZE)
2748 goto out;
2749
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002750 event = rb_reserve_next_event(buffer, cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002751 if (!event)
2752 goto out;
2753
2754 body = rb_event_data(event);
2755
2756 memcpy(body, data, length);
2757
2758 rb_commit(cpu_buffer, event);
2759
2760 ret = 0;
2761 out:
Steven Rostedt5168ae52010-06-03 09:36:50 -04002762 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002763
2764 return ret;
2765}
Robert Richterc4f50182008-12-11 16:49:22 +01002766EXPORT_SYMBOL_GPL(ring_buffer_write);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002767
Andrew Morton34a148b2009-01-09 12:27:09 -08002768static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtbf41a152008-10-04 02:00:59 -04002769{
2770 struct buffer_page *reader = cpu_buffer->reader_page;
Steven Rostedt77ae3652009-03-27 11:00:29 -04002771 struct buffer_page *head = rb_set_head_page(cpu_buffer);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002772 struct buffer_page *commit = cpu_buffer->commit_page;
2773
Steven Rostedt77ae3652009-03-27 11:00:29 -04002774 /* In case of error, head will be NULL */
2775 if (unlikely(!head))
2776 return 1;
2777
Steven Rostedtbf41a152008-10-04 02:00:59 -04002778 return reader->read == rb_page_commit(reader) &&
2779 (commit == reader ||
2780 (commit == head &&
2781 head->read == rb_page_commit(commit)));
2782}
2783
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002784/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002785 * ring_buffer_record_disable - stop all writes into the buffer
2786 * @buffer: The ring buffer to stop writes to.
2787 *
2788 * This prevents all writes to the buffer. Any attempt to write
2789 * to the buffer after this will fail and return NULL.
2790 *
2791 * The caller should call synchronize_sched() after this.
2792 */
2793void ring_buffer_record_disable(struct ring_buffer *buffer)
2794{
2795 atomic_inc(&buffer->record_disabled);
2796}
Robert Richterc4f50182008-12-11 16:49:22 +01002797EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002798
2799/**
2800 * ring_buffer_record_enable - enable writes to the buffer
2801 * @buffer: The ring buffer to enable writes
2802 *
2803 * Note, multiple disables will need the same number of enables
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05002804 * to truly enable the writing (much like preempt_disable).
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002805 */
2806void ring_buffer_record_enable(struct ring_buffer *buffer)
2807{
2808 atomic_dec(&buffer->record_disabled);
2809}
Robert Richterc4f50182008-12-11 16:49:22 +01002810EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002811
2812/**
Steven Rostedt499e5472012-02-22 15:50:28 -05002813 * ring_buffer_record_off - stop all writes into the buffer
2814 * @buffer: The ring buffer to stop writes to.
2815 *
2816 * This prevents all writes to the buffer. Any attempt to write
2817 * to the buffer after this will fail and return NULL.
2818 *
2819 * This is different than ring_buffer_record_disable() as
2820 * it works like an on/off switch, where as the disable() verison
2821 * must be paired with a enable().
2822 */
2823void ring_buffer_record_off(struct ring_buffer *buffer)
2824{
2825 unsigned int rd;
2826 unsigned int new_rd;
2827
2828 do {
2829 rd = atomic_read(&buffer->record_disabled);
2830 new_rd = rd | RB_BUFFER_OFF;
2831 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
2832}
2833EXPORT_SYMBOL_GPL(ring_buffer_record_off);
2834
2835/**
2836 * ring_buffer_record_on - restart writes into the buffer
2837 * @buffer: The ring buffer to start writes to.
2838 *
2839 * This enables all writes to the buffer that was disabled by
2840 * ring_buffer_record_off().
2841 *
2842 * This is different than ring_buffer_record_enable() as
2843 * it works like an on/off switch, where as the enable() verison
2844 * must be paired with a disable().
2845 */
2846void ring_buffer_record_on(struct ring_buffer *buffer)
2847{
2848 unsigned int rd;
2849 unsigned int new_rd;
2850
2851 do {
2852 rd = atomic_read(&buffer->record_disabled);
2853 new_rd = rd & ~RB_BUFFER_OFF;
2854 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
2855}
2856EXPORT_SYMBOL_GPL(ring_buffer_record_on);
2857
2858/**
2859 * ring_buffer_record_is_on - return true if the ring buffer can write
2860 * @buffer: The ring buffer to see if write is enabled
2861 *
2862 * Returns true if the ring buffer is in a state that it accepts writes.
2863 */
2864int ring_buffer_record_is_on(struct ring_buffer *buffer)
2865{
2866 return !atomic_read(&buffer->record_disabled);
2867}
2868
2869/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002870 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
2871 * @buffer: The ring buffer to stop writes to.
2872 * @cpu: The CPU buffer to stop
2873 *
2874 * This prevents all writes to the buffer. Any attempt to write
2875 * to the buffer after this will fail and return NULL.
2876 *
2877 * The caller should call synchronize_sched() after this.
2878 */
2879void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
2880{
2881 struct ring_buffer_per_cpu *cpu_buffer;
2882
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302883 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002884 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002885
2886 cpu_buffer = buffer->buffers[cpu];
2887 atomic_inc(&cpu_buffer->record_disabled);
2888}
Robert Richterc4f50182008-12-11 16:49:22 +01002889EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002890
2891/**
2892 * ring_buffer_record_enable_cpu - enable writes to the buffer
2893 * @buffer: The ring buffer to enable writes
2894 * @cpu: The CPU to enable.
2895 *
2896 * Note, multiple disables will need the same number of enables
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05002897 * to truly enable the writing (much like preempt_disable).
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002898 */
2899void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
2900{
2901 struct ring_buffer_per_cpu *cpu_buffer;
2902
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302903 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002904 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002905
2906 cpu_buffer = buffer->buffers[cpu];
2907 atomic_dec(&cpu_buffer->record_disabled);
2908}
Robert Richterc4f50182008-12-11 16:49:22 +01002909EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002910
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002911/*
2912 * The total entries in the ring buffer is the running counter
2913 * of entries entered into the ring buffer, minus the sum of
2914 * the entries read from the ring buffer and the number of
2915 * entries that were overwritten.
2916 */
2917static inline unsigned long
2918rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
2919{
2920 return local_read(&cpu_buffer->entries) -
2921 (local_read(&cpu_buffer->overrun) + cpu_buffer->read);
2922}
2923
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002924/**
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002925 * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
2926 * @buffer: The ring buffer
2927 * @cpu: The per CPU buffer to read from.
2928 */
2929unsigned long ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
2930{
2931 unsigned long flags;
2932 struct ring_buffer_per_cpu *cpu_buffer;
2933 struct buffer_page *bpage;
2934 unsigned long ret;
2935
2936 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2937 return 0;
2938
2939 cpu_buffer = buffer->buffers[cpu];
Linus Torvalds7115e3f2011-10-26 17:03:38 +02002940 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002941 /*
2942 * if the tail is on reader_page, oldest time stamp is on the reader
2943 * page
2944 */
2945 if (cpu_buffer->tail_page == cpu_buffer->reader_page)
2946 bpage = cpu_buffer->reader_page;
2947 else
2948 bpage = rb_set_head_page(cpu_buffer);
2949 ret = bpage->page->time_stamp;
Linus Torvalds7115e3f2011-10-26 17:03:38 +02002950 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002951
2952 return ret;
2953}
2954EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
2955
2956/**
2957 * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
2958 * @buffer: The ring buffer
2959 * @cpu: The per CPU buffer to read from.
2960 */
2961unsigned long ring_buffer_bytes_cpu(struct ring_buffer *buffer, int cpu)
2962{
2963 struct ring_buffer_per_cpu *cpu_buffer;
2964 unsigned long ret;
2965
2966 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2967 return 0;
2968
2969 cpu_buffer = buffer->buffers[cpu];
2970 ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
2971
2972 return ret;
2973}
2974EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
2975
2976/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002977 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
2978 * @buffer: The ring buffer
2979 * @cpu: The per CPU buffer to get the entries from.
2980 */
2981unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
2982{
2983 struct ring_buffer_per_cpu *cpu_buffer;
2984
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302985 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002986 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002987
2988 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04002989
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002990 return rb_num_of_entries(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002991}
Robert Richterc4f50182008-12-11 16:49:22 +01002992EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002993
2994/**
2995 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
2996 * @buffer: The ring buffer
2997 * @cpu: The per CPU buffer to get the number of overruns from
2998 */
2999unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
3000{
3001 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003002 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003003
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303004 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003005 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003006
3007 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04003008 ret = local_read(&cpu_buffer->overrun);
Steven Rostedt554f7862009-03-11 22:00:13 -04003009
3010 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003011}
Robert Richterc4f50182008-12-11 16:49:22 +01003012EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003013
3014/**
Steven Rostedtf0d2c682009-04-29 13:43:37 -04003015 * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
3016 * @buffer: The ring buffer
3017 * @cpu: The per CPU buffer to get the number of overruns from
3018 */
3019unsigned long
3020ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
3021{
3022 struct ring_buffer_per_cpu *cpu_buffer;
3023 unsigned long ret;
3024
3025 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3026 return 0;
3027
3028 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04003029 ret = local_read(&cpu_buffer->commit_overrun);
Steven Rostedtf0d2c682009-04-29 13:43:37 -04003030
3031 return ret;
3032}
3033EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
3034
3035/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003036 * ring_buffer_entries - get the number of entries in a buffer
3037 * @buffer: The ring buffer
3038 *
3039 * Returns the total number of entries in the ring buffer
3040 * (all CPU entries)
3041 */
3042unsigned long ring_buffer_entries(struct ring_buffer *buffer)
3043{
3044 struct ring_buffer_per_cpu *cpu_buffer;
3045 unsigned long entries = 0;
3046 int cpu;
3047
3048 /* if you care about this being correct, lock the buffer */
3049 for_each_buffer_cpu(buffer, cpu) {
3050 cpu_buffer = buffer->buffers[cpu];
Steven Rostedtf6195aa2010-09-01 12:23:12 -04003051 entries += rb_num_of_entries(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003052 }
3053
3054 return entries;
3055}
Robert Richterc4f50182008-12-11 16:49:22 +01003056EXPORT_SYMBOL_GPL(ring_buffer_entries);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003057
3058/**
Jiri Olsa67b394f2009-10-23 19:36:18 -04003059 * ring_buffer_overruns - get the number of overruns in buffer
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003060 * @buffer: The ring buffer
3061 *
3062 * Returns the total number of overruns in the ring buffer
3063 * (all CPU entries)
3064 */
3065unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
3066{
3067 struct ring_buffer_per_cpu *cpu_buffer;
3068 unsigned long overruns = 0;
3069 int cpu;
3070
3071 /* if you care about this being correct, lock the buffer */
3072 for_each_buffer_cpu(buffer, cpu) {
3073 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04003074 overruns += local_read(&cpu_buffer->overrun);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003075 }
3076
3077 return overruns;
3078}
Robert Richterc4f50182008-12-11 16:49:22 +01003079EXPORT_SYMBOL_GPL(ring_buffer_overruns);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003080
Steven Rostedt642edba2008-11-12 00:01:26 -05003081static void rb_iter_reset(struct ring_buffer_iter *iter)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003082{
3083 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3084
Steven Rostedtd7690412008-10-01 00:29:53 -04003085 /* Iterator usage is expected to have record disabled */
3086 if (list_empty(&cpu_buffer->reader_page->list)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04003087 iter->head_page = rb_set_head_page(cpu_buffer);
3088 if (unlikely(!iter->head_page))
3089 return;
3090 iter->head = iter->head_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04003091 } else {
3092 iter->head_page = cpu_buffer->reader_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003093 iter->head = cpu_buffer->reader_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04003094 }
3095 if (iter->head)
3096 iter->read_stamp = cpu_buffer->read_stamp;
3097 else
Steven Rostedtabc9b562008-12-02 15:34:06 -05003098 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt492a74f2010-01-25 15:17:47 -05003099 iter->cache_reader_page = cpu_buffer->reader_page;
3100 iter->cache_read = cpu_buffer->read;
Steven Rostedt642edba2008-11-12 00:01:26 -05003101}
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003102
Steven Rostedt642edba2008-11-12 00:01:26 -05003103/**
3104 * ring_buffer_iter_reset - reset an iterator
3105 * @iter: The iterator to reset
3106 *
3107 * Resets the iterator, so that it will start from the beginning
3108 * again.
3109 */
3110void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
3111{
Steven Rostedt554f7862009-03-11 22:00:13 -04003112 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt642edba2008-11-12 00:01:26 -05003113 unsigned long flags;
3114
Steven Rostedt554f7862009-03-11 22:00:13 -04003115 if (!iter)
3116 return;
3117
3118 cpu_buffer = iter->cpu_buffer;
3119
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003120 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt642edba2008-11-12 00:01:26 -05003121 rb_iter_reset(iter);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003122 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003123}
Robert Richterc4f50182008-12-11 16:49:22 +01003124EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003125
3126/**
3127 * ring_buffer_iter_empty - check if an iterator has no more to read
3128 * @iter: The iterator to check
3129 */
3130int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
3131{
3132 struct ring_buffer_per_cpu *cpu_buffer;
3133
3134 cpu_buffer = iter->cpu_buffer;
3135
Steven Rostedtbf41a152008-10-04 02:00:59 -04003136 return iter->head_page == cpu_buffer->commit_page &&
3137 iter->head == rb_commit_index(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003138}
Robert Richterc4f50182008-12-11 16:49:22 +01003139EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003140
3141static void
3142rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
3143 struct ring_buffer_event *event)
3144{
3145 u64 delta;
3146
Lai Jiangshan334d4162009-04-24 11:27:05 +08003147 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003148 case RINGBUF_TYPE_PADDING:
3149 return;
3150
3151 case RINGBUF_TYPE_TIME_EXTEND:
3152 delta = event->array[0];
3153 delta <<= TS_SHIFT;
3154 delta += event->time_delta;
3155 cpu_buffer->read_stamp += delta;
3156 return;
3157
3158 case RINGBUF_TYPE_TIME_STAMP:
3159 /* FIXME: not implemented */
3160 return;
3161
3162 case RINGBUF_TYPE_DATA:
3163 cpu_buffer->read_stamp += event->time_delta;
3164 return;
3165
3166 default:
3167 BUG();
3168 }
3169 return;
3170}
3171
3172static void
3173rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
3174 struct ring_buffer_event *event)
3175{
3176 u64 delta;
3177
Lai Jiangshan334d4162009-04-24 11:27:05 +08003178 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003179 case RINGBUF_TYPE_PADDING:
3180 return;
3181
3182 case RINGBUF_TYPE_TIME_EXTEND:
3183 delta = event->array[0];
3184 delta <<= TS_SHIFT;
3185 delta += event->time_delta;
3186 iter->read_stamp += delta;
3187 return;
3188
3189 case RINGBUF_TYPE_TIME_STAMP:
3190 /* FIXME: not implemented */
3191 return;
3192
3193 case RINGBUF_TYPE_DATA:
3194 iter->read_stamp += event->time_delta;
3195 return;
3196
3197 default:
3198 BUG();
3199 }
3200 return;
3201}
3202
Steven Rostedtd7690412008-10-01 00:29:53 -04003203static struct buffer_page *
3204rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003205{
Steven Rostedtd7690412008-10-01 00:29:53 -04003206 struct buffer_page *reader = NULL;
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003207 unsigned long overwrite;
Steven Rostedtd7690412008-10-01 00:29:53 -04003208 unsigned long flags;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003209 int nr_loops = 0;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003210 int ret;
Steven Rostedtd7690412008-10-01 00:29:53 -04003211
Steven Rostedt3e03fb72008-11-06 00:09:43 -05003212 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003213 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedtd7690412008-10-01 00:29:53 -04003214
3215 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003216 /*
3217 * This should normally only loop twice. But because the
3218 * start of the reader inserts an empty page, it causes
3219 * a case where we will loop three times. There should be no
3220 * reason to loop four times (that I know of).
3221 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003222 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003223 reader = NULL;
3224 goto out;
3225 }
3226
Steven Rostedtd7690412008-10-01 00:29:53 -04003227 reader = cpu_buffer->reader_page;
3228
3229 /* If there's more to read, return this page */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003230 if (cpu_buffer->reader_page->read < rb_page_size(reader))
Steven Rostedtd7690412008-10-01 00:29:53 -04003231 goto out;
3232
3233 /* Never should we have an index greater than the size */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003234 if (RB_WARN_ON(cpu_buffer,
3235 cpu_buffer->reader_page->read > rb_page_size(reader)))
3236 goto out;
Steven Rostedtd7690412008-10-01 00:29:53 -04003237
3238 /* check if we caught up to the tail */
3239 reader = NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003240 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
Steven Rostedtd7690412008-10-01 00:29:53 -04003241 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003242
3243 /*
Steven Rostedtd7690412008-10-01 00:29:53 -04003244 * Reset the reader page to size zero.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003245 */
Steven Rostedt77ae3652009-03-27 11:00:29 -04003246 local_set(&cpu_buffer->reader_page->write, 0);
3247 local_set(&cpu_buffer->reader_page->entries, 0);
3248 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedtff0ff842010-03-31 22:11:42 -04003249 cpu_buffer->reader_page->real_end = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003250
Steven Rostedt77ae3652009-03-27 11:00:29 -04003251 spin:
3252 /*
3253 * Splice the empty reader page into the list around the head.
3254 */
3255 reader = rb_set_head_page(cpu_buffer);
Steven Rostedt0e1ff5d2010-01-06 20:40:44 -05003256 cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
Steven Rostedtd7690412008-10-01 00:29:53 -04003257 cpu_buffer->reader_page->list.prev = reader->list.prev;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003258
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003259 /*
3260 * cpu_buffer->pages just needs to point to the buffer, it
3261 * has no specific buffer page to point to. Lets move it out
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003262 * of our way so we don't accidentally swap it.
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003263 */
3264 cpu_buffer->pages = reader->list.prev;
3265
Steven Rostedt77ae3652009-03-27 11:00:29 -04003266 /* The reader page will be pointing to the new head */
3267 rb_set_list_to_head(cpu_buffer, &cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -04003268
3269 /*
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003270 * We want to make sure we read the overruns after we set up our
3271 * pointers to the next object. The writer side does a
3272 * cmpxchg to cross pages which acts as the mb on the writer
3273 * side. Note, the reader will constantly fail the swap
3274 * while the writer is updating the pointers, so this
3275 * guarantees that the overwrite recorded here is the one we
3276 * want to compare with the last_overrun.
3277 */
3278 smp_mb();
3279 overwrite = local_read(&(cpu_buffer->overrun));
3280
3281 /*
Steven Rostedt77ae3652009-03-27 11:00:29 -04003282 * Here's the tricky part.
3283 *
3284 * We need to move the pointer past the header page.
3285 * But we can only do that if a writer is not currently
3286 * moving it. The page before the header page has the
3287 * flag bit '1' set if it is pointing to the page we want.
3288 * but if the writer is in the process of moving it
3289 * than it will be '2' or already moved '0'.
Steven Rostedtd7690412008-10-01 00:29:53 -04003290 */
Steven Rostedtd7690412008-10-01 00:29:53 -04003291
Steven Rostedt77ae3652009-03-27 11:00:29 -04003292 ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
3293
3294 /*
3295 * If we did not convert it, then we must try again.
3296 */
3297 if (!ret)
3298 goto spin;
3299
3300 /*
3301 * Yeah! We succeeded in replacing the page.
3302 *
3303 * Now make the new head point back to the reader page.
3304 */
David Sharp5ded3dc62010-01-06 17:12:07 -08003305 rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003306 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
Steven Rostedtd7690412008-10-01 00:29:53 -04003307
3308 /* Finally update the reader page to the new head */
3309 cpu_buffer->reader_page = reader;
3310 rb_reset_reader_page(cpu_buffer);
3311
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003312 if (overwrite != cpu_buffer->last_overrun) {
3313 cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
3314 cpu_buffer->last_overrun = overwrite;
3315 }
3316
Steven Rostedtd7690412008-10-01 00:29:53 -04003317 goto again;
3318
3319 out:
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003320 arch_spin_unlock(&cpu_buffer->lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05003321 local_irq_restore(flags);
Steven Rostedtd7690412008-10-01 00:29:53 -04003322
3323 return reader;
3324}
3325
3326static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
3327{
3328 struct ring_buffer_event *event;
3329 struct buffer_page *reader;
3330 unsigned length;
3331
3332 reader = rb_get_reader_page(cpu_buffer);
3333
3334 /* This function should not be called when buffer is empty */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003335 if (RB_WARN_ON(cpu_buffer, !reader))
3336 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04003337
3338 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003339
Steven Rostedta1863c22009-09-03 10:23:58 -04003340 if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Steven Rostedte4906ef2009-04-30 20:49:44 -04003341 cpu_buffer->read++;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003342
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003343 rb_update_read_stamp(cpu_buffer, event);
3344
Steven Rostedtd7690412008-10-01 00:29:53 -04003345 length = rb_event_length(event);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003346 cpu_buffer->reader_page->read += length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003347}
3348
3349static void rb_advance_iter(struct ring_buffer_iter *iter)
3350{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003351 struct ring_buffer_per_cpu *cpu_buffer;
3352 struct ring_buffer_event *event;
3353 unsigned length;
3354
3355 cpu_buffer = iter->cpu_buffer;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003356
3357 /*
3358 * Check if we are at the end of the buffer.
3359 */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003360 if (iter->head >= rb_page_size(iter->head_page)) {
Steven Rostedtea05b572009-06-03 09:30:10 -04003361 /* discarded commits can make the page empty */
3362 if (iter->head_page == cpu_buffer->commit_page)
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003363 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04003364 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003365 return;
3366 }
3367
3368 event = rb_iter_head_event(iter);
3369
3370 length = rb_event_length(event);
3371
3372 /*
3373 * This should not be called to advance the header if we are
3374 * at the tail of the buffer.
3375 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003376 if (RB_WARN_ON(cpu_buffer,
Steven Rostedtf536aaf2008-11-10 23:07:30 -05003377 (iter->head_page == cpu_buffer->commit_page) &&
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05003378 (iter->head + length > rb_commit_index(cpu_buffer))))
3379 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003380
3381 rb_update_iter_read_stamp(iter, event);
3382
3383 iter->head += length;
3384
3385 /* check for end of page padding */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003386 if ((iter->head >= rb_page_size(iter->head_page)) &&
3387 (iter->head_page != cpu_buffer->commit_page))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003388 rb_advance_iter(iter);
3389}
3390
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003391static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
3392{
3393 return cpu_buffer->lost_events;
3394}
3395
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003396static struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003397rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
3398 unsigned long *lost_events)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003399{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003400 struct ring_buffer_event *event;
Steven Rostedtd7690412008-10-01 00:29:53 -04003401 struct buffer_page *reader;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003402 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003403
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003404 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003405 /*
Steven Rostedt69d1b832010-10-07 18:18:05 -04003406 * We repeat when a time extend is encountered.
3407 * Since the time extend is always attached to a data event,
3408 * we should never loop more than once.
3409 * (We never hit the following condition more than twice).
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003410 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04003411 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003412 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003413
Steven Rostedtd7690412008-10-01 00:29:53 -04003414 reader = rb_get_reader_page(cpu_buffer);
3415 if (!reader)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003416 return NULL;
3417
Steven Rostedtd7690412008-10-01 00:29:53 -04003418 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003419
Lai Jiangshan334d4162009-04-24 11:27:05 +08003420 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003421 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05003422 if (rb_null_event(event))
3423 RB_WARN_ON(cpu_buffer, 1);
3424 /*
3425 * Because the writer could be discarding every
3426 * event it creates (which would probably be bad)
3427 * if we were to go back to "again" then we may never
3428 * catch up, and will trigger the warn on, or lock
3429 * the box. Return the padding, and we will release
3430 * the current locks, and try again.
3431 */
Tom Zanussi2d622712009-03-22 03:30:49 -05003432 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003433
3434 case RINGBUF_TYPE_TIME_EXTEND:
3435 /* Internal data, OK to advance */
Steven Rostedtd7690412008-10-01 00:29:53 -04003436 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003437 goto again;
3438
3439 case RINGBUF_TYPE_TIME_STAMP:
3440 /* FIXME: not implemented */
Steven Rostedtd7690412008-10-01 00:29:53 -04003441 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003442 goto again;
3443
3444 case RINGBUF_TYPE_DATA:
3445 if (ts) {
3446 *ts = cpu_buffer->read_stamp + event->time_delta;
Robert Richterd8eeb2d2009-07-31 14:58:04 +02003447 ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
Steven Rostedt37886f62009-03-17 17:22:06 -04003448 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003449 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003450 if (lost_events)
3451 *lost_events = rb_lost_events(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003452 return event;
3453
3454 default:
3455 BUG();
3456 }
3457
3458 return NULL;
3459}
Robert Richterc4f50182008-12-11 16:49:22 +01003460EXPORT_SYMBOL_GPL(ring_buffer_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003461
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003462static struct ring_buffer_event *
3463rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003464{
3465 struct ring_buffer *buffer;
3466 struct ring_buffer_per_cpu *cpu_buffer;
3467 struct ring_buffer_event *event;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003468 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003469
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003470 cpu_buffer = iter->cpu_buffer;
3471 buffer = cpu_buffer->buffer;
3472
Steven Rostedt492a74f2010-01-25 15:17:47 -05003473 /*
3474 * Check if someone performed a consuming read to
3475 * the buffer. A consuming read invalidates the iterator
3476 * and we need to reset the iterator in this case.
3477 */
3478 if (unlikely(iter->cache_read != cpu_buffer->read ||
3479 iter->cache_reader_page != cpu_buffer->reader_page))
3480 rb_iter_reset(iter);
3481
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003482 again:
Steven Rostedt3c05d742010-01-26 16:14:08 -05003483 if (ring_buffer_iter_empty(iter))
3484 return NULL;
3485
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003486 /*
Steven Rostedt69d1b832010-10-07 18:18:05 -04003487 * We repeat when a time extend is encountered.
3488 * Since the time extend is always attached to a data event,
3489 * we should never loop more than once.
3490 * (We never hit the following condition more than twice).
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003491 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04003492 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003493 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003494
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003495 if (rb_per_cpu_empty(cpu_buffer))
3496 return NULL;
3497
Steven Rostedt3c05d742010-01-26 16:14:08 -05003498 if (iter->head >= local_read(&iter->head_page->page->commit)) {
3499 rb_inc_iter(iter);
3500 goto again;
3501 }
3502
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003503 event = rb_iter_head_event(iter);
3504
Lai Jiangshan334d4162009-04-24 11:27:05 +08003505 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003506 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05003507 if (rb_null_event(event)) {
3508 rb_inc_iter(iter);
3509 goto again;
3510 }
3511 rb_advance_iter(iter);
3512 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003513
3514 case RINGBUF_TYPE_TIME_EXTEND:
3515 /* Internal data, OK to advance */
3516 rb_advance_iter(iter);
3517 goto again;
3518
3519 case RINGBUF_TYPE_TIME_STAMP:
3520 /* FIXME: not implemented */
3521 rb_advance_iter(iter);
3522 goto again;
3523
3524 case RINGBUF_TYPE_DATA:
3525 if (ts) {
3526 *ts = iter->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04003527 ring_buffer_normalize_time_stamp(buffer,
3528 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003529 }
3530 return event;
3531
3532 default:
3533 BUG();
3534 }
3535
3536 return NULL;
3537}
Robert Richterc4f50182008-12-11 16:49:22 +01003538EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003539
Steven Rostedt8d707e82009-06-16 21:22:48 -04003540static inline int rb_ok_to_lock(void)
3541{
3542 /*
3543 * If an NMI die dumps out the content of the ring buffer
3544 * do not grab locks. We also permanently disable the ring
3545 * buffer too. A one time deal is all you get from reading
3546 * the ring buffer from an NMI.
3547 */
Steven Rostedt464e85e2009-08-05 15:26:37 -04003548 if (likely(!in_nmi()))
Steven Rostedt8d707e82009-06-16 21:22:48 -04003549 return 1;
3550
3551 tracing_off_permanent();
3552 return 0;
3553}
3554
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003555/**
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003556 * ring_buffer_peek - peek at the next event to be read
3557 * @buffer: The ring buffer to read
3558 * @cpu: The cpu to peak at
3559 * @ts: The timestamp counter of this event.
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003560 * @lost_events: a variable to store if events were lost (may be NULL)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003561 *
3562 * This will return the event that will be read next, but does
3563 * not consume the data.
3564 */
3565struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003566ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts,
3567 unsigned long *lost_events)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003568{
3569 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8aabee52009-03-12 13:13:49 -04003570 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003571 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003572 int dolock;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003573
Steven Rostedt554f7862009-03-11 22:00:13 -04003574 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003575 return NULL;
Steven Rostedt554f7862009-03-11 22:00:13 -04003576
Steven Rostedt8d707e82009-06-16 21:22:48 -04003577 dolock = rb_ok_to_lock();
Tom Zanussi2d622712009-03-22 03:30:49 -05003578 again:
Steven Rostedt8d707e82009-06-16 21:22:48 -04003579 local_irq_save(flags);
3580 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003581 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003582 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
Robert Richter469535a2009-07-30 19:19:18 +02003583 if (event && event->type_len == RINGBUF_TYPE_PADDING)
3584 rb_advance_reader(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003585 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003586 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003587 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003588
Steven Rostedt1b959e12009-09-03 10:12:13 -04003589 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003590 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003591
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003592 return event;
3593}
3594
3595/**
3596 * ring_buffer_iter_peek - peek at the next event to be read
3597 * @iter: The ring buffer iterator
3598 * @ts: The timestamp counter of this event.
3599 *
3600 * This will return the event that will be read next, but does
3601 * not increment the iterator.
3602 */
3603struct ring_buffer_event *
3604ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
3605{
3606 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3607 struct ring_buffer_event *event;
3608 unsigned long flags;
3609
Tom Zanussi2d622712009-03-22 03:30:49 -05003610 again:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003611 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003612 event = rb_iter_peek(iter, ts);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003613 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003614
Steven Rostedt1b959e12009-09-03 10:12:13 -04003615 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003616 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003617
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003618 return event;
3619}
3620
3621/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003622 * ring_buffer_consume - return an event and consume it
3623 * @buffer: The ring buffer to get the next event from
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003624 * @cpu: the cpu to read the buffer from
3625 * @ts: a variable to store the timestamp (may be NULL)
3626 * @lost_events: a variable to store if events were lost (may be NULL)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003627 *
3628 * Returns the next event in the ring buffer, and that event is consumed.
3629 * Meaning, that sequential reads will keep returning a different event,
3630 * and eventually empty the ring buffer if the producer is slower.
3631 */
3632struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003633ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts,
3634 unsigned long *lost_events)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003635{
Steven Rostedt554f7862009-03-11 22:00:13 -04003636 struct ring_buffer_per_cpu *cpu_buffer;
3637 struct ring_buffer_event *event = NULL;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003638 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003639 int dolock;
3640
3641 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003642
Tom Zanussi2d622712009-03-22 03:30:49 -05003643 again:
Steven Rostedt554f7862009-03-11 22:00:13 -04003644 /* might be called in atomic */
3645 preempt_disable();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003646
Steven Rostedt554f7862009-03-11 22:00:13 -04003647 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3648 goto out;
3649
3650 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003651 local_irq_save(flags);
3652 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003653 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003654
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003655 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
3656 if (event) {
3657 cpu_buffer->lost_events = 0;
Robert Richter469535a2009-07-30 19:19:18 +02003658 rb_advance_reader(cpu_buffer);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003659 }
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003660
Steven Rostedt8d707e82009-06-16 21:22:48 -04003661 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003662 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003663 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003664
Steven Rostedt554f7862009-03-11 22:00:13 -04003665 out:
3666 preempt_enable();
3667
Steven Rostedt1b959e12009-09-03 10:12:13 -04003668 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003669 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003670
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003671 return event;
3672}
Robert Richterc4f50182008-12-11 16:49:22 +01003673EXPORT_SYMBOL_GPL(ring_buffer_consume);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003674
3675/**
David Miller72c9ddf2010-04-20 15:47:11 -07003676 * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003677 * @buffer: The ring buffer to read from
3678 * @cpu: The cpu buffer to iterate over
3679 *
David Miller72c9ddf2010-04-20 15:47:11 -07003680 * This performs the initial preparations necessary to iterate
3681 * through the buffer. Memory is allocated, buffer recording
3682 * is disabled, and the iterator pointer is returned to the caller.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003683 *
David Miller72c9ddf2010-04-20 15:47:11 -07003684 * Disabling buffer recordng prevents the reading from being
3685 * corrupted. This is not a consuming read, so a producer is not
3686 * expected.
3687 *
3688 * After a sequence of ring_buffer_read_prepare calls, the user is
3689 * expected to make at least one call to ring_buffer_prepare_sync.
3690 * Afterwards, ring_buffer_read_start is invoked to get things going
3691 * for real.
3692 *
3693 * This overall must be paired with ring_buffer_finish.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003694 */
3695struct ring_buffer_iter *
David Miller72c9ddf2010-04-20 15:47:11 -07003696ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003697{
3698 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003699 struct ring_buffer_iter *iter;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003700
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303701 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003702 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003703
3704 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
3705 if (!iter)
Steven Rostedt8aabee52009-03-12 13:13:49 -04003706 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003707
3708 cpu_buffer = buffer->buffers[cpu];
3709
3710 iter->cpu_buffer = cpu_buffer;
3711
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003712 atomic_inc(&buffer->resize_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003713 atomic_inc(&cpu_buffer->record_disabled);
David Miller72c9ddf2010-04-20 15:47:11 -07003714
3715 return iter;
3716}
3717EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);
3718
3719/**
3720 * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
3721 *
3722 * All previously invoked ring_buffer_read_prepare calls to prepare
3723 * iterators will be synchronized. Afterwards, read_buffer_read_start
3724 * calls on those iterators are allowed.
3725 */
3726void
3727ring_buffer_read_prepare_sync(void)
3728{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003729 synchronize_sched();
David Miller72c9ddf2010-04-20 15:47:11 -07003730}
3731EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
3732
3733/**
3734 * ring_buffer_read_start - start a non consuming read of the buffer
3735 * @iter: The iterator returned by ring_buffer_read_prepare
3736 *
3737 * This finalizes the startup of an iteration through the buffer.
3738 * The iterator comes from a call to ring_buffer_read_prepare and
3739 * an intervening ring_buffer_read_prepare_sync must have been
3740 * performed.
3741 *
3742 * Must be paired with ring_buffer_finish.
3743 */
3744void
3745ring_buffer_read_start(struct ring_buffer_iter *iter)
3746{
3747 struct ring_buffer_per_cpu *cpu_buffer;
3748 unsigned long flags;
3749
3750 if (!iter)
3751 return;
3752
3753 cpu_buffer = iter->cpu_buffer;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003754
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003755 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003756 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedt642edba2008-11-12 00:01:26 -05003757 rb_iter_reset(iter);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003758 arch_spin_unlock(&cpu_buffer->lock);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003759 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003760}
Robert Richterc4f50182008-12-11 16:49:22 +01003761EXPORT_SYMBOL_GPL(ring_buffer_read_start);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003762
3763/**
3764 * ring_buffer_finish - finish reading the iterator of the buffer
3765 * @iter: The iterator retrieved by ring_buffer_start
3766 *
3767 * This re-enables the recording to the buffer, and frees the
3768 * iterator.
3769 */
3770void
3771ring_buffer_read_finish(struct ring_buffer_iter *iter)
3772{
3773 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3774
Steven Rostedt659f4512012-05-14 17:02:33 -04003775 /*
3776 * Ring buffer is disabled from recording, here's a good place
3777 * to check the integrity of the ring buffer.
3778 */
3779 rb_check_pages(cpu_buffer);
3780
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003781 atomic_dec(&cpu_buffer->record_disabled);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003782 atomic_dec(&cpu_buffer->buffer->resize_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003783 kfree(iter);
3784}
Robert Richterc4f50182008-12-11 16:49:22 +01003785EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003786
3787/**
3788 * ring_buffer_read - read the next item in the ring buffer by the iterator
3789 * @iter: The ring buffer iterator
3790 * @ts: The time stamp of the event read.
3791 *
3792 * This reads the next event in the ring buffer and increments the iterator.
3793 */
3794struct ring_buffer_event *
3795ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
3796{
3797 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003798 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3799 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003800
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003801 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt7e9391c2009-09-03 10:02:09 -04003802 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003803 event = rb_iter_peek(iter, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003804 if (!event)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003805 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003806
Steven Rostedt7e9391c2009-09-03 10:02:09 -04003807 if (event->type_len == RINGBUF_TYPE_PADDING)
3808 goto again;
3809
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003810 rb_advance_iter(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003811 out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003812 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003813
3814 return event;
3815}
Robert Richterc4f50182008-12-11 16:49:22 +01003816EXPORT_SYMBOL_GPL(ring_buffer_read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003817
3818/**
3819 * ring_buffer_size - return the size of the ring buffer (in bytes)
3820 * @buffer: The ring buffer.
3821 */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08003822unsigned long ring_buffer_size(struct ring_buffer *buffer, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003823{
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08003824 /*
3825 * Earlier, this method returned
3826 * BUF_PAGE_SIZE * buffer->nr_pages
3827 * Since the nr_pages field is now removed, we have converted this to
3828 * return the per cpu buffer value.
3829 */
3830 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3831 return 0;
3832
3833 return BUF_PAGE_SIZE * buffer->buffers[cpu]->nr_pages;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003834}
Robert Richterc4f50182008-12-11 16:49:22 +01003835EXPORT_SYMBOL_GPL(ring_buffer_size);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003836
3837static void
3838rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
3839{
Steven Rostedt77ae3652009-03-27 11:00:29 -04003840 rb_head_page_deactivate(cpu_buffer);
3841
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003842 cpu_buffer->head_page
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003843 = list_entry(cpu_buffer->pages, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04003844 local_set(&cpu_buffer->head_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003845 local_set(&cpu_buffer->head_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05003846 local_set(&cpu_buffer->head_page->page->commit, 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003847
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003848 cpu_buffer->head_page->read = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003849
3850 cpu_buffer->tail_page = cpu_buffer->head_page;
3851 cpu_buffer->commit_page = cpu_buffer->head_page;
3852
3853 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07003854 INIT_LIST_HEAD(&cpu_buffer->new_pages);
Steven Rostedtbf41a152008-10-04 02:00:59 -04003855 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003856 local_set(&cpu_buffer->reader_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05003857 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003858 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04003859
Steven Rostedt77ae3652009-03-27 11:00:29 -04003860 local_set(&cpu_buffer->commit_overrun, 0);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07003861 local_set(&cpu_buffer->entries_bytes, 0);
Steven Rostedt77ae3652009-03-27 11:00:29 -04003862 local_set(&cpu_buffer->overrun, 0);
Steven Rostedte4906ef2009-04-30 20:49:44 -04003863 local_set(&cpu_buffer->entries, 0);
Steven Rostedtfa743952009-06-16 12:37:57 -04003864 local_set(&cpu_buffer->committing, 0);
3865 local_set(&cpu_buffer->commits, 0);
Steven Rostedt77ae3652009-03-27 11:00:29 -04003866 cpu_buffer->read = 0;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07003867 cpu_buffer->read_bytes = 0;
Steven Rostedt69507c02009-01-21 18:45:57 -05003868
3869 cpu_buffer->write_stamp = 0;
3870 cpu_buffer->read_stamp = 0;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003871
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003872 cpu_buffer->lost_events = 0;
3873 cpu_buffer->last_overrun = 0;
3874
Steven Rostedt77ae3652009-03-27 11:00:29 -04003875 rb_head_page_activate(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003876}
3877
3878/**
3879 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
3880 * @buffer: The ring buffer to reset a per cpu buffer of
3881 * @cpu: The CPU buffer to be reset
3882 */
3883void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
3884{
3885 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
3886 unsigned long flags;
3887
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303888 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003889 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003890
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003891 atomic_inc(&buffer->resize_disabled);
Steven Rostedt41ede232009-05-01 20:26:54 -04003892 atomic_inc(&cpu_buffer->record_disabled);
3893
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003894 /* Make sure all commits have finished */
3895 synchronize_sched();
3896
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003897 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003898
Steven Rostedt41b6a952009-09-02 09:59:48 -04003899 if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
3900 goto out;
3901
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003902 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003903
3904 rb_reset_cpu(cpu_buffer);
3905
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003906 arch_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003907
Steven Rostedt41b6a952009-09-02 09:59:48 -04003908 out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003909 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt41ede232009-05-01 20:26:54 -04003910
3911 atomic_dec(&cpu_buffer->record_disabled);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003912 atomic_dec(&buffer->resize_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003913}
Robert Richterc4f50182008-12-11 16:49:22 +01003914EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003915
3916/**
3917 * ring_buffer_reset - reset a ring buffer
3918 * @buffer: The ring buffer to reset all cpu buffers
3919 */
3920void ring_buffer_reset(struct ring_buffer *buffer)
3921{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003922 int cpu;
3923
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003924 for_each_buffer_cpu(buffer, cpu)
Steven Rostedtd7690412008-10-01 00:29:53 -04003925 ring_buffer_reset_cpu(buffer, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003926}
Robert Richterc4f50182008-12-11 16:49:22 +01003927EXPORT_SYMBOL_GPL(ring_buffer_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003928
3929/**
3930 * rind_buffer_empty - is the ring buffer empty?
3931 * @buffer: The ring buffer to test
3932 */
3933int ring_buffer_empty(struct ring_buffer *buffer)
3934{
3935 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04003936 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003937 int dolock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003938 int cpu;
Steven Rostedtd4788202009-06-17 00:39:43 -04003939 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003940
Steven Rostedt8d707e82009-06-16 21:22:48 -04003941 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003942
3943 /* yes this is racy, but if you don't like the race, lock the buffer */
3944 for_each_buffer_cpu(buffer, cpu) {
3945 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003946 local_irq_save(flags);
3947 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003948 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedtd4788202009-06-17 00:39:43 -04003949 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003950 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003951 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003952 local_irq_restore(flags);
3953
Steven Rostedtd4788202009-06-17 00:39:43 -04003954 if (!ret)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003955 return 0;
3956 }
Steven Rostedt554f7862009-03-11 22:00:13 -04003957
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003958 return 1;
3959}
Robert Richterc4f50182008-12-11 16:49:22 +01003960EXPORT_SYMBOL_GPL(ring_buffer_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003961
3962/**
3963 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
3964 * @buffer: The ring buffer
3965 * @cpu: The CPU buffer to test
3966 */
3967int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
3968{
3969 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04003970 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003971 int dolock;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003972 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003973
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303974 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003975 return 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003976
Steven Rostedt8d707e82009-06-16 21:22:48 -04003977 dolock = rb_ok_to_lock();
Steven Rostedt554f7862009-03-11 22:00:13 -04003978
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003979 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003980 local_irq_save(flags);
3981 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003982 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt554f7862009-03-11 22:00:13 -04003983 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003984 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003985 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003986 local_irq_restore(flags);
Steven Rostedt554f7862009-03-11 22:00:13 -04003987
3988 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003989}
Robert Richterc4f50182008-12-11 16:49:22 +01003990EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003991
Steven Rostedt85bac322009-09-04 14:24:40 -04003992#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003993/**
3994 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
3995 * @buffer_a: One buffer to swap with
3996 * @buffer_b: The other buffer to swap with
3997 *
3998 * This function is useful for tracers that want to take a "snapshot"
3999 * of a CPU buffer and has another back up buffer lying around.
4000 * it is expected that the tracer handles the cpu buffer not being
4001 * used at the moment.
4002 */
4003int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
4004 struct ring_buffer *buffer_b, int cpu)
4005{
4006 struct ring_buffer_per_cpu *cpu_buffer_a;
4007 struct ring_buffer_per_cpu *cpu_buffer_b;
Steven Rostedt554f7862009-03-11 22:00:13 -04004008 int ret = -EINVAL;
4009
Rusty Russell9e01c1b2009-01-01 10:12:22 +10304010 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
4011 !cpumask_test_cpu(cpu, buffer_b->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04004012 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004013
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004014 cpu_buffer_a = buffer_a->buffers[cpu];
4015 cpu_buffer_b = buffer_b->buffers[cpu];
4016
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004017 /* At least make sure the two buffers are somewhat the same */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004018 if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages)
Steven Rostedt554f7862009-03-11 22:00:13 -04004019 goto out;
4020
4021 ret = -EAGAIN;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004022
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004023 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedt554f7862009-03-11 22:00:13 -04004024 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004025
4026 if (atomic_read(&buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004027 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004028
4029 if (atomic_read(&buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004030 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004031
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004032 if (atomic_read(&cpu_buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004033 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004034
4035 if (atomic_read(&cpu_buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004036 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004037
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004038 /*
4039 * We can't do a synchronize_sched here because this
4040 * function can be called in atomic context.
4041 * Normally this will be called from the same CPU as cpu.
4042 * If not it's up to the caller to protect this.
4043 */
4044 atomic_inc(&cpu_buffer_a->record_disabled);
4045 atomic_inc(&cpu_buffer_b->record_disabled);
4046
Steven Rostedt98277992009-09-02 10:56:15 -04004047 ret = -EBUSY;
4048 if (local_read(&cpu_buffer_a->committing))
4049 goto out_dec;
4050 if (local_read(&cpu_buffer_b->committing))
4051 goto out_dec;
4052
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004053 buffer_a->buffers[cpu] = cpu_buffer_b;
4054 buffer_b->buffers[cpu] = cpu_buffer_a;
4055
4056 cpu_buffer_b->buffer = buffer_a;
4057 cpu_buffer_a->buffer = buffer_b;
4058
Steven Rostedt98277992009-09-02 10:56:15 -04004059 ret = 0;
4060
4061out_dec:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004062 atomic_dec(&cpu_buffer_a->record_disabled);
4063 atomic_dec(&cpu_buffer_b->record_disabled);
Steven Rostedt554f7862009-03-11 22:00:13 -04004064out:
Steven Rostedt554f7862009-03-11 22:00:13 -04004065 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004066}
Robert Richterc4f50182008-12-11 16:49:22 +01004067EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
Steven Rostedt85bac322009-09-04 14:24:40 -04004068#endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004069
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004070/**
4071 * ring_buffer_alloc_read_page - allocate a page to read from buffer
4072 * @buffer: the buffer to allocate for.
4073 *
4074 * This function is used in conjunction with ring_buffer_read_page.
4075 * When reading a full page from the ring buffer, these functions
4076 * can be used to speed up the process. The calling function should
4077 * allocate a few pages first with this function. Then when it
4078 * needs to get pages from the ring buffer, it passes the result
4079 * of this function into ring_buffer_read_page, which will swap
4080 * the page that was allocated, with the read page of the buffer.
4081 *
4082 * Returns:
4083 * The page allocated, or NULL on error.
4084 */
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004085void *ring_buffer_alloc_read_page(struct ring_buffer *buffer, int cpu)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004086{
Steven Rostedt044fa782008-12-02 23:50:03 -05004087 struct buffer_data_page *bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004088 struct page *page;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004089
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07004090 page = alloc_pages_node(cpu_to_node(cpu),
4091 GFP_KERNEL | __GFP_NORETRY, 0);
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004092 if (!page)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004093 return NULL;
4094
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004095 bpage = page_address(page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004096
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004097 rb_init_page(bpage);
4098
Steven Rostedt044fa782008-12-02 23:50:03 -05004099 return bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004100}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004101EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004102
4103/**
4104 * ring_buffer_free_read_page - free an allocated read page
4105 * @buffer: the buffer the page was allocate for
4106 * @data: the page to free
4107 *
4108 * Free a page allocated from ring_buffer_alloc_read_page.
4109 */
4110void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
4111{
4112 free_page((unsigned long)data);
4113}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004114EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004115
4116/**
4117 * ring_buffer_read_page - extract a page from the ring buffer
4118 * @buffer: buffer to extract from
4119 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004120 * @len: amount to extract
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004121 * @cpu: the cpu of the buffer to extract
4122 * @full: should the extraction only happen when the page is full.
4123 *
4124 * This function will pull out a page from the ring buffer and consume it.
4125 * @data_page must be the address of the variable that was returned
4126 * from ring_buffer_alloc_read_page. This is because the page might be used
4127 * to swap with a page in the ring buffer.
4128 *
4129 * for example:
Lai Jiangshanb85fa012009-02-09 14:21:14 +08004130 * rpage = ring_buffer_alloc_read_page(buffer);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004131 * if (!rpage)
4132 * return error;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004133 * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004134 * if (ret >= 0)
4135 * process_page(rpage, ret);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004136 *
4137 * When @full is set, the function will not return true unless
4138 * the writer is off the reader page.
4139 *
4140 * Note: it is up to the calling functions to handle sleeps and wakeups.
4141 * The ring buffer can be used anywhere in the kernel and can not
4142 * blindly call wake_up. The layer that uses the ring buffer must be
4143 * responsible for that.
4144 *
4145 * Returns:
Lai Jiangshan667d2412009-02-09 14:21:17 +08004146 * >=0 if data has been transferred, returns the offset of consumed data.
4147 * <0 if no data has been transferred.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004148 */
4149int ring_buffer_read_page(struct ring_buffer *buffer,
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004150 void **data_page, size_t len, int cpu, int full)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004151{
4152 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
4153 struct ring_buffer_event *event;
Steven Rostedt044fa782008-12-02 23:50:03 -05004154 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004155 struct buffer_page *reader;
Steven Rostedtff0ff842010-03-31 22:11:42 -04004156 unsigned long missed_events;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004157 unsigned long flags;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004158 unsigned int commit;
Lai Jiangshan667d2412009-02-09 14:21:17 +08004159 unsigned int read;
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004160 u64 save_timestamp;
Lai Jiangshan667d2412009-02-09 14:21:17 +08004161 int ret = -1;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004162
Steven Rostedt554f7862009-03-11 22:00:13 -04004163 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4164 goto out;
4165
Steven Rostedt474d32b2009-03-03 19:51:40 -05004166 /*
4167 * If len is not big enough to hold the page header, then
4168 * we can not copy anything.
4169 */
4170 if (len <= BUF_PAGE_HDR_SIZE)
Steven Rostedt554f7862009-03-11 22:00:13 -04004171 goto out;
Steven Rostedt474d32b2009-03-03 19:51:40 -05004172
4173 len -= BUF_PAGE_HDR_SIZE;
4174
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004175 if (!data_page)
Steven Rostedt554f7862009-03-11 22:00:13 -04004176 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004177
Steven Rostedt044fa782008-12-02 23:50:03 -05004178 bpage = *data_page;
4179 if (!bpage)
Steven Rostedt554f7862009-03-11 22:00:13 -04004180 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004181
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02004182 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004183
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004184 reader = rb_get_reader_page(cpu_buffer);
4185 if (!reader)
Steven Rostedt554f7862009-03-11 22:00:13 -04004186 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004187
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004188 event = rb_reader_event(cpu_buffer);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004189
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004190 read = reader->read;
4191 commit = rb_page_commit(reader);
4192
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004193 /* Check if any events were dropped */
Steven Rostedtff0ff842010-03-31 22:11:42 -04004194 missed_events = cpu_buffer->lost_events;
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004195
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004196 /*
Steven Rostedt474d32b2009-03-03 19:51:40 -05004197 * If this page has been partially read or
4198 * if len is not big enough to read the rest of the page or
4199 * a writer is still on the page, then
4200 * we must copy the data from the page to the buffer.
4201 * Otherwise, we can simply swap the page with the one passed in.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004202 */
Steven Rostedt474d32b2009-03-03 19:51:40 -05004203 if (read || (len < (commit - read)) ||
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004204 cpu_buffer->reader_page == cpu_buffer->commit_page) {
Lai Jiangshan667d2412009-02-09 14:21:17 +08004205 struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
Steven Rostedt474d32b2009-03-03 19:51:40 -05004206 unsigned int rpos = read;
4207 unsigned int pos = 0;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004208 unsigned int size;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004209
4210 if (full)
Steven Rostedt554f7862009-03-11 22:00:13 -04004211 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004212
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004213 if (len > (commit - read))
4214 len = (commit - read);
4215
Steven Rostedt69d1b832010-10-07 18:18:05 -04004216 /* Always keep the time extend and data together */
4217 size = rb_event_ts_length(event);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004218
4219 if (len < size)
Steven Rostedt554f7862009-03-11 22:00:13 -04004220 goto out_unlock;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004221
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004222 /* save the current timestamp, since the user will need it */
4223 save_timestamp = cpu_buffer->read_stamp;
4224
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004225 /* Need to copy one event at a time */
4226 do {
David Sharpe1e35922010-12-22 16:38:24 -08004227 /* We need the size of one event, because
4228 * rb_advance_reader only advances by one event,
4229 * whereas rb_event_ts_length may include the size of
4230 * one or two events.
4231 * We have already ensured there's enough space if this
4232 * is a time extend. */
4233 size = rb_event_length(event);
Steven Rostedt474d32b2009-03-03 19:51:40 -05004234 memcpy(bpage->data + pos, rpage->data + rpos, size);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004235
4236 len -= size;
4237
4238 rb_advance_reader(cpu_buffer);
Steven Rostedt474d32b2009-03-03 19:51:40 -05004239 rpos = reader->read;
4240 pos += size;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004241
Huang Ying18fab912010-07-28 14:14:01 +08004242 if (rpos >= commit)
4243 break;
4244
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004245 event = rb_reader_event(cpu_buffer);
Steven Rostedt69d1b832010-10-07 18:18:05 -04004246 /* Always keep the time extend and data together */
4247 size = rb_event_ts_length(event);
David Sharpe1e35922010-12-22 16:38:24 -08004248 } while (len >= size);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004249
4250 /* update bpage */
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004251 local_set(&bpage->commit, pos);
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004252 bpage->time_stamp = save_timestamp;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004253
Steven Rostedt474d32b2009-03-03 19:51:40 -05004254 /* we copied everything to the beginning */
4255 read = 0;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004256 } else {
Steven Rostedtafbab762009-05-01 19:40:05 -04004257 /* update the entry counter */
Steven Rostedt77ae3652009-03-27 11:00:29 -04004258 cpu_buffer->read += rb_page_entries(reader);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07004259 cpu_buffer->read_bytes += BUF_PAGE_SIZE;
Steven Rostedtafbab762009-05-01 19:40:05 -04004260
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004261 /* swap the pages */
Steven Rostedt044fa782008-12-02 23:50:03 -05004262 rb_init_page(bpage);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004263 bpage = reader->page;
4264 reader->page = *data_page;
4265 local_set(&reader->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04004266 local_set(&reader->entries, 0);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004267 reader->read = 0;
Steven Rostedt044fa782008-12-02 23:50:03 -05004268 *data_page = bpage;
Steven Rostedtff0ff842010-03-31 22:11:42 -04004269
4270 /*
4271 * Use the real_end for the data size,
4272 * This gives us a chance to store the lost events
4273 * on the page.
4274 */
4275 if (reader->real_end)
4276 local_set(&bpage->commit, reader->real_end);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004277 }
Lai Jiangshan667d2412009-02-09 14:21:17 +08004278 ret = read;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004279
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004280 cpu_buffer->lost_events = 0;
Steven Rostedt2711ca22010-05-21 13:32:26 -04004281
4282 commit = local_read(&bpage->commit);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004283 /*
4284 * Set a flag in the commit field if we lost events
4285 */
Steven Rostedtff0ff842010-03-31 22:11:42 -04004286 if (missed_events) {
Steven Rostedtff0ff842010-03-31 22:11:42 -04004287 /* If there is room at the end of the page to save the
4288 * missed events, then record it there.
4289 */
4290 if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
4291 memcpy(&bpage->data[commit], &missed_events,
4292 sizeof(missed_events));
4293 local_add(RB_MISSED_STORED, &bpage->commit);
Steven Rostedt2711ca22010-05-21 13:32:26 -04004294 commit += sizeof(missed_events);
Steven Rostedtff0ff842010-03-31 22:11:42 -04004295 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004296 local_add(RB_MISSED_EVENTS, &bpage->commit);
Steven Rostedtff0ff842010-03-31 22:11:42 -04004297 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004298
Steven Rostedt2711ca22010-05-21 13:32:26 -04004299 /*
4300 * This page may be off to user land. Zero it out here.
4301 */
4302 if (commit < BUF_PAGE_SIZE)
4303 memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);
4304
Steven Rostedt554f7862009-03-11 22:00:13 -04004305 out_unlock:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02004306 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004307
Steven Rostedt554f7862009-03-11 22:00:13 -04004308 out:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004309 return ret;
4310}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004311EXPORT_SYMBOL_GPL(ring_buffer_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004312
Steven Rostedt59222ef2009-03-12 11:46:03 -04004313#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01004314static int rb_cpu_notify(struct notifier_block *self,
4315 unsigned long action, void *hcpu)
Steven Rostedt554f7862009-03-11 22:00:13 -04004316{
4317 struct ring_buffer *buffer =
4318 container_of(self, struct ring_buffer, cpu_notify);
4319 long cpu = (long)hcpu;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004320 int cpu_i, nr_pages_same;
4321 unsigned int nr_pages;
Steven Rostedt554f7862009-03-11 22:00:13 -04004322
4323 switch (action) {
4324 case CPU_UP_PREPARE:
4325 case CPU_UP_PREPARE_FROZEN:
Rusty Russell3f237a72009-06-12 21:15:30 +09304326 if (cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04004327 return NOTIFY_OK;
4328
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004329 nr_pages = 0;
4330 nr_pages_same = 1;
4331 /* check if all cpu sizes are same */
4332 for_each_buffer_cpu(buffer, cpu_i) {
4333 /* fill in the size from first enabled cpu */
4334 if (nr_pages == 0)
4335 nr_pages = buffer->buffers[cpu_i]->nr_pages;
4336 if (nr_pages != buffer->buffers[cpu_i]->nr_pages) {
4337 nr_pages_same = 0;
4338 break;
4339 }
4340 }
4341 /* allocate minimum pages, user can later expand it */
4342 if (!nr_pages_same)
4343 nr_pages = 2;
Steven Rostedt554f7862009-03-11 22:00:13 -04004344 buffer->buffers[cpu] =
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004345 rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
Steven Rostedt554f7862009-03-11 22:00:13 -04004346 if (!buffer->buffers[cpu]) {
4347 WARN(1, "failed to allocate ring buffer on CPU %ld\n",
4348 cpu);
4349 return NOTIFY_OK;
4350 }
4351 smp_wmb();
Rusty Russell3f237a72009-06-12 21:15:30 +09304352 cpumask_set_cpu(cpu, buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -04004353 break;
4354 case CPU_DOWN_PREPARE:
4355 case CPU_DOWN_PREPARE_FROZEN:
4356 /*
4357 * Do nothing.
4358 * If we were to free the buffer, then the user would
4359 * lose any trace that was in the buffer.
4360 */
4361 break;
4362 default:
4363 break;
4364 }
4365 return NOTIFY_OK;
4366}
4367#endif