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