Struct Basic

pub struct Basic { /* private fields */ }

The basic Router struct. Very similar to FSIN’s router.

Implementations

impl Basic

pub fn new(arg: RouterBuilderArgument<'_>) -> Rc<RefCell<Basic>>

Trait Implementations

impl Eventful for Basic

fn process( &mut self, simulation: &SimulationShared, mutable: &mut SimulationMut, ) -> Vec<EventGeneration>

main routine of the router. Do all things that must be done in a cycle, if any.

fn as_eventful(&self) -> Weak<RefCell<dyn Eventful>>

Extract the eventful from the implementing class. Required since as Rc<RefCell<Eventful>> does not work.

fn schedule( &mut self, current_cycle: Time, delay: Time, ) -> Option<EventGeneration>

Schedule this component to be executed after delay cycles as soon as possible. This should include waits to synchronize with the component’s internal clock. Call with 0 to schedule as soon as possible, including the current cycle. Call with 1 to schedule in a future cycle as soon as possible. Returns None if the component decides against to be scheduled. For example due to already being scheduled.

impl Quantifiable for Basic

fn total_memory(&self) -> usize

Get the total memory currently being employed by the implementing type. Both stack and heap.

fn print_memory_breakdown(&self)

Prints by stdout how much memory is used per component.

fn forecast_total_memory(&self) -> usize

Get an estimation on how much memory the type could reach during the simulation.

impl Router for Basic

fn insert( &mut self, current_cycle: Time, phit: Rc<Phit>, port: usize, rng: &mut StdRng, ) -> Vec<EventGeneration>

Introduces a phit into the router in the specified port. Should return a list of events to push into the event queue. This may include to schedule itself or a subcomponent.

fn acknowledge( &mut self, current_cycle: Time, port: usize, ack_message: AcknowledgeMessage, ) -> Vec<EventGeneration>

Receive the acknowledge of a phit clear. Generally to increase the credit count. Should return a list of events to push into the event queue. This may include to schedule itself or a subcomponent.

fn num_virtual_channels(&self) -> usize

To get the number of virtual channels the router uses.

fn virtual_port_size(&self, _port: usize, _virtual_channel: usize) -> usize

Get the number of phits that fit inside the buffer of a port.

fn iter_phits(&self) -> Box<dyn Iterator<Item = Rc<Phit>>>

To iterate over the phits managed by the router. Required to account memory.

fn get_status_at_emisor(&self, port: usize) -> Option<&dyn StatusAtEmissor>

Get a virtual port if any. To be used in some policies, e.g., VirtualChannelPolicy::Shortest.

fn get_maximum_credits_towards( &self, _port: usize, _virtual_channel: usize, ) -> Option<usize>

Get the maximum number of credits towards the neighbour. To be used in policies such as VirtualChannelPolicy::LowestSinghWeight.

fn get_index(&self) -> Option<usize>

Get the index of the router in the topology. To be used in policies such as VirtualChannelPolicy::LowestSinghWeight.

fn aggregate_statistics( &self, statistics: Option<ConfigurationValue>, router_index: usize, total_routers: usize, cycle: Time, ) -> Option<ConfigurationValue>

To optionally write router statistics into the simulation output. Each router receives the aggregate of the statistics of the previous routers. In the frist router we have statistics=None and router_index=0. In the last router we have router_index+1==total_routers==topology.routers.len(), that may be used for final normalizations.

fn reset_statistics(&mut self, next_cycle: Time)

Clears all collected statistics

fn build_emissor_status( &self, port: usize, topology: &dyn Topology, ) -> Box<dyn StatusAtEmissor + 'static>

Build a status for an element that sends packets directly to the router ports. This is intended to build the status of the servers.