spinn_front_end_common.interface.buffer_management package

Subpackages

• spinn_front_end_common.interface.buffer_management.buffer_models package
  • Module contents
    • AbstractReceiveBuffersToHost
      • AbstractReceiveBuffersToHost.get_recorded_region_ids()
      • AbstractReceiveBuffersToHost.get_recording_region_base_address()
    • AbstractSendsBuffersFromHost
      • AbstractSendsBuffersFromHost.buffering_input()
      • AbstractSendsBuffersFromHost.get_next_key()
      • AbstractSendsBuffersFromHost.get_next_timestamp()
      • AbstractSendsBuffersFromHost.get_region_buffer_size()
      • AbstractSendsBuffersFromHost.get_regions()
      • AbstractSendsBuffersFromHost.is_empty()
      • AbstractSendsBuffersFromHost.is_next_key()
      • AbstractSendsBuffersFromHost.is_next_timestamp()
      • AbstractSendsBuffersFromHost.rewind()
    • SendsBuffersFromHostPreBufferedImpl
      • SendsBuffersFromHostPreBufferedImpl.buffering_input()
      • SendsBuffersFromHostPreBufferedImpl.get_next_key()
      • SendsBuffersFromHostPreBufferedImpl.get_next_timestamp()
      • SendsBuffersFromHostPreBufferedImpl.get_regions()
      • SendsBuffersFromHostPreBufferedImpl.is_empty()
      • SendsBuffersFromHostPreBufferedImpl.is_next_key()
      • SendsBuffersFromHostPreBufferedImpl.is_next_timestamp()
      • SendsBuffersFromHostPreBufferedImpl.rewind()
      • SendsBuffersFromHostPreBufferedImpl.send_buffers
• spinn_front_end_common.interface.buffer_management.storage_objects package
  • Module contents
    • BufferDatabase
      • BufferDatabase.clear_region()
      • BufferDatabase.get_core_name()
      • BufferDatabase.get_region_data()
      • BufferDatabase.store_data_in_region_buffer()
      • BufferDatabase.store_vertex_labels()
      • BufferDatabase.write_session_credentials_to_db()
    • BufferedSendingRegion
      • BufferedSendingRegion.add_key()
      • BufferedSendingRegion.add_keys()
      • BufferedSendingRegion.clear()
      • BufferedSendingRegion.current_timestamp
      • BufferedSendingRegion.get_n_keys()
      • BufferedSendingRegion.is_next_key()
      • BufferedSendingRegion.is_next_timestamp
      • BufferedSendingRegion.n_timestamps
      • BufferedSendingRegion.next_key
      • BufferedSendingRegion.next_timestamp
      • BufferedSendingRegion.rewind()
      • BufferedSendingRegion.timestamps
    • BuffersSentDeque
      • BuffersSentDeque.add_message_to_send()
      • BuffersSentDeque.is_empty()
      • BuffersSentDeque.is_full
      • BuffersSentDeque.messages
      • BuffersSentDeque.send_stop_message()
      • BuffersSentDeque.update_last_received_sequence_number()

Submodules

spinn_front_end_common.interface.buffer_management.recording_utilities module

spinn_front_end_common.interface.buffer_management.recording_utilities.get_recording_data_constant_size(n_recording_regions: int) → int

Get the size of the headers that are stored in the SDRAM spaces allocated during recording_initialise, and so do not need to be reserved with DSG (but need to be accounted for in SDRAM calculations).

Parameters:

n_recording_regions (int) – The number of regions that can be recorded

Return type:

int

spinn_front_end_common.interface.buffer_management.recording_utilities.get_recording_header_array(recorded_region_sizes: Sequence[int]) → List[int]

Get data to be written for the recording header.

Parameters:

recorded_region_sizes (list(int)) – A list of sizes of each region to be recorded. A size of 0 is acceptable.

Return type:

list(int)

spinn_front_end_common.interface.buffer_management.recording_utilities.get_recording_header_size(n_recording_regions: int) → int

Get the size of the data to be written for the recording header.

This is the data that sets up how recording will be done, and indicates the sizes of the regions to be stored.

Parameters:

n_recording_regions (int) – The number of regions that can be recorded

Return type:

int

Module contents

class spinn_front_end_common.interface.buffer_management.BufferManager

Bases: object

Manager of send buffers.

clear_recorded_data(x: int, y: int, p: int, recording_region_id: int)

Removes the recorded data stored in memory.

Parameters:

• x (int) – placement X coordinate

• y (int) – placement Y coordinate

• p (int) – placement processor ID

• recording_region_id (int) – the recording region ID

get_data_by_placement(placement: Placement, recording_region_id: int) → Tuple[bytes, bool]

Get the data container for all the data retrieved during the simulation from a specific region area of a core.

Parameters:

• placement (Placement) – the placement to get the data from

• recording_region_id (int) – desired recording data region

Returns:

an array contained all the data received during the simulation, and a flag indicating if any data was missing

Return type:

tuple(bytearray, bool)

get_placement_data() → None

Retrieve the data from placed vertices.

load_initial_buffers() → None

Load the initial buffers for the senders using memory writes.

reset() → None

Resets the buffered regions to start transmitting from the beginning of its expected regions and clears the buffered out data files.

resume() → None

Resets any data structures needed before starting running again.

property sender_vertices: Iterable[AbstractSendsBuffersFromHost]

The vertices which are buffered.

Return type:

iterable(AbstractSendsBuffersFromHost)