[mirror_frr.git] / lib / prefix.h

/*
 * Prefix structure.
 * Copyright (C) 1998 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_PREFIX_H
#define _ZEBRA_PREFIX_H

#ifdef SUNOS_5
#include <sys/ethernet.h>
#else
#ifdef GNU_LINUX
#include <net/ethernet.h>
#else
#include <netinet/if_ether.h>
#endif
#endif
#include "sockunion.h"
#include "ipaddr.h"
#include "compiler.h"

#ifndef ETH_ALEN
#define ETH_ALEN 6
#endif

#define ESI_BYTES 10
#define ESI_STR_LEN (3 * ESI_BYTES)

#define ETHER_ADDR_STRLEN (3*ETH_ALEN)
/*
 * there isn't a portable ethernet address type. We define our
 * own to simplify internal handling
 */
struct ethaddr {
	uint8_t octet[ETH_ALEN];
} __attribute__((packed));


/* length is the number of valuable bits of prefix structure
* 18 bytes is current length in structure, if address is ipv4
* 30 bytes is in case of ipv6
*/
#define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8)
#define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8)

typedef struct esi_t_ {
	uint8_t val[10];
} esi_t;

struct evpn_ead_addr {
	esi_t esi;
	uint32_t eth_tag;
};

struct evpn_macip_addr {
	uint32_t eth_tag;
	uint8_t ip_prefix_length;
	struct ethaddr mac;
	struct ipaddr ip;
};

struct evpn_imet_addr {
	uint32_t eth_tag;
	uint8_t ip_prefix_length;
	struct ipaddr ip;
};

struct evpn_es_addr {
	esi_t esi;
	uint8_t ip_prefix_length;
	struct ipaddr ip;
};

struct evpn_prefix_addr {
	uint32_t eth_tag;
	uint8_t ip_prefix_length;
	struct ipaddr ip;
};

/* EVPN address (RFC 7432) */
struct evpn_addr {
	uint8_t route_type;
	union {
		struct evpn_ead_addr _ead_addr;
		struct evpn_macip_addr _macip_addr;
		struct evpn_imet_addr _imet_addr;
		struct evpn_es_addr _es_addr;
		struct evpn_prefix_addr _prefix_addr;
	} u;
#define ead_addr u._ead_addr
#define macip_addr u._macip_addr
#define imet_addr u._imet_addr
#define es_addr u._es_addr
#define prefix_addr u._prefix_addr
};

/*
 * A struct prefix contains an address family, a prefix length, and an
 * address.  This can represent either a 'network prefix' as defined
 * by CIDR, where the 'host bits' of the prefix are 0
 * (e.g. AF_INET:10.0.0.0/8), or an address and netmask
 * (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
 * interface.
 */

/* different OSes use different names */
#if defined(AF_PACKET)
#define AF_ETHERNET AF_PACKET
#else
#if defined(AF_LINK)
#define AF_ETHERNET AF_LINK
#endif
#endif

/* The 'family' in the prefix structure is internal to FRR and need not
 * map to standard OS AF_ definitions except where needed for interacting
 * with the kernel. However, AF_ definitions are currently in use and
 * prevalent across the code. Define a new FRR-specific AF for EVPN to
 * distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and
 * ensure it does not conflict with any OS AF_ definition.
 */
#if !defined(AF_EVPN)
#define AF_EVPN (AF_MAX + 1)
#endif

#if !defined(AF_FLOWSPEC)
#define AF_FLOWSPEC (AF_MAX + 2)
#endif

struct flowspec_prefix {
	uint16_t prefixlen; /* length in bytes */
	uintptr_t ptr;
};

/* FRR generic prefix structure. */
struct prefix {
	uint8_t family;
	uint8_t prefixlen;
	union {
		uint8_t prefix;
		struct in_addr prefix4;
		struct in6_addr prefix6;
		struct {
			struct in_addr id;
			struct in_addr adv_router;
		} lp;
		struct ethaddr prefix_eth; /* AF_ETHERNET */
		uint8_t val[16];
		uintptr_t ptr;
		struct evpn_addr prefix_evpn; /* AF_EVPN */
		struct flowspec_prefix prefix_flowspec; /* AF_FLOWSPEC */
	} u __attribute__((aligned(8)));
};

/* IPv4 prefix structure. */
struct prefix_ipv4 {
	uint8_t family;
	uint8_t prefixlen;
	struct in_addr prefix __attribute__((aligned(8)));
};

/* IPv6 prefix structure. */
struct prefix_ipv6 {
	uint8_t family;
	uint8_t prefixlen;
	struct in6_addr prefix __attribute__((aligned(8)));
};

struct prefix_ls {
	uint8_t family;
	uint8_t prefixlen;
	struct in_addr id __attribute__((aligned(8)));
	struct in_addr adv_router;
};

/* Prefix for routing distinguisher. */
struct prefix_rd {
	uint8_t family;
	uint8_t prefixlen;
	uint8_t val[8] __attribute__((aligned(8)));
};

/* Prefix for ethernet. */
struct prefix_eth {
	uint8_t family;
	uint8_t prefixlen;
	struct ethaddr eth_addr __attribute__((aligned(8))); /* AF_ETHERNET */
};

/* EVPN prefix structure. */
struct prefix_evpn {
	uint8_t family;
	uint8_t prefixlen;
	struct evpn_addr prefix __attribute__((aligned(8)));
};

static inline int is_evpn_prefix_ipaddr_none(const struct prefix_evpn *evp)
{
	if (evp->prefix.route_type == 2)
		return IS_IPADDR_NONE(&(evp)->prefix.macip_addr.ip);
	if (evp->prefix.route_type == 3)
		return IS_IPADDR_NONE(&(evp)->prefix.imet_addr.ip);
	if (evp->prefix.route_type == 4)
		return IS_IPADDR_NONE(&(evp)->prefix.es_addr.ip);
	if (evp->prefix.route_type == 5)
		return IS_IPADDR_NONE(&(evp)->prefix.prefix_addr.ip);
	return 0;
}

static inline int is_evpn_prefix_ipaddr_v4(const struct prefix_evpn *evp)
{
	if (evp->prefix.route_type == 2)
		return IS_IPADDR_V4(&(evp)->prefix.macip_addr.ip);
	if (evp->prefix.route_type == 3)
		return IS_IPADDR_V4(&(evp)->prefix.imet_addr.ip);
	if (evp->prefix.route_type == 4)
		return IS_IPADDR_V4(&(evp)->prefix.es_addr.ip);
	if (evp->prefix.route_type == 5)
		return IS_IPADDR_V4(&(evp)->prefix.prefix_addr.ip);
	return 0;
}

static inline int is_evpn_prefix_ipaddr_v6(const struct prefix_evpn *evp)
{
	if (evp->prefix.route_type == 2)
		return IS_IPADDR_V6(&(evp)->prefix.macip_addr.ip);
	if (evp->prefix.route_type == 3)
		return IS_IPADDR_V6(&(evp)->prefix.imet_addr.ip);
	if (evp->prefix.route_type == 4)
		return IS_IPADDR_V6(&(evp)->prefix.es_addr.ip);
	if (evp->prefix.route_type == 5)
		return IS_IPADDR_V6(&(evp)->prefix.prefix_addr.ip);
	return 0;
}

/* Prefix for a generic pointer */
struct prefix_ptr {
	uint8_t family;
	uint8_t prefixlen;
	uintptr_t prefix __attribute__((aligned(8)));
};

/* Prefix for a Flowspec entry */
struct prefix_fs {
	uint8_t family;
	uint8_t prefixlen; /* unused */
	struct flowspec_prefix  prefix __attribute__((aligned(8)));
};

struct prefix_sg {
	uint8_t family;
	uint8_t prefixlen;
	struct in_addr src __attribute__((aligned(8)));
	struct in_addr grp;
};

/* helper to get type safety/avoid casts on calls
 * (w/o this, functions accepting all prefix types need casts on the caller
 * side, which strips type safety since the cast will accept any pointer
 * type.)
 */
union prefixptr {
	struct prefix *p;
	struct prefix_ipv4 *p4;
	struct prefix_ipv6 *p6;
	struct prefix_evpn *evp;
	const struct prefix_fs *fs;
} __attribute__((transparent_union));

union prefixconstptr {
	const struct prefix *p;
	const struct prefix_ipv4 *p4;
	const struct prefix_ipv6 *p6;
	const struct prefix_evpn *evp;
	const struct prefix_fs *fs;
} __attribute__((transparent_union));

#ifndef INET_ADDRSTRLEN
#define INET_ADDRSTRLEN 16
#endif /* INET_ADDRSTRLEN */

#ifndef INET6_ADDRSTRLEN
#define INET6_ADDRSTRLEN 46
#endif /* INET6_ADDRSTRLEN */

#ifndef INET6_BUFSIZ
#define INET6_BUFSIZ 51
#endif /* INET6_BUFSIZ */

/* Maximum prefix string length (IPv6) */
#define PREFIX_STRLEN 51

/* Max bit/byte length of IPv4 address. */
#define IPV4_MAX_BYTELEN    4
#define IPV4_MAX_BITLEN    32
#define IPV4_MAX_PREFIXLEN 32
#define IPV4_ADDR_CMP(D,S)   memcmp ((D), (S), IPV4_MAX_BYTELEN)

static inline bool ipv4_addr_same(const struct in_addr *a,
				  const struct in_addr *b)
{
	return (a->s_addr == b->s_addr);
}
#define IPV4_ADDR_SAME(A,B)  ipv4_addr_same((A), (B))

static inline void ipv4_addr_copy(struct in_addr *dst,
				  const struct in_addr *src)
{
	dst->s_addr = src->s_addr;
}
#define IPV4_ADDR_COPY(D,S)  ipv4_addr_copy((D), (S))

#define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000)
#define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000)
#define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000)
#define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000)
#define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000)

/* Max bit/byte length of IPv6 address. */
#define IPV6_MAX_BYTELEN    16
#define IPV6_MAX_BITLEN    128
#define IPV6_MAX_PREFIXLEN 128
#define IPV6_ADDR_CMP(D,S)   memcmp ((D), (S), IPV6_MAX_BYTELEN)
#define IPV6_ADDR_SAME(D,S)  (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
#define IPV6_ADDR_COPY(D,S)  memcpy ((D), (S), IPV6_MAX_BYTELEN)

/* Count prefix size from mask length */
#define PSIZE(a) (((a) + 7) / (8))

#define BSIZE(a) ((a) * (8))

/* Prefix's family member. */
#define PREFIX_FAMILY(p)  ((p)->family)

/* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC || GNU} */
#ifndef s6_addr32
#if defined(SUNOS_5)
/* Some SunOS define s6_addr32 only to kernel */
#define s6_addr32 _S6_un._S6_u32
#else
#define s6_addr32 __u6_addr.__u6_addr32
#endif /* SUNOS_5 */
#endif /*s6_addr32*/

/* Prototypes. */
extern int str2family(const char *);
extern int afi2family(afi_t);
extern afi_t family2afi(int);
extern const char *family2str(int family);
extern const char *safi2str(safi_t safi);
extern const char *afi2str(afi_t afi);

/* Check bit of the prefix. */
extern unsigned int prefix_bit(const uint8_t *prefix, const uint8_t prefixlen);
extern unsigned int prefix6_bit(const struct in6_addr *prefix,
				const uint8_t prefixlen);

extern struct prefix *prefix_new(void);
extern void prefix_free(struct prefix *);
extern const char *prefix_family_str(const struct prefix *);
extern int prefix_blen(const struct prefix *);
extern int str2prefix(const char *, struct prefix *);

#define PREFIX2STR_BUFFER  PREFIX_STRLEN

extern const char *prefix2str(union prefixconstptr, char *, int);
extern int prefix_match(const struct prefix *, const struct prefix *);
extern int prefix_match_network_statement(const struct prefix *,
					  const struct prefix *);
extern int prefix_same(const struct prefix *, const struct prefix *);
extern int prefix_cmp(const struct prefix *, const struct prefix *);
extern int prefix_common_bits(const struct prefix *, const struct prefix *);
extern void prefix_copy(struct prefix *dest, const struct prefix *src);
extern void apply_mask(struct prefix *);

extern struct prefix *sockunion2prefix(const union sockunion *dest,
				       const union sockunion *mask);
extern struct prefix *sockunion2hostprefix(const union sockunion *,
					   struct prefix *p);
extern void prefix2sockunion(const struct prefix *, union sockunion *);

extern int str2prefix_eth(const char *, struct prefix_eth *);

extern struct prefix_ipv4 *prefix_ipv4_new(void);
extern void prefix_ipv4_free(struct prefix_ipv4 *);
extern int str2prefix_ipv4(const char *, struct prefix_ipv4 *);
extern void apply_mask_ipv4(struct prefix_ipv4 *);

#define PREFIX_COPY(DST, SRC)                                                  \
	*((struct prefix *)(DST)) = *((const struct prefix *)(SRC))
#define PREFIX_COPY_IPV4(DST, SRC)                                             \
	*((struct prefix_ipv4 *)(DST)) = *((const struct prefix_ipv4 *)(SRC));

extern int prefix_ipv4_any(const struct prefix_ipv4 *);
extern void apply_classful_mask_ipv4(struct prefix_ipv4 *);

extern uint8_t ip_masklen(struct in_addr);
extern void masklen2ip(const int, struct in_addr *);
/* returns the network portion of the host address */
extern in_addr_t ipv4_network_addr(in_addr_t hostaddr, int masklen);
/* given the address of a host on a network and the network mask length,
 * calculate the broadcast address for that network;
 * special treatment for /31: returns the address of the other host
 * on the network by flipping the host bit */
extern in_addr_t ipv4_broadcast_addr(in_addr_t hostaddr, int masklen);

extern int netmask_str2prefix_str(const char *, const char *, char *);

extern struct prefix_ipv6 *prefix_ipv6_new(void);
extern void prefix_ipv6_free(struct prefix_ipv6 *);
extern int str2prefix_ipv6(const char *, struct prefix_ipv6 *);
extern void apply_mask_ipv6(struct prefix_ipv6 *);

#define PREFIX_COPY_IPV6(DST, SRC)                                             \
	*((struct prefix_ipv6 *)(DST)) = *((const struct prefix_ipv6 *)(SRC));

extern int ip6_masklen(struct in6_addr);
extern void masklen2ip6(const int, struct in6_addr *);

extern const char *inet6_ntoa(struct in6_addr);

extern int is_zero_mac(struct ethaddr *mac);
extern int prefix_str2mac(const char *str, struct ethaddr *mac);
extern char *prefix_mac2str(const struct ethaddr *mac, char *buf, int size);

extern unsigned prefix_hash_key(void *pp);

extern int str_to_esi(const char *str, esi_t *esi);
extern char *esi_to_str(const esi_t *esi, char *buf, int size);
extern void prefix_hexdump(const struct prefix *p);
extern void prefix_evpn_hexdump(const struct prefix_evpn *p);

static inline int ipv6_martian(struct in6_addr *addr)
{
	struct in6_addr localhost_addr;

	inet_pton(AF_INET6, "::1", &localhost_addr);

	if (IPV6_ADDR_SAME(&localhost_addr, addr))
		return 1;

	return 0;
}

extern int macstr2prefix_evpn(const char *str, struct prefix_evpn *p);

/* NOTE: This routine expects the address argument in network byte order. */
static inline int ipv4_martian(struct in_addr *addr)
{
	in_addr_t ip = ntohl(addr->s_addr);

	if (IPV4_NET0(ip) || IPV4_NET127(ip) || IPV4_CLASS_DE(ip)) {
		return 1;
	}
	return 0;
}

static inline int is_default_prefix(const struct prefix *p)
{
	if (!p)
		return 0;

	if ((p->family == AF_INET) && (p->u.prefix4.s_addr == INADDR_ANY)
	    && (p->prefixlen == 0))
		return 1;

	if ((p->family == AF_INET6) && (p->prefixlen == 0)
	    && (!memcmp(&p->u.prefix6, &in6addr_any, sizeof(struct in6_addr))))
		return 1;

	return 0;
}

static inline int is_host_route(struct prefix *p)
{
	if (p->family == AF_INET)
		return (p->prefixlen == IPV4_MAX_BITLEN);
	else if (p->family == AF_INET6)
		return (p->prefixlen == IPV6_MAX_BITLEN);
	return 0;
}
#endif /* _ZEBRA_PREFIX_H */
Commit	Line	Data
718e3744	1	/*
	2	* Prefix structure.
	3	* Copyright (C) 1998 Kunihiro Ishiguro
	4	*
	5	* This file is part of GNU Zebra.
	6	*
	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
	10	* later version.
	11	*
	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.
	16	*
896014f4 DL	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
718e3744	20	*/
	21
	22	#ifndef _ZEBRA_PREFIX_H
	23	#define _ZEBRA_PREFIX_H
	24
32ac65d9	25	#ifdef SUNOS_5
d62a17ae	26	#include <sys/ethernet.h>
32ac65d9	27	#else
d62a17ae	28	#ifdef GNU_LINUX
	29	#include <net/ethernet.h>
	30	#else
	31	#include <netinet/if_ether.h>
	32	#endif
32ac65d9	33	#endif
8cc4198f	34	#include "sockunion.h"
86f1ef44	35	#include "ipaddr.h"
de1a880c	36	#include "compiler.h"
8cc4198f	37
7628d862 DS	38	#ifndef ETH_ALEN
	39	#define ETH_ALEN 6
	40	#endif
	41
50f74cf1	42	#define ESI_BYTES 10
2bb9eff4	43	#define ESI_STR_LEN (3 * ESI_BYTES)
50f74cf1	44
7628d862	45	#define ETHER_ADDR_STRLEN (3*ETH_ALEN)
32ac65d9 LB	46	/*
	47	* there isn't a portable ethernet address type. We define our
	48	* own to simplify internal handling
	49	*/
	50	struct ethaddr {
d7c0a89a	51	uint8_t octet[ETH_ALEN];
d62a17ae	52	} __attribute__((packed));
32ac65d9 LB	53
32ac65d9 LB	54
d62a17ae	55	/* length is the number of valuable bits of prefix structure
9d303b37 DL	56	* 18 bytes is current length in structure, if address is ipv4
	57	* 30 bytes is in case of ipv6
	58	*/
a440846e	59	#define PREFIX_LEN_ROUTE_TYPE_5_IPV4 (18*8)
	60	#define PREFIX_LEN_ROUTE_TYPE_5_IPV6 (30*8)
	61
3714a385	62	typedef struct esi_t_ {
	63	uint8_t val[10];
	64	} esi_t;
	65
	66	struct evpn_ead_addr {
	67	esi_t esi;
	68	uint32_t eth_tag;
	69	};
	70
	71	struct evpn_macip_addr {
	72	uint32_t eth_tag;
d7c0a89a	73	uint8_t ip_prefix_length;
d62a17ae	74	struct ethaddr mac;
3714a385	75	struct ipaddr ip;
	76	};
	77
	78	struct evpn_imet_addr {
d62a17ae	79	uint32_t eth_tag;
3714a385	80	uint8_t ip_prefix_length;
	81	struct ipaddr ip;
	82	};
	83
	84	struct evpn_es_addr {
	85	esi_t esi;
	86	uint8_t ip_prefix_length;
d62a17ae	87	struct ipaddr ip;
a440846e	88	};
a440846e	89
3714a385	90	struct evpn_prefix_addr {
	91	uint32_t eth_tag;
	92	uint8_t ip_prefix_length;
	93	struct ipaddr ip;
	94	};
	95
	96	/* EVPN address (RFC 7432) */
	97	struct evpn_addr {
	98	uint8_t route_type;
	99	union {
	100	struct evpn_ead_addr _ead_addr;
	101	struct evpn_macip_addr _macip_addr;
	102	struct evpn_imet_addr _imet_addr;
	103	struct evpn_es_addr _es_addr;
	104	struct evpn_prefix_addr _prefix_addr;
	105	} u;
	106	#define ead_addr u._ead_addr
	107	#define macip_addr u._macip_addr
	108	#define imet_addr u._imet_addr
	109	#define es_addr u._es_addr
	110	#define prefix_addr u._prefix_addr
	111	};
a440846e	112
9d24baaa	113	/*
	114	* A struct prefix contains an address family, a prefix length, and an
	115	* address. This can represent either a 'network prefix' as defined
	116	* by CIDR, where the 'host bits' of the prefix are 0
	117	* (e.g. AF_INET:10.0.0.0/8), or an address and netmask
	118	* (e.g. AF_INET:10.0.0.9/8), such as might be configured on an
	119	* interface.
	120	*/
	121
32ac65d9 LB	122	/* different OSes use different names */
	123	#if defined(AF_PACKET)
	124	#define AF_ETHERNET AF_PACKET
	125	#else
	126	#if defined(AF_LINK)
	127	#define AF_ETHERNET AF_LINK
	128	#endif
	129	#endif
	130
b03b8898 DS	131	/* The 'family' in the prefix structure is internal to FRR and need not
	132	* map to standard OS AF_ definitions except where needed for interacting
	133	* with the kernel. However, AF_ definitions are currently in use and
	134	* prevalent across the code. Define a new FRR-specific AF for EVPN to
	135	* distinguish between 'ethernet' (MAC-only) and 'evpn' prefixes and
	136	* ensure it does not conflict with any OS AF_ definition.
	137	*/
	138	#if !defined(AF_EVPN)
	139	#define AF_EVPN (AF_MAX + 1)
	140	#endif
	141
9a14899b PG	142	#if !defined(AF_FLOWSPEC)
	143	#define AF_FLOWSPEC (AF_MAX + 2)
	144	#endif
	145
	146	struct flowspec_prefix {
	147	uint16_t prefixlen; /* length in bytes */
	148	uintptr_t ptr;
	149	};
	150
b03b8898	151	/* FRR generic prefix structure. */
d62a17ae	152	struct prefix {
d7c0a89a QY	153	uint8_t family;
d7c0a89a QY	154	uint8_t prefixlen;
d62a17ae	155	union {
d7c0a89a	156	uint8_t prefix;
d62a17ae	157	struct in_addr prefix4;
	158	struct in6_addr prefix6;
	159	struct {
	160	struct in_addr id;
	161	struct in_addr adv_router;
	162	} lp;
	163	struct ethaddr prefix_eth; /* AF_ETHERNET */
d7c0a89a	164	uint8_t val[16];
d62a17ae	165	uintptr_t ptr;
b03b8898	166	struct evpn_addr prefix_evpn; /* AF_EVPN */
9a14899b	167	struct flowspec_prefix prefix_flowspec; /* AF_FLOWSPEC */
d62a17ae	168	} u __attribute__((aligned(8)));
718e3744	169	};
	170
	171	/* IPv4 prefix structure. */
d62a17ae	172	struct prefix_ipv4 {
d7c0a89a QY	173	uint8_t family;
d7c0a89a QY	174	uint8_t prefixlen;
d62a17ae	175	struct in_addr prefix __attribute__((aligned(8)));
718e3744	176	};
	177
	178	/* IPv6 prefix structure. */
d62a17ae	179	struct prefix_ipv6 {
d7c0a89a QY	180	uint8_t family;
d7c0a89a QY	181	uint8_t prefixlen;
d62a17ae	182	struct in6_addr prefix __attribute__((aligned(8)));
718e3744	183	};
718e3744	184
d62a17ae	185	struct prefix_ls {
d7c0a89a QY	186	uint8_t family;
d7c0a89a QY	187	uint8_t prefixlen;
d62a17ae	188	struct in_addr id __attribute__((aligned(8)));
d62a17ae	189	struct in_addr adv_router;
718e3744	190	};
	191
	192	/* Prefix for routing distinguisher. */
d62a17ae	193	struct prefix_rd {
d7c0a89a QY	194	uint8_t family;
	195	uint8_t prefixlen;
	196	uint8_t val[8] __attribute__((aligned(8)));
718e3744	197	};
718e3744	198
32ac65d9	199	/* Prefix for ethernet. */
d62a17ae	200	struct prefix_eth {
d7c0a89a QY	201	uint8_t family;
d7c0a89a QY	202	uint8_t prefixlen;
d62a17ae	203	struct ethaddr eth_addr __attribute__((aligned(8))); /* AF_ETHERNET */
32ac65d9 LB	204	};
32ac65d9 LB	205
86f1ef44	206	/* EVPN prefix structure. */
d62a17ae	207	struct prefix_evpn {
d7c0a89a QY	208	uint8_t family;
d7c0a89a QY	209	uint8_t prefixlen;
d62a17ae	210	struct evpn_addr prefix __attribute__((aligned(8)));
86f1ef44	211	};
86f1ef44	212
3714a385	213	static inline int is_evpn_prefix_ipaddr_none(const struct prefix_evpn *evp)
	214	{
	215	if (evp->prefix.route_type == 2)
	216	return IS_IPADDR_NONE(&(evp)->prefix.macip_addr.ip);
	217	if (evp->prefix.route_type == 3)
	218	return IS_IPADDR_NONE(&(evp)->prefix.imet_addr.ip);
50f74cf1	219	if (evp->prefix.route_type == 4)
50f74cf1	220	return IS_IPADDR_NONE(&(evp)->prefix.es_addr.ip);
3714a385	221	if (evp->prefix.route_type == 5)
	222	return IS_IPADDR_NONE(&(evp)->prefix.prefix_addr.ip);
	223	return 0;
	224	}
	225
	226	static inline int is_evpn_prefix_ipaddr_v4(const struct prefix_evpn *evp)
	227	{
	228	if (evp->prefix.route_type == 2)
	229	return IS_IPADDR_V4(&(evp)->prefix.macip_addr.ip);
	230	if (evp->prefix.route_type == 3)
	231	return IS_IPADDR_V4(&(evp)->prefix.imet_addr.ip);
50f74cf1	232	if (evp->prefix.route_type == 4)
50f74cf1	233	return IS_IPADDR_V4(&(evp)->prefix.es_addr.ip);
3714a385	234	if (evp->prefix.route_type == 5)
	235	return IS_IPADDR_V4(&(evp)->prefix.prefix_addr.ip);
	236	return 0;
	237	}
	238
	239	static inline int is_evpn_prefix_ipaddr_v6(const struct prefix_evpn *evp)
	240	{
	241	if (evp->prefix.route_type == 2)
	242	return IS_IPADDR_V6(&(evp)->prefix.macip_addr.ip);
	243	if (evp->prefix.route_type == 3)
	244	return IS_IPADDR_V6(&(evp)->prefix.imet_addr.ip);
50f74cf1	245	if (evp->prefix.route_type == 4)
50f74cf1	246	return IS_IPADDR_V6(&(evp)->prefix.es_addr.ip);
3714a385	247	if (evp->prefix.route_type == 5)
	248	return IS_IPADDR_V6(&(evp)->prefix.prefix_addr.ip);
	249	return 0;
	250	}
	251
b4b359a2	252	/* Prefix for a generic pointer */
d62a17ae	253	struct prefix_ptr {
d7c0a89a QY	254	uint8_t family;
d7c0a89a QY	255	uint8_t prefixlen;
d62a17ae	256	uintptr_t prefix __attribute__((aligned(8)));
b4b359a2 PM	257	};
b4b359a2 PM	258
9a14899b PG	259	/* Prefix for a Flowspec entry */
	260	struct prefix_fs {
	261	uint8_t family;
	262	uint8_t prefixlen; /* unused */
	263	struct flowspec_prefix prefix __attribute__((aligned(8)));
	264	};
	265
d62a17ae	266	struct prefix_sg {
d7c0a89a QY	267	uint8_t family;
d7c0a89a QY	268	uint8_t prefixlen;
d62a17ae	269	struct in_addr src __attribute__((aligned(8)));
d62a17ae	270	struct in_addr grp;
e9219290 DS	271	};
e9219290 DS	272
f7bf4153 DL	273	/* helper to get type safety/avoid casts on calls
	274	* (w/o this, functions accepting all prefix types need casts on the caller
	275	* side, which strips type safety since the cast will accept any pointer
	276	* type.)
	277	*/
d62a17ae	278	union prefixptr {
	279	struct prefix *p;
	280	struct prefix_ipv4 *p4;
	281	struct prefix_ipv6 *p6;
	282	struct prefix_evpn *evp;
9a14899b	283	const struct prefix_fs *fs;
d62a17ae	284	} __attribute__((transparent_union));
	285
	286	union prefixconstptr {
	287	const struct prefix *p;
	288	const struct prefix_ipv4 *p4;
	289	const struct prefix_ipv6 *p6;
	290	const struct prefix_evpn *evp;
9a14899b	291	const struct prefix_fs *fs;
d62a17ae	292	} __attribute__((transparent_union));
f7bf4153	293
718e3744	294	#ifndef INET_ADDRSTRLEN
	295	#define INET_ADDRSTRLEN 16
	296	#endif /* INET_ADDRSTRLEN */
	297
	298	#ifndef INET6_ADDRSTRLEN
	299	#define INET6_ADDRSTRLEN 46
	300	#endif /* INET6_ADDRSTRLEN */
	301
	302	#ifndef INET6_BUFSIZ
	303	#define INET6_BUFSIZ 51
	304	#endif /* INET6_BUFSIZ */
	305
855110bb TT	306	/* Maximum prefix string length (IPv6) */
	307	#define PREFIX_STRLEN 51
	308
718e3744	309	/* Max bit/byte length of IPv4 address. */
	310	#define IPV4_MAX_BYTELEN 4
	311	#define IPV4_MAX_BITLEN 32
	312	#define IPV4_MAX_PREFIXLEN 32
	313	#define IPV4_ADDR_CMP(D,S) memcmp ((D), (S), IPV4_MAX_BYTELEN)
19aad877 JB	314
	315	static inline bool ipv4_addr_same(const struct in_addr *a,
	316	const struct in_addr *b)
	317	{
	318	return (a->s_addr == b->s_addr);
	319	}
	320	#define IPV4_ADDR_SAME(A,B) ipv4_addr_same((A), (B))
	321
	322	static inline void ipv4_addr_copy(struct in_addr *dst,
	323	const struct in_addr *src)
	324	{
	325	dst->s_addr = src->s_addr;
	326	}
	327	#define IPV4_ADDR_COPY(D,S) ipv4_addr_copy((D), (S))
718e3744	328
d7c0a89a QY	329	#define IPV4_NET0(a) ((((uint32_t)(a)) & 0xff000000) == 0x00000000)
	330	#define IPV4_NET127(a) ((((uint32_t)(a)) & 0xff000000) == 0x7f000000)
	331	#define IPV4_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffff0000) == 0xa9fe0000)
	332	#define IPV4_CLASS_DE(a) ((((uint32_t)(a)) & 0xe0000000) == 0xe0000000)
	333	#define IPV4_MC_LINKLOCAL(a) ((((uint32_t)(a)) & 0xffffff00) == 0xe0000000)
718e3744	334
	335	/* Max bit/byte length of IPv6 address. */
	336	#define IPV6_MAX_BYTELEN 16
	337	#define IPV6_MAX_BITLEN 128
	338	#define IPV6_MAX_PREFIXLEN 128
	339	#define IPV6_ADDR_CMP(D,S) memcmp ((D), (S), IPV6_MAX_BYTELEN)
	340	#define IPV6_ADDR_SAME(D,S) (memcmp ((D), (S), IPV6_MAX_BYTELEN) == 0)
	341	#define IPV6_ADDR_COPY(D,S) memcpy ((D), (S), IPV6_MAX_BYTELEN)
	342
	343	/* Count prefix size from mask length */
	344	#define PSIZE(a) (((a) + 7) / (8))
	345
cd1964ff DS	346	#define BSIZE(a) ((a) * (8))
cd1964ff DS	347
718e3744	348	/* Prefix's family member. */
	349	#define PREFIX_FAMILY(p) ((p)->family)
	350
5c6ed111 DL	351	/* glibc defines s6_addr32 to __in6_u.__u6_addr32 if __USE_{MISC \|\| GNU} */
	352	#ifndef s6_addr32
	353	#if defined(SUNOS_5)
	354	/* Some SunOS define s6_addr32 only to kernel */
	355	#define s6_addr32 _S6_un._S6_u32
	356	#else
	357	#define s6_addr32 __u6_addr.__u6_addr32
	358	#endif /* SUNOS_5 */
	359	#endif /s6_addr32/
	360
718e3744	361	/* Prototypes. */
f3ccedaa	362	extern int str2family(const char *);
d62a17ae	363	extern int afi2family(afi_t);
d62a17ae	364	extern afi_t family2afi(int);
db2fde34	365	extern const char *family2str(int family);
1ec23d90	366	extern const char *safi2str(safi_t safi);
32ac65d9	367	extern const char *afi2str(afi_t afi);
8cc4198f	368
f63f06da	369	/* Check bit of the prefix. */
d7c0a89a	370	extern unsigned int prefix_bit(const uint8_t *prefix, const uint8_t prefixlen);
d62a17ae	371	extern unsigned int prefix6_bit(const struct in6_addr *prefix,
d7c0a89a	372	const uint8_t prefixlen);
f63f06da	373
d62a17ae	374	extern struct prefix *prefix_new(void);
	375	extern void prefix_free(struct prefix *);
	376	extern const char prefix_family_str(const struct prefix );
	377	extern int prefix_blen(const struct prefix *);
	378	extern int str2prefix(const char , struct prefix );
4690c7d7	379
a9ea959f	380	#define PREFIX2STR_BUFFER PREFIX_STRLEN
a9ea959f	381
d62a17ae	382	extern const char prefix2str(union prefixconstptr, char , int);
	383	extern int prefix_match(const struct prefix , const struct prefix );
	384	extern int prefix_match_network_statement(const struct prefix *,
	385	const struct prefix *);
	386	extern int prefix_same(const struct prefix , const struct prefix );
	387	extern int prefix_cmp(const struct prefix , const struct prefix );
	388	extern int prefix_common_bits(const struct prefix , const struct prefix );
	389	extern void prefix_copy(struct prefix dest, const struct prefix src);
	390	extern void apply_mask(struct prefix *);
	391
	392	extern struct prefix sockunion2prefix(const union sockunion dest,
	393	const union sockunion *mask);
	394	extern struct prefix sockunion2hostprefix(const union sockunion ,
	395	struct prefix *p);
	396	extern void prefix2sockunion(const struct prefix , union sockunion );
	397
	398	extern int str2prefix_eth(const char , struct prefix_eth );
	399
	400	extern struct prefix_ipv4 *prefix_ipv4_new(void);
	401	extern void prefix_ipv4_free(struct prefix_ipv4 *);
	402	extern int str2prefix_ipv4(const char , struct prefix_ipv4 );
	403	extern void apply_mask_ipv4(struct prefix_ipv4 *);
	404
996c9314	405	#define PREFIX_COPY(DST, SRC) \
72a1b201	406	((struct prefix )(DST)) = ((const struct prefix )(SRC))
996c9314	407	#define PREFIX_COPY_IPV4(DST, SRC) \
e4529636 AS	408	((struct prefix_ipv4 )(DST)) = ((const struct prefix_ipv4 )(SRC));
e4529636 AS	409
d62a17ae	410	extern int prefix_ipv4_any(const struct prefix_ipv4 *);
d62a17ae	411	extern void apply_classful_mask_ipv4(struct prefix_ipv4 *);
8cc4198f	412
d7c0a89a	413	extern uint8_t ip_masklen(struct in_addr);
d62a17ae	414	extern void masklen2ip(const int, struct in_addr *);
3fb9cd6e	415	/* returns the network portion of the host address */
d62a17ae	416	extern in_addr_t ipv4_network_addr(in_addr_t hostaddr, int masklen);
3fb9cd6e	417	/* given the address of a host on a network and the network mask length,
	418	* calculate the broadcast address for that network;
	419	* special treatment for /31: returns the address of the other host
	420	* on the network by flipping the host bit */
d62a17ae	421	extern in_addr_t ipv4_broadcast_addr(in_addr_t hostaddr, int masklen);
3fb9cd6e	422
d62a17ae	423	extern int netmask_str2prefix_str(const char , const char , char *);
718e3744	424
d62a17ae	425	extern struct prefix_ipv6 *prefix_ipv6_new(void);
	426	extern void prefix_ipv6_free(struct prefix_ipv6 *);
	427	extern int str2prefix_ipv6(const char , struct prefix_ipv6 );
	428	extern void apply_mask_ipv6(struct prefix_ipv6 *);
718e3744	429
d62a17ae	430	#define PREFIX_COPY_IPV6(DST, SRC) \
e4529636 AS	431	((struct prefix_ipv6 )(DST)) = ((const struct prefix_ipv6 )(SRC));
e4529636 AS	432
d62a17ae	433	extern int ip6_masklen(struct in6_addr);
d62a17ae	434	extern void masklen2ip6(const int, struct in6_addr *);
b04c699e	435
d62a17ae	436	extern const char *inet6_ntoa(struct in6_addr);
5920990f	437
523cafc4	438	extern int is_zero_mac(struct ethaddr *mac);
db42a173 PG	439	extern int prefix_str2mac(const char str, struct ethaddr mac);
db42a173 PG	440	extern char prefix_mac2str(const struct ethaddr mac, char *buf, int size);
c215ecaf	441
7a7761d2 CF	442	extern unsigned prefix_hash_key(void *pp);
7a7761d2 CF	443
50f74cf1	444	extern int str_to_esi(const char str, esi_t esi);
	445	extern char esi_to_str(const esi_t esi, char *buf, int size);
	446	extern void prefix_hexdump(const struct prefix *p);
	447	extern void prefix_evpn_hexdump(const struct prefix_evpn *p);
	448
d62a17ae	449	static inline int ipv6_martian(struct in6_addr *addr)
d914d5ff	450	{
d62a17ae	451	struct in6_addr localhost_addr;
d914d5ff	452
d62a17ae	453	inet_pton(AF_INET6, "::1", &localhost_addr);
d914d5ff	454
d62a17ae	455	if (IPV6_ADDR_SAME(&localhost_addr, addr))
d62a17ae	456	return 1;
d914d5ff	457
d62a17ae	458	return 0;
d914d5ff DS	459	}
d914d5ff DS	460
d37ba549	461	extern int macstr2prefix_evpn(const char str, struct prefix_evpn p);
718e3744	462
d914d5ff	463	/* NOTE: This routine expects the address argument in network byte order. */
d62a17ae	464	static inline int ipv4_martian(struct in_addr *addr)
6ee06fa9	465	{
d62a17ae	466	in_addr_t ip = ntohl(addr->s_addr);
6ee06fa9	467
d62a17ae	468	if (IPV4_NET0(ip) \|\| IPV4_NET127(ip) \|\| IPV4_CLASS_DE(ip)) {
	469	return 1;
	470	}
	471	return 0;
6ee06fa9 PM	472	}
6ee06fa9 PM	473
f229873a	474	static inline int is_default_prefix(const struct prefix *p)
18ff3edd	475	{
d62a17ae	476	if (!p)
d62a17ae	477	return 0;
18ff3edd	478
996c9314 LB	479	if ((p->family == AF_INET) && (p->u.prefix4.s_addr == INADDR_ANY)
996c9314 LB	480	&& (p->prefixlen == 0))
f229873a DS	481	return 1;
f229873a DS	482
996c9314 LB	483	if ((p->family == AF_INET6) && (p->prefixlen == 0)
996c9314 LB	484	&& (!memcmp(&p->u.prefix6, &in6addr_any, sizeof(struct in6_addr))))
d62a17ae	485	return 1;
18ff3edd	486
d62a17ae	487	return 0;
18ff3edd DS	488	}
18ff3edd DS	489
408b00c4 MK	490	static inline int is_host_route(struct prefix *p)
	491	{
	492	if (p->family == AF_INET)
	493	return (p->prefixlen == IPV4_MAX_BITLEN);
	494	else if (p->family == AF_INET6)
	495	return (p->prefixlen == IPV6_MAX_BITLEN);
	496	return 0;
	497	}
718e3744	498	#endif /* _ZEBRA_PREFIX_H */