TODO file removed.

[redis.git] / src / Makefile

diff --git a/src/Makefile b/src/Makefile
index 0af70f1741ee47e4475c63d1ab763a4a2faaa8fa..e8543d9573262158a7a7043d1fbb9fc271ee90d0 100644 (file)
--- a/src/Makefile
+++ b/src/Makefile
@@ -1,122 +1,224 @@
 # Redis Makefile
 # Copyright (C) 2009 Salvatore Sanfilippo <antirez at gmail dot com>
 # This file is released under the BSD license, see the COPYING file
 # Redis Makefile
 # Copyright (C) 2009 Salvatore Sanfilippo <antirez at gmail dot com>
 # This file is released under the BSD license, see the COPYING file

+#
+# The Makefile composes the final FINAL_CFLAGS and FINAL_LDFLAGS using
+# what is needed for Redis plus the standard CFLAGS and LDFLAGS passed.
+# However when building the dependencies (Jemalloc, Lua, Hiredis, ...)
+# CFLAGS and LDFLAGS are propagated to the dependencies, so to pass
+# flags only to be used when compiling / linking Redis itself REDIS_CFLAGS
+# and REDIS_LDFLAGS are used instead (this is the case of 'make gcov').
+#
+# Dependencies are stored in the Makefile.dep file. To rebuild this file
+# Just use 'make dep', but this is only needed by developers.

 
 release_hdr := $(shell sh -c './mkreleasehdr.sh')
 uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')
 OPTIMIZATION?=-O2
 
 release_hdr := $(shell sh -c './mkreleasehdr.sh')
 uname_S := $(shell sh -c 'uname -s 2>/dev/null || echo not')
 OPTIMIZATION?=-O2

+DEPENDENCY_TARGETS=hiredis linenoise lua
+
+# Default settings
+STD= -std=c99 -pedantic
+WARN= -Wall
+OPT= $(OPTIMIZATION)
+
+# Default allocator
+ifeq ($(uname_S),Linux)
+  MALLOC=jemalloc
+else
+  MALLOC=libc
+endif
+
+# Backwards compatibility for selecting an allocator
+ifeq ($(USE_TCMALLOC),yes)
+  MALLOC=tcmalloc
+endif
+
+ifeq ($(USE_TCMALLOC_MINIMAL),yes)
+  MALLOC=tcmalloc_minimal
+endif
+
+ifeq ($(USE_JEMALLOC),yes)
+  MALLOC=jemalloc
+endif
+
+# Override default settings if possible
+-include .make-settings
+

 ifeq ($(uname_S),SunOS)
 ifeq ($(uname_S),SunOS)

-  CFLAGS?= -std=c99 -pedantic $(OPTIMIZATION) -Wall -W -D__EXTENSIONS__ -D_XPG6
-  CCLINK?= -ldl -lnsl -lsocket -lm -lpthread
+  FINAL_CFLAGS= $(STD) $(WARN) $(OPT) $(DEBUG) $(CFLAGS) $(REDIS_CFLAGS) -D__EXTENSIONS__ -D_XPG6
+  FINAL_LDFLAGS= $(LDFLAGS) $(REDIS_LDFLAGS) -g -ggdb
+  FINAL_LIBS= -ldl -lnsl -lsocket -lm -lpthread
+  DEBUG= -g -ggdb

 else
 else

-  CFLAGS?= -std=c99 -pedantic $(OPTIMIZATION) -Wall -W $(ARCH) $(PROF)
-  CCLINK?= -lm -pthread
+  FINAL_CFLAGS= $(STD) $(WARN) $(OPT) $(DEBUG) $(CFLAGS) $(REDIS_CFLAGS)
+  FINAL_LDFLAGS= $(LDFLAGS) $(REDIS_LDFLAGS) -g -rdynamic -ggdb
+  FINAL_LIBS= -lm -pthread
+  DEBUG= -g -rdynamic -ggdb

 endif
 endif

-CCOPT= $(CFLAGS) $(CCLINK) $(ARCH) $(PROF)
-DEBUG?= -g -rdynamic -ggdb 

 
 

-INSTALL_TOP= /usr/local
-INSTALL_BIN= $(INSTALL_TOP)/bin
-INSTALL= cp -p
+# Include paths to dependencies
+FINAL_CFLAGS+= -I../deps/hiredis -I../deps/linenoise -I../deps/lua/src

 
 

-OBJ = adlist.o ae.o anet.o dict.o redis.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o vm.o pubsub.o multi.o debug.o sort.o
-BENCHOBJ = ae.o anet.o redis-benchmark.o sds.o adlist.o zmalloc.o
-CLIOBJ = anet.o sds.o adlist.o redis-cli.o zmalloc.o linenoise.o
-CHECKDUMPOBJ = redis-check-dump.o lzf_c.o lzf_d.o
-CHECKAOFOBJ = redis-check-aof.o
+ifeq ($(MALLOC),tcmalloc)
+  FINAL_CFLAGS+= -DUSE_TCMALLOC
+  FINAL_LIBS+= -ltcmalloc
+endif

 
 

-PRGNAME = redis-server
-BENCHPRGNAME = redis-benchmark
-CLIPRGNAME = redis-cli
-CHECKDUMPPRGNAME = redis-check-dump
-CHECKAOFPRGNAME = redis-check-aof
+ifeq ($(MALLOC),tcmalloc_minimal)
+  FINAL_CFLAGS+= -DUSE_TCMALLOC
+  FINAL_LIBS+= -ltcmalloc_minimal
+endif

 
 

-all: redis-server redis-benchmark redis-cli redis-check-dump redis-check-aof
+ifeq ($(MALLOC),jemalloc)
+  DEPENDENCY_TARGETS+= jemalloc
+  FINAL_CFLAGS+= -DUSE_JEMALLOC -I../deps/jemalloc/include
+  FINAL_LIBS+= ../deps/jemalloc/lib/libjemalloc.a -ldl
+endif

 
 

-# Deps (use make dep to generate this)
-adlist.o: adlist.c adlist.h zmalloc.h
-ae.o: ae.c ae.h zmalloc.h config.h ae_kqueue.c
-ae_epoll.o: ae_epoll.c
-ae_kqueue.o: ae_kqueue.c
-ae_select.o: ae_select.c
-anet.o: anet.c fmacros.h anet.h
-dict.o: dict.c fmacros.h dict.h zmalloc.h
-linenoise.o: linenoise.c fmacros.h
-lzf_c.o: lzf_c.c lzfP.h
-lzf_d.o: lzf_d.c lzfP.h
-pqsort.o: pqsort.c
-redis-benchmark.o: redis-benchmark.c fmacros.h ae.h anet.h sds.h adlist.h \
-  zmalloc.h
-redis-check-aof.o: redis-check-aof.c fmacros.h config.h
-redis-check-dump.o: redis-check-dump.c lzf.h
-redis-cli.o: redis-cli.c fmacros.h anet.h sds.h adlist.h zmalloc.h \
-  linenoise.h
-redis.o: redis.c fmacros.h config.h redis.h ae.h sds.h anet.h dict.h \
-  adlist.h zmalloc.h lzf.h pqsort.h zipmap.h ziplist.h sha1.h
-release.o: release.c release.h
-sds.o: sds.c sds.h zmalloc.h
-sha1.o: sha1.c sha1.h
-ziplist.o: ziplist.c zmalloc.h ziplist.h
-zipmap.o: zipmap.c zmalloc.h
-zmalloc.o: zmalloc.c config.h
-
-redis-server: $(OBJ)
-       $(CC) -o $(PRGNAME) $(CCOPT) $(DEBUG) $(OBJ)
+REDIS_CC=$(QUIET_CC)$(CC) $(FINAL_CFLAGS)
+REDIS_LD=$(QUIET_LINK)$(CC) $(FINAL_LDFLAGS)
+
+PREFIX?=/usr/local
+INSTALL_BIN= $(PREFIX)/bin
+INSTALL= cp -pf
+
+CCCOLOR="\033[34m"
+LINKCOLOR="\033[34;1m"
+SRCCOLOR="\033[33m"
+BINCOLOR="\033[37;1m"
+MAKECOLOR="\033[32;1m"
+ENDCOLOR="\033[0m"
+
+ifndef V
+QUIET_CC = @printf '    %b %b\n' $(CCCOLOR)CC$(ENDCOLOR) $(SRCCOLOR)$@$(ENDCOLOR) 1>&2;
+QUIET_LINK = @printf '    %b %b\n' $(LINKCOLOR)LINK$(ENDCOLOR) $(BINCOLOR)$@$(ENDCOLOR) 1>&2;
+endif
+
+REDIS_SERVER_NAME= redis-server
+REDIS_SERVER_OBJ= adlist.o ae.o anet.o dict.o redis.o sds.o zmalloc.o lzf_c.o lzf_d.o pqsort.o zipmap.o sha1.o ziplist.o release.o networking.o util.o object.o db.o replication.o rdb.o t_string.o t_list.o t_set.o t_zset.o t_hash.o config.o aof.o pubsub.o multi.o debug.o sort.o intset.o syncio.o migrate.o endianconv.o slowlog.o scripting.o bio.o rio.o rand.o memtest.o crc64.o
+REDIS_CLI_NAME= redis-cli
+REDIS_CLI_OBJ= anet.o sds.o adlist.o redis-cli.o zmalloc.o release.o anet.o ae.o
+REDIS_BENCHMARK_NAME= redis-benchmark
+REDIS_BENCHMARK_OBJ= ae.o anet.o redis-benchmark.o sds.o adlist.o zmalloc.o redis-benchmark.o
+REDIS_CHECK_DUMP_NAME= redis-check-dump
+REDIS_CHECK_DUMP_OBJ= redis-check-dump.o lzf_c.o lzf_d.o crc64.o
+REDIS_CHECK_AOF_NAME= redis-check-aof
+REDIS_CHECK_AOF_OBJ= redis-check-aof.o
+
+all: $(REDIS_SERVER_NAME) $(REDIS_CLI_NAME) $(REDIS_BENCHMARK_NAME) $(REDIS_CHECK_DUMP_NAME) $(REDIS_CHECK_AOF_NAME)

        @echo ""
        @echo "Hint: To run 'make test' is a good idea ;)"
        @echo ""
 
        @echo ""
        @echo "Hint: To run 'make test' is a good idea ;)"
        @echo ""
 

-redis-benchmark: $(BENCHOBJ)
-       $(CC) -o $(BENCHPRGNAME) $(CCOPT) $(DEBUG) $(BENCHOBJ)
+.PHONY: all
+
+# Deps (use make dep to generate this)
+include Makefile.dep

 
 

-redis-cli: $(CLIOBJ)
-       $(CC) -o $(CLIPRGNAME) $(CCOPT) $(DEBUG) $(CLIOBJ)
+dep:
+       $(REDIS_CC) -MM *.c > Makefile.dep
+
+.PHONY: dep
+
+persist-settings: distclean
+       echo STD=$(STD) >> .make-settings
+       echo WARN=$(WARN) >> .make-settings
+       echo OPT=$(OPT) >> .make-settings
+       echo MALLOC=$(MALLOC) >> .make-settings
+       echo CFLAGS=$(CFLAGS) >> .make-settings
+       echo LDFLAGS=$(LDFLAGS) >> .make-settings
+       echo REDIS_CFLAGS=$(REDIS_CFLAGS) >> .make-settings
+       echo REDIS_LDFLAGS=$(REDIS_LDFLAGS) >> .make-settings
+       echo PREV_FINAL_CFLAGS=$(FINAL_CFLAGS) >> .make-settings
+       echo PREV_FINAL_LDFLAGS=$(FINAL_LDFLAGS) >> .make-settings
+       -(cd ../deps && $(MAKE) $(DEPENDENCY_TARGETS))
+
+.PHONY: persist-settings
+
+# Prerequisites target
+.make-prerequisites:
+       @touch $@
+
+# Clean everything, persist settings and build dependencies if anything changed
+ifneq ($(strip $(PREV_FINAL_CFLAGS)), $(strip $(FINAL_CFLAGS)))
+.make-prerequisites: persist-settings
+endif
+
+ifneq ($(strip $(PREV_FINAL_LDFLAGS)), $(strip $(FINAL_LDFLAGS)))
+.make-prerequisites: persist-settings
+endif

 
 

-redis-check-dump: $(CHECKDUMPOBJ)
-       $(CC) -o $(CHECKDUMPPRGNAME) $(CCOPT) $(DEBUG) $(CHECKDUMPOBJ)
+# redis-server
+$(REDIS_SERVER_NAME): $(REDIS_SERVER_OBJ)
+       $(REDIS_LD) -o $@ $^ ../deps/lua/src/liblua.a $(FINAL_LIBS)

 
 

-redis-check-aof: $(CHECKAOFOBJ)
-       $(CC) -o $(CHECKAOFPRGNAME) $(CCOPT) $(DEBUG) $(CHECKAOFOBJ)
+# redis-cli
+$(REDIS_CLI_NAME): $(REDIS_CLI_OBJ)
+       $(REDIS_LD) -o $@ $^ ../deps/hiredis/libhiredis.a ../deps/linenoise/linenoise.o $(FINAL_LIBS)

 
 

-.c.o:
-       $(CC) -c $(CFLAGS) $(DEBUG) $(COMPILE_TIME) $<
+# redis-benchmark
+$(REDIS_BENCHMARK_NAME): $(REDIS_BENCHMARK_OBJ)
+       $(REDIS_LD) -o $@ $^ ../deps/hiredis/libhiredis.a $(FINAL_LIBS)
+
+# redis-check-dump
+$(REDIS_CHECK_DUMP_NAME): $(REDIS_CHECK_DUMP_OBJ)
+       $(REDIS_LD) -o $@ $^ $(FINAL_LIBS)
+
+# redis-check-aof
+$(REDIS_CHECK_AOF_NAME): $(REDIS_CHECK_AOF_OBJ)
+       $(REDIS_LD) -o $@ $^ $(FINAL_LIBS)
+
+# Because the jemalloc.h header is generated as a part of the jemalloc build,
+# building it should complete before building any other object. Instead of
+# depending on a single artifact, build all dependencies first.
+%.o: %.c .make-prerequisites
+       $(REDIS_CC) -c $<

 
 clean:
 
 clean:

-       rm -rf $(PRGNAME) $(BENCHPRGNAME) $(CLIPRGNAME) $(CHECKDUMPPRGNAME) $(CHECKAOFPRGNAME) *.o *.gcda *.gcno *.gcov
+       rm -rf $(REDIS_SERVER_NAME) $(REDIS_CLI_NAME) $(REDIS_BENCHMARK_NAME) $(REDIS_CHECK_DUMP_NAME) $(REDIS_CHECK_AOF_NAME) *.o *.gcda *.gcno *.gcov redis.info lcov-html

 
 

-dep:
-       $(CC) -MM *.c
+.PHONY: clean

 
 

-test:
-       (cd ..; tclsh8.5 tests/test_helper.tcl --tags "${TAGS}")
+distclean: clean
+       -(cd ../deps && $(MAKE) distclean)
+       -(rm -f .make-*)

 
 

-bench:
-       ./redis-benchmark
+.PHONY: distclean

 
 

-log:
-       git log '--pretty=format:%ad %s (%cn)' --date=short > ../Changelog
+test: $(REDIS_SERVER_NAME) $(REDIS_CHECK_AOF_NAME)
+       @(cd ..; ./runtest)
+
+lcov:
+       $(MAKE) gcov
+       @(set -e; cd ..; ./runtest --clients 1)
+       @geninfo -o redis.info .
+       @genhtml --legend -o lcov-html redis.info
+
+.PHONY: lcov
+
+bench: $(REDIS_BENCHMARK_NAME)
+       ./$(REDIS_BENCHMARK_NAME)

 
 32bit:
        @echo ""
        @echo "WARNING: if it fails under Linux you probably need to install libc6-dev-i386"
        @echo ""
 
 32bit:
        @echo ""
        @echo "WARNING: if it fails under Linux you probably need to install libc6-dev-i386"
        @echo ""

-       make ARCH="-m32"
-
-gprof:
-       make PROF="-pg"
+       $(MAKE) CFLAGS="-m32" LDFLAGS="-m32"

 
 gcov:
 
 gcov:

-       make PROF="-fprofile-arcs -ftest-coverage"
+       $(MAKE) REDIS_CFLAGS="-fprofile-arcs -ftest-coverage -DCOVERAGE_TEST" REDIS_LDFLAGS="-fprofile-arcs -ftest-coverage"

 
 noopt:
 
 noopt:

-       make OPTIMIZATION=""
+       $(MAKE) OPT="-O0"

 
 

-32bitgprof:
-       make PROF="-pg" ARCH="-arch i386"
+src/help.h:
+       @../utils/generate-command-help.rb > help.h

 
 install: all
 
 install: all

-       $(INSTALL) $(PRGNAME) $(INSTALL_BIN)
-       $(INSTALL) $(BENCHPRGNAME) $(INSTALL_BIN)
-       $(INSTALL) $(CLIPRGNAME) $(INSTALL_BIN)
-       $(INSTALL) $(CHECKDUMPPRGNAME) $(INSTALL_BIN)
-       $(INSTALL) $(CHECKAOFPRGNAME) $(INSTALL_BIN)
+       mkdir -p $(INSTALL_BIN)
+       $(INSTALL) $(REDIS_SERVER_NAME) $(INSTALL_BIN)
+       $(INSTALL) $(REDIS_BENCHMARK_NAME) $(INSTALL_BIN)
+       $(INSTALL) $(REDIS_CLI_NAME) $(INSTALL_BIN)
+       $(INSTALL) $(REDIS_CHECK_DUMP_NAME) $(INSTALL_BIN)
+       $(INSTALL) $(REDIS_CHECK_AOF_NAME) $(INSTALL_BIN)