gem5  v21.1.0.2
dramsim2_wrapper.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013 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 <cassert>
39 
45 #ifdef DEBUG
46 #undef DEBUG
47 #endif
48 
49 #include "mem/dramsim2_wrapper.hh"
50 
51 #include <fstream>
52 
53 #include "DRAMSim2/MultiChannelMemorySystem.h"
54 #include "base/compiler.hh"
55 #include "base/logging.hh"
56 
57 namespace gem5
58 {
59 
60 namespace memory
61 {
62 
69 
70 DRAMSim2Wrapper::DRAMSim2Wrapper(const std::string& config_file,
71  const std::string& system_file,
72  const std::string& working_dir,
73  const std::string& trace_file,
74  unsigned int memory_size_mb,
75  bool enable_debug) :
76  dramsim(new DRAMSim::MultiChannelMemorySystem(config_file, system_file,
77  working_dir, trace_file,
78  memory_size_mb, NULL, NULL)),
79  _clockPeriod(0.0), _queueSize(0), _burstSize(0)
80 {
81  // tell DRAMSim2 to ignore its internal notion of a CPU frequency
82  dramsim->setCPUClockSpeed(0);
83 
84  // switch on debug output if requested
85  if (enable_debug)
86  SHOW_SIM_OUTPUT = 1;
87 
88  // there is no way of getting DRAMSim2 to tell us what frequency
89  // it is assuming, so we have to extract it ourselves
90  _clockPeriod = extractConfig<double>("tCK=",
91  working_dir + '/' + config_file);
92 
93  if (!_clockPeriod)
94  fatal("DRAMSim2 wrapper failed to get clock\n");
95 
96  // we also need to know what transaction queue size DRAMSim2 is
97  // using so we can stall when responses are blocked
98  _queueSize = extractConfig<unsigned int>("TRANS_QUEUE_DEPTH=",
99  working_dir + '/' + system_file);
100 
101  if (!_queueSize)
102  fatal("DRAMSim2 wrapper failed to get queue size\n");
103 
104 
105  // finally, get the data bus bits and burst length so we can add a
106  // sanity check for the burst size
107  unsigned int dataBusBits =
108  extractConfig<unsigned int>("JEDEC_DATA_BUS_BITS=",
109  working_dir + '/' + system_file);
110  unsigned int burstLength =
111  extractConfig<unsigned int>("BL=", working_dir + '/' + config_file);
112 
113  if (!dataBusBits || !burstLength)
114  fatal("DRAMSim22 wrapper failed to get burst size\n");
115 
116  _burstSize = dataBusBits * burstLength / 8;
117 }
118 
120 {
121  delete dramsim;
122 }
123 
124 template <typename T>
125 T
126 DRAMSim2Wrapper::extractConfig(const std::string& field_name,
127  const std::string& file_name) const
128 {
129  std::ifstream file_stream(file_name.c_str(), ios::in);
130 
131  if (!file_stream.good())
132  fatal("DRAMSim2 wrapper could not open %s for reading\n", file_name);
133 
134  bool found = false;
135  T res;
136  std::string line;
137  while (!found && file_stream) {
138  getline(file_stream, line);
139  if (line.substr(0, field_name.size()) == field_name) {
140  found = true;
141  istringstream iss(line.substr(field_name.size()));
142  iss >> res;
143  }
144  }
145 
146  file_stream.close();
147 
148  if (!found)
149  fatal("DRAMSim2 wrapper could not find %s in %s\n", field_name,
150  file_name);
151 
152  return res;
153 }
154 
155 void
157 {
158  dramsim->printStats(true);
159 }
160 
161 void
162 DRAMSim2Wrapper::setCallbacks(DRAMSim::TransactionCompleteCB* read_callback,
163  DRAMSim::TransactionCompleteCB* write_callback)
164 {
165  // simply pass it on, for now we ignore the power callback
166  dramsim->RegisterCallbacks(read_callback, write_callback, NULL);
167 }
168 
169 bool
171 {
172  return dramsim->willAcceptTransaction();
173 }
174 
175 void
176 DRAMSim2Wrapper::enqueue(bool is_write, uint64_t addr)
177 {
178  GEM5_VAR_USED bool success = dramsim->addTransaction(is_write, addr);
179  assert(success);
180 }
181 
182 double
184 {
185  return _clockPeriod;
186 }
187 
188 unsigned int
190 {
191  return _queueSize;
192 }
193 
194 unsigned int
196 {
197  return _burstSize;
198 }
199 
200 void
202 {
203  dramsim->update();
204 }
205 
206 } // namespace memory
207 } // namespace gem5
dramsim2_wrapper.hh
fatal
#define fatal(...)
This implements a cprintf based fatal() function.
Definition: logging.hh:189
gem5::memory::DRAMSim2Wrapper::dramsim
DRAMSim::MultiChannelMemorySystem * dramsim
Definition: dramsim2_wrapper.hh:78
memory
Definition: mem.h:38
gem5::memory::DRAMSim2Wrapper::_burstSize
unsigned int _burstSize
Definition: dramsim2_wrapper.hh:84
gem5::memory::SHOW_SIM_OUTPUT
int SHOW_SIM_OUTPUT
DRAMSim2 requires SHOW_SIM_OUTPUT to be defined (declared extern in the DRAMSim2 print macros),...
Definition: dramsim2_wrapper.cc:68
gem5::memory::DRAMSim2Wrapper::canAccept
bool canAccept() const
Determine if the controller can accept a new packet or not.
Definition: dramsim2_wrapper.cc:170
gem5::memory::DRAMSim2Wrapper::enqueue
void enqueue(bool is_write, uint64_t addr)
Enqueue a packet.
Definition: dramsim2_wrapper.cc:176
DRAMSim
Forward declaration to avoid includes.
Definition: dramsim2_wrapper.hh:53
gem5::memory::DRAMSim2Wrapper::~DRAMSim2Wrapper
~DRAMSim2Wrapper()
Definition: dramsim2_wrapper.cc:119
gem5::memory::DRAMSim2Wrapper::_queueSize
unsigned int _queueSize
Definition: dramsim2_wrapper.hh:82
gem5::memory::DRAMSim2Wrapper::queueSize
unsigned int queueSize() const
Get the transaction queue size used by DRAMSim2.
Definition: dramsim2_wrapper.cc:189
gem5::memory::DRAMSim2Wrapper::clockPeriod
double clockPeriod() const
Get the internal clock period used by DRAMSim2, specified in ns.
Definition: dramsim2_wrapper.cc:183
compiler.hh
gem5::memory::DRAMSim2Wrapper::setCallbacks
void setCallbacks(DRAMSim::TransactionCompleteCB *read_callback, DRAMSim::TransactionCompleteCB *write_callback)
Set the callbacks to use for read and write completion.
Definition: dramsim2_wrapper.cc:162
gem5::memory::DRAMSim2Wrapper::DRAMSim2Wrapper
DRAMSim2Wrapper(const std::string &config_file, const std::string &system_file, const std::string &working_dir, const std::string &trace_file, unsigned int memory_size_mb, bool enable_debug)
Create an instance of the DRAMSim2 multi-channel memory controller using a specific config and system...
Definition: dramsim2_wrapper.cc:70
gem5::memory::DRAMSim2Wrapper::tick
void tick()
Progress the memory controller one cycle.
Definition: dramsim2_wrapper.cc:201
gem5::memory::DRAMSim2Wrapper::extractConfig
T extractConfig(const std::string &field_name, const std::string &file_name) const
Definition: dramsim2_wrapper.cc:126
logging.hh
gem5::memory::DRAMSim2Wrapper::_clockPeriod
double _clockPeriod
Definition: dramsim2_wrapper.hh:80
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::memory::DRAMSim2Wrapper::burstSize
unsigned int burstSize() const
Get the burst size in bytes used by DRAMSim2.
Definition: dramsim2_wrapper.cc:195
gem5::memory::DRAMSim2Wrapper::printStats
void printStats()
Print the stats gathered in DRAMsim2.
Definition: dramsim2_wrapper.cc:156
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84

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