external_tools.mk

# DO NOT DIRECTLY CALL THIS FILE. Depends on vars in top level Makefile.
# When adding new tools, make PATH variable ajustments to $(ACTIVATE_SCRIPT) and append environment variables to $(VENV_VARS)
# Tool location paths here, other tool varialbes group with tool recipe or in setup/tools_vars/*.env
# The environment is activated with every shell line, so variables added to $(VENV_VARS) are available for all future shell lines.
# Keep tool recipes multithreading safe by using APPEND_MT macro or flock command when writing to shared files like $(VENV_VARS) and $(VENV_ACTIVATE)
TOOL_VARS := $(INITIAL_VARS)
include $(BFASST_SETUP)/helper_macros.mk
########################## Non-submodule Tools #####################################################
CONFORMAL_PATH ?= $(or $(shell command -v conformal), "conformal_is_missing")

ifndef VIVADO_BIN
  VIVADO ?= $(or $(shell command -v vivado), "vivado_is_missing")
else
  VIVADO := $(VIVADO_BIN)
endif

IC2_PATH ?= /tools/lscc/iCEcube2.2020.12

########################## Bulk Submodule Build Recipes ############################################
.PHONY: all_submodules update_all_submodules reset_submodules

# Automated Submodule Variables and Rules:
# Helper macros has imported <SUBMODULE>_PATH, <SUBMODULE>_INSTALLED, <SUBMODULE>_UPDATED for each submodule
# Helper macros has linked dependency rules to make sure the repo is cloned and checked out
# Keep $(VENV_VARS) newer than $(VENV_ACTIVATE) to prevent env_vars rebuild
# Dependency chain: (auto generated)
#    PHONY COMMAND                ACTUAL TARGET             	DEPENDENCIES
#  update_<submodule>	$(STAMP_DIR)/<submodule>_updated		$(STAMP_DIR)/<submodule>_checkout | $(STAMP_DIR)/<submodule>_installed
#         <submodule>	<submodule>_post_install
#  *_post_install		None									$(STAMP_DIR)/<submodule>_installed
#						$(STAMP_DIR)/<submodule>_installed		<none> | $(SUBMODULE_RULES_DIR)/<submodule>.mk $(STAMP_DIR)/<submodule>_checkout $(<SUBMODULE>_PATH)/.bfasst_installed
#						$(STAMP_DIR)/<submodule>_checkout		.git metadata files that change when submodule commit changes or bfasst expects a new commit | <none>
#			            $(SUBMODULE_RULES_DIR)/<submodule>.mk	<none> | $(<SUBMODULE>_PATH)/.git
#
# To avoid repeat work, and solve chicken/egg dependencies for cached submodules: 
# 1) *.git rules CREATE $(STAMP_DIR)/<submodule>_checkout target files
# 2) *_checkout rules DELETE the .bfasst_installed file. (only if an actual checkout was done)
# 3) *_installed rules CREATE _updated target file -> but it must be MANUALLY implemented in the rules below
#
# ADDING NEW SUBMODULES:
# 1) Add the submodule using git submodule add <repo_url> <path
# 2) Optionally create a $(SUBMODULE_PATH)/.bfasst_installed: rule to perfom any build steps done INSIDE the submodule repo.
# 3) Optionally create a $(SUBMODULE_INSTALLED): rule to perfom any build steps done in the BFASST repo (edit $(VENV_VARS), etc)
# 4) Optionally add dependencies to <submodule>_post_install to do other actions (cache part db, etc).
# 5) Optionally create a $(SUBMODULE_UPDATED): rule to perform any rebuild steps when a new commit is checked out.
# Do not add dependencies to <submodule> that acutally depend on <submodule>_installed, they will not be built in the correct order.
# 		Instead, add the deps to <submodule>_post_install, which is run after install is complete.
# No-op rules are predefined to fill in for any you do not need.


MODULE_INIT := git submodule init
# if you do not include init, then recursive update will not operate as expected
MODULE_UPDATE := git submodule update --init --recursive

# On fresh clone: bootstrap rules handle checkout + rule file generation lazily per-submodule
# Each submodule target generates its rule file on first request, then rule file provides git deps
# Batch build makefiles, then install targets to minimize redundant makefile parsing
all_submodules: .gitmodules $(VENV_VARS)
	$(MAKE) --no-print-directory $(SUBMOD_MAKEFILES)
	$(MAKE) --no-print-directory $(SUBMOD_INSTALL_TARGETS)

# Installed submodules are outdated if their current commit does not match the project's expected commit
update_all_submodules: .gitmodules
	$(MAKE) --no-print-directory $(SUBMOD_UPDATE_TARGETS)

clean_submodules:
	@echo "Cleaning all submodules"
	@$(MAKE) --no-print-directory $(foreach submodule,$(SUBMODULES),clean_$(notdir $(submodule)) )

RESET_BRANCH ?= main
reset_submodules:
	@echo "Force resetting all submodules to match origin/$(RESET_BRANCH)"
	@echo "Run $make reset_submodules RESET_BRANCH=<branch> to reset to a different branch."
	git submodule deinit -f --all
	git fetch origin $(RESET_BRANCH)
	git checkout $(RESET_BRANCH) -- .gitmodules
	@$(foreach submodule,$(ALL_SUBMODULES), git checkout $(RESET_BRANCH) -- $(submodule);)

####################################################################################################
# Vivado
####################################################################################################
.PHONY: vivado
vivado: $(VIVADO)
$(VIVADO):
	@echo "Vivado is not installed by this Makefile. Please install Vivado 2025.1"
	@echo "Then, set the VIVADO_BIN variable in bfasst.env to point to the vivado binary."
	exit 1

####################################################################################################
# CMake
####################################################################################################
CMAKE_VERSION ?= 3.27.7
CMAKE_DIR := cmake-${CMAKE_VERSION}-linux-x86_64
CMAKE_URL := https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/$(CMAKE_DIR).tar.gz
.PHONY: cmake update_cmake
update_cmake:
ifneq ($(shell cmake --version 2>/dev/null | grep $(CMAKE_VERSION)),)
	$(MAKE) -B $(VENV_BIN)/cmake
else
	@echo "make: Nothing to be done for 'update_cmake'. $(VENV_BIN)/cmake is already at the environment specified version ($(CMAKE_VERSION))"
endif

cmake: $(VENV_BIN)/cmake
$(VENV_BIN)/cmake: | $(VENV_BIN)
	curl -Ls "${CMAKE_URL}" | tar -xz --strip-components=2 -C $(VENV_BIN) $(CMAKE_DIR)/bin/

####################################################################################################
# Capnproto Java
####################################################################################################
CAPNP_JAVA := $(or $(shell command -v capnpc-java), capnpc-java)
PREFIX ?= /usr/local
.PHONY: capnproto_java
capnproto_java: $(CAPNP_JAVA)
# Auto rebuild capnproto-java if capnproto is updated by apt
$(CAPNP_JAVA): $(shell command -v capnproto) 
	$(eval TEMP_DIR := $(shell mktemp -d))
	git clone https://github.com/capnproto/capnproto-java $(TEMP_DIR)
	$(MAKE) -C $(TEMP_DIR)
	$(MAKE) -C $(TEMP_DIR) install || \
	  @echo "Did you run with sudo? To install to local environment, run 'make capnproto_java PREFIX=$(VENV_DIR)'""; \
	  exit 1;
	@rm -rf $(TEMP_DIR)
#   Update env variable for capnp schema, if it not already present
	ifeq ($(shell grep -Fx "export JAVA_SCHEMA=$(PREFIX)/include/capnp/" "$(VENV_VARS)" 2>/dev/null),)
		flock $(VENV_VARS) -c 'printf "\n%s\n" "# Capnproto Java Schema Path\nJAVA_SCHEMA=$(PREFIX)/include/capnp/" >> "$(VENV_VARS)"'
	endif

####################################################################################################
# Rapidwright
####################################################################################################
.PHONY: cache_rw_part inject_interchange stubs
# Find proper Java version. Currently 18 or 17.
ifndef JAVA_HOME
  ifneq ($(wildcard /usr/lib/jvm/java-18-openjdk-amd64/bin/java), )
    JAVA_HOME := /usr/lib/jvm/java-18-openjdk-amd64
  else ifneq ($(wildcard /usr/lib/jvm/java-17-openjdk-amd64/bin/java), )
    JAVA_HOME := /usr/lib/jvm/java-17-openjdk-amd64
  endif
endif
export JAVA_HOME

JAVA_STUBS_DEFAULT_PREFIX := $(SETUP_BUILD)/stubs
JAVA_STUBS_DIRS := com/xilinx/rapidwright java
ifneq ($(realpath $(RAPIDWRIGHT_PATH)/bin/),)
  STUBS_PREFIX := $(RAPIDWRIGHT_PATH)/stubs/
  JAVA_STUBS := $(addprefix $(STUBS_PREFIX), $(JAVA_STUBS_DIRS))
  $(JAVA_STUBS): $(RAPIDWRIGHT_BUILT) | $(RAPIDWRIGHT_INSTALLED)
else
  STUBS_PREFIX := $(JAVA_STUBS_DEFAULT_PREFIX)/
  JAVA_STUBS := $(addprefix $(STUBS_PREFIX), $(JAVA_STUBS_DIRS))
endif

RW_PART ?= $(DEFAULT_PART)
PART_CSV := $(RAPIDWRIGHT_PATH)/data/partdump.csv
# Infer family from part using $(RAPIDWRIGHT_PATH)/data/partdump.csv, if it exists
ifeq ($(realpath $(PART_CSV)),)
  # Partdump.csv does not exist, no parts have been cached.
  RW_PART_CACHE := $(PART_CSV)
else
  RW_FAMILY := $(shell awk -F, -v p="$(RW_PART)" '$$1 == p || $$5 == p {print $$4; exit}' $(PART_CSV))
  RW_PART_CACHE := $(RAPIDWRIGHT_PATH)/data/devices/$(RW_FAMILY)/$(RW_PART)_db_cache.dat
endif

rapidwright_post_install: $(RW_PART_CACHE)
cache_rw_part: $(RW_PART_CACHE)
$(RW_PART_CACHE): $(RAPIDWRIGHT_INSTALLED)
	cd $(RAPIDWRIGHT_PATH); rapidwright jython -c 'FileTools.ensureDataFilesAreStaticInstallFriendly("$(RW_PART)")'
	@echo "Cached RapidWright database for part $(RW_PART). To cache other parts, run make cache_rw_part RW_PART=<part>"

$(RAPIDWRIGHT_BUILT): | $(CAPNP_JAVA) $(VIVADO)
ifndef JAVA_HOME
	@echo "Java 17 or 18 is required to build RapidWright. Please run 'sudo make packages' to install it."
	@exit 1
else
	cd $(RAPIDWRIGHT_PATH) && JAVA_HOME=$(JAVA_HOME) ./gradlew updateJars
	cd $(RAPIDWRIGHT_PATH) && JAVA_HOME=$(JAVA_HOME) ./gradlew compileJava
	touch $@

RW_PATH := $(RAPIDWRIGHT_PATH)
CLASSPATH = $(RAPIDWRIGHT_PATH)/bin:$$(echo $(RAPIDWRIGHT_PATH)/jars/*.jar | tr ' ' ':')
$(RAPIDWRIGHT_INSTALLED):
	@$(call ADD_ENV_VARS,rapidwright,$(INITIAL_VARS)/rapidwright.paths,$(VENV_ACTIVATE))
	@$(call ADD_ENV_VARS,rapidwright,$(INITIAL_VARS)/rapidwright.env,$(VENV_VARS),RW_PATH JAVA_HOME CLASSPATH)
	touch $@
	touch $(RAPIDWRIGHT_UPDATED)
endif

# Inject interchange is only needed if custom modifications have been made.
# RW installs with the generated files matching its interchange submodule by default.
inject_interchange: $(RAPIDWRIGHT_INSTALLED) $(CAPNP_JAVA)
ifneq ($(wildcard $(RAPIDWRIGHT_PATH)/interchange/fpga-interchange-schema/),)
  ifneq ($(shell cd $(RAPIDWRIGHT_PATH)/interchange/fpga-interchange-schema/ && git status --porcelain),)
	@echo "Injecting updated FPGA Interchange schema into RapidWright"
	$(MAKE) -C $(RAPIDWRIGHT_PATH)/interchange/
	cd $(RAPIDWRIGHT_PATH) && ./gradlew compileJava
	touch $(RAPIDWRIGHT_UPDATED)
  endif
endif

stubs: $(JAVA_STUBS)

$(JAVA_STUBS) &:
ifneq ($(JAVA_STUBS_DEFAULT_PREFIX), $(STUBS_PREFIX))
	@rm -rf $(JAVA_STUBS_DEFAULT_PREFIX)
endif
	@rm -rf $(STUBS_PREFIX)
	@mkdir -p $(STUBS_PREFIX)
	@echo "Generating Java stubs for RapidWright at $(STUBS_PREFIX)"
	@python $(BFASST_SETUP)/generate_stubs.py --java $(STUBS_PREFIX) > /dev/null 2>&1
	
update_rapidwright: $(JAVA_STUBS)
$(RAPIDWRIGHT_UPDATED):
	touch $@

####################################################################################################
# Fasm2bels
####################################################################################################
.PHONY: init_f2b_db
fasm2bels_post_install: init_f2b_db

# f2b env is NOT parallel friendly, so for now do not use $(MAKE) for env target
$(FASM2BELS_BUILT): | $(RAPIDWRIGHT_INSTALLED) $(VIVADO)
	CONDA_PLUGINS_AUTO_ACCEPT_TOS=true make -C $(FASM2BELS_PATH) env & $(MAKE) -C $(FASM2BELS_PATH) build ; wait
	VIVADO_PATH=$$VIVADO_BIN $(MAKE) -C $(FASM2BELS_PATH) test-py
	touch $@

F2B_PATH := $(FASM2BELS_PATH)
$(FASM2BELS_INSTALLED): 
	$(call ADD_ENV_VARS,fasm2bels,$(INITIAL_VARS)/fasm2bels.env,$(VENV_VARS),F2B_PATH)
	touch $@
	touch $(FASM2BELS_UPDATED)

$(FASM2BELS_UPDATED):
	CONDA_PLUGINS_AUTO_ACCEPT_TOS=true make -C $(FASM2BELS_PATH) env & $(MAKE) -C $(FASM2BELS_PATH) build ; wait
	VIVADO_PATH=$$VIVADO_BIN $(MAKE) -C $(FASM2BELS_PATH) test-py
	touch $@

F2B_PART ?= $(DEFAULT_PART)
F2B_FAMILY ?= $(DEFAULT_PART_FAMILY)
FASM2BELS_PYTHON ?= $(FASM2BELS_PATH)/env/conda/envs/f4pga_xc_fasm2bels/bin/python3
init_f2b_db: $(FASM2BELS_PATH)/$(F2B_PART)_db
$(FASM2BELS_PATH)/$(F2B_PART)_db: $(FASM2BELS_INSTALLED)
	@echo "Generating fasm2bels database for family $(F2B_FAMILY), part $(F2B_PART)"
	$(FASM2BELS_PYTHON) $(FASM2BELS_PATH)/fasm2bels/database/create_channels.py \
		--db-root $(FASM2BELS_PATH)/third_party/prjxray-db/$(F2B_FAMILY) \
		--part $(F2B_PART) \
		--connection-database-output $(FASM2BELS_PATH)/$(F2B_PART)_db > /dev/null
	@echo "$(F2B_PART) Database generated. Pregenerate any other database by running F2B_PART=<part> F2B_FAMILY=<family> make init_f2b_db"

#####################################################################################################
# rand_soc
#####################################################################################################
$(RAND_SOC_INSTALLED):
	cd $(RAND_SOC_PATH) && pip install -r requirements.txt
	$(call ADD_ENV_VARS,randsoc,$(INITIAL_VARS)/randsoc.env,$(VENV_VARS),RAND_SOC_PATH)
	touch $@
	touch $(RAND_SOC_UPDATED)

$(RAND_SOC_UPDATED):
	cd $(RAND_SOC_PATH) && pip install -r requirements.txt
	touch $@

#####################################################################################################
# Conformal
#####################################################################################################
.PHONY: conformal
conformal: $(CONFROMAL_BIN)
$(CONFROMAL_BIN):
	@echo "Conformal is not installed by this Makefile. The conformal tool is"
	@echo "expected to be installed on a remote computer. Please set the"
	@echo "necessary variables in config.py to point to the remote computer."
	@echo "Then, rerun make conformal to setup project environment variables."
	exit 1

#####################################################################################################
# Yosys
#####################################################################################################
YO_PATH := $(YOSYS_PATH)
$(YOSYS_INSTALLED): 
	$(call ADD_ENV_VARS,yosys,$(INITIAL_VARS)/yosys.env,$(VENV_VARS),YO_PATH)
	$(MAKE) -C $(YOSYS_PATH)
	touch $@
	touch $(YOSYS_UPDATED)

$(YOSYS_UPDATED):
	$(MAKE) -C $(YOSYS_PATH)
	touch $@

#####################################################################################################
# Wafove
#####################################################################################################
$(WAFOVE_INSTALLED):
	cd $(WAFOVE_PATH) && python setup.py install
	$(MAKE) -C $(WAFOVE_PATH) yosys_cells_sim
	$(call ADD_ENV_VARS,wafove,$(INITIAL_VARS)/wafove.env,$(VENV_VARS),WAFOVE_PATH)
	touch $@
	touch $(WAFOVE_UPDATED)

$(WAFOVE_UPDATED):
	cd $(WAFOVE_PATH) && python setup.py install
	$(MAKE) -C $(WAFOVE_PATH) yosys_cells_sim
	touch $@

#####################################################################################################
# IceStorm
#####################################################################################################
# we used to also install archane pnr, but for some reason it did not get migrated here from legacy flows.
# https://github.com/cseed/arachne-pnr.git
# The following packages are not installed by make apt_packages, and may be needed: python-xdot mercurial

ICESTORM_HOME := $(ISCESTORM_PATH)
$(ICESTORM_INSTALLED): 
	$(MAKE) -C $(ICESTORM_PATH) && $(MAKE) -C $(ICESTORM_PATH) install PREFIX=../
	$(call ADD_ENV_VARS,icestorm,$(INITIAL_VARS)/icestorm.env,$(VENV_VARS),ICESTORM_HOME)
	touch $@
	touch $(ICESTORM_UPDATED)

$(ICESTORM_UPDATED):
	$(MAKE) -C $(ICESTORM_PATH) && $(MAKE) -C $(ICESTORM_PATH) install PREFIX=../
	touch $@

#####################################################################################################
# OpenTitan
#####################################################################################################
FUSESOC_CMD := --cores-root . run --build-root $(BFASST_BUILD)/opentitan --flag=fileset_top --target=synth --no-export --setup lowrisc:systems:chip_earlgrey_cw310
FINAL_TCL := $(BFASST_BUILD)/opentitan/synth-vivado/lowrisc_systems_chip_earlgrey_cw310_0.1.tcl
export CARGO_HOME ?= $(VENV_DIR)/.cargo
export RUSTUP_HOME ?= $(VENV_DIR)/.rustup
$(OPENTITAN_INSTALLED): | vivado
ifeq ($(shell command -v rustc),)
	@echo "Rust compiler is required to build OpenTitan. Building venv local install: https://rustup.rs/"
	tmp=$$(mktemp); curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > tmp; sh $$tmp -y --no-modify-path
endif
#   $(call ADD_ENV_VARS,opentitan,$(INITIAL_VARS)/opentitan.path,$(VENV_ACTIVATE),CARGO_HOME)
	pip install -U pip "setuptools<66.0.0"
	pip install -r $(OPENTITAN_PATH)/python-requirements.txt
	$(OPENTITAN_PATH)/util/get-toolchain.py --update
#   If fusesoc fails, retry with latest version.
	cd $(OPENTITAN_PATH) && fusesoc $(FUSESOC_CMD) || pip install fusesoc && fusesoc $(FUSESOC_CMD)
	echo "\nlaunch_runs impl_1" >> $(FINAL_TCL)
	touch $@
	touch $(OPENTITAN_UPDATED)

$(OPENTITAN_UPDATED):
# 	$(MODULE_UPDATE) $(OPENTITAN_PATH)
# 	pip install -r $(OPENTITAN_PATH)/python-requirements.txt
# 	$(OPENTITAN_PATH)/util/get-toolchain.py --update
# 	cd $(OPENTITAN_PATH) && fusesoc $(FUSESOC_CMD)
# 	echo "\nlaunch_runs impl_1" >> $(FINAL_TCL)

#####################################################################################################
# iCEcube2
#####################################################################################################
.PHONY: icecube2
icecube2: $(IC2_PATH)
	$(call APPEND_MT, \
		printf "\n%s\n" "# iCEcube2 Environment Variables"; \
		echo "IC2_PATH=$(IC2_PATH)"; \
		cat $(TOOL_VARS)/iCEcube2.env; \
	, $(VENV_VARS) )

$(IC2_PATH):
	@echo "iCEcube2 is not currently supported in the ninja build."
	@echo "Checkout the project tag legacy_flows for the last probable support point: https://github.com/byuccl/bfasst/releases/tag/legacy_flows"
	@echo "This tag would be useful for porting iCEcube2 to the current build system."
	@echo "iCEcube2 installation remnants in setup/: setIC2License.sh, install-icecube2.sh, env/iCEcube2.env"
	@exit 1