RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
haproxy/include/common/compat.h

152 lines
3.8 KiB
C
Raw Normal View History

[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
/*
[MINOR] move MAXPATHLEN definition to compat.h MAXPATHLEN may be used at other places, it's unconvenient to have it redefined in a few files. Also, since checking it requires including sys/param.h, some versions of it cause a macro declaration conflict with MIN/MAX which are defined in tools.h. The solution consists in including sys/param.h in both files so that we ensure it's loaded before the macros are defined and MAXPATHLEN is checked.
2010-11-07 10:44:13 +00:00
* include/common/compat.h
* Operating system compatibility interface.
*
* Copyright (C) 2000-2010 Willy Tarreau - w@1wt.eu
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, version 2.1
* exclusively.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
[CLEANUP] renamed include/haproxy to include/common
2006-06-29 15:53:05 +00:00
#ifndef _COMMON_COMPAT_H
#define _COMMON_COMPAT_H
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
/* This is needed on Linux for Netfilter includes */
[MINOR] move MAXPATHLEN definition to compat.h MAXPATHLEN may be used at other places, it's unconvenient to have it redefined in a few files. Also, since checking it requires including sys/param.h, some versions of it cause a macro declaration conflict with MIN/MAX which are defined in tools.h. The solution consists in including sys/param.h in both files so that we ensure it's loaded before the macros are defined and MAXPATHLEN is checked.
2010-11-07 10:44:13 +00:00
#include <sys/param.h>
[BUILD] fix 2 minor issues on AIX AIX does not know about MSG_DONTWAIT. Fortunately, nearly all sockets are already set to O_NONBLOCK, so it's not even required to change the code. It was only necessary to add this fcntl to the log socket which lacked it. The MSG_DONTWAIT value has been defined to zero when unset in order to make the code cleaner and more portable. Also, on AIX, "hz" is defined, which causes a problem with one function parameter in time.c. It's enough to rename the parameter there. Last, fix a missing #include <string.h> in proxy.c.
2007-11-30 17:38:35 +00:00
#include <sys/types.h>
[BUILD] includes order breaks OpenBSD build Jeff Buchbinder reported that OpenBSD build broke on compat.h, and that this patch fixes the issue.
2010-02-26 21:00:19 +00:00
#include <sys/socket.h>
[MINOR] move MAXPATHLEN definition to compat.h MAXPATHLEN may be used at other places, it's unconvenient to have it redefined in a few files. Also, since checking it requires including sys/param.h, some versions of it cause a macro declaration conflict with MIN/MAX which are defined in tools.h. The solution consists in including sys/param.h in both files so that we ensure it's loaded before the macros are defined and MAXPATHLEN is checked.
2010-11-07 10:44:13 +00:00
#include <arpa/inet.h>
[CLEANUP] included common/version.h everywhere
2006-06-29 16:54:54 +00:00
#include <common/config.h>
[BUILD] fix build with gcc 4.3 For Fedora 9 gcc 4.3 will be shipping as a feature, and right now haproxy does not compile with gcc 4.3. It appears that there is a reordering of headers or something along those lines, This is the patch that gets haproxy to compile with gcc 4.3. I'm not sure if this is the correct approach you would want to use, so please correct me. If this works for you, I'll go ahead and put this patch in the src rpm until a release of haproxy which compiles with gcc 4.3 is released.
2008-04-21 05:34:31 +00:00
#include <common/standard.h>
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
[CLEANUP] remove dependency on obsolete INTBITS macro The INTBITS macro was found to be already defined on some platforms, and to equal 32 (while INTBITS was 5 here). Due to pure luck, there was no declaration conflict, but it's nonetheless a problem to fix. Looking at the code showed that this macro was only used for left shifts and nothing else anymore. So the replacement is obvious. The new macro, BITS_PER_INT is more obviously correct.
2008-07-14 22:36:31 +00:00
#ifndef BITS_PER_INT
#define BITS_PER_INT (8*sizeof(int))
#endif
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
/* this is for libc5 for example */
#ifndef TCP_NODELAY
#define TCP_NODELAY 1
#endif
#ifndef SHUT_RD
#define SHUT_RD 0
#endif
#ifndef SHUT_WR
#define SHUT_WR 1
#endif
[CLEANUP] remove ifdef MSG_NOSIGNAL and define it instead ifdefs are really annoying in the code. Define MSG_NOSIGNAL to zero when undefined and remove associated ifdefs.
2009-08-19 09:22:33 +00:00
/* only Linux defines it */
#ifndef MSG_NOSIGNAL
#define MSG_NOSIGNAL 0
#endif
[BUILD] fix 2 minor issues on AIX AIX does not know about MSG_DONTWAIT. Fortunately, nearly all sockets are already set to O_NONBLOCK, so it's not even required to change the code. It was only necessary to add this fcntl to the log socket which lacked it. The MSG_DONTWAIT value has been defined to zero when unset in order to make the code cleaner and more portable. Also, on AIX, "hz" is defined, which causes a problem with one function parameter in time.c. It's enough to rename the parameter there. Last, fix a missing #include <string.h> in proxy.c.
2007-11-30 17:38:35 +00:00
/* AIX does not define MSG_DONTWAIT. We'll define it to zero, and test it
* wherever appropriate.
*/
#ifndef MSG_DONTWAIT
#define MSG_DONTWAIT 0
#endif
[MEDIUM] remove TCP_CORK and make use of MSG_MORE instead send() supports the MSG_MORE flag on Linux, which does the same as TCP_CORK except that we don't have to remove TCP_NODELAY before and we don't need any syscall to set/remove it. This can save up to 4 syscalls around a send() (two for setting it, two for removing it), and it's much cleaner since it is not persistent. So make use of it instead.
2009-08-19 09:14:11 +00:00
/* Only Linux defines MSG_MORE */
#ifndef MSG_MORE
#define MSG_MORE 0
#endif
MEDIUM: protocol: implement a "drain" function in protocol layers Since commit cfd97c6f was merged into 1.5-dev14 (BUG/MEDIUM: checks: prevent TIME_WAITs from appearing also on timeouts), some valid health checks sometimes used to show some TCP resets. For example, this HTTP health check sent to a local server : 19:55:15.742818 IP 127.0.0.1.16568 > 127.0.0.1.8000: S 3355859679:3355859679(0) win 32792 <mss 16396,nop,nop,sackOK,nop,wscale 7> 19:55:15.742841 IP 127.0.0.1.8000 > 127.0.0.1.16568: S 1060952566:1060952566(0) ack 3355859680 win 32792 <mss 16396,nop,nop,sackOK,nop,wscale 7> 19:55:15.742863 IP 127.0.0.1.16568 > 127.0.0.1.8000: . ack 1 win 257 19:55:15.745402 IP 127.0.0.1.16568 > 127.0.0.1.8000: P 1:23(22) ack 1 win 257 19:55:15.745488 IP 127.0.0.1.8000 > 127.0.0.1.16568: FP 1:146(145) ack 23 win 257 19:55:15.747109 IP 127.0.0.1.16568 > 127.0.0.1.8000: R 23:23(0) ack 147 win 257 After some discussion with Chris Huang-Leaver, it appeared clear that what we want is to only send the RST when we have no other choice, which means when the server has not closed. So we still keep SYN/SYN-ACK/RST for pure TCP checks, but don't want to see an RST emitted as above when the server has already sent the FIN. The solution against this consists in implementing a "drain" function at the protocol layer, which, when defined, causes as much as possible of the input socket buffer to be flushed to make recv() return zero so that we know that the server's FIN was received and ACKed. On Linux, we can make use of MSG_TRUNC on TCP sockets, which has the benefit of draining everything at once without even copying data. On other platforms, we read up to one buffer of data before the close. If recv() manages to get the final zero, we don't disable lingering. Same for hard errors. Otherwise we do. In practice, on HTTP health checks we generally find that the close was pending and is returned upon first recv() call. The network trace becomes cleaner : 19:55:23.650621 IP 127.0.0.1.16561 > 127.0.0.1.8000: S 3982804816:3982804816(0) win 32792 <mss 16396,nop,nop,sackOK,nop,wscale 7> 19:55:23.650644 IP 127.0.0.1.8000 > 127.0.0.1.16561: S 4082139313:4082139313(0) ack 3982804817 win 32792 <mss 16396,nop,nop,sackOK,nop,wscale 7> 19:55:23.650666 IP 127.0.0.1.16561 > 127.0.0.1.8000: . ack 1 win 257 19:55:23.651615 IP 127.0.0.1.16561 > 127.0.0.1.8000: P 1:23(22) ack 1 win 257 19:55:23.651696 IP 127.0.0.1.8000 > 127.0.0.1.16561: FP 1:146(145) ack 23 win 257 19:55:23.652628 IP 127.0.0.1.16561 > 127.0.0.1.8000: F 23:23(0) ack 147 win 257 19:55:23.652655 IP 127.0.0.1.8000 > 127.0.0.1.16561: . ack 24 win 257 This change should be backported to 1.4 which is where Chris encountered this issue. The code is different, so probably the tcp_drain() function will have to be put in the checks only.
2013-06-10 17:56:38 +00:00
/* On Linux 2.4 and above, MSG_TRUNC can be used on TCP sockets to drop any
* pending data. Let's rely on NETFILTER to detect if this is supported.
*/
#ifdef NETFILTER
#define MSG_TRUNC_CLEARS_INPUT
#endif
[MINOR] move MAXPATHLEN definition to compat.h MAXPATHLEN may be used at other places, it's unconvenient to have it redefined in a few files. Also, since checking it requires including sys/param.h, some versions of it cause a macro declaration conflict with MIN/MAX which are defined in tools.h. The solution consists in including sys/param.h in both files so that we ensure it's loaded before the macros are defined and MAXPATHLEN is checked.
2010-11-07 10:44:13 +00:00
/* Maximum path length, OS-dependant */
#ifndef MAXPATHLEN
#define MAXPATHLEN 128
#endif
OPTIM/MINOR: make it possible to change pipe size (tune.pipesize) By default, pipes are the default size for the system. But sometimes when using TCP splicing, it can improve performance to increase pipe sizes, especially if it is suspected that pipes are not filled and that many calls to splice() are performed. This has an impact on the kernel's memory footprint, so this must not be changed if impacts are not understood.
2011-10-23 19:14:29 +00:00
/* On Linux, allows pipes to be resized */
#ifndef F_SETPIPE_SZ
#define F_SETPIPE_SZ (1024 + 7)
#endif
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
#if defined(TPROXY) && defined(NETFILTER)
[BUILD] fix build with gcc 4.3 For Fedora 9 gcc 4.3 will be shipping as a feature, and right now haproxy does not compile with gcc 4.3. It appears that there is a reordering of headers or something along those lines, This is the patch that gets haproxy to compile with gcc 4.3. I'm not sure if this is the correct approach you would want to use, so please correct me. If this works for you, I'll go ahead and put this patch in the src rpm until a release of haproxy which compiles with gcc 4.3 is released.
2008-04-21 05:34:31 +00:00
#include <linux/types.h>
#include <linux/netfilter_ipv6.h>
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
#include <linux/netfilter_ipv4.h>
#endif
[MINOR] add transparent proxy support for balabit's Tproxy v4 Balabit's TPROXY version 4 which replaces CTTPROXY provides a similar API to the previous proxy, but relies on IP_FREEBIND instead of IP_TRANSPARENT. Let's add it.
2008-01-13 16:37:16 +00:00
/* On Linux, IP_TRANSPARENT and/or IP_FREEBIND generally require a kernel patch */
[MEDIUM] support fully transparent proxy on Linux (USE_LINUX_TPROXY) Using some Linux kernel patches, it is possible to redirect non-local traffic to local sockets when IP forwarding is enabled. In order to enable this option, we introduce the "transparent" option keyword on the "bind" command line. It will make the socket reachable by remote sources even if the destination address does not belong to the machine.
2008-01-13 13:49:51 +00:00
#if defined(CONFIG_HAP_LINUX_TPROXY)
[MINOR] add transparent proxy support for balabit's Tproxy v4 Balabit's TPROXY version 4 which replaces CTTPROXY provides a similar API to the previous proxy, but relies on IP_FREEBIND instead of IP_TRANSPARENT. Let's add it.
2008-01-13 16:37:16 +00:00
#if !defined(IP_FREEBIND)
#define IP_FREEBIND 15
#endif /* !IP_FREEBIND */
[MEDIUM] support fully transparent proxy on Linux (USE_LINUX_TPROXY) Using some Linux kernel patches, it is possible to redirect non-local traffic to local sockets when IP forwarding is enabled. In order to enable this option, we introduce the "transparent" option keyword on the "bind" command line. It will make the socket reachable by remote sources even if the destination address does not belong to the machine.
2008-01-13 13:49:51 +00:00
#if !defined(IP_TRANSPARENT)
#define IP_TRANSPARENT 19
#endif /* !IP_TRANSPARENT */
MINOR: IPv6 support for transparent proxy Set socket option IPV6_TRANSPARENT on binding to enable transparent proxy on IPv6. This option is available from Linux 2.6.37.
2012-07-13 12:34:59 +00:00
#if !defined(IPV6_TRANSPARENT)
#define IPV6_TRANSPARENT 75
#endif /* !IPV6_TRANSPARENT */
[MEDIUM] support fully transparent proxy on Linux (USE_LINUX_TPROXY) Using some Linux kernel patches, it is possible to redirect non-local traffic to local sockets when IP forwarding is enabled. In order to enable this option, we introduce the "transparent" option keyword on the "bind" command line. It will make the socket reachable by remote sources even if the destination address does not belong to the machine.
2008-01-13 13:49:51 +00:00
#endif /* CONFIG_HAP_LINUX_TPROXY */
REORG: tproxy: prepare the transparent proxy defines for accepting other OSes This patch does not change the logic of the code, it only changes the way OS-specific defines are tested. At the moment the transparent proxy code heavily depends on Linux-specific defines. This first patch introduces a new define "CONFIG_HAP_TRANSPARENT" which is set every time the defines used by transparent proxy are present. This also means that with an up-to-date libc, it should not be necessary anymore to force CONFIG_HAP_LINUX_TPROXY during the build, as the flags will automatically be detected. The CTTPROXY flags still remain separate because this older API doesn't work the same way. A new line has been added in the version output for haproxy -vv to indicate what transparent proxy support is available.
2013-05-08 20:49:23 +00:00
#if defined(IP_FREEBIND) \
MINOR: tproxy: add support for FreeBSD FreeBSD uses (IPPROTO_IP, IP_BINDANY) and (IPPROTO_IPV6, IPV6_BINDANY) to enable transparent proxy on a socket. This patch adds support for the relevant setsockopt() calls.
2013-05-08 21:22:39 +00:00
|| defined(IP_BINDANY) \
|| defined(IPV6_BINDANY) \
MINOR: tproxy: add support for OpenBSD OpenBSD uses (SOL_SOCKET, SO_BINDANY) to enable transparent proxy on a socket. This patch adds support for the relevant setsockopt() calls.
2013-05-08 21:30:23 +00:00
|| defined(SO_BINDANY) \
REORG: tproxy: prepare the transparent proxy defines for accepting other OSes This patch does not change the logic of the code, it only changes the way OS-specific defines are tested. At the moment the transparent proxy code heavily depends on Linux-specific defines. This first patch introduces a new define "CONFIG_HAP_TRANSPARENT" which is set every time the defines used by transparent proxy are present. This also means that with an up-to-date libc, it should not be necessary anymore to force CONFIG_HAP_LINUX_TPROXY during the build, as the flags will automatically be detected. The CTTPROXY flags still remain separate because this older API doesn't work the same way. A new line has been added in the version output for haproxy -vv to indicate what transparent proxy support is available.
2013-05-08 20:49:23 +00:00
|| defined(IP_TRANSPARENT) \
|| defined(IPV6_TRANSPARENT)
#define CONFIG_HAP_TRANSPARENT
#endif
[MEDIUM] add support for SO_REUSEPORT on Linux SO_REUSEPORT does not exist on Linux but the checks are available in the code. With a little patch, it's possible to implement the feature, but the value of SO_REUSEPORT will still have to be known from userland. This patch adds a workaround to this problem by figuring out the value for the one used by SO_REUSEADDR.
2006-11-13 00:22:38 +00:00
/* We'll try to enable SO_REUSEPORT on Linux 2.4 and 2.6 if not defined.
* There are two families of values depending on the architecture. Those
* are at least valid on Linux 2.4 and 2.6, reason why we'll rely on the
* NETFILTER define.
*/
#if !defined(SO_REUSEPORT) && defined(NETFILTER)
#if (SO_REUSEADDR == 2)
#define SO_REUSEPORT 15
#elif (SO_REUSEADDR == 0x0004)
#define SO_REUSEPORT 0x0200
#endif /* SO_REUSEADDR */
#endif /* SO_REUSEPORT */
BUILD: add explicit support for TFO with USE_TFO TCP Fast Open is supported in server mode since Linux 3.7, but current libc's don't define TCP_FASTOPEN=23. Introduce the new USE flag USE_TFO to define it manually in compat.h. Also note this in the TFO related documentation.
2013-04-02 14:43:24 +00:00
/* only Linux defines TCP_FASTOPEN */
#ifdef USE_TFO
#ifndef TCP_FASTOPEN
#define TCP_FASTOPEN 23
#endif
#endif
MEDIUM: http: add IPv6 support for "set-tos" As per RFC3260 #4 and BCP37 #4.2 and #5.2, the IPv6 counterpart of TOS is "traffic class". Add support for IPv6 traffic class in "set-tos" by moving the "set-tos" related code to the new inline function inet_set_tos(), handling IPv4 (IP_TOS), IPv6 (IPV6_TCLASS) and IPv4-mapped sockets (IP_TOS, like ::ffff:127.0.0.1). Also define - if missing - the IN6_IS_ADDR_V4MAPPED() macro in include/common/compat.h for compatibility.
2013-06-23 15:37:13 +00:00
/* If IPv6 is supported, define IN6_IS_ADDR_V4MAPPED() if missing. */
#if defined(IPV6_TCLASS) && !defined(IN6_IS_ADDR_V4MAPPED)
#define IN6_IS_ADDR_V4MAPPED(a) \
((((const uint32_t *) (a))[0] == 0) \
&& (((const uint32_t *) (a))[1] == 0) \
&& (((const uint32_t *) (a))[2] == htonl (0xffff)))
#endif
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
#if defined(__dietlibc__)
#include <strings.h>
#endif
[CLEANUP] renamed include/haproxy to include/common
2006-06-29 15:53:05 +00:00
#endif /* _COMMON_COMPAT_H */
[BIGMOVE] exploded the monolithic haproxy.c file into multiple files. The files are now stored under : - include/haproxy for the generic includes - include/types.h for the structures needed within prototypes - include/proto.h for function prototypes and inline functions - src/*.c for the C files Most include files are now covered by LGPL. A last move still needs to be done to put inline functions under GPL and not LGPL. Version has been set to 1.3.0 in the code but some control still needs to be done before releasing.
2006-06-26 00:48:02 +00:00
/*
* Local variables:
* c-indent-level: 8
* c-basic-offset: 8
* End:
*/