[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 GNU Zebra; see the file COPYING.  If not, write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.  */

#ifndef _ZEBRA_H
#define _ZEBRA_H

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

#ifdef SUNOS_5
#define _XPG4_2
typedef unsigned int    u_int32_t;
typedef unsigned short  u_int16_t;
typedef unsigned char   u_int8_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

#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"

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

#ifdef HAVE_BROKEN_CMSG_FIRSTHDR
/* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
   please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */

/* Check that msg_controllen is large enough. */
#define ZCMSG_FIRSTHDR(mhdr) \
  (((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
   CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)

#warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"

#else /* HAVE_BROKEN_CMSG_FIRSTHDR */
#define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
#endif /* HAVE_BROKEN_CMSG_FIRSTHDR */


/* 
 * 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 */

/* MAX / MIN are not commonly defined, but useful */
/* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
#ifdef MAX
#undef MAX
#endif
#define MAX(a, b) \
	({ typeof (a) _a = (a); \
	   typeof (b) _b = (b); \
	   _a > _b ? _a : _b; })
#ifdef MIN
#undef MIN
#endif
#define MIN(a, b) \
	({ typeof (a) _a = (a); \
	   typeof (b) _b = (b); \
	   _a < _b ? _a : _b; })

#define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))

/* 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

/* 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 */
#define ZEBRA_FLAG_INTERNAL           0x01
#define ZEBRA_FLAG_SELFROUTE          0x02
#define ZEBRA_FLAG_BLACKHOLE          0x04
#define ZEBRA_FLAG_IBGP               0x08
#define ZEBRA_FLAG_SELECTED           0x10
#define ZEBRA_FLAG_STATIC             0x40
#define ZEBRA_FLAG_REJECT             0x80
#define ZEBRA_FLAG_SCOPE_LINK         0x100
#define ZEBRA_FLAG_FIB_OVERRIDE       0x200

#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 = 4,
  AFI_MAX = 5
} afi_t;

/* Subsequent Address Family Identifier. */
#define SAFI_UNICAST              1
#define SAFI_MULTICAST            2
#define SAFI_MPLS_VPN             3
#define SAFI_RESERVED_4           4
#define SAFI_ENCAP		  5
#define SAFI_RESERVED_5           5
#define SAFI_EVPN                 6
#define SAFI_MAX                  7

#define IANA_SAFI_RESERVED            0
#define IANA_SAFI_UNICAST             1
#define IANA_SAFI_MULTICAST           2
#define IANA_SAFI_ENCAP               7
#define IANA_SAFI_MPLS_VPN            128

/*
 * 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;

#define IANA_SAFI_RESERVED            0
#define IANA_SAFI_UNICAST             1
#define IANA_SAFI_MULTICAST           2
#define IANA_SAFI_ENCAP               7
#define IANA_SAFI_EVPN                70
#define IANA_SAFI_MPLS_VPN            128

/* 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

typedef u_int8_t safi_t;

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

/* VRF ID type. */
typedef u_int16_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)
{
  if (afi == IANA_AFI_IPV4)
    return AFI_IP;
  if (afi == IANA_AFI_IPV6)
    return AFI_IP6;
  if (afi == IANA_AFI_L2VPN)
    return AFI_L2VPN;
  return AFI_MAX;
}

static inline iana_afi_t afi_int2iana (afi_t afi)
{
  if (afi == AFI_IP)
    return IANA_AFI_IPV4;
  if (afi == AFI_IP6)
    return IANA_AFI_IPV6;
  if (afi == AFI_L2VPN)
    return IANA_AFI_L2VPN;
  return IANA_AFI_RESERVED;
}

static inline safi_t safi_iana2int (safi_t safi)
{
  if (safi == IANA_SAFI_UNICAST)
    return SAFI_UNICAST;
  if (safi == IANA_SAFI_MULTICAST)
    return SAFI_MULTICAST;
  if (safi == IANA_SAFI_MPLS_VPN)
    return SAFI_MPLS_VPN;
  if (safi == IANA_SAFI_ENCAP)
    return SAFI_ENCAP;
  if (safi == IANA_SAFI_EVPN)
    return SAFI_EVPN;
  return SAFI_MAX;
}

static inline safi_t safi_int2iana (safi_t safi)
{
  if (safi == SAFI_UNICAST)
    return IANA_SAFI_UNICAST;
  if (safi == SAFI_MULTICAST)
    return IANA_SAFI_MULTICAST;
  if (safi == SAFI_MPLS_VPN)
    return IANA_SAFI_MPLS_VPN;
  if (safi == SAFI_ENCAP)
    return IANA_SAFI_ENCAP;
  if (safi == SAFI_EVPN)
    return IANA_SAFI_EVPN;
  return IANA_SAFI_RESERVED;
}

#endif /* _ZEBRA_H */
Commit	Line	Data
718e3744	1	/* Zebra common header.
	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
	17	along with GNU Zebra; see the file COPYING. If not, write to the Free
	18	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	19	02111-1307, USA. */
	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
	28	#ifdef SUNOS_5
	29	#define _XPG4_2
9bcdb638	30	typedef unsigned int u_int32_t;
	31	typedef unsigned short u_int16_t;
	32	typedef unsigned char u_int8_t;
718e3744	33	#endif /* SUNOS_5 */
	34
	35	#include <unistd.h>
	36	#include <stdio.h>
	37	#include <stdlib.h>
c423d413	38	#include <stddef.h>
718e3744	39	#include <ctype.h>
	40	#include <errno.h>
	41	#include <fcntl.h>
	42	#include <signal.h>
	43	#include <string.h>
edd7c245	44	#include <pwd.h>
edd7c245	45	#include <grp.h>
718e3744	46	#ifdef HAVE_STROPTS_H
	47	#include <stropts.h>
	48	#endif /* HAVE_STROPTS_H */
718e3744	49	#include <sys/select.h>
718e3744	50	#include <sys/stat.h>
718e3744	51	#include <sys/types.h>
	52	#include <sys/param.h>
	53	#ifdef HAVE_SYS_SYSCTL_H
0dc0b708 AS	54	#ifdef GNU_LINUX
	55	#include <linux/types.h>
	56	#endif
718e3744	57	#include <sys/sysctl.h>
	58	#endif /* HAVE_SYS_SYSCTL_H */
	59	#include <sys/ioctl.h>
	60	#ifdef HAVE_SYS_CONF_H
	61	#include <sys/conf.h>
	62	#endif /* HAVE_SYS_CONF_H */
	63	#ifdef HAVE_SYS_KSYM_H
	64	#include <sys/ksym.h>
	65	#endif /* HAVE_SYS_KSYM_H */
	66	#include <syslog.h>
24f5e2fc DL	67	#include <sys/time.h>
24f5e2fc DL	68	#include <time.h>
718e3744	69	#include <sys/uio.h>
718e3744	70	#include <sys/utsname.h>
718e3744	71	#include <sys/resource.h>
a58c25b6	72	#include <limits.h>
35cfc90c	73	#include <inttypes.h>
63a13864	74	#include <stdbool.h>
718e3744	75
	76	/* machine dependent includes */
	77	#ifdef SUNOS_5
718e3744	78	#include <strings.h>
	79	#endif /* SUNOS_5 */
	80
	81	/* machine dependent includes */
	82	#ifdef HAVE_LINUX_VERSION_H
	83	#include <linux/version.h>
	84	#endif /* HAVE_LINUX_VERSION_H */
	85
ba965c6c	86	#ifdef HAVE_ASM_TYPES_H
	87	#include <asm/types.h>
	88	#endif /* HAVE_ASM_TYPES_H */
	89
718e3744	90	/* misc include group */
718e3744	91	#include <stdarg.h>
4cf0d0df	92	#if !(defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
4cf0d0df	93	/* Not C99; do we need to define va_copy? */
e22f5516	94	#ifndef va_copy
e22f5516	95	#ifdef __va_copy
4cf0d0df	96	#define va_copy(DST,SRC) __va_copy(DST,SRC)
e22f5516	97	#else
	98	/* Now we are desperate; this should work on many typical platforms.
	99	But this is slightly dangerous, because the standard does not require
	100	va_copy to be a macro. */
	101	#define va_copy(DST,SRC) memcpy(&(DST), &(SRC), sizeof(va_list))
	102	#warning "Not C99 and no va_copy macro available, falling back to memcpy"
	103	#endif /* __va_copy */
	104	#endif /* !va_copy */
4cf0d0df	105	#endif /* !C99 */
db8eaac6	106
718e3744	107
ba3a0bc5	108	#ifdef HAVE_LCAPS
	109	#include <sys/capability.h>
	110	#include <sys/prctl.h>
	111	#endif /* HAVE_LCAPS */
	112
ceacedba	113	#ifdef HAVE_SOLARIS_CAPABILITIES
	114	#include <priv.h>
	115	#endif /* HAVE_SOLARIS_CAPABILITIES */
	116
718e3744	117	/* network include group */
	118
	119	#include <sys/socket.h>
	120
	121	#ifdef HAVE_SYS_SOCKIO_H
	122	#include <sys/sockio.h>
	123	#endif /* HAVE_SYS_SOCKIO_H */
	124
ea057677 HT	125	#ifdef __APPLE__
	126	#define __APPLE_USE_RFC_3542
	127	#endif
	128
718e3744	129	#include <netinet/in.h>
718e3744	130	#include <netinet/in_systm.h>
	131	#include <netinet/ip.h>
	132	#include <netinet/tcp.h>
	133
	134	#ifdef HAVE_NET_NETOPT_H
	135	#include <net/netopt.h>
	136	#endif /* HAVE_NET_NETOPT_H */
	137
	138	#include <net/if.h>
	139
	140	#ifdef HAVE_NET_IF_DL_H
	141	#include <net/if_dl.h>
	142	#endif /* HAVE_NET_IF_DL_H */
	143
	144	#ifdef HAVE_NET_IF_VAR_H
	145	#include <net/if_var.h>
	146	#endif /* HAVE_NET_IF_VAR_H */
	147
	148	#include <net/route.h>
	149
	150	#ifdef HAVE_NETLINK
	151	#include <linux/netlink.h>
	152	#include <linux/rtnetlink.h>
768a27ea	153	#include <linux/filter.h>
718e3744	154	#else
	155	#define RT_TABLE_MAIN 0
	156	#endif /* HAVE_NETLINK */
	157
718e3744	158	#include <netdb.h>
718e3744	159	#include <arpa/inet.h>
718e3744	160
	161	#ifdef HAVE_INET_ND_H
	162	#include <inet/nd.h>
	163	#endif /* HAVE_INET_ND_H */
	164
	165	#ifdef HAVE_NETINET_IN_VAR_H
	166	#include <netinet/in_var.h>
	167	#endif /* HAVE_NETINET_IN_VAR_H */
	168
726f9b2b	169	#ifdef HAVE_NETINET6_IN6_VAR_H
	170	#include <netinet6/in6_var.h>
	171	#endif /* HAVE_NETINET6_IN6_VAR_H */
	172
718e3744	173	#ifdef HAVE_NETINET_IN6_VAR_H
	174	#include <netinet/in6_var.h>
	175	#endif /* HAVE_NETINET_IN6_VAR_H */
	176
	177	#ifdef HAVE_NETINET6_IN_H
	178	#include <netinet6/in.h>
	179	#endif /* HAVE_NETINET6_IN_H */
	180
	181
	182	#ifdef HAVE_NETINET6_IP6_H
	183	#include <netinet6/ip6.h>
	184	#endif /* HAVE_NETINET6_IP6_H */
	185
718e3744	186	#include <netinet/icmp6.h>
718e3744	187
	188	#ifdef HAVE_NETINET6_ND6_H
	189	#include <netinet6/nd6.h>
	190	#endif /* HAVE_NETINET6_ND6_H */
	191
35cfc90c PJ	192	/* Some systems do not define UINT32_MAX, etc.. from inttypes.h
	193	* e.g. this makes life easier for FBSD 4.11 users.
	194	*/
	195	#ifndef INT8_MAX
	196	#define INT8_MAX (127)
	197	#endif
	198	#ifndef INT16_MAX
	199	#define INT16_MAX (32767)
	200	#endif
	201	#ifndef INT32_MAX
	202	#define INT32_MAX (2147483647)
	203	#endif
	204	#ifndef UINT8_MAX
	205	#define UINT8_MAX (255U)
	206	#endif
	207	#ifndef UINT16_MAX
	208	#define UINT16_MAX (65535U)
	209	#endif
3b424979	210	#ifndef UINT32_MAX
35cfc90c PJ	211	#define UINT32_MAX (4294967295U)
35cfc90c PJ	212	#endif
3b424979	213
fb2d1502	214	#ifdef HAVE_GLIBC_BACKTRACE
	215	#include <execinfo.h>
	216	#endif /* HAVE_GLIBC_BACKTRACE */
	217
db8eaac6	218	/* Local includes: */
	219	#if !(defined(__GNUC__) \|\| defined(VTYSH_EXTRACT_PL))
	220	#define __attribute__(x)
	221	#endif /* !__GNUC__ \|\| VTYSH_EXTRACT_PL */
	222
	223	#include "zassert.h"
	224
c5d9d3bb DL	225	#ifndef HAVE_STRLCAT
	226	size_t strlcat (char __restrict dest, const char __restrict src, size_t size);
	227	#endif
	228	#ifndef HAVE_STRLCPY
	229	size_t strlcpy (char __restrict dest, const char __restrict src, size_t size);
	230	#endif
db8eaac6	231
b99760ab	232	#ifdef HAVE_BROKEN_CMSG_FIRSTHDR
	233	/* This bug is present in Solaris 8 and pre-patch Solaris 9 <sys/socket.h>;
	234	please refer to http://bugzilla.quagga.net/show_bug.cgi?id=142 */
	235
	236	/* Check that msg_controllen is large enough. */
	237	#define ZCMSG_FIRSTHDR(mhdr) \
	238	(((size_t)((mhdr)->msg_controllen) >= sizeof(struct cmsghdr)) ? \
	239	CMSG_FIRSTHDR(mhdr) : (struct cmsghdr *)NULL)
	240
	241	#warning "CMSG_FIRSTHDR is broken on this platform, using a workaround"
	242
	243	#else /* HAVE_BROKEN_CMSG_FIRSTHDR */
	244	#define ZCMSG_FIRSTHDR(M) CMSG_FIRSTHDR(M)
	245	#endif /* HAVE_BROKEN_CMSG_FIRSTHDR */
	246
	247
	248
02ff83c5	249	/*
69e1325f	250	* RFC 3542 defines several macros for using struct cmsghdr.
	251	* Here, we define those that are not present
	252	*/
	253
	254	/*
	255	* Internal defines, for use only in this file.
	256	* These are likely wrong on other than ILP32 machines, so warn.
02ff83c5	257	*/
	258	#ifndef _CMSG_DATA_ALIGN
	259	#define _CMSG_DATA_ALIGN(n) (((n) + 3) & ~3)
	260	#endif /* _CMSG_DATA_ALIGN */
	261
	262	#ifndef _CMSG_HDR_ALIGN
	263	#define _CMSG_HDR_ALIGN(n) (((n) + 3) & ~3)
	264	#endif /* _CMSG_HDR_ALIGN */
	265
69e1325f	266	/*
	267	* CMSG_SPACE and CMSG_LEN are required in RFC3542, but were new in that
	268	* version.
	269	*/
02ff83c5	270	#ifndef CMSG_SPACE
	271	#define CMSG_SPACE(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + \
	272	_CMSG_HDR_ALIGN(l))
69e1325f	273	#warning "assuming 4-byte alignment for CMSG_SPACE"
02ff83c5	274	#endif /* CMSG_SPACE */
	275
	276
	277	#ifndef CMSG_LEN
	278	#define CMSG_LEN(l) (_CMSG_DATA_ALIGN(sizeof(struct cmsghdr)) + (l))
69e1325f	279	#warning "assuming 4-byte alignment for CMSG_LEN"
02ff83c5	280	#endif /* CMSG_LEN */
02ff83c5	281
69e1325f	282
718e3744	283	/* The definition of struct in_pktinfo is missing in old version of
718e3744	284	GLIBC 2.1 (Redhat 6.1). */
6f0e3f6e	285	#if defined (GNU_LINUX) && ! defined (HAVE_STRUCT_IN_PKTINFO)
718e3744	286	struct in_pktinfo
	287	{
	288	int ipi_ifindex;
	289	struct in_addr ipi_spec_dst;
	290	struct in_addr ipi_addr;
	291	};
	292	#endif
	293
9172ee0e	294	/*
	295	* IP_HDRINCL / struct ip byte order
	296	*
	297	* Linux: network byte order
	298	* *BSD: network, except for length and offset. (cf Stevens)
	299	* SunOS: nominally as per BSD. but bug: network order on LE.
	300	* OpenBSD: network byte order, apart from older versions which are as per
	301	* *BSD
	302	*/
618969ea OCL	303	#if defined(__NetBSD__) \
618969ea OCL	304	\|\| (defined(__FreeBSD__) && (__FreeBSD_version < 1100030)) \
9172ee0e	305	\|\| (defined(__OpenBSD__) && (OpenBSD < 200311)) \
3f0bfc9e	306	\|\| (defined(__APPLE__)) \
9172ee0e	307	\|\| (defined(SUNOS_5) && defined(WORDS_BIGENDIAN))
	308	#define HAVE_IP_HDRINCL_BSD_ORDER
	309	#endif
	310
34204aac	311	/* Define BYTE_ORDER, if not defined. Useful for compiler conditional
	312	* code, rather than preprocessor conditional.
	313	* Not all the world has this BSD define.
	314	*/
	315	#ifndef BYTE_ORDER
	316	#define BIG_ENDIAN 4321 /* least-significant byte first (vax, pc) */
	317	#define LITTLE_ENDIAN 1234 /* most-significant byte first (IBM, net) */
	318	#define PDP_ENDIAN 3412 /* LSB first in word, MSW first in long (pdp) */
	319
	320	#if defined(WORDS_BIGENDIAN)
	321	#define BYTE_ORDER BIG_ENDIAN
	322	#else /* !WORDS_BIGENDIAN */
	323	#define BYTE_ORDER LITTLE_ENDIAN
	324	#endif /* WORDS_BIGENDIAN */
	325
	326	#endif /* ndef BYTE_ORDER */
	327
efba6ce9	328	/* MAX / MIN are not commonly defined, but useful */
6b143a68 DL	329	/* note: glibc sys/param.h has #define MIN(a,b) (((a)<(b))?(a):(b)) */
	330	#ifdef MAX
	331	#undef MAX
	332	#endif
8a0bebfc DL	333	#define MAX(a, b) \
	334	({ typeof (a) _a = (a); \
	335	typeof (b) _b = (b); \
	336	_a > _b ? _a : _b; })
6b143a68 DL	337	#ifdef MIN
6b143a68 DL	338	#undef MIN
8a0bebfc	339	#endif
8a0bebfc DL	340	#define MIN(a, b) \
	341	({ typeof (a) _a = (a); \
	342	typeof (b) _b = (b); \
	343	_a < _b ? _a : _b; })
efba6ce9	344
0915bb0c AS	345	#define ZEBRA_NUM_OF(x) (sizeof (x) / sizeof (x[0]))
0915bb0c AS	346
718e3744	347	/* For old definition. */
	348	#ifndef IN6_ARE_ADDR_EQUAL
	349	#define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL
	350	#endif /* IN6_ARE_ADDR_EQUAL */
	351
8cc4198f	352	/* default zebra TCP port for zclient */
	353	#define ZEBRA_PORT 2600
	354
c1b9800a	355	/* Marker value used in new Zserv, in the byte location corresponding
	356	* the command value in the old zserv header. To allow old and new
	357	* Zserv headers to be distinguished from each other.
	358	*/
80e71dcd	359	#define ZEBRA_HEADER_MARKER 254
c1b9800a	360
e0ca5fde DL	361	/* Zebra route's types are defined in route_types.h */
e0ca5fde DL	362	#include "route_types.h"
718e3744	363
d6d672aa PJ	364	/* Note: whenever a new route-type or zserv-command is added the
	365	* corresponding {command,route}_types[] table in lib/log.c MUST be
	366	* updated! */
f52d13cb	367
f52d13cb	368	/* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
b6026073	369	extern const char *zebra_route_string(unsigned int route_type);
f52d13cb	370	/* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
b6026073	371	extern char zebra_route_char(unsigned int route_type);
d6d672aa PJ	372	/* Map a zserv command type to the same string,
d6d672aa PJ	373	* e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
7514fb77 PJ	374	/* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
7514fb77 PJ	375	extern int proto_name2num(const char *s);
e0ca5fde DL	376	/* Map redistribute X argument to protocol number.
	377	* unlike proto_name2num, this accepts shorthands and takes
	378	* an AFI value to restrict input */
	379	extern int proto_redistnum(int afi, const char *s);
7514fb77	380
d6d672aa	381	extern const char *zserv_command_string (unsigned int command);
f52d13cb	382
bf31fc81 DL	383	#define strmatch(a,b) (!strcmp((a), (b)))
bf31fc81 DL	384
718e3744	385	/* Zebra message flags */
	386	#define ZEBRA_FLAG_INTERNAL 0x01
	387	#define ZEBRA_FLAG_SELFROUTE 0x02
	388	#define ZEBRA_FLAG_BLACKHOLE 0x04
	389	#define ZEBRA_FLAG_IBGP 0x08
	390	#define ZEBRA_FLAG_SELECTED 0x10
718e3744	391	#define ZEBRA_FLAG_STATIC 0x40
81dfcaa2	392	#define ZEBRA_FLAG_REJECT 0x80
525c1839	393	#define ZEBRA_FLAG_SCOPE_LINK 0x100
446bb95e	394	#define ZEBRA_FLAG_FIB_OVERRIDE 0x200
718e3744	395
718e3744	396	#ifndef INADDR_LOOPBACK
	397	#define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */
	398	#endif
	399
	400	/* Address family numbers from RFC1700. */
e978e1de DS	401	typedef enum {
	402	AFI_IP = 1,
	403	AFI_IP6 = 2,
924bf71c PG	404	AFI_L2VPN = 4,
924bf71c PG	405	AFI_MAX = 5
e978e1de	406	} afi_t;
718e3744	407
	408	/* Subsequent Address Family Identifier. */
	409	#define SAFI_UNICAST 1
	410	#define SAFI_MULTICAST 2
db19215a	411	#define SAFI_MPLS_VPN 3
268fef65	412	#define SAFI_RESERVED_4 4
9cabb64b	413	#define SAFI_ENCAP 5
4d5b4f7b	414	#define SAFI_RESERVED_5 5
924bf71c PG	415	#define SAFI_EVPN 6
924bf71c PG	416	#define SAFI_MAX 7
9cabb64b	417
b58ed1f8 DS	418	#define IANA_SAFI_RESERVED 0
	419	#define IANA_SAFI_UNICAST 1
	420	#define IANA_SAFI_MULTICAST 2
	421	#define IANA_SAFI_ENCAP 7
	422	#define IANA_SAFI_MPLS_VPN 128
718e3744	423
90d82769 DS	424	/*
	425	* The above AFI and SAFI definitions are for internal use. The protocol
	426	* definitions (IANA values) as for example used in BGP protocol packets
	427	* are defined below and these will get mapped to/from the internal values
	428	* in the appropriate places.
	429	* The rationale is that the protocol (IANA) values may be sparse and are
	430	* not optimal for use in data-structure sizing.
	431	* Note: Only useful (i.e., supported) values are defined below.
	432	*/
	433	typedef enum {
	434	IANA_AFI_RESERVED = 0,
	435	IANA_AFI_IPV4 = 1,
	436	IANA_AFI_IPV6 = 2,
	437	IANA_AFI_L2VPN = 25,
	438	IANA_AFI_IPMR = 128,
	439	IANA_AFI_IP6MR = 129
	440	} iana_afi_t;
	441
9cabb64b	442	#define IANA_SAFI_RESERVED 0
	443	#define IANA_SAFI_UNICAST 1
	444	#define IANA_SAFI_MULTICAST 2
	445	#define IANA_SAFI_ENCAP 7
924bf71c	446	#define IANA_SAFI_EVPN 70
9cabb64b	447	#define IANA_SAFI_MPLS_VPN 128
718e3744	448
718e3744	449	/* Default Administrative Distance of each protocol. */
	450	#define ZEBRA_KERNEL_DISTANCE_DEFAULT 0
	451	#define ZEBRA_CONNECT_DISTANCE_DEFAULT 0
	452	#define ZEBRA_STATIC_DISTANCE_DEFAULT 1
	453	#define ZEBRA_RIP_DISTANCE_DEFAULT 120
	454	#define ZEBRA_RIPNG_DISTANCE_DEFAULT 120
	455	#define ZEBRA_OSPF_DISTANCE_DEFAULT 110
	456	#define ZEBRA_OSPF6_DISTANCE_DEFAULT 110
9e867fe6	457	#define ZEBRA_ISIS_DISTANCE_DEFAULT 115
718e3744	458	#define ZEBRA_IBGP_DISTANCE_DEFAULT 200
718e3744	459	#define ZEBRA_EBGP_DISTANCE_DEFAULT 20
7ab5795a	460	#define ZEBRA_TABLE_DISTANCE_DEFAULT 15
718e3744	461
	462	/* Flag manipulation macros. */
	463	#define CHECK_FLAG(V,F) ((V) & (F))
548e6f7d	464	#define SET_FLAG(V,F) (V) \|= (F)
548e6f7d	465	#define UNSET_FLAG(V,F) (V) &= ~(F)
fb018d25	466	#define RESET_FLAG(V) (V) = 0
718e3744	467
5228ad27	468	typedef u_int8_t safi_t;
718e3744	469
c1b9800a	470	/* Zebra types. Used in Zserv message header. */
718e3744	471	typedef u_int16_t zebra_size_t;
c1b9800a	472	typedef u_int16_t zebra_command_t;
718e3744	473
b72ede27 FL	474	/* VRF ID type. */
	475	typedef u_int16_t vrf_id_t;
	476
dc9ffce8 CF	477	typedef uint32_t route_tag_t;
	478	#define ROUTE_TAG_MAX UINT32_MAX
	479	#define ROUTE_TAG_PRI PRIu32
	480
b58ed1f8	481	static inline afi_t afi_iana2int (iana_afi_t afi)
9cabb64b	482	{
	483	if (afi == IANA_AFI_IPV4)
	484	return AFI_IP;
	485	if (afi == IANA_AFI_IPV6)
	486	return AFI_IP6;
924bf71c PG	487	if (afi == IANA_AFI_L2VPN)
924bf71c PG	488	return AFI_L2VPN;
9cabb64b	489	return AFI_MAX;
	490	}
	491
b58ed1f8	492	static inline iana_afi_t afi_int2iana (afi_t afi)
9cabb64b	493	{
	494	if (afi == AFI_IP)
	495	return IANA_AFI_IPV4;
	496	if (afi == AFI_IP6)
	497	return IANA_AFI_IPV6;
924bf71c PG	498	if (afi == AFI_L2VPN)
924bf71c PG	499	return IANA_AFI_L2VPN;
9cabb64b	500	return IANA_AFI_RESERVED;
	501	}
	502
	503	static inline safi_t safi_iana2int (safi_t safi)
	504	{
	505	if (safi == IANA_SAFI_UNICAST)
	506	return SAFI_UNICAST;
	507	if (safi == IANA_SAFI_MULTICAST)
	508	return SAFI_MULTICAST;
	509	if (safi == IANA_SAFI_MPLS_VPN)
	510	return SAFI_MPLS_VPN;
	511	if (safi == IANA_SAFI_ENCAP)
	512	return SAFI_ENCAP;
924bf71c PG	513	if (safi == IANA_SAFI_EVPN)
924bf71c PG	514	return SAFI_EVPN;
9cabb64b	515	return SAFI_MAX;
	516	}
	517
	518	static inline safi_t safi_int2iana (safi_t safi)
	519	{
	520	if (safi == SAFI_UNICAST)
	521	return IANA_SAFI_UNICAST;
	522	if (safi == SAFI_MULTICAST)
	523	return IANA_SAFI_MULTICAST;
	524	if (safi == SAFI_MPLS_VPN)
	525	return IANA_SAFI_MPLS_VPN;
	526	if (safi == SAFI_ENCAP)
	527	return IANA_SAFI_ENCAP;
924bf71c PG	528	if (safi == SAFI_EVPN)
924bf71c PG	529	return IANA_SAFI_EVPN;
9cabb64b	530	return IANA_SAFI_RESERVED;
	531	}
	532
718e3744	533	#endif /* _ZEBRA_H */