[mirror_frr.git] / babeld / route.h

// SPDX-License-Identifier: MIT
/*
Copyright (c) 2007, 2008 by Juliusz Chroboczek
Copyright 2011 by Matthieu Boutier and Juliusz Chroboczek
*/

#ifndef BABEL_ROUTE_H
#define BABEL_ROUTE_H

#include "babel_interface.h"
#include "source.h"

enum babel_diversity {
    DIVERSITY_NONE,
    DIVERSITY_INTERFACE_1,
    DIVERSITY_CHANNEL_1,
    DIVERSITY_CHANNEL,
};

#define DIVERSITY_HOPS 8

struct babel_route {
    struct source *src;
    unsigned short refmetric;
    unsigned short cost;
    unsigned short add_metric;
    unsigned short seqno;
    struct neighbour *neigh;
    unsigned char nexthop[16];
    time_t time;
    unsigned short hold_time;    /* in seconds */
    unsigned short smoothed_metric; /* for route selection */
    time_t smoothed_metric_time;
    short installed;
    unsigned char channels[DIVERSITY_HOPS];
    struct babel_route *next;
};

struct route_stream;

extern struct babel_route **routes;
extern int kernel_metric;
extern enum babel_diversity diversity_kind;
extern int diversity_factor;
extern int keep_unfeasible;
extern int smoothing_half_life;

static inline int
route_metric(const struct babel_route *route)
{
    int m = (int)route->refmetric + route->cost + route->add_metric;
    return MIN(m, INFINITY);
}

static inline int
route_metric_noninterfering(const struct babel_route *route)
{
    int m =
        (int)route->refmetric +
        (diversity_factor * route->cost + 128) / 256 +
        route->add_metric;
    m = MAX(m, route->refmetric + 1);
    return MIN(m, INFINITY);
}

struct babel_route *find_route(const unsigned char *prefix, unsigned char plen,
                         struct neighbour *neigh, const unsigned char *nexthop);
struct babel_route *find_installed_route(const unsigned char *prefix,
                                   unsigned char plen);
int installed_routes_estimate(void);
void flush_route(struct babel_route *route);
void flush_all_routes(void);
void flush_neighbour_routes(struct neighbour *neigh);
void flush_interface_routes(struct interface *ifp, int v4only);
struct route_stream *route_stream(int installed);
struct babel_route *route_stream_next(struct route_stream *stream);
void route_stream_done(struct route_stream *stream);
void install_route(struct babel_route *route);
void uninstall_route(struct babel_route *route);
int route_feasible(struct babel_route *route);
int route_old(struct babel_route *route);
int route_expired(struct babel_route *route);
int route_interferes(struct babel_route *route, struct interface *ifp);
int update_feasible(struct source *src,
                    unsigned short seqno, unsigned short refmetric);
void change_smoothing_half_life(int half_life);
int route_smoothed_metric(struct babel_route *route);
struct babel_route *find_best_route(const unsigned char *prefix, unsigned char plen,
                              int feasible, struct neighbour *exclude);
struct babel_route *install_best_route(const unsigned char prefix[16],
                                 unsigned char plen);
void update_neighbour_metric(struct neighbour *neigh, int change);
void update_interface_metric(struct interface *ifp);
void update_route_metric(struct babel_route *route);
struct babel_route *update_route(const unsigned char *id,
                           const unsigned char *prefix, unsigned char plen,
                           unsigned short seqno, unsigned short refmetric,
                           unsigned short interval, struct neighbour *neigh,
                           const unsigned char *nexthop,
                           const unsigned char *channels, int channels_len);
void retract_neighbour_routes(struct neighbour *neigh);
void send_unfeasible_request(struct neighbour *neigh, int force,
                             unsigned short seqno, unsigned short metric,
                             struct source *src);
void send_triggered_update(struct babel_route *route,
                           struct source *oldsrc, unsigned oldmetric);
void route_changed(struct babel_route *route,
                   struct source *oldsrc, unsigned short oldmetric);
void route_lost(struct source *src, unsigned oldmetric);
void expire_routes(void);

#endif
Commit	Line	Data
acddc0ed	1	// SPDX-License-Identifier: MIT
ca10883e DS	2	/*
	3	Copyright (c) 2007, 2008 by Juliusz Chroboczek
	4	Copyright 2011 by Matthieu Boutier and Juliusz Chroboczek
ca10883e DS	5	*/
	6
	7	#ifndef BABEL_ROUTE_H
	8	#define BABEL_ROUTE_H
	9
	10	#include "babel_interface.h"
	11	#include "source.h"
	12
e33b116c DS	13	enum babel_diversity {
	14	DIVERSITY_NONE,
	15	DIVERSITY_INTERFACE_1,
	16	DIVERSITY_CHANNEL_1,
	17	DIVERSITY_CHANNEL,
	18	};
ca10883e DS	19
	20	#define DIVERSITY_HOPS 8
	21
	22	struct babel_route {
	23	struct source *src;
	24	unsigned short refmetric;
	25	unsigned short cost;
	26	unsigned short add_metric;
	27	unsigned short seqno;
	28	struct neighbour *neigh;
	29	unsigned char nexthop[16];
	30	time_t time;
	31	unsigned short hold_time; /* in seconds */
	32	unsigned short smoothed_metric; /* for route selection */
	33	time_t smoothed_metric_time;
	34	short installed;
	35	unsigned char channels[DIVERSITY_HOPS];
	36	struct babel_route *next;
	37	};
	38
	39	struct route_stream;
	40
	41	extern struct babel_route **routes;
	42	extern int kernel_metric;
e33b116c DS	43	extern enum babel_diversity diversity_kind;
e33b116c DS	44	extern int diversity_factor;
ca10883e DS	45	extern int keep_unfeasible;
	46	extern int smoothing_half_life;
	47
	48	static inline int
	49	route_metric(const struct babel_route *route)
	50	{
	51	int m = (int)route->refmetric + route->cost + route->add_metric;
	52	return MIN(m, INFINITY);
	53	}
	54
	55	static inline int
	56	route_metric_noninterfering(const struct babel_route *route)
	57	{
	58	int m =
	59	(int)route->refmetric +
	60	(diversity_factor * route->cost + 128) / 256 +
	61	route->add_metric;
	62	m = MAX(m, route->refmetric + 1);
	63	return MIN(m, INFINITY);
	64	}
	65
	66	struct babel_route find_route(const unsigned char prefix, unsigned char plen,
	67	struct neighbour neigh, const unsigned char nexthop);
	68	struct babel_route find_installed_route(const unsigned char prefix,
	69	unsigned char plen);
	70	int installed_routes_estimate(void);
	71	void flush_route(struct babel_route *route);
	72	void flush_all_routes(void);
	73	void flush_neighbour_routes(struct neighbour *neigh);
	74	void flush_interface_routes(struct interface *ifp, int v4only);
	75	struct route_stream *route_stream(int installed);
	76	struct babel_route route_stream_next(struct route_stream stream);
	77	void route_stream_done(struct route_stream *stream);
	78	void install_route(struct babel_route *route);
	79	void uninstall_route(struct babel_route *route);
	80	int route_feasible(struct babel_route *route);
	81	int route_old(struct babel_route *route);
	82	int route_expired(struct babel_route *route);
	83	int route_interferes(struct babel_route route, struct interface ifp);
	84	int update_feasible(struct source *src,
	85	unsigned short seqno, unsigned short refmetric);
	86	void change_smoothing_half_life(int half_life);
	87	int route_smoothed_metric(struct babel_route *route);
	88	struct babel_route find_best_route(const unsigned char prefix, unsigned char plen,
	89	int feasible, struct neighbour *exclude);
	90	struct babel_route *install_best_route(const unsigned char prefix[16],
	91	unsigned char plen);
	92	void update_neighbour_metric(struct neighbour *neigh, int change);
	93	void update_interface_metric(struct interface *ifp);
	94	void update_route_metric(struct babel_route *route);
	95	struct babel_route update_route(const unsigned char id,
	96	const unsigned char *prefix, unsigned char plen,
	97	unsigned short seqno, unsigned short refmetric,
	98	unsigned short interval, struct neighbour *neigh,
	99	const unsigned char *nexthop,
	100	const unsigned char *channels, int channels_len);
	101	void retract_neighbour_routes(struct neighbour *neigh);
	102	void send_unfeasible_request(struct neighbour *neigh, int force,
	103	unsigned short seqno, unsigned short metric,
	104	struct source *src);
	105	void send_triggered_update(struct babel_route *route,
	106	struct source *oldsrc, unsigned oldmetric);
	107	void route_changed(struct babel_route *route,
	108	struct source *oldsrc, unsigned short oldmetric);
109	void route_lost(struct source *src, unsigned oldmetric);
110	void expire_routes(void);
111
112	#endif