[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;

	/* Sequence value incremented for each dataplane operation */
	uint32_t dplane_sequence;
};

/* 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);

#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_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, uint8_t distance,
		       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_update_table(struct route_table *table,
			     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 *)route_table_get_info(table);
}

/*
 * 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 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;
7cdb1a84 MS	94
	95	/* Sequence value incremented for each dataplane operation */
	96	uint32_t dplane_sequence;
718e3744	97	};
718e3744	98
e96f9203 DO	99	/* meta-queue structure:
	100	* sub-queue 0: connected, kernel
	101	* sub-queue 1: static
43cf4ba4	102	* sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
e96f9203 DO	103	* sub-queue 3: iBGP, eBGP
	104	* sub-queue 4: any other origin (if any)
	105	*/
	106	#define MQ_SIZE 5
d62a17ae	107	struct meta_queue {
d62a17ae	108	struct list *subq[MQ_SIZE];
d7c0a89a	109	uint32_t size; /* sum of lengths of all subqueues */
e96f9203 DO	110	};
e96f9203 DO	111
9fd92e3c AS	112	/*
	113	* Structure that represents a single destination (prefix).
	114	*/
d62a17ae	115	typedef struct rib_dest_t_ {
9fd92e3c	116
d62a17ae	117	/*
	118	* Back pointer to the route node for this destination. This helps
	119	* us get to the prefix that this structure is for.
	120	*/
	121	struct route_node *rnode;
9fd92e3c	122
d62a17ae	123	/*
	124	* Doubly-linked list of routes for this prefix.
	125	*/
	126	struct route_entry *routes;
9fd92e3c	127
5f7a4718 DS	128	struct route_entry *selected_fib;
5f7a4718 DS	129
d62a17ae	130	/*
	131	* Flags, see below.
	132	*/
d7c0a89a	133	uint32_t flags;
9fd92e3c	134
d62a17ae	135	/*
	136	* Linkage to put dest on the FPM processing queue.
	137	*/
	138	TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
5adc2528	139
9fd92e3c AS	140	} rib_dest_t;
	141
	142	#define RIB_ROUTE_QUEUED(x) (1 << (x))
1ca60f2c DS	143	// If MQ_SIZE is modified this value needs to be updated.
1ca60f2c DS	144	#define RIB_ROUTE_ANY_QUEUED 0x1F
9fd92e3c AS	145
	146	/*
	147	* The maximum qindex that can be used.
	148	*/
	149	#define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
	150
5adc2528 AS	151	/*
	152	* This flag indicates that a given prefix has been 'advertised' to
	153	* the FPM to be installed in the forwarding plane.
	154	*/
	155	#define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
	156
	157	/*
	158	* This flag is set when we need to send an update to the FPM about a
	159	* dest.
	160	*/
	161	#define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
	162
9fd92e3c AS	163	/*
	164	* Macro to iterate over each route for a destination (prefix).
	165	*/
d62a17ae	166	#define RE_DEST_FOREACH_ROUTE(dest, re) \
d62a17ae	167	for ((re) = (dest) ? (dest)->routes : NULL; (re); (re) = (re)->next)
9fd92e3c AS	168
	169	/*
	170	* Same as above, but allows the current node to be unlinked.
	171	*/
d62a17ae	172	#define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
	173	for ((re) = (dest) ? (dest)->routes : NULL; \
	174	(re) && ((next) = (re)->next, 1); (re) = (next))
9fd92e3c	175
d62a17ae	176	#define RNODE_FOREACH_RE(rn, re) \
996c9314	177	RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
9fd92e3c	178
d62a17ae	179	#define RNODE_FOREACH_RE_SAFE(rn, re, next) \
996c9314	180	RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
9fd92e3c	181
d62a17ae	182	#if defined(HAVE_RTADV)
cd80d74f	183	/* Structure which hold status of router advertisement. */
d62a17ae	184	struct rtadv {
d62a17ae	185	int sock;
cd80d74f	186
d62a17ae	187	int adv_if_count;
d62a17ae	188	int adv_msec_if_count;
cd80d74f	189
d62a17ae	190	struct thread *ra_read;
d62a17ae	191	struct thread *ra_timer;
cd80d74f	192	};
8da4e946	193	#endif /* HAVE_RTADV */
cd80d74f	194
1b5ed1b0 AS	195	/*
	196	* rib_table_info_t
	197	*
	198	* Structure that is hung off of a route_table that holds information about
	199	* the table.
	200	*/
d62a17ae	201	typedef struct rib_table_info_t_ {
1b5ed1b0	202
d62a17ae	203	/*
	204	* Back pointer to zebra_vrf.
	205	*/
	206	struct zebra_vrf *zvrf;
	207	afi_t afi;
	208	safi_t safi;
1b5ed1b0 AS	209
	210	} rib_table_info_t;
	211
d62a17ae	212	typedef enum {
	213	RIB_TABLES_ITER_S_INIT,
	214	RIB_TABLES_ITER_S_ITERATING,
	215	RIB_TABLES_ITER_S_DONE
0915bb0c AS	216	} rib_tables_iter_state_t;
	217
	218	/*
	219	* Structure that holds state for iterating over all tables in the
	220	* Routing Information Base.
	221	*/
d62a17ae	222	typedef struct rib_tables_iter_t_ {
	223	vrf_id_t vrf_id;
	224	int afi_safi_ix;
0915bb0c	225
d62a17ae	226	rib_tables_iter_state_t state;
0915bb0c AS	227	} rib_tables_iter_t;
0915bb0c AS	228
1c848137	229	/* Events/reasons triggering a RIB update. */
d62a17ae	230	typedef enum {
	231	RIB_UPDATE_IF_CHANGE,
	232	RIB_UPDATE_RMAP_CHANGE,
	233	RIB_UPDATE_OTHER
1c848137	234	} rib_update_event_t;
1c848137	235
072834ca DS	236	extern struct nexthop route_entry_nexthop_ifindex_add(struct route_entry re,
072834ca DS	237	ifindex_t ifindex,
4a7371e9	238	vrf_id_t nh_vrf_id);
072834ca DS	239	extern struct nexthop *
	240	route_entry_nexthop_blackhole_add(struct route_entry *re,
	241	enum blackhole_type bh_type);
	242	extern struct nexthop route_entry_nexthop_ipv4_add(struct route_entry re,
	243	struct in_addr *ipv4,
	244	struct in_addr *src,
4a7371e9	245	vrf_id_t nh_vrf_id);
d62a17ae	246	extern struct nexthop *
072834ca DS	247	route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
	248	struct in_addr ipv4, struct in_addr src,
	249	ifindex_t ifindex, vrf_id_t nh_vrf_id);
d62a17ae	250	extern void route_entry_nexthop_delete(struct route_entry *re,
d62a17ae	251	struct nexthop *nexthop);
072834ca DS	252	extern struct nexthop route_entry_nexthop_ipv6_add(struct route_entry re,
072834ca DS	253	struct in6_addr *ipv6,
4a7371e9	254	vrf_id_t nh_vrf_id);
d62a17ae	255	extern struct nexthop *
d62a17ae	256	route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
4a7371e9 DS	257	struct in6_addr *ipv6, ifindex_t ifindex,
4a7371e9 DS	258	vrf_id_t nh_vrf_id);
d62a17ae	259	extern void route_entry_nexthop_add(struct route_entry *re,
	260	struct nexthop *nexthop);
	261	extern void route_entry_copy_nexthops(struct route_entry *re,
	262	struct nexthop *nh);
f0f77c9a DS	263
f0f77c9a DS	264	#define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
072834ca DS	265	extern void _route_entry_dump(const char *func, union prefixconstptr pp,
	266	union prefixconstptr src_pp,
	267	const struct route_entry *re);
4623d897	268	/* RPF lookup behaviour */
d62a17ae	269	enum multicast_mode {
	270	MCAST_NO_CONFIG = 0, /* MIX_MRIB_FIRST, but no show in config write */
	271	MCAST_MRIB_ONLY, /* MRIB only */
	272	MCAST_URIB_ONLY, /* URIB only */
	273	MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
	274	MCAST_MIX_DISTANCE, /* MRIB & URIB, lower distance wins */
	275	MCAST_MIX_PFXLEN, /* MRIB & URIB, longer prefix wins */
	276	/* on equal value, MRIB wins for last 2 */
4623d897 DL	277	};
4623d897 DL	278
d62a17ae	279	extern void multicast_mode_ipv4_set(enum multicast_mode mode);
d62a17ae	280	extern enum multicast_mode multicast_mode_ipv4_get(void);
4623d897	281
072834ca DS	282	extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
072834ca DS	283	extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);
f0f77c9a	284
dc95824a DO	285	#define ZEBRA_RIB_LOOKUP_ERROR -1
	286	#define ZEBRA_RIB_FOUND_EXACT 0
	287	#define ZEBRA_RIB_FOUND_NOGATE 1
	288	#define ZEBRA_RIB_FOUND_CONNECTED 2
	289	#define ZEBRA_RIB_NOTFOUND 3
	290
d7c0a89a QY	291	extern int is_zebra_valid_kernel_table(uint32_t table_id);
d7c0a89a QY	292	extern int is_zebra_main_routing_table(uint32_t table_id);
86391e56	293	extern int zebra_check_addr(const struct prefix *p);
718e3744	294
d62a17ae	295	extern void rib_delnode(struct route_node rn, struct route_entry re);
0c555cc6 DS	296	extern void rib_install_kernel(struct route_node rn, struct route_entry re,
	297	struct route_entry *old);
	298	extern void rib_uninstall_kernel(struct route_node rn, struct route_entry re);
28f6dde8	299
d24af186	300	/* NOTE:
b4c034b0	301	* All rib_add function will not just add prefix into RIB, but
d24af186	302	* also implicitly withdraw equal prefix of same type. */
4a7371e9	303	extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
d7c0a89a	304	unsigned short instance, int flags, struct prefix *p,
fd36be7e	305	struct prefix_ipv6 src_p, const struct nexthop nh,
d7c0a89a	306	uint32_t table_id, uint32_t metric, uint32_t mtu,
4e40b6d6	307	uint8_t distance, route_tag_t tag);
d62a17ae	308
072834ca DS	309	extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
072834ca DS	310	struct prefix_ipv6 src_p, struct route_entry re);
d62a17ae	311
d62a17ae	312	extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
d7c0a89a	313	unsigned short instance, int flags, struct prefix *p,
fd36be7e	314	struct prefix_ipv6 src_p, const struct nexthop nh,
40ecd8e4 DS	315	uint32_t table_id, uint32_t metric, uint8_t distance,
40ecd8e4 DS	316	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);
d5b8c216	329	extern void rib_update_table(struct route_table *table,
d5b8c216	330	rib_update_event_t event);
d62a17ae	331	extern void rib_sweep_route(void);
072834ca DS	332	extern void rib_sweep_table(struct route_table *table);
072834ca DS	333	extern void rib_close_table(struct route_table *table);
d62a17ae	334	extern void rib_init(void);
d7c0a89a QY	335	extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
	336	extern unsigned long rib_score_proto_table(uint8_t proto,
	337	unsigned short instance,
47a08aa9	338	struct route_table *table);
d62a17ae	339	extern void rib_queue_add(struct route_node *rn);
	340	extern void meta_queue_free(struct meta_queue *mq);
	341	extern int zebra_rib_labeled_unicast(struct route_entry *re);
718e3744	342	extern struct route_table *rib_table_ipv6;
718e3744	343
072834ca	344	extern void rib_unlink(struct route_node rn, struct route_entry re);
d62a17ae	345	extern int rib_gc_dest(struct route_node *rn);
d62a17ae	346	extern struct route_table rib_tables_iter_next(rib_tables_iter_t iter);
9fd92e3c	347
fd289fc8	348	extern uint8_t route_distance(int type);
40c7bdb0	349
9fd92e3c AS	350	/*
	351	* Inline functions.
	352	*/
	353
1b5ed1b0 AS	354	/*
	355	* rib_table_info
	356	*/
d62a17ae	357	static inline rib_table_info_t rib_table_info(struct route_table table)
1b5ed1b0	358	{
6ca30e9e	359	return (rib_table_info_t *)route_table_get_info(table);
1b5ed1b0 AS	360	}
1b5ed1b0 AS	361
9fd92e3c AS	362	/*
	363	* rib_dest_from_rnode
	364	*/
d62a17ae	365	static inline rib_dest_t rib_dest_from_rnode(struct route_node rn)
9fd92e3c	366	{
d62a17ae	367	return (rib_dest_t *)rn->info;
9fd92e3c AS	368	}
	369
	370	/*
	371	* rnode_to_ribs
	372	*
	373	* Returns a pointer to the list of routes corresponding to the given
	374	* route_node.
	375	*/
d62a17ae	376	static inline struct route_entry rnode_to_ribs(struct route_node rn)
9fd92e3c	377	{
d62a17ae	378	rib_dest_t *dest;
9fd92e3c	379
d62a17ae	380	dest = rib_dest_from_rnode(rn);
	381	if (!dest)
	382	return NULL;
9fd92e3c	383
d62a17ae	384	return dest->routes;
9fd92e3c AS	385	}
	386
	387	/*
	388	* rib_dest_prefix
	389	*/
d62a17ae	390	static inline struct prefix rib_dest_prefix(rib_dest_t dest)
9fd92e3c	391	{
d62a17ae	392	return &dest->rnode->p;
9fd92e3c AS	393	}
	394
	395	/*
	396	* rib_dest_af
	397	*
	398	* Returns the address family that the destination is for.
	399	*/
d7c0a89a	400	static inline uint8_t rib_dest_af(rib_dest_t *dest)
9fd92e3c	401	{
d62a17ae	402	return dest->rnode->p.family;
9fd92e3c AS	403	}
	404
	405	/*
	406	* rib_dest_table
	407	*/
d62a17ae	408	static inline struct route_table rib_dest_table(rib_dest_t dest)
9fd92e3c	409	{
d62a17ae	410	return srcdest_rnode_table(dest->rnode);
9fd92e3c AS	411	}
9fd92e3c AS	412
1b5ed1b0 AS	413	/*
	414	* rib_dest_vrf
	415	*/
d62a17ae	416	static inline struct zebra_vrf rib_dest_vrf(rib_dest_t dest)
1b5ed1b0	417	{
d62a17ae	418	return rib_table_info(rib_dest_table(dest))->zvrf;
1b5ed1b0 AS	419	}
1b5ed1b0 AS	420
0915bb0c AS	421	/*
	422	* rib_tables_iter_init
	423	*/
d62a17ae	424	static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
0915bb0c AS	425
0915bb0c AS	426	{
d62a17ae	427	memset(iter, 0, sizeof(*iter));
d62a17ae	428	iter->state = RIB_TABLES_ITER_S_INIT;
0915bb0c AS	429	}
	430
	431	/*
	432	* rib_tables_iter_started
	433	*
	434	* Returns TRUE if this iterator has started iterating over the set of
	435	* tables.
	436	*/
d62a17ae	437	static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
0915bb0c	438	{
d62a17ae	439	return iter->state != RIB_TABLES_ITER_S_INIT;
0915bb0c AS	440	}
	441
	442	/*
	443	* rib_tables_iter_cleanup
	444	*/
d62a17ae	445	static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
0915bb0c	446	{
d62a17ae	447	iter->state = RIB_TABLES_ITER_S_DONE;
0915bb0c AS	448	}
0915bb0c AS	449
d62a17ae	450	DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
d62a17ae	451	(rn, reason))
4f8ea50c	452
05f7f5db DS	453
05f7f5db DS	454	extern void zebra_vty_init(void);
4060008b	455
05f7f5db DS	456	extern pid_t pid;
05f7f5db DS	457
6b093863	458	extern bool v6_rr_semantics;
718e3744	459	#endif /_ZEBRA_RIB_H /