Merge remote-tracking branch 'origin/main' into obus_switch

.gitattributes

@@ -1,2 +1,2 @@
-conda-reqs/conda-lock-reqs/conda-requirements-esp-tools-linux-64.conda-lock.yml linguist-generated=true
+conda-reqs/conda-lock-reqs/conda-requirements-riscv-tools-linux-64-lean.conda-lock.yml linguist-generated=true
 conda-reqs/conda-lock-reqs/conda-requirements-riscv-tools-linux-64.conda-lock.yml linguist-generated=true

.github/PULL_REQUEST_TEMPLATE.md

@@ -42,3 +42,12 @@ Provide a brief description of the PR immediately below this comment, if the tit
 - [ ] (If applicable) Did you add a test demonstrating the PR?
 <!-- Do this if this PR is a bugfix that should be applied to the latest release -->
 - [ ] (If applicable) Did you mark the PR as `Please Backport`?
+
+
+**CI Help**:
+Add the following labels to modify the CI for a set of features.
+Generally, a label added only affect subsequent changes to the PR (i.e. new commits, force pushing, closing/reopening).
+See `ci:*` for full list of labels:
+- `ci:fpga-deploy` - Run FPGA-based E2E testing
+- `ci:local-fpga-buildbitstream-deploy` - Build local FPGA bitstreams for platforms that are released
+- `ci:disable` - Disable CI

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

@@ -19,6 +19,7 @@ runs:
     - name: Init submodules (since only the RTL is cached)
       run: |
         conda activate ${{ env.conda-env-name-no-time }}-$(date --date "${{ env.workflow-timestamp }}" +%Y%m%d)
+        git submodule sync
         ./scripts/init-submodules-no-riscv-tools.sh
       shell: bash -leo pipefail {0}
 

.github/scripts/build-default-bitstreams.py

@@ -0,0 +1,265 @@
+#!/usr/bin/env python3
+
+from pathlib import Path
+from fabric.api import prefix, run, settings, execute # type: ignore
+import sys
+
+import fabric_cfg
+from ci_variables import ci_env, remote_fsim_dir, remote_cy_dir
+from github_common import move_and_commit_gh_file
+from utils import print_last_firesim_log
+
+from typing import List, Tuple
+
+URL_PREFIX = f"https://raw.githubusercontent.com/{ci_env['GH_ORG']}/{ci_env['GH_REPO']}"
+
+shared_build_dir = "/scratch/buildbot/FIRESIM_BUILD_DIR"
+
+from_chipyard_firesim_build_recipes = "sims/firesim-staging/sample_config_build_recipes.yaml"
+from_chipyard_firesim_hwdb = ci_env['CHIPYARD_HWDB_PATH']
+# this must point to build recipe in clone setup for firesim s.t. the makefrag it points to itself points to the working clone
+setup_clone_firesim_build_recipes = f"{remote_cy_dir}/{from_chipyard_firesim_build_recipes}"
+workspace_firesim_hwdb = f"{ci_env['GITHUB_WORKSPACE']}/{from_chipyard_firesim_hwdb}"
+assert Path(setup_clone_firesim_build_recipes).exists()
+assert Path(workspace_firesim_hwdb).exists()
+
+# host assumptions:
+#   - firesim's machine-launch-script requirements are already installed (i.e. sudo scripts on all machines)
+#   - XILINX_VITIS, XILINX_XRT, XILINX_VIVADO are setup (in environtment - LD_LIBRARY_PATH/PATH/etc)
+# priority == roughly the more powerful and available
+# ipaddr, buildtool:version, use unique build dir, unique build dir path, priority (0 is highest)(unused by code but used to track which machine has most resources)
+build_hosts = [
+    (    "localhost",  "vivado:2022.1", False, "", 0),
+    ("buildbot1@as4",  "vivado:2022.1",  True, "/scratch/buildbot1/FIRESIM_BUILD_DIR", 0),
+    ("buildbot2@as4",  "vivado:2022.1",  True, "/scratch/buildbot2/FIRESIM_BUILD_DIR", 0),
+    (          "a17",   "vitis:2022.1", False, "", 0),
+    ("buildbot1@a17",   "vitis:2022.1",  True, "/scratch/buildbot1/FIRESIM_BUILD_DIR", 0),
+    ("buildbot2@a17",   "vitis:2021.1",  True, "/scratch/buildbot2/FIRESIM_BUILD_DIR", 0),
+    ("buildbot3@a17",   "vitis:2021.1",  True, "/scratch/buildbot3/FIRESIM_BUILD_DIR", 0),
+    ("buildbot4@a17",   "vitis:2021.1",  True, "/scratch/buildbot4/FIRESIM_BUILD_DIR", 0),
+    (     "firesim1",   "vitis:2021.1", False, "", 1),
+    (        "jktgz",  "vivado:2023.1", False, "", 2),
+    (       "jktqos",  "vivado:2023.1", False, "", 2),
+]
+
+def positive_hash(any) -> int:
+    return hash(any) % 2**sys.hash_info.width
+
+# add builds to run into a config_build.yaml
+def modify_config_build(in_config_build_yaml, out_config_build_yaml, hwdb_entries_to_gen: List[str]) -> None:
+    global shared_build_dir
+
+    # comment out old lines
+    build_yaml_lines = open(in_config_build_yaml).read().split("\n")
+    with open(out_config_build_yaml, "w") as byf:
+        for line in build_yaml_lines:
+            if "- midas" in line:
+                # comment out midasexample lines
+                byf.write("# " + line + '\n')
+            elif 'default_build_dir:' in line:
+                byf.write(line.replace('null', shared_build_dir) + '\n')
+            else:
+                byf.write(line + '\n')
+
+    # add new builds to run
+    build_yaml_lines = open(out_config_build_yaml).read().split("\n")
+    with open(out_config_build_yaml, "w") as byf:
+        for line in build_yaml_lines:
+            if "builds_to_run:" in line and not "#" in line:
+                byf.write(line + '\n')
+                start_space_idx = line.index('b')
+                for hwdb_to_gen in hwdb_entries_to_gen:
+                        byf.write((' ' * (start_space_idx + 4)) + f"- {hwdb_to_gen}" + '\n')
+            else:
+                byf.write(line + '\n')
+
+# add hosts for builds to run into a config_build.yaml
+def add_host_list(in_build_yaml: str, out_build_yaml: str, hostlist: List[Tuple[str, bool, str]]) -> None:
+    build_yaml_lines = open(in_build_yaml).read().split("\n")
+    with open(out_build_yaml, "w") as byf:
+        for line in build_yaml_lines:
+            if "build_farm_hosts:" in line and not "#" in line:
+                byf.write(line + '\n')
+                start_space_idx = line.index('b')
+                for host, use_unique, unique_build_dir in hostlist:
+                    if use_unique:
+                        byf.write((' ' * (start_space_idx + 4)) + f"- {host}:" + '\n')
+                        byf.write((' ' * (start_space_idx + 8)) + f"override_build_dir: {unique_build_dir}" + '\n')
+                    else:
+                        byf.write((' ' * (start_space_idx + 4)) + f"- {host}" + '\n')
+            elif '- localhost' in line and not '#' in line:
+                byf.write("# " + line + '\n')
+            else:
+                byf.write(line + '\n')
+
+# replace hwdb entry in config_hwdb.yaml with a link
+def replace_in_hwdb(hwdb_file: str, hwdb_entry_name: str, link: str) -> None:
+    # replace the sample hwdb's bit line only
+    sample_hwdb_lines = open(hwdb_file).read().split('\n')
+
+    with open(hwdb_file, "w") as sample_hwdb_file:
+        match_bit = False
+        for line in sample_hwdb_lines:
+            if hwdb_entry_name in line.strip().split(' ')[0].replace(':', ''):
+                # hwdb entry matches key name
+                match_bit = True
+                sample_hwdb_file.write(line + '\n')
+            elif match_bit == True:
+                if ("bitstream_tar:" in line.strip().split(' ')[0]):
+                    # only replace this bit
+                    match_bit = False
+
+                    new_bit_line = f"    bitstream_tar: {link}"
+                    print(f"Replacing {line.strip()} with {new_bit_line}")
+
+                    # print out the bit line
+                    sample_hwdb_file.write(new_bit_line + '\n')
+                else:
+                    raise Exception("::ERROR:: Something went wrong")
+            else:
+                # if no match print other lines
+                sample_hwdb_file.write(line + '\n')
+
+        if match_bit == True:
+            raise Exception(f"::ERROR:: Unable to replace URL for {hwdb_entry_name} in {hwdb_file}")
+
+    # strip newlines from end of file
+    with open(hwdb_file, "r+") as sample_hwdb_file:
+        content = sample_hwdb_file.read()
+        content = content.rstrip('\n')
+        sample_hwdb_file.seek(0)
+
+        sample_hwdb_file.write(content)
+        sample_hwdb_file.truncate()
+
+def run_local_buildbitstreams():
+    """Runs local buildbitstreams"""
+
+    global workspace_firesim_hwdb
+
+    with prefix(f"cd {remote_fsim_dir}"):
+        with prefix('source sourceme-manager.sh --skip-ssh-setup'):
+
+            def build_upload(build_yaml: str, hwdb_entries: List[str], platforms: List[str]) -> List[str]:
+                global URL_PREFIX
+                global setup_clone_firesim_build_recipes
+
+                print(f"Printing {build_yaml}...")
+                run(f"cat {build_yaml}")
+
+                rc = 0
+                with settings(warn_only=True):
+                    # pty=False needed to avoid issues with screen -ls stalling in fabric
+                    build_result = run(f"timeout 10h firesim buildbitstream -b {build_yaml} -r {setup_clone_firesim_build_recipes} --forceterminate", pty=False)
+                    rc = build_result.return_code
+
+                if rc != 0:
+                    print(f"Buildbitstream failed.")
+                    print_last_firesim_log(200)
+                    raise Exception(f"Failed with code: {rc}")
+
+                hwdb_entry_dir = f"{remote_fsim_dir}/deploy/built-hwdb-entries"
+                links = []
+
+                for hwdb_entry_name, platform in zip(hwdb_entries, platforms):
+                    hwdb_entry = f"{hwdb_entry_dir}/{hwdb_entry_name}"
+
+                    print(f"Printing {hwdb_entry}...")
+                    run(f"cat {hwdb_entry}")
+
+                    with open(hwdb_entry, 'r') as hwdbef:
+                        lines = hwdbef.readlines()
+                        for line in lines:
+                            if "bitstream_tar:" in line:
+                                file_path = Path(line.strip().split(' ')[1].replace('file://', '')) # 2nd element (i.e. the path) (no URI)
+                                file_name = f"{platform}/{hwdb_entry_name}.tar.gz"
+                                run(f"shasum -a 256 {file_path}")
+                                sha = move_and_commit_gh_file(file_path, file_name, f"{ci_env['GITHUB_WORKSPACE']}/{ci_env['GH_REPO']}", f"Committing files from {ci_env['GITHUB_REPOSITORY']}:{ci_env['GITHUB_SHA']}")
+                                link = f"{URL_PREFIX}/{sha}/{file_name}"
+                                print(f"Uploaded bitstream_tar for {hwdb_entry_name} to {link}")
+                                links.append(link)
+                                break
+
+                return links
+
+
+            def do_builds(batch_hwdbs, hwdb_file_to_replace):
+                assert len(build_hosts) >= len(batch_hwdbs), f"Need at least {len(batch_hwdbs)} build_hosts to run builds"
+
+                # map hwdb tuple to build_hosts
+                hwdb_2_host = {}
+                for hwdb, platform, buildtool_version in batch_hwdbs:
+                    for host_name, host_buildtool_version, host_use_unique, host_unique_build_dir, host_prio in build_hosts:
+                        if host_buildtool_version == buildtool_version:
+                            if not host_name in [h[0] for h in hwdb_2_host.values()]:
+                                hwdb_2_host[hwdb] = (host_name, host_use_unique, host_unique_build_dir)
+                                break
+
+                assert len(hwdb_2_host) == len(batch_hwdbs), "Unable to map build_hosts to hwdb build"
+
+                hwdbs_ordered = [hwdb[0] for hwdb in batch_hwdbs]
+                platforms_ordered = [hwdb[1] for hwdb in batch_hwdbs]
+                hosts_ordered = hwdb_2_host.values()
+
+                print("Mappings")
+                print(f"HWDBS: {hwdbs_ordered}")
+                print(f"Platforms: {platforms_ordered}")
+                print(f"build_hosts: {hosts_ordered}")
+
+                og_build_yaml = f"{remote_fsim_dir}/deploy/config_build.yaml"
+                intermediate_build_yaml = f"{remote_fsim_dir}/deploy/config_build_{positive_hash(tuple(hwdbs_ordered))}.yaml"
+                final_build_yaml = f"{remote_fsim_dir}/deploy/config_build_{positive_hash(tuple(hosts_ordered))}.yaml"
+
+                modify_config_build(og_build_yaml, intermediate_build_yaml, hwdbs_ordered)
+                add_host_list(intermediate_build_yaml, final_build_yaml, hosts_ordered)
+                links = build_upload(final_build_yaml, hwdbs_ordered, platforms_ordered)
+                for hwdb, link in zip(hwdbs_ordered, links):
+                    replace_in_hwdb(hwdb_file_to_replace, hwdb, link)
+
+                print(f"Printing {hwdb_file_to_replace}...")
+                run(f"cat {hwdb_file_to_replace}")
+
+                # wipe old data
+                print("Cleaning old build directories")
+                for host_name, host_use_unique, host_unique_build_dir in hosts_ordered:
+                    if host_use_unique:
+                        run(f"ssh {host_name} rm -rf {host_unique_build_dir}")
+                    else:
+                        run(f"ssh {host_name} rm -rf {shared_build_dir}")
+
+            # note: next two statements can be duplicated to run different builds in phases
+            # i.e. run 4 agfis in 1st phase, then 6 in next
+
+            # order of following list roughly corresponds to build host to use.
+            # i.e. if 1st hwdb in list wants a host with V0 of tools, it will get the 1st host with V0 of tools
+            # in the build_hosts list
+
+            # hwdb_entry_name, platform_name, buildtool:version
+            batch_hwdbs_in = [
+                # hwdb's to verify FPGA builds
+
+                # TODO: disable due to not having xrt installed on localhost
+                #("vitis_firesim_rocket_singlecore_no_nic", "vitis", "vitis:2022.1"),
+
+                ("nitefury_firesim_rocket_singlecore_no_nic", "rhsresearch_nitefury_ii", "vitis:2022.1"),
+                ("alveo_u200_firesim_rocket_singlecore_no_nic", "xilinx_alveo_u200", "vitis:2021.1"),
+                ("alveo_u250_firesim_rocket_singlecore_no_nic", "xilinx_alveo_u250", "vitis:2021.1"),
+                ("alveo_u280_firesim_rocket_singlecore_no_nic", "xilinx_alveo_u280", "vitis:2021.1"),
+
+                # TODO: disable due to not having a license
+                #("xilinx_vcu118_firesim_rocket_singlecore_4GB_no_nic", "xilinx_vcu118", "vivado:2023.1"),
+
+                # extra hwdb's to run CI with
+                ("alveo_u250_firesim_rocket_quadcore_no_nic", "xilinx_alveo_u250", "vivado:2022.1"),
+                ("alveo_u250_firesim_boom_singlecore_no_nic", "xilinx_alveo_u250", "vivado:2022.1"),
+                ("alveo_u250_firesim_rocket_singlecore_nic", "xilinx_alveo_u250", "vivado:2022.1"),
+
+                # extra hwdb's
+                ("alveo_u250_firesim_gemmini_rocket_singlecore_no_nic", "xilinx_alveo_u250", "vitis:2021.1"),
+            ]
+
+            # replace hwdb entries in workspace area
+            do_builds(batch_hwdbs_in, workspace_firesim_hwdb)
+
+if __name__ == "__main__":
+    execute(run_local_buildbitstreams, hosts=["localhost"])

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

@@ -7,5 +7,6 @@ set -ex
 SCRIPT_DIR="$( cd "$( dirname "$0" )" && pwd )"
 source $SCRIPT_DIR/defaults.sh
 
-make -C $LOCAL_CHIPYARD_DIR/tests clean
-make -C $LOCAL_CHIPYARD_DIR/tests
+cmake $LOCAL_CHIPYARD_DIR/tests/ -S $LOCAL_CHIPYARD_DIR/tests/ -B $LOCAL_CHIPYARD_DIR/tests/build/ -D CMAKE_BUILD_TYPE=Debug
+cmake --build $LOCAL_CHIPYARD_DIR/tests/build/ --target clean
+cmake --build $LOCAL_CHIPYARD_DIR/tests/build/ --target all

.github/scripts/check-commit.sh

@@ -46,7 +46,7 @@ search () {
 }
 
 
-submodules=("cva6" "boom" "ibex" "gemmini" "icenet" "nvdla" "rocket-chip" "rocket-chip-blocks" "rocket-chip-inclusive-cache" "testchipip" "riscv-sodor" "mempress" "bar-fetchers" "shuttle" "constellation" "fft-generator" "hardfloat" "caliptra-aes-acc" "rocc-acc-utils" "diplomacy" "rerocc" "compress-acc")
+submodules=("cva6" "boom" "ibex" "gemmini" "icenet" "nvdla" "rocket-chip" "rocket-chip-blocks" "rocket-chip-inclusive-cache" "testchipip" "riscv-sodor" "mempress" "bar-fetchers" "shuttle" "constellation" "fft-generator" "hardfloat" "caliptra-aes-acc" "rocc-acc-utils" "diplomacy" "rerocc" "compress-acc" "saturn" "ara" "vexiiriscv")
 dir="generators"
 branches=("master" "main" "dev")
 search
@@ -83,7 +83,7 @@ dir="software"
 branches=("master" "dev")
 search
 
-submodules=("DRAMSim2" "axe" "dsptools" "dsptools-chisel3" "rocket-dsp-utils" "torture" "fixedpoint" "fixedpoint-chisel3" "cde" "midas-targetutils")
+submodules=("DRAMSim2" "axe" "dsptools" "rocket-dsp-utils" "torture" "fixedpoint" "cde" "firrtl2")
 dir="tools"
 branches=("master" "dev" "main")
 search

.github/scripts/ci_variables.py

@@ -0,0 +1,61 @@
+import os
+
+# This package contains utilities that rely on environment variable
+# definitions present only on the CI container instance.
+
+GITHUB_ACTIONS_ENV_VAR_NAME = 'GITHUB_ACTIONS'
+RUN_LOCAL = os.environ.get(GITHUB_ACTIONS_ENV_VAR_NAME, 'false') == 'false'
+
+# When running locally (not in a CI pipeline) run commands out of the clone hosting this file.
+# Should be equivalent to GITHUB_WORKSPACE if running locally
+local_cy_dir = os.path.normpath((os.path.realpath(__file__)) + "/../../..")
+
+def get_ci_value(env_var: str, default_value: str = "") -> str:
+    if RUN_LOCAL:
+        return default_value
+    else:
+        return os.environ.get(env_var, default_value)
+
+# Create a env. dict that is populated from the environment or from defaults.
+ci_env = {
+    # If not running under a CI pipeline defaults are provided that
+    # will suffice to run scripts that do not use GHA API calls.
+    # To manually provide environment variable settings, export GITHUB_ACTIONS=true, and provide
+    # values for all of the environment variables listed.
+    GITHUB_ACTIONS_ENV_VAR_NAME: 'false' if RUN_LOCAL else 'true', # type: ignore
+    # This is used as a unique tag for all instances launched in a workflow
+    'GITHUB_RUN_ID': get_ci_value('GITHUB_RUN_ID'),
+    # Self explanatory
+    'GITHUB_SHA': get_ci_value('GITHUB_SHA'),
+    # Multiple clones of the Chipyard repository exists on a CI machine. We expect state
+    # to persist between jobs in a workflow and faciliate that by having jobs run
+    # out of a centralized clone (REMOTE_WORK_DIR)-- not the default clones setup by
+    # the GHA runners (GITHUB_WORKSPACE)
+    # This is the location of the clone setup by the GHA runner infrastructure by default
+    # expanduser to replace the ~ present in the default, for portability
+    'GITHUB_WORKSPACE': os.path.expanduser(os.environ['GITHUB_WORKSPACE']) if not RUN_LOCAL else local_cy_dir,
+    # Self explanatory
+    'GITHUB_API_URL': get_ci_value('GITHUB_API_URL'),
+    # We look this up, instead of hardcoding "ucb-bar/chipyard", to support running
+    # this CI pipeline under forks.
+    'GITHUB_REPOSITORY': get_ci_value('GITHUB_REPOSITORY'),
+    # Path to webhook payload on the runner machine
+    'GITHUB_EVENT_PATH': get_ci_value('GITHUB_EVENT_PATH'),
+    # Chipyard repo used on local CI machine to run tests from (cached across all workflow CI jobs)
+    # CI scripts should refer variables
+    # derived from this path so that they may be reused across workflows that may
+    # initialize the Chipyard repository differently (e.g., as a submodule of a
+    # larger project.)
+    'REMOTE_WORK_DIR': get_ci_value('REMOTE_WORK_DIR', local_cy_dir if RUN_LOCAL else ""),
+    # Github token with more permissions to access repositories across the FireSim org.
+    'PERSONAL_ACCESS_TOKEN': get_ci_value('PERSONAL_ACCESS_TOKEN'),
+    # Path to Chipyard's HWDB file (if it exists)
+    'CHIPYARD_HWDB_PATH': get_ci_value('CHIPYARD_HWDB_PATH'),
+    # Org/repo name of repository to store build bitstreams
+    'GH_ORG': get_ci_value('GH_ORG'),
+    'GH_REPO': get_ci_value('GH_REPO'),
+}
+
+# for most uses these should be used (over using GITHUB_WORKSPACE)
+remote_cy_dir = ci_env['REMOTE_WORK_DIR']
+remote_fsim_dir = ci_env['REMOTE_WORK_DIR'] + "/sims/firesim"