floogen: Add NoC generation framework

.github/workflows/floogen.yml

@@ -0,0 +1,84 @@
+# Copyright 2024 ETH Zurich and University of Bologna.
+# Solderpad Hardware License, Version 0.51, see LICENSE for details.
+# SPDX-License-Identifier: SHL-0.51
+
+# Author: Tim Fischer <[email protected]>
+
+name: floogen
+
+on: [push, pull_request]
+
+jobs:
+
+  unit-test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .
+    - name: Run unit tests
+      run: |
+        python -m pytest -v
+
+  #####################
+  # Generate SV files #
+  #####################
+  gen-nocs:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        examples: ["single_cluster", "occamy_mesh", "occamy_tree"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+    - name: Install floogen
+      run: |
+        python -m pip install .
+    - name: Generate NoCs
+      run: |
+        floogen -c floogen/examples/${{ matrix.examples }}.yml -o generated --no-format
+    - name: Format generated NoCs
+      uses: chipsalliance/verible-formatter-action@main
+      with:
+        files:
+          ./generated/${{ matrix.examples }}_floo_noc.sv
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ matrix.examples }}
+        path: generated/${{ matrix.examples }}_floo_noc.sv
+        if-no-files-found: error
+        retention-days: 1
+
+  #################
+  # Lint SV files #
+  #################
+  lint-nocs:
+    runs-on: ubuntu-latest
+    needs: gen-nocs
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          path: generated
+      - name: Lint SV files
+        uses: chipsalliance/verible-linter-action@main
+        with:
+          config_file: ''
+          paths:
+            ./generated
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yml

@@ -16,21 +16,28 @@ jobs:
   check-clean:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.10'
           cache: 'pip'
-      - run: pip install -r requirements.txt
+      - name: Install dependencies and package
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
       - name: Install bender
         uses: pulp-platform/pulp-actions/bender-install@v2
-      - name: Install verible
+      - name: Make clean sources
         run: |
-          curl -Ls -o verible.tar.gz https://github.com/chipsalliance/verible/releases/download/v0.0-3313-gddcea377/verible-v0.0-3313-gddcea377-Ubuntu-22.04-jammy-x86_64.tar.gz
-          mkdir verible && tar -xzf verible.tar.gz -C verible --strip-components 1
-      - name: Check clean make targets
+          make clean sources FLOOGEN_ARGS="--no-format"
+      - name: Format with verible
+        uses: chipsalliance/verible-formatter-action@main
+        with:
+          files:
+            ./hw/**/*.sv
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Check clean
         run: |
-          make clean sources VERIBLE_FMT=verible/bin/verible-verilog-format
           git status && test -z "$(git status --porcelain)"
 
   ###############
@@ -39,22 +46,29 @@ jobs:
   check-stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: '3.9'
+          python-version: '3.10'
           cache: 'pip'
-      - run: pip install -r requirements.txt
+      - name: Install dependencies and package
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
       - name: Install bender
         uses: pulp-platform/pulp-actions/bender-install@v2
-      - name: Install verible
+      - name: Make clean sources
         run: |
-          curl -Ls -o verible.tar.gz https://github.com/chipsalliance/verible/releases/download/v0.0-3313-gddcea377/verible-v0.0-3313-gddcea377-Ubuntu-22.04-jammy-x86_64.tar.gz
-          mkdir verible && tar -xzf verible.tar.gz -C verible --strip-components 1
-      - name: Check clean makefile
+          make -B sources FLOOGEN_ARGS="--no-format"
+      - name: Format with verible
+        uses: chipsalliance/verible-formatter-action@main
+        with:
+          files:
+            ./hw/**/*.sv
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Check clean
         run: |
-          make -B sources VERIBLE_FMT=verible/bin/verible-verilog-format
-          git status && test -z "$(git status --porcelain)"
+            git status && test -z "$(git status --porcelain)"
 
   #####################
   # Bender up-to-date #
@@ -68,19 +82,40 @@ jobs:
   ################
   # Verible Lint #
   ################
-  lint:
+  verible-lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: chipsalliance/verible-linter-action@main
       with:
+        config_file: ''
         paths: |
-          ./src
+          ./hw
         extra_args: "--waiver_files util/verible.waiver"
         github_token: ${{ secrets.GITHUB_TOKEN }}
         fail_on_error: true
         reviewdog_reporter: github-check
 
+  ##########
+  # PyLint #
+  ##########
+  pylint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+        cache: 'pip'
+    - name: Install dependencies and package
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')
+
   #################
   # Check License #
   #################

.gitignore

@@ -1,20 +1,85 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__/*
+.cache/*
+.*.swp
+*/.ipynb_checkpoints/*
+.DS_Store
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+.dvt
+tags
+
+# Package files
+*.egg
+*.eggs/
+.installed.cfg
+*.egg-info
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.coverage.*
+.tox
+junit*.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+docs/api/*
+docs/_rst/*
+docs/_build/*
+cover/*
+MANIFEST
+
+# Per-project virtualenvs
+.venv*/
+.conda*/
+.python-version
+
+# bender
 .bender
-*modelsim.ini
-*transcript
-*work
+Bender.lock
+Bender.local
+deps
+
+# Auto generated sources
+generated
+*.png
+hw/test/jobs
+
+# QuestaSim
+work
+work-vsim
+modelsim.ini
+transcript
 vsim.wlf
 scripts/compile_vsim.tcl
-working_dir/*
-compile.log
-Bender.lock
-.dvt
-dvt_build.log
-.vscode
+
+# Verible
 verible*
 
 # spyglass
 scripts/spyglass/*
 
-test/jobs
+# Misc
 *.csv
 **/*.log
+reviewdog

.gitlab-ci.yml

@@ -7,27 +7,40 @@
 variables:
   VSIM: questa-2023.4 vsim
   BENDER: bender
+  PYTHON: /home/fischeti/micromamba/envs/floo/bin/python
 
 stages:
-  - sources
+  - init
   - build
   - run
 
 collect-bender-sources:
-  stage: sources
+  stage: init
   script:
     - $BENDER checkout
   artifacts:
     paths:
       - .bender/
       - Bender.lock
 
+python-virtualenv:
+  stage: init
+  script:
+    - $PYTHON -m venv .venv
+    - source .venv/bin/activate
+    - pip install .
+  artifacts:
+    paths:
+      - .venv/
+
 compile-vsim:
   stage: build
   script:
+    - source .venv/bin/activate
     - make compile-sim | tee compile.log 2>&1
     - '! grep "Error: " compile.log'
   needs:
+    - python-virtualenv
     - collect-bender-sources
   artifacts:
     paths: