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