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"
42 #define ETHER_ADDR_STRLEN (3*ETH_ALEN)
44 * there isn't a portable ethernet address type. We define our
45 * own to simplify internal handling
48 uint8_t octet
[ETH_ALEN
];
49 } __attribute__((packed
));
52 /* length is the number of valuable bits of prefix structure
53 * 18 bytes is current length in structure, if address is ipv4
54 * 30 bytes is in case of ipv6
56 #define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8)
57 #define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8)
59 /* EVPN address (RFC 7432) */
62 uint8_t ip_prefix_length
;
70 struct in_addr v4_addr
;
71 struct in6_addr v6_addr
;
76 #define IS_EVPN_PREFIX_IPADDR_NONE(evp) IS_IPADDR_NONE(&(evp)->prefix.ip)
77 #define IS_EVPN_PREFIX_IPADDR_V4(evp) IS_IPADDR_V4(&(evp)->prefix.ip)
78 #define IS_EVPN_PREFIX_IPADDR_V6(evp) IS_IPADDR_V6(&(evp)->prefix.ip)
81 * A struct prefix contains an address family, a prefix length, and an
82 * address. This can represent either a 'network prefix' as defined
83 * by CIDR, where the 'host bits' of the prefix are 0
84 * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
85 * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
89 /* different OSes use different names */
90 #if defined(AF_PACKET)
91 #define AF_ETHERNET AF_PACKET
94 #define AF_ETHERNET AF_LINK
98 /* The 'family' in the prefix structure is internal to FRR and need not
99 * map to standard OS AF_ definitions except where needed for interacting
100 * with the kernel. However, AF_ definitions are currently in use and
101 * prevalent across the code. Define a new FRR-specific AF for EVPN to
102 * distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and
103 * ensure it does not conflict with any OS AF_ definition.
105 #if !defined(AF_EVPN)
106 #define AF_EVPN (AF_MAX + 1)
109 #if !defined(AF_FLOWSPEC)
110 #define AF_FLOWSPEC (AF_MAX + 2)
113 struct flowspec_prefix
{
114 uint16_t prefixlen
; /* length in bytes */
118 /* FRR generic prefix structure. */
124 struct in_addr prefix4
;
125 struct in6_addr prefix6
;
128 struct in_addr adv_router
;
130 struct ethaddr prefix_eth
; /* AF_ETHERNET */
133 struct evpn_addr prefix_evpn
; /* AF_EVPN */
134 struct flowspec_prefix prefix_flowspec
; /* AF_FLOWSPEC */
135 } u
__attribute__((aligned(8)));
138 /* IPv4 prefix structure. */
142 struct in_addr prefix
__attribute__((aligned(8)));
145 /* IPv6 prefix structure. */
149 struct in6_addr prefix
__attribute__((aligned(8)));
155 struct in_addr id
__attribute__((aligned(8)));
156 struct in_addr adv_router
;
159 /* Prefix for routing distinguisher. */
163 uint8_t val
[8] __attribute__((aligned(8)));
166 /* Prefix for ethernet. */
170 struct ethaddr eth_addr
__attribute__((aligned(8))); /* AF_ETHERNET */
173 /* EVPN prefix structure. */
177 struct evpn_addr prefix
__attribute__((aligned(8)));
180 /* Prefix for a generic pointer */
184 uintptr_t prefix
__attribute__((aligned(8)));
187 /* Prefix for a Flowspec entry */
190 uint8_t prefixlen
; /* unused */
191 struct flowspec_prefix prefix
__attribute__((aligned(8)));
197 struct in_addr src
__attribute__((aligned(8)));
201 /* helper to get type safety/avoid casts on calls
202 * (w/o this, functions accepting all prefix types need casts on the caller
203 * side, which strips type safety since the cast will accept any pointer
208 struct prefix_ipv4
*p4
;
209 struct prefix_ipv6
*p6
;
210 struct prefix_evpn
*evp
;
211 const struct prefix_fs
*fs
;
212 } __attribute__((transparent_union
));
214 union prefixconstptr
{
215 const struct prefix
*p
;
216 const struct prefix_ipv4
*p4
;
217 const struct prefix_ipv6
*p6
;
218 const struct prefix_evpn
*evp
;
219 const struct prefix_fs
*fs
;
220 } __attribute__((transparent_union
));
222 #ifndef INET_ADDRSTRLEN
223 #define INET_ADDRSTRLEN 16
224 #endif /* INET_ADDRSTRLEN */
226 #ifndef INET6_ADDRSTRLEN
227 #define INET6_ADDRSTRLEN 46
228 #endif /* INET6_ADDRSTRLEN */
231 #define INET6_BUFSIZ 51
232 #endif /* INET6_BUFSIZ */
234 /* Maximum prefix string length (IPv6) */
235 #define PREFIX_STRLEN 51
237 /* Max bit/byte length of IPv4 address. */
238 #define IPV4_MAX_BYTELEN 4
239 #define IPV4_MAX_BITLEN 32
240 #define IPV4_MAX_PREFIXLEN 32
241 #define IPV4_ADDR_CMP(D,S) memcmp ((D), (S), IPV4_MAX_BYTELEN)
243 static inline bool ipv4_addr_same(const struct in_addr
*a
,
244 const struct in_addr
*b
)
246 return (a
->s_addr
== b
->s_addr
);
248 #define IPV4_ADDR_SAME(A,B) ipv4_addr_same((A), (B))
250 static inline void ipv4_addr_copy(struct in_addr
*dst
,
251 const struct in_addr
*src
)
253 dst
->s_addr
= src
->s_addr
;
255 #define IPV4_ADDR_COPY(D,S) ipv4_addr_copy((D), (S))
257 #define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000)
258 #define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000)
259 #define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000)
260 #define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000)
261 #define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000)
263 /* Max bit/byte length of IPv6 address. */
264 #define IPV6_MAX_BYTELEN 16
265 #define IPV6_MAX_BITLEN 128
266 #define IPV6_MAX_PREFIXLEN 128
267 #define IPV6_ADDR_CMP(D,S) memcmp ((D), (S), IPV6_MAX_BYTELEN)
268 #define IPV6_ADDR_SAME(D,S) (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
269 #define IPV6_ADDR_COPY(D,S) memcpy ((D), (S), IPV6_MAX_BYTELEN)
271 /* Count prefix size from mask length */
272 #define PSIZE(a) (((a) + 7) / (8))
274 #define BSIZE(a) ((a) * (8))
276 /* Prefix's family member. */
277 #define PREFIX_FAMILY(p) ((p)->family)
279 /* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */
282 /* Some SunOS define s6_addr32 only to kernel */
283 #define s6_addr32 _S6_un._S6_u32
285 #define s6_addr32 __u6_addr.__u6_addr32
290 extern int str2family(const char *);
291 extern int afi2family(afi_t
);
292 extern afi_t
family2afi(int);
293 extern const char *safi2str(safi_t safi
);
294 extern const char *afi2str(afi_t afi
);
296 /* Check bit of the prefix. */
297 extern unsigned int prefix_bit(const uint8_t *prefix
, const uint8_t prefixlen
);
298 extern unsigned int prefix6_bit(const struct in6_addr
*prefix
,
299 const uint8_t prefixlen
);
301 extern struct prefix
*prefix_new(void);
302 extern void prefix_free(struct prefix
*);
303 extern const char *prefix_family_str(const struct prefix
*);
304 extern int prefix_blen(const struct prefix
*);
305 extern int str2prefix(const char *, struct prefix
*);
307 #define PREFIX2STR_BUFFER PREFIX_STRLEN
309 extern const char *prefix2str(union prefixconstptr
, char *, int);
310 extern int prefix_match(const struct prefix
*, const struct prefix
*);
311 extern int prefix_match_network_statement(const struct prefix
*,
312 const struct prefix
*);
313 extern int prefix_same(const struct prefix
*, const struct prefix
*);
314 extern int prefix_cmp(const struct prefix
*, const struct prefix
*);
315 extern int prefix_common_bits(const struct prefix
*, const struct prefix
*);
316 extern void prefix_copy(struct prefix
*dest
, const struct prefix
*src
);
317 extern void apply_mask(struct prefix
*);
319 extern struct prefix
*sockunion2prefix(const union sockunion
*dest
,
320 const union sockunion
*mask
);
321 extern struct prefix
*sockunion2hostprefix(const union sockunion
*,
323 extern void prefix2sockunion(const struct prefix
*, union sockunion
*);
325 extern int str2prefix_eth(const char *, struct prefix_eth
*);
327 extern struct prefix_ipv4
*prefix_ipv4_new(void);
328 extern void prefix_ipv4_free(struct prefix_ipv4
*);
329 extern int str2prefix_ipv4(const char *, struct prefix_ipv4
*);
330 extern void apply_mask_ipv4(struct prefix_ipv4
*);
332 #define PREFIX_COPY(DST, SRC) \
333 *((struct prefix *)(DST)) = *((const struct prefix *)(SRC))
334 #define PREFIX_COPY_IPV4(DST, SRC) \
335 *((struct prefix_ipv4 *)(DST)) = *((const struct prefix_ipv4 *)(SRC));
337 extern int prefix_ipv4_any(const struct prefix_ipv4
*);
338 extern void apply_classful_mask_ipv4(struct prefix_ipv4
*);
340 extern uint8_t ip_masklen(struct in_addr
);
341 extern void masklen2ip(const int, struct in_addr
*);
342 /* returns the network portion of the host address */
343 extern in_addr_t
ipv4_network_addr(in_addr_t hostaddr
, int masklen
);
344 /* given the address of a host on a network and the network mask length,
345 * calculate the broadcast address for that network;
346 * special treatment for /31: returns the address of the other host
347 * on the network by flipping the host bit */
348 extern in_addr_t
ipv4_broadcast_addr(in_addr_t hostaddr
, int masklen
);
350 extern int netmask_str2prefix_str(const char *, const char *, char *);
352 extern struct prefix_ipv6
*prefix_ipv6_new(void);
353 extern void prefix_ipv6_free(struct prefix_ipv6
*);
354 extern int str2prefix_ipv6(const char *, struct prefix_ipv6
*);
355 extern void apply_mask_ipv6(struct prefix_ipv6
*);
357 #define PREFIX_COPY_IPV6(DST, SRC) \
358 *((struct prefix_ipv6 *)(DST)) = *((const struct prefix_ipv6 *)(SRC));
360 extern int ip6_masklen(struct in6_addr
);
361 extern void masklen2ip6(const int, struct in6_addr
*);
363 extern const char *inet6_ntoa(struct in6_addr
);
365 extern int is_zero_mac(struct ethaddr
*mac
);
366 extern int prefix_str2mac(const char *str
, struct ethaddr
*mac
);
367 extern char *prefix_mac2str(const struct ethaddr
*mac
, char *buf
, int size
);
369 extern unsigned prefix_hash_key(void *pp
);
371 static inline int ipv6_martian(struct in6_addr
*addr
)
373 struct in6_addr localhost_addr
;
375 inet_pton(AF_INET6
, "::1", &localhost_addr
);
377 if (IPV6_ADDR_SAME(&localhost_addr
, addr
))
383 extern int all_digit(const char *);
384 extern int macstr2prefix_evpn(const char *str
, struct prefix_evpn
*p
);
386 /* NOTE: This routine expects the address argument in network byte order. */
387 static inline int ipv4_martian(struct in_addr
*addr
)
389 in_addr_t ip
= ntohl(addr
->s_addr
);
391 if (IPV4_NET0(ip
) || IPV4_NET127(ip
) || IPV4_CLASS_DE(ip
)) {
397 static inline int is_default_prefix(const struct prefix
*p
)
402 if ((p
->family
== AF_INET
) && (p
->u
.prefix4
.s_addr
== INADDR_ANY
)
403 && (p
->prefixlen
== 0))
406 if ((p
->family
== AF_INET6
) && (p
->prefixlen
== 0)
407 && (!memcmp(&p
->u
.prefix6
, &in6addr_any
, sizeof(struct in6_addr
))))
413 static inline int is_host_route(struct prefix
*p
)
415 if (p
->family
== AF_INET
)
416 return (p
->prefixlen
== IPV4_MAX_BITLEN
);
417 else if (p
->family
== AF_INET6
)
418 return (p
->prefixlen
== IPV6_MAX_BITLEN
);
422 #endif /* _ZEBRA_PREFIX_H */