packet.hh revision 9018
12381SN/A/* 28949Sandreas.hansson@arm.com * Copyright (c) 2012 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 442381SN/A */ 452381SN/A 462381SN/A/** 472381SN/A * @file 482662Sstever@eecs.umich.edu * Declaration of the Packet class. 492381SN/A */ 502381SN/A 512381SN/A#ifndef __MEM_PACKET_HH__ 522381SN/A#define __MEM_PACKET_HH__ 532381SN/A 548229Snate@binkert.org#include <bitset> 553348Sbinkertn@umich.edu#include <cassert> 563348Sbinkertn@umich.edu#include <list> 573348Sbinkertn@umich.edu 585735Snate@binkert.org#include "base/cast.hh" 594024Sbinkertn@umich.edu#include "base/compiler.hh" 604610Ssaidi@eecs.umich.edu#include "base/fast_alloc.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, 949018Sandreas.hansson@arm.com // WriteInvalidateReq transactions used to be generated by the 959018Sandreas.hansson@arm.com // DMA ports when writing full blocks to memory, however, it 969018Sandreas.hansson@arm.com // is not used anymore since we put the I/O cache in place to 979018Sandreas.hansson@arm.com // deal with partial block writes. Hence, WriteInvalidateReq 989018Sandreas.hansson@arm.com // and WriteInvalidateResp are currently unused. The 999018Sandreas.hansson@arm.com // implication is that the I/O cache does read-exclusive 1009018Sandreas.hansson@arm.com // operations on every full-cache-block DMA, and ultimately 1019018Sandreas.hansson@arm.com // this needs to be fixed. 1024022Sstever@eecs.umich.edu WriteInvalidateReq, 1034022Sstever@eecs.umich.edu WriteInvalidateResp, 1044022Sstever@eecs.umich.edu UpgradeReq, 1057465Ssteve.reinhardt@amd.com SCUpgradeReq, // Special "weak" upgrade for StoreCond 1064628Sstever@eecs.umich.edu UpgradeResp, 1077465Ssteve.reinhardt@amd.com SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1087465Ssteve.reinhardt@amd.com UpgradeFailResp, // Valid for SCUpgradeReq only 1094022Sstever@eecs.umich.edu ReadExReq, 1104022Sstever@eecs.umich.edu ReadExResp, 1114626Sstever@eecs.umich.edu LoadLockedReq, 1124626Sstever@eecs.umich.edu StoreCondReq, 1137669Ssteve.reinhardt@amd.com StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1144626Sstever@eecs.umich.edu StoreCondResp, 1154040Ssaidi@eecs.umich.edu SwapReq, 1164040Ssaidi@eecs.umich.edu SwapResp, 1175650Sgblack@eecs.umich.edu MessageReq, 1185650Sgblack@eecs.umich.edu MessageResp, 1194870Sstever@eecs.umich.edu // Error responses 1204870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 1214870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 1224870Sstever@eecs.umich.edu // compatibility 1234870Sstever@eecs.umich.edu NetworkNackError, // nacked at network layer (not by protocol) 1244870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 1254870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 1268436SBrad.Beckmann@amd.com FunctionalReadError, // unable to fulfill functional read 1278436SBrad.Beckmann@amd.com FunctionalWriteError, // unable to fulfill functional write 1285314Sstever@gmail.com // Fake simulator-only commands 1295314Sstever@gmail.com PrintReq, // Print state matching address 1308184Ssomayeh@cs.wisc.edu FlushReq, //request for a cache flush 1318716Snilay@cs.wisc.edu InvalidationReq, // request for address to be invalidated from lsq 1324022Sstever@eecs.umich.edu NUM_MEM_CMDS 1334022Sstever@eecs.umich.edu }; 1344022Sstever@eecs.umich.edu 1354022Sstever@eecs.umich.edu private: 1365735Snate@binkert.org /** 1375735Snate@binkert.org * List of command attributes. 1385735Snate@binkert.org */ 1394022Sstever@eecs.umich.edu enum Attribute 1404022Sstever@eecs.umich.edu { 1414626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1424626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1437465Ssteve.reinhardt@amd.com IsUpgrade, 1444022Sstever@eecs.umich.edu IsInvalidate, 1454626Sstever@eecs.umich.edu NeedsExclusive, //!< Requires exclusive copy to complete in-cache 1464626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1474626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1484626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 1494022Sstever@eecs.umich.edu IsSWPrefetch, 1504022Sstever@eecs.umich.edu IsHWPrefetch, 1516076Sgblack@eecs.umich.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1524626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1534870Sstever@eecs.umich.edu IsError, //!< Error response 1545314Sstever@gmail.com IsPrint, //!< Print state matching address (for debugging) 1558184Ssomayeh@cs.wisc.edu IsFlush, //!< Flush the address from caches 1564022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1574022Sstever@eecs.umich.edu }; 1584022Sstever@eecs.umich.edu 1595735Snate@binkert.org /** 1605735Snate@binkert.org * Structure that defines attributes and other data associated 1615735Snate@binkert.org * with a Command. 1625735Snate@binkert.org */ 1635735Snate@binkert.org struct CommandInfo 1645735Snate@binkert.org { 1655735Snate@binkert.org /// Set of attribute flags. 1664022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1675735Snate@binkert.org /// Corresponding response for requests; InvalidCmd if no 1685735Snate@binkert.org /// response is applicable. 1694022Sstever@eecs.umich.edu const Command response; 1705735Snate@binkert.org /// String representation (for printing) 1714022Sstever@eecs.umich.edu const std::string str; 1724022Sstever@eecs.umich.edu }; 1734022Sstever@eecs.umich.edu 1745735Snate@binkert.org /// Array to map Command enum to associated info. 1754022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1764022Sstever@eecs.umich.edu 1774022Sstever@eecs.umich.edu private: 1784022Sstever@eecs.umich.edu 1794022Sstever@eecs.umich.edu Command cmd; 1804022Sstever@eecs.umich.edu 1815735Snate@binkert.org bool 1825735Snate@binkert.org testCmdAttrib(MemCmd::Attribute attrib) const 1835735Snate@binkert.org { 1844022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1854022Sstever@eecs.umich.edu } 1864022Sstever@eecs.umich.edu 1874022Sstever@eecs.umich.edu public: 1884022Sstever@eecs.umich.edu 1894022Sstever@eecs.umich.edu bool isRead() const { return testCmdAttrib(IsRead); } 1907465Ssteve.reinhardt@amd.com bool isWrite() const { return testCmdAttrib(IsWrite); } 1917465Ssteve.reinhardt@amd.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 1924022Sstever@eecs.umich.edu bool isRequest() const { return testCmdAttrib(IsRequest); } 1934022Sstever@eecs.umich.edu bool isResponse() const { return testCmdAttrib(IsResponse); } 1944870Sstever@eecs.umich.edu bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 1954022Sstever@eecs.umich.edu bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 1964022Sstever@eecs.umich.edu bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 1974022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 1984626Sstever@eecs.umich.edu bool isReadWrite() const { return isRead() && isWrite(); } 1996102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 2004870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 2015314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 2028184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2034022Sstever@eecs.umich.edu 2045735Snate@binkert.org const Command 2055735Snate@binkert.org responseCommand() const 2065735Snate@binkert.org { 2074022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2084022Sstever@eecs.umich.edu } 2094022Sstever@eecs.umich.edu 2105735Snate@binkert.org /// Return the string to a cmd given by idx. 2115735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2124022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2134022Sstever@eecs.umich.edu 2145735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2155735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2165735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2174022Sstever@eecs.umich.edu 2185735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2195735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2204022Sstever@eecs.umich.edu}; 2214022Sstever@eecs.umich.edu 2222381SN/A/** 2232662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2242662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2252662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2262662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2272662Sstever@eecs.umich.edu * different Packets along the way.) 2282381SN/A */ 2295314Sstever@gmail.comclass Packet : public FastAlloc, public Printable 2302381SN/A{ 2312813Srdreslin@umich.edu public: 2325735Snate@binkert.org typedef uint32_t FlagsType; 2335735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2345735Snate@binkert.org typedef short NodeID; 2354022Sstever@eecs.umich.edu 2365735Snate@binkert.org private: 2375735Snate@binkert.org static const FlagsType PUBLIC_FLAGS = 0x00000000; 2385735Snate@binkert.org static const FlagsType PRIVATE_FLAGS = 0x00007F0F; 2395735Snate@binkert.org static const FlagsType COPY_FLAGS = 0x0000000F; 2405735Snate@binkert.org 2415735Snate@binkert.org static const FlagsType SHARED = 0x00000001; 2425735Snate@binkert.org // Special control flags 2435735Snate@binkert.org /// Special timing-mode atomic snoop for multi-level coherence. 2445735Snate@binkert.org static const FlagsType EXPRESS_SNOOP = 0x00000002; 2455735Snate@binkert.org /// Does supplier have exclusive copy? 2465735Snate@binkert.org /// Useful for multi-level coherence. 2475735Snate@binkert.org static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004; 2485735Snate@binkert.org // Snoop response flags 2495735Snate@binkert.org static const FlagsType MEM_INHIBIT = 0x00000008; 2505735Snate@binkert.org /// Are the 'addr' and 'size' fields valid? 2515735Snate@binkert.org static const FlagsType VALID_ADDR = 0x00000100; 2525735Snate@binkert.org static const FlagsType VALID_SIZE = 0x00000200; 2535735Snate@binkert.org /// Is the 'src' field valid? 2545735Snate@binkert.org static const FlagsType VALID_SRC = 0x00000400; 2555735Snate@binkert.org static const FlagsType VALID_DST = 0x00000800; 2565735Snate@binkert.org /// Is the data pointer set to a value that shouldn't be freed 2575735Snate@binkert.org /// when the packet is destroyed? 2585735Snate@binkert.org static const FlagsType STATIC_DATA = 0x00001000; 2595735Snate@binkert.org /// The data pointer points to a value that should be freed when 2605735Snate@binkert.org /// the packet is destroyed. 2615735Snate@binkert.org static const FlagsType DYNAMIC_DATA = 0x00002000; 2625735Snate@binkert.org /// the data pointer points to an array (thus delete []) needs to 2635735Snate@binkert.org /// be called on it rather than simply delete. 2645735Snate@binkert.org static const FlagsType ARRAY_DATA = 0x00004000; 2658436SBrad.Beckmann@amd.com /// suppress the error if this packet encounters a functional 2668436SBrad.Beckmann@amd.com /// access failure. 2678436SBrad.Beckmann@amd.com static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 2685735Snate@binkert.org 2695735Snate@binkert.org Flags flags; 2705735Snate@binkert.org 2715735Snate@binkert.org public: 2724022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2734022Sstever@eecs.umich.edu 2745735Snate@binkert.org /// The command field of the packet. 2754870Sstever@eecs.umich.edu MemCmd cmd; 2764870Sstever@eecs.umich.edu 2775735Snate@binkert.org /// A pointer to the original request. 2784870Sstever@eecs.umich.edu RequestPtr req; 2794870Sstever@eecs.umich.edu 2802566SN/A private: 2815735Snate@binkert.org /** 2825735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 2835735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 2845735Snate@binkert.org * packet, not request. This may or may not be populated when a 2855735Snate@binkert.org * responder recieves the packet. If not populated it memory should 2865735Snate@binkert.org * be allocated. 2872566SN/A */ 2882566SN/A PacketDataPtr data; 2892566SN/A 2905735Snate@binkert.org /// The address of the request. This address could be virtual or 2915735Snate@binkert.org /// physical, depending on the system configuration. 2922381SN/A Addr addr; 2932381SN/A 2945735Snate@binkert.org /// The size of the request or transfer. 2956227Snate@binkert.org unsigned size; 2962381SN/A 2975735Snate@binkert.org /** 2985735Snate@binkert.org * Device address (e.g., bus ID) of the source of the 2995735Snate@binkert.org * transaction. The source is not responsible for setting this 3005735Snate@binkert.org * field; it is set implicitly by the interconnect when the packet 3015735Snate@binkert.org * is first sent. 3025735Snate@binkert.org */ 3035735Snate@binkert.org NodeID src; 3042381SN/A 3055735Snate@binkert.org /** 3065735Snate@binkert.org * Device address (e.g., bus ID) of the destination of the 3075735Snate@binkert.org * transaction. The special value Broadcast indicates that the 3085735Snate@binkert.org * packet should be routed based on its address. This field is 3095735Snate@binkert.org * initialized in the constructor and is thus always valid (unlike 3105735Snate@binkert.org * addr, size, and src). 3115735Snate@binkert.org */ 3125735Snate@binkert.org NodeID dest; 3132641Sstever@eecs.umich.edu 3145735Snate@binkert.org /** 3155735Snate@binkert.org * The original value of the command field. Only valid when the 3164870Sstever@eecs.umich.edu * current command field is an error condition; in that case, the 3174870Sstever@eecs.umich.edu * previous contents of the command field are copied here. This 3184870Sstever@eecs.umich.edu * field is *not* set on non-error responses. 3194870Sstever@eecs.umich.edu */ 3204870Sstever@eecs.umich.edu MemCmd origCmd; 3214870Sstever@eecs.umich.edu 3228668Sgeoffrey.blake@arm.com /** 3238668Sgeoffrey.blake@arm.com * These values specify the range of bytes found that satisfy a 3248668Sgeoffrey.blake@arm.com * functional read. 3258668Sgeoffrey.blake@arm.com */ 3268668Sgeoffrey.blake@arm.com uint16_t bytesValidStart; 3278668Sgeoffrey.blake@arm.com uint16_t bytesValidEnd; 3288668Sgeoffrey.blake@arm.com 3292641Sstever@eecs.umich.edu public: 3305735Snate@binkert.org /// Used to calculate latencies for each packet. 3312811Srdreslin@umich.edu Tick time; 3322811Srdreslin@umich.edu 3335735Snate@binkert.org /// The time at which the packet will be fully transmitted 3343218Sgblack@eecs.umich.edu Tick finishTime; 3353218Sgblack@eecs.umich.edu 3365735Snate@binkert.org /// The time at which the first chunk of the packet will be transmitted 3373218Sgblack@eecs.umich.edu Tick firstWordTime; 3383218Sgblack@eecs.umich.edu 3395735Snate@binkert.org /** 3405735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3415735Snate@binkert.org * with the packet but specific to the sending device (e.g., an 3425735Snate@binkert.org * MSHR). A pointer to this state is returned in the packet's 3435735Snate@binkert.org * response so that the sender can quickly look up the state 3445735Snate@binkert.org * needed to process it. A specific subclass would be derived 3455735Snate@binkert.org * from this to carry state specific to a particular sending 3465735Snate@binkert.org * device. 3475735Snate@binkert.org */ 3485735Snate@binkert.org struct SenderState 3495735Snate@binkert.org { 3502641Sstever@eecs.umich.edu virtual ~SenderState() {} 3512641Sstever@eecs.umich.edu }; 3522641Sstever@eecs.umich.edu 3535315Sstever@gmail.com /** 3545315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3555315Sstever@gmail.com * field of a PrintReq should always be of this type. 3565315Sstever@gmail.com */ 3575735Snate@binkert.org class PrintReqState : public SenderState, public FastAlloc 3585735Snate@binkert.org { 3595735Snate@binkert.org private: 3605735Snate@binkert.org /** 3615735Snate@binkert.org * An entry in the label stack. 3625735Snate@binkert.org */ 3635735Snate@binkert.org struct LabelStackEntry 3645735Snate@binkert.org { 3655314Sstever@gmail.com const std::string label; 3665314Sstever@gmail.com std::string *prefix; 3675314Sstever@gmail.com bool labelPrinted; 3685735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3695314Sstever@gmail.com }; 3705314Sstever@gmail.com 3715314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3725314Sstever@gmail.com LabelStack labelStack; 3735314Sstever@gmail.com 3745314Sstever@gmail.com std::string *curPrefixPtr; 3755314Sstever@gmail.com 3765314Sstever@gmail.com public: 3775314Sstever@gmail.com std::ostream &os; 3785314Sstever@gmail.com const int verbosity; 3795314Sstever@gmail.com 3805314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 3815314Sstever@gmail.com ~PrintReqState(); 3825314Sstever@gmail.com 3835735Snate@binkert.org /** 3845735Snate@binkert.org * Returns the current line prefix. 3855735Snate@binkert.org */ 3865314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 3875315Sstever@gmail.com 3885735Snate@binkert.org /** 3895735Snate@binkert.org * Push a label onto the label stack, and prepend the given 3905315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 3915735Snate@binkert.org * printed if an object within the label's scope is printed. 3925735Snate@binkert.org */ 3935314Sstever@gmail.com void pushLabel(const std::string &lbl, 3945314Sstever@gmail.com const std::string &prefix = " "); 3955735Snate@binkert.org 3965735Snate@binkert.org /** 3975735Snate@binkert.org * Pop a label off the label stack. 3985735Snate@binkert.org */ 3995314Sstever@gmail.com void popLabel(); 4005735Snate@binkert.org 4015735Snate@binkert.org /** 4025735Snate@binkert.org * Print all of the pending unprinted labels on the 4035315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4045735Snate@binkert.org * users unless bypassing printObj(). 4055735Snate@binkert.org */ 4065314Sstever@gmail.com void printLabels(); 4075735Snate@binkert.org 4085735Snate@binkert.org /** 4095735Snate@binkert.org * Print a Printable object to os, because it matched the 4105735Snate@binkert.org * address on a PrintReq. 4115735Snate@binkert.org */ 4125314Sstever@gmail.com void printObj(Printable *obj); 4135314Sstever@gmail.com }; 4145314Sstever@gmail.com 4155735Snate@binkert.org /** 4165735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4175735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4185735Snate@binkert.org * this variable is to allow a device to attach extra information 4195735Snate@binkert.org * to a request. A response packet must return the sender state 4205735Snate@binkert.org * that was attached to the original request (even if a new packet 4215735Snate@binkert.org * is created). 4225735Snate@binkert.org */ 4232662Sstever@eecs.umich.edu SenderState *senderState; 4242641Sstever@eecs.umich.edu 4255735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4265735Snate@binkert.org /// tracing). 4274022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4282811Srdreslin@umich.edu 4295735Snate@binkert.org /// Return the index of this command. 4304022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4312811Srdreslin@umich.edu 4324022Sstever@eecs.umich.edu bool isRead() const { return cmd.isRead(); } 4337465Ssteve.reinhardt@amd.com bool isWrite() const { return cmd.isWrite(); } 4347465Ssteve.reinhardt@amd.com bool isUpgrade() const { return cmd.isUpgrade(); } 4354022Sstever@eecs.umich.edu bool isRequest() const { return cmd.isRequest(); } 4364022Sstever@eecs.umich.edu bool isResponse() const { return cmd.isResponse(); } 4374870Sstever@eecs.umich.edu bool needsExclusive() const { return cmd.needsExclusive(); } 4384022Sstever@eecs.umich.edu bool needsResponse() const { return cmd.needsResponse(); } 4394022Sstever@eecs.umich.edu bool isInvalidate() const { return cmd.isInvalidate(); } 4404022Sstever@eecs.umich.edu bool hasData() const { return cmd.hasData(); } 4414040Ssaidi@eecs.umich.edu bool isReadWrite() const { return cmd.isReadWrite(); } 4426102Sgblack@eecs.umich.edu bool isLLSC() const { return cmd.isLLSC(); } 4434870Sstever@eecs.umich.edu bool isError() const { return cmd.isError(); } 4445314Sstever@gmail.com bool isPrint() const { return cmd.isPrint(); } 4458184Ssomayeh@cs.wisc.edu bool isFlush() const { return cmd.isFlush(); } 4462812Srdreslin@umich.edu 4474870Sstever@eecs.umich.edu // Snoop flags 4485735Snate@binkert.org void assertMemInhibit() { flags.set(MEM_INHIBIT); } 4495764Snate@binkert.org bool memInhibitAsserted() { return flags.isSet(MEM_INHIBIT); } 4505735Snate@binkert.org void assertShared() { flags.set(SHARED); } 4515764Snate@binkert.org bool sharedAsserted() { return flags.isSet(SHARED); } 4524870Sstever@eecs.umich.edu 4534895Sstever@eecs.umich.edu // Special control flags 4545735Snate@binkert.org void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 4555764Snate@binkert.org bool isExpressSnoop() { return flags.isSet(EXPRESS_SNOOP); } 4565735Snate@binkert.org void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 4577687Ssteve.reinhardt@amd.com void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 4585764Snate@binkert.org bool isSupplyExclusive() { return flags.isSet(SUPPLY_EXCLUSIVE); } 4598436SBrad.Beckmann@amd.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 4608436SBrad.Beckmann@amd.com bool suppressFuncError() { return flags.isSet(SUPPRESS_FUNC_ERROR); } 4614895Sstever@eecs.umich.edu 4624870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 4634870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 4644870Sstever@eecs.umich.edu // field, etc.) 4655735Snate@binkert.org void 4665735Snate@binkert.org setNacked() 4675735Snate@binkert.org { 4685735Snate@binkert.org assert(isResponse()); 4695735Snate@binkert.org cmd = MemCmd::NetworkNackError; 4705735Snate@binkert.org } 4715735Snate@binkert.org 4725735Snate@binkert.org void 4735735Snate@binkert.org setBadAddress() 4745735Snate@binkert.org { 4755735Snate@binkert.org assert(isResponse()); 4765735Snate@binkert.org cmd = MemCmd::BadAddressError; 4775735Snate@binkert.org } 4785735Snate@binkert.org 4795735Snate@binkert.org bool wasNacked() const { return cmd == MemCmd::NetworkNackError; } 4805735Snate@binkert.org bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 4814986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 4822814Srdreslin@umich.edu 4836768SBrad.Beckmann@amd.com bool isSrcValid() { return flags.isSet(VALID_SRC); } 4845735Snate@binkert.org /// Accessor function to get the source index of the packet. 4855764Snate@binkert.org NodeID getSrc() const { assert(flags.isSet(VALID_SRC)); return src; } 4865735Snate@binkert.org /// Accessor function to set the source index of the packet. 4875735Snate@binkert.org void setSrc(NodeID _src) { src = _src; flags.set(VALID_SRC); } 4885735Snate@binkert.org /// Reset source field, e.g. to retransmit packet on different bus. 4895735Snate@binkert.org void clearSrc() { flags.clear(VALID_SRC); } 4902641Sstever@eecs.umich.edu 4916768SBrad.Beckmann@amd.com bool isDestValid() { return flags.isSet(VALID_DST); } 4925735Snate@binkert.org /// Accessor function for the destination index of the packet. 4935764Snate@binkert.org NodeID getDest() const { assert(flags.isSet(VALID_DST)); return dest; } 4945735Snate@binkert.org /// Accessor function to set the destination index of the packet. 4955735Snate@binkert.org void setDest(NodeID _dest) { dest = _dest; flags.set(VALID_DST); } 4968949Sandreas.hansson@arm.com /// Reset destination field, e.g. to turn a response into a request again. 4978949Sandreas.hansson@arm.com void clearDest() { flags.clear(VALID_DST); } 4982381SN/A 4995764Snate@binkert.org Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5006227Snate@binkert.org unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 5015735Snate@binkert.org Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 5022549SN/A 5035735Snate@binkert.org /** 5047550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 5057550SBrad.Beckmann@amd.com * memory. Therefore, convert this SC packet to a normal write. 5067550SBrad.Beckmann@amd.com */ 5077550SBrad.Beckmann@amd.com void 5087550SBrad.Beckmann@amd.com convertScToWrite() 5097550SBrad.Beckmann@amd.com { 5107550SBrad.Beckmann@amd.com assert(isLLSC()); 5117550SBrad.Beckmann@amd.com assert(isWrite()); 5127550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5137550SBrad.Beckmann@amd.com } 5147550SBrad.Beckmann@amd.com 5157550SBrad.Beckmann@amd.com /** 5167550SBrad.Beckmann@amd.com * When ruby is in use, Ruby will monitor the cache line and thus M5 5177550SBrad.Beckmann@amd.com * phys memory should treat LL ops as normal reads. 5187550SBrad.Beckmann@amd.com */ 5197550SBrad.Beckmann@amd.com void 5207550SBrad.Beckmann@amd.com convertLlToRead() 5217550SBrad.Beckmann@amd.com { 5227550SBrad.Beckmann@amd.com assert(isLLSC()); 5237550SBrad.Beckmann@amd.com assert(isRead()); 5247550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5257550SBrad.Beckmann@amd.com } 5267550SBrad.Beckmann@amd.com 5277550SBrad.Beckmann@amd.com /** 5285735Snate@binkert.org * Constructor. Note that a Request object must be constructed 5295735Snate@binkert.org * first, but the Requests's physical address and size fields need 5305735Snate@binkert.org * not be valid. The command and destination addresses must be 5315735Snate@binkert.org * supplied. 5325735Snate@binkert.org */ 5338949Sandreas.hansson@arm.com Packet(Request *_req, MemCmd _cmd) 5348949Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(NULL), 5358949Sandreas.hansson@arm.com bytesValidStart(0), bytesValidEnd(0), 5368668Sgeoffrey.blake@arm.com time(curTick()), senderState(NULL) 5372641Sstever@eecs.umich.edu { 5386104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 5396104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 5406104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 5416104Ssteve.reinhardt@amd.com } 5426104Ssteve.reinhardt@amd.com if (req->hasSize()) { 5436104Ssteve.reinhardt@amd.com size = req->getSize(); 5446104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 5456104Ssteve.reinhardt@amd.com } 5462813Srdreslin@umich.edu } 5472813Srdreslin@umich.edu 5485735Snate@binkert.org /** 5495735Snate@binkert.org * Alternate constructor if you are trying to create a packet with 5505735Snate@binkert.org * a request that is for a whole block, not the address from the 5515735Snate@binkert.org * req. this allows for overriding the size/addr of the req. 5525735Snate@binkert.org */ 5538949Sandreas.hansson@arm.com Packet(Request *_req, MemCmd _cmd, int _blkSize) 5548949Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(NULL), 5558949Sandreas.hansson@arm.com bytesValidStart(0), bytesValidEnd(0), 5568668Sgeoffrey.blake@arm.com time(curTick()), senderState(NULL) 5572813Srdreslin@umich.edu { 5586104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 5596104Ssteve.reinhardt@amd.com addr = req->getPaddr() & ~(_blkSize - 1); 5606104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 5616104Ssteve.reinhardt@amd.com } 5626104Ssteve.reinhardt@amd.com size = _blkSize; 5636104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 5644626Sstever@eecs.umich.edu } 5654626Sstever@eecs.umich.edu 5665735Snate@binkert.org /** 5675735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 5684887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 5694887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 5704887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 5715735Snate@binkert.org * packet should allocate its own data. 5725735Snate@binkert.org */ 5735735Snate@binkert.org Packet(Packet *pkt, bool clearFlags = false) 5745735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 5755764Snate@binkert.org data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), 5765735Snate@binkert.org addr(pkt->addr), size(pkt->size), src(pkt->src), dest(pkt->dest), 5778668Sgeoffrey.blake@arm.com bytesValidStart(pkt->bytesValidStart), bytesValidEnd(pkt->bytesValidEnd), 5787823Ssteve.reinhardt@amd.com time(curTick()), senderState(pkt->senderState) 5794626Sstever@eecs.umich.edu { 5805735Snate@binkert.org if (!clearFlags) 5815735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 5825735Snate@binkert.org 5835735Snate@binkert.org flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE|VALID_SRC|VALID_DST)); 5845735Snate@binkert.org flags.set(pkt->flags & STATIC_DATA); 5858668Sgeoffrey.blake@arm.com 5862641Sstever@eecs.umich.edu } 5872549SN/A 5885735Snate@binkert.org /** 5895735Snate@binkert.org * clean up packet variables 5905735Snate@binkert.org */ 5912566SN/A ~Packet() 5925387Sstever@gmail.com { 5935387Sstever@gmail.com // If this is a request packet for which there's no response, 5945387Sstever@gmail.com // delete the request object here, since the requester will 5955387Sstever@gmail.com // never get the chance. 5965387Sstever@gmail.com if (req && isRequest() && !needsResponse()) 5975387Sstever@gmail.com delete req; 5985735Snate@binkert.org deleteData(); 5995387Sstever@gmail.com } 6002566SN/A 6015735Snate@binkert.org /** 6025735Snate@binkert.org * Reinitialize packet address and size from the associated 6035735Snate@binkert.org * Request object, and reset other fields that may have been 6045735Snate@binkert.org * modified by a previous transaction. Typically called when a 6055735Snate@binkert.org * statically allocated Request/Packet pair is reused for multiple 6065735Snate@binkert.org * transactions. 6075735Snate@binkert.org */ 6085735Snate@binkert.org void 6095735Snate@binkert.org reinitFromRequest() 6105735Snate@binkert.org { 6116104Ssteve.reinhardt@amd.com assert(req->hasPaddr()); 6124870Sstever@eecs.umich.edu flags = 0; 6136104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 6146104Ssteve.reinhardt@amd.com size = req->getSize(); 6156223Snate@binkert.org time = req->time(); 6165735Snate@binkert.org 6175735Snate@binkert.org flags.set(VALID_ADDR|VALID_SIZE); 6185735Snate@binkert.org deleteData(); 6192662Sstever@eecs.umich.edu } 6202566SN/A 6214626Sstever@eecs.umich.edu /** 6224626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 6234626Sstever@eecs.umich.edu * returning as a response to that request. The source and 6244626Sstever@eecs.umich.edu * destination fields are *not* modified, as is appropriate for 6254626Sstever@eecs.umich.edu * atomic accesses. 6264626Sstever@eecs.umich.edu */ 6275735Snate@binkert.org void 6285735Snate@binkert.org makeResponse() 6294626Sstever@eecs.umich.edu { 6302662Sstever@eecs.umich.edu assert(needsResponse()); 6312855Srdreslin@umich.edu assert(isRequest()); 6324986Ssaidi@eecs.umich.edu origCmd = cmd; 6334022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 6345745Snate@binkert.org 6357464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 6367464Ssteve.reinhardt@amd.com // triggered them was 6377464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 6387464Ssteve.reinhardt@amd.com 6395745Snate@binkert.org dest = src; 6405764Snate@binkert.org flags.set(VALID_DST, flags.isSet(VALID_SRC)); 6415745Snate@binkert.org flags.clear(VALID_SRC); 6422641Sstever@eecs.umich.edu } 6432641Sstever@eecs.umich.edu 6445735Snate@binkert.org void 6455735Snate@binkert.org makeAtomicResponse() 6464870Sstever@eecs.umich.edu { 6474870Sstever@eecs.umich.edu makeResponse(); 6484870Sstever@eecs.umich.edu } 6494870Sstever@eecs.umich.edu 6505735Snate@binkert.org void 6515735Snate@binkert.org makeTimingResponse() 6523348Sbinkertn@umich.edu { 6534870Sstever@eecs.umich.edu makeResponse(); 6543135Srdreslin@umich.edu } 6553135Srdreslin@umich.edu 6568436SBrad.Beckmann@amd.com void 6578436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 6588436SBrad.Beckmann@amd.com { 6598436SBrad.Beckmann@amd.com if (!success) { 6608436SBrad.Beckmann@amd.com if (isWrite()) { 6618436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 6628436SBrad.Beckmann@amd.com } else { 6638436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 6648436SBrad.Beckmann@amd.com } 6658436SBrad.Beckmann@amd.com } 6668436SBrad.Beckmann@amd.com } 6678436SBrad.Beckmann@amd.com 6683348Sbinkertn@umich.edu /** 6693348Sbinkertn@umich.edu * Take a request packet that has been returned as NACKED and 6703348Sbinkertn@umich.edu * modify it so that it can be sent out again. Only packets that 6713348Sbinkertn@umich.edu * need a response can be NACKED, so verify that that is true. 6723348Sbinkertn@umich.edu */ 6733348Sbinkertn@umich.edu void 6743348Sbinkertn@umich.edu reinitNacked() 6753348Sbinkertn@umich.edu { 6764870Sstever@eecs.umich.edu assert(wasNacked()); 6774870Sstever@eecs.umich.edu cmd = origCmd; 6784870Sstever@eecs.umich.edu assert(needsResponse()); 6798949Sandreas.hansson@arm.com clearDest(); 6802685Ssaidi@eecs.umich.edu } 6812685Ssaidi@eecs.umich.edu 6827006Snate@binkert.org void 6837006Snate@binkert.org setSize(unsigned size) 6847006Snate@binkert.org { 6857006Snate@binkert.org assert(!flags.isSet(VALID_SIZE)); 6867006Snate@binkert.org 6877006Snate@binkert.org this->size = size; 6887006Snate@binkert.org flags.set(VALID_SIZE); 6897006Snate@binkert.org } 6907006Snate@binkert.org 6912685Ssaidi@eecs.umich.edu 6923348Sbinkertn@umich.edu /** 6933348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 6943348Sbinkertn@umich.edu * freed. 6952566SN/A */ 6962566SN/A template <typename T> 6973348Sbinkertn@umich.edu void 6983348Sbinkertn@umich.edu dataStatic(T *p) 6993348Sbinkertn@umich.edu { 7005764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 7013348Sbinkertn@umich.edu data = (PacketDataPtr)p; 7025735Snate@binkert.org flags.set(STATIC_DATA); 7033348Sbinkertn@umich.edu } 7042566SN/A 7053348Sbinkertn@umich.edu /** 7063348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 7073348Sbinkertn@umich.edu * called on it. 7083348Sbinkertn@umich.edu */ 7092566SN/A template <typename T> 7103348Sbinkertn@umich.edu void 7113348Sbinkertn@umich.edu dataDynamicArray(T *p) 7123348Sbinkertn@umich.edu { 7135764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 7143348Sbinkertn@umich.edu data = (PacketDataPtr)p; 7155735Snate@binkert.org flags.set(DYNAMIC_DATA|ARRAY_DATA); 7163348Sbinkertn@umich.edu } 7173348Sbinkertn@umich.edu 7183348Sbinkertn@umich.edu /** 7193348Sbinkertn@umich.edu * set the data pointer to a value that should have delete called 7203348Sbinkertn@umich.edu * on it. 7213348Sbinkertn@umich.edu */ 7223348Sbinkertn@umich.edu template <typename T> 7233348Sbinkertn@umich.edu void 7243348Sbinkertn@umich.edu dataDynamic(T *p) 7253348Sbinkertn@umich.edu { 7265764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 7273348Sbinkertn@umich.edu data = (PacketDataPtr)p; 7285735Snate@binkert.org flags.set(DYNAMIC_DATA); 7293348Sbinkertn@umich.edu } 7303348Sbinkertn@umich.edu 7315735Snate@binkert.org /** 7325735Snate@binkert.org * get a pointer to the data ptr. 7335735Snate@binkert.org */ 7343348Sbinkertn@umich.edu template <typename T> 7353348Sbinkertn@umich.edu T* 7367915SBrad.Beckmann@amd.com getPtr(bool null_ok = false) 7373348Sbinkertn@umich.edu { 7387915SBrad.Beckmann@amd.com assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 7393348Sbinkertn@umich.edu return (T*)data; 7403348Sbinkertn@umich.edu } 7412566SN/A 7425735Snate@binkert.org /** 7435735Snate@binkert.org * return the value of what is pointed to in the packet. 7445735Snate@binkert.org */ 7452566SN/A template <typename T> 7462592SN/A T get(); 7472566SN/A 7485735Snate@binkert.org /** 7495735Snate@binkert.org * set the value in the data pointer to v. 7505735Snate@binkert.org */ 7512566SN/A template <typename T> 7522592SN/A void set(T v); 7532566SN/A 7543348Sbinkertn@umich.edu /** 7554626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 7564626Sstever@eecs.umich.edu */ 7575735Snate@binkert.org void 7585735Snate@binkert.org setData(uint8_t *p) 7594626Sstever@eecs.umich.edu { 7607691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 7617691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 7624626Sstever@eecs.umich.edu } 7634626Sstever@eecs.umich.edu 7644626Sstever@eecs.umich.edu /** 7654626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 7664626Sstever@eecs.umich.edu * which is aligned to the given block size. 7674626Sstever@eecs.umich.edu */ 7685735Snate@binkert.org void 7695735Snate@binkert.org setDataFromBlock(uint8_t *blk_data, int blkSize) 7704626Sstever@eecs.umich.edu { 7714626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 7724626Sstever@eecs.umich.edu } 7734626Sstever@eecs.umich.edu 7744626Sstever@eecs.umich.edu /** 7754626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 7764626Sstever@eecs.umich.edu * is aligned to the given block size. 7774626Sstever@eecs.umich.edu */ 7785735Snate@binkert.org void 7795735Snate@binkert.org writeData(uint8_t *p) 7804626Sstever@eecs.umich.edu { 7814626Sstever@eecs.umich.edu std::memcpy(p, getPtr<uint8_t>(), getSize()); 7824626Sstever@eecs.umich.edu } 7834626Sstever@eecs.umich.edu 7844626Sstever@eecs.umich.edu /** 7854626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 7864626Sstever@eecs.umich.edu */ 7875735Snate@binkert.org void 7885735Snate@binkert.org writeDataToBlock(uint8_t *blk_data, int blkSize) 7894626Sstever@eecs.umich.edu { 7904626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 7914626Sstever@eecs.umich.edu } 7924626Sstever@eecs.umich.edu 7934626Sstever@eecs.umich.edu /** 7943348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 7953348Sbinkertn@umich.edu * matter how data was allocted. 7963348Sbinkertn@umich.edu */ 7975735Snate@binkert.org void 7985735Snate@binkert.org deleteData() 7995735Snate@binkert.org { 8005764Snate@binkert.org if (flags.isSet(ARRAY_DATA)) 8015735Snate@binkert.org delete [] data; 8025764Snate@binkert.org else if (flags.isSet(DYNAMIC_DATA)) 8035735Snate@binkert.org delete data; 8045735Snate@binkert.org 8055735Snate@binkert.org flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA); 8065735Snate@binkert.org data = NULL; 8075735Snate@binkert.org } 8082566SN/A 8092566SN/A /** If there isn't data in the packet, allocate some. */ 8105735Snate@binkert.org void 8115735Snate@binkert.org allocate() 8125735Snate@binkert.org { 8135735Snate@binkert.org if (data) { 8145764Snate@binkert.org assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8155745Snate@binkert.org return; 8165735Snate@binkert.org } 8175745Snate@binkert.org 8185764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8195745Snate@binkert.org flags.set(DYNAMIC_DATA|ARRAY_DATA); 8205745Snate@binkert.org data = new uint8_t[getSize()]; 8215735Snate@binkert.org } 8225735Snate@binkert.org 8234626Sstever@eecs.umich.edu /** 8244626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 8254626Sstever@eecs.umich.edu * by a base/size pair and an associated data array. If the 8264626Sstever@eecs.umich.edu * functional request is a read, it may be satisfied by the memory 8274626Sstever@eecs.umich.edu * value. If the functional request is a write, it may update the 8284626Sstever@eecs.umich.edu * memory value. 8294626Sstever@eecs.umich.edu */ 8305314Sstever@gmail.com bool checkFunctional(Printable *obj, Addr base, int size, uint8_t *data); 8314626Sstever@eecs.umich.edu 8324626Sstever@eecs.umich.edu /** 8334626Sstever@eecs.umich.edu * Check a functional request against a memory value stored in 8345315Sstever@gmail.com * another packet (i.e. an in-transit request or response). 8354626Sstever@eecs.umich.edu */ 8365735Snate@binkert.org bool 8375735Snate@binkert.org checkFunctional(PacketPtr other) 8385735Snate@binkert.org { 8395735Snate@binkert.org uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL; 8405735Snate@binkert.org return checkFunctional(other, other->getAddr(), other->getSize(), 8415735Snate@binkert.org data); 8424626Sstever@eecs.umich.edu } 8435314Sstever@gmail.com 8445315Sstever@gmail.com /** 8455315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 8465315Sstever@gmail.com */ 8475735Snate@binkert.org void 8485735Snate@binkert.org pushLabel(const std::string &lbl) 8495735Snate@binkert.org { 8505735Snate@binkert.org if (isPrint()) 8515735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 8525314Sstever@gmail.com } 8535314Sstever@gmail.com 8545315Sstever@gmail.com /** 8555315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 8565315Sstever@gmail.com */ 8575735Snate@binkert.org void 8585735Snate@binkert.org popLabel() 8595735Snate@binkert.org { 8605735Snate@binkert.org if (isPrint()) 8615735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 8625314Sstever@gmail.com } 8635314Sstever@gmail.com 8645314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 8655314Sstever@gmail.com const std::string &prefix = "") const; 8662381SN/A}; 8672381SN/A 8682381SN/A#endif //__MEM_PACKET_HH 869