packet.hh revision 10570
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); } 18810570Sandreas.hansson@arm.com 18910570Sandreas.hansson@arm.com /** 19010570Sandreas.hansson@arm.com * Check if this particular packet type carries payload data. Note 19110570Sandreas.hansson@arm.com * that this does not reflect if the data pointer of the packet is 19210570Sandreas.hansson@arm.com * valid or not. 19310570Sandreas.hansson@arm.com */ 1944022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 1956102Sgblack@eecs.umich.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 19610343SCurtis.Dunham@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 19710343SCurtis.Dunham@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 19810343SCurtis.Dunham@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 19910343SCurtis.Dunham@arm.com testCmdAttrib(IsHWPrefetch); } 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 */ 2299044SAli.Saidi@ARM.comclass Packet : public Printable 2302381SN/A{ 2312813Srdreslin@umich.edu public: 2325735Snate@binkert.org typedef uint32_t FlagsType; 2335735Snate@binkert.org typedef ::Flags<FlagsType> Flags; 2344022Sstever@eecs.umich.edu 2355735Snate@binkert.org private: 2365735Snate@binkert.org static const FlagsType PUBLIC_FLAGS = 0x00000000; 2375735Snate@binkert.org static const FlagsType PRIVATE_FLAGS = 0x00007F0F; 2385735Snate@binkert.org static const FlagsType COPY_FLAGS = 0x0000000F; 2395735Snate@binkert.org 2405735Snate@binkert.org static const FlagsType SHARED = 0x00000001; 2415735Snate@binkert.org // Special control flags 2425735Snate@binkert.org /// Special timing-mode atomic snoop for multi-level coherence. 2435735Snate@binkert.org static const FlagsType EXPRESS_SNOOP = 0x00000002; 2445735Snate@binkert.org /// Does supplier have exclusive copy? 2455735Snate@binkert.org /// Useful for multi-level coherence. 2465735Snate@binkert.org static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004; 2475735Snate@binkert.org // Snoop response flags 2485735Snate@binkert.org static const FlagsType MEM_INHIBIT = 0x00000008; 2495735Snate@binkert.org /// Are the 'addr' and 'size' fields valid? 2505735Snate@binkert.org static const FlagsType VALID_ADDR = 0x00000100; 2515735Snate@binkert.org static const FlagsType VALID_SIZE = 0x00000200; 2525735Snate@binkert.org /// Is the data pointer set to a value that shouldn't be freed 2535735Snate@binkert.org /// when the packet is destroyed? 2545735Snate@binkert.org static const FlagsType STATIC_DATA = 0x00001000; 2555735Snate@binkert.org /// The data pointer points to a value that should be freed when 25610566Sandreas.hansson@arm.com /// the packet is destroyed. The pointer is assumed to be pointing 25710566Sandreas.hansson@arm.com /// to an array, and delete [] is consequently called 2585735Snate@binkert.org static const FlagsType DYNAMIC_DATA = 0x00002000; 2598436SBrad.Beckmann@amd.com /// suppress the error if this packet encounters a functional 2608436SBrad.Beckmann@amd.com /// access failure. 2618436SBrad.Beckmann@amd.com static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 26210192Smitch.hayenga@arm.com // Signal prefetch squash through express snoop flag 26310192Smitch.hayenga@arm.com static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; 2645735Snate@binkert.org 2655735Snate@binkert.org Flags flags; 2665735Snate@binkert.org 2675735Snate@binkert.org public: 2684022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 2694022Sstever@eecs.umich.edu 2705735Snate@binkert.org /// The command field of the packet. 2714870Sstever@eecs.umich.edu MemCmd cmd; 2724870Sstever@eecs.umich.edu 2735735Snate@binkert.org /// A pointer to the original request. 27410569Sandreas.hansson@arm.com const RequestPtr req; 2754870Sstever@eecs.umich.edu 2762566SN/A private: 2775735Snate@binkert.org /** 2785735Snate@binkert.org * A pointer to the data being transfered. It can be differnt 2795735Snate@binkert.org * sizes at each level of the heirarchy so it belongs in the 2805735Snate@binkert.org * packet, not request. This may or may not be populated when a 2815735Snate@binkert.org * responder recieves the packet. If not populated it memory should 2825735Snate@binkert.org * be allocated. 2832566SN/A */ 2842566SN/A PacketDataPtr data; 2852566SN/A 2865735Snate@binkert.org /// The address of the request. This address could be virtual or 2875735Snate@binkert.org /// physical, depending on the system configuration. 2882381SN/A Addr addr; 2892381SN/A 29010028SGiacomo.Gabrielli@arm.com /// True if the request targets the secure memory space. 29110028SGiacomo.Gabrielli@arm.com bool _isSecure; 29210028SGiacomo.Gabrielli@arm.com 2935735Snate@binkert.org /// The size of the request or transfer. 2946227Snate@binkert.org unsigned size; 2952381SN/A 2965735Snate@binkert.org /** 2979030Sandreas.hansson@arm.com * Source port identifier set on a request packet to enable 2989030Sandreas.hansson@arm.com * appropriate routing of the responses. The source port 29910405Sandreas.hansson@arm.com * identifier is set by any multiplexing component, e.g. a 30010405Sandreas.hansson@arm.com * crossbar, as the timing responses need this information to be 30110405Sandreas.hansson@arm.com * routed back to the appropriate port at a later point in 30210405Sandreas.hansson@arm.com * time. The field can be updated (over-written) as the request 30310405Sandreas.hansson@arm.com * packet passes through additional multiplexing components, and 30410405Sandreas.hansson@arm.com * it is their responsibility to remember the original source port 30510405Sandreas.hansson@arm.com * identifier, for example by using an appropriate sender 30610405Sandreas.hansson@arm.com * state. The latter is done in the cache and bridge. 3075735Snate@binkert.org */ 3089031Sandreas.hansson@arm.com PortID src; 3092381SN/A 3105735Snate@binkert.org /** 3119030Sandreas.hansson@arm.com * Destination port identifier that is present on all response 3129030Sandreas.hansson@arm.com * packets that passed through a multiplexing component as a 3139030Sandreas.hansson@arm.com * request packet. The source port identifier is turned into a 3149030Sandreas.hansson@arm.com * destination port identifier when the packet is turned into a 31510405Sandreas.hansson@arm.com * response, and the destination is used, e.g. by the crossbar, to 3169030Sandreas.hansson@arm.com * select the appropriate path through the interconnect. 3175735Snate@binkert.org */ 3189031Sandreas.hansson@arm.com PortID dest; 3192641Sstever@eecs.umich.edu 3205735Snate@binkert.org /** 3215735Snate@binkert.org * The original value of the command field. Only valid when the 3224870Sstever@eecs.umich.edu * current command field is an error condition; in that case, the 3234870Sstever@eecs.umich.edu * previous contents of the command field are copied here. This 3244870Sstever@eecs.umich.edu * field is *not* set on non-error responses. 3254870Sstever@eecs.umich.edu */ 3264870Sstever@eecs.umich.edu MemCmd origCmd; 3274870Sstever@eecs.umich.edu 3288668Sgeoffrey.blake@arm.com /** 3298668Sgeoffrey.blake@arm.com * These values specify the range of bytes found that satisfy a 3308668Sgeoffrey.blake@arm.com * functional read. 3318668Sgeoffrey.blake@arm.com */ 3328668Sgeoffrey.blake@arm.com uint16_t bytesValidStart; 3338668Sgeoffrey.blake@arm.com uint16_t bytesValidEnd; 3348668Sgeoffrey.blake@arm.com 3352641Sstever@eecs.umich.edu public: 3362811Srdreslin@umich.edu 3379547Sandreas.hansson@arm.com /** 3389547Sandreas.hansson@arm.com * The extra delay from seeing the packet until the first word is 33910405Sandreas.hansson@arm.com * transmitted. This delay is used to communicate the crossbar 34010405Sandreas.hansson@arm.com * forwarding latency to the neighbouring object (e.g. a cache) 34110405Sandreas.hansson@arm.com * that actually makes the packet wait. As the delay is relative, 34210405Sandreas.hansson@arm.com * a 32-bit unsigned should be sufficient. 3439547Sandreas.hansson@arm.com */ 34410405Sandreas.hansson@arm.com uint32_t firstWordDelay; 3453218Sgblack@eecs.umich.edu 3469547Sandreas.hansson@arm.com /** 34710405Sandreas.hansson@arm.com * The extra pipelining delay from seeing the packet until the 34810405Sandreas.hansson@arm.com * last word is transmitted by the component that provided it (if 34910405Sandreas.hansson@arm.com * any). This includes the first word delay. Similar to the first 35010405Sandreas.hansson@arm.com * word delay, this is used to make up for the fact that the 35110405Sandreas.hansson@arm.com * crossbar does not make the packet wait. As the delay is 35210405Sandreas.hansson@arm.com * relative, a 32-bit unsigned should be sufficient. 3539547Sandreas.hansson@arm.com */ 35410405Sandreas.hansson@arm.com uint32_t lastWordDelay; 3553218Sgblack@eecs.umich.edu 3565735Snate@binkert.org /** 3575735Snate@binkert.org * A virtual base opaque structure used to hold state associated 3589542Sandreas.hansson@arm.com * with the packet (e.g., an MSHR), specific to a MemObject that 3599542Sandreas.hansson@arm.com * sees the packet. A pointer to this state is returned in the 3609542Sandreas.hansson@arm.com * packet's response so that the MemObject in question can quickly 3619542Sandreas.hansson@arm.com * look up the state needed to process it. A specific subclass 3629542Sandreas.hansson@arm.com * would be derived from this to carry state specific to a 3639542Sandreas.hansson@arm.com * particular sending device. 3649542Sandreas.hansson@arm.com * 3659542Sandreas.hansson@arm.com * As multiple MemObjects may add their SenderState throughout the 3669542Sandreas.hansson@arm.com * memory system, the SenderStates create a stack, where a 3679542Sandreas.hansson@arm.com * MemObject can add a new Senderstate, as long as the 3689542Sandreas.hansson@arm.com * predecessing SenderState is restored when the response comes 3699542Sandreas.hansson@arm.com * back. For this reason, the predecessor should always be 3709542Sandreas.hansson@arm.com * populated with the current SenderState of a packet before 3719542Sandreas.hansson@arm.com * modifying the senderState field in the request packet. 3725735Snate@binkert.org */ 3735735Snate@binkert.org struct SenderState 3745735Snate@binkert.org { 3759542Sandreas.hansson@arm.com SenderState* predecessor; 3769542Sandreas.hansson@arm.com SenderState() : predecessor(NULL) {} 3772641Sstever@eecs.umich.edu virtual ~SenderState() {} 3782641Sstever@eecs.umich.edu }; 3792641Sstever@eecs.umich.edu 3805315Sstever@gmail.com /** 3815315Sstever@gmail.com * Object used to maintain state of a PrintReq. The senderState 3825315Sstever@gmail.com * field of a PrintReq should always be of this type. 3835315Sstever@gmail.com */ 3849044SAli.Saidi@ARM.com class PrintReqState : public SenderState 3855735Snate@binkert.org { 3865735Snate@binkert.org private: 3875735Snate@binkert.org /** 3885735Snate@binkert.org * An entry in the label stack. 3895735Snate@binkert.org */ 3905735Snate@binkert.org struct LabelStackEntry 3915735Snate@binkert.org { 3925314Sstever@gmail.com const std::string label; 3935314Sstever@gmail.com std::string *prefix; 3945314Sstever@gmail.com bool labelPrinted; 3955735Snate@binkert.org LabelStackEntry(const std::string &_label, std::string *_prefix); 3965314Sstever@gmail.com }; 3975314Sstever@gmail.com 3985314Sstever@gmail.com typedef std::list<LabelStackEntry> LabelStack; 3995314Sstever@gmail.com LabelStack labelStack; 4005314Sstever@gmail.com 4015314Sstever@gmail.com std::string *curPrefixPtr; 4025314Sstever@gmail.com 4035314Sstever@gmail.com public: 4045314Sstever@gmail.com std::ostream &os; 4055314Sstever@gmail.com const int verbosity; 4065314Sstever@gmail.com 4075314Sstever@gmail.com PrintReqState(std::ostream &os, int verbosity = 0); 4085314Sstever@gmail.com ~PrintReqState(); 4095314Sstever@gmail.com 4105735Snate@binkert.org /** 4115735Snate@binkert.org * Returns the current line prefix. 4125735Snate@binkert.org */ 4135314Sstever@gmail.com const std::string &curPrefix() { return *curPrefixPtr; } 4145315Sstever@gmail.com 4155735Snate@binkert.org /** 4165735Snate@binkert.org * Push a label onto the label stack, and prepend the given 4175315Sstever@gmail.com * prefix string onto the current prefix. Labels will only be 4185735Snate@binkert.org * printed if an object within the label's scope is printed. 4195735Snate@binkert.org */ 4205314Sstever@gmail.com void pushLabel(const std::string &lbl, 4215314Sstever@gmail.com const std::string &prefix = " "); 4225735Snate@binkert.org 4235735Snate@binkert.org /** 4245735Snate@binkert.org * Pop a label off the label stack. 4255735Snate@binkert.org */ 4265314Sstever@gmail.com void popLabel(); 4275735Snate@binkert.org 4285735Snate@binkert.org /** 4295735Snate@binkert.org * Print all of the pending unprinted labels on the 4305315Sstever@gmail.com * stack. Called by printObj(), so normally not called by 4315735Snate@binkert.org * users unless bypassing printObj(). 4325735Snate@binkert.org */ 4335314Sstever@gmail.com void printLabels(); 4345735Snate@binkert.org 4355735Snate@binkert.org /** 4365735Snate@binkert.org * Print a Printable object to os, because it matched the 4375735Snate@binkert.org * address on a PrintReq. 4385735Snate@binkert.org */ 4395314Sstever@gmail.com void printObj(Printable *obj); 4405314Sstever@gmail.com }; 4415314Sstever@gmail.com 4425735Snate@binkert.org /** 4435735Snate@binkert.org * This packet's sender state. Devices should use dynamic_cast<> 4445735Snate@binkert.org * to cast to the state appropriate to the sender. The intent of 4455735Snate@binkert.org * this variable is to allow a device to attach extra information 4469542Sandreas.hansson@arm.com * to a request. A response packet must return the sender state 4475735Snate@binkert.org * that was attached to the original request (even if a new packet 4485735Snate@binkert.org * is created). 4495735Snate@binkert.org */ 4502662Sstever@eecs.umich.edu SenderState *senderState; 4512641Sstever@eecs.umich.edu 4529542Sandreas.hansson@arm.com /** 4539542Sandreas.hansson@arm.com * Push a new sender state to the packet and make the current 4549542Sandreas.hansson@arm.com * sender state the predecessor of the new one. This should be 4559542Sandreas.hansson@arm.com * prefered over direct manipulation of the senderState member 4569542Sandreas.hansson@arm.com * variable. 4579542Sandreas.hansson@arm.com * 4589542Sandreas.hansson@arm.com * @param sender_state SenderState to push at the top of the stack 4599542Sandreas.hansson@arm.com */ 4609542Sandreas.hansson@arm.com void pushSenderState(SenderState *sender_state); 4619542Sandreas.hansson@arm.com 4629542Sandreas.hansson@arm.com /** 4639542Sandreas.hansson@arm.com * Pop the top of the state stack and return a pointer to it. This 4649542Sandreas.hansson@arm.com * assumes the current sender state is not NULL. This should be 4659542Sandreas.hansson@arm.com * preferred over direct manipulation of the senderState member 4669542Sandreas.hansson@arm.com * variable. 4679542Sandreas.hansson@arm.com * 4689542Sandreas.hansson@arm.com * @return The current top of the stack 4699542Sandreas.hansson@arm.com */ 4709542Sandreas.hansson@arm.com SenderState *popSenderState(); 4719542Sandreas.hansson@arm.com 4729543Ssascha.bischoff@arm.com /** 4739543Ssascha.bischoff@arm.com * Go through the sender state stack and return the first instance 4749543Ssascha.bischoff@arm.com * that is of type T (as determined by a dynamic_cast). If there 4759543Ssascha.bischoff@arm.com * is no sender state of type T, NULL is returned. 4769543Ssascha.bischoff@arm.com * 4779543Ssascha.bischoff@arm.com * @return The topmost state of type T 4789543Ssascha.bischoff@arm.com */ 4799543Ssascha.bischoff@arm.com template <typename T> 4809543Ssascha.bischoff@arm.com T * findNextSenderState() const 4819543Ssascha.bischoff@arm.com { 4829543Ssascha.bischoff@arm.com T *t = NULL; 4839543Ssascha.bischoff@arm.com SenderState* sender_state = senderState; 4849543Ssascha.bischoff@arm.com while (t == NULL && sender_state != NULL) { 4859543Ssascha.bischoff@arm.com t = dynamic_cast<T*>(sender_state); 4869543Ssascha.bischoff@arm.com sender_state = sender_state->predecessor; 4879543Ssascha.bischoff@arm.com } 4889543Ssascha.bischoff@arm.com return t; 4899543Ssascha.bischoff@arm.com } 4909543Ssascha.bischoff@arm.com 4915735Snate@binkert.org /// Return the string name of the cmd field (for debugging and 4925735Snate@binkert.org /// tracing). 4934022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 4942811Srdreslin@umich.edu 4955735Snate@binkert.org /// Return the index of this command. 4964022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 4972811Srdreslin@umich.edu 4984022Sstever@eecs.umich.edu bool isRead() const { return cmd.isRead(); } 4997465Ssteve.reinhardt@amd.com bool isWrite() const { return cmd.isWrite(); } 5007465Ssteve.reinhardt@amd.com bool isUpgrade() const { return cmd.isUpgrade(); } 5014022Sstever@eecs.umich.edu bool isRequest() const { return cmd.isRequest(); } 5024022Sstever@eecs.umich.edu bool isResponse() const { return cmd.isResponse(); } 5034870Sstever@eecs.umich.edu bool needsExclusive() const { return cmd.needsExclusive(); } 5044022Sstever@eecs.umich.edu bool needsResponse() const { return cmd.needsResponse(); } 5054022Sstever@eecs.umich.edu bool isInvalidate() const { return cmd.isInvalidate(); } 5064022Sstever@eecs.umich.edu bool hasData() const { return cmd.hasData(); } 5076102Sgblack@eecs.umich.edu bool isLLSC() const { return cmd.isLLSC(); } 5084870Sstever@eecs.umich.edu bool isError() const { return cmd.isError(); } 5095314Sstever@gmail.com bool isPrint() const { return cmd.isPrint(); } 5108184Ssomayeh@cs.wisc.edu bool isFlush() const { return cmd.isFlush(); } 5112812Srdreslin@umich.edu 5124870Sstever@eecs.umich.edu // Snoop flags 51310567Sandreas.hansson@arm.com void assertMemInhibit() 51410567Sandreas.hansson@arm.com { 51510567Sandreas.hansson@arm.com assert(isRequest()); 51610567Sandreas.hansson@arm.com assert(!flags.isSet(MEM_INHIBIT)); 51710567Sandreas.hansson@arm.com flags.set(MEM_INHIBIT); 51810567Sandreas.hansson@arm.com } 5199951Sstephan.diestelhorst@arm.com bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 5209951Sstephan.diestelhorst@arm.com void assertShared() { flags.set(SHARED); } 5219951Sstephan.diestelhorst@arm.com bool sharedAsserted() const { return flags.isSet(SHARED); } 5224870Sstever@eecs.umich.edu 5234895Sstever@eecs.umich.edu // Special control flags 5249951Sstephan.diestelhorst@arm.com void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 5259951Sstephan.diestelhorst@arm.com bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 5269951Sstephan.diestelhorst@arm.com void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 5279951Sstephan.diestelhorst@arm.com void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 5289951Sstephan.diestelhorst@arm.com bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 5299951Sstephan.diestelhorst@arm.com void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 5309951Sstephan.diestelhorst@arm.com bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 53110192Smitch.hayenga@arm.com void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } 53210192Smitch.hayenga@arm.com bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } 5334895Sstever@eecs.umich.edu 5344870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 5354870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 5364870Sstever@eecs.umich.edu // field, etc.) 5375735Snate@binkert.org void 5385735Snate@binkert.org setBadAddress() 5395735Snate@binkert.org { 5405735Snate@binkert.org assert(isResponse()); 5415735Snate@binkert.org cmd = MemCmd::BadAddressError; 5425735Snate@binkert.org } 5435735Snate@binkert.org 5445735Snate@binkert.org bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 5454986Ssaidi@eecs.umich.edu void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 5462814Srdreslin@umich.edu 5479031Sandreas.hansson@arm.com bool isSrcValid() const { return src != InvalidPortID; } 5485735Snate@binkert.org /// Accessor function to get the source index of the packet. 5499031Sandreas.hansson@arm.com PortID getSrc() const { assert(isSrcValid()); return src; } 5505735Snate@binkert.org /// Accessor function to set the source index of the packet. 5519031Sandreas.hansson@arm.com void setSrc(PortID _src) { src = _src; } 5522641Sstever@eecs.umich.edu 5539031Sandreas.hansson@arm.com bool isDestValid() const { return dest != InvalidPortID; } 5545735Snate@binkert.org /// Accessor function for the destination index of the packet. 5559031Sandreas.hansson@arm.com PortID getDest() const { assert(isDestValid()); return dest; } 5565735Snate@binkert.org /// Accessor function to set the destination index of the packet. 5579031Sandreas.hansson@arm.com void setDest(PortID _dest) { dest = _dest; } 5588949Sandreas.hansson@arm.com /// Reset destination field, e.g. to turn a response into a request again. 5599031Sandreas.hansson@arm.com void clearDest() { dest = InvalidPortID; } 5602381SN/A 5615764Snate@binkert.org Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 5629259SAli.Saidi@ARM.com /** 5639259SAli.Saidi@ARM.com * Update the address of this packet mid-transaction. This is used 5649259SAli.Saidi@ARM.com * by the address mapper to change an already set address to a new 5659259SAli.Saidi@ARM.com * one based on the system configuration. It is intended to remap 5669259SAli.Saidi@ARM.com * an existing address, so it asserts that the current address is 5679259SAli.Saidi@ARM.com * valid. 5689259SAli.Saidi@ARM.com */ 5699259SAli.Saidi@ARM.com void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 5709259SAli.Saidi@ARM.com 5716227Snate@binkert.org unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 5725735Snate@binkert.org Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 5732549SN/A 57410028SGiacomo.Gabrielli@arm.com bool isSecure() const 57510028SGiacomo.Gabrielli@arm.com { 57610028SGiacomo.Gabrielli@arm.com assert(flags.isSet(VALID_ADDR)); 57710028SGiacomo.Gabrielli@arm.com return _isSecure; 57810028SGiacomo.Gabrielli@arm.com } 57910028SGiacomo.Gabrielli@arm.com 5805735Snate@binkert.org /** 5817550SBrad.Beckmann@amd.com * It has been determined that the SC packet should successfully update 5827550SBrad.Beckmann@amd.com * memory. Therefore, convert this SC packet to a normal write. 5837550SBrad.Beckmann@amd.com */ 5847550SBrad.Beckmann@amd.com void 5857550SBrad.Beckmann@amd.com convertScToWrite() 5867550SBrad.Beckmann@amd.com { 5877550SBrad.Beckmann@amd.com assert(isLLSC()); 5887550SBrad.Beckmann@amd.com assert(isWrite()); 5897550SBrad.Beckmann@amd.com cmd = MemCmd::WriteReq; 5907550SBrad.Beckmann@amd.com } 5917550SBrad.Beckmann@amd.com 5927550SBrad.Beckmann@amd.com /** 5937550SBrad.Beckmann@amd.com * When ruby is in use, Ruby will monitor the cache line and thus M5 5947550SBrad.Beckmann@amd.com * phys memory should treat LL ops as normal reads. 5957550SBrad.Beckmann@amd.com */ 5967550SBrad.Beckmann@amd.com void 5977550SBrad.Beckmann@amd.com convertLlToRead() 5987550SBrad.Beckmann@amd.com { 5997550SBrad.Beckmann@amd.com assert(isLLSC()); 6007550SBrad.Beckmann@amd.com assert(isRead()); 6017550SBrad.Beckmann@amd.com cmd = MemCmd::ReadReq; 6027550SBrad.Beckmann@amd.com } 6037550SBrad.Beckmann@amd.com 6047550SBrad.Beckmann@amd.com /** 6055735Snate@binkert.org * Constructor. Note that a Request object must be constructed 6065735Snate@binkert.org * first, but the Requests's physical address and size fields need 6079030Sandreas.hansson@arm.com * not be valid. The command must be supplied. 6085735Snate@binkert.org */ 60910569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd) 61010360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 61110412Sandreas.hansson@arm.com size(0), src(InvalidPortID), dest(InvalidPortID), 6128949Sandreas.hansson@arm.com bytesValidStart(0), bytesValidEnd(0), 61310405Sandreas.hansson@arm.com firstWordDelay(0), lastWordDelay(0), 6149546Sandreas.hansson@arm.com senderState(NULL) 6152641Sstever@eecs.umich.edu { 6166104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 6176104Ssteve.reinhardt@amd.com addr = req->getPaddr(); 6186104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 61910028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6206104Ssteve.reinhardt@amd.com } 6216104Ssteve.reinhardt@amd.com if (req->hasSize()) { 6226104Ssteve.reinhardt@amd.com size = req->getSize(); 6236104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6246104Ssteve.reinhardt@amd.com } 6252813Srdreslin@umich.edu } 6262813Srdreslin@umich.edu 6275735Snate@binkert.org /** 6285735Snate@binkert.org * Alternate constructor if you are trying to create a packet with 6295735Snate@binkert.org * a request that is for a whole block, not the address from the 6305735Snate@binkert.org * req. this allows for overriding the size/addr of the req. 6315735Snate@binkert.org */ 63210569Sandreas.hansson@arm.com Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 63310360Sandreas.hansson@arm.com : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 6349031Sandreas.hansson@arm.com src(InvalidPortID), dest(InvalidPortID), 6358949Sandreas.hansson@arm.com bytesValidStart(0), bytesValidEnd(0), 63610405Sandreas.hansson@arm.com firstWordDelay(0), lastWordDelay(0), 6379546Sandreas.hansson@arm.com senderState(NULL) 6382813Srdreslin@umich.edu { 6396104Ssteve.reinhardt@amd.com if (req->hasPaddr()) { 6406104Ssteve.reinhardt@amd.com addr = req->getPaddr() & ~(_blkSize - 1); 6416104Ssteve.reinhardt@amd.com flags.set(VALID_ADDR); 64210028SGiacomo.Gabrielli@arm.com _isSecure = req->isSecure(); 6436104Ssteve.reinhardt@amd.com } 6446104Ssteve.reinhardt@amd.com size = _blkSize; 6456104Ssteve.reinhardt@amd.com flags.set(VALID_SIZE); 6464626Sstever@eecs.umich.edu } 6474626Sstever@eecs.umich.edu 6485735Snate@binkert.org /** 6495735Snate@binkert.org * Alternate constructor for copying a packet. Copy all fields 6504887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 6514887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 6524887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 6535735Snate@binkert.org * packet should allocate its own data. 6545735Snate@binkert.org */ 65510569Sandreas.hansson@arm.com Packet(PacketPtr pkt, bool clearFlags = false) 6565735Snate@binkert.org : cmd(pkt->cmd), req(pkt->req), 6575764Snate@binkert.org data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), 65810028SGiacomo.Gabrielli@arm.com addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 65910028SGiacomo.Gabrielli@arm.com src(pkt->src), dest(pkt->dest), 6609547Sandreas.hansson@arm.com bytesValidStart(pkt->bytesValidStart), 6619547Sandreas.hansson@arm.com bytesValidEnd(pkt->bytesValidEnd), 66210405Sandreas.hansson@arm.com firstWordDelay(pkt->firstWordDelay), 66310405Sandreas.hansson@arm.com lastWordDelay(pkt->lastWordDelay), 6649546Sandreas.hansson@arm.com senderState(pkt->senderState) 6654626Sstever@eecs.umich.edu { 6665735Snate@binkert.org if (!clearFlags) 6675735Snate@binkert.org flags.set(pkt->flags & COPY_FLAGS); 6685735Snate@binkert.org 6699031Sandreas.hansson@arm.com flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 6705735Snate@binkert.org flags.set(pkt->flags & STATIC_DATA); 67110565Sandreas.hansson@arm.com 67210565Sandreas.hansson@arm.com // if we did not copy the static data pointer, allocate data 67310565Sandreas.hansson@arm.com // dynamically instead 67410565Sandreas.hansson@arm.com if (!data) 67510565Sandreas.hansson@arm.com allocate(); 67610342SCurtis.Dunham@arm.com } 6778668Sgeoffrey.blake@arm.com 67810342SCurtis.Dunham@arm.com /** 67910342SCurtis.Dunham@arm.com * Change the packet type based on request type. 68010342SCurtis.Dunham@arm.com */ 68110342SCurtis.Dunham@arm.com void 68210342SCurtis.Dunham@arm.com refineCommand() 68310342SCurtis.Dunham@arm.com { 68410342SCurtis.Dunham@arm.com if (cmd == MemCmd::ReadReq) { 68510342SCurtis.Dunham@arm.com if (req->isLLSC()) { 68610342SCurtis.Dunham@arm.com cmd = MemCmd::LoadLockedReq; 68710343SCurtis.Dunham@arm.com } else if (req->isPrefetch()) { 68810343SCurtis.Dunham@arm.com cmd = MemCmd::SoftPFReq; 68910342SCurtis.Dunham@arm.com } 69010342SCurtis.Dunham@arm.com } else if (cmd == MemCmd::WriteReq) { 69110342SCurtis.Dunham@arm.com if (req->isLLSC()) { 69210342SCurtis.Dunham@arm.com cmd = MemCmd::StoreCondReq; 69310342SCurtis.Dunham@arm.com } else if (req->isSwap()) { 69410342SCurtis.Dunham@arm.com cmd = MemCmd::SwapReq; 69510342SCurtis.Dunham@arm.com } 69610342SCurtis.Dunham@arm.com } 69710342SCurtis.Dunham@arm.com } 69810342SCurtis.Dunham@arm.com 69910342SCurtis.Dunham@arm.com /** 70010342SCurtis.Dunham@arm.com * Constructor-like methods that return Packets based on Request objects. 70110342SCurtis.Dunham@arm.com * Will call refineCommand() to fine-tune the Packet type if it's not a 70210342SCurtis.Dunham@arm.com * vanilla read or write. 70310342SCurtis.Dunham@arm.com */ 70410342SCurtis.Dunham@arm.com static PacketPtr 70510569Sandreas.hansson@arm.com createRead(const RequestPtr req) 70610342SCurtis.Dunham@arm.com { 70710342SCurtis.Dunham@arm.com PacketPtr pkt = new Packet(req, MemCmd::ReadReq); 70810342SCurtis.Dunham@arm.com pkt->refineCommand(); 70910342SCurtis.Dunham@arm.com return pkt; 71010342SCurtis.Dunham@arm.com } 71110342SCurtis.Dunham@arm.com 71210342SCurtis.Dunham@arm.com static PacketPtr 71310569Sandreas.hansson@arm.com createWrite(const RequestPtr req) 71410342SCurtis.Dunham@arm.com { 71510342SCurtis.Dunham@arm.com PacketPtr pkt = new Packet(req, MemCmd::WriteReq); 71610342SCurtis.Dunham@arm.com pkt->refineCommand(); 71710342SCurtis.Dunham@arm.com return pkt; 7182641Sstever@eecs.umich.edu } 7192549SN/A 7205735Snate@binkert.org /** 7215735Snate@binkert.org * clean up packet variables 7225735Snate@binkert.org */ 7232566SN/A ~Packet() 7245387Sstever@gmail.com { 7255387Sstever@gmail.com // If this is a request packet for which there's no response, 7265387Sstever@gmail.com // delete the request object here, since the requester will 7275387Sstever@gmail.com // never get the chance. 7285387Sstever@gmail.com if (req && isRequest() && !needsResponse()) 7295387Sstever@gmail.com delete req; 7305735Snate@binkert.org deleteData(); 7315387Sstever@gmail.com } 7322566SN/A 7335735Snate@binkert.org /** 7344626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 7359030Sandreas.hansson@arm.com * returning as a response to that request. The source field is 7369030Sandreas.hansson@arm.com * turned into the destination, and subsequently cleared. Note 7379030Sandreas.hansson@arm.com * that the latter is not necessary for atomic requests, but 7389030Sandreas.hansson@arm.com * causes no harm as neither field is valid. 7394626Sstever@eecs.umich.edu */ 7405735Snate@binkert.org void 7415735Snate@binkert.org makeResponse() 7424626Sstever@eecs.umich.edu { 7432662Sstever@eecs.umich.edu assert(needsResponse()); 7442855Srdreslin@umich.edu assert(isRequest()); 7454986Ssaidi@eecs.umich.edu origCmd = cmd; 7464022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 7475745Snate@binkert.org 7487464Ssteve.reinhardt@amd.com // responses are never express, even if the snoop that 7497464Ssteve.reinhardt@amd.com // triggered them was 7507464Ssteve.reinhardt@amd.com flags.clear(EXPRESS_SNOOP); 7517464Ssteve.reinhardt@amd.com 7525745Snate@binkert.org dest = src; 75310405Sandreas.hansson@arm.com src = InvalidPortID; 7542641Sstever@eecs.umich.edu } 7552641Sstever@eecs.umich.edu 7565735Snate@binkert.org void 7575735Snate@binkert.org makeAtomicResponse() 7584870Sstever@eecs.umich.edu { 7594870Sstever@eecs.umich.edu makeResponse(); 7604870Sstever@eecs.umich.edu } 7614870Sstever@eecs.umich.edu 7625735Snate@binkert.org void 7635735Snate@binkert.org makeTimingResponse() 7643348Sbinkertn@umich.edu { 7654870Sstever@eecs.umich.edu makeResponse(); 7663135Srdreslin@umich.edu } 7673135Srdreslin@umich.edu 7688436SBrad.Beckmann@amd.com void 7698436SBrad.Beckmann@amd.com setFunctionalResponseStatus(bool success) 7708436SBrad.Beckmann@amd.com { 7718436SBrad.Beckmann@amd.com if (!success) { 7728436SBrad.Beckmann@amd.com if (isWrite()) { 7738436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalWriteError; 7748436SBrad.Beckmann@amd.com } else { 7758436SBrad.Beckmann@amd.com cmd = MemCmd::FunctionalReadError; 7768436SBrad.Beckmann@amd.com } 7778436SBrad.Beckmann@amd.com } 7788436SBrad.Beckmann@amd.com } 7798436SBrad.Beckmann@amd.com 7807006Snate@binkert.org void 7817006Snate@binkert.org setSize(unsigned size) 7827006Snate@binkert.org { 7837006Snate@binkert.org assert(!flags.isSet(VALID_SIZE)); 7847006Snate@binkert.org 7857006Snate@binkert.org this->size = size; 7867006Snate@binkert.org flags.set(VALID_SIZE); 7877006Snate@binkert.org } 7887006Snate@binkert.org 7892685Ssaidi@eecs.umich.edu 7903348Sbinkertn@umich.edu /** 7913348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 7923348Sbinkertn@umich.edu * freed. 7932566SN/A */ 7942566SN/A template <typename T> 7953348Sbinkertn@umich.edu void 7963348Sbinkertn@umich.edu dataStatic(T *p) 7973348Sbinkertn@umich.edu { 79810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 7993348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8005735Snate@binkert.org flags.set(STATIC_DATA); 8013348Sbinkertn@umich.edu } 8022566SN/A 8033348Sbinkertn@umich.edu /** 80410564Sandreas.hansson@arm.com * Set the data pointer to the following value that should not be 80510564Sandreas.hansson@arm.com * freed. This version of the function allows the pointer passed 80610564Sandreas.hansson@arm.com * to us to be const. To avoid issues down the line we cast the 80710564Sandreas.hansson@arm.com * constness away, the alternative would be to keep both a const 80810564Sandreas.hansson@arm.com * and non-const data pointer and cleverly choose between 80910564Sandreas.hansson@arm.com * them. Note that this is only allowed for static data. 81010564Sandreas.hansson@arm.com */ 81110564Sandreas.hansson@arm.com template <typename T> 81210564Sandreas.hansson@arm.com void 81310564Sandreas.hansson@arm.com dataStaticConst(const T *p) 81410564Sandreas.hansson@arm.com { 81510566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 81610564Sandreas.hansson@arm.com data = const_cast<PacketDataPtr>(p); 81710564Sandreas.hansson@arm.com flags.set(STATIC_DATA); 81810564Sandreas.hansson@arm.com } 81910564Sandreas.hansson@arm.com 82010564Sandreas.hansson@arm.com /** 8213348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 8223348Sbinkertn@umich.edu * called on it. 8233348Sbinkertn@umich.edu */ 8242566SN/A template <typename T> 8253348Sbinkertn@umich.edu void 8263348Sbinkertn@umich.edu dataDynamic(T *p) 8273348Sbinkertn@umich.edu { 82810566Sandreas.hansson@arm.com assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 8293348Sbinkertn@umich.edu data = (PacketDataPtr)p; 8305735Snate@binkert.org flags.set(DYNAMIC_DATA); 8313348Sbinkertn@umich.edu } 8323348Sbinkertn@umich.edu 8335735Snate@binkert.org /** 8345735Snate@binkert.org * get a pointer to the data ptr. 8355735Snate@binkert.org */ 8363348Sbinkertn@umich.edu template <typename T> 8373348Sbinkertn@umich.edu T* 83810562Sandreas.hansson@arm.com getPtr() 8393348Sbinkertn@umich.edu { 84010562Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 8413348Sbinkertn@umich.edu return (T*)data; 8423348Sbinkertn@umich.edu } 8432566SN/A 84410563Sandreas.hansson@arm.com template <typename T> 84510563Sandreas.hansson@arm.com const T* 84610563Sandreas.hansson@arm.com getConstPtr() const 84710563Sandreas.hansson@arm.com { 84810563Sandreas.hansson@arm.com assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 84910563Sandreas.hansson@arm.com return (const T*)data; 85010563Sandreas.hansson@arm.com } 85110563Sandreas.hansson@arm.com 8525735Snate@binkert.org /** 8535735Snate@binkert.org * return the value of what is pointed to in the packet. 8545735Snate@binkert.org */ 8552566SN/A template <typename T> 85610563Sandreas.hansson@arm.com T get() const; 8572566SN/A 8585735Snate@binkert.org /** 8595735Snate@binkert.org * set the value in the data pointer to v. 8605735Snate@binkert.org */ 8612566SN/A template <typename T> 8622592SN/A void set(T v); 8632566SN/A 8643348Sbinkertn@umich.edu /** 8654626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 8664626Sstever@eecs.umich.edu */ 8675735Snate@binkert.org void 86810563Sandreas.hansson@arm.com setData(const uint8_t *p) 8694626Sstever@eecs.umich.edu { 8707691SAli.Saidi@ARM.com if (p != getPtr<uint8_t>()) 8717691SAli.Saidi@ARM.com std::memcpy(getPtr<uint8_t>(), p, getSize()); 8724626Sstever@eecs.umich.edu } 8734626Sstever@eecs.umich.edu 8744626Sstever@eecs.umich.edu /** 8754626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 8764626Sstever@eecs.umich.edu * which is aligned to the given block size. 8774626Sstever@eecs.umich.edu */ 8785735Snate@binkert.org void 87910563Sandreas.hansson@arm.com setDataFromBlock(const uint8_t *blk_data, int blkSize) 8804626Sstever@eecs.umich.edu { 8814626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 8824626Sstever@eecs.umich.edu } 8834626Sstever@eecs.umich.edu 8844626Sstever@eecs.umich.edu /** 8854626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 8864626Sstever@eecs.umich.edu * is aligned to the given block size. 8874626Sstever@eecs.umich.edu */ 8885735Snate@binkert.org void 88910563Sandreas.hansson@arm.com writeData(uint8_t *p) const 8904626Sstever@eecs.umich.edu { 89110563Sandreas.hansson@arm.com std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 8924626Sstever@eecs.umich.edu } 8934626Sstever@eecs.umich.edu 8944626Sstever@eecs.umich.edu /** 8954626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 8964626Sstever@eecs.umich.edu */ 8975735Snate@binkert.org void 89810563Sandreas.hansson@arm.com writeDataToBlock(uint8_t *blk_data, int blkSize) const 8994626Sstever@eecs.umich.edu { 9004626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 9014626Sstever@eecs.umich.edu } 9024626Sstever@eecs.umich.edu 9034626Sstever@eecs.umich.edu /** 9043348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 9053348Sbinkertn@umich.edu * matter how data was allocted. 9063348Sbinkertn@umich.edu */ 9075735Snate@binkert.org void 9085735Snate@binkert.org deleteData() 9095735Snate@binkert.org { 91010566Sandreas.hansson@arm.com if (flags.isSet(DYNAMIC_DATA)) 9115735Snate@binkert.org delete [] data; 9125735Snate@binkert.org 91310566Sandreas.hansson@arm.com flags.clear(STATIC_DATA|DYNAMIC_DATA); 9145735Snate@binkert.org data = NULL; 9155735Snate@binkert.org } 9162566SN/A 91710565Sandreas.hansson@arm.com /** Allocate memory for the packet. */ 9185735Snate@binkert.org void 9195735Snate@binkert.org allocate() 9205735Snate@binkert.org { 9215764Snate@binkert.org assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 92210566Sandreas.hansson@arm.com flags.set(DYNAMIC_DATA); 9235745Snate@binkert.org data = new uint8_t[getSize()]; 9245735Snate@binkert.org } 9255735Snate@binkert.org 9264626Sstever@eecs.umich.edu /** 92710570Sandreas.hansson@arm.com * Check a functional request against a memory value stored in 92810570Sandreas.hansson@arm.com * another packet (i.e. an in-transit request or 92910570Sandreas.hansson@arm.com * response). Returns true if the current packet is a read, and 93010570Sandreas.hansson@arm.com * the other packet provides the data, which is then copied to the 93110570Sandreas.hansson@arm.com * current packet. If the current packet is a write, and the other 93210570Sandreas.hansson@arm.com * packet intersects this one, then we update the data 93310570Sandreas.hansson@arm.com * accordingly. 93410570Sandreas.hansson@arm.com */ 93510570Sandreas.hansson@arm.com bool 93610570Sandreas.hansson@arm.com checkFunctional(PacketPtr other) 93710570Sandreas.hansson@arm.com { 93810570Sandreas.hansson@arm.com // all packets that are carrying a payload should have a valid 93910570Sandreas.hansson@arm.com // data pointer 94010570Sandreas.hansson@arm.com return checkFunctional(other, other->getAddr(), other->isSecure(), 94110570Sandreas.hansson@arm.com other->getSize(), 94210570Sandreas.hansson@arm.com other->hasData() ? 94310570Sandreas.hansson@arm.com other->getPtr<uint8_t>() : NULL); 94410570Sandreas.hansson@arm.com } 94510570Sandreas.hansson@arm.com 94610570Sandreas.hansson@arm.com /** 9474626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 94810570Sandreas.hansson@arm.com * by a base/size pair and an associated data array. If the 94910570Sandreas.hansson@arm.com * current packet is a read, it may be satisfied by the memory 95010570Sandreas.hansson@arm.com * value. If the current packet is a write, it may update the 9514626Sstever@eecs.umich.edu * memory value. 9524626Sstever@eecs.umich.edu */ 9535735Snate@binkert.org bool 95410570Sandreas.hansson@arm.com checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 95510570Sandreas.hansson@arm.com uint8_t *_data); 9565314Sstever@gmail.com 9575315Sstever@gmail.com /** 9585315Sstever@gmail.com * Push label for PrintReq (safe to call unconditionally). 9595315Sstever@gmail.com */ 9605735Snate@binkert.org void 9615735Snate@binkert.org pushLabel(const std::string &lbl) 9625735Snate@binkert.org { 9635735Snate@binkert.org if (isPrint()) 9645735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 9655314Sstever@gmail.com } 9665314Sstever@gmail.com 9675315Sstever@gmail.com /** 9685315Sstever@gmail.com * Pop label for PrintReq (safe to call unconditionally). 9695315Sstever@gmail.com */ 9705735Snate@binkert.org void 9715735Snate@binkert.org popLabel() 9725735Snate@binkert.org { 9735735Snate@binkert.org if (isPrint()) 9745735Snate@binkert.org safe_cast<PrintReqState*>(senderState)->popLabel(); 9755314Sstever@gmail.com } 9765314Sstever@gmail.com 9775314Sstever@gmail.com void print(std::ostream &o, int verbosity = 0, 9785314Sstever@gmail.com const std::string &prefix = "") const; 9799663Suri.wiener@arm.com 9809663Suri.wiener@arm.com /** 9819663Suri.wiener@arm.com * A no-args wrapper of print(std::ostream...) 9829663Suri.wiener@arm.com * meant to be invoked from DPRINTFs 9839663Suri.wiener@arm.com * avoiding string overheads in fast mode 9849663Suri.wiener@arm.com * @return string with the request's type and start<->end addresses 9859663Suri.wiener@arm.com */ 9869663Suri.wiener@arm.com std::string print() const; 9872381SN/A}; 9882381SN/A 9892381SN/A#endif //__MEM_PACKET_HH 990