packet.hh revision 10565
12381SN/A/* 210342SCurtis.Dunham@arm.com * Copyright (c) 2012-2014 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 1804022Sstever@eecs.umich.edu bool isRead() const { return testCmdAttrib(IsRead); } 1817465Ssteve.reinhardt@amd.com bool isWrite() const { return testCmdAttrib(IsWrite); } 1827465Ssteve.reinhardt@amd.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 1834022Sstever@eecs.umich.edu bool isRequest() const { return testCmdAttrib(IsRequest); } 1844022Sstever@eecs.umich.edu bool isResponse() const { return testCmdAttrib(IsResponse); } 1854870Sstever@eecs.umich.edu bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 1864022Sstever@eecs.umich.edu bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 1874022Sstever@eecs.umich.edu bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 1884022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 1896102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 19010343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 19110343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 19210343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 19310343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 1944870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 1955314Sstever@gmail.com bool isPrint() const { return testCmdAttrib(IsPrint); } 1968184Ssomayeh@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 1974022Sstever@eecs.umich.edu 1985735Snate@binkert.org const Command 1995735Snate@binkert.org responseCommand() const 2005735Snate@binkert.org { 2014022Sstever@eecs.umich.edu return commandInfo[cmd].response; 2024022Sstever@eecs.umich.edu } 2034022Sstever@eecs.umich.edu 2045735Snate@binkert.org /// Return the string to a cmd given by idx. 2055735Snate@binkert.org const std::string &toString() const { return commandInfo[cmd].str; } 2064022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 2074022Sstever@eecs.umich.edu 2085735Snate@binkert.org MemCmd(Command _cmd) : cmd(_cmd) { } 2095735Snate@binkert.org MemCmd(int _cmd) : cmd((Command)_cmd) { } 2105735Snate@binkert.org MemCmd() : cmd(InvalidCmd) { } 2114022Sstever@eecs.umich.edu 2125735Snate@binkert.org bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2135735Snate@binkert.org bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2144022Sstever@eecs.umich.edu}; 2154022Sstever@eecs.umich.edu 2162381SN/A/** 2172662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 2182662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 2192662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 2202662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 2212662Sstever@eecs.umich.edu * different Packets along the way.) 2222381SN/A */ 2239044SAli.Saidi@ARM.comclass Packet : public Printable 2242381SN/A{ 2252813Srdreslin@umich.edu public: 2265735Snate@binkert.org typedef uint32_t FlagsType; 2275735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2284022Sstever@eecs.umich.edu 2295735Snate@binkert.org private: 2305735Snate@binkert.org static const FlagsType PUBLIC_FLAGS = 0x00000000; 2315735Snate@binkert.org static const FlagsType PRIVATE_FLAGS = 0x00007F0F; 2325735Snate@binkert.org static const FlagsType COPY_FLAGS = 0x0000000F; 2335735Snate@binkert.org 2345735Snate@binkert.org static const FlagsType SHARED = 0x00000001; 2355735Snate@binkert.org // Special control flags 2365735Snate@binkert.org /// Special timing-mode atomic snoop for multi-level coherence. 2375735Snate@binkert.org static const FlagsType EXPRESS_SNOOP = 0x00000002; 2385735Snate@binkert.org /// Does supplier have exclusive copy? 2395735Snate@binkert.org /// Useful for multi-level coherence. 2405735Snate@binkert.org static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004; 2415735Snate@binkert.org // Snoop response flags 2425735Snate@binkert.org static const FlagsType MEM_INHIBIT = 0x00000008; 2435735Snate@binkert.org /// Are the 'addr' and 'size' fields valid? 2445735Snate@binkert.org static const FlagsType VALID_ADDR = 0x00000100; 2455735Snate@binkert.org static const FlagsType VALID_SIZE = 0x00000200; 2465735Snate@binkert.org /// Is the data pointer set to a value that shouldn't be freed 2475735Snate@binkert.org /// when the packet is destroyed? 2485735Snate@binkert.org static const FlagsType STATIC_DATA = 0x00001000; 2495735Snate@binkert.org /// The data pointer points to a value that should be freed when 2505735Snate@binkert.org /// the packet is destroyed. 2515735Snate@binkert.org static const FlagsType DYNAMIC_DATA = 0x00002000; 2525735Snate@binkert.org /// the data pointer points to an array (thus delete []) needs to 2535735Snate@binkert.org /// be called on it rather than simply delete. 2545735Snate@binkert.org static const FlagsType ARRAY_DATA = 0x00004000; 2558436SBrad.Beckmann@amd.com /// suppress the error if this packet encounters a functional 2568436SBrad.Beckmann@amd.com /// access failure. 2578436SBrad.Beckmann@amd.com static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 25810192Smitch.hayenga@arm.com // Signal prefetch squash through express snoop flag 25910192Smitch.hayenga@arm.com static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; 2605735Snate@binkert.org 2615735Snate@binkert.org Flags flags; 2625735Snate@binkert.org 2635735Snate@binkert.org public: 2644022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2654022Sstever@eecs.umich.edu 2665735Snate@binkert.org /// The command field of the packet. 2674870Sstever@eecs.umich.edu MemCmd cmd; 2684870Sstever@eecs.umich.edu 2695735Snate@binkert.org /// A pointer to the original request. 2704870Sstever@eecs.umich.edu RequestPtr req; 2714870Sstever@eecs.umich.edu 2722566SN/A private: 2735735Snate@binkert.org /** 2745735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 2755735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 2765735Snate@binkert.org * packet, not request. This may or may not be populated when a 2775735Snate@binkert.org * responder recieves the packet. If not populated it memory should 2785735Snate@binkert.org * be allocated. 2792566SN/A */ 2802566SN/A PacketDataPtr data; 2812566SN/A 2825735Snate@binkert.org /// The address of the request. This address could be virtual or 2835735Snate@binkert.org /// physical, depending on the system configuration. 2842381SN/A Addr addr; 2852381SN/A 28610028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 28710028SGiacomo.Gabrielli@arm.com bool _isSecure; 28810028SGiacomo.Gabrielli@arm.com 2895735Snate@binkert.org /// The size of the request or transfer. 2906227Snate@binkert.org unsigned size; 2912381SN/A 2925735Snate@binkert.org /** 2939030Sandreas.hansson@arm.com * Source port identifier set on a request packet to enable 2949030Sandreas.hansson@arm.com * appropriate routing of the responses. The source port 29510405Sandreas.hansson@arm.com * identifier is set by any multiplexing component, e.g. a 29610405Sandreas.hansson@arm.com * crossbar, as the timing responses need this information to be 29710405Sandreas.hansson@arm.com * routed back to the appropriate port at a later point in 29810405Sandreas.hansson@arm.com * time. The field can be updated (over-written) as the request 29910405Sandreas.hansson@arm.com * packet passes through additional multiplexing components, and 30010405Sandreas.hansson@arm.com * it is their responsibility to remember the original source port 30110405Sandreas.hansson@arm.com * identifier, for example by using an appropriate sender 30210405Sandreas.hansson@arm.com * state. The latter is done in the cache and bridge. 3035735Snate@binkert.org */ 3049031Sandreas.hansson@arm.com PortID src; 3052381SN/A 3065735Snate@binkert.org /** 3079030Sandreas.hansson@arm.com * Destination port identifier that is present on all response 3089030Sandreas.hansson@arm.com * packets that passed through a multiplexing component as a 3099030Sandreas.hansson@arm.com * request packet. The source port identifier is turned into a 3109030Sandreas.hansson@arm.com * destination port identifier when the packet is turned into a 31110405Sandreas.hansson@arm.com * response, and the destination is used, e.g. by the crossbar, to 3129030Sandreas.hansson@arm.com * select the appropriate path through the interconnect. 3135735Snate@binkert.org */ 3149031Sandreas.hansson@arm.com PortID dest; 3152641Sstever@eecs.umich.edu 3165735Snate@binkert.org /** 3175735Snate@binkert.org * The original value of the command field. Only valid when the 3184870Sstever@eecs.umich.edu * current command field is an error condition; in that case, the 3194870Sstever@eecs.umich.edu * previous contents of the command field are copied here. This 3204870Sstever@eecs.umich.edu * field is *not* set on non-error responses. 3214870Sstever@eecs.umich.edu */ 3224870Sstever@eecs.umich.edu MemCmd origCmd; 3234870Sstever@eecs.umich.edu 3248668Sgeoffrey.blake@arm.com /** 3258668Sgeoffrey.blake@arm.com * These values specify the range of bytes found that satisfy a 3268668Sgeoffrey.blake@arm.com * functional read. 3278668Sgeoffrey.blake@arm.com */ 3288668Sgeoffrey.blake@arm.com uint16_t bytesValidStart; 3298668Sgeoffrey.blake@arm.com uint16_t bytesValidEnd; 3308668Sgeoffrey.blake@arm.com 3312641Sstever@eecs.umich.edu public: 3322811Srdreslin@umich.edu 3339547Sandreas.hansson@arm.com /** 3349547Sandreas.hansson@arm.com * The extra delay from seeing the packet until the first word is 33510405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 33610405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 33710405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 33810405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3399547Sandreas.hansson@arm.com */ 34010405Sandreas.hansson@arm.com uint32_t firstWordDelay; 3413218Sgblack@eecs.umich.edu 3429547Sandreas.hansson@arm.com /** 34310405Sandreas.hansson@arm.com * The extra pipelining delay from seeing the packet until the 34410405Sandreas.hansson@arm.com * last word is transmitted by the component that provided it (if 34510405Sandreas.hansson@arm.com * any). This includes the first word delay. Similar to the first 34610405Sandreas.hansson@arm.com * word delay, this is used to make up for the fact that the 34710405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 34810405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3499547Sandreas.hansson@arm.com */ 35010405Sandreas.hansson@arm.com uint32_t lastWordDelay; 3513218Sgblack@eecs.umich.edu 3525735Snate@binkert.org /** 3535735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3549542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3559542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3569542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3579542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3589542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3599542Sandreas.hansson@arm.com * particular sending device. 3609542Sandreas.hansson@arm.com * 3619542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3629542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3639542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3649542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3659542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3669542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3679542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3685735Snate@binkert.org */ 3695735Snate@binkert.org struct SenderState 3705735Snate@binkert.org { 3719542Sandreas.hansson@arm.com SenderState* predecessor; 3729542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3732641Sstever@eecs.umich.edu virtual ~SenderState() {} 3742641Sstever@eecs.umich.edu }; 3752641Sstever@eecs.umich.edu 3765315Sstever@gmail.com /** 3775315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3785315Sstever@gmail.com * field of a PrintReq should always be of this type. 3795315Sstever@gmail.com */ 3809044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3815735Snate@binkert.org { 3825735Snate@binkert.org private: 3835735Snate@binkert.org /** 3845735Snate@binkert.org * An entry in the label stack. 3855735Snate@binkert.org */ 3865735Snate@binkert.org struct LabelStackEntry 3875735Snate@binkert.org { 3885314Sstever@gmail.com const std::string label; 3895314Sstever@gmail.com std::string *prefix; 3905314Sstever@gmail.com bool labelPrinted; 3915735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3925314Sstever@gmail.com }; 3935314Sstever@gmail.com 3945314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3955314Sstever@gmail.com LabelStack labelStack; 3965314Sstever@gmail.com 3975314Sstever@gmail.com std::string *curPrefixPtr; 3985314Sstever@gmail.com 3995314Sstever@gmail.com public: 4005314Sstever@gmail.com std::ostream &os; 4015314Sstever@gmail.com const int verbosity; 4025314Sstever@gmail.com 4035314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4045314Sstever@gmail.com ~PrintReqState(); 4055314Sstever@gmail.com 4065735Snate@binkert.org /** 4075735Snate@binkert.org * Returns the current line prefix. 4085735Snate@binkert.org */ 4095314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4105315Sstever@gmail.com 4115735Snate@binkert.org /** 4125735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4135315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4145735Snate@binkert.org * printed if an object within the label's scope is printed. 4155735Snate@binkert.org */ 4165314Sstever@gmail.com void pushLabel(const std::string &lbl, 4175314Sstever@gmail.com const std::string &prefix = " "); 4185735Snate@binkert.org 4195735Snate@binkert.org /** 4205735Snate@binkert.org * Pop a label off the label stack. 4215735Snate@binkert.org */ 4225314Sstever@gmail.com void popLabel(); 4235735Snate@binkert.org 4245735Snate@binkert.org /** 4255735Snate@binkert.org * Print all of the pending unprinted labels on the 4265315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4275735Snate@binkert.org * users unless bypassing printObj(). 4285735Snate@binkert.org */ 4295314Sstever@gmail.com void printLabels(); 4305735Snate@binkert.org 4315735Snate@binkert.org /** 4325735Snate@binkert.org * Print a Printable object to os, because it matched the 4335735Snate@binkert.org * address on a PrintReq. 4345735Snate@binkert.org */ 4355314Sstever@gmail.com void printObj(Printable *obj); 4365314Sstever@gmail.com }; 4375314Sstever@gmail.com 4385735Snate@binkert.org /** 4395735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4405735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4415735Snate@binkert.org * this variable is to allow a device to attach extra information 4429542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4435735Snate@binkert.org * that was attached to the original request (even if a new packet 4445735Snate@binkert.org * is created). 4455735Snate@binkert.org */ 4462662Sstever@eecs.umich.edu SenderState *senderState; 4472641Sstever@eecs.umich.edu 4489542Sandreas.hansson@arm.com /** 4499542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4509542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4519542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4529542Sandreas.hansson@arm.com * variable. 4539542Sandreas.hansson@arm.com * 4549542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4559542Sandreas.hansson@arm.com */ 4569542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4579542Sandreas.hansson@arm.com 4589542Sandreas.hansson@arm.com /** 4599542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4609542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4619542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4629542Sandreas.hansson@arm.com * variable. 4639542Sandreas.hansson@arm.com * 4649542Sandreas.hansson@arm.com * @return The current top of the stack 4659542Sandreas.hansson@arm.com */ 4669542Sandreas.hansson@arm.com SenderState *popSenderState(); 4679542Sandreas.hansson@arm.com 4689543Ssascha.bischoff@arm.com /** 4699543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4709543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4719543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4729543Ssascha.bischoff@arm.com * 4739543Ssascha.bischoff@arm.com * @return The topmost state of type T 4749543Ssascha.bischoff@arm.com */ 4759543Ssascha.bischoff@arm.com template <typename T> 4769543Ssascha.bischoff@arm.com T * findNextSenderState() const 4779543Ssascha.bischoff@arm.com { 4789543Ssascha.bischoff@arm.com T *t = NULL; 4799543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4809543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4819543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4829543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4839543Ssascha.bischoff@arm.com } 4849543Ssascha.bischoff@arm.com return t; 4859543Ssascha.bischoff@arm.com } 4869543Ssascha.bischoff@arm.com 4875735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4885735Snate@binkert.org /// tracing). 4894022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4902811Srdreslin@umich.edu 4915735Snate@binkert.org /// Return the index of this command. 4924022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4932811Srdreslin@umich.edu 4944022Sstever@eecs.umich.edu bool isRead() const { return cmd.isRead(); } 4957465Ssteve.reinhardt@amd.com bool isWrite() const { return cmd.isWrite(); } 4967465Ssteve.reinhardt@amd.com bool isUpgrade() const { return cmd.isUpgrade(); } 4974022Sstever@eecs.umich.edu bool isRequest() const { return cmd.isRequest(); } 4984022Sstever@eecs.umich.edu bool isResponse() const { return cmd.isResponse(); } 4994870Sstever@eecs.umich.edu bool needsExclusive() const { return cmd.needsExclusive(); } 5004022Sstever@eecs.umich.edu bool needsResponse() const { return cmd.needsResponse(); } 5014022Sstever@eecs.umich.edu bool isInvalidate() const { return cmd.isInvalidate(); } 5024022Sstever@eecs.umich.edu bool hasData() const { return cmd.hasData(); } 5036102Sgblack@eecs.umich.edu bool isLLSC() const { return cmd.isLLSC(); } 5044870Sstever@eecs.umich.edu bool isError() const { return cmd.isError(); } 5055314Sstever@gmail.com bool isPrint() const { return cmd.isPrint(); } 5068184Ssomayeh@cs.wisc.edu bool isFlush() const { return cmd.isFlush(); } 5072812Srdreslin@umich.edu 5084870Sstever@eecs.umich.edu // Snoop flags 5099951Sstephan.diestelhorst@arm.com void assertMemInhibit() { flags.set(MEM_INHIBIT); } 5109951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 5119951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 5129951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 5134870Sstever@eecs.umich.edu 5144895Sstever@eecs.umich.edu // Special control flags 5159951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5169951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5179951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5189951Sstephan.diestelhorst@arm.com void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 5199951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5209951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5219951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 52210192Smitch.hayenga@arm.com void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } 52310192Smitch.hayenga@arm.com bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } 5244895Sstever@eecs.umich.edu 5254870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5264870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5274870Sstever@eecs.umich.edu // field, etc.) 5285735Snate@binkert.org void 5295735Snate@binkert.org setBadAddress() 5305735Snate@binkert.org { 5315735Snate@binkert.org assert(isResponse()); 5325735Snate@binkert.org cmd = MemCmd::BadAddressError; 5335735Snate@binkert.org } 5345735Snate@binkert.org 5355735Snate@binkert.org bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 5364986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5372814Srdreslin@umich.edu 5389031Sandreas.hansson@arm.com bool isSrcValid() const { return src != InvalidPortID; } 5395735Snate@binkert.org /// Accessor function to get the source index of the packet. 5409031Sandreas.hansson@arm.com PortID getSrc() const { assert(isSrcValid()); return src; } 5415735Snate@binkert.org /// Accessor function to set the source index of the packet. 5429031Sandreas.hansson@arm.com void setSrc(PortID _src) { src = _src; } 5432641Sstever@eecs.umich.edu 5449031Sandreas.hansson@arm.com bool isDestValid() const { return dest != InvalidPortID; } 5455735Snate@binkert.org /// Accessor function for the destination index of the packet. 5469031Sandreas.hansson@arm.com PortID getDest() const { assert(isDestValid()); return dest; } 5475735Snate@binkert.org /// Accessor function to set the destination index of the packet. 5489031Sandreas.hansson@arm.com void setDest(PortID _dest) { dest = _dest; } 5498949Sandreas.hansson@arm.com /// Reset destination field, e.g. to turn a response into a request again. 5509031Sandreas.hansson@arm.com void clearDest() { dest = InvalidPortID; } 5512381SN/A 5525764Snate@binkert.org Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5539259SAli.Saidi@ARM.com /** 5549259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5559259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5569259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5579259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5589259SAli.Saidi@ARM.com * valid. 5599259SAli.Saidi@ARM.com */ 5609259SAli.Saidi@ARM.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5619259SAli.Saidi@ARM.com 5626227Snate@binkert.org unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 5635735Snate@binkert.org Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 5642549SN/A 56510028SGiacomo.Gabrielli@arm.com bool isSecure() const 56610028SGiacomo.Gabrielli@arm.com { 56710028SGiacomo.Gabrielli@arm.com assert(flags.isSet(VALID_ADDR)); 56810028SGiacomo.Gabrielli@arm.com return _isSecure; 56910028SGiacomo.Gabrielli@arm.com } 57010028SGiacomo.Gabrielli@arm.com 5715735Snate@binkert.org /** 5727550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 5737550SBrad.Beckmann@amd.com * memory. Therefore, convert this SC packet to a normal write. 5747550SBrad.Beckmann@amd.com */ 5757550SBrad.Beckmann@amd.com void 5767550SBrad.Beckmann@amd.com convertScToWrite() 5777550SBrad.Beckmann@amd.com { 5787550SBrad.Beckmann@amd.com assert(isLLSC()); 5797550SBrad.Beckmann@amd.com assert(isWrite()); 5807550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5817550SBrad.Beckmann@amd.com } 5827550SBrad.Beckmann@amd.com 5837550SBrad.Beckmann@amd.com /** 5847550SBrad.Beckmann@amd.com * When ruby is in use, Ruby will monitor the cache line and thus M5 5857550SBrad.Beckmann@amd.com * phys memory should treat LL ops as normal reads. 5867550SBrad.Beckmann@amd.com */ 5877550SBrad.Beckmann@amd.com void 5887550SBrad.Beckmann@amd.com convertLlToRead() 5897550SBrad.Beckmann@amd.com { 5907550SBrad.Beckmann@amd.com assert(isLLSC()); 5917550SBrad.Beckmann@amd.com assert(isRead()); 5927550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 5937550SBrad.Beckmann@amd.com } 5947550SBrad.Beckmann@amd.com 5957550SBrad.Beckmann@amd.com /** 5965735Snate@binkert.org * Constructor. Note that a Request object must be constructed 5975735Snate@binkert.org * first, but the Requests's physical address and size fields need 5989030Sandreas.hansson@arm.com * not be valid. The command must be supplied. 5995735Snate@binkert.org */ 6008949Sandreas.hansson@arm.com Packet(Request *_req, MemCmd _cmd) 60110360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 60210412Sandreas.hansson@arm.com size(0), src(InvalidPortID), dest(InvalidPortID), 6038949Sandreas.hansson@arm.com bytesValidStart(0), bytesValidEnd(0), 60410405Sandreas.hansson@arm.com firstWordDelay(0), lastWordDelay(0), 6059546Sandreas.hansson@arm.com senderState(NULL) 6062641Sstever@eecs.umich.edu { 6076104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 6086104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 6096104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 61010028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6116104Ssteve.reinhardt@amd.com } 6126104Ssteve.reinhardt@amd.com if (req->hasSize()) { 6136104Ssteve.reinhardt@amd.com size = req->getSize(); 6146104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6156104Ssteve.reinhardt@amd.com } 6162813Srdreslin@umich.edu } 6172813Srdreslin@umich.edu 6185735Snate@binkert.org /** 6195735Snate@binkert.org * Alternate constructor if you are trying to create a packet with 6205735Snate@binkert.org * a request that is for a whole block, not the address from the 6215735Snate@binkert.org * req. this allows for overriding the size/addr of the req. 6225735Snate@binkert.org */ 6238949Sandreas.hansson@arm.com Packet(Request *_req, MemCmd _cmd, int _blkSize) 62410360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 6259031Sandreas.hansson@arm.com src(InvalidPortID), dest(InvalidPortID), 6268949Sandreas.hansson@arm.com bytesValidStart(0), bytesValidEnd(0), 62710405Sandreas.hansson@arm.com firstWordDelay(0), lastWordDelay(0), 6289546Sandreas.hansson@arm.com senderState(NULL) 6292813Srdreslin@umich.edu { 6306104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 6316104Ssteve.reinhardt@amd.com addr = req->getPaddr() & ~(_blkSize - 1); 6326104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 63310028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6346104Ssteve.reinhardt@amd.com } 6356104Ssteve.reinhardt@amd.com size = _blkSize; 6366104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6374626Sstever@eecs.umich.edu } 6384626Sstever@eecs.umich.edu 6395735Snate@binkert.org /** 6405735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6414887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6424887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6434887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6445735Snate@binkert.org * packet should allocate its own data. 6455735Snate@binkert.org */ 6465735Snate@binkert.org Packet(Packet *pkt, bool clearFlags = false) 6475735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 6485764Snate@binkert.org data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), 64910028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 65010028SGiacomo.Gabrielli@arm.com src(pkt->src), dest(pkt->dest), 6519547Sandreas.hansson@arm.com bytesValidStart(pkt->bytesValidStart), 6529547Sandreas.hansson@arm.com bytesValidEnd(pkt->bytesValidEnd), 65310405Sandreas.hansson@arm.com firstWordDelay(pkt->firstWordDelay), 65410405Sandreas.hansson@arm.com lastWordDelay(pkt->lastWordDelay), 6559546Sandreas.hansson@arm.com senderState(pkt->senderState) 6564626Sstever@eecs.umich.edu { 6575735Snate@binkert.org if (!clearFlags) 6585735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6595735Snate@binkert.org 6609031Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 6615735Snate@binkert.org flags.set(pkt->flags & STATIC_DATA); 66210565Sandreas.hansson@arm.com 66310565Sandreas.hansson@arm.com // if we did not copy the static data pointer, allocate data 66410565Sandreas.hansson@arm.com // dynamically instead 66510565Sandreas.hansson@arm.com if (!data) 66610565Sandreas.hansson@arm.com allocate(); 66710342SCurtis.Dunham@arm.com } 6688668Sgeoffrey.blake@arm.com 66910342SCurtis.Dunham@arm.com /** 67010342SCurtis.Dunham@arm.com * Change the packet type based on request type. 67110342SCurtis.Dunham@arm.com */ 67210342SCurtis.Dunham@arm.com void 67310342SCurtis.Dunham@arm.com refineCommand() 67410342SCurtis.Dunham@arm.com { 67510342SCurtis.Dunham@arm.com if (cmd == MemCmd::ReadReq) { 67610342SCurtis.Dunham@arm.com if (req->isLLSC()) { 67710342SCurtis.Dunham@arm.com cmd = MemCmd::LoadLockedReq; 67810343SCurtis.Dunham@arm.com } else if (req->isPrefetch()) { 67910343SCurtis.Dunham@arm.com cmd = MemCmd::SoftPFReq; 68010342SCurtis.Dunham@arm.com } 68110342SCurtis.Dunham@arm.com } else if (cmd == MemCmd::WriteReq) { 68210342SCurtis.Dunham@arm.com if (req->isLLSC()) { 68310342SCurtis.Dunham@arm.com cmd = MemCmd::StoreCondReq; 68410342SCurtis.Dunham@arm.com } else if (req->isSwap()) { 68510342SCurtis.Dunham@arm.com cmd = MemCmd::SwapReq; 68610342SCurtis.Dunham@arm.com } 68710342SCurtis.Dunham@arm.com } 68810342SCurtis.Dunham@arm.com } 68910342SCurtis.Dunham@arm.com 69010342SCurtis.Dunham@arm.com /** 69110342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 69210342SCurtis.Dunham@arm.com * Will call refineCommand() to fine-tune the Packet type if it's not a 69310342SCurtis.Dunham@arm.com * vanilla read or write. 69410342SCurtis.Dunham@arm.com */ 69510342SCurtis.Dunham@arm.com static PacketPtr 69610342SCurtis.Dunham@arm.com createRead(Request *req) 69710342SCurtis.Dunham@arm.com { 69810342SCurtis.Dunham@arm.com PacketPtr pkt = new Packet(req, MemCmd::ReadReq); 69910342SCurtis.Dunham@arm.com pkt->refineCommand(); 70010342SCurtis.Dunham@arm.com return pkt; 70110342SCurtis.Dunham@arm.com } 70210342SCurtis.Dunham@arm.com 70310342SCurtis.Dunham@arm.com static PacketPtr 70410342SCurtis.Dunham@arm.com createWrite(Request *req) 70510342SCurtis.Dunham@arm.com { 70610342SCurtis.Dunham@arm.com PacketPtr pkt = new Packet(req, MemCmd::WriteReq); 70710342SCurtis.Dunham@arm.com pkt->refineCommand(); 70810342SCurtis.Dunham@arm.com return pkt; 7092641Sstever@eecs.umich.edu } 7102549SN/A 7115735Snate@binkert.org /** 7125735Snate@binkert.org * clean up packet variables 7135735Snate@binkert.org */ 7142566SN/A ~Packet() 7155387Sstever@gmail.com { 7165387Sstever@gmail.com // If this is a request packet for which there's no response, 7175387Sstever@gmail.com // delete the request object here, since the requester will 7185387Sstever@gmail.com // never get the chance. 7195387Sstever@gmail.com if (req && isRequest() && !needsResponse()) 7205387Sstever@gmail.com delete req; 7215735Snate@binkert.org deleteData(); 7225387Sstever@gmail.com } 7232566SN/A 7245735Snate@binkert.org /** 7255735Snate@binkert.org * Reinitialize packet address and size from the associated 7265735Snate@binkert.org * Request object, and reset other fields that may have been 7275735Snate@binkert.org * modified by a previous transaction. Typically called when a 7285735Snate@binkert.org * statically allocated Request/Packet pair is reused for multiple 7295735Snate@binkert.org * transactions. 7305735Snate@binkert.org */ 7315735Snate@binkert.org void 7325735Snate@binkert.org reinitFromRequest() 7335735Snate@binkert.org { 7346104Ssteve.reinhardt@amd.com assert(req->hasPaddr()); 7354870Sstever@eecs.umich.edu flags = 0; 7366104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 73710028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 7386104Ssteve.reinhardt@amd.com size = req->getSize(); 7395735Snate@binkert.org 7409547Sandreas.hansson@arm.com src = InvalidPortID; 7419547Sandreas.hansson@arm.com dest = InvalidPortID; 7429547Sandreas.hansson@arm.com bytesValidStart = 0; 7439547Sandreas.hansson@arm.com bytesValidEnd = 0; 74410405Sandreas.hansson@arm.com firstWordDelay = 0; 74510405Sandreas.hansson@arm.com lastWordDelay = 0; 7469547Sandreas.hansson@arm.com 7475735Snate@binkert.org flags.set(VALID_ADDR|VALID_SIZE); 7485735Snate@binkert.org deleteData(); 7492662Sstever@eecs.umich.edu } 7502566SN/A 7514626Sstever@eecs.umich.edu /** 7524626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 7539030Sandreas.hansson@arm.com * returning as a response to that request. The source field is 7549030Sandreas.hansson@arm.com * turned into the destination, and subsequently cleared. Note 7559030Sandreas.hansson@arm.com * that the latter is not necessary for atomic requests, but 7569030Sandreas.hansson@arm.com * causes no harm as neither field is valid. 7574626Sstever@eecs.umich.edu */ 7585735Snate@binkert.org void 7595735Snate@binkert.org makeResponse() 7604626Sstever@eecs.umich.edu { 7612662Sstever@eecs.umich.edu assert(needsResponse()); 7622855Srdreslin@umich.edu assert(isRequest()); 7634986Ssaidi@eecs.umich.edu origCmd = cmd; 7644022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7655745Snate@binkert.org 7667464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7677464Ssteve.reinhardt@amd.com // triggered them was 7687464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7697464Ssteve.reinhardt@amd.com 7705745Snate@binkert.org dest = src; 77110405Sandreas.hansson@arm.com src = InvalidPortID; 7722641Sstever@eecs.umich.edu } 7732641Sstever@eecs.umich.edu 7745735Snate@binkert.org void 7755735Snate@binkert.org makeAtomicResponse() 7764870Sstever@eecs.umich.edu { 7774870Sstever@eecs.umich.edu makeResponse(); 7784870Sstever@eecs.umich.edu } 7794870Sstever@eecs.umich.edu 7805735Snate@binkert.org void 7815735Snate@binkert.org makeTimingResponse() 7823348Sbinkertn@umich.edu { 7834870Sstever@eecs.umich.edu makeResponse(); 7843135Srdreslin@umich.edu } 7853135Srdreslin@umich.edu 7868436SBrad.Beckmann@amd.com void 7878436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7888436SBrad.Beckmann@amd.com { 7898436SBrad.Beckmann@amd.com if (!success) { 7908436SBrad.Beckmann@amd.com if (isWrite()) { 7918436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7928436SBrad.Beckmann@amd.com } else { 7938436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7948436SBrad.Beckmann@amd.com } 7958436SBrad.Beckmann@amd.com } 7968436SBrad.Beckmann@amd.com } 7978436SBrad.Beckmann@amd.com 7987006Snate@binkert.org void 7997006Snate@binkert.org setSize(unsigned size) 8007006Snate@binkert.org { 8017006Snate@binkert.org assert(!flags.isSet(VALID_SIZE)); 8027006Snate@binkert.org 8037006Snate@binkert.org this->size = size; 8047006Snate@binkert.org flags.set(VALID_SIZE); 8057006Snate@binkert.org } 8067006Snate@binkert.org 8072685Ssaidi@eecs.umich.edu 8083348Sbinkertn@umich.edu /** 8093348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 8103348Sbinkertn@umich.edu * freed. 8112566SN/A */ 8122566SN/A template <typename T> 8133348Sbinkertn@umich.edu void 8143348Sbinkertn@umich.edu dataStatic(T *p) 8153348Sbinkertn@umich.edu { 8165764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 8173348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8185735Snate@binkert.org flags.set(STATIC_DATA); 8193348Sbinkertn@umich.edu } 8202566SN/A 8213348Sbinkertn@umich.edu /** 82210564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 82310564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 82410564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 82510564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 82610564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 82710564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 82810564Sandreas.hansson@arm.com */ 82910564Sandreas.hansson@arm.com template <typename T> 83010564Sandreas.hansson@arm.com void 83110564Sandreas.hansson@arm.com dataStaticConst(const T *p) 83210564Sandreas.hansson@arm.com { 83310564Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 83410564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 83510564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 83610564Sandreas.hansson@arm.com } 83710564Sandreas.hansson@arm.com 83810564Sandreas.hansson@arm.com /** 8393348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 8403348Sbinkertn@umich.edu * called on it. 8413348Sbinkertn@umich.edu */ 8422566SN/A template <typename T> 8433348Sbinkertn@umich.edu void 8443348Sbinkertn@umich.edu dataDynamicArray(T *p) 8453348Sbinkertn@umich.edu { 8465764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 8473348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8485735Snate@binkert.org flags.set(DYNAMIC_DATA|ARRAY_DATA); 8493348Sbinkertn@umich.edu } 8503348Sbinkertn@umich.edu 8513348Sbinkertn@umich.edu /** 8523348Sbinkertn@umich.edu * set the data pointer to a value that should have delete called 8533348Sbinkertn@umich.edu * on it. 8543348Sbinkertn@umich.edu */ 8553348Sbinkertn@umich.edu template <typename T> 8563348Sbinkertn@umich.edu void 8573348Sbinkertn@umich.edu dataDynamic(T *p) 8583348Sbinkertn@umich.edu { 8595764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 8603348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8615735Snate@binkert.org flags.set(DYNAMIC_DATA); 8623348Sbinkertn@umich.edu } 8633348Sbinkertn@umich.edu 8645735Snate@binkert.org /** 8655735Snate@binkert.org * get a pointer to the data ptr. 8665735Snate@binkert.org */ 8673348Sbinkertn@umich.edu template <typename T> 8683348Sbinkertn@umich.edu T* 86910562Sandreas.hansson@arm.com getPtr() 8703348Sbinkertn@umich.edu { 87110562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8723348Sbinkertn@umich.edu return (T*)data; 8733348Sbinkertn@umich.edu } 8742566SN/A 87510563Sandreas.hansson@arm.com template <typename T> 87610563Sandreas.hansson@arm.com const T* 87710563Sandreas.hansson@arm.com getConstPtr() const 87810563Sandreas.hansson@arm.com { 87910563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 88010563Sandreas.hansson@arm.com return (const T*)data; 88110563Sandreas.hansson@arm.com } 88210563Sandreas.hansson@arm.com 8835735Snate@binkert.org /** 8845735Snate@binkert.org * return the value of what is pointed to in the packet. 8855735Snate@binkert.org */ 8862566SN/A template <typename T> 88710563Sandreas.hansson@arm.com T get() const; 8882566SN/A 8895735Snate@binkert.org /** 8905735Snate@binkert.org * set the value in the data pointer to v. 8915735Snate@binkert.org */ 8922566SN/A template <typename T> 8932592SN/A void set(T v); 8942566SN/A 8953348Sbinkertn@umich.edu /** 8964626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 8974626Sstever@eecs.umich.edu */ 8985735Snate@binkert.org void 89910563Sandreas.hansson@arm.com setData(const uint8_t *p) 9004626Sstever@eecs.umich.edu { 9017691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 9027691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 9034626Sstever@eecs.umich.edu } 9044626Sstever@eecs.umich.edu 9054626Sstever@eecs.umich.edu /** 9064626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 9074626Sstever@eecs.umich.edu * which is aligned to the given block size. 9084626Sstever@eecs.umich.edu */ 9095735Snate@binkert.org void 91010563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 9114626Sstever@eecs.umich.edu { 9124626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 9134626Sstever@eecs.umich.edu } 9144626Sstever@eecs.umich.edu 9154626Sstever@eecs.umich.edu /** 9164626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 9174626Sstever@eecs.umich.edu * is aligned to the given block size. 9184626Sstever@eecs.umich.edu */ 9195735Snate@binkert.org void 92010563Sandreas.hansson@arm.com writeData(uint8_t *p) const 9214626Sstever@eecs.umich.edu { 92210563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 9234626Sstever@eecs.umich.edu } 9244626Sstever@eecs.umich.edu 9254626Sstever@eecs.umich.edu /** 9264626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 9274626Sstever@eecs.umich.edu */ 9285735Snate@binkert.org void 92910563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 9304626Sstever@eecs.umich.edu { 9314626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 9324626Sstever@eecs.umich.edu } 9334626Sstever@eecs.umich.edu 9344626Sstever@eecs.umich.edu /** 9353348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 9363348Sbinkertn@umich.edu * matter how data was allocted. 9373348Sbinkertn@umich.edu */ 9385735Snate@binkert.org void 9395735Snate@binkert.org deleteData() 9405735Snate@binkert.org { 9415764Snate@binkert.org if (flags.isSet(ARRAY_DATA)) 9425735Snate@binkert.org delete [] data; 9435764Snate@binkert.org else if (flags.isSet(DYNAMIC_DATA)) 9445735Snate@binkert.org delete data; 9455735Snate@binkert.org 9465735Snate@binkert.org flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA); 9475735Snate@binkert.org data = NULL; 9485735Snate@binkert.org } 9492566SN/A 95010565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9515735Snate@binkert.org void 9525735Snate@binkert.org allocate() 9535735Snate@binkert.org { 9545764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 9555745Snate@binkert.org flags.set(DYNAMIC_DATA|ARRAY_DATA); 9565745Snate@binkert.org data = new uint8_t[getSize()]; 9575735Snate@binkert.org } 9585735Snate@binkert.org 9594626Sstever@eecs.umich.edu /** 9604626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 9614626Sstever@eecs.umich.edu * by a base/size pair and an associated data array. If the 9624626Sstever@eecs.umich.edu * functional request is a read, it may be satisfied by the memory 9634626Sstever@eecs.umich.edu * value. If the functional request is a write, it may update the 9644626Sstever@eecs.umich.edu * memory value. 9654626Sstever@eecs.umich.edu */ 96610028SGiacomo.Gabrielli@arm.com bool checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 96710028SGiacomo.Gabrielli@arm.com uint8_t *data); 9684626Sstever@eecs.umich.edu 9694626Sstever@eecs.umich.edu /** 9704626Sstever@eecs.umich.edu * Check a functional request against a memory value stored in 9715315Sstever@gmail.com * another packet (i.e. an in-transit request or response). 9724626Sstever@eecs.umich.edu */ 9735735Snate@binkert.org bool 9745735Snate@binkert.org checkFunctional(PacketPtr other) 9755735Snate@binkert.org { 9765735Snate@binkert.org uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL; 97710028SGiacomo.Gabrielli@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 97810028SGiacomo.Gabrielli@arm.com other->getSize(), data); 9794626Sstever@eecs.umich.edu } 9805314Sstever@gmail.com 9815315Sstever@gmail.com /** 9825315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 9835315Sstever@gmail.com */ 9845735Snate@binkert.org void 9855735Snate@binkert.org pushLabel(const std::string &lbl) 9865735Snate@binkert.org { 9875735Snate@binkert.org if (isPrint()) 9885735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 9895314Sstever@gmail.com } 9905314Sstever@gmail.com 9915315Sstever@gmail.com /** 9925315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 9935315Sstever@gmail.com */ 9945735Snate@binkert.org void 9955735Snate@binkert.org popLabel() 9965735Snate@binkert.org { 9975735Snate@binkert.org if (isPrint()) 9985735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 9995314Sstever@gmail.com } 10005314Sstever@gmail.com 10015314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 10025314Sstever@gmail.com const std::string &prefix = "") const; 10039663Suri.wiener@arm.com 10049663Suri.wiener@arm.com /** 10059663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 10069663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 10079663Suri.wiener@arm.com * avoiding string overheads in fast mode 10089663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 10099663Suri.wiener@arm.com */ 10109663Suri.wiener@arm.com std::string print() const; 10112381SN/A}; 10122381SN/A 10132381SN/A#endif //__MEM_PACKET_HH 1014