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