gem5  v21.1.0.2
trace_gen.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2013, 2016-2017 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 here under. 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 
39 
40 #include <algorithm>
41 
42 #include "base/random.hh"
43 #include "base/trace.hh"
44 #include "debug/TrafficGen.hh"
45 #include "proto/packet.pb.h"
46 #include "sim/core.hh"
47 #include "sim/cur_tick.hh"
48 
49 namespace gem5
50 {
51 
52 TraceGen::InputStream::InputStream(const std::string& filename)
53  : trace(filename)
54 {
55  init();
56 }
57 
58 void
60 {
61  // Create a protobuf message for the header and read it from the stream
62  ProtoMessage::PacketHeader header_msg;
63  if (!trace.read(header_msg)) {
64  panic("Failed to read packet header from trace\n");
65  } else if (header_msg.tick_freq() != sim_clock::Frequency) {
66  panic("Trace was recorded with a different tick frequency %d\n",
67  header_msg.tick_freq());
68  }
69 }
70 
71 void
73 {
74  trace.reset();
75  init();
76 }
77 
78 bool
80 {
81  ProtoMessage::Packet pkt_msg;
82  if (trace.read(pkt_msg)) {
83  element.cmd = pkt_msg.cmd();
84  element.addr = pkt_msg.addr();
85  element.blocksize = pkt_msg.size();
86  element.tick = pkt_msg.tick();
87  element.flags = pkt_msg.has_flags() ? pkt_msg.flags() : 0;
88  return true;
89  }
90 
91  // We have reached the end of the file
92  return false;
93 }
94 
95 Tick
96 TraceGen::nextPacketTick(bool elastic, Tick delay) const
97 {
98  if (traceComplete) {
99  DPRINTF(TrafficGen, "No next tick as trace is finished\n");
100  // We are at the end of the file, thus we have no more data in
101  // the trace Return MaxTick to signal that there will be no
102  // more transactions in this active period for the state.
103  return MaxTick;
104  }
105 
106  assert(nextElement.isValid());
107 
108  DPRINTF(TrafficGen, "Next packet tick is %d\n", tickOffset +
109  nextElement.tick);
110 
111  // if the playback is supposed to be elastic, add the delay
112  if (elastic)
113  tickOffset += delay;
114 
115  return std::max(tickOffset + nextElement.tick, curTick());
116 }
117 
118 void
120 {
121  // update the trace offset to the time where the state was entered.
122  tickOffset = curTick();
123 
124  // clear everything
125  currElement.clear();
126 
127  // read the first element in the file and set the complete flag
129 }
130 
131 PacketPtr
133 {
134  // shift things one step forward
136  nextElement.clear();
137 
138  // read the next element and set the complete flag
140 
141  // it is the responsibility of the traceComplete flag to ensure we
142  // always have a valid element here
143  assert(currElement.isValid());
144 
145  DPRINTF(TrafficGen, "TraceGen::getNextPacket: %c %d %d %d 0x%x\n",
146  currElement.cmd.isRead() ? 'r' : 'w',
151 
155 
156  if (!traceComplete)
157  DPRINTF(TrafficGen, "nextElement: %c addr %d size %d tick %d (%d)\n",
158  nextElement.cmd.isRead() ? 'r' : 'w',
162  nextElement.tick);
163 
164  return pkt;
165 }
166 
167 void
169 {
170  // Check if we reached the end of the trace file. If we did not
171  // then we want to generate a warning stating that not the entire
172  // trace was played.
173  if (!traceComplete) {
174  warn("Trace player %s was unable to replay the entire trace!\n",
175  name());
176  }
177 
178  // Clear any flags and start over again from the beginning of the
179  // file
180  trace.reset();
181 }
182 
183 } // namespace gem5
gem5::curTick
Tick curTick()
The universal simulation clock.
Definition: cur_tick.hh:46
gem5::TraceGen::TraceElement::blocksize
Addr blocksize
The size of the access for the request.
Definition: trace_gen.hh:79
gem5::TraceGen::tickOffset
Tick tickOffset
Stores the time when the state was entered.
Definition: trace_gen.hh:197
gem5::TraceGen::InputStream::init
void init()
Check the trace header to make sure that it is of the right format.
Definition: trace_gen.cc:59
gem5::TraceGen::TraceElement::clear
void clear()
Make this element invalid.
Definition: trace_gen.hh:99
gem5::TraceGen::nextElement
TraceElement nextElement
Definition: trace_gen.hh:190
warn
#define warn(...)
Definition: logging.hh:245
gem5::TraceGen::TraceElement::isValid
bool isValid() const
Check validity of this element.
Definition: trace_gen.hh:92
gem5::BaseGen::name
std::string name() const
Get the name, useful for DPRINTFs.
Definition: base_gen.hh:107
gem5::TraceGen::InputStream::InputStream
InputStream(const std::string &filename)
Create a trace input stream for a given file name.
Definition: trace_gen.cc:52
gem5::TraceGen::TraceElement
This struct stores a line in the trace file.
Definition: trace_gen.hh:69
cur_tick.hh
random.hh
gem5::sim_clock::Frequency
Tick Frequency
The simulated frequency of curTick(). (In ticks per second)
Definition: core.cc:48
gem5::TraceGen::nextPacketTick
Tick nextPacketTick(bool elastic, Tick delay) const
Returns the tick when the next request should be generated.
Definition: trace_gen.cc:96
gem5::MaxTick
const Tick MaxTick
Definition: types.hh:60
trace_gen.hh
gem5::TraceGen::traceComplete
bool traceComplete
Set to true when the trace replay for one instance of state is complete.
Definition: trace_gen.hh:209
gem5::TraceGen::addrOffset
Addr addrOffset
Offset for memory requests.
Definition: trace_gen.hh:203
gem5::BaseGen::getPacket
PacketPtr getPacket(Addr addr, unsigned size, const MemCmd &cmd, Request::FlagsType flags=0)
Generate a new request and associated packet.
Definition: base_gen.cc:55
gem5::TraceGen::trace
InputStream trace
Input stream used for reading the input trace file.
Definition: trace_gen.hh:186
gem5::TraceGen::exit
void exit()
Exit this generator state.
Definition: trace_gen.cc:168
gem5::TraceGen::InputStream::reset
void reset()
Reset the stream such that it can be played once again.
Definition: trace_gen.cc:72
gem5::TraceGen::getNextPacket
PacketPtr getNextPacket()
Get the next generated packet.
Definition: trace_gen.cc:132
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::probing::Packet
ProbePointArg< PacketInfo > Packet
Packet probe point.
Definition: mem.hh:109
gem5::MemCmd::cmd
Command cmd
Definition: packet.hh:207
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::TraceGen::currElement
TraceElement currElement
Store the current and next element in the trace.
Definition: trace_gen.hh:189
gem5::TraceGen::TraceElement::cmd
MemCmd cmd
Specifies if the request is to be a read or a write.
Definition: trace_gen.hh:73
gem5::TraceGen::InputStream::read
bool read(TraceElement &element)
Attempt to read a trace element from the stream, and also notify the caller if the end of the file wa...
Definition: trace_gen.cc:79
gem5::TraceGen::enter
void enter()
Enter this generator state.
Definition: trace_gen.cc:119
core.hh
gem5::TraceGen::TraceElement::tick
Tick tick
The time at which the request should be sent.
Definition: trace_gen.hh:82
gem5::TraceGen::TraceElement::flags
Request::FlagsType flags
Potential request flags to use.
Definition: trace_gen.hh:85
gem5::TraceGen::TraceElement::addr
Addr addr
The address for the request.
Definition: trace_gen.hh:76
gem5::TrafficGen
The traffic generator is a module that generates stimuli for the memory system, based on a collection...
Definition: traffic_gen.hh:70
gem5::statistics::init
const FlagsType init
This Stat is Initialized.
Definition: info.hh:56
trace.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::MemCmd::isRead
bool isRead() const
Definition: packet.hh:217
panic
#define panic(...)
This implements a cprintf based panic() function.
Definition: logging.hh:177

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