gem5  v21.1.0.2
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Types | List of all members
gem5::memory::qos::PropFairPolicy Class Reference

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:
gem5::memory::qos::Policy gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

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. More...
 
void initRequestorObj (const SimObject *requestor, const double score)
 Initialize the requestor's score by providing the requestor's SimObject pointer and initial score value. More...
 
virtual uint8_t schedule (const RequestorID id, const uint64_t pkt_size) override
 Schedules a packet based on proportional fair configuration. More...
 
- Public Member Functions inherited from gem5::memory::qos::Policy
 Policy (const Params &p)
 
virtual ~Policy ()
 
virtual void regStats () override
 Callback to set stat parameters. More...
 
virtual void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void setMemCtrl (MemCtrl *mem)
 Setting a pointer to the Memory Controller implementing the policy. More...
 
template<typename Requestor , typename T >
std::pair< RequestorID, T > pair (Requestor requestor, T value)
 Builds a RequestorID/value pair given a requestor input. More...
 
uint8_t schedule (const PacketPtr pkt)
 Schedules a packet. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::EventManager
EventQueueeventQueue () 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. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 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. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
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. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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 More...
 

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. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

Protected Attributes

const double weight
 PF Policy weight. More...
 
std::vector< RequestorHistoryhistory
 
- Protected Attributes inherited from gem5::memory::qos::Policy
MemCtrlmemCtrl
 Pointer to parent memory controller implementing the policy. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 

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 70 of file policy_pf.hh.

Member Typedef Documentation

◆ Params

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

Definition at line 72 of file policy_pf.hh.

◆ RequestorHistory

history is keeping track of every requestor's score

Definition at line 120 of file policy_pf.hh.

Constructor & Destructor Documentation

◆ PropFairPolicy()

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

Definition at line 55 of file policy_pf.cc.

References fatal_if.

◆ ~PropFairPolicy()

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

Definition at line 62 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

◆ 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
requestorrequestor's name to lookup.
scoreinitial score value for the requestor

Definition at line 82 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
requestorrequestor's SimObject pointer to lookup.
scoreinitial score value for the requestor

Definition at line 88 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
idrequestor id to schedule
pkt_sizesize of the packet
Returns
QoS priority value

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

Definition at line 101 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 94 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 121 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 117 of file policy_pf.hh.

Referenced by updateScore().


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

Generated on Tue Sep 21 2021 12:31:29 for gem5 by doxygen 1.8.17