2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Steve Reinhardt
32 #ifndef __INSTRECORD_HH__
33 #define __INSTRECORD_HH__
35 #include "base/bigint.hh"
36 #include "base/trace.hh"
37 #include "base/types.hh"
38 #include "cpu/inst_seq.hh" // for InstSeqNum
39 #include "cpu/static_inst.hh"
40 #include "sim/sim_object.hh"
51 // The following fields are initialized by the constructor and
52 // thus guaranteed to be valid.
53 ThreadContext *thread;
54 // need to make this ref-counted so it doesn't go away before we
56 StaticInstPtr staticInst;
58 StaticInstPtr macroStaticInst;
62 // The remaining fields are only valid for particular instruction
63 // types (e.g, addresses for memory ops) or when particular
64 // options are enabled (e.g., tracing full register contents).
65 // Each data field has an associated valid flag to indicate
66 // whether the data field is valid.
76 DataInt8 = 1, // set to equal number of bytes
90 InstRecord(Tick _when, ThreadContext *_thread,
91 const StaticInstPtr _staticInst,
92 TheISA::PCState _pc, bool spec,
93 const StaticInstPtr _macroStaticInst = NULL)
94 : when(_when), thread(_thread),
95 staticInst(_staticInst), pc(_pc),
96 macroStaticInst(_macroStaticInst),
97 misspeculating(spec), predicate(true), addr(0), addr_valid(false),
98 data_status(DataInvalid),
99 fetch_seq(0), fetch_seq_valid(false), cp_seq(0), cp_seq_valid(false)
103 virtual ~InstRecord() { }
105 void setWhen(Tick new_when) { when = new_when; }
107 void setAddr(Addr a) { addr = a; addr_valid = true; }
109 void setData(Twin64_t d) { data.as_int = d.a; data_status = DataInt64; }
110 void setData(Twin32_t d) { data.as_int = d.a; data_status = DataInt32; }
111 void setData(uint64_t d) { data.as_int = d; data_status = DataInt64; }
112 void setData(uint32_t d) { data.as_int = d; data_status = DataInt32; }
113 void setData(uint16_t d) { data.as_int = d; data_status = DataInt16; }
114 void setData(uint8_t d) { data.as_int = d; data_status = DataInt8; }
116 void setData(int64_t d) { setData((uint64_t)d); }
117 void setData(int32_t d) { setData((uint32_t)d); }
118 void setData(int16_t d) { setData((uint16_t)d); }
119 void setData(int8_t d) { setData((uint8_t)d); }
121 void setData(double d) { data.as_double = d; data_status = DataDouble; }
123 void setFetchSeq(InstSeqNum seq)
124 { fetch_seq = seq; fetch_seq_valid = true; }
126 void setCPSeq(InstSeqNum seq)
127 { cp_seq = seq; cp_seq_valid = true; }
129 void setPredicate(bool val) { predicate = val; }
131 virtual void dump() = 0;
134 Tick getWhen() { return when; }
135 ThreadContext *getThread() { return thread; }
136 StaticInstPtr getStaticInst() { return staticInst; }
137 TheISA::PCState getPCState() { return pc; }
138 StaticInstPtr getMacroStaticInst() { return macroStaticInst; }
139 bool getMisspeculating() { return misspeculating; }
141 Addr getAddr() { return addr; }
142 bool getAddrValid() { return addr_valid; }
144 uint64_t getIntData() { return data.as_int; }
145 double getFloatData() { return data.as_double; }
146 int getDataStatus() { return data_status; }
148 InstSeqNum getFetchSeq() { return fetch_seq; }
149 bool getFetchSeqValid() { return fetch_seq_valid; }
151 InstSeqNum getCpSeq() { return cp_seq; }
152 bool getCpSeqValid() { return cp_seq_valid; }
155 class InstTracer : public SimObject
158 InstTracer(const Params *p) : SimObject(p)
161 virtual ~InstTracer()
165 getInstRecord(Tick when, ThreadContext *tc,
166 const StaticInstPtr staticInst, TheISA::PCState pc,
167 const StaticInstPtr macroStaticInst = NULL) = 0;
174 #endif // __INSTRECORD_HH__