Functions for routing MSU messages between MSUs. More...

#include "dfg.h"
#include "routing.h"
#include "logging.h"
#include "runtime_dfg.h"
#include "local_msu.h"
#include "unused_def.h"
#include <stdlib.h>
#include <limits.h>
#include <pthread.h>

Classes
struct	routing_table
	The core of the routing system, the routing table lists a route's destinations. More...

Macros
#define	MAX_DESTINATIONS 128
	The maximum number of destinations a route can have. More...

#define	MAX_ROUTE_ID 10000
	The maximum ID that may be assigned to a route. More...

#define	print_routing_table(t)

#define	MAX_MSU_Q_SIZE INT_MAX

Functions
static int	read_lock (struct routing_table *table)
	Simple wrapper to lock a routing table for reading. More...

static int	write_lock (struct routing_table *table)
	Simple wrapper to lock a routing table for writing. More...

static int	unlock (struct routing_table *table)
	Simple wrapper to unlock a locked routing table. More...

static int	find_value_index (struct routing_table *table, uint32_t value)
	Searches through the entries in the routing table, returning the index of the first key which surpasses the provided value. More...

static int	find_id_index (struct routing_table *table, int msu_id)
	Finds the index of the entry in the routing table with the destination that has the provided msu id. More...

static int	rm_routing_table_entry (struct routing_table *table, int msu_id)
	Removes a destination from the routing table. More...

int	add_routing_table_entry (struct routing_table table, struct msu_endpoint dest, uint32_t key)
	Adds a (copy of the) destination to a routing table. More...

static int	alter_routing_table_entry (struct routing_table *table, int msu_id, uint32_t new_key)
	Modifies the key associated with an existing destination in a routing table. More...

struct routing_table *	init_routing_table (int route_id, int type_id)
	Initializes and returns a new routing table. More...

static struct routing_table *	get_routing_table (int route_id)
	Gets the routing table associated with the route_id. More...

int	init_route (int route_id, int type_id)
	Initializes a new route with the given route_id and type_id. More...

int	get_shortest_queue_endpoint (struct routing_table table, uint32_t key, struct msu_endpoint endpoint)
	Gets the local endpoint from a route with the shortest queue length. More...

int	get_endpoint_by_index (struct routing_table table, int index, struct msu_endpoint endpoint)
	Gets endpoint witih given index in route set. More...

int	get_endpoint_by_id (struct routing_table table, int msu_id, struct msu_endpoint endpoint)
	Gets endpoint with the given MSU ID in the provided route. More...

int	get_endpoints_by_runtime_id (struct routing_table table, int runtime_id, struct msu_endpoint endpoints, int n_endpoints)
	Gets all of the endpoints in the provided routing table with the right runtime id. More...

int	get_n_endpoints (struct routing_table *table)

int	get_route_endpoint (struct routing_table table, uint32_t key, struct msu_endpoint endpoint)
	Gets the endpoint associated with the given key in the provided route. More...

struct routing_table *	get_type_from_route_set (struct route_set *set, int type_id)
	Gets the route from the provided array of routes which has the correct type ID. More...

int	add_route_endpoint (int route_id, struct msu_endpoint endpoint, uint32_t key)
	Adds an endpoint to the route with the given ID. More...

int	remove_route_endpoint (int route_id, int msu_id)
	Removes destination from route with given ID. More...

int	modify_route_endpoint (int route_id, int msu_id, uint32_t new_key)
	Modifies key associated with MSU in route. More...

int	add_route_to_set (struct route_set *set, int route_id)
	Adds a route to a set of routes. More...

int	rm_route_from_set (struct route_set *set, int route_id)
	Removes a route from a set of routes. More...

int	init_msu_endpoint (int msu_id, int runtime_id, struct msu_endpoint *endpoint)
	Initializes an endpoint structure to point to the relevant msu. More...

Variables
static struct routing_table *	all_routes [10000]
	All of the created routes in this runtime. More...

Detailed Description

Functions for routing MSU messages between MSUs.

Definition in file routing.c.

Macro Definition Documentation

#define MAX_DESTINATIONS 128

The maximum number of destinations a route can have.

Definition at line 37 of file routing.c.

#define MAX_MSU_Q_SIZE INT_MAX

Definition at line 297 of file routing.c.

#define MAX_ROUTE_ID 10000

The maximum ID that may be assigned to a route.

Definition at line 40 of file routing.c.

#define print_routing_table ( t )

Definition at line 68 of file routing.c.

Function Documentation

int add_route_endpoint	(	int	route_id,
		struct msu_endpoint	endpoint,
		uint32_t	key
	)

Adds an endpoint to the route with the given ID.

Parameters

route_id	ID of the route to which the endpoint is added
endpoint	the endpoint to be added
key	Key to associate with endpoint

Returns: 0 on success, -1 on error

Definition at line 409 of file routing.c.

int add_route_to_set	(	struct route_set *	set,
		int	route_id
	)

Adds a route to a set of routes.

Parameters

route_set	Set to add the route to
route_id	ID of the route to add

Returns: 0 on success, -1 on error

Definition at line 450 of file routing.c.

int add_routing_table_entry	(	struct routing_table *	table,
		struct msu_endpoint *	dest,
		uint32_t	key
	)

Adds a (copy of the) destination to a routing table.

Note: Kept non-static but excluded from header so it can be used for testing

Parameters

table	The table to which the destination is to be added
destination	The endpoint to add (a copy is made)
key	The key to be associated with this destination

Returns: 0 on success, -1 on error

Definition at line 174 of file routing.c.

static int alter_routing_table_entry	(	struct routing_table *	table,
		int	msu_id,
		uint32_t	new_key
	)

static

Modifies the key associated with an existing destination in a routing table.

Parameters

table	The routing table to modify
msu_id	The ID of the destination to modify
new_key	The new key that should be associated with this destination

Returns: 0 on success, -1 on error

Definition at line 209 of file routing.c.

static int find_id_index	(	struct routing_table *	table,
		int	msu_id
	)

static

Finds the index of the entry in the routing table with the destination that has the provided msu id.

Parameters

table	the table to search
msu_id	the ID to search for in the table

Returns: the index of the destination with the appropriate msu id

Definition at line 130 of file routing.c.

static int find_value_index	(	struct routing_table *	table,
		uint32_t	value
	)

static

Searches through the entries in the routing table, returning the index of the first key which surpasses the provided value.

Parameters

table	the table to search
value	the value to use in the search

Returns: the index of the destination with the appropriate value

Definition at line 110 of file routing.c.

int get_endpoint_by_id	(	struct routing_table *	table,
		int	msu_id,
		struct msu_endpoint *	endpoint
	)

Gets endpoint with the given MSU ID in the provided route.

Parameters

table	Route to get the endpoint from
msu_id	MSU ID to search for in the route set
endpoint	Points to appropriate endpoint on success

Returns: 0 on success, -1 on error

Definition at line 344 of file routing.c.

int get_endpoint_by_index	(	struct routing_table *	table,
		int	index,
		struct msu_endpoint *	endpoint
	)

Gets endpoint witih given index in route set.

Parameters

table	the route to get the endpoint from
index	Index of the endpoint to retrieve
endpoint	Points to appropriate endpoint on success

Returns: 0 on success, -1 on error

Definition at line 332 of file routing.c.

int get_endpoints_by_runtime_id	(	struct routing_table *	table,
		int	runtime_id,
		struct msu_endpoint *	endpoints,
		int	n_endpoints
	)

Gets all of the endpoints in the provided routing table with the right runtime id.

Parameters

table	The table to search for endpoints
runtime_id	The ID of the runtime on which endpoints must reside
endpoints	An array of endpoints to be filled.
n_endpoints	The amount of endpoints allocated in `endpoints`

Returns: The number of endpoints stored in endpoints, or -1 if n_endpoints is too low

Definition at line 359 of file routing.c.

int get_n_endpoints ( struct routing_table * table )

Definition at line 378 of file routing.c.

int get_route_endpoint	(	struct routing_table *	table,
		uint32_t	key,
		struct msu_endpoint *	endpoint
	)

Gets the endpoint associated with the given key in the provided route.

Parameters

route	Route to search for key
key	The key with which to search the route set endpoint Points to the appropraite endpoint on success

Returns: 0 on success, -1 on error

Definition at line 385 of file routing.c.

static struct routing_table* get_routing_table ( int route_id )

static

Gets the routing table associated with the route_id.

Returns: A pointer to the routing table if it exists, or NULL

Definition at line 267 of file routing.c.

int get_shortest_queue_endpoint	(	struct routing_table *	table,
		uint32_t	key,
		struct msu_endpoint *	endpoint
	)

Gets the local endpoint from a route with the shortest queue length.

Ignores enpoints on remote runtimes.

Parameters

table	The route to search for the shortest queue length
key	Used as a tiebreaker in the case of multiple MSUs with same queue length
endpoint	Points to appropriate endpoint on success

Returns: 0 on success, -1 on error

Definition at line 299 of file routing.c.

struct routing_table* get_type_from_route_set	(	struct route_set *	routes,
		int	type_id
	)

Gets the route from the provided array of routes which has the correct type ID.

Parameters

routes	Pointer to array of routes to search
n_routes	Number of routes in route array
type_id	Type ID to search for

Returns: pointer to the routing table with correct type ID on success, else NULL

Definition at line 399 of file routing.c.

int init_msu_endpoint	(	int	msu_id,
		int	runtime_id,
		struct msu_endpoint *	endpoint
	)

Initializes an endpoint structure to point to the relevant msu.

Definition at line 483 of file routing.c.

int init_route	(	int	route_id,
		int	type_id
	)

Initializes a new route with the given route_id and type_id.

Parameters

route_id	The ID to assign to the new route
type_id	The Type ID to assign to the new route

Returns: 0 on success, -1 on error

Definition at line 276 of file routing.c.

struct routing_table* init_routing_table	(	int	route_id,
		int	type_id
	)

Initializes and returns a new routing table.

Note: Not for external access! Use init_route() Note: Kept non-static (but exclued from header) so it can be accessed during testing

Returns: The new routing table

Definition at line 250 of file routing.c.

int modify_route_endpoint	(	int	route_id,
		int	msu_id,
		uint32_t	new_key
	)

Modifies key associated with MSU in route.

Parameters

route_id	The ID of the route to modify
msu_id	ID of MSU to modify
new_key	New key to associate with MSU in route

Returns: 0 on success, -1 on error

Definition at line 434 of file routing.c.

static int read_lock ( struct routing_table * table )

static

Simple wrapper to lock a routing table for reading.

Parameters

table the routing table to be locked for reading

Returns: 0 on success, -1 on error

Definition at line 81 of file routing.c.

int remove_route_endpoint	(	int	route_id,
		int	msu_id
	)

Removes destination from route with given ID.

Parameters

route_id	ID of the route from which the endpoint is removed
msu_id	ID of the msu to remove

Returns: 0 on success, -1 on error

Definition at line 419 of file routing.c.

int rm_route_from_set	(	struct route_set *	set,
		int	route_id
	)

Removes a route from a set of routes.

Parameters

route_set	Set to remove the route from
route_id	ID of the route to remove

Returns: 0 on success, -1 on error

Definition at line 465 of file routing.c.

static int rm_routing_table_entry	(	struct routing_table *	table,
		int	msu_id
	)

static

Removes a destination from the routing table.

Parameters

table	The table from which to remove the entry
msu_id	The ID of the msu to remove from the table

Returns: 0 on success, -1 on error

Definition at line 144 of file routing.c.

static int unlock ( struct routing_table * table )

static

Simple wrapper to unlock a locked routing table.

Parameters

table the routing table to be unlocked

Returns: 0 on success, -1 on error

Definition at line 99 of file routing.c.

static int write_lock ( struct routing_table * table )

static

Simple wrapper to lock a routing table for writing.

Parameters

table the routing table to be locked for writing

Returns: 0 on success, -1 on error

Definition at line 90 of file routing.c.

Variable Documentation

struct routing_table* all_routes[10000]

static

All of the created routes in this runtime.

Definition at line 74 of file routing.c.

Classes

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

Function Documentation

Variable Documentation