gem5::memory::DRAMSys Class Reference

#include <dramsys.hh>

Inheritance diagram for gem5::memory::DRAMSys:

Public Member Functions
	DRAMSys (Params const &params)
gem5::Port &	getPort (const std::string &if_name, PortID idx) override
	Get a port with a given name and index.
DrainState	drain () override
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
Public Member Functions inherited from gem5::memory::AbstractMemory
	PARAMS (AbstractMemory)
	AbstractMemory (const Params &p)
virtual	~AbstractMemory ()
void	initState () override
	initState() is called on each SimObject when not restoring from a checkpoint.
bool	isNull () const
	See if this is a null memory that should never store data and always return zero.
void	setBackingStore (uint8_t *pmem_addr)
	Set the host memory backing store to be used by this memory controller.
void	getBackdoor (MemBackdoorPtr &bd_ptr)
const std::list< LockedAddr > &	getLockedAddrList () const
	Get the list of locked addresses to allow checkpointing.
void	addLockedAddr (LockedAddr addr)
	Add a locked address to allow for checkpointing.
System *	system () const
	read the system pointer Implemented for completeness with the setter
void	system (System *sys)
	Set the system pointer on this memory This can't be done via a python parameter because the system needs pointers to all the memories and the reverse would create a cycle in the object graph.
AddrRange	getAddrRange () const
	Get the address range.
uint8_t *	toHostAddr (Addr addr) const
	Transform a gem5 address space address into its physical counterpart in the host address space.
uint64_t	size () const
	Get the memory size.
Addr	start () const
	Get the start address.
bool	isConfReported () const
	Should this memory be passed to the kernel and part of the OS physical memory layout.
bool	isInAddrMap () const
	Some memories are used as shadow memories or should for other reasons not be part of the global address map.
bool	isKvmMap () const
	When shadow memories are in use, KVM may want to make one or the other, but cannot map both into the guest address space.
void	access (PacketPtr pkt)
	Perform an untimed memory access and update all the state (e.g.
void	functionalAccess (PacketPtr pkt)
	Perform an untimed memory read or write without changing anything but the memory itself.
Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)
Public Member Functions inherited from gem5::SimObject
const Params &	params () const
	SimObject (const Params &p)
virtual	~SimObject ()
virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected.
virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when 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 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
Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	Update the tick to the current tick.
Tick	clockEdge (Cycles cycles=Cycles(0)) const
	Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle.
Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.
Tick	nextCycle () const
	Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future.
uint64_t	frequency () const
Tick	clockPeriod () const
double	voltage () const
Cycles	ticksToCycles (Tick t) const
Tick	cyclesToTicks (Cycles c) const

Private Member Functions
	PARAMS (DRAMSys)

Private Attributes
sc_gem5::TlmTargetWrapper	tlmWrapper
::DRAMSys::Config::Configuration	config
DRAMSysWrapper	dramSysWrapper

Additional Inherited Members
Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.
Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params
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.
Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState
Protected Member Functions inherited from gem5::memory::AbstractMemory
bool	checkLockedAddrList (PacketPtr pkt)
void	trackLoadLocked (PacketPtr pkt)
bool	writeOK (PacketPtr pkt)
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 Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.
	Clocked (Clocked &)=delete
Clocked &	operator= (Clocked &)=delete
virtual	~Clocked ()
	Virtual destructor due to inheritance.
void	resetClock () const
	Reset the object's clock using the current global tick value.
virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.
Protected Attributes inherited from gem5::memory::AbstractMemory
AddrRange	range
uint8_t *	pmemAddr
MemBackdoor	backdoor
const bool	confTableReported
const bool	inAddrMap
const bool	kvmMap
const bool	writeable
const bool	collectStats
std::list< LockedAddr >	lockedAddrList
System *	_system
	Pointer to the System object.
gem5::memory::AbstractMemory::MemStats	stats
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 43 of file dramsys.hh.

Constructor & Destructor Documentation

DRAMSys()

gem5::memory::DRAMSys::DRAMSys

(

Params const &

params

)

Definition at line 37 of file dramsys.cc.

References gem5::memory::DRAMSysWrapper::dramsys, and dramSysWrapper.

Member Function Documentation

drain()

DrainState gem5::memory::DRAMSys::drain ( )

overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note

An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().

Returns

DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements gem5::Drainable.

Definition at line 65 of file dramsys.cc.

References gem5::Drained, gem5::Draining, gem5::memory::DRAMSysWrapper::dramsys, and dramSysWrapper.

getPort()

gem5::Port & gem5::memory::DRAMSys::getPort ( const std::string & if_name, PortID idx )

overridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns

A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 55 of file dramsys.cc.

References gem5::SimObject::getPort(), and tlmWrapper.

PARAMS()

gem5::memory::DRAMSys::PARAMS ( DRAMSys )

private

serialize()

void gem5::memory::DRAMSys::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters

cp	Checkpoint state

Reimplemented from gem5::ClockedObject.

Definition at line 71 of file dramsys.cc.

References gem5::CheckpointIn::dir(), sc_core::sc_get_top_level_objects(), and serialize().

Referenced by serialize().

unserialize()

void gem5::memory::DRAMSys::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters

cp	Checkpoint state

Reimplemented from gem5::ClockedObject.

Definition at line 104 of file dramsys.cc.

References gem5::CheckpointIn::dir(), and sc_core::sc_get_top_level_objects().

Member Data Documentation

config

::DRAMSys::Config::Configuration gem5::memory::DRAMSys::config

private

Definition at line 59 of file dramsys.hh.

dramSysWrapper

DRAMSysWrapper gem5::memory::DRAMSys::dramSysWrapper

private

Definition at line 60 of file dramsys.hh.

Referenced by drain(), and DRAMSys().

tlmWrapper

sc_gem5::TlmTargetWrapper gem5::memory::DRAMSys::tlmWrapper

private

Definition at line 46 of file dramsys.hh.

Referenced by getPort().

---

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

• mem/dramsys.hh
• mem/dramsys.cc