Source code for spinn_front_end_common.interface.interface_functions.load_executable_images

# 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.
from spinn_utilities.progress_bar import ProgressBar
from spinnman.messages.scp.enums import Signal
from spinnman.model import ExecutableTargets
from spinnman.model.enums import CPUState
from spinn_front_end_common.data import FecDataView
from spinn_front_end_common.utilities.helpful_functions import (
    flood_fill_binary_to_spinnaker)
from spinn_front_end_common.utilities.utility_objs import ExecutableType
from spinnman.exceptions import SpiNNManCoresNotInStateException
from spinn_front_end_common.utilities.emergency_recovery import (
    emergency_recover_states_from_failure)

# 10 seconds is lots of time to wait for the application to become ready!
_APP_READY_TIMEOUT = 10.0


def load_app_images():
    """
    Go through the executable targets and load each binary to everywhere
    and then send a start request to the cores that actually use it.
    """
    __load_images(lambda ty: ty is not ExecutableType.SYSTEM,
                  "Loading executables onto the machine")


def load_sys_images():
    """
    Go through the executable targets and load each binary to everywhere
    and then send a start request to the cores that actually use it.
    """
    __load_images(lambda ty: ty is ExecutableType.SYSTEM,
                  "Loading system executables onto the machine")
    try:
        _, cores = filter_targets(lambda ty: ty is ExecutableType.SYSTEM)
        FecDataView.get_transceiver().wait_for_cores_to_be_in_state(
            cores.all_core_subsets, FecDataView.get_app_id(),
            [CPUState.RUNNING], timeout=10)
    except SpiNNManCoresNotInStateException as e:
        emergency_recover_states_from_failure()
        raise e


def __load_images(filt, label):
    """
    :param callable(ExecutableType,bool) filt:
    :param str label
    """
    # Compute what work is to be done here
    binaries, cores = filter_targets(filt)

    try:
        # ISSUE: Loading order may be non-constant on older Python
        progress = ProgressBar(cores.total_processors + 1, label)
        for binary in binaries:
            progress.update(flood_fill_binary_to_spinnaker(binary))

        __start_simulation(cores, FecDataView.get_app_id())
        progress.update()
        progress.end()
    except Exception as e:
        try:
            FecDataView.get_transceiver().stop_application(
                FecDataView.get_app_id())
        except Exception:  # pylint: disable=broad-except
            # Ignore this, this was just an attempt at recovery
            pass
        raise e


def filter_targets(filt):
    """
    :param ~spinnman.model.ExecutableTargets executable_targets:
    :param callable(ExecutableType,bool) filt:
    :rtype: tuple(list(str), ~spinnman.model.ExecutableTargets)
    """
    binaries = []
    cores = ExecutableTargets()
    targets = FecDataView.get_executable_targets()
    for exe_type in targets.executable_types_in_binary_set():
        if filt(exe_type):
            for aplx in targets.get_binaries_of_executable_type(exe_type):
                binaries.append(aplx)
                cores.add_subsets(
                    aplx, targets.get_cores_for_binary(aplx), exe_type)
    return binaries, cores


def __start_simulation(cores, app_id):
    """
    :param ~.ExecutableTargets cores:
        Possible subset of all ExecutableTargets to start
    :param int app_id:
    """
    txrx = FecDataView.get_transceiver()
    txrx.wait_for_cores_to_be_in_state(
        cores.all_core_subsets, app_id, [CPUState.READY],
        timeout=_APP_READY_TIMEOUT)
    txrx.send_signal(app_id, Signal.START)