X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=src%2Fmem%2Fpacket.hh;h=c7b47c0a72acf064263a9dee59194226bfe27e9f;hb=de62aedabc96e7492c40bbc4468ba42b3274bfd6;hp=50a6f3d5a35076bfdfa6118608570b34c5b3ffd6;hpb=6a54f7fc5ff1c33bc9f222014dc08c33248b0299;p=gem5.git diff --git a/src/mem/packet.hh b/src/mem/packet.hh index 50a6f3d5a..c7b47c0a7 100644 --- a/src/mem/packet.hh +++ b/src/mem/packet.hh @@ -1,5 +1,5 @@ /* - * Copyright (c) 2012 ARM Limited + * Copyright (c) 2012-2014 ARM Limited * All rights reserved * * The license below extends only to copyright in the software and shall @@ -41,6 +41,7 @@ * Authors: Ron Dreslinski * Steve Reinhardt * Ali Saidi + * Andreas Hansson */ /** @@ -57,7 +58,6 @@ #include "base/cast.hh" #include "base/compiler.hh" -#include "base/fast_alloc.hh" #include "base/flags.hh" #include "base/misc.hh" #include "base/printable.hh" @@ -91,14 +91,6 @@ class MemCmd HardPFReq, SoftPFResp, HardPFResp, - // WriteInvalidateReq transactions used to be generated by the - // DMA ports when writing full blocks to memory, however, it - // is not used anymore since we put the I/O cache in place to - // deal with partial block writes. Hence, WriteInvalidateReq - // and WriteInvalidateResp are currently unused. The - // implication is that the I/O cache does read-exclusive - // operations on every full-cache-block DMA, and ultimately - // this needs to be fixed. WriteInvalidateReq, WriteInvalidateResp, UpgradeReq, @@ -120,7 +112,6 @@ class MemCmd // @TODO these should be classified as responses rather than // requests; coding them as requests initially for backwards // compatibility - NetworkNackError, // nacked at network layer (not by protocol) InvalidDestError, // packet dest field invalid BadAddressError, // memory address invalid FunctionalReadError, // unable to fulfill functional read @@ -197,6 +188,10 @@ class MemCmd bool hasData() const { return testCmdAttrib(HasData); } bool isReadWrite() const { return isRead() && isWrite(); } bool isLLSC() const { return testCmdAttrib(IsLlsc); } + bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } + bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } + bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || + testCmdAttrib(IsHWPrefetch); } bool isError() const { return testCmdAttrib(IsError); } bool isPrint() const { return testCmdAttrib(IsPrint); } bool isFlush() const { return testCmdAttrib(IsFlush); } @@ -226,12 +221,11 @@ class MemCmd * ultimate destination and back, possibly being conveyed by several * different Packets along the way.) */ -class Packet : public FastAlloc, public Printable +class Packet : public Printable { public: typedef uint32_t FlagsType; typedef ::Flags Flags; - typedef short NodeID; private: static const FlagsType PUBLIC_FLAGS = 0x00000000; @@ -250,9 +244,6 @@ class Packet : public FastAlloc, public Printable /// Are the 'addr' and 'size' fields valid? static const FlagsType VALID_ADDR = 0x00000100; static const FlagsType VALID_SIZE = 0x00000200; - /// Is the 'src' field valid? - static const FlagsType VALID_SRC = 0x00000400; - static const FlagsType VALID_DST = 0x00000800; /// Is the data pointer set to a value that shouldn't be freed /// when the packet is destroyed? static const FlagsType STATIC_DATA = 0x00001000; @@ -265,6 +256,8 @@ class Packet : public FastAlloc, public Printable /// suppress the error if this packet encounters a functional /// access failure. static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; + // Signal prefetch squash through express snoop flag + static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; Flags flags; @@ -291,32 +284,35 @@ class Packet : public FastAlloc, public Printable /// physical, depending on the system configuration. Addr addr; + /// True if the request targets the secure memory space. + bool _isSecure; + /// The size of the request or transfer. unsigned size; /** * Source port identifier set on a request packet to enable * appropriate routing of the responses. The source port - * identifier is set by any multiplexing component, e.g. a bus, as - * the timing responses need this information to be routed back to - * the appropriate port at a later point in time. The field can be - * updated (over-written) as the request packet passes through - * additional multiplexing components, and it is their - * responsibility to remember the original source port identifier, - * for example by using an appropriate sender state. The latter is - * done in the cache and bridge. + * identifier is set by any multiplexing component, e.g. a + * crossbar, as the timing responses need this information to be + * routed back to the appropriate port at a later point in + * time. The field can be updated (over-written) as the request + * packet passes through additional multiplexing components, and + * it is their responsibility to remember the original source port + * identifier, for example by using an appropriate sender + * state. The latter is done in the cache and bridge. */ - NodeID src; + PortID src; /** * Destination port identifier that is present on all response * packets that passed through a multiplexing component as a * request packet. The source port identifier is turned into a * destination port identifier when the packet is turned into a - * response, and the destination is used, e.g. by the bus, to + * response, and the destination is used, e.g. by the crossbar, to * select the appropriate path through the interconnect. */ - NodeID dest; + PortID dest; /** * The original value of the command field. Only valid when the @@ -334,26 +330,47 @@ class Packet : public FastAlloc, public Printable uint16_t bytesValidEnd; public: - /// Used to calculate latencies for each packet. - Tick time; - /// The time at which the packet will be fully transmitted - Tick finishTime; + /** + * The extra delay from seeing the packet until the first word is + * transmitted. This delay is used to communicate the crossbar + * forwarding latency to the neighbouring object (e.g. a cache) + * that actually makes the packet wait. As the delay is relative, + * a 32-bit unsigned should be sufficient. + */ + uint32_t firstWordDelay; - /// The time at which the first chunk of the packet will be transmitted - Tick firstWordTime; + /** + * The extra pipelining delay from seeing the packet until the + * last word is transmitted by the component that provided it (if + * any). This includes the first word delay. Similar to the first + * word delay, this is used to make up for the fact that the + * crossbar does not make the packet wait. As the delay is + * relative, a 32-bit unsigned should be sufficient. + */ + uint32_t lastWordDelay; /** * A virtual base opaque structure used to hold state associated - * with the packet but specific to the sending device (e.g., an - * MSHR). A pointer to this state is returned in the packet's - * response so that the sender can quickly look up the state - * needed to process it. A specific subclass would be derived - * from this to carry state specific to a particular sending - * device. + * with the packet (e.g., an MSHR), specific to a MemObject that + * sees the packet. A pointer to this state is returned in the + * packet's response so that the MemObject in question can quickly + * look up the state needed to process it. A specific subclass + * would be derived from this to carry state specific to a + * particular sending device. + * + * As multiple MemObjects may add their SenderState throughout the + * memory system, the SenderStates create a stack, where a + * MemObject can add a new Senderstate, as long as the + * predecessing SenderState is restored when the response comes + * back. For this reason, the predecessor should always be + * populated with the current SenderState of a packet before + * modifying the senderState field in the request packet. */ struct SenderState { + SenderState* predecessor; + SenderState() : predecessor(NULL) {} virtual ~SenderState() {} }; @@ -361,7 +378,7 @@ class Packet : public FastAlloc, public Printable * Object used to maintain state of a PrintReq. The senderState * field of a PrintReq should always be of this type. */ - class PrintReqState : public SenderState, public FastAlloc + class PrintReqState : public SenderState { private: /** @@ -423,12 +440,51 @@ class Packet : public FastAlloc, public Printable * This packet's sender state. Devices should use dynamic_cast<> * to cast to the state appropriate to the sender. The intent of * this variable is to allow a device to attach extra information - * to a request. A response packet must return the sender state + * to a request. A response packet must return the sender state * that was attached to the original request (even if a new packet * is created). */ SenderState *senderState; + /** + * Push a new sender state to the packet and make the current + * sender state the predecessor of the new one. This should be + * prefered over direct manipulation of the senderState member + * variable. + * + * @param sender_state SenderState to push at the top of the stack + */ + void pushSenderState(SenderState *sender_state); + + /** + * Pop the top of the state stack and return a pointer to it. This + * assumes the current sender state is not NULL. This should be + * preferred over direct manipulation of the senderState member + * variable. + * + * @return The current top of the stack + */ + SenderState *popSenderState(); + + /** + * Go through the sender state stack and return the first instance + * that is of type T (as determined by a dynamic_cast). If there + * is no sender state of type T, NULL is returned. + * + * @return The topmost state of type T + */ + template + T * findNextSenderState() const + { + T *t = NULL; + SenderState* sender_state = senderState; + while (t == NULL && sender_state != NULL) { + t = dynamic_cast(sender_state); + sender_state = sender_state->predecessor; + } + return t; + } + /// Return the string name of the cmd field (for debugging and /// tracing). const std::string &cmdString() const { return cmd.toString(); } @@ -452,30 +508,25 @@ class Packet : public FastAlloc, public Printable bool isFlush() const { return cmd.isFlush(); } // Snoop flags - void assertMemInhibit() { flags.set(MEM_INHIBIT); } - bool memInhibitAsserted() { return flags.isSet(MEM_INHIBIT); } - void assertShared() { flags.set(SHARED); } - bool sharedAsserted() { return flags.isSet(SHARED); } + void assertMemInhibit() { flags.set(MEM_INHIBIT); } + bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } + void assertShared() { flags.set(SHARED); } + bool sharedAsserted() const { return flags.isSet(SHARED); } // Special control flags - void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } - bool isExpressSnoop() { return flags.isSet(EXPRESS_SNOOP); } - void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } - void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } - bool isSupplyExclusive() { return flags.isSet(SUPPLY_EXCLUSIVE); } - void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } - bool suppressFuncError() { return flags.isSet(SUPPRESS_FUNC_ERROR); } + void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } + bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } + void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } + void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } + bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } + void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } + bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } + void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } + bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } // Network error conditions... encapsulate them as methods since // their encoding keeps changing (from result field to command // field, etc.) - void - setNacked() - { - assert(isResponse()); - cmd = MemCmd::NetworkNackError; - } - void setBadAddress() { @@ -483,30 +534,42 @@ class Packet : public FastAlloc, public Printable cmd = MemCmd::BadAddressError; } - bool wasNacked() const { return cmd == MemCmd::NetworkNackError; } bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } - bool isSrcValid() { return flags.isSet(VALID_SRC); } + bool isSrcValid() const { return src != InvalidPortID; } /// Accessor function to get the source index of the packet. - NodeID getSrc() const { assert(flags.isSet(VALID_SRC)); return src; } + PortID getSrc() const { assert(isSrcValid()); return src; } /// Accessor function to set the source index of the packet. - void setSrc(NodeID _src) { src = _src; flags.set(VALID_SRC); } - /// Reset source field, e.g. to retransmit packet on different bus. - void clearSrc() { flags.clear(VALID_SRC); } + void setSrc(PortID _src) { src = _src; } - bool isDestValid() { return flags.isSet(VALID_DST); } + bool isDestValid() const { return dest != InvalidPortID; } /// Accessor function for the destination index of the packet. - NodeID getDest() const { assert(flags.isSet(VALID_DST)); return dest; } + PortID getDest() const { assert(isDestValid()); return dest; } /// Accessor function to set the destination index of the packet. - void setDest(NodeID _dest) { dest = _dest; flags.set(VALID_DST); } + void setDest(PortID _dest) { dest = _dest; } /// Reset destination field, e.g. to turn a response into a request again. - void clearDest() { flags.clear(VALID_DST); } + void clearDest() { dest = InvalidPortID; } Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } + /** + * Update the address of this packet mid-transaction. This is used + * by the address mapper to change an already set address to a new + * one based on the system configuration. It is intended to remap + * an existing address, so it asserts that the current address is + * valid. + */ + void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } + unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } + bool isSecure() const + { + assert(flags.isSet(VALID_ADDR)); + return _isSecure; + } + /** * It has been determined that the SC packet should successfully update * memory. Therefore, convert this SC packet to a normal write. @@ -537,13 +600,16 @@ class Packet : public FastAlloc, public Printable * not be valid. The command must be supplied. */ Packet(Request *_req, MemCmd _cmd) - : cmd(_cmd), req(_req), data(NULL), + : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), + size(0), src(InvalidPortID), dest(InvalidPortID), bytesValidStart(0), bytesValidEnd(0), - time(curTick()), senderState(NULL) + firstWordDelay(0), lastWordDelay(0), + senderState(NULL) { if (req->hasPaddr()) { addr = req->getPaddr(); flags.set(VALID_ADDR); + _isSecure = req->isSecure(); } if (req->hasSize()) { size = req->getSize(); @@ -557,13 +623,16 @@ class Packet : public FastAlloc, public Printable * req. this allows for overriding the size/addr of the req. */ Packet(Request *_req, MemCmd _cmd, int _blkSize) - : cmd(_cmd), req(_req), data(NULL), + : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), + src(InvalidPortID), dest(InvalidPortID), bytesValidStart(0), bytesValidEnd(0), - time(curTick()), senderState(NULL) + firstWordDelay(0), lastWordDelay(0), + senderState(NULL) { if (req->hasPaddr()) { addr = req->getPaddr() & ~(_blkSize - 1); flags.set(VALID_ADDR); + _isSecure = req->isSecure(); } size = _blkSize; flags.set(VALID_SIZE); @@ -579,16 +648,61 @@ class Packet : public FastAlloc, public Printable Packet(Packet *pkt, bool clearFlags = false) : cmd(pkt->cmd), req(pkt->req), data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), - addr(pkt->addr), size(pkt->size), src(pkt->src), dest(pkt->dest), - bytesValidStart(pkt->bytesValidStart), bytesValidEnd(pkt->bytesValidEnd), - time(curTick()), senderState(pkt->senderState) + addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), + src(pkt->src), dest(pkt->dest), + bytesValidStart(pkt->bytesValidStart), + bytesValidEnd(pkt->bytesValidEnd), + firstWordDelay(pkt->firstWordDelay), + lastWordDelay(pkt->lastWordDelay), + senderState(pkt->senderState) { if (!clearFlags) flags.set(pkt->flags & COPY_FLAGS); - flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE|VALID_SRC|VALID_DST)); + flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); flags.set(pkt->flags & STATIC_DATA); + } + + /** + * Change the packet type based on request type. + */ + void + refineCommand() + { + if (cmd == MemCmd::ReadReq) { + if (req->isLLSC()) { + cmd = MemCmd::LoadLockedReq; + } else if (req->isPrefetch()) { + cmd = MemCmd::SoftPFReq; + } + } else if (cmd == MemCmd::WriteReq) { + if (req->isLLSC()) { + cmd = MemCmd::StoreCondReq; + } else if (req->isSwap()) { + cmd = MemCmd::SwapReq; + } + } + } + + /** + * Constructor-like methods that return Packets based on Request objects. + * Will call refineCommand() to fine-tune the Packet type if it's not a + * vanilla read or write. + */ + static PacketPtr + createRead(Request *req) + { + PacketPtr pkt = new Packet(req, MemCmd::ReadReq); + pkt->refineCommand(); + return pkt; + } + static PacketPtr + createWrite(Request *req) + { + PacketPtr pkt = new Packet(req, MemCmd::WriteReq); + pkt->refineCommand(); + return pkt; } /** @@ -617,8 +731,15 @@ class Packet : public FastAlloc, public Printable assert(req->hasPaddr()); flags = 0; addr = req->getPaddr(); + _isSecure = req->isSecure(); size = req->getSize(); - time = req->time(); + + src = InvalidPortID; + dest = InvalidPortID; + bytesValidStart = 0; + bytesValidEnd = 0; + firstWordDelay = 0; + lastWordDelay = 0; flags.set(VALID_ADDR|VALID_SIZE); deleteData(); @@ -644,8 +765,7 @@ class Packet : public FastAlloc, public Printable flags.clear(EXPRESS_SNOOP); dest = src; - flags.set(VALID_DST, flags.isSet(VALID_SRC)); - flags.clear(VALID_SRC); + src = InvalidPortID; } void @@ -672,20 +792,6 @@ class Packet : public FastAlloc, public Printable } } - /** - * Take a request packet that has been returned as NACKED and - * modify it so that it can be sent out again. Only packets that - * need a response can be NACKED, so verify that that is true. - */ - void - reinitNacked() - { - assert(wasNacked()); - cmd = origCmd; - assert(needsResponse()); - clearDest(); - } - void setSize(unsigned size) { @@ -834,7 +940,8 @@ class Packet : public FastAlloc, public Printable * value. If the functional request is a write, it may update the * memory value. */ - bool checkFunctional(Printable *obj, Addr base, int size, uint8_t *data); + bool checkFunctional(Printable *obj, Addr base, bool is_secure, int size, + uint8_t *data); /** * Check a functional request against a memory value stored in @@ -844,8 +951,8 @@ class Packet : public FastAlloc, public Printable checkFunctional(PacketPtr other) { uint8_t *data = other->hasData() ? other->getPtr() : NULL; - return checkFunctional(other, other->getAddr(), other->getSize(), - data); + return checkFunctional(other, other->getAddr(), other->isSecure(), + other->getSize(), data); } /** @@ -870,6 +977,14 @@ class Packet : public FastAlloc, public Printable void print(std::ostream &o, int verbosity = 0, const std::string &prefix = "") const; + + /** + * A no-args wrapper of print(std::ostream...) + * meant to be invoked from DPRINTFs + * avoiding string overheads in fast mode + * @return string with the request's type and start<->end addresses + */ + std::string print() const; }; #endif //__MEM_PACKET_HH