Proportional Fair QoS Policy Providing a configurable fair scheduling policy based on utilization; utilization is directly proportional to a score which is inversely proportional to the QoS priority Users can tune the policy by adjusting the weight parameter (weight of the formula) More...

#include <policy_pf.hh>

Inheritance diagram for gem5::memory::qos::PropFairPolicy:

Public Member Functions
	PropFairPolicy (const Params &)

virtual	~PropFairPolicy ()

void	initRequestorName (const std::string requestor, const double score)
	Initialize the requestor's score by providing the requestor's name and initial score value.

void	initRequestorObj (const SimObject *requestor, const double score)
	Initialize the requestor's score by providing the requestor's SimObject pointer and initial score value.

virtual uint8_t	schedule (const RequestorID id, const uint64_t pkt_size) override
	Schedules a packet based on proportional fair configuration.

Public Member Functions inherited from gem5::memory::qos::Policy
	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.

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 Types
using	RequestorHistory = std::pair<RequestorID, double>
	history is keeping track of every requestor's score

Protected Member Functions
template<typename Requestor >
void	initRequestor (const Requestor requestor, const double score)

double	updateScore (const double old_score, const uint64_t served_bytes) const

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
const double	weight
	PF Policy weight.

std::vector< RequestorHistory >	history

Protected Attributes inherited from gem5::memory::qos::Policy
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.

Private Types
using	Params = QoSPropFairPolicyParams

Additional Inherited Members
Public Types inherited from gem5::memory::qos::Policy
using	Params = QoSPolicyParams

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.

Detailed Description

Proportional Fair QoS Policy Providing a configurable fair scheduling policy based on utilization; utilization is directly proportional to a score which is inversely proportional to the QoS priority Users can tune the policy by adjusting the weight parameter (weight of the formula)

This is the formula used by the policy ((1.0 - weight) * old_score) + (weight * served_bytes);

Definition at line 69 of file policy_pf.hh.

Member Typedef Documentation

◆ Params

using gem5::memory::qos::PropFairPolicy::Params = QoSPropFairPolicyParams

private

Definition at line 71 of file policy_pf.hh.

◆ RequestorHistory

using gem5::memory::qos::PropFairPolicy::RequestorHistory = std::pair<RequestorID, double>

protected

history is keeping track of every requestor's score

Definition at line 119 of file policy_pf.hh.

Constructor & Destructor Documentation

◆ PropFairPolicy()

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

Definition at line 54 of file policy_pf.cc.

References fatal_if, and weight.

◆ ~PropFairPolicy()

gem5::memory::qos::PropFairPolicy::~PropFairPolicy ( )

virtual

Definition at line 61 of file policy_pf.cc.

Member Function Documentation

◆ initRequestor()

template<typename Requestor >

void gem5::memory::qos::PropFairPolicy::initRequestor	(	const Requestor	requestor,
		const double	score )

protected

Definition at line 66 of file policy_pf.cc.

References fatal_if, history, gem5::Request::invldRequestorId, gem5::System::lookupRequestorId(), gem5::memory::qos::Policy::memCtrl, gem5::memory::qos::MemCtrl::numPriorities(), and gem5::memory::qos::MemCtrl::system().

Referenced by initRequestorName(), and initRequestorObj().

◆ initRequestorName()

void gem5::memory::qos::PropFairPolicy::initRequestorName	(	const std::string	requestor,
		const double	score )

Initialize the requestor's score by providing the requestor's name and initial score value.

The requestor's name has to match a name in the system.

Parameters

requestor	requestor's name to lookup.
score	initial score value for the requestor

Definition at line 81 of file policy_pf.cc.

References initRequestor().

◆ initRequestorObj()

void gem5::memory::qos::PropFairPolicy::initRequestorObj	(	const SimObject *	requestor,
		const double	score )

Initialize the requestor's score by providing the requestor's SimObject pointer and initial score value.

The requestor's pointer has to match a requestor in the system.

Parameters

requestor	requestor's SimObject pointer to lookup.
score	initial score value for the requestor

Definition at line 87 of file policy_pf.cc.

References initRequestor().

◆ schedule()

uint8_t gem5::memory::qos::PropFairPolicy::schedule	(	const RequestorID	id,
		const uint64_t	pkt_size )

overridevirtual

Schedules a packet based on proportional fair configuration.

Parameters

id	requestor id to schedule
pkt_size	size of the packet

Returns: QoS priority value

Implements gem5::memory::qos::Policy.

Definition at line 100 of file policy_pf.cc.

References history, and updateScore().

◆ updateScore()

double gem5::memory::qos::PropFairPolicy::updateScore	(	const double	old_score,
		const uint64_t	served_bytes ) const

inlineprotected

Definition at line 93 of file policy_pf.cc.

References weight.

Referenced by schedule().

Member Data Documentation

◆ history

std::vector<RequestorHistory> gem5::memory::qos::PropFairPolicy::history

protected

Definition at line 120 of file policy_pf.hh.

Referenced by initRequestor(), and schedule().

◆ weight

const double gem5::memory::qos::PropFairPolicy::weight

protected

PF Policy weight.

Definition at line 116 of file policy_pf.hh.

Referenced by PropFairPolicy(), and updateScore().

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

mem/qos/policy_pf.hh
mem/qos/policy_pf.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

◆ RequestorHistory

Constructor & Destructor Documentation

◆ PropFairPolicy()

◆ ~PropFairPolicy()

Member Function Documentation

◆ initRequestor()

◆ initRequestorName()

◆ initRequestorObj()

◆ schedule()

◆ updateScore()

Member Data Documentation

◆ history

◆ weight