1 // SPDX-License-Identifier: GPL-2.0
5 * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
7 #include <linux/trace_recursion.h>
8 #include <linux/trace_events.h>
9 #include <linux/ring_buffer.h>
10 #include <linux/trace_clock.h>
11 #include <linux/sched/clock.h>
12 #include <linux/trace_seq.h>
13 #include <linux/spinlock.h>
14 #include <linux/irq_work.h>
15 #include <linux/security.h>
16 #include <linux/uaccess.h>
17 #include <linux/hardirq.h>
18 #include <linux/kthread.h> /* for self test */
19 #include <linux/module.h>
20 #include <linux/percpu.h>
21 #include <linux/mutex.h>
22 #include <linux/delay.h>
23 #include <linux/slab.h>
24 #include <linux/init.h>
25 #include <linux/hash.h>
26 #include <linux/list.h>
27 #include <linux/cpu.h>
28 #include <linux/oom.h>
30 #include <asm/local.h>
32 static void update_pages_handler(struct work_struct *work);
35 * The ring buffer header is special. We must manually up keep it.
37 int ring_buffer_print_entry_header(struct trace_seq *s)
39 trace_seq_puts(s, "# compressed entry header\n");
40 trace_seq_puts(s, "\ttype_len : 5 bits\n");
41 trace_seq_puts(s, "\ttime_delta : 27 bits\n");
42 trace_seq_puts(s, "\tarray : 32 bits\n");
43 trace_seq_putc(s, '\n');
44 trace_seq_printf(s, "\tpadding : type == %d\n",
45 RINGBUF_TYPE_PADDING);
46 trace_seq_printf(s, "\ttime_extend : type == %d\n",
47 RINGBUF_TYPE_TIME_EXTEND);
48 trace_seq_printf(s, "\ttime_stamp : type == %d\n",
49 RINGBUF_TYPE_TIME_STAMP);
50 trace_seq_printf(s, "\tdata max type_len == %d\n",
51 RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
53 return !trace_seq_has_overflowed(s);
57 * The ring buffer is made up of a list of pages. A separate list of pages is
58 * allocated for each CPU. A writer may only write to a buffer that is
59 * associated with the CPU it is currently executing on. A reader may read
60 * from any per cpu buffer.
62 * The reader is special. For each per cpu buffer, the reader has its own
63 * reader page. When a reader has read the entire reader page, this reader
64 * page is swapped with another page in the ring buffer.
66 * Now, as long as the writer is off the reader page, the reader can do what
67 * ever it wants with that page. The writer will never write to that page
68 * again (as long as it is out of the ring buffer).
70 * Here's some silly ASCII art.
73 * |reader| RING BUFFER
75 * +------+ +---+ +---+ +---+
84 * |reader| RING BUFFER
85 * |page |------------------v
86 * +------+ +---+ +---+ +---+
95 * |reader| RING BUFFER
96 * |page |------------------v
97 * +------+ +---+ +---+ +---+
102 * +------------------------------+
106 * |buffer| RING BUFFER
107 * |page |------------------v
108 * +------+ +---+ +---+ +---+
110 * | New +---+ +---+ +---+
113 * +------------------------------+
116 * After we make this swap, the reader can hand this page off to the splice
117 * code and be done with it. It can even allocate a new page if it needs to
118 * and swap that into the ring buffer.
120 * We will be using cmpxchg soon to make all this lockless.
124 /* Used for individual buffers (after the counter) */
125 #define RB_BUFFER_OFF (1 << 20)
127 #define BUF_PAGE_HDR_SIZE offsetof(struct buffer_data_page, data)
129 #define RB_EVNT_HDR_SIZE (offsetof(struct ring_buffer_event, array))
130 #define RB_ALIGNMENT 4U
131 #define RB_MAX_SMALL_DATA (RB_ALIGNMENT * RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
132 #define RB_EVNT_MIN_SIZE 8U /* two 32bit words */
134 #ifndef CONFIG_HAVE_64BIT_ALIGNED_ACCESS
135 # define RB_FORCE_8BYTE_ALIGNMENT 0
136 # define RB_ARCH_ALIGNMENT RB_ALIGNMENT
138 # define RB_FORCE_8BYTE_ALIGNMENT 1
139 # define RB_ARCH_ALIGNMENT 8U
142 #define RB_ALIGN_DATA __aligned(RB_ARCH_ALIGNMENT)
144 /* define RINGBUF_TYPE_DATA for 'case RINGBUF_TYPE_DATA:' */
145 #define RINGBUF_TYPE_DATA 0 ... RINGBUF_TYPE_DATA_TYPE_LEN_MAX
148 RB_LEN_TIME_EXTEND = 8,
149 RB_LEN_TIME_STAMP = 8,
152 #define skip_time_extend(event) \
153 ((struct ring_buffer_event *)((char *)event + RB_LEN_TIME_EXTEND))
155 #define extended_time(event) \
156 (event->type_len >= RINGBUF_TYPE_TIME_EXTEND)
158 static inline int rb_null_event(struct ring_buffer_event *event)
160 return event->type_len == RINGBUF_TYPE_PADDING && !event->time_delta;
163 static void rb_event_set_padding(struct ring_buffer_event *event)
165 /* padding has a NULL time_delta */
166 event->type_len = RINGBUF_TYPE_PADDING;
167 event->time_delta = 0;
171 rb_event_data_length(struct ring_buffer_event *event)
176 length = event->type_len * RB_ALIGNMENT;
178 length = event->array[0];
179 return length + RB_EVNT_HDR_SIZE;
183 * Return the length of the given event. Will return
184 * the length of the time extend if the event is a
187 static inline unsigned
188 rb_event_length(struct ring_buffer_event *event)
190 switch (event->type_len) {
191 case RINGBUF_TYPE_PADDING:
192 if (rb_null_event(event))
195 return event->array[0] + RB_EVNT_HDR_SIZE;
197 case RINGBUF_TYPE_TIME_EXTEND:
198 return RB_LEN_TIME_EXTEND;
200 case RINGBUF_TYPE_TIME_STAMP:
201 return RB_LEN_TIME_STAMP;
203 case RINGBUF_TYPE_DATA:
204 return rb_event_data_length(event);
213 * Return total length of time extend and data,
214 * or just the event length for all other events.
216 static inline unsigned
217 rb_event_ts_length(struct ring_buffer_event *event)
221 if (extended_time(event)) {
222 /* time extends include the data event after it */
223 len = RB_LEN_TIME_EXTEND;
224 event = skip_time_extend(event);
226 return len + rb_event_length(event);
230 * ring_buffer_event_length - return the length of the event
231 * @event: the event to get the length of
233 * Returns the size of the data load of a data event.
234 * If the event is something other than a data event, it
235 * returns the size of the event itself. With the exception
236 * of a TIME EXTEND, where it still returns the size of the
237 * data load of the data event after it.
239 unsigned ring_buffer_event_length(struct ring_buffer_event *event)
243 if (extended_time(event))
244 event = skip_time_extend(event);
246 length = rb_event_length(event);
247 if (event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
249 length -= RB_EVNT_HDR_SIZE;
250 if (length > RB_MAX_SMALL_DATA + sizeof(event->array[0]))
251 length -= sizeof(event->array[0]);
254 EXPORT_SYMBOL_GPL(ring_buffer_event_length);
256 /* inline for ring buffer fast paths */
257 static __always_inline void *
258 rb_event_data(struct ring_buffer_event *event)
260 if (extended_time(event))
261 event = skip_time_extend(event);
262 WARN_ON_ONCE(event->type_len > RINGBUF_TYPE_DATA_TYPE_LEN_MAX);
263 /* If length is in len field, then array[0] has the data */
265 return (void *)&event->array[0];
266 /* Otherwise length is in array[0] and array[1] has the data */
267 return (void *)&event->array[1];
271 * ring_buffer_event_data - return the data of the event
272 * @event: the event to get the data from
274 void *ring_buffer_event_data(struct ring_buffer_event *event)
276 return rb_event_data(event);
278 EXPORT_SYMBOL_GPL(ring_buffer_event_data);
280 #define for_each_buffer_cpu(buffer, cpu) \
281 for_each_cpu(cpu, buffer->cpumask)
283 #define for_each_online_buffer_cpu(buffer, cpu) \
284 for_each_cpu_and(cpu, buffer->cpumask, cpu_online_mask)
287 #define TS_MASK ((1ULL << TS_SHIFT) - 1)
288 #define TS_DELTA_TEST (~TS_MASK)
291 * ring_buffer_event_time_stamp - return the event's extended timestamp
292 * @event: the event to get the timestamp of
294 * Returns the extended timestamp associated with a data event.
295 * An extended time_stamp is a 64-bit timestamp represented
296 * internally in a special way that makes the best use of space
297 * contained within a ring buffer event. This function decodes
298 * it and maps it to a straight u64 value.
300 u64 ring_buffer_event_time_stamp(struct ring_buffer_event *event)
304 ts = event->array[0];
306 ts += event->time_delta;
311 /* Flag when events were overwritten */
312 #define RB_MISSED_EVENTS (1 << 31)
313 /* Missed count stored at end */
314 #define RB_MISSED_STORED (1 << 30)
316 struct buffer_data_page {
317 u64 time_stamp; /* page time stamp */
318 local_t commit; /* write committed index */
319 unsigned char data[] RB_ALIGN_DATA; /* data of buffer page */
323 * Note, the buffer_page list must be first. The buffer pages
324 * are allocated in cache lines, which means that each buffer
325 * page will be at the beginning of a cache line, and thus
326 * the least significant bits will be zero. We use this to
327 * add flags in the list struct pointers, to make the ring buffer
331 struct list_head list; /* list of buffer pages */
332 local_t write; /* index for next write */
333 unsigned read; /* index for next read */
334 local_t entries; /* entries on this page */
335 unsigned long real_end; /* real end of data */
336 struct buffer_data_page *page; /* Actual data page */
340 * The buffer page counters, write and entries, must be reset
341 * atomically when crossing page boundaries. To synchronize this
342 * update, two counters are inserted into the number. One is
343 * the actual counter for the write position or count on the page.
345 * The other is a counter of updaters. Before an update happens
346 * the update partition of the counter is incremented. This will
347 * allow the updater to update the counter atomically.
349 * The counter is 20 bits, and the state data is 12.
351 #define RB_WRITE_MASK 0xfffff
352 #define RB_WRITE_INTCNT (1 << 20)
354 static void rb_init_page(struct buffer_data_page *bpage)
356 local_set(&bpage->commit, 0);
360 * Also stolen from mm/slob.c. Thanks to Mathieu Desnoyers for pointing
363 static void free_buffer_page(struct buffer_page *bpage)
365 free_page((unsigned long)bpage->page);
370 * We need to fit the time_stamp delta into 27 bits.
372 static inline int test_time_stamp(u64 delta)
374 if (delta & TS_DELTA_TEST)
379 #define BUF_PAGE_SIZE (PAGE_SIZE - BUF_PAGE_HDR_SIZE)
381 /* Max payload is BUF_PAGE_SIZE - header (8bytes) */
382 #define BUF_MAX_DATA_SIZE (BUF_PAGE_SIZE - (sizeof(u32) * 2))
384 int ring_buffer_print_page_header(struct trace_seq *s)
386 struct buffer_data_page field;
388 trace_seq_printf(s, "\tfield: u64 timestamp;\t"
389 "offset:0;\tsize:%u;\tsigned:%u;\n",
390 (unsigned int)sizeof(field.time_stamp),
391 (unsigned int)is_signed_type(u64));
393 trace_seq_printf(s, "\tfield: local_t commit;\t"
394 "offset:%u;\tsize:%u;\tsigned:%u;\n",
395 (unsigned int)offsetof(typeof(field), commit),
396 (unsigned int)sizeof(field.commit),
397 (unsigned int)is_signed_type(long));
399 trace_seq_printf(s, "\tfield: int overwrite;\t"
400 "offset:%u;\tsize:%u;\tsigned:%u;\n",
401 (unsigned int)offsetof(typeof(field), commit),
403 (unsigned int)is_signed_type(long));
405 trace_seq_printf(s, "\tfield: char data;\t"
406 "offset:%u;\tsize:%u;\tsigned:%u;\n",
407 (unsigned int)offsetof(typeof(field), data),
408 (unsigned int)BUF_PAGE_SIZE,
409 (unsigned int)is_signed_type(char));
411 return !trace_seq_has_overflowed(s);
415 struct irq_work work;
416 wait_queue_head_t waiters;
417 wait_queue_head_t full_waiters;
418 bool waiters_pending;
419 bool full_waiters_pending;
424 * Structure to hold event state and handle nested events.
426 struct rb_event_info {
431 unsigned long length;
432 struct buffer_page *tail_page;
437 * Used for the add_timestamp
439 * EXTEND - wants a time extend
440 * ABSOLUTE - the buffer requests all events to have absolute time stamps
441 * FORCE - force a full time stamp.
444 RB_ADD_STAMP_NONE = 0,
445 RB_ADD_STAMP_EXTEND = BIT(1),
446 RB_ADD_STAMP_ABSOLUTE = BIT(2),
447 RB_ADD_STAMP_FORCE = BIT(3)
450 * Used for which event context the event is in.
457 * See trace_recursive_lock() comment below for more details.
468 #if BITS_PER_LONG == 32
472 /* To test on 64 bit machines */
477 struct rb_time_struct {
483 #include <asm/local64.h>
484 struct rb_time_struct {
488 typedef struct rb_time_struct rb_time_t;
491 * head_page == tail_page && head == tail then buffer is empty.
493 struct ring_buffer_per_cpu {
495 atomic_t record_disabled;
496 atomic_t resize_disabled;
497 struct trace_buffer *buffer;
498 raw_spinlock_t reader_lock; /* serialize readers */
499 arch_spinlock_t lock;
500 struct lock_class_key lock_key;
501 struct buffer_data_page *free_page;
502 unsigned long nr_pages;
503 unsigned int current_context;
504 struct list_head *pages;
505 struct buffer_page *head_page; /* read from head */
506 struct buffer_page *tail_page; /* write to tail */
507 struct buffer_page *commit_page; /* committed pages */
508 struct buffer_page *reader_page;
509 unsigned long lost_events;
510 unsigned long last_overrun;
512 local_t entries_bytes;
515 local_t commit_overrun;
516 local_t dropped_events;
519 local_t pages_touched;
521 long last_pages_touch;
522 size_t shortest_full;
524 unsigned long read_bytes;
525 rb_time_t write_stamp;
526 rb_time_t before_stamp;
528 /* ring buffer pages to update, > 0 to add, < 0 to remove */
529 long nr_pages_to_update;
530 struct list_head new_pages; /* new pages to add */
531 struct work_struct update_pages_work;
532 struct completion update_done;
534 struct rb_irq_work irq_work;
537 struct trace_buffer {
540 atomic_t record_disabled;
541 cpumask_var_t cpumask;
543 struct lock_class_key *reader_lock_key;
547 struct ring_buffer_per_cpu **buffers;
549 struct hlist_node node;
552 struct rb_irq_work irq_work;
556 struct ring_buffer_iter {
557 struct ring_buffer_per_cpu *cpu_buffer;
559 unsigned long next_event;
560 struct buffer_page *head_page;
561 struct buffer_page *cache_reader_page;
562 unsigned long cache_read;
565 struct ring_buffer_event *event;
572 * On 32 bit machines, local64_t is very expensive. As the ring
573 * buffer doesn't need all the features of a true 64 bit atomic,
574 * on 32 bit, it uses these functions (64 still uses local64_t).
576 * For the ring buffer, 64 bit required operations for the time is
579 * - Only need 59 bits (uses 60 to make it even).
580 * - Reads may fail if it interrupted a modification of the time stamp.
581 * It will succeed if it did not interrupt another write even if
582 * the read itself is interrupted by a write.
583 * It returns whether it was successful or not.
585 * - Writes always succeed and will overwrite other writes and writes
586 * that were done by events interrupting the current write.
588 * - A write followed by a read of the same time stamp will always succeed,
589 * but may not contain the same value.
591 * - A cmpxchg will fail if it interrupted another write or cmpxchg.
592 * Other than that, it acts like a normal cmpxchg.
594 * The 60 bit time stamp is broken up by 30 bits in a top and bottom half
595 * (bottom being the least significant 30 bits of the 60 bit time stamp).
597 * The two most significant bits of each half holds a 2 bit counter (0-3).
598 * Each update will increment this counter by one.
599 * When reading the top and bottom, if the two counter bits match then the
600 * top and bottom together make a valid 60 bit number.
602 #define RB_TIME_SHIFT 30
603 #define RB_TIME_VAL_MASK ((1 << RB_TIME_SHIFT) - 1)
605 static inline int rb_time_cnt(unsigned long val)
607 return (val >> RB_TIME_SHIFT) & 3;
610 static inline u64 rb_time_val(unsigned long top, unsigned long bottom)
614 val = top & RB_TIME_VAL_MASK;
615 val <<= RB_TIME_SHIFT;
616 val |= bottom & RB_TIME_VAL_MASK;
621 static inline bool __rb_time_read(rb_time_t *t, u64 *ret, unsigned long *cnt)
623 unsigned long top, bottom;
627 * If the read is interrupted by a write, then the cnt will
628 * be different. Loop until both top and bottom have been read
629 * without interruption.
632 c = local_read(&t->cnt);
633 top = local_read(&t->top);
634 bottom = local_read(&t->bottom);
635 } while (c != local_read(&t->cnt));
637 *cnt = rb_time_cnt(top);
639 /* If top and bottom counts don't match, this interrupted a write */
640 if (*cnt != rb_time_cnt(bottom))
643 *ret = rb_time_val(top, bottom);
647 static bool rb_time_read(rb_time_t *t, u64 *ret)
651 return __rb_time_read(t, ret, &cnt);
654 static inline unsigned long rb_time_val_cnt(unsigned long val, unsigned long cnt)
656 return (val & RB_TIME_VAL_MASK) | ((cnt & 3) << RB_TIME_SHIFT);
659 static inline void rb_time_split(u64 val, unsigned long *top, unsigned long *bottom)
661 *top = (unsigned long)((val >> RB_TIME_SHIFT) & RB_TIME_VAL_MASK);
662 *bottom = (unsigned long)(val & RB_TIME_VAL_MASK);
665 static inline void rb_time_val_set(local_t *t, unsigned long val, unsigned long cnt)
667 val = rb_time_val_cnt(val, cnt);
671 static void rb_time_set(rb_time_t *t, u64 val)
673 unsigned long cnt, top, bottom;
675 rb_time_split(val, &top, &bottom);
677 /* Writes always succeed with a valid number even if it gets interrupted. */
679 cnt = local_inc_return(&t->cnt);
680 rb_time_val_set(&t->top, top, cnt);
681 rb_time_val_set(&t->bottom, bottom, cnt);
682 } while (cnt != local_read(&t->cnt));
686 rb_time_read_cmpxchg(local_t *l, unsigned long expect, unsigned long set)
690 ret = local_cmpxchg(l, expect, set);
691 return ret == expect;
694 static int rb_time_cmpxchg(rb_time_t *t, u64 expect, u64 set)
696 unsigned long cnt, top, bottom;
697 unsigned long cnt2, top2, bottom2;
700 /* The cmpxchg always fails if it interrupted an update */
701 if (!__rb_time_read(t, &val, &cnt2))
707 cnt = local_read(&t->cnt);
708 if ((cnt & 3) != cnt2)
713 rb_time_split(val, &top, &bottom);
714 top = rb_time_val_cnt(top, cnt);
715 bottom = rb_time_val_cnt(bottom, cnt);
717 rb_time_split(set, &top2, &bottom2);
718 top2 = rb_time_val_cnt(top2, cnt2);
719 bottom2 = rb_time_val_cnt(bottom2, cnt2);
721 if (!rb_time_read_cmpxchg(&t->cnt, cnt, cnt2))
723 if (!rb_time_read_cmpxchg(&t->top, top, top2))
725 if (!rb_time_read_cmpxchg(&t->bottom, bottom, bottom2))
732 /* local64_t always succeeds */
734 static inline bool rb_time_read(rb_time_t *t, u64 *ret)
736 *ret = local64_read(&t->time);
739 static void rb_time_set(rb_time_t *t, u64 val)
741 local64_set(&t->time, val);
744 static bool rb_time_cmpxchg(rb_time_t *t, u64 expect, u64 set)
747 val = local64_cmpxchg(&t->time, expect, set);
748 return val == expect;
753 * ring_buffer_nr_pages - get the number of buffer pages in the ring buffer
754 * @buffer: The ring_buffer to get the number of pages from
755 * @cpu: The cpu of the ring_buffer to get the number of pages from
757 * Returns the number of pages used by a per_cpu buffer of the ring buffer.
759 size_t ring_buffer_nr_pages(struct trace_buffer *buffer, int cpu)
761 return buffer->buffers[cpu]->nr_pages;
765 * ring_buffer_nr_pages_dirty - get the number of used pages in the ring buffer
766 * @buffer: The ring_buffer to get the number of pages from
767 * @cpu: The cpu of the ring_buffer to get the number of pages from
769 * Returns the number of pages that have content in the ring buffer.
771 size_t ring_buffer_nr_dirty_pages(struct trace_buffer *buffer, int cpu)
776 read = local_read(&buffer->buffers[cpu]->pages_read);
777 cnt = local_read(&buffer->buffers[cpu]->pages_touched);
778 /* The reader can read an empty page, but not more than that */
780 WARN_ON_ONCE(read > cnt + 1);
788 * rb_wake_up_waiters - wake up tasks waiting for ring buffer input
790 * Schedules a delayed work to wake up any task that is blocked on the
791 * ring buffer waiters queue.
793 static void rb_wake_up_waiters(struct irq_work *work)
795 struct rb_irq_work *rbwork = container_of(work, struct rb_irq_work, work);
797 wake_up_all(&rbwork->waiters);
798 if (rbwork->wakeup_full) {
799 rbwork->wakeup_full = false;
800 wake_up_all(&rbwork->full_waiters);
805 * ring_buffer_wait - wait for input to the ring buffer
806 * @buffer: buffer to wait on
807 * @cpu: the cpu buffer to wait on
808 * @full: wait until the percentage of pages are available, if @cpu != RING_BUFFER_ALL_CPUS
810 * If @cpu == RING_BUFFER_ALL_CPUS then the task will wake up as soon
811 * as data is added to any of the @buffer's cpu buffers. Otherwise
812 * it will wait for data to be added to a specific cpu buffer.
814 int ring_buffer_wait(struct trace_buffer *buffer, int cpu, int full)
816 struct ring_buffer_per_cpu *cpu_buffer;
818 struct rb_irq_work *work;
822 * Depending on what the caller is waiting for, either any
823 * data in any cpu buffer, or a specific buffer, put the
824 * caller on the appropriate wait queue.
826 if (cpu == RING_BUFFER_ALL_CPUS) {
827 work = &buffer->irq_work;
828 /* Full only makes sense on per cpu reads */
831 if (!cpumask_test_cpu(cpu, buffer->cpumask))
833 cpu_buffer = buffer->buffers[cpu];
834 work = &cpu_buffer->irq_work;
840 prepare_to_wait(&work->full_waiters, &wait, TASK_INTERRUPTIBLE);
842 prepare_to_wait(&work->waiters, &wait, TASK_INTERRUPTIBLE);
845 * The events can happen in critical sections where
846 * checking a work queue can cause deadlocks.
847 * After adding a task to the queue, this flag is set
848 * only to notify events to try to wake up the queue
851 * We don't clear it even if the buffer is no longer
852 * empty. The flag only causes the next event to run
853 * irq_work to do the work queue wake up. The worse
854 * that can happen if we race with !trace_empty() is that
855 * an event will cause an irq_work to try to wake up
858 * There's no reason to protect this flag either, as
859 * the work queue and irq_work logic will do the necessary
860 * synchronization for the wake ups. The only thing
861 * that is necessary is that the wake up happens after
862 * a task has been queued. It's OK for spurious wake ups.
865 work->full_waiters_pending = true;
867 work->waiters_pending = true;
869 if (signal_pending(current)) {
874 if (cpu == RING_BUFFER_ALL_CPUS && !ring_buffer_empty(buffer))
877 if (cpu != RING_BUFFER_ALL_CPUS &&
878 !ring_buffer_empty_cpu(buffer, cpu)) {
887 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
888 pagebusy = cpu_buffer->reader_page == cpu_buffer->commit_page;
889 nr_pages = cpu_buffer->nr_pages;
890 dirty = ring_buffer_nr_dirty_pages(buffer, cpu);
891 if (!cpu_buffer->shortest_full ||
892 cpu_buffer->shortest_full < full)
893 cpu_buffer->shortest_full = full;
894 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
896 (!nr_pages || (dirty * 100) > full * nr_pages))
904 finish_wait(&work->full_waiters, &wait);
906 finish_wait(&work->waiters, &wait);
912 * ring_buffer_poll_wait - poll on buffer input
913 * @buffer: buffer to wait on
914 * @cpu: the cpu buffer to wait on
915 * @filp: the file descriptor
916 * @poll_table: The poll descriptor
918 * If @cpu == RING_BUFFER_ALL_CPUS then the task will wake up as soon
919 * as data is added to any of the @buffer's cpu buffers. Otherwise
920 * it will wait for data to be added to a specific cpu buffer.
922 * Returns EPOLLIN | EPOLLRDNORM if data exists in the buffers,
925 __poll_t ring_buffer_poll_wait(struct trace_buffer *buffer, int cpu,
926 struct file *filp, poll_table *poll_table)
928 struct ring_buffer_per_cpu *cpu_buffer;
929 struct rb_irq_work *work;
931 if (cpu == RING_BUFFER_ALL_CPUS)
932 work = &buffer->irq_work;
934 if (!cpumask_test_cpu(cpu, buffer->cpumask))
937 cpu_buffer = buffer->buffers[cpu];
938 work = &cpu_buffer->irq_work;
941 poll_wait(filp, &work->waiters, poll_table);
942 work->waiters_pending = true;
944 * There's a tight race between setting the waiters_pending and
945 * checking if the ring buffer is empty. Once the waiters_pending bit
946 * is set, the next event will wake the task up, but we can get stuck
947 * if there's only a single event in.
949 * FIXME: Ideally, we need a memory barrier on the writer side as well,
950 * but adding a memory barrier to all events will cause too much of a
951 * performance hit in the fast path. We only need a memory barrier when
952 * the buffer goes from empty to having content. But as this race is
953 * extremely small, and it's not a problem if another event comes in, we
958 if ((cpu == RING_BUFFER_ALL_CPUS && !ring_buffer_empty(buffer)) ||
959 (cpu != RING_BUFFER_ALL_CPUS && !ring_buffer_empty_cpu(buffer, cpu)))
960 return EPOLLIN | EPOLLRDNORM;
964 /* buffer may be either ring_buffer or ring_buffer_per_cpu */
965 #define RB_WARN_ON(b, cond) \
967 int _____ret = unlikely(cond); \
969 if (__same_type(*(b), struct ring_buffer_per_cpu)) { \
970 struct ring_buffer_per_cpu *__b = \
972 atomic_inc(&__b->buffer->record_disabled); \
974 atomic_inc(&b->record_disabled); \
980 /* Up this if you want to test the TIME_EXTENTS and normalization */
981 #define DEBUG_SHIFT 0
983 static inline u64 rb_time_stamp(struct trace_buffer *buffer)
987 /* Skip retpolines :-( */
988 if (IS_ENABLED(CONFIG_RETPOLINE) && likely(buffer->clock == trace_clock_local))
989 ts = trace_clock_local();
991 ts = buffer->clock();
993 /* shift to debug/test normalization and TIME_EXTENTS */
994 return ts << DEBUG_SHIFT;
997 u64 ring_buffer_time_stamp(struct trace_buffer *buffer, int cpu)
1001 preempt_disable_notrace();
1002 time = rb_time_stamp(buffer);
1003 preempt_enable_notrace();
1007 EXPORT_SYMBOL_GPL(ring_buffer_time_stamp);
1009 void ring_buffer_normalize_time_stamp(struct trace_buffer *buffer,
1012 /* Just stupid testing the normalize function and deltas */
1013 *ts >>= DEBUG_SHIFT;
1015 EXPORT_SYMBOL_GPL(ring_buffer_normalize_time_stamp);
1018 * Making the ring buffer lockless makes things tricky.
1019 * Although writes only happen on the CPU that they are on,
1020 * and they only need to worry about interrupts. Reads can
1021 * happen on any CPU.
1023 * The reader page is always off the ring buffer, but when the
1024 * reader finishes with a page, it needs to swap its page with
1025 * a new one from the buffer. The reader needs to take from
1026 * the head (writes go to the tail). But if a writer is in overwrite
1027 * mode and wraps, it must push the head page forward.
1029 * Here lies the problem.
1031 * The reader must be careful to replace only the head page, and
1032 * not another one. As described at the top of the file in the
1033 * ASCII art, the reader sets its old page to point to the next
1034 * page after head. It then sets the page after head to point to
1035 * the old reader page. But if the writer moves the head page
1036 * during this operation, the reader could end up with the tail.
1038 * We use cmpxchg to help prevent this race. We also do something
1039 * special with the page before head. We set the LSB to 1.
1041 * When the writer must push the page forward, it will clear the
1042 * bit that points to the head page, move the head, and then set
1043 * the bit that points to the new head page.
1045 * We also don't want an interrupt coming in and moving the head
1046 * page on another writer. Thus we use the second LSB to catch
1049 * head->list->prev->next bit 1 bit 0
1052 * Points to head page 0 1
1055 * Note we can not trust the prev pointer of the head page, because:
1057 * +----+ +-----+ +-----+
1058 * | |------>| T |---X--->| N |
1060 * +----+ +-----+ +-----+
1063 * +----------| R |----------+ |
1067 * Key: ---X--> HEAD flag set in pointer
1072 * (see __rb_reserve_next() to see where this happens)
1074 * What the above shows is that the reader just swapped out
1075 * the reader page with a page in the buffer, but before it
1076 * could make the new header point back to the new page added
1077 * it was preempted by a writer. The writer moved forward onto
1078 * the new page added by the reader and is about to move forward
1081 * You can see, it is legitimate for the previous pointer of
1082 * the head (or any page) not to point back to itself. But only
1086 #define RB_PAGE_NORMAL 0UL
1087 #define RB_PAGE_HEAD 1UL
1088 #define RB_PAGE_UPDATE 2UL
1091 #define RB_FLAG_MASK 3UL
1093 /* PAGE_MOVED is not part of the mask */
1094 #define RB_PAGE_MOVED 4UL
1097 * rb_list_head - remove any bit
1099 static struct list_head *rb_list_head(struct list_head *list)
1101 unsigned long val = (unsigned long)list;
1103 return (struct list_head *)(val & ~RB_FLAG_MASK);
1107 * rb_is_head_page - test if the given page is the head page
1109 * Because the reader may move the head_page pointer, we can
1110 * not trust what the head page is (it may be pointing to
1111 * the reader page). But if the next page is a header page,
1112 * its flags will be non zero.
1115 rb_is_head_page(struct buffer_page *page, struct list_head *list)
1119 val = (unsigned long)list->next;
1121 if ((val & ~RB_FLAG_MASK) != (unsigned long)&page->list)
1122 return RB_PAGE_MOVED;
1124 return val & RB_FLAG_MASK;
1130 * The unique thing about the reader page, is that, if the
1131 * writer is ever on it, the previous pointer never points
1132 * back to the reader page.
1134 static bool rb_is_reader_page(struct buffer_page *page)
1136 struct list_head *list = page->list.prev;
1138 return rb_list_head(list->next) != &page->list;
1142 * rb_set_list_to_head - set a list_head to be pointing to head.
1144 static void rb_set_list_to_head(struct list_head *list)
1148 ptr = (unsigned long *)&list->next;
1149 *ptr |= RB_PAGE_HEAD;
1150 *ptr &= ~RB_PAGE_UPDATE;
1154 * rb_head_page_activate - sets up head page
1156 static void rb_head_page_activate(struct ring_buffer_per_cpu *cpu_buffer)
1158 struct buffer_page *head;
1160 head = cpu_buffer->head_page;
1165 * Set the previous list pointer to have the HEAD flag.
1167 rb_set_list_to_head(head->list.prev);
1170 static void rb_list_head_clear(struct list_head *list)
1172 unsigned long *ptr = (unsigned long *)&list->next;
1174 *ptr &= ~RB_FLAG_MASK;
1178 * rb_head_page_deactivate - clears head page ptr (for free list)
1181 rb_head_page_deactivate(struct ring_buffer_per_cpu *cpu_buffer)
1183 struct list_head *hd;
1185 /* Go through the whole list and clear any pointers found. */
1186 rb_list_head_clear(cpu_buffer->pages);
1188 list_for_each(hd, cpu_buffer->pages)
1189 rb_list_head_clear(hd);
1192 static int rb_head_page_set(struct ring_buffer_per_cpu *cpu_buffer,
1193 struct buffer_page *head,
1194 struct buffer_page *prev,
1195 int old_flag, int new_flag)
1197 struct list_head *list;
1198 unsigned long val = (unsigned long)&head->list;
1203 val &= ~RB_FLAG_MASK;
1205 ret = cmpxchg((unsigned long *)&list->next,
1206 val | old_flag, val | new_flag);
1208 /* check if the reader took the page */
1209 if ((ret & ~RB_FLAG_MASK) != val)
1210 return RB_PAGE_MOVED;
1212 return ret & RB_FLAG_MASK;
1215 static int rb_head_page_set_update(struct ring_buffer_per_cpu *cpu_buffer,
1216 struct buffer_page *head,
1217 struct buffer_page *prev,
1220 return rb_head_page_set(cpu_buffer, head, prev,
1221 old_flag, RB_PAGE_UPDATE);
1224 static int rb_head_page_set_head(struct ring_buffer_per_cpu *cpu_buffer,
1225 struct buffer_page *head,
1226 struct buffer_page *prev,
1229 return rb_head_page_set(cpu_buffer, head, prev,
1230 old_flag, RB_PAGE_HEAD);
1233 static int rb_head_page_set_normal(struct ring_buffer_per_cpu *cpu_buffer,
1234 struct buffer_page *head,
1235 struct buffer_page *prev,
1238 return rb_head_page_set(cpu_buffer, head, prev,
1239 old_flag, RB_PAGE_NORMAL);
1242 static inline void rb_inc_page(struct buffer_page **bpage)
1244 struct list_head *p = rb_list_head((*bpage)->list.next);
1246 *bpage = list_entry(p, struct buffer_page, list);
1249 static struct buffer_page *
1250 rb_set_head_page(struct ring_buffer_per_cpu *cpu_buffer)
1252 struct buffer_page *head;
1253 struct buffer_page *page;
1254 struct list_head *list;
1257 if (RB_WARN_ON(cpu_buffer, !cpu_buffer->head_page))
1261 list = cpu_buffer->pages;
1262 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev->next) != list))
1265 page = head = cpu_buffer->head_page;
1267 * It is possible that the writer moves the header behind
1268 * where we started, and we miss in one loop.
1269 * A second loop should grab the header, but we'll do
1270 * three loops just because I'm paranoid.
1272 for (i = 0; i < 3; i++) {
1274 if (rb_is_head_page(page, page->list.prev)) {
1275 cpu_buffer->head_page = page;
1279 } while (page != head);
1282 RB_WARN_ON(cpu_buffer, 1);
1287 static int rb_head_page_replace(struct buffer_page *old,
1288 struct buffer_page *new)
1290 unsigned long *ptr = (unsigned long *)&old->list.prev->next;
1294 val = *ptr & ~RB_FLAG_MASK;
1295 val |= RB_PAGE_HEAD;
1297 ret = cmpxchg(ptr, val, (unsigned long)&new->list);
1303 * rb_tail_page_update - move the tail page forward
1305 static void rb_tail_page_update(struct ring_buffer_per_cpu *cpu_buffer,
1306 struct buffer_page *tail_page,
1307 struct buffer_page *next_page)
1309 unsigned long old_entries;
1310 unsigned long old_write;
1313 * The tail page now needs to be moved forward.
1315 * We need to reset the tail page, but without messing
1316 * with possible erasing of data brought in by interrupts
1317 * that have moved the tail page and are currently on it.
1319 * We add a counter to the write field to denote this.
1321 old_write = local_add_return(RB_WRITE_INTCNT, &next_page->write);
1322 old_entries = local_add_return(RB_WRITE_INTCNT, &next_page->entries);
1324 local_inc(&cpu_buffer->pages_touched);
1326 * Just make sure we have seen our old_write and synchronize
1327 * with any interrupts that come in.
1332 * If the tail page is still the same as what we think
1333 * it is, then it is up to us to update the tail
1336 if (tail_page == READ_ONCE(cpu_buffer->tail_page)) {
1337 /* Zero the write counter */
1338 unsigned long val = old_write & ~RB_WRITE_MASK;
1339 unsigned long eval = old_entries & ~RB_WRITE_MASK;
1342 * This will only succeed if an interrupt did
1343 * not come in and change it. In which case, we
1344 * do not want to modify it.
1346 * We add (void) to let the compiler know that we do not care
1347 * about the return value of these functions. We use the
1348 * cmpxchg to only update if an interrupt did not already
1349 * do it for us. If the cmpxchg fails, we don't care.
1351 (void)local_cmpxchg(&next_page->write, old_write, val);
1352 (void)local_cmpxchg(&next_page->entries, old_entries, eval);
1355 * No need to worry about races with clearing out the commit.
1356 * it only can increment when a commit takes place. But that
1357 * only happens in the outer most nested commit.
1359 local_set(&next_page->page->commit, 0);
1361 /* Again, either we update tail_page or an interrupt does */
1362 (void)cmpxchg(&cpu_buffer->tail_page, tail_page, next_page);
1366 static int rb_check_bpage(struct ring_buffer_per_cpu *cpu_buffer,
1367 struct buffer_page *bpage)
1369 unsigned long val = (unsigned long)bpage;
1371 if (RB_WARN_ON(cpu_buffer, val & RB_FLAG_MASK))
1378 * rb_check_list - make sure a pointer to a list has the last bits zero
1380 static int rb_check_list(struct ring_buffer_per_cpu *cpu_buffer,
1381 struct list_head *list)
1383 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->prev) != list->prev))
1385 if (RB_WARN_ON(cpu_buffer, rb_list_head(list->next) != list->next))
1391 * rb_check_pages - integrity check of buffer pages
1392 * @cpu_buffer: CPU buffer with pages to test
1394 * As a safety measure we check to make sure the data pages have not
1397 static int rb_check_pages(struct ring_buffer_per_cpu *cpu_buffer)
1399 struct list_head *head = cpu_buffer->pages;
1400 struct buffer_page *bpage, *tmp;
1402 /* Reset the head page if it exists */
1403 if (cpu_buffer->head_page)
1404 rb_set_head_page(cpu_buffer);
1406 rb_head_page_deactivate(cpu_buffer);
1408 if (RB_WARN_ON(cpu_buffer, head->next->prev != head))
1410 if (RB_WARN_ON(cpu_buffer, head->prev->next != head))
1413 if (rb_check_list(cpu_buffer, head))
1416 list_for_each_entry_safe(bpage, tmp, head, list) {
1417 if (RB_WARN_ON(cpu_buffer,
1418 bpage->list.next->prev != &bpage->list))
1420 if (RB_WARN_ON(cpu_buffer,
1421 bpage->list.prev->next != &bpage->list))
1423 if (rb_check_list(cpu_buffer, &bpage->list))
1427 rb_head_page_activate(cpu_buffer);
1432 static int __rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
1433 long nr_pages, struct list_head *pages)
1435 struct buffer_page *bpage, *tmp;
1436 bool user_thread = current->mm != NULL;
1441 * Check if the available memory is there first.
1442 * Note, si_mem_available() only gives us a rough estimate of available
1443 * memory. It may not be accurate. But we don't care, we just want
1444 * to prevent doing any allocation when it is obvious that it is
1445 * not going to succeed.
1447 i = si_mem_available();
1452 * __GFP_RETRY_MAYFAIL flag makes sure that the allocation fails
1453 * gracefully without invoking oom-killer and the system is not
1456 mflags = GFP_KERNEL | __GFP_RETRY_MAYFAIL;
1459 * If a user thread allocates too much, and si_mem_available()
1460 * reports there's enough memory, even though there is not.
1461 * Make sure the OOM killer kills this thread. This can happen
1462 * even with RETRY_MAYFAIL because another task may be doing
1463 * an allocation after this task has taken all memory.
1464 * This is the task the OOM killer needs to take out during this
1465 * loop, even if it was triggered by an allocation somewhere else.
1468 set_current_oom_origin();
1469 for (i = 0; i < nr_pages; i++) {
1472 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
1473 mflags, cpu_to_node(cpu_buffer->cpu));
1477 rb_check_bpage(cpu_buffer, bpage);
1479 list_add(&bpage->list, pages);
1481 page = alloc_pages_node(cpu_to_node(cpu_buffer->cpu), mflags, 0);
1484 bpage->page = page_address(page);
1485 rb_init_page(bpage->page);
1487 if (user_thread && fatal_signal_pending(current))
1491 clear_current_oom_origin();
1496 list_for_each_entry_safe(bpage, tmp, pages, list) {
1497 list_del_init(&bpage->list);
1498 free_buffer_page(bpage);
1501 clear_current_oom_origin();
1506 static int rb_allocate_pages(struct ring_buffer_per_cpu *cpu_buffer,
1507 unsigned long nr_pages)
1513 if (__rb_allocate_pages(cpu_buffer, nr_pages, &pages))
1517 * The ring buffer page list is a circular list that does not
1518 * start and end with a list head. All page list items point to
1521 cpu_buffer->pages = pages.next;
1524 cpu_buffer->nr_pages = nr_pages;
1526 rb_check_pages(cpu_buffer);
1531 static struct ring_buffer_per_cpu *
1532 rb_allocate_cpu_buffer(struct trace_buffer *buffer, long nr_pages, int cpu)
1534 struct ring_buffer_per_cpu *cpu_buffer;
1535 struct buffer_page *bpage;
1539 cpu_buffer = kzalloc_node(ALIGN(sizeof(*cpu_buffer), cache_line_size()),
1540 GFP_KERNEL, cpu_to_node(cpu));
1544 cpu_buffer->cpu = cpu;
1545 cpu_buffer->buffer = buffer;
1546 raw_spin_lock_init(&cpu_buffer->reader_lock);
1547 lockdep_set_class(&cpu_buffer->reader_lock, buffer->reader_lock_key);
1548 cpu_buffer->lock = (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
1549 INIT_WORK(&cpu_buffer->update_pages_work, update_pages_handler);
1550 init_completion(&cpu_buffer->update_done);
1551 init_irq_work(&cpu_buffer->irq_work.work, rb_wake_up_waiters);
1552 init_waitqueue_head(&cpu_buffer->irq_work.waiters);
1553 init_waitqueue_head(&cpu_buffer->irq_work.full_waiters);
1555 bpage = kzalloc_node(ALIGN(sizeof(*bpage), cache_line_size()),
1556 GFP_KERNEL, cpu_to_node(cpu));
1558 goto fail_free_buffer;
1560 rb_check_bpage(cpu_buffer, bpage);
1562 cpu_buffer->reader_page = bpage;
1563 page = alloc_pages_node(cpu_to_node(cpu), GFP_KERNEL, 0);
1565 goto fail_free_reader;
1566 bpage->page = page_address(page);
1567 rb_init_page(bpage->page);
1569 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
1570 INIT_LIST_HEAD(&cpu_buffer->new_pages);
1572 ret = rb_allocate_pages(cpu_buffer, nr_pages);
1574 goto fail_free_reader;
1576 cpu_buffer->head_page
1577 = list_entry(cpu_buffer->pages, struct buffer_page, list);
1578 cpu_buffer->tail_page = cpu_buffer->commit_page = cpu_buffer->head_page;
1580 rb_head_page_activate(cpu_buffer);
1585 free_buffer_page(cpu_buffer->reader_page);
1592 static void rb_free_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
1594 struct list_head *head = cpu_buffer->pages;
1595 struct buffer_page *bpage, *tmp;
1597 free_buffer_page(cpu_buffer->reader_page);
1599 rb_head_page_deactivate(cpu_buffer);
1602 list_for_each_entry_safe(bpage, tmp, head, list) {
1603 list_del_init(&bpage->list);
1604 free_buffer_page(bpage);
1606 bpage = list_entry(head, struct buffer_page, list);
1607 free_buffer_page(bpage);
1614 * __ring_buffer_alloc - allocate a new ring_buffer
1615 * @size: the size in bytes per cpu that is needed.
1616 * @flags: attributes to set for the ring buffer.
1617 * @key: ring buffer reader_lock_key.
1619 * Currently the only flag that is available is the RB_FL_OVERWRITE
1620 * flag. This flag means that the buffer will overwrite old data
1621 * when the buffer wraps. If this flag is not set, the buffer will
1622 * drop data when the tail hits the head.
1624 struct trace_buffer *__ring_buffer_alloc(unsigned long size, unsigned flags,
1625 struct lock_class_key *key)
1627 struct trace_buffer *buffer;
1633 /* keep it in its own cache line */
1634 buffer = kzalloc(ALIGN(sizeof(*buffer), cache_line_size()),
1639 if (!zalloc_cpumask_var(&buffer->cpumask, GFP_KERNEL))
1640 goto fail_free_buffer;
1642 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1643 buffer->flags = flags;
1644 buffer->clock = trace_clock_local;
1645 buffer->reader_lock_key = key;
1647 init_irq_work(&buffer->irq_work.work, rb_wake_up_waiters);
1648 init_waitqueue_head(&buffer->irq_work.waiters);
1650 /* need at least two pages */
1654 buffer->cpus = nr_cpu_ids;
1656 bsize = sizeof(void *) * nr_cpu_ids;
1657 buffer->buffers = kzalloc(ALIGN(bsize, cache_line_size()),
1659 if (!buffer->buffers)
1660 goto fail_free_cpumask;
1662 cpu = raw_smp_processor_id();
1663 cpumask_set_cpu(cpu, buffer->cpumask);
1664 buffer->buffers[cpu] = rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
1665 if (!buffer->buffers[cpu])
1666 goto fail_free_buffers;
1668 ret = cpuhp_state_add_instance(CPUHP_TRACE_RB_PREPARE, &buffer->node);
1670 goto fail_free_buffers;
1672 mutex_init(&buffer->mutex);
1677 for_each_buffer_cpu(buffer, cpu) {
1678 if (buffer->buffers[cpu])
1679 rb_free_cpu_buffer(buffer->buffers[cpu]);
1681 kfree(buffer->buffers);
1684 free_cpumask_var(buffer->cpumask);
1690 EXPORT_SYMBOL_GPL(__ring_buffer_alloc);
1693 * ring_buffer_free - free a ring buffer.
1694 * @buffer: the buffer to free.
1697 ring_buffer_free(struct trace_buffer *buffer)
1701 cpuhp_state_remove_instance(CPUHP_TRACE_RB_PREPARE, &buffer->node);
1703 for_each_buffer_cpu(buffer, cpu)
1704 rb_free_cpu_buffer(buffer->buffers[cpu]);
1706 kfree(buffer->buffers);
1707 free_cpumask_var(buffer->cpumask);
1711 EXPORT_SYMBOL_GPL(ring_buffer_free);
1713 void ring_buffer_set_clock(struct trace_buffer *buffer,
1716 buffer->clock = clock;
1719 void ring_buffer_set_time_stamp_abs(struct trace_buffer *buffer, bool abs)
1721 buffer->time_stamp_abs = abs;
1724 bool ring_buffer_time_stamp_abs(struct trace_buffer *buffer)
1726 return buffer->time_stamp_abs;
1729 static void rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer);
1731 static inline unsigned long rb_page_entries(struct buffer_page *bpage)
1733 return local_read(&bpage->entries) & RB_WRITE_MASK;
1736 static inline unsigned long rb_page_write(struct buffer_page *bpage)
1738 return local_read(&bpage->write) & RB_WRITE_MASK;
1742 rb_remove_pages(struct ring_buffer_per_cpu *cpu_buffer, unsigned long nr_pages)
1744 struct list_head *tail_page, *to_remove, *next_page;
1745 struct buffer_page *to_remove_page, *tmp_iter_page;
1746 struct buffer_page *last_page, *first_page;
1747 unsigned long nr_removed;
1748 unsigned long head_bit;
1753 raw_spin_lock_irq(&cpu_buffer->reader_lock);
1754 atomic_inc(&cpu_buffer->record_disabled);
1756 * We don't race with the readers since we have acquired the reader
1757 * lock. We also don't race with writers after disabling recording.
1758 * This makes it easy to figure out the first and the last page to be
1759 * removed from the list. We unlink all the pages in between including
1760 * the first and last pages. This is done in a busy loop so that we
1761 * lose the least number of traces.
1762 * The pages are freed after we restart recording and unlock readers.
1764 tail_page = &cpu_buffer->tail_page->list;
1767 * tail page might be on reader page, we remove the next page
1768 * from the ring buffer
1770 if (cpu_buffer->tail_page == cpu_buffer->reader_page)
1771 tail_page = rb_list_head(tail_page->next);
1772 to_remove = tail_page;
1774 /* start of pages to remove */
1775 first_page = list_entry(rb_list_head(to_remove->next),
1776 struct buffer_page, list);
1778 for (nr_removed = 0; nr_removed < nr_pages; nr_removed++) {
1779 to_remove = rb_list_head(to_remove)->next;
1780 head_bit |= (unsigned long)to_remove & RB_PAGE_HEAD;
1783 next_page = rb_list_head(to_remove)->next;
1786 * Now we remove all pages between tail_page and next_page.
1787 * Make sure that we have head_bit value preserved for the
1790 tail_page->next = (struct list_head *)((unsigned long)next_page |
1792 next_page = rb_list_head(next_page);
1793 next_page->prev = tail_page;
1795 /* make sure pages points to a valid page in the ring buffer */
1796 cpu_buffer->pages = next_page;
1798 /* update head page */
1800 cpu_buffer->head_page = list_entry(next_page,
1801 struct buffer_page, list);
1804 * change read pointer to make sure any read iterators reset
1807 cpu_buffer->read = 0;
1809 /* pages are removed, resume tracing and then free the pages */
1810 atomic_dec(&cpu_buffer->record_disabled);
1811 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
1813 RB_WARN_ON(cpu_buffer, list_empty(cpu_buffer->pages));
1815 /* last buffer page to remove */
1816 last_page = list_entry(rb_list_head(to_remove), struct buffer_page,
1818 tmp_iter_page = first_page;
1823 to_remove_page = tmp_iter_page;
1824 rb_inc_page(&tmp_iter_page);
1826 /* update the counters */
1827 page_entries = rb_page_entries(to_remove_page);
1830 * If something was added to this page, it was full
1831 * since it is not the tail page. So we deduct the
1832 * bytes consumed in ring buffer from here.
1833 * Increment overrun to account for the lost events.
1835 local_add(page_entries, &cpu_buffer->overrun);
1836 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
1840 * We have already removed references to this list item, just
1841 * free up the buffer_page and its page
1843 free_buffer_page(to_remove_page);
1846 } while (to_remove_page != last_page);
1848 RB_WARN_ON(cpu_buffer, nr_removed);
1850 return nr_removed == 0;
1854 rb_insert_pages(struct ring_buffer_per_cpu *cpu_buffer)
1856 struct list_head *pages = &cpu_buffer->new_pages;
1857 int retries, success;
1859 raw_spin_lock_irq(&cpu_buffer->reader_lock);
1861 * We are holding the reader lock, so the reader page won't be swapped
1862 * in the ring buffer. Now we are racing with the writer trying to
1863 * move head page and the tail page.
1864 * We are going to adapt the reader page update process where:
1865 * 1. We first splice the start and end of list of new pages between
1866 * the head page and its previous page.
1867 * 2. We cmpxchg the prev_page->next to point from head page to the
1868 * start of new pages list.
1869 * 3. Finally, we update the head->prev to the end of new list.
1871 * We will try this process 10 times, to make sure that we don't keep
1877 struct list_head *head_page, *prev_page, *r;
1878 struct list_head *last_page, *first_page;
1879 struct list_head *head_page_with_bit;
1881 head_page = &rb_set_head_page(cpu_buffer)->list;
1884 prev_page = head_page->prev;
1886 first_page = pages->next;
1887 last_page = pages->prev;
1889 head_page_with_bit = (struct list_head *)
1890 ((unsigned long)head_page | RB_PAGE_HEAD);
1892 last_page->next = head_page_with_bit;
1893 first_page->prev = prev_page;
1895 r = cmpxchg(&prev_page->next, head_page_with_bit, first_page);
1897 if (r == head_page_with_bit) {
1899 * yay, we replaced the page pointer to our new list,
1900 * now, we just have to update to head page's prev
1901 * pointer to point to end of list
1903 head_page->prev = last_page;
1910 INIT_LIST_HEAD(pages);
1912 * If we weren't successful in adding in new pages, warn and stop
1915 RB_WARN_ON(cpu_buffer, !success);
1916 raw_spin_unlock_irq(&cpu_buffer->reader_lock);
1918 /* free pages if they weren't inserted */
1920 struct buffer_page *bpage, *tmp;
1921 list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
1923 list_del_init(&bpage->list);
1924 free_buffer_page(bpage);
1930 static void rb_update_pages(struct ring_buffer_per_cpu *cpu_buffer)
1934 if (cpu_buffer->nr_pages_to_update > 0)
1935 success = rb_insert_pages(cpu_buffer);
1937 success = rb_remove_pages(cpu_buffer,
1938 -cpu_buffer->nr_pages_to_update);
1941 cpu_buffer->nr_pages += cpu_buffer->nr_pages_to_update;
1944 static void update_pages_handler(struct work_struct *work)
1946 struct ring_buffer_per_cpu *cpu_buffer = container_of(work,
1947 struct ring_buffer_per_cpu, update_pages_work);
1948 rb_update_pages(cpu_buffer);
1949 complete(&cpu_buffer->update_done);
1953 * ring_buffer_resize - resize the ring buffer
1954 * @buffer: the buffer to resize.
1955 * @size: the new size.
1956 * @cpu_id: the cpu buffer to resize
1958 * Minimum size is 2 * BUF_PAGE_SIZE.
1960 * Returns 0 on success and < 0 on failure.
1962 int ring_buffer_resize(struct trace_buffer *buffer, unsigned long size,
1965 struct ring_buffer_per_cpu *cpu_buffer;
1966 unsigned long nr_pages;
1970 * Always succeed at resizing a non-existent buffer:
1975 /* Make sure the requested buffer exists */
1976 if (cpu_id != RING_BUFFER_ALL_CPUS &&
1977 !cpumask_test_cpu(cpu_id, buffer->cpumask))
1980 nr_pages = DIV_ROUND_UP(size, BUF_PAGE_SIZE);
1982 /* we need a minimum of two pages */
1986 /* prevent another thread from changing buffer sizes */
1987 mutex_lock(&buffer->mutex);
1990 if (cpu_id == RING_BUFFER_ALL_CPUS) {
1992 * Don't succeed if resizing is disabled, as a reader might be
1993 * manipulating the ring buffer and is expecting a sane state while
1996 for_each_buffer_cpu(buffer, cpu) {
1997 cpu_buffer = buffer->buffers[cpu];
1998 if (atomic_read(&cpu_buffer->resize_disabled)) {
2000 goto out_err_unlock;
2004 /* calculate the pages to update */
2005 for_each_buffer_cpu(buffer, cpu) {
2006 cpu_buffer = buffer->buffers[cpu];
2008 cpu_buffer->nr_pages_to_update = nr_pages -
2009 cpu_buffer->nr_pages;
2011 * nothing more to do for removing pages or no update
2013 if (cpu_buffer->nr_pages_to_update <= 0)
2016 * to add pages, make sure all new pages can be
2017 * allocated without receiving ENOMEM
2019 INIT_LIST_HEAD(&cpu_buffer->new_pages);
2020 if (__rb_allocate_pages(cpu_buffer, cpu_buffer->nr_pages_to_update,
2021 &cpu_buffer->new_pages)) {
2022 /* not enough memory for new pages */
2030 * Fire off all the required work handlers
2031 * We can't schedule on offline CPUs, but it's not necessary
2032 * since we can change their buffer sizes without any race.
2034 for_each_buffer_cpu(buffer, cpu) {
2035 cpu_buffer = buffer->buffers[cpu];
2036 if (!cpu_buffer->nr_pages_to_update)
2039 /* Can't run something on an offline CPU. */
2040 if (!cpu_online(cpu)) {
2041 rb_update_pages(cpu_buffer);
2042 cpu_buffer->nr_pages_to_update = 0;
2044 schedule_work_on(cpu,
2045 &cpu_buffer->update_pages_work);
2049 /* wait for all the updates to complete */
2050 for_each_buffer_cpu(buffer, cpu) {
2051 cpu_buffer = buffer->buffers[cpu];
2052 if (!cpu_buffer->nr_pages_to_update)
2055 if (cpu_online(cpu))
2056 wait_for_completion(&cpu_buffer->update_done);
2057 cpu_buffer->nr_pages_to_update = 0;
2062 /* Make sure this CPU has been initialized */
2063 if (!cpumask_test_cpu(cpu_id, buffer->cpumask))
2066 cpu_buffer = buffer->buffers[cpu_id];
2068 if (nr_pages == cpu_buffer->nr_pages)
2072 * Don't succeed if resizing is disabled, as a reader might be
2073 * manipulating the ring buffer and is expecting a sane state while
2076 if (atomic_read(&cpu_buffer->resize_disabled)) {
2078 goto out_err_unlock;
2081 cpu_buffer->nr_pages_to_update = nr_pages -
2082 cpu_buffer->nr_pages;
2084 INIT_LIST_HEAD(&cpu_buffer->new_pages);
2085 if (cpu_buffer->nr_pages_to_update > 0 &&
2086 __rb_allocate_pages(cpu_buffer, cpu_buffer->nr_pages_to_update,
2087 &cpu_buffer->new_pages)) {
2094 /* Can't run something on an offline CPU. */
2095 if (!cpu_online(cpu_id))
2096 rb_update_pages(cpu_buffer);
2098 schedule_work_on(cpu_id,
2099 &cpu_buffer->update_pages_work);
2100 wait_for_completion(&cpu_buffer->update_done);
2103 cpu_buffer->nr_pages_to_update = 0;
2109 * The ring buffer resize can happen with the ring buffer
2110 * enabled, so that the update disturbs the tracing as little
2111 * as possible. But if the buffer is disabled, we do not need
2112 * to worry about that, and we can take the time to verify
2113 * that the buffer is not corrupt.
2115 if (atomic_read(&buffer->record_disabled)) {
2116 atomic_inc(&buffer->record_disabled);
2118 * Even though the buffer was disabled, we must make sure
2119 * that it is truly disabled before calling rb_check_pages.
2120 * There could have been a race between checking
2121 * record_disable and incrementing it.
2124 for_each_buffer_cpu(buffer, cpu) {
2125 cpu_buffer = buffer->buffers[cpu];
2126 rb_check_pages(cpu_buffer);
2128 atomic_dec(&buffer->record_disabled);
2131 mutex_unlock(&buffer->mutex);
2135 for_each_buffer_cpu(buffer, cpu) {
2136 struct buffer_page *bpage, *tmp;
2138 cpu_buffer = buffer->buffers[cpu];
2139 cpu_buffer->nr_pages_to_update = 0;
2141 if (list_empty(&cpu_buffer->new_pages))
2144 list_for_each_entry_safe(bpage, tmp, &cpu_buffer->new_pages,
2146 list_del_init(&bpage->list);
2147 free_buffer_page(bpage);
2151 mutex_unlock(&buffer->mutex);
2154 EXPORT_SYMBOL_GPL(ring_buffer_resize);
2156 void ring_buffer_change_overwrite(struct trace_buffer *buffer, int val)
2158 mutex_lock(&buffer->mutex);
2160 buffer->flags |= RB_FL_OVERWRITE;
2162 buffer->flags &= ~RB_FL_OVERWRITE;
2163 mutex_unlock(&buffer->mutex);
2165 EXPORT_SYMBOL_GPL(ring_buffer_change_overwrite);
2167 static __always_inline void *__rb_page_index(struct buffer_page *bpage, unsigned index)
2169 return bpage->page->data + index;
2172 static __always_inline struct ring_buffer_event *
2173 rb_reader_event(struct ring_buffer_per_cpu *cpu_buffer)
2175 return __rb_page_index(cpu_buffer->reader_page,
2176 cpu_buffer->reader_page->read);
2179 static __always_inline unsigned rb_page_commit(struct buffer_page *bpage)
2181 return local_read(&bpage->page->commit);
2184 static struct ring_buffer_event *
2185 rb_iter_head_event(struct ring_buffer_iter *iter)
2187 struct ring_buffer_event *event;
2188 struct buffer_page *iter_head_page = iter->head_page;
2189 unsigned long commit;
2192 if (iter->head != iter->next_event)
2196 * When the writer goes across pages, it issues a cmpxchg which
2197 * is a mb(), which will synchronize with the rmb here.
2198 * (see rb_tail_page_update() and __rb_reserve_next())
2200 commit = rb_page_commit(iter_head_page);
2202 event = __rb_page_index(iter_head_page, iter->head);
2203 length = rb_event_length(event);
2206 * READ_ONCE() doesn't work on functions and we don't want the
2207 * compiler doing any crazy optimizations with length.
2211 if ((iter->head + length) > commit || length > BUF_MAX_DATA_SIZE)
2212 /* Writer corrupted the read? */
2215 memcpy(iter->event, event, length);
2217 * If the page stamp is still the same after this rmb() then the
2218 * event was safely copied without the writer entering the page.
2222 /* Make sure the page didn't change since we read this */
2223 if (iter->page_stamp != iter_head_page->page->time_stamp ||
2224 commit > rb_page_commit(iter_head_page))
2227 iter->next_event = iter->head + length;
2230 /* Reset to the beginning */
2231 iter->page_stamp = iter->read_stamp = iter->head_page->page->time_stamp;
2233 iter->next_event = 0;
2234 iter->missed_events = 1;
2238 /* Size is determined by what has been committed */
2239 static __always_inline unsigned rb_page_size(struct buffer_page *bpage)
2241 return rb_page_commit(bpage);
2244 static __always_inline unsigned
2245 rb_commit_index(struct ring_buffer_per_cpu *cpu_buffer)
2247 return rb_page_commit(cpu_buffer->commit_page);
2250 static __always_inline unsigned
2251 rb_event_index(struct ring_buffer_event *event)
2253 unsigned long addr = (unsigned long)event;
2255 return (addr & ~PAGE_MASK) - BUF_PAGE_HDR_SIZE;
2258 static void rb_inc_iter(struct ring_buffer_iter *iter)
2260 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
2263 * The iterator could be on the reader page (it starts there).
2264 * But the head could have moved, since the reader was
2265 * found. Check for this case and assign the iterator
2266 * to the head page instead of next.
2268 if (iter->head_page == cpu_buffer->reader_page)
2269 iter->head_page = rb_set_head_page(cpu_buffer);
2271 rb_inc_page(&iter->head_page);
2273 iter->page_stamp = iter->read_stamp = iter->head_page->page->time_stamp;
2275 iter->next_event = 0;
2279 * rb_handle_head_page - writer hit the head page
2281 * Returns: +1 to retry page
2286 rb_handle_head_page(struct ring_buffer_per_cpu *cpu_buffer,
2287 struct buffer_page *tail_page,
2288 struct buffer_page *next_page)
2290 struct buffer_page *new_head;
2295 entries = rb_page_entries(next_page);
2298 * The hard part is here. We need to move the head
2299 * forward, and protect against both readers on
2300 * other CPUs and writers coming in via interrupts.
2302 type = rb_head_page_set_update(cpu_buffer, next_page, tail_page,
2306 * type can be one of four:
2307 * NORMAL - an interrupt already moved it for us
2308 * HEAD - we are the first to get here.
2309 * UPDATE - we are the interrupt interrupting
2311 * MOVED - a reader on another CPU moved the next
2312 * pointer to its reader page. Give up
2319 * We changed the head to UPDATE, thus
2320 * it is our responsibility to update
2323 local_add(entries, &cpu_buffer->overrun);
2324 local_sub(BUF_PAGE_SIZE, &cpu_buffer->entries_bytes);
2327 * The entries will be zeroed out when we move the
2331 /* still more to do */
2334 case RB_PAGE_UPDATE:
2336 * This is an interrupt that interrupt the
2337 * previous update. Still more to do.
2340 case RB_PAGE_NORMAL:
2342 * An interrupt came in before the update
2343 * and processed this for us.
2344 * Nothing left to do.
2349 * The reader is on another CPU and just did
2350 * a swap with our next_page.
2355 RB_WARN_ON(cpu_buffer, 1); /* WTF??? */
2360 * Now that we are here, the old head pointer is
2361 * set to UPDATE. This will keep the reader from
2362 * swapping the head page with the reader page.
2363 * The reader (on another CPU) will spin till
2366 * We just need to protect against interrupts
2367 * doing the job. We will set the next pointer
2368 * to HEAD. After that, we set the old pointer
2369 * to NORMAL, but only if it was HEAD before.
2370 * otherwise we are an interrupt, and only
2371 * want the outer most commit to reset it.
2373 new_head = next_page;
2374 rb_inc_page(&new_head);
2376 ret = rb_head_page_set_head(cpu_buffer, new_head, next_page,
2380 * Valid returns are:
2381 * HEAD - an interrupt came in and already set it.
2382 * NORMAL - One of two things:
2383 * 1) We really set it.
2384 * 2) A bunch of interrupts came in and moved
2385 * the page forward again.
2389 case RB_PAGE_NORMAL:
2393 RB_WARN_ON(cpu_buffer, 1);
2398 * It is possible that an interrupt came in,
2399 * set the head up, then more interrupts came in
2400 * and moved it again. When we get back here,
2401 * the page would have been set to NORMAL but we
2402 * just set it back to HEAD.
2404 * How do you detect this? Well, if that happened
2405 * the tail page would have moved.
2407 if (ret == RB_PAGE_NORMAL) {
2408 struct buffer_page *buffer_tail_page;
2410 buffer_tail_page = READ_ONCE(cpu_buffer->tail_page);
2412 * If the tail had moved passed next, then we need
2413 * to reset the pointer.
2415 if (buffer_tail_page != tail_page &&
2416 buffer_tail_page != next_page)
2417 rb_head_page_set_normal(cpu_buffer, new_head,
2423 * If this was the outer most commit (the one that
2424 * changed the original pointer from HEAD to UPDATE),
2425 * then it is up to us to reset it to NORMAL.
2427 if (type == RB_PAGE_HEAD) {
2428 ret = rb_head_page_set_normal(cpu_buffer, next_page,
2431 if (RB_WARN_ON(cpu_buffer,
2432 ret != RB_PAGE_UPDATE))
2440 rb_reset_tail(struct ring_buffer_per_cpu *cpu_buffer,
2441 unsigned long tail, struct rb_event_info *info)
2443 struct buffer_page *tail_page = info->tail_page;
2444 struct ring_buffer_event *event;
2445 unsigned long length = info->length;
2448 * Only the event that crossed the page boundary
2449 * must fill the old tail_page with padding.
2451 if (tail >= BUF_PAGE_SIZE) {
2453 * If the page was filled, then we still need
2454 * to update the real_end. Reset it to zero
2455 * and the reader will ignore it.
2457 if (tail == BUF_PAGE_SIZE)
2458 tail_page->real_end = 0;
2460 local_sub(length, &tail_page->write);
2464 event = __rb_page_index(tail_page, tail);
2466 /* account for padding bytes */
2467 local_add(BUF_PAGE_SIZE - tail, &cpu_buffer->entries_bytes);
2470 * Save the original length to the meta data.
2471 * This will be used by the reader to add lost event
2474 tail_page->real_end = tail;
2477 * If this event is bigger than the minimum size, then
2478 * we need to be careful that we don't subtract the
2479 * write counter enough to allow another writer to slip
2481 * We put in a discarded commit instead, to make sure
2482 * that this space is not used again.
2484 * If we are less than the minimum size, we don't need to
2487 if (tail > (BUF_PAGE_SIZE - RB_EVNT_MIN_SIZE)) {
2488 /* No room for any events */
2490 /* Mark the rest of the page with padding */
2491 rb_event_set_padding(event);
2493 /* Set the write back to the previous setting */
2494 local_sub(length, &tail_page->write);
2498 /* Put in a discarded event */
2499 event->array[0] = (BUF_PAGE_SIZE - tail) - RB_EVNT_HDR_SIZE;
2500 event->type_len = RINGBUF_TYPE_PADDING;
2501 /* time delta must be non zero */
2502 event->time_delta = 1;
2504 /* Set write to end of buffer */
2505 length = (tail + length) - BUF_PAGE_SIZE;
2506 local_sub(length, &tail_page->write);
2509 static inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer);
2512 * This is the slow path, force gcc not to inline it.
2514 static noinline struct ring_buffer_event *
2515 rb_move_tail(struct ring_buffer_per_cpu *cpu_buffer,
2516 unsigned long tail, struct rb_event_info *info)
2518 struct buffer_page *tail_page = info->tail_page;
2519 struct buffer_page *commit_page = cpu_buffer->commit_page;
2520 struct trace_buffer *buffer = cpu_buffer->buffer;
2521 struct buffer_page *next_page;
2524 next_page = tail_page;
2526 rb_inc_page(&next_page);
2529 * If for some reason, we had an interrupt storm that made
2530 * it all the way around the buffer, bail, and warn
2533 if (unlikely(next_page == commit_page)) {
2534 local_inc(&cpu_buffer->commit_overrun);
2539 * This is where the fun begins!
2541 * We are fighting against races between a reader that
2542 * could be on another CPU trying to swap its reader
2543 * page with the buffer head.
2545 * We are also fighting against interrupts coming in and
2546 * moving the head or tail on us as well.
2548 * If the next page is the head page then we have filled
2549 * the buffer, unless the commit page is still on the
2552 if (rb_is_head_page(next_page, &tail_page->list)) {
2555 * If the commit is not on the reader page, then
2556 * move the header page.
2558 if (!rb_is_reader_page(cpu_buffer->commit_page)) {
2560 * If we are not in overwrite mode,
2561 * this is easy, just stop here.
2563 if (!(buffer->flags & RB_FL_OVERWRITE)) {
2564 local_inc(&cpu_buffer->dropped_events);
2568 ret = rb_handle_head_page(cpu_buffer,
2577 * We need to be careful here too. The
2578 * commit page could still be on the reader
2579 * page. We could have a small buffer, and
2580 * have filled up the buffer with events
2581 * from interrupts and such, and wrapped.
2583 * Note, if the tail page is also the on the
2584 * reader_page, we let it move out.
2586 if (unlikely((cpu_buffer->commit_page !=
2587 cpu_buffer->tail_page) &&
2588 (cpu_buffer->commit_page ==
2589 cpu_buffer->reader_page))) {
2590 local_inc(&cpu_buffer->commit_overrun);
2596 rb_tail_page_update(cpu_buffer, tail_page, next_page);
2600 rb_reset_tail(cpu_buffer, tail, info);
2602 /* Commit what we have for now. */
2603 rb_end_commit(cpu_buffer);
2604 /* rb_end_commit() decs committing */
2605 local_inc(&cpu_buffer->committing);
2607 /* fail and let the caller try again */
2608 return ERR_PTR(-EAGAIN);
2612 rb_reset_tail(cpu_buffer, tail, info);
2618 static struct ring_buffer_event *
2619 rb_add_time_stamp(struct ring_buffer_event *event, u64 delta, bool abs)
2622 event->type_len = RINGBUF_TYPE_TIME_STAMP;
2624 event->type_len = RINGBUF_TYPE_TIME_EXTEND;
2626 /* Not the first event on the page, or not delta? */
2627 if (abs || rb_event_index(event)) {
2628 event->time_delta = delta & TS_MASK;
2629 event->array[0] = delta >> TS_SHIFT;
2631 /* nope, just zero it */
2632 event->time_delta = 0;
2633 event->array[0] = 0;
2636 return skip_time_extend(event);
2639 #ifndef CONFIG_HAVE_UNSTABLE_SCHED_CLOCK
2640 static inline bool sched_clock_stable(void)
2647 rb_check_timestamp(struct ring_buffer_per_cpu *cpu_buffer,
2648 struct rb_event_info *info)
2652 WARN_ONCE(1, "Delta way too big! %llu ts=%llu before=%llu after=%llu write stamp=%llu\n%s",
2653 (unsigned long long)info->delta,
2654 (unsigned long long)info->ts,
2655 (unsigned long long)info->before,
2656 (unsigned long long)info->after,
2657 (unsigned long long)(rb_time_read(&cpu_buffer->write_stamp, &write_stamp) ? write_stamp : 0),
2658 sched_clock_stable() ? "" :
2659 "If you just came from a suspend/resume,\n"
2660 "please switch to the trace global clock:\n"
2661 " echo global > /sys/kernel/debug/tracing/trace_clock\n"
2662 "or add trace_clock=global to the kernel command line\n");
2665 static void rb_add_timestamp(struct ring_buffer_per_cpu *cpu_buffer,
2666 struct ring_buffer_event **event,
2667 struct rb_event_info *info,
2669 unsigned int *length)
2671 bool abs = info->add_timestamp &
2672 (RB_ADD_STAMP_FORCE | RB_ADD_STAMP_ABSOLUTE);
2674 if (unlikely(info->delta > (1ULL << 59))) {
2675 /* did the clock go backwards */
2676 if (info->before == info->after && info->before > info->ts) {
2677 /* not interrupted */
2681 * This is possible with a recalibrating of the TSC.
2682 * Do not produce a call stack, but just report it.
2686 pr_warn("Ring buffer clock went backwards: %llu -> %llu\n",
2687 info->before, info->ts);
2690 rb_check_timestamp(cpu_buffer, info);
2694 *event = rb_add_time_stamp(*event, info->delta, abs);
2695 *length -= RB_LEN_TIME_EXTEND;
2700 * rb_update_event - update event type and data
2701 * @cpu_buffer: The per cpu buffer of the @event
2702 * @event: the event to update
2703 * @info: The info to update the @event with (contains length and delta)
2705 * Update the type and data fields of the @event. The length
2706 * is the actual size that is written to the ring buffer,
2707 * and with this, we can determine what to place into the
2711 rb_update_event(struct ring_buffer_per_cpu *cpu_buffer,
2712 struct ring_buffer_event *event,
2713 struct rb_event_info *info)
2715 unsigned length = info->length;
2716 u64 delta = info->delta;
2719 * If we need to add a timestamp, then we
2720 * add it to the start of the reserved space.
2722 if (unlikely(info->add_timestamp))
2723 rb_add_timestamp(cpu_buffer, &event, info, &delta, &length);
2725 event->time_delta = delta;
2726 length -= RB_EVNT_HDR_SIZE;
2727 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT) {
2728 event->type_len = 0;
2729 event->array[0] = length;
2731 event->type_len = DIV_ROUND_UP(length, RB_ALIGNMENT);
2734 static unsigned rb_calculate_event_length(unsigned length)
2736 struct ring_buffer_event event; /* Used only for sizeof array */
2738 /* zero length can cause confusions */
2742 if (length > RB_MAX_SMALL_DATA || RB_FORCE_8BYTE_ALIGNMENT)
2743 length += sizeof(event.array[0]);
2745 length += RB_EVNT_HDR_SIZE;
2746 length = ALIGN(length, RB_ARCH_ALIGNMENT);
2749 * In case the time delta is larger than the 27 bits for it
2750 * in the header, we need to add a timestamp. If another
2751 * event comes in when trying to discard this one to increase
2752 * the length, then the timestamp will be added in the allocated
2753 * space of this event. If length is bigger than the size needed
2754 * for the TIME_EXTEND, then padding has to be used. The events
2755 * length must be either RB_LEN_TIME_EXTEND, or greater than or equal
2756 * to RB_LEN_TIME_EXTEND + 8, as 8 is the minimum size for padding.
2757 * As length is a multiple of 4, we only need to worry if it
2758 * is 12 (RB_LEN_TIME_EXTEND + 4).
2760 if (length == RB_LEN_TIME_EXTEND + RB_ALIGNMENT)
2761 length += RB_ALIGNMENT;
2766 static u64 rb_time_delta(struct ring_buffer_event *event)
2768 switch (event->type_len) {
2769 case RINGBUF_TYPE_PADDING:
2772 case RINGBUF_TYPE_TIME_EXTEND:
2773 return ring_buffer_event_time_stamp(event);
2775 case RINGBUF_TYPE_TIME_STAMP:
2778 case RINGBUF_TYPE_DATA:
2779 return event->time_delta;
2786 rb_try_to_discard(struct ring_buffer_per_cpu *cpu_buffer,
2787 struct ring_buffer_event *event)
2789 unsigned long new_index, old_index;
2790 struct buffer_page *bpage;
2791 unsigned long index;
2796 new_index = rb_event_index(event);
2797 old_index = new_index + rb_event_ts_length(event);
2798 addr = (unsigned long)event;
2801 bpage = READ_ONCE(cpu_buffer->tail_page);
2803 delta = rb_time_delta(event);
2805 if (!rb_time_read(&cpu_buffer->write_stamp, &write_stamp))
2808 /* Make sure the write stamp is read before testing the location */
2811 if (bpage->page == (void *)addr && rb_page_write(bpage) == old_index) {
2812 unsigned long write_mask =
2813 local_read(&bpage->write) & ~RB_WRITE_MASK;
2814 unsigned long event_length = rb_event_length(event);
2816 /* Something came in, can't discard */
2817 if (!rb_time_cmpxchg(&cpu_buffer->write_stamp,
2818 write_stamp, write_stamp - delta))
2822 * If an event were to come in now, it would see that the
2823 * write_stamp and the before_stamp are different, and assume
2824 * that this event just added itself before updating
2825 * the write stamp. The interrupting event will fix the
2826 * write stamp for us, and use the before stamp as its delta.
2830 * This is on the tail page. It is possible that
2831 * a write could come in and move the tail page
2832 * and write to the next page. That is fine
2833 * because we just shorten what is on this page.
2835 old_index += write_mask;
2836 new_index += write_mask;
2837 index = local_cmpxchg(&bpage->write, old_index, new_index);
2838 if (index == old_index) {
2839 /* update counters */
2840 local_sub(event_length, &cpu_buffer->entries_bytes);
2845 /* could not discard */
2849 static void rb_start_commit(struct ring_buffer_per_cpu *cpu_buffer)
2851 local_inc(&cpu_buffer->committing);
2852 local_inc(&cpu_buffer->commits);
2855 static __always_inline void
2856 rb_set_commit_to_write(struct ring_buffer_per_cpu *cpu_buffer)
2858 unsigned long max_count;
2861 * We only race with interrupts and NMIs on this CPU.
2862 * If we own the commit event, then we can commit
2863 * all others that interrupted us, since the interruptions
2864 * are in stack format (they finish before they come
2865 * back to us). This allows us to do a simple loop to
2866 * assign the commit to the tail.
2869 max_count = cpu_buffer->nr_pages * 100;
2871 while (cpu_buffer->commit_page != READ_ONCE(cpu_buffer->tail_page)) {
2872 if (RB_WARN_ON(cpu_buffer, !(--max_count)))
2874 if (RB_WARN_ON(cpu_buffer,
2875 rb_is_reader_page(cpu_buffer->tail_page)))
2877 local_set(&cpu_buffer->commit_page->page->commit,
2878 rb_page_write(cpu_buffer->commit_page));
2879 rb_inc_page(&cpu_buffer->commit_page);
2880 /* add barrier to keep gcc from optimizing too much */
2883 while (rb_commit_index(cpu_buffer) !=
2884 rb_page_write(cpu_buffer->commit_page)) {
2886 local_set(&cpu_buffer->commit_page->page->commit,
2887 rb_page_write(cpu_buffer->commit_page));
2888 RB_WARN_ON(cpu_buffer,
2889 local_read(&cpu_buffer->commit_page->page->commit) &
2894 /* again, keep gcc from optimizing */
2898 * If an interrupt came in just after the first while loop
2899 * and pushed the tail page forward, we will be left with
2900 * a dangling commit that will never go forward.
2902 if (unlikely(cpu_buffer->commit_page != READ_ONCE(cpu_buffer->tail_page)))
2906 static __always_inline void rb_end_commit(struct ring_buffer_per_cpu *cpu_buffer)
2908 unsigned long commits;
2910 if (RB_WARN_ON(cpu_buffer,
2911 !local_read(&cpu_buffer->committing)))
2915 commits = local_read(&cpu_buffer->commits);
2916 /* synchronize with interrupts */
2918 if (local_read(&cpu_buffer->committing) == 1)
2919 rb_set_commit_to_write(cpu_buffer);
2921 local_dec(&cpu_buffer->committing);
2923 /* synchronize with interrupts */
2927 * Need to account for interrupts coming in between the
2928 * updating of the commit page and the clearing of the
2929 * committing counter.
2931 if (unlikely(local_read(&cpu_buffer->commits) != commits) &&
2932 !local_read(&cpu_buffer->committing)) {
2933 local_inc(&cpu_buffer->committing);
2938 static inline void rb_event_discard(struct ring_buffer_event *event)
2940 if (extended_time(event))
2941 event = skip_time_extend(event);
2943 /* array[0] holds the actual length for the discarded event */
2944 event->array[0] = rb_event_data_length(event) - RB_EVNT_HDR_SIZE;
2945 event->type_len = RINGBUF_TYPE_PADDING;
2946 /* time delta must be non zero */
2947 if (!event->time_delta)
2948 event->time_delta = 1;
2951 static void rb_commit(struct ring_buffer_per_cpu *cpu_buffer,
2952 struct ring_buffer_event *event)
2954 local_inc(&cpu_buffer->entries);
2955 rb_end_commit(cpu_buffer);
2958 static __always_inline void
2959 rb_wakeups(struct trace_buffer *buffer, struct ring_buffer_per_cpu *cpu_buffer)
2965 if (buffer->irq_work.waiters_pending) {
2966 buffer->irq_work.waiters_pending = false;
2967 /* irq_work_queue() supplies it's own memory barriers */
2968 irq_work_queue(&buffer->irq_work.work);
2971 if (cpu_buffer->irq_work.waiters_pending) {
2972 cpu_buffer->irq_work.waiters_pending = false;
2973 /* irq_work_queue() supplies it's own memory barriers */
2974 irq_work_queue(&cpu_buffer->irq_work.work);
2977 if (cpu_buffer->last_pages_touch == local_read(&cpu_buffer->pages_touched))
2980 if (cpu_buffer->reader_page == cpu_buffer->commit_page)
2983 if (!cpu_buffer->irq_work.full_waiters_pending)
2986 cpu_buffer->last_pages_touch = local_read(&cpu_buffer->pages_touched);
2988 full = cpu_buffer->shortest_full;
2989 nr_pages = cpu_buffer->nr_pages;
2990 dirty = ring_buffer_nr_dirty_pages(buffer, cpu_buffer->cpu);
2991 if (full && nr_pages && (dirty * 100) <= full * nr_pages)
2994 cpu_buffer->irq_work.wakeup_full = true;
2995 cpu_buffer->irq_work.full_waiters_pending = false;
2996 /* irq_work_queue() supplies it's own memory barriers */
2997 irq_work_queue(&cpu_buffer->irq_work.work);
3000 #ifdef CONFIG_RING_BUFFER_RECORD_RECURSION
3001 # define do_ring_buffer_record_recursion() \
3002 do_ftrace_record_recursion(_THIS_IP_, _RET_IP_)
3004 # define do_ring_buffer_record_recursion() do { } while (0)
3008 * The lock and unlock are done within a preempt disable section.
3009 * The current_context per_cpu variable can only be modified
3010 * by the current task between lock and unlock. But it can
3011 * be modified more than once via an interrupt. To pass this
3012 * information from the lock to the unlock without having to
3013 * access the 'in_interrupt()' functions again (which do show
3014 * a bit of overhead in something as critical as function tracing,
3015 * we use a bitmask trick.
3017 * bit 1 = NMI context
3018 * bit 2 = IRQ context
3019 * bit 3 = SoftIRQ context
3020 * bit 4 = normal context.
3022 * This works because this is the order of contexts that can
3023 * preempt other contexts. A SoftIRQ never preempts an IRQ
3026 * When the context is determined, the corresponding bit is
3027 * checked and set (if it was set, then a recursion of that context
3030 * On unlock, we need to clear this bit. To do so, just subtract
3031 * 1 from the current_context and AND it to itself.
3035 * 101 & 100 = 100 (clearing bit zero)
3038 * 1010 & 1001 = 1000 (clearing bit 1)
3040 * The least significant bit can be cleared this way, and it
3041 * just so happens that it is the same bit corresponding to
3042 * the current context.
3044 * Now the TRANSITION bit breaks the above slightly. The TRANSITION bit
3045 * is set when a recursion is detected at the current context, and if
3046 * the TRANSITION bit is already set, it will fail the recursion.
3047 * This is needed because there's a lag between the changing of
3048 * interrupt context and updating the preempt count. In this case,
3049 * a false positive will be found. To handle this, one extra recursion
3050 * is allowed, and this is done by the TRANSITION bit. If the TRANSITION
3051 * bit is already set, then it is considered a recursion and the function
3052 * ends. Otherwise, the TRANSITION bit is set, and that bit is returned.
3054 * On the trace_recursive_unlock(), the TRANSITION bit will be the first
3055 * to be cleared. Even if it wasn't the context that set it. That is,
3056 * if an interrupt comes in while NORMAL bit is set and the ring buffer
3057 * is called before preempt_count() is updated, since the check will
3058 * be on the NORMAL bit, the TRANSITION bit will then be set. If an
3059 * NMI then comes in, it will set the NMI bit, but when the NMI code
3060 * does the trace_recursive_unlock() it will clear the TRANSTION bit
3061 * and leave the NMI bit set. But this is fine, because the interrupt
3062 * code that set the TRANSITION bit will then clear the NMI bit when it
3063 * calls trace_recursive_unlock(). If another NMI comes in, it will
3064 * set the TRANSITION bit and continue.
3066 * Note: The TRANSITION bit only handles a single transition between context.
3069 static __always_inline int
3070 trace_recursive_lock(struct ring_buffer_per_cpu *cpu_buffer)
3072 unsigned int val = cpu_buffer->current_context;
3073 unsigned long pc = preempt_count();
3076 if (!(pc & (NMI_MASK | HARDIRQ_MASK | SOFTIRQ_OFFSET)))
3077 bit = RB_CTX_NORMAL;
3079 bit = pc & NMI_MASK ? RB_CTX_NMI :
3080 pc & HARDIRQ_MASK ? RB_CTX_IRQ : RB_CTX_SOFTIRQ;
3082 if (unlikely(val & (1 << (bit + cpu_buffer->nest)))) {
3084 * It is possible that this was called by transitioning
3085 * between interrupt context, and preempt_count() has not
3086 * been updated yet. In this case, use the TRANSITION bit.
3088 bit = RB_CTX_TRANSITION;
3089 if (val & (1 << (bit + cpu_buffer->nest))) {
3090 do_ring_buffer_record_recursion();
3095 val |= (1 << (bit + cpu_buffer->nest));
3096 cpu_buffer->current_context = val;
3101 static __always_inline void
3102 trace_recursive_unlock(struct ring_buffer_per_cpu *cpu_buffer)
3104 cpu_buffer->current_context &=
3105 cpu_buffer->current_context - (1 << cpu_buffer->nest);
3108 /* The recursive locking above uses 5 bits */
3109 #define NESTED_BITS 5
3112 * ring_buffer_nest_start - Allow to trace while nested
3113 * @buffer: The ring buffer to modify
3115 * The ring buffer has a safety mechanism to prevent recursion.
3116 * But there may be a case where a trace needs to be done while
3117 * tracing something else. In this case, calling this function
3118 * will allow this function to nest within a currently active
3119 * ring_buffer_lock_reserve().
3121 * Call this function before calling another ring_buffer_lock_reserve() and
3122 * call ring_buffer_nest_end() after the nested ring_buffer_unlock_commit().
3124 void ring_buffer_nest_start(struct trace_buffer *buffer)
3126 struct ring_buffer_per_cpu *cpu_buffer;
3129 /* Enabled by ring_buffer_nest_end() */
3130 preempt_disable_notrace();
3131 cpu = raw_smp_processor_id();
3132 cpu_buffer = buffer->buffers[cpu];
3133 /* This is the shift value for the above recursive locking */
3134 cpu_buffer->nest += NESTED_BITS;
3138 * ring_buffer_nest_end - Allow to trace while nested
3139 * @buffer: The ring buffer to modify
3141 * Must be called after ring_buffer_nest_start() and after the
3142 * ring_buffer_unlock_commit().
3144 void ring_buffer_nest_end(struct trace_buffer *buffer)
3146 struct ring_buffer_per_cpu *cpu_buffer;
3149 /* disabled by ring_buffer_nest_start() */
3150 cpu = raw_smp_processor_id();
3151 cpu_buffer = buffer->buffers[cpu];
3152 /* This is the shift value for the above recursive locking */
3153 cpu_buffer->nest -= NESTED_BITS;
3154 preempt_enable_notrace();
3158 * ring_buffer_unlock_commit - commit a reserved
3159 * @buffer: The buffer to commit to
3160 * @event: The event pointer to commit.
3162 * This commits the data to the ring buffer, and releases any locks held.
3164 * Must be paired with ring_buffer_lock_reserve.
3166 int ring_buffer_unlock_commit(struct trace_buffer *buffer,
3167 struct ring_buffer_event *event)
3169 struct ring_buffer_per_cpu *cpu_buffer;
3170 int cpu = raw_smp_processor_id();
3172 cpu_buffer = buffer->buffers[cpu];
3174 rb_commit(cpu_buffer, event);
3176 rb_wakeups(buffer, cpu_buffer);
3178 trace_recursive_unlock(cpu_buffer);
3180 preempt_enable_notrace();
3184 EXPORT_SYMBOL_GPL(ring_buffer_unlock_commit);
3186 /* Special value to validate all deltas on a page. */
3187 #define CHECK_FULL_PAGE 1L
3189 #ifdef CONFIG_RING_BUFFER_VALIDATE_TIME_DELTAS
3190 static void dump_buffer_page(struct buffer_data_page *bpage,
3191 struct rb_event_info *info,
3194 struct ring_buffer_event *event;
3198 ts = bpage->time_stamp;
3199 pr_warn(" [%lld] PAGE TIME STAMP\n", ts);
3201 for (e = 0; e < tail; e += rb_event_length(event)) {
3203 event = (struct ring_buffer_event *)(bpage->data + e);
3205 switch (event->type_len) {
3207 case RINGBUF_TYPE_TIME_EXTEND:
3208 delta = ring_buffer_event_time_stamp(event);
3210 pr_warn(" [%lld] delta:%lld TIME EXTEND\n", ts, delta);
3213 case RINGBUF_TYPE_TIME_STAMP:
3214 delta = ring_buffer_event_time_stamp(event);
3216 pr_warn(" [%lld] absolute:%lld TIME STAMP\n", ts, delta);
3219 case RINGBUF_TYPE_PADDING:
3220 ts += event->time_delta;
3221 pr_warn(" [%lld] delta:%d PADDING\n", ts, event->time_delta);
3224 case RINGBUF_TYPE_DATA:
3225 ts += event->time_delta;
3226 pr_warn(" [%lld] delta:%d\n", ts, event->time_delta);
3235 static DEFINE_PER_CPU(atomic_t, checking);
3236 static atomic_t ts_dump;
3239 * Check if the current event time stamp matches the deltas on
3242 static void check_buffer(struct ring_buffer_per_cpu *cpu_buffer,
3243 struct rb_event_info *info,
3246 struct ring_buffer_event *event;
3247 struct buffer_data_page *bpage;
3252 bpage = info->tail_page->page;
3254 if (tail == CHECK_FULL_PAGE) {
3256 tail = local_read(&bpage->commit);
3257 } else if (info->add_timestamp &
3258 (RB_ADD_STAMP_FORCE | RB_ADD_STAMP_ABSOLUTE)) {
3259 /* Ignore events with absolute time stamps */
3264 * Do not check the first event (skip possible extends too).
3265 * Also do not check if previous events have not been committed.
3267 if (tail <= 8 || tail > local_read(&bpage->commit))
3271 * If this interrupted another event,
3273 if (atomic_inc_return(this_cpu_ptr(&checking)) != 1)
3276 ts = bpage->time_stamp;
3278 for (e = 0; e < tail; e += rb_event_length(event)) {
3280 event = (struct ring_buffer_event *)(bpage->data + e);
3282 switch (event->type_len) {
3284 case RINGBUF_TYPE_TIME_EXTEND:
3285 delta = ring_buffer_event_time_stamp(event);
3289 case RINGBUF_TYPE_TIME_STAMP:
3290 delta = ring_buffer_event_time_stamp(event);
3294 case RINGBUF_TYPE_PADDING:
3295 if (event->time_delta == 1)
3298 case RINGBUF_TYPE_DATA:
3299 ts += event->time_delta;
3303 RB_WARN_ON(cpu_buffer, 1);
3306 if ((full && ts > info->ts) ||
3307 (!full && ts + info->delta != info->ts)) {
3308 /* If another report is happening, ignore this one */
3309 if (atomic_inc_return(&ts_dump) != 1) {
3310 atomic_dec(&ts_dump);
3313 atomic_inc(&cpu_buffer->record_disabled);
3314 pr_warn("[CPU: %d]TIME DOES NOT MATCH expected:%lld actual:%lld delta:%lld after:%lld\n",
3316 ts + info->delta, info->ts, info->delta, info->after);
3317 dump_buffer_page(bpage, info, tail);
3318 atomic_dec(&ts_dump);
3319 /* Do not re-enable checking */
3323 atomic_dec(this_cpu_ptr(&checking));
3326 static inline void check_buffer(struct ring_buffer_per_cpu *cpu_buffer,
3327 struct rb_event_info *info,
3331 #endif /* CONFIG_RING_BUFFER_VALIDATE_TIME_DELTAS */
3333 static struct ring_buffer_event *
3334 __rb_reserve_next(struct ring_buffer_per_cpu *cpu_buffer,
3335 struct rb_event_info *info)
3337 struct ring_buffer_event *event;
3338 struct buffer_page *tail_page;
3339 unsigned long tail, write, w;
3343 /* Don't let the compiler play games with cpu_buffer->tail_page */
3344 tail_page = info->tail_page = READ_ONCE(cpu_buffer->tail_page);
3346 /*A*/ w = local_read(&tail_page->write) & RB_WRITE_MASK;
3348 b_ok = rb_time_read(&cpu_buffer->before_stamp, &info->before);
3349 a_ok = rb_time_read(&cpu_buffer->write_stamp, &info->after);
3351 info->ts = rb_time_stamp(cpu_buffer->buffer);
3353 if ((info->add_timestamp & RB_ADD_STAMP_ABSOLUTE)) {
3354 info->delta = info->ts;
3357 * If interrupting an event time update, we may need an
3358 * absolute timestamp.
3359 * Don't bother if this is the start of a new page (w == 0).
3361 if (unlikely(!a_ok || !b_ok || (info->before != info->after && w))) {
3362 info->add_timestamp |= RB_ADD_STAMP_FORCE | RB_ADD_STAMP_EXTEND;
3363 info->length += RB_LEN_TIME_EXTEND;
3365 info->delta = info->ts - info->after;
3366 if (unlikely(test_time_stamp(info->delta))) {
3367 info->add_timestamp |= RB_ADD_STAMP_EXTEND;
3368 info->length += RB_LEN_TIME_EXTEND;
3373 /*B*/ rb_time_set(&cpu_buffer->before_stamp, info->ts);
3375 /*C*/ write = local_add_return(info->length, &tail_page->write);
3377 /* set write to only the index of the write */
3378 write &= RB_WRITE_MASK;
3380 tail = write - info->length;
3382 /* See if we shot pass the end of this buffer page */
3383 if (unlikely(write > BUF_PAGE_SIZE)) {
3384 /* before and after may now different, fix it up*/
3385 b_ok = rb_time_read(&cpu_buffer->before_stamp, &info->before);
3386 a_ok = rb_time_read(&cpu_buffer->write_stamp, &info->after);
3387 if (a_ok && b_ok && info->before != info->after)
3388 (void)rb_time_cmpxchg(&cpu_buffer->before_stamp,
3389 info->before, info->after);
3391 check_buffer(cpu_buffer, info, CHECK_FULL_PAGE);
3392 return rb_move_tail(cpu_buffer, tail, info);
3395 if (likely(tail == w)) {
3399 /* Nothing interrupted us between A and C */
3400 /*D*/ rb_time_set(&cpu_buffer->write_stamp, info->ts);
3402 /*E*/ s_ok = rb_time_read(&cpu_buffer->before_stamp, &save_before);
3403 RB_WARN_ON(cpu_buffer, !s_ok);
3404 if (likely(!(info->add_timestamp &
3405 (RB_ADD_STAMP_FORCE | RB_ADD_STAMP_ABSOLUTE))))
3406 /* This did not interrupt any time update */
3407 info->delta = info->ts - info->after;
3409 /* Just use full timestamp for interrupting event */
3410 info->delta = info->ts;
3412 check_buffer(cpu_buffer, info, tail);
3413 if (unlikely(info->ts != save_before)) {
3414 /* SLOW PATH - Interrupted between C and E */
3416 a_ok = rb_time_read(&cpu_buffer->write_stamp, &info->after);
3417 RB_WARN_ON(cpu_buffer, !a_ok);
3419 /* Write stamp must only go forward */
3420 if (save_before > info->after) {
3422 * We do not care about the result, only that
3423 * it gets updated atomically.
3425 (void)rb_time_cmpxchg(&cpu_buffer->write_stamp,
3426 info->after, save_before);
3431 /* SLOW PATH - Interrupted between A and C */
3432 a_ok = rb_time_read(&cpu_buffer->write_stamp, &info->after);
3433 /* Was interrupted before here, write_stamp must be valid */
3434 RB_WARN_ON(cpu_buffer, !a_ok);
3435 ts = rb_time_stamp(cpu_buffer->buffer);
3437 /*E*/ if (write == (local_read(&tail_page->write) & RB_WRITE_MASK) &&
3439 rb_time_cmpxchg(&cpu_buffer->write_stamp,
3441 /* Nothing came after this event between C and E */
3442 info->delta = ts - info->after;
3446 * Interrupted between C and E:
3447 * Lost the previous events time stamp. Just set the
3448 * delta to zero, and this will be the same time as
3449 * the event this event interrupted. And the events that
3450 * came after this will still be correct (as they would
3451 * have built their delta on the previous event.
3455 info->add_timestamp &= ~RB_ADD_STAMP_FORCE;
3459 * If this is the first commit on the page, then it has the same
3460 * timestamp as the page itself.
3462 if (unlikely(!tail && !(info->add_timestamp &
3463 (RB_ADD_STAMP_FORCE | RB_ADD_STAMP_ABSOLUTE))))
3466 /* We reserved something on the buffer */
3468 event = __rb_page_index(tail_page, tail);
3469 rb_update_event(cpu_buffer, event, info);
3471 local_inc(&tail_page->entries);
3474 * If this is the first commit on the page, then update
3477 if (unlikely(!tail))
3478 tail_page->page->time_stamp = info->ts;
3480 /* account for these added bytes */
3481 local_add(info->length, &cpu_buffer->entries_bytes);
3486 static __always_inline struct ring_buffer_event *
3487 rb_reserve_next_event(struct trace_buffer *buffer,
3488 struct ring_buffer_per_cpu *cpu_buffer,
3489 unsigned long length)
3491 struct ring_buffer_event *event;
3492 struct rb_event_info info;
3496 rb_start_commit(cpu_buffer);
3497 /* The commit page can not change after this */
3499 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
3501 * Due to the ability to swap a cpu buffer from a buffer
3502 * it is possible it was swapped before we committed.
3503 * (committing stops a swap). We check for it here and
3504 * if it happened, we have to fail the write.
3507 if (unlikely(READ_ONCE(cpu_buffer->buffer) != buffer)) {
3508 local_dec(&cpu_buffer->committing);
3509 local_dec(&cpu_buffer->commits);
3514 info.length = rb_calculate_event_length(length);
3516 if (ring_buffer_time_stamp_abs(cpu_buffer->buffer)) {
3517 add_ts_default = RB_ADD_STAMP_ABSOLUTE;
3518 info.length += RB_LEN_TIME_EXTEND;
3520 add_ts_default = RB_ADD_STAMP_NONE;
3524 info.add_timestamp = add_ts_default;
3528 * We allow for interrupts to reenter here and do a trace.
3529 * If one does, it will cause this original code to loop
3530 * back here. Even with heavy interrupts happening, this
3531 * should only happen a few times in a row. If this happens
3532 * 1000 times in a row, there must be either an interrupt
3533 * storm or we have something buggy.
3536 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 1000))
3539 event = __rb_reserve_next(cpu_buffer, &info);
3541 if (unlikely(PTR_ERR(event) == -EAGAIN)) {
3542 if (info.add_timestamp & (RB_ADD_STAMP_FORCE | RB_ADD_STAMP_EXTEND))
3543 info.length -= RB_LEN_TIME_EXTEND;
3550 rb_end_commit(cpu_buffer);
3555 * ring_buffer_lock_reserve - reserve a part of the buffer
3556 * @buffer: the ring buffer to reserve from
3557 * @length: the length of the data to reserve (excluding event header)
3559 * Returns a reserved event on the ring buffer to copy directly to.
3560 * The user of this interface will need to get the body to write into
3561 * and can use the ring_buffer_event_data() interface.
3563 * The length is the length of the data needed, not the event length
3564 * which also includes the event header.
3566 * Must be paired with ring_buffer_unlock_commit, unless NULL is returned.
3567 * If NULL is returned, then nothing has been allocated or locked.
3569 struct ring_buffer_event *
3570 ring_buffer_lock_reserve(struct trace_buffer *buffer, unsigned long length)
3572 struct ring_buffer_per_cpu *cpu_buffer;
3573 struct ring_buffer_event *event;
3576 /* If we are tracing schedule, we don't want to recurse */
3577 preempt_disable_notrace();
3579 if (unlikely(atomic_read(&buffer->record_disabled)))
3582 cpu = raw_smp_processor_id();
3584 if (unlikely(!cpumask_test_cpu(cpu, buffer->cpumask)))
3587 cpu_buffer = buffer->buffers[cpu];
3589 if (unlikely(atomic_read(&cpu_buffer->record_disabled)))
3592 if (unlikely(length > BUF_MAX_DATA_SIZE))
3595 if (unlikely(trace_recursive_lock(cpu_buffer)))
3598 event = rb_reserve_next_event(buffer, cpu_buffer, length);
3605 trace_recursive_unlock(cpu_buffer);
3607 preempt_enable_notrace();
3610 EXPORT_SYMBOL_GPL(ring_buffer_lock_reserve);
3613 * Decrement the entries to the page that an event is on.
3614 * The event does not even need to exist, only the pointer
3615 * to the page it is on. This may only be called before the commit
3619 rb_decrement_entry(struct ring_buffer_per_cpu *cpu_buffer,
3620 struct ring_buffer_event *event)
3622 unsigned long addr = (unsigned long)event;
3623 struct buffer_page *bpage = cpu_buffer->commit_page;
3624 struct buffer_page *start;
3628 /* Do the likely case first */
3629 if (likely(bpage->page == (void *)addr)) {
3630 local_dec(&bpage->entries);
3635 * Because the commit page may be on the reader page we
3636 * start with the next page and check the end loop there.
3638 rb_inc_page(&bpage);
3641 if (bpage->page == (void *)addr) {
3642 local_dec(&bpage->entries);
3645 rb_inc_page(&bpage);
3646 } while (bpage != start);
3648 /* commit not part of this buffer?? */
3649 RB_WARN_ON(cpu_buffer, 1);
3653 * ring_buffer_discard_commit - discard an event that has not been committed
3654 * @buffer: the ring buffer
3655 * @event: non committed event to discard
3657 * Sometimes an event that is in the ring buffer needs to be ignored.
3658 * This function lets the user discard an event in the ring buffer
3659 * and then that event will not be read later.
3661 * This function only works if it is called before the item has been
3662 * committed. It will try to free the event from the ring buffer
3663 * if another event has not been added behind it.
3665 * If another event has been added behind it, it will set the event
3666 * up as discarded, and perform the commit.
3668 * If this function is called, do not call ring_buffer_unlock_commit on
3671 void ring_buffer_discard_commit(struct trace_buffer *buffer,
3672 struct ring_buffer_event *event)
3674 struct ring_buffer_per_cpu *cpu_buffer;
3677 /* The event is discarded regardless */
3678 rb_event_discard(event);
3680 cpu = smp_processor_id();
3681 cpu_buffer = buffer->buffers[cpu];
3684 * This must only be called if the event has not been
3685 * committed yet. Thus we can assume that preemption
3686 * is still disabled.
3688 RB_WARN_ON(buffer, !local_read(&cpu_buffer->committing));
3690 rb_decrement_entry(cpu_buffer, event);
3691 if (rb_try_to_discard(cpu_buffer, event))
3695 rb_end_commit(cpu_buffer);
3697 trace_recursive_unlock(cpu_buffer);
3699 preempt_enable_notrace();
3702 EXPORT_SYMBOL_GPL(ring_buffer_discard_commit);
3705 * ring_buffer_write - write data to the buffer without reserving
3706 * @buffer: The ring buffer to write to.
3707 * @length: The length of the data being written (excluding the event header)
3708 * @data: The data to write to the buffer.
3710 * This is like ring_buffer_lock_reserve and ring_buffer_unlock_commit as
3711 * one function. If you already have the data to write to the buffer, it
3712 * may be easier to simply call this function.
3714 * Note, like ring_buffer_lock_reserve, the length is the length of the data
3715 * and not the length of the event which would hold the header.
3717 int ring_buffer_write(struct trace_buffer *buffer,
3718 unsigned long length,
3721 struct ring_buffer_per_cpu *cpu_buffer;
3722 struct ring_buffer_event *event;
3727 preempt_disable_notrace();
3729 if (atomic_read(&buffer->record_disabled))
3732 cpu = raw_smp_processor_id();
3734 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3737 cpu_buffer = buffer->buffers[cpu];
3739 if (atomic_read(&cpu_buffer->record_disabled))
3742 if (length > BUF_MAX_DATA_SIZE)
3745 if (unlikely(trace_recursive_lock(cpu_buffer)))
3748 event = rb_reserve_next_event(buffer, cpu_buffer, length);
3752 body = rb_event_data(event);
3754 memcpy(body, data, length);
3756 rb_commit(cpu_buffer, event);
3758 rb_wakeups(buffer, cpu_buffer);
3763 trace_recursive_unlock(cpu_buffer);
3766 preempt_enable_notrace();
3770 EXPORT_SYMBOL_GPL(ring_buffer_write);
3772 static bool rb_per_cpu_empty(struct ring_buffer_per_cpu *cpu_buffer)
3774 struct buffer_page *reader = cpu_buffer->reader_page;
3775 struct buffer_page *head = rb_set_head_page(cpu_buffer);
3776 struct buffer_page *commit = cpu_buffer->commit_page;
3778 /* In case of error, head will be NULL */
3779 if (unlikely(!head))
3782 return reader->read == rb_page_commit(reader) &&
3783 (commit == reader ||
3785 head->read == rb_page_commit(commit)));
3789 * ring_buffer_record_disable - stop all writes into the buffer
3790 * @buffer: The ring buffer to stop writes to.
3792 * This prevents all writes to the buffer. Any attempt to write
3793 * to the buffer after this will fail and return NULL.
3795 * The caller should call synchronize_rcu() after this.
3797 void ring_buffer_record_disable(struct trace_buffer *buffer)
3799 atomic_inc(&buffer->record_disabled);
3801 EXPORT_SYMBOL_GPL(ring_buffer_record_disable);
3804 * ring_buffer_record_enable - enable writes to the buffer
3805 * @buffer: The ring buffer to enable writes
3807 * Note, multiple disables will need the same number of enables
3808 * to truly enable the writing (much like preempt_disable).
3810 void ring_buffer_record_enable(struct trace_buffer *buffer)
3812 atomic_dec(&buffer->record_disabled);
3814 EXPORT_SYMBOL_GPL(ring_buffer_record_enable);
3817 * ring_buffer_record_off - stop all writes into the buffer
3818 * @buffer: The ring buffer to stop writes to.
3820 * This prevents all writes to the buffer. Any attempt to write
3821 * to the buffer after this will fail and return NULL.
3823 * This is different than ring_buffer_record_disable() as
3824 * it works like an on/off switch, where as the disable() version
3825 * must be paired with a enable().
3827 void ring_buffer_record_off(struct trace_buffer *buffer)
3830 unsigned int new_rd;
3833 rd = atomic_read(&buffer->record_disabled);
3834 new_rd = rd | RB_BUFFER_OFF;
3835 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
3837 EXPORT_SYMBOL_GPL(ring_buffer_record_off);
3840 * ring_buffer_record_on - restart writes into the buffer
3841 * @buffer: The ring buffer to start writes to.
3843 * This enables all writes to the buffer that was disabled by
3844 * ring_buffer_record_off().
3846 * This is different than ring_buffer_record_enable() as
3847 * it works like an on/off switch, where as the enable() version
3848 * must be paired with a disable().
3850 void ring_buffer_record_on(struct trace_buffer *buffer)
3853 unsigned int new_rd;
3856 rd = atomic_read(&buffer->record_disabled);
3857 new_rd = rd & ~RB_BUFFER_OFF;
3858 } while (atomic_cmpxchg(&buffer->record_disabled, rd, new_rd) != rd);
3860 EXPORT_SYMBOL_GPL(ring_buffer_record_on);
3863 * ring_buffer_record_is_on - return true if the ring buffer can write
3864 * @buffer: The ring buffer to see if write is enabled
3866 * Returns true if the ring buffer is in a state that it accepts writes.
3868 bool ring_buffer_record_is_on(struct trace_buffer *buffer)
3870 return !atomic_read(&buffer->record_disabled);
3874 * ring_buffer_record_is_set_on - return true if the ring buffer is set writable
3875 * @buffer: The ring buffer to see if write is set enabled
3877 * Returns true if the ring buffer is set writable by ring_buffer_record_on().
3878 * Note that this does NOT mean it is in a writable state.
3880 * It may return true when the ring buffer has been disabled by
3881 * ring_buffer_record_disable(), as that is a temporary disabling of
3884 bool ring_buffer_record_is_set_on(struct trace_buffer *buffer)
3886 return !(atomic_read(&buffer->record_disabled) & RB_BUFFER_OFF);
3890 * ring_buffer_record_disable_cpu - stop all writes into the cpu_buffer
3891 * @buffer: The ring buffer to stop writes to.
3892 * @cpu: The CPU buffer to stop
3894 * This prevents all writes to the buffer. Any attempt to write
3895 * to the buffer after this will fail and return NULL.
3897 * The caller should call synchronize_rcu() after this.
3899 void ring_buffer_record_disable_cpu(struct trace_buffer *buffer, int cpu)
3901 struct ring_buffer_per_cpu *cpu_buffer;
3903 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3906 cpu_buffer = buffer->buffers[cpu];
3907 atomic_inc(&cpu_buffer->record_disabled);
3909 EXPORT_SYMBOL_GPL(ring_buffer_record_disable_cpu);
3912 * ring_buffer_record_enable_cpu - enable writes to the buffer
3913 * @buffer: The ring buffer to enable writes
3914 * @cpu: The CPU to enable.
3916 * Note, multiple disables will need the same number of enables
3917 * to truly enable the writing (much like preempt_disable).
3919 void ring_buffer_record_enable_cpu(struct trace_buffer *buffer, int cpu)
3921 struct ring_buffer_per_cpu *cpu_buffer;
3923 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3926 cpu_buffer = buffer->buffers[cpu];
3927 atomic_dec(&cpu_buffer->record_disabled);
3929 EXPORT_SYMBOL_GPL(ring_buffer_record_enable_cpu);
3932 * The total entries in the ring buffer is the running counter
3933 * of entries entered into the ring buffer, minus the sum of
3934 * the entries read from the ring buffer and the number of
3935 * entries that were overwritten.
3937 static inline unsigned long
3938 rb_num_of_entries(struct ring_buffer_per_cpu *cpu_buffer)
3940 return local_read(&cpu_buffer->entries) -
3941 (local_read(&cpu_buffer->overrun) + cpu_buffer->read);
3945 * ring_buffer_oldest_event_ts - get the oldest event timestamp from the buffer
3946 * @buffer: The ring buffer
3947 * @cpu: The per CPU buffer to read from.
3949 u64 ring_buffer_oldest_event_ts(struct trace_buffer *buffer, int cpu)
3951 unsigned long flags;
3952 struct ring_buffer_per_cpu *cpu_buffer;
3953 struct buffer_page *bpage;
3956 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3959 cpu_buffer = buffer->buffers[cpu];
3960 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
3962 * if the tail is on reader_page, oldest time stamp is on the reader
3965 if (cpu_buffer->tail_page == cpu_buffer->reader_page)
3966 bpage = cpu_buffer->reader_page;
3968 bpage = rb_set_head_page(cpu_buffer);
3970 ret = bpage->page->time_stamp;
3971 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
3975 EXPORT_SYMBOL_GPL(ring_buffer_oldest_event_ts);
3978 * ring_buffer_bytes_cpu - get the number of bytes consumed in a cpu buffer
3979 * @buffer: The ring buffer
3980 * @cpu: The per CPU buffer to read from.
3982 unsigned long ring_buffer_bytes_cpu(struct trace_buffer *buffer, int cpu)
3984 struct ring_buffer_per_cpu *cpu_buffer;
3987 if (!cpumask_test_cpu(cpu, buffer->cpumask))
3990 cpu_buffer = buffer->buffers[cpu];
3991 ret = local_read(&cpu_buffer->entries_bytes) - cpu_buffer->read_bytes;
3995 EXPORT_SYMBOL_GPL(ring_buffer_bytes_cpu);
3998 * ring_buffer_entries_cpu - get the number of entries in a cpu buffer
3999 * @buffer: The ring buffer
4000 * @cpu: The per CPU buffer to get the entries from.
4002 unsigned long ring_buffer_entries_cpu(struct trace_buffer *buffer, int cpu)
4004 struct ring_buffer_per_cpu *cpu_buffer;
4006 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4009 cpu_buffer = buffer->buffers[cpu];
4011 return rb_num_of_entries(cpu_buffer);
4013 EXPORT_SYMBOL_GPL(ring_buffer_entries_cpu);
4016 * ring_buffer_overrun_cpu - get the number of overruns caused by the ring
4017 * buffer wrapping around (only if RB_FL_OVERWRITE is on).
4018 * @buffer: The ring buffer
4019 * @cpu: The per CPU buffer to get the number of overruns from
4021 unsigned long ring_buffer_overrun_cpu(struct trace_buffer *buffer, int cpu)
4023 struct ring_buffer_per_cpu *cpu_buffer;
4026 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4029 cpu_buffer = buffer->buffers[cpu];
4030 ret = local_read(&cpu_buffer->overrun);
4034 EXPORT_SYMBOL_GPL(ring_buffer_overrun_cpu);
4037 * ring_buffer_commit_overrun_cpu - get the number of overruns caused by
4038 * commits failing due to the buffer wrapping around while there are uncommitted
4039 * events, such as during an interrupt storm.
4040 * @buffer: The ring buffer
4041 * @cpu: The per CPU buffer to get the number of overruns from
4044 ring_buffer_commit_overrun_cpu(struct trace_buffer *buffer, int cpu)
4046 struct ring_buffer_per_cpu *cpu_buffer;
4049 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4052 cpu_buffer = buffer->buffers[cpu];
4053 ret = local_read(&cpu_buffer->commit_overrun);
4057 EXPORT_SYMBOL_GPL(ring_buffer_commit_overrun_cpu);
4060 * ring_buffer_dropped_events_cpu - get the number of dropped events caused by
4061 * the ring buffer filling up (only if RB_FL_OVERWRITE is off).
4062 * @buffer: The ring buffer
4063 * @cpu: The per CPU buffer to get the number of overruns from
4066 ring_buffer_dropped_events_cpu(struct trace_buffer *buffer, int cpu)
4068 struct ring_buffer_per_cpu *cpu_buffer;
4071 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4074 cpu_buffer = buffer->buffers[cpu];
4075 ret = local_read(&cpu_buffer->dropped_events);
4079 EXPORT_SYMBOL_GPL(ring_buffer_dropped_events_cpu);
4082 * ring_buffer_read_events_cpu - get the number of events successfully read
4083 * @buffer: The ring buffer
4084 * @cpu: The per CPU buffer to get the number of events read
4087 ring_buffer_read_events_cpu(struct trace_buffer *buffer, int cpu)
4089 struct ring_buffer_per_cpu *cpu_buffer;
4091 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4094 cpu_buffer = buffer->buffers[cpu];
4095 return cpu_buffer->read;
4097 EXPORT_SYMBOL_GPL(ring_buffer_read_events_cpu);
4100 * ring_buffer_entries - get the number of entries in a buffer
4101 * @buffer: The ring buffer
4103 * Returns the total number of entries in the ring buffer
4106 unsigned long ring_buffer_entries(struct trace_buffer *buffer)
4108 struct ring_buffer_per_cpu *cpu_buffer;
4109 unsigned long entries = 0;
4112 /* if you care about this being correct, lock the buffer */
4113 for_each_buffer_cpu(buffer, cpu) {
4114 cpu_buffer = buffer->buffers[cpu];
4115 entries += rb_num_of_entries(cpu_buffer);
4120 EXPORT_SYMBOL_GPL(ring_buffer_entries);
4123 * ring_buffer_overruns - get the number of overruns in buffer
4124 * @buffer: The ring buffer
4126 * Returns the total number of overruns in the ring buffer
4129 unsigned long ring_buffer_overruns(struct trace_buffer *buffer)
4131 struct ring_buffer_per_cpu *cpu_buffer;
4132 unsigned long overruns = 0;
4135 /* if you care about this being correct, lock the buffer */
4136 for_each_buffer_cpu(buffer, cpu) {
4137 cpu_buffer = buffer->buffers[cpu];
4138 overruns += local_read(&cpu_buffer->overrun);
4143 EXPORT_SYMBOL_GPL(ring_buffer_overruns);
4145 static void rb_iter_reset(struct ring_buffer_iter *iter)
4147 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
4149 /* Iterator usage is expected to have record disabled */
4150 iter->head_page = cpu_buffer->reader_page;
4151 iter->head = cpu_buffer->reader_page->read;
4152 iter->next_event = iter->head;
4154 iter->cache_reader_page = iter->head_page;
4155 iter->cache_read = cpu_buffer->read;
4158 iter->read_stamp = cpu_buffer->read_stamp;
4159 iter->page_stamp = cpu_buffer->reader_page->page->time_stamp;
4161 iter->read_stamp = iter->head_page->page->time_stamp;
4162 iter->page_stamp = iter->read_stamp;
4167 * ring_buffer_iter_reset - reset an iterator
4168 * @iter: The iterator to reset
4170 * Resets the iterator, so that it will start from the beginning
4173 void ring_buffer_iter_reset(struct ring_buffer_iter *iter)
4175 struct ring_buffer_per_cpu *cpu_buffer;
4176 unsigned long flags;
4181 cpu_buffer = iter->cpu_buffer;
4183 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4184 rb_iter_reset(iter);
4185 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
4187 EXPORT_SYMBOL_GPL(ring_buffer_iter_reset);
4190 * ring_buffer_iter_empty - check if an iterator has no more to read
4191 * @iter: The iterator to check
4193 int ring_buffer_iter_empty(struct ring_buffer_iter *iter)
4195 struct ring_buffer_per_cpu *cpu_buffer;
4196 struct buffer_page *reader;
4197 struct buffer_page *head_page;
4198 struct buffer_page *commit_page;
4199 struct buffer_page *curr_commit_page;
4204 cpu_buffer = iter->cpu_buffer;
4205 reader = cpu_buffer->reader_page;
4206 head_page = cpu_buffer->head_page;
4207 commit_page = cpu_buffer->commit_page;
4208 commit_ts = commit_page->page->time_stamp;
4211 * When the writer goes across pages, it issues a cmpxchg which
4212 * is a mb(), which will synchronize with the rmb here.
4213 * (see rb_tail_page_update())
4216 commit = rb_page_commit(commit_page);
4217 /* We want to make sure that the commit page doesn't change */
4220 /* Make sure commit page didn't change */
4221 curr_commit_page = READ_ONCE(cpu_buffer->commit_page);
4222 curr_commit_ts = READ_ONCE(curr_commit_page->page->time_stamp);
4224 /* If the commit page changed, then there's more data */
4225 if (curr_commit_page != commit_page ||
4226 curr_commit_ts != commit_ts)
4229 /* Still racy, as it may return a false positive, but that's OK */
4230 return ((iter->head_page == commit_page && iter->head >= commit) ||
4231 (iter->head_page == reader && commit_page == head_page &&
4232 head_page->read == commit &&
4233 iter->head == rb_page_commit(cpu_buffer->reader_page)));
4235 EXPORT_SYMBOL_GPL(ring_buffer_iter_empty);
4238 rb_update_read_stamp(struct ring_buffer_per_cpu *cpu_buffer,
4239 struct ring_buffer_event *event)
4243 switch (event->type_len) {
4244 case RINGBUF_TYPE_PADDING:
4247 case RINGBUF_TYPE_TIME_EXTEND:
4248 delta = ring_buffer_event_time_stamp(event);
4249 cpu_buffer->read_stamp += delta;
4252 case RINGBUF_TYPE_TIME_STAMP:
4253 delta = ring_buffer_event_time_stamp(event);
4254 cpu_buffer->read_stamp = delta;
4257 case RINGBUF_TYPE_DATA:
4258 cpu_buffer->read_stamp += event->time_delta;
4262 RB_WARN_ON(cpu_buffer, 1);
4268 rb_update_iter_read_stamp(struct ring_buffer_iter *iter,
4269 struct ring_buffer_event *event)
4273 switch (event->type_len) {
4274 case RINGBUF_TYPE_PADDING:
4277 case RINGBUF_TYPE_TIME_EXTEND:
4278 delta = ring_buffer_event_time_stamp(event);
4279 iter->read_stamp += delta;
4282 case RINGBUF_TYPE_TIME_STAMP:
4283 delta = ring_buffer_event_time_stamp(event);
4284 iter->read_stamp = delta;
4287 case RINGBUF_TYPE_DATA:
4288 iter->read_stamp += event->time_delta;
4292 RB_WARN_ON(iter->cpu_buffer, 1);
4297 static struct buffer_page *
4298 rb_get_reader_page(struct ring_buffer_per_cpu *cpu_buffer)
4300 struct buffer_page *reader = NULL;
4301 unsigned long overwrite;
4302 unsigned long flags;
4306 local_irq_save(flags);
4307 arch_spin_lock(&cpu_buffer->lock);
4311 * This should normally only loop twice. But because the
4312 * start of the reader inserts an empty page, it causes
4313 * a case where we will loop three times. There should be no
4314 * reason to loop four times (that I know of).
4316 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 3)) {
4321 reader = cpu_buffer->reader_page;
4323 /* If there's more to read, return this page */
4324 if (cpu_buffer->reader_page->read < rb_page_size(reader))
4327 /* Never should we have an index greater than the size */
4328 if (RB_WARN_ON(cpu_buffer,
4329 cpu_buffer->reader_page->read > rb_page_size(reader)))
4332 /* check if we caught up to the tail */
4334 if (cpu_buffer->commit_page == cpu_buffer->reader_page)
4337 /* Don't bother swapping if the ring buffer is empty */
4338 if (rb_num_of_entries(cpu_buffer) == 0)
4342 * Reset the reader page to size zero.
4344 local_set(&cpu_buffer->reader_page->write, 0);
4345 local_set(&cpu_buffer->reader_page->entries, 0);
4346 local_set(&cpu_buffer->reader_page->page->commit, 0);
4347 cpu_buffer->reader_page->real_end = 0;
4351 * Splice the empty reader page into the list around the head.
4353 reader = rb_set_head_page(cpu_buffer);
4356 cpu_buffer->reader_page->list.next = rb_list_head(reader->list.next);
4357 cpu_buffer->reader_page->list.prev = reader->list.prev;
4360 * cpu_buffer->pages just needs to point to the buffer, it
4361 * has no specific buffer page to point to. Lets move it out
4362 * of our way so we don't accidentally swap it.
4364 cpu_buffer->pages = reader->list.prev;
4366 /* The reader page will be pointing to the new head */
4367 rb_set_list_to_head(&cpu_buffer->reader_page->list);
4370 * We want to make sure we read the overruns after we set up our
4371 * pointers to the next object. The writer side does a
4372 * cmpxchg to cross pages which acts as the mb on the writer
4373 * side. Note, the reader will constantly fail the swap
4374 * while the writer is updating the pointers, so this
4375 * guarantees that the overwrite recorded here is the one we
4376 * want to compare with the last_overrun.
4379 overwrite = local_read(&(cpu_buffer->overrun));
4382 * Here's the tricky part.
4384 * We need to move the pointer past the header page.
4385 * But we can only do that if a writer is not currently
4386 * moving it. The page before the header page has the
4387 * flag bit '1' set if it is pointing to the page we want.
4388 * but if the writer is in the process of moving it
4389 * than it will be '2' or already moved '0'.
4392 ret = rb_head_page_replace(reader, cpu_buffer->reader_page);
4395 * If we did not convert it, then we must try again.
4401 * Yay! We succeeded in replacing the page.
4403 * Now make the new head point back to the reader page.
4405 rb_list_head(reader->list.next)->prev = &cpu_buffer->reader_page->list;
4406 rb_inc_page(&cpu_buffer->head_page);
4408 local_inc(&cpu_buffer->pages_read);
4410 /* Finally update the reader page to the new head */
4411 cpu_buffer->reader_page = reader;
4412 cpu_buffer->reader_page->read = 0;
4414 if (overwrite != cpu_buffer->last_overrun) {
4415 cpu_buffer->lost_events = overwrite - cpu_buffer->last_overrun;
4416 cpu_buffer->last_overrun = overwrite;
4422 /* Update the read_stamp on the first event */
4423 if (reader && reader->read == 0)
4424 cpu_buffer->read_stamp = reader->page->time_stamp;
4426 arch_spin_unlock(&cpu_buffer->lock);
4427 local_irq_restore(flags);
4432 static void rb_advance_reader(struct ring_buffer_per_cpu *cpu_buffer)
4434 struct ring_buffer_event *event;
4435 struct buffer_page *reader;
4438 reader = rb_get_reader_page(cpu_buffer);
4440 /* This function should not be called when buffer is empty */
4441 if (RB_WARN_ON(cpu_buffer, !reader))
4444 event = rb_reader_event(cpu_buffer);
4446 if (event->type_len <= RINGBUF_TYPE_DATA_TYPE_LEN_MAX)
4449 rb_update_read_stamp(cpu_buffer, event);
4451 length = rb_event_length(event);
4452 cpu_buffer->reader_page->read += length;
4455 static void rb_advance_iter(struct ring_buffer_iter *iter)
4457 struct ring_buffer_per_cpu *cpu_buffer;
4459 cpu_buffer = iter->cpu_buffer;
4461 /* If head == next_event then we need to jump to the next event */
4462 if (iter->head == iter->next_event) {
4463 /* If the event gets overwritten again, there's nothing to do */
4464 if (rb_iter_head_event(iter) == NULL)
4468 iter->head = iter->next_event;
4471 * Check if we are at the end of the buffer.
4473 if (iter->next_event >= rb_page_size(iter->head_page)) {
4474 /* discarded commits can make the page empty */
4475 if (iter->head_page == cpu_buffer->commit_page)
4481 rb_update_iter_read_stamp(iter, iter->event);
4484 static int rb_lost_events(struct ring_buffer_per_cpu *cpu_buffer)
4486 return cpu_buffer->lost_events;
4489 static struct ring_buffer_event *
4490 rb_buffer_peek(struct ring_buffer_per_cpu *cpu_buffer, u64 *ts,
4491 unsigned long *lost_events)
4493 struct ring_buffer_event *event;
4494 struct buffer_page *reader;
4501 * We repeat when a time extend is encountered.
4502 * Since the time extend is always attached to a data event,
4503 * we should never loop more than once.
4504 * (We never hit the following condition more than twice).
4506 if (RB_WARN_ON(cpu_buffer, ++nr_loops > 2))
4509 reader = rb_get_reader_page(cpu_buffer);
4513 event = rb_reader_event(cpu_buffer);
4515 switch (event->type_len) {
4516 case RINGBUF_TYPE_PADDING:
4517 if (rb_null_event(event))
4518 RB_WARN_ON(cpu_buffer, 1);
4520 * Because the writer could be discarding every
4521 * event it creates (which would probably be bad)
4522 * if we were to go back to "again" then we may never
4523 * catch up, and will trigger the warn on, or lock
4524 * the box. Return the padding, and we will release
4525 * the current locks, and try again.
4529 case RINGBUF_TYPE_TIME_EXTEND:
4530 /* Internal data, OK to advance */
4531 rb_advance_reader(cpu_buffer);
4534 case RINGBUF_TYPE_TIME_STAMP:
4536 *ts = ring_buffer_event_time_stamp(event);
4537 ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
4538 cpu_buffer->cpu, ts);
4540 /* Internal data, OK to advance */
4541 rb_advance_reader(cpu_buffer);
4544 case RINGBUF_TYPE_DATA:
4546 *ts = cpu_buffer->read_stamp + event->time_delta;
4547 ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
4548 cpu_buffer->cpu, ts);
4551 *lost_events = rb_lost_events(cpu_buffer);
4555 RB_WARN_ON(cpu_buffer, 1);
4560 EXPORT_SYMBOL_GPL(ring_buffer_peek);
4562 static struct ring_buffer_event *
4563 rb_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
4565 struct trace_buffer *buffer;
4566 struct ring_buffer_per_cpu *cpu_buffer;
4567 struct ring_buffer_event *event;
4573 cpu_buffer = iter->cpu_buffer;
4574 buffer = cpu_buffer->buffer;
4577 * Check if someone performed a consuming read to
4578 * the buffer. A consuming read invalidates the iterator
4579 * and we need to reset the iterator in this case.
4581 if (unlikely(iter->cache_read != cpu_buffer->read ||
4582 iter->cache_reader_page != cpu_buffer->reader_page))
4583 rb_iter_reset(iter);
4586 if (ring_buffer_iter_empty(iter))
4590 * As the writer can mess with what the iterator is trying
4591 * to read, just give up if we fail to get an event after
4592 * three tries. The iterator is not as reliable when reading
4593 * the ring buffer with an active write as the consumer is.
4594 * Do not warn if the three failures is reached.
4599 if (rb_per_cpu_empty(cpu_buffer))
4602 if (iter->head >= rb_page_size(iter->head_page)) {
4607 event = rb_iter_head_event(iter);
4611 switch (event->type_len) {
4612 case RINGBUF_TYPE_PADDING:
4613 if (rb_null_event(event)) {
4617 rb_advance_iter(iter);
4620 case RINGBUF_TYPE_TIME_EXTEND:
4621 /* Internal data, OK to advance */
4622 rb_advance_iter(iter);
4625 case RINGBUF_TYPE_TIME_STAMP:
4627 *ts = ring_buffer_event_time_stamp(event);
4628 ring_buffer_normalize_time_stamp(cpu_buffer->buffer,
4629 cpu_buffer->cpu, ts);
4631 /* Internal data, OK to advance */
4632 rb_advance_iter(iter);
4635 case RINGBUF_TYPE_DATA:
4637 *ts = iter->read_stamp + event->time_delta;
4638 ring_buffer_normalize_time_stamp(buffer,
4639 cpu_buffer->cpu, ts);
4644 RB_WARN_ON(cpu_buffer, 1);
4649 EXPORT_SYMBOL_GPL(ring_buffer_iter_peek);
4651 static inline bool rb_reader_lock(struct ring_buffer_per_cpu *cpu_buffer)
4653 if (likely(!in_nmi())) {
4654 raw_spin_lock(&cpu_buffer->reader_lock);
4659 * If an NMI die dumps out the content of the ring buffer
4660 * trylock must be used to prevent a deadlock if the NMI
4661 * preempted a task that holds the ring buffer locks. If
4662 * we get the lock then all is fine, if not, then continue
4663 * to do the read, but this can corrupt the ring buffer,
4664 * so it must be permanently disabled from future writes.
4665 * Reading from NMI is a oneshot deal.
4667 if (raw_spin_trylock(&cpu_buffer->reader_lock))
4670 /* Continue without locking, but disable the ring buffer */
4671 atomic_inc(&cpu_buffer->record_disabled);
4676 rb_reader_unlock(struct ring_buffer_per_cpu *cpu_buffer, bool locked)
4679 raw_spin_unlock(&cpu_buffer->reader_lock);
4684 * ring_buffer_peek - peek at the next event to be read
4685 * @buffer: The ring buffer to read
4686 * @cpu: The cpu to peak at
4687 * @ts: The timestamp counter of this event.
4688 * @lost_events: a variable to store if events were lost (may be NULL)
4690 * This will return the event that will be read next, but does
4691 * not consume the data.
4693 struct ring_buffer_event *
4694 ring_buffer_peek(struct trace_buffer *buffer, int cpu, u64 *ts,
4695 unsigned long *lost_events)
4697 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
4698 struct ring_buffer_event *event;
4699 unsigned long flags;
4702 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4706 local_irq_save(flags);
4707 dolock = rb_reader_lock(cpu_buffer);
4708 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
4709 if (event && event->type_len == RINGBUF_TYPE_PADDING)
4710 rb_advance_reader(cpu_buffer);
4711 rb_reader_unlock(cpu_buffer, dolock);
4712 local_irq_restore(flags);
4714 if (event && event->type_len == RINGBUF_TYPE_PADDING)
4720 /** ring_buffer_iter_dropped - report if there are dropped events
4721 * @iter: The ring buffer iterator
4723 * Returns true if there was dropped events since the last peek.
4725 bool ring_buffer_iter_dropped(struct ring_buffer_iter *iter)
4727 bool ret = iter->missed_events != 0;
4729 iter->missed_events = 0;
4732 EXPORT_SYMBOL_GPL(ring_buffer_iter_dropped);
4735 * ring_buffer_iter_peek - peek at the next event to be read
4736 * @iter: The ring buffer iterator
4737 * @ts: The timestamp counter of this event.
4739 * This will return the event that will be read next, but does
4740 * not increment the iterator.
4742 struct ring_buffer_event *
4743 ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts)
4745 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
4746 struct ring_buffer_event *event;
4747 unsigned long flags;
4750 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4751 event = rb_iter_peek(iter, ts);
4752 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
4754 if (event && event->type_len == RINGBUF_TYPE_PADDING)
4761 * ring_buffer_consume - return an event and consume it
4762 * @buffer: The ring buffer to get the next event from
4763 * @cpu: the cpu to read the buffer from
4764 * @ts: a variable to store the timestamp (may be NULL)
4765 * @lost_events: a variable to store if events were lost (may be NULL)
4767 * Returns the next event in the ring buffer, and that event is consumed.
4768 * Meaning, that sequential reads will keep returning a different event,
4769 * and eventually empty the ring buffer if the producer is slower.
4771 struct ring_buffer_event *
4772 ring_buffer_consume(struct trace_buffer *buffer, int cpu, u64 *ts,
4773 unsigned long *lost_events)
4775 struct ring_buffer_per_cpu *cpu_buffer;
4776 struct ring_buffer_event *event = NULL;
4777 unsigned long flags;
4781 /* might be called in atomic */
4784 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4787 cpu_buffer = buffer->buffers[cpu];
4788 local_irq_save(flags);
4789 dolock = rb_reader_lock(cpu_buffer);
4791 event = rb_buffer_peek(cpu_buffer, ts, lost_events);
4793 cpu_buffer->lost_events = 0;
4794 rb_advance_reader(cpu_buffer);
4797 rb_reader_unlock(cpu_buffer, dolock);
4798 local_irq_restore(flags);
4803 if (event && event->type_len == RINGBUF_TYPE_PADDING)
4808 EXPORT_SYMBOL_GPL(ring_buffer_consume);
4811 * ring_buffer_read_prepare - Prepare for a non consuming read of the buffer
4812 * @buffer: The ring buffer to read from
4813 * @cpu: The cpu buffer to iterate over
4814 * @flags: gfp flags to use for memory allocation
4816 * This performs the initial preparations necessary to iterate
4817 * through the buffer. Memory is allocated, buffer recording
4818 * is disabled, and the iterator pointer is returned to the caller.
4820 * Disabling buffer recording prevents the reading from being
4821 * corrupted. This is not a consuming read, so a producer is not
4824 * After a sequence of ring_buffer_read_prepare calls, the user is
4825 * expected to make at least one call to ring_buffer_read_prepare_sync.
4826 * Afterwards, ring_buffer_read_start is invoked to get things going
4829 * This overall must be paired with ring_buffer_read_finish.
4831 struct ring_buffer_iter *
4832 ring_buffer_read_prepare(struct trace_buffer *buffer, int cpu, gfp_t flags)
4834 struct ring_buffer_per_cpu *cpu_buffer;
4835 struct ring_buffer_iter *iter;
4837 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4840 iter = kzalloc(sizeof(*iter), flags);
4844 iter->event = kmalloc(BUF_MAX_DATA_SIZE, flags);
4850 cpu_buffer = buffer->buffers[cpu];
4852 iter->cpu_buffer = cpu_buffer;
4854 atomic_inc(&cpu_buffer->resize_disabled);
4858 EXPORT_SYMBOL_GPL(ring_buffer_read_prepare);
4861 * ring_buffer_read_prepare_sync - Synchronize a set of prepare calls
4863 * All previously invoked ring_buffer_read_prepare calls to prepare
4864 * iterators will be synchronized. Afterwards, read_buffer_read_start
4865 * calls on those iterators are allowed.
4868 ring_buffer_read_prepare_sync(void)
4872 EXPORT_SYMBOL_GPL(ring_buffer_read_prepare_sync);
4875 * ring_buffer_read_start - start a non consuming read of the buffer
4876 * @iter: The iterator returned by ring_buffer_read_prepare
4878 * This finalizes the startup of an iteration through the buffer.
4879 * The iterator comes from a call to ring_buffer_read_prepare and
4880 * an intervening ring_buffer_read_prepare_sync must have been
4883 * Must be paired with ring_buffer_read_finish.
4886 ring_buffer_read_start(struct ring_buffer_iter *iter)
4888 struct ring_buffer_per_cpu *cpu_buffer;
4889 unsigned long flags;
4894 cpu_buffer = iter->cpu_buffer;
4896 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4897 arch_spin_lock(&cpu_buffer->lock);
4898 rb_iter_reset(iter);
4899 arch_spin_unlock(&cpu_buffer->lock);
4900 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
4902 EXPORT_SYMBOL_GPL(ring_buffer_read_start);
4905 * ring_buffer_read_finish - finish reading the iterator of the buffer
4906 * @iter: The iterator retrieved by ring_buffer_start
4908 * This re-enables the recording to the buffer, and frees the
4912 ring_buffer_read_finish(struct ring_buffer_iter *iter)
4914 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
4915 unsigned long flags;
4918 * Ring buffer is disabled from recording, here's a good place
4919 * to check the integrity of the ring buffer.
4920 * Must prevent readers from trying to read, as the check
4921 * clears the HEAD page and readers require it.
4923 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4924 rb_check_pages(cpu_buffer);
4925 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
4927 atomic_dec(&cpu_buffer->resize_disabled);
4931 EXPORT_SYMBOL_GPL(ring_buffer_read_finish);
4934 * ring_buffer_iter_advance - advance the iterator to the next location
4935 * @iter: The ring buffer iterator
4937 * Move the location of the iterator such that the next read will
4938 * be the next location of the iterator.
4940 void ring_buffer_iter_advance(struct ring_buffer_iter *iter)
4942 struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;
4943 unsigned long flags;
4945 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
4947 rb_advance_iter(iter);
4949 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
4951 EXPORT_SYMBOL_GPL(ring_buffer_iter_advance);
4954 * ring_buffer_size - return the size of the ring buffer (in bytes)
4955 * @buffer: The ring buffer.
4956 * @cpu: The CPU to get ring buffer size from.
4958 unsigned long ring_buffer_size(struct trace_buffer *buffer, int cpu)
4961 * Earlier, this method returned
4962 * BUF_PAGE_SIZE * buffer->nr_pages
4963 * Since the nr_pages field is now removed, we have converted this to
4964 * return the per cpu buffer value.
4966 if (!cpumask_test_cpu(cpu, buffer->cpumask))
4969 return BUF_PAGE_SIZE * buffer->buffers[cpu]->nr_pages;
4971 EXPORT_SYMBOL_GPL(ring_buffer_size);
4974 rb_reset_cpu(struct ring_buffer_per_cpu *cpu_buffer)
4976 rb_head_page_deactivate(cpu_buffer);
4978 cpu_buffer->head_page
4979 = list_entry(cpu_buffer->pages, struct buffer_page, list);
4980 local_set(&cpu_buffer->head_page->write, 0);
4981 local_set(&cpu_buffer->head_page->entries, 0);
4982 local_set(&cpu_buffer->head_page->page->commit, 0);
4984 cpu_buffer->head_page->read = 0;
4986 cpu_buffer->tail_page = cpu_buffer->head_page;
4987 cpu_buffer->commit_page = cpu_buffer->head_page;
4989 INIT_LIST_HEAD(&cpu_buffer->reader_page->list);
4990 INIT_LIST_HEAD(&cpu_buffer->new_pages);
4991 local_set(&cpu_buffer->reader_page->write, 0);
4992 local_set(&cpu_buffer->reader_page->entries, 0);
4993 local_set(&cpu_buffer->reader_page->page->commit, 0);
4994 cpu_buffer->reader_page->read = 0;
4996 local_set(&cpu_buffer->entries_bytes, 0);
4997 local_set(&cpu_buffer->overrun, 0);
4998 local_set(&cpu_buffer->commit_overrun, 0);
4999 local_set(&cpu_buffer->dropped_events, 0);
5000 local_set(&cpu_buffer->entries, 0);
5001 local_set(&cpu_buffer->committing, 0);
5002 local_set(&cpu_buffer->commits, 0);
5003 local_set(&cpu_buffer->pages_touched, 0);
5004 local_set(&cpu_buffer->pages_read, 0);
5005 cpu_buffer->last_pages_touch = 0;
5006 cpu_buffer->shortest_full = 0;
5007 cpu_buffer->read = 0;
5008 cpu_buffer->read_bytes = 0;
5010 rb_time_set(&cpu_buffer->write_stamp, 0);
5011 rb_time_set(&cpu_buffer->before_stamp, 0);
5013 cpu_buffer->lost_events = 0;
5014 cpu_buffer->last_overrun = 0;
5016 rb_head_page_activate(cpu_buffer);
5019 /* Must have disabled the cpu buffer then done a synchronize_rcu */
5020 static void reset_disabled_cpu_buffer(struct ring_buffer_per_cpu *cpu_buffer)
5022 unsigned long flags;
5024 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
5026 if (RB_WARN_ON(cpu_buffer, local_read(&cpu_buffer->committing)))
5029 arch_spin_lock(&cpu_buffer->lock);
5031 rb_reset_cpu(cpu_buffer);
5033 arch_spin_unlock(&cpu_buffer->lock);
5036 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
5040 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
5041 * @buffer: The ring buffer to reset a per cpu buffer of
5042 * @cpu: The CPU buffer to be reset
5044 void ring_buffer_reset_cpu(struct trace_buffer *buffer, int cpu)
5046 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
5048 if (!cpumask_test_cpu(cpu, buffer->cpumask))
5051 /* prevent another thread from changing buffer sizes */
5052 mutex_lock(&buffer->mutex);
5054 atomic_inc(&cpu_buffer->resize_disabled);
5055 atomic_inc(&cpu_buffer->record_disabled);
5057 /* Make sure all commits have finished */
5060 reset_disabled_cpu_buffer(cpu_buffer);
5062 atomic_dec(&cpu_buffer->record_disabled);
5063 atomic_dec(&cpu_buffer->resize_disabled);
5065 mutex_unlock(&buffer->mutex);
5067 EXPORT_SYMBOL_GPL(ring_buffer_reset_cpu);
5070 * ring_buffer_reset_cpu - reset a ring buffer per CPU buffer
5071 * @buffer: The ring buffer to reset a per cpu buffer of
5072 * @cpu: The CPU buffer to be reset
5074 void ring_buffer_reset_online_cpus(struct trace_buffer *buffer)
5076 struct ring_buffer_per_cpu *cpu_buffer;
5079 /* prevent another thread from changing buffer sizes */
5080 mutex_lock(&buffer->mutex);
5082 for_each_online_buffer_cpu(buffer, cpu) {
5083 cpu_buffer = buffer->buffers[cpu];
5085 atomic_inc(&cpu_buffer->resize_disabled);
5086 atomic_inc(&cpu_buffer->record_disabled);
5089 /* Make sure all commits have finished */
5092 for_each_online_buffer_cpu(buffer, cpu) {
5093 cpu_buffer = buffer->buffers[cpu];
5095 reset_disabled_cpu_buffer(cpu_buffer);
5097 atomic_dec(&cpu_buffer->record_disabled);
5098 atomic_dec(&cpu_buffer->resize_disabled);
5101 mutex_unlock(&buffer->mutex);
5105 * ring_buffer_reset - reset a ring buffer
5106 * @buffer: The ring buffer to reset all cpu buffers
5108 void ring_buffer_reset(struct trace_buffer *buffer)
5110 struct ring_buffer_per_cpu *cpu_buffer;
5113 for_each_buffer_cpu(buffer, cpu) {
5114 cpu_buffer = buffer->buffers[cpu];
5116 atomic_inc(&cpu_buffer->resize_disabled);
5117 atomic_inc(&cpu_buffer->record_disabled);
5120 /* Make sure all commits have finished */
5123 for_each_buffer_cpu(buffer, cpu) {
5124 cpu_buffer = buffer->buffers[cpu];
5126 reset_disabled_cpu_buffer(cpu_buffer);
5128 atomic_dec(&cpu_buffer->record_disabled);
5129 atomic_dec(&cpu_buffer->resize_disabled);
5132 EXPORT_SYMBOL_GPL(ring_buffer_reset);
5135 * rind_buffer_empty - is the ring buffer empty?
5136 * @buffer: The ring buffer to test
5138 bool ring_buffer_empty(struct trace_buffer *buffer)
5140 struct ring_buffer_per_cpu *cpu_buffer;
5141 unsigned long flags;
5146 /* yes this is racy, but if you don't like the race, lock the buffer */
5147 for_each_buffer_cpu(buffer, cpu) {
5148 cpu_buffer = buffer->buffers[cpu];
5149 local_irq_save(flags);
5150 dolock = rb_reader_lock(cpu_buffer);
5151 ret = rb_per_cpu_empty(cpu_buffer);
5152 rb_reader_unlock(cpu_buffer, dolock);
5153 local_irq_restore(flags);
5161 EXPORT_SYMBOL_GPL(ring_buffer_empty);
5164 * ring_buffer_empty_cpu - is a cpu buffer of a ring buffer empty?
5165 * @buffer: The ring buffer
5166 * @cpu: The CPU buffer to test
5168 bool ring_buffer_empty_cpu(struct trace_buffer *buffer, int cpu)
5170 struct ring_buffer_per_cpu *cpu_buffer;
5171 unsigned long flags;
5175 if (!cpumask_test_cpu(cpu, buffer->cpumask))
5178 cpu_buffer = buffer->buffers[cpu];
5179 local_irq_save(flags);
5180 dolock = rb_reader_lock(cpu_buffer);
5181 ret = rb_per_cpu_empty(cpu_buffer);
5182 rb_reader_unlock(cpu_buffer, dolock);
5183 local_irq_restore(flags);
5187 EXPORT_SYMBOL_GPL(ring_buffer_empty_cpu);
5189 #ifdef CONFIG_RING_BUFFER_ALLOW_SWAP
5191 * ring_buffer_swap_cpu - swap a CPU buffer between two ring buffers
5192 * @buffer_a: One buffer to swap with
5193 * @buffer_b: The other buffer to swap with
5194 * @cpu: the CPU of the buffers to swap
5196 * This function is useful for tracers that want to take a "snapshot"
5197 * of a CPU buffer and has another back up buffer lying around.
5198 * it is expected that the tracer handles the cpu buffer not being
5199 * used at the moment.
5201 int ring_buffer_swap_cpu(struct trace_buffer *buffer_a,
5202 struct trace_buffer *buffer_b, int cpu)
5204 struct ring_buffer_per_cpu *cpu_buffer_a;
5205 struct ring_buffer_per_cpu *cpu_buffer_b;
5208 if (!cpumask_test_cpu(cpu, buffer_a->cpumask) ||
5209 !cpumask_test_cpu(cpu, buffer_b->cpumask))
5212 cpu_buffer_a = buffer_a->buffers[cpu];
5213 cpu_buffer_b = buffer_b->buffers[cpu];
5215 /* At least make sure the two buffers are somewhat the same */
5216 if (cpu_buffer_a->nr_pages != cpu_buffer_b->nr_pages)
5221 if (atomic_read(&buffer_a->record_disabled))
5224 if (atomic_read(&buffer_b->record_disabled))
5227 if (atomic_read(&cpu_buffer_a->record_disabled))
5230 if (atomic_read(&cpu_buffer_b->record_disabled))
5234 * We can't do a synchronize_rcu here because this
5235 * function can be called in atomic context.
5236 * Normally this will be called from the same CPU as cpu.
5237 * If not it's up to the caller to protect this.
5239 atomic_inc(&cpu_buffer_a->record_disabled);
5240 atomic_inc(&cpu_buffer_b->record_disabled);
5243 if (local_read(&cpu_buffer_a->committing))
5245 if (local_read(&cpu_buffer_b->committing))
5248 buffer_a->buffers[cpu] = cpu_buffer_b;
5249 buffer_b->buffers[cpu] = cpu_buffer_a;
5251 cpu_buffer_b->buffer = buffer_a;
5252 cpu_buffer_a->buffer = buffer_b;
5257 atomic_dec(&cpu_buffer_a->record_disabled);
5258 atomic_dec(&cpu_buffer_b->record_disabled);
5262 EXPORT_SYMBOL_GPL(ring_buffer_swap_cpu);
5263 #endif /* CONFIG_RING_BUFFER_ALLOW_SWAP */
5266 * ring_buffer_alloc_read_page - allocate a page to read from buffer
5267 * @buffer: the buffer to allocate for.
5268 * @cpu: the cpu buffer to allocate.
5270 * This function is used in conjunction with ring_buffer_read_page.
5271 * When reading a full page from the ring buffer, these functions
5272 * can be used to speed up the process. The calling function should
5273 * allocate a few pages first with this function. Then when it
5274 * needs to get pages from the ring buffer, it passes the result
5275 * of this function into ring_buffer_read_page, which will swap
5276 * the page that was allocated, with the read page of the buffer.
5279 * The page allocated, or ERR_PTR
5281 void *ring_buffer_alloc_read_page(struct trace_buffer *buffer, int cpu)
5283 struct ring_buffer_per_cpu *cpu_buffer;
5284 struct buffer_data_page *bpage = NULL;
5285 unsigned long flags;
5288 if (!cpumask_test_cpu(cpu, buffer->cpumask))
5289 return ERR_PTR(-ENODEV);
5291 cpu_buffer = buffer->buffers[cpu];
5292 local_irq_save(flags);
5293 arch_spin_lock(&cpu_buffer->lock);
5295 if (cpu_buffer->free_page) {
5296 bpage = cpu_buffer->free_page;
5297 cpu_buffer->free_page = NULL;
5300 arch_spin_unlock(&cpu_buffer->lock);
5301 local_irq_restore(flags);
5306 page = alloc_pages_node(cpu_to_node(cpu),
5307 GFP_KERNEL | __GFP_NORETRY, 0);
5309 return ERR_PTR(-ENOMEM);
5311 bpage = page_address(page);
5314 rb_init_page(bpage);
5318 EXPORT_SYMBOL_GPL(ring_buffer_alloc_read_page);
5321 * ring_buffer_free_read_page - free an allocated read page
5322 * @buffer: the buffer the page was allocate for
5323 * @cpu: the cpu buffer the page came from
5324 * @data: the page to free
5326 * Free a page allocated from ring_buffer_alloc_read_page.
5328 void ring_buffer_free_read_page(struct trace_buffer *buffer, int cpu, void *data)
5330 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
5331 struct buffer_data_page *bpage = data;
5332 struct page *page = virt_to_page(bpage);
5333 unsigned long flags;
5335 /* If the page is still in use someplace else, we can't reuse it */
5336 if (page_ref_count(page) > 1)
5339 local_irq_save(flags);
5340 arch_spin_lock(&cpu_buffer->lock);
5342 if (!cpu_buffer->free_page) {
5343 cpu_buffer->free_page = bpage;
5347 arch_spin_unlock(&cpu_buffer->lock);
5348 local_irq_restore(flags);
5351 free_page((unsigned long)bpage);
5353 EXPORT_SYMBOL_GPL(ring_buffer_free_read_page);
5356 * ring_buffer_read_page - extract a page from the ring buffer
5357 * @buffer: buffer to extract from
5358 * @data_page: the page to use allocated from ring_buffer_alloc_read_page
5359 * @len: amount to extract
5360 * @cpu: the cpu of the buffer to extract
5361 * @full: should the extraction only happen when the page is full.
5363 * This function will pull out a page from the ring buffer and consume it.
5364 * @data_page must be the address of the variable that was returned
5365 * from ring_buffer_alloc_read_page. This is because the page might be used
5366 * to swap with a page in the ring buffer.
5369 * rpage = ring_buffer_alloc_read_page(buffer, cpu);
5370 * if (IS_ERR(rpage))
5371 * return PTR_ERR(rpage);
5372 * ret = ring_buffer_read_page(buffer, &rpage, len, cpu, 0);
5374 * process_page(rpage, ret);
5376 * When @full is set, the function will not return true unless
5377 * the writer is off the reader page.
5379 * Note: it is up to the calling functions to handle sleeps and wakeups.
5380 * The ring buffer can be used anywhere in the kernel and can not
5381 * blindly call wake_up. The layer that uses the ring buffer must be
5382 * responsible for that.
5385 * >=0 if data has been transferred, returns the offset of consumed data.
5386 * <0 if no data has been transferred.
5388 int ring_buffer_read_page(struct trace_buffer *buffer,
5389 void **data_page, size_t len, int cpu, int full)
5391 struct ring_buffer_per_cpu *cpu_buffer = buffer->buffers[cpu];
5392 struct ring_buffer_event *event;
5393 struct buffer_data_page *bpage;
5394 struct buffer_page *reader;
5395 unsigned long missed_events;
5396 unsigned long flags;
5397 unsigned int commit;
5402 if (!cpumask_test_cpu(cpu, buffer->cpumask))
5406 * If len is not big enough to hold the page header, then
5407 * we can not copy anything.
5409 if (len <= BUF_PAGE_HDR_SIZE)
5412 len -= BUF_PAGE_HDR_SIZE;
5421 raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);
5423 reader = rb_get_reader_page(cpu_buffer);
5427 event = rb_reader_event(cpu_buffer);
5429 read = reader->read;
5430 commit = rb_page_commit(reader);
5432 /* Check if any events were dropped */
5433 missed_events = cpu_buffer->lost_events;
5436 * If this page has been partially read or
5437 * if len is not big enough to read the rest of the page or
5438 * a writer is still on the page, then
5439 * we must copy the data from the page to the buffer.
5440 * Otherwise, we can simply swap the page with the one passed in.
5442 if (read || (len < (commit - read)) ||
5443 cpu_buffer->reader_page == cpu_buffer->commit_page) {
5444 struct buffer_data_page *rpage = cpu_buffer->reader_page->page;
5445 unsigned int rpos = read;
5446 unsigned int pos = 0;
5452 if (len > (commit - read))
5453 len = (commit - read);
5455 /* Always keep the time extend and data together */
5456 size = rb_event_ts_length(event);
5461 /* save the current timestamp, since the user will need it */
5462 save_timestamp = cpu_buffer->read_stamp;
5464 /* Need to copy one event at a time */
5466 /* We need the size of one event, because
5467 * rb_advance_reader only advances by one event,
5468 * whereas rb_event_ts_length may include the size of
5469 * one or two events.
5470 * We have already ensured there's enough space if this
5471 * is a time extend. */
5472 size = rb_event_length(event);
5473 memcpy(bpage->data + pos, rpage->data + rpos, size);
5477 rb_advance_reader(cpu_buffer);
5478 rpos = reader->read;
5484 event = rb_reader_event(cpu_buffer);
5485 /* Always keep the time extend and data together */
5486 size = rb_event_ts_length(event);
5487 } while (len >= size);
5490 local_set(&bpage->commit, pos);
5491 bpage->time_stamp = save_timestamp;
5493 /* we copied everything to the beginning */
5496 /* update the entry counter */
5497 cpu_buffer->read += rb_page_entries(reader);
5498 cpu_buffer->read_bytes += BUF_PAGE_SIZE;
5500 /* swap the pages */
5501 rb_init_page(bpage);
5502 bpage = reader->page;
5503 reader->page = *data_page;
5504 local_set(&reader->write, 0);
5505 local_set(&reader->entries, 0);
5510 * Use the real_end for the data size,
5511 * This gives us a chance to store the lost events
5514 if (reader->real_end)
5515 local_set(&bpage->commit, reader->real_end);
5519 cpu_buffer->lost_events = 0;
5521 commit = local_read(&bpage->commit);
5523 * Set a flag in the commit field if we lost events
5525 if (missed_events) {
5526 /* If there is room at the end of the page to save the
5527 * missed events, then record it there.
5529 if (BUF_PAGE_SIZE - commit >= sizeof(missed_events)) {
5530 memcpy(&bpage->data[commit], &missed_events,
5531 sizeof(missed_events));
5532 local_add(RB_MISSED_STORED, &bpage->commit);
5533 commit += sizeof(missed_events);
5535 local_add(RB_MISSED_EVENTS, &bpage->commit);
5539 * This page may be off to user land. Zero it out here.
5541 if (commit < BUF_PAGE_SIZE)
5542 memset(&bpage->data[commit], 0, BUF_PAGE_SIZE - commit);
5545 raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);
5550 EXPORT_SYMBOL_GPL(ring_buffer_read_page);
5553 * We only allocate new buffers, never free them if the CPU goes down.
5554 * If we were to free the buffer, then the user would lose any trace that was in
5557 int trace_rb_cpu_prepare(unsigned int cpu, struct hlist_node *node)
5559 struct trace_buffer *buffer;
5562 unsigned long nr_pages;
5564 buffer = container_of(node, struct trace_buffer, node);
5565 if (cpumask_test_cpu(cpu, buffer->cpumask))
5570 /* check if all cpu sizes are same */
5571 for_each_buffer_cpu(buffer, cpu_i) {
5572 /* fill in the size from first enabled cpu */
5574 nr_pages = buffer->buffers[cpu_i]->nr_pages;
5575 if (nr_pages != buffer->buffers[cpu_i]->nr_pages) {
5580 /* allocate minimum pages, user can later expand it */
5583 buffer->buffers[cpu] =
5584 rb_allocate_cpu_buffer(buffer, nr_pages, cpu);
5585 if (!buffer->buffers[cpu]) {
5586 WARN(1, "failed to allocate ring buffer on CPU %u\n",
5591 cpumask_set_cpu(cpu, buffer->cpumask);
5595 #ifdef CONFIG_RING_BUFFER_STARTUP_TEST
5597 * This is a basic integrity check of the ring buffer.
5598 * Late in the boot cycle this test will run when configured in.
5599 * It will kick off a thread per CPU that will go into a loop
5600 * writing to the per cpu ring buffer various sizes of data.
5601 * Some of the data will be large items, some small.
5603 * Another thread is created that goes into a spin, sending out
5604 * IPIs to the other CPUs to also write into the ring buffer.
5605 * this is to test the nesting ability of the buffer.
5607 * Basic stats are recorded and reported. If something in the
5608 * ring buffer should happen that's not expected, a big warning
5609 * is displayed and all ring buffers are disabled.
5611 static struct task_struct *rb_threads[NR_CPUS] __initdata;
5613 struct rb_test_data {
5614 struct trace_buffer *buffer;
5615 unsigned long events;
5616 unsigned long bytes_written;
5617 unsigned long bytes_alloc;
5618 unsigned long bytes_dropped;
5619 unsigned long events_nested;
5620 unsigned long bytes_written_nested;
5621 unsigned long bytes_alloc_nested;
5622 unsigned long bytes_dropped_nested;
5623 int min_size_nested;
5624 int max_size_nested;
5631 static struct rb_test_data rb_data[NR_CPUS] __initdata;
5634 #define RB_TEST_BUFFER_SIZE 1048576
5636 static char rb_string[] __initdata =
5637 "abcdefghijklmnopqrstuvwxyz1234567890!@#$%^&*()?+\\"
5638 "?+|:';\",.<>/?abcdefghijklmnopqrstuvwxyz1234567890"
5639 "!@#$%^&*()?+\\?+|:';\",.<>/?abcdefghijklmnopqrstuv";
5641 static bool rb_test_started __initdata;
5648 static __init int rb_write_something(struct rb_test_data *data, bool nested)
5650 struct ring_buffer_event *event;
5651 struct rb_item *item;
5658 /* Have nested writes different that what is written */
5659 cnt = data->cnt + (nested ? 27 : 0);
5661 /* Multiply cnt by ~e, to make some unique increment */
5662 size = (cnt * 68 / 25) % (sizeof(rb_string) - 1);
5664 len = size + sizeof(struct rb_item);
5666 started = rb_test_started;
5667 /* read rb_test_started before checking buffer enabled */
5670 event = ring_buffer_lock_reserve(data->buffer, len);
5672 /* Ignore dropped events before test starts. */
5675 data->bytes_dropped += len;
5677 data->bytes_dropped_nested += len;
5682 event_len = ring_buffer_event_length(event);
5684 if (RB_WARN_ON(data->buffer, event_len < len))
5687 item = ring_buffer_event_data(event);
5689 memcpy(item->str, rb_string, size);
5692 data->bytes_alloc_nested += event_len;
5693 data->bytes_written_nested += len;
5694 data->events_nested++;
5695 if (!data->min_size_nested || len < data->min_size_nested)
5696 data->min_size_nested = len;
5697 if (len > data->max_size_nested)
5698 data->max_size_nested = len;
5700 data->bytes_alloc += event_len;
5701 data->bytes_written += len;
5703 if (!data->min_size || len < data->min_size)
5704 data->max_size = len;
5705 if (len > data->max_size)
5706 data->max_size = len;
5710 ring_buffer_unlock_commit(data->buffer, event);
5715 static __init int rb_test(void *arg)
5717 struct rb_test_data *data = arg;
5719 while (!kthread_should_stop()) {
5720 rb_write_something(data, false);
5723 set_current_state(TASK_INTERRUPTIBLE);
5724 /* Now sleep between a min of 100-300us and a max of 1ms */
5725 usleep_range(((data->cnt % 3) + 1) * 100, 1000);
5731 static __init void rb_ipi(void *ignore)
5733 struct rb_test_data *data;
5734 int cpu = smp_processor_id();
5736 data = &rb_data[cpu];
5737 rb_write_something(data, true);
5740 static __init int rb_hammer_test(void *arg)
5742 while (!kthread_should_stop()) {
5744 /* Send an IPI to all cpus to write data! */
5745 smp_call_function(rb_ipi, NULL, 1);
5746 /* No sleep, but for non preempt, let others run */
5753 static __init int test_ringbuffer(void)
5755 struct task_struct *rb_hammer;
5756 struct trace_buffer *buffer;
5760 if (security_locked_down(LOCKDOWN_TRACEFS)) {
5761 pr_warn("Lockdown is enabled, skipping ring buffer tests\n");
5765 pr_info("Running ring buffer tests...\n");
5767 buffer = ring_buffer_alloc(RB_TEST_BUFFER_SIZE, RB_FL_OVERWRITE);
5768 if (WARN_ON(!buffer))
5771 /* Disable buffer so that threads can't write to it yet */
5772 ring_buffer_record_off(buffer);
5774 for_each_online_cpu(cpu) {
5775 rb_data[cpu].buffer = buffer;
5776 rb_data[cpu].cpu = cpu;
5777 rb_data[cpu].cnt = cpu;
5778 rb_threads[cpu] = kthread_create(rb_test, &rb_data[cpu],
5779 "rbtester/%d", cpu);
5780 if (WARN_ON(IS_ERR(rb_threads[cpu]))) {
5781 pr_cont("FAILED\n");
5782 ret = PTR_ERR(rb_threads[cpu]);
5786 kthread_bind(rb_threads[cpu], cpu);
5787 wake_up_process(rb_threads[cpu]);
5790 /* Now create the rb hammer! */
5791 rb_hammer = kthread_run(rb_hammer_test, NULL, "rbhammer");
5792 if (WARN_ON(IS_ERR(rb_hammer))) {
5793 pr_cont("FAILED\n");
5794 ret = PTR_ERR(rb_hammer);
5798 ring_buffer_record_on(buffer);
5800 * Show buffer is enabled before setting rb_test_started.
5801 * Yes there's a small race window where events could be
5802 * dropped and the thread wont catch it. But when a ring
5803 * buffer gets enabled, there will always be some kind of
5804 * delay before other CPUs see it. Thus, we don't care about
5805 * those dropped events. We care about events dropped after
5806 * the threads see that the buffer is active.
5809 rb_test_started = true;
5811 set_current_state(TASK_INTERRUPTIBLE);
5812 /* Just run for 10 seconds */;
5813 schedule_timeout(10 * HZ);
5815 kthread_stop(rb_hammer);
5818 for_each_online_cpu(cpu) {
5819 if (!rb_threads[cpu])
5821 kthread_stop(rb_threads[cpu]);
5824 ring_buffer_free(buffer);
5829 pr_info("finished\n");
5830 for_each_online_cpu(cpu) {
5831 struct ring_buffer_event *event;
5832 struct rb_test_data *data = &rb_data[cpu];
5833 struct rb_item *item;
5834 unsigned long total_events;
5835 unsigned long total_dropped;
5836 unsigned long total_written;
5837 unsigned long total_alloc;
5838 unsigned long total_read = 0;
5839 unsigned long total_size = 0;
5840 unsigned long total_len = 0;
5841 unsigned long total_lost = 0;
5844 int small_event_size;
5848 total_events = data->events + data->events_nested;
5849 total_written = data->bytes_written + data->bytes_written_nested;
5850 total_alloc = data->bytes_alloc + data->bytes_alloc_nested;
5851 total_dropped = data->bytes_dropped + data->bytes_dropped_nested;
5853 big_event_size = data->max_size + data->max_size_nested;
5854 small_event_size = data->min_size + data->min_size_nested;
5856 pr_info("CPU %d:\n", cpu);
5857 pr_info(" events: %ld\n", total_events);
5858 pr_info(" dropped bytes: %ld\n", total_dropped);
5859 pr_info(" alloced bytes: %ld\n", total_alloc);
5860 pr_info(" written bytes: %ld\n", total_written);
5861 pr_info(" biggest event: %d\n", big_event_size);
5862 pr_info(" smallest event: %d\n", small_event_size);
5864 if (RB_WARN_ON(buffer, total_dropped))
5869 while ((event = ring_buffer_consume(buffer, cpu, NULL, &lost))) {
5871 item = ring_buffer_event_data(event);
5872 total_len += ring_buffer_event_length(event);
5873 total_size += item->size + sizeof(struct rb_item);
5874 if (memcmp(&item->str[0], rb_string, item->size) != 0) {
5875 pr_info("FAILED!\n");
5876 pr_info("buffer had: %.*s\n", item->size, item->str);
5877 pr_info("expected: %.*s\n", item->size, rb_string);
5878 RB_WARN_ON(buffer, 1);
5889 pr_info(" read events: %ld\n", total_read);
5890 pr_info(" lost events: %ld\n", total_lost);
5891 pr_info(" total events: %ld\n", total_lost + total_read);
5892 pr_info(" recorded len bytes: %ld\n", total_len);
5893 pr_info(" recorded size bytes: %ld\n", total_size);
5895 pr_info(" With dropped events, record len and size may not match\n"
5896 " alloced and written from above\n");
5898 if (RB_WARN_ON(buffer, total_len != total_alloc ||
5899 total_size != total_written))
5902 if (RB_WARN_ON(buffer, total_lost + total_read != total_events))
5908 pr_info("Ring buffer PASSED!\n");
5910 ring_buffer_free(buffer);
5914 late_initcall(test_ringbuffer);
5915 #endif /* CONFIG_RING_BUFFER_STARTUP_TEST */