packet.hh revision 10975
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, 894022Sstever@eecs.umich.edu Writeback, 9010883Sali.jafri@arm.com CleanEvict, 914022Sstever@eecs.umich.edu SoftPFReq, 924022Sstever@eecs.umich.edu HardPFReq, 934022Sstever@eecs.umich.edu SoftPFResp, 944022Sstever@eecs.umich.edu HardPFResp, 9510886Sandreas.hansson@arm.com WriteLineReq, 964022Sstever@eecs.umich.edu UpgradeReq, 977465Ssteve.reinhardt@amd.com SCUpgradeReq, // Special "weak" upgrade for StoreCond 984628Sstever@eecs.umich.edu UpgradeResp, 997465Ssteve.reinhardt@amd.com SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1007465Ssteve.reinhardt@amd.com UpgradeFailResp, // Valid for SCUpgradeReq only 1014022Sstever@eecs.umich.edu ReadExReq, 1024022Sstever@eecs.umich.edu ReadExResp, 10310885Sandreas.hansson@arm.com ReadCleanReq, 10410885Sandreas.hansson@arm.com ReadSharedReq, 1054626Sstever@eecs.umich.edu LoadLockedReq, 1064626Sstever@eecs.umich.edu StoreCondReq, 1077669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1084626Sstever@eecs.umich.edu StoreCondResp, 1094040Ssaidi@eecs.umich.edu SwapReq, 1104040Ssaidi@eecs.umich.edu SwapResp, 1115650Sgblack@eecs.umich.edu MessageReq, 1125650Sgblack@eecs.umich.edu MessageResp, 11310975Sdavid.hashe@amd.com ReleaseReq, 11410975Sdavid.hashe@amd.com ReleaseResp, 11510975Sdavid.hashe@amd.com AcquireReq, 11610975Sdavid.hashe@amd.com AcquireResp, 1174870Sstever@eecs.umich.edu // Error responses 1184870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1194870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1204870Sstever@eecs.umich.edu // compatibility 1214870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1224870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1238436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1248436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1255314Sstever@gmail.com // Fake simulator-only commands 1265314Sstever@gmail.com PrintReq, // Print state matching address 1278184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 12810886Sandreas.hansson@arm.com InvalidateReq, // request for address to be invalidated 12910886Sandreas.hansson@arm.com InvalidateResp, 1304022Sstever@eecs.umich.edu NUM_MEM_CMDS 1314022Sstever@eecs.umich.edu }; 1324022Sstever@eecs.umich.edu 1334022Sstever@eecs.umich.edu private: 1345735Snate@binkert.org /** 1355735Snate@binkert.org * List of command attributes. 1365735Snate@binkert.org */ 1374022Sstever@eecs.umich.edu enum Attribute 1384022Sstever@eecs.umich.edu { 1394626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1404626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1417465Ssteve.reinhardt@amd.com IsUpgrade, 1424022Sstever@eecs.umich.edu IsInvalidate, 1434626Sstever@eecs.umich.edu NeedsExclusive, //!< Requires exclusive copy to complete in-cache 1444626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1454626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1464626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 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 15410975Sdavid.hashe@amd.com IsAcquire, //!< Acquire operation 15510975Sdavid.hashe@amd.com IsRelease, //!< Release operation 1564022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1574022Sstever@eecs.umich.edu }; 1584022Sstever@eecs.umich.edu 1595735Snate@binkert.org /** 1605735Snate@binkert.org * Structure that defines attributes and other data associated 1615735Snate@binkert.org * with a Command. 1625735Snate@binkert.org */ 1635735Snate@binkert.org struct CommandInfo 1645735Snate@binkert.org { 1655735Snate@binkert.org /// Set of attribute flags. 1664022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1675735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1685735Snate@binkert.org /// response is applicable. 1694022Sstever@eecs.umich.edu const Command response; 1705735Snate@binkert.org /// String representation (for printing) 1714022Sstever@eecs.umich.edu const std::string str; 1724022Sstever@eecs.umich.edu }; 1734022Sstever@eecs.umich.edu 1745735Snate@binkert.org /// Array to map Command enum to associated info. 1754022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1764022Sstever@eecs.umich.edu 1774022Sstever@eecs.umich.edu private: 1784022Sstever@eecs.umich.edu 1794022Sstever@eecs.umich.edu Command cmd; 1804022Sstever@eecs.umich.edu 1815735Snate@binkert.org bool 1825735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1835735Snate@binkert.org { 1844022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1854022Sstever@eecs.umich.edu } 1864022Sstever@eecs.umich.edu 1874022Sstever@eecs.umich.edu public: 1884022Sstever@eecs.umich.edu 18910583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 19010583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 19110583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19210583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 19310583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 19410583SCurtis.Dunham@arm.com bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 19510583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 19610583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 19710570Sandreas.hansson@arm.com 19810570Sandreas.hansson@arm.com /** 19910570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 20010570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 20110570Sandreas.hansson@arm.com * valid or not. 20210570Sandreas.hansson@arm.com */ 2034022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2046102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 20510343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 20610343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 20710343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 20810343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2094870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2105314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2118184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 21210975Sdavid.hashe@amd.com bool isAcquire() const { return testCmdAttrib(IsAcquire); } 21310975Sdavid.hashe@amd.com bool isRelease() const { return testCmdAttrib(IsRelease); } 2144022Sstever@eecs.umich.edu 2155735Snate@binkert.org const Command 2165735Snate@binkert.org responseCommand() const 2175735Snate@binkert.org { 2184022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2194022Sstever@eecs.umich.edu } 2204022Sstever@eecs.umich.edu 2215735Snate@binkert.org /// Return the string to a cmd given by idx. 2225735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2234022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2244022Sstever@eecs.umich.edu 2255735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2265735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2275735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2284022Sstever@eecs.umich.edu 2295735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2305735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2314022Sstever@eecs.umich.edu}; 2324022Sstever@eecs.umich.edu 2332381SN/A/** 2342662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2352662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2362662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2372662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2382662Sstever@eecs.umich.edu * different Packets along the way.) 2392381SN/A */ 2409044SAli.Saidi@ARM.comclass Packet : public Printable 2412381SN/A{ 2422813Srdreslin@umich.edu public: 2435735Snate@binkert.org typedef uint32_t FlagsType; 2445735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2454022Sstever@eecs.umich.edu 2465735Snate@binkert.org private: 2475735Snate@binkert.org 24810938Sandreas.hansson@arm.com enum : FlagsType { 24910938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 25010938Sandreas.hansson@arm.com COPY_FLAGS = 0x0000000F, 25110938Sandreas.hansson@arm.com 25210938Sandreas.hansson@arm.com SHARED = 0x00000001, 25310938Sandreas.hansson@arm.com // Special control flags 25410938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 25510938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 25610938Sandreas.hansson@arm.com /// Does supplier have exclusive copy? 25710938Sandreas.hansson@arm.com /// Useful for multi-level coherence. 25810938Sandreas.hansson@arm.com SUPPLY_EXCLUSIVE = 0x00000004, 25910938Sandreas.hansson@arm.com // Snoop response flags 26010938Sandreas.hansson@arm.com MEM_INHIBIT = 0x00000008, 26110938Sandreas.hansson@arm.com 26210938Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 26310938Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 26410938Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 26510938Sandreas.hansson@arm.com 26610938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 26710938Sandreas.hansson@arm.com /// when the packet is destroyed? 26810938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 26910938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 27010938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 27110938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 27210938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 27310938Sandreas.hansson@arm.com 27410938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 27510938Sandreas.hansson@arm.com /// access failure. 27610938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 27710938Sandreas.hansson@arm.com 27810938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 27910938Sandreas.hansson@arm.com // through express snoop flag 28010938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 28110938Sandreas.hansson@arm.com }; 2825735Snate@binkert.org 2835735Snate@binkert.org Flags flags; 2845735Snate@binkert.org 2855735Snate@binkert.org public: 2864022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2874022Sstever@eecs.umich.edu 2885735Snate@binkert.org /// The command field of the packet. 2894870Sstever@eecs.umich.edu MemCmd cmd; 2904870Sstever@eecs.umich.edu 2915735Snate@binkert.org /// A pointer to the original request. 29210569Sandreas.hansson@arm.com const RequestPtr req; 2934870Sstever@eecs.umich.edu 2942566SN/A private: 2955735Snate@binkert.org /** 2965735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 2975735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 2985735Snate@binkert.org * packet, not request. This may or may not be populated when a 2995735Snate@binkert.org * responder recieves the packet. If not populated it memory should 3005735Snate@binkert.org * be allocated. 3012566SN/A */ 3022566SN/A PacketDataPtr data; 3032566SN/A 3045735Snate@binkert.org /// The address of the request. This address could be virtual or 3055735Snate@binkert.org /// physical, depending on the system configuration. 3062381SN/A Addr addr; 3072381SN/A 30810028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 30910028SGiacomo.Gabrielli@arm.com bool _isSecure; 31010028SGiacomo.Gabrielli@arm.com 3115735Snate@binkert.org /// The size of the request or transfer. 3126227Snate@binkert.org unsigned size; 3132381SN/A 3145735Snate@binkert.org /** 31510723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3168668Sgeoffrey.blake@arm.com */ 31710723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3188668Sgeoffrey.blake@arm.com 3192641Sstever@eecs.umich.edu public: 3202811Srdreslin@umich.edu 3219547Sandreas.hansson@arm.com /** 32210694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 32310405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 32410405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 32510405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 32610405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3279547Sandreas.hansson@arm.com */ 32810694SMarco.Balboni@ARM.com uint32_t headerDelay; 3293218Sgblack@eecs.umich.edu 3309547Sandreas.hansson@arm.com /** 33110694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 33210694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 33310694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 33410694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 33510405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 33610405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3379547Sandreas.hansson@arm.com */ 33810694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3393218Sgblack@eecs.umich.edu 3405735Snate@binkert.org /** 3415735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3429542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3439542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3449542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3459542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3469542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3479542Sandreas.hansson@arm.com * particular sending device. 3489542Sandreas.hansson@arm.com * 3499542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3509542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3519542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3529542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3539542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3549542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3559542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3565735Snate@binkert.org */ 3575735Snate@binkert.org struct SenderState 3585735Snate@binkert.org { 3599542Sandreas.hansson@arm.com SenderState* predecessor; 3609542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3612641Sstever@eecs.umich.edu virtual ~SenderState() {} 3622641Sstever@eecs.umich.edu }; 3632641Sstever@eecs.umich.edu 3645315Sstever@gmail.com /** 3655315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3665315Sstever@gmail.com * field of a PrintReq should always be of this type. 3675315Sstever@gmail.com */ 3689044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3695735Snate@binkert.org { 3705735Snate@binkert.org private: 3715735Snate@binkert.org /** 3725735Snate@binkert.org * An entry in the label stack. 3735735Snate@binkert.org */ 3745735Snate@binkert.org struct LabelStackEntry 3755735Snate@binkert.org { 3765314Sstever@gmail.com const std::string label; 3775314Sstever@gmail.com std::string *prefix; 3785314Sstever@gmail.com bool labelPrinted; 3795735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3805314Sstever@gmail.com }; 3815314Sstever@gmail.com 3825314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3835314Sstever@gmail.com LabelStack labelStack; 3845314Sstever@gmail.com 3855314Sstever@gmail.com std::string *curPrefixPtr; 3865314Sstever@gmail.com 3875314Sstever@gmail.com public: 3885314Sstever@gmail.com std::ostream &os; 3895314Sstever@gmail.com const int verbosity; 3905314Sstever@gmail.com 3915314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 3925314Sstever@gmail.com ~PrintReqState(); 3935314Sstever@gmail.com 3945735Snate@binkert.org /** 3955735Snate@binkert.org * Returns the current line prefix. 3965735Snate@binkert.org */ 3975314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 3985315Sstever@gmail.com 3995735Snate@binkert.org /** 4005735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4015315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4025735Snate@binkert.org * printed if an object within the label's scope is printed. 4035735Snate@binkert.org */ 4045314Sstever@gmail.com void pushLabel(const std::string &lbl, 4055314Sstever@gmail.com const std::string &prefix = " "); 4065735Snate@binkert.org 4075735Snate@binkert.org /** 4085735Snate@binkert.org * Pop a label off the label stack. 4095735Snate@binkert.org */ 4105314Sstever@gmail.com void popLabel(); 4115735Snate@binkert.org 4125735Snate@binkert.org /** 4135735Snate@binkert.org * Print all of the pending unprinted labels on the 4145315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4155735Snate@binkert.org * users unless bypassing printObj(). 4165735Snate@binkert.org */ 4175314Sstever@gmail.com void printLabels(); 4185735Snate@binkert.org 4195735Snate@binkert.org /** 4205735Snate@binkert.org * Print a Printable object to os, because it matched the 4215735Snate@binkert.org * address on a PrintReq. 4225735Snate@binkert.org */ 4235314Sstever@gmail.com void printObj(Printable *obj); 4245314Sstever@gmail.com }; 4255314Sstever@gmail.com 4265735Snate@binkert.org /** 4275735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4285735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4295735Snate@binkert.org * this variable is to allow a device to attach extra information 4309542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4315735Snate@binkert.org * that was attached to the original request (even if a new packet 4325735Snate@binkert.org * is created). 4335735Snate@binkert.org */ 4342662Sstever@eecs.umich.edu SenderState *senderState; 4352641Sstever@eecs.umich.edu 4369542Sandreas.hansson@arm.com /** 4379542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4389542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4399542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4409542Sandreas.hansson@arm.com * variable. 4419542Sandreas.hansson@arm.com * 4429542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4439542Sandreas.hansson@arm.com */ 4449542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4459542Sandreas.hansson@arm.com 4469542Sandreas.hansson@arm.com /** 4479542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4489542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4499542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4509542Sandreas.hansson@arm.com * variable. 4519542Sandreas.hansson@arm.com * 4529542Sandreas.hansson@arm.com * @return The current top of the stack 4539542Sandreas.hansson@arm.com */ 4549542Sandreas.hansson@arm.com SenderState *popSenderState(); 4559542Sandreas.hansson@arm.com 4569543Ssascha.bischoff@arm.com /** 4579543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4589543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4599543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4609543Ssascha.bischoff@arm.com * 4619543Ssascha.bischoff@arm.com * @return The topmost state of type T 4629543Ssascha.bischoff@arm.com */ 4639543Ssascha.bischoff@arm.com template <typename T> 4649543Ssascha.bischoff@arm.com T * findNextSenderState() const 4659543Ssascha.bischoff@arm.com { 4669543Ssascha.bischoff@arm.com T *t = NULL; 4679543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4689543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4699543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4709543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4719543Ssascha.bischoff@arm.com } 4729543Ssascha.bischoff@arm.com return t; 4739543Ssascha.bischoff@arm.com } 4749543Ssascha.bischoff@arm.com 4755735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4765735Snate@binkert.org /// tracing). 4774022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4782811Srdreslin@umich.edu 4795735Snate@binkert.org /// Return the index of this command. 4804022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4812811Srdreslin@umich.edu 48210583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 48310583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 48410583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 48510583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 48610583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 48710583SCurtis.Dunham@arm.com bool needsExclusive() const { return cmd.needsExclusive(); } 48810583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 48910583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 49010583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 49110583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 49210583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 49310583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 49410583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 49510975Sdavid.hashe@amd.com bool isAcquire() const { return cmd.isAcquire(); } 49610975Sdavid.hashe@amd.com bool isRelease() const { return cmd.isRelease(); } 4972812Srdreslin@umich.edu 4984870Sstever@eecs.umich.edu // Snoop flags 49910567Sandreas.hansson@arm.com void assertMemInhibit() 50010567Sandreas.hansson@arm.com { 50110567Sandreas.hansson@arm.com assert(isRequest()); 50210567Sandreas.hansson@arm.com assert(!flags.isSet(MEM_INHIBIT)); 50310567Sandreas.hansson@arm.com flags.set(MEM_INHIBIT); 50410567Sandreas.hansson@arm.com } 5059951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 5069951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 5079951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 5084870Sstever@eecs.umich.edu 5094895Sstever@eecs.umich.edu // Special control flags 5109951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5119951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5129951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5139951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5149951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5159951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 51610763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 51710763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 51810883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 5194895Sstever@eecs.umich.edu 5204870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5214870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5224870Sstever@eecs.umich.edu // field, etc.) 5235735Snate@binkert.org void 5245735Snate@binkert.org setBadAddress() 5255735Snate@binkert.org { 5265735Snate@binkert.org assert(isResponse()); 5275735Snate@binkert.org cmd = MemCmd::BadAddressError; 5285735Snate@binkert.org } 5295735Snate@binkert.org 5304986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5312814Srdreslin@umich.edu 5325764Snate@binkert.org Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5339259SAli.Saidi@ARM.com /** 5349259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5359259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5369259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5379259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5389259SAli.Saidi@ARM.com * valid. 5399259SAli.Saidi@ARM.com */ 5409259SAli.Saidi@ARM.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5419259SAli.Saidi@ARM.com 5426227Snate@binkert.org unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 54310938Sandreas.hansson@arm.com 54410938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 54510938Sandreas.hansson@arm.com { 54610938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 54710938Sandreas.hansson@arm.com } 54810938Sandreas.hansson@arm.com 54910938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 55010938Sandreas.hansson@arm.com { 55110938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 55210938Sandreas.hansson@arm.com } 5532549SN/A 55410028SGiacomo.Gabrielli@arm.com bool isSecure() const 55510028SGiacomo.Gabrielli@arm.com { 55610028SGiacomo.Gabrielli@arm.com assert(flags.isSet(VALID_ADDR)); 55710028SGiacomo.Gabrielli@arm.com return _isSecure; 55810028SGiacomo.Gabrielli@arm.com } 55910028SGiacomo.Gabrielli@arm.com 5605735Snate@binkert.org /** 5617550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 56210938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 5637550SBrad.Beckmann@amd.com */ 5647550SBrad.Beckmann@amd.com void 5657550SBrad.Beckmann@amd.com convertScToWrite() 5667550SBrad.Beckmann@amd.com { 5677550SBrad.Beckmann@amd.com assert(isLLSC()); 5687550SBrad.Beckmann@amd.com assert(isWrite()); 5697550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5707550SBrad.Beckmann@amd.com } 5717550SBrad.Beckmann@amd.com 5727550SBrad.Beckmann@amd.com /** 57310938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 57410938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 5757550SBrad.Beckmann@amd.com */ 5767550SBrad.Beckmann@amd.com void 5777550SBrad.Beckmann@amd.com convertLlToRead() 5787550SBrad.Beckmann@amd.com { 5797550SBrad.Beckmann@amd.com assert(isLLSC()); 5807550SBrad.Beckmann@amd.com assert(isRead()); 5817550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5827550SBrad.Beckmann@amd.com } 5837550SBrad.Beckmann@amd.com 5847550SBrad.Beckmann@amd.com /** 58510938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 5865735Snate@binkert.org * first, but the Requests's physical address and size fields need 5879030Sandreas.hansson@arm.com * not be valid. The command must be supplied. 5885735Snate@binkert.org */ 58910569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 59010360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 59110723Sandreas.hansson@arm.com size(0), headerDelay(0), payloadDelay(0), 5929546Sandreas.hansson@arm.com senderState(NULL) 5932641Sstever@eecs.umich.edu { 5946104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 5956104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 5966104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 59710028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 5986104Ssteve.reinhardt@amd.com } 5996104Ssteve.reinhardt@amd.com if (req->hasSize()) { 6006104Ssteve.reinhardt@amd.com size = req->getSize(); 6016104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6026104Ssteve.reinhardt@amd.com } 6032813Srdreslin@umich.edu } 6042813Srdreslin@umich.edu 6055735Snate@binkert.org /** 6065735Snate@binkert.org * Alternate constructor if you are trying to create a packet with 6075735Snate@binkert.org * a request that is for a whole block, not the address from the 6085735Snate@binkert.org * req. this allows for overriding the size/addr of the req. 6095735Snate@binkert.org */ 61010569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 61110360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 61210694SMarco.Balboni@ARM.com headerDelay(0), payloadDelay(0), 6139546Sandreas.hansson@arm.com senderState(NULL) 6142813Srdreslin@umich.edu { 6156104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 6166104Ssteve.reinhardt@amd.com addr = req->getPaddr() & ~(_blkSize - 1); 6176104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 61810028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6196104Ssteve.reinhardt@amd.com } 6206104Ssteve.reinhardt@amd.com size = _blkSize; 6216104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6224626Sstever@eecs.umich.edu } 6234626Sstever@eecs.umich.edu 6245735Snate@binkert.org /** 6255735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6264887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6274887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6284887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6295735Snate@binkert.org * packet should allocate its own data. 6305735Snate@binkert.org */ 63110896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 6325735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 63310571Sandreas.hansson@arm.com data(nullptr), 63410028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 63510723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 63610694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 63710694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 6389546Sandreas.hansson@arm.com senderState(pkt->senderState) 6394626Sstever@eecs.umich.edu { 64010571Sandreas.hansson@arm.com if (!clear_flags) 6415735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6425735Snate@binkert.org 6439031Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 64410565Sandreas.hansson@arm.com 64510571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 64610571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 64710571Sandreas.hansson@arm.com // co-ordinate state changes 64810571Sandreas.hansson@arm.com if (alloc_data) { 64910571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 65010571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 65110571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 65210571Sandreas.hansson@arm.com // carry the pointer forward 65310571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 65410571Sandreas.hansson@arm.com data = pkt->data; 65510571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 65610571Sandreas.hansson@arm.com } else { 65710571Sandreas.hansson@arm.com allocate(); 65810571Sandreas.hansson@arm.com } 65910571Sandreas.hansson@arm.com } 66010342SCurtis.Dunham@arm.com } 6618668Sgeoffrey.blake@arm.com 66210342SCurtis.Dunham@arm.com /** 66310739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 66410342SCurtis.Dunham@arm.com */ 66510739Ssteve.reinhardt@amd.com static MemCmd 66610739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 66710342SCurtis.Dunham@arm.com { 66810739Ssteve.reinhardt@amd.com if (req->isLLSC()) 66910739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 67010739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 67110739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 67210739Ssteve.reinhardt@amd.com else 67310739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 67410739Ssteve.reinhardt@amd.com } 67510739Ssteve.reinhardt@amd.com 67610739Ssteve.reinhardt@amd.com /** 67710739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 67810739Ssteve.reinhardt@amd.com */ 67910739Ssteve.reinhardt@amd.com static MemCmd 68010739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 68110739Ssteve.reinhardt@amd.com { 68210739Ssteve.reinhardt@amd.com if (req->isLLSC()) 68310739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 68410739Ssteve.reinhardt@amd.com else if (req->isSwap()) 68510739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 68610739Ssteve.reinhardt@amd.com else 68710739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 68810342SCurtis.Dunham@arm.com } 68910342SCurtis.Dunham@arm.com 69010342SCurtis.Dunham@arm.com /** 69110342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 69210739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 69310342SCurtis.Dunham@arm.com */ 69410342SCurtis.Dunham@arm.com static PacketPtr 69510569Sandreas.hansson@arm.com createRead(const RequestPtr req) 69610342SCurtis.Dunham@arm.com { 69710739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 69810342SCurtis.Dunham@arm.com } 69910342SCurtis.Dunham@arm.com 70010342SCurtis.Dunham@arm.com static PacketPtr 70110569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 70210342SCurtis.Dunham@arm.com { 70310739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 7042641Sstever@eecs.umich.edu } 7052549SN/A 7065735Snate@binkert.org /** 7075735Snate@binkert.org * clean up packet variables 7085735Snate@binkert.org */ 7092566SN/A ~Packet() 7105387Sstever@gmail.com { 71110872Sali.jafri@arm.com // Delete the request object if this is a request packet which 71210872Sali.jafri@arm.com // does not need a response, because the requester will not get 71310872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 71410872Sali.jafri@arm.com // request will be deleted on receipt of the response 71510872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 71610872Sali.jafri@arm.com // express snoops, even for cases when responses are not 71710872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 71810872Sali.jafri@arm.com // re-uses the same request. 71910872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 72010872Sali.jafri@arm.com !isExpressSnoop()) { 7215387Sstever@gmail.com delete req; 72210872Sali.jafri@arm.com } 7235735Snate@binkert.org deleteData(); 7245387Sstever@gmail.com } 7252566SN/A 7265735Snate@binkert.org /** 7274626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 72810660Sandreas.hansson@arm.com * returning as a response to that request. 7294626Sstever@eecs.umich.edu */ 7305735Snate@binkert.org void 7315735Snate@binkert.org makeResponse() 7324626Sstever@eecs.umich.edu { 7332662Sstever@eecs.umich.edu assert(needsResponse()); 7342855Srdreslin@umich.edu assert(isRequest()); 7354022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7365745Snate@binkert.org 7377464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7387464Ssteve.reinhardt@amd.com // triggered them was 7397464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7402641Sstever@eecs.umich.edu } 7412641Sstever@eecs.umich.edu 7425735Snate@binkert.org void 7435735Snate@binkert.org makeAtomicResponse() 7444870Sstever@eecs.umich.edu { 7454870Sstever@eecs.umich.edu makeResponse(); 7464870Sstever@eecs.umich.edu } 7474870Sstever@eecs.umich.edu 7485735Snate@binkert.org void 7495735Snate@binkert.org makeTimingResponse() 7503348Sbinkertn@umich.edu { 7514870Sstever@eecs.umich.edu makeResponse(); 7523135Srdreslin@umich.edu } 7533135Srdreslin@umich.edu 7548436SBrad.Beckmann@amd.com void 7558436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7568436SBrad.Beckmann@amd.com { 7578436SBrad.Beckmann@amd.com if (!success) { 7588436SBrad.Beckmann@amd.com if (isWrite()) { 7598436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7608436SBrad.Beckmann@amd.com } else { 7618436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7628436SBrad.Beckmann@amd.com } 7638436SBrad.Beckmann@amd.com } 7648436SBrad.Beckmann@amd.com } 7658436SBrad.Beckmann@amd.com 7667006Snate@binkert.org void 7677006Snate@binkert.org setSize(unsigned size) 7687006Snate@binkert.org { 7697006Snate@binkert.org assert(!flags.isSet(VALID_SIZE)); 7707006Snate@binkert.org 7717006Snate@binkert.org this->size = size; 7727006Snate@binkert.org flags.set(VALID_SIZE); 7737006Snate@binkert.org } 7747006Snate@binkert.org 7752685Ssaidi@eecs.umich.edu 7763348Sbinkertn@umich.edu /** 7773348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 77810571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 77910571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 78010571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 78110571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 78210571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 78310571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 78410571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 78510571Sandreas.hansson@arm.com * to the source, no copies are necessary. 7862566SN/A */ 7872566SN/A template <typename T> 7883348Sbinkertn@umich.edu void 7893348Sbinkertn@umich.edu dataStatic(T *p) 7903348Sbinkertn@umich.edu { 79110566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 7923348Sbinkertn@umich.edu data = (PacketDataPtr)p; 7935735Snate@binkert.org flags.set(STATIC_DATA); 7943348Sbinkertn@umich.edu } 7952566SN/A 7963348Sbinkertn@umich.edu /** 79710564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 79810564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 79910564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 80010564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 80110564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 80210564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 80310564Sandreas.hansson@arm.com */ 80410564Sandreas.hansson@arm.com template <typename T> 80510564Sandreas.hansson@arm.com void 80610564Sandreas.hansson@arm.com dataStaticConst(const T *p) 80710564Sandreas.hansson@arm.com { 80810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 80910564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 81010564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 81110564Sandreas.hansson@arm.com } 81210564Sandreas.hansson@arm.com 81310564Sandreas.hansson@arm.com /** 8143348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 81510571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 81610571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 81710571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 81810571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 81910571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 82010571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 82110571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 82210571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 82310571Sandreas.hansson@arm.com * before it is deallocated. 8243348Sbinkertn@umich.edu */ 8252566SN/A template <typename T> 8263348Sbinkertn@umich.edu void 8273348Sbinkertn@umich.edu dataDynamic(T *p) 8283348Sbinkertn@umich.edu { 82910566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8303348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8315735Snate@binkert.org flags.set(DYNAMIC_DATA); 8323348Sbinkertn@umich.edu } 8333348Sbinkertn@umich.edu 8345735Snate@binkert.org /** 8355735Snate@binkert.org * get a pointer to the data ptr. 8365735Snate@binkert.org */ 8373348Sbinkertn@umich.edu template <typename T> 8383348Sbinkertn@umich.edu T* 83910562Sandreas.hansson@arm.com getPtr() 8403348Sbinkertn@umich.edu { 84110562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8423348Sbinkertn@umich.edu return (T*)data; 8433348Sbinkertn@umich.edu } 8442566SN/A 84510563Sandreas.hansson@arm.com template <typename T> 84610563Sandreas.hansson@arm.com const T* 84710563Sandreas.hansson@arm.com getConstPtr() const 84810563Sandreas.hansson@arm.com { 84910563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 85010563Sandreas.hansson@arm.com return (const T*)data; 85110563Sandreas.hansson@arm.com } 85210563Sandreas.hansson@arm.com 8535735Snate@binkert.org /** 8545735Snate@binkert.org * return the value of what is pointed to in the packet. 8555735Snate@binkert.org */ 8562566SN/A template <typename T> 85710563Sandreas.hansson@arm.com T get() const; 8582566SN/A 8595735Snate@binkert.org /** 8605735Snate@binkert.org * set the value in the data pointer to v. 8615735Snate@binkert.org */ 8622566SN/A template <typename T> 8632592SN/A void set(T v); 8642566SN/A 8653348Sbinkertn@umich.edu /** 8664626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 8674626Sstever@eecs.umich.edu */ 8685735Snate@binkert.org void 86910563Sandreas.hansson@arm.com setData(const uint8_t *p) 8704626Sstever@eecs.umich.edu { 87110571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 87210571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 87310571Sandreas.hansson@arm.com // same pointer from source to destination and back 87410571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 87510571Sandreas.hansson@arm.com 8767691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 87710571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 87810571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 8797691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 8804626Sstever@eecs.umich.edu } 8814626Sstever@eecs.umich.edu 8824626Sstever@eecs.umich.edu /** 8834626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 8844626Sstever@eecs.umich.edu * which is aligned to the given block size. 8854626Sstever@eecs.umich.edu */ 8865735Snate@binkert.org void 88710563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 8884626Sstever@eecs.umich.edu { 8894626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 8904626Sstever@eecs.umich.edu } 8914626Sstever@eecs.umich.edu 8924626Sstever@eecs.umich.edu /** 8934626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 8944626Sstever@eecs.umich.edu * is aligned to the given block size. 8954626Sstever@eecs.umich.edu */ 8965735Snate@binkert.org void 89710563Sandreas.hansson@arm.com writeData(uint8_t *p) const 8984626Sstever@eecs.umich.edu { 89910563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 9004626Sstever@eecs.umich.edu } 9014626Sstever@eecs.umich.edu 9024626Sstever@eecs.umich.edu /** 9034626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 9044626Sstever@eecs.umich.edu */ 9055735Snate@binkert.org void 90610563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 9074626Sstever@eecs.umich.edu { 9084626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 9094626Sstever@eecs.umich.edu } 9104626Sstever@eecs.umich.edu 9114626Sstever@eecs.umich.edu /** 9123348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 9133348Sbinkertn@umich.edu * matter how data was allocted. 9143348Sbinkertn@umich.edu */ 9155735Snate@binkert.org void 9165735Snate@binkert.org deleteData() 9175735Snate@binkert.org { 91810566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 9195735Snate@binkert.org delete [] data; 9205735Snate@binkert.org 92110566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 9225735Snate@binkert.org data = NULL; 9235735Snate@binkert.org } 9242566SN/A 92510565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9265735Snate@binkert.org void 9275735Snate@binkert.org allocate() 9285735Snate@binkert.org { 9295764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 93010566Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 9315745Snate@binkert.org data = new uint8_t[getSize()]; 9325735Snate@binkert.org } 9335735Snate@binkert.org 9344626Sstever@eecs.umich.edu /** 93510570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 93610570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 93710570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 93810570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 93910570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 94010570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 94110570Sandreas.hansson@arm.com * accordingly. 94210570Sandreas.hansson@arm.com */ 94310570Sandreas.hansson@arm.com bool 94410570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 94510570Sandreas.hansson@arm.com { 94610570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 94710570Sandreas.hansson@arm.com // data pointer 94810570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 94910570Sandreas.hansson@arm.com other->getSize(), 95010570Sandreas.hansson@arm.com other->hasData() ? 95110570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 95210570Sandreas.hansson@arm.com } 95310570Sandreas.hansson@arm.com 95410570Sandreas.hansson@arm.com /** 95510883Sali.jafri@arm.com * Is this request notification of a clean or dirty eviction from the cache. 95610883Sali.jafri@arm.com **/ 95710883Sali.jafri@arm.com bool 95810883Sali.jafri@arm.com evictingBlock() const 95910883Sali.jafri@arm.com { 96010883Sali.jafri@arm.com return (cmd == MemCmd::Writeback || 96110883Sali.jafri@arm.com cmd == MemCmd::CleanEvict); 96210883Sali.jafri@arm.com } 96310883Sali.jafri@arm.com 96410883Sali.jafri@arm.com /** 96510883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 96610883Sali.jafri@arm.com * in the memory hierarchy above. 96710883Sali.jafri@arm.com **/ 96810883Sali.jafri@arm.com bool 96910883Sali.jafri@arm.com mustCheckAbove() const 97010883Sali.jafri@arm.com { 97110883Sali.jafri@arm.com return (cmd == MemCmd::HardPFReq || 97210883Sali.jafri@arm.com evictingBlock()); 97310883Sali.jafri@arm.com } 97410883Sali.jafri@arm.com 97510883Sali.jafri@arm.com /** 9764626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 97710570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 97810570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 97910570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 9804626Sstever@eecs.umich.edu * memory value. 9814626Sstever@eecs.umich.edu */ 9825735Snate@binkert.org bool 98310570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 98410570Sandreas.hansson@arm.com uint8_t *_data); 9855314Sstever@gmail.com 9865315Sstever@gmail.com /** 9875315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 9885315Sstever@gmail.com */ 9895735Snate@binkert.org void 9905735Snate@binkert.org pushLabel(const std::string &lbl) 9915735Snate@binkert.org { 9925735Snate@binkert.org if (isPrint()) 9935735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 9945314Sstever@gmail.com } 9955314Sstever@gmail.com 9965315Sstever@gmail.com /** 9975315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 9985315Sstever@gmail.com */ 9995735Snate@binkert.org void 10005735Snate@binkert.org popLabel() 10015735Snate@binkert.org { 10025735Snate@binkert.org if (isPrint()) 10035735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 10045314Sstever@gmail.com } 10055314Sstever@gmail.com 10065314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 10075314Sstever@gmail.com const std::string &prefix = "") const; 10089663Suri.wiener@arm.com 10099663Suri.wiener@arm.com /** 10109663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 10119663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 10129663Suri.wiener@arm.com * avoiding string overheads in fast mode 10139663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 10149663Suri.wiener@arm.com */ 10159663Suri.wiener@arm.com std::string print() const; 10162381SN/A}; 10172381SN/A 10182381SN/A#endif //__MEM_PACKET_HH 1019