]>
Commit | Line | Data |
---|---|---|
acddc0ed | 1 | // SPDX-License-Identifier: GPL-2.0-or-later |
718e3744 | 2 | /* |
3 | * Prefix structure. | |
4 | * Copyright (C) 1998 Kunihiro Ishiguro | |
718e3744 | 5 | */ |
6 | ||
7 | #ifndef _ZEBRA_PREFIX_H | |
8 | #define _ZEBRA_PREFIX_H | |
9 | ||
d62a17ae | 10 | #ifdef GNU_LINUX |
11 | #include <net/ethernet.h> | |
12 | #else | |
13 | #include <netinet/if_ether.h> | |
14 | #endif | |
8cc4198f | 15 | #include "sockunion.h" |
86f1ef44 | 16 | #include "ipaddr.h" |
de1a880c | 17 | #include "compiler.h" |
8cc4198f | 18 | |
5e244469 RW |
19 | #ifdef __cplusplus |
20 | extern "C" { | |
21 | #endif | |
22 | ||
7628d862 DS |
23 | #ifndef ETH_ALEN |
24 | #define ETH_ALEN 6 | |
25 | #endif | |
26 | ||
2ff12693 AK |
27 | /* EVPN route types. */ |
28 | typedef enum { | |
29 | BGP_EVPN_AD_ROUTE = 1, /* Ethernet Auto-Discovery (A-D) route */ | |
30 | BGP_EVPN_MAC_IP_ROUTE, /* MAC/IP Advertisement route */ | |
31 | BGP_EVPN_IMET_ROUTE, /* Inclusive Multicast Ethernet Tag route */ | |
32 | BGP_EVPN_ES_ROUTE, /* Ethernet Segment route */ | |
33 | BGP_EVPN_IP_PREFIX_ROUTE, /* IP Prefix route */ | |
34 | } bgp_evpn_route_type; | |
35 | ||
19bfb274 AK |
36 | /* value of first byte of ESI */ |
37 | #define ESI_TYPE_ARBITRARY 0 /* */ | |
38 | #define ESI_TYPE_LACP 1 /* <> */ | |
39 | #define ESI_TYPE_BRIDGE 2 /* <Root bridge Mac-6B>:<Root Br Priority-2B>:00 */ | |
40 | #define ESI_TYPE_MAC 3 /* <Syst Mac Add-6B>:<Local Discriminator Value-3B> */ | |
41 | #define ESI_TYPE_ROUTER 4 /* <RouterId-4B>:<Local Discriminator Value-4B> */ | |
42 | #define ESI_TYPE_AS 5 /* <AS-4B>:<Local Discriminator Value-4B> */ | |
43 | ||
44 | #define MAX_ESI {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff} | |
45 | ||
46 | ||
c44ab6f1 | 47 | #define EVPN_ETH_TAG_BYTES 4 |
50f74cf1 | 48 | #define ESI_BYTES 10 |
2bb9eff4 | 49 | #define ESI_STR_LEN (3 * ESI_BYTES) |
74e2bd89 | 50 | #define EVPN_DF_ALG_STR_LEN 24 |
50f74cf1 | 51 | |
19bfb274 AK |
52 | /* Maximum number of VTEPs per-ES - |
53 | * XXX - temporary limit for allocating strings etc. | |
54 | */ | |
55 | #define ES_VTEP_MAX_CNT 10 | |
56 | #define ES_VTEP_LIST_STR_SZ (ES_VTEP_MAX_CNT * 16) | |
57 | ||
7628d862 | 58 | #define ETHER_ADDR_STRLEN (3*ETH_ALEN) |
32ac65d9 LB |
59 | /* |
60 | * there isn't a portable ethernet address type. We define our | |
61 | * own to simplify internal handling | |
62 | */ | |
63 | struct ethaddr { | |
d7c0a89a | 64 | uint8_t octet[ETH_ALEN]; |
d62a17ae | 65 | } __attribute__((packed)); |
32ac65d9 LB |
66 | |
67 | ||
d62a17ae | 68 | /* length is the number of valuable bits of prefix structure |
9d303b37 DL |
69 | * 18 bytes is current length in structure, if address is ipv4 |
70 | * 30 bytes is in case of ipv6 | |
71 | */ | |
a440846e | 72 | #define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8) |
73 | #define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8) | |
74 | ||
3714a385 | 75 | typedef struct esi_t_ { |
19bfb274 | 76 | uint8_t val[ESI_BYTES]; |
3714a385 | 77 | } esi_t; |
78 | ||
79 | struct evpn_ead_addr { | |
80 | esi_t esi; | |
81 | uint32_t eth_tag; | |
19bfb274 | 82 | struct ipaddr ip; |
7b0db0e4 | 83 | uint16_t frag_id; |
3714a385 | 84 | }; |
85 | ||
86 | struct evpn_macip_addr { | |
87 | uint32_t eth_tag; | |
d7c0a89a | 88 | uint8_t ip_prefix_length; |
d62a17ae | 89 | struct ethaddr mac; |
3714a385 | 90 | struct ipaddr ip; |
91 | }; | |
92 | ||
93 | struct evpn_imet_addr { | |
d62a17ae | 94 | uint32_t eth_tag; |
3714a385 | 95 | uint8_t ip_prefix_length; |
96 | struct ipaddr ip; | |
97 | }; | |
98 | ||
99 | struct evpn_es_addr { | |
100 | esi_t esi; | |
101 | uint8_t ip_prefix_length; | |
d62a17ae | 102 | struct ipaddr ip; |
a440846e | 103 | }; |
104 | ||
3714a385 | 105 | struct evpn_prefix_addr { |
106 | uint32_t eth_tag; | |
107 | uint8_t ip_prefix_length; | |
108 | struct ipaddr ip; | |
109 | }; | |
110 | ||
111 | /* EVPN address (RFC 7432) */ | |
112 | struct evpn_addr { | |
113 | uint8_t route_type; | |
114 | union { | |
115 | struct evpn_ead_addr _ead_addr; | |
116 | struct evpn_macip_addr _macip_addr; | |
117 | struct evpn_imet_addr _imet_addr; | |
118 | struct evpn_es_addr _es_addr; | |
119 | struct evpn_prefix_addr _prefix_addr; | |
120 | } u; | |
121 | #define ead_addr u._ead_addr | |
122 | #define macip_addr u._macip_addr | |
123 | #define imet_addr u._imet_addr | |
124 | #define es_addr u._es_addr | |
125 | #define prefix_addr u._prefix_addr | |
126 | }; | |
a440846e | 127 | |
9d24baaa | 128 | /* |
129 | * A struct prefix contains an address family, a prefix length, and an | |
130 | * address. This can represent either a 'network prefix' as defined | |
131 | * by CIDR, where the 'host bits' of the prefix are 0 | |
132 | * (e.g. AF_INET:10.0.0.0/8), or an address and netmask | |
133 | * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an | |
134 | * interface. | |
135 | */ | |
136 | ||
32ac65d9 LB |
137 | /* different OSes use different names */ |
138 | #if defined(AF_PACKET) | |
139 | #define AF_ETHERNET AF_PACKET | |
140 | #else | |
141 | #if defined(AF_LINK) | |
142 | #define AF_ETHERNET AF_LINK | |
143 | #endif | |
144 | #endif | |
145 | ||
b03b8898 DS |
146 | /* The 'family' in the prefix structure is internal to FRR and need not |
147 | * map to standard OS AF_ definitions except where needed for interacting | |
148 | * with the kernel. However, AF_ definitions are currently in use and | |
149 | * prevalent across the code. Define a new FRR-specific AF for EVPN to | |
150 | * distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and | |
151 | * ensure it does not conflict with any OS AF_ definition. | |
152 | */ | |
153 | #if !defined(AF_EVPN) | |
154 | #define AF_EVPN (AF_MAX + 1) | |
155 | #endif | |
156 | ||
9a14899b PG |
157 | #if !defined(AF_FLOWSPEC) |
158 | #define AF_FLOWSPEC (AF_MAX + 2) | |
159 | #endif | |
160 | ||
161 | struct flowspec_prefix { | |
e4552d66 | 162 | uint8_t family; |
9a14899b PG |
163 | uint16_t prefixlen; /* length in bytes */ |
164 | uintptr_t ptr; | |
165 | }; | |
166 | ||
b03b8898 | 167 | /* FRR generic prefix structure. */ |
d62a17ae | 168 | struct prefix { |
d7c0a89a | 169 | uint8_t family; |
f93eee44 | 170 | uint16_t prefixlen; |
d62a17ae | 171 | union { |
d7c0a89a | 172 | uint8_t prefix; |
d62a17ae | 173 | struct in_addr prefix4; |
174 | struct in6_addr prefix6; | |
175 | struct { | |
176 | struct in_addr id; | |
177 | struct in_addr adv_router; | |
178 | } lp; | |
179 | struct ethaddr prefix_eth; /* AF_ETHERNET */ | |
d7c0a89a | 180 | uint8_t val[16]; |
6a923ca4 | 181 | uint32_t val32[4]; |
d62a17ae | 182 | uintptr_t ptr; |
b03b8898 | 183 | struct evpn_addr prefix_evpn; /* AF_EVPN */ |
9a14899b | 184 | struct flowspec_prefix prefix_flowspec; /* AF_FLOWSPEC */ |
d62a17ae | 185 | } u __attribute__((aligned(8))); |
718e3744 | 186 | }; |
187 | ||
188 | /* IPv4 prefix structure. */ | |
d62a17ae | 189 | struct prefix_ipv4 { |
d7c0a89a | 190 | uint8_t family; |
f93eee44 | 191 | uint16_t prefixlen; |
d62a17ae | 192 | struct in_addr prefix __attribute__((aligned(8))); |
718e3744 | 193 | }; |
194 | ||
195 | /* IPv6 prefix structure. */ | |
d62a17ae | 196 | struct prefix_ipv6 { |
d7c0a89a | 197 | uint8_t family; |
f93eee44 | 198 | uint16_t prefixlen; |
d62a17ae | 199 | struct in6_addr prefix __attribute__((aligned(8))); |
718e3744 | 200 | }; |
718e3744 | 201 | |
d62a17ae | 202 | struct prefix_ls { |
d7c0a89a | 203 | uint8_t family; |
f93eee44 | 204 | uint16_t prefixlen; |
d62a17ae | 205 | struct in_addr id __attribute__((aligned(8))); |
206 | struct in_addr adv_router; | |
718e3744 | 207 | }; |
208 | ||
209 | /* Prefix for routing distinguisher. */ | |
d62a17ae | 210 | struct prefix_rd { |
d7c0a89a | 211 | uint8_t family; |
f93eee44 | 212 | uint16_t prefixlen; |
d7c0a89a | 213 | uint8_t val[8] __attribute__((aligned(8))); |
718e3744 | 214 | }; |
215 | ||
32ac65d9 | 216 | /* Prefix for ethernet. */ |
d62a17ae | 217 | struct prefix_eth { |
d7c0a89a | 218 | uint8_t family; |
f93eee44 | 219 | uint16_t prefixlen; |
d62a17ae | 220 | struct ethaddr eth_addr __attribute__((aligned(8))); /* AF_ETHERNET */ |
32ac65d9 LB |
221 | }; |
222 | ||
86f1ef44 | 223 | /* EVPN prefix structure. */ |
d62a17ae | 224 | struct prefix_evpn { |
d7c0a89a | 225 | uint8_t family; |
f93eee44 | 226 | uint16_t prefixlen; |
d62a17ae | 227 | struct evpn_addr prefix __attribute__((aligned(8))); |
86f1ef44 | 228 | }; |
229 | ||
3714a385 | 230 | static inline int is_evpn_prefix_ipaddr_none(const struct prefix_evpn *evp) |
231 | { | |
2ff12693 | 232 | if (evp->prefix.route_type == BGP_EVPN_AD_ROUTE) |
19bfb274 | 233 | return IS_IPADDR_NONE(&(evp)->prefix.ead_addr.ip); |
2ff12693 | 234 | if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE) |
3714a385 | 235 | return IS_IPADDR_NONE(&(evp)->prefix.macip_addr.ip); |
2ff12693 | 236 | if (evp->prefix.route_type == BGP_EVPN_IMET_ROUTE) |
3714a385 | 237 | return IS_IPADDR_NONE(&(evp)->prefix.imet_addr.ip); |
2ff12693 | 238 | if (evp->prefix.route_type == BGP_EVPN_ES_ROUTE) |
50f74cf1 | 239 | return IS_IPADDR_NONE(&(evp)->prefix.es_addr.ip); |
2ff12693 | 240 | if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE) |
3714a385 | 241 | return IS_IPADDR_NONE(&(evp)->prefix.prefix_addr.ip); |
242 | return 0; | |
243 | } | |
244 | ||
245 | static inline int is_evpn_prefix_ipaddr_v4(const struct prefix_evpn *evp) | |
246 | { | |
2ff12693 | 247 | if (evp->prefix.route_type == BGP_EVPN_AD_ROUTE) |
19bfb274 | 248 | return IS_IPADDR_V4(&(evp)->prefix.ead_addr.ip); |
2ff12693 | 249 | if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE) |
3714a385 | 250 | return IS_IPADDR_V4(&(evp)->prefix.macip_addr.ip); |
2ff12693 | 251 | if (evp->prefix.route_type == BGP_EVPN_IMET_ROUTE) |
3714a385 | 252 | return IS_IPADDR_V4(&(evp)->prefix.imet_addr.ip); |
2ff12693 | 253 | if (evp->prefix.route_type == BGP_EVPN_ES_ROUTE) |
50f74cf1 | 254 | return IS_IPADDR_V4(&(evp)->prefix.es_addr.ip); |
2ff12693 | 255 | if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE) |
3714a385 | 256 | return IS_IPADDR_V4(&(evp)->prefix.prefix_addr.ip); |
257 | return 0; | |
258 | } | |
259 | ||
260 | static inline int is_evpn_prefix_ipaddr_v6(const struct prefix_evpn *evp) | |
261 | { | |
2ff12693 | 262 | if (evp->prefix.route_type == BGP_EVPN_AD_ROUTE) |
19bfb274 | 263 | return IS_IPADDR_V6(&(evp)->prefix.ead_addr.ip); |
2ff12693 | 264 | if (evp->prefix.route_type == BGP_EVPN_MAC_IP_ROUTE) |
3714a385 | 265 | return IS_IPADDR_V6(&(evp)->prefix.macip_addr.ip); |
2ff12693 | 266 | if (evp->prefix.route_type == BGP_EVPN_IMET_ROUTE) |
3714a385 | 267 | return IS_IPADDR_V6(&(evp)->prefix.imet_addr.ip); |
2ff12693 | 268 | if (evp->prefix.route_type == BGP_EVPN_ES_ROUTE) |
50f74cf1 | 269 | return IS_IPADDR_V6(&(evp)->prefix.es_addr.ip); |
2ff12693 | 270 | if (evp->prefix.route_type == BGP_EVPN_IP_PREFIX_ROUTE) |
3714a385 | 271 | return IS_IPADDR_V6(&(evp)->prefix.prefix_addr.ip); |
272 | return 0; | |
273 | } | |
274 | ||
9a14899b PG |
275 | /* Prefix for a Flowspec entry */ |
276 | struct prefix_fs { | |
277 | uint8_t family; | |
f93eee44 | 278 | uint16_t prefixlen; /* unused */ |
9a14899b PG |
279 | struct flowspec_prefix prefix __attribute__((aligned(8))); |
280 | }; | |
281 | ||
d62a17ae | 282 | struct prefix_sg { |
d7c0a89a | 283 | uint8_t family; |
f93eee44 | 284 | uint16_t prefixlen; |
d62a17ae | 285 | struct in_addr src __attribute__((aligned(8))); |
286 | struct in_addr grp; | |
e9219290 DS |
287 | }; |
288 | ||
d62a17ae | 289 | union prefixptr { |
be566e4e DL |
290 | prefixtype(prefixptr, struct prefix, p) |
291 | prefixtype(prefixptr, struct prefix_ipv4, p4) | |
292 | prefixtype(prefixptr, struct prefix_ipv6, p6) | |
293 | prefixtype(prefixptr, struct prefix_evpn, evp) | |
294 | prefixtype(prefixptr, struct prefix_fs, fs) | |
132b6a91 | 295 | prefixtype(prefixptr, struct prefix_rd, rd) |
5d387792 | 296 | } TRANSPARENT_UNION; |
d62a17ae | 297 | |
298 | union prefixconstptr { | |
be566e4e DL |
299 | prefixtype(prefixconstptr, const struct prefix, p) |
300 | prefixtype(prefixconstptr, const struct prefix_ipv4, p4) | |
301 | prefixtype(prefixconstptr, const struct prefix_ipv6, p6) | |
302 | prefixtype(prefixconstptr, const struct prefix_evpn, evp) | |
303 | prefixtype(prefixconstptr, const struct prefix_fs, fs) | |
132b6a91 | 304 | prefixtype(prefixconstptr, const struct prefix_rd, rd) |
5d387792 DL |
305 | } TRANSPARENT_UNION; |
306 | ||
718e3744 | 307 | #ifndef INET_ADDRSTRLEN |
308 | #define INET_ADDRSTRLEN 16 | |
309 | #endif /* INET_ADDRSTRLEN */ | |
310 | ||
311 | #ifndef INET6_ADDRSTRLEN | |
f93eee44 | 312 | /* dead:beef:dead:beef:dead:beef:dead:beef + \0 */ |
718e3744 | 313 | #define INET6_ADDRSTRLEN 46 |
314 | #endif /* INET6_ADDRSTRLEN */ | |
315 | ||
316 | #ifndef INET6_BUFSIZ | |
f93eee44 | 317 | #define INET6_BUFSIZ 53 |
718e3744 | 318 | #endif /* INET6_BUFSIZ */ |
319 | ||
61be6e94 QY |
320 | /* Maximum string length of the result of prefix2str */ |
321 | #define PREFIX_STRLEN 80 | |
855110bb | 322 | |
c6b6b53b | 323 | /* |
9deed2ad | 324 | * Longest possible length of a (S,G) string is 34 bytes |
fef32740 | 325 | * 123.123.123.123 = 15 * 2 |
c6b6b53b AK |
326 | * (,) = 3 |
327 | * NULL Character at end = 1 | |
328 | * (123.123.123.123,123.123.123.123) | |
329 | */ | |
fef32740 | 330 | #define PREFIX_SG_STR_LEN 34 |
c6b6b53b | 331 | |
718e3744 | 332 | /* Max bit/byte length of IPv4 address. */ |
333 | #define IPV4_MAX_BYTELEN 4 | |
334 | #define IPV4_MAX_BITLEN 32 | |
718e3744 | 335 | #define IPV4_ADDR_CMP(D,S) memcmp ((D), (S), IPV4_MAX_BYTELEN) |
19aad877 JB |
336 | |
337 | static inline bool ipv4_addr_same(const struct in_addr *a, | |
338 | const struct in_addr *b) | |
339 | { | |
340 | return (a->s_addr == b->s_addr); | |
341 | } | |
342 | #define IPV4_ADDR_SAME(A,B) ipv4_addr_same((A), (B)) | |
343 | ||
344 | static inline void ipv4_addr_copy(struct in_addr *dst, | |
345 | const struct in_addr *src) | |
346 | { | |
347 | dst->s_addr = src->s_addr; | |
348 | } | |
349 | #define IPV4_ADDR_COPY(D,S) ipv4_addr_copy((D), (S)) | |
718e3744 | 350 | |
d7c0a89a QY |
351 | #define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000) |
352 | #define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000) | |
353 | #define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000) | |
d80132b1 DA |
354 | #define IPV4_CLASS_D(a) ((((uint32_t)(a)) & 0xf0000000) == 0xe0000000) |
355 | #define IPV4_CLASS_E(a) ((((uint32_t)(a)) & 0xf0000000) == 0xf0000000) | |
d7c0a89a QY |
356 | #define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000) |
357 | #define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000) | |
718e3744 | 358 | |
359 | /* Max bit/byte length of IPv6 address. */ | |
360 | #define IPV6_MAX_BYTELEN 16 | |
361 | #define IPV6_MAX_BITLEN 128 | |
718e3744 | 362 | #define IPV6_ADDR_CMP(D,S) memcmp ((D), (S), IPV6_MAX_BYTELEN) |
363 | #define IPV6_ADDR_SAME(D,S) (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0) | |
364 | #define IPV6_ADDR_COPY(D,S) memcpy ((D), (S), IPV6_MAX_BYTELEN) | |
365 | ||
366 | /* Count prefix size from mask length */ | |
367 | #define PSIZE(a) (((a) + 7) / (8)) | |
368 | ||
cd1964ff DS |
369 | #define BSIZE(a) ((a) * (8)) |
370 | ||
718e3744 | 371 | /* Prefix's family member. */ |
372 | #define PREFIX_FAMILY(p) ((p)->family) | |
373 | ||
5c6ed111 DL |
374 | /* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */ |
375 | #ifndef s6_addr32 | |
5c6ed111 | 376 | #define s6_addr32 __u6_addr.__u6_addr32 |
5c6ed111 DL |
377 | #endif /*s6_addr32*/ |
378 | ||
718e3744 | 379 | /* Prototypes. */ |
f3ccedaa | 380 | extern int str2family(const char *); |
d62a17ae | 381 | extern int afi2family(afi_t); |
382 | extern afi_t family2afi(int); | |
db2fde34 | 383 | extern const char *family2str(int family); |
1ec23d90 | 384 | extern const char *safi2str(safi_t safi); |
32ac65d9 | 385 | extern const char *afi2str(afi_t afi); |
0884f164 | 386 | extern const char *afi2str_lower(afi_t afi); |
8cc4198f | 387 | |
0e8d473b DL |
388 | static inline afi_t prefix_afi(union prefixconstptr pu) |
389 | { | |
390 | return family2afi(pu.p->family); | |
391 | } | |
392 | ||
adeb0672 QY |
393 | /* |
394 | * Check bit of the prefix. | |
395 | * | |
396 | * prefix | |
397 | * byte buffer | |
398 | * | |
399 | * bit_index | |
400 | * which bit to fetch from byte buffer, 0 indexed. | |
401 | */ | |
402 | extern unsigned int prefix_bit(const uint8_t *prefix, const uint16_t bit_index); | |
f63f06da | 403 | |
d62a17ae | 404 | extern struct prefix *prefix_new(void); |
63265b5c DS |
405 | extern void prefix_free(struct prefix **p); |
406 | /* | |
407 | * Function to handle prefix_free being used as a del function. | |
408 | */ | |
409 | extern void prefix_free_lists(void *arg); | |
3125fa6d DL |
410 | extern const char *prefix_family_str(union prefixconstptr pu); |
411 | extern int prefix_blen(union prefixconstptr pu); | |
d62a17ae | 412 | extern int str2prefix(const char *, struct prefix *); |
4690c7d7 | 413 | |
a9ea959f | 414 | #define PREFIX2STR_BUFFER PREFIX_STRLEN |
415 | ||
c6b6b53b AK |
416 | extern void prefix_mcast_inet4_dump(const char *onfail, struct in_addr addr, |
417 | char *buf, int buf_size); | |
418 | extern const char *prefix_sg2str(const struct prefix_sg *sg, char *str); | |
d62a17ae | 419 | extern const char *prefix2str(union prefixconstptr, char *, int); |
44c69747 LK |
420 | extern int evpn_type5_prefix_match(const struct prefix *evpn_pfx, |
421 | const struct prefix *match_pfx); | |
3125fa6d DL |
422 | extern int prefix_match(union prefixconstptr unet, union prefixconstptr upfx); |
423 | extern int prefix_match_network_statement(union prefixconstptr unet, | |
424 | union prefixconstptr upfx); | |
425 | extern int prefix_same(union prefixconstptr ua, union prefixconstptr ub); | |
426 | extern int prefix_cmp(union prefixconstptr ua, union prefixconstptr ub); | |
427 | extern int prefix_common_bits(union prefixconstptr ua, union prefixconstptr ub); | |
428 | extern void prefix_copy(union prefixptr udst, union prefixconstptr usrc); | |
429 | extern void apply_mask(union prefixptr pu); | |
d62a17ae | 430 | |
4937287f DL |
431 | #ifdef __clang_analyzer__ |
432 | /* clang-SA doesn't understand transparent unions, making it think that the | |
433 | * target of prefix_copy is uninitialized. So just memset the target. | |
434 | * cf. https://bugs.llvm.org/show_bug.cgi?id=42811 | |
435 | */ | |
436 | #define prefix_copy(a, b) ({ memset(a, 0, sizeof(*a)); prefix_copy(a, b); }) | |
437 | #endif | |
438 | ||
d62a17ae | 439 | extern struct prefix *sockunion2hostprefix(const union sockunion *, |
440 | struct prefix *p); | |
441 | extern void prefix2sockunion(const struct prefix *, union sockunion *); | |
442 | ||
443 | extern int str2prefix_eth(const char *, struct prefix_eth *); | |
444 | ||
445 | extern struct prefix_ipv4 *prefix_ipv4_new(void); | |
63265b5c | 446 | extern void prefix_ipv4_free(struct prefix_ipv4 **p); |
d62a17ae | 447 | extern int str2prefix_ipv4(const char *, struct prefix_ipv4 *); |
448 | extern void apply_mask_ipv4(struct prefix_ipv4 *); | |
449 | ||
d62a17ae | 450 | extern int prefix_ipv4_any(const struct prefix_ipv4 *); |
451 | extern void apply_classful_mask_ipv4(struct prefix_ipv4 *); | |
8cc4198f | 452 | |
d7c0a89a | 453 | extern uint8_t ip_masklen(struct in_addr); |
d62a17ae | 454 | extern void masklen2ip(const int, struct in_addr *); |
3fb9cd6e | 455 | /* given the address of a host on a network and the network mask length, |
456 | * calculate the broadcast address for that network; | |
2d48474e | 457 | * special treatment for /31 according to RFC3021 section 3.3 */ |
d62a17ae | 458 | extern in_addr_t ipv4_broadcast_addr(in_addr_t hostaddr, int masklen); |
3fb9cd6e | 459 | |
7533cad7 | 460 | extern int netmask_str2prefix_str(const char *, const char *, char *, size_t); |
718e3744 | 461 | |
d62a17ae | 462 | extern struct prefix_ipv6 *prefix_ipv6_new(void); |
63265b5c | 463 | extern void prefix_ipv6_free(struct prefix_ipv6 **p); |
d62a17ae | 464 | extern int str2prefix_ipv6(const char *, struct prefix_ipv6 *); |
465 | extern void apply_mask_ipv6(struct prefix_ipv6 *); | |
718e3744 | 466 | |
d62a17ae | 467 | extern int ip6_masklen(struct in6_addr); |
468 | extern void masklen2ip6(const int, struct in6_addr *); | |
b04c699e | 469 | |
a9e08ebc | 470 | extern int is_zero_mac(const struct ethaddr *mac); |
c6ec0c74 KA |
471 | extern bool is_mcast_mac(const struct ethaddr *mac); |
472 | extern bool is_bcast_mac(const struct ethaddr *mac); | |
db42a173 PG |
473 | extern int prefix_str2mac(const char *str, struct ethaddr *mac); |
474 | extern char *prefix_mac2str(const struct ethaddr *mac, char *buf, int size); | |
c215ecaf | 475 | |
62b4b3b6 | 476 | extern unsigned prefix_hash_key(const void *pp); |
7a7761d2 | 477 | |
50f74cf1 | 478 | extern int str_to_esi(const char *str, esi_t *esi); |
479 | extern char *esi_to_str(const esi_t *esi, char *buf, int size); | |
74e2bd89 | 480 | extern char *evpn_es_df_alg2str(uint8_t df_alg, char *buf, int buf_len); |
50f74cf1 | 481 | extern void prefix_evpn_hexdump(const struct prefix_evpn *p); |
d80132b1 | 482 | extern bool ipv4_unicast_valid(const struct in_addr *addr); |
6eb83505 | 483 | extern int evpn_prefix2prefix(const struct prefix *evpn, struct prefix *to); |
e24a6977 | 484 | |
9c86ee1e | 485 | static inline int ipv6_martian(const struct in6_addr *addr) |
d914d5ff | 486 | { |
d62a17ae | 487 | struct in6_addr localhost_addr; |
d914d5ff | 488 | |
d62a17ae | 489 | inet_pton(AF_INET6, "::1", &localhost_addr); |
d914d5ff | 490 | |
d62a17ae | 491 | if (IPV6_ADDR_SAME(&localhost_addr, addr)) |
492 | return 1; | |
d914d5ff | 493 | |
d62a17ae | 494 | return 0; |
d914d5ff DS |
495 | } |
496 | ||
d37ba549 | 497 | extern int macstr2prefix_evpn(const char *str, struct prefix_evpn *p); |
718e3744 | 498 | |
d914d5ff | 499 | /* NOTE: This routine expects the address argument in network byte order. */ |
e66b8e39 | 500 | static inline bool ipv4_martian(const struct in_addr *addr) |
6ee06fa9 | 501 | { |
d62a17ae | 502 | in_addr_t ip = ntohl(addr->s_addr); |
6ee06fa9 | 503 | |
e24a6977 | 504 | if (IPV4_NET0(ip) || IPV4_NET127(ip) || !ipv4_unicast_valid(addr)) { |
e66b8e39 | 505 | return true; |
d62a17ae | 506 | } |
e66b8e39 | 507 | return false; |
6ee06fa9 PM |
508 | } |
509 | ||
1fe59b44 | 510 | static inline bool is_default_prefix4(const struct prefix_ipv4 *p) |
18ff3edd | 511 | { |
1fe59b44 RZ |
512 | return p && p->family == AF_INET && p->prefixlen == 0 |
513 | && p->prefix.s_addr == INADDR_ANY; | |
514 | } | |
18ff3edd | 515 | |
1fe59b44 RZ |
516 | static inline bool is_default_prefix6(const struct prefix_ipv6 *p) |
517 | { | |
518 | return p && p->family == AF_INET6 && p->prefixlen == 0 | |
519 | && memcmp(&p->prefix, &in6addr_any, sizeof(struct in6_addr)) | |
520 | == 0; | |
521 | } | |
f229873a | 522 | |
1fe59b44 RZ |
523 | static inline bool is_default_prefix(const struct prefix *p) |
524 | { | |
525 | if (p == NULL) | |
526 | return false; | |
527 | ||
528 | switch (p->family) { | |
529 | case AF_INET: | |
530 | return is_default_prefix4((const struct prefix_ipv4 *)p); | |
531 | case AF_INET6: | |
532 | return is_default_prefix6((const struct prefix_ipv6 *)p); | |
533 | } | |
18ff3edd | 534 | |
1fe59b44 | 535 | return false; |
18ff3edd DS |
536 | } |
537 | ||
0b700537 | 538 | static inline int is_host_route(const struct prefix *p) |
408b00c4 MK |
539 | { |
540 | if (p->family == AF_INET) | |
541 | return (p->prefixlen == IPV4_MAX_BITLEN); | |
542 | else if (p->family == AF_INET6) | |
543 | return (p->prefixlen == IPV6_MAX_BITLEN); | |
544 | return 0; | |
545 | } | |
5e244469 | 546 | |
35518f54 | 547 | static inline int is_default_host_route(const struct prefix *p) |
1eb6c3ea CS |
548 | { |
549 | if (p->family == AF_INET) { | |
550 | return (p->u.prefix4.s_addr == INADDR_ANY && | |
551 | p->prefixlen == IPV4_MAX_BITLEN); | |
552 | } else if (p->family == AF_INET6) { | |
553 | return ((!memcmp(&p->u.prefix6, &in6addr_any, | |
554 | sizeof(struct in6_addr))) && | |
555 | p->prefixlen == IPV6_MAX_BITLEN); | |
556 | } | |
557 | return 0; | |
558 | } | |
559 | ||
3a0d338b MR |
560 | static inline bool is_ipv6_global_unicast(const struct in6_addr *p) |
561 | { | |
562 | if (IN6_IS_ADDR_UNSPECIFIED(p) || IN6_IS_ADDR_LOOPBACK(p) || | |
563 | IN6_IS_ADDR_LINKLOCAL(p) || IN6_IS_ADDR_MULTICAST(p)) | |
564 | return false; | |
565 | ||
566 | return true; | |
567 | } | |
568 | ||
eeec4112 DL |
569 | /* IPv6 scope values, usable for IPv4 too (cf. below) */ |
570 | /* clang-format off */ | |
571 | enum { | |
572 | /* 0: reserved */ | |
573 | MCAST_SCOPE_IFACE = 0x1, | |
574 | MCAST_SCOPE_LINK = 0x2, | |
575 | MCAST_SCOPE_REALM = 0x3, | |
576 | MCAST_SCOPE_ADMIN = 0x4, | |
577 | MCAST_SCOPE_SITE = 0x5, | |
578 | /* 6-7: unassigned */ | |
579 | MCAST_SCOPE_ORG = 0x8, | |
580 | /* 9-d: unassigned */ | |
581 | MCAST_SCOPE_GLOBAL = 0xe, | |
582 | /* f: reserved */ | |
583 | }; | |
584 | /* clang-format on */ | |
585 | ||
586 | static inline uint8_t ipv6_mcast_scope(const struct in6_addr *addr) | |
587 | { | |
588 | return addr->s6_addr[1] & 0xf; | |
589 | } | |
590 | ||
591 | static inline bool ipv6_mcast_nofwd(const struct in6_addr *addr) | |
592 | { | |
593 | return (addr->s6_addr[1] & 0xf) <= MCAST_SCOPE_LINK; | |
594 | } | |
595 | ||
596 | static inline bool ipv6_mcast_ssm(const struct in6_addr *addr) | |
597 | { | |
598 | uint32_t bits = ntohl(addr->s6_addr32[0]); | |
599 | ||
600 | /* ff3x:0000::/32 */ | |
601 | return (bits & 0xfff0ffff) == 0xff300000; | |
602 | } | |
603 | ||
604 | static inline uint8_t ipv4_mcast_scope(const struct in_addr *addr) | |
605 | { | |
606 | uint32_t bits = ntohl(addr->s_addr); | |
607 | ||
608 | /* 224.0.0.0/24 - link scope */ | |
609 | if ((bits & 0xffffff00) == 0xe0000000) | |
610 | return MCAST_SCOPE_LINK; | |
611 | /* 239.0.0.0/8 - org scope */ | |
612 | if ((bits & 0xff000000) == 0xef000000) | |
613 | return MCAST_SCOPE_ORG; | |
614 | ||
615 | return MCAST_SCOPE_GLOBAL; | |
616 | } | |
617 | ||
618 | static inline bool ipv4_mcast_nofwd(const struct in_addr *addr) | |
619 | { | |
620 | uint32_t bits = ntohl(addr->s_addr); | |
621 | ||
622 | /* 224.0.0.0/24 */ | |
623 | return (bits & 0xffffff00) == 0xe0000000; | |
624 | } | |
625 | ||
626 | static inline bool ipv4_mcast_ssm(const struct in_addr *addr) | |
627 | { | |
628 | uint32_t bits = ntohl(addr->s_addr); | |
629 | ||
630 | /* 232.0.0.0/8 */ | |
631 | return (bits & 0xff000000) == 0xe8000000; | |
632 | } | |
633 | ||
07ef3e34 | 634 | #ifdef _FRR_ATTRIBUTE_PRINTFRR |
bd0ab4d8 DL |
635 | #pragma FRR printfrr_ext "%pEA" (struct ethaddr *) |
636 | ||
07ef3e34 DL |
637 | #pragma FRR printfrr_ext "%pI4" (struct in_addr *) |
638 | #pragma FRR printfrr_ext "%pI4" (in_addr_t *) | |
639 | ||
640 | #pragma FRR printfrr_ext "%pI6" (struct in6_addr *) | |
641 | ||
642 | #pragma FRR printfrr_ext "%pFX" (struct prefix *) | |
643 | #pragma FRR printfrr_ext "%pFX" (struct prefix_ipv4 *) | |
644 | #pragma FRR printfrr_ext "%pFX" (struct prefix_ipv6 *) | |
645 | #pragma FRR printfrr_ext "%pFX" (struct prefix_eth *) | |
646 | #pragma FRR printfrr_ext "%pFX" (struct prefix_evpn *) | |
647 | #pragma FRR printfrr_ext "%pFX" (struct prefix_fs *) | |
4a8cd6ad PG |
648 | #pragma FRR printfrr_ext "%pRDP" (struct prefix_rd *) |
649 | /* RD with AS4B with dot and dot+ format */ | |
650 | #pragma FRR printfrr_ext "%pRDD" (struct prefix_rd *) | |
651 | #pragma FRR printfrr_ext "%pRDE" (struct prefix_rd *) | |
07ef3e34 | 652 | |
d51f8b0f | 653 | #pragma FRR printfrr_ext "%pPSG4" (struct prefix_sg *) |
07ef3e34 DL |
654 | #endif |
655 | ||
5e244469 RW |
656 | #ifdef __cplusplus |
657 | } | |
658 | #endif | |
659 | ||
718e3744 | 660 | #endif /* _ZEBRA_PREFIX_H */ |