gem5  v22.0.0.1
dramsim2_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 
43 #ifndef __MEM_DRAMSIM2_WRAPPER_HH__
44 #define __MEM_DRAMSIM2_WRAPPER_HH__
45 
46 #include <string>
47 
48 #include "DRAMSim2/Callback.h"
49 
53 namespace DRAMSim {
54 
55 class MultiChannelMemorySystem;
56 
57 }
58 
59 namespace gem5
60 {
61 
62 namespace memory
63 {
64 
74 {
75 
76  private:
77 
78  DRAMSim::MultiChannelMemorySystem* 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 
103  DRAMSim2Wrapper(const std::string& config_file,
104  const std::string& system_file,
105  const std::string& working_dir,
106  const std::string& trace_file,
107  unsigned int memory_size_mb,
108  bool enable_debug);
110 
114  void printStats();
115 
122  void setCallbacks(DRAMSim::TransactionCompleteCB* read_callback,
123  DRAMSim::TransactionCompleteCB* write_callback);
124 
130  bool canAccept() const;
131 
137  void enqueue(bool is_write, uint64_t addr);
138 
145  double clockPeriod() const;
146 
152  unsigned int queueSize() const;
153 
159  unsigned int burstSize() const;
160 
164  void tick();
165 };
166 
167 } // namespace memory
168 } // namespace gem5
169 
170 #endif //__MEM_DRAMSIM2_WRAPPER_HH__
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::DRAMSim2Wrapper
Wrapper class to avoid having DRAMSim2 names like ClockDomain etc clashing with the normal gem5 world...
Definition: dramsim2_wrapper.hh:73
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
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
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: gpu_translation_state.hh:37
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 Sat Jun 18 2022 08:12:28 for gem5 by doxygen 1.8.17