gem5  v21.2.1.1
dyn_inst.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014, 2016,2018 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  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #include "cpu/minor/dyn_inst.hh"
39 
40 #include <iomanip>
41 #include <sstream>
42 
43 #include "arch/isa.hh"
44 #include "cpu/base.hh"
45 #include "cpu/minor/trace.hh"
46 #include "cpu/null_static_inst.hh"
47 #include "cpu/reg_class.hh"
48 #include "debug/MinorExecute.hh"
49 #include "enums/OpClass.hh"
50 
51 namespace gem5
52 {
53 
55 namespace minor
56 {
57 
63 
64 std::ostream &
65 operator <<(std::ostream &os, const InstId &id)
66 {
67  os << id.threadId << '/' << id.streamSeqNum << '.'
68  << id.predictionSeqNum << '/' << id.lineSeqNum;
69 
70  /* Not all structures have fetch and exec sequence numbers */
71  if (id.fetchSeqNum != 0) {
72  os << '/' << id.fetchSeqNum;
73  if (id.execSeqNum != 0)
74  os << '.' << id.execSeqNum;
75  }
76 
77  return os;
78 }
79 
81  auto *inst = new MinorDynInst(nullStaticInstPtr);
82  assert(inst->isBubble());
83  // Make bubbleInst immortal.
84  inst->incref();
85  return inst;
86 }();
87 
88 bool
90 {
91  assert(staticInst);
92  return !(staticInst->isMicroop() && !staticInst->isLastMicroop());
93 }
94 
95 bool
97 {
98  return isInst() && staticInst->opClass() == No_OpClass;
99 }
100 
101 void
102 MinorDynInst::reportData(std::ostream &os) const
103 {
104  if (isBubble())
105  os << "-";
106  else if (isFault())
107  os << "F;" << id;
108  else if (translationFault != NoFault)
109  os << "TF;" << id;
110  else
111  os << id;
112 }
113 
114 std::ostream &
115 operator <<(std::ostream &os, const MinorDynInst &inst)
116 {
117  os << inst.id << " pc: 0x"
118  << std::hex << inst.pc->instAddr() << std::dec << " (";
119 
120  if (inst.isFault())
121  os << "fault: \"" << inst.fault->name() << '"';
122  else if (inst.translationFault != NoFault)
123  os << "translation fault: \"" << inst.translationFault->name() << '"';
124  else if (inst.staticInst)
125  os << inst.staticInst->getName();
126  else
127  os << "bubble";
128 
129  os << ')';
130 
131  return os;
132 }
133 
136 static void
137 printRegName(std::ostream &os, const RegId& reg,
138  const BaseISA::RegClasses &reg_classes)
139 {
140  const auto &reg_class = reg_classes.at(reg.classValue());
141  switch (reg.classValue()) {
142  case MiscRegClass:
143  {
144  RegIndex misc_reg = reg.index();
145  os << 'm' << misc_reg << '(' << reg_class.regName(reg) << ')';
146  }
147  break;
148  case FloatRegClass:
149  os << 'f' << reg.index();
150  break;
151  case VecRegClass:
152  os << 'v' << reg.index();
153  break;
154  case VecElemClass:
155  os << 'v' << reg.index() << '[' << reg.elemIndex() << ']';
156  break;
157  case IntRegClass:
158  if (reg.index() == reg_class.zeroReg()) {
159  os << 'z';
160  } else {
161  os << 'r' << reg.index();
162  }
163  break;
164  case CCRegClass:
165  os << 'c' << reg.index();
166  break;
167  default:
168  panic("Unknown register class: %d", (int)reg.classValue());
169  }
170 }
171 
172 void
174  const BaseISA::RegClasses &reg_classes) const
175 {
176  if (isFault()) {
177  minorInst(named_object, "id=F;%s addr=0x%x fault=\"%s\"\n",
178  id, pc->instAddr(), fault->name());
179  } else {
180  unsigned int num_src_regs = staticInst->numSrcRegs();
181  unsigned int num_dest_regs = staticInst->numDestRegs();
182 
183  std::ostringstream regs_str;
184 
185  /* Format lists of src and dest registers for microops and
186  * 'full' instructions */
187  if (!staticInst->isMacroop()) {
188  regs_str << " srcRegs=";
189 
190  unsigned int src_reg = 0;
191  while (src_reg < num_src_regs) {
192  printRegName(regs_str, staticInst->srcRegIdx(src_reg),
193  reg_classes);
194 
195  src_reg++;
196  if (src_reg != num_src_regs)
197  regs_str << ',';
198  }
199 
200  regs_str << " destRegs=";
201 
202  unsigned int dest_reg = 0;
203  while (dest_reg < num_dest_regs) {
204  printRegName(regs_str, staticInst->destRegIdx(dest_reg),
205  reg_classes);
206 
207  dest_reg++;
208  if (dest_reg != num_dest_regs)
209  regs_str << ',';
210  }
211 
212  ccprintf(regs_str, " extMachInst=%160x", staticInst->getEMI());
213  }
214 
215  std::ostringstream flags;
216  staticInst->printFlags(flags, " ");
217 
218  minorInst(named_object, "id=%s addr=0x%x inst=\"%s\" class=%s"
219  " flags=\"%s\"%s%s\n",
220  id, pc->instAddr(),
221  (staticInst->opClass() == No_OpClass ?
222  "(invalid)" : staticInst->disassemble(0,NULL)),
223  enums::OpClassStrings[staticInst->opClass()],
224  flags.str(),
225  regs_str.str(),
226  (predictedTaken ? " predictedTaken" : ""));
227  }
228 }
229 
231 {
232  if (traceData)
233  delete traceData;
234 }
235 
236 } // namespace minor
237 } // namespace gem5
dyn_inst.hh
gem5::minor::MinorDynInst::~MinorDynInst
~MinorDynInst()
Definition: dyn_inst.cc:230
gem5::minor::InstId::firstPredictionSeqNum
static const InstSeqNum firstPredictionSeqNum
Definition: dyn_inst.hh:82
gem5::NoFault
constexpr decltype(nullptr) NoFault
Definition: types.hh:260
gem5::StaticInst::isMicroop
bool isMicroop() const
Definition: static_inst.hh:207
gem5::minor::minorInst
void minorInst(const Named &named, const char *fmt, Args ...args)
DPRINTFN for MinorTrace MinorInst line reporting.
Definition: trace.hh:75
gem5::minor::InstId
Id for lines and instructions.
Definition: dyn_inst.hh:76
gem5::VecElemClass
@ VecElemClass
Vector Register Native Elem lane.
Definition: reg_class.hh:63
gem5::minor::MinorDynInst::staticInst
const StaticInstPtr staticInst
Definition: dyn_inst.hh:171
gem5::CCRegClass
@ CCRegClass
Condition-code register.
Definition: reg_class.hh:65
minor
gem5::minor::MinorDynInst::bubbleInst
static MinorDynInstPtr bubbleInst
A prototypical bubble instruction.
Definition: dyn_inst.hh:168
gem5::StaticInst::numSrcRegs
int8_t numSrcRegs() const
Number of source registers.
Definition: static_inst.hh:138
gem5::minor::MinorDynInst::minorTraceInst
void minorTraceInst(const Named &named_object, const BaseISA::RegClasses &reg_classes) const
Print (possibly verbose) instruction information for MinorTrace using the given Named object's name.
Definition: dyn_inst.cc:173
std::vector< RegClass >
gem5::minor::printRegName
static void printRegName(std::ostream &os, const RegId &reg, const BaseISA::RegClasses &reg_classes)
Print a register in the form r<n>, f<n>, m<n>(<name>) for integer, float, and misc given an 'architec...
Definition: dyn_inst.cc:137
gem5::minor::MinorDynInst::translationFault
Fault translationFault
Translation fault in case of a mem ref.
Definition: dyn_inst.hh:204
gem5::minor::InstId::firstFetchSeqNum
static const InstSeqNum firstFetchSeqNum
Definition: dyn_inst.hh:84
gem5::minor::MinorDynInstPtr
RefCountingPtr< MinorDynInst > MinorDynInstPtr
MinorDynInsts are currently reference counted.
Definition: dyn_inst.hh:69
gem5::minor::InstId::firstStreamSeqNum
static const InstSeqNum firstStreamSeqNum
First sequence numbers to use in initialisation of the pipeline and to be expected on the first line/...
Definition: dyn_inst.hh:81
gem5::StaticInst::destRegIdx
const RegId & destRegIdx(int i) const
Return logical index (architectural reg num) of i'th destination reg.
Definition: static_inst.hh:236
gem5::ccprintf
void ccprintf(cp::Print &print)
Definition: cprintf.hh:130
gem5::minor::InstId::firstLineSeqNum
static const InstSeqNum firstLineSeqNum
Definition: dyn_inst.hh:83
gem5::Named
Interface for things with names.
Definition: named.hh:38
gem5::StaticInst::opClass
OpClass opClass() const
Operation class. Used to select appropriate function unit in issue.
Definition: static_inst.hh:231
gem5::FloatRegClass
@ FloatRegClass
Floating-point register.
Definition: reg_class.hh:59
gem5::nullStaticInstPtr
const StaticInstPtr nullStaticInstPtr
Statically allocated null StaticInstPtr.
Definition: null_static_inst.cc:36
gem5::minor::MinorDynInst::predictedTaken
bool predictedTaken
This instruction was predicted to change control flow and the following instructions will have a newe...
Definition: dyn_inst.hh:190
gem5::StaticInst::srcRegIdx
const RegId & srcRegIdx(int i) const
Return logical index (architectural reg num) of i'th source reg.
Definition: static_inst.hh:246
gem5::StaticInst::getName
std::string getName()
Return name of machine instruction.
Definition: static_inst.hh:372
gem5::minor::InstId::firstExecSeqNum
static const InstSeqNum firstExecSeqNum
Definition: dyn_inst.hh:85
null_static_inst.hh
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::StaticInst::isLastMicroop
bool isLastMicroop() const
Definition: static_inst.hh:209
gem5::X86ISA::reg
Bitfield< 5, 3 > reg
Definition: types.hh:92
gem5::minor::MinorDynInst::isInst
bool isInst() const
Is this a real instruction.
Definition: dyn_inst.hh:257
gem5::minor::MinorDynInst::fault
Fault fault
This is actually a fault masquerading as an instruction.
Definition: dyn_inst.hh:182
gem5::minor::MinorDynInst::isBubble
bool isBubble() const
The BubbleIF interface.
Definition: dyn_inst.hh:248
gem5::IntRegClass
@ IntRegClass
Integer register.
Definition: reg_class.hh:58
gem5::minor::MinorDynInst::isFault
bool isFault() const
Is this a fault rather than instruction.
Definition: dyn_inst.hh:254
gem5::StaticInst::getEMI
virtual uint64_t getEMI() const
Definition: static_inst.hh:257
gem5::StaticInst::disassemble
virtual const std::string & disassemble(Addr pc, const loader::SymbolTable *symtab=nullptr) const
Return string representation of disassembled instruction.
Definition: static_inst.cc:60
gem5::minor::MinorDynInst::id
InstId id
Definition: dyn_inst.hh:173
gem5::minor::MinorDynInst::pc
std::unique_ptr< PCStateBase > pc
The fetch address of this instruction.
Definition: dyn_inst.hh:179
gem5::minor::MinorDynInst
Dynamic instruction for Minor.
Definition: dyn_inst.hh:163
base.hh
gem5::MiscRegClass
@ MiscRegClass
Control (misc) register.
Definition: reg_class.hh:66
gem5::minor::MinorDynInst::reportData
void reportData(std::ostream &os) const
ReportIF interface.
Definition: dyn_inst.cc:102
gem5::X86ISA::os
Bitfield< 17 > os
Definition: misc.hh:809
gem5::minor::operator<<
std::ostream & operator<<(std::ostream &os, const InstId &id)
Print this id in the usual slash-separated format expected by MinorTrace.
Definition: dyn_inst.cc:65
gem5::minor::MinorDynInst::isNoCostInst
bool isNoCostInst() const
Is this an instruction that can be executed ‘for free’ and needn't spend time in an FU.
Definition: dyn_inst.cc:96
gem5::StaticInst::isMacroop
bool isMacroop() const
Definition: static_inst.hh:206
reg_class.hh
gem5::StaticInst::numDestRegs
int8_t numDestRegs() const
Number of destination registers.
Definition: static_inst.hh:140
gem5::minor::MinorDynInst::isLastOpInInst
bool isLastOpInInst() const
Assuming this is not a fault, is this instruction either a whole instruction or the last microop from...
Definition: dyn_inst.cc:89
gem5::InstSeqNum
uint64_t InstSeqNum
Definition: inst_seq.hh:40
gem5::VecRegClass
@ VecRegClass
Vector Register.
Definition: reg_class.hh:61
gem5::RegIndex
uint16_t RegIndex
Definition: types.hh:176
trace.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: tlb.cc:60
gem5::minor::MinorDynInst::traceData
Trace::InstRecord * traceData
Trace information for this instruction's execution.
Definition: dyn_inst.hh:176
gem5::StaticInst::printFlags
void printFlags(std::ostream &outs, const std::string &separator) const
Print a separator separated list of this instruction's set flag names on the given stream.
Definition: static_inst.cc:71
gem5::RegId
Register ID: describe an architectural register with its class and index.
Definition: reg_class.hh:113
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:178

Generated on Wed May 4 2022 12:13:53 for gem5 by doxygen 1.8.17