spinn_front_end_common.utilities.utility_objs package¶
Subpackages¶
- spinn_front_end_common.utilities.utility_objs.extra_monitor_scp_messages package
- Submodules
- spinn_front_end_common.utilities.utility_objs.extra_monitor_scp_messages.reinjector_scp_commands module
- spinn_front_end_common.utilities.utility_objs.extra_monitor_scp_messages.speedup_in_scp_commands module
- Module contents
Module contents¶
- class spinn_front_end_common.utilities.utility_objs.DPRIFlags(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum
SCP Dropped Packet Reinjection (DPRI) packet type flags.
- FIXED_ROUTE = 8¶
- MULTICAST = 1¶
- NEAREST_NEIGHBOUR = 4¶
- POINT_TO_POINT = 2¶
- class spinn_front_end_common.utilities.utility_objs.ExecutableType¶
Bases:
object
This class is deprecated. Please use spinnman.model.enums.ExecutableType
- NO_APPLICATION = 3¶
- RUNNING = 0¶
- SYNC = 1¶
- SYSTEM = 4¶
- USES_SIMULATION_INTERFACE = 2¶
- class spinn_front_end_common.utilities.utility_objs.LivePacketGatherParameters(port: int | None = None, hostname: str | None = None, tag=None, strip_sdp=True, use_prefix=False, key_prefix=None, prefix_type=None, message_type=EIEIOType.KEY_32_BIT, right_shift=0, payload_as_time_stamps=True, use_payload_prefix=True, payload_prefix=None, payload_right_shift=0, number_of_packets_sent_per_time_step=0, label=None, received_key_mask=4294967295, translate_keys=False, translated_key_right_shift=0)¶
Bases:
object
Parameter holder for
LivePacketGather
ers so that they can be instantiated at a later date.- Raises:
ConfigurationException – If the parameters passed are known to be an invalid combination.
- get_iptag_resource() IPtagResource [source]¶
Get a description of the
IPTag
that the LPG for these parameters will require.- Return type:
- property hostname: str | None¶
Where to send data from SpiNNaker: the host name of the listening UDP socket.
- Return type:
- property number_of_packets_sent_per_time_step: int¶
The maximum number of packets to send in a timestep.
- Return type:
- property port: int | None¶
Where to send data from SpiNNaker: the port of the listening UDP socket.
- Return type:
- property strip_sdp: bool¶
Whether to remove SDP headers from the messages before sending.
- Return type:
- class spinn_front_end_common.utilities.utility_objs.PowerUsed¶
Bases:
object
Describes the power used by a simulation.
- property active_cores: Iterable[Tuple[int, int, int]]¶
Enumeration of the coordinates of the cores that can report active energy usage.
- property active_routers: Iterable[Tuple[int, int]]¶
Enumeration of the coordinates of the routers that can report active energy usage.
- add_core_active_energy(x: int, y: int, p: int, joules: float)[source]¶
Adds energy for a particular core. It can be called multiple times per core.
Only intended to be used during construction of this object.
- add_router_active_energy(x: int, y: int, joules: float)[source]¶
Adds energy for a particular router. It can be called multiple times per router.
Only intended to be used during construction of this object.
- property baseline_joules: float¶
Baseline/idle energy used, in Joules. This is used by things like the frames the SpiNNaker boards are held in, the cooling system, etc.
- Return type:
- property chip_energy_joules: float¶
Energy used by all SpiNNaker chips during active simulation running, in Joules.
- Return type:
- property data_gen_joules: float¶
Energy used during the data generation phase, in Joules. Assumes that the SpiNNaker system has been shut down.
- Return type:
- property fpga_exec_energy_joules: float¶
Energy used by all FPGAs during active simulation running, in Joules. This is included in the total FPGA energy.
- Return type:
- property fpga_total_energy_joules: float¶
Energy used by all FPGAs in total, in Joules.
- Return type:
- get_core_active_energy_joules(x: int, y: int, p: int) float [source]¶
Energy used (above idle baseline) by a particular core, in Joules.
Unused cores always report 0.0 for this.
- get_router_active_energy_joules(x: int, y: int) float [source]¶
Energy used (above idle baseline) by a particular router, in Joules.
Unused routers always report 0.0 for this.
- class spinn_front_end_common.utilities.utility_objs.ReInjectionStatus(data: bytes, offset: int)¶
Bases:
object
Represents a status information report from dropped packet reinjection.
- Parameters:
- property is_reinjecting_fixed_route: bool¶
True if re-injection of fixed-route packets is enabled.
- Return type:
- property is_reinjecting_multicast: bool¶
True if re-injection of multicast packets is enabled.
- Return type:
- property is_reinjecting_nearest_neighbour: bool¶
True if re-injection of nearest neighbour packets is enabled.
- Return type:
- property is_reinjecting_point_to_point: bool¶
True if re-injection of point-to-point packets is enabled.
- Return type:
- property n_dropped_packet_overflows: int¶
Of the n_dropped_packets received, how many were lost due to not having enough space in the queue of packets to reinject.
- Return type:
- property n_dropped_packets: int¶
The number of packets dropped by the router and received by the reinjection functionality (may not fit in the queue though).
- Return type:
- property n_link_dumps: int¶
The number of times that when a dropped packet was caused due to a link failing to take the packet.
- Return type:
- property n_missed_dropped_packets: int¶
The number of times that when a dropped packet was read it was found that another one or more packets had also been dropped, but had been missed.
- Return type:
- property n_processor_dumps: int¶
The number of times that when a dropped packet was caused due to a processor failing to take the packet.
- Return type:
- property n_reinjected_packets: int¶
Of the n_dropped_packets received, how many packets were successfully re-injected.
- Return type:
- property router_wait1_timeout_parameters: Tuple[int, int]¶
The WAIT1 timeout value of the router as mantissa and exponent.