[mirror_frr.git] / bgpd / bgp_route.h

/* BGP routing information base
 * Copyright (C) 1996, 97, 98, 2000 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 _QUAGGA_BGP_ROUTE_H
#define _QUAGGA_BGP_ROUTE_H

#include "queue.h"
#include "nexthop.h"
#include "bgp_table.h"

struct bgp_nexthop_cache;
struct bgp_route_evpn;

enum bgp_show_type {
	bgp_show_type_normal,
	bgp_show_type_regexp,
	bgp_show_type_prefix_list,
	bgp_show_type_filter_list,
	bgp_show_type_route_map,
	bgp_show_type_neighbor,
	bgp_show_type_cidr_only,
	bgp_show_type_prefix_longer,
	bgp_show_type_community_all,
	bgp_show_type_community,
	bgp_show_type_community_exact,
	bgp_show_type_community_list,
	bgp_show_type_community_list_exact,
	bgp_show_type_lcommunity_all,
	bgp_show_type_lcommunity,
	bgp_show_type_lcommunity_list,
	bgp_show_type_flap_statistics,
	bgp_show_type_flap_neighbor,
	bgp_show_type_dampend_paths,
	bgp_show_type_damp_neighbor
};


#define BGP_SHOW_SCODE_HEADER                                                  \
	"Status codes: s suppressed, d damped, "                               \
	"h history, * valid, > best, = multipath,\n"                           \
	"              i internal, r RIB-failure, S Stale, R Removed\n"
#define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
#define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path\n"

/* Ancillary information to struct bgp_info,
 * used for uncommonly used data (aggregation, MPLS, etc.)
 * and lazily allocated to save memory.
 */
struct bgp_info_extra {
	/* Pointer to dampening structure.  */
	struct bgp_damp_info *damp_info;

	/* This route is suppressed with aggregation.  */
	int suppress;

	/* Nexthop reachability check.  */
	u_int32_t igpmetric;

	/* MPLS label.  */
	mpls_label_t label;

#if ENABLE_BGP_VNC
	union {

		struct {
			void *rfapi_handle; /* export: NVE advertising this
					       route */
			struct list *local_nexthops; /* optional, for static
							routes */
		} export;

		struct {
			struct thread *timer;
			void *hme; /* encap monitor, if this is a VPN route */
			struct prefix_rd
				rd; /* import: route's route-distinguisher */
			u_char un_family; /* family of cached un address, 0 if
					     unset */
			union {
				struct in_addr addr4;
				struct in6_addr addr6;
			} un; /* cached un address */
			time_t create_time;
			struct
				prefix
					aux_prefix; /* AFI_L2VPN: the IP addr,
						       if family set */
		} import;

	} vnc;
#endif

	/* For imported routes into a VNI (or VRF), this points to the parent.
	 */
	void *parent;
};

struct bgp_info {
	/* For linked list. */
	struct bgp_info *next;
	struct bgp_info *prev;

	/* For nexthop linked list */
	LIST_ENTRY(bgp_info) nh_thread;

	/* Back pointer to the prefix node */
	struct bgp_node *net;

	/* Back pointer to the nexthop structure */
	struct bgp_nexthop_cache *nexthop;

	/* Peer structure.  */
	struct peer *peer;

	/* Attribute structure.  */
	struct attr *attr;

	/* Extra information */
	struct bgp_info_extra *extra;


	/* Multipath information */
	struct bgp_info_mpath *mpath;

	/* Uptime.  */
	time_t uptime;

	/* reference count */
	int lock;

	/* BGP information status.  */
	u_int16_t flags;
#define BGP_INFO_IGP_CHANGED    (1 << 0)
#define BGP_INFO_DAMPED         (1 << 1)
#define BGP_INFO_HISTORY        (1 << 2)
#define BGP_INFO_SELECTED       (1 << 3)
#define BGP_INFO_VALID          (1 << 4)
#define BGP_INFO_ATTR_CHANGED   (1 << 5)
#define BGP_INFO_DMED_CHECK     (1 << 6)
#define BGP_INFO_DMED_SELECTED  (1 << 7)
#define BGP_INFO_STALE          (1 << 8)
#define BGP_INFO_REMOVED        (1 << 9)
#define BGP_INFO_COUNTED	(1 << 10)
#define BGP_INFO_MULTIPATH      (1 << 11)
#define BGP_INFO_MULTIPATH_CHG  (1 << 12)
#define BGP_INFO_RIB_ATTR_CHG   (1 << 13)

	/* BGP route type.  This can be static, RIP, OSPF, BGP etc.  */
	u_char type;

	/* When above type is BGP.  This sub type specify BGP sub type
	   information.  */
	u_char sub_type;
#define BGP_ROUTE_NORMAL       0
#define BGP_ROUTE_STATIC       1
#define BGP_ROUTE_AGGREGATE    2
#define BGP_ROUTE_REDISTRIBUTE 3 
#ifdef ENABLE_BGP_VNC
# define BGP_ROUTE_RFP          4 
#endif

	u_short instance;

	/* Addpath identifiers */
	u_int32_t addpath_rx_id;
	u_int32_t addpath_tx_id;
};

/* Structure used in BGP path selection */
struct bgp_info_pair {
	struct bgp_info *old;
	struct bgp_info *new;
};

/* BGP static route configuration. */
struct bgp_static {
	/* Backdoor configuration.  */
	int backdoor;

	/* Label index configuration; applies to LU prefixes. */
	u_int32_t label_index;
#define BGP_INVALID_LABEL_INDEX   0xFFFFFFFF

	/* Import check status.  */
	u_char valid;

	/* IGP metric. */
	u_int32_t igpmetric;

	/* IGP nexthop. */
	struct in_addr igpnexthop;

	/* Atomic set reference count (ie cause of pathlimit) */
	u_int32_t atomic;

	/* BGP redistribute route-map.  */
	struct {
		char *name;
		struct route_map *map;
	} rmap;

	/* Route Distinguisher */
	struct prefix_rd prd;

	/* MPLS label.  */
	mpls_label_t label;

	/* EVPN */
	struct eth_segment_id *eth_s_id;
	struct ethaddr *router_mac;
	uint16_t encap_tunneltype;
	struct prefix gatewayIp;
};

#define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen)                                      \
	((nhlen) < IPV4_MAX_BYTELEN                                            \
		 ? 0                                                           \
		 : ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))

#define BGP_ATTR_NEXTHOP_AFI_IP6(attr)                                         \
	(!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP))             \
	 && ((attr)->mp_nexthop_len == 16 || (attr)->mp_nexthop_len == 32))
#define BGP_INFO_COUNTABLE(BI)                                                 \
	(!CHECK_FLAG((BI)->flags, BGP_INFO_HISTORY)                            \
	 && !CHECK_FLAG((BI)->flags, BGP_INFO_REMOVED))

/* Flags which indicate a route is unuseable in some form */
#define BGP_INFO_UNUSEABLE                                                     \
	(BGP_INFO_HISTORY | BGP_INFO_DAMPED | BGP_INFO_REMOVED)
/* Macro to check BGP information is alive or not.  Sadly,
 * not equivalent to just checking previous, because of the
 * sense of the additional VALID flag.
 */
#define BGP_INFO_HOLDDOWN(BI)                                                  \
	(!CHECK_FLAG((BI)->flags, BGP_INFO_VALID)                              \
	 || CHECK_FLAG((BI)->flags, BGP_INFO_UNUSEABLE))

#define DISTRIBUTE_IN_NAME(F)   ((F)->dlist[FILTER_IN].name)
#define DISTRIBUTE_IN(F)        ((F)->dlist[FILTER_IN].alist)
#define DISTRIBUTE_OUT_NAME(F)  ((F)->dlist[FILTER_OUT].name)
#define DISTRIBUTE_OUT(F)       ((F)->dlist[FILTER_OUT].alist)

#define PREFIX_LIST_IN_NAME(F)  ((F)->plist[FILTER_IN].name)
#define PREFIX_LIST_IN(F)       ((F)->plist[FILTER_IN].plist)
#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
#define PREFIX_LIST_OUT(F)      ((F)->plist[FILTER_OUT].plist)

#define FILTER_LIST_IN_NAME(F)  ((F)->aslist[FILTER_IN].name)
#define FILTER_LIST_IN(F)       ((F)->aslist[FILTER_IN].aslist)
#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
#define FILTER_LIST_OUT(F)      ((F)->aslist[FILTER_OUT].aslist)

#define ROUTE_MAP_IN_NAME(F)    ((F)->map[RMAP_IN].name)
#define ROUTE_MAP_IN(F)         ((F)->map[RMAP_IN].map)
#define ROUTE_MAP_OUT_NAME(F)   ((F)->map[RMAP_OUT].name)
#define ROUTE_MAP_OUT(F)        ((F)->map[RMAP_OUT].map)

#define UNSUPPRESS_MAP_NAME(F)  ((F)->usmap.name)
#define UNSUPPRESS_MAP(F)       ((F)->usmap.map)

/* path PREFIX (addpath rxid NUMBER) */
#define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32

enum bgp_path_type { BGP_PATH_ALL, BGP_PATH_BESTPATH, BGP_PATH_MULTIPATH };

static inline void bgp_bump_version(struct bgp_node *node)
{
	node->version = bgp_table_next_version(bgp_node_table(node));
}

static inline int bgp_fibupd_safi(safi_t safi)
{
	if (safi == SAFI_UNICAST || safi == SAFI_MULTICAST
	    || safi == SAFI_LABELED_UNICAST)
		return 1;
	return 0;
}

/* Prototypes. */
extern void bgp_rib_remove(struct bgp_node *rn, struct bgp_info *ri,
			   struct peer *peer, afi_t afi, safi_t safi);
extern void bgp_process_queue_init(void);
extern void bgp_route_init(void);
extern void bgp_route_finish(void);
extern void bgp_cleanup_routes(struct bgp *);
extern void bgp_announce_route(struct peer *, afi_t, safi_t);
extern void bgp_stop_announce_route_timer(struct peer_af *paf);
extern void bgp_announce_route_all(struct peer *);
extern void bgp_default_originate(struct peer *, afi_t, safi_t, int);
extern void bgp_soft_reconfig_in(struct peer *, afi_t, safi_t);
extern void bgp_clear_route(struct peer *, afi_t, safi_t);
extern void bgp_clear_route_all(struct peer *);
extern void bgp_clear_adj_in(struct peer *, afi_t, safi_t);
extern void bgp_clear_stale_route(struct peer *, afi_t, safi_t);

extern struct bgp_node *bgp_afi_node_get(struct bgp_table *table, afi_t afi,
					 safi_t safi, struct prefix *p,
					 struct prefix_rd *prd);
extern struct bgp_info *bgp_info_lock(struct bgp_info *);
extern struct bgp_info *bgp_info_unlock(struct bgp_info *);
extern void bgp_info_add(struct bgp_node *rn, struct bgp_info *ri);
extern void bgp_info_reap(struct bgp_node *rn, struct bgp_info *ri);
extern void bgp_info_delete(struct bgp_node *rn, struct bgp_info *ri);
extern struct bgp_info_extra *bgp_info_extra_get(struct bgp_info *);
extern void bgp_info_set_flag(struct bgp_node *, struct bgp_info *, u_int32_t);
extern void bgp_info_unset_flag(struct bgp_node *, struct bgp_info *,
				u_int32_t);
extern void bgp_info_path_with_addpath_rx_str(struct bgp_info *ri, char *buf);

extern int bgp_nlri_parse_ip(struct peer *, struct attr *, struct bgp_nlri *);

extern int bgp_maximum_prefix_overflow(struct peer *, afi_t, safi_t, int);

extern void bgp_redistribute_add(struct bgp *, struct prefix *,
				 const union g_addr *, unsigned int ifindex,
				 u_int32_t, u_char, u_short, route_tag_t);
extern void bgp_redistribute_delete(struct bgp *, struct prefix *, u_char,
				    u_short);
extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, u_short);

extern void bgp_static_add(struct bgp *);
extern void bgp_static_delete(struct bgp *);
extern void bgp_static_redo_import_check(struct bgp *);
extern void bgp_purge_static_redist_routes(struct bgp *bgp);
extern void bgp_static_update(struct bgp *, struct prefix *,
			      struct bgp_static *, afi_t, safi_t);
extern void bgp_static_withdraw(struct bgp *, struct prefix *, afi_t, safi_t);

extern int bgp_static_set_safi(afi_t afi, safi_t safi, struct vty *vty,
			       const char *, const char *, const char *,
			       const char *, int, const char *, const char *,
			       const char *, const char *);

extern int bgp_static_unset_safi(afi_t afi, safi_t safi, struct vty *,
				 const char *, const char *, const char *, int,
				 const char *, const char *, const char *);

/* this is primarily for MPLS-VPN */
extern int bgp_update(struct peer *, struct prefix *, u_int32_t, struct attr *,
		      afi_t, safi_t, int, int, struct prefix_rd *,
		      mpls_label_t *, int, struct bgp_route_evpn *);
extern int bgp_withdraw(struct peer *, struct prefix *, u_int32_t,
			struct attr *, afi_t, safi_t, int, int,
			struct prefix_rd *, mpls_label_t *,
			struct bgp_route_evpn *);

/* for bgp_nexthop and bgp_damp */
extern void bgp_process(struct bgp *, struct bgp_node *, afi_t, safi_t);

/*
 * Add an end-of-initial-update marker to the process queue. This is just a
 * queue element with NULL bgp node.
 */
extern void bgp_add_eoiu_mark(struct bgp *);
extern void bgp_config_write_table_map(struct vty *, struct bgp *, afi_t,
				       safi_t);
extern void bgp_config_write_network(struct vty *, struct bgp *, afi_t, safi_t);
extern void bgp_config_write_distance(struct vty *, struct bgp *, afi_t,
				      safi_t);

extern void bgp_aggregate_increment(struct bgp *, struct prefix *,
				    struct bgp_info *, afi_t, safi_t);
extern void bgp_aggregate_decrement(struct bgp *, struct prefix *,
				    struct bgp_info *, afi_t, safi_t);

extern u_char bgp_distance_apply(struct prefix *, struct bgp_info *, afi_t,
				 safi_t, struct bgp *);

extern afi_t bgp_node_afi(struct vty *);
extern safi_t bgp_node_safi(struct vty *);

extern struct bgp_info *info_make(int type, int sub_type, u_short instance,
				  struct peer *peer, struct attr *attr,
				  struct bgp_node *rn);

extern void route_vty_out(struct vty *, struct prefix *, struct bgp_info *, int,
			  safi_t, json_object *);
extern void route_vty_out_tag(struct vty *, struct prefix *, struct bgp_info *,
			      int, safi_t, json_object *);
extern void route_vty_out_tmp(struct vty *, struct prefix *, struct attr *,
			      safi_t, u_char, json_object *);
extern void route_vty_out_overlay(struct vty *vty, struct prefix *p,
				  struct bgp_info *binfo, int display,
				  json_object *json);

extern int subgroup_process_announce_selected(struct update_subgroup *subgrp,
					      struct bgp_info *selected,
					      struct bgp_node *rn,
					      u_int32_t addpath_tx_id);

extern int subgroup_announce_check(struct bgp_node *rn, struct bgp_info *ri,
				   struct update_subgroup *subgrp,
				   struct prefix *p, struct attr *attr);

extern void bgp_peer_clear_node_queue_drain_immediate(struct peer *peer);
extern void bgp_process_queues_drain_immediate(void);

/* for encap/vpn */
extern struct bgp_node *bgp_afi_node_get(struct bgp_table *, afi_t, safi_t,
					 struct prefix *, struct prefix_rd *);
extern struct bgp_node *bgp_afi_node_lookup(struct bgp_table *table, afi_t afi,
					    safi_t safi, struct prefix *p,
					    struct prefix_rd *prd);
extern struct bgp_info *bgp_info_new(void);
extern void bgp_info_restore(struct bgp_node *, struct bgp_info *);

extern int bgp_info_cmp_compatible(struct bgp *, struct bgp_info *,
				   struct bgp_info *, char *pfx_buf, afi_t afi,
				   safi_t safi);
extern void bgp_attr_add_gshut_community(struct attr *attr);

extern void bgp_best_selection(struct bgp *bgp, struct bgp_node *rn,
			       struct bgp_maxpaths_cfg *mpath_cfg,
			       struct bgp_info_pair *result, afi_t afi,
			       safi_t safi);
extern void bgp_zebra_clear_route_change_flags(struct bgp_node *rn);
extern int bgp_zebra_has_route_changed(struct bgp_node *rn,
				       struct bgp_info *selected);

extern void route_vty_out_detail_header(struct vty *vty, struct bgp *bgp,
					struct bgp_node *rn,
					struct prefix_rd *prd, afi_t afi,
					safi_t safi, json_object *json);
extern void route_vty_out_detail(struct vty *vty, struct bgp *bgp,
				 struct prefix *p, struct bgp_info *binfo,
				 afi_t afi, safi_t safi,
				 json_object *json_paths);
#endif /* _QUAGGA_BGP_ROUTE_H */
Commit	Line	Data
718e3744	1	/* BGP routing information base
896014f4 DL	2	* Copyright (C) 1996, 97, 98, 2000 Kunihiro Ishiguro
	3	*
	4	* This file is part of GNU Zebra.
	5	*
	6	* GNU Zebra is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2, or (at your option) any
	9	* later version.
	10	*
	11	* GNU Zebra is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	* General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License along
	17	* with this program; see the file COPYING; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
718e3744	20
00d252cb	21	#ifndef _QUAGGA_BGP_ROUTE_H
	22	#define _QUAGGA_BGP_ROUTE_H
	23
fb018d25	24	#include "queue.h"
74489921	25	#include "nexthop.h"
200df115	26	#include "bgp_table.h"
200df115	27
fb018d25	28	struct bgp_nexthop_cache;
7ef5a232	29	struct bgp_route_evpn;
fb018d25	30
d62a17ae	31	enum bgp_show_type {
	32	bgp_show_type_normal,
	33	bgp_show_type_regexp,
	34	bgp_show_type_prefix_list,
	35	bgp_show_type_filter_list,
	36	bgp_show_type_route_map,
	37	bgp_show_type_neighbor,
	38	bgp_show_type_cidr_only,
	39	bgp_show_type_prefix_longer,
	40	bgp_show_type_community_all,
	41	bgp_show_type_community,
	42	bgp_show_type_community_exact,
	43	bgp_show_type_community_list,
	44	bgp_show_type_community_list_exact,
	45	bgp_show_type_lcommunity_all,
	46	bgp_show_type_lcommunity,
	47	bgp_show_type_lcommunity_list,
	48	bgp_show_type_flap_statistics,
	49	bgp_show_type_flap_neighbor,
	50	bgp_show_type_dampend_paths,
	51	bgp_show_type_damp_neighbor
b2f0fa55 PG	52	};
	53
	54
d62a17ae	55	#define BGP_SHOW_SCODE_HEADER \
	56	"Status codes: s suppressed, d damped, " \
	57	"h history, * valid, > best, = multipath,\n" \
	58	" i internal, r RIB-failure, S Stale, R Removed\n"
181039f3 DL	59	#define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
181039f3 DL	60	#define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path\n"
3f9c7369	61
d62a17ae	62	/* Ancillary information to struct bgp_info,
fb982c25 PJ	63	* used for uncommonly used data (aggregation, MPLS, etc.)
	64	* and lazily allocated to save memory.
	65	*/
d62a17ae	66	struct bgp_info_extra {
	67	/* Pointer to dampening structure. */
	68	struct bgp_damp_info *damp_info;
fb982c25	69
d62a17ae	70	/* This route is suppressed with aggregation. */
d62a17ae	71	int suppress;
fb982c25	72
d62a17ae	73	/* Nexthop reachability check. */
d62a17ae	74	u_int32_t igpmetric;
fb982c25	75
d62a17ae	76	/* MPLS label. */
d62a17ae	77	mpls_label_t label;
65efcfce LB	78
65efcfce LB	79	#if ENABLE_BGP_VNC
d62a17ae	80	union {
	81
	82	struct {
	83	void rfapi_handle; / export: NVE advertising this
	84	route */
	85	struct list local_nexthops; / optional, for static
	86	routes */
	87	} export;
	88
	89	struct {
	90	struct thread *timer;
	91	void hme; / encap monitor, if this is a VPN route */
	92	struct prefix_rd
	93	rd; /* import: route's route-distinguisher */
	94	u_char un_family; /* family of cached un address, 0 if
	95	unset */
	96	union {
	97	struct in_addr addr4;
	98	struct in6_addr addr6;
	99	} un; /* cached un address */
	100	time_t create_time;
9d303b37 DL	101	struct
	102	prefix
	103	aux_prefix; /* AFI_L2VPN: the IP addr,
	104	if family set */
d62a17ae	105	} import;
	106
	107	} vnc;
65efcfce	108	#endif
128ea8ab	109
d62a17ae	110	/* For imported routes into a VNI (or VRF), this points to the parent.
	111	*/
	112	void *parent;
fb982c25 PJ	113	};
fb982c25 PJ	114
d62a17ae	115	struct bgp_info {
	116	/* For linked list. */
	117	struct bgp_info *next;
	118	struct bgp_info *prev;
	119
	120	/* For nexthop linked list */
	121	LIST_ENTRY(bgp_info) nh_thread;
	122
	123	/* Back pointer to the prefix node */
	124	struct bgp_node *net;
	125
	126	/* Back pointer to the nexthop structure */
	127	struct bgp_nexthop_cache *nexthop;
fb018d25	128
d62a17ae	129	/* Peer structure. */
d62a17ae	130	struct peer *peer;
fb018d25	131
d62a17ae	132	/* Attribute structure. */
d62a17ae	133	struct attr *attr;
fb018d25	134
d62a17ae	135	/* Extra information */
d62a17ae	136	struct bgp_info_extra *extra;
fb018d25	137
cbdfbaa5	138
d62a17ae	139	/* Multipath information */
d62a17ae	140	struct bgp_info_mpath *mpath;
de8d5dff	141
d62a17ae	142	/* Uptime. */
d62a17ae	143	time_t uptime;
de8d5dff	144
d62a17ae	145	/* reference count */
d62a17ae	146	int lock;
cbdfbaa5	147
d62a17ae	148	/* BGP information status. */
d62a17ae	149	u_int16_t flags;
718e3744	150	#define BGP_INFO_IGP_CHANGED (1 << 0)
	151	#define BGP_INFO_DAMPED (1 << 1)
	152	#define BGP_INFO_HISTORY (1 << 2)
	153	#define BGP_INFO_SELECTED (1 << 3)
	154	#define BGP_INFO_VALID (1 << 4)
	155	#define BGP_INFO_ATTR_CHANGED (1 << 5)
	156	#define BGP_INFO_DMED_CHECK (1 << 6)
	157	#define BGP_INFO_DMED_SELECTED (1 << 7)
93406d87	158	#define BGP_INFO_STALE (1 << 8)
b40d939b	159	#define BGP_INFO_REMOVED (1 << 9)
902212c3	160	#define BGP_INFO_COUNTED (1 << 10)
de8d5dff JB	161	#define BGP_INFO_MULTIPATH (1 << 11)
de8d5dff JB	162	#define BGP_INFO_MULTIPATH_CHG (1 << 12)
cd1964ff	163	#define BGP_INFO_RIB_ATTR_CHG (1 << 13)
718e3744	164
d62a17ae	165	/* BGP route type. This can be static, RIP, OSPF, BGP etc. */
d62a17ae	166	u_char type;
cbdfbaa5	167
d62a17ae	168	/* When above type is BGP. This sub type specify BGP sub type
	169	information. */
	170	u_char sub_type;
cbdfbaa5 PJ	171	#define BGP_ROUTE_NORMAL 0
	172	#define BGP_ROUTE_STATIC 1
	173	#define BGP_ROUTE_AGGREGATE 2
	174	#define BGP_ROUTE_REDISTRIBUTE 3
65efcfce LB	175	#ifdef ENABLE_BGP_VNC
	176	# define BGP_ROUTE_RFP 4
	177	#endif
7c8ff89e	178
d62a17ae	179	u_short instance;
a82478b9	180
d62a17ae	181	/* Addpath identifiers */
	182	u_int32_t addpath_rx_id;
	183	u_int32_t addpath_tx_id;
718e3744	184	};
718e3744	185
128ea8ab	186	/* Structure used in BGP path selection */
d62a17ae	187	struct bgp_info_pair {
	188	struct bgp_info *old;
	189	struct bgp_info *new;
128ea8ab	190	};
128ea8ab	191
718e3744	192	/* BGP static route configuration. */
d62a17ae	193	struct bgp_static {
	194	/* Backdoor configuration. */
	195	int backdoor;
718e3744	196
d62a17ae	197	/* Label index configuration; applies to LU prefixes. */
d62a17ae	198	u_int32_t label_index;
1b6d5c7e VV	199	#define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
1b6d5c7e VV	200
d62a17ae	201	/* Import check status. */
d62a17ae	202	u_char valid;
718e3744	203
d62a17ae	204	/* IGP metric. */
d62a17ae	205	u_int32_t igpmetric;
718e3744	206
d62a17ae	207	/* IGP nexthop. */
d62a17ae	208	struct in_addr igpnexthop;
718e3744	209
d62a17ae	210	/* Atomic set reference count (ie cause of pathlimit) */
d62a17ae	211	u_int32_t atomic;
718e3744	212
d62a17ae	213	/* BGP redistribute route-map. */
	214	struct {
	215	char *name;
	216	struct route_map *map;
	217	} rmap;
137446f9	218
d62a17ae	219	/* Route Distinguisher */
d62a17ae	220	struct prefix_rd prd;
684a7227	221
d62a17ae	222	/* MPLS label. */
	223	mpls_label_t label;
	224
	225	/* EVPN */
	226	struct eth_segment_id *eth_s_id;
	227	struct ethaddr *router_mac;
	228	uint16_t encap_tunneltype;
	229	struct prefix gatewayIp;
718e3744	230	};
718e3744	231
d62a17ae	232	#define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
	233	((nhlen) < IPV4_MAX_BYTELEN \
	234	? 0 \
	235	: ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
fe3ca08f	236
d62a17ae	237	#define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
	238	(!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP)) \
	239	&& ((attr)->mp_nexthop_len == 16 \|\| (attr)->mp_nexthop_len == 32))
	240	#define BGP_INFO_COUNTABLE(BI) \
	241	(!CHECK_FLAG((BI)->flags, BGP_INFO_HISTORY) \
	242	&& !CHECK_FLAG((BI)->flags, BGP_INFO_REMOVED))
80e0ad24	243
1a392d46	244	/* Flags which indicate a route is unuseable in some form */
d62a17ae	245	#define BGP_INFO_UNUSEABLE \
d62a17ae	246	(BGP_INFO_HISTORY \| BGP_INFO_DAMPED \| BGP_INFO_REMOVED)
1a392d46 PJ	247	/* Macro to check BGP information is alive or not. Sadly,
	248	* not equivalent to just checking previous, because of the
	249	* sense of the additional VALID flag.
	250	*/
d62a17ae	251	#define BGP_INFO_HOLDDOWN(BI) \
	252	(!CHECK_FLAG((BI)->flags, BGP_INFO_VALID) \
	253	\|\| CHECK_FLAG((BI)->flags, BGP_INFO_UNUSEABLE))
1a392d46	254
718e3744	255	#define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
	256	#define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
	257	#define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
	258	#define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
	259
	260	#define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
	261	#define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
	262	#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
	263	#define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
	264
	265	#define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
	266	#define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
	267	#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
	268	#define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
	269
fee0f4c6	270	#define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
	271	#define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
	272	#define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
	273	#define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
	274
718e3744	275	#define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
	276	#define UNSUPPRESS_MAP(F) ((F)->usmap.map)
	277
2ec1e66f DW	278	/* path PREFIX (addpath rxid NUMBER) */
	279	#define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
	280
d62a17ae	281	enum bgp_path_type { BGP_PATH_ALL, BGP_PATH_BESTPATH, BGP_PATH_MULTIPATH };
4092b06c	282
d62a17ae	283	static inline void bgp_bump_version(struct bgp_node *node)
3f9c7369	284	{
d62a17ae	285	node->version = bgp_table_next_version(bgp_node_table(node));
3f9c7369 DS	286	}
3f9c7369 DS	287
d62a17ae	288	static inline int bgp_fibupd_safi(safi_t safi)
cd1964ff	289	{
d62a17ae	290	if (safi == SAFI_UNICAST \|\| safi == SAFI_MULTICAST
	291	\|\| safi == SAFI_LABELED_UNICAST)
	292	return 1;
	293	return 0;
cd1964ff DS	294	}
cd1964ff DS	295
718e3744	296	/* Prototypes. */
db0e1937 MK	297	extern void bgp_rib_remove(struct bgp_node rn, struct bgp_info ri,
db0e1937 MK	298	struct peer *peer, afi_t afi, safi_t safi);
d62a17ae	299	extern void bgp_process_queue_init(void);
	300	extern void bgp_route_init(void);
	301	extern void bgp_route_finish(void);
	302	extern void bgp_cleanup_routes(struct bgp *);
	303	extern void bgp_announce_route(struct peer *, afi_t, safi_t);
3f9c7369	304	extern void bgp_stop_announce_route_timer(struct peer_af *paf);
d62a17ae	305	extern void bgp_announce_route_all(struct peer *);
	306	extern void bgp_default_originate(struct peer *, afi_t, safi_t, int);
	307	extern void bgp_soft_reconfig_in(struct peer *, afi_t, safi_t);
	308	extern void bgp_clear_route(struct peer *, afi_t, safi_t);
	309	extern void bgp_clear_route_all(struct peer *);
	310	extern void bgp_clear_adj_in(struct peer *, afi_t, safi_t);
	311	extern void bgp_clear_stale_route(struct peer *, afi_t, safi_t);
	312
	313	extern struct bgp_node bgp_afi_node_get(struct bgp_table table, afi_t afi,
	314	safi_t safi, struct prefix *p,
	315	struct prefix_rd *prd);
	316	extern struct bgp_info bgp_info_lock(struct bgp_info );
	317	extern struct bgp_info bgp_info_unlock(struct bgp_info );
	318	extern void bgp_info_add(struct bgp_node rn, struct bgp_info ri);
	319	extern void bgp_info_reap(struct bgp_node rn, struct bgp_info ri);
	320	extern void bgp_info_delete(struct bgp_node rn, struct bgp_info ri);
	321	extern struct bgp_info_extra bgp_info_extra_get(struct bgp_info );
	322	extern void bgp_info_set_flag(struct bgp_node , struct bgp_info , u_int32_t);
	323	extern void bgp_info_unset_flag(struct bgp_node , struct bgp_info ,
	324	u_int32_t);
	325	extern void bgp_info_path_with_addpath_rx_str(struct bgp_info ri, char buf);
	326
	327	extern int bgp_nlri_parse_ip(struct peer , struct attr , struct bgp_nlri *);
	328
	329	extern int bgp_maximum_prefix_overflow(struct peer *, afi_t, safi_t, int);
	330
	331	extern void bgp_redistribute_add(struct bgp , struct prefix ,
74489921	332	const union g_addr *, unsigned int ifindex,
d62a17ae	333	u_int32_t, u_char, u_short, route_tag_t);
	334	extern void bgp_redistribute_delete(struct bgp , struct prefix , u_char,
	335	u_short);
	336	extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, u_short);
	337
	338	extern void bgp_static_add(struct bgp *);
	339	extern void bgp_static_delete(struct bgp *);
	340	extern void bgp_static_redo_import_check(struct bgp *);
	341	extern void bgp_purge_static_redist_routes(struct bgp *bgp);
	342	extern void bgp_static_update(struct bgp , struct prefix ,
	343	struct bgp_static *, afi_t, safi_t);
	344	extern void bgp_static_withdraw(struct bgp , struct prefix , afi_t, safi_t);
	345
	346	extern int bgp_static_set_safi(afi_t afi, safi_t safi, struct vty *vty,
	347	const char , const char , const char *,
	348	const char , int, const char , const char *,
	349	const char , const char );
	350
	351	extern int bgp_static_unset_safi(afi_t afi, safi_t safi, struct vty *,
	352	const char , const char , const char *, int,
	353	const char , const char , const char *);
718e3744	354
94f2b392	355	/* this is primarily for MPLS-VPN */
d62a17ae	356	extern int bgp_update(struct peer , struct prefix , u_int32_t, struct attr *,
	357	afi_t, safi_t, int, int, struct prefix_rd *,
	358	mpls_label_t , int, struct bgp_route_evpn );
	359	extern int bgp_withdraw(struct peer , struct prefix , u_int32_t,
	360	struct attr *, afi_t, safi_t, int, int,
	361	struct prefix_rd , mpls_label_t ,
	362	struct bgp_route_evpn *);
718e3744	363
94f2b392	364	/* for bgp_nexthop and bgp_damp */
d62a17ae	365	extern void bgp_process(struct bgp , struct bgp_node , afi_t, safi_t);
cb1faec9 DS	366
	367	/*
	368	* Add an end-of-initial-update marker to the process queue. This is just a
	369	* queue element with NULL bgp node.
	370	*/
d62a17ae	371	extern void bgp_add_eoiu_mark(struct bgp *);
60466a63 QY	372	extern void bgp_config_write_table_map(struct vty , struct bgp , afi_t,
60466a63 QY	373	safi_t);
2b791107	374	extern void bgp_config_write_network(struct vty , struct bgp , afi_t, safi_t);
60466a63 QY	375	extern void bgp_config_write_distance(struct vty , struct bgp , afi_t,
60466a63 QY	376	safi_t);
d62a17ae	377
	378	extern void bgp_aggregate_increment(struct bgp , struct prefix ,
	379	struct bgp_info *, afi_t, safi_t);
	380	extern void bgp_aggregate_decrement(struct bgp , struct prefix ,
	381	struct bgp_info *, afi_t, safi_t);
	382
	383	extern u_char bgp_distance_apply(struct prefix , struct bgp_info , afi_t,
	384	safi_t, struct bgp *);
	385
	386	extern afi_t bgp_node_afi(struct vty *);
	387	extern safi_t bgp_node_safi(struct vty *);
	388
	389	extern struct bgp_info *info_make(int type, int sub_type, u_short instance,
	390	struct peer peer, struct attr attr,
	391	struct bgp_node *rn);
	392
	393	extern void route_vty_out(struct vty , struct prefix , struct bgp_info *, int,
	394	safi_t, json_object *);
	395	extern void route_vty_out_tag(struct vty , struct prefix , struct bgp_info *,
	396	int, safi_t, json_object *);
	397	extern void route_vty_out_tmp(struct vty , struct prefix , struct attr *,
	398	safi_t, u_char, json_object *);
	399	extern void route_vty_out_overlay(struct vty vty, struct prefix p,
	400	struct bgp_info *binfo, int display,
	401	json_object *json);
	402
	403	extern int subgroup_process_announce_selected(struct update_subgroup *subgrp,
	404	struct bgp_info *selected,
	405	struct bgp_node *rn,
	406	u_int32_t addpath_tx_id);
3f9c7369	407
cd1964ff	408	extern int subgroup_announce_check(struct bgp_node rn, struct bgp_info ri,
3f9c7369 DS	409	struct update_subgroup *subgrp,
	410	struct prefix p, struct attr attr);
	411
d62a17ae	412	extern void bgp_peer_clear_node_queue_drain_immediate(struct peer *peer);
d62a17ae	413	extern void bgp_process_queues_drain_immediate(void);
bb86c601	414
65efcfce	415	/* for encap/vpn */
d62a17ae	416	extern struct bgp_node bgp_afi_node_get(struct bgp_table , afi_t, safi_t,
	417	struct prefix , struct prefix_rd );
	418	extern struct bgp_node bgp_afi_node_lookup(struct bgp_table table, afi_t afi,
	419	safi_t safi, struct prefix *p,
	420	struct prefix_rd *prd);
	421	extern struct bgp_info *bgp_info_new(void);
	422	extern void bgp_info_restore(struct bgp_node , struct bgp_info );
	423
	424	extern int bgp_info_cmp_compatible(struct bgp , struct bgp_info ,
	425	struct bgp_info , char pfx_buf, afi_t afi,
	426	safi_t safi);
7f323236	427	extern void bgp_attr_add_gshut_community(struct attr *attr);
d62a17ae	428
	429	extern void bgp_best_selection(struct bgp bgp, struct bgp_node rn,
	430	struct bgp_maxpaths_cfg *mpath_cfg,
	431	struct bgp_info_pair *result, afi_t afi,
	432	safi_t safi);
	433	extern void bgp_zebra_clear_route_change_flags(struct bgp_node *rn);
	434	extern int bgp_zebra_has_route_changed(struct bgp_node *rn,
	435	struct bgp_info *selected);
	436
	437	extern void route_vty_out_detail_header(struct vty vty, struct bgp bgp,
	438	struct bgp_node *rn,
	439	struct prefix_rd *prd, afi_t afi,
	440	safi_t safi, json_object *json);
	441	extern void route_vty_out_detail(struct vty vty, struct bgp bgp,
	442	struct prefix p, struct bgp_info binfo,
	443	afi_t afi, safi_t safi,
	444	json_object *json_paths);
00d252cb	445	#endif /* _QUAGGA_BGP_ROUTE_H */