Source code for spinnman.messages.eieio.command_messages.host_data_read

# 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/>.

import struct
from spinnman.exceptions import (
    SpinnmanInvalidPacketException, SpinnmanInvalidParameterTypeException)
from .eieio_command_message import EIEIOCommandMessage
from .eieio_command_header import EIEIOCommandHeader
from spinnman.constants import EIEIO_COMMAND_IDS

_PATTERN_BB = struct.Struct("<BB")
_PATTERN_xxBBI = struct.Struct("<xxBBI")


[docs]class HostDataRead(EIEIOCommandMessage): """ Packet sent by the host computer to the SpiNNaker system in the\ context of the buffering output technique to signal that the host has\ completed reading data from the output buffer, and that such space can\ be considered free to use again """ __slots__ = [ "_acks", "_header"] def __init__( self, n_requests, sequence_no, channel, region_id, space_read): # pylint: disable=too-many-arguments if not isinstance(channel, list): channel = [channel] if not isinstance(region_id, list): region_id = [region_id] if not isinstance(space_read, list): space_read = [space_read] if len(channel) != n_requests or \ len(region_id) != n_requests or \ len(space_read) != n_requests: raise SpinnmanInvalidPacketException( "SpinnakerRequestReadData", "The format for a SpinnakerRequestReadData packet is " "invalid: {0:d} request(s), {1:d} space(s) read " "defined, {2:d} region(s) defined, {3:d} channel(s) " "defined".format( n_requests, len(space_read), len(region_id), len(channel))) super().__init__(EIEIOCommandHeader(EIEIO_COMMAND_IDS.HOST_DATA_READ)) self._header = _HostDataReadHeader(n_requests, sequence_no) self._acks = _HostDataReadAck(channel, region_id, space_read) @property def n_requests(self): return self._header.n_requests @property def sequence_no(self): return self._header.sequence_no
[docs] def channel(self, ack_id): return self._acks.channel(ack_id)
[docs] def region_id(self, ack_id): return self._acks.region_id(ack_id)
[docs] def space_read(self, ack_id): return self._acks.space_read(ack_id)
[docs] @staticmethod def get_min_packet_length(): return 8
[docs] @staticmethod def from_bytestring(command_header, data, offset): # @UnusedVariable n_requests, sequence_no = _PATTERN_BB.unpack_from(data, offset) offset += 2 n_requests &= 0x7 channel = list() region_id = list() space_read = list() for _ in range(n_requests): channel_ack, region_id_ack, space_read_ack = \ _PATTERN_xxBBI.unpack_from(data, offset) channel.append(channel_ack) region_id.append(region_id_ack) space_read.append(space_read_ack) offset += 8 return HostDataRead( n_requests, sequence_no, channel, region_id, space_read)
@property def bytestring(self): byte_string = super().bytestring n_requests = self.n_requests byte_string += _PATTERN_BB.pack(n_requests, self.sequence_no) for i in range(n_requests): byte_string += _PATTERN_xxBBI.pack( self.channel(i), self.region_id(i), self.space_read(i)) return byte_string
class _HostDataReadHeader(object): """ The HostDataRead contains itself on header with the number of requests\ and a sequence number """ __slots__ = [ "_n_requests", "_sequence_no"] def __init__(self, n_requests, sequence_no): self._n_requests = n_requests self._sequence_no = sequence_no @property def sequence_no(self): return self._sequence_no @property def n_requests(self): return self._n_requests class _HostDataReadAck(object): """ Contains a set of acks which refer to each of the channels read """ __slots__ = [ "_channel", "_region_id", "_space_read"] def __init__(self, channel, region_id, space_read): if not isinstance(channel, list): self._channel = [channel] else: self._channel = channel if not isinstance(region_id, list): self._region_id = [region_id] else: self._region_id = region_id if not isinstance(space_read, list): self._space_read = [space_read] else: self._space_read = space_read def channel(self, ack_id): if len(self._channel) > ack_id: return self._channel[ack_id] raise SpinnmanInvalidParameterTypeException( "request_id", "integer", "channel ack_id needs to be" "comprised between 0 and {0:d}; current value: {1:d}".format( len(self._channel) - 1, ack_id)) def region_id(self, ack_id): if len(self._region_id) > ack_id: return self._region_id[ack_id] raise SpinnmanInvalidParameterTypeException( "request_id", "integer", "region ID ack_id needs to be" "comprised between 0 and {0:d}; current value: {1:d}".format( len(self._region_id) - 1, ack_id)) def space_read(self, ack_id): if len(self._space_read) > ack_id: return self._space_read[ack_id] raise SpinnmanInvalidParameterTypeException( "request_id", "integer", "start address ack_id needs to be" "comprised between 0 and {0:d}; current value: {1:d}".format( len(self._space_read) - 1, ack_id))