packet.hh revision 12349
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 4512349Snikos.nikoleris@arm.com * Nikos Nikoleris 462381SN/A */ 472381SN/A 482381SN/A/** 492381SN/A * @file 502662Sstever@eecs.umich.edu * Declaration of the Packet class. 512381SN/A */ 522381SN/A 532381SN/A#ifndef __MEM_PACKET_HH__ 542381SN/A#define __MEM_PACKET_HH__ 552381SN/A 568229Snate@binkert.org#include <bitset> 573348Sbinkertn@umich.edu#include <cassert> 583348Sbinkertn@umich.edu#include <list> 593348Sbinkertn@umich.edu 605735Snate@binkert.org#include "base/cast.hh" 614024Sbinkertn@umich.edu#include "base/compiler.hh" 625735Snate@binkert.org#include "base/flags.hh" 6312334Sgabeblack@google.com#include "base/logging.hh" 645314Sstever@gmail.com#include "base/printable.hh" 656216Snate@binkert.org#include "base/types.hh" 662392SN/A#include "mem/request.hh" 674167Sbinkertn@umich.edu#include "sim/core.hh" 682394SN/A 698737Skoansin.tan@gmail.comclass Packet; 703349Sbinkertn@umich.edutypedef Packet *PacketPtr; 712394SN/Atypedef uint8_t* PacketDataPtr; 722812Srdreslin@umich.edutypedef std::list<PacketPtr> PacketList; 732812Srdreslin@umich.edu 744022Sstever@eecs.umich.educlass MemCmd 754022Sstever@eecs.umich.edu{ 765735Snate@binkert.org friend class Packet; 775735Snate@binkert.org 784022Sstever@eecs.umich.edu public: 795735Snate@binkert.org /** 805735Snate@binkert.org * List of all commands associated with a packet. 815735Snate@binkert.org */ 824022Sstever@eecs.umich.edu enum Command 834022Sstever@eecs.umich.edu { 844022Sstever@eecs.umich.edu InvalidCmd, 854022Sstever@eecs.umich.edu ReadReq, 864473Sstever@eecs.umich.edu ReadResp, 875319Sstever@gmail.com ReadRespWithInvalidate, 884022Sstever@eecs.umich.edu WriteReq, 894022Sstever@eecs.umich.edu WriteResp, 9011199Sandreas.hansson@arm.com WritebackDirty, 9111199Sandreas.hansson@arm.com WritebackClean, 9212344Snikos.nikoleris@arm.com WriteClean, // writes dirty data below without evicting 9310883Sali.jafri@arm.com CleanEvict, 944022Sstever@eecs.umich.edu SoftPFReq, 954022Sstever@eecs.umich.edu HardPFReq, 964022Sstever@eecs.umich.edu SoftPFResp, 974022Sstever@eecs.umich.edu HardPFResp, 9810886Sandreas.hansson@arm.com WriteLineReq, 994022Sstever@eecs.umich.edu UpgradeReq, 1007465Ssteve.reinhardt@amd.com SCUpgradeReq, // Special "weak" upgrade for StoreCond 1014628Sstever@eecs.umich.edu UpgradeResp, 1027465Ssteve.reinhardt@amd.com SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1037465Ssteve.reinhardt@amd.com UpgradeFailResp, // Valid for SCUpgradeReq only 1044022Sstever@eecs.umich.edu ReadExReq, 1054022Sstever@eecs.umich.edu ReadExResp, 10610885Sandreas.hansson@arm.com ReadCleanReq, 10710885Sandreas.hansson@arm.com ReadSharedReq, 1084626Sstever@eecs.umich.edu LoadLockedReq, 1094626Sstever@eecs.umich.edu StoreCondReq, 1107669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1114626Sstever@eecs.umich.edu StoreCondResp, 1124040Ssaidi@eecs.umich.edu SwapReq, 1134040Ssaidi@eecs.umich.edu SwapResp, 1145650Sgblack@eecs.umich.edu MessageReq, 1155650Sgblack@eecs.umich.edu MessageResp, 11611256Santhony.gutierrez@amd.com MemFenceReq, 11711256Santhony.gutierrez@amd.com MemFenceResp, 11812347Snikos.nikoleris@arm.com CleanSharedReq, 11912347Snikos.nikoleris@arm.com CleanSharedResp, 12012347Snikos.nikoleris@arm.com CleanInvalidReq, 12112347Snikos.nikoleris@arm.com CleanInvalidResp, 1224870Sstever@eecs.umich.edu // Error responses 1234870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1244870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1254870Sstever@eecs.umich.edu // compatibility 1264870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1274870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1288436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1298436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1305314Sstever@gmail.com // Fake simulator-only commands 1315314Sstever@gmail.com PrintReq, // Print state matching address 1328184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 13310886Sandreas.hansson@arm.com InvalidateReq, // request for address to be invalidated 13410886Sandreas.hansson@arm.com InvalidateResp, 1354022Sstever@eecs.umich.edu NUM_MEM_CMDS 1364022Sstever@eecs.umich.edu }; 1374022Sstever@eecs.umich.edu 1384022Sstever@eecs.umich.edu private: 1395735Snate@binkert.org /** 1405735Snate@binkert.org * List of command attributes. 1415735Snate@binkert.org */ 1424022Sstever@eecs.umich.edu enum Attribute 1434022Sstever@eecs.umich.edu { 1444626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1454626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1467465Ssteve.reinhardt@amd.com IsUpgrade, 1474022Sstever@eecs.umich.edu IsInvalidate, 14812347Snikos.nikoleris@arm.com IsClean, //!< Cleans any existing dirty blocks 14911284Sandreas.hansson@arm.com NeedsWritable, //!< Requires writable copy to complete in-cache 1504626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1514626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1524626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 15311199Sandreas.hansson@arm.com IsEviction, 1544022Sstever@eecs.umich.edu IsSWPrefetch, 1554022Sstever@eecs.umich.edu IsHWPrefetch, 1566076Sgblack@eecs.umich.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1574626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1584870Sstever@eecs.umich.edu IsError, //!< Error response 1595314Sstever@gmail.com IsPrint, //!< Print state matching address (for debugging) 1608184Ssomayeh@cs.wisc.edu IsFlush, //!< Flush the address from caches 16111600Sandreas.hansson@arm.com FromCache, //!< Request originated from a caching agent 1624022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1634022Sstever@eecs.umich.edu }; 1644022Sstever@eecs.umich.edu 1655735Snate@binkert.org /** 1665735Snate@binkert.org * Structure that defines attributes and other data associated 1675735Snate@binkert.org * with a Command. 1685735Snate@binkert.org */ 1695735Snate@binkert.org struct CommandInfo 1705735Snate@binkert.org { 1715735Snate@binkert.org /// Set of attribute flags. 1724022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1735735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1745735Snate@binkert.org /// response is applicable. 1754022Sstever@eecs.umich.edu const Command response; 1765735Snate@binkert.org /// String representation (for printing) 1774022Sstever@eecs.umich.edu const std::string str; 1784022Sstever@eecs.umich.edu }; 1794022Sstever@eecs.umich.edu 1805735Snate@binkert.org /// Array to map Command enum to associated info. 1814022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1824022Sstever@eecs.umich.edu 1834022Sstever@eecs.umich.edu private: 1844022Sstever@eecs.umich.edu 1854022Sstever@eecs.umich.edu Command cmd; 1864022Sstever@eecs.umich.edu 1875735Snate@binkert.org bool 1885735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1895735Snate@binkert.org { 1904022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1914022Sstever@eecs.umich.edu } 1924022Sstever@eecs.umich.edu 1934022Sstever@eecs.umich.edu public: 1944022Sstever@eecs.umich.edu 19510583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 19610583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 19710583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19810583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 19910583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 20011284Sandreas.hansson@arm.com bool needsWritable() const { return testCmdAttrib(NeedsWritable); } 20110583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 20210583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 20311199Sandreas.hansson@arm.com bool isEviction() const { return testCmdAttrib(IsEviction); } 20412347Snikos.nikoleris@arm.com bool isClean() const { return testCmdAttrib(IsClean); } 20511600Sandreas.hansson@arm.com bool fromCache() const { return testCmdAttrib(FromCache); } 20611199Sandreas.hansson@arm.com 20711199Sandreas.hansson@arm.com /** 20811199Sandreas.hansson@arm.com * A writeback is an eviction that carries data. 20911199Sandreas.hansson@arm.com */ 21011199Sandreas.hansson@arm.com bool isWriteback() const { return testCmdAttrib(IsEviction) && 21111199Sandreas.hansson@arm.com testCmdAttrib(HasData); } 21210570Sandreas.hansson@arm.com 21310570Sandreas.hansson@arm.com /** 21410570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 21510570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 21610570Sandreas.hansson@arm.com * valid or not. 21710570Sandreas.hansson@arm.com */ 2184022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2196102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 22010343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 22110343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 22210343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 22310343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2244870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2255314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2268184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2274022Sstever@eecs.umich.edu 22811294Sandreas.hansson@arm.com Command 2295735Snate@binkert.org responseCommand() const 2305735Snate@binkert.org { 2314022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2324022Sstever@eecs.umich.edu } 2334022Sstever@eecs.umich.edu 2345735Snate@binkert.org /// Return the string to a cmd given by idx. 2355735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2364022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2374022Sstever@eecs.umich.edu 2385735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2395735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2405735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2414022Sstever@eecs.umich.edu 2425735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2435735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2444022Sstever@eecs.umich.edu}; 2454022Sstever@eecs.umich.edu 2462381SN/A/** 2472662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2482662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2492662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2502662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2512662Sstever@eecs.umich.edu * different Packets along the way.) 2522381SN/A */ 2539044SAli.Saidi@ARM.comclass Packet : public Printable 2542381SN/A{ 2552813Srdreslin@umich.edu public: 2565735Snate@binkert.org typedef uint32_t FlagsType; 2575735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2584022Sstever@eecs.umich.edu 2595735Snate@binkert.org private: 2605735Snate@binkert.org 26110938Sandreas.hansson@arm.com enum : FlagsType { 26210938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 26312349Snikos.nikoleris@arm.com COPY_FLAGS = 0x0000003F, 26410938Sandreas.hansson@arm.com 26511284Sandreas.hansson@arm.com // Does this packet have sharers (which means it should not be 26611284Sandreas.hansson@arm.com // considered writable) or not. See setHasSharers below. 26711284Sandreas.hansson@arm.com HAS_SHARERS = 0x00000001, 26811284Sandreas.hansson@arm.com 26910938Sandreas.hansson@arm.com // Special control flags 27010938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 27110938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 27211284Sandreas.hansson@arm.com 27311284Sandreas.hansson@arm.com /// Allow a responding cache to inform the cache hierarchy 27411284Sandreas.hansson@arm.com /// that it had a writable copy before responding. See 27511284Sandreas.hansson@arm.com /// setResponderHadWritable below. 27611284Sandreas.hansson@arm.com RESPONDER_HAD_WRITABLE = 0x00000004, 27711284Sandreas.hansson@arm.com 27811284Sandreas.hansson@arm.com // Snoop co-ordination flag to indicate that a cache is 27911284Sandreas.hansson@arm.com // responding to a snoop. See setCacheResponding below. 28011284Sandreas.hansson@arm.com CACHE_RESPONDING = 0x00000008, 28110938Sandreas.hansson@arm.com 28212346Snikos.nikoleris@arm.com // The writeback/writeclean should be propagated further 28312346Snikos.nikoleris@arm.com // downstream by the receiver 28412346Snikos.nikoleris@arm.com WRITE_THROUGH = 0x00000010, 28512346Snikos.nikoleris@arm.com 28612349Snikos.nikoleris@arm.com // Response co-ordination flag for cache maintenance 28712349Snikos.nikoleris@arm.com // operations 28812349Snikos.nikoleris@arm.com SATISFIED = 0x00000020, 28912349Snikos.nikoleris@arm.com 29011057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 29111057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 29211057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 29311057Sandreas.hansson@arm.com 29410938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 29510938Sandreas.hansson@arm.com /// when the packet is destroyed? 29610938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 29710938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 29810938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 29910938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 30010938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 30110938Sandreas.hansson@arm.com 30210938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 30310938Sandreas.hansson@arm.com /// access failure. 30410938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 30510938Sandreas.hansson@arm.com 30610938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 30710938Sandreas.hansson@arm.com // through express snoop flag 30810938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 30910938Sandreas.hansson@arm.com }; 3105735Snate@binkert.org 3115735Snate@binkert.org Flags flags; 3125735Snate@binkert.org 3135735Snate@binkert.org public: 3144022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 3154022Sstever@eecs.umich.edu 3165735Snate@binkert.org /// The command field of the packet. 3174870Sstever@eecs.umich.edu MemCmd cmd; 3184870Sstever@eecs.umich.edu 3195735Snate@binkert.org /// A pointer to the original request. 32010569Sandreas.hansson@arm.com const RequestPtr req; 3214870Sstever@eecs.umich.edu 3222566SN/A private: 3235735Snate@binkert.org /** 3245735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 3255735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 3265735Snate@binkert.org * packet, not request. This may or may not be populated when a 3275735Snate@binkert.org * responder recieves the packet. If not populated it memory should 3285735Snate@binkert.org * be allocated. 3292566SN/A */ 3302566SN/A PacketDataPtr data; 3312566SN/A 3325735Snate@binkert.org /// The address of the request. This address could be virtual or 3335735Snate@binkert.org /// physical, depending on the system configuration. 3342381SN/A Addr addr; 3352381SN/A 33610028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 33710028SGiacomo.Gabrielli@arm.com bool _isSecure; 33810028SGiacomo.Gabrielli@arm.com 3395735Snate@binkert.org /// The size of the request or transfer. 3406227Snate@binkert.org unsigned size; 3412381SN/A 3425735Snate@binkert.org /** 34310723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3448668Sgeoffrey.blake@arm.com */ 34510723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3468668Sgeoffrey.blake@arm.com 3472641Sstever@eecs.umich.edu public: 3482811Srdreslin@umich.edu 3499547Sandreas.hansson@arm.com /** 35010694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 35110405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 35210405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 35310405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 35410405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3559547Sandreas.hansson@arm.com */ 35610694SMarco.Balboni@ARM.com uint32_t headerDelay; 3573218Sgblack@eecs.umich.edu 3589547Sandreas.hansson@arm.com /** 35911127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 36011127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 36111127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 36211127Sandreas.hansson@arm.com * delay. 36311127Sandreas.hansson@arm.com */ 36411127Sandreas.hansson@arm.com uint32_t snoopDelay; 36511127Sandreas.hansson@arm.com 36611127Sandreas.hansson@arm.com /** 36710694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 36810694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 36910694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 37010694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 37110405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 37210405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3739547Sandreas.hansson@arm.com */ 37410694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3753218Sgblack@eecs.umich.edu 3765735Snate@binkert.org /** 3775735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3789542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3799542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3809542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3819542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3829542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3839542Sandreas.hansson@arm.com * particular sending device. 3849542Sandreas.hansson@arm.com * 3859542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3869542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3879542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3889542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3899542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3909542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3919542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3925735Snate@binkert.org */ 3935735Snate@binkert.org struct SenderState 3945735Snate@binkert.org { 3959542Sandreas.hansson@arm.com SenderState* predecessor; 3969542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3972641Sstever@eecs.umich.edu virtual ~SenderState() {} 3982641Sstever@eecs.umich.edu }; 3992641Sstever@eecs.umich.edu 4005315Sstever@gmail.com /** 4015315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 4025315Sstever@gmail.com * field of a PrintReq should always be of this type. 4035315Sstever@gmail.com */ 4049044SAli.Saidi@ARM.com class PrintReqState : public SenderState 4055735Snate@binkert.org { 4065735Snate@binkert.org private: 4075735Snate@binkert.org /** 4085735Snate@binkert.org * An entry in the label stack. 4095735Snate@binkert.org */ 4105735Snate@binkert.org struct LabelStackEntry 4115735Snate@binkert.org { 4125314Sstever@gmail.com const std::string label; 4135314Sstever@gmail.com std::string *prefix; 4145314Sstever@gmail.com bool labelPrinted; 4155735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 4165314Sstever@gmail.com }; 4175314Sstever@gmail.com 4185314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 4195314Sstever@gmail.com LabelStack labelStack; 4205314Sstever@gmail.com 4215314Sstever@gmail.com std::string *curPrefixPtr; 4225314Sstever@gmail.com 4235314Sstever@gmail.com public: 4245314Sstever@gmail.com std::ostream &os; 4255314Sstever@gmail.com const int verbosity; 4265314Sstever@gmail.com 4275314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4285314Sstever@gmail.com ~PrintReqState(); 4295314Sstever@gmail.com 4305735Snate@binkert.org /** 4315735Snate@binkert.org * Returns the current line prefix. 4325735Snate@binkert.org */ 4335314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4345315Sstever@gmail.com 4355735Snate@binkert.org /** 4365735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4375315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4385735Snate@binkert.org * printed if an object within the label's scope is printed. 4395735Snate@binkert.org */ 4405314Sstever@gmail.com void pushLabel(const std::string &lbl, 4415314Sstever@gmail.com const std::string &prefix = " "); 4425735Snate@binkert.org 4435735Snate@binkert.org /** 4445735Snate@binkert.org * Pop a label off the label stack. 4455735Snate@binkert.org */ 4465314Sstever@gmail.com void popLabel(); 4475735Snate@binkert.org 4485735Snate@binkert.org /** 4495735Snate@binkert.org * Print all of the pending unprinted labels on the 4505315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4515735Snate@binkert.org * users unless bypassing printObj(). 4525735Snate@binkert.org */ 4535314Sstever@gmail.com void printLabels(); 4545735Snate@binkert.org 4555735Snate@binkert.org /** 4565735Snate@binkert.org * Print a Printable object to os, because it matched the 4575735Snate@binkert.org * address on a PrintReq. 4585735Snate@binkert.org */ 4595314Sstever@gmail.com void printObj(Printable *obj); 4605314Sstever@gmail.com }; 4615314Sstever@gmail.com 4625735Snate@binkert.org /** 4635735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4645735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4655735Snate@binkert.org * this variable is to allow a device to attach extra information 4669542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4675735Snate@binkert.org * that was attached to the original request (even if a new packet 4685735Snate@binkert.org * is created). 4695735Snate@binkert.org */ 4702662Sstever@eecs.umich.edu SenderState *senderState; 4712641Sstever@eecs.umich.edu 4729542Sandreas.hansson@arm.com /** 4739542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4749542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4759542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4769542Sandreas.hansson@arm.com * variable. 4779542Sandreas.hansson@arm.com * 4789542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4799542Sandreas.hansson@arm.com */ 4809542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4819542Sandreas.hansson@arm.com 4829542Sandreas.hansson@arm.com /** 4839542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4849542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4859542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4869542Sandreas.hansson@arm.com * variable. 4879542Sandreas.hansson@arm.com * 4889542Sandreas.hansson@arm.com * @return The current top of the stack 4899542Sandreas.hansson@arm.com */ 4909542Sandreas.hansson@arm.com SenderState *popSenderState(); 4919542Sandreas.hansson@arm.com 4929543Ssascha.bischoff@arm.com /** 4939543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4949543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4959543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4969543Ssascha.bischoff@arm.com * 4979543Ssascha.bischoff@arm.com * @return The topmost state of type T 4989543Ssascha.bischoff@arm.com */ 4999543Ssascha.bischoff@arm.com template <typename T> 5009543Ssascha.bischoff@arm.com T * findNextSenderState() const 5019543Ssascha.bischoff@arm.com { 5029543Ssascha.bischoff@arm.com T *t = NULL; 5039543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 5049543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 5059543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 5069543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 5079543Ssascha.bischoff@arm.com } 5089543Ssascha.bischoff@arm.com return t; 5099543Ssascha.bischoff@arm.com } 5109543Ssascha.bischoff@arm.com 5115735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 5125735Snate@binkert.org /// tracing). 5134022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 5142811Srdreslin@umich.edu 5155735Snate@binkert.org /// Return the index of this command. 5164022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 5172811Srdreslin@umich.edu 51810583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 51910583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 52010583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 52110583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 52210583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 52311287Sandreas.hansson@arm.com bool needsWritable() const 52411287Sandreas.hansson@arm.com { 52511287Sandreas.hansson@arm.com // we should never check if a response needsWritable, the 52611287Sandreas.hansson@arm.com // request has this flag, and for a response we should rather 52711287Sandreas.hansson@arm.com // look at the hasSharers flag (if not set, the response is to 52811287Sandreas.hansson@arm.com // be considered writable) 52911287Sandreas.hansson@arm.com assert(isRequest()); 53011287Sandreas.hansson@arm.com return cmd.needsWritable(); 53111287Sandreas.hansson@arm.com } 53210583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 53310583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 53411199Sandreas.hansson@arm.com bool isEviction() const { return cmd.isEviction(); } 53512347Snikos.nikoleris@arm.com bool isClean() const { return cmd.isClean(); } 53611600Sandreas.hansson@arm.com bool fromCache() const { return cmd.fromCache(); } 53711199Sandreas.hansson@arm.com bool isWriteback() const { return cmd.isWriteback(); } 53810583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 53911286Sandreas.hansson@arm.com bool hasRespData() const 54011286Sandreas.hansson@arm.com { 54111286Sandreas.hansson@arm.com MemCmd resp_cmd = cmd.responseCommand(); 54211286Sandreas.hansson@arm.com return resp_cmd.hasData(); 54311286Sandreas.hansson@arm.com } 54410583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 54510583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 54610583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 54710583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 5482812Srdreslin@umich.edu 54911284Sandreas.hansson@arm.com //@{ 55011284Sandreas.hansson@arm.com /// Snoop flags 55111284Sandreas.hansson@arm.com /** 55211284Sandreas.hansson@arm.com * Set the cacheResponding flag. This is used by the caches to 55311284Sandreas.hansson@arm.com * signal another cache that they are responding to a request. A 55411284Sandreas.hansson@arm.com * cache will only respond to snoops if it has the line in either 55511284Sandreas.hansson@arm.com * Modified or Owned state. Note that on snoop hits we always pass 55611284Sandreas.hansson@arm.com * the line as Modified and never Owned. In the case of an Owned 55711284Sandreas.hansson@arm.com * line we proceed to invalidate all other copies. 55811284Sandreas.hansson@arm.com * 55911284Sandreas.hansson@arm.com * On a cache fill (see Cache::handleFill), we check hasSharers 56011284Sandreas.hansson@arm.com * first, ignoring the cacheResponding flag if hasSharers is set. 56111284Sandreas.hansson@arm.com * A line is consequently allocated as: 56211284Sandreas.hansson@arm.com * 56311284Sandreas.hansson@arm.com * hasSharers cacheResponding state 56411284Sandreas.hansson@arm.com * true false Shared 56511284Sandreas.hansson@arm.com * true true Shared 56611284Sandreas.hansson@arm.com * false false Exclusive 56711284Sandreas.hansson@arm.com * false true Modified 56811284Sandreas.hansson@arm.com */ 56911284Sandreas.hansson@arm.com void setCacheResponding() 57010567Sandreas.hansson@arm.com { 57110567Sandreas.hansson@arm.com assert(isRequest()); 57211284Sandreas.hansson@arm.com assert(!flags.isSet(CACHE_RESPONDING)); 57311284Sandreas.hansson@arm.com flags.set(CACHE_RESPONDING); 57410567Sandreas.hansson@arm.com } 57511284Sandreas.hansson@arm.com bool cacheResponding() const { return flags.isSet(CACHE_RESPONDING); } 57611284Sandreas.hansson@arm.com /** 57711284Sandreas.hansson@arm.com * On fills, the hasSharers flag is used by the caches in 57811284Sandreas.hansson@arm.com * combination with the cacheResponding flag, as clarified 57911284Sandreas.hansson@arm.com * above. If the hasSharers flag is not set, the packet is passing 58011284Sandreas.hansson@arm.com * writable. Thus, a response from a memory passes the line as 58111284Sandreas.hansson@arm.com * writable by default. 58211284Sandreas.hansson@arm.com * 58311284Sandreas.hansson@arm.com * The hasSharers flag is also used by upstream caches to inform a 58411284Sandreas.hansson@arm.com * downstream cache that they have the block (by calling 58511284Sandreas.hansson@arm.com * setHasSharers on snoop request packets that hit in upstream 58611284Sandreas.hansson@arm.com * cachs tags or MSHRs). If the snoop packet has sharers, a 58711284Sandreas.hansson@arm.com * downstream cache is prevented from passing a dirty line upwards 58811284Sandreas.hansson@arm.com * if it was not explicitly asked for a writable copy. See 58911284Sandreas.hansson@arm.com * Cache::satisfyCpuSideRequest. 59011284Sandreas.hansson@arm.com * 59111284Sandreas.hansson@arm.com * The hasSharers flag is also used on writebacks, in 59211284Sandreas.hansson@arm.com * combination with the WritbackClean or WritebackDirty commands, 59311284Sandreas.hansson@arm.com * to allocate the block downstream either as: 59411284Sandreas.hansson@arm.com * 59511284Sandreas.hansson@arm.com * command hasSharers state 59611284Sandreas.hansson@arm.com * WritebackDirty false Modified 59711284Sandreas.hansson@arm.com * WritebackDirty true Owned 59811284Sandreas.hansson@arm.com * WritebackClean false Exclusive 59911284Sandreas.hansson@arm.com * WritebackClean true Shared 60011284Sandreas.hansson@arm.com */ 60111284Sandreas.hansson@arm.com void setHasSharers() { flags.set(HAS_SHARERS); } 60211284Sandreas.hansson@arm.com bool hasSharers() const { return flags.isSet(HAS_SHARERS); } 60311284Sandreas.hansson@arm.com //@} 6044870Sstever@eecs.umich.edu 60511284Sandreas.hansson@arm.com /** 60611284Sandreas.hansson@arm.com * The express snoop flag is used for two purposes. Firstly, it is 60711284Sandreas.hansson@arm.com * used to bypass flow control for normal (non-snoop) requests 60811284Sandreas.hansson@arm.com * going downstream in the memory system. In cases where a cache 60911284Sandreas.hansson@arm.com * is responding to a snoop from another cache (it had a dirty 61011284Sandreas.hansson@arm.com * line), but the line is not writable (and there are possibly 61111284Sandreas.hansson@arm.com * other copies), the express snoop flag is set by the downstream 61211284Sandreas.hansson@arm.com * cache to invalidate all other copies in zero time. Secondly, 61311284Sandreas.hansson@arm.com * the express snoop flag is also set to be able to distinguish 61411284Sandreas.hansson@arm.com * snoop packets that came from a downstream cache, rather than 61511284Sandreas.hansson@arm.com * snoop packets from neighbouring caches. 61611284Sandreas.hansson@arm.com */ 61711284Sandreas.hansson@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 61811284Sandreas.hansson@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 61911284Sandreas.hansson@arm.com 62011284Sandreas.hansson@arm.com /** 62111284Sandreas.hansson@arm.com * On responding to a snoop request (which only happens for 62211284Sandreas.hansson@arm.com * Modified or Owned lines), make sure that we can transform an 62311284Sandreas.hansson@arm.com * Owned response to a Modified one. If this flag is not set, the 62411284Sandreas.hansson@arm.com * responding cache had the line in the Owned state, and there are 62511284Sandreas.hansson@arm.com * possibly other Shared copies in the memory system. A downstream 62611284Sandreas.hansson@arm.com * cache helps in orchestrating the invalidation of these copies 62711284Sandreas.hansson@arm.com * by sending out the appropriate express snoops. 62811284Sandreas.hansson@arm.com */ 62911284Sandreas.hansson@arm.com void setResponderHadWritable() 63011284Sandreas.hansson@arm.com { 63111284Sandreas.hansson@arm.com assert(cacheResponding()); 63211746Snikos.nikoleris@arm.com assert(!responderHadWritable()); 63311284Sandreas.hansson@arm.com flags.set(RESPONDER_HAD_WRITABLE); 63411284Sandreas.hansson@arm.com } 63511284Sandreas.hansson@arm.com bool responderHadWritable() const 63611284Sandreas.hansson@arm.com { return flags.isSet(RESPONDER_HAD_WRITABLE); } 63711284Sandreas.hansson@arm.com 63812346Snikos.nikoleris@arm.com /** 63912346Snikos.nikoleris@arm.com * A writeback/writeclean cmd gets propagated further downstream 64012346Snikos.nikoleris@arm.com * by the receiver when the flag is set. 64112346Snikos.nikoleris@arm.com */ 64212346Snikos.nikoleris@arm.com void setWriteThrough() 64312346Snikos.nikoleris@arm.com { 64412346Snikos.nikoleris@arm.com assert(cmd.isWrite() && 64512346Snikos.nikoleris@arm.com (cmd.isEviction() || cmd == MemCmd::WriteClean)); 64612346Snikos.nikoleris@arm.com flags.set(WRITE_THROUGH); 64712346Snikos.nikoleris@arm.com } 64812346Snikos.nikoleris@arm.com void clearWriteThrough() { flags.clear(WRITE_THROUGH); } 64912346Snikos.nikoleris@arm.com bool writeThrough() const { return flags.isSet(WRITE_THROUGH); } 65012346Snikos.nikoleris@arm.com 65112349Snikos.nikoleris@arm.com /** 65212349Snikos.nikoleris@arm.com * Set when a request hits in a cache and the cache is not going 65312349Snikos.nikoleris@arm.com * to respond. This is used by the crossbar to coordinate 65412349Snikos.nikoleris@arm.com * responses for cache maintenance operations. 65512349Snikos.nikoleris@arm.com */ 65612349Snikos.nikoleris@arm.com void setSatisfied() 65712349Snikos.nikoleris@arm.com { 65812349Snikos.nikoleris@arm.com assert(cmd.isClean()); 65912349Snikos.nikoleris@arm.com assert(!flags.isSet(SATISFIED)); 66012349Snikos.nikoleris@arm.com flags.set(SATISFIED); 66112349Snikos.nikoleris@arm.com } 66212349Snikos.nikoleris@arm.com bool satisfied() const { return flags.isSet(SATISFIED); } 66312349Snikos.nikoleris@arm.com 6649951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 6659951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 66610763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 66710763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 66810883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 6694895Sstever@eecs.umich.edu 6704870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 6714870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 6724870Sstever@eecs.umich.edu // field, etc.) 6735735Snate@binkert.org void 6745735Snate@binkert.org setBadAddress() 6755735Snate@binkert.org { 6765735Snate@binkert.org assert(isResponse()); 6775735Snate@binkert.org cmd = MemCmd::BadAddressError; 6785735Snate@binkert.org } 6795735Snate@binkert.org 6804986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 6812814Srdreslin@umich.edu 68211057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 6839259SAli.Saidi@ARM.com /** 6849259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 6859259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 6869259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 6879259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 6889259SAli.Saidi@ARM.com * valid. 6899259SAli.Saidi@ARM.com */ 69011057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 6919259SAli.Saidi@ARM.com 69211057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 69310938Sandreas.hansson@arm.com 69410938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 69510938Sandreas.hansson@arm.com { 69610938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 69710938Sandreas.hansson@arm.com } 69810938Sandreas.hansson@arm.com 69910938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 70010938Sandreas.hansson@arm.com { 70110938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 70210938Sandreas.hansson@arm.com } 7032549SN/A 70411057Sandreas.hansson@arm.com bool isSecure() const 70511057Sandreas.hansson@arm.com { 70611057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 70711057Sandreas.hansson@arm.com return _isSecure; 70811057Sandreas.hansson@arm.com } 70910028SGiacomo.Gabrielli@arm.com 7105735Snate@binkert.org /** 71111306Santhony.gutierrez@amd.com * Accessor function to atomic op. 71211306Santhony.gutierrez@amd.com */ 71311306Santhony.gutierrez@amd.com AtomicOpFunctor *getAtomicOp() const { return req->getAtomicOpFunctor(); } 71411306Santhony.gutierrez@amd.com bool isAtomicOp() const { return req->isAtomic(); } 71511306Santhony.gutierrez@amd.com 71611306Santhony.gutierrez@amd.com /** 7177550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 71810938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 7197550SBrad.Beckmann@amd.com */ 7207550SBrad.Beckmann@amd.com void 7217550SBrad.Beckmann@amd.com convertScToWrite() 7227550SBrad.Beckmann@amd.com { 7237550SBrad.Beckmann@amd.com assert(isLLSC()); 7247550SBrad.Beckmann@amd.com assert(isWrite()); 7257550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 7267550SBrad.Beckmann@amd.com } 7277550SBrad.Beckmann@amd.com 7287550SBrad.Beckmann@amd.com /** 72910938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 73010938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 7317550SBrad.Beckmann@amd.com */ 7327550SBrad.Beckmann@amd.com void 7337550SBrad.Beckmann@amd.com convertLlToRead() 7347550SBrad.Beckmann@amd.com { 7357550SBrad.Beckmann@amd.com assert(isLLSC()); 7367550SBrad.Beckmann@amd.com assert(isRead()); 7377550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 7387550SBrad.Beckmann@amd.com } 7397550SBrad.Beckmann@amd.com 7407550SBrad.Beckmann@amd.com /** 74110938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 74211057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 74311057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 7445735Snate@binkert.org */ 74510569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 74611057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 74711127Sandreas.hansson@arm.com size(0), headerDelay(0), snoopDelay(0), payloadDelay(0), 74811057Sandreas.hansson@arm.com senderState(NULL) 74911057Sandreas.hansson@arm.com { 75011057Sandreas.hansson@arm.com if (req->hasPaddr()) { 75111057Sandreas.hansson@arm.com addr = req->getPaddr(); 75211057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 75311057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 75411057Sandreas.hansson@arm.com } 75511057Sandreas.hansson@arm.com if (req->hasSize()) { 75611057Sandreas.hansson@arm.com size = req->getSize(); 75711057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 75811057Sandreas.hansson@arm.com } 75911057Sandreas.hansson@arm.com } 76011057Sandreas.hansson@arm.com 76111057Sandreas.hansson@arm.com /** 76211057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 76311057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 76411057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 76511057Sandreas.hansson@arm.com */ 76611057Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 76711057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 76811127Sandreas.hansson@arm.com headerDelay(0), snoopDelay(0), payloadDelay(0), 7699546Sandreas.hansson@arm.com senderState(NULL) 77011057Sandreas.hansson@arm.com { 77111057Sandreas.hansson@arm.com if (req->hasPaddr()) { 77211057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 77311057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 77411057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 77511057Sandreas.hansson@arm.com } 77611057Sandreas.hansson@arm.com size = _blkSize; 77711057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 77811057Sandreas.hansson@arm.com } 7794626Sstever@eecs.umich.edu 7805735Snate@binkert.org /** 7815735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 7824887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 7834887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 7844887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 7855735Snate@binkert.org * packet should allocate its own data. 7865735Snate@binkert.org */ 78710896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 7885735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 78910571Sandreas.hansson@arm.com data(nullptr), 79010028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 79110723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 79210694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 79311127Sandreas.hansson@arm.com snoopDelay(0), 79410694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 7959546Sandreas.hansson@arm.com senderState(pkt->senderState) 7964626Sstever@eecs.umich.edu { 79710571Sandreas.hansson@arm.com if (!clear_flags) 7985735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 7995735Snate@binkert.org 80011057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 80111057Sandreas.hansson@arm.com 80210571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 80310571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 80410571Sandreas.hansson@arm.com // co-ordinate state changes 80510571Sandreas.hansson@arm.com if (alloc_data) { 80610571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 80710571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 80810571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 80910571Sandreas.hansson@arm.com // carry the pointer forward 81010571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 81110571Sandreas.hansson@arm.com data = pkt->data; 81210571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 81310571Sandreas.hansson@arm.com } else { 81410571Sandreas.hansson@arm.com allocate(); 81510571Sandreas.hansson@arm.com } 81610571Sandreas.hansson@arm.com } 81710342SCurtis.Dunham@arm.com } 8188668Sgeoffrey.blake@arm.com 81910342SCurtis.Dunham@arm.com /** 82010739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 82110342SCurtis.Dunham@arm.com */ 82210739Ssteve.reinhardt@amd.com static MemCmd 82310739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 82410342SCurtis.Dunham@arm.com { 82510739Ssteve.reinhardt@amd.com if (req->isLLSC()) 82610739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 82710739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 82810739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 82910739Ssteve.reinhardt@amd.com else 83010739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 83110739Ssteve.reinhardt@amd.com } 83210739Ssteve.reinhardt@amd.com 83310739Ssteve.reinhardt@amd.com /** 83410739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 83510739Ssteve.reinhardt@amd.com */ 83610739Ssteve.reinhardt@amd.com static MemCmd 83710739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 83810739Ssteve.reinhardt@amd.com { 83910739Ssteve.reinhardt@amd.com if (req->isLLSC()) 84010739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 84110739Ssteve.reinhardt@amd.com else if (req->isSwap()) 84210739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 84312347Snikos.nikoleris@arm.com else if (req->isCacheInvalidate()) { 84412347Snikos.nikoleris@arm.com return req->isCacheClean() ? MemCmd::CleanInvalidReq : 84512347Snikos.nikoleris@arm.com MemCmd::InvalidateReq; 84612347Snikos.nikoleris@arm.com } else if (req->isCacheClean()) { 84712347Snikos.nikoleris@arm.com return MemCmd::CleanSharedReq; 84812347Snikos.nikoleris@arm.com } else 84910739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 85010342SCurtis.Dunham@arm.com } 85110342SCurtis.Dunham@arm.com 85210342SCurtis.Dunham@arm.com /** 85310342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 85410739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 85510342SCurtis.Dunham@arm.com */ 85610342SCurtis.Dunham@arm.com static PacketPtr 85710569Sandreas.hansson@arm.com createRead(const RequestPtr req) 85810342SCurtis.Dunham@arm.com { 85910739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 86010342SCurtis.Dunham@arm.com } 86110342SCurtis.Dunham@arm.com 86210342SCurtis.Dunham@arm.com static PacketPtr 86310569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 86410342SCurtis.Dunham@arm.com { 86510739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 8662641Sstever@eecs.umich.edu } 8672549SN/A 8685735Snate@binkert.org /** 8695735Snate@binkert.org * clean up packet variables 8705735Snate@binkert.org */ 8712566SN/A ~Packet() 8725387Sstever@gmail.com { 87310872Sali.jafri@arm.com // Delete the request object if this is a request packet which 87410872Sali.jafri@arm.com // does not need a response, because the requester will not get 87510872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 87610872Sali.jafri@arm.com // request will be deleted on receipt of the response 87710872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 87810872Sali.jafri@arm.com // express snoops, even for cases when responses are not 87910872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 88010872Sali.jafri@arm.com // re-uses the same request. 88110872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 88210872Sali.jafri@arm.com !isExpressSnoop()) { 8835387Sstever@gmail.com delete req; 88410872Sali.jafri@arm.com } 8855735Snate@binkert.org deleteData(); 8865387Sstever@gmail.com } 8872566SN/A 8885735Snate@binkert.org /** 8894626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 89010660Sandreas.hansson@arm.com * returning as a response to that request. 8914626Sstever@eecs.umich.edu */ 8925735Snate@binkert.org void 8935735Snate@binkert.org makeResponse() 8944626Sstever@eecs.umich.edu { 8952662Sstever@eecs.umich.edu assert(needsResponse()); 8962855Srdreslin@umich.edu assert(isRequest()); 8974022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 8985745Snate@binkert.org 8997464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 9007464Ssteve.reinhardt@amd.com // triggered them was 9017464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 9022641Sstever@eecs.umich.edu } 9032641Sstever@eecs.umich.edu 9045735Snate@binkert.org void 9055735Snate@binkert.org makeAtomicResponse() 9064870Sstever@eecs.umich.edu { 9074870Sstever@eecs.umich.edu makeResponse(); 9084870Sstever@eecs.umich.edu } 9094870Sstever@eecs.umich.edu 9105735Snate@binkert.org void 9115735Snate@binkert.org makeTimingResponse() 9123348Sbinkertn@umich.edu { 9134870Sstever@eecs.umich.edu makeResponse(); 9143135Srdreslin@umich.edu } 9153135Srdreslin@umich.edu 9168436SBrad.Beckmann@amd.com void 9178436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 9188436SBrad.Beckmann@amd.com { 9198436SBrad.Beckmann@amd.com if (!success) { 9208436SBrad.Beckmann@amd.com if (isWrite()) { 9218436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 9228436SBrad.Beckmann@amd.com } else { 9238436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 9248436SBrad.Beckmann@amd.com } 9258436SBrad.Beckmann@amd.com } 9268436SBrad.Beckmann@amd.com } 9278436SBrad.Beckmann@amd.com 92811057Sandreas.hansson@arm.com void 92911057Sandreas.hansson@arm.com setSize(unsigned size) 93011057Sandreas.hansson@arm.com { 93111057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 93211057Sandreas.hansson@arm.com 93311057Sandreas.hansson@arm.com this->size = size; 93411057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 93511057Sandreas.hansson@arm.com } 93611057Sandreas.hansson@arm.com 93711057Sandreas.hansson@arm.com 93811013Sandreas.sandberg@arm.com public: 93911013Sandreas.sandberg@arm.com /** 94011013Sandreas.sandberg@arm.com * @{ 94111013Sandreas.sandberg@arm.com * @name Data accessor mehtods 94211013Sandreas.sandberg@arm.com */ 94311013Sandreas.sandberg@arm.com 9443348Sbinkertn@umich.edu /** 9453348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 94610571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 94710571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 94810571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 94910571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 95010571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 95110571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 95210571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 95310571Sandreas.hansson@arm.com * to the source, no copies are necessary. 9542566SN/A */ 9552566SN/A template <typename T> 9563348Sbinkertn@umich.edu void 9573348Sbinkertn@umich.edu dataStatic(T *p) 9583348Sbinkertn@umich.edu { 95910566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9603348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9615735Snate@binkert.org flags.set(STATIC_DATA); 9623348Sbinkertn@umich.edu } 9632566SN/A 9643348Sbinkertn@umich.edu /** 96510564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 96610564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 96710564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 96810564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 96910564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 97010564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 97110564Sandreas.hansson@arm.com */ 97210564Sandreas.hansson@arm.com template <typename T> 97310564Sandreas.hansson@arm.com void 97410564Sandreas.hansson@arm.com dataStaticConst(const T *p) 97510564Sandreas.hansson@arm.com { 97610566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 97710564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 97810564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 97910564Sandreas.hansson@arm.com } 98010564Sandreas.hansson@arm.com 98110564Sandreas.hansson@arm.com /** 9823348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 98310571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 98410571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 98510571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 98610571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 98710571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 98810571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 98910571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 99010571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 99110571Sandreas.hansson@arm.com * before it is deallocated. 9923348Sbinkertn@umich.edu */ 9932566SN/A template <typename T> 9943348Sbinkertn@umich.edu void 9953348Sbinkertn@umich.edu dataDynamic(T *p) 9963348Sbinkertn@umich.edu { 99710566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9983348Sbinkertn@umich.edu data = (PacketDataPtr)p; 9995735Snate@binkert.org flags.set(DYNAMIC_DATA); 10003348Sbinkertn@umich.edu } 10013348Sbinkertn@umich.edu 10025735Snate@binkert.org /** 10035735Snate@binkert.org * get a pointer to the data ptr. 10045735Snate@binkert.org */ 10053348Sbinkertn@umich.edu template <typename T> 10063348Sbinkertn@umich.edu T* 100710562Sandreas.hansson@arm.com getPtr() 10083348Sbinkertn@umich.edu { 100910562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 10103348Sbinkertn@umich.edu return (T*)data; 10113348Sbinkertn@umich.edu } 10122566SN/A 101310563Sandreas.hansson@arm.com template <typename T> 101410563Sandreas.hansson@arm.com const T* 101510563Sandreas.hansson@arm.com getConstPtr() const 101610563Sandreas.hansson@arm.com { 101710563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 101810563Sandreas.hansson@arm.com return (const T*)data; 101910563Sandreas.hansson@arm.com } 102010563Sandreas.hansson@arm.com 10215735Snate@binkert.org /** 102211013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 102311013Sandreas.sandberg@arm.com * host endian. 102411013Sandreas.sandberg@arm.com */ 102511013Sandreas.sandberg@arm.com template <typename T> 102611013Sandreas.sandberg@arm.com T getBE() const; 102711013Sandreas.sandberg@arm.com 102811013Sandreas.sandberg@arm.com /** 102911013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 103011013Sandreas.sandberg@arm.com * host endian. 103111013Sandreas.sandberg@arm.com */ 103211013Sandreas.sandberg@arm.com template <typename T> 103311013Sandreas.sandberg@arm.com T getLE() const; 103411013Sandreas.sandberg@arm.com 103511013Sandreas.sandberg@arm.com /** 103611013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 103711013Sandreas.sandberg@arm.com * endianness. 103811013Sandreas.sandberg@arm.com */ 103911013Sandreas.sandberg@arm.com template <typename T> 104011013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 104111013Sandreas.sandberg@arm.com 104211013Sandreas.sandberg@arm.com /** 104311013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 104411013Sandreas.sandberg@arm.com * endian. 10455735Snate@binkert.org */ 10462566SN/A template <typename T> 104710563Sandreas.hansson@arm.com T get() const; 10482566SN/A 104911013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 105011013Sandreas.sandberg@arm.com template <typename T> 105111013Sandreas.sandberg@arm.com void setBE(T v); 105211013Sandreas.sandberg@arm.com 105311013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 105411013Sandreas.sandberg@arm.com template <typename T> 105511013Sandreas.sandberg@arm.com void setLE(T v); 105611013Sandreas.sandberg@arm.com 10575735Snate@binkert.org /** 105811013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 105911013Sandreas.sandberg@arm.com * endianness. 10605735Snate@binkert.org */ 10612566SN/A template <typename T> 106211013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 106311013Sandreas.sandberg@arm.com 106411013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 106511013Sandreas.sandberg@arm.com template <typename T> 10662592SN/A void set(T v); 10672566SN/A 10683348Sbinkertn@umich.edu /** 10694626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 10704626Sstever@eecs.umich.edu */ 10715735Snate@binkert.org void 107210563Sandreas.hansson@arm.com setData(const uint8_t *p) 10734626Sstever@eecs.umich.edu { 107410571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 107510571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 107610571Sandreas.hansson@arm.com // same pointer from source to destination and back 107710571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 107810571Sandreas.hansson@arm.com 10797691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 108010571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 108110571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 10827691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 10834626Sstever@eecs.umich.edu } 10844626Sstever@eecs.umich.edu 10854626Sstever@eecs.umich.edu /** 10864626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 10874626Sstever@eecs.umich.edu * which is aligned to the given block size. 10884626Sstever@eecs.umich.edu */ 10895735Snate@binkert.org void 109010563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 10914626Sstever@eecs.umich.edu { 10924626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 10934626Sstever@eecs.umich.edu } 10944626Sstever@eecs.umich.edu 10954626Sstever@eecs.umich.edu /** 10964626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 10974626Sstever@eecs.umich.edu * is aligned to the given block size. 10984626Sstever@eecs.umich.edu */ 10995735Snate@binkert.org void 110010563Sandreas.hansson@arm.com writeData(uint8_t *p) const 11014626Sstever@eecs.umich.edu { 110210563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 11034626Sstever@eecs.umich.edu } 11044626Sstever@eecs.umich.edu 11054626Sstever@eecs.umich.edu /** 11064626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 11074626Sstever@eecs.umich.edu */ 11085735Snate@binkert.org void 110910563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 11104626Sstever@eecs.umich.edu { 11114626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 11124626Sstever@eecs.umich.edu } 11134626Sstever@eecs.umich.edu 11144626Sstever@eecs.umich.edu /** 11153348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 11163348Sbinkertn@umich.edu * matter how data was allocted. 11173348Sbinkertn@umich.edu */ 11185735Snate@binkert.org void 11195735Snate@binkert.org deleteData() 11205735Snate@binkert.org { 112110566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 11225735Snate@binkert.org delete [] data; 11235735Snate@binkert.org 112410566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 11255735Snate@binkert.org data = NULL; 11265735Snate@binkert.org } 11272566SN/A 112810565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 11295735Snate@binkert.org void 11305735Snate@binkert.org allocate() 11315735Snate@binkert.org { 113211286Sandreas.hansson@arm.com // if either this command or the response command has a data 113311286Sandreas.hansson@arm.com // payload, actually allocate space 113411286Sandreas.hansson@arm.com if (hasData() || hasRespData()) { 113511286Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 113611286Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 113711286Sandreas.hansson@arm.com data = new uint8_t[getSize()]; 113811286Sandreas.hansson@arm.com } 11395735Snate@binkert.org } 11405735Snate@binkert.org 114111013Sandreas.sandberg@arm.com /** @} */ 114211013Sandreas.sandberg@arm.com 114311013Sandreas.sandberg@arm.com private: // Private data accessor methods 114411013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 114511013Sandreas.sandberg@arm.com template <typename T> 114611013Sandreas.sandberg@arm.com T getRaw() const; 114711013Sandreas.sandberg@arm.com 114811013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 114911013Sandreas.sandberg@arm.com template <typename T> 115011013Sandreas.sandberg@arm.com void setRaw(T v); 115111013Sandreas.sandberg@arm.com 115211013Sandreas.sandberg@arm.com public: 11534626Sstever@eecs.umich.edu /** 115410570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 115510570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 115610570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 115710570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 115810570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 115910570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 116010570Sandreas.hansson@arm.com * accordingly. 116110570Sandreas.hansson@arm.com */ 116210570Sandreas.hansson@arm.com bool 116310570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 116410570Sandreas.hansson@arm.com { 116510570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 116610570Sandreas.hansson@arm.com // data pointer 116710570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 116810570Sandreas.hansson@arm.com other->getSize(), 116910570Sandreas.hansson@arm.com other->hasData() ? 117010570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 117110570Sandreas.hansson@arm.com } 117210570Sandreas.hansson@arm.com 117310570Sandreas.hansson@arm.com /** 117410883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 117510883Sali.jafri@arm.com * in the memory hierarchy above. 117610883Sali.jafri@arm.com **/ 117710883Sali.jafri@arm.com bool 117810883Sali.jafri@arm.com mustCheckAbove() const 117910883Sali.jafri@arm.com { 118011199Sandreas.hansson@arm.com return cmd == MemCmd::HardPFReq || isEviction(); 118111199Sandreas.hansson@arm.com } 118211199Sandreas.hansson@arm.com 118311199Sandreas.hansson@arm.com /** 118411199Sandreas.hansson@arm.com * Is this packet a clean eviction, including both actual clean 118511199Sandreas.hansson@arm.com * evict packets, but also clean writebacks. 118611199Sandreas.hansson@arm.com */ 118711199Sandreas.hansson@arm.com bool 118811199Sandreas.hansson@arm.com isCleanEviction() const 118911199Sandreas.hansson@arm.com { 119011199Sandreas.hansson@arm.com return cmd == MemCmd::CleanEvict || cmd == MemCmd::WritebackClean; 119110883Sali.jafri@arm.com } 119210883Sali.jafri@arm.com 119310883Sali.jafri@arm.com /** 11944626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 119510570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 119610570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 119710570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 11984626Sstever@eecs.umich.edu * memory value. 11994626Sstever@eecs.umich.edu */ 12005735Snate@binkert.org bool 120110570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 120210570Sandreas.hansson@arm.com uint8_t *_data); 12035314Sstever@gmail.com 12045315Sstever@gmail.com /** 12055315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 12065315Sstever@gmail.com */ 12075735Snate@binkert.org void 12085735Snate@binkert.org pushLabel(const std::string &lbl) 12095735Snate@binkert.org { 12105735Snate@binkert.org if (isPrint()) 12115735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 12125314Sstever@gmail.com } 12135314Sstever@gmail.com 12145315Sstever@gmail.com /** 12155315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 12165315Sstever@gmail.com */ 12175735Snate@binkert.org void 12185735Snate@binkert.org popLabel() 12195735Snate@binkert.org { 12205735Snate@binkert.org if (isPrint()) 12215735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 12225314Sstever@gmail.com } 12235314Sstever@gmail.com 12245314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 12255314Sstever@gmail.com const std::string &prefix = "") const; 12269663Suri.wiener@arm.com 12279663Suri.wiener@arm.com /** 12289663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 12299663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 12309663Suri.wiener@arm.com * avoiding string overheads in fast mode 12319663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 12329663Suri.wiener@arm.com */ 12339663Suri.wiener@arm.com std::string print() const; 12342381SN/A}; 12352381SN/A 12362381SN/A#endif //__MEM_PACKET_HH 1237