blob: 8e8b903b761368852ced83538748c599ca370f9a [file] [log] [blame]
Frederic Weisbecker76369132011-05-19 19:55:04 +02001/*
2 * Performance events ring-buffer code:
3 *
4 * Copyright (C) 2008 Thomas Gleixner <tglx@linutronix.de>
5 * Copyright (C) 2008-2011 Red Hat, Inc., Ingo Molnar
Peter Zijlstra90eec102015-11-16 11:08:45 +01006 * Copyright (C) 2008-2011 Red Hat, Inc., Peter Zijlstra
Al Virod36b6912011-12-29 17:09:01 -05007 * Copyright © 2009 Paul Mackerras, IBM Corp. <paulus@au1.ibm.com>
Frederic Weisbecker76369132011-05-19 19:55:04 +02008 *
9 * For licensing details see kernel-base/COPYING
10 */
11
12#include <linux/perf_event.h>
13#include <linux/vmalloc.h>
14#include <linux/slab.h>
Peter Zijlstra26c86da2013-10-31 10:19:59 +010015#include <linux/circ_buf.h>
Jiri Olsa7c60fc02015-01-28 18:54:38 +010016#include <linux/poll.h>
Peter Zijlstrac64ca002018-04-20 14:03:18 +020017#include <linux/nospec.h>
Frederic Weisbecker76369132011-05-19 19:55:04 +020018
19#include "internal.h"
20
Frederic Weisbecker76369132011-05-19 19:55:04 +020021static void perf_output_wakeup(struct perf_output_handle *handle)
22{
Jiri Olsa7c60fc02015-01-28 18:54:38 +010023 atomic_set(&handle->rb->poll, POLLIN);
Frederic Weisbecker76369132011-05-19 19:55:04 +020024
Peter Zijlstraa8b0ca12011-06-27 14:41:57 +020025 handle->event->pending_wakeup = 1;
26 irq_work_queue(&handle->event->pending);
Frederic Weisbecker76369132011-05-19 19:55:04 +020027}
28
29/*
30 * We need to ensure a later event_id doesn't publish a head when a former
31 * event isn't done writing. However since we need to deal with NMIs we
32 * cannot fully serialize things.
33 *
34 * We only publish the head (and generate a wakeup) when the outer-most
35 * event completes.
36 */
37static void perf_output_get_handle(struct perf_output_handle *handle)
38{
39 struct ring_buffer *rb = handle->rb;
40
41 preempt_disable();
42 local_inc(&rb->nest);
43 handle->wakeup = local_read(&rb->wakeup);
44}
45
46static void perf_output_put_handle(struct perf_output_handle *handle)
47{
48 struct ring_buffer *rb = handle->rb;
49 unsigned long head;
50
51again:
Peter Zijlstraabfdce32019-05-17 13:52:32 +020052 /*
53 * In order to avoid publishing a head value that goes backwards,
54 * we must ensure the load of @rb->head happens after we've
55 * incremented @rb->nest.
56 *
57 * Otherwise we can observe a @rb->head value before one published
58 * by an IRQ/NMI happening between the load and the increment.
59 */
60 barrier();
Frederic Weisbecker76369132011-05-19 19:55:04 +020061 head = local_read(&rb->head);
62
63 /*
Yabin Cuia446eb52019-05-17 13:52:31 +020064 * IRQ/NMI can happen here and advance @rb->head, causing our
65 * load above to be stale.
Frederic Weisbecker76369132011-05-19 19:55:04 +020066 */
67
Yabin Cuia446eb52019-05-17 13:52:31 +020068 /*
69 * If this isn't the outermost nesting, we don't have to update
70 * @rb->user_page->data_head.
71 */
72 if (local_read(&rb->nest) > 1) {
73 local_dec(&rb->nest);
Frederic Weisbecker76369132011-05-19 19:55:04 +020074 goto out;
Yabin Cuia446eb52019-05-17 13:52:31 +020075 }
Frederic Weisbecker76369132011-05-19 19:55:04 +020076
77 /*
Peter Zijlstrabf378d32013-10-28 13:55:29 +010078 * Since the mmap() consumer (userspace) can run on a different CPU:
79 *
80 * kernel user
81 *
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010082 * if (LOAD ->data_tail) { LOAD ->data_head
83 * (A) smp_rmb() (C)
84 * STORE $data LOAD $data
85 * smp_wmb() (B) smp_mb() (D)
86 * STORE ->data_head STORE ->data_tail
87 * }
Peter Zijlstrabf378d32013-10-28 13:55:29 +010088 *
89 * Where A pairs with D, and B pairs with C.
90 *
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010091 * In our case (A) is a control dependency that separates the load of
92 * the ->data_tail and the stores of $data. In case ->data_tail
93 * indicates there is no room in the buffer to store $data we do not.
Peter Zijlstrabf378d32013-10-28 13:55:29 +010094 *
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010095 * D needs to be a full barrier since it separates the data READ
Peter Zijlstrabf378d32013-10-28 13:55:29 +010096 * from the tail WRITE.
97 *
98 * For B a WMB is sufficient since it separates two WRITEs, and for C
99 * an RMB is sufficient since it separates two READs.
100 *
101 * See perf_output_begin().
Frederic Weisbecker76369132011-05-19 19:55:04 +0200102 */
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +0100103 smp_wmb(); /* B, matches C */
Frederic Weisbecker76369132011-05-19 19:55:04 +0200104 rb->user_page->data_head = head;
105
106 /*
Yabin Cuia446eb52019-05-17 13:52:31 +0200107 * We must publish the head before decrementing the nest count,
108 * otherwise an IRQ/NMI can publish a more recent head value and our
109 * write will (temporarily) publish a stale value.
Frederic Weisbecker76369132011-05-19 19:55:04 +0200110 */
Yabin Cuia446eb52019-05-17 13:52:31 +0200111 barrier();
112 local_set(&rb->nest, 0);
113
114 /*
115 * Ensure we decrement @rb->nest before we validate the @rb->head.
116 * Otherwise we cannot be sure we caught the 'last' nested update.
117 */
118 barrier();
Frederic Weisbecker76369132011-05-19 19:55:04 +0200119 if (unlikely(head != local_read(&rb->head))) {
120 local_inc(&rb->nest);
121 goto again;
122 }
123
124 if (handle->wakeup != local_read(&rb->wakeup))
125 perf_output_wakeup(handle);
126
127out:
128 preempt_enable();
129}
130
Wang Nand1b26c72016-03-28 06:41:31 +0000131static bool __always_inline
132ring_buffer_has_space(unsigned long head, unsigned long tail,
133 unsigned long data_size, unsigned int size,
134 bool backward)
135{
136 if (!backward)
137 return CIRC_SPACE(head, tail, data_size) >= size;
138 else
139 return CIRC_SPACE(tail, head, data_size) >= size;
140}
141
142static int __always_inline
143__perf_output_begin(struct perf_output_handle *handle,
144 struct perf_event *event, unsigned int size,
145 bool backward)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200146{
147 struct ring_buffer *rb;
148 unsigned long tail, offset, head;
Peter Zijlstra524feca2013-10-31 17:36:25 +0100149 int have_lost, page_shift;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200150 struct {
151 struct perf_event_header header;
152 u64 id;
153 u64 lost;
154 } lost_event;
155
156 rcu_read_lock();
157 /*
158 * For inherited events we send all the output towards the parent.
159 */
160 if (event->parent)
161 event = event->parent;
162
163 rb = rcu_dereference(event->rb);
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100164 if (unlikely(!rb))
Frederic Weisbecker76369132011-05-19 19:55:04 +0200165 goto out;
166
Wang Nan86e79722016-03-28 06:41:29 +0000167 if (unlikely(rb->paused)) {
168 if (rb->nr_pages)
169 local_inc(&rb->lost);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200170 goto out;
Wang Nan86e79722016-03-28 06:41:29 +0000171 }
Frederic Weisbecker76369132011-05-19 19:55:04 +0200172
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100173 handle->rb = rb;
174 handle->event = event;
175
Frederic Weisbecker76369132011-05-19 19:55:04 +0200176 have_lost = local_read(&rb->lost);
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100177 if (unlikely(have_lost)) {
Peter Zijlstrad20a9732013-10-31 17:29:29 +0100178 size += sizeof(lost_event);
179 if (event->attr.sample_id_all)
180 size += event->id_header_size;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200181 }
182
183 perf_output_get_handle(handle);
184
185 do {
Linus Torvalds105ff3c2015-11-03 17:22:17 -0800186 tail = READ_ONCE(rb->user_page->data_tail);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200187 offset = head = local_read(&rb->head);
Wang Nand1b26c72016-03-28 06:41:31 +0000188 if (!rb->overwrite) {
189 if (unlikely(!ring_buffer_has_space(head, tail,
190 perf_data_size(rb),
191 size, backward)))
192 goto fail;
193 }
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +0100194
195 /*
196 * The above forms a control dependency barrier separating the
197 * @tail load above from the data stores below. Since the @tail
198 * load is required to compute the branch to fail below.
199 *
200 * A, matches D; the full memory barrier userspace SHOULD issue
201 * after reading the data and before storing the new tail
202 * position.
203 *
204 * See perf_output_put_handle().
205 */
206
Wang Nand1b26c72016-03-28 06:41:31 +0000207 if (!backward)
208 head += size;
209 else
210 head -= size;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200211 } while (local_cmpxchg(&rb->head, offset, head) != offset);
212
Wang Nand1b26c72016-03-28 06:41:31 +0000213 if (backward) {
214 offset = head;
215 head = (u64)(-head);
216 }
217
Peter Zijlstra85f59ed2013-10-31 17:25:38 +0100218 /*
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +0100219 * We rely on the implied barrier() by local_cmpxchg() to ensure
220 * none of the data stores below can be lifted up by the compiler.
Peter Zijlstra85f59ed2013-10-31 17:25:38 +0100221 */
Peter Zijlstra85f59ed2013-10-31 17:25:38 +0100222
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100223 if (unlikely(head - local_read(&rb->wakeup) > rb->watermark))
Frederic Weisbecker76369132011-05-19 19:55:04 +0200224 local_add(rb->watermark, &rb->wakeup);
225
Peter Zijlstra524feca2013-10-31 17:36:25 +0100226 page_shift = PAGE_SHIFT + page_order(rb);
227
228 handle->page = (offset >> page_shift) & (rb->nr_pages - 1);
229 offset &= (1UL << page_shift) - 1;
230 handle->addr = rb->data_pages[handle->page] + offset;
231 handle->size = (1UL << page_shift) - offset;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200232
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100233 if (unlikely(have_lost)) {
Peter Zijlstrad20a9732013-10-31 17:29:29 +0100234 struct perf_sample_data sample_data;
235
236 lost_event.header.size = sizeof(lost_event);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200237 lost_event.header.type = PERF_RECORD_LOST;
238 lost_event.header.misc = 0;
239 lost_event.id = event->id;
240 lost_event.lost = local_xchg(&rb->lost, 0);
241
Peter Zijlstrad20a9732013-10-31 17:29:29 +0100242 perf_event_header__init_id(&lost_event.header,
243 &sample_data, event);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200244 perf_output_put(handle, lost_event);
245 perf_event__output_id_sample(event, handle, &sample_data);
246 }
247
248 return 0;
249
250fail:
251 local_inc(&rb->lost);
252 perf_output_put_handle(handle);
253out:
254 rcu_read_unlock();
255
256 return -ENOSPC;
257}
258
Wang Nan9ecda412016-04-05 14:11:18 +0000259int perf_output_begin_forward(struct perf_output_handle *handle,
260 struct perf_event *event, unsigned int size)
261{
262 return __perf_output_begin(handle, event, size, false);
263}
264
265int perf_output_begin_backward(struct perf_output_handle *handle,
266 struct perf_event *event, unsigned int size)
267{
268 return __perf_output_begin(handle, event, size, true);
269}
270
Wang Nand1b26c72016-03-28 06:41:31 +0000271int perf_output_begin(struct perf_output_handle *handle,
272 struct perf_event *event, unsigned int size)
273{
Wang Nan9ecda412016-04-05 14:11:18 +0000274
275 return __perf_output_begin(handle, event, size,
276 unlikely(is_write_backward(event)));
Wang Nand1b26c72016-03-28 06:41:31 +0000277}
278
Frederic Weisbecker91d77532012-08-07 15:20:38 +0200279unsigned int perf_output_copy(struct perf_output_handle *handle,
Frederic Weisbecker76369132011-05-19 19:55:04 +0200280 const void *buf, unsigned int len)
281{
Frederic Weisbecker91d77532012-08-07 15:20:38 +0200282 return __output_copy(handle, buf, len);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200283}
284
Jiri Olsa5685e0f2012-08-07 15:20:39 +0200285unsigned int perf_output_skip(struct perf_output_handle *handle,
286 unsigned int len)
287{
288 return __output_skip(handle, NULL, len);
289}
290
Frederic Weisbecker76369132011-05-19 19:55:04 +0200291void perf_output_end(struct perf_output_handle *handle)
292{
Frederic Weisbecker76369132011-05-19 19:55:04 +0200293 perf_output_put_handle(handle);
294 rcu_read_unlock();
295}
296
297static void
298ring_buffer_init(struct ring_buffer *rb, long watermark, int flags)
299{
300 long max_size = perf_data_size(rb);
301
302 if (watermark)
303 rb->watermark = min(max_size, watermark);
304
305 if (!rb->watermark)
306 rb->watermark = max_size / 2;
307
308 if (flags & RING_BUFFER_WRITABLE)
Stephane Eraniandd9c0862013-03-18 14:33:28 +0100309 rb->overwrite = 0;
310 else
311 rb->overwrite = 1;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200312
313 atomic_set(&rb->refcount, 1);
Peter Zijlstra10c6db12011-11-26 02:47:31 +0100314
315 INIT_LIST_HEAD(&rb->event_list);
316 spin_lock_init(&rb->event_lock);
Wang Nan86e79722016-03-28 06:41:29 +0000317
318 /*
319 * perf_output_begin() only checks rb->paused, therefore
320 * rb->paused must be true if we have no pages for output.
321 */
322 if (!rb->nr_pages)
323 rb->paused = 1;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200324}
325
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200326/*
327 * This is called before hardware starts writing to the AUX area to
328 * obtain an output handle and make sure there's room in the buffer.
329 * When the capture completes, call perf_aux_output_end() to commit
330 * the recorded data to the buffer.
331 *
332 * The ordering is similar to that of perf_output_{begin,end}, with
333 * the exception of (B), which should be taken care of by the pmu
334 * driver, since ordering rules will differ depending on hardware.
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200335 *
336 * Call this from pmu::start(); see the comment in perf_aux_output_end()
337 * about its use in pmu callbacks. Both can also be called from the PMI
338 * handler if needed.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200339 */
340void *perf_aux_output_begin(struct perf_output_handle *handle,
341 struct perf_event *event)
342{
343 struct perf_event *output_event = event;
344 unsigned long aux_head, aux_tail;
345 struct ring_buffer *rb;
346
347 if (output_event->parent)
348 output_event = output_event->parent;
349
350 /*
351 * Since this will typically be open across pmu::add/pmu::del, we
352 * grab ring_buffer's refcount instead of holding rcu read lock
353 * to make sure it doesn't disappear under us.
354 */
355 rb = ring_buffer_get(output_event);
356 if (!rb)
357 return NULL;
358
Alexander Shishkinb79ccad2016-09-06 16:23:50 +0300359 if (!rb_has_aux(rb))
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200360 goto err;
361
362 /*
Alexander Shishkinb79ccad2016-09-06 16:23:50 +0300363 * If aux_mmap_count is zero, the aux buffer is in perf_mmap_close(),
364 * about to get freed, so we leave immediately.
365 *
366 * Checking rb::aux_mmap_count and rb::refcount has to be done in
367 * the same order, see perf_mmap_close. Otherwise we end up freeing
368 * aux pages in this path, which is a bug, because in_atomic().
Alexander Shishkindcb10a92016-03-04 15:42:45 +0200369 */
370 if (!atomic_read(&rb->aux_mmap_count))
Alexander Shishkinb79ccad2016-09-06 16:23:50 +0300371 goto err;
372
373 if (!atomic_inc_not_zero(&rb->aux_refcount))
374 goto err;
Alexander Shishkindcb10a92016-03-04 15:42:45 +0200375
376 /*
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200377 * Nesting is not supported for AUX area, make sure nested
378 * writers are caught early
379 */
380 if (WARN_ON_ONCE(local_xchg(&rb->aux_nest, 1)))
381 goto err_put;
382
383 aux_head = local_read(&rb->aux_head);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200384
385 handle->rb = rb;
386 handle->event = event;
387 handle->head = aux_head;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200388 handle->size = 0;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200389
390 /*
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200391 * In overwrite mode, AUX data stores do not depend on aux_tail,
392 * therefore (A) control dependency barrier does not exist. The
393 * (B) <-> (C) ordering is still observed by the pmu driver.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200394 */
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200395 if (!rb->aux_overwrite) {
396 aux_tail = ACCESS_ONCE(rb->user_page->aux_tail);
Alexander Shishkin1a594132015-01-14 14:18:18 +0200397 handle->wakeup = local_read(&rb->aux_wakeup) + rb->aux_watermark;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200398 if (aux_head - aux_tail < perf_aux_size(rb))
399 handle->size = CIRC_SPACE(aux_head, aux_tail, perf_aux_size(rb));
400
401 /*
402 * handle->size computation depends on aux_tail load; this forms a
403 * control dependency barrier separating aux_tail load from aux data
404 * store that will be enabled on successful return
405 */
406 if (!handle->size) { /* A, matches D */
407 event->pending_disable = 1;
408 perf_output_wakeup(handle);
409 local_set(&rb->aux_nest, 0);
410 goto err_put;
411 }
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200412 }
413
414 return handle->rb->aux_priv;
415
416err_put:
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200417 /* can't be last */
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200418 rb_free_aux(rb);
419
420err:
Alexander Shishkin95ff4ca2015-12-02 18:41:11 +0200421 ring_buffer_put(rb);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200422 handle->event = NULL;
423
424 return NULL;
425}
426
427/*
428 * Commit the data written by hardware into the ring buffer by adjusting
429 * aux_head and posting a PERF_RECORD_AUX into the perf buffer. It is the
430 * pmu driver's responsibility to observe ordering rules of the hardware,
431 * so that all the data is externally visible before this is called.
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200432 *
433 * Note: this has to be called from pmu::stop() callback, as the assumption
434 * of the AUX buffer management code is that after pmu::stop(), the AUX
435 * transaction must be stopped and therefore drop the AUX reference count.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200436 */
437void perf_aux_output_end(struct perf_output_handle *handle, unsigned long size,
438 bool truncated)
439{
440 struct ring_buffer *rb = handle->rb;
Alexander Shishkin3f56e682016-05-10 16:18:33 +0300441 bool wakeup = truncated;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200442 unsigned long aux_head;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200443 u64 flags = 0;
444
445 if (truncated)
446 flags |= PERF_AUX_FLAG_TRUNCATED;
447
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200448 /* in overwrite mode, driver provides aux_head via handle */
449 if (rb->aux_overwrite) {
450 flags |= PERF_AUX_FLAG_OVERWRITE;
451
452 aux_head = handle->head;
453 local_set(&rb->aux_head, aux_head);
454 } else {
455 aux_head = local_read(&rb->aux_head);
456 local_add(size, &rb->aux_head);
457 }
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200458
459 if (size || flags) {
460 /*
461 * Only send RECORD_AUX if we have something useful to communicate
462 */
463
464 perf_event_aux_event(handle->event, aux_head, size, flags);
465 }
466
Alexander Shishkin1a594132015-01-14 14:18:18 +0200467 aux_head = rb->user_page->aux_head = local_read(&rb->aux_head);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200468
Alexander Shishkin1a594132015-01-14 14:18:18 +0200469 if (aux_head - local_read(&rb->aux_wakeup) >= rb->aux_watermark) {
Alexander Shishkin3f56e682016-05-10 16:18:33 +0300470 wakeup = true;
Alexander Shishkin1a594132015-01-14 14:18:18 +0200471 local_add(rb->aux_watermark, &rb->aux_wakeup);
472 }
Alexander Shishkin3f56e682016-05-10 16:18:33 +0300473
474 if (wakeup) {
475 if (truncated)
476 handle->event->pending_disable = 1;
477 perf_output_wakeup(handle);
478 }
479
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200480 handle->event = NULL;
481
482 local_set(&rb->aux_nest, 0);
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200483 /* can't be last */
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200484 rb_free_aux(rb);
Alexander Shishkin95ff4ca2015-12-02 18:41:11 +0200485 ring_buffer_put(rb);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200486}
487
488/*
489 * Skip over a given number of bytes in the AUX buffer, due to, for example,
490 * hardware's alignment constraints.
491 */
492int perf_aux_output_skip(struct perf_output_handle *handle, unsigned long size)
493{
494 struct ring_buffer *rb = handle->rb;
495 unsigned long aux_head;
496
497 if (size > handle->size)
498 return -ENOSPC;
499
500 local_add(size, &rb->aux_head);
501
Alexander Shishkin1a594132015-01-14 14:18:18 +0200502 aux_head = rb->user_page->aux_head = local_read(&rb->aux_head);
503 if (aux_head - local_read(&rb->aux_wakeup) >= rb->aux_watermark) {
504 perf_output_wakeup(handle);
505 local_add(rb->aux_watermark, &rb->aux_wakeup);
506 handle->wakeup = local_read(&rb->aux_wakeup) +
507 rb->aux_watermark;
508 }
509
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200510 handle->head = aux_head;
511 handle->size -= size;
512
513 return 0;
514}
515
516void *perf_get_aux(struct perf_output_handle *handle)
517{
518 /* this is only valid between perf_aux_output_begin and *_end */
519 if (!handle->event)
520 return NULL;
521
522 return handle->rb->aux_priv;
523}
524
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200525#define PERF_AUX_GFP (GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN | __GFP_NORETRY)
526
527static struct page *rb_alloc_aux_page(int node, int order)
528{
529 struct page *page;
530
531 if (order > MAX_ORDER)
532 order = MAX_ORDER;
533
534 do {
535 page = alloc_pages_node(node, PERF_AUX_GFP, order);
536 } while (!page && order--);
537
538 if (page && order) {
539 /*
Alexander Shishkinc2ad6b52015-07-28 09:00:04 +0300540 * Communicate the allocation size to the driver:
541 * if we managed to secure a high-order allocation,
542 * set its first page's private to this order;
543 * !PagePrivate(page) means it's just a normal page.
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200544 */
545 split_page(page, order);
546 SetPagePrivate(page);
547 set_page_private(page, order);
548 }
549
550 return page;
551}
552
553static void rb_free_aux_page(struct ring_buffer *rb, int idx)
554{
555 struct page *page = virt_to_page(rb->aux_pages[idx]);
556
557 ClearPagePrivate(page);
558 page->mapping = NULL;
559 __free_page(page);
560}
561
Alexander Shishkin45c815f2016-01-19 17:14:29 +0200562static void __rb_free_aux(struct ring_buffer *rb)
563{
564 int pg;
565
Alexander Shishkin95ff4ca2015-12-02 18:41:11 +0200566 /*
567 * Should never happen, the last reference should be dropped from
568 * perf_mmap_close() path, which first stops aux transactions (which
569 * in turn are the atomic holders of aux_refcount) and then does the
570 * last rb_free_aux().
571 */
572 WARN_ON_ONCE(in_atomic());
573
Alexander Shishkin45c815f2016-01-19 17:14:29 +0200574 if (rb->aux_priv) {
575 rb->free_aux(rb->aux_priv);
576 rb->free_aux = NULL;
577 rb->aux_priv = NULL;
578 }
579
580 if (rb->aux_nr_pages) {
581 for (pg = 0; pg < rb->aux_nr_pages; pg++)
582 rb_free_aux_page(rb, pg);
583
584 kfree(rb->aux_pages);
585 rb->aux_nr_pages = 0;
586 }
587}
588
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200589int rb_alloc_aux(struct ring_buffer *rb, struct perf_event *event,
Alexander Shishkin1a594132015-01-14 14:18:18 +0200590 pgoff_t pgoff, int nr_pages, long watermark, int flags)
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200591{
592 bool overwrite = !(flags & RING_BUFFER_WRITABLE);
593 int node = (event->cpu == -1) ? -1 : cpu_to_node(event->cpu);
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200594 int ret = -ENOMEM, max_order = 0;
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200595
596 if (!has_aux(event))
597 return -ENOTSUPP;
598
Alexander Shishkin6a279232015-01-14 14:18:13 +0200599 if (event->pmu->capabilities & PERF_PMU_CAP_AUX_NO_SG) {
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200600 /*
601 * We need to start with the max_order that fits in nr_pages,
602 * not the other way around, hence ilog2() and not get_order.
603 */
604 max_order = ilog2(nr_pages);
605
Alexander Shishkin6a279232015-01-14 14:18:13 +0200606 /*
607 * PMU requests more than one contiguous chunks of memory
608 * for SW double buffering
609 */
610 if ((event->pmu->capabilities & PERF_PMU_CAP_AUX_SW_DOUBLEBUF) &&
611 !overwrite) {
612 if (!max_order)
613 return -EINVAL;
614
615 max_order--;
616 }
617 }
618
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200619 rb->aux_pages = kzalloc_node(nr_pages * sizeof(void *), GFP_KERNEL, node);
620 if (!rb->aux_pages)
621 return -ENOMEM;
622
623 rb->free_aux = event->pmu->free_aux;
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200624 for (rb->aux_nr_pages = 0; rb->aux_nr_pages < nr_pages;) {
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200625 struct page *page;
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200626 int last, order;
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200627
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200628 order = min(max_order, ilog2(nr_pages - rb->aux_nr_pages));
629 page = rb_alloc_aux_page(node, order);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200630 if (!page)
631 goto out;
632
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200633 for (last = rb->aux_nr_pages + (1 << page_private(page));
634 last > rb->aux_nr_pages; rb->aux_nr_pages++)
635 rb->aux_pages[rb->aux_nr_pages] = page_address(page++);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200636 }
637
Alexander Shishkinaa319bc2015-05-22 18:30:20 +0300638 /*
639 * In overwrite mode, PMUs that don't support SG may not handle more
640 * than one contiguous allocation, since they rely on PMI to do double
641 * buffering. In this case, the entire buffer has to be one contiguous
642 * chunk.
643 */
644 if ((event->pmu->capabilities & PERF_PMU_CAP_AUX_NO_SG) &&
645 overwrite) {
646 struct page *page = virt_to_page(rb->aux_pages[0]);
647
648 if (page_private(page) != max_order)
649 goto out;
650 }
651
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200652 rb->aux_priv = event->pmu->setup_aux(event->cpu, rb->aux_pages, nr_pages,
653 overwrite);
654 if (!rb->aux_priv)
655 goto out;
656
657 ret = 0;
658
659 /*
660 * aux_pages (and pmu driver's private data, aux_priv) will be
661 * referenced in both producer's and consumer's contexts, thus
662 * we keep a refcount here to make sure either of the two can
663 * reference them safely.
664 */
665 atomic_set(&rb->aux_refcount, 1);
666
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200667 rb->aux_overwrite = overwrite;
Alexander Shishkin1a594132015-01-14 14:18:18 +0200668 rb->aux_watermark = watermark;
669
670 if (!rb->aux_watermark && !rb->aux_overwrite)
671 rb->aux_watermark = nr_pages << (PAGE_SHIFT - 1);
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200672
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200673out:
674 if (!ret)
675 rb->aux_pgoff = pgoff;
676 else
Alexander Shishkin45c815f2016-01-19 17:14:29 +0200677 __rb_free_aux(rb);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200678
679 return ret;
680}
681
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200682void rb_free_aux(struct ring_buffer *rb)
683{
684 if (atomic_dec_and_test(&rb->aux_refcount))
685 __rb_free_aux(rb);
686}
687
Frederic Weisbecker76369132011-05-19 19:55:04 +0200688#ifndef CONFIG_PERF_USE_VMALLOC
689
690/*
691 * Back perf_mmap() with regular GFP_KERNEL-0 pages.
692 */
693
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200694static struct page *
695__perf_mmap_to_page(struct ring_buffer *rb, unsigned long pgoff)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200696{
697 if (pgoff > rb->nr_pages)
698 return NULL;
699
700 if (pgoff == 0)
701 return virt_to_page(rb->user_page);
702
703 return virt_to_page(rb->data_pages[pgoff - 1]);
704}
705
706static void *perf_mmap_alloc_page(int cpu)
707{
708 struct page *page;
709 int node;
710
711 node = (cpu == -1) ? cpu : cpu_to_node(cpu);
712 page = alloc_pages_node(node, GFP_KERNEL | __GFP_ZERO, 0);
713 if (!page)
714 return NULL;
715
716 return page_address(page);
717}
718
719struct ring_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
720{
721 struct ring_buffer *rb;
722 unsigned long size;
723 int i;
724
725 size = sizeof(struct ring_buffer);
726 size += nr_pages * sizeof(void *);
727
Ingo Molnar01d16f02019-02-13 07:57:02 +0100728 if (order_base_2(size) >= PAGE_SHIFT+MAX_ORDER)
Mark Rutland9269ba32019-01-10 14:27:45 +0000729 goto fail;
730
Frederic Weisbecker76369132011-05-19 19:55:04 +0200731 rb = kzalloc(size, GFP_KERNEL);
732 if (!rb)
733 goto fail;
734
735 rb->user_page = perf_mmap_alloc_page(cpu);
736 if (!rb->user_page)
737 goto fail_user_page;
738
739 for (i = 0; i < nr_pages; i++) {
740 rb->data_pages[i] = perf_mmap_alloc_page(cpu);
741 if (!rb->data_pages[i])
742 goto fail_data_pages;
743 }
744
745 rb->nr_pages = nr_pages;
746
747 ring_buffer_init(rb, watermark, flags);
748
749 return rb;
750
751fail_data_pages:
752 for (i--; i >= 0; i--)
753 free_page((unsigned long)rb->data_pages[i]);
754
755 free_page((unsigned long)rb->user_page);
756
757fail_user_page:
758 kfree(rb);
759
760fail:
761 return NULL;
762}
763
764static void perf_mmap_free_page(unsigned long addr)
765{
766 struct page *page = virt_to_page((void *)addr);
767
768 page->mapping = NULL;
769 __free_page(page);
770}
771
772void rb_free(struct ring_buffer *rb)
773{
774 int i;
775
776 perf_mmap_free_page((unsigned long)rb->user_page);
777 for (i = 0; i < rb->nr_pages; i++)
778 perf_mmap_free_page((unsigned long)rb->data_pages[i]);
779 kfree(rb);
780}
781
782#else
Jiri Olsa5919b302013-03-19 15:35:09 +0100783static int data_page_nr(struct ring_buffer *rb)
784{
785 return rb->nr_pages << page_order(rb);
786}
Frederic Weisbecker76369132011-05-19 19:55:04 +0200787
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200788static struct page *
789__perf_mmap_to_page(struct ring_buffer *rb, unsigned long pgoff)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200790{
Jiri Olsa5919b302013-03-19 15:35:09 +0100791 /* The '>' counts in the user page. */
792 if (pgoff > data_page_nr(rb))
Frederic Weisbecker76369132011-05-19 19:55:04 +0200793 return NULL;
794
795 return vmalloc_to_page((void *)rb->user_page + pgoff * PAGE_SIZE);
796}
797
798static void perf_mmap_unmark_page(void *addr)
799{
800 struct page *page = vmalloc_to_page(addr);
801
802 page->mapping = NULL;
803}
804
805static void rb_free_work(struct work_struct *work)
806{
807 struct ring_buffer *rb;
808 void *base;
809 int i, nr;
810
811 rb = container_of(work, struct ring_buffer, work);
Jiri Olsa5919b302013-03-19 15:35:09 +0100812 nr = data_page_nr(rb);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200813
814 base = rb->user_page;
Jiri Olsa5919b302013-03-19 15:35:09 +0100815 /* The '<=' counts in the user page. */
816 for (i = 0; i <= nr; i++)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200817 perf_mmap_unmark_page(base + (i * PAGE_SIZE));
818
819 vfree(base);
820 kfree(rb);
821}
822
823void rb_free(struct ring_buffer *rb)
824{
825 schedule_work(&rb->work);
826}
827
828struct ring_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
829{
830 struct ring_buffer *rb;
831 unsigned long size;
832 void *all_buf;
833
834 size = sizeof(struct ring_buffer);
835 size += sizeof(void *);
836
837 rb = kzalloc(size, GFP_KERNEL);
838 if (!rb)
839 goto fail;
840
841 INIT_WORK(&rb->work, rb_free_work);
842
843 all_buf = vmalloc_user((nr_pages + 1) * PAGE_SIZE);
844 if (!all_buf)
845 goto fail_all_buf;
846
847 rb->user_page = all_buf;
848 rb->data_pages[0] = all_buf + PAGE_SIZE;
Peter Zijlstra81840592016-01-29 15:17:51 +0100849 if (nr_pages) {
850 rb->nr_pages = 1;
851 rb->page_order = ilog2(nr_pages);
852 }
Frederic Weisbecker76369132011-05-19 19:55:04 +0200853
854 ring_buffer_init(rb, watermark, flags);
855
856 return rb;
857
858fail_all_buf:
859 kfree(rb);
860
861fail:
862 return NULL;
863}
864
865#endif
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200866
867struct page *
868perf_mmap_to_page(struct ring_buffer *rb, unsigned long pgoff)
869{
870 if (rb->aux_nr_pages) {
871 /* above AUX space */
872 if (pgoff > rb->aux_pgoff + rb->aux_nr_pages)
873 return NULL;
874
875 /* AUX space */
Peter Zijlstrac64ca002018-04-20 14:03:18 +0200876 if (pgoff >= rb->aux_pgoff) {
877 int aux_pgoff = array_index_nospec(pgoff - rb->aux_pgoff, rb->aux_nr_pages);
878 return virt_to_page(rb->aux_pages[aux_pgoff]);
879 }
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200880 }
881
882 return __perf_mmap_to_page(rb, pgoff);
883}