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
18 * along with GNU Zebra; see the file COPYING. If not, write to the Free
19 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 #ifndef _ZEBRA_PREFIX_H
24 #define _ZEBRA_PREFIX_H
27 # include <sys/ethernet.h>
30 # include <net/ethernet.h>
32 # include <netinet/if_ether.h>
35 #include "sockunion.h"
37 #ifndef ETHER_ADDR_LEN
38 #define ETHER_ADDR_LEN ETHERADDRL
42 * there isn't a portable ethernet address type. We define our
43 * own to simplify internal handling
46 u_char octet[ETHER_ADDR_LEN];
51 * A struct prefix contains an address family, a prefix length, and an
52 * address. This can represent either a 'network prefix' as defined
53 * by CIDR, where the 'host bits' of the prefix are 0
54 * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
55 * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
59 /* different OSes use different names */
60 #if defined(AF_PACKET)
61 #define AF_ETHERNET AF_PACKET
64 #define AF_ETHERNET AF_LINK
68 /* IPv4 and IPv6 unified prefix structure. */
76 struct in_addr prefix4;
78 struct in6_addr prefix6;
79 #endif /* HAVE_IPV6 */
83 struct in_addr adv_router;
85 struct ethaddr prefix_eth; /* AF_ETHERNET */
88 } u __attribute__ ((aligned (8)));
91 /* IPv4 prefix structure. */
96 struct in_addr prefix __attribute__ ((aligned (8)));
99 /* IPv6 prefix structure. */
105 struct in6_addr prefix __attribute__ ((aligned (8)));
107 #endif /* HAVE_IPV6 */
113 struct in_addr id __attribute__ ((aligned (8)));
114 struct in_addr adv_router;
117 /* Prefix for routing distinguisher. */
122 u_char val[8] __attribute__ ((aligned (8)));
125 /* Prefix for ethernet. */
130 struct ethaddr eth_addr __attribute__ ((aligned (8))); /* AF_ETHERNET */
133 /* Prefix for a generic pointer */
138 uintptr_t prefix __attribute__ ((aligned (8)));
141 /* helper to get type safety/avoid casts on calls
142 * (w/o this, functions accepting all prefix types need casts on the caller
143 * side, which strips type safety since the cast will accept any pointer
149 struct prefix_ipv4 *p4;
150 struct prefix_ipv6 *p6;
151 } __attribute__ ((transparent_union));
153 union prefix46constptr
155 const struct prefix *p;
156 const struct prefix_ipv4 *p4;
157 const struct prefix_ipv6 *p6;
158 } __attribute__ ((transparent_union));
160 #ifndef INET_ADDRSTRLEN
161 #define INET_ADDRSTRLEN 16
162 #endif /* INET_ADDRSTRLEN */
164 #ifndef INET6_ADDRSTRLEN
165 #define INET6_ADDRSTRLEN 46
166 #endif /* INET6_ADDRSTRLEN */
169 #define INET6_BUFSIZ 51
170 #endif /* INET6_BUFSIZ */
172 /* Maximum prefix string length (IPv6) */
173 #define PREFIX_STRLEN 51
175 /* Max bit/byte length of IPv4 address. */
176 #define IPV4_MAX_BYTELEN 4
177 #define IPV4_MAX_BITLEN 32
178 #define IPV4_MAX_PREFIXLEN 32
179 #define IPV4_ADDR_CMP(D,S) memcmp ((D), (S), IPV4_MAX_BYTELEN)
180 #define IPV4_ADDR_SAME(D,S) (memcmp ((D), (S), IPV4_MAX_BYTELEN) == 0)
181 #define IPV4_ADDR_COPY(D,S) memcpy ((D), (S), IPV4_MAX_BYTELEN)
183 #define IPV4_NET0(a) ((((u_int32_t) (a)) & 0xff000000) == 0x00000000)
184 #define IPV4_NET127(a) ((((u_int32_t) (a)) & 0xff000000) == 0x7f000000)
185 #define IPV4_LINKLOCAL(a) ((((u_int32_t) (a)) & 0xffff0000) == 0xa9fe0000)
186 #define IPV4_CLASS_DE(a) ((((u_int32_t) (a)) & 0xe0000000) == 0xe0000000)
188 /* Max bit/byte length of IPv6 address. */
189 #define IPV6_MAX_BYTELEN 16
190 #define IPV6_MAX_BITLEN 128
191 #define IPV6_MAX_PREFIXLEN 128
192 #define IPV6_ADDR_CMP(D,S) memcmp ((D), (S), IPV6_MAX_BYTELEN)
193 #define IPV6_ADDR_SAME(D,S) (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
194 #define IPV6_ADDR_COPY(D,S) memcpy ((D), (S), IPV6_MAX_BYTELEN)
196 /* Count prefix size from mask length */
197 #define PSIZE(a) (((a) + 7) / (8))
199 /* Prefix's family member. */
200 #define PREFIX_FAMILY(p) ((p)->family)
202 /* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */
205 /* Some SunOS define s6_addr32 only to kernel */
206 #define s6_addr32 _S6_un._S6_u32
208 #define s6_addr32 __u6_addr.__u6_addr32
213 extern int str2family(const char *);
214 extern int afi2family (afi_t);
215 extern afi_t family2afi (int);
216 extern const char *safi2str(safi_t safi);
217 extern const char *afi2str(afi_t afi);
219 /* Check bit of the prefix. */
220 extern unsigned int prefix_bit (const u_char *prefix, const u_char prefixlen);
221 extern unsigned int prefix6_bit (const struct in6_addr *prefix, const u_char prefixlen);
223 extern struct prefix *prefix_new (void);
224 extern void prefix_free (struct prefix *);
225 extern const char *prefix_family_str (const struct prefix *);
226 extern int prefix_blen (const struct prefix *);
227 extern int str2prefix (const char *, struct prefix *);
228 extern const char *prefix2str (union prefix46constptr, char *, int);
229 extern int prefix_match (const struct prefix *, const struct prefix *);
230 extern int prefix_same (const struct prefix *, const struct prefix *);
231 extern int prefix_cmp (const struct prefix *, const struct prefix *);
232 extern int prefix_common_bits (const struct prefix *, const struct prefix *);
233 extern void prefix_copy (struct prefix *dest, const struct prefix *src);
234 extern void apply_mask (struct prefix *);
236 extern struct prefix *sockunion2prefix (const union sockunion *dest,
237 const union sockunion *mask);
238 extern struct prefix *sockunion2hostprefix (const union sockunion *, struct prefix *p);
239 extern void prefix2sockunion (const struct prefix *, union sockunion *);
241 extern int str2prefix_eth (const char *, struct prefix_eth *);
243 extern struct prefix_ipv4 *prefix_ipv4_new (void);
244 extern void prefix_ipv4_free (struct prefix_ipv4 *);
245 extern int str2prefix_ipv4 (const char *, struct prefix_ipv4 *);
246 extern void apply_mask_ipv4 (struct prefix_ipv4 *);
248 #define PREFIX_COPY_IPV4(DST, SRC) \
249 *((struct prefix_ipv4 *)(DST)) = *((const struct prefix_ipv4 *)(SRC));
251 extern int prefix_ipv4_any (const struct prefix_ipv4 *);
252 extern void apply_classful_mask_ipv4 (struct prefix_ipv4 *);
254 extern u_char ip_masklen (struct in_addr);
255 extern void masklen2ip (const int, struct in_addr *);
256 /* returns the network portion of the host address */
257 extern in_addr_t ipv4_network_addr (in_addr_t hostaddr, int masklen);
258 /* given the address of a host on a network and the network mask length,
259 * calculate the broadcast address for that network;
260 * special treatment for /31: returns the address of the other host
261 * on the network by flipping the host bit */
262 extern in_addr_t ipv4_broadcast_addr (in_addr_t hostaddr, int masklen);
264 extern int netmask_str2prefix_str (const char *, const char *, char *);
267 extern struct prefix_ipv6 *prefix_ipv6_new (void);
268 extern void prefix_ipv6_free (struct prefix_ipv6 *);
269 extern int str2prefix_ipv6 (const char *, struct prefix_ipv6 *);
270 extern void apply_mask_ipv6 (struct prefix_ipv6 *);
272 #define PREFIX_COPY_IPV6(DST, SRC) \
273 *((struct prefix_ipv6 *)(DST)) = *((const struct prefix_ipv6 *)(SRC));
275 extern int ip6_masklen (struct in6_addr);
276 extern void masklen2ip6 (const int, struct in6_addr *);
278 extern void str2in6_addr (const char *, struct in6_addr *);
279 extern const char *inet6_ntoa (struct in6_addr);
281 #endif /* HAVE_IPV6 */
283 extern int all_digit (const char *);
285 static inline int ipv4_martian (struct in_addr *addr)
287 in_addr_t ip = addr->s_addr;
289 if (IPV4_NET0(ip) || IPV4_NET127(ip) || IPV4_CLASS_DE(ip)) {
295 #endif /* _ZEBRA_PREFIX_H */