[mirror_frr.git] / zebra / rib.h

/*
 * Routing Information Base header
 * Copyright (C) 1997 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra 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; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_RIB_H
#define _ZEBRA_RIB_H

#include "zebra.h"
#include "hook.h"
#include "linklist.h"
#include "prefix.h"
#include "table.h"
#include "queue.h"
#include "nexthop.h"
#include "nexthop_group.h"
#include "vrf.h"
#include "if.h"
#include "mpls.h"
#include "srcdest_table.h"

#define DISTANCE_INFINITY  255
#define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */

struct route_entry {
	/* Link list. */
	struct route_entry *next;
	struct route_entry *prev;

	/* Nexthop structure */
	struct nexthop_group ng;

	/* Tag */
	route_tag_t tag;

	/* Uptime. */
	time_t uptime;

	/* Type fo this route. */
	int type;

	/* Source protocol instance */
	unsigned short instance;

	/* VRF identifier. */
	vrf_id_t vrf_id;

	/* Which routing table */
	uint32_t table;

	/* Metric */
	uint32_t metric;

	/* MTU */
	uint32_t mtu;
	uint32_t nexthop_mtu;

	/* Distance. */
	uint8_t distance;

	/* Flags of this route.
	 * This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
	 * to clients via Zserv
	 */
	uint32_t flags;

	/* RIB internal status */
	uint8_t status;
#define ROUTE_ENTRY_REMOVED          0x1
/* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
#define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
#define ROUTE_ENTRY_CHANGED          0x4
#define ROUTE_ENTRY_LABELS_CHANGED   0x8

	/* Nexthop information. */
	uint8_t nexthop_num;
	uint8_t nexthop_active_num;
};

/* meta-queue structure:
 * sub-queue 0: connected, kernel
 * sub-queue 1: static
 * sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
 * sub-queue 3: iBGP, eBGP
 * sub-queue 4: any other origin (if any)
 */
#define MQ_SIZE 5
struct meta_queue {
	struct list *subq[MQ_SIZE];
	uint32_t size; /* sum of lengths of all subqueues */
};

/*
 * Structure that represents a single destination (prefix).
 */
typedef struct rib_dest_t_ {

	/*
	 * Back pointer to the route node for this destination. This helps
	 * us get to the prefix that this structure is for.
	 */
	struct route_node *rnode;

	/*
	 * Doubly-linked list of routes for this prefix.
	 */
	struct route_entry *routes;

	struct route_entry *selected_fib;

	/*
	 * Flags, see below.
	 */
	uint32_t flags;

	/*
	 * Linkage to put dest on the FPM processing queue.
	 */
	TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;

} rib_dest_t;

#define RIB_ROUTE_QUEUED(x)	(1 << (x))
// If MQ_SIZE is modified this value needs to be updated.
#define RIB_ROUTE_ANY_QUEUED    0x1F

/*
 * The maximum qindex that can be used.
 */
#define ZEBRA_MAX_QINDEX        (MQ_SIZE - 1)

/*
 * This flag indicates that a given prefix has been 'advertised' to
 * the FPM to be installed in the forwarding plane.
 */
#define RIB_DEST_SENT_TO_FPM   (1 << (ZEBRA_MAX_QINDEX + 1))

/*
 * This flag is set when we need to send an update to the FPM about a
 * dest.
 */
#define RIB_DEST_UPDATE_FPM    (1 << (ZEBRA_MAX_QINDEX + 2))

/*
 * Macro to iterate over each route for a destination (prefix).
 */
#define RE_DEST_FOREACH_ROUTE(dest, re)                                        \
	for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)

/*
 * Same as above, but allows the current node to be unlinked.
 */
#define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next)                             \
	for ((re) = (dest) ? (dest)->routes : NULL;                            \
	     (re) && ((next) = (re)->next, 1); (re) = (next))

#define RNODE_FOREACH_RE(rn, re)                                               \
	RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)

#define RNODE_FOREACH_RE_SAFE(rn, re, next)                                    \
	RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)

#if defined(HAVE_RTADV)
/* Structure which hold status of router advertisement. */
struct rtadv {
	int sock;

	int adv_if_count;
	int adv_msec_if_count;

	struct thread *ra_read;
	struct thread *ra_timer;
};
#endif /* HAVE_RTADV */

/*
 * rib_table_info_t
 *
 * Structure that is hung off of a route_table that holds information about
 * the table.
 */
typedef struct rib_table_info_t_ {

	/*
	 * Back pointer to zebra_vrf.
	 */
	struct zebra_vrf *zvrf;
	afi_t afi;
	safi_t safi;

} rib_table_info_t;

typedef enum {
	RIB_TABLES_ITER_S_INIT,
	RIB_TABLES_ITER_S_ITERATING,
	RIB_TABLES_ITER_S_DONE
} rib_tables_iter_state_t;

/*
 * Structure that holds state for iterating over all tables in the
 * Routing Information Base.
 */
typedef struct rib_tables_iter_t_ {
	vrf_id_t vrf_id;
	int afi_safi_ix;

	rib_tables_iter_state_t state;
} rib_tables_iter_t;

/* Events/reasons triggering a RIB update. */
typedef enum {
	RIB_UPDATE_IF_CHANGE,
	RIB_UPDATE_RMAP_CHANGE,
	RIB_UPDATE_OTHER
} rib_update_event_t;

extern struct nexthop *route_entry_nexthop_ifindex_add(struct route_entry *re,
						       ifindex_t ifindex,
						       vrf_id_t nh_vrf_id);
extern struct nexthop *
route_entry_nexthop_blackhole_add(struct route_entry *re,
				  enum blackhole_type bh_type);
extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *re,
						    struct in_addr *ipv4,
						    struct in_addr *src,
						    vrf_id_t nh_vrf_id);
extern struct nexthop *
route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
				     struct in_addr *ipv4, struct in_addr *src,
				     ifindex_t ifindex, vrf_id_t nh_vrf_id);
extern void route_entry_nexthop_delete(struct route_entry *re,
				       struct nexthop *nexthop);
extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *re,
						    struct in6_addr *ipv6,
						    vrf_id_t nh_vrf_id);
extern struct nexthop *
route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
				     struct in6_addr *ipv6, ifindex_t ifindex,
				     vrf_id_t nh_vrf_id);
extern void route_entry_nexthop_add(struct route_entry *re,
				    struct nexthop *nexthop);
extern void route_entry_copy_nexthops(struct route_entry *re,
				      struct nexthop *nh);

#define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
extern void _route_entry_dump(const char *func, union prefixconstptr pp,
			      union prefixconstptr src_pp,
			      const struct route_entry *re);
/* RPF lookup behaviour */
enum multicast_mode {
	MCAST_NO_CONFIG = 0,  /* MIX_MRIB_FIRST, but no show in config write */
	MCAST_MRIB_ONLY,      /* MRIB only */
	MCAST_URIB_ONLY,      /* URIB only */
	MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
	MCAST_MIX_DISTANCE,   /* MRIB & URIB, lower distance wins */
	MCAST_MIX_PFXLEN,     /* MRIB & URIB, longer prefix wins */
			      /* on equal value, MRIB wins for last 2 */
};

extern void multicast_mode_ipv4_set(enum multicast_mode mode);
extern enum multicast_mode multicast_mode_ipv4_get(void);

extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);

extern int rib_lookup_ipv4_route(struct prefix_ipv4 *p, union sockunion *qgate,
				 vrf_id_t vrf_id);
#define ZEBRA_RIB_LOOKUP_ERROR -1
#define ZEBRA_RIB_FOUND_EXACT 0
#define ZEBRA_RIB_FOUND_NOGATE 1
#define ZEBRA_RIB_FOUND_CONNECTED 2
#define ZEBRA_RIB_NOTFOUND 3

extern int is_zebra_valid_kernel_table(uint32_t table_id);
extern int is_zebra_main_routing_table(uint32_t table_id);
extern int zebra_check_addr(const struct prefix *p);

extern void rib_addnode(struct route_node *rn, struct route_entry *re,
			int process);
extern void rib_delnode(struct route_node *rn, struct route_entry *re);
extern void rib_install_kernel(struct route_node *rn, struct route_entry *re,
			       struct route_entry *old);
extern void rib_uninstall_kernel(struct route_node *rn, struct route_entry *re);

/* NOTE:
 * All rib_add function will not just add prefix into RIB, but
 * also implicitly withdraw equal prefix of same type. */
extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
		   unsigned short instance, int flags, struct prefix *p,
		   struct prefix_ipv6 *src_p, const struct nexthop *nh,
		   uint32_t table_id, uint32_t metric, uint32_t mtu,
		   uint8_t distance, route_tag_t tag);

extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
			     struct prefix_ipv6 *src_p, struct route_entry *re);

extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
		       unsigned short instance, int flags, struct prefix *p,
		       struct prefix_ipv6 *src_p, const struct nexthop *nh,
		       uint32_t table_id, uint32_t metric, bool fromkernel);

extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
				     union g_addr *addr,
				     struct route_node **rn_out);
extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
						    struct in_addr addr,
						    struct route_node **rn_out);

extern struct route_entry *rib_lookup_ipv4(struct prefix_ipv4 *p,
					   vrf_id_t vrf_id);

extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event);
extern void rib_sweep_route(void);
extern void rib_sweep_table(struct route_table *table);
extern void rib_close_table(struct route_table *table);
extern void rib_init(void);
extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
extern unsigned long rib_score_proto_table(uint8_t proto,
					   unsigned short instance,
					   struct route_table *table);
extern void rib_queue_add(struct route_node *rn);
extern void meta_queue_free(struct meta_queue *mq);
extern int zebra_rib_labeled_unicast(struct route_entry *re);
extern struct route_table *rib_table_ipv6;

extern void rib_unlink(struct route_node *rn, struct route_entry *re);
extern int rib_gc_dest(struct route_node *rn);
extern struct route_table *rib_tables_iter_next(rib_tables_iter_t *iter);

extern uint8_t route_distance(int type);

/*
 * Inline functions.
 */

/*
 * rib_table_info
 */
static inline rib_table_info_t *rib_table_info(struct route_table *table)
{
	return (rib_table_info_t *)table->info;
}

/*
 * rib_dest_from_rnode
 */
static inline rib_dest_t *rib_dest_from_rnode(struct route_node *rn)
{
	return (rib_dest_t *)rn->info;
}

/*
 * rnode_to_ribs
 *
 * Returns a pointer to the list of routes corresponding to the given
 * route_node.
 */
static inline struct route_entry *rnode_to_ribs(struct route_node *rn)
{
	rib_dest_t *dest;

	dest = rib_dest_from_rnode(rn);
	if (!dest)
		return NULL;

	return dest->routes;
}

/*
 * rib_dest_prefix
 */
static inline struct prefix *rib_dest_prefix(rib_dest_t *dest)
{
	return &dest->rnode->p;
}

/*
 * rib_dest_af
 *
 * Returns the address family that the destination is for.
 */
static inline uint8_t rib_dest_af(rib_dest_t *dest)
{
	return dest->rnode->p.family;
}

/*
 * rib_dest_table
 */
static inline struct route_table *rib_dest_table(rib_dest_t *dest)
{
	return srcdest_rnode_table(dest->rnode);
}

/*
 * rib_dest_vrf
 */
static inline struct zebra_vrf *rib_dest_vrf(rib_dest_t *dest)
{
	return rib_table_info(rib_dest_table(dest))->zvrf;
}

/*
 * rib_tables_iter_init
 */
static inline void rib_tables_iter_init(rib_tables_iter_t *iter)

{
	memset(iter, 0, sizeof(*iter));
	iter->state = RIB_TABLES_ITER_S_INIT;
}

/*
 * rib_tables_iter_started
 *
 * Returns TRUE if this iterator has started iterating over the set of
 * tables.
 */
static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
{
	return iter->state != RIB_TABLES_ITER_S_INIT;
}

/*
 * rib_tables_iter_cleanup
 */
static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
{
	iter->state = RIB_TABLES_ITER_S_DONE;
}

DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
	     (rn, reason))


extern void zebra_vty_init(void);
extern int static_config(struct vty *vty, struct zebra_vrf *zvrf, afi_t afi,
			 safi_t safi, const char *cmd);
extern void static_config_install_delayed_routes(struct zebra_vrf *zvrf);

extern pid_t pid;

extern bool v6_rr_semantics;
#endif /*_ZEBRA_RIB_H */
Commit	Line	Data
718e3744	1	/*
	2	* Routing Information Base header
	3	* Copyright (C) 1997 Kunihiro Ishiguro
	4	*
	5	* This file is part of GNU Zebra.
	6	*
	7	* GNU Zebra is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2, or (at your option) any
	10	* later version.
	11	*
	12	* GNU Zebra is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
896014f4 DL	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; see the file COPYING; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
718e3744	20	*/
	21
	22	#ifndef _ZEBRA_RIB_H
	23	#define _ZEBRA_RIB_H
	24
dc9ffce8	25	#include "zebra.h"
4f8ea50c	26	#include "hook.h"
c6ffe645	27	#include "linklist.h"
ec1a4283	28	#include "prefix.h"
9fd92e3c	29	#include "table.h"
5adc2528	30	#include "queue.h"
fb018d25	31	#include "nexthop.h"
7ee30f28	32	#include "nexthop_group.h"
244a59d2	33	#include "vrf.h"
fb148af4	34	#include "if.h"
40c7bdb0	35	#include "mpls.h"
05737783	36	#include "srcdest_table.h"
ec1a4283	37
718e3744	38	#define DISTANCE_INFINITY 255
7a4bb9c5	39	#define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
718e3744	40
d62a17ae	41	struct route_entry {
	42	/* Link list. */
	43	struct route_entry *next;
	44	struct route_entry *prev;
	45
	46	/* Nexthop structure */
7ee30f28	47	struct nexthop_group ng;
d62a17ae	48
d62a17ae	49	/* Tag */
	50	route_tag_t tag;
	51
	52	/* Uptime. */
	53	time_t uptime;
	54
	55	/* Type fo this route. */
	56	int type;
	57
	58	/* Source protocol instance */
d7c0a89a	59	unsigned short instance;
d62a17ae	60
	61	/* VRF identifier. */
	62	vrf_id_t vrf_id;
	63
	64	/* Which routing table */
	65	uint32_t table;
	66
	67	/* Metric */
d7c0a89a	68	uint32_t metric;
d62a17ae	69
d62a17ae	70	/* MTU */
d7c0a89a QY	71	uint32_t mtu;
d7c0a89a QY	72	uint32_t nexthop_mtu;
d62a17ae	73
d62a17ae	74	/* Distance. */
fd289fc8	75	uint8_t distance;
d62a17ae	76
	77	/* Flags of this route.
	78	* This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
	79	* to clients via Zserv
	80	*/
d7c0a89a	81	uint32_t flags;
d62a17ae	82
d62a17ae	83	/* RIB internal status */
d7c0a89a	84	uint8_t status;
f0f77c9a	85	#define ROUTE_ENTRY_REMOVED 0x1
d62a17ae	86	/* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
f0f77c9a DS	87	#define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
f0f77c9a DS	88	#define ROUTE_ENTRY_CHANGED 0x4
5f7a4718	89	#define ROUTE_ENTRY_LABELS_CHANGED 0x8
6d691129	90
d62a17ae	91	/* Nexthop information. */
d7c0a89a QY	92	uint8_t nexthop_num;
d7c0a89a QY	93	uint8_t nexthop_active_num;
718e3744	94	};
718e3744	95
e96f9203 DO	96	/* meta-queue structure:
	97	* sub-queue 0: connected, kernel
	98	* sub-queue 1: static
43cf4ba4	99	* sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
e96f9203 DO	100	* sub-queue 3: iBGP, eBGP
	101	* sub-queue 4: any other origin (if any)
	102	*/
	103	#define MQ_SIZE 5
d62a17ae	104	struct meta_queue {
d62a17ae	105	struct list *subq[MQ_SIZE];
d7c0a89a	106	uint32_t size; /* sum of lengths of all subqueues */
e96f9203 DO	107	};
e96f9203 DO	108
9fd92e3c AS	109	/*
	110	* Structure that represents a single destination (prefix).
	111	*/
d62a17ae	112	typedef struct rib_dest_t_ {
9fd92e3c	113
d62a17ae	114	/*
	115	* Back pointer to the route node for this destination. This helps
	116	* us get to the prefix that this structure is for.
	117	*/
	118	struct route_node *rnode;
9fd92e3c	119
d62a17ae	120	/*
	121	* Doubly-linked list of routes for this prefix.
	122	*/
	123	struct route_entry *routes;
9fd92e3c	124
5f7a4718 DS	125	struct route_entry *selected_fib;
5f7a4718 DS	126
d62a17ae	127	/*
	128	* Flags, see below.
	129	*/
d7c0a89a	130	uint32_t flags;
9fd92e3c	131
d62a17ae	132	/*
	133	* Linkage to put dest on the FPM processing queue.
	134	*/
	135	TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
5adc2528	136
9fd92e3c AS	137	} rib_dest_t;
	138
	139	#define RIB_ROUTE_QUEUED(x) (1 << (x))
1ca60f2c DS	140	// If MQ_SIZE is modified this value needs to be updated.
1ca60f2c DS	141	#define RIB_ROUTE_ANY_QUEUED 0x1F
9fd92e3c AS	142
	143	/*
	144	* The maximum qindex that can be used.
	145	*/
	146	#define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
	147
5adc2528 AS	148	/*
	149	* This flag indicates that a given prefix has been 'advertised' to
	150	* the FPM to be installed in the forwarding plane.
	151	*/
	152	#define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
	153
	154	/*
	155	* This flag is set when we need to send an update to the FPM about a
	156	* dest.
	157	*/
	158	#define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
	159
9fd92e3c AS	160	/*
	161	* Macro to iterate over each route for a destination (prefix).
	162	*/
d62a17ae	163	#define RE_DEST_FOREACH_ROUTE(dest, re) \
d62a17ae	164	for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)
9fd92e3c AS	165
	166	/*
	167	* Same as above, but allows the current node to be unlinked.
	168	*/
d62a17ae	169	#define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
	170	for ((re) = (dest) ? (dest)->routes : NULL; \
	171	(re) && ((next) = (re)->next, 1); (re) = (next))
9fd92e3c	172
d62a17ae	173	#define RNODE_FOREACH_RE(rn, re) \
996c9314	174	RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
9fd92e3c	175
d62a17ae	176	#define RNODE_FOREACH_RE_SAFE(rn, re, next) \
996c9314	177	RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
9fd92e3c	178
d62a17ae	179	#if defined(HAVE_RTADV)
cd80d74f	180	/* Structure which hold status of router advertisement. */
d62a17ae	181	struct rtadv {
d62a17ae	182	int sock;
cd80d74f	183
d62a17ae	184	int adv_if_count;
d62a17ae	185	int adv_msec_if_count;
cd80d74f	186
d62a17ae	187	struct thread *ra_read;
d62a17ae	188	struct thread *ra_timer;
cd80d74f	189	};
8da4e946	190	#endif /* HAVE_RTADV */
cd80d74f	191
1b5ed1b0 AS	192	/*
	193	* rib_table_info_t
	194	*
	195	* Structure that is hung off of a route_table that holds information about
	196	* the table.
	197	*/
d62a17ae	198	typedef struct rib_table_info_t_ {
1b5ed1b0	199
d62a17ae	200	/*
	201	* Back pointer to zebra_vrf.
	202	*/
	203	struct zebra_vrf *zvrf;
	204	afi_t afi;
	205	safi_t safi;
1b5ed1b0 AS	206
	207	} rib_table_info_t;
	208
d62a17ae	209	typedef enum {
	210	RIB_TABLES_ITER_S_INIT,
	211	RIB_TABLES_ITER_S_ITERATING,
	212	RIB_TABLES_ITER_S_DONE
0915bb0c AS	213	} rib_tables_iter_state_t;
	214
	215	/*
	216	* Structure that holds state for iterating over all tables in the
	217	* Routing Information Base.
	218	*/
d62a17ae	219	typedef struct rib_tables_iter_t_ {
	220	vrf_id_t vrf_id;
	221	int afi_safi_ix;
0915bb0c	222
d62a17ae	223	rib_tables_iter_state_t state;
0915bb0c AS	224	} rib_tables_iter_t;
0915bb0c AS	225
1c848137	226	/* Events/reasons triggering a RIB update. */
d62a17ae	227	typedef enum {
	228	RIB_UPDATE_IF_CHANGE,
	229	RIB_UPDATE_RMAP_CHANGE,
	230	RIB_UPDATE_OTHER
1c848137	231	} rib_update_event_t;
1c848137	232
072834ca DS	233	extern struct nexthop route_entry_nexthop_ifindex_add(struct route_entry re,
072834ca DS	234	ifindex_t ifindex,
4a7371e9	235	vrf_id_t nh_vrf_id);
072834ca DS	236	extern struct nexthop *
	237	route_entry_nexthop_blackhole_add(struct route_entry *re,
	238	enum blackhole_type bh_type);
	239	extern struct nexthop route_entry_nexthop_ipv4_add(struct route_entry re,
	240	struct in_addr *ipv4,
	241	struct in_addr *src,
4a7371e9	242	vrf_id_t nh_vrf_id);
d62a17ae	243	extern struct nexthop *
072834ca DS	244	route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
	245	struct in_addr ipv4, struct in_addr src,
	246	ifindex_t ifindex, vrf_id_t nh_vrf_id);
d62a17ae	247	extern void route_entry_nexthop_delete(struct route_entry *re,
d62a17ae	248	struct nexthop *nexthop);
072834ca DS	249	extern struct nexthop route_entry_nexthop_ipv6_add(struct route_entry re,
072834ca DS	250	struct in6_addr *ipv6,
4a7371e9	251	vrf_id_t nh_vrf_id);
d62a17ae	252	extern struct nexthop *
d62a17ae	253	route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
4a7371e9 DS	254	struct in6_addr *ipv6, ifindex_t ifindex,
4a7371e9 DS	255	vrf_id_t nh_vrf_id);
d62a17ae	256	extern void route_entry_nexthop_add(struct route_entry *re,
	257	struct nexthop *nexthop);
	258	extern void route_entry_copy_nexthops(struct route_entry *re,
	259	struct nexthop *nh);
f0f77c9a DS	260
f0f77c9a DS	261	#define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
072834ca DS	262	extern void _route_entry_dump(const char *func, union prefixconstptr pp,
	263	union prefixconstptr src_pp,
	264	const struct route_entry *re);
4623d897	265	/* RPF lookup behaviour */
d62a17ae	266	enum multicast_mode {
	267	MCAST_NO_CONFIG = 0, /* MIX_MRIB_FIRST, but no show in config write */
	268	MCAST_MRIB_ONLY, /* MRIB only */
	269	MCAST_URIB_ONLY, /* URIB only */
	270	MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
	271	MCAST_MIX_DISTANCE, /* MRIB & URIB, lower distance wins */
	272	MCAST_MIX_PFXLEN, /* MRIB & URIB, longer prefix wins */
	273	/* on equal value, MRIB wins for last 2 */
4623d897 DL	274	};
4623d897 DL	275
d62a17ae	276	extern void multicast_mode_ipv4_set(enum multicast_mode mode);
d62a17ae	277	extern enum multicast_mode multicast_mode_ipv4_get(void);
4623d897	278
072834ca DS	279	extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
072834ca DS	280	extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);
f0f77c9a	281
072834ca DS	282	extern int rib_lookup_ipv4_route(struct prefix_ipv4 p, union sockunion qgate,
072834ca DS	283	vrf_id_t vrf_id);
dc95824a DO	284	#define ZEBRA_RIB_LOOKUP_ERROR -1
	285	#define ZEBRA_RIB_FOUND_EXACT 0
	286	#define ZEBRA_RIB_FOUND_NOGATE 1
	287	#define ZEBRA_RIB_FOUND_CONNECTED 2
	288	#define ZEBRA_RIB_NOTFOUND 3
	289
d7c0a89a QY	290	extern int is_zebra_valid_kernel_table(uint32_t table_id);
d7c0a89a QY	291	extern int is_zebra_main_routing_table(uint32_t table_id);
86391e56	292	extern int zebra_check_addr(const struct prefix *p);
718e3744	293
d62a17ae	294	extern void rib_addnode(struct route_node rn, struct route_entry re,
	295	int process);
	296	extern void rib_delnode(struct route_node rn, struct route_entry re);
0c555cc6 DS	297	extern void rib_install_kernel(struct route_node rn, struct route_entry re,
	298	struct route_entry *old);
	299	extern void rib_uninstall_kernel(struct route_node rn, struct route_entry re);
28f6dde8	300
d24af186	301	/* NOTE:
b4c034b0	302	* All rib_add function will not just add prefix into RIB, but
d24af186	303	* also implicitly withdraw equal prefix of same type. */
4a7371e9	304	extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
d7c0a89a	305	unsigned short instance, int flags, struct prefix *p,
fd36be7e	306	struct prefix_ipv6 src_p, const struct nexthop nh,
d7c0a89a	307	uint32_t table_id, uint32_t metric, uint32_t mtu,
4e40b6d6	308	uint8_t distance, route_tag_t tag);
d62a17ae	309
072834ca DS	310	extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
072834ca DS	311	struct prefix_ipv6 src_p, struct route_entry re);
d62a17ae	312
d62a17ae	313	extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
d7c0a89a	314	unsigned short instance, int flags, struct prefix *p,
fd36be7e	315	struct prefix_ipv6 src_p, const struct nexthop nh,
a317a9b9	316	uint32_t table_id, uint32_t metric, bool fromkernel);
d62a17ae	317
072834ca DS	318	extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
072834ca DS	319	union g_addr *addr,
d62a17ae	320	struct route_node **rn_out);
	321	extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
	322	struct in_addr addr,
	323	struct route_node **rn_out);
	324
072834ca DS	325	extern struct route_entry rib_lookup_ipv4(struct prefix_ipv4 p,
072834ca DS	326	vrf_id_t vrf_id);
d62a17ae	327
072834ca	328	extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event);
d62a17ae	329	extern void rib_sweep_route(void);
072834ca DS	330	extern void rib_sweep_table(struct route_table *table);
072834ca DS	331	extern void rib_close_table(struct route_table *table);
d62a17ae	332	extern void rib_init(void);
d7c0a89a QY	333	extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
	334	extern unsigned long rib_score_proto_table(uint8_t proto,
	335	unsigned short instance,
47a08aa9	336	struct route_table *table);
d62a17ae	337	extern void rib_queue_add(struct route_node *rn);
	338	extern void meta_queue_free(struct meta_queue *mq);
	339	extern int zebra_rib_labeled_unicast(struct route_entry *re);
718e3744	340	extern struct route_table *rib_table_ipv6;
718e3744	341
072834ca	342	extern void rib_unlink(struct route_node rn, struct route_entry re);
d62a17ae	343	extern int rib_gc_dest(struct route_node *rn);
d62a17ae	344	extern struct route_table rib_tables_iter_next(rib_tables_iter_t iter);
9fd92e3c	345
fd289fc8	346	extern uint8_t route_distance(int type);
40c7bdb0	347
9fd92e3c AS	348	/*
	349	* Inline functions.
	350	*/
	351
1b5ed1b0 AS	352	/*
	353	* rib_table_info
	354	*/
d62a17ae	355	static inline rib_table_info_t rib_table_info(struct route_table table)
1b5ed1b0	356	{
d62a17ae	357	return (rib_table_info_t *)table->info;
1b5ed1b0 AS	358	}
1b5ed1b0 AS	359
9fd92e3c AS	360	/*
	361	* rib_dest_from_rnode
	362	*/
d62a17ae	363	static inline rib_dest_t rib_dest_from_rnode(struct route_node rn)
9fd92e3c	364	{
d62a17ae	365	return (rib_dest_t *)rn->info;
9fd92e3c AS	366	}
	367
	368	/*
	369	* rnode_to_ribs
	370	*
	371	* Returns a pointer to the list of routes corresponding to the given
	372	* route_node.
	373	*/
d62a17ae	374	static inline struct route_entry rnode_to_ribs(struct route_node rn)
9fd92e3c	375	{
d62a17ae	376	rib_dest_t *dest;
9fd92e3c	377
d62a17ae	378	dest = rib_dest_from_rnode(rn);
	379	if (!dest)
	380	return NULL;
9fd92e3c	381
d62a17ae	382	return dest->routes;
9fd92e3c AS	383	}
	384
	385	/*
	386	* rib_dest_prefix
	387	*/
d62a17ae	388	static inline struct prefix rib_dest_prefix(rib_dest_t dest)
9fd92e3c	389	{
d62a17ae	390	return &dest->rnode->p;
9fd92e3c AS	391	}
	392
	393	/*
	394	* rib_dest_af
	395	*
	396	* Returns the address family that the destination is for.
	397	*/
d7c0a89a	398	static inline uint8_t rib_dest_af(rib_dest_t *dest)
9fd92e3c	399	{
d62a17ae	400	return dest->rnode->p.family;
9fd92e3c AS	401	}
	402
	403	/*
	404	* rib_dest_table
	405	*/
d62a17ae	406	static inline struct route_table rib_dest_table(rib_dest_t dest)
9fd92e3c	407	{
d62a17ae	408	return srcdest_rnode_table(dest->rnode);
9fd92e3c AS	409	}
9fd92e3c AS	410
1b5ed1b0 AS	411	/*
	412	* rib_dest_vrf
	413	*/
d62a17ae	414	static inline struct zebra_vrf rib_dest_vrf(rib_dest_t dest)
1b5ed1b0	415	{
d62a17ae	416	return rib_table_info(rib_dest_table(dest))->zvrf;
1b5ed1b0 AS	417	}
1b5ed1b0 AS	418
0915bb0c AS	419	/*
	420	* rib_tables_iter_init
	421	*/
d62a17ae	422	static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
0915bb0c AS	423
0915bb0c AS	424	{
d62a17ae	425	memset(iter, 0, sizeof(*iter));
d62a17ae	426	iter->state = RIB_TABLES_ITER_S_INIT;
0915bb0c AS	427	}
	428
	429	/*
	430	* rib_tables_iter_started
	431	*
	432	* Returns TRUE if this iterator has started iterating over the set of
	433	* tables.
	434	*/
d62a17ae	435	static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
0915bb0c	436	{
d62a17ae	437	return iter->state != RIB_TABLES_ITER_S_INIT;
0915bb0c AS	438	}
	439
	440	/*
	441	* rib_tables_iter_cleanup
	442	*/
d62a17ae	443	static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
0915bb0c	444	{
d62a17ae	445	iter->state = RIB_TABLES_ITER_S_DONE;
0915bb0c AS	446	}
0915bb0c AS	447
d62a17ae	448	DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
d62a17ae	449	(rn, reason))
4f8ea50c	450
05f7f5db DS	451
05f7f5db DS	452	extern void zebra_vty_init(void);
996c9314 LB	453	extern int static_config(struct vty vty, struct zebra_vrf zvrf, afi_t afi,
996c9314 LB	454	safi_t safi, const char *cmd);
4060008b DS	455	extern void static_config_install_delayed_routes(struct zebra_vrf *zvrf);
4060008b DS	456
05f7f5db DS	457	extern pid_t pid;
05f7f5db DS	458
6b093863	459	extern bool v6_rr_semantics;
718e3744	460	#endif /_ZEBRA_RIB_H /