xref: /linux/tools/perf/util/arm-spe-decoder/arm-spe-decoder.h (revision c7c198b3ed686300eaf84e679cee7e0f94befa8f)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * arm_spe_decoder.h: Arm Statistical Profiling Extensions support
4  * Copyright (c) 2019-2020, Arm Ltd.
5  */
6 
7 #ifndef INCLUDE__ARM_SPE_DECODER_H__
8 #define INCLUDE__ARM_SPE_DECODER_H__
9 
10 #include <stdbool.h>
11 #include <stddef.h>
12 #include <stdint.h>
13 
14 #include "arm-spe-pkt-decoder.h"
15 
16 #define ARM_SPE_L1D_ACCESS		BIT(EV_L1D_ACCESS)
17 #define ARM_SPE_L1D_MISS		BIT(EV_L1D_REFILL)
18 #define ARM_SPE_LLC_ACCESS		BIT(EV_LLC_ACCESS)
19 #define ARM_SPE_LLC_MISS		BIT(EV_LLC_MISS)
20 #define ARM_SPE_TLB_ACCESS		BIT(EV_TLB_ACCESS)
21 #define ARM_SPE_TLB_MISS		BIT(EV_TLB_WALK)
22 #define ARM_SPE_BRANCH_MISS		BIT(EV_MISPRED)
23 #define ARM_SPE_BRANCH_NOT_TAKEN	BIT(EV_NOT_TAKEN)
24 #define ARM_SPE_REMOTE_ACCESS		BIT(EV_REMOTE_ACCESS)
25 #define ARM_SPE_SVE_PARTIAL_PRED	BIT(EV_PARTIAL_PREDICATE)
26 #define ARM_SPE_SVE_EMPTY_PRED		BIT(EV_EMPTY_PREDICATE)
27 #define ARM_SPE_IN_TXN			BIT(EV_TRANSACTIONAL)
28 #define ARM_SPE_L2D_ACCESS		BIT(EV_L2D_ACCESS)
29 #define ARM_SPE_L2D_MISS		BIT(EV_L2D_MISS)
30 #define ARM_SPE_RECENTLY_FETCHED	BIT(EV_RECENTLY_FETCHED)
31 #define ARM_SPE_DATA_SNOOPED		BIT(EV_DATA_SNOOPED)
32 #define ARM_SPE_HITM			BIT(EV_CACHE_DATA_MODIFIED)
33 
34 enum arm_spe_op_type {
35 	/* First level operation type */
36 	ARM_SPE_OP_OTHER	= 1 << 0,
37 	ARM_SPE_OP_LDST		= 1 << 1,
38 	ARM_SPE_OP_BRANCH_ERET	= 1 << 2,
39 
40 	/* Second level operation type for OTHER */
41 	ARM_SPE_OP_SVE_OTHER		= 1 << 16,
42 
43 	/* Second level operation type for LDST */
44 	ARM_SPE_OP_LD			= 1 << 16,
45 	ARM_SPE_OP_ST			= 1 << 17,
46 	ARM_SPE_OP_ATOMIC		= 1 << 18,
47 	ARM_SPE_OP_EXCL			= 1 << 19,
48 	ARM_SPE_OP_AR			= 1 << 20,
49 	ARM_SPE_OP_SIMD_FP		= 1 << 21,
50 	ARM_SPE_OP_GP_REG		= 1 << 22,
51 	ARM_SPE_OP_UNSPEC_REG		= 1 << 23,
52 	ARM_SPE_OP_NV_SYSREG		= 1 << 24,
53 	ARM_SPE_OP_SVE_LDST		= 1 << 25,
54 
55 	/* Second level operation type for BRANCH_ERET */
56 	ARM_SPE_OP_BR_COND		= 1 << 16,
57 	ARM_SPE_OP_BR_INDIRECT		= 1 << 17,
58 	ARM_SPE_OP_BR_GCS		= 1 << 18,
59 	ARM_SPE_OP_BR_CR_BL		= 1 << 19,
60 	ARM_SPE_OP_BR_CR_RET		= 1 << 20,
61 	ARM_SPE_OP_BR_CR_NON_BL_RET	= 1 << 21,
62 };
63 
64 enum arm_spe_common_data_source {
65 	ARM_SPE_COMMON_DS_L1D		= 0x0,
66 	ARM_SPE_COMMON_DS_L2		= 0x8,
67 	ARM_SPE_COMMON_DS_PEER_CORE	= 0x9,
68 	ARM_SPE_COMMON_DS_LOCAL_CLUSTER = 0xa,
69 	ARM_SPE_COMMON_DS_SYS_CACHE	= 0xb,
70 	ARM_SPE_COMMON_DS_PEER_CLUSTER	= 0xc,
71 	ARM_SPE_COMMON_DS_REMOTE	= 0xd,
72 	ARM_SPE_COMMON_DS_DRAM		= 0xe,
73 };
74 
75 enum arm_spe_ampereone_data_source {
76 	ARM_SPE_AMPEREONE_LOCAL_CHIP_CACHE_OR_DEVICE    = 0x0,
77 	ARM_SPE_AMPEREONE_SLC                           = 0x3,
78 	ARM_SPE_AMPEREONE_REMOTE_CHIP_CACHE             = 0x5,
79 	ARM_SPE_AMPEREONE_DDR                           = 0x7,
80 	ARM_SPE_AMPEREONE_L1D                           = 0x8,
81 	ARM_SPE_AMPEREONE_L2D                           = 0x9,
82 };
83 
84 enum arm_spe_hisi_hip_data_source {
85 	ARM_SPE_HISI_HIP_PEER_CPU		= 0,
86 	ARM_SPE_HISI_HIP_PEER_CPU_HITM		= 1,
87 	ARM_SPE_HISI_HIP_L3			= 2,
88 	ARM_SPE_HISI_HIP_L3_HITM		= 3,
89 	ARM_SPE_HISI_HIP_PEER_CLUSTER		= 4,
90 	ARM_SPE_HISI_HIP_PEER_CLUSTER_HITM	= 5,
91 	ARM_SPE_HISI_HIP_REMOTE_SOCKET		= 6,
92 	ARM_SPE_HISI_HIP_REMOTE_SOCKET_HITM	= 7,
93 	ARM_SPE_HISI_HIP_LOCAL_MEM		= 8,
94 	ARM_SPE_HISI_HIP_REMOTE_MEM		= 9,
95 	ARM_SPE_HISI_HIP_NC_DEV			= 13,
96 	ARM_SPE_HISI_HIP_L2			= 16,
97 	ARM_SPE_HISI_HIP_L2_HITM		= 17,
98 	ARM_SPE_HISI_HIP_L1			= 18,
99 };
100 
101 struct arm_spe_record {
102 	u64 type;
103 	int err;
104 	u32 op;
105 	u32 latency;
106 	u64 from_ip;
107 	u64 to_ip;
108 	u64 prev_br_tgt;
109 	u64 timestamp;
110 	u64 virt_addr;
111 	u64 phys_addr;
112 	u64 context_id;
113 	u16 source;
114 };
115 
116 struct arm_spe_insn;
117 
118 struct arm_spe_buffer {
119 	const unsigned char *buf;
120 	size_t len;
121 	u64 offset;
122 	u64 trace_nr;
123 };
124 
125 struct arm_spe_params {
126 	int (*get_trace)(struct arm_spe_buffer *buffer, void *data);
127 	void *data;
128 };
129 
130 struct arm_spe_decoder {
131 	int (*get_trace)(struct arm_spe_buffer *buffer, void *data);
132 	void *data;
133 	struct arm_spe_record record;
134 
135 	const unsigned char *buf;
136 	size_t len;
137 
138 	struct arm_spe_pkt packet;
139 };
140 
141 struct arm_spe_decoder *arm_spe_decoder_new(struct arm_spe_params *params);
142 void arm_spe_decoder_free(struct arm_spe_decoder *decoder);
143 
144 int arm_spe_decode(struct arm_spe_decoder *decoder);
145 
146 #endif
147