# Source code for spinn_front_end_common.interface.simulation.simulation_utilities

# Copyright (c) 2017-2019 The University of Manchester
#
# This program is free software: you can redistribute it and/or modify
# 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 os
from pacman.utilities.utility_calls import md5
from spinn_front_end_common.utilities.constants import SDP_PORTS
from spinn_front_end_common.utilities.globals_variables import (
machine_time_step, time_scale_factor)

""" Get data to be written to the simulation header

:param str binary_file_name: The name of the binary of the application
:return: An array of values to be written as the simulation header
:rtype: list(int)
"""
# Get first 32-bits of the md5 hash of the application name
application_name_hash = md5(os.path.splitext(binary_file_name)[0])[:8]

# Write this to the system region (to be picked up by the simulation):
data = list()
data.append(int(application_name_hash, 16))
data.append(machine_time_step() * time_scale_factor())

# add SDP port number for receiving synchronisations and new run times
data.append(SDP_PORTS.RUNNING_COMMAND_SDP_PORT.value)

return data

""" Get data to be written to the simulation header

:param str binary_file_name: The name of the binary of the application
:return: An array of values to be written as the simulation header
:rtype: list(int)
"""
# Get first 32-bits of the md5 hash of the application name
application_name_hash = md5(os.path.splitext(binary_file_name)[0])[:8]

# Write this to the system region (to be picked up by the simulation):
data = list()
data.append(int(application_name_hash, 16))
data.append(0)

# add SDP port number for receiving synchronisations and new run times
data.append(SDP_PORTS.RUNNING_COMMAND_SDP_PORT.value)

return data