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

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

#include <packet.hh>

Inheritance diagram for Packet::PrintReqState:
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 Packet::SenderState
 SenderState ()
 
virtual ~SenderState ()
 

Public Attributes

std::ostream & os
 
const int verbosity
 
- Public Attributes inherited from 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 442 of file packet.hh.

Member Typedef Documentation

◆ LabelStack

Definition at line 456 of file packet.hh.

Constructor & Destructor Documentation

◆ PrintReqState()

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

Definition at line 435 of file packet.cc.

References curPrefixPtr, and labelStack.

◆ ~PrintReqState()

Packet::PrintReqState::~PrintReqState ( )

Definition at line 441 of file packet.cc.

Member Function Documentation

◆ curPrefix()

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

Returns the current line prefix.

Definition at line 471 of file packet.hh.

References curPrefixPtr.

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

◆ popLabel()

void Packet::PrintReqState::popLabel ( )

Pop a label off the label stack.

Definition at line 465 of file packet.cc.

References curPrefixPtr, and labelStack.

◆ printLabels()

void 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 474 of file packet.cc.

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

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

◆ printObj()

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

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

Definition at line 491 of file packet.cc.

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

◆ pushLabel()

void 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 456 of file packet.cc.

References curPrefixPtr, and labelStack.

Member Data Documentation

◆ curPrefixPtr

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

Definition at line 459 of file packet.hh.

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

◆ labelStack

LabelStack Packet::PrintReqState::labelStack
private

Definition at line 457 of file packet.hh.

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

◆ os

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

Definition at line 462 of file packet.hh.

Referenced by AbstractMemory::functionalAccess(), printLabels(), and printObj().

◆ verbosity

const int Packet::PrintReqState::verbosity

Definition at line 463 of file packet.hh.

Referenced by printObj().


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

Generated on Wed Sep 30 2020 14:02:29 for gem5 by doxygen 1.8.17