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 #define OCSD_ENV_INSTR_RANGE_LIMIT "OPENCSD_INSTR_RANGE_LIMIT" 47 48 class TrcStackElem; 49 class TrcStackElemParam; 50 class TrcStackElemCtxt; 51 52 class TrcPktDecodeEtmV4I : public TrcPktDecodeBase<EtmV4ITrcPacket, EtmV4Config> 53 { 54 public: 55 TrcPktDecodeEtmV4I(); 56 TrcPktDecodeEtmV4I(int instIDNum); 57 virtual ~TrcPktDecodeEtmV4I(); 58 59 protected: 60 /* implementation packet decoding interface */ 61 virtual ocsd_datapath_resp_t processPacket(); 62 virtual ocsd_datapath_resp_t onEOT(); 63 virtual ocsd_datapath_resp_t onReset(); 64 virtual ocsd_datapath_resp_t onFlush(); 65 virtual ocsd_err_t onProtocolConfig(); getCoreSightTraceID()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. 76 ocsd_err_t commitElemOnEOT(); 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 81 void doTraceInfoPacket(); 82 void updateContext(TrcStackElemCtxt *pCtxtElem, OcsdTraceElement &elem); 83 84 // process atom will create instruction trace, or no memory access trace output elements. 85 ocsd_err_t processAtom(const ocsd_atm_val atom); 86 87 // process an exception element - output instruction trace + exception generic type. 88 ocsd_err_t processException(); 89 90 // process Q element 91 ocsd_err_t processQElement(); 92 93 // process a source address element 94 ocsd_err_t processSourceAddress(); 95 96 // process an element that cannot be cancelled / discarded 97 ocsd_err_t processTS_CC_EventElem(TrcStackElem *pElem); 98 99 // process marker elements 100 ocsd_err_t processMarkerElem(TrcStackElem *pElem); 101 102 // process a transaction element 103 ocsd_err_t processTransElem(TrcStackElem *pElem); 104 105 // process an Instrumentation element 106 ocsd_err_t processITEElem(TrcStackElem *pElem); 107 108 // process a bad packet 109 ocsd_err_t handleBadPacket(const char *reason, ocsd_trc_index_t index = OCSD_BAD_TRC_INDEX); 110 111 // sequencing error on packet processing - optionally continue 112 ocsd_err_t handlePacketSeqErr(ocsd_err_t err, ocsd_trc_index_t index, const char *reason); 113 114 // common packet error routine 115 ocsd_err_t handlePacketErr(ocsd_err_t err, ocsd_err_severity_t sev, ocsd_trc_index_t index, const char *reason); 116 117 ocsd_err_t addElemCC(TrcStackElemParam *pParamElem); 118 ocsd_err_t addElemTS(TrcStackElemParam *pParamElem, bool withCC); 119 ocsd_err_t addElemEvent(TrcStackElemParam *pParamElem); 120 121 private: 122 void SetInstrInfoInAddrISA(const ocsd_vaddr_t addr_val, const uint8_t isa); calcISA(const bool SF,const uint8_t IS)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 147 //!< follow instructions from the current address to a WP. true if good, false if memory cannot be accessed. 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 WPFound(WP_res_t res)150 inline const bool WPFound(WP_res_t res) const { return (res == WP_FOUND); }; WPNacc(WP_res_t res)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. isETEConfig()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 187 /** Remove elements that are associated with data trace */ 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; //!< Coresight trace ID for this decoder. 200 201 bool m_IASize64; //!< True if 64 bit instruction addresses supported. 202 203 //** Other processor state; 204 205 // trace decode FSM 206 typedef enum { 207 NO_SYNC, //!< pre start trace - init state or after reset or overflow, loss of sync. 208 WAIT_SYNC, //!< waiting for sync packet. 209 WAIT_TINFO, //!< waiting for trace info packet. 210 DECODE_PKTS, //!< processing packets - creating decode elements on stack 211 RESOLVE_ELEM, //!< analyze / resolve decode elements - create generic trace elements and pass on. 212 } processor_state_t; 213 214 processor_state_t m_curr_state; 215 unsync_info_t m_unsync_eot_info; //!< addition info when / why unsync / eot 216 217 //** P0 element stack 218 EtmV4P0Stack m_P0_stack; //!< P0 decode element stack 219 220 // element resolution 221 struct { 222 int P0_commit; //!< number of elements to commit 223 int P0_cancel; //!< elements to cancel 224 bool mispredict; //!< mispredict latest atom 225 bool discard; //!< discard elements 226 } m_elem_res; 227 228 //! true if any of the element resolution fields are non-zero isElemForRes()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 clearElemRes()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; //!< need context to continue 243 bool m_need_addr; //!< need an address to continue 244 bool m_elem_pending_addr; //!< next address packet is needed for prev element. 245 246 ocsd_instr_info m_instr_info; //!< instruction info for code follower - in address is the next to be decoded. 247 248 etmv4_trace_info_t m_trace_info; //!< trace info for this trace run. 249 250 bool m_prev_overflow; 251 252 TrcAddrReturnStack m_return_stack; //!< the address return stack. 253 254 //** output element handling 255 OcsdGenElemStack m_out_elem; //!< output element stack. outElem()256 OcsdTraceElement &outElem() { return m_out_elem.getCurrElem(); }; //!< current out element 257 }; 258 259 #endif // ARM_TRC_PKT_DECODE_ETMV4I_H_INCLUDED 260 261 /* End of File trc_pkt_decode_etmv4i.h */ 262