packet.hh revision 2883
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" 442812Srdreslin@umich.edu#include <list> 452394SN/A 462394SN/Astruct Packet; 472394SN/Atypedef Packet* PacketPtr; 482394SN/Atypedef uint8_t* PacketDataPtr; 492812Srdreslin@umich.edutypedef std::list<PacketPtr> PacketList; 502812Srdreslin@umich.edu 512812Srdreslin@umich.edu//Coherence Flags 522812Srdreslin@umich.edu#define NACKED_LINE 1 << 0 532812Srdreslin@umich.edu#define SATISFIED 1 << 1 542812Srdreslin@umich.edu#define SHARED_LINE 1 << 2 552813Srdreslin@umich.edu#define CACHE_LINE_FILL 1 << 3 562813Srdreslin@umich.edu#define COMPRESSED 1 << 4 572813Srdreslin@umich.edu#define NO_ALLOCATE 1 << 5 582382SN/A 592811Srdreslin@umich.edu//For statistics we need max number of commands, hard code it at 602811Srdreslin@umich.edu//20 for now. @todo fix later 612811Srdreslin@umich.edu#define NUM_MEM_CMDS 1 << 9 622811Srdreslin@umich.edu 632381SN/A/** 642662Sstever@eecs.umich.edu * A Packet is used to encapsulate a transfer between two objects in 652662Sstever@eecs.umich.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 662662Sstever@eecs.umich.edu * single Request travels all the way from the requester to the 672662Sstever@eecs.umich.edu * ultimate destination and back, possibly being conveyed by several 682662Sstever@eecs.umich.edu * different Packets along the way.) 692381SN/A */ 702641Sstever@eecs.umich.educlass Packet 712381SN/A{ 722813Srdreslin@umich.edu public: 732813Srdreslin@umich.edu /** Temporary FLAGS field until cache gets working, this should be in coherence/sender state. */ 742813Srdreslin@umich.edu uint64_t flags; 752813Srdreslin@umich.edu 762566SN/A private: 772662Sstever@eecs.umich.edu /** A pointer to the data being transfered. It can be differnt 782662Sstever@eecs.umich.edu * sizes at each level of the heirarchy so it belongs in the 792662Sstever@eecs.umich.edu * packet, not request. This may or may not be populated when a 802662Sstever@eecs.umich.edu * responder recieves the packet. If not populated it memory 812662Sstever@eecs.umich.edu * should be allocated. 822566SN/A */ 832566SN/A PacketDataPtr data; 842566SN/A 852662Sstever@eecs.umich.edu /** Is the data pointer set to a value that shouldn't be freed 862662Sstever@eecs.umich.edu * when the packet is destroyed? */ 872566SN/A bool staticData; 882662Sstever@eecs.umich.edu /** The data pointer points to a value that should be freed when 892662Sstever@eecs.umich.edu * the packet is destroyed. */ 902566SN/A bool dynamicData; 912662Sstever@eecs.umich.edu /** the data pointer points to an array (thus delete [] ) needs to 922662Sstever@eecs.umich.edu * be called on it rather than simply delete.*/ 932566SN/A bool arrayData; 942566SN/A 952566SN/A 962662Sstever@eecs.umich.edu /** The address of the request. This address could be virtual or 972662Sstever@eecs.umich.edu * physical, depending on the system configuration. */ 982381SN/A Addr addr; 992381SN/A 1002662Sstever@eecs.umich.edu /** The size of the request or transfer. */ 1012381SN/A int size; 1022381SN/A 1032662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the source of the 1042662Sstever@eecs.umich.edu * transaction. The source is not responsible for setting this 1052662Sstever@eecs.umich.edu * field; it is set implicitly by the interconnect when the 1062662Sstever@eecs.umich.edu * packet * is first sent. */ 1072381SN/A short src; 1082381SN/A 1092662Sstever@eecs.umich.edu /** Device address (e.g., bus ID) of the destination of the 1102662Sstever@eecs.umich.edu * transaction. The special value Broadcast indicates that the 1112662Sstever@eecs.umich.edu * packet should be routed based on its address. This field is 1122662Sstever@eecs.umich.edu * initialized in the constructor and is thus always valid 1132662Sstever@eecs.umich.edu * (unlike * addr, size, and src). */ 1142641Sstever@eecs.umich.edu short dest; 1152641Sstever@eecs.umich.edu 1162663Sstever@eecs.umich.edu /** Are the 'addr' and 'size' fields valid? */ 1172663Sstever@eecs.umich.edu bool addrSizeValid; 1182662Sstever@eecs.umich.edu /** Is the 'src' field valid? */ 1192641Sstever@eecs.umich.edu bool srcValid; 1202813Srdreslin@umich.edu 1212641Sstever@eecs.umich.edu 1222641Sstever@eecs.umich.edu public: 1232641Sstever@eecs.umich.edu 1242811Srdreslin@umich.edu /** Used to calculate latencies for each packet.*/ 1252811Srdreslin@umich.edu Tick time; 1262811Srdreslin@umich.edu 1272662Sstever@eecs.umich.edu /** The special destination address indicating that the packet 1282662Sstever@eecs.umich.edu * should be routed based on its address. */ 1292623SN/A static const short Broadcast = -1; 1302623SN/A 1312662Sstever@eecs.umich.edu /** A pointer to the original request. */ 1322641Sstever@eecs.umich.edu RequestPtr req; 1332641Sstever@eecs.umich.edu 1342662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold coherence-related 1352662Sstever@eecs.umich.edu * state. A specific subclass would be derived from this to 1362662Sstever@eecs.umich.edu * carry state specific to a particular coherence protocol. */ 1372641Sstever@eecs.umich.edu class CoherenceState { 1382641Sstever@eecs.umich.edu public: 1392641Sstever@eecs.umich.edu virtual ~CoherenceState() {} 1402641Sstever@eecs.umich.edu }; 1412641Sstever@eecs.umich.edu 1422662Sstever@eecs.umich.edu /** This packet's coherence state. Caches should use 1432662Sstever@eecs.umich.edu * dynamic_cast<> to cast to the state appropriate for the 1442662Sstever@eecs.umich.edu * system's coherence protocol. */ 1452662Sstever@eecs.umich.edu CoherenceState *coherence; 1462641Sstever@eecs.umich.edu 1472662Sstever@eecs.umich.edu /** A virtual base opaque structure used to hold state associated 1482662Sstever@eecs.umich.edu * with the packet but specific to the sending device (e.g., an 1492662Sstever@eecs.umich.edu * MSHR). A pointer to this state is returned in the packet's 1502662Sstever@eecs.umich.edu * response so that the sender can quickly look up the state 1512662Sstever@eecs.umich.edu * needed to process it. A specific subclass would be derived 1522662Sstever@eecs.umich.edu * from this to carry state specific to a particular sending 1532662Sstever@eecs.umich.edu * device. */ 1542641Sstever@eecs.umich.edu class SenderState { 1552641Sstever@eecs.umich.edu public: 1562641Sstever@eecs.umich.edu virtual ~SenderState() {} 1572641Sstever@eecs.umich.edu }; 1582641Sstever@eecs.umich.edu 1592662Sstever@eecs.umich.edu /** This packet's sender state. Devices should use dynamic_cast<> 1602662Sstever@eecs.umich.edu * to cast to the state appropriate to the sender. */ 1612662Sstever@eecs.umich.edu SenderState *senderState; 1622641Sstever@eecs.umich.edu 1632641Sstever@eecs.umich.edu private: 1642641Sstever@eecs.umich.edu /** List of command attributes. */ 1652641Sstever@eecs.umich.edu enum CommandAttribute 1662641Sstever@eecs.umich.edu { 1672641Sstever@eecs.umich.edu IsRead = 1 << 0, 1682641Sstever@eecs.umich.edu IsWrite = 1 << 1, 1692641Sstever@eecs.umich.edu IsPrefetch = 1 << 2, 1702641Sstever@eecs.umich.edu IsInvalidate = 1 << 3, 1712641Sstever@eecs.umich.edu IsRequest = 1 << 4, 1722641Sstever@eecs.umich.edu IsResponse = 1 << 5, 1732641Sstever@eecs.umich.edu NeedsResponse = 1 << 6, 1742811Srdreslin@umich.edu IsSWPrefetch = 1 << 7, 1752811Srdreslin@umich.edu IsHWPrefetch = 1 << 8 1762641Sstever@eecs.umich.edu }; 1772641Sstever@eecs.umich.edu 1782641Sstever@eecs.umich.edu public: 1792641Sstever@eecs.umich.edu /** List of all commands associated with a packet. */ 1802641Sstever@eecs.umich.edu enum Command 1812641Sstever@eecs.umich.edu { 1822813Srdreslin@umich.edu InvalidCmd = 0, 1832641Sstever@eecs.umich.edu ReadReq = IsRead | IsRequest | NeedsResponse, 1842641Sstever@eecs.umich.edu WriteReq = IsWrite | IsRequest | NeedsResponse, 1852641Sstever@eecs.umich.edu WriteReqNoAck = IsWrite | IsRequest, 1862855Srdreslin@umich.edu ReadResp = IsRead | IsResponse | NeedsResponse, 1872855Srdreslin@umich.edu WriteResp = IsWrite | IsResponse | NeedsResponse, 1882811Srdreslin@umich.edu Writeback = IsWrite | IsRequest, 1892811Srdreslin@umich.edu SoftPFReq = IsRead | IsRequest | IsSWPrefetch | NeedsResponse, 1902811Srdreslin@umich.edu HardPFReq = IsRead | IsRequest | IsHWPrefetch | NeedsResponse, 1912855Srdreslin@umich.edu SoftPFResp = IsRead | IsResponse | IsSWPrefetch | NeedsResponse, 1922855Srdreslin@umich.edu HardPFResp = IsRead | IsResponse | IsHWPrefetch | NeedsResponse, 1932812Srdreslin@umich.edu InvalidateReq = IsInvalidate | IsRequest, 1942812Srdreslin@umich.edu WriteInvalidateReq = IsWrite | IsInvalidate | IsRequest, 1952855Srdreslin@umich.edu UpgradeReq = IsInvalidate | IsRequest | NeedsResponse, 1962855Srdreslin@umich.edu UpgradeResp = IsInvalidate | IsResponse | NeedsResponse, 1972855Srdreslin@umich.edu ReadExReq = IsRead | IsInvalidate | IsRequest | NeedsResponse, 1982855Srdreslin@umich.edu ReadExResp = IsRead | IsInvalidate | IsResponse | NeedsResponse 1992641Sstever@eecs.umich.edu }; 2002641Sstever@eecs.umich.edu 2012662Sstever@eecs.umich.edu /** Return the string name of the cmd field (for debugging and 2022662Sstever@eecs.umich.edu * tracing). */ 2032641Sstever@eecs.umich.edu const std::string &cmdString() const; 2042381SN/A 2052811Srdreslin@umich.edu /** Reutrn the string to a cmd given by idx. */ 2062811Srdreslin@umich.edu const std::string &cmdIdxToString(Command idx); 2072811Srdreslin@umich.edu 2082811Srdreslin@umich.edu /** Return the index of this command. */ 2092811Srdreslin@umich.edu inline int cmdToIndex() const { return (int) cmd; } 2102811Srdreslin@umich.edu 2112662Sstever@eecs.umich.edu /** The command field of the packet. */ 2122381SN/A Command cmd; 2132381SN/A 2142641Sstever@eecs.umich.edu bool isRead() { return (cmd & IsRead) != 0; } 2152812Srdreslin@umich.edu bool isWrite() { return (cmd & IsWrite) != 0; } 2162641Sstever@eecs.umich.edu bool isRequest() { return (cmd & IsRequest) != 0; } 2172641Sstever@eecs.umich.edu bool isResponse() { return (cmd & IsResponse) != 0; } 2182641Sstever@eecs.umich.edu bool needsResponse() { return (cmd & NeedsResponse) != 0; } 2192812Srdreslin@umich.edu bool isInvalidate() { return (cmd * IsInvalidate) != 0; } 2202812Srdreslin@umich.edu 2212813Srdreslin@umich.edu bool isCacheFill() { return (flags & CACHE_LINE_FILL) != 0; } 2222813Srdreslin@umich.edu bool isNoAllocate() { return (flags & NO_ALLOCATE) != 0; } 2232814Srdreslin@umich.edu bool isCompressed() { return (flags & COMPRESSED) != 0; } 2242814Srdreslin@umich.edu 2252814Srdreslin@umich.edu bool nic_pkt() { assert("Unimplemented\n" && 0); } 2262641Sstever@eecs.umich.edu 2272662Sstever@eecs.umich.edu /** Possible results of a packet's request. */ 2282641Sstever@eecs.umich.edu enum Result 2292641Sstever@eecs.umich.edu { 2302641Sstever@eecs.umich.edu Success, 2312641Sstever@eecs.umich.edu BadAddress, 2322685Ssaidi@eecs.umich.edu Nacked, 2332641Sstever@eecs.umich.edu Unknown 2342641Sstever@eecs.umich.edu }; 2352641Sstever@eecs.umich.edu 2362662Sstever@eecs.umich.edu /** The result of this packet's request. */ 2372641Sstever@eecs.umich.edu Result result; 2382381SN/A 2392381SN/A /** Accessor function that returns the source index of the packet. */ 2402641Sstever@eecs.umich.edu short getSrc() const { assert(srcValid); return src; } 2412641Sstever@eecs.umich.edu void setSrc(short _src) { src = _src; srcValid = true; } 2422381SN/A 2432381SN/A /** Accessor function that returns the destination index of 2442381SN/A the packet. */ 2452381SN/A short getDest() const { return dest; } 2462641Sstever@eecs.umich.edu void setDest(short _dest) { dest = _dest; } 2472549SN/A 2482663Sstever@eecs.umich.edu Addr getAddr() const { assert(addrSizeValid); return addr; } 2492663Sstever@eecs.umich.edu int getSize() const { assert(addrSizeValid); return size; } 2502883Srdreslin@umich.edu Addr getOffset(int blkSize) const { return addr & (Addr)(blkSize - 1); } 2512813Srdreslin@umich.edu 2522813Srdreslin@umich.edu void addrOverride(Addr newAddr) { assert(addrSizeValid); addr = newAddr; } 2532813Srdreslin@umich.edu void cmdOverride(Command newCmd) { cmd = newCmd; } 2542641Sstever@eecs.umich.edu 2552662Sstever@eecs.umich.edu /** Constructor. Note that a Request object must be constructed 2562662Sstever@eecs.umich.edu * first, but the Requests's physical address and size fields 2572662Sstever@eecs.umich.edu * need not be valid. The command and destination addresses 2582662Sstever@eecs.umich.edu * must be supplied. */ 2592641Sstever@eecs.umich.edu Packet(Request *_req, Command _cmd, short _dest) 2602566SN/A : data(NULL), staticData(false), dynamicData(false), arrayData(false), 2612641Sstever@eecs.umich.edu addr(_req->paddr), size(_req->size), dest(_dest), 2622663Sstever@eecs.umich.edu addrSizeValid(_req->validPaddr), 2632814Srdreslin@umich.edu srcValid(false), 2642641Sstever@eecs.umich.edu req(_req), coherence(NULL), senderState(NULL), cmd(_cmd), 2652662Sstever@eecs.umich.edu result(Unknown) 2662641Sstever@eecs.umich.edu { 2672813Srdreslin@umich.edu flags = 0; 2682813Srdreslin@umich.edu } 2692813Srdreslin@umich.edu 2702813Srdreslin@umich.edu /** Alternate constructor if you are trying to create a packet with 2712813Srdreslin@umich.edu * a request that is for a whole block, not the address from the req. 2722813Srdreslin@umich.edu * this allows for overriding the size/addr of the req.*/ 2732813Srdreslin@umich.edu Packet(Request *_req, Command _cmd, short _dest, int _blkSize) 2742813Srdreslin@umich.edu : data(NULL), staticData(false), dynamicData(false), arrayData(false), 2752813Srdreslin@umich.edu addr(_req->paddr & ~(_blkSize - 1)), size(_blkSize), 2762814Srdreslin@umich.edu dest(_dest), 2772814Srdreslin@umich.edu addrSizeValid(_req->validPaddr), srcValid(false), 2782813Srdreslin@umich.edu req(_req), coherence(NULL), senderState(NULL), cmd(_cmd), 2792813Srdreslin@umich.edu result(Unknown) 2802813Srdreslin@umich.edu { 2812813Srdreslin@umich.edu flags = 0; 2822641Sstever@eecs.umich.edu } 2832549SN/A 2842662Sstever@eecs.umich.edu /** Destructor. */ 2852566SN/A ~Packet() 2862566SN/A { deleteData(); } 2872566SN/A 2882662Sstever@eecs.umich.edu /** Reinitialize packet address and size from the associated 2892662Sstever@eecs.umich.edu * Request object, and reset other fields that may have been 2902662Sstever@eecs.umich.edu * modified by a previous transaction. Typically called when a 2912662Sstever@eecs.umich.edu * statically allocated Request/Packet pair is reused for 2922662Sstever@eecs.umich.edu * multiple transactions. */ 2932662Sstever@eecs.umich.edu void reinitFromRequest() { 2942662Sstever@eecs.umich.edu assert(req->validPaddr); 2952663Sstever@eecs.umich.edu addr = req->paddr; 2962663Sstever@eecs.umich.edu size = req->size; 2972663Sstever@eecs.umich.edu addrSizeValid = true; 2982662Sstever@eecs.umich.edu result = Unknown; 2992662Sstever@eecs.umich.edu if (dynamicData) { 3002662Sstever@eecs.umich.edu deleteData(); 3012662Sstever@eecs.umich.edu dynamicData = false; 3022662Sstever@eecs.umich.edu arrayData = false; 3032662Sstever@eecs.umich.edu } 3042662Sstever@eecs.umich.edu } 3052566SN/A 3062662Sstever@eecs.umich.edu /** Take a request packet and modify it in place to be suitable 3072662Sstever@eecs.umich.edu * for returning as a response to that request. Used for timing 3082662Sstever@eecs.umich.edu * accesses only. For atomic and functional accesses, the 3092662Sstever@eecs.umich.edu * request packet is always implicitly passed back *without* 3102662Sstever@eecs.umich.edu * modifying the command or destination fields, so this function 3112662Sstever@eecs.umich.edu * should not be called. */ 3122662Sstever@eecs.umich.edu void makeTimingResponse() { 3132662Sstever@eecs.umich.edu assert(needsResponse()); 3142855Srdreslin@umich.edu assert(isRequest()); 3152662Sstever@eecs.umich.edu int icmd = (int)cmd; 3162855Srdreslin@umich.edu icmd &= ~(IsRequest); 3172662Sstever@eecs.umich.edu icmd |= IsResponse; 3182662Sstever@eecs.umich.edu cmd = (Command)icmd; 3192662Sstever@eecs.umich.edu dest = src; 3202662Sstever@eecs.umich.edu srcValid = false; 3212641Sstever@eecs.umich.edu } 3222641Sstever@eecs.umich.edu 3232685Ssaidi@eecs.umich.edu /** Take a request packet that has been returned as NACKED and modify it so 3242685Ssaidi@eecs.umich.edu * that it can be sent out again. Only packets that need a response can be 3252685Ssaidi@eecs.umich.edu * NACKED, so verify that that is true. */ 3262685Ssaidi@eecs.umich.edu void reinitNacked() { 3272685Ssaidi@eecs.umich.edu assert(needsResponse() && result == Nacked); 3282685Ssaidi@eecs.umich.edu dest = Broadcast; 3292685Ssaidi@eecs.umich.edu result = Unknown; 3302685Ssaidi@eecs.umich.edu } 3312685Ssaidi@eecs.umich.edu 3322685Ssaidi@eecs.umich.edu 3332566SN/A /** Set the data pointer to the following value that should not be freed. */ 3342566SN/A template <typename T> 3352592SN/A void dataStatic(T *p); 3362566SN/A 3372566SN/A /** Set the data pointer to a value that should have delete [] called on it. 3382566SN/A */ 3392566SN/A template <typename T> 3402592SN/A void dataDynamicArray(T *p); 3412566SN/A 3422566SN/A /** set the data pointer to a value that should have delete called on it. */ 3432566SN/A template <typename T> 3442592SN/A void dataDynamic(T *p); 3452566SN/A 3462566SN/A /** return the value of what is pointed to in the packet. */ 3472566SN/A template <typename T> 3482592SN/A T get(); 3492566SN/A 3502566SN/A /** get a pointer to the data ptr. */ 3512566SN/A template <typename T> 3522592SN/A T* getPtr(); 3532566SN/A 3542566SN/A /** set the value in the data pointer to v. */ 3552566SN/A template <typename T> 3562592SN/A void set(T v); 3572566SN/A 3582566SN/A /** delete the data pointed to in the data pointer. Ok to call to matter how 3592566SN/A * data was allocted. */ 3602592SN/A void deleteData(); 3612566SN/A 3622566SN/A /** If there isn't data in the packet, allocate some. */ 3632592SN/A void allocate(); 3642568SN/A 3652568SN/A /** Do the packet modify the same addresses. */ 3662592SN/A bool intersect(Packet *p); 3672381SN/A}; 3682381SN/A 3692630SN/Abool fixPacket(Packet *func, Packet *timing); 3702381SN/A#endif //__MEM_PACKET_HH 371