BUILD: compression: switch SLZ from out-of-tree to in-tree
Now that SLZ is merged, let's update the makefile and compression
files to use it. As a result, SLZ_INC and SLZ_LIB are neither defined
nor used anymore.
USE_SLZ is enabled by default ("USE_SLZ=default") and can be disabled
by passing "USE_SLZ=" or by enabling USE_ZLIB=1.
The doc was updated to reflect the changes.
This commit is contained in:
Willy Tarreau
parent
ab2b7828e2
commit
12840be005
48
INSTALL
48
INSTALL
|
|
@ -32,14 +32,14 @@ are a few build examples :
|
|||
- recent Linux system with all options, make and install :
|
||||
$ make clean
|
||||
$ make -j $(nproc) TARGET=linux-glibc \
|
||||
USE_OPENSSL=1 USE_ZLIB=1 USE_LUA=1 USE_PCRE=1 USE_SYSTEMD=1
|
||||
USE_OPENSSL=1 USE_LUA=1 USE_PCRE=1 USE_SYSTEMD=1
|
||||
$ sudo make install
|
||||
|
||||
- FreeBSD and OpenBSD, build with all options :
|
||||
$ gmake -j 4 TARGET=freebsd USE_OPENSSL=1 USE_ZLIB=1 USE_LUA=1 USE_PCRE=1
|
||||
$ gmake -j 4 TARGET=freebsd USE_OPENSSL=1 USE_LUA=1 USE_PCRE=1
|
||||
|
||||
- embedded Linux, build using a cross-compiler :
|
||||
$ make -j $(nproc) TARGET=linux-glibc USE_OPENSSL=1 USE_SLZ=1 USE_PCRE=1 \
|
||||
$ make -j $(nproc) TARGET=linux-glibc USE_OPENSSL=1 USE_PCRE=1 \
|
||||
CC=/opt/cross/gcc730-arm/bin/gcc ADDLIB=-latomic
|
||||
|
||||
- Build with static PCRE on Solaris / UltraSPARC :
|
||||
|
|
@ -278,26 +278,34 @@ acceleration that might be present on your system.
|
|||
----------------
|
||||
HAProxy can compress HTTP responses before delivering them to clients, in order
|
||||
to save network bandwidth. Two compression options are available. The first one
|
||||
involves the widely known zlib library, which is very likely installed on your
|
||||
system. In order to use zlib, simply pass "USE_ZLIB=1" to the command line. If
|
||||
the library is not installed in your default system's path, it is possible to
|
||||
specify the path to the include files using ZLIB_INC, and the path to the
|
||||
library files using ZLIB_LIB :
|
||||
relies on the libslz library (http://libslz.org) that is embedded in haproxy.
|
||||
It is enabled by default as it is very fast and does not keep a copy of the
|
||||
contents in memory. It is possible to disable it, for example for very small
|
||||
systems, by passing "USE_SLZ=" to the "make" command.
|
||||
|
||||
Please note that SLZ will benefit from some CPU-specific instructions like the
|
||||
availability of the CRC32 extension on some ARM processors. Thus it can further
|
||||
improve its performance to build with "CPU=native" on the target system.
|
||||
|
||||
A second option involves the widely known zlib library, which is very likely
|
||||
installed on your system. In order to use zlib, simply pass "USE_ZLIB=1" to the
|
||||
"make" command line, which will also automatically disable SLZ. If the library
|
||||
is not installed in your default system's path, it is possible to specify the
|
||||
path to the include files using ZLIB_INC, and the path to the library files
|
||||
using ZLIB_LIB :
|
||||
|
||||
$ make TARGET=generic \
|
||||
USE_ZLIB=1 ZLIB_INC=/opt/zlib-1.2.11/include ZLIB_LIB=/opt/zlib-1.2.11/lib
|
||||
|
||||
However, zlib maintains an in-memory context for each compressed stream, which
|
||||
is not always welcome when dealing with large sites. An alternative solution is
|
||||
to use libslz instead, which doesn't consume memory, which is much faster, but
|
||||
compresses slightly less efficiently. For this, please use "USE_SLZ=1", and
|
||||
optionally make "SLZ_INC" and "SLZ_LIB" point to the library's include and
|
||||
library paths, respectively.
|
||||
|
||||
Zlib is commonly found on most systems, otherwise updates can be retrieved from
|
||||
http://www.zlib.net/. It is easy and fast to build, and new versions sometimes
|
||||
provide better performance so it might be worth using an up-to-date one. Libslz
|
||||
can be downloaded http://libslz.org/ and is even easier to build.
|
||||
provide better performance so it might be worth using an up-to-date one.
|
||||
|
||||
Zlib compresses a bit better than libslz but at the expense of more CPU usage
|
||||
(about 3.5 times more minimum), and a huge memory usage (~260 kB per compressed
|
||||
stream). The only valid reason for uzing Zlib instead of SLZ here usually is to
|
||||
deal with a very limited internet bandwidth while CPU and RAM are abundant so
|
||||
that the last few percent of compression ratio are worth the invested hardware.
|
||||
|
||||
|
||||
4.7) Lua
|
||||
|
|
@ -547,10 +555,10 @@ multithreading via USE_THREAD.
|
|||
|
||||
You can easily define your own target with the GNU Makefile. Unknown targets
|
||||
are processed with no default option except USE_POLL=default. So you can very
|
||||
well use that property to define your own set of options. USE_POLL can even be
|
||||
disabled by setting USE_POLL="". For example :
|
||||
well use that property to define your own set of options. USE_POLL and USE_SLZ
|
||||
can even be disabled by setting them to an empty string. For example :
|
||||
|
||||
$ gmake TARGET=tiny USE_POLL="" TARGET_CFLAGS=-fomit-frame-pointer
|
||||
$ gmake TARGET=tiny USE_POLL="" USE_SLZ="" TARGET_CFLAGS=-fomit-frame-pointer
|
||||
|
||||
If you need to pass some defines to the preprocessor or compiler, you may pass
|
||||
them all in the DEFINE variable. Example:
|
||||
|
|
|
|||
22
Makefile
22
Makefile
|
|
@ -39,8 +39,8 @@
|
|||
# USE_ACCEPT4 : enable use of accept4() on linux. Automatic.
|
||||
# USE_CLOSEFROM : enable use of closefrom() on *bsd, solaris. Automatic.
|
||||
# USE_PRCTL : enable use of prctl(). Automatic.
|
||||
# USE_ZLIB : enable zlib library support.
|
||||
# USE_SLZ : enable slz library instead of zlib (pick at most one).
|
||||
# USE_ZLIB : enable zlib library support and disable SLZ
|
||||
# USE_SLZ : enable slz library instead of zlib (default=enabled)
|
||||
# USE_CPU_AFFINITY : enable pinning processes to CPU on Linux. Automatic.
|
||||
# USE_TFO : enable TCP fast open. Supported on Linux >= 3.7.
|
||||
# USE_NS : enable network namespace support. Supported on Linux >= 2.6.24.
|
||||
|
|
@ -323,6 +323,12 @@ default_opts = $(foreach name,$(1),$(eval $(name)=implicit))
|
|||
# on the make command line.
|
||||
USE_POLL = default
|
||||
|
||||
# SLZ is always supported unless explicitly disabled by passing USE_SLZ=""
|
||||
# or disabled by enabling ZLIB using USE_ZLIB=1
|
||||
ifeq ($(USE_ZLIB),)
|
||||
USE_SLZ = default
|
||||
endif
|
||||
|
||||
# Always enable threads support by default and let the Makefile detect if
|
||||
# HAProxy can be compiled with threads or not.
|
||||
|
||||
|
|
@ -513,14 +519,6 @@ endif
|
|||
endif
|
||||
endif
|
||||
|
||||
ifneq ($(USE_SLZ),)
|
||||
# Use SLZ_INC and SLZ_LIB to force path to zlib.h and libz.{a,so} if needed.
|
||||
SLZ_INC =
|
||||
SLZ_LIB =
|
||||
OPTIONS_CFLAGS += $(if $(SLZ_INC),-I$(SLZ_INC))
|
||||
OPTIONS_LDFLAGS += $(if $(SLZ_LIB),-L$(SLZ_LIB)) -lslz
|
||||
endif
|
||||
|
||||
ifneq ($(USE_ZLIB),)
|
||||
# Use ZLIB_INC and ZLIB_LIB to force path to zlib.h and libz.{a,so} if needed.
|
||||
ZLIB_INC =
|
||||
|
|
@ -529,6 +527,10 @@ OPTIONS_CFLAGS += $(if $(ZLIB_INC),-I$(ZLIB_INC))
|
|||
OPTIONS_LDFLAGS += $(if $(ZLIB_LIB),-L$(ZLIB_LIB)) -lz
|
||||
endif
|
||||
|
||||
ifneq ($(USE_SLZ),)
|
||||
OPTIONS_OBJS += src/slz.o
|
||||
endif
|
||||
|
||||
ifneq ($(USE_POLL),)
|
||||
OPTIONS_OBJS += src/ev_poll.o
|
||||
endif
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
#ifdef USE_ZLIB
|
||||
#error "Cannot build with both USE_SLZ and USE_ZLIB at the same time."
|
||||
#endif
|
||||
#include <slz.h>
|
||||
#include <import/slz.h>
|
||||
#elif defined(USE_ZLIB)
|
||||
#include <zlib.h>
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -13,9 +13,7 @@
|
|||
|
||||
#include <stdio.h>
|
||||
|
||||
#if defined(USE_SLZ)
|
||||
#include <slz.h>
|
||||
#elif defined(USE_ZLIB)
|
||||
#if defined(USE_ZLIB)
|
||||
/* Note: the crappy zlib and openssl libs both define the "free_func" type.
|
||||
* That's a very clever idea to use such a generic name in general purpose
|
||||
* libraries, really... The zlib one is easier to redefine than openssl's,
|
||||
|
|
|
|||
Loading…
Reference in New Issue