[mirror_frr.git] / bgpd / bgp_nexthop.h

/* BGP nexthop scan
 * Copyright (C) 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_NEXTHOP_H
#define _QUAGGA_BGP_NEXTHOP_H

#include "if.h"
#include "queue.h"
#include "prefix.h"
#include "bgp_table.h"

#define NEXTHOP_FAMILY(nexthop_len)                                            \
	(((nexthop_len) == 4 || (nexthop_len) == 12                            \
		  ? AF_INET                                                    \
		  : ((nexthop_len) == 16 || (nexthop_len) == 24                \
				     || (nexthop_len) == 32                    \
				     || (nexthop_len) == 48                    \
			     ? AF_INET6                                        \
			     : AF_UNSPEC)))

#define BGP_MP_NEXTHOP_FAMILY NEXTHOP_FAMILY

PREDECL_RBTREE_UNIQ(bgp_nexthop_cache);

/* BGP nexthop cache value structure. */
struct bgp_nexthop_cache {
	/* The ifindex of the outgoing interface *if* it's a v6 LL */
	ifindex_t ifindex;

	/* RB-tree entry. */
	struct bgp_nexthop_cache_item entry;

	/* IGP route's metric. */
	uint32_t metric;

	/* Nexthop number and nexthop linked list.*/
	uint8_t nexthop_num;
	struct nexthop *nexthop;
	time_t last_update;
	uint16_t flags;

/*
 * If the nexthop is EVPN gateway IP NH, VALID flag is set only if the nexthop
 * is RIB reachable as well as MAC/IP is present
 */
#define BGP_NEXTHOP_VALID             (1 << 0)
#define BGP_NEXTHOP_REGISTERED        (1 << 1)
#define BGP_NEXTHOP_CONNECTED         (1 << 2)
#define BGP_NEXTHOP_PEER_NOTIFIED     (1 << 3)
#define BGP_STATIC_ROUTE              (1 << 4)
#define BGP_STATIC_ROUTE_EXACT_MATCH  (1 << 5)
#define BGP_NEXTHOP_LABELED_VALID     (1 << 6)

/*
 * This flag is added for EVPN gateway IP nexthops.
 * If the nexthop is RIB reachable, but a MAC/IP is not yet
 * resolved, this flag is set.
 * Following table explains the combination of L3 and L2 reachability w.r.t.
 * VALID and INCOMPLETE flags
 *
 *                | MACIP resolved | MACIP unresolved
 *----------------|----------------|------------------
 * L3 reachable   | VALID      = 1 | VALID      = 0
 *                | INCOMPLETE = 0 | INCOMPLETE = 1
 * ---------------|----------------|--------------------
 * L3 unreachable | VALID      = 0 | VALID      = 0
 *                | INCOMPLETE = 0 | INCOMPLETE = 0
 */
#define BGP_NEXTHOP_EVPN_INCOMPLETE (1 << 7)

	uint16_t change_flags;

#define BGP_NEXTHOP_CHANGED           (1 << 0)
#define BGP_NEXTHOP_METRIC_CHANGED    (1 << 1)
#define BGP_NEXTHOP_CONNECTED_CHANGED (1 << 2)
#define BGP_NEXTHOP_MACIP_CHANGED (1 << 3)

	/* Back pointer to the cache tree this entry belongs to. */
	struct bgp_nexthop_cache_head *tree;

	uint32_t srte_color;
	struct prefix prefix;
	void *nht_info; /* In BGP, peer session */
	LIST_HEAD(path_list, bgp_path_info) paths;
	unsigned int path_count;
	struct bgp *bgp;

	/* This flag is set to TRUE for a bnc that is gateway IP overlay index
	 * nexthop.
	 */
	bool is_evpn_gwip_nexthop;
};

extern int bgp_nexthop_cache_compare(const struct bgp_nexthop_cache *a,
				     const struct bgp_nexthop_cache *b);
DECLARE_RBTREE_UNIQ(bgp_nexthop_cache, struct bgp_nexthop_cache, entry,
		    bgp_nexthop_cache_compare);

/* Own tunnel-ip address structure */
struct tip_addr {
	struct in_addr addr;
	int refcnt;
};

struct bgp_addrv6 {
	struct in6_addr addrv6;
	struct list *ifp_name_list;
};

/* Forward declaration(s). */
struct peer;
struct update_subgroup;
struct bgp_dest;
struct attr;

#define BNC_FLAG_DUMP_SIZE 180
extern char *bgp_nexthop_dump_bnc_flags(struct bgp_nexthop_cache *bnc,
					char *buf, size_t len);
extern char *bgp_nexthop_dump_bnc_change_flags(struct bgp_nexthop_cache *bnc,
					       char *buf, size_t len);
extern void bgp_connected_add(struct bgp *bgp, struct connected *c);
extern void bgp_connected_delete(struct bgp *bgp, struct connected *c);
extern bool bgp_subgrp_multiaccess_check_v4(struct in_addr nexthop,
					    struct update_subgroup *subgrp,
					    struct peer *exclude);
extern bool bgp_subgrp_multiaccess_check_v6(struct in6_addr nexthop,
					    struct update_subgroup *subgrp,
					    struct peer *exclude);
extern bool bgp_multiaccess_check_v4(struct in_addr nexthop, struct peer *peer);
extern bool bgp_multiaccess_check_v6(struct in6_addr nexthop,
				     struct peer *peer);
extern int bgp_config_write_scan_time(struct vty *);
extern bool bgp_nexthop_self(struct bgp *bgp, afi_t afi, uint8_t type,
			     uint8_t sub_type, struct attr *attr,
			     struct bgp_dest *dest);
extern struct bgp_nexthop_cache *bnc_new(struct bgp_nexthop_cache_head *tree,
					 struct prefix *prefix,
					 uint32_t srte_color);
extern bool bnc_existing_for_prefix(struct bgp_nexthop_cache *bnc);
extern void bnc_free(struct bgp_nexthop_cache *bnc);
extern struct bgp_nexthop_cache *bnc_find(struct bgp_nexthop_cache_head *tree,
					  struct prefix *prefix,
					  uint32_t srte_color);
extern void bnc_nexthop_free(struct bgp_nexthop_cache *bnc);
extern const char *bnc_str(struct bgp_nexthop_cache *bnc, char *buf, int size);
extern void bgp_scan_init(struct bgp *bgp);
extern void bgp_scan_finish(struct bgp *bgp);
extern void bgp_scan_vty_init(void);
extern void bgp_address_init(struct bgp *bgp);
extern void bgp_address_destroy(struct bgp *bgp);
extern void bgp_tip_add(struct bgp *bgp, struct in_addr *tip);
extern void bgp_tip_del(struct bgp *bgp, struct in_addr *tip);
extern void bgp_tip_hash_init(struct bgp *bgp);
extern void bgp_tip_hash_destroy(struct bgp *bgp);

extern void bgp_nexthop_show_address_hash(struct vty *vty, struct bgp *bgp);
#endif /* _QUAGGA_BGP_NEXTHOP_H */
Commit	Line	Data
718e3744	1	/* BGP nexthop scan
896014f4 DL	2	* Copyright (C) 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_NEXTHOP_H
	22	#define _QUAGGA_BGP_NEXTHOP_H
	23
5304cb52	24	#include "if.h"
fb018d25 DS	25	#include "queue.h"
fb018d25 DS	26	#include "prefix.h"
f663c581	27	#include "bgp_table.h"
5304cb52	28
d62a17ae	29	#define NEXTHOP_FAMILY(nexthop_len) \
	30	(((nexthop_len) == 4 \|\| (nexthop_len) == 12 \
	31	? AF_INET \
	32	: ((nexthop_len) == 16 \|\| (nexthop_len) == 24 \
77e62f2b	33	\|\| (nexthop_len) == 32 \
d62a17ae	34	\|\| (nexthop_len) == 48 \
	35	? AF_INET6 \
	36	: AF_UNSPEC)))
95b9c671	37
65efcfce LB	38	#define BGP_MP_NEXTHOP_FAMILY NEXTHOP_FAMILY
65efcfce LB	39
f663c581 RW	40	PREDECL_RBTREE_UNIQ(bgp_nexthop_cache);
f663c581 RW	41
718e3744	42	/* BGP nexthop cache value structure. */
d62a17ae	43	struct bgp_nexthop_cache {
8761cd6d DS	44	/* The ifindex of the outgoing interface if it's a v6 LL */
	45	ifindex_t ifindex;
	46
f663c581 RW	47	/* RB-tree entry. */
	48	struct bgp_nexthop_cache_item entry;
	49
d62a17ae	50	/* IGP route's metric. */
d7c0a89a	51	uint32_t metric;
718e3744	52
d62a17ae	53	/* Nexthop number and nexthop linked list.*/
d7c0a89a	54	uint8_t nexthop_num;
d62a17ae	55	struct nexthop *nexthop;
d62a17ae	56	time_t last_update;
d7c0a89a	57	uint16_t flags;
fb018d25	58
021b6596 AD	59	/*
	60	* If the nexthop is EVPN gateway IP NH, VALID flag is set only if the nexthop
	61	* is RIB reachable as well as MAC/IP is present
	62	*/
fc9a856f DS	63	#define BGP_NEXTHOP_VALID (1 << 0)
	64	#define BGP_NEXTHOP_REGISTERED (1 << 1)
	65	#define BGP_NEXTHOP_CONNECTED (1 << 2)
	66	#define BGP_NEXTHOP_PEER_NOTIFIED (1 << 3)
078430f6 DS	67	#define BGP_STATIC_ROUTE (1 << 4)
078430f6 DS	68	#define BGP_STATIC_ROUTE_EXACT_MATCH (1 << 5)
960035b2	69	#define BGP_NEXTHOP_LABELED_VALID (1 << 6)
fb018d25	70
021b6596 AD	71	/*
	72	* This flag is added for EVPN gateway IP nexthops.
	73	* If the nexthop is RIB reachable, but a MAC/IP is not yet
	74	* resolved, this flag is set.
	75	* Following table explains the combination of L3 and L2 reachability w.r.t.
	76	* VALID and INCOMPLETE flags
	77	*
	78	* \| MACIP resolved \| MACIP unresolved
	79	*----------------\|----------------\|------------------
	80	* L3 reachable \| VALID = 1 \| VALID = 0
	81	* \| INCOMPLETE = 0 \| INCOMPLETE = 1
	82	* ---------------\|----------------\|--------------------
	83	* L3 unreachable \| VALID = 0 \| VALID = 0
	84	* \| INCOMPLETE = 0 \| INCOMPLETE = 0
	85	*/
	86	#define BGP_NEXTHOP_EVPN_INCOMPLETE (1 << 7)
	87
d7c0a89a	88	uint16_t change_flags;
fb018d25	89
fc9a856f DS	90	#define BGP_NEXTHOP_CHANGED (1 << 0)
	91	#define BGP_NEXTHOP_METRIC_CHANGED (1 << 1)
	92	#define BGP_NEXTHOP_CONNECTED_CHANGED (1 << 2)
021b6596	93	#define BGP_NEXTHOP_MACIP_CHANGED (1 << 3)
fb018d25	94
f663c581 RW	95	/* Back pointer to the cache tree this entry belongs to. */
	96	struct bgp_nexthop_cache_head *tree;
	97
545aeef1	98	uint32_t srte_color;
f663c581	99	struct prefix prefix;
d62a17ae	100	void nht_info; / In BGP, peer session */
4b7e6066	101	LIST_HEAD(path_list, bgp_path_info) paths;
d62a17ae	102	unsigned int path_count;
d62a17ae	103	struct bgp *bgp;
021b6596 AD	104
	105	/* This flag is set to TRUE for a bnc that is gateway IP overlay index
	106	* nexthop.
	107	*/
	108	bool is_evpn_gwip_nexthop;
718e3744	109	};
718e3744	110
f663c581 RW	111	extern int bgp_nexthop_cache_compare(const struct bgp_nexthop_cache *a,
	112	const struct bgp_nexthop_cache *b);
	113	DECLARE_RBTREE_UNIQ(bgp_nexthop_cache, struct bgp_nexthop_cache, entry,
	114	bgp_nexthop_cache_compare);
	115
db0e1937 MK	116	/* Own tunnel-ip address structure */
	117	struct tip_addr {
	118	struct in_addr addr;
	119	int refcnt;
	120	};
	121
737af885 BS	122	struct bgp_addrv6 {
	123	struct in6_addr addrv6;
	124	struct list *ifp_name_list;
	125	};
	126
f663c581 RW	127	/* Forward declaration(s). */
	128	struct peer;
	129	struct update_subgroup;
	130	struct bgp_dest;
	131	struct attr;
	132
987a720a DS	133	#define BNC_FLAG_DUMP_SIZE 180
	134	extern char bgp_nexthop_dump_bnc_flags(struct bgp_nexthop_cache bnc,
	135	char *buf, size_t len);
df2a41a9 DS	136	extern char bgp_nexthop_dump_bnc_change_flags(struct bgp_nexthop_cache bnc,
df2a41a9 DS	137	char *buf, size_t len);
d62a17ae	138	extern void bgp_connected_add(struct bgp bgp, struct connected c);
d62a17ae	139	extern void bgp_connected_delete(struct bgp bgp, struct connected c);
3dc339cd DA	140	extern bool bgp_subgrp_multiaccess_check_v4(struct in_addr nexthop,
	141	struct update_subgroup *subgrp,
	142	struct peer *exclude);
	143	extern bool bgp_subgrp_multiaccess_check_v6(struct in6_addr nexthop,
	144	struct update_subgroup *subgrp,
	145	struct peer *exclude);
	146	extern bool bgp_multiaccess_check_v4(struct in_addr nexthop, struct peer *peer);
	147	extern bool bgp_multiaccess_check_v6(struct in6_addr nexthop,
	148	struct peer *peer);
d62a17ae	149	extern int bgp_config_write_scan_time(struct vty *);
3dc339cd DA	150	extern bool bgp_nexthop_self(struct bgp *bgp, afi_t afi, uint8_t type,
3dc339cd DA	151	uint8_t sub_type, struct attr *attr,
9bcb3eef	152	struct bgp_dest *dest);
f663c581	153	extern struct bgp_nexthop_cache bnc_new(struct bgp_nexthop_cache_head tree,
545aeef1 RW	154	struct prefix *prefix,
545aeef1 RW	155	uint32_t srte_color);
e37e1e27	156	extern bool bnc_existing_for_prefix(struct bgp_nexthop_cache *bnc);
fb018d25	157	extern void bnc_free(struct bgp_nexthop_cache *bnc);
f663c581	158	extern struct bgp_nexthop_cache bnc_find(struct bgp_nexthop_cache_head tree,
545aeef1 RW	159	struct prefix *prefix,
545aeef1 RW	160	uint32_t srte_color);
fb018d25	161	extern void bnc_nexthop_free(struct bgp_nexthop_cache *bnc);
f663c581	162	extern const char bnc_str(struct bgp_nexthop_cache bnc, char *buf, int size);
6aeb9e78 DS	163	extern void bgp_scan_init(struct bgp *bgp);
6aeb9e78 DS	164	extern void bgp_scan_finish(struct bgp *bgp);
ffd0c037	165	extern void bgp_scan_vty_init(void);
d62a17ae	166	extern void bgp_address_init(struct bgp *bgp);
d62a17ae	167	extern void bgp_address_destroy(struct bgp *bgp);
db0e1937 MK	168	extern void bgp_tip_add(struct bgp bgp, struct in_addr tip);
	169	extern void bgp_tip_del(struct bgp bgp, struct in_addr tip);
	170	extern void bgp_tip_hash_init(struct bgp *bgp);
	171	extern void bgp_tip_hash_destroy(struct bgp *bgp);
00d252cb	172
af97a18b	173	extern void bgp_nexthop_show_address_hash(struct vty vty, struct bgp bgp);
00d252cb	174	#endif /* _QUAGGA_BGP_NEXTHOP_H */