packet.hh revision 12346
12381SN/A/* 212344Snikos.nikoleris@arm.com * Copyright (c) 2012-2017 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 452381SN/A */ 462381SN/A 472381SN/A/** 482381SN/A * @file 492662Sstever@eecs.umich.edu * Declaration of the Packet class. 502381SN/A */ 512381SN/A 522381SN/A#ifndef __MEM_PACKET_HH__ 532381SN/A#define __MEM_PACKET_HH__ 542381SN/A 558229Snate@binkert.org#include <bitset> 563348Sbinkertn@umich.edu#include <cassert> 573348Sbinkertn@umich.edu#include <list> 583348Sbinkertn@umich.edu 595735Snate@binkert.org#include "base/cast.hh" 604024Sbinkertn@umich.edu#include "base/compiler.hh" 615735Snate@binkert.org#include "base/flags.hh" 6212334Sgabeblack@google.com#include "base/logging.hh" 635314Sstever@gmail.com#include "base/printable.hh" 646216Snate@binkert.org#include "base/types.hh" 652392SN/A#include "mem/request.hh" 664167Sbinkertn@umich.edu#include "sim/core.hh" 672394SN/A 688737Skoansin.tan@gmail.comclass Packet; 693349Sbinkertn@umich.edutypedef Packet *PacketPtr; 702394SN/Atypedef uint8_t* PacketDataPtr; 712812Srdreslin@umich.edutypedef std::list<PacketPtr> PacketList; 722812Srdreslin@umich.edu 734022Sstever@eecs.umich.educlass MemCmd 744022Sstever@eecs.umich.edu{ 755735Snate@binkert.org friend class Packet; 765735Snate@binkert.org 774022Sstever@eecs.umich.edu public: 785735Snate@binkert.org /** 795735Snate@binkert.org * List of all commands associated with a packet. 805735Snate@binkert.org */ 814022Sstever@eecs.umich.edu enum Command 824022Sstever@eecs.umich.edu { 834022Sstever@eecs.umich.edu InvalidCmd, 844022Sstever@eecs.umich.edu ReadReq, 854473Sstever@eecs.umich.edu ReadResp, 865319Sstever@gmail.com ReadRespWithInvalidate, 874022Sstever@eecs.umich.edu WriteReq, 884022Sstever@eecs.umich.edu WriteResp, 8911199Sandreas.hansson@arm.com WritebackDirty, 9011199Sandreas.hansson@arm.com WritebackClean, 9112344Snikos.nikoleris@arm.com WriteClean, // writes dirty data below without evicting 9210883Sali.jafri@arm.com CleanEvict, 934022Sstever@eecs.umich.edu SoftPFReq, 944022Sstever@eecs.umich.edu HardPFReq, 954022Sstever@eecs.umich.edu SoftPFResp, 964022Sstever@eecs.umich.edu HardPFResp, 9710886Sandreas.hansson@arm.com WriteLineReq, 984022Sstever@eecs.umich.edu UpgradeReq, 997465Ssteve.reinhardt@amd.com SCUpgradeReq, // Special "weak" upgrade for StoreCond 1004628Sstever@eecs.umich.edu UpgradeResp, 1017465Ssteve.reinhardt@amd.com SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1027465Ssteve.reinhardt@amd.com UpgradeFailResp, // Valid for SCUpgradeReq only 1034022Sstever@eecs.umich.edu ReadExReq, 1044022Sstever@eecs.umich.edu ReadExResp, 10510885Sandreas.hansson@arm.com ReadCleanReq, 10610885Sandreas.hansson@arm.com ReadSharedReq, 1074626Sstever@eecs.umich.edu LoadLockedReq, 1084626Sstever@eecs.umich.edu StoreCondReq, 1097669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1104626Sstever@eecs.umich.edu StoreCondResp, 1114040Ssaidi@eecs.umich.edu SwapReq, 1124040Ssaidi@eecs.umich.edu SwapResp, 1135650Sgblack@eecs.umich.edu MessageReq, 1145650Sgblack@eecs.umich.edu MessageResp, 11511256Santhony.gutierrez@amd.com MemFenceReq, 11611256Santhony.gutierrez@amd.com MemFenceResp, 1174870Sstever@eecs.umich.edu // Error responses 1184870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1194870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1204870Sstever@eecs.umich.edu // compatibility 1214870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1224870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1238436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1248436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1255314Sstever@gmail.com // Fake simulator-only commands 1265314Sstever@gmail.com PrintReq, // Print state matching address 1278184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 12810886Sandreas.hansson@arm.com InvalidateReq, // request for address to be invalidated 12910886Sandreas.hansson@arm.com InvalidateResp, 1304022Sstever@eecs.umich.edu NUM_MEM_CMDS 1314022Sstever@eecs.umich.edu }; 1324022Sstever@eecs.umich.edu 1334022Sstever@eecs.umich.edu private: 1345735Snate@binkert.org /** 1355735Snate@binkert.org * List of command attributes. 1365735Snate@binkert.org */ 1374022Sstever@eecs.umich.edu enum Attribute 1384022Sstever@eecs.umich.edu { 1394626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1404626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1417465Ssteve.reinhardt@amd.com IsUpgrade, 1424022Sstever@eecs.umich.edu IsInvalidate, 14311284Sandreas.hansson@arm.com NeedsWritable, //!< Requires writable copy to complete in-cache 1444626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1454626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1464626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 14711199Sandreas.hansson@arm.com IsEviction, 1484022Sstever@eecs.umich.edu IsSWPrefetch, 1494022Sstever@eecs.umich.edu IsHWPrefetch, 1506076Sgblack@eecs.umich.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1514626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1524870Sstever@eecs.umich.edu IsError, //!< Error response 1535314Sstever@gmail.com IsPrint, //!< Print state matching address (for debugging) 1548184Ssomayeh@cs.wisc.edu IsFlush, //!< Flush the address from caches 15511600Sandreas.hansson@arm.com FromCache, //!< Request originated from a caching agent 1564022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1574022Sstever@eecs.umich.edu }; 1584022Sstever@eecs.umich.edu 1595735Snate@binkert.org /** 1605735Snate@binkert.org * Structure that defines attributes and other data associated 1615735Snate@binkert.org * with a Command. 1625735Snate@binkert.org */ 1635735Snate@binkert.org struct CommandInfo 1645735Snate@binkert.org { 1655735Snate@binkert.org /// Set of attribute flags. 1664022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1675735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1685735Snate@binkert.org /// response is applicable. 1694022Sstever@eecs.umich.edu const Command response; 1705735Snate@binkert.org /// String representation (for printing) 1714022Sstever@eecs.umich.edu const std::string str; 1724022Sstever@eecs.umich.edu }; 1734022Sstever@eecs.umich.edu 1745735Snate@binkert.org /// Array to map Command enum to associated info. 1754022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1764022Sstever@eecs.umich.edu 1774022Sstever@eecs.umich.edu private: 1784022Sstever@eecs.umich.edu 1794022Sstever@eecs.umich.edu Command cmd; 1804022Sstever@eecs.umich.edu 1815735Snate@binkert.org bool 1825735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1835735Snate@binkert.org { 1844022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1854022Sstever@eecs.umich.edu } 1864022Sstever@eecs.umich.edu 1874022Sstever@eecs.umich.edu public: 1884022Sstever@eecs.umich.edu 18910583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 19010583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 19110583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19210583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 19310583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 19411284Sandreas.hansson@arm.com bool needsWritable() const { return testCmdAttrib(NeedsWritable); } 19510583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 19610583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 19711199Sandreas.hansson@arm.com bool isEviction() const { return testCmdAttrib(IsEviction); } 19811600Sandreas.hansson@arm.com bool fromCache() const { return testCmdAttrib(FromCache); } 19911199Sandreas.hansson@arm.com 20011199Sandreas.hansson@arm.com /** 20111199Sandreas.hansson@arm.com * A writeback is an eviction that carries data. 20211199Sandreas.hansson@arm.com */ 20311199Sandreas.hansson@arm.com bool isWriteback() const { return testCmdAttrib(IsEviction) && 20411199Sandreas.hansson@arm.com testCmdAttrib(HasData); } 20510570Sandreas.hansson@arm.com 20610570Sandreas.hansson@arm.com /** 20710570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 20810570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 20910570Sandreas.hansson@arm.com * valid or not. 21010570Sandreas.hansson@arm.com */ 2114022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2126102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 21310343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 21410343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 21510343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 21610343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2174870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2185314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2198184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2204022Sstever@eecs.umich.edu 22111294Sandreas.hansson@arm.com Command 2225735Snate@binkert.org responseCommand() const 2235735Snate@binkert.org { 2244022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2254022Sstever@eecs.umich.edu } 2264022Sstever@eecs.umich.edu 2275735Snate@binkert.org /// Return the string to a cmd given by idx. 2285735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2294022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2304022Sstever@eecs.umich.edu 2315735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2325735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2335735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2344022Sstever@eecs.umich.edu 2355735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2365735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2374022Sstever@eecs.umich.edu}; 2384022Sstever@eecs.umich.edu 2392381SN/A/** 2402662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2412662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2422662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2432662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2442662Sstever@eecs.umich.edu * different Packets along the way.) 2452381SN/A */ 2469044SAli.Saidi@ARM.comclass Packet : public Printable 2472381SN/A{ 2482813Srdreslin@umich.edu public: 2495735Snate@binkert.org typedef uint32_t FlagsType; 2505735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2514022Sstever@eecs.umich.edu 2525735Snate@binkert.org private: 2535735Snate@binkert.org 25410938Sandreas.hansson@arm.com enum : FlagsType { 25510938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 25612346Snikos.nikoleris@arm.com COPY_FLAGS = 0x0000001F, 25710938Sandreas.hansson@arm.com 25811284Sandreas.hansson@arm.com // Does this packet have sharers (which means it should not be 25911284Sandreas.hansson@arm.com // considered writable) or not. See setHasSharers below. 26011284Sandreas.hansson@arm.com HAS_SHARERS = 0x00000001, 26111284Sandreas.hansson@arm.com 26210938Sandreas.hansson@arm.com // Special control flags 26310938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 26410938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 26511284Sandreas.hansson@arm.com 26611284Sandreas.hansson@arm.com /// Allow a responding cache to inform the cache hierarchy 26711284Sandreas.hansson@arm.com /// that it had a writable copy before responding. See 26811284Sandreas.hansson@arm.com /// setResponderHadWritable below. 26911284Sandreas.hansson@arm.com RESPONDER_HAD_WRITABLE = 0x00000004, 27011284Sandreas.hansson@arm.com 27111284Sandreas.hansson@arm.com // Snoop co-ordination flag to indicate that a cache is 27211284Sandreas.hansson@arm.com // responding to a snoop. See setCacheResponding below. 27311284Sandreas.hansson@arm.com CACHE_RESPONDING = 0x00000008, 27410938Sandreas.hansson@arm.com 27512346Snikos.nikoleris@arm.com // The writeback/writeclean should be propagated further 27612346Snikos.nikoleris@arm.com // downstream by the receiver 27712346Snikos.nikoleris@arm.com WRITE_THROUGH = 0x00000010, 27812346Snikos.nikoleris@arm.com 27911057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 28011057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 28111057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 28211057Sandreas.hansson@arm.com 28310938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 28410938Sandreas.hansson@arm.com /// when the packet is destroyed? 28510938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 28610938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 28710938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 28810938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 28910938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 29010938Sandreas.hansson@arm.com 29110938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 29210938Sandreas.hansson@arm.com /// access failure. 29310938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 29410938Sandreas.hansson@arm.com 29510938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 29610938Sandreas.hansson@arm.com // through express snoop flag 29710938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 29810938Sandreas.hansson@arm.com }; 2995735Snate@binkert.org 3005735Snate@binkert.org Flags flags; 3015735Snate@binkert.org 3025735Snate@binkert.org public: 3034022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 3044022Sstever@eecs.umich.edu 3055735Snate@binkert.org /// The command field of the packet. 3064870Sstever@eecs.umich.edu MemCmd cmd; 3074870Sstever@eecs.umich.edu 3085735Snate@binkert.org /// A pointer to the original request. 30910569Sandreas.hansson@arm.com const RequestPtr req; 3104870Sstever@eecs.umich.edu 3112566SN/A private: 3125735Snate@binkert.org /** 3135735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 3145735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 3155735Snate@binkert.org * packet, not request. This may or may not be populated when a 3165735Snate@binkert.org * responder recieves the packet. If not populated it memory should 3175735Snate@binkert.org * be allocated. 3182566SN/A */ 3192566SN/A PacketDataPtr data; 3202566SN/A 3215735Snate@binkert.org /// The address of the request. This address could be virtual or 3225735Snate@binkert.org /// physical, depending on the system configuration. 3232381SN/A Addr addr; 3242381SN/A 32510028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 32610028SGiacomo.Gabrielli@arm.com bool _isSecure; 32710028SGiacomo.Gabrielli@arm.com 3285735Snate@binkert.org /// The size of the request or transfer. 3296227Snate@binkert.org unsigned size; 3302381SN/A 3315735Snate@binkert.org /** 33210723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3338668Sgeoffrey.blake@arm.com */ 33410723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3358668Sgeoffrey.blake@arm.com 3362641Sstever@eecs.umich.edu public: 3372811Srdreslin@umich.edu 3389547Sandreas.hansson@arm.com /** 33910694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 34010405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 34110405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 34210405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 34310405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3449547Sandreas.hansson@arm.com */ 34510694SMarco.Balboni@ARM.com uint32_t headerDelay; 3463218Sgblack@eecs.umich.edu 3479547Sandreas.hansson@arm.com /** 34811127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 34911127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 35011127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 35111127Sandreas.hansson@arm.com * delay. 35211127Sandreas.hansson@arm.com */ 35311127Sandreas.hansson@arm.com uint32_t snoopDelay; 35411127Sandreas.hansson@arm.com 35511127Sandreas.hansson@arm.com /** 35610694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 35710694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 35810694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 35910694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 36010405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 36110405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3629547Sandreas.hansson@arm.com */ 36310694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3643218Sgblack@eecs.umich.edu 3655735Snate@binkert.org /** 3665735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3679542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3689542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3699542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3709542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3719542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3729542Sandreas.hansson@arm.com * particular sending device. 3739542Sandreas.hansson@arm.com * 3749542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3759542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3769542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3779542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3789542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3799542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3809542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3815735Snate@binkert.org */ 3825735Snate@binkert.org struct SenderState 3835735Snate@binkert.org { 3849542Sandreas.hansson@arm.com SenderState* predecessor; 3859542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3862641Sstever@eecs.umich.edu virtual ~SenderState() {} 3872641Sstever@eecs.umich.edu }; 3882641Sstever@eecs.umich.edu 3895315Sstever@gmail.com /** 3905315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3915315Sstever@gmail.com * field of a PrintReq should always be of this type. 3925315Sstever@gmail.com */ 3939044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3945735Snate@binkert.org { 3955735Snate@binkert.org private: 3965735Snate@binkert.org /** 3975735Snate@binkert.org * An entry in the label stack. 3985735Snate@binkert.org */ 3995735Snate@binkert.org struct LabelStackEntry 4005735Snate@binkert.org { 4015314Sstever@gmail.com const std::string label; 4025314Sstever@gmail.com std::string *prefix; 4035314Sstever@gmail.com bool labelPrinted; 4045735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 4055314Sstever@gmail.com }; 4065314Sstever@gmail.com 4075314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 4085314Sstever@gmail.com LabelStack labelStack; 4095314Sstever@gmail.com 4105314Sstever@gmail.com std::string *curPrefixPtr; 4115314Sstever@gmail.com 4125314Sstever@gmail.com public: 4135314Sstever@gmail.com std::ostream &os; 4145314Sstever@gmail.com const int verbosity; 4155314Sstever@gmail.com 4165314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4175314Sstever@gmail.com ~PrintReqState(); 4185314Sstever@gmail.com 4195735Snate@binkert.org /** 4205735Snate@binkert.org * Returns the current line prefix. 4215735Snate@binkert.org */ 4225314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4235315Sstever@gmail.com 4245735Snate@binkert.org /** 4255735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4265315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4275735Snate@binkert.org * printed if an object within the label's scope is printed. 4285735Snate@binkert.org */ 4295314Sstever@gmail.com void pushLabel(const std::string &lbl, 4305314Sstever@gmail.com const std::string &prefix = " "); 4315735Snate@binkert.org 4325735Snate@binkert.org /** 4335735Snate@binkert.org * Pop a label off the label stack. 4345735Snate@binkert.org */ 4355314Sstever@gmail.com void popLabel(); 4365735Snate@binkert.org 4375735Snate@binkert.org /** 4385735Snate@binkert.org * Print all of the pending unprinted labels on the 4395315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4405735Snate@binkert.org * users unless bypassing printObj(). 4415735Snate@binkert.org */ 4425314Sstever@gmail.com void printLabels(); 4435735Snate@binkert.org 4445735Snate@binkert.org /** 4455735Snate@binkert.org * Print a Printable object to os, because it matched the 4465735Snate@binkert.org * address on a PrintReq. 4475735Snate@binkert.org */ 4485314Sstever@gmail.com void printObj(Printable *obj); 4495314Sstever@gmail.com }; 4505314Sstever@gmail.com 4515735Snate@binkert.org /** 4525735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4535735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4545735Snate@binkert.org * this variable is to allow a device to attach extra information 4559542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4565735Snate@binkert.org * that was attached to the original request (even if a new packet 4575735Snate@binkert.org * is created). 4585735Snate@binkert.org */ 4592662Sstever@eecs.umich.edu SenderState *senderState; 4602641Sstever@eecs.umich.edu 4619542Sandreas.hansson@arm.com /** 4629542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4639542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4649542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4659542Sandreas.hansson@arm.com * variable. 4669542Sandreas.hansson@arm.com * 4679542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4689542Sandreas.hansson@arm.com */ 4699542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4709542Sandreas.hansson@arm.com 4719542Sandreas.hansson@arm.com /** 4729542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4739542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4749542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4759542Sandreas.hansson@arm.com * variable. 4769542Sandreas.hansson@arm.com * 4779542Sandreas.hansson@arm.com * @return The current top of the stack 4789542Sandreas.hansson@arm.com */ 4799542Sandreas.hansson@arm.com SenderState *popSenderState(); 4809542Sandreas.hansson@arm.com 4819543Ssascha.bischoff@arm.com /** 4829543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4839543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4849543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4859543Ssascha.bischoff@arm.com * 4869543Ssascha.bischoff@arm.com * @return The topmost state of type T 4879543Ssascha.bischoff@arm.com */ 4889543Ssascha.bischoff@arm.com template <typename T> 4899543Ssascha.bischoff@arm.com T * findNextSenderState() const 4909543Ssascha.bischoff@arm.com { 4919543Ssascha.bischoff@arm.com T *t = NULL; 4929543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4939543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4949543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4959543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4969543Ssascha.bischoff@arm.com } 4979543Ssascha.bischoff@arm.com return t; 4989543Ssascha.bischoff@arm.com } 4999543Ssascha.bischoff@arm.com 5005735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 5015735Snate@binkert.org /// tracing). 5024022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 5032811Srdreslin@umich.edu 5045735Snate@binkert.org /// Return the index of this command. 5054022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 5062811Srdreslin@umich.edu 50710583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 50810583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 50910583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 51010583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 51110583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 51211287Sandreas.hansson@arm.com bool needsWritable() const 51311287Sandreas.hansson@arm.com { 51411287Sandreas.hansson@arm.com // we should never check if a response needsWritable, the 51511287Sandreas.hansson@arm.com // request has this flag, and for a response we should rather 51611287Sandreas.hansson@arm.com // look at the hasSharers flag (if not set, the response is to 51711287Sandreas.hansson@arm.com // be considered writable) 51811287Sandreas.hansson@arm.com assert(isRequest()); 51911287Sandreas.hansson@arm.com return cmd.needsWritable(); 52011287Sandreas.hansson@arm.com } 52110583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 52210583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 52311199Sandreas.hansson@arm.com bool isEviction() const { return cmd.isEviction(); } 52411600Sandreas.hansson@arm.com bool fromCache() const { return cmd.fromCache(); } 52511199Sandreas.hansson@arm.com bool isWriteback() const { return cmd.isWriteback(); } 52610583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 52711286Sandreas.hansson@arm.com bool hasRespData() const 52811286Sandreas.hansson@arm.com { 52911286Sandreas.hansson@arm.com MemCmd resp_cmd = cmd.responseCommand(); 53011286Sandreas.hansson@arm.com return resp_cmd.hasData(); 53111286Sandreas.hansson@arm.com } 53210583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 53310583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 53410583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 53510583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 5362812Srdreslin@umich.edu 53711284Sandreas.hansson@arm.com //@{ 53811284Sandreas.hansson@arm.com /// Snoop flags 53911284Sandreas.hansson@arm.com /** 54011284Sandreas.hansson@arm.com * Set the cacheResponding flag. This is used by the caches to 54111284Sandreas.hansson@arm.com * signal another cache that they are responding to a request. A 54211284Sandreas.hansson@arm.com * cache will only respond to snoops if it has the line in either 54311284Sandreas.hansson@arm.com * Modified or Owned state. Note that on snoop hits we always pass 54411284Sandreas.hansson@arm.com * the line as Modified and never Owned. In the case of an Owned 54511284Sandreas.hansson@arm.com * line we proceed to invalidate all other copies. 54611284Sandreas.hansson@arm.com * 54711284Sandreas.hansson@arm.com * On a cache fill (see Cache::handleFill), we check hasSharers 54811284Sandreas.hansson@arm.com * first, ignoring the cacheResponding flag if hasSharers is set. 54911284Sandreas.hansson@arm.com * A line is consequently allocated as: 55011284Sandreas.hansson@arm.com * 55111284Sandreas.hansson@arm.com * hasSharers cacheResponding state 55211284Sandreas.hansson@arm.com * true false Shared 55311284Sandreas.hansson@arm.com * true true Shared 55411284Sandreas.hansson@arm.com * false false Exclusive 55511284Sandreas.hansson@arm.com * false true Modified 55611284Sandreas.hansson@arm.com */ 55711284Sandreas.hansson@arm.com void setCacheResponding() 55810567Sandreas.hansson@arm.com { 55910567Sandreas.hansson@arm.com assert(isRequest()); 56011284Sandreas.hansson@arm.com assert(!flags.isSet(CACHE_RESPONDING)); 56111284Sandreas.hansson@arm.com flags.set(CACHE_RESPONDING); 56210567Sandreas.hansson@arm.com } 56311284Sandreas.hansson@arm.com bool cacheResponding() const { return flags.isSet(CACHE_RESPONDING); } 56411284Sandreas.hansson@arm.com /** 56511284Sandreas.hansson@arm.com * On fills, the hasSharers flag is used by the caches in 56611284Sandreas.hansson@arm.com * combination with the cacheResponding flag, as clarified 56711284Sandreas.hansson@arm.com * above. If the hasSharers flag is not set, the packet is passing 56811284Sandreas.hansson@arm.com * writable. Thus, a response from a memory passes the line as 56911284Sandreas.hansson@arm.com * writable by default. 57011284Sandreas.hansson@arm.com * 57111284Sandreas.hansson@arm.com * The hasSharers flag is also used by upstream caches to inform a 57211284Sandreas.hansson@arm.com * downstream cache that they have the block (by calling 57311284Sandreas.hansson@arm.com * setHasSharers on snoop request packets that hit in upstream 57411284Sandreas.hansson@arm.com * cachs tags or MSHRs). If the snoop packet has sharers, a 57511284Sandreas.hansson@arm.com * downstream cache is prevented from passing a dirty line upwards 57611284Sandreas.hansson@arm.com * if it was not explicitly asked for a writable copy. See 57711284Sandreas.hansson@arm.com * Cache::satisfyCpuSideRequest. 57811284Sandreas.hansson@arm.com * 57911284Sandreas.hansson@arm.com * The hasSharers flag is also used on writebacks, in 58011284Sandreas.hansson@arm.com * combination with the WritbackClean or WritebackDirty commands, 58111284Sandreas.hansson@arm.com * to allocate the block downstream either as: 58211284Sandreas.hansson@arm.com * 58311284Sandreas.hansson@arm.com * command hasSharers state 58411284Sandreas.hansson@arm.com * WritebackDirty false Modified 58511284Sandreas.hansson@arm.com * WritebackDirty true Owned 58611284Sandreas.hansson@arm.com * WritebackClean false Exclusive 58711284Sandreas.hansson@arm.com * WritebackClean true Shared 58811284Sandreas.hansson@arm.com */ 58911284Sandreas.hansson@arm.com void setHasSharers() { flags.set(HAS_SHARERS); } 59011284Sandreas.hansson@arm.com bool hasSharers() const { return flags.isSet(HAS_SHARERS); } 59111284Sandreas.hansson@arm.com //@} 5924870Sstever@eecs.umich.edu 59311284Sandreas.hansson@arm.com /** 59411284Sandreas.hansson@arm.com * The express snoop flag is used for two purposes. Firstly, it is 59511284Sandreas.hansson@arm.com * used to bypass flow control for normal (non-snoop) requests 59611284Sandreas.hansson@arm.com * going downstream in the memory system. In cases where a cache 59711284Sandreas.hansson@arm.com * is responding to a snoop from another cache (it had a dirty 59811284Sandreas.hansson@arm.com * line), but the line is not writable (and there are possibly 59911284Sandreas.hansson@arm.com * other copies), the express snoop flag is set by the downstream 60011284Sandreas.hansson@arm.com * cache to invalidate all other copies in zero time. Secondly, 60111284Sandreas.hansson@arm.com * the express snoop flag is also set to be able to distinguish 60211284Sandreas.hansson@arm.com * snoop packets that came from a downstream cache, rather than 60311284Sandreas.hansson@arm.com * snoop packets from neighbouring caches. 60411284Sandreas.hansson@arm.com */ 60511284Sandreas.hansson@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 60611284Sandreas.hansson@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 60711284Sandreas.hansson@arm.com 60811284Sandreas.hansson@arm.com /** 60911284Sandreas.hansson@arm.com * On responding to a snoop request (which only happens for 61011284Sandreas.hansson@arm.com * Modified or Owned lines), make sure that we can transform an 61111284Sandreas.hansson@arm.com * Owned response to a Modified one. If this flag is not set, the 61211284Sandreas.hansson@arm.com * responding cache had the line in the Owned state, and there are 61311284Sandreas.hansson@arm.com * possibly other Shared copies in the memory system. A downstream 61411284Sandreas.hansson@arm.com * cache helps in orchestrating the invalidation of these copies 61511284Sandreas.hansson@arm.com * by sending out the appropriate express snoops. 61611284Sandreas.hansson@arm.com */ 61711284Sandreas.hansson@arm.com void setResponderHadWritable() 61811284Sandreas.hansson@arm.com { 61911284Sandreas.hansson@arm.com assert(cacheResponding()); 62011746Snikos.nikoleris@arm.com assert(!responderHadWritable()); 62111284Sandreas.hansson@arm.com flags.set(RESPONDER_HAD_WRITABLE); 62211284Sandreas.hansson@arm.com } 62311284Sandreas.hansson@arm.com bool responderHadWritable() const 62411284Sandreas.hansson@arm.com { return flags.isSet(RESPONDER_HAD_WRITABLE); } 62511284Sandreas.hansson@arm.com 62612346Snikos.nikoleris@arm.com /** 62712346Snikos.nikoleris@arm.com * A writeback/writeclean cmd gets propagated further downstream 62812346Snikos.nikoleris@arm.com * by the receiver when the flag is set. 62912346Snikos.nikoleris@arm.com */ 63012346Snikos.nikoleris@arm.com void setWriteThrough() 63112346Snikos.nikoleris@arm.com { 63212346Snikos.nikoleris@arm.com assert(cmd.isWrite() && 63312346Snikos.nikoleris@arm.com (cmd.isEviction() || cmd == MemCmd::WriteClean)); 63412346Snikos.nikoleris@arm.com flags.set(WRITE_THROUGH); 63512346Snikos.nikoleris@arm.com } 63612346Snikos.nikoleris@arm.com void clearWriteThrough() { flags.clear(WRITE_THROUGH); } 63712346Snikos.nikoleris@arm.com bool writeThrough() const { return flags.isSet(WRITE_THROUGH); } 63812346Snikos.nikoleris@arm.com 6399951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 6409951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 64110763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 64210763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 64310883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 6444895Sstever@eecs.umich.edu 6454870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 6464870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 6474870Sstever@eecs.umich.edu // field, etc.) 6485735Snate@binkert.org void 6495735Snate@binkert.org setBadAddress() 6505735Snate@binkert.org { 6515735Snate@binkert.org assert(isResponse()); 6525735Snate@binkert.org cmd = MemCmd::BadAddressError; 6535735Snate@binkert.org } 6545735Snate@binkert.org 6554986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 6562814Srdreslin@umich.edu 65711057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 6589259SAli.Saidi@ARM.com /** 6599259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 6609259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 6619259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 6629259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 6639259SAli.Saidi@ARM.com * valid. 6649259SAli.Saidi@ARM.com */ 66511057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 6669259SAli.Saidi@ARM.com 66711057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 66810938Sandreas.hansson@arm.com 66910938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 67010938Sandreas.hansson@arm.com { 67110938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 67210938Sandreas.hansson@arm.com } 67310938Sandreas.hansson@arm.com 67410938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 67510938Sandreas.hansson@arm.com { 67610938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 67710938Sandreas.hansson@arm.com } 6782549SN/A 67911057Sandreas.hansson@arm.com bool isSecure() const 68011057Sandreas.hansson@arm.com { 68111057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 68211057Sandreas.hansson@arm.com return _isSecure; 68311057Sandreas.hansson@arm.com } 68410028SGiacomo.Gabrielli@arm.com 6855735Snate@binkert.org /** 68611306Santhony.gutierrez@amd.com * Accessor function to atomic op. 68711306Santhony.gutierrez@amd.com */ 68811306Santhony.gutierrez@amd.com AtomicOpFunctor *getAtomicOp() const { return req->getAtomicOpFunctor(); } 68911306Santhony.gutierrez@amd.com bool isAtomicOp() const { return req->isAtomic(); } 69011306Santhony.gutierrez@amd.com 69111306Santhony.gutierrez@amd.com /** 6927550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 69310938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 6947550SBrad.Beckmann@amd.com */ 6957550SBrad.Beckmann@amd.com void 6967550SBrad.Beckmann@amd.com convertScToWrite() 6977550SBrad.Beckmann@amd.com { 6987550SBrad.Beckmann@amd.com assert(isLLSC()); 6997550SBrad.Beckmann@amd.com assert(isWrite()); 7007550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 7017550SBrad.Beckmann@amd.com } 7027550SBrad.Beckmann@amd.com 7037550SBrad.Beckmann@amd.com /** 70410938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 70510938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 7067550SBrad.Beckmann@amd.com */ 7077550SBrad.Beckmann@amd.com void 7087550SBrad.Beckmann@amd.com convertLlToRead() 7097550SBrad.Beckmann@amd.com { 7107550SBrad.Beckmann@amd.com assert(isLLSC()); 7117550SBrad.Beckmann@amd.com assert(isRead()); 7127550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 7137550SBrad.Beckmann@amd.com } 7147550SBrad.Beckmann@amd.com 7157550SBrad.Beckmann@amd.com /** 71610938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 71711057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 71811057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 7195735Snate@binkert.org */ 72010569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 72111057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 72211127Sandreas.hansson@arm.com size(0), headerDelay(0), snoopDelay(0), payloadDelay(0), 72311057Sandreas.hansson@arm.com senderState(NULL) 72411057Sandreas.hansson@arm.com { 72511057Sandreas.hansson@arm.com if (req->hasPaddr()) { 72611057Sandreas.hansson@arm.com addr = req->getPaddr(); 72711057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 72811057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 72911057Sandreas.hansson@arm.com } 73011057Sandreas.hansson@arm.com if (req->hasSize()) { 73111057Sandreas.hansson@arm.com size = req->getSize(); 73211057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 73311057Sandreas.hansson@arm.com } 73411057Sandreas.hansson@arm.com } 73511057Sandreas.hansson@arm.com 73611057Sandreas.hansson@arm.com /** 73711057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 73811057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 73911057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 74011057Sandreas.hansson@arm.com */ 74111057Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 74211057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 74311127Sandreas.hansson@arm.com headerDelay(0), snoopDelay(0), payloadDelay(0), 7449546Sandreas.hansson@arm.com senderState(NULL) 74511057Sandreas.hansson@arm.com { 74611057Sandreas.hansson@arm.com if (req->hasPaddr()) { 74711057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 74811057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 74911057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 75011057Sandreas.hansson@arm.com } 75111057Sandreas.hansson@arm.com size = _blkSize; 75211057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 75311057Sandreas.hansson@arm.com } 7544626Sstever@eecs.umich.edu 7555735Snate@binkert.org /** 7565735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 7574887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 7584887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 7594887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 7605735Snate@binkert.org * packet should allocate its own data. 7615735Snate@binkert.org */ 76210896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 7635735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 76410571Sandreas.hansson@arm.com data(nullptr), 76510028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 76610723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 76710694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 76811127Sandreas.hansson@arm.com snoopDelay(0), 76910694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 7709546Sandreas.hansson@arm.com senderState(pkt->senderState) 7714626Sstever@eecs.umich.edu { 77210571Sandreas.hansson@arm.com if (!clear_flags) 7735735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 7745735Snate@binkert.org 77511057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 77611057Sandreas.hansson@arm.com 77710571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 77810571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 77910571Sandreas.hansson@arm.com // co-ordinate state changes 78010571Sandreas.hansson@arm.com if (alloc_data) { 78110571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 78210571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 78310571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 78410571Sandreas.hansson@arm.com // carry the pointer forward 78510571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 78610571Sandreas.hansson@arm.com data = pkt->data; 78710571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 78810571Sandreas.hansson@arm.com } else { 78910571Sandreas.hansson@arm.com allocate(); 79010571Sandreas.hansson@arm.com } 79110571Sandreas.hansson@arm.com } 79210342SCurtis.Dunham@arm.com } 7938668Sgeoffrey.blake@arm.com 79410342SCurtis.Dunham@arm.com /** 79510739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 79610342SCurtis.Dunham@arm.com */ 79710739Ssteve.reinhardt@amd.com static MemCmd 79810739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 79910342SCurtis.Dunham@arm.com { 80010739Ssteve.reinhardt@amd.com if (req->isLLSC()) 80110739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 80210739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 80310739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 80410739Ssteve.reinhardt@amd.com else 80510739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 80610739Ssteve.reinhardt@amd.com } 80710739Ssteve.reinhardt@amd.com 80810739Ssteve.reinhardt@amd.com /** 80910739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 81010739Ssteve.reinhardt@amd.com */ 81110739Ssteve.reinhardt@amd.com static MemCmd 81210739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 81310739Ssteve.reinhardt@amd.com { 81410739Ssteve.reinhardt@amd.com if (req->isLLSC()) 81510739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 81610739Ssteve.reinhardt@amd.com else if (req->isSwap()) 81710739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 81810739Ssteve.reinhardt@amd.com else 81910739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 82010342SCurtis.Dunham@arm.com } 82110342SCurtis.Dunham@arm.com 82210342SCurtis.Dunham@arm.com /** 82310342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 82410739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 82510342SCurtis.Dunham@arm.com */ 82610342SCurtis.Dunham@arm.com static PacketPtr 82710569Sandreas.hansson@arm.com createRead(const RequestPtr req) 82810342SCurtis.Dunham@arm.com { 82910739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 83010342SCurtis.Dunham@arm.com } 83110342SCurtis.Dunham@arm.com 83210342SCurtis.Dunham@arm.com static PacketPtr 83310569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 83410342SCurtis.Dunham@arm.com { 83510739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 8362641Sstever@eecs.umich.edu } 8372549SN/A 8385735Snate@binkert.org /** 8395735Snate@binkert.org * clean up packet variables 8405735Snate@binkert.org */ 8412566SN/A ~Packet() 8425387Sstever@gmail.com { 84310872Sali.jafri@arm.com // Delete the request object if this is a request packet which 84410872Sali.jafri@arm.com // does not need a response, because the requester will not get 84510872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 84610872Sali.jafri@arm.com // request will be deleted on receipt of the response 84710872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 84810872Sali.jafri@arm.com // express snoops, even for cases when responses are not 84910872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 85010872Sali.jafri@arm.com // re-uses the same request. 85110872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 85210872Sali.jafri@arm.com !isExpressSnoop()) { 8535387Sstever@gmail.com delete req; 85410872Sali.jafri@arm.com } 8555735Snate@binkert.org deleteData(); 8565387Sstever@gmail.com } 8572566SN/A 8585735Snate@binkert.org /** 8594626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 86010660Sandreas.hansson@arm.com * returning as a response to that request. 8614626Sstever@eecs.umich.edu */ 8625735Snate@binkert.org void 8635735Snate@binkert.org makeResponse() 8644626Sstever@eecs.umich.edu { 8652662Sstever@eecs.umich.edu assert(needsResponse()); 8662855Srdreslin@umich.edu assert(isRequest()); 8674022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 8685745Snate@binkert.org 8697464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 8707464Ssteve.reinhardt@amd.com // triggered them was 8717464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 8722641Sstever@eecs.umich.edu } 8732641Sstever@eecs.umich.edu 8745735Snate@binkert.org void 8755735Snate@binkert.org makeAtomicResponse() 8764870Sstever@eecs.umich.edu { 8774870Sstever@eecs.umich.edu makeResponse(); 8784870Sstever@eecs.umich.edu } 8794870Sstever@eecs.umich.edu 8805735Snate@binkert.org void 8815735Snate@binkert.org makeTimingResponse() 8823348Sbinkertn@umich.edu { 8834870Sstever@eecs.umich.edu makeResponse(); 8843135Srdreslin@umich.edu } 8853135Srdreslin@umich.edu 8868436SBrad.Beckmann@amd.com void 8878436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 8888436SBrad.Beckmann@amd.com { 8898436SBrad.Beckmann@amd.com if (!success) { 8908436SBrad.Beckmann@amd.com if (isWrite()) { 8918436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 8928436SBrad.Beckmann@amd.com } else { 8938436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 8948436SBrad.Beckmann@amd.com } 8958436SBrad.Beckmann@amd.com } 8968436SBrad.Beckmann@amd.com } 8978436SBrad.Beckmann@amd.com 89811057Sandreas.hansson@arm.com void 89911057Sandreas.hansson@arm.com setSize(unsigned size) 90011057Sandreas.hansson@arm.com { 90111057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 90211057Sandreas.hansson@arm.com 90311057Sandreas.hansson@arm.com this->size = size; 90411057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 90511057Sandreas.hansson@arm.com } 90611057Sandreas.hansson@arm.com 90711057Sandreas.hansson@arm.com 90811013Sandreas.sandberg@arm.com public: 90911013Sandreas.sandberg@arm.com /** 91011013Sandreas.sandberg@arm.com * @{ 91111013Sandreas.sandberg@arm.com * @name Data accessor mehtods 91211013Sandreas.sandberg@arm.com */ 91311013Sandreas.sandberg@arm.com 9143348Sbinkertn@umich.edu /** 9153348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 91610571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 91710571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 91810571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 91910571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 92010571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 92110571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 92210571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 92310571Sandreas.hansson@arm.com * to the source, no copies are necessary. 9242566SN/A */ 9252566SN/A template <typename T> 9263348Sbinkertn@umich.edu void 9273348Sbinkertn@umich.edu dataStatic(T *p) 9283348Sbinkertn@umich.edu { 92910566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9303348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9315735Snate@binkert.org flags.set(STATIC_DATA); 9323348Sbinkertn@umich.edu } 9332566SN/A 9343348Sbinkertn@umich.edu /** 93510564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 93610564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 93710564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 93810564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 93910564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 94010564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 94110564Sandreas.hansson@arm.com */ 94210564Sandreas.hansson@arm.com template <typename T> 94310564Sandreas.hansson@arm.com void 94410564Sandreas.hansson@arm.com dataStaticConst(const T *p) 94510564Sandreas.hansson@arm.com { 94610566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 94710564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 94810564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 94910564Sandreas.hansson@arm.com } 95010564Sandreas.hansson@arm.com 95110564Sandreas.hansson@arm.com /** 9523348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 95310571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 95410571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 95510571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 95610571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 95710571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 95810571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 95910571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 96010571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 96110571Sandreas.hansson@arm.com * before it is deallocated. 9623348Sbinkertn@umich.edu */ 9632566SN/A template <typename T> 9643348Sbinkertn@umich.edu void 9653348Sbinkertn@umich.edu dataDynamic(T *p) 9663348Sbinkertn@umich.edu { 96710566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9683348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9695735Snate@binkert.org flags.set(DYNAMIC_DATA); 9703348Sbinkertn@umich.edu } 9713348Sbinkertn@umich.edu 9725735Snate@binkert.org /** 9735735Snate@binkert.org * get a pointer to the data ptr. 9745735Snate@binkert.org */ 9753348Sbinkertn@umich.edu template <typename T> 9763348Sbinkertn@umich.edu T* 97710562Sandreas.hansson@arm.com getPtr() 9783348Sbinkertn@umich.edu { 97910562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 9803348Sbinkertn@umich.edu return (T*)data; 9813348Sbinkertn@umich.edu } 9822566SN/A 98310563Sandreas.hansson@arm.com template <typename T> 98410563Sandreas.hansson@arm.com const T* 98510563Sandreas.hansson@arm.com getConstPtr() const 98610563Sandreas.hansson@arm.com { 98710563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 98810563Sandreas.hansson@arm.com return (const T*)data; 98910563Sandreas.hansson@arm.com } 99010563Sandreas.hansson@arm.com 9915735Snate@binkert.org /** 99211013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 99311013Sandreas.sandberg@arm.com * host endian. 99411013Sandreas.sandberg@arm.com */ 99511013Sandreas.sandberg@arm.com template <typename T> 99611013Sandreas.sandberg@arm.com T getBE() const; 99711013Sandreas.sandberg@arm.com 99811013Sandreas.sandberg@arm.com /** 99911013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 100011013Sandreas.sandberg@arm.com * host endian. 100111013Sandreas.sandberg@arm.com */ 100211013Sandreas.sandberg@arm.com template <typename T> 100311013Sandreas.sandberg@arm.com T getLE() const; 100411013Sandreas.sandberg@arm.com 100511013Sandreas.sandberg@arm.com /** 100611013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 100711013Sandreas.sandberg@arm.com * endianness. 100811013Sandreas.sandberg@arm.com */ 100911013Sandreas.sandberg@arm.com template <typename T> 101011013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 101111013Sandreas.sandberg@arm.com 101211013Sandreas.sandberg@arm.com /** 101311013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 101411013Sandreas.sandberg@arm.com * endian. 10155735Snate@binkert.org */ 10162566SN/A template <typename T> 101710563Sandreas.hansson@arm.com T get() const; 10182566SN/A 101911013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 102011013Sandreas.sandberg@arm.com template <typename T> 102111013Sandreas.sandberg@arm.com void setBE(T v); 102211013Sandreas.sandberg@arm.com 102311013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 102411013Sandreas.sandberg@arm.com template <typename T> 102511013Sandreas.sandberg@arm.com void setLE(T v); 102611013Sandreas.sandberg@arm.com 10275735Snate@binkert.org /** 102811013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 102911013Sandreas.sandberg@arm.com * endianness. 10305735Snate@binkert.org */ 10312566SN/A template <typename T> 103211013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 103311013Sandreas.sandberg@arm.com 103411013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 103511013Sandreas.sandberg@arm.com template <typename T> 10362592SN/A void set(T v); 10372566SN/A 10383348Sbinkertn@umich.edu /** 10394626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 10404626Sstever@eecs.umich.edu */ 10415735Snate@binkert.org void 104210563Sandreas.hansson@arm.com setData(const uint8_t *p) 10434626Sstever@eecs.umich.edu { 104410571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 104510571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 104610571Sandreas.hansson@arm.com // same pointer from source to destination and back 104710571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 104810571Sandreas.hansson@arm.com 10497691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 105010571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 105110571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 10527691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 10534626Sstever@eecs.umich.edu } 10544626Sstever@eecs.umich.edu 10554626Sstever@eecs.umich.edu /** 10564626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 10574626Sstever@eecs.umich.edu * which is aligned to the given block size. 10584626Sstever@eecs.umich.edu */ 10595735Snate@binkert.org void 106010563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 10614626Sstever@eecs.umich.edu { 10624626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 10634626Sstever@eecs.umich.edu } 10644626Sstever@eecs.umich.edu 10654626Sstever@eecs.umich.edu /** 10664626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 10674626Sstever@eecs.umich.edu * is aligned to the given block size. 10684626Sstever@eecs.umich.edu */ 10695735Snate@binkert.org void 107010563Sandreas.hansson@arm.com writeData(uint8_t *p) const 10714626Sstever@eecs.umich.edu { 107210563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 10734626Sstever@eecs.umich.edu } 10744626Sstever@eecs.umich.edu 10754626Sstever@eecs.umich.edu /** 10764626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 10774626Sstever@eecs.umich.edu */ 10785735Snate@binkert.org void 107910563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 10804626Sstever@eecs.umich.edu { 10814626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 10824626Sstever@eecs.umich.edu } 10834626Sstever@eecs.umich.edu 10844626Sstever@eecs.umich.edu /** 10853348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 10863348Sbinkertn@umich.edu * matter how data was allocted. 10873348Sbinkertn@umich.edu */ 10885735Snate@binkert.org void 10895735Snate@binkert.org deleteData() 10905735Snate@binkert.org { 109110566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 10925735Snate@binkert.org delete [] data; 10935735Snate@binkert.org 109410566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 10955735Snate@binkert.org data = NULL; 10965735Snate@binkert.org } 10972566SN/A 109810565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 10995735Snate@binkert.org void 11005735Snate@binkert.org allocate() 11015735Snate@binkert.org { 110211286Sandreas.hansson@arm.com // if either this command or the response command has a data 110311286Sandreas.hansson@arm.com // payload, actually allocate space 110411286Sandreas.hansson@arm.com if (hasData() || hasRespData()) { 110511286Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 110611286Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 110711286Sandreas.hansson@arm.com data = new uint8_t[getSize()]; 110811286Sandreas.hansson@arm.com } 11095735Snate@binkert.org } 11105735Snate@binkert.org 111111013Sandreas.sandberg@arm.com /** @} */ 111211013Sandreas.sandberg@arm.com 111311013Sandreas.sandberg@arm.com private: // Private data accessor methods 111411013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 111511013Sandreas.sandberg@arm.com template <typename T> 111611013Sandreas.sandberg@arm.com T getRaw() const; 111711013Sandreas.sandberg@arm.com 111811013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 111911013Sandreas.sandberg@arm.com template <typename T> 112011013Sandreas.sandberg@arm.com void setRaw(T v); 112111013Sandreas.sandberg@arm.com 112211013Sandreas.sandberg@arm.com public: 11234626Sstever@eecs.umich.edu /** 112410570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 112510570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 112610570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 112710570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 112810570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 112910570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 113010570Sandreas.hansson@arm.com * accordingly. 113110570Sandreas.hansson@arm.com */ 113210570Sandreas.hansson@arm.com bool 113310570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 113410570Sandreas.hansson@arm.com { 113510570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 113610570Sandreas.hansson@arm.com // data pointer 113710570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 113810570Sandreas.hansson@arm.com other->getSize(), 113910570Sandreas.hansson@arm.com other->hasData() ? 114010570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 114110570Sandreas.hansson@arm.com } 114210570Sandreas.hansson@arm.com 114310570Sandreas.hansson@arm.com /** 114410883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 114510883Sali.jafri@arm.com * in the memory hierarchy above. 114610883Sali.jafri@arm.com **/ 114710883Sali.jafri@arm.com bool 114810883Sali.jafri@arm.com mustCheckAbove() const 114910883Sali.jafri@arm.com { 115011199Sandreas.hansson@arm.com return cmd == MemCmd::HardPFReq || isEviction(); 115111199Sandreas.hansson@arm.com } 115211199Sandreas.hansson@arm.com 115311199Sandreas.hansson@arm.com /** 115411199Sandreas.hansson@arm.com * Is this packet a clean eviction, including both actual clean 115511199Sandreas.hansson@arm.com * evict packets, but also clean writebacks. 115611199Sandreas.hansson@arm.com */ 115711199Sandreas.hansson@arm.com bool 115811199Sandreas.hansson@arm.com isCleanEviction() const 115911199Sandreas.hansson@arm.com { 116011199Sandreas.hansson@arm.com return cmd == MemCmd::CleanEvict || cmd == MemCmd::WritebackClean; 116110883Sali.jafri@arm.com } 116210883Sali.jafri@arm.com 116310883Sali.jafri@arm.com /** 11644626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 116510570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 116610570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 116710570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 11684626Sstever@eecs.umich.edu * memory value. 11694626Sstever@eecs.umich.edu */ 11705735Snate@binkert.org bool 117110570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 117210570Sandreas.hansson@arm.com uint8_t *_data); 11735314Sstever@gmail.com 11745315Sstever@gmail.com /** 11755315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 11765315Sstever@gmail.com */ 11775735Snate@binkert.org void 11785735Snate@binkert.org pushLabel(const std::string &lbl) 11795735Snate@binkert.org { 11805735Snate@binkert.org if (isPrint()) 11815735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 11825314Sstever@gmail.com } 11835314Sstever@gmail.com 11845315Sstever@gmail.com /** 11855315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 11865315Sstever@gmail.com */ 11875735Snate@binkert.org void 11885735Snate@binkert.org popLabel() 11895735Snate@binkert.org { 11905735Snate@binkert.org if (isPrint()) 11915735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 11925314Sstever@gmail.com } 11935314Sstever@gmail.com 11945314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 11955314Sstever@gmail.com const std::string &prefix = "") const; 11969663Suri.wiener@arm.com 11979663Suri.wiener@arm.com /** 11989663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 11999663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 12009663Suri.wiener@arm.com * avoiding string overheads in fast mode 12019663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 12029663Suri.wiener@arm.com */ 12039663Suri.wiener@arm.com std::string print() const; 12042381SN/A}; 12052381SN/A 12062381SN/A#endif //__MEM_PACKET_HH 1207