3 * Copyright (C) 1998 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #ifndef _ZEBRA_PREFIX_H
23 #define _ZEBRA_PREFIX_H
26 #include <sys/ethernet.h>
29 #include <net/ethernet.h>
31 #include <netinet/if_ether.h>
34 #include "sockunion.h"
46 /* EVPN route types. */
48 BGP_EVPN_AD_ROUTE
= 1, /* Ethernet Auto-Discovery (A-D) route */
49 BGP_EVPN_MAC_IP_ROUTE
, /* MAC/IP Advertisement route */
50 BGP_EVPN_IMET_ROUTE
, /* Inclusive Multicast Ethernet Tag route */
51 BGP_EVPN_ES_ROUTE
, /* Ethernet Segment route */
52 BGP_EVPN_IP_PREFIX_ROUTE
, /* IP Prefix route */
53 } bgp_evpn_route_type
;
55 /* value of first byte of ESI */
56 #define ESI_TYPE_ARBITRARY 0 /* */
57 #define ESI_TYPE_LACP 1 /* <> */
58 #define ESI_TYPE_BRIDGE 2 /* <Root bridge Mac-6B>:<Root Br Priority-2B>:00 */
59 #define ESI_TYPE_MAC 3 /* <Syst Mac Add-6B>:<Local Discriminator Value-3B> */
60 #define ESI_TYPE_ROUTER 4 /* <RouterId-4B>:<Local Discriminator Value-4B> */
61 #define ESI_TYPE_AS 5 /* <AS-4B>:<Local Discriminator Value-4B> */
63 #define MAX_ESI {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
66 #define EVPN_ETH_TAG_BYTES 4
68 #define ESI_STR_LEN (3 * ESI_BYTES)
70 /* Maximum number of VTEPs per-ES -
71 * XXX - temporary limit for allocating strings etc.
73 #define ES_VTEP_MAX_CNT 10
74 #define ES_VTEP_LIST_STR_SZ (ES_VTEP_MAX_CNT * 16)
76 #define ETHER_ADDR_STRLEN (3*ETH_ALEN)
78 * there isn't a portable ethernet address type. We define our
79 * own to simplify internal handling
82 uint8_t octet
[ETH_ALEN
];
83 } __attribute__((packed
));
86 /* length is the number of valuable bits of prefix structure
87 * 18 bytes is current length in structure, if address is ipv4
88 * 30 bytes is in case of ipv6
90 #define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8)
91 #define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8)
93 typedef struct esi_t_
{
94 uint8_t val
[ESI_BYTES
];
97 struct evpn_ead_addr
{
103 struct evpn_macip_addr
{
105 uint8_t ip_prefix_length
;
110 struct evpn_imet_addr
{
112 uint8_t ip_prefix_length
;
116 struct evpn_es_addr
{
118 uint8_t ip_prefix_length
;
122 struct evpn_prefix_addr
{
124 uint8_t ip_prefix_length
;
128 /* EVPN address (RFC 7432) */
132 struct evpn_ead_addr _ead_addr
;
133 struct evpn_macip_addr _macip_addr
;
134 struct evpn_imet_addr _imet_addr
;
135 struct evpn_es_addr _es_addr
;
136 struct evpn_prefix_addr _prefix_addr
;
138 #define ead_addr u._ead_addr
139 #define macip_addr u._macip_addr
140 #define imet_addr u._imet_addr
141 #define es_addr u._es_addr
142 #define prefix_addr u._prefix_addr
146 * A struct prefix contains an address family, a prefix length, and an
147 * address. This can represent either a 'network prefix' as defined
148 * by CIDR, where the 'host bits' of the prefix are 0
149 * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
150 * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
154 /* different OSes use different names */
155 #if defined(AF_PACKET)
156 #define AF_ETHERNET AF_PACKET
159 #define AF_ETHERNET AF_LINK
163 /* The 'family' in the prefix structure is internal to FRR and need not
164 * map to standard OS AF_ definitions except where needed for interacting
165 * with the kernel. However, AF_ definitions are currently in use and
166 * prevalent across the code. Define a new FRR-specific AF for EVPN to
167 * distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and
168 * ensure it does not conflict with any OS AF_ definition.
170 #if !defined(AF_EVPN)
171 #define AF_EVPN (AF_MAX + 1)
174 #if !defined(AF_FLOWSPEC)
175 #define AF_FLOWSPEC (AF_MAX + 2)
178 struct flowspec_prefix
{
179 uint16_t prefixlen
; /* length in bytes */
183 /* FRR generic prefix structure. */
189 struct in_addr prefix4
;
190 struct in6_addr prefix6
;
193 struct in_addr adv_router
;
195 struct ethaddr prefix_eth
; /* AF_ETHERNET */
199 struct evpn_addr prefix_evpn
; /* AF_EVPN */
200 struct flowspec_prefix prefix_flowspec
; /* AF_FLOWSPEC */
201 } u
__attribute__((aligned(8)));
204 /* IPv4 prefix structure. */
208 struct in_addr prefix
__attribute__((aligned(8)));
211 /* IPv6 prefix structure. */
215 struct in6_addr prefix
__attribute__((aligned(8)));
221 struct in_addr id
__attribute__((aligned(8)));
222 struct in_addr adv_router
;
225 /* Prefix for routing distinguisher. */
229 uint8_t val
[8] __attribute__((aligned(8)));
232 /* Prefix for ethernet. */
236 struct ethaddr eth_addr
__attribute__((aligned(8))); /* AF_ETHERNET */
239 /* EVPN prefix structure. */
243 struct evpn_addr prefix
__attribute__((aligned(8)));
246 static inline int is_evpn_prefix_ipaddr_none(const struct prefix_evpn
*evp
)
248 if (evp
->prefix
.route_type
== BGP_EVPN_AD_ROUTE
)
249 return IS_IPADDR_NONE(&(evp
)->prefix
.ead_addr
.ip
);
250 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
251 return IS_IPADDR_NONE(&(evp
)->prefix
.macip_addr
.ip
);
252 if (evp
->prefix
.route_type
== BGP_EVPN_IMET_ROUTE
)
253 return IS_IPADDR_NONE(&(evp
)->prefix
.imet_addr
.ip
);
254 if (evp
->prefix
.route_type
== BGP_EVPN_ES_ROUTE
)
255 return IS_IPADDR_NONE(&(evp
)->prefix
.es_addr
.ip
);
256 if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
257 return IS_IPADDR_NONE(&(evp
)->prefix
.prefix_addr
.ip
);
261 static inline int is_evpn_prefix_ipaddr_v4(const struct prefix_evpn
*evp
)
263 if (evp
->prefix
.route_type
== BGP_EVPN_AD_ROUTE
)
264 return IS_IPADDR_V4(&(evp
)->prefix
.ead_addr
.ip
);
265 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
266 return IS_IPADDR_V4(&(evp
)->prefix
.macip_addr
.ip
);
267 if (evp
->prefix
.route_type
== BGP_EVPN_IMET_ROUTE
)
268 return IS_IPADDR_V4(&(evp
)->prefix
.imet_addr
.ip
);
269 if (evp
->prefix
.route_type
== BGP_EVPN_ES_ROUTE
)
270 return IS_IPADDR_V4(&(evp
)->prefix
.es_addr
.ip
);
271 if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
272 return IS_IPADDR_V4(&(evp
)->prefix
.prefix_addr
.ip
);
276 static inline int is_evpn_prefix_ipaddr_v6(const struct prefix_evpn
*evp
)
278 if (evp
->prefix
.route_type
== BGP_EVPN_AD_ROUTE
)
279 return IS_IPADDR_V6(&(evp
)->prefix
.ead_addr
.ip
);
280 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
281 return IS_IPADDR_V6(&(evp
)->prefix
.macip_addr
.ip
);
282 if (evp
->prefix
.route_type
== BGP_EVPN_IMET_ROUTE
)
283 return IS_IPADDR_V6(&(evp
)->prefix
.imet_addr
.ip
);
284 if (evp
->prefix
.route_type
== BGP_EVPN_ES_ROUTE
)
285 return IS_IPADDR_V6(&(evp
)->prefix
.es_addr
.ip
);
286 if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
287 return IS_IPADDR_V6(&(evp
)->prefix
.prefix_addr
.ip
);
291 /* Prefix for a generic pointer */
295 uintptr_t prefix
__attribute__((aligned(8)));
298 /* Prefix for a Flowspec entry */
301 uint16_t prefixlen
; /* unused */
302 struct flowspec_prefix prefix
__attribute__((aligned(8)));
308 struct in_addr src
__attribute__((aligned(8)));
312 /* helper to get type safety/avoid casts on calls
313 * (w/o this, functions accepting all prefix types need casts on the caller
314 * side, which strips type safety since the cast will accept any pointer
318 #define prefixtype(uname, typename, fieldname) \
321 #define prefixtype(uname, typename, fieldname) \
322 typename *fieldname; \
323 uname(typename *x) { this->fieldname = x; }
327 prefixtype(prefixptr
, struct prefix
, p
)
328 prefixtype(prefixptr
, struct prefix_ipv4
, p4
)
329 prefixtype(prefixptr
, struct prefix_ipv6
, p6
)
330 prefixtype(prefixptr
, struct prefix_evpn
, evp
)
331 prefixtype(prefixptr
, struct prefix_fs
, fs
)
332 prefixtype(prefixptr
, struct prefix_rd
, rd
)
333 } __attribute__((transparent_union
));
335 union prefixconstptr
{
336 prefixtype(prefixconstptr
, const struct prefix
, p
)
337 prefixtype(prefixconstptr
, const struct prefix_ipv4
, p4
)
338 prefixtype(prefixconstptr
, const struct prefix_ipv6
, p6
)
339 prefixtype(prefixconstptr
, const struct prefix_evpn
, evp
)
340 prefixtype(prefixconstptr
, const struct prefix_fs
, fs
)
341 prefixtype(prefixconstptr
, const struct prefix_rd
, rd
)
342 } __attribute__((transparent_union
));
344 #ifndef INET_ADDRSTRLEN
345 #define INET_ADDRSTRLEN 16
346 #endif /* INET_ADDRSTRLEN */
348 #ifndef INET6_ADDRSTRLEN
349 /* dead:beef:dead:beef:dead:beef:dead:beef + \0 */
350 #define INET6_ADDRSTRLEN 46
351 #endif /* INET6_ADDRSTRLEN */
354 #define INET6_BUFSIZ 53
355 #endif /* INET6_BUFSIZ */
357 /* Maximum string length of the result of prefix2str */
358 #define PREFIX_STRLEN 80
361 * Longest possible length of a (S,G) string is 36 bytes
362 * 123.123.123.123 = 15 * 2
364 * NULL Character at end = 1
365 * (123.123.123.123,123.123.123.123)
367 #define PREFIX_SG_STR_LEN 34
369 /* Max bit/byte length of IPv4 address. */
370 #define IPV4_MAX_BYTELEN 4
371 #define IPV4_MAX_BITLEN 32
372 #define IPV4_MAX_PREFIXLEN 32
373 #define IPV4_ADDR_CMP(D,S) memcmp ((D), (S), IPV4_MAX_BYTELEN)
375 static inline bool ipv4_addr_same(const struct in_addr
*a
,
376 const struct in_addr
*b
)
378 return (a
->s_addr
== b
->s_addr
);
380 #define IPV4_ADDR_SAME(A,B) ipv4_addr_same((A), (B))
382 static inline void ipv4_addr_copy(struct in_addr
*dst
,
383 const struct in_addr
*src
)
385 dst
->s_addr
= src
->s_addr
;
387 #define IPV4_ADDR_COPY(D,S) ipv4_addr_copy((D), (S))
389 #define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000)
390 #define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000)
391 #define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000)
392 #define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000)
393 #define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000)
395 /* Max bit/byte length of IPv6 address. */
396 #define IPV6_MAX_BYTELEN 16
397 #define IPV6_MAX_BITLEN 128
398 #define IPV6_MAX_PREFIXLEN 128
399 #define IPV6_ADDR_CMP(D,S) memcmp ((D), (S), IPV6_MAX_BYTELEN)
400 #define IPV6_ADDR_SAME(D,S) (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
401 #define IPV6_ADDR_COPY(D,S) memcpy ((D), (S), IPV6_MAX_BYTELEN)
403 /* Count prefix size from mask length */
404 #define PSIZE(a) (((a) + 7) / (8))
406 #define BSIZE(a) ((a) * (8))
408 /* Prefix's family member. */
409 #define PREFIX_FAMILY(p) ((p)->family)
411 /* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */
414 /* Some SunOS define s6_addr32 only to kernel */
415 #define s6_addr32 _S6_un._S6_u32
417 #define s6_addr32 __u6_addr.__u6_addr32
422 extern int str2family(const char *);
423 extern int afi2family(afi_t
);
424 extern afi_t
family2afi(int);
425 extern const char *family2str(int family
);
426 extern const char *safi2str(safi_t safi
);
427 extern const char *afi2str(afi_t afi
);
430 * Check bit of the prefix.
436 * which bit to fetch from byte buffer, 0 indexed.
438 extern unsigned int prefix_bit(const uint8_t *prefix
, const uint16_t bit_index
);
440 extern struct prefix
*prefix_new(void);
441 extern void prefix_free(struct prefix
**p
);
443 * Function to handle prefix_free being used as a del function.
445 extern void prefix_free_lists(void *arg
);
446 extern const char *prefix_family_str(const struct prefix
*);
447 extern int prefix_blen(const struct prefix
*);
448 extern int str2prefix(const char *, struct prefix
*);
450 #define PREFIX2STR_BUFFER PREFIX_STRLEN
452 extern void prefix_mcast_inet4_dump(const char *onfail
, struct in_addr addr
,
453 char *buf
, int buf_size
);
454 extern const char *prefix_sg2str(const struct prefix_sg
*sg
, char *str
);
455 extern const char *prefix2str(union prefixconstptr
, char *, int);
456 extern int evpn_type5_prefix_match(const struct prefix
*evpn_pfx
,
457 const struct prefix
*match_pfx
);
458 extern int prefix_match(const struct prefix
*, const struct prefix
*);
459 extern int prefix_match_network_statement(const struct prefix
*,
460 const struct prefix
*);
461 extern int prefix_same(union prefixconstptr
, union prefixconstptr
);
462 extern int prefix_cmp(union prefixconstptr
, union prefixconstptr
);
463 extern int prefix_common_bits(const struct prefix
*, const struct prefix
*);
464 extern void prefix_copy(union prefixptr
, union prefixconstptr
);
465 extern void apply_mask(struct prefix
*);
467 #ifdef __clang_analyzer__
468 /* clang-SA doesn't understand transparent unions, making it think that the
469 * target of prefix_copy is uninitialized. So just memset the target.
470 * cf. https://bugs.llvm.org/show_bug.cgi?id=42811
472 #define prefix_copy(a, b) ({ memset(a, 0, sizeof(*a)); prefix_copy(a, b); })
475 extern struct prefix
*sockunion2hostprefix(const union sockunion
*,
477 extern void prefix2sockunion(const struct prefix
*, union sockunion
*);
479 extern int str2prefix_eth(const char *, struct prefix_eth
*);
481 extern struct prefix_ipv4
*prefix_ipv4_new(void);
482 extern void prefix_ipv4_free(struct prefix_ipv4
**p
);
483 extern int str2prefix_ipv4(const char *, struct prefix_ipv4
*);
484 extern void apply_mask_ipv4(struct prefix_ipv4
*);
486 #define PREFIX_COPY(DST, SRC) \
487 *((struct prefix *)(DST)) = *((const struct prefix *)(SRC))
488 #define PREFIX_COPY_IPV4(DST, SRC) \
489 *((struct prefix_ipv4 *)(DST)) = *((const struct prefix_ipv4 *)(SRC));
491 extern int prefix_ipv4_any(const struct prefix_ipv4
*);
492 extern void apply_classful_mask_ipv4(struct prefix_ipv4
*);
494 extern uint8_t ip_masklen(struct in_addr
);
495 extern void masklen2ip(const int, struct in_addr
*);
496 /* given the address of a host on a network and the network mask length,
497 * calculate the broadcast address for that network;
498 * special treatment for /31 according to RFC3021 section 3.3 */
499 extern in_addr_t
ipv4_broadcast_addr(in_addr_t hostaddr
, int masklen
);
501 extern int netmask_str2prefix_str(const char *, const char *, char *);
503 extern struct prefix_ipv6
*prefix_ipv6_new(void);
504 extern void prefix_ipv6_free(struct prefix_ipv6
**p
);
505 extern int str2prefix_ipv6(const char *, struct prefix_ipv6
*);
506 extern void apply_mask_ipv6(struct prefix_ipv6
*);
508 #define PREFIX_COPY_IPV6(DST, SRC) \
509 *((struct prefix_ipv6 *)(DST)) = *((const struct prefix_ipv6 *)(SRC));
511 extern int ip6_masklen(struct in6_addr
);
512 extern void masklen2ip6(const int, struct in6_addr
*);
514 extern const char *inet6_ntoa(struct in6_addr
);
516 extern int is_zero_mac(const struct ethaddr
*mac
);
517 extern bool is_mcast_mac(const struct ethaddr
*mac
);
518 extern bool is_bcast_mac(const struct ethaddr
*mac
);
519 extern int prefix_str2mac(const char *str
, struct ethaddr
*mac
);
520 extern char *prefix_mac2str(const struct ethaddr
*mac
, char *buf
, int size
);
522 extern unsigned prefix_hash_key(const void *pp
);
524 extern int str_to_esi(const char *str
, esi_t
*esi
);
525 extern char *esi_to_str(const esi_t
*esi
, char *buf
, int size
);
526 extern void prefix_evpn_hexdump(const struct prefix_evpn
*p
);
528 static inline int ipv6_martian(struct in6_addr
*addr
)
530 struct in6_addr localhost_addr
;
532 inet_pton(AF_INET6
, "::1", &localhost_addr
);
534 if (IPV6_ADDR_SAME(&localhost_addr
, addr
))
540 extern int macstr2prefix_evpn(const char *str
, struct prefix_evpn
*p
);
542 /* NOTE: This routine expects the address argument in network byte order. */
543 static inline int ipv4_martian(struct in_addr
*addr
)
545 in_addr_t ip
= ntohl(addr
->s_addr
);
547 if (IPV4_NET0(ip
) || IPV4_NET127(ip
) || IPV4_CLASS_DE(ip
)) {
553 static inline int is_default_prefix(const struct prefix
*p
)
558 if ((p
->family
== AF_INET
) && (p
->u
.prefix4
.s_addr
== INADDR_ANY
)
559 && (p
->prefixlen
== 0))
562 if ((p
->family
== AF_INET6
) && (p
->prefixlen
== 0)
563 && (!memcmp(&p
->u
.prefix6
, &in6addr_any
, sizeof(struct in6_addr
))))
569 static inline int is_host_route(const struct prefix
*p
)
571 if (p
->family
== AF_INET
)
572 return (p
->prefixlen
== IPV4_MAX_BITLEN
);
573 else if (p
->family
== AF_INET6
)
574 return (p
->prefixlen
== IPV6_MAX_BITLEN
);
578 static inline int is_default_host_route(const struct prefix
*p
)
580 if (p
->family
== AF_INET
) {
581 return (p
->u
.prefix4
.s_addr
== INADDR_ANY
&&
582 p
->prefixlen
== IPV4_MAX_BITLEN
);
583 } else if (p
->family
== AF_INET6
) {
584 return ((!memcmp(&p
->u
.prefix6
, &in6addr_any
,
585 sizeof(struct in6_addr
))) &&
586 p
->prefixlen
== IPV6_MAX_BITLEN
);
591 #ifdef _FRR_ATTRIBUTE_PRINTFRR
592 #pragma FRR printfrr_ext "%pEA" (struct ethaddr *)
594 #pragma FRR printfrr_ext "%pI4" (struct in_addr *)
595 #pragma FRR printfrr_ext "%pI4" (in_addr_t *)
597 #pragma FRR printfrr_ext "%pI6" (struct in6_addr *)
599 #pragma FRR printfrr_ext "%pFX" (struct prefix *)
600 #pragma FRR printfrr_ext "%pFX" (struct prefix_ipv4 *)
601 #pragma FRR printfrr_ext "%pFX" (struct prefix_ipv6 *)
602 #pragma FRR printfrr_ext "%pFX" (struct prefix_eth *)
603 #pragma FRR printfrr_ext "%pFX" (struct prefix_evpn *)
604 #pragma FRR printfrr_ext "%pFX" (struct prefix_fs *)
606 #pragma FRR printfrr_ext "%pSG4" (struct prefix_sg *)
613 #endif /* _ZEBRA_PREFIX_H */