spinnman.processes package

Module contents

class spinnman.processes.AbstractMultiConnectionProcess(next_connection_selector: ConnectionSelector, n_retries: int = 10, timeout: float = 1.0, n_channels: int = 8, intermediate_channel_waits: int = 7, non_fail_retry_codes: Set[SCPResult] | None = None)

Bases: Generic[R]

A process for talking to SpiNNaker efficiently that uses multiple connections in communication if relevant.

Parameters:

  • next_connection_selector (ConnectionSelector) – How to choose the connection.

  • n_retries (int) – The number of retries of a message to use. Passed to SCPRequestPipeLine

  • timeout (float) – The timeout, in seconds. Passed to SCPRequestPipeLine

  • n_channels (int) – The maximum number of channels to use when talking to a particular SCAMP instance. Passed to SCPRequestPipeLine

  • intermediate_channel_waits (int) – The maximum number of outstanding message/reply pairs to have on a particular connection. Passed to SCPRequestPipeLine

  • non_fail_retry_codes (Optional[Set[SCPResult]]) – Optional set of responses that result in retry but after retrying don’t then result in failure even if returned on the last call.

check_for_error(print_exception: bool = False) → None[source]

Check if any errors have been cached and raises them

if print_exception it also logs the error.

Parameters:

print_exception (bool)

Raises:

SpinnmanGenericProcessException – If any was found

property connection_selector: ConnectionSelector

The connection selector of the process.

Return type:

ConnectionSelector

is_error() → bool[source]

Checks if any errors have been cached.

Return type:

bool

spinnman.processes.AbstractMultiConnectionProcessConnectionSelector

alias of ConnectionSelector

class spinnman.processes.ApplicationCopyRunProcess(next_connection_selector: ConnectionSelector, timeout: float = 6.0)

Bases: AbstractMultiConnectionProcess

Process to start a binary on a subset of cores on a subset of chips of a machine, performed by, on each chip, copying the data from an adjacent chip and then starting the binary. This goes to each chip in turn, and so detects failures early on, as well as ensuring that the copy and execution is done in the case of success i.e. this ensures that if all commands are successful, the full binary has been copied and started.

Note

The binary must have been loaded to the boot chip before this is called!

Parameters:

  • next_connection_selector (ConnectionSelector) – How to choose the connection.

  • n_retries (int) – The number of retries of a message to use. Passed to SCPRequestPipeLine

  • timeout (float) – The timeout, in seconds. Passed to SCPRequestPipeLine

  • n_channels (int) – The maximum number of channels to use when talking to a particular SCAMP instance. Passed to SCPRequestPipeLine

  • intermediate_channel_waits (int) – The maximum number of outstanding message/reply pairs to have on a particular connection. Passed to SCPRequestPipeLine

  • non_fail_retry_codes (Optional[Set[SCPResult]]) – Optional set of responses that result in retry but after retrying don’t then result in failure even if returned on the last call.

run(size: int, app_id: int, core_subsets: CoreSubsets, checksum: int, wait: bool) → None[source]

Run the process.

Parameters:

  • size (int) – The size of the binary to copy

  • app_id (int) – The application id to assign to the running binary

  • core_subsets (CoreSubsets) – The cores to load the binary on to

  • checksum (int) – The checksum of the data to test against

  • wait (bool) – Whether to put the binary in “wait” mode or run it straight away

class spinnman.processes.ApplicationRunProcess(next_connection_selector: ConnectionSelector, n_retries: int = 10, timeout: float = 1.0, n_channels: int = 8, intermediate_channel_waits: int = 7, non_fail_retry_codes: Set[SCPResult] | None = None)

Bases: AbstractMultiConnectionProcess[CheckOKResponse]

A process to run an application.

Parameters:

  • next_connection_selector (ConnectionSelector) – How to choose the connection.

  • n_retries (int) – The number of retries of a message to use. Passed to SCPRequestPipeLine

  • timeout (float) – The timeout, in seconds. Passed to SCPRequestPipeLine

  • n_channels (int) – The maximum number of channels to use when talking to a particular SCAMP instance. Passed to SCPRequestPipeLine

  • intermediate_channel_waits (int) – The maximum number of outstanding message/reply pairs to have on a particular connection. Passed to SCPRequestPipeLine

  • non_fail_retry_codes (Optional[Set[SCPResult]]) – Optional set of responses that result in retry but after retrying don’t then result in failure even if returned on the last call.

run(app_id: int, core_subsets: CoreSubsets, wait: bool) → None[source]

Runs the application.

param int app_id:

param CoreSubsets core_subsets:

param bool wait:

`

class spinnman.processes.ConnectionSelector

Bases: Generic[Conn]

A connection selector for multi-connection processes.

abstract get_next_connection(message: AbstractSCPRequest) → Conn[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.FixedConnectionSelector(connection: Conn)

Bases: ConnectionSelector[Conn], Generic[Conn]

A connection selector that only uses a single connection.

Parameters:

connection (SCAMPConnection) – The connection to be used

get_next_connection(message: Any) → Conn[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.GetCPUInfoProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[Response]

Gets the CPU for processors over the provided connection.

This base class returns info for all states.

Parameters:

connection_selector (ConnectionSelector)

get_cpu_info(core_subsets: CoreSubsets) → CPUInfos[source]
Parameters:

core_subsets (CoreSubsets)

Return type:

CPUInfos

class spinnman.processes.GetExcludeCPUInfoProcess(connection_selector: ConnectionSelector, states: Container[CPUState])

Bases: GetCPUInfoProcess

Gets the CPU for processors over the provided connection.

This class returns all but infos for the requested states.

Parameters:

  • connection_selector (AbstractMultiConnectionProcessConnectionSelector)

  • states (iterable(CPUState)) – The states for which info is NOT required.

class spinnman.processes.GetHeapProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[Response]

Gets Heap information using the provided connector.

Parameters:

connection_selector (ConnectionSelector)

get_heap(chip_coords: Tuple[int, int], pointer: SystemVariableDefinition = SystemVariableDefinition.sdram_heap_address) → Sequence[HeapElement][source]
Parameters:
Return type:

list(HeapElement)

class spinnman.processes.GetIncludeCPUInfoProcess(connection_selector: ConnectionSelector, states: Container[CPUState])

Bases: GetCPUInfoProcess

Gets the CPU for processors over the provided connection.

This class returns only infos for the requested states.

Parameters:

  • connection_selector (AbstractMultiConnectionProcessConnectionSelector)

  • states (iterable(CPUState)) – The states for which info is required.

class spinnman.processes.GetMachineProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess

A process for getting the machine details over a set of connections.

Parameters:

connection_selector (ConnectionSelector)

get_machine_details(boot_x: int, boot_y: int, width: int, height: int) → Machine[source]
Parameters:
Return type:

Machine

class spinnman.processes.GetMultiCastRoutesProcess(connection_selector: ConnectionSelector, app_id: int | None = None)

Bases: AbstractMultiConnectionProcess[Response]

A process for reading the multicast routing table of a SpiNNaker chip.

Parameters:
get_routes(x: int, y: int, base_address: int) → List[MulticastRoutingEntry][source]
Parameters:
Return type:

list(MulticastRoutingEntry)

class spinnman.processes.GetNCoresInStateProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess

Gets the state of a core over the provided connection.

Parameters:

connection_selector

get_n_cores_in_state(xys: Iterable[Tuple[int, int]], app_id: int, state: CPUState) → int[source]
Parameters:
Return type:

int

class spinnman.processes.GetTagsProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess

Gets information about the tags over the provided connection.

Parameters:

connection_selector (ConnectionSelector)

get_tags(connection: SCAMPConnection) → List[AbstractTag][source]
Parameters:

connection (SCAMPConnection)

Return type:

list(IPTag or ReverseIPTag)

class spinnman.processes.GetVersionProcess(connection_selector: ConnectionSelector, n_retries: int = 10)

Bases: AbstractMultiConnectionProcess[GetVersionResponse]

A process for getting the version of the machine.

Parameters:

connection_selector (ConnectionSelector)

get_version(x: int, y: int, p: int) → VersionInfo[source]
Parameters:
Return type:

VersionInfo

class spinnman.processes.LoadFixedRouteRoutingEntryProcess(next_connection_selector: ConnectionSelector, n_retries: int = 10, timeout: float = 1.0, n_channels: int = 8, intermediate_channel_waits: int = 7, non_fail_retry_codes: Set[SCPResult] | None = None)

Bases: AbstractMultiConnectionProcess

Load a fixed route routing entry onto a chip.

Parameters:

  • next_connection_selector (ConnectionSelector) – How to choose the connection.

  • n_retries (int) – The number of retries of a message to use. Passed to SCPRequestPipeLine

  • timeout (float) – The timeout, in seconds. Passed to SCPRequestPipeLine

  • n_channels (int) – The maximum number of channels to use when talking to a particular SCAMP instance. Passed to SCPRequestPipeLine

  • intermediate_channel_waits (int) – The maximum number of outstanding message/reply pairs to have on a particular connection. Passed to SCPRequestPipeLine

  • non_fail_retry_codes (Optional[Set[SCPResult]]) – Optional set of responses that result in retry but after retrying don’t then result in failure even if returned on the last call.

load_fixed_route(x: int, y: int, fixed_route: RoutingEntry, app_id: int = 0) → None[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 (RoutingEntry) – 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: ConnectionSelector)

Bases: AbstractMultiConnectionProcess

A process for loading the multicast routing table on a SpiNNaker chip.

Parameters:

connection_selector (ConnectionSelector)

load_routes(x: int, y: int, routes: Collection[MulticastRoutingEntry], app_id: int) → None[source]
Parameters:
class spinnman.processes.MallocSDRAMProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[_AllocResponse]

A process for allocating a block of SDRAM on a SpiNNaker chip.

Parameters:

connection_selector (ConnectionSelector)

property base_address: int

The address of the allocated memory block.

Return type:

int

malloc_sdram(x: int, y: int, size: int, app_id: int, tag: int) → None[source]

Allocate space in the SDRAM space.

Parameters:
class spinnman.processes.MostDirectConnectionSelector(connections: List[SCAMPConnection])

Bases: ConnectionSelector

A selector that goes for the most direct connection for the message.

Parameters:

connections (list(SCAMPConnection)) – The connections to be used

get_next_connection(message: AbstractSCPRequest) → SCAMPConnection[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: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[_FixedRouteResponse]

A process for reading a fixed route routing table entry.

Parameters:

connection_selector (ConnectionSelector) – the SC&MP connection selector

read_fixed_route(x: int, y: int, app_id: int = 0) → RoutingEntry[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:

RoutingEntry

class spinnman.processes.ReadIOBufProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[Response]

A process for reading IOBUF memory (mostly log messages) from a SpiNNaker core.

Parameters:

connection_selector (ConnectionSelector)

read_iobuf(iobuf_size: int, core_subsets: CoreSubsets) → Iterable[IOBuffer][source]
Parameters:
Return type:

iterable(IOBuffer)

class spinnman.processes.ReadMemoryProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[Response]

A process for reading memory on a SpiNNaker chip.

Parameters:

connection_selector (ConnectionSelector)

Read some memory from the neighbour of a core.

Parameters:
Return type:

bytearray

read_memory(coordinates: Tuple[int, int, int], base_address: int, length: int) → bytearray[source]

Read some memory from a core.

Parameters:
Return type:

bytearray

class spinnman.processes.ReadRouterDiagnosticsProcess(connection_selector: ConnectionSelector)

Bases: AbstractMultiConnectionProcess[Response]

A process for reading the diagnostic data block from a SpiNNaker router.

Parameters:

connection_selector (ConnectionSelector)

get_router_diagnostics(x: int, y: int) → RouterDiagnostics[source]
Parameters:
Return type:

RouterDiagnostics

class spinnman.processes.RoundRobinConnectionSelector(connections: List[SCAMPConnection])

Bases: ConnectionSelector

A connection selector that just spreads work as evenly as possible.

Parameters:

connections (list(SCAMPConnection)) – The connections to be used

get_next_connection(message: Any) → SCAMPConnection[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: ConnectionSelector, n_retries: int = 3, timeout: float = 1.0, non_fail_retry_codes: Set[SCPResult] | None = None)

Bases: AbstractMultiConnectionProcess, Generic[R]

A process that sends a single command and waits for a simple response.

Parameters:

  • connection_selector (ConnectionSelector)

  • n_retries (int) – The number of retries of a message to use. Passed to SCPRequestPipeLine

  • timeout (float) – The timeout, in seconds. Passed to SCPRequestPipeLine

  • non_fail_retry_codes (Optional[Set[SCPResult]]) – Optional set of responses that result in retry but after retrying don’t then result in failure even if returned on the last call.

execute(request: AbstractSCPRequest[R]) → R[source]
Parameters:

request (AbstractSCPRequest)

Return type:

AbstractSCPResponse

class spinnman.processes.WriteMemoryProcess(next_connection_selector: ConnectionSelector, n_retries: int = 10, timeout: float = 1.0, n_channels: int = 8, intermediate_channel_waits: int = 7, non_fail_retry_codes: Set[SCPResult] | None = None)

Bases: AbstractMultiConnectionProcess[CheckOKResponse]

A process for writing memory on a SpiNNaker chip.

Parameters:

  • next_connection_selector (ConnectionSelector) – How to choose the connection.

  • n_retries (int) – The number of retries of a message to use. Passed to SCPRequestPipeLine

  • timeout (float) – The timeout, in seconds. Passed to SCPRequestPipeLine

  • n_channels (int) – The maximum number of channels to use when talking to a particular SCAMP instance. Passed to SCPRequestPipeLine

  • intermediate_channel_waits (int) – The maximum number of outstanding message/reply pairs to have on a particular connection. Passed to SCPRequestPipeLine

  • non_fail_retry_codes (Optional[Set[SCPResult]]) – Optional set of responses that result in retry but after retrying don’t then result in failure even if returned on the last call.

Writes memory onto a neighbour of a SpiNNaker chip from a bytearray.

Parameters:

  • coordinates (tuple(int,int,int)) – The X,Y,P coordinates of the core that will write to its neighbour’s memory.

  • 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

  • get_sum (bool) – whether to return a checksum or 0

Returns:

the data checksum or 0 if get_sum is False

Return type:

int

Writes memory onto a neighbour of a SpiNNaker chip from a reader.

Parameters:

  • coordinates (tuple(int,int,int)) – The X,Y,P coordinates of the core that will write to its neighbour’s memory. The P coordinate is normally 0; no reason to not use SCAMP for this.

  • 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

  • get_sum (bool) – whether to return a checksum or 0

Returns:

the data checksum or 0 if get_sum is False

Return type:

int

write_memory_from_bytearray(coordinates: Tuple[int, int, int], base_address: int, data: bytes, offset: int, n_bytes: int, get_sum: bool = False) → int[source]

Writes memory onto a SpiNNaker chip from a bytearray.

Parameters:

  • coordinates (tuple(int,int,int)) – The X,Y,P coordinates of the core that will write to memory.

  • 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

  • get_sum (bool) – whether to return a checksum or 0

Returns:

the data checksum or 0 if get_sum is False

Return type:

int

write_memory_from_reader(coordinates: Tuple[int, int, int], base_address: int, reader: BinaryIO, n_bytes: int, get_sum: bool = False) → int[source]

Writes memory onto a SpiNNaker chip from a reader.

Parameters:

  • coordinates (tuple(int,int,int)) – The X,Y,P coordinates of the core that will write to memory.

  • 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

  • get_sum (bool) – whether to return a checksum or 0

Returns:

the data checksum or 0 if get_sum is False

Return type:

int