Update CI and toolchain installation

Author: vacantron

.ci/gdbstub-test.sh

@@ -2,7 +2,7 @@
 
 set -e -u -o pipefail
 
-export PATH=`pwd`/toolchain/riscv/bin:$PATH
+export PATH=`pwd`/toolchain/bin:$PATH
 
 GDB=
 prefixes=("${CROSS_COMPILE}" "riscv32-unknown-elf" "riscv-none-elf")
@@ -21,7 +21,7 @@ if [ -z ${GDB} ]; then
     exit 1
 fi
 
-build/rv32emu -g build/bin/riscv32/puzzle &
+build/rv32emu -g build/riscv32/puzzle &
 PID=$!
 
 # Before starting GDB, we should ensure rv32emu is still running.
@@ -33,7 +33,7 @@ OPTS=
 tmpfile=/tmp/rv32emu-gdbstub.$PID
 breakpoints=(0x10500 0x10600 0x10700)
 bkpt_count=${#breakpoints[@]}
-OPTS+="-ex 'file build/bin/riscv32/puzzle' "
+OPTS+="-ex 'file build/riscv32/puzzle' "
 OPTS+="-ex 'target remote :1234' "
 for t in ${breakpoints[@]}; do
     OPTS+="-ex 'break *$t' "

.ci/riscv-tests.sh

@@ -7,7 +7,7 @@ pip3 install git+https://github.com/riscv/riscof.git@d38859f85fe407bcacddd2efcd3
 
 set -x
 
-export PATH=`pwd`/toolchain/riscv/bin:$PATH
+export PATH=`pwd`/toolchain/bin:$PATH
 
 make clean
 make arch-test RISCV_DEVICE=IMAFCZicsrZifencei || exit 1

.ci/riscv-toolchain-install.sh

@@ -8,10 +8,15 @@ check_platform
 
 mkdir -p toolchain
 
-# GNU Toolchain for RISC-V
-GCC_VER=2024.04.12
-TOOLCHAIN_REPO=https://github.com/riscv-collab/riscv-gnu-toolchain/releases
+if [[ "$#" = 0 ]] || [[ "$1" != "riscv-collab" ]]; then
+    GCC_VER=14.2.0-1
+    TOOLCHAIN_REPO=https://github.com/xpack-dev-tools/riscv-none-elf-gcc-xpack
+    TOOLCHAIN_URL=${TOOLCHAIN_REPO}/releases/download/v${GCC_VER}/xpack-riscv-none-elf-gcc-${GCC_VER}-linux-x64.tar.gz
+else
+    UBUNTU_VER=`lsb_release -r | cut -f2`
+    GCC_VER=2024.04.12
+    TOOLCHAIN_REPO=https://github.com/riscv-collab/riscv-gnu-toolchain
+    TOOLCHAIN_URL=${TOOLCHAIN_REPO}/releases/download/${GCC_VER}/riscv32-elf-ubuntu-${UBUNTU_VER}-gcc-nightly-${GCC_VER}-nightly.tar.gz
+fi
 
-wget -q \
-    ${TOOLCHAIN_REPO}/download/${GCC_VER}/riscv32-elf-ubuntu-22.04-gcc-nightly-${GCC_VER}-nightly.tar.gz -O- \
-| tar -C toolchain -xz
+wget -q ${TOOLCHAIN_URL} -O- | tar -C toolchain --strip-components=1 -xz

.github/workflows/build-artifact.yml

@@ -0,0 +1,69 @@
+name: Build artifact
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  detect-files-changed:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+      - name: Test files changed
+        id: files-changed
+        uses: tj-actions/changed-files@v44
+        with:
+          fetch_additional_submodule_history: 'true'
+          files: |
+            tests/ansibench/*
+            tests/rv8-bench/*
+            tests/*.c
+      - name: Set alias
+        id: has_files_changed
+        run: |
+          if [[ ${{ steps.files-changed.outputs.any_changed }} == true ]]; then
+            echo "has_files_changed=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_files_changed=false" >> $GITHUB_OUTPUT
+          fi
+    outputs:
+      has_files_changed: ${{ steps.has_files_changed.outputs.has_files_changed }}
+
+  build-artifact:
+    needs: [detect-files-changed]
+    if: ${{ needs.detect-files-changed.outputs.has_files_changed == 'true' || github.event_name == 'workflow_dispatch' }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: 'true'
+      - name: Install dependencies
+        run: |
+          sudo apt-get update -q -y
+          sudo apt-get upgrade -q -y
+          sudo apt-get install -q -y gcc-multilib g++-multilib
+          .ci/riscv-toolchain-install.sh
+          echo "$PWD/toolchain/bin" >> $GITHUB_PATH
+      - name: Build binaries
+        run: |
+          make build-artifact USE_PREBUILT=0
+      - name: Create tarball
+        run: |
+          tar -C build -zcf rv32emu-prebuilt.tar.gz linux-x64 riscv32
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.RV32EMU_PREBUILT_TOKEN }}
+        run: |
+          RELEASE_TAG=$(date +'%Y.%m.%d')
+          gh release create $RELEASE_TAG \
+            --repo sysprog21/rv32emu-prebuilt \
+            --title "$RELEASE_TAG""-nightly"
+          gh release upload $RELEASE_TAG \
+            rv32emu-prebuilt.tar.gz \
+            --repo sysprog21/rv32emu-prebuilt

.github/workflows/build-testbenches.yml

@@ -16,7 +16,8 @@ build/softfloat
 build/cache/
 build/map/
 build/path/
-build/bin/
+build/linux-x64/
+build/riscv32/
 *.o
 *.o.d
 tests/**/*.elf

.gitignore

@@ -182,7 +182,7 @@ $(OUT)/emulate.o: CFLAGS += -foptimize-sibling-calls -fomit-frame-pointer -fno-s
 .DEFAULT_GOAL := all
 
 include mk/external.mk
-include mk/benchmark.mk
+include mk/artifact.mk
 include mk/wasm.mk
 
 all: config $(BIN)
@@ -243,10 +243,10 @@ EXPECTED_puzzle = success in 2005 trials
 EXPECTED_fcalc = Performed 12 tests, 0 failures, 100% success rate.
 EXPECTED_pi = 3.141592653589793238462643383279502884197169399375105820974944592307816406286208998628034825342117067982148086
 
-check: $(BIN) build-testbenches
+check: $(BIN) build-artifact
 	$(Q)$(foreach e,$(CHECK_ELF_FILES),\
 	    $(PRINTF) "Running $(e) ... "; \
-	    if [ "$(shell $(BIN) $(OUT)/bin/riscv32/$(e) | uniq)" = "$(strip $(EXPECTED_$(e))) inferior exit code 0" ]; then \
+	    if [ "$(shell $(BIN) $(OUT)/riscv32/$(e) | uniq)" = "$(strip $(EXPECTED_$(e))) inferior exit code 0" ]; then \
 	    $(call notice, [OK]); \
 	    else \
 	    $(PRINTF) "Failed.\n"; \
@@ -255,9 +255,9 @@ check: $(BIN) build-testbenches
 	)
 
 EXPECTED_aes_sha1 = f9924635666d3d58d5b60c0bde8b986a2a99effb  -
-misalign: $(BIN) build-testbenches
+misalign: $(BIN) build-artifact
 	$(Q)$(PRINTF) "Running aes ... ";
-	$(Q)if [ "$(shell $(BIN) -m $(OUT)/bin/riscv32/aes | $(SHA1SUM))" = "$(EXPECTED_aes_sha1)" ]; then \
+	$(Q)if [ "$(shell $(BIN) -m $(OUT)/riscv32/aes | $(SHA1SUM))" = "$(EXPECTED_aes_sha1)" ]; then \
 	    $(call notice, [OK]); \
 	    else \
 	    $(PRINTF) "Failed.\n"; \

Makefile

@@ -333,18 +333,18 @@ The prebuilt executables are built from GNU/GCC v9 and [xPack GCC v14.2.0-1](htt
 To fetch the prebuilt executables, run the following command:
 
 ```shell
-$ make build-testbenches
+$ make build-artifact
 ```
 
 Or, to compile the executables from the source, run:
 
 ```shell
-$ make build-testbenches USE_PREBUILT=0 CROSS_CC=<riscv-cross-compiler>
+$ make build-artifact USE_PREBUILT=0
 ```
 
 Notice that the RISC-V cross-compiler is required to build the binary.
 
-In default, `rv32emu` will download the tarball from GitHub and extract the executables into `build/bin/`.
+In default, `rv32emu` will download the tarball from GitHub and extract the executables into `build/`.
 
 There are still some prebuilt ELF files for testing purpose under `build/`.
 * `cc.elf` : See [tests/cc](tests/cc)

README.md

@@ -1,9 +1,9 @@
 USE_PREBUILT ?= 1
 
 CC ?= gcc
-CROSS_CC ?= riscv-none-elf-gcc
+CROSS_COMPILE ?= riscv-none-elf-
 
-BINDIR := $(abspath $(OUT))/bin
+BINDIR := $(abspath $(OUT))
 
 TEST_SUITES += \
     ansibench \
@@ -34,27 +34,23 @@ TESTBENCHES += \
     $(ticks)
 
 ifeq ($(USE_PREBUILT),1)
-  LATEST_RELEASE := $(shell wget -qO - https://api.github.com/repos/sysprog21/rv32emu-prebuilt/releases/latest | grep -Po '(?<="tag_name": ").+(?=",)')
+  LATEST_RELEASE := $(shell wget -q https://api.github.com/repos/sysprog21/rv32emu-prebuilt/releases/latest -O- | grep -Po '(?<="tag_name": ").+(?=",)')
 endif
 
-.PHONY: build-testbenches benchmark
+.PHONY: build-artifact
 
-# TODO: generate results automatically
-benchmark: build-testbenches
-
-build-testbenches:
+build-artifact:
 ifeq ($(USE_PREBUILT),1)
 	@echo "Fetching prebuilt executables in \"rv32emu-prebuilt\"..."
-	@wget -O - https://github.com/sysprog21/rv32emu-prebuilt/releases/download/$(LATEST_RELEASE)/rv32emu-prebuilt.tar.gz | tar zx -C build
+	@wget -q https://github.com/sysprog21/rv32emu-prebuilt/releases/download/$(LATEST_RELEASE)/rv32emu-prebuilt.tar.gz -O- | tar -C build -xz
 else
 	@$(foreach tb,$(TEST_SUITES), \
 	    git submodule update --init ./tests/$(tb) &&) true
 	@$(foreach tb,$(TEST_SUITES), \
-	    CC=$(CC) CROSS_CC=$(CROSS_CC) BINDIR=$(BINDIR) \
-		$(MAKE) -C ./tests/$(tb) all &&) true
+		$(MAKE) -C ./tests/$(tb) all BINDIR=$(BINDIR) &&) true
 	@$(foreach tb,$(TESTBENCHES), \
-	    $(CC) -m32 -O2 -Wno-unused-result -o $(BINDIR)/x86_64/$(tb) tests/$(tb).c -lm &&) true
+	    $(CC) -m32 -O2 -Wno-unused-result -o $(BINDIR)/linux-x64/$(tb) tests/$(tb).c -lm &&) true
 	@$(foreach tb,$(TESTBENCHES), \
-	    $(CROSS_CC) -march=rv32im -mabi=ilp32 -O2 -Wno-unused-result -Wno-implicit-function-declaration \
+	    $(CROSS_COMPILE)gcc -march=rv32im -mabi=ilp32 -O2 -Wno-unused-result -Wno-implicit-function-declaration \
 		    -o $(BINDIR)/riscv32/$(tb) tests/$(tb).c -lm -lsemihost &&) true
 endif