syshead.h
6fbf66fa
 /*
  *  OpenVPN -- An application to securely tunnel IP networks
  *             over a single UDP port, with support for SSL/TLS-based
  *             session authentication and key exchange,
  *             packet encryption, packet authentication, and
  *             packet compression.
  *
564a2109
  *  Copyright (C) 2002-2010 OpenVPN Technologies, Inc. <sales@openvpn.net>
6fbf66fa
  *
  *  This program is free software; you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License version 2
  *  as published by the Free Software Foundation.
  *
  *  This program 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 included with this
  *  distribution); if not, write to the Free Software Foundation, Inc.,
  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #ifndef SYSHEAD_H
 #define SYSHEAD_H
 
1bda73a7
 /*
  * Only include if not during configure
  */
 #ifndef PACKAGE_NAME
 #ifdef _MSC_VER
 #include "config-win32.h"
 #else
 #include "config.h"
 #endif
 #endif
 
5d89a362
 /* branch prediction hints */
 #if defined(__GNUC__)
 # define likely(x)       __builtin_expect((x),1)
 # define unlikely(x)     __builtin_expect((x),0)
 #else
 # define likely(x)      (x)
 # define unlikely(x)    (x)
 #endif
 
1bda73a7
 #if defined(_WIN32) && !defined(WIN32)
 #define WIN32
 #endif
 
 #ifdef WIN32
 #include <windows.h>
 #define sleep(x) Sleep((x)*1000)
 #define random rand
 #define srandom srand
 #endif
 
6fbf66fa
 #ifdef HAVE_SYS_TYPES_H
 #include <sys/types.h>
 #endif
 
 #ifdef HAVE_SYS_WAIT_H
 # include <sys/wait.h>
 #endif
 
 #ifndef WIN32
 #ifndef WEXITSTATUS
 # define WEXITSTATUS(stat_val) ((unsigned)(stat_val) >> 8)
 #endif
 #ifndef WIFEXITED
 # define WIFEXITED(stat_val) (((stat_val) & 255) == 0)
 #endif
 #endif
 
 #ifdef TIME_WITH_SYS_TIME
 # include <sys/time.h>
 # include <time.h>
 #else
 # ifdef HAVE_SYS_TIME_H
 #  include <sys/time.h>
 # else
 #  include <time.h>
 # endif
 #endif
 
 #ifdef HAVE_SYS_SOCKET_H
48045ace
 # if defined(TARGET_LINUX) && !defined(_GNU_SOURCE)
    /* needed for peercred support on glibc-2.8 */
 #  define _GNU_SOURCE
 # endif
6fbf66fa
 #include <sys/socket.h>
 #endif
 
bb564a59
 #ifdef HAVE_SYS_UN_H
 #include <sys/un.h>
 #endif
 
6fbf66fa
 #ifdef HAVE_SYS_IOCTL_H
 #include <sys/ioctl.h>
 #endif
 
 #ifdef HAVE_SYS_STAT_H
 #include <sys/stat.h>
 #endif
 
 #ifdef HAVE_FCNTL_H
 #include <fcntl.h>
 #endif
 
 #ifdef HAVE_SYS_FILE_H
 #include <sys/file.h>
 #endif
 
 #ifdef HAVE_STDLIB_H
 #include <stdlib.h>
 #endif
 
 #ifdef HAVE_STDINT_H
 #include <stdint.h>
 #endif
 
 #ifdef HAVE_STDARG_H
 #include <stdarg.h>
 #endif
 
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 
 #ifdef HAVE_SIGNAL_H
 #include <signal.h>
 #endif
 
 #ifdef HAVE_STDIO_H
 #include <stdio.h>
 #endif
 
 #ifdef HAVE_CTYPE_H
 #include <ctype.h>
 #endif
 
 #ifdef HAVE_ERRNO_H
 #include <errno.h>
 #endif
 
dcc0b244
 #ifdef HAVE_ERR_H
 #include <err.h>
 #endif
 
6fbf66fa
 #ifdef HAVE_SYSLOG_H
 #include <syslog.h>
 #endif
 
 #ifdef HAVE_PWD_H
 #include <pwd.h>
 #endif
 
 #ifdef HAVE_GRP_H
 #include <grp.h>
 #endif
 
 #ifdef USE_LIBDL
 #include <dlfcn.h>
 #endif
 
 #ifdef HAVE_NETDB_H
 #include <netdb.h>
 #endif
 
 #ifdef HAVE_NETINET_IN_H
 #include <netinet/in.h>
 #endif
 
1bda73a7
 #ifdef HAVE_RESOLV_H
 #include <resolv.h>
 #endif
 
6fbf66fa
 #ifdef HAVE_SYS_POLL_H
 #include <sys/poll.h>
 #endif
 
 #ifdef HAVE_SYS_EPOLL_H
 #include <sys/epoll.h>
 #endif
 
99385447
 #ifdef HAVE_SETCON
 #include <selinux/selinux.h>
 #endif
 
6fbf66fa
 #ifdef TARGET_SOLARIS
 #ifdef HAVE_STRINGS_H
 #include <strings.h>
 #endif
 #else
 #ifdef HAVE_STRING_H
 #include <string.h>
 #endif
 #endif
 
 #ifdef HAVE_ARPA_INET_H
 #include <arpa/inet.h>
 #endif
 
 #ifdef HAVE_NET_IF_H
 #include <net/if.h>
 #endif
 
 #ifdef TARGET_LINUX
 
 #if defined(HAVE_NETINET_IF_ETHER_H)
 #include <netinet/if_ether.h>
 #endif
 
 #ifdef HAVE_LINUX_IF_TUN_H
 #include <linux/if_tun.h>
 #endif
 
 #ifdef HAVE_NETINET_IP_H
 #include <netinet/ip.h>
 #endif
 
 #ifdef HAVE_LINUX_SOCKIOS_H
 #include <linux/sockios.h>
 #endif
 
 #ifdef HAVE_LINUX_TYPES_H
 #include <linux/types.h>
 #endif
 
 #ifdef HAVE_LINUX_ERRQUEUE_H
 #include <linux/errqueue.h>
 #endif
 
00d39170
 #ifdef HAVE_NETINET_TCP_H
 #include <netinet/tcp.h>
 #endif
 
6fbf66fa
 #endif /* TARGET_LINUX */
 
 #ifdef TARGET_SOLARIS
 
 #ifdef HAVE_STROPTS_H
 #include <stropts.h>
 #undef S_ERROR
 #endif
 
 #ifdef HAVE_NET_IF_TUN_H
 #include <net/if_tun.h>
 #endif
 
 #ifdef HAVE_SYS_SOCKIO_H
 #include <sys/sockio.h>
 #endif
 
 #ifdef HAVE_NETINET_IN_SYSTM_H
 #include <netinet/in_systm.h>
 #endif
 
 #ifdef HAVE_NETINET_IP_H
 #include <netinet/ip.h>
 #endif
 
 #ifdef HAVE_NETINET_TCP_H
 #include <netinet/tcp.h>
 #endif
 
 #endif /* TARGET_SOLARIS */
 
 #ifdef TARGET_OPENBSD
 
 #ifdef HAVE_SYS_UIO_H
 #include <sys/uio.h>
 #endif
 
 #ifdef HAVE_NETINET_IN_SYSTM_H
 #include <netinet/in_systm.h>
 #endif
 
 #ifdef HAVE_NETINET_IP_H
 #include <netinet/ip.h>
 #endif
 
 #ifdef HAVE_NET_IF_TUN_H
 #include <net/if_tun.h>
 #endif
 
 #endif /* TARGET_OPENBSD */
 
 #ifdef TARGET_FREEBSD
 
 #ifdef HAVE_SYS_UIO_H
 #include <sys/uio.h>
 #endif
 
 #ifdef HAVE_NETINET_IN_SYSTM_H
 #include <netinet/in_systm.h>
 #endif
 
 #ifdef HAVE_NETINET_IP_H
 #include <netinet/ip.h>
 #endif
 
 #ifdef HAVE_NET_IF_TUN_H
 #include <net/if_tun.h>
 #endif
 
 #endif /* TARGET_FREEBSD */
 
 #ifdef TARGET_NETBSD
 
 #ifdef HAVE_NET_IF_TUN_H
 #include <net/if_tun.h>
6c29814b
 #endif
 
 #ifdef HAVE_NETINET_TCP_H
 #include <netinet/tcp.h>
6fbf66fa
 #endif
 
 #endif /* TARGET_NETBSD */
 
1bda73a7
 #ifdef TARGET_DRAGONFLY
 
 #ifdef HAVE_SYS_UIO_H
 #include <sys/uio.h>
 #endif
 
 #ifdef HAVE_NETINET_IN_SYSTM_H
 #include <netinet/in_systm.h>
 #endif
 
 #ifdef HAVE_NETINET_IP_H
 #include <netinet/ip.h>
 #endif
 
 #ifdef HAVE_NET_TUN_IF_TUN_H
 #include <net/tun/if_tun.h>
 #endif
 
 #endif /* TARGET_DRAGONFLY */
 
6fbf66fa
 #ifdef WIN32
 #include <iphlpapi.h>
1bda73a7
 #include <wininet.h>
6fbf66fa
 #endif
 
 #ifdef HAVE_SYS_MMAN_H
 #ifdef TARGET_DARWIN
 #define _P1003_1B_VISIBLE
 #endif /* TARGET_DARWIN */
 #include <sys/mman.h>
 #endif
 
 /*
  * Pedantic mode is meant to accomplish lint-style program checking,
  * not to build a working executable.
  */
 #ifdef __STRICT_ANSI__
 # define PEDANTIC 1
 # undef HAVE_CPP_VARARG_MACRO_GCC
 # undef HAVE_CPP_VARARG_MACRO_ISO
 # undef EMPTY_ARRAY_SIZE
 # define EMPTY_ARRAY_SIZE 1
 # undef inline
 # define inline
 #else
 # define PEDANTIC 0
 #endif
 
 /*
  * Do we have the capability to support the --passtos option?
  */
 #if defined(IPPROTO_IP) && defined(IP_TOS) && defined(HAVE_SETSOCKOPT)
 #define PASSTOS_CAPABILITY 1
 #else
 #define PASSTOS_CAPABILITY 0
 #endif
 
 /*
  * Do we have the capability to report extended socket errors?
  */
 #if defined(HAVE_LINUX_TYPES_H) && defined(HAVE_LINUX_ERRQUEUE_H) && defined(HAVE_SOCK_EXTENDED_ERR) && defined(HAVE_MSGHDR) && defined(HAVE_CMSGHDR) && defined(CMSG_FIRSTHDR) && defined(CMSG_NXTHDR) && defined(IP_RECVERR) && defined(MSG_ERRQUEUE) && defined(SOL_IP) && defined(HAVE_IOVEC)
 #define EXTENDED_SOCKET_ERROR_CAPABILITY 1
 #else
 #define EXTENDED_SOCKET_ERROR_CAPABILITY 0
 #endif
 
 /*
8bc93d7f
  * Does this platform support linux-style IP_PKTINFO?
  */
 #if defined(ENABLE_MULTIHOME) && defined(HAVE_IN_PKTINFO) && defined(IP_PKTINFO) && defined(HAVE_MSGHDR) && defined(HAVE_CMSGHDR) && defined(HAVE_IOVEC) && defined(CMSG_FIRSTHDR) && defined(CMSG_NXTHDR) && defined(HAVE_RECVMSG) && defined(HAVE_SENDMSG)
 #define ENABLE_IP_PKTINFO 1
 #else
 #define ENABLE_IP_PKTINFO 0
 #endif
 
 /*
6fbf66fa
  * Disable ESEC
  */
 #if 0
 #undef EXTENDED_SOCKET_ERROR_CAPABILITY
 #define EXTENDED_SOCKET_ERROR_CAPABILITY 0
 #endif
 
 /*
  * Do we have a syslog capability?
  */
 #if defined(HAVE_OPENLOG) && defined(HAVE_SYSLOG)
 #define SYSLOG_CAPABILITY 1
 #else
 #define SYSLOG_CAPABILITY 0
 #endif
 
 /*
  * Does this OS draw a distinction between binary and ascii files?
  */
 #ifndef O_BINARY
 #define O_BINARY 0
 #endif
 
 /*
  * Directory separation char
  */
 #ifdef WIN32
 #define OS_SPECIFIC_DIRSEP '\\'
 #else
 #define OS_SPECIFIC_DIRSEP '/'
 #endif
 
 /*
  * Define a boolean value based
  * on Win32 status.
  */
 #ifdef WIN32
 #define WIN32_0_1 1
 #else
 #define WIN32_0_1 0
 #endif
 
 /*
  * Our socket descriptor type.
  */
 #ifdef WIN32
 #define SOCKET_UNDEFINED (INVALID_SOCKET)
 typedef SOCKET socket_descriptor_t;
 #else
 #define SOCKET_UNDEFINED (-1)
 typedef int socket_descriptor_t;
 #endif
 
 static inline int
 socket_defined (const socket_descriptor_t sd)
 {
   return sd != SOCKET_UNDEFINED;
 }
 
 /*
b9baa4d9
  * Should statistics counters be 64 bits?
  */
 #define USE_64_BIT_COUNTERS
 
 /*
5a2e9a25
  * Should we enable the use of execve() for calling subprocesses,
  * instead of system()?
  */
 #if defined(HAVE_EXECVE) && defined(HAVE_FORK)
 #define ENABLE_EXECVE
 #endif
 
 /*
6fbf66fa
  * Do we have point-to-multipoint capability?
  */
 
 #if defined(ENABLE_CLIENT_SERVER) && defined(USE_CRYPTO) && defined(USE_SSL) && defined(HAVE_GETTIMEOFDAY)
 #define P2MP 1
 #else
 #define P2MP 0
 #endif
 
 #if P2MP && !defined(ENABLE_CLIENT_ONLY)
 #define P2MP_SERVER 1
 #else
 #define P2MP_SERVER 0
 #endif
 
 /*
6add6b2f
  * HTTPS port sharing capability
  */
 #if defined(ENABLE_PORT_SHARE) && P2MP_SERVER && defined(SCM_RIGHTS) && defined(HAVE_MSGHDR) && defined(HAVE_CMSGHDR) && defined(HAVE_IOVEC) && defined(CMSG_FIRSTHDR) && defined(CMSG_NXTHDR) && defined(HAVE_RECVMSG) && defined(HAVE_SENDMSG)
 #define PORT_SHARE 1
 #else
 #define PORT_SHARE 0
 #endif
 
 /*
6fbf66fa
  * Do we have a plug-in capability?
  */
 #if defined(USE_LIBDL) || defined(USE_LOAD_LIBRARY)
 #define ENABLE_PLUGIN
 #endif
 
 /*
90efcacb
  * Enable deferred authentication?
47ae8457
  */
5acd2baf
 #if defined(CONFIGURE_DEF_AUTH) && P2MP_SERVER && defined(ENABLE_PLUGIN)
90efcacb
 #define PLUGIN_DEF_AUTH
 #endif
5acd2baf
 #if defined(CONFIGURE_DEF_AUTH) && P2MP_SERVER && defined(ENABLE_MANAGEMENT)
90efcacb
 #define MANAGEMENT_DEF_AUTH
 #endif
 #if defined(PLUGIN_DEF_AUTH) || defined(MANAGEMENT_DEF_AUTH)
47ae8457
 #define ENABLE_DEF_AUTH
 #endif
 
 /*
90efcacb
  * Enable packet filter?
47ae8457
  */
5acd2baf
 #if defined(CONFIGURE_PF) && P2MP_SERVER && defined(ENABLE_PLUGIN) && defined(HAVE_STAT)
90efcacb
 #define PLUGIN_PF
 #endif
5acd2baf
 #if defined(CONFIGURE_PF) && P2MP_SERVER && defined(MANAGEMENT_DEF_AUTH)
90efcacb
 #define MANAGEMENT_PF
 #endif
 #if defined(PLUGIN_PF) || defined(MANAGEMENT_PF)
47ae8457
 #define ENABLE_PF
 #endif
 
 /*
bb564a59
  * Do we support Unix domain sockets?
  */
 #if defined(PF_UNIX) && !defined(WIN32)
 #define UNIX_SOCK_SUPPORT 1
 #else
 #define UNIX_SOCK_SUPPORT 0
 #endif
 
 /*
dc85dae6
  * Compile the struct buffer_list code
90efcacb
  */
 #define ENABLE_BUFFER_LIST
 
 /*
6fbf66fa
  * Do we have pthread capability?
  */
 #ifdef USE_PTHREAD
 #if defined(USE_CRYPTO) && defined(USE_SSL) && P2MP
 #include <pthread.h>
 #else
 #undef USE_PTHREAD
 #endif
 #endif
 
 /*
  * Pthread support is currently experimental (and quite unfinished).
  */
 #if 1 /* JYFIXME -- if defined, disable pthread */
 #undef USE_PTHREAD
 #endif
 
 /*
  * Should we include OCC (options consistency check) code?
  */
 #ifndef ENABLE_SMALL
 #define ENABLE_OCC
 #endif
 
 /*
  * Should we include NTLM proxy functionality
  */
df5722cc
 #if defined(USE_CRYPTO) && defined(ENABLE_HTTP_PROXY)
6fbf66fa
 #define NTLM 1
 #else
 #define NTLM 0
 #endif
 
 /*
b27dc04c
  * Should we include proxy digest auth functionality
  */
 #if defined(USE_CRYPTO) && defined(ENABLE_HTTP_PROXY)
 #define PROXY_DIGEST_AUTH 1
 #else
 #define PROXY_DIGEST_AUTH 0
 #endif
 
 /*
f214bb21
  * Should we include code common to all proxy methods?
  */
 #if defined(ENABLE_HTTP_PROXY) || defined(ENABLE_SOCKS)
 #define GENERAL_PROXY_SUPPORT
 #endif
 
 /*
be38c051
  * Do we have PKCS11 capability?
  */
 #if defined(USE_PKCS11) && defined(USE_CRYPTO) && defined(USE_SSL)
 #define ENABLE_PKCS11
 #endif
 
 /*
6fbf66fa
  * Is poll available on this platform?
  */
 #if defined(HAVE_POLL) && defined(HAVE_SYS_POLL_H)
 #define POLL 1
 #else
 #define POLL 0
 #endif
 
 /*
  * Is epoll available on this platform?
  */
 #if defined(HAVE_EPOLL_CREATE) && defined(HAVE_SYS_EPOLL_H)
 #define EPOLL 1
 #else
 #define EPOLL 0
 #endif
 
 /* Disable EPOLL */
 #if 0
 #undef EPOLL
 #define EPOLL 0
 #endif
 
d40f2b20
 /*
  * Should we allow ca/cert/key files to be
  * included inline, in the configuration file?
  */
 #define ENABLE_INLINE_FILES 1
 
0475d17e
 /*
3cf6c932
  * Support "connection" directive
  */
 #if ENABLE_INLINE_FILES
 #define ENABLE_CONNECTION 1
 #endif
 
 /*
  * Should we include http proxy fallback functionality
  */
 #if defined(ENABLE_CONNECTION) && defined(ENABLE_MANAGEMENT) && defined(ENABLE_HTTP_PROXY)
 #define HTTP_PROXY_FALLBACK 1
 #else
 #define HTTP_PROXY_FALLBACK 0
 #endif
 
 /*
0475d17e
  * Reduce sensitivity to system clock instability
  * and backtracks.
  */
e5239fc2
 #define TIME_BACKTRACK_PROTECTION 1
0475d17e
 
1ae9d051
 /*
  * Is non-blocking connect() supported?
  */
 #if defined(HAVE_GETSOCKOPT) && defined(SOL_SOCKET) && defined(SO_ERROR) && defined(EINPROGRESS) && defined(ETIMEDOUT)
 #define CONNECT_NONBLOCK
 #endif
 
5f31881e
 /*
  * Do we have the capability to support the AUTO_USERID feature? 
  */
 #if defined(ENABLE_AUTO_USERID)
 #define AUTO_USERID 1
 #else
 #define AUTO_USERID 0
 #endif
 
4e9a51d7
 /*
aaf72974
  * Do we support pushing peer info?
4e9a51d7
  */
aaf72974
 #define ENABLE_PUSH_PEER_INFO
4e9a51d7
 
6fbf66fa
 #endif