2 * ring_buffer_frontend.c
4 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; only
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * Ring buffer wait-free buffer synchronization. Producer-consumer and flight
22 * recorder (overwrite) modes. See thesis:
24 * Desnoyers, Mathieu (2009), "Low-Impact Operating System Tracing", Ph.D.
25 * dissertation, Ecole Polytechnique de Montreal.
26 * http://www.lttng.org/pub/thesis/desnoyers-dissertation-2009-12.pdf
28 * - Algorithm presentation in Chapter 5:
29 * "Lockless Multi-Core High-Throughput Buffering".
30 * - Algorithm formal verification in Section 8.6:
31 * "Formal verification of LTTng"
34 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
36 * Inspired from LTT and RelayFS:
37 * Karim Yaghmour <karim@opersys.com>
38 * Tom Zanussi <zanussi@us.ibm.com>
39 * Bob Wisniewski <bob@watson.ibm.com>
41 * Bob Wisniewski <bob@watson.ibm.com>
43 * Buffer reader semantic :
46 * while buffer is not finalized and empty
48 * - if return value != 0, continue
49 * - splice one subbuffer worth of data to a pipe
50 * - splice the data from pipe to disk/network
54 #include <linux/delay.h>
55 #include <linux/module.h>
56 #include <linux/percpu.h>
57 #include <asm/cacheflush.h>
59 #include <wrapper/ringbuffer/config.h>
60 #include <wrapper/ringbuffer/backend.h>
61 #include <wrapper/ringbuffer/frontend.h>
62 #include <wrapper/ringbuffer/iterator.h>
63 #include <wrapper/ringbuffer/nohz.h>
64 #include <wrapper/atomic.h>
65 #include <wrapper/kref.h>
66 #include <wrapper/percpu-defs.h>
67 #include <wrapper/timer.h>
68 #include <wrapper/vmalloc.h>
71 * Internal structure representing offsets to use at a sub-buffer switch.
73 struct switch_offsets
{
74 unsigned long begin
, end
, old
;
75 size_t pre_header_padding
, size
;
76 unsigned int switch_new_start
:1, switch_new_end
:1, switch_old_start
:1,
87 static ATOMIC_NOTIFIER_HEAD(tick_nohz_notifier
);
88 #endif /* CONFIG_NO_HZ */
90 static DEFINE_PER_CPU(spinlock_t
, ring_buffer_nohz_lock
);
92 DEFINE_PER_CPU(unsigned int, lib_ring_buffer_nesting
);
93 EXPORT_PER_CPU_SYMBOL(lib_ring_buffer_nesting
);
96 void lib_ring_buffer_print_errors(struct channel
*chan
,
97 struct lib_ring_buffer
*buf
, int cpu
);
99 void _lib_ring_buffer_switch_remote(struct lib_ring_buffer
*buf
,
100 enum switch_mode mode
);
103 int lib_ring_buffer_poll_deliver(const struct lib_ring_buffer_config
*config
,
104 struct lib_ring_buffer
*buf
,
105 struct channel
*chan
)
107 unsigned long consumed_old
, consumed_idx
, commit_count
, write_offset
;
109 consumed_old
= atomic_long_read(&buf
->consumed
);
110 consumed_idx
= subbuf_index(consumed_old
, chan
);
111 commit_count
= v_read(config
, &buf
->commit_cold
[consumed_idx
].cc_sb
);
113 * No memory barrier here, since we are only interested
114 * in a statistically correct polling result. The next poll will
115 * get the data is we are racing. The mb() that ensures correct
116 * memory order is in get_subbuf.
118 write_offset
= v_read(config
, &buf
->offset
);
121 * Check that the subbuffer we are trying to consume has been
122 * already fully committed.
125 if (((commit_count
- chan
->backend
.subbuf_size
)
126 & chan
->commit_count_mask
)
127 - (buf_trunc(consumed_old
, chan
)
128 >> chan
->backend
.num_subbuf_order
)
133 * Check that we are not about to read the same subbuffer in
134 * which the writer head is.
136 if (subbuf_trunc(write_offset
, chan
) - subbuf_trunc(consumed_old
, chan
)
144 * Must be called under cpu hotplug protection.
146 void lib_ring_buffer_free(struct lib_ring_buffer
*buf
)
148 struct channel
*chan
= buf
->backend
.chan
;
150 lib_ring_buffer_print_errors(chan
, buf
, buf
->backend
.cpu
);
151 lttng_kvfree(buf
->commit_hot
);
152 lttng_kvfree(buf
->commit_cold
);
153 lttng_kvfree(buf
->ts_end
);
155 lib_ring_buffer_backend_free(&buf
->backend
);
159 * lib_ring_buffer_reset - Reset ring buffer to initial values.
162 * Effectively empty the ring buffer. Should be called when the buffer is not
163 * used for writing. The ring buffer can be opened for reading, but the reader
164 * should not be using the iterator concurrently with reset. The previous
165 * current iterator record is reset.
167 void lib_ring_buffer_reset(struct lib_ring_buffer
*buf
)
169 struct channel
*chan
= buf
->backend
.chan
;
170 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
174 * Reset iterator first. It will put the subbuffer if it currently holds
177 lib_ring_buffer_iterator_reset(buf
);
178 v_set(config
, &buf
->offset
, 0);
179 for (i
= 0; i
< chan
->backend
.num_subbuf
; i
++) {
180 v_set(config
, &buf
->commit_hot
[i
].cc
, 0);
181 v_set(config
, &buf
->commit_hot
[i
].seq
, 0);
182 v_set(config
, &buf
->commit_cold
[i
].cc_sb
, 0);
185 atomic_long_set(&buf
->consumed
, 0);
186 atomic_set(&buf
->record_disabled
, 0);
187 v_set(config
, &buf
->last_tsc
, 0);
188 lib_ring_buffer_backend_reset(&buf
->backend
);
189 /* Don't reset number of active readers */
190 v_set(config
, &buf
->records_lost_full
, 0);
191 v_set(config
, &buf
->records_lost_wrap
, 0);
192 v_set(config
, &buf
->records_lost_big
, 0);
193 v_set(config
, &buf
->records_count
, 0);
194 v_set(config
, &buf
->records_overrun
, 0);
197 EXPORT_SYMBOL_GPL(lib_ring_buffer_reset
);
200 * channel_reset - Reset channel to initial values.
203 * Effectively empty the channel. Should be called when the channel is not used
204 * for writing. The channel can be opened for reading, but the reader should not
205 * be using the iterator concurrently with reset. The previous current iterator
208 void channel_reset(struct channel
*chan
)
211 * Reset iterators first. Will put the subbuffer if held for reading.
213 channel_iterator_reset(chan
);
214 atomic_set(&chan
->record_disabled
, 0);
215 /* Don't reset commit_count_mask, still valid */
216 channel_backend_reset(&chan
->backend
);
217 /* Don't reset switch/read timer interval */
218 /* Don't reset notifiers and notifier enable bits */
219 /* Don't reset reader reference count */
221 EXPORT_SYMBOL_GPL(channel_reset
);
224 * Must be called under cpu hotplug protection.
226 int lib_ring_buffer_create(struct lib_ring_buffer
*buf
,
227 struct channel_backend
*chanb
, int cpu
)
229 const struct lib_ring_buffer_config
*config
= &chanb
->config
;
230 struct channel
*chan
= container_of(chanb
, struct channel
, backend
);
231 void *priv
= chanb
->priv
;
232 size_t subbuf_header_size
;
236 /* Test for cpu hotplug */
237 if (buf
->backend
.allocated
)
241 * Paranoia: per cpu dynamic allocation is not officially documented as
242 * zeroing the memory, so let's do it here too, just in case.
244 memset(buf
, 0, sizeof(*buf
));
246 ret
= lib_ring_buffer_backend_create(&buf
->backend
, &chan
->backend
, cpu
);
251 lttng_kvzalloc_node(ALIGN(sizeof(*buf
->commit_hot
)
252 * chan
->backend
.num_subbuf
,
253 1 << INTERNODE_CACHE_SHIFT
),
254 GFP_KERNEL
| __GFP_NOWARN
,
255 cpu_to_node(max(cpu
, 0)));
256 if (!buf
->commit_hot
) {
262 lttng_kvzalloc_node(ALIGN(sizeof(*buf
->commit_cold
)
263 * chan
->backend
.num_subbuf
,
264 1 << INTERNODE_CACHE_SHIFT
),
265 GFP_KERNEL
| __GFP_NOWARN
,
266 cpu_to_node(max(cpu
, 0)));
267 if (!buf
->commit_cold
) {
273 lttng_kvzalloc_node(ALIGN(sizeof(*buf
->ts_end
)
274 * chan
->backend
.num_subbuf
,
275 1 << INTERNODE_CACHE_SHIFT
),
276 GFP_KERNEL
| __GFP_NOWARN
,
277 cpu_to_node(max(cpu
, 0)));
280 goto free_commit_cold
;
283 init_waitqueue_head(&buf
->read_wait
);
284 init_waitqueue_head(&buf
->write_wait
);
285 raw_spin_lock_init(&buf
->raw_tick_nohz_spinlock
);
288 * Write the subbuffer header for first subbuffer so we know the total
289 * duration of data gathering.
291 subbuf_header_size
= config
->cb
.subbuffer_header_size();
292 v_set(config
, &buf
->offset
, subbuf_header_size
);
293 subbuffer_id_clear_noref(config
, &buf
->backend
.buf_wsb
[0].id
);
294 tsc
= config
->cb
.ring_buffer_clock_read(buf
->backend
.chan
);
295 config
->cb
.buffer_begin(buf
, tsc
, 0);
296 v_add(config
, subbuf_header_size
, &buf
->commit_hot
[0].cc
);
298 if (config
->cb
.buffer_create
) {
299 ret
= config
->cb
.buffer_create(buf
, priv
, cpu
, chanb
->name
);
305 * Ensure the buffer is ready before setting it to allocated and setting
307 * Used for cpu hotplug vs cpumask iteration.
310 buf
->backend
.allocated
= 1;
312 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
313 CHAN_WARN_ON(chan
, cpumask_test_cpu(cpu
,
314 chan
->backend
.cpumask
));
315 cpumask_set_cpu(cpu
, chan
->backend
.cpumask
);
322 lttng_kvfree(buf
->ts_end
);
324 lttng_kvfree(buf
->commit_cold
);
326 lttng_kvfree(buf
->commit_hot
);
328 lib_ring_buffer_backend_free(&buf
->backend
);
332 static void switch_buffer_timer(LTTNG_TIMER_FUNC_ARG_TYPE t
)
334 struct lib_ring_buffer
*buf
= lttng_from_timer(buf
, t
, switch_timer
);
335 struct channel
*chan
= buf
->backend
.chan
;
336 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
339 * Only flush buffers periodically if readers are active.
341 if (atomic_long_read(&buf
->active_readers
))
342 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
);
344 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
345 lttng_mod_timer_pinned(&buf
->switch_timer
,
346 jiffies
+ chan
->switch_timer_interval
);
348 mod_timer(&buf
->switch_timer
,
349 jiffies
+ chan
->switch_timer_interval
);
353 * Called with ring_buffer_nohz_lock held for per-cpu buffers.
355 static void lib_ring_buffer_start_switch_timer(struct lib_ring_buffer
*buf
)
357 struct channel
*chan
= buf
->backend
.chan
;
358 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
359 unsigned int flags
= 0;
361 if (!chan
->switch_timer_interval
|| buf
->switch_timer_enabled
)
364 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
365 flags
= LTTNG_TIMER_PINNED
;
367 lttng_timer_setup(&buf
->switch_timer
, switch_buffer_timer
, flags
, buf
);
368 buf
->switch_timer
.expires
= jiffies
+ chan
->switch_timer_interval
;
370 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
371 add_timer_on(&buf
->switch_timer
, buf
->backend
.cpu
);
373 add_timer(&buf
->switch_timer
);
375 buf
->switch_timer_enabled
= 1;
379 * Called with ring_buffer_nohz_lock held for per-cpu buffers.
381 static void lib_ring_buffer_stop_switch_timer(struct lib_ring_buffer
*buf
)
383 struct channel
*chan
= buf
->backend
.chan
;
385 if (!chan
->switch_timer_interval
|| !buf
->switch_timer_enabled
)
388 del_timer_sync(&buf
->switch_timer
);
389 buf
->switch_timer_enabled
= 0;
393 * Polling timer to check the channels for data.
395 static void read_buffer_timer(LTTNG_TIMER_FUNC_ARG_TYPE t
)
397 struct lib_ring_buffer
*buf
= lttng_from_timer(buf
, t
, read_timer
);
398 struct channel
*chan
= buf
->backend
.chan
;
399 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
401 CHAN_WARN_ON(chan
, !buf
->backend
.allocated
);
403 if (atomic_long_read(&buf
->active_readers
)
404 && lib_ring_buffer_poll_deliver(config
, buf
, chan
)) {
405 wake_up_interruptible(&buf
->read_wait
);
406 wake_up_interruptible(&chan
->read_wait
);
409 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
410 lttng_mod_timer_pinned(&buf
->read_timer
,
411 jiffies
+ chan
->read_timer_interval
);
413 mod_timer(&buf
->read_timer
,
414 jiffies
+ chan
->read_timer_interval
);
418 * Called with ring_buffer_nohz_lock held for per-cpu buffers.
420 static void lib_ring_buffer_start_read_timer(struct lib_ring_buffer
*buf
)
422 struct channel
*chan
= buf
->backend
.chan
;
423 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
424 unsigned int flags
= 0;
426 if (config
->wakeup
!= RING_BUFFER_WAKEUP_BY_TIMER
427 || !chan
->read_timer_interval
428 || buf
->read_timer_enabled
)
431 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
432 flags
= LTTNG_TIMER_PINNED
;
434 lttng_timer_setup(&buf
->read_timer
, read_buffer_timer
, flags
, buf
);
435 buf
->read_timer
.expires
= jiffies
+ chan
->read_timer_interval
;
437 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
438 add_timer_on(&buf
->read_timer
, buf
->backend
.cpu
);
440 add_timer(&buf
->read_timer
);
442 buf
->read_timer_enabled
= 1;
446 * Called with ring_buffer_nohz_lock held for per-cpu buffers.
448 static void lib_ring_buffer_stop_read_timer(struct lib_ring_buffer
*buf
)
450 struct channel
*chan
= buf
->backend
.chan
;
451 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
453 if (config
->wakeup
!= RING_BUFFER_WAKEUP_BY_TIMER
454 || !chan
->read_timer_interval
455 || !buf
->read_timer_enabled
)
458 del_timer_sync(&buf
->read_timer
);
460 * do one more check to catch data that has been written in the last
463 if (lib_ring_buffer_poll_deliver(config
, buf
, chan
)) {
464 wake_up_interruptible(&buf
->read_wait
);
465 wake_up_interruptible(&chan
->read_wait
);
467 buf
->read_timer_enabled
= 0;
470 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
472 enum cpuhp_state lttng_rb_hp_prepare
;
473 enum cpuhp_state lttng_rb_hp_online
;
475 void lttng_rb_set_hp_prepare(enum cpuhp_state val
)
477 lttng_rb_hp_prepare
= val
;
479 EXPORT_SYMBOL_GPL(lttng_rb_set_hp_prepare
);
481 void lttng_rb_set_hp_online(enum cpuhp_state val
)
483 lttng_rb_hp_online
= val
;
485 EXPORT_SYMBOL_GPL(lttng_rb_set_hp_online
);
487 int lttng_cpuhp_rb_frontend_dead(unsigned int cpu
,
488 struct lttng_cpuhp_node
*node
)
490 struct channel
*chan
= container_of(node
, struct channel
,
492 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
, cpu
);
493 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
495 CHAN_WARN_ON(chan
, config
->alloc
== RING_BUFFER_ALLOC_GLOBAL
);
498 * Performing a buffer switch on a remote CPU. Performed by
499 * the CPU responsible for doing the hotunplug after the target
500 * CPU stopped running completely. Ensures that all data
501 * from that remote CPU is flushed.
503 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
);
506 EXPORT_SYMBOL_GPL(lttng_cpuhp_rb_frontend_dead
);
508 int lttng_cpuhp_rb_frontend_online(unsigned int cpu
,
509 struct lttng_cpuhp_node
*node
)
511 struct channel
*chan
= container_of(node
, struct channel
,
513 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
, cpu
);
514 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
516 CHAN_WARN_ON(chan
, config
->alloc
== RING_BUFFER_ALLOC_GLOBAL
);
518 wake_up_interruptible(&chan
->hp_wait
);
519 lib_ring_buffer_start_switch_timer(buf
);
520 lib_ring_buffer_start_read_timer(buf
);
523 EXPORT_SYMBOL_GPL(lttng_cpuhp_rb_frontend_online
);
525 int lttng_cpuhp_rb_frontend_offline(unsigned int cpu
,
526 struct lttng_cpuhp_node
*node
)
528 struct channel
*chan
= container_of(node
, struct channel
,
530 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
, cpu
);
531 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
533 CHAN_WARN_ON(chan
, config
->alloc
== RING_BUFFER_ALLOC_GLOBAL
);
535 lib_ring_buffer_stop_switch_timer(buf
);
536 lib_ring_buffer_stop_read_timer(buf
);
539 EXPORT_SYMBOL_GPL(lttng_cpuhp_rb_frontend_offline
);
541 #else /* #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
543 #ifdef CONFIG_HOTPLUG_CPU
546 * lib_ring_buffer_cpu_hp_callback - CPU hotplug callback
547 * @nb: notifier block
548 * @action: hotplug action to take
551 * Returns the success/failure of the operation. (%NOTIFY_OK, %NOTIFY_BAD)
554 int lib_ring_buffer_cpu_hp_callback(struct notifier_block
*nb
,
555 unsigned long action
,
558 unsigned int cpu
= (unsigned long)hcpu
;
559 struct channel
*chan
= container_of(nb
, struct channel
,
561 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
, cpu
);
562 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
564 if (!chan
->cpu_hp_enable
)
567 CHAN_WARN_ON(chan
, config
->alloc
== RING_BUFFER_ALLOC_GLOBAL
);
570 case CPU_DOWN_FAILED
:
571 case CPU_DOWN_FAILED_FROZEN
:
573 case CPU_ONLINE_FROZEN
:
574 wake_up_interruptible(&chan
->hp_wait
);
575 lib_ring_buffer_start_switch_timer(buf
);
576 lib_ring_buffer_start_read_timer(buf
);
579 case CPU_DOWN_PREPARE
:
580 case CPU_DOWN_PREPARE_FROZEN
:
581 lib_ring_buffer_stop_switch_timer(buf
);
582 lib_ring_buffer_stop_read_timer(buf
);
586 case CPU_DEAD_FROZEN
:
588 * Performing a buffer switch on a remote CPU. Performed by
589 * the CPU responsible for doing the hotunplug after the target
590 * CPU stopped running completely. Ensures that all data
591 * from that remote CPU is flushed.
593 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
);
603 #endif /* #else #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
605 #if defined(CONFIG_NO_HZ) && defined(CONFIG_LIB_RING_BUFFER)
607 * For per-cpu buffers, call the reader wakeups before switching the buffer, so
608 * that wake-up-tracing generated events are flushed before going idle (in
609 * tick_nohz). We test if the spinlock is locked to deal with the race where
610 * readers try to sample the ring buffer before we perform the switch. We let
611 * the readers retry in that case. If there is data in the buffer, the wake up
612 * is going to forbid the CPU running the reader thread from going idle.
614 static int notrace
ring_buffer_tick_nohz_callback(struct notifier_block
*nb
,
618 struct channel
*chan
= container_of(nb
, struct channel
,
620 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
621 struct lib_ring_buffer
*buf
;
622 int cpu
= smp_processor_id();
624 if (config
->alloc
!= RING_BUFFER_ALLOC_PER_CPU
) {
626 * We don't support keeping the system idle with global buffers
627 * and streaming active. In order to do so, we would need to
628 * sample a non-nohz-cpumask racelessly with the nohz updates
629 * without adding synchronization overhead to nohz. Leave this
630 * use-case out for now.
635 buf
= channel_get_ring_buffer(config
, chan
, cpu
);
637 case TICK_NOHZ_FLUSH
:
638 raw_spin_lock(&buf
->raw_tick_nohz_spinlock
);
639 if (config
->wakeup
== RING_BUFFER_WAKEUP_BY_TIMER
640 && chan
->read_timer_interval
641 && atomic_long_read(&buf
->active_readers
)
642 && (lib_ring_buffer_poll_deliver(config
, buf
, chan
)
643 || lib_ring_buffer_pending_data(config
, buf
, chan
))) {
644 wake_up_interruptible(&buf
->read_wait
);
645 wake_up_interruptible(&chan
->read_wait
);
647 if (chan
->switch_timer_interval
)
648 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
);
649 raw_spin_unlock(&buf
->raw_tick_nohz_spinlock
);
652 spin_lock(lttng_this_cpu_ptr(&ring_buffer_nohz_lock
));
653 lib_ring_buffer_stop_switch_timer(buf
);
654 lib_ring_buffer_stop_read_timer(buf
);
655 spin_unlock(lttng_this_cpu_ptr(&ring_buffer_nohz_lock
));
657 case TICK_NOHZ_RESTART
:
658 spin_lock(lttng_this_cpu_ptr(&ring_buffer_nohz_lock
));
659 lib_ring_buffer_start_read_timer(buf
);
660 lib_ring_buffer_start_switch_timer(buf
);
661 spin_unlock(lttng_this_cpu_ptr(&ring_buffer_nohz_lock
));
668 void notrace
lib_ring_buffer_tick_nohz_flush(void)
670 atomic_notifier_call_chain(&tick_nohz_notifier
, TICK_NOHZ_FLUSH
,
674 void notrace
lib_ring_buffer_tick_nohz_stop(void)
676 atomic_notifier_call_chain(&tick_nohz_notifier
, TICK_NOHZ_STOP
,
680 void notrace
lib_ring_buffer_tick_nohz_restart(void)
682 atomic_notifier_call_chain(&tick_nohz_notifier
, TICK_NOHZ_RESTART
,
685 #endif /* defined(CONFIG_NO_HZ) && defined(CONFIG_LIB_RING_BUFFER) */
690 static void channel_unregister_notifiers(struct channel
*chan
)
692 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
694 channel_iterator_unregister_notifiers(chan
);
695 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
698 * Remove the nohz notifier first, so we are certain we stop
701 atomic_notifier_chain_unregister(&tick_nohz_notifier
,
702 &chan
->tick_nohz_notifier
);
704 * ring_buffer_nohz_lock will not be needed below, because
705 * we just removed the notifiers, which were the only source of
708 #endif /* CONFIG_NO_HZ */
709 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
713 ret
= cpuhp_state_remove_instance(lttng_rb_hp_online
,
714 &chan
->cpuhp_online
.node
);
716 ret
= cpuhp_state_remove_instance_nocalls(lttng_rb_hp_prepare
,
717 &chan
->cpuhp_prepare
.node
);
720 #else /* #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
724 #ifdef CONFIG_HOTPLUG_CPU
726 chan
->cpu_hp_enable
= 0;
727 for_each_online_cpu(cpu
) {
728 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
730 lib_ring_buffer_stop_switch_timer(buf
);
731 lib_ring_buffer_stop_read_timer(buf
);
734 unregister_cpu_notifier(&chan
->cpu_hp_notifier
);
736 for_each_possible_cpu(cpu
) {
737 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
739 lib_ring_buffer_stop_switch_timer(buf
);
740 lib_ring_buffer_stop_read_timer(buf
);
744 #endif /* #else #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
746 struct lib_ring_buffer
*buf
= chan
->backend
.buf
;
748 lib_ring_buffer_stop_switch_timer(buf
);
749 lib_ring_buffer_stop_read_timer(buf
);
751 channel_backend_unregister_notifiers(&chan
->backend
);
754 static void lib_ring_buffer_set_quiescent(struct lib_ring_buffer
*buf
)
756 if (!buf
->quiescent
) {
757 buf
->quiescent
= true;
758 _lib_ring_buffer_switch_remote(buf
, SWITCH_FLUSH
);
762 static void lib_ring_buffer_clear_quiescent(struct lib_ring_buffer
*buf
)
764 buf
->quiescent
= false;
767 void lib_ring_buffer_set_quiescent_channel(struct channel
*chan
)
770 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
772 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
774 for_each_channel_cpu(cpu
, chan
) {
775 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
778 lib_ring_buffer_set_quiescent(buf
);
782 struct lib_ring_buffer
*buf
= chan
->backend
.buf
;
784 lib_ring_buffer_set_quiescent(buf
);
787 EXPORT_SYMBOL_GPL(lib_ring_buffer_set_quiescent_channel
);
789 void lib_ring_buffer_clear_quiescent_channel(struct channel
*chan
)
792 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
794 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
796 for_each_channel_cpu(cpu
, chan
) {
797 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
800 lib_ring_buffer_clear_quiescent(buf
);
804 struct lib_ring_buffer
*buf
= chan
->backend
.buf
;
806 lib_ring_buffer_clear_quiescent(buf
);
809 EXPORT_SYMBOL_GPL(lib_ring_buffer_clear_quiescent_channel
);
811 static void channel_free(struct channel
*chan
)
813 if (chan
->backend
.release_priv_ops
) {
814 chan
->backend
.release_priv_ops(chan
->backend
.priv_ops
);
816 channel_iterator_free(chan
);
817 channel_backend_free(&chan
->backend
);
822 * channel_create - Create channel.
823 * @config: ring buffer instance configuration
824 * @name: name of the channel
825 * @priv: ring buffer client private data
826 * @buf_addr: pointer the the beginning of the preallocated buffer contiguous
827 * address mapping. It is used only by RING_BUFFER_STATIC
828 * configuration. It can be set to NULL for other backends.
829 * @subbuf_size: subbuffer size
830 * @num_subbuf: number of subbuffers
831 * @switch_timer_interval: Time interval (in us) to fill sub-buffers with
832 * padding to let readers get those sub-buffers.
833 * Used for live streaming.
834 * @read_timer_interval: Time interval (in us) to wake up pending readers.
837 * Returns NULL on failure.
839 struct channel
*channel_create(const struct lib_ring_buffer_config
*config
,
840 const char *name
, void *priv
, void *buf_addr
,
842 size_t num_subbuf
, unsigned int switch_timer_interval
,
843 unsigned int read_timer_interval
)
846 struct channel
*chan
;
848 if (lib_ring_buffer_check_config(config
, switch_timer_interval
,
849 read_timer_interval
))
852 chan
= kzalloc(sizeof(struct channel
), GFP_KERNEL
);
856 ret
= channel_backend_init(&chan
->backend
, name
, config
, priv
,
857 subbuf_size
, num_subbuf
);
861 ret
= channel_iterator_init(chan
);
863 goto error_free_backend
;
865 chan
->commit_count_mask
= (~0UL >> chan
->backend
.num_subbuf_order
);
866 chan
->switch_timer_interval
= usecs_to_jiffies(switch_timer_interval
);
867 chan
->read_timer_interval
= usecs_to_jiffies(read_timer_interval
);
868 kref_init(&chan
->ref
);
869 init_waitqueue_head(&chan
->read_wait
);
870 init_waitqueue_head(&chan
->hp_wait
);
872 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
873 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
874 chan
->cpuhp_prepare
.component
= LTTNG_RING_BUFFER_FRONTEND
;
875 ret
= cpuhp_state_add_instance_nocalls(lttng_rb_hp_prepare
,
876 &chan
->cpuhp_prepare
.node
);
878 goto cpuhp_prepare_error
;
880 chan
->cpuhp_online
.component
= LTTNG_RING_BUFFER_FRONTEND
;
881 ret
= cpuhp_state_add_instance(lttng_rb_hp_online
,
882 &chan
->cpuhp_online
.node
);
884 goto cpuhp_online_error
;
885 #else /* #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
889 * In case of non-hotplug cpu, if the ring-buffer is allocated
890 * in early initcall, it will not be notified of secondary cpus.
891 * In that off case, we need to allocate for all possible cpus.
893 #ifdef CONFIG_HOTPLUG_CPU
894 chan
->cpu_hp_notifier
.notifier_call
=
895 lib_ring_buffer_cpu_hp_callback
;
896 chan
->cpu_hp_notifier
.priority
= 6;
897 register_cpu_notifier(&chan
->cpu_hp_notifier
);
900 for_each_online_cpu(cpu
) {
901 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
903 spin_lock(&per_cpu(ring_buffer_nohz_lock
, cpu
));
904 lib_ring_buffer_start_switch_timer(buf
);
905 lib_ring_buffer_start_read_timer(buf
);
906 spin_unlock(&per_cpu(ring_buffer_nohz_lock
, cpu
));
908 chan
->cpu_hp_enable
= 1;
911 for_each_possible_cpu(cpu
) {
912 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
914 spin_lock(&per_cpu(ring_buffer_nohz_lock
, cpu
));
915 lib_ring_buffer_start_switch_timer(buf
);
916 lib_ring_buffer_start_read_timer(buf
);
917 spin_unlock(&per_cpu(ring_buffer_nohz_lock
, cpu
));
921 #endif /* #else #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
923 #if defined(CONFIG_NO_HZ) && defined(CONFIG_LIB_RING_BUFFER)
924 /* Only benefit from NO_HZ idle with per-cpu buffers for now. */
925 chan
->tick_nohz_notifier
.notifier_call
=
926 ring_buffer_tick_nohz_callback
;
927 chan
->tick_nohz_notifier
.priority
= ~0U;
928 atomic_notifier_chain_register(&tick_nohz_notifier
,
929 &chan
->tick_nohz_notifier
);
930 #endif /* defined(CONFIG_NO_HZ) && defined(CONFIG_LIB_RING_BUFFER) */
933 struct lib_ring_buffer
*buf
= chan
->backend
.buf
;
935 lib_ring_buffer_start_switch_timer(buf
);
936 lib_ring_buffer_start_read_timer(buf
);
941 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0))
943 ret
= cpuhp_state_remove_instance_nocalls(lttng_rb_hp_prepare
,
944 &chan
->cpuhp_prepare
.node
);
947 #endif /* #if (LINUX_VERSION_CODE >= KERNEL_VERSION(4,10,0)) */
949 channel_backend_free(&chan
->backend
);
954 EXPORT_SYMBOL_GPL(channel_create
);
957 void channel_release(struct kref
*kref
)
959 struct channel
*chan
= container_of(kref
, struct channel
, ref
);
964 * channel_destroy - Finalize, wait for q.s. and destroy channel.
965 * @chan: channel to destroy
968 * Call "destroy" callback, finalize channels, and then decrement the
969 * channel reference count. Note that when readers have completed data
970 * consumption of finalized channels, get_subbuf() will return -ENODATA.
971 * They should release their handle at that point. Returns the private
974 void *channel_destroy(struct channel
*chan
)
977 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
980 channel_unregister_notifiers(chan
);
982 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
984 * No need to hold cpu hotplug, because all notifiers have been
987 for_each_channel_cpu(cpu
, chan
) {
988 struct lib_ring_buffer
*buf
= per_cpu_ptr(chan
->backend
.buf
,
991 if (config
->cb
.buffer_finalize
)
992 config
->cb
.buffer_finalize(buf
,
996 * Perform flush before writing to finalized.
999 WRITE_ONCE(buf
->finalized
, 1);
1000 wake_up_interruptible(&buf
->read_wait
);
1003 struct lib_ring_buffer
*buf
= chan
->backend
.buf
;
1005 if (config
->cb
.buffer_finalize
)
1006 config
->cb
.buffer_finalize(buf
, chan
->backend
.priv
, -1);
1008 * Perform flush before writing to finalized.
1011 WRITE_ONCE(buf
->finalized
, 1);
1012 wake_up_interruptible(&buf
->read_wait
);
1014 WRITE_ONCE(chan
->finalized
, 1);
1015 wake_up_interruptible(&chan
->hp_wait
);
1016 wake_up_interruptible(&chan
->read_wait
);
1017 priv
= chan
->backend
.priv
;
1018 kref_put(&chan
->ref
, channel_release
);
1021 EXPORT_SYMBOL_GPL(channel_destroy
);
1023 struct lib_ring_buffer
*channel_get_ring_buffer(
1024 const struct lib_ring_buffer_config
*config
,
1025 struct channel
*chan
, int cpu
)
1027 if (config
->alloc
== RING_BUFFER_ALLOC_GLOBAL
)
1028 return chan
->backend
.buf
;
1030 return per_cpu_ptr(chan
->backend
.buf
, cpu
);
1032 EXPORT_SYMBOL_GPL(channel_get_ring_buffer
);
1034 int lib_ring_buffer_open_read(struct lib_ring_buffer
*buf
)
1036 struct channel
*chan
= buf
->backend
.chan
;
1038 if (!atomic_long_add_unless(&buf
->active_readers
, 1, 1))
1040 if (!lttng_kref_get(&chan
->ref
)) {
1041 atomic_long_dec(&buf
->active_readers
);
1044 lttng_smp_mb__after_atomic();
1047 EXPORT_SYMBOL_GPL(lib_ring_buffer_open_read
);
1049 void lib_ring_buffer_release_read(struct lib_ring_buffer
*buf
)
1051 struct channel
*chan
= buf
->backend
.chan
;
1053 CHAN_WARN_ON(chan
, atomic_long_read(&buf
->active_readers
) != 1);
1054 lttng_smp_mb__before_atomic();
1055 atomic_long_dec(&buf
->active_readers
);
1056 kref_put(&chan
->ref
, channel_release
);
1058 EXPORT_SYMBOL_GPL(lib_ring_buffer_release_read
);
1061 * Promote compiler barrier to a smp_mb().
1062 * For the specific ring buffer case, this IPI call should be removed if the
1063 * architecture does not reorder writes. This should eventually be provided by
1064 * a separate architecture-specific infrastructure.
1066 static void remote_mb(void *info
)
1072 * lib_ring_buffer_snapshot - save subbuffer position snapshot (for read)
1074 * @consumed: consumed count indicating the position where to read
1075 * @produced: produced count, indicates position when to stop reading
1077 * Returns -ENODATA if buffer is finalized, -EAGAIN if there is currently no
1078 * data to read at consumed position, or 0 if the get operation succeeds.
1079 * Busy-loop trying to get data if the tick_nohz sequence lock is held.
1082 int lib_ring_buffer_snapshot(struct lib_ring_buffer
*buf
,
1083 unsigned long *consumed
, unsigned long *produced
)
1085 struct channel
*chan
= buf
->backend
.chan
;
1086 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1087 unsigned long consumed_cur
, write_offset
;
1091 finalized
= READ_ONCE(buf
->finalized
);
1093 * Read finalized before counters.
1096 consumed_cur
= atomic_long_read(&buf
->consumed
);
1098 * No need to issue a memory barrier between consumed count read and
1099 * write offset read, because consumed count can only change
1100 * concurrently in overwrite mode, and we keep a sequence counter
1101 * identifier derived from the write offset to check we are getting
1102 * the same sub-buffer we are expecting (the sub-buffers are atomically
1103 * "tagged" upon writes, tags are checked upon read).
1105 write_offset
= v_read(config
, &buf
->offset
);
1108 * Check that we are not about to read the same subbuffer in
1109 * which the writer head is.
1111 if (subbuf_trunc(write_offset
, chan
) - subbuf_trunc(consumed_cur
, chan
)
1115 *consumed
= consumed_cur
;
1116 *produced
= subbuf_trunc(write_offset
, chan
);
1122 * The memory barriers __wait_event()/wake_up_interruptible() take care
1123 * of "raw_spin_is_locked" memory ordering.
1127 else if (raw_spin_is_locked(&buf
->raw_tick_nohz_spinlock
))
1132 EXPORT_SYMBOL_GPL(lib_ring_buffer_snapshot
);
1135 * lib_ring_buffer_put_snapshot - move consumed counter forward
1137 * Should only be called from consumer context.
1139 * @consumed_new: new consumed count value
1141 void lib_ring_buffer_move_consumer(struct lib_ring_buffer
*buf
,
1142 unsigned long consumed_new
)
1144 struct lib_ring_buffer_backend
*bufb
= &buf
->backend
;
1145 struct channel
*chan
= bufb
->chan
;
1146 unsigned long consumed
;
1148 CHAN_WARN_ON(chan
, atomic_long_read(&buf
->active_readers
) != 1);
1151 * Only push the consumed value forward.
1152 * If the consumed cmpxchg fails, this is because we have been pushed by
1153 * the writer in flight recorder mode.
1155 consumed
= atomic_long_read(&buf
->consumed
);
1156 while ((long) consumed
- (long) consumed_new
< 0)
1157 consumed
= atomic_long_cmpxchg(&buf
->consumed
, consumed
,
1159 /* Wake-up the metadata producer */
1160 wake_up_interruptible(&buf
->write_wait
);
1162 EXPORT_SYMBOL_GPL(lib_ring_buffer_move_consumer
);
1164 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1165 static void lib_ring_buffer_flush_read_subbuf_dcache(
1166 const struct lib_ring_buffer_config
*config
,
1167 struct channel
*chan
,
1168 struct lib_ring_buffer
*buf
)
1170 struct lib_ring_buffer_backend_pages
*pages
;
1171 unsigned long sb_bindex
, id
, i
, nr_pages
;
1173 if (config
->output
!= RING_BUFFER_MMAP
)
1177 * Architectures with caches aliased on virtual addresses may
1178 * use different cache lines for the linear mapping vs
1179 * user-space memory mapping. Given that the ring buffer is
1180 * based on the kernel linear mapping, aligning it with the
1181 * user-space mapping is not straightforward, and would require
1182 * extra TLB entries. Therefore, simply flush the dcache for the
1183 * entire sub-buffer before reading it.
1185 id
= buf
->backend
.buf_rsb
.id
;
1186 sb_bindex
= subbuffer_id_get_index(config
, id
);
1187 pages
= buf
->backend
.array
[sb_bindex
];
1188 nr_pages
= buf
->backend
.num_pages_per_subbuf
;
1189 for (i
= 0; i
< nr_pages
; i
++) {
1190 struct lib_ring_buffer_backend_page
*backend_page
;
1192 backend_page
= &pages
->p
[i
];
1193 flush_dcache_page(pfn_to_page(backend_page
->pfn
));
1197 static void lib_ring_buffer_flush_read_subbuf_dcache(
1198 const struct lib_ring_buffer_config
*config
,
1199 struct channel
*chan
,
1200 struct lib_ring_buffer
*buf
)
1206 * lib_ring_buffer_get_subbuf - get exclusive access to subbuffer for reading
1208 * @consumed: consumed count indicating the position where to read
1210 * Returns -ENODATA if buffer is finalized, -EAGAIN if there is currently no
1211 * data to read at consumed position, or 0 if the get operation succeeds.
1212 * Busy-loop trying to get data if the tick_nohz sequence lock is held.
1214 int lib_ring_buffer_get_subbuf(struct lib_ring_buffer
*buf
,
1215 unsigned long consumed
)
1217 struct channel
*chan
= buf
->backend
.chan
;
1218 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1219 unsigned long consumed_cur
, consumed_idx
, commit_count
, write_offset
;
1223 if (buf
->get_subbuf
) {
1225 * Reader is trying to get a subbuffer twice.
1227 CHAN_WARN_ON(chan
, 1);
1231 finalized
= READ_ONCE(buf
->finalized
);
1233 * Read finalized before counters.
1236 consumed_cur
= atomic_long_read(&buf
->consumed
);
1237 consumed_idx
= subbuf_index(consumed
, chan
);
1238 commit_count
= v_read(config
, &buf
->commit_cold
[consumed_idx
].cc_sb
);
1240 * Make sure we read the commit count before reading the buffer
1241 * data and the write offset. Correct consumed offset ordering
1242 * wrt commit count is insured by the use of cmpxchg to update
1243 * the consumed offset.
1244 * smp_call_function_single can fail if the remote CPU is offline,
1245 * this is OK because then there is no wmb to execute there.
1246 * If our thread is executing on the same CPU as the on the buffers
1247 * belongs to, we don't have to synchronize it at all. If we are
1248 * migrated, the scheduler will take care of the memory barriers.
1249 * Normally, smp_call_function_single() should ensure program order when
1250 * executing the remote function, which implies that it surrounds the
1251 * function execution with :
1262 * However, smp_call_function_single() does not seem to clearly execute
1263 * such barriers. It depends on spinlock semantic to provide the barrier
1264 * before executing the IPI and, when busy-looping, csd_lock_wait only
1265 * executes smp_mb() when it has to wait for the other CPU.
1267 * I don't trust this code. Therefore, let's add the smp_mb() sequence
1268 * required ourself, even if duplicated. It has no performance impact
1271 * smp_mb() is needed because smp_rmb() and smp_wmb() only order read vs
1272 * read and write vs write. They do not ensure core synchronization. We
1273 * really have to ensure total order between the 3 barriers running on
1276 if (config
->ipi
== RING_BUFFER_IPI_BARRIER
) {
1277 if (config
->sync
== RING_BUFFER_SYNC_PER_CPU
1278 && config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
1279 if (raw_smp_processor_id() != buf
->backend
.cpu
) {
1280 /* Total order with IPI handler smp_mb() */
1282 smp_call_function_single(buf
->backend
.cpu
,
1283 remote_mb
, NULL
, 1);
1284 /* Total order with IPI handler smp_mb() */
1288 /* Total order with IPI handler smp_mb() */
1290 smp_call_function(remote_mb
, NULL
, 1);
1291 /* Total order with IPI handler smp_mb() */
1296 * Local rmb to match the remote wmb to read the commit count
1297 * before the buffer data and the write offset.
1302 write_offset
= v_read(config
, &buf
->offset
);
1305 * Check that the buffer we are getting is after or at consumed_cur
1308 if ((long) subbuf_trunc(consumed
, chan
)
1309 - (long) subbuf_trunc(consumed_cur
, chan
) < 0)
1313 * Check that the subbuffer we are trying to consume has been
1314 * already fully committed.
1316 if (((commit_count
- chan
->backend
.subbuf_size
)
1317 & chan
->commit_count_mask
)
1318 - (buf_trunc(consumed
, chan
)
1319 >> chan
->backend
.num_subbuf_order
)
1324 * Check that we are not about to read the same subbuffer in
1325 * which the writer head is.
1327 if (subbuf_trunc(write_offset
, chan
) - subbuf_trunc(consumed
, chan
)
1332 * Failure to get the subbuffer causes a busy-loop retry without going
1333 * to a wait queue. These are caused by short-lived race windows where
1334 * the writer is getting access to a subbuffer we were trying to get
1335 * access to. Also checks that the "consumed" buffer count we are
1336 * looking for matches the one contained in the subbuffer id.
1338 ret
= update_read_sb_index(config
, &buf
->backend
, &chan
->backend
,
1339 consumed_idx
, buf_trunc_val(consumed
, chan
));
1342 subbuffer_id_clear_noref(config
, &buf
->backend
.buf_rsb
.id
);
1344 buf
->get_subbuf_consumed
= consumed
;
1345 buf
->get_subbuf
= 1;
1347 lib_ring_buffer_flush_read_subbuf_dcache(config
, chan
, buf
);
1353 * The memory barriers __wait_event()/wake_up_interruptible() take care
1354 * of "raw_spin_is_locked" memory ordering.
1358 else if (raw_spin_is_locked(&buf
->raw_tick_nohz_spinlock
))
1363 EXPORT_SYMBOL_GPL(lib_ring_buffer_get_subbuf
);
1366 * lib_ring_buffer_put_subbuf - release exclusive subbuffer access
1369 void lib_ring_buffer_put_subbuf(struct lib_ring_buffer
*buf
)
1371 struct lib_ring_buffer_backend
*bufb
= &buf
->backend
;
1372 struct channel
*chan
= bufb
->chan
;
1373 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1374 unsigned long read_sb_bindex
, consumed_idx
, consumed
;
1376 CHAN_WARN_ON(chan
, atomic_long_read(&buf
->active_readers
) != 1);
1378 if (!buf
->get_subbuf
) {
1380 * Reader puts a subbuffer it did not get.
1382 CHAN_WARN_ON(chan
, 1);
1385 consumed
= buf
->get_subbuf_consumed
;
1386 buf
->get_subbuf
= 0;
1389 * Clear the records_unread counter. (overruns counter)
1390 * Can still be non-zero if a file reader simply grabbed the data
1391 * without using iterators.
1392 * Can be below zero if an iterator is used on a snapshot more than
1395 read_sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_rsb
.id
);
1396 v_add(config
, v_read(config
,
1397 &bufb
->array
[read_sb_bindex
]->records_unread
),
1398 &bufb
->records_read
);
1399 v_set(config
, &bufb
->array
[read_sb_bindex
]->records_unread
, 0);
1400 CHAN_WARN_ON(chan
, config
->mode
== RING_BUFFER_OVERWRITE
1401 && subbuffer_id_is_noref(config
, bufb
->buf_rsb
.id
));
1402 subbuffer_id_set_noref(config
, &bufb
->buf_rsb
.id
);
1405 * Exchange the reader subbuffer with the one we put in its place in the
1406 * writer subbuffer table. Expect the original consumed count. If
1407 * update_read_sb_index fails, this is because the writer updated the
1408 * subbuffer concurrently. We should therefore keep the subbuffer we
1409 * currently have: it has become invalid to try reading this sub-buffer
1410 * consumed count value anyway.
1412 consumed_idx
= subbuf_index(consumed
, chan
);
1413 update_read_sb_index(config
, &buf
->backend
, &chan
->backend
,
1414 consumed_idx
, buf_trunc_val(consumed
, chan
));
1416 * update_read_sb_index return value ignored. Don't exchange sub-buffer
1417 * if the writer concurrently updated it.
1420 EXPORT_SYMBOL_GPL(lib_ring_buffer_put_subbuf
);
1423 * cons_offset is an iterator on all subbuffer offsets between the reader
1424 * position and the writer position. (inclusive)
1427 void lib_ring_buffer_print_subbuffer_errors(struct lib_ring_buffer
*buf
,
1428 struct channel
*chan
,
1429 unsigned long cons_offset
,
1432 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1433 unsigned long cons_idx
, commit_count
, commit_count_sb
;
1435 cons_idx
= subbuf_index(cons_offset
, chan
);
1436 commit_count
= v_read(config
, &buf
->commit_hot
[cons_idx
].cc
);
1437 commit_count_sb
= v_read(config
, &buf
->commit_cold
[cons_idx
].cc_sb
);
1439 if (subbuf_offset(commit_count
, chan
) != 0)
1441 "ring buffer %s, cpu %d: "
1442 "commit count in subbuffer %lu,\n"
1443 "expecting multiples of %lu bytes\n"
1444 " [ %lu bytes committed, %lu bytes reader-visible ]\n",
1445 chan
->backend
.name
, cpu
, cons_idx
,
1446 chan
->backend
.subbuf_size
,
1447 commit_count
, commit_count_sb
);
1449 printk(KERN_DEBUG
"ring buffer: %s, cpu %d: %lu bytes committed\n",
1450 chan
->backend
.name
, cpu
, commit_count
);
1454 void lib_ring_buffer_print_buffer_errors(struct lib_ring_buffer
*buf
,
1455 struct channel
*chan
,
1456 void *priv
, int cpu
)
1458 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1459 unsigned long write_offset
, cons_offset
;
1462 * No need to order commit_count, write_offset and cons_offset reads
1463 * because we execute at teardown when no more writer nor reader
1464 * references are left.
1466 write_offset
= v_read(config
, &buf
->offset
);
1467 cons_offset
= atomic_long_read(&buf
->consumed
);
1468 if (write_offset
!= cons_offset
)
1470 "ring buffer %s, cpu %d: "
1471 "non-consumed data\n"
1472 " [ %lu bytes written, %lu bytes read ]\n",
1473 chan
->backend
.name
, cpu
, write_offset
, cons_offset
);
1475 for (cons_offset
= atomic_long_read(&buf
->consumed
);
1476 (long) (subbuf_trunc((unsigned long) v_read(config
, &buf
->offset
),
1479 cons_offset
= subbuf_align(cons_offset
, chan
))
1480 lib_ring_buffer_print_subbuffer_errors(buf
, chan
, cons_offset
,
1484 #ifdef LTTNG_RING_BUFFER_COUNT_EVENTS
1486 void lib_ring_buffer_print_records_count(struct channel
*chan
,
1487 struct lib_ring_buffer
*buf
,
1490 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1492 if (!strcmp(chan
->backend
.name
, "relay-metadata")) {
1493 printk(KERN_DEBUG
"ring buffer %s: %lu records written, "
1494 "%lu records overrun\n",
1496 v_read(config
, &buf
->records_count
),
1497 v_read(config
, &buf
->records_overrun
));
1499 printk(KERN_DEBUG
"ring buffer %s, cpu %d: %lu records written, "
1500 "%lu records overrun\n",
1501 chan
->backend
.name
, cpu
,
1502 v_read(config
, &buf
->records_count
),
1503 v_read(config
, &buf
->records_overrun
));
1508 void lib_ring_buffer_print_records_count(struct channel
*chan
,
1509 struct lib_ring_buffer
*buf
,
1516 void lib_ring_buffer_print_errors(struct channel
*chan
,
1517 struct lib_ring_buffer
*buf
, int cpu
)
1519 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1520 void *priv
= chan
->backend
.priv
;
1522 lib_ring_buffer_print_records_count(chan
, buf
, cpu
);
1523 if (strcmp(chan
->backend
.name
, "relay-metadata")) {
1524 if (v_read(config
, &buf
->records_lost_full
)
1525 || v_read(config
, &buf
->records_lost_wrap
)
1526 || v_read(config
, &buf
->records_lost_big
))
1528 "ring buffer %s, cpu %d: records were lost. Caused by:\n"
1529 " [ %lu buffer full, %lu nest buffer wrap-around, "
1530 "%lu event too big ]\n",
1531 chan
->backend
.name
, cpu
,
1532 v_read(config
, &buf
->records_lost_full
),
1533 v_read(config
, &buf
->records_lost_wrap
),
1534 v_read(config
, &buf
->records_lost_big
));
1536 lib_ring_buffer_print_buffer_errors(buf
, chan
, priv
, cpu
);
1540 * lib_ring_buffer_switch_old_start: Populate old subbuffer header.
1542 * Only executed when the buffer is finalized, in SWITCH_FLUSH.
1545 void lib_ring_buffer_switch_old_start(struct lib_ring_buffer
*buf
,
1546 struct channel
*chan
,
1547 struct switch_offsets
*offsets
,
1550 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1551 unsigned long oldidx
= subbuf_index(offsets
->old
, chan
);
1552 unsigned long commit_count
;
1553 struct commit_counters_hot
*cc_hot
;
1555 config
->cb
.buffer_begin(buf
, tsc
, oldidx
);
1558 * Order all writes to buffer before the commit count update that will
1559 * determine that the subbuffer is full.
1561 if (config
->ipi
== RING_BUFFER_IPI_BARRIER
) {
1563 * Must write slot data before incrementing commit count. This
1564 * compiler barrier is upgraded into a smp_mb() by the IPI sent
1570 cc_hot
= &buf
->commit_hot
[oldidx
];
1571 v_add(config
, config
->cb
.subbuffer_header_size(), &cc_hot
->cc
);
1572 commit_count
= v_read(config
, &cc_hot
->cc
);
1573 /* Check if the written buffer has to be delivered */
1574 lib_ring_buffer_check_deliver(config
, buf
, chan
, offsets
->old
,
1575 commit_count
, oldidx
, tsc
);
1576 lib_ring_buffer_write_commit_counter(config
, buf
, chan
,
1577 offsets
->old
+ config
->cb
.subbuffer_header_size(),
1578 commit_count
, cc_hot
);
1582 * lib_ring_buffer_switch_old_end: switch old subbuffer
1584 * Note : offset_old should never be 0 here. It is ok, because we never perform
1585 * buffer switch on an empty subbuffer in SWITCH_ACTIVE mode. The caller
1586 * increments the offset_old value when doing a SWITCH_FLUSH on an empty
1590 void lib_ring_buffer_switch_old_end(struct lib_ring_buffer
*buf
,
1591 struct channel
*chan
,
1592 struct switch_offsets
*offsets
,
1595 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1596 unsigned long oldidx
= subbuf_index(offsets
->old
- 1, chan
);
1597 unsigned long commit_count
, padding_size
, data_size
;
1598 struct commit_counters_hot
*cc_hot
;
1601 data_size
= subbuf_offset(offsets
->old
- 1, chan
) + 1;
1602 padding_size
= chan
->backend
.subbuf_size
- data_size
;
1603 subbuffer_set_data_size(config
, &buf
->backend
, oldidx
, data_size
);
1605 ts_end
= &buf
->ts_end
[oldidx
];
1607 * This is the last space reservation in that sub-buffer before
1608 * it gets delivered. This provides exclusive access to write to
1609 * this sub-buffer's ts_end. There are also no concurrent
1610 * readers of that ts_end because delivery of that sub-buffer is
1611 * postponed until the commit counter is incremented for the
1612 * current space reservation.
1617 * Order all writes to buffer and store to ts_end before the commit
1618 * count update that will determine that the subbuffer is full.
1620 if (config
->ipi
== RING_BUFFER_IPI_BARRIER
) {
1622 * Must write slot data before incrementing commit count. This
1623 * compiler barrier is upgraded into a smp_mb() by the IPI sent
1629 cc_hot
= &buf
->commit_hot
[oldidx
];
1630 v_add(config
, padding_size
, &cc_hot
->cc
);
1631 commit_count
= v_read(config
, &cc_hot
->cc
);
1632 lib_ring_buffer_check_deliver(config
, buf
, chan
, offsets
->old
- 1,
1633 commit_count
, oldidx
, tsc
);
1634 lib_ring_buffer_write_commit_counter(config
, buf
, chan
,
1635 offsets
->old
+ padding_size
, commit_count
,
1640 * lib_ring_buffer_switch_new_start: Populate new subbuffer.
1642 * This code can be executed unordered : writers may already have written to the
1643 * sub-buffer before this code gets executed, caution. The commit makes sure
1644 * that this code is executed before the deliver of this sub-buffer.
1647 void lib_ring_buffer_switch_new_start(struct lib_ring_buffer
*buf
,
1648 struct channel
*chan
,
1649 struct switch_offsets
*offsets
,
1652 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1653 unsigned long beginidx
= subbuf_index(offsets
->begin
, chan
);
1654 unsigned long commit_count
;
1655 struct commit_counters_hot
*cc_hot
;
1657 config
->cb
.buffer_begin(buf
, tsc
, beginidx
);
1660 * Order all writes to buffer before the commit count update that will
1661 * determine that the subbuffer is full.
1663 if (config
->ipi
== RING_BUFFER_IPI_BARRIER
) {
1665 * Must write slot data before incrementing commit count. This
1666 * compiler barrier is upgraded into a smp_mb() by the IPI sent
1672 cc_hot
= &buf
->commit_hot
[beginidx
];
1673 v_add(config
, config
->cb
.subbuffer_header_size(), &cc_hot
->cc
);
1674 commit_count
= v_read(config
, &cc_hot
->cc
);
1675 /* Check if the written buffer has to be delivered */
1676 lib_ring_buffer_check_deliver(config
, buf
, chan
, offsets
->begin
,
1677 commit_count
, beginidx
, tsc
);
1678 lib_ring_buffer_write_commit_counter(config
, buf
, chan
,
1679 offsets
->begin
+ config
->cb
.subbuffer_header_size(),
1680 commit_count
, cc_hot
);
1684 * lib_ring_buffer_switch_new_end: finish switching current subbuffer
1686 * Calls subbuffer_set_data_size() to set the data size of the current
1687 * sub-buffer. We do not need to perform check_deliver nor commit here,
1688 * since this task will be done by the "commit" of the event for which
1689 * we are currently doing the space reservation.
1692 void lib_ring_buffer_switch_new_end(struct lib_ring_buffer
*buf
,
1693 struct channel
*chan
,
1694 struct switch_offsets
*offsets
,
1697 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1698 unsigned long endidx
, data_size
;
1701 endidx
= subbuf_index(offsets
->end
- 1, chan
);
1702 data_size
= subbuf_offset(offsets
->end
- 1, chan
) + 1;
1703 subbuffer_set_data_size(config
, &buf
->backend
, endidx
, data_size
);
1704 ts_end
= &buf
->ts_end
[endidx
];
1706 * This is the last space reservation in that sub-buffer before
1707 * it gets delivered. This provides exclusive access to write to
1708 * this sub-buffer's ts_end. There are also no concurrent
1709 * readers of that ts_end because delivery of that sub-buffer is
1710 * postponed until the commit counter is incremented for the
1711 * current space reservation.
1719 * !0 if execution must be aborted.
1722 int lib_ring_buffer_try_switch_slow(enum switch_mode mode
,
1723 struct lib_ring_buffer
*buf
,
1724 struct channel
*chan
,
1725 struct switch_offsets
*offsets
,
1728 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1729 unsigned long off
, reserve_commit_diff
;
1731 offsets
->begin
= v_read(config
, &buf
->offset
);
1732 offsets
->old
= offsets
->begin
;
1733 offsets
->switch_old_start
= 0;
1734 off
= subbuf_offset(offsets
->begin
, chan
);
1736 *tsc
= config
->cb
.ring_buffer_clock_read(chan
);
1739 * Ensure we flush the header of an empty subbuffer when doing the
1740 * finalize (SWITCH_FLUSH). This ensures that we end up knowing the
1741 * total data gathering duration even if there were no records saved
1742 * after the last buffer switch.
1743 * In SWITCH_ACTIVE mode, switch the buffer when it contains events.
1744 * SWITCH_ACTIVE only flushes the current subbuffer, dealing with end of
1745 * subbuffer header as appropriate.
1746 * The next record that reserves space will be responsible for
1747 * populating the following subbuffer header. We choose not to populate
1748 * the next subbuffer header here because we want to be able to use
1749 * SWITCH_ACTIVE for periodical buffer flush and CPU tick_nohz stop
1750 * buffer flush, which must guarantee that all the buffer content
1751 * (records and header timestamps) are visible to the reader. This is
1752 * required for quiescence guarantees for the fusion merge.
1754 if (mode
!= SWITCH_FLUSH
&& !off
)
1755 return -1; /* we do not have to switch : buffer is empty */
1757 if (unlikely(off
== 0)) {
1758 unsigned long sb_index
, commit_count
;
1761 * We are performing a SWITCH_FLUSH. At this stage, there are no
1762 * concurrent writes into the buffer.
1764 * The client does not save any header information. Don't
1765 * switch empty subbuffer on finalize, because it is invalid to
1766 * deliver a completely empty subbuffer.
1768 if (!config
->cb
.subbuffer_header_size())
1771 /* Test new buffer integrity */
1772 sb_index
= subbuf_index(offsets
->begin
, chan
);
1773 commit_count
= v_read(config
,
1774 &buf
->commit_cold
[sb_index
].cc_sb
);
1775 reserve_commit_diff
=
1776 (buf_trunc(offsets
->begin
, chan
)
1777 >> chan
->backend
.num_subbuf_order
)
1778 - (commit_count
& chan
->commit_count_mask
);
1779 if (likely(reserve_commit_diff
== 0)) {
1780 /* Next subbuffer not being written to. */
1781 if (unlikely(config
->mode
!= RING_BUFFER_OVERWRITE
&&
1782 subbuf_trunc(offsets
->begin
, chan
)
1783 - subbuf_trunc((unsigned long)
1784 atomic_long_read(&buf
->consumed
), chan
)
1785 >= chan
->backend
.buf_size
)) {
1787 * We do not overwrite non consumed buffers
1788 * and we are full : don't switch.
1793 * Next subbuffer not being written to, and we
1794 * are either in overwrite mode or the buffer is
1795 * not full. It's safe to write in this new
1801 * Next subbuffer reserve offset does not match the
1802 * commit offset. Don't perform switch in
1803 * producer-consumer and overwrite mode. Caused by
1804 * either a writer OOPS or too many nested writes over a
1805 * reserve/commit pair.
1811 * Need to write the subbuffer start header on finalize.
1813 offsets
->switch_old_start
= 1;
1815 offsets
->begin
= subbuf_align(offsets
->begin
, chan
);
1816 /* Note: old points to the next subbuf at offset 0 */
1817 offsets
->end
= offsets
->begin
;
1822 * Force a sub-buffer switch. This operation is completely reentrant : can be
1823 * called while tracing is active with absolutely no lock held.
1825 * Note, however, that as a v_cmpxchg is used for some atomic
1826 * operations, this function must be called from the CPU which owns the buffer
1827 * for a ACTIVE flush.
1829 void lib_ring_buffer_switch_slow(struct lib_ring_buffer
*buf
, enum switch_mode mode
)
1831 struct channel
*chan
= buf
->backend
.chan
;
1832 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1833 struct switch_offsets offsets
;
1834 unsigned long oldidx
;
1840 * Perform retryable operations.
1843 if (lib_ring_buffer_try_switch_slow(mode
, buf
, chan
, &offsets
,
1845 return; /* Switch not needed */
1846 } while (v_cmpxchg(config
, &buf
->offset
, offsets
.old
, offsets
.end
)
1850 * Atomically update last_tsc. This update races against concurrent
1851 * atomic updates, but the race will always cause supplementary full TSC
1852 * records, never the opposite (missing a full TSC record when it would
1855 save_last_tsc(config
, buf
, tsc
);
1858 * Push the reader if necessary
1860 lib_ring_buffer_reserve_push_reader(buf
, chan
, offsets
.old
);
1862 oldidx
= subbuf_index(offsets
.old
, chan
);
1863 lib_ring_buffer_clear_noref(config
, &buf
->backend
, oldidx
);
1866 * May need to populate header start on SWITCH_FLUSH.
1868 if (offsets
.switch_old_start
) {
1869 lib_ring_buffer_switch_old_start(buf
, chan
, &offsets
, tsc
);
1870 offsets
.old
+= config
->cb
.subbuffer_header_size();
1874 * Switch old subbuffer.
1876 lib_ring_buffer_switch_old_end(buf
, chan
, &offsets
, tsc
);
1878 EXPORT_SYMBOL_GPL(lib_ring_buffer_switch_slow
);
1880 struct switch_param
{
1881 struct lib_ring_buffer
*buf
;
1882 enum switch_mode mode
;
1885 static void remote_switch(void *info
)
1887 struct switch_param
*param
= info
;
1888 struct lib_ring_buffer
*buf
= param
->buf
;
1890 lib_ring_buffer_switch_slow(buf
, param
->mode
);
1893 static void _lib_ring_buffer_switch_remote(struct lib_ring_buffer
*buf
,
1894 enum switch_mode mode
)
1896 struct channel
*chan
= buf
->backend
.chan
;
1897 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1899 struct switch_param param
;
1902 * With global synchronization we don't need to use the IPI scheme.
1904 if (config
->sync
== RING_BUFFER_SYNC_GLOBAL
) {
1905 lib_ring_buffer_switch_slow(buf
, mode
);
1910 * Disabling preemption ensures two things: first, that the
1911 * target cpu is not taken concurrently offline while we are within
1912 * smp_call_function_single(). Secondly, if it happens that the
1913 * CPU is not online, our own call to lib_ring_buffer_switch_slow()
1914 * needs to be protected from CPU hotplug handlers, which can
1915 * also perform a remote subbuffer switch.
1920 ret
= smp_call_function_single(buf
->backend
.cpu
,
1921 remote_switch
, ¶m
, 1);
1923 /* Remote CPU is offline, do it ourself. */
1924 lib_ring_buffer_switch_slow(buf
, mode
);
1929 /* Switch sub-buffer if current sub-buffer is non-empty. */
1930 void lib_ring_buffer_switch_remote(struct lib_ring_buffer
*buf
)
1932 _lib_ring_buffer_switch_remote(buf
, SWITCH_ACTIVE
);
1934 EXPORT_SYMBOL_GPL(lib_ring_buffer_switch_remote
);
1936 /* Switch sub-buffer even if current sub-buffer is empty. */
1937 void lib_ring_buffer_switch_remote_empty(struct lib_ring_buffer
*buf
)
1939 _lib_ring_buffer_switch_remote(buf
, SWITCH_FLUSH
);
1941 EXPORT_SYMBOL_GPL(lib_ring_buffer_switch_remote_empty
);
1946 * -ENOSPC if event size is too large for packet.
1947 * -ENOBUFS if there is currently not enough space in buffer for the event.
1948 * -EIO if data cannot be written into the buffer for any other reason.
1951 int lib_ring_buffer_try_reserve_slow(struct lib_ring_buffer
*buf
,
1952 struct channel
*chan
,
1953 struct switch_offsets
*offsets
,
1954 struct lib_ring_buffer_ctx
*ctx
)
1956 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
1957 unsigned long reserve_commit_diff
, offset_cmp
;
1960 offsets
->begin
= offset_cmp
= v_read(config
, &buf
->offset
);
1961 offsets
->old
= offsets
->begin
;
1962 offsets
->switch_new_start
= 0;
1963 offsets
->switch_new_end
= 0;
1964 offsets
->switch_old_end
= 0;
1965 offsets
->pre_header_padding
= 0;
1967 ctx
->tsc
= config
->cb
.ring_buffer_clock_read(chan
);
1968 if ((int64_t) ctx
->tsc
== -EIO
)
1971 if (last_tsc_overflow(config
, buf
, ctx
->tsc
))
1972 ctx
->rflags
|= RING_BUFFER_RFLAG_FULL_TSC
;
1974 if (unlikely(subbuf_offset(offsets
->begin
, ctx
->chan
) == 0)) {
1975 offsets
->switch_new_start
= 1; /* For offsets->begin */
1977 offsets
->size
= config
->cb
.record_header_size(config
, chan
,
1979 &offsets
->pre_header_padding
,
1982 lib_ring_buffer_align(offsets
->begin
+ offsets
->size
,
1985 if (unlikely(subbuf_offset(offsets
->begin
, chan
) +
1986 offsets
->size
> chan
->backend
.subbuf_size
)) {
1987 offsets
->switch_old_end
= 1; /* For offsets->old */
1988 offsets
->switch_new_start
= 1; /* For offsets->begin */
1991 if (unlikely(offsets
->switch_new_start
)) {
1992 unsigned long sb_index
, commit_count
;
1995 * We are typically not filling the previous buffer completely.
1997 if (likely(offsets
->switch_old_end
))
1998 offsets
->begin
= subbuf_align(offsets
->begin
, chan
);
1999 offsets
->begin
= offsets
->begin
2000 + config
->cb
.subbuffer_header_size();
2001 /* Test new buffer integrity */
2002 sb_index
= subbuf_index(offsets
->begin
, chan
);
2004 * Read buf->offset before buf->commit_cold[sb_index].cc_sb.
2005 * lib_ring_buffer_check_deliver() has the matching
2006 * memory barriers required around commit_cold cc_sb
2007 * updates to ensure reserve and commit counter updates
2008 * are not seen reordered when updated by another CPU.
2011 commit_count
= v_read(config
,
2012 &buf
->commit_cold
[sb_index
].cc_sb
);
2013 /* Read buf->commit_cold[sb_index].cc_sb before buf->offset. */
2015 if (unlikely(offset_cmp
!= v_read(config
, &buf
->offset
))) {
2017 * The reserve counter have been concurrently updated
2018 * while we read the commit counter. This means the
2019 * commit counter we read might not match buf->offset
2020 * due to concurrent update. We therefore need to retry.
2024 reserve_commit_diff
=
2025 (buf_trunc(offsets
->begin
, chan
)
2026 >> chan
->backend
.num_subbuf_order
)
2027 - (commit_count
& chan
->commit_count_mask
);
2028 if (likely(reserve_commit_diff
== 0)) {
2029 /* Next subbuffer not being written to. */
2030 if (unlikely(config
->mode
!= RING_BUFFER_OVERWRITE
&&
2031 subbuf_trunc(offsets
->begin
, chan
)
2032 - subbuf_trunc((unsigned long)
2033 atomic_long_read(&buf
->consumed
), chan
)
2034 >= chan
->backend
.buf_size
)) {
2036 * We do not overwrite non consumed buffers
2037 * and we are full : record is lost.
2039 v_inc(config
, &buf
->records_lost_full
);
2043 * Next subbuffer not being written to, and we
2044 * are either in overwrite mode or the buffer is
2045 * not full. It's safe to write in this new
2051 * Next subbuffer reserve offset does not match the
2052 * commit offset, and this did not involve update to the
2053 * reserve counter. Drop record in producer-consumer and
2054 * overwrite mode. Caused by either a writer OOPS or
2055 * too many nested writes over a reserve/commit pair.
2057 v_inc(config
, &buf
->records_lost_wrap
);
2061 config
->cb
.record_header_size(config
, chan
,
2063 &offsets
->pre_header_padding
,
2066 lib_ring_buffer_align(offsets
->begin
+ offsets
->size
,
2069 if (unlikely(subbuf_offset(offsets
->begin
, chan
)
2070 + offsets
->size
> chan
->backend
.subbuf_size
)) {
2072 * Record too big for subbuffers, report error, don't
2073 * complete the sub-buffer switch.
2075 v_inc(config
, &buf
->records_lost_big
);
2079 * We just made a successful buffer switch and the
2080 * record fits in the new subbuffer. Let's write.
2085 * Record fits in the current buffer and we are not on a switch
2086 * boundary. It's safe to write.
2089 offsets
->end
= offsets
->begin
+ offsets
->size
;
2091 if (unlikely(subbuf_offset(offsets
->end
, chan
) == 0)) {
2093 * The offset_end will fall at the very beginning of the next
2096 offsets
->switch_new_end
= 1; /* For offsets->begin */
2101 static struct lib_ring_buffer
*get_current_buf(struct channel
*chan
, int cpu
)
2103 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
2105 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
2106 return per_cpu_ptr(chan
->backend
.buf
, cpu
);
2108 return chan
->backend
.buf
;
2111 void lib_ring_buffer_lost_event_too_big(struct channel
*chan
)
2113 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
2114 struct lib_ring_buffer
*buf
= get_current_buf(chan
, smp_processor_id());
2116 v_inc(config
, &buf
->records_lost_big
);
2118 EXPORT_SYMBOL_GPL(lib_ring_buffer_lost_event_too_big
);
2121 * lib_ring_buffer_reserve_slow - Atomic slot reservation in a buffer.
2122 * @ctx: ring buffer context.
2124 * Return : -NOBUFS if not enough space, -ENOSPC if event size too large,
2125 * -EIO for other errors, else returns 0.
2126 * It will take care of sub-buffer switching.
2128 int lib_ring_buffer_reserve_slow(struct lib_ring_buffer_ctx
*ctx
)
2130 struct channel
*chan
= ctx
->chan
;
2131 const struct lib_ring_buffer_config
*config
= &chan
->backend
.config
;
2132 struct lib_ring_buffer
*buf
;
2133 struct switch_offsets offsets
;
2136 ctx
->buf
= buf
= get_current_buf(chan
, ctx
->cpu
);
2140 ret
= lib_ring_buffer_try_reserve_slow(buf
, chan
, &offsets
,
2144 } while (unlikely(v_cmpxchg(config
, &buf
->offset
, offsets
.old
,
2149 * Atomically update last_tsc. This update races against concurrent
2150 * atomic updates, but the race will always cause supplementary full TSC
2151 * records, never the opposite (missing a full TSC record when it would
2154 save_last_tsc(config
, buf
, ctx
->tsc
);
2157 * Push the reader if necessary
2159 lib_ring_buffer_reserve_push_reader(buf
, chan
, offsets
.end
- 1);
2162 * Clear noref flag for this subbuffer.
2164 lib_ring_buffer_clear_noref(config
, &buf
->backend
,
2165 subbuf_index(offsets
.end
- 1, chan
));
2168 * Switch old subbuffer if needed.
2170 if (unlikely(offsets
.switch_old_end
)) {
2171 lib_ring_buffer_clear_noref(config
, &buf
->backend
,
2172 subbuf_index(offsets
.old
- 1, chan
));
2173 lib_ring_buffer_switch_old_end(buf
, chan
, &offsets
, ctx
->tsc
);
2177 * Populate new subbuffer.
2179 if (unlikely(offsets
.switch_new_start
))
2180 lib_ring_buffer_switch_new_start(buf
, chan
, &offsets
, ctx
->tsc
);
2182 if (unlikely(offsets
.switch_new_end
))
2183 lib_ring_buffer_switch_new_end(buf
, chan
, &offsets
, ctx
->tsc
);
2185 ctx
->slot_size
= offsets
.size
;
2186 ctx
->pre_offset
= offsets
.begin
;
2187 ctx
->buf_offset
= offsets
.begin
+ offsets
.pre_header_padding
;
2190 EXPORT_SYMBOL_GPL(lib_ring_buffer_reserve_slow
);
2193 void lib_ring_buffer_vmcore_check_deliver(const struct lib_ring_buffer_config
*config
,
2194 struct lib_ring_buffer
*buf
,
2195 unsigned long commit_count
,
2198 if (config
->oops
== RING_BUFFER_OOPS_CONSISTENCY
)
2199 v_set(config
, &buf
->commit_hot
[idx
].seq
, commit_count
);
2203 * The ring buffer can count events recorded and overwritten per buffer,
2204 * but it is disabled by default due to its performance overhead.
2206 #ifdef LTTNG_RING_BUFFER_COUNT_EVENTS
2208 void deliver_count_events(const struct lib_ring_buffer_config
*config
,
2209 struct lib_ring_buffer
*buf
,
2212 v_add(config
, subbuffer_get_records_count(config
,
2213 &buf
->backend
, idx
),
2214 &buf
->records_count
);
2215 v_add(config
, subbuffer_count_records_overrun(config
,
2216 &buf
->backend
, idx
),
2217 &buf
->records_overrun
);
2219 #else /* LTTNG_RING_BUFFER_COUNT_EVENTS */
2221 void deliver_count_events(const struct lib_ring_buffer_config
*config
,
2222 struct lib_ring_buffer
*buf
,
2226 #endif /* #else LTTNG_RING_BUFFER_COUNT_EVENTS */
2229 void lib_ring_buffer_check_deliver_slow(const struct lib_ring_buffer_config
*config
,
2230 struct lib_ring_buffer
*buf
,
2231 struct channel
*chan
,
2232 unsigned long offset
,
2233 unsigned long commit_count
,
2237 unsigned long old_commit_count
= commit_count
2238 - chan
->backend
.subbuf_size
;
2241 * If we succeeded at updating cc_sb below, we are the subbuffer
2242 * writer delivering the subbuffer. Deals with concurrent
2243 * updates of the "cc" value without adding a add_return atomic
2244 * operation to the fast path.
2246 * We are doing the delivery in two steps:
2247 * - First, we cmpxchg() cc_sb to the new value
2248 * old_commit_count + 1. This ensures that we are the only
2249 * subbuffer user successfully filling the subbuffer, but we
2250 * do _not_ set the cc_sb value to "commit_count" yet.
2251 * Therefore, other writers that would wrap around the ring
2252 * buffer and try to start writing to our subbuffer would
2253 * have to drop records, because it would appear as
2255 * We therefore have exclusive access to the subbuffer control
2256 * structures. This mutual exclusion with other writers is
2257 * crucially important to perform record overruns count in
2258 * flight recorder mode locklessly.
2259 * - When we are ready to release the subbuffer (either for
2260 * reading or for overrun by other writers), we simply set the
2261 * cc_sb value to "commit_count" and perform delivery.
2263 * The subbuffer size is least 2 bytes (minimum size: 1 page).
2264 * This guarantees that old_commit_count + 1 != commit_count.
2268 * Order prior updates to reserve count prior to the
2269 * commit_cold cc_sb update.
2272 if (likely(v_cmpxchg(config
, &buf
->commit_cold
[idx
].cc_sb
,
2273 old_commit_count
, old_commit_count
+ 1)
2274 == old_commit_count
)) {
2278 * Start of exclusive subbuffer access. We are
2279 * guaranteed to be the last writer in this subbuffer
2280 * and any other writer trying to access this subbuffer
2281 * in this state is required to drop records.
2283 * We can read the ts_end for the current sub-buffer
2284 * which has been saved by the very last space
2285 * reservation for the current sub-buffer.
2287 * Order increment of commit counter before reading ts_end.
2290 ts_end
= &buf
->ts_end
[idx
];
2291 deliver_count_events(config
, buf
, idx
);
2292 config
->cb
.buffer_end(buf
, *ts_end
, idx
,
2293 lib_ring_buffer_get_data_size(config
,
2298 * Increment the packet counter while we have exclusive
2301 subbuffer_inc_packet_count(config
, &buf
->backend
, idx
);
2304 * Set noref flag and offset for this subbuffer id.
2305 * Contains a memory barrier that ensures counter stores
2306 * are ordered before set noref and offset.
2308 lib_ring_buffer_set_noref_offset(config
, &buf
->backend
, idx
,
2309 buf_trunc_val(offset
, chan
));
2312 * Order set_noref and record counter updates before the
2313 * end of subbuffer exclusive access. Orders with
2314 * respect to writers coming into the subbuffer after
2315 * wrap around, and also order wrt concurrent readers.
2318 /* End of exclusive subbuffer access */
2319 v_set(config
, &buf
->commit_cold
[idx
].cc_sb
,
2322 * Order later updates to reserve count after
2323 * the commit_cold cc_sb update.
2326 lib_ring_buffer_vmcore_check_deliver(config
, buf
,
2330 * RING_BUFFER_WAKEUP_BY_WRITER wakeup is not lock-free.
2332 if (config
->wakeup
== RING_BUFFER_WAKEUP_BY_WRITER
2333 && atomic_long_read(&buf
->active_readers
)
2334 && lib_ring_buffer_poll_deliver(config
, buf
, chan
)) {
2335 wake_up_interruptible(&buf
->read_wait
);
2336 wake_up_interruptible(&chan
->read_wait
);
2341 EXPORT_SYMBOL_GPL(lib_ring_buffer_check_deliver_slow
);
2343 int __init
init_lib_ring_buffer_frontend(void)
2347 for_each_possible_cpu(cpu
)
2348 spin_lock_init(&per_cpu(ring_buffer_nohz_lock
, cpu
));
2352 module_init(init_lib_ring_buffer_frontend
);
2354 void __exit
exit_lib_ring_buffer_frontend(void)
2358 module_exit(exit_lib_ring_buffer_frontend
);