[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"

/* 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_LABEL_INDEX_LENGTH      7
#define BGP_PREFIX_SID_IPV6_LENGTH            19
#define BGP_PREFIX_SID_ORIGINATOR_SRGB_LENGTH  6

/* 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

/* Overlay Index Info */
struct overlay_index {
	struct eth_segment_id eth_s_id;
	union gw_addr gw_ip;
};

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 overlay_index evpn_overlay;

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

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

/* 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_dup(struct attr *, struct attr *);
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,
					      int as_set,
					      uint8_t atomic_aggregate);
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(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 *);

/* Transit attribute prototypes. */
void transit_unintern(struct transit *);

/* 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(int32_t tlength, 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);

/**
 * 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);

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