Add individual recipes

.github/workflows/deploy.yml

@@ -2,6 +2,10 @@ name: Deploy Docker Images
 
 on:
   push:
+    paths:
+      - 'recipes/Dockerfile.langutils'
+      - 'recipes/Dockerfile.synthesis'
+      - 'recipes/Dockerfile.simulation'
   schedule:
     - cron: '0 21 * * 5'
 
@@ -24,6 +28,6 @@ jobs:
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
     - name: Build Docker image for ${{ matrix.name }}
-      run: docker build -f recipes/${{ matrix.name }} -t ghcr.io/pyfpga/${{ matrix.name }} .
+      run: docker build -f recipes/Dockerfile.${{ matrix.name }} -t ghcr.io/pyfpga/${{ matrix.name }} .
     - name: Push Docker image for ${{ matrix.name }}
       run: docker push ghcr.io/pyfpga/${{ matrix.name }}

.gitignore

@@ -1 +1,2 @@
 results
+slpp_all

README.md

@@ -1,19 +1,33 @@
 # PyFPGA containers
 
+A collection of Docker containers featuring a curated selection of Free/Libre and Open-Source Software (FLOSS) tools for FPGA development.
+They streamline the setup process, ensuring consistency and easy access across diverse environments.
+Below is a list of the available containers and their included tools.
+
 * `langutils`: utilities for processing and analyzing HDL languages
   * [vhd2vl](https://github.com/ldoolitt/vhd2vl)
   * [Slang](https://github.com/MikePopoloski/slang)
   * [sv2v](https://github.com/zachjs/sv2v)
+  * [svlint](https://github.com/dalance/svlint)
   * [Verible](https://github.com/chipsalliance/verible)
   * [Surelog](https://github.com/chipsalliance/Surelog)
 * `synthesis`: tools for logic synthesis
   * [GHDL](https://github.com/ghdl/ghdl)
   * [Yosys](https://github.com/YosysHQ/yosys)
   * [ghdl-yosys-plugin](https://github.com/ghdl/ghdl-yosys-plugin)
-  * [yosys-slang](https://github.com/povik/yosys-slang)
+  * [sv-elab](https://github.com/povik/sv-elab)
   * [synlig](https://github.com/chipsalliance/synlig)
 * `simulation`: tools for simulation
   * [GHDL](https://github.com/ghdl/ghdl)
   * [iVerilog](https://github.com/steveicarus/iverilog)
   * [Verilator](https://github.com/verilator/verilator)
   * [cocotb](https://github.com/cocotb/cocotb)
+
+In the CI pipeline, the Dockerfile is used to build a Docker image, which is then pushed to the GitHub Container Registry.
+From there, it can be pulled and run as a container whenever needed.
+
+```bash
+docker run --user $(id -u):$(id -g) --rm -v $PWD:$PWD -w $PWD ghcr.io/pyfpga/<image> <command>
+```
+
+Replace `<image>` with the appropriate image name and `<command>` with the command you want to execute inside the container.

build.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 set -e
 IMAGE=$1
-docker build -f recipes/$IMAGE -t ghcr.io/pyfpga/$IMAGE .
+docker build -f recipes/Dockerfile.$IMAGE --network=host -t ghcr.io/pyfpga/$IMAGE .

purge.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+docker rmi -f $(docker images -q)
+docker system prune -a --volumes -f

recipes/Dockerfile.ghdl

@@ -0,0 +1,28 @@
+# https://github.com/ghdl/ghdl
+
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    build-essential \
+    gnat \
+    zlib1g-dev
+
+RUN git clone --depth 1 https://github.com/ghdl/ghdl
+RUN mkdir ghdl/build && cd ghdl/build && ../configure --prefix=/usr/local \
+ && make -j$(nproc) && make install
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+COPY --from=builder /usr/local /usr/local
+
+RUN ldconfig

recipes/Dockerfile.iverilog

@@ -0,0 +1,30 @@
+# https://github.com/steveicarus/iverilog
+
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    autoconf \
+    bison \
+    build-essential \
+    flex \
+    gperf
+
+RUN git clone --depth 1 https://github.com/steveicarus/iverilog
+RUN cd iverilog && autoconf && ./configure \
+ && make -j$(nproc) && make install
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+COPY --from=builder /usr/local /usr/local
+
+RUN ldconfig

recipes/Dockerfile.langutils

@@ -0,0 +1,88 @@
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    bison \
+    build-essential \
+    cargo \
+    cmake \
+    curl \
+    default-jre \
+    flex \
+    python3 \
+    python3-orderedmultidict
+
+#
+# vhd2vl
+#
+
+RUN git clone --depth 1 https://github.com/ldoolitt/vhd2vl
+RUN cd vhd2vl && make -j$(nproc) && make install
+
+#
+# sv2v
+#
+
+RUN curl -sSL https://get.haskellstack.org/ | sh
+
+RUN git clone --depth 1 https://github.com/zachjs/sv2v.git
+RUN cd sv2v && make -j$(nproc) && cp bin/sv2v /usr/local/bin
+
+#
+# Slang
+#
+
+RUN git clone --depth 1 https://github.com/MikePopoloski/slang.git
+RUN cd slang && cmake -B build && cmake --build build -j$(nproc) \
+ && cmake --install build --strip
+
+#
+# Surelog
+#
+
+RUN git clone --depth 1 https://github.com/alainmarcel/Surelog.git
+RUN cd Surelog && git submodule update --init --depth 1 --recursive \
+ && cmake -B build \
+    -DCMAKE_POLICY_VERSION_MINIMUM=3.5 \
+    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_INSTALL_PREFIX=/usr/local \
+ && cmake --build build -j$(nproc) \
+ && cmake --install build --strip
+
+#
+# Verible
+#
+
+RUN curl -fsSL https://github.com/bazelbuild/bazelisk/releases/latest/download/bazelisk-linux-amd64 \
+    -o /usr/local/bin/bazel && chmod +x /usr/local/bin/bazel
+
+RUN git clone --depth 1 https://github.com/chipsalliance/verible.git
+RUN cd verible && bazel build -c opt :install-binaries \
+ && .github/bin/simple-install.sh /usr/local/bin
+
+#
+# svlint
+#
+
+RUN cargo install --root /usr/local --git https://github.com/dalance/svlint.git svlint
+
+#
+# clean-up
+#
+
+RUN rm -f /usr/local/bin/stack /usr/local/bin/bazel
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+COPY --from=builder /usr/local /usr/local
+
+RUN ldconfig

recipes/Dockerfile.simulation

@@ -0,0 +1,83 @@
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    autoconf \
+    bison \
+    build-essential \
+    flex \
+    gnat \
+    gperf \
+    help2man \
+    libfl-dev \
+    python3 \
+    python3-dev \
+    python3-pip \
+    python3-venv \
+    zlib1g-dev
+
+#
+# ghdl
+#
+
+RUN git clone --depth 1 https://github.com/ghdl/ghdl
+RUN mkdir ghdl/build && cd ghdl/build && ../configure --prefix=/usr/local \
+ && make -j$(nproc) && make install
+
+#
+# iVerilog
+#
+
+RUN git clone --depth 1 https://github.com/steveicarus/iverilog
+RUN cd iverilog && autoconf && ./configure \
+ && make -j$(nproc) && make install
+
+#
+# Verilator
+#
+
+RUN git clone --depth 1 https://github.com/verilator/verilator
+RUN cd verilator && autoconf && ./configure \
+ && make -j$(nproc) && make install
+
+#
+# cocotb
+#
+
+# RUN pip install cocotb --break-system-packages
+
+RUN python3 -m venv /opt/venv && /opt/venv/bin/pip install --no-cache-dir cocotb
+
+#
+# Optimization
+#
+
+RUN strip /usr/local/bin/* 2>/dev/null || true
+RUN find /usr/local/lib -name "*.so*" -exec strip --strip-unneeded {} + 2>/dev/null || true
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+ENV PATH="/opt/venv/bin:$PATH"
+
+RUN apt-get update -qq && apt-get install -y --no-install-recommends \
+    g++ \
+    make \
+    perl \
+    python3 \
+    libgnat-14 \
+    zlib1g \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY --from=builder /usr/local /usr/local
+COPY --from=builder /opt/venv /opt/venv
+
+RUN ldconfig

recipes/Dockerfile.slang

@@ -0,0 +1,28 @@
+# https://github.com/MikePopoloski/slang
+
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    build-essential \
+    cmake \
+    python3
+
+RUN git clone --depth 1 https://github.com/MikePopoloski/slang.git
+RUN cd slang && cmake -B build && cmake --build build -j$(nproc) \
+ && cmake --install build --strip
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+COPY --from=builder /usr/local /usr/local
+
+RUN ldconfig

recipes/Dockerfile.surelog

@@ -0,0 +1,35 @@
+# https://github.com/chipsalliance/Surelog
+
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    build-essential \
+    cmake \
+    default-jre \
+    python3 \
+    python3-orderedmultidict
+
+RUN git clone --depth 1 https://github.com/alainmarcel/Surelog.git
+RUN cd Surelog && git submodule update --init --depth 1 --recursive \
+ && cmake -B build \
+    -DCMAKE_POLICY_VERSION_MINIMUM=3.5 \
+    -DCMAKE_BUILD_TYPE=Release \
+    -DCMAKE_INSTALL_PREFIX=/usr/local \
+ && cmake --build build -j$(nproc) \
+ && cmake --install build --strip
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+COPY --from=builder /usr/local /usr/local
+
+RUN ldconfig

recipes/Dockerfile.sv2v

@@ -0,0 +1,29 @@
+# https://github.com/zachjs/sv2v
+
+FROM ubuntu:latest AS builder
+
+WORKDIR /tmp
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update -qq
+RUN apt-get install -y --no-install-recommends \
+    ca-certificates \
+    git
+RUN apt-get install -y --no-install-recommends \
+    curl
+
+RUN curl -sSL https://get.haskellstack.org/ | sh
+
+RUN git clone --depth 1 https://github.com/zachjs/sv2v.git
+RUN cd sv2v && make -j$(nproc) && cp bin/sv2v /usr/local/bin
+
+RUN rm -f /usr/local/bin/stack
+
+#------------------------------------------------------------------------------
+
+FROM ubuntu:latest AS runtime
+
+COPY --from=builder /usr/local /usr/local
+
+RUN ldconfig