-
Notifications
You must be signed in to change notification settings - Fork 16
/
Makefile
439 lines (311 loc) · 11.9 KB
/
Makefile
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
ifeq ($(VG),docker)
override VG:=1
VG_DOCKER=1
endif
ifeq ($(VG),1)
export MEMCHECK=1
endif
ifneq ($(SAN),)
export MEMCHECK=1
endif
#----------------------------------------------------------------------------------------------
.NOTPARALLEL:
ROOT=.
MK.cmake=1
SRCDIR=.
include $(ROOT)/deps/readies/mk/main
MK_ALL_TARGETS=bindirs deps build
MK_CUSTOM_CLEAN=1
BINDIR=$(BINROOT)/src
export TARGET=$(BINROOT)/src/falkordb.so
#----------------------------------------------------------------------------------------------
define HELPTEXT
make all # Build everything
DEBUG=1 # Build for debugging
SLOW=1 # Disable parallel build
STATIC_OMP=1 # Link OpenMP statically
VARIANT=name # Add `name` to build products directory
GCC=1 # Build with GCC toolchain (default nor Linux)
CLANG=1 # Build with CLang toolchain (default for macOS)
COV=1 # Build for coverage analysis (implies DEBUG=1)
VG=1|docker # build for Valgrind
SAN=type # build with LLVM sanitizer (type=address|memory|leak|thread)
make clean # Clean build products
ALL=1 # Completely remove build products
DEPS=1 # Also clean dependant modules
AUTOGEN=1 # Remove autogen-generated files
make pack|package # Build RAMP packages
make run # Run redis-server with falkordb
GDB=1 # Run with debugger
make test # Run tests
HELP=1 # Show testing options
LIST=1 # List all tests, do not execute
UNIT=1 # Run unit tests
FLOW=1 # Run flow tests (Python)
TCK=1 # Run TCK framework tests
COV=1 # Perform coverage analysis
SLOW=1 # Do not run in parallel
PARALLEL=n # Set testing parallelism
GDB=1 # RLTest interactive debugging
TEST=test # Run specific test
TESTFILE=file # Run tests listed in file
FAILFILE=file # Write failed tests to file
make unit-tests # Run unit tests
make flow-tests # Run flow tests
make tck-tests # Run TCK tests
make fuzz-tests # Run fuzz tester
TIMEOUT=secs # Timeout in `secs`
make benchmark # Run benchmarks
REMOTE=1 # Run remotely
make coverage # Perform coverage analysis (build & test)
make cov-upload # Upload coverage data to codecov.io
make upload-artifacts # copy snapshot packages to S3
OSNICK=nick # copy snapshots for specific OSNICK
make upload-release # copy release packages to S3
common options for upload operations:
STAGING=1 # copy to staging lab area (for validation)
FORCE=1 # allow operation outside CI environment
VERBOSE=1 # show more details
NOP=1 # do not copy, just print commands
make docker # build for specified platform
OSNICK=nick # platform to build for (default: host platform)
TEST=1 # run tests after build
PACK=1 # create package
ARTIFACTS=1 # copy artifacts to host
endef
#----------------------------------------------------------------------------------------------
ifeq ($(MEMCHECK),1)
DEPS_BINDIR=$(ROOT)/bin/$(FULL_VARIANT)
DEPS_DEBUG=1
CMAKE_DEFS += MEMCHECK=ON
else
export DEPS_BINDIR:=$(ROOT)/bin/$(FULL_VARIANT.release)
DEPS_DEBUG=
endif
#----------------------------------------------------------------------------------------------
RAX_DIR = $(ROOT)/deps/rax
export RAX_BINDIR=$(DEPS_BINDIR)/rax
include $(ROOT)/build/rax/Makefile.defs
LIBXXHASH_DIR = $(ROOT)/deps/xxHash
export LIBXXHASH_BINDIR=$(DEPS_BINDIR)/xxHash
include $(ROOT)/build/xxHash/Makefile.defs
LIBCYPHER_PARSER_DIR = $(ROOT)/deps/libcypher-parser
LIBCYPHER_PARSER_SRCDIR = $(LIBCYPHER_PARSER_DIR)/lib/src
export LIBCYPHER_PARSER_BINDIR=$(DEPS_BINDIR)/libcypher-parser
include $(ROOT)/build/libcypher-parser/Makefile.defs
GRAPHBLAS_DIR = $(ROOT)/deps/GraphBLAS
export GRAPHBLAS_BINDIR=$(DEPS_BINDIR)/GraphBLAS
include $(ROOT)/build/GraphBLAS/Makefile.defs
UTF8PROC_DIR = $(ROOT)/deps/utf8proc
export UTF8PROC_BINDIR=$(DEPS_BINDIR)/utf8proc
include $(ROOT)/build/utf8proc/Makefile.defs
ONIGURUMA_DIR = $(ROOT)/deps/oniguruma
export ONIGURUMA_BINDIR=$(DEPS_BINDIR)/oniguruma
include $(ROOT)/build/oniguruma/Makefile.defs
REDISEARCH_DIR = $(ROOT)/deps/RediSearch
export REDISEARCH_BINROOT=$(BINROOT)
include $(ROOT)/build/RediSearch/Makefile.defs
FalkorDBRS_DIR = $(ROOT)/deps/FalkorDB-rs
export FalkorDBRS_BINDIR=$(BINROOT)/FalkorDB-rs
include $(ROOT)/build/FalkorDB-rs/Makefile.defs
BIN_DIRS += $(REDISEARCH_BINROOT)/search-static
LIBS=$(RAX) $(LIBXXHASH) $(GRAPHBLAS) $(REDISEARCH_LIBS) $(LIBCYPHER_PARSER) $(UTF8PROC) $(ONIGURUMA) $(FalkorDBRS)
#----------------------------------------------------------------------------------------------
CC_COMMON_H=$(SRCDIR)/src/common.h
CC_C_STD=gnu11
CC_OPENMP=1
include $(MK)/defs
$(info # Building into $(BINDIR))
$(info # Using CC=$(CC))
ifeq ($(UNIT_TESTS),1)
CMAKE_DEFS += UNIT_TESTS:BOOL=on
endif
#----------------------------------------------------------------------------------------------
MISSING_DEPS:=
ifeq ($(wildcard $(RAX)),)
MISSING_DEPS += $(RAX)
endif
ifeq ($(wildcard $(LIBXXHASH)),)
MISSING_DEPS += $(LIBXXHASH)
endif
ifeq ($(wildcard $(GRAPHBLAS)),)
MISSING_DEPS += $(GRAPHBLAS)
endif
ifeq ($(wildcard $(LIBCYPHER_PARSER)),)
MISSING_DEPS += $(LIBCYPHER_PARSER)
endif
ifeq ($(wildcard $(UTF8PROC)),)
MISSING_DEPS += $(UTF8PROC)
endif
ifeq ($(wildcard $(ONIGURUMA)),)
MISSING_DEPS += $(ONIGURUMA)
endif
ifneq ($(call files_missing,$(REDISEARCH_LIBS)),)
MISSING_DEPS += $(REDISEARCH_LIBS)
endif
MISSING_DEPS += falkordbrs
ifneq ($(MISSING_DEPS),)
DEPS=1
endif
DEPENDENCIES=libcypher-parser graphblas redisearch rax libxxhash utf8proc oniguruma falkordbrs
ifneq ($(filter all deps $(DEPENDENCIES) pack,$(MAKECMDGOALS)),)
DEPS=1
endif
.PHONY: deps $(DEPENDENCIES)
#----------------------------------------------------------------------------------------------
RUN_CMD=redis-server --loadmodule $(abspath $(TARGET))
#----------------------------------------------------------------------------------------------
MK_ALL_TARGETS=bindirs deps build
.PHONY: all deps clean lint format pack run tests unit_tests flow_tests docker bindirs
all: bindirs $(TARGET)
include $(MK)/rules
#----------------------------------------------------------------------------------------------
ifeq ($(DEPS),1)
deps: $(LIBCYPHER_PARSER) $(GRAPHBLAS) $(LIBXXHASH) $(RAX) $(REDISEARCH_LIBS) $(UTF8PROC) $(ONIGURUMA) falkordbrs
libxxhash: $(LIBXXHASH)
$(LIBXXHASH):
@echo Building $@ ...
$(SHOW)$(MAKE) --no-print-directory -C $(ROOT)/build/xxHash DEBUG=$(DEPS_DEBUG)
rax: $(RAX)
$(RAX):
@echo Building $@ ...
$(SHOW)$(MAKE) --no-print-directory -C $(ROOT)/build/rax DEBUG=$(DEPS_DEBUG)
graphblas: $(GRAPHBLAS)
GRAPHBLAS_MAKE_FLAGS.xenial-x64=CC=gcc-5 CXX=gxx-5
$(GRAPHBLAS):
@echo Building $@ ...
$(SHOW)$(MAKE) --no-print-directory -C $(ROOT)/build/GraphBLAS DEBUG=$(DEPS_DEBUG) $(GRAPHBLAS_MAKE_FLAGS.$(OSNICK)-$(ARCH))
libcypher-parser: $(LIBCYPHER_PARSER)
$(LIBCYPHER_PARSER):
@echo Building $@ ...
$(SHOW)$(MAKE) --no-print-directory -C $(ROOT)/build/libcypher-parser DEBUG=$(DEPS_DEBUG)
utf8proc: $(UTF8PROC)
$(UTF8PROC):
@echo Building $@ ...
$(SHOW)$(MAKE) --no-print-directory -C $(ROOT)/build/utf8proc DEBUG=$(DEPS_DEBUG)
oniguruma: $(ONIGURUMA)
$(ONIGURUMA):
@echo Building $@ ...
$(SHOW)$(MAKE) --no-print-directory -C $(ROOT)/build/oniguruma DEBUG=$(DEPS_DEBUG)
redisearch: $(REDISEARCH_LIBS)
$(REDISEARCH_LIBS):
@echo Building $@ ...
$(SHOW)$(MAKE) -C $(REDISEARCH_DIR) STATIC=1 BINROOT=$(REDISEARCH_BINROOT) CC=$(CC) CXX=$(CXX)
ifneq ($(DEBUG),1)
CARGO_FLAGS=--release
endif
ifneq ($(SAN),)
export RUSTFLAGS=-Zsanitizer=$(SAN)
CARGO_FLAGS=--target x86_64-unknown-linux-gnu
endif
falkordbrs:
@echo Building $@ ...
cd deps/FalkorDB-rs && cargo build $(CARGO_FLAGS) --features falkordb_allocator --target-dir $(FalkorDBRS_BINDIR)
.PHONY: libcypher-parser graphblas redisearch libxxhash rax utf8proc oniguruma falkordbrs
#----------------------------------------------------------------------------------------------
else
deps: ;
endif # DEPS
.PHONY: deps
#----------------------------------------------------------------------------------------------
$(LIBCYPHER_PARSER_BINDIR)/lib/src/cypher-parser.h : $(LIBCYPHER_PARSER)
#----------------------------------------------------------------------------------------------
clean:
ifeq ($(ALL),1)
$(SHOW)-rm -rf $(BINROOT) $(DEPS_BINDIR)
$(SHOW)$(MAKE) -C $(ROOT)/build/libcypher-parser clean ALL=1
else
$(SHOW)$(MAKE) -C $(BINDIR) clean
$(SHOW)-rm -fr $(TARGET).debug $(BINDIR)/CMakeCache.txt $(BINDIR)/tests
ifeq ($(DEPS),1)
$(SHOW)$(MAKE) -C $(ROOT)/build/rax clean DEBUG=$(DEPS_DEBUG)
$(SHOW)$(MAKE) -C $(ROOT)/build/xxHash clean DEBUG=$(DEPS_DEBUG)
$(SHOW)$(MAKE) -C $(ROOT)/build/utf8proc clean DEBUG=$(DEPS_DEBUG)
$(SHOW)$(MAKE) -C $(ROOT)/build/oniguruma clean DEBUG=$(DEPS_DEBUG)
$(SHOW)$(MAKE) -C $(ROOT)/build/GraphBLAS clean DEBUG=$(DEPS_DEBUG)
$(SHOW)$(MAKE) -C $(ROOT)/build/libcypher-parser clean DEBUG=$(DEPS_DEBUG)
$(SHOW)$(MAKE) -C $(REDISEARCH_DIR) clean ALL=1 BINROOT=$(REDISEARCH_BINROOT)
endif
endif
clean-libcypher-parser:
$(SHOW)$(MAKE) -C $(ROOT)/build/libcypher-parser clean ALL=1 AUTOGEN=1
clean-search:
ifeq ($(ALL),1)
$(SHOW)rm -rf $(REDISEARCH_BINROOT)/search-static
else
$(SHOW)$(MAKE) -C $(REDISEARCH_DIR) clean BINROOT=$(REDISEARCH_BINROOT)
endif
.PHONY: clean clean-libcypher-parser clean-search
#----------------------------------------------------------------------------------------------
pack package: #$(TARGET)
@MODULE=$(realpath $(TARGET)) $(ROOT)/sbin/pack.sh
upload-release:
$(SHOW)RELEASE=1 ./sbin/upload-artifacts
upload-artifacts:
$(SHOW)SNAPSHOT=1 ./sbin/upload-artifacts
.PHONY: pack package upload-artifacts upload-release
#----------------------------------------------------------------------------------------------
ifeq ($(SLOW),1)
_RLTEST_PARALLEL=0
else ifneq ($(PARALLEL),)
_RLTEST_PARALLEL=$(PARALLEL)
else
_RLTEST_PARALLEL=1
endif
ifneq ($(BUILD),0)
TEST_DEPS=$(TARGET)
endif
test: unit-tests flow-tests tck-tests
unit-tests:
ifneq ($(BUILD),0)
$(SHOW)$(MAKE) build FORCE=1 UNIT_TESTS=1
endif
$(SHOW)BINROOT=$(BINROOT) ./tests/unit/tests.sh
flow-tests: $(TEST_DEPS)
$(SHOW)MODULE=$(TARGET) BINROOT=$(BINROOT) PARALLEL=$(_RLTEST_PARALLEL) GEN=$(GEN) AOF=$(AOF) TCK=0 ./tests/flow/tests.sh
tck-tests: $(TEST_DEPS)
$(SHOW)MODULE=$(TARGET) BINROOT=$(BINROOT) PARALLEL=$(_RLTEST_PARALLEL) GEN=0 AOF=0 TCK=1 ./tests/flow/tests.sh
.PHONY: test unit-tests flow-tests tck-tests
#----------------------------------------------------------------------------------------------
ifneq ($(TIMEOUT),)
FUZZ_ARGS=-t $(TIMEOUT)
endif
fuzz fuzz-tests: $(TARGET)
$(SHOW)cd tests/fuzz && ./process.py -m $(TARGET) $(FUZZ_ARGS)
.PHONY: fuzz fuzz-tests
#----------------------------------------------------------------------------------------------
ifneq ($(REMOTE),)
BENCHMARK_ARGS=run-remote
else
BENCHMARK_ARGS=run-local
endif
BENCHMARK_ARGS += --module_path $(TARGET) --required-module graph
ifneq ($(BENCHMARK),)
BENCHMARK_ARGS += --test $(BENCHMARK)
endif
benchmark: $(TARGET)
$(SHOW)cd tests/benchmarks && redisbench-admin $(BENCHMARK_ARGS)
.PHONY: benchmark
#----------------------------------------------------------------------------------------------
COV_EXCLUDE_DIRS += \
deps \
src/util/sds \
tests
COV_EXCLUDE+=$(foreach D,$(COV_EXCLUDE_DIRS),'$(realpath $(ROOT))/$(D)/*')
coverage:
$(SHOW)$(MAKE) build COV=1
$(SHOW)$(COVERAGE_RESET)
-$(SHOW)$(MAKE) unit-tests COV=1
-$(SHOW)$(MAKE) flow-tests COV=1
-$(SHOW)$(MAKE) tck-tests COV=1
$(SHOW)$(COVERAGE_COLLECT_REPORT)
.PHONY: coverage
#----------------------------------------------------------------------------------------------
docker:
$(SHOW)$(MAKE) -C build/docker
ifneq ($(wildcard /w/*),)
SANBOX_ARGS += -v /w:/w
endif
sanbox:
@docker run -it -v $(PWD):/build -w /build --cap-add=SYS_PTRACE --security-opt seccomp=unconfined $(SANBOX_ARGS) redisfab/clang:16-$(ARCH)-bullseye bash
.PHONY: box sanbox