OpenCSD - CoreSight Trace Decode Library 1.5.1
Loading...
Searching...
No Matches
trc_pkt_decode_etmv4i.h
Go to the documentation of this file.
1/*
2 * \file trc_pkt_decode_etmv4i.h
3 * \brief OpenCSD : ETMv4 instruction decoder
4 *
5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
6 */
7
8/*
9 * Redistribution and use in source and binary forms, with or without modification,
10 * are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of the copyright holder nor the names of its contributors
20 * may be used to endorse or promote products derived from this software without
21 * specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 */
34
35#ifndef ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED
36#define ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED
37
41#include "common/trc_gen_elem.h"
45
46#define OCSD_ENV_INSTR_RANGE_LIMIT "OPENCSD_INSTR_RANGE_LIMIT"
47
48class TrcStackElem;
51
52class TrcPktDecodeEtmV4I : public TrcPktDecodeBase<EtmV4ITrcPacket, EtmV4Config>
53{
54public:
56 TrcPktDecodeEtmV4I(int instIDNum);
58
59protected:
60 /* implementation packet decoding interface */
66 virtual const uint8_t getCoreSightTraceID() { return m_CSID; };
67
68 /* local decode methods */
69 void initDecoder(); // initial state on creation (zeros all config)
70 void resetDecoder(); // reset state to start of decode. (moves state, retains config)
71 virtual void onFirstInitOK(); // override to set init related info.
72
73 ocsd_err_t decodePacket(); // decode packet into trace elements. return true to indicate decode complete - can change FSM to commit state - return is false.
74 ocsd_datapath_resp_t resolveElements(); // commit/cancel trace elements generated from latest / prior packets & send to output - may get wait response, or flag completion.
75 ocsd_err_t commitElements(); // commit elements - process element stack to generate output packets.
77 ocsd_err_t cancelElements(); // cancel elements. These not output
78 ocsd_err_t mispredictAtom(); // mispredict an atom
79 ocsd_err_t discardElements(); // discard elements and flush
80
83
84 // process atom will create instruction trace, or no memory access trace output elements.
86
87 // process an exception element - output instruction trace + exception generic type.
89
90 // process Q element
92
93 // process a source address element
95
96 // process an element that cannot be cancelled / discarded
98
99 // process marker elements
101
102 // process a transaction element
104
105 // process an Instrumentation element
107
108 // process a bad packet
110
111 // sequencing error on packet processing - optionally continue
113
114 // common packet error routine
116
118 ocsd_err_t addElemTS(TrcStackElemParam *pParamElem, bool withCC);
120
121private:
122 void SetInstrInfoInAddrISA(const ocsd_vaddr_t addr_val, const uint8_t isa);
123 const ocsd_isa calcISA(const bool SF, const uint8_t IS) const
124 {
125 if (SF)
126 return ocsd_isa_aarch64;
127 return (IS == 0) ? ocsd_isa_arm : ocsd_isa_thumb2;
128 }
129 typedef enum {
130 WP_NOT_FOUND,
131 WP_FOUND,
132 WP_NACC
133 } WP_res_t;
134
135 /* Optional run limit for decoded instruction range.
136 * Throw error if limit exceeded. Set by env var - use for debugging decode runs
137 * which may be running away due to bad data
138 */
139 int m_num_instr_range_limit;
140
141 typedef struct {
142 ocsd_vaddr_t st_addr;
143 ocsd_vaddr_t en_addr;
144 uint32_t num_instr;
145 } instr_range_t;
146
148 ocsd_err_t traceInstrToWP(instr_range_t &instr_range, WP_res_t &WPRes, const bool traceToAddrNext = false, const ocsd_vaddr_t nextAddrMatch = 0);
149
150 inline const bool WPFound(WP_res_t res) const { return (res == WP_FOUND); };
151 inline const bool WPNacc(WP_res_t res) const { return (res == WP_NACC); };
152
153 ocsd_err_t returnStackPop(); // pop return stack and update instruction address.
154
155 void setElemTraceRange(OcsdTraceElement &elemIn, const instr_range_t &addr_range, const bool executed, ocsd_trc_index_t index);
156 void setElemTraceRangeInstr(OcsdTraceElement &elemIn, const instr_range_t &addr_range,
157 const bool executed, ocsd_trc_index_t index, ocsd_instr_info &instr);
158
159 // true if we are ETE configured.
160 inline bool isETEConfig() {
161 return (m_config->MajVersion() >= ETE_ARCH_VERSION);
162 }
163
164 ocsd_mem_space_acc_t getCurrMemSpace();
165
166//** intra packet state (see ETMv4 spec 6.2.1);
167
168 // timestamping
169 uint64_t m_timestamp; // last broadcast global Timestamp.
170 bool m_ete_first_ts_marker;
171
172 // state and context
173 uint32_t m_context_id; // most recent context ID
174 uint32_t m_vmid_id; // most recent VMID
175 bool m_is_secure; // true if Secure
176 bool m_is_64bit; // true if 64 bit
177 uint8_t m_last_IS; // last instruction set value from address packet.
178
179 // cycle counts
180 int m_cc_threshold;
181
182 // speculative trace
183 int m_curr_spec_depth;
184 int m_max_spec_depth; // nax depth - from ID reg, beyond which auto-commit occurs
185 int m_unseen_spec_elem; // speculative elements at decode start
186
188#ifdef DATA_TRACE_SUPPORTED
189 // data trace associative elements (unsupported at present in the decoder).
190 int m_p0_key;
191 int m_p0_key_max;
192
193 // conditional non-branch trace - when data trace active (unsupported at present in the decoder)
194 int m_cond_c_key;
195 int m_cond_r_key;
196 int m_cond_key_max_incr;
197#endif
198
199 uint8_t m_CSID;
200
201 bool m_IASize64;
202
203//** Other processor state;
204
205 // trace decode FSM
206 typedef enum {
207 NO_SYNC,
208 WAIT_SYNC,
209 WAIT_TINFO,
210 DECODE_PKTS,
211 RESOLVE_ELEM,
212 } processor_state_t;
213
214 processor_state_t m_curr_state;
215 unsync_info_t m_unsync_eot_info;
216
217//** P0 element stack
218 EtmV4P0Stack m_P0_stack;
219
220 // element resolution
221 struct {
225 bool discard;
226 } m_elem_res;
227
229 const bool isElemForRes() const {
230 return (m_elem_res.P0_commit || m_elem_res.P0_cancel ||
231 m_elem_res.mispredict || m_elem_res.discard);
232 }
233
234 void clearElemRes() {
235 m_elem_res.P0_commit = 0;
236 m_elem_res.P0_cancel = 0;
237 m_elem_res.mispredict = false;
238 m_elem_res.discard = false;
239 }
240
241 // packet decode state
242 bool m_need_ctxt;
243 bool m_need_addr;
244 bool m_elem_pending_addr;
245
246 ocsd_instr_info m_instr_info;
247
248 etmv4_trace_info_t m_trace_info;
249
250 bool m_prev_overflow;
251
252 TrcAddrReturnStack m_return_stack;
253
254//** output element handling
255 OcsdGenElemStack m_out_elem;
256 OcsdTraceElement &outElem() { return m_out_elem.getCurrElem(); };
257};
258
259#endif // ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED
260
261/* End of File trc_pkt_decode_etmv4i.h */
OcsdTraceElement & getCurrElem()
get the current element.
Generic trace element class.
ocsd_err_t mispredictAtom()
ocsd_err_t handleBadPacket(const char *reason, ocsd_trc_index_t index=OCSD_BAD_TRC_INDEX)
ocsd_err_t handlePacketSeqErr(ocsd_err_t err, ocsd_trc_index_t index, const char *reason)
int P0_commit
number of elements to commit
TrcPktDecodeEtmV4I(int instIDNum)
ocsd_err_t cancelElements()
ocsd_err_t commitElemOnEOT()
ocsd_err_t processAtom(const ocsd_atm_val atom)
virtual ocsd_datapath_resp_t onEOT()
ocsd_err_t processTransElem(TrcStackElem *pElem)
ocsd_err_t processTS_CC_EventElem(TrcStackElem *pElem)
ocsd_err_t addElemCC(TrcStackElemParam *pParamElem)
ocsd_err_t discardElements()
ocsd_err_t commitElements()
ocsd_err_t processQElement()
bool discard
discard elements
virtual const uint8_t getCoreSightTraceID()
ocsd_err_t processITEElem(TrcStackElem *pElem)
ocsd_err_t handlePacketErr(ocsd_err_t err, ocsd_err_severity_t sev, ocsd_trc_index_t index, const char *reason)
bool mispredict
mispredict latest atom
virtual ocsd_datapath_resp_t onReset()
ocsd_err_t decodePacket()
ocsd_datapath_resp_t resolveElements()
virtual ocsd_datapath_resp_t onFlush()
virtual ocsd_err_t onProtocolConfig()
virtual void onFirstInitOK()
ocsd_err_t processMarkerElem(TrcStackElem *pElem)
ocsd_err_t processSourceAddress()
void updateContext(TrcStackElemCtxt *pCtxtElem, OcsdTraceElement &elem)
int P0_cancel
elements to cancel
ocsd_err_t addElemTS(TrcStackElemParam *pParamElem, bool withCC)
ocsd_err_t processException()
ocsd_err_t addElemEvent(TrcStackElemParam *pParamElem)
virtual ~TrcPktDecodeEtmV4I()
virtual ocsd_datapath_resp_t processPacket()
enum _unsync_info_t unsync_info_t
uint32_t ocsd_trc_index_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
#define OCSD_BAD_TRC_INDEX
enum _ocsd_mem_space_acc_t ocsd_mem_space_acc_t
enum _ocsd_err_severity_t ocsd_err_severity_t
enum _ocsd_err_t ocsd_err_t
enum _ocsd_isa ocsd_isa
uint64_t ocsd_vaddr_t
@ ocsd_isa_arm
@ ocsd_isa_aarch64
@ ocsd_isa_thumb2
const uint8_t MajVersion() const
enum _ocsd_atm_val ocsd_atm_val
#define ETE_ARCH_VERSION
OpenCSD : Decoder Generic trace element output class.
OpenCSD : Trace Packet decoder base class.