packet.hh revision 12766
12381SN/A/* 212652Sandreas.sandberg@arm.com * Copyright (c) 2012-2018 ARM Limited 38949Sandreas.hansson@arm.com * All rights reserved 48949Sandreas.hansson@arm.com * 58949Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 68949Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 78949Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 88949Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 98949Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 108949Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 118949Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 128949Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 138949Sandreas.hansson@arm.com * 142592SN/A * Copyright (c) 2006 The Regents of The University of Michigan 1510975Sdavid.hashe@amd.com * Copyright (c) 2010,2015 Advanced Micro Devices, Inc. 162381SN/A * All rights reserved. 172381SN/A * 182381SN/A * Redistribution and use in source and binary forms, with or without 192381SN/A * modification, are permitted provided that the following conditions are 202381SN/A * met: redistributions of source code must retain the above copyright 212381SN/A * notice, this list of conditions and the following disclaimer; 222381SN/A * redistributions in binary form must reproduce the above copyright 232381SN/A * notice, this list of conditions and the following disclaimer in the 242381SN/A * documentation and/or other materials provided with the distribution; 252381SN/A * neither the name of the copyright holders nor the names of its 262381SN/A * contributors may be used to endorse or promote products derived from 272381SN/A * this software without specific prior written permission. 282381SN/A * 292381SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 302381SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 312381SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 322381SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 332381SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 342381SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 352381SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 362381SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 372381SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 382381SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 392381SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 402665Ssaidi@eecs.umich.edu * 412665Ssaidi@eecs.umich.edu * Authors: Ron Dreslinski 422665Ssaidi@eecs.umich.edu * Steve Reinhardt 432665Ssaidi@eecs.umich.edu * Ali Saidi 449031Sandreas.hansson@arm.com * Andreas Hansson 4512349Snikos.nikoleris@arm.com * Nikos Nikoleris 462381SN/A */ 472381SN/A 482381SN/A/** 492381SN/A * @file 502662Sstever@eecs.umich.edu * Declaration of the Packet class. 512381SN/A */ 522381SN/A 532381SN/A#ifndef __MEM_PACKET_HH__ 542381SN/A#define __MEM_PACKET_HH__ 552381SN/A 568229Snate@binkert.org#include <bitset> 573348Sbinkertn@umich.edu#include <cassert> 583348Sbinkertn@umich.edu#include <list> 593348Sbinkertn@umich.edu 605735Snate@binkert.org#include "base/cast.hh" 614024Sbinkertn@umich.edu#include "base/compiler.hh" 625735Snate@binkert.org#include "base/flags.hh" 6312334Sgabeblack@google.com#include "base/logging.hh" 645314Sstever@gmail.com#include "base/printable.hh" 656216Snate@binkert.org#include "base/types.hh" 662392SN/A#include "mem/request.hh" 674167Sbinkertn@umich.edu#include "sim/core.hh" 682394SN/A 698737Skoansin.tan@gmail.comclass Packet; 703349Sbinkertn@umich.edutypedef Packet *PacketPtr; 712394SN/Atypedef uint8_t* PacketDataPtr; 722812Srdreslin@umich.edutypedef std::list<PacketPtr> PacketList; 7312351Snikos.nikoleris@arm.comtypedef uint64_t PacketId; 742812Srdreslin@umich.edu 754022Sstever@eecs.umich.educlass MemCmd 764022Sstever@eecs.umich.edu{ 775735Snate@binkert.org friend class Packet; 785735Snate@binkert.org 794022Sstever@eecs.umich.edu public: 805735Snate@binkert.org /** 815735Snate@binkert.org * List of all commands associated with a packet. 825735Snate@binkert.org */ 834022Sstever@eecs.umich.edu enum Command 844022Sstever@eecs.umich.edu { 854022Sstever@eecs.umich.edu InvalidCmd, 864022Sstever@eecs.umich.edu ReadReq, 874473Sstever@eecs.umich.edu ReadResp, 885319Sstever@gmail.com ReadRespWithInvalidate, 894022Sstever@eecs.umich.edu WriteReq, 904022Sstever@eecs.umich.edu WriteResp, 9111199Sandreas.hansson@arm.com WritebackDirty, 9211199Sandreas.hansson@arm.com WritebackClean, 9312344Snikos.nikoleris@arm.com WriteClean, // writes dirty data below without evicting 9410883Sali.jafri@arm.com CleanEvict, 954022Sstever@eecs.umich.edu SoftPFReq, 964022Sstever@eecs.umich.edu HardPFReq, 974022Sstever@eecs.umich.edu SoftPFResp, 984022Sstever@eecs.umich.edu HardPFResp, 9910886Sandreas.hansson@arm.com WriteLineReq, 1004022Sstever@eecs.umich.edu UpgradeReq, 1017465Ssteve.reinhardt@amd.com SCUpgradeReq, // Special "weak" upgrade for StoreCond 1024628Sstever@eecs.umich.edu UpgradeResp, 1037465Ssteve.reinhardt@amd.com SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1047465Ssteve.reinhardt@amd.com UpgradeFailResp, // Valid for SCUpgradeReq only 1054022Sstever@eecs.umich.edu ReadExReq, 1064022Sstever@eecs.umich.edu ReadExResp, 10710885Sandreas.hansson@arm.com ReadCleanReq, 10810885Sandreas.hansson@arm.com ReadSharedReq, 1094626Sstever@eecs.umich.edu LoadLockedReq, 1104626Sstever@eecs.umich.edu StoreCondReq, 1117669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1124626Sstever@eecs.umich.edu StoreCondResp, 1134040Ssaidi@eecs.umich.edu SwapReq, 1144040Ssaidi@eecs.umich.edu SwapResp, 1155650Sgblack@eecs.umich.edu MessageReq, 1165650Sgblack@eecs.umich.edu MessageResp, 11711256Santhony.gutierrez@amd.com MemFenceReq, 11811256Santhony.gutierrez@amd.com MemFenceResp, 11912347Snikos.nikoleris@arm.com CleanSharedReq, 12012347Snikos.nikoleris@arm.com CleanSharedResp, 12112347Snikos.nikoleris@arm.com CleanInvalidReq, 12212347Snikos.nikoleris@arm.com CleanInvalidResp, 1234870Sstever@eecs.umich.edu // Error responses 1244870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1254870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1264870Sstever@eecs.umich.edu // compatibility 1274870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1284870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1298436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1308436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1315314Sstever@gmail.com // Fake simulator-only commands 1325314Sstever@gmail.com PrintReq, // Print state matching address 1338184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 13410886Sandreas.hansson@arm.com InvalidateReq, // request for address to be invalidated 13510886Sandreas.hansson@arm.com InvalidateResp, 1364022Sstever@eecs.umich.edu NUM_MEM_CMDS 1374022Sstever@eecs.umich.edu }; 1384022Sstever@eecs.umich.edu 1394022Sstever@eecs.umich.edu private: 1405735Snate@binkert.org /** 1415735Snate@binkert.org * List of command attributes. 1425735Snate@binkert.org */ 1434022Sstever@eecs.umich.edu enum Attribute 1444022Sstever@eecs.umich.edu { 1454626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1464626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1477465Ssteve.reinhardt@amd.com IsUpgrade, 1484022Sstever@eecs.umich.edu IsInvalidate, 14912347Snikos.nikoleris@arm.com IsClean, //!< Cleans any existing dirty blocks 15011284Sandreas.hansson@arm.com NeedsWritable, //!< Requires writable copy to complete in-cache 1514626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1524626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1534626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 15411199Sandreas.hansson@arm.com IsEviction, 1554022Sstever@eecs.umich.edu IsSWPrefetch, 1564022Sstever@eecs.umich.edu IsHWPrefetch, 1576076Sgblack@eecs.umich.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1584626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1594870Sstever@eecs.umich.edu IsError, //!< Error response 1605314Sstever@gmail.com IsPrint, //!< Print state matching address (for debugging) 1618184Ssomayeh@cs.wisc.edu IsFlush, //!< Flush the address from caches 16211600Sandreas.hansson@arm.com FromCache, //!< Request originated from a caching agent 1634022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1644022Sstever@eecs.umich.edu }; 1654022Sstever@eecs.umich.edu 1665735Snate@binkert.org /** 1675735Snate@binkert.org * Structure that defines attributes and other data associated 1685735Snate@binkert.org * with a Command. 1695735Snate@binkert.org */ 1705735Snate@binkert.org struct CommandInfo 1715735Snate@binkert.org { 1725735Snate@binkert.org /// Set of attribute flags. 1734022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1745735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1755735Snate@binkert.org /// response is applicable. 1764022Sstever@eecs.umich.edu const Command response; 1775735Snate@binkert.org /// String representation (for printing) 1784022Sstever@eecs.umich.edu const std::string str; 1794022Sstever@eecs.umich.edu }; 1804022Sstever@eecs.umich.edu 1815735Snate@binkert.org /// Array to map Command enum to associated info. 1824022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1834022Sstever@eecs.umich.edu 1844022Sstever@eecs.umich.edu private: 1854022Sstever@eecs.umich.edu 1864022Sstever@eecs.umich.edu Command cmd; 1874022Sstever@eecs.umich.edu 1885735Snate@binkert.org bool 1895735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1905735Snate@binkert.org { 1914022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1924022Sstever@eecs.umich.edu } 1934022Sstever@eecs.umich.edu 1944022Sstever@eecs.umich.edu public: 1954022Sstever@eecs.umich.edu 19610583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 19710583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 19810583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19910583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 20010583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 20111284Sandreas.hansson@arm.com bool needsWritable() const { return testCmdAttrib(NeedsWritable); } 20210583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 20310583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 20411199Sandreas.hansson@arm.com bool isEviction() const { return testCmdAttrib(IsEviction); } 20512347Snikos.nikoleris@arm.com bool isClean() const { return testCmdAttrib(IsClean); } 20611600Sandreas.hansson@arm.com bool fromCache() const { return testCmdAttrib(FromCache); } 20711199Sandreas.hansson@arm.com 20811199Sandreas.hansson@arm.com /** 20911199Sandreas.hansson@arm.com * A writeback is an eviction that carries data. 21011199Sandreas.hansson@arm.com */ 21111199Sandreas.hansson@arm.com bool isWriteback() const { return testCmdAttrib(IsEviction) && 21211199Sandreas.hansson@arm.com testCmdAttrib(HasData); } 21310570Sandreas.hansson@arm.com 21410570Sandreas.hansson@arm.com /** 21510570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 21610570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 21710570Sandreas.hansson@arm.com * valid or not. 21810570Sandreas.hansson@arm.com */ 2194022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2206102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 22110343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 22210343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 22310343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 22410343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2254870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2265314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2278184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2284022Sstever@eecs.umich.edu 22911294Sandreas.hansson@arm.com Command 2305735Snate@binkert.org responseCommand() const 2315735Snate@binkert.org { 2324022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2334022Sstever@eecs.umich.edu } 2344022Sstever@eecs.umich.edu 2355735Snate@binkert.org /// Return the string to a cmd given by idx. 2365735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2374022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2384022Sstever@eecs.umich.edu 2395735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2405735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2415735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2424022Sstever@eecs.umich.edu 2435735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2445735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2454022Sstever@eecs.umich.edu}; 2464022Sstever@eecs.umich.edu 2472381SN/A/** 2482662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2492662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2502662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2512662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2522662Sstever@eecs.umich.edu * different Packets along the way.) 2532381SN/A */ 2549044SAli.Saidi@ARM.comclass Packet : public Printable 2552381SN/A{ 2562813Srdreslin@umich.edu public: 2575735Snate@binkert.org typedef uint32_t FlagsType; 2585735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2594022Sstever@eecs.umich.edu 2605735Snate@binkert.org private: 2615735Snate@binkert.org 26210938Sandreas.hansson@arm.com enum : FlagsType { 26310938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 26412349Snikos.nikoleris@arm.com COPY_FLAGS = 0x0000003F, 26510938Sandreas.hansson@arm.com 26611284Sandreas.hansson@arm.com // Does this packet have sharers (which means it should not be 26711284Sandreas.hansson@arm.com // considered writable) or not. See setHasSharers below. 26811284Sandreas.hansson@arm.com HAS_SHARERS = 0x00000001, 26911284Sandreas.hansson@arm.com 27010938Sandreas.hansson@arm.com // Special control flags 27110938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 27210938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 27311284Sandreas.hansson@arm.com 27411284Sandreas.hansson@arm.com /// Allow a responding cache to inform the cache hierarchy 27511284Sandreas.hansson@arm.com /// that it had a writable copy before responding. See 27611284Sandreas.hansson@arm.com /// setResponderHadWritable below. 27711284Sandreas.hansson@arm.com RESPONDER_HAD_WRITABLE = 0x00000004, 27811284Sandreas.hansson@arm.com 27911284Sandreas.hansson@arm.com // Snoop co-ordination flag to indicate that a cache is 28011284Sandreas.hansson@arm.com // responding to a snoop. See setCacheResponding below. 28111284Sandreas.hansson@arm.com CACHE_RESPONDING = 0x00000008, 28210938Sandreas.hansson@arm.com 28312346Snikos.nikoleris@arm.com // The writeback/writeclean should be propagated further 28412346Snikos.nikoleris@arm.com // downstream by the receiver 28512346Snikos.nikoleris@arm.com WRITE_THROUGH = 0x00000010, 28612346Snikos.nikoleris@arm.com 28712349Snikos.nikoleris@arm.com // Response co-ordination flag for cache maintenance 28812349Snikos.nikoleris@arm.com // operations 28912349Snikos.nikoleris@arm.com SATISFIED = 0x00000020, 29012349Snikos.nikoleris@arm.com 29111057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 29211057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 29311057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 29411057Sandreas.hansson@arm.com 29510938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 29610938Sandreas.hansson@arm.com /// when the packet is destroyed? 29710938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 29810938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 29910938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 30010938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 30110938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 30210938Sandreas.hansson@arm.com 30310938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 30410938Sandreas.hansson@arm.com /// access failure. 30510938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 30610938Sandreas.hansson@arm.com 30710938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 30810938Sandreas.hansson@arm.com // through express snoop flag 30910938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 31010938Sandreas.hansson@arm.com }; 3115735Snate@binkert.org 3125735Snate@binkert.org Flags flags; 3135735Snate@binkert.org 3145735Snate@binkert.org public: 3154022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 3164022Sstever@eecs.umich.edu 3175735Snate@binkert.org /// The command field of the packet. 3184870Sstever@eecs.umich.edu MemCmd cmd; 3194870Sstever@eecs.umich.edu 32012351Snikos.nikoleris@arm.com const PacketId id; 32112351Snikos.nikoleris@arm.com 3225735Snate@binkert.org /// A pointer to the original request. 32312749Sgiacomo.travaglini@arm.com RequestPtr req; 3244870Sstever@eecs.umich.edu 3252566SN/A private: 3265735Snate@binkert.org /** 32712633Sodanrc@yahoo.com.br * A pointer to the data being transferred. It can be different 32812633Sodanrc@yahoo.com.br * sizes at each level of the hierarchy so it belongs to the 3295735Snate@binkert.org * packet, not request. This may or may not be populated when a 33012633Sodanrc@yahoo.com.br * responder receives the packet. If not populated memory should 3315735Snate@binkert.org * be allocated. 3322566SN/A */ 3332566SN/A PacketDataPtr data; 3342566SN/A 3355735Snate@binkert.org /// The address of the request. This address could be virtual or 3365735Snate@binkert.org /// physical, depending on the system configuration. 3372381SN/A Addr addr; 3382381SN/A 33910028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 34010028SGiacomo.Gabrielli@arm.com bool _isSecure; 34110028SGiacomo.Gabrielli@arm.com 3425735Snate@binkert.org /// The size of the request or transfer. 3436227Snate@binkert.org unsigned size; 3442381SN/A 3455735Snate@binkert.org /** 34610723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3478668Sgeoffrey.blake@arm.com */ 34810723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3498668Sgeoffrey.blake@arm.com 3502641Sstever@eecs.umich.edu public: 3512811Srdreslin@umich.edu 3529547Sandreas.hansson@arm.com /** 35310694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 35410405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 35510405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 35610405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 35710405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3589547Sandreas.hansson@arm.com */ 35910694SMarco.Balboni@ARM.com uint32_t headerDelay; 3603218Sgblack@eecs.umich.edu 3619547Sandreas.hansson@arm.com /** 36211127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 36311127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 36411127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 36511127Sandreas.hansson@arm.com * delay. 36611127Sandreas.hansson@arm.com */ 36711127Sandreas.hansson@arm.com uint32_t snoopDelay; 36811127Sandreas.hansson@arm.com 36911127Sandreas.hansson@arm.com /** 37010694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 37110694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 37210694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 37310694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 37410405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 37510405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3769547Sandreas.hansson@arm.com */ 37710694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3783218Sgblack@eecs.umich.edu 3795735Snate@binkert.org /** 3805735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3819542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3829542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3839542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3849542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3859542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3869542Sandreas.hansson@arm.com * particular sending device. 3879542Sandreas.hansson@arm.com * 3889542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3899542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3909542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3919542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3929542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3939542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3949542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3955735Snate@binkert.org */ 3965735Snate@binkert.org struct SenderState 3975735Snate@binkert.org { 3989542Sandreas.hansson@arm.com SenderState* predecessor; 3999542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 4002641Sstever@eecs.umich.edu virtual ~SenderState() {} 4012641Sstever@eecs.umich.edu }; 4022641Sstever@eecs.umich.edu 4035315Sstever@gmail.com /** 4045315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 4055315Sstever@gmail.com * field of a PrintReq should always be of this type. 4065315Sstever@gmail.com */ 4079044SAli.Saidi@ARM.com class PrintReqState : public SenderState 4085735Snate@binkert.org { 4095735Snate@binkert.org private: 4105735Snate@binkert.org /** 4115735Snate@binkert.org * An entry in the label stack. 4125735Snate@binkert.org */ 4135735Snate@binkert.org struct LabelStackEntry 4145735Snate@binkert.org { 4155314Sstever@gmail.com const std::string label; 4165314Sstever@gmail.com std::string *prefix; 4175314Sstever@gmail.com bool labelPrinted; 4185735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 4195314Sstever@gmail.com }; 4205314Sstever@gmail.com 4215314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 4225314Sstever@gmail.com LabelStack labelStack; 4235314Sstever@gmail.com 4245314Sstever@gmail.com std::string *curPrefixPtr; 4255314Sstever@gmail.com 4265314Sstever@gmail.com public: 4275314Sstever@gmail.com std::ostream &os; 4285314Sstever@gmail.com const int verbosity; 4295314Sstever@gmail.com 4305314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4315314Sstever@gmail.com ~PrintReqState(); 4325314Sstever@gmail.com 4335735Snate@binkert.org /** 4345735Snate@binkert.org * Returns the current line prefix. 4355735Snate@binkert.org */ 4365314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4375315Sstever@gmail.com 4385735Snate@binkert.org /** 4395735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4405315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4415735Snate@binkert.org * printed if an object within the label's scope is printed. 4425735Snate@binkert.org */ 4435314Sstever@gmail.com void pushLabel(const std::string &lbl, 4445314Sstever@gmail.com const std::string &prefix = " "); 4455735Snate@binkert.org 4465735Snate@binkert.org /** 4475735Snate@binkert.org * Pop a label off the label stack. 4485735Snate@binkert.org */ 4495314Sstever@gmail.com void popLabel(); 4505735Snate@binkert.org 4515735Snate@binkert.org /** 4525735Snate@binkert.org * Print all of the pending unprinted labels on the 4535315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4545735Snate@binkert.org * users unless bypassing printObj(). 4555735Snate@binkert.org */ 4565314Sstever@gmail.com void printLabels(); 4575735Snate@binkert.org 4585735Snate@binkert.org /** 4595735Snate@binkert.org * Print a Printable object to os, because it matched the 4605735Snate@binkert.org * address on a PrintReq. 4615735Snate@binkert.org */ 4625314Sstever@gmail.com void printObj(Printable *obj); 4635314Sstever@gmail.com }; 4645314Sstever@gmail.com 4655735Snate@binkert.org /** 4665735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4675735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4685735Snate@binkert.org * this variable is to allow a device to attach extra information 4699542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4705735Snate@binkert.org * that was attached to the original request (even if a new packet 4715735Snate@binkert.org * is created). 4725735Snate@binkert.org */ 4732662Sstever@eecs.umich.edu SenderState *senderState; 4742641Sstever@eecs.umich.edu 4759542Sandreas.hansson@arm.com /** 4769542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4779542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4789542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4799542Sandreas.hansson@arm.com * variable. 4809542Sandreas.hansson@arm.com * 4819542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4829542Sandreas.hansson@arm.com */ 4839542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4849542Sandreas.hansson@arm.com 4859542Sandreas.hansson@arm.com /** 4869542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4879542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4889542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4899542Sandreas.hansson@arm.com * variable. 4909542Sandreas.hansson@arm.com * 4919542Sandreas.hansson@arm.com * @return The current top of the stack 4929542Sandreas.hansson@arm.com */ 4939542Sandreas.hansson@arm.com SenderState *popSenderState(); 4949542Sandreas.hansson@arm.com 4959543Ssascha.bischoff@arm.com /** 4969543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4979543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4989543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4999543Ssascha.bischoff@arm.com * 5009543Ssascha.bischoff@arm.com * @return The topmost state of type T 5019543Ssascha.bischoff@arm.com */ 5029543Ssascha.bischoff@arm.com template <typename T> 5039543Ssascha.bischoff@arm.com T * findNextSenderState() const 5049543Ssascha.bischoff@arm.com { 5059543Ssascha.bischoff@arm.com T *t = NULL; 5069543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 5079543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 5089543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 5099543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 5109543Ssascha.bischoff@arm.com } 5119543Ssascha.bischoff@arm.com return t; 5129543Ssascha.bischoff@arm.com } 5139543Ssascha.bischoff@arm.com 5145735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 5155735Snate@binkert.org /// tracing). 5164022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 5172811Srdreslin@umich.edu 5185735Snate@binkert.org /// Return the index of this command. 5194022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 5202811Srdreslin@umich.edu 52110583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 52210583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 52310583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 52410583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 52510583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 52611287Sandreas.hansson@arm.com bool needsWritable() const 52711287Sandreas.hansson@arm.com { 52811287Sandreas.hansson@arm.com // we should never check if a response needsWritable, the 52911287Sandreas.hansson@arm.com // request has this flag, and for a response we should rather 53011287Sandreas.hansson@arm.com // look at the hasSharers flag (if not set, the response is to 53111287Sandreas.hansson@arm.com // be considered writable) 53211287Sandreas.hansson@arm.com assert(isRequest()); 53311287Sandreas.hansson@arm.com return cmd.needsWritable(); 53411287Sandreas.hansson@arm.com } 53510583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 53610583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 53711199Sandreas.hansson@arm.com bool isEviction() const { return cmd.isEviction(); } 53812347Snikos.nikoleris@arm.com bool isClean() const { return cmd.isClean(); } 53911600Sandreas.hansson@arm.com bool fromCache() const { return cmd.fromCache(); } 54011199Sandreas.hansson@arm.com bool isWriteback() const { return cmd.isWriteback(); } 54110583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 54211286Sandreas.hansson@arm.com bool hasRespData() const 54311286Sandreas.hansson@arm.com { 54411286Sandreas.hansson@arm.com MemCmd resp_cmd = cmd.responseCommand(); 54511286Sandreas.hansson@arm.com return resp_cmd.hasData(); 54611286Sandreas.hansson@arm.com } 54710583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 54810583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 54910583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 55010583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 5512812Srdreslin@umich.edu 55211284Sandreas.hansson@arm.com //@{ 55311284Sandreas.hansson@arm.com /// Snoop flags 55411284Sandreas.hansson@arm.com /** 55511284Sandreas.hansson@arm.com * Set the cacheResponding flag. This is used by the caches to 55611284Sandreas.hansson@arm.com * signal another cache that they are responding to a request. A 55711284Sandreas.hansson@arm.com * cache will only respond to snoops if it has the line in either 55811284Sandreas.hansson@arm.com * Modified or Owned state. Note that on snoop hits we always pass 55911284Sandreas.hansson@arm.com * the line as Modified and never Owned. In the case of an Owned 56011284Sandreas.hansson@arm.com * line we proceed to invalidate all other copies. 56111284Sandreas.hansson@arm.com * 56211284Sandreas.hansson@arm.com * On a cache fill (see Cache::handleFill), we check hasSharers 56311284Sandreas.hansson@arm.com * first, ignoring the cacheResponding flag if hasSharers is set. 56411284Sandreas.hansson@arm.com * A line is consequently allocated as: 56511284Sandreas.hansson@arm.com * 56611284Sandreas.hansson@arm.com * hasSharers cacheResponding state 56711284Sandreas.hansson@arm.com * true false Shared 56811284Sandreas.hansson@arm.com * true true Shared 56911284Sandreas.hansson@arm.com * false false Exclusive 57011284Sandreas.hansson@arm.com * false true Modified 57111284Sandreas.hansson@arm.com */ 57211284Sandreas.hansson@arm.com void setCacheResponding() 57310567Sandreas.hansson@arm.com { 57410567Sandreas.hansson@arm.com assert(isRequest()); 57511284Sandreas.hansson@arm.com assert(!flags.isSet(CACHE_RESPONDING)); 57611284Sandreas.hansson@arm.com flags.set(CACHE_RESPONDING); 57710567Sandreas.hansson@arm.com } 57811284Sandreas.hansson@arm.com bool cacheResponding() const { return flags.isSet(CACHE_RESPONDING); } 57911284Sandreas.hansson@arm.com /** 58011284Sandreas.hansson@arm.com * On fills, the hasSharers flag is used by the caches in 58111284Sandreas.hansson@arm.com * combination with the cacheResponding flag, as clarified 58211284Sandreas.hansson@arm.com * above. If the hasSharers flag is not set, the packet is passing 58311284Sandreas.hansson@arm.com * writable. Thus, a response from a memory passes the line as 58411284Sandreas.hansson@arm.com * writable by default. 58511284Sandreas.hansson@arm.com * 58611284Sandreas.hansson@arm.com * The hasSharers flag is also used by upstream caches to inform a 58711284Sandreas.hansson@arm.com * downstream cache that they have the block (by calling 58811284Sandreas.hansson@arm.com * setHasSharers on snoop request packets that hit in upstream 58911284Sandreas.hansson@arm.com * cachs tags or MSHRs). If the snoop packet has sharers, a 59011284Sandreas.hansson@arm.com * downstream cache is prevented from passing a dirty line upwards 59111284Sandreas.hansson@arm.com * if it was not explicitly asked for a writable copy. See 59211284Sandreas.hansson@arm.com * Cache::satisfyCpuSideRequest. 59311284Sandreas.hansson@arm.com * 59411284Sandreas.hansson@arm.com * The hasSharers flag is also used on writebacks, in 59511284Sandreas.hansson@arm.com * combination with the WritbackClean or WritebackDirty commands, 59611284Sandreas.hansson@arm.com * to allocate the block downstream either as: 59711284Sandreas.hansson@arm.com * 59811284Sandreas.hansson@arm.com * command hasSharers state 59911284Sandreas.hansson@arm.com * WritebackDirty false Modified 60011284Sandreas.hansson@arm.com * WritebackDirty true Owned 60111284Sandreas.hansson@arm.com * WritebackClean false Exclusive 60211284Sandreas.hansson@arm.com * WritebackClean true Shared 60311284Sandreas.hansson@arm.com */ 60411284Sandreas.hansson@arm.com void setHasSharers() { flags.set(HAS_SHARERS); } 60511284Sandreas.hansson@arm.com bool hasSharers() const { return flags.isSet(HAS_SHARERS); } 60611284Sandreas.hansson@arm.com //@} 6074870Sstever@eecs.umich.edu 60811284Sandreas.hansson@arm.com /** 60911284Sandreas.hansson@arm.com * The express snoop flag is used for two purposes. Firstly, it is 61011284Sandreas.hansson@arm.com * used to bypass flow control for normal (non-snoop) requests 61111284Sandreas.hansson@arm.com * going downstream in the memory system. In cases where a cache 61211284Sandreas.hansson@arm.com * is responding to a snoop from another cache (it had a dirty 61311284Sandreas.hansson@arm.com * line), but the line is not writable (and there are possibly 61411284Sandreas.hansson@arm.com * other copies), the express snoop flag is set by the downstream 61511284Sandreas.hansson@arm.com * cache to invalidate all other copies in zero time. Secondly, 61611284Sandreas.hansson@arm.com * the express snoop flag is also set to be able to distinguish 61711284Sandreas.hansson@arm.com * snoop packets that came from a downstream cache, rather than 61811284Sandreas.hansson@arm.com * snoop packets from neighbouring caches. 61911284Sandreas.hansson@arm.com */ 62011284Sandreas.hansson@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 62111284Sandreas.hansson@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 62211284Sandreas.hansson@arm.com 62311284Sandreas.hansson@arm.com /** 62411284Sandreas.hansson@arm.com * On responding to a snoop request (which only happens for 62511284Sandreas.hansson@arm.com * Modified or Owned lines), make sure that we can transform an 62611284Sandreas.hansson@arm.com * Owned response to a Modified one. If this flag is not set, the 62711284Sandreas.hansson@arm.com * responding cache had the line in the Owned state, and there are 62811284Sandreas.hansson@arm.com * possibly other Shared copies in the memory system. A downstream 62911284Sandreas.hansson@arm.com * cache helps in orchestrating the invalidation of these copies 63011284Sandreas.hansson@arm.com * by sending out the appropriate express snoops. 63111284Sandreas.hansson@arm.com */ 63211284Sandreas.hansson@arm.com void setResponderHadWritable() 63311284Sandreas.hansson@arm.com { 63411284Sandreas.hansson@arm.com assert(cacheResponding()); 63511746Snikos.nikoleris@arm.com assert(!responderHadWritable()); 63611284Sandreas.hansson@arm.com flags.set(RESPONDER_HAD_WRITABLE); 63711284Sandreas.hansson@arm.com } 63811284Sandreas.hansson@arm.com bool responderHadWritable() const 63911284Sandreas.hansson@arm.com { return flags.isSet(RESPONDER_HAD_WRITABLE); } 64011284Sandreas.hansson@arm.com 64112346Snikos.nikoleris@arm.com /** 64212346Snikos.nikoleris@arm.com * A writeback/writeclean cmd gets propagated further downstream 64312346Snikos.nikoleris@arm.com * by the receiver when the flag is set. 64412346Snikos.nikoleris@arm.com */ 64512346Snikos.nikoleris@arm.com void setWriteThrough() 64612346Snikos.nikoleris@arm.com { 64712346Snikos.nikoleris@arm.com assert(cmd.isWrite() && 64812346Snikos.nikoleris@arm.com (cmd.isEviction() || cmd == MemCmd::WriteClean)); 64912346Snikos.nikoleris@arm.com flags.set(WRITE_THROUGH); 65012346Snikos.nikoleris@arm.com } 65112346Snikos.nikoleris@arm.com void clearWriteThrough() { flags.clear(WRITE_THROUGH); } 65212346Snikos.nikoleris@arm.com bool writeThrough() const { return flags.isSet(WRITE_THROUGH); } 65312346Snikos.nikoleris@arm.com 65412349Snikos.nikoleris@arm.com /** 65512349Snikos.nikoleris@arm.com * Set when a request hits in a cache and the cache is not going 65612349Snikos.nikoleris@arm.com * to respond. This is used by the crossbar to coordinate 65712349Snikos.nikoleris@arm.com * responses for cache maintenance operations. 65812349Snikos.nikoleris@arm.com */ 65912349Snikos.nikoleris@arm.com void setSatisfied() 66012349Snikos.nikoleris@arm.com { 66112349Snikos.nikoleris@arm.com assert(cmd.isClean()); 66212349Snikos.nikoleris@arm.com assert(!flags.isSet(SATISFIED)); 66312349Snikos.nikoleris@arm.com flags.set(SATISFIED); 66412349Snikos.nikoleris@arm.com } 66512349Snikos.nikoleris@arm.com bool satisfied() const { return flags.isSet(SATISFIED); } 66612349Snikos.nikoleris@arm.com 6679951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 6689951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 66910763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 67010763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 67110883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 6724895Sstever@eecs.umich.edu 6734870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 6744870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 6754870Sstever@eecs.umich.edu // field, etc.) 6765735Snate@binkert.org void 6775735Snate@binkert.org setBadAddress() 6785735Snate@binkert.org { 6795735Snate@binkert.org assert(isResponse()); 6805735Snate@binkert.org cmd = MemCmd::BadAddressError; 6815735Snate@binkert.org } 6825735Snate@binkert.org 6834986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 6842814Srdreslin@umich.edu 68511057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 6869259SAli.Saidi@ARM.com /** 6879259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 6889259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 6899259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 6909259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 6919259SAli.Saidi@ARM.com * valid. 6929259SAli.Saidi@ARM.com */ 69311057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 6949259SAli.Saidi@ARM.com 69511057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 69610938Sandreas.hansson@arm.com 69710938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 69810938Sandreas.hansson@arm.com { 69910938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 70010938Sandreas.hansson@arm.com } 70110938Sandreas.hansson@arm.com 70210938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 70310938Sandreas.hansson@arm.com { 70410938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 70510938Sandreas.hansson@arm.com } 7062549SN/A 70711057Sandreas.hansson@arm.com bool isSecure() const 70811057Sandreas.hansson@arm.com { 70911057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 71011057Sandreas.hansson@arm.com return _isSecure; 71111057Sandreas.hansson@arm.com } 71210028SGiacomo.Gabrielli@arm.com 7135735Snate@binkert.org /** 71411306Santhony.gutierrez@amd.com * Accessor function to atomic op. 71511306Santhony.gutierrez@amd.com */ 71611306Santhony.gutierrez@amd.com AtomicOpFunctor *getAtomicOp() const { return req->getAtomicOpFunctor(); } 71711306Santhony.gutierrez@amd.com bool isAtomicOp() const { return req->isAtomic(); } 71811306Santhony.gutierrez@amd.com 71911306Santhony.gutierrez@amd.com /** 7207550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 72110938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 7227550SBrad.Beckmann@amd.com */ 7237550SBrad.Beckmann@amd.com void 7247550SBrad.Beckmann@amd.com convertScToWrite() 7257550SBrad.Beckmann@amd.com { 7267550SBrad.Beckmann@amd.com assert(isLLSC()); 7277550SBrad.Beckmann@amd.com assert(isWrite()); 7287550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 7297550SBrad.Beckmann@amd.com } 7307550SBrad.Beckmann@amd.com 7317550SBrad.Beckmann@amd.com /** 73210938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 73310938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 7347550SBrad.Beckmann@amd.com */ 7357550SBrad.Beckmann@amd.com void 7367550SBrad.Beckmann@amd.com convertLlToRead() 7377550SBrad.Beckmann@amd.com { 7387550SBrad.Beckmann@amd.com assert(isLLSC()); 7397550SBrad.Beckmann@amd.com assert(isRead()); 7407550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 7417550SBrad.Beckmann@amd.com } 7427550SBrad.Beckmann@amd.com 7437550SBrad.Beckmann@amd.com /** 74410938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 74511057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 74611057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 7475735Snate@binkert.org */ 74812749Sgiacomo.travaglini@arm.com Packet(const RequestPtr &_req, MemCmd _cmd) 74912749Sgiacomo.travaglini@arm.com : cmd(_cmd), id((PacketId)_req.get()), req(_req), data(nullptr), 75012749Sgiacomo.travaglini@arm.com addr(0), _isSecure(false), size(0), headerDelay(0), snoopDelay(0), 75112351Snikos.nikoleris@arm.com payloadDelay(0), senderState(NULL) 75211057Sandreas.hansson@arm.com { 75311057Sandreas.hansson@arm.com if (req->hasPaddr()) { 75411057Sandreas.hansson@arm.com addr = req->getPaddr(); 75511057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 75611057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 75711057Sandreas.hansson@arm.com } 75811057Sandreas.hansson@arm.com if (req->hasSize()) { 75911057Sandreas.hansson@arm.com size = req->getSize(); 76011057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 76111057Sandreas.hansson@arm.com } 76211057Sandreas.hansson@arm.com } 76311057Sandreas.hansson@arm.com 76411057Sandreas.hansson@arm.com /** 76511057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 76611057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 76711057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 76811057Sandreas.hansson@arm.com */ 76912749Sgiacomo.travaglini@arm.com Packet(const RequestPtr &_req, MemCmd _cmd, int _blkSize, PacketId _id = 0) 77012749Sgiacomo.travaglini@arm.com : cmd(_cmd), id(_id ? _id : (PacketId)_req.get()), req(_req), 77112749Sgiacomo.travaglini@arm.com data(nullptr), addr(0), _isSecure(false), headerDelay(0), 77212749Sgiacomo.travaglini@arm.com snoopDelay(0), payloadDelay(0), senderState(NULL) 77311057Sandreas.hansson@arm.com { 77411057Sandreas.hansson@arm.com if (req->hasPaddr()) { 77511057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 77611057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 77711057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 77811057Sandreas.hansson@arm.com } 77911057Sandreas.hansson@arm.com size = _blkSize; 78011057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 78111057Sandreas.hansson@arm.com } 7824626Sstever@eecs.umich.edu 7835735Snate@binkert.org /** 7845735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 7854887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 7864887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 7874887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 7885735Snate@binkert.org * packet should allocate its own data. 7895735Snate@binkert.org */ 79010896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 79112351Snikos.nikoleris@arm.com : cmd(pkt->cmd), id(pkt->id), req(pkt->req), 79210571Sandreas.hansson@arm.com data(nullptr), 79310028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 79410723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 79510694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 79611127Sandreas.hansson@arm.com snoopDelay(0), 79710694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 7989546Sandreas.hansson@arm.com senderState(pkt->senderState) 7994626Sstever@eecs.umich.edu { 80010571Sandreas.hansson@arm.com if (!clear_flags) 8015735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 8025735Snate@binkert.org 80311057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 80411057Sandreas.hansson@arm.com 80510571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 80610571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 80710571Sandreas.hansson@arm.com // co-ordinate state changes 80810571Sandreas.hansson@arm.com if (alloc_data) { 80910571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 81010571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 81110571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 81210571Sandreas.hansson@arm.com // carry the pointer forward 81310571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 81410571Sandreas.hansson@arm.com data = pkt->data; 81510571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 81610571Sandreas.hansson@arm.com } else { 81710571Sandreas.hansson@arm.com allocate(); 81810571Sandreas.hansson@arm.com } 81910571Sandreas.hansson@arm.com } 82010342SCurtis.Dunham@arm.com } 8218668Sgeoffrey.blake@arm.com 82210342SCurtis.Dunham@arm.com /** 82310739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 82410342SCurtis.Dunham@arm.com */ 82510739Ssteve.reinhardt@amd.com static MemCmd 82612749Sgiacomo.travaglini@arm.com makeReadCmd(const RequestPtr &req) 82710342SCurtis.Dunham@arm.com { 82810739Ssteve.reinhardt@amd.com if (req->isLLSC()) 82910739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 83010739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 83110739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 83210739Ssteve.reinhardt@amd.com else 83310739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 83410739Ssteve.reinhardt@amd.com } 83510739Ssteve.reinhardt@amd.com 83610739Ssteve.reinhardt@amd.com /** 83710739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 83810739Ssteve.reinhardt@amd.com */ 83910739Ssteve.reinhardt@amd.com static MemCmd 84012749Sgiacomo.travaglini@arm.com makeWriteCmd(const RequestPtr &req) 84110739Ssteve.reinhardt@amd.com { 84210739Ssteve.reinhardt@amd.com if (req->isLLSC()) 84310739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 84412766Sqtt2@cornell.edu else if (req->isSwap() || req->isAtomic()) 84510739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 84612347Snikos.nikoleris@arm.com else if (req->isCacheInvalidate()) { 84712347Snikos.nikoleris@arm.com return req->isCacheClean() ? MemCmd::CleanInvalidReq : 84812347Snikos.nikoleris@arm.com MemCmd::InvalidateReq; 84912347Snikos.nikoleris@arm.com } else if (req->isCacheClean()) { 85012347Snikos.nikoleris@arm.com return MemCmd::CleanSharedReq; 85112347Snikos.nikoleris@arm.com } else 85210739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 85310342SCurtis.Dunham@arm.com } 85410342SCurtis.Dunham@arm.com 85510342SCurtis.Dunham@arm.com /** 85610342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 85710739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 85810342SCurtis.Dunham@arm.com */ 85910342SCurtis.Dunham@arm.com static PacketPtr 86012749Sgiacomo.travaglini@arm.com createRead(const RequestPtr &req) 86110342SCurtis.Dunham@arm.com { 86210739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 86310342SCurtis.Dunham@arm.com } 86410342SCurtis.Dunham@arm.com 86510342SCurtis.Dunham@arm.com static PacketPtr 86612749Sgiacomo.travaglini@arm.com createWrite(const RequestPtr &req) 86710342SCurtis.Dunham@arm.com { 86810739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 8692641Sstever@eecs.umich.edu } 8702549SN/A 8715735Snate@binkert.org /** 8725735Snate@binkert.org * clean up packet variables 8735735Snate@binkert.org */ 8742566SN/A ~Packet() 8755387Sstever@gmail.com { 8765735Snate@binkert.org deleteData(); 8775387Sstever@gmail.com } 8782566SN/A 8795735Snate@binkert.org /** 8804626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 88110660Sandreas.hansson@arm.com * returning as a response to that request. 8824626Sstever@eecs.umich.edu */ 8835735Snate@binkert.org void 8845735Snate@binkert.org makeResponse() 8854626Sstever@eecs.umich.edu { 8862662Sstever@eecs.umich.edu assert(needsResponse()); 8872855Srdreslin@umich.edu assert(isRequest()); 8884022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 8895745Snate@binkert.org 8907464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 8917464Ssteve.reinhardt@amd.com // triggered them was 8927464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 8932641Sstever@eecs.umich.edu } 8942641Sstever@eecs.umich.edu 8955735Snate@binkert.org void 8965735Snate@binkert.org makeAtomicResponse() 8974870Sstever@eecs.umich.edu { 8984870Sstever@eecs.umich.edu makeResponse(); 8994870Sstever@eecs.umich.edu } 9004870Sstever@eecs.umich.edu 9015735Snate@binkert.org void 9025735Snate@binkert.org makeTimingResponse() 9033348Sbinkertn@umich.edu { 9044870Sstever@eecs.umich.edu makeResponse(); 9053135Srdreslin@umich.edu } 9063135Srdreslin@umich.edu 9078436SBrad.Beckmann@amd.com void 9088436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 9098436SBrad.Beckmann@amd.com { 9108436SBrad.Beckmann@amd.com if (!success) { 9118436SBrad.Beckmann@amd.com if (isWrite()) { 9128436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 9138436SBrad.Beckmann@amd.com } else { 9148436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 9158436SBrad.Beckmann@amd.com } 9168436SBrad.Beckmann@amd.com } 9178436SBrad.Beckmann@amd.com } 9188436SBrad.Beckmann@amd.com 91911057Sandreas.hansson@arm.com void 92011057Sandreas.hansson@arm.com setSize(unsigned size) 92111057Sandreas.hansson@arm.com { 92211057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 92311057Sandreas.hansson@arm.com 92411057Sandreas.hansson@arm.com this->size = size; 92511057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 92611057Sandreas.hansson@arm.com } 92711057Sandreas.hansson@arm.com 92811057Sandreas.hansson@arm.com 92911013Sandreas.sandberg@arm.com public: 93011013Sandreas.sandberg@arm.com /** 93111013Sandreas.sandberg@arm.com * @{ 93211013Sandreas.sandberg@arm.com * @name Data accessor mehtods 93311013Sandreas.sandberg@arm.com */ 93411013Sandreas.sandberg@arm.com 9353348Sbinkertn@umich.edu /** 9363348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 93710571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 93810571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 93910571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 94010571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 94110571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 94210571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 94310571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 94410571Sandreas.hansson@arm.com * to the source, no copies are necessary. 9452566SN/A */ 9462566SN/A template <typename T> 9473348Sbinkertn@umich.edu void 9483348Sbinkertn@umich.edu dataStatic(T *p) 9493348Sbinkertn@umich.edu { 95010566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9513348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9525735Snate@binkert.org flags.set(STATIC_DATA); 9533348Sbinkertn@umich.edu } 9542566SN/A 9553348Sbinkertn@umich.edu /** 95610564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 95710564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 95810564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 95910564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 96010564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 96110564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 96210564Sandreas.hansson@arm.com */ 96310564Sandreas.hansson@arm.com template <typename T> 96410564Sandreas.hansson@arm.com void 96510564Sandreas.hansson@arm.com dataStaticConst(const T *p) 96610564Sandreas.hansson@arm.com { 96710566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 96810564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 96910564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 97010564Sandreas.hansson@arm.com } 97110564Sandreas.hansson@arm.com 97210564Sandreas.hansson@arm.com /** 9733348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 97410571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 97510571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 97610571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 97710571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 97810571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 97910571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 98010571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 98110571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 98210571Sandreas.hansson@arm.com * before it is deallocated. 9833348Sbinkertn@umich.edu */ 9842566SN/A template <typename T> 9853348Sbinkertn@umich.edu void 9863348Sbinkertn@umich.edu dataDynamic(T *p) 9873348Sbinkertn@umich.edu { 98810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9893348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9905735Snate@binkert.org flags.set(DYNAMIC_DATA); 9913348Sbinkertn@umich.edu } 9923348Sbinkertn@umich.edu 9935735Snate@binkert.org /** 9945735Snate@binkert.org * get a pointer to the data ptr. 9955735Snate@binkert.org */ 9963348Sbinkertn@umich.edu template <typename T> 9973348Sbinkertn@umich.edu T* 99810562Sandreas.hansson@arm.com getPtr() 9993348Sbinkertn@umich.edu { 100010562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 10013348Sbinkertn@umich.edu return (T*)data; 10023348Sbinkertn@umich.edu } 10032566SN/A 100410563Sandreas.hansson@arm.com template <typename T> 100510563Sandreas.hansson@arm.com const T* 100610563Sandreas.hansson@arm.com getConstPtr() const 100710563Sandreas.hansson@arm.com { 100810563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 100910563Sandreas.hansson@arm.com return (const T*)data; 101010563Sandreas.hansson@arm.com } 101110563Sandreas.hansson@arm.com 10125735Snate@binkert.org /** 101311013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 101411013Sandreas.sandberg@arm.com * host endian. 101511013Sandreas.sandberg@arm.com */ 101611013Sandreas.sandberg@arm.com template <typename T> 101711013Sandreas.sandberg@arm.com T getBE() const; 101811013Sandreas.sandberg@arm.com 101911013Sandreas.sandberg@arm.com /** 102011013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 102111013Sandreas.sandberg@arm.com * host endian. 102211013Sandreas.sandberg@arm.com */ 102311013Sandreas.sandberg@arm.com template <typename T> 102411013Sandreas.sandberg@arm.com T getLE() const; 102511013Sandreas.sandberg@arm.com 102611013Sandreas.sandberg@arm.com /** 102711013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 102811013Sandreas.sandberg@arm.com * endianness. 102911013Sandreas.sandberg@arm.com */ 103011013Sandreas.sandberg@arm.com template <typename T> 103111013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 103211013Sandreas.sandberg@arm.com 103311013Sandreas.sandberg@arm.com /** 103411013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 103511013Sandreas.sandberg@arm.com * endian. 10365735Snate@binkert.org */ 10372566SN/A template <typename T> 103810563Sandreas.hansson@arm.com T get() const; 10392566SN/A 104011013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 104111013Sandreas.sandberg@arm.com template <typename T> 104211013Sandreas.sandberg@arm.com void setBE(T v); 104311013Sandreas.sandberg@arm.com 104411013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 104511013Sandreas.sandberg@arm.com template <typename T> 104611013Sandreas.sandberg@arm.com void setLE(T v); 104711013Sandreas.sandberg@arm.com 10485735Snate@binkert.org /** 104911013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 105011013Sandreas.sandberg@arm.com * endianness. 10515735Snate@binkert.org */ 10522566SN/A template <typename T> 105311013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 105411013Sandreas.sandberg@arm.com 105511013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 105611013Sandreas.sandberg@arm.com template <typename T> 10572592SN/A void set(T v); 10582566SN/A 105912652Sandreas.sandberg@arm.com 106012652Sandreas.sandberg@arm.com /** 106112652Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 106212652Sandreas.sandberg@arm.com * endianness and zero-extended to 64 bits. 106312652Sandreas.sandberg@arm.com */ 106412652Sandreas.sandberg@arm.com uint64_t getUintX(ByteOrder endian) const; 106512652Sandreas.sandberg@arm.com 106612652Sandreas.sandberg@arm.com /** 106712652Sandreas.sandberg@arm.com * Set the value in the word w after truncating it to the length 106812652Sandreas.sandberg@arm.com * of the packet and then byteswapping it to the desired 106912652Sandreas.sandberg@arm.com * endianness. 107012652Sandreas.sandberg@arm.com */ 107112652Sandreas.sandberg@arm.com void setUintX(uint64_t w, ByteOrder endian); 107212652Sandreas.sandberg@arm.com 10733348Sbinkertn@umich.edu /** 10744626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 10754626Sstever@eecs.umich.edu */ 10765735Snate@binkert.org void 107710563Sandreas.hansson@arm.com setData(const uint8_t *p) 10784626Sstever@eecs.umich.edu { 107910571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 108010571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 108110571Sandreas.hansson@arm.com // same pointer from source to destination and back 108210571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 108310571Sandreas.hansson@arm.com 10847691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 108510571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 108610571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 10877691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 10884626Sstever@eecs.umich.edu } 10894626Sstever@eecs.umich.edu 10904626Sstever@eecs.umich.edu /** 10914626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 10924626Sstever@eecs.umich.edu * which is aligned to the given block size. 10934626Sstever@eecs.umich.edu */ 10945735Snate@binkert.org void 109510563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 10964626Sstever@eecs.umich.edu { 10974626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 10984626Sstever@eecs.umich.edu } 10994626Sstever@eecs.umich.edu 11004626Sstever@eecs.umich.edu /** 110112633Sodanrc@yahoo.com.br * Copy data from the packet to the memory at the provided pointer. 110212633Sodanrc@yahoo.com.br * @param p Pointer to which data will be copied. 11034626Sstever@eecs.umich.edu */ 11045735Snate@binkert.org void 110510563Sandreas.hansson@arm.com writeData(uint8_t *p) const 11064626Sstever@eecs.umich.edu { 110710563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 11084626Sstever@eecs.umich.edu } 11094626Sstever@eecs.umich.edu 11104626Sstever@eecs.umich.edu /** 111112633Sodanrc@yahoo.com.br * Copy data from the packet to the provided block pointer, which 111212633Sodanrc@yahoo.com.br * is aligned to the given block size. 111312633Sodanrc@yahoo.com.br * @param blk_data Pointer to block to which data will be copied. 111412633Sodanrc@yahoo.com.br * @param blkSize Block size in bytes. 11154626Sstever@eecs.umich.edu */ 11165735Snate@binkert.org void 111710563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 11184626Sstever@eecs.umich.edu { 11194626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 11204626Sstever@eecs.umich.edu } 11214626Sstever@eecs.umich.edu 11224626Sstever@eecs.umich.edu /** 11233348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 11243348Sbinkertn@umich.edu * matter how data was allocted. 11253348Sbinkertn@umich.edu */ 11265735Snate@binkert.org void 11275735Snate@binkert.org deleteData() 11285735Snate@binkert.org { 112910566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 11305735Snate@binkert.org delete [] data; 11315735Snate@binkert.org 113210566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 11335735Snate@binkert.org data = NULL; 11345735Snate@binkert.org } 11352566SN/A 113610565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 11375735Snate@binkert.org void 11385735Snate@binkert.org allocate() 11395735Snate@binkert.org { 114011286Sandreas.hansson@arm.com // if either this command or the response command has a data 114111286Sandreas.hansson@arm.com // payload, actually allocate space 114211286Sandreas.hansson@arm.com if (hasData() || hasRespData()) { 114311286Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 114411286Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 114511286Sandreas.hansson@arm.com data = new uint8_t[getSize()]; 114611286Sandreas.hansson@arm.com } 11475735Snate@binkert.org } 11485735Snate@binkert.org 114911013Sandreas.sandberg@arm.com /** @} */ 115011013Sandreas.sandberg@arm.com 115111013Sandreas.sandberg@arm.com private: // Private data accessor methods 115211013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 115311013Sandreas.sandberg@arm.com template <typename T> 115411013Sandreas.sandberg@arm.com T getRaw() const; 115511013Sandreas.sandberg@arm.com 115611013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 115711013Sandreas.sandberg@arm.com template <typename T> 115811013Sandreas.sandberg@arm.com void setRaw(T v); 115911013Sandreas.sandberg@arm.com 116011013Sandreas.sandberg@arm.com public: 11614626Sstever@eecs.umich.edu /** 116210570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 116310570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 116410570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 116510570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 116610570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 116710570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 116810570Sandreas.hansson@arm.com * accordingly. 116910570Sandreas.hansson@arm.com */ 117010570Sandreas.hansson@arm.com bool 117110570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 117210570Sandreas.hansson@arm.com { 117310570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 117410570Sandreas.hansson@arm.com // data pointer 117510570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 117610570Sandreas.hansson@arm.com other->getSize(), 117710570Sandreas.hansson@arm.com other->hasData() ? 117810570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 117910570Sandreas.hansson@arm.com } 118010570Sandreas.hansson@arm.com 118110570Sandreas.hansson@arm.com /** 118210883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 118310883Sali.jafri@arm.com * in the memory hierarchy above. 118410883Sali.jafri@arm.com **/ 118510883Sali.jafri@arm.com bool 118610883Sali.jafri@arm.com mustCheckAbove() const 118710883Sali.jafri@arm.com { 118811199Sandreas.hansson@arm.com return cmd == MemCmd::HardPFReq || isEviction(); 118911199Sandreas.hansson@arm.com } 119011199Sandreas.hansson@arm.com 119111199Sandreas.hansson@arm.com /** 119211199Sandreas.hansson@arm.com * Is this packet a clean eviction, including both actual clean 119311199Sandreas.hansson@arm.com * evict packets, but also clean writebacks. 119411199Sandreas.hansson@arm.com */ 119511199Sandreas.hansson@arm.com bool 119611199Sandreas.hansson@arm.com isCleanEviction() const 119711199Sandreas.hansson@arm.com { 119811199Sandreas.hansson@arm.com return cmd == MemCmd::CleanEvict || cmd == MemCmd::WritebackClean; 119910883Sali.jafri@arm.com } 120010883Sali.jafri@arm.com 120110883Sali.jafri@arm.com /** 12024626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 120310570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 120410570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 120510570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 12064626Sstever@eecs.umich.edu * memory value. 12074626Sstever@eecs.umich.edu */ 12085735Snate@binkert.org bool 120910570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 121010570Sandreas.hansson@arm.com uint8_t *_data); 12115314Sstever@gmail.com 12125315Sstever@gmail.com /** 12135315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 12145315Sstever@gmail.com */ 12155735Snate@binkert.org void 12165735Snate@binkert.org pushLabel(const std::string &lbl) 12175735Snate@binkert.org { 12185735Snate@binkert.org if (isPrint()) 12195735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 12205314Sstever@gmail.com } 12215314Sstever@gmail.com 12225315Sstever@gmail.com /** 12235315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 12245315Sstever@gmail.com */ 12255735Snate@binkert.org void 12265735Snate@binkert.org popLabel() 12275735Snate@binkert.org { 12285735Snate@binkert.org if (isPrint()) 12295735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 12305314Sstever@gmail.com } 12315314Sstever@gmail.com 12325314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 12335314Sstever@gmail.com const std::string &prefix = "") const; 12349663Suri.wiener@arm.com 12359663Suri.wiener@arm.com /** 12369663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 12379663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 12389663Suri.wiener@arm.com * avoiding string overheads in fast mode 12399663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 12409663Suri.wiener@arm.com */ 12419663Suri.wiener@arm.com std::string print() const; 12422381SN/A}; 12432381SN/A 12442381SN/A#endif //__MEM_PACKET_HH 1245