[mirror_frr.git] / bgpd / bgp_ecommunity.h

/* BGP Extended Communities Attribute.
 * Copyright (C) 2000 Kunihiro Ishiguro <kunihiro@zebra.org>
 *
 * 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_ECOMMUNITY_H
#define _QUAGGA_BGP_ECOMMUNITY_H

#include "bgpd/bgp_route.h"

/* High-order octet of the Extended Communities type field.  */
#define ECOMMUNITY_ENCODE_AS                0x00
#define ECOMMUNITY_ENCODE_IP                0x01
#define ECOMMUNITY_ENCODE_AS4               0x02
#define ECOMMUNITY_ENCODE_OPAQUE            0x03
#define ECOMMUNITY_ENCODE_EVPN              0x06
#define ECOMMUNITY_ENCODE_TRANS_EXP         0x80 /* Flow Spec */
#define ECOMMUNITY_ENCODE_REDIRECT_IP_NH    0x08 /* Flow Spec */
/* RFC7674 */
#define ECOMMUNITY_EXTENDED_COMMUNITY_PART_2 0x81
#define ECOMMUNITY_EXTENDED_COMMUNITY_PART_3 0x82

/* Low-order octet of the Extended Communities type field.  */
#define ECOMMUNITY_ROUTE_TARGET             0x02
#define ECOMMUNITY_SITE_ORIGIN              0x03
#define ECOMMUNITY_TRAFFIC_RATE             0x06 /* Flow Spec */
#define ECOMMUNITY_TRAFFIC_ACTION           0x07
#define ECOMMUNITY_REDIRECT_VRF             0x08
#define ECOMMUNITY_TRAFFIC_MARKING          0x09
#define ECOMMUNITY_REDIRECT_IP_NH           0x00
/* from IANA: bgp-extended-communities/bgp-extended-communities.xhtml
 * 0x0c Flow-spec Redirect to IPv4 - draft-ietf-idr-flowspec-redirect
 */
#define ECOMMUNITY_FLOWSPEC_REDIRECT_IPV4   0x0c

/* Low-order octet of the Extended Communities type field for EVPN types */
#define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY  0x00
#define ECOMMUNITY_EVPN_SUBTYPE_ESI_LABEL    0x01
#define ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT 0x02
#define ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC    0x03
#define ECOMMUNITY_EVPN_SUBTYPE_DEF_GW       0x0d
#define ECOMMUNITY_EVPN_SUBTYPE_ND           0x08

#define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY 0x01
#define ECOMMUNITY_EVPN_SUBTYPE_ND_ROUTER_FLAG		0x01
#define ECOMMUNITY_EVPN_SUBTYPE_ND_OVERRIDE_FLAG	0x02

/* Low-order octet of the Extended Communities type field for OPAQUE types */
#define ECOMMUNITY_OPAQUE_SUBTYPE_ENCAP     0x0c

/* Extended communities attribute string format.  */
#define ECOMMUNITY_FORMAT_ROUTE_MAP            0
#define ECOMMUNITY_FORMAT_COMMUNITY_LIST       1
#define ECOMMUNITY_FORMAT_DISPLAY              2

/* Extended Communities value is eight octet long.  */
#define ECOMMUNITY_SIZE                        8

/* Extended Communities type flag.  */
#define ECOMMUNITY_FLAG_NON_TRANSITIVE      0x40

/* Extended Communities attribute.  */
struct ecommunity {
	/* Reference counter.  */
	unsigned long refcnt;

	/* Size of Extended Communities attribute.  */
	int size;

	/* Extended Communities value.  */
	uint8_t *val;

	/* Human readable format string.  */
	char *str;
};

struct ecommunity_as {
	as_t as;
	uint32_t val;
};

struct ecommunity_ip {
	struct in_addr ip;
	uint16_t val;
};

/* Extended community value is eight octet.  */
struct ecommunity_val {
	char val[ECOMMUNITY_SIZE];
};

#define ecom_length(X)    ((X)->size * ECOMMUNITY_SIZE)

/*
 * Encode BGP Route Target AS:nn.
 */
static inline void encode_route_target_as(as_t as, uint32_t val,
					  struct ecommunity_val *eval)
{
	eval->val[0] = ECOMMUNITY_ENCODE_AS;
	eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
	eval->val[2] = (as >> 8) & 0xff;
	eval->val[3] = as & 0xff;
	eval->val[4] = (val >> 24) & 0xff;
	eval->val[5] = (val >> 16) & 0xff;
	eval->val[6] = (val >> 8) & 0xff;
	eval->val[7] = val & 0xff;
}

/*
 * Encode BGP Route Target IP:nn.
 */
static inline void encode_route_target_ip(struct in_addr ip, uint16_t val,
					  struct ecommunity_val *eval)
{
	eval->val[0] = ECOMMUNITY_ENCODE_IP;
	eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
	memcpy(&eval->val[2], &ip, sizeof(struct in_addr));
	eval->val[6] = (val >> 8) & 0xff;
	eval->val[7] = val & 0xff;
}

/*
 * Encode BGP Route Target AS4:nn.
 */
static inline void encode_route_target_as4(as_t as, uint16_t val,
					   struct ecommunity_val *eval)
{
	eval->val[0] = ECOMMUNITY_ENCODE_AS4;
	eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
	eval->val[2] = (as >> 24) & 0xff;
	eval->val[3] = (as >> 16) & 0xff;
	eval->val[4] = (as >> 8) & 0xff;
	eval->val[5] = as & 0xff;
	eval->val[6] = (val >> 8) & 0xff;
	eval->val[7] = val & 0xff;
}

extern void ecommunity_init(void);
extern void ecommunity_finish(void);
extern void ecommunity_free(struct ecommunity **);
extern struct ecommunity *ecommunity_parse(uint8_t *, unsigned short);
extern struct ecommunity *ecommunity_dup(struct ecommunity *);
extern struct ecommunity *ecommunity_merge(struct ecommunity *,
					   struct ecommunity *);
extern struct ecommunity *ecommunity_uniq_sort(struct ecommunity *);
extern struct ecommunity *ecommunity_intern(struct ecommunity *);
extern bool ecommunity_cmp(const void *arg1, const void *arg2);
extern void ecommunity_unintern(struct ecommunity **);
extern unsigned int ecommunity_hash_make(void *);
extern struct ecommunity *ecommunity_str2com(const char *, int, int);
extern char *ecommunity_ecom2str(struct ecommunity *, int, int);
extern void ecommunity_strfree(char **s);
extern int ecommunity_match(const struct ecommunity *,
			    const struct ecommunity *);
extern char *ecommunity_str(struct ecommunity *);
extern struct ecommunity_val *ecommunity_lookup(const struct ecommunity *,
						uint8_t, uint8_t);
extern int ecommunity_add_val(struct ecommunity *ecom,
			      struct ecommunity_val *eval);

/* for vpn */
extern struct ecommunity *ecommunity_new(void);
extern int ecommunity_add_val(struct ecommunity *, struct ecommunity_val *);
extern int ecommunity_strip(struct ecommunity *ecom, uint8_t type,
			    uint8_t subtype);
extern struct ecommunity *ecommunity_new(void);
extern int ecommunity_del_val(struct ecommunity *ecom,
			      struct ecommunity_val *eval);
struct bgp_pbr_entry_action;
extern int ecommunity_fill_pbr_action(struct ecommunity_val *ecom_eval,
			       struct bgp_pbr_entry_action *api);

extern void bgp_compute_aggregate_ecommunity(
					struct bgp_aggregate *aggregate,
					struct ecommunity *ecommunity);
extern void bgp_remove_ecommunity_from_aggregate(
					struct bgp_aggregate *aggregate,
					struct ecommunity *ecommunity);
extern void bgp_aggr_ecommunity_remove(void *arg);

#endif /* _QUAGGA_BGP_ECOMMUNITY_H */
Commit	Line	Data
718e3744	1	/* BGP Extended Communities Attribute.
896014f4 DL	2	* Copyright (C) 2000 Kunihiro Ishiguro <kunihiro@zebra.org>
	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_ECOMMUNITY_H
	22	#define _QUAGGA_BGP_ECOMMUNITY_H
	23
5b820d9e NT	24	#include "bgpd/bgp_route.h"
5b820d9e NT	25
718e3744	26	/* High-order octet of the Extended Communities type field. */
	27	#define ECOMMUNITY_ENCODE_AS 0x00
	28	#define ECOMMUNITY_ENCODE_IP 0x01
0b2aa3a0	29	#define ECOMMUNITY_ENCODE_AS4 0x02
0014c301	30	#define ECOMMUNITY_ENCODE_OPAQUE 0x03
e82202b7	31	#define ECOMMUNITY_ENCODE_EVPN 0x06
a8d72b61	32	#define ECOMMUNITY_ENCODE_TRANS_EXP 0x80 /* Flow Spec */
b72220fc	33	#define ECOMMUNITY_ENCODE_REDIRECT_IP_NH 0x08 /* Flow Spec */
a8d72b61 PG	34	/* RFC7674 */
	35	#define ECOMMUNITY_EXTENDED_COMMUNITY_PART_2 0x81
	36	#define ECOMMUNITY_EXTENDED_COMMUNITY_PART_3 0x82
718e3744	37
0014c301	38	/* Low-order octet of the Extended Communities type field. */
718e3744	39	#define ECOMMUNITY_ROUTE_TARGET 0x02
718e3744	40	#define ECOMMUNITY_SITE_ORIGIN 0x03
a8d72b61 PG	41	#define ECOMMUNITY_TRAFFIC_RATE 0x06 /* Flow Spec */
	42	#define ECOMMUNITY_TRAFFIC_ACTION 0x07
	43	#define ECOMMUNITY_REDIRECT_VRF 0x08
	44	#define ECOMMUNITY_TRAFFIC_MARKING 0x09
	45	#define ECOMMUNITY_REDIRECT_IP_NH 0x00
2551b26e PG	46	/* from IANA: bgp-extended-communities/bgp-extended-communities.xhtml
	47	* 0x0c Flow-spec Redirect to IPv4 - draft-ietf-idr-flowspec-redirect
	48	*/
	49	#define ECOMMUNITY_FLOWSPEC_REDIRECT_IPV4 0x0c
718e3744	50
128ea8ab	51	/* Low-order octet of the Extended Communities type field for EVPN types */
1e27ef50 PG	52	#define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY 0x00
	53	#define ECOMMUNITY_EVPN_SUBTYPE_ESI_LABEL 0x01
	54	#define ECOMMUNITY_EVPN_SUBTYPE_ES_IMPORT_RT 0x02
	55	#define ECOMMUNITY_EVPN_SUBTYPE_ROUTERMAC 0x03
	56	#define ECOMMUNITY_EVPN_SUBTYPE_DEF_GW 0x0d
68e33151	57	#define ECOMMUNITY_EVPN_SUBTYPE_ND 0x08
1e27ef50	58
128ea8ab	59	#define ECOMMUNITY_EVPN_SUBTYPE_MACMOBILITY_FLAG_STICKY 0x01
68e33151 CS	60	#define ECOMMUNITY_EVPN_SUBTYPE_ND_ROUTER_FLAG 0x01
68e33151 CS	61	#define ECOMMUNITY_EVPN_SUBTYPE_ND_OVERRIDE_FLAG 0x02
128ea8ab	62
0014c301 LB	63	/* Low-order octet of the Extended Communities type field for OPAQUE types */
	64	#define ECOMMUNITY_OPAQUE_SUBTYPE_ENCAP 0x0c
	65
718e3744	66	/* Extended communities attribute string format. */
	67	#define ECOMMUNITY_FORMAT_ROUTE_MAP 0
	68	#define ECOMMUNITY_FORMAT_COMMUNITY_LIST 1
	69	#define ECOMMUNITY_FORMAT_DISPLAY 2
	70
	71	/* Extended Communities value is eight octet long. */
	72	#define ECOMMUNITY_SIZE 8
	73
4372df71	74	/* Extended Communities type flag. */
7c40bf39	75	#define ECOMMUNITY_FLAG_NON_TRANSITIVE 0x40
4372df71	76
718e3744	77	/* Extended Communities attribute. */
d62a17ae	78	struct ecommunity {
	79	/* Reference counter. */
	80	unsigned long refcnt;
718e3744	81
d62a17ae	82	/* Size of Extended Communities attribute. */
d62a17ae	83	int size;
718e3744	84
d62a17ae	85	/* Extended Communities value. */
d7c0a89a	86	uint8_t *val;
718e3744	87
d62a17ae	88	/* Human readable format string. */
d62a17ae	89	char *str;
718e3744	90	};
718e3744	91
5a0ccebf QY	92	struct ecommunity_as {
	93	as_t as;
	94	uint32_t val;
	95	};
	96
	97	struct ecommunity_ip {
	98	struct in_addr ip;
	99	uint16_t val;
	100	};
	101
718e3744	102	/* Extended community value is eight octet. */
d62a17ae	103	struct ecommunity_val {
d62a17ae	104	char val[ECOMMUNITY_SIZE];
718e3744	105	};
	106
	107	#define ecom_length(X) ((X)->size * ECOMMUNITY_SIZE)
	108
c5900768	109	/*
	110	* Encode BGP Route Target AS:nn.
	111	*/
d7c0a89a	112	static inline void encode_route_target_as(as_t as, uint32_t val,
d62a17ae	113	struct ecommunity_val *eval)
c5900768	114	{
d62a17ae	115	eval->val[0] = ECOMMUNITY_ENCODE_AS;
	116	eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
	117	eval->val[2] = (as >> 8) & 0xff;
	118	eval->val[3] = as & 0xff;
	119	eval->val[4] = (val >> 24) & 0xff;
	120	eval->val[5] = (val >> 16) & 0xff;
	121	eval->val[6] = (val >> 8) & 0xff;
	122	eval->val[7] = val & 0xff;
c5900768	123	}
	124
	125	/*
	126	* Encode BGP Route Target IP:nn.
	127	*/
d7c0a89a	128	static inline void encode_route_target_ip(struct in_addr ip, uint16_t val,
d62a17ae	129	struct ecommunity_val *eval)
c5900768	130	{
d62a17ae	131	eval->val[0] = ECOMMUNITY_ENCODE_IP;
	132	eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
	133	memcpy(&eval->val[2], &ip, sizeof(struct in_addr));
	134	eval->val[6] = (val >> 8) & 0xff;
	135	eval->val[7] = val & 0xff;
c5900768	136	}
	137
	138	/*
	139	* Encode BGP Route Target AS4:nn.
	140	*/
d7c0a89a	141	static inline void encode_route_target_as4(as_t as, uint16_t val,
d62a17ae	142	struct ecommunity_val *eval)
c5900768	143	{
d62a17ae	144	eval->val[0] = ECOMMUNITY_ENCODE_AS4;
	145	eval->val[1] = ECOMMUNITY_ROUTE_TARGET;
	146	eval->val[2] = (as >> 24) & 0xff;
	147	eval->val[3] = (as >> 16) & 0xff;
	148	eval->val[4] = (as >> 8) & 0xff;
	149	eval->val[5] = as & 0xff;
	150	eval->val[6] = (val >> 8) & 0xff;
	151	eval->val[7] = val & 0xff;
c5900768	152	}
c5900768	153
d62a17ae	154	extern void ecommunity_init(void);
	155	extern void ecommunity_finish(void);
	156	extern void ecommunity_free(struct ecommunity **);
d7c0a89a	157	extern struct ecommunity ecommunity_parse(uint8_t , unsigned short);
d62a17ae	158	extern struct ecommunity ecommunity_dup(struct ecommunity );
	159	extern struct ecommunity ecommunity_merge(struct ecommunity ,
	160	struct ecommunity *);
	161	extern struct ecommunity ecommunity_uniq_sort(struct ecommunity );
	162	extern struct ecommunity ecommunity_intern(struct ecommunity );
74df8d6d	163	extern bool ecommunity_cmp(const void arg1, const void arg2);
d62a17ae	164	extern void ecommunity_unintern(struct ecommunity **);
	165	extern unsigned int ecommunity_hash_make(void *);
	166	extern struct ecommunity ecommunity_str2com(const char , int, int);
	167	extern char ecommunity_ecom2str(struct ecommunity , int, int);
c7ee6c35	168	extern void ecommunity_strfree(char **s);
d62a17ae	169	extern int ecommunity_match(const struct ecommunity *,
	170	const struct ecommunity *);
	171	extern char ecommunity_str(struct ecommunity );
	172	extern struct ecommunity_val ecommunity_lookup(const struct ecommunity ,
	173	uint8_t, uint8_t);
	174	extern int ecommunity_add_val(struct ecommunity *ecom,
	175	struct ecommunity_val *eval);
00d252cb	176
65efcfce	177	/* for vpn */
d62a17ae	178	extern struct ecommunity *ecommunity_new(void);
	179	extern int ecommunity_add_val(struct ecommunity , struct ecommunity_val );
	180	extern int ecommunity_strip(struct ecommunity *ecom, uint8_t type,
	181	uint8_t subtype);
	182	extern struct ecommunity *ecommunity_new(void);
44338987	183	extern int ecommunity_del_val(struct ecommunity *ecom,
44338987	184	struct ecommunity_val *eval);
dacf6ec1 PG	185	struct bgp_pbr_entry_action;
	186	extern int ecommunity_fill_pbr_action(struct ecommunity_val *ecom_eval,
	187	struct bgp_pbr_entry_action *api);
	188
5b820d9e NT	189	extern void bgp_compute_aggregate_ecommunity(
	190	struct bgp_aggregate *aggregate,
	191	struct ecommunity *ecommunity);
	192	extern void bgp_remove_ecommunity_from_aggregate(
	193	struct bgp_aggregate *aggregate,
	194	struct ecommunity *ecommunity);
	195	extern void bgp_aggr_ecommunity_remove(void *arg);
	196
00d252cb	197	#endif /* _QUAGGA_BGP_ECOMMUNITY_H */