#include <policy.hh>

Inheritance diagram for gem5::memory::qos::Policy:

Public Types
using	Params = QoSPolicyParams

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	Policy (const Params &p)

virtual	~Policy ()

virtual void	regStats () override
	Callback to set stat parameters.

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

void	setMemCtrl (MemCtrl *mem)
	Setting a pointer to the Memory Controller implementing the policy.

template<typename Requestor , typename T >
std::pair< RequestorID, T >	pair (Requestor requestor, T value)
	Builds a RequestorID/value pair given a requestor input.

virtual uint8_t	schedule (const RequestorID requestor_id, const uint64_t data)=0
	Schedules data - must be defined by derived class.

uint8_t	schedule (const PacketPtr pkt)
	Schedules a packet.

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	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

Protected Attributes
MemCtrl *	memCtrl
	Pointer to parent memory controller implementing the policy.

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.

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.

Detailed Description

QoS Policy base class.

QoS Policy base class: all QoS policies derive from this class to implement specific QoS scheduling algorithms

Definition at line 70 of file policy.hh.

Member Typedef Documentation

◆ Params

using gem5::memory::qos::Policy::Params = QoSPolicyParams

Definition at line 73 of file policy.hh.

Constructor & Destructor Documentation

◆ Policy()

gem5::memory::qos::Policy::Policy ( const Params & p )

Definition at line 51 of file policy.cc.

◆ ~Policy()

gem5::memory::qos::Policy::~Policy ( )

virtual

Definition at line 55 of file policy.cc.

Member Function Documentation

◆ init()

virtual void gem5::memory::qos::Policy::init ( )

inlineoverridevirtual

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.

Reimplemented in gem5::memory::qos::FixedPriorityPolicy.

Definition at line 80 of file policy.hh.

◆ pair()

template<typename Requestor , typename T >

std::pair< RequestorID, T > gem5::memory::qos::Policy::pair	(	Requestor	requestor,
		T	value )

Builds a RequestorID/value pair given a requestor input.

This will be looked up in the system list of requestors in order to retrieve the associated RequestorID. In case the requestor name/object cannot be resolved, the pairing method will panic.

Parameters

requestor	Requestor to lookup in the system
value	Value to be associated with the RequestorID

Returns: A RequestorID/Value pair.

Definition at line 128 of file policy.hh.

References DPRINTF, gem5::Request::invldRequestorId, gem5::System::lookupRequestorId(), memCtrl, panic_if, and gem5::memory::qos::MemCtrl::system().

Referenced by gem5::memory::qos::FixedPriorityPolicy::initRequestorName(), and gem5::memory::qos::FixedPriorityPolicy::initRequestorObj().

◆ regStats()

virtual void gem5::memory::qos::Policy::regStats ( )

inlineoverridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from gem5::statistics::Group.

Definition at line 78 of file policy.hh.

◆ schedule() [1/2]

uint8_t gem5::memory::qos::Policy::schedule ( const PacketPtr pkt )

Schedules a packet.

Non virtual interface for the scheduling method requiring a requestor id.

Parameters

pkt	pointer to packet to schedule

Returns: QoS priority value

Definition at line 58 of file policy.cc.

References gem5::Packet::getSize(), gem5::Packet::req, and schedule().

◆ schedule() [2/2]

virtual uint8_t gem5::memory::qos::Policy::schedule	(	const RequestorID	requestor_id,
		const uint64_t	data )

pure virtual

Schedules data - must be defined by derived class.

Parameters

requestor_id	requestor id to schedule
data	data to schedule

Returns: QoS priority value

Implemented in gem5::memory::qos::FixedPriorityPolicy, and gem5::memory::qos::PropFairPolicy.

Referenced by schedule().

◆ setMemCtrl()

void gem5::memory::qos::Policy::setMemCtrl ( MemCtrl * mem )

inline

Setting a pointer to the Memory Controller implementing the policy.

Definition at line 86 of file policy.hh.

References mem, and memCtrl.

Member Data Documentation

◆ memCtrl

MemCtrl* gem5::memory::qos::Policy::memCtrl

protected

Pointer to parent memory controller implementing the policy.

Definition at line 123 of file policy.hh.

Referenced by gem5::memory::qos::PropFairPolicy::initRequestor(), pair(), gem5::memory::qos::FixedPriorityPolicy::schedule(), and setMemCtrl().

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

mem/qos/policy.hh
mem/qos/policy.cc

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ Policy()

◆ ~Policy()

Member Function Documentation

◆ init()

◆ pair()

◆ regStats()

◆ schedule() [1/2]

◆ schedule() [2/2]

◆ setMemCtrl()

Member Data Documentation

◆ memCtrl