abstract_mem.hh revision 12749
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. 138931Sandreas.hansson@arm.com * 142391SN/A * Copyright (c) 2001-2005 The Regents of The University of Michigan 152391SN/A * All rights reserved. 162391SN/A * 172391SN/A * Redistribution and use in source and binary forms, with or without 182391SN/A * modification, are permitted provided that the following conditions are 192391SN/A * met: redistributions of source code must retain the above copyright 202391SN/A * notice, this list of conditions and the following disclaimer; 212391SN/A * redistributions in binary form must reproduce the above copyright 222391SN/A * notice, this list of conditions and the following disclaimer in the 232391SN/A * documentation and/or other materials provided with the distribution; 242391SN/A * neither the name of the copyright holders nor the names of its 252391SN/A * contributors may be used to endorse or promote products derived from 262391SN/A * this software without specific prior written permission. 272391SN/A * 282391SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292391SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302391SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312391SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322391SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332391SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342391SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352391SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362391SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372391SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382391SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392665SN/A * 402665SN/A * Authors: Ron Dreslinski 418931Sandreas.hansson@arm.com * Andreas Hansson 422391SN/A */ 432391SN/A 448931Sandreas.hansson@arm.com/** 458931Sandreas.hansson@arm.com * @file 468931Sandreas.hansson@arm.com * AbstractMemory declaration 472391SN/A */ 482391SN/A 4912492Sodanrc@yahoo.com.br#ifndef __MEM_ABSTRACT_MEMORY_HH__ 5012492Sodanrc@yahoo.com.br#define __MEM_ABSTRACT_MEMORY_HH__ 512391SN/A 522462SN/A#include "mem/mem_object.hh" 538931Sandreas.hansson@arm.com#include "params/AbstractMemory.hh" 548719SN/A#include "sim/stats.hh" 552462SN/A 569053Sdam.sunwoo@arm.com 579053Sdam.sunwoo@arm.comclass System; 589053Sdam.sunwoo@arm.com 598931Sandreas.hansson@arm.com/** 609293Sandreas.hansson@arm.com * Locked address class that represents a physical address and a 619293Sandreas.hansson@arm.com * context id. 629293Sandreas.hansson@arm.com */ 639293Sandreas.hansson@arm.comclass LockedAddr { 649293Sandreas.hansson@arm.com 659293Sandreas.hansson@arm.com private: 669293Sandreas.hansson@arm.com 679293Sandreas.hansson@arm.com // on alpha, minimum LL/SC granularity is 16 bytes, so lower 689293Sandreas.hansson@arm.com // bits need to masked off. 699293Sandreas.hansson@arm.com static const Addr Addr_Mask = 0xf; 709293Sandreas.hansson@arm.com 719293Sandreas.hansson@arm.com public: 729293Sandreas.hansson@arm.com 739293Sandreas.hansson@arm.com // locked address 749293Sandreas.hansson@arm.com Addr addr; 759293Sandreas.hansson@arm.com 769293Sandreas.hansson@arm.com // locking hw context 7711005Sandreas.sandberg@arm.com const ContextID contextId; 789293Sandreas.hansson@arm.com 799293Sandreas.hansson@arm.com static Addr mask(Addr paddr) { return (paddr & ~Addr_Mask); } 809293Sandreas.hansson@arm.com 819293Sandreas.hansson@arm.com // check for matching execution context 8212749Sgiacomo.travaglini@arm.com bool matchesContext(const RequestPtr &req) const 839293Sandreas.hansson@arm.com { 849293Sandreas.hansson@arm.com return (contextId == req->contextId()); 859293Sandreas.hansson@arm.com } 869293Sandreas.hansson@arm.com 8712749Sgiacomo.travaglini@arm.com LockedAddr(const RequestPtr &req) : addr(mask(req->getPaddr())), 8812749Sgiacomo.travaglini@arm.com contextId(req->contextId()) 899293Sandreas.hansson@arm.com {} 909293Sandreas.hansson@arm.com 919293Sandreas.hansson@arm.com // constructor for unserialization use 929293Sandreas.hansson@arm.com LockedAddr(Addr _addr, int _cid) : addr(_addr), contextId(_cid) 939293Sandreas.hansson@arm.com {} 949293Sandreas.hansson@arm.com}; 959293Sandreas.hansson@arm.com 969293Sandreas.hansson@arm.com/** 978931Sandreas.hansson@arm.com * An abstract memory represents a contiguous block of physical 988931Sandreas.hansson@arm.com * memory, with an associated address range, and also provides basic 998931Sandreas.hansson@arm.com * functionality for reading and writing this memory without any 1008931Sandreas.hansson@arm.com * timing information. It is a MemObject since any subclass must have 1018931Sandreas.hansson@arm.com * at least one slave port. 1028931Sandreas.hansson@arm.com */ 1038931Sandreas.hansson@arm.comclass AbstractMemory : public MemObject 1042391SN/A{ 1056107SN/A protected: 1066107SN/A 1078931Sandreas.hansson@arm.com // Address range of this memory 1089235Sandreas.hansson@arm.com AddrRange range; 1092413SN/A 1108931Sandreas.hansson@arm.com // Pointer to host memory used to implement this memory 1118931Sandreas.hansson@arm.com uint8_t* pmemAddr; 1122413SN/A 1138931Sandreas.hansson@arm.com // Enable specific memories to be reported to the configuration table 11411614Sdavid.j.hashe@gmail.com const bool confTableReported; 1152413SN/A 1168931Sandreas.hansson@arm.com // Should the memory appear in the global address map 11711614Sdavid.j.hashe@gmail.com const bool inAddrMap; 11811614Sdavid.j.hashe@gmail.com 11911614Sdavid.j.hashe@gmail.com // Should KVM map this memory for the guest 12011614Sdavid.j.hashe@gmail.com const bool kvmMap; 1213170SN/A 1223170SN/A std::list<LockedAddr> lockedAddrList; 1233170SN/A 1243170SN/A // helper function for checkLockedAddrs(): we really want to 1253170SN/A // inline a quick check for an empty locked addr list (hopefully 1263170SN/A // the common case), and do the full list search (if necessary) in 1273170SN/A // this out-of-line function 1284626SN/A bool checkLockedAddrList(PacketPtr pkt); 1293170SN/A 1303170SN/A // Record the address of a load-locked operation so that we can 1313170SN/A // clear the execution context's lock flag if a matching store is 1323170SN/A // performed 1334626SN/A void trackLoadLocked(PacketPtr pkt); 1343170SN/A 1353170SN/A // Compare a store address with any locked addresses so we can 1363170SN/A // clear the lock flag appropriately. Return value set to 'false' 1373170SN/A // if store operation should be suppressed (because it was a 1383170SN/A // conditional store and the address was no longer locked by the 1393170SN/A // requesting execution context), 'true' otherwise. Note that 1403170SN/A // this method must be called on *all* stores since even 1413170SN/A // non-conditional stores must clear any matching lock addresses. 1424626SN/A bool writeOK(PacketPtr pkt) { 14312749Sgiacomo.travaglini@arm.com const RequestPtr &req = pkt->req; 1443170SN/A if (lockedAddrList.empty()) { 1453170SN/A // no locked addrs: nothing to check, store_conditional fails 1466102SN/A bool isLLSC = pkt->isLLSC(); 1476102SN/A if (isLLSC) { 1484040SN/A req->setExtraData(0); 1493170SN/A } 1506102SN/A return !isLLSC; // only do write if not an sc 1513170SN/A } else { 1523170SN/A // iterate over list... 1534626SN/A return checkLockedAddrList(pkt); 1543170SN/A } 1553170SN/A } 1563170SN/A 1578719SN/A /** Number of total bytes read from this memory */ 1589053Sdam.sunwoo@arm.com Stats::Vector bytesRead; 1598719SN/A /** Number of instruction bytes read from this memory */ 1609053Sdam.sunwoo@arm.com Stats::Vector bytesInstRead; 1618719SN/A /** Number of bytes written to this memory */ 1629053Sdam.sunwoo@arm.com Stats::Vector bytesWritten; 1638719SN/A /** Number of read requests */ 1649053Sdam.sunwoo@arm.com Stats::Vector numReads; 1658719SN/A /** Number of write requests */ 1669053Sdam.sunwoo@arm.com Stats::Vector numWrites; 1678719SN/A /** Number of other requests */ 1689053Sdam.sunwoo@arm.com Stats::Vector numOther; 1698719SN/A /** Read bandwidth from this memory */ 1708719SN/A Stats::Formula bwRead; 1718719SN/A /** Read bandwidth from this memory */ 1728719SN/A Stats::Formula bwInstRead; 1738719SN/A /** Write bandwidth from this memory */ 1748719SN/A Stats::Formula bwWrite; 1758719SN/A /** Total bandwidth from this memory */ 1768719SN/A Stats::Formula bwTotal; 1778719SN/A 1789053Sdam.sunwoo@arm.com /** Pointor to the System object. 1799053Sdam.sunwoo@arm.com * This is used for getting the number of masters in the system which is 1809053Sdam.sunwoo@arm.com * needed when registering stats 1819053Sdam.sunwoo@arm.com */ 1829053Sdam.sunwoo@arm.com System *_system; 1839053Sdam.sunwoo@arm.com 1849053Sdam.sunwoo@arm.com 1858931Sandreas.hansson@arm.com private: 1868931Sandreas.hansson@arm.com 1878931Sandreas.hansson@arm.com // Prevent copying 1888931Sandreas.hansson@arm.com AbstractMemory(const AbstractMemory&); 1898931Sandreas.hansson@arm.com 1908931Sandreas.hansson@arm.com // Prevent assignment 1918931Sandreas.hansson@arm.com AbstractMemory& operator=(const AbstractMemory&); 1922391SN/A 1932391SN/A public: 1948931Sandreas.hansson@arm.com 1958931Sandreas.hansson@arm.com typedef AbstractMemoryParams Params; 1968931Sandreas.hansson@arm.com 1978931Sandreas.hansson@arm.com AbstractMemory(const Params* p); 1989293Sandreas.hansson@arm.com virtual ~AbstractMemory() {} 1999293Sandreas.hansson@arm.com 2009293Sandreas.hansson@arm.com /** 20110466Sandreas.hansson@arm.com * Initialise this memory. 20210466Sandreas.hansson@arm.com */ 20311169Sandreas.hansson@arm.com void init() override; 20410466Sandreas.hansson@arm.com 20510466Sandreas.hansson@arm.com /** 2069293Sandreas.hansson@arm.com * See if this is a null memory that should never store data and 2079293Sandreas.hansson@arm.com * always return zero. 2089293Sandreas.hansson@arm.com * 2099293Sandreas.hansson@arm.com * @return true if null 2109293Sandreas.hansson@arm.com */ 2119293Sandreas.hansson@arm.com bool isNull() const { return params()->null; } 2129293Sandreas.hansson@arm.com 2139293Sandreas.hansson@arm.com /** 2149293Sandreas.hansson@arm.com * Set the host memory backing store to be used by this memory 2159293Sandreas.hansson@arm.com * controller. 2169293Sandreas.hansson@arm.com * 2179293Sandreas.hansson@arm.com * @param pmem_addr Pointer to a segment of host memory 2189293Sandreas.hansson@arm.com */ 2199293Sandreas.hansson@arm.com void setBackingStore(uint8_t* pmem_addr); 2209293Sandreas.hansson@arm.com 2219293Sandreas.hansson@arm.com /** 2229293Sandreas.hansson@arm.com * Get the list of locked addresses to allow checkpointing. 2239293Sandreas.hansson@arm.com */ 2249293Sandreas.hansson@arm.com const std::list<LockedAddr>& getLockedAddrList() const 2259293Sandreas.hansson@arm.com { return lockedAddrList; } 2269293Sandreas.hansson@arm.com 2279293Sandreas.hansson@arm.com /** 2289293Sandreas.hansson@arm.com * Add a locked address to allow for checkpointing. 2299293Sandreas.hansson@arm.com */ 2309293Sandreas.hansson@arm.com void addLockedAddr(LockedAddr addr) { lockedAddrList.push_back(addr); } 2312391SN/A 2329053Sdam.sunwoo@arm.com /** read the system pointer 2339053Sdam.sunwoo@arm.com * Implemented for completeness with the setter 2349053Sdam.sunwoo@arm.com * @return pointer to the system object */ 2359053Sdam.sunwoo@arm.com System* system() const { return _system; } 2369053Sdam.sunwoo@arm.com 2379053Sdam.sunwoo@arm.com /** Set the system pointer on this memory 2389053Sdam.sunwoo@arm.com * This can't be done via a python parameter because the system needs 2399053Sdam.sunwoo@arm.com * pointers to all the memories and the reverse would create a cycle in the 2409053Sdam.sunwoo@arm.com * object graph. An init() this is set. 2419053Sdam.sunwoo@arm.com * @param sys system pointer to set 2429053Sdam.sunwoo@arm.com */ 2439053Sdam.sunwoo@arm.com void system(System *sys) { _system = sys; } 2449053Sdam.sunwoo@arm.com 2454762SN/A const Params * 2464762SN/A params() const 2474762SN/A { 2484762SN/A return dynamic_cast<const Params *>(_params); 2494762SN/A } 2504762SN/A 2518931Sandreas.hansson@arm.com /** 2528931Sandreas.hansson@arm.com * Get the address range 2538931Sandreas.hansson@arm.com * 2548931Sandreas.hansson@arm.com * @return a single contigous address range 2558931Sandreas.hansson@arm.com */ 2569235Sandreas.hansson@arm.com AddrRange getAddrRange() const; 2572391SN/A 2588931Sandreas.hansson@arm.com /** 2598931Sandreas.hansson@arm.com * Get the memory size. 2608931Sandreas.hansson@arm.com * 2618931Sandreas.hansson@arm.com * @return the size of the memory 2628931Sandreas.hansson@arm.com */ 2639098Sandreas.hansson@arm.com uint64_t size() const { return range.size(); } 2648923SN/A 2658931Sandreas.hansson@arm.com /** 2668931Sandreas.hansson@arm.com * Get the start address. 2678931Sandreas.hansson@arm.com * 2688931Sandreas.hansson@arm.com * @return the start address of the memory 2698931Sandreas.hansson@arm.com */ 2709405Sandreas.hansson@arm.com Addr start() const { return range.start(); } 2718923SN/A 2728931Sandreas.hansson@arm.com /** 2738931Sandreas.hansson@arm.com * Should this memory be passed to the kernel and part of the OS 2748931Sandreas.hansson@arm.com * physical memory layout. 2758931Sandreas.hansson@arm.com * 2768931Sandreas.hansson@arm.com * @return if this memory is reported 2778931Sandreas.hansson@arm.com */ 2788931Sandreas.hansson@arm.com bool isConfReported() const { return confTableReported; } 2792391SN/A 2808931Sandreas.hansson@arm.com /** 2818931Sandreas.hansson@arm.com * Some memories are used as shadow memories or should for other 2828931Sandreas.hansson@arm.com * reasons not be part of the global address map. 2838931Sandreas.hansson@arm.com * 2848931Sandreas.hansson@arm.com * @return if this memory is part of the address map 2858931Sandreas.hansson@arm.com */ 2868931Sandreas.hansson@arm.com bool isInAddrMap() const { return inAddrMap; } 2878931Sandreas.hansson@arm.com 2888931Sandreas.hansson@arm.com /** 28911614Sdavid.j.hashe@gmail.com * When shadow memories are in use, KVM may want to make one or the other, 29011614Sdavid.j.hashe@gmail.com * but cannot map both into the guest address space. 29111614Sdavid.j.hashe@gmail.com * 29211614Sdavid.j.hashe@gmail.com * @return if this memory should be mapped into the KVM guest address space 29311614Sdavid.j.hashe@gmail.com */ 29411614Sdavid.j.hashe@gmail.com bool isKvmMap() const { return kvmMap; } 29511614Sdavid.j.hashe@gmail.com 29611614Sdavid.j.hashe@gmail.com /** 2978931Sandreas.hansson@arm.com * Perform an untimed memory access and update all the state 2988931Sandreas.hansson@arm.com * (e.g. locked addresses) and statistics accordingly. The packet 2998931Sandreas.hansson@arm.com * is turned into a response if required. 3008931Sandreas.hansson@arm.com * 3018931Sandreas.hansson@arm.com * @param pkt Packet performing the access 3028931Sandreas.hansson@arm.com */ 3038931Sandreas.hansson@arm.com void access(PacketPtr pkt); 3048931Sandreas.hansson@arm.com 3058931Sandreas.hansson@arm.com /** 3068931Sandreas.hansson@arm.com * Perform an untimed memory read or write without changing 3078931Sandreas.hansson@arm.com * anything but the memory itself. No stats are affected by this 3088931Sandreas.hansson@arm.com * access. In addition to normal accesses this also facilitates 3098931Sandreas.hansson@arm.com * print requests. 3108931Sandreas.hansson@arm.com * 3118931Sandreas.hansson@arm.com * @param pkt Packet performing the access 3128931Sandreas.hansson@arm.com */ 3138931Sandreas.hansson@arm.com void functionalAccess(PacketPtr pkt); 3148931Sandreas.hansson@arm.com 3158931Sandreas.hansson@arm.com /** 3168719SN/A * Register Statistics 3178719SN/A */ 31811169Sandreas.hansson@arm.com void regStats() override; 3198719SN/A 3202391SN/A}; 3212391SN/A 32212492Sodanrc@yahoo.com.br#endif //__MEM_ABSTRACT_MEMORY_HH__ 323