packet.hh revision 12344
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 25610938Sandreas.hansson@arm.com COPY_FLAGS = 0x0000000F, 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 27511057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 27611057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 27711057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 27811057Sandreas.hansson@arm.com 27910938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 28010938Sandreas.hansson@arm.com /// when the packet is destroyed? 28110938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 28210938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 28310938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 28410938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 28510938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 28610938Sandreas.hansson@arm.com 28710938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 28810938Sandreas.hansson@arm.com /// access failure. 28910938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 29010938Sandreas.hansson@arm.com 29110938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 29210938Sandreas.hansson@arm.com // through express snoop flag 29310938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 29410938Sandreas.hansson@arm.com }; 2955735Snate@binkert.org 2965735Snate@binkert.org Flags flags; 2975735Snate@binkert.org 2985735Snate@binkert.org public: 2994022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 3004022Sstever@eecs.umich.edu 3015735Snate@binkert.org /// The command field of the packet. 3024870Sstever@eecs.umich.edu MemCmd cmd; 3034870Sstever@eecs.umich.edu 3045735Snate@binkert.org /// A pointer to the original request. 30510569Sandreas.hansson@arm.com const RequestPtr req; 3064870Sstever@eecs.umich.edu 3072566SN/A private: 3085735Snate@binkert.org /** 3095735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 3105735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 3115735Snate@binkert.org * packet, not request. This may or may not be populated when a 3125735Snate@binkert.org * responder recieves the packet. If not populated it memory should 3135735Snate@binkert.org * be allocated. 3142566SN/A */ 3152566SN/A PacketDataPtr data; 3162566SN/A 3175735Snate@binkert.org /// The address of the request. This address could be virtual or 3185735Snate@binkert.org /// physical, depending on the system configuration. 3192381SN/A Addr addr; 3202381SN/A 32110028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 32210028SGiacomo.Gabrielli@arm.com bool _isSecure; 32310028SGiacomo.Gabrielli@arm.com 3245735Snate@binkert.org /// The size of the request or transfer. 3256227Snate@binkert.org unsigned size; 3262381SN/A 3275735Snate@binkert.org /** 32810723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3298668Sgeoffrey.blake@arm.com */ 33010723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3318668Sgeoffrey.blake@arm.com 3322641Sstever@eecs.umich.edu public: 3332811Srdreslin@umich.edu 3349547Sandreas.hansson@arm.com /** 33510694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 33610405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 33710405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 33810405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 33910405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3409547Sandreas.hansson@arm.com */ 34110694SMarco.Balboni@ARM.com uint32_t headerDelay; 3423218Sgblack@eecs.umich.edu 3439547Sandreas.hansson@arm.com /** 34411127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 34511127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 34611127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 34711127Sandreas.hansson@arm.com * delay. 34811127Sandreas.hansson@arm.com */ 34911127Sandreas.hansson@arm.com uint32_t snoopDelay; 35011127Sandreas.hansson@arm.com 35111127Sandreas.hansson@arm.com /** 35210694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 35310694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 35410694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 35510694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 35610405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 35710405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3589547Sandreas.hansson@arm.com */ 35910694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3603218Sgblack@eecs.umich.edu 3615735Snate@binkert.org /** 3625735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3639542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3649542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3659542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3669542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3679542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3689542Sandreas.hansson@arm.com * particular sending device. 3699542Sandreas.hansson@arm.com * 3709542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3719542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3729542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3739542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3749542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3759542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3769542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3775735Snate@binkert.org */ 3785735Snate@binkert.org struct SenderState 3795735Snate@binkert.org { 3809542Sandreas.hansson@arm.com SenderState* predecessor; 3819542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3822641Sstever@eecs.umich.edu virtual ~SenderState() {} 3832641Sstever@eecs.umich.edu }; 3842641Sstever@eecs.umich.edu 3855315Sstever@gmail.com /** 3865315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3875315Sstever@gmail.com * field of a PrintReq should always be of this type. 3885315Sstever@gmail.com */ 3899044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3905735Snate@binkert.org { 3915735Snate@binkert.org private: 3925735Snate@binkert.org /** 3935735Snate@binkert.org * An entry in the label stack. 3945735Snate@binkert.org */ 3955735Snate@binkert.org struct LabelStackEntry 3965735Snate@binkert.org { 3975314Sstever@gmail.com const std::string label; 3985314Sstever@gmail.com std::string *prefix; 3995314Sstever@gmail.com bool labelPrinted; 4005735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 4015314Sstever@gmail.com }; 4025314Sstever@gmail.com 4035314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 4045314Sstever@gmail.com LabelStack labelStack; 4055314Sstever@gmail.com 4065314Sstever@gmail.com std::string *curPrefixPtr; 4075314Sstever@gmail.com 4085314Sstever@gmail.com public: 4095314Sstever@gmail.com std::ostream &os; 4105314Sstever@gmail.com const int verbosity; 4115314Sstever@gmail.com 4125314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4135314Sstever@gmail.com ~PrintReqState(); 4145314Sstever@gmail.com 4155735Snate@binkert.org /** 4165735Snate@binkert.org * Returns the current line prefix. 4175735Snate@binkert.org */ 4185314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4195315Sstever@gmail.com 4205735Snate@binkert.org /** 4215735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4225315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4235735Snate@binkert.org * printed if an object within the label's scope is printed. 4245735Snate@binkert.org */ 4255314Sstever@gmail.com void pushLabel(const std::string &lbl, 4265314Sstever@gmail.com const std::string &prefix = " "); 4275735Snate@binkert.org 4285735Snate@binkert.org /** 4295735Snate@binkert.org * Pop a label off the label stack. 4305735Snate@binkert.org */ 4315314Sstever@gmail.com void popLabel(); 4325735Snate@binkert.org 4335735Snate@binkert.org /** 4345735Snate@binkert.org * Print all of the pending unprinted labels on the 4355315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4365735Snate@binkert.org * users unless bypassing printObj(). 4375735Snate@binkert.org */ 4385314Sstever@gmail.com void printLabels(); 4395735Snate@binkert.org 4405735Snate@binkert.org /** 4415735Snate@binkert.org * Print a Printable object to os, because it matched the 4425735Snate@binkert.org * address on a PrintReq. 4435735Snate@binkert.org */ 4445314Sstever@gmail.com void printObj(Printable *obj); 4455314Sstever@gmail.com }; 4465314Sstever@gmail.com 4475735Snate@binkert.org /** 4485735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4495735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4505735Snate@binkert.org * this variable is to allow a device to attach extra information 4519542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4525735Snate@binkert.org * that was attached to the original request (even if a new packet 4535735Snate@binkert.org * is created). 4545735Snate@binkert.org */ 4552662Sstever@eecs.umich.edu SenderState *senderState; 4562641Sstever@eecs.umich.edu 4579542Sandreas.hansson@arm.com /** 4589542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4599542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4609542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4619542Sandreas.hansson@arm.com * variable. 4629542Sandreas.hansson@arm.com * 4639542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4649542Sandreas.hansson@arm.com */ 4659542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4669542Sandreas.hansson@arm.com 4679542Sandreas.hansson@arm.com /** 4689542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4699542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4709542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4719542Sandreas.hansson@arm.com * variable. 4729542Sandreas.hansson@arm.com * 4739542Sandreas.hansson@arm.com * @return The current top of the stack 4749542Sandreas.hansson@arm.com */ 4759542Sandreas.hansson@arm.com SenderState *popSenderState(); 4769542Sandreas.hansson@arm.com 4779543Ssascha.bischoff@arm.com /** 4789543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4799543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4809543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4819543Ssascha.bischoff@arm.com * 4829543Ssascha.bischoff@arm.com * @return The topmost state of type T 4839543Ssascha.bischoff@arm.com */ 4849543Ssascha.bischoff@arm.com template <typename T> 4859543Ssascha.bischoff@arm.com T * findNextSenderState() const 4869543Ssascha.bischoff@arm.com { 4879543Ssascha.bischoff@arm.com T *t = NULL; 4889543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4899543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4909543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4919543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4929543Ssascha.bischoff@arm.com } 4939543Ssascha.bischoff@arm.com return t; 4949543Ssascha.bischoff@arm.com } 4959543Ssascha.bischoff@arm.com 4965735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4975735Snate@binkert.org /// tracing). 4984022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4992811Srdreslin@umich.edu 5005735Snate@binkert.org /// Return the index of this command. 5014022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 5022811Srdreslin@umich.edu 50310583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 50410583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 50510583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 50610583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 50710583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 50811287Sandreas.hansson@arm.com bool needsWritable() const 50911287Sandreas.hansson@arm.com { 51011287Sandreas.hansson@arm.com // we should never check if a response needsWritable, the 51111287Sandreas.hansson@arm.com // request has this flag, and for a response we should rather 51211287Sandreas.hansson@arm.com // look at the hasSharers flag (if not set, the response is to 51311287Sandreas.hansson@arm.com // be considered writable) 51411287Sandreas.hansson@arm.com assert(isRequest()); 51511287Sandreas.hansson@arm.com return cmd.needsWritable(); 51611287Sandreas.hansson@arm.com } 51710583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 51810583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 51911199Sandreas.hansson@arm.com bool isEviction() const { return cmd.isEviction(); } 52011600Sandreas.hansson@arm.com bool fromCache() const { return cmd.fromCache(); } 52111199Sandreas.hansson@arm.com bool isWriteback() const { return cmd.isWriteback(); } 52210583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 52311286Sandreas.hansson@arm.com bool hasRespData() const 52411286Sandreas.hansson@arm.com { 52511286Sandreas.hansson@arm.com MemCmd resp_cmd = cmd.responseCommand(); 52611286Sandreas.hansson@arm.com return resp_cmd.hasData(); 52711286Sandreas.hansson@arm.com } 52810583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 52910583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 53010583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 53110583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 5322812Srdreslin@umich.edu 53311284Sandreas.hansson@arm.com //@{ 53411284Sandreas.hansson@arm.com /// Snoop flags 53511284Sandreas.hansson@arm.com /** 53611284Sandreas.hansson@arm.com * Set the cacheResponding flag. This is used by the caches to 53711284Sandreas.hansson@arm.com * signal another cache that they are responding to a request. A 53811284Sandreas.hansson@arm.com * cache will only respond to snoops if it has the line in either 53911284Sandreas.hansson@arm.com * Modified or Owned state. Note that on snoop hits we always pass 54011284Sandreas.hansson@arm.com * the line as Modified and never Owned. In the case of an Owned 54111284Sandreas.hansson@arm.com * line we proceed to invalidate all other copies. 54211284Sandreas.hansson@arm.com * 54311284Sandreas.hansson@arm.com * On a cache fill (see Cache::handleFill), we check hasSharers 54411284Sandreas.hansson@arm.com * first, ignoring the cacheResponding flag if hasSharers is set. 54511284Sandreas.hansson@arm.com * A line is consequently allocated as: 54611284Sandreas.hansson@arm.com * 54711284Sandreas.hansson@arm.com * hasSharers cacheResponding state 54811284Sandreas.hansson@arm.com * true false Shared 54911284Sandreas.hansson@arm.com * true true Shared 55011284Sandreas.hansson@arm.com * false false Exclusive 55111284Sandreas.hansson@arm.com * false true Modified 55211284Sandreas.hansson@arm.com */ 55311284Sandreas.hansson@arm.com void setCacheResponding() 55410567Sandreas.hansson@arm.com { 55510567Sandreas.hansson@arm.com assert(isRequest()); 55611284Sandreas.hansson@arm.com assert(!flags.isSet(CACHE_RESPONDING)); 55711284Sandreas.hansson@arm.com flags.set(CACHE_RESPONDING); 55810567Sandreas.hansson@arm.com } 55911284Sandreas.hansson@arm.com bool cacheResponding() const { return flags.isSet(CACHE_RESPONDING); } 56011284Sandreas.hansson@arm.com /** 56111284Sandreas.hansson@arm.com * On fills, the hasSharers flag is used by the caches in 56211284Sandreas.hansson@arm.com * combination with the cacheResponding flag, as clarified 56311284Sandreas.hansson@arm.com * above. If the hasSharers flag is not set, the packet is passing 56411284Sandreas.hansson@arm.com * writable. Thus, a response from a memory passes the line as 56511284Sandreas.hansson@arm.com * writable by default. 56611284Sandreas.hansson@arm.com * 56711284Sandreas.hansson@arm.com * The hasSharers flag is also used by upstream caches to inform a 56811284Sandreas.hansson@arm.com * downstream cache that they have the block (by calling 56911284Sandreas.hansson@arm.com * setHasSharers on snoop request packets that hit in upstream 57011284Sandreas.hansson@arm.com * cachs tags or MSHRs). If the snoop packet has sharers, a 57111284Sandreas.hansson@arm.com * downstream cache is prevented from passing a dirty line upwards 57211284Sandreas.hansson@arm.com * if it was not explicitly asked for a writable copy. See 57311284Sandreas.hansson@arm.com * Cache::satisfyCpuSideRequest. 57411284Sandreas.hansson@arm.com * 57511284Sandreas.hansson@arm.com * The hasSharers flag is also used on writebacks, in 57611284Sandreas.hansson@arm.com * combination with the WritbackClean or WritebackDirty commands, 57711284Sandreas.hansson@arm.com * to allocate the block downstream either as: 57811284Sandreas.hansson@arm.com * 57911284Sandreas.hansson@arm.com * command hasSharers state 58011284Sandreas.hansson@arm.com * WritebackDirty false Modified 58111284Sandreas.hansson@arm.com * WritebackDirty true Owned 58211284Sandreas.hansson@arm.com * WritebackClean false Exclusive 58311284Sandreas.hansson@arm.com * WritebackClean true Shared 58411284Sandreas.hansson@arm.com */ 58511284Sandreas.hansson@arm.com void setHasSharers() { flags.set(HAS_SHARERS); } 58611284Sandreas.hansson@arm.com bool hasSharers() const { return flags.isSet(HAS_SHARERS); } 58711284Sandreas.hansson@arm.com //@} 5884870Sstever@eecs.umich.edu 58911284Sandreas.hansson@arm.com /** 59011284Sandreas.hansson@arm.com * The express snoop flag is used for two purposes. Firstly, it is 59111284Sandreas.hansson@arm.com * used to bypass flow control for normal (non-snoop) requests 59211284Sandreas.hansson@arm.com * going downstream in the memory system. In cases where a cache 59311284Sandreas.hansson@arm.com * is responding to a snoop from another cache (it had a dirty 59411284Sandreas.hansson@arm.com * line), but the line is not writable (and there are possibly 59511284Sandreas.hansson@arm.com * other copies), the express snoop flag is set by the downstream 59611284Sandreas.hansson@arm.com * cache to invalidate all other copies in zero time. Secondly, 59711284Sandreas.hansson@arm.com * the express snoop flag is also set to be able to distinguish 59811284Sandreas.hansson@arm.com * snoop packets that came from a downstream cache, rather than 59911284Sandreas.hansson@arm.com * snoop packets from neighbouring caches. 60011284Sandreas.hansson@arm.com */ 60111284Sandreas.hansson@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 60211284Sandreas.hansson@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 60311284Sandreas.hansson@arm.com 60411284Sandreas.hansson@arm.com /** 60511284Sandreas.hansson@arm.com * On responding to a snoop request (which only happens for 60611284Sandreas.hansson@arm.com * Modified or Owned lines), make sure that we can transform an 60711284Sandreas.hansson@arm.com * Owned response to a Modified one. If this flag is not set, the 60811284Sandreas.hansson@arm.com * responding cache had the line in the Owned state, and there are 60911284Sandreas.hansson@arm.com * possibly other Shared copies in the memory system. A downstream 61011284Sandreas.hansson@arm.com * cache helps in orchestrating the invalidation of these copies 61111284Sandreas.hansson@arm.com * by sending out the appropriate express snoops. 61211284Sandreas.hansson@arm.com */ 61311284Sandreas.hansson@arm.com void setResponderHadWritable() 61411284Sandreas.hansson@arm.com { 61511284Sandreas.hansson@arm.com assert(cacheResponding()); 61611746Snikos.nikoleris@arm.com assert(!responderHadWritable()); 61711284Sandreas.hansson@arm.com flags.set(RESPONDER_HAD_WRITABLE); 61811284Sandreas.hansson@arm.com } 61911284Sandreas.hansson@arm.com bool responderHadWritable() const 62011284Sandreas.hansson@arm.com { return flags.isSet(RESPONDER_HAD_WRITABLE); } 62111284Sandreas.hansson@arm.com 6229951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 6239951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 62410763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 62510763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 62610883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 6274895Sstever@eecs.umich.edu 6284870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 6294870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 6304870Sstever@eecs.umich.edu // field, etc.) 6315735Snate@binkert.org void 6325735Snate@binkert.org setBadAddress() 6335735Snate@binkert.org { 6345735Snate@binkert.org assert(isResponse()); 6355735Snate@binkert.org cmd = MemCmd::BadAddressError; 6365735Snate@binkert.org } 6375735Snate@binkert.org 6384986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 6392814Srdreslin@umich.edu 64011057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 6419259SAli.Saidi@ARM.com /** 6429259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 6439259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 6449259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 6459259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 6469259SAli.Saidi@ARM.com * valid. 6479259SAli.Saidi@ARM.com */ 64811057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 6499259SAli.Saidi@ARM.com 65011057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 65110938Sandreas.hansson@arm.com 65210938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 65310938Sandreas.hansson@arm.com { 65410938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 65510938Sandreas.hansson@arm.com } 65610938Sandreas.hansson@arm.com 65710938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 65810938Sandreas.hansson@arm.com { 65910938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 66010938Sandreas.hansson@arm.com } 6612549SN/A 66211057Sandreas.hansson@arm.com bool isSecure() const 66311057Sandreas.hansson@arm.com { 66411057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 66511057Sandreas.hansson@arm.com return _isSecure; 66611057Sandreas.hansson@arm.com } 66710028SGiacomo.Gabrielli@arm.com 6685735Snate@binkert.org /** 66911306Santhony.gutierrez@amd.com * Accessor function to atomic op. 67011306Santhony.gutierrez@amd.com */ 67111306Santhony.gutierrez@amd.com AtomicOpFunctor *getAtomicOp() const { return req->getAtomicOpFunctor(); } 67211306Santhony.gutierrez@amd.com bool isAtomicOp() const { return req->isAtomic(); } 67311306Santhony.gutierrez@amd.com 67411306Santhony.gutierrez@amd.com /** 6757550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 67610938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 6777550SBrad.Beckmann@amd.com */ 6787550SBrad.Beckmann@amd.com void 6797550SBrad.Beckmann@amd.com convertScToWrite() 6807550SBrad.Beckmann@amd.com { 6817550SBrad.Beckmann@amd.com assert(isLLSC()); 6827550SBrad.Beckmann@amd.com assert(isWrite()); 6837550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 6847550SBrad.Beckmann@amd.com } 6857550SBrad.Beckmann@amd.com 6867550SBrad.Beckmann@amd.com /** 68710938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 68810938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 6897550SBrad.Beckmann@amd.com */ 6907550SBrad.Beckmann@amd.com void 6917550SBrad.Beckmann@amd.com convertLlToRead() 6927550SBrad.Beckmann@amd.com { 6937550SBrad.Beckmann@amd.com assert(isLLSC()); 6947550SBrad.Beckmann@amd.com assert(isRead()); 6957550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 6967550SBrad.Beckmann@amd.com } 6977550SBrad.Beckmann@amd.com 6987550SBrad.Beckmann@amd.com /** 69910938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 70011057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 70111057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 7025735Snate@binkert.org */ 70310569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 70411057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 70511127Sandreas.hansson@arm.com size(0), headerDelay(0), snoopDelay(0), payloadDelay(0), 70611057Sandreas.hansson@arm.com senderState(NULL) 70711057Sandreas.hansson@arm.com { 70811057Sandreas.hansson@arm.com if (req->hasPaddr()) { 70911057Sandreas.hansson@arm.com addr = req->getPaddr(); 71011057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 71111057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 71211057Sandreas.hansson@arm.com } 71311057Sandreas.hansson@arm.com if (req->hasSize()) { 71411057Sandreas.hansson@arm.com size = req->getSize(); 71511057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 71611057Sandreas.hansson@arm.com } 71711057Sandreas.hansson@arm.com } 71811057Sandreas.hansson@arm.com 71911057Sandreas.hansson@arm.com /** 72011057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 72111057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 72211057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 72311057Sandreas.hansson@arm.com */ 72411057Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 72511057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 72611127Sandreas.hansson@arm.com headerDelay(0), snoopDelay(0), payloadDelay(0), 7279546Sandreas.hansson@arm.com senderState(NULL) 72811057Sandreas.hansson@arm.com { 72911057Sandreas.hansson@arm.com if (req->hasPaddr()) { 73011057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 73111057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 73211057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 73311057Sandreas.hansson@arm.com } 73411057Sandreas.hansson@arm.com size = _blkSize; 73511057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 73611057Sandreas.hansson@arm.com } 7374626Sstever@eecs.umich.edu 7385735Snate@binkert.org /** 7395735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 7404887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 7414887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 7424887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 7435735Snate@binkert.org * packet should allocate its own data. 7445735Snate@binkert.org */ 74510896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 7465735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 74710571Sandreas.hansson@arm.com data(nullptr), 74810028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 74910723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 75010694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 75111127Sandreas.hansson@arm.com snoopDelay(0), 75210694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 7539546Sandreas.hansson@arm.com senderState(pkt->senderState) 7544626Sstever@eecs.umich.edu { 75510571Sandreas.hansson@arm.com if (!clear_flags) 7565735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 7575735Snate@binkert.org 75811057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 75911057Sandreas.hansson@arm.com 76010571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 76110571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 76210571Sandreas.hansson@arm.com // co-ordinate state changes 76310571Sandreas.hansson@arm.com if (alloc_data) { 76410571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 76510571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 76610571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 76710571Sandreas.hansson@arm.com // carry the pointer forward 76810571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 76910571Sandreas.hansson@arm.com data = pkt->data; 77010571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 77110571Sandreas.hansson@arm.com } else { 77210571Sandreas.hansson@arm.com allocate(); 77310571Sandreas.hansson@arm.com } 77410571Sandreas.hansson@arm.com } 77510342SCurtis.Dunham@arm.com } 7768668Sgeoffrey.blake@arm.com 77710342SCurtis.Dunham@arm.com /** 77810739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 77910342SCurtis.Dunham@arm.com */ 78010739Ssteve.reinhardt@amd.com static MemCmd 78110739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 78210342SCurtis.Dunham@arm.com { 78310739Ssteve.reinhardt@amd.com if (req->isLLSC()) 78410739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 78510739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 78610739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 78710739Ssteve.reinhardt@amd.com else 78810739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 78910739Ssteve.reinhardt@amd.com } 79010739Ssteve.reinhardt@amd.com 79110739Ssteve.reinhardt@amd.com /** 79210739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 79310739Ssteve.reinhardt@amd.com */ 79410739Ssteve.reinhardt@amd.com static MemCmd 79510739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 79610739Ssteve.reinhardt@amd.com { 79710739Ssteve.reinhardt@amd.com if (req->isLLSC()) 79810739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 79910739Ssteve.reinhardt@amd.com else if (req->isSwap()) 80010739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 80110739Ssteve.reinhardt@amd.com else 80210739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 80310342SCurtis.Dunham@arm.com } 80410342SCurtis.Dunham@arm.com 80510342SCurtis.Dunham@arm.com /** 80610342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 80710739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 80810342SCurtis.Dunham@arm.com */ 80910342SCurtis.Dunham@arm.com static PacketPtr 81010569Sandreas.hansson@arm.com createRead(const RequestPtr req) 81110342SCurtis.Dunham@arm.com { 81210739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 81310342SCurtis.Dunham@arm.com } 81410342SCurtis.Dunham@arm.com 81510342SCurtis.Dunham@arm.com static PacketPtr 81610569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 81710342SCurtis.Dunham@arm.com { 81810739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 8192641Sstever@eecs.umich.edu } 8202549SN/A 8215735Snate@binkert.org /** 8225735Snate@binkert.org * clean up packet variables 8235735Snate@binkert.org */ 8242566SN/A ~Packet() 8255387Sstever@gmail.com { 82610872Sali.jafri@arm.com // Delete the request object if this is a request packet which 82710872Sali.jafri@arm.com // does not need a response, because the requester will not get 82810872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 82910872Sali.jafri@arm.com // request will be deleted on receipt of the response 83010872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 83110872Sali.jafri@arm.com // express snoops, even for cases when responses are not 83210872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 83310872Sali.jafri@arm.com // re-uses the same request. 83410872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 83510872Sali.jafri@arm.com !isExpressSnoop()) { 8365387Sstever@gmail.com delete req; 83710872Sali.jafri@arm.com } 8385735Snate@binkert.org deleteData(); 8395387Sstever@gmail.com } 8402566SN/A 8415735Snate@binkert.org /** 8424626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 84310660Sandreas.hansson@arm.com * returning as a response to that request. 8444626Sstever@eecs.umich.edu */ 8455735Snate@binkert.org void 8465735Snate@binkert.org makeResponse() 8474626Sstever@eecs.umich.edu { 8482662Sstever@eecs.umich.edu assert(needsResponse()); 8492855Srdreslin@umich.edu assert(isRequest()); 8504022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 8515745Snate@binkert.org 8527464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 8537464Ssteve.reinhardt@amd.com // triggered them was 8547464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 8552641Sstever@eecs.umich.edu } 8562641Sstever@eecs.umich.edu 8575735Snate@binkert.org void 8585735Snate@binkert.org makeAtomicResponse() 8594870Sstever@eecs.umich.edu { 8604870Sstever@eecs.umich.edu makeResponse(); 8614870Sstever@eecs.umich.edu } 8624870Sstever@eecs.umich.edu 8635735Snate@binkert.org void 8645735Snate@binkert.org makeTimingResponse() 8653348Sbinkertn@umich.edu { 8664870Sstever@eecs.umich.edu makeResponse(); 8673135Srdreslin@umich.edu } 8683135Srdreslin@umich.edu 8698436SBrad.Beckmann@amd.com void 8708436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 8718436SBrad.Beckmann@amd.com { 8728436SBrad.Beckmann@amd.com if (!success) { 8738436SBrad.Beckmann@amd.com if (isWrite()) { 8748436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 8758436SBrad.Beckmann@amd.com } else { 8768436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 8778436SBrad.Beckmann@amd.com } 8788436SBrad.Beckmann@amd.com } 8798436SBrad.Beckmann@amd.com } 8808436SBrad.Beckmann@amd.com 88111057Sandreas.hansson@arm.com void 88211057Sandreas.hansson@arm.com setSize(unsigned size) 88311057Sandreas.hansson@arm.com { 88411057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 88511057Sandreas.hansson@arm.com 88611057Sandreas.hansson@arm.com this->size = size; 88711057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 88811057Sandreas.hansson@arm.com } 88911057Sandreas.hansson@arm.com 89011057Sandreas.hansson@arm.com 89111013Sandreas.sandberg@arm.com public: 89211013Sandreas.sandberg@arm.com /** 89311013Sandreas.sandberg@arm.com * @{ 89411013Sandreas.sandberg@arm.com * @name Data accessor mehtods 89511013Sandreas.sandberg@arm.com */ 89611013Sandreas.sandberg@arm.com 8973348Sbinkertn@umich.edu /** 8983348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 89910571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 90010571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 90110571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 90210571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 90310571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 90410571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 90510571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 90610571Sandreas.hansson@arm.com * to the source, no copies are necessary. 9072566SN/A */ 9082566SN/A template <typename T> 9093348Sbinkertn@umich.edu void 9103348Sbinkertn@umich.edu dataStatic(T *p) 9113348Sbinkertn@umich.edu { 91210566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9133348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9145735Snate@binkert.org flags.set(STATIC_DATA); 9153348Sbinkertn@umich.edu } 9162566SN/A 9173348Sbinkertn@umich.edu /** 91810564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 91910564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 92010564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 92110564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 92210564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 92310564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 92410564Sandreas.hansson@arm.com */ 92510564Sandreas.hansson@arm.com template <typename T> 92610564Sandreas.hansson@arm.com void 92710564Sandreas.hansson@arm.com dataStaticConst(const T *p) 92810564Sandreas.hansson@arm.com { 92910566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 93010564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 93110564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 93210564Sandreas.hansson@arm.com } 93310564Sandreas.hansson@arm.com 93410564Sandreas.hansson@arm.com /** 9353348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 93610571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 93710571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 93810571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 93910571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 94010571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 94110571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 94210571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 94310571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 94410571Sandreas.hansson@arm.com * before it is deallocated. 9453348Sbinkertn@umich.edu */ 9462566SN/A template <typename T> 9473348Sbinkertn@umich.edu void 9483348Sbinkertn@umich.edu dataDynamic(T *p) 9493348Sbinkertn@umich.edu { 95010566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9513348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9525735Snate@binkert.org flags.set(DYNAMIC_DATA); 9533348Sbinkertn@umich.edu } 9543348Sbinkertn@umich.edu 9555735Snate@binkert.org /** 9565735Snate@binkert.org * get a pointer to the data ptr. 9575735Snate@binkert.org */ 9583348Sbinkertn@umich.edu template <typename T> 9593348Sbinkertn@umich.edu T* 96010562Sandreas.hansson@arm.com getPtr() 9613348Sbinkertn@umich.edu { 96210562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 9633348Sbinkertn@umich.edu return (T*)data; 9643348Sbinkertn@umich.edu } 9652566SN/A 96610563Sandreas.hansson@arm.com template <typename T> 96710563Sandreas.hansson@arm.com const T* 96810563Sandreas.hansson@arm.com getConstPtr() const 96910563Sandreas.hansson@arm.com { 97010563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 97110563Sandreas.hansson@arm.com return (const T*)data; 97210563Sandreas.hansson@arm.com } 97310563Sandreas.hansson@arm.com 9745735Snate@binkert.org /** 97511013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 97611013Sandreas.sandberg@arm.com * host endian. 97711013Sandreas.sandberg@arm.com */ 97811013Sandreas.sandberg@arm.com template <typename T> 97911013Sandreas.sandberg@arm.com T getBE() const; 98011013Sandreas.sandberg@arm.com 98111013Sandreas.sandberg@arm.com /** 98211013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 98311013Sandreas.sandberg@arm.com * host endian. 98411013Sandreas.sandberg@arm.com */ 98511013Sandreas.sandberg@arm.com template <typename T> 98611013Sandreas.sandberg@arm.com T getLE() const; 98711013Sandreas.sandberg@arm.com 98811013Sandreas.sandberg@arm.com /** 98911013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 99011013Sandreas.sandberg@arm.com * endianness. 99111013Sandreas.sandberg@arm.com */ 99211013Sandreas.sandberg@arm.com template <typename T> 99311013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 99411013Sandreas.sandberg@arm.com 99511013Sandreas.sandberg@arm.com /** 99611013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 99711013Sandreas.sandberg@arm.com * endian. 9985735Snate@binkert.org */ 9992566SN/A template <typename T> 100010563Sandreas.hansson@arm.com T get() const; 10012566SN/A 100211013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 100311013Sandreas.sandberg@arm.com template <typename T> 100411013Sandreas.sandberg@arm.com void setBE(T v); 100511013Sandreas.sandberg@arm.com 100611013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 100711013Sandreas.sandberg@arm.com template <typename T> 100811013Sandreas.sandberg@arm.com void setLE(T v); 100911013Sandreas.sandberg@arm.com 10105735Snate@binkert.org /** 101111013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 101211013Sandreas.sandberg@arm.com * endianness. 10135735Snate@binkert.org */ 10142566SN/A template <typename T> 101511013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 101611013Sandreas.sandberg@arm.com 101711013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 101811013Sandreas.sandberg@arm.com template <typename T> 10192592SN/A void set(T v); 10202566SN/A 10213348Sbinkertn@umich.edu /** 10224626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 10234626Sstever@eecs.umich.edu */ 10245735Snate@binkert.org void 102510563Sandreas.hansson@arm.com setData(const uint8_t *p) 10264626Sstever@eecs.umich.edu { 102710571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 102810571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 102910571Sandreas.hansson@arm.com // same pointer from source to destination and back 103010571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 103110571Sandreas.hansson@arm.com 10327691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 103310571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 103410571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 10357691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 10364626Sstever@eecs.umich.edu } 10374626Sstever@eecs.umich.edu 10384626Sstever@eecs.umich.edu /** 10394626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 10404626Sstever@eecs.umich.edu * which is aligned to the given block size. 10414626Sstever@eecs.umich.edu */ 10425735Snate@binkert.org void 104310563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 10444626Sstever@eecs.umich.edu { 10454626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 10464626Sstever@eecs.umich.edu } 10474626Sstever@eecs.umich.edu 10484626Sstever@eecs.umich.edu /** 10494626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 10504626Sstever@eecs.umich.edu * is aligned to the given block size. 10514626Sstever@eecs.umich.edu */ 10525735Snate@binkert.org void 105310563Sandreas.hansson@arm.com writeData(uint8_t *p) const 10544626Sstever@eecs.umich.edu { 105510563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 10564626Sstever@eecs.umich.edu } 10574626Sstever@eecs.umich.edu 10584626Sstever@eecs.umich.edu /** 10594626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 10604626Sstever@eecs.umich.edu */ 10615735Snate@binkert.org void 106210563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 10634626Sstever@eecs.umich.edu { 10644626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 10654626Sstever@eecs.umich.edu } 10664626Sstever@eecs.umich.edu 10674626Sstever@eecs.umich.edu /** 10683348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 10693348Sbinkertn@umich.edu * matter how data was allocted. 10703348Sbinkertn@umich.edu */ 10715735Snate@binkert.org void 10725735Snate@binkert.org deleteData() 10735735Snate@binkert.org { 107410566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 10755735Snate@binkert.org delete [] data; 10765735Snate@binkert.org 107710566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 10785735Snate@binkert.org data = NULL; 10795735Snate@binkert.org } 10802566SN/A 108110565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 10825735Snate@binkert.org void 10835735Snate@binkert.org allocate() 10845735Snate@binkert.org { 108511286Sandreas.hansson@arm.com // if either this command or the response command has a data 108611286Sandreas.hansson@arm.com // payload, actually allocate space 108711286Sandreas.hansson@arm.com if (hasData() || hasRespData()) { 108811286Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 108911286Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 109011286Sandreas.hansson@arm.com data = new uint8_t[getSize()]; 109111286Sandreas.hansson@arm.com } 10925735Snate@binkert.org } 10935735Snate@binkert.org 109411013Sandreas.sandberg@arm.com /** @} */ 109511013Sandreas.sandberg@arm.com 109611013Sandreas.sandberg@arm.com private: // Private data accessor methods 109711013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 109811013Sandreas.sandberg@arm.com template <typename T> 109911013Sandreas.sandberg@arm.com T getRaw() const; 110011013Sandreas.sandberg@arm.com 110111013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 110211013Sandreas.sandberg@arm.com template <typename T> 110311013Sandreas.sandberg@arm.com void setRaw(T v); 110411013Sandreas.sandberg@arm.com 110511013Sandreas.sandberg@arm.com public: 11064626Sstever@eecs.umich.edu /** 110710570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 110810570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 110910570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 111010570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 111110570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 111210570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 111310570Sandreas.hansson@arm.com * accordingly. 111410570Sandreas.hansson@arm.com */ 111510570Sandreas.hansson@arm.com bool 111610570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 111710570Sandreas.hansson@arm.com { 111810570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 111910570Sandreas.hansson@arm.com // data pointer 112010570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 112110570Sandreas.hansson@arm.com other->getSize(), 112210570Sandreas.hansson@arm.com other->hasData() ? 112310570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 112410570Sandreas.hansson@arm.com } 112510570Sandreas.hansson@arm.com 112610570Sandreas.hansson@arm.com /** 112710883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 112810883Sali.jafri@arm.com * in the memory hierarchy above. 112910883Sali.jafri@arm.com **/ 113010883Sali.jafri@arm.com bool 113110883Sali.jafri@arm.com mustCheckAbove() const 113210883Sali.jafri@arm.com { 113311199Sandreas.hansson@arm.com return cmd == MemCmd::HardPFReq || isEviction(); 113411199Sandreas.hansson@arm.com } 113511199Sandreas.hansson@arm.com 113611199Sandreas.hansson@arm.com /** 113711199Sandreas.hansson@arm.com * Is this packet a clean eviction, including both actual clean 113811199Sandreas.hansson@arm.com * evict packets, but also clean writebacks. 113911199Sandreas.hansson@arm.com */ 114011199Sandreas.hansson@arm.com bool 114111199Sandreas.hansson@arm.com isCleanEviction() const 114211199Sandreas.hansson@arm.com { 114311199Sandreas.hansson@arm.com return cmd == MemCmd::CleanEvict || cmd == MemCmd::WritebackClean; 114410883Sali.jafri@arm.com } 114510883Sali.jafri@arm.com 114610883Sali.jafri@arm.com /** 11474626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 114810570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 114910570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 115010570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 11514626Sstever@eecs.umich.edu * memory value. 11524626Sstever@eecs.umich.edu */ 11535735Snate@binkert.org bool 115410570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 115510570Sandreas.hansson@arm.com uint8_t *_data); 11565314Sstever@gmail.com 11575315Sstever@gmail.com /** 11585315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 11595315Sstever@gmail.com */ 11605735Snate@binkert.org void 11615735Snate@binkert.org pushLabel(const std::string &lbl) 11625735Snate@binkert.org { 11635735Snate@binkert.org if (isPrint()) 11645735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 11655314Sstever@gmail.com } 11665314Sstever@gmail.com 11675315Sstever@gmail.com /** 11685315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 11695315Sstever@gmail.com */ 11705735Snate@binkert.org void 11715735Snate@binkert.org popLabel() 11725735Snate@binkert.org { 11735735Snate@binkert.org if (isPrint()) 11745735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 11755314Sstever@gmail.com } 11765314Sstever@gmail.com 11775314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 11785314Sstever@gmail.com const std::string &prefix = "") const; 11799663Suri.wiener@arm.com 11809663Suri.wiener@arm.com /** 11819663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 11829663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 11839663Suri.wiener@arm.com * avoiding string overheads in fast mode 11849663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 11859663Suri.wiener@arm.com */ 11869663Suri.wiener@arm.com std::string print() const; 11872381SN/A}; 11882381SN/A 11892381SN/A#endif //__MEM_PACKET_HH 1190