xref: /aosp_15_r20/external/lz4/programs/Makefile (revision 27162e4e17433d5aa7cb38e7b6a433a09405fc7f)
1# ##########################################################################
2# LZ4 programs - Makefile
3# Copyright (C) Yann Collet 2011-2023
4#
5# This Makefile is validated for Linux, macOS, *BSD, Hurd, Solaris, MSYS2 targets
6#
7# GPL v2 License
8#
9# This program is free software; you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation; either version 2 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License along
20# with this program; if not, write to the Free Software Foundation, Inc.,
21# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22#
23# You can contact the author at :
24#  - LZ4 homepage : http://www.lz4.org
25#  - LZ4 source repository : https://github.com/lz4/lz4
26# ##########################################################################
27# lz4 : Command Line Utility, supporting gzip-like arguments
28# lz4c  : CLU, supporting also legacy lz4demo arguments
29# lz4c32: Same as lz4c, but forced to compile in 32-bits mode
30# ##########################################################################
31SED ?= sed
32
33# Version numbers
34LIBDIR   := ../lib
35LIBVER_SRC := $(LIBDIR)/lz4.h
36LIBVER_MAJOR_SCRIPT:=`$(SED) -n '/define[[:blank:]][[:blank:]]*LZ4_VERSION_MAJOR/s/.*[[:blank:]]\([0-9][0-9]*\).*/\1/p' < $(LIBVER_SRC)`
37LIBVER_MINOR_SCRIPT:=`$(SED) -n '/define[[:blank:]][[:blank:]]*LZ4_VERSION_MINOR/s/.*[[:blank:]]\([0-9][0-9]*\).*/\1/p' < $(LIBVER_SRC)`
38LIBVER_PATCH_SCRIPT:=`$(SED) -n '/define[[:blank:]][[:blank:]]*LZ4_VERSION_RELEASE/s/.*[[:blank:]]\([0-9][0-9]*\).*/\1/p' < $(LIBVER_SRC)`
39LIBVER_SCRIPT:= $(LIBVER_MAJOR_SCRIPT).$(LIBVER_MINOR_SCRIPT).$(LIBVER_PATCH_SCRIPT)
40LIBVER_MAJOR := $(shell echo $(LIBVER_MAJOR_SCRIPT))
41LIBVER_MINOR := $(shell echo $(LIBVER_MINOR_SCRIPT))
42LIBVER_PATCH := $(shell echo $(LIBVER_PATCH_SCRIPT))
43LIBVER   := $(shell echo $(LIBVER_SCRIPT))
44
45LIBFILES  = $(wildcard $(LIBDIR)/*.c)
46SRCFILES  = $(sort $(LIBFILES) $(wildcard *.c))
47OBJFILES  = $(SRCFILES:.c=.o)
48
49DEBUGFLAGS= -Wall -Wextra -Wundef -Wcast-qual -Wcast-align -Wshadow \
50            -Wswitch-enum -Wdeclaration-after-statement -Wstrict-prototypes \
51            -Wpointer-arith -Wstrict-aliasing=1
52USERCFLAGS:= -O3 $(CFLAGS) # -O3 can be overruled by user-provided -Ox level
53CFLAGS    = $(DEBUGFLAGS) $(USERCFLAGS)
54CPPFLAGS += -I$(LIBDIR) -DXXH_NAMESPACE=LZ4_
55
56include ../Makefile.inc
57
58OS_VERSION ?= $(UNAME) -r
59ifeq ($(TARGET_OS)$(shell $(OS_VERSION)),SunOS5.10)
60LDFLAGS  += -lrt
61endif
62
63ALLFLAGS  = $(CFLAGS) $(CPPFLAGS) $(LDFLAGS)
64
65# thread detection
66NUM_SYMBOL   := \#
67NO_THREAD_MSG:= ==> no multithread support: building for single-thread mode only
68HAVE_PTHREAD := $(shell printf '$(NUM_SYMBOL)include <pthread.h>\nint main(void) { return 0; }' > have_pthread.c && $(CC) $(ALLFLAGS) -o have_pthread$(EXT) have_pthread.c -pthread 2> $(VOID) && rm -f have_pthread$(EXT) && echo 1 || echo 0; rm have_pthread.c)
69HAVE_MULTITHREAD  := $(shell [ "$(HAVE_PTHREAD)" -eq "1" -o -n "$(filter Windows%,$(OS))" ] && echo 1 || echo 0)
70ifeq ($(HAVE_MULTITHREAD), 1)
71  THREAD_MSG := ==> building with multithreading support
72  THREAD_CPP := -DLZ4IO_MULTITHREAD
73  ifeq ($(HAVE_PTHREAD), 1)
74    THREAD_LD  := -pthread
75  endif
76else
77  THREAD_MSG := $(NO_THREAD_MSG)
78endif
79
80LZ4_VERSION=$(LIBVER)
81MD2ROFF    = ronn
82MD2ROFF_FLAGS = --roff --warnings --manual="User Commands" --organization="lz4 $(LZ4_VERSION)"
83
84.PHONY:default
85default: lz4-release
86
87# silent mode by default; verbose can be triggered by V=1 or VERBOSE=1
88$(V)$(VERBOSE).SILENT:
89
90.PHONY:all
91all: lz4 lz4-nomt lz4c unlz4 lz4cat
92
93.PHONY:all32
94all32: CFLAGS+=-m32
95all32: all
96
97ifeq ($(WINBASED),yes)
98lz4-exe.rc: lz4-exe.rc.in
99	@echo creating executable resource
100	$(SED) -e 's|@PROGNAME@|lz4|' \
101           -e 's|@LIBVER_MAJOR@|$(LIBVER_MAJOR)|g' \
102           -e 's|@LIBVER_MINOR@|$(LIBVER_MINOR)|g' \
103           -e 's|@LIBVER_PATCH@|$(LIBVER_PATCH)|g' \
104           -e 's|@EXT@|.exe|g' \
105           $< >$@
106
107lz4-exe.o: lz4-exe.rc
108	$(WINDRES) -i lz4-exe.rc -o lz4-exe.o
109
110lz4: CPPFLAGS += $(THREAD_CPP)
111lz4: LDFLAGS += $(THREAD_LD)
112lz4: $(OBJFILES) lz4-exe.o
113	echo "$(THREAD_MSG)"
114	$(CC) $(ALLFLAGS) $^ -o $@$(EXT)
115else
116lz4: CPPFLAGS += $(THREAD_CPP)
117lz4: LDFLAGS += $(THREAD_LD)
118lz4: $(OBJFILES)
119	echo "$(THREAD_MSG)"
120	$(CC) $(ALLFLAGS) $(OBJFILES) -o $@$(EXT) $(LDLIBS)
121endif
122CLEAN += lz4
123
124.PHONY: lz4-release
125lz4-release: DEBUGFLAGS=
126lz4-release: CPPFLAGS+=-DNDEBUG
127lz4-release: lz4
128
129CLEAN += lz4-nomt
130lz4-nomt: $(SRCFILES)
131	$(CC) $(ALLFLAGS) $^ -o $@$(EXT)
132
133CLEAN += lz4-wlib
134lz4-wlib: LIBFILES =
135lz4-wlib: SRCFILES+= $(LIBDIR)/xxhash.c  # benchmark unit needs XXH64()
136lz4-wlib: LDFLAGS += -L $(LIBDIR)
137lz4-wlib: LDLIBS   = -llz4
138lz4-wlib: liblz4 $(OBJFILES)
139	@echo WARNING: $@ must link to an extended variant of the dynamic library which also exposes unstable symbols
140	$(CC) $(ALLFLAGS) $(OBJFILES) -o $@$(EXT) $(LDLIBS)
141
142.PHONY:liblz4
143liblz4:
144	CPPFLAGS="-DLZ4F_PUBLISH_STATIC_FUNCTIONS -DLZ4_PUBLISH_STATIC_FUNCTIONS" $(MAKE) -C $(LIBDIR) liblz4
145
146CLEAN += lz4c
147lz4c: lz4
148	$(LN_SF) lz4$(EXT) lz4c$(EXT)
149
150CLEAN += lz4c32
151lz4c32: CFLAGS += -m32
152lz4c32 : $(SRCFILES)
153	$(CC) $(ALLFLAGS) $^ -o $@$(EXT)
154
155CLEAN += unlz4
156unlz4: lz4
157	$(LN_SF) lz4$(EXT) unlz4$(EXT)
158
159CLEAN += lz4cat
160lz4cat: lz4
161	$(LN_SF) lz4$(EXT) lz4cat$(EXT)
162
163lz4.1: lz4.1.md $(LIBVER_SRC)
164	cat $< | $(MD2ROFF) $(MD2ROFF_FLAGS) | $(SED) -n '/^\.\\\".*/!p' > $@
165
166.PHONY:man
167man: lz4.1
168
169.PHONY:clean-man
170clean-man:
171	$(RM) lz4.1
172
173.PHONY:preview-man
174preview-man: clean-man man
175	man ./lz4.1
176
177.PHONY:clean
178clean:
179ifeq ($(WINBASED),yes)
180	$(RM) *.rc
181endif
182	$(MAKE) -C $(LIBDIR) $@ > $(VOID)
183	$(RM) $(CLEAN) *.o tmp* *.test core
184	@echo Cleaning completed
185
186
187#-----------------------------------------------------------------------------
188# make install is validated only for Linux, OSX, BSD, Hurd and Solaris targets
189#-----------------------------------------------------------------------------
190ifeq ($(POSIX_ENV),Yes)
191
192DESTDIR     ?=
193# directory variables : GNU conventions prefer lowercase
194# see https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html
195# support both lower and uppercase (BSD), use lowercase in script
196PREFIX      ?= /usr/local
197prefix      ?= $(PREFIX)
198EXEC_PREFIX ?= $(prefix)
199exec_prefix ?= $(EXEC_PREFIX)
200BINDIR      ?= $(exec_prefix)/bin
201bindir      ?= $(BINDIR)
202DATAROOTDIR ?= $(prefix)/share
203datarootdir ?= $(DATAROOTDIR)
204MANDIR      ?= $(datarootdir)/man
205mandir      ?= $(MANDIR)
206MAN1DIR     ?= $(mandir)/man1
207man1dir     ?= $(MAN1DIR)
208
209.PHONY: install
210install: lz4
211	@echo Installing binaries in $(DESTDIR)$(bindir)
212	$(MAKE_DIR) $(DESTDIR)$(bindir)/ $(DESTDIR)$(man1dir)/
213	$(INSTALL_PROGRAM) lz4$(EXT) $(DESTDIR)$(bindir)/lz4$(EXT)
214	$(LN_SF) lz4$(EXT) $(DESTDIR)$(bindir)/lz4c$(EXT)
215	$(LN_SF) lz4$(EXT) $(DESTDIR)$(bindir)/lz4cat$(EXT)
216	$(LN_SF) lz4$(EXT) $(DESTDIR)$(bindir)/unlz4$(EXT)
217	@echo Installing man pages in $(DESTDIR)$(man1dir)
218	$(INSTALL_DATA) lz4.1 $(DESTDIR)$(man1dir)/lz4.1
219	$(LN_SF) lz4.1 $(DESTDIR)$(man1dir)/lz4c.1
220	$(LN_SF) lz4.1 $(DESTDIR)$(man1dir)/lz4cat.1
221	$(LN_SF) lz4.1 $(DESTDIR)$(man1dir)/unlz4.1
222	@echo lz4 installation completed
223
224.PHONY: uninstall
225uninstall:
226	$(RM) $(DESTDIR)$(bindir)/lz4cat$(EXT)
227	$(RM) $(DESTDIR)$(bindir)/unlz4$(EXT)
228	$(RM) $(DESTDIR)$(bindir)/lz4$(EXT)
229	$(RM) $(DESTDIR)$(bindir)/lz4c$(EXT)
230	$(RM) $(DESTDIR)$(man1dir)/lz4.1
231	$(RM) $(DESTDIR)$(man1dir)/lz4c.1
232	$(RM) $(DESTDIR)$(man1dir)/lz4cat.1
233	$(RM) $(DESTDIR)$(man1dir)/unlz4.1
234	@echo lz4 programs successfully uninstalled
235
236endif
237