Makefile

# RISCV should either be unset, or set to point to a directory that contains
# a toolchain install tree that was built via other means.
RISCV ?= $(CURDIR)/toolchain
PATH := $(RISCV)/bin:$(PATH)
ISA ?= rv64imafdc_zifencei_zicsr
ABI ?= lp64d
BL ?= bbl
BOARD ?= spike
NCORE ?= `nproc`
SPIKE_SPEC ?= spike -p1
SPIKE_DUAL ?= spike -p2
SPIKE_MCORE ?= spike -p4
SPECKLE ?= /set/to/your/speckle/build/overlay

topdir := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
topdir := $(topdir:/=)
srcdir := $(topdir)/repo
confdir := $(topdir)/conf
wrkdir := $(CURDIR)/build

toolchain_srcdir := $(srcdir)/riscv-gnu-toolchain
toolchain_wrkdir := $(wrkdir)/riscv-gnu-toolchain
toolchain_dest := $(RISCV)

buildroot_srcdir := $(srcdir)/buildroot
buildroot_initramfs_wrkdir := $(topdir)/rootfs/buildroot_initramfs
buildroot_initramfs_tar := $(buildroot_initramfs_wrkdir)/images/rootfs.tar
buildroot_initramfs_config := $(confdir)/buildroot_initramfs_config
buildroot_initramfs_sysroot_stamp := $(wrkdir)/.buildroot_initramfs_sysroot
buildroot_initramfs_sysroot := $(topdir)/rootfs/buildroot_initramfs_sysroot

buildroot_initramfs_sysroot_modifications = \
	$(buildroot_initramfs_sysroot)/usr/bin/timed-run \
	$(buildroot_initramfs_sysroot)/usr/bin/mcore-run \
	$(buildroot_initramfs_sysroot)/usr/bin/mount-spec \
	$(buildroot_initramfs_sysroot)/usr/bin/run-spec \
	$(buildroot_initramfs_sysroot)/usr/bin/run-mcore \
	$(buildroot_initramfs_sysroot)/usr/bin/allocate-hugepages 

linux_srcdir := $(srcdir)/linux
linux_wrkdir := $(wrkdir)/linux
linux_defconfig := $(confdir)/linux_defconfig

vmlinux := $(linux_wrkdir)/vmlinux
vmlinux_stripped := $(linux_wrkdir)/vmlinux-stripped
linux_image := $(linux_wrkdir)/arch/riscv/boot/Image

DTS ?= $(abspath conf/$(BOARD).dts)
pk_srcdir := $(srcdir)/riscv-pk
pk_wrkdir := $(wrkdir)/riscv-pk
bbl := $(pk_wrkdir)/bbl
pk  := $(pk_wrkdir)/pk

opensbi_srcdir := $(srcdir)/opensbi
opensbi_wrkdir := $(wrkdir)/opensbi
fw_jump := $(opensbi_wrkdir)/platform/generic/firmware/fw_jump.elf

spike_srcdir := $(srcdir)/riscv-isa-sim
spike_wrkdir := $(wrkdir)/riscv-isa-sim
spike := $(toolchain_dest)/bin/spike

qemu_srcdir := $(srcdir)/riscv-gnu-toolchain/qemu
qemu_wrkdir := $(wrkdir)/qemu
qemu :=  $(toolchain_dest)/bin/qemu-system-riscv64

target_linux  := riscv64-unknown-linux-gnu
target_newlib := riscv64-unknown-elf

.PHONY: all
all: spike

newlib: $(RISCV)/bin/$(target_newlib)-gcc


#ifneq ($(RISCV),$(CURDIR)/toolchain)
#$(RISCV)/bin/$(target_linux)-gcc:
#	$(error The RISCV environment variable was set, but is not pointing at a toolchain install tree)
#endif

$(toolchain_dest)/bin/$(target_linux)-gcc:
	mkdir -p $(toolchain_wrkdir)
	$(MAKE) -C $(linux_srcdir) O=$(toolchain_wrkdir) ARCH=riscv INSTALL_HDR_PATH=$(abspath $(toolchain_srcdir)/linux-headers) headers_install
	cd $(toolchain_wrkdir); $(toolchain_srcdir)/configure \
		--prefix=$(toolchain_dest) \
		--with-arch=$(ISA) \
		--with-abi=$(ABI) 
	$(MAKE) -C $(toolchain_wrkdir) linux
	# sed 's/^#define LINUX_VERSION_CODE.*/#define LINUX_VERSION_CODE 329226/' -i $(toolchain_dest)/sysroot/usr/include/linux/version.h

$(toolchain_dest)/bin/$(target_newlib)-gcc:
	mkdir -p $(toolchain_wrkdir)
	cd $(toolchain_wrkdir); $(toolchain_srcdir)/configure \
		--prefix=$(toolchain_dest) \
		--enable-multilib
	$(MAKE) -C $(toolchain_wrkdir) 

$(buildroot_initramfs_wrkdir)/.config: $(buildroot_srcdir)
	rm -rf $(dir $@)
	mkdir -p $(dir $@)
	cp $(buildroot_initramfs_config) $@
	$(MAKE) -C $< RISCV=$(RISCV) PATH="$(PATH)" O=$(buildroot_initramfs_wrkdir) olddefconfig CROSS_COMPILE=riscv64-unknown-linux-gnu-

$(buildroot_initramfs_tar): $(buildroot_srcdir) $(buildroot_initramfs_wrkdir)/.config $(RISCV)/bin/$(target_linux)-gcc $(buildroot_initramfs_config)
	$(MAKE) -C $< RISCV=$(RISCV) PATH="$(PATH)" O=$(buildroot_initramfs_wrkdir) -j$(NCORE)

.PHONY: buildroot_initramfs-menuconfig
buildroot-menuconfig: $(buildroot_initramfs_wrkdir)/.config $(buildroot_srcdir)
	$(MAKE) -C $(dir $<) O=$(buildroot_initramfs_wrkdir) menuconfig
	$(MAKE) -C $(dir $<) O=$(buildroot_initramfs_wrkdir) savedefconfig
	cp $(dir $<)/defconfig conf/buildroot_initramfs_config

$(buildroot_initramfs_sysroot): $(buildroot_initramfs_tar)
	mkdir -p $(buildroot_initramfs_sysroot)
	tar -xpf $< -C $(buildroot_initramfs_sysroot) --exclude ./dev --exclude ./usr/share/locale

.PHONY: buildroot_initramfs_sysroot-clean buildroot_initramfs_sysroot-rebuild vmlinux-initramfs-clean
# clear buildroot initramfs build target, 
#   make this every time after post-build.sh is updated, and then make bbl;
# ref: https://stackoverflow.com/a/49862790/24082431
buildroot_initramfs_sysroot-clean: 
	rm -rf $(buildroot_initramfs_wrkdir)/target $(buildroot_initramfs_wrkdir)/images/rootfs.tar 
	rm -rf $(buildroot_initramfs_sysroot) 
	find $(buildroot_initramfs_wrkdir) -name ".stamp_target_installed" -delete
	rm -f $(buildroot_initramfs_wrkdir)/build/host-gcc-final-*/.stamp_host_installed

# clear buildroot initramfs intermediate files in build/linux,
# 	make this every time after changing files under $(buildroot_initramfs_sysroot),
#		and then make bbl
vmlinux-initramfs-clean:
	rm -rf $(linux_wrkdir)/usr/initramfs_data.cpio $(linux_wrkdir)/usr/initramfs_inc_data $(vmlinux) $(vmlinux_stripped)

# shortcut to rebuild necessary targets related to buildroot initramfs,
#		make this or make bbl after changing files under $(buildroot_initramfs_sysroot)
buildroot_initramfs_sysroot-rebuild: $(buildroot_initramfs_sysroot) $(vmlinux) $(bbl) install-spec install-attack


$(linux_wrkdir)/.config: $(linux_defconfig) $(linux_srcdir) $(toolchain_dest)/bin/$(target_linux)-gcc
	mkdir -p $(dir $@)
	cp -p $< $@
	$(MAKE) -C $(linux_srcdir) O=$(linux_wrkdir) ARCH=riscv CROSS_COMPILE=riscv64-unknown-linux-gnu- olddefconfig
	echo $(ISA)
	echo $(filter rv32%,$(ISA))
ifeq (,$(filter rv%c,$(ISA)))
	sed 's/^.*CONFIG_RISCV_ISA_C.*$$/CONFIG_RISCV_ISA_C=n/' -i $@
	$(MAKE) -C $(linux_srcdir) O=$(linux_wrkdir) ARCH=riscv CROSS_COMPILE=riscv64-unknown-linux-gnu- olddefconfig
endif
ifeq ($(ISA),$(filter rv32%,$(ISA)))
	sed 's/^.*CONFIG_ARCH_RV32I.*$$/CONFIG_ARCH_RV32I=y/' -i $@
	sed 's/^.*CONFIG_ARCH_RV64I.*$$/CONFIG_ARCH_RV64I=n/' -i $@
	$(MAKE) -C $(linux_srcdir) O=$(linux_wrkdir) ARCH=riscv CROSS_COMPILE=riscv64-unknown-linux-gnu- olddefconfig
endif

$(vmlinux): $(linux_srcdir) $(linux_wrkdir)/.config $(buildroot_initramfs_sysroot) $(buildroot_initramfs_sysroot_modifications)
	$(MAKE) -C $< O=$(linux_wrkdir) \
		CONFIG_INITRAMFS_SOURCE="$(confdir)/initramfs.txt $(buildroot_initramfs_sysroot)" \
		CONFIG_INITRAMFS_ROOT_UID=$(shell id -u) \
		CONFIG_INITRAMFS_ROOT_GID=$(shell id -g) \
		CROSS_COMPILE=riscv64-unknown-linux-gnu- \
		ARCH=riscv \
		all -j$(NCORE)

$(vmlinux_stripped): $(vmlinux)
	$(target_linux)-strip -o $@ $<

$(linux_image): $(vmlinux)

.PHONY: linux-menuconfig
linux-menuconfig: $(linux_wrkdir)/.config
	$(MAKE) -C $(linux_srcdir) O=$(dir $<) ARCH=riscv CROSS_COMPILE=riscv64-unknown-linux-gnu- menuconfig
	$(MAKE) -C $(linux_srcdir) O=$(dir $<) ARCH=riscv CROSS_COMPILE=riscv64-unknown-linux-gnu- savedefconfig
	# cp $(dir $<)/defconfig conf/linux_defconfig

$(bbl): $(pk_srcdir) $(vmlinux_stripped) $(DTS)
	rm -rf $(pk_wrkdir)
	mkdir -p $(pk_wrkdir)
	cd $(pk_wrkdir) && $</configure \
		--host=$(target_linux) \
		--with-payload=$(vmlinux_stripped) \
		--enable-logo \
		--with-logo=$(abspath conf/logo.txt) \
		--with-dts=$(DTS)
	CFLAGS="-mabi=$(ABI) -march=$(ISA)" $(MAKE) -C $(pk_wrkdir) -j$(NCORE)


$(pk): $(pk_srcdir) $(RISCV)/bin/$(target_newlib)-gcc
	rm -rf $(pk_wrkdir)
	mkdir -p $(pk_wrkdir)
	cd $(pk_wrkdir) && $</configure \
		--host=$(target_newlib) \
		--prefix=$(abspath $(toolchain_dest))
	CFLAGS="-mabi=$(ABI) -march=$(ISA)" $(MAKE) -C $(pk_wrkdir)
	$(MAKE) -C $(pk_wrkdir) install

$(fw_jump): $(opensbi_srcdir) $(linux_image) $(RISCV)/bin/$(target_linux)-gcc
	rm -rf $(opensbi_wrkdir)
	mkdir -p $(opensbi_wrkdir)
	$(MAKE) -C $(opensbi_srcdir) FW_PAYLOAD_PATH=$(linux_image) PLATFORM=generic O=$(opensbi_wrkdir) CROSS_COMPILE=riscv64-unknown-linux-gnu-

$(spike): $(spike_srcdir) 
	rm -rf $(spike_wrkdir)
	mkdir -p $(spike_wrkdir)
	mkdir -p $(dir $@)
	cd $(spike_wrkdir) && $</configure \
		--prefix=$(dir $(abspath $(dir $@))) 
	$(MAKE) -C $(spike_wrkdir)
	$(MAKE) -C $(spike_wrkdir) install
	touch -c $@

$(qemu): $(qemu_srcdir)
	rm -rf $(qemu_wrkdir)
	mkdir -p $(qemu_wrkdir)
	mkdir -p $(dir $@)
	cd $(qemu_wrkdir) && $</configure \
		--disable-docs \
		--prefix=$(dir $(abspath $(dir $@))) \
		--target-list=riscv64-linux-user,riscv64-softmmu
	$(MAKE) -C $(qemu_wrkdir)
	$(MAKE) -C $(qemu_wrkdir) install
	touch -c $@


.PHONY: buildroot_initramfs_sysroot vmlinux bbl fw_jump
buildroot_initramfs_sysroot: $(buildroot_initramfs_sysroot)
vmlinux: $(vmlinux)
bbl: $(bbl)
fw_image: $(fw_jump)

.PHONY: clean mrproper
clean:
	rm -rf -- $(wrkdir)
	-rm spec2017/cusom.dt*
	-rm spec2017/bbl

mrproper:
	rm -rf -- $(wrkdir) $(CURDIR)/toolchain $(topdir)/rootfs

.PHONY: spike qemu

ifeq ($(BL),opensbi)
spike: $(fw_jump) $(spike)
	$(spike) --isa=$(ISA)_zicntr_zihpm --kernel $(linux_image) $(fw_jump)

qemu: $(qemu) $(fw_jump)
	$(qemu) -nographic -machine virt -cpu rv64,sv57=on -m 2048M -bios $(fw_jump) -kernel $(linux_image)

qemu-debug: $(qemu) $(fw_jump)
	$(qemu) -nographic -machine virt -cpu rv64,sv57=on -m 2048M -bios $(fw_jump) -kernel $(linux_image) -s -S

else ifeq ($(BL),bbl)

.PHONY: sim
sim: $(bbl)
	$(spike) --isa=$(ISA)_zicntr_zihpm $(bbl)

qemu: $(qemu) $(bbl)
	$(qemu) -nographic -machine virt -cpu rv64,sv57=on -m 2048M -bios $(bbl)

qemu-debug: $(qemu) $(bbl)
	$(qemu) -nographic -machine virt -cpu rv64,sv57=on -m 2048M -bios $(bbl) -s -S
endif

SD_CARD ?= /dev/sdb
.PHONY: make_sd
make_sd: $(bbl)
	sudo dd if=$(bbl).bin of=$(SD_CARD)1 bs=4096

$(buildroot_initramfs_sysroot)/usr/bin/timed-run: rsa/timed-run.cpp
	riscv64-unknown-linux-gnu-g++ -I$(RISCV)/include -static $< -o $@

$(buildroot_initramfs_sysroot)/usr/bin/mcore-run: rsa/mcore-run.cpp
	riscv64-unknown-linux-gnu-g++ -I$(RISCV)/include -static $< -o $@

$(buildroot_initramfs_sysroot)/usr/bin/run-spec: rsa/run-spec
	cp $< $@

$(buildroot_initramfs_sysroot)/usr/bin/run-mcore: rsa/run-mcore
	cp $< $@

$(buildroot_initramfs_sysroot)/usr/bin/mount-spec:
	mkdir -p $(buildroot_initramfs_sysroot)/root/spec
	echo "mount -t 9p -o msize=8192 /dev/root /root/spec" > $@
	chmod u+x $@

$(buildroot_initramfs_sysroot)/usr/bin/allocate-hugepages:
	echo 'echo $${1:-512} > /proc/sys/vm/nr_hugepages' >> $@
	chmod u+x $@

.PHONY: install
install: $(bbl)
	cp $(bbl) $(RISCV)/bin

.PHONY: install-spec install-attack

install-spec: spec2017/custom.patch
	$(MAKE) -C $(pk_wrkdir) clean
	cd spec2017 && $(SPIKE_SPEC) --dump-dts bbl > custom.dts
	cd spec2017 && patch -p1 < custom.patch
	dtc -O dtb spec2017/custom.dts -o spec2017/spec.dtb && cp spec2017/spec.dtb $(pk_wrkdir)/custom.dtb
	CFLAGS="-mabi=$(ABI) -march=$(ISA)" $(MAKE) -C $(pk_wrkdir) && cp $(bbl) spec2017/spec-bbl
	rm $(pk_wrkdir)/custom.dtb
	$(MAKE) -C $(pk_wrkdir) clean
	echo "$(SPIKE_SPEC) --dtb=$(CURDIR)/spec2017/spec.dtb \$${@:1} --extlib=libvirtio9pdiskdevice.so --device=\"virtio9p,path=$(SPECKLE)\" $(CURDIR)/spec2017/spec-bbl" > $(RISCV)/bin/spike-spec
	chmod u+x $(RISCV)/bin/spike-spec

install-attack: spec2017/custom.patch
	$(MAKE) -C $(pk_wrkdir) clean
	cd spec2017 && $(SPIKE_DUAL) --dump-dts bbl > custom.dts
	cd spec2017 && patch -p1 < custom.patch
	dtc -O dtb spec2017/custom.dts -o spec2017/dual.dtb && cp spec2017/dual.dtb $(pk_wrkdir)/custom.dtb
	CFLAGS="-mabi=$(ABI) -march=$(ISA)" $(MAKE) -C $(pk_wrkdir) && cp $(bbl) spec2017/attack-bbl
	rm $(pk_wrkdir)/custom.dtb
	$(MAKE) -C $(pk_wrkdir) clean
	echo "$(SPIKE_DUAL) --dtb=$(CURDIR)/spec2017/dual.dtb \$${@:2} --extlib=libvirtio9pdiskdevice.so --device=\"virtio9p,path=\$$1\" $(CURDIR)/spec2017/attack-bbl" > $(RISCV)/bin/spike-attack
	chmod u+x $(RISCV)/bin/spike-attack

install-mcore: spec2017/custom.patch
	$(MAKE) -C $(pk_wrkdir) clean
	cd spec2017 && $(SPIKE_MCORE) --dump-dts bbl > custom.dts
	cd spec2017 && patch -p1 < custom.patch
	dtc -O dtb spec2017/custom.dts -o spec2017/mcore.dtb && cp spec2017/mcore.dtb $(pk_wrkdir)/custom.dtb
	CFLAGS="-mabi=$(ABI) -march=$(ISA)" $(MAKE) -C $(pk_wrkdir) && cp $(bbl) spec2017/mcore-bbl
	rm $(pk_wrkdir)/custom.dtb
	$(MAKE) -C $(pk_wrkdir) clean
	echo "$(SPIKE_MCORE) --dtb=$(CURDIR)/spec2017/mcore.dtb \$${@:1} --extlib=libvirtio9pdiskdevice.so --device=\"virtio9p,path=$(SPECKLE)\" $(CURDIR)/spec2017/mcore-bbl" > $(RISCV)/bin/spike-mcore
	chmod u+x $(RISCV)/bin/spike-mcore