Packages

glazer

0.2.0
0.5.17 0.5.16 0.5.15 0.5.14 retired 0.5.13 retired 0.5.12 retired 0.5.11 retired 0.5.10 retired 0.5.9 retired 0.5.8 retired 0.5.7 retired 0.5.6 retired 0.5.5 retired 0.5.4 retired 0.5.3 retired 0.5.2 retired 0.5.1 retired 0.5.0 retired 0.3.2 retired 0.3.0 retired 0.2.6 retired 0.2.5 retired 0.2.4 retired 0.2.3 retired 0.2.2 retired 0.2.1 retired 0.2.0 retired 0.1.7 retired 0.1.6 retired 0.1.5 retired 0.1.4 retired

Erlang NIF JSON encoder/decoder using the glaze C++ library

Retired package: Deprecated - Deprecated
HexDocs

Current section

Files

Jump to
Readme
31 Versions
0 Dependencies
Dependants
Files
Activity
glazer Makefile
Raw

Makefile 

ifndef VERBOSE

MAKEFLAGS += --no-print-directory

endif



PRIV_DIR := $(abspath priv)

OBJ_DIR  := $(abspath obj)

DEBUG    ?= 0

REBAR    ?= rebar3

APP      := $(shell sed -n '/application,/{s/^.*, //; s/,.*$$//; p; q}' src/*.app.src)



all: compile



help:

	@echo "Usage: make [target] [VAR=value ...]"

	@echo ""

	@echo "Build targets:"

	@echo "  all          Build NIF and compile Erlang (default)"

	@echo "  nif          Build only the C NIF shared library"

	@echo "  compile      Build NIF + run rebar3 compile"

	@echo "  optimize     PGO build: instrument → benchmark → rebuild (fastest binary)"

	@echo "  clean        Remove build artifacts"

	@echo "  distclean    Remove all generated files including deps"

	@echo ""

	@echo "Development:"

	@echo "  test         Run eunit test suite"

	@echo "  memcheck     Build with ASan (-fsanitize=address) and run eunit"

	@echo "  benchmark    Run benchmarks via mix bench"

	@echo "  deps         Fetch mix dependencies"

	@echo "  doc          Generate documentation"

	@echo ""

	@echo "Publishing:"

	@echo "  publish      Publish to hex.pm  (pass replace=1 to replace existing)"

	@echo "  deprecate    Deprecate a hex.pm release  (pass vsn=X.Y.Z)"

	@echo ""

	@echo "Variables:"

	@echo "  DEBUG=1      Build NIF without optimisations (-O0 -g)"

	@echo "  ASAN=1       Build with AddressSanitizer (implied by memcheck)"

	@echo "  VERBOSE=1    Show full compiler command lines"



nif: $(PRIV_DIR)/glazer.so



$(PRIV_DIR)/glazer.so: $(wildcard c_src/*.cpp c_src/*.hpp)

	@$(MAKE) -C c_src PRIV_DIR=$(PRIV_DIR) OBJ_DIR=$(OBJ_DIR) DEBUG=$(DEBUG) \

	  $(if $(VERBOSE),VERBOSE=1,) --no-print-directory



compile: $(PRIV_DIR)/glazer.so

	$(REBAR) compile



clean:

	$(REBAR) clean

	@$(MAKE) --no-print-directory -C c_src PRIV_DIR=$(PRIV_DIR) OBJ_DIR=$(OBJ_DIR) DEBUG=$(DEBUG) clean 2>/dev/null || true



distclean: clean

	@rm -rf obj priv/glazer.so _build



test:

	$(REBAR) eunit



# Locate the ASan runtime for LD_PRELOAD on Linux.

# macOS memcheck is not supported (DYLD_INSERT_LIBRARIES is dropped by the

# rebar3 shell wrapper before reaching erl), so this block is Linux-only.

# Try Clang's resource-dir path first; fall back to GCC's -print-file-name.

_CXX_RESOURCE_DIR := $(shell $(CXX) -print-resource-dir 2>/dev/null)

_HOST_ARCH        := $(shell uname -m)

_ASAN_CLANG       := $(_CXX_RESOURCE_DIR)/lib/linux/libclang_rt.asan-$(_HOST_ARCH).so

_ASAN_GCC         := $(shell $(CXX) -print-file-name=libasan.so 2>/dev/null)

ASAN_RT           := $(strip $(if $(wildcard $(_ASAN_CLANG)),$(_ASAN_CLANG),\

                       $(if $(filter-out $(notdir $(_ASAN_GCC)),$(_ASAN_GCC)),$(_ASAN_GCC))))

ASAN_PRELOAD       = LD_PRELOAD="$(ASAN_RT)"



memcheck:

	@echo "==> Building NIF with AddressSanitizer"

	@$(MAKE) -C c_src PRIV_DIR=$(PRIV_DIR) OBJ_DIR=$(OBJ_DIR) ASAN=1 \

	  $(if $(VERBOSE),VERBOSE=1,) clean all

	@$(REBAR) compile

	@echo "==> Running eunit under ASan ($(ASAN_PRELOAD))"

	ERL_FLAGS="+A 1" ASAN_OPTIONS="detect_leaks=0" \

	  $(ASAN_PRELOAD) \

	  $(REBAR) eunit

	@echo "==> Rebuilding normal NIF (removing ASan instrumentation)"

	@$(MAKE) -C c_src PRIV_DIR=$(PRIV_DIR) OBJ_DIR=$(OBJ_DIR) \

	  $(if $(VERBOSE),VERBOSE=1,) clean all

	@$(REBAR) compile



doc docs:

	$(REBAR) ex_doc



benchmark bench: deps

	@echo "Running benchmarks..."

	@mix bench



# Profile-guided optimisation: instrument → run tests as workload → rebuild.

# Usage: make optimize

optimize:

	@echo "==> PGO step 1/3: build instrumented binary"

	@$(MAKE) -C c_src PRIV_DIR=$(PRIV_DIR) OBJ_DIR=$(OBJ_DIR) PGO=generate clean all

	@$(REBAR) compile

	@echo "==> PGO step 2/3: collect profile data via test suite"

	mix bench 1>/dev/null

	@echo "==> PGO step 3/3: rebuild with profile data"

	@rm -f $(OBJ_DIR)/glazer_nif.o $(PRIV_DIR)/glazer.so

	@$(MAKE) -C c_src PRIV_DIR=$(PRIV_DIR) OBJ_DIR=$(OBJ_DIR) PGO=use all

	@$(REBAR) compile

	@echo "==> PGO build complete"



deps:

	@mix deps.get



publish: docs

	$(REBAR) hex publish$(if $(replace), --replace)



deprecate:

	@if [ -z $(vsn) ]; then \

	  echo "Usage: $(MAKE) $@ vsn=X.Y.Z      - Deprecate version X.Y.Z"; \

	  exit 1; \

	fi

	$(REBAR) hex retire $(APP) $(vsn) deprecated --message Deprecated



.PHONY: all help doc compile clean distclean test memcheck nif optimize benchmark bench deps publish deprecate