gem5  v21.0.1.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ArmISA::TableWalker::LongDescriptor Class Reference

Long-descriptor format (LPAE) More...

#include <table_walker.hh>

Inheritance diagram for ArmISA::TableWalker::LongDescriptor:
ArmISA::TableWalker::DescriptorBase

Public Types

enum  EntryType { Invalid, Table, Block, Page }
 Descriptor type. More...
 

Public Member Functions

 LongDescriptor ()
 
virtual uint64_t getRawData () const
 
virtual std::string dbgHeader () const
 
bool secure (bool have_security, WalkerState *currState) const
 Returns true if this entry targets the secure physical address map. More...
 
EntryType type () const
 Return the descriptor type. More...
 
uint8_t offsetBits () const
 Return the bit width of the page/block offset. More...
 
Addr pfn () const
 Return the physical frame, bits shifted right. More...
 
Addr paddr () const
 Return the physical address of the entry. More...
 
Addr nextTableAddr () const
 Return the address of the next page table. More...
 
Addr nextDescAddr (Addr va) const
 Return the address of the next descriptor. More...
 
bool xn () const
 Is execution allowed on this mapping? More...
 
bool pxn () const
 Is privileged execution allowed on this mapping? (LPAE only) More...
 
bool contiguousHint () const
 Contiguous hint bit. More...
 
bool global (WalkerState *currState) const
 Is the translation global (no asid used)? More...
 
bool af () const
 Returns true if the access flag (AF) is set. More...
 
uint8_t sh () const
 2-bit shareability field More...
 
uint8_t ap () const
 2-bit access protection flags More...
 
bool rw () const
 Read/write access protection flag. More...
 
bool user () const
 User/privileged level access protection flag. More...
 
TlbEntry::DomainType domain () const
 
uint8_t attrIndx () const
 Attribute index. More...
 
uint8_t memAttr () const
 Memory attributes, only used by stage 2 translations. More...
 
void setAf ()
 Set access flag that this entry has been touched. More...
 
bool dirty () const
 This entry needs to be written back to memory. More...
 
bool secureTable () const
 Whether the subsequent levels of lookup are secure. More...
 
uint8_t apTable () const
 Two bit access protection flags for subsequent levels of lookup. More...
 
uint8_t rwTable () const
 R/W protection flag for subsequent levels of lookup. More...
 
uint8_t userTable () const
 User/privileged mode protection flag for subsequent levels of lookup. More...
 
bool xnTable () const
 Is execution allowed on subsequent lookup levels? More...
 
bool pxnTable () const
 Is privileged execution allowed on subsequent lookup levels? More...
 
- Public Member Functions inherited from ArmISA::TableWalker::DescriptorBase
 DescriptorBase ()
 
virtual uint8_t texcb () const
 
virtual bool shareable () const
 

Static Public Member Functions

static uint8_t ap (bool rw, bool user)
 Return the AP bits as compatible with the AP[2:0] format. More...
 

Public Attributes

uint64_t data
 The raw bits of the entry. More...
 
bool _dirty
 This entry has been modified (access flag set) and needs to be written back to memory. More...
 
bool aarch64
 True if the current lookup is performed in AArch64 state. More...
 
GrainSize grainSize
 Width of the granule size in bits. More...
 
uint8_t physAddrRange
 
- Public Attributes inherited from ArmISA::TableWalker::DescriptorBase
LookupLevel lookupLevel
 Current lookup level for this descriptor. More...
 

Detailed Description

Long-descriptor format (LPAE)

Definition at line 375 of file table_walker.hh.

Member Enumeration Documentation

◆ EntryType

Descriptor type.

Enumerator
Invalid 
Table 
Block 
Page 

Definition at line 378 of file table_walker.hh.

Constructor & Destructor Documentation

◆ LongDescriptor()

ArmISA::TableWalker::LongDescriptor::LongDescriptor ( )
inline

Definition at line 385 of file table_walker.hh.

Member Function Documentation

◆ af()

bool ArmISA::TableWalker::LongDescriptor::af ( ) const
inline

Returns true if the access flag (AF) is set.

Definition at line 598 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

◆ ap() [1/2]

uint8_t ArmISA::TableWalker::LongDescriptor::ap ( ) const
inlinevirtual

2-bit access protection flags

Implements ArmISA::TableWalker::DescriptorBase.

Definition at line 612 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor(), and ArmISA::TableWalker::insertTableEntry().

◆ ap() [2/2]

static uint8_t ArmISA::TableWalker::LongDescriptor::ap ( bool  rw,
bool  user 
)
inlinestatic

Return the AP bits as compatible with the AP[2:0] format.

Utility function used to simplify the code in the TLB for performing permission checks.

Definition at line 636 of file table_walker.hh.

References rw(), and user().

◆ apTable()

uint8_t ArmISA::TableWalker::LongDescriptor::apTable ( ) const
inline

Two bit access protection flags for subsequent levels of lookup.

Definition at line 684 of file table_walker.hh.

References bits(), data, Table, and type().

◆ attrIndx()

uint8_t ArmISA::TableWalker::LongDescriptor::attrIndx ( ) const
inline

Attribute index.

Definition at line 649 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::memAttrsAArch64(), and ArmISA::TableWalker::memAttrsLPAE().

◆ contiguousHint()

bool ArmISA::TableWalker::LongDescriptor::contiguousHint ( ) const
inline

Contiguous hint bit.

Definition at line 573 of file table_walker.hh.

References bits(), data, Page, and type().

◆ dbgHeader()

virtual std::string ArmISA::TableWalker::LongDescriptor::dbgHeader ( ) const
inlinevirtual

◆ dirty()

bool ArmISA::TableWalker::LongDescriptor::dirty ( ) const
inline

This entry needs to be written back to memory.

Definition at line 671 of file table_walker.hh.

References _dirty.

◆ domain()

TlbEntry::DomainType ArmISA::TableWalker::LongDescriptor::domain ( ) const
inlinevirtual

Implements ArmISA::TableWalker::DescriptorBase.

Definition at line 641 of file table_walker.hh.

References ArmISA::TlbEntry::Client, Page, and type().

◆ getRawData()

virtual uint64_t ArmISA::TableWalker::LongDescriptor::getRawData ( ) const
inlinevirtual

Implements ArmISA::TableWalker::DescriptorBase.

Definition at line 406 of file table_walker.hh.

References data.

◆ global()

bool ArmISA::TableWalker::LongDescriptor::global ( WalkerState currState) const
inlinevirtual

◆ memAttr()

uint8_t ArmISA::TableWalker::LongDescriptor::memAttr ( ) const
inline

Memory attributes, only used by stage 2 translations.

Definition at line 656 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::memAttrsAArch64(), and ArmISA::TableWalker::memAttrsLPAE().

◆ nextDescAddr()

Addr ArmISA::TableWalker::LongDescriptor::nextDescAddr ( Addr  va) const
inline

◆ nextTableAddr()

Addr ArmISA::TableWalker::LongDescriptor::nextTableAddr ( ) const
inline

Return the address of the next page table.

Definition at line 523 of file table_walker.hh.

References aarch64, bits(), data, ArmISA::TableWalker::Grain64KB, grainSize, mbits(), physAddrRange, Table, and type().

Referenced by nextDescAddr().

◆ offsetBits()

uint8_t ArmISA::TableWalker::LongDescriptor::offsetBits ( ) const
inlinevirtual

◆ paddr()

Addr ArmISA::TableWalker::LongDescriptor::paddr ( ) const
inline

Return the physical address of the entry.

Definition at line 508 of file table_walker.hh.

References aarch64, X86ISA::addr, bits(), data, ArmISA::TableWalker::Grain64KB, grainSize, mbits(), offsetBits(), and physAddrRange.

Referenced by ArmISA::TableWalker::doLongDescriptor(), and pfn().

◆ pfn()

Addr ArmISA::TableWalker::LongDescriptor::pfn ( ) const
inlinevirtual

Return the physical frame, bits shifted right.

Implements ArmISA::TableWalker::DescriptorBase.

Definition at line 502 of file table_walker.hh.

References offsetBits(), and paddr().

◆ pxn()

bool ArmISA::TableWalker::LongDescriptor::pxn ( ) const
inline

Is privileged execution allowed on this mapping? (LPAE only)

Definition at line 566 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor(), and ArmISA::TableWalker::insertTableEntry().

◆ pxnTable()

bool ArmISA::TableWalker::LongDescriptor::pxnTable ( ) const
inline

Is privileged execution allowed on subsequent lookup levels?

Definition at line 713 of file table_walker.hh.

References bits(), data, Table, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

◆ rw()

bool ArmISA::TableWalker::LongDescriptor::rw ( ) const
inline

Read/write access protection flag.

Definition at line 620 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ap().

◆ rwTable()

uint8_t ArmISA::TableWalker::LongDescriptor::rwTable ( ) const
inline

R/W protection flag for subsequent levels of lookup.

Definition at line 691 of file table_walker.hh.

References bits(), data, Table, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

◆ secure()

bool ArmISA::TableWalker::LongDescriptor::secure ( bool  have_security,
WalkerState currState 
) const
inlinevirtual

Returns true if this entry targets the secure physical address map.

Implements ArmISA::TableWalker::DescriptorBase.

Definition at line 426 of file table_walker.hh.

References bits(), ArmISA::TableWalker::currState, data, Page, ArmISA::TableWalker::WalkerState::secureLookup, and type().

◆ secureTable()

bool ArmISA::TableWalker::LongDescriptor::secureTable ( ) const
inline

Whether the subsequent levels of lookup are secure.

Definition at line 677 of file table_walker.hh.

References bits(), data, Table, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

◆ setAf()

void ArmISA::TableWalker::LongDescriptor::setAf ( )
inline

Set access flag that this entry has been touched.

Mark the entry as requiring a writeback, in the future.

Definition at line 664 of file table_walker.hh.

References _dirty, and data.

◆ sh()

uint8_t ArmISA::TableWalker::LongDescriptor::sh ( ) const
inline

2-bit shareability field

Definition at line 605 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::memAttrsAArch64(), and ArmISA::TableWalker::memAttrsLPAE().

◆ type()

EntryType ArmISA::TableWalker::LongDescriptor::type ( ) const
inline

◆ user()

bool ArmISA::TableWalker::LongDescriptor::user ( ) const
inline

User/privileged level access protection flag.

Definition at line 627 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ap().

◆ userTable()

uint8_t ArmISA::TableWalker::LongDescriptor::userTable ( ) const
inline

User/privileged mode protection flag for subsequent levels of lookup.

Definition at line 699 of file table_walker.hh.

References bits(), data, Table, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

◆ xn()

bool ArmISA::TableWalker::LongDescriptor::xn ( ) const
inlinevirtual

Is execution allowed on this mapping?

Implements ArmISA::TableWalker::DescriptorBase.

Definition at line 559 of file table_walker.hh.

References bits(), data, Page, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

◆ xnTable()

bool ArmISA::TableWalker::LongDescriptor::xnTable ( ) const
inline

Is execution allowed on subsequent lookup levels?

Definition at line 706 of file table_walker.hh.

References bits(), data, Table, and type().

Referenced by ArmISA::TableWalker::doLongDescriptor().

Member Data Documentation

◆ _dirty

bool ArmISA::TableWalker::LongDescriptor::_dirty

This entry has been modified (access flag set) and needs to be written back to memory.

Definition at line 395 of file table_walker.hh.

Referenced by dirty(), and setAf().

◆ aarch64

bool ArmISA::TableWalker::LongDescriptor::aarch64

True if the current lookup is performed in AArch64 state.

Definition at line 398 of file table_walker.hh.

Referenced by nextDescAddr(), nextTableAddr(), paddr(), and ArmISA::TableWalker::processWalkLPAE().

◆ data

uint64_t ArmISA::TableWalker::LongDescriptor::data

◆ grainSize

GrainSize ArmISA::TableWalker::LongDescriptor::grainSize

Width of the granule size in bits.

Definition at line 401 of file table_walker.hh.

Referenced by nextDescAddr(), nextTableAddr(), offsetBits(), paddr(), ArmISA::TableWalker::processWalkLPAE(), and type().

◆ physAddrRange

uint8_t ArmISA::TableWalker::LongDescriptor::physAddrRange

Definition at line 403 of file table_walker.hh.

Referenced by nextTableAddr(), paddr(), and type().


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

Generated on Tue Jun 22 2021 15:28:49 for gem5 by doxygen 1.8.17