gem5  v20.1.0.0
Public Member Functions | Protected Attributes | Private Types | List of all members
QoS::FixedPriorityPolicy Class Reference

Fixed Priority QoS Policy. More...

#include <policy_fixed_prio.hh>

Inheritance diagram for QoS::FixedPriorityPolicy:
QoS::Policy SimObject EventManager Serializable Drainable Stats::Group

Public Member Functions

 FixedPriorityPolicy (const Params *)
 
virtual ~FixedPriorityPolicy ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void initRequestorName (std::string requestor, uint8_t priority)
 Initialize the fixed requestor's priority by providing the requestor's name and priority value. More...
 
void initRequestorObj (const SimObject *requestor, uint8_t priority)
 Initialize the fixed requestor's priority by providing the requestor's SimObject pointer and priority value. More...
 
virtual uint8_t schedule (const RequestorID, const uint64_t) override
 Schedules a packet based on fixed priority configuration. More...
 
- Public Member Functions inherited from QoS::Policy
 Policy (const Params *p)
 
virtual ~Policy ()
 
virtual void regStats () override
 Callback to set stat parameters. 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 SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 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 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 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 Stats::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 (Stats::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...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Protected Attributes

const uint8_t defaultPriority
 Default fixed priority value for non-listed requestors. More...
 
std::map< RequestorID, uint8_t > priorityMap
 Priority map, associates configured requestors with a fixed QoS priority value. More...
 
- Protected Attributes inherited from QoS::Policy
MemCtrlmemCtrl
 Pointer to parent memory controller implementing the policy. More...
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Types

using Params = QoSFixedPriorityPolicyParams
 

Additional Inherited Members

- Public Types inherited from QoS::Policy
using Params = QoSPolicyParams
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 
- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Protected Member Functions inherited from Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

Detailed Description

Fixed Priority QoS Policy.

Fixed Priority Policy: based on a configured RequestorID to priority map, it returns a fixed QoS priority value: every requestor has a fixed priority.

Definition at line 54 of file policy_fixed_prio.hh.

Member Typedef Documentation

◆ Params

using QoS::FixedPriorityPolicy::Params = QoSFixedPriorityPolicyParams
private

Definition at line 56 of file policy_fixed_prio.hh.

Constructor & Destructor Documentation

◆ FixedPriorityPolicy()

QoS::FixedPriorityPolicy::FixedPriorityPolicy ( const Params p)

Definition at line 49 of file policy_fixed_prio.cc.

◆ ~FixedPriorityPolicy()

QoS::FixedPriorityPolicy::~FixedPriorityPolicy ( )
virtual

Definition at line 53 of file policy_fixed_prio.cc.

Member Function Documentation

◆ init()

void QoS::FixedPriorityPolicy::init ( )
overridevirtual

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 QoS::Policy.

Definition at line 57 of file policy_fixed_prio.cc.

◆ initRequestorName()

void QoS::FixedPriorityPolicy::initRequestorName ( std::string  requestor,
uint8_t  priority 
)

Initialize the fixed requestor's priority by providing the requestor's name and priority value.

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

Parameters
requestorrequestor's name to lookup.
prioritypriority value for the requestor

Definition at line 62 of file policy_fixed_prio.cc.

References priorityMap.

◆ initRequestorObj()

void QoS::FixedPriorityPolicy::initRequestorObj ( const SimObject requestor,
uint8_t  priority 
)

Initialize the fixed requestor's priority by providing the requestor's SimObject pointer and priority value.

Parameters
requestorrequestor's SimObject pointer to lookup.
prioritypriority value for the requestor

Definition at line 69 of file policy_fixed_prio.cc.

References priorityMap.

◆ schedule()

uint8_t QoS::FixedPriorityPolicy::schedule ( const RequestorID  id,
const uint64_t  data 
)
overridevirtual

Schedules a packet based on fixed priority configuration.

Parameters
idrequestor id to schedule
datadata to schedule
Returns
QoS priority value

Implements QoS::Policy.

Definition at line 77 of file policy_fixed_prio.cc.

References defaultPriority, DPRINTF, System::getRequestorName(), QoS::Policy::memCtrl, priorityMap, and QoS::MemCtrl::system().

Member Data Documentation

◆ defaultPriority

const uint8_t QoS::FixedPriorityPolicy::defaultPriority
protected

Default fixed priority value for non-listed requestors.

Definition at line 94 of file policy_fixed_prio.hh.

Referenced by schedule().

◆ priorityMap

std::map<RequestorID, uint8_t> QoS::FixedPriorityPolicy::priorityMap
protected

Priority map, associates configured requestors with a fixed QoS priority value.

Definition at line 100 of file policy_fixed_prio.hh.

Referenced by initRequestorName(), initRequestorObj(), and schedule().


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

Generated on Wed Sep 30 2020 14:03:08 for gem5 by doxygen 1.8.17