Merge tag 'driver-core-4.2-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git...
[cascardo/linux.git] / tools / perf / util / auxtrace.h
1 /*
2  * auxtrace.h: AUX area trace support
3  * Copyright (c) 2013-2015, Intel Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms and conditions of the GNU General Public License,
7  * version 2, as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  */
15
16 #ifndef __PERF_AUXTRACE_H
17 #define __PERF_AUXTRACE_H
18
19 #include <sys/types.h>
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <linux/list.h>
23 #include <linux/perf_event.h>
24 #include <linux/types.h>
25
26 #include "../perf.h"
27 #include "event.h"
28 #include "session.h"
29 #include "debug.h"
30
31 union perf_event;
32 struct perf_session;
33 struct perf_evlist;
34 struct perf_tool;
35 struct option;
36 struct record_opts;
37 struct auxtrace_info_event;
38 struct events_stats;
39
40 enum auxtrace_type {
41         PERF_AUXTRACE_UNKNOWN,
42 };
43
44 enum itrace_period_type {
45         PERF_ITRACE_PERIOD_INSTRUCTIONS,
46         PERF_ITRACE_PERIOD_TICKS,
47         PERF_ITRACE_PERIOD_NANOSECS,
48 };
49
50 /**
51  * struct itrace_synth_opts - AUX area tracing synthesis options.
52  * @set: indicates whether or not options have been set
53  * @inject: indicates the event (not just the sample) must be fully synthesized
54  *          because 'perf inject' will write it out
55  * @instructions: whether to synthesize 'instructions' events
56  * @branches: whether to synthesize 'branches' events
57  * @transactions: whether to synthesize events for transactions
58  * @errors: whether to synthesize decoder error events
59  * @dont_decode: whether to skip decoding entirely
60  * @log: write a decoding log
61  * @calls: limit branch samples to calls (can be combined with @returns)
62  * @returns: limit branch samples to returns (can be combined with @calls)
63  * @callchain: add callchain to 'instructions' events
64  * @callchain_sz: maximum callchain size
65  * @period: 'instructions' events period
66  * @period_type: 'instructions' events period type
67  */
68 struct itrace_synth_opts {
69         bool                    set;
70         bool                    inject;
71         bool                    instructions;
72         bool                    branches;
73         bool                    transactions;
74         bool                    errors;
75         bool                    dont_decode;
76         bool                    log;
77         bool                    calls;
78         bool                    returns;
79         bool                    callchain;
80         unsigned int            callchain_sz;
81         unsigned long long      period;
82         enum itrace_period_type period_type;
83 };
84
85 /**
86  * struct auxtrace_index_entry - indexes a AUX area tracing event within a
87  *                               perf.data file.
88  * @file_offset: offset within the perf.data file
89  * @sz: size of the event
90  */
91 struct auxtrace_index_entry {
92         u64                     file_offset;
93         u64                     sz;
94 };
95
96 #define PERF_AUXTRACE_INDEX_ENTRY_COUNT 256
97
98 /**
99  * struct auxtrace_index - index of AUX area tracing events within a perf.data
100  *                         file.
101  * @list: linking a number of arrays of entries
102  * @nr: number of entries
103  * @entries: array of entries
104  */
105 struct auxtrace_index {
106         struct list_head        list;
107         size_t                  nr;
108         struct auxtrace_index_entry entries[PERF_AUXTRACE_INDEX_ENTRY_COUNT];
109 };
110
111 /**
112  * struct auxtrace - session callbacks to allow AUX area data decoding.
113  * @process_event: lets the decoder see all session events
114  * @flush_events: process any remaining data
115  * @free_events: free resources associated with event processing
116  * @free: free resources associated with the session
117  */
118 struct auxtrace {
119         int (*process_event)(struct perf_session *session,
120                              union perf_event *event,
121                              struct perf_sample *sample,
122                              struct perf_tool *tool);
123         int (*process_auxtrace_event)(struct perf_session *session,
124                                       union perf_event *event,
125                                       struct perf_tool *tool);
126         int (*flush_events)(struct perf_session *session,
127                             struct perf_tool *tool);
128         void (*free_events)(struct perf_session *session);
129         void (*free)(struct perf_session *session);
130 };
131
132 /**
133  * struct auxtrace_buffer - a buffer containing AUX area tracing data.
134  * @list: buffers are queued in a list held by struct auxtrace_queue
135  * @size: size of the buffer in bytes
136  * @pid: in per-thread mode, the pid this buffer is associated with
137  * @tid: in per-thread mode, the tid this buffer is associated with
138  * @cpu: in per-cpu mode, the cpu this buffer is associated with
139  * @data: actual buffer data (can be null if the data has not been loaded)
140  * @data_offset: file offset at which the buffer can be read
141  * @mmap_addr: mmap address at which the buffer can be read
142  * @mmap_size: size of the mmap at @mmap_addr
143  * @data_needs_freeing: @data was malloc'd so free it when it is no longer
144  *                      needed
145  * @consecutive: the original data was split up and this buffer is consecutive
146  *               to the previous buffer
147  * @offset: offset as determined by aux_head / aux_tail members of struct
148  *          perf_event_mmap_page
149  * @reference: an implementation-specific reference determined when the data is
150  *             recorded
151  * @buffer_nr: used to number each buffer
152  * @use_size: implementation actually only uses this number of bytes
153  * @use_data: implementation actually only uses data starting at this address
154  */
155 struct auxtrace_buffer {
156         struct list_head        list;
157         size_t                  size;
158         pid_t                   pid;
159         pid_t                   tid;
160         int                     cpu;
161         void                    *data;
162         off_t                   data_offset;
163         void                    *mmap_addr;
164         size_t                  mmap_size;
165         bool                    data_needs_freeing;
166         bool                    consecutive;
167         u64                     offset;
168         u64                     reference;
169         u64                     buffer_nr;
170         size_t                  use_size;
171         void                    *use_data;
172 };
173
174 /**
175  * struct auxtrace_queue - a queue of AUX area tracing data buffers.
176  * @head: head of buffer list
177  * @tid: in per-thread mode, the tid this queue is associated with
178  * @cpu: in per-cpu mode, the cpu this queue is associated with
179  * @set: %true once this queue has been dedicated to a specific thread or cpu
180  * @priv: implementation-specific data
181  */
182 struct auxtrace_queue {
183         struct list_head        head;
184         pid_t                   tid;
185         int                     cpu;
186         bool                    set;
187         void                    *priv;
188 };
189
190 /**
191  * struct auxtrace_queues - an array of AUX area tracing queues.
192  * @queue_array: array of queues
193  * @nr_queues: number of queues
194  * @new_data: set whenever new data is queued
195  * @populated: queues have been fully populated using the auxtrace_index
196  * @next_buffer_nr: used to number each buffer
197  */
198 struct auxtrace_queues {
199         struct auxtrace_queue   *queue_array;
200         unsigned int            nr_queues;
201         bool                    new_data;
202         bool                    populated;
203         u64                     next_buffer_nr;
204 };
205
206 /**
207  * struct auxtrace_heap_item - element of struct auxtrace_heap.
208  * @queue_nr: queue number
209  * @ordinal: value used for sorting (lowest ordinal is top of the heap) expected
210  *           to be a timestamp
211  */
212 struct auxtrace_heap_item {
213         unsigned int            queue_nr;
214         u64                     ordinal;
215 };
216
217 /**
218  * struct auxtrace_heap - a heap suitable for sorting AUX area tracing queues.
219  * @heap_array: the heap
220  * @heap_cnt: the number of elements in the heap
221  * @heap_sz: maximum number of elements (grows as needed)
222  */
223 struct auxtrace_heap {
224         struct auxtrace_heap_item       *heap_array;
225         unsigned int            heap_cnt;
226         unsigned int            heap_sz;
227 };
228
229 /**
230  * struct auxtrace_mmap - records an mmap of the auxtrace buffer.
231  * @base: address of mapped area
232  * @userpg: pointer to buffer's perf_event_mmap_page
233  * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
234  * @len: size of mapped area
235  * @prev: previous aux_head
236  * @idx: index of this mmap
237  * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
238  *       mmap) otherwise %0
239  * @cpu: cpu number for a per-cpu mmap otherwise %-1
240  */
241 struct auxtrace_mmap {
242         void            *base;
243         void            *userpg;
244         size_t          mask;
245         size_t          len;
246         u64             prev;
247         int             idx;
248         pid_t           tid;
249         int             cpu;
250 };
251
252 /**
253  * struct auxtrace_mmap_params - parameters to set up struct auxtrace_mmap.
254  * @mask: %0 if @len is not a power of two, otherwise (@len - %1)
255  * @offset: file offset of mapped area
256  * @len: size of mapped area
257  * @prot: mmap memory protection
258  * @idx: index of this mmap
259  * @tid: tid for a per-thread mmap (also set if there is only 1 tid on a per-cpu
260  *       mmap) otherwise %0
261  * @cpu: cpu number for a per-cpu mmap otherwise %-1
262  */
263 struct auxtrace_mmap_params {
264         size_t          mask;
265         off_t           offset;
266         size_t          len;
267         int             prot;
268         int             idx;
269         pid_t           tid;
270         int             cpu;
271 };
272
273 /**
274  * struct auxtrace_record - callbacks for recording AUX area data.
275  * @recording_options: validate and process recording options
276  * @info_priv_size: return the size of the private data in auxtrace_info_event
277  * @info_fill: fill-in the private data in auxtrace_info_event
278  * @free: free this auxtrace record structure
279  * @snapshot_start: starting a snapshot
280  * @snapshot_finish: finishing a snapshot
281  * @find_snapshot: find data to snapshot within auxtrace mmap
282  * @parse_snapshot_options: parse snapshot options
283  * @reference: provide a 64-bit reference number for auxtrace_event
284  * @read_finish: called after reading from an auxtrace mmap
285  */
286 struct auxtrace_record {
287         int (*recording_options)(struct auxtrace_record *itr,
288                                  struct perf_evlist *evlist,
289                                  struct record_opts *opts);
290         size_t (*info_priv_size)(struct auxtrace_record *itr);
291         int (*info_fill)(struct auxtrace_record *itr,
292                          struct perf_session *session,
293                          struct auxtrace_info_event *auxtrace_info,
294                          size_t priv_size);
295         void (*free)(struct auxtrace_record *itr);
296         int (*snapshot_start)(struct auxtrace_record *itr);
297         int (*snapshot_finish)(struct auxtrace_record *itr);
298         int (*find_snapshot)(struct auxtrace_record *itr, int idx,
299                              struct auxtrace_mmap *mm, unsigned char *data,
300                              u64 *head, u64 *old);
301         int (*parse_snapshot_options)(struct auxtrace_record *itr,
302                                       struct record_opts *opts,
303                                       const char *str);
304         u64 (*reference)(struct auxtrace_record *itr);
305         int (*read_finish)(struct auxtrace_record *itr, int idx);
306 };
307
308 #ifdef HAVE_AUXTRACE_SUPPORT
309
310 /*
311  * In snapshot mode the mmapped page is read-only which makes using
312  * __sync_val_compare_and_swap() problematic.  However, snapshot mode expects
313  * the buffer is not updated while the snapshot is made (e.g. Intel PT disables
314  * the event) so there is not a race anyway.
315  */
316 static inline u64 auxtrace_mmap__read_snapshot_head(struct auxtrace_mmap *mm)
317 {
318         struct perf_event_mmap_page *pc = mm->userpg;
319         u64 head = ACCESS_ONCE(pc->aux_head);
320
321         /* Ensure all reads are done after we read the head */
322         rmb();
323         return head;
324 }
325
326 static inline u64 auxtrace_mmap__read_head(struct auxtrace_mmap *mm)
327 {
328         struct perf_event_mmap_page *pc = mm->userpg;
329 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
330         u64 head = ACCESS_ONCE(pc->aux_head);
331 #else
332         u64 head = __sync_val_compare_and_swap(&pc->aux_head, 0, 0);
333 #endif
334
335         /* Ensure all reads are done after we read the head */
336         rmb();
337         return head;
338 }
339
340 static inline void auxtrace_mmap__write_tail(struct auxtrace_mmap *mm, u64 tail)
341 {
342         struct perf_event_mmap_page *pc = mm->userpg;
343 #if BITS_PER_LONG != 64 && defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
344         u64 old_tail;
345 #endif
346
347         /* Ensure all reads are done before we write the tail out */
348         mb();
349 #if BITS_PER_LONG == 64 || !defined(HAVE_SYNC_COMPARE_AND_SWAP_SUPPORT)
350         pc->aux_tail = tail;
351 #else
352         do {
353                 old_tail = __sync_val_compare_and_swap(&pc->aux_tail, 0, 0);
354         } while (!__sync_bool_compare_and_swap(&pc->aux_tail, old_tail, tail));
355 #endif
356 }
357
358 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
359                         struct auxtrace_mmap_params *mp,
360                         void *userpg, int fd);
361 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
362 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
363                                 off_t auxtrace_offset,
364                                 unsigned int auxtrace_pages,
365                                 bool auxtrace_overwrite);
366 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
367                                    struct perf_evlist *evlist, int idx,
368                                    bool per_cpu);
369
370 typedef int (*process_auxtrace_t)(struct perf_tool *tool,
371                                   union perf_event *event, void *data1,
372                                   size_t len1, void *data2, size_t len2);
373
374 int auxtrace_mmap__read(struct auxtrace_mmap *mm, struct auxtrace_record *itr,
375                         struct perf_tool *tool, process_auxtrace_t fn);
376
377 int auxtrace_mmap__read_snapshot(struct auxtrace_mmap *mm,
378                                  struct auxtrace_record *itr,
379                                  struct perf_tool *tool, process_auxtrace_t fn,
380                                  size_t snapshot_size);
381
382 int auxtrace_queues__init(struct auxtrace_queues *queues);
383 int auxtrace_queues__add_event(struct auxtrace_queues *queues,
384                                struct perf_session *session,
385                                union perf_event *event, off_t data_offset,
386                                struct auxtrace_buffer **buffer_ptr);
387 void auxtrace_queues__free(struct auxtrace_queues *queues);
388 int auxtrace_queues__process_index(struct auxtrace_queues *queues,
389                                    struct perf_session *session);
390 struct auxtrace_buffer *auxtrace_buffer__next(struct auxtrace_queue *queue,
391                                               struct auxtrace_buffer *buffer);
392 void *auxtrace_buffer__get_data(struct auxtrace_buffer *buffer, int fd);
393 void auxtrace_buffer__put_data(struct auxtrace_buffer *buffer);
394 void auxtrace_buffer__drop_data(struct auxtrace_buffer *buffer);
395 void auxtrace_buffer__free(struct auxtrace_buffer *buffer);
396
397 int auxtrace_heap__add(struct auxtrace_heap *heap, unsigned int queue_nr,
398                        u64 ordinal);
399 void auxtrace_heap__pop(struct auxtrace_heap *heap);
400 void auxtrace_heap__free(struct auxtrace_heap *heap);
401
402 struct auxtrace_cache_entry {
403         struct hlist_node hash;
404         u32 key;
405 };
406
407 struct auxtrace_cache *auxtrace_cache__new(unsigned int bits, size_t entry_size,
408                                            unsigned int limit_percent);
409 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache);
410 void *auxtrace_cache__alloc_entry(struct auxtrace_cache *c);
411 void auxtrace_cache__free_entry(struct auxtrace_cache *c, void *entry);
412 int auxtrace_cache__add(struct auxtrace_cache *c, u32 key,
413                         struct auxtrace_cache_entry *entry);
414 void *auxtrace_cache__lookup(struct auxtrace_cache *c, u32 key);
415
416 struct auxtrace_record *auxtrace_record__init(struct perf_evlist *evlist,
417                                               int *err);
418
419 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr,
420                                     struct record_opts *opts,
421                                     const char *str);
422 int auxtrace_record__options(struct auxtrace_record *itr,
423                              struct perf_evlist *evlist,
424                              struct record_opts *opts);
425 size_t auxtrace_record__info_priv_size(struct auxtrace_record *itr);
426 int auxtrace_record__info_fill(struct auxtrace_record *itr,
427                                struct perf_session *session,
428                                struct auxtrace_info_event *auxtrace_info,
429                                size_t priv_size);
430 void auxtrace_record__free(struct auxtrace_record *itr);
431 int auxtrace_record__snapshot_start(struct auxtrace_record *itr);
432 int auxtrace_record__snapshot_finish(struct auxtrace_record *itr);
433 int auxtrace_record__find_snapshot(struct auxtrace_record *itr, int idx,
434                                    struct auxtrace_mmap *mm,
435                                    unsigned char *data, u64 *head, u64 *old);
436 u64 auxtrace_record__reference(struct auxtrace_record *itr);
437
438 int auxtrace_index__auxtrace_event(struct list_head *head, union perf_event *event,
439                                    off_t file_offset);
440 int auxtrace_index__write(int fd, struct list_head *head);
441 int auxtrace_index__process(int fd, u64 size, struct perf_session *session,
442                             bool needs_swap);
443 void auxtrace_index__free(struct list_head *head);
444
445 void auxtrace_synth_error(struct auxtrace_error_event *auxtrace_error, int type,
446                           int code, int cpu, pid_t pid, pid_t tid, u64 ip,
447                           const char *msg);
448
449 int perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr,
450                                          struct perf_tool *tool,
451                                          struct perf_session *session,
452                                          perf_event__handler_t process);
453 int perf_event__process_auxtrace_info(struct perf_tool *tool,
454                                       union perf_event *event,
455                                       struct perf_session *session);
456 s64 perf_event__process_auxtrace(struct perf_tool *tool,
457                                  union perf_event *event,
458                                  struct perf_session *session);
459 int perf_event__process_auxtrace_error(struct perf_tool *tool,
460                                        union perf_event *event,
461                                        struct perf_session *session);
462 int itrace_parse_synth_opts(const struct option *opt, const char *str,
463                             int unset);
464 void itrace_synth_opts__set_default(struct itrace_synth_opts *synth_opts);
465
466 size_t perf_event__fprintf_auxtrace_error(union perf_event *event, FILE *fp);
467 void perf_session__auxtrace_error_inc(struct perf_session *session,
468                                       union perf_event *event);
469 void events_stats__auxtrace_error_warn(const struct events_stats *stats);
470
471 static inline int auxtrace__process_event(struct perf_session *session,
472                                           union perf_event *event,
473                                           struct perf_sample *sample,
474                                           struct perf_tool *tool)
475 {
476         if (!session->auxtrace)
477                 return 0;
478
479         return session->auxtrace->process_event(session, event, sample, tool);
480 }
481
482 static inline int auxtrace__flush_events(struct perf_session *session,
483                                          struct perf_tool *tool)
484 {
485         if (!session->auxtrace)
486                 return 0;
487
488         return session->auxtrace->flush_events(session, tool);
489 }
490
491 static inline void auxtrace__free_events(struct perf_session *session)
492 {
493         if (!session->auxtrace)
494                 return;
495
496         return session->auxtrace->free_events(session);
497 }
498
499 static inline void auxtrace__free(struct perf_session *session)
500 {
501         if (!session->auxtrace)
502                 return;
503
504         return session->auxtrace->free(session);
505 }
506
507 #else
508
509 static inline struct auxtrace_record *
510 auxtrace_record__init(struct perf_evlist *evlist __maybe_unused,
511                       int *err __maybe_unused)
512 {
513         *err = 0;
514         return NULL;
515 }
516
517 static inline
518 void auxtrace_record__free(struct auxtrace_record *itr __maybe_unused)
519 {
520 }
521
522 static inline int
523 perf_event__synthesize_auxtrace_info(struct auxtrace_record *itr __maybe_unused,
524                                      struct perf_tool *tool __maybe_unused,
525                                      struct perf_session *session __maybe_unused,
526                                      perf_event__handler_t process __maybe_unused)
527 {
528         return -EINVAL;
529 }
530
531 static inline
532 int auxtrace_record__options(struct auxtrace_record *itr __maybe_unused,
533                              struct perf_evlist *evlist __maybe_unused,
534                              struct record_opts *opts __maybe_unused)
535 {
536         return 0;
537 }
538
539 #define perf_event__process_auxtrace_info               0
540 #define perf_event__process_auxtrace                    0
541 #define perf_event__process_auxtrace_error              0
542
543 static inline
544 void perf_session__auxtrace_error_inc(struct perf_session *session
545                                       __maybe_unused,
546                                       union perf_event *event
547                                       __maybe_unused)
548 {
549 }
550
551 static inline
552 void events_stats__auxtrace_error_warn(const struct events_stats *stats
553                                        __maybe_unused)
554 {
555 }
556
557 static inline
558 int itrace_parse_synth_opts(const struct option *opt __maybe_unused,
559                             const char *str __maybe_unused,
560                             int unset __maybe_unused)
561 {
562         pr_err("AUX area tracing not supported\n");
563         return -EINVAL;
564 }
565
566 static inline
567 int auxtrace_parse_snapshot_options(struct auxtrace_record *itr __maybe_unused,
568                                     struct record_opts *opts __maybe_unused,
569                                     const char *str)
570 {
571         if (!str)
572                 return 0;
573         pr_err("AUX area tracing not supported\n");
574         return -EINVAL;
575 }
576
577 static inline
578 int auxtrace__process_event(struct perf_session *session __maybe_unused,
579                             union perf_event *event __maybe_unused,
580                             struct perf_sample *sample __maybe_unused,
581                             struct perf_tool *tool __maybe_unused)
582 {
583         return 0;
584 }
585
586 static inline
587 int auxtrace__flush_events(struct perf_session *session __maybe_unused,
588                            struct perf_tool *tool __maybe_unused)
589 {
590         return 0;
591 }
592
593 static inline
594 void auxtrace__free_events(struct perf_session *session __maybe_unused)
595 {
596 }
597
598 static inline
599 void auxtrace_cache__free(struct auxtrace_cache *auxtrace_cache __maybe_unused)
600 {
601 }
602
603 static inline
604 void auxtrace__free(struct perf_session *session __maybe_unused)
605 {
606 }
607
608 static inline
609 int auxtrace_index__write(int fd __maybe_unused,
610                           struct list_head *head __maybe_unused)
611 {
612         return -EINVAL;
613 }
614
615 static inline
616 int auxtrace_index__process(int fd __maybe_unused,
617                             u64 size __maybe_unused,
618                             struct perf_session *session __maybe_unused,
619                             bool needs_swap __maybe_unused)
620 {
621         return -EINVAL;
622 }
623
624 static inline
625 void auxtrace_index__free(struct list_head *head __maybe_unused)
626 {
627 }
628
629 int auxtrace_mmap__mmap(struct auxtrace_mmap *mm,
630                         struct auxtrace_mmap_params *mp,
631                         void *userpg, int fd);
632 void auxtrace_mmap__munmap(struct auxtrace_mmap *mm);
633 void auxtrace_mmap_params__init(struct auxtrace_mmap_params *mp,
634                                 off_t auxtrace_offset,
635                                 unsigned int auxtrace_pages,
636                                 bool auxtrace_overwrite);
637 void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
638                                    struct perf_evlist *evlist, int idx,
639                                    bool per_cpu);
640
641 #endif
642
643 #endif