xmnn-isax-flow

Demo scripts for XMNN Instruction Set Extension for muRISCV-NN

Usage

Either clone this repository recursively via

git clone https://github.com/PhilippvK/xmnn-isax-flow.git --recursive

or fetch the submodules in a two-step fashion:

git clone https://github.com/PhilippvK/xmnn-isax-flow.git
git submodule update --init --recursive

Step-by-step

Download toolchains

test -d install/rv32im_ilp32 || ./scripts/download_helper.sh install/rv32im_ilp32/ gnu 2024.09.03 rv32im_zicsr_zifencei_ilp32
test -d install/llvm || ./scripts/download_helper.sh install/llvm/ llvm 19.1.6_xcvmem_heuristic

Setup venv for M2-ISA-R

./scripts/setup_m2isar.sh

Setup another venv for Seal5

./scripts/setup_seal5.sh

Generate and apply ETISS patches

# ./scripts/patch_etiss.sh [ETISS_ARCH]
./scripts/patch_etiss.sh RV32IMACFDXCoreVXMNN

Build patched ETISS simulator

# ./scripts/setup_etiss.sh [Release|Debug]
./scripts/setup_etiss.sh Release

Generate & build patched LLVM

./scripts/patch_llvm.sh

Compile target SW

# ./scripts/compile_example.sh [PROG] [gcc|llvm|seal5_llvm] [ARCH] [ABI]
./scripts/compile_example.sh mnn seal5_llvm rv32im_xcvmem_xcvmac_xcvalu_xcvbitmanip_xmnn_zicsr_zifencei ilp32

Run program on patched architecture ETISS

# ./scripts/run_example.sh [PROG] [CPU_ARCH]
./scripts/run_example.sh mnn RV32IMACFDXCoreVXMNN

All-in-one

All steps above combined in one single script:

./scripts/full_flow.sh

Hints

If you have a ccache/sccache installation on your system, use the following to drastically speedup your LLVM rebuilds:

export CCACHE=1

If you have patched the LLVM at least once, some stages in the Seal5 flow can be skipped like this:

export PREPATCHED=1