Makefile

#
# Copyright 2020, Offchain Labs, Inc. All rights reserved.
#

# Add your mexe as an output file
generics_files = basic simple nested func closure colorful queue
generics_outputs = $(patsubst %,generics/%, $(generics_files))

minitest_outputs = arithmetic codeloadtest default globaltest modexp simple-closure closure stack-safety quick wide-tuples $(generics_outputs)
upgrade_outputs = regcopy_new regcopy_old upgrade1_new upgrade1_old
looptest_outputs = upgrade2_new upgrade2_old
builtin_outputs = arraytest kvstest maptest
stdlib_outputs = addressSetTest biguinttest blstest bytearraytest expandingIntArrayTest fixedpointtest keccaktest priorityqtest queuetest ripemd160test rlptest storageMapTest sha256test
stdlib2_outputs = arraytest priorityqtest

builtin_mexes = $(patsubst %,builtin/%.mexe, $(builtin_outputs))
stdlib_mexes = $(patsubst %,stdlib/%.mexe, $(stdlib_outputs))
stdlib2_mexes = $(patsubst %,stdlib2/%.mexe, $(stdlib2_outputs))
minitest_mexes = $(patsubst %,minitests/%.mexe, $(minitest_outputs))
upgrade_mexes = $(patsubst %,upgradetests/%.mexe, $(upgrade_outputs))
looptest_mexes = $(patsubst %,looptest/%.mexe, $(looptest_outputs))

libs_mexes = $(builtin_mexes) $(stdlib_mexes) $(minitest_mexes)
test_mexes = $(builtin_mexes) $(stdlib_mexes) $(stdlib2_mexes) $(minitest_mexes) $(upgrade_mexes) $(looptest_mexes)

target = ./target/release/mini

compile = ./target/release/mini compile $(compile_options)
upgrade = ./target/release/mini gen-upgrade-code
run     = ./target/release/mini

consts = arb_os/constants.json
globals = arb_os/globals.txt
done = "\e[38;5;161;1mdone!\e[0;0m\n"

# user targets

.make/all: always arb_os/arbos.mexe $(test_mexes) arb_os/arbos-upgrade.mexe arb_os/upgrade.json .make/test
	@printf "\e[38;5;161;1mdone building %s\e[0;0m\n" $$(expr $$(echo $? | wc -w) - 1)
	@touch .make/all

arbos: arb_os/arbos.mexe
	@printf $(done)

upgrade: arb_os/arbos-upgrade.mexe arb_os/upgrade.json
	@printf $(done)

libs: .make/libs
	cargo test --release
	@printf $(done)

contracts: .make/solidity
	@printf $(done)

paramslist: parameters.json
	@printf $(done)

evmtest: arb_os/arbos.mexe .make/tools
	$(run) evm-tests

evmlogs: evm-test-logs
	@printf $(done)

evmdebug: arb_os/arbos.mexe .make/tools
	$(run) evm-debug

replay: replayTests
	@printf $(done)

coverage: always lcov-mini.info
	@printf $(done)

benchmark: arb_os/arbos.mexe .make/tools
	$(run) make-benchmarks

test: .make/test
	cargo test --release

push: .make/push
	@printf "\e[38;5;161;1mReady for push!\e[0;0m\n"

ci: .make/all replayTests lcov-mini.info
	@printf "Made ci products\n"

clean:
	@rm -f {builtin,stdlib,upgradetests,minitests,looptest}/*.mexe arb_os/{arbos,arbos-upgrade}.mexe
	@rm -f minitests/generics/*.mexe
	@rm -f arbos/{upgrade.json,contractTemplates.mini}
	@rm -rf contracts/artifacts contracts/cache
	@rm -f */*.cov lcov.info lcov-mini.info logs/* .make/*


# pattern rules

builtin/%.mexe: builtin/%.mini builtin/*.mini $(consts) .make/tools
	$(compile) -c $(consts) $< -o $@ -t

stdlib/%.mexe: stdlib/%.mini stdlib/*.mini builtin/*.mini $(consts) .make/tools
	$(compile) -c $(consts) $< -o $@ -t

stdlib2/%.mexe: stdlib2/%.mini stdlib2/*.mini builtin/*.mini $(consts) .make/tools
	$(compile) -c $(consts) $< -o $@ -t

minitests/%.mexe: minitests/%.mini minitests/*.mini stdlib/*.mini builtin/*.mini $(consts) .make/tools
	$(compile) -c $(consts) $< -o $@ -t

upgradetests/%.mexe: upgradetests/%.mini upgradetests/*.mini stdlib/*.mini builtin/*.mini $(consts) .make/tools
	$(compile) -c $(consts) $< -o $@ -t

arb_os/arbos.mexe: arb_os/*.mini arb_os/bridge_arbos_versions.mini arb_os/contractTemplates.mini stdlib/*.mini builtin/*.mini $(consts) $(globals) .make/tools
	$(compile) arb_os -o $@ -m

parameters.json: arb_os/constants.json .make/tools
	$(run) make-parameters-list -c arb_os/constants.json > $<

replayTests: arb_os/arbos.mexe .make/tools
	mkdir -p testlogs replayTests
	$(run) make-test-logs > /dev/null
	mv testlogs/* replayTests/

evm-test-logs: arb_os/arbos.mexe .make/tools
	rm -rf evm-test-logs
	mkdir -p evm-test-logs
	$(run) evm-tests --savelogs

arb_os/contractTemplates.mini: .make/tools
	$(run) make-templates


# Upgrade tests

upgradetests/upgrade1_new.mexe: upgradetests/upgrade1_new.mini $(consts) .make/tools
	$(compile) -c $(consts) $< -o $@

looptest/upgrade2_new.mexe: looptest/upgrade2_new.mini looptest/*.mini looptest/upgrade2.toml .make/tools
	$(compile) looptest/upgrade2_new.mini -c $(consts) -o $@

looptest/bridge2.mini upgradetests/impl2.mini &: looptest/upgrade2_base.mexe looptest/upgrade2_old.mexe looptest/upgrade2.toml .make/tools
	$(upgrade) looptest/upgrade2_old.mexe $< looptest/bridge2.mini impl2 looptest/upgrade2.toml

looptest/upgrade2_base.mexe: looptest/upgrade2_new.mini .make/tools
	$(compile) $< -c arb_os/constants.json -o looptest/upgrade2_base.mexe

looptest/upgrade2_old.mexe: looptest/upgrade2_old.mini stdlib/*.mini builtin/*.mini .make/tools
	$(compile) -c $(consts) $< -o $@ -t


# ArbOS upgrade
arbos_source_all = $(wildcard arb_os/*.mini) $(consts) $(globals) stdlib/*.mini builtin/*.mini arb_os/contractTemplates.mini
arbos_source_no_bridge = $(filter-out arb_os/bridge_arbos_versions.mini, $(arbos_source_all))

arb_os/upgrade.json: arb_os/arbos-upgrade.mexe .make/tools
	$(run) serialize-upgrade arb_os/arbos-upgrade.mexe > $@

arb_os/arbos-upgrade.mexe: arb_os/arbos-upgrade-base.mexe arb_os/bridge_arbos_versions.mini .make/tools
	$(compile) arb_os -o $@ -m

arb_os/bridge_arbos_versions.mini: arb_os/arbos-upgrade-base.mexe arb_os/arbos_before.mexe arb_os/customize_arbos_bridge_versions.mini arb_os/upgrade.toml .make/tools
	$(upgrade) arb_os/arbos_before.mexe $< $@ customize_arbos_bridge_versions arb_os/upgrade.toml

arb_os/arbos-upgrade-base.mexe: $(arbos_source_no_bridge) .make/tools
	cp arb_os/dummy_version_bridge.mini arb_os/bridge_arbos_versions.mini
	$(compile) arb_os -o $@ -m


# strategic rules to minimize dependency building

.make/tools: .make/solidity .make/compiler .make/install
	@touch .make/tools

.make/test: arb_os/arbos.mexe $(test_mexes) arb_os/arbos-upgrade.mexe arb_os/upgrade.json
	cargo test --release
	@touch .make/test

.make/libs: $(libs_mexes)
	cargo test --release -- test_arraytest test_if_else test_closures test_codeblocks test_basic test_codeload test_globaltest test_map test_kvstest test_fixedpoint test_error_system test_queuetest test_keccak test_pqtest test_storage_map test_expanding_int_array test_bytearray test_biguint test_rlp
	exit 1
	@touch .make/libs

.make/fmt: src/*.rs src/*/*.rs Cargo.* .make/install
	cargo fmt
	@touch .make/fmt

.make/push: .make/fmt arb_os/arbos.mexe
	make $(MAKEFLAGS) compile_options="$(compile_options)" replayTests .make/test
	@touch .make/push

.make/compiler: src/*.rs src/*/*.rs src/*.lalrpop Cargo.* .make/install
	cargo build --release
	@touch .make/compiler

.make/solidity: contracts/arbos/*/*.sol .make/install
	yarn --cwd contracts build
	@touch .make/solidity

.make/install:
	mkdir -p .make
	yarn --cwd contracts install
	@touch .make/install


# CLI tooling
cov_files = $(wildcard coverage/*.cov)
cov_files_no_upgrade = $(filter-out coverage/test_upgrade_arbos_to_different_version.cov, $(cov_files))

lcov-mini.info: coverage/alltests.all ./coverage/mini-coverage.sh
	./coverage/mini-coverage.sh $< > $@

coverage/alltests.all: coverage/avmcodebuilder.partial $(cov_files_no_upgrade) .make/test
	cat $^ | sort -r | uniq | sort | uniq -f 1 | sort -k2,2 -k3,3n | grep -v test | grep -v Test > $@

coverage/avmcodebuilder.partial: coverage/test_upgrade_arbos_to_different_version.cov
	grep avmcodebuilder $< > $@

coverage/test_upgrade_arbos_to_different_version.cov: .make/test

# Makefile settings

always:              # use this to force other rules to always build
.DELETE_ON_ERROR:    # causes a failure to delete its target