packet.hh revision 2662
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. 272381SN/A */ 282381SN/A 292381SN/A/** 302381SN/A * @file 312662Sstever@eecs.umich.edu * Declaration of the Packet class. 322381SN/A */ 332381SN/A 342381SN/A#ifndef __MEM_PACKET_HH__ 352381SN/A#define __MEM_PACKET_HH__ 362381SN/A 372392SN/A#include "mem/request.hh" 382423SN/A#include "arch/isa_traits.hh" 392394SN/A#include "sim/root.hh" 402394SN/A 412394SN/Astruct Packet; 422394SN/Atypedef Packet* PacketPtr; 432394SN/Atypedef uint8_t* PacketDataPtr; 442382SN/A 452381SN/A/** 462662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 472662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 482662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 492662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 502662Sstever@eecs.umich.edu * different Packets along the way.) 512381SN/A */ 522641Sstever@eecs.umich.educlass Packet 532381SN/A{ 542566SN/A private: 552662Sstever@eecs.umich.edu /** A pointer to the data being transfered. It can be differnt 562662Sstever@eecs.umich.edu * sizes at each level of the heirarchy so it belongs in the 572662Sstever@eecs.umich.edu * packet, not request. This may or may not be populated when a 582662Sstever@eecs.umich.edu * responder recieves the packet. If not populated it memory 592662Sstever@eecs.umich.edu * should be allocated. 602566SN/A */ 612566SN/A PacketDataPtr data; 622566SN/A 632662Sstever@eecs.umich.edu /** Is the data pointer set to a value that shouldn't be freed 642662Sstever@eecs.umich.edu * when the packet is destroyed? */ 652566SN/A bool staticData; 662662Sstever@eecs.umich.edu /** The data pointer points to a value that should be freed when 672662Sstever@eecs.umich.edu * the packet is destroyed. */ 682566SN/A bool dynamicData; 692662Sstever@eecs.umich.edu /** the data pointer points to an array (thus delete [] ) needs to 702662Sstever@eecs.umich.edu * be called on it rather than simply delete.*/ 712566SN/A bool arrayData; 722566SN/A 732566SN/A 742662Sstever@eecs.umich.edu /** The address of the request. This address could be virtual or 752662Sstever@eecs.umich.edu * physical, depending on the system configuration. */ 762381SN/A Addr addr; 772381SN/A 782662Sstever@eecs.umich.edu /** The size of the request or transfer. */ 792381SN/A int size; 802381SN/A 812662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the source of the 822662Sstever@eecs.umich.edu * transaction. The source is not responsible for setting this 832662Sstever@eecs.umich.edu * field; it is set implicitly by the interconnect when the 842662Sstever@eecs.umich.edu * packet * is first sent. */ 852381SN/A short src; 862381SN/A 872662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the destination of the 882662Sstever@eecs.umich.edu * transaction. The special value Broadcast indicates that the 892662Sstever@eecs.umich.edu * packet should be routed based on its address. This field is 902662Sstever@eecs.umich.edu * initialized in the constructor and is thus always valid 912662Sstever@eecs.umich.edu * (unlike * addr, size, and src). */ 922641Sstever@eecs.umich.edu short dest; 932641Sstever@eecs.umich.edu 942662Sstever@eecs.umich.edu /** Is the 'addr' field valid? */ 952641Sstever@eecs.umich.edu bool addrValid; 962662Sstever@eecs.umich.edu /** Is the 'size' field valid? */ 972641Sstever@eecs.umich.edu bool sizeValid; 982662Sstever@eecs.umich.edu /** Is the 'src' field valid? */ 992641Sstever@eecs.umich.edu bool srcValid; 1002641Sstever@eecs.umich.edu 1012641Sstever@eecs.umich.edu public: 1022641Sstever@eecs.umich.edu 1032662Sstever@eecs.umich.edu /** The special destination address indicating that the packet 1042662Sstever@eecs.umich.edu * should be routed based on its address. */ 1052623SN/A static const short Broadcast = -1; 1062623SN/A 1072662Sstever@eecs.umich.edu /** A pointer to the original request. */ 1082641Sstever@eecs.umich.edu RequestPtr req; 1092641Sstever@eecs.umich.edu 1102662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold coherence-related 1112662Sstever@eecs.umich.edu * state. A specific subclass would be derived from this to 1122662Sstever@eecs.umich.edu * carry state specific to a particular coherence protocol. */ 1132641Sstever@eecs.umich.edu class CoherenceState { 1142641Sstever@eecs.umich.edu public: 1152641Sstever@eecs.umich.edu virtual ~CoherenceState() {} 1162641Sstever@eecs.umich.edu }; 1172641Sstever@eecs.umich.edu 1182662Sstever@eecs.umich.edu /** This packet's coherence state. Caches should use 1192662Sstever@eecs.umich.edu * dynamic_cast<> to cast to the state appropriate for the 1202662Sstever@eecs.umich.edu * system's coherence protocol. */ 1212662Sstever@eecs.umich.edu CoherenceState *coherence; 1222641Sstever@eecs.umich.edu 1232662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold state associated 1242662Sstever@eecs.umich.edu * with the packet but specific to the sending device (e.g., an 1252662Sstever@eecs.umich.edu * MSHR). A pointer to this state is returned in the packet's 1262662Sstever@eecs.umich.edu * response so that the sender can quickly look up the state 1272662Sstever@eecs.umich.edu * needed to process it. A specific subclass would be derived 1282662Sstever@eecs.umich.edu * from this to carry state specific to a particular sending 1292662Sstever@eecs.umich.edu * device. */ 1302641Sstever@eecs.umich.edu class SenderState { 1312641Sstever@eecs.umich.edu public: 1322641Sstever@eecs.umich.edu virtual ~SenderState() {} 1332641Sstever@eecs.umich.edu }; 1342641Sstever@eecs.umich.edu 1352662Sstever@eecs.umich.edu /** This packet's sender state. Devices should use dynamic_cast<> 1362662Sstever@eecs.umich.edu * to cast to the state appropriate to the sender. */ 1372662Sstever@eecs.umich.edu SenderState *senderState; 1382641Sstever@eecs.umich.edu 1392641Sstever@eecs.umich.edu private: 1402641Sstever@eecs.umich.edu /** List of command attributes. */ 1412641Sstever@eecs.umich.edu enum CommandAttribute 1422641Sstever@eecs.umich.edu { 1432641Sstever@eecs.umich.edu IsRead = 1 << 0, 1442641Sstever@eecs.umich.edu IsWrite = 1 << 1, 1452641Sstever@eecs.umich.edu IsPrefetch = 1 << 2, 1462641Sstever@eecs.umich.edu IsInvalidate = 1 << 3, 1472641Sstever@eecs.umich.edu IsRequest = 1 << 4, 1482641Sstever@eecs.umich.edu IsResponse = 1 << 5, 1492641Sstever@eecs.umich.edu NeedsResponse = 1 << 6, 1502641Sstever@eecs.umich.edu }; 1512641Sstever@eecs.umich.edu 1522641Sstever@eecs.umich.edu public: 1532641Sstever@eecs.umich.edu /** List of all commands associated with a packet. */ 1542641Sstever@eecs.umich.edu enum Command 1552641Sstever@eecs.umich.edu { 1562641Sstever@eecs.umich.edu ReadReq = IsRead | IsRequest | NeedsResponse, 1572641Sstever@eecs.umich.edu WriteReq = IsWrite | IsRequest | NeedsResponse, 1582641Sstever@eecs.umich.edu WriteReqNoAck = IsWrite | IsRequest, 1592641Sstever@eecs.umich.edu ReadResp = IsRead | IsResponse, 1602641Sstever@eecs.umich.edu WriteResp = IsWrite | IsResponse 1612641Sstever@eecs.umich.edu }; 1622641Sstever@eecs.umich.edu 1632662Sstever@eecs.umich.edu /** Return the string name of the cmd field (for debugging and 1642662Sstever@eecs.umich.edu * tracing). */ 1652641Sstever@eecs.umich.edu const std::string &cmdString() const; 1662381SN/A 1672662Sstever@eecs.umich.edu /** The command field of the packet. */ 1682381SN/A Command cmd; 1692381SN/A 1702641Sstever@eecs.umich.edu bool isRead() { return (cmd & IsRead) != 0; } 1712641Sstever@eecs.umich.edu bool isRequest() { return (cmd & IsRequest) != 0; } 1722641Sstever@eecs.umich.edu bool isResponse() { return (cmd & IsResponse) != 0; } 1732641Sstever@eecs.umich.edu bool needsResponse() { return (cmd & NeedsResponse) != 0; } 1742641Sstever@eecs.umich.edu 1752662Sstever@eecs.umich.edu /** Possible results of a packet's request. */ 1762641Sstever@eecs.umich.edu enum Result 1772641Sstever@eecs.umich.edu { 1782641Sstever@eecs.umich.edu Success, 1792641Sstever@eecs.umich.edu BadAddress, 1802641Sstever@eecs.umich.edu Unknown 1812641Sstever@eecs.umich.edu }; 1822641Sstever@eecs.umich.edu 1832662Sstever@eecs.umich.edu /** The result of this packet's request. */ 1842641Sstever@eecs.umich.edu Result result; 1852381SN/A 1862381SN/A /** Accessor function that returns the source index of the packet. */ 1872641Sstever@eecs.umich.edu short getSrc() const { assert(srcValid); return src; } 1882641Sstever@eecs.umich.edu void setSrc(short _src) { src = _src; srcValid = true; } 1892381SN/A 1902381SN/A /** Accessor function that returns the destination index of 1912381SN/A the packet. */ 1922381SN/A short getDest() const { return dest; } 1932641Sstever@eecs.umich.edu void setDest(short _dest) { dest = _dest; } 1942549SN/A 1952641Sstever@eecs.umich.edu Addr getAddr() const { assert(addrValid); return addr; } 1962641Sstever@eecs.umich.edu void setAddr(Addr _addr) { addr = _addr; addrValid = true; } 1972641Sstever@eecs.umich.edu 1982641Sstever@eecs.umich.edu int getSize() const { assert(sizeValid); return size; } 1992641Sstever@eecs.umich.edu void setSize(int _size) { size = _size; sizeValid = true; } 2002641Sstever@eecs.umich.edu 2012662Sstever@eecs.umich.edu /** Constructor. Note that a Request object must be constructed 2022662Sstever@eecs.umich.edu * first, but the Requests's physical address and size fields 2032662Sstever@eecs.umich.edu * need not be valid. The command and destination addresses 2042662Sstever@eecs.umich.edu * must be supplied. */ 2052641Sstever@eecs.umich.edu Packet(Request *_req, Command _cmd, short _dest) 2062566SN/A : data(NULL), staticData(false), dynamicData(false), arrayData(false), 2072641Sstever@eecs.umich.edu addr(_req->paddr), size(_req->size), dest(_dest), 2082641Sstever@eecs.umich.edu addrValid(_req->validPaddr), sizeValid(_req->validSize), 2092641Sstever@eecs.umich.edu srcValid(false), 2102641Sstever@eecs.umich.edu req(_req), coherence(NULL), senderState(NULL), cmd(_cmd), 2112662Sstever@eecs.umich.edu result(Unknown) 2122641Sstever@eecs.umich.edu { 2132641Sstever@eecs.umich.edu } 2142549SN/A 2152662Sstever@eecs.umich.edu /** Destructor. */ 2162566SN/A ~Packet() 2172566SN/A { deleteData(); } 2182566SN/A 2192662Sstever@eecs.umich.edu /** Reinitialize packet address and size from the associated 2202662Sstever@eecs.umich.edu * Request object, and reset other fields that may have been 2212662Sstever@eecs.umich.edu * modified by a previous transaction. Typically called when a 2222662Sstever@eecs.umich.edu * statically allocated Request/Packet pair is reused for 2232662Sstever@eecs.umich.edu * multiple transactions. */ 2242662Sstever@eecs.umich.edu void reinitFromRequest() { 2252662Sstever@eecs.umich.edu assert(req->validPaddr); 2262662Sstever@eecs.umich.edu setAddr(req->paddr); 2272662Sstever@eecs.umich.edu assert(req->validSize); 2282662Sstever@eecs.umich.edu setSize(req->size); 2292662Sstever@eecs.umich.edu result = Unknown; 2302662Sstever@eecs.umich.edu if (dynamicData) { 2312662Sstever@eecs.umich.edu deleteData(); 2322662Sstever@eecs.umich.edu dynamicData = false; 2332662Sstever@eecs.umich.edu arrayData = false; 2342662Sstever@eecs.umich.edu } 2352662Sstever@eecs.umich.edu } 2362566SN/A 2372662Sstever@eecs.umich.edu /** Take a request packet and modify it in place to be suitable 2382662Sstever@eecs.umich.edu * for returning as a response to that request. Used for timing 2392662Sstever@eecs.umich.edu * accesses only. For atomic and functional accesses, the 2402662Sstever@eecs.umich.edu * request packet is always implicitly passed back *without* 2412662Sstever@eecs.umich.edu * modifying the command or destination fields, so this function 2422662Sstever@eecs.umich.edu * should not be called. */ 2432662Sstever@eecs.umich.edu void makeTimingResponse() { 2442662Sstever@eecs.umich.edu assert(needsResponse()); 2452662Sstever@eecs.umich.edu int icmd = (int)cmd; 2462662Sstever@eecs.umich.edu icmd &= ~(IsRequest | NeedsResponse); 2472662Sstever@eecs.umich.edu icmd |= IsResponse; 2482662Sstever@eecs.umich.edu cmd = (Command)icmd; 2492662Sstever@eecs.umich.edu dest = src; 2502662Sstever@eecs.umich.edu srcValid = false; 2512641Sstever@eecs.umich.edu } 2522641Sstever@eecs.umich.edu 2532566SN/A /** Set the data pointer to the following value that should not be freed. */ 2542566SN/A template <typename T> 2552592SN/A void dataStatic(T *p); 2562566SN/A 2572566SN/A /** Set the data pointer to a value that should have delete [] called on it. 2582566SN/A */ 2592566SN/A template <typename T> 2602592SN/A void dataDynamicArray(T *p); 2612566SN/A 2622566SN/A /** set the data pointer to a value that should have delete called on it. */ 2632566SN/A template <typename T> 2642592SN/A void dataDynamic(T *p); 2652566SN/A 2662566SN/A /** return the value of what is pointed to in the packet. */ 2672566SN/A template <typename T> 2682592SN/A T get(); 2692566SN/A 2702566SN/A /** get a pointer to the data ptr. */ 2712566SN/A template <typename T> 2722592SN/A T* getPtr(); 2732566SN/A 2742566SN/A /** set the value in the data pointer to v. */ 2752566SN/A template <typename T> 2762592SN/A void set(T v); 2772566SN/A 2782566SN/A /** delete the data pointed to in the data pointer. Ok to call to matter how 2792566SN/A * data was allocted. */ 2802592SN/A void deleteData(); 2812566SN/A 2822566SN/A /** If there isn't data in the packet, allocate some. */ 2832592SN/A void allocate(); 2842568SN/A 2852568SN/A /** Do the packet modify the same addresses. */ 2862592SN/A bool intersect(Packet *p); 2872381SN/A}; 2882381SN/A 2892630SN/Abool fixPacket(Packet *func, Packet *timing); 2902381SN/A#endif //__MEM_PACKET_HH 291