# Copyright (c) 2021 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.
from typing import List, Optional, Union
from typing_extensions import TypeAlias
from spinn_utilities.overrides import overrides
from pacman.model.graphs.application import (
ApplicationFPGAVertex, ApplicationSpiNNakerLinkVertex)
from pacman.model.graphs.machine import (
MachineFPGAVertex, MachineSpiNNakerLinkVertex)
from pacman.exceptions import (
PacmanConfigurationException, PacmanNotExistException)
from pacman.model.graphs.application import FPGAConnection
from pacman.utilities.utility_objs import ChipCounter
from pacman.model.graphs.machine import MachineVertex
from pacman.model.graphs.common import Slice
from .abstract_splitter_common import AbstractSplitterCommon
_Allowed: TypeAlias = Union[
ApplicationFPGAVertex, ApplicationSpiNNakerLinkVertex]
class SplitterExternalDevice(AbstractSplitterCommon):
"""
A splitter for handling external devices.
"""
__slots__ = (
# Machine vertices that will send packets into the network
"__incoming_vertices",
# Machine vertices that will receive packets from the network
"__outgoing_vertex",
# Slices of incoming vertices (not exactly but hopefully close enough)
"__incoming_slices",
# Slice of outgoing vertex (which really doesn't matter here)
"__outgoing_slice")
def __init__(self) -> None:
super().__init__()
self.__incoming_vertices: List[MachineVertex] = list()
self.__incoming_slices: List[Slice] = list()
self.__outgoing_vertex: Optional[MachineVertex] = None
self.__outgoing_slice: Optional[Slice] = None
[docs]
@overrides(AbstractSplitterCommon.set_governed_app_vertex)
def set_governed_app_vertex(self, app_vertex: _Allowed):
super().set_governed_app_vertex(app_vertex)
self.__incoming_vertices = list()
self.__incoming_slices = list()
self.__outgoing_vertex = None
self.__outgoing_slice = None
if isinstance(app_vertex, ApplicationFPGAVertex):
fpga: Optional[FPGAConnection]
# This can have multiple FPGA connections per board
for i in range(app_vertex.n_machine_vertices_per_link):
for fpga in app_vertex.incoming_fpga_connections:
label = (
f"Incoming Machine vertex {i} for"
f" {app_vertex.label}"
f":{fpga.fpga_id}:{fpga.fpga_link_id}"
f":{fpga.board_address}:{fpga.chip_coords}")
vertex_slice = app_vertex.get_incoming_slice_for_link(
fpga, i)
self.__incoming_vertices.append(MachineFPGAVertex(
fpga.fpga_id, fpga.fpga_link_id,
fpga.board_address, fpga.chip_coords, label=label,
app_vertex=app_vertex, vertex_slice=vertex_slice,
incoming=True, outgoing=False))
self.__incoming_slices.append(vertex_slice)
fpga = app_vertex.outgoing_fpga_connection
if fpga is not None:
label = (
f"Outgoing Machine vertex for {app_vertex.label}"
f":{fpga.fpga_id}:{fpga.fpga_link_id}"
f":{fpga.board_address}:{fpga.chip_coords}")
self.__outgoing_slice = app_vertex.get_outgoing_slice()
self.__outgoing_vertex = MachineFPGAVertex(
fpga.fpga_id, fpga.fpga_link_id, fpga.board_address,
fpga.chip_coords, app_vertex=app_vertex, label=label,
vertex_slice=self.__outgoing_slice,
incoming=False, outgoing=True)
elif isinstance(app_vertex, ApplicationSpiNNakerLinkVertex):
# So far this only handles one connection in total
label = f"Machine vertex for {app_vertex.label}"
if app_vertex.incoming:
for i in range(app_vertex.n_machine_vertices):
vertex_slice = app_vertex.get_incoming_slice(i)
self.__incoming_vertices.append(MachineSpiNNakerLinkVertex(
app_vertex.spinnaker_link_id, app_vertex.board_address,
None, label=label, app_vertex=app_vertex,
vertex_slice=vertex_slice, incoming=True,
outgoing=False))
self.__incoming_slices.append(vertex_slice)
if app_vertex.outgoing:
self.__outgoing_slice = app_vertex.get_outgoing_slice()
self.__outgoing_vertex = MachineSpiNNakerLinkVertex(
app_vertex.spinnaker_link_id, app_vertex.board_address,
None, label=label, app_vertex=app_vertex,
vertex_slice=self.__outgoing_slice, incoming=False,
outgoing=True)
else:
raise PacmanConfigurationException(
f"Unknown vertex type to splitter: {app_vertex}")
[docs]
@overrides(AbstractSplitterCommon.create_machine_vertices)
def create_machine_vertices(self, chip_counter: ChipCounter):
app_vertex = self.governed_app_vertex
for vertex in self.__incoming_vertices:
# machine_graph.add_vertex(vertex)
chip_counter.add_core(vertex.sdram_required)
app_vertex.remember_machine_vertex(vertex)
if self.__outgoing_vertex is not None:
# machine_graph.add_vertex(self.__outgoing_vertex)
chip_counter.add_core(self.__outgoing_vertex.sdram_required)
app_vertex.remember_machine_vertex(self.__outgoing_vertex)
[docs]
@overrides(AbstractSplitterCommon.get_in_coming_slices)
def get_in_coming_slices(self) -> List[Slice]:
if self.__outgoing_slice is None:
return []
return [self.__outgoing_slice]
[docs]
@overrides(AbstractSplitterCommon.get_out_going_slices)
def get_out_going_slices(self) -> List[Slice]:
return self.__incoming_slices
[docs]
@overrides(AbstractSplitterCommon.get_in_coming_vertices)
def get_in_coming_vertices(self, partition_id: str) -> List[MachineVertex]:
# Note, the incoming vertex is how to get packets into this device,
# so we want to direct it at the outgoing vertex!
if self.__outgoing_vertex is None:
raise PacmanNotExistException(
f"The target device of {self} doesn't support outgoing"
" traffic")
return [self.__outgoing_vertex]
[docs]
@overrides(AbstractSplitterCommon.get_out_going_vertices)
def get_out_going_vertices(self, partition_id: str) -> List[MachineVertex]:
# Note, the outgoing vertex is how to get packets out of this device,
# so we want to direct it at the incoming vertices!
if not self.__incoming_vertices:
raise PacmanNotExistException(
f"The target device of {self} doesn't support incoming"
" traffic")
return self.__incoming_vertices
[docs]
@overrides(AbstractSplitterCommon.machine_vertices_for_recording)
def machine_vertices_for_recording(
self, variable_to_record: str) -> List[MachineVertex]:
return []
[docs]
@overrides(AbstractSplitterCommon.reset_called)
def reset_called(self) -> None:
pass