---
# DESCRIPTION: Github actions config
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0

name: reusable-rtlmeter-build

on:
  workflow_call:
    inputs:
      runs-on:
        description: "Runner to use, e.g.: ubuntu-24.04"
        type: string
        required: true
      cc:
        description: "Compiler to use: 'gcc' or 'clang'"
        type: string
        required: true
      sha:
        description: "Git SHA to build"
        type: string
        required: true
    outputs:
      archive:
        description: "Name of the built installation archive artifact"
        value: ${{ jobs.build.outputs.archive }}

defaults:
  run:
    shell: bash

env:
  CCACHE_DIR: ${{ github.workspace }}/ccache
  CCACHE_MAXSIZE: 512M

jobs:
  build:
    name: Build
    runs-on: ${{ inputs.runs-on }}
    outputs:
      archive: ${{ steps.create-archive.outputs.archive }}
    steps:
      - name: Install dependencies
        run: |
          echo "path-exclude /usr/share/doc/*"  | sudo tee -a /etc/dpkg/dpkg.cfg.d/01_nodoc
          echo "path-exclude /usr/share/man/*"  | sudo tee -a /etc/dpkg/dpkg.cfg.d/01_nodoc
          echo "path-exclude /usr/share/info/*" | sudo tee -a /etc/dpkg/dpkg.cfg.d/01_nodoc
          sudo apt update || \
          sudo apt update
          sudo apt install ccache mold help2man libfl-dev libjemalloc-dev libsystemc-dev || \
          sudo apt install ccache mold help2man libfl-dev libjemalloc-dev libsystemc-dev

      - name: Use saved ccache
        uses: actions/cache@v5
        with:
          path: ccache
          key: rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.sha }}-${{ github.run_id }}-${{ github.run_attempt }}
          restore-keys: |
            rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.sha }}-${{ github.run_id }}
            rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.sha }}
            rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}

      - name: Checkout
        uses: actions/checkout@v6
        with:
          path: repo
          ref: ${{ inputs.sha }}
          fetch-depth: 0 # Required for 'git describe' used for 'verilator --version'

      - name: Configure
        working-directory: repo
        run: |
          autoconf
          ./configure --prefix=${{ github.workspace }}/install CXX=${{ inputs.cc == 'clang' && 'clang++' || 'g++' }}

      - name: Make
        working-directory: repo
        run: make -j $(nproc)

      - name: Install
        working-directory: repo
        run: make install

      - name: Tar up installation
        id: create-archive
        run: |
          SHA=$(git -C repo rev-parse HEAD)
          ARCHIVE=verilator-$SHA-rtlmeter-${{ inputs.runs-on }}-${{ inputs.cc }}.tar.gz
          tar --posix -c -z -f $ARCHIVE install
          echo "archive=$ARCHIVE" >> $GITHUB_OUTPUT

      - name: Upload Verilator installation archive
        uses: actions/upload-artifact@v7
        with:
          path: ${{ steps.create-archive.outputs.archive }}
          name: ${{ steps.create-archive.outputs.archive }}
          overwrite: true