]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - kernel/events/ring_buffer.c
net: macb: fix macb_get/set_wol() when moving to phylink
[mirror_ubuntu-jammy-kernel.git] / kernel / events / ring_buffer.c
CommitLineData
8e86e015 1// SPDX-License-Identifier: GPL-2.0
76369139
FW
2/*
3 * Performance events ring-buffer code:
4 *
5 * Copyright (C) 2008 Thomas Gleixner <tglx@linutronix.de>
6 * Copyright (C) 2008-2011 Red Hat, Inc., Ingo Molnar
90eec103 7 * Copyright (C) 2008-2011 Red Hat, Inc., Peter Zijlstra
d36b6910 8 * Copyright © 2009 Paul Mackerras, IBM Corp. <paulus@au1.ibm.com>
76369139
FW
9 */
10
11#include <linux/perf_event.h>
12#include <linux/vmalloc.h>
13#include <linux/slab.h>
26c86da8 14#include <linux/circ_buf.h>
7c60fc0e 15#include <linux/poll.h>
4411ec1d 16#include <linux/nospec.h>
76369139
FW
17
18#include "internal.h"
19
76369139
FW
20static void perf_output_wakeup(struct perf_output_handle *handle)
21{
a9a08845 22 atomic_set(&handle->rb->poll, EPOLLIN);
76369139 23
a8b0ca17
PZ
24 handle->event->pending_wakeup = 1;
25 irq_work_queue(&handle->event->pending);
76369139
FW
26}
27
28/*
29 * We need to ensure a later event_id doesn't publish a head when a former
30 * event isn't done writing. However since we need to deal with NMIs we
31 * cannot fully serialize things.
32 *
33 * We only publish the head (and generate a wakeup) when the outer-most
34 * event completes.
35 */
36static void perf_output_get_handle(struct perf_output_handle *handle)
37{
56de4e8f 38 struct perf_buffer *rb = handle->rb;
76369139
FW
39
40 preempt_disable();
5322ea58
PZ
41
42 /*
43 * Avoid an explicit LOAD/STORE such that architectures with memops
44 * can use them.
45 */
46 (*(volatile unsigned int *)&rb->nest)++;
76369139
FW
47 handle->wakeup = local_read(&rb->wakeup);
48}
49
50static void perf_output_put_handle(struct perf_output_handle *handle)
51{
56de4e8f 52 struct perf_buffer *rb = handle->rb;
76369139 53 unsigned long head;
5322ea58
PZ
54 unsigned int nest;
55
56 /*
57 * If this isn't the outermost nesting, we don't have to update
58 * @rb->user_page->data_head.
59 */
60 nest = READ_ONCE(rb->nest);
61 if (nest > 1) {
62 WRITE_ONCE(rb->nest, nest - 1);
63 goto out;
64 }
76369139
FW
65
66again:
3f9fbe9b
PZ
67 /*
68 * In order to avoid publishing a head value that goes backwards,
69 * we must ensure the load of @rb->head happens after we've
70 * incremented @rb->nest.
71 *
72 * Otherwise we can observe a @rb->head value before one published
73 * by an IRQ/NMI happening between the load and the increment.
74 */
75 barrier();
76369139
FW
76 head = local_read(&rb->head);
77
78 /*
1b038c6e
YC
79 * IRQ/NMI can happen here and advance @rb->head, causing our
80 * load above to be stale.
76369139
FW
81 */
82
76369139 83 /*
bf378d34
PZ
84 * Since the mmap() consumer (userspace) can run on a different CPU:
85 *
86 * kernel user
87 *
c7f2e3cd
PZ
88 * if (LOAD ->data_tail) { LOAD ->data_head
89 * (A) smp_rmb() (C)
90 * STORE $data LOAD $data
91 * smp_wmb() (B) smp_mb() (D)
92 * STORE ->data_head STORE ->data_tail
93 * }
bf378d34
PZ
94 *
95 * Where A pairs with D, and B pairs with C.
96 *
c7f2e3cd
PZ
97 * In our case (A) is a control dependency that separates the load of
98 * the ->data_tail and the stores of $data. In case ->data_tail
99 * indicates there is no room in the buffer to store $data we do not.
bf378d34 100 *
c7f2e3cd 101 * D needs to be a full barrier since it separates the data READ
bf378d34
PZ
102 * from the tail WRITE.
103 *
104 * For B a WMB is sufficient since it separates two WRITEs, and for C
105 * an RMB is sufficient since it separates two READs.
106 *
107 * See perf_output_begin().
76369139 108 */
c7f2e3cd 109 smp_wmb(); /* B, matches C */
4d839dd9 110 WRITE_ONCE(rb->user_page->data_head, head);
76369139
FW
111
112 /*
1b038c6e
YC
113 * We must publish the head before decrementing the nest count,
114 * otherwise an IRQ/NMI can publish a more recent head value and our
115 * write will (temporarily) publish a stale value.
116 */
117 barrier();
5322ea58 118 WRITE_ONCE(rb->nest, 0);
1b038c6e
YC
119
120 /*
121 * Ensure we decrement @rb->nest before we validate the @rb->head.
122 * Otherwise we cannot be sure we caught the 'last' nested update.
76369139 123 */
1b038c6e 124 barrier();
76369139 125 if (unlikely(head != local_read(&rb->head))) {
5322ea58 126 WRITE_ONCE(rb->nest, 1);
76369139
FW
127 goto again;
128 }
129
130 if (handle->wakeup != local_read(&rb->wakeup))
131 perf_output_wakeup(handle);
132
133out:
134 preempt_enable();
135}
136
57d6a793 137static __always_inline bool
d1b26c70
WN
138ring_buffer_has_space(unsigned long head, unsigned long tail,
139 unsigned long data_size, unsigned int size,
140 bool backward)
141{
142 if (!backward)
143 return CIRC_SPACE(head, tail, data_size) >= size;
144 else
145 return CIRC_SPACE(tail, head, data_size) >= size;
146}
147
57d6a793 148static __always_inline int
d1b26c70
WN
149__perf_output_begin(struct perf_output_handle *handle,
150 struct perf_event *event, unsigned int size,
151 bool backward)
76369139 152{
56de4e8f 153 struct perf_buffer *rb;
76369139 154 unsigned long tail, offset, head;
524feca5 155 int have_lost, page_shift;
76369139
FW
156 struct {
157 struct perf_event_header header;
158 u64 id;
159 u64 lost;
160 } lost_event;
161
162 rcu_read_lock();
163 /*
164 * For inherited events we send all the output towards the parent.
165 */
166 if (event->parent)
167 event = event->parent;
168
169 rb = rcu_dereference(event->rb);
c72b42a3 170 if (unlikely(!rb))
76369139
FW
171 goto out;
172
86e7972f
WN
173 if (unlikely(rb->paused)) {
174 if (rb->nr_pages)
175 local_inc(&rb->lost);
76369139 176 goto out;
86e7972f 177 }
76369139 178
c72b42a3
PZ
179 handle->rb = rb;
180 handle->event = event;
181
76369139 182 have_lost = local_read(&rb->lost);
c72b42a3 183 if (unlikely(have_lost)) {
d20a973f
PZ
184 size += sizeof(lost_event);
185 if (event->attr.sample_id_all)
186 size += event->id_header_size;
76369139
FW
187 }
188
189 perf_output_get_handle(handle);
190
191 do {
105ff3cb 192 tail = READ_ONCE(rb->user_page->data_tail);
76369139 193 offset = head = local_read(&rb->head);
d1b26c70
WN
194 if (!rb->overwrite) {
195 if (unlikely(!ring_buffer_has_space(head, tail,
196 perf_data_size(rb),
197 size, backward)))
198 goto fail;
199 }
c7f2e3cd
PZ
200
201 /*
202 * The above forms a control dependency barrier separating the
203 * @tail load above from the data stores below. Since the @tail
204 * load is required to compute the branch to fail below.
205 *
206 * A, matches D; the full memory barrier userspace SHOULD issue
207 * after reading the data and before storing the new tail
208 * position.
209 *
210 * See perf_output_put_handle().
211 */
212
d1b26c70
WN
213 if (!backward)
214 head += size;
215 else
216 head -= size;
76369139
FW
217 } while (local_cmpxchg(&rb->head, offset, head) != offset);
218
d1b26c70
WN
219 if (backward) {
220 offset = head;
221 head = (u64)(-head);
222 }
223
85f59edf 224 /*
c7f2e3cd
PZ
225 * We rely on the implied barrier() by local_cmpxchg() to ensure
226 * none of the data stores below can be lifted up by the compiler.
85f59edf 227 */
85f59edf 228
c72b42a3 229 if (unlikely(head - local_read(&rb->wakeup) > rb->watermark))
76369139
FW
230 local_add(rb->watermark, &rb->wakeup);
231
524feca5
PZ
232 page_shift = PAGE_SHIFT + page_order(rb);
233
234 handle->page = (offset >> page_shift) & (rb->nr_pages - 1);
235 offset &= (1UL << page_shift) - 1;
236 handle->addr = rb->data_pages[handle->page] + offset;
237 handle->size = (1UL << page_shift) - offset;
76369139 238
c72b42a3 239 if (unlikely(have_lost)) {
d20a973f
PZ
240 struct perf_sample_data sample_data;
241
242 lost_event.header.size = sizeof(lost_event);
76369139
FW
243 lost_event.header.type = PERF_RECORD_LOST;
244 lost_event.header.misc = 0;
245 lost_event.id = event->id;
246 lost_event.lost = local_xchg(&rb->lost, 0);
247
d20a973f
PZ
248 perf_event_header__init_id(&lost_event.header,
249 &sample_data, event);
76369139
FW
250 perf_output_put(handle, lost_event);
251 perf_event__output_id_sample(event, handle, &sample_data);
252 }
253
254 return 0;
255
256fail:
257 local_inc(&rb->lost);
258 perf_output_put_handle(handle);
259out:
260 rcu_read_unlock();
261
262 return -ENOSPC;
263}
264
9ecda41a
WN
265int perf_output_begin_forward(struct perf_output_handle *handle,
266 struct perf_event *event, unsigned int size)
267{
268 return __perf_output_begin(handle, event, size, false);
269}
270
271int perf_output_begin_backward(struct perf_output_handle *handle,
272 struct perf_event *event, unsigned int size)
273{
274 return __perf_output_begin(handle, event, size, true);
275}
276
d1b26c70
WN
277int perf_output_begin(struct perf_output_handle *handle,
278 struct perf_event *event, unsigned int size)
279{
9ecda41a
WN
280
281 return __perf_output_begin(handle, event, size,
282 unlikely(is_write_backward(event)));
d1b26c70
WN
283}
284
91d7753a 285unsigned int perf_output_copy(struct perf_output_handle *handle,
76369139
FW
286 const void *buf, unsigned int len)
287{
91d7753a 288 return __output_copy(handle, buf, len);
76369139
FW
289}
290
5685e0ff
JO
291unsigned int perf_output_skip(struct perf_output_handle *handle,
292 unsigned int len)
293{
294 return __output_skip(handle, NULL, len);
295}
296
76369139
FW
297void perf_output_end(struct perf_output_handle *handle)
298{
76369139
FW
299 perf_output_put_handle(handle);
300 rcu_read_unlock();
301}
302
303static void
56de4e8f 304ring_buffer_init(struct perf_buffer *rb, long watermark, int flags)
76369139
FW
305{
306 long max_size = perf_data_size(rb);
307
308 if (watermark)
309 rb->watermark = min(max_size, watermark);
310
311 if (!rb->watermark)
312 rb->watermark = max_size / 2;
313
314 if (flags & RING_BUFFER_WRITABLE)
dd9c086d
SE
315 rb->overwrite = 0;
316 else
317 rb->overwrite = 1;
76369139 318
fecb8ed2 319 refcount_set(&rb->refcount, 1);
10c6db11
PZ
320
321 INIT_LIST_HEAD(&rb->event_list);
322 spin_lock_init(&rb->event_lock);
86e7972f
WN
323
324 /*
325 * perf_output_begin() only checks rb->paused, therefore
326 * rb->paused must be true if we have no pages for output.
327 */
328 if (!rb->nr_pages)
329 rb->paused = 1;
76369139
FW
330}
331
f4c0b0aa
WD
332void perf_aux_output_flag(struct perf_output_handle *handle, u64 flags)
333{
334 /*
335 * OVERWRITE is determined by perf_aux_output_end() and can't
336 * be passed in directly.
337 */
338 if (WARN_ON_ONCE(flags & PERF_AUX_FLAG_OVERWRITE))
339 return;
340
341 handle->aux_flags |= flags;
342}
343EXPORT_SYMBOL_GPL(perf_aux_output_flag);
344
fdc26706
AS
345/*
346 * This is called before hardware starts writing to the AUX area to
347 * obtain an output handle and make sure there's room in the buffer.
348 * When the capture completes, call perf_aux_output_end() to commit
349 * the recorded data to the buffer.
350 *
351 * The ordering is similar to that of perf_output_{begin,end}, with
352 * the exception of (B), which should be taken care of by the pmu
353 * driver, since ordering rules will differ depending on hardware.
af5bb4ed
AS
354 *
355 * Call this from pmu::start(); see the comment in perf_aux_output_end()
356 * about its use in pmu callbacks. Both can also be called from the PMI
357 * handler if needed.
fdc26706
AS
358 */
359void *perf_aux_output_begin(struct perf_output_handle *handle,
360 struct perf_event *event)
361{
362 struct perf_event *output_event = event;
363 unsigned long aux_head, aux_tail;
56de4e8f 364 struct perf_buffer *rb;
5322ea58 365 unsigned int nest;
fdc26706
AS
366
367 if (output_event->parent)
368 output_event = output_event->parent;
369
370 /*
371 * Since this will typically be open across pmu::add/pmu::del, we
372 * grab ring_buffer's refcount instead of holding rcu read lock
373 * to make sure it doesn't disappear under us.
374 */
375 rb = ring_buffer_get(output_event);
376 if (!rb)
377 return NULL;
378
b79ccadd 379 if (!rb_has_aux(rb))
fdc26706
AS
380 goto err;
381
dcb10a96 382 /*
b79ccadd
AS
383 * If aux_mmap_count is zero, the aux buffer is in perf_mmap_close(),
384 * about to get freed, so we leave immediately.
385 *
386 * Checking rb::aux_mmap_count and rb::refcount has to be done in
387 * the same order, see perf_mmap_close. Otherwise we end up freeing
388 * aux pages in this path, which is a bug, because in_atomic().
dcb10a96
AS
389 */
390 if (!atomic_read(&rb->aux_mmap_count))
b79ccadd
AS
391 goto err;
392
ca3bb3d0 393 if (!refcount_inc_not_zero(&rb->aux_refcount))
b79ccadd 394 goto err;
dcb10a96 395
5322ea58 396 nest = READ_ONCE(rb->aux_nest);
fdc26706
AS
397 /*
398 * Nesting is not supported for AUX area, make sure nested
399 * writers are caught early
400 */
5322ea58 401 if (WARN_ON_ONCE(nest))
fdc26706
AS
402 goto err_put;
403
5322ea58
PZ
404 WRITE_ONCE(rb->aux_nest, nest + 1);
405
2ab346cf 406 aux_head = rb->aux_head;
fdc26706
AS
407
408 handle->rb = rb;
409 handle->event = event;
410 handle->head = aux_head;
2023a0d2 411 handle->size = 0;
f4c0b0aa 412 handle->aux_flags = 0;
fdc26706
AS
413
414 /*
2023a0d2
AS
415 * In overwrite mode, AUX data stores do not depend on aux_tail,
416 * therefore (A) control dependency barrier does not exist. The
417 * (B) <-> (C) ordering is still observed by the pmu driver.
fdc26706 418 */
2023a0d2 419 if (!rb->aux_overwrite) {
6aa7de05 420 aux_tail = READ_ONCE(rb->user_page->aux_tail);
2ab346cf 421 handle->wakeup = rb->aux_wakeup + rb->aux_watermark;
2023a0d2
AS
422 if (aux_head - aux_tail < perf_aux_size(rb))
423 handle->size = CIRC_SPACE(aux_head, aux_tail, perf_aux_size(rb));
424
425 /*
426 * handle->size computation depends on aux_tail load; this forms a
427 * control dependency barrier separating aux_tail load from aux data
428 * store that will be enabled on successful return
429 */
430 if (!handle->size) { /* A, matches D */
1d54ad94 431 event->pending_disable = smp_processor_id();
2023a0d2 432 perf_output_wakeup(handle);
5322ea58 433 WRITE_ONCE(rb->aux_nest, 0);
2023a0d2
AS
434 goto err_put;
435 }
fdc26706
AS
436 }
437
438 return handle->rb->aux_priv;
439
440err_put:
af5bb4ed 441 /* can't be last */
fdc26706
AS
442 rb_free_aux(rb);
443
444err:
95ff4ca2 445 ring_buffer_put(rb);
fdc26706
AS
446 handle->event = NULL;
447
448 return NULL;
449}
bc1d2020 450EXPORT_SYMBOL_GPL(perf_aux_output_begin);
fdc26706 451
56de4e8f 452static __always_inline bool rb_need_aux_wakeup(struct perf_buffer *rb)
441430eb
AS
453{
454 if (rb->aux_overwrite)
455 return false;
456
457 if (rb->aux_head - rb->aux_wakeup >= rb->aux_watermark) {
458 rb->aux_wakeup = rounddown(rb->aux_head, rb->aux_watermark);
459 return true;
460 }
461
462 return false;
463}
464
fdc26706
AS
465/*
466 * Commit the data written by hardware into the ring buffer by adjusting
467 * aux_head and posting a PERF_RECORD_AUX into the perf buffer. It is the
468 * pmu driver's responsibility to observe ordering rules of the hardware,
469 * so that all the data is externally visible before this is called.
af5bb4ed
AS
470 *
471 * Note: this has to be called from pmu::stop() callback, as the assumption
472 * of the AUX buffer management code is that after pmu::stop(), the AUX
473 * transaction must be stopped and therefore drop the AUX reference count.
fdc26706 474 */
f4c0b0aa 475void perf_aux_output_end(struct perf_output_handle *handle, unsigned long size)
fdc26706 476{
ae0c2d99 477 bool wakeup = !!(handle->aux_flags & PERF_AUX_FLAG_TRUNCATED);
56de4e8f 478 struct perf_buffer *rb = handle->rb;
2023a0d2 479 unsigned long aux_head;
fdc26706 480
2023a0d2
AS
481 /* in overwrite mode, driver provides aux_head via handle */
482 if (rb->aux_overwrite) {
f4c0b0aa 483 handle->aux_flags |= PERF_AUX_FLAG_OVERWRITE;
2023a0d2
AS
484
485 aux_head = handle->head;
2ab346cf 486 rb->aux_head = aux_head;
2023a0d2 487 } else {
f4c0b0aa
WD
488 handle->aux_flags &= ~PERF_AUX_FLAG_OVERWRITE;
489
2ab346cf
WD
490 aux_head = rb->aux_head;
491 rb->aux_head += size;
2023a0d2 492 }
fdc26706 493
339bc418
AS
494 /*
495 * Only send RECORD_AUX if we have something useful to communicate
496 *
497 * Note: the OVERWRITE records by themselves are not considered
498 * useful, as they don't communicate any *new* information,
499 * aside from the short-lived offset, that becomes history at
500 * the next event sched-in and therefore isn't useful.
501 * The userspace that needs to copy out AUX data in overwrite
502 * mode should know to use user_page::aux_head for the actual
503 * offset. So, from now on we don't output AUX records that
504 * have *only* OVERWRITE flag set.
505 */
506 if (size || (handle->aux_flags & ~(u64)PERF_AUX_FLAG_OVERWRITE))
507 perf_event_aux_event(handle->event, aux_head, size,
508 handle->aux_flags);
fdc26706 509
4d839dd9 510 WRITE_ONCE(rb->user_page->aux_head, rb->aux_head);
441430eb 511 if (rb_need_aux_wakeup(rb))
3f56e687 512 wakeup = true;
3f56e687
AS
513
514 if (wakeup) {
f4c0b0aa 515 if (handle->aux_flags & PERF_AUX_FLAG_TRUNCATED)
1d54ad94 516 handle->event->pending_disable = smp_processor_id();
3f56e687
AS
517 perf_output_wakeup(handle);
518 }
519
fdc26706
AS
520 handle->event = NULL;
521
5322ea58 522 WRITE_ONCE(rb->aux_nest, 0);
af5bb4ed 523 /* can't be last */
fdc26706 524 rb_free_aux(rb);
95ff4ca2 525 ring_buffer_put(rb);
fdc26706 526}
bc1d2020 527EXPORT_SYMBOL_GPL(perf_aux_output_end);
fdc26706
AS
528
529/*
530 * Skip over a given number of bytes in the AUX buffer, due to, for example,
531 * hardware's alignment constraints.
532 */
533int perf_aux_output_skip(struct perf_output_handle *handle, unsigned long size)
534{
56de4e8f 535 struct perf_buffer *rb = handle->rb;
fdc26706
AS
536
537 if (size > handle->size)
538 return -ENOSPC;
539
2ab346cf 540 rb->aux_head += size;
fdc26706 541
4d839dd9 542 WRITE_ONCE(rb->user_page->aux_head, rb->aux_head);
441430eb 543 if (rb_need_aux_wakeup(rb)) {
1a594131 544 perf_output_wakeup(handle);
2ab346cf 545 handle->wakeup = rb->aux_wakeup + rb->aux_watermark;
1a594131
AS
546 }
547
2ab346cf 548 handle->head = rb->aux_head;
fdc26706
AS
549 handle->size -= size;
550
551 return 0;
552}
bc1d2020 553EXPORT_SYMBOL_GPL(perf_aux_output_skip);
fdc26706
AS
554
555void *perf_get_aux(struct perf_output_handle *handle)
556{
557 /* this is only valid between perf_aux_output_begin and *_end */
558 if (!handle->event)
559 return NULL;
560
561 return handle->rb->aux_priv;
562}
bc1d2020 563EXPORT_SYMBOL_GPL(perf_get_aux);
fdc26706 564
a4faf00d
AS
565/*
566 * Copy out AUX data from an AUX handle.
567 */
568long perf_output_copy_aux(struct perf_output_handle *aux_handle,
569 struct perf_output_handle *handle,
570 unsigned long from, unsigned long to)
571{
56de4e8f 572 struct perf_buffer *rb = aux_handle->rb;
a4faf00d 573 unsigned long tocopy, remainder, len = 0;
a4faf00d
AS
574 void *addr;
575
576 from &= (rb->aux_nr_pages << PAGE_SHIFT) - 1;
577 to &= (rb->aux_nr_pages << PAGE_SHIFT) - 1;
578
579 do {
580 tocopy = PAGE_SIZE - offset_in_page(from);
581 if (to > from)
582 tocopy = min(tocopy, to - from);
583 if (!tocopy)
584 break;
585
586 addr = rb->aux_pages[from >> PAGE_SHIFT];
587 addr += offset_in_page(from);
588
589 remainder = perf_output_copy(handle, addr, tocopy);
590 if (remainder)
591 return -EFAULT;
592
593 len += tocopy;
594 from += tocopy;
595 from &= (rb->aux_nr_pages << PAGE_SHIFT) - 1;
596 } while (to != from);
597
598 return len;
599}
600
0a4e38e6
AS
601#define PERF_AUX_GFP (GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN | __GFP_NORETRY)
602
603static struct page *rb_alloc_aux_page(int node, int order)
604{
605 struct page *page;
606
607 if (order > MAX_ORDER)
608 order = MAX_ORDER;
609
610 do {
611 page = alloc_pages_node(node, PERF_AUX_GFP, order);
612 } while (!page && order--);
613
614 if (page && order) {
615 /*
c2ad6b51
AS
616 * Communicate the allocation size to the driver:
617 * if we managed to secure a high-order allocation,
618 * set its first page's private to this order;
619 * !PagePrivate(page) means it's just a normal page.
0a4e38e6
AS
620 */
621 split_page(page, order);
622 SetPagePrivate(page);
623 set_page_private(page, order);
624 }
625
626 return page;
627}
628
56de4e8f 629static void rb_free_aux_page(struct perf_buffer *rb, int idx)
0a4e38e6
AS
630{
631 struct page *page = virt_to_page(rb->aux_pages[idx]);
632
633 ClearPagePrivate(page);
634 page->mapping = NULL;
635 __free_page(page);
636}
637
56de4e8f 638static void __rb_free_aux(struct perf_buffer *rb)
45c815f0
AS
639{
640 int pg;
641
95ff4ca2
AS
642 /*
643 * Should never happen, the last reference should be dropped from
644 * perf_mmap_close() path, which first stops aux transactions (which
645 * in turn are the atomic holders of aux_refcount) and then does the
646 * last rb_free_aux().
647 */
648 WARN_ON_ONCE(in_atomic());
649
45c815f0
AS
650 if (rb->aux_priv) {
651 rb->free_aux(rb->aux_priv);
652 rb->free_aux = NULL;
653 rb->aux_priv = NULL;
654 }
655
656 if (rb->aux_nr_pages) {
657 for (pg = 0; pg < rb->aux_nr_pages; pg++)
658 rb_free_aux_page(rb, pg);
659
660 kfree(rb->aux_pages);
661 rb->aux_nr_pages = 0;
662 }
663}
664
56de4e8f 665int rb_alloc_aux(struct perf_buffer *rb, struct perf_event *event,
1a594131 666 pgoff_t pgoff, int nr_pages, long watermark, int flags)
45bfb2e5
PZ
667{
668 bool overwrite = !(flags & RING_BUFFER_WRITABLE);
669 int node = (event->cpu == -1) ? -1 : cpu_to_node(event->cpu);
5768402f 670 int ret = -ENOMEM, max_order;
45bfb2e5
PZ
671
672 if (!has_aux(event))
8a1898db 673 return -EOPNOTSUPP;
45bfb2e5 674
5768402f
AS
675 /*
676 * We need to start with the max_order that fits in nr_pages,
677 * not the other way around, hence ilog2() and not get_order.
678 */
679 max_order = ilog2(nr_pages);
0a4e38e6 680
5768402f
AS
681 /*
682 * PMU requests more than one contiguous chunks of memory
683 * for SW double buffering
684 */
26ae4f44 685 if (!overwrite) {
5768402f
AS
686 if (!max_order)
687 return -EINVAL;
6a279230 688
5768402f 689 max_order--;
6a279230
AS
690 }
691
590b5b7d
KC
692 rb->aux_pages = kcalloc_node(nr_pages, sizeof(void *), GFP_KERNEL,
693 node);
45bfb2e5
PZ
694 if (!rb->aux_pages)
695 return -ENOMEM;
696
697 rb->free_aux = event->pmu->free_aux;
0a4e38e6 698 for (rb->aux_nr_pages = 0; rb->aux_nr_pages < nr_pages;) {
45bfb2e5 699 struct page *page;
0a4e38e6 700 int last, order;
45bfb2e5 701
0a4e38e6
AS
702 order = min(max_order, ilog2(nr_pages - rb->aux_nr_pages));
703 page = rb_alloc_aux_page(node, order);
45bfb2e5
PZ
704 if (!page)
705 goto out;
706
0a4e38e6
AS
707 for (last = rb->aux_nr_pages + (1 << page_private(page));
708 last > rb->aux_nr_pages; rb->aux_nr_pages++)
709 rb->aux_pages[rb->aux_nr_pages] = page_address(page++);
45bfb2e5
PZ
710 }
711
aa319bcd
AS
712 /*
713 * In overwrite mode, PMUs that don't support SG may not handle more
714 * than one contiguous allocation, since they rely on PMI to do double
715 * buffering. In this case, the entire buffer has to be one contiguous
716 * chunk.
717 */
718 if ((event->pmu->capabilities & PERF_PMU_CAP_AUX_NO_SG) &&
719 overwrite) {
720 struct page *page = virt_to_page(rb->aux_pages[0]);
721
722 if (page_private(page) != max_order)
723 goto out;
724 }
725
84001866 726 rb->aux_priv = event->pmu->setup_aux(event, rb->aux_pages, nr_pages,
45bfb2e5
PZ
727 overwrite);
728 if (!rb->aux_priv)
729 goto out;
730
731 ret = 0;
732
733 /*
734 * aux_pages (and pmu driver's private data, aux_priv) will be
735 * referenced in both producer's and consumer's contexts, thus
736 * we keep a refcount here to make sure either of the two can
737 * reference them safely.
738 */
ca3bb3d0 739 refcount_set(&rb->aux_refcount, 1);
45bfb2e5 740
2023a0d2 741 rb->aux_overwrite = overwrite;
1a594131
AS
742 rb->aux_watermark = watermark;
743
744 if (!rb->aux_watermark && !rb->aux_overwrite)
745 rb->aux_watermark = nr_pages << (PAGE_SHIFT - 1);
2023a0d2 746
45bfb2e5
PZ
747out:
748 if (!ret)
749 rb->aux_pgoff = pgoff;
750 else
45c815f0 751 __rb_free_aux(rb);
45bfb2e5
PZ
752
753 return ret;
754}
755
56de4e8f 756void rb_free_aux(struct perf_buffer *rb)
45bfb2e5 757{
ca3bb3d0 758 if (refcount_dec_and_test(&rb->aux_refcount))
45bfb2e5
PZ
759 __rb_free_aux(rb);
760}
761
76369139
FW
762#ifndef CONFIG_PERF_USE_VMALLOC
763
764/*
765 * Back perf_mmap() with regular GFP_KERNEL-0 pages.
766 */
767
45bfb2e5 768static struct page *
56de4e8f 769__perf_mmap_to_page(struct perf_buffer *rb, unsigned long pgoff)
76369139
FW
770{
771 if (pgoff > rb->nr_pages)
772 return NULL;
773
774 if (pgoff == 0)
775 return virt_to_page(rb->user_page);
776
777 return virt_to_page(rb->data_pages[pgoff - 1]);
778}
779
780static void *perf_mmap_alloc_page(int cpu)
781{
782 struct page *page;
783 int node;
784
785 node = (cpu == -1) ? cpu : cpu_to_node(cpu);
786 page = alloc_pages_node(node, GFP_KERNEL | __GFP_ZERO, 0);
787 if (!page)
788 return NULL;
789
790 return page_address(page);
791}
792
d7e78706
YY
793static void perf_mmap_free_page(void *addr)
794{
795 struct page *page = virt_to_page(addr);
796
797 page->mapping = NULL;
798 __free_page(page);
799}
800
56de4e8f 801struct perf_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
76369139 802{
56de4e8f 803 struct perf_buffer *rb;
76369139
FW
804 unsigned long size;
805 int i;
806
56de4e8f 807 size = sizeof(struct perf_buffer);
76369139
FW
808 size += nr_pages * sizeof(void *);
809
528871b4 810 if (order_base_2(size) >= PAGE_SHIFT+MAX_ORDER)
9dff0aa9
MR
811 goto fail;
812
76369139
FW
813 rb = kzalloc(size, GFP_KERNEL);
814 if (!rb)
815 goto fail;
816
817 rb->user_page = perf_mmap_alloc_page(cpu);
818 if (!rb->user_page)
819 goto fail_user_page;
820
821 for (i = 0; i < nr_pages; i++) {
822 rb->data_pages[i] = perf_mmap_alloc_page(cpu);
823 if (!rb->data_pages[i])
824 goto fail_data_pages;
825 }
826
827 rb->nr_pages = nr_pages;
828
829 ring_buffer_init(rb, watermark, flags);
830
831 return rb;
832
833fail_data_pages:
834 for (i--; i >= 0; i--)
d7e78706 835 perf_mmap_free_page(rb->data_pages[i]);
76369139 836
d7e78706 837 perf_mmap_free_page(rb->user_page);
76369139
FW
838
839fail_user_page:
840 kfree(rb);
841
842fail:
843 return NULL;
844}
845
56de4e8f 846void rb_free(struct perf_buffer *rb)
76369139
FW
847{
848 int i;
849
8a9f91c5 850 perf_mmap_free_page(rb->user_page);
76369139 851 for (i = 0; i < rb->nr_pages; i++)
8a9f91c5 852 perf_mmap_free_page(rb->data_pages[i]);
76369139
FW
853 kfree(rb);
854}
855
856#else
56de4e8f 857static int data_page_nr(struct perf_buffer *rb)
5919b309
JO
858{
859 return rb->nr_pages << page_order(rb);
860}
76369139 861
45bfb2e5 862static struct page *
56de4e8f 863__perf_mmap_to_page(struct perf_buffer *rb, unsigned long pgoff)
76369139 864{
5919b309
JO
865 /* The '>' counts in the user page. */
866 if (pgoff > data_page_nr(rb))
76369139
FW
867 return NULL;
868
869 return vmalloc_to_page((void *)rb->user_page + pgoff * PAGE_SIZE);
870}
871
872static void perf_mmap_unmark_page(void *addr)
873{
874 struct page *page = vmalloc_to_page(addr);
875
876 page->mapping = NULL;
877}
878
879static void rb_free_work(struct work_struct *work)
880{
56de4e8f 881 struct perf_buffer *rb;
76369139
FW
882 void *base;
883 int i, nr;
884
56de4e8f 885 rb = container_of(work, struct perf_buffer, work);
5919b309 886 nr = data_page_nr(rb);
76369139
FW
887
888 base = rb->user_page;
5919b309
JO
889 /* The '<=' counts in the user page. */
890 for (i = 0; i <= nr; i++)
76369139
FW
891 perf_mmap_unmark_page(base + (i * PAGE_SIZE));
892
893 vfree(base);
894 kfree(rb);
895}
896
56de4e8f 897void rb_free(struct perf_buffer *rb)
76369139
FW
898{
899 schedule_work(&rb->work);
900}
901
56de4e8f 902struct perf_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
76369139 903{
56de4e8f 904 struct perf_buffer *rb;
76369139
FW
905 unsigned long size;
906 void *all_buf;
907
56de4e8f 908 size = sizeof(struct perf_buffer);
76369139
FW
909 size += sizeof(void *);
910
911 rb = kzalloc(size, GFP_KERNEL);
912 if (!rb)
913 goto fail;
914
915 INIT_WORK(&rb->work, rb_free_work);
916
917 all_buf = vmalloc_user((nr_pages + 1) * PAGE_SIZE);
918 if (!all_buf)
919 goto fail_all_buf;
920
921 rb->user_page = all_buf;
922 rb->data_pages[0] = all_buf + PAGE_SIZE;
8184059e
PZ
923 if (nr_pages) {
924 rb->nr_pages = 1;
925 rb->page_order = ilog2(nr_pages);
926 }
76369139
FW
927
928 ring_buffer_init(rb, watermark, flags);
929
930 return rb;
931
932fail_all_buf:
933 kfree(rb);
934
935fail:
936 return NULL;
937}
938
939#endif
45bfb2e5
PZ
940
941struct page *
56de4e8f 942perf_mmap_to_page(struct perf_buffer *rb, unsigned long pgoff)
45bfb2e5
PZ
943{
944 if (rb->aux_nr_pages) {
945 /* above AUX space */
946 if (pgoff > rb->aux_pgoff + rb->aux_nr_pages)
947 return NULL;
948
949 /* AUX space */
4411ec1d
PZ
950 if (pgoff >= rb->aux_pgoff) {
951 int aux_pgoff = array_index_nospec(pgoff - rb->aux_pgoff, rb->aux_nr_pages);
952 return virt_to_page(rb->aux_pages[aux_pgoff]);
953 }
45bfb2e5
PZ
954 }
955
956 return __perf_mmap_to_page(rb, pgoff);
957}