packet.hh revision 10343:a1eea45928e6
19793Sakash.bagdia@arm.com/* 28706Sandreas.hansson@arm.com * Copyright (c) 2012-2014 ARM Limited 38706Sandreas.hansson@arm.com * All rights reserved 48706Sandreas.hansson@arm.com * 58706Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall 68706Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual 78706Sandreas.hansson@arm.com * property including but not limited to intellectual property relating 88706Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software 98706Sandreas.hansson@arm.com * licensed hereunder. You may use the software subject to the license 108706Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated 118706Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software, 128706Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form. 135369Ssaidi@eecs.umich.edu * 143005Sstever@eecs.umich.edu * Copyright (c) 2006 The Regents of The University of Michigan 153005Sstever@eecs.umich.edu * Copyright (c) 2010 Advanced Micro Devices, Inc. 163005Sstever@eecs.umich.edu * All rights reserved. 173005Sstever@eecs.umich.edu * 183005Sstever@eecs.umich.edu * Redistribution and use in source and binary forms, with or without 193005Sstever@eecs.umich.edu * modification, are permitted provided that the following conditions are 203005Sstever@eecs.umich.edu * met: redistributions of source code must retain the above copyright 213005Sstever@eecs.umich.edu * notice, this list of conditions and the following disclaimer; 223005Sstever@eecs.umich.edu * redistributions in binary form must reproduce the above copyright 233005Sstever@eecs.umich.edu * notice, this list of conditions and the following disclaimer in the 243005Sstever@eecs.umich.edu * documentation and/or other materials provided with the distribution; 253005Sstever@eecs.umich.edu * neither the name of the copyright holders nor the names of its 263005Sstever@eecs.umich.edu * contributors may be used to endorse or promote products derived from 273005Sstever@eecs.umich.edu * this software without specific prior written permission. 283005Sstever@eecs.umich.edu * 293005Sstever@eecs.umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 303005Sstever@eecs.umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 313005Sstever@eecs.umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 323005Sstever@eecs.umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 333005Sstever@eecs.umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 343005Sstever@eecs.umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 353005Sstever@eecs.umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 363005Sstever@eecs.umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 373005Sstever@eecs.umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 383005Sstever@eecs.umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 393005Sstever@eecs.umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 403005Sstever@eecs.umich.edu * 412710SN/A * Authors: Ron Dreslinski 422710SN/A * Steve Reinhardt 433005Sstever@eecs.umich.edu * Ali Saidi 442889SN/A * Andreas Hansson 456654Snate@binkert.org */ 466654Snate@binkert.org 479907Snilay@cs.wisc.edu/** 486654Snate@binkert.org * @file 492667SN/A * Declaration of the Packet class. 506654Snate@binkert.org */ 516654Snate@binkert.org 526654Snate@binkert.org#ifndef __MEM_PACKET_HH__ 535457Ssaidi@eecs.umich.edu#define __MEM_PACKET_HH__ 546654Snate@binkert.org 558169SLisa.Hsu@amd.com#include <bitset> 568169SLisa.Hsu@amd.com#include <cassert> 578920Snilay@cs.wisc.edu#include <list> 588169SLisa.Hsu@amd.com 593395Shsul@eecs.umich.edu#include "base/cast.hh" 606981SLisa.Hsu@amd.com#include "base/compiler.hh" 619836Sandreas.hansson@arm.com#include "base/flags.hh" 623448Shsul@eecs.umich.edu#include "base/misc.hh" 635369Ssaidi@eecs.umich.edu#include "base/printable.hh" 643394Shsul@eecs.umich.edu#include "base/types.hh" 659197Snilay@cs.wisc.edu#include "mem/request.hh" 669197Snilay@cs.wisc.edu#include "sim/core.hh" 679197Snilay@cs.wisc.edu 689197Snilay@cs.wisc.educlass Packet; 699197Snilay@cs.wisc.edutypedef Packet *PacketPtr; 709197Snilay@cs.wisc.edutypedef uint8_t* PacketDataPtr; 719197Snilay@cs.wisc.edutypedef std::list<PacketPtr> PacketList; 729197Snilay@cs.wisc.edu 739197Snilay@cs.wisc.educlass MemCmd 749197Snilay@cs.wisc.edu{ 759197Snilay@cs.wisc.edu friend class Packet; 769197Snilay@cs.wisc.edu 779197Snilay@cs.wisc.edu public: 789197Snilay@cs.wisc.edu /** 799197Snilay@cs.wisc.edu * List of all commands associated with a packet. 809197Snilay@cs.wisc.edu */ 819197Snilay@cs.wisc.edu enum Command 829197Snilay@cs.wisc.edu { 839197Snilay@cs.wisc.edu InvalidCmd, 849197Snilay@cs.wisc.edu ReadReq, 859197Snilay@cs.wisc.edu ReadResp, 869197Snilay@cs.wisc.edu ReadRespWithInvalidate, 879197Snilay@cs.wisc.edu WriteReq, 889907Snilay@cs.wisc.edu WriteResp, 899197Snilay@cs.wisc.edu Writeback, 909197Snilay@cs.wisc.edu SoftPFReq, 919217Snilay@cs.wisc.edu HardPFReq, 929197Snilay@cs.wisc.edu SoftPFResp, 939197Snilay@cs.wisc.edu HardPFResp, 949197Snilay@cs.wisc.edu // WriteInvalidateReq transactions used to be generated by the 959197Snilay@cs.wisc.edu // DMA ports when writing full blocks to memory, however, it 969197Snilay@cs.wisc.edu // is not used anymore since we put the I/O cache in place to 979197Snilay@cs.wisc.edu // deal with partial block writes. Hence, WriteInvalidateReq 989197Snilay@cs.wisc.edu // and WriteInvalidateResp are currently unused. The 999197Snilay@cs.wisc.edu // implication is that the I/O cache does read-exclusive 1009197Snilay@cs.wisc.edu // operations on every full-cache-block DMA, and ultimately 1019197Snilay@cs.wisc.edu // this needs to be fixed. 1029197Snilay@cs.wisc.edu WriteInvalidateReq, 1039197Snilay@cs.wisc.edu WriteInvalidateResp, 1049197Snilay@cs.wisc.edu UpgradeReq, 1059197Snilay@cs.wisc.edu SCUpgradeReq, // Special "weak" upgrade for StoreCond 1069197Snilay@cs.wisc.edu UpgradeResp, 1079197Snilay@cs.wisc.edu SCUpgradeFailReq, // Failed SCUpgradeReq in MSHR (never sent) 1089197Snilay@cs.wisc.edu UpgradeFailResp, // Valid for SCUpgradeReq only 1099197Snilay@cs.wisc.edu ReadExReq, 1109197Snilay@cs.wisc.edu ReadExResp, 1119197Snilay@cs.wisc.edu LoadLockedReq, 1122957SN/A StoreCondReq, 1138920Snilay@cs.wisc.edu StoreCondFailReq, // Failed StoreCondReq in MSHR (never sent) 1148920Snilay@cs.wisc.edu StoreCondResp, 1152957SN/A SwapReq, 1168862Snilay@cs.wisc.edu SwapResp, 1178862Snilay@cs.wisc.edu MessageReq, 1188467Snilay@cs.wisc.edu MessageResp, 1192957SN/A // Error responses 1202957SN/A // @TODO these should be classified as responses rather than 1212957SN/A // requests; coding them as requests initially for backwards 1222957SN/A // compatibility 1232957SN/A InvalidDestError, // packet dest field invalid 1242957SN/A BadAddressError, // memory address invalid 1258167SLisa.Hsu@amd.com FunctionalReadError, // unable to fulfill functional read 1269197Snilay@cs.wisc.edu FunctionalWriteError, // unable to fulfill functional write 1278167SLisa.Hsu@amd.com // Fake simulator-only commands 1285369Ssaidi@eecs.umich.edu PrintReq, // Print state matching address 1298167SLisa.Hsu@amd.com FlushReq, //request for a cache flush 1308167SLisa.Hsu@amd.com InvalidationReq, // request for address to be invalidated from lsq 1318167SLisa.Hsu@amd.com NUM_MEM_CMDS 1328167SLisa.Hsu@amd.com }; 1338167SLisa.Hsu@amd.com 1348167SLisa.Hsu@amd.com private: 1358167SLisa.Hsu@amd.com /** 1368168SLisa.Hsu@amd.com * List of command attributes. 13710037SARM gem5 Developers */ 13810037SARM gem5 Developers enum Attribute 13910037SARM gem5 Developers { 14010037SARM gem5 Developers IsRead, //!< Data flows from responder to requester 14110037SARM gem5 Developers IsWrite, //!< Data flows from requester to responder 1428168SLisa.Hsu@amd.com IsUpgrade, 14310037SARM gem5 Developers IsInvalidate, 14410037SARM gem5 Developers NeedsExclusive, //!< Requires exclusive copy to complete in-cache 1458167SLisa.Hsu@amd.com IsRequest, //!< Issued by requester 1468167SLisa.Hsu@amd.com IsResponse, //!< Issue by responder 14710118Snilay@cs.wisc.edu NeedsResponse, //!< Requester needs response from target 14810118Snilay@cs.wisc.edu IsSWPrefetch, 1495369Ssaidi@eecs.umich.edu IsHWPrefetch, 1508920Snilay@cs.wisc.edu IsLlsc, //!< Alpha/MIPS LL or SC access 1519197Snilay@cs.wisc.edu HasData, //!< There is an associated payload 1528920Snilay@cs.wisc.edu IsError, //!< Error response 1538920Snilay@cs.wisc.edu IsPrint, //!< Print state matching address (for debugging) 1548920Snilay@cs.wisc.edu IsFlush, //!< Flush the address from caches 1555369Ssaidi@eecs.umich.edu NUM_COMMAND_ATTRIBUTES 1565369Ssaidi@eecs.umich.edu }; 1578718Snilay@cs.wisc.edu 1589197Snilay@cs.wisc.edu /** 1599197Snilay@cs.wisc.edu * Structure that defines attributes and other data associated 1609197Snilay@cs.wisc.edu * with a Command. 1619197Snilay@cs.wisc.edu */ 1629197Snilay@cs.wisc.edu struct CommandInfo 1633005Sstever@eecs.umich.edu { 1643395Shsul@eecs.umich.edu /// Set of attribute flags. 1653395Shsul@eecs.umich.edu const std::bitset<NUM_COMMAND_ATTRIBUTES> attributes; 1669793Sakash.bagdia@arm.com /// Corresponding response for requests; InvalidCmd if no 1679836Sandreas.hansson@arm.com /// response is applicable. 1689815SAndreas Hansson <andreas.hansson> const Command response; 1699793Sakash.bagdia@arm.com /// String representation (for printing) 1709827Sakash.bagdia@arm.com const std::string str; 1719827Sakash.bagdia@arm.com }; 1729827Sakash.bagdia@arm.com 1739827Sakash.bagdia@arm.com /// Array to map Command enum to associated info. 1749827Sakash.bagdia@arm.com static const CommandInfo commandInfo[]; 1759827Sakash.bagdia@arm.com 1769827Sakash.bagdia@arm.com private: 1779827Sakash.bagdia@arm.com 1789827Sakash.bagdia@arm.com Command cmd; 1799827Sakash.bagdia@arm.com 1809793Sakash.bagdia@arm.com bool 1819827Sakash.bagdia@arm.com testCmdAttrib(MemCmd::Attribute attrib) const 1829827Sakash.bagdia@arm.com { 1839827Sakash.bagdia@arm.com return commandInfo[cmd].attributes[attrib] != 0; 1849793Sakash.bagdia@arm.com } 1859793Sakash.bagdia@arm.com 1869793Sakash.bagdia@arm.com public: 1879793Sakash.bagdia@arm.com 1889793Sakash.bagdia@arm.com bool isRead() const { return testCmdAttrib(IsRead); } 1893395Shsul@eecs.umich.edu bool isWrite() const { return testCmdAttrib(IsWrite); } 1908926Sandreas.hansson@arm.com bool isUpgrade() const { return testCmdAttrib(IsUpgrade); } 1919317Sandreas.hansson@arm.com bool isRequest() const { return testCmdAttrib(IsRequest); } 1929317Sandreas.hansson@arm.com bool isResponse() const { return testCmdAttrib(IsResponse); } 1939317Sandreas.hansson@arm.com bool needsExclusive() const { return testCmdAttrib(NeedsExclusive); } 1949317Sandreas.hansson@arm.com bool needsResponse() const { return testCmdAttrib(NeedsResponse); } 1959317Sandreas.hansson@arm.com bool isInvalidate() const { return testCmdAttrib(IsInvalidate); } 1968926Sandreas.hansson@arm.com bool hasData() const { return testCmdAttrib(HasData); } 1979647Sdam.sunwoo@arm.com bool isReadWrite() const { return isRead() && isWrite(); } 1989647Sdam.sunwoo@arm.com bool isLLSC() const { return testCmdAttrib(IsLlsc); } 1999647Sdam.sunwoo@arm.com bool isSWPrefetch() const { return testCmdAttrib(IsSWPrefetch); } 2009647Sdam.sunwoo@arm.com bool isHWPrefetch() const { return testCmdAttrib(IsHWPrefetch); } 2019647Sdam.sunwoo@arm.com bool isPrefetch() const { return testCmdAttrib(IsSWPrefetch) || 2029647Sdam.sunwoo@arm.com testCmdAttrib(IsHWPrefetch); } 2039647Sdam.sunwoo@arm.com bool isError() const { return testCmdAttrib(IsError); } 2043395Shsul@eecs.umich.edu bool isPrint() const { return testCmdAttrib(IsPrint); } 2059197Snilay@cs.wisc.edu bool isFlush() const { return testCmdAttrib(IsFlush); } 2069197Snilay@cs.wisc.edu 2079197Snilay@cs.wisc.edu const Command 2088957Sjayneel@cs.wisc.edu responseCommand() const 2098957Sjayneel@cs.wisc.edu { 2108957Sjayneel@cs.wisc.edu return commandInfo[cmd].response; 2113005Sstever@eecs.umich.edu } 2124968Sacolyte@umich.edu 2139006Sandreas.hansson@arm.com /// Return the string to a cmd given by idx. 2144968Sacolyte@umich.edu const std::string &toString() const { return commandInfo[cmd].str; } 2159647Sdam.sunwoo@arm.com int toInt() const { return (int)cmd; } 21610381Sdam.sunwoo@arm.com 2179647Sdam.sunwoo@arm.com MemCmd(Command _cmd) : cmd(_cmd) { } 2188887Sgeoffrey.blake@arm.com MemCmd(int _cmd) : cmd((Command)_cmd) { } 2198887Sgeoffrey.blake@arm.com MemCmd() : cmd(InvalidCmd) { } 2208887Sgeoffrey.blake@arm.com 2219384SAndreas.Sandberg@arm.com bool operator==(MemCmd c2) const { return (cmd == c2.cmd); } 2229384SAndreas.Sandberg@arm.com bool operator!=(MemCmd c2) const { return (cmd != c2.cmd); } 2238887Sgeoffrey.blake@arm.com}; 2248896Snilay@cs.wisc.edu 2258896Snilay@cs.wisc.edu/** 2268896Snilay@cs.wisc.edu * A Packet is used to encapsulate a transfer between two objects in 2278896Snilay@cs.wisc.edu * the memory system (e.g., the L1 and L2 cache). (In contrast, a 22810150Snilay@cs.wisc.edu * single Request travels all the way from the requester to the 22910150Snilay@cs.wisc.edu * ultimate destination and back, possibly being conveyed by several 23010150Snilay@cs.wisc.edu * different Packets along the way.) 23110150Snilay@cs.wisc.edu */ 2329836Sandreas.hansson@arm.comclass Packet : public Printable 23310092Snilay@cs.wisc.edu{ 23410519Snilay@cs.wisc.edu public: 23510120Snilay@cs.wisc.edu typedef uint32_t FlagsType; 2368896Snilay@cs.wisc.edu typedef ::Flags<FlagsType> Flags; 23710300Scastilloe@unican.es 23810300Scastilloe@unican.es private: 2398896Snilay@cs.wisc.edu static const FlagsType PUBLIC_FLAGS = 0x00000000; 24010120Snilay@cs.wisc.edu static const FlagsType PRIVATE_FLAGS = 0x00007F0F; 2418896Snilay@cs.wisc.edu static const FlagsType COPY_FLAGS = 0x0000000F; 2428896Snilay@cs.wisc.edu 2439268Smalek.musleh@gmail.com static const FlagsType SHARED = 0x00000001; 2449268Smalek.musleh@gmail.com // Special control flags 2458896Snilay@cs.wisc.edu /// Special timing-mode atomic snoop for multi-level coherence. 2468896Snilay@cs.wisc.edu static const FlagsType EXPRESS_SNOOP = 0x00000002; 2478896Snilay@cs.wisc.edu /// Does supplier have exclusive copy? 2488896Snilay@cs.wisc.edu /// Useful for multi-level coherence. 2498896Snilay@cs.wisc.edu static const FlagsType SUPPLY_EXCLUSIVE = 0x00000004; 2509222Shestness@cs.wisc.edu // Snoop response flags 2519268Smalek.musleh@gmail.com static const FlagsType MEM_INHIBIT = 0x00000008; 2529268Smalek.musleh@gmail.com /// Are the 'addr' and 'size' fields valid? 2539268Smalek.musleh@gmail.com static const FlagsType VALID_ADDR = 0x00000100; 2549222Shestness@cs.wisc.edu static const FlagsType VALID_SIZE = 0x00000200; 2559222Shestness@cs.wisc.edu /// Is the data pointer set to a value that shouldn't be freed 2568887Sgeoffrey.blake@arm.com /// when the packet is destroyed? 25710150Snilay@cs.wisc.edu static const FlagsType STATIC_DATA = 0x00001000; 25810405Sandreas.hansson@arm.com /// The data pointer points to a value that should be freed when 2598887Sgeoffrey.blake@arm.com /// the packet is destroyed. 2608887Sgeoffrey.blake@arm.com static const FlagsType DYNAMIC_DATA = 0x00002000; 2619836Sandreas.hansson@arm.com /// the data pointer points to an array (thus delete []) needs to 2628887Sgeoffrey.blake@arm.com /// be called on it rather than simply delete. 2638801Sgblack@eecs.umich.edu static const FlagsType ARRAY_DATA = 0x00004000; 2643481Shsul@eecs.umich.edu /// suppress the error if this packet encounters a functional 265 /// access failure. 266 static const FlagsType SUPPRESS_FUNC_ERROR = 0x00008000; 267 // Signal prefetch squash through express snoop flag 268 static const FlagsType PREFETCH_SNOOP_SQUASH = 0x00010000; 269 270 Flags flags; 271 272 public: 273 typedef MemCmd::Command Command; 274 275 /// The command field of the packet. 276 MemCmd cmd; 277 278 /// A pointer to the original request. 279 RequestPtr req; 280 281 private: 282 /** 283 * A pointer to the data being transfered. It can be differnt 284 * sizes at each level of the heirarchy so it belongs in the 285 * packet, not request. This may or may not be populated when a 286 * responder recieves the packet. If not populated it memory should 287 * be allocated. 288 */ 289 PacketDataPtr data; 290 291 /// The address of the request. This address could be virtual or 292 /// physical, depending on the system configuration. 293 Addr addr; 294 295 /// True if the request targets the secure memory space. 296 bool _isSecure; 297 298 /// The size of the request or transfer. 299 unsigned size; 300 301 /** 302 * Source port identifier set on a request packet to enable 303 * appropriate routing of the responses. The source port 304 * identifier is set by any multiplexing component, e.g. a bus, as 305 * the timing responses need this information to be routed back to 306 * the appropriate port at a later point in time. The field can be 307 * updated (over-written) as the request packet passes through 308 * additional multiplexing components, and it is their 309 * responsibility to remember the original source port identifier, 310 * for example by using an appropriate sender state. The latter is 311 * done in the cache and bridge. 312 */ 313 PortID src; 314 315 /** 316 * Destination port identifier that is present on all response 317 * packets that passed through a multiplexing component as a 318 * request packet. The source port identifier is turned into a 319 * destination port identifier when the packet is turned into a 320 * response, and the destination is used, e.g. by the bus, to 321 * select the appropriate path through the interconnect. 322 */ 323 PortID dest; 324 325 /** 326 * The original value of the command field. Only valid when the 327 * current command field is an error condition; in that case, the 328 * previous contents of the command field are copied here. This 329 * field is *not* set on non-error responses. 330 */ 331 MemCmd origCmd; 332 333 /** 334 * These values specify the range of bytes found that satisfy a 335 * functional read. 336 */ 337 uint16_t bytesValidStart; 338 uint16_t bytesValidEnd; 339 340 public: 341 342 /** 343 * The extra delay from seeing the packet until the first word is 344 * transmitted by the bus that provided it (if any). This delay is 345 * used to communicate the bus waiting time to the neighbouring 346 * object (e.g. a cache) that actually makes the packet wait. As 347 * the delay is relative, a 32-bit unsigned should be sufficient. 348 */ 349 uint32_t busFirstWordDelay; 350 351 /** 352 * The extra delay from seeing the packet until the last word is 353 * transmitted by the bus that provided it (if any). Similar to 354 * the first word time, this is used to make up for the fact that 355 * the bus does not make the packet wait. As the delay is relative, 356 * a 32-bit unsigned should be sufficient. 357 */ 358 uint32_t busLastWordDelay; 359 360 /** 361 * A virtual base opaque structure used to hold state associated 362 * with the packet (e.g., an MSHR), specific to a MemObject that 363 * sees the packet. A pointer to this state is returned in the 364 * packet's response so that the MemObject in question can quickly 365 * look up the state needed to process it. A specific subclass 366 * would be derived from this to carry state specific to a 367 * particular sending device. 368 * 369 * As multiple MemObjects may add their SenderState throughout the 370 * memory system, the SenderStates create a stack, where a 371 * MemObject can add a new Senderstate, as long as the 372 * predecessing SenderState is restored when the response comes 373 * back. For this reason, the predecessor should always be 374 * populated with the current SenderState of a packet before 375 * modifying the senderState field in the request packet. 376 */ 377 struct SenderState 378 { 379 SenderState* predecessor; 380 SenderState() : predecessor(NULL) {} 381 virtual ~SenderState() {} 382 }; 383 384 /** 385 * Object used to maintain state of a PrintReq. The senderState 386 * field of a PrintReq should always be of this type. 387 */ 388 class PrintReqState : public SenderState 389 { 390 private: 391 /** 392 * An entry in the label stack. 393 */ 394 struct LabelStackEntry 395 { 396 const std::string label; 397 std::string *prefix; 398 bool labelPrinted; 399 LabelStackEntry(const std::string &_label, std::string *_prefix); 400 }; 401 402 typedef std::list<LabelStackEntry> LabelStack; 403 LabelStack labelStack; 404 405 std::string *curPrefixPtr; 406 407 public: 408 std::ostream &os; 409 const int verbosity; 410 411 PrintReqState(std::ostream &os, int verbosity = 0); 412 ~PrintReqState(); 413 414 /** 415 * Returns the current line prefix. 416 */ 417 const std::string &curPrefix() { return *curPrefixPtr; } 418 419 /** 420 * Push a label onto the label stack, and prepend the given 421 * prefix string onto the current prefix. Labels will only be 422 * printed if an object within the label's scope is printed. 423 */ 424 void pushLabel(const std::string &lbl, 425 const std::string &prefix = " "); 426 427 /** 428 * Pop a label off the label stack. 429 */ 430 void popLabel(); 431 432 /** 433 * Print all of the pending unprinted labels on the 434 * stack. Called by printObj(), so normally not called by 435 * users unless bypassing printObj(). 436 */ 437 void printLabels(); 438 439 /** 440 * Print a Printable object to os, because it matched the 441 * address on a PrintReq. 442 */ 443 void printObj(Printable *obj); 444 }; 445 446 /** 447 * This packet's sender state. Devices should use dynamic_cast<> 448 * to cast to the state appropriate to the sender. The intent of 449 * this variable is to allow a device to attach extra information 450 * to a request. A response packet must return the sender state 451 * that was attached to the original request (even if a new packet 452 * is created). 453 */ 454 SenderState *senderState; 455 456 /** 457 * Push a new sender state to the packet and make the current 458 * sender state the predecessor of the new one. This should be 459 * prefered over direct manipulation of the senderState member 460 * variable. 461 * 462 * @param sender_state SenderState to push at the top of the stack 463 */ 464 void pushSenderState(SenderState *sender_state); 465 466 /** 467 * Pop the top of the state stack and return a pointer to it. This 468 * assumes the current sender state is not NULL. This should be 469 * preferred over direct manipulation of the senderState member 470 * variable. 471 * 472 * @return The current top of the stack 473 */ 474 SenderState *popSenderState(); 475 476 /** 477 * Go through the sender state stack and return the first instance 478 * that is of type T (as determined by a dynamic_cast). If there 479 * is no sender state of type T, NULL is returned. 480 * 481 * @return The topmost state of type T 482 */ 483 template <typename T> 484 T * findNextSenderState() const 485 { 486 T *t = NULL; 487 SenderState* sender_state = senderState; 488 while (t == NULL && sender_state != NULL) { 489 t = dynamic_cast<T*>(sender_state); 490 sender_state = sender_state->predecessor; 491 } 492 return t; 493 } 494 495 /// Return the string name of the cmd field (for debugging and 496 /// tracing). 497 const std::string &cmdString() const { return cmd.toString(); } 498 499 /// Return the index of this command. 500 inline int cmdToIndex() const { return cmd.toInt(); } 501 502 bool isRead() const { return cmd.isRead(); } 503 bool isWrite() const { return cmd.isWrite(); } 504 bool isUpgrade() const { return cmd.isUpgrade(); } 505 bool isRequest() const { return cmd.isRequest(); } 506 bool isResponse() const { return cmd.isResponse(); } 507 bool needsExclusive() const { return cmd.needsExclusive(); } 508 bool needsResponse() const { return cmd.needsResponse(); } 509 bool isInvalidate() const { return cmd.isInvalidate(); } 510 bool hasData() const { return cmd.hasData(); } 511 bool isReadWrite() const { return cmd.isReadWrite(); } 512 bool isLLSC() const { return cmd.isLLSC(); } 513 bool isError() const { return cmd.isError(); } 514 bool isPrint() const { return cmd.isPrint(); } 515 bool isFlush() const { return cmd.isFlush(); } 516 517 // Snoop flags 518 void assertMemInhibit() { flags.set(MEM_INHIBIT); } 519 bool memInhibitAsserted() const { return flags.isSet(MEM_INHIBIT); } 520 void assertShared() { flags.set(SHARED); } 521 bool sharedAsserted() const { return flags.isSet(SHARED); } 522 523 // Special control flags 524 void setExpressSnoop() { flags.set(EXPRESS_SNOOP); } 525 bool isExpressSnoop() const { return flags.isSet(EXPRESS_SNOOP); } 526 void setSupplyExclusive() { flags.set(SUPPLY_EXCLUSIVE); } 527 void clearSupplyExclusive() { flags.clear(SUPPLY_EXCLUSIVE); } 528 bool isSupplyExclusive() const { return flags.isSet(SUPPLY_EXCLUSIVE); } 529 void setSuppressFuncError() { flags.set(SUPPRESS_FUNC_ERROR); } 530 bool suppressFuncError() const { return flags.isSet(SUPPRESS_FUNC_ERROR); } 531 void setPrefetchSquashed() { flags.set(PREFETCH_SNOOP_SQUASH); } 532 bool prefetchSquashed() const { return flags.isSet(PREFETCH_SNOOP_SQUASH); } 533 534 // Network error conditions... encapsulate them as methods since 535 // their encoding keeps changing (from result field to command 536 // field, etc.) 537 void 538 setBadAddress() 539 { 540 assert(isResponse()); 541 cmd = MemCmd::BadAddressError; 542 } 543 544 bool hadBadAddress() const { return cmd == MemCmd::BadAddressError; } 545 void copyError(Packet *pkt) { assert(pkt->isError()); cmd = pkt->cmd; } 546 547 bool isSrcValid() const { return src != InvalidPortID; } 548 /// Accessor function to get the source index of the packet. 549 PortID getSrc() const { assert(isSrcValid()); return src; } 550 /// Accessor function to set the source index of the packet. 551 void setSrc(PortID _src) { src = _src; } 552 /// Reset source field, e.g. to retransmit packet on different bus. 553 void clearSrc() { src = InvalidPortID; } 554 555 bool isDestValid() const { return dest != InvalidPortID; } 556 /// Accessor function for the destination index of the packet. 557 PortID getDest() const { assert(isDestValid()); return dest; } 558 /// Accessor function to set the destination index of the packet. 559 void setDest(PortID _dest) { dest = _dest; } 560 /// Reset destination field, e.g. to turn a response into a request again. 561 void clearDest() { dest = InvalidPortID; } 562 563 Addr getAddr() const { assert(flags.isSet(VALID_ADDR)); return addr; } 564 /** 565 * Update the address of this packet mid-transaction. This is used 566 * by the address mapper to change an already set address to a new 567 * one based on the system configuration. It is intended to remap 568 * an existing address, so it asserts that the current address is 569 * valid. 570 */ 571 void setAddr(Addr _addr) { assert(flags.isSet(VALID_ADDR)); addr = _addr; } 572 573 unsigned getSize() const { assert(flags.isSet(VALID_SIZE)); return size; } 574 Addr getOffset(int blkSize) const { return getAddr() & (Addr)(blkSize - 1); } 575 576 bool isSecure() const 577 { 578 assert(flags.isSet(VALID_ADDR)); 579 return _isSecure; 580 } 581 582 /** 583 * It has been determined that the SC packet should successfully update 584 * memory. Therefore, convert this SC packet to a normal write. 585 */ 586 void 587 convertScToWrite() 588 { 589 assert(isLLSC()); 590 assert(isWrite()); 591 cmd = MemCmd::WriteReq; 592 } 593 594 /** 595 * When ruby is in use, Ruby will monitor the cache line and thus M5 596 * phys memory should treat LL ops as normal reads. 597 */ 598 void 599 convertLlToRead() 600 { 601 assert(isLLSC()); 602 assert(isRead()); 603 cmd = MemCmd::ReadReq; 604 } 605 606 /** 607 * Constructor. Note that a Request object must be constructed 608 * first, but the Requests's physical address and size fields need 609 * not be valid. The command must be supplied. 610 */ 611 Packet(Request *_req, MemCmd _cmd) 612 : cmd(_cmd), req(_req), data(NULL), 613 src(InvalidPortID), dest(InvalidPortID), 614 bytesValidStart(0), bytesValidEnd(0), 615 busFirstWordDelay(0), busLastWordDelay(0), 616 senderState(NULL) 617 { 618 if (req->hasPaddr()) { 619 addr = req->getPaddr(); 620 flags.set(VALID_ADDR); 621 _isSecure = req->isSecure(); 622 } 623 if (req->hasSize()) { 624 size = req->getSize(); 625 flags.set(VALID_SIZE); 626 } 627 } 628 629 /** 630 * Alternate constructor if you are trying to create a packet with 631 * a request that is for a whole block, not the address from the 632 * req. this allows for overriding the size/addr of the req. 633 */ 634 Packet(Request *_req, MemCmd _cmd, int _blkSize) 635 : cmd(_cmd), req(_req), data(NULL), 636 src(InvalidPortID), dest(InvalidPortID), 637 bytesValidStart(0), bytesValidEnd(0), 638 busFirstWordDelay(0), busLastWordDelay(0), 639 senderState(NULL) 640 { 641 if (req->hasPaddr()) { 642 addr = req->getPaddr() & ~(_blkSize - 1); 643 flags.set(VALID_ADDR); 644 _isSecure = req->isSecure(); 645 } 646 size = _blkSize; 647 flags.set(VALID_SIZE); 648 } 649 650 /** 651 * Alternate constructor for copying a packet. Copy all fields 652 * *except* if the original packet's data was dynamic, don't copy 653 * that, as we can't guarantee that the new packet's lifetime is 654 * less than that of the original packet. In this case the new 655 * packet should allocate its own data. 656 */ 657 Packet(Packet *pkt, bool clearFlags = false) 658 : cmd(pkt->cmd), req(pkt->req), 659 data(pkt->flags.isSet(STATIC_DATA) ? pkt->data : NULL), 660 addr(pkt->addr), _isSecure(pkt->_isSecure), size(pkt->size), 661 src(pkt->src), dest(pkt->dest), 662 bytesValidStart(pkt->bytesValidStart), 663 bytesValidEnd(pkt->bytesValidEnd), 664 busFirstWordDelay(pkt->busFirstWordDelay), 665 busLastWordDelay(pkt->busLastWordDelay), 666 senderState(pkt->senderState) 667 { 668 if (!clearFlags) 669 flags.set(pkt->flags & COPY_FLAGS); 670 671 flags.set(pkt->flags & (VALID_ADDR|VALID_SIZE)); 672 flags.set(pkt->flags & STATIC_DATA); 673 } 674 675 /** 676 * Change the packet type based on request type. 677 */ 678 void 679 refineCommand() 680 { 681 if (cmd == MemCmd::ReadReq) { 682 if (req->isLLSC()) { 683 cmd = MemCmd::LoadLockedReq; 684 } else if (req->isPrefetch()) { 685 cmd = MemCmd::SoftPFReq; 686 } 687 } else if (cmd == MemCmd::WriteReq) { 688 if (req->isLLSC()) { 689 cmd = MemCmd::StoreCondReq; 690 } else if (req->isSwap()) { 691 cmd = MemCmd::SwapReq; 692 } 693 } 694 } 695 696 /** 697 * Constructor-like methods that return Packets based on Request objects. 698 * Will call refineCommand() to fine-tune the Packet type if it's not a 699 * vanilla read or write. 700 */ 701 static PacketPtr 702 createRead(Request *req) 703 { 704 PacketPtr pkt = new Packet(req, MemCmd::ReadReq); 705 pkt->refineCommand(); 706 return pkt; 707 } 708 709 static PacketPtr 710 createWrite(Request *req) 711 { 712 PacketPtr pkt = new Packet(req, MemCmd::WriteReq); 713 pkt->refineCommand(); 714 return pkt; 715 } 716 717 /** 718 * clean up packet variables 719 */ 720 ~Packet() 721 { 722 // If this is a request packet for which there's no response, 723 // delete the request object here, since the requester will 724 // never get the chance. 725 if (req && isRequest() && !needsResponse()) 726 delete req; 727 deleteData(); 728 } 729 730 /** 731 * Reinitialize packet address and size from the associated 732 * Request object, and reset other fields that may have been 733 * modified by a previous transaction. Typically called when a 734 * statically allocated Request/Packet pair is reused for multiple 735 * transactions. 736 */ 737 void 738 reinitFromRequest() 739 { 740 assert(req->hasPaddr()); 741 flags = 0; 742 addr = req->getPaddr(); 743 _isSecure = req->isSecure(); 744 size = req->getSize(); 745 746 src = InvalidPortID; 747 dest = InvalidPortID; 748 bytesValidStart = 0; 749 bytesValidEnd = 0; 750 busFirstWordDelay = 0; 751 busLastWordDelay = 0; 752 753 flags.set(VALID_ADDR|VALID_SIZE); 754 deleteData(); 755 } 756 757 /** 758 * Take a request packet and modify it in place to be suitable for 759 * returning as a response to that request. The source field is 760 * turned into the destination, and subsequently cleared. Note 761 * that the latter is not necessary for atomic requests, but 762 * causes no harm as neither field is valid. 763 */ 764 void 765 makeResponse() 766 { 767 assert(needsResponse()); 768 assert(isRequest()); 769 origCmd = cmd; 770 cmd = cmd.responseCommand(); 771 772 // responses are never express, even if the snoop that 773 // triggered them was 774 flags.clear(EXPRESS_SNOOP); 775 776 dest = src; 777 clearSrc(); 778 } 779 780 void 781 makeAtomicResponse() 782 { 783 makeResponse(); 784 } 785 786 void 787 makeTimingResponse() 788 { 789 makeResponse(); 790 } 791 792 void 793 setFunctionalResponseStatus(bool success) 794 { 795 if (!success) { 796 if (isWrite()) { 797 cmd = MemCmd::FunctionalWriteError; 798 } else { 799 cmd = MemCmd::FunctionalReadError; 800 } 801 } 802 } 803 804 void 805 setSize(unsigned size) 806 { 807 assert(!flags.isSet(VALID_SIZE)); 808 809 this->size = size; 810 flags.set(VALID_SIZE); 811 } 812 813 814 /** 815 * Set the data pointer to the following value that should not be 816 * freed. 817 */ 818 template <typename T> 819 void 820 dataStatic(T *p) 821 { 822 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 823 data = (PacketDataPtr)p; 824 flags.set(STATIC_DATA); 825 } 826 827 /** 828 * Set the data pointer to a value that should have delete [] 829 * called on it. 830 */ 831 template <typename T> 832 void 833 dataDynamicArray(T *p) 834 { 835 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 836 data = (PacketDataPtr)p; 837 flags.set(DYNAMIC_DATA|ARRAY_DATA); 838 } 839 840 /** 841 * set the data pointer to a value that should have delete called 842 * on it. 843 */ 844 template <typename T> 845 void 846 dataDynamic(T *p) 847 { 848 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA)); 849 data = (PacketDataPtr)p; 850 flags.set(DYNAMIC_DATA); 851 } 852 853 /** 854 * get a pointer to the data ptr. 855 */ 856 template <typename T> 857 T* 858 getPtr(bool null_ok = false) 859 { 860 assert(null_ok || flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 861 return (T*)data; 862 } 863 864 /** 865 * return the value of what is pointed to in the packet. 866 */ 867 template <typename T> 868 T get(); 869 870 /** 871 * set the value in the data pointer to v. 872 */ 873 template <typename T> 874 void set(T v); 875 876 /** 877 * Copy data into the packet from the provided pointer. 878 */ 879 void 880 setData(uint8_t *p) 881 { 882 if (p != getPtr<uint8_t>()) 883 std::memcpy(getPtr<uint8_t>(), p, getSize()); 884 } 885 886 /** 887 * Copy data into the packet from the provided block pointer, 888 * which is aligned to the given block size. 889 */ 890 void 891 setDataFromBlock(uint8_t *blk_data, int blkSize) 892 { 893 setData(blk_data + getOffset(blkSize)); 894 } 895 896 /** 897 * Copy data from the packet to the provided block pointer, which 898 * is aligned to the given block size. 899 */ 900 void 901 writeData(uint8_t *p) 902 { 903 std::memcpy(p, getPtr<uint8_t>(), getSize()); 904 } 905 906 /** 907 * Copy data from the packet to the memory at the provided pointer. 908 */ 909 void 910 writeDataToBlock(uint8_t *blk_data, int blkSize) 911 { 912 writeData(blk_data + getOffset(blkSize)); 913 } 914 915 /** 916 * delete the data pointed to in the data pointer. Ok to call to 917 * matter how data was allocted. 918 */ 919 void 920 deleteData() 921 { 922 if (flags.isSet(ARRAY_DATA)) 923 delete [] data; 924 else if (flags.isSet(DYNAMIC_DATA)) 925 delete data; 926 927 flags.clear(STATIC_DATA|DYNAMIC_DATA|ARRAY_DATA); 928 data = NULL; 929 } 930 931 /** If there isn't data in the packet, allocate some. */ 932 void 933 allocate() 934 { 935 if (data) { 936 assert(flags.isSet(STATIC_DATA|DYNAMIC_DATA)); 937 return; 938 } 939 940 assert(flags.noneSet(STATIC_DATA|DYNAMIC_DATA)); 941 flags.set(DYNAMIC_DATA|ARRAY_DATA); 942 data = new uint8_t[getSize()]; 943 } 944 945 /** 946 * Check a functional request against a memory value represented 947 * by a base/size pair and an associated data array. If the 948 * functional request is a read, it may be satisfied by the memory 949 * value. If the functional request is a write, it may update the 950 * memory value. 951 */ 952 bool checkFunctional(Printable *obj, Addr base, bool is_secure, int size, 953 uint8_t *data); 954 955 /** 956 * Check a functional request against a memory value stored in 957 * another packet (i.e. an in-transit request or response). 958 */ 959 bool 960 checkFunctional(PacketPtr other) 961 { 962 uint8_t *data = other->hasData() ? other->getPtr<uint8_t>() : NULL; 963 return checkFunctional(other, other->getAddr(), other->isSecure(), 964 other->getSize(), data); 965 } 966 967 /** 968 * Push label for PrintReq (safe to call unconditionally). 969 */ 970 void 971 pushLabel(const std::string &lbl) 972 { 973 if (isPrint()) 974 safe_cast<PrintReqState*>(senderState)->pushLabel(lbl); 975 } 976 977 /** 978 * Pop label for PrintReq (safe to call unconditionally). 979 */ 980 void 981 popLabel() 982 { 983 if (isPrint()) 984 safe_cast<PrintReqState*>(senderState)->popLabel(); 985 } 986 987 void print(std::ostream &o, int verbosity = 0, 988 const std::string &prefix = "") const; 989 990 /** 991 * A no-args wrapper of print(std::ostream...) 992 * meant to be invoked from DPRINTFs 993 * avoiding string overheads in fast mode 994 * @return string with the request's type and start<->end addresses 995 */ 996 std::string print() const; 997}; 998 999#endif //__MEM_PACKET_HH 1000