1 /* AS path related definitions.
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  */
20 
21 #ifndef _QUAGGA_BGP_ASPATH_H
22 #define _QUAGGA_BGP_ASPATH_H
23 
24 #include "lib/json.h"
25 #include "bgpd/bgp_route.h"
26 
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.  */
34 #define BGP_PRIVATE_AS_MIN       64512U
35 #define BGP_PRIVATE_AS_MAX       65535U
36 
37 /* Private 4 byte AS range defined in RFC6996.  */
38 #define BGP_PRIVATE_AS4_MIN     4200000000U
39 #define BGP_PRIVATE_AS4_MAX     4294967294U
40 
41 /* we leave BGP_AS_MAX as the 16bit AS MAX number.  */
42 #define BGP_AS_ZERO		          0
43 #define BGP_AS_MAX		     65535U
44 #define BGP_AS4_MAX		4294967295U
45 /* Transition 16Bit AS as defined by IANA */
46 #define BGP_AS_TRANS		 23456U
47 
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))
51 
52 /* AS_PATH segment data in abstracted form, no limit is placed on length */
53 struct assegment {
54 	struct assegment *next;
55 	as_t *as;
56 	unsigned short length;
57 	uint8_t type;
58 };
59 
60 /* AS path may be include some AsSegments.  */
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;
75 };
76 
77 #define ASPATH_STR_DEFAULT_LEN 32
78 
79 /* Prototypes. */
80 extern void aspath_init(void);
81 extern void aspath_finish(void);
82 extern struct aspath *aspath_parse(struct stream *, size_t, int);
83 extern struct aspath *aspath_dup(struct aspath *);
84 extern struct aspath *aspath_aggregate(struct aspath *, struct aspath *);
85 extern struct aspath *aspath_prepend(struct aspath *, struct aspath *);
86 extern struct aspath *aspath_filter_exclude(struct aspath *, struct aspath *);
87 extern struct aspath *aspath_add_seq_n(struct aspath *, as_t, unsigned);
88 extern struct aspath *aspath_add_seq(struct aspath *, as_t);
89 extern struct aspath *aspath_add_confed_seq(struct aspath *, as_t);
90 extern bool aspath_cmp(const void *as1, const void *as2);
91 extern bool aspath_cmp_left(const struct aspath *, const struct aspath *);
92 extern bool aspath_cmp_left_confed(const struct aspath *as1,
93 				   const struct aspath *as2xs);
94 extern struct aspath *aspath_delete_confed_seq(struct aspath *);
95 extern struct aspath *aspath_empty(void);
96 extern struct aspath *aspath_empty_get(void);
97 extern struct aspath *aspath_str2aspath(const char *);
98 extern void aspath_str_update(struct aspath *as, bool make_json);
99 extern void aspath_free(struct aspath *);
100 extern struct aspath *aspath_intern(struct aspath *);
101 extern void aspath_unintern(struct aspath **);
102 extern const char *aspath_print(struct aspath *);
103 extern void aspath_print_vty(struct vty *, const char *, struct aspath *,
104 			     const char *);
105 extern void aspath_print_all_vty(struct vty *);
106 extern unsigned int aspath_key_make(const void *);
107 extern unsigned int aspath_get_first_as(struct aspath *);
108 extern unsigned int aspath_get_last_as(struct aspath *);
109 extern int aspath_loop_check(struct aspath *, as_t);
110 extern bool aspath_private_as_check(struct aspath *);
111 extern bool aspath_single_asn_check(struct aspath *, as_t asn);
112 extern struct aspath *aspath_replace_specific_asn(struct aspath *aspath,
113 						  as_t target_asn,
114 						  as_t our_asn);
115 extern struct aspath *aspath_replace_private_asns(struct aspath *aspath,
116 						  as_t asn, as_t peer_asn);
117 extern struct aspath *aspath_remove_private_asns(struct aspath *aspath,
118 						 as_t peer_asn);
119 extern bool aspath_firstas_check(struct aspath *, as_t);
120 extern bool aspath_confed_check(struct aspath *);
121 extern bool aspath_left_confed_check(struct aspath *);
122 extern unsigned long aspath_count(void);
123 extern unsigned int aspath_count_hops(const struct aspath *);
124 extern bool aspath_check_as_sets(struct aspath *aspath);
125 extern bool aspath_check_as_zero(struct aspath *aspath);
126 extern unsigned int aspath_count_confeds(struct aspath *);
127 extern unsigned int aspath_size(struct aspath *);
128 extern as_t aspath_highest(struct aspath *);
129 extern as_t aspath_leftmost(struct aspath *);
130 extern size_t aspath_put(struct stream *, struct aspath *, int);
131 
132 extern struct aspath *aspath_reconcile_as4(struct aspath *, struct aspath *);
133 extern bool aspath_has_as4(struct aspath *);
134 
135 /* For SNMP BGP4PATHATTRASPATHSEGMENT, might be useful for debug */
136 extern uint8_t *aspath_snmp_pathseg(struct aspath *, size_t *);
137 
138 extern void bgp_compute_aggregate_aspath(struct bgp_aggregate *aggregate,
139 					 struct aspath *aspath);
140 
141 extern void bgp_compute_aggregate_aspath_hash(struct bgp_aggregate *aggregate,
142 					      struct aspath *aspath);
143 extern void bgp_compute_aggregate_aspath_val(struct bgp_aggregate *aggregate);
144 extern void bgp_remove_aspath_from_aggregate(struct bgp_aggregate *aggregate,
145 					     struct aspath *aspath);
146 extern void bgp_remove_aspath_from_aggregate_hash(
147 						struct bgp_aggregate *aggregate,
148 						struct aspath *aspath);
149 
150 extern void bgp_aggr_aspath_remove(void *arg);
151 
152 #endif /* _QUAGGA_BGP_ASPATH_H */
153