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