SpiNNFrontEndCommon 7.2.2
Common support code for user-facing front end systems.
|
Simulation Functions Header File. More...
Go to the source code of this file.
Data Structures | |
struct | simulation_config |
the position and human readable terms for each element from the region containing the timing details. More... | |
struct | simulation_provenance |
elements that are always grabbed for provenance if possible when requested More... | |
Macros | |
#define | MAX_DMA_CALLBACK_TAG 16 |
Typedefs | |
typedef void(* | prov_callback_t) (address_t) |
the definition of the callback used by provenance data functions | |
typedef void(* | resume_callback_t) (void) |
the definition of the callback used by pause and resume | |
typedef void(* | exit_callback_t) (void) |
typedef resume_callback_t | start_callback_t |
the definition of the callback used to call a function once at start | |
Enumerations | |
enum | simulation_commands { CMD_STOP = 6 , CMD_RUNTIME = 7 , PROVENANCE_DATA_GATHERING = 8 , IOBUF_CLEAR = 9 } |
the commands that the simulation control protocol may send More... | |
Functions | |
bool | simulation_initialise (address_t address, uint32_t expected_application_magic_number, uint32_t *timer_period, uint32_t *simulation_ticks_pointer, uint32_t *infinite_run_pointer, uint32_t *time_pointer, int sdp_packet_callback_priority, int dma_transfer_complete_priority) |
initialises the simulation interface which involves: | |
static bool | simulation_steps_initialise (address_t address, uint32_t expected_application_magic_number, uint32_t *simulation_steps_pointer, uint32_t *infinite_steps_pointer, uint32_t *step_pointer, int sdp_packet_callback_priority, int dma_transfer_complete_priority) |
initialises the simulation interface for step-based simulation, which involves: | |
void | simulation_set_provenance_data_address (address_t provenance_data_address) |
Set the address of the data region where provenance data is to be stored. | |
void | simulation_set_provenance_function (prov_callback_t provenance_function, address_t provenance_data_address) |
Set an additional callback function to store extra provenance data. | |
void | simulation_set_exit_function (exit_callback_t exit_function) |
Set an additional function to call before exiting the binary when running without a fixed duration of execution. | |
void | simulation_set_start_function (start_callback_t start_function) |
Set an additional function to call before starting the binary. | |
void | simulation_handle_pause_resume (resume_callback_t callback) |
cleans up the house keeping, falls into a sync state and handles the resetting up of states as required to resume. Note that following this function, the code should call simulation_ready_to_read (see later). | |
void | simulation_exit (void) |
a helper method for people not using the auto pause and resume functionality | |
void | simulation_run (void) |
Starts the simulation running, returning when it is complete,. | |
void | simulation_ready_to_read (void) |
Indicates that all data has been written and the core is going idle, so any data can now be read. | |
bool | simulation_sdp_callback_on (uint sdp_port, callback_t sdp_callback) |
Registers an additional SDP callback on a given SDP port. This is required when using simulation_register_sdp_callback, as this will register its own SDP handler. | |
void | simulation_sdp_callback_off (uint sdp_port) |
disables SDP callbacks on the given port | |
bool | simulation_dma_transfer_done_callback_on (uint tag, callback_t callback) |
registers a DMA transfer callback to the simulation system | |
void | simulation_dma_transfer_done_callback_off (uint tag) |
turns off a registered callback for a given DMA transfer done tag | |
void | simulation_set_uses_timer (bool sim_uses_timer) |
set whether the simulation uses the timer. By default it will be assumed that simulations use the timer unless this function is called. | |
void | simulation_set_sync_steps (uint32_t n_steps) |
sets the simulation to enter a synchronisation barrier repeatedly during the simulation. The synchronisation message must be sent from the host. Note simulation_is_finished() must be used each timestep to cause the pause to happen. | |
bool | simulation_is_finished (void) |
determine if the simulation is finished. Will also pause the simulation for resynchronisation if requested (see simulation_set_sync_steps). | |
Simulation Functions Header File.
Specifies functions that are used to get simulation information and start simulations.
Definition in file simulation.h.
struct simulation_config |
struct simulation_provenance |
elements that are always grabbed for provenance if possible when requested
Definition at line 47 of file simulation.h.
Data Fields | ||
---|---|---|
uint32_t | transmission_event_overflow | |
uint32_t | callback_queue_overloads | |
uint32_t | dma_queue_overloads | |
uint32_t | user_queue_overloads | |
uint32_t | timer_tic_has_overrun | |
uint32_t | max_num_timer_tic_overrun | |
uint32_t | provenance_data_elements[] |
#define MAX_DMA_CALLBACK_TAG 16 |
constant for how many DMA IDs you can use (caps the values of the tags as well)
Definition at line 35 of file simulation.h.
the definition of the callback used by provenance data functions
Definition at line 70 of file simulation.h.
the definition of the callback used by pause and resume
Definition at line 73 of file simulation.h.
the definition of the callback used by pause and resume when exit command is sent and models want to do cleaning up
Definition at line 77 of file simulation.h.
the definition of the callback used to call a function once at start
Definition at line 80 of file simulation.h.
the commands that the simulation control protocol may send
Definition at line 58 of file simulation.h.
bool simulation_initialise | ( | address_t | address, |
uint32_t | expected_application_magic_number, | ||
uint32_t * | timer_period, | ||
uint32_t * | simulation_ticks_pointer, | ||
uint32_t * | infinite_run_pointer, | ||
uint32_t * | time_pointer, | ||
int | sdp_packet_callback_priority, | ||
int | dma_transfer_complete_priority | ||
) |
initialises the simulation interface which involves:
[in] | address | The address of the region |
[in] | expected_application_magic_number | The expected value of the magic number that checks if the data was meant for this code |
[out] | timer_period | Pointer to an int to receive the timer period, in microseconds |
[in] | simulation_ticks_pointer | Pointer to the number of simulation ticks, to allow this to be updated when requested via SDP |
[in] | infinite_run_pointer | Pointer to the infinite run flag, to allow this to be updated when requested via SDP |
[in] | time_pointer | Pointer to the current time, to allow this to be updated when requested via SDP |
[in] | sdp_packet_callback_priority | The priority to use for the SDP packet reception |
[in] | dma_transfer_complete_priority | The priority to use for the DMA transfer complete callbacks |
Definition at line 343 of file simulation.c.
|
inlinestatic |
initialises the simulation interface for step-based simulation, which involves:
[in] | address | The address of the region |
[in] | expected_application_magic_number | The expected value of the magic number that checks if the data was meant for this code |
[in] | simulation_steps_pointer | Pointer to the number of simulation steps, to allow this to be updated when requested via SDP |
[in] | infinite_steps_pointer | Pointer to the infinite steps flag, to allow this to be updated when requested via SDP |
[in] | step_pointer | Pointer to the current step, to allow this to be updated when requested via SDP |
[in] | sdp_packet_callback_priority | The priority to use for the SDP packet reception |
[in] | dma_transfer_complete_priority | The priority to use for the DMA transfer complete callbacks or <= -2 to disable |
Definition at line 137 of file simulation.h.
Set the address of the data region where provenance data is to be stored.
[in] | provenance_data_address | the address where provenance data should be stored |
Definition at line 387 of file simulation.c.
void simulation_set_provenance_function | ( | prov_callback_t | provenance_function, |
address_t | provenance_data_address | ||
) |
Set an additional callback function to store extra provenance data.
[in] | provenance_function | function to call for extra provenance data |
[in] | provenance_data_address | the address where provenance data should be stored |
Definition at line 391 of file simulation.c.
void simulation_set_exit_function | ( | exit_callback_t | exit_function | ) |
Set an additional function to call before exiting the binary when running without a fixed duration of execution.
[in] | exit_function | function to call when the host tells the simulation to exit. Executed before API exit. |
Definition at line 398 of file simulation.c.
void simulation_set_start_function | ( | start_callback_t | start_function | ) |
Set an additional function to call before starting the binary.
[in] | start_function | function to call when the host tells the simulation to start. Executed before "synchronisation". |
Definition at line 402 of file simulation.c.
void simulation_handle_pause_resume | ( | resume_callback_t | callback | ) |
cleans up the house keeping, falls into a sync state and handles the resetting up of states as required to resume. Note that following this function, the code should call simulation_ready_to_read (see later).
[in] | callback | The function to call just before the simulation is resumed (to allow the resetting of the simulation) |
Definition at line 110 of file simulation.c.
a helper method for people not using the auto pause and resume functionality
a helper method for people not using the auto pause and resume functionality
Helper when not using the auto pause and resume functionality
Definition at line 124 of file simulation.c.
Starts the simulation running, returning when it is complete,.
Definition at line 105 of file simulation.c.
Indicates that all data has been written and the core is going idle, so any data can now be read.
Definition at line 128 of file simulation.c.
bool simulation_sdp_callback_on | ( | uint | sdp_port, |
callback_t | sdp_callback | ||
) |
Registers an additional SDP callback on a given SDP port. This is required when using simulation_register_sdp_callback, as this will register its own SDP handler.
[in] | sdp_port | The SDP port to use |
[in] | sdp_callback | The callback to call when a packet is received |
Definition at line 296 of file simulation.c.
disables SDP callbacks on the given port
[in] | sdp_port | The SDP port to disable callbacks for |
Definition at line 306 of file simulation.c.
bool simulation_dma_transfer_done_callback_on | ( | uint | tag, |
callback_t | callback | ||
) |
registers a DMA transfer callback to the simulation system
[in] | tag | the DMA transfer tag to register against |
[in] | callback | the callback to register for the given tag |
Definition at line 319 of file simulation.c.
turns off a registered callback for a given DMA transfer done tag
[in] | tag | the DMA transfer tag to de-register |
Definition at line 339 of file simulation.c.
set whether the simulation uses the timer. By default it will be assumed that simulations use the timer unless this function is called.
[in] | sim_uses_timer | Whether the simulation uses the timer (true) or not (false) |
Definition at line 406 of file simulation.c.
sets the simulation to enter a synchronisation barrier repeatedly during the simulation. The synchronisation message must be sent from the host. Note simulation_is_finished() must be used each timestep to cause the pause to happen.
[in] | n_steps | The number of steps of simulation between synchronisations |
Definition at line 410 of file simulation.c.
determine if the simulation is finished. Will also pause the simulation for resynchronisation if requested (see simulation_set_sync_steps).
Definition at line 417 of file simulation.c.