1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * intel_pt_decoder.h: Intel Processor Trace support
4 * Copyright (c) 2013-2014, Intel Corporation.
7 #ifndef INCLUDE__INTEL_PT_DECODER_H__
8 #define INCLUDE__INTEL_PT_DECODER_H__
14 #include <linux/rbtree.h>
16 #include "intel-pt-insn-decoder.h"
18 #define INTEL_PT_IN_TX (1 << 0)
19 #define INTEL_PT_ABORT_TX (1 << 1)
20 #define INTEL_PT_ASYNC (1 << 2)
21 #define INTEL_PT_FUP_IP (1 << 3)
22 #define INTEL_PT_SAMPLE_IPC (1 << 4)
24 enum intel_pt_sample_type {
25 INTEL_PT_BRANCH = 1 << 0,
26 INTEL_PT_INSTRUCTION = 1 << 1,
27 INTEL_PT_TRANSACTION = 1 << 2,
28 INTEL_PT_PTW = 1 << 3,
29 INTEL_PT_MWAIT_OP = 1 << 4,
30 INTEL_PT_PWR_ENTRY = 1 << 5,
31 INTEL_PT_EX_STOP = 1 << 6,
32 INTEL_PT_PWR_EXIT = 1 << 7,
33 INTEL_PT_CBR_CHG = 1 << 8,
34 INTEL_PT_TRACE_BEGIN = 1 << 9,
35 INTEL_PT_TRACE_END = 1 << 10,
36 INTEL_PT_BLK_ITEMS = 1 << 11,
37 INTEL_PT_PSB_EVT = 1 << 12,
40 enum intel_pt_period_type {
42 INTEL_PT_PERIOD_INSTRUCTIONS,
43 INTEL_PT_PERIOD_TICKS,
48 INTEL_PT_ERR_NOMEM = 1,
61 enum intel_pt_param_flags {
63 * FUP packet can contain next linear instruction pointer instead of
64 * current linear instruction pointer.
66 INTEL_PT_FUP_WITH_NLIP = 1 << 0,
69 enum intel_pt_blk_type {
71 INTEL_PT_PEBS_BASIC = 4,
72 INTEL_PT_PEBS_MEM = 5,
81 * The block type numbers are not sequential but here they are given sequential
82 * positions to avoid wasting space for array placement.
84 enum intel_pt_blk_type_pos {
86 INTEL_PT_PEBS_BASIC_POS,
87 INTEL_PT_PEBS_MEM_POS,
95 /* Get the array position for a block type */
96 static inline int intel_pt_blk_type_pos(enum intel_pt_blk_type blk_type)
98 #define BLK_TYPE(bt) [INTEL_PT_##bt] = INTEL_PT_##bt##_POS + 1
99 const int map[INTEL_PT_BLK_TYPE_MAX] = {
101 BLK_TYPE(PEBS_BASIC),
110 return blk_type < INTEL_PT_BLK_TYPE_MAX ? map[blk_type] - 1 : -1;
113 #define INTEL_PT_BLK_ITEM_ID_CNT 32
116 * Use unions so that the block items can be accessed by name or by array index.
117 * There is an array of 32-bit masks for each block type, which indicate which
118 * values are present. Then arrays of 32 64-bit values for each block type.
120 struct intel_pt_blk_items {
122 uint32_t mask[INTEL_PT_BLK_TYPE_CNT];
124 uint32_t has_rflags:1;
142 uint32_t has_unused_0:14;
144 uint32_t has_applicable_counters:1;
145 uint32_t has_timestamp:1;
146 uint32_t has_unused_1:29;
147 uint32_t has_mem_access_address:1;
148 uint32_t has_mem_aux_info:1;
149 uint32_t has_mem_access_latency:1;
150 uint32_t has_tsx_aux_info:1;
151 uint32_t has_unused_2:28;
159 uint64_t val[INTEL_PT_BLK_TYPE_CNT][INTEL_PT_BLK_ITEM_ID_CNT];
180 uint64_t unused_0[INTEL_PT_BLK_ITEM_ID_CNT - 18];
184 uint64_t applicable_counters;
186 uint64_t unused_1[INTEL_PT_BLK_ITEM_ID_CNT - 3];
189 uint64_t mem_access_address;
190 uint64_t mem_aux_info;
191 uint64_t mem_access_latency;
192 uint64_t tsx_aux_info;
193 uint64_t unused_2[INTEL_PT_BLK_ITEM_ID_CNT - 4];
195 uint64_t lbr_0[INTEL_PT_BLK_ITEM_ID_CNT];
196 uint64_t lbr_1[INTEL_PT_BLK_ITEM_ID_CNT];
197 uint64_t lbr_2[INTEL_PT_BLK_ITEM_ID_CNT];
198 uint64_t xmm[INTEL_PT_BLK_ITEM_ID_CNT];
204 struct intel_pt_vmcs_info {
205 struct rb_node rb_node;
212 struct intel_pt_state {
213 enum intel_pt_sample_type type;
219 uint64_t tot_insn_cnt;
220 uint64_t tot_cyc_cnt;
222 uint64_t est_timestamp;
224 uint64_t ptw_payload;
225 uint64_t mwait_payload;
226 uint64_t pwre_payload;
227 uint64_t pwrx_payload;
228 uint64_t cbr_payload;
232 enum intel_pt_insn_op insn_op;
234 char insn[INTEL_PT_INSN_BUF_SZ];
235 struct intel_pt_blk_items items;
238 struct intel_pt_insn;
240 struct intel_pt_buffer {
241 const unsigned char *buf;
244 uint64_t ref_timestamp;
248 typedef int (*intel_pt_lookahead_cb_t)(struct intel_pt_buffer *, void *);
250 struct intel_pt_params {
251 int (*get_trace)(struct intel_pt_buffer *buffer, void *data);
252 int (*walk_insn)(struct intel_pt_insn *intel_pt_insn,
253 uint64_t *insn_cnt_ptr, uint64_t *ip, uint64_t to_ip,
254 uint64_t max_insn_cnt, void *data);
255 bool (*pgd_ip)(uint64_t ip, void *data);
256 int (*lookahead)(void *data, intel_pt_lookahead_cb_t cb, void *cb_data);
257 struct intel_pt_vmcs_info *(*findnew_vmcs_info)(void *data, uint64_t vmcs);
259 bool return_compression;
261 bool vm_time_correlation;
262 bool vm_tm_corr_dry_run;
263 uint64_t first_timestamp;
266 enum intel_pt_period_type period_type;
267 unsigned max_non_turbo_ratio;
268 unsigned int mtc_period;
269 uint32_t tsc_ctc_ratio_n;
270 uint32_t tsc_ctc_ratio_d;
271 enum intel_pt_param_flags flags;
275 struct intel_pt_decoder;
277 struct intel_pt_decoder *intel_pt_decoder_new(struct intel_pt_params *params);
278 void intel_pt_decoder_free(struct intel_pt_decoder *decoder);
280 const struct intel_pt_state *intel_pt_decode(struct intel_pt_decoder *decoder);
282 int intel_pt_fast_forward(struct intel_pt_decoder *decoder, uint64_t timestamp);
284 unsigned char *intel_pt_find_overlap(unsigned char *buf_a, size_t len_a,
285 unsigned char *buf_b, size_t len_b,
286 bool have_tsc, bool *consecutive,
289 int intel_pt__strerror(int code, char *buf, size_t buflen);
291 void intel_pt_set_first_timestamp(struct intel_pt_decoder *decoder,
292 uint64_t first_timestamp);