Register ID: describe an architectural register with its class and index. More...

#include <reg_class.hh>

Inheritance diagram for gem5::RegId:

Public Member Functions
	RegId ()

	RegId (RegClassType reg_class, RegIndex reg_idx)

	RegId (RegClassType reg_class, RegIndex reg_idx, ElemIndex elem_idx)

bool	operator== (const RegId &that) const

bool	operator!= (const RegId &that) const

bool	operator< (const RegId &that) const
	Order operator. More...

bool	isRenameable () const
	Return true if this register can be renamed. More...

bool	is (RegClassType reg_class) const

RegIndex	elemIndex () const
	Elem accessor. More...

RegClassType	classValue () const
	Class accessor. More...

const char *	className () const
	Return a const char* with the register class name. More...

int	getNumPinnedWrites () const

void	setNumPinnedWrites (int num_writes)


RegIndex	index () const
	Index accessors. More...

RegIndex	flatIndex () const
	Index flattening. More...

Protected Attributes
RegClassType	regClass

RegIndex	regIdx

ElemIndex	elemIdx

int	numPinnedWrites

Static Protected Attributes
static const char *	regClassStrings []

static constexpr size_t	Scale = TheISA::NumVecElemPerVecReg

Friends
struct	std::hash< RegId >

std::ostream &	operator<< (std::ostream &os, const RegId &rid)

Detailed Description

Register ID: describe an architectural register with its class and index.

This structure is used instead of just the register index to disambiguate between different classes of registers. For example, a integer register with index 3 is represented by Regid(IntRegClass, 3).

Definition at line 113 of file reg_class.hh.

Constructor & Destructor Documentation

◆ RegId() [1/3]

gem5::RegId::RegId ( )

inline

Definition at line 126 of file reg_class.hh.

◆ RegId() [2/3]

gem5::RegId::RegId	(	RegClassType	reg_class,
		RegIndex	reg_idx
	)

inline

Definition at line 128 of file reg_class.hh.

◆ RegId() [3/3]

gem5::RegId::RegId	(	RegClassType	reg_class,
		RegIndex	reg_idx,
		ElemIndex	elem_idx
	)

inlineexplicit

Definition at line 131 of file reg_class.hh.

References elemIdx, gem5::IllegalElemIndex, panic_if, regClass, and gem5::VecElemClass.

Member Function Documentation

◆ className()

const char* gem5::RegId::className ( ) const

inline

Return a const char* with the register class name.

Definition at line 208 of file reg_class.hh.

References regClass, and regClassStrings.

Referenced by gem5::o3::UnifiedRenameMap::lookup(), gem5::o3::UnifiedRenameMap::rename(), gem5::o3::Rename::renameDestRegs(), gem5::o3::Rename::renameSrcRegs(), gem5::o3::UnifiedRenameMap::setEntry(), and gem5::o3::ElasticTrace::updateRegDep().

◆ classValue()

RegClassType gem5::RegId::classValue ( ) const

inline

Class accessor.

Definition at line 206 of file reg_class.hh.

References regClass.

Referenced by gem5::Checker< gem5::RefCountingPtr >::copyResult(), gem5::X86ISA::ISA::flattenRegId(), gem5::SparcISA::ISA::flattenRegId(), gem5::ArmISA::ISA::flattenRegId(), gem5::o3::DynInst::forwardOldRegs(), gem5::o3::UnifiedRenameMap::lookup(), operator<(), operator==(), gem5::o3::UnifiedRenameMap::rename(), gem5::o3::Rename::renameSrcRegs(), and gem5::o3::UnifiedRenameMap::setEntry().

◆ elemIndex()

RegIndex gem5::RegId::elemIndex ( ) const

inline

Elem accessor.

Definition at line 204 of file reg_class.hh.

References elemIdx.

Referenced by gem5::ArmISA::ISA::flattenRegId(), operator<(), and operator==().

◆ flatIndex()

RegIndex gem5::RegId::flatIndex ( ) const

inline

Index flattening.

Required to be able to use a vector for the register mapping.

Definition at line 186 of file reg_class.hh.

References gem5::CCRegClass, elemIdx, gem5::FloatRegClass, gem5::IntRegClass, gem5::MiscRegClass, panic, regClass, regIdx, Scale, gem5::VecElemClass, gem5::VecPredRegClass, and gem5::VecRegClass.

Referenced by gem5::o3::SimpleRenameMap::lookup(), gem5::o3::UnifiedRenameMap::lookup(), std::hash< gem5::RegId >::operator()(), gem5::o3::SimpleRenameMap::rename(), and gem5::o3::SimpleRenameMap::setEntry().

◆ getNumPinnedWrites()

int gem5::RegId::getNumPinnedWrites ( ) const

inline

Definition at line 210 of file reg_class.hh.

References numPinnedWrites.

Referenced by gem5::o3::SimpleRenameMap::rename(), and gem5::o3::Rename::renameDestRegs().

◆ index()

RegIndex gem5::RegId::index ( ) const

inline

Index accessors.

Definition at line 180 of file reg_class.hh.

References regIdx.

Referenced by gem5::Checker< gem5::RefCountingPtr >::copyResult(), gem5::TimingExprSrcReg::eval(), gem5::X86ISA::ISA::flattenRegId(), gem5::SparcISA::ISA::flattenRegId(), gem5::ArmISA::ISA::flattenRegId(), operator<(), operator==(), gem5::Iris::ThreadContext::readVecPredReg(), gem5::Iris::ThreadContext::readVecReg(), gem5::o3::SimpleRenameMap::rename(), gem5::o3::Rename::renameDestRegs(), gem5::o3::Rename::renameSrcRegs(), gem5::o3::PhysRegFile::setIntReg(), gem5::CheckerCPU::setMiscRegOperand(), and gem5::o3::ElasticTrace::updateRegDep().

◆ is()

bool gem5::RegId::is ( RegClassType reg_class ) const

inline

Returns: true if it is of the specified class.

Definition at line 176 of file reg_class.hh.

References regClass.

Referenced by gem5::o3::ElasticTrace::updateRegDep().

◆ isRenameable()

bool gem5::RegId::isRenameable ( ) const

inline

Return true if this register can be renamed.

Definition at line 170 of file reg_class.hh.

References gem5::MiscRegClass, and regClass.

Referenced by gem5::PhysRegId::isFixedMapping().

◆ operator!=()

bool gem5::RegId::operator!= ( const RegId & that ) const

inline

Definition at line 152 of file reg_class.hh.

Referenced by gem5::PhysRegId::operator!=().

◆ operator<()

bool gem5::RegId::operator< ( const RegId & that ) const

inline

Order operator.

The order is required to implement maps with key type RegId

Definition at line 158 of file reg_class.hh.

References classValue(), elemIdx, elemIndex(), index(), regClass, and regIdx.

Referenced by gem5::PhysRegId::operator<().

◆ operator==()

bool gem5::RegId::operator== ( const RegId & that ) const

inline

Definition at line 146 of file reg_class.hh.

References classValue(), elemIdx, elemIndex(), index(), regClass, and regIdx.

Referenced by gem5::PhysRegId::operator==().

◆ setNumPinnedWrites()

void gem5::RegId::setNumPinnedWrites ( int num_writes )

inline

Definition at line 211 of file reg_class.hh.

References numPinnedWrites.

Referenced by gem5::o3::Rename::renameDestRegs().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const RegId &	rid
	)

friend

Definition at line 214 of file reg_class.hh.

◆ std::hash< RegId >

friend struct std::hash< RegId >

friend

Definition at line 123 of file reg_class.hh.

Member Data Documentation

◆ elemIdx

ElemIndex gem5::RegId::elemIdx

protected

Definition at line 119 of file reg_class.hh.

Referenced by elemIndex(), flatIndex(), operator<(), operator==(), and RegId().

◆ numPinnedWrites

int gem5::RegId::numPinnedWrites

protected

Definition at line 121 of file reg_class.hh.

Referenced by gem5::PhysRegId::decrNumPinnedWrites(), getNumPinnedWrites(), gem5::PhysRegId::getNumPinnedWrites(), gem5::PhysRegId::incrNumPinnedWrites(), setNumPinnedWrites(), and gem5::PhysRegId::setNumPinnedWrites().

◆ regClass

RegClassType gem5::RegId::regClass

protected

Definition at line 117 of file reg_class.hh.

Referenced by className(), classValue(), flatIndex(), is(), isRenameable(), std::hash< gem5::RegId >::operator()(), operator<(), operator==(), and RegId().

◆ regClassStrings

const char * gem5::RegId::regClassStrings

staticprotected

Initial value:

= {
    "IntRegClass",
    "FloatRegClass",
    "VecRegClass",
    "VecElemClass",
    "VecPredRegClass",
    "CCRegClass",
    "MiscRegClass"
}

Definition at line 116 of file reg_class.hh.

Referenced by className().

◆ regIdx

RegIndex gem5::RegId::regIdx

protected

Definition at line 118 of file reg_class.hh.

Referenced by flatIndex(), index(), operator<(), and operator==().

◆ Scale

constexpr size_t gem5::RegId::Scale = TheISA::NumVecElemPerVecReg

staticconstexprprotected

Definition at line 120 of file reg_class.hh.

Referenced by flatIndex().

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

cpu/reg_class.hh
cpu/reg_class.cc

Public Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ RegId() [1/3]

◆ RegId() [2/3]

◆ RegId() [3/3]

Member Function Documentation

◆ className()

◆ classValue()

◆ elemIndex()

◆ flatIndex()

◆ getNumPinnedWrites()

◆ index()

◆ is()

◆ isRenameable()

◆ operator!=()

◆ operator<()

◆ operator==()

◆ setNumPinnedWrites()

Friends And Related Function Documentation

◆ operator<<

◆ std::hash< RegId >

Member Data Documentation

◆ elemIdx

◆ numPinnedWrites

◆ regClass

◆ regClassStrings

◆ regIdx

◆ Scale