blob: ec01803e0a557a9b3016c936e9e32b4dcb6fe6da [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 Rostedt3e89c7bb2008-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 Rostedt3e89c7bb2008-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 Rostedt3e89c7bb2008-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 Rostedt3e89c7bb2008-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 Rostedt3e89c7bb2008-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.
Vaibhav Nagarnaik48fdc722012-06-29 12:31:41 -07001350 * Increment overrun to account for the lost events.
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001351 */
Vaibhav Nagarnaik48fdc722012-06-29 12:31:41 -07001352 local_add(page_entries, &cpu_buffer->overrun);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001353 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
1354 }
1355
1356 /*
1357 * We have already removed references to this list item, just
1358 * free up the buffer_page and its page
1359 */
1360 free_buffer_page(to_remove_page);
1361 nr_removed--;
1362
1363 } while (to_remove_page != last_page);
1364
1365 RB_WARN_ON(cpu_buffer, nr_removed);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001366
1367 return nr_removed == 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001368}
1369
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001370static int
1371rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001372{
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001373 struct list_head *pages = &cpu_buffer->new_pages;
1374 int retries, success;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001375
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001376 raw_spin_lock_irq(&cpu_buffer->reader_lock);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001377 /*
1378 * We are holding the reader lock, so the reader page won't be swapped
1379 * in the ring buffer. Now we are racing with the writer trying to
1380 * move head page and the tail page.
1381 * We are going to adapt the reader page update process where:
1382 * 1. We first splice the start and end of list of new pages between
1383 * the head page and its previous page.
1384 * 2. We cmpxchg the prev_page->next to point from head page to the
1385 * start of new pages list.
1386 * 3. Finally, we update the head->prev to the end of new list.
1387 *
1388 * We will try this process 10 times, to make sure that we don't keep
1389 * spinning.
1390 */
1391 retries = 10;
1392 success = 0;
1393 while (retries--) {
1394 struct list_head *head_page, *prev_page, *r;
1395 struct list_head *last_page, *first_page;
1396 struct list_head *head_page_with_bit;
Steven Rostedt77ae3652009-03-27 11:00:29 -04001397
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001398 head_page = &rb_set_head_page(cpu_buffer)->list;
Steven Rostedt54f7be52012-11-29 22:27:22 -05001399 if (!head_page)
1400 break;
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001401 prev_page = head_page->prev;
1402
1403 first_page = pages->next;
1404 last_page = pages->prev;
1405
1406 head_page_with_bit = (struct list_head *)
1407 ((unsigned long)head_page | RB_PAGE_HEAD);
1408
1409 last_page->next = head_page_with_bit;
1410 first_page->prev = prev_page;
1411
1412 r = cmpxchg(&prev_page->next, head_page_with_bit, first_page);
1413
1414 if (r == head_page_with_bit) {
1415 /*
1416 * yay, we replaced the page pointer to our new list,
1417 * now, we just have to update to head page's prev
1418 * pointer to point to end of list
1419 */
1420 head_page->prev = last_page;
1421 success = 1;
1422 break;
1423 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001424 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001425
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001426 if (success)
1427 INIT_LIST_HEAD(pages);
1428 /*
1429 * If we weren't successful in adding in new pages, warn and stop
1430 * tracing
1431 */
1432 RB_WARN_ON(cpu_buffer, !success);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02001433 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001434
1435 /* free pages if they weren't inserted */
1436 if (!success) {
1437 struct buffer_page *bpage, *tmp;
1438 list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
1439 list) {
1440 list_del_init(&bpage->list);
1441 free_buffer_page(bpage);
1442 }
1443 }
1444 return success;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001445}
1446
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001447static void rb_update_pages(struct ring_buffer_per_cpu *cpu_buffer)
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001448{
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001449 int success;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001450
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07001451 if (cpu_buffer->nr_pages_to_update > 0)
1452 success = rb_insert_pages(cpu_buffer);
1453 else
1454 success = rb_remove_pages(cpu_buffer,
1455 -cpu_buffer->nr_pages_to_update);
1456
1457 if (success)
1458 cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001459}
1460
1461static void update_pages_handler(struct work_struct *work)
1462{
1463 struct ring_buffer_per_cpu *cpu_buffer = container_of(work,
1464 struct ring_buffer_per_cpu, update_pages_work);
1465 rb_update_pages(cpu_buffer);
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001466 complete(&cpu_buffer->update_done);
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001467}
1468
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001469/**
1470 * ring_buffer_resize - resize the ring buffer
1471 * @buffer: the buffer to resize.
1472 * @size: the new size.
1473 *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001474 * Minimum size is 2 * BUF_PAGE_SIZE.
1475 *
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001476 * Returns 0 on success and < 0 on failure.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001477 */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001478int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size,
1479 int cpu_id)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001480{
1481 struct ring_buffer_per_cpu *cpu_buffer;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001482 unsigned nr_pages;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001483 int cpu, err = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001484
Ingo Molnaree51a1d2008-11-13 14:58:31 +01001485 /*
1486 * Always succeed at resizing a non-existent buffer:
1487 */
1488 if (!buffer)
1489 return size;
1490
Steven Rostedt6a31e1f2012-05-23 15:35:17 -04001491 /* Make sure the requested buffer exists */
1492 if (cpu_id != RING_BUFFER_ALL_CPUS &&
1493 !cpumask_test_cpu(cpu_id, buffer->cpumask))
1494 return size;
1495
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001496 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1497 size *= BUF_PAGE_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001498
1499 /* we need a minimum of two pages */
1500 if (size < BUF_PAGE_SIZE * 2)
1501 size = BUF_PAGE_SIZE * 2;
1502
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001503 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1504
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001505 /*
1506 * Don't succeed if resizing is disabled, as a reader might be
1507 * manipulating the ring buffer and is expecting a sane state while
1508 * this is true.
1509 */
1510 if (atomic_read(&buffer->resize_disabled))
1511 return -EBUSY;
1512
1513 /* prevent another thread from changing buffer sizes */
1514 mutex_lock(&buffer->mutex);
1515
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001516 if (cpu_id == RING_BUFFER_ALL_CPUS) {
1517 /* calculate the pages to update */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001518 for_each_buffer_cpu(buffer, cpu) {
1519 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001520
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001521 cpu_buffer->nr_pages_to_update = nr_pages -
1522 cpu_buffer->nr_pages;
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001523 /*
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001524 * nothing more to do for removing pages or no update
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07001525 */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001526 if (cpu_buffer->nr_pages_to_update <= 0)
1527 continue;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001528 /*
1529 * to add pages, make sure all new pages can be
1530 * allocated without receiving ENOMEM
1531 */
1532 INIT_LIST_HEAD(&cpu_buffer->new_pages);
1533 if (__rb_allocate_pages(cpu_buffer->nr_pages_to_update,
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001534 &cpu_buffer->new_pages, cpu)) {
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001535 /* not enough memory for new pages */
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001536 err = -ENOMEM;
1537 goto out_err;
1538 }
1539 }
1540
1541 get_online_cpus();
1542 /*
1543 * Fire off all the required work handlers
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001544 * We can't schedule on offline CPUs, but it's not necessary
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001545 * since we can change their buffer sizes without any race.
1546 */
1547 for_each_buffer_cpu(buffer, cpu) {
1548 cpu_buffer = buffer->buffers[cpu];
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001549 if (!cpu_buffer->nr_pages_to_update)
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001550 continue;
1551
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001552 if (cpu_online(cpu))
1553 schedule_work_on(cpu,
1554 &cpu_buffer->update_pages_work);
1555 else
1556 rb_update_pages(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001557 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001558
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001559 /* wait for all the updates to complete */
1560 for_each_buffer_cpu(buffer, cpu) {
1561 cpu_buffer = buffer->buffers[cpu];
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001562 if (!cpu_buffer->nr_pages_to_update)
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001563 continue;
1564
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001565 if (cpu_online(cpu))
1566 wait_for_completion(&cpu_buffer->update_done);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001567 cpu_buffer->nr_pages_to_update = 0;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001568 }
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001569
1570 put_online_cpus();
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001571 } else {
Vaibhav Nagarnaik8e49f412012-10-10 16:40:27 -07001572 /* Make sure this CPU has been intitialized */
1573 if (!cpumask_test_cpu(cpu_id, buffer->cpumask))
1574 goto out;
1575
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001576 cpu_buffer = buffer->buffers[cpu_id];
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001577
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001578 if (nr_pages == cpu_buffer->nr_pages)
1579 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001580
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001581 cpu_buffer->nr_pages_to_update = nr_pages -
1582 cpu_buffer->nr_pages;
1583
1584 INIT_LIST_HEAD(&cpu_buffer->new_pages);
1585 if (cpu_buffer->nr_pages_to_update > 0 &&
1586 __rb_allocate_pages(cpu_buffer->nr_pages_to_update,
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001587 &cpu_buffer->new_pages, cpu_id)) {
1588 err = -ENOMEM;
1589 goto out_err;
1590 }
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001591
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001592 get_online_cpus();
1593
1594 if (cpu_online(cpu_id)) {
1595 schedule_work_on(cpu_id,
1596 &cpu_buffer->update_pages_work);
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001597 wait_for_completion(&cpu_buffer->update_done);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001598 } else
1599 rb_update_pages(cpu_buffer);
1600
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001601 cpu_buffer->nr_pages_to_update = 0;
Vaibhav Nagarnaik05fdd702012-05-18 13:29:51 -07001602 put_online_cpus();
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001603 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001604
1605 out:
Steven Rostedt659f4512012-05-14 17:02:33 -04001606 /*
1607 * The ring buffer resize can happen with the ring buffer
1608 * enabled, so that the update disturbs the tracing as little
1609 * as possible. But if the buffer is disabled, we do not need
1610 * to worry about that, and we can take the time to verify
1611 * that the buffer is not corrupt.
1612 */
1613 if (atomic_read(&buffer->record_disabled)) {
1614 atomic_inc(&buffer->record_disabled);
1615 /*
1616 * Even though the buffer was disabled, we must make sure
1617 * that it is truly disabled before calling rb_check_pages.
1618 * There could have been a race between checking
1619 * record_disable and incrementing it.
1620 */
1621 synchronize_sched();
1622 for_each_buffer_cpu(buffer, cpu) {
1623 cpu_buffer = buffer->buffers[cpu];
1624 rb_check_pages(cpu_buffer);
1625 }
1626 atomic_dec(&buffer->record_disabled);
1627 }
1628
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001629 mutex_unlock(&buffer->mutex);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001630 return size;
1631
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001632 out_err:
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001633 for_each_buffer_cpu(buffer, cpu) {
1634 struct buffer_page *bpage, *tmp;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001635
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001636 cpu_buffer = buffer->buffers[cpu];
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001637 cpu_buffer->nr_pages_to_update = 0;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001638
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001639 if (list_empty(&cpu_buffer->new_pages))
1640 continue;
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001641
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001642 list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
1643 list) {
1644 list_del_init(&bpage->list);
1645 free_buffer_page(bpage);
1646 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001647 }
Vegard Nossum641d2f62008-11-18 19:22:13 +01001648 mutex_unlock(&buffer->mutex);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07001649 return err;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001650}
Robert Richterc4f50182008-12-11 16:49:22 +01001651EXPORT_SYMBOL_GPL(ring_buffer_resize);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001652
David Sharp750912f2010-12-08 13:46:47 -08001653void ring_buffer_change_overwrite(struct ring_buffer *buffer, int val)
1654{
1655 mutex_lock(&buffer->mutex);
1656 if (val)
1657 buffer->flags |= RB_FL_OVERWRITE;
1658 else
1659 buffer->flags &= ~RB_FL_OVERWRITE;
1660 mutex_unlock(&buffer->mutex);
1661}
1662EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
1663
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001664static inline void *
Steven Rostedt044fa782008-12-02 23:50:03 -05001665__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001666{
Steven Rostedt044fa782008-12-02 23:50:03 -05001667 return bpage->data + index;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05001668}
1669
Steven Rostedt044fa782008-12-02 23:50:03 -05001670static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001671{
Steven Rostedt044fa782008-12-02 23:50:03 -05001672 return bpage->page->data + index;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001673}
1674
1675static inline struct ring_buffer_event *
Steven Rostedtd7690412008-10-01 00:29:53 -04001676rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001677{
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001678 return __rb_page_index(cpu_buffer->reader_page,
1679 cpu_buffer->reader_page->read);
1680}
1681
1682static inline struct ring_buffer_event *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001683rb_iter_head_event(struct ring_buffer_iter *iter)
1684{
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001685 return __rb_page_index(iter->head_page, iter->head);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001686}
1687
Steven Rostedtbf41a152008-10-04 02:00:59 -04001688static inline unsigned rb_page_commit(struct buffer_page *bpage)
1689{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001690 return local_read(&bpage->page->commit);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001691}
1692
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001693/* Size is determined by what has been committed */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001694static inline unsigned rb_page_size(struct buffer_page *bpage)
1695{
1696 return rb_page_commit(bpage);
1697}
1698
1699static inline unsigned
1700rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
1701{
1702 return rb_page_commit(cpu_buffer->commit_page);
1703}
1704
Steven Rostedtbf41a152008-10-04 02:00:59 -04001705static inline unsigned
1706rb_event_index(struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001707{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001708 unsigned long addr = (unsigned long)event;
1709
Steven Rostedt22f470f2009-06-11 09:29:58 -04001710 return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001711}
1712
Steven Rostedt0f0c85f2009-05-11 16:08:00 -04001713static inline int
Steven Rostedtfa743952009-06-16 12:37:57 -04001714rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
1715 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001716{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001717 unsigned long addr = (unsigned long)event;
1718 unsigned long index;
1719
1720 index = rb_event_index(event);
1721 addr &= PAGE_MASK;
1722
1723 return cpu_buffer->commit_page->page == (void *)addr &&
1724 rb_commit_index(cpu_buffer) == index;
1725}
1726
Andrew Morton34a148b2009-01-09 12:27:09 -08001727static void
Steven Rostedtbf41a152008-10-04 02:00:59 -04001728rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
1729{
Steven Rostedt77ae3652009-03-27 11:00:29 -04001730 unsigned long max_count;
1731
Steven Rostedtbf41a152008-10-04 02:00:59 -04001732 /*
1733 * We only race with interrupts and NMIs on this CPU.
1734 * If we own the commit event, then we can commit
1735 * all others that interrupted us, since the interruptions
1736 * are in stack format (they finish before they come
1737 * back to us). This allows us to do a simple loop to
1738 * assign the commit to the tail.
1739 */
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001740 again:
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08001741 max_count = cpu_buffer->nr_pages * 100;
Steven Rostedt77ae3652009-03-27 11:00:29 -04001742
Steven Rostedtbf41a152008-10-04 02:00:59 -04001743 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001744 if (RB_WARN_ON(cpu_buffer, !(--max_count)))
1745 return;
1746 if (RB_WARN_ON(cpu_buffer,
1747 rb_is_reader_page(cpu_buffer->tail_page)))
1748 return;
1749 local_set(&cpu_buffer->commit_page->page->commit,
1750 rb_page_write(cpu_buffer->commit_page));
Steven Rostedtbf41a152008-10-04 02:00:59 -04001751 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001752 cpu_buffer->write_stamp =
1753 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001754 /* add barrier to keep gcc from optimizing too much */
1755 barrier();
1756 }
1757 while (rb_commit_index(cpu_buffer) !=
1758 rb_page_write(cpu_buffer->commit_page)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04001759
1760 local_set(&cpu_buffer->commit_page->page->commit,
1761 rb_page_write(cpu_buffer->commit_page));
1762 RB_WARN_ON(cpu_buffer,
1763 local_read(&cpu_buffer->commit_page->page->commit) &
1764 ~RB_WRITE_MASK);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001765 barrier();
1766 }
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001767
1768 /* again, keep gcc from optimizing */
1769 barrier();
1770
1771 /*
1772 * If an interrupt came in just after the first while loop
1773 * and pushed the tail page forward, we will be left with
1774 * a dangling commit that will never go forward.
1775 */
1776 if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
1777 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001778}
1779
Steven Rostedtd7690412008-10-01 00:29:53 -04001780static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001781{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001782 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001783 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04001784}
1785
Andrew Morton34a148b2009-01-09 12:27:09 -08001786static void rb_inc_iter(struct ring_buffer_iter *iter)
Steven Rostedtd7690412008-10-01 00:29:53 -04001787{
1788 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1789
1790 /*
1791 * The iterator could be on the reader page (it starts there).
1792 * But the head could have moved, since the reader was
1793 * found. Check for this case and assign the iterator
1794 * to the head page instead of next.
1795 */
1796 if (iter->head_page == cpu_buffer->reader_page)
Steven Rostedt77ae3652009-03-27 11:00:29 -04001797 iter->head_page = rb_set_head_page(cpu_buffer);
Steven Rostedtd7690412008-10-01 00:29:53 -04001798 else
1799 rb_inc_page(cpu_buffer, &iter->head_page);
1800
Steven Rostedtabc9b562008-12-02 15:34:06 -05001801 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001802 iter->head = 0;
1803}
1804
Steven Rostedt69d1b832010-10-07 18:18:05 -04001805/* Slow path, do not inline */
1806static noinline struct ring_buffer_event *
1807rb_add_time_stamp(struct ring_buffer_event *event, u64 delta)
1808{
1809 event->type_len = RINGBUF_TYPE_TIME_EXTEND;
1810
1811 /* Not the first event on the page? */
1812 if (rb_event_index(event)) {
1813 event->time_delta = delta & TS_MASK;
1814 event->array[0] = delta >> TS_SHIFT;
1815 } else {
1816 /* nope, just zero it */
1817 event->time_delta = 0;
1818 event->array[0] = 0;
1819 }
1820
1821 return skip_time_extend(event);
1822}
1823
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001824/**
1825 * ring_buffer_update_event - update event type and data
1826 * @event: the even to update
1827 * @type: the type of event
1828 * @length: the size of the event field in the ring buffer
1829 *
1830 * Update the type and data fields of the event. The length
1831 * is the actual size that is written to the ring buffer,
1832 * and with this, we can determine what to place into the
1833 * data field.
1834 */
Andrew Morton34a148b2009-01-09 12:27:09 -08001835static void
Steven Rostedt69d1b832010-10-07 18:18:05 -04001836rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
1837 struct ring_buffer_event *event, unsigned length,
1838 int add_timestamp, u64 delta)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001839{
Steven Rostedt69d1b832010-10-07 18:18:05 -04001840 /* Only a commit updates the timestamp */
1841 if (unlikely(!rb_event_is_commit(cpu_buffer, event)))
1842 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001843
Steven Rostedt69d1b832010-10-07 18:18:05 -04001844 /*
1845 * If we need to add a timestamp, then we
1846 * add it to the start of the resevered space.
1847 */
1848 if (unlikely(add_timestamp)) {
1849 event = rb_add_time_stamp(event, delta);
1850 length -= RB_LEN_TIME_EXTEND;
1851 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001852 }
Steven Rostedt69d1b832010-10-07 18:18:05 -04001853
1854 event->time_delta = delta;
1855 length -= RB_EVNT_HDR_SIZE;
1856 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
1857 event->type_len = 0;
1858 event->array[0] = length;
1859 } else
1860 event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001861}
1862
Steven Rostedt77ae3652009-03-27 11:00:29 -04001863/*
1864 * rb_handle_head_page - writer hit the head page
1865 *
1866 * Returns: +1 to retry page
1867 * 0 to continue
1868 * -1 on error
1869 */
1870static int
1871rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
1872 struct buffer_page *tail_page,
1873 struct buffer_page *next_page)
1874{
1875 struct buffer_page *new_head;
1876 int entries;
1877 int type;
1878 int ret;
1879
1880 entries = rb_page_entries(next_page);
1881
1882 /*
1883 * The hard part is here. We need to move the head
1884 * forward, and protect against both readers on
1885 * other CPUs and writers coming in via interrupts.
1886 */
1887 type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
1888 RB_PAGE_HEAD);
1889
1890 /*
1891 * type can be one of four:
1892 * NORMAL - an interrupt already moved it for us
1893 * HEAD - we are the first to get here.
1894 * UPDATE - we are the interrupt interrupting
1895 * a current move.
1896 * MOVED - a reader on another CPU moved the next
1897 * pointer to its reader page. Give up
1898 * and try again.
1899 */
1900
1901 switch (type) {
1902 case RB_PAGE_HEAD:
1903 /*
1904 * We changed the head to UPDATE, thus
1905 * it is our responsibility to update
1906 * the counters.
1907 */
1908 local_add(entries, &cpu_buffer->overrun);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07001909 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
Steven Rostedt77ae3652009-03-27 11:00:29 -04001910
1911 /*
1912 * The entries will be zeroed out when we move the
1913 * tail page.
1914 */
1915
1916 /* still more to do */
1917 break;
1918
1919 case RB_PAGE_UPDATE:
1920 /*
1921 * This is an interrupt that interrupt the
1922 * previous update. Still more to do.
1923 */
1924 break;
1925 case RB_PAGE_NORMAL:
1926 /*
1927 * An interrupt came in before the update
1928 * and processed this for us.
1929 * Nothing left to do.
1930 */
1931 return 1;
1932 case RB_PAGE_MOVED:
1933 /*
1934 * The reader is on another CPU and just did
1935 * a swap with our next_page.
1936 * Try again.
1937 */
1938 return 1;
1939 default:
1940 RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
1941 return -1;
1942 }
1943
1944 /*
1945 * Now that we are here, the old head pointer is
1946 * set to UPDATE. This will keep the reader from
1947 * swapping the head page with the reader page.
1948 * The reader (on another CPU) will spin till
1949 * we are finished.
1950 *
1951 * We just need to protect against interrupts
1952 * doing the job. We will set the next pointer
1953 * to HEAD. After that, we set the old pointer
1954 * to NORMAL, but only if it was HEAD before.
1955 * otherwise we are an interrupt, and only
1956 * want the outer most commit to reset it.
1957 */
1958 new_head = next_page;
1959 rb_inc_page(cpu_buffer, &new_head);
1960
1961 ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
1962 RB_PAGE_NORMAL);
1963
1964 /*
1965 * Valid returns are:
1966 * HEAD - an interrupt came in and already set it.
1967 * NORMAL - One of two things:
1968 * 1) We really set it.
1969 * 2) A bunch of interrupts came in and moved
1970 * the page forward again.
1971 */
1972 switch (ret) {
1973 case RB_PAGE_HEAD:
1974 case RB_PAGE_NORMAL:
1975 /* OK */
1976 break;
1977 default:
1978 RB_WARN_ON(cpu_buffer, 1);
1979 return -1;
1980 }
1981
1982 /*
1983 * It is possible that an interrupt came in,
1984 * set the head up, then more interrupts came in
1985 * and moved it again. When we get back here,
1986 * the page would have been set to NORMAL but we
1987 * just set it back to HEAD.
1988 *
1989 * How do you detect this? Well, if that happened
1990 * the tail page would have moved.
1991 */
1992 if (ret == RB_PAGE_NORMAL) {
1993 /*
1994 * If the tail had moved passed next, then we need
1995 * to reset the pointer.
1996 */
1997 if (cpu_buffer->tail_page != tail_page &&
1998 cpu_buffer->tail_page != next_page)
1999 rb_head_page_set_normal(cpu_buffer, new_head,
2000 next_page,
2001 RB_PAGE_HEAD);
2002 }
2003
2004 /*
2005 * If this was the outer most commit (the one that
2006 * changed the original pointer from HEAD to UPDATE),
2007 * then it is up to us to reset it to NORMAL.
2008 */
2009 if (type == RB_PAGE_HEAD) {
2010 ret = rb_head_page_set_normal(cpu_buffer, next_page,
2011 tail_page,
2012 RB_PAGE_UPDATE);
2013 if (RB_WARN_ON(cpu_buffer,
2014 ret != RB_PAGE_UPDATE))
2015 return -1;
2016 }
2017
2018 return 0;
2019}
2020
Andrew Morton34a148b2009-01-09 12:27:09 -08002021static unsigned rb_calculate_event_length(unsigned length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002022{
2023 struct ring_buffer_event event; /* Used only for sizeof array */
2024
2025 /* zero length can cause confusions */
2026 if (!length)
2027 length = 1;
2028
Steven Rostedt22710482010-03-18 17:54:19 -04002029 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002030 length += sizeof(event.array[0]);
2031
2032 length += RB_EVNT_HDR_SIZE;
Steven Rostedt22710482010-03-18 17:54:19 -04002033 length = ALIGN(length, RB_ARCH_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002034
2035 return length;
2036}
2037
Steven Rostedtc7b09302009-06-11 11:12:00 -04002038static inline void
2039rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
2040 struct buffer_page *tail_page,
2041 unsigned long tail, unsigned long length)
2042{
2043 struct ring_buffer_event *event;
2044
2045 /*
2046 * Only the event that crossed the page boundary
2047 * must fill the old tail_page with padding.
2048 */
2049 if (tail >= BUF_PAGE_SIZE) {
Steven Rostedtb3230c82010-05-21 11:55:21 -04002050 /*
2051 * If the page was filled, then we still need
2052 * to update the real_end. Reset it to zero
2053 * and the reader will ignore it.
2054 */
2055 if (tail == BUF_PAGE_SIZE)
2056 tail_page->real_end = 0;
2057
Steven Rostedtc7b09302009-06-11 11:12:00 -04002058 local_sub(length, &tail_page->write);
2059 return;
2060 }
2061
2062 event = __rb_page_index(tail_page, tail);
Linus Torvaldsb0b70652009-06-20 10:56:46 -07002063 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedtc7b09302009-06-11 11:12:00 -04002064
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002065 /* account for padding bytes */
2066 local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
2067
Steven Rostedtc7b09302009-06-11 11:12:00 -04002068 /*
Steven Rostedtff0ff842010-03-31 22:11:42 -04002069 * Save the original length to the meta data.
2070 * This will be used by the reader to add lost event
2071 * counter.
2072 */
2073 tail_page->real_end = tail;
2074
2075 /*
Steven Rostedtc7b09302009-06-11 11:12:00 -04002076 * If this event is bigger than the minimum size, then
2077 * we need to be careful that we don't subtract the
2078 * write counter enough to allow another writer to slip
2079 * in on this page.
2080 * We put in a discarded commit instead, to make sure
2081 * that this space is not used again.
2082 *
2083 * If we are less than the minimum size, we don't need to
2084 * worry about it.
2085 */
2086 if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
2087 /* No room for any events */
2088
2089 /* Mark the rest of the page with padding */
2090 rb_event_set_padding(event);
2091
2092 /* Set the write back to the previous setting */
2093 local_sub(length, &tail_page->write);
2094 return;
2095 }
2096
2097 /* Put in a discarded event */
2098 event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
2099 event->type_len = RINGBUF_TYPE_PADDING;
2100 /* time delta must be non zero */
2101 event->time_delta = 1;
Steven Rostedtc7b09302009-06-11 11:12:00 -04002102
2103 /* Set write to end of buffer */
2104 length = (tail + length) - BUF_PAGE_SIZE;
2105 local_sub(length, &tail_page->write);
2106}
Steven Rostedt6634ff22009-05-06 15:30:07 -04002107
Steven Rostedt747e94a2010-10-08 13:51:48 -04002108/*
2109 * This is the slow path, force gcc not to inline it.
2110 */
2111static noinline struct ring_buffer_event *
Steven Rostedt6634ff22009-05-06 15:30:07 -04002112rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
2113 unsigned long length, unsigned long tail,
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002114 struct buffer_page *tail_page, u64 ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002115{
Steven Rostedt5a50e332009-11-17 08:43:01 -05002116 struct buffer_page *commit_page = cpu_buffer->commit_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002117 struct ring_buffer *buffer = cpu_buffer->buffer;
Steven Rostedt77ae3652009-03-27 11:00:29 -04002118 struct buffer_page *next_page;
2119 int ret;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002120
2121 next_page = tail_page;
2122
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002123 rb_inc_page(cpu_buffer, &next_page);
2124
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002125 /*
2126 * If for some reason, we had an interrupt storm that made
2127 * it all the way around the buffer, bail, and warn
2128 * about it.
2129 */
2130 if (unlikely(next_page == commit_page)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04002131 local_inc(&cpu_buffer->commit_overrun);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002132 goto out_reset;
2133 }
2134
Steven Rostedt77ae3652009-03-27 11:00:29 -04002135 /*
2136 * This is where the fun begins!
2137 *
2138 * We are fighting against races between a reader that
2139 * could be on another CPU trying to swap its reader
2140 * page with the buffer head.
2141 *
2142 * We are also fighting against interrupts coming in and
2143 * moving the head or tail on us as well.
2144 *
2145 * If the next page is the head page then we have filled
2146 * the buffer, unless the commit page is still on the
2147 * reader page.
2148 */
2149 if (rb_is_head_page(cpu_buffer, next_page, &tail_page->list)) {
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002150
Steven Rostedt77ae3652009-03-27 11:00:29 -04002151 /*
2152 * If the commit is not on the reader page, then
2153 * move the header page.
2154 */
2155 if (!rb_is_reader_page(cpu_buffer->commit_page)) {
2156 /*
2157 * If we are not in overwrite mode,
2158 * this is easy, just stop here.
2159 */
2160 if (!(buffer->flags & RB_FL_OVERWRITE))
2161 goto out_reset;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002162
Steven Rostedt77ae3652009-03-27 11:00:29 -04002163 ret = rb_handle_head_page(cpu_buffer,
2164 tail_page,
2165 next_page);
2166 if (ret < 0)
2167 goto out_reset;
2168 if (ret)
2169 goto out_again;
2170 } else {
2171 /*
2172 * We need to be careful here too. The
2173 * commit page could still be on the reader
2174 * page. We could have a small buffer, and
2175 * have filled up the buffer with events
2176 * from interrupts and such, and wrapped.
2177 *
2178 * Note, if the tail page is also the on the
2179 * reader_page, we let it move out.
2180 */
2181 if (unlikely((cpu_buffer->commit_page !=
2182 cpu_buffer->tail_page) &&
2183 (cpu_buffer->commit_page ==
2184 cpu_buffer->reader_page))) {
2185 local_inc(&cpu_buffer->commit_overrun);
2186 goto out_reset;
2187 }
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002188 }
2189 }
2190
Steven Rostedt77ae3652009-03-27 11:00:29 -04002191 ret = rb_tail_page_update(cpu_buffer, tail_page, next_page);
2192 if (ret) {
2193 /*
2194 * Nested commits always have zero deltas, so
2195 * just reread the time stamp
2196 */
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002197 ts = rb_time_stamp(buffer);
2198 next_page->page->time_stamp = ts;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002199 }
2200
Steven Rostedt77ae3652009-03-27 11:00:29 -04002201 out_again:
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002202
Steven Rostedt77ae3652009-03-27 11:00:29 -04002203 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04002204
2205 /* fail and let the caller try again */
2206 return ERR_PTR(-EAGAIN);
2207
Steven Rostedt45141d42009-02-12 13:19:48 -05002208 out_reset:
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08002209 /* reset write */
Steven Rostedtc7b09302009-06-11 11:12:00 -04002210 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08002211
Steven Rostedtbf41a152008-10-04 02:00:59 -04002212 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002213}
2214
Steven Rostedt6634ff22009-05-06 15:30:07 -04002215static struct ring_buffer_event *
2216__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt69d1b832010-10-07 18:18:05 -04002217 unsigned long length, u64 ts,
2218 u64 delta, int add_timestamp)
Steven Rostedt6634ff22009-05-06 15:30:07 -04002219{
Steven Rostedt5a50e332009-11-17 08:43:01 -05002220 struct buffer_page *tail_page;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002221 struct ring_buffer_event *event;
2222 unsigned long tail, write;
2223
Steven Rostedt69d1b832010-10-07 18:18:05 -04002224 /*
2225 * If the time delta since the last event is too big to
2226 * hold in the time field of the event, then we append a
2227 * TIME EXTEND event ahead of the data event.
2228 */
2229 if (unlikely(add_timestamp))
2230 length += RB_LEN_TIME_EXTEND;
2231
Steven Rostedt6634ff22009-05-06 15:30:07 -04002232 tail_page = cpu_buffer->tail_page;
2233 write = local_add_return(length, &tail_page->write);
Steven Rostedt77ae3652009-03-27 11:00:29 -04002234
2235 /* set write to only the index of the write */
2236 write &= RB_WRITE_MASK;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002237 tail = write - length;
2238
2239 /* See if we shot pass the end of this buffer page */
Steven Rostedt747e94a2010-10-08 13:51:48 -04002240 if (unlikely(write > BUF_PAGE_SIZE))
Steven Rostedt6634ff22009-05-06 15:30:07 -04002241 return rb_move_tail(cpu_buffer, length, tail,
Steven Rostedt5a50e332009-11-17 08:43:01 -05002242 tail_page, ts);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002243
2244 /* We reserved something on the buffer */
2245
Steven Rostedt6634ff22009-05-06 15:30:07 -04002246 event = __rb_page_index(tail_page, tail);
Vegard Nossum1744a212009-02-28 08:29:44 +01002247 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedt69d1b832010-10-07 18:18:05 -04002248 rb_update_event(cpu_buffer, event, length, add_timestamp, delta);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002249
Steven Rostedt69d1b832010-10-07 18:18:05 -04002250 local_inc(&tail_page->entries);
Steven Rostedt6634ff22009-05-06 15:30:07 -04002251
2252 /*
Steven Rostedtfa743952009-06-16 12:37:57 -04002253 * If this is the first commit on the page, then update
2254 * its timestamp.
Steven Rostedt6634ff22009-05-06 15:30:07 -04002255 */
Steven Rostedtfa743952009-06-16 12:37:57 -04002256 if (!tail)
Steven Rostedte8bc43e2010-10-20 10:58:02 -04002257 tail_page->page->time_stamp = ts;
Steven Rostedt6634ff22009-05-06 15:30:07 -04002258
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002259 /* account for these added bytes */
2260 local_add(length, &cpu_buffer->entries_bytes);
2261
Steven Rostedt6634ff22009-05-06 15:30:07 -04002262 return event;
2263}
2264
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002265static inline int
2266rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
2267 struct ring_buffer_event *event)
2268{
2269 unsigned long new_index, old_index;
2270 struct buffer_page *bpage;
2271 unsigned long index;
2272 unsigned long addr;
2273
2274 new_index = rb_event_index(event);
Steven Rostedt69d1b832010-10-07 18:18:05 -04002275 old_index = new_index + rb_event_ts_length(event);
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002276 addr = (unsigned long)event;
2277 addr &= PAGE_MASK;
2278
2279 bpage = cpu_buffer->tail_page;
2280
2281 if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04002282 unsigned long write_mask =
2283 local_read(&bpage->write) & ~RB_WRITE_MASK;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002284 unsigned long event_length = rb_event_length(event);
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002285 /*
2286 * This is on the tail page. It is possible that
2287 * a write could come in and move the tail page
2288 * and write to the next page. That is fine
2289 * because we just shorten what is on this page.
2290 */
Steven Rostedt77ae3652009-03-27 11:00:29 -04002291 old_index += write_mask;
2292 new_index += write_mask;
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002293 index = local_cmpxchg(&bpage->write, old_index, new_index);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002294 if (index == old_index) {
2295 /* update counters */
2296 local_sub(event_length, &cpu_buffer->entries_bytes);
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002297 return 1;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002298 }
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002299 }
2300
2301 /* could not discard */
2302 return 0;
2303}
2304
Steven Rostedtfa743952009-06-16 12:37:57 -04002305static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
2306{
2307 local_inc(&cpu_buffer->committing);
2308 local_inc(&cpu_buffer->commits);
2309}
2310
Steven Rostedtd9abde22010-10-19 13:17:08 -04002311static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtfa743952009-06-16 12:37:57 -04002312{
2313 unsigned long commits;
2314
2315 if (RB_WARN_ON(cpu_buffer,
2316 !local_read(&cpu_buffer->committing)))
2317 return;
2318
2319 again:
2320 commits = local_read(&cpu_buffer->commits);
2321 /* synchronize with interrupts */
2322 barrier();
2323 if (local_read(&cpu_buffer->committing) == 1)
2324 rb_set_commit_to_write(cpu_buffer);
2325
2326 local_dec(&cpu_buffer->committing);
2327
2328 /* synchronize with interrupts */
2329 barrier();
2330
2331 /*
2332 * Need to account for interrupts coming in between the
2333 * updating of the commit page and the clearing of the
2334 * committing counter.
2335 */
2336 if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
2337 !local_read(&cpu_buffer->committing)) {
2338 local_inc(&cpu_buffer->committing);
2339 goto again;
2340 }
2341}
2342
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002343static struct ring_buffer_event *
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002344rb_reserve_next_event(struct ring_buffer *buffer,
2345 struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt1cd8d732009-05-11 14:08:09 -04002346 unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002347{
2348 struct ring_buffer_event *event;
Steven Rostedt69d1b832010-10-07 18:18:05 -04002349 u64 ts, delta;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002350 int nr_loops = 0;
Steven Rostedt69d1b832010-10-07 18:18:05 -04002351 int add_timestamp;
Steven Rostedt140ff892010-10-08 10:50:30 -04002352 u64 diff;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002353
Steven Rostedtfa743952009-06-16 12:37:57 -04002354 rb_start_commit(cpu_buffer);
2355
Steven Rostedt85bac322009-09-04 14:24:40 -04002356#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002357 /*
2358 * Due to the ability to swap a cpu buffer from a buffer
2359 * it is possible it was swapped before we committed.
2360 * (committing stops a swap). We check for it here and
2361 * if it happened, we have to fail the write.
2362 */
2363 barrier();
2364 if (unlikely(ACCESS_ONCE(cpu_buffer->buffer) != buffer)) {
2365 local_dec(&cpu_buffer->committing);
2366 local_dec(&cpu_buffer->commits);
2367 return NULL;
2368 }
Steven Rostedt85bac322009-09-04 14:24:40 -04002369#endif
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002370
Steven Rostedtbe957c42009-05-11 14:42:53 -04002371 length = rb_calculate_event_length(length);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002372 again:
Steven Rostedt69d1b832010-10-07 18:18:05 -04002373 add_timestamp = 0;
2374 delta = 0;
2375
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002376 /*
2377 * We allow for interrupts to reenter here and do a trace.
2378 * If one does, it will cause this original code to loop
2379 * back here. Even with heavy interrupts happening, this
2380 * should only happen a few times in a row. If this happens
2381 * 1000 times in a row, there must be either an interrupt
2382 * storm or we have something buggy.
2383 * Bail!
2384 */
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05002385 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
Steven Rostedtfa743952009-06-16 12:37:57 -04002386 goto out_fail;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002387
Jiri Olsa6d3f1e12009-10-23 19:36:19 -04002388 ts = rb_time_stamp(cpu_buffer->buffer);
Steven Rostedt140ff892010-10-08 10:50:30 -04002389 diff = ts - cpu_buffer->write_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002390
Steven Rostedt140ff892010-10-08 10:50:30 -04002391 /* make sure this diff is calculated here */
2392 barrier();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002393
Steven Rostedt140ff892010-10-08 10:50:30 -04002394 /* Did the write stamp get updated already? */
2395 if (likely(ts >= cpu_buffer->write_stamp)) {
Steven Rostedt168b6b12009-05-11 22:11:05 -04002396 delta = diff;
2397 if (unlikely(test_time_stamp(delta))) {
Jiri Olsa31274d72011-02-18 15:52:19 +01002398 int local_clock_stable = 1;
2399#ifdef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
2400 local_clock_stable = sched_clock_stable;
2401#endif
Steven Rostedt69d1b832010-10-07 18:18:05 -04002402 WARN_ONCE(delta > (1ULL << 59),
Jiri Olsa31274d72011-02-18 15:52:19 +01002403 KERN_WARNING "Delta way too big! %llu ts=%llu write stamp = %llu\n%s",
Steven Rostedt69d1b832010-10-07 18:18:05 -04002404 (unsigned long long)delta,
2405 (unsigned long long)ts,
Jiri Olsa31274d72011-02-18 15:52:19 +01002406 (unsigned long long)cpu_buffer->write_stamp,
2407 local_clock_stable ? "" :
2408 "If you just came from a suspend/resume,\n"
2409 "please switch to the trace global clock:\n"
2410 " echo global > /sys/kernel/debug/tracing/trace_clock\n");
Steven Rostedt69d1b832010-10-07 18:18:05 -04002411 add_timestamp = 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002412 }
Steven Rostedt168b6b12009-05-11 22:11:05 -04002413 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002414
Steven Rostedt69d1b832010-10-07 18:18:05 -04002415 event = __rb_reserve_next(cpu_buffer, length, ts,
2416 delta, add_timestamp);
Steven Rostedt168b6b12009-05-11 22:11:05 -04002417 if (unlikely(PTR_ERR(event) == -EAGAIN))
Steven Rostedtbf41a152008-10-04 02:00:59 -04002418 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002419
Steven Rostedtfa743952009-06-16 12:37:57 -04002420 if (!event)
2421 goto out_fail;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002422
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002423 return event;
Steven Rostedtfa743952009-06-16 12:37:57 -04002424
2425 out_fail:
2426 rb_end_commit(cpu_buffer);
2427 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002428}
2429
Paul Mundt1155de42009-06-25 14:30:12 +09002430#ifdef CONFIG_TRACING
2431
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002432#define TRACE_RECURSIVE_DEPTH 16
Steven Rostedt261842b2009-04-16 21:41:52 -04002433
Steven Rostedtd9abde22010-10-19 13:17:08 -04002434/* Keep this code out of the fast path cache */
2435static noinline void trace_recursive_fail(void)
Steven Rostedt261842b2009-04-16 21:41:52 -04002436{
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002437 /* Disable all tracing before we do anything else */
2438 tracing_off_permanent();
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02002439
Steven Rostedt7d7d2b82009-04-27 12:37:49 -04002440 printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002441 "HC[%lu]:SC[%lu]:NMI[%lu]\n",
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002442 trace_recursion_buffer(),
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002443 hardirq_count() >> HARDIRQ_SHIFT,
2444 softirq_count() >> SOFTIRQ_SHIFT,
2445 in_nmi());
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02002446
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002447 WARN_ON_ONCE(1);
Steven Rostedtd9abde22010-10-19 13:17:08 -04002448}
2449
2450static inline int trace_recursive_lock(void)
2451{
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002452 trace_recursion_inc();
Steven Rostedtd9abde22010-10-19 13:17:08 -04002453
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002454 if (likely(trace_recursion_buffer() < TRACE_RECURSIVE_DEPTH))
Steven Rostedtd9abde22010-10-19 13:17:08 -04002455 return 0;
2456
2457 trace_recursive_fail();
2458
Steven Rostedtaa18efb2009-04-20 16:16:11 -04002459 return -1;
Steven Rostedt261842b2009-04-16 21:41:52 -04002460}
2461
Steven Rostedtd9abde22010-10-19 13:17:08 -04002462static inline void trace_recursive_unlock(void)
Steven Rostedt261842b2009-04-16 21:41:52 -04002463{
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002464 WARN_ON_ONCE(!trace_recursion_buffer());
Steven Rostedt261842b2009-04-16 21:41:52 -04002465
Steven Rostedtb1cff0a2011-05-25 14:27:43 -04002466 trace_recursion_dec();
Steven Rostedt261842b2009-04-16 21:41:52 -04002467}
2468
Paul Mundt1155de42009-06-25 14:30:12 +09002469#else
2470
2471#define trace_recursive_lock() (0)
2472#define trace_recursive_unlock() do { } while (0)
2473
2474#endif
2475
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002476/**
2477 * ring_buffer_lock_reserve - reserve a part of the buffer
2478 * @buffer: the ring buffer to reserve from
2479 * @length: the length of the data to reserve (excluding event header)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002480 *
2481 * Returns a reseverd event on the ring buffer to copy directly to.
2482 * The user of this interface will need to get the body to write into
2483 * and can use the ring_buffer_event_data() interface.
2484 *
2485 * The length is the length of the data needed, not the event length
2486 * which also includes the event header.
2487 *
2488 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
2489 * If NULL is returned, then nothing has been allocated or locked.
2490 */
2491struct ring_buffer_event *
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02002492ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002493{
2494 struct ring_buffer_per_cpu *cpu_buffer;
2495 struct ring_buffer_event *event;
Steven Rostedt5168ae52010-06-03 09:36:50 -04002496 int cpu;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002497
Steven Rostedt033601a2008-11-21 12:41:55 -05002498 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05002499 return NULL;
2500
Steven Rostedtbf41a152008-10-04 02:00:59 -04002501 /* If we are tracing schedule, we don't want to recurse */
Steven Rostedt5168ae52010-06-03 09:36:50 -04002502 preempt_disable_notrace();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002503
Lai Jiangshan52fbe9c2010-03-08 14:50:43 +08002504 if (atomic_read(&buffer->record_disabled))
2505 goto out_nocheck;
2506
Steven Rostedt261842b2009-04-16 21:41:52 -04002507 if (trace_recursive_lock())
2508 goto out_nocheck;
2509
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002510 cpu = raw_smp_processor_id();
2511
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302512 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04002513 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002514
2515 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002516
2517 if (atomic_read(&cpu_buffer->record_disabled))
Steven Rostedtd7690412008-10-01 00:29:53 -04002518 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002519
Steven Rostedtbe957c42009-05-11 14:42:53 -04002520 if (length > BUF_MAX_DATA_SIZE)
Steven Rostedtbf41a152008-10-04 02:00:59 -04002521 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002522
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002523 event = rb_reserve_next_event(buffer, cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002524 if (!event)
Steven Rostedtd7690412008-10-01 00:29:53 -04002525 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002526
2527 return event;
2528
Steven Rostedtd7690412008-10-01 00:29:53 -04002529 out:
Steven Rostedt261842b2009-04-16 21:41:52 -04002530 trace_recursive_unlock();
2531
2532 out_nocheck:
Steven Rostedt5168ae52010-06-03 09:36:50 -04002533 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002534 return NULL;
2535}
Robert Richterc4f50182008-12-11 16:49:22 +01002536EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002537
Steven Rostedta1863c22009-09-03 10:23:58 -04002538static void
2539rb_update_write_stamp(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002540 struct ring_buffer_event *event)
2541{
Steven Rostedt69d1b832010-10-07 18:18:05 -04002542 u64 delta;
2543
Steven Rostedtfa743952009-06-16 12:37:57 -04002544 /*
2545 * The event first in the commit queue updates the
2546 * time stamp.
2547 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04002548 if (rb_event_is_commit(cpu_buffer, event)) {
2549 /*
2550 * A commit event that is first on a page
2551 * updates the write timestamp with the page stamp
2552 */
2553 if (!rb_event_index(event))
2554 cpu_buffer->write_stamp =
2555 cpu_buffer->commit_page->page->time_stamp;
2556 else if (event->type_len == RINGBUF_TYPE_TIME_EXTEND) {
2557 delta = event->array[0];
2558 delta <<= TS_SHIFT;
2559 delta += event->time_delta;
2560 cpu_buffer->write_stamp += delta;
2561 } else
2562 cpu_buffer->write_stamp += event->time_delta;
2563 }
Steven Rostedta1863c22009-09-03 10:23:58 -04002564}
Steven Rostedtbf41a152008-10-04 02:00:59 -04002565
Steven Rostedta1863c22009-09-03 10:23:58 -04002566static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
2567 struct ring_buffer_event *event)
2568{
2569 local_inc(&cpu_buffer->entries);
2570 rb_update_write_stamp(cpu_buffer, event);
Steven Rostedtfa743952009-06-16 12:37:57 -04002571 rb_end_commit(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002572}
2573
2574/**
2575 * ring_buffer_unlock_commit - commit a reserved
2576 * @buffer: The buffer to commit to
2577 * @event: The event pointer to commit.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002578 *
2579 * This commits the data to the ring buffer, and releases any locks held.
2580 *
2581 * Must be paired with ring_buffer_lock_reserve.
2582 */
2583int ring_buffer_unlock_commit(struct ring_buffer *buffer,
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02002584 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002585{
2586 struct ring_buffer_per_cpu *cpu_buffer;
2587 int cpu = raw_smp_processor_id();
2588
2589 cpu_buffer = buffer->buffers[cpu];
2590
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002591 rb_commit(cpu_buffer, event);
2592
Steven Rostedt261842b2009-04-16 21:41:52 -04002593 trace_recursive_unlock();
2594
Steven Rostedt5168ae52010-06-03 09:36:50 -04002595 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002596
2597 return 0;
2598}
Robert Richterc4f50182008-12-11 16:49:22 +01002599EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002600
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002601static inline void rb_event_discard(struct ring_buffer_event *event)
2602{
Steven Rostedt69d1b832010-10-07 18:18:05 -04002603 if (event->type_len == RINGBUF_TYPE_TIME_EXTEND)
2604 event = skip_time_extend(event);
2605
Lai Jiangshan334d4162009-04-24 11:27:05 +08002606 /* array[0] holds the actual length for the discarded event */
2607 event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
2608 event->type_len = RINGBUF_TYPE_PADDING;
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002609 /* time delta must be non zero */
2610 if (!event->time_delta)
2611 event->time_delta = 1;
2612}
2613
Steven Rostedta1863c22009-09-03 10:23:58 -04002614/*
2615 * Decrement the entries to the page that an event is on.
2616 * The event does not even need to exist, only the pointer
2617 * to the page it is on. This may only be called before the commit
2618 * takes place.
2619 */
2620static inline void
2621rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
2622 struct ring_buffer_event *event)
2623{
2624 unsigned long addr = (unsigned long)event;
2625 struct buffer_page *bpage = cpu_buffer->commit_page;
2626 struct buffer_page *start;
2627
2628 addr &= PAGE_MASK;
2629
2630 /* Do the likely case first */
2631 if (likely(bpage->page == (void *)addr)) {
2632 local_dec(&bpage->entries);
2633 return;
2634 }
2635
2636 /*
2637 * Because the commit page may be on the reader page we
2638 * start with the next page and check the end loop there.
2639 */
2640 rb_inc_page(cpu_buffer, &bpage);
2641 start = bpage;
2642 do {
2643 if (bpage->page == (void *)addr) {
2644 local_dec(&bpage->entries);
2645 return;
2646 }
2647 rb_inc_page(cpu_buffer, &bpage);
2648 } while (bpage != start);
2649
2650 /* commit not part of this buffer?? */
2651 RB_WARN_ON(cpu_buffer, 1);
2652}
2653
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002654/**
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002655 * ring_buffer_commit_discard - discard an event that has not been committed
2656 * @buffer: the ring buffer
2657 * @event: non committed event to discard
2658 *
Steven Rostedtdc892f72009-09-03 15:33:41 -04002659 * Sometimes an event that is in the ring buffer needs to be ignored.
2660 * This function lets the user discard an event in the ring buffer
2661 * and then that event will not be read later.
2662 *
2663 * This function only works if it is called before the the item has been
2664 * committed. It will try to free the event from the ring buffer
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002665 * if another event has not been added behind it.
2666 *
2667 * If another event has been added behind it, it will set the event
2668 * up as discarded, and perform the commit.
2669 *
2670 * If this function is called, do not call ring_buffer_unlock_commit on
2671 * the event.
2672 */
2673void ring_buffer_discard_commit(struct ring_buffer *buffer,
2674 struct ring_buffer_event *event)
2675{
2676 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002677 int cpu;
2678
2679 /* The event is discarded regardless */
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002680 rb_event_discard(event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002681
Steven Rostedtfa743952009-06-16 12:37:57 -04002682 cpu = smp_processor_id();
2683 cpu_buffer = buffer->buffers[cpu];
2684
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002685 /*
2686 * This must only be called if the event has not been
2687 * committed yet. Thus we can assume that preemption
2688 * is still disabled.
2689 */
Steven Rostedtfa743952009-06-16 12:37:57 -04002690 RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002691
Steven Rostedta1863c22009-09-03 10:23:58 -04002692 rb_decrement_entry(cpu_buffer, event);
Steven Rostedt0f2541d2009-08-05 12:02:48 -04002693 if (rb_try_to_discard(cpu_buffer, event))
Steven Rostedtedd813bf2009-06-02 23:00:53 -04002694 goto out;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002695
2696 /*
2697 * The commit is still visible by the reader, so we
Steven Rostedta1863c22009-09-03 10:23:58 -04002698 * must still update the timestamp.
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002699 */
Steven Rostedta1863c22009-09-03 10:23:58 -04002700 rb_update_write_stamp(cpu_buffer, event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002701 out:
Steven Rostedtfa743952009-06-16 12:37:57 -04002702 rb_end_commit(cpu_buffer);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002703
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02002704 trace_recursive_unlock();
2705
Steven Rostedt5168ae52010-06-03 09:36:50 -04002706 preempt_enable_notrace();
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04002707
2708}
2709EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
2710
2711/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002712 * ring_buffer_write - write data to the buffer without reserving
2713 * @buffer: The ring buffer to write to.
2714 * @length: The length of the data being written (excluding the event header)
2715 * @data: The data to write to the buffer.
2716 *
2717 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
2718 * one function. If you already have the data to write to the buffer, it
2719 * may be easier to simply call this function.
2720 *
2721 * Note, like ring_buffer_lock_reserve, the length is the length of the data
2722 * and not the length of the event which would hold the header.
2723 */
2724int ring_buffer_write(struct ring_buffer *buffer,
2725 unsigned long length,
2726 void *data)
2727{
2728 struct ring_buffer_per_cpu *cpu_buffer;
2729 struct ring_buffer_event *event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002730 void *body;
2731 int ret = -EBUSY;
Steven Rostedt5168ae52010-06-03 09:36:50 -04002732 int cpu;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002733
Steven Rostedt033601a2008-11-21 12:41:55 -05002734 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05002735 return -EBUSY;
2736
Steven Rostedt5168ae52010-06-03 09:36:50 -04002737 preempt_disable_notrace();
Steven Rostedtbf41a152008-10-04 02:00:59 -04002738
Lai Jiangshan52fbe9c2010-03-08 14:50:43 +08002739 if (atomic_read(&buffer->record_disabled))
2740 goto out;
2741
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002742 cpu = raw_smp_processor_id();
2743
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302744 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04002745 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002746
2747 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002748
2749 if (atomic_read(&cpu_buffer->record_disabled))
2750 goto out;
2751
Steven Rostedtbe957c42009-05-11 14:42:53 -04002752 if (length > BUF_MAX_DATA_SIZE)
2753 goto out;
2754
Steven Rostedt62f0b3e2009-09-04 14:11:34 -04002755 event = rb_reserve_next_event(buffer, cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002756 if (!event)
2757 goto out;
2758
2759 body = rb_event_data(event);
2760
2761 memcpy(body, data, length);
2762
2763 rb_commit(cpu_buffer, event);
2764
2765 ret = 0;
2766 out:
Steven Rostedt5168ae52010-06-03 09:36:50 -04002767 preempt_enable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002768
2769 return ret;
2770}
Robert Richterc4f50182008-12-11 16:49:22 +01002771EXPORT_SYMBOL_GPL(ring_buffer_write);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002772
Andrew Morton34a148b2009-01-09 12:27:09 -08002773static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtbf41a152008-10-04 02:00:59 -04002774{
2775 struct buffer_page *reader = cpu_buffer->reader_page;
Steven Rostedt77ae3652009-03-27 11:00:29 -04002776 struct buffer_page *head = rb_set_head_page(cpu_buffer);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002777 struct buffer_page *commit = cpu_buffer->commit_page;
2778
Steven Rostedt77ae3652009-03-27 11:00:29 -04002779 /* In case of error, head will be NULL */
2780 if (unlikely(!head))
2781 return 1;
2782
Steven Rostedtbf41a152008-10-04 02:00:59 -04002783 return reader->read == rb_page_commit(reader) &&
2784 (commit == reader ||
2785 (commit == head &&
2786 head->read == rb_page_commit(commit)));
2787}
2788
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002789/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002790 * ring_buffer_record_disable - stop all writes into the buffer
2791 * @buffer: The ring buffer to stop writes to.
2792 *
2793 * This prevents all writes to the buffer. Any attempt to write
2794 * to the buffer after this will fail and return NULL.
2795 *
2796 * The caller should call synchronize_sched() after this.
2797 */
2798void ring_buffer_record_disable(struct ring_buffer *buffer)
2799{
2800 atomic_inc(&buffer->record_disabled);
2801}
Robert Richterc4f50182008-12-11 16:49:22 +01002802EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002803
2804/**
2805 * ring_buffer_record_enable - enable writes to the buffer
2806 * @buffer: The ring buffer to enable writes
2807 *
2808 * Note, multiple disables will need the same number of enables
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05002809 * to truly enable the writing (much like preempt_disable).
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002810 */
2811void ring_buffer_record_enable(struct ring_buffer *buffer)
2812{
2813 atomic_dec(&buffer->record_disabled);
2814}
Robert Richterc4f50182008-12-11 16:49:22 +01002815EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002816
2817/**
Steven Rostedt499e5472012-02-22 15:50:28 -05002818 * ring_buffer_record_off - stop all writes into the buffer
2819 * @buffer: The ring buffer to stop writes to.
2820 *
2821 * This prevents all writes to the buffer. Any attempt to write
2822 * to the buffer after this will fail and return NULL.
2823 *
2824 * This is different than ring_buffer_record_disable() as
Wang Tianhong87abb3b2012-08-02 14:02:00 +08002825 * it works like an on/off switch, where as the disable() version
Steven Rostedt499e5472012-02-22 15:50:28 -05002826 * must be paired with a enable().
2827 */
2828void ring_buffer_record_off(struct ring_buffer *buffer)
2829{
2830 unsigned int rd;
2831 unsigned int new_rd;
2832
2833 do {
2834 rd = atomic_read(&buffer->record_disabled);
2835 new_rd = rd | RB_BUFFER_OFF;
2836 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
2837}
2838EXPORT_SYMBOL_GPL(ring_buffer_record_off);
2839
2840/**
2841 * ring_buffer_record_on - restart writes into the buffer
2842 * @buffer: The ring buffer to start writes to.
2843 *
2844 * This enables all writes to the buffer that was disabled by
2845 * ring_buffer_record_off().
2846 *
2847 * This is different than ring_buffer_record_enable() as
Wang Tianhong87abb3b2012-08-02 14:02:00 +08002848 * it works like an on/off switch, where as the enable() version
Steven Rostedt499e5472012-02-22 15:50:28 -05002849 * must be paired with a disable().
2850 */
2851void ring_buffer_record_on(struct ring_buffer *buffer)
2852{
2853 unsigned int rd;
2854 unsigned int new_rd;
2855
2856 do {
2857 rd = atomic_read(&buffer->record_disabled);
2858 new_rd = rd & ~RB_BUFFER_OFF;
2859 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
2860}
2861EXPORT_SYMBOL_GPL(ring_buffer_record_on);
2862
2863/**
2864 * ring_buffer_record_is_on - return true if the ring buffer can write
2865 * @buffer: The ring buffer to see if write is enabled
2866 *
2867 * Returns true if the ring buffer is in a state that it accepts writes.
2868 */
2869int ring_buffer_record_is_on(struct ring_buffer *buffer)
2870{
2871 return !atomic_read(&buffer->record_disabled);
2872}
2873
2874/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002875 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
2876 * @buffer: The ring buffer to stop writes to.
2877 * @cpu: The CPU buffer to stop
2878 *
2879 * This prevents all writes to the buffer. Any attempt to write
2880 * to the buffer after this will fail and return NULL.
2881 *
2882 * The caller should call synchronize_sched() after this.
2883 */
2884void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
2885{
2886 struct ring_buffer_per_cpu *cpu_buffer;
2887
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302888 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002889 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002890
2891 cpu_buffer = buffer->buffers[cpu];
2892 atomic_inc(&cpu_buffer->record_disabled);
2893}
Robert Richterc4f50182008-12-11 16:49:22 +01002894EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002895
2896/**
2897 * ring_buffer_record_enable_cpu - enable writes to the buffer
2898 * @buffer: The ring buffer to enable writes
2899 * @cpu: The CPU to enable.
2900 *
2901 * Note, multiple disables will need the same number of enables
Adam Buchbinderc41b20e2009-12-11 16:35:39 -05002902 * to truly enable the writing (much like preempt_disable).
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002903 */
2904void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
2905{
2906 struct ring_buffer_per_cpu *cpu_buffer;
2907
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302908 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002909 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002910
2911 cpu_buffer = buffer->buffers[cpu];
2912 atomic_dec(&cpu_buffer->record_disabled);
2913}
Robert Richterc4f50182008-12-11 16:49:22 +01002914EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002915
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002916/*
2917 * The total entries in the ring buffer is the running counter
2918 * of entries entered into the ring buffer, minus the sum of
2919 * the entries read from the ring buffer and the number of
2920 * entries that were overwritten.
2921 */
2922static inline unsigned long
2923rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
2924{
2925 return local_read(&cpu_buffer->entries) -
2926 (local_read(&cpu_buffer->overrun) + cpu_buffer->read);
2927}
2928
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002929/**
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002930 * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
2931 * @buffer: The ring buffer
2932 * @cpu: The per CPU buffer to read from.
2933 */
2934unsigned long ring_buffer_oldest_event_ts(struct ring_buffer *buffer, int cpu)
2935{
2936 unsigned long flags;
2937 struct ring_buffer_per_cpu *cpu_buffer;
2938 struct buffer_page *bpage;
Steven Rostedt54f7be52012-11-29 22:27:22 -05002939 unsigned long ret = 0;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002940
2941 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2942 return 0;
2943
2944 cpu_buffer = buffer->buffers[cpu];
Linus Torvalds7115e3f2011-10-26 17:03:38 +02002945 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002946 /*
2947 * if the tail is on reader_page, oldest time stamp is on the reader
2948 * page
2949 */
2950 if (cpu_buffer->tail_page == cpu_buffer->reader_page)
2951 bpage = cpu_buffer->reader_page;
2952 else
2953 bpage = rb_set_head_page(cpu_buffer);
Steven Rostedt54f7be52012-11-29 22:27:22 -05002954 if (bpage)
2955 ret = bpage->page->time_stamp;
Linus Torvalds7115e3f2011-10-26 17:03:38 +02002956 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07002957
2958 return ret;
2959}
2960EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
2961
2962/**
2963 * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
2964 * @buffer: The ring buffer
2965 * @cpu: The per CPU buffer to read from.
2966 */
2967unsigned long ring_buffer_bytes_cpu(struct ring_buffer *buffer, int cpu)
2968{
2969 struct ring_buffer_per_cpu *cpu_buffer;
2970 unsigned long ret;
2971
2972 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2973 return 0;
2974
2975 cpu_buffer = buffer->buffers[cpu];
2976 ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
2977
2978 return ret;
2979}
2980EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
2981
2982/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002983 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
2984 * @buffer: The ring buffer
2985 * @cpu: The per CPU buffer to get the entries from.
2986 */
2987unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
2988{
2989 struct ring_buffer_per_cpu *cpu_buffer;
2990
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302991 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002992 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002993
2994 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04002995
Steven Rostedtf6195aa2010-09-01 12:23:12 -04002996 return rb_num_of_entries(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002997}
Robert Richterc4f50182008-12-11 16:49:22 +01002998EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002999
3000/**
3001 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
3002 * @buffer: The ring buffer
3003 * @cpu: The per CPU buffer to get the number of overruns from
3004 */
3005unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
3006{
3007 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003008 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003009
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303010 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003011 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003012
3013 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04003014 ret = local_read(&cpu_buffer->overrun);
Steven Rostedt554f7862009-03-11 22:00:13 -04003015
3016 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003017}
Robert Richterc4f50182008-12-11 16:49:22 +01003018EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003019
3020/**
Steven Rostedtf0d2c682009-04-29 13:43:37 -04003021 * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
3022 * @buffer: The ring buffer
3023 * @cpu: The per CPU buffer to get the number of overruns from
3024 */
3025unsigned long
3026ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
3027{
3028 struct ring_buffer_per_cpu *cpu_buffer;
3029 unsigned long ret;
3030
3031 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3032 return 0;
3033
3034 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04003035 ret = local_read(&cpu_buffer->commit_overrun);
Steven Rostedtf0d2c682009-04-29 13:43:37 -04003036
3037 return ret;
3038}
3039EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
3040
3041/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003042 * ring_buffer_entries - get the number of entries in a buffer
3043 * @buffer: The ring buffer
3044 *
3045 * Returns the total number of entries in the ring buffer
3046 * (all CPU entries)
3047 */
3048unsigned long ring_buffer_entries(struct ring_buffer *buffer)
3049{
3050 struct ring_buffer_per_cpu *cpu_buffer;
3051 unsigned long entries = 0;
3052 int cpu;
3053
3054 /* if you care about this being correct, lock the buffer */
3055 for_each_buffer_cpu(buffer, cpu) {
3056 cpu_buffer = buffer->buffers[cpu];
Steven Rostedtf6195aa2010-09-01 12:23:12 -04003057 entries += rb_num_of_entries(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003058 }
3059
3060 return entries;
3061}
Robert Richterc4f50182008-12-11 16:49:22 +01003062EXPORT_SYMBOL_GPL(ring_buffer_entries);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003063
3064/**
Jiri Olsa67b394f2009-10-23 19:36:18 -04003065 * ring_buffer_overruns - get the number of overruns in buffer
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003066 * @buffer: The ring buffer
3067 *
3068 * Returns the total number of overruns in the ring buffer
3069 * (all CPU entries)
3070 */
3071unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
3072{
3073 struct ring_buffer_per_cpu *cpu_buffer;
3074 unsigned long overruns = 0;
3075 int cpu;
3076
3077 /* if you care about this being correct, lock the buffer */
3078 for_each_buffer_cpu(buffer, cpu) {
3079 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt77ae3652009-03-27 11:00:29 -04003080 overruns += local_read(&cpu_buffer->overrun);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003081 }
3082
3083 return overruns;
3084}
Robert Richterc4f50182008-12-11 16:49:22 +01003085EXPORT_SYMBOL_GPL(ring_buffer_overruns);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003086
Steven Rostedt642edba2008-11-12 00:01:26 -05003087static void rb_iter_reset(struct ring_buffer_iter *iter)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003088{
3089 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3090
Steven Rostedtd7690412008-10-01 00:29:53 -04003091 /* Iterator usage is expected to have record disabled */
3092 if (list_empty(&cpu_buffer->reader_page->list)) {
Steven Rostedt77ae3652009-03-27 11:00:29 -04003093 iter->head_page = rb_set_head_page(cpu_buffer);
3094 if (unlikely(!iter->head_page))
3095 return;
3096 iter->head = iter->head_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04003097 } else {
3098 iter->head_page = cpu_buffer->reader_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003099 iter->head = cpu_buffer->reader_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04003100 }
3101 if (iter->head)
3102 iter->read_stamp = cpu_buffer->read_stamp;
3103 else
Steven Rostedtabc9b562008-12-02 15:34:06 -05003104 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt492a74f2010-01-25 15:17:47 -05003105 iter->cache_reader_page = cpu_buffer->reader_page;
3106 iter->cache_read = cpu_buffer->read;
Steven Rostedt642edba2008-11-12 00:01:26 -05003107}
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003108
Steven Rostedt642edba2008-11-12 00:01:26 -05003109/**
3110 * ring_buffer_iter_reset - reset an iterator
3111 * @iter: The iterator to reset
3112 *
3113 * Resets the iterator, so that it will start from the beginning
3114 * again.
3115 */
3116void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
3117{
Steven Rostedt554f7862009-03-11 22:00:13 -04003118 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt642edba2008-11-12 00:01:26 -05003119 unsigned long flags;
3120
Steven Rostedt554f7862009-03-11 22:00:13 -04003121 if (!iter)
3122 return;
3123
3124 cpu_buffer = iter->cpu_buffer;
3125
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003126 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt642edba2008-11-12 00:01:26 -05003127 rb_iter_reset(iter);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003128 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003129}
Robert Richterc4f50182008-12-11 16:49:22 +01003130EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003131
3132/**
3133 * ring_buffer_iter_empty - check if an iterator has no more to read
3134 * @iter: The iterator to check
3135 */
3136int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
3137{
3138 struct ring_buffer_per_cpu *cpu_buffer;
3139
3140 cpu_buffer = iter->cpu_buffer;
3141
Steven Rostedtbf41a152008-10-04 02:00:59 -04003142 return iter->head_page == cpu_buffer->commit_page &&
3143 iter->head == rb_commit_index(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003144}
Robert Richterc4f50182008-12-11 16:49:22 +01003145EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003146
3147static void
3148rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
3149 struct ring_buffer_event *event)
3150{
3151 u64 delta;
3152
Lai Jiangshan334d4162009-04-24 11:27:05 +08003153 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003154 case RINGBUF_TYPE_PADDING:
3155 return;
3156
3157 case RINGBUF_TYPE_TIME_EXTEND:
3158 delta = event->array[0];
3159 delta <<= TS_SHIFT;
3160 delta += event->time_delta;
3161 cpu_buffer->read_stamp += delta;
3162 return;
3163
3164 case RINGBUF_TYPE_TIME_STAMP:
3165 /* FIXME: not implemented */
3166 return;
3167
3168 case RINGBUF_TYPE_DATA:
3169 cpu_buffer->read_stamp += event->time_delta;
3170 return;
3171
3172 default:
3173 BUG();
3174 }
3175 return;
3176}
3177
3178static void
3179rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
3180 struct ring_buffer_event *event)
3181{
3182 u64 delta;
3183
Lai Jiangshan334d4162009-04-24 11:27:05 +08003184 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003185 case RINGBUF_TYPE_PADDING:
3186 return;
3187
3188 case RINGBUF_TYPE_TIME_EXTEND:
3189 delta = event->array[0];
3190 delta <<= TS_SHIFT;
3191 delta += event->time_delta;
3192 iter->read_stamp += delta;
3193 return;
3194
3195 case RINGBUF_TYPE_TIME_STAMP:
3196 /* FIXME: not implemented */
3197 return;
3198
3199 case RINGBUF_TYPE_DATA:
3200 iter->read_stamp += event->time_delta;
3201 return;
3202
3203 default:
3204 BUG();
3205 }
3206 return;
3207}
3208
Steven Rostedtd7690412008-10-01 00:29:53 -04003209static struct buffer_page *
3210rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003211{
Steven Rostedtd7690412008-10-01 00:29:53 -04003212 struct buffer_page *reader = NULL;
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003213 unsigned long overwrite;
Steven Rostedtd7690412008-10-01 00:29:53 -04003214 unsigned long flags;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003215 int nr_loops = 0;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003216 int ret;
Steven Rostedtd7690412008-10-01 00:29:53 -04003217
Steven Rostedt3e03fb72008-11-06 00:09:43 -05003218 local_irq_save(flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003219 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedtd7690412008-10-01 00:29:53 -04003220
3221 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003222 /*
3223 * This should normally only loop twice. But because the
3224 * start of the reader inserts an empty page, it causes
3225 * a case where we will loop three times. There should be no
3226 * reason to loop four times (that I know of).
3227 */
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05003228 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003229 reader = NULL;
3230 goto out;
3231 }
3232
Steven Rostedtd7690412008-10-01 00:29:53 -04003233 reader = cpu_buffer->reader_page;
3234
3235 /* If there's more to read, return this page */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003236 if (cpu_buffer->reader_page->read < rb_page_size(reader))
Steven Rostedtd7690412008-10-01 00:29:53 -04003237 goto out;
3238
3239 /* Never should we have an index greater than the size */
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05003240 if (RB_WARN_ON(cpu_buffer,
3241 cpu_buffer->reader_page->read > rb_page_size(reader)))
3242 goto out;
Steven Rostedtd7690412008-10-01 00:29:53 -04003243
3244 /* check if we caught up to the tail */
3245 reader = NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003246 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
Steven Rostedtd7690412008-10-01 00:29:53 -04003247 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003248
Steven Rostedta5fb8332012-06-28 13:35:04 -04003249 /* Don't bother swapping if the ring buffer is empty */
3250 if (rb_num_of_entries(cpu_buffer) == 0)
3251 goto out;
3252
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003253 /*
Steven Rostedtd7690412008-10-01 00:29:53 -04003254 * Reset the reader page to size zero.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003255 */
Steven Rostedt77ae3652009-03-27 11:00:29 -04003256 local_set(&cpu_buffer->reader_page->write, 0);
3257 local_set(&cpu_buffer->reader_page->entries, 0);
3258 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedtff0ff842010-03-31 22:11:42 -04003259 cpu_buffer->reader_page->real_end = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003260
Steven Rostedt77ae3652009-03-27 11:00:29 -04003261 spin:
3262 /*
3263 * Splice the empty reader page into the list around the head.
3264 */
3265 reader = rb_set_head_page(cpu_buffer);
Steven Rostedt54f7be52012-11-29 22:27:22 -05003266 if (!reader)
3267 goto out;
Steven Rostedt0e1ff5d2010-01-06 20:40:44 -05003268 cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
Steven Rostedtd7690412008-10-01 00:29:53 -04003269 cpu_buffer->reader_page->list.prev = reader->list.prev;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003270
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003271 /*
3272 * cpu_buffer->pages just needs to point to the buffer, it
3273 * has no specific buffer page to point to. Lets move it out
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003274 * of our way so we don't accidentally swap it.
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003275 */
3276 cpu_buffer->pages = reader->list.prev;
3277
Steven Rostedt77ae3652009-03-27 11:00:29 -04003278 /* The reader page will be pointing to the new head */
3279 rb_set_list_to_head(cpu_buffer, &cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -04003280
3281 /*
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003282 * We want to make sure we read the overruns after we set up our
3283 * pointers to the next object. The writer side does a
3284 * cmpxchg to cross pages which acts as the mb on the writer
3285 * side. Note, the reader will constantly fail the swap
3286 * while the writer is updating the pointers, so this
3287 * guarantees that the overwrite recorded here is the one we
3288 * want to compare with the last_overrun.
3289 */
3290 smp_mb();
3291 overwrite = local_read(&(cpu_buffer->overrun));
3292
3293 /*
Steven Rostedt77ae3652009-03-27 11:00:29 -04003294 * Here's the tricky part.
3295 *
3296 * We need to move the pointer past the header page.
3297 * But we can only do that if a writer is not currently
3298 * moving it. The page before the header page has the
3299 * flag bit '1' set if it is pointing to the page we want.
3300 * but if the writer is in the process of moving it
3301 * than it will be '2' or already moved '0'.
Steven Rostedtd7690412008-10-01 00:29:53 -04003302 */
Steven Rostedtd7690412008-10-01 00:29:53 -04003303
Steven Rostedt77ae3652009-03-27 11:00:29 -04003304 ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
3305
3306 /*
3307 * If we did not convert it, then we must try again.
3308 */
3309 if (!ret)
3310 goto spin;
3311
3312 /*
3313 * Yeah! We succeeded in replacing the page.
3314 *
3315 * Now make the new head point back to the reader page.
3316 */
David Sharp5ded3dc62010-01-06 17:12:07 -08003317 rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003318 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
Steven Rostedtd7690412008-10-01 00:29:53 -04003319
3320 /* Finally update the reader page to the new head */
3321 cpu_buffer->reader_page = reader;
3322 rb_reset_reader_page(cpu_buffer);
3323
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003324 if (overwrite != cpu_buffer->last_overrun) {
3325 cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
3326 cpu_buffer->last_overrun = overwrite;
3327 }
3328
Steven Rostedtd7690412008-10-01 00:29:53 -04003329 goto again;
3330
3331 out:
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003332 arch_spin_unlock(&cpu_buffer->lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05003333 local_irq_restore(flags);
Steven Rostedtd7690412008-10-01 00:29:53 -04003334
3335 return reader;
3336}
3337
3338static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
3339{
3340 struct ring_buffer_event *event;
3341 struct buffer_page *reader;
3342 unsigned length;
3343
3344 reader = rb_get_reader_page(cpu_buffer);
3345
3346 /* This function should not be called when buffer is empty */
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05003347 if (RB_WARN_ON(cpu_buffer, !reader))
3348 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04003349
3350 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003351
Steven Rostedta1863c22009-09-03 10:23:58 -04003352 if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Steven Rostedte4906ef2009-04-30 20:49:44 -04003353 cpu_buffer->read++;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003354
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003355 rb_update_read_stamp(cpu_buffer, event);
3356
Steven Rostedtd7690412008-10-01 00:29:53 -04003357 length = rb_event_length(event);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003358 cpu_buffer->reader_page->read += length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003359}
3360
3361static void rb_advance_iter(struct ring_buffer_iter *iter)
3362{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003363 struct ring_buffer_per_cpu *cpu_buffer;
3364 struct ring_buffer_event *event;
3365 unsigned length;
3366
3367 cpu_buffer = iter->cpu_buffer;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003368
3369 /*
3370 * Check if we are at the end of the buffer.
3371 */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003372 if (iter->head >= rb_page_size(iter->head_page)) {
Steven Rostedtea05b572009-06-03 09:30:10 -04003373 /* discarded commits can make the page empty */
3374 if (iter->head_page == cpu_buffer->commit_page)
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05003375 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04003376 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003377 return;
3378 }
3379
3380 event = rb_iter_head_event(iter);
3381
3382 length = rb_event_length(event);
3383
3384 /*
3385 * This should not be called to advance the header if we are
3386 * at the tail of the buffer.
3387 */
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05003388 if (RB_WARN_ON(cpu_buffer,
Steven Rostedtf536aaf2008-11-10 23:07:30 -05003389 (iter->head_page == cpu_buffer->commit_page) &&
Steven Rostedt3e89c7bb2008-11-11 15:28:41 -05003390 (iter->head + length > rb_commit_index(cpu_buffer))))
3391 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003392
3393 rb_update_iter_read_stamp(iter, event);
3394
3395 iter->head += length;
3396
3397 /* check for end of page padding */
Steven Rostedtbf41a152008-10-04 02:00:59 -04003398 if ((iter->head >= rb_page_size(iter->head_page)) &&
3399 (iter->head_page != cpu_buffer->commit_page))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003400 rb_advance_iter(iter);
3401}
3402
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003403static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
3404{
3405 return cpu_buffer->lost_events;
3406}
3407
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003408static struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003409rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
3410 unsigned long *lost_events)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003411{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003412 struct ring_buffer_event *event;
Steven Rostedtd7690412008-10-01 00:29:53 -04003413 struct buffer_page *reader;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003414 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003415
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003416 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003417 /*
Steven Rostedt69d1b832010-10-07 18:18:05 -04003418 * We repeat when a time extend is encountered.
3419 * Since the time extend is always attached to a data event,
3420 * we should never loop more than once.
3421 * (We never hit the following condition more than twice).
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003422 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04003423 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003424 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003425
Steven Rostedtd7690412008-10-01 00:29:53 -04003426 reader = rb_get_reader_page(cpu_buffer);
3427 if (!reader)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003428 return NULL;
3429
Steven Rostedtd7690412008-10-01 00:29:53 -04003430 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003431
Lai Jiangshan334d4162009-04-24 11:27:05 +08003432 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003433 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05003434 if (rb_null_event(event))
3435 RB_WARN_ON(cpu_buffer, 1);
3436 /*
3437 * Because the writer could be discarding every
3438 * event it creates (which would probably be bad)
3439 * if we were to go back to "again" then we may never
3440 * catch up, and will trigger the warn on, or lock
3441 * the box. Return the padding, and we will release
3442 * the current locks, and try again.
3443 */
Tom Zanussi2d622712009-03-22 03:30:49 -05003444 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003445
3446 case RINGBUF_TYPE_TIME_EXTEND:
3447 /* Internal data, OK to advance */
Steven Rostedtd7690412008-10-01 00:29:53 -04003448 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003449 goto again;
3450
3451 case RINGBUF_TYPE_TIME_STAMP:
3452 /* FIXME: not implemented */
Steven Rostedtd7690412008-10-01 00:29:53 -04003453 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003454 goto again;
3455
3456 case RINGBUF_TYPE_DATA:
3457 if (ts) {
3458 *ts = cpu_buffer->read_stamp + event->time_delta;
Robert Richterd8eeb2d2009-07-31 14:58:04 +02003459 ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
Steven Rostedt37886f62009-03-17 17:22:06 -04003460 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003461 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003462 if (lost_events)
3463 *lost_events = rb_lost_events(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003464 return event;
3465
3466 default:
3467 BUG();
3468 }
3469
3470 return NULL;
3471}
Robert Richterc4f50182008-12-11 16:49:22 +01003472EXPORT_SYMBOL_GPL(ring_buffer_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003473
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003474static struct ring_buffer_event *
3475rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003476{
3477 struct ring_buffer *buffer;
3478 struct ring_buffer_per_cpu *cpu_buffer;
3479 struct ring_buffer_event *event;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003480 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003481
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003482 cpu_buffer = iter->cpu_buffer;
3483 buffer = cpu_buffer->buffer;
3484
Steven Rostedt492a74f2010-01-25 15:17:47 -05003485 /*
3486 * Check if someone performed a consuming read to
3487 * the buffer. A consuming read invalidates the iterator
3488 * and we need to reset the iterator in this case.
3489 */
3490 if (unlikely(iter->cache_read != cpu_buffer->read ||
3491 iter->cache_reader_page != cpu_buffer->reader_page))
3492 rb_iter_reset(iter);
3493
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003494 again:
Steven Rostedt3c05d742010-01-26 16:14:08 -05003495 if (ring_buffer_iter_empty(iter))
3496 return NULL;
3497
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003498 /*
Steven Rostedt69d1b832010-10-07 18:18:05 -04003499 * We repeat when a time extend is encountered.
3500 * Since the time extend is always attached to a data event,
3501 * we should never loop more than once.
3502 * (We never hit the following condition more than twice).
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003503 */
Steven Rostedt69d1b832010-10-07 18:18:05 -04003504 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003505 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04003506
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003507 if (rb_per_cpu_empty(cpu_buffer))
3508 return NULL;
3509
Steven Rostedt3c05d742010-01-26 16:14:08 -05003510 if (iter->head >= local_read(&iter->head_page->page->commit)) {
3511 rb_inc_iter(iter);
3512 goto again;
3513 }
3514
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003515 event = rb_iter_head_event(iter);
3516
Lai Jiangshan334d4162009-04-24 11:27:05 +08003517 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003518 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05003519 if (rb_null_event(event)) {
3520 rb_inc_iter(iter);
3521 goto again;
3522 }
3523 rb_advance_iter(iter);
3524 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003525
3526 case RINGBUF_TYPE_TIME_EXTEND:
3527 /* Internal data, OK to advance */
3528 rb_advance_iter(iter);
3529 goto again;
3530
3531 case RINGBUF_TYPE_TIME_STAMP:
3532 /* FIXME: not implemented */
3533 rb_advance_iter(iter);
3534 goto again;
3535
3536 case RINGBUF_TYPE_DATA:
3537 if (ts) {
3538 *ts = iter->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04003539 ring_buffer_normalize_time_stamp(buffer,
3540 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003541 }
3542 return event;
3543
3544 default:
3545 BUG();
3546 }
3547
3548 return NULL;
3549}
Robert Richterc4f50182008-12-11 16:49:22 +01003550EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003551
Steven Rostedt8d707e82009-06-16 21:22:48 -04003552static inline int rb_ok_to_lock(void)
3553{
3554 /*
3555 * If an NMI die dumps out the content of the ring buffer
3556 * do not grab locks. We also permanently disable the ring
3557 * buffer too. A one time deal is all you get from reading
3558 * the ring buffer from an NMI.
3559 */
Steven Rostedt464e85e2009-08-05 15:26:37 -04003560 if (likely(!in_nmi()))
Steven Rostedt8d707e82009-06-16 21:22:48 -04003561 return 1;
3562
3563 tracing_off_permanent();
3564 return 0;
3565}
3566
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003567/**
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003568 * ring_buffer_peek - peek at the next event to be read
3569 * @buffer: The ring buffer to read
3570 * @cpu: The cpu to peak at
3571 * @ts: The timestamp counter of this event.
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003572 * @lost_events: a variable to store if events were lost (may be NULL)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003573 *
3574 * This will return the event that will be read next, but does
3575 * not consume the data.
3576 */
3577struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003578ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts,
3579 unsigned long *lost_events)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003580{
3581 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8aabee52009-03-12 13:13:49 -04003582 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003583 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003584 int dolock;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003585
Steven Rostedt554f7862009-03-11 22:00:13 -04003586 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003587 return NULL;
Steven Rostedt554f7862009-03-11 22:00:13 -04003588
Steven Rostedt8d707e82009-06-16 21:22:48 -04003589 dolock = rb_ok_to_lock();
Tom Zanussi2d622712009-03-22 03:30:49 -05003590 again:
Steven Rostedt8d707e82009-06-16 21:22:48 -04003591 local_irq_save(flags);
3592 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003593 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003594 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
Robert Richter469535a2009-07-30 19:19:18 +02003595 if (event && event->type_len == RINGBUF_TYPE_PADDING)
3596 rb_advance_reader(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003597 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003598 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003599 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003600
Steven Rostedt1b959e12009-09-03 10:12:13 -04003601 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003602 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003603
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003604 return event;
3605}
3606
3607/**
3608 * ring_buffer_iter_peek - peek at the next event to be read
3609 * @iter: The ring buffer iterator
3610 * @ts: The timestamp counter of this event.
3611 *
3612 * This will return the event that will be read next, but does
3613 * not increment the iterator.
3614 */
3615struct ring_buffer_event *
3616ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
3617{
3618 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3619 struct ring_buffer_event *event;
3620 unsigned long flags;
3621
Tom Zanussi2d622712009-03-22 03:30:49 -05003622 again:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003623 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003624 event = rb_iter_peek(iter, ts);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003625 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003626
Steven Rostedt1b959e12009-09-03 10:12:13 -04003627 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003628 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003629
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003630 return event;
3631}
3632
3633/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003634 * ring_buffer_consume - return an event and consume it
3635 * @buffer: The ring buffer to get the next event from
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003636 * @cpu: the cpu to read the buffer from
3637 * @ts: a variable to store the timestamp (may be NULL)
3638 * @lost_events: a variable to store if events were lost (may be NULL)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003639 *
3640 * Returns the next event in the ring buffer, and that event is consumed.
3641 * Meaning, that sequential reads will keep returning a different event,
3642 * and eventually empty the ring buffer if the producer is slower.
3643 */
3644struct ring_buffer_event *
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003645ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts,
3646 unsigned long *lost_events)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003647{
Steven Rostedt554f7862009-03-11 22:00:13 -04003648 struct ring_buffer_per_cpu *cpu_buffer;
3649 struct ring_buffer_event *event = NULL;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003650 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003651 int dolock;
3652
3653 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003654
Tom Zanussi2d622712009-03-22 03:30:49 -05003655 again:
Steven Rostedt554f7862009-03-11 22:00:13 -04003656 /* might be called in atomic */
3657 preempt_disable();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003658
Steven Rostedt554f7862009-03-11 22:00:13 -04003659 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3660 goto out;
3661
3662 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003663 local_irq_save(flags);
3664 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003665 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003666
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003667 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
3668 if (event) {
3669 cpu_buffer->lost_events = 0;
Robert Richter469535a2009-07-30 19:19:18 +02003670 rb_advance_reader(cpu_buffer);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003671 }
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003672
Steven Rostedt8d707e82009-06-16 21:22:48 -04003673 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003674 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003675 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003676
Steven Rostedt554f7862009-03-11 22:00:13 -04003677 out:
3678 preempt_enable();
3679
Steven Rostedt1b959e12009-09-03 10:12:13 -04003680 if (event && event->type_len == RINGBUF_TYPE_PADDING)
Tom Zanussi2d622712009-03-22 03:30:49 -05003681 goto again;
Tom Zanussi2d622712009-03-22 03:30:49 -05003682
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003683 return event;
3684}
Robert Richterc4f50182008-12-11 16:49:22 +01003685EXPORT_SYMBOL_GPL(ring_buffer_consume);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003686
3687/**
David Miller72c9ddf2010-04-20 15:47:11 -07003688 * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003689 * @buffer: The ring buffer to read from
3690 * @cpu: The cpu buffer to iterate over
3691 *
David Miller72c9ddf2010-04-20 15:47:11 -07003692 * This performs the initial preparations necessary to iterate
3693 * through the buffer. Memory is allocated, buffer recording
3694 * is disabled, and the iterator pointer is returned to the caller.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003695 *
David Miller72c9ddf2010-04-20 15:47:11 -07003696 * Disabling buffer recordng prevents the reading from being
3697 * corrupted. This is not a consuming read, so a producer is not
3698 * expected.
3699 *
3700 * After a sequence of ring_buffer_read_prepare calls, the user is
3701 * expected to make at least one call to ring_buffer_prepare_sync.
3702 * Afterwards, ring_buffer_read_start is invoked to get things going
3703 * for real.
3704 *
3705 * This overall must be paired with ring_buffer_finish.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003706 */
3707struct ring_buffer_iter *
David Miller72c9ddf2010-04-20 15:47:11 -07003708ring_buffer_read_prepare(struct ring_buffer *buffer, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003709{
3710 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003711 struct ring_buffer_iter *iter;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003712
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303713 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003714 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003715
3716 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
3717 if (!iter)
Steven Rostedt8aabee52009-03-12 13:13:49 -04003718 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003719
3720 cpu_buffer = buffer->buffers[cpu];
3721
3722 iter->cpu_buffer = cpu_buffer;
3723
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003724 atomic_inc(&buffer->resize_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003725 atomic_inc(&cpu_buffer->record_disabled);
David Miller72c9ddf2010-04-20 15:47:11 -07003726
3727 return iter;
3728}
3729EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);
3730
3731/**
3732 * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
3733 *
3734 * All previously invoked ring_buffer_read_prepare calls to prepare
3735 * iterators will be synchronized. Afterwards, read_buffer_read_start
3736 * calls on those iterators are allowed.
3737 */
3738void
3739ring_buffer_read_prepare_sync(void)
3740{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003741 synchronize_sched();
David Miller72c9ddf2010-04-20 15:47:11 -07003742}
3743EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
3744
3745/**
3746 * ring_buffer_read_start - start a non consuming read of the buffer
3747 * @iter: The iterator returned by ring_buffer_read_prepare
3748 *
3749 * This finalizes the startup of an iteration through the buffer.
3750 * The iterator comes from a call to ring_buffer_read_prepare and
3751 * an intervening ring_buffer_read_prepare_sync must have been
3752 * performed.
3753 *
3754 * Must be paired with ring_buffer_finish.
3755 */
3756void
3757ring_buffer_read_start(struct ring_buffer_iter *iter)
3758{
3759 struct ring_buffer_per_cpu *cpu_buffer;
3760 unsigned long flags;
3761
3762 if (!iter)
3763 return;
3764
3765 cpu_buffer = iter->cpu_buffer;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003766
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003767 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003768 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedt642edba2008-11-12 00:01:26 -05003769 rb_iter_reset(iter);
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003770 arch_spin_unlock(&cpu_buffer->lock);
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003771 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003772}
Robert Richterc4f50182008-12-11 16:49:22 +01003773EXPORT_SYMBOL_GPL(ring_buffer_read_start);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003774
3775/**
3776 * ring_buffer_finish - finish reading the iterator of the buffer
3777 * @iter: The iterator retrieved by ring_buffer_start
3778 *
3779 * This re-enables the recording to the buffer, and frees the
3780 * iterator.
3781 */
3782void
3783ring_buffer_read_finish(struct ring_buffer_iter *iter)
3784{
3785 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3786
Steven Rostedt659f4512012-05-14 17:02:33 -04003787 /*
3788 * Ring buffer is disabled from recording, here's a good place
3789 * to check the integrity of the ring buffer.
3790 */
3791 rb_check_pages(cpu_buffer);
3792
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003793 atomic_dec(&cpu_buffer->record_disabled);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003794 atomic_dec(&cpu_buffer->buffer->resize_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003795 kfree(iter);
3796}
Robert Richterc4f50182008-12-11 16:49:22 +01003797EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003798
3799/**
3800 * ring_buffer_read - read the next item in the ring buffer by the iterator
3801 * @iter: The ring buffer iterator
3802 * @ts: The time stamp of the event read.
3803 *
3804 * This reads the next event in the ring buffer and increments the iterator.
3805 */
3806struct ring_buffer_event *
3807ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
3808{
3809 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003810 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
3811 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003812
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003813 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt7e9391c2009-09-03 10:02:09 -04003814 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003815 event = rb_iter_peek(iter, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003816 if (!event)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003817 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003818
Steven Rostedt7e9391c2009-09-03 10:02:09 -04003819 if (event->type_len == RINGBUF_TYPE_PADDING)
3820 goto again;
3821
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003822 rb_advance_iter(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003823 out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003824 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003825
3826 return event;
3827}
Robert Richterc4f50182008-12-11 16:49:22 +01003828EXPORT_SYMBOL_GPL(ring_buffer_read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003829
3830/**
3831 * ring_buffer_size - return the size of the ring buffer (in bytes)
3832 * @buffer: The ring buffer.
3833 */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08003834unsigned long ring_buffer_size(struct ring_buffer *buffer, int cpu)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003835{
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08003836 /*
3837 * Earlier, this method returned
3838 * BUF_PAGE_SIZE * buffer->nr_pages
3839 * Since the nr_pages field is now removed, we have converted this to
3840 * return the per cpu buffer value.
3841 */
3842 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3843 return 0;
3844
3845 return BUF_PAGE_SIZE * buffer->buffers[cpu]->nr_pages;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003846}
Robert Richterc4f50182008-12-11 16:49:22 +01003847EXPORT_SYMBOL_GPL(ring_buffer_size);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003848
3849static void
3850rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
3851{
Steven Rostedt77ae3652009-03-27 11:00:29 -04003852 rb_head_page_deactivate(cpu_buffer);
3853
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003854 cpu_buffer->head_page
Steven Rostedt3adc54f2009-03-30 15:32:01 -04003855 = list_entry(cpu_buffer->pages, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04003856 local_set(&cpu_buffer->head_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003857 local_set(&cpu_buffer->head_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05003858 local_set(&cpu_buffer->head_page->page->commit, 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003859
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003860 cpu_buffer->head_page->read = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04003861
3862 cpu_buffer->tail_page = cpu_buffer->head_page;
3863 cpu_buffer->commit_page = cpu_buffer->head_page;
3864
3865 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Vaibhav Nagarnaik5040b4b2012-05-03 18:59:51 -07003866 INIT_LIST_HEAD(&cpu_buffer->new_pages);
Steven Rostedtbf41a152008-10-04 02:00:59 -04003867 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003868 local_set(&cpu_buffer->reader_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05003869 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04003870 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04003871
Steven Rostedt77ae3652009-03-27 11:00:29 -04003872 local_set(&cpu_buffer->commit_overrun, 0);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07003873 local_set(&cpu_buffer->entries_bytes, 0);
Steven Rostedt77ae3652009-03-27 11:00:29 -04003874 local_set(&cpu_buffer->overrun, 0);
Steven Rostedte4906ef2009-04-30 20:49:44 -04003875 local_set(&cpu_buffer->entries, 0);
Steven Rostedtfa743952009-06-16 12:37:57 -04003876 local_set(&cpu_buffer->committing, 0);
3877 local_set(&cpu_buffer->commits, 0);
Steven Rostedt77ae3652009-03-27 11:00:29 -04003878 cpu_buffer->read = 0;
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07003879 cpu_buffer->read_bytes = 0;
Steven Rostedt69507c02009-01-21 18:45:57 -05003880
3881 cpu_buffer->write_stamp = 0;
3882 cpu_buffer->read_stamp = 0;
Steven Rostedt77ae3652009-03-27 11:00:29 -04003883
Steven Rostedt66a8cb92010-03-31 13:21:56 -04003884 cpu_buffer->lost_events = 0;
3885 cpu_buffer->last_overrun = 0;
3886
Steven Rostedt77ae3652009-03-27 11:00:29 -04003887 rb_head_page_activate(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003888}
3889
3890/**
3891 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
3892 * @buffer: The ring buffer to reset a per cpu buffer of
3893 * @cpu: The CPU buffer to be reset
3894 */
3895void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
3896{
3897 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
3898 unsigned long flags;
3899
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303900 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003901 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003902
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003903 atomic_inc(&buffer->resize_disabled);
Steven Rostedt41ede232009-05-01 20:26:54 -04003904 atomic_inc(&cpu_buffer->record_disabled);
3905
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003906 /* Make sure all commits have finished */
3907 synchronize_sched();
3908
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003909 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003910
Steven Rostedt41b6a952009-09-02 09:59:48 -04003911 if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
3912 goto out;
3913
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003914 arch_spin_lock(&cpu_buffer->lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003915
3916 rb_reset_cpu(cpu_buffer);
3917
Thomas Gleixner0199c4e2009-12-02 20:01:25 +01003918 arch_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01003919
Steven Rostedt41b6a952009-09-02 09:59:48 -04003920 out:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003921 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt41ede232009-05-01 20:26:54 -04003922
3923 atomic_dec(&cpu_buffer->record_disabled);
Vaibhav Nagarnaik83f40312012-05-03 18:59:50 -07003924 atomic_dec(&buffer->resize_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003925}
Robert Richterc4f50182008-12-11 16:49:22 +01003926EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003927
3928/**
3929 * ring_buffer_reset - reset a ring buffer
3930 * @buffer: The ring buffer to reset all cpu buffers
3931 */
3932void ring_buffer_reset(struct ring_buffer *buffer)
3933{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003934 int cpu;
3935
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003936 for_each_buffer_cpu(buffer, cpu)
Steven Rostedtd7690412008-10-01 00:29:53 -04003937 ring_buffer_reset_cpu(buffer, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003938}
Robert Richterc4f50182008-12-11 16:49:22 +01003939EXPORT_SYMBOL_GPL(ring_buffer_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003940
3941/**
3942 * rind_buffer_empty - is the ring buffer empty?
3943 * @buffer: The ring buffer to test
3944 */
3945int ring_buffer_empty(struct ring_buffer *buffer)
3946{
3947 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04003948 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003949 int dolock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003950 int cpu;
Steven Rostedtd4788202009-06-17 00:39:43 -04003951 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003952
Steven Rostedt8d707e82009-06-16 21:22:48 -04003953 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003954
3955 /* yes this is racy, but if you don't like the race, lock the buffer */
3956 for_each_buffer_cpu(buffer, cpu) {
3957 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003958 local_irq_save(flags);
3959 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003960 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedtd4788202009-06-17 00:39:43 -04003961 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003962 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003963 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003964 local_irq_restore(flags);
3965
Steven Rostedtd4788202009-06-17 00:39:43 -04003966 if (!ret)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003967 return 0;
3968 }
Steven Rostedt554f7862009-03-11 22:00:13 -04003969
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003970 return 1;
3971}
Robert Richterc4f50182008-12-11 16:49:22 +01003972EXPORT_SYMBOL_GPL(ring_buffer_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003973
3974/**
3975 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
3976 * @buffer: The ring buffer
3977 * @cpu: The CPU buffer to test
3978 */
3979int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
3980{
3981 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04003982 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04003983 int dolock;
Steven Rostedt8aabee52009-03-12 13:13:49 -04003984 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003985
Rusty Russell9e01c1b2009-01-01 10:12:22 +10303986 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04003987 return 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003988
Steven Rostedt8d707e82009-06-16 21:22:48 -04003989 dolock = rb_ok_to_lock();
Steven Rostedt554f7862009-03-11 22:00:13 -04003990
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04003991 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04003992 local_irq_save(flags);
3993 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003994 raw_spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt554f7862009-03-11 22:00:13 -04003995 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003996 if (dolock)
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02003997 raw_spin_unlock(&cpu_buffer->reader_lock);
Steven Rostedt8d707e82009-06-16 21:22:48 -04003998 local_irq_restore(flags);
Steven Rostedt554f7862009-03-11 22:00:13 -04003999
4000 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004001}
Robert Richterc4f50182008-12-11 16:49:22 +01004002EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004003
Steven Rostedt85bac322009-09-04 14:24:40 -04004004#ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004005/**
4006 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
4007 * @buffer_a: One buffer to swap with
4008 * @buffer_b: The other buffer to swap with
4009 *
4010 * This function is useful for tracers that want to take a "snapshot"
4011 * of a CPU buffer and has another back up buffer lying around.
4012 * it is expected that the tracer handles the cpu buffer not being
4013 * used at the moment.
4014 */
4015int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
4016 struct ring_buffer *buffer_b, int cpu)
4017{
4018 struct ring_buffer_per_cpu *cpu_buffer_a;
4019 struct ring_buffer_per_cpu *cpu_buffer_b;
Steven Rostedt554f7862009-03-11 22:00:13 -04004020 int ret = -EINVAL;
4021
Rusty Russell9e01c1b2009-01-01 10:12:22 +10304022 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
4023 !cpumask_test_cpu(cpu, buffer_b->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04004024 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004025
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004026 cpu_buffer_a = buffer_a->buffers[cpu];
4027 cpu_buffer_b = buffer_b->buffers[cpu];
4028
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004029 /* At least make sure the two buffers are somewhat the same */
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004030 if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages)
Steven Rostedt554f7862009-03-11 22:00:13 -04004031 goto out;
4032
4033 ret = -EAGAIN;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004034
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004035 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedt554f7862009-03-11 22:00:13 -04004036 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004037
4038 if (atomic_read(&buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004039 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004040
4041 if (atomic_read(&buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004042 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004043
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004044 if (atomic_read(&cpu_buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004045 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004046
4047 if (atomic_read(&cpu_buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04004048 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05004049
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004050 /*
4051 * We can't do a synchronize_sched here because this
4052 * function can be called in atomic context.
4053 * Normally this will be called from the same CPU as cpu.
4054 * If not it's up to the caller to protect this.
4055 */
4056 atomic_inc(&cpu_buffer_a->record_disabled);
4057 atomic_inc(&cpu_buffer_b->record_disabled);
4058
Steven Rostedt98277992009-09-02 10:56:15 -04004059 ret = -EBUSY;
4060 if (local_read(&cpu_buffer_a->committing))
4061 goto out_dec;
4062 if (local_read(&cpu_buffer_b->committing))
4063 goto out_dec;
4064
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004065 buffer_a->buffers[cpu] = cpu_buffer_b;
4066 buffer_b->buffers[cpu] = cpu_buffer_a;
4067
4068 cpu_buffer_b->buffer = buffer_a;
4069 cpu_buffer_a->buffer = buffer_b;
4070
Steven Rostedt98277992009-09-02 10:56:15 -04004071 ret = 0;
4072
4073out_dec:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004074 atomic_dec(&cpu_buffer_a->record_disabled);
4075 atomic_dec(&cpu_buffer_b->record_disabled);
Steven Rostedt554f7862009-03-11 22:00:13 -04004076out:
Steven Rostedt554f7862009-03-11 22:00:13 -04004077 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004078}
Robert Richterc4f50182008-12-11 16:49:22 +01004079EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
Steven Rostedt85bac322009-09-04 14:24:40 -04004080#endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04004081
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004082/**
4083 * ring_buffer_alloc_read_page - allocate a page to read from buffer
4084 * @buffer: the buffer to allocate for.
4085 *
4086 * This function is used in conjunction with ring_buffer_read_page.
4087 * When reading a full page from the ring buffer, these functions
4088 * can be used to speed up the process. The calling function should
4089 * allocate a few pages first with this function. Then when it
4090 * needs to get pages from the ring buffer, it passes the result
4091 * of this function into ring_buffer_read_page, which will swap
4092 * the page that was allocated, with the read page of the buffer.
4093 *
4094 * Returns:
4095 * The page allocated, or NULL on error.
4096 */
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004097void *ring_buffer_alloc_read_page(struct ring_buffer *buffer, int cpu)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004098{
Steven Rostedt044fa782008-12-02 23:50:03 -05004099 struct buffer_data_page *bpage;
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004100 struct page *page;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004101
Vaibhav Nagarnaikd7ec4bf2011-06-07 17:01:42 -07004102 page = alloc_pages_node(cpu_to_node(cpu),
4103 GFP_KERNEL | __GFP_NORETRY, 0);
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004104 if (!page)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004105 return NULL;
4106
Vaibhav Nagarnaik7ea59062011-05-03 17:56:42 -07004107 bpage = page_address(page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004108
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004109 rb_init_page(bpage);
4110
Steven Rostedt044fa782008-12-02 23:50:03 -05004111 return bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004112}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004113EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004114
4115/**
4116 * ring_buffer_free_read_page - free an allocated read page
4117 * @buffer: the buffer the page was allocate for
4118 * @data: the page to free
4119 *
4120 * Free a page allocated from ring_buffer_alloc_read_page.
4121 */
4122void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
4123{
4124 free_page((unsigned long)data);
4125}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004126EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004127
4128/**
4129 * ring_buffer_read_page - extract a page from the ring buffer
4130 * @buffer: buffer to extract from
4131 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004132 * @len: amount to extract
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004133 * @cpu: the cpu of the buffer to extract
4134 * @full: should the extraction only happen when the page is full.
4135 *
4136 * This function will pull out a page from the ring buffer and consume it.
4137 * @data_page must be the address of the variable that was returned
4138 * from ring_buffer_alloc_read_page. This is because the page might be used
4139 * to swap with a page in the ring buffer.
4140 *
4141 * for example:
Lai Jiangshanb85fa012009-02-09 14:21:14 +08004142 * rpage = ring_buffer_alloc_read_page(buffer);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004143 * if (!rpage)
4144 * return error;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004145 * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004146 * if (ret >= 0)
4147 * process_page(rpage, ret);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004148 *
4149 * When @full is set, the function will not return true unless
4150 * the writer is off the reader page.
4151 *
4152 * Note: it is up to the calling functions to handle sleeps and wakeups.
4153 * The ring buffer can be used anywhere in the kernel and can not
4154 * blindly call wake_up. The layer that uses the ring buffer must be
4155 * responsible for that.
4156 *
4157 * Returns:
Lai Jiangshan667d2412009-02-09 14:21:17 +08004158 * >=0 if data has been transferred, returns the offset of consumed data.
4159 * <0 if no data has been transferred.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004160 */
4161int ring_buffer_read_page(struct ring_buffer *buffer,
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004162 void **data_page, size_t len, int cpu, int full)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004163{
4164 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
4165 struct ring_buffer_event *event;
Steven Rostedt044fa782008-12-02 23:50:03 -05004166 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004167 struct buffer_page *reader;
Steven Rostedtff0ff842010-03-31 22:11:42 -04004168 unsigned long missed_events;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004169 unsigned long flags;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004170 unsigned int commit;
Lai Jiangshan667d2412009-02-09 14:21:17 +08004171 unsigned int read;
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004172 u64 save_timestamp;
Lai Jiangshan667d2412009-02-09 14:21:17 +08004173 int ret = -1;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004174
Steven Rostedt554f7862009-03-11 22:00:13 -04004175 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4176 goto out;
4177
Steven Rostedt474d32b2009-03-03 19:51:40 -05004178 /*
4179 * If len is not big enough to hold the page header, then
4180 * we can not copy anything.
4181 */
4182 if (len <= BUF_PAGE_HDR_SIZE)
Steven Rostedt554f7862009-03-11 22:00:13 -04004183 goto out;
Steven Rostedt474d32b2009-03-03 19:51:40 -05004184
4185 len -= BUF_PAGE_HDR_SIZE;
4186
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004187 if (!data_page)
Steven Rostedt554f7862009-03-11 22:00:13 -04004188 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004189
Steven Rostedt044fa782008-12-02 23:50:03 -05004190 bpage = *data_page;
4191 if (!bpage)
Steven Rostedt554f7862009-03-11 22:00:13 -04004192 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004193
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02004194 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004195
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004196 reader = rb_get_reader_page(cpu_buffer);
4197 if (!reader)
Steven Rostedt554f7862009-03-11 22:00:13 -04004198 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004199
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004200 event = rb_reader_event(cpu_buffer);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004201
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004202 read = reader->read;
4203 commit = rb_page_commit(reader);
4204
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004205 /* Check if any events were dropped */
Steven Rostedtff0ff842010-03-31 22:11:42 -04004206 missed_events = cpu_buffer->lost_events;
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004207
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004208 /*
Steven Rostedt474d32b2009-03-03 19:51:40 -05004209 * If this page has been partially read or
4210 * if len is not big enough to read the rest of the page or
4211 * a writer is still on the page, then
4212 * we must copy the data from the page to the buffer.
4213 * Otherwise, we can simply swap the page with the one passed in.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004214 */
Steven Rostedt474d32b2009-03-03 19:51:40 -05004215 if (read || (len < (commit - read)) ||
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004216 cpu_buffer->reader_page == cpu_buffer->commit_page) {
Lai Jiangshan667d2412009-02-09 14:21:17 +08004217 struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
Steven Rostedt474d32b2009-03-03 19:51:40 -05004218 unsigned int rpos = read;
4219 unsigned int pos = 0;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004220 unsigned int size;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004221
4222 if (full)
Steven Rostedt554f7862009-03-11 22:00:13 -04004223 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004224
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004225 if (len > (commit - read))
4226 len = (commit - read);
4227
Steven Rostedt69d1b832010-10-07 18:18:05 -04004228 /* Always keep the time extend and data together */
4229 size = rb_event_ts_length(event);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004230
4231 if (len < size)
Steven Rostedt554f7862009-03-11 22:00:13 -04004232 goto out_unlock;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004233
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004234 /* save the current timestamp, since the user will need it */
4235 save_timestamp = cpu_buffer->read_stamp;
4236
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004237 /* Need to copy one event at a time */
4238 do {
David Sharpe1e35922010-12-22 16:38:24 -08004239 /* We need the size of one event, because
4240 * rb_advance_reader only advances by one event,
4241 * whereas rb_event_ts_length may include the size of
4242 * one or two events.
4243 * We have already ensured there's enough space if this
4244 * is a time extend. */
4245 size = rb_event_length(event);
Steven Rostedt474d32b2009-03-03 19:51:40 -05004246 memcpy(bpage->data + pos, rpage->data + rpos, size);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004247
4248 len -= size;
4249
4250 rb_advance_reader(cpu_buffer);
Steven Rostedt474d32b2009-03-03 19:51:40 -05004251 rpos = reader->read;
4252 pos += size;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004253
Huang Ying18fab912010-07-28 14:14:01 +08004254 if (rpos >= commit)
4255 break;
4256
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004257 event = rb_reader_event(cpu_buffer);
Steven Rostedt69d1b832010-10-07 18:18:05 -04004258 /* Always keep the time extend and data together */
4259 size = rb_event_ts_length(event);
David Sharpe1e35922010-12-22 16:38:24 -08004260 } while (len >= size);
Lai Jiangshan667d2412009-02-09 14:21:17 +08004261
4262 /* update bpage */
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004263 local_set(&bpage->commit, pos);
Steven Rostedt4f3640f2009-03-03 23:52:42 -05004264 bpage->time_stamp = save_timestamp;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004265
Steven Rostedt474d32b2009-03-03 19:51:40 -05004266 /* we copied everything to the beginning */
4267 read = 0;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004268 } else {
Steven Rostedtafbab762009-05-01 19:40:05 -04004269 /* update the entry counter */
Steven Rostedt77ae3652009-03-27 11:00:29 -04004270 cpu_buffer->read += rb_page_entries(reader);
Vaibhav Nagarnaikc64e1482011-08-16 14:46:16 -07004271 cpu_buffer->read_bytes += BUF_PAGE_SIZE;
Steven Rostedtafbab762009-05-01 19:40:05 -04004272
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004273 /* swap the pages */
Steven Rostedt044fa782008-12-02 23:50:03 -05004274 rb_init_page(bpage);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004275 bpage = reader->page;
4276 reader->page = *data_page;
4277 local_set(&reader->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04004278 local_set(&reader->entries, 0);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05004279 reader->read = 0;
Steven Rostedt044fa782008-12-02 23:50:03 -05004280 *data_page = bpage;
Steven Rostedtff0ff842010-03-31 22:11:42 -04004281
4282 /*
4283 * Use the real_end for the data size,
4284 * This gives us a chance to store the lost events
4285 * on the page.
4286 */
4287 if (reader->real_end)
4288 local_set(&bpage->commit, reader->real_end);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004289 }
Lai Jiangshan667d2412009-02-09 14:21:17 +08004290 ret = read;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004291
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004292 cpu_buffer->lost_events = 0;
Steven Rostedt2711ca22010-05-21 13:32:26 -04004293
4294 commit = local_read(&bpage->commit);
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004295 /*
4296 * Set a flag in the commit field if we lost events
4297 */
Steven Rostedtff0ff842010-03-31 22:11:42 -04004298 if (missed_events) {
Steven Rostedtff0ff842010-03-31 22:11:42 -04004299 /* If there is room at the end of the page to save the
4300 * missed events, then record it there.
4301 */
4302 if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
4303 memcpy(&bpage->data[commit], &missed_events,
4304 sizeof(missed_events));
4305 local_add(RB_MISSED_STORED, &bpage->commit);
Steven Rostedt2711ca22010-05-21 13:32:26 -04004306 commit += sizeof(missed_events);
Steven Rostedtff0ff842010-03-31 22:11:42 -04004307 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004308 local_add(RB_MISSED_EVENTS, &bpage->commit);
Steven Rostedtff0ff842010-03-31 22:11:42 -04004309 }
Steven Rostedt66a8cb92010-03-31 13:21:56 -04004310
Steven Rostedt2711ca22010-05-21 13:32:26 -04004311 /*
4312 * This page may be off to user land. Zero it out here.
4313 */
4314 if (commit < BUF_PAGE_SIZE)
4315 memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);
4316
Steven Rostedt554f7862009-03-11 22:00:13 -04004317 out_unlock:
Thomas Gleixner5389f6f2009-07-25 17:13:33 +02004318 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004319
Steven Rostedt554f7862009-03-11 22:00:13 -04004320 out:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004321 return ret;
4322}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04004323EXPORT_SYMBOL_GPL(ring_buffer_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05004324
Steven Rostedt59222ef2009-03-12 11:46:03 -04004325#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01004326static int rb_cpu_notify(struct notifier_block *self,
4327 unsigned long action, void *hcpu)
Steven Rostedt554f7862009-03-11 22:00:13 -04004328{
4329 struct ring_buffer *buffer =
4330 container_of(self, struct ring_buffer, cpu_notify);
4331 long cpu = (long)hcpu;
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004332 int cpu_i, nr_pages_same;
4333 unsigned int nr_pages;
Steven Rostedt554f7862009-03-11 22:00:13 -04004334
4335 switch (action) {
4336 case CPU_UP_PREPARE:
4337 case CPU_UP_PREPARE_FROZEN:
Rusty Russell3f237a72009-06-12 21:15:30 +09304338 if (cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04004339 return NOTIFY_OK;
4340
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004341 nr_pages = 0;
4342 nr_pages_same = 1;
4343 /* check if all cpu sizes are same */
4344 for_each_buffer_cpu(buffer, cpu_i) {
4345 /* fill in the size from first enabled cpu */
4346 if (nr_pages == 0)
4347 nr_pages = buffer->buffers[cpu_i]->nr_pages;
4348 if (nr_pages != buffer->buffers[cpu_i]->nr_pages) {
4349 nr_pages_same = 0;
4350 break;
4351 }
4352 }
4353 /* allocate minimum pages, user can later expand it */
4354 if (!nr_pages_same)
4355 nr_pages = 2;
Steven Rostedt554f7862009-03-11 22:00:13 -04004356 buffer->buffers[cpu] =
Vaibhav Nagarnaik438ced12012-02-02 12:00:41 -08004357 rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
Steven Rostedt554f7862009-03-11 22:00:13 -04004358 if (!buffer->buffers[cpu]) {
4359 WARN(1, "failed to allocate ring buffer on CPU %ld\n",
4360 cpu);
4361 return NOTIFY_OK;
4362 }
4363 smp_wmb();
Rusty Russell3f237a72009-06-12 21:15:30 +09304364 cpumask_set_cpu(cpu, buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -04004365 break;
4366 case CPU_DOWN_PREPARE:
4367 case CPU_DOWN_PREPARE_FROZEN:
4368 /*
4369 * Do nothing.
4370 * If we were to free the buffer, then the user would
4371 * lose any trace that was in the buffer.
4372 */
4373 break;
4374 default:
4375 break;
4376 }
4377 return NOTIFY_OK;
4378}
4379#endif