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