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

#include <SimpleNetwork.hh>

Inheritance diagram for gem5::ruby::SimpleNetwork:
gem5::ruby::Network gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  NetworkStats
 

Public Types

typedef SimpleNetworkParams 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

 SimpleNetwork (const Params &p)
 
 ~SimpleNetwork ()=default
 
void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
int getBufferSize ()
 
int getEndpointBandwidth ()
 
bool getAdaptiveRouting ()
 
void collateStats ()
 
void regStats ()
 Callback to set stat parameters. More...
 
bool isVNetOrdered (int vnet) const
 
void makeExtOutLink (SwitchID src, NodeID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry)
 
void makeExtInLink (NodeID src, SwitchID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry)
 
void makeInternalLink (SwitchID src, SwitchID dest, BasicLink *link, std::vector< NetDest > &routing_table_entry, PortDirection src_outport, PortDirection dst_inport)
 
void print (std::ostream &out) const
 
bool functionalRead (Packet *pkt)
 
bool functionalRead (Packet *pkt, WriteMask &mask)
 
uint32_t functionalWrite (Packet *pkt)
 
- Public Member Functions inherited from gem5::ruby::Network
 PARAMS (RubyNetwork)
 
 Network (const Params &p)
 
virtual ~Network ()
 
int getNumNodes () const
 
void setToNetQueue (NodeID global_id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)
 
virtual void setFromNetQueue (NodeID global_id, bool ordered, int netNumber, std::string vnet_type, MessageBuffer *b)
 
virtual void checkNetworkAllocation (NodeID local_id, bool ordered, int network_num, std::string vnet_type)
 
NodeID addressToNodeID (Addr addr, MachineType mtype)
 Map an address to the correct NodeID. More...
 
PortgetPort (const std::string &, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
NodeID getLocalNodeID (NodeID global_id) 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 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
 
- 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
 

Private Member Functions

void addLink (SwitchID src, SwitchID dest, int link_latency)
 
void makeLink (SwitchID src, SwitchID dest, const NetDest &routing_table_entry, int link_latency)
 
void makeTopology ()
 
 SimpleNetwork (const SimpleNetwork &obj)
 
SimpleNetworkoperator= (const SimpleNetwork &obj)
 

Private Attributes

std::vector< Switch * > m_switches
 
std::vector< MessageBuffer * > m_int_link_buffers
 
int m_num_connected_buffers
 
const int m_buffer_size
 
const int m_endpoint_bandwidth
 
const bool m_adaptive_routing
 
gem5::ruby::SimpleNetwork::NetworkStats networkStats
 

Additional Inherited Members

- Static Public Member Functions inherited from gem5::ruby::Network
static uint32_t getNumberOfVirtualNetworks ()
 
static uint32_t MessageSizeType_to_int (MessageSizeType size_type)
 
- 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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from gem5::ruby::Network
 Network (const Network &obj)
 
Networkoperator= (const Network &obj)
 
- 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::Network
uint32_t m_nodes
 
std::vector< std::string > m_vnet_type_names
 
Topologym_topology_ptr
 
std::vector< std::vector< MessageBuffer * > > m_toNetQueues
 
std::vector< std::vector< MessageBuffer * > > m_fromNetQueues
 
std::vector< bool > m_ordered
 
- 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...
 
- Static Protected Attributes inherited from gem5::ruby::Network
static uint32_t m_virtual_networks
 
static uint32_t m_control_msg_size
 
static uint32_t m_data_msg_size
 

Detailed Description

Definition at line 61 of file SimpleNetwork.hh.

Member Typedef Documentation

◆ Params

typedef SimpleNetworkParams gem5::ruby::SimpleNetwork::Params

Definition at line 64 of file SimpleNetwork.hh.

Constructor & Destructor Documentation

◆ SimpleNetwork() [1/2]

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

◆ ~SimpleNetwork()

gem5::ruby::SimpleNetwork::~SimpleNetwork ( )
default

◆ SimpleNetwork() [2/2]

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

Member Function Documentation

◆ addLink()

void gem5::ruby::SimpleNetwork::addLink ( SwitchID  src,
SwitchID  dest,
int  link_latency 
)
private

◆ collateStats()

void gem5::ruby::SimpleNetwork::collateStats ( )
virtual

Implements gem5::ruby::Network.

Definition at line 179 of file SimpleNetwork.cc.

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

◆ functionalRead() [1/2]

bool gem5::ruby::SimpleNetwork::functionalRead ( Packet pkt)
virtual

Reimplemented from gem5::ruby::Network.

Definition at line 198 of file SimpleNetwork.cc.

References gem5::ArmISA::i, m_int_link_buffers, and m_switches.

Referenced by functionalRead().

◆ functionalRead() [2/2]

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

Reimplemented from gem5::ruby::Network.

Definition at line 213 of file SimpleNetwork.cc.

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

◆ functionalWrite()

uint32_t gem5::ruby::SimpleNetwork::functionalWrite ( Packet pkt)
virtual

Reimplemented from gem5::ruby::Network.

Definition at line 228 of file SimpleNetwork.cc.

References gem5::ArmISA::i, m_int_link_buffers, and m_switches.

◆ getAdaptiveRouting()

bool gem5::ruby::SimpleNetwork::getAdaptiveRouting ( )
inline

Definition at line 72 of file SimpleNetwork.hh.

References m_adaptive_routing.

Referenced by gem5::ruby::PerfectSwitch::operateMessageBuffer().

◆ getBufferSize()

int gem5::ruby::SimpleNetwork::getBufferSize ( )
inline

Definition at line 70 of file SimpleNetwork.hh.

References m_buffer_size.

◆ getEndpointBandwidth()

int gem5::ruby::SimpleNetwork::getEndpointBandwidth ( )
inline

Definition at line 71 of file SimpleNetwork.hh.

References m_endpoint_bandwidth.

Referenced by gem5::ruby::Switch::addOutPort().

◆ init()

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

Definition at line 80 of file SimpleNetwork.cc.

References gem5::ruby::Topology::createLinks(), gem5::SimObject::init(), and gem5::ruby::Network::m_topology_ptr.

◆ isVNetOrdered()

bool gem5::ruby::SimpleNetwork::isVNetOrdered ( int  vnet) const
inline

◆ makeExtInLink()

void gem5::ruby::SimpleNetwork::makeExtInLink ( NodeID  src,
SwitchID  dest,
BasicLink link,
std::vector< NetDest > &  routing_table_entry 
)
virtual

◆ makeExtOutLink()

void gem5::ruby::SimpleNetwork::makeExtOutLink ( SwitchID  src,
NodeID  dest,
BasicLink link,
std::vector< NetDest > &  routing_table_entry 
)
virtual

◆ makeInternalLink()

void gem5::ruby::SimpleNetwork::makeInternalLink ( SwitchID  src,
SwitchID  dest,
BasicLink link,
std::vector< NetDest > &  routing_table_entry,
PortDirection  src_outport,
PortDirection  dst_inport 
)
virtual

◆ makeLink()

void gem5::ruby::SimpleNetwork::makeLink ( SwitchID  src,
SwitchID  dest,
const NetDest routing_table_entry,
int  link_latency 
)
private

◆ makeTopology()

void gem5::ruby::SimpleNetwork::makeTopology ( )
private

◆ operator=()

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

◆ print()

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

Implements gem5::ruby::Network.

Definition at line 187 of file SimpleNetwork.cc.

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

◆ regStats()

void gem5::ruby::SimpleNetwork::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 146 of file SimpleNetwork.cc.

References gem5::statistics::constant(), gem5::csprintf(), gem5::ArmISA::i, gem5::ruby::SimpleNetwork::NetworkStats::m_msg_bytes, gem5::ruby::SimpleNetwork::NetworkStats::m_msg_counts, m_switches, gem5::ruby::Network::MessageSizeType_to_int(), networkStats, gem5::statistics::nozero, gem5::statistics::Group::regStats(), gem5::RiscvISA::sum, and gem5::X86ISA::type.

Member Data Documentation

◆ m_adaptive_routing

const bool gem5::ruby::SimpleNetwork::m_adaptive_routing
private

Definition at line 110 of file SimpleNetwork.hh.

Referenced by getAdaptiveRouting().

◆ m_buffer_size

const int gem5::ruby::SimpleNetwork::m_buffer_size
private

Definition at line 108 of file SimpleNetwork.hh.

Referenced by getBufferSize().

◆ m_endpoint_bandwidth

const int gem5::ruby::SimpleNetwork::m_endpoint_bandwidth
private

Definition at line 109 of file SimpleNetwork.hh.

Referenced by getEndpointBandwidth().

◆ m_int_link_buffers

std::vector<MessageBuffer*> gem5::ruby::SimpleNetwork::m_int_link_buffers
private

Definition at line 106 of file SimpleNetwork.hh.

Referenced by functionalRead(), functionalWrite(), makeInternalLink(), and SimpleNetwork().

◆ m_num_connected_buffers

int gem5::ruby::SimpleNetwork::m_num_connected_buffers
private

Definition at line 107 of file SimpleNetwork.hh.

Referenced by makeInternalLink(), and SimpleNetwork().

◆ m_switches

std::vector<Switch*> gem5::ruby::SimpleNetwork::m_switches
private

◆ networkStats

gem5::ruby::SimpleNetwork::NetworkStats gem5::ruby::SimpleNetwork::networkStats
private

Referenced by regStats().


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