gem5  v20.1.0.0
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 
63 
64 DRAMSim2Wrapper::DRAMSim2Wrapper(const std::string& config_file,
65  const std::string& system_file,
66  const std::string& working_dir,
67  const std::string& trace_file,
68  unsigned int memory_size_mb,
69  bool enable_debug) :
70  dramsim(new DRAMSim::MultiChannelMemorySystem(config_file, system_file,
71  working_dir, trace_file,
72  memory_size_mb, NULL, NULL)),
73  _clockPeriod(0.0), _queueSize(0), _burstSize(0)
74 {
75  // tell DRAMSim2 to ignore its internal notion of a CPU frequency
76  dramsim->setCPUClockSpeed(0);
77 
78  // switch on debug output if requested
79  if (enable_debug)
80  SHOW_SIM_OUTPUT = 1;
81 
82  // there is no way of getting DRAMSim2 to tell us what frequency
83  // it is assuming, so we have to extract it ourselves
84  _clockPeriod = extractConfig<double>("tCK=",
85  working_dir + '/' + config_file);
86 
87  if (!_clockPeriod)
88  fatal("DRAMSim2 wrapper failed to get clock\n");
89 
90  // we also need to know what transaction queue size DRAMSim2 is
91  // using so we can stall when responses are blocked
92  _queueSize = extractConfig<unsigned int>("TRANS_QUEUE_DEPTH=",
93  working_dir + '/' + system_file);
94 
95  if (!_queueSize)
96  fatal("DRAMSim2 wrapper failed to get queue size\n");
97 
98 
99  // finally, get the data bus bits and burst length so we can add a
100  // sanity check for the burst size
101  unsigned int dataBusBits =
102  extractConfig<unsigned int>("JEDEC_DATA_BUS_BITS=",
103  working_dir + '/' + system_file);
104  unsigned int burstLength =
105  extractConfig<unsigned int>("BL=", working_dir + '/' + config_file);
106 
107  if (!dataBusBits || !burstLength)
108  fatal("DRAMSim22 wrapper failed to get burst size\n");
109 
110  _burstSize = dataBusBits * burstLength / 8;
111 }
112 
114 {
115  delete dramsim;
116 }
117 
118 template <typename T>
119 T
120 DRAMSim2Wrapper::extractConfig(const std::string& field_name,
121  const std::string& file_name) const
122 {
123  std::ifstream file_stream(file_name.c_str(), ios::in);
124 
125  if (!file_stream.good())
126  fatal("DRAMSim2 wrapper could not open %s for reading\n", file_name);
127 
128  bool found = false;
129  T res;
130  std::string line;
131  while (!found && file_stream) {
132  getline(file_stream, line);
133  if (line.substr(0, field_name.size()) == field_name) {
134  found = true;
135  istringstream iss(line.substr(field_name.size()));
136  iss >> res;
137  }
138  }
139 
140  file_stream.close();
141 
142  if (!found)
143  fatal("DRAMSim2 wrapper could not find %s in %s\n", field_name,
144  file_name);
145 
146  return res;
147 }
148 
149 void
151 {
152  dramsim->printStats(true);
153 }
154 
155 void
156 DRAMSim2Wrapper::setCallbacks(DRAMSim::TransactionCompleteCB* read_callback,
157  DRAMSim::TransactionCompleteCB* write_callback)
158 {
159  // simply pass it on, for now we ignore the power callback
160  dramsim->RegisterCallbacks(read_callback, write_callback, NULL);
161 }
162 
163 bool
165 {
166  return dramsim->willAcceptTransaction();
167 }
168 
169 void
170 DRAMSim2Wrapper::enqueue(bool is_write, uint64_t addr)
171 {
172  bool success M5_VAR_USED = dramsim->addTransaction(is_write, addr);
173  assert(success);
174 }
175 
176 double
178 {
179  return _clockPeriod;
180 }
181 
182 unsigned int
184 {
185  return _queueSize;
186 }
187 
188 unsigned int
190 {
191  return _burstSize;
192 }
193 
194 void
196 {
197  dramsim->update();
198 }
dramsim2_wrapper.hh
DRAMSim2Wrapper::extractConfig
T extractConfig(const std::string &field_name, const std::string &file_name) const
Definition: dramsim2_wrapper.cc:120
fatal
#define fatal(...)
This implements a cprintf based fatal() function.
Definition: logging.hh:183
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:64
DRAMSim2Wrapper::dramsim
DRAMSim::MultiChannelMemorySystem * dramsim
Definition: dramsim2_wrapper.hh:72
DRAMSim2Wrapper::_queueSize
unsigned int _queueSize
Definition: dramsim2_wrapper.hh:76
DRAMSim2Wrapper::canAccept
bool canAccept() const
Determine if the controller can accept a new packet or not.
Definition: dramsim2_wrapper.cc:164
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:156
DRAMSim
Forward declaration to avoid includes.
Definition: dramsim2_wrapper.hh:53
DRAMSim2Wrapper::printStats
void printStats()
Print the stats gathered in DRAMsim2.
Definition: dramsim2_wrapper.cc:150
DRAMSim2Wrapper::burstSize
unsigned int burstSize() const
Get the burst size in bytes used by DRAMSim2.
Definition: dramsim2_wrapper.cc:189
DRAMSim2Wrapper::_clockPeriod
double _clockPeriod
Definition: dramsim2_wrapper.hh:74
compiler.hh
DRAMSim2Wrapper::queueSize
unsigned int queueSize() const
Get the transaction queue size used by DRAMSim2.
Definition: dramsim2_wrapper.cc:183
DRAMSim2Wrapper::~DRAMSim2Wrapper
~DRAMSim2Wrapper()
Definition: dramsim2_wrapper.cc:113
DRAMSim2Wrapper::tick
void tick()
Progress the memory controller one cycle.
Definition: dramsim2_wrapper.cc:195
addr
ip6_addr_t addr
Definition: inet.hh:423
logging.hh
DRAMSim2Wrapper::enqueue
void enqueue(bool is_write, uint64_t addr)
Enqueue a packet.
Definition: dramsim2_wrapper.cc:170
SHOW_SIM_OUTPUT
int SHOW_SIM_OUTPUT
When building the debug binary, we need to undo the command-line definition of DEBUG not to clash wit...
Definition: dramsim2_wrapper.cc:62
DRAMSim2Wrapper::clockPeriod
double clockPeriod() const
Get the internal clock period used by DRAMSim2, specified in ns.
Definition: dramsim2_wrapper.cc:177
DRAMSim2Wrapper::_burstSize
unsigned int _burstSize
Definition: dramsim2_wrapper.hh:78

Generated on Wed Sep 30 2020 14:02:13 for gem5 by doxygen 1.8.17