#include <DirectoryMemory.hh>

Inheritance diagram for gem5::ruby::DirectoryMemory:

Public Types
typedef RubyDirectoryMemoryParams	Params

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	DirectoryMemory (const Params &p)

	~DirectoryMemory ()

void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.

uint64_t	mapAddressToLocalIdx (Addr address)
	Return the index in the directory based on an address.

uint64_t	getSize ()

bool	isPresent (Addr address)

AbstractCacheEntry *	lookup (Addr address)

AbstractCacheEntry *	allocate (Addr address, AbstractCacheEntry *new_entry)

void	deallocate (Addr address)

void	print (std::ostream &out) const

void	recordRequestType (DirectoryRequestType requestType)

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

virtual void	startup ()
	startup() is the final initialization call before simulation.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from gem5::Drainable
DrainState	drainState () const
	Return the current drain state of an object.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from gem5::Named
	Named (const std::string &name_)

virtual	~Named ()=default

virtual std::string	name () const

Private Member Functions
	DirectoryMemory (const DirectoryMemory &obj)

DirectoryMemory &	operator= (const DirectoryMemory &obj)

Private Attributes
const std::string	m_name

AbstractCacheEntry **	m_entries

uint64_t	m_size_bytes

uint64_t	m_size_bits

uint64_t	m_num_entries

const AddrRangeList	addrRanges
	The address range for which the directory responds.

Additional Inherited Members
Static Public Member Functions inherited from gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Detailed Description

Definition at line 60 of file DirectoryMemory.hh.

Member Typedef Documentation

◆ Params

typedef RubyDirectoryMemoryParams gem5::ruby::DirectoryMemory::Params

Definition at line 63 of file DirectoryMemory.hh.

Constructor & Destructor Documentation

◆ DirectoryMemory() [1/2]

gem5::ruby::DirectoryMemory::DirectoryMemory ( const Params & p )

Definition at line 58 of file DirectoryMemory.cc.

References addrRanges, gem5::floorLog2(), m_num_entries, m_size_bits, m_size_bytes, and gem5::MipsISA::r.

◆ ~DirectoryMemory()

gem5::ruby::DirectoryMemory::~DirectoryMemory ( )

Definition at line 78 of file DirectoryMemory.cc.

References gem5::ArmISA::i, m_entries, and m_num_entries.

◆ DirectoryMemory() [2/2]

gem5::ruby::DirectoryMemory::DirectoryMemory ( const DirectoryMemory & obj )

private

Member Function Documentation

◆ allocate()

AbstractCacheEntry * gem5::ruby::DirectoryMemory::allocate	(	Addr	address,
		AbstractCacheEntry *	new_entry )

Definition at line 126 of file DirectoryMemory.cc.

References gem5::ruby::AbstractCacheEntry::changePermission(), DPRINTF, isPresent(), m_entries, m_num_entries, and mapAddressToLocalIdx().

◆ deallocate()

void gem5::ruby::DirectoryMemory::deallocate ( Addr address )

Definition at line 142 of file DirectoryMemory.cc.

References DPRINTF, isPresent(), m_entries, m_num_entries, and mapAddressToLocalIdx().

◆ getSize()

uint64_t gem5::ruby::DirectoryMemory::getSize ( )

inline

Definition at line 82 of file DirectoryMemory.hh.

References m_size_bytes.

◆ init()

void gem5::ruby::DirectoryMemory::init ( )

virtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Definition at line 70 of file DirectoryMemory.cc.

References gem5::ruby::RubySystem::getBlockSizeBytes(), gem5::ArmISA::i, m_entries, m_num_entries, and m_size_bytes.

◆ isPresent()

bool gem5::ruby::DirectoryMemory::isPresent ( Addr address )

Definition at line 90 of file DirectoryMemory.cc.

References addrRanges, and gem5::MipsISA::r.

Referenced by allocate(), deallocate(), and lookup().

◆ lookup()

AbstractCacheEntry * gem5::ruby::DirectoryMemory::lookup ( Addr address )

Definition at line 115 of file DirectoryMemory.cc.

References DPRINTF, isPresent(), m_entries, m_num_entries, and mapAddressToLocalIdx().

◆ mapAddressToLocalIdx()

uint64_t gem5::ruby::DirectoryMemory::mapAddressToLocalIdx ( Addr address )

Return the index in the directory based on an address.

This function transforms an address which belongs to a not necessarily continuous vector of address ranges into a flat address that we use to index in the directory

Parameters

an	input address

Returns: the corresponding index in the directory

Definition at line 101 of file DirectoryMemory.cc.

References addrRanges, gem5::ruby::RubySystem::getBlockSizeBits(), and gem5::MipsISA::r.

Referenced by allocate(), deallocate(), and lookup().

◆ operator=()

DirectoryMemory & gem5::ruby::DirectoryMemory::operator= ( const DirectoryMemory & obj )

private

◆ print()

void gem5::ruby::DirectoryMemory::print ( std::ostream & out ) const

Definition at line 156 of file DirectoryMemory.cc.

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

◆ recordRequestType()

void gem5::ruby::DirectoryMemory::recordRequestType ( DirectoryRequestType requestType )

Definition at line 161 of file DirectoryMemory.cc.

References DPRINTF.

Member Data Documentation

◆ addrRanges

const AddrRangeList gem5::ruby::DirectoryMemory::addrRanges

private

The address range for which the directory responds.

Normally this is all possible memory addresses.

Definition at line 112 of file DirectoryMemory.hh.

Referenced by DirectoryMemory(), isPresent(), and mapAddressToLocalIdx().

◆ m_entries

AbstractCacheEntry** gem5::ruby::DirectoryMemory::m_entries

private

Definition at line 101 of file DirectoryMemory.hh.

Referenced by allocate(), deallocate(), init(), lookup(), and ~DirectoryMemory().

◆ m_name

const std::string gem5::ruby::DirectoryMemory::m_name

private

Definition at line 100 of file DirectoryMemory.hh.

◆ m_num_entries

uint64_t gem5::ruby::DirectoryMemory::m_num_entries

private

Definition at line 106 of file DirectoryMemory.hh.

Referenced by allocate(), deallocate(), DirectoryMemory(), init(), lookup(), and ~DirectoryMemory().

◆ m_size_bits

uint64_t gem5::ruby::DirectoryMemory::m_size_bits

private

Definition at line 105 of file DirectoryMemory.hh.

Referenced by DirectoryMemory().

◆ m_size_bytes

uint64_t gem5::ruby::DirectoryMemory::m_size_bytes

private

Definition at line 104 of file DirectoryMemory.hh.

Referenced by DirectoryMemory(), getSize(), and init().

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

mem/ruby/structures/DirectoryMemory.hh
mem/ruby/structures/DirectoryMemory.cc

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ DirectoryMemory() [1/2]

◆ ~DirectoryMemory()

◆ DirectoryMemory() [2/2]

Member Function Documentation

◆ allocate()

◆ deallocate()

◆ getSize()

◆ init()

◆ isPresent()

◆ lookup()

◆ mapAddressToLocalIdx()

◆ operator=()

◆ print()

◆ recordRequestType()

Member Data Documentation

◆ addrRanges

◆ m_entries

◆ m_name

◆ m_num_entries

◆ m_size_bits

◆ m_size_bytes