# Copyright (c) 2015 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
import struct
from threading import Thread, Condition
from time import sleep
from spinn_utilities.log import FormatAdapter
from spinnman.messages.eieio.data_messages import (
EIEIODataMessage, KeyPayloadDataElement)
from spinnman.messages.eieio import EIEIOType, AbstractEIEIOMessage
from spinnman.connections import ConnectionListener
from spinnman.connections.udp_packet_connections import (
EIEIOConnection, UDPConnection)
from spinnman.messages.sdp.sdp_flag import SDPFlag
from spinnman.constants import SCP_SCAMP_PORT
from spinnman.messages.sdp.sdp_message import SDPMessage
from spinnman.messages.sdp.sdp_header import SDPHeader
from spinnman.utilities.utility_functions import reprogram_tag_to_listener
from spinnman.messages.eieio import (
read_eieio_command_message, read_eieio_data_message)
from spinn_front_end_common.utilities.constants import NOTIFY_PORT
from spinn_front_end_common.utilities.database import DatabaseConnection
from spinn_front_end_common.utilities.exceptions import ConfigurationException
logger = FormatAdapter(logging.getLogger(__name__))
# The maximum number of 32-bit keys that will fit in a packet
_MAX_FULL_KEYS_PER_PACKET = 63
# The maximum number of 16-bit keys that will fit in a packet
_MAX_HALF_KEYS_PER_PACKET = 127
# The maximum number of 32-bit keys with payloads that will fit in a packet
_MAX_FULL_KEYS_PAYLOADS_PER_PACKET = 31
# Decoding of a single short value
_ONE_SHORT = struct.Struct("<H")
# The size of a RAW SCP OK response (includes 2 bytes of padding)
_SCP_OK_SIZE = 18
# The byte of the RAW SCP packet that contains the flags
_SCP_FLAGS_BYTE = 2
# The byte of the RAW SCP packet that contains the destination cpu
_SCP_DEST_CPU_BYTE = 4
# The expected flags from a RAW SCP packet in response
_SCP_RESPONSE_FLAGS = 7
# The expected destination cpu from a RAW SCP packet in repsonse
_SCP_RESPONSE_DEST = 0xFF
[docs]class LiveEventConnection(DatabaseConnection):
"""
A connection for receiving and sending live events from and to SpiNNaker.
.. note::
This class is intended to be potentially usable from another
process than the one that the simulator is present in.
"""
__slots__ = [
"_atom_id_to_key",
"__error_keys",
"__init_callbacks",
"__key_to_atom_id_and_label",
"__live_event_callbacks",
"__live_packet_gather_label",
"__pause_stop_callbacks",
"__receive_labels",
"__receiver_connection",
"__receiver_listener",
"__send_address_details",
"__send_labels",
"__sender_connection",
"__start_resume_callbacks",
"__simulator",
"__spalloc_job",
"__receiver_details",
"__is_running",
"__expect_scp_response",
"__expect_scp_response_lock",
"__scp_response_received"]
def __init__(self, live_packet_gather_label, receive_labels=None,
send_labels=None, local_host=None, local_port=NOTIFY_PORT):
"""
:param str live_packet_gather_label:
The label of the vertex to which received events are being sent
:param iterable(str) receive_labels:
Labels of vertices from which live events will be received.
:param iterable(str) send_labels:
Labels of vertices to which live events will be sent
:param str local_host:
Optional specification of the local hostname or IP address of the
interface to listen on
:param int local_port:
Optional specification of the local port to listen on. Must match
the port that the toolchain will send the notification on (19999
by default)
"""
# pylint: disable=too-many-arguments
super().__init__(
self.__do_start_resume, self.__do_stop_pause,
local_host=local_host, local_port=local_port)
self.add_database_callback(self.__read_database_callback)
self.__live_packet_gather_label = live_packet_gather_label
self.__receive_labels = (
list(receive_labels) if receive_labels is not None else None)
self.__send_labels = (
list(send_labels) if send_labels is not None else None)
self.__sender_connection = None
self.__send_address_details = dict()
# Also used by SpynnakerPoissonControlConnection
self._atom_id_to_key = dict()
self.__key_to_atom_id_and_label = dict()
self.__live_event_callbacks = list()
self.__start_resume_callbacks = dict()
self.__pause_stop_callbacks = dict()
self.__init_callbacks = dict()
self.__receiver_details = list()
if receive_labels is not None:
for label in receive_labels:
self.__live_event_callbacks.append(list())
self.__start_resume_callbacks[label] = list()
self.__pause_stop_callbacks[label] = list()
self.__init_callbacks[label] = list()
if send_labels is not None:
for label in send_labels:
self.__start_resume_callbacks[label] = list()
self.__pause_stop_callbacks[label] = list()
self.__init_callbacks[label] = list()
self.__receiver_listener = None
self.__receiver_connection = None
self.__error_keys = set()
self.__is_running = False
self.__expect_scp_response = False
self.__expect_scp_response_lock = Condition()
self.__scp_response_received = None
[docs] def add_send_label(self, label):
if self.__send_labels is None:
self.__send_labels = list()
if label not in self.__send_labels:
self.__send_labels.append(label)
if label not in self.__start_resume_callbacks:
self.__start_resume_callbacks[label] = list()
self.__pause_stop_callbacks[label] = list()
self.__init_callbacks[label] = list()
[docs] def add_receive_label(self, label):
if self.__receive_labels is None:
self.__receive_labels = list()
if label not in self.__receive_labels:
self.__receive_labels.append(label)
self.__live_event_callbacks.append(list())
if label not in self.__start_resume_callbacks:
self.__start_resume_callbacks[label] = list()
self.__pause_stop_callbacks[label] = list()
self.__init_callbacks[label] = list()
[docs] def add_init_callback(self, label, init_callback):
"""
Add a callback to be called to initialise a vertex.
:param str label:
The label of the vertex to be notified about. Must be one of the
vertices listed in the constructor
:param init_callback: A function to be called to initialise the
vertex. This should take as parameters the label of the vertex,
the number of neurons in the population, the run time of the
simulation in milliseconds, and the simulation timestep in
milliseconds
:type init_callback: callable(str, int, float, float) -> None
"""
self.__init_callbacks[label].append(init_callback)
[docs] def add_receive_callback(self, label, live_event_callback,
translate_key=True):
"""
Add a callback for the reception of live events from a vertex.
:param str label: The label of the vertex to be notified about.
Must be one of the vertices listed in the constructor
:param live_event_callback: A function to be called when events are
received. This should take as parameters the label of the vertex,
the simulation timestep when the event occurred, and an
array-like of atom IDs.
:type live_event_callback: callable(str, int, list(int)) -> None
:param bool translate_key:
True if the key is to be converted to an atom ID, False if the
key should stay a key
"""
label_id = self.__receive_labels.index(label)
logger.info("Receive callback {} registered to label {}",
live_event_callback, label)
self.__live_event_callbacks[label_id].append(
(live_event_callback, translate_key))
[docs] def add_start_callback(self, label, start_callback):
"""
Add a callback for the start of the simulation.
:param start_callback: A function to be called when the start
message has been received. This function should take the label of
the referenced vertex, and an instance of this class, which can
be used to send events
:type start_callback: callable(str, LiveEventConnection) -> None
:param str label: the label of the function to be sent
"""
logger.warning(
"the method 'add_start_callback(label, start_callback)' is in "
"deprecation, and will be replaced with the method "
"'add_start_resume_callback(label, start_resume_callback)' in a "
"future release.")
self.add_start_resume_callback(label, start_callback)
[docs] def add_start_resume_callback(self, label, start_resume_callback):
"""
Add a callback for the start and resume state of the simulation.
:param str label: the label of the function to be sent
:param start_resume_callback: A function to be called when the start
or resume message has been received. This function should take
the label of the referenced vertex, and an instance of this
class, which can be used to send events.
:type start_resume_callback: callable(str, LiveEventConnection) -> None
"""
self.__start_resume_callbacks[label].append(start_resume_callback)
[docs] def add_pause_stop_callback(self, label, pause_stop_callback):
"""
Add a callback for the pause and stop state of the simulation.
:param str label: the label of the function to be sent
:param pause_stop_callback: A function to be called when the pause
or stop message has been received. This function should take the
label of the referenced vertex, and an instance of this class,
which can be used to send events.
:type pause_stop_callback: callable(str, LiveEventConnection) -> None
"""
self.__pause_stop_callbacks[label].append(pause_stop_callback)
def __read_database_callback(self, db_reader):
"""
:param DatabaseReader db_reader:
"""
self.__handle_possible_rerun_state()
vertex_sizes = dict()
run_time_ms = db_reader.get_configuration_parameter_value(
"runtime")
machine_timestep_ms = db_reader.get_configuration_parameter_value(
"machine_time_step") / 1000.0
if self.__send_labels is not None:
self.__init_sender(db_reader, vertex_sizes)
if self.__receive_labels is not None:
self.__init_receivers(db_reader, vertex_sizes)
for label, vertex_size in vertex_sizes.items():
for init_callback in self.__init_callbacks[label]:
init_callback(
label, vertex_size, run_time_ms, machine_timestep_ms)
def __init_sender(self, db, vertex_sizes):
"""
:param DatabaseReader db:
:param dict(str,int) vertex_sizes:
"""
if self.__sender_connection is None:
job = db.get_job()
if job:
self.__sender_connection = job.open_listener_connection()
else:
self.__sender_connection = EIEIOConnection()
for label in self.__send_labels:
self.__send_address_details[label] = self.__get_live_input_details(
db, label)
self._atom_id_to_key[label] = db.get_atom_id_to_key_mapping(
label)
vertex_sizes[label] = len(self._atom_id_to_key[label])
def __init_receivers(self, db, vertex_sizes):
"""
:param DatabaseReader db:
:param dict(str,int) vertex_sizes:
"""
# Set up a single connection for receive
if self.__receiver_connection is None:
job = db.get_job()
if job:
self.__receiver_connection = job.open_listener_connection()
else:
self.__receiver_connection = UDPConnection()
receivers = set()
for label_id, label in enumerate(self.__receive_labels):
_, port, board_address, tag, x, y = self.__get_live_output_details(
db, label)
# Update the tag if not already done
if (board_address, port, tag) not in receivers:
receivers.add((board_address, port, tag))
self.__receiver_details.append((x, y, tag, board_address))
logger.info(
"Listening for traffic from {} on board {} on {}:{}",
label, board_address,
self.__receiver_connection.local_ip_address,
self.__receiver_connection.local_port)
key_to_atom_id = db.get_key_to_atom_id_mapping(label)
for key, atom_id in key_to_atom_id.items():
self.__key_to_atom_id_and_label[key] = (atom_id, label_id)
vertex_sizes[label] = len(key_to_atom_id)
# Last of all, set up the listener for packets
# NOTE: Has to be done last as otherwise will receive SCP messages
# sent above!
if self.__receiver_listener is None:
self.__receiver_listener = ConnectionListener(
self.__receiver_connection)
self.__receiver_listener.add_callback(self.__do_receive_packet)
self.__receiver_listener.start()
self.__send_tag_messages_now()
def __get_live_input_details(self, db_reader, send_label):
"""
:param DatabaseReader db_reader:
:param str send_label:
:rtype: tuple(int,int,int,str or None)
"""
x, y, p = db_reader.get_placements(send_label)[0]
ip_address = db_reader.get_ip_address(x, y)
return x, y, p, ip_address
def __get_live_output_details(self, db_reader, receive_label):
host, port, strip_sdp, board_address, tag, chip_x, chip_y = \
db_reader.get_live_output_details(
receive_label, self.__live_packet_gather_label)
if host is None:
raise ConfigurationException(
f"no live output tag found for {receive_label} in app graph")
if not strip_sdp:
raise receive_label("Currently, only IP tags which strip the SDP "
"headers are supported")
return host, port, board_address, tag, chip_x, chip_y
def __handle_possible_rerun_state(self):
# reset from possible previous calls
if self.__sender_connection is not None:
self.__sender_connection.close()
self.__sender_connection = None
if self.__receiver_listener is not None:
self.__receiver_listener.close()
self.__receiver_listener = None
if self.__receiver_connection is not None:
self.__receiver_connection.close()
self.__receiver_connection = None
def __launch_thread(self, kind, label, callback):
thread = Thread(
target=callback, args=(label, self),
name=(f"{kind} callback thread for live_event_connection "
f"{self._local_port}:{self._local_ip_address}"))
thread.start()
def __do_start_resume(self):
for label, callbacks in self.__start_resume_callbacks.items():
for callback in callbacks:
self.__launch_thread("start_resume", label, callback)
if not self.__is_running:
self.__is_running = True
thread = Thread(target=self.__send_tag_messages_thread)
thread.start()
def __do_stop_pause(self):
self.__is_running = False
for label, callbacks in self.__pause_stop_callbacks.items():
for callback in callbacks:
self.__launch_thread("pause_stop", label, callback)
def __send_tag_messages_thread(self):
if self.__receiver_connection is None:
return
while self.__is_running:
sleep(10.0)
if self.__is_running:
self.__send_tag_messages_now()
def __send_tag_messages_now(self):
indirect = hasattr(self.__receiver_connection, "update_tag")
for (x, y, tag, board_address) in self.__receiver_details:
with self.__expect_scp_response_lock:
self.__scp_response_received = None
self.__expect_scp_response = True
if indirect:
self.__receiver_connection.update_tag(
x, y, tag, do_receive=False)
# No port trigger necessary; proxied already
else:
reprogram_tag_to_listener(
self.__receiver_connection, x, y, board_address,
tag, read_response=False)
while self.__scp_response_received is None:
self.__expect_scp_response_lock.wait(timeout=1.0)
def __handle_scp_packet(self, data):
with self.__expect_scp_response_lock:
# SCP unexpected
if not self.__expect_scp_response:
return False
if (len(data) == _SCP_OK_SIZE and
data[_SCP_FLAGS_BYTE] == _SCP_RESPONSE_FLAGS and
data[_SCP_DEST_CPU_BYTE] == _SCP_RESPONSE_DEST):
self.__scp_response_received = data
self.__expect_scp_response = False
return True
return False
def __do_receive_packet(self, data):
if self.__handle_scp_packet(data):
return
logger.debug("Received packet")
try:
header = _ONE_SHORT.unpack_from(data)[0]
if header & 0xC000 == 0x4000:
return read_eieio_command_message(data, 0)
packet = read_eieio_data_message(data, 0)
if packet.eieio_header.is_time:
self.__handle_time_packet(packet)
else:
self.__handle_no_time_packet(packet)
# pylint: disable=broad-except
except Exception:
logger.warning("problem handling received packet", exc_info=True)
def __handle_time_packet(self, packet):
key_times_labels = dict()
atoms_times_labels = dict()
while packet.is_next_element:
element = packet.next_element
time = element.payload
key = element.key
if key in self.__key_to_atom_id_and_label:
atom_id, label_id = self.__key_to_atom_id_and_label[key]
if time not in key_times_labels:
key_times_labels[time] = dict()
atoms_times_labels[time] = dict()
if label_id not in key_times_labels[time]:
key_times_labels[time][label_id] = list()
atoms_times_labels[time][label_id] = list()
key_times_labels[time][label_id].append(key)
atoms_times_labels[time][label_id].append(atom_id)
else:
self.__handle_unknown_key(key)
for time in key_times_labels:
for label_id in key_times_labels[time]:
label = self.__receive_labels[label_id]
for c_back, use_atom in self.__live_event_callbacks[label_id]:
if use_atom:
c_back(label, time, atoms_times_labels[time][label_id])
else:
c_back(label, time, key_times_labels[time][label_id])
def __handle_no_time_packet(self, packet):
while packet.is_next_element:
element = packet.next_element
key = element.key
if key in self.__key_to_atom_id_and_label:
atom_id, label_id = self.__key_to_atom_id_and_label[key]
label = self.__receive_labels[label_id]
for c_back, use_atom in self.__live_event_callbacks[label_id]:
if isinstance(element, KeyPayloadDataElement):
if use_atom:
c_back(label, atom_id, element.payload)
else:
c_back(label, key, element.payload)
else:
if use_atom:
c_back(label, atom_id)
else:
c_back(label, key)
else:
self.__handle_unknown_key(key)
def __handle_unknown_key(self, key):
if key not in self.__error_keys:
self.__error_keys.add(key)
logger.warning("Received unexpected key {}", key)
[docs] def send_event(self, label, atom_id, send_full_keys=False):
"""
Send an event from a single atom.
:param str label:
The label of the vertex from which the event will originate
:param int atom_id: The ID of the atom sending the event
:param bool send_full_keys:
Determines whether to send full 32-bit keys, getting the key for
each atom from the database, or whether to send 16-bit atom IDs
directly
"""
self.send_events(label, [atom_id], send_full_keys)
[docs] def send_events(self, label, atom_ids, send_full_keys=False):
"""
Send a number of events.
:param str label:
The label of the vertex from which the events will originate
:param list(int) atom_ids: array-like of atom IDs sending events
:param bool send_full_keys:
Determines whether to send full 32-bit keys, getting the key for
each atom from the database, or whether to send 16-bit atom IDs
directly
"""
max_keys = _MAX_HALF_KEYS_PER_PACKET
msg_type = EIEIOType.KEY_16_BIT
if send_full_keys:
max_keys = _MAX_FULL_KEYS_PER_PACKET
msg_type = EIEIOType.KEY_32_BIT
pos = 0
x, y, p, ip_address = self.__send_address_details[label]
while pos < len(atom_ids):
message = EIEIODataMessage.create(msg_type)
events_in_packet = 0
while pos < len(atom_ids) and events_in_packet < max_keys:
key = atom_ids[pos]
if send_full_keys:
key = self._atom_id_to_key[label][key]
message.add_key(key)
pos += 1
events_in_packet += 1
self._send(message, x, y, p, ip_address)
[docs] def send_event_with_payload(self, label, atom_id, payload):
"""
Send an event with a payload from a single atom.
:param str label:
The label of the vertex from which the event will originate
:param int atom_id: The ID of the atom sending the event
:param int payload: The payload to send
"""
self.send_events_with_payloads(label, [(atom_id, payload)])
[docs] def send_events_with_payloads(self, label, atom_ids_and_payloads):
"""
Send a number of events with payloads.
:param str label:
The label of the vertex from which the events will originate
:param list(tuple(int,int)) atom_ids_and_payloads:
array-like of tuples of atom IDs sending events with their payloads
"""
msg_type = EIEIOType.KEY_PAYLOAD_32_BIT
max_keys = _MAX_FULL_KEYS_PAYLOADS_PER_PACKET
pos = 0
x, y, p, ip_address = self.__send_address_details[label]
while pos < len(atom_ids_and_payloads):
message = EIEIODataMessage.create(msg_type)
events = 0
while pos < len(atom_ids_and_payloads) and events < max_keys:
key, payload = atom_ids_and_payloads[pos]
key = self._atom_id_to_key[label][key]
message.add_key_and_payload(key, payload)
pos += 1
events += 1
self._send(message, x, y, p, ip_address)
[docs] def send_eieio_message(self, message, label):
"""
Send an EIEIO message (using one-way the live input) to the
vertex with the given label.
:param ~spinnman.messages.eieio.AbstractEIEIOMessage message:
The EIEIO message to send
:param str label: The label of the receiver machine vertex
"""
target = self.__send_address_details[label]
if target is None:
return
x, y, p, ip_address = target
self._send(message, x, y, p, ip_address)
def _send(self, message: AbstractEIEIOMessage, x, y, p, ip_address):
"""
Send an EIEIO message to a particular core.
:param ~spinnman.messages.eieio.AbstractEIEIOMessage message:
The EIEIO message to send
:param int x: Destination chip X coordinate
:param int y: Destination chip Y coordinate
:param int p: Destination core number
:param str ip_address: What ethernet chip to send via
"""
# Create an SDP message - no reply so source is unimportant
# SDP port can be anything except 0 as the target doesn't care
sdp_message = SDPMessage(
SDPHeader(
flags=SDPFlag.REPLY_NOT_EXPECTED, tag=0,
destination_port=1, destination_cpu=p,
destination_chip_x=x, destination_chip_y=y,
source_port=0, source_cpu=0,
source_chip_x=0, source_chip_y=0),
data=message.bytestring)
self.__sender_connection.send_to(
# Prefix padding: two empty bytes
b'\0\0' + sdp_message.bytestring,
(ip_address, SCP_SCAMP_PORT))
[docs] def close(self):
self.__is_running = False
self.__handle_possible_rerun_state()
super().close()