blob: d4d3580a894a7f39bda320841d6baf70487eec91 [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 Rostedt78d904b2009-02-05 18:43:07 -05008#include <linux/ftrace_irq.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04009#include <linux/spinlock.h>
10#include <linux/debugfs.h>
11#include <linux/uaccess.h>
Steven Rostedta81bd802009-02-06 01:45:16 -050012#include <linux/hardirq.h>
Vegard Nossum1744a212009-02-28 08:29:44 +010013#include <linux/kmemcheck.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040014#include <linux/module.h>
15#include <linux/percpu.h>
16#include <linux/mutex.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
Steven Rostedt182e9f52008-11-03 23:15:56 -050023#include "trace.h"
24
Steven Rostedt033601a2008-11-21 12:41:55 -050025/*
Steven Rostedtd1b182a2009-04-15 16:53:47 -040026 * The ring buffer header is special. We must manually up keep it.
27 */
28int ring_buffer_print_entry_header(struct trace_seq *s)
29{
30 int ret;
31
Lai Jiangshan334d4162009-04-24 11:27:05 +080032 ret = trace_seq_printf(s, "# compressed entry header\n");
33 ret = trace_seq_printf(s, "\ttype_len : 5 bits\n");
Steven Rostedtd1b182a2009-04-15 16:53:47 -040034 ret = trace_seq_printf(s, "\ttime_delta : 27 bits\n");
35 ret = trace_seq_printf(s, "\tarray : 32 bits\n");
36 ret = trace_seq_printf(s, "\n");
37 ret = trace_seq_printf(s, "\tpadding : type == %d\n",
38 RINGBUF_TYPE_PADDING);
39 ret = trace_seq_printf(s, "\ttime_extend : type == %d\n",
40 RINGBUF_TYPE_TIME_EXTEND);
Lai Jiangshan334d4162009-04-24 11:27:05 +080041 ret = trace_seq_printf(s, "\tdata max type_len == %d\n",
42 RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
Steven Rostedtd1b182a2009-04-15 16:53:47 -040043
44 return ret;
45}
46
47/*
Steven Rostedt5cc98542009-03-12 22:24:17 -040048 * The ring buffer is made up of a list of pages. A separate list of pages is
49 * allocated for each CPU. A writer may only write to a buffer that is
50 * associated with the CPU it is currently executing on. A reader may read
51 * from any per cpu buffer.
52 *
53 * The reader is special. For each per cpu buffer, the reader has its own
54 * reader page. When a reader has read the entire reader page, this reader
55 * page is swapped with another page in the ring buffer.
56 *
57 * Now, as long as the writer is off the reader page, the reader can do what
58 * ever it wants with that page. The writer will never write to that page
59 * again (as long as it is out of the ring buffer).
60 *
61 * Here's some silly ASCII art.
62 *
63 * +------+
64 * |reader| RING BUFFER
65 * |page |
66 * +------+ +---+ +---+ +---+
67 * | |-->| |-->| |
68 * +---+ +---+ +---+
69 * ^ |
70 * | |
71 * +---------------+
72 *
73 *
74 * +------+
75 * |reader| RING BUFFER
76 * |page |------------------v
77 * +------+ +---+ +---+ +---+
78 * | |-->| |-->| |
79 * +---+ +---+ +---+
80 * ^ |
81 * | |
82 * +---------------+
83 *
84 *
85 * +------+
86 * |reader| RING BUFFER
87 * |page |------------------v
88 * +------+ +---+ +---+ +---+
89 * ^ | |-->| |-->| |
90 * | +---+ +---+ +---+
91 * | |
92 * | |
93 * +------------------------------+
94 *
95 *
96 * +------+
97 * |buffer| RING BUFFER
98 * |page |------------------v
99 * +------+ +---+ +---+ +---+
100 * ^ | | | |-->| |
101 * | New +---+ +---+ +---+
102 * | Reader------^ |
103 * | page |
104 * +------------------------------+
105 *
106 *
107 * After we make this swap, the reader can hand this page off to the splice
108 * code and be done with it. It can even allocate a new page if it needs to
109 * and swap that into the ring buffer.
110 *
111 * We will be using cmpxchg soon to make all this lockless.
112 *
113 */
114
115/*
Steven Rostedt033601a2008-11-21 12:41:55 -0500116 * A fast way to enable or disable all ring buffers is to
117 * call tracing_on or tracing_off. Turning off the ring buffers
118 * prevents all ring buffers from being recorded to.
119 * Turning this switch on, makes it OK to write to the
120 * ring buffer, if the ring buffer is enabled itself.
121 *
122 * There's three layers that must be on in order to write
123 * to the ring buffer.
124 *
125 * 1) This global flag must be set.
126 * 2) The ring buffer must be enabled for recording.
127 * 3) The per cpu buffer must be enabled for recording.
128 *
129 * In case of an anomaly, this global flag has a bit set that
130 * will permantly disable all ring buffers.
131 */
132
133/*
134 * Global flag to disable all recording to ring buffers
135 * This has two bits: ON, DISABLED
136 *
137 * ON DISABLED
138 * ---- ----------
139 * 0 0 : ring buffers are off
140 * 1 0 : ring buffers are on
141 * X 1 : ring buffers are permanently disabled
142 */
143
144enum {
145 RB_BUFFERS_ON_BIT = 0,
146 RB_BUFFERS_DISABLED_BIT = 1,
147};
148
149enum {
150 RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
151 RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
152};
153
Hannes Eder5e398412009-02-10 19:44:34 +0100154static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
Steven Rostedta3583242008-11-11 15:01:42 -0500155
Steven Rostedt474d32b2009-03-03 19:51:40 -0500156#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
157
Steven Rostedta3583242008-11-11 15:01:42 -0500158/**
159 * tracing_on - enable all tracing buffers
160 *
161 * This function enables all tracing buffers that may have been
162 * disabled with tracing_off.
163 */
164void tracing_on(void)
165{
Steven Rostedt033601a2008-11-21 12:41:55 -0500166 set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -0500167}
Robert Richterc4f50182008-12-11 16:49:22 +0100168EXPORT_SYMBOL_GPL(tracing_on);
Steven Rostedta3583242008-11-11 15:01:42 -0500169
170/**
171 * tracing_off - turn off all tracing buffers
172 *
173 * This function stops all tracing buffers from recording data.
174 * It does not disable any overhead the tracers themselves may
175 * be causing. This function simply causes all recording to
176 * the ring buffers to fail.
177 */
178void tracing_off(void)
179{
Steven Rostedt033601a2008-11-21 12:41:55 -0500180 clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
181}
Robert Richterc4f50182008-12-11 16:49:22 +0100182EXPORT_SYMBOL_GPL(tracing_off);
Steven Rostedt033601a2008-11-21 12:41:55 -0500183
184/**
185 * tracing_off_permanent - permanently disable ring buffers
186 *
187 * This function, once called, will disable all ring buffers
Wenji Huangc3706f02009-02-10 01:03:18 -0500188 * permanently.
Steven Rostedt033601a2008-11-21 12:41:55 -0500189 */
190void tracing_off_permanent(void)
191{
192 set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -0500193}
194
Steven Rostedt988ae9d2009-02-14 19:17:02 -0500195/**
196 * tracing_is_on - show state of ring buffers enabled
197 */
198int tracing_is_on(void)
199{
200 return ring_buffer_flags == RB_BUFFERS_ON;
201}
202EXPORT_SYMBOL_GPL(tracing_is_on);
203
Ingo Molnard06bbd62008-11-12 10:11:37 +0100204#include "trace.h"
205
Steven Rostedte3d6bf02009-03-03 13:53:07 -0500206#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
Andrew Morton67d34722009-01-09 12:27:09 -0800207#define RB_ALIGNMENT 4U
Lai Jiangshan334d4162009-04-24 11:27:05 +0800208#define RB_MAX_SMALL_DATA (RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Steven Rostedtc7b09302009-06-11 11:12:00 -0400209#define RB_EVNT_MIN_SIZE 8U /* two 32bit words */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800210
211/* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
212#define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400213
214enum {
215 RB_LEN_TIME_EXTEND = 8,
216 RB_LEN_TIME_STAMP = 16,
217};
218
Tom Zanussi2d622712009-03-22 03:30:49 -0500219static inline int rb_null_event(struct ring_buffer_event *event)
220{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800221 return event->type_len == RINGBUF_TYPE_PADDING
222 && event->time_delta == 0;
Tom Zanussi2d622712009-03-22 03:30:49 -0500223}
224
225static inline int rb_discarded_event(struct ring_buffer_event *event)
226{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800227 return event->type_len == RINGBUF_TYPE_PADDING && event->time_delta;
Tom Zanussi2d622712009-03-22 03:30:49 -0500228}
229
230static void rb_event_set_padding(struct ring_buffer_event *event)
231{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800232 event->type_len = RINGBUF_TYPE_PADDING;
Tom Zanussi2d622712009-03-22 03:30:49 -0500233 event->time_delta = 0;
234}
235
Tom Zanussi2d622712009-03-22 03:30:49 -0500236static unsigned
237rb_event_data_length(struct ring_buffer_event *event)
238{
239 unsigned length;
240
Lai Jiangshan334d4162009-04-24 11:27:05 +0800241 if (event->type_len)
242 length = event->type_len * RB_ALIGNMENT;
Tom Zanussi2d622712009-03-22 03:30:49 -0500243 else
244 length = event->array[0];
245 return length + RB_EVNT_HDR_SIZE;
246}
247
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400248/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800249static unsigned
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400250rb_event_length(struct ring_buffer_event *event)
251{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800252 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400253 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -0500254 if (rb_null_event(event))
255 /* undefined */
256 return -1;
Lai Jiangshan334d4162009-04-24 11:27:05 +0800257 return event->array[0] + RB_EVNT_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400258
259 case RINGBUF_TYPE_TIME_EXTEND:
260 return RB_LEN_TIME_EXTEND;
261
262 case RINGBUF_TYPE_TIME_STAMP:
263 return RB_LEN_TIME_STAMP;
264
265 case RINGBUF_TYPE_DATA:
Tom Zanussi2d622712009-03-22 03:30:49 -0500266 return rb_event_data_length(event);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400267 default:
268 BUG();
269 }
270 /* not hit */
271 return 0;
272}
273
274/**
275 * ring_buffer_event_length - return the length of the event
276 * @event: the event to get the length of
277 */
278unsigned ring_buffer_event_length(struct ring_buffer_event *event)
279{
Robert Richter465634a2009-01-07 15:32:11 +0100280 unsigned length = rb_event_length(event);
Lai Jiangshan334d4162009-04-24 11:27:05 +0800281 if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
Robert Richter465634a2009-01-07 15:32:11 +0100282 return length;
283 length -= RB_EVNT_HDR_SIZE;
284 if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
285 length -= sizeof(event->array[0]);
286 return length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400287}
Robert Richterc4f50182008-12-11 16:49:22 +0100288EXPORT_SYMBOL_GPL(ring_buffer_event_length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400289
290/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800291static void *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400292rb_event_data(struct ring_buffer_event *event)
293{
Lai Jiangshan334d4162009-04-24 11:27:05 +0800294 BUG_ON(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400295 /* If length is in len field, then array[0] has the data */
Lai Jiangshan334d4162009-04-24 11:27:05 +0800296 if (event->type_len)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400297 return (void *)&event->array[0];
298 /* Otherwise length is in array[0] and array[1] has the data */
299 return (void *)&event->array[1];
300}
301
302/**
303 * ring_buffer_event_data - return the data of the event
304 * @event: the event to get the data from
305 */
306void *ring_buffer_event_data(struct ring_buffer_event *event)
307{
308 return rb_event_data(event);
309}
Robert Richterc4f50182008-12-11 16:49:22 +0100310EXPORT_SYMBOL_GPL(ring_buffer_event_data);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400311
312#define for_each_buffer_cpu(buffer, cpu) \
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030313 for_each_cpu(cpu, buffer->cpumask)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400314
315#define TS_SHIFT 27
316#define TS_MASK ((1ULL << TS_SHIFT) - 1)
317#define TS_DELTA_TEST (~TS_MASK)
318
Steven Rostedtabc9b562008-12-02 15:34:06 -0500319struct buffer_data_page {
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400320 u64 time_stamp; /* page time stamp */
Wenji Huangc3706f02009-02-10 01:03:18 -0500321 local_t commit; /* write committed index */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500322 unsigned char data[]; /* data of buffer page */
323};
324
325struct buffer_page {
Steven Rostedt778c55d2009-05-01 18:44:45 -0400326 struct list_head list; /* list of buffer pages */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500327 local_t write; /* index for next write */
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400328 unsigned read; /* index for next read */
Steven Rostedt778c55d2009-05-01 18:44:45 -0400329 local_t entries; /* entries on this page */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500330 struct buffer_data_page *page; /* Actual data page */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400331};
332
Steven Rostedt044fa782008-12-02 23:50:03 -0500333static void rb_init_page(struct buffer_data_page *bpage)
Steven Rostedtabc9b562008-12-02 15:34:06 -0500334{
Steven Rostedt044fa782008-12-02 23:50:03 -0500335 local_set(&bpage->commit, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500336}
337
Steven Rostedt474d32b2009-03-03 19:51:40 -0500338/**
339 * ring_buffer_page_len - the size of data on the page.
340 * @page: The page to read
341 *
342 * Returns the amount of data on the page, including buffer page header.
343 */
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500344size_t ring_buffer_page_len(void *page)
345{
Steven Rostedt474d32b2009-03-03 19:51:40 -0500346 return local_read(&((struct buffer_data_page *)page)->commit)
347 + BUF_PAGE_HDR_SIZE;
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500348}
349
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400350/*
Steven Rostedted568292008-09-29 23:02:40 -0400351 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
352 * this issue out.
353 */
Andrew Morton34a148b2009-01-09 12:27:09 -0800354static void free_buffer_page(struct buffer_page *bpage)
Steven Rostedted568292008-09-29 23:02:40 -0400355{
Andrew Morton34a148b2009-01-09 12:27:09 -0800356 free_page((unsigned long)bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400357 kfree(bpage);
Steven Rostedted568292008-09-29 23:02:40 -0400358}
359
360/*
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400361 * We need to fit the time_stamp delta into 27 bits.
362 */
363static inline int test_time_stamp(u64 delta)
364{
365 if (delta & TS_DELTA_TEST)
366 return 1;
367 return 0;
368}
369
Steven Rostedt474d32b2009-03-03 19:51:40 -0500370#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400371
Steven Rostedtbe957c42009-05-11 14:42:53 -0400372/* Max payload is BUF_PAGE_SIZE - header (8bytes) */
373#define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))
374
Steven Rostedtea05b572009-06-03 09:30:10 -0400375/* Max number of timestamps that can fit on a page */
376#define RB_TIMESTAMPS_PER_PAGE (BUF_PAGE_SIZE / RB_LEN_TIME_STAMP)
377
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400378int ring_buffer_print_page_header(struct trace_seq *s)
379{
380 struct buffer_data_page field;
381 int ret;
382
383 ret = trace_seq_printf(s, "\tfield: u64 timestamp;\t"
384 "offset:0;\tsize:%u;\n",
385 (unsigned int)sizeof(field.time_stamp));
386
387 ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
388 "offset:%u;\tsize:%u;\n",
389 (unsigned int)offsetof(typeof(field), commit),
390 (unsigned int)sizeof(field.commit));
391
392 ret = trace_seq_printf(s, "\tfield: char data;\t"
393 "offset:%u;\tsize:%u;\n",
394 (unsigned int)offsetof(typeof(field), data),
395 (unsigned int)BUF_PAGE_SIZE);
396
397 return ret;
398}
399
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400400/*
401 * head_page == tail_page && head == tail then buffer is empty.
402 */
403struct ring_buffer_per_cpu {
404 int cpu;
405 struct ring_buffer *buffer;
Steven Rostedtf83c9d02008-11-11 18:47:44 +0100406 spinlock_t reader_lock; /* serialize readers */
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500407 raw_spinlock_t lock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400408 struct lock_class_key lock_key;
409 struct list_head pages;
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400410 struct buffer_page *head_page; /* read from head */
411 struct buffer_page *tail_page; /* write to tail */
Wenji Huangc3706f02009-02-10 01:03:18 -0500412 struct buffer_page *commit_page; /* committed pages */
Steven Rostedtd7690412008-10-01 00:29:53 -0400413 struct buffer_page *reader_page;
Steven Rostedtf0d2c682009-04-29 13:43:37 -0400414 unsigned long nmi_dropped;
415 unsigned long commit_overrun;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400416 unsigned long overrun;
Steven Rostedte4906ef2009-04-30 20:49:44 -0400417 unsigned long read;
418 local_t entries;
Steven Rostedtfa743952009-06-16 12:37:57 -0400419 local_t committing;
420 local_t commits;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400421 u64 write_stamp;
422 u64 read_stamp;
423 atomic_t record_disabled;
424};
425
426struct ring_buffer {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400427 unsigned pages;
428 unsigned flags;
429 int cpus;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400430 atomic_t record_disabled;
Arnaldo Carvalho de Melo00f62f62009-02-09 17:04:06 -0200431 cpumask_var_t cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400432
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200433 struct lock_class_key *reader_lock_key;
434
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400435 struct mutex mutex;
436
437 struct ring_buffer_per_cpu **buffers;
Steven Rostedt554f7862009-03-11 22:00:13 -0400438
Steven Rostedt59222ef2009-03-12 11:46:03 -0400439#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400440 struct notifier_block cpu_notify;
441#endif
Steven Rostedt37886f62009-03-17 17:22:06 -0400442 u64 (*clock)(void);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400443};
444
445struct ring_buffer_iter {
446 struct ring_buffer_per_cpu *cpu_buffer;
447 unsigned long head;
448 struct buffer_page *head_page;
449 u64 read_stamp;
450};
451
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500452/* buffer may be either ring_buffer or ring_buffer_per_cpu */
Steven Rostedtbf41a152008-10-04 02:00:59 -0400453#define RB_WARN_ON(buffer, cond) \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500454 ({ \
455 int _____ret = unlikely(cond); \
456 if (_____ret) { \
Steven Rostedtbf41a152008-10-04 02:00:59 -0400457 atomic_inc(&buffer->record_disabled); \
458 WARN_ON(1); \
459 } \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500460 _____ret; \
461 })
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500462
Steven Rostedt37886f62009-03-17 17:22:06 -0400463/* Up this if you want to test the TIME_EXTENTS and normalization */
464#define DEBUG_SHIFT 0
465
Steven Rostedt88eb0122009-05-11 16:28:23 -0400466static inline u64 rb_time_stamp(struct ring_buffer *buffer, int cpu)
467{
468 /* shift to debug/test normalization and TIME_EXTENTS */
469 return buffer->clock() << DEBUG_SHIFT;
470}
471
Steven Rostedt37886f62009-03-17 17:22:06 -0400472u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
473{
474 u64 time;
475
476 preempt_disable_notrace();
Steven Rostedt88eb0122009-05-11 16:28:23 -0400477 time = rb_time_stamp(buffer, cpu);
Steven Rostedt37886f62009-03-17 17:22:06 -0400478 preempt_enable_no_resched_notrace();
479
480 return time;
481}
482EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
483
484void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
485 int cpu, u64 *ts)
486{
487 /* Just stupid testing the normalize function and deltas */
488 *ts >>= DEBUG_SHIFT;
489}
490EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
491
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400492/**
493 * check_pages - integrity check of buffer pages
494 * @cpu_buffer: CPU buffer with pages to test
495 *
Wenji Huangc3706f02009-02-10 01:03:18 -0500496 * As a safety measure we check to make sure the data pages have not
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400497 * been corrupted.
498 */
499static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
500{
501 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500502 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400503
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500504 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
505 return -1;
506 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
507 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400508
Steven Rostedt044fa782008-12-02 23:50:03 -0500509 list_for_each_entry_safe(bpage, tmp, head, list) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500510 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500511 bpage->list.next->prev != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500512 return -1;
513 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500514 bpage->list.prev->next != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500515 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400516 }
517
518 return 0;
519}
520
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400521static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
522 unsigned nr_pages)
523{
524 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500525 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400526 unsigned long addr;
527 LIST_HEAD(pages);
528 unsigned i;
529
530 for (i = 0; i < nr_pages; i++) {
Steven Rostedt044fa782008-12-02 23:50:03 -0500531 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedtaa1e0e32008-10-02 19:18:09 -0400532 GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500533 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400534 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500535 list_add(&bpage->list, &pages);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400536
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400537 addr = __get_free_page(GFP_KERNEL);
538 if (!addr)
539 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500540 bpage->page = (void *)addr;
541 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400542 }
543
544 list_splice(&pages, head);
545
546 rb_check_pages(cpu_buffer);
547
548 return 0;
549
550 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -0500551 list_for_each_entry_safe(bpage, tmp, &pages, list) {
552 list_del_init(&bpage->list);
553 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400554 }
555 return -ENOMEM;
556}
557
558static struct ring_buffer_per_cpu *
559rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
560{
561 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt044fa782008-12-02 23:50:03 -0500562 struct buffer_page *bpage;
Steven Rostedtd7690412008-10-01 00:29:53 -0400563 unsigned long addr;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400564 int ret;
565
566 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
567 GFP_KERNEL, cpu_to_node(cpu));
568 if (!cpu_buffer)
569 return NULL;
570
571 cpu_buffer->cpu = cpu;
572 cpu_buffer->buffer = buffer;
Steven Rostedtf83c9d02008-11-11 18:47:44 +0100573 spin_lock_init(&cpu_buffer->reader_lock);
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200574 lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500575 cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400576 INIT_LIST_HEAD(&cpu_buffer->pages);
577
Steven Rostedt044fa782008-12-02 23:50:03 -0500578 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400579 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500580 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400581 goto fail_free_buffer;
582
Steven Rostedt044fa782008-12-02 23:50:03 -0500583 cpu_buffer->reader_page = bpage;
Steven Rostedtd7690412008-10-01 00:29:53 -0400584 addr = __get_free_page(GFP_KERNEL);
585 if (!addr)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400586 goto fail_free_reader;
Steven Rostedt044fa782008-12-02 23:50:03 -0500587 bpage->page = (void *)addr;
588 rb_init_page(bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400589
Steven Rostedtd7690412008-10-01 00:29:53 -0400590 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -0400591
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400592 ret = rb_allocate_pages(cpu_buffer, buffer->pages);
593 if (ret < 0)
Steven Rostedtd7690412008-10-01 00:29:53 -0400594 goto fail_free_reader;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400595
596 cpu_buffer->head_page
597 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400598 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400599
600 return cpu_buffer;
601
Steven Rostedtd7690412008-10-01 00:29:53 -0400602 fail_free_reader:
603 free_buffer_page(cpu_buffer->reader_page);
604
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400605 fail_free_buffer:
606 kfree(cpu_buffer);
607 return NULL;
608}
609
610static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
611{
612 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500613 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400614
Steven Rostedtd7690412008-10-01 00:29:53 -0400615 free_buffer_page(cpu_buffer->reader_page);
616
Steven Rostedt044fa782008-12-02 23:50:03 -0500617 list_for_each_entry_safe(bpage, tmp, head, list) {
618 list_del_init(&bpage->list);
619 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400620 }
621 kfree(cpu_buffer);
622}
623
Steven Rostedt59222ef2009-03-12 11:46:03 -0400624#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +0100625static int rb_cpu_notify(struct notifier_block *self,
626 unsigned long action, void *hcpu);
Steven Rostedt554f7862009-03-11 22:00:13 -0400627#endif
628
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400629/**
630 * ring_buffer_alloc - allocate a new ring_buffer
Robert Richter68814b52008-11-24 12:24:12 +0100631 * @size: the size in bytes per cpu that is needed.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400632 * @flags: attributes to set for the ring buffer.
633 *
634 * Currently the only flag that is available is the RB_FL_OVERWRITE
635 * flag. This flag means that the buffer will overwrite old data
636 * when the buffer wraps. If this flag is not set, the buffer will
637 * drop data when the tail hits the head.
638 */
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200639struct ring_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
640 struct lock_class_key *key)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400641{
642 struct ring_buffer *buffer;
643 int bsize;
644 int cpu;
645
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400646 /* keep it in its own cache line */
647 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
648 GFP_KERNEL);
649 if (!buffer)
650 return NULL;
651
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030652 if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
653 goto fail_free_buffer;
654
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400655 buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
656 buffer->flags = flags;
Steven Rostedt37886f62009-03-17 17:22:06 -0400657 buffer->clock = trace_clock_local;
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200658 buffer->reader_lock_key = key;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400659
660 /* need at least two pages */
Steven Rostedt5f78abe2009-06-17 14:11:10 -0400661 if (buffer->pages < 2)
662 buffer->pages = 2;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400663
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +0100664 /*
665 * In case of non-hotplug cpu, if the ring-buffer is allocated
666 * in early initcall, it will not be notified of secondary cpus.
667 * In that off case, we need to allocate for all possible cpus.
668 */
669#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400670 get_online_cpus();
671 cpumask_copy(buffer->cpumask, cpu_online_mask);
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +0100672#else
673 cpumask_copy(buffer->cpumask, cpu_possible_mask);
674#endif
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400675 buffer->cpus = nr_cpu_ids;
676
677 bsize = sizeof(void *) * nr_cpu_ids;
678 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
679 GFP_KERNEL);
680 if (!buffer->buffers)
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030681 goto fail_free_cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400682
683 for_each_buffer_cpu(buffer, cpu) {
684 buffer->buffers[cpu] =
685 rb_allocate_cpu_buffer(buffer, cpu);
686 if (!buffer->buffers[cpu])
687 goto fail_free_buffers;
688 }
689
Steven Rostedt59222ef2009-03-12 11:46:03 -0400690#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400691 buffer->cpu_notify.notifier_call = rb_cpu_notify;
692 buffer->cpu_notify.priority = 0;
693 register_cpu_notifier(&buffer->cpu_notify);
694#endif
695
696 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400697 mutex_init(&buffer->mutex);
698
699 return buffer;
700
701 fail_free_buffers:
702 for_each_buffer_cpu(buffer, cpu) {
703 if (buffer->buffers[cpu])
704 rb_free_cpu_buffer(buffer->buffers[cpu]);
705 }
706 kfree(buffer->buffers);
707
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030708 fail_free_cpumask:
709 free_cpumask_var(buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -0400710 put_online_cpus();
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030711
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400712 fail_free_buffer:
713 kfree(buffer);
714 return NULL;
715}
Peter Zijlstra1f8a6a12009-06-08 18:18:39 +0200716EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400717
718/**
719 * ring_buffer_free - free a ring buffer.
720 * @buffer: the buffer to free.
721 */
722void
723ring_buffer_free(struct ring_buffer *buffer)
724{
725 int cpu;
726
Steven Rostedt554f7862009-03-11 22:00:13 -0400727 get_online_cpus();
728
Steven Rostedt59222ef2009-03-12 11:46:03 -0400729#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400730 unregister_cpu_notifier(&buffer->cpu_notify);
731#endif
732
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400733 for_each_buffer_cpu(buffer, cpu)
734 rb_free_cpu_buffer(buffer->buffers[cpu]);
735
Steven Rostedt554f7862009-03-11 22:00:13 -0400736 put_online_cpus();
737
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030738 free_cpumask_var(buffer->cpumask);
739
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400740 kfree(buffer);
741}
Robert Richterc4f50182008-12-11 16:49:22 +0100742EXPORT_SYMBOL_GPL(ring_buffer_free);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400743
Steven Rostedt37886f62009-03-17 17:22:06 -0400744void ring_buffer_set_clock(struct ring_buffer *buffer,
745 u64 (*clock)(void))
746{
747 buffer->clock = clock;
748}
749
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400750static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
751
752static void
753rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
754{
Steven Rostedt044fa782008-12-02 23:50:03 -0500755 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400756 struct list_head *p;
757 unsigned i;
758
759 atomic_inc(&cpu_buffer->record_disabled);
760 synchronize_sched();
761
762 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500763 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
764 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400765 p = cpu_buffer->pages.next;
Steven Rostedt044fa782008-12-02 23:50:03 -0500766 bpage = list_entry(p, struct buffer_page, list);
767 list_del_init(&bpage->list);
768 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400769 }
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500770 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
771 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400772
773 rb_reset_cpu(cpu_buffer);
774
775 rb_check_pages(cpu_buffer);
776
777 atomic_dec(&cpu_buffer->record_disabled);
778
779}
780
781static void
782rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
783 struct list_head *pages, unsigned nr_pages)
784{
Steven Rostedt044fa782008-12-02 23:50:03 -0500785 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400786 struct list_head *p;
787 unsigned i;
788
789 atomic_inc(&cpu_buffer->record_disabled);
790 synchronize_sched();
791
792 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500793 if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
794 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400795 p = pages->next;
Steven Rostedt044fa782008-12-02 23:50:03 -0500796 bpage = list_entry(p, struct buffer_page, list);
797 list_del_init(&bpage->list);
798 list_add_tail(&bpage->list, &cpu_buffer->pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400799 }
800 rb_reset_cpu(cpu_buffer);
801
802 rb_check_pages(cpu_buffer);
803
804 atomic_dec(&cpu_buffer->record_disabled);
805}
806
807/**
808 * ring_buffer_resize - resize the ring buffer
809 * @buffer: the buffer to resize.
810 * @size: the new size.
811 *
812 * The tracer is responsible for making sure that the buffer is
813 * not being used while changing the size.
814 * Note: We may be able to change the above requirement by using
815 * RCU synchronizations.
816 *
817 * Minimum size is 2 * BUF_PAGE_SIZE.
818 *
819 * Returns -1 on failure.
820 */
821int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
822{
823 struct ring_buffer_per_cpu *cpu_buffer;
824 unsigned nr_pages, rm_pages, new_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500825 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400826 unsigned long buffer_size;
827 unsigned long addr;
828 LIST_HEAD(pages);
829 int i, cpu;
830
Ingo Molnaree51a1d2008-11-13 14:58:31 +0100831 /*
832 * Always succeed at resizing a non-existent buffer:
833 */
834 if (!buffer)
835 return size;
836
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400837 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
838 size *= BUF_PAGE_SIZE;
839 buffer_size = buffer->pages * BUF_PAGE_SIZE;
840
841 /* we need a minimum of two pages */
842 if (size < BUF_PAGE_SIZE * 2)
843 size = BUF_PAGE_SIZE * 2;
844
845 if (size == buffer_size)
846 return size;
847
848 mutex_lock(&buffer->mutex);
Steven Rostedt554f7862009-03-11 22:00:13 -0400849 get_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400850
851 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
852
853 if (size < buffer_size) {
854
855 /* easy case, just free pages */
Steven Rostedt554f7862009-03-11 22:00:13 -0400856 if (RB_WARN_ON(buffer, nr_pages >= buffer->pages))
857 goto out_fail;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400858
859 rm_pages = buffer->pages - nr_pages;
860
861 for_each_buffer_cpu(buffer, cpu) {
862 cpu_buffer = buffer->buffers[cpu];
863 rb_remove_pages(cpu_buffer, rm_pages);
864 }
865 goto out;
866 }
867
868 /*
869 * This is a bit more difficult. We only want to add pages
870 * when we can allocate enough for all CPUs. We do this
871 * by allocating all the pages and storing them on a local
872 * link list. If we succeed in our allocation, then we
873 * add these pages to the cpu_buffers. Otherwise we just free
874 * them all and return -ENOMEM;
875 */
Steven Rostedt554f7862009-03-11 22:00:13 -0400876 if (RB_WARN_ON(buffer, nr_pages <= buffer->pages))
877 goto out_fail;
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500878
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400879 new_pages = nr_pages - buffer->pages;
880
881 for_each_buffer_cpu(buffer, cpu) {
882 for (i = 0; i < new_pages; i++) {
Steven Rostedt044fa782008-12-02 23:50:03 -0500883 bpage = kzalloc_node(ALIGN(sizeof(*bpage),
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400884 cache_line_size()),
885 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500886 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400887 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500888 list_add(&bpage->list, &pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400889 addr = __get_free_page(GFP_KERNEL);
890 if (!addr)
891 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500892 bpage->page = (void *)addr;
893 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400894 }
895 }
896
897 for_each_buffer_cpu(buffer, cpu) {
898 cpu_buffer = buffer->buffers[cpu];
899 rb_insert_pages(cpu_buffer, &pages, new_pages);
900 }
901
Steven Rostedt554f7862009-03-11 22:00:13 -0400902 if (RB_WARN_ON(buffer, !list_empty(&pages)))
903 goto out_fail;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400904
905 out:
906 buffer->pages = nr_pages;
Steven Rostedt554f7862009-03-11 22:00:13 -0400907 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400908 mutex_unlock(&buffer->mutex);
909
910 return size;
911
912 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -0500913 list_for_each_entry_safe(bpage, tmp, &pages, list) {
914 list_del_init(&bpage->list);
915 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400916 }
Steven Rostedt554f7862009-03-11 22:00:13 -0400917 put_online_cpus();
Vegard Nossum641d2f62008-11-18 19:22:13 +0100918 mutex_unlock(&buffer->mutex);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400919 return -ENOMEM;
Steven Rostedt554f7862009-03-11 22:00:13 -0400920
921 /*
922 * Something went totally wrong, and we are too paranoid
923 * to even clean up the mess.
924 */
925 out_fail:
926 put_online_cpus();
927 mutex_unlock(&buffer->mutex);
928 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400929}
Robert Richterc4f50182008-12-11 16:49:22 +0100930EXPORT_SYMBOL_GPL(ring_buffer_resize);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400931
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500932static inline void *
Steven Rostedt044fa782008-12-02 23:50:03 -0500933__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500934{
Steven Rostedt044fa782008-12-02 23:50:03 -0500935 return bpage->data + index;
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500936}
937
Steven Rostedt044fa782008-12-02 23:50:03 -0500938static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400939{
Steven Rostedt044fa782008-12-02 23:50:03 -0500940 return bpage->page->data + index;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400941}
942
943static inline struct ring_buffer_event *
Steven Rostedtd7690412008-10-01 00:29:53 -0400944rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400945{
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400946 return __rb_page_index(cpu_buffer->reader_page,
947 cpu_buffer->reader_page->read);
948}
949
950static inline struct ring_buffer_event *
951rb_head_event(struct ring_buffer_per_cpu *cpu_buffer)
952{
953 return __rb_page_index(cpu_buffer->head_page,
954 cpu_buffer->head_page->read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400955}
956
957static inline struct ring_buffer_event *
958rb_iter_head_event(struct ring_buffer_iter *iter)
959{
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400960 return __rb_page_index(iter->head_page, iter->head);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400961}
962
Steven Rostedtbf41a152008-10-04 02:00:59 -0400963static inline unsigned rb_page_write(struct buffer_page *bpage)
964{
965 return local_read(&bpage->write);
966}
967
968static inline unsigned rb_page_commit(struct buffer_page *bpage)
969{
Steven Rostedtabc9b562008-12-02 15:34:06 -0500970 return local_read(&bpage->page->commit);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400971}
972
973/* Size is determined by what has been commited */
974static inline unsigned rb_page_size(struct buffer_page *bpage)
975{
976 return rb_page_commit(bpage);
977}
978
979static inline unsigned
980rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
981{
982 return rb_page_commit(cpu_buffer->commit_page);
983}
984
985static inline unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
986{
987 return rb_page_commit(cpu_buffer->head_page);
988}
989
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400990static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500991 struct buffer_page **bpage)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400992{
Steven Rostedt044fa782008-12-02 23:50:03 -0500993 struct list_head *p = (*bpage)->list.next;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400994
995 if (p == &cpu_buffer->pages)
996 p = p->next;
997
Steven Rostedt044fa782008-12-02 23:50:03 -0500998 *bpage = list_entry(p, struct buffer_page, list);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400999}
1000
Steven Rostedtbf41a152008-10-04 02:00:59 -04001001static inline unsigned
1002rb_event_index(struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001003{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001004 unsigned long addr = (unsigned long)event;
1005
Steven Rostedt22f470f2009-06-11 09:29:58 -04001006 return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001007}
1008
Steven Rostedt0f0c85f2009-05-11 16:08:00 -04001009static inline int
Steven Rostedtfa743952009-06-16 12:37:57 -04001010rb_event_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
1011 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001012{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001013 unsigned long addr = (unsigned long)event;
1014 unsigned long index;
1015
1016 index = rb_event_index(event);
1017 addr &= PAGE_MASK;
1018
1019 return cpu_buffer->commit_page->page == (void *)addr &&
1020 rb_commit_index(cpu_buffer) == index;
1021}
1022
Andrew Morton34a148b2009-01-09 12:27:09 -08001023static void
Steven Rostedtbf41a152008-10-04 02:00:59 -04001024rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
1025{
1026 /*
1027 * We only race with interrupts and NMIs on this CPU.
1028 * If we own the commit event, then we can commit
1029 * all others that interrupted us, since the interruptions
1030 * are in stack format (they finish before they come
1031 * back to us). This allows us to do a simple loop to
1032 * assign the commit to the tail.
1033 */
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001034 again:
Steven Rostedtbf41a152008-10-04 02:00:59 -04001035 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
Steven Rostedtabc9b562008-12-02 15:34:06 -05001036 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -04001037 cpu_buffer->commit_page->write;
1038 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001039 cpu_buffer->write_stamp =
1040 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001041 /* add barrier to keep gcc from optimizing too much */
1042 barrier();
1043 }
1044 while (rb_commit_index(cpu_buffer) !=
1045 rb_page_write(cpu_buffer->commit_page)) {
Steven Rostedtabc9b562008-12-02 15:34:06 -05001046 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -04001047 cpu_buffer->commit_page->write;
1048 barrier();
1049 }
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001050
1051 /* again, keep gcc from optimizing */
1052 barrier();
1053
1054 /*
1055 * If an interrupt came in just after the first while loop
1056 * and pushed the tail page forward, we will be left with
1057 * a dangling commit that will never go forward.
1058 */
1059 if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
1060 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001061}
1062
Steven Rostedtd7690412008-10-01 00:29:53 -04001063static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001064{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001065 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001066 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04001067}
1068
Andrew Morton34a148b2009-01-09 12:27:09 -08001069static void rb_inc_iter(struct ring_buffer_iter *iter)
Steven Rostedtd7690412008-10-01 00:29:53 -04001070{
1071 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1072
1073 /*
1074 * The iterator could be on the reader page (it starts there).
1075 * But the head could have moved, since the reader was
1076 * found. Check for this case and assign the iterator
1077 * to the head page instead of next.
1078 */
1079 if (iter->head_page == cpu_buffer->reader_page)
1080 iter->head_page = cpu_buffer->head_page;
1081 else
1082 rb_inc_page(cpu_buffer, &iter->head_page);
1083
Steven Rostedtabc9b562008-12-02 15:34:06 -05001084 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001085 iter->head = 0;
1086}
1087
1088/**
1089 * ring_buffer_update_event - update event type and data
1090 * @event: the even to update
1091 * @type: the type of event
1092 * @length: the size of the event field in the ring buffer
1093 *
1094 * Update the type and data fields of the event. The length
1095 * is the actual size that is written to the ring buffer,
1096 * and with this, we can determine what to place into the
1097 * data field.
1098 */
Andrew Morton34a148b2009-01-09 12:27:09 -08001099static void
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001100rb_update_event(struct ring_buffer_event *event,
1101 unsigned type, unsigned length)
1102{
Lai Jiangshan334d4162009-04-24 11:27:05 +08001103 event->type_len = type;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001104
1105 switch (type) {
1106
1107 case RINGBUF_TYPE_PADDING:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001108 case RINGBUF_TYPE_TIME_EXTEND:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001109 case RINGBUF_TYPE_TIME_STAMP:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001110 break;
1111
Lai Jiangshan334d4162009-04-24 11:27:05 +08001112 case 0:
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001113 length -= RB_EVNT_HDR_SIZE;
Lai Jiangshan334d4162009-04-24 11:27:05 +08001114 if (length > RB_MAX_SMALL_DATA)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001115 event->array[0] = length;
Lai Jiangshan334d4162009-04-24 11:27:05 +08001116 else
1117 event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001118 break;
1119 default:
1120 BUG();
1121 }
1122}
1123
Andrew Morton34a148b2009-01-09 12:27:09 -08001124static unsigned rb_calculate_event_length(unsigned length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001125{
1126 struct ring_buffer_event event; /* Used only for sizeof array */
1127
1128 /* zero length can cause confusions */
1129 if (!length)
1130 length = 1;
1131
1132 if (length > RB_MAX_SMALL_DATA)
1133 length += sizeof(event.array[0]);
1134
1135 length += RB_EVNT_HDR_SIZE;
1136 length = ALIGN(length, RB_ALIGNMENT);
1137
1138 return length;
1139}
1140
Steven Rostedtc7b09302009-06-11 11:12:00 -04001141static inline void
1142rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
1143 struct buffer_page *tail_page,
1144 unsigned long tail, unsigned long length)
1145{
1146 struct ring_buffer_event *event;
1147
1148 /*
1149 * Only the event that crossed the page boundary
1150 * must fill the old tail_page with padding.
1151 */
1152 if (tail >= BUF_PAGE_SIZE) {
1153 local_sub(length, &tail_page->write);
1154 return;
1155 }
1156
1157 event = __rb_page_index(tail_page, tail);
Linus Torvaldsb0b70652009-06-20 10:56:46 -07001158 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedtc7b09302009-06-11 11:12:00 -04001159
1160 /*
1161 * If this event is bigger than the minimum size, then
1162 * we need to be careful that we don't subtract the
1163 * write counter enough to allow another writer to slip
1164 * in on this page.
1165 * We put in a discarded commit instead, to make sure
1166 * that this space is not used again.
1167 *
1168 * If we are less than the minimum size, we don't need to
1169 * worry about it.
1170 */
1171 if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
1172 /* No room for any events */
1173
1174 /* Mark the rest of the page with padding */
1175 rb_event_set_padding(event);
1176
1177 /* Set the write back to the previous setting */
1178 local_sub(length, &tail_page->write);
1179 return;
1180 }
1181
1182 /* Put in a discarded event */
1183 event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
1184 event->type_len = RINGBUF_TYPE_PADDING;
1185 /* time delta must be non zero */
1186 event->time_delta = 1;
1187 /* Account for this as an entry */
1188 local_inc(&tail_page->entries);
1189 local_inc(&cpu_buffer->entries);
1190
1191 /* Set write to end of buffer */
1192 length = (tail + length) - BUF_PAGE_SIZE;
1193 local_sub(length, &tail_page->write);
1194}
Steven Rostedt6634ff22009-05-06 15:30:07 -04001195
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001196static struct ring_buffer_event *
Steven Rostedt6634ff22009-05-06 15:30:07 -04001197rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
1198 unsigned long length, unsigned long tail,
1199 struct buffer_page *commit_page,
1200 struct buffer_page *tail_page, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001201{
Steven Rostedt6634ff22009-05-06 15:30:07 -04001202 struct buffer_page *next_page, *head_page, *reader_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001203 struct ring_buffer *buffer = cpu_buffer->buffer;
Steven Rostedt78d904b2009-02-05 18:43:07 -05001204 bool lock_taken = false;
Steven Rostedt6634ff22009-05-06 15:30:07 -04001205 unsigned long flags;
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001206
1207 next_page = tail_page;
1208
1209 local_irq_save(flags);
1210 /*
1211 * Since the write to the buffer is still not
1212 * fully lockless, we must be careful with NMIs.
1213 * The locks in the writers are taken when a write
1214 * crosses to a new page. The locks protect against
1215 * races with the readers (this will soon be fixed
1216 * with a lockless solution).
1217 *
1218 * Because we can not protect against NMIs, and we
1219 * want to keep traces reentrant, we need to manage
1220 * what happens when we are in an NMI.
1221 *
1222 * NMIs can happen after we take the lock.
1223 * If we are in an NMI, only take the lock
1224 * if it is not already taken. Otherwise
1225 * simply fail.
1226 */
1227 if (unlikely(in_nmi())) {
1228 if (!__raw_spin_trylock(&cpu_buffer->lock)) {
1229 cpu_buffer->nmi_dropped++;
1230 goto out_reset;
1231 }
1232 } else
1233 __raw_spin_lock(&cpu_buffer->lock);
1234
1235 lock_taken = true;
1236
1237 rb_inc_page(cpu_buffer, &next_page);
1238
1239 head_page = cpu_buffer->head_page;
1240 reader_page = cpu_buffer->reader_page;
1241
1242 /* we grabbed the lock before incrementing */
1243 if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
1244 goto out_reset;
1245
1246 /*
1247 * If for some reason, we had an interrupt storm that made
1248 * it all the way around the buffer, bail, and warn
1249 * about it.
1250 */
1251 if (unlikely(next_page == commit_page)) {
1252 cpu_buffer->commit_overrun++;
1253 goto out_reset;
1254 }
1255
1256 if (next_page == head_page) {
1257 if (!(buffer->flags & RB_FL_OVERWRITE))
1258 goto out_reset;
1259
1260 /* tail_page has not moved yet? */
1261 if (tail_page == cpu_buffer->tail_page) {
1262 /* count overflows */
1263 cpu_buffer->overrun +=
1264 local_read(&head_page->entries);
1265
1266 rb_inc_page(cpu_buffer, &head_page);
1267 cpu_buffer->head_page = head_page;
1268 cpu_buffer->head_page->read = 0;
1269 }
1270 }
1271
1272 /*
1273 * If the tail page is still the same as what we think
1274 * it is, then it is up to us to update the tail
1275 * pointer.
1276 */
1277 if (tail_page == cpu_buffer->tail_page) {
1278 local_set(&next_page->write, 0);
1279 local_set(&next_page->entries, 0);
1280 local_set(&next_page->page->commit, 0);
1281 cpu_buffer->tail_page = next_page;
1282
1283 /* reread the time stamp */
Steven Rostedt88eb0122009-05-11 16:28:23 -04001284 *ts = rb_time_stamp(buffer, cpu_buffer->cpu);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001285 cpu_buffer->tail_page->page->time_stamp = *ts;
1286 }
1287
Steven Rostedtc7b09302009-06-11 11:12:00 -04001288 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Steven Rostedtaa20ae82009-05-05 21:16:11 -04001289
1290 __raw_spin_unlock(&cpu_buffer->lock);
1291 local_irq_restore(flags);
1292
1293 /* fail and let the caller try again */
1294 return ERR_PTR(-EAGAIN);
1295
Steven Rostedt45141d42009-02-12 13:19:48 -05001296 out_reset:
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001297 /* reset write */
Steven Rostedtc7b09302009-06-11 11:12:00 -04001298 rb_reset_tail(cpu_buffer, tail_page, tail, length);
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001299
Steven Rostedt78d904b2009-02-05 18:43:07 -05001300 if (likely(lock_taken))
1301 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001302 local_irq_restore(flags);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001303 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001304}
1305
Steven Rostedt6634ff22009-05-06 15:30:07 -04001306static struct ring_buffer_event *
1307__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
1308 unsigned type, unsigned long length, u64 *ts)
1309{
1310 struct buffer_page *tail_page, *commit_page;
1311 struct ring_buffer_event *event;
1312 unsigned long tail, write;
1313
1314 commit_page = cpu_buffer->commit_page;
1315 /* we just need to protect against interrupts */
1316 barrier();
1317 tail_page = cpu_buffer->tail_page;
1318 write = local_add_return(length, &tail_page->write);
1319 tail = write - length;
1320
1321 /* See if we shot pass the end of this buffer page */
1322 if (write > BUF_PAGE_SIZE)
1323 return rb_move_tail(cpu_buffer, length, tail,
1324 commit_page, tail_page, ts);
1325
1326 /* We reserved something on the buffer */
1327
Steven Rostedt6634ff22009-05-06 15:30:07 -04001328 event = __rb_page_index(tail_page, tail);
Vegard Nossum1744a212009-02-28 08:29:44 +01001329 kmemcheck_annotate_bitfield(event, bitfield);
Steven Rostedt6634ff22009-05-06 15:30:07 -04001330 rb_update_event(event, type, length);
1331
1332 /* The passed in type is zero for DATA */
1333 if (likely(!type))
1334 local_inc(&tail_page->entries);
1335
1336 /*
Steven Rostedtfa743952009-06-16 12:37:57 -04001337 * If this is the first commit on the page, then update
1338 * its timestamp.
Steven Rostedt6634ff22009-05-06 15:30:07 -04001339 */
Steven Rostedtfa743952009-06-16 12:37:57 -04001340 if (!tail)
1341 tail_page->page->time_stamp = *ts;
Steven Rostedt6634ff22009-05-06 15:30:07 -04001342
1343 return event;
1344}
1345
Steven Rostedtedd813bf2009-06-02 23:00:53 -04001346static inline int
1347rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
1348 struct ring_buffer_event *event)
1349{
1350 unsigned long new_index, old_index;
1351 struct buffer_page *bpage;
1352 unsigned long index;
1353 unsigned long addr;
1354
1355 new_index = rb_event_index(event);
1356 old_index = new_index + rb_event_length(event);
1357 addr = (unsigned long)event;
1358 addr &= PAGE_MASK;
1359
1360 bpage = cpu_buffer->tail_page;
1361
1362 if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
1363 /*
1364 * This is on the tail page. It is possible that
1365 * a write could come in and move the tail page
1366 * and write to the next page. That is fine
1367 * because we just shorten what is on this page.
1368 */
1369 index = local_cmpxchg(&bpage->write, old_index, new_index);
1370 if (index == old_index)
1371 return 1;
1372 }
1373
1374 /* could not discard */
1375 return 0;
1376}
1377
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001378static int
1379rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
1380 u64 *ts, u64 *delta)
1381{
1382 struct ring_buffer_event *event;
1383 static int once;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001384 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001385
1386 if (unlikely(*delta > (1ULL << 59) && !once++)) {
1387 printk(KERN_WARNING "Delta way too big! %llu"
1388 " ts=%llu write stamp = %llu\n",
Stephen Rothwelle2862c92008-10-27 17:43:28 +11001389 (unsigned long long)*delta,
1390 (unsigned long long)*ts,
1391 (unsigned long long)cpu_buffer->write_stamp);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001392 WARN_ON(1);
1393 }
1394
1395 /*
1396 * The delta is too big, we to add a
1397 * new timestamp.
1398 */
1399 event = __rb_reserve_next(cpu_buffer,
1400 RINGBUF_TYPE_TIME_EXTEND,
1401 RB_LEN_TIME_EXTEND,
1402 ts);
1403 if (!event)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001404 return -EBUSY;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001405
Steven Rostedtbf41a152008-10-04 02:00:59 -04001406 if (PTR_ERR(event) == -EAGAIN)
1407 return -EAGAIN;
1408
1409 /* Only a commited time event can update the write stamp */
Steven Rostedtfa743952009-06-16 12:37:57 -04001410 if (rb_event_is_commit(cpu_buffer, event)) {
Steven Rostedtbf41a152008-10-04 02:00:59 -04001411 /*
Steven Rostedtfa743952009-06-16 12:37:57 -04001412 * If this is the first on the page, then it was
1413 * updated with the page itself. Try to discard it
1414 * and if we can't just make it zero.
Steven Rostedtbf41a152008-10-04 02:00:59 -04001415 */
1416 if (rb_event_index(event)) {
1417 event->time_delta = *delta & TS_MASK;
1418 event->array[0] = *delta >> TS_SHIFT;
1419 } else {
Steven Rostedtea05b572009-06-03 09:30:10 -04001420 /* try to discard, since we do not need this */
1421 if (!rb_try_to_discard(cpu_buffer, event)) {
1422 /* nope, just zero it */
1423 event->time_delta = 0;
1424 event->array[0] = 0;
1425 }
Steven Rostedtbf41a152008-10-04 02:00:59 -04001426 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001427 cpu_buffer->write_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001428 /* let the caller know this was the commit */
1429 ret = 1;
1430 } else {
Steven Rostedtedd813bf2009-06-02 23:00:53 -04001431 /* Try to discard the event */
1432 if (!rb_try_to_discard(cpu_buffer, event)) {
1433 /* Darn, this is just wasted space */
1434 event->time_delta = 0;
1435 event->array[0] = 0;
Steven Rostedtedd813bf2009-06-02 23:00:53 -04001436 }
Steven Rostedtf57a8a12009-06-05 14:11:30 -04001437 ret = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001438 }
1439
Steven Rostedtbf41a152008-10-04 02:00:59 -04001440 *delta = 0;
1441
1442 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001443}
1444
Steven Rostedtfa743952009-06-16 12:37:57 -04001445static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
1446{
1447 local_inc(&cpu_buffer->committing);
1448 local_inc(&cpu_buffer->commits);
1449}
1450
1451static void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
1452{
1453 unsigned long commits;
1454
1455 if (RB_WARN_ON(cpu_buffer,
1456 !local_read(&cpu_buffer->committing)))
1457 return;
1458
1459 again:
1460 commits = local_read(&cpu_buffer->commits);
1461 /* synchronize with interrupts */
1462 barrier();
1463 if (local_read(&cpu_buffer->committing) == 1)
1464 rb_set_commit_to_write(cpu_buffer);
1465
1466 local_dec(&cpu_buffer->committing);
1467
1468 /* synchronize with interrupts */
1469 barrier();
1470
1471 /*
1472 * Need to account for interrupts coming in between the
1473 * updating of the commit page and the clearing of the
1474 * committing counter.
1475 */
1476 if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
1477 !local_read(&cpu_buffer->committing)) {
1478 local_inc(&cpu_buffer->committing);
1479 goto again;
1480 }
1481}
1482
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001483static struct ring_buffer_event *
1484rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt1cd8d732009-05-11 14:08:09 -04001485 unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001486{
1487 struct ring_buffer_event *event;
Steven Rostedt168b6b12009-05-11 22:11:05 -04001488 u64 ts, delta = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001489 int commit = 0;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001490 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001491
Steven Rostedtfa743952009-06-16 12:37:57 -04001492 rb_start_commit(cpu_buffer);
1493
Steven Rostedtbe957c42009-05-11 14:42:53 -04001494 length = rb_calculate_event_length(length);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001495 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001496 /*
1497 * We allow for interrupts to reenter here and do a trace.
1498 * If one does, it will cause this original code to loop
1499 * back here. Even with heavy interrupts happening, this
1500 * should only happen a few times in a row. If this happens
1501 * 1000 times in a row, there must be either an interrupt
1502 * storm or we have something buggy.
1503 * Bail!
1504 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001505 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
Steven Rostedtfa743952009-06-16 12:37:57 -04001506 goto out_fail;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001507
Steven Rostedt88eb0122009-05-11 16:28:23 -04001508 ts = rb_time_stamp(cpu_buffer->buffer, cpu_buffer->cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001509
Steven Rostedtbf41a152008-10-04 02:00:59 -04001510 /*
1511 * Only the first commit can update the timestamp.
1512 * Yes there is a race here. If an interrupt comes in
1513 * just after the conditional and it traces too, then it
1514 * will also check the deltas. More than one timestamp may
1515 * also be made. But only the entry that did the actual
1516 * commit will be something other than zero.
1517 */
Steven Rostedt0f0c85f2009-05-11 16:08:00 -04001518 if (likely(cpu_buffer->tail_page == cpu_buffer->commit_page &&
1519 rb_page_write(cpu_buffer->tail_page) ==
1520 rb_commit_index(cpu_buffer))) {
Steven Rostedt168b6b12009-05-11 22:11:05 -04001521 u64 diff;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001522
Steven Rostedt168b6b12009-05-11 22:11:05 -04001523 diff = ts - cpu_buffer->write_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001524
Steven Rostedt168b6b12009-05-11 22:11:05 -04001525 /* make sure this diff is calculated here */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001526 barrier();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001527
Steven Rostedtbf41a152008-10-04 02:00:59 -04001528 /* Did the write stamp get updated already? */
1529 if (unlikely(ts < cpu_buffer->write_stamp))
Steven Rostedt168b6b12009-05-11 22:11:05 -04001530 goto get_event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001531
Steven Rostedt168b6b12009-05-11 22:11:05 -04001532 delta = diff;
1533 if (unlikely(test_time_stamp(delta))) {
Steven Rostedtbf41a152008-10-04 02:00:59 -04001534
1535 commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001536 if (commit == -EBUSY)
Steven Rostedtfa743952009-06-16 12:37:57 -04001537 goto out_fail;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001538
1539 if (commit == -EAGAIN)
1540 goto again;
1541
1542 RB_WARN_ON(cpu_buffer, commit < 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001543 }
Steven Rostedt168b6b12009-05-11 22:11:05 -04001544 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001545
Steven Rostedt168b6b12009-05-11 22:11:05 -04001546 get_event:
Steven Rostedt1cd8d732009-05-11 14:08:09 -04001547 event = __rb_reserve_next(cpu_buffer, 0, length, &ts);
Steven Rostedt168b6b12009-05-11 22:11:05 -04001548 if (unlikely(PTR_ERR(event) == -EAGAIN))
Steven Rostedtbf41a152008-10-04 02:00:59 -04001549 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001550
Steven Rostedtfa743952009-06-16 12:37:57 -04001551 if (!event)
1552 goto out_fail;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001553
Steven Rostedtfa743952009-06-16 12:37:57 -04001554 if (!rb_event_is_commit(cpu_buffer, event))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001555 delta = 0;
1556
1557 event->time_delta = delta;
1558
1559 return event;
Steven Rostedtfa743952009-06-16 12:37:57 -04001560
1561 out_fail:
1562 rb_end_commit(cpu_buffer);
1563 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001564}
1565
Paul Mundt1155de42009-06-25 14:30:12 +09001566#ifdef CONFIG_TRACING
1567
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001568#define TRACE_RECURSIVE_DEPTH 16
Steven Rostedt261842b2009-04-16 21:41:52 -04001569
1570static int trace_recursive_lock(void)
1571{
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001572 current->trace_recursion++;
Steven Rostedt261842b2009-04-16 21:41:52 -04001573
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001574 if (likely(current->trace_recursion < TRACE_RECURSIVE_DEPTH))
1575 return 0;
Steven Rostedt261842b2009-04-16 21:41:52 -04001576
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001577 /* Disable all tracing before we do anything else */
1578 tracing_off_permanent();
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02001579
Steven Rostedt7d7d2b82009-04-27 12:37:49 -04001580 printk_once(KERN_WARNING "Tracing recursion: depth[%ld]:"
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001581 "HC[%lu]:SC[%lu]:NMI[%lu]\n",
1582 current->trace_recursion,
1583 hardirq_count() >> HARDIRQ_SHIFT,
1584 softirq_count() >> SOFTIRQ_SHIFT,
1585 in_nmi());
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02001586
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001587 WARN_ON_ONCE(1);
1588 return -1;
Steven Rostedt261842b2009-04-16 21:41:52 -04001589}
1590
1591static void trace_recursive_unlock(void)
1592{
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001593 WARN_ON_ONCE(!current->trace_recursion);
Steven Rostedt261842b2009-04-16 21:41:52 -04001594
Steven Rostedtaa18efb2009-04-20 16:16:11 -04001595 current->trace_recursion--;
Steven Rostedt261842b2009-04-16 21:41:52 -04001596}
1597
Paul Mundt1155de42009-06-25 14:30:12 +09001598#else
1599
1600#define trace_recursive_lock() (0)
1601#define trace_recursive_unlock() do { } while (0)
1602
1603#endif
1604
Steven Rostedtbf41a152008-10-04 02:00:59 -04001605static DEFINE_PER_CPU(int, rb_need_resched);
1606
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001607/**
1608 * ring_buffer_lock_reserve - reserve a part of the buffer
1609 * @buffer: the ring buffer to reserve from
1610 * @length: the length of the data to reserve (excluding event header)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001611 *
1612 * Returns a reseverd event on the ring buffer to copy directly to.
1613 * The user of this interface will need to get the body to write into
1614 * and can use the ring_buffer_event_data() interface.
1615 *
1616 * The length is the length of the data needed, not the event length
1617 * which also includes the event header.
1618 *
1619 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
1620 * If NULL is returned, then nothing has been allocated or locked.
1621 */
1622struct ring_buffer_event *
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02001623ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001624{
1625 struct ring_buffer_per_cpu *cpu_buffer;
1626 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001627 int cpu, resched;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001628
Steven Rostedt033601a2008-11-21 12:41:55 -05001629 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05001630 return NULL;
1631
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001632 if (atomic_read(&buffer->record_disabled))
1633 return NULL;
1634
Steven Rostedtbf41a152008-10-04 02:00:59 -04001635 /* If we are tracing schedule, we don't want to recurse */
Steven Rostedt182e9f52008-11-03 23:15:56 -05001636 resched = ftrace_preempt_disable();
Steven Rostedtbf41a152008-10-04 02:00:59 -04001637
Steven Rostedt261842b2009-04-16 21:41:52 -04001638 if (trace_recursive_lock())
1639 goto out_nocheck;
1640
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001641 cpu = raw_smp_processor_id();
1642
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301643 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04001644 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001645
1646 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001647
1648 if (atomic_read(&cpu_buffer->record_disabled))
Steven Rostedtd7690412008-10-01 00:29:53 -04001649 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001650
Steven Rostedtbe957c42009-05-11 14:42:53 -04001651 if (length > BUF_MAX_DATA_SIZE)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001652 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001653
Steven Rostedt1cd8d732009-05-11 14:08:09 -04001654 event = rb_reserve_next_event(cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001655 if (!event)
Steven Rostedtd7690412008-10-01 00:29:53 -04001656 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001657
Steven Rostedtbf41a152008-10-04 02:00:59 -04001658 /*
1659 * Need to store resched state on this cpu.
1660 * Only the first needs to.
1661 */
1662
1663 if (preempt_count() == 1)
1664 per_cpu(rb_need_resched, cpu) = resched;
1665
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001666 return event;
1667
Steven Rostedtd7690412008-10-01 00:29:53 -04001668 out:
Steven Rostedt261842b2009-04-16 21:41:52 -04001669 trace_recursive_unlock();
1670
1671 out_nocheck:
Steven Rostedt182e9f52008-11-03 23:15:56 -05001672 ftrace_preempt_enable(resched);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001673 return NULL;
1674}
Robert Richterc4f50182008-12-11 16:49:22 +01001675EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001676
1677static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
1678 struct ring_buffer_event *event)
1679{
Steven Rostedte4906ef2009-04-30 20:49:44 -04001680 local_inc(&cpu_buffer->entries);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001681
Steven Rostedtfa743952009-06-16 12:37:57 -04001682 /*
1683 * The event first in the commit queue updates the
1684 * time stamp.
1685 */
1686 if (rb_event_is_commit(cpu_buffer, event))
1687 cpu_buffer->write_stamp += event->time_delta;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001688
Steven Rostedtfa743952009-06-16 12:37:57 -04001689 rb_end_commit(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001690}
1691
1692/**
1693 * ring_buffer_unlock_commit - commit a reserved
1694 * @buffer: The buffer to commit to
1695 * @event: The event pointer to commit.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001696 *
1697 * This commits the data to the ring buffer, and releases any locks held.
1698 *
1699 * Must be paired with ring_buffer_lock_reserve.
1700 */
1701int ring_buffer_unlock_commit(struct ring_buffer *buffer,
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02001702 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001703{
1704 struct ring_buffer_per_cpu *cpu_buffer;
1705 int cpu = raw_smp_processor_id();
1706
1707 cpu_buffer = buffer->buffers[cpu];
1708
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001709 rb_commit(cpu_buffer, event);
1710
Steven Rostedt261842b2009-04-16 21:41:52 -04001711 trace_recursive_unlock();
1712
Steven Rostedtbf41a152008-10-04 02:00:59 -04001713 /*
1714 * Only the last preempt count needs to restore preemption.
1715 */
Steven Rostedt182e9f52008-11-03 23:15:56 -05001716 if (preempt_count() == 1)
1717 ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
1718 else
Steven Rostedtbf41a152008-10-04 02:00:59 -04001719 preempt_enable_no_resched_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001720
1721 return 0;
1722}
Robert Richterc4f50182008-12-11 16:49:22 +01001723EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001724
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001725static inline void rb_event_discard(struct ring_buffer_event *event)
1726{
Lai Jiangshan334d4162009-04-24 11:27:05 +08001727 /* array[0] holds the actual length for the discarded event */
1728 event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
1729 event->type_len = RINGBUF_TYPE_PADDING;
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001730 /* time delta must be non zero */
1731 if (!event->time_delta)
1732 event->time_delta = 1;
1733}
1734
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001735/**
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001736 * ring_buffer_event_discard - discard any event in the ring buffer
1737 * @event: the event to discard
1738 *
1739 * Sometimes a event that is in the ring buffer needs to be ignored.
1740 * This function lets the user discard an event in the ring buffer
1741 * and then that event will not be read later.
1742 *
1743 * Note, it is up to the user to be careful with this, and protect
1744 * against races. If the user discards an event that has been consumed
1745 * it is possible that it could corrupt the ring buffer.
1746 */
1747void ring_buffer_event_discard(struct ring_buffer_event *event)
1748{
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001749 rb_event_discard(event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001750}
1751EXPORT_SYMBOL_GPL(ring_buffer_event_discard);
1752
1753/**
1754 * ring_buffer_commit_discard - discard an event that has not been committed
1755 * @buffer: the ring buffer
1756 * @event: non committed event to discard
1757 *
1758 * This is similar to ring_buffer_event_discard but must only be
1759 * performed on an event that has not been committed yet. The difference
1760 * is that this will also try to free the event from the ring buffer
1761 * if another event has not been added behind it.
1762 *
1763 * If another event has been added behind it, it will set the event
1764 * up as discarded, and perform the commit.
1765 *
1766 * If this function is called, do not call ring_buffer_unlock_commit on
1767 * the event.
1768 */
1769void ring_buffer_discard_commit(struct ring_buffer *buffer,
1770 struct ring_buffer_event *event)
1771{
1772 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001773 int cpu;
1774
1775 /* The event is discarded regardless */
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001776 rb_event_discard(event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001777
Steven Rostedtfa743952009-06-16 12:37:57 -04001778 cpu = smp_processor_id();
1779 cpu_buffer = buffer->buffers[cpu];
1780
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001781 /*
1782 * This must only be called if the event has not been
1783 * committed yet. Thus we can assume that preemption
1784 * is still disabled.
1785 */
Steven Rostedtfa743952009-06-16 12:37:57 -04001786 RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001787
Steven Rostedt0f2541d2009-08-05 12:02:48 -04001788 if (rb_try_to_discard(cpu_buffer, event))
Steven Rostedtedd813bf2009-06-02 23:00:53 -04001789 goto out;
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001790
1791 /*
1792 * The commit is still visible by the reader, so we
1793 * must increment entries.
1794 */
Steven Rostedte4906ef2009-04-30 20:49:44 -04001795 local_inc(&cpu_buffer->entries);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001796 out:
Steven Rostedtfa743952009-06-16 12:37:57 -04001797 rb_end_commit(cpu_buffer);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001798
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001799 trace_recursive_unlock();
1800
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001801 /*
1802 * Only the last preempt count needs to restore preemption.
1803 */
1804 if (preempt_count() == 1)
1805 ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
1806 else
1807 preempt_enable_no_resched_notrace();
1808
1809}
1810EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
1811
1812/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001813 * ring_buffer_write - write data to the buffer without reserving
1814 * @buffer: The ring buffer to write to.
1815 * @length: The length of the data being written (excluding the event header)
1816 * @data: The data to write to the buffer.
1817 *
1818 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
1819 * one function. If you already have the data to write to the buffer, it
1820 * may be easier to simply call this function.
1821 *
1822 * Note, like ring_buffer_lock_reserve, the length is the length of the data
1823 * and not the length of the event which would hold the header.
1824 */
1825int ring_buffer_write(struct ring_buffer *buffer,
1826 unsigned long length,
1827 void *data)
1828{
1829 struct ring_buffer_per_cpu *cpu_buffer;
1830 struct ring_buffer_event *event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001831 void *body;
1832 int ret = -EBUSY;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001833 int cpu, resched;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001834
Steven Rostedt033601a2008-11-21 12:41:55 -05001835 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05001836 return -EBUSY;
1837
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001838 if (atomic_read(&buffer->record_disabled))
1839 return -EBUSY;
1840
Steven Rostedt182e9f52008-11-03 23:15:56 -05001841 resched = ftrace_preempt_disable();
Steven Rostedtbf41a152008-10-04 02:00:59 -04001842
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001843 cpu = raw_smp_processor_id();
1844
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301845 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04001846 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001847
1848 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001849
1850 if (atomic_read(&cpu_buffer->record_disabled))
1851 goto out;
1852
Steven Rostedtbe957c42009-05-11 14:42:53 -04001853 if (length > BUF_MAX_DATA_SIZE)
1854 goto out;
1855
1856 event = rb_reserve_next_event(cpu_buffer, length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001857 if (!event)
1858 goto out;
1859
1860 body = rb_event_data(event);
1861
1862 memcpy(body, data, length);
1863
1864 rb_commit(cpu_buffer, event);
1865
1866 ret = 0;
1867 out:
Steven Rostedt182e9f52008-11-03 23:15:56 -05001868 ftrace_preempt_enable(resched);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001869
1870 return ret;
1871}
Robert Richterc4f50182008-12-11 16:49:22 +01001872EXPORT_SYMBOL_GPL(ring_buffer_write);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001873
Andrew Morton34a148b2009-01-09 12:27:09 -08001874static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001875{
1876 struct buffer_page *reader = cpu_buffer->reader_page;
1877 struct buffer_page *head = cpu_buffer->head_page;
1878 struct buffer_page *commit = cpu_buffer->commit_page;
1879
1880 return reader->read == rb_page_commit(reader) &&
1881 (commit == reader ||
1882 (commit == head &&
1883 head->read == rb_page_commit(commit)));
1884}
1885
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001886/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001887 * ring_buffer_record_disable - stop all writes into the buffer
1888 * @buffer: The ring buffer to stop writes to.
1889 *
1890 * This prevents all writes to the buffer. Any attempt to write
1891 * to the buffer after this will fail and return NULL.
1892 *
1893 * The caller should call synchronize_sched() after this.
1894 */
1895void ring_buffer_record_disable(struct ring_buffer *buffer)
1896{
1897 atomic_inc(&buffer->record_disabled);
1898}
Robert Richterc4f50182008-12-11 16:49:22 +01001899EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001900
1901/**
1902 * ring_buffer_record_enable - enable writes to the buffer
1903 * @buffer: The ring buffer to enable writes
1904 *
1905 * Note, multiple disables will need the same number of enables
1906 * to truely enable the writing (much like preempt_disable).
1907 */
1908void ring_buffer_record_enable(struct ring_buffer *buffer)
1909{
1910 atomic_dec(&buffer->record_disabled);
1911}
Robert Richterc4f50182008-12-11 16:49:22 +01001912EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001913
1914/**
1915 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
1916 * @buffer: The ring buffer to stop writes to.
1917 * @cpu: The CPU buffer to stop
1918 *
1919 * This prevents all writes to the buffer. Any attempt to write
1920 * to the buffer after this will fail and return NULL.
1921 *
1922 * The caller should call synchronize_sched() after this.
1923 */
1924void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
1925{
1926 struct ring_buffer_per_cpu *cpu_buffer;
1927
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301928 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001929 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001930
1931 cpu_buffer = buffer->buffers[cpu];
1932 atomic_inc(&cpu_buffer->record_disabled);
1933}
Robert Richterc4f50182008-12-11 16:49:22 +01001934EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001935
1936/**
1937 * ring_buffer_record_enable_cpu - enable writes to the buffer
1938 * @buffer: The ring buffer to enable writes
1939 * @cpu: The CPU to enable.
1940 *
1941 * Note, multiple disables will need the same number of enables
1942 * to truely enable the writing (much like preempt_disable).
1943 */
1944void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
1945{
1946 struct ring_buffer_per_cpu *cpu_buffer;
1947
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301948 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001949 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001950
1951 cpu_buffer = buffer->buffers[cpu];
1952 atomic_dec(&cpu_buffer->record_disabled);
1953}
Robert Richterc4f50182008-12-11 16:49:22 +01001954EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001955
1956/**
1957 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
1958 * @buffer: The ring buffer
1959 * @cpu: The per CPU buffer to get the entries from.
1960 */
1961unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
1962{
1963 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04001964 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001965
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301966 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001967 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001968
1969 cpu_buffer = buffer->buffers[cpu];
Steven Rostedte4906ef2009-04-30 20:49:44 -04001970 ret = (local_read(&cpu_buffer->entries) - cpu_buffer->overrun)
1971 - cpu_buffer->read;
Steven Rostedt554f7862009-03-11 22:00:13 -04001972
1973 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001974}
Robert Richterc4f50182008-12-11 16:49:22 +01001975EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001976
1977/**
1978 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
1979 * @buffer: The ring buffer
1980 * @cpu: The per CPU buffer to get the number of overruns from
1981 */
1982unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
1983{
1984 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04001985 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001986
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301987 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001988 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001989
1990 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04001991 ret = cpu_buffer->overrun;
Steven Rostedt554f7862009-03-11 22:00:13 -04001992
1993 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001994}
Robert Richterc4f50182008-12-11 16:49:22 +01001995EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001996
1997/**
Steven Rostedtf0d2c682009-04-29 13:43:37 -04001998 * ring_buffer_nmi_dropped_cpu - get the number of nmis that were dropped
1999 * @buffer: The ring buffer
2000 * @cpu: The per CPU buffer to get the number of overruns from
2001 */
2002unsigned long ring_buffer_nmi_dropped_cpu(struct ring_buffer *buffer, int cpu)
2003{
2004 struct ring_buffer_per_cpu *cpu_buffer;
2005 unsigned long ret;
2006
2007 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2008 return 0;
2009
2010 cpu_buffer = buffer->buffers[cpu];
2011 ret = cpu_buffer->nmi_dropped;
2012
2013 return ret;
2014}
2015EXPORT_SYMBOL_GPL(ring_buffer_nmi_dropped_cpu);
2016
2017/**
2018 * ring_buffer_commit_overrun_cpu - get the number of overruns caused by commits
2019 * @buffer: The ring buffer
2020 * @cpu: The per CPU buffer to get the number of overruns from
2021 */
2022unsigned long
2023ring_buffer_commit_overrun_cpu(struct ring_buffer *buffer, int cpu)
2024{
2025 struct ring_buffer_per_cpu *cpu_buffer;
2026 unsigned long ret;
2027
2028 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2029 return 0;
2030
2031 cpu_buffer = buffer->buffers[cpu];
2032 ret = cpu_buffer->commit_overrun;
2033
2034 return ret;
2035}
2036EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
2037
2038/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002039 * ring_buffer_entries - get the number of entries in a buffer
2040 * @buffer: The ring buffer
2041 *
2042 * Returns the total number of entries in the ring buffer
2043 * (all CPU entries)
2044 */
2045unsigned long ring_buffer_entries(struct ring_buffer *buffer)
2046{
2047 struct ring_buffer_per_cpu *cpu_buffer;
2048 unsigned long entries = 0;
2049 int cpu;
2050
2051 /* if you care about this being correct, lock the buffer */
2052 for_each_buffer_cpu(buffer, cpu) {
2053 cpu_buffer = buffer->buffers[cpu];
Steven Rostedte4906ef2009-04-30 20:49:44 -04002054 entries += (local_read(&cpu_buffer->entries) -
2055 cpu_buffer->overrun) - cpu_buffer->read;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002056 }
2057
2058 return entries;
2059}
Robert Richterc4f50182008-12-11 16:49:22 +01002060EXPORT_SYMBOL_GPL(ring_buffer_entries);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002061
2062/**
2063 * ring_buffer_overrun_cpu - get the number of overruns in buffer
2064 * @buffer: The ring buffer
2065 *
2066 * Returns the total number of overruns in the ring buffer
2067 * (all CPU entries)
2068 */
2069unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
2070{
2071 struct ring_buffer_per_cpu *cpu_buffer;
2072 unsigned long overruns = 0;
2073 int cpu;
2074
2075 /* if you care about this being correct, lock the buffer */
2076 for_each_buffer_cpu(buffer, cpu) {
2077 cpu_buffer = buffer->buffers[cpu];
2078 overruns += cpu_buffer->overrun;
2079 }
2080
2081 return overruns;
2082}
Robert Richterc4f50182008-12-11 16:49:22 +01002083EXPORT_SYMBOL_GPL(ring_buffer_overruns);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002084
Steven Rostedt642edba2008-11-12 00:01:26 -05002085static void rb_iter_reset(struct ring_buffer_iter *iter)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002086{
2087 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2088
Steven Rostedtd7690412008-10-01 00:29:53 -04002089 /* Iterator usage is expected to have record disabled */
2090 if (list_empty(&cpu_buffer->reader_page->list)) {
2091 iter->head_page = cpu_buffer->head_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002092 iter->head = cpu_buffer->head_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04002093 } else {
2094 iter->head_page = cpu_buffer->reader_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002095 iter->head = cpu_buffer->reader_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04002096 }
2097 if (iter->head)
2098 iter->read_stamp = cpu_buffer->read_stamp;
2099 else
Steven Rostedtabc9b562008-12-02 15:34:06 -05002100 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt642edba2008-11-12 00:01:26 -05002101}
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002102
Steven Rostedt642edba2008-11-12 00:01:26 -05002103/**
2104 * ring_buffer_iter_reset - reset an iterator
2105 * @iter: The iterator to reset
2106 *
2107 * Resets the iterator, so that it will start from the beginning
2108 * again.
2109 */
2110void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
2111{
Steven Rostedt554f7862009-03-11 22:00:13 -04002112 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt642edba2008-11-12 00:01:26 -05002113 unsigned long flags;
2114
Steven Rostedt554f7862009-03-11 22:00:13 -04002115 if (!iter)
2116 return;
2117
2118 cpu_buffer = iter->cpu_buffer;
2119
Steven Rostedt642edba2008-11-12 00:01:26 -05002120 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2121 rb_iter_reset(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002122 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002123}
Robert Richterc4f50182008-12-11 16:49:22 +01002124EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002125
2126/**
2127 * ring_buffer_iter_empty - check if an iterator has no more to read
2128 * @iter: The iterator to check
2129 */
2130int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
2131{
2132 struct ring_buffer_per_cpu *cpu_buffer;
2133
2134 cpu_buffer = iter->cpu_buffer;
2135
Steven Rostedtbf41a152008-10-04 02:00:59 -04002136 return iter->head_page == cpu_buffer->commit_page &&
2137 iter->head == rb_commit_index(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002138}
Robert Richterc4f50182008-12-11 16:49:22 +01002139EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002140
2141static void
2142rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
2143 struct ring_buffer_event *event)
2144{
2145 u64 delta;
2146
Lai Jiangshan334d4162009-04-24 11:27:05 +08002147 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002148 case RINGBUF_TYPE_PADDING:
2149 return;
2150
2151 case RINGBUF_TYPE_TIME_EXTEND:
2152 delta = event->array[0];
2153 delta <<= TS_SHIFT;
2154 delta += event->time_delta;
2155 cpu_buffer->read_stamp += delta;
2156 return;
2157
2158 case RINGBUF_TYPE_TIME_STAMP:
2159 /* FIXME: not implemented */
2160 return;
2161
2162 case RINGBUF_TYPE_DATA:
2163 cpu_buffer->read_stamp += event->time_delta;
2164 return;
2165
2166 default:
2167 BUG();
2168 }
2169 return;
2170}
2171
2172static void
2173rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
2174 struct ring_buffer_event *event)
2175{
2176 u64 delta;
2177
Lai Jiangshan334d4162009-04-24 11:27:05 +08002178 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002179 case RINGBUF_TYPE_PADDING:
2180 return;
2181
2182 case RINGBUF_TYPE_TIME_EXTEND:
2183 delta = event->array[0];
2184 delta <<= TS_SHIFT;
2185 delta += event->time_delta;
2186 iter->read_stamp += delta;
2187 return;
2188
2189 case RINGBUF_TYPE_TIME_STAMP:
2190 /* FIXME: not implemented */
2191 return;
2192
2193 case RINGBUF_TYPE_DATA:
2194 iter->read_stamp += event->time_delta;
2195 return;
2196
2197 default:
2198 BUG();
2199 }
2200 return;
2201}
2202
Steven Rostedtd7690412008-10-01 00:29:53 -04002203static struct buffer_page *
2204rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002205{
Steven Rostedtd7690412008-10-01 00:29:53 -04002206 struct buffer_page *reader = NULL;
2207 unsigned long flags;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002208 int nr_loops = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04002209
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002210 local_irq_save(flags);
2211 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedtd7690412008-10-01 00:29:53 -04002212
2213 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002214 /*
2215 * This should normally only loop twice. But because the
2216 * start of the reader inserts an empty page, it causes
2217 * a case where we will loop three times. There should be no
2218 * reason to loop four times (that I know of).
2219 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002220 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002221 reader = NULL;
2222 goto out;
2223 }
2224
Steven Rostedtd7690412008-10-01 00:29:53 -04002225 reader = cpu_buffer->reader_page;
2226
2227 /* If there's more to read, return this page */
Steven Rostedtbf41a152008-10-04 02:00:59 -04002228 if (cpu_buffer->reader_page->read < rb_page_size(reader))
Steven Rostedtd7690412008-10-01 00:29:53 -04002229 goto out;
2230
2231 /* Never should we have an index greater than the size */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002232 if (RB_WARN_ON(cpu_buffer,
2233 cpu_buffer->reader_page->read > rb_page_size(reader)))
2234 goto out;
Steven Rostedtd7690412008-10-01 00:29:53 -04002235
2236 /* check if we caught up to the tail */
2237 reader = NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002238 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
Steven Rostedtd7690412008-10-01 00:29:53 -04002239 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002240
2241 /*
Steven Rostedtd7690412008-10-01 00:29:53 -04002242 * Splice the empty reader page into the list around the head.
2243 * Reset the reader page to size zero.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002244 */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002245
Steven Rostedtd7690412008-10-01 00:29:53 -04002246 reader = cpu_buffer->head_page;
2247 cpu_buffer->reader_page->list.next = reader->list.next;
2248 cpu_buffer->reader_page->list.prev = reader->list.prev;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002249
2250 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04002251 local_set(&cpu_buffer->reader_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002252 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedtd7690412008-10-01 00:29:53 -04002253
2254 /* Make the reader page now replace the head */
2255 reader->list.prev->next = &cpu_buffer->reader_page->list;
2256 reader->list.next->prev = &cpu_buffer->reader_page->list;
2257
2258 /*
2259 * If the tail is on the reader, then we must set the head
2260 * to the inserted page, otherwise we set it one before.
2261 */
2262 cpu_buffer->head_page = cpu_buffer->reader_page;
2263
Steven Rostedtbf41a152008-10-04 02:00:59 -04002264 if (cpu_buffer->commit_page != reader)
Steven Rostedtd7690412008-10-01 00:29:53 -04002265 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
2266
2267 /* Finally update the reader page to the new head */
2268 cpu_buffer->reader_page = reader;
2269 rb_reset_reader_page(cpu_buffer);
2270
2271 goto again;
2272
2273 out:
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002274 __raw_spin_unlock(&cpu_buffer->lock);
2275 local_irq_restore(flags);
Steven Rostedtd7690412008-10-01 00:29:53 -04002276
2277 return reader;
2278}
2279
2280static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
2281{
2282 struct ring_buffer_event *event;
2283 struct buffer_page *reader;
2284 unsigned length;
2285
2286 reader = rb_get_reader_page(cpu_buffer);
2287
2288 /* This function should not be called when buffer is empty */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002289 if (RB_WARN_ON(cpu_buffer, !reader))
2290 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04002291
2292 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002293
Lai Jiangshan334d4162009-04-24 11:27:05 +08002294 if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX
2295 || rb_discarded_event(event))
Steven Rostedte4906ef2009-04-30 20:49:44 -04002296 cpu_buffer->read++;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002297
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002298 rb_update_read_stamp(cpu_buffer, event);
2299
Steven Rostedtd7690412008-10-01 00:29:53 -04002300 length = rb_event_length(event);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002301 cpu_buffer->reader_page->read += length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002302}
2303
2304static void rb_advance_iter(struct ring_buffer_iter *iter)
2305{
2306 struct ring_buffer *buffer;
2307 struct ring_buffer_per_cpu *cpu_buffer;
2308 struct ring_buffer_event *event;
2309 unsigned length;
2310
2311 cpu_buffer = iter->cpu_buffer;
2312 buffer = cpu_buffer->buffer;
2313
2314 /*
2315 * Check if we are at the end of the buffer.
2316 */
Steven Rostedtbf41a152008-10-04 02:00:59 -04002317 if (iter->head >= rb_page_size(iter->head_page)) {
Steven Rostedtea05b572009-06-03 09:30:10 -04002318 /* discarded commits can make the page empty */
2319 if (iter->head_page == cpu_buffer->commit_page)
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002320 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04002321 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002322 return;
2323 }
2324
2325 event = rb_iter_head_event(iter);
2326
2327 length = rb_event_length(event);
2328
2329 /*
2330 * This should not be called to advance the header if we are
2331 * at the tail of the buffer.
2332 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002333 if (RB_WARN_ON(cpu_buffer,
Steven Rostedtf536aaf2008-11-10 23:07:30 -05002334 (iter->head_page == cpu_buffer->commit_page) &&
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002335 (iter->head + length > rb_commit_index(cpu_buffer))))
2336 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002337
2338 rb_update_iter_read_stamp(iter, event);
2339
2340 iter->head += length;
2341
2342 /* check for end of page padding */
Steven Rostedtbf41a152008-10-04 02:00:59 -04002343 if ((iter->head >= rb_page_size(iter->head_page)) &&
2344 (iter->head_page != cpu_buffer->commit_page))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002345 rb_advance_iter(iter);
2346}
2347
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002348static struct ring_buffer_event *
2349rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002350{
2351 struct ring_buffer_per_cpu *cpu_buffer;
2352 struct ring_buffer_event *event;
Steven Rostedtd7690412008-10-01 00:29:53 -04002353 struct buffer_page *reader;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002354 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002355
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002356 cpu_buffer = buffer->buffers[cpu];
2357
2358 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002359 /*
2360 * We repeat when a timestamp is encountered. It is possible
2361 * to get multiple timestamps from an interrupt entering just
Steven Rostedtea05b572009-06-03 09:30:10 -04002362 * as one timestamp is about to be written, or from discarded
2363 * commits. The most that we can have is the number on a single page.
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002364 */
Steven Rostedtea05b572009-06-03 09:30:10 -04002365 if (RB_WARN_ON(cpu_buffer, ++nr_loops > RB_TIMESTAMPS_PER_PAGE))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002366 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002367
Steven Rostedtd7690412008-10-01 00:29:53 -04002368 reader = rb_get_reader_page(cpu_buffer);
2369 if (!reader)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002370 return NULL;
2371
Steven Rostedtd7690412008-10-01 00:29:53 -04002372 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002373
Lai Jiangshan334d4162009-04-24 11:27:05 +08002374 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002375 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05002376 if (rb_null_event(event))
2377 RB_WARN_ON(cpu_buffer, 1);
2378 /*
2379 * Because the writer could be discarding every
2380 * event it creates (which would probably be bad)
2381 * if we were to go back to "again" then we may never
2382 * catch up, and will trigger the warn on, or lock
2383 * the box. Return the padding, and we will release
2384 * the current locks, and try again.
2385 */
Tom Zanussi2d622712009-03-22 03:30:49 -05002386 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002387
2388 case RINGBUF_TYPE_TIME_EXTEND:
2389 /* Internal data, OK to advance */
Steven Rostedtd7690412008-10-01 00:29:53 -04002390 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002391 goto again;
2392
2393 case RINGBUF_TYPE_TIME_STAMP:
2394 /* FIXME: not implemented */
Steven Rostedtd7690412008-10-01 00:29:53 -04002395 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002396 goto again;
2397
2398 case RINGBUF_TYPE_DATA:
2399 if (ts) {
2400 *ts = cpu_buffer->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04002401 ring_buffer_normalize_time_stamp(buffer,
2402 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002403 }
2404 return event;
2405
2406 default:
2407 BUG();
2408 }
2409
2410 return NULL;
2411}
Robert Richterc4f50182008-12-11 16:49:22 +01002412EXPORT_SYMBOL_GPL(ring_buffer_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002413
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002414static struct ring_buffer_event *
2415rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002416{
2417 struct ring_buffer *buffer;
2418 struct ring_buffer_per_cpu *cpu_buffer;
2419 struct ring_buffer_event *event;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002420 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002421
2422 if (ring_buffer_iter_empty(iter))
2423 return NULL;
2424
2425 cpu_buffer = iter->cpu_buffer;
2426 buffer = cpu_buffer->buffer;
2427
2428 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002429 /*
Steven Rostedtea05b572009-06-03 09:30:10 -04002430 * We repeat when a timestamp is encountered.
2431 * We can get multiple timestamps by nested interrupts or also
2432 * if filtering is on (discarding commits). Since discarding
2433 * commits can be frequent we can get a lot of timestamps.
2434 * But we limit them by not adding timestamps if they begin
2435 * at the start of a page.
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002436 */
Steven Rostedtea05b572009-06-03 09:30:10 -04002437 if (RB_WARN_ON(cpu_buffer, ++nr_loops > RB_TIMESTAMPS_PER_PAGE))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002438 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002439
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002440 if (rb_per_cpu_empty(cpu_buffer))
2441 return NULL;
2442
2443 event = rb_iter_head_event(iter);
2444
Lai Jiangshan334d4162009-04-24 11:27:05 +08002445 switch (event->type_len) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002446 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05002447 if (rb_null_event(event)) {
2448 rb_inc_iter(iter);
2449 goto again;
2450 }
2451 rb_advance_iter(iter);
2452 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002453
2454 case RINGBUF_TYPE_TIME_EXTEND:
2455 /* Internal data, OK to advance */
2456 rb_advance_iter(iter);
2457 goto again;
2458
2459 case RINGBUF_TYPE_TIME_STAMP:
2460 /* FIXME: not implemented */
2461 rb_advance_iter(iter);
2462 goto again;
2463
2464 case RINGBUF_TYPE_DATA:
2465 if (ts) {
2466 *ts = iter->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04002467 ring_buffer_normalize_time_stamp(buffer,
2468 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002469 }
2470 return event;
2471
2472 default:
2473 BUG();
2474 }
2475
2476 return NULL;
2477}
Robert Richterc4f50182008-12-11 16:49:22 +01002478EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002479
Steven Rostedt8d707e82009-06-16 21:22:48 -04002480static inline int rb_ok_to_lock(void)
2481{
2482 /*
2483 * If an NMI die dumps out the content of the ring buffer
2484 * do not grab locks. We also permanently disable the ring
2485 * buffer too. A one time deal is all you get from reading
2486 * the ring buffer from an NMI.
2487 */
Steven Rostedt464e85e2009-08-05 15:26:37 -04002488 if (likely(!in_nmi()))
Steven Rostedt8d707e82009-06-16 21:22:48 -04002489 return 1;
2490
2491 tracing_off_permanent();
2492 return 0;
2493}
2494
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002495/**
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002496 * ring_buffer_peek - peek at the next event to be read
2497 * @buffer: The ring buffer to read
2498 * @cpu: The cpu to peak at
2499 * @ts: The timestamp counter of this event.
2500 *
2501 * This will return the event that will be read next, but does
2502 * not consume the data.
2503 */
2504struct ring_buffer_event *
2505ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
2506{
2507 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8aabee52009-03-12 13:13:49 -04002508 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002509 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04002510 int dolock;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002511
Steven Rostedt554f7862009-03-11 22:00:13 -04002512 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002513 return NULL;
Steven Rostedt554f7862009-03-11 22:00:13 -04002514
Steven Rostedt8d707e82009-06-16 21:22:48 -04002515 dolock = rb_ok_to_lock();
Tom Zanussi2d622712009-03-22 03:30:49 -05002516 again:
Steven Rostedt8d707e82009-06-16 21:22:48 -04002517 local_irq_save(flags);
2518 if (dolock)
2519 spin_lock(&cpu_buffer->reader_lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002520 event = rb_buffer_peek(buffer, cpu, ts);
Robert Richter469535a2009-07-30 19:19:18 +02002521 if (event && event->type_len == RINGBUF_TYPE_PADDING)
2522 rb_advance_reader(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04002523 if (dolock)
2524 spin_unlock(&cpu_buffer->reader_lock);
2525 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002526
Lai Jiangshan334d4162009-04-24 11:27:05 +08002527 if (event && event->type_len == RINGBUF_TYPE_PADDING) {
Tom Zanussi2d622712009-03-22 03:30:49 -05002528 cpu_relax();
2529 goto again;
2530 }
2531
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002532 return event;
2533}
2534
2535/**
2536 * ring_buffer_iter_peek - peek at the next event to be read
2537 * @iter: The ring buffer iterator
2538 * @ts: The timestamp counter of this event.
2539 *
2540 * This will return the event that will be read next, but does
2541 * not increment the iterator.
2542 */
2543struct ring_buffer_event *
2544ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
2545{
2546 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2547 struct ring_buffer_event *event;
2548 unsigned long flags;
2549
Tom Zanussi2d622712009-03-22 03:30:49 -05002550 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002551 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2552 event = rb_iter_peek(iter, ts);
2553 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2554
Lai Jiangshan334d4162009-04-24 11:27:05 +08002555 if (event && event->type_len == RINGBUF_TYPE_PADDING) {
Tom Zanussi2d622712009-03-22 03:30:49 -05002556 cpu_relax();
2557 goto again;
2558 }
2559
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002560 return event;
2561}
2562
2563/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002564 * ring_buffer_consume - return an event and consume it
2565 * @buffer: The ring buffer to get the next event from
2566 *
2567 * Returns the next event in the ring buffer, and that event is consumed.
2568 * Meaning, that sequential reads will keep returning a different event,
2569 * and eventually empty the ring buffer if the producer is slower.
2570 */
2571struct ring_buffer_event *
2572ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
2573{
Steven Rostedt554f7862009-03-11 22:00:13 -04002574 struct ring_buffer_per_cpu *cpu_buffer;
2575 struct ring_buffer_event *event = NULL;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002576 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04002577 int dolock;
2578
2579 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002580
Tom Zanussi2d622712009-03-22 03:30:49 -05002581 again:
Steven Rostedt554f7862009-03-11 22:00:13 -04002582 /* might be called in atomic */
2583 preempt_disable();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002584
Steven Rostedt554f7862009-03-11 22:00:13 -04002585 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2586 goto out;
2587
2588 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04002589 local_irq_save(flags);
2590 if (dolock)
2591 spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002592
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002593 event = rb_buffer_peek(buffer, cpu, ts);
Robert Richter469535a2009-07-30 19:19:18 +02002594 if (event)
2595 rb_advance_reader(cpu_buffer);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002596
Steven Rostedt8d707e82009-06-16 21:22:48 -04002597 if (dolock)
2598 spin_unlock(&cpu_buffer->reader_lock);
2599 local_irq_restore(flags);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002600
Steven Rostedt554f7862009-03-11 22:00:13 -04002601 out:
2602 preempt_enable();
2603
Lai Jiangshan334d4162009-04-24 11:27:05 +08002604 if (event && event->type_len == RINGBUF_TYPE_PADDING) {
Tom Zanussi2d622712009-03-22 03:30:49 -05002605 cpu_relax();
2606 goto again;
2607 }
2608
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002609 return event;
2610}
Robert Richterc4f50182008-12-11 16:49:22 +01002611EXPORT_SYMBOL_GPL(ring_buffer_consume);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002612
2613/**
2614 * ring_buffer_read_start - start a non consuming read of the buffer
2615 * @buffer: The ring buffer to read from
2616 * @cpu: The cpu buffer to iterate over
2617 *
2618 * This starts up an iteration through the buffer. It also disables
2619 * the recording to the buffer until the reading is finished.
2620 * This prevents the reading from being corrupted. This is not
2621 * a consuming read, so a producer is not expected.
2622 *
2623 * Must be paired with ring_buffer_finish.
2624 */
2625struct ring_buffer_iter *
2626ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
2627{
2628 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04002629 struct ring_buffer_iter *iter;
Steven Rostedtd7690412008-10-01 00:29:53 -04002630 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002631
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302632 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002633 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002634
2635 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
2636 if (!iter)
Steven Rostedt8aabee52009-03-12 13:13:49 -04002637 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002638
2639 cpu_buffer = buffer->buffers[cpu];
2640
2641 iter->cpu_buffer = cpu_buffer;
2642
2643 atomic_inc(&cpu_buffer->record_disabled);
2644 synchronize_sched();
2645
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002646 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002647 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt642edba2008-11-12 00:01:26 -05002648 rb_iter_reset(iter);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002649 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002650 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002651
2652 return iter;
2653}
Robert Richterc4f50182008-12-11 16:49:22 +01002654EXPORT_SYMBOL_GPL(ring_buffer_read_start);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002655
2656/**
2657 * ring_buffer_finish - finish reading the iterator of the buffer
2658 * @iter: The iterator retrieved by ring_buffer_start
2659 *
2660 * This re-enables the recording to the buffer, and frees the
2661 * iterator.
2662 */
2663void
2664ring_buffer_read_finish(struct ring_buffer_iter *iter)
2665{
2666 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2667
2668 atomic_dec(&cpu_buffer->record_disabled);
2669 kfree(iter);
2670}
Robert Richterc4f50182008-12-11 16:49:22 +01002671EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002672
2673/**
2674 * ring_buffer_read - read the next item in the ring buffer by the iterator
2675 * @iter: The ring buffer iterator
2676 * @ts: The time stamp of the event read.
2677 *
2678 * This reads the next event in the ring buffer and increments the iterator.
2679 */
2680struct ring_buffer_event *
2681ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
2682{
2683 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002684 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2685 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002686
Tom Zanussi2d622712009-03-22 03:30:49 -05002687 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002688 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2689 event = rb_iter_peek(iter, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002690 if (!event)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002691 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002692
2693 rb_advance_iter(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002694 out:
2695 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002696
Lai Jiangshan334d4162009-04-24 11:27:05 +08002697 if (event && event->type_len == RINGBUF_TYPE_PADDING) {
Tom Zanussi2d622712009-03-22 03:30:49 -05002698 cpu_relax();
2699 goto again;
2700 }
2701
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002702 return event;
2703}
Robert Richterc4f50182008-12-11 16:49:22 +01002704EXPORT_SYMBOL_GPL(ring_buffer_read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002705
2706/**
2707 * ring_buffer_size - return the size of the ring buffer (in bytes)
2708 * @buffer: The ring buffer.
2709 */
2710unsigned long ring_buffer_size(struct ring_buffer *buffer)
2711{
2712 return BUF_PAGE_SIZE * buffer->pages;
2713}
Robert Richterc4f50182008-12-11 16:49:22 +01002714EXPORT_SYMBOL_GPL(ring_buffer_size);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002715
2716static void
2717rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
2718{
2719 cpu_buffer->head_page
2720 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002721 local_set(&cpu_buffer->head_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04002722 local_set(&cpu_buffer->head_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002723 local_set(&cpu_buffer->head_page->page->commit, 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002724
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002725 cpu_buffer->head_page->read = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002726
2727 cpu_buffer->tail_page = cpu_buffer->head_page;
2728 cpu_buffer->commit_page = cpu_buffer->head_page;
2729
2730 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
2731 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04002732 local_set(&cpu_buffer->reader_page->entries, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002733 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002734 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04002735
Steven Rostedtf0d2c682009-04-29 13:43:37 -04002736 cpu_buffer->nmi_dropped = 0;
2737 cpu_buffer->commit_overrun = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002738 cpu_buffer->overrun = 0;
Steven Rostedte4906ef2009-04-30 20:49:44 -04002739 cpu_buffer->read = 0;
2740 local_set(&cpu_buffer->entries, 0);
Steven Rostedtfa743952009-06-16 12:37:57 -04002741 local_set(&cpu_buffer->committing, 0);
2742 local_set(&cpu_buffer->commits, 0);
Steven Rostedt69507c02009-01-21 18:45:57 -05002743
2744 cpu_buffer->write_stamp = 0;
2745 cpu_buffer->read_stamp = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002746}
2747
2748/**
2749 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
2750 * @buffer: The ring buffer to reset a per cpu buffer of
2751 * @cpu: The CPU buffer to be reset
2752 */
2753void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
2754{
2755 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2756 unsigned long flags;
2757
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302758 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002759 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002760
Steven Rostedt41ede232009-05-01 20:26:54 -04002761 atomic_inc(&cpu_buffer->record_disabled);
2762
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002763 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2764
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002765 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002766
2767 rb_reset_cpu(cpu_buffer);
2768
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002769 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002770
2771 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt41ede232009-05-01 20:26:54 -04002772
2773 atomic_dec(&cpu_buffer->record_disabled);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002774}
Robert Richterc4f50182008-12-11 16:49:22 +01002775EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002776
2777/**
2778 * ring_buffer_reset - reset a ring buffer
2779 * @buffer: The ring buffer to reset all cpu buffers
2780 */
2781void ring_buffer_reset(struct ring_buffer *buffer)
2782{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002783 int cpu;
2784
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002785 for_each_buffer_cpu(buffer, cpu)
Steven Rostedtd7690412008-10-01 00:29:53 -04002786 ring_buffer_reset_cpu(buffer, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002787}
Robert Richterc4f50182008-12-11 16:49:22 +01002788EXPORT_SYMBOL_GPL(ring_buffer_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002789
2790/**
2791 * rind_buffer_empty - is the ring buffer empty?
2792 * @buffer: The ring buffer to test
2793 */
2794int ring_buffer_empty(struct ring_buffer *buffer)
2795{
2796 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04002797 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04002798 int dolock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002799 int cpu;
Steven Rostedtd4788202009-06-17 00:39:43 -04002800 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002801
Steven Rostedt8d707e82009-06-16 21:22:48 -04002802 dolock = rb_ok_to_lock();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002803
2804 /* yes this is racy, but if you don't like the race, lock the buffer */
2805 for_each_buffer_cpu(buffer, cpu) {
2806 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04002807 local_irq_save(flags);
2808 if (dolock)
2809 spin_lock(&cpu_buffer->reader_lock);
Steven Rostedtd4788202009-06-17 00:39:43 -04002810 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04002811 if (dolock)
2812 spin_unlock(&cpu_buffer->reader_lock);
2813 local_irq_restore(flags);
2814
Steven Rostedtd4788202009-06-17 00:39:43 -04002815 if (!ret)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002816 return 0;
2817 }
Steven Rostedt554f7862009-03-11 22:00:13 -04002818
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002819 return 1;
2820}
Robert Richterc4f50182008-12-11 16:49:22 +01002821EXPORT_SYMBOL_GPL(ring_buffer_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002822
2823/**
2824 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
2825 * @buffer: The ring buffer
2826 * @cpu: The CPU buffer to test
2827 */
2828int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
2829{
2830 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedtd4788202009-06-17 00:39:43 -04002831 unsigned long flags;
Steven Rostedt8d707e82009-06-16 21:22:48 -04002832 int dolock;
Steven Rostedt8aabee52009-03-12 13:13:49 -04002833 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002834
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302835 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002836 return 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002837
Steven Rostedt8d707e82009-06-16 21:22:48 -04002838 dolock = rb_ok_to_lock();
Steven Rostedt554f7862009-03-11 22:00:13 -04002839
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002840 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8d707e82009-06-16 21:22:48 -04002841 local_irq_save(flags);
2842 if (dolock)
2843 spin_lock(&cpu_buffer->reader_lock);
Steven Rostedt554f7862009-03-11 22:00:13 -04002844 ret = rb_per_cpu_empty(cpu_buffer);
Steven Rostedt8d707e82009-06-16 21:22:48 -04002845 if (dolock)
2846 spin_unlock(&cpu_buffer->reader_lock);
2847 local_irq_restore(flags);
Steven Rostedt554f7862009-03-11 22:00:13 -04002848
2849 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002850}
Robert Richterc4f50182008-12-11 16:49:22 +01002851EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002852
2853/**
2854 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
2855 * @buffer_a: One buffer to swap with
2856 * @buffer_b: The other buffer to swap with
2857 *
2858 * This function is useful for tracers that want to take a "snapshot"
2859 * of a CPU buffer and has another back up buffer lying around.
2860 * it is expected that the tracer handles the cpu buffer not being
2861 * used at the moment.
2862 */
2863int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
2864 struct ring_buffer *buffer_b, int cpu)
2865{
2866 struct ring_buffer_per_cpu *cpu_buffer_a;
2867 struct ring_buffer_per_cpu *cpu_buffer_b;
Steven Rostedt554f7862009-03-11 22:00:13 -04002868 int ret = -EINVAL;
2869
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302870 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
2871 !cpumask_test_cpu(cpu, buffer_b->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04002872 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002873
2874 /* At least make sure the two buffers are somewhat the same */
Lai Jiangshan6d102bc2008-12-17 17:48:23 +08002875 if (buffer_a->pages != buffer_b->pages)
Steven Rostedt554f7862009-03-11 22:00:13 -04002876 goto out;
2877
2878 ret = -EAGAIN;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002879
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002880 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedt554f7862009-03-11 22:00:13 -04002881 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002882
2883 if (atomic_read(&buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002884 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002885
2886 if (atomic_read(&buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002887 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002888
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002889 cpu_buffer_a = buffer_a->buffers[cpu];
2890 cpu_buffer_b = buffer_b->buffers[cpu];
2891
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002892 if (atomic_read(&cpu_buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002893 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002894
2895 if (atomic_read(&cpu_buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002896 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002897
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002898 /*
2899 * We can't do a synchronize_sched here because this
2900 * function can be called in atomic context.
2901 * Normally this will be called from the same CPU as cpu.
2902 * If not it's up to the caller to protect this.
2903 */
2904 atomic_inc(&cpu_buffer_a->record_disabled);
2905 atomic_inc(&cpu_buffer_b->record_disabled);
2906
2907 buffer_a->buffers[cpu] = cpu_buffer_b;
2908 buffer_b->buffers[cpu] = cpu_buffer_a;
2909
2910 cpu_buffer_b->buffer = buffer_a;
2911 cpu_buffer_a->buffer = buffer_b;
2912
2913 atomic_dec(&cpu_buffer_a->record_disabled);
2914 atomic_dec(&cpu_buffer_b->record_disabled);
2915
Steven Rostedt554f7862009-03-11 22:00:13 -04002916 ret = 0;
2917out:
Steven Rostedt554f7862009-03-11 22:00:13 -04002918 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002919}
Robert Richterc4f50182008-12-11 16:49:22 +01002920EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002921
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002922/**
2923 * ring_buffer_alloc_read_page - allocate a page to read from buffer
2924 * @buffer: the buffer to allocate for.
2925 *
2926 * This function is used in conjunction with ring_buffer_read_page.
2927 * When reading a full page from the ring buffer, these functions
2928 * can be used to speed up the process. The calling function should
2929 * allocate a few pages first with this function. Then when it
2930 * needs to get pages from the ring buffer, it passes the result
2931 * of this function into ring_buffer_read_page, which will swap
2932 * the page that was allocated, with the read page of the buffer.
2933 *
2934 * Returns:
2935 * The page allocated, or NULL on error.
2936 */
2937void *ring_buffer_alloc_read_page(struct ring_buffer *buffer)
2938{
Steven Rostedt044fa782008-12-02 23:50:03 -05002939 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002940 unsigned long addr;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002941
2942 addr = __get_free_page(GFP_KERNEL);
2943 if (!addr)
2944 return NULL;
2945
Steven Rostedt044fa782008-12-02 23:50:03 -05002946 bpage = (void *)addr;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002947
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002948 rb_init_page(bpage);
2949
Steven Rostedt044fa782008-12-02 23:50:03 -05002950 return bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002951}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04002952EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002953
2954/**
2955 * ring_buffer_free_read_page - free an allocated read page
2956 * @buffer: the buffer the page was allocate for
2957 * @data: the page to free
2958 *
2959 * Free a page allocated from ring_buffer_alloc_read_page.
2960 */
2961void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
2962{
2963 free_page((unsigned long)data);
2964}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04002965EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002966
2967/**
2968 * ring_buffer_read_page - extract a page from the ring buffer
2969 * @buffer: buffer to extract from
2970 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002971 * @len: amount to extract
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002972 * @cpu: the cpu of the buffer to extract
2973 * @full: should the extraction only happen when the page is full.
2974 *
2975 * This function will pull out a page from the ring buffer and consume it.
2976 * @data_page must be the address of the variable that was returned
2977 * from ring_buffer_alloc_read_page. This is because the page might be used
2978 * to swap with a page in the ring buffer.
2979 *
2980 * for example:
Lai Jiangshanb85fa012009-02-09 14:21:14 +08002981 * rpage = ring_buffer_alloc_read_page(buffer);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002982 * if (!rpage)
2983 * return error;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002984 * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
Lai Jiangshan667d2412009-02-09 14:21:17 +08002985 * if (ret >= 0)
2986 * process_page(rpage, ret);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002987 *
2988 * When @full is set, the function will not return true unless
2989 * the writer is off the reader page.
2990 *
2991 * Note: it is up to the calling functions to handle sleeps and wakeups.
2992 * The ring buffer can be used anywhere in the kernel and can not
2993 * blindly call wake_up. The layer that uses the ring buffer must be
2994 * responsible for that.
2995 *
2996 * Returns:
Lai Jiangshan667d2412009-02-09 14:21:17 +08002997 * >=0 if data has been transferred, returns the offset of consumed data.
2998 * <0 if no data has been transferred.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002999 */
3000int ring_buffer_read_page(struct ring_buffer *buffer,
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003001 void **data_page, size_t len, int cpu, int full)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003002{
3003 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
3004 struct ring_buffer_event *event;
Steven Rostedt044fa782008-12-02 23:50:03 -05003005 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003006 struct buffer_page *reader;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003007 unsigned long flags;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003008 unsigned int commit;
Lai Jiangshan667d2412009-02-09 14:21:17 +08003009 unsigned int read;
Steven Rostedt4f3640f2009-03-03 23:52:42 -05003010 u64 save_timestamp;
Lai Jiangshan667d2412009-02-09 14:21:17 +08003011 int ret = -1;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003012
Steven Rostedt554f7862009-03-11 22:00:13 -04003013 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3014 goto out;
3015
Steven Rostedt474d32b2009-03-03 19:51:40 -05003016 /*
3017 * If len is not big enough to hold the page header, then
3018 * we can not copy anything.
3019 */
3020 if (len <= BUF_PAGE_HDR_SIZE)
Steven Rostedt554f7862009-03-11 22:00:13 -04003021 goto out;
Steven Rostedt474d32b2009-03-03 19:51:40 -05003022
3023 len -= BUF_PAGE_HDR_SIZE;
3024
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003025 if (!data_page)
Steven Rostedt554f7862009-03-11 22:00:13 -04003026 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003027
Steven Rostedt044fa782008-12-02 23:50:03 -05003028 bpage = *data_page;
3029 if (!bpage)
Steven Rostedt554f7862009-03-11 22:00:13 -04003030 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003031
3032 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3033
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003034 reader = rb_get_reader_page(cpu_buffer);
3035 if (!reader)
Steven Rostedt554f7862009-03-11 22:00:13 -04003036 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003037
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003038 event = rb_reader_event(cpu_buffer);
Lai Jiangshan667d2412009-02-09 14:21:17 +08003039
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003040 read = reader->read;
3041 commit = rb_page_commit(reader);
3042
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003043 /*
Steven Rostedt474d32b2009-03-03 19:51:40 -05003044 * If this page has been partially read or
3045 * if len is not big enough to read the rest of the page or
3046 * a writer is still on the page, then
3047 * we must copy the data from the page to the buffer.
3048 * Otherwise, we can simply swap the page with the one passed in.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003049 */
Steven Rostedt474d32b2009-03-03 19:51:40 -05003050 if (read || (len < (commit - read)) ||
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003051 cpu_buffer->reader_page == cpu_buffer->commit_page) {
Lai Jiangshan667d2412009-02-09 14:21:17 +08003052 struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
Steven Rostedt474d32b2009-03-03 19:51:40 -05003053 unsigned int rpos = read;
3054 unsigned int pos = 0;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003055 unsigned int size;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003056
3057 if (full)
Steven Rostedt554f7862009-03-11 22:00:13 -04003058 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003059
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003060 if (len > (commit - read))
3061 len = (commit - read);
3062
3063 size = rb_event_length(event);
3064
3065 if (len < size)
Steven Rostedt554f7862009-03-11 22:00:13 -04003066 goto out_unlock;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003067
Steven Rostedt4f3640f2009-03-03 23:52:42 -05003068 /* save the current timestamp, since the user will need it */
3069 save_timestamp = cpu_buffer->read_stamp;
3070
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003071 /* Need to copy one event at a time */
3072 do {
Steven Rostedt474d32b2009-03-03 19:51:40 -05003073 memcpy(bpage->data + pos, rpage->data + rpos, size);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003074
3075 len -= size;
3076
3077 rb_advance_reader(cpu_buffer);
Steven Rostedt474d32b2009-03-03 19:51:40 -05003078 rpos = reader->read;
3079 pos += size;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003080
3081 event = rb_reader_event(cpu_buffer);
3082 size = rb_event_length(event);
3083 } while (len > size);
Lai Jiangshan667d2412009-02-09 14:21:17 +08003084
3085 /* update bpage */
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003086 local_set(&bpage->commit, pos);
Steven Rostedt4f3640f2009-03-03 23:52:42 -05003087 bpage->time_stamp = save_timestamp;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003088
Steven Rostedt474d32b2009-03-03 19:51:40 -05003089 /* we copied everything to the beginning */
3090 read = 0;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003091 } else {
Steven Rostedtafbab762009-05-01 19:40:05 -04003092 /* update the entry counter */
3093 cpu_buffer->read += local_read(&reader->entries);
3094
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003095 /* swap the pages */
Steven Rostedt044fa782008-12-02 23:50:03 -05003096 rb_init_page(bpage);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003097 bpage = reader->page;
3098 reader->page = *data_page;
3099 local_set(&reader->write, 0);
Steven Rostedt778c55d2009-05-01 18:44:45 -04003100 local_set(&reader->entries, 0);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05003101 reader->read = 0;
Steven Rostedt044fa782008-12-02 23:50:03 -05003102 *data_page = bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003103 }
Lai Jiangshan667d2412009-02-09 14:21:17 +08003104 ret = read;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003105
Steven Rostedt554f7862009-03-11 22:00:13 -04003106 out_unlock:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003107 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
3108
Steven Rostedt554f7862009-03-11 22:00:13 -04003109 out:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003110 return ret;
3111}
Steven Rostedtd6ce96d2009-05-05 01:15:24 -04003112EXPORT_SYMBOL_GPL(ring_buffer_read_page);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05003113
Paul Mundt1155de42009-06-25 14:30:12 +09003114#ifdef CONFIG_TRACING
Steven Rostedta3583242008-11-11 15:01:42 -05003115static ssize_t
3116rb_simple_read(struct file *filp, char __user *ubuf,
3117 size_t cnt, loff_t *ppos)
3118{
Hannes Eder5e398412009-02-10 19:44:34 +01003119 unsigned long *p = filp->private_data;
Steven Rostedta3583242008-11-11 15:01:42 -05003120 char buf[64];
3121 int r;
3122
Steven Rostedt033601a2008-11-21 12:41:55 -05003123 if (test_bit(RB_BUFFERS_DISABLED_BIT, p))
3124 r = sprintf(buf, "permanently disabled\n");
3125 else
3126 r = sprintf(buf, "%d\n", test_bit(RB_BUFFERS_ON_BIT, p));
Steven Rostedta3583242008-11-11 15:01:42 -05003127
3128 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
3129}
3130
3131static ssize_t
3132rb_simple_write(struct file *filp, const char __user *ubuf,
3133 size_t cnt, loff_t *ppos)
3134{
Hannes Eder5e398412009-02-10 19:44:34 +01003135 unsigned long *p = filp->private_data;
Steven Rostedta3583242008-11-11 15:01:42 -05003136 char buf[64];
Hannes Eder5e398412009-02-10 19:44:34 +01003137 unsigned long val;
Steven Rostedta3583242008-11-11 15:01:42 -05003138 int ret;
3139
3140 if (cnt >= sizeof(buf))
3141 return -EINVAL;
3142
3143 if (copy_from_user(&buf, ubuf, cnt))
3144 return -EFAULT;
3145
3146 buf[cnt] = 0;
3147
3148 ret = strict_strtoul(buf, 10, &val);
3149 if (ret < 0)
3150 return ret;
3151
Steven Rostedt033601a2008-11-21 12:41:55 -05003152 if (val)
3153 set_bit(RB_BUFFERS_ON_BIT, p);
3154 else
3155 clear_bit(RB_BUFFERS_ON_BIT, p);
Steven Rostedta3583242008-11-11 15:01:42 -05003156
3157 (*ppos)++;
3158
3159 return cnt;
3160}
3161
Steven Rostedt5e2336a2009-03-05 21:44:55 -05003162static const struct file_operations rb_simple_fops = {
Steven Rostedta3583242008-11-11 15:01:42 -05003163 .open = tracing_open_generic,
3164 .read = rb_simple_read,
3165 .write = rb_simple_write,
3166};
3167
3168
3169static __init int rb_init_debugfs(void)
3170{
3171 struct dentry *d_tracer;
Steven Rostedta3583242008-11-11 15:01:42 -05003172
3173 d_tracer = tracing_init_dentry();
3174
Frederic Weisbecker5452af62009-03-27 00:25:38 +01003175 trace_create_file("tracing_on", 0644, d_tracer,
3176 &ring_buffer_flags, &rb_simple_fops);
Steven Rostedta3583242008-11-11 15:01:42 -05003177
3178 return 0;
3179}
3180
3181fs_initcall(rb_init_debugfs);
Paul Mundt1155de42009-06-25 14:30:12 +09003182#endif
Steven Rostedt554f7862009-03-11 22:00:13 -04003183
Steven Rostedt59222ef2009-03-12 11:46:03 -04003184#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01003185static int rb_cpu_notify(struct notifier_block *self,
3186 unsigned long action, void *hcpu)
Steven Rostedt554f7862009-03-11 22:00:13 -04003187{
3188 struct ring_buffer *buffer =
3189 container_of(self, struct ring_buffer, cpu_notify);
3190 long cpu = (long)hcpu;
3191
3192 switch (action) {
3193 case CPU_UP_PREPARE:
3194 case CPU_UP_PREPARE_FROZEN:
Rusty Russell3f237a72009-06-12 21:15:30 +09303195 if (cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04003196 return NOTIFY_OK;
3197
3198 buffer->buffers[cpu] =
3199 rb_allocate_cpu_buffer(buffer, cpu);
3200 if (!buffer->buffers[cpu]) {
3201 WARN(1, "failed to allocate ring buffer on CPU %ld\n",
3202 cpu);
3203 return NOTIFY_OK;
3204 }
3205 smp_wmb();
Rusty Russell3f237a72009-06-12 21:15:30 +09303206 cpumask_set_cpu(cpu, buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -04003207 break;
3208 case CPU_DOWN_PREPARE:
3209 case CPU_DOWN_PREPARE_FROZEN:
3210 /*
3211 * Do nothing.
3212 * If we were to free the buffer, then the user would
3213 * lose any trace that was in the buffer.
3214 */
3215 break;
3216 default:
3217 break;
3218 }
3219 return NOTIFY_OK;
3220}
3221#endif