packet.hh revision 10570
1/* 2 * Copyright (c) 2012-2014 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, 95 WriteInvalidateResp, 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 LoadLockedReq, 104 StoreCondReq, 105 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 106 StoreCondResp, 107 SwapReq, 108 SwapResp, 109 MessageReq, 110 MessageResp, 111 // Error responses 112 // @TODO these should be classified as responses rather than 113 // requests; coding them as requests initially for backwards 114 // compatibility 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 123 NUM_MEM_CMDS 124 }; 125 126 private: 127 /** 128 * List of command attributes. 129 */ 130 enum Attribute 131 { 132 IsRead, //!< Data flows from responder to requester 133 IsWrite, //!< Data flows from requester to responder 134 IsUpgrade, 135 IsInvalidate, 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 140 IsSWPrefetch, 141 IsHWPrefetch, 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 148 }; 149 150 /** 151 * Structure that defines attributes and other data associated 152 * with a Command. 153 */ 154 struct CommandInfo 155 { 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; 163 }; 164 165 /// Array to map Command enum to associated info. 166 static const CommandInfo commandInfo[]; 167 168 private: 169 170 Command cmd; 171 172 bool 173 testCmdAttrib(MemCmd::Attribute attrib) const 174 { 175 return commandInfo[cmd].attributes[attrib] != 0; 176 } 177 178 public: 179 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 189 /** 190 * Check if this particular packet type carries payload data. Note 191 * that this does not reflect if the data pointer of the packet is 192 * valid or not. 193 */ 194 bool hasData() const { return testCmdAttrib(HasData); } 195 bool isLLSC() const { return testCmdAttrib(IsLlsc); } 196 bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 197 bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 198 bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 199 testCmdAttrib(IsHWPrefetch); } 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. The pointer is assumed to be pointing 257 /// to an array, and delete [] is consequently called 258 static const FlagsType DYNAMIC_DATA = 0x00002000; 259 /// suppress the error if this packet encounters a functional 260 /// access failure. 261 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 262 // Signal prefetch squash through express snoop flag 263 static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; 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 const 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 /// True if the request targets the secure memory space. 291 bool _isSecure; 292 293 /// The size of the request or transfer. 294 unsigned size; 295 296 /** 297 * Source port identifier set on a request packet to enable 298 * appropriate routing of the responses. The source port 299 * identifier is set by any multiplexing component, e.g. a 300 * crossbar, as the timing responses need this information to be 301 * routed back to the appropriate port at a later point in 302 * time. The field can be updated (over-written) as the request 303 * packet passes through additional multiplexing components, and 304 * it is their responsibility to remember the original source port 305 * identifier, for example by using an appropriate sender 306 * state. The latter is done in the cache and bridge. 307 */ 308 PortID src; 309 310 /** 311 * Destination port identifier that is present on all response 312 * packets that passed through a multiplexing component as a 313 * request packet. The source port identifier is turned into a 314 * destination port identifier when the packet is turned into a 315 * response, and the destination is used, e.g. by the crossbar, to 316 * select the appropriate path through the interconnect. 317 */ 318 PortID dest; 319 320 /** 321 * The original value of the command field. Only valid when the 322 * current command field is an error condition; in that case, the 323 * previous contents of the command field are copied here. This 324 * field is *not* set on non-error responses. 325 */ 326 MemCmd origCmd; 327 328 /** 329 * These values specify the range of bytes found that satisfy a 330 * functional read. 331 */ 332 uint16_t bytesValidStart; 333 uint16_t bytesValidEnd; 334 335 public: 336 337 /** 338 * The extra delay from seeing the packet until the first word is 339 * transmitted. This delay is used to communicate the crossbar 340 * forwarding latency to the neighbouring object (e.g. a cache) 341 * that actually makes the packet wait. As the delay is relative, 342 * a 32-bit unsigned should be sufficient. 343 */ 344 uint32_t firstWordDelay; 345 346 /** 347 * The extra pipelining delay from seeing the packet until the 348 * last word is transmitted by the component that provided it (if 349 * any). This includes the first word delay. Similar to the first 350 * word delay, this is used to make up for the fact that the 351 * crossbar does not make the packet wait. As the delay is 352 * relative, a 32-bit unsigned should be sufficient. 353 */ 354 uint32_t lastWordDelay; 355 356 /** 357 * A virtual base opaque structure used to hold state associated 358 * with the packet (e.g., an MSHR), specific to a MemObject that 359 * sees the packet. A pointer to this state is returned in the 360 * packet's response so that the MemObject in question can quickly 361 * look up the state needed to process it. A specific subclass 362 * would be derived from this to carry state specific to a 363 * particular sending device. 364 * 365 * As multiple MemObjects may add their SenderState throughout the 366 * memory system, the SenderStates create a stack, where a 367 * MemObject can add a new Senderstate, as long as the 368 * predecessing SenderState is restored when the response comes 369 * back. For this reason, the predecessor should always be 370 * populated with the current SenderState of a packet before 371 * modifying the senderState field in the request packet. 372 */ 373 struct SenderState 374 { 375 SenderState* predecessor; 376 SenderState() : predecessor(NULL) {} 377 virtual ~SenderState() {} 378 }; 379 380 /** 381 * Object used to maintain state of a PrintReq. The senderState 382 * field of a PrintReq should always be of this type. 383 */ 384 class PrintReqState : public SenderState 385 { 386 private: 387 /** 388 * An entry in the label stack. 389 */ 390 struct LabelStackEntry 391 { 392 const std::string label; 393 std::string *prefix; 394 bool labelPrinted; 395 LabelStackEntry(const std::string &_label, std::string *_prefix); 396 }; 397 398 typedef std::list<LabelStackEntry> LabelStack; 399 LabelStack labelStack; 400 401 std::string *curPrefixPtr; 402 403 public: 404 std::ostream &os; 405 const int verbosity; 406 407 PrintReqState(std::ostream &os, int verbosity = 0); 408 ~PrintReqState(); 409 410 /** 411 * Returns the current line prefix. 412 */ 413 const std::string &curPrefix() { return *curPrefixPtr; } 414 415 /** 416 * Push a label onto the label stack, and prepend the given 417 * prefix string onto the current prefix. Labels will only be 418 * printed if an object within the label's scope is printed. 419 */ 420 void pushLabel(const std::string &lbl, 421 const std::string &prefix = " "); 422 423 /** 424 * Pop a label off the label stack. 425 */ 426 void popLabel(); 427 428 /** 429 * Print all of the pending unprinted labels on the 430 * stack. Called by printObj(), so normally not called by 431 * users unless bypassing printObj(). 432 */ 433 void printLabels(); 434 435 /** 436 * Print a Printable object to os, because it matched the 437 * address on a PrintReq. 438 */ 439 void printObj(Printable *obj); 440 }; 441 442 /** 443 * This packet's sender state. Devices should use dynamic_cast<> 444 * to cast to the state appropriate to the sender. The intent of 445 * this variable is to allow a device to attach extra information 446 * to a request. A response packet must return the sender state 447 * that was attached to the original request (even if a new packet 448 * is created). 449 */ 450 SenderState *senderState; 451 452 /** 453 * Push a new sender state to the packet and make the current 454 * sender state the predecessor of the new one. This should be 455 * prefered over direct manipulation of the senderState member 456 * variable. 457 * 458 * @param sender_state SenderState to push at the top of the stack 459 */ 460 void pushSenderState(SenderState *sender_state); 461 462 /** 463 * Pop the top of the state stack and return a pointer to it. This 464 * assumes the current sender state is not NULL. This should be 465 * preferred over direct manipulation of the senderState member 466 * variable. 467 * 468 * @return The current top of the stack 469 */ 470 SenderState *popSenderState(); 471 472 /** 473 * Go through the sender state stack and return the first instance 474 * that is of type T (as determined by a dynamic_cast). If there 475 * is no sender state of type T, NULL is returned. 476 * 477 * @return The topmost state of type T 478 */ 479 template <typename T> 480 T * findNextSenderState() const 481 { 482 T *t = NULL; 483 SenderState* sender_state = senderState; 484 while (t == NULL && sender_state != NULL) { 485 t = dynamic_cast<T*>(sender_state); 486 sender_state = sender_state->predecessor; 487 } 488 return t; 489 } 490 491 /// Return the string name of the cmd field (for debugging and 492 /// tracing). 493 const std::string &cmdString() const { return cmd.toString(); } 494 495 /// Return the index of this command. 496 inline int cmdToIndex() const { return cmd.toInt(); } 497 498 bool isRead() const { return cmd.isRead(); } 499 bool isWrite() const { return cmd.isWrite(); } 500 bool isUpgrade() const { return cmd.isUpgrade(); } 501 bool isRequest() const { return cmd.isRequest(); } 502 bool isResponse() const { return cmd.isResponse(); } 503 bool needsExclusive() const { return cmd.needsExclusive(); } 504 bool needsResponse() const { return cmd.needsResponse(); } 505 bool isInvalidate() const { return cmd.isInvalidate(); } 506 bool hasData() const { return cmd.hasData(); } 507 bool isLLSC() const { return cmd.isLLSC(); } 508 bool isError() const { return cmd.isError(); } 509 bool isPrint() const { return cmd.isPrint(); } 510 bool isFlush() const { return cmd.isFlush(); } 511 512 // Snoop flags 513 void assertMemInhibit() 514 { 515 assert(isRequest()); 516 assert(!flags.isSet(MEM_INHIBIT)); 517 flags.set(MEM_INHIBIT); 518 } 519 bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 520 void assertShared() { flags.set(SHARED); } 521 bool sharedAsserted() const { return flags.isSet(SHARED); } 522 523 // Special control flags 524 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 525 bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 526 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 527 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 528 bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 529 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 530 bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 531 void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } 532 bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } 533 534 // Network error conditions... encapsulate them as methods since 535 // their encoding keeps changing (from result field to command 536 // field, etc.) 537 void 538 setBadAddress() 539 { 540 assert(isResponse()); 541 cmd = MemCmd::BadAddressError; 542 } 543 544 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 545 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 546 547 bool isSrcValid() const { return src != InvalidPortID; } 548 /// Accessor function to get the source index of the packet. 549 PortID getSrc() const { assert(isSrcValid()); return src; } 550 /// Accessor function to set the source index of the packet. 551 void setSrc(PortID _src) { src = _src; } 552 553 bool isDestValid() const { return dest != InvalidPortID; } 554 /// Accessor function for the destination index of the packet. 555 PortID getDest() const { assert(isDestValid()); return dest; } 556 /// Accessor function to set the destination index of the packet. 557 void setDest(PortID _dest) { dest = _dest; } 558 /// Reset destination field, e.g. to turn a response into a request again. 559 void clearDest() { dest = InvalidPortID; } 560 561 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 562 /** 563 * Update the address of this packet mid-transaction. This is used 564 * by the address mapper to change an already set address to a new 565 * one based on the system configuration. It is intended to remap 566 * an existing address, so it asserts that the current address is 567 * valid. 568 */ 569 void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 570 571 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 572 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 573 574 bool isSecure() const 575 { 576 assert(flags.isSet(VALID_ADDR)); 577 return _isSecure; 578 } 579 580 /** 581 * It has been determined that the SC packet should successfully update 582 * memory. Therefore, convert this SC packet to a normal write. 583 */ 584 void 585 convertScToWrite() 586 { 587 assert(isLLSC()); 588 assert(isWrite()); 589 cmd = MemCmd::WriteReq; 590 } 591 592 /** 593 * When ruby is in use, Ruby will monitor the cache line and thus M5 594 * phys memory should treat LL ops as normal reads. 595 */ 596 void 597 convertLlToRead() 598 { 599 assert(isLLSC()); 600 assert(isRead()); 601 cmd = MemCmd::ReadReq; 602 } 603 604 /** 605 * Constructor. Note that a Request object must be constructed 606 * first, but the Requests's physical address and size fields need 607 * not be valid. The command must be supplied. 608 */ 609 Packet(const RequestPtr _req, MemCmd _cmd) 610 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 611 size(0), src(InvalidPortID), dest(InvalidPortID), 612 bytesValidStart(0), bytesValidEnd(0), 613 firstWordDelay(0), lastWordDelay(0), 614 senderState(NULL) 615 { 616 if (req->hasPaddr()) { 617 addr = req->getPaddr(); 618 flags.set(VALID_ADDR); 619 _isSecure = req->isSecure(); 620 } 621 if (req->hasSize()) { 622 size = req->getSize(); 623 flags.set(VALID_SIZE); 624 } 625 } 626 627 /** 628 * Alternate constructor if you are trying to create a packet with 629 * a request that is for a whole block, not the address from the 630 * req. this allows for overriding the size/addr of the req. 631 */ 632 Packet(const RequestPtr _req, MemCmd _cmd, int _blkSize) 633 : cmd(_cmd), req(_req), data(nullptr), addr(0), _isSecure(false), 634 src(InvalidPortID), dest(InvalidPortID), 635 bytesValidStart(0), bytesValidEnd(0), 636 firstWordDelay(0), lastWordDelay(0), 637 senderState(NULL) 638 { 639 if (req->hasPaddr()) { 640 addr = req->getPaddr() & ~(_blkSize - 1); 641 flags.set(VALID_ADDR); 642 _isSecure = req->isSecure(); 643 } 644 size = _blkSize; 645 flags.set(VALID_SIZE); 646 } 647 648 /** 649 * Alternate constructor for copying a packet. Copy all fields 650 * *except* if the original packet's data was dynamic, don't copy 651 * that, as we can't guarantee that the new packet's lifetime is 652 * less than that of the original packet. In this case the new 653 * packet should allocate its own data. 654 */ 655 Packet(PacketPtr pkt, bool clearFlags = false) 656 : cmd(pkt->cmd), req(pkt->req), 657 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), 658 addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 659 src(pkt->src), dest(pkt->dest), 660 bytesValidStart(pkt->bytesValidStart), 661 bytesValidEnd(pkt->bytesValidEnd), 662 firstWordDelay(pkt->firstWordDelay), 663 lastWordDelay(pkt->lastWordDelay), 664 senderState(pkt->senderState) 665 { 666 if (!clearFlags) 667 flags.set(pkt->flags & COPY_FLAGS); 668 669 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 670 flags.set(pkt->flags & STATIC_DATA); 671 672 // if we did not copy the static data pointer, allocate data 673 // dynamically instead 674 if (!data) 675 allocate(); 676 } 677 678 /** 679 * Change the packet type based on request type. 680 */ 681 void 682 refineCommand() 683 { 684 if (cmd == MemCmd::ReadReq) { 685 if (req->isLLSC()) { 686 cmd = MemCmd::LoadLockedReq; 687 } else if (req->isPrefetch()) { 688 cmd = MemCmd::SoftPFReq; 689 } 690 } else if (cmd == MemCmd::WriteReq) { 691 if (req->isLLSC()) { 692 cmd = MemCmd::StoreCondReq; 693 } else if (req->isSwap()) { 694 cmd = MemCmd::SwapReq; 695 } 696 } 697 } 698 699 /** 700 * Constructor-like methods that return Packets based on Request objects. 701 * Will call refineCommand() to fine-tune the Packet type if it's not a 702 * vanilla read or write. 703 */ 704 static PacketPtr 705 createRead(const RequestPtr req) 706 { 707 PacketPtr pkt = new Packet(req, MemCmd::ReadReq); 708 pkt->refineCommand(); 709 return pkt; 710 } 711 712 static PacketPtr 713 createWrite(const RequestPtr req) 714 { 715 PacketPtr pkt = new Packet(req, MemCmd::WriteReq); 716 pkt->refineCommand(); 717 return pkt; 718 } 719 720 /** 721 * clean up packet variables 722 */ 723 ~Packet() 724 { 725 // If this is a request packet for which there's no response, 726 // delete the request object here, since the requester will 727 // never get the chance. 728 if (req && isRequest() && !needsResponse()) 729 delete req; 730 deleteData(); 731 } 732 733 /** 734 * Take a request packet and modify it in place to be suitable for 735 * returning as a response to that request. The source field is 736 * turned into the destination, and subsequently cleared. Note 737 * that the latter is not necessary for atomic requests, but 738 * causes no harm as neither field is valid. 739 */ 740 void 741 makeResponse() 742 { 743 assert(needsResponse()); 744 assert(isRequest()); 745 origCmd = cmd; 746 cmd = cmd.responseCommand(); 747 748 // responses are never express, even if the snoop that 749 // triggered them was 750 flags.clear(EXPRESS_SNOOP); 751 752 dest = src; 753 src = InvalidPortID; 754 } 755 756 void 757 makeAtomicResponse() 758 { 759 makeResponse(); 760 } 761 762 void 763 makeTimingResponse() 764 { 765 makeResponse(); 766 } 767 768 void 769 setFunctionalResponseStatus(bool success) 770 { 771 if (!success) { 772 if (isWrite()) { 773 cmd = MemCmd::FunctionalWriteError; 774 } else { 775 cmd = MemCmd::FunctionalReadError; 776 } 777 } 778 } 779 780 void 781 setSize(unsigned size) 782 { 783 assert(!flags.isSet(VALID_SIZE)); 784 785 this->size = size; 786 flags.set(VALID_SIZE); 787 } 788 789 790 /** 791 * Set the data pointer to the following value that should not be 792 * freed. 793 */ 794 template <typename T> 795 void 796 dataStatic(T *p) 797 { 798 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 799 data = (PacketDataPtr)p; 800 flags.set(STATIC_DATA); 801 } 802 803 /** 804 * Set the data pointer to the following value that should not be 805 * freed. This version of the function allows the pointer passed 806 * to us to be const. To avoid issues down the line we cast the 807 * constness away, the alternative would be to keep both a const 808 * and non-const data pointer and cleverly choose between 809 * them. Note that this is only allowed for static data. 810 */ 811 template <typename T> 812 void 813 dataStaticConst(const T *p) 814 { 815 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 816 data = const_cast<PacketDataPtr>(p); 817 flags.set(STATIC_DATA); 818 } 819 820 /** 821 * Set the data pointer to a value that should have delete [] 822 * called on it. 823 */ 824 template <typename T> 825 void 826 dataDynamic(T *p) 827 { 828 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 829 data = (PacketDataPtr)p; 830 flags.set(DYNAMIC_DATA); 831 } 832 833 /** 834 * get a pointer to the data ptr. 835 */ 836 template <typename T> 837 T* 838 getPtr() 839 { 840 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 841 return (T*)data; 842 } 843 844 template <typename T> 845 const T* 846 getConstPtr() const 847 { 848 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 849 return (const T*)data; 850 } 851 852 /** 853 * return the value of what is pointed to in the packet. 854 */ 855 template <typename T> 856 T get() const; 857 858 /** 859 * set the value in the data pointer to v. 860 */ 861 template <typename T> 862 void set(T v); 863 864 /** 865 * Copy data into the packet from the provided pointer. 866 */ 867 void 868 setData(const uint8_t *p) 869 { 870 if (p != getPtr<uint8_t>()) 871 std::memcpy(getPtr<uint8_t>(), p, getSize()); 872 } 873 874 /** 875 * Copy data into the packet from the provided block pointer, 876 * which is aligned to the given block size. 877 */ 878 void 879 setDataFromBlock(const uint8_t *blk_data, int blkSize) 880 { 881 setData(blk_data + getOffset(blkSize)); 882 } 883 884 /** 885 * Copy data from the packet to the provided block pointer, which 886 * is aligned to the given block size. 887 */ 888 void 889 writeData(uint8_t *p) const 890 { 891 std::memcpy(p, getConstPtr<uint8_t>(), getSize()); 892 } 893 894 /** 895 * Copy data from the packet to the memory at the provided pointer. 896 */ 897 void 898 writeDataToBlock(uint8_t *blk_data, int blkSize) const 899 { 900 writeData(blk_data + getOffset(blkSize)); 901 } 902 903 /** 904 * delete the data pointed to in the data pointer. Ok to call to 905 * matter how data was allocted. 906 */ 907 void 908 deleteData() 909 { 910 if (flags.isSet(DYNAMIC_DATA)) 911 delete [] data; 912 913 flags.clear(STATIC_DATA|DYNAMIC_DATA); 914 data = NULL; 915 } 916 917 /** Allocate memory for the packet. */ 918 void 919 allocate() 920 { 921 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 922 flags.set(DYNAMIC_DATA); 923 data = new uint8_t[getSize()]; 924 } 925 926 /** 927 * Check a functional request against a memory value stored in 928 * another packet (i.e. an in-transit request or 929 * response). Returns true if the current packet is a read, and 930 * the other packet provides the data, which is then copied to the 931 * current packet. If the current packet is a write, and the other 932 * packet intersects this one, then we update the data 933 * accordingly. 934 */ 935 bool 936 checkFunctional(PacketPtr other) 937 { 938 // all packets that are carrying a payload should have a valid 939 // data pointer 940 return checkFunctional(other, other->getAddr(), other->isSecure(), 941 other->getSize(), 942 other->hasData() ? 943 other->getPtr<uint8_t>() : NULL); 944 } 945 946 /** 947 * Check a functional request against a memory value represented 948 * by a base/size pair and an associated data array. If the 949 * current packet is a read, it may be satisfied by the memory 950 * value. If the current packet is a write, it may update the 951 * memory value. 952 */ 953 bool 954 checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 955 uint8_t *_data); 956 957 /** 958 * Push label for PrintReq (safe to call unconditionally). 959 */ 960 void 961 pushLabel(const std::string &lbl) 962 { 963 if (isPrint()) 964 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 965 } 966 967 /** 968 * Pop label for PrintReq (safe to call unconditionally). 969 */ 970 void 971 popLabel() 972 { 973 if (isPrint()) 974 safe_cast<PrintReqState*>(senderState)->popLabel(); 975 } 976 977 void print(std::ostream &o, int verbosity = 0, 978 const std::string &prefix = "") const; 979 980 /** 981 * A no-args wrapper of print(std::ostream...) 982 * meant to be invoked from DPRINTFs 983 * avoiding string overheads in fast mode 984 * @return string with the request's type and start<->end addresses 985 */ 986 std::string print() const; 987}; 988 989#endif //__MEM_PACKET_HH 990