1/*
2 * Copyright (c) 2012 ARM Limited
3 * All rights reserved
4 *
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.
13 *
14 * Copyright (c) 2006 The Regents of The University of Michigan
15 * Copyright (c) 2010 Advanced Micro Devices, Inc.
16 * All rights reserved.
17 *
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.
28 *
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.
40 *
41 * Authors: Ron Dreslinski
42 * Steve Reinhardt
43 * Ali Saidi
44 * Andreas Hansson
45 */
46
47/**
48 * @file
49 * Declaration of the Packet class.
50 */
51
52#ifndef __MEM_PACKET_HH__
53#define __MEM_PACKET_HH__
54
55#include <bitset>
56#include <cassert>
57#include <list>
58
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"
67
68class Packet;
69typedef Packet *PacketPtr;
70typedef uint8_t* PacketDataPtr;
71typedef std::list<PacketPtr> PacketList;
72
73class MemCmd
74{
75 friend class Packet;
76
77 public:
78 /**
79 * List of all commands associated with a packet.
80 */
81 enum Command
82 {
83 InvalidCmd,
84 ReadReq,
85 ReadResp,
86 ReadRespWithInvalidate,
87 WriteReq,
88 WriteResp,
89 Writeback,
90 SoftPFReq,
91 HardPFReq,
92 SoftPFResp,
93 HardPFResp,
94 // WriteInvalidateReq transactions used to be generated by the
95 // DMA ports when writing full blocks to memory, however, it
96 // is not used anymore since we put the I/O cache in place to
97 // deal with partial block writes. Hence, WriteInvalidateReq
98 // and WriteInvalidateResp are currently unused. The
99 // implication is that the I/O cache does read-exclusive
100 // operations on every full-cache-block DMA, and ultimately
101 // this needs to be fixed.
102 WriteInvalidateReq,
103 WriteInvalidateResp,
104 UpgradeReq,
105 SCUpgradeReq, // Special "weak" upgrade for StoreCond
106 UpgradeResp,
107 SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent)
108 UpgradeFailResp, // Valid for SCUpgradeReq only
109 ReadExReq,
110 ReadExResp,
111 LoadLockedReq,
112 StoreCondReq,
113 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent)
114 StoreCondResp,
115 SwapReq,
116 SwapResp,
117 MessageReq,
118 MessageResp,
119 // Error responses
120 // @TODO these should be classified as responses rather than
121 // requests; coding them as requests initially for backwards
122 // compatibility
123 InvalidDestError, // packet dest field invalid
124 BadAddressError, // memory address invalid
125 FunctionalReadError, // unable to fulfill functional read
126 FunctionalWriteError, // unable to fulfill functional write
127 // Fake simulator-only commands
128 PrintReq, // Print state matching address
129 FlushReq, //request for a cache flush
130 InvalidationReq, // request for address to be invalidated from lsq
131 NUM_MEM_CMDS
132 };
133
134 private:
135 /**
136 * List of command attributes.
137 */
138 enum Attribute
139 {
140 IsRead, //!< Data flows from responder to requester
141 IsWrite, //!< Data flows from requester to responder
142 IsUpgrade,
143 IsInvalidate,
144 NeedsExclusive, //!< Requires exclusive copy to complete in-cache
145 IsRequest, //!< Issued by requester
146 IsResponse, //!< Issue by responder
147 NeedsResponse, //!< Requester needs response from target
148 IsSWPrefetch,
149 IsHWPrefetch,
150 IsLlsc, //!< Alpha/MIPS LL or SC access
151 HasData, //!< There is an associated payload
152 IsError, //!< Error response
153 IsPrint, //!< Print state matching address (for debugging)
154 IsFlush, //!< Flush the address from caches
155 NUM_COMMAND_ATTRIBUTES
156 };
157
158 /**
159 * Structure that defines attributes and other data associated
160 * with a Command.
161 */
162 struct CommandInfo
163 {
164 /// Set of attribute flags.
165 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes;
166 /// Corresponding response for requests; InvalidCmd if no
167 /// response is applicable.
168 const Command response;
169 /// String representation (for printing)
170 const std::string str;
171 };
172
173 /// Array to map Command enum to associated info.
174 static const CommandInfo commandInfo[];
175
176 private:
177
178 Command cmd;
179
180 bool
181 testCmdAttrib(MemCmd::Attribute attrib) const
182 {
183 return commandInfo[cmd].attributes[attrib] != 0;
184 }
185
186 public:
187
188 bool isRead() const { return testCmdAttrib(IsRead); }
189 bool isWrite() const { return testCmdAttrib(IsWrite); }
190 bool isUpgrade() const { return testCmdAttrib(IsUpgrade); }
191 bool isRequest() const { return testCmdAttrib(IsRequest); }
192 bool isResponse() const { return testCmdAttrib(IsResponse); }
193 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); }
194 bool needsResponse() const { return testCmdAttrib(NeedsResponse); }
195 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); }
196 bool hasData() const { return testCmdAttrib(HasData); }
197 bool isReadWrite() const { return isRead() && isWrite(); }
198 bool isLLSC() const { return testCmdAttrib(IsLlsc); }
199 bool isError() const { return testCmdAttrib(IsError); }
200 bool isPrint() const { return testCmdAttrib(IsPrint); }
201 bool isFlush() const { return testCmdAttrib(IsFlush); }
202
203 const Command
204 responseCommand() const
205 {
206 return commandInfo[cmd].response;
207 }
208
209 /// Return the string to a cmd given by idx.
210 const std::string &toString() const { return commandInfo[cmd].str; }
211 int toInt() const { return (int)cmd; }
212
213 MemCmd(Command _cmd) : cmd(_cmd) { }
214 MemCmd(int _cmd) : cmd((Command)_cmd) { }
215 MemCmd() : cmd(InvalidCmd) { }
216
217 bool operator==(MemCmd c2) const { return (cmd == c2.cmd); }
218 bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); }
219};
220
221/**
222 * A Packet is used to encapsulate a transfer between two objects in
223 * the memory system (e.g., the L1 and L2 cache). (In contrast, a
224 * single Request travels all the way from the requester to the
225 * ultimate destination and back, possibly being conveyed by several
226 * different Packets along the way.)
227 */
228class Packet : public Printable
229{
230 public:
231 typedef uint32_t FlagsType;
232 typedef ::Flags<FlagsType> Flags;
233
234 private:
235 static const FlagsType PUBLIC_FLAGS = 0x00000000;
236 static const FlagsType PRIVATE_FLAGS = 0x00007F0F;
237 static const FlagsType COPY_FLAGS = 0x0000000F;
238
239 static const FlagsType SHARED = 0x00000001;
240 // Special control flags
241 /// Special timing-mode atomic snoop for multi-level coherence.
242 static const FlagsType EXPRESS_SNOOP = 0x00000002;
243 /// Does supplier have exclusive copy?
244 /// Useful for multi-level coherence.
245 static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004;
246 // Snoop response flags
247 static const FlagsType MEM_INHIBIT = 0x00000008;
248 /// Are the 'addr' and 'size' fields valid?
249 static const FlagsType VALID_ADDR = 0x00000100;
250 static const FlagsType VALID_SIZE = 0x00000200;
251 /// Is the data pointer set to a value that shouldn't be freed
252 /// when the packet is destroyed?
253 static const FlagsType STATIC_DATA = 0x00001000;
254 /// The data pointer points to a value that should be freed when
255 /// the packet is destroyed.
256 static const FlagsType DYNAMIC_DATA = 0x00002000;
257 /// the data pointer points to an array (thus delete []) needs to
258 /// be called on it rather than simply delete.
259 static const FlagsType ARRAY_DATA = 0x00004000;
260 /// suppress the error if this packet encounters a functional
261 /// access failure.
262 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000;
263
264 Flags flags;
265
266 public:
267 typedef MemCmd::Command Command;
268
269 /// The command field of the packet.
270 MemCmd cmd;
271
272 /// A pointer to the original request.
273 RequestPtr req;
274
275 private:
276 /**
277 * A pointer to the data being transfered. It can be differnt
278 * sizes at each level of the heirarchy so it belongs in the
279 * packet, not request. This may or may not be populated when a
280 * responder recieves the packet. If not populated it memory should
281 * be allocated.
282 */
283 PacketDataPtr data;
284
285 /// The address of the request. This address could be virtual or
286 /// physical, depending on the system configuration.
287 Addr addr;
288
289 /// The size of the request or transfer.
290 unsigned size;
291
292 /**
293 * Source port identifier set on a request packet to enable
294 * appropriate routing of the responses. The source port
295 * identifier is set by any multiplexing component, e.g. a bus, as
296 * the timing responses need this information to be routed back to
297 * the appropriate port at a later point in time. The field can be
298 * updated (over-written) as the request packet passes through
299 * additional multiplexing components, and it is their
300 * responsibility to remember the original source port identifier,
301 * for example by using an appropriate sender state. The latter is
302 * done in the cache and bridge.
303 */
304 PortID src;
305
306 /**
307 * Destination port identifier that is present on all response
308 * packets that passed through a multiplexing component as a
309 * request packet. The source port identifier is turned into a
310 * destination port identifier when the packet is turned into a
311 * response, and the destination is used, e.g. by the bus, to
312 * select the appropriate path through the interconnect.
313 */
314 PortID dest;
315
316 /**
317 * The original value of the command field. Only valid when the
318 * current command field is an error condition; in that case, the
319 * previous contents of the command field are copied here. This
320 * field is *not* set on non-error responses.
321 */
322 MemCmd origCmd;
323
324 /**
325 * These values specify the range of bytes found that satisfy a
326 * functional read.
327 */
328 uint16_t bytesValidStart;
329 uint16_t bytesValidEnd;
330
331 public:
332 /// Used to calculate latencies for each packet.
333 Tick time;
334
335 /// The time at which the packet will be fully transmitted
336 Tick finishTime;
337
338 /// The time at which the first chunk of the packet will be transmitted
339 Tick firstWordTime;
340
341 /**
342 * A virtual base opaque structure used to hold state associated
343 * with the packet but specific to the sending device (e.g., an
344 * MSHR). A pointer to this state is returned in the packet's
345 * response so that the sender can quickly look up the state
346 * needed to process it. A specific subclass would be derived
347 * from this to carry state specific to a particular sending
348 * device.
349 */
350 struct SenderState
351 {
352 virtual ~SenderState() {}
353 };
354
355 /**
356 * Object used to maintain state of a PrintReq. The senderState
357 * field of a PrintReq should always be of this type.
358 */
359 class PrintReqState : public SenderState
360 {
361 private:
362 /**
363 * An entry in the label stack.
364 */
365 struct LabelStackEntry
366 {
367 const std::string label;
368 std::string *prefix;
369 bool labelPrinted;
370 LabelStackEntry(const std::string &_label, std::string *_prefix);
371 };
372
373 typedef std::list<LabelStackEntry> LabelStack;
374 LabelStack labelStack;
375
376 std::string *curPrefixPtr;
377
378 public:
379 std::ostream &os;
380 const int verbosity;
381
382 PrintReqState(std::ostream &os, int verbosity = 0);
383 ~PrintReqState();
384
385 /**
386 * Returns the current line prefix.
387 */
388 const std::string &curPrefix() { return *curPrefixPtr; }
389
390 /**
391 * Push a label onto the label stack, and prepend the given
392 * prefix string onto the current prefix. Labels will only be
393 * printed if an object within the label's scope is printed.
394 */
395 void pushLabel(const std::string &lbl,
396 const std::string &prefix = " ");
397
398 /**
399 * Pop a label off the label stack.
400 */
401 void popLabel();
402
403 /**
404 * Print all of the pending unprinted labels on the
405 * stack. Called by printObj(), so normally not called by
406 * users unless bypassing printObj().
407 */
408 void printLabels();
409
410 /**
411 * Print a Printable object to os, because it matched the
412 * address on a PrintReq.
413 */
414 void printObj(Printable *obj);
415 };
416
417 /**
418 * This packet's sender state. Devices should use dynamic_cast<>
419 * to cast to the state appropriate to the sender. The intent of
420 * this variable is to allow a device to attach extra information
421 * to a request. A response packet must return the sender state
422 * that was attached to the original request (even if a new packet
423 * is created).
424 */
425 SenderState *senderState;
426
427 /// Return the string name of the cmd field (for debugging and
428 /// tracing).
429 const std::string &cmdString() const { return cmd.toString(); }
430
431 /// Return the index of this command.
432 inline int cmdToIndex() const { return cmd.toInt(); }
433
434 bool isRead() const { return cmd.isRead(); }
435 bool isWrite() const { return cmd.isWrite(); }
436 bool isUpgrade() const { return cmd.isUpgrade(); }
437 bool isRequest() const { return cmd.isRequest(); }
438 bool isResponse() const { return cmd.isResponse(); }
439 bool needsExclusive() const { return cmd.needsExclusive(); }
440 bool needsResponse() const { return cmd.needsResponse(); }
441 bool isInvalidate() const { return cmd.isInvalidate(); }
442 bool hasData() const { return cmd.hasData(); }
443 bool isReadWrite() const { return cmd.isReadWrite(); }
444 bool isLLSC() const { return cmd.isLLSC(); }
445 bool isError() const { return cmd.isError(); }
446 bool isPrint() const { return cmd.isPrint(); }
447 bool isFlush() const { return cmd.isFlush(); }
448
449 // Snoop flags
450 void assertMemInhibit() { flags.set(MEM_INHIBIT); }
451 bool memInhibitAsserted() { return flags.isSet(MEM_INHIBIT); }
452 void assertShared() { flags.set(SHARED); }
453 bool sharedAsserted() { return flags.isSet(SHARED); }
454
455 // Special control flags
456 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); }
457 bool isExpressSnoop() { return flags.isSet(EXPRESS_SNOOP); }
458 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); }
459 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); }
460 bool isSupplyExclusive() { return flags.isSet(SUPPLY_EXCLUSIVE); }
461 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); }
462 bool suppressFuncError() { return flags.isSet(SUPPRESS_FUNC_ERROR); }
463
464 // Network error conditions... encapsulate them as methods since
465 // their encoding keeps changing (from result field to command
466 // field, etc.)
467 void
468 setBadAddress()
469 {
470 assert(isResponse());
471 cmd = MemCmd::BadAddressError;
472 }
473
474 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; }
475 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; }
476
477 bool isSrcValid() const { return src != InvalidPortID; }
478 /// Accessor function to get the source index of the packet.
479 PortID getSrc() const { assert(isSrcValid()); return src; }
480 /// Accessor function to set the source index of the packet.
481 void setSrc(PortID _src) { src = _src; }
482 /// Reset source field, e.g. to retransmit packet on different bus.
483 void clearSrc() { src = InvalidPortID; }
484
485 bool isDestValid() const { return dest != InvalidPortID; }
486 /// Accessor function for the destination index of the packet.
487 PortID getDest() const { assert(isDestValid()); return dest; }
488 /// Accessor function to set the destination index of the packet.
489 void setDest(PortID _dest) { dest = _dest; }
490 /// Reset destination field, e.g. to turn a response into a request again.
491 void clearDest() { dest = InvalidPortID; }
492
493 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; }
494 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; }
495 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); }
496
497 /**
498 * It has been determined that the SC packet should successfully update
499 * memory. Therefore, convert this SC packet to a normal write.
500 */
501 void
502 convertScToWrite()
503 {
504 assert(isLLSC());
505 assert(isWrite());
506 cmd = MemCmd::WriteReq;
507 }
508
509 /**
510 * When ruby is in use, Ruby will monitor the cache line and thus M5
511 * phys memory should treat LL ops as normal reads.
512 */
513 void
514 convertLlToRead()
515 {
516 assert(isLLSC());
517 assert(isRead());
518 cmd = MemCmd::ReadReq;
519 }
520
521 /**
522 * Constructor. Note that a Request object must be constructed
523 * first, but the Requests's physical address and size fields need
524 * not be valid. The command must be supplied.
525 */
526 Packet(Request *_req, MemCmd _cmd)
527 : cmd(_cmd), req(_req), data(NULL),
528 src(InvalidPortID), dest(InvalidPortID),
529 bytesValidStart(0), bytesValidEnd(0),
530 time(curTick()), senderState(NULL)
531 {
532 if (req->hasPaddr()) {
533 addr = req->getPaddr();
534 flags.set(VALID_ADDR);
535 }
536 if (req->hasSize()) {
537 size = req->getSize();
538 flags.set(VALID_SIZE);
539 }
540 }
541
542 /**
543 * Alternate constructor if you are trying to create a packet with
544 * a request that is for a whole block, not the address from the
545 * req. this allows for overriding the size/addr of the req.
546 */
547 Packet(Request *_req, MemCmd _cmd, int _blkSize)
548 : cmd(_cmd), req(_req), data(NULL),
549 src(InvalidPortID), dest(InvalidPortID),
550 bytesValidStart(0), bytesValidEnd(0),
551 time(curTick()), senderState(NULL)
552 {
553 if (req->hasPaddr()) {
554 addr = req->getPaddr() & ~(_blkSize - 1);
555 flags.set(VALID_ADDR);
556 }
557 size = _blkSize;
558 flags.set(VALID_SIZE);
559 }
560
561 /**
562 * Alternate constructor for copying a packet. Copy all fields
563 * *except* if the original packet's data was dynamic, don't copy
564 * that, as we can't guarantee that the new packet's lifetime is
565 * less than that of the original packet. In this case the new
566 * packet should allocate its own data.
567 */
568 Packet(Packet *pkt, bool clearFlags = false)
569 : cmd(pkt->cmd), req(pkt->req),
570 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL),
571 addr(pkt->addr), size(pkt->size), src(pkt->src), dest(pkt->dest),
572 bytesValidStart(pkt->bytesValidStart), bytesValidEnd(pkt->bytesValidEnd),
573 time(curTick()), senderState(pkt->senderState)
574 {
575 if (!clearFlags)
576 flags.set(pkt->flags & COPY_FLAGS);
577
578 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE));
579 flags.set(pkt->flags & STATIC_DATA);
580
581 }
582
583 /**
584 * clean up packet variables
585 */
586 ~Packet()
587 {
588 // If this is a request packet for which there's no response,
589 // delete the request object here, since the requester will
590 // never get the chance.
591 if (req && isRequest() && !needsResponse())
592 delete req;
593 deleteData();
594 }
595
596 /**
597 * Reinitialize packet address and size from the associated
598 * Request object, and reset other fields that may have been
599 * modified by a previous transaction. Typically called when a
600 * statically allocated Request/Packet pair is reused for multiple
601 * transactions.
602 */
603 void
604 reinitFromRequest()
605 {
606 assert(req->hasPaddr());
607 flags = 0;
608 addr = req->getPaddr();
609 size = req->getSize();
610 time = req->time();
611
612 flags.set(VALID_ADDR|VALID_SIZE);
613 deleteData();
614 }
615
616 /**
617 * Take a request packet and modify it in place to be suitable for
618 * returning as a response to that request. The source field is
619 * turned into the destination, and subsequently cleared. Note
620 * that the latter is not necessary for atomic requests, but
621 * causes no harm as neither field is valid.
622 */
623 void
624 makeResponse()
625 {
626 assert(needsResponse());
627 assert(isRequest());
628 origCmd = cmd;
629 cmd = cmd.responseCommand();
630
631 // responses are never express, even if the snoop that
632 // triggered them was
633 flags.clear(EXPRESS_SNOOP);
634
635 dest = src;
636 clearSrc();
637 }
638
639 void
640 makeAtomicResponse()
641 {
642 makeResponse();
643 }
644
645 void
646 makeTimingResponse()
647 {
648 makeResponse();
649 }
650
651 void
652 setFunctionalResponseStatus(bool success)
653 {
654 if (!success) {
655 if (isWrite()) {
656 cmd = MemCmd::FunctionalWriteError;
657 } else {
658 cmd = MemCmd::FunctionalReadError;
659 }
660 }
661 }
662
663 void
664 setSize(unsigned size)
665 {
666 assert(!flags.isSet(VALID_SIZE));
667
668 this->size = size;
669 flags.set(VALID_SIZE);
670 }
671
672
673 /**
674 * Set the data pointer to the following value that should not be
675 * freed.
676 */
677 template <typename T>
678 void
679 dataStatic(T *p)
680 {
681 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
682 data = (PacketDataPtr)p;
683 flags.set(STATIC_DATA);
684 }
685
686 /**
687 * Set the data pointer to a value that should have delete []
688 * called on it.
689 */
690 template <typename T>
691 void
692 dataDynamicArray(T *p)
693 {
694 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
695 data = (PacketDataPtr)p;
696 flags.set(DYNAMIC_DATA|ARRAY_DATA);
697 }
698
699 /**
700 * set the data pointer to a value that should have delete called
701 * on it.
702 */
703 template <typename T>
704 void
705 dataDynamic(T *p)
706 {
707 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA));
708 data = (PacketDataPtr)p;
709 flags.set(DYNAMIC_DATA);
710 }
711
712 /**
713 * get a pointer to the data ptr.
714 */
715 template <typename T>
716 T*
717 getPtr(bool null_ok = false)
718 {
719 assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA));
720 return (T*)data;
721 }
722
723 /**
724 * return the value of what is pointed to in the packet.
725 */
726 template <typename T>
727 T get();
728
729 /**
730 * set the value in the data pointer to v.
731 */
732 template <typename T>
733 void set(T v);
734
735 /**
736 * Copy data into the packet from the provided pointer.
737 */
738 void
739 setData(uint8_t *p)
740 {
741 if (p != getPtr<uint8_t>())
742 std::memcpy(getPtr<uint8_t>(), p, getSize());
743 }
744
745 /**
746 * Copy data into the packet from the provided block pointer,
747 * which is aligned to the given block size.
748 */
749 void
750 setDataFromBlock(uint8_t *blk_data, int blkSize)
751 {
752 setData(blk_data + getOffset(blkSize));
753 }
754
755 /**
756 * Copy data from the packet to the provided block pointer, which
757 * is aligned to the given block size.
758 */
759 void
760 writeData(uint8_t *p)
761 {
762 std::memcpy(p, getPtr<uint8_t>(), getSize());
763 }
764
765 /**
766 * Copy data from the packet to the memory at the provided pointer.
767 */
768 void
769 writeDataToBlock(uint8_t *blk_data, int blkSize)
770 {
771 writeData(blk_data + getOffset(blkSize));
772 }
773
774 /**
775 * delete the data pointed to in the data pointer. Ok to call to
776 * matter how data was allocted.
777 */
778 void
779 deleteData()
780 {
781 if (flags.isSet(ARRAY_DATA))
782 delete [] data;
783 else if (flags.isSet(DYNAMIC_DATA))
784 delete data;
785
786 flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA);
787 data = NULL;
788 }
789
790 /** If there isn't data in the packet, allocate some. */
791 void
792 allocate()
793 {
794 if (data) {
795 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA));
796 return;
797 }
798
799 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA));
800 flags.set(DYNAMIC_DATA|ARRAY_DATA);
801 data = new uint8_t[getSize()];
802 }
803
804 /**
805 * Check a functional request against a memory value represented
806 * by a base/size pair and an associated data array. If the
807 * functional request is a read, it may be satisfied by the memory
808 * value. If the functional request is a write, it may update the
809 * memory value.
810 */
811 bool checkFunctional(Printable *obj, Addr base, int size, uint8_t *data);
812
813 /**
814 * Check a functional request against a memory value stored in
815 * another packet (i.e. an in-transit request or response).
816 */
817 bool
818 checkFunctional(PacketPtr other)
819 {
820 uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL;
821 return checkFunctional(other, other->getAddr(), other->getSize(),
822 data);
823 }
824
825 /**
826 * Push label for PrintReq (safe to call unconditionally).
827 */
828 void
829 pushLabel(const std::string &lbl)
830 {
831 if (isPrint())
832 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl);
833 }
834
835 /**
836 * Pop label for PrintReq (safe to call unconditionally).
837 */
838 void
839 popLabel()
840 {
841 if (isPrint())
842 safe_cast<PrintReqState*>(senderState)->popLabel();
843 }
844
845 void print(std::ostream &o, int verbosity = 0,
846 const std::string &prefix = "") const;
847};
848
849#endif //__MEM_PACKET_HH