gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
Switch Class Reference

#include <Switch.hh>

Inheritance diagram for Switch:
BasicRouter ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

typedef SwitchParams Params
 
- Public Types inherited from BasicRouter
typedef BasicRouterParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Switch (const Params *p)
 
 ~Switch ()
 
void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
void addInPort (const std::vector< MessageBuffer * > &in)
 
void addOutPort (const std::vector< MessageBuffer * > &out, const NetDest &routing_table_entry, Cycles link_latency, int bw_multiplier)
 
const ThrottlegetThrottle (LinkID link_number) const
 
void resetStats ()
 Reset statistics associated with this object. More...
 
void collateStats ()
 
void regStats ()
 Register statistics for this object. More...
 
const Stats::FormulagetMsgCount (unsigned int type) const
 
void print (std::ostream &out) const
 
void init_net_ptr (SimpleNetwork *net_ptr)
 
bool functionalRead (Packet *)
 
uint32_t functionalWrite (Packet *)
 
- Public Member Functions inherited from BasicRouter
 BasicRouter (const Params *p)
 
const Paramsparams () const
 
void print (std::ostream &out) const
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. 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 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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- 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 Clocked
void updateClockPeriod () const
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Private Member Functions

 Switch (const Switch &obj)
 
Switchoperator= (const Switch &obj)
 

Private Attributes

PerfectSwitchm_perfect_switch
 
SimpleNetworkm_network_ptr
 
std::vector< Throttle * > m_throttles
 
std::vector< MessageBuffer * > m_port_buffers
 
unsigned m_num_connected_buffers
 
Stats::Formula m_avg_utilization
 
Stats::Formula m_msg_counts [MessageSizeType_NUM]
 
Stats::Formula m_msg_bytes [MessageSizeType_NUM]
 

Additional Inherited Members

- 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 ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 
- 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...
 
- Protected Member Functions inherited from Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
- Protected Attributes inherited from BasicRouter
uint32_t m_id
 
uint32_t m_latency
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- 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...
 

Detailed Description

Definition at line 57 of file Switch.hh.

Member Typedef Documentation

typedef SwitchParams Switch::Params

Definition at line 60 of file Switch.hh.

Constructor & Destructor Documentation

Switch::Switch ( const Params p)

Definition at line 44 of file Switch.cc.

References BasicRouter::m_id, m_num_connected_buffers, m_perfect_switch, and m_port_buffers.

Switch::~Switch ( )
Switch::Switch ( const Switch obj)
private

Member Function Documentation

void Switch::addInPort ( const std::vector< MessageBuffer * > &  in)

Definition at line 70 of file Switch.cc.

References PerfectSwitch::addInPort(), and m_perfect_switch.

void Switch::addOutPort ( const std::vector< MessageBuffer * > &  out,
const NetDest routing_table_entry,
Cycles  link_latency,
int  bw_multiplier 
)
void Switch::collateStats ( )

Definition at line 159 of file Switch.cc.

References PerfectSwitch::collateStats(), ArmISA::i, m_perfect_switch, and m_throttles.

bool Switch::functionalRead ( Packet pkt)

Definition at line 175 of file Switch.cc.

uint32_t Switch::functionalWrite ( Packet pkt)

Definition at line 181 of file Switch.cc.

References ArmISA::i, and m_port_buffers.

const Stats::Formula& Switch::getMsgCount ( unsigned int  type) const
inline

Definition at line 75 of file Switch.hh.

References m_msg_counts, and X86ISA::type.

const Throttle * Switch::getThrottle ( LinkID  link_number) const

Definition at line 107 of file Switch.cc.

References m_throttles.

void Switch::init ( )
virtual

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

Definition at line 63 of file Switch.cc.

References BasicRouter::init(), PerfectSwitch::init(), m_network_ptr, and m_perfect_switch.

void Switch::init_net_ptr ( SimpleNetwork net_ptr)
inline

Definition at line 79 of file Switch.hh.

References m_network_ptr.

Referenced by SimpleNetwork::SimpleNetwork().

Switch& Switch::operator= ( const Switch obj)
private
void Switch::print ( std::ostream &  out) const

Definition at line 168 of file Switch.cc.

Referenced by operator<<().

void Switch::regStats ( )
virtual
void Switch::resetStats ( )
virtual

Reset statistics associated with this object.

Reimplemented from SimObject.

Definition at line 150 of file Switch.cc.

References PerfectSwitch::clearStats(), ArmISA::i, m_perfect_switch, and m_throttles.

Member Data Documentation

Stats::Formula Switch::m_avg_utilization
private

Definition at line 96 of file Switch.hh.

Referenced by regStats().

Stats::Formula Switch::m_msg_bytes[MessageSizeType_NUM]
private

Definition at line 98 of file Switch.hh.

Referenced by regStats().

Stats::Formula Switch::m_msg_counts[MessageSizeType_NUM]
private

Definition at line 97 of file Switch.hh.

Referenced by getMsgCount(), and regStats().

SimpleNetwork* Switch::m_network_ptr
private

Definition at line 90 of file Switch.hh.

Referenced by addOutPort(), init(), and init_net_ptr().

unsigned Switch::m_num_connected_buffers
private

Definition at line 93 of file Switch.hh.

Referenced by addOutPort(), and Switch().

PerfectSwitch* Switch::m_perfect_switch
private

Definition at line 89 of file Switch.hh.

Referenced by addInPort(), addOutPort(), collateStats(), init(), resetStats(), Switch(), and ~Switch().

std::vector<MessageBuffer*> Switch::m_port_buffers
private

Definition at line 92 of file Switch.hh.

Referenced by addOutPort(), functionalWrite(), Switch(), and ~Switch().

std::vector<Throttle*> Switch::m_throttles
private

Definition at line 91 of file Switch.hh.

Referenced by addOutPort(), collateStats(), getThrottle(), regStats(), resetStats(), and ~Switch().


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

Generated on Fri Jun 9 2017 13:04:20 for gem5 by doxygen 1.8.6