packet.hh revision 4628
12381SN/A/* 22592SN/A * Copyright (c) 2006 The Regents of The University of Michigan 32381SN/A * All rights reserved. 42381SN/A * 52381SN/A * Redistribution and use in source and binary forms, with or without 62381SN/A * modification, are permitted provided that the following conditions are 72381SN/A * met: redistributions of source code must retain the above copyright 82381SN/A * notice, this list of conditions and the following disclaimer; 92381SN/A * redistributions in binary form must reproduce the above copyright 102381SN/A * notice, this list of conditions and the following disclaimer in the 112381SN/A * documentation and/or other materials provided with the distribution; 122381SN/A * neither the name of the copyright holders nor the names of its 132381SN/A * contributors may be used to endorse or promote products derived from 142381SN/A * this software without specific prior written permission. 152381SN/A * 162381SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172381SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182381SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192381SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202381SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212381SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222381SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232381SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242381SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252381SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262381SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665Ssaidi@eecs.umich.edu * 282665Ssaidi@eecs.umich.edu * Authors: Ron Dreslinski 292665Ssaidi@eecs.umich.edu * Steve Reinhardt 302665Ssaidi@eecs.umich.edu * Ali Saidi 312381SN/A */ 322381SN/A 332381SN/A/** 342381SN/A * @file 352662Sstever@eecs.umich.edu * Declaration of the Packet class. 362381SN/A */ 372381SN/A 382381SN/A#ifndef __MEM_PACKET_HH__ 392381SN/A#define __MEM_PACKET_HH__ 402381SN/A 413348Sbinkertn@umich.edu#include <cassert> 423348Sbinkertn@umich.edu#include <list> 434022Sstever@eecs.umich.edu#include <bitset> 443348Sbinkertn@umich.edu 454024Sbinkertn@umich.edu#include "base/compiler.hh" 463940Ssaidi@eecs.umich.edu#include "base/misc.hh" 472392SN/A#include "mem/request.hh" 482980Sgblack@eecs.umich.edu#include "sim/host.hh" 494167Sbinkertn@umich.edu#include "sim/core.hh" 502394SN/A 513940Ssaidi@eecs.umich.edu 522394SN/Astruct Packet; 533349Sbinkertn@umich.edutypedef Packet *PacketPtr; 542394SN/Atypedef uint8_t* PacketDataPtr; 552812Srdreslin@umich.edutypedef std::list<PacketPtr> PacketList; 562812Srdreslin@umich.edu 574022Sstever@eecs.umich.educlass MemCmd 584022Sstever@eecs.umich.edu{ 594022Sstever@eecs.umich.edu public: 604022Sstever@eecs.umich.edu 614022Sstever@eecs.umich.edu /** List of all commands associated with a packet. */ 624022Sstever@eecs.umich.edu enum Command 634022Sstever@eecs.umich.edu { 644022Sstever@eecs.umich.edu InvalidCmd, 654022Sstever@eecs.umich.edu ReadReq, 664473Sstever@eecs.umich.edu ReadResp, 674022Sstever@eecs.umich.edu WriteReq, 684022Sstever@eecs.umich.edu WriteResp, 694022Sstever@eecs.umich.edu Writeback, 704022Sstever@eecs.umich.edu SoftPFReq, 714022Sstever@eecs.umich.edu HardPFReq, 724022Sstever@eecs.umich.edu SoftPFResp, 734022Sstever@eecs.umich.edu HardPFResp, 744022Sstever@eecs.umich.edu WriteInvalidateReq, 754022Sstever@eecs.umich.edu WriteInvalidateResp, 764022Sstever@eecs.umich.edu UpgradeReq, 774628Sstever@eecs.umich.edu UpgradeResp, 784022Sstever@eecs.umich.edu ReadExReq, 794022Sstever@eecs.umich.edu ReadExResp, 804626Sstever@eecs.umich.edu LoadLockedReq, 814626Sstever@eecs.umich.edu LoadLockedResp, 824626Sstever@eecs.umich.edu StoreCondReq, 834626Sstever@eecs.umich.edu StoreCondResp, 844040Ssaidi@eecs.umich.edu SwapReq, 854040Ssaidi@eecs.umich.edu SwapResp, 864022Sstever@eecs.umich.edu NUM_MEM_CMDS 874022Sstever@eecs.umich.edu }; 884022Sstever@eecs.umich.edu 894022Sstever@eecs.umich.edu private: 904022Sstever@eecs.umich.edu /** List of command attributes. */ 914022Sstever@eecs.umich.edu enum Attribute 924022Sstever@eecs.umich.edu { 934626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 944626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 954626Sstever@eecs.umich.edu IsPrefetch, //!< Not a demand access 964022Sstever@eecs.umich.edu IsInvalidate, 974626Sstever@eecs.umich.edu NeedsExclusive, //!< Requires exclusive copy to complete in-cache 984626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 994626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1004626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 1014022Sstever@eecs.umich.edu IsSWPrefetch, 1024022Sstever@eecs.umich.edu IsHWPrefetch, 1034626Sstever@eecs.umich.edu IsLocked, //!< Alpha/MIPS LL or SC access 1044626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1054022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1064022Sstever@eecs.umich.edu }; 1074022Sstever@eecs.umich.edu 1084022Sstever@eecs.umich.edu /** Structure that defines attributes and other data associated 1094022Sstever@eecs.umich.edu * with a Command. */ 1104022Sstever@eecs.umich.edu struct CommandInfo { 1114022Sstever@eecs.umich.edu /** Set of attribute flags. */ 1124022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1134022Sstever@eecs.umich.edu /** Corresponding response for requests; InvalidCmd if no 1144022Sstever@eecs.umich.edu * response is applicable. */ 1154022Sstever@eecs.umich.edu const Command response; 1164022Sstever@eecs.umich.edu /** String representation (for printing) */ 1174022Sstever@eecs.umich.edu const std::string str; 1184022Sstever@eecs.umich.edu }; 1194022Sstever@eecs.umich.edu 1204022Sstever@eecs.umich.edu /** Array to map Command enum to associated info. */ 1214022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1224022Sstever@eecs.umich.edu 1234022Sstever@eecs.umich.edu private: 1244022Sstever@eecs.umich.edu 1254022Sstever@eecs.umich.edu Command cmd; 1264022Sstever@eecs.umich.edu 1274022Sstever@eecs.umich.edu bool testCmdAttrib(MemCmd::Attribute attrib) const { 1284022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1294022Sstever@eecs.umich.edu } 1304022Sstever@eecs.umich.edu 1314022Sstever@eecs.umich.edu public: 1324022Sstever@eecs.umich.edu 1334022Sstever@eecs.umich.edu bool isRead() const { return testCmdAttrib(IsRead); } 1344022Sstever@eecs.umich.edu bool isWrite() const { return testCmdAttrib(IsWrite); } 1354022Sstever@eecs.umich.edu bool isRequest() const { return testCmdAttrib(IsRequest); } 1364022Sstever@eecs.umich.edu bool isResponse() const { return testCmdAttrib(IsResponse); } 1374626Sstever@eecs.umich.edu bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 1384022Sstever@eecs.umich.edu bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 1394022Sstever@eecs.umich.edu bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 1404022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 1414626Sstever@eecs.umich.edu bool isReadWrite() const { return isRead() && isWrite(); } 1424626Sstever@eecs.umich.edu bool isLocked() const { return testCmdAttrib(IsLocked); } 1434022Sstever@eecs.umich.edu 1444022Sstever@eecs.umich.edu const Command responseCommand() const { 1454022Sstever@eecs.umich.edu return commandInfo[cmd].response; 1464022Sstever@eecs.umich.edu } 1474022Sstever@eecs.umich.edu 1484022Sstever@eecs.umich.edu /** Return the string to a cmd given by idx. */ 1494022Sstever@eecs.umich.edu const std::string &toString() const { 1504022Sstever@eecs.umich.edu return commandInfo[cmd].str; 1514022Sstever@eecs.umich.edu } 1524022Sstever@eecs.umich.edu 1534022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 1544022Sstever@eecs.umich.edu 1554022Sstever@eecs.umich.edu MemCmd(Command _cmd) 1564022Sstever@eecs.umich.edu : cmd(_cmd) 1574022Sstever@eecs.umich.edu { } 1584022Sstever@eecs.umich.edu 1594022Sstever@eecs.umich.edu MemCmd(int _cmd) 1604022Sstever@eecs.umich.edu : cmd((Command)_cmd) 1614022Sstever@eecs.umich.edu { } 1624022Sstever@eecs.umich.edu 1634022Sstever@eecs.umich.edu MemCmd() 1644022Sstever@eecs.umich.edu : cmd(InvalidCmd) 1654022Sstever@eecs.umich.edu { } 1664022Sstever@eecs.umich.edu 1674022Sstever@eecs.umich.edu bool operator==(MemCmd c2) { return (cmd == c2.cmd); } 1684022Sstever@eecs.umich.edu bool operator!=(MemCmd c2) { return (cmd != c2.cmd); } 1694022Sstever@eecs.umich.edu 1704022Sstever@eecs.umich.edu friend class Packet; 1714022Sstever@eecs.umich.edu}; 1724022Sstever@eecs.umich.edu 1732381SN/A/** 1742662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 1752662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 1762662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 1772662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 1782662Sstever@eecs.umich.edu * different Packets along the way.) 1792381SN/A */ 1802641Sstever@eecs.umich.educlass Packet 1812381SN/A{ 1822813Srdreslin@umich.edu public: 1834022Sstever@eecs.umich.edu 1844022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 1854022Sstever@eecs.umich.edu 1862566SN/A private: 1872662Sstever@eecs.umich.edu /** A pointer to the data being transfered. It can be differnt 1882662Sstever@eecs.umich.edu * sizes at each level of the heirarchy so it belongs in the 1892662Sstever@eecs.umich.edu * packet, not request. This may or may not be populated when a 1902662Sstever@eecs.umich.edu * responder recieves the packet. If not populated it memory 1912662Sstever@eecs.umich.edu * should be allocated. 1922566SN/A */ 1932566SN/A PacketDataPtr data; 1942566SN/A 1952662Sstever@eecs.umich.edu /** Is the data pointer set to a value that shouldn't be freed 1962662Sstever@eecs.umich.edu * when the packet is destroyed? */ 1972566SN/A bool staticData; 1982662Sstever@eecs.umich.edu /** The data pointer points to a value that should be freed when 1992662Sstever@eecs.umich.edu * the packet is destroyed. */ 2002566SN/A bool dynamicData; 2012662Sstever@eecs.umich.edu /** the data pointer points to an array (thus delete [] ) needs to 2022662Sstever@eecs.umich.edu * be called on it rather than simply delete.*/ 2032566SN/A bool arrayData; 2042566SN/A 2052662Sstever@eecs.umich.edu /** The address of the request. This address could be virtual or 2062662Sstever@eecs.umich.edu * physical, depending on the system configuration. */ 2072381SN/A Addr addr; 2082381SN/A 2092662Sstever@eecs.umich.edu /** The size of the request or transfer. */ 2102381SN/A int size; 2112381SN/A 2122662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the source of the 2132662Sstever@eecs.umich.edu * transaction. The source is not responsible for setting this 2142662Sstever@eecs.umich.edu * field; it is set implicitly by the interconnect when the 2153349Sbinkertn@umich.edu * packet is first sent. */ 2162381SN/A short src; 2172381SN/A 2182662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the destination of the 2192662Sstever@eecs.umich.edu * transaction. The special value Broadcast indicates that the 2202662Sstever@eecs.umich.edu * packet should be routed based on its address. This field is 2212662Sstever@eecs.umich.edu * initialized in the constructor and is thus always valid 2222662Sstever@eecs.umich.edu * (unlike * addr, size, and src). */ 2232641Sstever@eecs.umich.edu short dest; 2242641Sstever@eecs.umich.edu 2252663Sstever@eecs.umich.edu /** Are the 'addr' and 'size' fields valid? */ 2262663Sstever@eecs.umich.edu bool addrSizeValid; 2272662Sstever@eecs.umich.edu /** Is the 'src' field valid? */ 2282641Sstever@eecs.umich.edu bool srcValid; 2292813Srdreslin@umich.edu 2304626Sstever@eecs.umich.edu enum SnoopFlag { 2314626Sstever@eecs.umich.edu MemInhibit, 2324626Sstever@eecs.umich.edu Shared, 2334626Sstever@eecs.umich.edu NUM_SNOOP_FLAGS 2344626Sstever@eecs.umich.edu }; 2354626Sstever@eecs.umich.edu 2364626Sstever@eecs.umich.edu /** Coherence snoopFlags for snooping */ 2374626Sstever@eecs.umich.edu std::bitset<NUM_SNOOP_FLAGS> snoopFlags; 2382641Sstever@eecs.umich.edu 2392641Sstever@eecs.umich.edu public: 2402641Sstever@eecs.umich.edu 2412811Srdreslin@umich.edu /** Used to calculate latencies for each packet.*/ 2422811Srdreslin@umich.edu Tick time; 2432811Srdreslin@umich.edu 2443218Sgblack@eecs.umich.edu /** The time at which the packet will be fully transmitted */ 2453218Sgblack@eecs.umich.edu Tick finishTime; 2463218Sgblack@eecs.umich.edu 2473218Sgblack@eecs.umich.edu /** The time at which the first chunk of the packet will be transmitted */ 2483218Sgblack@eecs.umich.edu Tick firstWordTime; 2493218Sgblack@eecs.umich.edu 2502662Sstever@eecs.umich.edu /** The special destination address indicating that the packet 2512662Sstever@eecs.umich.edu * should be routed based on its address. */ 2522623SN/A static const short Broadcast = -1; 2532623SN/A 2542662Sstever@eecs.umich.edu /** A pointer to the original request. */ 2552641Sstever@eecs.umich.edu RequestPtr req; 2562641Sstever@eecs.umich.edu 2572662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold coherence-related 2582662Sstever@eecs.umich.edu * state. A specific subclass would be derived from this to 2592662Sstever@eecs.umich.edu * carry state specific to a particular coherence protocol. */ 2602641Sstever@eecs.umich.edu class CoherenceState { 2612641Sstever@eecs.umich.edu public: 2622641Sstever@eecs.umich.edu virtual ~CoherenceState() {} 2632641Sstever@eecs.umich.edu }; 2642641Sstever@eecs.umich.edu 2652662Sstever@eecs.umich.edu /** This packet's coherence state. Caches should use 2662662Sstever@eecs.umich.edu * dynamic_cast<> to cast to the state appropriate for the 2672662Sstever@eecs.umich.edu * system's coherence protocol. */ 2682662Sstever@eecs.umich.edu CoherenceState *coherence; 2692641Sstever@eecs.umich.edu 2702662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold state associated 2712662Sstever@eecs.umich.edu * with the packet but specific to the sending device (e.g., an 2722662Sstever@eecs.umich.edu * MSHR). A pointer to this state is returned in the packet's 2732662Sstever@eecs.umich.edu * response so that the sender can quickly look up the state 2742662Sstever@eecs.umich.edu * needed to process it. A specific subclass would be derived 2752662Sstever@eecs.umich.edu * from this to carry state specific to a particular sending 2762662Sstever@eecs.umich.edu * device. */ 2772641Sstever@eecs.umich.edu class SenderState { 2782641Sstever@eecs.umich.edu public: 2792641Sstever@eecs.umich.edu virtual ~SenderState() {} 2802641Sstever@eecs.umich.edu }; 2812641Sstever@eecs.umich.edu 2822662Sstever@eecs.umich.edu /** This packet's sender state. Devices should use dynamic_cast<> 2832662Sstever@eecs.umich.edu * to cast to the state appropriate to the sender. */ 2842662Sstever@eecs.umich.edu SenderState *senderState; 2852641Sstever@eecs.umich.edu 2864022Sstever@eecs.umich.edu public: 2872641Sstever@eecs.umich.edu 2884022Sstever@eecs.umich.edu /** The command field of the packet. */ 2894022Sstever@eecs.umich.edu MemCmd cmd; 2902641Sstever@eecs.umich.edu 2912662Sstever@eecs.umich.edu /** Return the string name of the cmd field (for debugging and 2922662Sstever@eecs.umich.edu * tracing). */ 2934022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 2942811Srdreslin@umich.edu 2952811Srdreslin@umich.edu /** Return the index of this command. */ 2964022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 2972811Srdreslin@umich.edu 2984022Sstever@eecs.umich.edu public: 2992381SN/A 3004022Sstever@eecs.umich.edu bool isRead() const { return cmd.isRead(); } 3014022Sstever@eecs.umich.edu bool isWrite() const { return cmd.isWrite(); } 3024022Sstever@eecs.umich.edu bool isRequest() const { return cmd.isRequest(); } 3034022Sstever@eecs.umich.edu bool isResponse() const { return cmd.isResponse(); } 3044626Sstever@eecs.umich.edu bool needsExclusive() const { return cmd.needsExclusive(); } 3054022Sstever@eecs.umich.edu bool needsResponse() const { return cmd.needsResponse(); } 3064022Sstever@eecs.umich.edu bool isInvalidate() const { return cmd.isInvalidate(); } 3074022Sstever@eecs.umich.edu bool hasData() const { return cmd.hasData(); } 3084040Ssaidi@eecs.umich.edu bool isReadWrite() const { return cmd.isReadWrite(); } 3094626Sstever@eecs.umich.edu bool isLocked() const { return cmd.isLocked(); } 3102812Srdreslin@umich.edu 3114626Sstever@eecs.umich.edu void assertMemInhibit() { snoopFlags[MemInhibit] = true; } 3124626Sstever@eecs.umich.edu void assertShared() { snoopFlags[Shared] = true; } 3134626Sstever@eecs.umich.edu bool memInhibitAsserted() { return snoopFlags[MemInhibit]; } 3144626Sstever@eecs.umich.edu bool sharedAsserted() { return snoopFlags[Shared]; } 3152814Srdreslin@umich.edu 3163940Ssaidi@eecs.umich.edu bool nic_pkt() { panic("Unimplemented"); M5_DUMMY_RETURN } 3172641Sstever@eecs.umich.edu 3182662Sstever@eecs.umich.edu /** Possible results of a packet's request. */ 3192641Sstever@eecs.umich.edu enum Result 3202641Sstever@eecs.umich.edu { 3212641Sstever@eecs.umich.edu Success, 3222641Sstever@eecs.umich.edu BadAddress, 3232685Ssaidi@eecs.umich.edu Nacked, 3242641Sstever@eecs.umich.edu Unknown 3252641Sstever@eecs.umich.edu }; 3262641Sstever@eecs.umich.edu 3272662Sstever@eecs.umich.edu /** The result of this packet's request. */ 3282641Sstever@eecs.umich.edu Result result; 3292381SN/A 3302381SN/A /** Accessor function that returns the source index of the packet. */ 3312641Sstever@eecs.umich.edu short getSrc() const { assert(srcValid); return src; } 3322641Sstever@eecs.umich.edu void setSrc(short _src) { src = _src; srcValid = true; } 3334626Sstever@eecs.umich.edu /** Reset source field, e.g. to retransmit packet on different bus. */ 3344626Sstever@eecs.umich.edu void clearSrc() { srcValid = false; } 3352381SN/A 3362381SN/A /** Accessor function that returns the destination index of 3372381SN/A the packet. */ 3382381SN/A short getDest() const { return dest; } 3392641Sstever@eecs.umich.edu void setDest(short _dest) { dest = _dest; } 3402549SN/A 3412663Sstever@eecs.umich.edu Addr getAddr() const { assert(addrSizeValid); return addr; } 3422663Sstever@eecs.umich.edu int getSize() const { assert(addrSizeValid); return size; } 3432883Srdreslin@umich.edu Addr getOffset(int blkSize) const { return addr & (Addr)(blkSize - 1); } 3442813Srdreslin@umich.edu 3452813Srdreslin@umich.edu void addrOverride(Addr newAddr) { assert(addrSizeValid); addr = newAddr; } 3464022Sstever@eecs.umich.edu void cmdOverride(MemCmd newCmd) { cmd = newCmd; } 3472641Sstever@eecs.umich.edu 3482662Sstever@eecs.umich.edu /** Constructor. Note that a Request object must be constructed 3492662Sstever@eecs.umich.edu * first, but the Requests's physical address and size fields 3502662Sstever@eecs.umich.edu * need not be valid. The command and destination addresses 3512662Sstever@eecs.umich.edu * must be supplied. */ 3524022Sstever@eecs.umich.edu Packet(Request *_req, MemCmd _cmd, short _dest) 3532566SN/A : data(NULL), staticData(false), dynamicData(false), arrayData(false), 3542641Sstever@eecs.umich.edu addr(_req->paddr), size(_req->size), dest(_dest), 3554626Sstever@eecs.umich.edu addrSizeValid(_req->validPaddr), srcValid(false), 3564626Sstever@eecs.umich.edu snoopFlags(0), 3574626Sstever@eecs.umich.edu time(curTick), 3582641Sstever@eecs.umich.edu req(_req), coherence(NULL), senderState(NULL), cmd(_cmd), 3592662Sstever@eecs.umich.edu result(Unknown) 3602641Sstever@eecs.umich.edu { 3612813Srdreslin@umich.edu } 3622813Srdreslin@umich.edu 3632813Srdreslin@umich.edu /** Alternate constructor if you are trying to create a packet with 3642813Srdreslin@umich.edu * a request that is for a whole block, not the address from the req. 3652813Srdreslin@umich.edu * this allows for overriding the size/addr of the req.*/ 3664022Sstever@eecs.umich.edu Packet(Request *_req, MemCmd _cmd, short _dest, int _blkSize) 3672813Srdreslin@umich.edu : data(NULL), staticData(false), dynamicData(false), arrayData(false), 3684626Sstever@eecs.umich.edu addr(_req->paddr & ~(_blkSize - 1)), size(_blkSize), dest(_dest), 3692814Srdreslin@umich.edu addrSizeValid(_req->validPaddr), srcValid(false), 3704626Sstever@eecs.umich.edu snoopFlags(0), 3714626Sstever@eecs.umich.edu time(curTick), 3722813Srdreslin@umich.edu req(_req), coherence(NULL), senderState(NULL), cmd(_cmd), 3732813Srdreslin@umich.edu result(Unknown) 3742813Srdreslin@umich.edu { 3754626Sstever@eecs.umich.edu } 3764626Sstever@eecs.umich.edu 3774626Sstever@eecs.umich.edu /** Alternate constructor for copying a packet. Copy all fields 3784626Sstever@eecs.umich.edu * *except* set data allocation as static... even if the original 3794626Sstever@eecs.umich.edu * packet's data was dynamic, we don't want to free it when the 3804626Sstever@eecs.umich.edu * new packet is deallocated. Note that if original packet used 3814626Sstever@eecs.umich.edu * dynamic data, user must guarantee that the new packet's 3824626Sstever@eecs.umich.edu * lifetime is less than that of the original packet. */ 3834626Sstever@eecs.umich.edu Packet(Packet *origPkt) 3844626Sstever@eecs.umich.edu : data(NULL), staticData(false), dynamicData(false), arrayData(false), 3854626Sstever@eecs.umich.edu addr(origPkt->addr), size(origPkt->size), 3864626Sstever@eecs.umich.edu dest(origPkt->dest), 3874626Sstever@eecs.umich.edu addrSizeValid(origPkt->addrSizeValid), srcValid(origPkt->srcValid), 3884626Sstever@eecs.umich.edu snoopFlags(origPkt->snoopFlags), 3894626Sstever@eecs.umich.edu time(curTick), 3904626Sstever@eecs.umich.edu req(origPkt->req), coherence(origPkt->coherence), 3914626Sstever@eecs.umich.edu senderState(origPkt->senderState), cmd(origPkt->cmd), 3924626Sstever@eecs.umich.edu result(origPkt->result) 3934626Sstever@eecs.umich.edu { 3942641Sstever@eecs.umich.edu } 3952549SN/A 3962662Sstever@eecs.umich.edu /** Destructor. */ 3972566SN/A ~Packet() 3983665Srdreslin@umich.edu { if (staticData || dynamicData) deleteData(); } 3992566SN/A 4002662Sstever@eecs.umich.edu /** Reinitialize packet address and size from the associated 4012662Sstever@eecs.umich.edu * Request object, and reset other fields that may have been 4022662Sstever@eecs.umich.edu * modified by a previous transaction. Typically called when a 4032662Sstever@eecs.umich.edu * statically allocated Request/Packet pair is reused for 4042662Sstever@eecs.umich.edu * multiple transactions. */ 4052662Sstever@eecs.umich.edu void reinitFromRequest() { 4062662Sstever@eecs.umich.edu assert(req->validPaddr); 4074626Sstever@eecs.umich.edu snoopFlags = 0; 4082663Sstever@eecs.umich.edu addr = req->paddr; 4092663Sstever@eecs.umich.edu size = req->size; 4103018Srdreslin@umich.edu time = req->time; 4112663Sstever@eecs.umich.edu addrSizeValid = true; 4122662Sstever@eecs.umich.edu result = Unknown; 4132662Sstever@eecs.umich.edu if (dynamicData) { 4142662Sstever@eecs.umich.edu deleteData(); 4152662Sstever@eecs.umich.edu dynamicData = false; 4162662Sstever@eecs.umich.edu arrayData = false; 4172662Sstever@eecs.umich.edu } 4182662Sstever@eecs.umich.edu } 4192566SN/A 4204626Sstever@eecs.umich.edu /** 4214626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 4224626Sstever@eecs.umich.edu * returning as a response to that request. The source and 4234626Sstever@eecs.umich.edu * destination fields are *not* modified, as is appropriate for 4244626Sstever@eecs.umich.edu * atomic accesses. 4254626Sstever@eecs.umich.edu */ 4264626Sstever@eecs.umich.edu void makeAtomicResponse() 4274626Sstever@eecs.umich.edu { 4282662Sstever@eecs.umich.edu assert(needsResponse()); 4292855Srdreslin@umich.edu assert(isRequest()); 4304626Sstever@eecs.umich.edu assert(result == Unknown); 4314022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 4324626Sstever@eecs.umich.edu result = Success; 4334626Sstever@eecs.umich.edu } 4344626Sstever@eecs.umich.edu 4354626Sstever@eecs.umich.edu /** 4364626Sstever@eecs.umich.edu * Perform the additional work required for timing responses above 4374626Sstever@eecs.umich.edu * and beyond atomic responses; i.e., change the destination to 4384626Sstever@eecs.umich.edu * point back to the requester and clear the source field. 4394626Sstever@eecs.umich.edu */ 4404626Sstever@eecs.umich.edu void convertAtomicToTimingResponse() 4414626Sstever@eecs.umich.edu { 4422662Sstever@eecs.umich.edu dest = src; 4432662Sstever@eecs.umich.edu srcValid = false; 4442641Sstever@eecs.umich.edu } 4452641Sstever@eecs.umich.edu 4463348Sbinkertn@umich.edu /** 4473348Sbinkertn@umich.edu * Take a request packet and modify it in place to be suitable for 4484626Sstever@eecs.umich.edu * returning as a response to a timing request. 4493135Srdreslin@umich.edu */ 4504626Sstever@eecs.umich.edu void makeTimingResponse() 4513348Sbinkertn@umich.edu { 4524626Sstever@eecs.umich.edu makeAtomicResponse(); 4534626Sstever@eecs.umich.edu convertAtomicToTimingResponse(); 4543135Srdreslin@umich.edu } 4553135Srdreslin@umich.edu 4563348Sbinkertn@umich.edu /** 4573348Sbinkertn@umich.edu * Take a request packet that has been returned as NACKED and 4583348Sbinkertn@umich.edu * modify it so that it can be sent out again. Only packets that 4593348Sbinkertn@umich.edu * need a response can be NACKED, so verify that that is true. 4603348Sbinkertn@umich.edu */ 4613348Sbinkertn@umich.edu void 4623348Sbinkertn@umich.edu reinitNacked() 4633348Sbinkertn@umich.edu { 4642685Ssaidi@eecs.umich.edu assert(needsResponse() && result == Nacked); 4652685Ssaidi@eecs.umich.edu dest = Broadcast; 4662685Ssaidi@eecs.umich.edu result = Unknown; 4672685Ssaidi@eecs.umich.edu } 4682685Ssaidi@eecs.umich.edu 4692685Ssaidi@eecs.umich.edu 4703348Sbinkertn@umich.edu /** 4713348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 4723348Sbinkertn@umich.edu * freed. 4732566SN/A */ 4742566SN/A template <typename T> 4753348Sbinkertn@umich.edu void 4763348Sbinkertn@umich.edu dataStatic(T *p) 4773348Sbinkertn@umich.edu { 4783348Sbinkertn@umich.edu if(dynamicData) 4793348Sbinkertn@umich.edu dynamicData = false; 4803348Sbinkertn@umich.edu data = (PacketDataPtr)p; 4813348Sbinkertn@umich.edu staticData = true; 4823348Sbinkertn@umich.edu } 4832566SN/A 4843348Sbinkertn@umich.edu /** 4853348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 4863348Sbinkertn@umich.edu * called on it. 4873348Sbinkertn@umich.edu */ 4882566SN/A template <typename T> 4893348Sbinkertn@umich.edu void 4903348Sbinkertn@umich.edu dataDynamicArray(T *p) 4913348Sbinkertn@umich.edu { 4923348Sbinkertn@umich.edu assert(!staticData && !dynamicData); 4933348Sbinkertn@umich.edu data = (PacketDataPtr)p; 4943348Sbinkertn@umich.edu dynamicData = true; 4953348Sbinkertn@umich.edu arrayData = true; 4963348Sbinkertn@umich.edu } 4973348Sbinkertn@umich.edu 4983348Sbinkertn@umich.edu /** 4993348Sbinkertn@umich.edu * set the data pointer to a value that should have delete called 5003348Sbinkertn@umich.edu * on it. 5013348Sbinkertn@umich.edu */ 5023348Sbinkertn@umich.edu template <typename T> 5033348Sbinkertn@umich.edu void 5043348Sbinkertn@umich.edu dataDynamic(T *p) 5053348Sbinkertn@umich.edu { 5063348Sbinkertn@umich.edu assert(!staticData && !dynamicData); 5073348Sbinkertn@umich.edu data = (PacketDataPtr)p; 5083348Sbinkertn@umich.edu dynamicData = true; 5093348Sbinkertn@umich.edu arrayData = false; 5103348Sbinkertn@umich.edu } 5113348Sbinkertn@umich.edu 5123348Sbinkertn@umich.edu /** get a pointer to the data ptr. */ 5133348Sbinkertn@umich.edu template <typename T> 5143348Sbinkertn@umich.edu T* 5153348Sbinkertn@umich.edu getPtr() 5163348Sbinkertn@umich.edu { 5173348Sbinkertn@umich.edu assert(staticData || dynamicData); 5183348Sbinkertn@umich.edu return (T*)data; 5193348Sbinkertn@umich.edu } 5202566SN/A 5212566SN/A /** return the value of what is pointed to in the packet. */ 5222566SN/A template <typename T> 5232592SN/A T get(); 5242566SN/A 5252566SN/A /** set the value in the data pointer to v. */ 5262566SN/A template <typename T> 5272592SN/A void set(T v); 5282566SN/A 5293348Sbinkertn@umich.edu /** 5304626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 5314626Sstever@eecs.umich.edu */ 5324626Sstever@eecs.umich.edu void setData(uint8_t *p) 5334626Sstever@eecs.umich.edu { 5344626Sstever@eecs.umich.edu std::memcpy(getPtr<uint8_t>(), p, getSize()); 5354626Sstever@eecs.umich.edu } 5364626Sstever@eecs.umich.edu 5374626Sstever@eecs.umich.edu /** 5384626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 5394626Sstever@eecs.umich.edu * which is aligned to the given block size. 5404626Sstever@eecs.umich.edu */ 5414626Sstever@eecs.umich.edu void setDataFromBlock(uint8_t *blk_data, int blkSize) 5424626Sstever@eecs.umich.edu { 5434626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 5444626Sstever@eecs.umich.edu } 5454626Sstever@eecs.umich.edu 5464626Sstever@eecs.umich.edu /** 5474626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 5484626Sstever@eecs.umich.edu * is aligned to the given block size. 5494626Sstever@eecs.umich.edu */ 5504626Sstever@eecs.umich.edu void writeData(uint8_t *p) 5514626Sstever@eecs.umich.edu { 5524626Sstever@eecs.umich.edu std::memcpy(p, getPtr<uint8_t>(), getSize()); 5534626Sstever@eecs.umich.edu } 5544626Sstever@eecs.umich.edu 5554626Sstever@eecs.umich.edu /** 5564626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 5574626Sstever@eecs.umich.edu */ 5584626Sstever@eecs.umich.edu void writeDataToBlock(uint8_t *blk_data, int blkSize) 5594626Sstever@eecs.umich.edu { 5604626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 5614626Sstever@eecs.umich.edu } 5624626Sstever@eecs.umich.edu 5634626Sstever@eecs.umich.edu /** 5643348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 5653348Sbinkertn@umich.edu * matter how data was allocted. 5663348Sbinkertn@umich.edu */ 5672592SN/A void deleteData(); 5682566SN/A 5692566SN/A /** If there isn't data in the packet, allocate some. */ 5702592SN/A void allocate(); 5712568SN/A 5722568SN/A /** Do the packet modify the same addresses. */ 5733349Sbinkertn@umich.edu bool intersect(PacketPtr p); 5744626Sstever@eecs.umich.edu 5754626Sstever@eecs.umich.edu /** 5764626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 5774626Sstever@eecs.umich.edu * by a base/size pair and an associated data array. If the 5784626Sstever@eecs.umich.edu * functional request is a read, it may be satisfied by the memory 5794626Sstever@eecs.umich.edu * value. If the functional request is a write, it may update the 5804626Sstever@eecs.umich.edu * memory value. 5814626Sstever@eecs.umich.edu */ 5824626Sstever@eecs.umich.edu bool checkFunctional(Addr base, int size, uint8_t *data); 5834626Sstever@eecs.umich.edu 5844626Sstever@eecs.umich.edu /** 5854626Sstever@eecs.umich.edu * Check a functional request against a memory value stored in 5864626Sstever@eecs.umich.edu * another packet (i.e. an in-transit request or response). 5874626Sstever@eecs.umich.edu */ 5884626Sstever@eecs.umich.edu bool checkFunctional(PacketPtr otherPkt) { 5894626Sstever@eecs.umich.edu return (otherPkt->hasData() && 5904626Sstever@eecs.umich.edu checkFunctional(otherPkt->getAddr(), otherPkt->getSize(), 5914626Sstever@eecs.umich.edu otherPkt->getPtr<uint8_t>())); 5924626Sstever@eecs.umich.edu } 5932381SN/A}; 5942381SN/A 5954626Sstever@eecs.umich.edu 5964626Sstever@eecs.umich.edu 5974626Sstever@eecs.umich.edu/** Temporary for backwards compatibility. 5983260Ssaidi@eecs.umich.edu */ 5994626Sstever@eecs.umich.eduinline 6004626Sstever@eecs.umich.edubool fixPacket(PacketPtr func, PacketPtr timing) { 6014626Sstever@eecs.umich.edu return !func->checkFunctional(timing); 6024626Sstever@eecs.umich.edu} 6033260Ssaidi@eecs.umich.edu 6044489Sstever@eecs.umich.edu/** This function is a wrapper for the fixPacket field that toggles 6054489Sstever@eecs.umich.edu * the hasData bit it is used when a response is waiting in the 6064489Sstever@eecs.umich.edu * caches, but hasn't been marked as a response yet (so the fixPacket 6074489Sstever@eecs.umich.edu * needs to get the correct value for the hasData) 6083607Srdreslin@umich.edu */ 6093607Srdreslin@umich.edubool fixDelayedResponsePacket(PacketPtr func, PacketPtr timing); 6103607Srdreslin@umich.edu 6113260Ssaidi@eecs.umich.edustd::ostream & operator<<(std::ostream &o, const Packet &p); 6123260Ssaidi@eecs.umich.edu 6132381SN/A#endif //__MEM_PACKET_HH 614