Source code for pacman.model.routing_info.app_vertex_routing_info

# 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 __future__ import annotations
import logging
import math
from typing import Iterable, List, Tuple, TYPE_CHECKING

from spinn_utilities.log import FormatAdapter
from spinn_utilities.overrides import overrides

from spinn_machine import MulticastRoutingEntry, RoutingEntry

from .vertex_routing_info import VertexRoutingInfo

if TYPE_CHECKING:
    from pacman.model.graphs.application import ApplicationVertex
    from pacman.model.routing_info import BaseKeyAndMask
    from .machine_vertex_routing_info import MachineVertexRoutingInfo

logger = FormatAdapter(logging.getLogger(__name__))

# pylint: disable=abstract-method


class AppVertexRoutingInfo(VertexRoutingInfo):
    """
    Routing information for an application vertex.
    """

    __slots__ = (
        "__app_vertex",
        "__machine_mask",
        "__max_machine_index")

    def __init__(
            self, key_and_mask: BaseKeyAndMask, partition_id: str,
            app_vertex: ApplicationVertex, max_machine_index: int,
            machine_mask: int):
        """
        :param key_and_mask:
        :param partition_id:
        :param app_vertex:
        :param max_machine_index:
        :param machine_mask:
        """
        super().__init__(key_and_mask, partition_id)
        self.__app_vertex = app_vertex
        self.__machine_mask = machine_mask
        self.__max_machine_index = max_machine_index



    def merge_machine_entries(self, entries: List[Tuple[
            RoutingEntry,
            MachineVertexRoutingInfo]]) -> Iterable[MulticastRoutingEntry]:
        """
        Merge the machine entries.

        :param entries:
            The entries to merge
        :returns: The routing info in the merged/ multicast format.
        :raises PacmanValueError: If the masks are not shiftable
        """
        n_entries = len(entries)
        (_, last_r_info) = entries[-1]
        is_last = last_r_info.index == self.__max_machine_index
        i = 0
        while i < n_entries:
            # The maximum number of next entries
            (entry, r_info) = entries[i]
            next_entries = self.__n_sequential_entries(r_info.index, n_entries)

            # If that is OK, we can just use them
            if next_entries <= (n_entries - i) or is_last:
                mask = self.__group_mask(next_entries)
                yield MulticastRoutingEntry(r_info.key, mask, entry)
                i += next_entries

            # Otherwise, we have to break down into powers of two
            else:
                entries_to_go = n_entries - i
                while entries_to_go > 0:
                    next_entries = 2 ** int(math.log2(entries_to_go))
                    mask = self.__group_mask(next_entries)
                    (entry, r_info) = entries[i]
                    yield MulticastRoutingEntry(r_info.key, mask, entry)
                    entries_to_go -= next_entries
                    i += next_entries


    def __group_mask(self, n_entries: int) -> int:
        return self.machine_mask - ((n_entries - 1) << self.machine_shift)

    def __n_sequential_entries(self, i: int, n_entries: int) -> int:
        # This finds the maximum number of entries that can be joined following
        # the starting entry index.  This is calculated by finding how many
        # zero bits are in the least significant position in the index.  These
        # can then be masked out to merge entries.
        # Works because -v == not v + 1
        if i > 0:
            return i & -i
        return 2 ** int(math.ceil(math.log2(n_entries)))

    @property
    @overrides(VertexRoutingInfo.vertex)
    def vertex(self) -> ApplicationVertex:
        return self.__app_vertex

    @property
    @overrides(VertexRoutingInfo.app_vertex)
    def app_vertex(self) -> ApplicationVertex:
        return self.__app_vertex

    @property
    def machine_mask(self) -> int:
        """
        The mask that covers a specific machine vertex.
       """
        return self.__machine_mask

    @property
    @overrides(VertexRoutingInfo.app_mask)
    def app_mask(self) -> int:
        return self.mask