/* 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 #define __EXTENSIONS__ typedef unsigned int u_int32_t; typedef unsigned short u_int16_t; typedef unsigned char u_int8_t; #endif /* SUNOS_5 */ #ifndef HAVE_SOCKLEN_T typedef int socklen_t; #endif /* HAVE_SOCKLEN_T */ #include #include #include #include #include #include #include #include #include #include #include #ifdef HAVE_STROPTS_H #include #endif /* HAVE_STROPTS_H */ #ifdef HAVE_SYS_SELECT_H #include #endif /* HAVE_SYS_SELECT_H */ #include #include #include #ifdef HAVE_SYS_SYSCTL_H #ifdef GNU_LINUX #include #endif #include #endif /* HAVE_SYS_SYSCTL_H */ #include #ifdef HAVE_SYS_CONF_H #include #endif /* HAVE_SYS_CONF_H */ #ifdef HAVE_SYS_KSYM_H #include #endif /* HAVE_SYS_KSYM_H */ #include #ifdef TIME_WITH_SYS_TIME # include # include #else # ifdef HAVE_SYS_TIME_H # include # else # include # endif #endif /* TIME_WITH_SYS_TIME */ #include #include #ifdef HAVE_RUSAGE #include #endif /* HAVE_RUSAGE */ #ifdef HAVE_LIMITS_H #include #endif /* HAVE_LIMITS_H */ #ifdef HAVE_INTTYPES_H #include #endif /* HAVE_INTTYPES_H */ /* machine dependent includes */ #ifdef SUNOS_5 #include #endif /* SUNOS_5 */ /* machine dependent includes */ #ifdef HAVE_LINUX_VERSION_H #include #endif /* HAVE_LINUX_VERSION_H */ #ifdef HAVE_ASM_TYPES_H #include #endif /* HAVE_ASM_TYPES_H */ /* misc include group */ #include #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 #include #endif /* HAVE_LCAPS */ #ifdef HAVE_SOLARIS_CAPABILITIES #include #endif /* HAVE_SOLARIS_CAPABILITIES */ /* network include group */ #include #ifdef HAVE_SYS_SOCKIO_H #include #endif /* HAVE_SYS_SOCKIO_H */ #ifdef __APPLE__ #define __APPLE_USE_RFC_3542 #endif #ifdef HAVE_NETINET_IN_H #include #endif /* HAVE_NETINET_IN_H */ #include #include #include #ifdef HAVE_NET_NETOPT_H #include #endif /* HAVE_NET_NETOPT_H */ #include #ifdef HAVE_NET_IF_DL_H #include #endif /* HAVE_NET_IF_DL_H */ #ifdef HAVE_NET_IF_VAR_H #include #endif /* HAVE_NET_IF_VAR_H */ #ifdef HAVE_NET_ROUTE_H #include #endif /* HAVE_NET_ROUTE_H */ #ifdef HAVE_NETLINK #include #include #include #else #define RT_TABLE_MAIN 0 #endif /* HAVE_NETLINK */ #ifdef HAVE_NETDB_H #include #endif /* HAVE_NETDB_H */ #include #ifdef HAVE_INET_ND_H #include #endif /* HAVE_INET_ND_H */ #ifdef HAVE_NETINET_IN_VAR_H #include #endif /* HAVE_NETINET_IN_VAR_H */ #ifdef HAVE_NETINET6_IN6_VAR_H #include #endif /* HAVE_NETINET6_IN6_VAR_H */ #ifdef HAVE_NETINET_IN6_VAR_H #include #endif /* HAVE_NETINET_IN6_VAR_H */ #ifdef HAVE_NETINET6_IN_H #include #endif /* HAVE_NETINET6_IN_H */ #ifdef HAVE_NETINET6_IP6_H #include #endif /* HAVE_NETINET6_IP6_H */ #ifdef HAVE_NETINET_ICMP6_H #include #endif /* HAVE_NETINET_ICMP6_H */ #ifdef HAVE_NETINET6_ND6_H #include #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 #endif /* HAVE_GLIBC_BACKTRACE */ #ifdef BSDI_NRL #ifdef HAVE_NETINET6_IN6_H #include #endif /* HAVE_NETINET6_IN6_H */ #ifdef NRL #include #endif /* NRL */ #define IN6_ARE_ADDR_EQUAL IN6_IS_ADDR_EQUAL #endif /* BSDI_NRL */ /* Local includes: */ #if !(defined(__GNUC__) || defined(VTYSH_EXTRACT_PL)) #define __attribute__(x) #endif /* !__GNUC__ || VTYSH_EXTRACT_PL */ #include "zassert.h" #include "str.h" #ifdef HAVE_BROKEN_CMSG_FIRSTHDR /* This bug is present in Solaris 8 and pre-patch Solaris 9 ; 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 /* * OSPF Fragmentation / fragmented writes * * ospfd can support writing fragmented packets, for cases where * kernel will not fragment IP_HDRINCL and/or multicast destined * packets (ie TTBOMK all kernels, BSD, SunOS, Linux). However, * SunOS, probably BSD too, clobber the user supplied IP ID and IP * flags fields, hence user-space fragmentation will not work. * Only Linux is known to leave IP header unmolested. * Further, fragmentation really should be done the kernel, which already * supports it, and which avoids nasty IP ID state problems. * * Fragmentation of OSPF packets can be required on networks with router * with many many interfaces active in one area, or on networks with links * with low MTUs. */ #ifdef GNU_LINUX #define WANT_OSPF_WRITE_FRAGMENT #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__) \ || (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 */ #ifndef MAX #define MAX(a, b) ((a) > (b) ? (a) : (b)) #endif #ifndef MIN #define MIN(a, b) ((a) < (b) ? (a) : (b)) #endif #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 /* Zebra message types. */ #define ZEBRA_INTERFACE_ADD 1 #define ZEBRA_INTERFACE_DELETE 2 #define ZEBRA_INTERFACE_ADDRESS_ADD 3 #define ZEBRA_INTERFACE_ADDRESS_DELETE 4 #define ZEBRA_INTERFACE_UP 5 #define ZEBRA_INTERFACE_DOWN 6 #define ZEBRA_IPV4_ROUTE_ADD 7 #define ZEBRA_IPV4_ROUTE_DELETE 8 #define ZEBRA_IPV6_ROUTE_ADD 9 #define ZEBRA_IPV6_ROUTE_DELETE 10 #define ZEBRA_REDISTRIBUTE_ADD 11 #define ZEBRA_REDISTRIBUTE_DELETE 12 #define ZEBRA_REDISTRIBUTE_DEFAULT_ADD 13 #define ZEBRA_REDISTRIBUTE_DEFAULT_DELETE 14 #define ZEBRA_IPV4_NEXTHOP_LOOKUP 15 #define ZEBRA_IPV6_NEXTHOP_LOOKUP 16 #define ZEBRA_IPV4_IMPORT_LOOKUP 17 #define ZEBRA_IPV6_IMPORT_LOOKUP 18 #define ZEBRA_INTERFACE_RENAME 19 #define ZEBRA_ROUTER_ID_ADD 20 #define ZEBRA_ROUTER_ID_DELETE 21 #define ZEBRA_ROUTER_ID_UPDATE 22 #define ZEBRA_HELLO 23 #define ZEBRA_NEXTHOP_REGISTER 24 #define ZEBRA_NEXTHOP_UNREGISTER 25 #define ZEBRA_NEXTHOP_UPDATE 26 #define ZEBRA_INTERFACE_NBR_ADDRESS_ADD 27 #define ZEBRA_INTERFACE_NBR_ADDRESS_DELETE 28 #define ZEBRA_INTERFACE_BFD_DEST_DOWN 29 #define ZEBRA_MESSAGE_MAX 30 /* 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 255 /* 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); /* Zebra's family types. */ #define ZEBRA_FAMILY_IPV4 1 #define ZEBRA_FAMILY_IPV6 2 #define ZEBRA_FAMILY_MAX 3 /* Error codes of zebra. */ #define ZEBRA_ERR_NOERROR 0 #define ZEBRA_ERR_RTEXIST -1 #define ZEBRA_ERR_RTUNREACH -2 #define ZEBRA_ERR_EPERM -3 #define ZEBRA_ERR_RTNOEXIST -4 #define ZEBRA_ERR_KERNEL -5 /* 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_CHANGED 0x20 #define ZEBRA_FLAG_STATIC 0x40 #define ZEBRA_FLAG_REJECT 0x80 /* Zebra nexthop flags. */ #define ZEBRA_NEXTHOP_IFINDEX 1 #define ZEBRA_NEXTHOP_IFNAME 2 #define ZEBRA_NEXTHOP_IPV4 3 #define ZEBRA_NEXTHOP_IPV4_IFINDEX 4 #define ZEBRA_NEXTHOP_IPV4_IFNAME 5 #define ZEBRA_NEXTHOP_IPV6 6 #define ZEBRA_NEXTHOP_IPV6_IFINDEX 7 #define ZEBRA_NEXTHOP_IPV6_IFNAME 8 #define ZEBRA_NEXTHOP_BLACKHOLE 9 #ifndef INADDR_LOOPBACK #define INADDR_LOOPBACK 0x7f000001 /* Internet address 127.0.0.1. */ #endif /* Address family numbers from RFC1700. */ #define AFI_IP 1 #define AFI_IP6 2 #define AFI_MAX 3 /* Subsequent Address Family Identifier. */ #define SAFI_UNICAST 1 #define SAFI_MULTICAST 2 #define SAFI_RESERVED_3 3 #define SAFI_MPLS_VPN 4 #define SAFI_MAX 5 /* Filter direction. */ #define FILTER_IN 0 #define FILTER_OUT 1 #define FILTER_MAX 2 /* 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 /* 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 /* AFI and SAFI type. */ typedef u_int16_t afi_t; 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; /* FIFO -- first in first out structure and macros. */ struct fifo { struct fifo *next; struct fifo *prev; }; #define FIFO_INIT(F) \ do { \ struct fifo *Xfifo = (struct fifo *)(F); \ Xfifo->next = Xfifo->prev = Xfifo; \ } while (0) #define FIFO_ADD(F,N) \ do { \ struct fifo *Xfifo = (struct fifo *)(F); \ struct fifo *Xnode = (struct fifo *)(N); \ Xnode->next = Xfifo; \ Xnode->prev = Xfifo->prev; \ Xfifo->prev = Xfifo->prev->next = Xnode; \ } while (0) #define FIFO_DEL(N) \ do { \ struct fifo *Xnode = (struct fifo *)(N); \ Xnode->prev->next = Xnode->next; \ Xnode->next->prev = Xnode->prev; \ } while (0) #define FIFO_HEAD(F) \ ((((struct fifo *)(F))->next == (struct fifo *)(F)) \ ? NULL : (F)->next) #define FIFO_EMPTY(F) \ (((struct fifo *)(F))->next == (struct fifo *)(F)) #define FIFO_TOP(F) \ (FIFO_EMPTY(F) ? NULL : ((struct fifo *)(F))->next) #endif /* _ZEBRA_H */