packet.hh revision 11057
110447Snilay@cs.wisc.edu/* 210447Snilay@cs.wisc.edu * Copyright (c) 2012-2015 ARM Limited 310447Snilay@cs.wisc.edu * All rights reserved 410447Snilay@cs.wisc.edu * 510447Snilay@cs.wisc.edu * The license below extends only to copyright in the software and shall 610447Snilay@cs.wisc.edu * not be construed as granting a license to any other intellectual 710447Snilay@cs.wisc.edu * property including but not limited to intellectual property relating 810447Snilay@cs.wisc.edu * to a hardware implementation of the functionality of the software 910447Snilay@cs.wisc.edu * licensed hereunder. You may use the software subject to the license 1010447Snilay@cs.wisc.edu * terms below provided that you ensure that this notice is replicated 1110447Snilay@cs.wisc.edu * unmodified and in its entirety in all distributions of the software, 1210447Snilay@cs.wisc.edu * modified or unmodified, in source code or in binary form. 1310447Snilay@cs.wisc.edu * 1410447Snilay@cs.wisc.edu * Copyright (c) 2006 The Regents of The University of Michigan 1510447Snilay@cs.wisc.edu * Copyright (c) 2010,2015 Advanced Micro Devices, Inc. 1610447Snilay@cs.wisc.edu * All rights reserved. 1710447Snilay@cs.wisc.edu * 1810447Snilay@cs.wisc.edu * Redistribution and use in source and binary forms, with or without 1910447Snilay@cs.wisc.edu * modification, are permitted provided that the following conditions are 2010447Snilay@cs.wisc.edu * met: redistributions of source code must retain the above copyright 2110447Snilay@cs.wisc.edu * notice, this list of conditions and the following disclaimer; 2210447Snilay@cs.wisc.edu * redistributions in binary form must reproduce the above copyright 2310447Snilay@cs.wisc.edu * notice, this list of conditions and the following disclaimer in the 2410447Snilay@cs.wisc.edu * documentation and/or other materials provided with the distribution; 2510447Snilay@cs.wisc.edu * neither the name of the copyright holders nor the names of its 2610447Snilay@cs.wisc.edu * contributors may be used to endorse or promote products derived from 2710447Snilay@cs.wisc.edu * this software without specific prior written permission. 2810447Snilay@cs.wisc.edu * 2910447Snilay@cs.wisc.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 3010447Snilay@cs.wisc.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3110447Snilay@cs.wisc.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 3210447Snilay@cs.wisc.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3310447Snilay@cs.wisc.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3410447Snilay@cs.wisc.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3510447Snilay@cs.wisc.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3610447Snilay@cs.wisc.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3710447Snilay@cs.wisc.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3810447Snilay@cs.wisc.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3910447Snilay@cs.wisc.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 4010447Snilay@cs.wisc.edu * 4110447Snilay@cs.wisc.edu * Authors: Ron Dreslinski 4210447Snilay@cs.wisc.edu * Steve Reinhardt 4310447Snilay@cs.wisc.edu * Ali Saidi 4410447Snilay@cs.wisc.edu * Andreas Hansson 4510447Snilay@cs.wisc.edu */ 4610447Snilay@cs.wisc.edu 4710447Snilay@cs.wisc.edu/** 4810447Snilay@cs.wisc.edu * @file 4910447Snilay@cs.wisc.edu * Declaration of the Packet class. 5010447Snilay@cs.wisc.edu */ 5110447Snilay@cs.wisc.edu 5210447Snilay@cs.wisc.edu#ifndef __MEM_PACKET_HH__ 5310447Snilay@cs.wisc.edu#define __MEM_PACKET_HH__ 5410447Snilay@cs.wisc.edu 5510447Snilay@cs.wisc.edu#include <bitset> 5610447Snilay@cs.wisc.edu#include <cassert> 5710447Snilay@cs.wisc.edu#include <list> 5810447Snilay@cs.wisc.edu 5910447Snilay@cs.wisc.edu#include "base/cast.hh" 6010447Snilay@cs.wisc.edu#include "base/compiler.hh" 6110447Snilay@cs.wisc.edu#include "base/flags.hh" 6210447Snilay@cs.wisc.edu#include "base/misc.hh" 6310447Snilay@cs.wisc.edu#include "base/printable.hh" 6410447Snilay@cs.wisc.edu#include "base/types.hh" 6510447Snilay@cs.wisc.edu#include "mem/request.hh" 6610447Snilay@cs.wisc.edu#include "sim/core.hh" 6710447Snilay@cs.wisc.edu 6810447Snilay@cs.wisc.educlass Packet; 6910447Snilay@cs.wisc.edutypedef Packet *PacketPtr; 7010447Snilay@cs.wisc.edutypedef uint8_t* PacketDataPtr; 7110447Snilay@cs.wisc.edutypedef std::list<PacketPtr> PacketList; 7210447Snilay@cs.wisc.edu 7310447Snilay@cs.wisc.educlass MemCmd 7410447Snilay@cs.wisc.edu{ 7510447Snilay@cs.wisc.edu friend class Packet; 7610447Snilay@cs.wisc.edu 7710447Snilay@cs.wisc.edu public: 7810447Snilay@cs.wisc.edu /** 7910447Snilay@cs.wisc.edu * List of all commands associated with a packet. 8010447Snilay@cs.wisc.edu */ 8110447Snilay@cs.wisc.edu enum Command 8210447Snilay@cs.wisc.edu { 8310447Snilay@cs.wisc.edu InvalidCmd, 8410447Snilay@cs.wisc.edu ReadReq, 8510447Snilay@cs.wisc.edu ReadResp, 8610447Snilay@cs.wisc.edu ReadRespWithInvalidate, 8710447Snilay@cs.wisc.edu WriteReq, 8810447Snilay@cs.wisc.edu WriteResp, 8910447Snilay@cs.wisc.edu Writeback, 9010447Snilay@cs.wisc.edu CleanEvict, 9110447Snilay@cs.wisc.edu SoftPFReq, 9210447Snilay@cs.wisc.edu HardPFReq, 9310447Snilay@cs.wisc.edu SoftPFResp, 9410447Snilay@cs.wisc.edu HardPFResp, 9510447Snilay@cs.wisc.edu WriteLineReq, 9610447Snilay@cs.wisc.edu UpgradeReq, 9710447Snilay@cs.wisc.edu SCUpgradeReq, // Special "weak" upgrade for StoreCond 9810447Snilay@cs.wisc.edu UpgradeResp, 9910447Snilay@cs.wisc.edu SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 10010447Snilay@cs.wisc.edu UpgradeFailResp, // Valid for SCUpgradeReq only 10110447Snilay@cs.wisc.edu ReadExReq, 10210447Snilay@cs.wisc.edu ReadExResp, 10310447Snilay@cs.wisc.edu ReadCleanReq, 10410447Snilay@cs.wisc.edu ReadSharedReq, 10510447Snilay@cs.wisc.edu LoadLockedReq, 10610447Snilay@cs.wisc.edu StoreCondReq, 10710447Snilay@cs.wisc.edu StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 10810447Snilay@cs.wisc.edu StoreCondResp, 10910447Snilay@cs.wisc.edu SwapReq, 11010447Snilay@cs.wisc.edu SwapResp, 11110447Snilay@cs.wisc.edu MessageReq, 11210447Snilay@cs.wisc.edu MessageResp, 11310447Snilay@cs.wisc.edu ReleaseReq, 11410447Snilay@cs.wisc.edu ReleaseResp, 11510447Snilay@cs.wisc.edu AcquireReq, 11610447Snilay@cs.wisc.edu AcquireResp, 11710447Snilay@cs.wisc.edu // Error responses 11810447Snilay@cs.wisc.edu // @TODO these should be classified as responses rather than 11910447Snilay@cs.wisc.edu // requests; coding them as requests initially for backwards 12010447Snilay@cs.wisc.edu // compatibility 12110447Snilay@cs.wisc.edu InvalidDestError, // packet dest field invalid 12210447Snilay@cs.wisc.edu BadAddressError, // memory address invalid 12310447Snilay@cs.wisc.edu FunctionalReadError, // unable to fulfill functional read 12410447Snilay@cs.wisc.edu FunctionalWriteError, // unable to fulfill functional write 12510447Snilay@cs.wisc.edu // Fake simulator-only commands 12610447Snilay@cs.wisc.edu PrintReq, // Print state matching address 12710447Snilay@cs.wisc.edu FlushReq, //request for a cache flush 12810447Snilay@cs.wisc.edu InvalidateReq, // request for address to be invalidated 12910447Snilay@cs.wisc.edu InvalidateResp, 13010447Snilay@cs.wisc.edu NUM_MEM_CMDS 13110447Snilay@cs.wisc.edu }; 13210447Snilay@cs.wisc.edu 13310447Snilay@cs.wisc.edu private: 13410447Snilay@cs.wisc.edu /** 13510447Snilay@cs.wisc.edu * List of command attributes. 13610447Snilay@cs.wisc.edu */ 13710447Snilay@cs.wisc.edu enum Attribute 13810447Snilay@cs.wisc.edu { 13910447Snilay@cs.wisc.edu IsRead, //!< Data flows from responder to requester 14010447Snilay@cs.wisc.edu IsWrite, //!< Data flows from requester to responder 14110447Snilay@cs.wisc.edu IsUpgrade, 14210447Snilay@cs.wisc.edu IsInvalidate, 14310447Snilay@cs.wisc.edu NeedsExclusive, //!< Requires exclusive copy to complete in-cache 14410447Snilay@cs.wisc.edu IsRequest, //!< Issued by requester 14510447Snilay@cs.wisc.edu IsResponse, //!< Issue by responder 14610447Snilay@cs.wisc.edu NeedsResponse, //!< Requester needs response from target 14710447Snilay@cs.wisc.edu IsSWPrefetch, 14810447Snilay@cs.wisc.edu IsHWPrefetch, 14910447Snilay@cs.wisc.edu IsLlsc, //!< Alpha/MIPS LL or SC access 15010447Snilay@cs.wisc.edu HasData, //!< There is an associated payload 15110447Snilay@cs.wisc.edu IsError, //!< Error response 15210447Snilay@cs.wisc.edu IsPrint, //!< Print state matching address (for debugging) 15310447Snilay@cs.wisc.edu IsFlush, //!< Flush the address from caches 15410447Snilay@cs.wisc.edu NUM_COMMAND_ATTRIBUTES 15510447Snilay@cs.wisc.edu }; 15610447Snilay@cs.wisc.edu 15710447Snilay@cs.wisc.edu /** 15810447Snilay@cs.wisc.edu * Structure that defines attributes and other data associated 15910447Snilay@cs.wisc.edu * with a Command. 16010447Snilay@cs.wisc.edu */ 16110447Snilay@cs.wisc.edu struct CommandInfo 16210447Snilay@cs.wisc.edu { 16310447Snilay@cs.wisc.edu /// Set of attribute flags. 16410447Snilay@cs.wisc.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 16510447Snilay@cs.wisc.edu /// Corresponding response for requests; InvalidCmd if no 16610447Snilay@cs.wisc.edu /// response is applicable. 16710447Snilay@cs.wisc.edu const Command response; 16810447Snilay@cs.wisc.edu /// String representation (for printing) 16910447Snilay@cs.wisc.edu const std::string str; 17010447Snilay@cs.wisc.edu }; 17110447Snilay@cs.wisc.edu 17210447Snilay@cs.wisc.edu /// Array to map Command enum to associated info. 17310447Snilay@cs.wisc.edu static const CommandInfo commandInfo[]; 17410447Snilay@cs.wisc.edu 17510447Snilay@cs.wisc.edu private: 17610447Snilay@cs.wisc.edu 17710447Snilay@cs.wisc.edu Command cmd; 17810447Snilay@cs.wisc.edu 17910447Snilay@cs.wisc.edu bool 18010447Snilay@cs.wisc.edu testCmdAttrib(MemCmd::Attribute attrib) const 18110447Snilay@cs.wisc.edu { 18210447Snilay@cs.wisc.edu return commandInfo[cmd].attributes[attrib] != 0; 18310447Snilay@cs.wisc.edu } 18410447Snilay@cs.wisc.edu 18510447Snilay@cs.wisc.edu public: 18610447Snilay@cs.wisc.edu 18710447Snilay@cs.wisc.edu bool isRead() const { return testCmdAttrib(IsRead); } 18810447Snilay@cs.wisc.edu bool isWrite() const { return testCmdAttrib(IsWrite); } 18910447Snilay@cs.wisc.edu bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 19010447Snilay@cs.wisc.edu bool isRequest() const { return testCmdAttrib(IsRequest); } 19110447Snilay@cs.wisc.edu bool isResponse() const { return testCmdAttrib(IsResponse); } 19210447Snilay@cs.wisc.edu bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 19310447Snilay@cs.wisc.edu bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 19410447Snilay@cs.wisc.edu bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 19510447Snilay@cs.wisc.edu 19610447Snilay@cs.wisc.edu /** 19710447Snilay@cs.wisc.edu * Check if this particular packet type carries payload data. Note 19810447Snilay@cs.wisc.edu * that this does not reflect if the data pointer of the packet is 19910447Snilay@cs.wisc.edu * valid or not. 20010447Snilay@cs.wisc.edu */ 20110447Snilay@cs.wisc.edu bool hasData() const { return testCmdAttrib(HasData); } 20210447Snilay@cs.wisc.edu bool isLLSC() const { return testCmdAttrib(IsLlsc); } 20310447Snilay@cs.wisc.edu bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 20410447Snilay@cs.wisc.edu bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 20510447Snilay@cs.wisc.edu bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 20610447Snilay@cs.wisc.edu testCmdAttrib(IsHWPrefetch); } 20710447Snilay@cs.wisc.edu bool isError() const { return testCmdAttrib(IsError); } 20810447Snilay@cs.wisc.edu bool isPrint() const { return testCmdAttrib(IsPrint); } 20910447Snilay@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 21010447Snilay@cs.wisc.edu 21110447Snilay@cs.wisc.edu const Command 21210447Snilay@cs.wisc.edu responseCommand() const 21310447Snilay@cs.wisc.edu { 21410447Snilay@cs.wisc.edu return commandInfo[cmd].response; 21510447Snilay@cs.wisc.edu } 21610447Snilay@cs.wisc.edu 21710447Snilay@cs.wisc.edu /// Return the string to a cmd given by idx. 21810447Snilay@cs.wisc.edu const std::string &toString() const { return commandInfo[cmd].str; } 21910447Snilay@cs.wisc.edu int toInt() const { return (int)cmd; } 22010447Snilay@cs.wisc.edu 22110447Snilay@cs.wisc.edu MemCmd(Command _cmd) : cmd(_cmd) { } 22210447Snilay@cs.wisc.edu MemCmd(int _cmd) : cmd((Command)_cmd) { } 22310447Snilay@cs.wisc.edu MemCmd() : cmd(InvalidCmd) { } 22410447Snilay@cs.wisc.edu 22510447Snilay@cs.wisc.edu bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 22610447Snilay@cs.wisc.edu bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 22710447Snilay@cs.wisc.edu}; 22810447Snilay@cs.wisc.edu 22910447Snilay@cs.wisc.edu/** 23010447Snilay@cs.wisc.edu * A Packet is used to encapsulate a transfer between two objects in 23110447Snilay@cs.wisc.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 23210447Snilay@cs.wisc.edu * single Request travels all the way from the requester to the 23310447Snilay@cs.wisc.edu * ultimate destination and back, possibly being conveyed by several 23410447Snilay@cs.wisc.edu * different Packets along the way.) 23510447Snilay@cs.wisc.edu */ 23610447Snilay@cs.wisc.educlass Packet : public Printable 23710447Snilay@cs.wisc.edu{ 23810447Snilay@cs.wisc.edu public: 23910447Snilay@cs.wisc.edu typedef uint32_t FlagsType; 24010447Snilay@cs.wisc.edu typedef ::Flags<FlagsType> Flags; 24110447Snilay@cs.wisc.edu 24210447Snilay@cs.wisc.edu private: 24310447Snilay@cs.wisc.edu 24410447Snilay@cs.wisc.edu enum : FlagsType { 24510447Snilay@cs.wisc.edu // Flags to transfer across when copying a packet 24610447Snilay@cs.wisc.edu COPY_FLAGS = 0x0000000F, 24710447Snilay@cs.wisc.edu 24810447Snilay@cs.wisc.edu SHARED = 0x00000001, 24910447Snilay@cs.wisc.edu // Special control flags 25010447Snilay@cs.wisc.edu /// Special timing-mode atomic snoop for multi-level coherence. 25110447Snilay@cs.wisc.edu EXPRESS_SNOOP = 0x00000002, 25210447Snilay@cs.wisc.edu /// Does supplier have exclusive copy? 25310447Snilay@cs.wisc.edu /// Useful for multi-level coherence. 25410447Snilay@cs.wisc.edu SUPPLY_EXCLUSIVE = 0x00000004, 25510447Snilay@cs.wisc.edu // Snoop response flags 25610447Snilay@cs.wisc.edu MEM_INHIBIT = 0x00000008, 25710447Snilay@cs.wisc.edu 25810447Snilay@cs.wisc.edu /// Are the 'addr' and 'size' fields valid? 25910447Snilay@cs.wisc.edu VALID_ADDR = 0x00000100, 26010447Snilay@cs.wisc.edu VALID_SIZE = 0x00000200, 26110447Snilay@cs.wisc.edu 26210447Snilay@cs.wisc.edu /// Is the data pointer set to a value that shouldn't be freed 26310447Snilay@cs.wisc.edu /// when the packet is destroyed? 26410447Snilay@cs.wisc.edu STATIC_DATA = 0x00001000, 26510447Snilay@cs.wisc.edu /// The data pointer points to a value that should be freed when 26610447Snilay@cs.wisc.edu /// the packet is destroyed. The pointer is assumed to be pointing 26710447Snilay@cs.wisc.edu /// to an array, and delete [] is consequently called 26810447Snilay@cs.wisc.edu DYNAMIC_DATA = 0x00002000, 26910447Snilay@cs.wisc.edu 27010447Snilay@cs.wisc.edu /// suppress the error if this packet encounters a functional 27110447Snilay@cs.wisc.edu /// access failure. 27210447Snilay@cs.wisc.edu SUPPRESS_FUNC_ERROR = 0x00008000, 27310447Snilay@cs.wisc.edu 27410447Snilay@cs.wisc.edu // Signal block present to squash prefetch and cache evict packets 27510447Snilay@cs.wisc.edu // through express snoop flag 27610447Snilay@cs.wisc.edu BLOCK_CACHED = 0x00010000 27710447Snilay@cs.wisc.edu }; 27810447Snilay@cs.wisc.edu 27910447Snilay@cs.wisc.edu Flags flags; 28010447Snilay@cs.wisc.edu 28110447Snilay@cs.wisc.edu public: 28210447Snilay@cs.wisc.edu typedef MemCmd::Command Command; 28310447Snilay@cs.wisc.edu 28410447Snilay@cs.wisc.edu /// The command field of the packet. 28510447Snilay@cs.wisc.edu MemCmd cmd; 28610447Snilay@cs.wisc.edu 28710447Snilay@cs.wisc.edu /// A pointer to the original request. 28810447Snilay@cs.wisc.edu const RequestPtr req; 28910447Snilay@cs.wisc.edu 29010447Snilay@cs.wisc.edu private: 29110447Snilay@cs.wisc.edu /** 29210447Snilay@cs.wisc.edu * A pointer to the data being transfered. It can be differnt 29310447Snilay@cs.wisc.edu * sizes at each level of the heirarchy so it belongs in the 29410447Snilay@cs.wisc.edu * packet, not request. This may or may not be populated when a 29510447Snilay@cs.wisc.edu * responder recieves the packet. If not populated it memory should 29610447Snilay@cs.wisc.edu * be allocated. 29710447Snilay@cs.wisc.edu */ 29810447Snilay@cs.wisc.edu PacketDataPtr data; 29910447Snilay@cs.wisc.edu 30010447Snilay@cs.wisc.edu /// The address of the request. This address could be virtual or 30110447Snilay@cs.wisc.edu /// physical, depending on the system configuration. 30210447Snilay@cs.wisc.edu Addr addr; 30310447Snilay@cs.wisc.edu 30410447Snilay@cs.wisc.edu /// True if the request targets the secure memory space. 30510447Snilay@cs.wisc.edu bool _isSecure; 30610447Snilay@cs.wisc.edu 30710447Snilay@cs.wisc.edu /// The size of the request or transfer. 30810447Snilay@cs.wisc.edu unsigned size; 30910447Snilay@cs.wisc.edu 31010447Snilay@cs.wisc.edu /** 31110447Snilay@cs.wisc.edu * Track the bytes found that satisfy a functional read. 31210447Snilay@cs.wisc.edu */ 31310447Snilay@cs.wisc.edu std::vector<bool> bytesValid; 31410447Snilay@cs.wisc.edu 31510447Snilay@cs.wisc.edu public: 31610447Snilay@cs.wisc.edu 31710447Snilay@cs.wisc.edu /** 31810447Snilay@cs.wisc.edu * The extra delay from seeing the packet until the header is 31910447Snilay@cs.wisc.edu * transmitted. This delay is used to communicate the crossbar 32010447Snilay@cs.wisc.edu * forwarding latency to the neighbouring object (e.g. a cache) 32110447Snilay@cs.wisc.edu * that actually makes the packet wait. As the delay is relative, 32210447Snilay@cs.wisc.edu * a 32-bit unsigned should be sufficient. 32310447Snilay@cs.wisc.edu */ 32410447Snilay@cs.wisc.edu uint32_t headerDelay; 32510447Snilay@cs.wisc.edu 32610447Snilay@cs.wisc.edu /** 32710447Snilay@cs.wisc.edu * The extra pipelining delay from seeing the packet until the end of 32810447Snilay@cs.wisc.edu * payload is transmitted by the component that provided it (if 32910447Snilay@cs.wisc.edu * any). This includes the header delay. Similar to the header 33010447Snilay@cs.wisc.edu * delay, this is used to make up for the fact that the 33110447Snilay@cs.wisc.edu * crossbar does not make the packet wait. As the delay is 33210447Snilay@cs.wisc.edu * relative, a 32-bit unsigned should be sufficient. 33310447Snilay@cs.wisc.edu */ 33410447Snilay@cs.wisc.edu uint32_t payloadDelay; 33510447Snilay@cs.wisc.edu 33610447Snilay@cs.wisc.edu /** 33710447Snilay@cs.wisc.edu * A virtual base opaque structure used to hold state associated 33810447Snilay@cs.wisc.edu * with the packet (e.g., an MSHR), specific to a MemObject that 33910447Snilay@cs.wisc.edu * sees the packet. A pointer to this state is returned in the 34010447Snilay@cs.wisc.edu * packet's response so that the MemObject in question can quickly 34110447Snilay@cs.wisc.edu * look up the state needed to process it. A specific subclass 34210447Snilay@cs.wisc.edu * would be derived from this to carry state specific to a 34310447Snilay@cs.wisc.edu * particular sending device. 34410447Snilay@cs.wisc.edu * 34510447Snilay@cs.wisc.edu * As multiple MemObjects may add their SenderState throughout the 34610447Snilay@cs.wisc.edu * memory system, the SenderStates create a stack, where a 34710447Snilay@cs.wisc.edu * MemObject can add a new Senderstate, as long as the 34810447Snilay@cs.wisc.edu * predecessing SenderState is restored when the response comes 34910447Snilay@cs.wisc.edu * back. For this reason, the predecessor should always be 35010447Snilay@cs.wisc.edu * populated with the current SenderState of a packet before 35110447Snilay@cs.wisc.edu * modifying the senderState field in the request packet. 35210447Snilay@cs.wisc.edu */ 35310447Snilay@cs.wisc.edu struct SenderState 35410447Snilay@cs.wisc.edu { 35510447Snilay@cs.wisc.edu SenderState* predecessor; 35610447Snilay@cs.wisc.edu SenderState() : predecessor(NULL) {} 35710447Snilay@cs.wisc.edu virtual ~SenderState() {} 35810447Snilay@cs.wisc.edu }; 35910447Snilay@cs.wisc.edu 36010447Snilay@cs.wisc.edu /** 36110447Snilay@cs.wisc.edu * Object used to maintain state of a PrintReq. The senderState 36210447Snilay@cs.wisc.edu * field of a PrintReq should always be of this type. 36310447Snilay@cs.wisc.edu */ 36410447Snilay@cs.wisc.edu class PrintReqState : public SenderState 36510447Snilay@cs.wisc.edu { 36610447Snilay@cs.wisc.edu private: 36710447Snilay@cs.wisc.edu /** 36810447Snilay@cs.wisc.edu * An entry in the label stack. 36910447Snilay@cs.wisc.edu */ 37010447Snilay@cs.wisc.edu struct LabelStackEntry 37110447Snilay@cs.wisc.edu { 37210447Snilay@cs.wisc.edu const std::string label; 37310447Snilay@cs.wisc.edu std::string *prefix; 37410447Snilay@cs.wisc.edu bool labelPrinted; 37510447Snilay@cs.wisc.edu LabelStackEntry(const std::string &_label, std::string *_prefix); 37610447Snilay@cs.wisc.edu }; 37710447Snilay@cs.wisc.edu 37810447Snilay@cs.wisc.edu typedef std::list<LabelStackEntry> LabelStack; 379 LabelStack labelStack; 380 381 std::string *curPrefixPtr; 382 383 public: 384 std::ostream &os; 385 const int verbosity; 386 387 PrintReqState(std::ostream &os, int verbosity = 0); 388 ~PrintReqState(); 389 390 /** 391 * Returns the current line prefix. 392 */ 393 const std::string &curPrefix() { return *curPrefixPtr; } 394 395 /** 396 * Push a label onto the label stack, and prepend the given 397 * prefix string onto the current prefix. Labels will only be 398 * printed if an object within the label's scope is printed. 399 */ 400 void pushLabel(const std::string &lbl, 401 const std::string &prefix = " "); 402 403 /** 404 * Pop a label off the label stack. 405 */ 406 void popLabel(); 407 408 /** 409 * Print all of the pending unprinted labels on the 410 * stack. Called by printObj(), so normally not called by 411 * users unless bypassing printObj(). 412 */ 413 void printLabels(); 414 415 /** 416 * Print a Printable object to os, because it matched the 417 * address on a PrintReq. 418 */ 419 void printObj(Printable *obj); 420 }; 421 422 /** 423 * This packet's sender state. Devices should use dynamic_cast<> 424 * to cast to the state appropriate to the sender. The intent of 425 * this variable is to allow a device to attach extra information 426 * to a request. A response packet must return the sender state 427 * that was attached to the original request (even if a new packet 428 * is created). 429 */ 430 SenderState *senderState; 431 432 /** 433 * Push a new sender state to the packet and make the current 434 * sender state the predecessor of the new one. This should be 435 * prefered over direct manipulation of the senderState member 436 * variable. 437 * 438 * @param sender_state SenderState to push at the top of the stack 439 */ 440 void pushSenderState(SenderState *sender_state); 441 442 /** 443 * Pop the top of the state stack and return a pointer to it. This 444 * assumes the current sender state is not NULL. This should be 445 * preferred over direct manipulation of the senderState member 446 * variable. 447 * 448 * @return The current top of the stack 449 */ 450 SenderState *popSenderState(); 451 452 /** 453 * Go through the sender state stack and return the first instance 454 * that is of type T (as determined by a dynamic_cast). If there 455 * is no sender state of type T, NULL is returned. 456 * 457 * @return The topmost state of type T 458 */ 459 template <typename T> 460 T * findNextSenderState() const 461 { 462 T *t = NULL; 463 SenderState* sender_state = senderState; 464 while (t == NULL && sender_state != NULL) { 465 t = dynamic_cast<T*>(sender_state); 466 sender_state = sender_state->predecessor; 467 } 468 return t; 469 } 470 471 /// Return the string name of the cmd field (for debugging and 472 /// tracing). 473 const std::string &cmdString() const { return cmd.toString(); } 474 475 /// Return the index of this command. 476 inline int cmdToIndex() const { return cmd.toInt(); } 477 478 bool isRead() const { return cmd.isRead(); } 479 bool isWrite() const { return cmd.isWrite(); } 480 bool isUpgrade() const { return cmd.isUpgrade(); } 481 bool isRequest() const { return cmd.isRequest(); } 482 bool isResponse() const { return cmd.isResponse(); } 483 bool needsExclusive() const { return cmd.needsExclusive(); } 484 bool needsResponse() const { return cmd.needsResponse(); } 485 bool isInvalidate() const { return cmd.isInvalidate(); } 486 bool hasData() const { return cmd.hasData(); } 487 bool isLLSC() const { return cmd.isLLSC(); } 488 bool isError() const { return cmd.isError(); } 489 bool isPrint() const { return cmd.isPrint(); } 490 bool isFlush() const { return cmd.isFlush(); } 491 492 // Snoop flags 493 void assertMemInhibit() 494 { 495 assert(isRequest()); 496 assert(!flags.isSet(MEM_INHIBIT)); 497 flags.set(MEM_INHIBIT); 498 } 499 bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 500 void assertShared() { flags.set(SHARED); } 501 bool sharedAsserted() const { return flags.isSet(SHARED); } 502 503 // Special control flags 504 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 505 bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 506 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 507 bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 508 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 509 bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 510 void setBlockCached() { flags.set(BLOCK_CACHED); } 511 bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 512 void clearBlockCached() { flags.clear(BLOCK_CACHED); } 513 514 // Network error conditions... encapsulate them as methods since 515 // their encoding keeps changing (from result field to command 516 // field, etc.) 517 void 518 setBadAddress() 519 { 520 assert(isResponse()); 521 cmd = MemCmd::BadAddressError; 522 } 523 524 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 525 526 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 527 /** 528 * Update the address of this packet mid-transaction. This is used 529 * by the address mapper to change an already set address to a new 530 * one based on the system configuration. It is intended to remap 531 * an existing address, so it asserts that the current address is 532 * valid. 533 */ 534 void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 535 536 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 537 538 Addr getOffset(unsigned int blk_size) const 539 { 540 return getAddr() & Addr(blk_size - 1); 541 } 542 543 Addr getBlockAddr(unsigned int blk_size) const 544 { 545 return getAddr() & ~(Addr(blk_size - 1)); 546 } 547 548 bool isSecure() const 549 { 550 assert(flags.isSet(VALID_ADDR)); 551 return _isSecure; 552 } 553 554 /** 555 * It has been determined that the SC packet should successfully update 556 * memory. Therefore, convert this SC packet to a normal write. 557 */ 558 void 559 convertScToWrite() 560 { 561 assert(isLLSC()); 562 assert(isWrite()); 563 cmd = MemCmd::WriteReq; 564 } 565 566 /** 567 * When ruby is in use, Ruby will monitor the cache line and the 568 * phys memory should treat LL ops as normal reads. 569 */ 570 void 571 convertLlToRead() 572 { 573 assert(isLLSC()); 574 assert(isRead()); 575 cmd = MemCmd::ReadReq; 576 } 577 578 /** 579 * Constructor. Note that a Request object must be constructed 580 * first, but the Requests's physical address and size fields need 581 * not be valid. The command must be supplied. 582 */ 583 Packet(const RequestPtr _req, MemCmd _cmd) 584 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 585 size(0), headerDelay(0), payloadDelay(0), 586 senderState(NULL) 587 { 588 if (req->hasPaddr()) { 589 addr = req->getPaddr(); 590 flags.set(VALID_ADDR); 591 _isSecure = req->isSecure(); 592 } 593 if (req->hasSize()) { 594 size = req->getSize(); 595 flags.set(VALID_SIZE); 596 } 597 } 598 599 /** 600 * Alternate constructor if you are trying to create a packet with 601 * a request that is for a whole block, not the address from the 602 * req. this allows for overriding the size/addr of the req. 603 */ 604 Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 605 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 606 headerDelay(0), payloadDelay(0), 607 senderState(NULL) 608 { 609 if (req->hasPaddr()) { 610 addr = req->getPaddr() & ~(_blkSize - 1); 611 flags.set(VALID_ADDR); 612 _isSecure = req->isSecure(); 613 } 614 size = _blkSize; 615 flags.set(VALID_SIZE); 616 } 617 618 /** 619 * Alternate constructor for copying a packet. Copy all fields 620 * *except* if the original packet's data was dynamic, don't copy 621 * that, as we can't guarantee that the new packet's lifetime is 622 * less than that of the original packet. In this case the new 623 * packet should allocate its own data. 624 */ 625 Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 626 : cmd(pkt->cmd), req(pkt->req), 627 data(nullptr), 628 addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 629 bytesValid(pkt->bytesValid), 630 headerDelay(pkt->headerDelay), 631 payloadDelay(pkt->payloadDelay), 632 senderState(pkt->senderState) 633 { 634 if (!clear_flags) 635 flags.set(pkt->flags & COPY_FLAGS); 636 637 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 638 639 // should we allocate space for data, or not, the express 640 // snoops do not need to carry any data as they only serve to 641 // co-ordinate state changes 642 if (alloc_data) { 643 // even if asked to allocate data, if the original packet 644 // holds static data, then the sender will not be doing 645 // any memcpy on receiving the response, thus we simply 646 // carry the pointer forward 647 if (pkt->flags.isSet(STATIC_DATA)) { 648 data = pkt->data; 649 flags.set(STATIC_DATA); 650 } else { 651 allocate(); 652 } 653 } 654 } 655 656 /** 657 * Generate the appropriate read MemCmd based on the Request flags. 658 */ 659 static MemCmd 660 makeReadCmd(const RequestPtr req) 661 { 662 if (req->isLLSC()) 663 return MemCmd::LoadLockedReq; 664 else if (req->isPrefetch()) 665 return MemCmd::SoftPFReq; 666 else 667 return MemCmd::ReadReq; 668 } 669 670 /** 671 * Generate the appropriate write MemCmd based on the Request flags. 672 */ 673 static MemCmd 674 makeWriteCmd(const RequestPtr req) 675 { 676 if (req->isLLSC()) 677 return MemCmd::StoreCondReq; 678 else if (req->isSwap()) 679 return MemCmd::SwapReq; 680 else 681 return MemCmd::WriteReq; 682 } 683 684 /** 685 * Constructor-like methods that return Packets based on Request objects. 686 * Fine-tune the MemCmd type if it's not a vanilla read or write. 687 */ 688 static PacketPtr 689 createRead(const RequestPtr req) 690 { 691 return new Packet(req, makeReadCmd(req)); 692 } 693 694 static PacketPtr 695 createWrite(const RequestPtr req) 696 { 697 return new Packet(req, makeWriteCmd(req)); 698 } 699 700 /** 701 * clean up packet variables 702 */ 703 ~Packet() 704 { 705 // Delete the request object if this is a request packet which 706 // does not need a response, because the requester will not get 707 // a chance. If the request packet needs a response then the 708 // request will be deleted on receipt of the response 709 // packet. We also make sure to never delete the request for 710 // express snoops, even for cases when responses are not 711 // needed (CleanEvict and Writeback), since the snoop packet 712 // re-uses the same request. 713 if (req && isRequest() && !needsResponse() && 714 !isExpressSnoop()) { 715 delete req; 716 } 717 deleteData(); 718 } 719 720 /** 721 * Take a request packet and modify it in place to be suitable for 722 * returning as a response to that request. 723 */ 724 void 725 makeResponse() 726 { 727 assert(needsResponse()); 728 assert(isRequest()); 729 cmd = cmd.responseCommand(); 730 731 // responses are never express, even if the snoop that 732 // triggered them was 733 flags.clear(EXPRESS_SNOOP); 734 } 735 736 void 737 makeAtomicResponse() 738 { 739 makeResponse(); 740 } 741 742 void 743 makeTimingResponse() 744 { 745 makeResponse(); 746 } 747 748 void 749 setFunctionalResponseStatus(bool success) 750 { 751 if (!success) { 752 if (isWrite()) { 753 cmd = MemCmd::FunctionalWriteError; 754 } else { 755 cmd = MemCmd::FunctionalReadError; 756 } 757 } 758 } 759 760 void 761 setSize(unsigned size) 762 { 763 assert(!flags.isSet(VALID_SIZE)); 764 765 this->size = size; 766 flags.set(VALID_SIZE); 767 } 768 769 770 public: 771 /** 772 * @{ 773 * @name Data accessor mehtods 774 */ 775 776 /** 777 * Set the data pointer to the following value that should not be 778 * freed. Static data allows us to do a single memcpy even if 779 * multiple packets are required to get from source to destination 780 * and back. In essence the pointer is set calling dataStatic on 781 * the original packet, and whenever this packet is copied and 782 * forwarded the same pointer is passed on. When a packet 783 * eventually reaches the destination holding the data, it is 784 * copied once into the location originally set. On the way back 785 * to the source, no copies are necessary. 786 */ 787 template <typename T> 788 void 789 dataStatic(T *p) 790 { 791 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 792 data = (PacketDataPtr)p; 793 flags.set(STATIC_DATA); 794 } 795 796 /** 797 * Set the data pointer to the following value that should not be 798 * freed. This version of the function allows the pointer passed 799 * to us to be const. To avoid issues down the line we cast the 800 * constness away, the alternative would be to keep both a const 801 * and non-const data pointer and cleverly choose between 802 * them. Note that this is only allowed for static data. 803 */ 804 template <typename T> 805 void 806 dataStaticConst(const T *p) 807 { 808 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 809 data = const_cast<PacketDataPtr>(p); 810 flags.set(STATIC_DATA); 811 } 812 813 /** 814 * Set the data pointer to a value that should have delete [] 815 * called on it. Dynamic data is local to this packet, and as the 816 * packet travels from source to destination, forwarded packets 817 * will allocate their own data. When a packet reaches the final 818 * destination it will populate the dynamic data of that specific 819 * packet, and on the way back towards the source, memcpy will be 820 * invoked in every step where a new packet was created e.g. in 821 * the caches. Ultimately when the response reaches the source a 822 * final memcpy is needed to extract the data from the packet 823 * before it is deallocated. 824 */ 825 template <typename T> 826 void 827 dataDynamic(T *p) 828 { 829 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 830 data = (PacketDataPtr)p; 831 flags.set(DYNAMIC_DATA); 832 } 833 834 /** 835 * get a pointer to the data ptr. 836 */ 837 template <typename T> 838 T* 839 getPtr() 840 { 841 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 842 return (T*)data; 843 } 844 845 template <typename T> 846 const T* 847 getConstPtr() const 848 { 849 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 850 return (const T*)data; 851 } 852 853 /** 854 * Get the data in the packet byte swapped from big endian to 855 * host endian. 856 */ 857 template <typename T> 858 T getBE() const; 859 860 /** 861 * Get the data in the packet byte swapped from little endian to 862 * host endian. 863 */ 864 template <typename T> 865 T getLE() const; 866 867 /** 868 * Get the data in the packet byte swapped from the specified 869 * endianness. 870 */ 871 template <typename T> 872 T get(ByteOrder endian) const; 873 874 /** 875 * Get the data in the packet byte swapped from guest to host 876 * endian. 877 */ 878 template <typename T> 879 T get() const; 880 881 /** Set the value in the data pointer to v as big endian. */ 882 template <typename T> 883 void setBE(T v); 884 885 /** Set the value in the data pointer to v as little endian. */ 886 template <typename T> 887 void setLE(T v); 888 889 /** 890 * Set the value in the data pointer to v using the specified 891 * endianness. 892 */ 893 template <typename T> 894 void set(T v, ByteOrder endian); 895 896 /** Set the value in the data pointer to v as guest endian. */ 897 template <typename T> 898 void set(T v); 899 900 /** 901 * Copy data into the packet from the provided pointer. 902 */ 903 void 904 setData(const uint8_t *p) 905 { 906 // we should never be copying data onto itself, which means we 907 // must idenfity packets with static data, as they carry the 908 // same pointer from source to destination and back 909 assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 910 911 if (p != getPtr<uint8_t>()) 912 // for packet with allocated dynamic data, we copy data from 913 // one to the other, e.g. a forwarded response to a response 914 std::memcpy(getPtr<uint8_t>(), p, getSize()); 915 } 916 917 /** 918 * Copy data into the packet from the provided block pointer, 919 * which is aligned to the given block size. 920 */ 921 void 922 setDataFromBlock(const uint8_t *blk_data, int blkSize) 923 { 924 setData(blk_data + getOffset(blkSize)); 925 } 926 927 /** 928 * Copy data from the packet to the provided block pointer, which 929 * is aligned to the given block size. 930 */ 931 void 932 writeData(uint8_t *p) const 933 { 934 std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 935 } 936 937 /** 938 * Copy data from the packet to the memory at the provided pointer. 939 */ 940 void 941 writeDataToBlock(uint8_t *blk_data, int blkSize) const 942 { 943 writeData(blk_data + getOffset(blkSize)); 944 } 945 946 /** 947 * delete the data pointed to in the data pointer. Ok to call to 948 * matter how data was allocted. 949 */ 950 void 951 deleteData() 952 { 953 if (flags.isSet(DYNAMIC_DATA)) 954 delete [] data; 955 956 flags.clear(STATIC_DATA|DYNAMIC_DATA); 957 data = NULL; 958 } 959 960 /** Allocate memory for the packet. */ 961 void 962 allocate() 963 { 964 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 965 flags.set(DYNAMIC_DATA); 966 data = new uint8_t[getSize()]; 967 } 968 969 /** @} */ 970 971 private: // Private data accessor methods 972 /** Get the data in the packet without byte swapping. */ 973 template <typename T> 974 T getRaw() const; 975 976 /** Set the value in the data pointer to v without byte swapping. */ 977 template <typename T> 978 void setRaw(T v); 979 980 public: 981 /** 982 * Check a functional request against a memory value stored in 983 * another packet (i.e. an in-transit request or 984 * response). Returns true if the current packet is a read, and 985 * the other packet provides the data, which is then copied to the 986 * current packet. If the current packet is a write, and the other 987 * packet intersects this one, then we update the data 988 * accordingly. 989 */ 990 bool 991 checkFunctional(PacketPtr other) 992 { 993 // all packets that are carrying a payload should have a valid 994 // data pointer 995 return checkFunctional(other, other->getAddr(), other->isSecure(), 996 other->getSize(), 997 other->hasData() ? 998 other->getPtr<uint8_t>() : NULL); 999 } 1000 1001 /** 1002 * Is this request notification of a clean or dirty eviction from the cache. 1003 **/ 1004 bool 1005 evictingBlock() const 1006 { 1007 return (cmd == MemCmd::Writeback || 1008 cmd == MemCmd::CleanEvict); 1009 } 1010 1011 /** 1012 * Does the request need to check for cached copies of the same block 1013 * in the memory hierarchy above. 1014 **/ 1015 bool 1016 mustCheckAbove() const 1017 { 1018 return (cmd == MemCmd::HardPFReq || 1019 evictingBlock()); 1020 } 1021 1022 /** 1023 * Check a functional request against a memory value represented 1024 * by a base/size pair and an associated data array. If the 1025 * current packet is a read, it may be satisfied by the memory 1026 * value. If the current packet is a write, it may update the 1027 * memory value. 1028 */ 1029 bool 1030 checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 1031 uint8_t *_data); 1032 1033 /** 1034 * Push label for PrintReq (safe to call unconditionally). 1035 */ 1036 void 1037 pushLabel(const std::string &lbl) 1038 { 1039 if (isPrint()) 1040 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 1041 } 1042 1043 /** 1044 * Pop label for PrintReq (safe to call unconditionally). 1045 */ 1046 void 1047 popLabel() 1048 { 1049 if (isPrint()) 1050 safe_cast<PrintReqState*>(senderState)->popLabel(); 1051 } 1052 1053 void print(std::ostream &o, int verbosity = 0, 1054 const std::string &prefix = "") const; 1055 1056 /** 1057 * A no-args wrapper of print(std::ostream...) 1058 * meant to be invoked from DPRINTFs 1059 * avoiding string overheads in fast mode 1060 * @return string with the request's type and start<->end addresses 1061 */ 1062 std::string print() const; 1063}; 1064 1065#endif //__MEM_PACKET_HH 1066