[mirror_frr.git] / lib / zebra.h

/* Zebra common header.
 * Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 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_H
#define _ZEBRA_H

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /* HAVE_CONFIG_H */

#include "compiler.h"

#ifdef SUNOS_5
typedef unsigned int uint32_t;
typedef unsigned short uint16_t;
typedef unsigned char uint8_t;
#endif /* SUNOS_5 */

#include <unistd.h>
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <ctype.h>
#include <errno.h>
#include <fcntl.h>
#include <signal.h>
#include <string.h>
#include <pwd.h>
#include <grp.h>
#ifdef HAVE_STROPTS_H
#include <stropts.h>
#endif /* HAVE_STROPTS_H */
#include <sys/select.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/param.h>
#ifdef HAVE_SYS_SYSCTL_H
#ifdef GNU_LINUX
#include <linux/types.h>
#endif
#include <sys/sysctl.h>
#endif /* HAVE_SYS_SYSCTL_H */
#include <sys/ioctl.h>
#ifdef HAVE_SYS_CONF_H
#include <sys/conf.h>
#endif /* HAVE_SYS_CONF_H */
#ifdef HAVE_SYS_KSYM_H
#include <sys/ksym.h>
#endif /* HAVE_SYS_KSYM_H */
#include <syslog.h>
#include <sys/time.h>
#include <time.h>
#include <sys/uio.h>
#include <sys/utsname.h>
#include <sys/resource.h>
#include <limits.h>
#include <inttypes.h>
#include <stdbool.h>

/* machine dependent includes */
#ifdef SUNOS_5
#include <strings.h>
#endif /* SUNOS_5 */

/* machine dependent includes */
#ifdef HAVE_LINUX_VERSION_H
#include <linux/version.h>
#endif /* HAVE_LINUX_VERSION_H */

#ifdef HAVE_ASM_TYPES_H
#include <asm/types.h>
#endif /* HAVE_ASM_TYPES_H */

/* misc include group */
#include <stdarg.h>
#if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
/* Not C99; do we need to define va_copy? */
#ifndef va_copy
#ifdef __va_copy
#define va_copy(DST,SRC) __va_copy(DST,SRC)
#else
/* Now we are desperate; this should work on many typical platforms.
   But this is slightly dangerous, because the standard does not require
   va_copy to be a macro. */
#define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
#warning "Not C99 and no va_copy macro available, falling back to memcpy"
#endif /* __va_copy */
#endif /* !va_copy */
#endif /* !C99 */


#ifdef HAVE_LCAPS
#include <sys/capability.h>
#include <sys/prctl.h>
#endif /* HAVE_LCAPS */

#ifdef HAVE_SOLARIS_CAPABILITIES
#include <priv.h>
#endif /* HAVE_SOLARIS_CAPABILITIES */

/* network include group */

#include <sys/socket.h>

#ifdef HAVE_SYS_SOCKIO_H
#include <sys/sockio.h>
#endif /* HAVE_SYS_SOCKIO_H */

#ifdef __APPLE__
#define __APPLE_USE_RFC_3542
#endif

#ifndef HAVE_LIBCRYPT
#ifdef HAVE_LIBCRYPTO
#include <openssl/des.h>
#      define crypt DES_crypt
#endif
#endif

#include "openbsd-tree.h"

#include <netinet/in.h>
#include <netinet/in_systm.h>
#include <netinet/ip.h>
#include <netinet/tcp.h>

#ifdef HAVE_NET_NETOPT_H
#include <net/netopt.h>
#endif /* HAVE_NET_NETOPT_H */

#include <net/if.h>

#ifdef HAVE_NET_IF_DL_H
#include <net/if_dl.h>
#endif /* HAVE_NET_IF_DL_H */

#ifdef HAVE_NET_IF_VAR_H
#include <net/if_var.h>
#endif /* HAVE_NET_IF_VAR_H */

#include <net/route.h>

#ifdef HAVE_NETLINK
#include <linux/netlink.h>
#include <linux/rtnetlink.h>
#include <linux/filter.h>
#else
#define RT_TABLE_MAIN		0
#endif /* HAVE_NETLINK */

#include <netdb.h>
#include <arpa/inet.h>

#ifdef HAVE_INET_ND_H
#include <inet/nd.h>
#endif /* HAVE_INET_ND_H */

#ifdef HAVE_NETINET_IN_VAR_H
#include <netinet/in_var.h>
#endif /* HAVE_NETINET_IN_VAR_H */

#ifdef HAVE_NETINET6_IN6_VAR_H
#include <netinet6/in6_var.h>
#endif /* HAVE_NETINET6_IN6_VAR_H */

#ifdef HAVE_NETINET_IN6_VAR_H
#include <netinet/in6_var.h>
#endif /* HAVE_NETINET_IN6_VAR_H */

#ifdef HAVE_NETINET6_IN_H
#include <netinet6/in.h>
#endif /* HAVE_NETINET6_IN_H */


#ifdef HAVE_NETINET6_IP6_H
#include <netinet6/ip6.h>
#endif /* HAVE_NETINET6_IP6_H */

#include <netinet/icmp6.h>

#ifdef HAVE_NETINET6_ND6_H
#include <netinet6/nd6.h>
#endif /* HAVE_NETINET6_ND6_H */

/* Some systems do not define UINT32_MAX, etc.. from inttypes.h
 * e.g. this makes life easier for FBSD 4.11 users.
 */
#ifndef INT8_MAX
#define INT8_MAX	(127)
#endif
#ifndef INT16_MAX
#define INT16_MAX	(32767)
#endif
#ifndef INT32_MAX
#define INT32_MAX	(2147483647)
#endif
#ifndef UINT8_MAX
#define UINT8_MAX	(255U)
#endif
#ifndef UINT16_MAX
#define UINT16_MAX	(65535U)
#endif
#ifndef UINT32_MAX
#define UINT32_MAX	(4294967295U)
#endif

#ifdef HAVE_GLIBC_BACKTRACE
#include <execinfo.h>
#endif /* HAVE_GLIBC_BACKTRACE */

/* Local includes: */
#if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL))
#define __attribute__(x)
#endif /* !__GNUC__ || VTYSH_EXTRACT_PL */

#include "zassert.h"

/*
 * Add explicit static cast only when using a C++ compiler.
 */
#ifdef __cplusplus
#define static_cast(l, r) static_cast<decltype(l)>((r))
#else
#define static_cast(l, r) (r)
#endif

#ifndef HAVE_STRLCAT
size_t strlcat(char *__restrict dest,
	       const char *__restrict src, size_t destsize);
#endif
#ifndef HAVE_STRLCPY
size_t strlcpy(char *__restrict dest,
	       const char *__restrict src, size_t destsize);
#endif

/* GCC have printf type attribute check.  */
#ifdef __GNUC__
#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
#else
#define PRINTF_ATTRIBUTE(a,b)
#endif /* __GNUC__ */

/*
 * RFC 3542 defines several macros for using struct cmsghdr.
 * Here, we define those that are not present
 */

/*
 * Internal defines, for use only in this file.
 * These are likely wrong on other than ILP32 machines, so warn.
 */
#ifndef _CMSG_DATA_ALIGN
#define _CMSG_DATA_ALIGN(n)           (((n) + 3) & ~3)
#endif /* _CMSG_DATA_ALIGN */

#ifndef _CMSG_HDR_ALIGN
#define _CMSG_HDR_ALIGN(n)            (((n) + 3) & ~3)
#endif /* _CMSG_HDR_ALIGN */

/*
 * CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
 * version.
 */
#ifndef CMSG_SPACE
#define CMSG_SPACE(l)                                                          \
	(_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + _CMSG_HDR_ALIGN(l))
#warning "assuming 4-byte alignment for CMSG_SPACE"
#endif /* CMSG_SPACE */


#ifndef CMSG_LEN
#define CMSG_LEN(l)         (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
#warning "assuming 4-byte alignment for CMSG_LEN"
#endif /* CMSG_LEN */


/*  The definition of struct in_pktinfo is missing in old version of
    GLIBC 2.1 (Redhat 6.1).  */
#if defined(GNU_LINUX) && !defined(HAVE_STRUCT_IN_PKTINFO)
struct in_pktinfo {
	int ipi_ifindex;
	struct in_addr ipi_spec_dst;
	struct in_addr ipi_addr;
};
#endif

/*
 * IP_HDRINCL / struct ip byte order
 *
 * Linux: network byte order
 * *BSD: network, except for length and offset. (cf Stevens)
 * SunOS: nominally as per BSD. but bug: network order on LE.
 * OpenBSD: network byte order, apart from older versions which are as per
 *          *BSD
 */
#if defined(__NetBSD__)                                                        \
	|| (defined(__FreeBSD__) && (__FreeBSD_version < 1100030))             \
	|| (defined(__OpenBSD__) && (OpenBSD < 200311))                        \
	|| (defined(__APPLE__))                                                \
	|| (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
#define HAVE_IP_HDRINCL_BSD_ORDER
#endif

/* Define BYTE_ORDER, if not defined. Useful for compiler conditional
 * code, rather than preprocessor conditional.
 * Not all the world has this BSD define.
 */
#ifndef BYTE_ORDER
#define BIG_ENDIAN	4321	/* least-significant byte first (vax, pc) */
#define LITTLE_ENDIAN	1234	/* most-significant byte first (IBM, net) */
#define PDP_ENDIAN	3412	/* LSB first in word, MSW first in long (pdp) */

#if defined(WORDS_BIGENDIAN)
#define BYTE_ORDER	BIG_ENDIAN
#else  /* !WORDS_BIGENDIAN */
#define BYTE_ORDER	LITTLE_ENDIAN
#endif /* WORDS_BIGENDIAN */

#endif /* ndef BYTE_ORDER */

/* For old definition. */
#ifndef IN6_ARE_ADDR_EQUAL
#define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
#endif /* IN6_ARE_ADDR_EQUAL */

/* default zebra TCP port for zclient */
#define ZEBRA_PORT			2600

/* Marker value used in new Zserv, in the byte location corresponding
 * the command value in the old zserv header. To allow old and new
 * Zserv headers to be distinguished from each other.
 */
#define ZEBRA_HEADER_MARKER              254

/*
 * The compiler.h header is used for anyone using the CPP_NOTICE
 * since this is universally needed, let's add it to zebra.h
 */
#include "compiler.h"

/* Zebra route's types are defined in route_types.h */
#include "route_types.h"

/* Note: whenever a new route-type or zserv-command is added the
 * corresponding {command,route}_types[] table in lib/log.c MUST be
 * updated! */

/* Map a route type to a string.  For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
extern const char *zebra_route_string(unsigned int route_type);
/* Map a route type to a char.  For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
extern char zebra_route_char(unsigned int route_type);
/* Map a zserv command type to the same string,
 * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
/* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
extern int proto_name2num(const char *s);
/* Map redistribute X argument to protocol number.
 * unlike proto_name2num, this accepts shorthands and takes
 * an AFI value to restrict input */
extern int proto_redistnum(int afi, const char *s);

extern const char *zserv_command_string(unsigned int command);

#define strmatch(a,b) (!strcmp((a), (b)))

/* Zebra message flags */

/*
 * Cause Zebra to consider this routes nexthops recursively
 */
#define ZEBRA_FLAG_ALLOW_RECURSION    0x01
/*
 * This is a route that is read in on startup that was left around
 * from a previous run of FRR
 */
#define ZEBRA_FLAG_SELFROUTE          0x02
/*
 * This flag is used to tell Zebra that the BGP route being passed
 * down is a IBGP route
 */
#define ZEBRA_FLAG_IBGP               0x04
/*
 * This is a route that has been selected for FIB installation.
 * This flag is set in zebra and can be passed up to routing daemons
 */
#define ZEBRA_FLAG_SELECTED           0x08
/*
 * This is a route that we are telling Zebra that this route *must*
 * win and will be installed even over ZEBRA_FLAG_SELECTED
 */
#define ZEBRA_FLAG_FIB_OVERRIDE       0x10
/*
 * This flag tells Zebra that the route is a EVPN route and should
 * be treated specially
 */
#define ZEBRA_FLAG_EVPN_ROUTE         0x20
/*
 * This flag tells Zebra that it should treat the distance passed
 * down as an additional discriminator for route selection of the
 * route entry.  This mainly is used for backup static routes.
 */
#define ZEBRA_FLAG_RR_USE_DISTANCE    0x40

#ifndef INADDR_LOOPBACK
#define	INADDR_LOOPBACK	0x7f000001	/* Internet address 127.0.0.1.  */
#endif

/* Address family numbers from RFC1700. */
typedef enum { AFI_IP = 1, AFI_IP6 = 2, AFI_L2VPN = 3, AFI_MAX = 4 } afi_t;

/* Subsequent Address Family Identifier. */
typedef enum {
	SAFI_UNICAST = 1,
	SAFI_MULTICAST = 2,
	SAFI_MPLS_VPN = 3,
	SAFI_ENCAP = 4,
	SAFI_EVPN = 5,
	SAFI_LABELED_UNICAST = 6,
	SAFI_FLOWSPEC = 7,
	SAFI_MAX = 8
} safi_t;

/*
 * The above AFI and SAFI definitions are for internal use. The protocol
 * definitions (IANA values) as for example used in BGP protocol packets
 * are defined below and these will get mapped to/from the internal values
 * in the appropriate places.
 * The rationale is that the protocol (IANA) values may be sparse and are
 * not optimal for use in data-structure sizing.
 * Note: Only useful (i.e., supported) values are defined below.
 */
typedef enum {
	IANA_AFI_RESERVED = 0,
	IANA_AFI_IPV4 = 1,
	IANA_AFI_IPV6 = 2,
	IANA_AFI_L2VPN = 25,
	IANA_AFI_IPMR = 128,
	IANA_AFI_IP6MR = 129
} iana_afi_t;

typedef enum {
	IANA_SAFI_RESERVED = 0,
	IANA_SAFI_UNICAST = 1,
	IANA_SAFI_MULTICAST = 2,
	IANA_SAFI_LABELED_UNICAST = 4,
	IANA_SAFI_ENCAP = 7,
	IANA_SAFI_EVPN = 70,
	IANA_SAFI_MPLS_VPN = 128,
	IANA_SAFI_FLOWSPEC = 133
} iana_safi_t;

/* Default Administrative Distance of each protocol. */
#define ZEBRA_KERNEL_DISTANCE_DEFAULT      0
#define ZEBRA_CONNECT_DISTANCE_DEFAULT     0
#define ZEBRA_STATIC_DISTANCE_DEFAULT      1
#define ZEBRA_RIP_DISTANCE_DEFAULT       120
#define ZEBRA_RIPNG_DISTANCE_DEFAULT     120
#define ZEBRA_OSPF_DISTANCE_DEFAULT      110
#define ZEBRA_OSPF6_DISTANCE_DEFAULT     110
#define ZEBRA_ISIS_DISTANCE_DEFAULT      115
#define ZEBRA_IBGP_DISTANCE_DEFAULT      200
#define ZEBRA_EBGP_DISTANCE_DEFAULT       20
#define ZEBRA_TABLE_DISTANCE_DEFAULT      15

/* Flag manipulation macros. */
#define CHECK_FLAG(V,F)      ((V) & (F))
#define SET_FLAG(V,F)        (V) |= (F)
#define UNSET_FLAG(V,F)      (V) &= ~(F)
#define RESET_FLAG(V)        (V) = 0
#define COND_FLAG(V, F, C)   ((C) ? (SET_FLAG(V, F)) : (UNSET_FLAG(V, F)))

/* Atomic flag manipulation macros. */
#define CHECK_FLAG_ATOMIC(PV, F)                                               \
	((atomic_load_explicit(PV, memory_order_seq_cst)) & (F))
#define SET_FLAG_ATOMIC(PV, F)                                                 \
	((atomic_fetch_or_explicit(PV, (F), memory_order_seq_cst)))
#define UNSET_FLAG_ATOMIC(PV, F)                                               \
	((atomic_fetch_and_explicit(PV, ~(F), memory_order_seq_cst)))
#define RESET_FLAG_ATOMIC(PV)                                                  \
	((atomic_store_explicit(PV, 0, memory_order_seq_cst)))

/* Zebra types. Used in Zserv message header. */
typedef uint16_t zebra_size_t;
typedef uint16_t zebra_command_t;

/* VRF ID type. */
typedef uint32_t vrf_id_t;

typedef uint32_t route_tag_t;
#define ROUTE_TAG_MAX UINT32_MAX
#define ROUTE_TAG_PRI PRIu32

static inline afi_t afi_iana2int(iana_afi_t afi)
{
	switch (afi) {
	case IANA_AFI_IPV4:
		return AFI_IP;
	case IANA_AFI_IPV6:
		return AFI_IP6;
	case IANA_AFI_L2VPN:
		return AFI_L2VPN;
	default:
		return AFI_MAX;
	}
}

static inline iana_afi_t afi_int2iana(afi_t afi)
{
	switch (afi) {
	case AFI_IP:
		return IANA_AFI_IPV4;
	case AFI_IP6:
		return IANA_AFI_IPV6;
	case AFI_L2VPN:
		return IANA_AFI_L2VPN;
	default:
		return IANA_AFI_RESERVED;
	}
}

static inline safi_t safi_iana2int(iana_safi_t safi)
{
	switch (safi) {
	case IANA_SAFI_UNICAST:
		return SAFI_UNICAST;
	case IANA_SAFI_MULTICAST:
		return SAFI_MULTICAST;
	case IANA_SAFI_MPLS_VPN:
		return SAFI_MPLS_VPN;
	case IANA_SAFI_ENCAP:
		return SAFI_ENCAP;
	case IANA_SAFI_EVPN:
		return SAFI_EVPN;
	case IANA_SAFI_LABELED_UNICAST:
		return SAFI_LABELED_UNICAST;
	case IANA_SAFI_FLOWSPEC:
		return SAFI_FLOWSPEC;
	default:
		return SAFI_MAX;
	}
}

static inline iana_safi_t safi_int2iana(safi_t safi)
{
	switch (safi) {
	case SAFI_UNICAST:
		return IANA_SAFI_UNICAST;
	case SAFI_MULTICAST:
		return IANA_SAFI_MULTICAST;
	case SAFI_MPLS_VPN:
		return IANA_SAFI_MPLS_VPN;
	case SAFI_ENCAP:
		return IANA_SAFI_ENCAP;
	case SAFI_EVPN:
		return IANA_SAFI_EVPN;
	case SAFI_LABELED_UNICAST:
		return IANA_SAFI_LABELED_UNICAST;
	case SAFI_FLOWSPEC:
		return IANA_SAFI_FLOWSPEC;
	default:
		return IANA_SAFI_RESERVED;
	}
}

#endif /* _ZEBRA_H */
Commit	Line	Data
718e3744	1	/* Zebra common header.
896014f4 DL	2	* Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Kunihiro Ishiguro
	3	*
	4	* This file is part of GNU Zebra.
	5	*
	6	* GNU Zebra is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2, or (at your option) any
	9	* later version.
	10	*
	11	* GNU Zebra is distributed in the hope that it will be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	14	* General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License along
	17	* with this program; see the file COPYING; if not, write to the Free Software
	18	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	19	*/
718e3744	20
	21	#ifndef _ZEBRA_H
	22	#define _ZEBRA_H
	23
	24	#ifdef HAVE_CONFIG_H
	25	#include "config.h"
	26	#endif /* HAVE_CONFIG_H */
	27
ef7eec74 QY	28	#include "compiler.h"
ef7eec74 QY	29
718e3744	30	#ifdef SUNOS_5
d7c0a89a QY	31	typedef unsigned int uint32_t;
	32	typedef unsigned short uint16_t;
	33	typedef unsigned char uint8_t;
718e3744	34	#endif /* SUNOS_5 */
	35
	36	#include <unistd.h>
	37	#include <stdio.h>
	38	#include <stdlib.h>
c423d413	39	#include <stddef.h>
718e3744	40	#include <ctype.h>
	41	#include <errno.h>
	42	#include <fcntl.h>
	43	#include <signal.h>
	44	#include <string.h>
edd7c245	45	#include <pwd.h>
edd7c245	46	#include <grp.h>
718e3744	47	#ifdef HAVE_STROPTS_H
	48	#include <stropts.h>
	49	#endif /* HAVE_STROPTS_H */
718e3744	50	#include <sys/select.h>
718e3744	51	#include <sys/stat.h>
718e3744	52	#include <sys/types.h>
	53	#include <sys/param.h>
	54	#ifdef HAVE_SYS_SYSCTL_H
0dc0b708 AS	55	#ifdef GNU_LINUX
	56	#include <linux/types.h>
	57	#endif
718e3744	58	#include <sys/sysctl.h>
	59	#endif /* HAVE_SYS_SYSCTL_H */
	60	#include <sys/ioctl.h>
	61	#ifdef HAVE_SYS_CONF_H
	62	#include <sys/conf.h>
	63	#endif /* HAVE_SYS_CONF_H */
	64	#ifdef HAVE_SYS_KSYM_H
	65	#include <sys/ksym.h>
	66	#endif /* HAVE_SYS_KSYM_H */
	67	#include <syslog.h>
24f5e2fc DL	68	#include <sys/time.h>
24f5e2fc DL	69	#include <time.h>
718e3744	70	#include <sys/uio.h>
718e3744	71	#include <sys/utsname.h>
718e3744	72	#include <sys/resource.h>
a58c25b6	73	#include <limits.h>
35cfc90c	74	#include <inttypes.h>
63a13864	75	#include <stdbool.h>
718e3744	76
	77	/* machine dependent includes */
	78	#ifdef SUNOS_5
718e3744	79	#include <strings.h>
	80	#endif /* SUNOS_5 */
	81
	82	/* machine dependent includes */
	83	#ifdef HAVE_LINUX_VERSION_H
	84	#include <linux/version.h>
	85	#endif /* HAVE_LINUX_VERSION_H */
	86
ba965c6c	87	#ifdef HAVE_ASM_TYPES_H
	88	#include <asm/types.h>
	89	#endif /* HAVE_ASM_TYPES_H */
	90
718e3744	91	/* misc include group */
718e3744	92	#include <stdarg.h>
4cf0d0df	93	#if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
4cf0d0df	94	/* Not C99; do we need to define va_copy? */
e22f5516	95	#ifndef va_copy
e22f5516	96	#ifdef __va_copy
4cf0d0df	97	#define va_copy(DST,SRC) __va_copy(DST,SRC)
e22f5516	98	#else
d62a17ae	99	/* Now we are desperate; this should work on many typical platforms.
e22f5516	100	But this is slightly dangerous, because the standard does not require
	101	va_copy to be a macro. */
	102	#define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
	103	#warning "Not C99 and no va_copy macro available, falling back to memcpy"
	104	#endif /* __va_copy */
	105	#endif /* !va_copy */
4cf0d0df	106	#endif /* !C99 */
db8eaac6	107
718e3744	108
ba3a0bc5	109	#ifdef HAVE_LCAPS
	110	#include <sys/capability.h>
	111	#include <sys/prctl.h>
	112	#endif /* HAVE_LCAPS */
	113
ceacedba	114	#ifdef HAVE_SOLARIS_CAPABILITIES
	115	#include <priv.h>
	116	#endif /* HAVE_SOLARIS_CAPABILITIES */
	117
718e3744	118	/* network include group */
	119
	120	#include <sys/socket.h>
	121
	122	#ifdef HAVE_SYS_SOCKIO_H
	123	#include <sys/sockio.h>
	124	#endif /* HAVE_SYS_SOCKIO_H */
	125
ea057677 HT	126	#ifdef __APPLE__
	127	#define __APPLE_USE_RFC_3542
	128	#endif
	129
f9e75524	130	#ifndef HAVE_LIBCRYPT
996c9314 LB	131	#ifdef HAVE_LIBCRYPTO
996c9314 LB	132	#include <openssl/des.h>
f9e75524	133	# define crypt DES_crypt
996c9314	134	#endif
f9e75524 JAG	135	#endif
f9e75524 JAG	136
8d8763f4	137	#include "openbsd-tree.h"
6021c8d3	138
718e3744	139	#include <netinet/in.h>
718e3744	140	#include <netinet/in_systm.h>
	141	#include <netinet/ip.h>
	142	#include <netinet/tcp.h>
	143
	144	#ifdef HAVE_NET_NETOPT_H
	145	#include <net/netopt.h>
	146	#endif /* HAVE_NET_NETOPT_H */
	147
	148	#include <net/if.h>
	149
	150	#ifdef HAVE_NET_IF_DL_H
	151	#include <net/if_dl.h>
	152	#endif /* HAVE_NET_IF_DL_H */
	153
	154	#ifdef HAVE_NET_IF_VAR_H
	155	#include <net/if_var.h>
	156	#endif /* HAVE_NET_IF_VAR_H */
	157
	158	#include <net/route.h>
	159
	160	#ifdef HAVE_NETLINK
	161	#include <linux/netlink.h>
	162	#include <linux/rtnetlink.h>
768a27ea	163	#include <linux/filter.h>
718e3744	164	#else
	165	#define RT_TABLE_MAIN 0
	166	#endif /* HAVE_NETLINK */
	167
718e3744	168	#include <netdb.h>
718e3744	169	#include <arpa/inet.h>
718e3744	170
	171	#ifdef HAVE_INET_ND_H
	172	#include <inet/nd.h>
	173	#endif /* HAVE_INET_ND_H */
	174
	175	#ifdef HAVE_NETINET_IN_VAR_H
	176	#include <netinet/in_var.h>
	177	#endif /* HAVE_NETINET_IN_VAR_H */
	178
726f9b2b	179	#ifdef HAVE_NETINET6_IN6_VAR_H
	180	#include <netinet6/in6_var.h>
	181	#endif /* HAVE_NETINET6_IN6_VAR_H */
	182
718e3744	183	#ifdef HAVE_NETINET_IN6_VAR_H
	184	#include <netinet/in6_var.h>
	185	#endif /* HAVE_NETINET_IN6_VAR_H */
	186
	187	#ifdef HAVE_NETINET6_IN_H
	188	#include <netinet6/in.h>
	189	#endif /* HAVE_NETINET6_IN_H */
	190
	191
	192	#ifdef HAVE_NETINET6_IP6_H
	193	#include <netinet6/ip6.h>
	194	#endif /* HAVE_NETINET6_IP6_H */
	195
718e3744	196	#include <netinet/icmp6.h>
718e3744	197
	198	#ifdef HAVE_NETINET6_ND6_H
	199	#include <netinet6/nd6.h>
	200	#endif /* HAVE_NETINET6_ND6_H */
	201
35cfc90c PJ	202	/* Some systems do not define UINT32_MAX, etc.. from inttypes.h
	203	* e.g. this makes life easier for FBSD 4.11 users.
	204	*/
	205	#ifndef INT8_MAX
	206	#define INT8_MAX (127)
	207	#endif
	208	#ifndef INT16_MAX
	209	#define INT16_MAX (32767)
	210	#endif
	211	#ifndef INT32_MAX
	212	#define INT32_MAX (2147483647)
	213	#endif
	214	#ifndef UINT8_MAX
	215	#define UINT8_MAX (255U)
	216	#endif
	217	#ifndef UINT16_MAX
	218	#define UINT16_MAX (65535U)
	219	#endif
3b424979	220	#ifndef UINT32_MAX
35cfc90c PJ	221	#define UINT32_MAX (4294967295U)
35cfc90c PJ	222	#endif
3b424979	223
fb2d1502	224	#ifdef HAVE_GLIBC_BACKTRACE
	225	#include <execinfo.h>
	226	#endif /* HAVE_GLIBC_BACKTRACE */
	227
db8eaac6	228	/* Local includes: */
d62a17ae	229	#if !(defined(__GNUC__) \|\| defined(VTYSH_EXTRACT_PL))
db8eaac6	230	#define __attribute__(x)
d62a17ae	231	#endif /* !__GNUC__ \|\| VTYSH_EXTRACT_PL */
db8eaac6	232
	233	#include "zassert.h"
	234
343cd13e RW	235	/*
	236	* Add explicit static cast only when using a C++ compiler.
	237	*/
	238	#ifdef __cplusplus
	239	#define static_cast(l, r) static_cast<decltype(l)>((r))
	240	#else
	241	#define static_cast(l, r) (r)
	242	#endif
	243
c5d9d3bb	244	#ifndef HAVE_STRLCAT
c9a164df DS	245	size_t strlcat(char *__restrict dest,
c9a164df DS	246	const char *__restrict src, size_t destsize);
c5d9d3bb DL	247	#endif
c5d9d3bb DL	248	#ifndef HAVE_STRLCPY
c9a164df DS	249	size_t strlcpy(char *__restrict dest,
c9a164df DS	250	const char *__restrict src, size_t destsize);
c5d9d3bb	251	#endif
db8eaac6	252
fe232cf8 QY	253	/* GCC have printf type attribute check. */
	254	#ifdef __GNUC__
	255	#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
	256	#else
	257	#define PRINTF_ATTRIBUTE(a,b)
	258	#endif /* __GNUC__ */
b99760ab	259
d62a17ae	260	/*
69e1325f	261	* RFC 3542 defines several macros for using struct cmsghdr.
	262	* Here, we define those that are not present
	263	*/
	264
	265	/*
	266	* Internal defines, for use only in this file.
	267	* These are likely wrong on other than ILP32 machines, so warn.
02ff83c5	268	*/
	269	#ifndef _CMSG_DATA_ALIGN
	270	#define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
	271	#endif /* _CMSG_DATA_ALIGN */
	272
	273	#ifndef _CMSG_HDR_ALIGN
	274	#define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
	275	#endif /* _CMSG_HDR_ALIGN */
	276
69e1325f	277	/*
	278	* CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
	279	* version.
	280	*/
02ff83c5	281	#ifndef CMSG_SPACE
d62a17ae	282	#define CMSG_SPACE(l) \
d62a17ae	283	(_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + _CMSG_HDR_ALIGN(l))
69e1325f	284	#warning "assuming 4-byte alignment for CMSG_SPACE"
d62a17ae	285	#endif /* CMSG_SPACE */
02ff83c5	286
	287
	288	#ifndef CMSG_LEN
	289	#define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
69e1325f	290	#warning "assuming 4-byte alignment for CMSG_LEN"
02ff83c5	291	#endif /* CMSG_LEN */
02ff83c5	292
69e1325f	293
718e3744	294	/* The definition of struct in_pktinfo is missing in old version of
718e3744	295	GLIBC 2.1 (Redhat 6.1). */
d62a17ae	296	#if defined(GNU_LINUX) && !defined(HAVE_STRUCT_IN_PKTINFO)
	297	struct in_pktinfo {
	298	int ipi_ifindex;
	299	struct in_addr ipi_spec_dst;
	300	struct in_addr ipi_addr;
718e3744	301	};
	302	#endif
	303
d62a17ae	304	/*
9172ee0e	305	* IP_HDRINCL / struct ip byte order
	306	*
	307	* Linux: network byte order
	308	* *BSD: network, except for length and offset. (cf Stevens)
	309	* SunOS: nominally as per BSD. but bug: network order on LE.
d62a17ae	310	* OpenBSD: network byte order, apart from older versions which are as per
9172ee0e	311	* *BSD
9172ee0e	312	*/
d62a17ae	313	#if defined(__NetBSD__) \
	314	\|\| (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
	315	\|\| (defined(__OpenBSD__) && (OpenBSD < 200311)) \
	316	\|\| (defined(__APPLE__)) \
	317	\|\| (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
9172ee0e	318	#define HAVE_IP_HDRINCL_BSD_ORDER
	319	#endif
	320
34204aac	321	/* Define BYTE_ORDER, if not defined. Useful for compiler conditional
	322	* code, rather than preprocessor conditional.
	323	* Not all the world has this BSD define.
	324	*/
	325	#ifndef BYTE_ORDER
	326	#define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
	327	#define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
	328	#define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
	329
	330	#if defined(WORDS_BIGENDIAN)
	331	#define BYTE_ORDER BIG_ENDIAN
d62a17ae	332	#else /* !WORDS_BIGENDIAN */
34204aac	333	#define BYTE_ORDER LITTLE_ENDIAN
	334	#endif /* WORDS_BIGENDIAN */
	335
	336	#endif /* ndef BYTE_ORDER */
	337
718e3744	338	/* For old definition. */
	339	#ifndef IN6_ARE_ADDR_EQUAL
	340	#define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
	341	#endif /* IN6_ARE_ADDR_EQUAL */
	342
8cc4198f	343	/* default zebra TCP port for zclient */
	344	#define ZEBRA_PORT 2600
	345
c1b9800a	346	/* Marker value used in new Zserv, in the byte location corresponding
	347	* the command value in the old zserv header. To allow old and new
	348	* Zserv headers to be distinguished from each other.
	349	*/
80e71dcd	350	#define ZEBRA_HEADER_MARKER 254
c1b9800a	351
728806e6 DS	352	/*
	353	* The compiler.h header is used for anyone using the CPP_NOTICE
	354	* since this is universally needed, let's add it to zebra.h
	355	*/
	356	#include "compiler.h"
	357
e0ca5fde DL	358	/* Zebra route's types are defined in route_types.h */
e0ca5fde DL	359	#include "route_types.h"
718e3744	360
d6d672aa PJ	361	/* Note: whenever a new route-type or zserv-command is added the
	362	* corresponding {command,route}_types[] table in lib/log.c MUST be
	363	* updated! */
f52d13cb	364
f52d13cb	365	/* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
b6026073	366	extern const char *zebra_route_string(unsigned int route_type);
f52d13cb	367	/* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
b6026073	368	extern char zebra_route_char(unsigned int route_type);
d62a17ae	369	/* Map a zserv command type to the same string,
d6d672aa	370	* e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
7514fb77 PJ	371	/* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
7514fb77 PJ	372	extern int proto_name2num(const char *s);
e0ca5fde DL	373	/* Map redistribute X argument to protocol number.
	374	* unlike proto_name2num, this accepts shorthands and takes
	375	* an AFI value to restrict input */
	376	extern int proto_redistnum(int afi, const char *s);
7514fb77	377
d62a17ae	378	extern const char *zserv_command_string(unsigned int command);
f52d13cb	379
bf31fc81 DL	380	#define strmatch(a,b) (!strcmp((a), (b)))
bf31fc81 DL	381
718e3744	382	/* Zebra message flags */
07c67e1e DS	383
	384	/*
	385	* Cause Zebra to consider this routes nexthops recursively
	386	*/
4e8b02f4	387	#define ZEBRA_FLAG_ALLOW_RECURSION 0x01
07c67e1e DS	388	/*
	389	* This is a route that is read in on startup that was left around
	390	* from a previous run of FRR
	391	*/
718e3744	392	#define ZEBRA_FLAG_SELFROUTE 0x02
07c67e1e DS	393	/*
	394	* This flag is used to tell Zebra that the BGP route being passed
	395	* down is a IBGP route
	396	*/
	397	#define ZEBRA_FLAG_IBGP 0x04
	398	/*
	399	* This is a route that has been selected for FIB installation.
	400	* This flag is set in zebra and can be passed up to routing daemons
	401	*/
	402	#define ZEBRA_FLAG_SELECTED 0x08
	403	/*
	404	* This is a route that we are telling Zebra that this route must
	405	* win and will be installed even over ZEBRA_FLAG_SELECTED
	406	*/
	407	#define ZEBRA_FLAG_FIB_OVERRIDE 0x10
	408	/*
	409	* This flag tells Zebra that the route is a EVPN route and should
	410	* be treated specially
	411	*/
	412	#define ZEBRA_FLAG_EVPN_ROUTE 0x20
	413	/*
	414	* This flag tells Zebra that it should treat the distance passed
	415	* down as an additional discriminator for route selection of the
	416	* route entry. This mainly is used for backup static routes.
	417	*/
	418	#define ZEBRA_FLAG_RR_USE_DISTANCE 0x40
718e3744	419
718e3744	420	#ifndef INADDR_LOOPBACK
	421	#define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
	422	#endif
	423
	424	/* Address family numbers from RFC1700. */
d62a17ae	425	typedef enum { AFI_IP = 1, AFI_IP6 = 2, AFI_L2VPN = 3, AFI_MAX = 4 } afi_t;
718e3744	426
718e3744	427	/* Subsequent Address Family Identifier. */
5c525538 RW	428	typedef enum {
	429	SAFI_UNICAST = 1,
	430	SAFI_MULTICAST = 2,
	431	SAFI_MPLS_VPN = 3,
	432	SAFI_ENCAP = 4,
	433	SAFI_EVPN = 5,
	434	SAFI_LABELED_UNICAST = 6,
b98f7728 PG	435	SAFI_FLOWSPEC = 7,
b98f7728 PG	436	SAFI_MAX = 8
5c525538	437	} safi_t;
718e3744	438
90d82769 DS	439	/*
	440	* The above AFI and SAFI definitions are for internal use. The protocol
	441	* definitions (IANA values) as for example used in BGP protocol packets
	442	* are defined below and these will get mapped to/from the internal values
	443	* in the appropriate places.
	444	* The rationale is that the protocol (IANA) values may be sparse and are
	445	* not optimal for use in data-structure sizing.
	446	* Note: Only useful (i.e., supported) values are defined below.
	447	*/
	448	typedef enum {
d62a17ae	449	IANA_AFI_RESERVED = 0,
	450	IANA_AFI_IPV4 = 1,
	451	IANA_AFI_IPV6 = 2,
	452	IANA_AFI_L2VPN = 25,
	453	IANA_AFI_IPMR = 128,
	454	IANA_AFI_IP6MR = 129
90d82769 DS	455	} iana_afi_t;
90d82769 DS	456
5c525538 RW	457	typedef enum {
	458	IANA_SAFI_RESERVED = 0,
	459	IANA_SAFI_UNICAST = 1,
	460	IANA_SAFI_MULTICAST = 2,
	461	IANA_SAFI_LABELED_UNICAST = 4,
	462	IANA_SAFI_ENCAP = 7,
	463	IANA_SAFI_EVPN = 70,
7c40bf39	464	IANA_SAFI_MPLS_VPN = 128,
7c40bf39	465	IANA_SAFI_FLOWSPEC = 133
5c525538	466	} iana_safi_t;
718e3744	467
718e3744	468	/* Default Administrative Distance of each protocol. */
	469	#define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
	470	#define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
	471	#define ZEBRA_STATIC_DISTANCE_DEFAULT 1
	472	#define ZEBRA_RIP_DISTANCE_DEFAULT 120
	473	#define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
	474	#define ZEBRA_OSPF_DISTANCE_DEFAULT 110
	475	#define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
9e867fe6	476	#define ZEBRA_ISIS_DISTANCE_DEFAULT 115
718e3744	477	#define ZEBRA_IBGP_DISTANCE_DEFAULT 200
718e3744	478	#define ZEBRA_EBGP_DISTANCE_DEFAULT 20
7ab5795a	479	#define ZEBRA_TABLE_DISTANCE_DEFAULT 15
718e3744	480
	481	/* Flag manipulation macros. */
	482	#define CHECK_FLAG(V,F) ((V) & (F))
548e6f7d	483	#define SET_FLAG(V,F) (V) \|= (F)
548e6f7d	484	#define UNSET_FLAG(V,F) (V) &= ~(F)
fb018d25	485	#define RESET_FLAG(V) (V) = 0
9fb964de	486	#define COND_FLAG(V, F, C) ((C) ? (SET_FLAG(V, F)) : (UNSET_FLAG(V, F)))
718e3744	487
f765d422 QY	488	/* Atomic flag manipulation macros. */
	489	#define CHECK_FLAG_ATOMIC(PV, F) \
	490	((atomic_load_explicit(PV, memory_order_seq_cst)) & (F))
	491	#define SET_FLAG_ATOMIC(PV, F) \
	492	((atomic_fetch_or_explicit(PV, (F), memory_order_seq_cst)))
	493	#define UNSET_FLAG_ATOMIC(PV, F) \
	494	((atomic_fetch_and_explicit(PV, ~(F), memory_order_seq_cst)))
	495	#define RESET_FLAG_ATOMIC(PV) \
	496	((atomic_store_explicit(PV, 0, memory_order_seq_cst)))
	497
c1b9800a	498	/* Zebra types. Used in Zserv message header. */
d7c0a89a QY	499	typedef uint16_t zebra_size_t;
d7c0a89a QY	500	typedef uint16_t zebra_command_t;
718e3744	501
b72ede27	502	/* VRF ID type. */
a9ff90c4	503	typedef uint32_t vrf_id_t;
b72ede27	504
dc9ffce8 CF	505	typedef uint32_t route_tag_t;
	506	#define ROUTE_TAG_MAX UINT32_MAX
	507	#define ROUTE_TAG_PRI PRIu32
	508
d62a17ae	509	static inline afi_t afi_iana2int(iana_afi_t afi)
9cabb64b	510	{
085347cf RW	511	switch (afi) {
085347cf RW	512	case IANA_AFI_IPV4:
d62a17ae	513	return AFI_IP;
085347cf	514	case IANA_AFI_IPV6:
d62a17ae	515	return AFI_IP6;
085347cf	516	case IANA_AFI_L2VPN:
d62a17ae	517	return AFI_L2VPN;
085347cf RW	518	default:
	519	return AFI_MAX;
	520	}
9cabb64b	521	}
9cabb64b	522
d62a17ae	523	static inline iana_afi_t afi_int2iana(afi_t afi)
9cabb64b	524	{
085347cf RW	525	switch (afi) {
085347cf RW	526	case AFI_IP:
d62a17ae	527	return IANA_AFI_IPV4;
085347cf	528	case AFI_IP6:
d62a17ae	529	return IANA_AFI_IPV6;
085347cf	530	case AFI_L2VPN:
d62a17ae	531	return IANA_AFI_L2VPN;
085347cf RW	532	default:
	533	return IANA_AFI_RESERVED;
	534	}
9cabb64b	535	}
9cabb64b	536
5c525538	537	static inline safi_t safi_iana2int(iana_safi_t safi)
9cabb64b	538	{
085347cf RW	539	switch (safi) {
085347cf RW	540	case IANA_SAFI_UNICAST:
d62a17ae	541	return SAFI_UNICAST;
085347cf	542	case IANA_SAFI_MULTICAST:
d62a17ae	543	return SAFI_MULTICAST;
085347cf	544	case IANA_SAFI_MPLS_VPN:
d62a17ae	545	return SAFI_MPLS_VPN;
085347cf	546	case IANA_SAFI_ENCAP:
d62a17ae	547	return SAFI_ENCAP;
085347cf	548	case IANA_SAFI_EVPN:
d62a17ae	549	return SAFI_EVPN;
085347cf	550	case IANA_SAFI_LABELED_UNICAST:
d62a17ae	551	return SAFI_LABELED_UNICAST;
7c40bf39	552	case IANA_SAFI_FLOWSPEC:
7c40bf39	553	return SAFI_FLOWSPEC;
085347cf RW	554	default:
	555	return SAFI_MAX;
	556	}
9cabb64b	557	}
9cabb64b	558
5c525538	559	static inline iana_safi_t safi_int2iana(safi_t safi)
9cabb64b	560	{
085347cf RW	561	switch (safi) {
085347cf RW	562	case SAFI_UNICAST:
d62a17ae	563	return IANA_SAFI_UNICAST;
085347cf	564	case SAFI_MULTICAST:
d62a17ae	565	return IANA_SAFI_MULTICAST;
085347cf	566	case SAFI_MPLS_VPN:
d62a17ae	567	return IANA_SAFI_MPLS_VPN;
085347cf	568	case SAFI_ENCAP:
d62a17ae	569	return IANA_SAFI_ENCAP;
085347cf	570	case SAFI_EVPN:
d62a17ae	571	return IANA_SAFI_EVPN;
085347cf	572	case SAFI_LABELED_UNICAST:
d62a17ae	573	return IANA_SAFI_LABELED_UNICAST;
7c40bf39	574	case SAFI_FLOWSPEC:
7c40bf39	575	return IANA_SAFI_FLOWSPEC;
085347cf RW	576	default:
	577	return IANA_SAFI_RESERVED;
	578	}
9cabb64b	579	}
9cabb64b	580
718e3744	581	#endif /* _ZEBRA_H */