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 <net/ethernet.h>
28 #include <netinet/if_ether.h>
30 #include "sockunion.h"
42 /* EVPN route types. */
44 BGP_EVPN_AD_ROUTE
= 1, /* Ethernet Auto-Discovery (A-D) route */
45 BGP_EVPN_MAC_IP_ROUTE
, /* MAC/IP Advertisement route */
46 BGP_EVPN_IMET_ROUTE
, /* Inclusive Multicast Ethernet Tag route */
47 BGP_EVPN_ES_ROUTE
, /* Ethernet Segment route */
48 BGP_EVPN_IP_PREFIX_ROUTE
, /* IP Prefix route */
49 } bgp_evpn_route_type
;
51 /* value of first byte of ESI */
52 #define ESI_TYPE_ARBITRARY 0 /* */
53 #define ESI_TYPE_LACP 1 /* <> */
54 #define ESI_TYPE_BRIDGE 2 /* <Root bridge Mac-6B>:<Root Br Priority-2B>:00 */
55 #define ESI_TYPE_MAC 3 /* <Syst Mac Add-6B>:<Local Discriminator Value-3B> */
56 #define ESI_TYPE_ROUTER 4 /* <RouterId-4B>:<Local Discriminator Value-4B> */
57 #define ESI_TYPE_AS 5 /* <AS-4B>:<Local Discriminator Value-4B> */
59 #define MAX_ESI {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
62 #define EVPN_ETH_TAG_BYTES 4
64 #define ESI_STR_LEN (3 * ESI_BYTES)
66 /* Maximum number of VTEPs per-ES -
67 * XXX - temporary limit for allocating strings etc.
69 #define ES_VTEP_MAX_CNT 10
70 #define ES_VTEP_LIST_STR_SZ (ES_VTEP_MAX_CNT * 16)
72 #define ETHER_ADDR_STRLEN (3*ETH_ALEN)
74 * there isn't a portable ethernet address type. We define our
75 * own to simplify internal handling
78 uint8_t octet
[ETH_ALEN
];
79 } __attribute__((packed
));
82 /* length is the number of valuable bits of prefix structure
83 * 18 bytes is current length in structure, if address is ipv4
84 * 30 bytes is in case of ipv6
86 #define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8)
87 #define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8)
89 typedef struct esi_t_
{
90 uint8_t val
[ESI_BYTES
];
93 struct evpn_ead_addr
{
99 struct evpn_macip_addr
{
101 uint8_t ip_prefix_length
;
106 struct evpn_imet_addr
{
108 uint8_t ip_prefix_length
;
112 struct evpn_es_addr
{
114 uint8_t ip_prefix_length
;
118 struct evpn_prefix_addr
{
120 uint8_t ip_prefix_length
;
124 /* EVPN address (RFC 7432) */
128 struct evpn_ead_addr _ead_addr
;
129 struct evpn_macip_addr _macip_addr
;
130 struct evpn_imet_addr _imet_addr
;
131 struct evpn_es_addr _es_addr
;
132 struct evpn_prefix_addr _prefix_addr
;
134 #define ead_addr u._ead_addr
135 #define macip_addr u._macip_addr
136 #define imet_addr u._imet_addr
137 #define es_addr u._es_addr
138 #define prefix_addr u._prefix_addr
142 * A struct prefix contains an address family, a prefix length, and an
143 * address. This can represent either a 'network prefix' as defined
144 * by CIDR, where the 'host bits' of the prefix are 0
145 * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
146 * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
150 /* different OSes use different names */
151 #if defined(AF_PACKET)
152 #define AF_ETHERNET AF_PACKET
155 #define AF_ETHERNET AF_LINK
159 /* The 'family' in the prefix structure is internal to FRR and need not
160 * map to standard OS AF_ definitions except where needed for interacting
161 * with the kernel. However, AF_ definitions are currently in use and
162 * prevalent across the code. Define a new FRR-specific AF for EVPN to
163 * distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and
164 * ensure it does not conflict with any OS AF_ definition.
166 #if !defined(AF_EVPN)
167 #define AF_EVPN (AF_MAX + 1)
170 #if !defined(AF_FLOWSPEC)
171 #define AF_FLOWSPEC (AF_MAX + 2)
174 struct flowspec_prefix
{
176 uint16_t prefixlen
; /* length in bytes */
180 /* FRR generic prefix structure. */
186 struct in_addr prefix4
;
187 struct in6_addr prefix6
;
190 struct in_addr adv_router
;
192 struct ethaddr prefix_eth
; /* AF_ETHERNET */
196 struct evpn_addr prefix_evpn
; /* AF_EVPN */
197 struct flowspec_prefix prefix_flowspec
; /* AF_FLOWSPEC */
198 } u
__attribute__((aligned(8)));
201 /* IPv4 prefix structure. */
205 struct in_addr prefix
__attribute__((aligned(8)));
208 /* IPv6 prefix structure. */
212 struct in6_addr prefix
__attribute__((aligned(8)));
218 struct in_addr id
__attribute__((aligned(8)));
219 struct in_addr adv_router
;
222 /* Prefix for routing distinguisher. */
226 uint8_t val
[8] __attribute__((aligned(8)));
229 /* Prefix for ethernet. */
233 struct ethaddr eth_addr
__attribute__((aligned(8))); /* AF_ETHERNET */
236 /* EVPN prefix structure. */
240 struct evpn_addr prefix
__attribute__((aligned(8)));
243 static inline int is_evpn_prefix_ipaddr_none(const struct prefix_evpn
*evp
)
245 if (evp
->prefix
.route_type
== BGP_EVPN_AD_ROUTE
)
246 return IS_IPADDR_NONE(&(evp
)->prefix
.ead_addr
.ip
);
247 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
248 return IS_IPADDR_NONE(&(evp
)->prefix
.macip_addr
.ip
);
249 if (evp
->prefix
.route_type
== BGP_EVPN_IMET_ROUTE
)
250 return IS_IPADDR_NONE(&(evp
)->prefix
.imet_addr
.ip
);
251 if (evp
->prefix
.route_type
== BGP_EVPN_ES_ROUTE
)
252 return IS_IPADDR_NONE(&(evp
)->prefix
.es_addr
.ip
);
253 if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
254 return IS_IPADDR_NONE(&(evp
)->prefix
.prefix_addr
.ip
);
258 static inline int is_evpn_prefix_ipaddr_v4(const struct prefix_evpn
*evp
)
260 if (evp
->prefix
.route_type
== BGP_EVPN_AD_ROUTE
)
261 return IS_IPADDR_V4(&(evp
)->prefix
.ead_addr
.ip
);
262 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
263 return IS_IPADDR_V4(&(evp
)->prefix
.macip_addr
.ip
);
264 if (evp
->prefix
.route_type
== BGP_EVPN_IMET_ROUTE
)
265 return IS_IPADDR_V4(&(evp
)->prefix
.imet_addr
.ip
);
266 if (evp
->prefix
.route_type
== BGP_EVPN_ES_ROUTE
)
267 return IS_IPADDR_V4(&(evp
)->prefix
.es_addr
.ip
);
268 if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
269 return IS_IPADDR_V4(&(evp
)->prefix
.prefix_addr
.ip
);
273 static inline int is_evpn_prefix_ipaddr_v6(const struct prefix_evpn
*evp
)
275 if (evp
->prefix
.route_type
== BGP_EVPN_AD_ROUTE
)
276 return IS_IPADDR_V6(&(evp
)->prefix
.ead_addr
.ip
);
277 if (evp
->prefix
.route_type
== BGP_EVPN_MAC_IP_ROUTE
)
278 return IS_IPADDR_V6(&(evp
)->prefix
.macip_addr
.ip
);
279 if (evp
->prefix
.route_type
== BGP_EVPN_IMET_ROUTE
)
280 return IS_IPADDR_V6(&(evp
)->prefix
.imet_addr
.ip
);
281 if (evp
->prefix
.route_type
== BGP_EVPN_ES_ROUTE
)
282 return IS_IPADDR_V6(&(evp
)->prefix
.es_addr
.ip
);
283 if (evp
->prefix
.route_type
== BGP_EVPN_IP_PREFIX_ROUTE
)
284 return IS_IPADDR_V6(&(evp
)->prefix
.prefix_addr
.ip
);
288 /* Prefix for a generic pointer */
292 uintptr_t prefix
__attribute__((aligned(8)));
295 /* Prefix for a Flowspec entry */
298 uint16_t prefixlen
; /* unused */
299 struct flowspec_prefix prefix
__attribute__((aligned(8)));
305 struct in_addr src
__attribute__((aligned(8)));
309 /* helper to get type safety/avoid casts on calls
310 * (w/o this, functions accepting all prefix types need casts on the caller
311 * side, which strips type safety since the cast will accept any pointer
315 #define prefixtype(uname, typename, fieldname) \
318 #define prefixtype(uname, typename, fieldname) \
319 typename *fieldname; \
320 uname(typename *x) { this->fieldname = x; }
324 prefixtype(prefixptr
, struct prefix
, p
)
325 prefixtype(prefixptr
, struct prefix_ipv4
, p4
)
326 prefixtype(prefixptr
, struct prefix_ipv6
, p6
)
327 prefixtype(prefixptr
, struct prefix_evpn
, evp
)
328 prefixtype(prefixptr
, struct prefix_fs
, fs
)
329 prefixtype(prefixptr
, struct prefix_rd
, rd
)
330 } __attribute__((transparent_union
));
332 union prefixconstptr
{
333 prefixtype(prefixconstptr
, const struct prefix
, p
)
334 prefixtype(prefixconstptr
, const struct prefix_ipv4
, p4
)
335 prefixtype(prefixconstptr
, const struct prefix_ipv6
, p6
)
336 prefixtype(prefixconstptr
, const struct prefix_evpn
, evp
)
337 prefixtype(prefixconstptr
, const struct prefix_fs
, fs
)
338 prefixtype(prefixconstptr
, const struct prefix_rd
, rd
)
339 } __attribute__((transparent_union
));
341 #ifndef INET_ADDRSTRLEN
342 #define INET_ADDRSTRLEN 16
343 #endif /* INET_ADDRSTRLEN */
345 #ifndef INET6_ADDRSTRLEN
346 /* dead:beef:dead:beef:dead:beef:dead:beef + \0 */
347 #define INET6_ADDRSTRLEN 46
348 #endif /* INET6_ADDRSTRLEN */
351 #define INET6_BUFSIZ 53
352 #endif /* INET6_BUFSIZ */
354 /* Maximum string length of the result of prefix2str */
355 #define PREFIX_STRLEN 80
358 * Longest possible length of a (S,G) string is 36 bytes
359 * 123.123.123.123 = 15 * 2
361 * NULL Character at end = 1
362 * (123.123.123.123,123.123.123.123)
364 #define PREFIX_SG_STR_LEN 34
366 /* Max bit/byte length of IPv4 address. */
367 #define IPV4_MAX_BYTELEN 4
368 #define IPV4_MAX_BITLEN 32
369 #define IPV4_MAX_PREFIXLEN 32
370 #define IPV4_ADDR_CMP(D,S) memcmp ((D), (S), IPV4_MAX_BYTELEN)
372 static inline bool ipv4_addr_same(const struct in_addr
*a
,
373 const struct in_addr
*b
)
375 return (a
->s_addr
== b
->s_addr
);
377 #define IPV4_ADDR_SAME(A,B) ipv4_addr_same((A), (B))
379 static inline void ipv4_addr_copy(struct in_addr
*dst
,
380 const struct in_addr
*src
)
382 dst
->s_addr
= src
->s_addr
;
384 #define IPV4_ADDR_COPY(D,S) ipv4_addr_copy((D), (S))
386 #define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000)
387 #define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000)
388 #define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000)
389 #define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000)
390 #define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000)
392 /* Max bit/byte length of IPv6 address. */
393 #define IPV6_MAX_BYTELEN 16
394 #define IPV6_MAX_BITLEN 128
395 #define IPV6_MAX_PREFIXLEN 128
396 #define IPV6_ADDR_CMP(D,S) memcmp ((D), (S), IPV6_MAX_BYTELEN)
397 #define IPV6_ADDR_SAME(D,S) (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
398 #define IPV6_ADDR_COPY(D,S) memcpy ((D), (S), IPV6_MAX_BYTELEN)
400 /* Count prefix size from mask length */
401 #define PSIZE(a) (((a) + 7) / (8))
403 #define BSIZE(a) ((a) * (8))
405 /* Prefix's family member. */
406 #define PREFIX_FAMILY(p) ((p)->family)
408 /* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */
410 #define s6_addr32 __u6_addr.__u6_addr32
414 extern int str2family(const char *);
415 extern int afi2family(afi_t
);
416 extern afi_t
family2afi(int);
417 extern const char *family2str(int family
);
418 extern const char *safi2str(safi_t safi
);
419 extern const char *afi2str(afi_t afi
);
422 * Check bit of the prefix.
428 * which bit to fetch from byte buffer, 0 indexed.
430 extern unsigned int prefix_bit(const uint8_t *prefix
, const uint16_t bit_index
);
432 extern struct prefix
*prefix_new(void);
433 extern void prefix_free(struct prefix
**p
);
435 * Function to handle prefix_free being used as a del function.
437 extern void prefix_free_lists(void *arg
);
438 extern const char *prefix_family_str(const struct prefix
*);
439 extern int prefix_blen(const struct prefix
*);
440 extern int str2prefix(const char *, struct prefix
*);
442 #define PREFIX2STR_BUFFER PREFIX_STRLEN
444 extern void prefix_mcast_inet4_dump(const char *onfail
, struct in_addr addr
,
445 char *buf
, int buf_size
);
446 extern const char *prefix_sg2str(const struct prefix_sg
*sg
, char *str
);
447 extern const char *prefix2str(union prefixconstptr
, char *, int);
448 extern int evpn_type5_prefix_match(const struct prefix
*evpn_pfx
,
449 const struct prefix
*match_pfx
);
450 extern int prefix_match(const struct prefix
*, const struct prefix
*);
451 extern int prefix_match_network_statement(const struct prefix
*,
452 const struct prefix
*);
453 extern int prefix_same(union prefixconstptr
, union prefixconstptr
);
454 extern int prefix_cmp(union prefixconstptr
, union prefixconstptr
);
455 extern int prefix_common_bits(const struct prefix
*, const struct prefix
*);
456 extern void prefix_copy(union prefixptr
, union prefixconstptr
);
457 extern void apply_mask(struct prefix
*);
459 #ifdef __clang_analyzer__
460 /* clang-SA doesn't understand transparent unions, making it think that the
461 * target of prefix_copy is uninitialized. So just memset the target.
462 * cf. https://bugs.llvm.org/show_bug.cgi?id=42811
464 #define prefix_copy(a, b) ({ memset(a, 0, sizeof(*a)); prefix_copy(a, b); })
467 extern struct prefix
*sockunion2hostprefix(const union sockunion
*,
469 extern void prefix2sockunion(const struct prefix
*, union sockunion
*);
471 extern int str2prefix_eth(const char *, struct prefix_eth
*);
473 extern struct prefix_ipv4
*prefix_ipv4_new(void);
474 extern void prefix_ipv4_free(struct prefix_ipv4
**p
);
475 extern int str2prefix_ipv4(const char *, struct prefix_ipv4
*);
476 extern void apply_mask_ipv4(struct prefix_ipv4
*);
478 #define PREFIX_COPY(DST, SRC) \
479 *((struct prefix *)(DST)) = *((const struct prefix *)(SRC))
480 #define PREFIX_COPY_IPV4(DST, SRC) \
481 *((struct prefix_ipv4 *)(DST)) = *((const struct prefix_ipv4 *)(SRC));
483 extern int prefix_ipv4_any(const struct prefix_ipv4
*);
484 extern void apply_classful_mask_ipv4(struct prefix_ipv4
*);
486 extern uint8_t ip_masklen(struct in_addr
);
487 extern void masklen2ip(const int, struct in_addr
*);
488 /* given the address of a host on a network and the network mask length,
489 * calculate the broadcast address for that network;
490 * special treatment for /31 according to RFC3021 section 3.3 */
491 extern in_addr_t
ipv4_broadcast_addr(in_addr_t hostaddr
, int masklen
);
493 extern int netmask_str2prefix_str(const char *, const char *, char *);
495 extern struct prefix_ipv6
*prefix_ipv6_new(void);
496 extern void prefix_ipv6_free(struct prefix_ipv6
**p
);
497 extern int str2prefix_ipv6(const char *, struct prefix_ipv6
*);
498 extern void apply_mask_ipv6(struct prefix_ipv6
*);
500 #define PREFIX_COPY_IPV6(DST, SRC) \
501 *((struct prefix_ipv6 *)(DST)) = *((const struct prefix_ipv6 *)(SRC));
503 extern int ip6_masklen(struct in6_addr
);
504 extern void masklen2ip6(const int, struct in6_addr
*);
506 extern const char *inet6_ntoa(struct in6_addr
);
508 extern int is_zero_mac(const struct ethaddr
*mac
);
509 extern bool is_mcast_mac(const struct ethaddr
*mac
);
510 extern bool is_bcast_mac(const struct ethaddr
*mac
);
511 extern int prefix_str2mac(const char *str
, struct ethaddr
*mac
);
512 extern char *prefix_mac2str(const struct ethaddr
*mac
, char *buf
, int size
);
514 extern unsigned prefix_hash_key(const void *pp
);
516 extern int str_to_esi(const char *str
, esi_t
*esi
);
517 extern char *esi_to_str(const esi_t
*esi
, char *buf
, int size
);
518 extern void prefix_evpn_hexdump(const struct prefix_evpn
*p
);
520 static inline int ipv6_martian(struct in6_addr
*addr
)
522 struct in6_addr localhost_addr
;
524 inet_pton(AF_INET6
, "::1", &localhost_addr
);
526 if (IPV6_ADDR_SAME(&localhost_addr
, addr
))
532 extern int macstr2prefix_evpn(const char *str
, struct prefix_evpn
*p
);
534 /* NOTE: This routine expects the address argument in network byte order. */
535 static inline int ipv4_martian(struct in_addr
*addr
)
537 in_addr_t ip
= ntohl(addr
->s_addr
);
539 if (IPV4_NET0(ip
) || IPV4_NET127(ip
) || IPV4_CLASS_DE(ip
)) {
545 static inline int is_default_prefix(const struct prefix
*p
)
550 if ((p
->family
== AF_INET
) && (p
->u
.prefix4
.s_addr
== INADDR_ANY
)
551 && (p
->prefixlen
== 0))
554 if ((p
->family
== AF_INET6
) && (p
->prefixlen
== 0)
555 && (!memcmp(&p
->u
.prefix6
, &in6addr_any
, sizeof(struct in6_addr
))))
561 static inline int is_host_route(const struct prefix
*p
)
563 if (p
->family
== AF_INET
)
564 return (p
->prefixlen
== IPV4_MAX_BITLEN
);
565 else if (p
->family
== AF_INET6
)
566 return (p
->prefixlen
== IPV6_MAX_BITLEN
);
570 static inline int is_default_host_route(const struct prefix
*p
)
572 if (p
->family
== AF_INET
) {
573 return (p
->u
.prefix4
.s_addr
== INADDR_ANY
&&
574 p
->prefixlen
== IPV4_MAX_BITLEN
);
575 } else if (p
->family
== AF_INET6
) {
576 return ((!memcmp(&p
->u
.prefix6
, &in6addr_any
,
577 sizeof(struct in6_addr
))) &&
578 p
->prefixlen
== IPV6_MAX_BITLEN
);
583 #ifdef _FRR_ATTRIBUTE_PRINTFRR
584 #pragma FRR printfrr_ext "%pEA" (struct ethaddr *)
586 #pragma FRR printfrr_ext "%pI4" (struct in_addr *)
587 #pragma FRR printfrr_ext "%pI4" (in_addr_t *)
589 #pragma FRR printfrr_ext "%pI6" (struct in6_addr *)
591 #pragma FRR printfrr_ext "%pFX" (struct prefix *)
592 #pragma FRR printfrr_ext "%pFX" (struct prefix_ipv4 *)
593 #pragma FRR printfrr_ext "%pFX" (struct prefix_ipv6 *)
594 #pragma FRR printfrr_ext "%pFX" (struct prefix_eth *)
595 #pragma FRR printfrr_ext "%pFX" (struct prefix_evpn *)
596 #pragma FRR printfrr_ext "%pFX" (struct prefix_fs *)
598 #pragma FRR printfrr_ext "%pSG4" (struct prefix_sg *)
605 #endif /* _ZEBRA_PREFIX_H */