syshead.h

Go to the documentation of this file.

/*
 *  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.
 *
 *  Copyright (C) 2002-2025 OpenVPN Inc <sales@openvpn.net>
 *
 *  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; if not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef SYSHEAD_H
#define SYSHEAD_H
 
#include "compat.h"
#include <stdbool.h>
 
/* 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
 
#ifdef _WIN32
#include <windows.h>
#include <winsock2.h>
#include <tlhelp32.h>
#define sleep(x) Sleep((x) * 1000)
#define random   rand
#define srandom  srand
#endif
 
/* if inttypes.h is included this breaks rc.exe when using the ClangCL
 * Toolchain as it pulls in a inttypes.h variant for clang that rc.exe does
 * not understand (#include_next preprocessor directive) */
#if defined(_WIN32) && !defined(RC_INVOKED)
#include <inttypes.h>
typedef uint32_t in_addr_t;
typedef uint16_t in_port_t;
 
#define SIGHUP  1
#define SIGINT  2
#define SIGUSR1 10
#define SIGUSR2 12
#define SIGTERM 15
#endif
 
#if defined(_MSC_VER) && !defined(RC_INVOKED)
#include <BaseTsd.h>
typedef SSIZE_T ssize_t;
#define strncasecmp strnicmp
#define strcasecmp  _stricmp
 
#define S_IRUSR _S_IREAD
#define S_IWUSR _S_IWRITE
#define R_OK    4
#define W_OK    2
#define X_OK    1
#define F_OK    0
#endif
 
#if defined(_MSC_VER) && !defined(__clang__) /* Microsoft compiler */
#define __func__ __FUNCTION__
#define __attribute__(x)
#endif
 
#if defined(__APPLE__)
#if __ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 1070
#define __APPLE_USE_RFC_3542 1
#endif
#endif
 
#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 HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
 
#include <time.h>
 
#ifdef HAVE_SYS_SOCKET_H
#include <sys/socket.h>
#endif
 
#ifdef HAVE_SYS_UN_H
#include <sys/un.h>
#endif
 
#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
 
/* These headers belong to C99 and should be always be present */
#include <stdlib.h>
#include <inttypes.h>
#include <stdint.h>
#include <stdarg.h>
#include <signal.h>
#include <limits.h>
#include <stdio.h>
#include <ctype.h>
#include <errno.h>
 
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
 
#ifdef HAVE_ERR_H
#include <err.h>
#endif
 
#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 HAVE_NETDB_H
#include <netdb.h>
#endif
 
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
 
#ifdef HAVE_RESOLV_H
#include <resolv.h>
#endif
 
#ifdef HAVE_POLL_H
#include <poll.h>
#endif
 
#ifdef ENABLE_SELINUX
#include <selinux/selinux.h>
#endif
 
#if defined(HAVE_LIBGEN_H)
#include <libgen.h>
#endif
 
#ifdef TARGET_SOLARIS
#ifdef HAVE_STRINGS_H
#include <strings.h>
#endif
#else
#include <string.h>
#endif
 
#if defined(TARGET_HAIKU)
#include <SupportDefs.h> /* uint32, etc */
#include <net/if.h>      /* ifconf etc */
#include <sys/sockio.h>  /* SIOCGRTTABLE, etc */
#endif                   /* TARGET_HAIKU */
 
#ifdef HAVE_ARPA_INET_H
#include <arpa/inet.h>
#endif
 
#ifdef HAVE_NET_IF_H
#include <net/if.h>
#endif
 
#ifdef TARGET_NETBSD
#include <net/if_tap.h>
#endif
 
#if defined(TARGET_LINUX) || defined(TARGET_ANDROID)
 
#define EXTENDED_SOCKET_ERROR_CAPABILITY 1
 
#ifdef TARGET_LINUX
#define ENABLE_FEATURE_TUN_PERSIST
#endif
 
#include <linux/if_tun.h>
#include <linux/sockios.h>
 
#ifdef HAVE_NETINET_IP_H
#include <netinet/ip.h>
#endif
 
#ifdef HAVE_NETINET_TCP_H
#include <netinet/tcp.h>
#endif
 
#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_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_IP_H
#include <netinet/ip.h>
#endif
 
#ifdef HAVE_NETINET_TCP_H
#include <netinet/tcp.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_IP_H
#include <netinet/ip.h>
#endif
 
#ifdef HAVE_NETINET_TCP_H
#include <netinet/tcp.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>
#endif
 
#ifdef HAVE_NETINET_TCP_H
#include <netinet/tcp.h>
#endif
 
#endif /* TARGET_NETBSD */
 
#ifdef TARGET_DRAGONFLY
 
#ifdef HAVE_SYS_UIO_H
#include <sys/uio.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 */
 
#ifdef TARGET_DARWIN
 
#ifdef HAVE_NETINET_TCP_H
#include <netinet/tcp.h>
#endif
 
#endif /* TARGET_DARWIN */
 
#ifdef _WIN32
/* Missing declarations for MinGW 32. */
#if defined(__MINGW32__)
typedef int MIB_TCP_STATE;
#endif
#include <naptypes.h>
#include <ntddndis.h>
#include <iphlpapi.h>
#include <wininet.h>
#include <shellapi.h>
#include <io.h>
 
/* The following two headers are needed of PF_INET6 */
#include <winsock2.h>
#include <ws2tcpip.h>
#endif
 
#ifdef HAVE_SYS_MMAN_H
#ifdef TARGET_DARWIN
#define _P1003_1B_VISIBLE
#endif /* TARGET_DARWIN */
#include <sys/mman.h>
#endif
 
#ifndef _WIN32
#include <sys/utsname.h>
#endif
 
/*
 * Pedantic mode is meant to accomplish lint-style program checking,
 * not to build a working executable.
 */
#ifdef PEDANTIC
#undef HAVE_CPP_VARARG_MACRO_GCC
#undef HAVE_CPP_VARARG_MACRO_ISO
#undef inline
#define inline
#endif
 
/*
 * Do we have the capability to support the --passtos option?
 */
#if defined(IPPROTO_IP) && defined(IP_TOS)
#define PASSTOS_CAPABILITY 1
#else
#define PASSTOS_CAPABILITY 0
#endif
 
/*
 * Does this platform support linux-style IP_PKTINFO
 * or bsd-style IP_RECVDSTADDR ?
 */
#if ((defined(HAVE_IN_PKTINFO) && defined(IP_PKTINFO)) || defined(IP_RECVDSTADDR)) \
    && defined(HAVE_MSGHDR) && defined(HAVE_CMSGHDR) && defined(CMSG_FIRSTHDR)     \
    && defined(CMSG_NXTHDR) && defined(HAVE_RECVMSG) && defined(HAVE_SENDMSG)
#define ENABLE_IP_PKTINFO 1
#else
#define ENABLE_IP_PKTINFO 0
#endif
 
/*
 * Does this platform define SOL_IP
 * or only bsd-style IPPROTO_IP ?
 */
#ifndef SOL_IP
#define SOL_IP IPPROTO_IP
#endif
 
/*
 * Define type sa_family_t if it isn't defined in the socket headers
 */
#ifndef HAVE_SA_FAMILY_T
typedef unsigned short sa_family_t;
#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 PATH_SEPARATOR     '\\'
#define PATH_SEPARATOR_STR "\\"
#else
#define PATH_SEPARATOR     '/'
#define PATH_SEPARATOR_STR "/"
#endif
 
/*
 * Our socket descriptor type.
 */
#ifdef _WIN32
#define SOCKET_UNDEFINED (INVALID_SOCKET)
#define SOCKET_PRINTF    "%" PRIxPTR
typedef SOCKET socket_descriptor_t;
#else
#define SOCKET_UNDEFINED (-1)
#define SOCKET_PRINTF    "%d"
typedef int socket_descriptor_t;
#endif
 
static inline int
socket_defined(const socket_descriptor_t sd)
{
    return sd != SOCKET_UNDEFINED;
}
 
/*
 * Should we enable the use of execve() for calling subprocesses,
 * instead of system()?
 */
#if defined(HAVE_EXECVE) && defined(HAVE_FORK)
#define ENABLE_FEATURE_EXECVE
#endif
 
/*
 * HTTPS port sharing capability
 */
#if defined(ENABLE_PORT_SHARE) && defined(SCM_RIGHTS) && defined(HAVE_MSGHDR)  \
    && defined(HAVE_CMSGHDR) && defined(CMSG_FIRSTHDR) && defined(CMSG_NXTHDR) \
    && defined(HAVE_RECVMSG) && defined(HAVE_SENDMSG)
#define PORT_SHARE 1
#else
#define PORT_SHARE 0
#endif
 
#ifdef ENABLE_CRYPTO_MBEDTLS
#define ENABLE_PREDICTION_RESISTANCE
#endif /* ENABLE_CRYPTO_MBEDTLS */
 
/*
 * Do we support Unix domain sockets?
 */
#if defined(PF_UNIX) && !defined(_WIN32)
#define UNIX_SOCK_SUPPORT 1
#else
#define UNIX_SOCK_SUPPORT 0
#endif
 
/*
 * Should we include NTLM proxy functionality
 */
#ifdef ENABLE_NTLM
#define NTLM 1
#endif
 
/*
 * Should we include proxy digest auth functionality
 */
#define PROXY_DIGEST_AUTH 1
 
/*
 * Do we have CryptoAPI capability?
 */
#if defined(_WIN32) && defined(ENABLE_CRYPTO_OPENSSL) && !defined(ENABLE_CRYPTO_WOLFSSL)
#define ENABLE_CRYPTOAPI
#endif
 
/*
 * Is poll available on this platform?
 * (Note: on win32 select is faster than poll and we avoid
 * using poll there)
 */
#if defined(HAVE_POLL_H) || !defined(_WIN32)
#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
 
/*
 * Compression support
 */
#if defined(ENABLE_LZO) || defined(ENABLE_LZ4) || defined(ENABLE_COMP_STUB)
#define USE_COMP
#endif
 
#ifdef _MSC_VER
#ifndef PATH_MAX
#define PATH_MAX MAX_PATH
#endif
#endif
 
#endif /* ifndef SYSHEAD_H */