[mirror_frr.git] / bgpd / bgp_aspath.h

/* AS path related definitions.
 * Copyright (C) 1997, 98, 99 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_ASPATH_H
#define _QUAGGA_BGP_ASPATH_H

#include "lib/json.h"
#include "bgpd/bgp_route.h"

/* AS path segment type.  */
#define AS_SET                       1
#define AS_SEQUENCE                  2
#define AS_CONFED_SEQUENCE           3
#define AS_CONFED_SET                4

/* Private AS range defined in RFC2270.  */
#define BGP_PRIVATE_AS_MIN       64512U
#define BGP_PRIVATE_AS_MAX UINT16_MAX

/* Private 4 byte AS range defined in RFC6996.  */
#define BGP_PRIVATE_AS4_MIN     4200000000U
#define BGP_PRIVATE_AS4_MAX     4294967294U

/* we leave BGP_AS_MAX as the 16bit AS MAX number.  */
#define BGP_AS_ZERO		          0
#define BGP_AS_MAX UINT16_MAX
#define BGP_AS4_MAX		4294967295U
/* Transition 16Bit AS as defined by IANA */
#define BGP_AS_TRANS		 23456U

#define BGP_AS_IS_PRIVATE(ASN)                                                 \
	(((ASN) >= BGP_PRIVATE_AS_MIN && (ASN) <= BGP_PRIVATE_AS_MAX)          \
	 || ((ASN) >= BGP_PRIVATE_AS4_MIN && (ASN) <= BGP_PRIVATE_AS4_MAX))

/* AS_PATH segment data in abstracted form, no limit is placed on length */
struct assegment {
	struct assegment *next;
	as_t *as;
	unsigned short length;
	uint8_t type;
};

/* AS path may be include some AsSegments.  */
struct aspath {
	/* Reference count to this aspath.  */
	unsigned long refcnt;

	/* segment data */
	struct assegment *segments;

	/* AS path as a json object */
	json_object *json;

	/* String expression of AS path.  This string is used by vty output
	   and AS path regular expression match.  */
	char *str;
	unsigned short str_len;
};

#define ASPATH_STR_DEFAULT_LEN 32

/* Prototypes. */
extern void aspath_init(void);
extern void aspath_finish(void);
extern struct aspath *aspath_parse(struct stream *s, size_t length,
				   int use32bit);
extern struct aspath *aspath_dup(struct aspath *aspath);
extern struct aspath *aspath_aggregate(struct aspath *as1, struct aspath *as2);
extern struct aspath *aspath_prepend(struct aspath *as1, struct aspath *as2);
extern struct aspath *aspath_filter_exclude(struct aspath *source,
					    struct aspath *exclude_list);
extern struct aspath *aspath_add_seq_n(struct aspath *aspath, as_t asno,
				       unsigned num);
extern struct aspath *aspath_add_seq(struct aspath *aspath, as_t asno);
extern struct aspath *aspath_add_confed_seq(struct aspath *aspath, as_t asno);
extern bool aspath_cmp(const void *as1, const void *as2);
extern bool aspath_cmp_left(const struct aspath *aspath1,
			    const struct aspath *aspath2);
extern bool aspath_cmp_left_confed(const struct aspath *as1,
				   const struct aspath *as2);
extern struct aspath *aspath_delete_confed_seq(struct aspath *aspath);
extern struct aspath *aspath_empty(void);
extern struct aspath *aspath_empty_get(void);
extern struct aspath *aspath_str2aspath(const char *str);
extern void aspath_str_update(struct aspath *as, bool make_json);
extern void aspath_free(struct aspath *aspath);
extern struct aspath *aspath_intern(struct aspath *aspath);
extern void aspath_unintern(struct aspath **aspath);
extern const char *aspath_print(struct aspath *aspath);
extern void aspath_print_vty(struct vty *vty, const char *format,
			     struct aspath *aspath, const char *suffix);
extern void aspath_print_all_vty(struct vty *vty);
extern unsigned int aspath_key_make(const void *p);
extern unsigned int aspath_get_first_as(struct aspath *aspath);
extern unsigned int aspath_get_last_as(struct aspath *aspath);
extern int aspath_loop_check(struct aspath *aspath, as_t asno);
extern int aspath_loop_check_confed(struct aspath *aspath, as_t asno);
extern bool aspath_private_as_check(struct aspath *aspath);
extern struct aspath *aspath_replace_specific_asn(struct aspath *aspath,
						  as_t target_asn,
						  as_t our_asn);
extern struct aspath *aspath_replace_all_asn(struct aspath *aspath,
					     as_t our_asn);
extern struct aspath *aspath_replace_private_asns(struct aspath *aspath,
						  as_t asn, as_t peer_asn);
extern struct aspath *aspath_remove_private_asns(struct aspath *aspath,
						 as_t peer_asn);
extern bool aspath_firstas_check(struct aspath *aspath, as_t asno);
extern bool aspath_confed_check(struct aspath *aspath);
extern bool aspath_left_confed_check(struct aspath *aspath);
extern unsigned long aspath_count(void);
extern unsigned int aspath_count_hops(const struct aspath *aspath);
extern bool aspath_check_as_sets(struct aspath *aspath);
extern bool aspath_check_as_zero(struct aspath *aspath);
extern unsigned int aspath_count_confeds(struct aspath *aspath);
extern unsigned int aspath_size(struct aspath *aspath);
extern as_t aspath_highest(struct aspath *aspath);
extern as_t aspath_leftmost(struct aspath *aspath);
extern size_t aspath_put(struct stream *s, struct aspath *aspath, int use32bit);

extern struct aspath *aspath_reconcile_as4(struct aspath *aspath,
					   struct aspath *as4path);
extern bool aspath_has_as4(struct aspath *aspath);

/* For SNMP BGP4PATHATTRASPATHSEGMENT, might be useful for debug */
extern uint8_t *aspath_snmp_pathseg(struct aspath *aspath, size_t *varlen);

extern void bgp_compute_aggregate_aspath(struct bgp_aggregate *aggregate,
					 struct aspath *aspath);

extern void bgp_compute_aggregate_aspath_hash(struct bgp_aggregate *aggregate,
					      struct aspath *aspath);
extern void bgp_compute_aggregate_aspath_val(struct bgp_aggregate *aggregate);
extern void bgp_remove_aspath_from_aggregate(struct bgp_aggregate *aggregate,
					     struct aspath *aspath);
extern void bgp_remove_aspath_from_aggregate_hash(
						struct bgp_aggregate *aggregate,
						struct aspath *aspath);

extern void bgp_aggr_aspath_remove(void *arg);

#endif /* _QUAGGA_BGP_ASPATH_H */
Commit	Line	Data
718e3744	1	/* AS path related definitions.
896014f4 DL	2	* Copyright (C) 1997, 98, 99 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_ASPATH_H
	22	#define _QUAGGA_BGP_ASPATH_H
	23
f1aa5d8a	24	#include "lib/json.h"
e00d8008	25	#include "bgpd/bgp_route.h"
f1aa5d8a	26
718e3744	27	/* AS path segment type. */
	28	#define AS_SET 1
	29	#define AS_SEQUENCE 2
	30	#define AS_CONFED_SEQUENCE 3
	31	#define AS_CONFED_SET 4
	32
	33	/* Private AS range defined in RFC2270. */
fd79ac91	34	#define BGP_PRIVATE_AS_MIN 64512U
48e1932b	35	#define BGP_PRIVATE_AS_MAX UINT16_MAX
fd79ac91	36
2e8142b2 DS	37	/* Private 4 byte AS range defined in RFC6996. */
	38	#define BGP_PRIVATE_AS4_MIN 4200000000U
	39	#define BGP_PRIVATE_AS4_MAX 4294967294U
	40
0b2aa3a0	41	/* we leave BGP_AS_MAX as the 16bit AS MAX number. */
33d022bc	42	#define BGP_AS_ZERO 0
48e1932b	43	#define BGP_AS_MAX UINT16_MAX
0b2aa3a0 PJ	44	#define BGP_AS4_MAX 4294967295U
	45	/* Transition 16Bit AS as defined by IANA */
	46	#define BGP_AS_TRANS 23456U
718e3744	47
d62a17ae	48	#define BGP_AS_IS_PRIVATE(ASN) \
	49	(((ASN) >= BGP_PRIVATE_AS_MIN && (ASN) <= BGP_PRIVATE_AS_MAX) \
	50	\|\| ((ASN) >= BGP_PRIVATE_AS4_MIN && (ASN) <= BGP_PRIVATE_AS4_MAX))
5000f21c	51
fe69a505	52	/* AS_PATH segment data in abstracted form, no limit is placed on length */
d62a17ae	53	struct assegment {
	54	struct assegment *next;
	55	as_t *as;
d7c0a89a QY	56	unsigned short length;
d7c0a89a QY	57	uint8_t type;
fe69a505	58	};
fe69a505	59
718e3744	60	/* AS path may be include some AsSegments. */
d62a17ae	61	struct aspath {
	62	/* Reference count to this aspath. */
	63	unsigned long refcnt;
	64
	65	/* segment data */
	66	struct assegment *segments;
	67
	68	/* AS path as a json object */
	69	json_object *json;
	70
	71	/* String expression of AS path. This string is used by vty output
	72	and AS path regular expression match. */
	73	char *str;
	74	unsigned short str_len;
718e3744	75	};
	76
	77	#define ASPATH_STR_DEFAULT_LEN 32
	78
	79	/* Prototypes. */
d62a17ae	80	extern void aspath_init(void);
d62a17ae	81	extern void aspath_finish(void);
137a38ac DS	82	extern struct aspath aspath_parse(struct stream s, size_t length,
	83	int use32bit);
	84	extern struct aspath aspath_dup(struct aspath aspath);
	85	extern struct aspath aspath_aggregate(struct aspath as1, struct aspath *as2);
	86	extern struct aspath aspath_prepend(struct aspath as1, struct aspath *as2);
	87	extern struct aspath aspath_filter_exclude(struct aspath source,
	88	struct aspath *exclude_list);
	89	extern struct aspath aspath_add_seq_n(struct aspath aspath, as_t asno,
	90	unsigned num);
	91	extern struct aspath aspath_add_seq(struct aspath aspath, as_t asno);
	92	extern struct aspath aspath_add_confed_seq(struct aspath aspath, as_t asno);
74df8d6d	93	extern bool aspath_cmp(const void as1, const void as2);
137a38ac DS	94	extern bool aspath_cmp_left(const struct aspath *aspath1,
137a38ac DS	95	const struct aspath *aspath2);
74df8d6d	96	extern bool aspath_cmp_left_confed(const struct aspath *as1,
137a38ac DS	97	const struct aspath *as2);
137a38ac DS	98	extern struct aspath aspath_delete_confed_seq(struct aspath aspath);
d62a17ae	99	extern struct aspath *aspath_empty(void);
d62a17ae	100	extern struct aspath *aspath_empty_get(void);
137a38ac	101	extern struct aspath aspath_str2aspath(const char str);
68e1a55b	102	extern void aspath_str_update(struct aspath *as, bool make_json);
137a38ac DS	103	extern void aspath_free(struct aspath *aspath);
	104	extern struct aspath aspath_intern(struct aspath aspath);
	105	extern void aspath_unintern(struct aspath **aspath);
	106	extern const char aspath_print(struct aspath aspath);
	107	extern void aspath_print_vty(struct vty vty, const char format,
	108	struct aspath aspath, const char suffix);
	109	extern void aspath_print_all_vty(struct vty *vty);
	110	extern unsigned int aspath_key_make(const void *p);
	111	extern unsigned int aspath_get_first_as(struct aspath *aspath);
	112	extern unsigned int aspath_get_last_as(struct aspath *aspath);
	113	extern int aspath_loop_check(struct aspath *aspath, as_t asno);
b0a8f709	114	extern int aspath_loop_check_confed(struct aspath *aspath, as_t asno);
137a38ac	115	extern bool aspath_private_as_check(struct aspath *aspath);
d62a17ae	116	extern struct aspath aspath_replace_specific_asn(struct aspath aspath,
	117	as_t target_asn,
	118	as_t our_asn);
77e3d821 DA	119	extern struct aspath aspath_replace_all_asn(struct aspath aspath,
77e3d821 DA	120	as_t our_asn);
d62a17ae	121	extern struct aspath aspath_replace_private_asns(struct aspath aspath,
bf26b80e DS	122	as_t asn, as_t peer_asn);
	123	extern struct aspath aspath_remove_private_asns(struct aspath aspath,
	124	as_t peer_asn);
137a38ac DS	125	extern bool aspath_firstas_check(struct aspath *aspath, as_t asno);
	126	extern bool aspath_confed_check(struct aspath *aspath);
	127	extern bool aspath_left_confed_check(struct aspath *aspath);
d62a17ae	128	extern unsigned long aspath_count(void);
137a38ac	129	extern unsigned int aspath_count_hops(const struct aspath *aspath);
fb29348a	130	extern bool aspath_check_as_sets(struct aspath *aspath);
33d022bc	131	extern bool aspath_check_as_zero(struct aspath *aspath);
137a38ac DS	132	extern unsigned int aspath_count_confeds(struct aspath *aspath);
	133	extern unsigned int aspath_size(struct aspath *aspath);
	134	extern as_t aspath_highest(struct aspath *aspath);
	135	extern as_t aspath_leftmost(struct aspath *aspath);
	136	extern size_t aspath_put(struct stream s, struct aspath aspath, int use32bit);
d62a17ae	137
137a38ac DS	138	extern struct aspath aspath_reconcile_as4(struct aspath aspath,
	139	struct aspath *as4path);
	140	extern bool aspath_has_as4(struct aspath *aspath);
fe69a505	141
fe69a505	142	/* For SNMP BGP4PATHATTRASPATHSEGMENT, might be useful for debug */
137a38ac	143	extern uint8_t aspath_snmp_pathseg(struct aspath aspath, size_t *varlen);
00d252cb	144
e00d8008 NT	145	extern void bgp_compute_aggregate_aspath(struct bgp_aggregate *aggregate,
e00d8008 NT	146	struct aspath *aspath);
ef51a7d8	147
	148	extern void bgp_compute_aggregate_aspath_hash(struct bgp_aggregate *aggregate,
	149	struct aspath *aspath);
	150	extern void bgp_compute_aggregate_aspath_val(struct bgp_aggregate *aggregate);
e00d8008 NT	151	extern void bgp_remove_aspath_from_aggregate(struct bgp_aggregate *aggregate,
e00d8008 NT	152	struct aspath *aspath);
ef51a7d8	153	extern void bgp_remove_aspath_from_aggregate_hash(
	154	struct bgp_aggregate *aggregate,
	155	struct aspath *aspath);
	156
e00d8008 NT	157	extern void bgp_aggr_aspath_remove(void *arg);
e00d8008 NT	158
00d252cb	159	#endif /* _QUAGGA_BGP_ASPATH_H */