exqlite

#
# Makefile for building the NIF
#
# Makefile targets:
#
# all      build and install the NIF
# clean    clean build products and intermediates
# c-check  strict warnings and Clang static analysis for sqlite3_nif.c
#
# Variables to override:
#
# MIX_APP_PATH  path to the build directory
#
# CC            The C compiler
# CROSSCOMPILE  crosscompiler prefix, if any
# CFLAGS        compiler flags for compiling all C files
# LDFLAGS       linker flags for linking all binaries
# ERL_CFLAGS	additional compiler flags for files using Erlang header files
# ERL_EI_INCLUDE_DIR include path to header files (Possibly required for crosscompile)
#

ERL_INCLUDE := $(ERTS_INCLUDE_DIR)
ifeq ($(ERL_INCLUDE),)
	ERL_INCLUDE := $(shell erl -noshell -eval 'io:put_chars(filename:join([code:root_dir(), "erts-" ++ erlang:system_info(version), "include"])), halt().')
endif

SRC = c_src/sqlite3_nif.c

CFLAGS = -I"$(ERL_INCLUDE)"

ifeq ($(EXQLITE_USE_SYSTEM),)
	SRC += c_src/sqlite3.c
	CFLAGS += -Ic_src
else
	ifneq ($(EXQLITE_SYSTEM_LDFLAGS),)
		LDFLAGS += $(EXQLITE_SYSTEM_LDFLAGS)
	else
		# best attempt to link the system library
		# if the user didn't supply it in the environment
		LDFLAGS += -lsqlite3
	endif
endif

ifneq ($(DEBUG),)
	CFLAGS += -g
else
	CFLAGS += -DNDEBUG=1 -O2
endif

KERNEL_NAME := $(shell uname -s)

ifneq ($(findstring android,$(CC_PRECOMPILER_CURRENT_TARGET)),)
	CROSSCOMPILE ?= Android
endif

PREFIX = $(MIX_APP_PATH)/priv
BUILD  = $(MIX_APP_PATH)/obj
LIB_NAME = $(PREFIX)/sqlite3_nif.so
ARCHIVE_NAME = $(PREFIX)/sqlite3_nif.a

OBJ = $(SRC:c_src/%.c=$(BUILD)/%.o)

ifneq ($(CROSSCOMPILE),)
	ifeq ($(CROSSCOMPILE), Android)
		CFLAGS:=$(filter-out -O2,$(CFLAGS))
		CFLAGS += -fPIC -Os -z global
		LDFLAGS += -fPIC -shared -lm
	else ifeq ($(findstring linux,$(CROSSCOMPILE)),linux)
		CFLAGS:=$(filter-out -O2,$(CFLAGS))
		CFLAGS += -fPIC -Os -fvisibility=hidden
		LDFLAGS += -fPIC -shared
	else
		CFLAGS += -fPIC -fvisibility=hidden
		LDFLAGS += -fPIC -shared
	endif
else
	ifeq ($(KERNEL_NAME), Linux)
		CFLAGS += -fPIC -fvisibility=hidden
		LDFLAGS += -fPIC -shared
	endif
	ifeq ($(KERNEL_NAME), Darwin)
		CFLAGS += -fPIC
		LDFLAGS += -dynamiclib -undefined dynamic_lookup
	endif
	ifeq (MINGW, $(findstring MINGW,$(KERNEL_NAME)))
		CFLAGS += -fPIC
		LDFLAGS += -fPIC -shared
		LIB_NAME = $(PREFIX)/sqlite3_nif.dll
	endif
	ifeq ($(KERNEL_NAME), $(filter $(KERNEL_NAME),OpenBSD FreeBSD NetBSD SunOS))
		CFLAGS += -fPIC
		LDFLAGS += -fPIC -shared
	endif
endif

# ########################
# COMPILE TIME DEFINITIONS
# ########################

# For more information about these features being enabled, check out
# --> https://sqlite.org/compile.html
CFLAGS += -DSQLITE_THREADSAFE=1
CFLAGS += -DSQLITE_USE_URI=1
CFLAGS += -DSQLITE_LIKE_DOESNT_MATCH_BLOBS=1
CFLAGS += -DSQLITE_DQS=0
CFLAGS += -DHAVE_USLEEP=1

# TODO: The following features should be completely configurable by the person
#       installing the nif. Just need to have certain environment variables
#       enabled to support them.
CFLAGS += -DALLOW_COVERING_INDEX_SCAN=1
CFLAGS += -DENABLE_FTS3_PARENTHESIS=1
CFLAGS += -DENABLE_LOAD_EXTENSION=1
CFLAGS += -DENABLE_SOUNDEX=1
CFLAGS += -DENABLE_STAT4=1
CFLAGS += -DENABLE_UPDATE_DELETE_LIMIT=1
CFLAGS += -DSQLITE_ENABLE_FTS3=1
CFLAGS += -DSQLITE_ENABLE_FTS4=1
CFLAGS += -DSQLITE_ENABLE_FTS5=1
CFLAGS += -DSQLITE_ENABLE_GEOPOLY=1
CFLAGS += -DSQLITE_ENABLE_MATH_FUNCTIONS=1
CFLAGS += -DSQLITE_ENABLE_RBU=1
CFLAGS += -DSQLITE_ENABLE_RTREE=1
CFLAGS += -DSQLITE_OMIT_DEPRECATED=1
CFLAGS += -DSQLITE_ENABLE_DBSTAT_VTAB=1

# Add any extra flags set in the environment
ifneq ($(EXQLITE_SYSTEM_CFLAGS),)
	CFLAGS += $(EXQLITE_SYSTEM_CFLAGS)
endif

# Opt-in only. scripts/test-c-sanitizers.sh uses a separate Mix build tree
# and preloads ASan. Do not set SANITIZE for a release build.
ifneq ($(SANITIZE),)
	CFLAGS += -O1 -g -fno-omit-frame-pointer -fsanitize=$(SANITIZE) -fno-sanitize-recover=all
	LDFLAGS += -fsanitize=$(SANITIZE)
endif

CLANG ?= clang
# NIF and SQLite callback signatures keep unused parameters. -DNDEBUG also
# compiles out assert() uses of those parameters.
C_WARNINGS = -Wall -Wextra -Wformat=2 -Wshadow -Wno-unused-parameter -Werror

# Set Erlang-specific compile flags
# An empty -I"" is one shell word, "-I", and it swallows the next flag.
ifeq ($(CC_PRECOMPILER_CURRENT_TARGET),armv7l-linux-gnueabihf)
	ERL_CFLAGS ?= $(if $(PRECOMPILE_ERL_EI_INCLUDE_DIR),-I"$(PRECOMPILE_ERL_EI_INCLUDE_DIR)",)
else
	ERL_CFLAGS ?= $(if $(ERL_EI_INCLUDE_DIR),-I"$(ERL_EI_INCLUDE_DIR)",)
endif

ifneq ($(STATIC_ERLANG_NIF),)
	CFLAGS += -DSTATIC_ERLANG_NIF=1
endif

ifeq ($(STATIC_ERLANG_NIF),)
all: $(PREFIX) $(BUILD) $(LIB_NAME)
else
all: $(PREFIX) $(BUILD) $(ARCHIVE_NAME)
endif

$(BUILD)/%.o: c_src/%.c
	@echo " CC $(notdir $@)"
	$(CC) -c $(ERL_CFLAGS) $(CFLAGS) -MMD -MP -o $@ $<

# Include dependency files for automatic header tracking
-include $(OBJ:.o=.d)

$(LIB_NAME): $(OBJ)
	@echo " LD $(notdir $@)"
	$(CC) -o $@ $^ $(LDFLAGS)

$(ARCHIVE_NAME): $(OBJ)
	@echo " AR $(notdir $@)"
	$(AR) -rv $@ $^

$(PREFIX) $(BUILD):
	mkdir -p $@

clean:
	$(RM) $(LIB_NAME) $(ARCHIVE_NAME) $(OBJ) $(OBJ:.o=.d)

# Keep strict diagnostics on our wrapper, not the vendored amalgamation.
# analyzer-werror is separate from -Werror: findings must fail CI too.
c-check:
	$(CLANG) $(CFLAGS) -Ic_src $(C_WARNINGS) -fsyntax-only c_src/sqlite3_nif.c
	$(CLANG) $(CFLAGS) -Ic_src $(C_WARNINGS) --analyze \
	  -Xanalyzer -analyzer-output=text -Xanalyzer -analyzer-werror \
	  c_src/sqlite3_nif.c

.PHONY: all clean c-check

# Don't echo commands unless the caller exports "V=1"
${V}.SILENT: