compressor.h File Reference

SpiNNaker routing table minimisation. More...

#include <debug.h>
#include "ordered_covering_includes/ordered_covering.h"
#include "remove_default_routes.h"
#include "../common/routing_table.h"

Go to the source code of this file.

Functions
bool	run_compressor (int compress_as_much_as_possible, bool *failed_by_malloc, volatile bool *stop_compressing)
	The callback for setting off the router compressor.

Detailed Description

SpiNNaker routing table minimisation.

Minimises a routing table loaded into SDRAM and load the minimised table into the router using the specified application ID.

the exit code is stored in the user0 register

The memory address with tag "1" is expected contain the following struct (entry_t is defined in routing_table.h but is described below).

Definition in file compressor.h.

Function Documentation

run_compressor()

bool run_compressor	(	int	compress_as_much_as_possible,
		bool *	failed_by_malloc,
		volatile bool *	stop_compressing
	)

The callback for setting off the router compressor.

Parameters

[in]	compress_as_much_as_possible	Only compress to normal routing table length
[out]	failed_by_malloc	Flag stating that it failed due to malloc
[in]	stop_compressing	Variable saying if the compressor should stop and return false; set by interrupt DURING the run of this method!

Returns

Whether compression succeeded

Definition at line 46 of file compressor.h.