4 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
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>
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.
28 * There's three layers that must be on in order to write
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.
35 * In case of an anomaly, this global flag has a bit set that
36 * will permantly disable all ring buffers.
40 * Global flag to disable all recording to ring buffers
41 * This has two bits: ON, DISABLED
45 * 0 0 : ring buffers are off
46 * 1 0 : ring buffers are on
47 * X 1 : ring buffers are permanently disabled
51 RB_BUFFERS_ON_BIT = 0,
52 RB_BUFFERS_DISABLED_BIT = 1,
56 RB_BUFFERS_ON = 1 << RB_BUFFERS_ON_BIT,
57 RB_BUFFERS_DISABLED = 1 << RB_BUFFERS_DISABLED_BIT,
60 static long ring_buffer_flags __read_mostly = RB_BUFFERS_ON;
63 * tracing_on - enable all tracing buffers
65 * This function enables all tracing buffers that may have been
66 * disabled with tracing_off.
70 set_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
74 * tracing_off - turn off all tracing buffers
76 * This function stops all tracing buffers from recording data.
77 * It does not disable any overhead the tracers themselves may
78 * be causing. This function simply causes all recording to
79 * the ring buffers to fail.
81 void tracing_off(void)
83 clear_bit(RB_BUFFERS_ON_BIT, &ring_buffer_flags);
87 * tracing_off_permanent - permanently disable ring buffers
89 * This function, once called, will disable all ring buffers
92 void tracing_off_permanent(void)
94 set_bit(RB_BUFFERS_DISABLED_BIT, &ring_buffer_flags);
99 /* Up this if you want to test the TIME_EXTENTS and normalization */
100 #define DEBUG_SHIFT 0
103 u64 ring_buffer_time_stamp(int cpu)
107 preempt_disable_notrace();
108 /* shift to debug/test normalization and TIME_EXTENTS */
109 time = sched_clock() << DEBUG_SHIFT;
110 preempt_enable_no_resched_notrace();
115 void ring_buffer_normalize_time_stamp(int cpu, u64 *ts)
117 /* Just stupid testing the normalize function and deltas */
121 #define RB_EVNT_HDR_SIZE (sizeof(struct ring_buffer_event))
122 #define RB_ALIGNMENT_SHIFT 2
123 #define RB_ALIGNMENT (1 << RB_ALIGNMENT_SHIFT)
124 #define RB_MAX_SMALL_DATA 28
127 RB_LEN_TIME_EXTEND = 8,
128 RB_LEN_TIME_STAMP = 16,
131 /* inline for ring buffer fast paths */
132 static inline unsigned
133 rb_event_length(struct ring_buffer_event *event)
137 switch (event->type) {
138 case RINGBUF_TYPE_PADDING:
142 case RINGBUF_TYPE_TIME_EXTEND:
143 return RB_LEN_TIME_EXTEND;
145 case RINGBUF_TYPE_TIME_STAMP:
146 return RB_LEN_TIME_STAMP;
148 case RINGBUF_TYPE_DATA:
150 length = event->len << RB_ALIGNMENT_SHIFT;
152 length = event->array[0];
153 return length + RB_EVNT_HDR_SIZE;
162 * ring_buffer_event_length - return the length of the event
163 * @event: the event to get the length of
165 unsigned ring_buffer_event_length(struct ring_buffer_event *event)
167 return rb_event_length(event);
170 /* inline for ring buffer fast paths */
172 rb_event_data(struct ring_buffer_event *event)
174 BUG_ON(event->type != RINGBUF_TYPE_DATA);
175 /* If length is in len field, then array[0] has the data */
177 return (void *)&event->array[0];
178 /* Otherwise length is in array[0] and array[1] has the data */
179 return (void *)&event->array[1];
183 * ring_buffer_event_data - return the data of the event
184 * @event: the event to get the data from
186 void *ring_buffer_event_data(struct ring_buffer_event *event)
188 return rb_event_data(event);
191 #define for_each_buffer_cpu(buffer, cpu) \
192 for_each_cpu_mask(cpu, buffer->cpumask)
195 #define TS_MASK ((1ULL << TS_SHIFT) - 1)
196 #define TS_DELTA_TEST (~TS_MASK)
198 struct buffer_data_page {
199 u64 time_stamp; /* page time stamp */
200 local_t commit; /* write commited index */
201 unsigned char data[]; /* data of buffer page */
205 local_t write; /* index for next write */
206 unsigned read; /* index for next read */
207 struct list_head list; /* list of free pages */
208 struct buffer_data_page *page; /* Actual data page */
211 static void rb_init_page(struct buffer_data_page *bpage)
213 local_set(&bpage->commit, 0);
217 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
220 static inline void free_buffer_page(struct buffer_page *bpage)
223 free_page((unsigned long)bpage->page);
228 * We need to fit the time_stamp delta into 27 bits.
230 static inline int test_time_stamp(u64 delta)
232 if (delta & TS_DELTA_TEST)
237 #define BUF_PAGE_SIZE (PAGE_SIZE - sizeof(struct buffer_data_page))
240 * head_page == tail_page && head == tail then buffer is empty.
242 struct ring_buffer_per_cpu {
244 struct ring_buffer *buffer;
245 spinlock_t reader_lock; /* serialize readers */
247 struct lock_class_key lock_key;
248 struct list_head pages;
249 struct buffer_page *head_page; /* read from head */
250 struct buffer_page *tail_page; /* write to tail */
251 struct buffer_page *commit_page; /* commited pages */
252 struct buffer_page *reader_page;
253 unsigned long overrun;
254 unsigned long entries;
257 atomic_t record_disabled;
265 atomic_t record_disabled;
269 struct ring_buffer_per_cpu **buffers;
272 struct ring_buffer_iter {
273 struct ring_buffer_per_cpu *cpu_buffer;
275 struct buffer_page *head_page;
279 /* buffer may be either ring_buffer or ring_buffer_per_cpu */
280 #define RB_WARN_ON(buffer, cond) \
282 int _____ret = unlikely(cond); \
284 atomic_inc(&buffer->record_disabled); \
291 * check_pages - integrity check of buffer pages
292 * @cpu_buffer: CPU buffer with pages to test
294 * As a safty measure we check to make sure the data pages have not
297 static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
299 struct list_head *head = &cpu_buffer->pages;
300 struct buffer_page *bpage, *tmp;
302 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
304 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
307 list_for_each_entry_safe(bpage, tmp, head, list) {
308 if (RB_WARN_ON(cpu_buffer,
309 bpage->list.next->prev != &bpage->list))
311 if (RB_WARN_ON(cpu_buffer,
312 bpage->list.prev->next != &bpage->list))
319 static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
322 struct list_head *head = &cpu_buffer->pages;
323 struct buffer_page *bpage, *tmp;
328 for (i = 0; i < nr_pages; i++) {
329 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
330 GFP_KERNEL, cpu_to_node(cpu_buffer->cpu));
333 list_add(&bpage->list, &pages);
335 addr = __get_free_page(GFP_KERNEL);
338 bpage->page = (void *)addr;
339 rb_init_page(bpage->page);
342 list_splice(&pages, head);
344 rb_check_pages(cpu_buffer);
349 list_for_each_entry_safe(bpage, tmp, &pages, list) {
350 list_del_init(&bpage->list);
351 free_buffer_page(bpage);
356 static struct ring_buffer_per_cpu *
357 rb_allocate_cpu_buffer(struct ring_buffer *buffer, int cpu)
359 struct ring_buffer_per_cpu *cpu_buffer;
360 struct buffer_page *bpage;
364 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
365 GFP_KERNEL, cpu_to_node(cpu));
369 cpu_buffer->cpu = cpu;
370 cpu_buffer->buffer = buffer;
371 spin_lock_init(&cpu_buffer->reader_lock);
372 cpu_buffer->lock = (raw_spinlock_t)__RAW_SPIN_LOCK_UNLOCKED;
373 INIT_LIST_HEAD(&cpu_buffer->pages);
375 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
376 GFP_KERNEL, cpu_to_node(cpu));
378 goto fail_free_buffer;
380 cpu_buffer->reader_page = bpage;
381 addr = __get_free_page(GFP_KERNEL);
383 goto fail_free_reader;
384 bpage->page = (void *)addr;
385 rb_init_page(bpage->page);
387 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
389 ret = rb_allocate_pages(cpu_buffer, buffer->pages);
391 goto fail_free_reader;
393 cpu_buffer->head_page
394 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
395 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
400 free_buffer_page(cpu_buffer->reader_page);
407 static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
409 struct list_head *head = &cpu_buffer->pages;
410 struct buffer_page *bpage, *tmp;
412 list_del_init(&cpu_buffer->reader_page->list);
413 free_buffer_page(cpu_buffer->reader_page);
415 list_for_each_entry_safe(bpage, tmp, head, list) {
416 list_del_init(&bpage->list);
417 free_buffer_page(bpage);
423 * Causes compile errors if the struct buffer_page gets bigger
424 * than the struct page.
426 extern int ring_buffer_page_too_big(void);
429 * ring_buffer_alloc - allocate a new ring_buffer
430 * @size: the size in bytes that is needed.
431 * @flags: attributes to set for the ring buffer.
433 * Currently the only flag that is available is the RB_FL_OVERWRITE
434 * flag. This flag means that the buffer will overwrite old data
435 * when the buffer wraps. If this flag is not set, the buffer will
436 * drop data when the tail hits the head.
438 struct ring_buffer *ring_buffer_alloc(unsigned long size, unsigned flags)
440 struct ring_buffer *buffer;
444 /* Paranoid! Optimizes out when all is well */
445 if (sizeof(struct buffer_page) > sizeof(struct page))
446 ring_buffer_page_too_big();
449 /* keep it in its own cache line */
450 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
455 buffer->pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
456 buffer->flags = flags;
458 /* need at least two pages */
459 if (buffer->pages == 1)
462 buffer->cpumask = cpu_possible_map;
463 buffer->cpus = nr_cpu_ids;
465 bsize = sizeof(void *) * nr_cpu_ids;
466 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
468 if (!buffer->buffers)
469 goto fail_free_buffer;
471 for_each_buffer_cpu(buffer, cpu) {
472 buffer->buffers[cpu] =
473 rb_allocate_cpu_buffer(buffer, cpu);
474 if (!buffer->buffers[cpu])
475 goto fail_free_buffers;
478 mutex_init(&buffer->mutex);
483 for_each_buffer_cpu(buffer, cpu) {
484 if (buffer->buffers[cpu])
485 rb_free_cpu_buffer(buffer->buffers[cpu]);
487 kfree(buffer->buffers);
495 * ring_buffer_free - free a ring buffer.
496 * @buffer: the buffer to free.
499 ring_buffer_free(struct ring_buffer *buffer)
503 for_each_buffer_cpu(buffer, cpu)
504 rb_free_cpu_buffer(buffer->buffers[cpu]);
509 static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
512 rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned nr_pages)
514 struct buffer_page *bpage;
518 atomic_inc(&cpu_buffer->record_disabled);
521 for (i = 0; i < nr_pages; i++) {
522 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
524 p = cpu_buffer->pages.next;
525 bpage = list_entry(p, struct buffer_page, list);
526 list_del_init(&bpage->list);
527 free_buffer_page(bpage);
529 if (RB_WARN_ON(cpu_buffer, list_empty(&cpu_buffer->pages)))
532 rb_reset_cpu(cpu_buffer);
534 rb_check_pages(cpu_buffer);
536 atomic_dec(&cpu_buffer->record_disabled);
541 rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer,
542 struct list_head *pages, unsigned nr_pages)
544 struct buffer_page *bpage;
548 atomic_inc(&cpu_buffer->record_disabled);
551 for (i = 0; i < nr_pages; i++) {
552 if (RB_WARN_ON(cpu_buffer, list_empty(pages)))
555 bpage = list_entry(p, struct buffer_page, list);
556 list_del_init(&bpage->list);
557 list_add_tail(&bpage->list, &cpu_buffer->pages);
559 rb_reset_cpu(cpu_buffer);
561 rb_check_pages(cpu_buffer);
563 atomic_dec(&cpu_buffer->record_disabled);
567 * ring_buffer_resize - resize the ring buffer
568 * @buffer: the buffer to resize.
569 * @size: the new size.
571 * The tracer is responsible for making sure that the buffer is
572 * not being used while changing the size.
573 * Note: We may be able to change the above requirement by using
574 * RCU synchronizations.
576 * Minimum size is 2 * BUF_PAGE_SIZE.
578 * Returns -1 on failure.
580 int ring_buffer_resize(struct ring_buffer *buffer, unsigned long size)
582 struct ring_buffer_per_cpu *cpu_buffer;
583 unsigned nr_pages, rm_pages, new_pages;
584 struct buffer_page *bpage, *tmp;
585 unsigned long buffer_size;
591 * Always succeed at resizing a non-existent buffer:
596 size = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
597 size *= BUF_PAGE_SIZE;
598 buffer_size = buffer->pages * BUF_PAGE_SIZE;
600 /* we need a minimum of two pages */
601 if (size < BUF_PAGE_SIZE * 2)
602 size = BUF_PAGE_SIZE * 2;
604 if (size == buffer_size)
607 mutex_lock(&buffer->mutex);
609 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
611 if (size < buffer_size) {
613 /* easy case, just free pages */
614 if (RB_WARN_ON(buffer, nr_pages >= buffer->pages)) {
615 mutex_unlock(&buffer->mutex);
619 rm_pages = buffer->pages - nr_pages;
621 for_each_buffer_cpu(buffer, cpu) {
622 cpu_buffer = buffer->buffers[cpu];
623 rb_remove_pages(cpu_buffer, rm_pages);
629 * This is a bit more difficult. We only want to add pages
630 * when we can allocate enough for all CPUs. We do this
631 * by allocating all the pages and storing them on a local
632 * link list. If we succeed in our allocation, then we
633 * add these pages to the cpu_buffers. Otherwise we just free
634 * them all and return -ENOMEM;
636 if (RB_WARN_ON(buffer, nr_pages <= buffer->pages)) {
637 mutex_unlock(&buffer->mutex);
641 new_pages = nr_pages - buffer->pages;
643 for_each_buffer_cpu(buffer, cpu) {
644 for (i = 0; i < new_pages; i++) {
645 bpage = kzalloc_node(ALIGN(sizeof(*bpage),
647 GFP_KERNEL, cpu_to_node(cpu));
650 list_add(&bpage->list, &pages);
651 addr = __get_free_page(GFP_KERNEL);
654 bpage->page = (void *)addr;
655 rb_init_page(bpage->page);
659 for_each_buffer_cpu(buffer, cpu) {
660 cpu_buffer = buffer->buffers[cpu];
661 rb_insert_pages(cpu_buffer, &pages, new_pages);
664 if (RB_WARN_ON(buffer, !list_empty(&pages))) {
665 mutex_unlock(&buffer->mutex);
670 buffer->pages = nr_pages;
671 mutex_unlock(&buffer->mutex);
676 list_for_each_entry_safe(bpage, tmp, &pages, list) {
677 list_del_init(&bpage->list);
678 free_buffer_page(bpage);
680 mutex_unlock(&buffer->mutex);
684 static inline int rb_null_event(struct ring_buffer_event *event)
686 return event->type == RINGBUF_TYPE_PADDING;
690 __rb_data_page_index(struct buffer_data_page *bpage, unsigned index)
692 return bpage->data + index;
695 static inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
697 return bpage->page->data + index;
700 static inline struct ring_buffer_event *
701 rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
703 return __rb_page_index(cpu_buffer->reader_page,
704 cpu_buffer->reader_page->read);
707 static inline struct ring_buffer_event *
708 rb_head_event(struct ring_buffer_per_cpu *cpu_buffer)
710 return __rb_page_index(cpu_buffer->head_page,
711 cpu_buffer->head_page->read);
714 static inline struct ring_buffer_event *
715 rb_iter_head_event(struct ring_buffer_iter *iter)
717 return __rb_page_index(iter->head_page, iter->head);
720 static inline unsigned rb_page_write(struct buffer_page *bpage)
722 return local_read(&bpage->write);
725 static inline unsigned rb_page_commit(struct buffer_page *bpage)
727 return local_read(&bpage->page->commit);
730 /* Size is determined by what has been commited */
731 static inline unsigned rb_page_size(struct buffer_page *bpage)
733 return rb_page_commit(bpage);
736 static inline unsigned
737 rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
739 return rb_page_commit(cpu_buffer->commit_page);
742 static inline unsigned rb_head_size(struct ring_buffer_per_cpu *cpu_buffer)
744 return rb_page_commit(cpu_buffer->head_page);
748 * When the tail hits the head and the buffer is in overwrite mode,
749 * the head jumps to the next page and all content on the previous
750 * page is discarded. But before doing so, we update the overrun
751 * variable of the buffer.
753 static void rb_update_overflow(struct ring_buffer_per_cpu *cpu_buffer)
755 struct ring_buffer_event *event;
758 for (head = 0; head < rb_head_size(cpu_buffer);
759 head += rb_event_length(event)) {
761 event = __rb_page_index(cpu_buffer->head_page, head);
762 if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
764 /* Only count data entries */
765 if (event->type != RINGBUF_TYPE_DATA)
767 cpu_buffer->overrun++;
768 cpu_buffer->entries--;
772 static inline void rb_inc_page(struct ring_buffer_per_cpu *cpu_buffer,
773 struct buffer_page **bpage)
775 struct list_head *p = (*bpage)->list.next;
777 if (p == &cpu_buffer->pages)
780 *bpage = list_entry(p, struct buffer_page, list);
783 static inline unsigned
784 rb_event_index(struct ring_buffer_event *event)
786 unsigned long addr = (unsigned long)event;
788 return (addr & ~PAGE_MASK) - (PAGE_SIZE - BUF_PAGE_SIZE);
792 rb_is_commit(struct ring_buffer_per_cpu *cpu_buffer,
793 struct ring_buffer_event *event)
795 unsigned long addr = (unsigned long)event;
798 index = rb_event_index(event);
801 return cpu_buffer->commit_page->page == (void *)addr &&
802 rb_commit_index(cpu_buffer) == index;
806 rb_set_commit_event(struct ring_buffer_per_cpu *cpu_buffer,
807 struct ring_buffer_event *event)
809 unsigned long addr = (unsigned long)event;
812 index = rb_event_index(event);
815 while (cpu_buffer->commit_page->page != (void *)addr) {
816 if (RB_WARN_ON(cpu_buffer,
817 cpu_buffer->commit_page == cpu_buffer->tail_page))
819 cpu_buffer->commit_page->page->commit =
820 cpu_buffer->commit_page->write;
821 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
822 cpu_buffer->write_stamp =
823 cpu_buffer->commit_page->page->time_stamp;
826 /* Now set the commit to the event's index */
827 local_set(&cpu_buffer->commit_page->page->commit, index);
831 rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
834 * We only race with interrupts and NMIs on this CPU.
835 * If we own the commit event, then we can commit
836 * all others that interrupted us, since the interruptions
837 * are in stack format (they finish before they come
838 * back to us). This allows us to do a simple loop to
839 * assign the commit to the tail.
841 while (cpu_buffer->commit_page != cpu_buffer->tail_page) {
842 cpu_buffer->commit_page->page->commit =
843 cpu_buffer->commit_page->write;
844 rb_inc_page(cpu_buffer, &cpu_buffer->commit_page);
845 cpu_buffer->write_stamp =
846 cpu_buffer->commit_page->page->time_stamp;
847 /* add barrier to keep gcc from optimizing too much */
850 while (rb_commit_index(cpu_buffer) !=
851 rb_page_write(cpu_buffer->commit_page)) {
852 cpu_buffer->commit_page->page->commit =
853 cpu_buffer->commit_page->write;
858 static void rb_reset_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
860 cpu_buffer->read_stamp = cpu_buffer->reader_page->page->time_stamp;
861 cpu_buffer->reader_page->read = 0;
864 static inline void rb_inc_iter(struct ring_buffer_iter *iter)
866 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
869 * The iterator could be on the reader page (it starts there).
870 * But the head could have moved, since the reader was
871 * found. Check for this case and assign the iterator
872 * to the head page instead of next.
874 if (iter->head_page == cpu_buffer->reader_page)
875 iter->head_page = cpu_buffer->head_page;
877 rb_inc_page(cpu_buffer, &iter->head_page);
879 iter->read_stamp = iter->head_page->page->time_stamp;
884 * ring_buffer_update_event - update event type and data
885 * @event: the even to update
886 * @type: the type of event
887 * @length: the size of the event field in the ring buffer
889 * Update the type and data fields of the event. The length
890 * is the actual size that is written to the ring buffer,
891 * and with this, we can determine what to place into the
895 rb_update_event(struct ring_buffer_event *event,
896 unsigned type, unsigned length)
902 case RINGBUF_TYPE_PADDING:
905 case RINGBUF_TYPE_TIME_EXTEND:
907 (RB_LEN_TIME_EXTEND + (RB_ALIGNMENT-1))
908 >> RB_ALIGNMENT_SHIFT;
911 case RINGBUF_TYPE_TIME_STAMP:
913 (RB_LEN_TIME_STAMP + (RB_ALIGNMENT-1))
914 >> RB_ALIGNMENT_SHIFT;
917 case RINGBUF_TYPE_DATA:
918 length -= RB_EVNT_HDR_SIZE;
919 if (length > RB_MAX_SMALL_DATA) {
921 event->array[0] = length;
924 (length + (RB_ALIGNMENT-1))
925 >> RB_ALIGNMENT_SHIFT;
932 static inline unsigned rb_calculate_event_length(unsigned length)
934 struct ring_buffer_event event; /* Used only for sizeof array */
936 /* zero length can cause confusions */
940 if (length > RB_MAX_SMALL_DATA)
941 length += sizeof(event.array[0]);
943 length += RB_EVNT_HDR_SIZE;
944 length = ALIGN(length, RB_ALIGNMENT);
949 static struct ring_buffer_event *
950 __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
951 unsigned type, unsigned long length, u64 *ts)
953 struct buffer_page *tail_page, *head_page, *reader_page;
954 unsigned long tail, write;
955 struct ring_buffer *buffer = cpu_buffer->buffer;
956 struct ring_buffer_event *event;
959 tail_page = cpu_buffer->tail_page;
960 write = local_add_return(length, &tail_page->write);
961 tail = write - length;
963 /* See if we shot pass the end of this buffer page */
964 if (write > BUF_PAGE_SIZE) {
965 struct buffer_page *next_page = tail_page;
967 local_irq_save(flags);
968 __raw_spin_lock(&cpu_buffer->lock);
970 rb_inc_page(cpu_buffer, &next_page);
972 head_page = cpu_buffer->head_page;
973 reader_page = cpu_buffer->reader_page;
975 /* we grabbed the lock before incrementing */
976 if (RB_WARN_ON(cpu_buffer, next_page == reader_page))
980 * If for some reason, we had an interrupt storm that made
981 * it all the way around the buffer, bail, and warn
984 if (unlikely(next_page == cpu_buffer->commit_page)) {
989 if (next_page == head_page) {
990 if (!(buffer->flags & RB_FL_OVERWRITE)) {
992 if (tail <= BUF_PAGE_SIZE)
993 local_set(&tail_page->write, tail);
997 /* tail_page has not moved yet? */
998 if (tail_page == cpu_buffer->tail_page) {
999 /* count overflows */
1000 rb_update_overflow(cpu_buffer);
1002 rb_inc_page(cpu_buffer, &head_page);
1003 cpu_buffer->head_page = head_page;
1004 cpu_buffer->head_page->read = 0;
1009 * If the tail page is still the same as what we think
1010 * it is, then it is up to us to update the tail
1013 if (tail_page == cpu_buffer->tail_page) {
1014 local_set(&next_page->write, 0);
1015 local_set(&next_page->page->commit, 0);
1016 cpu_buffer->tail_page = next_page;
1018 /* reread the time stamp */
1019 *ts = ring_buffer_time_stamp(cpu_buffer->cpu);
1020 cpu_buffer->tail_page->page->time_stamp = *ts;
1024 * The actual tail page has moved forward.
1026 if (tail < BUF_PAGE_SIZE) {
1027 /* Mark the rest of the page with padding */
1028 event = __rb_page_index(tail_page, tail);
1029 event->type = RINGBUF_TYPE_PADDING;
1032 if (tail <= BUF_PAGE_SIZE)
1033 /* Set the write back to the previous setting */
1034 local_set(&tail_page->write, tail);
1037 * If this was a commit entry that failed,
1038 * increment that too
1040 if (tail_page == cpu_buffer->commit_page &&
1041 tail == rb_commit_index(cpu_buffer)) {
1042 rb_set_commit_to_write(cpu_buffer);
1045 __raw_spin_unlock(&cpu_buffer->lock);
1046 local_irq_restore(flags);
1048 /* fail and let the caller try again */
1049 return ERR_PTR(-EAGAIN);
1052 /* We reserved something on the buffer */
1054 if (RB_WARN_ON(cpu_buffer, write > BUF_PAGE_SIZE))
1057 event = __rb_page_index(tail_page, tail);
1058 rb_update_event(event, type, length);
1061 * If this is a commit and the tail is zero, then update
1062 * this page's time stamp.
1064 if (!tail && rb_is_commit(cpu_buffer, event))
1065 cpu_buffer->commit_page->page->time_stamp = *ts;
1070 __raw_spin_unlock(&cpu_buffer->lock);
1071 local_irq_restore(flags);
1076 rb_add_time_stamp(struct ring_buffer_per_cpu *cpu_buffer,
1077 u64 *ts, u64 *delta)
1079 struct ring_buffer_event *event;
1083 if (unlikely(*delta > (1ULL << 59) && !once++)) {
1084 printk(KERN_WARNING "Delta way too big! %llu"
1085 " ts=%llu write stamp = %llu\n",
1086 (unsigned long long)*delta,
1087 (unsigned long long)*ts,
1088 (unsigned long long)cpu_buffer->write_stamp);
1093 * The delta is too big, we to add a
1096 event = __rb_reserve_next(cpu_buffer,
1097 RINGBUF_TYPE_TIME_EXTEND,
1103 if (PTR_ERR(event) == -EAGAIN)
1106 /* Only a commited time event can update the write stamp */
1107 if (rb_is_commit(cpu_buffer, event)) {
1109 * If this is the first on the page, then we need to
1110 * update the page itself, and just put in a zero.
1112 if (rb_event_index(event)) {
1113 event->time_delta = *delta & TS_MASK;
1114 event->array[0] = *delta >> TS_SHIFT;
1116 cpu_buffer->commit_page->page->time_stamp = *ts;
1117 event->time_delta = 0;
1118 event->array[0] = 0;
1120 cpu_buffer->write_stamp = *ts;
1121 /* let the caller know this was the commit */
1124 /* Darn, this is just wasted space */
1125 event->time_delta = 0;
1126 event->array[0] = 0;
1135 static struct ring_buffer_event *
1136 rb_reserve_next_event(struct ring_buffer_per_cpu *cpu_buffer,
1137 unsigned type, unsigned long length)
1139 struct ring_buffer_event *event;
1146 * We allow for interrupts to reenter here and do a trace.
1147 * If one does, it will cause this original code to loop
1148 * back here. Even with heavy interrupts happening, this
1149 * should only happen a few times in a row. If this happens
1150 * 1000 times in a row, there must be either an interrupt
1151 * storm or we have something buggy.
1154 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
1157 ts = ring_buffer_time_stamp(cpu_buffer->cpu);
1160 * Only the first commit can update the timestamp.
1161 * Yes there is a race here. If an interrupt comes in
1162 * just after the conditional and it traces too, then it
1163 * will also check the deltas. More than one timestamp may
1164 * also be made. But only the entry that did the actual
1165 * commit will be something other than zero.
1167 if (cpu_buffer->tail_page == cpu_buffer->commit_page &&
1168 rb_page_write(cpu_buffer->tail_page) ==
1169 rb_commit_index(cpu_buffer)) {
1171 delta = ts - cpu_buffer->write_stamp;
1173 /* make sure this delta is calculated here */
1176 /* Did the write stamp get updated already? */
1177 if (unlikely(ts < cpu_buffer->write_stamp))
1180 if (test_time_stamp(delta)) {
1182 commit = rb_add_time_stamp(cpu_buffer, &ts, &delta);
1184 if (commit == -EBUSY)
1187 if (commit == -EAGAIN)
1190 RB_WARN_ON(cpu_buffer, commit < 0);
1193 /* Non commits have zero deltas */
1196 event = __rb_reserve_next(cpu_buffer, type, length, &ts);
1197 if (PTR_ERR(event) == -EAGAIN)
1201 if (unlikely(commit))
1203 * Ouch! We needed a timestamp and it was commited. But
1204 * we didn't get our event reserved.
1206 rb_set_commit_to_write(cpu_buffer);
1211 * If the timestamp was commited, make the commit our entry
1212 * now so that we will update it when needed.
1215 rb_set_commit_event(cpu_buffer, event);
1216 else if (!rb_is_commit(cpu_buffer, event))
1219 event->time_delta = delta;
1224 static DEFINE_PER_CPU(int, rb_need_resched);
1227 * ring_buffer_lock_reserve - reserve a part of the buffer
1228 * @buffer: the ring buffer to reserve from
1229 * @length: the length of the data to reserve (excluding event header)
1230 * @flags: a pointer to save the interrupt flags
1232 * Returns a reseverd event on the ring buffer to copy directly to.
1233 * The user of this interface will need to get the body to write into
1234 * and can use the ring_buffer_event_data() interface.
1236 * The length is the length of the data needed, not the event length
1237 * which also includes the event header.
1239 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
1240 * If NULL is returned, then nothing has been allocated or locked.
1242 struct ring_buffer_event *
1243 ring_buffer_lock_reserve(struct ring_buffer *buffer,
1244 unsigned long length,
1245 unsigned long *flags)
1247 struct ring_buffer_per_cpu *cpu_buffer;
1248 struct ring_buffer_event *event;
1251 if (ring_buffer_flags != RB_BUFFERS_ON)
1254 if (atomic_read(&buffer->record_disabled))
1257 /* If we are tracing schedule, we don't want to recurse */
1258 resched = ftrace_preempt_disable();
1260 cpu = raw_smp_processor_id();
1262 if (!cpu_isset(cpu, buffer->cpumask))
1265 cpu_buffer = buffer->buffers[cpu];
1267 if (atomic_read(&cpu_buffer->record_disabled))
1270 length = rb_calculate_event_length(length);
1271 if (length > BUF_PAGE_SIZE)
1274 event = rb_reserve_next_event(cpu_buffer, RINGBUF_TYPE_DATA, length);
1279 * Need to store resched state on this cpu.
1280 * Only the first needs to.
1283 if (preempt_count() == 1)
1284 per_cpu(rb_need_resched, cpu) = resched;
1289 ftrace_preempt_enable(resched);
1293 static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
1294 struct ring_buffer_event *event)
1296 cpu_buffer->entries++;
1298 /* Only process further if we own the commit */
1299 if (!rb_is_commit(cpu_buffer, event))
1302 cpu_buffer->write_stamp += event->time_delta;
1304 rb_set_commit_to_write(cpu_buffer);
1308 * ring_buffer_unlock_commit - commit a reserved
1309 * @buffer: The buffer to commit to
1310 * @event: The event pointer to commit.
1311 * @flags: the interrupt flags received from ring_buffer_lock_reserve.
1313 * This commits the data to the ring buffer, and releases any locks held.
1315 * Must be paired with ring_buffer_lock_reserve.
1317 int ring_buffer_unlock_commit(struct ring_buffer *buffer,
1318 struct ring_buffer_event *event,
1319 unsigned long flags)
1321 struct ring_buffer_per_cpu *cpu_buffer;
1322 int cpu = raw_smp_processor_id();
1324 cpu_buffer = buffer->buffers[cpu];
1326 rb_commit(cpu_buffer, event);
1329 * Only the last preempt count needs to restore preemption.
1331 if (preempt_count() == 1)
1332 ftrace_preempt_enable(per_cpu(rb_need_resched, cpu));
1334 preempt_enable_no_resched_notrace();
1340 * ring_buffer_write - write data to the buffer without reserving
1341 * @buffer: The ring buffer to write to.
1342 * @length: The length of the data being written (excluding the event header)
1343 * @data: The data to write to the buffer.
1345 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
1346 * one function. If you already have the data to write to the buffer, it
1347 * may be easier to simply call this function.
1349 * Note, like ring_buffer_lock_reserve, the length is the length of the data
1350 * and not the length of the event which would hold the header.
1352 int ring_buffer_write(struct ring_buffer *buffer,
1353 unsigned long length,
1356 struct ring_buffer_per_cpu *cpu_buffer;
1357 struct ring_buffer_event *event;
1358 unsigned long event_length;
1363 if (ring_buffer_flags != RB_BUFFERS_ON)
1366 if (atomic_read(&buffer->record_disabled))
1369 resched = ftrace_preempt_disable();
1371 cpu = raw_smp_processor_id();
1373 if (!cpu_isset(cpu, buffer->cpumask))
1376 cpu_buffer = buffer->buffers[cpu];
1378 if (atomic_read(&cpu_buffer->record_disabled))
1381 event_length = rb_calculate_event_length(length);
1382 event = rb_reserve_next_event(cpu_buffer,
1383 RINGBUF_TYPE_DATA, event_length);
1387 body = rb_event_data(event);
1389 memcpy(body, data, length);
1391 rb_commit(cpu_buffer, event);
1395 ftrace_preempt_enable(resched);
1400 static inline int rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
1402 struct buffer_page *reader = cpu_buffer->reader_page;
1403 struct buffer_page *head = cpu_buffer->head_page;
1404 struct buffer_page *commit = cpu_buffer->commit_page;
1406 return reader->read == rb_page_commit(reader) &&
1407 (commit == reader ||
1409 head->read == rb_page_commit(commit)));
1413 * ring_buffer_record_disable - stop all writes into the buffer
1414 * @buffer: The ring buffer to stop writes to.
1416 * This prevents all writes to the buffer. Any attempt to write
1417 * to the buffer after this will fail and return NULL.
1419 * The caller should call synchronize_sched() after this.
1421 void ring_buffer_record_disable(struct ring_buffer *buffer)
1423 atomic_inc(&buffer->record_disabled);
1427 * ring_buffer_record_enable - enable writes to the buffer
1428 * @buffer: The ring buffer to enable writes
1430 * Note, multiple disables will need the same number of enables
1431 * to truely enable the writing (much like preempt_disable).
1433 void ring_buffer_record_enable(struct ring_buffer *buffer)
1435 atomic_dec(&buffer->record_disabled);
1439 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
1440 * @buffer: The ring buffer to stop writes to.
1441 * @cpu: The CPU buffer to stop
1443 * This prevents all writes to the buffer. Any attempt to write
1444 * to the buffer after this will fail and return NULL.
1446 * The caller should call synchronize_sched() after this.
1448 void ring_buffer_record_disable_cpu(struct ring_buffer *buffer, int cpu)
1450 struct ring_buffer_per_cpu *cpu_buffer;
1452 if (!cpu_isset(cpu, buffer->cpumask))
1455 cpu_buffer = buffer->buffers[cpu];
1456 atomic_inc(&cpu_buffer->record_disabled);
1460 * ring_buffer_record_enable_cpu - enable writes to the buffer
1461 * @buffer: The ring buffer to enable writes
1462 * @cpu: The CPU to enable.
1464 * Note, multiple disables will need the same number of enables
1465 * to truely enable the writing (much like preempt_disable).
1467 void ring_buffer_record_enable_cpu(struct ring_buffer *buffer, int cpu)
1469 struct ring_buffer_per_cpu *cpu_buffer;
1471 if (!cpu_isset(cpu, buffer->cpumask))
1474 cpu_buffer = buffer->buffers[cpu];
1475 atomic_dec(&cpu_buffer->record_disabled);
1479 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
1480 * @buffer: The ring buffer
1481 * @cpu: The per CPU buffer to get the entries from.
1483 unsigned long ring_buffer_entries_cpu(struct ring_buffer *buffer, int cpu)
1485 struct ring_buffer_per_cpu *cpu_buffer;
1487 if (!cpu_isset(cpu, buffer->cpumask))
1490 cpu_buffer = buffer->buffers[cpu];
1491 return cpu_buffer->entries;
1495 * ring_buffer_overrun_cpu - get the number of overruns in a cpu_buffer
1496 * @buffer: The ring buffer
1497 * @cpu: The per CPU buffer to get the number of overruns from
1499 unsigned long ring_buffer_overrun_cpu(struct ring_buffer *buffer, int cpu)
1501 struct ring_buffer_per_cpu *cpu_buffer;
1503 if (!cpu_isset(cpu, buffer->cpumask))
1506 cpu_buffer = buffer->buffers[cpu];
1507 return cpu_buffer->overrun;
1511 * ring_buffer_entries - get the number of entries in a buffer
1512 * @buffer: The ring buffer
1514 * Returns the total number of entries in the ring buffer
1517 unsigned long ring_buffer_entries(struct ring_buffer *buffer)
1519 struct ring_buffer_per_cpu *cpu_buffer;
1520 unsigned long entries = 0;
1523 /* if you care about this being correct, lock the buffer */
1524 for_each_buffer_cpu(buffer, cpu) {
1525 cpu_buffer = buffer->buffers[cpu];
1526 entries += cpu_buffer->entries;
1533 * ring_buffer_overrun_cpu - get the number of overruns in buffer
1534 * @buffer: The ring buffer
1536 * Returns the total number of overruns in the ring buffer
1539 unsigned long ring_buffer_overruns(struct ring_buffer *buffer)
1541 struct ring_buffer_per_cpu *cpu_buffer;
1542 unsigned long overruns = 0;
1545 /* if you care about this being correct, lock the buffer */
1546 for_each_buffer_cpu(buffer, cpu) {
1547 cpu_buffer = buffer->buffers[cpu];
1548 overruns += cpu_buffer->overrun;
1554 static void rb_iter_reset(struct ring_buffer_iter *iter)
1556 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1558 /* Iterator usage is expected to have record disabled */
1559 if (list_empty(&cpu_buffer->reader_page->list)) {
1560 iter->head_page = cpu_buffer->head_page;
1561 iter->head = cpu_buffer->head_page->read;
1563 iter->head_page = cpu_buffer->reader_page;
1564 iter->head = cpu_buffer->reader_page->read;
1567 iter->read_stamp = cpu_buffer->read_stamp;
1569 iter->read_stamp = iter->head_page->page->time_stamp;
1573 * ring_buffer_iter_reset - reset an iterator
1574 * @iter: The iterator to reset
1576 * Resets the iterator, so that it will start from the beginning
1579 void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
1581 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1582 unsigned long flags;
1584 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
1585 rb_iter_reset(iter);
1586 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
1590 * ring_buffer_iter_empty - check if an iterator has no more to read
1591 * @iter: The iterator to check
1593 int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
1595 struct ring_buffer_per_cpu *cpu_buffer;
1597 cpu_buffer = iter->cpu_buffer;
1599 return iter->head_page == cpu_buffer->commit_page &&
1600 iter->head == rb_commit_index(cpu_buffer);
1604 rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
1605 struct ring_buffer_event *event)
1609 switch (event->type) {
1610 case RINGBUF_TYPE_PADDING:
1613 case RINGBUF_TYPE_TIME_EXTEND:
1614 delta = event->array[0];
1616 delta += event->time_delta;
1617 cpu_buffer->read_stamp += delta;
1620 case RINGBUF_TYPE_TIME_STAMP:
1621 /* FIXME: not implemented */
1624 case RINGBUF_TYPE_DATA:
1625 cpu_buffer->read_stamp += event->time_delta;
1635 rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
1636 struct ring_buffer_event *event)
1640 switch (event->type) {
1641 case RINGBUF_TYPE_PADDING:
1644 case RINGBUF_TYPE_TIME_EXTEND:
1645 delta = event->array[0];
1647 delta += event->time_delta;
1648 iter->read_stamp += delta;
1651 case RINGBUF_TYPE_TIME_STAMP:
1652 /* FIXME: not implemented */
1655 case RINGBUF_TYPE_DATA:
1656 iter->read_stamp += event->time_delta;
1665 static struct buffer_page *
1666 rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
1668 struct buffer_page *reader = NULL;
1669 unsigned long flags;
1672 local_irq_save(flags);
1673 __raw_spin_lock(&cpu_buffer->lock);
1677 * This should normally only loop twice. But because the
1678 * start of the reader inserts an empty page, it causes
1679 * a case where we will loop three times. There should be no
1680 * reason to loop four times (that I know of).
1682 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
1687 reader = cpu_buffer->reader_page;
1689 /* If there's more to read, return this page */
1690 if (cpu_buffer->reader_page->read < rb_page_size(reader))
1693 /* Never should we have an index greater than the size */
1694 if (RB_WARN_ON(cpu_buffer,
1695 cpu_buffer->reader_page->read > rb_page_size(reader)))
1698 /* check if we caught up to the tail */
1700 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
1704 * Splice the empty reader page into the list around the head.
1705 * Reset the reader page to size zero.
1708 reader = cpu_buffer->head_page;
1709 cpu_buffer->reader_page->list.next = reader->list.next;
1710 cpu_buffer->reader_page->list.prev = reader->list.prev;
1712 local_set(&cpu_buffer->reader_page->write, 0);
1713 local_set(&cpu_buffer->reader_page->page->commit, 0);
1715 /* Make the reader page now replace the head */
1716 reader->list.prev->next = &cpu_buffer->reader_page->list;
1717 reader->list.next->prev = &cpu_buffer->reader_page->list;
1720 * If the tail is on the reader, then we must set the head
1721 * to the inserted page, otherwise we set it one before.
1723 cpu_buffer->head_page = cpu_buffer->reader_page;
1725 if (cpu_buffer->commit_page != reader)
1726 rb_inc_page(cpu_buffer, &cpu_buffer->head_page);
1728 /* Finally update the reader page to the new head */
1729 cpu_buffer->reader_page = reader;
1730 rb_reset_reader_page(cpu_buffer);
1735 __raw_spin_unlock(&cpu_buffer->lock);
1736 local_irq_restore(flags);
1741 static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
1743 struct ring_buffer_event *event;
1744 struct buffer_page *reader;
1747 reader = rb_get_reader_page(cpu_buffer);
1749 /* This function should not be called when buffer is empty */
1750 if (RB_WARN_ON(cpu_buffer, !reader))
1753 event = rb_reader_event(cpu_buffer);
1755 if (event->type == RINGBUF_TYPE_DATA)
1756 cpu_buffer->entries--;
1758 rb_update_read_stamp(cpu_buffer, event);
1760 length = rb_event_length(event);
1761 cpu_buffer->reader_page->read += length;
1764 static void rb_advance_iter(struct ring_buffer_iter *iter)
1766 struct ring_buffer *buffer;
1767 struct ring_buffer_per_cpu *cpu_buffer;
1768 struct ring_buffer_event *event;
1771 cpu_buffer = iter->cpu_buffer;
1772 buffer = cpu_buffer->buffer;
1775 * Check if we are at the end of the buffer.
1777 if (iter->head >= rb_page_size(iter->head_page)) {
1778 if (RB_WARN_ON(buffer,
1779 iter->head_page == cpu_buffer->commit_page))
1785 event = rb_iter_head_event(iter);
1787 length = rb_event_length(event);
1790 * This should not be called to advance the header if we are
1791 * at the tail of the buffer.
1793 if (RB_WARN_ON(cpu_buffer,
1794 (iter->head_page == cpu_buffer->commit_page) &&
1795 (iter->head + length > rb_commit_index(cpu_buffer))))
1798 rb_update_iter_read_stamp(iter, event);
1800 iter->head += length;
1802 /* check for end of page padding */
1803 if ((iter->head >= rb_page_size(iter->head_page)) &&
1804 (iter->head_page != cpu_buffer->commit_page))
1805 rb_advance_iter(iter);
1808 static struct ring_buffer_event *
1809 rb_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
1811 struct ring_buffer_per_cpu *cpu_buffer;
1812 struct ring_buffer_event *event;
1813 struct buffer_page *reader;
1816 if (!cpu_isset(cpu, buffer->cpumask))
1819 cpu_buffer = buffer->buffers[cpu];
1823 * We repeat when a timestamp is encountered. It is possible
1824 * to get multiple timestamps from an interrupt entering just
1825 * as one timestamp is about to be written. The max times
1826 * that this can happen is the number of nested interrupts we
1827 * can have. Nesting 10 deep of interrupts is clearly
1830 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
1833 reader = rb_get_reader_page(cpu_buffer);
1837 event = rb_reader_event(cpu_buffer);
1839 switch (event->type) {
1840 case RINGBUF_TYPE_PADDING:
1841 RB_WARN_ON(cpu_buffer, 1);
1842 rb_advance_reader(cpu_buffer);
1845 case RINGBUF_TYPE_TIME_EXTEND:
1846 /* Internal data, OK to advance */
1847 rb_advance_reader(cpu_buffer);
1850 case RINGBUF_TYPE_TIME_STAMP:
1851 /* FIXME: not implemented */
1852 rb_advance_reader(cpu_buffer);
1855 case RINGBUF_TYPE_DATA:
1857 *ts = cpu_buffer->read_stamp + event->time_delta;
1858 ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
1869 static struct ring_buffer_event *
1870 rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
1872 struct ring_buffer *buffer;
1873 struct ring_buffer_per_cpu *cpu_buffer;
1874 struct ring_buffer_event *event;
1877 if (ring_buffer_iter_empty(iter))
1880 cpu_buffer = iter->cpu_buffer;
1881 buffer = cpu_buffer->buffer;
1885 * We repeat when a timestamp is encountered. It is possible
1886 * to get multiple timestamps from an interrupt entering just
1887 * as one timestamp is about to be written. The max times
1888 * that this can happen is the number of nested interrupts we
1889 * can have. Nesting 10 deep of interrupts is clearly
1892 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 10))
1895 if (rb_per_cpu_empty(cpu_buffer))
1898 event = rb_iter_head_event(iter);
1900 switch (event->type) {
1901 case RINGBUF_TYPE_PADDING:
1905 case RINGBUF_TYPE_TIME_EXTEND:
1906 /* Internal data, OK to advance */
1907 rb_advance_iter(iter);
1910 case RINGBUF_TYPE_TIME_STAMP:
1911 /* FIXME: not implemented */
1912 rb_advance_iter(iter);
1915 case RINGBUF_TYPE_DATA:
1917 *ts = iter->read_stamp + event->time_delta;
1918 ring_buffer_normalize_time_stamp(cpu_buffer->cpu, ts);
1930 * ring_buffer_peek - peek at the next event to be read
1931 * @buffer: The ring buffer to read
1932 * @cpu: The cpu to peak at
1933 * @ts: The timestamp counter of this event.
1935 * This will return the event that will be read next, but does
1936 * not consume the data.
1938 struct ring_buffer_event *
1939 ring_buffer_peek(struct ring_buffer *buffer, int cpu, u64 *ts)
1941 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
1942 struct ring_buffer_event *event;
1943 unsigned long flags;
1945 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
1946 event = rb_buffer_peek(buffer, cpu, ts);
1947 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
1953 * ring_buffer_iter_peek - peek at the next event to be read
1954 * @iter: The ring buffer iterator
1955 * @ts: The timestamp counter of this event.
1957 * This will return the event that will be read next, but does
1958 * not increment the iterator.
1960 struct ring_buffer_event *
1961 ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
1963 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
1964 struct ring_buffer_event *event;
1965 unsigned long flags;
1967 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
1968 event = rb_iter_peek(iter, ts);
1969 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
1975 * ring_buffer_consume - return an event and consume it
1976 * @buffer: The ring buffer to get the next event from
1978 * Returns the next event in the ring buffer, and that event is consumed.
1979 * Meaning, that sequential reads will keep returning a different event,
1980 * and eventually empty the ring buffer if the producer is slower.
1982 struct ring_buffer_event *
1983 ring_buffer_consume(struct ring_buffer *buffer, int cpu, u64 *ts)
1985 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
1986 struct ring_buffer_event *event;
1987 unsigned long flags;
1989 if (!cpu_isset(cpu, buffer->cpumask))
1992 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
1994 event = rb_buffer_peek(buffer, cpu, ts);
1998 rb_advance_reader(cpu_buffer);
2001 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2007 * ring_buffer_read_start - start a non consuming read of the buffer
2008 * @buffer: The ring buffer to read from
2009 * @cpu: The cpu buffer to iterate over
2011 * This starts up an iteration through the buffer. It also disables
2012 * the recording to the buffer until the reading is finished.
2013 * This prevents the reading from being corrupted. This is not
2014 * a consuming read, so a producer is not expected.
2016 * Must be paired with ring_buffer_finish.
2018 struct ring_buffer_iter *
2019 ring_buffer_read_start(struct ring_buffer *buffer, int cpu)
2021 struct ring_buffer_per_cpu *cpu_buffer;
2022 struct ring_buffer_iter *iter;
2023 unsigned long flags;
2025 if (!cpu_isset(cpu, buffer->cpumask))
2028 iter = kmalloc(sizeof(*iter), GFP_KERNEL);
2032 cpu_buffer = buffer->buffers[cpu];
2034 iter->cpu_buffer = cpu_buffer;
2036 atomic_inc(&cpu_buffer->record_disabled);
2037 synchronize_sched();
2039 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2040 __raw_spin_lock(&cpu_buffer->lock);
2041 rb_iter_reset(iter);
2042 __raw_spin_unlock(&cpu_buffer->lock);
2043 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2049 * ring_buffer_finish - finish reading the iterator of the buffer
2050 * @iter: The iterator retrieved by ring_buffer_start
2052 * This re-enables the recording to the buffer, and frees the
2056 ring_buffer_read_finish(struct ring_buffer_iter *iter)
2058 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2060 atomic_dec(&cpu_buffer->record_disabled);
2065 * ring_buffer_read - read the next item in the ring buffer by the iterator
2066 * @iter: The ring buffer iterator
2067 * @ts: The time stamp of the event read.
2069 * This reads the next event in the ring buffer and increments the iterator.
2071 struct ring_buffer_event *
2072 ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)
2074 struct ring_buffer_event *event;
2075 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2076 unsigned long flags;
2078 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2079 event = rb_iter_peek(iter, ts);
2083 rb_advance_iter(iter);
2085 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2091 * ring_buffer_size - return the size of the ring buffer (in bytes)
2092 * @buffer: The ring buffer.
2094 unsigned long ring_buffer_size(struct ring_buffer *buffer)
2096 return BUF_PAGE_SIZE * buffer->pages;
2100 rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
2102 cpu_buffer->head_page
2103 = list_entry(cpu_buffer->pages.next, struct buffer_page, list);
2104 local_set(&cpu_buffer->head_page->write, 0);
2105 local_set(&cpu_buffer->head_page->page->commit, 0);
2107 cpu_buffer->head_page->read = 0;
2109 cpu_buffer->tail_page = cpu_buffer->head_page;
2110 cpu_buffer->commit_page = cpu_buffer->head_page;
2112 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
2113 local_set(&cpu_buffer->reader_page->write, 0);
2114 local_set(&cpu_buffer->reader_page->page->commit, 0);
2115 cpu_buffer->reader_page->read = 0;
2117 cpu_buffer->overrun = 0;
2118 cpu_buffer->entries = 0;
2122 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
2123 * @buffer: The ring buffer to reset a per cpu buffer of
2124 * @cpu: The CPU buffer to be reset
2126 void ring_buffer_reset_cpu(struct ring_buffer *buffer, int cpu)
2128 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2129 unsigned long flags;
2131 if (!cpu_isset(cpu, buffer->cpumask))
2134 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2136 __raw_spin_lock(&cpu_buffer->lock);
2138 rb_reset_cpu(cpu_buffer);
2140 __raw_spin_unlock(&cpu_buffer->lock);
2142 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2146 * ring_buffer_reset - reset a ring buffer
2147 * @buffer: The ring buffer to reset all cpu buffers
2149 void ring_buffer_reset(struct ring_buffer *buffer)
2153 for_each_buffer_cpu(buffer, cpu)
2154 ring_buffer_reset_cpu(buffer, cpu);
2158 * rind_buffer_empty - is the ring buffer empty?
2159 * @buffer: The ring buffer to test
2161 int ring_buffer_empty(struct ring_buffer *buffer)
2163 struct ring_buffer_per_cpu *cpu_buffer;
2166 /* yes this is racy, but if you don't like the race, lock the buffer */
2167 for_each_buffer_cpu(buffer, cpu) {
2168 cpu_buffer = buffer->buffers[cpu];
2169 if (!rb_per_cpu_empty(cpu_buffer))
2176 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
2177 * @buffer: The ring buffer
2178 * @cpu: The CPU buffer to test
2180 int ring_buffer_empty_cpu(struct ring_buffer *buffer, int cpu)
2182 struct ring_buffer_per_cpu *cpu_buffer;
2184 if (!cpu_isset(cpu, buffer->cpumask))
2187 cpu_buffer = buffer->buffers[cpu];
2188 return rb_per_cpu_empty(cpu_buffer);
2192 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
2193 * @buffer_a: One buffer to swap with
2194 * @buffer_b: The other buffer to swap with
2196 * This function is useful for tracers that want to take a "snapshot"
2197 * of a CPU buffer and has another back up buffer lying around.
2198 * it is expected that the tracer handles the cpu buffer not being
2199 * used at the moment.
2201 int ring_buffer_swap_cpu(struct ring_buffer *buffer_a,
2202 struct ring_buffer *buffer_b, int cpu)
2204 struct ring_buffer_per_cpu *cpu_buffer_a;
2205 struct ring_buffer_per_cpu *cpu_buffer_b;
2207 if (!cpu_isset(cpu, buffer_a->cpumask) ||
2208 !cpu_isset(cpu, buffer_b->cpumask))
2211 /* At least make sure the two buffers are somewhat the same */
2212 if (buffer_a->pages != buffer_b->pages)
2215 cpu_buffer_a = buffer_a->buffers[cpu];
2216 cpu_buffer_b = buffer_b->buffers[cpu];
2219 * We can't do a synchronize_sched here because this
2220 * function can be called in atomic context.
2221 * Normally this will be called from the same CPU as cpu.
2222 * If not it's up to the caller to protect this.
2224 atomic_inc(&cpu_buffer_a->record_disabled);
2225 atomic_inc(&cpu_buffer_b->record_disabled);
2227 buffer_a->buffers[cpu] = cpu_buffer_b;
2228 buffer_b->buffers[cpu] = cpu_buffer_a;
2230 cpu_buffer_b->buffer = buffer_a;
2231 cpu_buffer_a->buffer = buffer_b;
2233 atomic_dec(&cpu_buffer_a->record_disabled);
2234 atomic_dec(&cpu_buffer_b->record_disabled);
2239 static void rb_remove_entries(struct ring_buffer_per_cpu *cpu_buffer,
2240 struct buffer_data_page *bpage)
2242 struct ring_buffer_event *event;
2245 __raw_spin_lock(&cpu_buffer->lock);
2246 for (head = 0; head < local_read(&bpage->commit);
2247 head += rb_event_length(event)) {
2249 event = __rb_data_page_index(bpage, head);
2250 if (RB_WARN_ON(cpu_buffer, rb_null_event(event)))
2252 /* Only count data entries */
2253 if (event->type != RINGBUF_TYPE_DATA)
2255 cpu_buffer->entries--;
2257 __raw_spin_unlock(&cpu_buffer->lock);
2261 * ring_buffer_alloc_read_page - allocate a page to read from buffer
2262 * @buffer: the buffer to allocate for.
2264 * This function is used in conjunction with ring_buffer_read_page.
2265 * When reading a full page from the ring buffer, these functions
2266 * can be used to speed up the process. The calling function should
2267 * allocate a few pages first with this function. Then when it
2268 * needs to get pages from the ring buffer, it passes the result
2269 * of this function into ring_buffer_read_page, which will swap
2270 * the page that was allocated, with the read page of the buffer.
2273 * The page allocated, or NULL on error.
2275 void *ring_buffer_alloc_read_page(struct ring_buffer *buffer)
2278 struct buffer_data_page *bpage;
2280 addr = __get_free_page(GFP_KERNEL);
2284 bpage = (void *)addr;
2290 * ring_buffer_free_read_page - free an allocated read page
2291 * @buffer: the buffer the page was allocate for
2292 * @data: the page to free
2294 * Free a page allocated from ring_buffer_alloc_read_page.
2296 void ring_buffer_free_read_page(struct ring_buffer *buffer, void *data)
2298 free_page((unsigned long)data);
2302 * ring_buffer_read_page - extract a page from the ring buffer
2303 * @buffer: buffer to extract from
2304 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
2305 * @cpu: the cpu of the buffer to extract
2306 * @full: should the extraction only happen when the page is full.
2308 * This function will pull out a page from the ring buffer and consume it.
2309 * @data_page must be the address of the variable that was returned
2310 * from ring_buffer_alloc_read_page. This is because the page might be used
2311 * to swap with a page in the ring buffer.
2314 * rpage = ring_buffer_alloc_page(buffer);
2317 * ret = ring_buffer_read_page(buffer, &rpage, cpu, 0);
2319 * process_page(rpage);
2321 * When @full is set, the function will not return true unless
2322 * the writer is off the reader page.
2324 * Note: it is up to the calling functions to handle sleeps and wakeups.
2325 * The ring buffer can be used anywhere in the kernel and can not
2326 * blindly call wake_up. The layer that uses the ring buffer must be
2327 * responsible for that.
2330 * 1 if data has been transferred
2331 * 0 if no data has been transferred.
2333 int ring_buffer_read_page(struct ring_buffer *buffer,
2334 void **data_page, int cpu, int full)
2336 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
2337 struct ring_buffer_event *event;
2338 struct buffer_data_page *bpage;
2339 unsigned long flags;
2349 spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
2352 * rb_buffer_peek will get the next ring buffer if
2353 * the current reader page is empty.
2355 event = rb_buffer_peek(buffer, cpu, NULL);
2359 /* check for data */
2360 if (!local_read(&cpu_buffer->reader_page->page->commit))
2363 * If the writer is already off of the read page, then simply
2364 * switch the read page with the given page. Otherwise
2365 * we need to copy the data from the reader to the writer.
2367 if (cpu_buffer->reader_page == cpu_buffer->commit_page) {
2368 unsigned int read = cpu_buffer->reader_page->read;
2372 /* The writer is still on the reader page, we must copy */
2373 bpage = cpu_buffer->reader_page->page;
2375 cpu_buffer->reader_page->page->data + read,
2376 local_read(&bpage->commit) - read);
2378 /* consume what was read */
2379 cpu_buffer->reader_page += read;
2382 /* swap the pages */
2383 rb_init_page(bpage);
2384 bpage = cpu_buffer->reader_page->page;
2385 cpu_buffer->reader_page->page = *data_page;
2386 cpu_buffer->reader_page->read = 0;
2391 /* update the entry counter */
2392 rb_remove_entries(cpu_buffer, bpage);
2394 spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
2400 rb_simple_read(struct file *filp, char __user *ubuf,
2401 size_t cnt, loff_t *ppos)
2403 long *p = filp->private_data;
2407 if (test_bit(RB_BUFFERS_DISABLED_BIT, p))
2408 r = sprintf(buf, "permanently disabled\n");
2410 r = sprintf(buf, "%d\n", test_bit(RB_BUFFERS_ON_BIT, p));
2412 return simple_read_from_buffer(ubuf, cnt, ppos, buf, r);
2416 rb_simple_write(struct file *filp, const char __user *ubuf,
2417 size_t cnt, loff_t *ppos)
2419 long *p = filp->private_data;
2424 if (cnt >= sizeof(buf))
2427 if (copy_from_user(&buf, ubuf, cnt))
2432 ret = strict_strtoul(buf, 10, &val);
2437 set_bit(RB_BUFFERS_ON_BIT, p);
2439 clear_bit(RB_BUFFERS_ON_BIT, p);
2446 static struct file_operations rb_simple_fops = {
2447 .open = tracing_open_generic,
2448 .read = rb_simple_read,
2449 .write = rb_simple_write,
2453 static __init int rb_init_debugfs(void)
2455 struct dentry *d_tracer;
2456 struct dentry *entry;
2458 d_tracer = tracing_init_dentry();
2460 entry = debugfs_create_file("tracing_on", 0644, d_tracer,
2461 &ring_buffer_flags, &rb_simple_fops);
2463 pr_warning("Could not create debugfs 'tracing_on' entry\n");
2468 fs_initcall(rb_init_debugfs);