Simulation

This module contains the simulation setup and execution.

ControlledEnvironment

class cs143sim.simulation.ControlledEnvironment(controller)

SimPy Environment with a reference to its Controller

Parameters:controller – Controller that created the Environment

Controller

class cs143sim.simulation.Controller(case='cs143sim/cases/case0.txt')

Controller that prepares, starts, and cleans up a run of the simulation

Parameters:

case (str) – path to simulation input file

Variables:

• env – SimPy simulation Environment
• flows (dict) – all Flows in the simulation
• hosts (dict) – all Hosts in the simulation
• links (dict) – all Links in the simulation
• routers (dict) – all Routers in the simulation
• buffer_occupancy (dict) – buffer occupancy records for each link; Links key to lists of (time, value) tuples
• flow_rate (dict) – flow rate records for each flow; Flows key to lists of (time, value) tuples
• link_rate (dict) – link rate records for each link; Links key to lists of (time, value) tuples
• packet_delay (dict) – packet delay records for each flow; Flows key to lists of (time, value) tuples
• packet_loss (dict) – packet loss records for each link; Links key to lists of (time, value) tuples
• window_size (dict) – window size records for each flow; Flows key to lists of (time, value) tuples

make_flow(name, source, destination, amount, start_time, algorithm)

Make a new Flow and add it to self.flows

Parameters:

• name (str) – new Flow name
• source – source Host
• destination – destination Host
• amount (int) – amount of data to transfer, in bits
• start_time (float) – time the new Flow starts

make_host(name, ip_address)

Make a new Host and add it to self.hosts

Parameters:

• name (str) – new Host name
• ip_address (str) – new Host‘s IP address

make_link(name, source, destination, rate, delay, buffer_capacity)

Make a new Host and add it to self.hosts

Parameters:

• name (str) – new Link name
• source – source Host or Router
• destination – destination Host or Router
• rate (float) – rate of data transfer, in Mbps
• delay (float) – delay for data transfer, in ms
• buffer_capacity (int) – size of receiver Buffer, in KB

make_router(name, ip_address, update_time)

Make a new Router and add it to self.routers

Parameters:

• name (str) – new Router name
• ip_address (str) – new Router‘s IP Address

read_case(case)

Read input file at path case and create actors accordingly

Parameters:case (str) – path to simulation input file

record(recorder, actor, value)

Record the time and value in the recorder keyed by the actor

Parameters:

• recorder (dict) – recorder to record the change
• actor – Actor that experienced the change
• value – new value of changed quantity

record_buffer_occupancy(link, buffer_occupancy)

Record the occupancy of a link buffer

Parameters:

• link – Link changing its buffer occupancy
• buffer_occupancy (float) – new buffer occupancy (bytes)

record_flow_rate(flow, packet_size)

Record the size of a delivered packet

Parameters:

• flow – Flow to which the delivered packet belongs
• packet_size (float) – size of the delivered packet (bits)

record_link_rate(link, packet_size)

Record the duration a link sends a packet

Parameters:

• link – Link sending the packet
• packet_size (float) – size of the delivered packet (bits)

record_packet_delay(flow, packet_delay)

Record the delay of a delivered packet

Parameters:

• flow – Flow to which the delivered packet belongs
• packet_delay (int) – time since the delivered packet was sent (ms)

record_packet_loss(link)

Record a packet loss

Parameters:link – Link that dropped the packet

record_window_size(flow, window_size)

Record the flow’s window size

Parameters:

• flow – Flow changing its window size
• window_size (int) – new window size

run(until=None)

Run the simulation for a specified duration

Parameters:until (float) – simulation duration