xref: /linux/tools/perf/util/arm-spe-decoder/arm-spe-decoder.h (revision ec714e371f22f716a04e6ecb2a24988c92b26911)
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 	ARM_SPE_OP_SVE_FP		= 1 << 17,
43 	ARM_SPE_OP_SVE_PRED_OTHER	= 1 << 18,
44 
45 	/* Second level operation type for LDST */
46 	ARM_SPE_OP_LD			= 1 << 16,
47 	ARM_SPE_OP_ST			= 1 << 17,
48 	ARM_SPE_OP_ATOMIC		= 1 << 18,
49 	ARM_SPE_OP_EXCL			= 1 << 19,
50 	ARM_SPE_OP_AR			= 1 << 20,
51 	ARM_SPE_OP_SIMD_FP		= 1 << 21,
52 	ARM_SPE_OP_GP_REG		= 1 << 22,
53 	ARM_SPE_OP_UNSPEC_REG		= 1 << 23,
54 	ARM_SPE_OP_NV_SYSREG		= 1 << 24,
55 	ARM_SPE_OP_SVE_LDST		= 1 << 25,
56 	ARM_SPE_OP_SVE_PRED_LDST	= 1 << 26,
57 	ARM_SPE_OP_SVE_SG		= 1 << 27,
58 
59 	/* Second level operation type for BRANCH_ERET */
60 	ARM_SPE_OP_BR_COND		= 1 << 16,
61 	ARM_SPE_OP_BR_INDIRECT		= 1 << 17,
62 	ARM_SPE_OP_BR_GCS		= 1 << 18,
63 	ARM_SPE_OP_BR_CR_BL		= 1 << 19,
64 	ARM_SPE_OP_BR_CR_RET		= 1 << 20,
65 	ARM_SPE_OP_BR_CR_NON_BL_RET	= 1 << 21,
66 };
67 
68 enum arm_spe_common_data_source {
69 	ARM_SPE_COMMON_DS_L1D		= 0x0,
70 	ARM_SPE_COMMON_DS_L2		= 0x8,
71 	ARM_SPE_COMMON_DS_PEER_CORE	= 0x9,
72 	ARM_SPE_COMMON_DS_LOCAL_CLUSTER = 0xa,
73 	ARM_SPE_COMMON_DS_SYS_CACHE	= 0xb,
74 	ARM_SPE_COMMON_DS_PEER_CLUSTER	= 0xc,
75 	ARM_SPE_COMMON_DS_REMOTE	= 0xd,
76 	ARM_SPE_COMMON_DS_DRAM		= 0xe,
77 };
78 
79 enum arm_spe_ampereone_data_source {
80 	ARM_SPE_AMPEREONE_LOCAL_CHIP_CACHE_OR_DEVICE    = 0x0,
81 	ARM_SPE_AMPEREONE_SLC                           = 0x3,
82 	ARM_SPE_AMPEREONE_REMOTE_CHIP_CACHE             = 0x5,
83 	ARM_SPE_AMPEREONE_DDR                           = 0x7,
84 	ARM_SPE_AMPEREONE_L1D                           = 0x8,
85 	ARM_SPE_AMPEREONE_L2D                           = 0x9,
86 };
87 
88 enum arm_spe_hisi_hip_data_source {
89 	ARM_SPE_HISI_HIP_PEER_CPU		= 0,
90 	ARM_SPE_HISI_HIP_PEER_CPU_HITM		= 1,
91 	ARM_SPE_HISI_HIP_L3			= 2,
92 	ARM_SPE_HISI_HIP_L3_HITM		= 3,
93 	ARM_SPE_HISI_HIP_PEER_CLUSTER		= 4,
94 	ARM_SPE_HISI_HIP_PEER_CLUSTER_HITM	= 5,
95 	ARM_SPE_HISI_HIP_REMOTE_SOCKET		= 6,
96 	ARM_SPE_HISI_HIP_REMOTE_SOCKET_HITM	= 7,
97 	ARM_SPE_HISI_HIP_LOCAL_MEM		= 8,
98 	ARM_SPE_HISI_HIP_REMOTE_MEM		= 9,
99 	ARM_SPE_HISI_HIP_NC_DEV			= 13,
100 	ARM_SPE_HISI_HIP_L2			= 16,
101 	ARM_SPE_HISI_HIP_L2_HITM		= 17,
102 	ARM_SPE_HISI_HIP_L1			= 18,
103 };
104 
105 struct arm_spe_record {
106 	u64 type;
107 	int err;
108 	u32 op;
109 	u32 latency;
110 	u64 from_ip;
111 	u64 to_ip;
112 	u64 prev_br_tgt;
113 	u64 timestamp;
114 	u64 virt_addr;
115 	u64 phys_addr;
116 	u64 context_id;
117 	u16 source;
118 };
119 
120 struct arm_spe_insn;
121 
122 struct arm_spe_buffer {
123 	const unsigned char *buf;
124 	size_t len;
125 	u64 offset;
126 	u64 trace_nr;
127 };
128 
129 struct arm_spe_params {
130 	int (*get_trace)(struct arm_spe_buffer *buffer, void *data);
131 	void *data;
132 };
133 
134 struct arm_spe_decoder {
135 	int (*get_trace)(struct arm_spe_buffer *buffer, void *data);
136 	void *data;
137 	struct arm_spe_record record;
138 
139 	const unsigned char *buf;
140 	size_t len;
141 
142 	struct arm_spe_pkt packet;
143 };
144 
145 struct arm_spe_decoder *arm_spe_decoder_new(struct arm_spe_params *params);
146 void arm_spe_decoder_free(struct arm_spe_decoder *decoder);
147 
148 int arm_spe_decode(struct arm_spe_decoder *decoder);
149 
150 #endif
151