packet.hh revision 12334
12381SN/A/* 211600Sandreas.hansson@arm.com * Copyright (c) 2012-2016 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, 9110883Sali.jafri@arm.com CleanEvict, 924022Sstever@eecs.umich.edu SoftPFReq, 934022Sstever@eecs.umich.edu HardPFReq, 944022Sstever@eecs.umich.edu SoftPFResp, 954022Sstever@eecs.umich.edu HardPFResp, 9610886Sandreas.hansson@arm.com WriteLineReq, 974022Sstever@eecs.umich.edu UpgradeReq, 987465Ssteve.reinhardt@amd.com SCUpgradeReq, // Special "weak" upgrade for StoreCond 994628Sstever@eecs.umich.edu UpgradeResp, 1007465Ssteve.reinhardt@amd.com SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1017465Ssteve.reinhardt@amd.com UpgradeFailResp, // Valid for SCUpgradeReq only 1024022Sstever@eecs.umich.edu ReadExReq, 1034022Sstever@eecs.umich.edu ReadExResp, 10410885Sandreas.hansson@arm.com ReadCleanReq, 10510885Sandreas.hansson@arm.com ReadSharedReq, 1064626Sstever@eecs.umich.edu LoadLockedReq, 1074626Sstever@eecs.umich.edu StoreCondReq, 1087669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1094626Sstever@eecs.umich.edu StoreCondResp, 1104040Ssaidi@eecs.umich.edu SwapReq, 1114040Ssaidi@eecs.umich.edu SwapResp, 1125650Sgblack@eecs.umich.edu MessageReq, 1135650Sgblack@eecs.umich.edu MessageResp, 11411256Santhony.gutierrez@amd.com MemFenceReq, 11511256Santhony.gutierrez@amd.com MemFenceResp, 1164870Sstever@eecs.umich.edu // Error responses 1174870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1184870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1194870Sstever@eecs.umich.edu // compatibility 1204870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1214870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1228436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1238436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1245314Sstever@gmail.com // Fake simulator-only commands 1255314Sstever@gmail.com PrintReq, // Print state matching address 1268184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 12710886Sandreas.hansson@arm.com InvalidateReq, // request for address to be invalidated 12810886Sandreas.hansson@arm.com InvalidateResp, 1294022Sstever@eecs.umich.edu NUM_MEM_CMDS 1304022Sstever@eecs.umich.edu }; 1314022Sstever@eecs.umich.edu 1324022Sstever@eecs.umich.edu private: 1335735Snate@binkert.org /** 1345735Snate@binkert.org * List of command attributes. 1355735Snate@binkert.org */ 1364022Sstever@eecs.umich.edu enum Attribute 1374022Sstever@eecs.umich.edu { 1384626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1394626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1407465Ssteve.reinhardt@amd.com IsUpgrade, 1414022Sstever@eecs.umich.edu IsInvalidate, 14211284Sandreas.hansson@arm.com NeedsWritable, //!< Requires writable copy to complete in-cache 1434626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1444626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1454626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 14611199Sandreas.hansson@arm.com IsEviction, 1474022Sstever@eecs.umich.edu IsSWPrefetch, 1484022Sstever@eecs.umich.edu IsHWPrefetch, 1496076Sgblack@eecs.umich.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1504626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1514870Sstever@eecs.umich.edu IsError, //!< Error response 1525314Sstever@gmail.com IsPrint, //!< Print state matching address (for debugging) 1538184Ssomayeh@cs.wisc.edu IsFlush, //!< Flush the address from caches 15411600Sandreas.hansson@arm.com FromCache, //!< Request originated from a caching agent 1554022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1564022Sstever@eecs.umich.edu }; 1574022Sstever@eecs.umich.edu 1585735Snate@binkert.org /** 1595735Snate@binkert.org * Structure that defines attributes and other data associated 1605735Snate@binkert.org * with a Command. 1615735Snate@binkert.org */ 1625735Snate@binkert.org struct CommandInfo 1635735Snate@binkert.org { 1645735Snate@binkert.org /// Set of attribute flags. 1654022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1665735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1675735Snate@binkert.org /// response is applicable. 1684022Sstever@eecs.umich.edu const Command response; 1695735Snate@binkert.org /// String representation (for printing) 1704022Sstever@eecs.umich.edu const std::string str; 1714022Sstever@eecs.umich.edu }; 1724022Sstever@eecs.umich.edu 1735735Snate@binkert.org /// Array to map Command enum to associated info. 1744022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1754022Sstever@eecs.umich.edu 1764022Sstever@eecs.umich.edu private: 1774022Sstever@eecs.umich.edu 1784022Sstever@eecs.umich.edu Command cmd; 1794022Sstever@eecs.umich.edu 1805735Snate@binkert.org bool 1815735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1825735Snate@binkert.org { 1834022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1844022Sstever@eecs.umich.edu } 1854022Sstever@eecs.umich.edu 1864022Sstever@eecs.umich.edu public: 1874022Sstever@eecs.umich.edu 18810583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 18910583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 19010583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19110583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 19210583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 19311284Sandreas.hansson@arm.com bool needsWritable() const { return testCmdAttrib(NeedsWritable); } 19410583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 19510583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 19611199Sandreas.hansson@arm.com bool isEviction() const { return testCmdAttrib(IsEviction); } 19711600Sandreas.hansson@arm.com bool fromCache() const { return testCmdAttrib(FromCache); } 19811199Sandreas.hansson@arm.com 19911199Sandreas.hansson@arm.com /** 20011199Sandreas.hansson@arm.com * A writeback is an eviction that carries data. 20111199Sandreas.hansson@arm.com */ 20211199Sandreas.hansson@arm.com bool isWriteback() const { return testCmdAttrib(IsEviction) && 20311199Sandreas.hansson@arm.com testCmdAttrib(HasData); } 20410570Sandreas.hansson@arm.com 20510570Sandreas.hansson@arm.com /** 20610570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 20710570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 20810570Sandreas.hansson@arm.com * valid or not. 20910570Sandreas.hansson@arm.com */ 2104022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2116102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 21210343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 21310343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 21410343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 21510343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2164870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2175314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2188184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2194022Sstever@eecs.umich.edu 22011294Sandreas.hansson@arm.com Command 2215735Snate@binkert.org responseCommand() const 2225735Snate@binkert.org { 2234022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2244022Sstever@eecs.umich.edu } 2254022Sstever@eecs.umich.edu 2265735Snate@binkert.org /// Return the string to a cmd given by idx. 2275735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2284022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2294022Sstever@eecs.umich.edu 2305735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2315735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2325735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2334022Sstever@eecs.umich.edu 2345735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2355735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2364022Sstever@eecs.umich.edu}; 2374022Sstever@eecs.umich.edu 2382381SN/A/** 2392662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2402662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2412662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2422662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2432662Sstever@eecs.umich.edu * different Packets along the way.) 2442381SN/A */ 2459044SAli.Saidi@ARM.comclass Packet : public Printable 2462381SN/A{ 2472813Srdreslin@umich.edu public: 2485735Snate@binkert.org typedef uint32_t FlagsType; 2495735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2504022Sstever@eecs.umich.edu 2515735Snate@binkert.org private: 2525735Snate@binkert.org 25310938Sandreas.hansson@arm.com enum : FlagsType { 25410938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 25510938Sandreas.hansson@arm.com COPY_FLAGS = 0x0000000F, 25610938Sandreas.hansson@arm.com 25711284Sandreas.hansson@arm.com // Does this packet have sharers (which means it should not be 25811284Sandreas.hansson@arm.com // considered writable) or not. See setHasSharers below. 25911284Sandreas.hansson@arm.com HAS_SHARERS = 0x00000001, 26011284Sandreas.hansson@arm.com 26110938Sandreas.hansson@arm.com // Special control flags 26210938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 26310938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 26411284Sandreas.hansson@arm.com 26511284Sandreas.hansson@arm.com /// Allow a responding cache to inform the cache hierarchy 26611284Sandreas.hansson@arm.com /// that it had a writable copy before responding. See 26711284Sandreas.hansson@arm.com /// setResponderHadWritable below. 26811284Sandreas.hansson@arm.com RESPONDER_HAD_WRITABLE = 0x00000004, 26911284Sandreas.hansson@arm.com 27011284Sandreas.hansson@arm.com // Snoop co-ordination flag to indicate that a cache is 27111284Sandreas.hansson@arm.com // responding to a snoop. See setCacheResponding below. 27211284Sandreas.hansson@arm.com CACHE_RESPONDING = 0x00000008, 27310938Sandreas.hansson@arm.com 27411057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 27511057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 27611057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 27711057Sandreas.hansson@arm.com 27810938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 27910938Sandreas.hansson@arm.com /// when the packet is destroyed? 28010938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 28110938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 28210938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 28310938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 28410938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 28510938Sandreas.hansson@arm.com 28610938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 28710938Sandreas.hansson@arm.com /// access failure. 28810938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 28910938Sandreas.hansson@arm.com 29010938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 29110938Sandreas.hansson@arm.com // through express snoop flag 29210938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 29310938Sandreas.hansson@arm.com }; 2945735Snate@binkert.org 2955735Snate@binkert.org Flags flags; 2965735Snate@binkert.org 2975735Snate@binkert.org public: 2984022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2994022Sstever@eecs.umich.edu 3005735Snate@binkert.org /// The command field of the packet. 3014870Sstever@eecs.umich.edu MemCmd cmd; 3024870Sstever@eecs.umich.edu 3035735Snate@binkert.org /// A pointer to the original request. 30410569Sandreas.hansson@arm.com const RequestPtr req; 3054870Sstever@eecs.umich.edu 3062566SN/A private: 3075735Snate@binkert.org /** 3085735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 3095735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 3105735Snate@binkert.org * packet, not request. This may or may not be populated when a 3115735Snate@binkert.org * responder recieves the packet. If not populated it memory should 3125735Snate@binkert.org * be allocated. 3132566SN/A */ 3142566SN/A PacketDataPtr data; 3152566SN/A 3165735Snate@binkert.org /// The address of the request. This address could be virtual or 3175735Snate@binkert.org /// physical, depending on the system configuration. 3182381SN/A Addr addr; 3192381SN/A 32010028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 32110028SGiacomo.Gabrielli@arm.com bool _isSecure; 32210028SGiacomo.Gabrielli@arm.com 3235735Snate@binkert.org /// The size of the request or transfer. 3246227Snate@binkert.org unsigned size; 3252381SN/A 3265735Snate@binkert.org /** 32710723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3288668Sgeoffrey.blake@arm.com */ 32910723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3308668Sgeoffrey.blake@arm.com 3312641Sstever@eecs.umich.edu public: 3322811Srdreslin@umich.edu 3339547Sandreas.hansson@arm.com /** 33410694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 33510405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 33610405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 33710405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 33810405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3399547Sandreas.hansson@arm.com */ 34010694SMarco.Balboni@ARM.com uint32_t headerDelay; 3413218Sgblack@eecs.umich.edu 3429547Sandreas.hansson@arm.com /** 34311127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 34411127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 34511127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 34611127Sandreas.hansson@arm.com * delay. 34711127Sandreas.hansson@arm.com */ 34811127Sandreas.hansson@arm.com uint32_t snoopDelay; 34911127Sandreas.hansson@arm.com 35011127Sandreas.hansson@arm.com /** 35110694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 35210694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 35310694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 35410694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 35510405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 35610405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3579547Sandreas.hansson@arm.com */ 35810694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3593218Sgblack@eecs.umich.edu 3605735Snate@binkert.org /** 3615735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3629542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3639542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3649542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3659542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3669542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3679542Sandreas.hansson@arm.com * particular sending device. 3689542Sandreas.hansson@arm.com * 3699542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3709542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3719542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3729542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3739542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3749542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3759542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3765735Snate@binkert.org */ 3775735Snate@binkert.org struct SenderState 3785735Snate@binkert.org { 3799542Sandreas.hansson@arm.com SenderState* predecessor; 3809542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3812641Sstever@eecs.umich.edu virtual ~SenderState() {} 3822641Sstever@eecs.umich.edu }; 3832641Sstever@eecs.umich.edu 3845315Sstever@gmail.com /** 3855315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3865315Sstever@gmail.com * field of a PrintReq should always be of this type. 3875315Sstever@gmail.com */ 3889044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3895735Snate@binkert.org { 3905735Snate@binkert.org private: 3915735Snate@binkert.org /** 3925735Snate@binkert.org * An entry in the label stack. 3935735Snate@binkert.org */ 3945735Snate@binkert.org struct LabelStackEntry 3955735Snate@binkert.org { 3965314Sstever@gmail.com const std::string label; 3975314Sstever@gmail.com std::string *prefix; 3985314Sstever@gmail.com bool labelPrinted; 3995735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 4005314Sstever@gmail.com }; 4015314Sstever@gmail.com 4025314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 4035314Sstever@gmail.com LabelStack labelStack; 4045314Sstever@gmail.com 4055314Sstever@gmail.com std::string *curPrefixPtr; 4065314Sstever@gmail.com 4075314Sstever@gmail.com public: 4085314Sstever@gmail.com std::ostream &os; 4095314Sstever@gmail.com const int verbosity; 4105314Sstever@gmail.com 4115314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4125314Sstever@gmail.com ~PrintReqState(); 4135314Sstever@gmail.com 4145735Snate@binkert.org /** 4155735Snate@binkert.org * Returns the current line prefix. 4165735Snate@binkert.org */ 4175314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4185315Sstever@gmail.com 4195735Snate@binkert.org /** 4205735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4215315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4225735Snate@binkert.org * printed if an object within the label's scope is printed. 4235735Snate@binkert.org */ 4245314Sstever@gmail.com void pushLabel(const std::string &lbl, 4255314Sstever@gmail.com const std::string &prefix = " "); 4265735Snate@binkert.org 4275735Snate@binkert.org /** 4285735Snate@binkert.org * Pop a label off the label stack. 4295735Snate@binkert.org */ 4305314Sstever@gmail.com void popLabel(); 4315735Snate@binkert.org 4325735Snate@binkert.org /** 4335735Snate@binkert.org * Print all of the pending unprinted labels on the 4345315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4355735Snate@binkert.org * users unless bypassing printObj(). 4365735Snate@binkert.org */ 4375314Sstever@gmail.com void printLabels(); 4385735Snate@binkert.org 4395735Snate@binkert.org /** 4405735Snate@binkert.org * Print a Printable object to os, because it matched the 4415735Snate@binkert.org * address on a PrintReq. 4425735Snate@binkert.org */ 4435314Sstever@gmail.com void printObj(Printable *obj); 4445314Sstever@gmail.com }; 4455314Sstever@gmail.com 4465735Snate@binkert.org /** 4475735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4485735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4495735Snate@binkert.org * this variable is to allow a device to attach extra information 4509542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4515735Snate@binkert.org * that was attached to the original request (even if a new packet 4525735Snate@binkert.org * is created). 4535735Snate@binkert.org */ 4542662Sstever@eecs.umich.edu SenderState *senderState; 4552641Sstever@eecs.umich.edu 4569542Sandreas.hansson@arm.com /** 4579542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4589542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4599542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4609542Sandreas.hansson@arm.com * variable. 4619542Sandreas.hansson@arm.com * 4629542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4639542Sandreas.hansson@arm.com */ 4649542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4659542Sandreas.hansson@arm.com 4669542Sandreas.hansson@arm.com /** 4679542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4689542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4699542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4709542Sandreas.hansson@arm.com * variable. 4719542Sandreas.hansson@arm.com * 4729542Sandreas.hansson@arm.com * @return The current top of the stack 4739542Sandreas.hansson@arm.com */ 4749542Sandreas.hansson@arm.com SenderState *popSenderState(); 4759542Sandreas.hansson@arm.com 4769543Ssascha.bischoff@arm.com /** 4779543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4789543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4799543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4809543Ssascha.bischoff@arm.com * 4819543Ssascha.bischoff@arm.com * @return The topmost state of type T 4829543Ssascha.bischoff@arm.com */ 4839543Ssascha.bischoff@arm.com template <typename T> 4849543Ssascha.bischoff@arm.com T * findNextSenderState() const 4859543Ssascha.bischoff@arm.com { 4869543Ssascha.bischoff@arm.com T *t = NULL; 4879543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4889543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4899543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4909543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4919543Ssascha.bischoff@arm.com } 4929543Ssascha.bischoff@arm.com return t; 4939543Ssascha.bischoff@arm.com } 4949543Ssascha.bischoff@arm.com 4955735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4965735Snate@binkert.org /// tracing). 4974022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4982811Srdreslin@umich.edu 4995735Snate@binkert.org /// Return the index of this command. 5004022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 5012811Srdreslin@umich.edu 50210583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 50310583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 50410583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 50510583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 50610583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 50711287Sandreas.hansson@arm.com bool needsWritable() const 50811287Sandreas.hansson@arm.com { 50911287Sandreas.hansson@arm.com // we should never check if a response needsWritable, the 51011287Sandreas.hansson@arm.com // request has this flag, and for a response we should rather 51111287Sandreas.hansson@arm.com // look at the hasSharers flag (if not set, the response is to 51211287Sandreas.hansson@arm.com // be considered writable) 51311287Sandreas.hansson@arm.com assert(isRequest()); 51411287Sandreas.hansson@arm.com return cmd.needsWritable(); 51511287Sandreas.hansson@arm.com } 51610583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 51710583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 51811199Sandreas.hansson@arm.com bool isEviction() const { return cmd.isEviction(); } 51911600Sandreas.hansson@arm.com bool fromCache() const { return cmd.fromCache(); } 52011199Sandreas.hansson@arm.com bool isWriteback() const { return cmd.isWriteback(); } 52110583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 52211286Sandreas.hansson@arm.com bool hasRespData() const 52311286Sandreas.hansson@arm.com { 52411286Sandreas.hansson@arm.com MemCmd resp_cmd = cmd.responseCommand(); 52511286Sandreas.hansson@arm.com return resp_cmd.hasData(); 52611286Sandreas.hansson@arm.com } 52710583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 52810583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 52910583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 53010583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 5312812Srdreslin@umich.edu 53211284Sandreas.hansson@arm.com //@{ 53311284Sandreas.hansson@arm.com /// Snoop flags 53411284Sandreas.hansson@arm.com /** 53511284Sandreas.hansson@arm.com * Set the cacheResponding flag. This is used by the caches to 53611284Sandreas.hansson@arm.com * signal another cache that they are responding to a request. A 53711284Sandreas.hansson@arm.com * cache will only respond to snoops if it has the line in either 53811284Sandreas.hansson@arm.com * Modified or Owned state. Note that on snoop hits we always pass 53911284Sandreas.hansson@arm.com * the line as Modified and never Owned. In the case of an Owned 54011284Sandreas.hansson@arm.com * line we proceed to invalidate all other copies. 54111284Sandreas.hansson@arm.com * 54211284Sandreas.hansson@arm.com * On a cache fill (see Cache::handleFill), we check hasSharers 54311284Sandreas.hansson@arm.com * first, ignoring the cacheResponding flag if hasSharers is set. 54411284Sandreas.hansson@arm.com * A line is consequently allocated as: 54511284Sandreas.hansson@arm.com * 54611284Sandreas.hansson@arm.com * hasSharers cacheResponding state 54711284Sandreas.hansson@arm.com * true false Shared 54811284Sandreas.hansson@arm.com * true true Shared 54911284Sandreas.hansson@arm.com * false false Exclusive 55011284Sandreas.hansson@arm.com * false true Modified 55111284Sandreas.hansson@arm.com */ 55211284Sandreas.hansson@arm.com void setCacheResponding() 55310567Sandreas.hansson@arm.com { 55410567Sandreas.hansson@arm.com assert(isRequest()); 55511284Sandreas.hansson@arm.com assert(!flags.isSet(CACHE_RESPONDING)); 55611284Sandreas.hansson@arm.com flags.set(CACHE_RESPONDING); 55710567Sandreas.hansson@arm.com } 55811284Sandreas.hansson@arm.com bool cacheResponding() const { return flags.isSet(CACHE_RESPONDING); } 55911284Sandreas.hansson@arm.com /** 56011284Sandreas.hansson@arm.com * On fills, the hasSharers flag is used by the caches in 56111284Sandreas.hansson@arm.com * combination with the cacheResponding flag, as clarified 56211284Sandreas.hansson@arm.com * above. If the hasSharers flag is not set, the packet is passing 56311284Sandreas.hansson@arm.com * writable. Thus, a response from a memory passes the line as 56411284Sandreas.hansson@arm.com * writable by default. 56511284Sandreas.hansson@arm.com * 56611284Sandreas.hansson@arm.com * The hasSharers flag is also used by upstream caches to inform a 56711284Sandreas.hansson@arm.com * downstream cache that they have the block (by calling 56811284Sandreas.hansson@arm.com * setHasSharers on snoop request packets that hit in upstream 56911284Sandreas.hansson@arm.com * cachs tags or MSHRs). If the snoop packet has sharers, a 57011284Sandreas.hansson@arm.com * downstream cache is prevented from passing a dirty line upwards 57111284Sandreas.hansson@arm.com * if it was not explicitly asked for a writable copy. See 57211284Sandreas.hansson@arm.com * Cache::satisfyCpuSideRequest. 57311284Sandreas.hansson@arm.com * 57411284Sandreas.hansson@arm.com * The hasSharers flag is also used on writebacks, in 57511284Sandreas.hansson@arm.com * combination with the WritbackClean or WritebackDirty commands, 57611284Sandreas.hansson@arm.com * to allocate the block downstream either as: 57711284Sandreas.hansson@arm.com * 57811284Sandreas.hansson@arm.com * command hasSharers state 57911284Sandreas.hansson@arm.com * WritebackDirty false Modified 58011284Sandreas.hansson@arm.com * WritebackDirty true Owned 58111284Sandreas.hansson@arm.com * WritebackClean false Exclusive 58211284Sandreas.hansson@arm.com * WritebackClean true Shared 58311284Sandreas.hansson@arm.com */ 58411284Sandreas.hansson@arm.com void setHasSharers() { flags.set(HAS_SHARERS); } 58511284Sandreas.hansson@arm.com bool hasSharers() const { return flags.isSet(HAS_SHARERS); } 58611284Sandreas.hansson@arm.com //@} 5874870Sstever@eecs.umich.edu 58811284Sandreas.hansson@arm.com /** 58911284Sandreas.hansson@arm.com * The express snoop flag is used for two purposes. Firstly, it is 59011284Sandreas.hansson@arm.com * used to bypass flow control for normal (non-snoop) requests 59111284Sandreas.hansson@arm.com * going downstream in the memory system. In cases where a cache 59211284Sandreas.hansson@arm.com * is responding to a snoop from another cache (it had a dirty 59311284Sandreas.hansson@arm.com * line), but the line is not writable (and there are possibly 59411284Sandreas.hansson@arm.com * other copies), the express snoop flag is set by the downstream 59511284Sandreas.hansson@arm.com * cache to invalidate all other copies in zero time. Secondly, 59611284Sandreas.hansson@arm.com * the express snoop flag is also set to be able to distinguish 59711284Sandreas.hansson@arm.com * snoop packets that came from a downstream cache, rather than 59811284Sandreas.hansson@arm.com * snoop packets from neighbouring caches. 59911284Sandreas.hansson@arm.com */ 60011284Sandreas.hansson@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 60111284Sandreas.hansson@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 60211284Sandreas.hansson@arm.com 60311284Sandreas.hansson@arm.com /** 60411284Sandreas.hansson@arm.com * On responding to a snoop request (which only happens for 60511284Sandreas.hansson@arm.com * Modified or Owned lines), make sure that we can transform an 60611284Sandreas.hansson@arm.com * Owned response to a Modified one. If this flag is not set, the 60711284Sandreas.hansson@arm.com * responding cache had the line in the Owned state, and there are 60811284Sandreas.hansson@arm.com * possibly other Shared copies in the memory system. A downstream 60911284Sandreas.hansson@arm.com * cache helps in orchestrating the invalidation of these copies 61011284Sandreas.hansson@arm.com * by sending out the appropriate express snoops. 61111284Sandreas.hansson@arm.com */ 61211284Sandreas.hansson@arm.com void setResponderHadWritable() 61311284Sandreas.hansson@arm.com { 61411284Sandreas.hansson@arm.com assert(cacheResponding()); 61511746Snikos.nikoleris@arm.com assert(!responderHadWritable()); 61611284Sandreas.hansson@arm.com flags.set(RESPONDER_HAD_WRITABLE); 61711284Sandreas.hansson@arm.com } 61811284Sandreas.hansson@arm.com bool responderHadWritable() const 61911284Sandreas.hansson@arm.com { return flags.isSet(RESPONDER_HAD_WRITABLE); } 62011284Sandreas.hansson@arm.com 6219951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 6229951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 62310763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 62410763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 62510883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 6264895Sstever@eecs.umich.edu 6274870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 6284870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 6294870Sstever@eecs.umich.edu // field, etc.) 6305735Snate@binkert.org void 6315735Snate@binkert.org setBadAddress() 6325735Snate@binkert.org { 6335735Snate@binkert.org assert(isResponse()); 6345735Snate@binkert.org cmd = MemCmd::BadAddressError; 6355735Snate@binkert.org } 6365735Snate@binkert.org 6374986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 6382814Srdreslin@umich.edu 63911057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 6409259SAli.Saidi@ARM.com /** 6419259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 6429259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 6439259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 6449259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 6459259SAli.Saidi@ARM.com * valid. 6469259SAli.Saidi@ARM.com */ 64711057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 6489259SAli.Saidi@ARM.com 64911057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 65010938Sandreas.hansson@arm.com 65110938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 65210938Sandreas.hansson@arm.com { 65310938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 65410938Sandreas.hansson@arm.com } 65510938Sandreas.hansson@arm.com 65610938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 65710938Sandreas.hansson@arm.com { 65810938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 65910938Sandreas.hansson@arm.com } 6602549SN/A 66111057Sandreas.hansson@arm.com bool isSecure() const 66211057Sandreas.hansson@arm.com { 66311057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 66411057Sandreas.hansson@arm.com return _isSecure; 66511057Sandreas.hansson@arm.com } 66610028SGiacomo.Gabrielli@arm.com 6675735Snate@binkert.org /** 66811306Santhony.gutierrez@amd.com * Accessor function to atomic op. 66911306Santhony.gutierrez@amd.com */ 67011306Santhony.gutierrez@amd.com AtomicOpFunctor *getAtomicOp() const { return req->getAtomicOpFunctor(); } 67111306Santhony.gutierrez@amd.com bool isAtomicOp() const { return req->isAtomic(); } 67211306Santhony.gutierrez@amd.com 67311306Santhony.gutierrez@amd.com /** 6747550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 67510938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 6767550SBrad.Beckmann@amd.com */ 6777550SBrad.Beckmann@amd.com void 6787550SBrad.Beckmann@amd.com convertScToWrite() 6797550SBrad.Beckmann@amd.com { 6807550SBrad.Beckmann@amd.com assert(isLLSC()); 6817550SBrad.Beckmann@amd.com assert(isWrite()); 6827550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 6837550SBrad.Beckmann@amd.com } 6847550SBrad.Beckmann@amd.com 6857550SBrad.Beckmann@amd.com /** 68610938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 68710938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 6887550SBrad.Beckmann@amd.com */ 6897550SBrad.Beckmann@amd.com void 6907550SBrad.Beckmann@amd.com convertLlToRead() 6917550SBrad.Beckmann@amd.com { 6927550SBrad.Beckmann@amd.com assert(isLLSC()); 6937550SBrad.Beckmann@amd.com assert(isRead()); 6947550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 6957550SBrad.Beckmann@amd.com } 6967550SBrad.Beckmann@amd.com 6977550SBrad.Beckmann@amd.com /** 69810938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 69911057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 70011057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 7015735Snate@binkert.org */ 70210569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 70311057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 70411127Sandreas.hansson@arm.com size(0), headerDelay(0), snoopDelay(0), payloadDelay(0), 70511057Sandreas.hansson@arm.com senderState(NULL) 70611057Sandreas.hansson@arm.com { 70711057Sandreas.hansson@arm.com if (req->hasPaddr()) { 70811057Sandreas.hansson@arm.com addr = req->getPaddr(); 70911057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 71011057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 71111057Sandreas.hansson@arm.com } 71211057Sandreas.hansson@arm.com if (req->hasSize()) { 71311057Sandreas.hansson@arm.com size = req->getSize(); 71411057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 71511057Sandreas.hansson@arm.com } 71611057Sandreas.hansson@arm.com } 71711057Sandreas.hansson@arm.com 71811057Sandreas.hansson@arm.com /** 71911057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 72011057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 72111057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 72211057Sandreas.hansson@arm.com */ 72311057Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 72411057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 72511127Sandreas.hansson@arm.com headerDelay(0), snoopDelay(0), payloadDelay(0), 7269546Sandreas.hansson@arm.com senderState(NULL) 72711057Sandreas.hansson@arm.com { 72811057Sandreas.hansson@arm.com if (req->hasPaddr()) { 72911057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 73011057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 73111057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 73211057Sandreas.hansson@arm.com } 73311057Sandreas.hansson@arm.com size = _blkSize; 73411057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 73511057Sandreas.hansson@arm.com } 7364626Sstever@eecs.umich.edu 7375735Snate@binkert.org /** 7385735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 7394887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 7404887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 7414887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 7425735Snate@binkert.org * packet should allocate its own data. 7435735Snate@binkert.org */ 74410896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 7455735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 74610571Sandreas.hansson@arm.com data(nullptr), 74710028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 74810723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 74910694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 75011127Sandreas.hansson@arm.com snoopDelay(0), 75110694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 7529546Sandreas.hansson@arm.com senderState(pkt->senderState) 7534626Sstever@eecs.umich.edu { 75410571Sandreas.hansson@arm.com if (!clear_flags) 7555735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 7565735Snate@binkert.org 75711057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 75811057Sandreas.hansson@arm.com 75910571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 76010571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 76110571Sandreas.hansson@arm.com // co-ordinate state changes 76210571Sandreas.hansson@arm.com if (alloc_data) { 76310571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 76410571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 76510571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 76610571Sandreas.hansson@arm.com // carry the pointer forward 76710571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 76810571Sandreas.hansson@arm.com data = pkt->data; 76910571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 77010571Sandreas.hansson@arm.com } else { 77110571Sandreas.hansson@arm.com allocate(); 77210571Sandreas.hansson@arm.com } 77310571Sandreas.hansson@arm.com } 77410342SCurtis.Dunham@arm.com } 7758668Sgeoffrey.blake@arm.com 77610342SCurtis.Dunham@arm.com /** 77710739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 77810342SCurtis.Dunham@arm.com */ 77910739Ssteve.reinhardt@amd.com static MemCmd 78010739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 78110342SCurtis.Dunham@arm.com { 78210739Ssteve.reinhardt@amd.com if (req->isLLSC()) 78310739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 78410739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 78510739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 78610739Ssteve.reinhardt@amd.com else 78710739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 78810739Ssteve.reinhardt@amd.com } 78910739Ssteve.reinhardt@amd.com 79010739Ssteve.reinhardt@amd.com /** 79110739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 79210739Ssteve.reinhardt@amd.com */ 79310739Ssteve.reinhardt@amd.com static MemCmd 79410739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 79510739Ssteve.reinhardt@amd.com { 79610739Ssteve.reinhardt@amd.com if (req->isLLSC()) 79710739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 79810739Ssteve.reinhardt@amd.com else if (req->isSwap()) 79910739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 80010739Ssteve.reinhardt@amd.com else 80110739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 80210342SCurtis.Dunham@arm.com } 80310342SCurtis.Dunham@arm.com 80410342SCurtis.Dunham@arm.com /** 80510342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 80610739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 80710342SCurtis.Dunham@arm.com */ 80810342SCurtis.Dunham@arm.com static PacketPtr 80910569Sandreas.hansson@arm.com createRead(const RequestPtr req) 81010342SCurtis.Dunham@arm.com { 81110739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 81210342SCurtis.Dunham@arm.com } 81310342SCurtis.Dunham@arm.com 81410342SCurtis.Dunham@arm.com static PacketPtr 81510569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 81610342SCurtis.Dunham@arm.com { 81710739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 8182641Sstever@eecs.umich.edu } 8192549SN/A 8205735Snate@binkert.org /** 8215735Snate@binkert.org * clean up packet variables 8225735Snate@binkert.org */ 8232566SN/A ~Packet() 8245387Sstever@gmail.com { 82510872Sali.jafri@arm.com // Delete the request object if this is a request packet which 82610872Sali.jafri@arm.com // does not need a response, because the requester will not get 82710872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 82810872Sali.jafri@arm.com // request will be deleted on receipt of the response 82910872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 83010872Sali.jafri@arm.com // express snoops, even for cases when responses are not 83110872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 83210872Sali.jafri@arm.com // re-uses the same request. 83310872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 83410872Sali.jafri@arm.com !isExpressSnoop()) { 8355387Sstever@gmail.com delete req; 83610872Sali.jafri@arm.com } 8375735Snate@binkert.org deleteData(); 8385387Sstever@gmail.com } 8392566SN/A 8405735Snate@binkert.org /** 8414626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 84210660Sandreas.hansson@arm.com * returning as a response to that request. 8434626Sstever@eecs.umich.edu */ 8445735Snate@binkert.org void 8455735Snate@binkert.org makeResponse() 8464626Sstever@eecs.umich.edu { 8472662Sstever@eecs.umich.edu assert(needsResponse()); 8482855Srdreslin@umich.edu assert(isRequest()); 8494022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 8505745Snate@binkert.org 8517464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 8527464Ssteve.reinhardt@amd.com // triggered them was 8537464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 8542641Sstever@eecs.umich.edu } 8552641Sstever@eecs.umich.edu 8565735Snate@binkert.org void 8575735Snate@binkert.org makeAtomicResponse() 8584870Sstever@eecs.umich.edu { 8594870Sstever@eecs.umich.edu makeResponse(); 8604870Sstever@eecs.umich.edu } 8614870Sstever@eecs.umich.edu 8625735Snate@binkert.org void 8635735Snate@binkert.org makeTimingResponse() 8643348Sbinkertn@umich.edu { 8654870Sstever@eecs.umich.edu makeResponse(); 8663135Srdreslin@umich.edu } 8673135Srdreslin@umich.edu 8688436SBrad.Beckmann@amd.com void 8698436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 8708436SBrad.Beckmann@amd.com { 8718436SBrad.Beckmann@amd.com if (!success) { 8728436SBrad.Beckmann@amd.com if (isWrite()) { 8738436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 8748436SBrad.Beckmann@amd.com } else { 8758436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 8768436SBrad.Beckmann@amd.com } 8778436SBrad.Beckmann@amd.com } 8788436SBrad.Beckmann@amd.com } 8798436SBrad.Beckmann@amd.com 88011057Sandreas.hansson@arm.com void 88111057Sandreas.hansson@arm.com setSize(unsigned size) 88211057Sandreas.hansson@arm.com { 88311057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 88411057Sandreas.hansson@arm.com 88511057Sandreas.hansson@arm.com this->size = size; 88611057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 88711057Sandreas.hansson@arm.com } 88811057Sandreas.hansson@arm.com 88911057Sandreas.hansson@arm.com 89011013Sandreas.sandberg@arm.com public: 89111013Sandreas.sandberg@arm.com /** 89211013Sandreas.sandberg@arm.com * @{ 89311013Sandreas.sandberg@arm.com * @name Data accessor mehtods 89411013Sandreas.sandberg@arm.com */ 89511013Sandreas.sandberg@arm.com 8963348Sbinkertn@umich.edu /** 8973348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 89810571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 89910571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 90010571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 90110571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 90210571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 90310571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 90410571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 90510571Sandreas.hansson@arm.com * to the source, no copies are necessary. 9062566SN/A */ 9072566SN/A template <typename T> 9083348Sbinkertn@umich.edu void 9093348Sbinkertn@umich.edu dataStatic(T *p) 9103348Sbinkertn@umich.edu { 91110566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9123348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9135735Snate@binkert.org flags.set(STATIC_DATA); 9143348Sbinkertn@umich.edu } 9152566SN/A 9163348Sbinkertn@umich.edu /** 91710564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 91810564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 91910564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 92010564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 92110564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 92210564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 92310564Sandreas.hansson@arm.com */ 92410564Sandreas.hansson@arm.com template <typename T> 92510564Sandreas.hansson@arm.com void 92610564Sandreas.hansson@arm.com dataStaticConst(const T *p) 92710564Sandreas.hansson@arm.com { 92810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 92910564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 93010564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 93110564Sandreas.hansson@arm.com } 93210564Sandreas.hansson@arm.com 93310564Sandreas.hansson@arm.com /** 9343348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 93510571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 93610571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 93710571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 93810571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 93910571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 94010571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 94110571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 94210571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 94310571Sandreas.hansson@arm.com * before it is deallocated. 9443348Sbinkertn@umich.edu */ 9452566SN/A template <typename T> 9463348Sbinkertn@umich.edu void 9473348Sbinkertn@umich.edu dataDynamic(T *p) 9483348Sbinkertn@umich.edu { 94910566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9503348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9515735Snate@binkert.org flags.set(DYNAMIC_DATA); 9523348Sbinkertn@umich.edu } 9533348Sbinkertn@umich.edu 9545735Snate@binkert.org /** 9555735Snate@binkert.org * get a pointer to the data ptr. 9565735Snate@binkert.org */ 9573348Sbinkertn@umich.edu template <typename T> 9583348Sbinkertn@umich.edu T* 95910562Sandreas.hansson@arm.com getPtr() 9603348Sbinkertn@umich.edu { 96110562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 9623348Sbinkertn@umich.edu return (T*)data; 9633348Sbinkertn@umich.edu } 9642566SN/A 96510563Sandreas.hansson@arm.com template <typename T> 96610563Sandreas.hansson@arm.com const T* 96710563Sandreas.hansson@arm.com getConstPtr() const 96810563Sandreas.hansson@arm.com { 96910563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 97010563Sandreas.hansson@arm.com return (const T*)data; 97110563Sandreas.hansson@arm.com } 97210563Sandreas.hansson@arm.com 9735735Snate@binkert.org /** 97411013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 97511013Sandreas.sandberg@arm.com * host endian. 97611013Sandreas.sandberg@arm.com */ 97711013Sandreas.sandberg@arm.com template <typename T> 97811013Sandreas.sandberg@arm.com T getBE() const; 97911013Sandreas.sandberg@arm.com 98011013Sandreas.sandberg@arm.com /** 98111013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 98211013Sandreas.sandberg@arm.com * host endian. 98311013Sandreas.sandberg@arm.com */ 98411013Sandreas.sandberg@arm.com template <typename T> 98511013Sandreas.sandberg@arm.com T getLE() const; 98611013Sandreas.sandberg@arm.com 98711013Sandreas.sandberg@arm.com /** 98811013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 98911013Sandreas.sandberg@arm.com * endianness. 99011013Sandreas.sandberg@arm.com */ 99111013Sandreas.sandberg@arm.com template <typename T> 99211013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 99311013Sandreas.sandberg@arm.com 99411013Sandreas.sandberg@arm.com /** 99511013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 99611013Sandreas.sandberg@arm.com * endian. 9975735Snate@binkert.org */ 9982566SN/A template <typename T> 99910563Sandreas.hansson@arm.com T get() const; 10002566SN/A 100111013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 100211013Sandreas.sandberg@arm.com template <typename T> 100311013Sandreas.sandberg@arm.com void setBE(T v); 100411013Sandreas.sandberg@arm.com 100511013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 100611013Sandreas.sandberg@arm.com template <typename T> 100711013Sandreas.sandberg@arm.com void setLE(T v); 100811013Sandreas.sandberg@arm.com 10095735Snate@binkert.org /** 101011013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 101111013Sandreas.sandberg@arm.com * endianness. 10125735Snate@binkert.org */ 10132566SN/A template <typename T> 101411013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 101511013Sandreas.sandberg@arm.com 101611013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 101711013Sandreas.sandberg@arm.com template <typename T> 10182592SN/A void set(T v); 10192566SN/A 10203348Sbinkertn@umich.edu /** 10214626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 10224626Sstever@eecs.umich.edu */ 10235735Snate@binkert.org void 102410563Sandreas.hansson@arm.com setData(const uint8_t *p) 10254626Sstever@eecs.umich.edu { 102610571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 102710571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 102810571Sandreas.hansson@arm.com // same pointer from source to destination and back 102910571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 103010571Sandreas.hansson@arm.com 10317691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 103210571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 103310571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 10347691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 10354626Sstever@eecs.umich.edu } 10364626Sstever@eecs.umich.edu 10374626Sstever@eecs.umich.edu /** 10384626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 10394626Sstever@eecs.umich.edu * which is aligned to the given block size. 10404626Sstever@eecs.umich.edu */ 10415735Snate@binkert.org void 104210563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 10434626Sstever@eecs.umich.edu { 10444626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 10454626Sstever@eecs.umich.edu } 10464626Sstever@eecs.umich.edu 10474626Sstever@eecs.umich.edu /** 10484626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 10494626Sstever@eecs.umich.edu * is aligned to the given block size. 10504626Sstever@eecs.umich.edu */ 10515735Snate@binkert.org void 105210563Sandreas.hansson@arm.com writeData(uint8_t *p) const 10534626Sstever@eecs.umich.edu { 105410563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 10554626Sstever@eecs.umich.edu } 10564626Sstever@eecs.umich.edu 10574626Sstever@eecs.umich.edu /** 10584626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 10594626Sstever@eecs.umich.edu */ 10605735Snate@binkert.org void 106110563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 10624626Sstever@eecs.umich.edu { 10634626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 10644626Sstever@eecs.umich.edu } 10654626Sstever@eecs.umich.edu 10664626Sstever@eecs.umich.edu /** 10673348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 10683348Sbinkertn@umich.edu * matter how data was allocted. 10693348Sbinkertn@umich.edu */ 10705735Snate@binkert.org void 10715735Snate@binkert.org deleteData() 10725735Snate@binkert.org { 107310566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 10745735Snate@binkert.org delete [] data; 10755735Snate@binkert.org 107610566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 10775735Snate@binkert.org data = NULL; 10785735Snate@binkert.org } 10792566SN/A 108010565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 10815735Snate@binkert.org void 10825735Snate@binkert.org allocate() 10835735Snate@binkert.org { 108411286Sandreas.hansson@arm.com // if either this command or the response command has a data 108511286Sandreas.hansson@arm.com // payload, actually allocate space 108611286Sandreas.hansson@arm.com if (hasData() || hasRespData()) { 108711286Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 108811286Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 108911286Sandreas.hansson@arm.com data = new uint8_t[getSize()]; 109011286Sandreas.hansson@arm.com } 10915735Snate@binkert.org } 10925735Snate@binkert.org 109311013Sandreas.sandberg@arm.com /** @} */ 109411013Sandreas.sandberg@arm.com 109511013Sandreas.sandberg@arm.com private: // Private data accessor methods 109611013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 109711013Sandreas.sandberg@arm.com template <typename T> 109811013Sandreas.sandberg@arm.com T getRaw() const; 109911013Sandreas.sandberg@arm.com 110011013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 110111013Sandreas.sandberg@arm.com template <typename T> 110211013Sandreas.sandberg@arm.com void setRaw(T v); 110311013Sandreas.sandberg@arm.com 110411013Sandreas.sandberg@arm.com public: 11054626Sstever@eecs.umich.edu /** 110610570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 110710570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 110810570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 110910570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 111010570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 111110570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 111210570Sandreas.hansson@arm.com * accordingly. 111310570Sandreas.hansson@arm.com */ 111410570Sandreas.hansson@arm.com bool 111510570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 111610570Sandreas.hansson@arm.com { 111710570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 111810570Sandreas.hansson@arm.com // data pointer 111910570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 112010570Sandreas.hansson@arm.com other->getSize(), 112110570Sandreas.hansson@arm.com other->hasData() ? 112210570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 112310570Sandreas.hansson@arm.com } 112410570Sandreas.hansson@arm.com 112510570Sandreas.hansson@arm.com /** 112610883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 112710883Sali.jafri@arm.com * in the memory hierarchy above. 112810883Sali.jafri@arm.com **/ 112910883Sali.jafri@arm.com bool 113010883Sali.jafri@arm.com mustCheckAbove() const 113110883Sali.jafri@arm.com { 113211199Sandreas.hansson@arm.com return cmd == MemCmd::HardPFReq || isEviction(); 113311199Sandreas.hansson@arm.com } 113411199Sandreas.hansson@arm.com 113511199Sandreas.hansson@arm.com /** 113611199Sandreas.hansson@arm.com * Is this packet a clean eviction, including both actual clean 113711199Sandreas.hansson@arm.com * evict packets, but also clean writebacks. 113811199Sandreas.hansson@arm.com */ 113911199Sandreas.hansson@arm.com bool 114011199Sandreas.hansson@arm.com isCleanEviction() const 114111199Sandreas.hansson@arm.com { 114211199Sandreas.hansson@arm.com return cmd == MemCmd::CleanEvict || cmd == MemCmd::WritebackClean; 114310883Sali.jafri@arm.com } 114410883Sali.jafri@arm.com 114510883Sali.jafri@arm.com /** 11464626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 114710570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 114810570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 114910570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 11504626Sstever@eecs.umich.edu * memory value. 11514626Sstever@eecs.umich.edu */ 11525735Snate@binkert.org bool 115310570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 115410570Sandreas.hansson@arm.com uint8_t *_data); 11555314Sstever@gmail.com 11565315Sstever@gmail.com /** 11575315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 11585315Sstever@gmail.com */ 11595735Snate@binkert.org void 11605735Snate@binkert.org pushLabel(const std::string &lbl) 11615735Snate@binkert.org { 11625735Snate@binkert.org if (isPrint()) 11635735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 11645314Sstever@gmail.com } 11655314Sstever@gmail.com 11665315Sstever@gmail.com /** 11675315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 11685315Sstever@gmail.com */ 11695735Snate@binkert.org void 11705735Snate@binkert.org popLabel() 11715735Snate@binkert.org { 11725735Snate@binkert.org if (isPrint()) 11735735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 11745314Sstever@gmail.com } 11755314Sstever@gmail.com 11765314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 11775314Sstever@gmail.com const std::string &prefix = "") const; 11789663Suri.wiener@arm.com 11799663Suri.wiener@arm.com /** 11809663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 11819663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 11829663Suri.wiener@arm.com * avoiding string overheads in fast mode 11839663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 11849663Suri.wiener@arm.com */ 11859663Suri.wiener@arm.com std::string print() const; 11862381SN/A}; 11872381SN/A 11882381SN/A#endif //__MEM_PACKET_HH 1189