gem5  v21.1.0.2
Classes | Public Member Functions | Public Attributes | Private Types | Private Attributes | List of all members
gem5::Packet::PrintReqState Class Reference

Object used to maintain state of a PrintReq. More...

#include <packet.hh>

Inheritance diagram for gem5::Packet::PrintReqState:
gem5::Packet::SenderState

Classes

struct  LabelStackEntry
 An entry in the label stack. More...
 

Public Member Functions

 PrintReqState (std::ostream &os, int verbosity=0)
 
 ~PrintReqState ()
 
const std::string & curPrefix ()
 Returns the current line prefix. More...
 
void pushLabel (const std::string &lbl, const std::string &prefix=" ")
 Push a label onto the label stack, and prepend the given prefix string onto the current prefix. More...
 
void popLabel ()
 Pop a label off the label stack. More...
 
void printLabels ()
 Print all of the pending unprinted labels on the stack. More...
 
void printObj (Printable *obj)
 Print a Printable object to os, because it matched the address on a PrintReq. More...
 
- Public Member Functions inherited from gem5::Packet::SenderState
 SenderState ()
 
virtual ~SenderState ()
 

Public Attributes

std::ostream & os
 
const int verbosity
 
- Public Attributes inherited from gem5::Packet::SenderState
SenderStatepredecessor
 

Private Types

typedef std::list< LabelStackEntryLabelStack
 

Private Attributes

LabelStack labelStack
 
std::string * curPrefixPtr
 

Detailed Description

Object used to maintain state of a PrintReq.

The senderState field of a PrintReq should always be of this type.

Definition at line 468 of file packet.hh.

Member Typedef Documentation

◆ LabelStack

Definition at line 482 of file packet.hh.

Constructor & Destructor Documentation

◆ PrintReqState()

gem5::Packet::PrintReqState::PrintReqState ( std::ostream &  os,
int  verbosity = 0 
)

Definition at line 419 of file packet.cc.

References curPrefixPtr, and labelStack.

◆ ~PrintReqState()

gem5::Packet::PrintReqState::~PrintReqState ( )

Definition at line 425 of file packet.cc.

Member Function Documentation

◆ curPrefix()

const std::string& gem5::Packet::PrintReqState::curPrefix ( )
inline

Returns the current line prefix.

Definition at line 497 of file packet.hh.

References curPrefixPtr.

Referenced by gem5::memory::AbstractMemory::functionalAccess(), and printObj().

◆ popLabel()

void gem5::Packet::PrintReqState::popLabel ( )

Pop a label off the label stack.

Definition at line 449 of file packet.cc.

References curPrefixPtr, and labelStack.

◆ printLabels()

void gem5::Packet::PrintReqState::printLabels ( )

Print all of the pending unprinted labels on the stack.

Called by printObj(), so normally not called by users unless bypassing printObj().

Definition at line 458 of file packet.cc.

References gem5::ccprintf(), gem5::ArmISA::i, labelStack, and os.

Referenced by gem5::memory::AbstractMemory::functionalAccess(), and printObj().

◆ printObj()

void gem5::Packet::PrintReqState::printObj ( Printable obj)

Print a Printable object to os, because it matched the address on a PrintReq.

Definition at line 475 of file packet.cc.

References curPrefix(), os, gem5::Printable::print(), printLabels(), and verbosity.

◆ pushLabel()

void gem5::Packet::PrintReqState::pushLabel ( const std::string &  lbl,
const std::string &  prefix = "  " 
)

Push a label onto the label stack, and prepend the given prefix string onto the current prefix.

Labels will only be printed if an object within the label's scope is printed.

Definition at line 440 of file packet.cc.

References curPrefixPtr, and labelStack.

Member Data Documentation

◆ curPrefixPtr

std::string* gem5::Packet::PrintReqState::curPrefixPtr
private

Definition at line 485 of file packet.hh.

Referenced by curPrefix(), popLabel(), PrintReqState(), and pushLabel().

◆ labelStack

LabelStack gem5::Packet::PrintReqState::labelStack
private

Definition at line 483 of file packet.hh.

Referenced by popLabel(), printLabels(), PrintReqState(), and pushLabel().

◆ os

std::ostream& gem5::Packet::PrintReqState::os

◆ verbosity

const int gem5::Packet::PrintReqState::verbosity

Definition at line 489 of file packet.hh.

Referenced by printObj().


The documentation for this class was generated from the following files:

Generated on Tue Sep 21 2021 12:27:52 for gem5 by doxygen 1.8.17