[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 "typesafe.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"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum { RNH_NEXTHOP_TYPE, RNH_IMPORT_CHECK_TYPE } rnh_type_t;

PREDECL_LIST(rnh_list)

/* Nexthop structure. */
struct rnh {
	uint8_t flags;

#define ZEBRA_NHT_CONNECTED     0x1
#define ZEBRA_NHT_DELETED       0x2
#define ZEBRA_NHT_EXACT_MATCH   0x4

	/* VRF identifier. */
	vrf_id_t vrf_id;

	afi_t afi;

	rnh_type_t type;

	uint32_t seqno;

	struct route_entry *state;
	struct prefix resolved_route;
	struct list *client_list;

	/* pseudowires dependent on this nh */
	struct list *zebra_pseudowire_list;

	struct route_node *node;

	/*
	 * if this has been filtered for the client
	 */
	int filtered[ZEBRA_ROUTE_MAX];

	struct rnh_list_item rnh_list_item;
};

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

PREDECL_LIST(re_list)

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

	/* 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 */
	uint32_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
/* The Route Entry has changed */
#define ROUTE_ENTRY_CHANGED          0x4
/* The Label has changed on the Route entry */
#define ROUTE_ENTRY_LABELS_CHANGED   0x8
/* Route is queued for Installation into the Data Plane */
#define ROUTE_ENTRY_QUEUED   0x10
/* Route is installed into the Data Plane */
#define ROUTE_ENTRY_INSTALLED        0x20
/* Route has Failed installation into the Data Plane in some manner */
#define ROUTE_ENTRY_FAILED           0x40

	/* 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 re_list_head routes;

	struct route_entry *selected_fib;

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

	/*
	 * The list of nht prefixes that have ended up
	 * depending on this route node.
	 * After route processing is returned from
	 * the data plane we will run evaluate_rnh
	 * on these prefixes.
	 */
	struct rnh_list_head nht;

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

} rib_dest_t;

DECLARE_LIST(rnh_list, struct rnh, rnh_list_item);
DECLARE_LIST(re_list, struct route_entry, next);

#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))

#define RIB_DEST_UPDATE_LSPS   (1 << (ZEBRA_MAX_QINDEX + 3))

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

/*
 * Same as above, but allows the current node to be unlinked.
 */
#define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next)                             \
	for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL;          \
	     (re) && ((next) = re_list_next(&((dest)->routes), (re)), 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);

extern void zebra_rib_evaluate_rn_nexthops(struct route_node *rn, uint32_t seq);

/*
 * 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 re_list_first(&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;
}

/*
 * Create the rib_dest_t and attach it to the specified node
 */
extern rib_dest_t *zebra_rib_create_dest(struct route_node *rn);

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

#ifdef __cplusplus
}
#endif

#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"
aa57abfb	27	#include "typesafe.h"
c6ffe645	28	#include "linklist.h"
ec1a4283	29	#include "prefix.h"
9fd92e3c	30	#include "table.h"
5adc2528	31	#include "queue.h"
fb018d25	32	#include "nexthop.h"
7ee30f28	33	#include "nexthop_group.h"
244a59d2	34	#include "vrf.h"
fb148af4	35	#include "if.h"
40c7bdb0	36	#include "mpls.h"
05737783	37	#include "srcdest_table.h"
ec1a4283	38
51e94aa7 EDP	39	#ifdef __cplusplus
	40	extern "C" {
	41	#endif
	42
aa57abfb DS	43	typedef enum { RNH_NEXTHOP_TYPE, RNH_IMPORT_CHECK_TYPE } rnh_type_t;
	44
	45	PREDECL_LIST(rnh_list)
	46
	47	/* Nexthop structure. */
	48	struct rnh {
	49	uint8_t flags;
	50
	51	#define ZEBRA_NHT_CONNECTED 0x1
	52	#define ZEBRA_NHT_DELETED 0x2
	53	#define ZEBRA_NHT_EXACT_MATCH 0x4
	54
	55	/* VRF identifier. */
	56	vrf_id_t vrf_id;
	57
	58	afi_t afi;
	59
	60	rnh_type_t type;
	61
	62	uint32_t seqno;
	63
	64	struct route_entry *state;
	65	struct prefix resolved_route;
	66	struct list *client_list;
	67
	68	/* pseudowires dependent on this nh */
	69	struct list *zebra_pseudowire_list;
	70
	71	struct route_node *node;
	72
	73	/*
	74	* if this has been filtered for the client
	75	*/
	76	int filtered[ZEBRA_ROUTE_MAX];
	77
	78	struct rnh_list_item rnh_list_item;
	79	};
	80
718e3744	81	#define DISTANCE_INFINITY 255
7a4bb9c5	82	#define ZEBRA_KERNEL_TABLE_MAX 252 /* support for no more than this rt tables */
718e3744	83
045207e2 DS	84	PREDECL_LIST(re_list)
045207e2 DS	85
d62a17ae	86	struct route_entry {
d62a17ae	87	/* Link list. */
045207e2	88	struct re_list_item next;
d62a17ae	89
d62a17ae	90	/* Nexthop structure */
7ee30f28	91	struct nexthop_group ng;
d62a17ae	92
d62a17ae	93	/* Tag */
	94	route_tag_t tag;
	95
	96	/* Uptime. */
	97	time_t uptime;
	98
	99	/* Type fo this route. */
	100	int type;
	101
	102	/* Source protocol instance */
d7c0a89a	103	unsigned short instance;
d62a17ae	104
	105	/* VRF identifier. */
	106	vrf_id_t vrf_id;
	107
	108	/* Which routing table */
	109	uint32_t table;
	110
	111	/* Metric */
d7c0a89a	112	uint32_t metric;
d62a17ae	113
d62a17ae	114	/* MTU */
d7c0a89a QY	115	uint32_t mtu;
d7c0a89a QY	116	uint32_t nexthop_mtu;
d62a17ae	117
d62a17ae	118	/* Distance. */
fd289fc8	119	uint8_t distance;
d62a17ae	120
	121	/* Flags of this route.
	122	* This flag's definition is in lib/zebra.h ZEBRA_FLAG_* and is exposed
	123	* to clients via Zserv
	124	*/
d7c0a89a	125	uint32_t flags;
d62a17ae	126
d62a17ae	127	/* RIB internal status */
88f7ea31	128	uint32_t status;
f0f77c9a	129	#define ROUTE_ENTRY_REMOVED 0x1
d62a17ae	130	/* to simplify NHT logic when NHs change, instead of doing a NH by NH cmp */
f0f77c9a	131	#define ROUTE_ENTRY_NEXTHOPS_CHANGED 0x2
88f7ea31	132	/* The Route Entry has changed */
f0f77c9a	133	#define ROUTE_ENTRY_CHANGED 0x4
88f7ea31	134	/* The Label has changed on the Route entry */
5f7a4718	135	#define ROUTE_ENTRY_LABELS_CHANGED 0x8
88f7ea31 DS	136	/* Route is queued for Installation into the Data Plane */
	137	#define ROUTE_ENTRY_QUEUED 0x10
	138	/* Route is installed into the Data Plane */
	139	#define ROUTE_ENTRY_INSTALLED 0x20
	140	/* Route has Failed installation into the Data Plane in some manner */
	141	#define ROUTE_ENTRY_FAILED 0x40
6d691129	142
d62a17ae	143	/* Nexthop information. */
d7c0a89a QY	144	uint8_t nexthop_num;
d7c0a89a QY	145	uint8_t nexthop_active_num;
7cdb1a84 MS	146
	147	/* Sequence value incremented for each dataplane operation */
	148	uint32_t dplane_sequence;
718e3744	149	};
718e3744	150
e96f9203 DO	151	/* meta-queue structure:
	152	* sub-queue 0: connected, kernel
	153	* sub-queue 1: static
43cf4ba4	154	* sub-queue 2: RIP, RIPng, OSPF, OSPF6, IS-IS, EIGRP, NHRP
e96f9203 DO	155	* sub-queue 3: iBGP, eBGP
	156	* sub-queue 4: any other origin (if any)
	157	*/
	158	#define MQ_SIZE 5
d62a17ae	159	struct meta_queue {
d62a17ae	160	struct list *subq[MQ_SIZE];
d7c0a89a	161	uint32_t size; /* sum of lengths of all subqueues */
e96f9203 DO	162	};
e96f9203 DO	163
9fd92e3c AS	164	/*
	165	* Structure that represents a single destination (prefix).
	166	*/
d62a17ae	167	typedef struct rib_dest_t_ {
9fd92e3c	168
d62a17ae	169	/*
	170	* Back pointer to the route node for this destination. This helps
	171	* us get to the prefix that this structure is for.
	172	*/
	173	struct route_node *rnode;
9fd92e3c	174
d62a17ae	175	/*
	176	* Doubly-linked list of routes for this prefix.
	177	*/
045207e2	178	struct re_list_head routes;
9fd92e3c	179
5f7a4718 DS	180	struct route_entry *selected_fib;
5f7a4718 DS	181
d62a17ae	182	/*
	183	* Flags, see below.
	184	*/
d7c0a89a	185	uint32_t flags;
9fd92e3c	186
699dae23 DS	187	/*
	188	* The list of nht prefixes that have ended up
	189	* depending on this route node.
	190	* After route processing is returned from
	191	* the data plane we will run evaluate_rnh
	192	* on these prefixes.
	193	*/
aa57abfb	194	struct rnh_list_head nht;
699dae23	195
d62a17ae	196	/*
	197	* Linkage to put dest on the FPM processing queue.
	198	*/
	199	TAILQ_ENTRY(rib_dest_t_) fpm_q_entries;
5adc2528	200
9fd92e3c AS	201	} rib_dest_t;
9fd92e3c AS	202
aa57abfb	203	DECLARE_LIST(rnh_list, struct rnh, rnh_list_item);
045207e2	204	DECLARE_LIST(re_list, struct route_entry, next);
aa57abfb	205
9fd92e3c	206	#define RIB_ROUTE_QUEUED(x) (1 << (x))
1ca60f2c DS	207	// If MQ_SIZE is modified this value needs to be updated.
1ca60f2c DS	208	#define RIB_ROUTE_ANY_QUEUED 0x1F
9fd92e3c AS	209
	210	/*
	211	* The maximum qindex that can be used.
	212	*/
	213	#define ZEBRA_MAX_QINDEX (MQ_SIZE - 1)
	214
5adc2528 AS	215	/*
	216	* This flag indicates that a given prefix has been 'advertised' to
	217	* the FPM to be installed in the forwarding plane.
	218	*/
	219	#define RIB_DEST_SENT_TO_FPM (1 << (ZEBRA_MAX_QINDEX + 1))
	220
	221	/*
	222	* This flag is set when we need to send an update to the FPM about a
	223	* dest.
	224	*/
	225	#define RIB_DEST_UPDATE_FPM (1 << (ZEBRA_MAX_QINDEX + 2))
	226
a1494c25 DS	227	#define RIB_DEST_UPDATE_LSPS (1 << (ZEBRA_MAX_QINDEX + 3))
a1494c25 DS	228
9fd92e3c AS	229	/*
	230	* Macro to iterate over each route for a destination (prefix).
	231	*/
d62a17ae	232	#define RE_DEST_FOREACH_ROUTE(dest, re) \
045207e2 DS	233	for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; (re); \
045207e2 DS	234	(re) = re_list_next(&((dest)->routes), (re)))
9fd92e3c AS	235
	236	/*
	237	* Same as above, but allows the current node to be unlinked.
	238	*/
d62a17ae	239	#define RE_DEST_FOREACH_ROUTE_SAFE(dest, re, next) \
045207e2 DS	240	for ((re) = (dest) ? re_list_first(&((dest)->routes)) : NULL; \
	241	(re) && ((next) = re_list_next(&((dest)->routes), (re)), 1); \
	242	(re) = (next))
9fd92e3c	243
d62a17ae	244	#define RNODE_FOREACH_RE(rn, re) \
996c9314	245	RE_DEST_FOREACH_ROUTE (rib_dest_from_rnode(rn), re)
9fd92e3c	246
d62a17ae	247	#define RNODE_FOREACH_RE_SAFE(rn, re, next) \
996c9314	248	RE_DEST_FOREACH_ROUTE_SAFE (rib_dest_from_rnode(rn), re, next)
9fd92e3c	249
d62a17ae	250	#if defined(HAVE_RTADV)
cd80d74f	251	/* Structure which hold status of router advertisement. */
d62a17ae	252	struct rtadv {
d62a17ae	253	int sock;
cd80d74f	254
d62a17ae	255	int adv_if_count;
d62a17ae	256	int adv_msec_if_count;
cd80d74f	257
d62a17ae	258	struct thread *ra_read;
d62a17ae	259	struct thread *ra_timer;
cd80d74f	260	};
8da4e946	261	#endif /* HAVE_RTADV */
cd80d74f	262
1b5ed1b0 AS	263	/*
	264	* rib_table_info_t
	265	*
	266	* Structure that is hung off of a route_table that holds information about
	267	* the table.
	268	*/
d62a17ae	269	typedef struct rib_table_info_t_ {
1b5ed1b0	270
d62a17ae	271	/*
	272	* Back pointer to zebra_vrf.
	273	*/
	274	struct zebra_vrf *zvrf;
	275	afi_t afi;
	276	safi_t safi;
1b5ed1b0 AS	277
	278	} rib_table_info_t;
	279
d62a17ae	280	typedef enum {
	281	RIB_TABLES_ITER_S_INIT,
	282	RIB_TABLES_ITER_S_ITERATING,
	283	RIB_TABLES_ITER_S_DONE
0915bb0c AS	284	} rib_tables_iter_state_t;
	285
	286	/*
	287	* Structure that holds state for iterating over all tables in the
	288	* Routing Information Base.
	289	*/
d62a17ae	290	typedef struct rib_tables_iter_t_ {
	291	vrf_id_t vrf_id;
	292	int afi_safi_ix;
0915bb0c	293
d62a17ae	294	rib_tables_iter_state_t state;
0915bb0c AS	295	} rib_tables_iter_t;
0915bb0c AS	296
1c848137	297	/* Events/reasons triggering a RIB update. */
d62a17ae	298	typedef enum {
	299	RIB_UPDATE_IF_CHANGE,
	300	RIB_UPDATE_RMAP_CHANGE,
	301	RIB_UPDATE_OTHER
1c848137	302	} rib_update_event_t;
1c848137	303
072834ca DS	304	extern struct nexthop route_entry_nexthop_ifindex_add(struct route_entry re,
072834ca DS	305	ifindex_t ifindex,
4a7371e9	306	vrf_id_t nh_vrf_id);
072834ca DS	307	extern struct nexthop *
	308	route_entry_nexthop_blackhole_add(struct route_entry *re,
	309	enum blackhole_type bh_type);
	310	extern struct nexthop route_entry_nexthop_ipv4_add(struct route_entry re,
	311	struct in_addr *ipv4,
	312	struct in_addr *src,
4a7371e9	313	vrf_id_t nh_vrf_id);
d62a17ae	314	extern struct nexthop *
072834ca DS	315	route_entry_nexthop_ipv4_ifindex_add(struct route_entry *re,
	316	struct in_addr ipv4, struct in_addr src,
	317	ifindex_t ifindex, vrf_id_t nh_vrf_id);
d62a17ae	318	extern void route_entry_nexthop_delete(struct route_entry *re,
d62a17ae	319	struct nexthop *nexthop);
072834ca DS	320	extern struct nexthop route_entry_nexthop_ipv6_add(struct route_entry re,
072834ca DS	321	struct in6_addr *ipv6,
4a7371e9	322	vrf_id_t nh_vrf_id);
d62a17ae	323	extern struct nexthop *
d62a17ae	324	route_entry_nexthop_ipv6_ifindex_add(struct route_entry *re,
4a7371e9 DS	325	struct in6_addr *ipv6, ifindex_t ifindex,
4a7371e9 DS	326	vrf_id_t nh_vrf_id);
d62a17ae	327	extern void route_entry_nexthop_add(struct route_entry *re,
	328	struct nexthop *nexthop);
	329	extern void route_entry_copy_nexthops(struct route_entry *re,
	330	struct nexthop *nh);
f0f77c9a DS	331
f0f77c9a DS	332	#define route_entry_dump(prefix, src, re) _route_entry_dump(__func__, prefix, src, re)
072834ca DS	333	extern void _route_entry_dump(const char *func, union prefixconstptr pp,
	334	union prefixconstptr src_pp,
	335	const struct route_entry *re);
4623d897	336	/* RPF lookup behaviour */
d62a17ae	337	enum multicast_mode {
	338	MCAST_NO_CONFIG = 0, /* MIX_MRIB_FIRST, but no show in config write */
	339	MCAST_MRIB_ONLY, /* MRIB only */
	340	MCAST_URIB_ONLY, /* URIB only */
	341	MCAST_MIX_MRIB_FIRST, /* MRIB, if nothing at all then URIB */
	342	MCAST_MIX_DISTANCE, /* MRIB & URIB, lower distance wins */
	343	MCAST_MIX_PFXLEN, /* MRIB & URIB, longer prefix wins */
	344	/* on equal value, MRIB wins for last 2 */
4623d897 DL	345	};
4623d897 DL	346
d62a17ae	347	extern void multicast_mode_ipv4_set(enum multicast_mode mode);
d62a17ae	348	extern enum multicast_mode multicast_mode_ipv4_get(void);
4623d897	349
072834ca DS	350	extern void rib_lookup_and_dump(struct prefix_ipv4 *p, vrf_id_t vrf_id);
072834ca DS	351	extern void rib_lookup_and_pushup(struct prefix_ipv4 *p, vrf_id_t vrf_id);
f0f77c9a	352
dc95824a DO	353	#define ZEBRA_RIB_LOOKUP_ERROR -1
	354	#define ZEBRA_RIB_FOUND_EXACT 0
	355	#define ZEBRA_RIB_FOUND_NOGATE 1
	356	#define ZEBRA_RIB_FOUND_CONNECTED 2
	357	#define ZEBRA_RIB_NOTFOUND 3
	358
d7c0a89a QY	359	extern int is_zebra_valid_kernel_table(uint32_t table_id);
d7c0a89a QY	360	extern int is_zebra_main_routing_table(uint32_t table_id);
86391e56	361	extern int zebra_check_addr(const struct prefix *p);
718e3744	362
d62a17ae	363	extern void rib_delnode(struct route_node rn, struct route_entry re);
0c555cc6 DS	364	extern void rib_install_kernel(struct route_node rn, struct route_entry re,
	365	struct route_entry *old);
	366	extern void rib_uninstall_kernel(struct route_node rn, struct route_entry re);
28f6dde8	367
d24af186	368	/* NOTE:
b4c034b0	369	* All rib_add function will not just add prefix into RIB, but
d24af186	370	* also implicitly withdraw equal prefix of same type. */
4a7371e9	371	extern int rib_add(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
d7c0a89a	372	unsigned short instance, int flags, struct prefix *p,
fd36be7e	373	struct prefix_ipv6 src_p, const struct nexthop nh,
d7c0a89a	374	uint32_t table_id, uint32_t metric, uint32_t mtu,
4e40b6d6	375	uint8_t distance, route_tag_t tag);
d62a17ae	376
072834ca DS	377	extern int rib_add_multipath(afi_t afi, safi_t safi, struct prefix *p,
072834ca DS	378	struct prefix_ipv6 src_p, struct route_entry re);
d62a17ae	379
d62a17ae	380	extern void rib_delete(afi_t afi, safi_t safi, vrf_id_t vrf_id, int type,
d7c0a89a	381	unsigned short instance, int flags, struct prefix *p,
fd36be7e	382	struct prefix_ipv6 src_p, const struct nexthop nh,
40ecd8e4 DS	383	uint32_t table_id, uint32_t metric, uint8_t distance,
40ecd8e4 DS	384	bool fromkernel);
d62a17ae	385
072834ca DS	386	extern struct route_entry *rib_match(afi_t afi, safi_t safi, vrf_id_t vrf_id,
072834ca DS	387	union g_addr *addr,
d62a17ae	388	struct route_node **rn_out);
	389	extern struct route_entry *rib_match_ipv4_multicast(vrf_id_t vrf_id,
	390	struct in_addr addr,
	391	struct route_node **rn_out);
	392
072834ca DS	393	extern struct route_entry rib_lookup_ipv4(struct prefix_ipv4 p,
072834ca DS	394	vrf_id_t vrf_id);
d62a17ae	395
072834ca	396	extern void rib_update(vrf_id_t vrf_id, rib_update_event_t event);
d5b8c216	397	extern void rib_update_table(struct route_table *table,
d5b8c216	398	rib_update_event_t event);
d62a17ae	399	extern void rib_sweep_route(void);
072834ca DS	400	extern void rib_sweep_table(struct route_table *table);
072834ca DS	401	extern void rib_close_table(struct route_table *table);
d62a17ae	402	extern void rib_init(void);
d7c0a89a QY	403	extern unsigned long rib_score_proto(uint8_t proto, unsigned short instance);
	404	extern unsigned long rib_score_proto_table(uint8_t proto,
	405	unsigned short instance,
47a08aa9	406	struct route_table *table);
d62a17ae	407	extern void rib_queue_add(struct route_node *rn);
	408	extern void meta_queue_free(struct meta_queue *mq);
	409	extern int zebra_rib_labeled_unicast(struct route_entry *re);
718e3744	410	extern struct route_table *rib_table_ipv6;
718e3744	411
072834ca	412	extern void rib_unlink(struct route_node rn, struct route_entry re);
d62a17ae	413	extern int rib_gc_dest(struct route_node *rn);
d62a17ae	414	extern struct route_table rib_tables_iter_next(rib_tables_iter_t iter);
9fd92e3c	415
fd289fc8	416	extern uint8_t route_distance(int type);
40c7bdb0	417
699dae23 DS	418	extern void zebra_rib_evaluate_rn_nexthops(struct route_node *rn, uint32_t seq);
699dae23 DS	419
9fd92e3c AS	420	/*
	421	* Inline functions.
	422	*/
	423
1b5ed1b0 AS	424	/*
	425	* rib_table_info
	426	*/
d62a17ae	427	static inline rib_table_info_t rib_table_info(struct route_table table)
1b5ed1b0	428	{
6ca30e9e	429	return (rib_table_info_t *)route_table_get_info(table);
1b5ed1b0 AS	430	}
1b5ed1b0 AS	431
9fd92e3c AS	432	/*
	433	* rib_dest_from_rnode
	434	*/
d62a17ae	435	static inline rib_dest_t rib_dest_from_rnode(struct route_node rn)
9fd92e3c	436	{
d62a17ae	437	return (rib_dest_t *)rn->info;
9fd92e3c AS	438	}
	439
	440	/*
	441	* rnode_to_ribs
	442	*
	443	* Returns a pointer to the list of routes corresponding to the given
	444	* route_node.
	445	*/
d62a17ae	446	static inline struct route_entry rnode_to_ribs(struct route_node rn)
9fd92e3c	447	{
d62a17ae	448	rib_dest_t *dest;
9fd92e3c	449
d62a17ae	450	dest = rib_dest_from_rnode(rn);
	451	if (!dest)
	452	return NULL;
9fd92e3c	453
045207e2	454	return re_list_first(&dest->routes);
9fd92e3c AS	455	}
	456
	457	/*
	458	* rib_dest_prefix
	459	*/
d62a17ae	460	static inline struct prefix rib_dest_prefix(rib_dest_t dest)
9fd92e3c	461	{
d62a17ae	462	return &dest->rnode->p;
9fd92e3c AS	463	}
	464
	465	/*
	466	* rib_dest_af
	467	*
	468	* Returns the address family that the destination is for.
	469	*/
d7c0a89a	470	static inline uint8_t rib_dest_af(rib_dest_t *dest)
9fd92e3c	471	{
d62a17ae	472	return dest->rnode->p.family;
9fd92e3c AS	473	}
	474
	475	/*
	476	* rib_dest_table
	477	*/
d62a17ae	478	static inline struct route_table rib_dest_table(rib_dest_t dest)
9fd92e3c	479	{
d62a17ae	480	return srcdest_rnode_table(dest->rnode);
9fd92e3c AS	481	}
9fd92e3c AS	482
1b5ed1b0 AS	483	/*
	484	* rib_dest_vrf
	485	*/
d62a17ae	486	static inline struct zebra_vrf rib_dest_vrf(rib_dest_t dest)
1b5ed1b0	487	{
d62a17ae	488	return rib_table_info(rib_dest_table(dest))->zvrf;
1b5ed1b0 AS	489	}
1b5ed1b0 AS	490
434434f7 DS	491	/*
	492	* Create the rib_dest_t and attach it to the specified node
	493	*/
	494	extern rib_dest_t zebra_rib_create_dest(struct route_node rn);
	495
0915bb0c AS	496	/*
	497	* rib_tables_iter_init
	498	*/
d62a17ae	499	static inline void rib_tables_iter_init(rib_tables_iter_t *iter)
0915bb0c AS	500
0915bb0c AS	501	{
d62a17ae	502	memset(iter, 0, sizeof(*iter));
d62a17ae	503	iter->state = RIB_TABLES_ITER_S_INIT;
0915bb0c AS	504	}
	505
	506	/*
	507	* rib_tables_iter_started
	508	*
	509	* Returns TRUE if this iterator has started iterating over the set of
	510	* tables.
	511	*/
d62a17ae	512	static inline int rib_tables_iter_started(rib_tables_iter_t *iter)
0915bb0c	513	{
d62a17ae	514	return iter->state != RIB_TABLES_ITER_S_INIT;
0915bb0c AS	515	}
	516
	517	/*
	518	* rib_tables_iter_cleanup
	519	*/
d62a17ae	520	static inline void rib_tables_iter_cleanup(rib_tables_iter_t *iter)
0915bb0c	521	{
d62a17ae	522	iter->state = RIB_TABLES_ITER_S_DONE;
0915bb0c AS	523	}
0915bb0c AS	524
d62a17ae	525	DECLARE_HOOK(rib_update, (struct route_node * rn, const char *reason),
d62a17ae	526	(rn, reason))
4f8ea50c	527
05f7f5db DS	528
05f7f5db DS	529	extern void zebra_vty_init(void);
4060008b	530
05f7f5db DS	531	extern pid_t pid;
05f7f5db DS	532
6b093863	533	extern bool v6_rr_semantics;
51e94aa7 EDP	534
	535	#ifdef __cplusplus
	536	}
	537	#endif
	538
718e3744	539	#endif /_ZEBRA_RIB_H /