Makefile

# 
# Use "make help" to find out about configuration options.
#

EXE_NAME           ?= elbencho
EXE_VER_MAJOR      ?= 3
EXE_VER_MINOR      ?= 0
EXE_VER_PATCHLEVEL ?= 15
EXE_VERSION        ?= $(EXE_VER_MAJOR).$(EXE_VER_MINOR)-$(EXE_VER_PATCHLEVEL)
EXE                ?= $(BIN_PATH)/$(EXE_NAME)
EXE_UNSTRIPPED     ?= $(EXE)-unstripped

SOURCE_PATH        ?= ./source
BIN_PATH           ?= ./bin
EXTERNAL_PATH      ?= ./external
PACKAGING_PATH     ?= ./packaging
BUILD_HELPERS_PATH ?= ./build_helpers

INST_PATH          ?= /usr/local/bin
PKG_INST_PATH      ?= /usr/bin

CXX                ?= g++
STRIP              ?= strip
CXX_FLAVOR         ?= c++17

CXXFLAGS_BOOST     ?= -DBOOST_SPIRIT_THREADSAFE -DBOOST_BIND_GLOBAL_PLACEHOLDERS
LDFLAGS_AIO        ?= -laio
LDFLAGS_BOOST      ?= -lboost_program_options -lboost_system -lboost_thread
LDFLAGS_NUMA       ?= -lnuma

ALTHTTPSVC_SUPPORT ?= 0
BACKTRACE_SUPPORT  ?= 1
COREBIND_SUPPORT   ?= 1
LIBAIO_SUPPORT     ?= 1
LIBNUMA_SUPPORT    ?= 1
NCURSES_SUPPORT    ?= 1
SYNCFS_SUPPORT     ?= 1
S3_SUPPORT         ?= 0
SYSCALLH_SUPPORT   ?= 1

CXXFLAGS_COMMON   = -D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64 $(CXXFLAGS_BOOST) \
	-DNCURSES_NOMACROS -DEXE_NAME=\"$(EXE_NAME)\" -DEXE_VERSION=\"$(EXE_VERSION)\" \
	-I $(SOURCE_PATH) -I $(EXTERNAL_PATH)/Simple-Web-Server \
	-Wall -Wunused-variable -Woverloaded-virtual -Wextra -Wno-unused-parameter -fmessage-length=0 \
	-fno-strict-aliasing -pthread -ggdb -std=$(CXX_FLAVOR)
CXXFLAGS_RELEASE  = -O3 -Wuninitialized
CXXFLAGS_DEBUG    = -O0 -D_FORTIFY_SOURCE=2 -DBUILD_DEBUG

LDFLAGS_COMMON    = -rdynamic -pthread -l crypto -l rt -l ssl -l stdc++fs $(LDFLAGS_NUMA) \
	$(LDFLAGS_AIO) $(LDFLAGS_BOOST)
LDFLAGS_RELASE    = -O3
LDFLAGS_DEBUG     = -O0

SOURCES          := $(shell find $(SOURCE_PATH) -name '*.cpp')
OBJECTS          := $(SOURCES:.cpp=.o)
OBJECTS_CLEANUP  := $(shell find $(SOURCE_PATH) -name '*.o') # separate to clean after C file rename
DEPENDENCY_FILES := $(shell find $(SOURCE_PATH) -name '*.d')

# Release & debug flags for compiler and linker
ifeq ($(BUILD_DEBUG), 1)
CXXFLAGS = $(CXXFLAGS_COMMON) $(CXXFLAGS_DEBUG) $(CXXFLAGS_EXTRA)
LDFLAGS  = $(LDFLAGS_COMMON) $(LDFLAGS_DEBUG) $(LDFLAGS_EXTRA)
else
CXXFLAGS = $(CXXFLAGS_COMMON) $(CXXFLAGS_RELEASE) $(CXXFLAGS_EXTRA)
LDFLAGS  = $(LDFLAGS_COMMON) $(LDFLAGS_RELASE) $(LDFLAGS_EXTRA)

  ifeq ($(CXX), g++)
  # This is to enable gcc's automatic SIMD vectorization for RandAlgoXoshiro256ppSIMD.
  # ("-fopt-info-vec" can be used to confirm that all loops in nextInternalNway() get vectorized.)
  # For background see https://prng.di.unimi.it/ section "Vectorization".
  CXXFLAGS_SPECIAL_SIMD += -fdisable-tree-cunrolli 
  endif
endif

# Dynamic or static linking
ifeq ($(BUILD_STATIC), 1)
LDFLAGS            += -static
# NOTE: "-l ssl -l crypto" intetionally appear again here although they are in LDFLAGS_COMMON. This
#       is because the link order matters for static libs.
LDFLAGS_S3_STATIC  += -l curl -l ssl -l crypto -l tls -l z -l nghttp2 -l brotlidec -l brotlicommon \
	-l idn2 -l unistring -l psl -l cares -l zstd -l dl
else # dynamic linking
LDFLAGS_S3_DYNAMIC += -l curl -l z -l dl
endif

# Compiler and linker flags for S3 support
# "-Wno-overloaded-virtual" because AWS SDK shows a lot of warnings about this otherwise
ifeq ($(S3_SUPPORT), 1)
CXXFLAGS += -DS3_SUPPORT -Wno-overloaded-virtual
LDFLAGS  += -L $(EXTERNAL_PATH)/aws-sdk-cpp_install/lib* -l:libaws-sdk-all.a \
	$(LDFLAGS_S3_DYNAMIC) $(LDFLAGS_S3_STATIC)

  # Apply user-provided AWS SDK include dir if given
  ifeq ($(AWS_INCLUDE_DIR),)
  CXXFLAGS += -I $(EXTERNAL_PATH)/aws-sdk-cpp_install/include
  else
  CXXFLAGS += -I $(AWS_INCLUDE_DIR)
  endif

endif

# Use Microsoft mimalloc for memory allocations.
# Note: This needs to come as very last in link order, thus we have a separate variable to ensure
# it's the trailing arg for the linker. (Can be confirmed e.g. via MIMALLOC_SHOW_STATS=1)
ifeq ($(USE_MIMALLOC), 1)
CXXFLAGS += -DUSE_MIMALLOC
LDFLAGS_MIMALLOC_TAIL := -L external/mimalloc/build -l:libmimalloc.a
endif

# Support for uWS (Micro Web Sockets) HTTP service.
ifeq ($(ALTHTTPSVC_SUPPORT), 1)
CXXFLAGS += -DALTHTTPSVC_SUPPORT -I $(EXTERNAL_PATH)/uWebSockets/src \
	-I $(EXTERNAL_PATH)/uWebSockets/uSockets/src -DUWS_NO_ZLIB -DLIBUS_NO_SSL
LDFLAGS  += -L $(EXTERNAL_PATH)/uWebSockets/uSockets -l:uSockets.a
endif

# Support for Hadoop HDFS
# (Note: "lib/amd64/server" is for OpenJDK 1.8 on RHEL8.)
ifeq ($(HDFS_SUPPORT), 1)
CXXFLAGS += -DHDFS_SUPPORT -I $(HADOOP_HOME)/include
LDFLAGS  += -L $(HADOOP_HOME)/lib/native -l:libhdfs.a -L $(JAVA_HOME)/lib/server \
	-L $(JAVA_HOME)/lib/amd64/server -l jvm
endif

# Support for ncurses
ifeq ($(NCURSES_SUPPORT), 1)
CXXFLAGS += -DNCURSES_SUPPORT

  ifeq ($(BUILD_STATIC), 1)
    LDFLAGS += -lncursesw
  else # dynamic linking
    LDFLAGS += -lncurses
  endif

endif

# Support build in Cygwin environment
ifeq ($(CYGWIN_SUPPORT), 1)
# EXE_UNSTRIPPED includes EXE in definition, so must be updated first 
EXE_UNSTRIPPED     := $(EXE_UNSTRIPPED).exe
EXE                := $(EXE).exe

BACKTRACE_SUPPORT  := 0
LIBAIO_SUPPORT     := 0
SYNCFS_SUPPORT     := 0
LIBNUMA_SUPPORT    := 0
COREBIND_SUPPORT   := 0
SYSCALLH_SUPPORT   := 0

CXX_FLAVOR         := gnu++17
CXXFLAGS           += -DCYGWIN_SUPPORT
LDFLAGS_AIO        :=
LDFLAGS_NUMA       :=
endif

# Backtrace support
# Note: Gets set by CYGWIN_SUPPORT=1, so needs to come after that
ifeq ($(BACKTRACE_SUPPORT), 1)
CXXFLAGS += -DBACKTRACE_SUPPORT
endif

# libaio support
# Note: Gets set by CYGWIN_SUPPORT=1, so needs to come after that
ifeq ($(LIBAIO_SUPPORT), 1)
CXXFLAGS += -DLIBAIO_SUPPORT
endif

# syncfs() call support
# Note: Gets set by CYGWIN_SUPPORT=1, so needs to come after that
ifeq ($(SYNCFS_SUPPORT), 1)
CXXFLAGS += -DSYNCFS_SUPPORT
endif

# libnuma support
# Note: Gets set by CYGWIN_SUPPORT=1, so needs to come after that
ifeq ($(LIBNUMA_SUPPORT), 1)
CXXFLAGS += -DLIBNUMA_SUPPORT
endif

# CPU core binding support
# Note: Gets set by CYGWIN_SUPPORT=1, so needs to come after that
ifeq ($(COREBIND_SUPPORT), 1)
CXXFLAGS += -DCOREBIND_SUPPORT
endif

# sys/syscall.h include file support (for definition of SYS_..., e.g. SYS_gettid)
# Note: Gets set by CYGWIN_SUPPORT=1, so needs to come after that
ifeq ($(SYSCALLH_SUPPORT), 1)
CXXFLAGS += -DSYSCALLH_SUPPORT
endif

# Include build helpers for auto detection
include build_helpers/AutoDetection.mk


all: $(SOURCES) $(EXE)

$(EXE): $(EXE_UNSTRIPPED)
ifdef BUILD_VERBOSE
	$(STRIP) --strip-debug $(EXE_UNSTRIPPED) -o $(EXE)
else
	@echo [STRIP] $@ 
	@$(STRIP) --strip-debug $(EXE_UNSTRIPPED) -o $(EXE)
endif

$(EXE_UNSTRIPPED): $(OBJECTS)
ifdef BUILD_VERBOSE
	$(CXX) -o $(EXE_UNSTRIPPED) $(OBJECTS) $(LDFLAGS) $(LDFLAGS_MIMALLOC_TAIL)
else
	@echo [LINK] $@
	@$(CXX) -o $(EXE_UNSTRIPPED) $(OBJECTS) $(LDFLAGS) $(LDFLAGS_MIMALLOC_TAIL)
endif

.c.o:
ifdef BUILD_VERBOSE
	$(CXX) $(CXXFLAGS) -c $(@:.o=.c) -E -MMD -MF $(@:.o=.d) -MT $(@) -o /dev/null
	$(CXX) $(CXXFLAGS) -c $(@:.o=.c) -o $(@)
else
	@echo [DEP] $(@:.o=.d)
	@$(CXX) $(CXXFLAGS) -c $(@:.o=.c) -E -MMD -MF $(@:.o=.d) -MT $(@) -o /dev/null
	@echo [CXX] $@
	@$(CXX) $(CXXFLAGS) -c $(@:.o=.c) -o $(@)
endif

.cpp.o:
ifdef BUILD_VERBOSE
	$(CXX) $(CXXFLAGS) -c $(@:.o=.cpp) -E -MMD -MF $(@:.o=.d) -MT $(@) -o /dev/null
	$(CXX) $(CXXFLAGS) -c $(@:.o=.cpp) -o $(@)
else
	@echo [DEP] $(@:.o=.d)
	@$(CXX) $(CXXFLAGS) -c $(@:.o=.cpp) -E -MMD -MF $(@:.o=.d) -MT $(@) -o /dev/null
	@echo [CXX] $@
	@$(CXX) $(CXXFLAGS) -c $(@:.o=.cpp) -o $(@)
endif

# This is a special case because we need special compile options to get gcc to enable loop unrolling
# and SIMD conversion, hence the additional "CXXFLAGS_SPECIAL_SIMD".
source/toolkits/random/RandAlgoSelectorTk.o: source/toolkits/random/RandAlgoSelectorTk.cpp
ifdef BUILD_VERBOSE
	$(CXX) $(CXXFLAGS) -c $(@:.o=.cpp) -E -MMD -MF $(@:.o=.d) -MT $(@) -o /dev/null
	$(CXX) $(CXXFLAGS) $(CXXFLAGS_SPECIAL_SIMD) -c $(@:.o=.cpp) -o $(@)
else
	@echo [DEP] $(@:.o=.d)
	@$(CXX) $(CXXFLAGS) -c $(@:.o=.cpp) -E -MMD -MF $(@:.o=.d) -MT $(@) -o /dev/null
	@echo [CXX special SIMD] $@
	@$(CXX) $(CXXFLAGS) $(CXXFLAGS_SPECIAL_SIMD) -c $(@:.o=.cpp) -o $(@)
endif

$(OBJECTS): Makefile | externals features-info # Makefile dep to rebuild all on Makefile change

externals:
ifdef BUILD_VERBOSE
	PREP_AWS_SDK=$(S3_SUPPORT) AWS_LIB_DIR=$(AWS_LIB_DIR) AWS_INCLUDE_DIR=$(AWS_INCLUDE_DIR) \
		PREP_MIMALLOC=$(USE_MIMALLOC) PREP_UWS=$(ALTHTTPSVC_SUPPORT) \
		$(EXTERNAL_PATH)/prepare-external.sh
else
	@PREP_AWS_SDK=$(S3_SUPPORT) AWS_LIB_DIR=$(AWS_LIB_DIR) AWS_INCLUDE_DIR=$(AWS_INCLUDE_DIR) \
		PREP_MIMALLOC=$(USE_MIMALLOC) PREP_UWS=$(ALTHTTPSVC_SUPPORT) \
		$(EXTERNAL_PATH)/prepare-external.sh
endif

features-info:
ifeq ($(CUFILE_SUPPORT),1)
 ifdef BUILD_VERBOSE
	$(info [OPT] CUFILE (GDS) support enabled (CUFILE_INCLUDE_PATH: $(CUFILE_INCLUDE_PATH)))
 else
	$(info [OPT] CUFILE (GDS) support enabled)
 endif
else
	$(info [OPT] CUFILE (GDS) support disabled)
endif
ifeq ($(CUDA_SUPPORT),1)
 ifdef BUILD_VERBOSE
	$(info [OPT] CUDA support enabled (CUDA_INCLUDE_PATH: $(CUDA_INCLUDE_PATH)))
 else
	$(info [OPT] CUDA support enabled)
 endif
else
	$(info [OPT] CUDA support disabled)
endif
ifeq ($(S3_SUPPORT),1)
	$(info [OPT] S3 support enabled)
else
	$(info [OPT] S3 support disabled. (Enable via S3_SUPPORT=1))
endif
ifeq ($(USE_MIMALLOC),1)
	$(info [OPT] mimalloc enabled)
else
	$(info [OPT] mimalloc disabled)
endif
ifeq ($(ALTHTTPSVC_SUPPORT),1)
	$(info [OPT] Alternative HTTP service enabled)
else
	$(info [OPT] Alternative HTTP service disabled)
endif
ifeq ($(HDFS_SUPPORT),1)
	$(info [OPT] HDFS support enabled. (HADOOP_HOME: $(HADOOP_HOME); JAVA_HOME: $(JAVA_HOME)))
else
	$(info [OPT] HDFS support disabled)
endif
ifneq ($(NCURSES_SUPPORT),1)
	$(info [OPT] ncurses disabled)
endif

clean: clean-packaging clean-buildhelpers
ifdef BUILD_VERBOSE
	rm -rf $(OBJECTS_CLEANUP) $(DEPENDENCY_FILES) $(EXE) $(EXE).exe $(EXE_UNSTRIPPED) \
		$(EXE_UNSTRIPPED).exe
else
	@echo "[DELETE] OBJECTS, DEPENDENCY_FILES, EXECUTABLES"
	@rm -rf $(OBJECTS_CLEANUP) $(DEPENDENCY_FILES) $(EXE) $(EXE).exe $(EXE_UNSTRIPPED) \
		$(EXE_UNSTRIPPED).exe
endif

clean-externals:
ifdef BUILD_VERBOSE
	rm -f $(EXTERNAL_PATH)/alpine-chroot-install
	rm -rf $(EXTERNAL_PATH)/Simple-Web-Server 
	rm -rf $(EXTERNAL_PATH)/uWebSockets 
	rm -rf $(EXTERNAL_PATH)/aws-sdk-cpp $(EXTERNAL_PATH)/aws-sdk-cpp_install
	rm -rf $(EXTERNAL_PATH)/mimalloc
else
	@echo "[DELETE] EXTERNALS"
	@rm -f $(EXTERNAL_PATH)/alpine-chroot-install
	@rm -rf $(EXTERNAL_PATH)/Simple-Web-Server
	@rm -rf $(EXTERNAL_PATH)/uWebSockets 
	@rm -rf $(EXTERNAL_PATH)/aws-sdk-cpp $(EXTERNAL_PATH)/aws-sdk-cpp_install
	@rm -rf $(EXTERNAL_PATH)/mimalloc
endif

clean-packaging:
ifdef BUILD_VERBOSE
	rm -rf \
		$(EXE)-*-static-* \
		$(PACKAGING_PATH)/$(EXE_NAME)-*-static-*.tar.* \
	rm -rf \
		$(PACKAGING_PATH)/BUILDROOT \
		$(PACKAGING_PATH)/RPMS/* $(PACKAGING_PATH)/SPECS/rpm.spec
	bash -c "rm -rf $(PACKAGING_PATH)/$(EXE_NAME)*.{deb,ddeb,build,buildinfo,changes}"
else
	@echo "[DELETE] PACKAGING_FILES"
	@rm -rf \
		$(EXE)-*-static-* \
		$(PACKAGING_PATH)/$(EXE_NAME)-*-static-*.tar.* \
	@rm -rf \
		$(PACKAGING_PATH)/BUILDROOT \
		$(PACKAGING_PATH)/RPMS/* $(PACKAGING_PATH)/SPECS/rpm.spec
	@bash -c "rm -rf $(PACKAGING_PATH)/$(EXE_NAME)*.{deb,ddeb,build,buildinfo,changes}"
endif

clean-all: clean clean-externals clean-packaging clean-buildhelpers

install: all
	@echo "Installing elbencho..."
	
	install -p -m u=rwx,g=rx,o=rx $(EXE) $(INST_PATH)/
	install -p -m u=rwx,g=rx,o=rx dist/usr/bin/$(EXE_NAME)-chart $(INST_PATH)/
	install -p -m u=rwx,g=rx,o=rx dist/usr/bin/$(EXE_NAME)-scan-path $(INST_PATH)/
	
	install -p -m u=rwx,g=rx,o=rx -D dist/etc/bash_completion.d/$(EXE_NAME) \
		/etc/bash_completion.d/$(EXE_NAME)
	install -p -m u=rwx,g=rx,o=rx -D dist/etc/bash_completion.d/$(EXE_NAME)-chart \
		/etc/bash_completion.d/$(EXE_NAME)-chart

	@echo
	@echo "Installing contributed tools..."
	
	install -p -m u=rwx,g=rx,o=rx contrib/storage_sweep/mtelbencho.sh $(INST_PATH)/
	install -p -m u=rwx,g=rx,o=rx contrib/storage_sweep/graph_sweep.sh $(INST_PATH)/
	
	@echo
	@echo "NOTE: The $(EXE_NAME) executable was installed to $(INST_PATH). The sudo"
	@echo "  command might drop $(INST_PATH) from PATH. In case sudo is needed, the"
	@echo "  absolute path can be used. Or alternatively use a rpm/deb package."

uninstall:
	rm -f $(INST_PATH)/$(EXE_NAME)
	rm -f $(INST_PATH)/$(EXE_NAME)-chart
	rm -f $(INST_PATH)/$(EXE_NAME)-scan-path
	rm -f $(INST_PATH)/mtelbencho.sh
	rm -f $(INST_PATH)/graph_sweep.sh
	rm -f /etc/bash_completion.d/$(EXE_NAME)
	rm -f /etc/bash_completion.d/$(EXE_NAME)-chart

# prepare generic part of build-root (not the .rpm or .deb specific part)
prepare-buildroot: | all clean-packaging
	@echo "[PACKAGING] PREPARE BUILDROOT"

	mkdir -p $(PACKAGING_PATH)/BUILDROOT/$(PKG_INST_PATH)

	# copy main executable
	cp --preserve $(EXE) $(PACKAGING_PATH)/BUILDROOT/$(PKG_INST_PATH)

	# copy contents of dist subdir
	for dir in $(shell find dist/ -mindepth 1 -type d -printf "%P\n"); do \
		mkdir -p $(PACKAGING_PATH)/BUILDROOT/$$dir; \
	done

	for file in $(shell find dist/ -mindepth 1 -type f -printf "%P\n"); do \
		cp --preserve dist/$$file $(PACKAGING_PATH)/BUILDROOT/$$file; \
	done
	
	# copy contents of contrib subdir
	cp --preserve contrib/storage_sweep/mtelbencho.sh $(PACKAGING_PATH)/BUILDROOT/$(PKG_INST_PATH)
	cp --preserve contrib/storage_sweep/graph_sweep.sh $(PACKAGING_PATH)/BUILDROOT/$(PKG_INST_PATH)

rpm: | prepare-buildroot
	@echo "[PACKAGING] PREPARE RPM PACKAGE"

	cp $(PACKAGING_PATH)/SPECS/rpm.spec.template $(PACKAGING_PATH)/SPECS/rpm.spec
	sed -i "s/__NAME__/$(EXE_NAME)/" $(PACKAGING_PATH)/SPECS/rpm.spec
	sed -i "s/__VERSION__/$(EXE_VER_MAJOR).$(EXE_VER_MINOR).$(EXE_VER_PATCHLEVEL)/" \
		$(PACKAGING_PATH)/SPECS/rpm.spec
	
	rpmbuild $(PACKAGING_PATH)/SPECS/rpm.spec --bb --define "_topdir $(PWD)/$(PACKAGING_PATH)" \
		--define "__spec_install_pre /bin/true" --buildroot=$(PWD)/$(PACKAGING_PATH)/BUILDROOT
	
	@echo
	@echo "All done. Your package is here:"
	@find $(PACKAGING_PATH)/RPMS -name $(EXE_NAME)*.rpm

deb: | prepare-buildroot
	@echo "[PACKAGING] PREPARE DEB PACKAGE"

	cp -r $(PACKAGING_PATH)/debian $(PACKAGING_PATH)/BUILDROOT
	
	cp $(PACKAGING_PATH)/BUILDROOT/debian/control.template \
		$(PACKAGING_PATH)/BUILDROOT/debian/control

	sed -i "s/__NAME__/$(EXE_NAME)/" $(PACKAGING_PATH)/BUILDROOT/debian/control
	
	cd $(PACKAGING_PATH)/BUILDROOT && \
	EDITOR=/bin/true VISUAL=/bin/true DEBEMAIL=elbencho@localhost.localdomain debchange --create \
		--package elbencho --urgency low --noquery \
		--newversion "$(EXE_VER_MAJOR).$(EXE_VER_MINOR).$(EXE_VER_PATCHLEVEL)" \
		"Custom package build."
	
	cd $(PACKAGING_PATH)/BUILDROOT && \
		debuild -b -us -uc
	
	@echo
	@echo "All done. Your package is here:"
	@find $(PACKAGING_PATH) -name $(EXE_NAME)*.deb

version:
	@echo $(EXE_VERSION)

help:
	@echo 'Optional Build Features:'
	@echo '   ALTHTTPSVC_SUPPORT=0|1  - Build with support for alternative HTTP service.'
	@echo '                             (Default: 0)'
	@echo '   BACKTRACE_SUPPORT=0|1   - Build with backtrace support. (Default: 1)'
	@echo '   CUDA_SUPPORT=0|1        - Manually enable (=1) or disable (=0) support for'
	@echo '                             CUDA to work with GPU memory. By default, CUDA'
	@echo '                             support will be enabled when CUDA development files'
	@echo '                             are found. (cuda_runtime.h and libcudart.so)'
	@echo '   CUFILE_SUPPORT=0|1      - Manually enable (=1) or disable (=0) support for'
	@echo '                             GPUDirect Storage (GDS) through the cuFile API.'
	@echo '                             By default, GDS support will be enabled when GDS'
	@echo '                             development files are found. (cufile.h and'
	@echo '                             libcufile.so)'
	@echo '   CYGWIN_SUPPORT=0|1      - Reduce build features to enable build in Cygwin'
	@echo '                             environment. (Default: 0)'
	@echo '   HDFS_SUPPORT=0|1        - Build with support for Hadoop HDFS. HADOOP_HOME'
	@echo '                             and JAVA_HOME need to be set correctly so that'
	@echo '                             $$HADDOP_HOME/include/hdfs.h and'
	@echo '                             $$JAVA_HOME/lib/server/libjvm.so can be found.'
	@echo '                             (Default: 0)'
	@echo '   NCURSES_SUPPORT=0|1     - Link against ncurses for fullscreen live stats'
	@echo '                             support. (Default: 1)'
	@echo '   S3_SUPPORT=0|1          - Build with S3 support. This will fetch a AWS SDK'
	@echo '                             git repo of over 1GB size. (Default: 0)'
	@echo '   USE_MIMALLOC=0|1        - Use Microsoft mimalloc library for memory'
	@echo '                             allocation management. Recommended when using'
	@echo '                             musl-libc. (Default: 0)'
	@echo
	@echo 'Optional Compile/Link Arguments:'
	@echo '   BUILD_VERBOSE=1         - Enable verbose build output.'
	@echo '   BUILD_STATIC=1          - Generate a static binary without dependencies.'
	@echo '                             (Tested only on Alpine Linux.)'
	@echo '   BUILD_DEBUG=1           - Include debug info in executable.'
	@echo '   CXX=<string>            - Path to alternative C++ compiler. (Default: g++)'
	@echo '   CXX_FLAVOR=<string>     - C++ standard compiler flag. (Default: c++17)'
	@echo '   CXXFLAGS_EXTRA=<string> - Additional C++ compiler flags.'
	@echo '   LDFLAGS_EXTRA=<string>  - Additional linker flags.'
	@echo
	@echo 'Include and library paths:'
	@echo '   AWS_LIB_DIR=<path>         - If this is set in combination with S3_SUPPORT=1'
	@echo '                                then link against pre-built libs in given dir'
	@echo '                                instead of building the AWS SDK CPP.'
	@echo '   AWS_INCLUDE_DIR=<path>     - Include files path for AWS_LIB_DIR.'
	@echo '                                (Default: /usr/include")'
	@echo '   CUDA_INCLUDE_PATH=<path>   - Path to directory containing cuda_runtime.h.'
	@echo '                                (Default: search under /usr/local/cuda*")'
	@echo '   CUDA_LIB_PATH=<path>       - Path to directory containing libcudart.so.'
	@echo '                                (Default: search under /usr/local/cuda*")'
	@echo '   CUFILE_INCLUDE_PATH=<path> - Path to directory containing cufile.h.'
	@echo '                                (Default: search under /usr/local/cuda*")'
	@echo '   CUFILE_LIB_PATH=<path>     - Path to directory containing libcufile.so.'
	@echo '                                (Default: search under /usr/local/cuda*")'
	@echo
	@echo 'Targets:'
	@echo '   all (default)     - Build executable'
	@echo '   clean             - Remove build artifacts'
	@echo '   clean-all         - Remove build artifacts and external sources'
	@echo '   install           - Install executable to /usr/local/bin'
	@echo '   uninstall         - Uninstall executable from /usr/local/bin'
	@echo '   rpm               - Create RPM package file'
	@echo '   deb               - Create Debian package file'
	@echo '   help              - Print this help message'
	@echo
	@echo 'Note: Use "make clean-all" when changing any optional build features.'

.PHONY: clean clean-all clean-externals clean-packaging clean-buildhelpers deb externals \
features-info help prepare-buildroot rpm version

.DEFAULT_GOAL := all

# Include dependency files
ifneq ($(DEPENDENCY_FILES),)
include $(DEPENDENCY_FILES)
endif