packet.hh revision 4895
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" 464610Ssaidi@eecs.umich.edu#include "base/fast_alloc.hh" 473940Ssaidi@eecs.umich.edu#include "base/misc.hh" 482392SN/A#include "mem/request.hh" 492980Sgblack@eecs.umich.edu#include "sim/host.hh" 504167Sbinkertn@umich.edu#include "sim/core.hh" 512394SN/A 523940Ssaidi@eecs.umich.edu 532394SN/Astruct Packet; 543349Sbinkertn@umich.edutypedef Packet *PacketPtr; 552394SN/Atypedef uint8_t* PacketDataPtr; 562812Srdreslin@umich.edutypedef std::list<PacketPtr> PacketList; 572812Srdreslin@umich.edu 584022Sstever@eecs.umich.educlass MemCmd 594022Sstever@eecs.umich.edu{ 604022Sstever@eecs.umich.edu public: 614022Sstever@eecs.umich.edu 624022Sstever@eecs.umich.edu /** List of all commands associated with a packet. */ 634022Sstever@eecs.umich.edu enum Command 644022Sstever@eecs.umich.edu { 654022Sstever@eecs.umich.edu InvalidCmd, 664022Sstever@eecs.umich.edu ReadReq, 674473Sstever@eecs.umich.edu ReadResp, 684022Sstever@eecs.umich.edu WriteReq, 694022Sstever@eecs.umich.edu WriteResp, 704022Sstever@eecs.umich.edu Writeback, 714022Sstever@eecs.umich.edu SoftPFReq, 724022Sstever@eecs.umich.edu HardPFReq, 734022Sstever@eecs.umich.edu SoftPFResp, 744022Sstever@eecs.umich.edu HardPFResp, 754022Sstever@eecs.umich.edu WriteInvalidateReq, 764022Sstever@eecs.umich.edu WriteInvalidateResp, 774022Sstever@eecs.umich.edu UpgradeReq, 784628Sstever@eecs.umich.edu UpgradeResp, 794022Sstever@eecs.umich.edu ReadExReq, 804022Sstever@eecs.umich.edu ReadExResp, 814626Sstever@eecs.umich.edu LoadLockedReq, 824626Sstever@eecs.umich.edu LoadLockedResp, 834626Sstever@eecs.umich.edu StoreCondReq, 844626Sstever@eecs.umich.edu StoreCondResp, 854040Ssaidi@eecs.umich.edu SwapReq, 864040Ssaidi@eecs.umich.edu SwapResp, 874870Sstever@eecs.umich.edu // Error responses 884870Sstever@eecs.umich.edu // @TODO these should be classified as responses rather than 894870Sstever@eecs.umich.edu // requests; coding them as requests initially for backwards 904870Sstever@eecs.umich.edu // compatibility 914870Sstever@eecs.umich.edu NetworkNackError, // nacked at network layer (not by protocol) 924870Sstever@eecs.umich.edu InvalidDestError, // packet dest field invalid 934870Sstever@eecs.umich.edu BadAddressError, // memory address invalid 944022Sstever@eecs.umich.edu NUM_MEM_CMDS 954022Sstever@eecs.umich.edu }; 964022Sstever@eecs.umich.edu 974022Sstever@eecs.umich.edu private: 984022Sstever@eecs.umich.edu /** List of command attributes. */ 994022Sstever@eecs.umich.edu enum Attribute 1004022Sstever@eecs.umich.edu { 1014626Sstever@eecs.umich.edu IsRead, //!< Data flows from responder to requester 1024626Sstever@eecs.umich.edu IsWrite, //!< Data flows from requester to responder 1034626Sstever@eecs.umich.edu IsPrefetch, //!< Not a demand access 1044022Sstever@eecs.umich.edu IsInvalidate, 1054626Sstever@eecs.umich.edu NeedsExclusive, //!< Requires exclusive copy to complete in-cache 1064626Sstever@eecs.umich.edu IsRequest, //!< Issued by requester 1074626Sstever@eecs.umich.edu IsResponse, //!< Issue by responder 1084626Sstever@eecs.umich.edu NeedsResponse, //!< Requester needs response from target 1094022Sstever@eecs.umich.edu IsSWPrefetch, 1104022Sstever@eecs.umich.edu IsHWPrefetch, 1114626Sstever@eecs.umich.edu IsLocked, //!< Alpha/MIPS LL or SC access 1124626Sstever@eecs.umich.edu HasData, //!< There is an associated payload 1134870Sstever@eecs.umich.edu IsError, //!< Error response 1144022Sstever@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1154022Sstever@eecs.umich.edu }; 1164022Sstever@eecs.umich.edu 1174022Sstever@eecs.umich.edu /** Structure that defines attributes and other data associated 1184022Sstever@eecs.umich.edu * with a Command. */ 1194022Sstever@eecs.umich.edu struct CommandInfo { 1204022Sstever@eecs.umich.edu /** Set of attribute flags. */ 1214022Sstever@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1224022Sstever@eecs.umich.edu /** Corresponding response for requests; InvalidCmd if no 1234022Sstever@eecs.umich.edu * response is applicable. */ 1244022Sstever@eecs.umich.edu const Command response; 1254022Sstever@eecs.umich.edu /** String representation (for printing) */ 1264022Sstever@eecs.umich.edu const std::string str; 1274022Sstever@eecs.umich.edu }; 1284022Sstever@eecs.umich.edu 1294022Sstever@eecs.umich.edu /** Array to map Command enum to associated info. */ 1304022Sstever@eecs.umich.edu static const CommandInfo commandInfo[]; 1314022Sstever@eecs.umich.edu 1324022Sstever@eecs.umich.edu private: 1334022Sstever@eecs.umich.edu 1344022Sstever@eecs.umich.edu Command cmd; 1354022Sstever@eecs.umich.edu 1364022Sstever@eecs.umich.edu bool testCmdAttrib(MemCmd::Attribute attrib) const { 1374022Sstever@eecs.umich.edu return commandInfo[cmd].attributes[attrib] != 0; 1384022Sstever@eecs.umich.edu } 1394022Sstever@eecs.umich.edu 1404022Sstever@eecs.umich.edu public: 1414022Sstever@eecs.umich.edu 1424022Sstever@eecs.umich.edu bool isRead() const { return testCmdAttrib(IsRead); } 1434022Sstever@eecs.umich.edu bool isWrite() const { return testCmdAttrib(IsWrite); } 1444022Sstever@eecs.umich.edu bool isRequest() const { return testCmdAttrib(IsRequest); } 1454022Sstever@eecs.umich.edu bool isResponse() const { return testCmdAttrib(IsResponse); } 1464870Sstever@eecs.umich.edu bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 1474022Sstever@eecs.umich.edu bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 1484022Sstever@eecs.umich.edu bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 1494022Sstever@eecs.umich.edu bool hasData() const { return testCmdAttrib(HasData); } 1504626Sstever@eecs.umich.edu bool isReadWrite() const { return isRead() && isWrite(); } 1514626Sstever@eecs.umich.edu bool isLocked() const { return testCmdAttrib(IsLocked); } 1524870Sstever@eecs.umich.edu bool isError() const { return testCmdAttrib(IsError); } 1534022Sstever@eecs.umich.edu 1544022Sstever@eecs.umich.edu const Command responseCommand() const { 1554022Sstever@eecs.umich.edu return commandInfo[cmd].response; 1564022Sstever@eecs.umich.edu } 1574022Sstever@eecs.umich.edu 1584022Sstever@eecs.umich.edu /** Return the string to a cmd given by idx. */ 1594022Sstever@eecs.umich.edu const std::string &toString() const { 1604022Sstever@eecs.umich.edu return commandInfo[cmd].str; 1614022Sstever@eecs.umich.edu } 1624022Sstever@eecs.umich.edu 1634022Sstever@eecs.umich.edu int toInt() const { return (int)cmd; } 1644022Sstever@eecs.umich.edu 1654022Sstever@eecs.umich.edu MemCmd(Command _cmd) 1664022Sstever@eecs.umich.edu : cmd(_cmd) 1674022Sstever@eecs.umich.edu { } 1684022Sstever@eecs.umich.edu 1694022Sstever@eecs.umich.edu MemCmd(int _cmd) 1704022Sstever@eecs.umich.edu : cmd((Command)_cmd) 1714022Sstever@eecs.umich.edu { } 1724022Sstever@eecs.umich.edu 1734022Sstever@eecs.umich.edu MemCmd() 1744022Sstever@eecs.umich.edu : cmd(InvalidCmd) 1754022Sstever@eecs.umich.edu { } 1764022Sstever@eecs.umich.edu 1774022Sstever@eecs.umich.edu bool operator==(MemCmd c2) { return (cmd == c2.cmd); } 1784022Sstever@eecs.umich.edu bool operator!=(MemCmd c2) { return (cmd != c2.cmd); } 1794022Sstever@eecs.umich.edu 1804022Sstever@eecs.umich.edu friend class Packet; 1814022Sstever@eecs.umich.edu}; 1824022Sstever@eecs.umich.edu 1832381SN/A/** 1842662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 1852662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 1862662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 1872662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 1882662Sstever@eecs.umich.edu * different Packets along the way.) 1892381SN/A */ 1904610Ssaidi@eecs.umich.educlass Packet : public FastAlloc 1912381SN/A{ 1922813Srdreslin@umich.edu public: 1934022Sstever@eecs.umich.edu 1944022Sstever@eecs.umich.edu typedef MemCmd::Command Command; 1954022Sstever@eecs.umich.edu 1964870Sstever@eecs.umich.edu /** The command field of the packet. */ 1974870Sstever@eecs.umich.edu MemCmd cmd; 1984870Sstever@eecs.umich.edu 1994870Sstever@eecs.umich.edu /** A pointer to the original request. */ 2004870Sstever@eecs.umich.edu RequestPtr req; 2014870Sstever@eecs.umich.edu 2022566SN/A private: 2032662Sstever@eecs.umich.edu /** A pointer to the data being transfered. It can be differnt 2042662Sstever@eecs.umich.edu * sizes at each level of the heirarchy so it belongs in the 2052662Sstever@eecs.umich.edu * packet, not request. This may or may not be populated when a 2062662Sstever@eecs.umich.edu * responder recieves the packet. If not populated it memory 2072662Sstever@eecs.umich.edu * should be allocated. 2082566SN/A */ 2092566SN/A PacketDataPtr data; 2102566SN/A 2112662Sstever@eecs.umich.edu /** Is the data pointer set to a value that shouldn't be freed 2122662Sstever@eecs.umich.edu * when the packet is destroyed? */ 2132566SN/A bool staticData; 2142662Sstever@eecs.umich.edu /** The data pointer points to a value that should be freed when 2152662Sstever@eecs.umich.edu * the packet is destroyed. */ 2162566SN/A bool dynamicData; 2172662Sstever@eecs.umich.edu /** the data pointer points to an array (thus delete [] ) needs to 2182662Sstever@eecs.umich.edu * be called on it rather than simply delete.*/ 2192566SN/A bool arrayData; 2202566SN/A 2212662Sstever@eecs.umich.edu /** The address of the request. This address could be virtual or 2222662Sstever@eecs.umich.edu * physical, depending on the system configuration. */ 2232381SN/A Addr addr; 2242381SN/A 2252662Sstever@eecs.umich.edu /** The size of the request or transfer. */ 2262381SN/A int size; 2272381SN/A 2282662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the source of the 2292662Sstever@eecs.umich.edu * transaction. The source is not responsible for setting this 2302662Sstever@eecs.umich.edu * field; it is set implicitly by the interconnect when the 2313349Sbinkertn@umich.edu * packet is first sent. */ 2322381SN/A short src; 2332381SN/A 2342662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the destination of the 2352662Sstever@eecs.umich.edu * transaction. The special value Broadcast indicates that the 2362662Sstever@eecs.umich.edu * packet should be routed based on its address. This field is 2372662Sstever@eecs.umich.edu * initialized in the constructor and is thus always valid 2382662Sstever@eecs.umich.edu * (unlike * addr, size, and src). */ 2392641Sstever@eecs.umich.edu short dest; 2402641Sstever@eecs.umich.edu 2414870Sstever@eecs.umich.edu /** The original value of the command field. Only valid when the 2424870Sstever@eecs.umich.edu * current command field is an error condition; in that case, the 2434870Sstever@eecs.umich.edu * previous contents of the command field are copied here. This 2444870Sstever@eecs.umich.edu * field is *not* set on non-error responses. 2454870Sstever@eecs.umich.edu */ 2464870Sstever@eecs.umich.edu MemCmd origCmd; 2474870Sstever@eecs.umich.edu 2482663Sstever@eecs.umich.edu /** Are the 'addr' and 'size' fields valid? */ 2492663Sstever@eecs.umich.edu bool addrSizeValid; 2502662Sstever@eecs.umich.edu /** Is the 'src' field valid? */ 2512641Sstever@eecs.umich.edu bool srcValid; 2524870Sstever@eecs.umich.edu bool destValid; 2532813Srdreslin@umich.edu 2544870Sstever@eecs.umich.edu enum Flag { 2554895Sstever@eecs.umich.edu // Snoop response flags 2564626Sstever@eecs.umich.edu MemInhibit, 2574626Sstever@eecs.umich.edu Shared, 2584895Sstever@eecs.umich.edu // Special control flags 2594895Sstever@eecs.umich.edu ExpressSnoop, 2604870Sstever@eecs.umich.edu NUM_PACKET_FLAGS 2614626Sstever@eecs.umich.edu }; 2624626Sstever@eecs.umich.edu 2634870Sstever@eecs.umich.edu /** Status flags */ 2644870Sstever@eecs.umich.edu std::bitset<NUM_PACKET_FLAGS> flags; 2652641Sstever@eecs.umich.edu 2662641Sstever@eecs.umich.edu public: 2672641Sstever@eecs.umich.edu 2682811Srdreslin@umich.edu /** Used to calculate latencies for each packet.*/ 2692811Srdreslin@umich.edu Tick time; 2702811Srdreslin@umich.edu 2713218Sgblack@eecs.umich.edu /** The time at which the packet will be fully transmitted */ 2723218Sgblack@eecs.umich.edu Tick finishTime; 2733218Sgblack@eecs.umich.edu 2743218Sgblack@eecs.umich.edu /** The time at which the first chunk of the packet will be transmitted */ 2753218Sgblack@eecs.umich.edu Tick firstWordTime; 2763218Sgblack@eecs.umich.edu 2772662Sstever@eecs.umich.edu /** The special destination address indicating that the packet 2782662Sstever@eecs.umich.edu * should be routed based on its address. */ 2792623SN/A static const short Broadcast = -1; 2802623SN/A 2812662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold state associated 2822662Sstever@eecs.umich.edu * with the packet but specific to the sending device (e.g., an 2832662Sstever@eecs.umich.edu * MSHR). A pointer to this state is returned in the packet's 2842662Sstever@eecs.umich.edu * response so that the sender can quickly look up the state 2852662Sstever@eecs.umich.edu * needed to process it. A specific subclass would be derived 2862662Sstever@eecs.umich.edu * from this to carry state specific to a particular sending 2872662Sstever@eecs.umich.edu * device. */ 2884610Ssaidi@eecs.umich.edu class SenderState : public FastAlloc { 2892641Sstever@eecs.umich.edu public: 2902641Sstever@eecs.umich.edu virtual ~SenderState() {} 2912641Sstever@eecs.umich.edu }; 2922641Sstever@eecs.umich.edu 2932662Sstever@eecs.umich.edu /** This packet's sender state. Devices should use dynamic_cast<> 2942662Sstever@eecs.umich.edu * to cast to the state appropriate to the sender. */ 2952662Sstever@eecs.umich.edu SenderState *senderState; 2962641Sstever@eecs.umich.edu 2972662Sstever@eecs.umich.edu /** Return the string name of the cmd field (for debugging and 2982662Sstever@eecs.umich.edu * tracing). */ 2994022Sstever@eecs.umich.edu const std::string &cmdString() const { return cmd.toString(); } 3002811Srdreslin@umich.edu 3012811Srdreslin@umich.edu /** Return the index of this command. */ 3024022Sstever@eecs.umich.edu inline int cmdToIndex() const { return cmd.toInt(); } 3032811Srdreslin@umich.edu 3044022Sstever@eecs.umich.edu bool isRead() const { return cmd.isRead(); } 3054022Sstever@eecs.umich.edu bool isWrite() const { return cmd.isWrite(); } 3064022Sstever@eecs.umich.edu bool isRequest() const { return cmd.isRequest(); } 3074022Sstever@eecs.umich.edu bool isResponse() const { return cmd.isResponse(); } 3084870Sstever@eecs.umich.edu bool needsExclusive() const { return cmd.needsExclusive(); } 3094022Sstever@eecs.umich.edu bool needsResponse() const { return cmd.needsResponse(); } 3104022Sstever@eecs.umich.edu bool isInvalidate() const { return cmd.isInvalidate(); } 3114022Sstever@eecs.umich.edu bool hasData() const { return cmd.hasData(); } 3124040Ssaidi@eecs.umich.edu bool isReadWrite() const { return cmd.isReadWrite(); } 3134626Sstever@eecs.umich.edu bool isLocked() const { return cmd.isLocked(); } 3144870Sstever@eecs.umich.edu bool isError() const { return cmd.isError(); } 3152812Srdreslin@umich.edu 3164870Sstever@eecs.umich.edu // Snoop flags 3174870Sstever@eecs.umich.edu void assertMemInhibit() { flags[MemInhibit] = true; } 3184870Sstever@eecs.umich.edu void assertShared() { flags[Shared] = true; } 3194870Sstever@eecs.umich.edu bool memInhibitAsserted() { return flags[MemInhibit]; } 3204870Sstever@eecs.umich.edu bool sharedAsserted() { return flags[Shared]; } 3214870Sstever@eecs.umich.edu 3224895Sstever@eecs.umich.edu // Special control flags 3234895Sstever@eecs.umich.edu void setExpressSnoop() { flags[ExpressSnoop] = true; } 3244895Sstever@eecs.umich.edu bool isExpressSnoop() { return flags[ExpressSnoop]; } 3254895Sstever@eecs.umich.edu 3264870Sstever@eecs.umich.edu // Network error conditions... encapsulate them as methods since 3274870Sstever@eecs.umich.edu // their encoding keeps changing (from result field to command 3284870Sstever@eecs.umich.edu // field, etc.) 3294870Sstever@eecs.umich.edu void setNacked() { origCmd = cmd; cmd = MemCmd::NetworkNackError; } 3304870Sstever@eecs.umich.edu void setBadAddress() { origCmd = cmd; cmd = MemCmd::BadAddressError; } 3314870Sstever@eecs.umich.edu bool wasNacked() { return cmd == MemCmd::NetworkNackError; } 3324870Sstever@eecs.umich.edu bool hadBadAddress() { return cmd == MemCmd::BadAddressError; } 3332814Srdreslin@umich.edu 3343940Ssaidi@eecs.umich.edu bool nic_pkt() { panic("Unimplemented"); M5_DUMMY_RETURN } 3352641Sstever@eecs.umich.edu 3362381SN/A /** Accessor function that returns the source index of the packet. */ 3374870Sstever@eecs.umich.edu short getSrc() const { assert(srcValid); return src; } 3382641Sstever@eecs.umich.edu void setSrc(short _src) { src = _src; srcValid = true; } 3394626Sstever@eecs.umich.edu /** Reset source field, e.g. to retransmit packet on different bus. */ 3404626Sstever@eecs.umich.edu void clearSrc() { srcValid = false; } 3412381SN/A 3422381SN/A /** Accessor function that returns the destination index of 3432381SN/A the packet. */ 3444870Sstever@eecs.umich.edu short getDest() const { assert(destValid); return dest; } 3454870Sstever@eecs.umich.edu void setDest(short _dest) { dest = _dest; destValid = true; } 3462549SN/A 3472663Sstever@eecs.umich.edu Addr getAddr() const { assert(addrSizeValid); return addr; } 3484870Sstever@eecs.umich.edu int getSize() const { assert(addrSizeValid); return size; } 3492883Srdreslin@umich.edu Addr getOffset(int blkSize) const { return addr & (Addr)(blkSize - 1); } 3502813Srdreslin@umich.edu 3512662Sstever@eecs.umich.edu /** Constructor. Note that a Request object must be constructed 3522662Sstever@eecs.umich.edu * first, but the Requests's physical address and size fields 3532662Sstever@eecs.umich.edu * need not be valid. The command and destination addresses 3542662Sstever@eecs.umich.edu * must be supplied. */ 3554022Sstever@eecs.umich.edu Packet(Request *_req, MemCmd _cmd, short _dest) 3564870Sstever@eecs.umich.edu : cmd(_cmd), req(_req), 3574870Sstever@eecs.umich.edu data(NULL), staticData(false), dynamicData(false), arrayData(false), 3582641Sstever@eecs.umich.edu addr(_req->paddr), size(_req->size), dest(_dest), 3594870Sstever@eecs.umich.edu addrSizeValid(_req->validPaddr), srcValid(false), destValid(true), 3604870Sstever@eecs.umich.edu flags(0), time(curTick), senderState(NULL) 3612641Sstever@eecs.umich.edu { 3622813Srdreslin@umich.edu } 3632813Srdreslin@umich.edu 3642813Srdreslin@umich.edu /** Alternate constructor if you are trying to create a packet with 3652813Srdreslin@umich.edu * a request that is for a whole block, not the address from the req. 3662813Srdreslin@umich.edu * this allows for overriding the size/addr of the req.*/ 3674022Sstever@eecs.umich.edu Packet(Request *_req, MemCmd _cmd, short _dest, int _blkSize) 3684870Sstever@eecs.umich.edu : cmd(_cmd), req(_req), 3694870Sstever@eecs.umich.edu data(NULL), staticData(false), dynamicData(false), arrayData(false), 3704626Sstever@eecs.umich.edu addr(_req->paddr & ~(_blkSize - 1)), size(_blkSize), dest(_dest), 3714870Sstever@eecs.umich.edu addrSizeValid(_req->validPaddr), srcValid(false), destValid(true), 3724870Sstever@eecs.umich.edu flags(0), time(curTick), senderState(NULL) 3732813Srdreslin@umich.edu { 3744626Sstever@eecs.umich.edu } 3754626Sstever@eecs.umich.edu 3764626Sstever@eecs.umich.edu /** Alternate constructor for copying a packet. Copy all fields 3774887Sstever@eecs.umich.edu * *except* if the original packet's data was dynamic, don't copy 3784887Sstever@eecs.umich.edu * that, as we can't guarantee that the new packet's lifetime is 3794887Sstever@eecs.umich.edu * less than that of the original packet. In this case the new 3804887Sstever@eecs.umich.edu * packet should allocate its own data. */ 3814895Sstever@eecs.umich.edu Packet(Packet *origPkt, bool clearFlags = false) 3824870Sstever@eecs.umich.edu : cmd(origPkt->cmd), req(origPkt->req), 3834887Sstever@eecs.umich.edu data(origPkt->staticData ? origPkt->data : NULL), 3844887Sstever@eecs.umich.edu staticData(origPkt->staticData), 3854887Sstever@eecs.umich.edu dynamicData(false), arrayData(false), 3864626Sstever@eecs.umich.edu addr(origPkt->addr), size(origPkt->size), 3874660Sstever@eecs.umich.edu src(origPkt->src), dest(origPkt->dest), 3884870Sstever@eecs.umich.edu addrSizeValid(origPkt->addrSizeValid), 3894870Sstever@eecs.umich.edu srcValid(origPkt->srcValid), destValid(origPkt->destValid), 3904895Sstever@eecs.umich.edu flags(clearFlags ? 0 : origPkt->flags), 3914870Sstever@eecs.umich.edu time(curTick), senderState(origPkt->senderState) 3924626Sstever@eecs.umich.edu { 3932641Sstever@eecs.umich.edu } 3942549SN/A 3952662Sstever@eecs.umich.edu /** Destructor. */ 3962566SN/A ~Packet() 3973665Srdreslin@umich.edu { if (staticData || dynamicData) deleteData(); } 3982566SN/A 3992662Sstever@eecs.umich.edu /** Reinitialize packet address and size from the associated 4002662Sstever@eecs.umich.edu * Request object, and reset other fields that may have been 4012662Sstever@eecs.umich.edu * modified by a previous transaction. Typically called when a 4022662Sstever@eecs.umich.edu * statically allocated Request/Packet pair is reused for 4032662Sstever@eecs.umich.edu * multiple transactions. */ 4042662Sstever@eecs.umich.edu void reinitFromRequest() { 4052662Sstever@eecs.umich.edu assert(req->validPaddr); 4064870Sstever@eecs.umich.edu flags = 0; 4072663Sstever@eecs.umich.edu addr = req->paddr; 4082663Sstever@eecs.umich.edu size = req->size; 4093018Srdreslin@umich.edu time = req->time; 4102663Sstever@eecs.umich.edu addrSizeValid = true; 4112662Sstever@eecs.umich.edu if (dynamicData) { 4122662Sstever@eecs.umich.edu deleteData(); 4132662Sstever@eecs.umich.edu dynamicData = false; 4142662Sstever@eecs.umich.edu arrayData = false; 4152662Sstever@eecs.umich.edu } 4162662Sstever@eecs.umich.edu } 4172566SN/A 4184626Sstever@eecs.umich.edu /** 4194626Sstever@eecs.umich.edu * Take a request packet and modify it in place to be suitable for 4204626Sstever@eecs.umich.edu * returning as a response to that request. The source and 4214626Sstever@eecs.umich.edu * destination fields are *not* modified, as is appropriate for 4224626Sstever@eecs.umich.edu * atomic accesses. 4234626Sstever@eecs.umich.edu */ 4244870Sstever@eecs.umich.edu void makeResponse() 4254626Sstever@eecs.umich.edu { 4262662Sstever@eecs.umich.edu assert(needsResponse()); 4272855Srdreslin@umich.edu assert(isRequest()); 4284022Sstever@eecs.umich.edu cmd = cmd.responseCommand(); 4294870Sstever@eecs.umich.edu dest = src; 4304870Sstever@eecs.umich.edu destValid = srcValid; 4312662Sstever@eecs.umich.edu srcValid = false; 4322641Sstever@eecs.umich.edu } 4332641Sstever@eecs.umich.edu 4344870Sstever@eecs.umich.edu void makeAtomicResponse() 4354870Sstever@eecs.umich.edu { 4364870Sstever@eecs.umich.edu makeResponse(); 4374870Sstever@eecs.umich.edu } 4384870Sstever@eecs.umich.edu 4394626Sstever@eecs.umich.edu void makeTimingResponse() 4403348Sbinkertn@umich.edu { 4414870Sstever@eecs.umich.edu makeResponse(); 4423135Srdreslin@umich.edu } 4433135Srdreslin@umich.edu 4443348Sbinkertn@umich.edu /** 4453348Sbinkertn@umich.edu * Take a request packet that has been returned as NACKED and 4463348Sbinkertn@umich.edu * modify it so that it can be sent out again. Only packets that 4473348Sbinkertn@umich.edu * need a response can be NACKED, so verify that that is true. 4483348Sbinkertn@umich.edu */ 4493348Sbinkertn@umich.edu void 4503348Sbinkertn@umich.edu reinitNacked() 4513348Sbinkertn@umich.edu { 4524870Sstever@eecs.umich.edu assert(wasNacked()); 4534870Sstever@eecs.umich.edu cmd = origCmd; 4544870Sstever@eecs.umich.edu assert(needsResponse()); 4554870Sstever@eecs.umich.edu setDest(Broadcast); 4562685Ssaidi@eecs.umich.edu } 4572685Ssaidi@eecs.umich.edu 4582685Ssaidi@eecs.umich.edu 4593348Sbinkertn@umich.edu /** 4603348Sbinkertn@umich.edu * Set the data pointer to the following value that should not be 4613348Sbinkertn@umich.edu * freed. 4622566SN/A */ 4632566SN/A template <typename T> 4643348Sbinkertn@umich.edu void 4653348Sbinkertn@umich.edu dataStatic(T *p) 4663348Sbinkertn@umich.edu { 4673348Sbinkertn@umich.edu if(dynamicData) 4683348Sbinkertn@umich.edu dynamicData = false; 4693348Sbinkertn@umich.edu data = (PacketDataPtr)p; 4703348Sbinkertn@umich.edu staticData = true; 4713348Sbinkertn@umich.edu } 4722566SN/A 4733348Sbinkertn@umich.edu /** 4743348Sbinkertn@umich.edu * Set the data pointer to a value that should have delete [] 4753348Sbinkertn@umich.edu * called on it. 4763348Sbinkertn@umich.edu */ 4772566SN/A template <typename T> 4783348Sbinkertn@umich.edu void 4793348Sbinkertn@umich.edu dataDynamicArray(T *p) 4803348Sbinkertn@umich.edu { 4813348Sbinkertn@umich.edu assert(!staticData && !dynamicData); 4823348Sbinkertn@umich.edu data = (PacketDataPtr)p; 4833348Sbinkertn@umich.edu dynamicData = true; 4843348Sbinkertn@umich.edu arrayData = true; 4853348Sbinkertn@umich.edu } 4863348Sbinkertn@umich.edu 4873348Sbinkertn@umich.edu /** 4883348Sbinkertn@umich.edu * set the data pointer to a value that should have delete called 4893348Sbinkertn@umich.edu * on it. 4903348Sbinkertn@umich.edu */ 4913348Sbinkertn@umich.edu template <typename T> 4923348Sbinkertn@umich.edu void 4933348Sbinkertn@umich.edu dataDynamic(T *p) 4943348Sbinkertn@umich.edu { 4953348Sbinkertn@umich.edu assert(!staticData && !dynamicData); 4963348Sbinkertn@umich.edu data = (PacketDataPtr)p; 4973348Sbinkertn@umich.edu dynamicData = true; 4983348Sbinkertn@umich.edu arrayData = false; 4993348Sbinkertn@umich.edu } 5003348Sbinkertn@umich.edu 5013348Sbinkertn@umich.edu /** get a pointer to the data ptr. */ 5023348Sbinkertn@umich.edu template <typename T> 5033348Sbinkertn@umich.edu T* 5043348Sbinkertn@umich.edu getPtr() 5053348Sbinkertn@umich.edu { 5063348Sbinkertn@umich.edu assert(staticData || dynamicData); 5073348Sbinkertn@umich.edu return (T*)data; 5083348Sbinkertn@umich.edu } 5092566SN/A 5102566SN/A /** return the value of what is pointed to in the packet. */ 5112566SN/A template <typename T> 5122592SN/A T get(); 5132566SN/A 5142566SN/A /** set the value in the data pointer to v. */ 5152566SN/A template <typename T> 5162592SN/A void set(T v); 5172566SN/A 5183348Sbinkertn@umich.edu /** 5194626Sstever@eecs.umich.edu * Copy data into the packet from the provided pointer. 5204626Sstever@eecs.umich.edu */ 5214626Sstever@eecs.umich.edu void setData(uint8_t *p) 5224626Sstever@eecs.umich.edu { 5234626Sstever@eecs.umich.edu std::memcpy(getPtr<uint8_t>(), p, getSize()); 5244626Sstever@eecs.umich.edu } 5254626Sstever@eecs.umich.edu 5264626Sstever@eecs.umich.edu /** 5274626Sstever@eecs.umich.edu * Copy data into the packet from the provided block pointer, 5284626Sstever@eecs.umich.edu * which is aligned to the given block size. 5294626Sstever@eecs.umich.edu */ 5304626Sstever@eecs.umich.edu void setDataFromBlock(uint8_t *blk_data, int blkSize) 5314626Sstever@eecs.umich.edu { 5324626Sstever@eecs.umich.edu setData(blk_data + getOffset(blkSize)); 5334626Sstever@eecs.umich.edu } 5344626Sstever@eecs.umich.edu 5354626Sstever@eecs.umich.edu /** 5364626Sstever@eecs.umich.edu * Copy data from the packet to the provided block pointer, which 5374626Sstever@eecs.umich.edu * is aligned to the given block size. 5384626Sstever@eecs.umich.edu */ 5394626Sstever@eecs.umich.edu void writeData(uint8_t *p) 5404626Sstever@eecs.umich.edu { 5414626Sstever@eecs.umich.edu std::memcpy(p, getPtr<uint8_t>(), getSize()); 5424626Sstever@eecs.umich.edu } 5434626Sstever@eecs.umich.edu 5444626Sstever@eecs.umich.edu /** 5454626Sstever@eecs.umich.edu * Copy data from the packet to the memory at the provided pointer. 5464626Sstever@eecs.umich.edu */ 5474626Sstever@eecs.umich.edu void writeDataToBlock(uint8_t *blk_data, int blkSize) 5484626Sstever@eecs.umich.edu { 5494626Sstever@eecs.umich.edu writeData(blk_data + getOffset(blkSize)); 5504626Sstever@eecs.umich.edu } 5514626Sstever@eecs.umich.edu 5524626Sstever@eecs.umich.edu /** 5533348Sbinkertn@umich.edu * delete the data pointed to in the data pointer. Ok to call to 5543348Sbinkertn@umich.edu * matter how data was allocted. 5553348Sbinkertn@umich.edu */ 5562592SN/A void deleteData(); 5572566SN/A 5582566SN/A /** If there isn't data in the packet, allocate some. */ 5592592SN/A void allocate(); 5602568SN/A 5612568SN/A /** Do the packet modify the same addresses. */ 5623349Sbinkertn@umich.edu bool intersect(PacketPtr p); 5634626Sstever@eecs.umich.edu 5644626Sstever@eecs.umich.edu /** 5654626Sstever@eecs.umich.edu * Check a functional request against a memory value represented 5664626Sstever@eecs.umich.edu * by a base/size pair and an associated data array. If the 5674626Sstever@eecs.umich.edu * functional request is a read, it may be satisfied by the memory 5684626Sstever@eecs.umich.edu * value. If the functional request is a write, it may update the 5694626Sstever@eecs.umich.edu * memory value. 5704626Sstever@eecs.umich.edu */ 5714626Sstever@eecs.umich.edu bool checkFunctional(Addr base, int size, uint8_t *data); 5724626Sstever@eecs.umich.edu 5734626Sstever@eecs.umich.edu /** 5744626Sstever@eecs.umich.edu * Check a functional request against a memory value stored in 5754626Sstever@eecs.umich.edu * another packet (i.e. an in-transit request or response). 5764626Sstever@eecs.umich.edu */ 5774626Sstever@eecs.umich.edu bool checkFunctional(PacketPtr otherPkt) { 5784626Sstever@eecs.umich.edu return (otherPkt->hasData() && 5794626Sstever@eecs.umich.edu checkFunctional(otherPkt->getAddr(), otherPkt->getSize(), 5804626Sstever@eecs.umich.edu otherPkt->getPtr<uint8_t>())); 5814626Sstever@eecs.umich.edu } 5822381SN/A}; 5832381SN/A 5843260Ssaidi@eecs.umich.edustd::ostream & operator<<(std::ostream &o, const Packet &p); 5853260Ssaidi@eecs.umich.edu 5862381SN/A#endif //__MEM_PACKET_HH 587