gem5  v22.0.0.1
dramsim3_wrapper.hh
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 
44 #ifndef __MEM_DRAMSIM3_WRAPPER_HH__
45 #define __MEM_DRAMSIM3_WRAPPER_HH__
46 
47 #include <functional>
48 #include <string>
49 
53 namespace dramsim3 {
54 
55 class MemorySystem;
56 
57 }
58 
59 namespace gem5
60 {
61 
62 namespace memory
63 {
64 
74 {
75 
76  private:
77 
78  dramsim3::MemorySystem* dramsim;
79 
80  double _clockPeriod;
81 
82  unsigned int _queueSize;
83 
84  unsigned int _burstSize;
85 
86  template <typename T>
87  T extractConfig(const std::string& field_name,
88  const std::string& file_name) const;
89 
90  public:
91 
99  DRAMsim3Wrapper(const std::string& config_file,
100  const std::string& working_dir,
101  std::function<void(uint64_t)> read_cb,
102  std::function<void(uint64_t)> write_cb);
104 
108  void printStats();
109 
113  void resetStats();
114 
121  void setCallbacks(std::function<void(uint64_t)> read_complete,
122  std::function<void(uint64_t)> write_complete);
123 
129  bool canAccept(uint64_t addr, bool is_write) const;
130 
136  void enqueue(uint64_t addr, bool is_write);
137 
144  double clockPeriod() const;
145 
151  unsigned int queueSize() const;
152 
158  unsigned int burstSize() const;
159 
163  void tick();
164 };
165 
166 } // namespace memory
167 } // namespace gem5
168 
169 #endif //__MEM_DRAMSIM3_WRAPPER_HH__
gem5::memory::DRAMsim3Wrapper::dramsim
dramsim3::MemorySystem * dramsim
Definition: dramsim3_wrapper.hh:78
gem5::memory::DRAMsim3Wrapper::canAccept
bool canAccept(uint64_t addr, bool is_write) const
Determine if the controller can accept a new packet or not.
Definition: dramsim3_wrapper.cc:124
gem5::memory::DRAMsim3Wrapper::clockPeriod
double clockPeriod() const
Get the internal clock period used by DRAMsim3, specified in ns.
Definition: dramsim3_wrapper.cc:137
gem5::memory::DRAMsim3Wrapper::setCallbacks
void setCallbacks(std::function< void(uint64_t)> read_complete, std::function< void(uint64_t)> write_complete)
Set the callbacks to use for read and write completion.
Definition: dramsim3_wrapper.cc:117
gem5::memory::DRAMsim3Wrapper::burstSize
unsigned int burstSize() const
Get the burst size in bytes used by DRAMsim3.
Definition: dramsim3_wrapper.cc:149
gem5::memory::DRAMsim3Wrapper::printStats
void printStats()
Print the stats gathered in DRAMsim3.
Definition: dramsim3_wrapper.cc:105
memory
Definition: mem.h:38
gem5::memory::DRAMsim3Wrapper::queueSize
unsigned int queueSize() const
Get the transaction queue size used by DRAMsim3.
Definition: dramsim3_wrapper.cc:143
gem5::memory::DRAMsim3Wrapper::DRAMsim3Wrapper
DRAMsim3Wrapper(const std::string &config_file, const std::string &working_dir, std::function< void(uint64_t)> read_cb, std::function< void(uint64_t)> write_cb)
Create an instance of the DRAMsim3 multi-channel memory controller using a specific config and system...
Definition: dramsim3_wrapper.cc:64
gem5::memory::DRAMsim3Wrapper::_clockPeriod
double _clockPeriod
Definition: dramsim3_wrapper.hh:80
gem5::memory::DRAMsim3Wrapper::extractConfig
T extractConfig(const std::string &field_name, const std::string &file_name) const
dramsim3
Forward declaration to avoid includes.
Definition: dramsim3_wrapper.hh:53
gem5::memory::DRAMsim3Wrapper::enqueue
void enqueue(uint64_t addr, bool is_write)
Enqueue a packet.
Definition: dramsim3_wrapper.cc:130
gem5::memory::DRAMsim3Wrapper
Wrapper class to avoid having DRAMsim3 names like ClockDomain etc clashing with the normal gem5 world...
Definition: dramsim3_wrapper.hh:73
gem5::memory::DRAMsim3Wrapper::~DRAMsim3Wrapper
~DRAMsim3Wrapper()
Definition: dramsim3_wrapper.cc:98
gem5::memory::DRAMsim3Wrapper::tick
void tick()
Progress the memory controller one cycle.
Definition: dramsim3_wrapper.cc:155
gem5::memory::DRAMsim3Wrapper::_queueSize
unsigned int _queueSize
Definition: dramsim3_wrapper.hh:82
gem5::memory::DRAMsim3Wrapper::_burstSize
unsigned int _burstSize
Definition: dramsim3_wrapper.hh:84
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
gem5::memory::DRAMsim3Wrapper::resetStats
void resetStats()
Reset stats (useful for fastforwarding switch)
Definition: dramsim3_wrapper.cc:111
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84

Generated on Sat Jun 18 2022 08:12:28 for gem5 by doxygen 1.8.17