1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * Intel(R) Processor Trace PMU driver for perf
4 * Copyright (c) 2013-2014, Intel Corporation.
5 *
6 * Intel PT is specified in the Intel Architecture Instruction Set Extensions
7 * Programming Reference:
8 * http://software.intel.com/en-us/intel-isa-extensions
9 */
10
11 #ifndef __INTEL_PT_H__
12 #define __INTEL_PT_H__
13
14 /*
15 * Single-entry ToPA: when this close to region boundary, switch
16 * buffers to avoid losing data.
17 */
18 #define TOPA_PMI_MARGIN 512
19
20 #define TOPA_SHIFT 12
21
sizes(unsigned int tsz)22 static inline unsigned int sizes(unsigned int tsz)
23 {
24 return 1 << (tsz + TOPA_SHIFT);
25 };
26
27 struct topa_entry {
28 u64 end : 1;
29 u64 rsvd0 : 1;
30 u64 intr : 1;
31 u64 rsvd1 : 1;
32 u64 stop : 1;
33 u64 rsvd2 : 1;
34 u64 size : 4;
35 u64 rsvd3 : 2;
36 u64 base : 36;
37 u64 rsvd4 : 16;
38 };
39
40 /* TSC to Core Crystal Clock Ratio */
41 #define CPUID_TSC_LEAF 0x15
42
43 struct pt_pmu {
44 struct pmu pmu;
45 u32 caps[PT_CPUID_REGS_NUM * PT_CPUID_LEAVES];
46 bool vmx;
47 bool branch_en_always_on;
48 unsigned long max_nonturbo_ratio;
49 unsigned int tsc_art_num;
50 unsigned int tsc_art_den;
51 };
52
53 /**
54 * struct pt_buffer - buffer configuration; one buffer per task_struct or
55 * cpu, depending on perf event configuration
56 * @tables: list of ToPA tables in this buffer
57 * @first: shorthand for first topa table
58 * @last: shorthand for last topa table
59 * @cur: current topa table
60 * @nr_pages: buffer size in pages
61 * @cur_idx: current output region's index within @cur table
62 * @output_off: offset within the current output region
63 * @data_size: running total of the amount of data in this buffer
64 * @lost: if data was lost/truncated
65 * @head: logical write offset inside the buffer
66 * @snapshot: if this is for a snapshot/overwrite counter
67 * @single: use Single Range Output instead of ToPA
68 * @stop_pos: STOP topa entry index
69 * @intr_pos: INT topa entry index
70 * @stop_te: STOP topa entry pointer
71 * @intr_te: INT topa entry pointer
72 * @data_pages: array of pages from perf
73 * @topa_index: table of topa entries indexed by page offset
74 */
75 struct pt_buffer {
76 struct list_head tables;
77 struct topa *first, *last, *cur;
78 unsigned int cur_idx;
79 size_t output_off;
80 unsigned long nr_pages;
81 local_t data_size;
82 local64_t head;
83 bool snapshot;
84 bool single;
85 long stop_pos, intr_pos;
86 struct topa_entry *stop_te, *intr_te;
87 void **data_pages;
88 };
89
90 #define PT_FILTERS_NUM 4
91
92 /**
93 * struct pt_filter - IP range filter configuration
94 * @msr_a: range start, goes to RTIT_ADDRn_A
95 * @msr_b: range end, goes to RTIT_ADDRn_B
96 * @config: 4-bit field in RTIT_CTL
97 */
98 struct pt_filter {
99 unsigned long msr_a;
100 unsigned long msr_b;
101 unsigned long config;
102 };
103
104 /**
105 * struct pt_filters - IP range filtering context
106 * @filter: filters defined for this context
107 * @nr_filters: number of defined filters in the @filter array
108 */
109 struct pt_filters {
110 struct pt_filter filter[PT_FILTERS_NUM];
111 unsigned int nr_filters;
112 };
113
114 /**
115 * struct pt - per-cpu pt context
116 * @handle: perf output handle
117 * @filters: last configured filters
118 * @handle_nmi: do handle PT PMI on this cpu, there's an active event
119 * @vmx_on: 1 if VMX is ON on this cpu
120 * @output_base: cached RTIT_OUTPUT_BASE MSR value
121 * @output_mask: cached RTIT_OUTPUT_MASK MSR value
122 */
123 struct pt {
124 struct perf_output_handle handle;
125 struct pt_filters filters;
126 int handle_nmi;
127 int vmx_on;
128 u64 output_base;
129 u64 output_mask;
130 };
131
132 #endif /* __INTEL_PT_H__ */
133