[mirror_frr.git] / lib / nexthop.h

/*
 * Nexthop structure definition.
 * Copyright (C) 1997, 98, 99, 2001 Kunihiro Ishiguro
 * Copyright (C) 2013 Cumulus Networks, Inc.
 *
 * This file is part of Quagga.
 *
 * Quagga 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.
 *
 * Quagga 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 _LIB_NEXTHOP_H
#define _LIB_NEXTHOP_H

#include "prefix.h"
#include "mpls.h"
#include "vxlan.h"
#include "srv6.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Maximum next hop string length - gateway + ifindex */
#define NEXTHOP_STRLEN (INET6_ADDRSTRLEN + 30)

union g_addr {
	struct in_addr ipv4;
	struct in6_addr ipv6;
};

enum nexthop_types_t {
	NEXTHOP_TYPE_IFINDEX = 1,  /* Directly connected.  */
	NEXTHOP_TYPE_IPV4,	 /* IPv4 nexthop.  */
	NEXTHOP_TYPE_IPV4_IFINDEX, /* IPv4 nexthop with ifindex.  */
	NEXTHOP_TYPE_IPV6,	 /* IPv6 nexthop.  */
	NEXTHOP_TYPE_IPV6_IFINDEX, /* IPv6 nexthop with ifindex.  */
	NEXTHOP_TYPE_BLACKHOLE,    /* Null0 nexthop.  */
};

enum blackhole_type {
	BLACKHOLE_UNSPEC = 0,
	BLACKHOLE_NULL,
	BLACKHOLE_REJECT,
	BLACKHOLE_ADMINPROHIB,
};

enum nh_encap_type {
	NET_VXLAN = 100, /* value copied from FPM_NH_ENCAP_VXLAN. */
};

/* Fixed limit on the number of backup nexthops per primary nexthop */
#define NEXTHOP_MAX_BACKUPS  8

/* Backup index value is limited */
#define NEXTHOP_BACKUP_IDX_MAX 255

/* Nexthop structure. */
struct nexthop {
	struct nexthop *next;
	struct nexthop *prev;

	/*
	 * What vrf is this nexthop associated with?
	 */
	vrf_id_t vrf_id;

	/* Interface index. */
	ifindex_t ifindex;

	enum nexthop_types_t type;

	uint16_t flags;
#define NEXTHOP_FLAG_ACTIVE     (1 << 0) /* This nexthop is alive. */
#define NEXTHOP_FLAG_FIB        (1 << 1) /* FIB nexthop. */
#define NEXTHOP_FLAG_RECURSIVE  (1 << 2) /* Recursive nexthop. */
#define NEXTHOP_FLAG_ONLINK     (1 << 3) /* Nexthop should be installed
					  * onlink.
					  */
#define NEXTHOP_FLAG_DUPLICATE  (1 << 4) /* nexthop duplicates another
					  * active one
					  */
#define NEXTHOP_FLAG_RNH_FILTERED  (1 << 5) /* rmap filtered, used by rnh */
#define NEXTHOP_FLAG_HAS_BACKUP (1 << 6)    /* Backup nexthop index is set */
#define NEXTHOP_FLAG_SRTE       (1 << 7) /* SR-TE color used for BGP traffic */
#define NEXTHOP_FLAG_EVPN       (1 << 8) /* nexthop is EVPN */
#define NEXTHOP_FLAG_LINKDOWN   (1 << 9) /* is not removed on link down */

#define NEXTHOP_IS_ACTIVE(flags)                                               \
	(CHECK_FLAG(flags, NEXTHOP_FLAG_ACTIVE)                                \
	 && !CHECK_FLAG(flags, NEXTHOP_FLAG_DUPLICATE))

	/* Nexthop address */
	union {
		union g_addr gate;
		enum blackhole_type bh_type;
	};
	union g_addr src;
	union g_addr rmap_src; /* Src is set via routemap */

	/* Nexthops obtained by recursive resolution.
	 *
	 * If the nexthop struct needs to be resolved recursively,
	 * NEXTHOP_FLAG_RECURSIVE will be set in flags and the nexthops
	 * obtained by recursive resolution will be added to `resolved'.
	 */
	struct nexthop *resolved;
	/* Recursive parent */
	struct nexthop *rparent;

	/* Type of label(s), if any */
	enum lsp_types_t nh_label_type;

	/* Label(s) associated with this nexthop. */
	struct mpls_label_stack *nh_label;

	/* Weight of the nexthop ( for unequal cost ECMP ) */
	uint8_t weight;

	/* Count and index of corresponding backup nexthop(s) in a backup list;
	 * only meaningful if the HAS_BACKUP flag is set.
	 */
	uint8_t backup_num;
	uint8_t backup_idx[NEXTHOP_MAX_BACKUPS];

	/* Encapsulation information. */
	enum nh_encap_type nh_encap_type;
	union {
		vni_t vni;
	} nh_encap;

	/* SR-TE color used for matching SR-TE policies */
	uint32_t srte_color;

	/* SRv6 information */
	struct nexthop_srv6 *nh_srv6;
};

/* Utility to append one nexthop to another. */
#define NEXTHOP_APPEND(to, new)           \
	do {                              \
		(to)->next = (new);       \
		(new)->prev = (to);       \
		(new)->next = NULL;       \
	} while (0)

struct nexthop *nexthop_new(void);

void nexthop_free(struct nexthop *nexthop);
void nexthops_free(struct nexthop *nexthop);

void nexthop_add_labels(struct nexthop *nexthop, enum lsp_types_t ltype,
			uint8_t num_labels, const mpls_label_t *labels);
void nexthop_del_labels(struct nexthop *);
void nexthop_add_srv6_seg6local(struct nexthop *nexthop, uint32_t action,
				const struct seg6local_context *ctx);
void nexthop_del_srv6_seg6local(struct nexthop *nexthop);
void nexthop_add_srv6_seg6(struct nexthop *nexthop,
			   const struct in6_addr *segs);
void nexthop_del_srv6_seg6(struct nexthop *nexthop);

/*
 * Allocate a new nexthop object and initialize it from various args.
 */
struct nexthop *nexthop_from_ifindex(ifindex_t ifindex, vrf_id_t vrf_id);
struct nexthop *nexthop_from_ipv4(const struct in_addr *ipv4,
				  const struct in_addr *src,
				  vrf_id_t vrf_id);
struct nexthop *nexthop_from_ipv4_ifindex(const struct in_addr *ipv4,
					  const struct in_addr *src,
					  ifindex_t ifindex, vrf_id_t vrf_id);
struct nexthop *nexthop_from_ipv6(const struct in6_addr *ipv6,
				  vrf_id_t vrf_id);
struct nexthop *nexthop_from_ipv6_ifindex(const struct in6_addr *ipv6,
					  ifindex_t ifindex, vrf_id_t vrf_id);
struct nexthop *nexthop_from_blackhole(enum blackhole_type bh_type,
				       vrf_id_t nh_vrf_id);

/*
 * Hash a nexthop. Suitable for use with hash tables.
 *
 * This function uses the following values when computing the hash:
 * - vrf_id
 * - ifindex
 * - type
 * - gate
 *
 * nexthop
 *    The nexthop to hash
 *
 * Returns:
 *    32-bit hash of nexthop
 */
uint32_t nexthop_hash(const struct nexthop *nexthop);
/*
 * Hash a nexthop only on word-sized attributes:
 * - vrf_id
 * - ifindex
 * - type
 * - (some) flags
 */
uint32_t nexthop_hash_quick(const struct nexthop *nexthop);

extern bool nexthop_same(const struct nexthop *nh1, const struct nexthop *nh2);
extern bool nexthop_same_no_labels(const struct nexthop *nh1,
				   const struct nexthop *nh2);
extern int nexthop_cmp(const struct nexthop *nh1, const struct nexthop *nh2);
extern int nexthop_g_addr_cmp(enum nexthop_types_t type,
			      const union g_addr *addr1,
			      const union g_addr *addr2);

/* More-limited comparison function used to detect duplicate nexthops.
 * Returns -1, 0, 1
 */
int nexthop_cmp_basic(const struct nexthop *nh1, const struct nexthop *nh2);

extern const char *nexthop_type_to_str(enum nexthop_types_t nh_type);
extern bool nexthop_labels_match(const struct nexthop *nh1,
				 const struct nexthop *nh2);

extern const char *nexthop2str(const struct nexthop *nexthop,
			       char *str, int size);
extern struct nexthop *nexthop_next(const struct nexthop *nexthop);
extern struct nexthop *
nexthop_next_active_resolved(const struct nexthop *nexthop);
extern unsigned int nexthop_level(const struct nexthop *nexthop);
/* Copies to an already allocated nexthop struct */
extern void nexthop_copy(struct nexthop *copy, const struct nexthop *nexthop,
			 struct nexthop *rparent);
/* Copies to an already allocated nexthop struct, not including recurse info */
extern void nexthop_copy_no_recurse(struct nexthop *copy,
				    const struct nexthop *nexthop,
				    struct nexthop *rparent);
/* Duplicates a nexthop and returns the newly allocated nexthop */
extern struct nexthop *nexthop_dup(const struct nexthop *nexthop,
				   struct nexthop *rparent);
/* Duplicates a nexthop and returns the newly allocated nexthop */
extern struct nexthop *nexthop_dup_no_recurse(const struct nexthop *nexthop,
					      struct nexthop *rparent);

/*
 * Parse one or more backup index values, as comma-separated numbers,
 * into caller's array of uint8_ts. The array must be NEXTHOP_MAX_BACKUPS
 * in size. Mails back the number of values converted, and returns 0 on
 * success, <0 if an error in parsing.
 */
int nexthop_str2backups(const char *str, int *num_backups,
			uint8_t *backups);

#ifdef _FRR_ATTRIBUTE_PRINTFRR
#pragma FRR printfrr_ext "%pNH"  (struct nexthop *)
#endif

ssize_t printfrr_nhs(struct fbuf *buf, const struct nexthop *nh);
#ifdef __cplusplus
}
#endif

#endif /*_LIB_NEXTHOP_H */
Commit	Line	Data
fb018d25 DS	1	/*
fb018d25 DS	2	* Nexthop structure definition.
a399694f	3	* Copyright (C) 1997, 98, 99, 2001 Kunihiro Ishiguro
fb018d25 DS	4	* Copyright (C) 2013 Cumulus Networks, Inc.
fb018d25 DS	5	*
a399694f	6	* This file is part of Quagga.
fb018d25	7	*
a399694f	8	* Quagga is free software; you can redistribute it and/or modify it
fb018d25 DS	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2, or (at your option) any
	11	* later version.
	12	*
a399694f	13	* Quagga is distributed in the hope that it will be useful, but
fb018d25 DS	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
896014f4 DL	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; see the file COPYING; if not, write to the Free Software
	20	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
fb018d25 DS	21	*/
	22
	23	#ifndef _LIB_NEXTHOP_H
	24	#define _LIB_NEXTHOP_H
	25
	26	#include "prefix.h"
54d48ea1	27	#include "mpls.h"
f2a0ba3a	28	#include "vxlan.h"
cb7775a9	29	#include "srv6.h"
fb018d25	30
5e244469 RW	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
80c2442a	35	/* Maximum next hop string length - gateway + ifindex */
	36	#define NEXTHOP_STRLEN (INET6_ADDRSTRLEN + 30)
	37
fb018d25	38	union g_addr {
d62a17ae	39	struct in_addr ipv4;
d62a17ae	40	struct in6_addr ipv6;
fb018d25 DS	41	};
fb018d25 DS	42
d62a17ae	43	enum nexthop_types_t {
	44	NEXTHOP_TYPE_IFINDEX = 1, /* Directly connected. */
	45	NEXTHOP_TYPE_IPV4, /* IPv4 nexthop. */
	46	NEXTHOP_TYPE_IPV4_IFINDEX, /* IPv4 nexthop with ifindex. */
	47	NEXTHOP_TYPE_IPV6, /* IPv6 nexthop. */
	48	NEXTHOP_TYPE_IPV6_IFINDEX, /* IPv6 nexthop with ifindex. */
	49	NEXTHOP_TYPE_BLACKHOLE, /* Null0 nexthop. */
fb018d25	50	};
09a484dd DL	51
	52	enum blackhole_type {
	53	BLACKHOLE_UNSPEC = 0,
	54	BLACKHOLE_NULL,
	55	BLACKHOLE_REJECT,
	56	BLACKHOLE_ADMINPROHIB,
	57	};
fb018d25	58
f2a0ba3a RZ	59	enum nh_encap_type {
	60	NET_VXLAN = 100, /* value copied from FPM_NH_ENCAP_VXLAN. */
	61	};
	62
474aebd9 MS	63	/* Fixed limit on the number of backup nexthops per primary nexthop */
	64	#define NEXTHOP_MAX_BACKUPS 8
	65
	66	/* Backup index value is limited */
	67	#define NEXTHOP_BACKUP_IDX_MAX 255
	68
fb018d25	69	/* Nexthop structure. */
d62a17ae	70	struct nexthop {
	71	struct nexthop *next;
	72	struct nexthop *prev;
fb018d25	73
4a7371e9 DS	74	/*
	75	* What vrf is this nexthop associated with?
	76	*/
	77	vrf_id_t vrf_id;
	78
d62a17ae	79	/* Interface index. */
d62a17ae	80	ifindex_t ifindex;
fb018d25	81
d62a17ae	82	enum nexthop_types_t type;
fb018d25	83
52e8a7c4	84	uint16_t flags;
fb018d25 DS	85	#define NEXTHOP_FLAG_ACTIVE (1 << 0) /* This nexthop is alive. */
	86	#define NEXTHOP_FLAG_FIB (1 << 1) /* FIB nexthop. */
	87	#define NEXTHOP_FLAG_RECURSIVE (1 << 2) /* Recursive nexthop. */
0641a955 MS	88	#define NEXTHOP_FLAG_ONLINK (1 << 3) /* Nexthop should be installed
	89	* onlink.
	90	*/
	91	#define NEXTHOP_FLAG_DUPLICATE (1 << 4) /* nexthop duplicates another
	92	* active one
	93	*/
	94	#define NEXTHOP_FLAG_RNH_FILTERED (1 << 5) /* rmap filtered, used by rnh */
defd2ea4	95	#define NEXTHOP_FLAG_HAS_BACKUP (1 << 6) /* Backup nexthop index is set */
31f937fb	96	#define NEXTHOP_FLAG_SRTE (1 << 7) /* SR-TE color used for BGP traffic */
5609e70f	97	#define NEXTHOP_FLAG_EVPN (1 << 8) /* nexthop is EVPN */
c704cb44	98	#define NEXTHOP_FLAG_LINKDOWN (1 << 9) /* is not removed on link down */
defd2ea4	99
996c9314 LB	100	#define NEXTHOP_IS_ACTIVE(flags) \
	101	(CHECK_FLAG(flags, NEXTHOP_FLAG_ACTIVE) \
	102	&& !CHECK_FLAG(flags, NEXTHOP_FLAG_DUPLICATE))
fb018d25	103
d62a17ae	104	/* Nexthop address */
a8309422 DL	105	union {
	106	union g_addr gate;
	107	enum blackhole_type bh_type;
	108	};
d62a17ae	109	union g_addr src;
	110	union g_addr rmap_src; /* Src is set via routemap */
	111
	112	/* Nexthops obtained by recursive resolution.
	113	*
	114	* If the nexthop struct needs to be resolved recursively,
	115	* NEXTHOP_FLAG_RECURSIVE will be set in flags and the nexthops
	116	* obtained by recursive resolution will be added to `resolved'.
	117	*/
	118	struct nexthop *resolved;
	119	/* Recursive parent */
	120	struct nexthop *rparent;
	121
	122	/* Type of label(s), if any */
	123	enum lsp_types_t nh_label_type;
	124
	125	/* Label(s) associated with this nexthop. */
8ecdb26e	126	struct mpls_label_stack *nh_label;
df7fb580 DS	127
	128	/* Weight of the nexthop ( for unequal cost ECMP ) */
	129	uint8_t weight;
defd2ea4	130
474aebd9	131	/* Count and index of corresponding backup nexthop(s) in a backup list;
defd2ea4 MS	132	* only meaningful if the HAS_BACKUP flag is set.
defd2ea4 MS	133	*/
474aebd9 MS	134	uint8_t backup_num;
474aebd9 MS	135	uint8_t backup_idx[NEXTHOP_MAX_BACKUPS];
f2a0ba3a RZ	136
	137	/* Encapsulation information. */
	138	enum nh_encap_type nh_encap_type;
	139	union {
	140	vni_t vni;
	141	} nh_encap;
31f937fb SM	142
	143	/* SR-TE color used for matching SR-TE policies */
	144	uint32_t srte_color;
cb7775a9	145
eab0f8f0 HS	146	/* SRv6 information */
eab0f8f0 HS	147	struct nexthop_srv6 *nh_srv6;
fb018d25 DS	148	};
fb018d25 DS	149
e4a1ec74 MS	150	/* Utility to append one nexthop to another. */
	151	#define NEXTHOP_APPEND(to, new) \
	152	do { \
	153	(to)->next = (new); \
	154	(new)->prev = (to); \
	155	(new)->next = NULL; \
	156	} while (0)
	157
d62a17ae	158	struct nexthop *nexthop_new(void);
a399694f	159
d62a17ae	160	void nexthop_free(struct nexthop *nexthop);
d62a17ae	161	void nexthops_free(struct nexthop *nexthop);
a399694f	162
e4a1ec74 MS	163	void nexthop_add_labels(struct nexthop *nexthop, enum lsp_types_t ltype,
e4a1ec74 MS	164	uint8_t num_labels, const mpls_label_t *labels);
d62a17ae	165	void nexthop_del_labels(struct nexthop *);
eab0f8f0 HS	166	void nexthop_add_srv6_seg6local(struct nexthop *nexthop, uint32_t action,
	167	const struct seg6local_context *ctx);
	168	void nexthop_del_srv6_seg6local(struct nexthop *nexthop);
	169	void nexthop_add_srv6_seg6(struct nexthop *nexthop,
	170	const struct in6_addr *segs);
	171	void nexthop_del_srv6_seg6(struct nexthop *nexthop);
40c7bdb0	172
f3323df2 MS	173	/*
	174	* Allocate a new nexthop object and initialize it from various args.
	175	*/
	176	struct nexthop *nexthop_from_ifindex(ifindex_t ifindex, vrf_id_t vrf_id);
	177	struct nexthop nexthop_from_ipv4(const struct in_addr ipv4,
	178	const struct in_addr *src,
	179	vrf_id_t vrf_id);
	180	struct nexthop nexthop_from_ipv4_ifindex(const struct in_addr ipv4,
	181	const struct in_addr *src,
	182	ifindex_t ifindex, vrf_id_t vrf_id);
	183	struct nexthop nexthop_from_ipv6(const struct in6_addr ipv6,
	184	vrf_id_t vrf_id);
	185	struct nexthop nexthop_from_ipv6_ifindex(const struct in6_addr ipv6,
	186	ifindex_t ifindex, vrf_id_t vrf_id);
0789eb69 KM	187	struct nexthop *nexthop_from_blackhole(enum blackhole_type bh_type,
0789eb69 KM	188	vrf_id_t nh_vrf_id);
f3323df2	189
d36d0d57 QY	190	/*
	191	* Hash a nexthop. Suitable for use with hash tables.
	192	*
	193	* This function uses the following values when computing the hash:
	194	* - vrf_id
	195	* - ifindex
	196	* - type
	197	* - gate
	198	*
	199	* nexthop
	200	* The nexthop to hash
	201	*
	202	* Returns:
	203	* 32-bit hash of nexthop
	204	*/
1b1fe1c4	205	uint32_t nexthop_hash(const struct nexthop *nexthop);
73a38187 SW	206	/*
	207	* Hash a nexthop only on word-sized attributes:
	208	* - vrf_id
	209	* - ifindex
	210	* - type
	211	* - (some) flags
	212	*/
	213	uint32_t nexthop_hash_quick(const struct nexthop *nexthop);
d36d0d57	214
31919191	215	extern bool nexthop_same(const struct nexthop nh1, const struct nexthop nh2);
a5a2d802 SW	216	extern bool nexthop_same_no_labels(const struct nexthop *nh1,
a5a2d802 SW	217	const struct nexthop *nh2);
776c3e90	218	extern int nexthop_cmp(const struct nexthop nh1, const struct nexthop nh2);
3c6e0bd4 SW	219	extern int nexthop_g_addr_cmp(enum nexthop_types_t type,
	220	const union g_addr *addr1,
	221	const union g_addr *addr2);
31919191	222
338ec3b8 MS	223	/* More-limited comparison function used to detect duplicate nexthops.
	224	* Returns -1, 0, 1
	225	*/
	226	int nexthop_cmp_basic(const struct nexthop nh1, const struct nexthop nh2);
	227
d62a17ae	228	extern const char *nexthop_type_to_str(enum nexthop_types_t nh_type);
89dc3160 SW	229	extern bool nexthop_labels_match(const struct nexthop *nh1,
89dc3160 SW	230	const struct nexthop *nh2);
fb018d25	231
55f93d4b MS	232	extern const char nexthop2str(const struct nexthop nexthop,
55f93d4b MS	233	char *str, int size);
17c25e03 SW	234	extern struct nexthop nexthop_next(const struct nexthop nexthop);
	235	extern struct nexthop *
	236	nexthop_next_active_resolved(const struct nexthop *nexthop);
850c85b9	237	extern unsigned int nexthop_level(const struct nexthop *nexthop);
504d0a40	238	/* Copies to an already allocated nexthop struct */
e7addf02 SW	239	extern void nexthop_copy(struct nexthop copy, const struct nexthop nexthop,
e7addf02 SW	240	struct nexthop *rparent);
77bf9504 SW	241	/* Copies to an already allocated nexthop struct, not including recurse info */
	242	extern void nexthop_copy_no_recurse(struct nexthop *copy,
	243	const struct nexthop *nexthop,
	244	struct nexthop *rparent);
504d0a40 SW	245	/* Duplicates a nexthop and returns the newly allocated nexthop */
	246	extern struct nexthop nexthop_dup(const struct nexthop nexthop,
	247	struct nexthop *rparent);
77bf9504 SW	248	/* Duplicates a nexthop and returns the newly allocated nexthop */
	249	extern struct nexthop nexthop_dup_no_recurse(const struct nexthop nexthop,
	250	struct nexthop *rparent);
5e244469	251
0cac0cf4 MS	252	/*
	253	* Parse one or more backup index values, as comma-separated numbers,
	254	* into caller's array of uint8_ts. The array must be NEXTHOP_MAX_BACKUPS
	255	* in size. Mails back the number of values converted, and returns 0 on
	256	* success, <0 if an error in parsing.
	257	*/
	258	int nexthop_str2backups(const char str, int num_backups,
	259	uint8_t *backups);
	260
07ef3e34 DL	261	#ifdef _FRR_ATTRIBUTE_PRINTFRR
	262	#pragma FRR printfrr_ext "%pNH" (struct nexthop *)
	263	#endif
	264
f7a410a7	265	ssize_t printfrr_nhs(struct fbuf buf, const struct nexthop nh);
5e244469 RW	266	#ifdef __cplusplus
	267	}
	268	#endif
	269
fb018d25	270	#endif /_LIB_NEXTHOP_H /