libpg-query-node/native/Makefile at 0e4eeb047afd783a6dbbba14f7c90574c6d4a519 · ashbyhq/libpg-query-node · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
LIBPG_QUERY_REPO := https://github.com/pganalyze/libpg_query.git
LIBPG_QUERY_TAG := 18.0.0

OS := $(shell uname -s)
ARCH := $(shell uname -m)

ifeq ($(OS),Darwin)
PLATFORM := darwin
else ifeq ($(OS),Linux)
PLATFORM := linux
else
$(error Unsupported platform: $(OS))
endif

ifeq ($(ARCH),x86_64)
NODE_ARCH := x64
else ifeq ($(ARCH),aarch64)
NODE_ARCH := arm64
else ifeq ($(ARCH),arm64)
NODE_ARCH := arm64
else
NODE_ARCH := $(ARCH)
endif

# Detect musl libc (Alpine) by the presence of its dynamic loader.
# More reliable than parsing `ldd --version`, which varies across distros.
ifneq ($(wildcard /lib/ld-musl-*),)
PLATFORM_SUFFIX := -musl
else
PLATFORM_SUFFIX :=
endif

# PLATFORM_KEY can be overridden (e.g. `make build PLATFORM_KEY=linux-x64-musl`)
# so CI can pin the output dir to the known target instead of relying on detection.
PLATFORM_KEY ?= $(PLATFORM)-$(NODE_ARCH)$(PLATFORM_SUFFIX)
CACHE_DIR := .cache/$(PLATFORM_KEY)
LIBPG_QUERY_DIR := $(CACHE_DIR)/libpg_query

LIBPG_QUERY_LIB := $(LIBPG_QUERY_DIR)/libpg_query.a

NODE_ADDON_API_DIR := $(shell node -p "require('node-addon-api').include_dir" 2>/dev/null || echo "node_modules/node-addon-api")
NODE_INCLUDE := $(shell node -p "require('node-api-headers').include_dir" 2>/dev/null || echo "")

OUT_DIR := prebuilds/$(PLATFORM_KEY)
OUT_FILE := $(OUT_DIR)/libpg_query_native.node

CXXFLAGS := -O2 -std=c++17 -fPIC -DNAPI_VERSION=8 -DNODE_ADDON_API_DISABLE_DEPRECATED
LDFLAGS :=

ifeq ($(PLATFORM),darwin)
LDFLAGS += -undefined dynamic_lookup -dynamiclib
else
LDFLAGS += -shared
endif

INCLUDES := \
	-I$(LIBPG_QUERY_DIR) \
	-I$(LIBPG_QUERY_DIR)/vendor \
	-I$(NODE_ADDON_API_DIR) \
	$(if $(NODE_INCLUDE),-I$(NODE_INCLUDE),)

# Clone and build libpg_query. Clone into a temp dir and move into place only on
# success, so an interrupted clone can't leave a poisoned (partial) cache dir
# that later builds would mistake for a complete checkout.
$(LIBPG_QUERY_DIR):
	mkdir -p $(CACHE_DIR)
	rm -rf $(LIBPG_QUERY_DIR).tmp
	git clone -b $(LIBPG_QUERY_TAG) --single-branch --depth 1 $(LIBPG_QUERY_REPO) $(LIBPG_QUERY_DIR).tmp
	# Local patches, applied before the move so a failed patch can't leave a
	# poisoned cache dir. patches/*.patch documents what each one is for; a
	# conflict on a libpg_query bump fails the build loudly, which is the
	# desired signal that the patch needs rebasing or upstreaming succeeded.
	# git apply rather than patch(1): the musl builds run in Alpine containers
	# that don't ship patch, but git is guaranteed here — this recipe just ran
	# git clone.
	cd $(LIBPG_QUERY_DIR).tmp && for p in $(CURDIR)/patches/*.patch; do git apply $$p; done
	mv $(LIBPG_QUERY_DIR).tmp $(LIBPG_QUERY_DIR)

$(LIBPG_QUERY_LIB): $(LIBPG_QUERY_DIR)
	cd $(LIBPG_QUERY_DIR) && $(MAKE) build

# Build the .node addon
$(OUT_FILE): src/addon.cc $(LIBPG_QUERY_LIB)
	mkdir -p $(OUT_DIR)
	$(CXX) $(CXXFLAGS) $(INCLUDES) \
		src/addon.cc \
		$(LIBPG_QUERY_LIB) \
		$(LDFLAGS) \
		-lpthread \
		-o $(OUT_FILE)
	@echo "Built $(OUT_FILE) ($$(du -h $(OUT_FILE) | cut -f1))"

.PHONY: build clean clean-cache deps info

build: $(OUT_FILE)

deps: $(LIBPG_QUERY_LIB)

clean:
	rm -rf prebuilds

clean-cache:
	rm -rf .cache

info:
	@echo "Platform:     $(PLATFORM_KEY)"
	@echo "libpg_query:  $(LIBPG_QUERY_TAG)"
	@echo "Output:       $(OUT_FILE)"
	@echo "Node API dir: $(NODE_ADDON_API_DIR)"
	@echo ""
	@echo "For jemalloc memory benefits, use LD_PRELOAD:"
	@echo "  Linux:  LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so node app.js"
	@echo "  macOS:  DYLD_INSERT_LIBRARIES=/opt/homebrew/lib/libjemalloc.dylib node app.js"