packet.hh revision 11256
12381SN/A/* 210694SMarco.Balboni@ARM.com * Copyright (c) 2012-2015 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" 623940Ssaidi@eecs.umich.edu#include "base/misc.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, 1424626Sstever@eecs.umich.edu NeedsExclusive, //!< Requires exclusive 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 1544022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1554022Sstever@eecs.umich.edu }; 1564022Sstever@eecs.umich.edu 1575735Snate@binkert.org /** 1585735Snate@binkert.org * Structure that defines attributes and other data associated 1595735Snate@binkert.org * with a Command. 1605735Snate@binkert.org */ 1615735Snate@binkert.org struct CommandInfo 1625735Snate@binkert.org { 1635735Snate@binkert.org /// Set of attribute flags. 1644022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1655735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1665735Snate@binkert.org /// response is applicable. 1674022Sstever@eecs.umich.edu const Command response; 1685735Snate@binkert.org /// String representation (for printing) 1694022Sstever@eecs.umich.edu const std::string str; 1704022Sstever@eecs.umich.edu }; 1714022Sstever@eecs.umich.edu 1725735Snate@binkert.org /// Array to map Command enum to associated info. 1734022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1744022Sstever@eecs.umich.edu 1754022Sstever@eecs.umich.edu private: 1764022Sstever@eecs.umich.edu 1774022Sstever@eecs.umich.edu Command cmd; 1784022Sstever@eecs.umich.edu 1795735Snate@binkert.org bool 1805735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1815735Snate@binkert.org { 1824022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1834022Sstever@eecs.umich.edu } 1844022Sstever@eecs.umich.edu 1854022Sstever@eecs.umich.edu public: 1864022Sstever@eecs.umich.edu 18710583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 18810583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 18910583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19010583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 19110583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 19210583SCurtis.Dunham@arm.com bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 19310583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 19410583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 19511199Sandreas.hansson@arm.com bool isEviction() const { return testCmdAttrib(IsEviction); } 19611199Sandreas.hansson@arm.com 19711199Sandreas.hansson@arm.com /** 19811199Sandreas.hansson@arm.com * A writeback is an eviction that carries data. 19911199Sandreas.hansson@arm.com */ 20011199Sandreas.hansson@arm.com bool isWriteback() const { return testCmdAttrib(IsEviction) && 20111199Sandreas.hansson@arm.com testCmdAttrib(HasData); } 20210570Sandreas.hansson@arm.com 20310570Sandreas.hansson@arm.com /** 20410570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 20510570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 20610570Sandreas.hansson@arm.com * valid or not. 20710570Sandreas.hansson@arm.com */ 2084022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2096102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 21010343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 21110343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 21210343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 21310343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2144870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2155314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2168184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2174022Sstever@eecs.umich.edu 2185735Snate@binkert.org const Command 2195735Snate@binkert.org responseCommand() const 2205735Snate@binkert.org { 2214022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2224022Sstever@eecs.umich.edu } 2234022Sstever@eecs.umich.edu 2245735Snate@binkert.org /// Return the string to a cmd given by idx. 2255735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2264022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2274022Sstever@eecs.umich.edu 2285735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2295735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2305735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2314022Sstever@eecs.umich.edu 2325735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2335735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2344022Sstever@eecs.umich.edu}; 2354022Sstever@eecs.umich.edu 2362381SN/A/** 2372662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2382662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2392662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2402662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2412662Sstever@eecs.umich.edu * different Packets along the way.) 2422381SN/A */ 2439044SAli.Saidi@ARM.comclass Packet : public Printable 2442381SN/A{ 2452813Srdreslin@umich.edu public: 2465735Snate@binkert.org typedef uint32_t FlagsType; 2475735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2484022Sstever@eecs.umich.edu 2495735Snate@binkert.org private: 2505735Snate@binkert.org 25110938Sandreas.hansson@arm.com enum : FlagsType { 25210938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 25310938Sandreas.hansson@arm.com COPY_FLAGS = 0x0000000F, 25410938Sandreas.hansson@arm.com 25510938Sandreas.hansson@arm.com SHARED = 0x00000001, 25610938Sandreas.hansson@arm.com // Special control flags 25710938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 25810938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 25910938Sandreas.hansson@arm.com /// Does supplier have exclusive copy? 26010938Sandreas.hansson@arm.com /// Useful for multi-level coherence. 26110938Sandreas.hansson@arm.com SUPPLY_EXCLUSIVE = 0x00000004, 26210938Sandreas.hansson@arm.com // Snoop response flags 26310938Sandreas.hansson@arm.com MEM_INHIBIT = 0x00000008, 26410938Sandreas.hansson@arm.com 26511057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 26611057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 26711057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 26811057Sandreas.hansson@arm.com 26910938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 27010938Sandreas.hansson@arm.com /// when the packet is destroyed? 27110938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 27210938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 27310938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 27410938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 27510938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 27610938Sandreas.hansson@arm.com 27710938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 27810938Sandreas.hansson@arm.com /// access failure. 27910938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 28010938Sandreas.hansson@arm.com 28110938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 28210938Sandreas.hansson@arm.com // through express snoop flag 28310938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 28410938Sandreas.hansson@arm.com }; 2855735Snate@binkert.org 2865735Snate@binkert.org Flags flags; 2875735Snate@binkert.org 2885735Snate@binkert.org public: 2894022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2904022Sstever@eecs.umich.edu 2915735Snate@binkert.org /// The command field of the packet. 2924870Sstever@eecs.umich.edu MemCmd cmd; 2934870Sstever@eecs.umich.edu 2945735Snate@binkert.org /// A pointer to the original request. 29510569Sandreas.hansson@arm.com const RequestPtr req; 2964870Sstever@eecs.umich.edu 2972566SN/A private: 2985735Snate@binkert.org /** 2995735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 3005735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 3015735Snate@binkert.org * packet, not request. This may or may not be populated when a 3025735Snate@binkert.org * responder recieves the packet. If not populated it memory should 3035735Snate@binkert.org * be allocated. 3042566SN/A */ 3052566SN/A PacketDataPtr data; 3062566SN/A 3075735Snate@binkert.org /// The address of the request. This address could be virtual or 3085735Snate@binkert.org /// physical, depending on the system configuration. 3092381SN/A Addr addr; 3102381SN/A 31110028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 31210028SGiacomo.Gabrielli@arm.com bool _isSecure; 31310028SGiacomo.Gabrielli@arm.com 3145735Snate@binkert.org /// The size of the request or transfer. 3156227Snate@binkert.org unsigned size; 3162381SN/A 3175735Snate@binkert.org /** 31810723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3198668Sgeoffrey.blake@arm.com */ 32010723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3218668Sgeoffrey.blake@arm.com 3222641Sstever@eecs.umich.edu public: 3232811Srdreslin@umich.edu 3249547Sandreas.hansson@arm.com /** 32510694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 32610405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 32710405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 32810405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 32910405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3309547Sandreas.hansson@arm.com */ 33110694SMarco.Balboni@ARM.com uint32_t headerDelay; 3323218Sgblack@eecs.umich.edu 3339547Sandreas.hansson@arm.com /** 33411127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 33511127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 33611127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 33711127Sandreas.hansson@arm.com * delay. 33811127Sandreas.hansson@arm.com */ 33911127Sandreas.hansson@arm.com uint32_t snoopDelay; 34011127Sandreas.hansson@arm.com 34111127Sandreas.hansson@arm.com /** 34210694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 34310694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 34410694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 34510694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 34610405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 34710405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3489547Sandreas.hansson@arm.com */ 34910694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3503218Sgblack@eecs.umich.edu 3515735Snate@binkert.org /** 3525735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3539542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3549542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3559542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3569542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3579542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3589542Sandreas.hansson@arm.com * particular sending device. 3599542Sandreas.hansson@arm.com * 3609542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3619542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3629542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3639542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3649542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3659542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3669542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3675735Snate@binkert.org */ 3685735Snate@binkert.org struct SenderState 3695735Snate@binkert.org { 3709542Sandreas.hansson@arm.com SenderState* predecessor; 3719542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3722641Sstever@eecs.umich.edu virtual ~SenderState() {} 3732641Sstever@eecs.umich.edu }; 3742641Sstever@eecs.umich.edu 3755315Sstever@gmail.com /** 3765315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3775315Sstever@gmail.com * field of a PrintReq should always be of this type. 3785315Sstever@gmail.com */ 3799044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3805735Snate@binkert.org { 3815735Snate@binkert.org private: 3825735Snate@binkert.org /** 3835735Snate@binkert.org * An entry in the label stack. 3845735Snate@binkert.org */ 3855735Snate@binkert.org struct LabelStackEntry 3865735Snate@binkert.org { 3875314Sstever@gmail.com const std::string label; 3885314Sstever@gmail.com std::string *prefix; 3895314Sstever@gmail.com bool labelPrinted; 3905735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3915314Sstever@gmail.com }; 3925314Sstever@gmail.com 3935314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3945314Sstever@gmail.com LabelStack labelStack; 3955314Sstever@gmail.com 3965314Sstever@gmail.com std::string *curPrefixPtr; 3975314Sstever@gmail.com 3985314Sstever@gmail.com public: 3995314Sstever@gmail.com std::ostream &os; 4005314Sstever@gmail.com const int verbosity; 4015314Sstever@gmail.com 4025314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4035314Sstever@gmail.com ~PrintReqState(); 4045314Sstever@gmail.com 4055735Snate@binkert.org /** 4065735Snate@binkert.org * Returns the current line prefix. 4075735Snate@binkert.org */ 4085314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4095315Sstever@gmail.com 4105735Snate@binkert.org /** 4115735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4125315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4135735Snate@binkert.org * printed if an object within the label's scope is printed. 4145735Snate@binkert.org */ 4155314Sstever@gmail.com void pushLabel(const std::string &lbl, 4165314Sstever@gmail.com const std::string &prefix = " "); 4175735Snate@binkert.org 4185735Snate@binkert.org /** 4195735Snate@binkert.org * Pop a label off the label stack. 4205735Snate@binkert.org */ 4215314Sstever@gmail.com void popLabel(); 4225735Snate@binkert.org 4235735Snate@binkert.org /** 4245735Snate@binkert.org * Print all of the pending unprinted labels on the 4255315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4265735Snate@binkert.org * users unless bypassing printObj(). 4275735Snate@binkert.org */ 4285314Sstever@gmail.com void printLabels(); 4295735Snate@binkert.org 4305735Snate@binkert.org /** 4315735Snate@binkert.org * Print a Printable object to os, because it matched the 4325735Snate@binkert.org * address on a PrintReq. 4335735Snate@binkert.org */ 4345314Sstever@gmail.com void printObj(Printable *obj); 4355314Sstever@gmail.com }; 4365314Sstever@gmail.com 4375735Snate@binkert.org /** 4385735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4395735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4405735Snate@binkert.org * this variable is to allow a device to attach extra information 4419542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4425735Snate@binkert.org * that was attached to the original request (even if a new packet 4435735Snate@binkert.org * is created). 4445735Snate@binkert.org */ 4452662Sstever@eecs.umich.edu SenderState *senderState; 4462641Sstever@eecs.umich.edu 4479542Sandreas.hansson@arm.com /** 4489542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4499542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4509542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4519542Sandreas.hansson@arm.com * variable. 4529542Sandreas.hansson@arm.com * 4539542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4549542Sandreas.hansson@arm.com */ 4559542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4569542Sandreas.hansson@arm.com 4579542Sandreas.hansson@arm.com /** 4589542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4599542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4609542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4619542Sandreas.hansson@arm.com * variable. 4629542Sandreas.hansson@arm.com * 4639542Sandreas.hansson@arm.com * @return The current top of the stack 4649542Sandreas.hansson@arm.com */ 4659542Sandreas.hansson@arm.com SenderState *popSenderState(); 4669542Sandreas.hansson@arm.com 4679543Ssascha.bischoff@arm.com /** 4689543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4699543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4709543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4719543Ssascha.bischoff@arm.com * 4729543Ssascha.bischoff@arm.com * @return The topmost state of type T 4739543Ssascha.bischoff@arm.com */ 4749543Ssascha.bischoff@arm.com template <typename T> 4759543Ssascha.bischoff@arm.com T * findNextSenderState() const 4769543Ssascha.bischoff@arm.com { 4779543Ssascha.bischoff@arm.com T *t = NULL; 4789543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4799543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4809543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4819543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4829543Ssascha.bischoff@arm.com } 4839543Ssascha.bischoff@arm.com return t; 4849543Ssascha.bischoff@arm.com } 4859543Ssascha.bischoff@arm.com 4865735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4875735Snate@binkert.org /// tracing). 4884022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4892811Srdreslin@umich.edu 4905735Snate@binkert.org /// Return the index of this command. 4914022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4922811Srdreslin@umich.edu 49310583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 49410583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 49510583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 49610583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 49710583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 49810583SCurtis.Dunham@arm.com bool needsExclusive() const { return cmd.needsExclusive(); } 49910583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 50010583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 50111199Sandreas.hansson@arm.com bool isEviction() const { return cmd.isEviction(); } 50211199Sandreas.hansson@arm.com bool isWriteback() const { return cmd.isWriteback(); } 50310583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 50410583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 50510583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 50610583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 50710583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 5082812Srdreslin@umich.edu 5094870Sstever@eecs.umich.edu // Snoop flags 51010567Sandreas.hansson@arm.com void assertMemInhibit() 51110567Sandreas.hansson@arm.com { 51210567Sandreas.hansson@arm.com assert(isRequest()); 51310567Sandreas.hansson@arm.com assert(!flags.isSet(MEM_INHIBIT)); 51410567Sandreas.hansson@arm.com flags.set(MEM_INHIBIT); 51510567Sandreas.hansson@arm.com } 5169951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 5179951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 5189951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 5194870Sstever@eecs.umich.edu 5204895Sstever@eecs.umich.edu // Special control flags 5219951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5229951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5239951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5249951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5259951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5269951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 52710763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 52810763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 52910883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 5304895Sstever@eecs.umich.edu 5314870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5324870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5334870Sstever@eecs.umich.edu // field, etc.) 5345735Snate@binkert.org void 5355735Snate@binkert.org setBadAddress() 5365735Snate@binkert.org { 5375735Snate@binkert.org assert(isResponse()); 5385735Snate@binkert.org cmd = MemCmd::BadAddressError; 5395735Snate@binkert.org } 5405735Snate@binkert.org 5414986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5422814Srdreslin@umich.edu 54311057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5449259SAli.Saidi@ARM.com /** 5459259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5469259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5479259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5489259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5499259SAli.Saidi@ARM.com * valid. 5509259SAli.Saidi@ARM.com */ 55111057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5529259SAli.Saidi@ARM.com 55311057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 55410938Sandreas.hansson@arm.com 55510938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 55610938Sandreas.hansson@arm.com { 55710938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 55810938Sandreas.hansson@arm.com } 55910938Sandreas.hansson@arm.com 56010938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 56110938Sandreas.hansson@arm.com { 56210938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 56310938Sandreas.hansson@arm.com } 5642549SN/A 56511057Sandreas.hansson@arm.com bool isSecure() const 56611057Sandreas.hansson@arm.com { 56711057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 56811057Sandreas.hansson@arm.com return _isSecure; 56911057Sandreas.hansson@arm.com } 57010028SGiacomo.Gabrielli@arm.com 5715735Snate@binkert.org /** 5727550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 57310938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 5747550SBrad.Beckmann@amd.com */ 5757550SBrad.Beckmann@amd.com void 5767550SBrad.Beckmann@amd.com convertScToWrite() 5777550SBrad.Beckmann@amd.com { 5787550SBrad.Beckmann@amd.com assert(isLLSC()); 5797550SBrad.Beckmann@amd.com assert(isWrite()); 5807550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5817550SBrad.Beckmann@amd.com } 5827550SBrad.Beckmann@amd.com 5837550SBrad.Beckmann@amd.com /** 58410938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 58510938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 5867550SBrad.Beckmann@amd.com */ 5877550SBrad.Beckmann@amd.com void 5887550SBrad.Beckmann@amd.com convertLlToRead() 5897550SBrad.Beckmann@amd.com { 5907550SBrad.Beckmann@amd.com assert(isLLSC()); 5917550SBrad.Beckmann@amd.com assert(isRead()); 5927550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5937550SBrad.Beckmann@amd.com } 5947550SBrad.Beckmann@amd.com 5957550SBrad.Beckmann@amd.com /** 59610938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 59711057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 59811057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 5995735Snate@binkert.org */ 60010569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 60111057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 60211127Sandreas.hansson@arm.com size(0), headerDelay(0), snoopDelay(0), payloadDelay(0), 60311057Sandreas.hansson@arm.com senderState(NULL) 60411057Sandreas.hansson@arm.com { 60511057Sandreas.hansson@arm.com if (req->hasPaddr()) { 60611057Sandreas.hansson@arm.com addr = req->getPaddr(); 60711057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 60811057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 60911057Sandreas.hansson@arm.com } 61011057Sandreas.hansson@arm.com if (req->hasSize()) { 61111057Sandreas.hansson@arm.com size = req->getSize(); 61211057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 61311057Sandreas.hansson@arm.com } 61411057Sandreas.hansson@arm.com } 61511057Sandreas.hansson@arm.com 61611057Sandreas.hansson@arm.com /** 61711057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 61811057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 61911057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 62011057Sandreas.hansson@arm.com */ 62111057Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 62211057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 62311127Sandreas.hansson@arm.com headerDelay(0), snoopDelay(0), payloadDelay(0), 6249546Sandreas.hansson@arm.com senderState(NULL) 62511057Sandreas.hansson@arm.com { 62611057Sandreas.hansson@arm.com if (req->hasPaddr()) { 62711057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 62811057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 62911057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 63011057Sandreas.hansson@arm.com } 63111057Sandreas.hansson@arm.com size = _blkSize; 63211057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 63311057Sandreas.hansson@arm.com } 6344626Sstever@eecs.umich.edu 6355735Snate@binkert.org /** 6365735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6374887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6384887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6394887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6405735Snate@binkert.org * packet should allocate its own data. 6415735Snate@binkert.org */ 64210896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 6435735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 64410571Sandreas.hansson@arm.com data(nullptr), 64510028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 64610723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 64710694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 64811127Sandreas.hansson@arm.com snoopDelay(0), 64910694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 6509546Sandreas.hansson@arm.com senderState(pkt->senderState) 6514626Sstever@eecs.umich.edu { 65210571Sandreas.hansson@arm.com if (!clear_flags) 6535735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6545735Snate@binkert.org 65511057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 65611057Sandreas.hansson@arm.com 65710571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 65810571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 65910571Sandreas.hansson@arm.com // co-ordinate state changes 66010571Sandreas.hansson@arm.com if (alloc_data) { 66110571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 66210571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 66310571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 66410571Sandreas.hansson@arm.com // carry the pointer forward 66510571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 66610571Sandreas.hansson@arm.com data = pkt->data; 66710571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 66810571Sandreas.hansson@arm.com } else { 66910571Sandreas.hansson@arm.com allocate(); 67010571Sandreas.hansson@arm.com } 67110571Sandreas.hansson@arm.com } 67210342SCurtis.Dunham@arm.com } 6738668Sgeoffrey.blake@arm.com 67410342SCurtis.Dunham@arm.com /** 67510739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 67610342SCurtis.Dunham@arm.com */ 67710739Ssteve.reinhardt@amd.com static MemCmd 67810739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 67910342SCurtis.Dunham@arm.com { 68010739Ssteve.reinhardt@amd.com if (req->isLLSC()) 68110739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 68210739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 68310739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 68410739Ssteve.reinhardt@amd.com else 68510739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 68610739Ssteve.reinhardt@amd.com } 68710739Ssteve.reinhardt@amd.com 68810739Ssteve.reinhardt@amd.com /** 68910739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 69010739Ssteve.reinhardt@amd.com */ 69110739Ssteve.reinhardt@amd.com static MemCmd 69210739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 69310739Ssteve.reinhardt@amd.com { 69410739Ssteve.reinhardt@amd.com if (req->isLLSC()) 69510739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 69610739Ssteve.reinhardt@amd.com else if (req->isSwap()) 69710739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 69810739Ssteve.reinhardt@amd.com else 69910739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 70010342SCurtis.Dunham@arm.com } 70110342SCurtis.Dunham@arm.com 70210342SCurtis.Dunham@arm.com /** 70310342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 70410739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 70510342SCurtis.Dunham@arm.com */ 70610342SCurtis.Dunham@arm.com static PacketPtr 70710569Sandreas.hansson@arm.com createRead(const RequestPtr req) 70810342SCurtis.Dunham@arm.com { 70910739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 71010342SCurtis.Dunham@arm.com } 71110342SCurtis.Dunham@arm.com 71210342SCurtis.Dunham@arm.com static PacketPtr 71310569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 71410342SCurtis.Dunham@arm.com { 71510739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 7162641Sstever@eecs.umich.edu } 7172549SN/A 7185735Snate@binkert.org /** 7195735Snate@binkert.org * clean up packet variables 7205735Snate@binkert.org */ 7212566SN/A ~Packet() 7225387Sstever@gmail.com { 72310872Sali.jafri@arm.com // Delete the request object if this is a request packet which 72410872Sali.jafri@arm.com // does not need a response, because the requester will not get 72510872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 72610872Sali.jafri@arm.com // request will be deleted on receipt of the response 72710872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 72810872Sali.jafri@arm.com // express snoops, even for cases when responses are not 72910872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 73010872Sali.jafri@arm.com // re-uses the same request. 73110872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 73210872Sali.jafri@arm.com !isExpressSnoop()) { 7335387Sstever@gmail.com delete req; 73410872Sali.jafri@arm.com } 7355735Snate@binkert.org deleteData(); 7365387Sstever@gmail.com } 7372566SN/A 7385735Snate@binkert.org /** 7394626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 74010660Sandreas.hansson@arm.com * returning as a response to that request. 7414626Sstever@eecs.umich.edu */ 7425735Snate@binkert.org void 7435735Snate@binkert.org makeResponse() 7444626Sstever@eecs.umich.edu { 7452662Sstever@eecs.umich.edu assert(needsResponse()); 7462855Srdreslin@umich.edu assert(isRequest()); 7474022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7485745Snate@binkert.org 7497464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7507464Ssteve.reinhardt@amd.com // triggered them was 7517464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7522641Sstever@eecs.umich.edu } 7532641Sstever@eecs.umich.edu 7545735Snate@binkert.org void 7555735Snate@binkert.org makeAtomicResponse() 7564870Sstever@eecs.umich.edu { 7574870Sstever@eecs.umich.edu makeResponse(); 7584870Sstever@eecs.umich.edu } 7594870Sstever@eecs.umich.edu 7605735Snate@binkert.org void 7615735Snate@binkert.org makeTimingResponse() 7623348Sbinkertn@umich.edu { 7634870Sstever@eecs.umich.edu makeResponse(); 7643135Srdreslin@umich.edu } 7653135Srdreslin@umich.edu 7668436SBrad.Beckmann@amd.com void 7678436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7688436SBrad.Beckmann@amd.com { 7698436SBrad.Beckmann@amd.com if (!success) { 7708436SBrad.Beckmann@amd.com if (isWrite()) { 7718436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7728436SBrad.Beckmann@amd.com } else { 7738436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7748436SBrad.Beckmann@amd.com } 7758436SBrad.Beckmann@amd.com } 7768436SBrad.Beckmann@amd.com } 7778436SBrad.Beckmann@amd.com 77811057Sandreas.hansson@arm.com void 77911057Sandreas.hansson@arm.com setSize(unsigned size) 78011057Sandreas.hansson@arm.com { 78111057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 78211057Sandreas.hansson@arm.com 78311057Sandreas.hansson@arm.com this->size = size; 78411057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 78511057Sandreas.hansson@arm.com } 78611057Sandreas.hansson@arm.com 78711057Sandreas.hansson@arm.com 78811013Sandreas.sandberg@arm.com public: 78911013Sandreas.sandberg@arm.com /** 79011013Sandreas.sandberg@arm.com * @{ 79111013Sandreas.sandberg@arm.com * @name Data accessor mehtods 79211013Sandreas.sandberg@arm.com */ 79311013Sandreas.sandberg@arm.com 7943348Sbinkertn@umich.edu /** 7953348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 79610571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 79710571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 79810571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 79910571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 80010571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 80110571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 80210571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 80310571Sandreas.hansson@arm.com * to the source, no copies are necessary. 8042566SN/A */ 8052566SN/A template <typename T> 8063348Sbinkertn@umich.edu void 8073348Sbinkertn@umich.edu dataStatic(T *p) 8083348Sbinkertn@umich.edu { 80910566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8103348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8115735Snate@binkert.org flags.set(STATIC_DATA); 8123348Sbinkertn@umich.edu } 8132566SN/A 8143348Sbinkertn@umich.edu /** 81510564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 81610564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 81710564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 81810564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 81910564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 82010564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 82110564Sandreas.hansson@arm.com */ 82210564Sandreas.hansson@arm.com template <typename T> 82310564Sandreas.hansson@arm.com void 82410564Sandreas.hansson@arm.com dataStaticConst(const T *p) 82510564Sandreas.hansson@arm.com { 82610566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 82710564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 82810564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 82910564Sandreas.hansson@arm.com } 83010564Sandreas.hansson@arm.com 83110564Sandreas.hansson@arm.com /** 8323348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 83310571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 83410571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 83510571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 83610571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 83710571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 83810571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 83910571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 84010571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 84110571Sandreas.hansson@arm.com * before it is deallocated. 8423348Sbinkertn@umich.edu */ 8432566SN/A template <typename T> 8443348Sbinkertn@umich.edu void 8453348Sbinkertn@umich.edu dataDynamic(T *p) 8463348Sbinkertn@umich.edu { 84710566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8483348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8495735Snate@binkert.org flags.set(DYNAMIC_DATA); 8503348Sbinkertn@umich.edu } 8513348Sbinkertn@umich.edu 8525735Snate@binkert.org /** 8535735Snate@binkert.org * get a pointer to the data ptr. 8545735Snate@binkert.org */ 8553348Sbinkertn@umich.edu template <typename T> 8563348Sbinkertn@umich.edu T* 85710562Sandreas.hansson@arm.com getPtr() 8583348Sbinkertn@umich.edu { 85910562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8603348Sbinkertn@umich.edu return (T*)data; 8613348Sbinkertn@umich.edu } 8622566SN/A 86310563Sandreas.hansson@arm.com template <typename T> 86410563Sandreas.hansson@arm.com const T* 86510563Sandreas.hansson@arm.com getConstPtr() const 86610563Sandreas.hansson@arm.com { 86710563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 86810563Sandreas.hansson@arm.com return (const T*)data; 86910563Sandreas.hansson@arm.com } 87010563Sandreas.hansson@arm.com 8715735Snate@binkert.org /** 87211013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 87311013Sandreas.sandberg@arm.com * host endian. 87411013Sandreas.sandberg@arm.com */ 87511013Sandreas.sandberg@arm.com template <typename T> 87611013Sandreas.sandberg@arm.com T getBE() const; 87711013Sandreas.sandberg@arm.com 87811013Sandreas.sandberg@arm.com /** 87911013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 88011013Sandreas.sandberg@arm.com * host endian. 88111013Sandreas.sandberg@arm.com */ 88211013Sandreas.sandberg@arm.com template <typename T> 88311013Sandreas.sandberg@arm.com T getLE() const; 88411013Sandreas.sandberg@arm.com 88511013Sandreas.sandberg@arm.com /** 88611013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 88711013Sandreas.sandberg@arm.com * endianness. 88811013Sandreas.sandberg@arm.com */ 88911013Sandreas.sandberg@arm.com template <typename T> 89011013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 89111013Sandreas.sandberg@arm.com 89211013Sandreas.sandberg@arm.com /** 89311013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 89411013Sandreas.sandberg@arm.com * endian. 8955735Snate@binkert.org */ 8962566SN/A template <typename T> 89710563Sandreas.hansson@arm.com T get() const; 8982566SN/A 89911013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 90011013Sandreas.sandberg@arm.com template <typename T> 90111013Sandreas.sandberg@arm.com void setBE(T v); 90211013Sandreas.sandberg@arm.com 90311013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 90411013Sandreas.sandberg@arm.com template <typename T> 90511013Sandreas.sandberg@arm.com void setLE(T v); 90611013Sandreas.sandberg@arm.com 9075735Snate@binkert.org /** 90811013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 90911013Sandreas.sandberg@arm.com * endianness. 9105735Snate@binkert.org */ 9112566SN/A template <typename T> 91211013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 91311013Sandreas.sandberg@arm.com 91411013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 91511013Sandreas.sandberg@arm.com template <typename T> 9162592SN/A void set(T v); 9172566SN/A 9183348Sbinkertn@umich.edu /** 9194626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 9204626Sstever@eecs.umich.edu */ 9215735Snate@binkert.org void 92210563Sandreas.hansson@arm.com setData(const uint8_t *p) 9234626Sstever@eecs.umich.edu { 92410571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 92510571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 92610571Sandreas.hansson@arm.com // same pointer from source to destination and back 92710571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 92810571Sandreas.hansson@arm.com 9297691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 93010571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 93110571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 9327691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 9334626Sstever@eecs.umich.edu } 9344626Sstever@eecs.umich.edu 9354626Sstever@eecs.umich.edu /** 9364626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 9374626Sstever@eecs.umich.edu * which is aligned to the given block size. 9384626Sstever@eecs.umich.edu */ 9395735Snate@binkert.org void 94010563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 9414626Sstever@eecs.umich.edu { 9424626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 9434626Sstever@eecs.umich.edu } 9444626Sstever@eecs.umich.edu 9454626Sstever@eecs.umich.edu /** 9464626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 9474626Sstever@eecs.umich.edu * is aligned to the given block size. 9484626Sstever@eecs.umich.edu */ 9495735Snate@binkert.org void 95010563Sandreas.hansson@arm.com writeData(uint8_t *p) const 9514626Sstever@eecs.umich.edu { 95210563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 9534626Sstever@eecs.umich.edu } 9544626Sstever@eecs.umich.edu 9554626Sstever@eecs.umich.edu /** 9564626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 9574626Sstever@eecs.umich.edu */ 9585735Snate@binkert.org void 95910563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 9604626Sstever@eecs.umich.edu { 9614626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 9624626Sstever@eecs.umich.edu } 9634626Sstever@eecs.umich.edu 9644626Sstever@eecs.umich.edu /** 9653348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 9663348Sbinkertn@umich.edu * matter how data was allocted. 9673348Sbinkertn@umich.edu */ 9685735Snate@binkert.org void 9695735Snate@binkert.org deleteData() 9705735Snate@binkert.org { 97110566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 9725735Snate@binkert.org delete [] data; 9735735Snate@binkert.org 97410566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 9755735Snate@binkert.org data = NULL; 9765735Snate@binkert.org } 9772566SN/A 97810565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9795735Snate@binkert.org void 9805735Snate@binkert.org allocate() 9815735Snate@binkert.org { 9825764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 98310566Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 9845745Snate@binkert.org data = new uint8_t[getSize()]; 9855735Snate@binkert.org } 9865735Snate@binkert.org 98711013Sandreas.sandberg@arm.com /** @} */ 98811013Sandreas.sandberg@arm.com 98911013Sandreas.sandberg@arm.com private: // Private data accessor methods 99011013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 99111013Sandreas.sandberg@arm.com template <typename T> 99211013Sandreas.sandberg@arm.com T getRaw() const; 99311013Sandreas.sandberg@arm.com 99411013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 99511013Sandreas.sandberg@arm.com template <typename T> 99611013Sandreas.sandberg@arm.com void setRaw(T v); 99711013Sandreas.sandberg@arm.com 99811013Sandreas.sandberg@arm.com public: 9994626Sstever@eecs.umich.edu /** 100010570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 100110570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 100210570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 100310570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 100410570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 100510570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 100610570Sandreas.hansson@arm.com * accordingly. 100710570Sandreas.hansson@arm.com */ 100810570Sandreas.hansson@arm.com bool 100910570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 101010570Sandreas.hansson@arm.com { 101110570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 101210570Sandreas.hansson@arm.com // data pointer 101310570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 101410570Sandreas.hansson@arm.com other->getSize(), 101510570Sandreas.hansson@arm.com other->hasData() ? 101610570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 101710570Sandreas.hansson@arm.com } 101810570Sandreas.hansson@arm.com 101910570Sandreas.hansson@arm.com /** 102010883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 102110883Sali.jafri@arm.com * in the memory hierarchy above. 102210883Sali.jafri@arm.com **/ 102310883Sali.jafri@arm.com bool 102410883Sali.jafri@arm.com mustCheckAbove() const 102510883Sali.jafri@arm.com { 102611199Sandreas.hansson@arm.com return cmd == MemCmd::HardPFReq || isEviction(); 102711199Sandreas.hansson@arm.com } 102811199Sandreas.hansson@arm.com 102911199Sandreas.hansson@arm.com /** 103011199Sandreas.hansson@arm.com * Is this packet a clean eviction, including both actual clean 103111199Sandreas.hansson@arm.com * evict packets, but also clean writebacks. 103211199Sandreas.hansson@arm.com */ 103311199Sandreas.hansson@arm.com bool 103411199Sandreas.hansson@arm.com isCleanEviction() const 103511199Sandreas.hansson@arm.com { 103611199Sandreas.hansson@arm.com return cmd == MemCmd::CleanEvict || cmd == MemCmd::WritebackClean; 103710883Sali.jafri@arm.com } 103810883Sali.jafri@arm.com 103910883Sali.jafri@arm.com /** 10404626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 104110570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 104210570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 104310570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 10444626Sstever@eecs.umich.edu * memory value. 10454626Sstever@eecs.umich.edu */ 10465735Snate@binkert.org bool 104710570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 104810570Sandreas.hansson@arm.com uint8_t *_data); 10495314Sstever@gmail.com 10505315Sstever@gmail.com /** 10515315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 10525315Sstever@gmail.com */ 10535735Snate@binkert.org void 10545735Snate@binkert.org pushLabel(const std::string &lbl) 10555735Snate@binkert.org { 10565735Snate@binkert.org if (isPrint()) 10575735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 10585314Sstever@gmail.com } 10595314Sstever@gmail.com 10605315Sstever@gmail.com /** 10615315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 10625315Sstever@gmail.com */ 10635735Snate@binkert.org void 10645735Snate@binkert.org popLabel() 10655735Snate@binkert.org { 10665735Snate@binkert.org if (isPrint()) 10675735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 10685314Sstever@gmail.com } 10695314Sstever@gmail.com 10705314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 10715314Sstever@gmail.com const std::string &prefix = "") const; 10729663Suri.wiener@arm.com 10739663Suri.wiener@arm.com /** 10749663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 10759663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 10769663Suri.wiener@arm.com * avoiding string overheads in fast mode 10779663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 10789663Suri.wiener@arm.com */ 10799663Suri.wiener@arm.com std::string print() const; 10802381SN/A}; 10812381SN/A 10822381SN/A#endif //__MEM_PACKET_HH 1083