YuanQi(元气) env

Setup YuanQi env

source env.sh

vexriscv

./mill VexRiscv.runMain vexriscv.demo.GenFull
./mill VexRiscv.test.testOnly vexriscv.TestIndividualFeatures
./mill VexRiscv.runMain vexriscv.demo.Briey
./mill VexRiscv.runMain vexriscv.demo.Murax
./mill VexRiscv.runMain vexriscv.demo.MuraxWithRamInit
./mill VexRiscv.test.runMain vexriscv.MuraxSim
./mill mill.idea.GenIdea/idea

rocket-chip

# 编译verilog (mill, jvm, firtool)
make verilog
# 编译Testharness并运行riscv-tests (mill, jvm, firtool, verilator, riscv-isa-sim, riscv-gnu-toolchain, riscv-tests)
mill "runnable-riscv-test[freechips.rocketchip.system.TestHarness,freechips.rocketchip.system.DefaultConfig,_,_].run"
# mill生成idea依赖
mill -i mill.idea.GenIdea/idea

Errors

• firtool新版工具不支持-dedup和-disable-infer-rw这两个选项，需要去掉或控制firtool版本，issue中提到用nix做环境版本控制

riscv-tests

Errors

• 遇到stdint.h等标准库没find到，是riscv-gnu-toolchain的构建出错未完全完成，查看riscv64-unknown-elf文件夹中是否有include文件夹

riscv-isa-sim

cd ./riscv-isa-sim
../configure --prefix=$RISCV 
make -j

# more oprions example:
../configure --with-boost=no --with-boost-asio=no --with-boost-regex=no --with-priv=MSU --with-isa=rv64gcv --with-varch=vlen:128,elen:64

# run debug
spike -d --isa=rv64gc --log-commit xxxx.elf

riscv-opcodes

# python prerequisites
pip3 install PyYAML

# generate a instr_dict.yaml
make

# make different language target encoding list
make inst.chisel
make inst.go 
make latex
make inst.sverilog
make inst.rs

riscv-gcc-toolchain

# 替换仓库源
cd ./riscv-gcc-toolchain
git checkout <commit-id-you-want-to-build-with>
# gcc
sed -i'' -e "s|https://gcc.gnu.org/git/gcc.git|https://mirrors.tuna.tsinghua.edu.cn/git/gcc.git|g" ./.gitmodules
# glibc
sed -i'' -e "s|https://sourceware.org/git/glibc.git|https://mirrors.tuna.tsinghua.edu.cn/git/glibc.git|g" ./.gitmodules
# binutils-gdb
sed -i'' -e "s|https://sourceware.org/git/binutils-gdb.git|https://mirrors.tuna.tsinghua.edu.cn/git/binutils-gdb.git|g" ./.gitmodules
# qemu
sed -i'' -e "s|https://gitlab.com/qemu-project/qemu.git|https://mirrors.tuna.tsinghua.edu.cn/git/qemu.git|g" ./.gitmodules
# llvm
sed -i'' -e "s|https://github.com/llvm/llvm-project.git|https://mirrors.tuna.tsinghua.edu.cn/git/llvm-project.git|g" ./.gitmodules

# init git submodule
git submodule update --init

# ubuntu prerequisites
sudo apt-get install autoconf automake autotools-dev curl python3 python3-pip libmpc-dev libmpfr-dev libgmp-dev gawk build-essential bison flex texinfo gperf libtool patchutils bc zlib1g-dev libexpat-dev ninja-build git cmake libglib2.0-dev

# linux prerequisites
sudo pacman -Syyu autoconf automake curl python3 libmpc mpfr gmp gawk base-devel bison flex texinfo gperf libtool patchutils bc zlib expat

# Fedora/CentOS/RHEL OS prerequisites
sudo yum install autoconf automake python3 libmpc-devel mpfr-devel gmp-devel gawk  bison flex texinfo patchutils gcc gcc-c++ zlib-devel expat-devel

# mac os prerequisites
brew install python3 gawk gnu-sed gmp mpfr libmpc isl zlib expat texinfo flock

# compile
mkdir -p ./riscv-gcc-toolchain/build 
../configure --prefix=$RISCV --enable-multilib --with-arch=rv64gcv_zifencei_zicsr
make

Errors

• 不能 make -j8，多核情况下会报错，但其他并行编译会打印一些正确的信息把错误覆盖掉
• configure: error: source directory already configured; run "make distclean" there first

# 删除gcc的安装目录
rm -rf $RISCV 
# 删除build文件夹
rm -rf build 
# 查看gcc、newlib、等仓库的改变情况，使用git
git status
# 使用make清除命令
make distclean

• TODO: gdb的构建会报错: configure: error: GMP is missing or unusable

circt

# 替换仓库源
cd ./circt
git checkout <commit-id-you-want-to-build-with>
sed -i'' -e "s|https://github.com/llvm/llvm-project.git|https://mirrors.tuna.tsinghua.edu.cn/git/llvm-project.git|g" ./.gitmodules
git submodule update --init

# Explanation of sed -i''
# https://stackoverflow.com/a/4247319/13433323

Tools

git

# 查看远程仓库地址信息
git remote -v
# 添加子模块仓库
git submodule add <git-url>
# 删除子模块三步走, 第一步删除.git/config下信息, 第二步删除.gitmodules信息, 第三步删除剩余信息
git submodule deinit <submodule>
git rm <submodule>
rm -rf .git/modules/<submodule>
# 将官方本地自己建的分支推到远程的自己的仓库
git remote set-url origin https://ghp_TGugITdDdGkilXLUPMLuExxxxxxxxxxxxxxxxxxxxx@github.com/davine47/yuanqi.git
git remote add davine http://root:123456@127.0.0.1:20/pppp/xxxx.git
git push davine <branch>