1 /* SPDX-License-Identifier: (GPL-2.0-only OR LGPL-2.1-only)
3 * ringbuffer/backend_internal.h
5 * Ring buffer backend (internal helpers).
7 * Copyright (C) 2008-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 #ifndef _LIB_RING_BUFFER_BACKEND_INTERNAL_H
11 #define _LIB_RING_BUFFER_BACKEND_INTERNAL_H
13 #include <wrapper/compiler.h>
14 #include <wrapper/inline_memcpy.h>
15 #include <ringbuffer/config.h>
16 #include <ringbuffer/backend_types.h>
17 #include <ringbuffer/frontend_types.h>
18 #include <linux/string.h>
19 #include <linux/uaccess.h>
21 /* Ring buffer backend API presented to the frontend */
23 /* Ring buffer and channel backend create/free */
25 int lib_ring_buffer_backend_create(struct lib_ring_buffer_backend
*bufb
,
26 struct channel_backend
*chan
, int cpu
);
27 void channel_backend_unregister_notifiers(struct channel_backend
*chanb
);
28 void lib_ring_buffer_backend_free(struct lib_ring_buffer_backend
*bufb
);
29 int channel_backend_init(struct channel_backend
*chanb
,
31 const struct lib_ring_buffer_config
*config
,
32 void *priv
, size_t subbuf_size
,
34 void channel_backend_free(struct channel_backend
*chanb
);
36 void lib_ring_buffer_backend_reset(struct lib_ring_buffer_backend
*bufb
);
37 void channel_backend_reset(struct channel_backend
*chanb
);
39 int lib_ring_buffer_backend_init(void);
40 void lib_ring_buffer_backend_exit(void);
42 extern void _lib_ring_buffer_write(struct lib_ring_buffer_backend
*bufb
,
43 size_t offset
, const void *src
, size_t len
,
45 extern void _lib_ring_buffer_memset(struct lib_ring_buffer_backend
*bufb
,
46 size_t offset
, int c
, size_t len
,
48 extern void _lib_ring_buffer_strcpy(struct lib_ring_buffer_backend
*bufb
,
49 size_t offset
, const char *src
, size_t len
,
50 size_t pagecpy
, int pad
);
51 extern void _lib_ring_buffer_copy_from_user_inatomic(struct lib_ring_buffer_backend
*bufb
,
52 size_t offset
, const void *src
,
53 size_t len
, size_t pagecpy
);
54 extern void _lib_ring_buffer_strcpy_from_user_inatomic(struct lib_ring_buffer_backend
*bufb
,
55 size_t offset
, const char __user
*src
, size_t len
,
56 size_t pagecpy
, int pad
);
59 * Subbuffer ID bits for overwrite mode. Need to fit within a single word to be
60 * exchanged atomically.
62 * Top half word, except lowest bit, belongs to "offset", which is used to keep
63 * to count the produced buffers. For overwrite mode, this provides the
64 * consumer with the capacity to read subbuffers in order, handling the
65 * situation where producers would write up to 2^15 buffers (or 2^31 for 64-bit
66 * systems) concurrently with a single execution of get_subbuf (between offset
67 * sampling and subbuffer ID exchange).
70 #define HALF_ULONG_BITS (BITS_PER_LONG >> 1)
72 #define SB_ID_OFFSET_SHIFT (HALF_ULONG_BITS + 1)
73 #define SB_ID_OFFSET_COUNT (1UL << SB_ID_OFFSET_SHIFT)
74 #define SB_ID_OFFSET_MASK (~(SB_ID_OFFSET_COUNT - 1))
76 * Lowest bit of top word half belongs to noref. Used only for overwrite mode.
78 #define SB_ID_NOREF_SHIFT (SB_ID_OFFSET_SHIFT - 1)
79 #define SB_ID_NOREF_COUNT (1UL << SB_ID_NOREF_SHIFT)
80 #define SB_ID_NOREF_MASK SB_ID_NOREF_COUNT
82 * In overwrite mode: lowest half of word is used for index.
83 * Limit of 2^16 subbuffers per buffer on 32-bit, 2^32 on 64-bit.
84 * In producer-consumer mode: whole word used for index.
86 #define SB_ID_INDEX_SHIFT 0
87 #define SB_ID_INDEX_COUNT (1UL << SB_ID_INDEX_SHIFT)
88 #define SB_ID_INDEX_MASK (SB_ID_NOREF_COUNT - 1)
91 * Construct the subbuffer id from offset, index and noref. Use only the index
92 * for producer-consumer mode (offset and noref are only used in overwrite
96 unsigned long subbuffer_id(const struct lib_ring_buffer_config
*config
,
97 unsigned long offset
, unsigned long noref
,
100 if (config
->mode
== RING_BUFFER_OVERWRITE
)
101 return (offset
<< SB_ID_OFFSET_SHIFT
)
102 | (noref
<< SB_ID_NOREF_SHIFT
)
109 * Compare offset with the offset contained within id. Return 1 if the offset
110 * bits are identical, else 0.
113 int subbuffer_id_compare_offset(const struct lib_ring_buffer_config
*config
,
114 unsigned long id
, unsigned long offset
)
116 return (id
& SB_ID_OFFSET_MASK
) == (offset
<< SB_ID_OFFSET_SHIFT
);
120 unsigned long subbuffer_id_get_index(const struct lib_ring_buffer_config
*config
,
123 if (config
->mode
== RING_BUFFER_OVERWRITE
)
124 return id
& SB_ID_INDEX_MASK
;
130 unsigned long subbuffer_id_is_noref(const struct lib_ring_buffer_config
*config
,
133 if (config
->mode
== RING_BUFFER_OVERWRITE
)
134 return !!(id
& SB_ID_NOREF_MASK
);
140 * Only used by reader on subbuffer ID it has exclusive access to. No volatile
144 void subbuffer_id_set_noref(const struct lib_ring_buffer_config
*config
,
147 if (config
->mode
== RING_BUFFER_OVERWRITE
)
148 *id
|= SB_ID_NOREF_MASK
;
152 void subbuffer_id_set_noref_offset(const struct lib_ring_buffer_config
*config
,
153 unsigned long *id
, unsigned long offset
)
157 if (config
->mode
== RING_BUFFER_OVERWRITE
) {
159 tmp
&= ~SB_ID_OFFSET_MASK
;
160 tmp
|= offset
<< SB_ID_OFFSET_SHIFT
;
161 tmp
|= SB_ID_NOREF_MASK
;
162 /* Volatile store, read concurrently by readers. */
163 WRITE_ONCE(*id
, tmp
);
167 /* No volatile access, since already used locally */
169 void subbuffer_id_clear_noref(const struct lib_ring_buffer_config
*config
,
172 if (config
->mode
== RING_BUFFER_OVERWRITE
)
173 *id
&= ~SB_ID_NOREF_MASK
;
177 * For overwrite mode, cap the number of subbuffers per buffer to:
178 * 2^16 on 32-bit architectures
179 * 2^32 on 64-bit architectures
180 * This is required to fit in the index part of the ID. Return 0 on success,
184 int subbuffer_id_check_index(const struct lib_ring_buffer_config
*config
,
185 unsigned long num_subbuf
)
187 if (config
->mode
== RING_BUFFER_OVERWRITE
)
188 return (num_subbuf
> (1UL << HALF_ULONG_BITS
)) ? -EPERM
: 0;
194 void lib_ring_buffer_backend_get_pages(const struct lib_ring_buffer_config
*config
,
195 struct lib_ring_buffer_ctx
*ctx
,
196 struct lib_ring_buffer_backend_pages
**backend_pages
)
198 struct lib_ring_buffer_backend
*bufb
= &ctx
->priv
.buf
->backend
;
199 struct channel_backend
*chanb
= &ctx
->priv
.chan
->backend
;
200 size_t sbidx
, offset
= ctx
->priv
.buf_offset
;
201 unsigned long sb_bindex
, id
;
202 struct lib_ring_buffer_backend_pages
*rpages
;
204 offset
&= chanb
->buf_size
- 1;
205 sbidx
= offset
>> chanb
->subbuf_size_order
;
206 id
= bufb
->buf_wsb
[sbidx
].id
;
207 sb_bindex
= subbuffer_id_get_index(config
, id
);
208 rpages
= bufb
->array
[sb_bindex
];
209 CHAN_WARN_ON(ctx
->priv
.chan
,
210 config
->mode
== RING_BUFFER_OVERWRITE
211 && subbuffer_id_is_noref(config
, id
));
212 *backend_pages
= rpages
;
215 /* Get backend pages from cache. */
217 struct lib_ring_buffer_backend_pages
*
218 lib_ring_buffer_get_backend_pages_from_ctx(const struct lib_ring_buffer_config
*config
,
219 struct lib_ring_buffer_ctx
*ctx
)
221 return ctx
->priv
.backend_pages
;
225 * The ring buffer can count events recorded and overwritten per buffer,
226 * but it is disabled by default due to its performance overhead.
228 #ifdef LTTNG_RING_BUFFER_COUNT_EVENTS
230 void subbuffer_count_record(const struct lib_ring_buffer_config
*config
,
231 struct lib_ring_buffer_backend
*bufb
,
234 unsigned long sb_bindex
;
236 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_wsb
[idx
].id
);
237 v_inc(config
, &bufb
->array
[sb_bindex
]->records_commit
);
241 * Reader has exclusive subbuffer access for record consumption. No need to
242 * perform the decrement atomically.
245 void subbuffer_consume_record(const struct lib_ring_buffer_config
*config
,
246 struct lib_ring_buffer_backend
*bufb
)
248 unsigned long sb_bindex
;
250 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_rsb
.id
);
251 CHAN_WARN_ON(bufb
->chan
,
252 !v_read(config
, &bufb
->array
[sb_bindex
]->records_unread
));
253 /* Non-atomic decrement protected by exclusive subbuffer access */
254 _v_dec(config
, &bufb
->array
[sb_bindex
]->records_unread
);
255 v_inc(config
, &bufb
->records_read
);
257 #else /* LTTNG_RING_BUFFER_COUNT_EVENTS */
259 void subbuffer_count_record(const struct lib_ring_buffer_config
*config
,
260 struct lib_ring_buffer_backend
*bufb
,
265 void subbuffer_consume_record(const struct lib_ring_buffer_config
*config
,
266 struct lib_ring_buffer_backend
*bufb
)
269 #endif /* #else LTTNG_RING_BUFFER_COUNT_EVENTS */
272 unsigned long subbuffer_get_records_count(
273 const struct lib_ring_buffer_config
*config
,
274 struct lib_ring_buffer_backend
*bufb
,
277 unsigned long sb_bindex
;
279 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_wsb
[idx
].id
);
280 return v_read(config
, &bufb
->array
[sb_bindex
]->records_commit
);
284 * Must be executed at subbuffer delivery when the writer has _exclusive_
285 * subbuffer access. See lib_ring_buffer_check_deliver() for details.
286 * lib_ring_buffer_get_records_count() must be called to get the records
287 * count before this function, because it resets the records_commit
291 unsigned long subbuffer_count_records_overrun(
292 const struct lib_ring_buffer_config
*config
,
293 struct lib_ring_buffer_backend
*bufb
,
296 struct lib_ring_buffer_backend_pages
*pages
;
297 unsigned long overruns
, sb_bindex
;
299 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_wsb
[idx
].id
);
300 pages
= bufb
->array
[sb_bindex
];
301 overruns
= v_read(config
, &pages
->records_unread
);
302 v_set(config
, &pages
->records_unread
,
303 v_read(config
, &pages
->records_commit
));
304 v_set(config
, &pages
->records_commit
, 0);
310 void subbuffer_set_data_size(const struct lib_ring_buffer_config
*config
,
311 struct lib_ring_buffer_backend
*bufb
,
313 unsigned long data_size
)
315 struct lib_ring_buffer_backend_pages
*pages
;
316 unsigned long sb_bindex
;
318 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_wsb
[idx
].id
);
319 pages
= bufb
->array
[sb_bindex
];
320 pages
->data_size
= data_size
;
324 unsigned long subbuffer_get_read_data_size(
325 const struct lib_ring_buffer_config
*config
,
326 struct lib_ring_buffer_backend
*bufb
)
328 struct lib_ring_buffer_backend_pages
*pages
;
329 unsigned long sb_bindex
;
331 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_rsb
.id
);
332 pages
= bufb
->array
[sb_bindex
];
333 return pages
->data_size
;
337 unsigned long subbuffer_get_data_size(
338 const struct lib_ring_buffer_config
*config
,
339 struct lib_ring_buffer_backend
*bufb
,
342 struct lib_ring_buffer_backend_pages
*pages
;
343 unsigned long sb_bindex
;
345 sb_bindex
= subbuffer_id_get_index(config
, bufb
->buf_wsb
[idx
].id
);
346 pages
= bufb
->array
[sb_bindex
];
347 return pages
->data_size
;
351 void subbuffer_inc_packet_count(const struct lib_ring_buffer_config
*config
,
352 struct lib_ring_buffer_backend
*bufb
,
355 bufb
->buf_cnt
[idx
].seq_cnt
++;
359 * lib_ring_buffer_clear_noref - Clear the noref subbuffer flag, called by
363 void lib_ring_buffer_clear_noref(const struct lib_ring_buffer_config
*config
,
364 struct lib_ring_buffer_backend
*bufb
,
367 unsigned long id
, new_id
;
369 if (config
->mode
!= RING_BUFFER_OVERWRITE
)
373 * Performing a volatile access to read the sb_pages, because we want to
374 * read a coherent version of the pointer and the associated noref flag.
376 id
= LTTNG_READ_ONCE(bufb
->buf_wsb
[idx
].id
);
378 /* This check is called on the fast path for each record. */
379 if (likely(!subbuffer_id_is_noref(config
, id
))) {
381 * Store after load dependency ordering the writes to
382 * the subbuffer after load and test of the noref flag
383 * matches the memory barrier implied by the cmpxchg()
384 * in update_read_sb_index().
386 return; /* Already writing to this buffer */
389 subbuffer_id_clear_noref(config
, &new_id
);
390 new_id
= cmpxchg(&bufb
->buf_wsb
[idx
].id
, id
, new_id
);
391 if (likely(new_id
== id
))
398 * lib_ring_buffer_set_noref_offset - Set the noref subbuffer flag and offset,
402 void lib_ring_buffer_set_noref_offset(const struct lib_ring_buffer_config
*config
,
403 struct lib_ring_buffer_backend
*bufb
,
404 unsigned long idx
, unsigned long offset
)
406 if (config
->mode
!= RING_BUFFER_OVERWRITE
)
410 * Because ring_buffer_set_noref() is only called by a single thread
411 * (the one which updated the cc_sb value), there are no concurrent
412 * updates to take care of: other writers have not updated cc_sb, so
413 * they cannot set the noref flag, and concurrent readers cannot modify
414 * the pointer because the noref flag is not set yet.
415 * The smp_wmb() in ring_buffer_commit() takes care of ordering writes
416 * to the subbuffer before this set noref operation.
417 * subbuffer_set_noref() uses a volatile store to deal with concurrent
418 * readers of the noref flag.
420 CHAN_WARN_ON(bufb
->chan
,
421 subbuffer_id_is_noref(config
, bufb
->buf_wsb
[idx
].id
));
423 * Memory barrier that ensures counter stores are ordered before set
427 subbuffer_id_set_noref_offset(config
, &bufb
->buf_wsb
[idx
].id
, offset
);
431 * update_read_sb_index - Read-side subbuffer index update.
434 int update_read_sb_index(const struct lib_ring_buffer_config
*config
,
435 struct lib_ring_buffer_backend
*bufb
,
436 struct channel_backend
*chanb
,
437 unsigned long consumed_idx
,
438 unsigned long consumed_count
)
440 unsigned long old_id
, new_id
;
442 if (config
->mode
== RING_BUFFER_OVERWRITE
) {
444 * Exchange the target writer subbuffer with our own unused
445 * subbuffer. No need to use READ_ONCE() here to read the
446 * old_wpage, because the value read will be confirmed by the
447 * following cmpxchg().
449 old_id
= bufb
->buf_wsb
[consumed_idx
].id
;
450 if (unlikely(!subbuffer_id_is_noref(config
, old_id
)))
453 * Make sure the offset count we are expecting matches the one
454 * indicated by the writer.
456 if (unlikely(!subbuffer_id_compare_offset(config
, old_id
,
459 CHAN_WARN_ON(bufb
->chan
,
460 !subbuffer_id_is_noref(config
, bufb
->buf_rsb
.id
));
461 subbuffer_id_set_noref_offset(config
, &bufb
->buf_rsb
.id
,
463 new_id
= cmpxchg(&bufb
->buf_wsb
[consumed_idx
].id
, old_id
,
465 if (unlikely(old_id
!= new_id
))
467 bufb
->buf_rsb
.id
= new_id
;
469 /* No page exchange, use the writer page directly */
470 bufb
->buf_rsb
.id
= bufb
->buf_wsb
[consumed_idx
].id
;
475 static inline __attribute__((always_inline
))
476 void lttng_inline_memcpy(void *dest
, const void *src
,
481 *(uint8_t *) dest
= *(const uint8_t *) src
;
484 *(uint16_t *) dest
= *(const uint16_t *) src
;
487 *(uint32_t *) dest
= *(const uint32_t *) src
;
490 *(uint64_t *) dest
= *(const uint64_t *) src
;
493 inline_memcpy(dest
, src
, len
);
498 * Use the architecture-specific memcpy implementation for constant-sized
499 * inputs, but rely on an inline memcpy for length statically unknown.
500 * The function call to memcpy is just way too expensive for a fast path.
502 #define lib_ring_buffer_do_copy(config, dest, src, len) \
504 size_t __len = (len); \
505 if (__builtin_constant_p(len)) \
506 memcpy(dest, src, __len); \
508 lttng_inline_memcpy(dest, src, __len); \
512 * We use __copy_from_user_inatomic to copy userspace data since we already
513 * did the access_ok for the whole range.
515 * Return 0 if OK, nonzero on error.
518 unsigned long lib_ring_buffer_do_copy_from_user_inatomic(void *dest
,
519 const void __user
*src
,
522 return __copy_from_user_inatomic(dest
, src
, len
);
526 * write len bytes to dest with c
529 void lib_ring_buffer_do_memset(char *dest
, int c
,
534 for (i
= 0; i
< len
; i
++)
538 #endif /* _LIB_RING_BUFFER_BACKEND_INTERNAL_H */