OpenCSD - CoreSight Trace Decode Library  0.10.0
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"
42 #include "common/trc_ret_stack.h"
44 
45 class TrcStackElem;
46 class TrcStackElemParam;
47 class TrcStackElemCtxt;
48 
49 class TrcPktDecodeEtmV4I : public TrcPktDecodeBase<EtmV4ITrcPacket, EtmV4Config>
50 {
51 public:
53  TrcPktDecodeEtmV4I(int instIDNum);
54  virtual ~TrcPktDecodeEtmV4I();
55 
56 protected:
57  /* implementation packet decoding interface */
59  virtual ocsd_datapath_resp_t onEOT();
60  virtual ocsd_datapath_resp_t onReset();
61  virtual ocsd_datapath_resp_t onFlush();
62  virtual ocsd_err_t onProtocolConfig();
63  virtual const uint8_t getCoreSightTraceID() { return m_CSID; };
64 
65  /* local decode methods */
66  void initDecoder(); // initial state on creation (zeros all config)
67  void resetDecoder(); // reset state to start of decode. (moves state, retains config)
68 
69  ocsd_datapath_resp_t decodePacket(bool &Complete); // return true to indicate decode complete - can change FSM to commit state - return is false.
70  ocsd_datapath_resp_t commitElements(bool &Complete); // commit elements - may get wait response, or flag completion.
72 
73  void doTraceInfoPacket();
74  void updateContext(TrcStackElemCtxt *pCtxtElem);
75 
76  // process atom will output instruction trace, or no memory access trace elements.
77  ocsd_datapath_resp_t processAtom(const ocsd_atm_val, bool &bCont);
78 
79  // process an exception element - output instruction trace + exception generic type.
81 
82  // process a bad packet
83  ocsd_datapath_resp_t handleBadPacket(const char *reason);
84 
86  ocsd_datapath_resp_t outputTS(TrcStackElemParam *pParamElem, bool withCC);
88 
89 private:
90  void SetInstrInfoInAddrISA(const ocsd_vaddr_t addr_val, const uint8_t isa);
91 
92  ocsd_err_t traceInstrToWP(bool &bWPFound, const bool traceToAddrNext = false, const ocsd_vaddr_t nextAddrMatch = 0);
93 
94  ocsd_datapath_resp_t returnStackPop(); // pop return stack and update instruction address.
95 
96  ocsd_datapath_resp_t outputTraceRange(const bool executed, ocsd_trc_index_t index);
97 
98 //** intra packet state (see ETMv4 spec 6.2.1);
99 
100  // timestamping
101  uint64_t m_timestamp; // last broadcast global Timestamp.
102 
103  // state and context
104  uint32_t m_context_id; // most recent context ID
105  uint32_t m_vmid_id; // most recent VMID
106  bool m_is_secure; // true if Secure
107  bool m_is_64bit; // true if 64 bit
108 
109  // cycle counts
110  int m_cc_threshold;
111 
112  // speculative trace (unsupported at present in the decoder).
113  int m_curr_spec_depth;
114  int m_max_spec_depth;
115 
116  // data trace associative elements (unsupported at present in the decoder).
117  int m_p0_key;
118  int m_p0_key_max;
119 
120  // conditional non-branch trace - when data trace active (unsupported at present in the decoder)
121  int m_cond_c_key;
122  int m_cond_r_key;
123  int m_cond_key_max_incr;
124 
125  uint8_t m_CSID;
126 
127  bool m_IASize64;
128 
129 //** Other processor state;
130 
131  // trace decode FSM
132  typedef enum {
133  NO_SYNC,
134  WAIT_SYNC,
135  WAIT_TINFO,
136  DECODE_PKTS,
137  COMMIT_ELEM,
138  } processor_state_t;
139 
140  processor_state_t m_curr_state;
141 
142 //** P0 element stack
143  EtmV4P0Stack m_P0_stack;
144 
145  int m_P0_commit;
146 
147  // packet decode state
148  bool m_need_ctxt;
149  bool m_need_addr;
150  bool m_except_pending_addr;
151 
152  // exception packet processing state (may need excep elem only, range+excep, range+
153  typedef enum {
154  EXCEP_POP, // start of processing read exception packets off the stack and analyze
155  EXCEP_RANGE, // output a range element
156  EXCEP_NACC, // output a nacc element
157  EXCEP_EXCEP, // output an ecxeption element.
158  } excep_proc_state_t;
159 
160  excep_proc_state_t m_excep_proc;
161  etmv4_addr_val_t m_excep_addr;
162  uint32_t m_excep_number;
163  ocsd_trc_index_t m_excep_index;
164 
165  ocsd_instr_info m_instr_info;
166 
167  bool m_mem_nacc_pending;
168  ocsd_vaddr_t m_nacc_addr;
169 
170  ocsd_pe_context m_pe_context;
171  etmv4_trace_info_t m_trace_info;
172 
173  bool m_prev_overflow;
174 
175  bool m_flush_EOT;
176 
177  TrcAddrReturnStack m_return_stack;
178 
179 //** output element
180  OcsdTraceElement m_output_elem;
181 
182 };
183 
184 #endif // ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED
185 
186 /* End of File trc_pkt_decode_etmv4i.h */
ocsd_datapath_resp_t decodePacket(bool &Complete)
void updateContext(TrcStackElemCtxt *pCtxtElem)
uint64_t ocsd_vaddr_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
ocsd_datapath_resp_t flushEOT()
virtual ~TrcPktDecodeEtmV4I()
virtual ocsd_err_t onProtocolConfig()
enum _ocsd_atm_val ocsd_atm_val
enum _ocsd_err_t ocsd_err_t
virtual ocsd_datapath_resp_t processPacket()
virtual ocsd_datapath_resp_t onFlush()
ocsd_datapath_resp_t outputCC(TrcStackElemParam *pParamElem)
OpenCSD : Trace Packet decoder base class.
Generic trace element class.
Definition: trc_gen_elem.h:49
ocsd_datapath_resp_t handleBadPacket(const char *reason)
ocsd_datapath_resp_t commitElements(bool &Complete)
ocsd_datapath_resp_t outputEvent(TrcStackElemParam *pParamElem)
virtual ocsd_datapath_resp_t onEOT()
ocsd_datapath_resp_t processException()
ocsd_datapath_resp_t processAtom(const ocsd_atm_val, bool &bCont)
uint32_t ocsd_trc_index_t
Definition: ocsd_if_types.h:67
ocsd_datapath_resp_t outputTS(TrcStackElemParam *pParamElem, bool withCC)
virtual ocsd_datapath_resp_t onReset()
OpenCSD : Decoder Generic trace element output class.
virtual const uint8_t getCoreSightTraceID()