gem5  v21.1.0.2
pipe_data.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-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  * 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 
50 #ifndef __CPU_MINOR_PIPE_DATA_HH__
51 #define __CPU_MINOR_PIPE_DATA_HH__
52 
53 #include "cpu/minor/buffers.hh"
54 #include "cpu/minor/dyn_inst.hh"
55 #include "cpu/base.hh"
56 
57 namespace gem5
58 {
59 
61 namespace minor
62 {
63 
66 class BranchData /* : public ReportIF, public BubbleIF */
67 {
68  public:
69  enum Reason
70  {
71  /* *** No change of stream (information to branch prediction) */
72 
73  /* Don't branch at all (bubble) */
75  /* Don't branch, but here's the details of a correct prediction
76  * that was executed */
78 
79  /* *** Change of stream */
80 
81  /* Take an unpredicted branch */
83  /* Take a branch on branch prediction data (from Fetch2) */
85  /* Prediction of wrong target PC */
87  /* Bad branch prediction (didn't actually branch). Need to branch
88  * back to correct stream. If the target is wrong, use
89  * BadlyPredictedBranchTarget */
91  /* Suspend fetching for this thread (inst->id.threadId).
92  * This will be woken up by another stream changing branch so
93  * count it as stream changing itself and expect pc to be the PC
94  * of the next instruction */
96  /* Branch from an interrupt (no instruction) */
98  /* Stop fetching in anticipation of of draining */
100  };
101 
104  static bool isStreamChange(const BranchData::Reason reason);
105 
109  static bool isBranch(const BranchData::Reason reason);
110 
111  public:
114 
117 
121 
124 
127 
128  public:
131  newPredictionSeqNum(0), target(TheISA::PCState(0)),
133  { }
134 
136  Reason reason_,
137  ThreadID thread_id,
138  InstSeqNum new_stream_seq_num,
139  InstSeqNum new_prediction_seq_num,
141  MinorDynInstPtr inst_) :
142  reason(reason_),
143  threadId(thread_id),
144  newStreamSeqNum(new_stream_seq_num),
145  newPredictionSeqNum(new_prediction_seq_num),
146  target(target),
147  inst(inst_)
148  { }
149 
151  static BranchData bubble() { return BranchData(); }
152  bool isBubble() const { return reason == NoBranch; }
153 
155  bool isStreamChange() const { return isStreamChange(reason); }
156 
158  bool isBranch() const { return isBranch(reason); }
159 
161  void reportData(std::ostream &os) const;
162 };
163 
165 std::ostream &operator <<(std::ostream &os, BranchData::Reason reason);
166 
169 std::ostream &operator <<(std::ostream &os, const BranchData &branch);
170 
175 class ForwardLineData /* : public ReportIF, public BubbleIF */
176 {
177  private:
181 
182  public:
186 
189 
191  unsigned int lineWidth;
192 
193  public:
197 
200 
203  uint8_t *line;
204 
207 
208  public:
210  bubbleFlag(true),
211  lineBaseAddr(0),
212  lineWidth(0),
213  fault(NoFault),
214  line(NULL),
215  packet(NULL)
216  {
217  /* Make lines bubbles by default */
218  }
219 
220  ~ForwardLineData() { line = NULL; }
221 
222  public:
224  bool isFault() const { return fault != NoFault; }
225 
227  void setFault(Fault fault_);
228 
231  void allocateLine(unsigned int width_);
232 
236 
241  void freeLine();
242 
244  static ForwardLineData bubble() { return ForwardLineData(); }
245  bool isBubble() const { return bubbleFlag; }
246 
248  void reportData(std::ostream &os) const;
249 };
250 
252 const unsigned int MAX_FORWARD_INSTS = 16;
253 
257 class ForwardInstData /* : public ReportIF, public BubbleIF */
258 {
259  public:
262 
264  unsigned int numInsts;
265 
268 
269  public:
270  explicit ForwardInstData(unsigned int width = 0,
271  ThreadID tid = InvalidThreadID);
272 
273  ForwardInstData(const ForwardInstData &src);
274 
275  public:
277  unsigned int width() const { return numInsts; }
278 
281 
283  void resize(unsigned int width);
284 
286  void bubbleFill();
287 
289  bool isBubble() const;
290 
292  void reportData(std::ostream &os) const;
293 };
294 
295 } // namespace minor
296 } // namespace gem5
297 
298 #endif /* __CPU_MINOR_PIPE_DATA_HH__ */
gem5::minor::ForwardInstData::ForwardInstData
ForwardInstData(unsigned int width=0, ThreadID tid=InvalidThreadID)
Definition: pipe_data.cc:228
gem5::minor::ForwardLineData
Line fetch data in the forward direction.
Definition: pipe_data.hh:175
dyn_inst.hh
gem5::minor::ForwardLineData::bubble
static ForwardLineData bubble()
BubbleIF interface.
Definition: pipe_data.hh:244
gem5::NoFault
constexpr decltype(nullptr) NoFault
Definition: types.hh:260
gem5::minor::ForwardInstData::reportData
void reportData(std::ostream &os) const
ReportIF interface.
Definition: pipe_data.cc:273
gem5::minor::ForwardInstData::bubbleFill
void bubbleFill()
Fill with bubbles from 0 to width() - 1.
Definition: pipe_data.cc:257
gem5::minor::ForwardLineData::id
InstId id
Thread, stream, prediction ...
Definition: pipe_data.hh:199
gem5::minor::ForwardInstData::isBubble
bool isBubble() const
BubbleIF interface.
Definition: pipe_data.cc:251
gem5::minor::BranchData::Reason
Reason
Definition: pipe_data.hh:69
gem5::minor::InstId
Id for lines and instructions.
Definition: dyn_inst.hh:76
gem5::minor::ForwardInstData::insts
MinorDynInstPtr insts[MAX_FORWARD_INSTS]
Array of carried insts, ref counted.
Definition: pipe_data.hh:261
gem5::minor::ForwardInstData::threadId
ThreadID threadId
Thread associated with these instructions.
Definition: pipe_data.hh:267
gem5::minor::ForwardLineData::isBubble
bool isBubble() const
Definition: pipe_data.hh:245
gem5::minor::BranchData::reason
Reason reason
Explanation for this branch.
Definition: pipe_data.hh:113
gem5::minor::ForwardInstData::numInsts
unsigned int numInsts
The number of insts slots that can be expected to be valid insts.
Definition: pipe_data.hh:264
gem5::minor::ForwardLineData::allocateLine
void allocateLine(unsigned int width_)
In-place initialise a ForwardLineData, freeing and overridding the line.
Definition: pipe_data.cc:175
minor
gem5::minor::ForwardLineData::lineWidth
unsigned int lineWidth
Explicit line width, don't rely on data.size.
Definition: pipe_data.hh:191
gem5::minor::BranchData::isBranch
bool isBranch() const
As static isBranch but on this branch data.
Definition: pipe_data.hh:158
gem5::minor::BranchData::bubble
static BranchData bubble()
BubbleIF interface.
Definition: pipe_data.hh:151
gem5::minor::BranchData::NoBranch
@ NoBranch
Definition: pipe_data.hh:74
gem5::minor::BranchData::BranchData
BranchData(Reason reason_, ThreadID thread_id, InstSeqNum new_stream_seq_num, InstSeqNum new_prediction_seq_num, TheISA::PCState target, MinorDynInstPtr inst_)
Definition: pipe_data.hh:135
gem5::minor::ForwardInstData
Forward flowing data between Fetch2,Decode,Execute carrying a packet of instructions of a width appro...
Definition: pipe_data.hh:257
gem5::PowerISA::PCState
Definition: pcstate.hh:42
gem5::minor::BranchData::BranchData
BranchData()
Definition: pipe_data.hh:129
gem5::RefCountingPtr< MinorDynInst >
gem5::minor::ForwardLineData::setFault
void setFault(Fault fault_)
Set fault and possible clear the bubble flag.
Definition: pipe_data.cc:167
gem5::minor::ForwardLineData::reportData
void reportData(std::ostream &os) const
ReportIF interface.
Definition: pipe_data.cc:218
gem5::minor::BranchData::Interrupt
@ Interrupt
Definition: pipe_data.hh:97
gem5::Fault
std::shared_ptr< FaultBase > Fault
Definition: types.hh:255
gem5::minor::BranchData::CorrectlyPredictedBranch
@ CorrectlyPredictedBranch
Definition: pipe_data.hh:77
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::MipsISA::PCState
GenericISA::DelaySlotPCState< 4 > PCState
Definition: pcstate.hh:40
gem5::minor::BranchData::BadlyPredictedBranchTarget
@ BadlyPredictedBranchTarget
Definition: pipe_data.hh:86
gem5::minor::ForwardLineData::line
uint8_t * line
Line data.
Definition: pipe_data.hh:203
gem5::minor::ForwardInstData::width
unsigned int width() const
Number of instructions carried by this object.
Definition: pipe_data.hh:277
gem5::minor::ForwardInstData::operator=
ForwardInstData & operator=(const ForwardInstData &src)
Copy the inst array only as far as numInsts.
Definition: pipe_data.cc:240
gem5::InvalidThreadID
const ThreadID InvalidThreadID
Definition: types.hh:243
gem5::minor::MAX_FORWARD_INSTS
const unsigned int MAX_FORWARD_INSTS
Maximum number of instructions that can be carried by the pipeline.
Definition: pipe_data.hh:252
gem5::minor::BranchData
Forward data betwen Execute and Fetch1 carrying change-of-address/stream information.
Definition: pipe_data.hh:66
gem5::minor::BranchData::target
TheISA::PCState target
Starting PC of that stream.
Definition: pipe_data.hh:123
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::minor::BranchData::inst
MinorDynInstPtr inst
Instruction which caused this branch.
Definition: pipe_data.hh:126
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
gem5::minor::BranchData::isBubble
bool isBubble() const
Definition: pipe_data.hh:152
gem5::minor::ForwardLineData::~ForwardLineData
~ForwardLineData()
Definition: pipe_data.hh:220
gem5::minor::ForwardLineData::isFault
bool isFault() const
This is a fault, not a line.
Definition: pipe_data.hh:224
gem5::minor::ForwardLineData::packet
Packet * packet
Packet from which the line is taken.
Definition: pipe_data.hh:206
gem5::minor::ForwardLineData::adoptPacketData
void adoptPacketData(Packet *packet)
Use the data from a packet as line instead of allocating new space.
Definition: pipe_data.cc:187
gem5::minor::BranchData::isStreamChange
bool isStreamChange() const
As static isStreamChange but on this branch data.
Definition: pipe_data.hh:155
gem5::minor::ForwardInstData::resize
void resize(unsigned int width)
Resize a bubble/empty ForwardInstData and fill with bubbles.
Definition: pipe_data.cc:264
gem5::minor::MinorDynInst
Dynamic instruction for Minor.
Definition: dyn_inst.hh:163
base.hh
gem5::minor::BranchData::threadId
ThreadID threadId
ThreadID associated with branch.
Definition: pipe_data.hh:116
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::BranchData::HaltFetch
@ HaltFetch
Definition: pipe_data.hh:99
gem5::minor::BranchData::BranchPrediction
@ BranchPrediction
Definition: pipe_data.hh:84
gem5::minor::ForwardLineData::lineBaseAddr
Addr lineBaseAddr
First byte address in the line.
Definition: pipe_data.hh:185
gem5::InstSeqNum
uint64_t InstSeqNum
Definition: inst_seq.hh:40
gem5::minor::BranchData::BadlyPredictedBranch
@ BadlyPredictedBranch
Definition: pipe_data.hh:90
buffers.hh
gem5::minor::ForwardLineData::fault
Fault fault
This line has a fault.
Definition: pipe_data.hh:196
gem5::minor::BranchData::reportData
void reportData(std::ostream &os) const
ReportIF interface.
Definition: pipe_data.cc:141
gem5::minor::BranchData::SuspendThread
@ SuspendThread
Definition: pipe_data.hh:95
gem5::minor::ForwardLineData::pc
TheISA::PCState pc
PC of the first requested inst within this line.
Definition: pipe_data.hh:188
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::minor::BranchData::UnpredictedBranch
@ UnpredictedBranch
Definition: pipe_data.hh:82
gem5::minor::BranchData::newPredictionSeqNum
InstSeqNum newPredictionSeqNum
Definition: pipe_data.hh:120
gem5::minor::ForwardLineData::ForwardLineData
ForwardLineData()
Definition: pipe_data.hh:209
gem5::minor::BranchData::newStreamSeqNum
InstSeqNum newStreamSeqNum
Sequence number of new stream/prediction to be adopted.
Definition: pipe_data.hh:119
gem5::minor::ForwardLineData::bubbleFlag
bool bubbleFlag
This line is a bubble.
Definition: pipe_data.hh:180
gem5::ThreadID
int16_t ThreadID
Thread index/ID type.
Definition: types.hh:242
gem5::minor::ForwardLineData::freeLine
void freeLine()
Free this ForwardLineData line.
Definition: pipe_data.cc:200

Generated on Tue Sep 21 2021 12:25:01 for gem5 by doxygen 1.8.17