[mirror_frr.git] / bgpd / bgp_attr.h

/* BGP attributes.
 * Copyright (C) 1996, 97, 98 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_ATTR_H
#define _QUAGGA_BGP_ATTR_H

#include "mpls.h"
#include "bgp_attr_evpn.h"
#include "bgpd/bgp_encap_types.h"

/* Simple bit mapping. */
#define BITMAP_NBBY 8

#define SET_BITMAP(MAP, NUM)                                                   \
	SET_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))

#define CHECK_BITMAP(MAP, NUM)                                                 \
	CHECK_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))

#define BGP_MED_MAX UINT32_MAX

/* BGP Attribute type range. */
#define BGP_ATTR_TYPE_RANGE     256
#define BGP_ATTR_BITMAP_SIZE    (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)

/* BGP Attribute flags. */
#define BGP_ATTR_FLAG_OPTIONAL  0x80	/* Attribute is optional. */
#define BGP_ATTR_FLAG_TRANS     0x40	/* Attribute is transitive. */
#define BGP_ATTR_FLAG_PARTIAL   0x20	/* Attribute is partial. */
#define BGP_ATTR_FLAG_EXTLEN    0x10	/* Extended length flag. */

/* BGP attribute header must bigger than 2. */
#define BGP_ATTR_MIN_LEN        3       /* Attribute flag, type length. */
#define BGP_ATTR_DEFAULT_WEIGHT 32768

/* Valid lengths for mp_nexthop_len */
#define BGP_ATTR_NHLEN_IPV4               IPV4_MAX_BYTELEN
#define BGP_ATTR_NHLEN_VPNV4              8+IPV4_MAX_BYTELEN
#define BGP_ATTR_NHLEN_IPV6_GLOBAL        IPV6_MAX_BYTELEN
#define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
#define BGP_ATTR_NHLEN_VPNV6_GLOBAL       8+IPV6_MAX_BYTELEN
#define BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL ((8+IPV6_MAX_BYTELEN) * 2)

/* Prefix SID types */
#define BGP_PREFIX_SID_LABEL_INDEX     1
#define BGP_PREFIX_SID_IPV6            2
#define BGP_PREFIX_SID_ORIGINATOR_SRGB 3
#define BGP_PREFIX_SID_SRV6_L3_SERVICE 5
#define BGP_PREFIX_SID_SRV6_L2_SERVICE 6

#define BGP_PREFIX_SID_LABEL_INDEX_LENGTH      7
#define BGP_PREFIX_SID_IPV6_LENGTH            19
#define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH  6

#define BGP_ATTR_NH_AFI(afi, attr) \
	((afi != AFI_L2VPN) ? afi : \
	((attr->mp_nexthop_len == BGP_ATTR_NHLEN_IPV4) ? AFI_IP : AFI_IP6))

/* PMSI tunnel types (RFC 6514) */

struct bgp_attr_encap_subtlv {
	struct bgp_attr_encap_subtlv *next; /* for chaining */
	/* Reference count of this attribute. */
	unsigned long refcnt;
	uint16_t type;
	uint16_t length;
	uint8_t value[0]; /* will be extended */
};

#if ENABLE_BGP_VNC
/*
 * old rfp<->rfapi representation
 */
struct bgp_tea_options {
	struct bgp_tea_options *next;
	uint8_t options_count;
	uint16_t options_length; /* each TLV may be 256 in length */
	uint8_t type;
	uint8_t length;
	void *value; /* pointer to data */
};

#endif

enum pta_type {
	PMSI_TNLTYPE_NO_INFO = 0,
	PMSI_TNLTYPE_RSVP_TE_P2MP,
	PMSI_TNLTYPE_MLDP_P2MP,
	PMSI_TNLTYPE_PIM_SSM,
	PMSI_TNLTYPE_PIM_SM,
	PMSI_TNLTYPE_PIM_BIDIR,
	PMSI_TNLTYPE_INGR_REPL,
	PMSI_TNLTYPE_MLDP_MP2MP,
	PMSI_TNLTYPE_MAX = PMSI_TNLTYPE_MLDP_MP2MP
};

/* BGP core attribute structure. */
struct attr {
	/* AS Path structure */
	struct aspath *aspath;

	/* Community structure */
	struct community *community;

	/* Reference count of this attribute. */
	unsigned long refcnt;

	/* Flag of attribute is set or not. */
	uint64_t flag;

	/* Apart from in6_addr, the remaining static attributes */
	struct in_addr nexthop;
	uint32_t med;
	uint32_t local_pref;
	ifindex_t nh_ifindex;

	/* Path origin attribute */
	uint8_t origin;

	/* PMSI tunnel type (RFC 6514). */
	enum pta_type pmsi_tnl_type;

	/* has the route-map changed any attribute?
	   Used on the peer outbound side. */
	uint32_t rmap_change_flags;

	/* Multi-Protocol Nexthop, AFI IPv6 */
	struct in6_addr mp_nexthop_global;
	struct in6_addr mp_nexthop_local;

	/* ifIndex corresponding to mp_nexthop_local. */
	ifindex_t nh_lla_ifindex;

	/* Extended Communities attribute. */
	struct ecommunity *ecommunity;

	/* Large Communities attribute. */
	struct lcommunity *lcommunity;

	/* Route-Reflector Cluster attribute */
	struct cluster_list *cluster;

	/* Unknown transitive attribute. */
	struct transit *transit;

	struct in_addr mp_nexthop_global_in;

	/* Aggregator Router ID attribute */
	struct in_addr aggregator_addr;

	/* Route Reflector Originator attribute */
	struct in_addr originator_id;

	/* Local weight, not actually an attribute */
	uint32_t weight;

	/* Aggregator ASN */
	as_t aggregator_as;

	/* MP Nexthop length */
	uint8_t mp_nexthop_len;

	/* MP Nexthop preference */
	uint8_t mp_nexthop_prefer_global;

	/* Static MAC for EVPN */
	uint8_t sticky;

	/* Flag for default gateway extended community in EVPN */
	uint8_t default_gw;

	/* NA router flag (R-bit) support in EVPN */
	uint8_t router_flag;

	/* route tag */
	route_tag_t tag;

	/* Label index */
	uint32_t label_index;

	/* MPLS label */
	mpls_label_t label;

	uint16_t encap_tunneltype;		     /* grr */
	struct bgp_attr_encap_subtlv *encap_subtlvs; /* rfc5512 */

#if ENABLE_BGP_VNC
	struct bgp_attr_encap_subtlv *vnc_subtlvs; /* VNC-specific */
#endif
	/* EVPN */
	struct bgp_route_evpn evpn_overlay;

	/* EVPN MAC Mobility sequence number, if any. */
	uint32_t mm_seqnum;

	/* EVPN local router-mac */
	struct ethaddr rmac;

	/* Distance as applied by Route map */
	uint8_t distance;

	/* rmap set table */
	uint32_t rmap_table_id;
};

/* rmap_change_flags definition */
#define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
#define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
#define BATTR_REFLECTED (1 << 2)
#define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
#define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
#define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
#define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)

/* Router Reflector related structure. */
struct cluster_list {
	unsigned long refcnt;
	int length;
	struct in_addr *list;
};

/* Unknown transit attribute. */
struct transit {
	unsigned long refcnt;
	int length;
	uint8_t *val;
};

/* "(void) 0" will generate a compiler error.  this is a safety check to
 * ensure we're not using a value that exceeds the bit size of attr->flag. */
#define ATTR_FLAG_BIT(X)                                                       \
	__builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)

#define BGP_CLUSTER_LIST_LENGTH(attr)                                          \
	(((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST))                 \
		 ? (attr)->cluster->length                                     \
		 : 0)

typedef enum {
	BGP_ATTR_PARSE_PROCEED = 0,
	BGP_ATTR_PARSE_ERROR = -1,
	BGP_ATTR_PARSE_WITHDRAW = -2,

	/* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
	   */
	BGP_ATTR_PARSE_ERROR_NOTIFYPLS = -3,
	BGP_ATTR_PARSE_EOR = -4,
} bgp_attr_parse_ret_t;

struct bpacket_attr_vec_arr;

/* Prototypes. */
extern void bgp_attr_init(void);
extern void bgp_attr_finish(void);
extern bgp_attr_parse_ret_t bgp_attr_parse(struct peer *, struct attr *,
					   bgp_size_t, struct bgp_nlri *,
					   struct bgp_nlri *);
extern void bgp_attr_undup(struct attr *new, struct attr *old);
extern struct attr *bgp_attr_intern(struct attr *attr);
extern void bgp_attr_unintern_sub(struct attr *);
extern void bgp_attr_unintern(struct attr **);
extern void bgp_attr_flush(struct attr *);
extern struct attr *bgp_attr_default_set(struct attr *attr, uint8_t);
extern struct attr *bgp_attr_aggregate_intern(struct bgp *bgp, uint8_t origin,
					      struct aspath *aspath,
					      struct community *community,
					      struct ecommunity *ecommunity,
					      struct lcommunity *lcommunity,
					      struct bgp_aggregate *aggregate,
					      uint8_t atomic_aggregate,
					      struct prefix *p);
extern bgp_size_t bgp_packet_attribute(struct bgp *bgp, struct peer *,
				       struct stream *, struct attr *,
				       struct bpacket_attr_vec_arr *vecarr,
				       struct prefix *, afi_t, safi_t,
				       struct peer *, struct prefix_rd *,
				       mpls_label_t *, uint32_t, int, uint32_t);
extern void bgp_dump_routes_attr(struct stream *, struct attr *,
				 struct prefix *);
extern bool attrhash_cmp(const void *arg1, const void *arg2);
extern unsigned int attrhash_key_make(const void *);
extern void attr_show_all(struct vty *);
extern unsigned long int attr_count(void);
extern unsigned long int attr_unknown_count(void);

/* Cluster list prototypes. */
extern int cluster_loop_check(struct cluster_list *, struct in_addr);
extern void cluster_unintern(struct cluster_list *);

/* Below exported for unit-test purposes only */
struct bgp_attr_parser_args {
	struct peer *peer;
	bgp_size_t length; /* attribute data length; */
	bgp_size_t total;  /* total length, inc header */
	struct attr *attr;
	uint8_t type;
	uint8_t flags;
	uint8_t *startp;
};
extern int bgp_mp_reach_parse(struct bgp_attr_parser_args *args,
			      struct bgp_nlri *);
extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args *args,
				struct bgp_nlri *);
extern bgp_attr_parse_ret_t
bgp_attr_prefix_sid(struct bgp_attr_parser_args *args,
		    struct bgp_nlri *mp_update);

extern struct bgp_attr_encap_subtlv *
encap_tlv_dup(struct bgp_attr_encap_subtlv *orig);

extern void bgp_attr_flush_encap(struct attr *attr);

extern void bgp_attr_extcom_tunnel_type(struct attr *attr,
					 bgp_encap_types *tunnel_type);

/**
 * Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
 * Typical call sequence is to call _start(), followed by multiple _prefix(),
 * one for each NLRI that needs to be encoded into the UPDATE message, and
 * finally the _end() function.
 */
extern size_t bgp_packet_mpattr_start(struct stream *s, struct peer *peer,
				      afi_t afi, safi_t safi,
				      struct bpacket_attr_vec_arr *vecarr,
				      struct attr *attr);
extern void bgp_packet_mpattr_prefix(struct stream *s, afi_t afi, safi_t safi,
				     struct prefix *p, struct prefix_rd *prd,
				     mpls_label_t *label, uint32_t num_labels,
				     int addpath_encode, uint32_t addpath_tx_id,
				     struct attr *);
extern size_t bgp_packet_mpattr_prefix_size(afi_t afi, safi_t safi,
					    struct prefix *p);
extern void bgp_packet_mpattr_end(struct stream *s, size_t sizep);

extern size_t bgp_packet_mpunreach_start(struct stream *s, afi_t afi,
					 safi_t safi);
extern void bgp_packet_mpunreach_prefix(struct stream *s, struct prefix *p,
					afi_t afi, safi_t safi,
					struct prefix_rd *prd, mpls_label_t *,
					uint32_t, int, uint32_t, struct attr *);
extern void bgp_packet_mpunreach_end(struct stream *s, size_t attrlen_pnt);

extern bgp_attr_parse_ret_t bgp_attr_nexthop_valid(struct peer *peer,
						   struct attr *attr);

static inline int bgp_rmap_nhop_changed(uint32_t out_rmap_flags,
					uint32_t in_rmap_flags)
{
	return ((CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_PEER_ADDRESS)
		 || CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED)
		 || CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV4_NHOP_CHANGED)
		 || CHECK_FLAG(out_rmap_flags,
			       BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED)
		 || CHECK_FLAG(out_rmap_flags,
			       BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED)
		 || CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV6_LL_NHOP_CHANGED)
		 || CHECK_FLAG(in_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED))
			? 1
			: 0);
}

static inline uint32_t mac_mobility_seqnum(struct attr *attr)
{
	return (attr) ? attr->mm_seqnum : 0;
}

#endif /* _QUAGGA_BGP_ATTR_H */
Commit	Line	Data
d62a17ae	1	/* BGP attributes.
896014f4 DL	2	* Copyright (C) 1996, 97, 98 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_ATTR_H
	22	#define _QUAGGA_BGP_ATTR_H
	23
9bedbb1e	24	#include "mpls.h"
684a7227	25	#include "bgp_attr_evpn.h"
f4bd90c5	26	#include "bgpd/bgp_encap_types.h"
684a7227	27
718e3744	28	/* Simple bit mapping. */
	29	#define BITMAP_NBBY 8
	30
d62a17ae	31	#define SET_BITMAP(MAP, NUM) \
d62a17ae	32	SET_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
718e3744	33
d62a17ae	34	#define CHECK_BITMAP(MAP, NUM) \
d62a17ae	35	CHECK_FLAG(MAP[(NUM) / BITMAP_NBBY], 1 << ((NUM) % BITMAP_NBBY))
718e3744	36
3b424979	37	#define BGP_MED_MAX UINT32_MAX
3b424979	38
718e3744	39	/* BGP Attribute type range. */
	40	#define BGP_ATTR_TYPE_RANGE 256
	41	#define BGP_ATTR_BITMAP_SIZE (BGP_ATTR_TYPE_RANGE / BITMAP_NBBY)
	42
	43	/* BGP Attribute flags. */
	44	#define BGP_ATTR_FLAG_OPTIONAL 0x80 /* Attribute is optional. */
	45	#define BGP_ATTR_FLAG_TRANS 0x40 /* Attribute is transitive. */
	46	#define BGP_ATTR_FLAG_PARTIAL 0x20 /* Attribute is partial. */
	47	#define BGP_ATTR_FLAG_EXTLEN 0x10 /* Extended length flag. */
	48
	49	/* BGP attribute header must bigger than 2. */
370b64a2	50	#define BGP_ATTR_MIN_LEN 3 /* Attribute flag, type length. */
03e214c8 PJ	51	#define BGP_ATTR_DEFAULT_WEIGHT 32768
03e214c8 PJ	52
801a9bcc DS	53	/* Valid lengths for mp_nexthop_len */
801a9bcc DS	54	#define BGP_ATTR_NHLEN_IPV4 IPV4_MAX_BYTELEN
945c8fe9	55	#define BGP_ATTR_NHLEN_VPNV4 8+IPV4_MAX_BYTELEN
801a9bcc DS	56	#define BGP_ATTR_NHLEN_IPV6_GLOBAL IPV6_MAX_BYTELEN
801a9bcc DS	57	#define BGP_ATTR_NHLEN_IPV6_GLOBAL_AND_LL (IPV6_MAX_BYTELEN * 2)
945c8fe9 LB	58	#define BGP_ATTR_NHLEN_VPNV6_GLOBAL 8+IPV6_MAX_BYTELEN
945c8fe9 LB	59	#define BGP_ATTR_NHLEN_VPNV6_GLOBAL_AND_LL ((8+IPV6_MAX_BYTELEN) * 2)
801a9bcc	60
c5a543b4 DW	61	/* Prefix SID types */
	62	#define BGP_PREFIX_SID_LABEL_INDEX 1
	63	#define BGP_PREFIX_SID_IPV6 2
	64	#define BGP_PREFIX_SID_ORIGINATOR_SRGB 3
c6ca155d HS	65	#define BGP_PREFIX_SID_SRV6_L3_SERVICE 5
c6ca155d HS	66	#define BGP_PREFIX_SID_SRV6_L2_SERVICE 6
c5a543b4 DW	67
	68	#define BGP_PREFIX_SID_LABEL_INDEX_LENGTH 7
	69	#define BGP_PREFIX_SID_IPV6_LENGTH 19
	70	#define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH 6
f4c89855	71
7c312383 AD	72	#define BGP_ATTR_NH_AFI(afi, attr) \
	73	((afi != AFI_L2VPN) ? afi : \
	74	((attr->mp_nexthop_len == BGP_ATTR_NHLEN_IPV4) ? AFI_IP : AFI_IP6))
	75
7fd077aa	76	/* PMSI tunnel types (RFC 6514) */
7fd077aa	77
f4c89855	78	struct bgp_attr_encap_subtlv {
d62a17ae	79	struct bgp_attr_encap_subtlv next; / for chaining */
	80	/* Reference count of this attribute. */
	81	unsigned long refcnt;
	82	uint16_t type;
	83	uint16_t length;
8c9cc7bb	84	uint8_t value[0]; /* will be extended */
f4c89855 LB	85	};
f4c89855 LB	86
65efcfce LB	87	#if ENABLE_BGP_VNC
	88	/*
	89	* old rfp<->rfapi representation
	90	*/
	91	struct bgp_tea_options {
d62a17ae	92	struct bgp_tea_options *next;
	93	uint8_t options_count;
	94	uint16_t options_length; /* each TLV may be 256 in length */
	95	uint8_t type;
	96	uint8_t length;
	97	void value; / pointer to data */
65efcfce LB	98	};
	99
	100	#endif
	101
7fd077aa	102	enum pta_type {
b7d08f5a	103	PMSI_TNLTYPE_NO_INFO = 0,
7fd077aa	104	PMSI_TNLTYPE_RSVP_TE_P2MP,
	105	PMSI_TNLTYPE_MLDP_P2MP,
	106	PMSI_TNLTYPE_PIM_SSM,
	107	PMSI_TNLTYPE_PIM_SM,
	108	PMSI_TNLTYPE_PIM_BIDIR,
	109	PMSI_TNLTYPE_INGR_REPL,
	110	PMSI_TNLTYPE_MLDP_MP2MP,
	111	PMSI_TNLTYPE_MAX = PMSI_TNLTYPE_MLDP_MP2MP
	112	};
	113
aadc0905	114	/* BGP core attribute structure. */
d62a17ae	115	struct attr {
	116	/* AS Path structure */
	117	struct aspath *aspath;
	118
	119	/* Community structure */
	120	struct community *community;
	121
	122	/* Reference count of this attribute. */
	123	unsigned long refcnt;
	124
	125	/* Flag of attribute is set or not. */
	126	uint64_t flag;
	127
	128	/* Apart from in6_addr, the remaining static attributes */
	129	struct in_addr nexthop;
d7c0a89a QY	130	uint32_t med;
d7c0a89a QY	131	uint32_t local_pref;
d62a17ae	132	ifindex_t nh_ifindex;
	133
	134	/* Path origin attribute */
d7c0a89a	135	uint8_t origin;
d62a17ae	136
7fd077aa	137	/* PMSI tunnel type (RFC 6514). */
	138	enum pta_type pmsi_tnl_type;
	139
d62a17ae	140	/* has the route-map changed any attribute?
d62a17ae	141	Used on the peer outbound side. */
d7c0a89a	142	uint32_t rmap_change_flags;
d62a17ae	143
	144	/* Multi-Protocol Nexthop, AFI IPv6 */
	145	struct in6_addr mp_nexthop_global;
	146	struct in6_addr mp_nexthop_local;
	147
77e62f2b	148	/* ifIndex corresponding to mp_nexthop_local. */
	149	ifindex_t nh_lla_ifindex;
	150
d62a17ae	151	/* Extended Communities attribute. */
	152	struct ecommunity *ecommunity;
	153
	154	/* Large Communities attribute. */
	155	struct lcommunity *lcommunity;
	156
	157	/* Route-Reflector Cluster attribute */
	158	struct cluster_list *cluster;
	159
	160	/* Unknown transitive attribute. */
	161	struct transit *transit;
	162
	163	struct in_addr mp_nexthop_global_in;
	164
	165	/* Aggregator Router ID attribute */
	166	struct in_addr aggregator_addr;
	167
	168	/* Route Reflector Originator attribute */
	169	struct in_addr originator_id;
	170
	171	/* Local weight, not actually an attribute */
d7c0a89a	172	uint32_t weight;
d62a17ae	173
	174	/* Aggregator ASN */
	175	as_t aggregator_as;
	176
	177	/* MP Nexthop length */
d7c0a89a	178	uint8_t mp_nexthop_len;
d62a17ae	179
d62a17ae	180	/* MP Nexthop preference */
d7c0a89a	181	uint8_t mp_nexthop_prefer_global;
d62a17ae	182
d62a17ae	183	/* Static MAC for EVPN */
d7c0a89a	184	uint8_t sticky;
d62a17ae	185
ead40654	186	/* Flag for default gateway extended community in EVPN */
d7c0a89a	187	uint8_t default_gw;
ead40654	188
68e33151 CS	189	/* NA router flag (R-bit) support in EVPN */
	190	uint8_t router_flag;
	191
d62a17ae	192	/* route tag */
	193	route_tag_t tag;
	194
	195	/* Label index */
d7c0a89a	196	uint32_t label_index;
d62a17ae	197
	198	/* MPLS label */
	199	mpls_label_t label;
	200
	201	uint16_t encap_tunneltype; /* grr */
	202	struct bgp_attr_encap_subtlv encap_subtlvs; / rfc5512 */
65efcfce LB	203
65efcfce LB	204	#if ENABLE_BGP_VNC
d62a17ae	205	struct bgp_attr_encap_subtlv vnc_subtlvs; / VNC-specific */
65efcfce	206	#endif
d62a17ae	207	/* EVPN */
ea7741a0	208	struct bgp_route_evpn evpn_overlay;
128ea8ab	209
d62a17ae	210	/* EVPN MAC Mobility sequence number, if any. */
d7c0a89a	211	uint32_t mm_seqnum;
bc59a672 MK	212
	213	/* EVPN local router-mac */
	214	struct ethaddr rmac;
7b7d48e5 DS	215
	216	/* Distance as applied by Route map */
	217	uint8_t distance;
951745bd PG	218
	219	/* rmap set table */
	220	uint32_t rmap_table_id;
fb982c25 PJ	221	};
fb982c25 PJ	222
3f9c7369	223	/* rmap_change_flags definition */
3811f1e2	224	#define BATTR_RMAP_IPV4_NHOP_CHANGED (1 << 0)
3f9c7369 DS	225	#define BATTR_RMAP_NEXTHOP_PEER_ADDRESS (1 << 1)
3f9c7369 DS	226	#define BATTR_REFLECTED (1 << 2)
316e074d	227	#define BATTR_RMAP_NEXTHOP_UNCHANGED (1 << 3)
3811f1e2 DS	228	#define BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED (1 << 4)
3811f1e2 DS	229	#define BATTR_RMAP_IPV6_LL_NHOP_CHANGED (1 << 5)
b2e03f7a	230	#define BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED (1 << 6)
3f9c7369	231
718e3744	232	/* Router Reflector related structure. */
d62a17ae	233	struct cluster_list {
	234	unsigned long refcnt;
	235	int length;
	236	struct in_addr *list;
718e3744	237	};
	238
	239	/* Unknown transit attribute. */
d62a17ae	240	struct transit {
	241	unsigned long refcnt;
	242	int length;
d7c0a89a	243	uint8_t *val;
718e3744	244	};
718e3744	245
96099b40 DL	246	/* "(void) 0" will generate a compiler error. this is a safety check to
96099b40 DL	247	* ensure we're not using a value that exceeds the bit size of attr->flag. */
996c9314 LB	248	#define ATTR_FLAG_BIT(X) \
996c9314 LB	249	__builtin_choose_expr((X) >= 1 && (X) <= 64, 1ULL << ((X)-1), (void)0)
718e3744	250
d62a17ae	251	#define BGP_CLUSTER_LIST_LENGTH(attr) \
	252	(((attr)->flag & ATTR_FLAG_BIT(BGP_ATTR_CLUSTER_LIST)) \
	253	? (attr)->cluster->length \
	254	: 0)
5e242b0d	255
b881c707	256	typedef enum {
d62a17ae	257	BGP_ATTR_PARSE_PROCEED = 0,
	258	BGP_ATTR_PARSE_ERROR = -1,
	259	BGP_ATTR_PARSE_WITHDRAW = -2,
f57000c0	260
d62a17ae	261	/* only used internally, send notify + convert to BGP_ATTR_PARSE_ERROR
9d303b37	262	*/
d62a17ae	263	BGP_ATTR_PARSE_ERROR_NOTIFYPLS = -3,
9b9df989	264	BGP_ATTR_PARSE_EOR = -4,
b881c707 PJ	265	} bgp_attr_parse_ret_t;
b881c707 PJ	266
3f9c7369 DS	267	struct bpacket_attr_vec_arr;
3f9c7369 DS	268
718e3744	269	/* Prototypes. */
d62a17ae	270	extern void bgp_attr_init(void);
	271	extern void bgp_attr_finish(void);
	272	extern bgp_attr_parse_ret_t bgp_attr_parse(struct peer , struct attr ,
	273	bgp_size_t, struct bgp_nlri *,
	274	struct bgp_nlri *);
f46d8e1e	275	extern void bgp_attr_undup(struct attr new, struct attr old);
d62a17ae	276	extern struct attr bgp_attr_intern(struct attr attr);
d62a17ae	277	extern void bgp_attr_unintern_sub(struct attr *);
	278	extern void bgp_attr_unintern(struct attr **);
	279	extern void bgp_attr_flush(struct attr *);
d7c0a89a	280	extern struct attr bgp_attr_default_set(struct attr attr, uint8_t);
3da2cc32 DS	281	extern struct attr bgp_attr_aggregate_intern(struct bgp bgp, uint8_t origin,
	282	struct aspath *aspath,
	283	struct community *community,
	284	struct ecommunity *ecommunity,
dd18c5a9	285	struct lcommunity *lcommunity,
20894f50 DA	286	struct bgp_aggregate *aggregate,
	287	uint8_t atomic_aggregate,
	288	struct prefix *p);
d62a17ae	289	extern bgp_size_t bgp_packet_attribute(struct bgp bgp, struct peer ,
	290	struct stream , struct attr ,
	291	struct bpacket_attr_vec_arr *vecarr,
	292	struct prefix *, afi_t, safi_t,
	293	struct peer , struct prefix_rd ,
d7c0a89a	294	mpls_label_t *, uint32_t, int, uint32_t);
d62a17ae	295	extern void bgp_dump_routes_attr(struct stream , struct attr ,
d62a17ae	296	struct prefix *);
74df8d6d	297	extern bool attrhash_cmp(const void arg1, const void arg2);
d8b87afe	298	extern unsigned int attrhash_key_make(const void *);
d62a17ae	299	extern void attr_show_all(struct vty *);
	300	extern unsigned long int attr_count(void);
	301	extern unsigned long int attr_unknown_count(void);
718e3744	302
718e3744	303	/* Cluster list prototypes. */
d62a17ae	304	extern int cluster_loop_check(struct cluster_list *, struct in_addr);
d62a17ae	305	extern void cluster_unintern(struct cluster_list *);
718e3744	306
835315bf PJ	307	/* Below exported for unit-test purposes only */
835315bf PJ	308	struct bgp_attr_parser_args {
d62a17ae	309	struct peer *peer;
	310	bgp_size_t length; /* attribute data length; */
	311	bgp_size_t total; /* total length, inc header */
	312	struct attr *attr;
d7c0a89a QY	313	uint8_t type;
	314	uint8_t flags;
	315	uint8_t *startp;
835315bf	316	};
d62a17ae	317	extern int bgp_mp_reach_parse(struct bgp_attr_parser_args *args,
	318	struct bgp_nlri *);
	319	extern int bgp_mp_unreach_parse(struct bgp_attr_parser_args *args,
	320	struct bgp_nlri *);
30adbd4e	321	extern bgp_attr_parse_ret_t
f69aeb76	322	bgp_attr_prefix_sid(struct bgp_attr_parser_args *args,
30adbd4e	323	struct bgp_nlri *mp_update);
03292809	324
f4c89855 LB	325	extern struct bgp_attr_encap_subtlv *
	326	encap_tlv_dup(struct bgp_attr_encap_subtlv *orig);
	327
d62a17ae	328	extern void bgp_attr_flush_encap(struct attr *attr);
f4c89855	329
f4bd90c5 LK	330	extern void bgp_attr_extcom_tunnel_type(struct attr *attr,
	331	bgp_encap_types *tunnel_type);
	332
8c71e481 PM	333	/**
	334	* Set of functions to encode MP_REACH_NLRI and MP_UNREACH_NLRI attributes.
	335	* Typical call sequence is to call _start(), followed by multiple _prefix(),
	336	* one for each NLRI that needs to be encoded into the UPDATE message, and
	337	* finally the _end() function.
	338	*/
2b26882d	339	extern size_t bgp_packet_mpattr_start(struct stream s, struct peer peer,
d62a17ae	340	afi_t afi, safi_t safi,
d62a17ae	341	struct bpacket_attr_vec_arr *vecarr,
8c71e481 PM	342	struct attr *attr);
	343	extern void bgp_packet_mpattr_prefix(struct stream *s, afi_t afi, safi_t safi,
	344	struct prefix p, struct prefix_rd prd,
d7c0a89a QY	345	mpls_label_t *label, uint32_t num_labels,
	346	int addpath_encode, uint32_t addpath_tx_id,
	347	struct attr *);
93b73dfa	348	extern size_t bgp_packet_mpattr_prefix_size(afi_t afi, safi_t safi,
d62a17ae	349	struct prefix *p);
8c71e481 PM	350	extern void bgp_packet_mpattr_end(struct stream *s, size_t sizep);
8c71e481 PM	351
d62a17ae	352	extern size_t bgp_packet_mpunreach_start(struct stream *s, afi_t afi,
	353	safi_t safi);
	354	extern void bgp_packet_mpunreach_prefix(struct stream s, struct prefix p,
	355	afi_t afi, safi_t safi,
996c9314	356	struct prefix_rd prd, mpls_label_t ,
d7c0a89a	357	uint32_t, int, uint32_t, struct attr *);
d62a17ae	358	extern void bgp_packet_mpunreach_end(struct stream *s, size_t attrlen_pnt);
8c71e481	359
9738e9aa	360	extern bgp_attr_parse_ret_t bgp_attr_nexthop_valid(struct peer *peer,
	361	struct attr *attr);
	362
d7c0a89a QY	363	static inline int bgp_rmap_nhop_changed(uint32_t out_rmap_flags,
d7c0a89a QY	364	uint32_t in_rmap_flags)
3811f1e2	365	{
d62a17ae	366	return ((CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_PEER_ADDRESS)
	367	\|\| CHECK_FLAG(out_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED)
	368	\|\| CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV4_NHOP_CHANGED)
	369	\|\| CHECK_FLAG(out_rmap_flags,
	370	BATTR_RMAP_IPV6_GLOBAL_NHOP_CHANGED)
	371	\|\| CHECK_FLAG(out_rmap_flags,
	372	BATTR_RMAP_IPV6_PREFER_GLOBAL_CHANGED)
	373	\|\| CHECK_FLAG(out_rmap_flags, BATTR_RMAP_IPV6_LL_NHOP_CHANGED)
	374	\|\| CHECK_FLAG(in_rmap_flags, BATTR_RMAP_NEXTHOP_UNCHANGED))
	375	? 1
	376	: 0);
3811f1e2 DS	377	}
3811f1e2 DS	378
d7c0a89a	379	static inline uint32_t mac_mobility_seqnum(struct attr *attr)
128ea8ab	380	{
d62a17ae	381	return (attr) ? attr->mm_seqnum : 0;
128ea8ab	382	}
128ea8ab	383
00d252cb	384	#endif /* _QUAGGA_BGP_ATTR_H */