# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from .exceptions import (
SpinnMachineAlreadyExistsException, SpinnMachineInvalidParameterException)
from spinn_machine.router import Router
[docs]class MulticastRoutingEntry(object):
""" Represents an entry in a SpiNNaker chip's multicast routing table
"""
__slots__ = (
"_routing_entry_key", "_mask", "_defaultable", "_processor_ids",
"_link_ids", "_spinnaker_route"
)
# pylint: disable=too-many-arguments
def __init__(self, routing_entry_key, mask, processor_ids=None,
link_ids=None, defaultable=False, spinnaker_route=None):
"""
:param routing_entry_key: The routing key_combo
:type routing_entry_key: int
:param mask: The route key_combo mask
:type mask: int
:param processor_ids: The destination processor IDs
:type processor_ids: iterable(int)
:param link_ids: The destination link IDs
:type link_ids: iterable(int)
:param defaultable: if this entry is defaultable (it receives packets \
from its directly opposite route position)
:type defaultable: bool
:raise spinn_machine.exceptions.SpinnMachineAlreadyExistsException:
* If processor_ids contains the same ID more than once
* If link_ids contains the same ID more than once
"""
self._routing_entry_key = routing_entry_key
self._mask = mask
self._defaultable = defaultable
if (routing_entry_key & mask) != routing_entry_key:
raise SpinnMachineInvalidParameterException(
"key_mask_combo and mask",
"{} and {}".format(routing_entry_key, mask),
"The key combo is changed when masked with the mask. This"
" is determined to be an error in the tool chain. Please "
"correct this and try again.")
# Add processor IDs, checking that there is only one of each
if spinnaker_route is None:
self._processor_ids = set()
for processor_id in processor_ids:
if processor_id in self._processor_ids:
raise SpinnMachineAlreadyExistsException(
"processor ID", str(processor_id))
self._processor_ids.add(processor_id)
# Add link IDs, checking that there is only one of each
self._link_ids = set()
for link_id in link_ids:
if link_id in self._link_ids:
raise SpinnMachineAlreadyExistsException(
"link ID", str(link_id))
self._link_ids.add(link_id)
self._spinnaker_route = self._calc_spinnaker_route()
else:
self._spinnaker_route = spinnaker_route
self._processor_ids = None
self._link_ids = None
@property
def routing_entry_key(self):
""" The routing key
:return: The routing key
:rtype: int
"""
return self._routing_entry_key
@property
def mask(self):
""" The routing mask
:return: The routing mask
:rtype: int
"""
return self._mask
@property
def processor_ids(self):
""" The destination processor IDs
:return: An iterable of processor IDs
:rtype: iterable(int)
"""
if self._processor_ids is None:
self._processor_ids, self._link_ids = self._calc_routing_ids()
return self._processor_ids
@property
def link_ids(self):
""" The destination link IDs
:return: An iterable of link IDs
:rtype: iterable(int)
"""
if self._link_ids is None:
self._processor_ids, self._link_ids = self._calc_routing_ids()
return self._link_ids
@property
def defaultable(self):
""" Whether this entry is a defaultable entry
:return: the bool that represents if a entry is defaultable or not
:rtype: bool
"""
return self._defaultable
@property
def spinnaker_route(self):
return self._spinnaker_route
[docs] def merge(self, other_entry):
""" Merges together two multicast routing entries. The entry to merge\
must have the same key and mask. The merge will join the\
processor IDs and link IDs from both the entries. This could be\
used to add a new destination to an existing route in a\
routing table. It is also possible to use the add (`+`) operator\
or the or (`|`) operator with the same effect.
:param other_entry: The multicast entry to merge with this entry
:type other_entry: :py:class:`~spinn_machine.MulticastRoutingEntry`
:return: A new multicast routing entry with merged destinations
:rtype: :py:class:`~spinn_machine.MulticastRoutingEntry`
:raise spinn_machine.exceptions.SpinnMachineInvalidParameterException:\
If the key and mask of the other entry do not match
"""
if other_entry.routing_entry_key != self.routing_entry_key:
raise SpinnMachineInvalidParameterException(
"other_entry.key", hex(other_entry.routing_entry_key),
"The key does not match {}".format(
hex(self.routing_entry_key)))
if other_entry.mask != self.mask:
raise SpinnMachineInvalidParameterException(
"other_entry.mask", hex(other_entry.mask),
"The mask does not match {}".format(hex(self.mask)))
defaultable = self._defaultable
if self._defaultable != other_entry.defaultable:
defaultable = False
new_entry = MulticastRoutingEntry(
self.routing_entry_key, self.mask,
self._processor_ids.union(other_entry.processor_ids),
self._link_ids.union(other_entry.link_ids), defaultable)
return new_entry
def __add__(self, other_entry):
""" Allows overloading of `+` to merge two entries together.\
See :py:meth:`merge`
"""
return self.merge(other_entry)
def __or__(self, other_entry):
""" Allows overloading of `|` to merge two entries together.\
See :py:meth:`merge`
"""
return self.merge(other_entry)
def __eq__(self, other_entry):
if not isinstance(other_entry, MulticastRoutingEntry):
return False
if self.routing_entry_key != other_entry.routing_entry_key:
return False
if self.mask != other_entry.mask:
return False
if self._spinnaker_route != other_entry._spinnaker_route:
return False
return (self._defaultable == other_entry.defaultable)
def __ne__(self, other):
return not self.__eq__(other)
def __repr__(self):
return "{}:{}:{}:{{{}}}:{{{}}}".format(
self._routing_entry_key, self._mask, self._defaultable,
", ".join(map(str, self.processor_ids)),
", ".join(map(str, self.link_ids)))
def __str__(self):
return self.__repr__()
def __getstate__(self):
return dict(
(slot, getattr(self, slot))
for slot in self.__slots__
if hasattr(self, slot)
)
def __setstate__(self, state):
for slot, value in state.items():
setattr(self, slot, value)
def _calc_spinnaker_route(self):
""" Convert a routing table entry represented in software to a\
binary routing table entry usable on the machine
:rtype: int
"""
route_entry = 0
for processor_id in self.processor_ids:
route_entry |= (1 << (Router.MAX_LINKS_PER_ROUTER + processor_id))
for link_id in self.link_ids:
route_entry |= (1 << link_id)
return route_entry
def _calc_routing_ids(self):
""" Convert a binary routing table entry usable on the machine to \
lists of route IDs usable in a routing table entry represented in \
software.
:rtype: tuple(list(int), list(int))
"""
processor_ids = [pi for pi in range(0, Router.MAX_CORES_PER_ROUTER)
if self._spinnaker_route & 1 <<
(Router.MAX_LINKS_PER_ROUTER + pi)]
link_ids = [li for li in range(0, Router.MAX_LINKS_PER_ROUTER)
if self._spinnaker_route & 1 << li]
return processor_ids, link_ids