12391SN/A/* 28931Sandreas.hansson@arm.com * Copyright (c) 2012 ARM Limited 38931Sandreas.hansson@arm.com * All rights reserved 48931Sandreas.hansson@arm.com * 58931Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 68931Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 78931Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 88931Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 98931Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 108931Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 118931Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 128931Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 132391SN/A * 142391SN/A * Redistribution and use in source and binary forms, with or without 152391SN/A * modification, are permitted provided that the following conditions are 162391SN/A * met: redistributions of source code must retain the above copyright 172391SN/A * notice, this list of conditions and the following disclaimer; 182391SN/A * redistributions in binary form must reproduce the above copyright 192391SN/A * notice, this list of conditions and the following disclaimer in the 202391SN/A * documentation and/or other materials provided with the distribution; 212391SN/A * neither the name of the copyright holders nor the names of its 222391SN/A * contributors may be used to endorse or promote products derived from 232391SN/A * this software without specific prior written permission. 242391SN/A * 252391SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 262391SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 272391SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 282391SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 292391SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 302391SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 312391SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 322391SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 332391SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 342391SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 352391SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 362665Ssaidi@eecs.umich.edu * 378931Sandreas.hansson@arm.com * Authors: Andreas Hansson 382391SN/A */ 392391SN/A 4010482Sandreas.hansson@arm.com#ifndef __MEM_PHYSICAL_HH__ 4110482Sandreas.hansson@arm.com#define __MEM_PHYSICAL_HH__ 422391SN/A 439235Sandreas.hansson@arm.com#include "base/addr_range_map.hh" 4410482Sandreas.hansson@arm.com#include "mem/packet.hh" 459293Sandreas.hansson@arm.com 469293Sandreas.hansson@arm.com/** 479293Sandreas.hansson@arm.com * Forward declaration to avoid header dependencies. 489293Sandreas.hansson@arm.com */ 499293Sandreas.hansson@arm.comclass AbstractMemory; 504762Snate@binkert.org 518931Sandreas.hansson@arm.com/** 5211614Sdavid.j.hashe@gmail.com * A single entry for the backing store. 5311614Sdavid.j.hashe@gmail.com */ 5411614Sdavid.j.hashe@gmail.comclass BackingStoreEntry 5511614Sdavid.j.hashe@gmail.com{ 5611614Sdavid.j.hashe@gmail.com public: 5711614Sdavid.j.hashe@gmail.com 5811614Sdavid.j.hashe@gmail.com /** 5911614Sdavid.j.hashe@gmail.com * Create a backing store entry. Don't worry about managing the memory 6011614Sdavid.j.hashe@gmail.com * pointers, because PhysicalMemory is responsible for that. 6111614Sdavid.j.hashe@gmail.com */ 6211614Sdavid.j.hashe@gmail.com BackingStoreEntry(AddrRange range, uint8_t* pmem, 6311614Sdavid.j.hashe@gmail.com bool conf_table_reported, bool in_addr_map, bool kvm_map) 6411614Sdavid.j.hashe@gmail.com : range(range), pmem(pmem), confTableReported(conf_table_reported), 6511614Sdavid.j.hashe@gmail.com inAddrMap(in_addr_map), kvmMap(kvm_map) 6611614Sdavid.j.hashe@gmail.com {} 6711614Sdavid.j.hashe@gmail.com 6811614Sdavid.j.hashe@gmail.com /** 6911614Sdavid.j.hashe@gmail.com * The address range covered in the guest. 7011614Sdavid.j.hashe@gmail.com */ 7111614Sdavid.j.hashe@gmail.com AddrRange range; 7211614Sdavid.j.hashe@gmail.com 7311614Sdavid.j.hashe@gmail.com /** 7411614Sdavid.j.hashe@gmail.com * Pointer to the host memory this range maps to. This memory is the same 7511614Sdavid.j.hashe@gmail.com * size as the range field. 7611614Sdavid.j.hashe@gmail.com */ 7711614Sdavid.j.hashe@gmail.com uint8_t* pmem; 7811614Sdavid.j.hashe@gmail.com 7911614Sdavid.j.hashe@gmail.com /** 8011614Sdavid.j.hashe@gmail.com * Whether this memory should be reported to the configuration table 8111614Sdavid.j.hashe@gmail.com */ 8211614Sdavid.j.hashe@gmail.com bool confTableReported; 8311614Sdavid.j.hashe@gmail.com 8411614Sdavid.j.hashe@gmail.com /** 8511614Sdavid.j.hashe@gmail.com * Whether this memory should appear in the global address map 8611614Sdavid.j.hashe@gmail.com */ 8711614Sdavid.j.hashe@gmail.com bool inAddrMap; 8811614Sdavid.j.hashe@gmail.com 8911614Sdavid.j.hashe@gmail.com /** 9011614Sdavid.j.hashe@gmail.com * Whether KVM should map this memory into the guest address space during 9111614Sdavid.j.hashe@gmail.com * acceleration. 9211614Sdavid.j.hashe@gmail.com */ 9311614Sdavid.j.hashe@gmail.com bool kvmMap; 9411614Sdavid.j.hashe@gmail.com}; 9511614Sdavid.j.hashe@gmail.com 9611614Sdavid.j.hashe@gmail.com/** 978931Sandreas.hansson@arm.com * The physical memory encapsulates all memories in the system and 988931Sandreas.hansson@arm.com * provides basic functionality for accessing those memories without 998931Sandreas.hansson@arm.com * going through the memory system and interconnect. 1009293Sandreas.hansson@arm.com * 1019293Sandreas.hansson@arm.com * The physical memory is also responsible for providing the host 1029293Sandreas.hansson@arm.com * system backingstore used by the memories in the simulated guest 1039293Sandreas.hansson@arm.com * system. When the system is created, the physical memory allocates 1049293Sandreas.hansson@arm.com * the backing store based on the address ranges that are populated in 10510482Sandreas.hansson@arm.com * the system, and does so independent of how those map to actual 1069293Sandreas.hansson@arm.com * memory controllers. Thus, the physical memory completely abstracts 1079293Sandreas.hansson@arm.com * the mapping of the backing store of the host system and the address 1089293Sandreas.hansson@arm.com * mapping in the guest system. This enables us to arbitrarily change 1099293Sandreas.hansson@arm.com * the number of memory controllers, and their address mapping, as 1109293Sandreas.hansson@arm.com * long as the ranges stay the same. 1118931Sandreas.hansson@arm.com */ 1129293Sandreas.hansson@arm.comclass PhysicalMemory : public Serializable 1132391SN/A{ 1142413SN/A 1152391SN/A private: 1162391SN/A 1179293Sandreas.hansson@arm.com // Name for debugging 1189293Sandreas.hansson@arm.com std::string _name; 1199293Sandreas.hansson@arm.com 1208931Sandreas.hansson@arm.com // Global address map 12112779Sgabeblack@google.com AddrRangeMap<AbstractMemory*, 1> addrMap; 1223170Sstever@eecs.umich.edu 1238931Sandreas.hansson@arm.com // All address-mapped memories 1248931Sandreas.hansson@arm.com std::vector<AbstractMemory*> memories; 1253170Sstever@eecs.umich.edu 1268931Sandreas.hansson@arm.com // The total memory size 1278931Sandreas.hansson@arm.com uint64_t size; 1283170Sstever@eecs.umich.edu 12910700Sandreas.hansson@arm.com // Let the user choose if we reserve swap space when calling mmap 13010700Sandreas.hansson@arm.com const bool mmapUsingNoReserve; 13110700Sandreas.hansson@arm.com 1329293Sandreas.hansson@arm.com // The physical memory used to provide the memory in the simulated 1339293Sandreas.hansson@arm.com // system 13411614Sdavid.j.hashe@gmail.com std::vector<BackingStoreEntry> backingStore; 1359293Sandreas.hansson@arm.com 1368931Sandreas.hansson@arm.com // Prevent copying 1378931Sandreas.hansson@arm.com PhysicalMemory(const PhysicalMemory&); 1383170Sstever@eecs.umich.edu 1398931Sandreas.hansson@arm.com // Prevent assignment 1408931Sandreas.hansson@arm.com PhysicalMemory& operator=(const PhysicalMemory&); 1418719SAli.Saidi@ARM.com 1429293Sandreas.hansson@arm.com /** 1439293Sandreas.hansson@arm.com * Create the memory region providing the backing store for a 1449293Sandreas.hansson@arm.com * given address range that corresponds to a set of memories in 1459293Sandreas.hansson@arm.com * the simulated system. 1469293Sandreas.hansson@arm.com * 1479293Sandreas.hansson@arm.com * @param range The address range covered 1489293Sandreas.hansson@arm.com * @param memories The memories this range maps to 14911614Sdavid.j.hashe@gmail.com * @param kvm_map Should KVM map this memory for the guest 1509293Sandreas.hansson@arm.com */ 1519293Sandreas.hansson@arm.com void createBackingStore(AddrRange range, 15211614Sdavid.j.hashe@gmail.com const std::vector<AbstractMemory*>& _memories, 15311614Sdavid.j.hashe@gmail.com bool conf_table_reported, 15411614Sdavid.j.hashe@gmail.com bool in_addr_map, bool kvm_map); 1559293Sandreas.hansson@arm.com 1562391SN/A public: 1572391SN/A 1588931Sandreas.hansson@arm.com /** 1598931Sandreas.hansson@arm.com * Create a physical memory object, wrapping a number of memories. 1608931Sandreas.hansson@arm.com */ 1619293Sandreas.hansson@arm.com PhysicalMemory(const std::string& _name, 16210700Sandreas.hansson@arm.com const std::vector<AbstractMemory*>& _memories, 16310700Sandreas.hansson@arm.com bool mmap_using_noreserve); 1642391SN/A 1658931Sandreas.hansson@arm.com /** 1669293Sandreas.hansson@arm.com * Unmap all the backing store we have used. 1678931Sandreas.hansson@arm.com */ 1689293Sandreas.hansson@arm.com ~PhysicalMemory(); 1699293Sandreas.hansson@arm.com 1709293Sandreas.hansson@arm.com /** 1719293Sandreas.hansson@arm.com * Return the name for debugging and for creation of sections for 1729293Sandreas.hansson@arm.com * checkpointing. 1739293Sandreas.hansson@arm.com */ 1749293Sandreas.hansson@arm.com const std::string name() const { return _name; } 1754762Snate@binkert.org 1768931Sandreas.hansson@arm.com /** 1778931Sandreas.hansson@arm.com * Check if a physical address is within a range of a memory that 1788931Sandreas.hansson@arm.com * is part of the global address map. 1798931Sandreas.hansson@arm.com * 1808931Sandreas.hansson@arm.com * @param addr A physical address 1818931Sandreas.hansson@arm.com * @return Whether the address corresponds to a memory 1828931Sandreas.hansson@arm.com */ 1838931Sandreas.hansson@arm.com bool isMemAddr(Addr addr) const; 1842391SN/A 1858931Sandreas.hansson@arm.com /** 1868931Sandreas.hansson@arm.com * Get the memory ranges for all memories that are to be reported 1879413Sandreas.hansson@arm.com * to the configuration table. The ranges are merged before they 1889413Sandreas.hansson@arm.com * are returned such that any interleaved ranges appear as a 1899413Sandreas.hansson@arm.com * single range. 1908931Sandreas.hansson@arm.com * 1918931Sandreas.hansson@arm.com * @return All configuration table memory ranges 1928931Sandreas.hansson@arm.com */ 1938931Sandreas.hansson@arm.com AddrRangeList getConfAddrRanges() const; 1948923Sandreas.hansson@arm.com 1958931Sandreas.hansson@arm.com /** 1968931Sandreas.hansson@arm.com * Get the total physical memory size. 1978931Sandreas.hansson@arm.com * 1988931Sandreas.hansson@arm.com * @return The sum of all memory sizes 1998931Sandreas.hansson@arm.com */ 2008931Sandreas.hansson@arm.com uint64_t totalSize() const { return size; } 2018923Sandreas.hansson@arm.com 2029293Sandreas.hansson@arm.com /** 2039293Sandreas.hansson@arm.com * Get the pointers to the backing store for external host 2049293Sandreas.hansson@arm.com * access. Note that memory in the guest should be accessed using 2059293Sandreas.hansson@arm.com * access() or functionalAccess(). This interface is primarily 2069293Sandreas.hansson@arm.com * intended for CPU models using hardware virtualization. Note 2079293Sandreas.hansson@arm.com * that memories that are null are not present, and that the 2089293Sandreas.hansson@arm.com * backing store may also contain memories that are not part of 2099293Sandreas.hansson@arm.com * the OS-visible global address map and thus are allowed to 2109293Sandreas.hansson@arm.com * overlap. 2119293Sandreas.hansson@arm.com * 2129293Sandreas.hansson@arm.com * @return Pointers to the memory backing store 2139293Sandreas.hansson@arm.com */ 21411614Sdavid.j.hashe@gmail.com std::vector<BackingStoreEntry> getBackingStore() const 2159293Sandreas.hansson@arm.com { return backingStore; } 2169293Sandreas.hansson@arm.com 2178931Sandreas.hansson@arm.com /** 2189293Sandreas.hansson@arm.com * Perform an untimed memory access and update all the state 2199293Sandreas.hansson@arm.com * (e.g. locked addresses) and statistics accordingly. The packet 2209293Sandreas.hansson@arm.com * is turned into a response if required. 2218931Sandreas.hansson@arm.com * 2229293Sandreas.hansson@arm.com * @param pkt Packet performing the access 2238719SAli.Saidi@ARM.com */ 2248931Sandreas.hansson@arm.com void access(PacketPtr pkt); 2259293Sandreas.hansson@arm.com 2269293Sandreas.hansson@arm.com /** 2279293Sandreas.hansson@arm.com * Perform an untimed memory read or write without changing 2289293Sandreas.hansson@arm.com * anything but the memory itself. No stats are affected by this 2299293Sandreas.hansson@arm.com * access. In addition to normal accesses this also facilitates 2309293Sandreas.hansson@arm.com * print requests. 2319293Sandreas.hansson@arm.com * 2329293Sandreas.hansson@arm.com * @param pkt Packet performing the access 2339293Sandreas.hansson@arm.com */ 2348931Sandreas.hansson@arm.com void functionalAccess(PacketPtr pkt); 2359293Sandreas.hansson@arm.com 2369293Sandreas.hansson@arm.com /** 2379293Sandreas.hansson@arm.com * Serialize all the memories in the system. This is independent 2389293Sandreas.hansson@arm.com * of the logical memory layout, and the serialization only sees 2399293Sandreas.hansson@arm.com * the contigous backing store, independent of how this maps to 2409293Sandreas.hansson@arm.com * logical memories in the guest system. 2419293Sandreas.hansson@arm.com * 2429293Sandreas.hansson@arm.com * @param os stream to serialize to 2439293Sandreas.hansson@arm.com */ 24411168Sandreas.hansson@arm.com void serialize(CheckpointOut &cp) const override; 2459293Sandreas.hansson@arm.com 2469293Sandreas.hansson@arm.com /** 2479293Sandreas.hansson@arm.com * Serialize a specific store. 2489293Sandreas.hansson@arm.com * 2499293Sandreas.hansson@arm.com * @param store_id Unique identifier of this backing store 2509293Sandreas.hansson@arm.com * @param range The address range of this backing store 2519293Sandreas.hansson@arm.com * @param pmem The host pointer to this backing store 2529293Sandreas.hansson@arm.com */ 25310905Sandreas.sandberg@arm.com void serializeStore(CheckpointOut &cp, unsigned int store_id, 25410905Sandreas.sandberg@arm.com AddrRange range, uint8_t* pmem) const; 2559293Sandreas.hansson@arm.com 2569293Sandreas.hansson@arm.com /** 2579293Sandreas.hansson@arm.com * Unserialize the memories in the system. As with the 2589293Sandreas.hansson@arm.com * serialization, this action is independent of how the address 2599293Sandreas.hansson@arm.com * ranges are mapped to logical memories in the guest system. 2609293Sandreas.hansson@arm.com */ 26111168Sandreas.hansson@arm.com void unserialize(CheckpointIn &cp) override; 2629293Sandreas.hansson@arm.com 2639293Sandreas.hansson@arm.com /** 2649293Sandreas.hansson@arm.com * Unserialize a specific backing store, identified by a section. 2659293Sandreas.hansson@arm.com */ 26610905Sandreas.sandberg@arm.com void unserializeStore(CheckpointIn &cp); 2679293Sandreas.hansson@arm.com 2682391SN/A}; 2692391SN/A 27010482Sandreas.hansson@arm.com#endif //__MEM_PHYSICAL_HH__ 271