2 * Copyright (c) 2012-2014 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * Copyright (c) 2010 Advanced Micro Devices, Inc.
16 * All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * Authors: Ron Dreslinski
49 * Declaration of the Packet class.
52 #ifndef __MEM_PACKET_HH__
53 #define __MEM_PACKET_HH__
59 #include "base/cast.hh"
60 #include "base/compiler.hh"
61 #include "base/flags.hh"
62 #include "base/misc.hh"
63 #include "base/printable.hh"
64 #include "base/types.hh"
65 #include "mem/request.hh"
66 #include "sim/core.hh"
69 typedef Packet *PacketPtr;
70 typedef uint8_t* PacketDataPtr;
71 typedef std::list<PacketPtr> PacketList;
79 * List of all commands associated with a packet.
86 ReadRespWithInvalidate,
97 SCUpgradeReq, // Special "weak" upgrade for StoreCond
99 SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent)
100 UpgradeFailResp, // Valid for SCUpgradeReq only
105 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent)
112 // @TODO these should be classified as responses rather than
113 // requests; coding them as requests initially for backwards
115 InvalidDestError, // packet dest field invalid
116 BadAddressError, // memory address invalid
117 FunctionalReadError, // unable to fulfill functional read
118 FunctionalWriteError, // unable to fulfill functional write
119 // Fake simulator-only commands
120 PrintReq, // Print state matching address
121 FlushReq, //request for a cache flush
122 InvalidationReq, // request for address to be invalidated from lsq
128 * List of command attributes.
132 IsRead, //!< Data flows from responder to requester
133 IsWrite, //!< Data flows from requester to responder
136 NeedsExclusive, //!< Requires exclusive copy to complete in-cache
137 IsRequest, //!< Issued by requester
138 IsResponse, //!< Issue by responder
139 NeedsResponse, //!< Requester needs response from target
142 IsLlsc, //!< Alpha/MIPS LL or SC access
143 HasData, //!< There is an associated payload
144 IsError, //!< Error response
145 IsPrint, //!< Print state matching address (for debugging)
146 IsFlush, //!< Flush the address from caches
147 NUM_COMMAND_ATTRIBUTES
151 * Structure that defines attributes and other data associated
156 /// Set of attribute flags.
157 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes;
158 /// Corresponding response for requests; InvalidCmd if no
159 /// response is applicable.
160 const Command response;
161 /// String representation (for printing)
162 const std::string str;
165 /// Array to map Command enum to associated info.
166 static const CommandInfo commandInfo[];
173 testCmdAttrib(MemCmd::Attribute attrib) const
175 return commandInfo[cmd].attributes[attrib] != 0;
180 bool isRead() const { return testCmdAttrib(IsRead); }
181 bool isWrite() const { return testCmdAttrib(IsWrite); }
182 bool isUpgrade() const { return testCmdAttrib(IsUpgrade); }
183 bool isRequest() const { return testCmdAttrib(IsRequest); }
184 bool isResponse() const { return testCmdAttrib(IsResponse); }
185 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); }
186 bool needsResponse() const { return testCmdAttrib(NeedsResponse); }
187 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); }
188 bool hasData() const { return testCmdAttrib(HasData); }
189 bool isReadWrite() const { return isRead() && isWrite(); }
190 bool isLLSC() const { return testCmdAttrib(IsLlsc); }
191 bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); }
192 bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); }
193 bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) ||
194 testCmdAttrib(IsHWPrefetch); }
195 bool isError() const { return testCmdAttrib(IsError); }
196 bool isPrint() const { return testCmdAttrib(IsPrint); }
197 bool isFlush() const { return testCmdAttrib(IsFlush); }
200 responseCommand() const
202 return commandInfo[cmd].response;
205 /// Return the string to a cmd given by idx.
206 const std::string &toString() const { return commandInfo[cmd].str; }
207 int toInt() const { return (int)cmd; }
209 MemCmd(Command _cmd) : cmd(_cmd) { }
210 MemCmd(int _cmd) : cmd((Command)_cmd) { }
211 MemCmd() : cmd(InvalidCmd) { }
213 bool operator==(MemCmd c2) const { return (cmd == c2.cmd); }
214 bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); }
218 * A Packet is used to encapsulate a transfer between two objects in
219 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
220 * single Request travels all the way from the requester to the
221 * ultimate destination and back, possibly being conveyed by several
222 * different Packets along the way.)
224 class Packet : public Printable
227 typedef uint32_t FlagsType;
228 typedef ::Flags<FlagsType> Flags;
231 static const FlagsType PUBLIC_FLAGS = 0x00000000;
232 static const FlagsType PRIVATE_FLAGS = 0x00007F0F;
233 static const FlagsType COPY_FLAGS = 0x0000000F;
235 static const FlagsType SHARED = 0x00000001;
236 // Special control flags
237 /// Special timing-mode atomic snoop for multi-level coherence.
238 static const FlagsType EXPRESS_SNOOP = 0x00000002;
239 /// Does supplier have exclusive copy?
240 /// Useful for multi-level coherence.
241 static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004;
242 // Snoop response flags
243 static const FlagsType MEM_INHIBIT = 0x00000008;
244 /// Are the 'addr' and 'size' fields valid?
245 static const FlagsType VALID_ADDR = 0x00000100;
246 static const FlagsType VALID_SIZE = 0x00000200;
247 /// Is the data pointer set to a value that shouldn't be freed
248 /// when the packet is destroyed?
249 static const FlagsType STATIC_DATA = 0x00001000;
250 /// The data pointer points to a value that should be freed when
251 /// the packet is destroyed.
252 static const FlagsType DYNAMIC_DATA = 0x00002000;
253 /// the data pointer points to an array (thus delete []) needs to
254 /// be called on it rather than simply delete.
255 static const FlagsType ARRAY_DATA = 0x00004000;
256 /// suppress the error if this packet encounters a functional
258 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000;
259 // Signal prefetch squash through express snoop flag
260 static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000;
265 typedef MemCmd::Command Command;
267 /// The command field of the packet.
270 /// A pointer to the original request.
275 * A pointer to the data being transfered. It can be differnt
276 * sizes at each level of the heirarchy so it belongs in the
277 * packet, not request. This may or may not be populated when a
278 * responder recieves the packet. If not populated it memory should
283 /// The address of the request. This address could be virtual or
284 /// physical, depending on the system configuration.
287 /// True if the request targets the secure memory space.
290 /// The size of the request or transfer.
294 * Source port identifier set on a request packet to enable
295 * appropriate routing of the responses. The source port
296 * identifier is set by any multiplexing component, e.g. a
297 * crossbar, as the timing responses need this information to be
298 * routed back to the appropriate port at a later point in
299 * time. The field can be updated (over-written) as the request
300 * packet passes through additional multiplexing components, and
301 * it is their responsibility to remember the original source port
302 * identifier, for example by using an appropriate sender
303 * state. The latter is done in the cache and bridge.
308 * Destination port identifier that is present on all response
309 * packets that passed through a multiplexing component as a
310 * request packet. The source port identifier is turned into a
311 * destination port identifier when the packet is turned into a
312 * response, and the destination is used, e.g. by the crossbar, to
313 * select the appropriate path through the interconnect.
318 * The original value of the command field. Only valid when the
319 * current command field is an error condition; in that case, the
320 * previous contents of the command field are copied here. This
321 * field is *not* set on non-error responses.
326 * These values specify the range of bytes found that satisfy a
329 uint16_t bytesValidStart;
330 uint16_t bytesValidEnd;
335 * The extra delay from seeing the packet until the first word is
336 * transmitted. This delay is used to communicate the crossbar
337 * forwarding latency to the neighbouring object (e.g. a cache)
338 * that actually makes the packet wait. As the delay is relative,
339 * a 32-bit unsigned should be sufficient.
341 uint32_t firstWordDelay;
344 * The extra pipelining delay from seeing the packet until the
345 * last word is transmitted by the component that provided it (if
346 * any). This includes the first word delay. Similar to the first
347 * word delay, this is used to make up for the fact that the
348 * crossbar does not make the packet wait. As the delay is
349 * relative, a 32-bit unsigned should be sufficient.
351 uint32_t lastWordDelay;
354 * A virtual base opaque structure used to hold state associated
355 * with the packet (e.g., an MSHR), specific to a MemObject that
356 * sees the packet. A pointer to this state is returned in the
357 * packet's response so that the MemObject in question can quickly
358 * look up the state needed to process it. A specific subclass
359 * would be derived from this to carry state specific to a
360 * particular sending device.
362 * As multiple MemObjects may add their SenderState throughout the
363 * memory system, the SenderStates create a stack, where a
364 * MemObject can add a new Senderstate, as long as the
365 * predecessing SenderState is restored when the response comes
366 * back. For this reason, the predecessor should always be
367 * populated with the current SenderState of a packet before
368 * modifying the senderState field in the request packet.
372 SenderState* predecessor;
373 SenderState() : predecessor(NULL) {}
374 virtual ~SenderState() {}
378 * Object used to maintain state of a PrintReq. The senderState
379 * field of a PrintReq should always be of this type.
381 class PrintReqState : public SenderState
385 * An entry in the label stack.
387 struct LabelStackEntry
389 const std::string label;
392 LabelStackEntry(const std::string &_label, std::string *_prefix);
395 typedef std::list<LabelStackEntry> LabelStack;
396 LabelStack labelStack;
398 std::string *curPrefixPtr;
404 PrintReqState(std::ostream &os, int verbosity = 0);
408 * Returns the current line prefix.
410 const std::string &curPrefix() { return *curPrefixPtr; }
413 * Push a label onto the label stack, and prepend the given
414 * prefix string onto the current prefix. Labels will only be
415 * printed if an object within the label's scope is printed.
417 void pushLabel(const std::string &lbl,
418 const std::string &prefix = " ");
421 * Pop a label off the label stack.
426 * Print all of the pending unprinted labels on the
427 * stack. Called by printObj(), so normally not called by
428 * users unless bypassing printObj().
433 * Print a Printable object to os, because it matched the
434 * address on a PrintReq.
436 void printObj(Printable *obj);
440 * This packet's sender state. Devices should use dynamic_cast<>
441 * to cast to the state appropriate to the sender. The intent of
442 * this variable is to allow a device to attach extra information
443 * to a request. A response packet must return the sender state
444 * that was attached to the original request (even if a new packet
447 SenderState *senderState;
450 * Push a new sender state to the packet and make the current
451 * sender state the predecessor of the new one. This should be
452 * prefered over direct manipulation of the senderState member
455 * @param sender_state SenderState to push at the top of the stack
457 void pushSenderState(SenderState *sender_state);
460 * Pop the top of the state stack and return a pointer to it. This
461 * assumes the current sender state is not NULL. This should be
462 * preferred over direct manipulation of the senderState member
465 * @return The current top of the stack
467 SenderState *popSenderState();
470 * Go through the sender state stack and return the first instance
471 * that is of type T (as determined by a dynamic_cast). If there
472 * is no sender state of type T, NULL is returned.
474 * @return The topmost state of type T
476 template <typename T>
477 T * findNextSenderState() const
480 SenderState* sender_state = senderState;
481 while (t == NULL && sender_state != NULL) {
482 t = dynamic_cast<T*>(sender_state);
483 sender_state = sender_state->predecessor;
488 /// Return the string name of the cmd field (for debugging and
490 const std::string &cmdString() const { return cmd.toString(); }
492 /// Return the index of this command.
493 inline int cmdToIndex() const { return cmd.toInt(); }
495 bool isRead() const { return cmd.isRead(); }
496 bool isWrite() const { return cmd.isWrite(); }
497 bool isUpgrade() const { return cmd.isUpgrade(); }
498 bool isRequest() const { return cmd.isRequest(); }
499 bool isResponse() const { return cmd.isResponse(); }
500 bool needsExclusive() const { return cmd.needsExclusive(); }
501 bool needsResponse() const { return cmd.needsResponse(); }
502 bool isInvalidate() const { return cmd.isInvalidate(); }
503 bool hasData() const { return cmd.hasData(); }
504 bool isReadWrite() const { return cmd.isReadWrite(); }
505 bool isLLSC() const { return cmd.isLLSC(); }
506 bool isError() const { return cmd.isError(); }
507 bool isPrint() const { return cmd.isPrint(); }
508 bool isFlush() const { return cmd.isFlush(); }
511 void assertMemInhibit() { flags.set(MEM_INHIBIT); }
512 bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); }
513 void assertShared() { flags.set(SHARED); }
514 bool sharedAsserted() const { return flags.isSet(SHARED); }
516 // Special control flags
517 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); }
518 bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); }
519 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); }
520 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); }
521 bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); }
522 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); }
523 bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); }
524 void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); }
525 bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); }
527 // Network error conditions... encapsulate them as methods since
528 // their encoding keeps changing (from result field to command
533 assert(isResponse());
534 cmd = MemCmd::BadAddressError;
537 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; }
538 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; }
540 bool isSrcValid() const { return src != InvalidPortID; }
541 /// Accessor function to get the source index of the packet.
542 PortID getSrc() const { assert(isSrcValid()); return src; }
543 /// Accessor function to set the source index of the packet.
544 void setSrc(PortID _src) { src = _src; }
546 bool isDestValid() const { return dest != InvalidPortID; }
547 /// Accessor function for the destination index of the packet.
548 PortID getDest() const { assert(isDestValid()); return dest; }
549 /// Accessor function to set the destination index of the packet.
550 void setDest(PortID _dest) { dest = _dest; }
551 /// Reset destination field, e.g. to turn a response into a request again.
552 void clearDest() { dest = InvalidPortID; }
554 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; }
556 * Update the address of this packet mid-transaction. This is used
557 * by the address mapper to change an already set address to a new
558 * one based on the system configuration. It is intended to remap
559 * an existing address, so it asserts that the current address is
562 void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; }
564 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; }
565 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); }
567 bool isSecure() const
569 assert(flags.isSet(VALID_ADDR));
574 * It has been determined that the SC packet should successfully update
575 * memory. Therefore, convert this SC packet to a normal write.
582 cmd = MemCmd::WriteReq;
586 * When ruby is in use, Ruby will monitor the cache line and thus M5
587 * phys memory should treat LL ops as normal reads.
594 cmd = MemCmd::ReadReq;
598 * Constructor. Note that a Request object must be constructed
599 * first, but the Requests's physical address and size fields need
600 * not be valid. The command must be supplied.
602 Packet(Request *_req, MemCmd _cmd)
603 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false),
604 src(InvalidPortID), dest(InvalidPortID),
605 bytesValidStart(0), bytesValidEnd(0),
606 firstWordDelay(0), lastWordDelay(0),
609 if (req->hasPaddr()) {
610 addr = req->getPaddr();
611 flags.set(VALID_ADDR);
612 _isSecure = req->isSecure();
614 if (req->hasSize()) {
615 size = req->getSize();
616 flags.set(VALID_SIZE);
621 * Alternate constructor if you are trying to create a packet with
622 * a request that is for a whole block, not the address from the
623 * req. this allows for overriding the size/addr of the req.
625 Packet(Request *_req, MemCmd _cmd, int _blkSize)
626 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false),
627 src(InvalidPortID), dest(InvalidPortID),
628 bytesValidStart(0), bytesValidEnd(0),
629 firstWordDelay(0), lastWordDelay(0),
632 if (req->hasPaddr()) {
633 addr = req->getPaddr() & ~(_blkSize - 1);
634 flags.set(VALID_ADDR);
635 _isSecure = req->isSecure();
638 flags.set(VALID_SIZE);
642 * Alternate constructor for copying a packet. Copy all fields
643 * *except* if the original packet's data was dynamic, don't copy
644 * that, as we can't guarantee that the new packet's lifetime is
645 * less than that of the original packet. In this case the new
646 * packet should allocate its own data.
648 Packet(Packet *pkt, bool clearFlags = false)
649 : cmd(pkt->cmd), req(pkt->req),
650 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL),
651 addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size),
652 src(pkt->src), dest(pkt->dest),
653 bytesValidStart(pkt->bytesValidStart),
654 bytesValidEnd(pkt->bytesValidEnd),
655 firstWordDelay(pkt->firstWordDelay),
656 lastWordDelay(pkt->lastWordDelay),
657 senderState(pkt->senderState)
660 flags.set(pkt->flags & COPY_FLAGS);
662 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE));
663 flags.set(pkt->flags & STATIC_DATA);
667 * Change the packet type based on request type.
672 if (cmd == MemCmd::ReadReq) {
674 cmd = MemCmd::LoadLockedReq;
675 } else if (req->isPrefetch()) {
676 cmd = MemCmd::SoftPFReq;
678 } else if (cmd == MemCmd::WriteReq) {
680 cmd = MemCmd::StoreCondReq;
681 } else if (req->isSwap()) {
682 cmd = MemCmd::SwapReq;
688 * Constructor-like methods that return Packets based on Request objects.
689 * Will call refineCommand() to fine-tune the Packet type if it's not a
690 * vanilla read or write.
693 createRead(Request *req)
695 PacketPtr pkt = new Packet(req, MemCmd::ReadReq);
696 pkt->refineCommand();
701 createWrite(Request *req)
703 PacketPtr pkt = new Packet(req, MemCmd::WriteReq);
704 pkt->refineCommand();
709 * clean up packet variables
713 // If this is a request packet for which there's no response,
714 // delete the request object here, since the requester will
715 // never get the chance.
716 if (req && isRequest() && !needsResponse())
722 * Reinitialize packet address and size from the associated
723 * Request object, and reset other fields that may have been
724 * modified by a previous transaction. Typically called when a
725 * statically allocated Request/Packet pair is reused for multiple
731 assert(req->hasPaddr());
733 addr = req->getPaddr();
734 _isSecure = req->isSecure();
735 size = req->getSize();
738 dest = InvalidPortID;
744 flags.set(VALID_ADDR|VALID_SIZE);
749 * Take a request packet and modify it in place to be suitable for
750 * returning as a response to that request. The source field is
751 * turned into the destination, and subsequently cleared. Note
752 * that the latter is not necessary for atomic requests, but
753 * causes no harm as neither field is valid.
758 assert(needsResponse());
761 cmd = cmd.responseCommand();
763 // responses are never express, even if the snoop that
764 // triggered them was
765 flags.clear(EXPRESS_SNOOP);
784 setFunctionalResponseStatus(bool success)
788 cmd = MemCmd::FunctionalWriteError;
790 cmd = MemCmd::FunctionalReadError;
796 setSize(unsigned size)
798 assert(!flags.isSet(VALID_SIZE));
801 flags.set(VALID_SIZE);
806 * Set the data pointer to the following value that should not be
809 template <typename T>
813 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
814 data = (PacketDataPtr)p;
815 flags.set(STATIC_DATA);
819 * Set the data pointer to a value that should have delete []
822 template <typename T>
824 dataDynamicArray(T *p)
826 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
827 data = (PacketDataPtr)p;
828 flags.set(DYNAMIC_DATA|ARRAY_DATA);
832 * set the data pointer to a value that should have delete called
835 template <typename T>
839 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
840 data = (PacketDataPtr)p;
841 flags.set(DYNAMIC_DATA);
845 * get a pointer to the data ptr.
847 template <typename T>
849 getPtr(bool null_ok = false)
851 assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA));
856 * return the value of what is pointed to in the packet.
858 template <typename T>
862 * set the value in the data pointer to v.
864 template <typename T>
868 * Copy data into the packet from the provided pointer.
873 if (p != getPtr<uint8_t>())
874 std::memcpy(getPtr<uint8_t>(), p, getSize());
878 * Copy data into the packet from the provided block pointer,
879 * which is aligned to the given block size.
882 setDataFromBlock(uint8_t *blk_data, int blkSize)
884 setData(blk_data + getOffset(blkSize));
888 * Copy data from the packet to the provided block pointer, which
889 * is aligned to the given block size.
892 writeData(uint8_t *p)
894 std::memcpy(p, getPtr<uint8_t>(), getSize());
898 * Copy data from the packet to the memory at the provided pointer.
901 writeDataToBlock(uint8_t *blk_data, int blkSize)
903 writeData(blk_data + getOffset(blkSize));
907 * delete the data pointed to in the data pointer. Ok to call to
908 * matter how data was allocted.
913 if (flags.isSet(ARRAY_DATA))
915 else if (flags.isSet(DYNAMIC_DATA))
918 flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA);
922 /** If there isn't data in the packet, allocate some. */
927 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA));
931 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA));
932 flags.set(DYNAMIC_DATA|ARRAY_DATA);
933 data = new uint8_t[getSize()];
937 * Check a functional request against a memory value represented
938 * by a base/size pair and an associated data array. If the
939 * functional request is a read, it may be satisfied by the memory
940 * value. If the functional request is a write, it may update the
943 bool checkFunctional(Printable *obj, Addr base, bool is_secure, int size,
947 * Check a functional request against a memory value stored in
948 * another packet (i.e. an in-transit request or response).
951 checkFunctional(PacketPtr other)
953 uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL;
954 return checkFunctional(other, other->getAddr(), other->isSecure(),
955 other->getSize(), data);
959 * Push label for PrintReq (safe to call unconditionally).
962 pushLabel(const std::string &lbl)
965 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl);
969 * Pop label for PrintReq (safe to call unconditionally).
975 safe_cast<PrintReqState*>(senderState)->popLabel();
978 void print(std::ostream &o, int verbosity = 0,
979 const std::string &prefix = "") const;
982 * A no-args wrapper of print(std::ostream...)
983 * meant to be invoked from DPRINTFs
984 * avoiding string overheads in fast mode
985 * @return string with the request's type and start<->end addresses
987 std::string print() const;
990 #endif //__MEM_PACKET_HH