Source code for spinn_front_end_common.utilities.report_functions.fixed_route_from_machine_report

# Copyright (c) 2017 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 os
from spinn_utilities.progress_bar import ProgressBar
from spinn_front_end_common.data import FecDataView


def fixed_route_from_machine_report():
    """
    Writes the fixed routes from the machine.
    """
    file_name = os.path.join(
        FecDataView.get_run_dir_path(), "fixed_route_routers")
    transceiver = FecDataView.get_transceiver()
    machine = FecDataView.get_machine()

    progress = ProgressBar(machine.n_chips, "Writing fixed route report")

    app_id = FecDataView.get_app_id()
    with open(file_name, "w", encoding="utf-8") as f:
        f.write(" x    y       route         [cores][links]\n")
        for chip in progress.over(machine.chips):
            fixed_route = transceiver.read_fixed_route(
                chip.x, chip.y, app_id)
            f.write("{: <3s}:{: <3s} contains route {: <10s} {}\n".format(
                str(chip.x), str(chip.y),
                _reduce_route_value(
                    fixed_route.processor_ids, fixed_route.link_ids),
                _expand_route_value(
                    fixed_route.processor_ids, fixed_route.link_ids)))


def _reduce_route_value(processors_ids, link_ids):
    value = 0
    for link in link_ids:
        value += 1 << link
    for processor in processors_ids:
        value += 1 << (processor + 6)
    return str(value)


def _expand_route_value(processors_ids, link_ids):
    """
    Convert a 32-bit route word into a string which lists the target
    cores and links.
    """

    # Convert processor targets to readable values:
    route_string = "["
    separator = ""
    for processor in processors_ids:
        route_string += separator + str(processor)
        separator = ", "

    route_string += "] ["

    # Convert link targets to readable values:
    link_labels = {0: 'E', 1: 'NE', 2: 'N', 3: 'W', 4: 'SW', 5: 'S'}

    separator = ""
    for link in link_ids:
        route_string += separator + link_labels[link]
        separator = ", "
    route_string += "]"
    return route_string