[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 "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 *nexthop;

	/* Tag */
	route_tag_t tag;

	/* Uptime. */
	time_t uptime;

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

	/* Source protocol instance */
	u_short instance;

	/* VRF identifier. */
	vrf_id_t vrf_id;

	/* Which routing table */
	uint32_t table;

	/* Metric */
	u_int32_t metric;

	/* MTU */
	u_int32_t mtu;
	u_int32_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
	 */
	u_int32_t flags;

	/* RIB internal status */
	u_char 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. */
	u_char nexthop_num;
	u_char 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];
	u_int32_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.
	 */
	u_int32_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 *,
						       ifindex_t);
extern struct nexthop *route_entry_nexthop_blackhole_add(struct route_entry *,
							 enum blackhole_type);
extern struct nexthop *route_entry_nexthop_ipv4_add(struct route_entry *,
						    struct in_addr *,
						    struct in_addr *);
extern struct nexthop *
route_entry_nexthop_ipv4_ifindex_add(struct route_entry *, struct in_addr *,
				     struct in_addr *, ifindex_t);
extern void route_entry_nexthop_delete(struct route_entry *re,
				       struct nexthop *nexthop);
extern struct nexthop *route_entry_nexthop_ipv6_add(struct route_entry *,
						    struct in6_addr *);
extern struct nexthop *
route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
				     struct in6_addr *ipv6, ifindex_t ifindex);
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 *, union prefixconstptr,
			      union prefixconstptr, const struct route_entry *);
/* 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 *, vrf_id_t);
extern void rib_lookup_and_pushup(struct prefix_ipv4 *, vrf_id_t);

extern int rib_lookup_ipv4_route(struct prefix_ipv4 *, union sockunion *,
				 vrf_id_t);
#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(u_int32_t table_id);
extern int is_zebra_main_routing_table(u_int32_t table_id);
extern int zebra_check_addr(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,
		   u_short instance, int flags, struct prefix *p,
		   struct prefix_ipv6 *src_p, const struct nexthop *nh,
		   u_int32_t table_id, u_int32_t metric, u_int32_t mtu,
		   uint8_t distance, route_tag_t tag);

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

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

extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t,
				     union g_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 *, vrf_id_t);

extern void rib_update(vrf_id_t, rib_update_event_t);
extern void rib_weed_tables(void);
extern void rib_sweep_route(void);
extern void rib_close_table(struct route_table *);
extern void rib_init(void);
extern unsigned long rib_score_proto(u_char proto, u_short instance);
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 *, struct route_entry *);
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 u_char 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;

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