2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
11 #include <urcu/arch.h>
14 #include <lttng/align.h>
15 #include <lttng/ringbuffer-config.h>
21 #include "ust-compat.h"
24 * lib_ring_buffer_backend_allocate - allocate a channel buffer
25 * @config: ring buffer instance configuration
26 * @buf: the buffer struct
27 * @size: total size of the buffer
28 * @num_subbuf: number of subbuffers
29 * @extra_reader_sb: need extra subbuffer for reader
32 int lib_ring_buffer_backend_allocate(const struct lttng_ust_lib_ring_buffer_config
*config
,
33 struct lttng_ust_lib_ring_buffer_backend
*bufb
,
34 size_t size
, size_t num_subbuf
,
36 struct lttng_ust_shm_handle
*handle
,
37 struct shm_object
*shmobj
)
39 struct channel_backend
*chanb
;
40 unsigned long subbuf_size
, mmap_offset
= 0;
41 unsigned long num_subbuf_alloc
;
45 chanb
= &shmp(handle
, bufb
->chan
)->backend
;
49 subbuf_size
= chanb
->subbuf_size
;
50 num_subbuf_alloc
= num_subbuf
;
55 page_size
= LTTNG_UST_PAGE_SIZE
;
60 align_shm(shmobj
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_pages_shmp
));
61 set_shmp(bufb
->array
, zalloc_shm(shmobj
,
62 sizeof(struct lttng_ust_lib_ring_buffer_backend_pages_shmp
) * num_subbuf_alloc
));
63 if (caa_unlikely(!shmp(handle
, bufb
->array
)))
67 * This is the largest element (the buffer pages) which needs to
68 * be aligned on page size.
70 align_shm(shmobj
, page_size
);
71 set_shmp(bufb
->memory_map
, zalloc_shm(shmobj
,
72 subbuf_size
* num_subbuf_alloc
));
73 if (caa_unlikely(!shmp(handle
, bufb
->memory_map
)))
74 goto memory_map_error
;
76 /* Allocate backend pages array elements */
77 for (i
= 0; i
< num_subbuf_alloc
; i
++) {
78 align_shm(shmobj
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_pages
));
79 set_shmp(shmp_index(handle
, bufb
->array
, i
)->shmp
,
81 sizeof(struct lttng_ust_lib_ring_buffer_backend_pages
)));
82 if (!shmp(handle
, shmp_index(handle
, bufb
->array
, i
)->shmp
))
86 /* Allocate write-side subbuffer table */
87 align_shm(shmobj
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_subbuffer
));
88 set_shmp(bufb
->buf_wsb
, zalloc_shm(shmobj
,
89 sizeof(struct lttng_ust_lib_ring_buffer_backend_subbuffer
)
91 if (caa_unlikely(!shmp(handle
, bufb
->buf_wsb
)))
94 for (i
= 0; i
< num_subbuf
; i
++) {
95 struct lttng_ust_lib_ring_buffer_backend_subbuffer
*sb
;
97 sb
= shmp_index(handle
, bufb
->buf_wsb
, i
);
100 sb
->id
= subbuffer_id(config
, 0, 1, i
);
103 /* Assign read-side subbuffer table */
105 bufb
->buf_rsb
.id
= subbuffer_id(config
, 0, 1,
106 num_subbuf_alloc
- 1);
108 bufb
->buf_rsb
.id
= subbuffer_id(config
, 0, 1, 0);
110 /* Allocate subbuffer packet counter table */
111 align_shm(shmobj
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_counts
));
112 set_shmp(bufb
->buf_cnt
, zalloc_shm(shmobj
,
113 sizeof(struct lttng_ust_lib_ring_buffer_backend_counts
)
115 if (caa_unlikely(!shmp(handle
, bufb
->buf_cnt
)))
118 /* Assign pages to page index */
119 for (i
= 0; i
< num_subbuf_alloc
; i
++) {
120 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*sbp
;
121 struct lttng_ust_lib_ring_buffer_backend_pages
*pages
;
124 ref
.index
= bufb
->memory_map
._ref
.index
;
125 ref
.offset
= bufb
->memory_map
._ref
.offset
;
126 ref
.offset
+= i
* subbuf_size
;
128 sbp
= shmp_index(handle
, bufb
->array
, i
);
131 pages
= shmp(handle
, sbp
->shmp
);
134 set_shmp(pages
->p
, ref
);
135 if (config
->output
== RING_BUFFER_MMAP
) {
136 pages
->mmap_offset
= mmap_offset
;
137 mmap_offset
+= subbuf_size
;
143 /* bufb->buf_wsb will be freed by shm teardown */
145 /* bufb->array[i] will be freed by shm teardown */
147 /* bufb->array will be freed by shm teardown */
153 int lib_ring_buffer_backend_create(struct lttng_ust_lib_ring_buffer_backend
*bufb
,
154 struct channel_backend
*chanb
, int cpu
,
155 struct lttng_ust_shm_handle
*handle
,
156 struct shm_object
*shmobj
)
158 const struct lttng_ust_lib_ring_buffer_config
*config
= &chanb
->config
;
160 set_shmp(bufb
->chan
, handle
->chan
._ref
);
163 return lib_ring_buffer_backend_allocate(config
, bufb
, chanb
->buf_size
,
165 chanb
->extra_reader_sb
,
169 void lib_ring_buffer_backend_reset(struct lttng_ust_lib_ring_buffer_backend
*bufb
,
170 struct lttng_ust_shm_handle
*handle
)
172 struct channel_backend
*chanb
;
173 const struct lttng_ust_lib_ring_buffer_config
*config
;
174 unsigned long num_subbuf_alloc
;
177 chanb
= &shmp(handle
, bufb
->chan
)->backend
;
180 config
= &chanb
->config
;
182 num_subbuf_alloc
= chanb
->num_subbuf
;
183 if (chanb
->extra_reader_sb
)
186 for (i
= 0; i
< chanb
->num_subbuf
; i
++) {
187 struct lttng_ust_lib_ring_buffer_backend_subbuffer
*sb
;
189 sb
= shmp_index(handle
, bufb
->buf_wsb
, i
);
192 sb
->id
= subbuffer_id(config
, 0, 1, i
);
194 if (chanb
->extra_reader_sb
)
195 bufb
->buf_rsb
.id
= subbuffer_id(config
, 0, 1,
196 num_subbuf_alloc
- 1);
198 bufb
->buf_rsb
.id
= subbuffer_id(config
, 0, 1, 0);
200 for (i
= 0; i
< num_subbuf_alloc
; i
++) {
201 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*sbp
;
202 struct lttng_ust_lib_ring_buffer_backend_pages
*pages
;
204 sbp
= shmp_index(handle
, bufb
->array
, i
);
207 pages
= shmp(handle
, sbp
->shmp
);
210 /* Don't reset mmap_offset */
211 v_set(config
, &pages
->records_commit
, 0);
212 v_set(config
, &pages
->records_unread
, 0);
213 pages
->data_size
= 0;
214 /* Don't reset backend page and virt addresses */
216 /* Don't reset num_pages_per_subbuf, cpu, allocated */
217 v_set(config
, &bufb
->records_read
, 0);
221 * The frontend is responsible for also calling ring_buffer_backend_reset for
222 * each buffer when calling channel_backend_reset.
224 void channel_backend_reset(struct channel_backend
*chanb
)
226 struct lttng_ust_lib_ring_buffer_channel
*chan
= caa_container_of(chanb
,
227 struct lttng_ust_lib_ring_buffer_channel
, backend
);
228 const struct lttng_ust_lib_ring_buffer_config
*config
= &chanb
->config
;
231 * Don't reset buf_size, subbuf_size, subbuf_size_order,
232 * num_subbuf_order, buf_size_order, extra_reader_sb, num_subbuf,
233 * priv, notifiers, config, cpumask and name.
235 chanb
->start_tsc
= config
->cb
.ring_buffer_clock_read(chan
);
239 * channel_backend_init - initialize a channel backend
240 * @chanb: channel backend
241 * @name: channel name
242 * @config: client ring buffer configuration
243 * @parent: dentry of parent directory, %NULL for root directory
244 * @subbuf_size: size of sub-buffers (> page size, power of 2)
245 * @num_subbuf: number of sub-buffers (power of 2)
246 * @lttng_ust_shm_handle: shared memory handle
247 * @stream_fds: stream file descriptors.
249 * Returns channel pointer if successful, %NULL otherwise.
251 * Creates per-cpu channel buffers using the sizes and attributes
252 * specified. The created channel buffer files will be named
253 * name_0...name_N-1. File permissions will be %S_IRUSR.
255 * Called with CPU hotplug disabled.
257 int channel_backend_init(struct channel_backend
*chanb
,
259 const struct lttng_ust_lib_ring_buffer_config
*config
,
260 size_t subbuf_size
, size_t num_subbuf
,
261 struct lttng_ust_shm_handle
*handle
,
262 const int *stream_fds
)
264 struct lttng_ust_lib_ring_buffer_channel
*chan
= caa_container_of(chanb
,
265 struct lttng_ust_lib_ring_buffer_channel
, backend
);
268 size_t shmsize
= 0, num_subbuf_alloc
;
274 page_size
= LTTNG_UST_PAGE_SIZE
;
275 if (page_size
<= 0) {
278 /* Check that the subbuffer size is larger than a page. */
279 if (subbuf_size
< page_size
)
283 * Make sure the number of subbuffers and subbuffer size are
284 * power of 2, and nonzero.
286 if (!subbuf_size
|| (subbuf_size
& (subbuf_size
- 1)))
288 if (!num_subbuf
|| (num_subbuf
& (num_subbuf
- 1)))
291 * Overwrite mode buffers require at least 2 subbuffers per
294 if (config
->mode
== RING_BUFFER_OVERWRITE
&& num_subbuf
< 2)
297 ret
= subbuffer_id_check_index(config
, num_subbuf
);
301 chanb
->buf_size
= num_subbuf
* subbuf_size
;
302 chanb
->subbuf_size
= subbuf_size
;
303 chanb
->buf_size_order
= get_count_order(chanb
->buf_size
);
304 chanb
->subbuf_size_order
= get_count_order(subbuf_size
);
305 chanb
->num_subbuf_order
= get_count_order(num_subbuf
);
306 chanb
->extra_reader_sb
=
307 (config
->mode
== RING_BUFFER_OVERWRITE
) ? 1 : 0;
308 chanb
->num_subbuf
= num_subbuf
;
309 strncpy(chanb
->name
, name
, NAME_MAX
);
310 chanb
->name
[NAME_MAX
- 1] = '\0';
311 memcpy(&chanb
->config
, config
, sizeof(*config
));
313 /* Per-cpu buffer size: control (prior to backend) */
314 shmsize
= lttng_ust_offset_align(shmsize
, __alignof__(struct lttng_ust_lib_ring_buffer
));
315 shmsize
+= sizeof(struct lttng_ust_lib_ring_buffer
);
316 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(struct commit_counters_hot
));
317 shmsize
+= sizeof(struct commit_counters_hot
) * num_subbuf
;
318 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(struct commit_counters_cold
));
319 shmsize
+= sizeof(struct commit_counters_cold
) * num_subbuf
;
320 /* Sampled timestamp end */
321 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(uint64_t));
322 shmsize
+= sizeof(uint64_t) * num_subbuf
;
324 /* Per-cpu buffer size: backend */
325 /* num_subbuf + 1 is the worse case */
326 num_subbuf_alloc
= num_subbuf
+ 1;
327 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_pages_shmp
));
328 shmsize
+= sizeof(struct lttng_ust_lib_ring_buffer_backend_pages_shmp
) * num_subbuf_alloc
;
329 shmsize
+= lttng_ust_offset_align(shmsize
, page_size
);
330 shmsize
+= subbuf_size
* num_subbuf_alloc
;
331 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_pages
));
332 shmsize
+= sizeof(struct lttng_ust_lib_ring_buffer_backend_pages
) * num_subbuf_alloc
;
333 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_subbuffer
));
334 shmsize
+= sizeof(struct lttng_ust_lib_ring_buffer_backend_subbuffer
) * num_subbuf
;
335 shmsize
+= lttng_ust_offset_align(shmsize
, __alignof__(struct lttng_ust_lib_ring_buffer_backend_counts
));
336 shmsize
+= sizeof(struct lttng_ust_lib_ring_buffer_backend_counts
) * num_subbuf
;
338 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
) {
339 struct lttng_ust_lib_ring_buffer
*buf
;
341 * We need to allocate for all possible cpus.
343 for_each_possible_cpu(i
) {
344 struct shm_object
*shmobj
;
346 shmobj
= shm_object_table_alloc(handle
->table
, shmsize
,
347 SHM_OBJECT_SHM
, stream_fds
[i
], i
);
350 align_shm(shmobj
, __alignof__(struct lttng_ust_lib_ring_buffer
));
351 set_shmp(chanb
->buf
[i
].shmp
, zalloc_shm(shmobj
, sizeof(struct lttng_ust_lib_ring_buffer
)));
352 buf
= shmp(handle
, chanb
->buf
[i
].shmp
);
355 set_shmp(buf
->self
, chanb
->buf
[i
].shmp
._ref
);
356 ret
= lib_ring_buffer_create(buf
, chanb
, i
,
359 goto free_bufs
; /* cpu hotplug locked */
362 struct shm_object
*shmobj
;
363 struct lttng_ust_lib_ring_buffer
*buf
;
365 shmobj
= shm_object_table_alloc(handle
->table
, shmsize
,
366 SHM_OBJECT_SHM
, stream_fds
[0], -1);
369 align_shm(shmobj
, __alignof__(struct lttng_ust_lib_ring_buffer
));
370 set_shmp(chanb
->buf
[0].shmp
, zalloc_shm(shmobj
, sizeof(struct lttng_ust_lib_ring_buffer
)));
371 buf
= shmp(handle
, chanb
->buf
[0].shmp
);
374 set_shmp(buf
->self
, chanb
->buf
[0].shmp
._ref
);
375 ret
= lib_ring_buffer_create(buf
, chanb
, -1,
380 chanb
->start_tsc
= config
->cb
.ring_buffer_clock_read(chan
);
385 /* We only free the buffer data upon shm teardown */
391 * channel_backend_free - destroy the channel
394 * Destroy all channel buffers and frees the channel.
396 void channel_backend_free(struct channel_backend
*chanb
,
397 struct lttng_ust_shm_handle
*handle
)
399 /* SHM teardown takes care of everything */
403 * lib_ring_buffer_read - read data from ring_buffer_buffer.
404 * @bufb : buffer backend
405 * @offset : offset within the buffer
406 * @dest : destination address
407 * @len : length to copy to destination
409 * Should be protected by get_subbuf/put_subbuf.
410 * Returns the length copied.
412 size_t lib_ring_buffer_read(struct lttng_ust_lib_ring_buffer_backend
*bufb
, size_t offset
,
413 void *dest
, size_t len
, struct lttng_ust_shm_handle
*handle
)
415 struct channel_backend
*chanb
;
416 const struct lttng_ust_lib_ring_buffer_config
*config
;
418 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*rpages
;
419 struct lttng_ust_lib_ring_buffer_backend_pages
*backend_pages
;
420 unsigned long sb_bindex
, id
;
423 chanb
= &shmp(handle
, bufb
->chan
)->backend
;
426 config
= &chanb
->config
;
428 offset
&= chanb
->buf_size
- 1;
430 if (caa_unlikely(!len
))
432 id
= bufb
->buf_rsb
.id
;
433 sb_bindex
= subbuffer_id_get_index(config
, id
);
434 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
438 * Underlying layer should never ask for reads across
441 CHAN_WARN_ON(chanb
, offset
>= chanb
->buf_size
);
442 CHAN_WARN_ON(chanb
, config
->mode
== RING_BUFFER_OVERWRITE
443 && subbuffer_id_is_noref(config
, id
));
444 backend_pages
= shmp(handle
, rpages
->shmp
);
447 src
= shmp_index(handle
, backend_pages
->p
, offset
& (chanb
->subbuf_size
- 1));
448 if (caa_unlikely(!src
))
450 memcpy(dest
, src
, len
);
455 * lib_ring_buffer_read_cstr - read a C-style string from ring_buffer.
456 * @bufb : buffer backend
457 * @offset : offset within the buffer
458 * @dest : destination address
459 * @len : destination's length
461 * Return string's length, or -EINVAL on error.
462 * Should be protected by get_subbuf/put_subbuf.
463 * Destination length should be at least 1 to hold '\0'.
465 int lib_ring_buffer_read_cstr(struct lttng_ust_lib_ring_buffer_backend
*bufb
, size_t offset
,
466 void *dest
, size_t len
, struct lttng_ust_shm_handle
*handle
)
468 struct channel_backend
*chanb
;
469 const struct lttng_ust_lib_ring_buffer_config
*config
;
470 ssize_t string_len
, orig_offset
;
472 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*rpages
;
473 struct lttng_ust_lib_ring_buffer_backend_pages
*backend_pages
;
474 unsigned long sb_bindex
, id
;
476 chanb
= &shmp(handle
, bufb
->chan
)->backend
;
479 config
= &chanb
->config
;
480 if (caa_unlikely(!len
))
482 offset
&= chanb
->buf_size
- 1;
483 orig_offset
= offset
;
484 id
= bufb
->buf_rsb
.id
;
485 sb_bindex
= subbuffer_id_get_index(config
, id
);
486 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
490 * Underlying layer should never ask for reads across
493 CHAN_WARN_ON(chanb
, offset
>= chanb
->buf_size
);
494 CHAN_WARN_ON(chanb
, config
->mode
== RING_BUFFER_OVERWRITE
495 && subbuffer_id_is_noref(config
, id
));
496 backend_pages
= shmp(handle
, rpages
->shmp
);
499 str
= shmp_index(handle
, backend_pages
->p
, offset
& (chanb
->subbuf_size
- 1));
500 if (caa_unlikely(!str
))
502 string_len
= strnlen(str
, len
);
504 memcpy(dest
, str
, string_len
);
505 ((char *)dest
)[0] = 0;
507 return offset
- orig_offset
;
511 * lib_ring_buffer_read_offset_address - get address of a buffer location
512 * @bufb : buffer backend
513 * @offset : offset within the buffer.
515 * Return the address where a given offset is located (for read).
516 * Should be used to get the current subbuffer header pointer. Given we know
517 * it's never on a page boundary, it's safe to read/write directly
518 * from/to this address, as long as the read/write is never bigger than
521 void *lib_ring_buffer_read_offset_address(struct lttng_ust_lib_ring_buffer_backend
*bufb
,
523 struct lttng_ust_shm_handle
*handle
)
525 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*rpages
;
526 struct lttng_ust_lib_ring_buffer_backend_pages
*backend_pages
;
527 struct channel_backend
*chanb
;
528 const struct lttng_ust_lib_ring_buffer_config
*config
;
529 unsigned long sb_bindex
, id
;
531 chanb
= &shmp(handle
, bufb
->chan
)->backend
;
534 config
= &chanb
->config
;
535 offset
&= chanb
->buf_size
- 1;
536 id
= bufb
->buf_rsb
.id
;
537 sb_bindex
= subbuffer_id_get_index(config
, id
);
538 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
541 CHAN_WARN_ON(chanb
, config
->mode
== RING_BUFFER_OVERWRITE
542 && subbuffer_id_is_noref(config
, id
));
543 backend_pages
= shmp(handle
, rpages
->shmp
);
546 return shmp_index(handle
, backend_pages
->p
, offset
& (chanb
->subbuf_size
- 1));
550 * lib_ring_buffer_offset_address - get address of a location within the buffer
551 * @bufb : buffer backend
552 * @offset : offset within the buffer.
554 * Return the address where a given offset is located.
555 * Should be used to get the current subbuffer header pointer. Given we know
556 * it's always at the beginning of a page, it's safe to write directly to this
557 * address, as long as the write is never bigger than a page size.
559 void *lib_ring_buffer_offset_address(struct lttng_ust_lib_ring_buffer_backend
*bufb
,
561 struct lttng_ust_shm_handle
*handle
)
564 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*rpages
;
565 struct lttng_ust_lib_ring_buffer_backend_pages
*backend_pages
;
566 struct channel_backend
*chanb
;
567 const struct lttng_ust_lib_ring_buffer_config
*config
;
568 unsigned long sb_bindex
, id
;
569 struct lttng_ust_lib_ring_buffer_backend_subbuffer
*sb
;
571 chanb
= &shmp(handle
, bufb
->chan
)->backend
;
574 config
= &chanb
->config
;
575 offset
&= chanb
->buf_size
- 1;
576 sbidx
= offset
>> chanb
->subbuf_size_order
;
577 sb
= shmp_index(handle
, bufb
->buf_wsb
, sbidx
);
581 sb_bindex
= subbuffer_id_get_index(config
, id
);
582 rpages
= shmp_index(handle
, bufb
->array
, sb_bindex
);
585 CHAN_WARN_ON(chanb
, config
->mode
== RING_BUFFER_OVERWRITE
586 && subbuffer_id_is_noref(config
, id
));
587 backend_pages
= shmp(handle
, rpages
->shmp
);
590 return shmp_index(handle
, backend_pages
->p
, offset
& (chanb
->subbuf_size
- 1));