packet.hh revision 11013
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 1544022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1554022Sstever@eecs.umich.edu }; 1564022Sstever@eecs.umich.edu 1575735Snate@binkert.org /** 1585735Snate@binkert.org * Structure that defines attributes and other data associated 1595735Snate@binkert.org * with a Command. 1605735Snate@binkert.org */ 1615735Snate@binkert.org struct CommandInfo 1625735Snate@binkert.org { 1635735Snate@binkert.org /// Set of attribute flags. 1644022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1655735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1665735Snate@binkert.org /// response is applicable. 1674022Sstever@eecs.umich.edu const Command response; 1685735Snate@binkert.org /// String representation (for printing) 1694022Sstever@eecs.umich.edu const std::string str; 1704022Sstever@eecs.umich.edu }; 1714022Sstever@eecs.umich.edu 1725735Snate@binkert.org /// Array to map Command enum to associated info. 1734022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1744022Sstever@eecs.umich.edu 1754022Sstever@eecs.umich.edu private: 1764022Sstever@eecs.umich.edu 1774022Sstever@eecs.umich.edu Command cmd; 1784022Sstever@eecs.umich.edu 1795735Snate@binkert.org bool 1805735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1815735Snate@binkert.org { 1824022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1834022Sstever@eecs.umich.edu } 1844022Sstever@eecs.umich.edu 1854022Sstever@eecs.umich.edu public: 1864022Sstever@eecs.umich.edu 18710583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 18810583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 18910583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19010583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 19110583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 19210583SCurtis.Dunham@arm.com bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 19310583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 19410583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 19510570Sandreas.hansson@arm.com 19610570Sandreas.hansson@arm.com /** 19710570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 19810570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 19910570Sandreas.hansson@arm.com * valid or not. 20010570Sandreas.hansson@arm.com */ 2014022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 2026102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 20310343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 20410343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 20510343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 20610343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2074870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2085314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2098184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2104022Sstever@eecs.umich.edu 2115735Snate@binkert.org const Command 2125735Snate@binkert.org responseCommand() const 2135735Snate@binkert.org { 2144022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2154022Sstever@eecs.umich.edu } 2164022Sstever@eecs.umich.edu 2175735Snate@binkert.org /// Return the string to a cmd given by idx. 2185735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2194022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2204022Sstever@eecs.umich.edu 2215735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2225735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2235735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2244022Sstever@eecs.umich.edu 2255735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2265735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2274022Sstever@eecs.umich.edu}; 2284022Sstever@eecs.umich.edu 2292381SN/A/** 2302662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2312662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2322662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2332662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2342662Sstever@eecs.umich.edu * different Packets along the way.) 2352381SN/A */ 2369044SAli.Saidi@ARM.comclass Packet : public Printable 2372381SN/A{ 2382813Srdreslin@umich.edu public: 2395735Snate@binkert.org typedef uint32_t FlagsType; 2405735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2414022Sstever@eecs.umich.edu 2425735Snate@binkert.org private: 2435735Snate@binkert.org 24410938Sandreas.hansson@arm.com enum : FlagsType { 24510938Sandreas.hansson@arm.com // Flags to transfer across when copying a packet 24610938Sandreas.hansson@arm.com COPY_FLAGS = 0x0000000F, 24710938Sandreas.hansson@arm.com 24810938Sandreas.hansson@arm.com SHARED = 0x00000001, 24910938Sandreas.hansson@arm.com // Special control flags 25010938Sandreas.hansson@arm.com /// Special timing-mode atomic snoop for multi-level coherence. 25110938Sandreas.hansson@arm.com EXPRESS_SNOOP = 0x00000002, 25210938Sandreas.hansson@arm.com /// Does supplier have exclusive copy? 25310938Sandreas.hansson@arm.com /// Useful for multi-level coherence. 25410938Sandreas.hansson@arm.com SUPPLY_EXCLUSIVE = 0x00000004, 25510938Sandreas.hansson@arm.com // Snoop response flags 25610938Sandreas.hansson@arm.com MEM_INHIBIT = 0x00000008, 25710938Sandreas.hansson@arm.com 25810938Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 25910938Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 26010938Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 26110938Sandreas.hansson@arm.com 26210938Sandreas.hansson@arm.com /// Is the data pointer set to a value that shouldn't be freed 26310938Sandreas.hansson@arm.com /// when the packet is destroyed? 26410938Sandreas.hansson@arm.com STATIC_DATA = 0x00001000, 26510938Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 26610938Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 26710938Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 26810938Sandreas.hansson@arm.com DYNAMIC_DATA = 0x00002000, 26910938Sandreas.hansson@arm.com 27010938Sandreas.hansson@arm.com /// suppress the error if this packet encounters a functional 27110938Sandreas.hansson@arm.com /// access failure. 27210938Sandreas.hansson@arm.com SUPPRESS_FUNC_ERROR = 0x00008000, 27310938Sandreas.hansson@arm.com 27410938Sandreas.hansson@arm.com // Signal block present to squash prefetch and cache evict packets 27510938Sandreas.hansson@arm.com // through express snoop flag 27610938Sandreas.hansson@arm.com BLOCK_CACHED = 0x00010000 27710938Sandreas.hansson@arm.com }; 2785735Snate@binkert.org 2795735Snate@binkert.org Flags flags; 2805735Snate@binkert.org 2815735Snate@binkert.org public: 2824022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2834022Sstever@eecs.umich.edu 2845735Snate@binkert.org /// The command field of the packet. 2854870Sstever@eecs.umich.edu MemCmd cmd; 2864870Sstever@eecs.umich.edu 2875735Snate@binkert.org /// A pointer to the original request. 28810569Sandreas.hansson@arm.com const RequestPtr req; 2894870Sstever@eecs.umich.edu 2902566SN/A private: 2915735Snate@binkert.org /** 2925735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 2935735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 2945735Snate@binkert.org * packet, not request. This may or may not be populated when a 2955735Snate@binkert.org * responder recieves the packet. If not populated it memory should 2965735Snate@binkert.org * be allocated. 2972566SN/A */ 2982566SN/A PacketDataPtr data; 2992566SN/A 3005735Snate@binkert.org /// The address of the request. This address could be virtual or 3015735Snate@binkert.org /// physical, depending on the system configuration. 3022381SN/A Addr addr; 3032381SN/A 30410028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 30510028SGiacomo.Gabrielli@arm.com bool _isSecure; 30610028SGiacomo.Gabrielli@arm.com 3075735Snate@binkert.org /// The size of the request or transfer. 3086227Snate@binkert.org unsigned size; 3092381SN/A 3105735Snate@binkert.org /** 31110723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3128668Sgeoffrey.blake@arm.com */ 31310723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3148668Sgeoffrey.blake@arm.com 3152641Sstever@eecs.umich.edu public: 3162811Srdreslin@umich.edu 3179547Sandreas.hansson@arm.com /** 31810694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 31910405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 32010405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 32110405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 32210405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3239547Sandreas.hansson@arm.com */ 32410694SMarco.Balboni@ARM.com uint32_t headerDelay; 3253218Sgblack@eecs.umich.edu 3269547Sandreas.hansson@arm.com /** 32710694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 32810694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 32910694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 33010694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 33110405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 33210405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3339547Sandreas.hansson@arm.com */ 33410694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3353218Sgblack@eecs.umich.edu 3365735Snate@binkert.org /** 3375735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3389542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3399542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3409542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3419542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3429542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3439542Sandreas.hansson@arm.com * particular sending device. 3449542Sandreas.hansson@arm.com * 3459542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3469542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3479542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3489542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3499542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3509542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3519542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3525735Snate@binkert.org */ 3535735Snate@binkert.org struct SenderState 3545735Snate@binkert.org { 3559542Sandreas.hansson@arm.com SenderState* predecessor; 3569542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3572641Sstever@eecs.umich.edu virtual ~SenderState() {} 3582641Sstever@eecs.umich.edu }; 3592641Sstever@eecs.umich.edu 3605315Sstever@gmail.com /** 3615315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3625315Sstever@gmail.com * field of a PrintReq should always be of this type. 3635315Sstever@gmail.com */ 3649044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3655735Snate@binkert.org { 3665735Snate@binkert.org private: 3675735Snate@binkert.org /** 3685735Snate@binkert.org * An entry in the label stack. 3695735Snate@binkert.org */ 3705735Snate@binkert.org struct LabelStackEntry 3715735Snate@binkert.org { 3725314Sstever@gmail.com const std::string label; 3735314Sstever@gmail.com std::string *prefix; 3745314Sstever@gmail.com bool labelPrinted; 3755735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3765314Sstever@gmail.com }; 3775314Sstever@gmail.com 3785314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3795314Sstever@gmail.com LabelStack labelStack; 3805314Sstever@gmail.com 3815314Sstever@gmail.com std::string *curPrefixPtr; 3825314Sstever@gmail.com 3835314Sstever@gmail.com public: 3845314Sstever@gmail.com std::ostream &os; 3855314Sstever@gmail.com const int verbosity; 3865314Sstever@gmail.com 3875314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 3885314Sstever@gmail.com ~PrintReqState(); 3895314Sstever@gmail.com 3905735Snate@binkert.org /** 3915735Snate@binkert.org * Returns the current line prefix. 3925735Snate@binkert.org */ 3935314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 3945315Sstever@gmail.com 3955735Snate@binkert.org /** 3965735Snate@binkert.org * Push a label onto the label stack, and prepend the given 3975315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 3985735Snate@binkert.org * printed if an object within the label's scope is printed. 3995735Snate@binkert.org */ 4005314Sstever@gmail.com void pushLabel(const std::string &lbl, 4015314Sstever@gmail.com const std::string &prefix = " "); 4025735Snate@binkert.org 4035735Snate@binkert.org /** 4045735Snate@binkert.org * Pop a label off the label stack. 4055735Snate@binkert.org */ 4065314Sstever@gmail.com void popLabel(); 4075735Snate@binkert.org 4085735Snate@binkert.org /** 4095735Snate@binkert.org * Print all of the pending unprinted labels on the 4105315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4115735Snate@binkert.org * users unless bypassing printObj(). 4125735Snate@binkert.org */ 4135314Sstever@gmail.com void printLabels(); 4145735Snate@binkert.org 4155735Snate@binkert.org /** 4165735Snate@binkert.org * Print a Printable object to os, because it matched the 4175735Snate@binkert.org * address on a PrintReq. 4185735Snate@binkert.org */ 4195314Sstever@gmail.com void printObj(Printable *obj); 4205314Sstever@gmail.com }; 4215314Sstever@gmail.com 4225735Snate@binkert.org /** 4235735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4245735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4255735Snate@binkert.org * this variable is to allow a device to attach extra information 4269542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4275735Snate@binkert.org * that was attached to the original request (even if a new packet 4285735Snate@binkert.org * is created). 4295735Snate@binkert.org */ 4302662Sstever@eecs.umich.edu SenderState *senderState; 4312641Sstever@eecs.umich.edu 4329542Sandreas.hansson@arm.com /** 4339542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4349542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4359542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4369542Sandreas.hansson@arm.com * variable. 4379542Sandreas.hansson@arm.com * 4389542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4399542Sandreas.hansson@arm.com */ 4409542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4419542Sandreas.hansson@arm.com 4429542Sandreas.hansson@arm.com /** 4439542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4449542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4459542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4469542Sandreas.hansson@arm.com * variable. 4479542Sandreas.hansson@arm.com * 4489542Sandreas.hansson@arm.com * @return The current top of the stack 4499542Sandreas.hansson@arm.com */ 4509542Sandreas.hansson@arm.com SenderState *popSenderState(); 4519542Sandreas.hansson@arm.com 4529543Ssascha.bischoff@arm.com /** 4539543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4549543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4559543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4569543Ssascha.bischoff@arm.com * 4579543Ssascha.bischoff@arm.com * @return The topmost state of type T 4589543Ssascha.bischoff@arm.com */ 4599543Ssascha.bischoff@arm.com template <typename T> 4609543Ssascha.bischoff@arm.com T * findNextSenderState() const 4619543Ssascha.bischoff@arm.com { 4629543Ssascha.bischoff@arm.com T *t = NULL; 4639543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4649543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4659543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4669543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4679543Ssascha.bischoff@arm.com } 4689543Ssascha.bischoff@arm.com return t; 4699543Ssascha.bischoff@arm.com } 4709543Ssascha.bischoff@arm.com 4715735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4725735Snate@binkert.org /// tracing). 4734022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4742811Srdreslin@umich.edu 4755735Snate@binkert.org /// Return the index of this command. 4764022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4772811Srdreslin@umich.edu 47810583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 47910583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 48010583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 48110583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 48210583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 48310583SCurtis.Dunham@arm.com bool needsExclusive() const { return cmd.needsExclusive(); } 48410583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 48510583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 48610583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 48710583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 48810583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 48910583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 49010583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 4912812Srdreslin@umich.edu 4924870Sstever@eecs.umich.edu // Snoop flags 49310567Sandreas.hansson@arm.com void assertMemInhibit() 49410567Sandreas.hansson@arm.com { 49510567Sandreas.hansson@arm.com assert(isRequest()); 49610567Sandreas.hansson@arm.com assert(!flags.isSet(MEM_INHIBIT)); 49710567Sandreas.hansson@arm.com flags.set(MEM_INHIBIT); 49810567Sandreas.hansson@arm.com } 4999951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 5009951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 5019951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 5024870Sstever@eecs.umich.edu 5034895Sstever@eecs.umich.edu // Special control flags 5049951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5059951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5069951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5079951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5089951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5099951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 51010763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 51110763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 51210883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 5134895Sstever@eecs.umich.edu 5144870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5154870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5164870Sstever@eecs.umich.edu // field, etc.) 5175735Snate@binkert.org void 5185735Snate@binkert.org setBadAddress() 5195735Snate@binkert.org { 5205735Snate@binkert.org assert(isResponse()); 5215735Snate@binkert.org cmd = MemCmd::BadAddressError; 5225735Snate@binkert.org } 5235735Snate@binkert.org 5244986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5252814Srdreslin@umich.edu 5265764Snate@binkert.org Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5279259SAli.Saidi@ARM.com /** 5289259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5299259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5309259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5319259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5329259SAli.Saidi@ARM.com * valid. 5339259SAli.Saidi@ARM.com */ 5349259SAli.Saidi@ARM.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5359259SAli.Saidi@ARM.com 5366227Snate@binkert.org unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 53710938Sandreas.hansson@arm.com 53810938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 53910938Sandreas.hansson@arm.com { 54010938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 54110938Sandreas.hansson@arm.com } 54210938Sandreas.hansson@arm.com 54310938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 54410938Sandreas.hansson@arm.com { 54510938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 54610938Sandreas.hansson@arm.com } 5472549SN/A 54810028SGiacomo.Gabrielli@arm.com bool isSecure() const 54910028SGiacomo.Gabrielli@arm.com { 55010028SGiacomo.Gabrielli@arm.com assert(flags.isSet(VALID_ADDR)); 55110028SGiacomo.Gabrielli@arm.com return _isSecure; 55210028SGiacomo.Gabrielli@arm.com } 55310028SGiacomo.Gabrielli@arm.com 5545735Snate@binkert.org /** 5557550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 55610938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 5577550SBrad.Beckmann@amd.com */ 5587550SBrad.Beckmann@amd.com void 5597550SBrad.Beckmann@amd.com convertScToWrite() 5607550SBrad.Beckmann@amd.com { 5617550SBrad.Beckmann@amd.com assert(isLLSC()); 5627550SBrad.Beckmann@amd.com assert(isWrite()); 5637550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5647550SBrad.Beckmann@amd.com } 5657550SBrad.Beckmann@amd.com 5667550SBrad.Beckmann@amd.com /** 56710938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 56810938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 5697550SBrad.Beckmann@amd.com */ 5707550SBrad.Beckmann@amd.com void 5717550SBrad.Beckmann@amd.com convertLlToRead() 5727550SBrad.Beckmann@amd.com { 5737550SBrad.Beckmann@amd.com assert(isLLSC()); 5747550SBrad.Beckmann@amd.com assert(isRead()); 5757550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5767550SBrad.Beckmann@amd.com } 5777550SBrad.Beckmann@amd.com 5787550SBrad.Beckmann@amd.com /** 57910938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 5805735Snate@binkert.org * first, but the Requests's physical address and size fields need 5819030Sandreas.hansson@arm.com * not be valid. The command must be supplied. 5825735Snate@binkert.org */ 58310569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 58410360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 58510723Sandreas.hansson@arm.com size(0), headerDelay(0), payloadDelay(0), 5869546Sandreas.hansson@arm.com senderState(NULL) 5872641Sstever@eecs.umich.edu { 5886104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 5896104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 5906104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 59110028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 5926104Ssteve.reinhardt@amd.com } 5936104Ssteve.reinhardt@amd.com if (req->hasSize()) { 5946104Ssteve.reinhardt@amd.com size = req->getSize(); 5956104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 5966104Ssteve.reinhardt@amd.com } 5972813Srdreslin@umich.edu } 5982813Srdreslin@umich.edu 5995735Snate@binkert.org /** 6005735Snate@binkert.org * Alternate constructor if you are trying to create a packet with 6015735Snate@binkert.org * a request that is for a whole block, not the address from the 6025735Snate@binkert.org * req. this allows for overriding the size/addr of the req. 6035735Snate@binkert.org */ 60410569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 60510360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 60610694SMarco.Balboni@ARM.com headerDelay(0), payloadDelay(0), 6079546Sandreas.hansson@arm.com senderState(NULL) 6082813Srdreslin@umich.edu { 6096104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 6106104Ssteve.reinhardt@amd.com addr = req->getPaddr() & ~(_blkSize - 1); 6116104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 61210028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6136104Ssteve.reinhardt@amd.com } 6146104Ssteve.reinhardt@amd.com size = _blkSize; 6156104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6164626Sstever@eecs.umich.edu } 6174626Sstever@eecs.umich.edu 6185735Snate@binkert.org /** 6195735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6204887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6214887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6224887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6235735Snate@binkert.org * packet should allocate its own data. 6245735Snate@binkert.org */ 62510896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 6265735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 62710571Sandreas.hansson@arm.com data(nullptr), 62810028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 62910723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 63010694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 63110694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 6329546Sandreas.hansson@arm.com senderState(pkt->senderState) 6334626Sstever@eecs.umich.edu { 63410571Sandreas.hansson@arm.com if (!clear_flags) 6355735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6365735Snate@binkert.org 6379031Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 63810565Sandreas.hansson@arm.com 63910571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 64010571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 64110571Sandreas.hansson@arm.com // co-ordinate state changes 64210571Sandreas.hansson@arm.com if (alloc_data) { 64310571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 64410571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 64510571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 64610571Sandreas.hansson@arm.com // carry the pointer forward 64710571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 64810571Sandreas.hansson@arm.com data = pkt->data; 64910571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 65010571Sandreas.hansson@arm.com } else { 65110571Sandreas.hansson@arm.com allocate(); 65210571Sandreas.hansson@arm.com } 65310571Sandreas.hansson@arm.com } 65410342SCurtis.Dunham@arm.com } 6558668Sgeoffrey.blake@arm.com 65610342SCurtis.Dunham@arm.com /** 65710739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 65810342SCurtis.Dunham@arm.com */ 65910739Ssteve.reinhardt@amd.com static MemCmd 66010739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 66110342SCurtis.Dunham@arm.com { 66210739Ssteve.reinhardt@amd.com if (req->isLLSC()) 66310739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 66410739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 66510739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 66610739Ssteve.reinhardt@amd.com else 66710739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 66810739Ssteve.reinhardt@amd.com } 66910739Ssteve.reinhardt@amd.com 67010739Ssteve.reinhardt@amd.com /** 67110739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 67210739Ssteve.reinhardt@amd.com */ 67310739Ssteve.reinhardt@amd.com static MemCmd 67410739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 67510739Ssteve.reinhardt@amd.com { 67610739Ssteve.reinhardt@amd.com if (req->isLLSC()) 67710739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 67810739Ssteve.reinhardt@amd.com else if (req->isSwap()) 67910739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 68010739Ssteve.reinhardt@amd.com else 68110739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 68210342SCurtis.Dunham@arm.com } 68310342SCurtis.Dunham@arm.com 68410342SCurtis.Dunham@arm.com /** 68510342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 68610739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 68710342SCurtis.Dunham@arm.com */ 68810342SCurtis.Dunham@arm.com static PacketPtr 68910569Sandreas.hansson@arm.com createRead(const RequestPtr req) 69010342SCurtis.Dunham@arm.com { 69110739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 69210342SCurtis.Dunham@arm.com } 69310342SCurtis.Dunham@arm.com 69410342SCurtis.Dunham@arm.com static PacketPtr 69510569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 69610342SCurtis.Dunham@arm.com { 69710739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 6982641Sstever@eecs.umich.edu } 6992549SN/A 7005735Snate@binkert.org /** 7015735Snate@binkert.org * clean up packet variables 7025735Snate@binkert.org */ 7032566SN/A ~Packet() 7045387Sstever@gmail.com { 70510872Sali.jafri@arm.com // Delete the request object if this is a request packet which 70610872Sali.jafri@arm.com // does not need a response, because the requester will not get 70710872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 70810872Sali.jafri@arm.com // request will be deleted on receipt of the response 70910872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 71010872Sali.jafri@arm.com // express snoops, even for cases when responses are not 71110872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 71210872Sali.jafri@arm.com // re-uses the same request. 71310872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 71410872Sali.jafri@arm.com !isExpressSnoop()) { 7155387Sstever@gmail.com delete req; 71610872Sali.jafri@arm.com } 7175735Snate@binkert.org deleteData(); 7185387Sstever@gmail.com } 7192566SN/A 7205735Snate@binkert.org /** 7214626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 72210660Sandreas.hansson@arm.com * returning as a response to that request. 7234626Sstever@eecs.umich.edu */ 7245735Snate@binkert.org void 7255735Snate@binkert.org makeResponse() 7264626Sstever@eecs.umich.edu { 7272662Sstever@eecs.umich.edu assert(needsResponse()); 7282855Srdreslin@umich.edu assert(isRequest()); 7294022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7305745Snate@binkert.org 7317464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7327464Ssteve.reinhardt@amd.com // triggered them was 7337464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7342641Sstever@eecs.umich.edu } 7352641Sstever@eecs.umich.edu 7365735Snate@binkert.org void 7375735Snate@binkert.org makeAtomicResponse() 7384870Sstever@eecs.umich.edu { 7394870Sstever@eecs.umich.edu makeResponse(); 7404870Sstever@eecs.umich.edu } 7414870Sstever@eecs.umich.edu 7425735Snate@binkert.org void 7435735Snate@binkert.org makeTimingResponse() 7443348Sbinkertn@umich.edu { 7454870Sstever@eecs.umich.edu makeResponse(); 7463135Srdreslin@umich.edu } 7473135Srdreslin@umich.edu 7488436SBrad.Beckmann@amd.com void 7498436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7508436SBrad.Beckmann@amd.com { 7518436SBrad.Beckmann@amd.com if (!success) { 7528436SBrad.Beckmann@amd.com if (isWrite()) { 7538436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7548436SBrad.Beckmann@amd.com } else { 7558436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7568436SBrad.Beckmann@amd.com } 7578436SBrad.Beckmann@amd.com } 7588436SBrad.Beckmann@amd.com } 7598436SBrad.Beckmann@amd.com 7607006Snate@binkert.org void 7617006Snate@binkert.org setSize(unsigned size) 7627006Snate@binkert.org { 7637006Snate@binkert.org assert(!flags.isSet(VALID_SIZE)); 7647006Snate@binkert.org 7657006Snate@binkert.org this->size = size; 7667006Snate@binkert.org flags.set(VALID_SIZE); 7677006Snate@binkert.org } 7687006Snate@binkert.org 7692685Ssaidi@eecs.umich.edu 77011013Sandreas.sandberg@arm.com public: 77111013Sandreas.sandberg@arm.com /** 77211013Sandreas.sandberg@arm.com * @{ 77311013Sandreas.sandberg@arm.com * @name Data accessor mehtods 77411013Sandreas.sandberg@arm.com */ 77511013Sandreas.sandberg@arm.com 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 /** 85411013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 85511013Sandreas.sandberg@arm.com * host endian. 85611013Sandreas.sandberg@arm.com */ 85711013Sandreas.sandberg@arm.com template <typename T> 85811013Sandreas.sandberg@arm.com T getBE() const; 85911013Sandreas.sandberg@arm.com 86011013Sandreas.sandberg@arm.com /** 86111013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 86211013Sandreas.sandberg@arm.com * host endian. 86311013Sandreas.sandberg@arm.com */ 86411013Sandreas.sandberg@arm.com template <typename T> 86511013Sandreas.sandberg@arm.com T getLE() const; 86611013Sandreas.sandberg@arm.com 86711013Sandreas.sandberg@arm.com /** 86811013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 86911013Sandreas.sandberg@arm.com * endianness. 87011013Sandreas.sandberg@arm.com */ 87111013Sandreas.sandberg@arm.com template <typename T> 87211013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 87311013Sandreas.sandberg@arm.com 87411013Sandreas.sandberg@arm.com /** 87511013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 87611013Sandreas.sandberg@arm.com * endian. 8775735Snate@binkert.org */ 8782566SN/A template <typename T> 87910563Sandreas.hansson@arm.com T get() const; 8802566SN/A 88111013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 88211013Sandreas.sandberg@arm.com template <typename T> 88311013Sandreas.sandberg@arm.com void setBE(T v); 88411013Sandreas.sandberg@arm.com 88511013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 88611013Sandreas.sandberg@arm.com template <typename T> 88711013Sandreas.sandberg@arm.com void setLE(T v); 88811013Sandreas.sandberg@arm.com 8895735Snate@binkert.org /** 89011013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 89111013Sandreas.sandberg@arm.com * endianness. 8925735Snate@binkert.org */ 8932566SN/A template <typename T> 89411013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 89511013Sandreas.sandberg@arm.com 89611013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 89711013Sandreas.sandberg@arm.com template <typename T> 8982592SN/A void set(T v); 8992566SN/A 9003348Sbinkertn@umich.edu /** 9014626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 9024626Sstever@eecs.umich.edu */ 9035735Snate@binkert.org void 90410563Sandreas.hansson@arm.com setData(const uint8_t *p) 9054626Sstever@eecs.umich.edu { 90610571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 90710571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 90810571Sandreas.hansson@arm.com // same pointer from source to destination and back 90910571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 91010571Sandreas.hansson@arm.com 9117691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 91210571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 91310571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 9147691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 9154626Sstever@eecs.umich.edu } 9164626Sstever@eecs.umich.edu 9174626Sstever@eecs.umich.edu /** 9184626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 9194626Sstever@eecs.umich.edu * which is aligned to the given block size. 9204626Sstever@eecs.umich.edu */ 9215735Snate@binkert.org void 92210563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 9234626Sstever@eecs.umich.edu { 9244626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 9254626Sstever@eecs.umich.edu } 9264626Sstever@eecs.umich.edu 9274626Sstever@eecs.umich.edu /** 9284626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 9294626Sstever@eecs.umich.edu * is aligned to the given block size. 9304626Sstever@eecs.umich.edu */ 9315735Snate@binkert.org void 93210563Sandreas.hansson@arm.com writeData(uint8_t *p) const 9334626Sstever@eecs.umich.edu { 93410563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 9354626Sstever@eecs.umich.edu } 9364626Sstever@eecs.umich.edu 9374626Sstever@eecs.umich.edu /** 9384626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 9394626Sstever@eecs.umich.edu */ 9405735Snate@binkert.org void 94110563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 9424626Sstever@eecs.umich.edu { 9434626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 9444626Sstever@eecs.umich.edu } 9454626Sstever@eecs.umich.edu 9464626Sstever@eecs.umich.edu /** 9473348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 9483348Sbinkertn@umich.edu * matter how data was allocted. 9493348Sbinkertn@umich.edu */ 9505735Snate@binkert.org void 9515735Snate@binkert.org deleteData() 9525735Snate@binkert.org { 95310566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 9545735Snate@binkert.org delete [] data; 9555735Snate@binkert.org 95610566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 9575735Snate@binkert.org data = NULL; 9585735Snate@binkert.org } 9592566SN/A 96010565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9615735Snate@binkert.org void 9625735Snate@binkert.org allocate() 9635735Snate@binkert.org { 9645764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 96510566Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 9665745Snate@binkert.org data = new uint8_t[getSize()]; 9675735Snate@binkert.org } 9685735Snate@binkert.org 96911013Sandreas.sandberg@arm.com /** @} */ 97011013Sandreas.sandberg@arm.com 97111013Sandreas.sandberg@arm.com private: // Private data accessor methods 97211013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 97311013Sandreas.sandberg@arm.com template <typename T> 97411013Sandreas.sandberg@arm.com T getRaw() const; 97511013Sandreas.sandberg@arm.com 97611013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 97711013Sandreas.sandberg@arm.com template <typename T> 97811013Sandreas.sandberg@arm.com void setRaw(T v); 97911013Sandreas.sandberg@arm.com 98011013Sandreas.sandberg@arm.com public: 9814626Sstever@eecs.umich.edu /** 98210570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 98310570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 98410570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 98510570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 98610570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 98710570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 98810570Sandreas.hansson@arm.com * accordingly. 98910570Sandreas.hansson@arm.com */ 99010570Sandreas.hansson@arm.com bool 99110570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 99210570Sandreas.hansson@arm.com { 99310570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 99410570Sandreas.hansson@arm.com // data pointer 99510570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 99610570Sandreas.hansson@arm.com other->getSize(), 99710570Sandreas.hansson@arm.com other->hasData() ? 99810570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 99910570Sandreas.hansson@arm.com } 100010570Sandreas.hansson@arm.com 100110570Sandreas.hansson@arm.com /** 100210883Sali.jafri@arm.com * Is this request notification of a clean or dirty eviction from the cache. 100310883Sali.jafri@arm.com **/ 100410883Sali.jafri@arm.com bool 100510883Sali.jafri@arm.com evictingBlock() const 100610883Sali.jafri@arm.com { 100710883Sali.jafri@arm.com return (cmd == MemCmd::Writeback || 100810883Sali.jafri@arm.com cmd == MemCmd::CleanEvict); 100910883Sali.jafri@arm.com } 101010883Sali.jafri@arm.com 101110883Sali.jafri@arm.com /** 101210883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 101310883Sali.jafri@arm.com * in the memory hierarchy above. 101410883Sali.jafri@arm.com **/ 101510883Sali.jafri@arm.com bool 101610883Sali.jafri@arm.com mustCheckAbove() const 101710883Sali.jafri@arm.com { 101810883Sali.jafri@arm.com return (cmd == MemCmd::HardPFReq || 101910883Sali.jafri@arm.com evictingBlock()); 102010883Sali.jafri@arm.com } 102110883Sali.jafri@arm.com 102210883Sali.jafri@arm.com /** 10234626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 102410570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 102510570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 102610570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 10274626Sstever@eecs.umich.edu * memory value. 10284626Sstever@eecs.umich.edu */ 10295735Snate@binkert.org bool 103010570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 103110570Sandreas.hansson@arm.com uint8_t *_data); 10325314Sstever@gmail.com 10335315Sstever@gmail.com /** 10345315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 10355315Sstever@gmail.com */ 10365735Snate@binkert.org void 10375735Snate@binkert.org pushLabel(const std::string &lbl) 10385735Snate@binkert.org { 10395735Snate@binkert.org if (isPrint()) 10405735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 10415314Sstever@gmail.com } 10425314Sstever@gmail.com 10435315Sstever@gmail.com /** 10445315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 10455315Sstever@gmail.com */ 10465735Snate@binkert.org void 10475735Snate@binkert.org popLabel() 10485735Snate@binkert.org { 10495735Snate@binkert.org if (isPrint()) 10505735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 10515314Sstever@gmail.com } 10525314Sstever@gmail.com 10535314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 10545314Sstever@gmail.com const std::string &prefix = "") const; 10559663Suri.wiener@arm.com 10569663Suri.wiener@arm.com /** 10579663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 10589663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 10599663Suri.wiener@arm.com * avoiding string overheads in fast mode 10609663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 10619663Suri.wiener@arm.com */ 10629663Suri.wiener@arm.com std::string print() const; 10632381SN/A}; 10642381SN/A 10652381SN/A#endif //__MEM_PACKET_HH 1066