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 "intel-pt-insn-decoder.h"
16 #define INTEL_PT_IN_TX (1 << 0)
17 #define INTEL_PT_ABORT_TX (1 << 1)
18 #define INTEL_PT_ASYNC (1 << 2)
19 #define INTEL_PT_FUP_IP (1 << 3)
20 #define INTEL_PT_SAMPLE_IPC (1 << 4)
22 enum intel_pt_sample_type {
23 INTEL_PT_BRANCH = 1 << 0,
24 INTEL_PT_INSTRUCTION = 1 << 1,
25 INTEL_PT_TRANSACTION = 1 << 2,
26 INTEL_PT_PTW = 1 << 3,
27 INTEL_PT_MWAIT_OP = 1 << 4,
28 INTEL_PT_PWR_ENTRY = 1 << 5,
29 INTEL_PT_EX_STOP = 1 << 6,
30 INTEL_PT_PWR_EXIT = 1 << 7,
31 INTEL_PT_CBR_CHG = 1 << 8,
32 INTEL_PT_TRACE_BEGIN = 1 << 9,
33 INTEL_PT_TRACE_END = 1 << 10,
34 INTEL_PT_BLK_ITEMS = 1 << 11,
35 INTEL_PT_PSB_EVT = 1 << 12,
38 enum intel_pt_period_type {
40 INTEL_PT_PERIOD_INSTRUCTIONS,
41 INTEL_PT_PERIOD_TICKS,
46 INTEL_PT_ERR_NOMEM = 1,
59 enum intel_pt_param_flags {
61 * FUP packet can contain next linear instruction pointer instead of
62 * current linear instruction pointer.
64 INTEL_PT_FUP_WITH_NLIP = 1 << 0,
67 enum intel_pt_blk_type {
69 INTEL_PT_PEBS_BASIC = 4,
70 INTEL_PT_PEBS_MEM = 5,
79 * The block type numbers are not sequential but here they are given sequential
80 * positions to avoid wasting space for array placement.
82 enum intel_pt_blk_type_pos {
84 INTEL_PT_PEBS_BASIC_POS,
85 INTEL_PT_PEBS_MEM_POS,
93 /* Get the array position for a block type */
94 static inline int intel_pt_blk_type_pos(enum intel_pt_blk_type blk_type)
96 #define BLK_TYPE(bt) [INTEL_PT_##bt] = INTEL_PT_##bt##_POS + 1
97 const int map[INTEL_PT_BLK_TYPE_MAX] = {
108 return blk_type < INTEL_PT_BLK_TYPE_MAX ? map[blk_type] - 1 : -1;
111 #define INTEL_PT_BLK_ITEM_ID_CNT 32
114 * Use unions so that the block items can be accessed by name or by array index.
115 * There is an array of 32-bit masks for each block type, which indicate which
116 * values are present. Then arrays of 32 64-bit values for each block type.
118 struct intel_pt_blk_items {
120 uint32_t mask[INTEL_PT_BLK_TYPE_CNT];
122 uint32_t has_rflags:1;
140 uint32_t has_unused_0:14;
142 uint32_t has_applicable_counters:1;
143 uint32_t has_timestamp:1;
144 uint32_t has_unused_1:29;
145 uint32_t has_mem_access_address:1;
146 uint32_t has_mem_aux_info:1;
147 uint32_t has_mem_access_latency:1;
148 uint32_t has_tsx_aux_info:1;
149 uint32_t has_unused_2:28;
157 uint64_t val[INTEL_PT_BLK_TYPE_CNT][INTEL_PT_BLK_ITEM_ID_CNT];
178 uint64_t unused_0[INTEL_PT_BLK_ITEM_ID_CNT - 18];
182 uint64_t applicable_counters;
184 uint64_t unused_1[INTEL_PT_BLK_ITEM_ID_CNT - 3];
187 uint64_t mem_access_address;
188 uint64_t mem_aux_info;
189 uint64_t mem_access_latency;
190 uint64_t tsx_aux_info;
191 uint64_t unused_2[INTEL_PT_BLK_ITEM_ID_CNT - 4];
193 uint64_t lbr_0[INTEL_PT_BLK_ITEM_ID_CNT];
194 uint64_t lbr_1[INTEL_PT_BLK_ITEM_ID_CNT];
195 uint64_t lbr_2[INTEL_PT_BLK_ITEM_ID_CNT];
196 uint64_t xmm[INTEL_PT_BLK_ITEM_ID_CNT];
202 struct intel_pt_state {
203 enum intel_pt_sample_type type;
209 uint64_t tot_insn_cnt;
210 uint64_t tot_cyc_cnt;
212 uint64_t est_timestamp;
214 uint64_t ptw_payload;
215 uint64_t mwait_payload;
216 uint64_t pwre_payload;
217 uint64_t pwrx_payload;
218 uint64_t cbr_payload;
222 enum intel_pt_insn_op insn_op;
224 char insn[INTEL_PT_INSN_BUF_SZ];
225 struct intel_pt_blk_items items;
228 struct intel_pt_insn;
230 struct intel_pt_buffer {
231 const unsigned char *buf;
234 uint64_t ref_timestamp;
238 typedef int (*intel_pt_lookahead_cb_t)(struct intel_pt_buffer *, void *);
240 struct intel_pt_params {
241 int (*get_trace)(struct intel_pt_buffer *buffer, void *data);
242 int (*walk_insn)(struct intel_pt_insn *intel_pt_insn,
243 uint64_t *insn_cnt_ptr, uint64_t *ip, uint64_t to_ip,
244 uint64_t max_insn_cnt, void *data);
245 bool (*pgd_ip)(uint64_t ip, void *data);
246 int (*lookahead)(void *data, intel_pt_lookahead_cb_t cb, void *cb_data);
248 bool return_compression;
252 enum intel_pt_period_type period_type;
253 unsigned max_non_turbo_ratio;
254 unsigned int mtc_period;
255 uint32_t tsc_ctc_ratio_n;
256 uint32_t tsc_ctc_ratio_d;
257 enum intel_pt_param_flags flags;
261 struct intel_pt_decoder;
263 struct intel_pt_decoder *intel_pt_decoder_new(struct intel_pt_params *params);
264 void intel_pt_decoder_free(struct intel_pt_decoder *decoder);
266 const struct intel_pt_state *intel_pt_decode(struct intel_pt_decoder *decoder);
268 int intel_pt_fast_forward(struct intel_pt_decoder *decoder, uint64_t timestamp);
270 unsigned char *intel_pt_find_overlap(unsigned char *buf_a, size_t len_a,
271 unsigned char *buf_b, size_t len_b,
272 bool have_tsc, bool *consecutive);
274 int intel_pt__strerror(int code, char *buf, size_t buflen);