from pacman.executor.injection_decorator import inject_items
from pacman.model.decorators import overrides
from pacman.model.graphs.machine import MachineVertex
from pacman.model.resources import CPUCyclesPerTickResource, DTCMResource
from pacman.model.resources import IPtagResource, ResourceContainer
from pacman.model.resources import SDRAMResource
from spinn_front_end_common.interface.provenance \
import ProvidesProvenanceDataFromMachineImpl
from spinn_front_end_common.interface.simulation.simulation_utilities \
import get_simulation_header_array
from spinn_front_end_common.abstract_models \
import AbstractGeneratesDataSpecification, AbstractHasAssociatedBinary, \
AbstractSupportsDatabaseInjection
from spinn_front_end_common.utilities.utility_objs \
import ProvenanceDataItem, ExecutableStartType
from spinn_front_end_common.utilities.constants \
import SYSTEM_BYTES_REQUIREMENT
from spinnman.messages.eieio import EIEIOType
from enum import Enum
import struct
[docs]class LivePacketGatherMachineVertex(
MachineVertex, ProvidesProvenanceDataFromMachineImpl,
AbstractGeneratesDataSpecification, AbstractHasAssociatedBinary,
AbstractSupportsDatabaseInjection):
_LIVE_DATA_GATHER_REGIONS = Enum(
value="LIVE_DATA_GATHER_REGIONS",
names=[('SYSTEM', 0),
('CONFIG', 1),
('PROVENANCE', 2)])
N_ADDITIONAL_PROVENANCE_ITEMS = 2
_CONFIG_SIZE = 48
_PROVENANCE_REGION_SIZE = 8
def __init__(
self, label, use_prefix=False, key_prefix=None, prefix_type=None,
message_type=EIEIOType.KEY_32_BIT, right_shift=0,
payload_as_time_stamps=True, use_payload_prefix=True,
payload_prefix=None, payload_right_shift=0,
number_of_packets_sent_per_time_step=0,
hostname=None, port=None, strip_sdp=None, board_address=None,
tag=None, constraints=None):
# inheritance
MachineVertex.__init__(self, label, constraints=constraints)
self._resources_required = ResourceContainer(
cpu_cycles=CPUCyclesPerTickResource(self.get_cpu_usage()),
dtcm=DTCMResource(self.get_dtcm_usage()),
sdram=SDRAMResource(self.get_sdram_usage()),
iptags=[IPtagResource(
ip_address=hostname, port=port,
strip_sdp=strip_sdp, tag=tag,
traffic_identifier="LPG_EVENT_STREAM")])
# app specific data items
self._use_prefix = use_prefix
self._key_prefix = key_prefix
self._prefix_type = prefix_type
self._message_type = message_type
self._right_shift = right_shift
self._payload_as_time_stamps = payload_as_time_stamps
self._use_payload_prefix = use_payload_prefix
self._payload_prefix = payload_prefix
self._payload_right_shift = payload_right_shift
self._number_of_packets_sent_per_time_step = \
number_of_packets_sent_per_time_step
@property
@overrides(ProvidesProvenanceDataFromMachineImpl._provenance_region_id)
def _provenance_region_id(self):
return self._LIVE_DATA_GATHER_REGIONS.PROVENANCE.value
@property
@overrides(ProvidesProvenanceDataFromMachineImpl._n_additional_data_items)
def _n_additional_data_items(self):
return self.N_ADDITIONAL_PROVENANCE_ITEMS
@property
@overrides(MachineVertex.resources_required)
def resources_required(self):
return self._resources_required
@property
@overrides(AbstractSupportsDatabaseInjection.is_in_injection_mode)
def is_in_injection_mode(self):
return True
[docs] @overrides(ProvidesProvenanceDataFromMachineImpl.
get_provenance_data_from_machine)
def get_provenance_data_from_machine(self, transceiver, placement):
""" Get provenance from the machine
:param transceiver: spinnman interface to the machine
:param placement: the location of this vertex on the machine
"""
provenance_data = self._read_provenance_data(transceiver, placement)
provenance_items = self._read_basic_provenance_items(
provenance_data, placement)
provenance_data = self._get_remaining_provenance_data_items(
provenance_data)
_, _, _, _, names = self._get_placement_details(placement)
provenance_items.append(ProvenanceDataItem(
self._add_name(names, "lost_packets_without_payload"),
provenance_data[0],
report=provenance_data[0] > 0,
message=(
"The live packet gatherer has lost {} packets which have "
"payloads during its execution. Try increasing the machine "
"time step or increasing the time scale factor. If you are "
"running in real time, try reducing the number of vertices "
"which are feeding this live packet gatherer".format(
provenance_data[0]))))
provenance_items.append(ProvenanceDataItem(
self._add_name(names, "lost_packets_with_payload"),
provenance_data[1],
report=provenance_data[1] > 0,
message=(
"The live packet gatherer has lost {} packets which do not "
"have payloads during its execution. Try increasing the "
"machine time step or increasing the time scale factor. If "
"you are running in real time, try reducing the number of "
"vertices which are feeding this live packet gatherer".format(
provenance_data[1]))))
return provenance_items
[docs] @overrides(AbstractHasAssociatedBinary.get_binary_file_name)
def get_binary_file_name(self):
return 'live_packet_gather.aplx'
[docs] @overrides(AbstractHasAssociatedBinary.get_binary_start_type)
def get_binary_start_type(self):
return ExecutableStartType.USES_SIMULATION_INTERFACE
[docs] @inject_items({
"machine_time_step": "MachineTimeStep",
"time_scale_factor": "TimeScaleFactor",
"tags": "MemoryTags"})
@overrides(
AbstractGeneratesDataSpecification.generate_data_specification,
additional_arguments={
"machine_time_step", "time_scale_factor", "tags"
})
def generate_data_specification(
self, spec, placement, machine_time_step, time_scale_factor,
tags):
spec.comment("\n*** Spec for LivePacketGather Instance ***\n\n")
# Construct the data images needed for the Neuron:
self._reserve_memory_regions(spec)
self._write_setup_info(spec, machine_time_step, time_scale_factor)
self._write_configuration_region(
spec, tags.get_ip_tags_for_vertex(self))
# End-of-Spec:
spec.end_specification()
def _reserve_memory_regions(self, spec):
""" Reserve SDRAM space for memory areas
"""
spec.comment("\nReserving memory space for data regions:\n\n")
# Reserve memory:
spec.reserve_memory_region(
region=(
LivePacketGatherMachineVertex.
_LIVE_DATA_GATHER_REGIONS.SYSTEM.value),
size=SYSTEM_BYTES_REQUIREMENT,
label='system')
spec.reserve_memory_region(
region=(
LivePacketGatherMachineVertex.
_LIVE_DATA_GATHER_REGIONS.CONFIG.value),
size=self._CONFIG_SIZE, label='config')
self.reserve_provenance_data_region(spec)
def _write_configuration_region(self, spec, iptags):
""" writes the configuration region to the spec
:param spec: the spec object for the dsg
:type spec: \
:py:class:`spinn_storage_handlers.FileDataWriter`
:param iptags: The set of ip tags assigned to the object
:type iptags: iterable of :py:class:`spinn_machine.tags.IPTag`
:raise DataSpecificationException: when something goes wrong with the\
dsg generation
"""
spec.switch_write_focus(
region=(
LivePacketGatherMachineVertex.
_LIVE_DATA_GATHER_REGIONS.CONFIG.value))
# has prefix
if self._use_prefix:
spec.write_value(data=1)
else:
spec.write_value(data=0)
# prefix
if self._key_prefix is not None:
spec.write_value(data=self._key_prefix)
else:
spec.write_value(data=0)
# prefix type
if self._prefix_type is not None:
spec.write_value(data=self._prefix_type.value)
else:
spec.write_value(data=0)
# packet type
spec.write_value(data=self._message_type.value)
# right shift
spec.write_value(data=self._right_shift)
# payload as time stamp
if self._payload_as_time_stamps:
spec.write_value(data=1)
else:
spec.write_value(data=0)
# payload has prefix
if self._use_payload_prefix:
spec.write_value(data=1)
else:
spec.write_value(data=0)
# payload prefix
if self._payload_prefix is not None:
spec.write_value(data=self._payload_prefix)
else:
spec.write_value(data=0)
# right shift
spec.write_value(data=self._payload_right_shift)
# SDP tag
iptag = iter(iptags).next()
spec.write_value(data=iptag.tag)
spec.write_value(struct.unpack("<H", struct.pack(
"<BB", iptag.destination_y, iptag.destination_x))[0])
# number of packets to send per time stamp
spec.write_value(data=self._number_of_packets_sent_per_time_step)
def _write_setup_info(self, spec, machine_time_step, time_scale_factor):
""" Write basic info to the system region
"""
# Write this to the system region (to be picked up by the simulation):
spec.switch_write_focus(
region=(LivePacketGatherMachineVertex.
_LIVE_DATA_GATHER_REGIONS.SYSTEM.value))
spec.write_array(get_simulation_header_array(
self.get_binary_file_name(), machine_time_step, time_scale_factor))
[docs] @staticmethod
def get_cpu_usage():
""" Get the CPU used by this vertex
:return: 0
:rtype: int
"""
return 0
[docs] @staticmethod
def get_sdram_usage():
""" Get the SDRAM used by this vertex
"""
return (
SYSTEM_BYTES_REQUIREMENT +
LivePacketGatherMachineVertex._CONFIG_SIZE +
LivePacketGatherMachineVertex.get_provenance_data_size(
LivePacketGatherMachineVertex.N_ADDITIONAL_PROVENANCE_ITEMS))
[docs] @staticmethod
def get_dtcm_usage():
""" Get the DTCM used by this vertex
"""
return LivePacketGatherMachineVertex._CONFIG_SIZE