gem5  v21.1.0.2
physical.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 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 #ifndef __MEM_PHYSICAL_HH__
39 #define __MEM_PHYSICAL_HH__
40 
41 #include <cstdint>
42 #include <string>
43 #include <vector>
44 
45 #include "base/addr_range.hh"
46 #include "base/addr_range_map.hh"
47 #include "mem/packet.hh"
48 #include "sim/serialize.hh"
49 
50 namespace gem5
51 {
52 
53 namespace memory
54 {
55 
59 class AbstractMemory;
60 
65 {
66  public:
67 
73  bool conf_table_reported, bool in_addr_map, bool kvm_map)
74  : range(range), pmem(pmem), confTableReported(conf_table_reported),
75  inAddrMap(in_addr_map), kvmMap(kvm_map)
76  {}
77 
82 
87  uint8_t* pmem;
88 
93 
97  bool inAddrMap;
98 
103  bool kvmMap;
104 };
105 
123 {
124 
125  private:
126 
127  // Name for debugging
128  std::string _name;
129 
130  // Global address map
132 
133  // All address-mapped memories
135 
136  // The total memory size
137  uint64_t size;
138 
139  // Let the user choose if we reserve swap space when calling mmap
140  const bool mmapUsingNoReserve;
141 
142  const std::string sharedBackstore;
143 
144  // The physical memory used to provide the memory in the simulated
145  // system
147 
148  // Prevent copying
150 
151  // Prevent assignment
153 
163  void createBackingStore(AddrRange range,
164  const std::vector<AbstractMemory*>& _memories,
165  bool conf_table_reported,
166  bool in_addr_map, bool kvm_map);
167 
168  public:
169 
173  PhysicalMemory(const std::string& _name,
174  const std::vector<AbstractMemory*>& _memories,
175  bool mmap_using_noreserve,
176  const std::string& shared_backstore);
177 
181  ~PhysicalMemory();
182 
187  const std::string name() const { return _name; }
188 
196  bool isMemAddr(Addr addr) const;
197 
207 
213  uint64_t totalSize() const { return size; }
214 
228  { return backingStore; }
229 
237  void access(PacketPtr pkt);
238 
247  void functionalAccess(PacketPtr pkt);
248 
257  void serialize(CheckpointOut &cp) const override;
258 
266  void serializeStore(CheckpointOut &cp, unsigned int store_id,
267  AddrRange range, uint8_t* pmem) const;
268 
274  void unserialize(CheckpointIn &cp) override;
275 
279  void unserializeStore(CheckpointIn &cp);
280 
281 };
282 
283 } // namespace memory
284 } // namespace gem5
285 
286 #endif //__MEM_PHYSICAL_HH__
gem5::memory::PhysicalMemory::getBackingStore
std::vector< BackingStoreEntry > getBackingStore() const
Get the pointers to the backing store for external host access.
Definition: physical.hh:227
gem5::memory::PhysicalMemory::serialize
void serialize(CheckpointOut &cp) const override
Serialize all the memories in the system.
Definition: physical.cc:316
gem5::memory::BackingStoreEntry::confTableReported
bool confTableReported
Whether this memory should be reported to the configuration table.
Definition: physical.hh:92
gem5::AddrRangeMap
The AddrRangeMap uses an STL map to implement an interval tree for address decoding.
Definition: addr_range_map.hh:62
serialize.hh
memory
Definition: mem.h:38
gem5::memory::PhysicalMemory
The physical memory encapsulates all memories in the system and provides basic functionality for acce...
Definition: physical.hh:122
gem5::memory::BackingStoreEntry::inAddrMap
bool inAddrMap
Whether this memory should appear in the global address map.
Definition: physical.hh:97
gem5::memory::PhysicalMemory::access
void access(PacketPtr pkt)
Perform an untimed memory access and update all the state (e.g.
Definition: physical.cc:298
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::memory::PhysicalMemory::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize the memories in the system.
Definition: physical.cc:393
gem5::memory::PhysicalMemory::backingStore
std::vector< BackingStoreEntry > backingStore
Definition: physical.hh:146
gem5::memory::PhysicalMemory::unserializeStore
void unserializeStore(CheckpointIn &cp)
Unserialize a specific backing store, identified by a section.
Definition: physical.cc:418
gem5::memory::BackingStoreEntry::range
AddrRange range
The address range covered in the guest.
Definition: physical.hh:81
gem5::memory::PhysicalMemory::serializeStore
void serializeStore(CheckpointOut &cp, unsigned int store_id, AddrRange range, uint8_t *pmem) const
Serialize a specific store.
Definition: physical.cc:346
std::vector
STL vector class.
Definition: stl.hh:37
gem5::memory::BackingStoreEntry::kvmMap
bool kvmMap
Whether KVM should map this memory into the guest address space during acceleration.
Definition: physical.hh:103
packet.hh
gem5::memory::PhysicalMemory::PhysicalMemory
PhysicalMemory(const PhysicalMemory &)
gem5::memory::PhysicalMemory::addrMap
AddrRangeMap< AbstractMemory *, 1 > addrMap
Definition: physical.hh:131
gem5::Serializable
Basic support for object serialization.
Definition: serialize.hh:169
gem5::memory::BackingStoreEntry::BackingStoreEntry
BackingStoreEntry(AddrRange range, uint8_t *pmem, bool conf_table_reported, bool in_addr_map, bool kvm_map)
Create a backing store entry.
Definition: physical.hh:72
addr_range_map.hh
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::memory::BackingStoreEntry
A single entry for the backing store.
Definition: physical.hh:64
gem5::memory::PhysicalMemory::~PhysicalMemory
~PhysicalMemory()
Unmap all the backing store we have used.
Definition: physical.cc:248
gem5::memory::PhysicalMemory::mmapUsingNoReserve
const bool mmapUsingNoReserve
Definition: physical.hh:140
gem5::memory::PhysicalMemory::sharedBackstore
const std::string sharedBackstore
Definition: physical.hh:142
gem5::memory::PhysicalMemory::memories
std::vector< AbstractMemory * > memories
Definition: physical.hh:134
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::memory::PhysicalMemory::functionalAccess
void functionalAccess(PacketPtr pkt)
Perform an untimed memory read or write without changing anything but the memory itself.
Definition: physical.cc:307
addr_range.hh
gem5::memory::PhysicalMemory::name
const std::string name() const
Return the name for debugging and for creation of sections for checkpointing.
Definition: physical.hh:187
gem5::memory::PhysicalMemory::operator=
PhysicalMemory & operator=(const PhysicalMemory &)
gem5::memory::PhysicalMemory::size
uint64_t size
Definition: physical.hh:137
gem5::memory::PhysicalMemory::isMemAddr
bool isMemAddr(Addr addr) const
Check if a physical address is within a range of a memory that is part of the global address map.
Definition: physical.cc:256
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::memory::PhysicalMemory::totalSize
uint64_t totalSize() const
Get the total physical memory size.
Definition: physical.hh:213
gem5::AddrRange
The AddrRange class encapsulates an address range, and supports a number of tests to check if two ran...
Definition: addr_range.hh:71
std::list< AddrRange >
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::memory::PhysicalMemory::_name
std::string _name
Definition: physical.hh:128
gem5::memory::PhysicalMemory::getConfAddrRanges
AddrRangeList getConfAddrRanges() const
Get the memory ranges for all memories that are to be reported to the configuration table.
Definition: physical.cc:262
gem5::memory::BackingStoreEntry::pmem
uint8_t * pmem
Pointer to the host memory this range maps to.
Definition: physical.hh:87
gem5::memory::PhysicalMemory::createBackingStore
void createBackingStore(AddrRange range, const std::vector< AbstractMemory * > &_memories, bool conf_table_reported, bool in_addr_map, bool kvm_map)
Create the memory region providing the backing store for a given address range that corresponds to a ...
Definition: physical.cc:190
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84

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