packet.hh revision 2665
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 412392SN/A#include "mem/request.hh" 422423SN/A#include "arch/isa_traits.hh" 432394SN/A#include "sim/root.hh" 442394SN/A 452394SN/Astruct Packet; 462394SN/Atypedef Packet* PacketPtr; 472394SN/Atypedef uint8_t* PacketDataPtr; 482382SN/A 492381SN/A/** 502662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 512662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 522662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 532662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 542662Sstever@eecs.umich.edu * different Packets along the way.) 552381SN/A */ 562641Sstever@eecs.umich.educlass Packet 572381SN/A{ 582566SN/A private: 592662Sstever@eecs.umich.edu /** A pointer to the data being transfered. It can be differnt 602662Sstever@eecs.umich.edu * sizes at each level of the heirarchy so it belongs in the 612662Sstever@eecs.umich.edu * packet, not request. This may or may not be populated when a 622662Sstever@eecs.umich.edu * responder recieves the packet. If not populated it memory 632662Sstever@eecs.umich.edu * should be allocated. 642566SN/A */ 652566SN/A PacketDataPtr data; 662566SN/A 672662Sstever@eecs.umich.edu /** Is the data pointer set to a value that shouldn't be freed 682662Sstever@eecs.umich.edu * when the packet is destroyed? */ 692566SN/A bool staticData; 702662Sstever@eecs.umich.edu /** The data pointer points to a value that should be freed when 712662Sstever@eecs.umich.edu * the packet is destroyed. */ 722566SN/A bool dynamicData; 732662Sstever@eecs.umich.edu /** the data pointer points to an array (thus delete [] ) needs to 742662Sstever@eecs.umich.edu * be called on it rather than simply delete.*/ 752566SN/A bool arrayData; 762566SN/A 772566SN/A 782662Sstever@eecs.umich.edu /** The address of the request. This address could be virtual or 792662Sstever@eecs.umich.edu * physical, depending on the system configuration. */ 802381SN/A Addr addr; 812381SN/A 822662Sstever@eecs.umich.edu /** The size of the request or transfer. */ 832381SN/A int size; 842381SN/A 852662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the source of the 862662Sstever@eecs.umich.edu * transaction. The source is not responsible for setting this 872662Sstever@eecs.umich.edu * field; it is set implicitly by the interconnect when the 882662Sstever@eecs.umich.edu * packet * is first sent. */ 892381SN/A short src; 902381SN/A 912662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the destination of the 922662Sstever@eecs.umich.edu * transaction. The special value Broadcast indicates that the 932662Sstever@eecs.umich.edu * packet should be routed based on its address. This field is 942662Sstever@eecs.umich.edu * initialized in the constructor and is thus always valid 952662Sstever@eecs.umich.edu * (unlike * addr, size, and src). */ 962641Sstever@eecs.umich.edu short dest; 972641Sstever@eecs.umich.edu 982663Sstever@eecs.umich.edu /** Are the 'addr' and 'size' fields valid? */ 992663Sstever@eecs.umich.edu bool addrSizeValid; 1002662Sstever@eecs.umich.edu /** Is the 'src' field valid? */ 1012641Sstever@eecs.umich.edu bool srcValid; 1022641Sstever@eecs.umich.edu 1032641Sstever@eecs.umich.edu public: 1042641Sstever@eecs.umich.edu 1052662Sstever@eecs.umich.edu /** The special destination address indicating that the packet 1062662Sstever@eecs.umich.edu * should be routed based on its address. */ 1072623SN/A static const short Broadcast = -1; 1082623SN/A 1092662Sstever@eecs.umich.edu /** A pointer to the original request. */ 1102641Sstever@eecs.umich.edu RequestPtr req; 1112641Sstever@eecs.umich.edu 1122662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold coherence-related 1132662Sstever@eecs.umich.edu * state. A specific subclass would be derived from this to 1142662Sstever@eecs.umich.edu * carry state specific to a particular coherence protocol. */ 1152641Sstever@eecs.umich.edu class CoherenceState { 1162641Sstever@eecs.umich.edu public: 1172641Sstever@eecs.umich.edu virtual ~CoherenceState() {} 1182641Sstever@eecs.umich.edu }; 1192641Sstever@eecs.umich.edu 1202662Sstever@eecs.umich.edu /** This packet's coherence state. Caches should use 1212662Sstever@eecs.umich.edu * dynamic_cast<> to cast to the state appropriate for the 1222662Sstever@eecs.umich.edu * system's coherence protocol. */ 1232662Sstever@eecs.umich.edu CoherenceState *coherence; 1242641Sstever@eecs.umich.edu 1252662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold state associated 1262662Sstever@eecs.umich.edu * with the packet but specific to the sending device (e.g., an 1272662Sstever@eecs.umich.edu * MSHR). A pointer to this state is returned in the packet's 1282662Sstever@eecs.umich.edu * response so that the sender can quickly look up the state 1292662Sstever@eecs.umich.edu * needed to process it. A specific subclass would be derived 1302662Sstever@eecs.umich.edu * from this to carry state specific to a particular sending 1312662Sstever@eecs.umich.edu * device. */ 1322641Sstever@eecs.umich.edu class SenderState { 1332641Sstever@eecs.umich.edu public: 1342641Sstever@eecs.umich.edu virtual ~SenderState() {} 1352641Sstever@eecs.umich.edu }; 1362641Sstever@eecs.umich.edu 1372662Sstever@eecs.umich.edu /** This packet's sender state. Devices should use dynamic_cast<> 1382662Sstever@eecs.umich.edu * to cast to the state appropriate to the sender. */ 1392662Sstever@eecs.umich.edu SenderState *senderState; 1402641Sstever@eecs.umich.edu 1412641Sstever@eecs.umich.edu private: 1422641Sstever@eecs.umich.edu /** List of command attributes. */ 1432641Sstever@eecs.umich.edu enum CommandAttribute 1442641Sstever@eecs.umich.edu { 1452641Sstever@eecs.umich.edu IsRead = 1 << 0, 1462641Sstever@eecs.umich.edu IsWrite = 1 << 1, 1472641Sstever@eecs.umich.edu IsPrefetch = 1 << 2, 1482641Sstever@eecs.umich.edu IsInvalidate = 1 << 3, 1492641Sstever@eecs.umich.edu IsRequest = 1 << 4, 1502641Sstever@eecs.umich.edu IsResponse = 1 << 5, 1512641Sstever@eecs.umich.edu NeedsResponse = 1 << 6, 1522641Sstever@eecs.umich.edu }; 1532641Sstever@eecs.umich.edu 1542641Sstever@eecs.umich.edu public: 1552641Sstever@eecs.umich.edu /** List of all commands associated with a packet. */ 1562641Sstever@eecs.umich.edu enum Command 1572641Sstever@eecs.umich.edu { 1582641Sstever@eecs.umich.edu ReadReq = IsRead | IsRequest | NeedsResponse, 1592641Sstever@eecs.umich.edu WriteReq = IsWrite | IsRequest | NeedsResponse, 1602641Sstever@eecs.umich.edu WriteReqNoAck = IsWrite | IsRequest, 1612641Sstever@eecs.umich.edu ReadResp = IsRead | IsResponse, 1622641Sstever@eecs.umich.edu WriteResp = IsWrite | IsResponse 1632641Sstever@eecs.umich.edu }; 1642641Sstever@eecs.umich.edu 1652662Sstever@eecs.umich.edu /** Return the string name of the cmd field (for debugging and 1662662Sstever@eecs.umich.edu * tracing). */ 1672641Sstever@eecs.umich.edu const std::string &cmdString() const; 1682381SN/A 1692662Sstever@eecs.umich.edu /** The command field of the packet. */ 1702381SN/A Command cmd; 1712381SN/A 1722641Sstever@eecs.umich.edu bool isRead() { return (cmd & IsRead) != 0; } 1732641Sstever@eecs.umich.edu bool isRequest() { return (cmd & IsRequest) != 0; } 1742641Sstever@eecs.umich.edu bool isResponse() { return (cmd & IsResponse) != 0; } 1752641Sstever@eecs.umich.edu bool needsResponse() { return (cmd & NeedsResponse) != 0; } 1762641Sstever@eecs.umich.edu 1772662Sstever@eecs.umich.edu /** Possible results of a packet's request. */ 1782641Sstever@eecs.umich.edu enum Result 1792641Sstever@eecs.umich.edu { 1802641Sstever@eecs.umich.edu Success, 1812641Sstever@eecs.umich.edu BadAddress, 1822641Sstever@eecs.umich.edu Unknown 1832641Sstever@eecs.umich.edu }; 1842641Sstever@eecs.umich.edu 1852662Sstever@eecs.umich.edu /** The result of this packet's request. */ 1862641Sstever@eecs.umich.edu Result result; 1872381SN/A 1882381SN/A /** Accessor function that returns the source index of the packet. */ 1892641Sstever@eecs.umich.edu short getSrc() const { assert(srcValid); return src; } 1902641Sstever@eecs.umich.edu void setSrc(short _src) { src = _src; srcValid = true; } 1912381SN/A 1922381SN/A /** Accessor function that returns the destination index of 1932381SN/A the packet. */ 1942381SN/A short getDest() const { return dest; } 1952641Sstever@eecs.umich.edu void setDest(short _dest) { dest = _dest; } 1962549SN/A 1972663Sstever@eecs.umich.edu Addr getAddr() const { assert(addrSizeValid); return addr; } 1982663Sstever@eecs.umich.edu int getSize() const { assert(addrSizeValid); return size; } 1992641Sstever@eecs.umich.edu 2002662Sstever@eecs.umich.edu /** Constructor. Note that a Request object must be constructed 2012662Sstever@eecs.umich.edu * first, but the Requests's physical address and size fields 2022662Sstever@eecs.umich.edu * need not be valid. The command and destination addresses 2032662Sstever@eecs.umich.edu * must be supplied. */ 2042641Sstever@eecs.umich.edu Packet(Request *_req, Command _cmd, short _dest) 2052566SN/A : data(NULL), staticData(false), dynamicData(false), arrayData(false), 2062641Sstever@eecs.umich.edu addr(_req->paddr), size(_req->size), dest(_dest), 2072663Sstever@eecs.umich.edu addrSizeValid(_req->validPaddr), 2082641Sstever@eecs.umich.edu srcValid(false), 2092641Sstever@eecs.umich.edu req(_req), coherence(NULL), senderState(NULL), cmd(_cmd), 2102662Sstever@eecs.umich.edu result(Unknown) 2112641Sstever@eecs.umich.edu { 2122641Sstever@eecs.umich.edu } 2132549SN/A 2142662Sstever@eecs.umich.edu /** Destructor. */ 2152566SN/A ~Packet() 2162566SN/A { deleteData(); } 2172566SN/A 2182662Sstever@eecs.umich.edu /** Reinitialize packet address and size from the associated 2192662Sstever@eecs.umich.edu * Request object, and reset other fields that may have been 2202662Sstever@eecs.umich.edu * modified by a previous transaction. Typically called when a 2212662Sstever@eecs.umich.edu * statically allocated Request/Packet pair is reused for 2222662Sstever@eecs.umich.edu * multiple transactions. */ 2232662Sstever@eecs.umich.edu void reinitFromRequest() { 2242662Sstever@eecs.umich.edu assert(req->validPaddr); 2252663Sstever@eecs.umich.edu addr = req->paddr; 2262663Sstever@eecs.umich.edu size = req->size; 2272663Sstever@eecs.umich.edu addrSizeValid = true; 2282662Sstever@eecs.umich.edu result = Unknown; 2292662Sstever@eecs.umich.edu if (dynamicData) { 2302662Sstever@eecs.umich.edu deleteData(); 2312662Sstever@eecs.umich.edu dynamicData = false; 2322662Sstever@eecs.umich.edu arrayData = false; 2332662Sstever@eecs.umich.edu } 2342662Sstever@eecs.umich.edu } 2352566SN/A 2362662Sstever@eecs.umich.edu /** Take a request packet and modify it in place to be suitable 2372662Sstever@eecs.umich.edu * for returning as a response to that request. Used for timing 2382662Sstever@eecs.umich.edu * accesses only. For atomic and functional accesses, the 2392662Sstever@eecs.umich.edu * request packet is always implicitly passed back *without* 2402662Sstever@eecs.umich.edu * modifying the command or destination fields, so this function 2412662Sstever@eecs.umich.edu * should not be called. */ 2422662Sstever@eecs.umich.edu void makeTimingResponse() { 2432662Sstever@eecs.umich.edu assert(needsResponse()); 2442662Sstever@eecs.umich.edu int icmd = (int)cmd; 2452662Sstever@eecs.umich.edu icmd &= ~(IsRequest | NeedsResponse); 2462662Sstever@eecs.umich.edu icmd |= IsResponse; 2472662Sstever@eecs.umich.edu cmd = (Command)icmd; 2482662Sstever@eecs.umich.edu dest = src; 2492662Sstever@eecs.umich.edu srcValid = false; 2502641Sstever@eecs.umich.edu } 2512641Sstever@eecs.umich.edu 2522566SN/A /** Set the data pointer to the following value that should not be freed. */ 2532566SN/A template <typename T> 2542592SN/A void dataStatic(T *p); 2552566SN/A 2562566SN/A /** Set the data pointer to a value that should have delete [] called on it. 2572566SN/A */ 2582566SN/A template <typename T> 2592592SN/A void dataDynamicArray(T *p); 2602566SN/A 2612566SN/A /** set the data pointer to a value that should have delete called on it. */ 2622566SN/A template <typename T> 2632592SN/A void dataDynamic(T *p); 2642566SN/A 2652566SN/A /** return the value of what is pointed to in the packet. */ 2662566SN/A template <typename T> 2672592SN/A T get(); 2682566SN/A 2692566SN/A /** get a pointer to the data ptr. */ 2702566SN/A template <typename T> 2712592SN/A T* getPtr(); 2722566SN/A 2732566SN/A /** set the value in the data pointer to v. */ 2742566SN/A template <typename T> 2752592SN/A void set(T v); 2762566SN/A 2772566SN/A /** delete the data pointed to in the data pointer. Ok to call to matter how 2782566SN/A * data was allocted. */ 2792592SN/A void deleteData(); 2802566SN/A 2812566SN/A /** If there isn't data in the packet, allocate some. */ 2822592SN/A void allocate(); 2832568SN/A 2842568SN/A /** Do the packet modify the same addresses. */ 2852592SN/A bool intersect(Packet *p); 2862381SN/A}; 2872381SN/A 2882630SN/Abool fixPacket(Packet *func, Packet *timing); 2892381SN/A#endif //__MEM_PACKET_HH 290