[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,
	bgp_show_type_detail,
};


#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_NCODE_HEADER "Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self\n"
#define BGP_SHOW_HEADER "   Network          Next Hop            Metric LocPrf Weight Path\n"

/* Maximum number of labels we can process or send with a prefix. We
 * really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
 */
#define BGP_MAX_LABELS 2

/* 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.  */
	uint32_t igpmetric;

	/* MPLS label(s) - VNI(s) for EVPN-VxLAN  */
	mpls_label_t label[BGP_MAX_LABELS];
	uint32_t num_labels;

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

	/*
	 * Some tunnelish parameters follow. Maybe consolidate into an
	 * internal tunnel structure?
	 */

	/*
	 * Original bgp instance for imported routes. Needed for:
	 * 1. Find all routes from a specific vrf for deletion
	 * 2. vrf context of original nexthop
	 *
	 * Store pointer to bgp instance rather than bgp->vrf_id because
	 * bgp->vrf_id is not always valid (or may change?).
	 *
	 * Set to NULL if route is not imported from another bgp instance.
	 */
	struct bgp *bgp_orig;

	/*
	 * Nexthop in context of original bgp instance. Needed
	 * for label resolution of core mpls routes exported to a vrf.
	 * Set nexthop_orig.family to 0 if not valid.
	 */
	struct prefix nexthop_orig;
};

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.  */
	uint16_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)
#define BGP_INFO_ANNC_NH_SELF   (1 << 14)

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

	/* When above type is BGP.  This sub type specify BGP sub type
	   information.  */
	uint8_t 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
#define BGP_ROUTE_IMPORTED     5        /* from another bgp instance/safi */

	unsigned short instance;

	/* Addpath identifiers */
	uint32_t addpath_rx_id;
	uint32_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. */
	uint32_t label_index;
#define BGP_INVALID_LABEL_INDEX   0xFFFFFFFF

	/* Import check status.  */
	uint8_t valid;

	/* IGP metric. */
	uint32_t igpmetric;

	/* IGP nexthop. */
	struct in_addr igpnexthop;

	/* Atomic set reference count (ie cause of pathlimit) */
	uint32_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
	    || safi == SAFI_FLOWSPEC)
		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 *, uint32_t);
extern void bgp_info_unset_flag(struct bgp_node *, struct bgp_info *, uint32_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 *bgp, struct prefix *p,
				 const union g_addr *nexthop, ifindex_t ifindex,
				 enum nexthop_types_t nhtype, uint32_t metric,
				 uint8_t type, unsigned short instance,
				 route_tag_t tag);
extern void bgp_redistribute_delete(struct bgp *, struct prefix *, uint8_t,
				    unsigned short);
extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, unsigned 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 *, uint32_t, struct attr *,
		      afi_t, safi_t, int, int, struct prefix_rd *,
		      mpls_label_t *, uint32_t, int, struct bgp_route_evpn *);
extern int bgp_withdraw(struct peer *, struct prefix *, uint32_t, struct attr *,
			afi_t, safi_t, int, int, struct prefix_rd *,
			mpls_label_t *, uint32_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 uint8_t 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,
				  unsigned 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, uint8_t, 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,
					      uint32_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_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);
extern int bgp_show_table_rd(struct vty *vty, struct bgp *bgp, safi_t safi,
			     struct bgp_table *table, struct prefix_rd *prd,
			     enum bgp_show_type type, void *output_arg,
			     uint8_t use_json);
#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,
dba3c1d3 PG	51	bgp_show_type_damp_neighbor,
dba3c1d3 PG	52	bgp_show_type_detail,
b2f0fa55 PG	53	};
	54
	55
d62a17ae	56	#define BGP_SHOW_SCODE_HEADER \
9df8b37c	57	"Status codes: s suppressed, d damped, " \
d62a17ae	58	"h history, * valid, > best, = multipath,\n" \
9df8b37c PZ	59	" i internal, r RIB-failure, S Stale, R Removed\n"
	60	#define BGP_SHOW_OCODE_HEADER "Origin codes: i - IGP, e - EGP, ? - incomplete\n\n"
	61	#define BGP_SHOW_NCODE_HEADER "Nexthop codes: @NNN nexthop's vrf id, < announce-nh-self\n"
181039f3	62	#define BGP_SHOW_HEADER " Network Next Hop Metric LocPrf Weight Path\n"
3f9c7369	63
b57ba6d2 MK	64	/* Maximum number of labels we can process or send with a prefix. We
	65	* really do only 1 for MPLS (BGP-LU) but we can do 2 for EVPN-VxLAN.
	66	*/
	67	#define BGP_MAX_LABELS 2
	68
d62a17ae	69	/* Ancillary information to struct bgp_info,
fb982c25 PJ	70	* used for uncommonly used data (aggregation, MPLS, etc.)
	71	* and lazily allocated to save memory.
	72	*/
d62a17ae	73	struct bgp_info_extra {
	74	/* Pointer to dampening structure. */
	75	struct bgp_damp_info *damp_info;
fb982c25	76
d62a17ae	77	/* This route is suppressed with aggregation. */
d62a17ae	78	int suppress;
fb982c25	79
d62a17ae	80	/* Nexthop reachability check. */
d7c0a89a	81	uint32_t igpmetric;
fb982c25	82
b57ba6d2 MK	83	/* MPLS label(s) - VNI(s) for EVPN-VxLAN */
b57ba6d2 MK	84	mpls_label_t label[BGP_MAX_LABELS];
d7c0a89a	85	uint32_t num_labels;
342dd0c6	86
65efcfce	87	#if ENABLE_BGP_VNC
d62a17ae	88	union {
	89
	90	struct {
	91	void rfapi_handle; / export: NVE advertising this
	92	route */
	93	struct list local_nexthops; / optional, for static
	94	routes */
	95	} export;
	96
	97	struct {
	98	struct thread *timer;
	99	void hme; / encap monitor, if this is a VPN route */
	100	struct prefix_rd
	101	rd; /* import: route's route-distinguisher */
d7c0a89a	102	uint8_t un_family; /* family of cached un address, 0 if
d62a17ae	103	unset */
	104	union {
	105	struct in_addr addr4;
	106	struct in6_addr addr6;
	107	} un; /* cached un address */
	108	time_t create_time;
996c9314 LB	109	struct prefix aux_prefix; /* AFI_L2VPN: the IP addr,
996c9314 LB	110	if family set */
d62a17ae	111	} import;
	112
	113	} vnc;
65efcfce	114	#endif
128ea8ab	115
d62a17ae	116	/* For imported routes into a VNI (or VRF), this points to the parent.
	117	*/
	118	void *parent;
ddb5b488 PZ	119
	120	/*
	121	* Some tunnelish parameters follow. Maybe consolidate into an
	122	* internal tunnel structure?
	123	*/
	124
	125	/*
	126	* Original bgp instance for imported routes. Needed for:
	127	* 1. Find all routes from a specific vrf for deletion
	128	* 2. vrf context of original nexthop
	129	*
	130	* Store pointer to bgp instance rather than bgp->vrf_id because
	131	* bgp->vrf_id is not always valid (or may change?).
	132	*
	133	* Set to NULL if route is not imported from another bgp instance.
	134	*/
	135	struct bgp *bgp_orig;
	136
	137	/*
	138	* Nexthop in context of original bgp instance. Needed
	139	* for label resolution of core mpls routes exported to a vrf.
	140	* Set nexthop_orig.family to 0 if not valid.
	141	*/
	142	struct prefix nexthop_orig;
fb982c25 PJ	143	};
fb982c25 PJ	144
d62a17ae	145	struct bgp_info {
	146	/* For linked list. */
	147	struct bgp_info *next;
	148	struct bgp_info *prev;
	149
	150	/* For nexthop linked list */
	151	LIST_ENTRY(bgp_info) nh_thread;
	152
	153	/* Back pointer to the prefix node */
	154	struct bgp_node *net;
	155
	156	/* Back pointer to the nexthop structure */
	157	struct bgp_nexthop_cache *nexthop;
fb018d25	158
d62a17ae	159	/* Peer structure. */
d62a17ae	160	struct peer *peer;
fb018d25	161
d62a17ae	162	/* Attribute structure. */
d62a17ae	163	struct attr *attr;
fb018d25	164
d62a17ae	165	/* Extra information */
d62a17ae	166	struct bgp_info_extra *extra;
fb018d25	167
cbdfbaa5	168
d62a17ae	169	/* Multipath information */
d62a17ae	170	struct bgp_info_mpath *mpath;
de8d5dff	171
d62a17ae	172	/* Uptime. */
d62a17ae	173	time_t uptime;
de8d5dff	174
d62a17ae	175	/* reference count */
d62a17ae	176	int lock;
cbdfbaa5	177
d62a17ae	178	/* BGP information status. */
d7c0a89a	179	uint16_t flags;
718e3744	180	#define BGP_INFO_IGP_CHANGED (1 << 0)
	181	#define BGP_INFO_DAMPED (1 << 1)
	182	#define BGP_INFO_HISTORY (1 << 2)
	183	#define BGP_INFO_SELECTED (1 << 3)
	184	#define BGP_INFO_VALID (1 << 4)
	185	#define BGP_INFO_ATTR_CHANGED (1 << 5)
	186	#define BGP_INFO_DMED_CHECK (1 << 6)
	187	#define BGP_INFO_DMED_SELECTED (1 << 7)
93406d87	188	#define BGP_INFO_STALE (1 << 8)
b40d939b	189	#define BGP_INFO_REMOVED (1 << 9)
902212c3	190	#define BGP_INFO_COUNTED (1 << 10)
de8d5dff JB	191	#define BGP_INFO_MULTIPATH (1 << 11)
de8d5dff JB	192	#define BGP_INFO_MULTIPATH_CHG (1 << 12)
cd1964ff	193	#define BGP_INFO_RIB_ATTR_CHG (1 << 13)
960035b2	194	#define BGP_INFO_ANNC_NH_SELF (1 << 14)
718e3744	195
d62a17ae	196	/* BGP route type. This can be static, RIP, OSPF, BGP etc. */
d7c0a89a	197	uint8_t type;
cbdfbaa5	198
d62a17ae	199	/* When above type is BGP. This sub type specify BGP sub type
d62a17ae	200	information. */
d7c0a89a	201	uint8_t sub_type;
cbdfbaa5 PJ	202	#define BGP_ROUTE_NORMAL 0
	203	#define BGP_ROUTE_STATIC 1
	204	#define BGP_ROUTE_AGGREGATE 2
	205	#define BGP_ROUTE_REDISTRIBUTE 3
65efcfce LB	206	#ifdef ENABLE_BGP_VNC
	207	# define BGP_ROUTE_RFP 4
	208	#endif
ddb5b488	209	#define BGP_ROUTE_IMPORTED 5 /* from another bgp instance/safi */
7c8ff89e	210
d7c0a89a	211	unsigned short instance;
a82478b9	212
d62a17ae	213	/* Addpath identifiers */
d7c0a89a QY	214	uint32_t addpath_rx_id;
d7c0a89a QY	215	uint32_t addpath_tx_id;
718e3744	216	};
718e3744	217
128ea8ab	218	/* Structure used in BGP path selection */
d62a17ae	219	struct bgp_info_pair {
	220	struct bgp_info *old;
	221	struct bgp_info *new;
128ea8ab	222	};
128ea8ab	223
718e3744	224	/* BGP static route configuration. */
d62a17ae	225	struct bgp_static {
	226	/* Backdoor configuration. */
	227	int backdoor;
718e3744	228
d62a17ae	229	/* Label index configuration; applies to LU prefixes. */
d7c0a89a	230	uint32_t label_index;
1b6d5c7e VV	231	#define BGP_INVALID_LABEL_INDEX 0xFFFFFFFF
1b6d5c7e VV	232
d62a17ae	233	/* Import check status. */
d7c0a89a	234	uint8_t valid;
718e3744	235
d62a17ae	236	/* IGP metric. */
d7c0a89a	237	uint32_t igpmetric;
718e3744	238
d62a17ae	239	/* IGP nexthop. */
d62a17ae	240	struct in_addr igpnexthop;
718e3744	241
d62a17ae	242	/* Atomic set reference count (ie cause of pathlimit) */
d7c0a89a	243	uint32_t atomic;
718e3744	244
d62a17ae	245	/* BGP redistribute route-map. */
	246	struct {
	247	char *name;
	248	struct route_map *map;
	249	} rmap;
137446f9	250
d62a17ae	251	/* Route Distinguisher */
d62a17ae	252	struct prefix_rd prd;
684a7227	253
d62a17ae	254	/* MPLS label. */
	255	mpls_label_t label;
	256
	257	/* EVPN */
	258	struct eth_segment_id *eth_s_id;
	259	struct ethaddr *router_mac;
	260	uint16_t encap_tunneltype;
	261	struct prefix gatewayIp;
718e3744	262	};
718e3744	263
d62a17ae	264	#define BGP_NEXTHOP_AFI_FROM_NHLEN(nhlen) \
	265	((nhlen) < IPV4_MAX_BYTELEN \
	266	? 0 \
	267	: ((nhlen) < IPV6_MAX_BYTELEN ? AFI_IP : AFI_IP6))
fe3ca08f	268
d62a17ae	269	#define BGP_ATTR_NEXTHOP_AFI_IP6(attr) \
	270	(!CHECK_FLAG(attr->flag, ATTR_FLAG_BIT(BGP_ATTR_NEXT_HOP)) \
	271	&& ((attr)->mp_nexthop_len == 16 \|\| (attr)->mp_nexthop_len == 32))
	272	#define BGP_INFO_COUNTABLE(BI) \
	273	(!CHECK_FLAG((BI)->flags, BGP_INFO_HISTORY) \
	274	&& !CHECK_FLAG((BI)->flags, BGP_INFO_REMOVED))
80e0ad24	275
1a392d46	276	/* Flags which indicate a route is unuseable in some form */
d62a17ae	277	#define BGP_INFO_UNUSEABLE \
d62a17ae	278	(BGP_INFO_HISTORY \| BGP_INFO_DAMPED \| BGP_INFO_REMOVED)
1a392d46 PJ	279	/* Macro to check BGP information is alive or not. Sadly,
	280	* not equivalent to just checking previous, because of the
	281	* sense of the additional VALID flag.
	282	*/
d62a17ae	283	#define BGP_INFO_HOLDDOWN(BI) \
	284	(!CHECK_FLAG((BI)->flags, BGP_INFO_VALID) \
	285	\|\| CHECK_FLAG((BI)->flags, BGP_INFO_UNUSEABLE))
1a392d46	286
718e3744	287	#define DISTRIBUTE_IN_NAME(F) ((F)->dlist[FILTER_IN].name)
	288	#define DISTRIBUTE_IN(F) ((F)->dlist[FILTER_IN].alist)
	289	#define DISTRIBUTE_OUT_NAME(F) ((F)->dlist[FILTER_OUT].name)
	290	#define DISTRIBUTE_OUT(F) ((F)->dlist[FILTER_OUT].alist)
	291
	292	#define PREFIX_LIST_IN_NAME(F) ((F)->plist[FILTER_IN].name)
	293	#define PREFIX_LIST_IN(F) ((F)->plist[FILTER_IN].plist)
	294	#define PREFIX_LIST_OUT_NAME(F) ((F)->plist[FILTER_OUT].name)
	295	#define PREFIX_LIST_OUT(F) ((F)->plist[FILTER_OUT].plist)
	296
	297	#define FILTER_LIST_IN_NAME(F) ((F)->aslist[FILTER_IN].name)
	298	#define FILTER_LIST_IN(F) ((F)->aslist[FILTER_IN].aslist)
	299	#define FILTER_LIST_OUT_NAME(F) ((F)->aslist[FILTER_OUT].name)
	300	#define FILTER_LIST_OUT(F) ((F)->aslist[FILTER_OUT].aslist)
	301
fee0f4c6	302	#define ROUTE_MAP_IN_NAME(F) ((F)->map[RMAP_IN].name)
	303	#define ROUTE_MAP_IN(F) ((F)->map[RMAP_IN].map)
	304	#define ROUTE_MAP_OUT_NAME(F) ((F)->map[RMAP_OUT].name)
	305	#define ROUTE_MAP_OUT(F) ((F)->map[RMAP_OUT].map)
	306
718e3744	307	#define UNSUPPRESS_MAP_NAME(F) ((F)->usmap.name)
	308	#define UNSUPPRESS_MAP(F) ((F)->usmap.map)
	309
2ec1e66f DW	310	/* path PREFIX (addpath rxid NUMBER) */
	311	#define PATH_ADDPATH_STR_BUFFER PREFIX2STR_BUFFER + 32
	312
d62a17ae	313	enum bgp_path_type { BGP_PATH_ALL, BGP_PATH_BESTPATH, BGP_PATH_MULTIPATH };
4092b06c	314
d62a17ae	315	static inline void bgp_bump_version(struct bgp_node *node)
3f9c7369	316	{
d62a17ae	317	node->version = bgp_table_next_version(bgp_node_table(node));
3f9c7369 DS	318	}
3f9c7369 DS	319
d62a17ae	320	static inline int bgp_fibupd_safi(safi_t safi)
cd1964ff	321	{
d62a17ae	322	if (safi == SAFI_UNICAST \|\| safi == SAFI_MULTICAST
529efa23 PG	323	\|\| safi == SAFI_LABELED_UNICAST
529efa23 PG	324	\|\| safi == SAFI_FLOWSPEC)
d62a17ae	325	return 1;
d62a17ae	326	return 0;
cd1964ff DS	327	}
cd1964ff DS	328
718e3744	329	/* Prototypes. */
db0e1937 MK	330	extern void bgp_rib_remove(struct bgp_node rn, struct bgp_info ri,
db0e1937 MK	331	struct peer *peer, afi_t afi, safi_t safi);
d62a17ae	332	extern void bgp_process_queue_init(void);
	333	extern void bgp_route_init(void);
	334	extern void bgp_route_finish(void);
	335	extern void bgp_cleanup_routes(struct bgp *);
	336	extern void bgp_announce_route(struct peer *, afi_t, safi_t);
3f9c7369	337	extern void bgp_stop_announce_route_timer(struct peer_af *paf);
d62a17ae	338	extern void bgp_announce_route_all(struct peer *);
	339	extern void bgp_default_originate(struct peer *, afi_t, safi_t, int);
	340	extern void bgp_soft_reconfig_in(struct peer *, afi_t, safi_t);
	341	extern void bgp_clear_route(struct peer *, afi_t, safi_t);
	342	extern void bgp_clear_route_all(struct peer *);
	343	extern void bgp_clear_adj_in(struct peer *, afi_t, safi_t);
	344	extern void bgp_clear_stale_route(struct peer *, afi_t, safi_t);
	345
	346	extern struct bgp_node bgp_afi_node_get(struct bgp_table table, afi_t afi,
	347	safi_t safi, struct prefix *p,
	348	struct prefix_rd *prd);
	349	extern struct bgp_info bgp_info_lock(struct bgp_info );
	350	extern struct bgp_info bgp_info_unlock(struct bgp_info );
	351	extern void bgp_info_add(struct bgp_node rn, struct bgp_info ri);
	352	extern void bgp_info_reap(struct bgp_node rn, struct bgp_info ri);
	353	extern void bgp_info_delete(struct bgp_node rn, struct bgp_info ri);
	354	extern struct bgp_info_extra bgp_info_extra_get(struct bgp_info );
d7c0a89a QY	355	extern void bgp_info_set_flag(struct bgp_node , struct bgp_info , uint32_t);
d7c0a89a QY	356	extern void bgp_info_unset_flag(struct bgp_node , struct bgp_info , uint32_t);
d62a17ae	357	extern void bgp_info_path_with_addpath_rx_str(struct bgp_info ri, char buf);
	358
	359	extern int bgp_nlri_parse_ip(struct peer , struct attr , struct bgp_nlri *);
	360
	361	extern int bgp_maximum_prefix_overflow(struct peer *, afi_t, safi_t, int);
	362
9de1f7ff DS	363	extern void bgp_redistribute_add(struct bgp bgp, struct prefix p,
	364	const union g_addr *nexthop, ifindex_t ifindex,
	365	enum nexthop_types_t nhtype, uint32_t metric,
d7c0a89a	366	uint8_t type, unsigned short instance,
9de1f7ff	367	route_tag_t tag);
d7c0a89a QY	368	extern void bgp_redistribute_delete(struct bgp , struct prefix , uint8_t,
	369	unsigned short);
	370	extern void bgp_redistribute_withdraw(struct bgp *, afi_t, int, unsigned short);
d62a17ae	371
	372	extern void bgp_static_add(struct bgp *);
	373	extern void bgp_static_delete(struct bgp *);
	374	extern void bgp_static_redo_import_check(struct bgp *);
	375	extern void bgp_purge_static_redist_routes(struct bgp *bgp);
	376	extern void bgp_static_update(struct bgp , struct prefix ,
	377	struct bgp_static *, afi_t, safi_t);
	378	extern void bgp_static_withdraw(struct bgp , struct prefix , afi_t, safi_t);
	379
	380	extern int bgp_static_set_safi(afi_t afi, safi_t safi, struct vty *vty,
	381	const char , const char , const char *,
	382	const char , int, const char , const char *,
	383	const char , const char );
	384
	385	extern int bgp_static_unset_safi(afi_t afi, safi_t safi, struct vty *,
	386	const char , const char , const char *, int,
	387	const char , const char , const char *);
718e3744	388
94f2b392	389	/* this is primarily for MPLS-VPN */
d7c0a89a	390	extern int bgp_update(struct peer , struct prefix , uint32_t, struct attr *,
d62a17ae	391	afi_t, safi_t, int, int, struct prefix_rd *,
d7c0a89a QY	392	mpls_label_t , uint32_t, int, struct bgp_route_evpn );
	393	extern int bgp_withdraw(struct peer , struct prefix , uint32_t, struct attr *,
	394	afi_t, safi_t, int, int, struct prefix_rd *,
	395	mpls_label_t , uint32_t, struct bgp_route_evpn );
718e3744	396
94f2b392	397	/* for bgp_nexthop and bgp_damp */
d62a17ae	398	extern void bgp_process(struct bgp , struct bgp_node , afi_t, safi_t);
cb1faec9 DS	399
	400	/*
	401	* Add an end-of-initial-update marker to the process queue. This is just a
	402	* queue element with NULL bgp node.
	403	*/
d62a17ae	404	extern void bgp_add_eoiu_mark(struct bgp *);
60466a63 QY	405	extern void bgp_config_write_table_map(struct vty , struct bgp , afi_t,
60466a63 QY	406	safi_t);
2b791107	407	extern void bgp_config_write_network(struct vty , struct bgp , afi_t, safi_t);
60466a63 QY	408	extern void bgp_config_write_distance(struct vty , struct bgp , afi_t,
60466a63 QY	409	safi_t);
d62a17ae	410
	411	extern void bgp_aggregate_increment(struct bgp , struct prefix ,
	412	struct bgp_info *, afi_t, safi_t);
	413	extern void bgp_aggregate_decrement(struct bgp , struct prefix ,
	414	struct bgp_info *, afi_t, safi_t);
	415
d7c0a89a QY	416	extern uint8_t bgp_distance_apply(struct prefix , struct bgp_info , afi_t,
d7c0a89a QY	417	safi_t, struct bgp *);
d62a17ae	418
	419	extern afi_t bgp_node_afi(struct vty *);
	420	extern safi_t bgp_node_safi(struct vty *);
	421
d7c0a89a QY	422	extern struct bgp_info *info_make(int type, int sub_type,
	423	unsigned short instance, struct peer *peer,
	424	struct attr attr, struct bgp_node rn);
d62a17ae	425
	426	extern void route_vty_out(struct vty , struct prefix , struct bgp_info *, int,
	427	safi_t, json_object *);
	428	extern void route_vty_out_tag(struct vty , struct prefix , struct bgp_info *,
	429	int, safi_t, json_object *);
	430	extern void route_vty_out_tmp(struct vty , struct prefix , struct attr *,
d7c0a89a	431	safi_t, uint8_t, json_object *);
d62a17ae	432	extern void route_vty_out_overlay(struct vty vty, struct prefix p,
	433	struct bgp_info *binfo, int display,
	434	json_object *json);
	435
	436	extern int subgroup_process_announce_selected(struct update_subgroup *subgrp,
	437	struct bgp_info *selected,
	438	struct bgp_node *rn,
d7c0a89a	439	uint32_t addpath_tx_id);
3f9c7369	440
cd1964ff	441	extern int subgroup_announce_check(struct bgp_node rn, struct bgp_info ri,
3f9c7369 DS	442	struct update_subgroup *subgrp,
	443	struct prefix p, struct attr attr);
	444
d62a17ae	445	extern void bgp_peer_clear_node_queue_drain_immediate(struct peer *peer);
d62a17ae	446	extern void bgp_process_queues_drain_immediate(void);
bb86c601	447
65efcfce	448	/* for encap/vpn */
d62a17ae	449	extern struct bgp_node bgp_afi_node_lookup(struct bgp_table table, afi_t afi,
	450	safi_t safi, struct prefix *p,
	451	struct prefix_rd *prd);
	452	extern struct bgp_info *bgp_info_new(void);
	453	extern void bgp_info_restore(struct bgp_node , struct bgp_info );
	454
	455	extern int bgp_info_cmp_compatible(struct bgp , struct bgp_info ,
	456	struct bgp_info , char pfx_buf, afi_t afi,
	457	safi_t safi);
7f323236	458	extern void bgp_attr_add_gshut_community(struct attr *attr);
d62a17ae	459
	460	extern void bgp_best_selection(struct bgp bgp, struct bgp_node rn,
	461	struct bgp_maxpaths_cfg *mpath_cfg,
	462	struct bgp_info_pair *result, afi_t afi,
	463	safi_t safi);
	464	extern void bgp_zebra_clear_route_change_flags(struct bgp_node *rn);
	465	extern int bgp_zebra_has_route_changed(struct bgp_node *rn,
	466	struct bgp_info *selected);
	467
	468	extern void route_vty_out_detail_header(struct vty vty, struct bgp bgp,
	469	struct bgp_node *rn,
	470	struct prefix_rd *prd, afi_t afi,
	471	safi_t safi, json_object *json);
	472	extern void route_vty_out_detail(struct vty vty, struct bgp bgp,
	473	struct prefix p, struct bgp_info binfo,
	474	afi_t afi, safi_t safi,
	475	json_object *json_paths);
1ae44dfc LB	476	extern int bgp_show_table_rd(struct vty vty, struct bgp bgp, safi_t safi,
	477	struct bgp_table table, struct prefix_rd prd,
	478	enum bgp_show_type type, void *output_arg,
d7c0a89a	479	uint8_t use_json);
00d252cb	480	#endif /* _QUAGGA_BGP_ROUTE_H */