blob: 34d1b35c591097a21423076269074d41ec2f3d7c [file] [log] [blame]
Willy Tarreaubaaee002006-06-26 02:48:02 +02001/*
Willy Tarreau17f449b2010-11-07 11:44:13 +01002 * include/common/compat.h
3 * Operating system compatibility interface.
4 *
5 * Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
Willy Tarreaubaaee002006-06-26 02:48:02 +020021
Willy Tarreau2dd0d472006-06-29 17:53:05 +020022#ifndef _COMMON_COMPAT_H
23#define _COMMON_COMPAT_H
Willy Tarreaubaaee002006-06-26 02:48:02 +020024
Joris Dedieu9dd44ba2015-06-13 01:05:11 +020025#include <limits.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020026/* This is needed on Linux for Netfilter includes */
Willy Tarreau17f449b2010-11-07 11:44:13 +010027#include <sys/param.h>
Willy Tarreauc8f24f82007-11-30 18:38:35 +010028#include <sys/types.h>
Willy Tarreau0e996c62010-02-26 22:00:19 +010029#include <sys/socket.h>
Willy Tarreau17f449b2010-11-07 11:44:13 +010030#include <arpa/inet.h>
Joris Dedieu9dd44ba2015-06-13 01:05:11 +020031#include <netinet/in.h>
Willy Tarreau9d87ca02016-08-10 21:09:24 +020032#include <netinet/tcp.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +020033
Willy Tarreaue3e2b722019-05-20 19:10:52 +020034// Redefine some limits that are not present everywhere
35#ifndef LLONG_MAX
36# define LLONG_MAX 9223372036854775807LL
37# define LLONG_MIN (-LLONG_MAX - 1LL)
38#endif
39
40#ifndef ULLONG_MAX
41# define ULLONG_MAX (LLONG_MAX * 2ULL + 1)
42#endif
43
44#ifndef LONGBITS
45#define LONGBITS ((unsigned int)sizeof(long) * 8)
46#endif
47
Willy Tarreau177e2b02008-07-15 00:36:31 +020048#ifndef BITS_PER_INT
49#define BITS_PER_INT (8*sizeof(int))
50#endif
Willy Tarreaubaaee002006-06-26 02:48:02 +020051
52/* this is for libc5 for example */
53#ifndef TCP_NODELAY
54#define TCP_NODELAY 1
55#endif
56
57#ifndef SHUT_RD
58#define SHUT_RD 0
59#endif
60
61#ifndef SHUT_WR
62#define SHUT_WR 1
63#endif
64
Willy Tarreaud6d06902009-08-19 11:22:33 +020065/* only Linux defines it */
66#ifndef MSG_NOSIGNAL
67#define MSG_NOSIGNAL 0
68#endif
69
Willy Tarreauc8f24f82007-11-30 18:38:35 +010070/* AIX does not define MSG_DONTWAIT. We'll define it to zero, and test it
71 * wherever appropriate.
72 */
73#ifndef MSG_DONTWAIT
74#define MSG_DONTWAIT 0
75#endif
76
Willy Tarreau6db06d32009-08-19 11:14:11 +020077/* Only Linux defines MSG_MORE */
78#ifndef MSG_MORE
79#define MSG_MORE 0
80#endif
81
Willy Tarreau2b57cb82013-06-10 19:56:38 +020082/* On Linux 2.4 and above, MSG_TRUNC can be used on TCP sockets to drop any
83 * pending data. Let's rely on NETFILTER to detect if this is supported.
84 */
85#ifdef NETFILTER
86#define MSG_TRUNC_CLEARS_INPUT
87#endif
88
Willy Tarreau17f449b2010-11-07 11:44:13 +010089/* Maximum path length, OS-dependant */
90#ifndef MAXPATHLEN
91#define MAXPATHLEN 128
92#endif
93
Willy Tarreaubd9a0a72011-10-23 21:14:29 +020094/* On Linux, allows pipes to be resized */
95#ifndef F_SETPIPE_SZ
96#define F_SETPIPE_SZ (1024 + 7)
97#endif
98
Willy Tarreaubaaee002006-06-26 02:48:02 +020099#if defined(TPROXY) && defined(NETFILTER)
Jeremy Hinegardnere7dd2f22008-04-21 07:34:31 +0200100#include <linux/types.h>
101#include <linux/netfilter_ipv6.h>
Willy Tarreaubaaee002006-06-26 02:48:02 +0200102#include <linux/netfilter_ipv4.h>
103#endif
104
Willy Tarreau0a459892008-01-13 17:37:16 +0100105/* On Linux, IP_TRANSPARENT and/or IP_FREEBIND generally require a kernel patch */
Willy Tarreaub1e52e82008-01-13 14:49:51 +0100106#if defined(CONFIG_HAP_LINUX_TPROXY)
Willy Tarreau0a459892008-01-13 17:37:16 +0100107#if !defined(IP_FREEBIND)
108#define IP_FREEBIND 15
109#endif /* !IP_FREEBIND */
Willy Tarreaub1e52e82008-01-13 14:49:51 +0100110#if !defined(IP_TRANSPARENT)
111#define IP_TRANSPARENT 19
112#endif /* !IP_TRANSPARENT */
David du Colombier65c17962012-07-13 14:34:59 +0200113#if !defined(IPV6_TRANSPARENT)
114#define IPV6_TRANSPARENT 75
115#endif /* !IPV6_TRANSPARENT */
Willy Tarreaub1e52e82008-01-13 14:49:51 +0100116#endif /* CONFIG_HAP_LINUX_TPROXY */
117
Pieter Baauwd551fb52013-05-08 22:49:23 +0200118#if defined(IP_FREEBIND) \
Pieter Baauwff30b662013-05-08 23:22:39 +0200119 || defined(IP_BINDANY) \
120 || defined(IPV6_BINDANY) \
Pieter Baauw1eb75922013-05-08 23:30:23 +0200121 || defined(SO_BINDANY) \
Pieter Baauwd551fb52013-05-08 22:49:23 +0200122 || defined(IP_TRANSPARENT) \
123 || defined(IPV6_TRANSPARENT)
124#define CONFIG_HAP_TRANSPARENT
125#endif
126
Willy Tarreau58b2f832006-11-13 01:22:38 +0100127/* We'll try to enable SO_REUSEPORT on Linux 2.4 and 2.6 if not defined.
128 * There are two families of values depending on the architecture. Those
129 * are at least valid on Linux 2.4 and 2.6, reason why we'll rely on the
130 * NETFILTER define.
131 */
132#if !defined(SO_REUSEPORT) && defined(NETFILTER)
133#if (SO_REUSEADDR == 2)
134#define SO_REUSEPORT 15
135#elif (SO_REUSEADDR == 0x0004)
136#define SO_REUSEPORT 0x0200
137#endif /* SO_REUSEADDR */
138#endif /* SO_REUSEPORT */
139
Lukas Tribus0999f762013-04-02 16:43:24 +0200140/* only Linux defines TCP_FASTOPEN */
141#ifdef USE_TFO
142#ifndef TCP_FASTOPEN
143#define TCP_FASTOPEN 23
144#endif
Willy Tarreau034c88c2017-01-23 23:36:45 +0100145
146#ifndef TCP_FASTOPEN_CONNECT
147#define TCP_FASTOPEN_CONNECT 30
148#endif
Lukas Tribus0999f762013-04-02 16:43:24 +0200149#endif
150
Willy Tarreauae459f32015-09-29 18:19:32 +0200151/* FreeBSD doesn't define SOL_IP and prefers IPPROTO_IP */
152#ifndef SOL_IP
153#define SOL_IP IPPROTO_IP
154#endif
155
Willy Tarreau9d87ca02016-08-10 21:09:24 +0200156/* same for SOL_TCP */
157#ifndef SOL_TCP
158#define SOL_TCP IPPROTO_TCP
159#endif
160
Lukas Tribus67db8df2013-06-23 17:37:13 +0200161/* If IPv6 is supported, define IN6_IS_ADDR_V4MAPPED() if missing. */
162#if defined(IPV6_TCLASS) && !defined(IN6_IS_ADDR_V4MAPPED)
163#define IN6_IS_ADDR_V4MAPPED(a) \
164((((const uint32_t *) (a))[0] == 0) \
165&& (((const uint32_t *) (a))[1] == 0) \
166&& (((const uint32_t *) (a))[2] == htonl (0xffff)))
167#endif
168
Willy Tarreaubaaee002006-06-26 02:48:02 +0200169#if defined(__dietlibc__)
170#include <strings.h>
171#endif
172
Willy Tarreau4698adf2018-10-29 19:14:14 +0100173/* crypt_r() has been present in glibc since 2.2 and on FreeBSD since 12.0
174 * (12000002). No other OS makes any mention of it for now. Feel free to add
175 * valid known combinations below if needed to relax the crypt() lock when
176 * using threads.
177 */
178#if (defined(__GNU_LIBRARY__) && (__GLIBC__ > 2 || __GLIBC__ == 2 && __GLIBC_MINOR__ >= 2)) \
179 || (defined(__FreeBSD__) && __FreeBSD_version >= 1200002)
180#define HA_HAVE_CRYPT_R
181#endif
182
Willy Tarreau2dd0d472006-06-29 17:53:05 +0200183#endif /* _COMMON_COMPAT_H */
Willy Tarreaubaaee002006-06-26 02:48:02 +0200184
185/*
186 * Local variables:
187 * c-indent-level: 8
188 * c-basic-offset: 8
189 * End:
190 */