spinnman.processes package¶
Module contents¶
-
class
spinnman.processes.
AbstractMultiConnectionProcess
(next_connection_selector, n_retries=10, timeout=1.0, n_channels=8, intermediate_channel_waits=7)[source]¶ Bases:
spinnman.processes.abstract_process.AbstractProcess
A process that uses multiple connections in communication.
Parameters: next_connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
ApplicationRunProcess
(next_connection_selector, n_retries=10, timeout=1.0, n_channels=8, intermediate_channel_waits=7)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
Parameters: next_connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
AbstractMultiConnectionProcessConnectionSelector
[source]¶ Bases:
object
A connection selector for multi-connection processes
-
get_next_connection
(message)[source]¶ Get the index of the next connection for the process from a list of connections.
Parameters: message (AbstractSCPRequest) – The SCP message to be sent Return type: SCAMPConnection
-
-
class
spinnman.processes.
DeAllocSDRAMProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
This class is currently deprecated and untested as there is no known use except for Transceiver.free_sdram and free_sdram_by_app_id which are both themselves deprecated.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
no_blocks_freed
¶
-
-
class
spinnman.processes.
GetCPUInfoProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
get_cpu_info
(core_subsets)[source]¶ Parameters: core_subsets (CoreSubsets) – Return type: list(CPUInfo)
-
-
class
spinnman.processes.
GetHeapProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
get_heap
(chip_address, pointer=<SystemVariableDefinition.sdram_heap_address: _Definition(offset=76, data_type=<_DataType.INT: 4>, default=0, array_size=None, doc='The base address of the user SDRAM heap')>)[source]¶ Parameters: - chip_address (tuple(int,int)) – x, y
- pointer (SystemVariableDefinition) –
Return type:
-
-
class
spinnman.processes.
GetMachineProcess
(connection_selector, default_report_directory=None)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for getting the machine details over a set of connections.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
GetMultiCastRoutesProcess
(connection_selector, app_id=None)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for reading the multicast routing table of a SpiNNaker chip.
Parameters: - connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
- app_id (int) –
-
class
spinnman.processes.
GetTagsProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – Parameters: connection (SCAMPConnection) – Return type: list(IPTag or ReverseIPTag)
-
class
spinnman.processes.
GetVersionProcess
(connection_selector, n_retries=10)[source]¶ Bases:
spinnman.processes.abstract_single_connection_process.AbstractSingleConnectionProcess
A process for getting the version of the machine.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
LoadFixedRouteRoutingEntryProcess
(next_connection_selector, n_retries=10, timeout=1.0, n_channels=8, intermediate_channel_waits=7)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
Load a fixed route routing entry onto a chip.
Parameters: next_connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
load_fixed_route
(x, y, fixed_route, app_id=0)[source]¶ Parameters: - x (int) – The x-coordinate of the chip, between 0 and 255; this is not checked due to speed restrictions.
- y (int) – The y-coordinate of the chip, between 0 and 255; this is not checked due to speed restrictions.
- fixed_route (FixedRouteEntry) – the fixed route entry
- app_id (int) – The ID of the application with which to associate the routes. If not specified, defaults to 0.
-
-
class
spinnman.processes.
LoadMultiCastRoutesProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for loading the multicast routing table on a SpiNNaker chip.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
MallocSDRAMProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for allocating a block of SDRAM on a SpiNNaker chip.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
MostDirectConnectionSelector
(machine, connections)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process_connection_selector.AbstractMultiConnectionProcessConnectionSelector
A selector that goes for the most direct connection for the message.
Parameters: - machine (Machine) –
- connections (list(SCAMPConnection)) – The connections to be used
-
get_next_connection
(message)[source]¶ Get the index of the next connection for the process from a list of connections.
Parameters: message (AbstractSCPRequest) – The SCP message to be sent Return type: SCAMPConnection
-
class
spinnman.processes.
ReadFixedRouteRoutingEntryProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for reading a fixed route routing table entry.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – the SC&MP connection selector -
read_fixed_route
(x, y, app_id=0)[source]¶ Read the fixed route entry installed on a particular chip’s router.
Parameters: - x (int) – The x-coordinate of the chip, between 0 and 255; this is not checked due to speed restrictions
- y (int) – The y-coordinate of the chip, between 0 and 255; this is not checked due to speed restrictions
- app_id (int) – The ID of the application with which to associate the routes. If not specified, defaults to 0.
Return type:
-
-
class
spinnman.processes.
ReadIOBufProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for reading IOBUF memory (mostly log messages) from a SpiNNaker core.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
read_iobuf
(iobuf_size, core_subsets)[source]¶ Parameters: - iobuf_size (int) –
- core_subsets (CoreSubsets) –
Return type: iterable(IOBuffer)
-
-
class
spinnman.processes.
ReadMemoryProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for reading memory on a SpiNNaker chip.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
ReadRouterDiagnosticsProcess
(connection_selector)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for reading the diagnostic data block from a SpiNNaker router.
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
RoundRobinConnectionSelector
(connections)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process_connection_selector.AbstractMultiConnectionProcessConnectionSelector
A connection selector that just spreads work as evenly as possible.
Parameters: connections (list(SCAMPConnection)) – The connections to be used -
get_next_connection
(message)[source]¶ Get the index of the next connection for the process from a list of connections.
Parameters: message (AbstractSCPRequest) – The SCP message to be sent Return type: SCAMPConnection
-
-
class
spinnman.processes.
SendSingleCommandProcess
(connection_selector, n_retries=3, timeout=1.0)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
Parameters: connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
execute
(request)[source]¶ Parameters: request (AbstractSCPRequest) – Return type: AbstractSCPResponse
-
-
class
spinnman.processes.
WriteMemoryFloodProcess
(next_connection_selector, n_retries=10, timeout=1.0, n_channels=8, intermediate_channel_waits=7)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for writing memory on multiple SpiNNaker chips at once.
Parameters: next_connection_selector (AbstractMultiConnectionProcessConnectionSelector) –
-
class
spinnman.processes.
WriteMemoryProcess
(next_connection_selector, n_retries=10, timeout=1.0, n_channels=8, intermediate_channel_waits=7)[source]¶ Bases:
spinnman.processes.abstract_multi_connection_process.AbstractMultiConnectionProcess
A process for writing memory on a SpiNNaker chip.
Parameters: next_connection_selector (AbstractMultiConnectionProcessConnectionSelector) – -
write_link_memory_from_bytearray
(x, y, p, link, base_address, data, offset, n_bytes)[source]¶ Writes memory onto a neighbour of a SpiNNaker chip from a bytearray.
Parameters: - x (int) – The x-coordinate of the chip where the memory is to be written to
- y (int) – The y-coordinate of the chip where the memory is to be written to
- p (int) – The processor of the chip where the memory is to be written to
- link (int) – Along which link is the neighbour.
- base_address (int) – the address in SDRAM to start writing
- data (bytearray or bytes) – the data to write
- offset (int) – where in the data to start writing from
- n_bytes (int) – how much data to write
-
write_link_memory_from_reader
(x, y, p, link, base_address, reader, n_bytes)[source]¶ Writes memory onto a neighbour of a SpiNNaker chip from a reader.
Parameters: - x (int) – The x-coordinate of the chip where the memory is to be written to
- y (int) – The y-coordinate of the chip where the memory is to be written to
- p (int) – The processor of the chip where the memory is to be written to
- link (int) – Along which link is the neighbour.
- base_address (int) – the address in SDRAM to start writing
- reader (RawIOBase or BufferedIOBase) – the readable object containing the data to write
- n_bytes (int) – how much data to write
-
write_memory_from_bytearray
(x, y, p, base_address, data, offset, n_bytes)[source]¶ Writes memory onto a SpiNNaker chip from a bytearray.
Parameters: - x (int) – The x-coordinate of the chip where the memory is to be written to
- y (int) – The y-coordinate of the chip where the memory is to be written to
- p (int) – The processor of the chip where the memory is to be written to
- base_address (int) – the address in SDRAM to start writing
- data (bytearray or bytes) – the data to write
- offset (int) – where in the data to start writing from
- n_bytes (int) – how much data to write
-
write_memory_from_reader
(x, y, p, base_address, reader, n_bytes)[source]¶ Writes memory onto a SpiNNaker chip from a reader.
Parameters: - x (int) – The x-coordinate of the chip where the memory is to be written to
- y (int) – The y-coordinate of the chip where the memory is to be written to
- p (int) – The processor of the chip where the memory is to be written to
- base_address (int) – the address in SDRAM to start writing
- reader (RawIOBase or BufferedIOBase) – the readable object containing the data to write
- n_bytes (int) – how much data to write
-