[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"
#include "bgp_addpath_types.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,
};

enum bgp_show_adj_route_type {
	bgp_show_adj_route_advertised,
	bgp_show_adj_route_received,
	bgp_show_adj_route_filtered,
};


#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_path_info,
 * used for uncommonly used data (aggregation, MPLS, etc.)
 * and lazily allocated to save memory.
 */
struct bgp_path_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;
	/* presence of FS pbr firewall based entry */
	struct list *bgp_fs_pbr;
	/* presence of FS pbr iprule based entry */
	struct list *bgp_fs_iprule;
};

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

	/* For nexthop linked list */
	LIST_ENTRY(bgp_path_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_path_info_extra *extra;


	/* Multipath information */
	struct bgp_path_info_mpath *mpath;

	/* Uptime.  */
	time_t uptime;

	/* reference count */
	int lock;

	/* BGP information status.  */
	uint16_t flags;
#define BGP_PATH_IGP_CHANGED (1 << 0)
#define BGP_PATH_DAMPED (1 << 1)
#define BGP_PATH_HISTORY (1 << 2)
#define BGP_PATH_SELECTED (1 << 3)
#define BGP_PATH_VALID (1 << 4)
#define BGP_PATH_ATTR_CHANGED (1 << 5)
#define BGP_PATH_DMED_CHECK (1 << 6)
#define BGP_PATH_DMED_SELECTED (1 << 7)
#define BGP_PATH_STALE (1 << 8)
#define BGP_PATH_REMOVED (1 << 9)
#define BGP_PATH_COUNTED (1 << 10)
#define BGP_PATH_MULTIPATH (1 << 11)
#define BGP_PATH_MULTIPATH_CHG (1 << 12)
#define BGP_PATH_RIB_ATTR_CHG (1 << 13)
#define BGP_PATH_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;
	struct bgp_addpath_info_data tx_addpath;
};

/* Structure used in BGP path selection */
struct bgp_path_info_pair {
	struct bgp_path_info *old;
	struct bgp_path_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_PATH_COUNTABLE(BI)                                                 \
	(!CHECK_FLAG((BI)->flags, BGP_PATH_HISTORY)                            \
	 && !CHECK_FLAG((BI)->flags, BGP_PATH_REMOVED))

/* Flags which indicate a route is unuseable in some form */
#define BGP_PATH_UNUSEABLE                                                     \
	(BGP_PATH_HISTORY | BGP_PATH_DAMPED | BGP_PATH_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_PATH_HOLDDOWN(BI)                                                  \
	(!CHECK_FLAG((BI)->flags, BGP_PATH_VALID)                              \
	 || CHECK_FLAG((BI)->flags, BGP_PATH_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_SHOW_ALL,
	BGP_PATH_SHOW_BESTPATH,
	BGP_PATH_SHOW_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_path_info *pi,
			   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_path_info *bgp_path_info_lock(struct bgp_path_info *path);
extern struct bgp_path_info *bgp_path_info_unlock(struct bgp_path_info *path);
extern void bgp_path_info_add(struct bgp_node *rn, struct bgp_path_info *pi);
extern void bgp_path_info_extra_free(struct bgp_path_info_extra **extra);
extern void bgp_path_info_reap(struct bgp_node *rn, struct bgp_path_info *pi);
extern void bgp_path_info_delete(struct bgp_node *rn, struct bgp_path_info *pi);
extern struct bgp_path_info_extra *
bgp_path_info_extra_get(struct bgp_path_info *path);
extern void bgp_path_info_set_flag(struct bgp_node *rn,
				   struct bgp_path_info *path, uint32_t flag);
extern void bgp_path_info_unset_flag(struct bgp_node *rn,
				     struct bgp_path_info *path, uint32_t flag);
extern void bgp_path_info_path_with_addpath_rx_str(struct bgp_path_info *pi,
						   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 *bgp, struct prefix *p,
				    struct bgp_path_info *path, afi_t afi,
				    safi_t safi);
extern void bgp_aggregate_decrement(struct bgp *bgp, struct prefix *p,
				    struct bgp_path_info *path, afi_t afi,
				    safi_t safi);

extern uint8_t bgp_distance_apply(struct prefix *p, struct bgp_path_info *path,
				  afi_t afi, safi_t safi, struct bgp *bgp);

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

extern struct bgp_path_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 *vty, struct prefix *p,
			  struct bgp_path_info *path, int display, safi_t safi,
			  json_object *json_paths);
extern void route_vty_out_tag(struct vty *vty, struct prefix *p,
			      struct bgp_path_info *path, int display,
			      safi_t safi, json_object *json);
extern void route_vty_out_tmp(struct vty *vty, struct prefix *p,
			      struct attr *attr, safi_t safi, bool use_json,
			      json_object *json_ar);
extern void route_vty_out_overlay(struct vty *vty, struct prefix *p,
				  struct bgp_path_info *path, int display,
				  json_object *json);

extern int subgroup_process_announce_selected(struct update_subgroup *subgrp,
					      struct bgp_path_info *selected,
					      struct bgp_node *rn,
					      uint32_t addpath_tx_id);

extern int subgroup_announce_check(struct bgp_node *rn,
				   struct bgp_path_info *pi,
				   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_path_info *bgp_path_info_new(void);
extern void bgp_path_info_restore(struct bgp_node *rn,
				  struct bgp_path_info *path);

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