2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * Ring buffer backend (internal helpers).
9 #ifndef _LTTNG_RING_BUFFER_BACKEND_INTERNAL_H
10 #define _LTTNG_RING_BUFFER_BACKEND_INTERNAL_H
15 #include <urcu/compiler.h>
17 #include <lttng/ust-ringbuffer-context.h>
18 #include "ringbuffer-config.h"
19 #include "backend_types.h"
20 #include "frontend_types.h"
23 /* Ring buffer backend API presented to the frontend */
25 /* Ring buffer and channel backend create/free */
27 int lib_ring_buffer_backend_create(struct lttng_ust_ring_buffer_backend
*bufb
,
28 struct channel_backend
*chan
,
30 struct lttng_ust_shm_handle
*handle
,
31 struct shm_object
*shmobj
)
32 __attribute__((visibility("hidden")));
34 void channel_backend_unregister_notifiers(struct channel_backend
*chanb
)
35 __attribute__((visibility("hidden")));
37 void lib_ring_buffer_backend_free(struct lttng_ust_ring_buffer_backend
*bufb
)
38 __attribute__((visibility("hidden")));
40 int channel_backend_init(struct channel_backend
*chanb
,
42 const struct lttng_ust_ring_buffer_config
*config
,
44 size_t num_subbuf
, struct lttng_ust_shm_handle
*handle
,
45 const int *stream_fds
)
46 __attribute__((visibility("hidden")));
48 void channel_backend_free(struct channel_backend
*chanb
,
49 struct lttng_ust_shm_handle
*handle
)
50 __attribute__((visibility("hidden")));
52 void lib_ring_buffer_backend_reset(struct lttng_ust_ring_buffer_backend
*bufb
,
53 struct lttng_ust_shm_handle
*handle
)
54 __attribute__((visibility("hidden")));
56 void channel_backend_reset(struct channel_backend
*chanb
)
57 __attribute__((visibility("hidden")));
59 int lib_ring_buffer_backend_init(void)
60 __attribute__((visibility("hidden")));
62 void lib_ring_buffer_backend_exit(void)
63 __attribute__((visibility("hidden")));
65 extern void _lib_ring_buffer_write(struct lttng_ust_ring_buffer_backend
*bufb
,
66 size_t offset
, const void *src
, size_t len
,
68 __attribute__((visibility("hidden")));
71 * Subbuffer ID bits for overwrite mode. Need to fit within a single word to be
72 * exchanged atomically.
74 * Top half word, except lowest bit, belongs to "offset", which is used to keep
75 * to count the produced buffers. For overwrite mode, this provides the
76 * consumer with the capacity to read subbuffers in order, handling the
77 * situation where producers would write up to 2^15 buffers (or 2^31 for 64-bit
78 * systems) concurrently with a single execution of get_subbuf (between offset
79 * sampling and subbuffer ID exchange).
82 #define HALF_ULONG_BITS (CAA_BITS_PER_LONG >> 1)
84 #define SB_ID_OFFSET_SHIFT (HALF_ULONG_BITS + 1)
85 #define SB_ID_OFFSET_COUNT (1UL << SB_ID_OFFSET_SHIFT)
86 #define SB_ID_OFFSET_MASK (~(SB_ID_OFFSET_COUNT - 1))
88 * Lowest bit of top word half belongs to noref. Used only for overwrite mode.
90 #define SB_ID_NOREF_SHIFT (SB_ID_OFFSET_SHIFT - 1)
91 #define SB_ID_NOREF_COUNT (1UL << SB_ID_NOREF_SHIFT)
92 #define SB_ID_NOREF_MASK SB_ID_NOREF_COUNT
94 * In overwrite mode: lowest half of word is used for index.
95 * Limit of 2^16 subbuffers per buffer on 32-bit, 2^32 on 64-bit.
96 * In producer-consumer mode: whole word used for index.
98 #define SB_ID_INDEX_SHIFT 0
99 #define SB_ID_INDEX_COUNT (1UL << SB_ID_INDEX_SHIFT)
100 #define SB_ID_INDEX_MASK (SB_ID_NOREF_COUNT - 1)
103 * Construct the subbuffer id from offset, index and noref. Use only the index
104 * for producer-consumer mode (offset and noref are only used in overwrite
108 unsigned long subbuffer_id(const struct lttng_ust_ring_buffer_config
*config
,
109 unsigned long offset
, unsigned long noref
,
112 if (config
->mode
== RING_BUFFER_OVERWRITE
)
113 return (offset
<< SB_ID_OFFSET_SHIFT
)
114 | (noref
<< SB_ID_NOREF_SHIFT
)
121 * Compare offset with the offset contained within id. Return 1 if the offset
122 * bits are identical, else 0.
125 int subbuffer_id_compare_offset(
126 const struct lttng_ust_ring_buffer_config
*config
__attribute__((unused
)),
127 unsigned long id
, unsigned long offset
)
129 return (id
& SB_ID_OFFSET_MASK
) == (offset
<< SB_ID_OFFSET_SHIFT
);
133 unsigned long subbuffer_id_get_index(const struct lttng_ust_ring_buffer_config
*config
,
136 if (config
->mode
== RING_BUFFER_OVERWRITE
)
137 return id
& SB_ID_INDEX_MASK
;
143 unsigned long subbuffer_id_is_noref(const struct lttng_ust_ring_buffer_config
*config
,
146 if (config
->mode
== RING_BUFFER_OVERWRITE
)
147 return !!(id
& SB_ID_NOREF_MASK
);
153 * Only used by reader on subbuffer ID it has exclusive access to. No volatile
157 void subbuffer_id_set_noref(const struct lttng_ust_ring_buffer_config
*config
,
160 if (config
->mode
== RING_BUFFER_OVERWRITE
)
161 *id
|= SB_ID_NOREF_MASK
;
165 void subbuffer_id_set_noref_offset(const struct lttng_ust_ring_buffer_config
*config
,
166 unsigned long *id
, unsigned long offset
)
170 if (config
->mode
== RING_BUFFER_OVERWRITE
) {
172 tmp
&= ~SB_ID_OFFSET_MASK
;
173 tmp
|= offset
<< SB_ID_OFFSET_SHIFT
;
174 tmp
|= SB_ID_NOREF_MASK
;
175 /* Volatile store, read concurrently by readers. */
176 CMM_ACCESS_ONCE(*id
) = tmp
;
180 /* No volatile access, since already used locally */
182 void subbuffer_id_clear_noref(const struct lttng_ust_ring_buffer_config
*config
,
185 if (config
->mode
== RING_BUFFER_OVERWRITE
)
186 *id
&= ~SB_ID_NOREF_MASK
;
190 * For overwrite mode, cap the number of subbuffers per buffer to:
191 * 2^16 on 32-bit architectures
192 * 2^32 on 64-bit architectures
193 * This is required to fit in the index part of the ID. Return 0 on success,
197 int subbuffer_id_check_index(const struct lttng_ust_ring_buffer_config
*config
,
198 unsigned long num_subbuf
)
200 if (config
->mode
== RING_BUFFER_OVERWRITE
)
201 return (num_subbuf
> (1UL << HALF_ULONG_BITS
)) ? -EPERM
: 0;
207 int lib_ring_buffer_backend_get_pages(const struct lttng_ust_ring_buffer_config
*config
,
208 const struct lttng_ust_ring_buffer_ctx
*ctx
,
209 struct lttng_ust_ring_buffer_backend_pages
**backend_pages
)
211 struct lttng_ust_ring_buffer_ctx_private
*ctx_private
= ctx
->priv
;
212 struct lttng_ust_ring_buffer_backend
*bufb
= &ctx_private
->buf
->backend
;
213 struct channel_backend
*chanb
= &ctx_private
->chan
->backend
;
214 struct lttng_ust_shm_handle
*handle
= ctx_private
->chan
->handle
;
216 size_t offset
= ctx_private
->buf_offset
;
217 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
218 struct lttng_ust_ring_buffer_backend_pages_shmp
*rpages
;
219 unsigned long sb_bindex
, id
;
220 struct lttng_ust_ring_buffer_backend_pages
*_backend_pages
;
222 offset
&= chanb
->buf_size
- 1;
223 sbidx
= offset
>> chanb
->subbuf_size_order
;
224 wsb
= shmp_index(handle
, bufb
->buf_wsb
, sbidx
);
225 if (caa_unlikely(!wsb
))
228 sb_bindex
= subbuffer_id_get_index(config
, id
);
229 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
230 if (caa_unlikely(!rpages
))
232 CHAN_WARN_ON(ctx_private
->chan
,
233 config
->mode
== RING_BUFFER_OVERWRITE
234 && subbuffer_id_is_noref(config
, id
));
235 _backend_pages
= shmp(handle
, rpages
->shmp
);
236 if (caa_unlikely(!_backend_pages
))
238 *backend_pages
= _backend_pages
;
242 /* Get backend pages from cache. */
244 struct lttng_ust_ring_buffer_backend_pages
*
245 lib_ring_buffer_get_backend_pages_from_ctx(
246 const struct lttng_ust_ring_buffer_config
*config
__attribute__((unused
)),
247 const struct lttng_ust_ring_buffer_ctx
*ctx
)
249 return ctx
->priv
->backend_pages
;
253 * The ring buffer can count events recorded and overwritten per buffer,
254 * but it is disabled by default due to its performance overhead.
256 #ifdef LTTNG_RING_BUFFER_COUNT_EVENTS
258 void subbuffer_count_record(const struct lttng_ust_ring_buffer_config
*config
,
259 const struct lttng_ust_ring_buffer_ctx
*ctx
)
261 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
263 backend_pages
= lib_ring_buffer_get_backend_pages_from_ctx(config
, ctx
);
264 if (caa_unlikely(!backend_pages
)) {
265 if (lib_ring_buffer_backend_get_pages(config
, ctx
, &backend_pages
))
268 v_inc(config
, &backend_pages
->records_commit
);
270 #else /* LTTNG_RING_BUFFER_COUNT_EVENTS */
272 void subbuffer_count_record(const struct lttng_ust_ring_buffer_config
*config
__attribute__((unused
)),
273 const struct lttng_ust_ring_buffer_ctx
*ctx
__attribute__((unused
)))
276 #endif /* #else LTTNG_RING_BUFFER_COUNT_EVENTS */
279 * Reader has exclusive subbuffer access for record consumption. No need to
280 * perform the decrement atomically.
283 void subbuffer_consume_record(const struct lttng_ust_ring_buffer_config
*config
,
284 struct lttng_ust_ring_buffer_backend
*bufb
,
285 struct lttng_ust_shm_handle
*handle
)
287 unsigned long sb_bindex
;
288 struct lttng_ust_ring_buffer_channel
*chan
;
289 struct lttng_ust_ring_buffer_backend_pages_shmp
*pages_shmp
;
290 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
292 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_rsb
.id
);
293 chan
= shmp(handle
, bufb
->chan
);
296 pages_shmp
= shmp_index(handle
, bufb
->array
, sb_bindex
);
299 backend_pages
= shmp(handle
, pages_shmp
->shmp
);
302 CHAN_WARN_ON(chan
, !v_read(config
, &backend_pages
->records_unread
));
303 /* Non-atomic decrement protected by exclusive subbuffer access */
304 _v_dec(config
, &backend_pages
->records_unread
);
305 v_inc(config
, &bufb
->records_read
);
309 unsigned long subbuffer_get_records_count(
310 const struct lttng_ust_ring_buffer_config
*config
,
311 struct lttng_ust_ring_buffer_backend
*bufb
,
313 struct lttng_ust_shm_handle
*handle
)
315 unsigned long sb_bindex
;
316 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
317 struct lttng_ust_ring_buffer_backend_pages_shmp
*rpages
;
318 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
320 wsb
= shmp_index(handle
, bufb
->buf_wsb
, idx
);
323 sb_bindex
= subbuffer_id_get_index(config
, wsb
->id
);
324 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
327 backend_pages
= shmp(handle
, rpages
->shmp
);
330 return v_read(config
, &backend_pages
->records_commit
);
334 * Must be executed at subbuffer delivery when the writer has _exclusive_
335 * subbuffer access. See lib_ring_buffer_check_deliver() for details.
336 * lib_ring_buffer_get_records_count() must be called to get the records
337 * count before this function, because it resets the records_commit
341 unsigned long subbuffer_count_records_overrun(
342 const struct lttng_ust_ring_buffer_config
*config
,
343 struct lttng_ust_ring_buffer_backend
*bufb
,
345 struct lttng_ust_shm_handle
*handle
)
347 unsigned long overruns
, sb_bindex
;
348 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
349 struct lttng_ust_ring_buffer_backend_pages_shmp
*rpages
;
350 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
352 wsb
= shmp_index(handle
, bufb
->buf_wsb
, idx
);
355 sb_bindex
= subbuffer_id_get_index(config
, wsb
->id
);
356 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
359 backend_pages
= shmp(handle
, rpages
->shmp
);
362 overruns
= v_read(config
, &backend_pages
->records_unread
);
363 v_set(config
, &backend_pages
->records_unread
,
364 v_read(config
, &backend_pages
->records_commit
));
365 v_set(config
, &backend_pages
->records_commit
, 0);
371 void subbuffer_set_data_size(const struct lttng_ust_ring_buffer_config
*config
,
372 struct lttng_ust_ring_buffer_backend
*bufb
,
374 unsigned long data_size
,
375 struct lttng_ust_shm_handle
*handle
)
377 unsigned long sb_bindex
;
378 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
379 struct lttng_ust_ring_buffer_backend_pages_shmp
*rpages
;
380 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
382 wsb
= shmp_index(handle
, bufb
->buf_wsb
, idx
);
385 sb_bindex
= subbuffer_id_get_index(config
, wsb
->id
);
386 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
389 backend_pages
= shmp(handle
, rpages
->shmp
);
392 backend_pages
->data_size
= data_size
;
396 unsigned long subbuffer_get_read_data_size(
397 const struct lttng_ust_ring_buffer_config
*config
,
398 struct lttng_ust_ring_buffer_backend
*bufb
,
399 struct lttng_ust_shm_handle
*handle
)
401 unsigned long sb_bindex
;
402 struct lttng_ust_ring_buffer_backend_pages_shmp
*pages_shmp
;
403 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
405 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_rsb
.id
);
406 pages_shmp
= shmp_index(handle
, bufb
->array
, sb_bindex
);
409 backend_pages
= shmp(handle
, pages_shmp
->shmp
);
412 return backend_pages
->data_size
;
416 unsigned long subbuffer_get_data_size(
417 const struct lttng_ust_ring_buffer_config
*config
,
418 struct lttng_ust_ring_buffer_backend
*bufb
,
420 struct lttng_ust_shm_handle
*handle
)
422 unsigned long sb_bindex
;
423 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
424 struct lttng_ust_ring_buffer_backend_pages_shmp
*rpages
;
425 struct lttng_ust_ring_buffer_backend_pages
*backend_pages
;
427 wsb
= shmp_index(handle
, bufb
->buf_wsb
, idx
);
430 sb_bindex
= subbuffer_id_get_index(config
, wsb
->id
);
431 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
434 backend_pages
= shmp(handle
, rpages
->shmp
);
437 return backend_pages
->data_size
;
441 void subbuffer_inc_packet_count(
442 const struct lttng_ust_ring_buffer_config
*config
__attribute__((unused
)),
443 struct lttng_ust_ring_buffer_backend
*bufb
,
444 unsigned long idx
, struct lttng_ust_shm_handle
*handle
)
446 struct lttng_ust_ring_buffer_backend_counts
*counts
;
448 counts
= shmp_index(handle
, bufb
->buf_cnt
, idx
);
455 * lib_ring_buffer_clear_noref - Clear the noref subbuffer flag, called by
459 void lib_ring_buffer_clear_noref(const struct lttng_ust_ring_buffer_config
*config
,
460 struct lttng_ust_ring_buffer_backend
*bufb
,
462 struct lttng_ust_shm_handle
*handle
)
464 unsigned long id
, new_id
;
465 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
467 if (config
->mode
!= RING_BUFFER_OVERWRITE
)
471 * Performing a volatile access to read the sb_pages, because we want to
472 * read a coherent version of the pointer and the associated noref flag.
474 wsb
= shmp_index(handle
, bufb
->buf_wsb
, idx
);
477 id
= CMM_ACCESS_ONCE(wsb
->id
);
479 /* This check is called on the fast path for each record. */
480 if (caa_likely(!subbuffer_id_is_noref(config
, id
))) {
482 * Store after load dependency ordering the writes to
483 * the subbuffer after load and test of the noref flag
484 * matches the memory barrier implied by the cmpxchg()
485 * in update_read_sb_index().
487 return; /* Already writing to this buffer */
490 subbuffer_id_clear_noref(config
, &new_id
);
491 new_id
= uatomic_cmpxchg(&wsb
->id
, id
, new_id
);
492 if (caa_likely(new_id
== id
))
499 * lib_ring_buffer_set_noref_offset - Set the noref subbuffer flag and offset,
503 void lib_ring_buffer_set_noref_offset(const struct lttng_ust_ring_buffer_config
*config
,
504 struct lttng_ust_ring_buffer_backend
*bufb
,
505 unsigned long idx
, unsigned long offset
,
506 struct lttng_ust_shm_handle
*handle
)
508 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
509 struct lttng_ust_ring_buffer_channel
*chan
;
511 if (config
->mode
!= RING_BUFFER_OVERWRITE
)
514 wsb
= shmp_index(handle
, bufb
->buf_wsb
, idx
);
518 * Because ring_buffer_set_noref() is only called by a single thread
519 * (the one which updated the cc_sb value), there are no concurrent
520 * updates to take care of: other writers have not updated cc_sb, so
521 * they cannot set the noref flag, and concurrent readers cannot modify
522 * the pointer because the noref flag is not set yet.
523 * The smp_wmb() in ring_buffer_commit() takes care of ordering writes
524 * to the subbuffer before this set noref operation.
525 * subbuffer_set_noref() uses a volatile store to deal with concurrent
526 * readers of the noref flag.
528 chan
= shmp(handle
, bufb
->chan
);
531 CHAN_WARN_ON(chan
, subbuffer_id_is_noref(config
, wsb
->id
));
533 * Memory barrier that ensures counter stores are ordered before set
537 subbuffer_id_set_noref_offset(config
, &wsb
->id
, offset
);
541 * update_read_sb_index - Read-side subbuffer index update.
544 int update_read_sb_index(const struct lttng_ust_ring_buffer_config
*config
,
545 struct lttng_ust_ring_buffer_backend
*bufb
,
546 struct channel_backend
*chanb
__attribute__((unused
)),
547 unsigned long consumed_idx
,
548 unsigned long consumed_count
,
549 struct lttng_ust_shm_handle
*handle
)
551 struct lttng_ust_ring_buffer_backend_subbuffer
*wsb
;
552 unsigned long old_id
, new_id
;
554 wsb
= shmp_index(handle
, bufb
->buf_wsb
, consumed_idx
);
555 if (caa_unlikely(!wsb
))
558 if (config
->mode
== RING_BUFFER_OVERWRITE
) {
559 struct lttng_ust_ring_buffer_channel
*chan
;
562 * Exchange the target writer subbuffer with our own unused
563 * subbuffer. No need to use CMM_ACCESS_ONCE() here to read the
564 * old_wpage, because the value read will be confirmed by the
565 * following cmpxchg().
568 if (caa_unlikely(!subbuffer_id_is_noref(config
, old_id
)))
571 * Make sure the offset count we are expecting matches the one
572 * indicated by the writer.
574 if (caa_unlikely(!subbuffer_id_compare_offset(config
, old_id
,
577 chan
= shmp(handle
, bufb
->chan
);
578 if (caa_unlikely(!chan
))
580 CHAN_WARN_ON(chan
, !subbuffer_id_is_noref(config
, bufb
->buf_rsb
.id
));
581 subbuffer_id_set_noref_offset(config
, &bufb
->buf_rsb
.id
,
583 new_id
= uatomic_cmpxchg(&wsb
->id
, old_id
, bufb
->buf_rsb
.id
);
584 if (caa_unlikely(old_id
!= new_id
))
586 bufb
->buf_rsb
.id
= new_id
;
588 /* No page exchange, use the writer page directly */
589 bufb
->buf_rsb
.id
= wsb
->id
;
594 #ifndef inline_memcpy
595 #define inline_memcpy(dest, src, n) memcpy(dest, src, n)
598 #define LOAD_UNALIGNED_INT(type, p) \
600 struct packed_struct { type __v; } __attribute__((packed)); \
601 (((const struct packed_struct *) (p))->__v); \
604 #define STORE_UNALIGNED_INT(type, p, v) \
606 struct packed_struct { type __v; } __attribute__((packed)); \
607 ((struct packed_struct *) (p))->__v = (v); \
611 * Copy from src into dest, assuming unaligned src and dest.
614 void lttng_inline_memcpy(void *dest
, const void *src
,
616 __attribute__((always_inline
));
618 void lttng_inline_memcpy(void *dest
, const void *src
,
623 *(uint8_t *) dest
= *(const uint8_t *) src
;
626 STORE_UNALIGNED_INT(uint16_t, dest
, LOAD_UNALIGNED_INT(uint16_t, src
));
629 STORE_UNALIGNED_INT(uint32_t, dest
, LOAD_UNALIGNED_INT(uint32_t, src
));
632 STORE_UNALIGNED_INT(uint64_t, dest
, LOAD_UNALIGNED_INT(uint64_t, src
));
635 inline_memcpy(dest
, src
, len
);
640 * Use the architecture-specific memcpy implementation for constant-sized
641 * inputs, but rely on an inline memcpy for length statically unknown.
642 * The function call to memcpy is just way too expensive for a fast path.
644 #define lib_ring_buffer_do_copy(config, dest, src, len) \
646 size_t __len = (len); \
647 if (__builtin_constant_p(len)) \
648 memcpy(dest, src, __len); \
650 lttng_inline_memcpy(dest, src, __len); \
654 * write len bytes to dest with c
657 void lib_ring_buffer_do_memset(char *dest
, char c
, unsigned long len
)
661 for (i
= 0; i
< len
; i
++)
665 /* arch-agnostic implementation */
667 static inline int lttng_ust_fls(unsigned int x
)
673 if (!(x
& 0xFFFF0000U
)) {
677 if (!(x
& 0xFF000000U
)) {
681 if (!(x
& 0xF0000000U
)) {
685 if (!(x
& 0xC0000000U
)) {
689 if (!(x
& 0x80000000U
)) {
690 /* No need to bit shift on last operation */
696 static inline int get_count_order(unsigned int count
)
700 order
= lttng_ust_fls(count
) - 1;
701 if (count
& (count
- 1))
706 #endif /* _LTTNG_RING_BUFFER_BACKEND_INTERNAL_H */