Makefile

# Copyright (C) 2021 Toitware ApS.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; version
# 2.1 only.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# The license can be found in the file `LICENSE` in the top level
# directory of this repository.

.ONESHELL: # Run all lines of targets in one shell
.SHELLFLAGS += -e

# General options.
HOST=host
BUILD_TYPE=Release

# Use 'make ESP32_ENTRY=examples/mandelbrot.toit esp32' to compile a different
# example for the ESP32 firmware.
ESP32_ENTRY=examples/hello.toit
ESP32_WIFI_SSID=
ESP32_WIFI_PASSWORD=
ESP32_PORT=
ESP32_CHIP=esp32

# The system process is started from its own entry point.
ESP32_SYSTEM_ENTRY=system/extensions/esp32/boot.toit

# Extra entries stored in the flash must have the same uuid as the system image
# to make sure they are produced by the same toolchain. On most platforms it
# is possible to use 'make ... ESP32_SYSTEM_ID=$(uuidgen)' to ensure this.
ESP32_SYSTEM_ID=00000000-0000-0000-0000-000000000000

export IDF_TARGET=$(ESP32_CHIP)

# Use Toitware ESP-IDF fork by default.
export IDF_PATH ?= $(CURDIR)/third_party/esp-idf

ifeq ($(OS),Windows_NT)
	EXE_SUFFIX=.exe
	DETECTED_OS=$(OS)
else
	EXE_SUFFIX=
	DETECTED_OS=$(shell uname)
endif

CROSS_ARCH=

prefix ?= /opt/toit-sdk

# HOST
.PHONY: all
all: sdk

.PHONY: sdk
sdk: tools snapshots version-file

check-env:
ifndef IGNORE_SUBMODULE
	@ if git submodule status | grep '^[-+]' ; then \
		echo "Submodules not updated or initialized. Did you 'git submodule update --init --recursive'?"; \
		exit 1; \
	fi
endif
ifndef IGNORE_GIT_TAGS
	@ if [ -z "$$(git rev-list --tags --max-count=1)" ]; then \
		echo "No tags in repository. Checkout is probably shallow. Run 'git fetch --tags --recurse-submodules=no'"; \
		exit 1; \
	fi
endif
ifeq ("$(wildcard $(IDF_PATH)/components/mbedtls/mbedtls/LICENSE)","")
ifeq ("$(IDF_PATH)", "$(CURDIR)/third_party/esp-idf")
	$(error mbedtls sources are missing. Did you `git submodule update --init --recursive`?)
else
	$(error Invalid IDF_PATH. Missing mbedtls sources.)
endif
endif
ifneq ("$(IDF_PATH)", "$(CURDIR)/third_party/esp-idf")
	$(info -- Not using Toitware ESP-IDF fork.)
endif

# We mark this phony because adding and removing .cc files means that
# cmake needs to be rerun, but we don't detect that, so it might not
# get run enough.  It takes <1s on Linux to run cmake, so it's
# usually best to run it eagerly.
.PHONY: build/host/CMakeCache.txt
build/$(HOST)/CMakeCache.txt:
	$(MAKE) rebuild-cmake

BIN_DIR = $(CURDIR)/build/$(HOST)/sdk/bin
TOITVM_BIN = $(BIN_DIR)/toit.run$(EXE_SUFFIX)
TOITPKG_BIN = $(BIN_DIR)/toit.pkg$(EXE_SUFFIX)
TOITC_BIN = $(BIN_DIR)/toit.compile$(EXE_SUFFIX)

.PHONY: download-packages
download-packages: check-env build/$(HOST)/CMakeCache.txt tools
	(cd build/$(HOST) && ninja download_packages)

.PHONY: rebuild-cmake
rebuild-cmake:
	mkdir -p build/$(HOST)
	(cd build/$(HOST) && cmake ../.. -G Ninja -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DCMAKE_TOOLCHAIN_FILE=../../toolchains/host.cmake --no-warn-unused-cli)

.PHONY: tools
tools: check-env build/$(HOST)/CMakeCache.txt
	(cd build/$(HOST) && ninja build_tools)

.PHONY: snapshots
snapshots: tools download-packages
	(cd build/$(HOST) && ninja build_snapshots)

.PHONY: version-file
version-file: build/$(HOST)/CMakeCache.txt
	(cd build/$(HOST) && ninja build_version_file)

# CROSS-COMPILE
.PHONY: all-cross
all-cross: tools-cross snapshots-cross version-file-cross

check-env-cross:
ifndef CROSS_ARCH
	$(error invalid must specify a cross-compilation target with CROSS_ARCH.  For example: make all-cross CROSS_ARCH=riscv64)
endif
ifeq ("$(wildcard ./toolchains/$(CROSS_ARCH).cmake)","")
	$(error invalid cross-compile target '$(CROSS_ARCH)')
endif

.PHONY: build/$(CROSS_ARCH)/CMakeCache.txt
build/$(CROSS_ARCH)/CMakeCache.txt:
	$(MAKE) rebuild-cross-cmake

.PHONY: rebuild-cross-cmake
rebuild-cross-cmake:
	mkdir -p build/$(CROSS_ARCH)
	(cd build/$(CROSS_ARCH) && cmake ../../ -G Ninja -DTOITC=$(TOITC_BIN) -DTOITPKG=$(TOITPKG_BIN) -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DCMAKE_TOOLCHAIN_FILE=../../toolchains/$(CROSS_ARCH).cmake --no-warn-unused-cli)

.PHONY: tools-cross
tools-cross: check-env-cross tools build/$(CROSS_ARCH)/CMakeCache.txt
	(cd build/$(CROSS_ARCH) && ninja build_tools)

.PHONY: snapshots-cross
snapshots-cross: tools download-packages build/$(CROSS_ARCH)/CMakeCache.txt
	(cd build/$(CROSS_ARCH) && ninja build_snapshots)

.PHONY: version-file-cross
version-file-cross: build/$(CROSS_ARCH)/CMakeCache.txt
	(cd build/$(CROSS_ARCH) && ninja build_version_file)


# ESP32 VARIANTS
SNAPSHOT_DIR = build/$(HOST)/sdk/snapshots

ifeq ($(DETECTED_OS), Linux)
	NUM_CPU := $(shell nproc)
else ifeq ($(DETECTED_OS), Darwin)
	NUM_CPU := $(shell sysctl -n hw.ncpu)
else
	# Just assume two cores.
	NUM_CPU := 2
endif


.PHONY: check-esp32-env
check-esp32-env:
ifeq ("", "$(shell command -v xtensa-esp32-elf-g++)")
	$(error xtensa-esp32-elf-g++ not in path. Did you `source third_party/esp-idf/export.sh`?)
endif

.PHONY: esp32
esp32: check-env check-esp32-env build/$(ESP32_CHIP)/toit.bin  build/$(ESP32_CHIP)/programs.bin

build/$(ESP32_CHIP)/toit.bin build/$(ESP32_CHIP)/toit.elf: build/$(ESP32_CHIP)/lib/libtoit_vm.a
build/$(ESP32_CHIP)/toit.bin build/$(ESP32_CHIP)/toit.elf: build/$(ESP32_CHIP)/lib/libtoit_image.a
build/$(ESP32_CHIP)/toit.bin build/$(ESP32_CHIP)/toit.elf: tools snapshots build/config.json
	$(MAKE) -j $(NUM_CPU) -C toolchains/$(ESP32_CHIP)/
	$(TOITVM_BIN) tools/inject_config.toit build/config.json --unique_id=$(ESP32_SYSTEM_ID) build/$(ESP32_CHIP)/toit.bin

.PHONY: build/$(ESP32_CHIP)/lib/libtoit_vm.a  # Marked phony to force regeneration.
build/$(ESP32_CHIP)/lib/libtoit_vm.a: build/$(ESP32_CHIP)/CMakeCache.txt build/$(ESP32_CHIP)/include/sdkconfig.h
	(cd build/$(ESP32_CHIP) && ninja toit_vm)

build/$(ESP32_CHIP)/lib/libtoit_image.a: build/$(ESP32_CHIP)/$(ESP32_CHIP).image.s build/$(ESP32_CHIP)/CMakeCache.txt build/$(ESP32_CHIP)/include/sdkconfig.h
	(cd build/$(ESP32_CHIP) && ninja toit_image)

build/$(ESP32_CHIP)/$(ESP32_CHIP).image.s: build/$(ESP32_CHIP)/system.snapshot tools snapshots
	mkdir -p build/$(ESP32_CHIP)
	$(TOITVM_BIN) $(SNAPSHOT_DIR)/snapshot_to_image.snapshot $< $@

.PHONY: build/$(ESP32_CHIP)/system.snapshot  # Marked phony to force regeneration.
build/$(ESP32_CHIP)/system.snapshot: $(ESP32_SYSTEM_ENTRY) tools
	$(TOITC_BIN) -w $@ $<

.PHONY: build/$(ESP32_CHIP)/program.snapshot  # Marked phony to force regeneration.
build/$(ESP32_CHIP)/program.snapshot: $(ESP32_ENTRY) tools
	mkdir -p build/$(ESP32_CHIP)
	$(TOITC_BIN) -w $@ $<

build/$(ESP32_CHIP)/programs.bin: build/$(ESP32_CHIP)/program.snapshot tools
	$(TOITVM_BIN) tools/snapshot_to_image.toit --unique_id=$(ESP32_SYSTEM_ID) -m32 --binary --relocate=0x3f430000 $< $@

build/$(ESP32_CHIP)/CMakeCache.txt:
	mkdir -p build/$(ESP32_CHIP)
	touch build/$(ESP32_CHIP)/$(ESP32_CHIP).image.s
	(cd build/$(ESP32_CHIP) && IMAGE=build/$(ESP32_CHIP)/$(ESP32_CHIP).image.s cmake ../../ -G Ninja -DTOITC=$(TOITC_BIN) -DTOITPKG=$(TOITPKG_BIN) -DCMAKE_BUILD_TYPE=$(BUILD_TYPE) -DCMAKE_TOOLCHAIN_FILE=../../toolchains/$(ESP32_CHIP)/$(ESP32_CHIP).cmake --no-warn-unused-cli)

build/$(ESP32_CHIP)/include/sdkconfig.h:
	mkdir -p build/$(ESP32_CHIP)
	$(MAKE) -C toolchains/$(ESP32_CHIP) -s "$(CURDIR)"/$@

.PHONY: build/config.json  # Marked phony to force regeneration.
build/config.json:
	echo '{"wifi": {"ssid": "$(ESP32_WIFI_SSID)", "password": "$(ESP32_WIFI_PASSWORD)"}}' > $@


# ESP32 VARIANTS FLASH
.PHONY: flash
flash: check-env-flash sdk esp32
	python $(IDF_PATH)/components/esptool_py/esptool/esptool.py --chip $(ESP32_CHIP) --port $(ESP32_PORT) --baud 921600 \
	    --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 40m --flash_size detect \
		0x001000 build/$(ESP32_CHIP)/bootloader/bootloader.bin \
		0x008000 build/$(ESP32_CHIP)/partitions.bin \
		0x010000 build/$(ESP32_CHIP)/toit.bin \
		0x200000 build/$(ESP32_CHIP)/programs.bin

.PHONY: check-env-flash
check-env-flash:
ifndef ESP32_PORT
	$(error ESP32_PORT is not set)
endif


# UTILITY
.PHONY:	clean
clean:
	rm -rf build/

.PHONY: install-sdk install
install-sdk: all
	install -D --target-directory="$(DESTDIR)$(prefix)"/bin "$(CURDIR)"/build/$(HOST)/sdk/bin/*
	chmod 644 "$(DESTDIR)$(prefix)"/bin/*.snapshot
	mkdir -p "$(DESTDIR)$(prefix)"/lib
	cp -R "$(CURDIR)"/lib/* "$(DESTDIR)$(prefix)"/lib
	find "$(DESTDIR)$(prefix)"/lib -type f -exec chmod 644 {} \;
	mkdir -p "$(DESTDIR)$(prefix)"/snapshots
	cp "$(CURDIR)"/build/$(HOST)/sdk/snapshots/* "$(DESTDIR)$(prefix)"/snapshots
	find "$(DESTDIR)$(prefix)"/snapshots -type f -exec chmod 644 {} \;

install: install-sdk


# TESTS (host)
.PHONY: test
test:
	(cd build/$(HOST) && ninja check_slow check_fuzzer_lib)

.PHONY: update-gold
update-gold:
	(cd build/$(HOST) && ninja update_gold)
	(cd build/$(HOST) && ninja update_minus_s_gold)

.PHONY: test-health
test-health: download-packages
	$(MAKE) rebuild-cmake
	(cd build/$(HOST) && ninja check_health)

.PHONY: update-health-gold
update-health-gold: download-packages
	$(MAKE) rebuild-cmake
	(cd build/$(HOST) && ninja clear_health_gold)
	(cd build/$(HOST) && ninja update_health_gold)

.PHONY: enable-external
enable-external:
	$(MAKE) rebuild-cmake  # Ensure the cmake-directory was created.
	cmake -DTOIT_TEST_EXTERNAL=ON build/$(HOST)
	$(MAKE) download-external
	$(MAKE) rebuild-cmake
	$(MAKE) download-packages

.PHONY: check-external-enabled
check-external-enabled:
	@ if ! cmake -LA -N build/$(HOST) | grep 'TOIT_TEST_EXTERNAL:BOOL=ON'; then \
		echo "external projects are not enabled. Run 'make enable-external' first."; \
		exit 1; \
	fi

.PHONY: disable-external
disable-external: check-external-enabled
	$(MAKE) rebuild-cmake  # Ensure the cmake-directory was created.
	cmake -DTOIT_TEST_EXTERNAL=OFF build/$(HOST)

.PHONY: download-external
download-external: check-external-enabled
	# Download with higher parallelism.
	(cd build/$(HOST) && ninja -j 16 download_external)

.PHONY: test-external
test-external: check-external-enabled
	(cd build/$(HOST) && ninja check_external)

.PHONY: test-external-health
test-external-health: check-external-enabled
	(cd build/$(HOST) && ninja check_external_health)

.PHONY: update-external-health-gold
update-external-health-gold: download-packages check-external-enabled
	$(MAKE) rebuild-cmake
	(cd build/$(HOST) && ninja clear_external_health_gold)
	(cd build/$(HOST) && ninja update_external_health_gold)