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