blob: aee76b3eeed2862de000f9fdc8ecbf9b30825788 [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>
7#include <linux/spinlock.h>
8#include <linux/debugfs.h>
9#include <linux/uaccess.h>
10#include <linux/module.h>
11#include <linux/percpu.h>
12#include <linux/mutex.h>
13#include <linux/sched.h> /* used for sched_clock() (for now) */
14#include <linux/init.h>
15#include <linux/hash.h>
16#include <linux/list.h>
17#include <linux/fs.h>
18
Steven Rostedt182e9f52008-11-03 23:15:56 -050019#include "trace.h"
20
Steven Rostedt033601a2008-11-21 12:41:55 -050021/*
22 * A fast way to enable or disable all ring buffers is to
23 * call tracing_on or tracing_off. Turning off the ring buffers
24 * prevents all ring buffers from being recorded to.
25 * Turning this switch on, makes it OK to write to the
26 * ring buffer, if the ring buffer is enabled itself.
27 *
28 * There's three layers that must be on in order to write
29 * to the ring buffer.
30 *
31 * 1) This global flag must be set.
32 * 2) The ring buffer must be enabled for recording.
33 * 3) The per cpu buffer must be enabled for recording.
34 *
35 * In case of an anomaly, this global flag has a bit set that
36 * will permantly disable all ring buffers.
37 */
38
39/*
40 * Global flag to disable all recording to ring buffers
41 * This has two bits: ON, DISABLED
42 *
43 * ON DISABLED
44 * ---- ----------
45 * 0 0 : ring buffers are off
46 * 1 0 : ring buffers are on
47 * X 1 : ring buffers are permanently disabled
48 */
49
50enum {
51 RB_BUFFERS_ON_BIT = 0,
52 RB_BUFFERS_DISABLED_BIT = 1,
53};
54
55enum {
56 RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
57 RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
58};
59
60static long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
Steven Rostedta3583242008-11-11 15:01:42 -050061
62/**
63 * tracing_on - enable all tracing buffers
64 *
65 * This function enables all tracing buffers that may have been
66 * disabled with tracing_off.
67 */
68void tracing_on(void)
69{
Steven Rostedt033601a2008-11-21 12:41:55 -050070 set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -050071}
Robert Richterc4f50182008-12-11 16:49:22 +010072EXPORT_SYMBOL_GPL(tracing_on);
Steven Rostedta3583242008-11-11 15:01:42 -050073
74/**
75 * tracing_off - turn off all tracing buffers
76 *
77 * This function stops all tracing buffers from recording data.
78 * It does not disable any overhead the tracers themselves may
79 * be causing. This function simply causes all recording to
80 * the ring buffers to fail.
81 */
82void tracing_off(void)
83{
Steven Rostedt033601a2008-11-21 12:41:55 -050084 clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
85}
Robert Richterc4f50182008-12-11 16:49:22 +010086EXPORT_SYMBOL_GPL(tracing_off);
Steven Rostedt033601a2008-11-21 12:41:55 -050087
88/**
89 * tracing_off_permanent - permanently disable ring buffers
90 *
91 * This function, once called, will disable all ring buffers
92 * permanenty.
93 */
94void tracing_off_permanent(void)
95{
96 set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
Steven Rostedta3583242008-11-11 15:01:42 -050097}
98
Ingo Molnard06bbd62008-11-12 10:11:37 +010099#include "trace.h"
100
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400101/* Up this if you want to test the TIME_EXTENTS and normalization */
102#define DEBUG_SHIFT 0
103
104/* FIXME!!! */
105u64 ring_buffer_time_stamp(int cpu)
106{
Steven Rostedt47e74f22008-11-12 00:01:27 -0500107 u64 time;
108
109 preempt_disable_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400110 /* shift to debug/test normalization and TIME_EXTENTS */
Steven Rostedt47e74f22008-11-12 00:01:27 -0500111 time = sched_clock() << DEBUG_SHIFT;
Frederic Weisbecker2c2d7322008-12-16 22:08:58 +0100112 preempt_enable_no_resched_notrace();
Steven Rostedt47e74f22008-11-12 00:01:27 -0500113
114 return time;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400115}
Robert Richterc4f50182008-12-11 16:49:22 +0100116EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400117
118void ring_buffer_normalize_time_stamp(int cpu, u64 *ts)
119{
120 /* Just stupid testing the normalize function and deltas */
121 *ts >>= DEBUG_SHIFT;
122}
Robert Richterc4f50182008-12-11 16:49:22 +0100123EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400124
125#define RB_EVNT_HDR_SIZE (sizeof(struct ring_buffer_event))
Andrew Morton67d34722009-01-09 12:27:09 -0800126#define RB_ALIGNMENT 4U
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400127#define RB_MAX_SMALL_DATA 28
128
129enum {
130 RB_LEN_TIME_EXTEND = 8,
131 RB_LEN_TIME_STAMP = 16,
132};
133
134/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800135static unsigned
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400136rb_event_length(struct ring_buffer_event *event)
137{
138 unsigned length;
139
140 switch (event->type) {
141 case RINGBUF_TYPE_PADDING:
142 /* undefined */
143 return -1;
144
145 case RINGBUF_TYPE_TIME_EXTEND:
146 return RB_LEN_TIME_EXTEND;
147
148 case RINGBUF_TYPE_TIME_STAMP:
149 return RB_LEN_TIME_STAMP;
150
151 case RINGBUF_TYPE_DATA:
152 if (event->len)
Andrew Morton67d34722009-01-09 12:27:09 -0800153 length = event->len * RB_ALIGNMENT;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400154 else
155 length = event->array[0];
156 return length + RB_EVNT_HDR_SIZE;
157 default:
158 BUG();
159 }
160 /* not hit */
161 return 0;
162}
163
164/**
165 * ring_buffer_event_length - return the length of the event
166 * @event: the event to get the length of
167 */
168unsigned ring_buffer_event_length(struct ring_buffer_event *event)
169{
Robert Richter465634a2009-01-07 15:32:11 +0100170 unsigned length = rb_event_length(event);
171 if (event->type != RINGBUF_TYPE_DATA)
172 return length;
173 length -= RB_EVNT_HDR_SIZE;
174 if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
175 length -= sizeof(event->array[0]);
176 return length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400177}
Robert Richterc4f50182008-12-11 16:49:22 +0100178EXPORT_SYMBOL_GPL(ring_buffer_event_length);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400179
180/* inline for ring buffer fast paths */
Andrew Morton34a148b2009-01-09 12:27:09 -0800181static void *
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400182rb_event_data(struct ring_buffer_event *event)
183{
184 BUG_ON(event->type != RINGBUF_TYPE_DATA);
185 /* If length is in len field, then array[0] has the data */
186 if (event->len)
187 return (void *)&event->array[0];
188 /* Otherwise length is in array[0] and array[1] has the data */
189 return (void *)&event->array[1];
190}
191
192/**
193 * ring_buffer_event_data - return the data of the event
194 * @event: the event to get the data from
195 */
196void *ring_buffer_event_data(struct ring_buffer_event *event)
197{
198 return rb_event_data(event);
199}
Robert Richterc4f50182008-12-11 16:49:22 +0100200EXPORT_SYMBOL_GPL(ring_buffer_event_data);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400201
202#define for_each_buffer_cpu(buffer, cpu) \
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030203 for_each_cpu(cpu, buffer->cpumask)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400204
205#define TS_SHIFT 27
206#define TS_MASK ((1ULL << TS_SHIFT) - 1)
207#define TS_DELTA_TEST (~TS_MASK)
208
Steven Rostedtabc9b562008-12-02 15:34:06 -0500209struct buffer_data_page {
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400210 u64 time_stamp; /* page time stamp */
Steven Rostedtbf41a152008-10-04 02:00:59 -0400211 local_t commit; /* write commited index */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500212 unsigned char data[]; /* data of buffer page */
213};
214
215struct buffer_page {
216 local_t write; /* index for next write */
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400217 unsigned read; /* index for next read */
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400218 struct list_head list; /* list of free pages */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500219 struct buffer_data_page *page; /* Actual data page */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400220};
221
Steven Rostedt044fa782008-12-02 23:50:03 -0500222static void rb_init_page(struct buffer_data_page *bpage)
Steven Rostedtabc9b562008-12-02 15:34:06 -0500223{
Steven Rostedt044fa782008-12-02 23:50:03 -0500224 local_set(&bpage->commit, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500225}
226
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400227/*
Steven Rostedted568292008-09-29 23:02:40 -0400228 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
229 * this issue out.
230 */
Andrew Morton34a148b2009-01-09 12:27:09 -0800231static void free_buffer_page(struct buffer_page *bpage)
Steven Rostedted568292008-09-29 23:02:40 -0400232{
Andrew Morton34a148b2009-01-09 12:27:09 -0800233 free_page((unsigned long)bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400234 kfree(bpage);
Steven Rostedted568292008-09-29 23:02:40 -0400235}
236
237/*
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400238 * We need to fit the time_stamp delta into 27 bits.
239 */
240static inline int test_time_stamp(u64 delta)
241{
242 if (delta & TS_DELTA_TEST)
243 return 1;
244 return 0;
245}
246
Steven Rostedt082605d2009-01-19 14:32:51 -0500247#define BUF_PAGE_SIZE (PAGE_SIZE - offsetof(struct buffer_data_page, data))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400248
249/*
250 * head_page == tail_page && head == tail then buffer is empty.
251 */
252struct ring_buffer_per_cpu {
253 int cpu;
254 struct ring_buffer *buffer;
Steven Rostedtf83c9d02008-11-11 18:47:44 +0100255 spinlock_t reader_lock; /* serialize readers */
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500256 raw_spinlock_t lock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400257 struct lock_class_key lock_key;
258 struct list_head pages;
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400259 struct buffer_page *head_page; /* read from head */
260 struct buffer_page *tail_page; /* write to tail */
Steven Rostedtbf41a152008-10-04 02:00:59 -0400261 struct buffer_page *commit_page; /* commited pages */
Steven Rostedtd7690412008-10-01 00:29:53 -0400262 struct buffer_page *reader_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400263 unsigned long overrun;
264 unsigned long entries;
265 u64 write_stamp;
266 u64 read_stamp;
267 atomic_t record_disabled;
268};
269
270struct ring_buffer {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400271 unsigned pages;
272 unsigned flags;
273 int cpus;
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030274 cpumask_var_t cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400275 atomic_t record_disabled;
276
277 struct mutex mutex;
278
279 struct ring_buffer_per_cpu **buffers;
280};
281
282struct ring_buffer_iter {
283 struct ring_buffer_per_cpu *cpu_buffer;
284 unsigned long head;
285 struct buffer_page *head_page;
286 u64 read_stamp;
287};
288
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500289/* buffer may be either ring_buffer or ring_buffer_per_cpu */
Steven Rostedtbf41a152008-10-04 02:00:59 -0400290#define RB_WARN_ON(buffer, cond) \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500291 ({ \
292 int _____ret = unlikely(cond); \
293 if (_____ret) { \
Steven Rostedtbf41a152008-10-04 02:00:59 -0400294 atomic_inc(&buffer->record_disabled); \
295 WARN_ON(1); \
296 } \
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500297 _____ret; \
298 })
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500299
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400300/**
301 * check_pages - integrity check of buffer pages
302 * @cpu_buffer: CPU buffer with pages to test
303 *
304 * As a safty measure we check to make sure the data pages have not
305 * been corrupted.
306 */
307static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
308{
309 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500310 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400311
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500312 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
313 return -1;
314 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
315 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400316
Steven Rostedt044fa782008-12-02 23:50:03 -0500317 list_for_each_entry_safe(bpage, tmp, head, list) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500318 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500319 bpage->list.next->prev != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500320 return -1;
321 if (RB_WARN_ON(cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500322 bpage->list.prev->next != &bpage->list))
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500323 return -1;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400324 }
325
326 return 0;
327}
328
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400329static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
330 unsigned nr_pages)
331{
332 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500333 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400334 unsigned long addr;
335 LIST_HEAD(pages);
336 unsigned i;
337
338 for (i = 0; i < nr_pages; i++) {
Steven Rostedt044fa782008-12-02 23:50:03 -0500339 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedtaa1e0e3b2008-10-02 19:18:09 -0400340 GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500341 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400342 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500343 list_add(&bpage->list, &pages);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400344
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400345 addr = __get_free_page(GFP_KERNEL);
346 if (!addr)
347 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500348 bpage->page = (void *)addr;
349 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400350 }
351
352 list_splice(&pages, head);
353
354 rb_check_pages(cpu_buffer);
355
356 return 0;
357
358 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -0500359 list_for_each_entry_safe(bpage, tmp, &pages, list) {
360 list_del_init(&bpage->list);
361 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400362 }
363 return -ENOMEM;
364}
365
366static struct ring_buffer_per_cpu *
367rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
368{
369 struct ring_buffer_per_cpu *cpu_buffer;
Steven Rostedt044fa782008-12-02 23:50:03 -0500370 struct buffer_page *bpage;
Steven Rostedtd7690412008-10-01 00:29:53 -0400371 unsigned long addr;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400372 int ret;
373
374 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
375 GFP_KERNEL, cpu_to_node(cpu));
376 if (!cpu_buffer)
377 return NULL;
378
379 cpu_buffer->cpu = cpu;
380 cpu_buffer->buffer = buffer;
Steven Rostedtf83c9d02008-11-11 18:47:44 +0100381 spin_lock_init(&cpu_buffer->reader_lock);
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500382 cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400383 INIT_LIST_HEAD(&cpu_buffer->pages);
384
Steven Rostedt044fa782008-12-02 23:50:03 -0500385 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400386 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500387 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400388 goto fail_free_buffer;
389
Steven Rostedt044fa782008-12-02 23:50:03 -0500390 cpu_buffer->reader_page = bpage;
Steven Rostedtd7690412008-10-01 00:29:53 -0400391 addr = __get_free_page(GFP_KERNEL);
392 if (!addr)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400393 goto fail_free_reader;
Steven Rostedt044fa782008-12-02 23:50:03 -0500394 bpage->page = (void *)addr;
395 rb_init_page(bpage->page);
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400396
Steven Rostedtd7690412008-10-01 00:29:53 -0400397 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
Steven Rostedtd7690412008-10-01 00:29:53 -0400398
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400399 ret = rb_allocate_pages(cpu_buffer, buffer->pages);
400 if (ret < 0)
Steven Rostedtd7690412008-10-01 00:29:53 -0400401 goto fail_free_reader;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400402
403 cpu_buffer->head_page
404 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400405 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400406
407 return cpu_buffer;
408
Steven Rostedtd7690412008-10-01 00:29:53 -0400409 fail_free_reader:
410 free_buffer_page(cpu_buffer->reader_page);
411
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400412 fail_free_buffer:
413 kfree(cpu_buffer);
414 return NULL;
415}
416
417static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
418{
419 struct list_head *head = &cpu_buffer->pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500420 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400421
Steven Rostedtd7690412008-10-01 00:29:53 -0400422 list_del_init(&cpu_buffer->reader_page->list);
423 free_buffer_page(cpu_buffer->reader_page);
424
Steven Rostedt044fa782008-12-02 23:50:03 -0500425 list_for_each_entry_safe(bpage, tmp, head, list) {
426 list_del_init(&bpage->list);
427 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400428 }
429 kfree(cpu_buffer);
430}
431
Steven Rostedta7b13742008-09-29 23:02:39 -0400432/*
433 * Causes compile errors if the struct buffer_page gets bigger
434 * than the struct page.
435 */
436extern int ring_buffer_page_too_big(void);
437
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400438/**
439 * ring_buffer_alloc - allocate a new ring_buffer
Robert Richter68814b52008-11-24 12:24:12 +0100440 * @size: the size in bytes per cpu that is needed.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400441 * @flags: attributes to set for the ring buffer.
442 *
443 * Currently the only flag that is available is the RB_FL_OVERWRITE
444 * flag. This flag means that the buffer will overwrite old data
445 * when the buffer wraps. If this flag is not set, the buffer will
446 * drop data when the tail hits the head.
447 */
448struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
449{
450 struct ring_buffer *buffer;
451 int bsize;
452 int cpu;
453
Steven Rostedta7b13742008-09-29 23:02:39 -0400454 /* Paranoid! Optimizes out when all is well */
455 if (sizeof(struct buffer_page) > sizeof(struct page))
456 ring_buffer_page_too_big();
457
458
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400459 /* keep it in its own cache line */
460 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
461 GFP_KERNEL);
462 if (!buffer)
463 return NULL;
464
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030465 if (!alloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
466 goto fail_free_buffer;
467
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400468 buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
469 buffer->flags = flags;
470
471 /* need at least two pages */
472 if (buffer->pages == 1)
473 buffer->pages++;
474
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030475 cpumask_copy(buffer->cpumask, cpu_possible_mask);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400476 buffer->cpus = nr_cpu_ids;
477
478 bsize = sizeof(void *) * nr_cpu_ids;
479 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
480 GFP_KERNEL);
481 if (!buffer->buffers)
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030482 goto fail_free_cpumask;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400483
484 for_each_buffer_cpu(buffer, cpu) {
485 buffer->buffers[cpu] =
486 rb_allocate_cpu_buffer(buffer, cpu);
487 if (!buffer->buffers[cpu])
488 goto fail_free_buffers;
489 }
490
491 mutex_init(&buffer->mutex);
492
493 return buffer;
494
495 fail_free_buffers:
496 for_each_buffer_cpu(buffer, cpu) {
497 if (buffer->buffers[cpu])
498 rb_free_cpu_buffer(buffer->buffers[cpu]);
499 }
500 kfree(buffer->buffers);
501
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030502 fail_free_cpumask:
503 free_cpumask_var(buffer->cpumask);
504
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400505 fail_free_buffer:
506 kfree(buffer);
507 return NULL;
508}
Robert Richterc4f50182008-12-11 16:49:22 +0100509EXPORT_SYMBOL_GPL(ring_buffer_alloc);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400510
511/**
512 * ring_buffer_free - free a ring buffer.
513 * @buffer: the buffer to free.
514 */
515void
516ring_buffer_free(struct ring_buffer *buffer)
517{
518 int cpu;
519
520 for_each_buffer_cpu(buffer, cpu)
521 rb_free_cpu_buffer(buffer->buffers[cpu]);
522
Rusty Russell9e01c1b2009-01-01 10:12:22 +1030523 free_cpumask_var(buffer->cpumask);
524
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400525 kfree(buffer);
526}
Robert Richterc4f50182008-12-11 16:49:22 +0100527EXPORT_SYMBOL_GPL(ring_buffer_free);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400528
529static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
530
531static void
532rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
533{
Steven Rostedt044fa782008-12-02 23:50:03 -0500534 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400535 struct list_head *p;
536 unsigned i;
537
538 atomic_inc(&cpu_buffer->record_disabled);
539 synchronize_sched();
540
541 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500542 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
543 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400544 p = cpu_buffer->pages.next;
Steven Rostedt044fa782008-12-02 23:50:03 -0500545 bpage = list_entry(p, struct buffer_page, list);
546 list_del_init(&bpage->list);
547 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400548 }
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500549 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
550 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400551
552 rb_reset_cpu(cpu_buffer);
553
554 rb_check_pages(cpu_buffer);
555
556 atomic_dec(&cpu_buffer->record_disabled);
557
558}
559
560static void
561rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
562 struct list_head *pages, unsigned nr_pages)
563{
Steven Rostedt044fa782008-12-02 23:50:03 -0500564 struct buffer_page *bpage;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400565 struct list_head *p;
566 unsigned i;
567
568 atomic_inc(&cpu_buffer->record_disabled);
569 synchronize_sched();
570
571 for (i = 0; i < nr_pages; i++) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500572 if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
573 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400574 p = pages->next;
Steven Rostedt044fa782008-12-02 23:50:03 -0500575 bpage = list_entry(p, struct buffer_page, list);
576 list_del_init(&bpage->list);
577 list_add_tail(&bpage->list, &cpu_buffer->pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400578 }
579 rb_reset_cpu(cpu_buffer);
580
581 rb_check_pages(cpu_buffer);
582
583 atomic_dec(&cpu_buffer->record_disabled);
584}
585
586/**
587 * ring_buffer_resize - resize the ring buffer
588 * @buffer: the buffer to resize.
589 * @size: the new size.
590 *
591 * The tracer is responsible for making sure that the buffer is
592 * not being used while changing the size.
593 * Note: We may be able to change the above requirement by using
594 * RCU synchronizations.
595 *
596 * Minimum size is 2 * BUF_PAGE_SIZE.
597 *
598 * Returns -1 on failure.
599 */
600int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
601{
602 struct ring_buffer_per_cpu *cpu_buffer;
603 unsigned nr_pages, rm_pages, new_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500604 struct buffer_page *bpage, *tmp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400605 unsigned long buffer_size;
606 unsigned long addr;
607 LIST_HEAD(pages);
608 int i, cpu;
609
Ingo Molnaree51a1d2008-11-13 14:58:31 +0100610 /*
611 * Always succeed at resizing a non-existent buffer:
612 */
613 if (!buffer)
614 return size;
615
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400616 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
617 size *= BUF_PAGE_SIZE;
618 buffer_size = buffer->pages * BUF_PAGE_SIZE;
619
620 /* we need a minimum of two pages */
621 if (size < BUF_PAGE_SIZE * 2)
622 size = BUF_PAGE_SIZE * 2;
623
624 if (size == buffer_size)
625 return size;
626
627 mutex_lock(&buffer->mutex);
628
629 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
630
631 if (size < buffer_size) {
632
633 /* easy case, just free pages */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500634 if (RB_WARN_ON(buffer, nr_pages >= buffer->pages)) {
635 mutex_unlock(&buffer->mutex);
636 return -1;
637 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400638
639 rm_pages = buffer->pages - nr_pages;
640
641 for_each_buffer_cpu(buffer, cpu) {
642 cpu_buffer = buffer->buffers[cpu];
643 rb_remove_pages(cpu_buffer, rm_pages);
644 }
645 goto out;
646 }
647
648 /*
649 * This is a bit more difficult. We only want to add pages
650 * when we can allocate enough for all CPUs. We do this
651 * by allocating all the pages and storing them on a local
652 * link list. If we succeed in our allocation, then we
653 * add these pages to the cpu_buffers. Otherwise we just free
654 * them all and return -ENOMEM;
655 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500656 if (RB_WARN_ON(buffer, nr_pages <= buffer->pages)) {
657 mutex_unlock(&buffer->mutex);
658 return -1;
659 }
Steven Rostedtf536aaf2008-11-10 23:07:30 -0500660
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400661 new_pages = nr_pages - buffer->pages;
662
663 for_each_buffer_cpu(buffer, cpu) {
664 for (i = 0; i < new_pages; i++) {
Steven Rostedt044fa782008-12-02 23:50:03 -0500665 bpage = kzalloc_node(ALIGN(sizeof(*bpage),
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400666 cache_line_size()),
667 GFP_KERNEL, cpu_to_node(cpu));
Steven Rostedt044fa782008-12-02 23:50:03 -0500668 if (!bpage)
Steven Rostedte4c2ce82008-10-01 11:14:54 -0400669 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500670 list_add(&bpage->list, &pages);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400671 addr = __get_free_page(GFP_KERNEL);
672 if (!addr)
673 goto free_pages;
Steven Rostedt044fa782008-12-02 23:50:03 -0500674 bpage->page = (void *)addr;
675 rb_init_page(bpage->page);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400676 }
677 }
678
679 for_each_buffer_cpu(buffer, cpu) {
680 cpu_buffer = buffer->buffers[cpu];
681 rb_insert_pages(cpu_buffer, &pages, new_pages);
682 }
683
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500684 if (RB_WARN_ON(buffer, !list_empty(&pages))) {
685 mutex_unlock(&buffer->mutex);
686 return -1;
687 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400688
689 out:
690 buffer->pages = nr_pages;
691 mutex_unlock(&buffer->mutex);
692
693 return size;
694
695 free_pages:
Steven Rostedt044fa782008-12-02 23:50:03 -0500696 list_for_each_entry_safe(bpage, tmp, &pages, list) {
697 list_del_init(&bpage->list);
698 free_buffer_page(bpage);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400699 }
Vegard Nossum641d2f62008-11-18 19:22:13 +0100700 mutex_unlock(&buffer->mutex);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400701 return -ENOMEM;
702}
Robert Richterc4f50182008-12-11 16:49:22 +0100703EXPORT_SYMBOL_GPL(ring_buffer_resize);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400704
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400705static inline int rb_null_event(struct ring_buffer_event *event)
706{
707 return event->type == RINGBUF_TYPE_PADDING;
708}
709
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500710static inline void *
Steven Rostedt044fa782008-12-02 23:50:03 -0500711__rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500712{
Steven Rostedt044fa782008-12-02 23:50:03 -0500713 return bpage->data + index;
Steven Rostedt8789a9e2008-12-02 15:34:07 -0500714}
715
Steven Rostedt044fa782008-12-02 23:50:03 -0500716static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400717{
Steven Rostedt044fa782008-12-02 23:50:03 -0500718 return bpage->page->data + index;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400719}
720
721static inline struct ring_buffer_event *
Steven Rostedtd7690412008-10-01 00:29:53 -0400722rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400723{
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400724 return __rb_page_index(cpu_buffer->reader_page,
725 cpu_buffer->reader_page->read);
726}
727
728static inline struct ring_buffer_event *
729rb_head_event(struct ring_buffer_per_cpu *cpu_buffer)
730{
731 return __rb_page_index(cpu_buffer->head_page,
732 cpu_buffer->head_page->read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400733}
734
735static inline struct ring_buffer_event *
736rb_iter_head_event(struct ring_buffer_iter *iter)
737{
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400738 return __rb_page_index(iter->head_page, iter->head);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400739}
740
Steven Rostedtbf41a152008-10-04 02:00:59 -0400741static inline unsigned rb_page_write(struct buffer_page *bpage)
742{
743 return local_read(&bpage->write);
744}
745
746static inline unsigned rb_page_commit(struct buffer_page *bpage)
747{
Steven Rostedtabc9b562008-12-02 15:34:06 -0500748 return local_read(&bpage->page->commit);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400749}
750
751/* Size is determined by what has been commited */
752static inline unsigned rb_page_size(struct buffer_page *bpage)
753{
754 return rb_page_commit(bpage);
755}
756
757static inline unsigned
758rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
759{
760 return rb_page_commit(cpu_buffer->commit_page);
761}
762
763static inline unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
764{
765 return rb_page_commit(cpu_buffer->head_page);
766}
767
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400768/*
769 * When the tail hits the head and the buffer is in overwrite mode,
770 * the head jumps to the next page and all content on the previous
771 * page is discarded. But before doing so, we update the overrun
772 * variable of the buffer.
773 */
774static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
775{
776 struct ring_buffer_event *event;
777 unsigned long head;
778
779 for (head = 0; head < rb_head_size(cpu_buffer);
780 head += rb_event_length(event)) {
781
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400782 event = __rb_page_index(cpu_buffer->head_page, head);
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500783 if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
784 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400785 /* Only count data entries */
786 if (event->type != RINGBUF_TYPE_DATA)
787 continue;
788 cpu_buffer->overrun++;
789 cpu_buffer->entries--;
790 }
791}
792
793static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -0500794 struct buffer_page **bpage)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400795{
Steven Rostedt044fa782008-12-02 23:50:03 -0500796 struct list_head *p = (*bpage)->list.next;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400797
798 if (p == &cpu_buffer->pages)
799 p = p->next;
800
Steven Rostedt044fa782008-12-02 23:50:03 -0500801 *bpage = list_entry(p, struct buffer_page, list);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400802}
803
Steven Rostedtbf41a152008-10-04 02:00:59 -0400804static inline unsigned
805rb_event_index(struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400806{
Steven Rostedtbf41a152008-10-04 02:00:59 -0400807 unsigned long addr = (unsigned long)event;
808
809 return (addr & ~PAGE_MASK) - (PAGE_SIZE - BUF_PAGE_SIZE);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400810}
811
Andrew Morton34a148b2009-01-09 12:27:09 -0800812static int
Steven Rostedtbf41a152008-10-04 02:00:59 -0400813rb_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
814 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400815{
Steven Rostedtbf41a152008-10-04 02:00:59 -0400816 unsigned long addr = (unsigned long)event;
817 unsigned long index;
818
819 index = rb_event_index(event);
820 addr &= PAGE_MASK;
821
822 return cpu_buffer->commit_page->page == (void *)addr &&
823 rb_commit_index(cpu_buffer) == index;
824}
825
Andrew Morton34a148b2009-01-09 12:27:09 -0800826static void
Steven Rostedtbf41a152008-10-04 02:00:59 -0400827rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
828 struct ring_buffer_event *event)
829{
830 unsigned long addr = (unsigned long)event;
831 unsigned long index;
832
833 index = rb_event_index(event);
834 addr &= PAGE_MASK;
835
836 while (cpu_buffer->commit_page->page != (void *)addr) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -0500837 if (RB_WARN_ON(cpu_buffer,
838 cpu_buffer->commit_page == cpu_buffer->tail_page))
839 return;
Steven Rostedtabc9b562008-12-02 15:34:06 -0500840 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -0400841 cpu_buffer->commit_page->write;
842 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500843 cpu_buffer->write_stamp =
844 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -0400845 }
846
847 /* Now set the commit to the event's index */
Steven Rostedtabc9b562008-12-02 15:34:06 -0500848 local_set(&cpu_buffer->commit_page->page->commit, index);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400849}
850
Andrew Morton34a148b2009-01-09 12:27:09 -0800851static void
Steven Rostedtbf41a152008-10-04 02:00:59 -0400852rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
853{
854 /*
855 * We only race with interrupts and NMIs on this CPU.
856 * If we own the commit event, then we can commit
857 * all others that interrupted us, since the interruptions
858 * are in stack format (they finish before they come
859 * back to us). This allows us to do a simple loop to
860 * assign the commit to the tail.
861 */
Steven Rostedta8ccf1d2008-12-23 11:32:24 -0500862 again:
Steven Rostedtbf41a152008-10-04 02:00:59 -0400863 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
Steven Rostedtabc9b562008-12-02 15:34:06 -0500864 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -0400865 cpu_buffer->commit_page->write;
866 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
Steven Rostedtabc9b562008-12-02 15:34:06 -0500867 cpu_buffer->write_stamp =
868 cpu_buffer->commit_page->page->time_stamp;
Steven Rostedtbf41a152008-10-04 02:00:59 -0400869 /* add barrier to keep gcc from optimizing too much */
870 barrier();
871 }
872 while (rb_commit_index(cpu_buffer) !=
873 rb_page_write(cpu_buffer->commit_page)) {
Steven Rostedtabc9b562008-12-02 15:34:06 -0500874 cpu_buffer->commit_page->page->commit =
Steven Rostedtbf41a152008-10-04 02:00:59 -0400875 cpu_buffer->commit_page->write;
876 barrier();
877 }
Steven Rostedta8ccf1d2008-12-23 11:32:24 -0500878
879 /* again, keep gcc from optimizing */
880 barrier();
881
882 /*
883 * If an interrupt came in just after the first while loop
884 * and pushed the tail page forward, we will be left with
885 * a dangling commit that will never go forward.
886 */
887 if (unlikely(cpu_buffer->commit_page != cpu_buffer->tail_page))
888 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400889}
890
Steven Rostedtd7690412008-10-01 00:29:53 -0400891static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400892{
Steven Rostedtabc9b562008-12-02 15:34:06 -0500893 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
Steven Rostedt6f807ac2008-10-04 02:00:58 -0400894 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -0400895}
896
Andrew Morton34a148b2009-01-09 12:27:09 -0800897static void rb_inc_iter(struct ring_buffer_iter *iter)
Steven Rostedtd7690412008-10-01 00:29:53 -0400898{
899 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
900
901 /*
902 * The iterator could be on the reader page (it starts there).
903 * But the head could have moved, since the reader was
904 * found. Check for this case and assign the iterator
905 * to the head page instead of next.
906 */
907 if (iter->head_page == cpu_buffer->reader_page)
908 iter->head_page = cpu_buffer->head_page;
909 else
910 rb_inc_page(cpu_buffer, &iter->head_page);
911
Steven Rostedtabc9b562008-12-02 15:34:06 -0500912 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400913 iter->head = 0;
914}
915
916/**
917 * ring_buffer_update_event - update event type and data
918 * @event: the even to update
919 * @type: the type of event
920 * @length: the size of the event field in the ring buffer
921 *
922 * Update the type and data fields of the event. The length
923 * is the actual size that is written to the ring buffer,
924 * and with this, we can determine what to place into the
925 * data field.
926 */
Andrew Morton34a148b2009-01-09 12:27:09 -0800927static void
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400928rb_update_event(struct ring_buffer_event *event,
929 unsigned type, unsigned length)
930{
931 event->type = type;
932
933 switch (type) {
934
935 case RINGBUF_TYPE_PADDING:
936 break;
937
938 case RINGBUF_TYPE_TIME_EXTEND:
Andrew Morton67d34722009-01-09 12:27:09 -0800939 event->len = DIV_ROUND_UP(RB_LEN_TIME_EXTEND, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400940 break;
941
942 case RINGBUF_TYPE_TIME_STAMP:
Andrew Morton67d34722009-01-09 12:27:09 -0800943 event->len = DIV_ROUND_UP(RB_LEN_TIME_STAMP, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400944 break;
945
946 case RINGBUF_TYPE_DATA:
947 length -= RB_EVNT_HDR_SIZE;
948 if (length > RB_MAX_SMALL_DATA) {
949 event->len = 0;
950 event->array[0] = length;
951 } else
Andrew Morton67d34722009-01-09 12:27:09 -0800952 event->len = DIV_ROUND_UP(length, RB_ALIGNMENT);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400953 break;
954 default:
955 BUG();
956 }
957}
958
Andrew Morton34a148b2009-01-09 12:27:09 -0800959static unsigned rb_calculate_event_length(unsigned length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400960{
961 struct ring_buffer_event event; /* Used only for sizeof array */
962
963 /* zero length can cause confusions */
964 if (!length)
965 length = 1;
966
967 if (length > RB_MAX_SMALL_DATA)
968 length += sizeof(event.array[0]);
969
970 length += RB_EVNT_HDR_SIZE;
971 length = ALIGN(length, RB_ALIGNMENT);
972
973 return length;
974}
975
976static struct ring_buffer_event *
977__rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
978 unsigned type, unsigned long length, u64 *ts)
979{
Steven Rostedt98db8df2008-12-23 11:32:25 -0500980 struct buffer_page *tail_page, *head_page, *reader_page, *commit_page;
Steven Rostedtbf41a152008-10-04 02:00:59 -0400981 unsigned long tail, write;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400982 struct ring_buffer *buffer = cpu_buffer->buffer;
983 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -0400984 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400985
Steven Rostedt98db8df2008-12-23 11:32:25 -0500986 commit_page = cpu_buffer->commit_page;
987 /* we just need to protect against interrupts */
988 barrier();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400989 tail_page = cpu_buffer->tail_page;
Steven Rostedtbf41a152008-10-04 02:00:59 -0400990 write = local_add_return(length, &tail_page->write);
991 tail = write - length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400992
Steven Rostedtbf41a152008-10-04 02:00:59 -0400993 /* See if we shot pass the end of this buffer page */
994 if (write > BUF_PAGE_SIZE) {
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400995 struct buffer_page *next_page = tail_page;
996
Steven Rostedt3e03fb72008-11-06 00:09:43 -0500997 local_irq_save(flags);
998 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedtbf41a152008-10-04 02:00:59 -0400999
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001000 rb_inc_page(cpu_buffer, &next_page);
1001
Steven Rostedtd7690412008-10-01 00:29:53 -04001002 head_page = cpu_buffer->head_page;
1003 reader_page = cpu_buffer->reader_page;
1004
1005 /* we grabbed the lock before incrementing */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001006 if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
1007 goto out_unlock;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001008
1009 /*
1010 * If for some reason, we had an interrupt storm that made
1011 * it all the way around the buffer, bail, and warn
1012 * about it.
1013 */
Steven Rostedt98db8df2008-12-23 11:32:25 -05001014 if (unlikely(next_page == commit_page)) {
Steven Rostedtbf41a152008-10-04 02:00:59 -04001015 WARN_ON_ONCE(1);
1016 goto out_unlock;
1017 }
Steven Rostedtd7690412008-10-01 00:29:53 -04001018
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001019 if (next_page == head_page) {
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001020 if (!(buffer->flags & RB_FL_OVERWRITE))
Steven Rostedtbf41a152008-10-04 02:00:59 -04001021 goto out_unlock;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001022
Steven Rostedtbf41a152008-10-04 02:00:59 -04001023 /* tail_page has not moved yet? */
1024 if (tail_page == cpu_buffer->tail_page) {
1025 /* count overflows */
1026 rb_update_overflow(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001027
Steven Rostedtbf41a152008-10-04 02:00:59 -04001028 rb_inc_page(cpu_buffer, &head_page);
1029 cpu_buffer->head_page = head_page;
1030 cpu_buffer->head_page->read = 0;
1031 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001032 }
1033
Steven Rostedtbf41a152008-10-04 02:00:59 -04001034 /*
1035 * If the tail page is still the same as what we think
1036 * it is, then it is up to us to update the tail
1037 * pointer.
1038 */
1039 if (tail_page == cpu_buffer->tail_page) {
1040 local_set(&next_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001041 local_set(&next_page->page->commit, 0);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001042 cpu_buffer->tail_page = next_page;
1043
1044 /* reread the time stamp */
1045 *ts = ring_buffer_time_stamp(cpu_buffer->cpu);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001046 cpu_buffer->tail_page->page->time_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001047 }
1048
1049 /*
1050 * The actual tail page has moved forward.
1051 */
1052 if (tail < BUF_PAGE_SIZE) {
1053 /* Mark the rest of the page with padding */
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001054 event = __rb_page_index(tail_page, tail);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001055 event->type = RINGBUF_TYPE_PADDING;
1056 }
1057
Steven Rostedtbf41a152008-10-04 02:00:59 -04001058 if (tail <= BUF_PAGE_SIZE)
1059 /* Set the write back to the previous setting */
1060 local_set(&tail_page->write, tail);
1061
1062 /*
1063 * If this was a commit entry that failed,
1064 * increment that too
1065 */
1066 if (tail_page == cpu_buffer->commit_page &&
1067 tail == rb_commit_index(cpu_buffer)) {
1068 rb_set_commit_to_write(cpu_buffer);
1069 }
1070
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001071 __raw_spin_unlock(&cpu_buffer->lock);
1072 local_irq_restore(flags);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001073
1074 /* fail and let the caller try again */
1075 return ERR_PTR(-EAGAIN);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001076 }
1077
Steven Rostedtbf41a152008-10-04 02:00:59 -04001078 /* We reserved something on the buffer */
1079
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001080 if (RB_WARN_ON(cpu_buffer, write > BUF_PAGE_SIZE))
1081 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001082
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001083 event = __rb_page_index(tail_page, tail);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001084 rb_update_event(event, type, length);
1085
Steven Rostedtbf41a152008-10-04 02:00:59 -04001086 /*
1087 * If this is a commit and the tail is zero, then update
1088 * this page's time stamp.
1089 */
1090 if (!tail && rb_is_commit(cpu_buffer, event))
Steven Rostedtabc9b562008-12-02 15:34:06 -05001091 cpu_buffer->commit_page->page->time_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001092
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001093 return event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001094
1095 out_unlock:
Lai Jiangshan6f3b3442009-01-12 11:06:18 +08001096 /* reset write */
1097 if (tail <= BUF_PAGE_SIZE)
1098 local_set(&tail_page->write, tail);
1099
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001100 __raw_spin_unlock(&cpu_buffer->lock);
1101 local_irq_restore(flags);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001102 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001103}
1104
1105static int
1106rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
1107 u64 *ts, u64 *delta)
1108{
1109 struct ring_buffer_event *event;
1110 static int once;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001111 int ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001112
1113 if (unlikely(*delta > (1ULL << 59) && !once++)) {
1114 printk(KERN_WARNING "Delta way too big! %llu"
1115 " ts=%llu write stamp = %llu\n",
Stephen Rothwelle2862c92008-10-27 17:43:28 +11001116 (unsigned long long)*delta,
1117 (unsigned long long)*ts,
1118 (unsigned long long)cpu_buffer->write_stamp);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001119 WARN_ON(1);
1120 }
1121
1122 /*
1123 * The delta is too big, we to add a
1124 * new timestamp.
1125 */
1126 event = __rb_reserve_next(cpu_buffer,
1127 RINGBUF_TYPE_TIME_EXTEND,
1128 RB_LEN_TIME_EXTEND,
1129 ts);
1130 if (!event)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001131 return -EBUSY;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001132
Steven Rostedtbf41a152008-10-04 02:00:59 -04001133 if (PTR_ERR(event) == -EAGAIN)
1134 return -EAGAIN;
1135
1136 /* Only a commited time event can update the write stamp */
1137 if (rb_is_commit(cpu_buffer, event)) {
1138 /*
1139 * If this is the first on the page, then we need to
1140 * update the page itself, and just put in a zero.
1141 */
1142 if (rb_event_index(event)) {
1143 event->time_delta = *delta & TS_MASK;
1144 event->array[0] = *delta >> TS_SHIFT;
1145 } else {
Steven Rostedtabc9b562008-12-02 15:34:06 -05001146 cpu_buffer->commit_page->page->time_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001147 event->time_delta = 0;
1148 event->array[0] = 0;
1149 }
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001150 cpu_buffer->write_stamp = *ts;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001151 /* let the caller know this was the commit */
1152 ret = 1;
1153 } else {
1154 /* Darn, this is just wasted space */
1155 event->time_delta = 0;
1156 event->array[0] = 0;
1157 ret = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001158 }
1159
Steven Rostedtbf41a152008-10-04 02:00:59 -04001160 *delta = 0;
1161
1162 return ret;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001163}
1164
1165static struct ring_buffer_event *
1166rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
1167 unsigned type, unsigned long length)
1168{
1169 struct ring_buffer_event *event;
1170 u64 ts, delta;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001171 int commit = 0;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001172 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001173
Steven Rostedtbf41a152008-10-04 02:00:59 -04001174 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001175 /*
1176 * We allow for interrupts to reenter here and do a trace.
1177 * If one does, it will cause this original code to loop
1178 * back here. Even with heavy interrupts happening, this
1179 * should only happen a few times in a row. If this happens
1180 * 1000 times in a row, there must be either an interrupt
1181 * storm or we have something buggy.
1182 * Bail!
1183 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001184 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001185 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001186
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001187 ts = ring_buffer_time_stamp(cpu_buffer->cpu);
1188
Steven Rostedtbf41a152008-10-04 02:00:59 -04001189 /*
1190 * Only the first commit can update the timestamp.
1191 * Yes there is a race here. If an interrupt comes in
1192 * just after the conditional and it traces too, then it
1193 * will also check the deltas. More than one timestamp may
1194 * also be made. But only the entry that did the actual
1195 * commit will be something other than zero.
1196 */
1197 if (cpu_buffer->tail_page == cpu_buffer->commit_page &&
1198 rb_page_write(cpu_buffer->tail_page) ==
1199 rb_commit_index(cpu_buffer)) {
1200
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001201 delta = ts - cpu_buffer->write_stamp;
1202
Steven Rostedtbf41a152008-10-04 02:00:59 -04001203 /* make sure this delta is calculated here */
1204 barrier();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001205
Steven Rostedtbf41a152008-10-04 02:00:59 -04001206 /* Did the write stamp get updated already? */
1207 if (unlikely(ts < cpu_buffer->write_stamp))
Steven Rostedt4143c5c2008-11-10 21:46:01 -05001208 delta = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001209
1210 if (test_time_stamp(delta)) {
1211
1212 commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
1213
1214 if (commit == -EBUSY)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001215 return NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001216
1217 if (commit == -EAGAIN)
1218 goto again;
1219
1220 RB_WARN_ON(cpu_buffer, commit < 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001221 }
Steven Rostedtbf41a152008-10-04 02:00:59 -04001222 } else
1223 /* Non commits have zero deltas */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001224 delta = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001225
1226 event = __rb_reserve_next(cpu_buffer, type, length, &ts);
Steven Rostedtbf41a152008-10-04 02:00:59 -04001227 if (PTR_ERR(event) == -EAGAIN)
1228 goto again;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001229
Steven Rostedtbf41a152008-10-04 02:00:59 -04001230 if (!event) {
1231 if (unlikely(commit))
1232 /*
1233 * Ouch! We needed a timestamp and it was commited. But
1234 * we didn't get our event reserved.
1235 */
1236 rb_set_commit_to_write(cpu_buffer);
1237 return NULL;
1238 }
1239
1240 /*
1241 * If the timestamp was commited, make the commit our entry
1242 * now so that we will update it when needed.
1243 */
1244 if (commit)
1245 rb_set_commit_event(cpu_buffer, event);
1246 else if (!rb_is_commit(cpu_buffer, event))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001247 delta = 0;
1248
1249 event->time_delta = delta;
1250
1251 return event;
1252}
1253
Steven Rostedtbf41a152008-10-04 02:00:59 -04001254static DEFINE_PER_CPU(int, rb_need_resched);
1255
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001256/**
1257 * ring_buffer_lock_reserve - reserve a part of the buffer
1258 * @buffer: the ring buffer to reserve from
1259 * @length: the length of the data to reserve (excluding event header)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001260 *
1261 * Returns a reseverd event on the ring buffer to copy directly to.
1262 * The user of this interface will need to get the body to write into
1263 * and can use the ring_buffer_event_data() interface.
1264 *
1265 * The length is the length of the data needed, not the event length
1266 * which also includes the event header.
1267 *
1268 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
1269 * If NULL is returned, then nothing has been allocated or locked.
1270 */
1271struct ring_buffer_event *
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02001272ring_buffer_lock_reserve(struct ring_buffer *buffer, unsigned long length)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001273{
1274 struct ring_buffer_per_cpu *cpu_buffer;
1275 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001276 int cpu, resched;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001277
Steven Rostedt033601a2008-11-21 12:41:55 -05001278 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05001279 return NULL;
1280
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001281 if (atomic_read(&buffer->record_disabled))
1282 return NULL;
1283
Steven Rostedtbf41a152008-10-04 02:00:59 -04001284 /* If we are tracing schedule, we don't want to recurse */
Steven Rostedt182e9f52008-11-03 23:15:56 -05001285 resched = ftrace_preempt_disable();
Steven Rostedtbf41a152008-10-04 02:00:59 -04001286
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001287 cpu = raw_smp_processor_id();
1288
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301289 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04001290 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001291
1292 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001293
1294 if (atomic_read(&cpu_buffer->record_disabled))
Steven Rostedtd7690412008-10-01 00:29:53 -04001295 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001296
1297 length = rb_calculate_event_length(length);
1298 if (length > BUF_PAGE_SIZE)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001299 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001300
1301 event = rb_reserve_next_event(cpu_buffer, RINGBUF_TYPE_DATA, length);
1302 if (!event)
Steven Rostedtd7690412008-10-01 00:29:53 -04001303 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001304
Steven Rostedtbf41a152008-10-04 02:00:59 -04001305 /*
1306 * Need to store resched state on this cpu.
1307 * Only the first needs to.
1308 */
1309
1310 if (preempt_count() == 1)
1311 per_cpu(rb_need_resched, cpu) = resched;
1312
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001313 return event;
1314
Steven Rostedtd7690412008-10-01 00:29:53 -04001315 out:
Steven Rostedt182e9f52008-11-03 23:15:56 -05001316 ftrace_preempt_enable(resched);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001317 return NULL;
1318}
Robert Richterc4f50182008-12-11 16:49:22 +01001319EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001320
1321static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
1322 struct ring_buffer_event *event)
1323{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001324 cpu_buffer->entries++;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001325
1326 /* Only process further if we own the commit */
1327 if (!rb_is_commit(cpu_buffer, event))
1328 return;
1329
1330 cpu_buffer->write_stamp += event->time_delta;
1331
1332 rb_set_commit_to_write(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001333}
1334
1335/**
1336 * ring_buffer_unlock_commit - commit a reserved
1337 * @buffer: The buffer to commit to
1338 * @event: The event pointer to commit.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001339 *
1340 * This commits the data to the ring buffer, and releases any locks held.
1341 *
1342 * Must be paired with ring_buffer_lock_reserve.
1343 */
1344int ring_buffer_unlock_commit(struct ring_buffer *buffer,
Arnaldo Carvalho de Melo0a987752009-02-05 16:12:56 -02001345 struct ring_buffer_event *event)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001346{
1347 struct ring_buffer_per_cpu *cpu_buffer;
1348 int cpu = raw_smp_processor_id();
1349
1350 cpu_buffer = buffer->buffers[cpu];
1351
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001352 rb_commit(cpu_buffer, event);
1353
Steven Rostedtbf41a152008-10-04 02:00:59 -04001354 /*
1355 * Only the last preempt count needs to restore preemption.
1356 */
Steven Rostedt182e9f52008-11-03 23:15:56 -05001357 if (preempt_count() == 1)
1358 ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
1359 else
Steven Rostedtbf41a152008-10-04 02:00:59 -04001360 preempt_enable_no_resched_notrace();
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001361
1362 return 0;
1363}
Robert Richterc4f50182008-12-11 16:49:22 +01001364EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001365
1366/**
1367 * ring_buffer_write - write data to the buffer without reserving
1368 * @buffer: The ring buffer to write to.
1369 * @length: The length of the data being written (excluding the event header)
1370 * @data: The data to write to the buffer.
1371 *
1372 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
1373 * one function. If you already have the data to write to the buffer, it
1374 * may be easier to simply call this function.
1375 *
1376 * Note, like ring_buffer_lock_reserve, the length is the length of the data
1377 * and not the length of the event which would hold the header.
1378 */
1379int ring_buffer_write(struct ring_buffer *buffer,
1380 unsigned long length,
1381 void *data)
1382{
1383 struct ring_buffer_per_cpu *cpu_buffer;
1384 struct ring_buffer_event *event;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001385 unsigned long event_length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001386 void *body;
1387 int ret = -EBUSY;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001388 int cpu, resched;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001389
Steven Rostedt033601a2008-11-21 12:41:55 -05001390 if (ring_buffer_flags != RB_BUFFERS_ON)
Steven Rostedta3583242008-11-11 15:01:42 -05001391 return -EBUSY;
1392
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001393 if (atomic_read(&buffer->record_disabled))
1394 return -EBUSY;
1395
Steven Rostedt182e9f52008-11-03 23:15:56 -05001396 resched = ftrace_preempt_disable();
Steven Rostedtbf41a152008-10-04 02:00:59 -04001397
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001398 cpu = raw_smp_processor_id();
1399
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301400 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedtd7690412008-10-01 00:29:53 -04001401 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001402
1403 cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001404
1405 if (atomic_read(&cpu_buffer->record_disabled))
1406 goto out;
1407
1408 event_length = rb_calculate_event_length(length);
1409 event = rb_reserve_next_event(cpu_buffer,
1410 RINGBUF_TYPE_DATA, event_length);
1411 if (!event)
1412 goto out;
1413
1414 body = rb_event_data(event);
1415
1416 memcpy(body, data, length);
1417
1418 rb_commit(cpu_buffer, event);
1419
1420 ret = 0;
1421 out:
Steven Rostedt182e9f52008-11-03 23:15:56 -05001422 ftrace_preempt_enable(resched);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001423
1424 return ret;
1425}
Robert Richterc4f50182008-12-11 16:49:22 +01001426EXPORT_SYMBOL_GPL(ring_buffer_write);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001427
Andrew Morton34a148b2009-01-09 12:27:09 -08001428static int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedtbf41a152008-10-04 02:00:59 -04001429{
1430 struct buffer_page *reader = cpu_buffer->reader_page;
1431 struct buffer_page *head = cpu_buffer->head_page;
1432 struct buffer_page *commit = cpu_buffer->commit_page;
1433
1434 return reader->read == rb_page_commit(reader) &&
1435 (commit == reader ||
1436 (commit == head &&
1437 head->read == rb_page_commit(commit)));
1438}
1439
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001440/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001441 * ring_buffer_record_disable - stop all writes into the buffer
1442 * @buffer: The ring buffer to stop writes to.
1443 *
1444 * This prevents all writes to the buffer. Any attempt to write
1445 * to the buffer after this will fail and return NULL.
1446 *
1447 * The caller should call synchronize_sched() after this.
1448 */
1449void ring_buffer_record_disable(struct ring_buffer *buffer)
1450{
1451 atomic_inc(&buffer->record_disabled);
1452}
Robert Richterc4f50182008-12-11 16:49:22 +01001453EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001454
1455/**
1456 * ring_buffer_record_enable - enable writes to the buffer
1457 * @buffer: The ring buffer to enable writes
1458 *
1459 * Note, multiple disables will need the same number of enables
1460 * to truely enable the writing (much like preempt_disable).
1461 */
1462void ring_buffer_record_enable(struct ring_buffer *buffer)
1463{
1464 atomic_dec(&buffer->record_disabled);
1465}
Robert Richterc4f50182008-12-11 16:49:22 +01001466EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001467
1468/**
1469 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
1470 * @buffer: The ring buffer to stop writes to.
1471 * @cpu: The CPU buffer to stop
1472 *
1473 * This prevents all writes to the buffer. Any attempt to write
1474 * to the buffer after this will fail and return NULL.
1475 *
1476 * The caller should call synchronize_sched() after this.
1477 */
1478void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
1479{
1480 struct ring_buffer_per_cpu *cpu_buffer;
1481
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301482 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001483 return;
1484
1485 cpu_buffer = buffer->buffers[cpu];
1486 atomic_inc(&cpu_buffer->record_disabled);
1487}
Robert Richterc4f50182008-12-11 16:49:22 +01001488EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001489
1490/**
1491 * ring_buffer_record_enable_cpu - enable writes to the buffer
1492 * @buffer: The ring buffer to enable writes
1493 * @cpu: The CPU to enable.
1494 *
1495 * Note, multiple disables will need the same number of enables
1496 * to truely enable the writing (much like preempt_disable).
1497 */
1498void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
1499{
1500 struct ring_buffer_per_cpu *cpu_buffer;
1501
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301502 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001503 return;
1504
1505 cpu_buffer = buffer->buffers[cpu];
1506 atomic_dec(&cpu_buffer->record_disabled);
1507}
Robert Richterc4f50182008-12-11 16:49:22 +01001508EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001509
1510/**
1511 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
1512 * @buffer: The ring buffer
1513 * @cpu: The per CPU buffer to get the entries from.
1514 */
1515unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
1516{
1517 struct ring_buffer_per_cpu *cpu_buffer;
1518
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301519 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001520 return 0;
1521
1522 cpu_buffer = buffer->buffers[cpu];
1523 return cpu_buffer->entries;
1524}
Robert Richterc4f50182008-12-11 16:49:22 +01001525EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001526
1527/**
1528 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
1529 * @buffer: The ring buffer
1530 * @cpu: The per CPU buffer to get the number of overruns from
1531 */
1532unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
1533{
1534 struct ring_buffer_per_cpu *cpu_buffer;
1535
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301536 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001537 return 0;
1538
1539 cpu_buffer = buffer->buffers[cpu];
1540 return cpu_buffer->overrun;
1541}
Robert Richterc4f50182008-12-11 16:49:22 +01001542EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001543
1544/**
1545 * ring_buffer_entries - get the number of entries in a buffer
1546 * @buffer: The ring buffer
1547 *
1548 * Returns the total number of entries in the ring buffer
1549 * (all CPU entries)
1550 */
1551unsigned long ring_buffer_entries(struct ring_buffer *buffer)
1552{
1553 struct ring_buffer_per_cpu *cpu_buffer;
1554 unsigned long entries = 0;
1555 int cpu;
1556
1557 /* if you care about this being correct, lock the buffer */
1558 for_each_buffer_cpu(buffer, cpu) {
1559 cpu_buffer = buffer->buffers[cpu];
1560 entries += cpu_buffer->entries;
1561 }
1562
1563 return entries;
1564}
Robert Richterc4f50182008-12-11 16:49:22 +01001565EXPORT_SYMBOL_GPL(ring_buffer_entries);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001566
1567/**
1568 * ring_buffer_overrun_cpu - get the number of overruns in buffer
1569 * @buffer: The ring buffer
1570 *
1571 * Returns the total number of overruns in the ring buffer
1572 * (all CPU entries)
1573 */
1574unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
1575{
1576 struct ring_buffer_per_cpu *cpu_buffer;
1577 unsigned long overruns = 0;
1578 int cpu;
1579
1580 /* if you care about this being correct, lock the buffer */
1581 for_each_buffer_cpu(buffer, cpu) {
1582 cpu_buffer = buffer->buffers[cpu];
1583 overruns += cpu_buffer->overrun;
1584 }
1585
1586 return overruns;
1587}
Robert Richterc4f50182008-12-11 16:49:22 +01001588EXPORT_SYMBOL_GPL(ring_buffer_overruns);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001589
Steven Rostedt642edba2008-11-12 00:01:26 -05001590static void rb_iter_reset(struct ring_buffer_iter *iter)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001591{
1592 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1593
Steven Rostedtd7690412008-10-01 00:29:53 -04001594 /* Iterator usage is expected to have record disabled */
1595 if (list_empty(&cpu_buffer->reader_page->list)) {
1596 iter->head_page = cpu_buffer->head_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001597 iter->head = cpu_buffer->head_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04001598 } else {
1599 iter->head_page = cpu_buffer->reader_page;
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001600 iter->head = cpu_buffer->reader_page->read;
Steven Rostedtd7690412008-10-01 00:29:53 -04001601 }
1602 if (iter->head)
1603 iter->read_stamp = cpu_buffer->read_stamp;
1604 else
Steven Rostedtabc9b562008-12-02 15:34:06 -05001605 iter->read_stamp = iter->head_page->page->time_stamp;
Steven Rostedt642edba2008-11-12 00:01:26 -05001606}
Steven Rostedtf83c9d02008-11-11 18:47:44 +01001607
Steven Rostedt642edba2008-11-12 00:01:26 -05001608/**
1609 * ring_buffer_iter_reset - reset an iterator
1610 * @iter: The iterator to reset
1611 *
1612 * Resets the iterator, so that it will start from the beginning
1613 * again.
1614 */
1615void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
1616{
1617 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1618 unsigned long flags;
1619
1620 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
1621 rb_iter_reset(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01001622 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001623}
Robert Richterc4f50182008-12-11 16:49:22 +01001624EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001625
1626/**
1627 * ring_buffer_iter_empty - check if an iterator has no more to read
1628 * @iter: The iterator to check
1629 */
1630int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
1631{
1632 struct ring_buffer_per_cpu *cpu_buffer;
1633
1634 cpu_buffer = iter->cpu_buffer;
1635
Steven Rostedtbf41a152008-10-04 02:00:59 -04001636 return iter->head_page == cpu_buffer->commit_page &&
1637 iter->head == rb_commit_index(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001638}
Robert Richterc4f50182008-12-11 16:49:22 +01001639EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001640
1641static void
1642rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
1643 struct ring_buffer_event *event)
1644{
1645 u64 delta;
1646
1647 switch (event->type) {
1648 case RINGBUF_TYPE_PADDING:
1649 return;
1650
1651 case RINGBUF_TYPE_TIME_EXTEND:
1652 delta = event->array[0];
1653 delta <<= TS_SHIFT;
1654 delta += event->time_delta;
1655 cpu_buffer->read_stamp += delta;
1656 return;
1657
1658 case RINGBUF_TYPE_TIME_STAMP:
1659 /* FIXME: not implemented */
1660 return;
1661
1662 case RINGBUF_TYPE_DATA:
1663 cpu_buffer->read_stamp += event->time_delta;
1664 return;
1665
1666 default:
1667 BUG();
1668 }
1669 return;
1670}
1671
1672static void
1673rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
1674 struct ring_buffer_event *event)
1675{
1676 u64 delta;
1677
1678 switch (event->type) {
1679 case RINGBUF_TYPE_PADDING:
1680 return;
1681
1682 case RINGBUF_TYPE_TIME_EXTEND:
1683 delta = event->array[0];
1684 delta <<= TS_SHIFT;
1685 delta += event->time_delta;
1686 iter->read_stamp += delta;
1687 return;
1688
1689 case RINGBUF_TYPE_TIME_STAMP:
1690 /* FIXME: not implemented */
1691 return;
1692
1693 case RINGBUF_TYPE_DATA:
1694 iter->read_stamp += event->time_delta;
1695 return;
1696
1697 default:
1698 BUG();
1699 }
1700 return;
1701}
1702
Steven Rostedtd7690412008-10-01 00:29:53 -04001703static struct buffer_page *
1704rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001705{
Steven Rostedtd7690412008-10-01 00:29:53 -04001706 struct buffer_page *reader = NULL;
1707 unsigned long flags;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001708 int nr_loops = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04001709
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001710 local_irq_save(flags);
1711 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedtd7690412008-10-01 00:29:53 -04001712
1713 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001714 /*
1715 * This should normally only loop twice. But because the
1716 * start of the reader inserts an empty page, it causes
1717 * a case where we will loop three times. There should be no
1718 * reason to loop four times (that I know of).
1719 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001720 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001721 reader = NULL;
1722 goto out;
1723 }
1724
Steven Rostedtd7690412008-10-01 00:29:53 -04001725 reader = cpu_buffer->reader_page;
1726
1727 /* If there's more to read, return this page */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001728 if (cpu_buffer->reader_page->read < rb_page_size(reader))
Steven Rostedtd7690412008-10-01 00:29:53 -04001729 goto out;
1730
1731 /* Never should we have an index greater than the size */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001732 if (RB_WARN_ON(cpu_buffer,
1733 cpu_buffer->reader_page->read > rb_page_size(reader)))
1734 goto out;
Steven Rostedtd7690412008-10-01 00:29:53 -04001735
1736 /* check if we caught up to the tail */
1737 reader = NULL;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001738 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
Steven Rostedtd7690412008-10-01 00:29:53 -04001739 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001740
1741 /*
Steven Rostedtd7690412008-10-01 00:29:53 -04001742 * Splice the empty reader page into the list around the head.
1743 * Reset the reader page to size zero.
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001744 */
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001745
Steven Rostedtd7690412008-10-01 00:29:53 -04001746 reader = cpu_buffer->head_page;
1747 cpu_buffer->reader_page->list.next = reader->list.next;
1748 cpu_buffer->reader_page->list.prev = reader->list.prev;
Steven Rostedtbf41a152008-10-04 02:00:59 -04001749
1750 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05001751 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedtd7690412008-10-01 00:29:53 -04001752
1753 /* Make the reader page now replace the head */
1754 reader->list.prev->next = &cpu_buffer->reader_page->list;
1755 reader->list.next->prev = &cpu_buffer->reader_page->list;
1756
1757 /*
1758 * If the tail is on the reader, then we must set the head
1759 * to the inserted page, otherwise we set it one before.
1760 */
1761 cpu_buffer->head_page = cpu_buffer->reader_page;
1762
Steven Rostedtbf41a152008-10-04 02:00:59 -04001763 if (cpu_buffer->commit_page != reader)
Steven Rostedtd7690412008-10-01 00:29:53 -04001764 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
1765
1766 /* Finally update the reader page to the new head */
1767 cpu_buffer->reader_page = reader;
1768 rb_reset_reader_page(cpu_buffer);
1769
1770 goto again;
1771
1772 out:
Steven Rostedt3e03fb72008-11-06 00:09:43 -05001773 __raw_spin_unlock(&cpu_buffer->lock);
1774 local_irq_restore(flags);
Steven Rostedtd7690412008-10-01 00:29:53 -04001775
1776 return reader;
1777}
1778
1779static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
1780{
1781 struct ring_buffer_event *event;
1782 struct buffer_page *reader;
1783 unsigned length;
1784
1785 reader = rb_get_reader_page(cpu_buffer);
1786
1787 /* This function should not be called when buffer is empty */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001788 if (RB_WARN_ON(cpu_buffer, !reader))
1789 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04001790
1791 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001792
1793 if (event->type == RINGBUF_TYPE_DATA)
1794 cpu_buffer->entries--;
1795
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001796 rb_update_read_stamp(cpu_buffer, event);
1797
Steven Rostedtd7690412008-10-01 00:29:53 -04001798 length = rb_event_length(event);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04001799 cpu_buffer->reader_page->read += length;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001800}
1801
1802static void rb_advance_iter(struct ring_buffer_iter *iter)
1803{
1804 struct ring_buffer *buffer;
1805 struct ring_buffer_per_cpu *cpu_buffer;
1806 struct ring_buffer_event *event;
1807 unsigned length;
1808
1809 cpu_buffer = iter->cpu_buffer;
1810 buffer = cpu_buffer->buffer;
1811
1812 /*
1813 * Check if we are at the end of the buffer.
1814 */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001815 if (iter->head >= rb_page_size(iter->head_page)) {
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001816 if (RB_WARN_ON(buffer,
1817 iter->head_page == cpu_buffer->commit_page))
1818 return;
Steven Rostedtd7690412008-10-01 00:29:53 -04001819 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001820 return;
1821 }
1822
1823 event = rb_iter_head_event(iter);
1824
1825 length = rb_event_length(event);
1826
1827 /*
1828 * This should not be called to advance the header if we are
1829 * at the tail of the buffer.
1830 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001831 if (RB_WARN_ON(cpu_buffer,
Steven Rostedtf536aaf2008-11-10 23:07:30 -05001832 (iter->head_page == cpu_buffer->commit_page) &&
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001833 (iter->head + length > rb_commit_index(cpu_buffer))))
1834 return;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001835
1836 rb_update_iter_read_stamp(iter, event);
1837
1838 iter->head += length;
1839
1840 /* check for end of page padding */
Steven Rostedtbf41a152008-10-04 02:00:59 -04001841 if ((iter->head >= rb_page_size(iter->head_page)) &&
1842 (iter->head_page != cpu_buffer->commit_page))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001843 rb_advance_iter(iter);
1844}
1845
Steven Rostedtf83c9d02008-11-11 18:47:44 +01001846static struct ring_buffer_event *
1847rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001848{
1849 struct ring_buffer_per_cpu *cpu_buffer;
1850 struct ring_buffer_event *event;
Steven Rostedtd7690412008-10-01 00:29:53 -04001851 struct buffer_page *reader;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001852 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001853
Rusty Russell9e01c1b2009-01-01 10:12:22 +10301854 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001855 return NULL;
1856
1857 cpu_buffer = buffer->buffers[cpu];
1858
1859 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001860 /*
1861 * We repeat when a timestamp is encountered. It is possible
1862 * to get multiple timestamps from an interrupt entering just
1863 * as one timestamp is about to be written. The max times
1864 * that this can happen is the number of nested interrupts we
1865 * can have. Nesting 10 deep of interrupts is clearly
1866 * an anomaly.
1867 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001868 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001869 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001870
Steven Rostedtd7690412008-10-01 00:29:53 -04001871 reader = rb_get_reader_page(cpu_buffer);
1872 if (!reader)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001873 return NULL;
1874
Steven Rostedtd7690412008-10-01 00:29:53 -04001875 event = rb_reader_event(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001876
1877 switch (event->type) {
1878 case RINGBUF_TYPE_PADDING:
Steven Rostedtbf41a152008-10-04 02:00:59 -04001879 RB_WARN_ON(cpu_buffer, 1);
Steven Rostedtd7690412008-10-01 00:29:53 -04001880 rb_advance_reader(cpu_buffer);
1881 return NULL;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001882
1883 case RINGBUF_TYPE_TIME_EXTEND:
1884 /* Internal data, OK to advance */
Steven Rostedtd7690412008-10-01 00:29:53 -04001885 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001886 goto again;
1887
1888 case RINGBUF_TYPE_TIME_STAMP:
1889 /* FIXME: not implemented */
Steven Rostedtd7690412008-10-01 00:29:53 -04001890 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001891 goto again;
1892
1893 case RINGBUF_TYPE_DATA:
1894 if (ts) {
1895 *ts = cpu_buffer->read_stamp + event->time_delta;
1896 ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
1897 }
1898 return event;
1899
1900 default:
1901 BUG();
1902 }
1903
1904 return NULL;
1905}
Robert Richterc4f50182008-12-11 16:49:22 +01001906EXPORT_SYMBOL_GPL(ring_buffer_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001907
Steven Rostedtf83c9d02008-11-11 18:47:44 +01001908static struct ring_buffer_event *
1909rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001910{
1911 struct ring_buffer *buffer;
1912 struct ring_buffer_per_cpu *cpu_buffer;
1913 struct ring_buffer_event *event;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001914 int nr_loops = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001915
1916 if (ring_buffer_iter_empty(iter))
1917 return NULL;
1918
1919 cpu_buffer = iter->cpu_buffer;
1920 buffer = cpu_buffer->buffer;
1921
1922 again:
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001923 /*
1924 * We repeat when a timestamp is encountered. It is possible
1925 * to get multiple timestamps from an interrupt entering just
1926 * as one timestamp is about to be written. The max times
1927 * that this can happen is the number of nested interrupts we
1928 * can have. Nesting 10 deep of interrupts is clearly
1929 * an anomaly.
1930 */
Steven Rostedt3e89c7b2008-11-11 15:28:41 -05001931 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001932 return NULL;
Steven Rostedt818e3dd2008-10-31 09:58:35 -04001933
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001934 if (rb_per_cpu_empty(cpu_buffer))
1935 return NULL;
1936
1937 event = rb_iter_head_event(iter);
1938
1939 switch (event->type) {
1940 case RINGBUF_TYPE_PADDING:
Steven Rostedtd7690412008-10-01 00:29:53 -04001941 rb_inc_iter(iter);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001942 goto again;
1943
1944 case RINGBUF_TYPE_TIME_EXTEND:
1945 /* Internal data, OK to advance */
1946 rb_advance_iter(iter);
1947 goto again;
1948
1949 case RINGBUF_TYPE_TIME_STAMP:
1950 /* FIXME: not implemented */
1951 rb_advance_iter(iter);
1952 goto again;
1953
1954 case RINGBUF_TYPE_DATA:
1955 if (ts) {
1956 *ts = iter->read_stamp + event->time_delta;
1957 ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
1958 }
1959 return event;
1960
1961 default:
1962 BUG();
1963 }
1964
1965 return NULL;
1966}
Robert Richterc4f50182008-12-11 16:49:22 +01001967EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04001968
1969/**
Steven Rostedtf83c9d02008-11-11 18:47:44 +01001970 * ring_buffer_peek - peek at the next event to be read
1971 * @buffer: The ring buffer to read
1972 * @cpu: The cpu to peak at
1973 * @ts: The timestamp counter of this event.
1974 *
1975 * This will return the event that will be read next, but does
1976 * not consume the data.
1977 */
1978struct ring_buffer_event *
1979ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
1980{
1981 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
1982 struct ring_buffer_event *event;
1983 unsigned long flags;
1984
1985 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
1986 event = rb_buffer_peek(buffer, cpu, ts);
1987 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
1988
1989 return event;
1990}
1991
1992/**
1993 * ring_buffer_iter_peek - peek at the next event to be read
1994 * @iter: The ring buffer iterator
1995 * @ts: The timestamp counter of this event.
1996 *
1997 * This will return the event that will be read next, but does
1998 * not increment the iterator.
1999 */
2000struct ring_buffer_event *
2001ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
2002{
2003 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2004 struct ring_buffer_event *event;
2005 unsigned long flags;
2006
2007 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2008 event = rb_iter_peek(iter, ts);
2009 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2010
2011 return event;
2012}
2013
2014/**
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002015 * ring_buffer_consume - return an event and consume it
2016 * @buffer: The ring buffer to get the next event from
2017 *
2018 * Returns the next event in the ring buffer, and that event is consumed.
2019 * Meaning, that sequential reads will keep returning a different event,
2020 * and eventually empty the ring buffer if the producer is slower.
2021 */
2022struct ring_buffer_event *
2023ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
2024{
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002025 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002026 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002027 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002028
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302029 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002030 return NULL;
2031
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002032 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002033
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002034 event = rb_buffer_peek(buffer, cpu, ts);
2035 if (!event)
2036 goto out;
2037
Steven Rostedtd7690412008-10-01 00:29:53 -04002038 rb_advance_reader(cpu_buffer);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002039
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002040 out:
2041 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2042
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002043 return event;
2044}
Robert Richterc4f50182008-12-11 16:49:22 +01002045EXPORT_SYMBOL_GPL(ring_buffer_consume);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002046
2047/**
2048 * ring_buffer_read_start - start a non consuming read of the buffer
2049 * @buffer: The ring buffer to read from
2050 * @cpu: The cpu buffer to iterate over
2051 *
2052 * This starts up an iteration through the buffer. It also disables
2053 * the recording to the buffer until the reading is finished.
2054 * This prevents the reading from being corrupted. This is not
2055 * a consuming read, so a producer is not expected.
2056 *
2057 * Must be paired with ring_buffer_finish.
2058 */
2059struct ring_buffer_iter *
2060ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
2061{
2062 struct ring_buffer_per_cpu *cpu_buffer;
2063 struct ring_buffer_iter *iter;
Steven Rostedtd7690412008-10-01 00:29:53 -04002064 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002065
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302066 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002067 return NULL;
2068
2069 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
2070 if (!iter)
2071 return NULL;
2072
2073 cpu_buffer = buffer->buffers[cpu];
2074
2075 iter->cpu_buffer = cpu_buffer;
2076
2077 atomic_inc(&cpu_buffer->record_disabled);
2078 synchronize_sched();
2079
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002080 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002081 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt642edba2008-11-12 00:01:26 -05002082 rb_iter_reset(iter);
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002083 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002084 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002085
2086 return iter;
2087}
Robert Richterc4f50182008-12-11 16:49:22 +01002088EXPORT_SYMBOL_GPL(ring_buffer_read_start);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002089
2090/**
2091 * ring_buffer_finish - finish reading the iterator of the buffer
2092 * @iter: The iterator retrieved by ring_buffer_start
2093 *
2094 * This re-enables the recording to the buffer, and frees the
2095 * iterator.
2096 */
2097void
2098ring_buffer_read_finish(struct ring_buffer_iter *iter)
2099{
2100 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2101
2102 atomic_dec(&cpu_buffer->record_disabled);
2103 kfree(iter);
2104}
Robert Richterc4f50182008-12-11 16:49:22 +01002105EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002106
2107/**
2108 * ring_buffer_read - read the next item in the ring buffer by the iterator
2109 * @iter: The ring buffer iterator
2110 * @ts: The time stamp of the event read.
2111 *
2112 * This reads the next event in the ring buffer and increments the iterator.
2113 */
2114struct ring_buffer_event *
2115ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
2116{
2117 struct ring_buffer_event *event;
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002118 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2119 unsigned long flags;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002120
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002121 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2122 event = rb_iter_peek(iter, ts);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002123 if (!event)
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002124 goto out;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002125
2126 rb_advance_iter(iter);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002127 out:
2128 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002129
2130 return event;
2131}
Robert Richterc4f50182008-12-11 16:49:22 +01002132EXPORT_SYMBOL_GPL(ring_buffer_read);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002133
2134/**
2135 * ring_buffer_size - return the size of the ring buffer (in bytes)
2136 * @buffer: The ring buffer.
2137 */
2138unsigned long ring_buffer_size(struct ring_buffer *buffer)
2139{
2140 return BUF_PAGE_SIZE * buffer->pages;
2141}
Robert Richterc4f50182008-12-11 16:49:22 +01002142EXPORT_SYMBOL_GPL(ring_buffer_size);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002143
2144static void
2145rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
2146{
2147 cpu_buffer->head_page
2148 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
Steven Rostedtbf41a152008-10-04 02:00:59 -04002149 local_set(&cpu_buffer->head_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002150 local_set(&cpu_buffer->head_page->page->commit, 0);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002151
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002152 cpu_buffer->head_page->read = 0;
Steven Rostedtbf41a152008-10-04 02:00:59 -04002153
2154 cpu_buffer->tail_page = cpu_buffer->head_page;
2155 cpu_buffer->commit_page = cpu_buffer->head_page;
2156
2157 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
2158 local_set(&cpu_buffer->reader_page->write, 0);
Steven Rostedtabc9b562008-12-02 15:34:06 -05002159 local_set(&cpu_buffer->reader_page->page->commit, 0);
Steven Rostedt6f807ac2008-10-04 02:00:58 -04002160 cpu_buffer->reader_page->read = 0;
Steven Rostedtd7690412008-10-01 00:29:53 -04002161
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002162 cpu_buffer->overrun = 0;
2163 cpu_buffer->entries = 0;
Steven Rostedt69507c02009-01-21 18:45:57 -05002164
2165 cpu_buffer->write_stamp = 0;
2166 cpu_buffer->read_stamp = 0;
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002167}
2168
2169/**
2170 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
2171 * @buffer: The ring buffer to reset a per cpu buffer of
2172 * @cpu: The CPU buffer to be reset
2173 */
2174void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
2175{
2176 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2177 unsigned long flags;
2178
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302179 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002180 return;
2181
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002182 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2183
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002184 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002185
2186 rb_reset_cpu(cpu_buffer);
2187
Steven Rostedt3e03fb72008-11-06 00:09:43 -05002188 __raw_spin_unlock(&cpu_buffer->lock);
Steven Rostedtf83c9d02008-11-11 18:47:44 +01002189
2190 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002191}
Robert Richterc4f50182008-12-11 16:49:22 +01002192EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002193
2194/**
2195 * ring_buffer_reset - reset a ring buffer
2196 * @buffer: The ring buffer to reset all cpu buffers
2197 */
2198void ring_buffer_reset(struct ring_buffer *buffer)
2199{
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002200 int cpu;
2201
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002202 for_each_buffer_cpu(buffer, cpu)
Steven Rostedtd7690412008-10-01 00:29:53 -04002203 ring_buffer_reset_cpu(buffer, cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002204}
Robert Richterc4f50182008-12-11 16:49:22 +01002205EXPORT_SYMBOL_GPL(ring_buffer_reset);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002206
2207/**
2208 * rind_buffer_empty - is the ring buffer empty?
2209 * @buffer: The ring buffer to test
2210 */
2211int ring_buffer_empty(struct ring_buffer *buffer)
2212{
2213 struct ring_buffer_per_cpu *cpu_buffer;
2214 int cpu;
2215
2216 /* yes this is racy, but if you don't like the race, lock the buffer */
2217 for_each_buffer_cpu(buffer, cpu) {
2218 cpu_buffer = buffer->buffers[cpu];
2219 if (!rb_per_cpu_empty(cpu_buffer))
2220 return 0;
2221 }
2222 return 1;
2223}
Robert Richterc4f50182008-12-11 16:49:22 +01002224EXPORT_SYMBOL_GPL(ring_buffer_empty);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002225
2226/**
2227 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
2228 * @buffer: The ring buffer
2229 * @cpu: The CPU buffer to test
2230 */
2231int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
2232{
2233 struct ring_buffer_per_cpu *cpu_buffer;
2234
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302235 if (!cpumask_test_cpu(cpu, buffer->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002236 return 1;
2237
2238 cpu_buffer = buffer->buffers[cpu];
2239 return rb_per_cpu_empty(cpu_buffer);
2240}
Robert Richterc4f50182008-12-11 16:49:22 +01002241EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002242
2243/**
2244 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
2245 * @buffer_a: One buffer to swap with
2246 * @buffer_b: The other buffer to swap with
2247 *
2248 * This function is useful for tracers that want to take a "snapshot"
2249 * of a CPU buffer and has another back up buffer lying around.
2250 * it is expected that the tracer handles the cpu buffer not being
2251 * used at the moment.
2252 */
2253int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
2254 struct ring_buffer *buffer_b, int cpu)
2255{
2256 struct ring_buffer_per_cpu *cpu_buffer_a;
2257 struct ring_buffer_per_cpu *cpu_buffer_b;
2258
Rusty Russell9e01c1b2009-01-01 10:12:22 +10302259 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
2260 !cpumask_test_cpu(cpu, buffer_b->cpumask))
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002261 return -EINVAL;
2262
2263 /* At least make sure the two buffers are somewhat the same */
Lai Jiangshan6d102bc2008-12-17 17:48:23 +08002264 if (buffer_a->pages != buffer_b->pages)
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002265 return -EINVAL;
2266
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002267 if (ring_buffer_flags != RB_BUFFERS_ON)
2268 return -EAGAIN;
2269
2270 if (atomic_read(&buffer_a->record_disabled))
2271 return -EAGAIN;
2272
2273 if (atomic_read(&buffer_b->record_disabled))
2274 return -EAGAIN;
2275
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002276 cpu_buffer_a = buffer_a->buffers[cpu];
2277 cpu_buffer_b = buffer_b->buffers[cpu];
2278
Steven Rostedt97b17ef2009-01-21 15:24:56 -05002279 if (atomic_read(&cpu_buffer_a->record_disabled))
2280 return -EAGAIN;
2281
2282 if (atomic_read(&cpu_buffer_b->record_disabled))
2283 return -EAGAIN;
2284
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002285 /*
2286 * We can't do a synchronize_sched here because this
2287 * function can be called in atomic context.
2288 * Normally this will be called from the same CPU as cpu.
2289 * If not it's up to the caller to protect this.
2290 */
2291 atomic_inc(&cpu_buffer_a->record_disabled);
2292 atomic_inc(&cpu_buffer_b->record_disabled);
2293
2294 buffer_a->buffers[cpu] = cpu_buffer_b;
2295 buffer_b->buffers[cpu] = cpu_buffer_a;
2296
2297 cpu_buffer_b->buffer = buffer_a;
2298 cpu_buffer_a->buffer = buffer_b;
2299
2300 atomic_dec(&cpu_buffer_a->record_disabled);
2301 atomic_dec(&cpu_buffer_b->record_disabled);
2302
2303 return 0;
2304}
Robert Richterc4f50182008-12-11 16:49:22 +01002305EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
Steven Rostedt7a8e76a2008-09-29 23:02:38 -04002306
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002307static void rb_remove_entries(struct ring_buffer_per_cpu *cpu_buffer,
Steven Rostedt044fa782008-12-02 23:50:03 -05002308 struct buffer_data_page *bpage)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002309{
2310 struct ring_buffer_event *event;
2311 unsigned long head;
2312
2313 __raw_spin_lock(&cpu_buffer->lock);
Steven Rostedt044fa782008-12-02 23:50:03 -05002314 for (head = 0; head < local_read(&bpage->commit);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002315 head += rb_event_length(event)) {
2316
Steven Rostedt044fa782008-12-02 23:50:03 -05002317 event = __rb_data_page_index(bpage, head);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002318 if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
2319 return;
2320 /* Only count data entries */
2321 if (event->type != RINGBUF_TYPE_DATA)
2322 continue;
2323 cpu_buffer->entries--;
2324 }
2325 __raw_spin_unlock(&cpu_buffer->lock);
2326}
2327
2328/**
2329 * ring_buffer_alloc_read_page - allocate a page to read from buffer
2330 * @buffer: the buffer to allocate for.
2331 *
2332 * This function is used in conjunction with ring_buffer_read_page.
2333 * When reading a full page from the ring buffer, these functions
2334 * can be used to speed up the process. The calling function should
2335 * allocate a few pages first with this function. Then when it
2336 * needs to get pages from the ring buffer, it passes the result
2337 * of this function into ring_buffer_read_page, which will swap
2338 * the page that was allocated, with the read page of the buffer.
2339 *
2340 * Returns:
2341 * The page allocated, or NULL on error.
2342 */
2343void *ring_buffer_alloc_read_page(struct ring_buffer *buffer)
2344{
2345 unsigned long addr;
Steven Rostedt044fa782008-12-02 23:50:03 -05002346 struct buffer_data_page *bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002347
2348 addr = __get_free_page(GFP_KERNEL);
2349 if (!addr)
2350 return NULL;
2351
Steven Rostedt044fa782008-12-02 23:50:03 -05002352 bpage = (void *)addr;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002353
Steven Rostedt044fa782008-12-02 23:50:03 -05002354 return bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002355}
2356
2357/**
2358 * ring_buffer_free_read_page - free an allocated read page
2359 * @buffer: the buffer the page was allocate for
2360 * @data: the page to free
2361 *
2362 * Free a page allocated from ring_buffer_alloc_read_page.
2363 */
2364void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
2365{
2366 free_page((unsigned long)data);
2367}
2368
2369/**
2370 * ring_buffer_read_page - extract a page from the ring buffer
2371 * @buffer: buffer to extract from
2372 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
2373 * @cpu: the cpu of the buffer to extract
2374 * @full: should the extraction only happen when the page is full.
2375 *
2376 * This function will pull out a page from the ring buffer and consume it.
2377 * @data_page must be the address of the variable that was returned
2378 * from ring_buffer_alloc_read_page. This is because the page might be used
2379 * to swap with a page in the ring buffer.
2380 *
2381 * for example:
2382 * rpage = ring_buffer_alloc_page(buffer);
2383 * if (!rpage)
2384 * return error;
2385 * ret = ring_buffer_read_page(buffer, &rpage, cpu, 0);
2386 * if (ret)
2387 * process_page(rpage);
2388 *
2389 * When @full is set, the function will not return true unless
2390 * the writer is off the reader page.
2391 *
2392 * Note: it is up to the calling functions to handle sleeps and wakeups.
2393 * The ring buffer can be used anywhere in the kernel and can not
2394 * blindly call wake_up. The layer that uses the ring buffer must be
2395 * responsible for that.
2396 *
2397 * Returns:
2398 * 1 if data has been transferred
2399 * 0 if no data has been transferred.
2400 */
2401int ring_buffer_read_page(struct ring_buffer *buffer,
2402 void **data_page, int cpu, int full)
2403{
2404 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2405 struct ring_buffer_event *event;
Steven Rostedt044fa782008-12-02 23:50:03 -05002406 struct buffer_data_page *bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002407 unsigned long flags;
2408 int ret = 0;
2409
2410 if (!data_page)
2411 return 0;
2412
Steven Rostedt044fa782008-12-02 23:50:03 -05002413 bpage = *data_page;
2414 if (!bpage)
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002415 return 0;
2416
2417 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2418
2419 /*
2420 * rb_buffer_peek will get the next ring buffer if
2421 * the current reader page is empty.
2422 */
2423 event = rb_buffer_peek(buffer, cpu, NULL);
2424 if (!event)
2425 goto out;
2426
2427 /* check for data */
2428 if (!local_read(&cpu_buffer->reader_page->page->commit))
2429 goto out;
2430 /*
2431 * If the writer is already off of the read page, then simply
2432 * switch the read page with the given page. Otherwise
2433 * we need to copy the data from the reader to the writer.
2434 */
2435 if (cpu_buffer->reader_page == cpu_buffer->commit_page) {
2436 unsigned int read = cpu_buffer->reader_page->read;
2437
2438 if (full)
2439 goto out;
2440 /* The writer is still on the reader page, we must copy */
Steven Rostedt044fa782008-12-02 23:50:03 -05002441 bpage = cpu_buffer->reader_page->page;
2442 memcpy(bpage->data,
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002443 cpu_buffer->reader_page->page->data + read,
Steven Rostedt044fa782008-12-02 23:50:03 -05002444 local_read(&bpage->commit) - read);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002445
2446 /* consume what was read */
2447 cpu_buffer->reader_page += read;
2448
2449 } else {
2450 /* swap the pages */
Steven Rostedt044fa782008-12-02 23:50:03 -05002451 rb_init_page(bpage);
2452 bpage = cpu_buffer->reader_page->page;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002453 cpu_buffer->reader_page->page = *data_page;
2454 cpu_buffer->reader_page->read = 0;
Steven Rostedt044fa782008-12-02 23:50:03 -05002455 *data_page = bpage;
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002456 }
2457 ret = 1;
2458
2459 /* update the entry counter */
Steven Rostedt044fa782008-12-02 23:50:03 -05002460 rb_remove_entries(cpu_buffer, bpage);
Steven Rostedt8789a9e2008-12-02 15:34:07 -05002461 out:
2462 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2463
2464 return ret;
2465}
2466
Steven Rostedta3583242008-11-11 15:01:42 -05002467static ssize_t
2468rb_simple_read(struct file *filp, char __user *ubuf,
2469 size_t cnt, loff_t *ppos)
2470{
Steven Rostedt033601a2008-11-21 12:41:55 -05002471 long *p = filp->private_data;
Steven Rostedta3583242008-11-11 15:01:42 -05002472 char buf[64];
2473 int r;
2474
Steven Rostedt033601a2008-11-21 12:41:55 -05002475 if (test_bit(RB_BUFFERS_DISABLED_BIT, p))
2476 r = sprintf(buf, "permanently disabled\n");
2477 else
2478 r = sprintf(buf, "%d\n", test_bit(RB_BUFFERS_ON_BIT, p));
Steven Rostedta3583242008-11-11 15:01:42 -05002479
2480 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
2481}
2482
2483static ssize_t
2484rb_simple_write(struct file *filp, const char __user *ubuf,
2485 size_t cnt, loff_t *ppos)
2486{
Steven Rostedt033601a2008-11-21 12:41:55 -05002487 long *p = filp->private_data;
Steven Rostedta3583242008-11-11 15:01:42 -05002488 char buf[64];
2489 long val;
2490 int ret;
2491
2492 if (cnt >= sizeof(buf))
2493 return -EINVAL;
2494
2495 if (copy_from_user(&buf, ubuf, cnt))
2496 return -EFAULT;
2497
2498 buf[cnt] = 0;
2499
2500 ret = strict_strtoul(buf, 10, &val);
2501 if (ret < 0)
2502 return ret;
2503
Steven Rostedt033601a2008-11-21 12:41:55 -05002504 if (val)
2505 set_bit(RB_BUFFERS_ON_BIT, p);
2506 else
2507 clear_bit(RB_BUFFERS_ON_BIT, p);
Steven Rostedta3583242008-11-11 15:01:42 -05002508
2509 (*ppos)++;
2510
2511 return cnt;
2512}
2513
2514static struct file_operations rb_simple_fops = {
2515 .open = tracing_open_generic,
2516 .read = rb_simple_read,
2517 .write = rb_simple_write,
2518};
2519
2520
2521static __init int rb_init_debugfs(void)
2522{
2523 struct dentry *d_tracer;
2524 struct dentry *entry;
2525
2526 d_tracer = tracing_init_dentry();
2527
2528 entry = debugfs_create_file("tracing_on", 0644, d_tracer,
Steven Rostedt033601a2008-11-21 12:41:55 -05002529 &ring_buffer_flags, &rb_simple_fops);
Steven Rostedta3583242008-11-11 15:01:42 -05002530 if (!entry)
2531 pr_warning("Could not create debugfs 'tracing_on' entry\n");
2532
2533 return 0;
2534}
2535
2536fs_initcall(rb_init_debugfs);