1/*
2 * Copyright (c) 2014 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2001-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Steve Reinhardt
41 * Nathan Binkert
42 */
43
44#ifndef __INSTRECORD_HH__
45#define __INSTRECORD_HH__
46
47#include "base/bigint.hh"
48#include "base/trace.hh"
49#include "base/types.hh"
50#include "cpu/inst_seq.hh" // for InstSeqNum
51#include "cpu/static_inst.hh"
52#include "sim/sim_object.hh"
53
54class ThreadContext;
55
56namespace Trace {
57
58class InstRecord
59{
60 protected:
61 Tick when;
62
63 // The following fields are initialized by the constructor and
64 // thus guaranteed to be valid.
65 ThreadContext *thread;
66 // need to make this ref-counted so it doesn't go away before we
67 // dump the record
68 StaticInstPtr staticInst;
69 TheISA::PCState pc;
70 StaticInstPtr macroStaticInst;
71
72 // The remaining fields are only valid for particular instruction
73 // types (e.g, addresses for memory ops) or when particular
74 // options are enabled (e.g., tracing full register contents).
75 // Each data field has an associated valid flag to indicate
76 // whether the data field is valid.
77
78 /*** @defgroup mem
79 * @{
80 * Memory request information in the instruction accessed memory.
81 * @see mem_valid
82 */
83 Addr addr; ///< The address that was accessed
84 Addr size; ///< The size of the memory request
85 unsigned flags; ///< The flags that were assigned to the request.
86
87 /** @} */
88
89 /** @defgroup data
90 * If this instruction wrote any data values they're recorded here
91 * WARNING: Instructions are quite loose with with what they write
92 * since many instructions write multiple values (e.g. destintation
93 * register, flags, status, ...) This only captures the last write.
94 * @TODO fix this and record all destintations that an instruction writes
95 * @see data_status
96 */
97 union {
98 uint64_t as_int;
99 double as_double;
100 } data;
101
102 /** @defgroup fetch_seq
103 * This records the serial number that the instruction was fetched in.
104 * @see fetch_seq_valid
105 */
106 InstSeqNum fetch_seq;
107
108 /** @defgroup commit_seq
109 * This records the instruction number that was committed in the pipeline
110 * @see cp_seq_valid
111 */
112 InstSeqNum cp_seq;
113
114 /** @ingroup data
115 * What size of data was written?
116 */
117 enum {
118 DataInvalid = 0,
119 DataInt8 = 1, // set to equal number of bytes
120 DataInt16 = 2,
121 DataInt32 = 4,
122 DataInt64 = 8,
123 DataDouble = 3
124 } data_status;
125
126 /** @ingroup memory
127 * Are the memory fields in the record valid?
128 */
129 bool mem_valid;
130
131 /** @ingroup fetch_seq
132 * Are the fetch sequence number fields valid?
133 */
134 bool fetch_seq_valid;
135 /** @ingroup commit_seq
136 * Are the commit sequence number fields valid?
137 */
138 bool cp_seq_valid;
139
140 /** is the predicate for execution this inst true or false (not execed)?
141 */
142 bool predicate;
143
144 public:
145 InstRecord(Tick _when, ThreadContext *_thread,
146 const StaticInstPtr _staticInst,
147 TheISA::PCState _pc,
148 const StaticInstPtr _macroStaticInst = NULL)
149 : when(_when), thread(_thread), staticInst(_staticInst), pc(_pc),
150 macroStaticInst(_macroStaticInst), addr(0), size(0), flags(0),
151 fetch_seq(0), cp_seq(0), data_status(DataInvalid), mem_valid(false),
152 fetch_seq_valid(false), cp_seq_valid(false), predicate(true)
153 { }
154
155 virtual ~InstRecord() { }
156
157 void setWhen(Tick new_when) { when = new_when; }
158 void setMem(Addr a, Addr s, unsigned f)
159 {
160 addr = a; size = s; flags = f; mem_valid = true;
161 }
162
163 void setData(Twin64_t d) { data.as_int = d.a; data_status = DataInt64; }
164 void setData(Twin32_t d) { data.as_int = d.a; data_status = DataInt32; }
165 void setData(uint64_t d) { data.as_int = d; data_status = DataInt64; }
166 void setData(uint32_t d) { data.as_int = d; data_status = DataInt32; }
167 void setData(uint16_t d) { data.as_int = d; data_status = DataInt16; }
168 void setData(uint8_t d) { data.as_int = d; data_status = DataInt8; }
169
170 void setData(int64_t d) { setData((uint64_t)d); }
171 void setData(int32_t d) { setData((uint32_t)d); }
172 void setData(int16_t d) { setData((uint16_t)d); }
173 void setData(int8_t d) { setData((uint8_t)d); }
174
175 void setData(double d) { data.as_double = d; data_status = DataDouble; }
176
177 void setFetchSeq(InstSeqNum seq)
178 { fetch_seq = seq; fetch_seq_valid = true; }
179
180 void setCPSeq(InstSeqNum seq)
181 { cp_seq = seq; cp_seq_valid = true; }
182
183 void setPredicate(bool val) { predicate = val; }
184
185 virtual void dump() = 0;
| 1/*
2 * Copyright (c) 2014 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2001-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Steve Reinhardt
41 * Nathan Binkert
42 */
43
44#ifndef __INSTRECORD_HH__
45#define __INSTRECORD_HH__
46
47#include "base/bigint.hh"
48#include "base/trace.hh"
49#include "base/types.hh"
50#include "cpu/inst_seq.hh" // for InstSeqNum
51#include "cpu/static_inst.hh"
52#include "sim/sim_object.hh"
53
54class ThreadContext;
55
56namespace Trace {
57
58class InstRecord
59{
60 protected:
61 Tick when;
62
63 // The following fields are initialized by the constructor and
64 // thus guaranteed to be valid.
65 ThreadContext *thread;
66 // need to make this ref-counted so it doesn't go away before we
67 // dump the record
68 StaticInstPtr staticInst;
69 TheISA::PCState pc;
70 StaticInstPtr macroStaticInst;
71
72 // The remaining fields are only valid for particular instruction
73 // types (e.g, addresses for memory ops) or when particular
74 // options are enabled (e.g., tracing full register contents).
75 // Each data field has an associated valid flag to indicate
76 // whether the data field is valid.
77
78 /*** @defgroup mem
79 * @{
80 * Memory request information in the instruction accessed memory.
81 * @see mem_valid
82 */
83 Addr addr; ///< The address that was accessed
84 Addr size; ///< The size of the memory request
85 unsigned flags; ///< The flags that were assigned to the request.
86
87 /** @} */
88
89 /** @defgroup data
90 * If this instruction wrote any data values they're recorded here
91 * WARNING: Instructions are quite loose with with what they write
92 * since many instructions write multiple values (e.g. destintation
93 * register, flags, status, ...) This only captures the last write.
94 * @TODO fix this and record all destintations that an instruction writes
95 * @see data_status
96 */
97 union {
98 uint64_t as_int;
99 double as_double;
100 } data;
101
102 /** @defgroup fetch_seq
103 * This records the serial number that the instruction was fetched in.
104 * @see fetch_seq_valid
105 */
106 InstSeqNum fetch_seq;
107
108 /** @defgroup commit_seq
109 * This records the instruction number that was committed in the pipeline
110 * @see cp_seq_valid
111 */
112 InstSeqNum cp_seq;
113
114 /** @ingroup data
115 * What size of data was written?
116 */
117 enum {
118 DataInvalid = 0,
119 DataInt8 = 1, // set to equal number of bytes
120 DataInt16 = 2,
121 DataInt32 = 4,
122 DataInt64 = 8,
123 DataDouble = 3
124 } data_status;
125
126 /** @ingroup memory
127 * Are the memory fields in the record valid?
128 */
129 bool mem_valid;
130
131 /** @ingroup fetch_seq
132 * Are the fetch sequence number fields valid?
133 */
134 bool fetch_seq_valid;
135 /** @ingroup commit_seq
136 * Are the commit sequence number fields valid?
137 */
138 bool cp_seq_valid;
139
140 /** is the predicate for execution this inst true or false (not execed)?
141 */
142 bool predicate;
143
144 public:
145 InstRecord(Tick _when, ThreadContext *_thread,
146 const StaticInstPtr _staticInst,
147 TheISA::PCState _pc,
148 const StaticInstPtr _macroStaticInst = NULL)
149 : when(_when), thread(_thread), staticInst(_staticInst), pc(_pc),
150 macroStaticInst(_macroStaticInst), addr(0), size(0), flags(0),
151 fetch_seq(0), cp_seq(0), data_status(DataInvalid), mem_valid(false),
152 fetch_seq_valid(false), cp_seq_valid(false), predicate(true)
153 { }
154
155 virtual ~InstRecord() { }
156
157 void setWhen(Tick new_when) { when = new_when; }
158 void setMem(Addr a, Addr s, unsigned f)
159 {
160 addr = a; size = s; flags = f; mem_valid = true;
161 }
162
163 void setData(Twin64_t d) { data.as_int = d.a; data_status = DataInt64; }
164 void setData(Twin32_t d) { data.as_int = d.a; data_status = DataInt32; }
165 void setData(uint64_t d) { data.as_int = d; data_status = DataInt64; }
166 void setData(uint32_t d) { data.as_int = d; data_status = DataInt32; }
167 void setData(uint16_t d) { data.as_int = d; data_status = DataInt16; }
168 void setData(uint8_t d) { data.as_int = d; data_status = DataInt8; }
169
170 void setData(int64_t d) { setData((uint64_t)d); }
171 void setData(int32_t d) { setData((uint32_t)d); }
172 void setData(int16_t d) { setData((uint16_t)d); }
173 void setData(int8_t d) { setData((uint8_t)d); }
174
175 void setData(double d) { data.as_double = d; data_status = DataDouble; }
176
177 void setFetchSeq(InstSeqNum seq)
178 { fetch_seq = seq; fetch_seq_valid = true; }
179
180 void setCPSeq(InstSeqNum seq)
181 { cp_seq = seq; cp_seq_valid = true; }
182
183 void setPredicate(bool val) { predicate = val; }
184
185 virtual void dump() = 0;
|