Cleanup: clarify strcpy/strcpy_from_user local variables
[lttng-modules.git] / src / lib / ringbuffer / ring_buffer_backend.c
CommitLineData
b7cdc182 1/* SPDX-License-Identifier: (GPL-2.0-only OR LGPL-2.1-only)
9f36eaed 2 *
f3bc08c5
MD
3 * ring_buffer_backend.c
4 *
886d51a3 5 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
f3bc08c5
MD
6 */
7
f3bc08c5
MD
8#include <linux/stddef.h>
9#include <linux/module.h>
10#include <linux/string.h>
11#include <linux/bitops.h>
12#include <linux/delay.h>
13#include <linux/errno.h>
14#include <linux/slab.h>
15#include <linux/cpu.h>
16#include <linux/mm.h>
df388b78 17#include <linux/vmalloc.h>
f3bc08c5 18
7502f47a 19#include <wrapper/mm.h>
263b6c88 20#include <wrapper/vmalloc.h> /* for wrapper_vmalloc_sync_mappings() */
24591303
MD
21#include <ringbuffer/config.h>
22#include <ringbuffer/backend.h>
23#include <ringbuffer/frontend.h>
f3bc08c5
MD
24
25/**
26 * lib_ring_buffer_backend_allocate - allocate a channel buffer
27 * @config: ring buffer instance configuration
28 * @buf: the buffer struct
29 * @size: total size of the buffer
30 * @num_subbuf: number of subbuffers
31 * @extra_reader_sb: need extra subbuffer for reader
32 */
33static
e20c0fec
MD
34int lib_ring_buffer_backend_allocate(const struct lttng_kernel_ring_buffer_config *config,
35 struct lttng_kernel_ring_buffer_backend *bufb,
f3bc08c5
MD
36 size_t size, size_t num_subbuf,
37 int extra_reader_sb)
38{
39 struct channel_backend *chanb = &bufb->chan->backend;
40 unsigned long j, num_pages, num_pages_per_subbuf, page_idx = 0;
41 unsigned long subbuf_size, mmap_offset = 0;
42 unsigned long num_subbuf_alloc;
43 struct page **pages;
f3bc08c5
MD
44 unsigned long i;
45
46 num_pages = size >> PAGE_SHIFT;
1f0ab1eb
FD
47
48 /*
7502f47a
FD
49 * Verify that there is enough free pages available on the system for
50 * the current allocation request.
51 * wrapper_check_enough_free_pages uses si_mem_available() if available
52 * and returns if there should be enough free pages based on the
53 * current estimate.
1f0ab1eb 54 */
7502f47a 55 if (!wrapper_check_enough_free_pages(num_pages))
1f0ab1eb
FD
56 goto not_enough_pages;
57
58 /*
59 * Set the current user thread as the first target of the OOM killer.
60 * If the estimate received by si_mem_available() was off, and we do
61 * end up running out of memory because of this buffer allocation, we
62 * want to kill the offending app first.
63 */
7502f47a 64 wrapper_set_current_oom_origin();
1f0ab1eb 65
f3bc08c5
MD
66 num_pages_per_subbuf = num_pages >> get_count_order(num_subbuf);
67 subbuf_size = chanb->subbuf_size;
68 num_subbuf_alloc = num_subbuf;
69
70 if (extra_reader_sb) {
71 num_pages += num_pages_per_subbuf; /* Add pages for reader */
72 num_subbuf_alloc++;
73 }
74
df388b78 75 pages = vmalloc_node(ALIGN(sizeof(*pages) * num_pages,
f3bc08c5 76 1 << INTERNODE_CACHE_SHIFT),
df388b78 77 cpu_to_node(max(bufb->cpu, 0)));
f3bc08c5
MD
78 if (unlikely(!pages))
79 goto pages_error;
80
48f5e0b5 81 bufb->array = lttng_kvmalloc_node(ALIGN(sizeof(*bufb->array)
f3bc08c5
MD
82 * num_subbuf_alloc,
83 1 << INTERNODE_CACHE_SHIFT),
df388b78
MD
84 GFP_KERNEL | __GFP_NOWARN,
85 cpu_to_node(max(bufb->cpu, 0)));
f3bc08c5
MD
86 if (unlikely(!bufb->array))
87 goto array_error;
88
89 for (i = 0; i < num_pages; i++) {
90 pages[i] = alloc_pages_node(cpu_to_node(max(bufb->cpu, 0)),
df388b78 91 GFP_KERNEL | __GFP_NOWARN | __GFP_ZERO, 0);
f3bc08c5
MD
92 if (unlikely(!pages[i]))
93 goto depopulate;
f3bc08c5
MD
94 }
95 bufb->num_pages_per_subbuf = num_pages_per_subbuf;
96
97 /* Allocate backend pages array elements */
98 for (i = 0; i < num_subbuf_alloc; i++) {
99 bufb->array[i] =
48f5e0b5 100 lttng_kvzalloc_node(ALIGN(
e20c0fec
MD
101 sizeof(struct lttng_kernel_ring_buffer_backend_pages) +
102 sizeof(struct lttng_kernel_ring_buffer_backend_page)
f3bc08c5
MD
103 * num_pages_per_subbuf,
104 1 << INTERNODE_CACHE_SHIFT),
df388b78
MD
105 GFP_KERNEL | __GFP_NOWARN,
106 cpu_to_node(max(bufb->cpu, 0)));
f3bc08c5
MD
107 if (!bufb->array[i])
108 goto free_array;
109 }
110
111 /* Allocate write-side subbuffer table */
48f5e0b5 112 bufb->buf_wsb = lttng_kvzalloc_node(ALIGN(
e20c0fec 113 sizeof(struct lttng_kernel_ring_buffer_backend_subbuffer)
f3bc08c5
MD
114 * num_subbuf,
115 1 << INTERNODE_CACHE_SHIFT),
df388b78
MD
116 GFP_KERNEL | __GFP_NOWARN,
117 cpu_to_node(max(bufb->cpu, 0)));
f3bc08c5
MD
118 if (unlikely(!bufb->buf_wsb))
119 goto free_array;
120
121 for (i = 0; i < num_subbuf; i++)
122 bufb->buf_wsb[i].id = subbuffer_id(config, 0, 1, i);
123
124 /* Assign read-side subbuffer table */
125 if (extra_reader_sb)
126 bufb->buf_rsb.id = subbuffer_id(config, 0, 1,
127 num_subbuf_alloc - 1);
128 else
129 bufb->buf_rsb.id = subbuffer_id(config, 0, 1, 0);
130
5b3cf4f9 131 /* Allocate subbuffer packet counter table */
48f5e0b5 132 bufb->buf_cnt = lttng_kvzalloc_node(ALIGN(
e20c0fec 133 sizeof(struct lttng_kernel_ring_buffer_backend_counts)
5b3cf4f9
JD
134 * num_subbuf,
135 1 << INTERNODE_CACHE_SHIFT),
df388b78
MD
136 GFP_KERNEL | __GFP_NOWARN,
137 cpu_to_node(max(bufb->cpu, 0)));
5b3cf4f9
JD
138 if (unlikely(!bufb->buf_cnt))
139 goto free_wsb;
140
f3bc08c5
MD
141 /* Assign pages to page index */
142 for (i = 0; i < num_subbuf_alloc; i++) {
143 for (j = 0; j < num_pages_per_subbuf; j++) {
144 CHAN_WARN_ON(chanb, page_idx > num_pages);
0112cb7b
MD
145 bufb->array[i]->p[j].virt = page_address(pages[page_idx]);
146 bufb->array[i]->p[j].pfn = page_to_pfn(pages[page_idx]);
f3bc08c5
MD
147 page_idx++;
148 }
149 if (config->output == RING_BUFFER_MMAP) {
150 bufb->array[i]->mmap_offset = mmap_offset;
151 mmap_offset += subbuf_size;
152 }
153 }
154
155 /*
156 * If kmalloc ever uses vmalloc underneath, make sure the buffer pages
157 * will not fault.
158 */
263b6c88 159 wrapper_vmalloc_sync_mappings();
7502f47a 160 wrapper_clear_current_oom_origin();
df388b78 161 vfree(pages);
f3bc08c5
MD
162 return 0;
163
5b3cf4f9 164free_wsb:
48f5e0b5 165 lttng_kvfree(bufb->buf_wsb);
f3bc08c5
MD
166free_array:
167 for (i = 0; (i < num_subbuf_alloc && bufb->array[i]); i++)
48f5e0b5 168 lttng_kvfree(bufb->array[i]);
f3bc08c5
MD
169depopulate:
170 /* Free all allocated pages */
171 for (i = 0; (i < num_pages && pages[i]); i++)
172 __free_page(pages[i]);
48f5e0b5 173 lttng_kvfree(bufb->array);
f3bc08c5 174array_error:
df388b78 175 vfree(pages);
f3bc08c5 176pages_error:
7502f47a 177 wrapper_clear_current_oom_origin();
1f0ab1eb 178not_enough_pages:
f3bc08c5
MD
179 return -ENOMEM;
180}
181
e20c0fec 182int lib_ring_buffer_backend_create(struct lttng_kernel_ring_buffer_backend *bufb,
f3bc08c5
MD
183 struct channel_backend *chanb, int cpu)
184{
e20c0fec 185 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5 186
860c213b 187 bufb->chan = container_of(chanb, struct lttng_kernel_ring_buffer_channel, backend);
f3bc08c5
MD
188 bufb->cpu = cpu;
189
190 return lib_ring_buffer_backend_allocate(config, bufb, chanb->buf_size,
191 chanb->num_subbuf,
192 chanb->extra_reader_sb);
193}
194
e20c0fec 195void lib_ring_buffer_backend_free(struct lttng_kernel_ring_buffer_backend *bufb)
f3bc08c5
MD
196{
197 struct channel_backend *chanb = &bufb->chan->backend;
198 unsigned long i, j, num_subbuf_alloc;
199
200 num_subbuf_alloc = chanb->num_subbuf;
201 if (chanb->extra_reader_sb)
202 num_subbuf_alloc++;
203
48f5e0b5
MJ
204 lttng_kvfree(bufb->buf_wsb);
205 lttng_kvfree(bufb->buf_cnt);
f3bc08c5
MD
206 for (i = 0; i < num_subbuf_alloc; i++) {
207 for (j = 0; j < bufb->num_pages_per_subbuf; j++)
0112cb7b 208 __free_page(pfn_to_page(bufb->array[i]->p[j].pfn));
48f5e0b5 209 lttng_kvfree(bufb->array[i]);
f3bc08c5 210 }
48f5e0b5 211 lttng_kvfree(bufb->array);
f3bc08c5
MD
212 bufb->allocated = 0;
213}
214
e20c0fec 215void lib_ring_buffer_backend_reset(struct lttng_kernel_ring_buffer_backend *bufb)
f3bc08c5
MD
216{
217 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 218 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
219 unsigned long num_subbuf_alloc;
220 unsigned int i;
221
222 num_subbuf_alloc = chanb->num_subbuf;
223 if (chanb->extra_reader_sb)
224 num_subbuf_alloc++;
225
226 for (i = 0; i < chanb->num_subbuf; i++)
227 bufb->buf_wsb[i].id = subbuffer_id(config, 0, 1, i);
228 if (chanb->extra_reader_sb)
229 bufb->buf_rsb.id = subbuffer_id(config, 0, 1,
230 num_subbuf_alloc - 1);
231 else
232 bufb->buf_rsb.id = subbuffer_id(config, 0, 1, 0);
233
234 for (i = 0; i < num_subbuf_alloc; i++) {
235 /* Don't reset mmap_offset */
236 v_set(config, &bufb->array[i]->records_commit, 0);
237 v_set(config, &bufb->array[i]->records_unread, 0);
238 bufb->array[i]->data_size = 0;
239 /* Don't reset backend page and virt addresses */
240 }
241 /* Don't reset num_pages_per_subbuf, cpu, allocated */
242 v_set(config, &bufb->records_read, 0);
243}
244
245/*
246 * The frontend is responsible for also calling ring_buffer_backend_reset for
247 * each buffer when calling channel_backend_reset.
248 */
249void channel_backend_reset(struct channel_backend *chanb)
250{
860c213b 251 struct lttng_kernel_ring_buffer_channel *chan = container_of(chanb, struct lttng_kernel_ring_buffer_channel, backend);
e20c0fec 252 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
253
254 /*
255 * Don't reset buf_size, subbuf_size, subbuf_size_order,
256 * num_subbuf_order, buf_size_order, extra_reader_sb, num_subbuf,
257 * priv, notifiers, config, cpumask and name.
258 */
259 chanb->start_tsc = config->cb.ring_buffer_clock_read(chan);
260}
261
5f4c791e 262#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
1e367326
MD
263
264/*
265 * No need to implement a "dead" callback to do a buffer switch here,
266 * because it will happen when tracing is stopped, or will be done by
267 * switch timer CPU DEAD callback.
268 * We don't free buffers when CPU go away, because it would make trace
269 * data vanish, which is unwanted.
270 */
271int lttng_cpuhp_rb_backend_prepare(unsigned int cpu,
272 struct lttng_cpuhp_node *node)
273{
274 struct channel_backend *chanb = container_of(node,
275 struct channel_backend, cpuhp_prepare);
e20c0fec
MD
276 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
277 struct lttng_kernel_ring_buffer *buf;
1e367326
MD
278 int ret;
279
280 CHAN_WARN_ON(chanb, config->alloc == RING_BUFFER_ALLOC_GLOBAL);
281
282 buf = per_cpu_ptr(chanb->buf, cpu);
283 ret = lib_ring_buffer_create(buf, chanb, cpu);
284 if (ret) {
285 printk(KERN_ERR
5a15f70c 286 "LTTng: ring_buffer_cpu_hp_callback: cpu %d "
1e367326
MD
287 "buffer creation failed\n", cpu);
288 return ret;
289 }
290 return 0;
291}
292EXPORT_SYMBOL_GPL(lttng_cpuhp_rb_backend_prepare);
293
5f4c791e 294#else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
1e367326 295
f3bc08c5 296#ifdef CONFIG_HOTPLUG_CPU
1e367326 297
f3bc08c5
MD
298/**
299 * lib_ring_buffer_cpu_hp_callback - CPU hotplug callback
300 * @nb: notifier block
301 * @action: hotplug action to take
302 * @hcpu: CPU number
303 *
304 * Returns the success/failure of the operation. (%NOTIFY_OK, %NOTIFY_BAD)
305 */
306static
e8f071d5 307int lib_ring_buffer_cpu_hp_callback(struct notifier_block *nb,
f3bc08c5
MD
308 unsigned long action,
309 void *hcpu)
310{
311 unsigned int cpu = (unsigned long)hcpu;
312 struct channel_backend *chanb = container_of(nb, struct channel_backend,
313 cpu_hp_notifier);
e20c0fec
MD
314 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
315 struct lttng_kernel_ring_buffer *buf;
f3bc08c5
MD
316 int ret;
317
318 CHAN_WARN_ON(chanb, config->alloc == RING_BUFFER_ALLOC_GLOBAL);
319
320 switch (action) {
321 case CPU_UP_PREPARE:
322 case CPU_UP_PREPARE_FROZEN:
323 buf = per_cpu_ptr(chanb->buf, cpu);
324 ret = lib_ring_buffer_create(buf, chanb, cpu);
325 if (ret) {
326 printk(KERN_ERR
5a15f70c 327 "LTTng: ring_buffer_cpu_hp_callback: cpu %d "
f3bc08c5
MD
328 "buffer creation failed\n", cpu);
329 return NOTIFY_BAD;
330 }
331 break;
332 case CPU_DEAD:
333 case CPU_DEAD_FROZEN:
334 /* No need to do a buffer switch here, because it will happen
335 * when tracing is stopped, or will be done by switch timer CPU
336 * DEAD callback. */
337 break;
338 }
339 return NOTIFY_OK;
340}
1e367326 341
f3bc08c5
MD
342#endif
343
5f4c791e 344#endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
1e367326 345
f3bc08c5
MD
346/**
347 * channel_backend_init - initialize a channel backend
348 * @chanb: channel backend
349 * @name: channel name
350 * @config: client ring buffer configuration
351 * @priv: client private data
352 * @parent: dentry of parent directory, %NULL for root directory
353 * @subbuf_size: size of sub-buffers (> PAGE_SIZE, power of 2)
354 * @num_subbuf: number of sub-buffers (power of 2)
355 *
356 * Returns channel pointer if successful, %NULL otherwise.
357 *
358 * Creates per-cpu channel buffers using the sizes and attributes
359 * specified. The created channel buffer files will be named
360 * name_0...name_N-1. File permissions will be %S_IRUSR.
361 *
362 * Called with CPU hotplug disabled.
363 */
364int channel_backend_init(struct channel_backend *chanb,
365 const char *name,
e20c0fec 366 const struct lttng_kernel_ring_buffer_config *config,
f3bc08c5
MD
367 void *priv, size_t subbuf_size, size_t num_subbuf)
368{
860c213b 369 struct lttng_kernel_ring_buffer_channel *chan = container_of(chanb, struct lttng_kernel_ring_buffer_channel, backend);
f3bc08c5
MD
370 unsigned int i;
371 int ret;
372
373 if (!name)
374 return -EPERM;
375
f3bc08c5 376 /* Check that the subbuffer size is larger than a page. */
2fb46300
MD
377 if (subbuf_size < PAGE_SIZE)
378 return -EINVAL;
f3bc08c5
MD
379
380 /*
bbda3a00
MD
381 * Make sure the number of subbuffers and subbuffer size are
382 * power of 2 and nonzero.
f3bc08c5 383 */
bbda3a00 384 if (!subbuf_size || (subbuf_size & (subbuf_size - 1)))
863497fa 385 return -EINVAL;
bbda3a00 386 if (!num_subbuf || (num_subbuf & (num_subbuf - 1)))
863497fa 387 return -EINVAL;
5140d2b3
MD
388 /*
389 * Overwrite mode buffers require at least 2 subbuffers per
390 * buffer.
391 */
392 if (config->mode == RING_BUFFER_OVERWRITE && num_subbuf < 2)
393 return -EINVAL;
f3bc08c5
MD
394
395 ret = subbuffer_id_check_index(config, num_subbuf);
396 if (ret)
397 return ret;
398
399 chanb->priv = priv;
400 chanb->buf_size = num_subbuf * subbuf_size;
401 chanb->subbuf_size = subbuf_size;
402 chanb->buf_size_order = get_count_order(chanb->buf_size);
403 chanb->subbuf_size_order = get_count_order(subbuf_size);
404 chanb->num_subbuf_order = get_count_order(num_subbuf);
405 chanb->extra_reader_sb =
406 (config->mode == RING_BUFFER_OVERWRITE) ? 1 : 0;
407 chanb->num_subbuf = num_subbuf;
408 strlcpy(chanb->name, name, NAME_MAX);
5a8fd222 409 memcpy(&chanb->config, config, sizeof(chanb->config));
f3bc08c5
MD
410
411 if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) {
412 if (!zalloc_cpumask_var(&chanb->cpumask, GFP_KERNEL))
413 return -ENOMEM;
414 }
415
416 if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) {
417 /* Allocating the buffer per-cpu structures */
e20c0fec 418 chanb->buf = alloc_percpu(struct lttng_kernel_ring_buffer);
f3bc08c5
MD
419 if (!chanb->buf)
420 goto free_cpumask;
421
5f4c791e 422#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
1e367326
MD
423 chanb->cpuhp_prepare.component = LTTNG_RING_BUFFER_BACKEND;
424 ret = cpuhp_state_add_instance(lttng_rb_hp_prepare,
425 &chanb->cpuhp_prepare.node);
426 if (ret)
427 goto free_bufs;
5f4c791e 428#else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
1e367326
MD
429
430 {
431 /*
432 * In case of non-hotplug cpu, if the ring-buffer is allocated
433 * in early initcall, it will not be notified of secondary cpus.
434 * In that off case, we need to allocate for all possible cpus.
435 */
f3bc08c5 436#ifdef CONFIG_HOTPLUG_CPU
1e367326
MD
437 /*
438 * buf->backend.allocated test takes care of concurrent CPU
439 * hotplug.
440 * Priority higher than frontend, so we create the ring buffer
441 * before we start the timer.
442 */
443 chanb->cpu_hp_notifier.notifier_call =
444 lib_ring_buffer_cpu_hp_callback;
445 chanb->cpu_hp_notifier.priority = 5;
446 register_hotcpu_notifier(&chanb->cpu_hp_notifier);
447
448 get_online_cpus();
449 for_each_online_cpu(i) {
450 ret = lib_ring_buffer_create(per_cpu_ptr(chanb->buf, i),
451 chanb, i);
452 if (ret)
453 goto free_bufs; /* cpu hotplug locked */
454 }
455 put_online_cpus();
f3bc08c5 456#else
1e367326
MD
457 for_each_possible_cpu(i) {
458 ret = lib_ring_buffer_create(per_cpu_ptr(chanb->buf, i),
459 chanb, i);
460 if (ret)
461 goto free_bufs;
462 }
f3bc08c5 463#endif
1e367326 464 }
5f4c791e 465#endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
f3bc08c5 466 } else {
e20c0fec 467 chanb->buf = kzalloc(sizeof(struct lttng_kernel_ring_buffer), GFP_KERNEL);
f3bc08c5
MD
468 if (!chanb->buf)
469 goto free_cpumask;
470 ret = lib_ring_buffer_create(chanb->buf, chanb, -1);
471 if (ret)
472 goto free_bufs;
473 }
474 chanb->start_tsc = config->cb.ring_buffer_clock_read(chan);
475
476 return 0;
477
478free_bufs:
479 if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) {
5f4c791e 480#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
5f14d8ae
MD
481 /*
482 * Teardown of lttng_rb_hp_prepare instance
483 * on "add" error is handled within cpu hotplug,
484 * no teardown to do from the caller.
485 */
5f4c791e 486#else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
1e367326
MD
487#ifdef CONFIG_HOTPLUG_CPU
488 put_online_cpus();
489 unregister_hotcpu_notifier(&chanb->cpu_hp_notifier);
490#endif
5f4c791e 491#endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
f3bc08c5 492 for_each_possible_cpu(i) {
e20c0fec 493 struct lttng_kernel_ring_buffer *buf =
1e367326 494 per_cpu_ptr(chanb->buf, i);
f3bc08c5
MD
495
496 if (!buf->backend.allocated)
497 continue;
498 lib_ring_buffer_free(buf);
499 }
f3bc08c5
MD
500 free_percpu(chanb->buf);
501 } else
502 kfree(chanb->buf);
503free_cpumask:
504 if (config->alloc == RING_BUFFER_ALLOC_PER_CPU)
505 free_cpumask_var(chanb->cpumask);
506 return -ENOMEM;
507}
508
509/**
510 * channel_backend_unregister_notifiers - unregister notifiers
511 * @chan: the channel
512 *
513 * Holds CPU hotplug.
514 */
515void channel_backend_unregister_notifiers(struct channel_backend *chanb)
516{
e20c0fec 517 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5 518
1e367326 519 if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) {
5f4c791e 520#if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0))
1e367326
MD
521 int ret;
522
523 ret = cpuhp_state_remove_instance(lttng_rb_hp_prepare,
524 &chanb->cpuhp_prepare.node);
525 WARN_ON(ret);
5f4c791e 526#else /* #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
f3bc08c5 527 unregister_hotcpu_notifier(&chanb->cpu_hp_notifier);
5f4c791e 528#endif /* #else #if (LTTNG_LINUX_VERSION_CODE >= LTTNG_KERNEL_VERSION(4,10,0)) */
1e367326 529 }
f3bc08c5
MD
530}
531
532/**
533 * channel_backend_free - destroy the channel
534 * @chan: the channel
535 *
536 * Destroy all channel buffers and frees the channel.
537 */
538void channel_backend_free(struct channel_backend *chanb)
539{
e20c0fec 540 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
541 unsigned int i;
542
543 if (config->alloc == RING_BUFFER_ALLOC_PER_CPU) {
544 for_each_possible_cpu(i) {
e20c0fec 545 struct lttng_kernel_ring_buffer *buf = per_cpu_ptr(chanb->buf, i);
f3bc08c5
MD
546
547 if (!buf->backend.allocated)
548 continue;
549 lib_ring_buffer_free(buf);
550 }
551 free_cpumask_var(chanb->cpumask);
552 free_percpu(chanb->buf);
553 } else {
e20c0fec 554 struct lttng_kernel_ring_buffer *buf = chanb->buf;
f3bc08c5
MD
555
556 CHAN_WARN_ON(chanb, !buf->backend.allocated);
557 lib_ring_buffer_free(buf);
558 kfree(buf);
559 }
560}
561
562/**
563 * lib_ring_buffer_write - write data to a ring_buffer buffer.
564 * @bufb : buffer backend
565 * @offset : offset within the buffer
566 * @src : source address
567 * @len : length to write
568 * @pagecpy : page size copied so far
569 */
e20c0fec 570void _lib_ring_buffer_write(struct lttng_kernel_ring_buffer_backend *bufb, size_t offset,
bfe529f9 571 const void *src, size_t len, size_t pagecpy)
f3bc08c5
MD
572{
573 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 574 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5 575 size_t sbidx, index;
e20c0fec 576 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5
MD
577 unsigned long sb_bindex, id;
578
579 do {
580 len -= pagecpy;
581 src += pagecpy;
582 offset += pagecpy;
583 sbidx = offset >> chanb->subbuf_size_order;
584 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
585
586 /*
587 * Underlying layer should never ask for writes across
588 * subbuffers.
589 */
590 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
591
592 pagecpy = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
593 id = bufb->buf_wsb[sbidx].id;
594 sb_bindex = subbuffer_id_get_index(config, id);
595 rpages = bufb->array[sb_bindex];
596 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
597 && subbuffer_id_is_noref(config, id));
598 lib_ring_buffer_do_copy(config,
599 rpages->p[index].virt
600 + (offset & ~PAGE_MASK),
601 src, pagecpy);
602 } while (unlikely(len != pagecpy));
603}
604EXPORT_SYMBOL_GPL(_lib_ring_buffer_write);
605
4ea00e4f
JD
606
607/**
608 * lib_ring_buffer_memset - write len bytes of c to a ring_buffer buffer.
609 * @bufb : buffer backend
610 * @offset : offset within the buffer
611 * @c : the byte to write
612 * @len : length to write
613 * @pagecpy : page size copied so far
614 */
e20c0fec 615void _lib_ring_buffer_memset(struct lttng_kernel_ring_buffer_backend *bufb,
4ea00e4f 616 size_t offset,
bfe529f9 617 int c, size_t len, size_t pagecpy)
4ea00e4f
JD
618{
619 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 620 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
4ea00e4f 621 size_t sbidx, index;
e20c0fec 622 struct lttng_kernel_ring_buffer_backend_pages *rpages;
4ea00e4f
JD
623 unsigned long sb_bindex, id;
624
625 do {
626 len -= pagecpy;
627 offset += pagecpy;
628 sbidx = offset >> chanb->subbuf_size_order;
629 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
630
631 /*
632 * Underlying layer should never ask for writes across
633 * subbuffers.
634 */
635 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
636
637 pagecpy = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
638 id = bufb->buf_wsb[sbidx].id;
639 sb_bindex = subbuffer_id_get_index(config, id);
640 rpages = bufb->array[sb_bindex];
641 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
642 && subbuffer_id_is_noref(config, id));
643 lib_ring_buffer_do_memset(rpages->p[index].virt
644 + (offset & ~PAGE_MASK),
645 c, pagecpy);
646 } while (unlikely(len != pagecpy));
647}
648EXPORT_SYMBOL_GPL(_lib_ring_buffer_memset);
649
16f78f3a
MD
650/**
651 * lib_ring_buffer_strcpy - write string data to a ring_buffer buffer.
652 * @bufb : buffer backend
653 * @offset : offset within the buffer
654 * @src : source address
655 * @len : length to write
16f78f3a
MD
656 * @pad : character to use for padding
657 */
e20c0fec 658void _lib_ring_buffer_strcpy(struct lttng_kernel_ring_buffer_backend *bufb,
e5f1eb9a 659 size_t offset, const char *src, size_t len, int pad)
16f78f3a
MD
660{
661 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 662 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
e5f1eb9a 663 size_t sbidx, index, bytes_left_in_page;
e20c0fec 664 struct lttng_kernel_ring_buffer_backend_pages *rpages;
16f78f3a 665 unsigned long sb_bindex, id;
e5f1eb9a 666 bool src_terminated = false;
16f78f3a
MD
667
668 CHAN_WARN_ON(chanb, !len);
16f78f3a 669 do {
16f78f3a
MD
670 sbidx = offset >> chanb->subbuf_size_order;
671 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
672
673 /*
674 * Underlying layer should never ask for writes across
675 * subbuffers.
676 */
677 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
678
e5f1eb9a 679 bytes_left_in_page = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
16f78f3a
MD
680 id = bufb->buf_wsb[sbidx].id;
681 sb_bindex = subbuffer_id_get_index(config, id);
682 rpages = bufb->array[sb_bindex];
683 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
684 && subbuffer_id_is_noref(config, id));
685
686 if (likely(!src_terminated)) {
687 size_t count, to_copy;
688
e5f1eb9a
MD
689 to_copy = bytes_left_in_page;
690 if (bytes_left_in_page == len)
16f78f3a
MD
691 to_copy--; /* Final '\0' */
692 count = lib_ring_buffer_do_strcpy(config,
693 rpages->p[index].virt
694 + (offset & ~PAGE_MASK),
695 src, to_copy);
696 offset += count;
697 /* Padding */
698 if (unlikely(count < to_copy)) {
699 size_t pad_len = to_copy - count;
700
701 /* Next pages will have padding */
e5f1eb9a 702 src_terminated = true;
16f78f3a
MD
703 lib_ring_buffer_do_memset(rpages->p[index].virt
704 + (offset & ~PAGE_MASK),
705 pad, pad_len);
706 offset += pad_len;
707 }
708 } else {
709 size_t pad_len;
710
e5f1eb9a
MD
711 pad_len = bytes_left_in_page;
712 if (bytes_left_in_page == len)
16f78f3a
MD
713 pad_len--; /* Final '\0' */
714 lib_ring_buffer_do_memset(rpages->p[index].virt
715 + (offset & ~PAGE_MASK),
716 pad, pad_len);
717 offset += pad_len;
718 }
e5f1eb9a
MD
719 len -= bytes_left_in_page;
720 if (!src_terminated)
721 src += bytes_left_in_page;
722 } while (unlikely(len));
723
16f78f3a
MD
724 /* Ending '\0' */
725 lib_ring_buffer_do_memset(rpages->p[index].virt + (offset & ~PAGE_MASK),
726 '\0', 1);
727}
728EXPORT_SYMBOL_GPL(_lib_ring_buffer_strcpy);
4ea00e4f 729
0d1080f4
MD
730/**
731 * _lib_ring_buffer_pstrcpy - write to a buffer backend P-string
732 * @bufb : buffer backend
733 * @src : source pointer to copy from
734 * @len : length of data to copy
735 * @pad : character to use for padding
736 *
737 * This function copies up to @len bytes of data from a source pointer
738 * to a Pascal String into the buffer backend. If a terminating '\0'
739 * character is found in @src before @len characters are copied, pad the
740 * buffer with @pad characters (e.g. '\0').
741 *
742 * The length of the pascal strings in the ring buffer is explicit: it
743 * is either the array or sequence length.
744 */
745void _lib_ring_buffer_pstrcpy(struct lttng_kernel_ring_buffer_backend *bufb,
746 size_t offset, const char *src, size_t len, int pad)
747{
748 struct channel_backend *chanb = &bufb->chan->backend;
749 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
750 size_t sbidx, index, bytes_left_in_page;
751 struct lttng_kernel_ring_buffer_backend_pages *rpages;
752 unsigned long sb_bindex, id;
753 bool src_terminated = false;
754
755 CHAN_WARN_ON(chanb, !len);
756 do {
757 sbidx = offset >> chanb->subbuf_size_order;
758 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
759
760 /*
761 * Underlying layer should never ask for writes across
762 * subbuffers.
763 */
764 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
765
766 bytes_left_in_page = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
767 id = bufb->buf_wsb[sbidx].id;
768 sb_bindex = subbuffer_id_get_index(config, id);
769 rpages = bufb->array[sb_bindex];
770 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
771 && subbuffer_id_is_noref(config, id));
772
773 if (likely(!src_terminated)) {
774 size_t count, to_copy;
775
776 to_copy = bytes_left_in_page;
777 count = lib_ring_buffer_do_strcpy(config,
778 rpages->p[index].virt
779 + (offset & ~PAGE_MASK),
780 src, to_copy);
781 offset += count;
782 /* Padding */
783 if (unlikely(count < to_copy)) {
784 size_t pad_len = to_copy - count;
785
786 /* Next pages will have padding */
787 src_terminated = true;
788 lib_ring_buffer_do_memset(rpages->p[index].virt
789 + (offset & ~PAGE_MASK),
790 pad, pad_len);
791 offset += pad_len;
792 }
793 } else {
794 size_t pad_len;
795
796 pad_len = bytes_left_in_page;
797 lib_ring_buffer_do_memset(rpages->p[index].virt
798 + (offset & ~PAGE_MASK),
799 pad, pad_len);
800 offset += pad_len;
801 }
802 len -= bytes_left_in_page;
803 if (!src_terminated)
804 src += bytes_left_in_page;
805 } while (unlikely(len));
806}
807EXPORT_SYMBOL_GPL(_lib_ring_buffer_pstrcpy);
808
4ea00e4f 809/**
7b8ea3a5 810 * lib_ring_buffer_copy_from_user_inatomic - write user data to a ring_buffer buffer.
4ea00e4f
JD
811 * @bufb : buffer backend
812 * @offset : offset within the buffer
813 * @src : source address
814 * @len : length to write
815 * @pagecpy : page size copied so far
816 *
817 * This function deals with userspace pointers, it should never be called
818 * directly without having the src pointer checked with access_ok()
819 * previously.
820 */
e20c0fec 821void _lib_ring_buffer_copy_from_user_inatomic(struct lttng_kernel_ring_buffer_backend *bufb,
4ea00e4f
JD
822 size_t offset,
823 const void __user *src, size_t len,
bfe529f9 824 size_t pagecpy)
4ea00e4f
JD
825{
826 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 827 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
4ea00e4f 828 size_t sbidx, index;
e20c0fec 829 struct lttng_kernel_ring_buffer_backend_pages *rpages;
4ea00e4f
JD
830 unsigned long sb_bindex, id;
831 int ret;
832
833 do {
834 len -= pagecpy;
835 src += pagecpy;
836 offset += pagecpy;
837 sbidx = offset >> chanb->subbuf_size_order;
838 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
839
840 /*
841 * Underlying layer should never ask for writes across
842 * subbuffers.
843 */
844 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
845
846 pagecpy = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
847 id = bufb->buf_wsb[sbidx].id;
848 sb_bindex = subbuffer_id_get_index(config, id);
849 rpages = bufb->array[sb_bindex];
850 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
851 && subbuffer_id_is_noref(config, id));
7b8ea3a5 852 ret = lib_ring_buffer_do_copy_from_user_inatomic(rpages->p[index].virt
4ea00e4f
JD
853 + (offset & ~PAGE_MASK),
854 src, pagecpy) != 0;
855 if (ret > 0) {
d87a9f03 856 /* Copy failed. */
4ea00e4f
JD
857 _lib_ring_buffer_memset(bufb, offset, 0, len, 0);
858 break; /* stop copy */
859 }
860 } while (unlikely(len != pagecpy));
861}
7b8ea3a5 862EXPORT_SYMBOL_GPL(_lib_ring_buffer_copy_from_user_inatomic);
4ea00e4f 863
16f78f3a
MD
864/**
865 * lib_ring_buffer_strcpy_from_user_inatomic - write userspace string data to a ring_buffer buffer.
866 * @bufb : buffer backend
867 * @offset : offset within the buffer
868 * @src : source address
869 * @len : length to write
16f78f3a
MD
870 * @pad : character to use for padding
871 *
872 * This function deals with userspace pointers, it should never be called
873 * directly without having the src pointer checked with access_ok()
874 * previously.
875 */
e20c0fec 876void _lib_ring_buffer_strcpy_from_user_inatomic(struct lttng_kernel_ring_buffer_backend *bufb,
e5f1eb9a 877 size_t offset, const char __user *src, size_t len, int pad)
16f78f3a
MD
878{
879 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 880 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
e5f1eb9a 881 size_t sbidx, index, bytes_left_in_page;
e20c0fec 882 struct lttng_kernel_ring_buffer_backend_pages *rpages;
16f78f3a 883 unsigned long sb_bindex, id;
e5f1eb9a 884 bool src_terminated = false;
16f78f3a 885
16f78f3a 886 do {
16f78f3a
MD
887 sbidx = offset >> chanb->subbuf_size_order;
888 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
889
890 /*
891 * Underlying layer should never ask for writes across
892 * subbuffers.
893 */
894 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
895
e5f1eb9a 896 bytes_left_in_page = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
16f78f3a
MD
897 id = bufb->buf_wsb[sbidx].id;
898 sb_bindex = subbuffer_id_get_index(config, id);
899 rpages = bufb->array[sb_bindex];
900 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
901 && subbuffer_id_is_noref(config, id));
902
903 if (likely(!src_terminated)) {
904 size_t count, to_copy;
905
e5f1eb9a
MD
906 to_copy = bytes_left_in_page;
907 if (bytes_left_in_page == len)
16f78f3a
MD
908 to_copy--; /* Final '\0' */
909 count = lib_ring_buffer_do_strcpy_from_user_inatomic(config,
910 rpages->p[index].virt
911 + (offset & ~PAGE_MASK),
912 src, to_copy);
913 offset += count;
914 /* Padding */
915 if (unlikely(count < to_copy)) {
916 size_t pad_len = to_copy - count;
917
918 /* Next pages will have padding */
e5f1eb9a 919 src_terminated = true;
16f78f3a
MD
920 lib_ring_buffer_do_memset(rpages->p[index].virt
921 + (offset & ~PAGE_MASK),
922 pad, pad_len);
923 offset += pad_len;
924 }
925 } else {
926 size_t pad_len;
927
e5f1eb9a
MD
928 pad_len = bytes_left_in_page;
929 if (bytes_left_in_page == len)
16f78f3a
MD
930 pad_len--; /* Final '\0' */
931 lib_ring_buffer_do_memset(rpages->p[index].virt
932 + (offset & ~PAGE_MASK),
933 pad, pad_len);
934 offset += pad_len;
935 }
e5f1eb9a
MD
936 len -= bytes_left_in_page;
937 if (!src_terminated)
938 src += bytes_left_in_page;
939 } while (unlikely(len));
940
16f78f3a
MD
941 /* Ending '\0' */
942 lib_ring_buffer_do_memset(rpages->p[index].virt + (offset & ~PAGE_MASK),
943 '\0', 1);
944}
945EXPORT_SYMBOL_GPL(_lib_ring_buffer_strcpy_from_user_inatomic);
946
0d1080f4
MD
947/**
948 * _lib_ring_buffer_pstrcpy_from_user_inatomic - write userspace string to a buffer backend P-string
949 * @bufb : buffer backend
950 * @src : source pointer to copy from
951 * @len : length of data to copy
952 * @pad : character to use for padding
953 *
954 * This function copies up to @len bytes of data from a source pointer
955 * to a Pascal String into the buffer backend. If a terminating '\0'
956 * character is found in @src before @len characters are copied, pad the
957 * buffer with @pad characters (e.g. '\0').
958 *
959 * The length of the pascal strings in the ring buffer is explicit: it
960 * is either the array or sequence length.
961 *
962 * This function deals with userspace pointers, it should never be called
963 * directly without having the src pointer checked with access_ok()
964 * previously.
965 */
966void _lib_ring_buffer_pstrcpy_from_user_inatomic(struct lttng_kernel_ring_buffer_backend *bufb,
967 size_t offset, const char __user *src, size_t len, int pad)
968{
969 struct channel_backend *chanb = &bufb->chan->backend;
970 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
971 size_t sbidx, index, bytes_left_in_page;
972 struct lttng_kernel_ring_buffer_backend_pages *rpages;
973 unsigned long sb_bindex, id;
974 bool src_terminated = false;
975
976 CHAN_WARN_ON(chanb, !len);
977 do {
978 sbidx = offset >> chanb->subbuf_size_order;
979 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
980
981 /*
982 * Underlying layer should never ask for writes across
983 * subbuffers.
984 */
985 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
986
987 bytes_left_in_page = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
988 id = bufb->buf_wsb[sbidx].id;
989 sb_bindex = subbuffer_id_get_index(config, id);
990 rpages = bufb->array[sb_bindex];
991 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
992 && subbuffer_id_is_noref(config, id));
993
994 if (likely(!src_terminated)) {
995 size_t count, to_copy;
996
997 to_copy = bytes_left_in_page;
998 count = lib_ring_buffer_do_strcpy_from_user_inatomic(config,
999 rpages->p[index].virt
1000 + (offset & ~PAGE_MASK),
1001 src, to_copy);
1002 offset += count;
1003 /* Padding */
1004 if (unlikely(count < to_copy)) {
1005 size_t pad_len = to_copy - count;
1006
1007 /* Next pages will have padding */
1008 src_terminated = true;
1009 lib_ring_buffer_do_memset(rpages->p[index].virt
1010 + (offset & ~PAGE_MASK),
1011 pad, pad_len);
1012 offset += pad_len;
1013 }
1014 } else {
1015 size_t pad_len;
1016
1017 pad_len = bytes_left_in_page;
1018 lib_ring_buffer_do_memset(rpages->p[index].virt
1019 + (offset & ~PAGE_MASK),
1020 pad, pad_len);
1021 offset += pad_len;
1022 }
1023 len -= bytes_left_in_page;
1024 if (!src_terminated)
1025 src += bytes_left_in_page;
1026 } while (unlikely(len));
1027}
1028EXPORT_SYMBOL_GPL(_lib_ring_buffer_pstrcpy_from_user_inatomic);
1029
f3bc08c5
MD
1030/**
1031 * lib_ring_buffer_read - read data from ring_buffer_buffer.
1032 * @bufb : buffer backend
1033 * @offset : offset within the buffer
1034 * @dest : destination address
1035 * @len : length to copy to destination
1036 *
1037 * Should be protected by get_subbuf/put_subbuf.
1038 * Returns the length copied.
1039 */
e20c0fec 1040size_t lib_ring_buffer_read(struct lttng_kernel_ring_buffer_backend *bufb, size_t offset,
f3bc08c5
MD
1041 void *dest, size_t len)
1042{
1043 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 1044 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
bfe529f9 1045 size_t index, pagecpy, orig_len;
e20c0fec 1046 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5
MD
1047 unsigned long sb_bindex, id;
1048
1049 orig_len = len;
1050 offset &= chanb->buf_size - 1;
1051 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1052 if (unlikely(!len))
1053 return 0;
1054 for (;;) {
1055 pagecpy = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
1056 id = bufb->buf_rsb.id;
1057 sb_bindex = subbuffer_id_get_index(config, id);
1058 rpages = bufb->array[sb_bindex];
1059 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
1060 && subbuffer_id_is_noref(config, id));
1061 memcpy(dest, rpages->p[index].virt + (offset & ~PAGE_MASK),
1062 pagecpy);
1063 len -= pagecpy;
1064 if (likely(!len))
1065 break;
1066 dest += pagecpy;
1067 offset += pagecpy;
1068 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1069 /*
1070 * Underlying layer should never ask for reads across
1071 * subbuffers.
1072 */
1073 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
1074 }
1075 return orig_len;
1076}
1077EXPORT_SYMBOL_GPL(lib_ring_buffer_read);
1078
1079/**
1080 * __lib_ring_buffer_copy_to_user - read data from ring_buffer to userspace
1081 * @bufb : buffer backend
1082 * @offset : offset within the buffer
1083 * @dest : destination userspace address
1084 * @len : length to copy to destination
1085 *
1086 * Should be protected by get_subbuf/put_subbuf.
1087 * access_ok() must have been performed on dest addresses prior to call this
1088 * function.
1089 * Returns -EFAULT on error, 0 if ok.
1090 */
e20c0fec 1091int __lib_ring_buffer_copy_to_user(struct lttng_kernel_ring_buffer_backend *bufb,
f3bc08c5
MD
1092 size_t offset, void __user *dest, size_t len)
1093{
1094 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 1095 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5 1096 size_t index;
88dfd899 1097 ssize_t pagecpy;
e20c0fec 1098 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5
MD
1099 unsigned long sb_bindex, id;
1100
f3bc08c5
MD
1101 offset &= chanb->buf_size - 1;
1102 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1103 if (unlikely(!len))
1104 return 0;
1105 for (;;) {
1106 pagecpy = min_t(size_t, len, PAGE_SIZE - (offset & ~PAGE_MASK));
1107 id = bufb->buf_rsb.id;
1108 sb_bindex = subbuffer_id_get_index(config, id);
1109 rpages = bufb->array[sb_bindex];
1110 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
1111 && subbuffer_id_is_noref(config, id));
1112 if (__copy_to_user(dest,
1113 rpages->p[index].virt + (offset & ~PAGE_MASK),
1114 pagecpy))
1115 return -EFAULT;
1116 len -= pagecpy;
1117 if (likely(!len))
1118 break;
1119 dest += pagecpy;
1120 offset += pagecpy;
1121 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1122 /*
1123 * Underlying layer should never ask for reads across
1124 * subbuffers.
1125 */
1126 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
1127 }
1128 return 0;
1129}
1130EXPORT_SYMBOL_GPL(__lib_ring_buffer_copy_to_user);
1131
1132/**
1133 * lib_ring_buffer_read_cstr - read a C-style string from ring_buffer.
1134 * @bufb : buffer backend
1135 * @offset : offset within the buffer
1136 * @dest : destination address
1137 * @len : destination's length
1138 *
61eb4c39 1139 * Return string's length, or -EINVAL on error.
f3bc08c5 1140 * Should be protected by get_subbuf/put_subbuf.
61eb4c39 1141 * Destination length should be at least 1 to hold '\0'.
f3bc08c5 1142 */
e20c0fec 1143int lib_ring_buffer_read_cstr(struct lttng_kernel_ring_buffer_backend *bufb, size_t offset,
f3bc08c5
MD
1144 void *dest, size_t len)
1145{
1146 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 1147 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
1148 size_t index;
1149 ssize_t pagecpy, pagelen, strpagelen, orig_offset;
1150 char *str;
e20c0fec 1151 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5
MD
1152 unsigned long sb_bindex, id;
1153
1154 offset &= chanb->buf_size - 1;
1155 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1156 orig_offset = offset;
61eb4c39
MD
1157 if (unlikely(!len))
1158 return -EINVAL;
f3bc08c5
MD
1159 for (;;) {
1160 id = bufb->buf_rsb.id;
1161 sb_bindex = subbuffer_id_get_index(config, id);
1162 rpages = bufb->array[sb_bindex];
1163 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
1164 && subbuffer_id_is_noref(config, id));
1165 str = (char *)rpages->p[index].virt + (offset & ~PAGE_MASK);
1166 pagelen = PAGE_SIZE - (offset & ~PAGE_MASK);
1167 strpagelen = strnlen(str, pagelen);
1168 if (len) {
1169 pagecpy = min_t(size_t, len, strpagelen);
1170 if (dest) {
1171 memcpy(dest, str, pagecpy);
1172 dest += pagecpy;
1173 }
1174 len -= pagecpy;
1175 }
1176 offset += strpagelen;
1177 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1178 if (strpagelen < pagelen)
1179 break;
1180 /*
1181 * Underlying layer should never ask for reads across
1182 * subbuffers.
1183 */
1184 CHAN_WARN_ON(chanb, offset >= chanb->buf_size);
1185 }
1186 if (dest && len)
1187 ((char *)dest)[0] = 0;
1188 return offset - orig_offset;
1189}
1190EXPORT_SYMBOL_GPL(lib_ring_buffer_read_cstr);
1191
1192/**
0112cb7b 1193 * lib_ring_buffer_read_get_pfn - Get a page frame number to read from
f3bc08c5
MD
1194 * @bufb : buffer backend
1195 * @offset : offset within the buffer
1196 * @virt : pointer to page address (output)
1197 *
1198 * Should be protected by get_subbuf/put_subbuf.
0112cb7b 1199 * Returns the pointer to the page frame number unsigned long.
f3bc08c5 1200 */
e20c0fec 1201unsigned long *lib_ring_buffer_read_get_pfn(struct lttng_kernel_ring_buffer_backend *bufb,
f3bc08c5
MD
1202 size_t offset, void ***virt)
1203{
1204 size_t index;
e20c0fec 1205 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5 1206 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 1207 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
1208 unsigned long sb_bindex, id;
1209
1210 offset &= chanb->buf_size - 1;
1211 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1212 id = bufb->buf_rsb.id;
1213 sb_bindex = subbuffer_id_get_index(config, id);
1214 rpages = bufb->array[sb_bindex];
1215 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
1216 && subbuffer_id_is_noref(config, id));
1217 *virt = &rpages->p[index].virt;
0112cb7b 1218 return &rpages->p[index].pfn;
f3bc08c5 1219}
0112cb7b 1220EXPORT_SYMBOL_GPL(lib_ring_buffer_read_get_pfn);
f3bc08c5
MD
1221
1222/**
1223 * lib_ring_buffer_read_offset_address - get address of a buffer location
1224 * @bufb : buffer backend
1225 * @offset : offset within the buffer.
1226 *
1227 * Return the address where a given offset is located (for read).
1228 * Should be used to get the current subbuffer header pointer. Given we know
759d02c1
MD
1229 * it's never on a page boundary, it's safe to read/write directly
1230 * from/to this address, as long as the read/write is never bigger than a
1231 * page size.
f3bc08c5 1232 */
e20c0fec 1233void *lib_ring_buffer_read_offset_address(struct lttng_kernel_ring_buffer_backend *bufb,
f3bc08c5
MD
1234 size_t offset)
1235{
1236 size_t index;
e20c0fec 1237 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5 1238 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 1239 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
1240 unsigned long sb_bindex, id;
1241
1242 offset &= chanb->buf_size - 1;
1243 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1244 id = bufb->buf_rsb.id;
1245 sb_bindex = subbuffer_id_get_index(config, id);
1246 rpages = bufb->array[sb_bindex];
1247 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
1248 && subbuffer_id_is_noref(config, id));
1249 return rpages->p[index].virt + (offset & ~PAGE_MASK);
1250}
1251EXPORT_SYMBOL_GPL(lib_ring_buffer_read_offset_address);
1252
1253/**
1254 * lib_ring_buffer_offset_address - get address of a location within the buffer
1255 * @bufb : buffer backend
1256 * @offset : offset within the buffer.
1257 *
1258 * Return the address where a given offset is located.
1259 * Should be used to get the current subbuffer header pointer. Given we know
1260 * it's always at the beginning of a page, it's safe to write directly to this
1261 * address, as long as the write is never bigger than a page size.
1262 */
e20c0fec 1263void *lib_ring_buffer_offset_address(struct lttng_kernel_ring_buffer_backend *bufb,
f3bc08c5
MD
1264 size_t offset)
1265{
1266 size_t sbidx, index;
e20c0fec 1267 struct lttng_kernel_ring_buffer_backend_pages *rpages;
f3bc08c5 1268 struct channel_backend *chanb = &bufb->chan->backend;
e20c0fec 1269 const struct lttng_kernel_ring_buffer_config *config = &chanb->config;
f3bc08c5
MD
1270 unsigned long sb_bindex, id;
1271
1272 offset &= chanb->buf_size - 1;
1273 sbidx = offset >> chanb->subbuf_size_order;
1274 index = (offset & (chanb->subbuf_size - 1)) >> PAGE_SHIFT;
1275 id = bufb->buf_wsb[sbidx].id;
1276 sb_bindex = subbuffer_id_get_index(config, id);
1277 rpages = bufb->array[sb_bindex];
1278 CHAN_WARN_ON(chanb, config->mode == RING_BUFFER_OVERWRITE
1279 && subbuffer_id_is_noref(config, id));
1280 return rpages->p[index].virt + (offset & ~PAGE_MASK);
1281}
1282EXPORT_SYMBOL_GPL(lib_ring_buffer_offset_address);
This page took 0.122766 seconds and 4 git commands to generate.