Move Chipyard CI to Github Actions

- As similar as possible to the circle ci code.
- The `.github/README.md` file has a fair amount of documentation for this.
- Creates a worfklow file
  - re-uses most of the circleci/scipts unchanged
  - defines a number of *Composite Actions* which are like YML subroutines
- Removes the circle-ci code
- Points the CI badge in the top level README to use the GA test result

.github/README.md

@@ -0,0 +1,137 @@
+Chipyard Continuous Integration (CI)
+===========
+
+Website: https://gihub.com/gh/ucb-bar/chipyard/actions
+
+GitHub Actions Brief Explanation
+---------------------------
+
+CI is executed by Github Actions (GA). GA is controlled by `.yml` files in the `.github/workflows/` directory. 
+In our case we have just one workflow named `chipyard-rocket-run-tests.yml`.
+It defines a number of `jobs` within it that do particular tasks.
+All jobs in the workflow must pass for the CI run to be successful.
+In general, a job is run in parallel with others unless it depends on some other job.  
+The dependency of one job on the completion of another is specified via the `needs` field.
+
+For example:
+```yaml
+  prepare-chipyard-cores:
+    name: prepare-chipyard-cores
+    needs: [make-keys, setup-complete]
+```
+This specifies that the `prepare-chipyard-cores` job needs the both the `make-keys` and the `setup-complete` steps to
+be completed before it can run.
+
+Chipyard runs its CI using a docker image created from `dockerfiles/Dockerfile`.
+See its [README](../dockerfiles/README.md) for more details.
+
+Finally, within each job's `steps:` section, the steps are run sequentially and state persists throughout a job.
+So when you run something like `checkout` the next step has the checked out code.
+
+[Composite Actions](https://docs.github.com/en/actions/creating-actions) (CA) allow for limited subroutine like code re-use within GA.
+We use both community created and our own Composite Actions in our CI process. CA capabilities are changing rapidly.
+Nesting of composite actions was only recently unveiled. There is a lot of room for more code reuse, in particular
+we specify things over and over like docker image tag and checkout commands.
+
+One use of CA: our process relies on caching to avoid running time-consuming and intensive tasks more often than necessary.
+
+The following is an example of using the cache@v2 composite action. A step `uses: actions/cache@v2` which take as parameters the
+path that contains the data to be cached and a key. Paths can have multiple targets. 
+The following step can look at the result of the cache operation, if there was cache miss, then we run the command that
+will generate the data to be cached. The caching of the generated data is implicit.
+>Note: GA cache documentation suggests using the yml level `if: steps.cache-primes.outputs.cache-hit != 'true'` to
+> determine whether to run the data generation command.
+> At the time of this writing the if construct has a bug and will not run correctly within a composite action. The use
+> of a bash based if is a hack found on stackoverflow
+```yaml
+    - uses: actions/cache@v2
+      id: rtl-build-id
+      with:
+        path: |
+          sims/verilator
+          sims/firesim/sim
+          generators/gemmini/software/gemmini-rocc-tests
+        key: ${{ inputs.group-key }}-${{ github.ref }}-${{ github.sha }}
+    - name: run rtl build script if not cached
+      run: |
+        if [[ "${{ steps.rtl-build-id.outputs.cache-hit }}" != 'true' ]]; then
+          echo "Cache miss on ${{ inputs.group-key }}-${{ github.ref }}-${{ github.sha }}"
+          ./.github/scripts/${{ inputs.build-script }} ${{ inputs.group-key }} ${{ inputs.build-type }}
+        else
+          echo "cache hit do not prepare rtl"
+        fi
+      shell: bash
+```
+
+Our own composite actions are defined in the `.github/actions/<ActionName>/action.yml`
+
+.github/scripts directory
+-------------------
+
+This directory contains most the collateral for the Chipyard CI to work.
+The following is included in `.github/scripts/: directory
+
+    `build-toolchains.sh`        # build either riscv-tools or esp-tools
+    `create-hash.sh`             # create hashes of riscv-tools/esp-tools to use as hash keys
+    `do-rtl-build.sh`            # use verilator to build a sim executable (remotely)
+    `defaults.sh`                # default variables used
+    `check-commit.sh`            # check that submodule commits are valid
+    `build-extra-tests.sh`       # build default chipyard tests located in tests/
+    `clean-old-files.sh`         # clean up build server files
+    `do-fpga-rtl-build.sh`       # similar to `do-rtl-build` but using fpga/
+    `install-verilator.sh`       # install verilator on build server
+    `run-firesim-scala-tests.sh` # run firesim scala tests
+    `run-tests.sh                # run tests for a specific set of designs
+
+How things are set up for Chipyard
+---------------------------------
+
+The steps for CI to run are as follows.
+1. Build the toolchains in parallel (note: `esp-tools` is currently not used in the run).
+The docker image sets up the `PATH` and `RISCV` variable so that `riscv-tools` is the default (currently the `env.sh` script that is created at tool build is unused).
+2. Create the simulator binary.
+This requires the `riscv-tools` for `fesvr` and `verilator` to be able to build the binary.
+This stores all collateral for the tests (srcs, generated-srcs, sim binary, etc) to run "out of the gate" in the next job (make needs everything or else it will run again).
+3. Finally, run the desired tests.
+
+Other CI Setup
+--------------
+
+To get the CI to work correctly you need to create the following GH Repository Secrets
+
+| Secret | Value |
+| -------| ------------- |
+| BUILDSERVER | the hostname of the remote build server (likely be a millennium machine) |
+| BUILDUSER | the login to use on the build server |
+| BUILDDIR | the directory to use on the build server |
+| SERVERKEY | a private key to access the build server |
+
+The default.sh script defines the following,
+```bash
+CI_DIR = /path/to/where/you/want/to/store/remote/files
+```` 
+but in the future this should likely be a GH Secret too.
+
+The scripts also construct (repeatedly) a SERVER env using the above secrets 
+```bash
+SERVER = ${{ secrets.BUILDUSER }}@${{ secrets.BUILDSERVER }}
+```
+
+Additionally, you need to add under the "PERMISSIONS" "SSH Permissions" section a private key that is on the build server that you are using.
+After adding a private key, it will show a fingerprint that should be added under the jobs that need to be run.
+
+Note: On the remote server you need to have the `*.pub` key file added to the `authorized_keys` file.
+
+Additional Work
+---------------
+- It would be nice to add the ability to re-run just parts of the workflow. [See Workflows Hacks](https://github.com/jaredpalmer/razzle/blob/f8305c26997bae8ef0f5dfa52540d842451b4090/.github/workflows/examples.yml)
+
+
+Notes on CIRCLE CI
+------------------
+This code is heavily based on the origin [CircleCI]() work. There a quite a few differences
+- CCI supports workflow level variables, in GA we must define thiing like `BUILDSERVER: ${{ secrets.BUILDSERVER }}` in every job
+- CCI allows a much larger cache. The entire CY directory with toolchains and RTL could be cached, with GA there is a 5Gb total cache limit
+- GA support more parallel jobs 20 vs 4
+- GA seems to allow much longer run times
+- 

.github/actions/build-extra-tests/action.yml

@@ -0,0 +1,28 @@
+name: build-extra-tests
+description: 'Builds extra test required for some flows'
+
+inputs:
+  tools-version:
+    description: Which toolchain to build
+    required: false
+    default: 'riscv-tools'
+  cache-key:
+    description: Use this for caching
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/cache@v2
+      id: build-extra-tools-cache
+      with:
+        path: extra-tests-install
+        key: ${{ needs.make-keys.outputs.extra-tests-cache-key }}
+        restore-keys: ${{ needs.make-keys.outputs.extra-tests-cache-key }}
+    - name: Build extra tests if not cached
+      run: |
+        export RISCV="/__w/chipyard/chipyard/riscv-tools-install"
+        export LD_LIBRARY_PATH="$RISCV/lib"
+        export PATH="$RISCV/bin:$PATH"
+        .github/scripts/build-extra-tests.sh
+      shell: bash
+

.github/actions/prepare-rtl/action.yml

@@ -0,0 +1,41 @@
+name: prepare-rtl
+description: 'Builds RTL based on parameters, caches the entire chipyard root dir when done'
+
+inputs:
+  tools-version:
+    description: Which toolchain to build
+    required: false
+    default: 'riscv-tools'
+  group-key:
+    description: group key
+    required: true
+  build-script:
+    description: rtl build script to use
+    required: false
+    default: "do-rtl-build.sh"
+  build-type:
+    description: type of build
+    required: false
+    default: "sim"
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/cache@v2
+      id: rtl-build-id
+      with:
+        path: |
+          sims/verilator
+          sims/firesim/sim
+          generators/gemmini/software/gemmini-rocc-tests
+        key: ${{ inputs.group-key }}-${{ github.ref }}-${{ github.sha }}
+    - name: run rtl build script if not cached
+      run: |
+        if [[ "${{ steps.rtl-build-id.outputs.cache-hit }}" != 'true' ]]; then
+          echo "Cache miss on ${{ inputs.group-key }}-${{ github.ref }}-${{ github.sha }}"
+          ./.github/scripts/${{ inputs.build-script }} ${{ inputs.group-key }} ${{ inputs.build-type }}
+        else
+          echo "cache hit do not prepare rtl"
+        fi
+      shell: bash
+

.github/actions/run-tests/action.yml

@@ -0,0 +1,30 @@
+name: run-tests
+description: 'Runs tests according to input parameters'
+
+inputs:
+  tools-version:
+    description: Which toolchain to build
+    required: false
+    default: 'riscv-tools'
+  group-key:
+    description: group key
+    required: true
+  project-key:
+    description: project key
+    required: true
+  run-script:
+    description: rtl build script to use
+    required: false
+    default: "run-tests.sh"
+
+runs:
+  using: "composite"
+  steps:
+    - name: run rtl build script cache of chipyard root should have been loaded by prepare-rtl
+      run: |
+        export RISCV="/__w/chipyard/chipyard/riscv-tools-install"
+        export LD_LIBRARY_PATH="$RISCV/lib"
+        export PATH="$RISCV/bin:$PATH"
+        ./.github/scripts/${{ inputs.run-script }} ${{ inputs.project-key }}
+      shell: bash
+

.github/actions/toolchain-build/action.yml

@@ -0,0 +1,29 @@
+name: toolchain-build
+description: 'Builds the selected toolchain'
+
+inputs:
+  tools-version:
+    description: Which toolchain to build
+    required: false
+    default: 'riscv-tools'
+  cache-key:
+    description: Use this for caching
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/cache@v2
+      id: toolchain-build-id
+      with:
+        path: ${{ inputs.tools-version }}-install
+        key: ${{ inputs.cache-key }}
+    - name: run build toolchain if not cached
+      run: |
+        if [[ "${{ steps.toolchain-build-id.outputs.cache-hit }}" != 'true' ]]; then
+          echo "Cache miss on ${{ inputs.tools-version }}-install"
+          ./.github/scripts/build-toolchains.sh ${{ inputs.tools-version }}
+        else
+          echo "cache hit do not generate build ${{ inputs.tools-version }}"
+        fi
+      shell: bash
+

.github/scripts/build-extra-tests.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# turn echo on and error on earliest command
+set -ex
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+make -C $LOCAL_CHIPYARD_DIR/tests clean
+make -C $LOCAL_CHIPYARD_DIR/tests

.github/scripts/build-toolchains.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# create the riscv tools/esp tools binaries
+# passed in as <riscv-tools or esp-tools>
+
+# turn echo on and error on earliest command
+set -ex
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+if [ ! -d "$HOME/$1-install" ]; then
+    cd $HOME
+
+    # init all submodules including the tools
+    CHIPYARD_DIR="$LOCAL_CHIPYARD_DIR" NPROC=$CI_MAKE_NPROC $LOCAL_CHIPYARD_DIR/scripts/build-toolchains.sh $1
+fi

.github/scripts/check-commit.sh

@@ -0,0 +1,152 @@
+#!/bin/bash
+
+# check to see that submodule commits are present on the master branch
+
+# turn echo on and error on earliest command
+set -ex
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+# enter bhd repo
+cd $LOCAL_CHIPYARD_DIR
+
+# ignore the private vlsi submodules
+git config submodule.vlsi/hammer-cadence-plugins.update none
+git config submodule.vlsi/hammer-mentor-plugins.update none
+git config submodule.vlsi/hammer-synopsys-plugins.update none
+
+# initialize submodules and get the hashes
+git submodule update --init
+status=$(git submodule status)
+
+all_names=()
+
+
+search_submodule() {
+    echo "Running check on submodule $submodule in $dir"
+    hash=$(echo "$status" | grep "$dir.*$submodule " | awk '{print$1}' | grep -o "[[:alnum:]]*")
+    for branch in "${branches[@]}"
+    do
+        echo "Searching for $hash in origin/$branch of $submodule"
+        (git -C $dir/$submodule branch -r --contains "$hash" | grep "origin/$branch") && true # needs init'ed submodules
+        if [ $? -eq 0 ]
+        then
+            all_names+=("$dir/$submodule $hash 0")
+            return
+        fi
+    done
+    all_names+=("$dir/$submodule $hash 1")
+    return
+}
+
+search () {
+    for submodule in "${submodules[@]}"
+    do
+        search_submodule
+    done
+}
+
+submodules=("cva6" "boom" "gemmini" "hwacha" "icenet" "nvdla" "rocket-chip" "sha3" "sifive-blocks" "sifive-cache" "testchipip" "riscv-sodor")
+dir="generators"
+if [ "$CIRCLE_BRANCH" == "master" ] || [ "$CIRCLE_BRANCH" == "dev" ]
+then
+    branches=("master")
+else
+    branches=("master" "dev")
+fi
+search
+
+submodules=("riscv-gnu-toolchain" "riscv-isa-sim" "riscv-pk" "riscv-tests")
+dir="toolchains/esp-tools"
+branches=("master")
+search
+
+
+submodules=("riscv-gnu-toolchain" "riscv-isa-sim" "riscv-pk" "riscv-tests")
+dir="toolchains/riscv-tools"
+branches=("master")
+search
+
+# riscv-openocd doesn't use its master branch
+submodules=("riscv-openocd")
+dir="toolchains/riscv-tools"
+branches=("riscv")
+search
+
+submodules=("qemu" "libgloss")
+dir="toolchains"
+branches=("master")
+search
+
+submodules=("coremark" "firemarshal" "nvdla-workload" "spec2017")
+dir="software"
+if [ "$CIRCLE_BRANCH" == "master" ] || [ "$CIRCLE_BRANCH" == "dev" ]
+then
+    branches=("master")
+else
+    branches=("master" "dev")
+fi
+search
+
+submodules=("DRAMSim2" "axe" "barstools" "chisel-testers" "dsptools" "rocket-dsp-utils" "firrtl-interpreter" "torture" "treadle")
+dir="tools"
+if [ "$CIRCLE_BRANCH" == "master" ] || [ "$CIRCLE_BRANCH" == "dev" ]
+then
+    branches=("master")
+else
+    branches=("master" "dev")
+fi
+search
+
+submodules=("dromajo-src")
+dir="tools/dromajo"
+branches=("master")
+search
+
+submodules=("firesim")
+dir="sims"
+if [ "$CIRCLE_BRANCH" == "master" ] || [ "$CIRCLE_BRANCH" == "dev" ]
+then
+    branches=("master")
+else
+    branches=("master" "dev")
+fi
+search
+
+submodules=("hammer")
+dir="vlsi"
+branches=("master")
+search
+
+submodules=("fpga-shells")
+dir="fpga"
+branches=("master")
+search
+
+# turn off verbose printing to make this easier to read
+set +x
+
+# print 0's
+for str in "${all_names[@]}";
+do
+    if [ 0 = $(echo "$str" | awk '{print$3}') ]; then
+        echo "$str"
+    fi
+done
+
+echo ""
+
+# check if there was a non-zero return code and print 1's
+EXIT=0
+for str in "${all_names[@]}";
+do
+    if [ ! 0 = $(echo "$str" | awk '{print$3}') ]; then
+        echo "$str"
+        EXIT=1
+    fi
+done
+
+echo "Done checking all submodules"
+exit $EXIT

.github/scripts/clean-old-files.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+# clean directories that are older than 14 days
+# argument is used as the directory to look in
+
+age () {
+	local AGE_SEC
+	local CUR_SEC
+	local DIFF_SEC
+	local SEC_PER_DAY
+
+	SEC_PER_DAY=86400
+
+	CUR_SEC=$(date +%s)
+	AGE_SEC=$(stat -c %Y -- "$1")
+	DIFF_SEC=$(expr $CUR_SEC - $AGE_SEC)
+
+	echo $(expr $DIFF_SEC / $SEC_PER_DAY)
+}
+
+for d in $1/*/ ; do
+	DIR_AGE="$(age $d)"
+	if [ $DIR_AGE -ge 14 ]; then
+		echo "Deleting $d since is it $DIR_AGE old"
+		rm -rf $d
+	else
+	    echo "Keep $d since it is $DIR_AGE old"
+	fi
+done

.github/scripts/create-hash.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# get the hash of riscv-tools
+
+# turn echo on and error on earliest command
+set -ex
+set -o pipefail
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+# Use normalized output of git-submodule status as hashfile
+for tools in 'riscv-tools' 'esp-tools' ; do
+    git submodule status "toolchains/${tools}" 'toolchains/libgloss' 'toolchains/qemu' |
+    while read -r line ; do
+        echo "${line#[!0-9a-f]}"
+    done > "${tools}.hash"
+done
+echo "Hashfile for riscv-tools and esp-tools created in $HOME"

.github/scripts/defaults.sh

@@ -0,0 +1,96 @@
+#!/bin/bash
+
+copy () {
+    rsync -azp -e 'ssh' --exclude '.git' $1 $2
+}
+
+run () {
+    ssh -o "ServerAliveInterval=60" -o "StrictHostKeyChecking no" -t $SERVER $@
+}
+
+run_script () {
+    ssh -o "ServerAliveInterval=60" -o "StrictHostKeyChecking no" -t $SERVER 'bash -s' < $1 "$2"
+}
+
+clean () {
+    # remove remote work dir
+    run "rm -rf $REMOTE_WORK_DIR"
+}
+
+# make parallelism
+CI_MAKE_NPROC=4
+# chosen based on a 24c system shared with 1 other project
+REMOTE_MAKE_NPROC=4
+
+# verilator version
+VERILATOR_VERSION=v4.034
+
+# remote variables
+
+CURRENT_BRANCH=$(git branch --show-current)
+
+# CI_DIR is defined externally based on the GH repository secret BUILDDIR
+
+HOME=`pwd`
+REMOTE_PREFIX=$CI_DIR/${GITHUB_REPOSITORY#*/}-$CURRENT_BRANCH
+REMOTE_WORK_DIR=$REMOTE_PREFIX-$GITHUB_SHA-$GITHUB_JOB
+REMOTE_RISCV_DIR=$REMOTE_WORK_DIR/riscv-tools-install
+REMOTE_ESP_DIR=$REMOTE_WORK_DIR/esp-tools-install
+REMOTE_CHIPYARD_DIR=$REMOTE_WORK_DIR/chipyard
+REMOTE_SIM_DIR=$REMOTE_CHIPYARD_DIR/sims/verilator
+REMOTE_FIRESIM_DIR=$REMOTE_CHIPYARD_DIR/sims/firesim/sim
+REMOTE_FPGA_DIR=$REMOTE_CHIPYARD_DIR/fpga
+REMOTE_JAVA_OPTS="-Xmx10G -Xss8M"
+# Disable the supershell to greatly improve the readability of SBT output when captured by Circle CI
+REMOTE_SBT_OPTS="-Dsbt.ivy.home=$REMOTE_WORK_DIR/.ivy2 -Dsbt.supershell=false -Dsbt.global.base=$REMOTE_WORK_DIR/.sbt -Dsbt.boot.directory=$REMOTE_WORK_DIR/.sbt/boot"
+REMOTE_VERILATOR_DIR=$REMOTE_PREFIX-$GITHUB_SHA-verilator-install
+
+# local variables (aka within the docker container)
+LOCAL_CHECKOUT_DIR=$HOME/project
+LOCAL_RISCV_DIR=$HOME/riscv-tools-install
+LOCAL_ESP_DIR=$HOME/esp-tools-install
+LOCAL_CHIPYARD_DIR=$HOME
+LOCAL_SIM_DIR=$LOCAL_CHIPYARD_DIR/sims/verilator
+LOCAL_FIRESIM_DIR=$LOCAL_CHIPYARD_DIR/sims/firesim/sim
+
+# key value store to get the build groups
+declare -A grouping
+grouping["group-cores"]="chipyard-cva6 chipyard-rocket chipyard-hetero chipyard-boom chipyard-sodor chipyard-digitaltop chipyard-multiclock-rocket"
+grouping["group-peripherals"]="chipyard-dmirocket chipyard-blkdev chipyard-spiflashread chipyard-spiflashwrite chipyard-mmios chipyard-lbwif"
+grouping["group-accels"]="chipyard-nvdla chipyard-sha3 chipyard-hwacha chipyard-gemmini chipyard-streaming-fir chipyard-streaming-passthrough"
+grouping["group-tracegen"]="tracegen tracegen-boom"
+grouping["group-other"]="icenet testchipip"
+grouping["group-fpga"]="arty vcu118"
+
+# key value store to get the build strings
+declare -A mapping
+mapping["chipyard-rocket"]=""
+mapping["chipyard-dmirocket"]=" CONFIG=dmiRocketConfig"
+mapping["chipyard-lbwif"]=" CONFIG=LBWIFRocketConfig"
+mapping["chipyard-sha3"]=" CONFIG=Sha3RocketConfig"
+mapping["chipyard-digitaltop"]=" TOP=DigitalTop"
+mapping["chipyard-streaming-fir"]=" CONFIG=StreamingFIRRocketConfig"
+mapping["chipyard-streaming-passthrough"]=" CONFIG=StreamingPassthroughRocketConfig"
+mapping["chipyard-hetero"]=" CONFIG=LargeBoomAndRocketConfig"
+mapping["chipyard-boom"]=" CONFIG=SmallBoomConfig"
+mapping["chipyard-blkdev"]=" CONFIG=SimBlockDeviceRocketConfig"
+mapping["chipyard-hwacha"]=" CONFIG=HwachaRocketConfig"
+mapping["chipyard-gemmini"]=" CONFIG=GemminiRocketConfig"
+mapping["chipyard-cva6"]=" CONFIG=CVA6Config"
+mapping["chipyard-spiflashread"]=" CONFIG=LargeSPIFlashROMRocketConfig"
+mapping["chipyard-spiflashwrite"]=" CONFIG=SmallSPIFlashRocketConfig"
+mapping["chipyard-mmios"]=" CONFIG=MMIORocketConfig verilog"
+mapping["tracegen"]=" CONFIG=NonBlockingTraceGenL2Config"
+mapping["tracegen-boom"]=" CONFIG=BoomTraceGenConfig"
+mapping["chipyard-nvdla"]=" CONFIG=SmallNVDLARocketConfig"
+mapping["chipyard-sodor"]=" CONFIG=Sodor5StageConfig"
+mapping["chipyard-multiclock-rocket"]=" CONFIG=MulticlockRocketConfig"
+
+mapping["firesim"]="SCALA_TEST=firesim.firesim.RocketNICF1Tests"
+mapping["firesim-multiclock"]="SCALA_TEST=firesim.firesim.RocketMulticlockF1Tests"
+mapping["fireboom"]="SCALA_TEST=firesim.firesim.BoomF1Tests"
+mapping["icenet"]="SUB_PROJECT=icenet"
+mapping["testchipip"]="SUB_PROJECT=testchipip"
+
+mapping["arty"]="SUB_PROJECT=arty verilog"
+mapping["vcu118"]="SUB_PROJECT=vcu118 verilog"

.github/scripts/do-rtl-build.sh

@@ -0,0 +1,96 @@
+#!/bin/bash
+
+# create the different verilator builds
+# usage:
+#   do-rtl-build.sh <make command string> sim
+#     run rtl build for simulations and copy back results
+#   do-rtl-build.sh <make command string> fpga
+#     run rtl build for fpga and don't copy back results
+
+# turn echo on and error on earliest command
+set -ex
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+# call clean on exit
+trap clean EXIT
+
+cd $LOCAL_CHIPYARD_DIR
+./scripts/init-submodules-no-riscv-tools.sh
+./scripts/init-fpga.sh
+
+# replace the workspace dir with a local dir so you can copy around
+sed -i -E 's/(workspace=).*(\/tools)/\1$PWD\2/g' .sbtopts
+
+# set stricthostkeychecking to no (must happen before rsync)
+run "echo \"Ping $SERVER\""
+
+clean
+
+# copy over riscv/esp-tools, and chipyard to remote
+run "mkdir -p $REMOTE_CHIPYARD_DIR"
+copy $LOCAL_CHIPYARD_DIR/ $SERVER:$REMOTE_CHIPYARD_DIR
+
+run "cp -r ~/.ivy2 $REMOTE_WORK_DIR"
+run "cp -r ~/.sbt  $REMOTE_WORK_DIR"
+
+TOOLS_DIR=$REMOTE_RISCV_DIR
+LD_LIB_DIR=$REMOTE_RISCV_DIR/lib
+
+if [ $1 = "group-accels" ]; then
+    export RISCV=$LOCAL_ESP_DIR
+    export LD_LIBRARY_PATH=$LOCAL_ESP_DIR/lib
+    export PATH=$RISCV/bin:$PATH
+    GEMMINI_SOFTWARE_DIR=$LOCAL_SIM_DIR/../../generators/gemmini/software/gemmini-rocc-tests
+    cd $LOCAL_SIM_DIR/../../generators/gemmini/software
+    git submodule update --init --recursive gemmini-rocc-tests
+    cd gemmini-rocc-tests
+    ./build.sh
+
+    TOOLS_DIR=$REMOTE_ESP_DIR
+    LD_LIB_DIR=$REMOTE_ESP_DIR/lib
+    run "mkdir -p $REMOTE_ESP_DIR"
+    copy $LOCAL_ESP_DIR/ $SERVER:$REMOTE_ESP_DIR
+else
+    run "mkdir -p $REMOTE_RISCV_DIR"
+    copy $LOCAL_RISCV_DIR/ $SERVER:$REMOTE_RISCV_DIR
+fi
+
+# choose what make dir to use
+
+case $2 in
+    "sim")
+        REMOTE_MAKE_DIR=$REMOTE_SIM_DIR
+        ;;
+    "fpga")
+        REMOTE_MAKE_DIR=$REMOTE_FPGA_DIR
+        ;;
+esac
+
+# enter the verilator directory and build the specific config on remote server
+run "export RISCV=\"$TOOLS_DIR\"; \
+     make -C $REMOTE_MAKE_DIR clean;"
+
+read -a keys <<< ${grouping[$1]}
+
+# need to set the PATH to use the new verilator (with the new verilator root)
+for key in "${keys[@]}"
+do
+    run "export RISCV=\"$TOOLS_DIR\"; \
+         export LD_LIBRARY_PATH=\"$LD_LIB_DIR\"; \
+         export PATH=\"$REMOTE_VERILATOR_DIR/bin:\$PATH\"; \
+         export VERILATOR_ROOT=\"$REMOTE_VERILATOR_DIR\"; \
+         export COURSIER_CACHE=\"$REMOTE_WORK_DIR/.coursier-cache\"; \
+         make -j$REMOTE_MAKE_NPROC -C $REMOTE_MAKE_DIR FIRRTL_LOGLEVEL=info JAVA_OPTS=\"$REMOTE_JAVA_OPTS\" SBT_OPTS=\"$REMOTE_SBT_OPTS\" ${mapping[$key]}"
+done
+
+run "rm -rf $REMOTE_CHIPYARD_DIR/project"
+
+# choose to copy back results
+if [ $2 = "sim" ]; then
+    # copy back the final build
+    mkdir -p $LOCAL_CHIPYARD_DIR
+    copy $SERVER:$REMOTE_CHIPYARD_DIR/ $LOCAL_CHIPYARD_DIR
+fi

.github/scripts/install-verilator.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# move verilator to the remote server
+
+# turn echo on and error on earliest command
+set -ex
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+# clean older directories (delete prior directories related to this branch also)
+run_script $LOCAL_CHIPYARD_DIR/.github/scripts/clean-old-files.sh $CI_DIR
+run "rm -rf $REMOTE_PREFIX*"
+
+# set stricthostkeychecking to no (must happen before rsync)
+run "echo \"Ping $SERVER\""
+
+run "git clone http://git.veripool.org/git/verilator $REMOTE_VERILATOR_DIR; \
+     cd $REMOTE_VERILATOR_DIR; \
+     git checkout $VERILATOR_VERSION; \
+     autoconf; \
+     export VERILATOR_ROOT=$REMOTE_VERILATOR_DIR; \
+     ./configure; \
+     make -j$REMOTE_MAKE_NPROC;"

.github/scripts/run-firesim-scala-tests.sh

@@ -0,0 +1,62 @@
+#!/bin/bash
+
+# create the different verilator builds
+# argument is the make command string
+
+# turn echo on and error on earliest command
+set -ex
+
+# get shared variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+# call clean on exit
+trap clean EXIT
+
+# Directory locations for handling firesim-local installations of libelf/libdwarf
+# This would generally be handled by build-setup.sh/firesim-setup.sh
+firesim_sysroot=lib-install
+local_firesim_sysroot=$LOCAL_FIRESIM_DIR/$firesim_sysroot
+remote_firesim_sysroot=$REMOTE_FIRESIM_DIR/$firesim_sysroot
+
+cd $LOCAL_CHIPYARD_DIR
+./scripts/init-submodules-no-riscv-tools.sh
+cd $LOCAL_CHIPYARD_DIR/sims/firesim/sim/firesim-lib/src/main/cc/lib
+git submodule update --init elfutils libdwarf
+cd $LOCAL_CHIPYARD_DIR/sims/firesim
+mkdir -p $local_firesim_sysroot
+./scripts/build-libelf.sh $local_firesim_sysroot
+./scripts/build-libdwarf.sh $local_firesim_sysroot
+cd $LOCAL_CHIPYARD_DIR
+
+# replace the workspace dir with a local dir so you can copy around
+sed -i -E 's/(workspace=).*(\/tools)/\1$PWD\2/g' .sbtopts
+
+make -C $LOCAL_CHIPYARD_DIR/tools/dromajo/dromajo-src/src
+
+# set stricthostkeychecking to no (must happen before rsync)
+run "echo \"Ping $SERVER\""
+
+clean
+
+# copy over riscv/esp-tools, and chipyard to remote
+run "mkdir -p $REMOTE_CHIPYARD_DIR"
+run "mkdir -p $REMOTE_RISCV_DIR"
+copy $LOCAL_CHIPYARD_DIR/ $SERVER:$REMOTE_CHIPYARD_DIR
+copy $LOCAL_RISCV_DIR/ $SERVER:$REMOTE_RISCV_DIR
+
+run "cp -r ~/.ivy2 $REMOTE_WORK_DIR"
+run "cp -r ~/.sbt  $REMOTE_WORK_DIR"
+
+TOOLS_DIR=$REMOTE_RISCV_DIR
+
+LD_LIB_DIR=$remote_firesim_sysroot/lib:$REMOTE_RISCV_DIR/lib
+
+# Run Firesim Scala Tests
+run "export RISCV=\"$TOOLS_DIR\"; \
+     export LD_LIBRARY_PATH=\"$LD_LIB_DIR\"; \
+     export FIRESIM_ENV_SOURCED=1; \
+     export PATH=\"$REMOTE_VERILATOR_DIR/bin:\$PATH\"; \
+     export VERILATOR_ROOT=\"$REMOTE_VERILATOR_DIR\"; \
+     export COURSIER_CACHE=\"$REMOTE_WORK_DIR/.coursier-cache\"; \
+     make -C $REMOTE_FIRESIM_DIR JAVA_OPTS=\"$REMOTE_JAVA_OPTS\" SBT_OPTS=\"$REMOTE_SBT_OPTS\" testOnly ${mapping[$1]}"

.github/scripts/run-tests.sh

@@ -0,0 +1,117 @@
+#!/bin/bash
+
+# run the different tests
+
+# turn echo on and error on earliest command
+set -ex
+
+# get remote exec variables
+SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
+source $SCRIPT_DIR/defaults.sh
+
+run_bmark () {
+    make run-bmark-tests-fast -j$CI_MAKE_NPROC -C $LOCAL_SIM_DIR $@
+}
+
+run_asm () {
+    make run-asm-tests-fast -j$CI_MAKE_NPROC -C $LOCAL_SIM_DIR $@
+}
+
+run_both () {
+    run_bmark $@
+    run_asm $@
+}
+
+run_tracegen () {
+    make tracegen -C $LOCAL_SIM_DIR $@
+}
+
+# TODO BUG: the run-binary command forces a rebuild of the simulator in CI
+#           instead, directly run the simulator binary
+case $1 in
+    chipyard-rocket)
+        run_bmark ${mapping[$1]}
+        ;;
+    chipyard-dmirocket)
+        run_bmark ${mapping[$1]}
+        ;;
+    chipyard-lbwif)
+        run_bmark ${mapping[$1]}
+        ;;
+    chipyard-boom)
+        run_bmark ${mapping[$1]}
+        ;;
+    chipyard-hetero)
+        run_bmark ${mapping[$1]}
+        ;;
+    rocketchip)
+        run_bmark ${mapping[$1]}
+        ;;
+    chipyard-hwacha)
+        export RISCV=$LOCAL_ESP_DIR
+        export LD_LIBRARY_PATH=$LOCAL_ESP_DIR/lib
+        export PATH=$RISCV/bin:$PATH
+        make run-rv64uv-p-asm-tests -j$CI_MAKE_NPROC -C $LOCAL_SIM_DIR ${mapping[$1]}
+        ;;
+    chipyard-gemmini)
+        export RISCV=$LOCAL_ESP_DIR
+        export LD_LIBRARY_PATH=$LOCAL_ESP_DIR/lib
+        export PATH=$RISCV/bin:$PATH
+        GEMMINI_SOFTWARE_DIR=$LOCAL_SIM_DIR/../../generators/gemmini/software/gemmini-rocc-tests
+        rm -rf $GEMMINI_SOFTWARE_DIR/riscv-tests
+        cd $LOCAL_SIM_DIR
+        $LOCAL_SIM_DIR/simulator-chipyard-GemminiRocketConfig $GEMMINI_SOFTWARE_DIR/build/bareMetalC/aligned-baremetal
+        $LOCAL_SIM_DIR/simulator-chipyard-GemminiRocketConfig $GEMMINI_SOFTWARE_DIR/build/bareMetalC/raw_hazard-baremetal
+        $LOCAL_SIM_DIR/simulator-chipyard-GemminiRocketConfig $GEMMINI_SOFTWARE_DIR/build/bareMetalC/mvin_mvout-baremetal
+        ;;
+    chipyard-sha3)
+        export RISCV=$LOCAL_ESP_DIR
+        export LD_LIBRARY_PATH=$LOCAL_ESP_DIR/lib
+        export PATH=$RISCV/bin:$PATH
+        (cd $LOCAL_CHIPYARD_DIR/generators/sha3/software && ./build.sh)
+        $LOCAL_SIM_DIR/simulator-chipyard-Sha3RocketConfig $LOCAL_CHIPYARD_DIR/generators/sha3/software/tests/bare/sha3-rocc.riscv
+        ;;
+    chipyard-streaming-passthrough)
+        make -C $LOCAL_CHIPYARD_DIR/tests
+        $LOCAL_SIM_DIR/simulator-chipyard-StreamingPassthroughRocketConfig $LOCAL_CHIPYARD_DIR/tests/streaming-passthrough.riscv
+        ;;
+    chipyard-streaming-fir)
+        make -C $LOCAL_CHIPYARD_DIR/tests
+        $LOCAL_SIM_DIR/simulator-chipyard-StreamingFIRRocketConfig $LOCAL_CHIPYARD_DIR/tests/streaming-fir.riscv
+        ;;
+    chipyard-spiflashread)
+        make -C $LOCAL_CHIPYARD_DIR/tests
+        make -C $LOCAL_SIM_DIR ${mapping[$1]} BINARY=$LOCAL_CHIPYARD_DIR/tests/spiflashread.riscv SIM_FLAGS="+spiflash0=${LOCAL_CHIPYARD_DIR}/tests/spiflash.img" run-binary
+        ;;
+    chipyard-spiflashwrite)
+        make -C $LOCAL_CHIPYARD_DIR/tests
+        make -C $LOCAL_SIM_DIR ${mapping[$1]} BINARY=$LOCAL_CHIPYARD_DIR/tests/spiflashwrite.riscv SIM_FLAGS="+spiflash0=${LOCAL_CHIPYARD_DIR}/tests/spiflash.img" run-binary
+        [[ "`xxd $LOCAL_CHIPYARD_DIR/tests/spiflash.img  | grep 1337\ 00ff\ aa55\ face | wc -l`" == "6" ]] || false
+        ;;
+    tracegen)
+        run_tracegen ${mapping[$1]}
+        ;;
+    tracegen-boom)
+        run_tracegen ${mapping[$1]}
+        ;;
+    chipyard-cva6)
+        make run-binary-fast -C $LOCAL_SIM_DIR ${mapping[$1]} BINARY=$RISCV/riscv64-unknown-elf/share/riscv-tests/benchmarks/multiply.riscv
+        ;;
+    chipyard-sodor)
+        run_asm ${mapping[$1]}
+        ;;
+    chipyard-nvdla)
+        make -C $LOCAL_CHIPYARD_DIR/tests
+        make -C $LOCAL_SIM_DIR ${mapping[$1]} BINARY=$LOCAL_CHIPYARD_DIR/tests/nvdla.riscv run-binary
+        ;;
+    icenet)
+        make run-binary-fast BINARY=none -C $LOCAL_SIM_DIR ${mapping[$1]}
+        ;;
+    testchipip)
+        make run-binary-fast BINARY=none -C $LOCAL_SIM_DIR ${mapping[$1]}
+        ;;
+    *)
+        echo "No set of tests for $1. Did you spell it right?"
+        exit 1
+        ;;
+esac