packet.hh revision 10192:5c2c4195b839
1/* 2 * Copyright (c) 2012-2013 ARM Limited 3 * All rights reserved 4 * 5 * The license below extends only to copyright in the software and shall 6 * not be construed as granting a license to any other intellectual 7 * property including but not limited to intellectual property relating 8 * to a hardware implementation of the functionality of the software 9 * licensed hereunder. You may use the software subject to the license 10 * terms below provided that you ensure that this notice is replicated 11 * unmodified and in its entirety in all distributions of the software, 12 * modified or unmodified, in source code or in binary form. 13 * 14 * Copyright (c) 2006 The Regents of The University of Michigan 15 * Copyright (c) 2010 Advanced Micro Devices, Inc. 16 * All rights reserved. 17 * 18 * Redistribution and use in source and binary forms, with or without 19 * modification, are permitted provided that the following conditions are 20 * met: redistributions of source code must retain the above copyright 21 * notice, this list of conditions and the following disclaimer; 22 * redistributions in binary form must reproduce the above copyright 23 * notice, this list of conditions and the following disclaimer in the 24 * documentation and/or other materials provided with the distribution; 25 * neither the name of the copyright holders nor the names of its 26 * contributors may be used to endorse or promote products derived from 27 * this software without specific prior written permission. 28 * 29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 40 * 41 * Authors: Ron Dreslinski 42 * Steve Reinhardt 43 * Ali Saidi 44 * Andreas Hansson 45 */ 46 47/** 48 * @file 49 * Declaration of the Packet class. 50 */ 51 52#ifndef __MEM_PACKET_HH__ 53#define __MEM_PACKET_HH__ 54 55#include <bitset> 56#include <cassert> 57#include <list> 58 59#include "base/cast.hh" 60#include "base/compiler.hh" 61#include "base/flags.hh" 62#include "base/misc.hh" 63#include "base/printable.hh" 64#include "base/types.hh" 65#include "mem/request.hh" 66#include "sim/core.hh" 67 68class Packet; 69typedef Packet *PacketPtr; 70typedef uint8_t* PacketDataPtr; 71typedef std::list<PacketPtr> PacketList; 72 73class MemCmd 74{ 75 friend class Packet; 76 77 public: 78 /** 79 * List of all commands associated with a packet. 80 */ 81 enum Command 82 { 83 InvalidCmd, 84 ReadReq, 85 ReadResp, 86 ReadRespWithInvalidate, 87 WriteReq, 88 WriteResp, 89 Writeback, 90 SoftPFReq, 91 HardPFReq, 92 SoftPFResp, 93 HardPFResp, 94 // WriteInvalidateReq transactions used to be generated by the 95 // DMA ports when writing full blocks to memory, however, it 96 // is not used anymore since we put the I/O cache in place to 97 // deal with partial block writes. Hence, WriteInvalidateReq 98 // and WriteInvalidateResp are currently unused. The 99 // implication is that the I/O cache does read-exclusive 100 // operations on every full-cache-block DMA, and ultimately 101 // this needs to be fixed. 102 WriteInvalidateReq, 103 WriteInvalidateResp, 104 UpgradeReq, 105 SCUpgradeReq, // Special "weak" upgrade for StoreCond 106 UpgradeResp, 107 SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 108 UpgradeFailResp, // Valid for SCUpgradeReq only 109 ReadExReq, 110 ReadExResp, 111 LoadLockedReq, 112 StoreCondReq, 113 StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 114 StoreCondResp, 115 SwapReq, 116 SwapResp, 117 MessageReq, 118 MessageResp, 119 // Error responses 120 // @TODO these should be classified as responses rather than 121 // requests; coding them as requests initially for backwards 122 // compatibility 123 InvalidDestError, // packet dest field invalid 124 BadAddressError, // memory address invalid 125 FunctionalReadError, // unable to fulfill functional read 126 FunctionalWriteError, // unable to fulfill functional write 127 // Fake simulator-only commands 128 PrintReq, // Print state matching address 129 FlushReq, //request for a cache flush 130 InvalidationReq, // request for address to be invalidated from lsq 131 NUM_MEM_CMDS 132 }; 133 134 private: 135 /** 136 * List of command attributes. 137 */ 138 enum Attribute 139 { 140 IsRead, //!< Data flows from responder to requester 141 IsWrite, //!< Data flows from requester to responder 142 IsUpgrade, 143 IsInvalidate, 144 NeedsExclusive, //!< Requires exclusive copy to complete in-cache 145 IsRequest, //!< Issued by requester 146 IsResponse, //!< Issue by responder 147 NeedsResponse, //!< Requester needs response from target 148 IsSWPrefetch, 149 IsHWPrefetch, 150 IsLlsc, //!< Alpha/MIPS LL or SC access 151 HasData, //!< There is an associated payload 152 IsError, //!< Error response 153 IsPrint, //!< Print state matching address (for debugging) 154 IsFlush, //!< Flush the address from caches 155 NUM_COMMAND_ATTRIBUTES 156 }; 157 158 /** 159 * Structure that defines attributes and other data associated 160 * with a Command. 161 */ 162 struct CommandInfo 163 { 164 /// Set of attribute flags. 165 const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 166 /// Corresponding response for requests; InvalidCmd if no 167 /// response is applicable. 168 const Command response; 169 /// String representation (for printing) 170 const std::string str; 171 }; 172 173 /// Array to map Command enum to associated info. 174 static const CommandInfo commandInfo[]; 175 176 private: 177 178 Command cmd; 179 180 bool 181 testCmdAttrib(MemCmd::Attribute attrib) const 182 { 183 return commandInfo[cmd].attributes[attrib] != 0; 184 } 185 186 public: 187 188 bool isRead() const { return testCmdAttrib(IsRead); } 189 bool isWrite() const { return testCmdAttrib(IsWrite); } 190 bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 191 bool isRequest() const { return testCmdAttrib(IsRequest); } 192 bool isResponse() const { return testCmdAttrib(IsResponse); } 193 bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 194 bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 195 bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 196 bool hasData() const { return testCmdAttrib(HasData); } 197 bool isReadWrite() const { return isRead() && isWrite(); } 198 bool isLLSC() const { return testCmdAttrib(IsLlsc); } 199 bool isError() const { return testCmdAttrib(IsError); } 200 bool isPrint() const { return testCmdAttrib(IsPrint); } 201 bool isFlush() const { return testCmdAttrib(IsFlush); } 202 203 const Command 204 responseCommand() const 205 { 206 return commandInfo[cmd].response; 207 } 208 209 /// Return the string to a cmd given by idx. 210 const std::string &toString() const { return commandInfo[cmd].str; } 211 int toInt() const { return (int)cmd; } 212 213 MemCmd(Command _cmd) : cmd(_cmd) { } 214 MemCmd(int _cmd) : cmd((Command)_cmd) { } 215 MemCmd() : cmd(InvalidCmd) { } 216 217 bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 218 bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 219}; 220 221/** 222 * A Packet is used to encapsulate a transfer between two objects in 223 * the memory system (e.g., the L1 and L2 cache). (In contrast, a 224 * single Request travels all the way from the requester to the 225 * ultimate destination and back, possibly being conveyed by several 226 * different Packets along the way.) 227 */ 228class Packet : public Printable 229{ 230 public: 231 typedef uint32_t FlagsType; 232 typedef ::Flags<FlagsType> Flags; 233 234 private: 235 static const FlagsType PUBLIC_FLAGS = 0x00000000; 236 static const FlagsType PRIVATE_FLAGS = 0x00007F0F; 237 static const FlagsType COPY_FLAGS = 0x0000000F; 238 239 static const FlagsType SHARED = 0x00000001; 240 // Special control flags 241 /// Special timing-mode atomic snoop for multi-level coherence. 242 static const FlagsType EXPRESS_SNOOP = 0x00000002; 243 /// Does supplier have exclusive copy? 244 /// Useful for multi-level coherence. 245 static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004; 246 // Snoop response flags 247 static const FlagsType MEM_INHIBIT = 0x00000008; 248 /// Are the 'addr' and 'size' fields valid? 249 static const FlagsType VALID_ADDR = 0x00000100; 250 static const FlagsType VALID_SIZE = 0x00000200; 251 /// Is the data pointer set to a value that shouldn't be freed 252 /// when the packet is destroyed? 253 static const FlagsType STATIC_DATA = 0x00001000; 254 /// The data pointer points to a value that should be freed when 255 /// the packet is destroyed. 256 static const FlagsType DYNAMIC_DATA = 0x00002000; 257 /// the data pointer points to an array (thus delete []) needs to 258 /// be called on it rather than simply delete. 259 static const FlagsType ARRAY_DATA = 0x00004000; 260 /// suppress the error if this packet encounters a functional 261 /// access failure. 262 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 263 // Signal prefetch squash through express snoop flag 264 static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; 265 266 Flags flags; 267 268 public: 269 typedef MemCmd::Command Command; 270 271 /// The command field of the packet. 272 MemCmd cmd; 273 274 /// A pointer to the original request. 275 RequestPtr req; 276 277 private: 278 /** 279 * A pointer to the data being transfered. It can be differnt 280 * sizes at each level of the heirarchy so it belongs in the 281 * packet, not request. This may or may not be populated when a 282 * responder recieves the packet. If not populated it memory should 283 * be allocated. 284 */ 285 PacketDataPtr data; 286 287 /// The address of the request. This address could be virtual or 288 /// physical, depending on the system configuration. 289 Addr addr; 290 291 /// True if the request targets the secure memory space. 292 bool _isSecure; 293 294 /// The size of the request or transfer. 295 unsigned size; 296 297 /** 298 * Source port identifier set on a request packet to enable 299 * appropriate routing of the responses. The source port 300 * identifier is set by any multiplexing component, e.g. a bus, as 301 * the timing responses need this information to be routed back to 302 * the appropriate port at a later point in time. The field can be 303 * updated (over-written) as the request packet passes through 304 * additional multiplexing components, and it is their 305 * responsibility to remember the original source port identifier, 306 * for example by using an appropriate sender state. The latter is 307 * done in the cache and bridge. 308 */ 309 PortID src; 310 311 /** 312 * Destination port identifier that is present on all response 313 * packets that passed through a multiplexing component as a 314 * request packet. The source port identifier is turned into a 315 * destination port identifier when the packet is turned into a 316 * response, and the destination is used, e.g. by the bus, to 317 * select the appropriate path through the interconnect. 318 */ 319 PortID dest; 320 321 /** 322 * The original value of the command field. Only valid when the 323 * current command field is an error condition; in that case, the 324 * previous contents of the command field are copied here. This 325 * field is *not* set on non-error responses. 326 */ 327 MemCmd origCmd; 328 329 /** 330 * These values specify the range of bytes found that satisfy a 331 * functional read. 332 */ 333 uint16_t bytesValidStart; 334 uint16_t bytesValidEnd; 335 336 public: 337 338 /** 339 * The extra delay from seeing the packet until the first word is 340 * transmitted by the bus that provided it (if any). This delay is 341 * used to communicate the bus waiting time to the neighbouring 342 * object (e.g. a cache) that actually makes the packet wait. As 343 * the delay is relative, a 32-bit unsigned should be sufficient. 344 */ 345 uint32_t busFirstWordDelay; 346 347 /** 348 * The extra delay from seeing the packet until the last word is 349 * transmitted by the bus that provided it (if any). Similar to 350 * the first word time, this is used to make up for the fact that 351 * the bus does not make the packet wait. As the delay is relative, 352 * a 32-bit unsigned should be sufficient. 353 */ 354 uint32_t busLastWordDelay; 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 isReadWrite() const { return cmd.isReadWrite(); } 508 bool isLLSC() const { return cmd.isLLSC(); } 509 bool isError() const { return cmd.isError(); } 510 bool isPrint() const { return cmd.isPrint(); } 511 bool isFlush() const { return cmd.isFlush(); } 512 513 // Snoop flags 514 void assertMemInhibit() { flags.set(MEM_INHIBIT); } 515 bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 516 void assertShared() { flags.set(SHARED); } 517 bool sharedAsserted() const { return flags.isSet(SHARED); } 518 519 // Special control flags 520 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 521 bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 522 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 523 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 524 bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 525 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 526 bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 527 void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } 528 bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } 529 530 // Network error conditions... encapsulate them as methods since 531 // their encoding keeps changing (from result field to command 532 // field, etc.) 533 void 534 setBadAddress() 535 { 536 assert(isResponse()); 537 cmd = MemCmd::BadAddressError; 538 } 539 540 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 541 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 542 543 bool isSrcValid() const { return src != InvalidPortID; } 544 /// Accessor function to get the source index of the packet. 545 PortID getSrc() const { assert(isSrcValid()); return src; } 546 /// Accessor function to set the source index of the packet. 547 void setSrc(PortID _src) { src = _src; } 548 /// Reset source field, e.g. to retransmit packet on different bus. 549 void clearSrc() { src = InvalidPortID; } 550 551 bool isDestValid() const { return dest != InvalidPortID; } 552 /// Accessor function for the destination index of the packet. 553 PortID getDest() const { assert(isDestValid()); return dest; } 554 /// Accessor function to set the destination index of the packet. 555 void setDest(PortID _dest) { dest = _dest; } 556 /// Reset destination field, e.g. to turn a response into a request again. 557 void clearDest() { dest = InvalidPortID; } 558 559 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 560 /** 561 * Update the address of this packet mid-transaction. This is used 562 * by the address mapper to change an already set address to a new 563 * one based on the system configuration. It is intended to remap 564 * an existing address, so it asserts that the current address is 565 * valid. 566 */ 567 void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 568 569 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 570 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 571 572 bool isSecure() const 573 { 574 assert(flags.isSet(VALID_ADDR)); 575 return _isSecure; 576 } 577 578 /** 579 * It has been determined that the SC packet should successfully update 580 * memory. Therefore, convert this SC packet to a normal write. 581 */ 582 void 583 convertScToWrite() 584 { 585 assert(isLLSC()); 586 assert(isWrite()); 587 cmd = MemCmd::WriteReq; 588 } 589 590 /** 591 * When ruby is in use, Ruby will monitor the cache line and thus M5 592 * phys memory should treat LL ops as normal reads. 593 */ 594 void 595 convertLlToRead() 596 { 597 assert(isLLSC()); 598 assert(isRead()); 599 cmd = MemCmd::ReadReq; 600 } 601 602 /** 603 * Constructor. Note that a Request object must be constructed 604 * first, but the Requests's physical address and size fields need 605 * not be valid. The command must be supplied. 606 */ 607 Packet(Request *_req, MemCmd _cmd) 608 : cmd(_cmd), req(_req), data(NULL), 609 src(InvalidPortID), dest(InvalidPortID), 610 bytesValidStart(0), bytesValidEnd(0), 611 busFirstWordDelay(0), busLastWordDelay(0), 612 senderState(NULL) 613 { 614 if (req->hasPaddr()) { 615 addr = req->getPaddr(); 616 flags.set(VALID_ADDR); 617 _isSecure = req->isSecure(); 618 } 619 if (req->hasSize()) { 620 size = req->getSize(); 621 flags.set(VALID_SIZE); 622 } 623 } 624 625 /** 626 * Alternate constructor if you are trying to create a packet with 627 * a request that is for a whole block, not the address from the 628 * req. this allows for overriding the size/addr of the req. 629 */ 630 Packet(Request *_req, MemCmd _cmd, int _blkSize) 631 : cmd(_cmd), req(_req), data(NULL), 632 src(InvalidPortID), dest(InvalidPortID), 633 bytesValidStart(0), bytesValidEnd(0), 634 busFirstWordDelay(0), busLastWordDelay(0), 635 senderState(NULL) 636 { 637 if (req->hasPaddr()) { 638 addr = req->getPaddr() & ~(_blkSize - 1); 639 flags.set(VALID_ADDR); 640 _isSecure = req->isSecure(); 641 } 642 size = _blkSize; 643 flags.set(VALID_SIZE); 644 } 645 646 /** 647 * Alternate constructor for copying a packet. Copy all fields 648 * *except* if the original packet's data was dynamic, don't copy 649 * that, as we can't guarantee that the new packet's lifetime is 650 * less than that of the original packet. In this case the new 651 * packet should allocate its own data. 652 */ 653 Packet(Packet *pkt, bool clearFlags = false) 654 : cmd(pkt->cmd), req(pkt->req), 655 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), 656 addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 657 src(pkt->src), dest(pkt->dest), 658 bytesValidStart(pkt->bytesValidStart), 659 bytesValidEnd(pkt->bytesValidEnd), 660 busFirstWordDelay(pkt->busFirstWordDelay), 661 busLastWordDelay(pkt->busLastWordDelay), 662 senderState(pkt->senderState) 663 { 664 if (!clearFlags) 665 flags.set(pkt->flags & COPY_FLAGS); 666 667 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 668 flags.set(pkt->flags & STATIC_DATA); 669 670 } 671 672 /** 673 * clean up packet variables 674 */ 675 ~Packet() 676 { 677 // If this is a request packet for which there's no response, 678 // delete the request object here, since the requester will 679 // never get the chance. 680 if (req && isRequest() && !needsResponse()) 681 delete req; 682 deleteData(); 683 } 684 685 /** 686 * Reinitialize packet address and size from the associated 687 * Request object, and reset other fields that may have been 688 * modified by a previous transaction. Typically called when a 689 * statically allocated Request/Packet pair is reused for multiple 690 * transactions. 691 */ 692 void 693 reinitFromRequest() 694 { 695 assert(req->hasPaddr()); 696 flags = 0; 697 addr = req->getPaddr(); 698 _isSecure = req->isSecure(); 699 size = req->getSize(); 700 701 src = InvalidPortID; 702 dest = InvalidPortID; 703 bytesValidStart = 0; 704 bytesValidEnd = 0; 705 busFirstWordDelay = 0; 706 busLastWordDelay = 0; 707 708 flags.set(VALID_ADDR|VALID_SIZE); 709 deleteData(); 710 } 711 712 /** 713 * Take a request packet and modify it in place to be suitable for 714 * returning as a response to that request. The source field is 715 * turned into the destination, and subsequently cleared. Note 716 * that the latter is not necessary for atomic requests, but 717 * causes no harm as neither field is valid. 718 */ 719 void 720 makeResponse() 721 { 722 assert(needsResponse()); 723 assert(isRequest()); 724 origCmd = cmd; 725 cmd = cmd.responseCommand(); 726 727 // responses are never express, even if the snoop that 728 // triggered them was 729 flags.clear(EXPRESS_SNOOP); 730 731 dest = src; 732 clearSrc(); 733 } 734 735 void 736 makeAtomicResponse() 737 { 738 makeResponse(); 739 } 740 741 void 742 makeTimingResponse() 743 { 744 makeResponse(); 745 } 746 747 void 748 setFunctionalResponseStatus(bool success) 749 { 750 if (!success) { 751 if (isWrite()) { 752 cmd = MemCmd::FunctionalWriteError; 753 } else { 754 cmd = MemCmd::FunctionalReadError; 755 } 756 } 757 } 758 759 void 760 setSize(unsigned size) 761 { 762 assert(!flags.isSet(VALID_SIZE)); 763 764 this->size = size; 765 flags.set(VALID_SIZE); 766 } 767 768 769 /** 770 * Set the data pointer to the following value that should not be 771 * freed. 772 */ 773 template <typename T> 774 void 775 dataStatic(T *p) 776 { 777 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 778 data = (PacketDataPtr)p; 779 flags.set(STATIC_DATA); 780 } 781 782 /** 783 * Set the data pointer to a value that should have delete [] 784 * called on it. 785 */ 786 template <typename T> 787 void 788 dataDynamicArray(T *p) 789 { 790 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 791 data = (PacketDataPtr)p; 792 flags.set(DYNAMIC_DATA|ARRAY_DATA); 793 } 794 795 /** 796 * set the data pointer to a value that should have delete called 797 * on it. 798 */ 799 template <typename T> 800 void 801 dataDynamic(T *p) 802 { 803 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 804 data = (PacketDataPtr)p; 805 flags.set(DYNAMIC_DATA); 806 } 807 808 /** 809 * get a pointer to the data ptr. 810 */ 811 template <typename T> 812 T* 813 getPtr(bool null_ok = false) 814 { 815 assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 816 return (T*)data; 817 } 818 819 /** 820 * return the value of what is pointed to in the packet. 821 */ 822 template <typename T> 823 T get(); 824 825 /** 826 * set the value in the data pointer to v. 827 */ 828 template <typename T> 829 void set(T v); 830 831 /** 832 * Copy data into the packet from the provided pointer. 833 */ 834 void 835 setData(uint8_t *p) 836 { 837 if (p != getPtr<uint8_t>()) 838 std::memcpy(getPtr<uint8_t>(), p, getSize()); 839 } 840 841 /** 842 * Copy data into the packet from the provided block pointer, 843 * which is aligned to the given block size. 844 */ 845 void 846 setDataFromBlock(uint8_t *blk_data, int blkSize) 847 { 848 setData(blk_data + getOffset(blkSize)); 849 } 850 851 /** 852 * Copy data from the packet to the provided block pointer, which 853 * is aligned to the given block size. 854 */ 855 void 856 writeData(uint8_t *p) 857 { 858 std::memcpy(p, getPtr<uint8_t>(), getSize()); 859 } 860 861 /** 862 * Copy data from the packet to the memory at the provided pointer. 863 */ 864 void 865 writeDataToBlock(uint8_t *blk_data, int blkSize) 866 { 867 writeData(blk_data + getOffset(blkSize)); 868 } 869 870 /** 871 * delete the data pointed to in the data pointer. Ok to call to 872 * matter how data was allocted. 873 */ 874 void 875 deleteData() 876 { 877 if (flags.isSet(ARRAY_DATA)) 878 delete [] data; 879 else if (flags.isSet(DYNAMIC_DATA)) 880 delete data; 881 882 flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA); 883 data = NULL; 884 } 885 886 /** If there isn't data in the packet, allocate some. */ 887 void 888 allocate() 889 { 890 if (data) { 891 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 892 return; 893 } 894 895 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 896 flags.set(DYNAMIC_DATA|ARRAY_DATA); 897 data = new uint8_t[getSize()]; 898 } 899 900 /** 901 * Check a functional request against a memory value represented 902 * by a base/size pair and an associated data array. If the 903 * functional request is a read, it may be satisfied by the memory 904 * value. If the functional request is a write, it may update the 905 * memory value. 906 */ 907 bool checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 908 uint8_t *data); 909 910 /** 911 * Check a functional request against a memory value stored in 912 * another packet (i.e. an in-transit request or response). 913 */ 914 bool 915 checkFunctional(PacketPtr other) 916 { 917 uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL; 918 return checkFunctional(other, other->getAddr(), other->isSecure(), 919 other->getSize(), data); 920 } 921 922 /** 923 * Push label for PrintReq (safe to call unconditionally). 924 */ 925 void 926 pushLabel(const std::string &lbl) 927 { 928 if (isPrint()) 929 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 930 } 931 932 /** 933 * Pop label for PrintReq (safe to call unconditionally). 934 */ 935 void 936 popLabel() 937 { 938 if (isPrint()) 939 safe_cast<PrintReqState*>(senderState)->popLabel(); 940 } 941 942 void print(std::ostream &o, int verbosity = 0, 943 const std::string &prefix = "") const; 944 945 /** 946 * A no-args wrapper of print(std::ostream...) 947 * meant to be invoked from DPRINTFs 948 * avoiding string overheads in fast mode 949 * @return string with the request's type and start<->end addresses 950 */ 951 std::string print() const; 952}; 953 954#endif //__MEM_PACKET_HH 955