gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
gem5::ruby::Switch Class Reference

#include <Switch.hh>

Inheritance diagram for gem5::ruby::Switch:
gem5::ruby::BasicRouter gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  SwitchStats
 

Public Types

typedef SwitchParams Params
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Switch (const Params &p)
 
 ~Switch ()=default
 
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)
 
void resetStats ()
 Callback to reset stats. More...
 
void collateStats ()
 
void regStats ()
 Callback to set stat parameters. More...
 
const statistics::FormulagetMsgCount (unsigned int type) const
 
void print (std::ostream &out) const
 
void init_net_ptr (SimpleNetwork *net_ptr)
 
bool functionalRead (Packet *)
 
bool functionalRead (Packet *, WriteMask &)
 
uint32_t functionalWrite (Packet *)
 
- Public Member Functions inherited from gem5::ruby::BasicRouter
 PARAMS (BasicRouter)
 
 BasicRouter (const Params &p)
 
void print (std::ostream &out) const
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
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::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 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
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 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
 

Public Attributes

gem5::ruby::Switch::SwitchStats switchStats
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Private Member Functions

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

Private Attributes

PerfectSwitch perfectSwitch
 
SimpleNetworkm_network_ptr
 
std::list< Throttlethrottles
 
unsigned m_num_connected_buffers
 
std::vector< MessageBuffer * > m_port_buffers
 

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. 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...
 
- 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 Member Functions inherited from gem5::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...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 
- Protected Attributes inherited from gem5::ruby::BasicRouter
uint32_t m_id
 
uint32_t m_latency
 
- 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...
 

Detailed Description

Definition at line 77 of file Switch.hh.

Member Typedef Documentation

◆ Params

typedef SwitchParams gem5::ruby::Switch::Params

Definition at line 80 of file Switch.hh.

Constructor & Destructor Documentation

◆ Switch() [1/2]

gem5::ruby::Switch::Switch ( const Params p)

Definition at line 59 of file Switch.cc.

References m_port_buffers, and gem5::MipsISA::p.

◆ ~Switch()

gem5::ruby::Switch::~Switch ( )
default

◆ Switch() [2/2]

gem5::ruby::Switch::Switch ( const Switch obj)
private

Member Function Documentation

◆ addInPort()

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

Definition at line 78 of file Switch.cc.

References gem5::ruby::PerfectSwitch::addInPort(), and perfectSwitch.

◆ addOutPort()

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

◆ collateStats()

void gem5::ruby::Switch::collateStats ( )

Definition at line 160 of file Switch.cc.

References gem5::ruby::PerfectSwitch::collateStats(), perfectSwitch, and throttles.

◆ functionalRead() [1/2]

bool gem5::ruby::Switch::functionalRead ( Packet pkt)

Definition at line 176 of file Switch.cc.

References gem5::ArmISA::i, and m_port_buffers.

Referenced by functionalRead().

◆ functionalRead() [2/2]

bool gem5::ruby::Switch::functionalRead ( Packet pkt,
WriteMask mask 
)

Definition at line 186 of file Switch.cc.

References functionalRead(), gem5::ArmISA::i, m_port_buffers, and gem5::mask().

◆ functionalWrite()

uint32_t gem5::ruby::Switch::functionalWrite ( Packet pkt)

Definition at line 197 of file Switch.cc.

References gem5::ArmISA::i, and m_port_buffers.

◆ getMsgCount()

const statistics::Formula& gem5::ruby::Switch::getMsgCount ( unsigned int  type) const
inline

◆ init()

void gem5::ruby::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 gem5::ruby::BasicRouter.

Definition at line 71 of file Switch.cc.

References gem5::ruby::BasicRouter::init(), gem5::ruby::PerfectSwitch::init(), m_network_ptr, and perfectSwitch.

◆ init_net_ptr()

void gem5::ruby::Switch::init_net_ptr ( SimpleNetwork net_ptr)
inline

Definition at line 97 of file Switch.hh.

References m_network_ptr.

◆ operator=()

Switch& gem5::ruby::Switch::operator= ( const Switch obj)
private

◆ print()

void gem5::ruby::Switch::print ( std::ostream &  out) const

Definition at line 169 of file Switch.cc.

Referenced by gem5::ruby::operator<<().

◆ regStats()

void gem5::ruby::Switch::regStats ( )
virtual

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 112 of file Switch.cc.

References gem5::statistics::constant(), gem5::csprintf(), gem5::statistics::DataWrap< Derived, InfoProxyType >::flags(), gem5::ruby::Switch::SwitchStats::m_avg_utilization, gem5::ruby::Switch::SwitchStats::m_msg_bytes, gem5::ruby::Switch::SwitchStats::m_msg_counts, gem5::ruby::Network::MessageSizeType_to_int(), gem5::statistics::nozero, gem5::statistics::Group::regStats(), switchStats, throttles, and gem5::X86ISA::type.

◆ resetStats()

void gem5::ruby::Switch::resetStats ( )
virtual

Callback to reset stats.

Reimplemented from gem5::statistics::Group.

Definition at line 151 of file Switch.cc.

References gem5::ruby::PerfectSwitch::clearStats(), perfectSwitch, and throttles.

Member Data Documentation

◆ m_network_ptr

SimpleNetwork* gem5::ruby::Switch::m_network_ptr
private

Definition at line 109 of file Switch.hh.

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

◆ m_num_connected_buffers

unsigned gem5::ruby::Switch::m_num_connected_buffers
private

Definition at line 112 of file Switch.hh.

Referenced by addOutPort().

◆ m_port_buffers

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

Definition at line 113 of file Switch.hh.

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

◆ perfectSwitch

PerfectSwitch gem5::ruby::Switch::perfectSwitch
private

Definition at line 108 of file Switch.hh.

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

◆ switchStats

gem5::ruby::Switch::SwitchStats gem5::ruby::Switch::switchStats

Referenced by getMsgCount(), and regStats().

◆ throttles

std::list<Throttle> gem5::ruby::Switch::throttles
private

Definition at line 110 of file Switch.hh.

Referenced by addOutPort(), collateStats(), regStats(), and resetStats().


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

Generated on Tue Sep 21 2021 12:32:10 for gem5 by doxygen 1.8.17