packet.hh revision 10739
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 157636Ssteve.reinhardt@amd.com * Copyright (c) 2010 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, 904022Sstever@eecs.umich.edu SoftPFReq, 914022Sstever@eecs.umich.edu HardPFReq, 924022Sstever@eecs.umich.edu SoftPFResp, 934022Sstever@eecs.umich.edu HardPFResp, 944022Sstever@eecs.umich.edu WriteInvalidateReq, 954022Sstever@eecs.umich.edu WriteInvalidateResp, 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, 1034626Sstever@eecs.umich.edu LoadLockedReq, 1044626Sstever@eecs.umich.edu StoreCondReq, 1057669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1064626Sstever@eecs.umich.edu StoreCondResp, 1074040Ssaidi@eecs.umich.edu SwapReq, 1084040Ssaidi@eecs.umich.edu SwapResp, 1095650Sgblack@eecs.umich.edu MessageReq, 1105650Sgblack@eecs.umich.edu MessageResp, 1114870Sstever@eecs.umich.edu // Error responses 1124870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1134870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1144870Sstever@eecs.umich.edu // compatibility 1154870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1164870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1178436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1188436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1195314Sstever@gmail.com // Fake simulator-only commands 1205314Sstever@gmail.com PrintReq, // Print state matching address 1218184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 1228716Snilay@cs.wisc.edu InvalidationReq, // request for address to be invalidated from lsq 1234022Sstever@eecs.umich.edu NUM_MEM_CMDS 1244022Sstever@eecs.umich.edu }; 1254022Sstever@eecs.umich.edu 1264022Sstever@eecs.umich.edu private: 1275735Snate@binkert.org /** 1285735Snate@binkert.org * List of command attributes. 1295735Snate@binkert.org */ 1304022Sstever@eecs.umich.edu enum Attribute 1314022Sstever@eecs.umich.edu { 1324626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1334626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1347465Ssteve.reinhardt@amd.com IsUpgrade, 1354022Sstever@eecs.umich.edu IsInvalidate, 1364626Sstever@eecs.umich.edu NeedsExclusive, //!< Requires exclusive copy to complete in-cache 1374626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1384626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1394626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 1404022Sstever@eecs.umich.edu IsSWPrefetch, 1414022Sstever@eecs.umich.edu IsHWPrefetch, 1426076Sgblack@eecs.umich.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1434626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1444870Sstever@eecs.umich.edu IsError, //!< Error response 1455314Sstever@gmail.com IsPrint, //!< Print state matching address (for debugging) 1468184Ssomayeh@cs.wisc.edu IsFlush, //!< Flush the address from caches 1474022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1484022Sstever@eecs.umich.edu }; 1494022Sstever@eecs.umich.edu 1505735Snate@binkert.org /** 1515735Snate@binkert.org * Structure that defines attributes and other data associated 1525735Snate@binkert.org * with a Command. 1535735Snate@binkert.org */ 1545735Snate@binkert.org struct CommandInfo 1555735Snate@binkert.org { 1565735Snate@binkert.org /// Set of attribute flags. 1574022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1585735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1595735Snate@binkert.org /// response is applicable. 1604022Sstever@eecs.umich.edu const Command response; 1615735Snate@binkert.org /// String representation (for printing) 1624022Sstever@eecs.umich.edu const std::string str; 1634022Sstever@eecs.umich.edu }; 1644022Sstever@eecs.umich.edu 1655735Snate@binkert.org /// Array to map Command enum to associated info. 1664022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1674022Sstever@eecs.umich.edu 1684022Sstever@eecs.umich.edu private: 1694022Sstever@eecs.umich.edu 1704022Sstever@eecs.umich.edu Command cmd; 1714022Sstever@eecs.umich.edu 1725735Snate@binkert.org bool 1735735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1745735Snate@binkert.org { 1754022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1764022Sstever@eecs.umich.edu } 1774022Sstever@eecs.umich.edu 1784022Sstever@eecs.umich.edu public: 1794022Sstever@eecs.umich.edu 18010583SCurtis.Dunham@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 18110583SCurtis.Dunham@arm.com bool isWrite() const { return testCmdAttrib(IsWrite); } 18210583SCurtis.Dunham@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 18310583SCurtis.Dunham@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 18410583SCurtis.Dunham@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 18510583SCurtis.Dunham@arm.com bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 18610583SCurtis.Dunham@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 18710583SCurtis.Dunham@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 18810583SCurtis.Dunham@arm.com bool isWriteInvalidate() const { return testCmdAttrib(IsWrite) && 18910583SCurtis.Dunham@arm.com testCmdAttrib(IsInvalidate); } 19010570Sandreas.hansson@arm.com 19110570Sandreas.hansson@arm.com /** 19210570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 19310570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 19410570Sandreas.hansson@arm.com * valid or not. 19510570Sandreas.hansson@arm.com */ 1964022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 1976102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 19810343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 19910343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 20010343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 20110343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 2024870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2035314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2048184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2054022Sstever@eecs.umich.edu 2065735Snate@binkert.org const Command 2075735Snate@binkert.org responseCommand() const 2085735Snate@binkert.org { 2094022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2104022Sstever@eecs.umich.edu } 2114022Sstever@eecs.umich.edu 2125735Snate@binkert.org /// Return the string to a cmd given by idx. 2135735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2144022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2154022Sstever@eecs.umich.edu 2165735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2175735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2185735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2194022Sstever@eecs.umich.edu 2205735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2215735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2224022Sstever@eecs.umich.edu}; 2234022Sstever@eecs.umich.edu 2242381SN/A/** 2252662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2262662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2272662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2282662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2292662Sstever@eecs.umich.edu * different Packets along the way.) 2302381SN/A */ 2319044SAli.Saidi@ARM.comclass Packet : public Printable 2322381SN/A{ 2332813Srdreslin@umich.edu public: 2345735Snate@binkert.org typedef uint32_t FlagsType; 2355735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2364022Sstever@eecs.umich.edu 2375735Snate@binkert.org private: 2385735Snate@binkert.org static const FlagsType PUBLIC_FLAGS = 0x00000000; 2395735Snate@binkert.org static const FlagsType PRIVATE_FLAGS = 0x00007F0F; 2405735Snate@binkert.org static const FlagsType COPY_FLAGS = 0x0000000F; 2415735Snate@binkert.org 2425735Snate@binkert.org static const FlagsType SHARED = 0x00000001; 2435735Snate@binkert.org // Special control flags 2445735Snate@binkert.org /// Special timing-mode atomic snoop for multi-level coherence. 2455735Snate@binkert.org static const FlagsType EXPRESS_SNOOP = 0x00000002; 2465735Snate@binkert.org /// Does supplier have exclusive copy? 2475735Snate@binkert.org /// Useful for multi-level coherence. 2485735Snate@binkert.org static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004; 2495735Snate@binkert.org // Snoop response flags 2505735Snate@binkert.org static const FlagsType MEM_INHIBIT = 0x00000008; 2515735Snate@binkert.org /// Are the 'addr' and 'size' fields valid? 2525735Snate@binkert.org static const FlagsType VALID_ADDR = 0x00000100; 2535735Snate@binkert.org static const FlagsType VALID_SIZE = 0x00000200; 2545735Snate@binkert.org /// Is the data pointer set to a value that shouldn't be freed 2555735Snate@binkert.org /// when the packet is destroyed? 2565735Snate@binkert.org static const FlagsType STATIC_DATA = 0x00001000; 2575735Snate@binkert.org /// The data pointer points to a value that should be freed when 25810566Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 25910566Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 2605735Snate@binkert.org static const FlagsType DYNAMIC_DATA = 0x00002000; 2618436SBrad.Beckmann@amd.com /// suppress the error if this packet encounters a functional 2628436SBrad.Beckmann@amd.com /// access failure. 2638436SBrad.Beckmann@amd.com static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 26410192Smitch.hayenga@arm.com // Signal prefetch squash through express snoop flag 26510192Smitch.hayenga@arm.com static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; 2665735Snate@binkert.org 2675735Snate@binkert.org Flags flags; 2685735Snate@binkert.org 2695735Snate@binkert.org public: 2704022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2714022Sstever@eecs.umich.edu 2725735Snate@binkert.org /// The command field of the packet. 2734870Sstever@eecs.umich.edu MemCmd cmd; 2744870Sstever@eecs.umich.edu 2755735Snate@binkert.org /// A pointer to the original request. 27610569Sandreas.hansson@arm.com const RequestPtr req; 2774870Sstever@eecs.umich.edu 2782566SN/A private: 2795735Snate@binkert.org /** 2805735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 2815735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 2825735Snate@binkert.org * packet, not request. This may or may not be populated when a 2835735Snate@binkert.org * responder recieves the packet. If not populated it memory should 2845735Snate@binkert.org * be allocated. 2852566SN/A */ 2862566SN/A PacketDataPtr data; 2872566SN/A 2885735Snate@binkert.org /// The address of the request. This address could be virtual or 2895735Snate@binkert.org /// physical, depending on the system configuration. 2902381SN/A Addr addr; 2912381SN/A 29210028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 29310028SGiacomo.Gabrielli@arm.com bool _isSecure; 29410028SGiacomo.Gabrielli@arm.com 2955735Snate@binkert.org /// The size of the request or transfer. 2966227Snate@binkert.org unsigned size; 2972381SN/A 2985735Snate@binkert.org /** 2995735Snate@binkert.org * The original value of the command field. Only valid when the 3004870Sstever@eecs.umich.edu * current command field is an error condition; in that case, the 3014870Sstever@eecs.umich.edu * previous contents of the command field are copied here. This 3024870Sstever@eecs.umich.edu * field is *not* set on non-error responses. 3034870Sstever@eecs.umich.edu */ 3044870Sstever@eecs.umich.edu MemCmd origCmd; 3054870Sstever@eecs.umich.edu 3068668Sgeoffrey.blake@arm.com /** 30710723Sandreas.hansson@arm.com * Track the bytes found that satisfy a functional read. 3088668Sgeoffrey.blake@arm.com */ 30910723Sandreas.hansson@arm.com std::vector<bool> bytesValid; 3108668Sgeoffrey.blake@arm.com 3112641Sstever@eecs.umich.edu public: 3122811Srdreslin@umich.edu 3139547Sandreas.hansson@arm.com /** 31410694SMarco.Balboni@ARM.com * The extra delay from seeing the packet until the header is 31510405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 31610405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 31710405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 31810405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3199547Sandreas.hansson@arm.com */ 32010694SMarco.Balboni@ARM.com uint32_t headerDelay; 3213218Sgblack@eecs.umich.edu 3229547Sandreas.hansson@arm.com /** 32310694SMarco.Balboni@ARM.com * The extra pipelining delay from seeing the packet until the end of 32410694SMarco.Balboni@ARM.com * payload is transmitted by the component that provided it (if 32510694SMarco.Balboni@ARM.com * any). This includes the header delay. Similar to the header 32610694SMarco.Balboni@ARM.com * delay, this is used to make up for the fact that the 32710405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 32810405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3299547Sandreas.hansson@arm.com */ 33010694SMarco.Balboni@ARM.com uint32_t payloadDelay; 3313218Sgblack@eecs.umich.edu 3325735Snate@binkert.org /** 3335735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3349542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3359542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3369542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3379542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3389542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3399542Sandreas.hansson@arm.com * particular sending device. 3409542Sandreas.hansson@arm.com * 3419542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3429542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3439542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3449542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3459542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3469542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3479542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3485735Snate@binkert.org */ 3495735Snate@binkert.org struct SenderState 3505735Snate@binkert.org { 3519542Sandreas.hansson@arm.com SenderState* predecessor; 3529542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3532641Sstever@eecs.umich.edu virtual ~SenderState() {} 3542641Sstever@eecs.umich.edu }; 3552641Sstever@eecs.umich.edu 3565315Sstever@gmail.com /** 3575315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3585315Sstever@gmail.com * field of a PrintReq should always be of this type. 3595315Sstever@gmail.com */ 3609044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3615735Snate@binkert.org { 3625735Snate@binkert.org private: 3635735Snate@binkert.org /** 3645735Snate@binkert.org * An entry in the label stack. 3655735Snate@binkert.org */ 3665735Snate@binkert.org struct LabelStackEntry 3675735Snate@binkert.org { 3685314Sstever@gmail.com const std::string label; 3695314Sstever@gmail.com std::string *prefix; 3705314Sstever@gmail.com bool labelPrinted; 3715735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3725314Sstever@gmail.com }; 3735314Sstever@gmail.com 3745314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3755314Sstever@gmail.com LabelStack labelStack; 3765314Sstever@gmail.com 3775314Sstever@gmail.com std::string *curPrefixPtr; 3785314Sstever@gmail.com 3795314Sstever@gmail.com public: 3805314Sstever@gmail.com std::ostream &os; 3815314Sstever@gmail.com const int verbosity; 3825314Sstever@gmail.com 3835314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 3845314Sstever@gmail.com ~PrintReqState(); 3855314Sstever@gmail.com 3865735Snate@binkert.org /** 3875735Snate@binkert.org * Returns the current line prefix. 3885735Snate@binkert.org */ 3895314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 3905315Sstever@gmail.com 3915735Snate@binkert.org /** 3925735Snate@binkert.org * Push a label onto the label stack, and prepend the given 3935315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 3945735Snate@binkert.org * printed if an object within the label's scope is printed. 3955735Snate@binkert.org */ 3965314Sstever@gmail.com void pushLabel(const std::string &lbl, 3975314Sstever@gmail.com const std::string &prefix = " "); 3985735Snate@binkert.org 3995735Snate@binkert.org /** 4005735Snate@binkert.org * Pop a label off the label stack. 4015735Snate@binkert.org */ 4025314Sstever@gmail.com void popLabel(); 4035735Snate@binkert.org 4045735Snate@binkert.org /** 4055735Snate@binkert.org * Print all of the pending unprinted labels on the 4065315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4075735Snate@binkert.org * users unless bypassing printObj(). 4085735Snate@binkert.org */ 4095314Sstever@gmail.com void printLabels(); 4105735Snate@binkert.org 4115735Snate@binkert.org /** 4125735Snate@binkert.org * Print a Printable object to os, because it matched the 4135735Snate@binkert.org * address on a PrintReq. 4145735Snate@binkert.org */ 4155314Sstever@gmail.com void printObj(Printable *obj); 4165314Sstever@gmail.com }; 4175314Sstever@gmail.com 4185735Snate@binkert.org /** 4195735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4205735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4215735Snate@binkert.org * this variable is to allow a device to attach extra information 4229542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4235735Snate@binkert.org * that was attached to the original request (even if a new packet 4245735Snate@binkert.org * is created). 4255735Snate@binkert.org */ 4262662Sstever@eecs.umich.edu SenderState *senderState; 4272641Sstever@eecs.umich.edu 4289542Sandreas.hansson@arm.com /** 4299542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4309542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4319542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4329542Sandreas.hansson@arm.com * variable. 4339542Sandreas.hansson@arm.com * 4349542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4359542Sandreas.hansson@arm.com */ 4369542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4379542Sandreas.hansson@arm.com 4389542Sandreas.hansson@arm.com /** 4399542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4409542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4419542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4429542Sandreas.hansson@arm.com * variable. 4439542Sandreas.hansson@arm.com * 4449542Sandreas.hansson@arm.com * @return The current top of the stack 4459542Sandreas.hansson@arm.com */ 4469542Sandreas.hansson@arm.com SenderState *popSenderState(); 4479542Sandreas.hansson@arm.com 4489543Ssascha.bischoff@arm.com /** 4499543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4509543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4519543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4529543Ssascha.bischoff@arm.com * 4539543Ssascha.bischoff@arm.com * @return The topmost state of type T 4549543Ssascha.bischoff@arm.com */ 4559543Ssascha.bischoff@arm.com template <typename T> 4569543Ssascha.bischoff@arm.com T * findNextSenderState() const 4579543Ssascha.bischoff@arm.com { 4589543Ssascha.bischoff@arm.com T *t = NULL; 4599543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4609543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4619543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4629543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4639543Ssascha.bischoff@arm.com } 4649543Ssascha.bischoff@arm.com return t; 4659543Ssascha.bischoff@arm.com } 4669543Ssascha.bischoff@arm.com 4675735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4685735Snate@binkert.org /// tracing). 4694022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4702811Srdreslin@umich.edu 4715735Snate@binkert.org /// Return the index of this command. 4724022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4732811Srdreslin@umich.edu 47410583SCurtis.Dunham@arm.com bool isRead() const { return cmd.isRead(); } 47510583SCurtis.Dunham@arm.com bool isWrite() const { return cmd.isWrite(); } 47610583SCurtis.Dunham@arm.com bool isUpgrade() const { return cmd.isUpgrade(); } 47710583SCurtis.Dunham@arm.com bool isRequest() const { return cmd.isRequest(); } 47810583SCurtis.Dunham@arm.com bool isResponse() const { return cmd.isResponse(); } 47910583SCurtis.Dunham@arm.com bool needsExclusive() const { return cmd.needsExclusive(); } 48010583SCurtis.Dunham@arm.com bool needsResponse() const { return cmd.needsResponse(); } 48110583SCurtis.Dunham@arm.com bool isInvalidate() const { return cmd.isInvalidate(); } 48210583SCurtis.Dunham@arm.com bool isWriteInvalidate() const { return cmd.isWriteInvalidate(); } 48310583SCurtis.Dunham@arm.com bool hasData() const { return cmd.hasData(); } 48410583SCurtis.Dunham@arm.com bool isLLSC() const { return cmd.isLLSC(); } 48510583SCurtis.Dunham@arm.com bool isError() const { return cmd.isError(); } 48610583SCurtis.Dunham@arm.com bool isPrint() const { return cmd.isPrint(); } 48710583SCurtis.Dunham@arm.com bool isFlush() const { return cmd.isFlush(); } 4882812Srdreslin@umich.edu 4894870Sstever@eecs.umich.edu // Snoop flags 49010567Sandreas.hansson@arm.com void assertMemInhibit() 49110567Sandreas.hansson@arm.com { 49210567Sandreas.hansson@arm.com assert(isRequest()); 49310567Sandreas.hansson@arm.com assert(!flags.isSet(MEM_INHIBIT)); 49410567Sandreas.hansson@arm.com flags.set(MEM_INHIBIT); 49510567Sandreas.hansson@arm.com } 4969951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 4979951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 4989951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 4994870Sstever@eecs.umich.edu 5004895Sstever@eecs.umich.edu // Special control flags 5019951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5029951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5039951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5049951Sstephan.diestelhorst@arm.com void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 5059951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5069951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5079951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 50810192Smitch.hayenga@arm.com void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } 50910192Smitch.hayenga@arm.com bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } 5104895Sstever@eecs.umich.edu 5114870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5124870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5134870Sstever@eecs.umich.edu // field, etc.) 5145735Snate@binkert.org void 5155735Snate@binkert.org setBadAddress() 5165735Snate@binkert.org { 5175735Snate@binkert.org assert(isResponse()); 5185735Snate@binkert.org cmd = MemCmd::BadAddressError; 5195735Snate@binkert.org } 5205735Snate@binkert.org 5215735Snate@binkert.org bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 5224986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5232814Srdreslin@umich.edu 5245764Snate@binkert.org Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5259259SAli.Saidi@ARM.com /** 5269259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5279259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5289259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5299259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5309259SAli.Saidi@ARM.com * valid. 5319259SAli.Saidi@ARM.com */ 5329259SAli.Saidi@ARM.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5339259SAli.Saidi@ARM.com 5346227Snate@binkert.org unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 5355735Snate@binkert.org Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 5362549SN/A 53710028SGiacomo.Gabrielli@arm.com bool isSecure() const 53810028SGiacomo.Gabrielli@arm.com { 53910028SGiacomo.Gabrielli@arm.com assert(flags.isSet(VALID_ADDR)); 54010028SGiacomo.Gabrielli@arm.com return _isSecure; 54110028SGiacomo.Gabrielli@arm.com } 54210028SGiacomo.Gabrielli@arm.com 5435735Snate@binkert.org /** 5447550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 5457550SBrad.Beckmann@amd.com * memory. Therefore, convert this SC packet to a normal write. 5467550SBrad.Beckmann@amd.com */ 5477550SBrad.Beckmann@amd.com void 5487550SBrad.Beckmann@amd.com convertScToWrite() 5497550SBrad.Beckmann@amd.com { 5507550SBrad.Beckmann@amd.com assert(isLLSC()); 5517550SBrad.Beckmann@amd.com assert(isWrite()); 5527550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5537550SBrad.Beckmann@amd.com } 5547550SBrad.Beckmann@amd.com 5557550SBrad.Beckmann@amd.com /** 5567550SBrad.Beckmann@amd.com * When ruby is in use, Ruby will monitor the cache line and thus M5 5577550SBrad.Beckmann@amd.com * phys memory should treat LL ops as normal reads. 5587550SBrad.Beckmann@amd.com */ 5597550SBrad.Beckmann@amd.com void 5607550SBrad.Beckmann@amd.com convertLlToRead() 5617550SBrad.Beckmann@amd.com { 5627550SBrad.Beckmann@amd.com assert(isLLSC()); 5637550SBrad.Beckmann@amd.com assert(isRead()); 5647550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5657550SBrad.Beckmann@amd.com } 5667550SBrad.Beckmann@amd.com 5677550SBrad.Beckmann@amd.com /** 5685735Snate@binkert.org * Constructor. Note that a Request object must be constructed 5695735Snate@binkert.org * first, but the Requests's physical address and size fields need 5709030Sandreas.hansson@arm.com * not be valid. The command must be supplied. 5715735Snate@binkert.org */ 57210569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 57310360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 57410723Sandreas.hansson@arm.com size(0), headerDelay(0), payloadDelay(0), 5759546Sandreas.hansson@arm.com senderState(NULL) 5762641Sstever@eecs.umich.edu { 5776104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 5786104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 5796104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 58010028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 5816104Ssteve.reinhardt@amd.com } 5826104Ssteve.reinhardt@amd.com if (req->hasSize()) { 5836104Ssteve.reinhardt@amd.com size = req->getSize(); 5846104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 5856104Ssteve.reinhardt@amd.com } 5862813Srdreslin@umich.edu } 5872813Srdreslin@umich.edu 5885735Snate@binkert.org /** 5895735Snate@binkert.org * Alternate constructor if you are trying to create a packet with 5905735Snate@binkert.org * a request that is for a whole block, not the address from the 5915735Snate@binkert.org * req. this allows for overriding the size/addr of the req. 5925735Snate@binkert.org */ 59310569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 59410360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 59510694SMarco.Balboni@ARM.com headerDelay(0), payloadDelay(0), 5969546Sandreas.hansson@arm.com senderState(NULL) 5972813Srdreslin@umich.edu { 5986104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 5996104Ssteve.reinhardt@amd.com addr = req->getPaddr() & ~(_blkSize - 1); 6006104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 60110028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6026104Ssteve.reinhardt@amd.com } 6036104Ssteve.reinhardt@amd.com size = _blkSize; 6046104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6054626Sstever@eecs.umich.edu } 6064626Sstever@eecs.umich.edu 6075735Snate@binkert.org /** 6085735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6094887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6104887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6114887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6125735Snate@binkert.org * packet should allocate its own data. 6135735Snate@binkert.org */ 61410571Sandreas.hansson@arm.com Packet(PacketPtr pkt, bool clear_flags, bool alloc_data) 6155735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 61610571Sandreas.hansson@arm.com data(nullptr), 61710028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 61810723Sandreas.hansson@arm.com bytesValid(pkt->bytesValid), 61910694SMarco.Balboni@ARM.com headerDelay(pkt->headerDelay), 62010694SMarco.Balboni@ARM.com payloadDelay(pkt->payloadDelay), 6219546Sandreas.hansson@arm.com senderState(pkt->senderState) 6224626Sstever@eecs.umich.edu { 62310571Sandreas.hansson@arm.com if (!clear_flags) 6245735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6255735Snate@binkert.org 6269031Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 62710565Sandreas.hansson@arm.com 62810571Sandreas.hansson@arm.com // should we allocate space for data, or not, the express 62910571Sandreas.hansson@arm.com // snoops do not need to carry any data as they only serve to 63010571Sandreas.hansson@arm.com // co-ordinate state changes 63110571Sandreas.hansson@arm.com if (alloc_data) { 63210571Sandreas.hansson@arm.com // even if asked to allocate data, if the original packet 63310571Sandreas.hansson@arm.com // holds static data, then the sender will not be doing 63410571Sandreas.hansson@arm.com // any memcpy on receiving the response, thus we simply 63510571Sandreas.hansson@arm.com // carry the pointer forward 63610571Sandreas.hansson@arm.com if (pkt->flags.isSet(STATIC_DATA)) { 63710571Sandreas.hansson@arm.com data = pkt->data; 63810571Sandreas.hansson@arm.com flags.set(STATIC_DATA); 63910571Sandreas.hansson@arm.com } else { 64010571Sandreas.hansson@arm.com allocate(); 64110571Sandreas.hansson@arm.com } 64210571Sandreas.hansson@arm.com } 64310342SCurtis.Dunham@arm.com } 6448668Sgeoffrey.blake@arm.com 64510342SCurtis.Dunham@arm.com /** 64610739Ssteve.reinhardt@amd.com * Generate the appropriate read MemCmd based on the Request flags. 64710342SCurtis.Dunham@arm.com */ 64810739Ssteve.reinhardt@amd.com static MemCmd 64910739Ssteve.reinhardt@amd.com makeReadCmd(const RequestPtr req) 65010342SCurtis.Dunham@arm.com { 65110739Ssteve.reinhardt@amd.com if (req->isLLSC()) 65210739Ssteve.reinhardt@amd.com return MemCmd::LoadLockedReq; 65310739Ssteve.reinhardt@amd.com else if (req->isPrefetch()) 65410739Ssteve.reinhardt@amd.com return MemCmd::SoftPFReq; 65510739Ssteve.reinhardt@amd.com else 65610739Ssteve.reinhardt@amd.com return MemCmd::ReadReq; 65710739Ssteve.reinhardt@amd.com } 65810739Ssteve.reinhardt@amd.com 65910739Ssteve.reinhardt@amd.com /** 66010739Ssteve.reinhardt@amd.com * Generate the appropriate write MemCmd based on the Request flags. 66110739Ssteve.reinhardt@amd.com */ 66210739Ssteve.reinhardt@amd.com static MemCmd 66310739Ssteve.reinhardt@amd.com makeWriteCmd(const RequestPtr req) 66410739Ssteve.reinhardt@amd.com { 66510739Ssteve.reinhardt@amd.com if (req->isLLSC()) 66610739Ssteve.reinhardt@amd.com return MemCmd::StoreCondReq; 66710739Ssteve.reinhardt@amd.com else if (req->isSwap()) 66810739Ssteve.reinhardt@amd.com return MemCmd::SwapReq; 66910739Ssteve.reinhardt@amd.com else 67010739Ssteve.reinhardt@amd.com return MemCmd::WriteReq; 67110342SCurtis.Dunham@arm.com } 67210342SCurtis.Dunham@arm.com 67310342SCurtis.Dunham@arm.com /** 67410342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 67510739Ssteve.reinhardt@amd.com * Fine-tune the MemCmd type if it's not a vanilla read or write. 67610342SCurtis.Dunham@arm.com */ 67710342SCurtis.Dunham@arm.com static PacketPtr 67810569Sandreas.hansson@arm.com createRead(const RequestPtr req) 67910342SCurtis.Dunham@arm.com { 68010739Ssteve.reinhardt@amd.com return new Packet(req, makeReadCmd(req)); 68110342SCurtis.Dunham@arm.com } 68210342SCurtis.Dunham@arm.com 68310342SCurtis.Dunham@arm.com static PacketPtr 68410569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 68510342SCurtis.Dunham@arm.com { 68610739Ssteve.reinhardt@amd.com return new Packet(req, makeWriteCmd(req)); 6872641Sstever@eecs.umich.edu } 6882549SN/A 6895735Snate@binkert.org /** 6905735Snate@binkert.org * clean up packet variables 6915735Snate@binkert.org */ 6922566SN/A ~Packet() 6935387Sstever@gmail.com { 6945387Sstever@gmail.com // If this is a request packet for which there's no response, 6955387Sstever@gmail.com // delete the request object here, since the requester will 6965387Sstever@gmail.com // never get the chance. 6975387Sstever@gmail.com if (req && isRequest() && !needsResponse()) 6985387Sstever@gmail.com delete req; 6995735Snate@binkert.org deleteData(); 7005387Sstever@gmail.com } 7012566SN/A 7025735Snate@binkert.org /** 7034626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 70410660Sandreas.hansson@arm.com * returning as a response to that request. 7054626Sstever@eecs.umich.edu */ 7065735Snate@binkert.org void 7075735Snate@binkert.org makeResponse() 7084626Sstever@eecs.umich.edu { 7092662Sstever@eecs.umich.edu assert(needsResponse()); 7102855Srdreslin@umich.edu assert(isRequest()); 7114986Ssaidi@eecs.umich.edu origCmd = cmd; 7124022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7135745Snate@binkert.org 7147464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7157464Ssteve.reinhardt@amd.com // triggered them was 7167464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7172641Sstever@eecs.umich.edu } 7182641Sstever@eecs.umich.edu 7195735Snate@binkert.org void 7205735Snate@binkert.org makeAtomicResponse() 7214870Sstever@eecs.umich.edu { 7224870Sstever@eecs.umich.edu makeResponse(); 7234870Sstever@eecs.umich.edu } 7244870Sstever@eecs.umich.edu 7255735Snate@binkert.org void 7265735Snate@binkert.org makeTimingResponse() 7273348Sbinkertn@umich.edu { 7284870Sstever@eecs.umich.edu makeResponse(); 7293135Srdreslin@umich.edu } 7303135Srdreslin@umich.edu 7318436SBrad.Beckmann@amd.com void 7328436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7338436SBrad.Beckmann@amd.com { 7348436SBrad.Beckmann@amd.com if (!success) { 7358436SBrad.Beckmann@amd.com if (isWrite()) { 7368436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7378436SBrad.Beckmann@amd.com } else { 7388436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7398436SBrad.Beckmann@amd.com } 7408436SBrad.Beckmann@amd.com } 7418436SBrad.Beckmann@amd.com } 7428436SBrad.Beckmann@amd.com 7437006Snate@binkert.org void 7447006Snate@binkert.org setSize(unsigned size) 7457006Snate@binkert.org { 7467006Snate@binkert.org assert(!flags.isSet(VALID_SIZE)); 7477006Snate@binkert.org 7487006Snate@binkert.org this->size = size; 7497006Snate@binkert.org flags.set(VALID_SIZE); 7507006Snate@binkert.org } 7517006Snate@binkert.org 7522685Ssaidi@eecs.umich.edu 7533348Sbinkertn@umich.edu /** 7543348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 75510571Sandreas.hansson@arm.com * freed. Static data allows us to do a single memcpy even if 75610571Sandreas.hansson@arm.com * multiple packets are required to get from source to destination 75710571Sandreas.hansson@arm.com * and back. In essence the pointer is set calling dataStatic on 75810571Sandreas.hansson@arm.com * the original packet, and whenever this packet is copied and 75910571Sandreas.hansson@arm.com * forwarded the same pointer is passed on. When a packet 76010571Sandreas.hansson@arm.com * eventually reaches the destination holding the data, it is 76110571Sandreas.hansson@arm.com * copied once into the location originally set. On the way back 76210571Sandreas.hansson@arm.com * to the source, no copies are necessary. 7632566SN/A */ 7642566SN/A template <typename T> 7653348Sbinkertn@umich.edu void 7663348Sbinkertn@umich.edu dataStatic(T *p) 7673348Sbinkertn@umich.edu { 76810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 7693348Sbinkertn@umich.edu data = (PacketDataPtr)p; 7705735Snate@binkert.org flags.set(STATIC_DATA); 7713348Sbinkertn@umich.edu } 7722566SN/A 7733348Sbinkertn@umich.edu /** 77410564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 77510564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 77610564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 77710564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 77810564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 77910564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 78010564Sandreas.hansson@arm.com */ 78110564Sandreas.hansson@arm.com template <typename T> 78210564Sandreas.hansson@arm.com void 78310564Sandreas.hansson@arm.com dataStaticConst(const T *p) 78410564Sandreas.hansson@arm.com { 78510566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 78610564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 78710564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 78810564Sandreas.hansson@arm.com } 78910564Sandreas.hansson@arm.com 79010564Sandreas.hansson@arm.com /** 7913348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 79210571Sandreas.hansson@arm.com * called on it. Dynamic data is local to this packet, and as the 79310571Sandreas.hansson@arm.com * packet travels from source to destination, forwarded packets 79410571Sandreas.hansson@arm.com * will allocate their own data. When a packet reaches the final 79510571Sandreas.hansson@arm.com * destination it will populate the dynamic data of that specific 79610571Sandreas.hansson@arm.com * packet, and on the way back towards the source, memcpy will be 79710571Sandreas.hansson@arm.com * invoked in every step where a new packet was created e.g. in 79810571Sandreas.hansson@arm.com * the caches. Ultimately when the response reaches the source a 79910571Sandreas.hansson@arm.com * final memcpy is needed to extract the data from the packet 80010571Sandreas.hansson@arm.com * before it is deallocated. 8013348Sbinkertn@umich.edu */ 8022566SN/A template <typename T> 8033348Sbinkertn@umich.edu void 8043348Sbinkertn@umich.edu dataDynamic(T *p) 8053348Sbinkertn@umich.edu { 80610566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8073348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8085735Snate@binkert.org flags.set(DYNAMIC_DATA); 8093348Sbinkertn@umich.edu } 8103348Sbinkertn@umich.edu 8115735Snate@binkert.org /** 8125735Snate@binkert.org * get a pointer to the data ptr. 8135735Snate@binkert.org */ 8143348Sbinkertn@umich.edu template <typename T> 8153348Sbinkertn@umich.edu T* 81610562Sandreas.hansson@arm.com getPtr() 8173348Sbinkertn@umich.edu { 81810562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8193348Sbinkertn@umich.edu return (T*)data; 8203348Sbinkertn@umich.edu } 8212566SN/A 82210563Sandreas.hansson@arm.com template <typename T> 82310563Sandreas.hansson@arm.com const T* 82410563Sandreas.hansson@arm.com getConstPtr() const 82510563Sandreas.hansson@arm.com { 82610563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 82710563Sandreas.hansson@arm.com return (const T*)data; 82810563Sandreas.hansson@arm.com } 82910563Sandreas.hansson@arm.com 8305735Snate@binkert.org /** 8315735Snate@binkert.org * return the value of what is pointed to in the packet. 8325735Snate@binkert.org */ 8332566SN/A template <typename T> 83410563Sandreas.hansson@arm.com T get() const; 8352566SN/A 8365735Snate@binkert.org /** 8375735Snate@binkert.org * set the value in the data pointer to v. 8385735Snate@binkert.org */ 8392566SN/A template <typename T> 8402592SN/A void set(T v); 8412566SN/A 8423348Sbinkertn@umich.edu /** 8434626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 8444626Sstever@eecs.umich.edu */ 8455735Snate@binkert.org void 84610563Sandreas.hansson@arm.com setData(const uint8_t *p) 8474626Sstever@eecs.umich.edu { 84810571Sandreas.hansson@arm.com // we should never be copying data onto itself, which means we 84910571Sandreas.hansson@arm.com // must idenfity packets with static data, as they carry the 85010571Sandreas.hansson@arm.com // same pointer from source to destination and back 85110571Sandreas.hansson@arm.com assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 85210571Sandreas.hansson@arm.com 8537691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 85410571Sandreas.hansson@arm.com // for packet with allocated dynamic data, we copy data from 85510571Sandreas.hansson@arm.com // one to the other, e.g. a forwarded response to a response 8567691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 8574626Sstever@eecs.umich.edu } 8584626Sstever@eecs.umich.edu 8594626Sstever@eecs.umich.edu /** 8604626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 8614626Sstever@eecs.umich.edu * which is aligned to the given block size. 8624626Sstever@eecs.umich.edu */ 8635735Snate@binkert.org void 86410563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 8654626Sstever@eecs.umich.edu { 8664626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 8674626Sstever@eecs.umich.edu } 8684626Sstever@eecs.umich.edu 8694626Sstever@eecs.umich.edu /** 8704626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 8714626Sstever@eecs.umich.edu * is aligned to the given block size. 8724626Sstever@eecs.umich.edu */ 8735735Snate@binkert.org void 87410563Sandreas.hansson@arm.com writeData(uint8_t *p) const 8754626Sstever@eecs.umich.edu { 87610563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 8774626Sstever@eecs.umich.edu } 8784626Sstever@eecs.umich.edu 8794626Sstever@eecs.umich.edu /** 8804626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 8814626Sstever@eecs.umich.edu */ 8825735Snate@binkert.org void 88310563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 8844626Sstever@eecs.umich.edu { 8854626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 8864626Sstever@eecs.umich.edu } 8874626Sstever@eecs.umich.edu 8884626Sstever@eecs.umich.edu /** 8893348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 8903348Sbinkertn@umich.edu * matter how data was allocted. 8913348Sbinkertn@umich.edu */ 8925735Snate@binkert.org void 8935735Snate@binkert.org deleteData() 8945735Snate@binkert.org { 89510566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 8965735Snate@binkert.org delete [] data; 8975735Snate@binkert.org 89810566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 8995735Snate@binkert.org data = NULL; 9005735Snate@binkert.org } 9012566SN/A 90210565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9035735Snate@binkert.org void 9045735Snate@binkert.org allocate() 9055735Snate@binkert.org { 9065764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 90710566Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 9085745Snate@binkert.org data = new uint8_t[getSize()]; 9095735Snate@binkert.org } 9105735Snate@binkert.org 9114626Sstever@eecs.umich.edu /** 91210570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 91310570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 91410570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 91510570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 91610570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 91710570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 91810570Sandreas.hansson@arm.com * accordingly. 91910570Sandreas.hansson@arm.com */ 92010570Sandreas.hansson@arm.com bool 92110570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 92210570Sandreas.hansson@arm.com { 92310570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 92410570Sandreas.hansson@arm.com // data pointer 92510570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 92610570Sandreas.hansson@arm.com other->getSize(), 92710570Sandreas.hansson@arm.com other->hasData() ? 92810570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 92910570Sandreas.hansson@arm.com } 93010570Sandreas.hansson@arm.com 93110570Sandreas.hansson@arm.com /** 9324626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 93310570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 93410570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 93510570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 9364626Sstever@eecs.umich.edu * memory value. 9374626Sstever@eecs.umich.edu */ 9385735Snate@binkert.org bool 93910570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 94010570Sandreas.hansson@arm.com uint8_t *_data); 9415314Sstever@gmail.com 9425315Sstever@gmail.com /** 9435315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 9445315Sstever@gmail.com */ 9455735Snate@binkert.org void 9465735Snate@binkert.org pushLabel(const std::string &lbl) 9475735Snate@binkert.org { 9485735Snate@binkert.org if (isPrint()) 9495735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 9505314Sstever@gmail.com } 9515314Sstever@gmail.com 9525315Sstever@gmail.com /** 9535315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 9545315Sstever@gmail.com */ 9555735Snate@binkert.org void 9565735Snate@binkert.org popLabel() 9575735Snate@binkert.org { 9585735Snate@binkert.org if (isPrint()) 9595735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 9605314Sstever@gmail.com } 9615314Sstever@gmail.com 9625314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 9635314Sstever@gmail.com const std::string &prefix = "") const; 9649663Suri.wiener@arm.com 9659663Suri.wiener@arm.com /** 9669663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 9679663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 9689663Suri.wiener@arm.com * avoiding string overheads in fast mode 9699663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 9709663Suri.wiener@arm.com */ 9719663Suri.wiener@arm.com std::string print() const; 9722381SN/A}; 9732381SN/A 9742381SN/A#endif //__MEM_PACKET_HH 975