OpenCSD - CoreSight Trace Decode Library  0.12.1
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  const ocsd_isa calcISA(const bool SF, const uint8_t IS) const
92  {
93  if (SF)
94  return ocsd_isa_aarch64;
95  return (IS == 0) ? ocsd_isa_arm : ocsd_isa_thumb2;
96  }
97 
98  ocsd_err_t traceInstrToWP(bool &bWPFound, const bool traceToAddrNext = false, const ocsd_vaddr_t nextAddrMatch = 0);
99 
100  ocsd_datapath_resp_t returnStackPop(); // pop return stack and update instruction address.
101 
102  ocsd_datapath_resp_t outputTraceRange(const bool executed, ocsd_trc_index_t index);
103 
104 //** intra packet state (see ETMv4 spec 6.2.1);
105 
106  // timestamping
107  uint64_t m_timestamp; // last broadcast global Timestamp.
108 
109  // state and context
110  uint32_t m_context_id; // most recent context ID
111  uint32_t m_vmid_id; // most recent VMID
112  bool m_is_secure; // true if Secure
113  bool m_is_64bit; // true if 64 bit
114  uint8_t m_last_IS; // last instruction set value from address packet.
115 
116  // cycle counts
117  int m_cc_threshold;
118 
119  // speculative trace (unsupported at present in the decoder).
120  int m_curr_spec_depth;
121  int m_max_spec_depth;
122 
123  // data trace associative elements (unsupported at present in the decoder).
124  int m_p0_key;
125  int m_p0_key_max;
126 
127  // conditional non-branch trace - when data trace active (unsupported at present in the decoder)
128  int m_cond_c_key;
129  int m_cond_r_key;
130  int m_cond_key_max_incr;
131 
132  uint8_t m_CSID;
133 
134  bool m_IASize64;
135 
136 //** Other processor state;
137 
138  // trace decode FSM
139  typedef enum {
140  NO_SYNC,
141  WAIT_SYNC,
142  WAIT_TINFO,
143  DECODE_PKTS,
144  COMMIT_ELEM,
145  } processor_state_t;
146 
147  processor_state_t m_curr_state;
148 
149 //** P0 element stack
150  EtmV4P0Stack m_P0_stack;
151 
152  int m_P0_commit;
153 
154  // packet decode state
155  bool m_need_ctxt;
156  bool m_need_addr;
157  bool m_except_pending_addr;
158 
159  // exception packet processing state (may need excep elem only, range+excep, range+
160  typedef enum {
161  EXCEP_POP, // start of processing read exception packets off the stack and analyze
162  EXCEP_RANGE, // output a range element
163  EXCEP_NACC, // output a nacc element
164  EXCEP_CTXT, // output a ctxt element
165  EXCEP_EXCEP, // output an ecxeption element.
166  } excep_proc_state_t;
167 
168  struct {
169  excep_proc_state_t proc;
171  uint32_t number;
173  bool addr_b_tgt;
174  } m_excep_info;
175 
176  ocsd_instr_info m_instr_info;
177 
178  bool m_mem_nacc_pending;
179  ocsd_vaddr_t m_nacc_addr;
180 
181  ocsd_pe_context m_pe_context;
182  etmv4_trace_info_t m_trace_info;
183 
184  bool m_prev_overflow;
185 
186  bool m_flush_EOT;
187 
188  TrcAddrReturnStack m_return_stack;
189 
190 //** output element
191  OcsdTraceElement m_output_elem;
192 
193 };
194 
195 #endif // ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED
196 
197 /* End of File trc_pkt_decode_etmv4i.h */
_ocsd_instr_info
Definition: ocsd_if_types.h:382
ocsd_err_t
enum _ocsd_err_t ocsd_err_t
TrcPktDecodeEtmV4I::doTraceInfoPacket
void doTraceInfoPacket()
OcsdTraceElement
Generic trace element class.
Definition: trc_gen_elem.h:49
TrcPktDecodeEtmV4I::outputEvent
ocsd_datapath_resp_t outputEvent(TrcStackElemParam *pParamElem)
TrcStackElemParam
Definition: trc_etmv4_stack_elem.h:226
_etmv4_trace_info_t
Definition: trc_pkt_types_etmv4.h:151
TrcPktDecodeEtmV4I::getCoreSightTraceID
virtual const uint8_t getCoreSightTraceID()
Definition: trc_pkt_decode_etmv4i.h:63
TrcPktDecodeEtmV4I::processPacket
virtual ocsd_datapath_resp_t processPacket()
TrcStackElemCtxt
Definition: trc_etmv4_stack_elem.h:125
TrcPktDecodeEtmV4I::onReset
virtual ocsd_datapath_resp_t onReset()
TrcPktDecodeEtmV4I::outputCC
ocsd_datapath_resp_t outputCC(TrcStackElemParam *pParamElem)
TrcPktDecodeEtmV4I::decodePacket
ocsd_datapath_resp_t decodePacket(bool &Complete)
TrcPktDecodeEtmV4I::onFlush
virtual ocsd_datapath_resp_t onFlush()
TrcPktDecodeBase
Definition: trc_pkt_decode_base.h:180
_etmv4_addr_val_t
Definition: trc_pkt_types_etmv4.h:175
TrcPktDecodeEtmV4I::processException
ocsd_datapath_resp_t processException()
TrcPktDecodeEtmV4I::processAtom
ocsd_datapath_resp_t processAtom(const ocsd_atm_val, bool &bCont)
TrcPktDecodeEtmV4I::resetDecoder
void resetDecoder()
TrcPktDecodeEtmV4I::updateContext
void updateContext(TrcStackElemCtxt *pCtxtElem)
ocsd_vaddr_t
uint64_t ocsd_vaddr_t
Definition: ocsd_if_types.h:308
TrcPktDecodeEtmV4I::addr
etmv4_addr_val_t addr
excetion return address.
Definition: trc_pkt_decode_etmv4i.h:170
TrcPktDecodeEtmV4I::initDecoder
void initDecoder()
TrcPktDecodeEtmV4I
Definition: trc_pkt_decode_etmv4i.h:49
trc_gen_elem.h
OpenCSD : Decoder Generic trace element output class.
ocsd_atm_val
enum _ocsd_atm_val ocsd_atm_val
ocsd_isa_thumb2
Definition: ocsd_if_types.h:327
EtmV4P0Stack
Definition: trc_etmv4_stack_elem.h:250
TrcAddrReturnStack
Definition: trc_ret_stack.h:53
ocsd_isa_aarch64
Definition: ocsd_if_types.h:328
TrcPktDecodeEtmV4I::outputTS
ocsd_datapath_resp_t outputTS(TrcStackElemParam *pParamElem, bool withCC)
TrcPktDecodeEtmV4I::~TrcPktDecodeEtmV4I
virtual ~TrcPktDecodeEtmV4I()
_ocsd_pe_context
Definition: ocsd_if_types.h:406
trc_ret_stack.h
TrcPktDecodeEtmV4I::commitElements
ocsd_datapath_resp_t commitElements(bool &Complete)
trc_cmp_cfg_etmv4.h
ocsd_trc_index_t
uint32_t ocsd_trc_index_t
Definition: ocsd_if_types.h:67
TrcStackElem
Definition: trc_etmv4_stack_elem.h:68
TrcPktDecodeEtmV4I::proc
excep_proc_state_t proc
state of exception processing
Definition: trc_pkt_decode_etmv4i.h:169
trc_pkt_decode_base.h
OpenCSD : Trace Packet decoder base class.
TrcPktDecodeEtmV4I::index
ocsd_trc_index_t index
trace index for exception element
Definition: trc_pkt_decode_etmv4i.h:172
TrcPktDecodeEtmV4I::onProtocolConfig
virtual ocsd_err_t onProtocolConfig()
TrcPktDecodeEtmV4I::flushEOT
ocsd_datapath_resp_t flushEOT()
ocsd_isa_arm
Definition: ocsd_if_types.h:326
ocsd_isa
enum _ocsd_isa ocsd_isa
ocsd_datapath_resp_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
TrcPktDecodeEtmV4I::handleBadPacket
ocsd_datapath_resp_t handleBadPacket(const char *reason)
TrcPktDecodeEtmV4I::number
uint32_t number
exception number.
Definition: trc_pkt_decode_etmv4i.h:171
TrcPktDecodeEtmV4I::TrcPktDecodeEtmV4I
TrcPktDecodeEtmV4I()
TrcPktDecodeEtmV4I::addr_b_tgt
bool addr_b_tgt
return address is also branch tgt address.
Definition: trc_pkt_decode_etmv4i.h:173
trc_pkt_elem_etmv4i.h
trc_etmv4_stack_elem.h
TrcPktDecodeEtmV4I::onEOT
virtual ocsd_datapath_resp_t onEOT()