# Copyright (c) 2022 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.
"""
API of the client for the Spalloc web service.
"""
import struct
from typing import Dict, Iterable, Tuple, Optional
from spinn_utilities.abstract_base import AbstractBase, abstractmethod
from .spalloc_machine import SpallocMachine
from .spalloc_job import SpallocJob
_ONE_SHORT = struct.Struct("<H")
_TWO_SHORTS = struct.Struct("<2H")
_TWO_SKIP: bytes = b'\0\0'
_NUM_UPDATE_TAG_TRIES = 3
_UPDATE_TAG_TIMEOUT = 1.0
class AbstractSpallocClient(object, metaclass=AbstractBase):
"""
The API exported by the Spalloc Client.
"""
__slots__ = ()
[docs]
@abstractmethod
def list_machines(self) -> Dict[str, SpallocMachine]:
"""
Get the machines supported by the server.
:return:
Mapping from machine names to handles for working with a machine.
:rtype: dict(str,SpallocMachine)
"""
raise NotImplementedError
[docs]
@abstractmethod
def list_jobs(self, deleted: bool = False) -> Iterable[SpallocJob]:
"""
Get the jobs known to the server.
:param bool deleted: Whether to include deleted jobs.
:return: The jobs known to the server.
:rtype: ~typing.Iterable(SpallocJob)
"""
raise NotImplementedError
[docs]
@abstractmethod
def create_job(
self, num_boards: int = 1, machine_name: Optional[str] = None,
keepalive: int = 45) -> SpallocJob:
"""
Create a job with a specified number of boards.
:param int num_boards:
How many boards to ask for (defaults to 1)
:param str machine_name:
Which machine to run on? If omitted, the service's machine tagged
with ``default`` will be used.
:param int keepalive:
After how many seconds of no activity should a job become eligible
for automatic pruning?
:return: A handle for monitoring and interacting with the job.
:rtype: SpallocJob
"""
raise NotImplementedError
[docs]
@abstractmethod
def create_job_rect(
self, width: int, height: int, machine_name: Optional[str] = None,
keepalive: int = 45) -> SpallocJob:
"""
Create a job with a rectangle of boards.
:param int width:
The width of rectangle to request
:param int height:
The height of rectangle to request
:param str machine_name:
Which machine to run on? If omitted, the service's machine tagged
with ``default`` will be used.
:param int keepalive:
After how many seconds of no activity should a job become eligible
for automatic pruning?
:return: A handle for monitoring and interacting with the job.
:rtype: SpallocJob
"""
raise NotImplementedError
[docs]
@abstractmethod
def create_job_board(
self, triad: Optional[Tuple[int, int, int]] = None,
physical: Optional[Tuple[int, int, int]] = None,
ip_address: Optional[str] = None,
machine_name: Optional[str] = None,
keepalive: int = 45) -> SpallocJob:
"""
Create a job with a specific board. At least one of ``triad``,
``physical`` and ``ip_address`` must be not ``None``.
:param tuple(int,int,int) triad:
The logical coordinate of the board to request
:param tuple(int,int,int) physical:
The physical coordinate of the board to request
:param str ip_address:
The IP address of the board to request
:param str machine_name:
Which machine to run on? If omitted, the service's machine tagged
with ``default`` will be used.
:param int keepalive:
After how many seconds of no activity should a job become eligible
for automatic pruning?
:return: A handle for monitoring and interacting with the job.
:rtype: SpallocJob
"""
raise NotImplementedError
[docs]
@abstractmethod
def create_job_rect_at_board(
self, width: int, height: int,
triad: Optional[Tuple[int, int, int]] = None,
physical: Optional[Tuple[int, int, int]] = None,
ip_address: Optional[str] = None,
machine_name: Optional[str] = None, keepalive: int = 45,
max_dead_boards: int = 0) -> SpallocJob:
"""
Create a job with a rectangle of boards starting at a specific board.
At least one of ``triad``, ``physical`` and ``ip_address`` must be not
``None``.
:param int width:
The width of rectangle to request
:param int height:
The height of rectangle to request
:param tuple(int,int,int) triad:
The logical coordinate of the board to request
:param tuple(int,int,int) physical:
The physical coordinate of the board to request
:param str ip_address:
The IP address of the board to request
:param str machine_name:
Which machine to run on? If omitted, the service's machine tagged
with ``default`` will be used.
:param int keepalive:
After how many seconds of no activity should a job become eligible
for automatic pruning?
:param int max_dead_boards:
How many dead boards can be included.
:return: A handle for monitoring and interacting with the job.
:rtype: SpallocJob
"""
raise NotImplementedError