packet.hh revision 10938
1/* 2 * Copyright (c) 2012-2015 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 CleanEvict, 91 SoftPFReq, 92 HardPFReq, 93 SoftPFResp, 94 HardPFResp, 95 WriteLineReq, 96 UpgradeReq, 97 SCUpgradeReq, // Special "weak" upgrade for StoreCond 98 UpgradeResp, 99 SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 100 UpgradeFailResp, // Valid for SCUpgradeReq only 101 ReadExReq, 102 ReadExResp, 103 ReadCleanReq, 104 ReadSharedReq, 105 LoadLockedReq, 106 StoreCondReq, 107 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 108 StoreCondResp, 109 SwapReq, 110 SwapResp, 111 MessageReq, 112 MessageResp, 113 // Error responses 114 // @TODO these should be classified as responses rather than 115 // requests; coding them as requests initially for backwards 116 // compatibility 117 InvalidDestError, // packet dest field invalid 118 BadAddressError, // memory address invalid 119 FunctionalReadError, // unable to fulfill functional read 120 FunctionalWriteError, // unable to fulfill functional write 121 // Fake simulator-only commands 122 PrintReq, // Print state matching address 123 FlushReq, //request for a cache flush 124 InvalidateReq, // request for address to be invalidated 125 InvalidateResp, 126 NUM_MEM_CMDS 127 }; 128 129 private: 130 /** 131 * List of command attributes. 132 */ 133 enum Attribute 134 { 135 IsRead, //!< Data flows from responder to requester 136 IsWrite, //!< Data flows from requester to responder 137 IsUpgrade, 138 IsInvalidate, 139 NeedsExclusive, //!< Requires exclusive copy to complete in-cache 140 IsRequest, //!< Issued by requester 141 IsResponse, //!< Issue by responder 142 NeedsResponse, //!< Requester needs response from target 143 IsSWPrefetch, 144 IsHWPrefetch, 145 IsLlsc, //!< Alpha/MIPS LL or SC access 146 HasData, //!< There is an associated payload 147 IsError, //!< Error response 148 IsPrint, //!< Print state matching address (for debugging) 149 IsFlush, //!< Flush the address from caches 150 NUM_COMMAND_ATTRIBUTES 151 }; 152 153 /** 154 * Structure that defines attributes and other data associated 155 * with a Command. 156 */ 157 struct CommandInfo 158 { 159 /// Set of attribute flags. 160 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 161 /// Corresponding response for requests; InvalidCmd if no 162 /// response is applicable. 163 const Command response; 164 /// String representation (for printing) 165 const std::string str; 166 }; 167 168 /// Array to map Command enum to associated info. 169 static const CommandInfo commandInfo[]; 170 171 private: 172 173 Command cmd; 174 175 bool 176 testCmdAttrib(MemCmd::Attribute attrib) const 177 { 178 return commandInfo[cmd].attributes[attrib] != 0; 179 } 180 181 public: 182 183 bool isRead() const { return testCmdAttrib(IsRead); } 184 bool isWrite() const { return testCmdAttrib(IsWrite); } 185 bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 186 bool isRequest() const { return testCmdAttrib(IsRequest); } 187 bool isResponse() const { return testCmdAttrib(IsResponse); } 188 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 189 bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 190 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 191 192 /** 193 * Check if this particular packet type carries payload data. Note 194 * that this does not reflect if the data pointer of the packet is 195 * valid or not. 196 */ 197 bool hasData() const { return testCmdAttrib(HasData); } 198 bool isLLSC() const { return testCmdAttrib(IsLlsc); } 199 bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 200 bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 201 bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 202 testCmdAttrib(IsHWPrefetch); } 203 bool isError() const { return testCmdAttrib(IsError); } 204 bool isPrint() const { return testCmdAttrib(IsPrint); } 205 bool isFlush() const { return testCmdAttrib(IsFlush); } 206 207 const Command 208 responseCommand() const 209 { 210 return commandInfo[cmd].response; 211 } 212 213 /// Return the string to a cmd given by idx. 214 const std::string &toString() const { return commandInfo[cmd].str; } 215 int toInt() const { return (int)cmd; } 216 217 MemCmd(Command _cmd) : cmd(_cmd) { } 218 MemCmd(int _cmd) : cmd((Command)_cmd) { } 219 MemCmd() : cmd(InvalidCmd) { } 220 221 bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 222 bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 223}; 224 225/** 226 * A Packet is used to encapsulate a transfer between two objects in 227 * the memory system (e.g., the L1 and L2 cache). (In contrast, a 228 * single Request travels all the way from the requester to the 229 * ultimate destination and back, possibly being conveyed by several 230 * different Packets along the way.) 231 */ 232class Packet : public Printable 233{ 234 public: 235 typedef uint32_t FlagsType; 236 typedef ::Flags<FlagsType> Flags; 237 238 private: 239 240 enum : FlagsType { 241 // Flags to transfer across when copying a packet 242 COPY_FLAGS = 0x0000000F, 243 244 SHARED = 0x00000001, 245 // Special control flags 246 /// Special timing-mode atomic snoop for multi-level coherence. 247 EXPRESS_SNOOP = 0x00000002, 248 /// Does supplier have exclusive copy? 249 /// Useful for multi-level coherence. 250 SUPPLY_EXCLUSIVE = 0x00000004, 251 // Snoop response flags 252 MEM_INHIBIT = 0x00000008, 253 254 /// Are the 'addr' and 'size' fields valid? 255 VALID_ADDR = 0x00000100, 256 VALID_SIZE = 0x00000200, 257 258 /// Is the data pointer set to a value that shouldn't be freed 259 /// when the packet is destroyed? 260 STATIC_DATA = 0x00001000, 261 /// The data pointer points to a value that should be freed when 262 /// the packet is destroyed. The pointer is assumed to be pointing 263 /// to an array, and delete [] is consequently called 264 DYNAMIC_DATA = 0x00002000, 265 266 /// suppress the error if this packet encounters a functional 267 /// access failure. 268 SUPPRESS_FUNC_ERROR = 0x00008000, 269 270 // Signal block present to squash prefetch and cache evict packets 271 // through express snoop flag 272 BLOCK_CACHED = 0x00010000 273 }; 274 275 Flags flags; 276 277 public: 278 typedef MemCmd::Command Command; 279 280 /// The command field of the packet. 281 MemCmd cmd; 282 283 /// A pointer to the original request. 284 const RequestPtr req; 285 286 private: 287 /** 288 * A pointer to the data being transfered. It can be differnt 289 * sizes at each level of the heirarchy so it belongs in the 290 * packet, not request. This may or may not be populated when a 291 * responder recieves the packet. If not populated it memory should 292 * be allocated. 293 */ 294 PacketDataPtr data; 295 296 /// The address of the request. This address could be virtual or 297 /// physical, depending on the system configuration. 298 Addr addr; 299 300 /// True if the request targets the secure memory space. 301 bool _isSecure; 302 303 /// The size of the request or transfer. 304 unsigned size; 305 306 /** 307 * Track the bytes found that satisfy a functional read. 308 */ 309 std::vector<bool> bytesValid; 310 311 public: 312 313 /** 314 * The extra delay from seeing the packet until the header is 315 * transmitted. This delay is used to communicate the crossbar 316 * forwarding latency to the neighbouring object (e.g. a cache) 317 * that actually makes the packet wait. As the delay is relative, 318 * a 32-bit unsigned should be sufficient. 319 */ 320 uint32_t headerDelay; 321 322 /** 323 * The extra pipelining delay from seeing the packet until the end of 324 * payload is transmitted by the component that provided it (if 325 * any). This includes the header delay. Similar to the header 326 * delay, this is used to make up for the fact that the 327 * crossbar does not make the packet wait. As the delay is 328 * relative, a 32-bit unsigned should be sufficient. 329 */ 330 uint32_t payloadDelay; 331 332 /** 333 * A virtual base opaque structure used to hold state associated 334 * with the packet (e.g., an MSHR), specific to a MemObject that 335 * sees the packet. A pointer to this state is returned in the 336 * packet's response so that the MemObject in question can quickly 337 * look up the state needed to process it. A specific subclass 338 * would be derived from this to carry state specific to a 339 * particular sending device. 340 * 341 * As multiple MemObjects may add their SenderState throughout the 342 * memory system, the SenderStates create a stack, where a 343 * MemObject can add a new Senderstate, as long as the 344 * predecessing SenderState is restored when the response comes 345 * back. For this reason, the predecessor should always be 346 * populated with the current SenderState of a packet before 347 * modifying the senderState field in the request packet. 348 */ 349 struct SenderState 350 { 351 SenderState* predecessor; 352 SenderState() : predecessor(NULL) {} 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 /** 429 * Push a new sender state to the packet and make the current 430 * sender state the predecessor of the new one. This should be 431 * prefered over direct manipulation of the senderState member 432 * variable. 433 * 434 * @param sender_state SenderState to push at the top of the stack 435 */ 436 void pushSenderState(SenderState *sender_state); 437 438 /** 439 * Pop the top of the state stack and return a pointer to it. This 440 * assumes the current sender state is not NULL. This should be 441 * preferred over direct manipulation of the senderState member 442 * variable. 443 * 444 * @return The current top of the stack 445 */ 446 SenderState *popSenderState(); 447 448 /** 449 * Go through the sender state stack and return the first instance 450 * that is of type T (as determined by a dynamic_cast). If there 451 * is no sender state of type T, NULL is returned. 452 * 453 * @return The topmost state of type T 454 */ 455 template <typename T> 456 T * findNextSenderState() const 457 { 458 T *t = NULL; 459 SenderState* sender_state = senderState; 460 while (t == NULL && sender_state != NULL) { 461 t = dynamic_cast<T*>(sender_state); 462 sender_state = sender_state->predecessor; 463 } 464 return t; 465 } 466 467 /// Return the string name of the cmd field (for debugging and 468 /// tracing). 469 const std::string &cmdString() const { return cmd.toString(); } 470 471 /// Return the index of this command. 472 inline int cmdToIndex() const { return cmd.toInt(); } 473 474 bool isRead() const { return cmd.isRead(); } 475 bool isWrite() const { return cmd.isWrite(); } 476 bool isUpgrade() const { return cmd.isUpgrade(); } 477 bool isRequest() const { return cmd.isRequest(); } 478 bool isResponse() const { return cmd.isResponse(); } 479 bool needsExclusive() const { return cmd.needsExclusive(); } 480 bool needsResponse() const { return cmd.needsResponse(); } 481 bool isInvalidate() const { return cmd.isInvalidate(); } 482 bool hasData() const { return cmd.hasData(); } 483 bool isLLSC() const { return cmd.isLLSC(); } 484 bool isError() const { return cmd.isError(); } 485 bool isPrint() const { return cmd.isPrint(); } 486 bool isFlush() const { return cmd.isFlush(); } 487 488 // Snoop flags 489 void assertMemInhibit() 490 { 491 assert(isRequest()); 492 assert(!flags.isSet(MEM_INHIBIT)); 493 flags.set(MEM_INHIBIT); 494 } 495 bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 496 void assertShared() { flags.set(SHARED); } 497 bool sharedAsserted() const { return flags.isSet(SHARED); } 498 499 // Special control flags 500 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 501 bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 502 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 503 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 504 bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 505 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 506 bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 507 void setBlockCached() { flags.set(BLOCK_CACHED); } 508 bool isBlockCached() const { return flags.isSet(BLOCK_CACHED); } 509 void clearBlockCached() { flags.clear(BLOCK_CACHED); } 510 511 // Network error conditions... encapsulate them as methods since 512 // their encoding keeps changing (from result field to command 513 // field, etc.) 514 void 515 setBadAddress() 516 { 517 assert(isResponse()); 518 cmd = MemCmd::BadAddressError; 519 } 520 521 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 522 523 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 524 /** 525 * Update the address of this packet mid-transaction. This is used 526 * by the address mapper to change an already set address to a new 527 * one based on the system configuration. It is intended to remap 528 * an existing address, so it asserts that the current address is 529 * valid. 530 */ 531 void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 532 533 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 534 535 Addr getOffset(unsigned int blk_size) const 536 { 537 return getAddr() & Addr(blk_size - 1); 538 } 539 540 Addr getBlockAddr(unsigned int blk_size) const 541 { 542 return getAddr() & ~(Addr(blk_size - 1)); 543 } 544 545 bool isSecure() const 546 { 547 assert(flags.isSet(VALID_ADDR)); 548 return _isSecure; 549 } 550 551 /** 552 * It has been determined that the SC packet should successfully update 553 * memory. Therefore, convert this SC packet to a normal write. 554 */ 555 void 556 convertScToWrite() 557 { 558 assert(isLLSC()); 559 assert(isWrite()); 560 cmd = MemCmd::WriteReq; 561 } 562 563 /** 564 * When ruby is in use, Ruby will monitor the cache line and the 565 * phys memory should treat LL ops as normal reads. 566 */ 567 void 568 convertLlToRead() 569 { 570 assert(isLLSC()); 571 assert(isRead()); 572 cmd = MemCmd::ReadReq; 573 } 574 575 /** 576 * Constructor. Note that a Request object must be constructed 577 * first, but the Requests's physical address and size fields need 578 * not be valid. The command must be supplied. 579 */ 580 Packet(const RequestPtr _req, MemCmd _cmd) 581 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 582 size(0), headerDelay(0), payloadDelay(0), 583 senderState(NULL) 584 { 585 if (req->hasPaddr()) { 586 addr = req->getPaddr(); 587 flags.set(VALID_ADDR); 588 _isSecure = req->isSecure(); 589 } 590 if (req->hasSize()) { 591 size = req->getSize(); 592 flags.set(VALID_SIZE); 593 } 594 } 595 596 /** 597 * Alternate constructor if you are trying to create a packet with 598 * a request that is for a whole block, not the address from the 599 * req. this allows for overriding the size/addr of the req. 600 */ 601 Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 602 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 603 headerDelay(0), payloadDelay(0), 604 senderState(NULL) 605 { 606 if (req->hasPaddr()) { 607 addr = req->getPaddr() & ~(_blkSize - 1); 608 flags.set(VALID_ADDR); 609 _isSecure = req->isSecure(); 610 } 611 size = _blkSize; 612 flags.set(VALID_SIZE); 613 } 614 615 /** 616 * Alternate constructor for copying a packet. Copy all fields 617 * *except* if the original packet's data was dynamic, don't copy 618 * that, as we can't guarantee that the new packet's lifetime is 619 * less than that of the original packet. In this case the new 620 * packet should allocate its own data. 621 */ 622 Packet(const PacketPtr pkt, bool clear_flags, bool alloc_data) 623 : cmd(pkt->cmd), req(pkt->req), 624 data(nullptr), 625 addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 626 bytesValid(pkt->bytesValid), 627 headerDelay(pkt->headerDelay), 628 payloadDelay(pkt->payloadDelay), 629 senderState(pkt->senderState) 630 { 631 if (!clear_flags) 632 flags.set(pkt->flags & COPY_FLAGS); 633 634 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 635 636 // should we allocate space for data, or not, the express 637 // snoops do not need to carry any data as they only serve to 638 // co-ordinate state changes 639 if (alloc_data) { 640 // even if asked to allocate data, if the original packet 641 // holds static data, then the sender will not be doing 642 // any memcpy on receiving the response, thus we simply 643 // carry the pointer forward 644 if (pkt->flags.isSet(STATIC_DATA)) { 645 data = pkt->data; 646 flags.set(STATIC_DATA); 647 } else { 648 allocate(); 649 } 650 } 651 } 652 653 /** 654 * Generate the appropriate read MemCmd based on the Request flags. 655 */ 656 static MemCmd 657 makeReadCmd(const RequestPtr req) 658 { 659 if (req->isLLSC()) 660 return MemCmd::LoadLockedReq; 661 else if (req->isPrefetch()) 662 return MemCmd::SoftPFReq; 663 else 664 return MemCmd::ReadReq; 665 } 666 667 /** 668 * Generate the appropriate write MemCmd based on the Request flags. 669 */ 670 static MemCmd 671 makeWriteCmd(const RequestPtr req) 672 { 673 if (req->isLLSC()) 674 return MemCmd::StoreCondReq; 675 else if (req->isSwap()) 676 return MemCmd::SwapReq; 677 else 678 return MemCmd::WriteReq; 679 } 680 681 /** 682 * Constructor-like methods that return Packets based on Request objects. 683 * Fine-tune the MemCmd type if it's not a vanilla read or write. 684 */ 685 static PacketPtr 686 createRead(const RequestPtr req) 687 { 688 return new Packet(req, makeReadCmd(req)); 689 } 690 691 static PacketPtr 692 createWrite(const RequestPtr req) 693 { 694 return new Packet(req, makeWriteCmd(req)); 695 } 696 697 /** 698 * clean up packet variables 699 */ 700 ~Packet() 701 { 702 // Delete the request object if this is a request packet which 703 // does not need a response, because the requester will not get 704 // a chance. If the request packet needs a response then the 705 // request will be deleted on receipt of the response 706 // packet. We also make sure to never delete the request for 707 // express snoops, even for cases when responses are not 708 // needed (CleanEvict and Writeback), since the snoop packet 709 // re-uses the same request. 710 if (req && isRequest() && !needsResponse() && 711 !isExpressSnoop()) { 712 delete req; 713 } 714 deleteData(); 715 } 716 717 /** 718 * Take a request packet and modify it in place to be suitable for 719 * returning as a response to that request. 720 */ 721 void 722 makeResponse() 723 { 724 assert(needsResponse()); 725 assert(isRequest()); 726 cmd = cmd.responseCommand(); 727 728 // responses are never express, even if the snoop that 729 // triggered them was 730 flags.clear(EXPRESS_SNOOP); 731 } 732 733 void 734 makeAtomicResponse() 735 { 736 makeResponse(); 737 } 738 739 void 740 makeTimingResponse() 741 { 742 makeResponse(); 743 } 744 745 void 746 setFunctionalResponseStatus(bool success) 747 { 748 if (!success) { 749 if (isWrite()) { 750 cmd = MemCmd::FunctionalWriteError; 751 } else { 752 cmd = MemCmd::FunctionalReadError; 753 } 754 } 755 } 756 757 void 758 setSize(unsigned size) 759 { 760 assert(!flags.isSet(VALID_SIZE)); 761 762 this->size = size; 763 flags.set(VALID_SIZE); 764 } 765 766 767 /** 768 * Set the data pointer to the following value that should not be 769 * freed. Static data allows us to do a single memcpy even if 770 * multiple packets are required to get from source to destination 771 * and back. In essence the pointer is set calling dataStatic on 772 * the original packet, and whenever this packet is copied and 773 * forwarded the same pointer is passed on. When a packet 774 * eventually reaches the destination holding the data, it is 775 * copied once into the location originally set. On the way back 776 * to the source, no copies are necessary. 777 */ 778 template <typename T> 779 void 780 dataStatic(T *p) 781 { 782 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 783 data = (PacketDataPtr)p; 784 flags.set(STATIC_DATA); 785 } 786 787 /** 788 * Set the data pointer to the following value that should not be 789 * freed. This version of the function allows the pointer passed 790 * to us to be const. To avoid issues down the line we cast the 791 * constness away, the alternative would be to keep both a const 792 * and non-const data pointer and cleverly choose between 793 * them. Note that this is only allowed for static data. 794 */ 795 template <typename T> 796 void 797 dataStaticConst(const T *p) 798 { 799 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 800 data = const_cast<PacketDataPtr>(p); 801 flags.set(STATIC_DATA); 802 } 803 804 /** 805 * Set the data pointer to a value that should have delete [] 806 * called on it. Dynamic data is local to this packet, and as the 807 * packet travels from source to destination, forwarded packets 808 * will allocate their own data. When a packet reaches the final 809 * destination it will populate the dynamic data of that specific 810 * packet, and on the way back towards the source, memcpy will be 811 * invoked in every step where a new packet was created e.g. in 812 * the caches. Ultimately when the response reaches the source a 813 * final memcpy is needed to extract the data from the packet 814 * before it is deallocated. 815 */ 816 template <typename T> 817 void 818 dataDynamic(T *p) 819 { 820 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 821 data = (PacketDataPtr)p; 822 flags.set(DYNAMIC_DATA); 823 } 824 825 /** 826 * get a pointer to the data ptr. 827 */ 828 template <typename T> 829 T* 830 getPtr() 831 { 832 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 833 return (T*)data; 834 } 835 836 template <typename T> 837 const T* 838 getConstPtr() const 839 { 840 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 841 return (const T*)data; 842 } 843 844 /** 845 * return the value of what is pointed to in the packet. 846 */ 847 template <typename T> 848 T get() const; 849 850 /** 851 * set the value in the data pointer to v. 852 */ 853 template <typename T> 854 void set(T v); 855 856 /** 857 * Copy data into the packet from the provided pointer. 858 */ 859 void 860 setData(const uint8_t *p) 861 { 862 // we should never be copying data onto itself, which means we 863 // must idenfity packets with static data, as they carry the 864 // same pointer from source to destination and back 865 assert(p != getPtr<uint8_t>() || flags.isSet(STATIC_DATA)); 866 867 if (p != getPtr<uint8_t>()) 868 // for packet with allocated dynamic data, we copy data from 869 // one to the other, e.g. a forwarded response to a response 870 std::memcpy(getPtr<uint8_t>(), p, getSize()); 871 } 872 873 /** 874 * Copy data into the packet from the provided block pointer, 875 * which is aligned to the given block size. 876 */ 877 void 878 setDataFromBlock(const uint8_t *blk_data, int blkSize) 879 { 880 setData(blk_data + getOffset(blkSize)); 881 } 882 883 /** 884 * Copy data from the packet to the provided block pointer, which 885 * is aligned to the given block size. 886 */ 887 void 888 writeData(uint8_t *p) const 889 { 890 std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 891 } 892 893 /** 894 * Copy data from the packet to the memory at the provided pointer. 895 */ 896 void 897 writeDataToBlock(uint8_t *blk_data, int blkSize) const 898 { 899 writeData(blk_data + getOffset(blkSize)); 900 } 901 902 /** 903 * delete the data pointed to in the data pointer. Ok to call to 904 * matter how data was allocted. 905 */ 906 void 907 deleteData() 908 { 909 if (flags.isSet(DYNAMIC_DATA)) 910 delete [] data; 911 912 flags.clear(STATIC_DATA|DYNAMIC_DATA); 913 data = NULL; 914 } 915 916 /** Allocate memory for the packet. */ 917 void 918 allocate() 919 { 920 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 921 flags.set(DYNAMIC_DATA); 922 data = new uint8_t[getSize()]; 923 } 924 925 /** 926 * Check a functional request against a memory value stored in 927 * another packet (i.e. an in-transit request or 928 * response). Returns true if the current packet is a read, and 929 * the other packet provides the data, which is then copied to the 930 * current packet. If the current packet is a write, and the other 931 * packet intersects this one, then we update the data 932 * accordingly. 933 */ 934 bool 935 checkFunctional(PacketPtr other) 936 { 937 // all packets that are carrying a payload should have a valid 938 // data pointer 939 return checkFunctional(other, other->getAddr(), other->isSecure(), 940 other->getSize(), 941 other->hasData() ? 942 other->getPtr<uint8_t>() : NULL); 943 } 944 945 /** 946 * Is this request notification of a clean or dirty eviction from the cache. 947 **/ 948 bool 949 evictingBlock() const 950 { 951 return (cmd == MemCmd::Writeback || 952 cmd == MemCmd::CleanEvict); 953 } 954 955 /** 956 * Does the request need to check for cached copies of the same block 957 * in the memory hierarchy above. 958 **/ 959 bool 960 mustCheckAbove() const 961 { 962 return (cmd == MemCmd::HardPFReq || 963 evictingBlock()); 964 } 965 966 /** 967 * Check a functional request against a memory value represented 968 * by a base/size pair and an associated data array. If the 969 * current packet is a read, it may be satisfied by the memory 970 * value. If the current packet is a write, it may update the 971 * memory value. 972 */ 973 bool 974 checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 975 uint8_t *_data); 976 977 /** 978 * Push label for PrintReq (safe to call unconditionally). 979 */ 980 void 981 pushLabel(const std::string &lbl) 982 { 983 if (isPrint()) 984 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 985 } 986 987 /** 988 * Pop label for PrintReq (safe to call unconditionally). 989 */ 990 void 991 popLabel() 992 { 993 if (isPrint()) 994 safe_cast<PrintReqState*>(senderState)->popLabel(); 995 } 996 997 void print(std::ostream &o, int verbosity = 0, 998 const std::string &prefix = "") const; 999 1000 /** 1001 * A no-args wrapper of print(std::ostream...) 1002 * meant to be invoked from DPRINTFs 1003 * avoiding string overheads in fast mode 1004 * @return string with the request's type and start<->end addresses 1005 */ 1006 std::string print() const; 1007}; 1008 1009#endif //__MEM_PACKET_HH 1010