blob: ed6409300ef581bc088a97d4d9b344eb5ab7d4ef [file] [log] [blame]
Thomas Gleixner8e86e012019-01-16 12:10:59 +01001// SPDX-License-Identifier: GPL-2.0
Frederic Weisbecker76369132011-05-19 19:55:04 +02002/*
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
Peter Zijlstra90eec102015-11-16 11:08:45 +01007 * Copyright (C) 2008-2011 Red Hat, Inc., Peter Zijlstra
Al Virod36b6912011-12-29 17:09:01 -05008 * Copyright © 2009 Paul Mackerras, IBM Corp. <paulus@au1.ibm.com>
Frederic Weisbecker76369132011-05-19 19:55:04 +02009 */
10
11#include <linux/perf_event.h>
12#include <linux/vmalloc.h>
13#include <linux/slab.h>
Peter Zijlstra26c86da2013-10-31 10:19:59 +010014#include <linux/circ_buf.h>
Jiri Olsa7c60fc02015-01-28 18:54:38 +010015#include <linux/poll.h>
Peter Zijlstra4411ec12018-04-20 14:03:18 +020016#include <linux/nospec.h>
Frederic Weisbecker76369132011-05-19 19:55:04 +020017
18#include "internal.h"
19
Frederic Weisbecker76369132011-05-19 19:55:04 +020020static void perf_output_wakeup(struct perf_output_handle *handle)
21{
Linus Torvaldsa9a08842018-02-11 14:34:03 -080022 atomic_set(&handle->rb->poll, EPOLLIN);
Frederic Weisbecker76369132011-05-19 19:55:04 +020023
Peter Zijlstraa8b0ca12011-06-27 14:41:57 +020024 handle->event->pending_wakeup = 1;
25 irq_work_queue(&handle->event->pending);
Frederic Weisbecker76369132011-05-19 19:55:04 +020026}
27
28/*
29 * We need to ensure a later event_id doesn't publish a head when a former
30 * event isn't done writing. However since we need to deal with NMIs we
31 * cannot fully serialize things.
32 *
33 * We only publish the head (and generate a wakeup) when the outer-most
34 * event completes.
35 */
36static void perf_output_get_handle(struct perf_output_handle *handle)
37{
38 struct ring_buffer *rb = handle->rb;
39
40 preempt_disable();
41 local_inc(&rb->nest);
42 handle->wakeup = local_read(&rb->wakeup);
43}
44
45static void perf_output_put_handle(struct perf_output_handle *handle)
46{
47 struct ring_buffer *rb = handle->rb;
48 unsigned long head;
49
50again:
51 head = local_read(&rb->head);
52
53 /*
54 * IRQ/NMI can happen here, which means we can miss a head update.
55 */
56
57 if (!local_dec_and_test(&rb->nest))
58 goto out;
59
60 /*
Peter Zijlstrabf378d32013-10-28 13:55:29 +010061 * Since the mmap() consumer (userspace) can run on a different CPU:
62 *
63 * kernel user
64 *
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010065 * if (LOAD ->data_tail) { LOAD ->data_head
66 * (A) smp_rmb() (C)
67 * STORE $data LOAD $data
68 * smp_wmb() (B) smp_mb() (D)
69 * STORE ->data_head STORE ->data_tail
70 * }
Peter Zijlstrabf378d32013-10-28 13:55:29 +010071 *
72 * Where A pairs with D, and B pairs with C.
73 *
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010074 * In our case (A) is a control dependency that separates the load of
75 * the ->data_tail and the stores of $data. In case ->data_tail
76 * indicates there is no room in the buffer to store $data we do not.
Peter Zijlstrabf378d32013-10-28 13:55:29 +010077 *
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010078 * D needs to be a full barrier since it separates the data READ
Peter Zijlstrabf378d32013-10-28 13:55:29 +010079 * from the tail WRITE.
80 *
81 * For B a WMB is sufficient since it separates two WRITEs, and for C
82 * an RMB is sufficient since it separates two READs.
83 *
84 * See perf_output_begin().
Frederic Weisbecker76369132011-05-19 19:55:04 +020085 */
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +010086 smp_wmb(); /* B, matches C */
Frederic Weisbecker76369132011-05-19 19:55:04 +020087 rb->user_page->data_head = head;
88
89 /*
Peter Zijlstra394570b2013-10-31 17:41:23 +010090 * Now check if we missed an update -- rely on previous implied
91 * compiler barriers to force a re-read.
Frederic Weisbecker76369132011-05-19 19:55:04 +020092 */
93 if (unlikely(head != local_read(&rb->head))) {
94 local_inc(&rb->nest);
95 goto again;
96 }
97
98 if (handle->wakeup != local_read(&rb->wakeup))
99 perf_output_wakeup(handle);
100
101out:
102 preempt_enable();
103}
104
Mathieu Malaterre57d6a792018-03-08 21:28:56 +0100105static __always_inline bool
Wang Nand1b26c72016-03-28 06:41:31 +0000106ring_buffer_has_space(unsigned long head, unsigned long tail,
107 unsigned long data_size, unsigned int size,
108 bool backward)
109{
110 if (!backward)
111 return CIRC_SPACE(head, tail, data_size) >= size;
112 else
113 return CIRC_SPACE(tail, head, data_size) >= size;
114}
115
Mathieu Malaterre57d6a792018-03-08 21:28:56 +0100116static __always_inline int
Wang Nand1b26c72016-03-28 06:41:31 +0000117__perf_output_begin(struct perf_output_handle *handle,
118 struct perf_event *event, unsigned int size,
119 bool backward)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200120{
121 struct ring_buffer *rb;
122 unsigned long tail, offset, head;
Peter Zijlstra524feca2013-10-31 17:36:25 +0100123 int have_lost, page_shift;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200124 struct {
125 struct perf_event_header header;
126 u64 id;
127 u64 lost;
128 } lost_event;
129
130 rcu_read_lock();
131 /*
132 * For inherited events we send all the output towards the parent.
133 */
134 if (event->parent)
135 event = event->parent;
136
137 rb = rcu_dereference(event->rb);
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100138 if (unlikely(!rb))
Frederic Weisbecker76369132011-05-19 19:55:04 +0200139 goto out;
140
Wang Nan86e79722016-03-28 06:41:29 +0000141 if (unlikely(rb->paused)) {
142 if (rb->nr_pages)
143 local_inc(&rb->lost);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200144 goto out;
Wang Nan86e79722016-03-28 06:41:29 +0000145 }
Frederic Weisbecker76369132011-05-19 19:55:04 +0200146
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100147 handle->rb = rb;
148 handle->event = event;
149
Frederic Weisbecker76369132011-05-19 19:55:04 +0200150 have_lost = local_read(&rb->lost);
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100151 if (unlikely(have_lost)) {
Peter Zijlstrad20a9732013-10-31 17:29:29 +0100152 size += sizeof(lost_event);
153 if (event->attr.sample_id_all)
154 size += event->id_header_size;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200155 }
156
157 perf_output_get_handle(handle);
158
159 do {
Linus Torvalds105ff3c2015-11-03 17:22:17 -0800160 tail = READ_ONCE(rb->user_page->data_tail);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200161 offset = head = local_read(&rb->head);
Wang Nand1b26c72016-03-28 06:41:31 +0000162 if (!rb->overwrite) {
163 if (unlikely(!ring_buffer_has_space(head, tail,
164 perf_data_size(rb),
165 size, backward)))
166 goto fail;
167 }
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +0100168
169 /*
170 * The above forms a control dependency barrier separating the
171 * @tail load above from the data stores below. Since the @tail
172 * load is required to compute the branch to fail below.
173 *
174 * A, matches D; the full memory barrier userspace SHOULD issue
175 * after reading the data and before storing the new tail
176 * position.
177 *
178 * See perf_output_put_handle().
179 */
180
Wang Nand1b26c72016-03-28 06:41:31 +0000181 if (!backward)
182 head += size;
183 else
184 head -= size;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200185 } while (local_cmpxchg(&rb->head, offset, head) != offset);
186
Wang Nand1b26c72016-03-28 06:41:31 +0000187 if (backward) {
188 offset = head;
189 head = (u64)(-head);
190 }
191
Peter Zijlstra85f59ed2013-10-31 17:25:38 +0100192 /*
Peter Zijlstrac7f2e3c2013-11-25 11:49:10 +0100193 * We rely on the implied barrier() by local_cmpxchg() to ensure
194 * none of the data stores below can be lifted up by the compiler.
Peter Zijlstra85f59ed2013-10-31 17:25:38 +0100195 */
Peter Zijlstra85f59ed2013-10-31 17:25:38 +0100196
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100197 if (unlikely(head - local_read(&rb->wakeup) > rb->watermark))
Frederic Weisbecker76369132011-05-19 19:55:04 +0200198 local_add(rb->watermark, &rb->wakeup);
199
Peter Zijlstra524feca2013-10-31 17:36:25 +0100200 page_shift = PAGE_SHIFT + page_order(rb);
201
202 handle->page = (offset >> page_shift) & (rb->nr_pages - 1);
203 offset &= (1UL << page_shift) - 1;
204 handle->addr = rb->data_pages[handle->page] + offset;
205 handle->size = (1UL << page_shift) - offset;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200206
Peter Zijlstrac72b42a2013-10-31 17:20:25 +0100207 if (unlikely(have_lost)) {
Peter Zijlstrad20a9732013-10-31 17:29:29 +0100208 struct perf_sample_data sample_data;
209
210 lost_event.header.size = sizeof(lost_event);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200211 lost_event.header.type = PERF_RECORD_LOST;
212 lost_event.header.misc = 0;
213 lost_event.id = event->id;
214 lost_event.lost = local_xchg(&rb->lost, 0);
215
Peter Zijlstrad20a9732013-10-31 17:29:29 +0100216 perf_event_header__init_id(&lost_event.header,
217 &sample_data, event);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200218 perf_output_put(handle, lost_event);
219 perf_event__output_id_sample(event, handle, &sample_data);
220 }
221
222 return 0;
223
224fail:
225 local_inc(&rb->lost);
226 perf_output_put_handle(handle);
227out:
228 rcu_read_unlock();
229
230 return -ENOSPC;
231}
232
Wang Nan9ecda412016-04-05 14:11:18 +0000233int perf_output_begin_forward(struct perf_output_handle *handle,
234 struct perf_event *event, unsigned int size)
235{
236 return __perf_output_begin(handle, event, size, false);
237}
238
239int perf_output_begin_backward(struct perf_output_handle *handle,
240 struct perf_event *event, unsigned int size)
241{
242 return __perf_output_begin(handle, event, size, true);
243}
244
Wang Nand1b26c72016-03-28 06:41:31 +0000245int perf_output_begin(struct perf_output_handle *handle,
246 struct perf_event *event, unsigned int size)
247{
Wang Nan9ecda412016-04-05 14:11:18 +0000248
249 return __perf_output_begin(handle, event, size,
250 unlikely(is_write_backward(event)));
Wang Nand1b26c72016-03-28 06:41:31 +0000251}
252
Frederic Weisbecker91d77532012-08-07 15:20:38 +0200253unsigned int perf_output_copy(struct perf_output_handle *handle,
Frederic Weisbecker76369132011-05-19 19:55:04 +0200254 const void *buf, unsigned int len)
255{
Frederic Weisbecker91d77532012-08-07 15:20:38 +0200256 return __output_copy(handle, buf, len);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200257}
258
Jiri Olsa5685e0f2012-08-07 15:20:39 +0200259unsigned int perf_output_skip(struct perf_output_handle *handle,
260 unsigned int len)
261{
262 return __output_skip(handle, NULL, len);
263}
264
Frederic Weisbecker76369132011-05-19 19:55:04 +0200265void perf_output_end(struct perf_output_handle *handle)
266{
Frederic Weisbecker76369132011-05-19 19:55:04 +0200267 perf_output_put_handle(handle);
268 rcu_read_unlock();
269}
270
271static void
272ring_buffer_init(struct ring_buffer *rb, long watermark, int flags)
273{
274 long max_size = perf_data_size(rb);
275
276 if (watermark)
277 rb->watermark = min(max_size, watermark);
278
279 if (!rb->watermark)
280 rb->watermark = max_size / 2;
281
282 if (flags & RING_BUFFER_WRITABLE)
Stephane Eraniandd9c0862013-03-18 14:33:28 +0100283 rb->overwrite = 0;
284 else
285 rb->overwrite = 1;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200286
287 atomic_set(&rb->refcount, 1);
Peter Zijlstra10c6db12011-11-26 02:47:31 +0100288
289 INIT_LIST_HEAD(&rb->event_list);
290 spin_lock_init(&rb->event_lock);
Wang Nan86e79722016-03-28 06:41:29 +0000291
292 /*
293 * perf_output_begin() only checks rb->paused, therefore
294 * rb->paused must be true if we have no pages for output.
295 */
296 if (!rb->nr_pages)
297 rb->paused = 1;
Frederic Weisbecker76369132011-05-19 19:55:04 +0200298}
299
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200300void perf_aux_output_flag(struct perf_output_handle *handle, u64 flags)
301{
302 /*
303 * OVERWRITE is determined by perf_aux_output_end() and can't
304 * be passed in directly.
305 */
306 if (WARN_ON_ONCE(flags & PERF_AUX_FLAG_OVERWRITE))
307 return;
308
309 handle->aux_flags |= flags;
310}
311EXPORT_SYMBOL_GPL(perf_aux_output_flag);
312
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200313/*
314 * This is called before hardware starts writing to the AUX area to
315 * obtain an output handle and make sure there's room in the buffer.
316 * When the capture completes, call perf_aux_output_end() to commit
317 * the recorded data to the buffer.
318 *
319 * The ordering is similar to that of perf_output_{begin,end}, with
320 * the exception of (B), which should be taken care of by the pmu
321 * driver, since ordering rules will differ depending on hardware.
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200322 *
323 * Call this from pmu::start(); see the comment in perf_aux_output_end()
324 * about its use in pmu callbacks. Both can also be called from the PMI
325 * handler if needed.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200326 */
327void *perf_aux_output_begin(struct perf_output_handle *handle,
328 struct perf_event *event)
329{
330 struct perf_event *output_event = event;
331 unsigned long aux_head, aux_tail;
332 struct ring_buffer *rb;
333
334 if (output_event->parent)
335 output_event = output_event->parent;
336
337 /*
338 * Since this will typically be open across pmu::add/pmu::del, we
339 * grab ring_buffer's refcount instead of holding rcu read lock
340 * to make sure it doesn't disappear under us.
341 */
342 rb = ring_buffer_get(output_event);
343 if (!rb)
344 return NULL;
345
Alexander Shishkinb79ccad2016-09-06 16:23:50 +0300346 if (!rb_has_aux(rb))
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200347 goto err;
348
349 /*
Alexander Shishkinb79ccad2016-09-06 16:23:50 +0300350 * If aux_mmap_count is zero, the aux buffer is in perf_mmap_close(),
351 * about to get freed, so we leave immediately.
352 *
353 * Checking rb::aux_mmap_count and rb::refcount has to be done in
354 * the same order, see perf_mmap_close. Otherwise we end up freeing
355 * aux pages in this path, which is a bug, because in_atomic().
Alexander Shishkindcb10a92016-03-04 15:42:45 +0200356 */
357 if (!atomic_read(&rb->aux_mmap_count))
Alexander Shishkinb79ccad2016-09-06 16:23:50 +0300358 goto err;
359
360 if (!atomic_inc_not_zero(&rb->aux_refcount))
361 goto err;
Alexander Shishkindcb10a92016-03-04 15:42:45 +0200362
363 /*
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200364 * Nesting is not supported for AUX area, make sure nested
365 * writers are caught early
366 */
367 if (WARN_ON_ONCE(local_xchg(&rb->aux_nest, 1)))
368 goto err_put;
369
Will Deacon2ab346c2017-08-16 17:18:16 +0100370 aux_head = rb->aux_head;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200371
372 handle->rb = rb;
373 handle->event = event;
374 handle->head = aux_head;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200375 handle->size = 0;
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200376 handle->aux_flags = 0;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200377
378 /*
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200379 * In overwrite mode, AUX data stores do not depend on aux_tail,
380 * therefore (A) control dependency barrier does not exist. The
381 * (B) <-> (C) ordering is still observed by the pmu driver.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200382 */
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200383 if (!rb->aux_overwrite) {
Mark Rutland6aa7de02017-10-23 14:07:29 -0700384 aux_tail = READ_ONCE(rb->user_page->aux_tail);
Will Deacon2ab346c2017-08-16 17:18:16 +0100385 handle->wakeup = rb->aux_wakeup + rb->aux_watermark;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200386 if (aux_head - aux_tail < perf_aux_size(rb))
387 handle->size = CIRC_SPACE(aux_head, aux_tail, perf_aux_size(rb));
388
389 /*
390 * handle->size computation depends on aux_tail load; this forms a
391 * control dependency barrier separating aux_tail load from aux data
392 * store that will be enabled on successful return
393 */
394 if (!handle->size) { /* A, matches D */
395 event->pending_disable = 1;
396 perf_output_wakeup(handle);
397 local_set(&rb->aux_nest, 0);
398 goto err_put;
399 }
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200400 }
401
402 return handle->rb->aux_priv;
403
404err_put:
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200405 /* can't be last */
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200406 rb_free_aux(rb);
407
408err:
Alexander Shishkin95ff4ca2015-12-02 18:41:11 +0200409 ring_buffer_put(rb);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200410 handle->event = NULL;
411
412 return NULL;
413}
Will Deaconbc1d2022016-08-16 16:53:15 +0100414EXPORT_SYMBOL_GPL(perf_aux_output_begin);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200415
Mathieu Malaterre57d6a792018-03-08 21:28:56 +0100416static __always_inline bool rb_need_aux_wakeup(struct ring_buffer *rb)
Alexander Shishkin441430e2017-09-06 19:08:11 +0300417{
418 if (rb->aux_overwrite)
419 return false;
420
421 if (rb->aux_head - rb->aux_wakeup >= rb->aux_watermark) {
422 rb->aux_wakeup = rounddown(rb->aux_head, rb->aux_watermark);
423 return true;
424 }
425
426 return false;
427}
428
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200429/*
430 * Commit the data written by hardware into the ring buffer by adjusting
431 * aux_head and posting a PERF_RECORD_AUX into the perf buffer. It is the
432 * pmu driver's responsibility to observe ordering rules of the hardware,
433 * so that all the data is externally visible before this is called.
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200434 *
435 * Note: this has to be called from pmu::stop() callback, as the assumption
436 * of the AUX buffer management code is that after pmu::stop(), the AUX
437 * transaction must be stopped and therefore drop the AUX reference count.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200438 */
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200439void perf_aux_output_end(struct perf_output_handle *handle, unsigned long size)
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200440{
Alexander Shishkinae0c2d92017-02-20 15:33:51 +0200441 bool wakeup = !!(handle->aux_flags & PERF_AUX_FLAG_TRUNCATED);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200442 struct ring_buffer *rb = handle->rb;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200443 unsigned long aux_head;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200444
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200445 /* in overwrite mode, driver provides aux_head via handle */
446 if (rb->aux_overwrite) {
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200447 handle->aux_flags |= PERF_AUX_FLAG_OVERWRITE;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200448
449 aux_head = handle->head;
Will Deacon2ab346c2017-08-16 17:18:16 +0100450 rb->aux_head = aux_head;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200451 } else {
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200452 handle->aux_flags &= ~PERF_AUX_FLAG_OVERWRITE;
453
Will Deacon2ab346c2017-08-16 17:18:16 +0100454 aux_head = rb->aux_head;
455 rb->aux_head += size;
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200456 }
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200457
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200458 if (size || handle->aux_flags) {
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200459 /*
460 * Only send RECORD_AUX if we have something useful to communicate
Alexander Shishkin16273142018-04-04 17:53:23 +0300461 *
462 * Note: the OVERWRITE records by themselves are not considered
463 * useful, as they don't communicate any *new* information,
464 * aside from the short-lived offset, that becomes history at
465 * the next event sched-in and therefore isn't useful.
466 * The userspace that needs to copy out AUX data in overwrite
467 * mode should know to use user_page::aux_head for the actual
468 * offset. So, from now on we don't output AUX records that
469 * have *only* OVERWRITE flag set.
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200470 */
471
Alexander Shishkin16273142018-04-04 17:53:23 +0300472 if (handle->aux_flags & ~(u64)PERF_AUX_FLAG_OVERWRITE)
473 perf_event_aux_event(handle->event, aux_head, size,
474 handle->aux_flags);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200475 }
476
Will Deacon2ab346c2017-08-16 17:18:16 +0100477 rb->user_page->aux_head = rb->aux_head;
Alexander Shishkin441430e2017-09-06 19:08:11 +0300478 if (rb_need_aux_wakeup(rb))
Alexander Shishkin3f56e682016-05-10 16:18:33 +0300479 wakeup = true;
Alexander Shishkin3f56e682016-05-10 16:18:33 +0300480
481 if (wakeup) {
Will Deaconf4c0b0a2017-02-20 15:33:50 +0200482 if (handle->aux_flags & PERF_AUX_FLAG_TRUNCATED)
Alexander Shishkin3f56e682016-05-10 16:18:33 +0300483 handle->event->pending_disable = 1;
484 perf_output_wakeup(handle);
485 }
486
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200487 handle->event = NULL;
488
489 local_set(&rb->aux_nest, 0);
Alexander Shishkinaf5bb4e2016-03-04 15:42:47 +0200490 /* can't be last */
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200491 rb_free_aux(rb);
Alexander Shishkin95ff4ca2015-12-02 18:41:11 +0200492 ring_buffer_put(rb);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200493}
Will Deaconbc1d2022016-08-16 16:53:15 +0100494EXPORT_SYMBOL_GPL(perf_aux_output_end);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200495
496/*
497 * Skip over a given number of bytes in the AUX buffer, due to, for example,
498 * hardware's alignment constraints.
499 */
500int perf_aux_output_skip(struct perf_output_handle *handle, unsigned long size)
501{
502 struct ring_buffer *rb = handle->rb;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200503
504 if (size > handle->size)
505 return -ENOSPC;
506
Will Deacon2ab346c2017-08-16 17:18:16 +0100507 rb->aux_head += size;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200508
Will Deacon2ab346c2017-08-16 17:18:16 +0100509 rb->user_page->aux_head = rb->aux_head;
Alexander Shishkin441430e2017-09-06 19:08:11 +0300510 if (rb_need_aux_wakeup(rb)) {
Alexander Shishkin1a594132015-01-14 14:18:18 +0200511 perf_output_wakeup(handle);
Will Deacon2ab346c2017-08-16 17:18:16 +0100512 handle->wakeup = rb->aux_wakeup + rb->aux_watermark;
Alexander Shishkin1a594132015-01-14 14:18:18 +0200513 }
514
Will Deacon2ab346c2017-08-16 17:18:16 +0100515 handle->head = rb->aux_head;
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200516 handle->size -= size;
517
518 return 0;
519}
Will Deaconbc1d2022016-08-16 16:53:15 +0100520EXPORT_SYMBOL_GPL(perf_aux_output_skip);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200521
522void *perf_get_aux(struct perf_output_handle *handle)
523{
524 /* this is only valid between perf_aux_output_begin and *_end */
525 if (!handle->event)
526 return NULL;
527
528 return handle->rb->aux_priv;
529}
Will Deaconbc1d2022016-08-16 16:53:15 +0100530EXPORT_SYMBOL_GPL(perf_get_aux);
Alexander Shishkinfdc26702015-01-14 14:18:16 +0200531
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200532#define PERF_AUX_GFP (GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN | __GFP_NORETRY)
533
534static struct page *rb_alloc_aux_page(int node, int order)
535{
536 struct page *page;
537
538 if (order > MAX_ORDER)
539 order = MAX_ORDER;
540
541 do {
542 page = alloc_pages_node(node, PERF_AUX_GFP, order);
543 } while (!page && order--);
544
545 if (page && order) {
546 /*
Alexander Shishkinc2ad6b52015-07-28 09:00:04 +0300547 * Communicate the allocation size to the driver:
548 * if we managed to secure a high-order allocation,
549 * set its first page's private to this order;
550 * !PagePrivate(page) means it's just a normal page.
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200551 */
552 split_page(page, order);
553 SetPagePrivate(page);
554 set_page_private(page, order);
555 }
556
557 return page;
558}
559
560static void rb_free_aux_page(struct ring_buffer *rb, int idx)
561{
562 struct page *page = virt_to_page(rb->aux_pages[idx]);
563
564 ClearPagePrivate(page);
565 page->mapping = NULL;
566 __free_page(page);
567}
568
Alexander Shishkin45c815f2016-01-19 17:14:29 +0200569static void __rb_free_aux(struct ring_buffer *rb)
570{
571 int pg;
572
Alexander Shishkin95ff4ca2015-12-02 18:41:11 +0200573 /*
574 * Should never happen, the last reference should be dropped from
575 * perf_mmap_close() path, which first stops aux transactions (which
576 * in turn are the atomic holders of aux_refcount) and then does the
577 * last rb_free_aux().
578 */
579 WARN_ON_ONCE(in_atomic());
580
Alexander Shishkin45c815f2016-01-19 17:14:29 +0200581 if (rb->aux_priv) {
582 rb->free_aux(rb->aux_priv);
583 rb->free_aux = NULL;
584 rb->aux_priv = NULL;
585 }
586
587 if (rb->aux_nr_pages) {
588 for (pg = 0; pg < rb->aux_nr_pages; pg++)
589 rb_free_aux_page(rb, pg);
590
591 kfree(rb->aux_pages);
592 rb->aux_nr_pages = 0;
593 }
594}
595
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200596int rb_alloc_aux(struct ring_buffer *rb, struct perf_event *event,
Alexander Shishkin1a594132015-01-14 14:18:18 +0200597 pgoff_t pgoff, int nr_pages, long watermark, int flags)
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200598{
599 bool overwrite = !(flags & RING_BUFFER_WRITABLE);
600 int node = (event->cpu == -1) ? -1 : cpu_to_node(event->cpu);
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200601 int ret = -ENOMEM, max_order = 0;
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200602
603 if (!has_aux(event))
Hendrik Brueckner8a1898d2017-06-20 12:26:39 +0200604 return -EOPNOTSUPP;
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200605
Alexander Shishkin6a279232015-01-14 14:18:13 +0200606 if (event->pmu->capabilities & PERF_PMU_CAP_AUX_NO_SG) {
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200607 /*
608 * We need to start with the max_order that fits in nr_pages,
609 * not the other way around, hence ilog2() and not get_order.
610 */
611 max_order = ilog2(nr_pages);
612
Alexander Shishkin6a279232015-01-14 14:18:13 +0200613 /*
614 * PMU requests more than one contiguous chunks of memory
615 * for SW double buffering
616 */
617 if ((event->pmu->capabilities & PERF_PMU_CAP_AUX_SW_DOUBLEBUF) &&
618 !overwrite) {
619 if (!max_order)
620 return -EINVAL;
621
622 max_order--;
623 }
624 }
625
Kees Cook590b5b72018-06-12 14:04:20 -0700626 rb->aux_pages = kcalloc_node(nr_pages, sizeof(void *), GFP_KERNEL,
627 node);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200628 if (!rb->aux_pages)
629 return -ENOMEM;
630
631 rb->free_aux = event->pmu->free_aux;
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200632 for (rb->aux_nr_pages = 0; rb->aux_nr_pages < nr_pages;) {
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200633 struct page *page;
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200634 int last, order;
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200635
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200636 order = min(max_order, ilog2(nr_pages - rb->aux_nr_pages));
637 page = rb_alloc_aux_page(node, order);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200638 if (!page)
639 goto out;
640
Alexander Shishkin0a4e38e2015-01-14 14:18:12 +0200641 for (last = rb->aux_nr_pages + (1 << page_private(page));
642 last > rb->aux_nr_pages; rb->aux_nr_pages++)
643 rb->aux_pages[rb->aux_nr_pages] = page_address(page++);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200644 }
645
Alexander Shishkinaa319bc2015-05-22 18:30:20 +0300646 /*
647 * In overwrite mode, PMUs that don't support SG may not handle more
648 * than one contiguous allocation, since they rely on PMI to do double
649 * buffering. In this case, the entire buffer has to be one contiguous
650 * chunk.
651 */
652 if ((event->pmu->capabilities & PERF_PMU_CAP_AUX_NO_SG) &&
653 overwrite) {
654 struct page *page = virt_to_page(rb->aux_pages[0]);
655
656 if (page_private(page) != max_order)
657 goto out;
658 }
659
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200660 rb->aux_priv = event->pmu->setup_aux(event->cpu, rb->aux_pages, nr_pages,
661 overwrite);
662 if (!rb->aux_priv)
663 goto out;
664
665 ret = 0;
666
667 /*
668 * aux_pages (and pmu driver's private data, aux_priv) will be
669 * referenced in both producer's and consumer's contexts, thus
670 * we keep a refcount here to make sure either of the two can
671 * reference them safely.
672 */
673 atomic_set(&rb->aux_refcount, 1);
674
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200675 rb->aux_overwrite = overwrite;
Alexander Shishkin1a594132015-01-14 14:18:18 +0200676 rb->aux_watermark = watermark;
677
678 if (!rb->aux_watermark && !rb->aux_overwrite)
679 rb->aux_watermark = nr_pages << (PAGE_SHIFT - 1);
Alexander Shishkin2023a0d2015-01-14 14:18:17 +0200680
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200681out:
682 if (!ret)
683 rb->aux_pgoff = pgoff;
684 else
Alexander Shishkin45c815f2016-01-19 17:14:29 +0200685 __rb_free_aux(rb);
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200686
687 return ret;
688}
689
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200690void rb_free_aux(struct ring_buffer *rb)
691{
692 if (atomic_dec_and_test(&rb->aux_refcount))
693 __rb_free_aux(rb);
694}
695
Frederic Weisbecker76369132011-05-19 19:55:04 +0200696#ifndef CONFIG_PERF_USE_VMALLOC
697
698/*
699 * Back perf_mmap() with regular GFP_KERNEL-0 pages.
700 */
701
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200702static struct page *
703__perf_mmap_to_page(struct ring_buffer *rb, unsigned long pgoff)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200704{
705 if (pgoff > rb->nr_pages)
706 return NULL;
707
708 if (pgoff == 0)
709 return virt_to_page(rb->user_page);
710
711 return virt_to_page(rb->data_pages[pgoff - 1]);
712}
713
714static void *perf_mmap_alloc_page(int cpu)
715{
716 struct page *page;
717 int node;
718
719 node = (cpu == -1) ? cpu : cpu_to_node(cpu);
720 page = alloc_pages_node(node, GFP_KERNEL | __GFP_ZERO, 0);
721 if (!page)
722 return NULL;
723
724 return page_address(page);
725}
726
727struct ring_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
728{
729 struct ring_buffer *rb;
730 unsigned long size;
731 int i;
732
733 size = sizeof(struct ring_buffer);
734 size += nr_pages * sizeof(void *);
735
Mark Rutland9dff0aa2019-01-10 14:27:45 +0000736 if (order_base_2(size) >= MAX_ORDER)
737 goto fail;
738
Frederic Weisbecker76369132011-05-19 19:55:04 +0200739 rb = kzalloc(size, GFP_KERNEL);
740 if (!rb)
741 goto fail;
742
743 rb->user_page = perf_mmap_alloc_page(cpu);
744 if (!rb->user_page)
745 goto fail_user_page;
746
747 for (i = 0; i < nr_pages; i++) {
748 rb->data_pages[i] = perf_mmap_alloc_page(cpu);
749 if (!rb->data_pages[i])
750 goto fail_data_pages;
751 }
752
753 rb->nr_pages = nr_pages;
754
755 ring_buffer_init(rb, watermark, flags);
756
757 return rb;
758
759fail_data_pages:
760 for (i--; i >= 0; i--)
761 free_page((unsigned long)rb->data_pages[i]);
762
763 free_page((unsigned long)rb->user_page);
764
765fail_user_page:
766 kfree(rb);
767
768fail:
769 return NULL;
770}
771
772static void perf_mmap_free_page(unsigned long addr)
773{
774 struct page *page = virt_to_page((void *)addr);
775
776 page->mapping = NULL;
777 __free_page(page);
778}
779
780void rb_free(struct ring_buffer *rb)
781{
782 int i;
783
784 perf_mmap_free_page((unsigned long)rb->user_page);
785 for (i = 0; i < rb->nr_pages; i++)
786 perf_mmap_free_page((unsigned long)rb->data_pages[i]);
787 kfree(rb);
788}
789
790#else
Jiri Olsa5919b302013-03-19 15:35:09 +0100791static int data_page_nr(struct ring_buffer *rb)
792{
793 return rb->nr_pages << page_order(rb);
794}
Frederic Weisbecker76369132011-05-19 19:55:04 +0200795
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200796static struct page *
797__perf_mmap_to_page(struct ring_buffer *rb, unsigned long pgoff)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200798{
Jiri Olsa5919b302013-03-19 15:35:09 +0100799 /* The '>' counts in the user page. */
800 if (pgoff > data_page_nr(rb))
Frederic Weisbecker76369132011-05-19 19:55:04 +0200801 return NULL;
802
803 return vmalloc_to_page((void *)rb->user_page + pgoff * PAGE_SIZE);
804}
805
806static void perf_mmap_unmark_page(void *addr)
807{
808 struct page *page = vmalloc_to_page(addr);
809
810 page->mapping = NULL;
811}
812
813static void rb_free_work(struct work_struct *work)
814{
815 struct ring_buffer *rb;
816 void *base;
817 int i, nr;
818
819 rb = container_of(work, struct ring_buffer, work);
Jiri Olsa5919b302013-03-19 15:35:09 +0100820 nr = data_page_nr(rb);
Frederic Weisbecker76369132011-05-19 19:55:04 +0200821
822 base = rb->user_page;
Jiri Olsa5919b302013-03-19 15:35:09 +0100823 /* The '<=' counts in the user page. */
824 for (i = 0; i <= nr; i++)
Frederic Weisbecker76369132011-05-19 19:55:04 +0200825 perf_mmap_unmark_page(base + (i * PAGE_SIZE));
826
827 vfree(base);
828 kfree(rb);
829}
830
831void rb_free(struct ring_buffer *rb)
832{
833 schedule_work(&rb->work);
834}
835
836struct ring_buffer *rb_alloc(int nr_pages, long watermark, int cpu, int flags)
837{
838 struct ring_buffer *rb;
839 unsigned long size;
840 void *all_buf;
841
842 size = sizeof(struct ring_buffer);
843 size += sizeof(void *);
844
845 rb = kzalloc(size, GFP_KERNEL);
846 if (!rb)
847 goto fail;
848
849 INIT_WORK(&rb->work, rb_free_work);
850
851 all_buf = vmalloc_user((nr_pages + 1) * PAGE_SIZE);
852 if (!all_buf)
853 goto fail_all_buf;
854
855 rb->user_page = all_buf;
856 rb->data_pages[0] = all_buf + PAGE_SIZE;
Peter Zijlstra81840592016-01-29 15:17:51 +0100857 if (nr_pages) {
858 rb->nr_pages = 1;
859 rb->page_order = ilog2(nr_pages);
860 }
Frederic Weisbecker76369132011-05-19 19:55:04 +0200861
862 ring_buffer_init(rb, watermark, flags);
863
864 return rb;
865
866fail_all_buf:
867 kfree(rb);
868
869fail:
870 return NULL;
871}
872
873#endif
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200874
875struct page *
876perf_mmap_to_page(struct ring_buffer *rb, unsigned long pgoff)
877{
878 if (rb->aux_nr_pages) {
879 /* above AUX space */
880 if (pgoff > rb->aux_pgoff + rb->aux_nr_pages)
881 return NULL;
882
883 /* AUX space */
Peter Zijlstra4411ec12018-04-20 14:03:18 +0200884 if (pgoff >= rb->aux_pgoff) {
885 int aux_pgoff = array_index_nospec(pgoff - rb->aux_pgoff, rb->aux_nr_pages);
886 return virt_to_page(rb->aux_pages[aux_pgoff]);
887 }
Peter Zijlstra45bfb2e2015-01-14 14:18:11 +0200888 }
889
890 return __perf_mmap_to_page(rb, pgoff);
891}