Merge branch 'main' of github.com:efabless/caravel-sim-infrastructure

Author: M0stafaRady

.github/workflows/caravel_cocotb.yml

@@ -11,40 +11,39 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v2
-
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.8
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v1
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
-
-    - name: Install dependencies
-      run: |
-        cd $GITHUB_WORKSPACE/cocotb
-        python3 -m pip install --upgrade pip
-        pip install -r requirements.txt
-        python3 -m pip install --upgrade --no-cache-dir volare
-        pip install flake8
-
-    - name: Run Flake8
-      run: flake8 $GITHUB_WORKSPACE/cocotb --config $GITHUB_WORKSPACE/cocotb/.flake8
-
-    - name: download docker
-      run: |
-        docker pull efabless/dv:cocotb
-
-    - name: Install caravel_cocotb
-      run: |
-        cd $GITHUB_WORKSPACE/cocotb
-        pip install .
-
-    - name: Run main.py
-      run: |
-        cd $GITHUB_WORKSPACE/cocotb/caravel_cocotb/CI
-        python3 main.py
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Install dependencies
+        run: |
+          cd $GITHUB_WORKSPACE/cocotb
+          make venv
+
+      - name: Run Flake8
+        run: |
+          cd $GITHUB_WORKSPACE/cocotb
+          make lint
+
+      - name: download docker
+        run: |
+          docker pull efabless/dv:cocotb
+
+      - name: Install caravel_cocotb
+        run: |
+          cd $GITHUB_WORKSPACE/cocotb
+          pip install .
+
+      - name: Run main.py
+        run: |
+          cd $GITHUB_WORKSPACE/cocotb/caravel_cocotb/CI
+          python3 main.py

.github/workflows/publish_pypi.yaml

@@ -6,41 +6,34 @@ on:
     branches:
       - main
     paths:
-      - cocotb/caravel_cocotb/__version__.py  # Trigger the workflow only if the VERSION file changes
+      - cocotb/pyproject.toml # Trigger the workflow only if the VERSION file changes
 
 jobs:
   publish:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: 3.8
-
-    - name: Install dependencies
-      run: |
-        pip install --upgrade setuptools wheel twine
-
-    - name: Read version number
-      id: read_version
-      run: |
-        VERSION_FILE=cocotb/caravel_cocotb/__version__.py
-        NEW_VERSION=$(cat $VERSION_FILE)
-        echo "New version: $NEW_VERSION"
-        echo "version=$NEW_VERSION" >> $GITHUB_ENV
-
-    - name: Build package
-      run: |
-        cd cocotb
-        python setup.py sdist bdist_wheel
-
-    - name: Publish
-      if: ${{ env.NEW_TAG != 'NO_NEW_TAG' }}
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        password: ${{ secrets.PYPI_API_TOKEN }}
-        packages-dir: cocotb/dist
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+
+      - name: Read version number
+        id: read_version
+        run: |
+          echo "version=$(python3 cocotb/caravel_cocotb/__version__.py)" >> $GITHUB_ENV
+
+      - name: Build package
+        run: |
+          cd cocotb
+          make dist
+
+      - name: Publish
+        if: ${{ env.NEW_TAG != 'NO_NEW_TAG' }}
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: cocotb/dist

cocotb/.flake8

@@ -1,2 +1,5 @@
 [flake8]
-ignore = E203,E266,E302,E501,W503,E731
+ignore = E203,E266,E302,E501,W503,E731
+exclude =
+    .git/,
+    venv/

cocotb/.gitignore

@@ -17,4 +17,5 @@ __pycache__
 /build
 /venv
 /dist
-/*.egg-info
+/*.egg-info
+/requirements_tmp.txt

cocotb/Makefile

@@ -1,23 +1,43 @@
 PACKAGE_NAME = caravel_cocotb
 
-.PHONY: clean test lint dist upload release
+PYTHON3 ?= python3
 
-clean:
-	rm -rf dist build *.egg-info
-	rm -rf caravel mgmt_core pdk_root user_project_root
-
-test:
-	pip install .
-	python3 caravel_cocotb/CI/main.py
-
-lint:
-	flake8
-
-dist: clean
-	python3 setup.py sdist bdist_wheel
+all: dist
 
+.PHONY: upload
 upload: dist
-	twine upload dist/*
+	./venv/bin/python3 -m pip install twine
+	./venv/bin/twine upload dist/*
 
-release: lint test dist upload
+.PHONY: dist
+dist: venv/manifest.txt
+	./venv/bin/poetry build
 
+.PHONY: lint
+lint: venv/manifest.txt
+	./venv/bin/flake8 .
+	
+test: venv/manifest.txt
+	./venv/bin/python3 -m pip install .
+	./venv/bin/python3 caravel_cocotb/CI/main.py
+
+venv: venv/manifest.txt
+venv/manifest.txt: ./pyproject.toml ./poetry.lock
+	rm -rf venv
+	python3 -m venv ./venv
+	PYTHONPATH= ./venv/bin/python3 -m pip install --upgrade pip
+	PYTHONPATH= ./venv/bin/python3 -m pip install --upgrade wheel poetry poetry-plugin-export
+	PYTHONPATH= ./venv/bin/poetry export --with dev --without-hashes --format=requirements.txt --output=requirements_tmp.txt
+	PYTHONPATH= ./venv/bin/python3 -m pip install --upgrade -r requirements_tmp.txt
+	PYTHONPATH= ./venv/bin/python3 -m pip freeze > $@
+	@echo ">> Venv prepared."
+
+.PHONY: clean
+clean:
+	rm -rf _nl2bench_antlr4*/
+	rm -rf build/
+	rm -rf dist/
+	rm -rf htmlcov/
+	rm -rf *.egg-info/
+	rm -rf .antlr/
+	rm -f .coverage

cocotb/caravel_cocotb/__version__.py

@@ -1 +1,41 @@
-__version__ = "1.3.2"
+# Copyright 2024 Efabless Corporation
+#
+# 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.
+import os
+import sys
+import importlib.metadata
+
+
+def __get_version():
+    try:
+        return importlib.metadata.version("caravel_cocotb")
+    except importlib.metadata.PackageNotFoundError:
+        import re
+
+        rx = re.compile(r"version\s*=\s*\"([^\"]+)\"")
+        script_directory = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+        pyproject_path = os.path.join(script_directory, "pyproject.toml")
+        try:
+            match = rx.search(open(pyproject_path, encoding="utf8").read())
+            assert match is not None, "pyproject.toml found, but without a version"
+            return match[1]
+        except FileNotFoundError:
+            print("Warning: Failed to extract caravel cocotb version.", file=sys.stderr)
+            return "UNKNOWN"
+
+
+__version__ = __get_version()
+
+
+if __name__ == "__main__":
+    print(__version__, end="")

cocotb/caravel_cocotb/scripts/verify_cocotb/RunFlow.py

@@ -146,21 +146,21 @@ def set_paths(self, design_info):
                 design_info["USER_PROJECT_ROOT"],
                 SIM_PATH,
             )
-        elif "CHEETAH_ROOT" in design_info:
+        elif "FRIGATE_ROOT" in design_info:
             Paths = namedtuple(
                 "Paths",
-                "CHEETAH_ROOT MCW_ROOT PDK_ROOT PDK RUN_PATH VERILOG_PATH FIRMWARE_PATH USER_PROJECT_ROOT SIM_PATH",
+                "FRIGATE_ROOT MCW_ROOT PDK_ROOT PDK RUN_PATH VERILOG_PATH FIRMWARE_PATH USER_PROJECT_ROOT SIM_PATH",
             )
-            if not os.path.exists(design_info["CHEETAH_ROOT"]):
+            if not os.path.exists(design_info["FRIGATE_ROOT"]):
                 raise NotADirectoryError(
-                    f"CHEETAH_ROOT is not a correct directory CHEETAH_ROOT:{design_info['CHEETAH_ROOT']}"
+                    f"FRIGATE_ROOT is not a correct directory FRIGATE_ROOT:{design_info['FRIGATE_ROOT']}"
                 )
             if not os.path.exists(design_info["MCW_ROOT"]):
                 raise NotADirectoryError(
                     f"MCW_ROOT is not a correct directory MCW_ROOT:{design_info['MCW_ROOT']}"
                 )
             self.paths = Paths(
-                design_info["CHEETAH_ROOT"],
+                design_info["FRIGATE_ROOT"],
                 design_info["MCW_ROOT"],
                 design_info["PDK_ROOT"],
                 design_info["PDK"],
@@ -242,10 +242,10 @@ def set_config_script(self, design_info):
                     PDK_ROOT=f'{self.paths.PDK_ROOT}/{design_info["PDK"]}',
                 )
             )
-        elif "CHEETAH_ROOT" in self.paths._fields:
+        elif "FRIGATE_ROOT" in self.paths._fields:
             design_configs.update(
                 dict(
-                    CHEETAH_ROOT=self.paths.CHEETAH_ROOT,
+                    FRIGATE_ROOT=self.paths.FRIGATE_ROOT,
                     MCW_ROOT=self.paths.MCW_ROOT,
                     PDK_ROOT=f'{self.paths.PDK_ROOT}/{design_info["PDK"]}',
                 )

cocotb/caravel_cocotb/scripts/verify_cocotb/RunRegression.py

@@ -52,8 +52,8 @@ def set_common_macros(self):
         ]
         if "CARAVEL_ROOT" in self.paths._fields:
             paths_macros += [f'CARAVEL_ROOT=\\"{self.paths.CARAVEL_ROOT}\\"']
-        elif "CHEETAH_ROOT" in self.paths._fields:
-            paths_macros += [f'CHEETAH_ROOT=\\"{self.paths.CHEETAH_ROOT}\\"']
+        elif "FRIGATE_ROOT" in self.paths._fields:
+            paths_macros += [f'FRIGATE_ROOT=\\"{self.paths.FRIGATE_ROOT}\\"']
 
         paths_macros.append(f'SIM_PATH=\\"{self.paths.SIM_PATH}/\\"')
         if self.args.pdk != "gf180":
@@ -329,8 +329,8 @@ def write_command_log(self):
     def write_git_log(self):
         file_name = f"{self.paths.SIM_PATH}/{self.args.tag}/repos_info.log"
         f = open(file_name, "w")
-        f.write(f"{'#'*4} {'Caravel' if 'CARAVEL_ROOT' in self.paths._fields else 'Cheetah' if 'CHEETAH_ROOT' in self.paths._fields else None} repo info {'#'*4}\n")
-        ROOT_REPO = self.paths.CARAVEL_ROOT if "CARAVEL_ROOT" in self.paths._fields else self.paths.CHEETAH_ROOT if "CHEETAH_ROOT" in self.paths._fields else None
+        f.write(f"{'#'*4} {'Caravel' if 'CARAVEL_ROOT' in self.paths._fields else 'frigate' if 'FRIGATE_ROOT' in self.paths._fields else None} repo info {'#'*4}\n")
+        ROOT_REPO = self.paths.CARAVEL_ROOT if "CARAVEL_ROOT" in self.paths._fields else self.paths.FRIGATE_ROOT if "FRIGATE_ROOT" in self.paths._fields else None
         url = "https://github.com/" + f"{run(f'cd {ROOT_REPO};git ls-remote --get-url', stdout=PIPE, stderr=PIPE, universal_newlines=True, shell=True).stdout}".replace(
             "[email protected]:", ""
         ).replace(

cocotb/caravel_cocotb/scripts/verify_cocotb/RunTest.py

@@ -45,6 +45,16 @@ def hex_riscv_command_gen(self):
         LINKER_SCRIPT = f"-Wl,-Bstatic,-T,{self.test.linker_script_file},--strip-debug "
         CPUFLAGS = "-O2 -g -march=rv32i_zicsr -mabi=ilp32 -D__vexriscv__ -ffreestanding -nostdlib"
         # CPUFLAGS = "-O2 -g -march=rv32imc_zicsr -mabi=ilp32 -D__vexriscv__ -ffreestanding -nostdlib"
+        includes = [
+            f"-I{ip}" for ip in self.get_ips_fw()
+        ] + [
+            f"-I{self.paths.FIRMWARE_PATH}",
+            f"-I{self.paths.FIRMWARE_PATH}/APIs",
+            f"-I{self.paths.USER_PROJECT_ROOT}/verilog/dv/cocotb",
+            f"-I{self.paths.VERILOG_PATH}/dv/generated",
+            f"-I{self.paths.VERILOG_PATH}/dv/",
+            f"-I{self.paths.VERILOG_PATH}/common/",
+        ]
         includes = f" -I{self.paths.FIRMWARE_PATH} -I{self.paths.FIRMWARE_PATH}/APIs -I{self.paths.VERILOG_PATH}/dv/generated  -I{self.paths.VERILOG_PATH}/dv/ -I{self.paths.VERILOG_PATH}/common"
         includes += f" -I{self.paths.USER_PROJECT_ROOT}/verilog/dv/cocotb {' '.join([f'-I{ip}' for ip in self.get_ips_fw()])}"
         elf_command = (
@@ -185,11 +195,13 @@ def write_iverilog_includes_file(self):
             self.iverilog_dirs += f" -I {include_dir}"
 
     def iverilog_compile(self):
+        if os.path.isfile(f"{self.test.compilation_dir}/sim.vvp"):
+            os.remove(f"{self.test.compilation_dir}/sim.vvp")
         macros = " -D" + " -D".join(self.test.macros)
         compile_command = (
             f"cd {self.test.compilation_dir} &&"
-            f"iverilog -g2012 -Ttyp {macros} {self.iverilog_dirs} -o {self.test.compilation_dir}/sim.vvp"
-            f" {self.paths.CARAVEL_VERILOG_PATH}/rtl/toplevel_cocotb.v -s caravel_top"
+            f"iverilog -g2012 -Ttyp {macros} {self.iverilog_dirs} -o {self.test.compilation_dir}/sim.vvp -s caravel_top"
+            f" {self.paths.CARAVEL_VERILOG_PATH}/rtl/toplevel_cocotb.v"
         )
         docker_compilation_command = self._iverilog_docker_command_str(compile_command)
         self.run_command_write_to_file(
@@ -238,8 +250,6 @@ def _iverilog_docker_command_str(self, command=""):
 
     def find_symbolic_links(self, directory):
         sym_links = []
-        if not os.path.exists(directory):
-            return sym_links
         for root, dirs, files in os.walk(directory):
             for dir_name in dirs:
                 dir_path = os.path.join(root, dir_name)
@@ -283,6 +293,8 @@ def write_vcs_includes_file(self):
         self.test.set_user_project()
 
     def vcs_compile(self):
+        if os.path.isfile(f"{self.test.compilation_dir}/simv"):
+            os.remove(f"{self.test.compilation_dir}/simv")
         macros = " +define+" + " +define+".join(self.test.macros)
         vlogan_cmd = f"cd {self.test.compilation_dir}; vlogan -full64 -sverilog +error+30 {self.paths.CARAVEL_VERILOG_PATH}/rtl/toplevel_cocotb.v {self.vcs_dirs}  {macros}   -l {self.test.compilation_dir}/analysis.log -o {self.test.compilation_dir} "
         self.run_command_write_to_file(