diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..4566a46 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,80 @@ +name: Chipyard Megaboom Benchmark + +on: + workflow_dispatch: + push: + pull_request: + +jobs: + install-chipyard: + name: Install Chipyard + runs-on: ubuntu-latest + container: + image: ghcr.io/antmicro/megaboom-cpu-benchmarking:latest + defaults: + run: + shell: bash + env: + DEBIAN_FRONTEND: "noninteractive" + steps: + - name: install chipyard + id: install_chipyard + run: | + git clone https://github.com/ucb-bar/chipyard.git + pushd chipyard + git checkout 1.11.0 + ./build-setup.sh riscv-tools -s 5 -s 6 -s 7 -s 8 -s 9 + popd + tar -czf chipyard.tar.gz chipyard/ + - name: upload artifact + id: upload_artifact + uses: actions/upload-artifact@v4 + with: + name: chipyard.tar.gz + path: ./ + + binary-tests: + name: Binary test + needs: install-chipyard + runs-on: ubuntu-latest + container: + image: ghcr.io/antmicro/megaboom-cpu-benchmarking:latest + defaults: + run: + shell: bash + strategy: + fail-fast: false + matrix: + CONFIG: ["RocketConfig", "MegaBoomConfig"] + BINARY: ["../../tests/hello.riscv", "../../software/coremark/riscv-coremark/coremark.bare.riscv"] + env: + DEBIAN_FRONTEND: "noninteractive" + steps: + - name: Download artifact + uses: actions/download-artifact@v3 + with: + name: chipyard.tar.gz + path: ./ + - name: Unpack artifact + run: | + tar -xf chipyard.tar.gz chipyard/ + - name: Coremark + run: | + pushd chipyard + source env.sh + git submodule update --init --recursive software/coremark + pushd software/coremark + ./build.sh + popd + popd + - name: Binary test + id: binary_test + run: | + pushd chipyard + source env.sh + pushd sims/verilator + make run-binary CONFIG=${CONFIG} BINARY=${BINARY} + popd + popd + + diff --git a/.github/workflows/ci_docker.yml b/.github/workflows/ci_docker.yml new file mode 100644 index 0000000..34dfd8c --- /dev/null +++ b/.github/workflows/ci_docker.yml @@ -0,0 +1,31 @@ +name: docker update + +on: + workflow_dispatch: + # push: + # pull_request: + + +jobs: + docker: + runs-on: ubuntu-latest + env: + IMAGE: ghcr.io/antmicro/megaboom-cpu-benchmarking + steps: + - uses: actions/checkout@v3 + - name: Build docker image + run: | + docker build -t "${{ env.IMAGE }}" . + + - name: Login to GitHub Container Registry (GHCR) + if: github.event_name != 'pull_request' && github.repository == 'antmicro/megaboom-cpu-benchmarking' + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: gha + password: ${{ github.token }} + + - name: Push container image to GitHub Container Registry (GHCR) + if: github.event_name != 'pull_request' && github.repository == 'antmicro/megaboom-cpu-benchmarking' + run: docker push $IMAGE + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..a2a26ad --- /dev/null +++ b/Dockerfile @@ -0,0 +1,45 @@ +# Chipyard setup + +FROM ubuntu:22.04 + +SHELL [ "/bin/bash", "--login", "-c" ] + +RUN apt -qqy update && \ + DEBIAN_FRONTEND=noninteractive apt install -qqy --no-install-recommends \ + autoconf \ + bison \ + build-essential \ + ca-certificates \ + cmake \ + curl \ + flex \ + g++ \ + gcc \ + git \ + help2man \ + kmod \ + pbzip2 \ + python3 \ + sudo \ + wget +RUN update-ca-certificates + +COPY scripts/install-conda.sh /install-conda.sh +RUN chmod +x install-conda.sh +RUN ./install-conda.sh +ENV PATH=/root/conda/bin:$PATH +RUN conda init bash + +# FIXME: Cleanup the build +# Adding results of build-setup makes the image go from ~0.5GB to over 6GB. +# On public runners, the download speeds are insufficient to transfer such large files. +# RUN . /root/conda/etc/profile.d/conda.sh \ +# && conda activate \ +# && git clone https://github.com/ucb-bar/chipyard.git \ +# && cd chipyard \ +# && git checkout 1.11.0 \ +# && ./build-setup.sh riscv-tools -s 3 -s 4 -s 5 -s 6 -s 7 -s 8 -s 9 -s 10 \ +# && cd .. + +ENTRYPOINT ["/bin/bash"] + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f9c2aeb --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Antmicro + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa9ad66 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# megaboom-cpu-benchmarking + +Copyright (c) 2024 [Antmicro](https://antmicro.com) + +# Docker image + +Current version of the docker image only installs and prepares conda without installing Chipyard. Check comment in Dockerfile for more details. + +If you want to recreate the docker image you have to trigger the ci_docker workflow manually. + +# Verilator tests + +This workflow runs the verilator tests from Chipyard: + + CONFIG: ["RocketConfig", "MegaBoomConfig"] + BINARY: ["../../tests/hello.riscv", "../../software/coremark/riscv-coremark/coremark.bare.riscv"] + +with Verilator: + + pushd sims/verilator + make run-binary CONFIG=${CONFIG} BINARY=${BINARY} + popd + diff --git a/scripts/install-chipyard.sh b/scripts/install-chipyard.sh new file mode 100644 index 0000000..205ad71 --- /dev/null +++ b/scripts/install-chipyard.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +# conda activate base + +git clone https://github.com/ucb-bar/chipyard.git +cd chipyard + git checkout 1.11.0 + ./build-setup.sh riscv-tools -s 1 -s 2 -s 3 -s 4 -s 5 -s 6 -s 7 -s 8 -s 9 +cd .. diff --git a/scripts/install-conda.sh b/scripts/install-conda.sh new file mode 100644 index 0000000..ff07a36 --- /dev/null +++ b/scripts/install-conda.sh @@ -0,0 +1,14 @@ +#!/bin/bash + +set -ex +set -o pipefail + +curl -L -O "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh" +bash Miniforge3-$(uname)-$(uname -m).sh -b -p "${HOME}/conda" + +export PATH=/root/conda/bin/:$PATH + +conda install -n base conda-libmamba-solver +conda config --set solver libmamba +conda install -n base conda-lock==1.4.0 +