blob: e145969a8edab596fd8d2b7d4411718d5692caf2 [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>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040013#include <linux/module.h>
14#include <linux/percpu.h>
15#include <linux/mutex.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040016#include <linux/init.h>
17#include <linux/hash.h>
18#include <linux/list.h>
Steven Rostedt554f7862009-03-11 22:00:13 -040019#include <linux/cpu.h>
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040020#include <linux/fs.h>
21
Steven Rostedt182e9f52008-11-03 23:15:56 -050022#include "trace.h"
23
Steven Rostedt033601a2008-11-21 12:41:55 -050024/*
Steven Rostedtd1b182a2009-04-15 16:53:47 -040025 * The ring buffer header is special. We must manually up keep it.
26 */
27int ring_buffer_print_entry_header(struct trace_seq *s)
28{
29 int ret;
30
31 ret = trace_seq_printf(s, "\ttype : 2 bits\n");
32 ret = trace_seq_printf(s, "\tlen : 3 bits\n");
33 ret = trace_seq_printf(s, "\ttime_delta : 27 bits\n");
34 ret = trace_seq_printf(s, "\tarray : 32 bits\n");
35 ret = trace_seq_printf(s, "\n");
36 ret = trace_seq_printf(s, "\tpadding : type == %d\n",
37 RINGBUF_TYPE_PADDING);
38 ret = trace_seq_printf(s, "\ttime_extend : type == %d\n",
39 RINGBUF_TYPE_TIME_EXTEND);
40 ret = trace_seq_printf(s, "\tdata : type == %d\n",
41 RINGBUF_TYPE_DATA);
42
43 return ret;
44}
45
46/*
Steven Rostedt5cc98542009-03-12 22:24:17 -040047 * The ring buffer is made up of a list of pages. A separate list of pages is
48 * allocated for each CPU. A writer may only write to a buffer that is
49 * associated with the CPU it is currently executing on. A reader may read
50 * from any per cpu buffer.
51 *
52 * The reader is special. For each per cpu buffer, the reader has its own
53 * reader page. When a reader has read the entire reader page, this reader
54 * page is swapped with another page in the ring buffer.
55 *
56 * Now, as long as the writer is off the reader page, the reader can do what
57 * ever it wants with that page. The writer will never write to that page
58 * again (as long as it is out of the ring buffer).
59 *
60 * Here's some silly ASCII art.
61 *
62 * +------+
63 * |reader| RING BUFFER
64 * |page |
65 * +------+ +---+ +---+ +---+
66 * | |-->| |-->| |
67 * +---+ +---+ +---+
68 * ^ |
69 * | |
70 * +---------------+
71 *
72 *
73 * +------+
74 * |reader| RING BUFFER
75 * |page |------------------v
76 * +------+ +---+ +---+ +---+
77 * | |-->| |-->| |
78 * +---+ +---+ +---+
79 * ^ |
80 * | |
81 * +---------------+
82 *
83 *
84 * +------+
85 * |reader| RING BUFFER
86 * |page |------------------v
87 * +------+ +---+ +---+ +---+
88 * ^ | |-->| |-->| |
89 * | +---+ +---+ +---+
90 * | |
91 * | |
92 * +------------------------------+
93 *
94 *
95 * +------+
96 * |buffer| RING BUFFER
97 * |page |------------------v
98 * +------+ +---+ +---+ +---+
99 * ^ | | | |-->| |
100 * | New +---+ +---+ +---+
101 * | Reader------^ |
102 * | page |
103 * +------------------------------+
104 *
105 *
106 * After we make this swap, the reader can hand this page off to the splice
107 * code and be done with it. It can even allocate a new page if it needs to
108 * and swap that into the ring buffer.
109 *
110 * We will be using cmpxchg soon to make all this lockless.
111 *
112 */
113
114/*
Steven Rostedt033601a2008-11-21 12:41:55 -0500115 * A fast way to enable or disable all ring buffers is to
116 * call tracing_on or tracing_off. Turning off the ring buffers
117 * prevents all ring buffers from being recorded to.
118 * Turning this switch on, makes it OK to write to the
119 * ring buffer, if the ring buffer is enabled itself.
120 *
121 * There's three layers that must be on in order to write
122 * to the ring buffer.
123 *
124 * 1) This global flag must be set.
125 * 2) The ring buffer must be enabled for recording.
126 * 3) The per cpu buffer must be enabled for recording.
127 *
128 * In case of an anomaly, this global flag has a bit set that
129 * will permantly disable all ring buffers.
130 */
131
132/*
133 * Global flag to disable all recording to ring buffers
134 * This has two bits: ON, DISABLED
135 *
136 * ON DISABLED
137 * ---- ----------
138 * 0 0 : ring buffers are off
139 * 1 0 : ring buffers are on
140 * X 1 : ring buffers are permanently disabled
141 */
142
143enum {
144 RB_BUFFERS_ON_BIT = 0,
145 RB_BUFFERS_DISABLED_BIT = 1,
146};
147
148enum {
149 RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
150 RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
151};
152
Hannes Eder5e398412009-02-10 19:44:34 +0100153static unsigned long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
Steven Rostedta3583242008-11-11 15:01:42 -0500154
Steven Rostedt474d32b2009-03-03 19:51:40 -0500155#define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
156
Steven Rostedta3583242008-11-11 15:01:42 -0500157/**
158 * tracing_on - enable all tracing buffers
159 *
160 * This function enables all tracing buffers that may have been
161 * disabled with tracing_off.
162 */
163void tracing_on(void)
164{
Steven Rostedt033601a2008-11-21 12:41:55 -0500165 set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -0500166}
Robert Richterc4f50182008-12-11 16:49:22 +0100167EXPORT_SYMBOL_GPL(tracing_on);
Steven Rostedta3583242008-11-11 15:01:42 -0500168
169/**
170 * tracing_off - turn off all tracing buffers
171 *
172 * This function stops all tracing buffers from recording data.
173 * It does not disable any overhead the tracers themselves may
174 * be causing. This function simply causes all recording to
175 * the ring buffers to fail.
176 */
177void tracing_off(void)
178{
Steven Rostedt033601a2008-11-21 12:41:55 -0500179 clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
180}
Robert Richterc4f50182008-12-11 16:49:22 +0100181EXPORT_SYMBOL_GPL(tracing_off);
Steven Rostedt033601a2008-11-21 12:41:55 -0500182
183/**
184 * tracing_off_permanent - permanently disable ring buffers
185 *
186 * This function, once called, will disable all ring buffers
Wenji Huangc3706f02009-02-10 01:03:18 -0500187 * permanently.
Steven Rostedt033601a2008-11-21 12:41:55 -0500188 */
189void tracing_off_permanent(void)
190{
191 set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -0500192}
193
Steven Rostedt988ae9d2009-02-14 19:17:02 -0500194/**
195 * tracing_is_on - show state of ring buffers enabled
196 */
197int tracing_is_on(void)
198{
199 return ring_buffer_flags == RB_BUFFERS_ON;
200}
201EXPORT_SYMBOL_GPL(tracing_is_on);
202
Ingo Molnard06bbd62008-11-12 10:11:37 +0100203#include "trace.h"
204
Steven Rostedte3d6bf02009-03-03 13:53:07 -0500205#define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
Andrew Morton67d34722009-01-09 12:27:09 -0800206#define RB_ALIGNMENT 4U
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400207#define RB_MAX_SMALL_DATA 28
208
209enum {
210 RB_LEN_TIME_EXTEND = 8,
211 RB_LEN_TIME_STAMP = 16,
212};
213
Tom Zanussi2d622712009-03-22 03:30:49 -0500214static inline int rb_null_event(struct ring_buffer_event *event)
215{
216 return event->type == RINGBUF_TYPE_PADDING && event->time_delta == 0;
217}
218
219static inline int rb_discarded_event(struct ring_buffer_event *event)
220{
221 return event->type == RINGBUF_TYPE_PADDING && event->time_delta;
222}
223
224static void rb_event_set_padding(struct ring_buffer_event *event)
225{
226 event->type = RINGBUF_TYPE_PADDING;
227 event->time_delta = 0;
228}
229
Tom Zanussi2d622712009-03-22 03:30:49 -0500230static unsigned
231rb_event_data_length(struct ring_buffer_event *event)
232{
233 unsigned length;
234
235 if (event->len)
236 length = event->len * RB_ALIGNMENT;
237 else
238 length = event->array[0];
239 return length + RB_EVNT_HDR_SIZE;
240}
241
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400242/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800243static unsigned
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400244rb_event_length(struct ring_buffer_event *event)
245{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400246 switch (event->type) {
247 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -0500248 if (rb_null_event(event))
249 /* undefined */
250 return -1;
251 return rb_event_data_length(event);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400252
253 case RINGBUF_TYPE_TIME_EXTEND:
254 return RB_LEN_TIME_EXTEND;
255
256 case RINGBUF_TYPE_TIME_STAMP:
257 return RB_LEN_TIME_STAMP;
258
259 case RINGBUF_TYPE_DATA:
Tom Zanussi2d622712009-03-22 03:30:49 -0500260 return rb_event_data_length(event);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400261 default:
262 BUG();
263 }
264 /* not hit */
265 return 0;
266}
267
268/**
269 * ring_buffer_event_length - return the length of the event
270 * @event: the event to get the length of
271 */
272unsigned ring_buffer_event_length(struct ring_buffer_event *event)
273{
Robert Richter465634a2009-01-07 15:32:11 +0100274 unsigned length = rb_event_length(event);
275 if (event->type != RINGBUF_TYPE_DATA)
276 return length;
277 length -= RB_EVNT_HDR_SIZE;
278 if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
279 length -= sizeof(event->array[0]);
280 return length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400281}
Robert Richterc4f50182008-12-11 16:49:22 +0100282EXPORT_SYMBOL_GPL(ring_buffer_event_length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400283
284/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800285static void *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400286rb_event_data(struct ring_buffer_event *event)
287{
288 BUG_ON(event->type != RINGBUF_TYPE_DATA);
289 /* If length is in len field, then array[0] has the data */
290 if (event->len)
291 return (void *)&event->array[0];
292 /* Otherwise length is in array[0] and array[1] has the data */
293 return (void *)&event->array[1];
294}
295
296/**
297 * ring_buffer_event_data - return the data of the event
298 * @event: the event to get the data from
299 */
300void *ring_buffer_event_data(struct ring_buffer_event *event)
301{
302 return rb_event_data(event);
303}
Robert Richterc4f50182008-12-11 16:49:22 +0100304EXPORT_SYMBOL_GPL(ring_buffer_event_data);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400305
306#define for_each_buffer_cpu(buffer, cpu) \
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030307 for_each_cpu(cpu, buffer->cpumask)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400308
309#define TS_SHIFT 27
310#define TS_MASK ((1ULL << TS_SHIFT) - 1)
311#define TS_DELTA_TEST (~TS_MASK)
312
Steven Rostedtabc9b562008-12-02 15:34:06 -0500313struct buffer_data_page {
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400314 u64 time_stamp; /* page time stamp */
Wenji Huangc3706f02009-02-10 01:03:18 -0500315 local_t commit; /* write committed index */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500316 unsigned char data[]; /* data of buffer page */
317};
318
319struct buffer_page {
320 local_t write; /* index for next write */
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400321 unsigned read; /* index for next read */
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400322 struct list_head list; /* list of free pages */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500323 struct buffer_data_page *page; /* Actual data page */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400324};
325
Steven Rostedt044fa782008-12-02 23:50:03 -0500326static void rb_init_page(struct buffer_data_page *bpage)
Steven Rostedtabc9b562008-12-02 15:34:06 -0500327{
Steven Rostedt044fa782008-12-02 23:50:03 -0500328 local_set(&bpage->commit, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500329}
330
Steven Rostedt474d32b2009-03-03 19:51:40 -0500331/**
332 * ring_buffer_page_len - the size of data on the page.
333 * @page: The page to read
334 *
335 * Returns the amount of data on the page, including buffer page header.
336 */
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500337size_t ring_buffer_page_len(void *page)
338{
Steven Rostedt474d32b2009-03-03 19:51:40 -0500339 return local_read(&((struct buffer_data_page *)page)->commit)
340 + BUF_PAGE_HDR_SIZE;
Steven Rostedtef7a4a12009-03-03 00:27:49 -0500341}
342
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400343/*
Steven Rostedted568292008-09-29 23:02:40 -0400344 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
345 * this issue out.
346 */
Andrew Morton34a148b2009-01-09 12:27:09 -0800347static void free_buffer_page(struct buffer_page *bpage)
Steven Rostedted568292008-09-29 23:02:40 -0400348{
Andrew Morton34a148b2009-01-09 12:27:09 -0800349 free_page((unsigned long)bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400350 kfree(bpage);
Steven Rostedted568292008-09-29 23:02:40 -0400351}
352
353/*
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400354 * We need to fit the time_stamp delta into 27 bits.
355 */
356static inline int test_time_stamp(u64 delta)
357{
358 if (delta & TS_DELTA_TEST)
359 return 1;
360 return 0;
361}
362
Steven Rostedt474d32b2009-03-03 19:51:40 -0500363#define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400364
Steven Rostedtd1b182a2009-04-15 16:53:47 -0400365int ring_buffer_print_page_header(struct trace_seq *s)
366{
367 struct buffer_data_page field;
368 int ret;
369
370 ret = trace_seq_printf(s, "\tfield: u64 timestamp;\t"
371 "offset:0;\tsize:%u;\n",
372 (unsigned int)sizeof(field.time_stamp));
373
374 ret = trace_seq_printf(s, "\tfield: local_t commit;\t"
375 "offset:%u;\tsize:%u;\n",
376 (unsigned int)offsetof(typeof(field), commit),
377 (unsigned int)sizeof(field.commit));
378
379 ret = trace_seq_printf(s, "\tfield: char data;\t"
380 "offset:%u;\tsize:%u;\n",
381 (unsigned int)offsetof(typeof(field), data),
382 (unsigned int)BUF_PAGE_SIZE);
383
384 return ret;
385}
386
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400387/*
388 * head_page == tail_page && head == tail then buffer is empty.
389 */
390struct ring_buffer_per_cpu {
391 int cpu;
392 struct ring_buffer *buffer;
Steven Rostedtf83c9d02008-11-11 18:47:44 +0100393 spinlock_t reader_lock; /* serialize readers */
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500394 raw_spinlock_t lock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400395 struct lock_class_key lock_key;
396 struct list_head pages;
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400397 struct buffer_page *head_page; /* read from head */
398 struct buffer_page *tail_page; /* write to tail */
Wenji Huangc3706f02009-02-10 01:03:18 -0500399 struct buffer_page *commit_page; /* committed pages */
Steven Rostedtd7690412008-10-01 00:29:53 -0400400 struct buffer_page *reader_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400401 unsigned long overrun;
402 unsigned long entries;
403 u64 write_stamp;
404 u64 read_stamp;
405 atomic_t record_disabled;
406};
407
408struct ring_buffer {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400409 unsigned pages;
410 unsigned flags;
411 int cpus;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400412 atomic_t record_disabled;
Arnaldo Carvalho de Melo00f62f62009-02-09 17:04:06 -0200413 cpumask_var_t cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400414
415 struct mutex mutex;
416
417 struct ring_buffer_per_cpu **buffers;
Steven Rostedt554f7862009-03-11 22:00:13 -0400418
Steven Rostedt59222ef2009-03-12 11:46:03 -0400419#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400420 struct notifier_block cpu_notify;
421#endif
Steven Rostedt37886f62009-03-17 17:22:06 -0400422 u64 (*clock)(void);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400423};
424
425struct ring_buffer_iter {
426 struct ring_buffer_per_cpu *cpu_buffer;
427 unsigned long head;
428 struct buffer_page *head_page;
429 u64 read_stamp;
430};
431
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500432/* buffer may be either ring_buffer or ring_buffer_per_cpu */
Steven Rostedtbf41a152008-10-04 02:00:59 -0400433#define RB_WARN_ON(buffer, cond) \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500434 ({ \
435 int _____ret = unlikely(cond); \
436 if (_____ret) { \
Steven Rostedtbf41a152008-10-04 02:00:59 -0400437 atomic_inc(&buffer->record_disabled); \
438 WARN_ON(1); \
439 } \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500440 _____ret; \
441 })
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500442
Steven Rostedt37886f62009-03-17 17:22:06 -0400443/* Up this if you want to test the TIME_EXTENTS and normalization */
444#define DEBUG_SHIFT 0
445
446u64 ring_buffer_time_stamp(struct ring_buffer *buffer, int cpu)
447{
448 u64 time;
449
450 preempt_disable_notrace();
451 /* shift to debug/test normalization and TIME_EXTENTS */
452 time = buffer->clock() << DEBUG_SHIFT;
453 preempt_enable_no_resched_notrace();
454
455 return time;
456}
457EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
458
459void ring_buffer_normalize_time_stamp(struct ring_buffer *buffer,
460 int cpu, u64 *ts)
461{
462 /* Just stupid testing the normalize function and deltas */
463 *ts >>= DEBUG_SHIFT;
464}
465EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
466
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400467/**
468 * check_pages - integrity check of buffer pages
469 * @cpu_buffer: CPU buffer with pages to test
470 *
Wenji Huangc3706f02009-02-10 01:03:18 -0500471 * As a safety measure we check to make sure the data pages have not
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400472 * been corrupted.
473 */
474static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
475{
476 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500477 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400478
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500479 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
480 return -1;
481 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
482 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400483
Steven Rostedt044fa782008-12-02 23:50:03 -0500484 list_for_each_entry_safe(bpage, tmp, head, list) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500485 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500486 bpage->list.next->prev != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500487 return -1;
488 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500489 bpage->list.prev->next != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500490 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400491 }
492
493 return 0;
494}
495
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400496static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
497 unsigned nr_pages)
498{
499 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500500 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400501 unsigned long addr;
502 LIST_HEAD(pages);
503 unsigned i;
504
505 for (i = 0; i < nr_pages; i++) {
Steven Rostedt044fa782008-12-02 23:50:03 -0500506 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedtaa1e0e3b2008-10-02 19:18:09 -0400507 GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500508 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400509 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500510 list_add(&bpage->list, &pages);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400511
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400512 addr = __get_free_page(GFP_KERNEL);
513 if (!addr)
514 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500515 bpage->page = (void *)addr;
516 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400517 }
518
519 list_splice(&pages, head);
520
521 rb_check_pages(cpu_buffer);
522
523 return 0;
524
525 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -0500526 list_for_each_entry_safe(bpage, tmp, &pages, list) {
527 list_del_init(&bpage->list);
528 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400529 }
530 return -ENOMEM;
531}
532
533static struct ring_buffer_per_cpu *
534rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
535{
536 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt044fa782008-12-02 23:50:03 -0500537 struct buffer_page *bpage;
Steven Rostedtd7690412008-10-01 00:29:53 -0400538 unsigned long addr;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400539 int ret;
540
541 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
542 GFP_KERNEL, cpu_to_node(cpu));
543 if (!cpu_buffer)
544 return NULL;
545
546 cpu_buffer->cpu = cpu;
547 cpu_buffer->buffer = buffer;
Steven Rostedtf83c9d02008-11-11 18:47:44 +0100548 spin_lock_init(&cpu_buffer->reader_lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500549 cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400550 INIT_LIST_HEAD(&cpu_buffer->pages);
551
Steven Rostedt044fa782008-12-02 23:50:03 -0500552 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400553 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500554 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400555 goto fail_free_buffer;
556
Steven Rostedt044fa782008-12-02 23:50:03 -0500557 cpu_buffer->reader_page = bpage;
Steven Rostedtd7690412008-10-01 00:29:53 -0400558 addr = __get_free_page(GFP_KERNEL);
559 if (!addr)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400560 goto fail_free_reader;
Steven Rostedt044fa782008-12-02 23:50:03 -0500561 bpage->page = (void *)addr;
562 rb_init_page(bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400563
Steven Rostedtd7690412008-10-01 00:29:53 -0400564 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -0400565
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400566 ret = rb_allocate_pages(cpu_buffer, buffer->pages);
567 if (ret < 0)
Steven Rostedtd7690412008-10-01 00:29:53 -0400568 goto fail_free_reader;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400569
570 cpu_buffer->head_page
571 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400572 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400573
574 return cpu_buffer;
575
Steven Rostedtd7690412008-10-01 00:29:53 -0400576 fail_free_reader:
577 free_buffer_page(cpu_buffer->reader_page);
578
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400579 fail_free_buffer:
580 kfree(cpu_buffer);
581 return NULL;
582}
583
584static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
585{
586 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500587 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400588
Steven Rostedtd7690412008-10-01 00:29:53 -0400589 free_buffer_page(cpu_buffer->reader_page);
590
Steven Rostedt044fa782008-12-02 23:50:03 -0500591 list_for_each_entry_safe(bpage, tmp, head, list) {
592 list_del_init(&bpage->list);
593 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400594 }
595 kfree(cpu_buffer);
596}
597
Steven Rostedta7b13742008-09-29 23:02:39 -0400598/*
599 * Causes compile errors if the struct buffer_page gets bigger
600 * than the struct page.
601 */
602extern int ring_buffer_page_too_big(void);
603
Steven Rostedt59222ef2009-03-12 11:46:03 -0400604#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +0100605static int rb_cpu_notify(struct notifier_block *self,
606 unsigned long action, void *hcpu);
Steven Rostedt554f7862009-03-11 22:00:13 -0400607#endif
608
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400609/**
610 * ring_buffer_alloc - allocate a new ring_buffer
Robert Richter68814b52008-11-24 12:24:12 +0100611 * @size: the size in bytes per cpu that is needed.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400612 * @flags: attributes to set for the ring buffer.
613 *
614 * Currently the only flag that is available is the RB_FL_OVERWRITE
615 * flag. This flag means that the buffer will overwrite old data
616 * when the buffer wraps. If this flag is not set, the buffer will
617 * drop data when the tail hits the head.
618 */
619struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
620{
621 struct ring_buffer *buffer;
622 int bsize;
623 int cpu;
624
Steven Rostedta7b13742008-09-29 23:02:39 -0400625 /* Paranoid! Optimizes out when all is well */
626 if (sizeof(struct buffer_page) > sizeof(struct page))
627 ring_buffer_page_too_big();
628
629
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400630 /* keep it in its own cache line */
631 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
632 GFP_KERNEL);
633 if (!buffer)
634 return NULL;
635
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030636 if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
637 goto fail_free_buffer;
638
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400639 buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
640 buffer->flags = flags;
Steven Rostedt37886f62009-03-17 17:22:06 -0400641 buffer->clock = trace_clock_local;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400642
643 /* need at least two pages */
644 if (buffer->pages == 1)
645 buffer->pages++;
646
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +0100647 /*
648 * In case of non-hotplug cpu, if the ring-buffer is allocated
649 * in early initcall, it will not be notified of secondary cpus.
650 * In that off case, we need to allocate for all possible cpus.
651 */
652#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400653 get_online_cpus();
654 cpumask_copy(buffer->cpumask, cpu_online_mask);
Frederic Weisbecker3bf832c2009-03-19 14:47:33 +0100655#else
656 cpumask_copy(buffer->cpumask, cpu_possible_mask);
657#endif
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400658 buffer->cpus = nr_cpu_ids;
659
660 bsize = sizeof(void *) * nr_cpu_ids;
661 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
662 GFP_KERNEL);
663 if (!buffer->buffers)
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030664 goto fail_free_cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400665
666 for_each_buffer_cpu(buffer, cpu) {
667 buffer->buffers[cpu] =
668 rb_allocate_cpu_buffer(buffer, cpu);
669 if (!buffer->buffers[cpu])
670 goto fail_free_buffers;
671 }
672
Steven Rostedt59222ef2009-03-12 11:46:03 -0400673#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400674 buffer->cpu_notify.notifier_call = rb_cpu_notify;
675 buffer->cpu_notify.priority = 0;
676 register_cpu_notifier(&buffer->cpu_notify);
677#endif
678
679 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400680 mutex_init(&buffer->mutex);
681
682 return buffer;
683
684 fail_free_buffers:
685 for_each_buffer_cpu(buffer, cpu) {
686 if (buffer->buffers[cpu])
687 rb_free_cpu_buffer(buffer->buffers[cpu]);
688 }
689 kfree(buffer->buffers);
690
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030691 fail_free_cpumask:
692 free_cpumask_var(buffer->cpumask);
Steven Rostedt554f7862009-03-11 22:00:13 -0400693 put_online_cpus();
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030694
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400695 fail_free_buffer:
696 kfree(buffer);
697 return NULL;
698}
Robert Richterc4f50182008-12-11 16:49:22 +0100699EXPORT_SYMBOL_GPL(ring_buffer_alloc);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400700
701/**
702 * ring_buffer_free - free a ring buffer.
703 * @buffer: the buffer to free.
704 */
705void
706ring_buffer_free(struct ring_buffer *buffer)
707{
708 int cpu;
709
Steven Rostedt554f7862009-03-11 22:00:13 -0400710 get_online_cpus();
711
Steven Rostedt59222ef2009-03-12 11:46:03 -0400712#ifdef CONFIG_HOTPLUG_CPU
Steven Rostedt554f7862009-03-11 22:00:13 -0400713 unregister_cpu_notifier(&buffer->cpu_notify);
714#endif
715
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400716 for_each_buffer_cpu(buffer, cpu)
717 rb_free_cpu_buffer(buffer->buffers[cpu]);
718
Steven Rostedt554f7862009-03-11 22:00:13 -0400719 put_online_cpus();
720
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030721 free_cpumask_var(buffer->cpumask);
722
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400723 kfree(buffer);
724}
Robert Richterc4f50182008-12-11 16:49:22 +0100725EXPORT_SYMBOL_GPL(ring_buffer_free);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400726
Steven Rostedt37886f62009-03-17 17:22:06 -0400727void ring_buffer_set_clock(struct ring_buffer *buffer,
728 u64 (*clock)(void))
729{
730 buffer->clock = clock;
731}
732
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400733static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
734
735static void
736rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
737{
Steven Rostedt044fa782008-12-02 23:50:03 -0500738 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400739 struct list_head *p;
740 unsigned i;
741
742 atomic_inc(&cpu_buffer->record_disabled);
743 synchronize_sched();
744
745 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500746 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
747 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400748 p = cpu_buffer->pages.next;
Steven Rostedt044fa782008-12-02 23:50:03 -0500749 bpage = list_entry(p, struct buffer_page, list);
750 list_del_init(&bpage->list);
751 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400752 }
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500753 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
754 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400755
756 rb_reset_cpu(cpu_buffer);
757
758 rb_check_pages(cpu_buffer);
759
760 atomic_dec(&cpu_buffer->record_disabled);
761
762}
763
764static void
765rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
766 struct list_head *pages, unsigned nr_pages)
767{
Steven Rostedt044fa782008-12-02 23:50:03 -0500768 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400769 struct list_head *p;
770 unsigned i;
771
772 atomic_inc(&cpu_buffer->record_disabled);
773 synchronize_sched();
774
775 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500776 if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
777 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400778 p = pages->next;
Steven Rostedt044fa782008-12-02 23:50:03 -0500779 bpage = list_entry(p, struct buffer_page, list);
780 list_del_init(&bpage->list);
781 list_add_tail(&bpage->list, &cpu_buffer->pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400782 }
783 rb_reset_cpu(cpu_buffer);
784
785 rb_check_pages(cpu_buffer);
786
787 atomic_dec(&cpu_buffer->record_disabled);
788}
789
790/**
791 * ring_buffer_resize - resize the ring buffer
792 * @buffer: the buffer to resize.
793 * @size: the new size.
794 *
795 * The tracer is responsible for making sure that the buffer is
796 * not being used while changing the size.
797 * Note: We may be able to change the above requirement by using
798 * RCU synchronizations.
799 *
800 * Minimum size is 2 * BUF_PAGE_SIZE.
801 *
802 * Returns -1 on failure.
803 */
804int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
805{
806 struct ring_buffer_per_cpu *cpu_buffer;
807 unsigned nr_pages, rm_pages, new_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500808 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400809 unsigned long buffer_size;
810 unsigned long addr;
811 LIST_HEAD(pages);
812 int i, cpu;
813
Ingo Molnaree51a1d2008-11-13 14:58:31 +0100814 /*
815 * Always succeed at resizing a non-existent buffer:
816 */
817 if (!buffer)
818 return size;
819
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400820 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
821 size *= BUF_PAGE_SIZE;
822 buffer_size = buffer->pages * BUF_PAGE_SIZE;
823
824 /* we need a minimum of two pages */
825 if (size < BUF_PAGE_SIZE * 2)
826 size = BUF_PAGE_SIZE * 2;
827
828 if (size == buffer_size)
829 return size;
830
831 mutex_lock(&buffer->mutex);
Steven Rostedt554f7862009-03-11 22:00:13 -0400832 get_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400833
834 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
835
836 if (size < buffer_size) {
837
838 /* easy case, just free pages */
Steven Rostedt554f7862009-03-11 22:00:13 -0400839 if (RB_WARN_ON(buffer, nr_pages >= buffer->pages))
840 goto out_fail;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400841
842 rm_pages = buffer->pages - nr_pages;
843
844 for_each_buffer_cpu(buffer, cpu) {
845 cpu_buffer = buffer->buffers[cpu];
846 rb_remove_pages(cpu_buffer, rm_pages);
847 }
848 goto out;
849 }
850
851 /*
852 * This is a bit more difficult. We only want to add pages
853 * when we can allocate enough for all CPUs. We do this
854 * by allocating all the pages and storing them on a local
855 * link list. If we succeed in our allocation, then we
856 * add these pages to the cpu_buffers. Otherwise we just free
857 * them all and return -ENOMEM;
858 */
Steven Rostedt554f7862009-03-11 22:00:13 -0400859 if (RB_WARN_ON(buffer, nr_pages <= buffer->pages))
860 goto out_fail;
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500861
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400862 new_pages = nr_pages - buffer->pages;
863
864 for_each_buffer_cpu(buffer, cpu) {
865 for (i = 0; i < new_pages; i++) {
Steven Rostedt044fa782008-12-02 23:50:03 -0500866 bpage = kzalloc_node(ALIGN(sizeof(*bpage),
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400867 cache_line_size()),
868 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500869 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400870 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500871 list_add(&bpage->list, &pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400872 addr = __get_free_page(GFP_KERNEL);
873 if (!addr)
874 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500875 bpage->page = (void *)addr;
876 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400877 }
878 }
879
880 for_each_buffer_cpu(buffer, cpu) {
881 cpu_buffer = buffer->buffers[cpu];
882 rb_insert_pages(cpu_buffer, &pages, new_pages);
883 }
884
Steven Rostedt554f7862009-03-11 22:00:13 -0400885 if (RB_WARN_ON(buffer, !list_empty(&pages)))
886 goto out_fail;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400887
888 out:
889 buffer->pages = nr_pages;
Steven Rostedt554f7862009-03-11 22:00:13 -0400890 put_online_cpus();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400891 mutex_unlock(&buffer->mutex);
892
893 return size;
894
895 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -0500896 list_for_each_entry_safe(bpage, tmp, &pages, list) {
897 list_del_init(&bpage->list);
898 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400899 }
Steven Rostedt554f7862009-03-11 22:00:13 -0400900 put_online_cpus();
Vegard Nossum641d2f62008-11-18 19:22:13 +0100901 mutex_unlock(&buffer->mutex);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400902 return -ENOMEM;
Steven Rostedt554f7862009-03-11 22:00:13 -0400903
904 /*
905 * Something went totally wrong, and we are too paranoid
906 * to even clean up the mess.
907 */
908 out_fail:
909 put_online_cpus();
910 mutex_unlock(&buffer->mutex);
911 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400912}
Robert Richterc4f50182008-12-11 16:49:22 +0100913EXPORT_SYMBOL_GPL(ring_buffer_resize);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400914
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500915static inline void *
Steven Rostedt044fa782008-12-02 23:50:03 -0500916__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500917{
Steven Rostedt044fa782008-12-02 23:50:03 -0500918 return bpage->data + index;
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500919}
920
Steven Rostedt044fa782008-12-02 23:50:03 -0500921static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400922{
Steven Rostedt044fa782008-12-02 23:50:03 -0500923 return bpage->page->data + index;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400924}
925
926static inline struct ring_buffer_event *
Steven Rostedtd7690412008-10-01 00:29:53 -0400927rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400928{
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400929 return __rb_page_index(cpu_buffer->reader_page,
930 cpu_buffer->reader_page->read);
931}
932
933static inline struct ring_buffer_event *
934rb_head_event(struct ring_buffer_per_cpu *cpu_buffer)
935{
936 return __rb_page_index(cpu_buffer->head_page,
937 cpu_buffer->head_page->read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400938}
939
940static inline struct ring_buffer_event *
941rb_iter_head_event(struct ring_buffer_iter *iter)
942{
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400943 return __rb_page_index(iter->head_page, iter->head);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400944}
945
Steven Rostedtbf41a152008-10-04 02:00:59 -0400946static inline unsigned rb_page_write(struct buffer_page *bpage)
947{
948 return local_read(&bpage->write);
949}
950
951static inline unsigned rb_page_commit(struct buffer_page *bpage)
952{
Steven Rostedtabc9b562008-12-02 15:34:06 -0500953 return local_read(&bpage->page->commit);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400954}
955
956/* Size is determined by what has been commited */
957static inline unsigned rb_page_size(struct buffer_page *bpage)
958{
959 return rb_page_commit(bpage);
960}
961
962static inline unsigned
963rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
964{
965 return rb_page_commit(cpu_buffer->commit_page);
966}
967
968static inline unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
969{
970 return rb_page_commit(cpu_buffer->head_page);
971}
972
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400973/*
974 * When the tail hits the head and the buffer is in overwrite mode,
975 * the head jumps to the next page and all content on the previous
976 * page is discarded. But before doing so, we update the overrun
977 * variable of the buffer.
978 */
979static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
980{
981 struct ring_buffer_event *event;
982 unsigned long head;
983
984 for (head = 0; head < rb_head_size(cpu_buffer);
985 head += rb_event_length(event)) {
986
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400987 event = __rb_page_index(cpu_buffer->head_page, head);
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500988 if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
989 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400990 /* Only count data entries */
991 if (event->type != RINGBUF_TYPE_DATA)
992 continue;
993 cpu_buffer->overrun++;
994 cpu_buffer->entries--;
995 }
996}
997
998static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500999 struct buffer_page **bpage)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001000{
Steven Rostedt044fa782008-12-02 23:50:03 -05001001 struct list_head *p = (*bpage)->list.next;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001002
1003 if (p == &cpu_buffer->pages)
1004 p = p->next;
1005
Steven Rostedt044fa782008-12-02 23:50:03 -05001006 *bpage = list_entry(p, struct buffer_page, list);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001007}
1008
Steven Rostedtbf41a152008-10-04 02:00:59 -04001009static inline unsigned
1010rb_event_index(struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001011{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001012 unsigned long addr = (unsigned long)event;
1013
1014 return (addr & ~PAGE_MASK) - (PAGE_SIZE - BUF_PAGE_SIZE);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001015}
1016
Andrew Morton34a148b2009-01-09 12:27:09 -08001017static int
Steven Rostedtbf41a152008-10-04 02:00:59 -04001018rb_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
1019 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001020{
Steven Rostedtbf41a152008-10-04 02:00:59 -04001021 unsigned long addr = (unsigned long)event;
1022 unsigned long index;
1023
1024 index = rb_event_index(event);
1025 addr &= PAGE_MASK;
1026
1027 return cpu_buffer->commit_page->page == (void *)addr &&
1028 rb_commit_index(cpu_buffer) == index;
1029}
1030
Andrew Morton34a148b2009-01-09 12:27:09 -08001031static void
Steven Rostedtbf41a152008-10-04 02:00:59 -04001032rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
1033 struct ring_buffer_event *event)
1034{
1035 unsigned long addr = (unsigned long)event;
1036 unsigned long index;
1037
1038 index = rb_event_index(event);
1039 addr &= PAGE_MASK;
1040
1041 while (cpu_buffer->commit_page->page != (void *)addr) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001042 if (RB_WARN_ON(cpu_buffer,
1043 cpu_buffer->commit_page == cpu_buffer->tail_page))
1044 return;
Steven Rostedtabc9b562008-12-02 15:34:06 -05001045 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -04001046 cpu_buffer->commit_page->write;
1047 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001048 cpu_buffer->write_stamp =
1049 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001050 }
1051
1052 /* Now set the commit to the event's index */
Steven Rostedtabc9b562008-12-02 15:34:06 -05001053 local_set(&cpu_buffer->commit_page->page->commit, index);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001054}
1055
Andrew Morton34a148b2009-01-09 12:27:09 -08001056static void
Steven Rostedtbf41a152008-10-04 02:00:59 -04001057rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
1058{
1059 /*
1060 * We only race with interrupts and NMIs on this CPU.
1061 * If we own the commit event, then we can commit
1062 * all others that interrupted us, since the interruptions
1063 * are in stack format (they finish before they come
1064 * back to us). This allows us to do a simple loop to
1065 * assign the commit to the tail.
1066 */
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001067 again:
Steven Rostedtbf41a152008-10-04 02:00:59 -04001068 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
Steven Rostedtabc9b562008-12-02 15:34:06 -05001069 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -04001070 cpu_buffer->commit_page->write;
1071 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001072 cpu_buffer->write_stamp =
1073 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001074 /* add barrier to keep gcc from optimizing too much */
1075 barrier();
1076 }
1077 while (rb_commit_index(cpu_buffer) !=
1078 rb_page_write(cpu_buffer->commit_page)) {
Steven Rostedtabc9b562008-12-02 15:34:06 -05001079 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -04001080 cpu_buffer->commit_page->write;
1081 barrier();
1082 }
Steven Rostedta8ccf1d2008-12-23 11:32:24 -05001083
1084 /* again, keep gcc from optimizing */
1085 barrier();
1086
1087 /*
1088 * If an interrupt came in just after the first while loop
1089 * and pushed the tail page forward, we will be left with
1090 * a dangling commit that will never go forward.
1091 */
1092 if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
1093 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001094}
1095
Steven Rostedtd7690412008-10-01 00:29:53 -04001096static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001097{
Steven Rostedtabc9b562008-12-02 15:34:06 -05001098 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001099 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04001100}
1101
Andrew Morton34a148b2009-01-09 12:27:09 -08001102static void rb_inc_iter(struct ring_buffer_iter *iter)
Steven Rostedtd7690412008-10-01 00:29:53 -04001103{
1104 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1105
1106 /*
1107 * The iterator could be on the reader page (it starts there).
1108 * But the head could have moved, since the reader was
1109 * found. Check for this case and assign the iterator
1110 * to the head page instead of next.
1111 */
1112 if (iter->head_page == cpu_buffer->reader_page)
1113 iter->head_page = cpu_buffer->head_page;
1114 else
1115 rb_inc_page(cpu_buffer, &iter->head_page);
1116
Steven Rostedtabc9b562008-12-02 15:34:06 -05001117 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001118 iter->head = 0;
1119}
1120
1121/**
1122 * ring_buffer_update_event - update event type and data
1123 * @event: the even to update
1124 * @type: the type of event
1125 * @length: the size of the event field in the ring buffer
1126 *
1127 * Update the type and data fields of the event. The length
1128 * is the actual size that is written to the ring buffer,
1129 * and with this, we can determine what to place into the
1130 * data field.
1131 */
Andrew Morton34a148b2009-01-09 12:27:09 -08001132static void
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001133rb_update_event(struct ring_buffer_event *event,
1134 unsigned type, unsigned length)
1135{
1136 event->type = type;
1137
1138 switch (type) {
1139
1140 case RINGBUF_TYPE_PADDING:
1141 break;
1142
1143 case RINGBUF_TYPE_TIME_EXTEND:
Andrew Morton67d34722009-01-09 12:27:09 -08001144 event->len = DIV_ROUND_UP(RB_LEN_TIME_EXTEND, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001145 break;
1146
1147 case RINGBUF_TYPE_TIME_STAMP:
Andrew Morton67d34722009-01-09 12:27:09 -08001148 event->len = DIV_ROUND_UP(RB_LEN_TIME_STAMP, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001149 break;
1150
1151 case RINGBUF_TYPE_DATA:
1152 length -= RB_EVNT_HDR_SIZE;
1153 if (length > RB_MAX_SMALL_DATA) {
1154 event->len = 0;
1155 event->array[0] = length;
1156 } else
Andrew Morton67d34722009-01-09 12:27:09 -08001157 event->len = DIV_ROUND_UP(length, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001158 break;
1159 default:
1160 BUG();
1161 }
1162}
1163
Andrew Morton34a148b2009-01-09 12:27:09 -08001164static unsigned rb_calculate_event_length(unsigned length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001165{
1166 struct ring_buffer_event event; /* Used only for sizeof array */
1167
1168 /* zero length can cause confusions */
1169 if (!length)
1170 length = 1;
1171
1172 if (length > RB_MAX_SMALL_DATA)
1173 length += sizeof(event.array[0]);
1174
1175 length += RB_EVNT_HDR_SIZE;
1176 length = ALIGN(length, RB_ALIGNMENT);
1177
1178 return length;
1179}
1180
1181static struct ring_buffer_event *
1182__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
1183 unsigned type, unsigned long length, u64 *ts)
1184{
Steven Rostedt98db8df2008-12-23 11:32:25 -05001185 struct buffer_page *tail_page, *head_page, *reader_page, *commit_page;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001186 unsigned long tail, write;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001187 struct ring_buffer *buffer = cpu_buffer->buffer;
1188 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001189 unsigned long flags;
Steven Rostedt78d904b2009-02-05 18:43:07 -05001190 bool lock_taken = false;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001191
Steven Rostedt98db8df2008-12-23 11:32:25 -05001192 commit_page = cpu_buffer->commit_page;
1193 /* we just need to protect against interrupts */
1194 barrier();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001195 tail_page = cpu_buffer->tail_page;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001196 write = local_add_return(length, &tail_page->write);
1197 tail = write - length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001198
Steven Rostedtbf41a152008-10-04 02:00:59 -04001199 /* See if we shot pass the end of this buffer page */
1200 if (write > BUF_PAGE_SIZE) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001201 struct buffer_page *next_page = tail_page;
1202
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001203 local_irq_save(flags);
Steven Rostedt78d904b2009-02-05 18:43:07 -05001204 /*
Steven Rostedta81bd802009-02-06 01:45:16 -05001205 * Since the write to the buffer is still not
1206 * fully lockless, we must be careful with NMIs.
1207 * The locks in the writers are taken when a write
1208 * crosses to a new page. The locks protect against
1209 * races with the readers (this will soon be fixed
1210 * with a lockless solution).
1211 *
1212 * Because we can not protect against NMIs, and we
1213 * want to keep traces reentrant, we need to manage
1214 * what happens when we are in an NMI.
1215 *
Steven Rostedt78d904b2009-02-05 18:43:07 -05001216 * NMIs can happen after we take the lock.
1217 * If we are in an NMI, only take the lock
1218 * if it is not already taken. Otherwise
1219 * simply fail.
1220 */
Steven Rostedta81bd802009-02-06 01:45:16 -05001221 if (unlikely(in_nmi())) {
Steven Rostedt78d904b2009-02-05 18:43:07 -05001222 if (!__raw_spin_trylock(&cpu_buffer->lock))
Steven Rostedt45141d42009-02-12 13:19:48 -05001223 goto out_reset;
Steven Rostedt78d904b2009-02-05 18:43:07 -05001224 } else
1225 __raw_spin_lock(&cpu_buffer->lock);
1226
1227 lock_taken = true;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001228
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001229 rb_inc_page(cpu_buffer, &next_page);
1230
Steven Rostedtd7690412008-10-01 00:29:53 -04001231 head_page = cpu_buffer->head_page;
1232 reader_page = cpu_buffer->reader_page;
1233
1234 /* we grabbed the lock before incrementing */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001235 if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
Steven Rostedt45141d42009-02-12 13:19:48 -05001236 goto out_reset;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001237
1238 /*
1239 * If for some reason, we had an interrupt storm that made
1240 * it all the way around the buffer, bail, and warn
1241 * about it.
1242 */
Steven Rostedt98db8df2008-12-23 11:32:25 -05001243 if (unlikely(next_page == commit_page)) {
Steven Rostedtbf41a152008-10-04 02:00:59 -04001244 WARN_ON_ONCE(1);
Steven Rostedt45141d42009-02-12 13:19:48 -05001245 goto out_reset;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001246 }
Steven Rostedtd7690412008-10-01 00:29:53 -04001247
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001248 if (next_page == head_page) {
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001249 if (!(buffer->flags & RB_FL_OVERWRITE))
Steven Rostedt45141d42009-02-12 13:19:48 -05001250 goto out_reset;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001251
Steven Rostedtbf41a152008-10-04 02:00:59 -04001252 /* tail_page has not moved yet? */
1253 if (tail_page == cpu_buffer->tail_page) {
1254 /* count overflows */
1255 rb_update_overflow(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001256
Steven Rostedtbf41a152008-10-04 02:00:59 -04001257 rb_inc_page(cpu_buffer, &head_page);
1258 cpu_buffer->head_page = head_page;
1259 cpu_buffer->head_page->read = 0;
1260 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001261 }
1262
Steven Rostedtbf41a152008-10-04 02:00:59 -04001263 /*
1264 * If the tail page is still the same as what we think
1265 * it is, then it is up to us to update the tail
1266 * pointer.
1267 */
1268 if (tail_page == cpu_buffer->tail_page) {
1269 local_set(&next_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001270 local_set(&next_page->page->commit, 0);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001271 cpu_buffer->tail_page = next_page;
1272
1273 /* reread the time stamp */
Steven Rostedt37886f62009-03-17 17:22:06 -04001274 *ts = ring_buffer_time_stamp(buffer, cpu_buffer->cpu);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001275 cpu_buffer->tail_page->page->time_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001276 }
1277
1278 /*
1279 * The actual tail page has moved forward.
1280 */
1281 if (tail < BUF_PAGE_SIZE) {
1282 /* Mark the rest of the page with padding */
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001283 event = __rb_page_index(tail_page, tail);
Tom Zanussi2d622712009-03-22 03:30:49 -05001284 rb_event_set_padding(event);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001285 }
1286
Steven Rostedtbf41a152008-10-04 02:00:59 -04001287 if (tail <= BUF_PAGE_SIZE)
1288 /* Set the write back to the previous setting */
1289 local_set(&tail_page->write, tail);
1290
1291 /*
1292 * If this was a commit entry that failed,
1293 * increment that too
1294 */
1295 if (tail_page == cpu_buffer->commit_page &&
1296 tail == rb_commit_index(cpu_buffer)) {
1297 rb_set_commit_to_write(cpu_buffer);
1298 }
1299
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001300 __raw_spin_unlock(&cpu_buffer->lock);
1301 local_irq_restore(flags);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001302
1303 /* fail and let the caller try again */
1304 return ERR_PTR(-EAGAIN);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001305 }
1306
Steven Rostedtbf41a152008-10-04 02:00:59 -04001307 /* We reserved something on the buffer */
1308
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001309 if (RB_WARN_ON(cpu_buffer, write > BUF_PAGE_SIZE))
1310 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001311
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001312 event = __rb_page_index(tail_page, tail);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001313 rb_update_event(event, type, length);
1314
Steven Rostedtbf41a152008-10-04 02:00:59 -04001315 /*
1316 * If this is a commit and the tail is zero, then update
1317 * this page's time stamp.
1318 */
1319 if (!tail && rb_is_commit(cpu_buffer, event))
Steven Rostedtabc9b562008-12-02 15:34:06 -05001320 cpu_buffer->commit_page->page->time_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001321
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001322 return event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001323
Steven Rostedt45141d42009-02-12 13:19:48 -05001324 out_reset:
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001325 /* reset write */
1326 if (tail <= BUF_PAGE_SIZE)
1327 local_set(&tail_page->write, tail);
1328
Steven Rostedt78d904b2009-02-05 18:43:07 -05001329 if (likely(lock_taken))
1330 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001331 local_irq_restore(flags);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001332 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001333}
1334
1335static int
1336rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
1337 u64 *ts, u64 *delta)
1338{
1339 struct ring_buffer_event *event;
1340 static int once;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001341 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001342
1343 if (unlikely(*delta > (1ULL << 59) && !once++)) {
1344 printk(KERN_WARNING "Delta way too big! %llu"
1345 " ts=%llu write stamp = %llu\n",
Stephen Rothwelle2862c92008-10-27 17:43:28 +11001346 (unsigned long long)*delta,
1347 (unsigned long long)*ts,
1348 (unsigned long long)cpu_buffer->write_stamp);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001349 WARN_ON(1);
1350 }
1351
1352 /*
1353 * The delta is too big, we to add a
1354 * new timestamp.
1355 */
1356 event = __rb_reserve_next(cpu_buffer,
1357 RINGBUF_TYPE_TIME_EXTEND,
1358 RB_LEN_TIME_EXTEND,
1359 ts);
1360 if (!event)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001361 return -EBUSY;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001362
Steven Rostedtbf41a152008-10-04 02:00:59 -04001363 if (PTR_ERR(event) == -EAGAIN)
1364 return -EAGAIN;
1365
1366 /* Only a commited time event can update the write stamp */
1367 if (rb_is_commit(cpu_buffer, event)) {
1368 /*
1369 * If this is the first on the page, then we need to
1370 * update the page itself, and just put in a zero.
1371 */
1372 if (rb_event_index(event)) {
1373 event->time_delta = *delta & TS_MASK;
1374 event->array[0] = *delta >> TS_SHIFT;
1375 } else {
Steven Rostedtabc9b562008-12-02 15:34:06 -05001376 cpu_buffer->commit_page->page->time_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001377 event->time_delta = 0;
1378 event->array[0] = 0;
1379 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001380 cpu_buffer->write_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001381 /* let the caller know this was the commit */
1382 ret = 1;
1383 } else {
1384 /* Darn, this is just wasted space */
1385 event->time_delta = 0;
1386 event->array[0] = 0;
1387 ret = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001388 }
1389
Steven Rostedtbf41a152008-10-04 02:00:59 -04001390 *delta = 0;
1391
1392 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001393}
1394
1395static struct ring_buffer_event *
1396rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
1397 unsigned type, unsigned long length)
1398{
1399 struct ring_buffer_event *event;
1400 u64 ts, delta;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001401 int commit = 0;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001402 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001403
Steven Rostedtbf41a152008-10-04 02:00:59 -04001404 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001405 /*
1406 * We allow for interrupts to reenter here and do a trace.
1407 * If one does, it will cause this original code to loop
1408 * back here. Even with heavy interrupts happening, this
1409 * should only happen a few times in a row. If this happens
1410 * 1000 times in a row, there must be either an interrupt
1411 * storm or we have something buggy.
1412 * Bail!
1413 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001414 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001415 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001416
Steven Rostedt37886f62009-03-17 17:22:06 -04001417 ts = ring_buffer_time_stamp(cpu_buffer->buffer, cpu_buffer->cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001418
Steven Rostedtbf41a152008-10-04 02:00:59 -04001419 /*
1420 * Only the first commit can update the timestamp.
1421 * Yes there is a race here. If an interrupt comes in
1422 * just after the conditional and it traces too, then it
1423 * will also check the deltas. More than one timestamp may
1424 * also be made. But only the entry that did the actual
1425 * commit will be something other than zero.
1426 */
1427 if (cpu_buffer->tail_page == cpu_buffer->commit_page &&
1428 rb_page_write(cpu_buffer->tail_page) ==
1429 rb_commit_index(cpu_buffer)) {
1430
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001431 delta = ts - cpu_buffer->write_stamp;
1432
Steven Rostedtbf41a152008-10-04 02:00:59 -04001433 /* make sure this delta is calculated here */
1434 barrier();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001435
Steven Rostedtbf41a152008-10-04 02:00:59 -04001436 /* Did the write stamp get updated already? */
1437 if (unlikely(ts < cpu_buffer->write_stamp))
Steven Rostedt4143c5c2008-11-10 21:46:01 -05001438 delta = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001439
1440 if (test_time_stamp(delta)) {
1441
1442 commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
1443
1444 if (commit == -EBUSY)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001445 return NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001446
1447 if (commit == -EAGAIN)
1448 goto again;
1449
1450 RB_WARN_ON(cpu_buffer, commit < 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001451 }
Steven Rostedtbf41a152008-10-04 02:00:59 -04001452 } else
1453 /* Non commits have zero deltas */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001454 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001455
1456 event = __rb_reserve_next(cpu_buffer, type, length, &ts);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001457 if (PTR_ERR(event) == -EAGAIN)
1458 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001459
Steven Rostedtbf41a152008-10-04 02:00:59 -04001460 if (!event) {
1461 if (unlikely(commit))
1462 /*
1463 * Ouch! We needed a timestamp and it was commited. But
1464 * we didn't get our event reserved.
1465 */
1466 rb_set_commit_to_write(cpu_buffer);
1467 return NULL;
1468 }
1469
1470 /*
1471 * If the timestamp was commited, make the commit our entry
1472 * now so that we will update it when needed.
1473 */
1474 if (commit)
1475 rb_set_commit_event(cpu_buffer, event);
1476 else if (!rb_is_commit(cpu_buffer, event))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001477 delta = 0;
1478
1479 event->time_delta = delta;
1480
1481 return event;
1482}
1483
Steven Rostedt261842b2009-04-16 21:41:52 -04001484static int trace_irq_level(void)
1485{
1486 return hardirq_count() + softirq_count() + in_nmi();
1487}
1488
1489static int trace_recursive_lock(void)
1490{
1491 int level;
1492
1493 level = trace_irq_level();
1494
1495 if (unlikely(current->trace_recursion & (1 << level))) {
1496 /* Disable all tracing before we do anything else */
1497 tracing_off_permanent();
Frederic Weisbeckere057a5e2009-04-19 23:38:12 +02001498
1499 printk_once(KERN_WARNING "Tracing recursion: "
1500 "HC[%lu]:SC[%lu]:NMI[%lu]\n",
1501 hardirq_count() >> HARDIRQ_SHIFT,
1502 softirq_count() >> SOFTIRQ_SHIFT,
1503 in_nmi());
1504
Steven Rostedt261842b2009-04-16 21:41:52 -04001505 WARN_ON_ONCE(1);
1506 return -1;
1507 }
1508
1509 current->trace_recursion |= 1 << level;
1510
1511 return 0;
1512}
1513
1514static void trace_recursive_unlock(void)
1515{
1516 int level;
1517
1518 level = trace_irq_level();
1519
1520 WARN_ON_ONCE(!current->trace_recursion & (1 << level));
1521
1522 current->trace_recursion &= ~(1 << level);
1523}
1524
Steven Rostedtbf41a152008-10-04 02:00:59 -04001525static DEFINE_PER_CPU(int, rb_need_resched);
1526
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001527/**
1528 * ring_buffer_lock_reserve - reserve a part of the buffer
1529 * @buffer: the ring buffer to reserve from
1530 * @length: the length of the data to reserve (excluding event header)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001531 *
1532 * Returns a reseverd event on the ring buffer to copy directly to.
1533 * The user of this interface will need to get the body to write into
1534 * and can use the ring_buffer_event_data() interface.
1535 *
1536 * The length is the length of the data needed, not the event length
1537 * which also includes the event header.
1538 *
1539 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
1540 * If NULL is returned, then nothing has been allocated or locked.
1541 */
1542struct ring_buffer_event *
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02001543ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001544{
1545 struct ring_buffer_per_cpu *cpu_buffer;
1546 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001547 int cpu, resched;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001548
Steven Rostedt033601a2008-11-21 12:41:55 -05001549 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05001550 return NULL;
1551
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001552 if (atomic_read(&buffer->record_disabled))
1553 return NULL;
1554
Steven Rostedtbf41a152008-10-04 02:00:59 -04001555 /* If we are tracing schedule, we don't want to recurse */
Steven Rostedt182e9f52008-11-03 23:15:56 -05001556 resched = ftrace_preempt_disable();
Steven Rostedtbf41a152008-10-04 02:00:59 -04001557
Steven Rostedt261842b2009-04-16 21:41:52 -04001558 if (trace_recursive_lock())
1559 goto out_nocheck;
1560
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001561 cpu = raw_smp_processor_id();
1562
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301563 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04001564 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001565
1566 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001567
1568 if (atomic_read(&cpu_buffer->record_disabled))
Steven Rostedtd7690412008-10-01 00:29:53 -04001569 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001570
1571 length = rb_calculate_event_length(length);
1572 if (length > BUF_PAGE_SIZE)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001573 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001574
1575 event = rb_reserve_next_event(cpu_buffer, RINGBUF_TYPE_DATA, length);
1576 if (!event)
Steven Rostedtd7690412008-10-01 00:29:53 -04001577 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001578
Steven Rostedtbf41a152008-10-04 02:00:59 -04001579 /*
1580 * Need to store resched state on this cpu.
1581 * Only the first needs to.
1582 */
1583
1584 if (preempt_count() == 1)
1585 per_cpu(rb_need_resched, cpu) = resched;
1586
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001587 return event;
1588
Steven Rostedtd7690412008-10-01 00:29:53 -04001589 out:
Steven Rostedt261842b2009-04-16 21:41:52 -04001590 trace_recursive_unlock();
1591
1592 out_nocheck:
Steven Rostedt182e9f52008-11-03 23:15:56 -05001593 ftrace_preempt_enable(resched);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001594 return NULL;
1595}
Robert Richterc4f50182008-12-11 16:49:22 +01001596EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001597
1598static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
1599 struct ring_buffer_event *event)
1600{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001601 cpu_buffer->entries++;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001602
1603 /* Only process further if we own the commit */
1604 if (!rb_is_commit(cpu_buffer, event))
1605 return;
1606
1607 cpu_buffer->write_stamp += event->time_delta;
1608
1609 rb_set_commit_to_write(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001610}
1611
1612/**
1613 * ring_buffer_unlock_commit - commit a reserved
1614 * @buffer: The buffer to commit to
1615 * @event: The event pointer to commit.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001616 *
1617 * This commits the data to the ring buffer, and releases any locks held.
1618 *
1619 * Must be paired with ring_buffer_lock_reserve.
1620 */
1621int ring_buffer_unlock_commit(struct ring_buffer *buffer,
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02001622 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001623{
1624 struct ring_buffer_per_cpu *cpu_buffer;
1625 int cpu = raw_smp_processor_id();
1626
1627 cpu_buffer = buffer->buffers[cpu];
1628
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001629 rb_commit(cpu_buffer, event);
1630
Steven Rostedt261842b2009-04-16 21:41:52 -04001631 trace_recursive_unlock();
1632
Steven Rostedtbf41a152008-10-04 02:00:59 -04001633 /*
1634 * Only the last preempt count needs to restore preemption.
1635 */
Steven Rostedt182e9f52008-11-03 23:15:56 -05001636 if (preempt_count() == 1)
1637 ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
1638 else
Steven Rostedtbf41a152008-10-04 02:00:59 -04001639 preempt_enable_no_resched_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001640
1641 return 0;
1642}
Robert Richterc4f50182008-12-11 16:49:22 +01001643EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001644
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001645static inline void rb_event_discard(struct ring_buffer_event *event)
1646{
1647 event->type = RINGBUF_TYPE_PADDING;
1648 /* time delta must be non zero */
1649 if (!event->time_delta)
1650 event->time_delta = 1;
1651}
1652
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001653/**
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001654 * ring_buffer_event_discard - discard any event in the ring buffer
1655 * @event: the event to discard
1656 *
1657 * Sometimes a event that is in the ring buffer needs to be ignored.
1658 * This function lets the user discard an event in the ring buffer
1659 * and then that event will not be read later.
1660 *
1661 * Note, it is up to the user to be careful with this, and protect
1662 * against races. If the user discards an event that has been consumed
1663 * it is possible that it could corrupt the ring buffer.
1664 */
1665void ring_buffer_event_discard(struct ring_buffer_event *event)
1666{
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001667 rb_event_discard(event);
1668 trace_recursive_unlock();
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001669}
1670EXPORT_SYMBOL_GPL(ring_buffer_event_discard);
1671
1672/**
1673 * ring_buffer_commit_discard - discard an event that has not been committed
1674 * @buffer: the ring buffer
1675 * @event: non committed event to discard
1676 *
1677 * This is similar to ring_buffer_event_discard but must only be
1678 * performed on an event that has not been committed yet. The difference
1679 * is that this will also try to free the event from the ring buffer
1680 * if another event has not been added behind it.
1681 *
1682 * If another event has been added behind it, it will set the event
1683 * up as discarded, and perform the commit.
1684 *
1685 * If this function is called, do not call ring_buffer_unlock_commit on
1686 * the event.
1687 */
1688void ring_buffer_discard_commit(struct ring_buffer *buffer,
1689 struct ring_buffer_event *event)
1690{
1691 struct ring_buffer_per_cpu *cpu_buffer;
1692 unsigned long new_index, old_index;
1693 struct buffer_page *bpage;
1694 unsigned long index;
1695 unsigned long addr;
1696 int cpu;
1697
1698 /* The event is discarded regardless */
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001699 rb_event_discard(event);
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001700
1701 /*
1702 * This must only be called if the event has not been
1703 * committed yet. Thus we can assume that preemption
1704 * is still disabled.
1705 */
1706 RB_WARN_ON(buffer, !preempt_count());
1707
1708 cpu = smp_processor_id();
1709 cpu_buffer = buffer->buffers[cpu];
1710
1711 new_index = rb_event_index(event);
1712 old_index = new_index + rb_event_length(event);
1713 addr = (unsigned long)event;
1714 addr &= PAGE_MASK;
1715
1716 bpage = cpu_buffer->tail_page;
1717
1718 if (bpage == (void *)addr && rb_page_write(bpage) == old_index) {
1719 /*
1720 * This is on the tail page. It is possible that
1721 * a write could come in and move the tail page
1722 * and write to the next page. That is fine
1723 * because we just shorten what is on this page.
1724 */
1725 index = local_cmpxchg(&bpage->write, old_index, new_index);
1726 if (index == old_index)
1727 goto out;
1728 }
1729
1730 /*
1731 * The commit is still visible by the reader, so we
1732 * must increment entries.
1733 */
1734 cpu_buffer->entries++;
1735 out:
1736 /*
1737 * If a write came in and pushed the tail page
1738 * we still need to update the commit pointer
1739 * if we were the commit.
1740 */
1741 if (rb_is_commit(cpu_buffer, event))
1742 rb_set_commit_to_write(cpu_buffer);
1743
Frederic Weisbeckerf3b9aae2009-04-19 23:39:33 +02001744 trace_recursive_unlock();
1745
Steven Rostedtfa1b47d2009-04-02 00:09:41 -04001746 /*
1747 * Only the last preempt count needs to restore preemption.
1748 */
1749 if (preempt_count() == 1)
1750 ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
1751 else
1752 preempt_enable_no_resched_notrace();
1753
1754}
1755EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
1756
1757/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001758 * ring_buffer_write - write data to the buffer without reserving
1759 * @buffer: The ring buffer to write to.
1760 * @length: The length of the data being written (excluding the event header)
1761 * @data: The data to write to the buffer.
1762 *
1763 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
1764 * one function. If you already have the data to write to the buffer, it
1765 * may be easier to simply call this function.
1766 *
1767 * Note, like ring_buffer_lock_reserve, the length is the length of the data
1768 * and not the length of the event which would hold the header.
1769 */
1770int ring_buffer_write(struct ring_buffer *buffer,
1771 unsigned long length,
1772 void *data)
1773{
1774 struct ring_buffer_per_cpu *cpu_buffer;
1775 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001776 unsigned long event_length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001777 void *body;
1778 int ret = -EBUSY;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001779 int cpu, resched;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001780
Steven Rostedt033601a2008-11-21 12:41:55 -05001781 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05001782 return -EBUSY;
1783
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001784 if (atomic_read(&buffer->record_disabled))
1785 return -EBUSY;
1786
Steven Rostedt182e9f52008-11-03 23:15:56 -05001787 resched = ftrace_preempt_disable();
Steven Rostedtbf41a152008-10-04 02:00:59 -04001788
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001789 cpu = raw_smp_processor_id();
1790
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301791 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04001792 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001793
1794 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001795
1796 if (atomic_read(&cpu_buffer->record_disabled))
1797 goto out;
1798
1799 event_length = rb_calculate_event_length(length);
1800 event = rb_reserve_next_event(cpu_buffer,
1801 RINGBUF_TYPE_DATA, event_length);
1802 if (!event)
1803 goto out;
1804
1805 body = rb_event_data(event);
1806
1807 memcpy(body, data, length);
1808
1809 rb_commit(cpu_buffer, event);
1810
1811 ret = 0;
1812 out:
Steven Rostedt182e9f52008-11-03 23:15:56 -05001813 ftrace_preempt_enable(resched);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001814
1815 return ret;
1816}
Robert Richterc4f50182008-12-11 16:49:22 +01001817EXPORT_SYMBOL_GPL(ring_buffer_write);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001818
Andrew Morton34a148b2009-01-09 12:27:09 -08001819static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001820{
1821 struct buffer_page *reader = cpu_buffer->reader_page;
1822 struct buffer_page *head = cpu_buffer->head_page;
1823 struct buffer_page *commit = cpu_buffer->commit_page;
1824
1825 return reader->read == rb_page_commit(reader) &&
1826 (commit == reader ||
1827 (commit == head &&
1828 head->read == rb_page_commit(commit)));
1829}
1830
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001831/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001832 * ring_buffer_record_disable - stop all writes into the buffer
1833 * @buffer: The ring buffer to stop writes to.
1834 *
1835 * This prevents all writes to the buffer. Any attempt to write
1836 * to the buffer after this will fail and return NULL.
1837 *
1838 * The caller should call synchronize_sched() after this.
1839 */
1840void ring_buffer_record_disable(struct ring_buffer *buffer)
1841{
1842 atomic_inc(&buffer->record_disabled);
1843}
Robert Richterc4f50182008-12-11 16:49:22 +01001844EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001845
1846/**
1847 * ring_buffer_record_enable - enable writes to the buffer
1848 * @buffer: The ring buffer to enable writes
1849 *
1850 * Note, multiple disables will need the same number of enables
1851 * to truely enable the writing (much like preempt_disable).
1852 */
1853void ring_buffer_record_enable(struct ring_buffer *buffer)
1854{
1855 atomic_dec(&buffer->record_disabled);
1856}
Robert Richterc4f50182008-12-11 16:49:22 +01001857EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001858
1859/**
1860 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
1861 * @buffer: The ring buffer to stop writes to.
1862 * @cpu: The CPU buffer to stop
1863 *
1864 * This prevents all writes to the buffer. Any attempt to write
1865 * to the buffer after this will fail and return NULL.
1866 *
1867 * The caller should call synchronize_sched() after this.
1868 */
1869void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
1870{
1871 struct ring_buffer_per_cpu *cpu_buffer;
1872
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301873 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001874 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001875
1876 cpu_buffer = buffer->buffers[cpu];
1877 atomic_inc(&cpu_buffer->record_disabled);
1878}
Robert Richterc4f50182008-12-11 16:49:22 +01001879EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001880
1881/**
1882 * ring_buffer_record_enable_cpu - enable writes to the buffer
1883 * @buffer: The ring buffer to enable writes
1884 * @cpu: The CPU to enable.
1885 *
1886 * Note, multiple disables will need the same number of enables
1887 * to truely enable the writing (much like preempt_disable).
1888 */
1889void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
1890{
1891 struct ring_buffer_per_cpu *cpu_buffer;
1892
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301893 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001894 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001895
1896 cpu_buffer = buffer->buffers[cpu];
1897 atomic_dec(&cpu_buffer->record_disabled);
1898}
Robert Richterc4f50182008-12-11 16:49:22 +01001899EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001900
1901/**
1902 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
1903 * @buffer: The ring buffer
1904 * @cpu: The per CPU buffer to get the entries from.
1905 */
1906unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
1907{
1908 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04001909 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001910
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301911 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001912 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001913
1914 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04001915 ret = cpu_buffer->entries;
Steven Rostedt554f7862009-03-11 22:00:13 -04001916
1917 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001918}
Robert Richterc4f50182008-12-11 16:49:22 +01001919EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001920
1921/**
1922 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
1923 * @buffer: The ring buffer
1924 * @cpu: The per CPU buffer to get the number of overruns from
1925 */
1926unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
1927{
1928 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04001929 unsigned long ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001930
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301931 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04001932 return 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001933
1934 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04001935 ret = cpu_buffer->overrun;
Steven Rostedt554f7862009-03-11 22:00:13 -04001936
1937 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001938}
Robert Richterc4f50182008-12-11 16:49:22 +01001939EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001940
1941/**
1942 * ring_buffer_entries - get the number of entries in a buffer
1943 * @buffer: The ring buffer
1944 *
1945 * Returns the total number of entries in the ring buffer
1946 * (all CPU entries)
1947 */
1948unsigned long ring_buffer_entries(struct ring_buffer *buffer)
1949{
1950 struct ring_buffer_per_cpu *cpu_buffer;
1951 unsigned long entries = 0;
1952 int cpu;
1953
1954 /* if you care about this being correct, lock the buffer */
1955 for_each_buffer_cpu(buffer, cpu) {
1956 cpu_buffer = buffer->buffers[cpu];
1957 entries += cpu_buffer->entries;
1958 }
1959
1960 return entries;
1961}
Robert Richterc4f50182008-12-11 16:49:22 +01001962EXPORT_SYMBOL_GPL(ring_buffer_entries);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001963
1964/**
1965 * ring_buffer_overrun_cpu - get the number of overruns in buffer
1966 * @buffer: The ring buffer
1967 *
1968 * Returns the total number of overruns in the ring buffer
1969 * (all CPU entries)
1970 */
1971unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
1972{
1973 struct ring_buffer_per_cpu *cpu_buffer;
1974 unsigned long overruns = 0;
1975 int cpu;
1976
1977 /* if you care about this being correct, lock the buffer */
1978 for_each_buffer_cpu(buffer, cpu) {
1979 cpu_buffer = buffer->buffers[cpu];
1980 overruns += cpu_buffer->overrun;
1981 }
1982
1983 return overruns;
1984}
Robert Richterc4f50182008-12-11 16:49:22 +01001985EXPORT_SYMBOL_GPL(ring_buffer_overruns);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001986
Steven Rostedt642edba2008-11-12 00:01:26 -05001987static void rb_iter_reset(struct ring_buffer_iter *iter)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001988{
1989 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1990
Steven Rostedtd7690412008-10-01 00:29:53 -04001991 /* Iterator usage is expected to have record disabled */
1992 if (list_empty(&cpu_buffer->reader_page->list)) {
1993 iter->head_page = cpu_buffer->head_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001994 iter->head = cpu_buffer->head_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04001995 } else {
1996 iter->head_page = cpu_buffer->reader_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001997 iter->head = cpu_buffer->reader_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04001998 }
1999 if (iter->head)
2000 iter->read_stamp = cpu_buffer->read_stamp;
2001 else
Steven Rostedtabc9b562008-12-02 15:34:06 -05002002 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt642edba2008-11-12 00:01:26 -05002003}
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002004
Steven Rostedt642edba2008-11-12 00:01:26 -05002005/**
2006 * ring_buffer_iter_reset - reset an iterator
2007 * @iter: The iterator to reset
2008 *
2009 * Resets the iterator, so that it will start from the beginning
2010 * again.
2011 */
2012void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
2013{
Steven Rostedt554f7862009-03-11 22:00:13 -04002014 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt642edba2008-11-12 00:01:26 -05002015 unsigned long flags;
2016
Steven Rostedt554f7862009-03-11 22:00:13 -04002017 if (!iter)
2018 return;
2019
2020 cpu_buffer = iter->cpu_buffer;
2021
Steven Rostedt642edba2008-11-12 00:01:26 -05002022 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2023 rb_iter_reset(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002024 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002025}
Robert Richterc4f50182008-12-11 16:49:22 +01002026EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002027
2028/**
2029 * ring_buffer_iter_empty - check if an iterator has no more to read
2030 * @iter: The iterator to check
2031 */
2032int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
2033{
2034 struct ring_buffer_per_cpu *cpu_buffer;
2035
2036 cpu_buffer = iter->cpu_buffer;
2037
Steven Rostedtbf41a152008-10-04 02:00:59 -04002038 return iter->head_page == cpu_buffer->commit_page &&
2039 iter->head == rb_commit_index(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002040}
Robert Richterc4f50182008-12-11 16:49:22 +01002041EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002042
2043static void
2044rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
2045 struct ring_buffer_event *event)
2046{
2047 u64 delta;
2048
2049 switch (event->type) {
2050 case RINGBUF_TYPE_PADDING:
2051 return;
2052
2053 case RINGBUF_TYPE_TIME_EXTEND:
2054 delta = event->array[0];
2055 delta <<= TS_SHIFT;
2056 delta += event->time_delta;
2057 cpu_buffer->read_stamp += delta;
2058 return;
2059
2060 case RINGBUF_TYPE_TIME_STAMP:
2061 /* FIXME: not implemented */
2062 return;
2063
2064 case RINGBUF_TYPE_DATA:
2065 cpu_buffer->read_stamp += event->time_delta;
2066 return;
2067
2068 default:
2069 BUG();
2070 }
2071 return;
2072}
2073
2074static void
2075rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
2076 struct ring_buffer_event *event)
2077{
2078 u64 delta;
2079
2080 switch (event->type) {
2081 case RINGBUF_TYPE_PADDING:
2082 return;
2083
2084 case RINGBUF_TYPE_TIME_EXTEND:
2085 delta = event->array[0];
2086 delta <<= TS_SHIFT;
2087 delta += event->time_delta;
2088 iter->read_stamp += delta;
2089 return;
2090
2091 case RINGBUF_TYPE_TIME_STAMP:
2092 /* FIXME: not implemented */
2093 return;
2094
2095 case RINGBUF_TYPE_DATA:
2096 iter->read_stamp += event->time_delta;
2097 return;
2098
2099 default:
2100 BUG();
2101 }
2102 return;
2103}
2104
Steven Rostedtd7690412008-10-01 00:29:53 -04002105static struct buffer_page *
2106rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002107{
Steven Rostedtd7690412008-10-01 00:29:53 -04002108 struct buffer_page *reader = NULL;
2109 unsigned long flags;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002110 int nr_loops = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04002111
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002112 local_irq_save(flags);
2113 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedtd7690412008-10-01 00:29:53 -04002114
2115 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002116 /*
2117 * This should normally only loop twice. But because the
2118 * start of the reader inserts an empty page, it causes
2119 * a case where we will loop three times. There should be no
2120 * reason to loop four times (that I know of).
2121 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002122 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002123 reader = NULL;
2124 goto out;
2125 }
2126
Steven Rostedtd7690412008-10-01 00:29:53 -04002127 reader = cpu_buffer->reader_page;
2128
2129 /* If there's more to read, return this page */
Steven Rostedtbf41a152008-10-04 02:00:59 -04002130 if (cpu_buffer->reader_page->read < rb_page_size(reader))
Steven Rostedtd7690412008-10-01 00:29:53 -04002131 goto out;
2132
2133 /* Never should we have an index greater than the size */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002134 if (RB_WARN_ON(cpu_buffer,
2135 cpu_buffer->reader_page->read > rb_page_size(reader)))
2136 goto out;
Steven Rostedtd7690412008-10-01 00:29:53 -04002137
2138 /* check if we caught up to the tail */
2139 reader = NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002140 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
Steven Rostedtd7690412008-10-01 00:29:53 -04002141 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002142
2143 /*
Steven Rostedtd7690412008-10-01 00:29:53 -04002144 * Splice the empty reader page into the list around the head.
2145 * Reset the reader page to size zero.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002146 */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002147
Steven Rostedtd7690412008-10-01 00:29:53 -04002148 reader = cpu_buffer->head_page;
2149 cpu_buffer->reader_page->list.next = reader->list.next;
2150 cpu_buffer->reader_page->list.prev = reader->list.prev;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002151
2152 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002153 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedtd7690412008-10-01 00:29:53 -04002154
2155 /* Make the reader page now replace the head */
2156 reader->list.prev->next = &cpu_buffer->reader_page->list;
2157 reader->list.next->prev = &cpu_buffer->reader_page->list;
2158
2159 /*
2160 * If the tail is on the reader, then we must set the head
2161 * to the inserted page, otherwise we set it one before.
2162 */
2163 cpu_buffer->head_page = cpu_buffer->reader_page;
2164
Steven Rostedtbf41a152008-10-04 02:00:59 -04002165 if (cpu_buffer->commit_page != reader)
Steven Rostedtd7690412008-10-01 00:29:53 -04002166 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
2167
2168 /* Finally update the reader page to the new head */
2169 cpu_buffer->reader_page = reader;
2170 rb_reset_reader_page(cpu_buffer);
2171
2172 goto again;
2173
2174 out:
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002175 __raw_spin_unlock(&cpu_buffer->lock);
2176 local_irq_restore(flags);
Steven Rostedtd7690412008-10-01 00:29:53 -04002177
2178 return reader;
2179}
2180
2181static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
2182{
2183 struct ring_buffer_event *event;
2184 struct buffer_page *reader;
2185 unsigned length;
2186
2187 reader = rb_get_reader_page(cpu_buffer);
2188
2189 /* This function should not be called when buffer is empty */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002190 if (RB_WARN_ON(cpu_buffer, !reader))
2191 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04002192
2193 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002194
Tom Zanussi2d622712009-03-22 03:30:49 -05002195 if (event->type == RINGBUF_TYPE_DATA || rb_discarded_event(event))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002196 cpu_buffer->entries--;
2197
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002198 rb_update_read_stamp(cpu_buffer, event);
2199
Steven Rostedtd7690412008-10-01 00:29:53 -04002200 length = rb_event_length(event);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002201 cpu_buffer->reader_page->read += length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002202}
2203
2204static void rb_advance_iter(struct ring_buffer_iter *iter)
2205{
2206 struct ring_buffer *buffer;
2207 struct ring_buffer_per_cpu *cpu_buffer;
2208 struct ring_buffer_event *event;
2209 unsigned length;
2210
2211 cpu_buffer = iter->cpu_buffer;
2212 buffer = cpu_buffer->buffer;
2213
2214 /*
2215 * Check if we are at the end of the buffer.
2216 */
Steven Rostedtbf41a152008-10-04 02:00:59 -04002217 if (iter->head >= rb_page_size(iter->head_page)) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002218 if (RB_WARN_ON(buffer,
2219 iter->head_page == cpu_buffer->commit_page))
2220 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04002221 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002222 return;
2223 }
2224
2225 event = rb_iter_head_event(iter);
2226
2227 length = rb_event_length(event);
2228
2229 /*
2230 * This should not be called to advance the header if we are
2231 * at the tail of the buffer.
2232 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002233 if (RB_WARN_ON(cpu_buffer,
Steven Rostedtf536aaf2008-11-10 23:07:30 -05002234 (iter->head_page == cpu_buffer->commit_page) &&
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002235 (iter->head + length > rb_commit_index(cpu_buffer))))
2236 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002237
2238 rb_update_iter_read_stamp(iter, event);
2239
2240 iter->head += length;
2241
2242 /* check for end of page padding */
Steven Rostedtbf41a152008-10-04 02:00:59 -04002243 if ((iter->head >= rb_page_size(iter->head_page)) &&
2244 (iter->head_page != cpu_buffer->commit_page))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002245 rb_advance_iter(iter);
2246}
2247
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002248static struct ring_buffer_event *
2249rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002250{
2251 struct ring_buffer_per_cpu *cpu_buffer;
2252 struct ring_buffer_event *event;
Steven Rostedtd7690412008-10-01 00:29:53 -04002253 struct buffer_page *reader;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002254 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002255
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002256 cpu_buffer = buffer->buffers[cpu];
2257
2258 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002259 /*
2260 * We repeat when a timestamp is encountered. It is possible
2261 * to get multiple timestamps from an interrupt entering just
2262 * as one timestamp is about to be written. The max times
2263 * that this can happen is the number of nested interrupts we
2264 * can have. Nesting 10 deep of interrupts is clearly
2265 * an anomaly.
2266 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002267 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002268 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002269
Steven Rostedtd7690412008-10-01 00:29:53 -04002270 reader = rb_get_reader_page(cpu_buffer);
2271 if (!reader)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002272 return NULL;
2273
Steven Rostedtd7690412008-10-01 00:29:53 -04002274 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002275
2276 switch (event->type) {
2277 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05002278 if (rb_null_event(event))
2279 RB_WARN_ON(cpu_buffer, 1);
2280 /*
2281 * Because the writer could be discarding every
2282 * event it creates (which would probably be bad)
2283 * if we were to go back to "again" then we may never
2284 * catch up, and will trigger the warn on, or lock
2285 * the box. Return the padding, and we will release
2286 * the current locks, and try again.
2287 */
Steven Rostedtd7690412008-10-01 00:29:53 -04002288 rb_advance_reader(cpu_buffer);
Tom Zanussi2d622712009-03-22 03:30:49 -05002289 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002290
2291 case RINGBUF_TYPE_TIME_EXTEND:
2292 /* Internal data, OK to advance */
Steven Rostedtd7690412008-10-01 00:29:53 -04002293 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002294 goto again;
2295
2296 case RINGBUF_TYPE_TIME_STAMP:
2297 /* FIXME: not implemented */
Steven Rostedtd7690412008-10-01 00:29:53 -04002298 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002299 goto again;
2300
2301 case RINGBUF_TYPE_DATA:
2302 if (ts) {
2303 *ts = cpu_buffer->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04002304 ring_buffer_normalize_time_stamp(buffer,
2305 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002306 }
2307 return event;
2308
2309 default:
2310 BUG();
2311 }
2312
2313 return NULL;
2314}
Robert Richterc4f50182008-12-11 16:49:22 +01002315EXPORT_SYMBOL_GPL(ring_buffer_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002316
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002317static struct ring_buffer_event *
2318rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002319{
2320 struct ring_buffer *buffer;
2321 struct ring_buffer_per_cpu *cpu_buffer;
2322 struct ring_buffer_event *event;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002323 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002324
2325 if (ring_buffer_iter_empty(iter))
2326 return NULL;
2327
2328 cpu_buffer = iter->cpu_buffer;
2329 buffer = cpu_buffer->buffer;
2330
2331 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002332 /*
2333 * We repeat when a timestamp is encountered. It is possible
2334 * to get multiple timestamps from an interrupt entering just
2335 * as one timestamp is about to be written. The max times
2336 * that this can happen is the number of nested interrupts we
2337 * can have. Nesting 10 deep of interrupts is clearly
2338 * an anomaly.
2339 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05002340 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002341 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04002342
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002343 if (rb_per_cpu_empty(cpu_buffer))
2344 return NULL;
2345
2346 event = rb_iter_head_event(iter);
2347
2348 switch (event->type) {
2349 case RINGBUF_TYPE_PADDING:
Tom Zanussi2d622712009-03-22 03:30:49 -05002350 if (rb_null_event(event)) {
2351 rb_inc_iter(iter);
2352 goto again;
2353 }
2354 rb_advance_iter(iter);
2355 return event;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002356
2357 case RINGBUF_TYPE_TIME_EXTEND:
2358 /* Internal data, OK to advance */
2359 rb_advance_iter(iter);
2360 goto again;
2361
2362 case RINGBUF_TYPE_TIME_STAMP:
2363 /* FIXME: not implemented */
2364 rb_advance_iter(iter);
2365 goto again;
2366
2367 case RINGBUF_TYPE_DATA:
2368 if (ts) {
2369 *ts = iter->read_stamp + event->time_delta;
Steven Rostedt37886f62009-03-17 17:22:06 -04002370 ring_buffer_normalize_time_stamp(buffer,
2371 cpu_buffer->cpu, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002372 }
2373 return event;
2374
2375 default:
2376 BUG();
2377 }
2378
2379 return NULL;
2380}
Robert Richterc4f50182008-12-11 16:49:22 +01002381EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002382
2383/**
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002384 * ring_buffer_peek - peek at the next event to be read
2385 * @buffer: The ring buffer to read
2386 * @cpu: The cpu to peak at
2387 * @ts: The timestamp counter of this event.
2388 *
2389 * This will return the event that will be read next, but does
2390 * not consume the data.
2391 */
2392struct ring_buffer_event *
2393ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
2394{
2395 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
Steven Rostedt8aabee52009-03-12 13:13:49 -04002396 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002397 unsigned long flags;
2398
Steven Rostedt554f7862009-03-11 22:00:13 -04002399 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002400 return NULL;
Steven Rostedt554f7862009-03-11 22:00:13 -04002401
Tom Zanussi2d622712009-03-22 03:30:49 -05002402 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002403 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2404 event = rb_buffer_peek(buffer, cpu, ts);
2405 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2406
Tom Zanussi2d622712009-03-22 03:30:49 -05002407 if (event && event->type == RINGBUF_TYPE_PADDING) {
2408 cpu_relax();
2409 goto again;
2410 }
2411
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002412 return event;
2413}
2414
2415/**
2416 * ring_buffer_iter_peek - peek at the next event to be read
2417 * @iter: The ring buffer iterator
2418 * @ts: The timestamp counter of this event.
2419 *
2420 * This will return the event that will be read next, but does
2421 * not increment the iterator.
2422 */
2423struct ring_buffer_event *
2424ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
2425{
2426 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2427 struct ring_buffer_event *event;
2428 unsigned long flags;
2429
Tom Zanussi2d622712009-03-22 03:30:49 -05002430 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002431 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2432 event = rb_iter_peek(iter, ts);
2433 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2434
Tom Zanussi2d622712009-03-22 03:30:49 -05002435 if (event && event->type == RINGBUF_TYPE_PADDING) {
2436 cpu_relax();
2437 goto again;
2438 }
2439
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002440 return event;
2441}
2442
2443/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002444 * ring_buffer_consume - return an event and consume it
2445 * @buffer: The ring buffer to get the next event from
2446 *
2447 * Returns the next event in the ring buffer, and that event is consumed.
2448 * Meaning, that sequential reads will keep returning a different event,
2449 * and eventually empty the ring buffer if the producer is slower.
2450 */
2451struct ring_buffer_event *
2452ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
2453{
Steven Rostedt554f7862009-03-11 22:00:13 -04002454 struct ring_buffer_per_cpu *cpu_buffer;
2455 struct ring_buffer_event *event = NULL;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002456 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002457
Tom Zanussi2d622712009-03-22 03:30:49 -05002458 again:
Steven Rostedt554f7862009-03-11 22:00:13 -04002459 /* might be called in atomic */
2460 preempt_disable();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002461
Steven Rostedt554f7862009-03-11 22:00:13 -04002462 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2463 goto out;
2464
2465 cpu_buffer = buffer->buffers[cpu];
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002466 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002467
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002468 event = rb_buffer_peek(buffer, cpu, ts);
2469 if (!event)
Steven Rostedt554f7862009-03-11 22:00:13 -04002470 goto out_unlock;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002471
Steven Rostedtd7690412008-10-01 00:29:53 -04002472 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002473
Steven Rostedt554f7862009-03-11 22:00:13 -04002474 out_unlock:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002475 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2476
Steven Rostedt554f7862009-03-11 22:00:13 -04002477 out:
2478 preempt_enable();
2479
Tom Zanussi2d622712009-03-22 03:30:49 -05002480 if (event && event->type == RINGBUF_TYPE_PADDING) {
2481 cpu_relax();
2482 goto again;
2483 }
2484
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002485 return event;
2486}
Robert Richterc4f50182008-12-11 16:49:22 +01002487EXPORT_SYMBOL_GPL(ring_buffer_consume);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002488
2489/**
2490 * ring_buffer_read_start - start a non consuming read of the buffer
2491 * @buffer: The ring buffer to read from
2492 * @cpu: The cpu buffer to iterate over
2493 *
2494 * This starts up an iteration through the buffer. It also disables
2495 * the recording to the buffer until the reading is finished.
2496 * This prevents the reading from being corrupted. This is not
2497 * a consuming read, so a producer is not expected.
2498 *
2499 * Must be paired with ring_buffer_finish.
2500 */
2501struct ring_buffer_iter *
2502ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
2503{
2504 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04002505 struct ring_buffer_iter *iter;
Steven Rostedtd7690412008-10-01 00:29:53 -04002506 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002507
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302508 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002509 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002510
2511 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
2512 if (!iter)
Steven Rostedt8aabee52009-03-12 13:13:49 -04002513 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002514
2515 cpu_buffer = buffer->buffers[cpu];
2516
2517 iter->cpu_buffer = cpu_buffer;
2518
2519 atomic_inc(&cpu_buffer->record_disabled);
2520 synchronize_sched();
2521
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002522 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002523 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt642edba2008-11-12 00:01:26 -05002524 rb_iter_reset(iter);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002525 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002526 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002527
2528 return iter;
2529}
Robert Richterc4f50182008-12-11 16:49:22 +01002530EXPORT_SYMBOL_GPL(ring_buffer_read_start);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002531
2532/**
2533 * ring_buffer_finish - finish reading the iterator of the buffer
2534 * @iter: The iterator retrieved by ring_buffer_start
2535 *
2536 * This re-enables the recording to the buffer, and frees the
2537 * iterator.
2538 */
2539void
2540ring_buffer_read_finish(struct ring_buffer_iter *iter)
2541{
2542 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2543
2544 atomic_dec(&cpu_buffer->record_disabled);
2545 kfree(iter);
2546}
Robert Richterc4f50182008-12-11 16:49:22 +01002547EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002548
2549/**
2550 * ring_buffer_read - read the next item in the ring buffer by the iterator
2551 * @iter: The ring buffer iterator
2552 * @ts: The time stamp of the event read.
2553 *
2554 * This reads the next event in the ring buffer and increments the iterator.
2555 */
2556struct ring_buffer_event *
2557ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
2558{
2559 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002560 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2561 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002562
Tom Zanussi2d622712009-03-22 03:30:49 -05002563 again:
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002564 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2565 event = rb_iter_peek(iter, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002566 if (!event)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002567 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002568
2569 rb_advance_iter(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002570 out:
2571 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002572
Tom Zanussi2d622712009-03-22 03:30:49 -05002573 if (event && event->type == RINGBUF_TYPE_PADDING) {
2574 cpu_relax();
2575 goto again;
2576 }
2577
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002578 return event;
2579}
Robert Richterc4f50182008-12-11 16:49:22 +01002580EXPORT_SYMBOL_GPL(ring_buffer_read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002581
2582/**
2583 * ring_buffer_size - return the size of the ring buffer (in bytes)
2584 * @buffer: The ring buffer.
2585 */
2586unsigned long ring_buffer_size(struct ring_buffer *buffer)
2587{
2588 return BUF_PAGE_SIZE * buffer->pages;
2589}
Robert Richterc4f50182008-12-11 16:49:22 +01002590EXPORT_SYMBOL_GPL(ring_buffer_size);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002591
2592static void
2593rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
2594{
2595 cpu_buffer->head_page
2596 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002597 local_set(&cpu_buffer->head_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002598 local_set(&cpu_buffer->head_page->page->commit, 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002599
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002600 cpu_buffer->head_page->read = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002601
2602 cpu_buffer->tail_page = cpu_buffer->head_page;
2603 cpu_buffer->commit_page = cpu_buffer->head_page;
2604
2605 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
2606 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002607 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002608 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04002609
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002610 cpu_buffer->overrun = 0;
2611 cpu_buffer->entries = 0;
Steven Rostedt69507c02009-01-21 18:45:57 -05002612
2613 cpu_buffer->write_stamp = 0;
2614 cpu_buffer->read_stamp = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002615}
2616
2617/**
2618 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
2619 * @buffer: The ring buffer to reset a per cpu buffer of
2620 * @cpu: The CPU buffer to be reset
2621 */
2622void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
2623{
2624 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2625 unsigned long flags;
2626
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302627 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002628 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002629
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002630 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2631
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002632 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002633
2634 rb_reset_cpu(cpu_buffer);
2635
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002636 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002637
2638 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002639}
Robert Richterc4f50182008-12-11 16:49:22 +01002640EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002641
2642/**
2643 * ring_buffer_reset - reset a ring buffer
2644 * @buffer: The ring buffer to reset all cpu buffers
2645 */
2646void ring_buffer_reset(struct ring_buffer *buffer)
2647{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002648 int cpu;
2649
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002650 for_each_buffer_cpu(buffer, cpu)
Steven Rostedtd7690412008-10-01 00:29:53 -04002651 ring_buffer_reset_cpu(buffer, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002652}
Robert Richterc4f50182008-12-11 16:49:22 +01002653EXPORT_SYMBOL_GPL(ring_buffer_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002654
2655/**
2656 * rind_buffer_empty - is the ring buffer empty?
2657 * @buffer: The ring buffer to test
2658 */
2659int ring_buffer_empty(struct ring_buffer *buffer)
2660{
2661 struct ring_buffer_per_cpu *cpu_buffer;
2662 int cpu;
2663
2664 /* yes this is racy, but if you don't like the race, lock the buffer */
2665 for_each_buffer_cpu(buffer, cpu) {
2666 cpu_buffer = buffer->buffers[cpu];
2667 if (!rb_per_cpu_empty(cpu_buffer))
2668 return 0;
2669 }
Steven Rostedt554f7862009-03-11 22:00:13 -04002670
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002671 return 1;
2672}
Robert Richterc4f50182008-12-11 16:49:22 +01002673EXPORT_SYMBOL_GPL(ring_buffer_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002674
2675/**
2676 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
2677 * @buffer: The ring buffer
2678 * @cpu: The CPU buffer to test
2679 */
2680int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
2681{
2682 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt8aabee52009-03-12 13:13:49 -04002683 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002684
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302685 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt8aabee52009-03-12 13:13:49 -04002686 return 1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002687
2688 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt554f7862009-03-11 22:00:13 -04002689 ret = rb_per_cpu_empty(cpu_buffer);
2690
Steven Rostedt554f7862009-03-11 22:00:13 -04002691
2692 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002693}
Robert Richterc4f50182008-12-11 16:49:22 +01002694EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002695
2696/**
2697 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
2698 * @buffer_a: One buffer to swap with
2699 * @buffer_b: The other buffer to swap with
2700 *
2701 * This function is useful for tracers that want to take a "snapshot"
2702 * of a CPU buffer and has another back up buffer lying around.
2703 * it is expected that the tracer handles the cpu buffer not being
2704 * used at the moment.
2705 */
2706int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
2707 struct ring_buffer *buffer_b, int cpu)
2708{
2709 struct ring_buffer_per_cpu *cpu_buffer_a;
2710 struct ring_buffer_per_cpu *cpu_buffer_b;
Steven Rostedt554f7862009-03-11 22:00:13 -04002711 int ret = -EINVAL;
2712
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302713 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
2714 !cpumask_test_cpu(cpu, buffer_b->cpumask))
Steven Rostedt554f7862009-03-11 22:00:13 -04002715 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002716
2717 /* At least make sure the two buffers are somewhat the same */
Lai Jiangshan6d102bc2008-12-17 17:48:23 +08002718 if (buffer_a->pages != buffer_b->pages)
Steven Rostedt554f7862009-03-11 22:00:13 -04002719 goto out;
2720
2721 ret = -EAGAIN;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002722
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002723 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedt554f7862009-03-11 22:00:13 -04002724 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002725
2726 if (atomic_read(&buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002727 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002728
2729 if (atomic_read(&buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002730 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002731
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002732 cpu_buffer_a = buffer_a->buffers[cpu];
2733 cpu_buffer_b = buffer_b->buffers[cpu];
2734
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002735 if (atomic_read(&cpu_buffer_a->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002736 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002737
2738 if (atomic_read(&cpu_buffer_b->record_disabled))
Steven Rostedt554f7862009-03-11 22:00:13 -04002739 goto out;
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002740
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002741 /*
2742 * We can't do a synchronize_sched here because this
2743 * function can be called in atomic context.
2744 * Normally this will be called from the same CPU as cpu.
2745 * If not it's up to the caller to protect this.
2746 */
2747 atomic_inc(&cpu_buffer_a->record_disabled);
2748 atomic_inc(&cpu_buffer_b->record_disabled);
2749
2750 buffer_a->buffers[cpu] = cpu_buffer_b;
2751 buffer_b->buffers[cpu] = cpu_buffer_a;
2752
2753 cpu_buffer_b->buffer = buffer_a;
2754 cpu_buffer_a->buffer = buffer_b;
2755
2756 atomic_dec(&cpu_buffer_a->record_disabled);
2757 atomic_dec(&cpu_buffer_b->record_disabled);
2758
Steven Rostedt554f7862009-03-11 22:00:13 -04002759 ret = 0;
2760out:
Steven Rostedt554f7862009-03-11 22:00:13 -04002761 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002762}
Robert Richterc4f50182008-12-11 16:49:22 +01002763EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002764
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002765static void rb_remove_entries(struct ring_buffer_per_cpu *cpu_buffer,
Lai Jiangshan667d2412009-02-09 14:21:17 +08002766 struct buffer_data_page *bpage,
2767 unsigned int offset)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002768{
2769 struct ring_buffer_event *event;
2770 unsigned long head;
2771
2772 __raw_spin_lock(&cpu_buffer->lock);
Lai Jiangshan667d2412009-02-09 14:21:17 +08002773 for (head = offset; head < local_read(&bpage->commit);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002774 head += rb_event_length(event)) {
2775
Steven Rostedt044fa782008-12-02 23:50:03 -05002776 event = __rb_data_page_index(bpage, head);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002777 if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
2778 return;
2779 /* Only count data entries */
2780 if (event->type != RINGBUF_TYPE_DATA)
2781 continue;
2782 cpu_buffer->entries--;
2783 }
2784 __raw_spin_unlock(&cpu_buffer->lock);
2785}
2786
2787/**
2788 * ring_buffer_alloc_read_page - allocate a page to read from buffer
2789 * @buffer: the buffer to allocate for.
2790 *
2791 * This function is used in conjunction with ring_buffer_read_page.
2792 * When reading a full page from the ring buffer, these functions
2793 * can be used to speed up the process. The calling function should
2794 * allocate a few pages first with this function. Then when it
2795 * needs to get pages from the ring buffer, it passes the result
2796 * of this function into ring_buffer_read_page, which will swap
2797 * the page that was allocated, with the read page of the buffer.
2798 *
2799 * Returns:
2800 * The page allocated, or NULL on error.
2801 */
2802void *ring_buffer_alloc_read_page(struct ring_buffer *buffer)
2803{
Steven Rostedt044fa782008-12-02 23:50:03 -05002804 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002805 unsigned long addr;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002806
2807 addr = __get_free_page(GFP_KERNEL);
2808 if (!addr)
2809 return NULL;
2810
Steven Rostedt044fa782008-12-02 23:50:03 -05002811 bpage = (void *)addr;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002812
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002813 rb_init_page(bpage);
2814
Steven Rostedt044fa782008-12-02 23:50:03 -05002815 return bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002816}
2817
2818/**
2819 * ring_buffer_free_read_page - free an allocated read page
2820 * @buffer: the buffer the page was allocate for
2821 * @data: the page to free
2822 *
2823 * Free a page allocated from ring_buffer_alloc_read_page.
2824 */
2825void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
2826{
2827 free_page((unsigned long)data);
2828}
2829
2830/**
2831 * ring_buffer_read_page - extract a page from the ring buffer
2832 * @buffer: buffer to extract from
2833 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002834 * @len: amount to extract
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002835 * @cpu: the cpu of the buffer to extract
2836 * @full: should the extraction only happen when the page is full.
2837 *
2838 * This function will pull out a page from the ring buffer and consume it.
2839 * @data_page must be the address of the variable that was returned
2840 * from ring_buffer_alloc_read_page. This is because the page might be used
2841 * to swap with a page in the ring buffer.
2842 *
2843 * for example:
Lai Jiangshanb85fa012009-02-09 14:21:14 +08002844 * rpage = ring_buffer_alloc_read_page(buffer);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002845 * if (!rpage)
2846 * return error;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002847 * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
Lai Jiangshan667d2412009-02-09 14:21:17 +08002848 * if (ret >= 0)
2849 * process_page(rpage, ret);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002850 *
2851 * When @full is set, the function will not return true unless
2852 * the writer is off the reader page.
2853 *
2854 * Note: it is up to the calling functions to handle sleeps and wakeups.
2855 * The ring buffer can be used anywhere in the kernel and can not
2856 * blindly call wake_up. The layer that uses the ring buffer must be
2857 * responsible for that.
2858 *
2859 * Returns:
Lai Jiangshan667d2412009-02-09 14:21:17 +08002860 * >=0 if data has been transferred, returns the offset of consumed data.
2861 * <0 if no data has been transferred.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002862 */
2863int ring_buffer_read_page(struct ring_buffer *buffer,
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002864 void **data_page, size_t len, int cpu, int full)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002865{
2866 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2867 struct ring_buffer_event *event;
Steven Rostedt044fa782008-12-02 23:50:03 -05002868 struct buffer_data_page *bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002869 struct buffer_page *reader;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002870 unsigned long flags;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002871 unsigned int commit;
Lai Jiangshan667d2412009-02-09 14:21:17 +08002872 unsigned int read;
Steven Rostedt4f3640f2009-03-03 23:52:42 -05002873 u64 save_timestamp;
Lai Jiangshan667d2412009-02-09 14:21:17 +08002874 int ret = -1;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002875
Steven Rostedt554f7862009-03-11 22:00:13 -04002876 if (!cpumask_test_cpu(cpu, buffer->cpumask))
2877 goto out;
2878
Steven Rostedt474d32b2009-03-03 19:51:40 -05002879 /*
2880 * If len is not big enough to hold the page header, then
2881 * we can not copy anything.
2882 */
2883 if (len <= BUF_PAGE_HDR_SIZE)
Steven Rostedt554f7862009-03-11 22:00:13 -04002884 goto out;
Steven Rostedt474d32b2009-03-03 19:51:40 -05002885
2886 len -= BUF_PAGE_HDR_SIZE;
2887
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002888 if (!data_page)
Steven Rostedt554f7862009-03-11 22:00:13 -04002889 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002890
Steven Rostedt044fa782008-12-02 23:50:03 -05002891 bpage = *data_page;
2892 if (!bpage)
Steven Rostedt554f7862009-03-11 22:00:13 -04002893 goto out;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002894
2895 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2896
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002897 reader = rb_get_reader_page(cpu_buffer);
2898 if (!reader)
Steven Rostedt554f7862009-03-11 22:00:13 -04002899 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002900
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002901 event = rb_reader_event(cpu_buffer);
Lai Jiangshan667d2412009-02-09 14:21:17 +08002902
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002903 read = reader->read;
2904 commit = rb_page_commit(reader);
2905
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002906 /*
Steven Rostedt474d32b2009-03-03 19:51:40 -05002907 * If this page has been partially read or
2908 * if len is not big enough to read the rest of the page or
2909 * a writer is still on the page, then
2910 * we must copy the data from the page to the buffer.
2911 * Otherwise, we can simply swap the page with the one passed in.
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002912 */
Steven Rostedt474d32b2009-03-03 19:51:40 -05002913 if (read || (len < (commit - read)) ||
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002914 cpu_buffer->reader_page == cpu_buffer->commit_page) {
Lai Jiangshan667d2412009-02-09 14:21:17 +08002915 struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
Steven Rostedt474d32b2009-03-03 19:51:40 -05002916 unsigned int rpos = read;
2917 unsigned int pos = 0;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002918 unsigned int size;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002919
2920 if (full)
Steven Rostedt554f7862009-03-11 22:00:13 -04002921 goto out_unlock;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002922
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002923 if (len > (commit - read))
2924 len = (commit - read);
2925
2926 size = rb_event_length(event);
2927
2928 if (len < size)
Steven Rostedt554f7862009-03-11 22:00:13 -04002929 goto out_unlock;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002930
Steven Rostedt4f3640f2009-03-03 23:52:42 -05002931 /* save the current timestamp, since the user will need it */
2932 save_timestamp = cpu_buffer->read_stamp;
2933
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002934 /* Need to copy one event at a time */
2935 do {
Steven Rostedt474d32b2009-03-03 19:51:40 -05002936 memcpy(bpage->data + pos, rpage->data + rpos, size);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002937
2938 len -= size;
2939
2940 rb_advance_reader(cpu_buffer);
Steven Rostedt474d32b2009-03-03 19:51:40 -05002941 rpos = reader->read;
2942 pos += size;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002943
2944 event = rb_reader_event(cpu_buffer);
2945 size = rb_event_length(event);
2946 } while (len > size);
Lai Jiangshan667d2412009-02-09 14:21:17 +08002947
2948 /* update bpage */
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002949 local_set(&bpage->commit, pos);
Steven Rostedt4f3640f2009-03-03 23:52:42 -05002950 bpage->time_stamp = save_timestamp;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002951
Steven Rostedt474d32b2009-03-03 19:51:40 -05002952 /* we copied everything to the beginning */
2953 read = 0;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002954 } else {
2955 /* swap the pages */
Steven Rostedt044fa782008-12-02 23:50:03 -05002956 rb_init_page(bpage);
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002957 bpage = reader->page;
2958 reader->page = *data_page;
2959 local_set(&reader->write, 0);
2960 reader->read = 0;
Steven Rostedt044fa782008-12-02 23:50:03 -05002961 *data_page = bpage;
Steven Rostedtef7a4a12009-03-03 00:27:49 -05002962
2963 /* update the entry counter */
2964 rb_remove_entries(cpu_buffer, bpage, read);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002965 }
Lai Jiangshan667d2412009-02-09 14:21:17 +08002966 ret = read;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002967
Steven Rostedt554f7862009-03-11 22:00:13 -04002968 out_unlock:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002969 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2970
Steven Rostedt554f7862009-03-11 22:00:13 -04002971 out:
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002972 return ret;
2973}
2974
Steven Rostedta3583242008-11-11 15:01:42 -05002975static ssize_t
2976rb_simple_read(struct file *filp, char __user *ubuf,
2977 size_t cnt, loff_t *ppos)
2978{
Hannes Eder5e398412009-02-10 19:44:34 +01002979 unsigned long *p = filp->private_data;
Steven Rostedta3583242008-11-11 15:01:42 -05002980 char buf[64];
2981 int r;
2982
Steven Rostedt033601a2008-11-21 12:41:55 -05002983 if (test_bit(RB_BUFFERS_DISABLED_BIT, p))
2984 r = sprintf(buf, "permanently disabled\n");
2985 else
2986 r = sprintf(buf, "%d\n", test_bit(RB_BUFFERS_ON_BIT, p));
Steven Rostedta3583242008-11-11 15:01:42 -05002987
2988 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
2989}
2990
2991static ssize_t
2992rb_simple_write(struct file *filp, const char __user *ubuf,
2993 size_t cnt, loff_t *ppos)
2994{
Hannes Eder5e398412009-02-10 19:44:34 +01002995 unsigned long *p = filp->private_data;
Steven Rostedta3583242008-11-11 15:01:42 -05002996 char buf[64];
Hannes Eder5e398412009-02-10 19:44:34 +01002997 unsigned long val;
Steven Rostedta3583242008-11-11 15:01:42 -05002998 int ret;
2999
3000 if (cnt >= sizeof(buf))
3001 return -EINVAL;
3002
3003 if (copy_from_user(&buf, ubuf, cnt))
3004 return -EFAULT;
3005
3006 buf[cnt] = 0;
3007
3008 ret = strict_strtoul(buf, 10, &val);
3009 if (ret < 0)
3010 return ret;
3011
Steven Rostedt033601a2008-11-21 12:41:55 -05003012 if (val)
3013 set_bit(RB_BUFFERS_ON_BIT, p);
3014 else
3015 clear_bit(RB_BUFFERS_ON_BIT, p);
Steven Rostedta3583242008-11-11 15:01:42 -05003016
3017 (*ppos)++;
3018
3019 return cnt;
3020}
3021
Steven Rostedt5e2336a2009-03-05 21:44:55 -05003022static const struct file_operations rb_simple_fops = {
Steven Rostedta3583242008-11-11 15:01:42 -05003023 .open = tracing_open_generic,
3024 .read = rb_simple_read,
3025 .write = rb_simple_write,
3026};
3027
3028
3029static __init int rb_init_debugfs(void)
3030{
3031 struct dentry *d_tracer;
Steven Rostedta3583242008-11-11 15:01:42 -05003032
3033 d_tracer = tracing_init_dentry();
3034
Frederic Weisbecker5452af62009-03-27 00:25:38 +01003035 trace_create_file("tracing_on", 0644, d_tracer,
3036 &ring_buffer_flags, &rb_simple_fops);
Steven Rostedta3583242008-11-11 15:01:42 -05003037
3038 return 0;
3039}
3040
3041fs_initcall(rb_init_debugfs);
Steven Rostedt554f7862009-03-11 22:00:13 -04003042
Steven Rostedt59222ef2009-03-12 11:46:03 -04003043#ifdef CONFIG_HOTPLUG_CPU
Frederic Weisbecker09c9e842009-03-21 04:33:36 +01003044static int rb_cpu_notify(struct notifier_block *self,
3045 unsigned long action, void *hcpu)
Steven Rostedt554f7862009-03-11 22:00:13 -04003046{
3047 struct ring_buffer *buffer =
3048 container_of(self, struct ring_buffer, cpu_notify);
3049 long cpu = (long)hcpu;
3050
3051 switch (action) {
3052 case CPU_UP_PREPARE:
3053 case CPU_UP_PREPARE_FROZEN:
3054 if (cpu_isset(cpu, *buffer->cpumask))
3055 return NOTIFY_OK;
3056
3057 buffer->buffers[cpu] =
3058 rb_allocate_cpu_buffer(buffer, cpu);
3059 if (!buffer->buffers[cpu]) {
3060 WARN(1, "failed to allocate ring buffer on CPU %ld\n",
3061 cpu);
3062 return NOTIFY_OK;
3063 }
3064 smp_wmb();
3065 cpu_set(cpu, *buffer->cpumask);
3066 break;
3067 case CPU_DOWN_PREPARE:
3068 case CPU_DOWN_PREPARE_FROZEN:
3069 /*
3070 * Do nothing.
3071 * If we were to free the buffer, then the user would
3072 * lose any trace that was in the buffer.
3073 */
3074 break;
3075 default:
3076 break;
3077 }
3078 return NOTIFY_OK;
3079}
3080#endif