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 38 #include "common/trc_pkt_decode_base.h" 39 #include "opencsd/etmv4/trc_pkt_elem_etmv4i.h" 40 #include "opencsd/etmv4/trc_cmp_cfg_etmv4.h" 41 #include "common/trc_gen_elem.h" 42 #include "common/trc_ret_stack.h" 43 #include "common/ocsd_gen_elem_stack.h" 44 #include "opencsd/etmv4/trc_etmv4_stack_elem.h" 45 46 class TrcStackElem; 47 class TrcStackElemParam; 48 class TrcStackElemCtxt; 49 50 class TrcPktDecodeEtmV4I : public TrcPktDecodeBase<EtmV4ITrcPacket, EtmV4Config> 51 { 52 public: 53 TrcPktDecodeEtmV4I(); 54 TrcPktDecodeEtmV4I(int instIDNum); 55 virtual ~TrcPktDecodeEtmV4I(); 56 57 protected: 58 /* implementation packet decoding interface */ 59 virtual ocsd_datapath_resp_t processPacket(); 60 virtual ocsd_datapath_resp_t onEOT(); 61 virtual ocsd_datapath_resp_t onReset(); 62 virtual ocsd_datapath_resp_t onFlush(); 63 virtual ocsd_err_t onProtocolConfig(); getCoreSightTraceID()64 virtual const uint8_t getCoreSightTraceID() { return m_CSID; }; 65 66 /* local decode methods */ 67 void initDecoder(); // initial state on creation (zeros all config) 68 void resetDecoder(); // reset state to start of decode. (moves state, retains config) 69 virtual void onFirstInitOK(); // override to set init related info. 70 71 ocsd_err_t decodePacket(); // decode packet into trace elements. return true to indicate decode complete - can change FSM to commit state - return is false. 72 ocsd_datapath_resp_t resolveElements(); // commit/cancel trace elements generated from latest / prior packets & send to output - may get wait response, or flag completion. 73 ocsd_err_t commitElements(); // commit elements - process element stack to generate output packets. 74 ocsd_err_t commitElemOnEOT(); 75 ocsd_err_t cancelElements(); // cancel elements. These not output 76 ocsd_err_t mispredictAtom(); // mispredict an atom 77 ocsd_err_t discardElements(); // discard elements and flush 78 79 void doTraceInfoPacket(); 80 void updateContext(TrcStackElemCtxt *pCtxtElem, OcsdTraceElement &elem); 81 82 // process atom will create instruction trace, or no memory access trace output elements. 83 ocsd_err_t processAtom(const ocsd_atm_val atom); 84 85 // process an exception element - output instruction trace + exception generic type. 86 ocsd_err_t processException(); 87 88 // process Q element 89 ocsd_err_t processQElement(); 90 91 // process a source address element 92 ocsd_err_t processSourceAddress(); 93 94 // process an element that cannot be cancelled / discarded 95 ocsd_err_t processTS_CC_EventElem(TrcStackElem *pElem); 96 97 // process marker elements 98 ocsd_err_t processMarkerElem(TrcStackElem *pElem); 99 100 // process a transaction element 101 ocsd_err_t processTransElem(TrcStackElem *pElem); 102 103 // process a bad packet 104 ocsd_err_t handleBadPacket(const char *reason, ocsd_trc_index_t index = OCSD_BAD_TRC_INDEX); 105 106 // sequencing error on packet processing - optionally continue 107 ocsd_err_t handlePacketSeqErr(ocsd_err_t err, ocsd_trc_index_t index, const char *reason); 108 109 // common packet error routine 110 ocsd_err_t handlePacketErr(ocsd_err_t err, ocsd_err_severity_t sev, ocsd_trc_index_t index, const char *reason); 111 112 ocsd_err_t addElemCC(TrcStackElemParam *pParamElem); 113 ocsd_err_t addElemTS(TrcStackElemParam *pParamElem, bool withCC); 114 ocsd_err_t addElemEvent(TrcStackElemParam *pParamElem); 115 116 private: 117 void SetInstrInfoInAddrISA(const ocsd_vaddr_t addr_val, const uint8_t isa); calcISA(const bool SF,const uint8_t IS)118 const ocsd_isa calcISA(const bool SF, const uint8_t IS) const 119 { 120 if (SF) 121 return ocsd_isa_aarch64; 122 return (IS == 0) ? ocsd_isa_arm : ocsd_isa_thumb2; 123 } 124 typedef enum { 125 WP_NOT_FOUND, 126 WP_FOUND, 127 WP_NACC 128 } WP_res_t; 129 130 typedef struct { 131 ocsd_vaddr_t st_addr; 132 ocsd_vaddr_t en_addr; 133 uint32_t num_instr; 134 } instr_range_t; 135 136 //!< follow instructions from the current address to a WP. true if good, false if memory cannot be accessed. 137 ocsd_err_t traceInstrToWP(instr_range_t &instr_range, WP_res_t &WPRes, const bool traceToAddrNext = false, const ocsd_vaddr_t nextAddrMatch = 0); 138 WPFound(WP_res_t res)139 inline const bool WPFound(WP_res_t res) const { return (res == WP_FOUND); }; WPNacc(WP_res_t res)140 inline const bool WPNacc(WP_res_t res) const { return (res == WP_NACC); }; 141 142 ocsd_err_t returnStackPop(); // pop return stack and update instruction address. 143 144 void setElemTraceRange(OcsdTraceElement &elemIn, const instr_range_t &addr_range, const bool executed, ocsd_trc_index_t index); 145 void setElemTraceRangeInstr(OcsdTraceElement &elemIn, const instr_range_t &addr_range, 146 const bool executed, ocsd_trc_index_t index, ocsd_instr_info &instr); 147 148 // true if we are ETE configured. isETEConfig()149 inline bool isETEConfig() { 150 return (m_config->MajVersion() >= ETE_ARCH_VERSION); 151 } 152 153 ocsd_mem_space_acc_t getCurrMemSpace(); 154 155 //** intra packet state (see ETMv4 spec 6.2.1); 156 157 // timestamping 158 uint64_t m_timestamp; // last broadcast global Timestamp. 159 bool m_ete_first_ts_marker; 160 161 // state and context 162 uint32_t m_context_id; // most recent context ID 163 uint32_t m_vmid_id; // most recent VMID 164 bool m_is_secure; // true if Secure 165 bool m_is_64bit; // true if 64 bit 166 uint8_t m_last_IS; // last instruction set value from address packet. 167 168 // cycle counts 169 int m_cc_threshold; 170 171 // speculative trace 172 int m_curr_spec_depth; 173 int m_max_spec_depth; // nax depth - from ID reg, beyond which auto-commit occurs 174 int m_unseen_spec_elem; // speculative elements at decode start 175 176 /** Remove elements that are associated with data trace */ 177 #ifdef DATA_TRACE_SUPPORTED 178 // data trace associative elements (unsupported at present in the decoder). 179 int m_p0_key; 180 int m_p0_key_max; 181 182 // conditional non-branch trace - when data trace active (unsupported at present in the decoder) 183 int m_cond_c_key; 184 int m_cond_r_key; 185 int m_cond_key_max_incr; 186 #endif 187 188 uint8_t m_CSID; //!< Coresight trace ID for this decoder. 189 190 bool m_IASize64; //!< True if 64 bit instruction addresses supported. 191 192 //** Other processor state; 193 194 // trace decode FSM 195 typedef enum { 196 NO_SYNC, //!< pre start trace - init state or after reset or overflow, loss of sync. 197 WAIT_SYNC, //!< waiting for sync packet. 198 WAIT_TINFO, //!< waiting for trace info packet. 199 DECODE_PKTS, //!< processing packets - creating decode elements on stack 200 RESOLVE_ELEM, //!< analyze / resolve decode elements - create generic trace elements and pass on. 201 } processor_state_t; 202 203 processor_state_t m_curr_state; 204 unsync_info_t m_unsync_eot_info; //!< addition info when / why unsync / eot 205 206 //** P0 element stack 207 EtmV4P0Stack m_P0_stack; //!< P0 decode element stack 208 209 // element resolution 210 struct { 211 int P0_commit; //!< number of elements to commit 212 int P0_cancel; //!< elements to cancel 213 bool mispredict; //!< mispredict latest atom 214 bool discard; //!< discard elements 215 } m_elem_res; 216 217 //! true if any of the element resolution fields are non-zero isElemForRes()218 const bool isElemForRes() const { 219 return (m_elem_res.P0_commit || m_elem_res.P0_cancel || 220 m_elem_res.mispredict || m_elem_res.discard); 221 } 222 clearElemRes()223 void clearElemRes() { 224 m_elem_res.P0_commit = 0; 225 m_elem_res.P0_cancel = 0; 226 m_elem_res.mispredict = false; 227 m_elem_res.discard = false; 228 } 229 230 // packet decode state 231 bool m_need_ctxt; //!< need context to continue 232 bool m_need_addr; //!< need an address to continue 233 bool m_elem_pending_addr; //!< next address packet is needed for prev element. 234 235 ocsd_instr_info m_instr_info; //!< instruction info for code follower - in address is the next to be decoded. 236 237 etmv4_trace_info_t m_trace_info; //!< trace info for this trace run. 238 239 bool m_prev_overflow; 240 241 TrcAddrReturnStack m_return_stack; //!< the address return stack. 242 243 //** output element handling 244 OcsdGenElemStack m_out_elem; //!< output element stack. outElem()245 OcsdTraceElement &outElem() { return m_out_elem.getCurrElem(); }; //!< current out element 246 }; 247 248 #endif // ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED 249 250 /* End of File trc_pkt_decode_etmv4i.h */ 251