packet.hh revision 11127
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 25811057Sandreas.hansson@arm.com /// Are the 'addr' and 'size' fields valid? 25911057Sandreas.hansson@arm.com VALID_ADDR = 0x00000100, 26011057Sandreas.hansson@arm.com VALID_SIZE = 0x00000200, 26111057Sandreas.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 /** 32711127Sandreas.hansson@arm.com * Keep track of the extra delay incurred by snooping upwards 32811127Sandreas.hansson@arm.com * before sending a request down the memory system. This is used 32911127Sandreas.hansson@arm.com * by the coherent crossbar to account for the additional request 33011127Sandreas.hansson@arm.com * delay. 33111127Sandreas.hansson@arm.com */ 33211127Sandreas.hansson@arm.com uint32_t snoopDelay; 33311127Sandreas.hansson@arm.com 33411127Sandreas.hansson@arm.com /** 33510694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 33610694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 33710694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 33810694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 33910405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 34010405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3419547Sandreas.hansson@arm.com */ 34210694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3433218Sgblack@eecs.umich.edu 3445735Snate@binkert.org /** 3455735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3469542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3479542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3489542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3499542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3509542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3519542Sandreas.hansson@arm.com * particular sending device. 3529542Sandreas.hansson@arm.com * 3539542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3549542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3559542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3569542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3579542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3589542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3599542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3605735Snate@binkert.org */ 3615735Snate@binkert.org struct SenderState 3625735Snate@binkert.org { 3639542Sandreas.hansson@arm.com SenderState* predecessor; 3649542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3652641Sstever@eecs.umich.edu virtual ~SenderState() {} 3662641Sstever@eecs.umich.edu }; 3672641Sstever@eecs.umich.edu 3685315Sstever@gmail.com /** 3695315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3705315Sstever@gmail.com * field of a PrintReq should always be of this type. 3715315Sstever@gmail.com */ 3729044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3735735Snate@binkert.org { 3745735Snate@binkert.org private: 3755735Snate@binkert.org /** 3765735Snate@binkert.org * An entry in the label stack. 3775735Snate@binkert.org */ 3785735Snate@binkert.org struct LabelStackEntry 3795735Snate@binkert.org { 3805314Sstever@gmail.com const std::string label; 3815314Sstever@gmail.com std::string *prefix; 3825314Sstever@gmail.com bool labelPrinted; 3835735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3845314Sstever@gmail.com }; 3855314Sstever@gmail.com 3865314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3875314Sstever@gmail.com LabelStack labelStack; 3885314Sstever@gmail.com 3895314Sstever@gmail.com std::string *curPrefixPtr; 3905314Sstever@gmail.com 3915314Sstever@gmail.com public: 3925314Sstever@gmail.com std::ostream &os; 3935314Sstever@gmail.com const int verbosity; 3945314Sstever@gmail.com 3955314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 3965314Sstever@gmail.com ~PrintReqState(); 3975314Sstever@gmail.com 3985735Snate@binkert.org /** 3995735Snate@binkert.org * Returns the current line prefix. 4005735Snate@binkert.org */ 4015314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4025315Sstever@gmail.com 4035735Snate@binkert.org /** 4045735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4055315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4065735Snate@binkert.org * printed if an object within the label's scope is printed. 4075735Snate@binkert.org */ 4085314Sstever@gmail.com void pushLabel(const std::string &lbl, 4095314Sstever@gmail.com const std::string &prefix = " "); 4105735Snate@binkert.org 4115735Snate@binkert.org /** 4125735Snate@binkert.org * Pop a label off the label stack. 4135735Snate@binkert.org */ 4145314Sstever@gmail.com void popLabel(); 4155735Snate@binkert.org 4165735Snate@binkert.org /** 4175735Snate@binkert.org * Print all of the pending unprinted labels on the 4185315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4195735Snate@binkert.org * users unless bypassing printObj(). 4205735Snate@binkert.org */ 4215314Sstever@gmail.com void printLabels(); 4225735Snate@binkert.org 4235735Snate@binkert.org /** 4245735Snate@binkert.org * Print a Printable object to os, because it matched the 4255735Snate@binkert.org * address on a PrintReq. 4265735Snate@binkert.org */ 4275314Sstever@gmail.com void printObj(Printable *obj); 4285314Sstever@gmail.com }; 4295314Sstever@gmail.com 4305735Snate@binkert.org /** 4315735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4325735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4335735Snate@binkert.org * this variable is to allow a device to attach extra information 4349542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4355735Snate@binkert.org * that was attached to the original request (even if a new packet 4365735Snate@binkert.org * is created). 4375735Snate@binkert.org */ 4382662Sstever@eecs.umich.edu SenderState *senderState; 4392641Sstever@eecs.umich.edu 4409542Sandreas.hansson@arm.com /** 4419542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4429542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4439542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4449542Sandreas.hansson@arm.com * variable. 4459542Sandreas.hansson@arm.com * 4469542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4479542Sandreas.hansson@arm.com */ 4489542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4499542Sandreas.hansson@arm.com 4509542Sandreas.hansson@arm.com /** 4519542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4529542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4539542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4549542Sandreas.hansson@arm.com * variable. 4559542Sandreas.hansson@arm.com * 4569542Sandreas.hansson@arm.com * @return The current top of the stack 4579542Sandreas.hansson@arm.com */ 4589542Sandreas.hansson@arm.com SenderState *popSenderState(); 4599542Sandreas.hansson@arm.com 4609543Ssascha.bischoff@arm.com /** 4619543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4629543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4639543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4649543Ssascha.bischoff@arm.com * 4659543Ssascha.bischoff@arm.com * @return The topmost state of type T 4669543Ssascha.bischoff@arm.com */ 4679543Ssascha.bischoff@arm.com template <typename T> 4689543Ssascha.bischoff@arm.com T * findNextSenderState() const 4699543Ssascha.bischoff@arm.com { 4709543Ssascha.bischoff@arm.com T *t = NULL; 4719543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4729543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4739543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4749543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4759543Ssascha.bischoff@arm.com } 4769543Ssascha.bischoff@arm.com return t; 4779543Ssascha.bischoff@arm.com } 4789543Ssascha.bischoff@arm.com 4795735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4805735Snate@binkert.org /// tracing). 4814022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4822811Srdreslin@umich.edu 4835735Snate@binkert.org /// Return the index of this command. 4844022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4852811Srdreslin@umich.edu 48610583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 48710583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 48810583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 48910583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 49010583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 49110583SCurtis.Dunham@arm.com bool needsExclusive() const { return cmd.needsExclusive(); } 49210583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 49310583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 49410583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 49510583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 49610583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 49710583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 49810583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 4992812Srdreslin@umich.edu 5004870Sstever@eecs.umich.edu // Snoop flags 50110567Sandreas.hansson@arm.com void assertMemInhibit() 50210567Sandreas.hansson@arm.com { 50310567Sandreas.hansson@arm.com assert(isRequest()); 50410567Sandreas.hansson@arm.com assert(!flags.isSet(MEM_INHIBIT)); 50510567Sandreas.hansson@arm.com flags.set(MEM_INHIBIT); 50610567Sandreas.hansson@arm.com } 5079951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 5089951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 5099951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 5104870Sstever@eecs.umich.edu 5114895Sstever@eecs.umich.edu // Special control flags 5129951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5139951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5149951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5159951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5169951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5179951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 51810763Sali.jafri@arm.com void setBlockCached() { flags.set(BLOCK_CACHED); } 51910763Sali.jafri@arm.com bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 52010883Sali.jafri@arm.com void clearBlockCached() { flags.clear(BLOCK_CACHED); } 5214895Sstever@eecs.umich.edu 5224870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5234870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5244870Sstever@eecs.umich.edu // field, etc.) 5255735Snate@binkert.org void 5265735Snate@binkert.org setBadAddress() 5275735Snate@binkert.org { 5285735Snate@binkert.org assert(isResponse()); 5295735Snate@binkert.org cmd = MemCmd::BadAddressError; 5305735Snate@binkert.org } 5315735Snate@binkert.org 5324986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5332814Srdreslin@umich.edu 53411057Sandreas.hansson@arm.com Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5359259SAli.Saidi@ARM.com /** 5369259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5379259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5389259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5399259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5409259SAli.Saidi@ARM.com * valid. 5419259SAli.Saidi@ARM.com */ 54211057Sandreas.hansson@arm.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5439259SAli.Saidi@ARM.com 54411057Sandreas.hansson@arm.com unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 54510938Sandreas.hansson@arm.com 54610938Sandreas.hansson@arm.com Addr getOffset(unsigned int blk_size) const 54710938Sandreas.hansson@arm.com { 54810938Sandreas.hansson@arm.com return getAddr() & Addr(blk_size - 1); 54910938Sandreas.hansson@arm.com } 55010938Sandreas.hansson@arm.com 55110938Sandreas.hansson@arm.com Addr getBlockAddr(unsigned int blk_size) const 55210938Sandreas.hansson@arm.com { 55310938Sandreas.hansson@arm.com return getAddr() & ~(Addr(blk_size - 1)); 55410938Sandreas.hansson@arm.com } 5552549SN/A 55611057Sandreas.hansson@arm.com bool isSecure() const 55711057Sandreas.hansson@arm.com { 55811057Sandreas.hansson@arm.com assert(flags.isSet(VALID_ADDR)); 55911057Sandreas.hansson@arm.com return _isSecure; 56011057Sandreas.hansson@arm.com } 56110028SGiacomo.Gabrielli@arm.com 5625735Snate@binkert.org /** 5637550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 56410938Sandreas.hansson@arm.com * memory. Therefore, convert this SC packet to a normal write. 5657550SBrad.Beckmann@amd.com */ 5667550SBrad.Beckmann@amd.com void 5677550SBrad.Beckmann@amd.com convertScToWrite() 5687550SBrad.Beckmann@amd.com { 5697550SBrad.Beckmann@amd.com assert(isLLSC()); 5707550SBrad.Beckmann@amd.com assert(isWrite()); 5717550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5727550SBrad.Beckmann@amd.com } 5737550SBrad.Beckmann@amd.com 5747550SBrad.Beckmann@amd.com /** 57510938Sandreas.hansson@arm.com * When ruby is in use, Ruby will monitor the cache line and the 57610938Sandreas.hansson@arm.com * phys memory should treat LL ops as normal reads. 5777550SBrad.Beckmann@amd.com */ 5787550SBrad.Beckmann@amd.com void 5797550SBrad.Beckmann@amd.com convertLlToRead() 5807550SBrad.Beckmann@amd.com { 5817550SBrad.Beckmann@amd.com assert(isLLSC()); 5827550SBrad.Beckmann@amd.com assert(isRead()); 5837550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5847550SBrad.Beckmann@amd.com } 5857550SBrad.Beckmann@amd.com 5867550SBrad.Beckmann@amd.com /** 58710938Sandreas.hansson@arm.com * Constructor. Note that a Request object must be constructed 58811057Sandreas.hansson@arm.com * first, but the Requests's physical address and size fields need 58911057Sandreas.hansson@arm.com * not be valid. The command must be supplied. 5905735Snate@binkert.org */ 59110569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 59211057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 59311127Sandreas.hansson@arm.com size(0), headerDelay(0), snoopDelay(0), payloadDelay(0), 59411057Sandreas.hansson@arm.com senderState(NULL) 59511057Sandreas.hansson@arm.com { 59611057Sandreas.hansson@arm.com if (req->hasPaddr()) { 59711057Sandreas.hansson@arm.com addr = req->getPaddr(); 59811057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 59911057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 60011057Sandreas.hansson@arm.com } 60111057Sandreas.hansson@arm.com if (req->hasSize()) { 60211057Sandreas.hansson@arm.com size = req->getSize(); 60311057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 60411057Sandreas.hansson@arm.com } 60511057Sandreas.hansson@arm.com } 60611057Sandreas.hansson@arm.com 60711057Sandreas.hansson@arm.com /** 60811057Sandreas.hansson@arm.com * Alternate constructor if you are trying to create a packet with 60911057Sandreas.hansson@arm.com * a request that is for a whole block, not the address from the 61011057Sandreas.hansson@arm.com * req. this allows for overriding the size/addr of the req. 61111057Sandreas.hansson@arm.com */ 61211057Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 61311057Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 61411127Sandreas.hansson@arm.com headerDelay(0), snoopDelay(0), payloadDelay(0), 6159546Sandreas.hansson@arm.com senderState(NULL) 61611057Sandreas.hansson@arm.com { 61711057Sandreas.hansson@arm.com if (req->hasPaddr()) { 61811057Sandreas.hansson@arm.com addr = req->getPaddr() & ~(_blkSize - 1); 61911057Sandreas.hansson@arm.com flags.set(VALID_ADDR); 62011057Sandreas.hansson@arm.com _isSecure = req->isSecure(); 62111057Sandreas.hansson@arm.com } 62211057Sandreas.hansson@arm.com size = _blkSize; 62311057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 62411057Sandreas.hansson@arm.com } 6254626Sstever@eecs.umich.edu 6265735Snate@binkert.org /** 6275735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6284887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6294887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6304887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6315735Snate@binkert.org * packet should allocate its own data. 6325735Snate@binkert.org */ 63310896Snilay@cs.wisc.edu Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 6345735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 63510571Sandreas.hansson@arm.com data(nullptr), 63610028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 63710723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 63810694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 63911127Sandreas.hansson@arm.com snoopDelay(0), 64010694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 6419546Sandreas.hansson@arm.com senderState(pkt->senderState) 6424626Sstever@eecs.umich.edu { 64310571Sandreas.hansson@arm.com if (!clear_flags) 6445735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6455735Snate@binkert.org 64611057Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 64711057Sandreas.hansson@arm.com 64810571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 64910571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 65010571Sandreas.hansson@arm.com // co-ordinate state changes 65110571Sandreas.hansson@arm.com if (alloc_data) { 65210571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 65310571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 65410571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 65510571Sandreas.hansson@arm.com // carry the pointer forward 65610571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 65710571Sandreas.hansson@arm.com data = pkt->data; 65810571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 65910571Sandreas.hansson@arm.com } else { 66010571Sandreas.hansson@arm.com allocate(); 66110571Sandreas.hansson@arm.com } 66210571Sandreas.hansson@arm.com } 66310342SCurtis.Dunham@arm.com } 6648668Sgeoffrey.blake@arm.com 66510342SCurtis.Dunham@arm.com /** 66610739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 66710342SCurtis.Dunham@arm.com */ 66810739Ssteve.reinhardt@amd.com static MemCmd 66910739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 67010342SCurtis.Dunham@arm.com { 67110739Ssteve.reinhardt@amd.com if (req->isLLSC()) 67210739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 67310739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 67410739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 67510739Ssteve.reinhardt@amd.com else 67610739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 67710739Ssteve.reinhardt@amd.com } 67810739Ssteve.reinhardt@amd.com 67910739Ssteve.reinhardt@amd.com /** 68010739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 68110739Ssteve.reinhardt@amd.com */ 68210739Ssteve.reinhardt@amd.com static MemCmd 68310739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 68410739Ssteve.reinhardt@amd.com { 68510739Ssteve.reinhardt@amd.com if (req->isLLSC()) 68610739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 68710739Ssteve.reinhardt@amd.com else if (req->isSwap()) 68810739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 68910739Ssteve.reinhardt@amd.com else 69010739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 69110342SCurtis.Dunham@arm.com } 69210342SCurtis.Dunham@arm.com 69310342SCurtis.Dunham@arm.com /** 69410342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 69510739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 69610342SCurtis.Dunham@arm.com */ 69710342SCurtis.Dunham@arm.com static PacketPtr 69810569Sandreas.hansson@arm.com createRead(const RequestPtr req) 69910342SCurtis.Dunham@arm.com { 70010739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 70110342SCurtis.Dunham@arm.com } 70210342SCurtis.Dunham@arm.com 70310342SCurtis.Dunham@arm.com static PacketPtr 70410569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 70510342SCurtis.Dunham@arm.com { 70610739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 7072641Sstever@eecs.umich.edu } 7082549SN/A 7095735Snate@binkert.org /** 7105735Snate@binkert.org * clean up packet variables 7115735Snate@binkert.org */ 7122566SN/A ~Packet() 7135387Sstever@gmail.com { 71410872Sali.jafri@arm.com // Delete the request object if this is a request packet which 71510872Sali.jafri@arm.com // does not need a response, because the requester will not get 71610872Sali.jafri@arm.com // a chance. If the request packet needs a response then the 71710872Sali.jafri@arm.com // request will be deleted on receipt of the response 71810872Sali.jafri@arm.com // packet. We also make sure to never delete the request for 71910872Sali.jafri@arm.com // express snoops, even for cases when responses are not 72010872Sali.jafri@arm.com // needed (CleanEvict and Writeback), since the snoop packet 72110872Sali.jafri@arm.com // re-uses the same request. 72210872Sali.jafri@arm.com if (req && isRequest() && !needsResponse() && 72310872Sali.jafri@arm.com !isExpressSnoop()) { 7245387Sstever@gmail.com delete req; 72510872Sali.jafri@arm.com } 7265735Snate@binkert.org deleteData(); 7275387Sstever@gmail.com } 7282566SN/A 7295735Snate@binkert.org /** 7304626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 73110660Sandreas.hansson@arm.com * returning as a response to that request. 7324626Sstever@eecs.umich.edu */ 7335735Snate@binkert.org void 7345735Snate@binkert.org makeResponse() 7354626Sstever@eecs.umich.edu { 7362662Sstever@eecs.umich.edu assert(needsResponse()); 7372855Srdreslin@umich.edu assert(isRequest()); 7384022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7395745Snate@binkert.org 7407464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7417464Ssteve.reinhardt@amd.com // triggered them was 7427464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7432641Sstever@eecs.umich.edu } 7442641Sstever@eecs.umich.edu 7455735Snate@binkert.org void 7465735Snate@binkert.org makeAtomicResponse() 7474870Sstever@eecs.umich.edu { 7484870Sstever@eecs.umich.edu makeResponse(); 7494870Sstever@eecs.umich.edu } 7504870Sstever@eecs.umich.edu 7515735Snate@binkert.org void 7525735Snate@binkert.org makeTimingResponse() 7533348Sbinkertn@umich.edu { 7544870Sstever@eecs.umich.edu makeResponse(); 7553135Srdreslin@umich.edu } 7563135Srdreslin@umich.edu 7578436SBrad.Beckmann@amd.com void 7588436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7598436SBrad.Beckmann@amd.com { 7608436SBrad.Beckmann@amd.com if (!success) { 7618436SBrad.Beckmann@amd.com if (isWrite()) { 7628436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7638436SBrad.Beckmann@amd.com } else { 7648436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7658436SBrad.Beckmann@amd.com } 7668436SBrad.Beckmann@amd.com } 7678436SBrad.Beckmann@amd.com } 7688436SBrad.Beckmann@amd.com 76911057Sandreas.hansson@arm.com void 77011057Sandreas.hansson@arm.com setSize(unsigned size) 77111057Sandreas.hansson@arm.com { 77211057Sandreas.hansson@arm.com assert(!flags.isSet(VALID_SIZE)); 77311057Sandreas.hansson@arm.com 77411057Sandreas.hansson@arm.com this->size = size; 77511057Sandreas.hansson@arm.com flags.set(VALID_SIZE); 77611057Sandreas.hansson@arm.com } 77711057Sandreas.hansson@arm.com 77811057Sandreas.hansson@arm.com 77911013Sandreas.sandberg@arm.com public: 78011013Sandreas.sandberg@arm.com /** 78111013Sandreas.sandberg@arm.com * @{ 78211013Sandreas.sandberg@arm.com * @name Data accessor mehtods 78311013Sandreas.sandberg@arm.com */ 78411013Sandreas.sandberg@arm.com 7853348Sbinkertn@umich.edu /** 7863348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 78710571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 78810571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 78910571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 79010571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 79110571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 79210571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 79310571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 79410571Sandreas.hansson@arm.com * to the source, no copies are necessary. 7952566SN/A */ 7962566SN/A template <typename T> 7973348Sbinkertn@umich.edu void 7983348Sbinkertn@umich.edu dataStatic(T *p) 7993348Sbinkertn@umich.edu { 80010566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8013348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8025735Snate@binkert.org flags.set(STATIC_DATA); 8033348Sbinkertn@umich.edu } 8042566SN/A 8053348Sbinkertn@umich.edu /** 80610564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 80710564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 80810564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 80910564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 81010564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 81110564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 81210564Sandreas.hansson@arm.com */ 81310564Sandreas.hansson@arm.com template <typename T> 81410564Sandreas.hansson@arm.com void 81510564Sandreas.hansson@arm.com dataStaticConst(const T *p) 81610564Sandreas.hansson@arm.com { 81710566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 81810564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 81910564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 82010564Sandreas.hansson@arm.com } 82110564Sandreas.hansson@arm.com 82210564Sandreas.hansson@arm.com /** 8233348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 82410571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 82510571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 82610571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 82710571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 82810571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 82910571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 83010571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 83110571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 83210571Sandreas.hansson@arm.com * before it is deallocated. 8333348Sbinkertn@umich.edu */ 8342566SN/A template <typename T> 8353348Sbinkertn@umich.edu void 8363348Sbinkertn@umich.edu dataDynamic(T *p) 8373348Sbinkertn@umich.edu { 83810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8393348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8405735Snate@binkert.org flags.set(DYNAMIC_DATA); 8413348Sbinkertn@umich.edu } 8423348Sbinkertn@umich.edu 8435735Snate@binkert.org /** 8445735Snate@binkert.org * get a pointer to the data ptr. 8455735Snate@binkert.org */ 8463348Sbinkertn@umich.edu template <typename T> 8473348Sbinkertn@umich.edu T* 84810562Sandreas.hansson@arm.com getPtr() 8493348Sbinkertn@umich.edu { 85010562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8513348Sbinkertn@umich.edu return (T*)data; 8523348Sbinkertn@umich.edu } 8532566SN/A 85410563Sandreas.hansson@arm.com template <typename T> 85510563Sandreas.hansson@arm.com const T* 85610563Sandreas.hansson@arm.com getConstPtr() const 85710563Sandreas.hansson@arm.com { 85810563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 85910563Sandreas.hansson@arm.com return (const T*)data; 86010563Sandreas.hansson@arm.com } 86110563Sandreas.hansson@arm.com 8625735Snate@binkert.org /** 86311013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from big endian to 86411013Sandreas.sandberg@arm.com * host endian. 86511013Sandreas.sandberg@arm.com */ 86611013Sandreas.sandberg@arm.com template <typename T> 86711013Sandreas.sandberg@arm.com T getBE() const; 86811013Sandreas.sandberg@arm.com 86911013Sandreas.sandberg@arm.com /** 87011013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from little endian to 87111013Sandreas.sandberg@arm.com * host endian. 87211013Sandreas.sandberg@arm.com */ 87311013Sandreas.sandberg@arm.com template <typename T> 87411013Sandreas.sandberg@arm.com T getLE() const; 87511013Sandreas.sandberg@arm.com 87611013Sandreas.sandberg@arm.com /** 87711013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from the specified 87811013Sandreas.sandberg@arm.com * endianness. 87911013Sandreas.sandberg@arm.com */ 88011013Sandreas.sandberg@arm.com template <typename T> 88111013Sandreas.sandberg@arm.com T get(ByteOrder endian) const; 88211013Sandreas.sandberg@arm.com 88311013Sandreas.sandberg@arm.com /** 88411013Sandreas.sandberg@arm.com * Get the data in the packet byte swapped from guest to host 88511013Sandreas.sandberg@arm.com * endian. 8865735Snate@binkert.org */ 8872566SN/A template <typename T> 88810563Sandreas.hansson@arm.com T get() const; 8892566SN/A 89011013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as big endian. */ 89111013Sandreas.sandberg@arm.com template <typename T> 89211013Sandreas.sandberg@arm.com void setBE(T v); 89311013Sandreas.sandberg@arm.com 89411013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as little endian. */ 89511013Sandreas.sandberg@arm.com template <typename T> 89611013Sandreas.sandberg@arm.com void setLE(T v); 89711013Sandreas.sandberg@arm.com 8985735Snate@binkert.org /** 89911013Sandreas.sandberg@arm.com * Set the value in the data pointer to v using the specified 90011013Sandreas.sandberg@arm.com * endianness. 9015735Snate@binkert.org */ 9022566SN/A template <typename T> 90311013Sandreas.sandberg@arm.com void set(T v, ByteOrder endian); 90411013Sandreas.sandberg@arm.com 90511013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v as guest endian. */ 90611013Sandreas.sandberg@arm.com template <typename T> 9072592SN/A void set(T v); 9082566SN/A 9093348Sbinkertn@umich.edu /** 9104626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 9114626Sstever@eecs.umich.edu */ 9125735Snate@binkert.org void 91310563Sandreas.hansson@arm.com setData(const uint8_t *p) 9144626Sstever@eecs.umich.edu { 91510571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 91610571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 91710571Sandreas.hansson@arm.com // same pointer from source to destination and back 91810571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 91910571Sandreas.hansson@arm.com 9207691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 92110571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 92210571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 9237691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 9244626Sstever@eecs.umich.edu } 9254626Sstever@eecs.umich.edu 9264626Sstever@eecs.umich.edu /** 9274626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 9284626Sstever@eecs.umich.edu * which is aligned to the given block size. 9294626Sstever@eecs.umich.edu */ 9305735Snate@binkert.org void 93110563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 9324626Sstever@eecs.umich.edu { 9334626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 9344626Sstever@eecs.umich.edu } 9354626Sstever@eecs.umich.edu 9364626Sstever@eecs.umich.edu /** 9374626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 9384626Sstever@eecs.umich.edu * is aligned to the given block size. 9394626Sstever@eecs.umich.edu */ 9405735Snate@binkert.org void 94110563Sandreas.hansson@arm.com writeData(uint8_t *p) const 9424626Sstever@eecs.umich.edu { 94310563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 9444626Sstever@eecs.umich.edu } 9454626Sstever@eecs.umich.edu 9464626Sstever@eecs.umich.edu /** 9474626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 9484626Sstever@eecs.umich.edu */ 9495735Snate@binkert.org void 95010563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 9514626Sstever@eecs.umich.edu { 9524626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 9534626Sstever@eecs.umich.edu } 9544626Sstever@eecs.umich.edu 9554626Sstever@eecs.umich.edu /** 9563348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 9573348Sbinkertn@umich.edu * matter how data was allocted. 9583348Sbinkertn@umich.edu */ 9595735Snate@binkert.org void 9605735Snate@binkert.org deleteData() 9615735Snate@binkert.org { 96210566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 9635735Snate@binkert.org delete [] data; 9645735Snate@binkert.org 96510566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 9665735Snate@binkert.org data = NULL; 9675735Snate@binkert.org } 9682566SN/A 96910565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9705735Snate@binkert.org void 9715735Snate@binkert.org allocate() 9725735Snate@binkert.org { 9735764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 97410566Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 9755745Snate@binkert.org data = new uint8_t[getSize()]; 9765735Snate@binkert.org } 9775735Snate@binkert.org 97811013Sandreas.sandberg@arm.com /** @} */ 97911013Sandreas.sandberg@arm.com 98011013Sandreas.sandberg@arm.com private: // Private data accessor methods 98111013Sandreas.sandberg@arm.com /** Get the data in the packet without byte swapping. */ 98211013Sandreas.sandberg@arm.com template <typename T> 98311013Sandreas.sandberg@arm.com T getRaw() const; 98411013Sandreas.sandberg@arm.com 98511013Sandreas.sandberg@arm.com /** Set the value in the data pointer to v without byte swapping. */ 98611013Sandreas.sandberg@arm.com template <typename T> 98711013Sandreas.sandberg@arm.com void setRaw(T v); 98811013Sandreas.sandberg@arm.com 98911013Sandreas.sandberg@arm.com public: 9904626Sstever@eecs.umich.edu /** 99110570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 99210570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 99310570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 99410570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 99510570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 99610570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 99710570Sandreas.hansson@arm.com * accordingly. 99810570Sandreas.hansson@arm.com */ 99910570Sandreas.hansson@arm.com bool 100010570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 100110570Sandreas.hansson@arm.com { 100210570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 100310570Sandreas.hansson@arm.com // data pointer 100410570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 100510570Sandreas.hansson@arm.com other->getSize(), 100610570Sandreas.hansson@arm.com other->hasData() ? 100710570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 100810570Sandreas.hansson@arm.com } 100910570Sandreas.hansson@arm.com 101010570Sandreas.hansson@arm.com /** 101110883Sali.jafri@arm.com * Is this request notification of a clean or dirty eviction from the cache. 101210883Sali.jafri@arm.com **/ 101310883Sali.jafri@arm.com bool 101410883Sali.jafri@arm.com evictingBlock() const 101510883Sali.jafri@arm.com { 101610883Sali.jafri@arm.com return (cmd == MemCmd::Writeback || 101710883Sali.jafri@arm.com cmd == MemCmd::CleanEvict); 101810883Sali.jafri@arm.com } 101910883Sali.jafri@arm.com 102010883Sali.jafri@arm.com /** 102110883Sali.jafri@arm.com * Does the request need to check for cached copies of the same block 102210883Sali.jafri@arm.com * in the memory hierarchy above. 102310883Sali.jafri@arm.com **/ 102410883Sali.jafri@arm.com bool 102510883Sali.jafri@arm.com mustCheckAbove() const 102610883Sali.jafri@arm.com { 102710883Sali.jafri@arm.com return (cmd == MemCmd::HardPFReq || 102810883Sali.jafri@arm.com evictingBlock()); 102910883Sali.jafri@arm.com } 103010883Sali.jafri@arm.com 103110883Sali.jafri@arm.com /** 10324626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 103310570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 103410570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 103510570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 10364626Sstever@eecs.umich.edu * memory value. 10374626Sstever@eecs.umich.edu */ 10385735Snate@binkert.org bool 103910570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 104010570Sandreas.hansson@arm.com uint8_t *_data); 10415314Sstever@gmail.com 10425315Sstever@gmail.com /** 10435315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 10445315Sstever@gmail.com */ 10455735Snate@binkert.org void 10465735Snate@binkert.org pushLabel(const std::string &lbl) 10475735Snate@binkert.org { 10485735Snate@binkert.org if (isPrint()) 10495735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 10505314Sstever@gmail.com } 10515314Sstever@gmail.com 10525315Sstever@gmail.com /** 10535315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 10545315Sstever@gmail.com */ 10555735Snate@binkert.org void 10565735Snate@binkert.org popLabel() 10575735Snate@binkert.org { 10585735Snate@binkert.org if (isPrint()) 10595735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 10605314Sstever@gmail.com } 10615314Sstever@gmail.com 10625314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 10635314Sstever@gmail.com const std::string &prefix = "") const; 10649663Suri.wiener@arm.com 10659663Suri.wiener@arm.com /** 10669663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 10679663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 10689663Suri.wiener@arm.com * avoiding string overheads in fast mode 10699663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 10709663Suri.wiener@arm.com */ 10719663Suri.wiener@arm.com std::string print() const; 10722381SN/A}; 10732381SN/A 10742381SN/A#endif //__MEM_PACKET_HH 1075