A very simple memory object. More...

#include <simple_memobj.hh>

Inheritance diagram for gem5::SimpleMemobj:

Classes
class	CPUSidePort
	Port on the CPU-side that receives requests. More...

class	MemSidePort
	Port on the memory-side that receives responses. More...

Public Member Functions
	SimpleMemobj (const SimpleMemobjParams &params)
	constructor

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

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	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 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
bool	handleRequest (PacketPtr pkt)
	Handle the request from the CPU side.

bool	handleResponse (PacketPtr pkt)
	Handle the respone from the memory side.

void	handleFunctional (PacketPtr pkt)
	Handle a packet functionally.

AddrRangeList	getAddrRanges () const
	Return the address ranges this memobj is responsible for.

void	sendRangeChange ()
	Tell the CPU side to ask for our memory ranges.

Private Attributes
CPUSidePort	instPort
	Instantiation of the CPU-side ports.

CPUSidePort	dataPort

MemSidePort	memPort
	Instantiation of the memory-side port.

bool	blocked
	True if this is currently blocked waiting for a response.

Additional Inherited Members
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.

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

A very simple memory object.

Current implementation doesn't even cache anything it just forwards requests and responses. This memobj is fully blocking (not non-blocking). Only a single request can be outstanding at a time.

Definition at line 45 of file simple_memobj.hh.

Constructor & Destructor Documentation

◆ SimpleMemobj()

gem5::SimpleMemobj::SimpleMemobj ( const SimpleMemobjParams & params )

constructor

Definition at line 37 of file simple_memobj.cc.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::SimpleMemobj::getAddrRanges ( ) const

private

Return the address ranges this memobj is responsible for.

Just use the same as the next upper level of the hierarchy.

Returns: the address ranges this memobj is responsible for

Definition at line 221 of file simple_memobj.cc.

References DPRINTF, gem5::RequestPort::getAddrRanges(), and memPort.

◆ getPort()

Port & gem5::SimpleMemobj::getPort	(	const std::string &	if_name,
		PortID	idx = InvalidPortID )

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.

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 47 of file simple_memobj.cc.

References dataPort, gem5::SimObject::getPort(), instPort, gem5::InvalidPortID, memPort, and panic_if.

◆ handleFunctional()

void gem5::SimpleMemobj::handleFunctional ( PacketPtr pkt )

private

Handle a packet functionally.

Update the data on a write and get the data on a read.

Parameters

packet to functionally handle

Definition at line 214 of file simple_memobj.cc.

References memPort, and gem5::RequestPort::sendFunctional().

◆ handleRequest()

bool gem5::SimpleMemobj::handleRequest ( PacketPtr pkt )

private

Handle the request from the CPU side.

Parameters

requesting packet

Returns: true if we can handle the request this cycle, false if the requestor needs to retry later

Definition at line 168 of file simple_memobj.cc.

References blocked, DPRINTF, gem5::Packet::getAddr(), memPort, and gem5::SimpleMemobj::MemSidePort::sendPacket().

◆ handleResponse()

bool gem5::SimpleMemobj::handleResponse ( PacketPtr pkt )

private

Handle the respone from the memory side.

Parameters

responding packet

Returns: true if we can handle the response this cycle, false if the responder needs to retry later

Definition at line 187 of file simple_memobj.cc.

References blocked, dataPort, DPRINTF, gem5::Packet::getAddr(), instPort, gem5::Packet::req, gem5::SimpleMemobj::CPUSidePort::sendPacket(), and gem5::SimpleMemobj::CPUSidePort::trySendRetry().

◆ sendRangeChange()

void gem5::SimpleMemobj::sendRangeChange ( )

private

Tell the CPU side to ask for our memory ranges.

Definition at line 229 of file simple_memobj.cc.

References dataPort, instPort, and gem5::ResponsePort::sendRangeChange().

Member Data Documentation

◆ blocked

bool gem5::SimpleMemobj::blocked

private

True if this is currently blocked waiting for a response.

Definition at line 231 of file simple_memobj.hh.

Referenced by handleRequest(), and handleResponse().

◆ dataPort

CPUSidePort gem5::SimpleMemobj::dataPort

private

Definition at line 225 of file simple_memobj.hh.

Referenced by getPort(), handleResponse(), and sendRangeChange().

◆ instPort

CPUSidePort gem5::SimpleMemobj::instPort

private

Instantiation of the CPU-side ports.

Definition at line 224 of file simple_memobj.hh.

Referenced by getPort(), handleResponse(), and sendRangeChange().

◆ memPort

MemSidePort gem5::SimpleMemobj::memPort

private

Instantiation of the memory-side port.

Definition at line 228 of file simple_memobj.hh.

Referenced by getAddrRanges(), getPort(), handleFunctional(), and handleRequest().

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

learning_gem5/part2/simple_memobj.hh
learning_gem5/part2/simple_memobj.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimpleMemobj()

Member Function Documentation

◆ getAddrRanges()

◆ getPort()

◆ handleFunctional()

◆ handleRequest()

◆ handleResponse()

◆ sendRangeChange()

Member Data Documentation

◆ blocked

◆ dataPort

◆ instPort

◆ memPort