mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-12 13:24:21 +00:00
ecb0654da7
Remove the C and Go example wrappers that call Nimbus as a library, by removing the entire `wrappers/` directory. They are removed because they only wrap Whisper protocol support, which has been removed as it is obsolete. The only thing wrapped were Whisper functions, even though there were separate `go_wrapper_example` and `go_wrapper_whisper_example` programs. The wrappers don't build without Whisper in Nimbus, and without it, there isn't enough left for them to be useful examples. Also remove support for building the whole of Nimbus as a library, because there is nothing left using it. These targets are gone from the Makefile: - `wrappers` - `wrappers-static` - `libnimbus.so` - `libnimbus.a` The code isn't really gone, because it remains available in Git history. It may be useful someday, so a comment has been left in the Makefile for future generations: > This note is kept so that anyone wanting to build Nimbus as a library or call > from C or Go will know it has been done before. The previous working version > can be found in Git history. Look for the `nimbus-eth1` commit that adds > this comment and removes `wrappers/*`. Also worth a note, the library support was not tested on Windows, and the shared library support was only tested on Linux. Signed-off-by: Jamie Lokier <jamie@shareable.org>
154 lines
4.8 KiB
Makefile
154 lines
4.8 KiB
Makefile
# Copyright (c) 2018-2021 Status Research & Development GmbH. Licensed under
|
|
# either of:
|
|
# - Apache License, version 2.0
|
|
# - MIT license
|
|
# at your option. This file may not be copied, modified, or distributed except
|
|
# according to those terms.
|
|
|
|
SHELL := bash # the shell used internally by "make"
|
|
|
|
# used inside the included makefiles
|
|
BUILD_SYSTEM_DIR := vendor/nimbus-build-system
|
|
|
|
LINK_PCRE := 0
|
|
|
|
# we don't want an error here, so we can handle things later, in the ".DEFAULT" target
|
|
-include $(BUILD_SYSTEM_DIR)/makefiles/variables.mk
|
|
|
|
# debugging tools + testing tools
|
|
TOOLS := \
|
|
test_tools_build
|
|
TOOLS_DIRS := \
|
|
tests
|
|
# comma-separated values for the "clean" target
|
|
TOOLS_CSV := $(subst $(SPACE),$(COMMA),$(TOOLS))
|
|
|
|
.PHONY: \
|
|
all \
|
|
$(TOOLS) \
|
|
deps \
|
|
update \
|
|
nimbus \
|
|
test \
|
|
test-reproducibility \
|
|
clean \
|
|
libnimbus.so \
|
|
libnimbus.a \
|
|
libbacktrace
|
|
|
|
ifeq ($(NIM_PARAMS),)
|
|
# "variables.mk" was not included, so we update the submodules.
|
|
GIT_SUBMODULE_UPDATE := git submodule update --init --recursive
|
|
.DEFAULT:
|
|
+@ echo -e "Git submodules not found. Running '$(GIT_SUBMODULE_UPDATE)'.\n"; \
|
|
$(GIT_SUBMODULE_UPDATE); \
|
|
echo
|
|
# Now that the included *.mk files appeared, and are newer than this file, Make will restart itself:
|
|
# https://www.gnu.org/software/make/manual/make.html#Remaking-Makefiles
|
|
#
|
|
# After restarting, it will execute its original goal, so we don't have to start a child Make here
|
|
# with "$(MAKE) $(MAKECMDGOALS)". Isn't hidden control flow great?
|
|
|
|
else # "variables.mk" was included. Business as usual until the end of this file.
|
|
|
|
# default target, because it's the first one that doesn't start with '.'
|
|
all: | $(TOOLS) nimbus
|
|
|
|
# must be included after the default target
|
|
-include $(BUILD_SYSTEM_DIR)/makefiles/targets.mk
|
|
|
|
# default: use blst
|
|
USE_MIRACL := 0
|
|
|
|
# default: use nim native evm
|
|
ENABLE_EVMC := 0
|
|
|
|
# "-d:release" implies "--stacktrace:off" and it cannot be added to config.nims
|
|
ifeq ($(USE_LIBBACKTRACE), 0)
|
|
NIM_PARAMS := $(NIM_PARAMS) -d:debug -d:disable_libbacktrace
|
|
else
|
|
NIM_PARAMS := $(NIM_PARAMS) -d:release
|
|
endif
|
|
|
|
ifneq ($(USE_MIRACL), 0)
|
|
NIM_PARAMS := $(NIM_PARAMS) -d:BLS_FORCE_BACKEND=miracl
|
|
endif
|
|
|
|
ifneq ($(ENABLE_EVMC), 0)
|
|
NIM_PARAMS := $(NIM_PARAMS) -d:evmc_enabled
|
|
endif
|
|
|
|
# disabled by default, enable with ENABLE_VM2SLOW=1
|
|
ifneq ($(if $(ENABLE_VM2LOWMEM),$(ENABLE_VM2LOWMEM),0),0)
|
|
NIM_PARAMS := $(NIM_PARAMS) -d:vm2_enabled -d:lowmem:1
|
|
else
|
|
# disabled by default, enable with ENABLE_VM2=1
|
|
ifneq ($(if $(ENABLE_VM2),$(ENABLE_VM2),0),0)
|
|
NIM_PARAMS := $(NIM_PARAMS) -d:vm2_enabled
|
|
endif
|
|
endif
|
|
|
|
deps: | deps-common nat-libs nimbus.nims
|
|
ifneq ($(USE_LIBBACKTRACE), 0)
|
|
deps: | libbacktrace
|
|
endif
|
|
|
|
#- deletes and recreates "nimbus.nims" which on Windows is a copy instead of a proper symlink
|
|
update: | update-common
|
|
rm -rf nimbus.nims && \
|
|
$(MAKE) nimbus.nims $(HANDLE_OUTPUT)
|
|
|
|
# builds the tools, wherever they are
|
|
$(TOOLS): | build deps
|
|
for D in $(TOOLS_DIRS); do [ -e "$${D}/$@.nim" ] && TOOL_DIR="$${D}" && break; done && \
|
|
echo -e $(BUILD_MSG) "build/$@" && \
|
|
$(ENV_SCRIPT) nim c $(NIM_PARAMS) -o:build/$@ "$${TOOL_DIR}/$@.nim"
|
|
|
|
# a phony target, because teaching `make` how to do conditional recompilation of Nim projects is too complicated
|
|
nimbus: | build deps
|
|
echo -e $(BUILD_MSG) "build/$@" && \
|
|
$(ENV_SCRIPT) nim nimbus $(NIM_PARAMS) nimbus.nims
|
|
|
|
# symlink
|
|
nimbus.nims:
|
|
ln -s nimbus.nimble $@
|
|
|
|
# nim-libbacktrace
|
|
libbacktrace:
|
|
+ $(MAKE) -C vendor/nim-libbacktrace --no-print-directory BUILD_CXX_LIB=0
|
|
|
|
# builds and runs the test suite
|
|
test: | build deps
|
|
$(ENV_SCRIPT) nim test $(NIM_PARAMS) nimbus.nims
|
|
|
|
# primitive reproducibility test
|
|
test-reproducibility:
|
|
+ [ -e build/nimbus ] || $(MAKE) V=0 nimbus; \
|
|
MD5SUM1=$$($(MD5SUM) build/nimbus | cut -d ' ' -f 1) && \
|
|
rm -rf nimcache/*/nimbus && \
|
|
$(MAKE) V=0 nimbus && \
|
|
MD5SUM2=$$($(MD5SUM) build/nimbus | cut -d ' ' -f 1) && \
|
|
[ "$$MD5SUM1" = "$$MD5SUM2" ] && echo -e "\e[92mSuccess: identical binaries.\e[39m" || \
|
|
{ echo -e "\e[91mFailure: the binary changed between builds.\e[39m"; exit 1; }
|
|
|
|
# usual cleaning
|
|
clean: | clean-common
|
|
rm -rf build/{nimbus,$(TOOLS_CSV),all_tests,test_rpc}
|
|
ifneq ($(USE_LIBBACKTRACE), 0)
|
|
+ $(MAKE) -C vendor/nim-libbacktrace clean $(HANDLE_OUTPUT)
|
|
endif
|
|
|
|
# Note about building Nimbus as a library:
|
|
#
|
|
# There were `wrappers`, `wrappers-static`, `libnimbus.so` and `libnimbus.a`
|
|
# target scripts here, and C and Go examples for calling the Nimbus library in
|
|
# directory `wrappers/`. They have been removed because they only wrapped
|
|
# Whisper protocol support, which has been removed as it is obsolete.
|
|
#
|
|
# This note is kept so that anyone wanting to build Nimbus as a library or call
|
|
# from C or Go will know it has been done before. The previous working version
|
|
# can be found in Git history. Look for the `nimbus-eth1` commit that adds
|
|
# this comment and removes `wrappers/*`.
|
|
|
|
endif # "variables.mk" was not included
|