verilator/ci/ci-install.bash

#!/usr/bin/env bash
# DESCRIPTION: Verilator: CI dependency install script
#
# SPDX-FileCopyrightText: 2026 Wilson Snyder
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0

################################################################################
# This script runs in the 'install' phase of all jobs, in all stages. We try to
# minimize the time spent in this by selectively installing only the components
# required by the particular build stage.
################################################################################

# Installs system packages with sudo; never run locally
if [ "$GITHUB_ACTIONS" != "true" ]; then
  echo "ERROR: $(basename "$0") must only be run in GitHub Actions CI" >&2
  exit 1
fi

set -e
set -x

cd $(dirname "$0")/..

source "$(dirname "$0")/ci-common.bash"

################################################################################
# Parse arguments

# Which stage to install dependencies for
STAGE="$1"

################################################################################
# Install dependencies

if [ "$HOST_OS" = "macOS" ]; then
  # The macos runner image ships an untrusted third-party tap we don't use;
  # untap it so brew stops emitting a tap-trust warning. Force + '|| true' since
  # untap fails if a formula was installed from it, which is harmless here.
  brew untap --force aws/tap || true
fi

# Run 'sudo apt-get', with timeout, retrying if failed
apt-get-retry() {
  local _attempt
  for _attempt in 1 2 3; do
    [ "$_attempt" -eq 1 ] || sleep $((15 * _attempt))
    sudo timeout --kill-after=30s 5m env DEBIAN_FRONTEND=noninteractive \
      apt-get -o DPkg::Lock::Timeout=60 "$@" && return 0
  done
  fatal "'apt-get $*' failed on all attempts"
}

# Run 'brew', retrying if failed
brew-retry() {
  local _attempt
  for _attempt in 1 2 3; do
    [ "$_attempt" -eq 1 ] || sleep $((15 * _attempt))
    brew "$@" && return 0
  done
  fatal "'brew $*' failed on all attempts"
}

install-wavediff() {
  source ci/docker/buildenv/wavetools.conf
  local _base_url="https://github.com/hudson-trading/wavetools/releases/download/${WAVETOOLS_VERSION}"
  local _platform
  if [ "$HOST_OS" = "linux" ]; then
    _platform="linux-x86_64"
  elif [ "$HOST_OS" = "macOS" ]; then
    _platform="macos-arm64"
  else
    echo "WARNING: No wavetools binary available for HOST_OS=$HOST_OS, skipping"
    return 0
  fi
  local _tmpdir
  _tmpdir=$(mktemp -d)
  local _archive="wavetools-${WAVETOOLS_VERSION}-${_platform}"
  wget -q -O "${_tmpdir}/${_archive}.tar.gz" "${_base_url}/${_archive}.tar.gz"
  tar -xzf "${_tmpdir}/${_archive}.tar.gz" -C "${_tmpdir}"
  sudo cp "${_tmpdir}/${_archive}/wavediff" /usr/local/bin/wavediff
  rm -rf "${_tmpdir}"
}

if [ "$STAGE" = "build" ]; then
  ##############################################################################
  # Dependencies of jobs in the 'build' stage, i.e.: packages required to
  # build Verilator

  if [ "$HOST_OS" = "linux" ]; then
    if [ "$DISTRO_ID" = "ubuntu" ]; then
      PACKAGES=(
        bear
        ccache
        help2man
        libfl-dev
        libsystemc-dev
        mold
      )
      # libunwind conflict on 22.04, can live without libjemalloc there
      if [ "$DISTRO_VERSION" != "22.04" ]; then
        PACKAGES+=(libjemalloc-dev)
      fi
      apt-get-retry update
      apt-get-retry install --yes "${PACKAGES[@]}"
    fi
  elif [ "$HOST_OS" = "macOS" ]; then
    PACKAGES=(
      autoconf
      bison
      ccache
      flex
      gperftools
      help2man
      perl
    )
    brew-retry update
    brew-retry install "${PACKAGES[@]}"
  else
    fatal "Unknown HOST_OS: '$HOST_OS'"
  fi
elif [ "$STAGE" = "test" ]; then
  ##############################################################################
  # Dependencies of jobs in the 'test' stage, i.e.: packages required to
  # run the tests

  if [ "$HOST_OS" = "linux" ]; then
    if [ "$DISTRO_ID" = "ubuntu" ]; then
      PACKAGES=(
        ccache
        gdb
        jq
        lcov
        libfl-dev
        libsystemc-dev
        mold
        python3-clang
        z3
      )
      apt-get-retry update
      apt-get-retry install --yes "${PACKAGES[@]}"
    fi
  elif [ "$HOST_OS" = "macOS" ]; then
    PACKAGES=(
      ccache
      jq
      perl
      z3
    )
    brew-retry update
    brew-retry install "${PACKAGES[@]}"
  else
    fatal "Unknown HOST_OS: '$HOST_OS'"
  fi
  # Common installs
  install-wavediff
  # Workaround -fsanitize=address crash
  sudo sysctl -w vm.mmap_rnd_bits=28
elif [ "$STAGE" = "lint-py" ]; then
  ##############################################################################
  # Dependencies for nodist/clang_check_attributes

  if [ "$HOST_OS" = "linux" ] && [ "$DISTRO_ID" = "ubuntu" ]; then
    PACKAGES=(
      python3-clang  # Not run, but importers are linted
    )
    apt-get-retry update
    apt-get-retry install --yes "${PACKAGES[@]}"
  fi
elif [ "$STAGE" = "format" ]; then
  ##############################################################################
  # Dependencies of 'make format'

  if [ "$HOST_OS" = "linux" ] && [ "$DISTRO_ID" = "ubuntu" ]; then
    PACKAGES=(
      clang-format-18  # Version pinned, so all of CI formats alike
    )
    apt-get-retry update
    apt-get-retry install --yes "${PACKAGES[@]}"
  fi
elif [ "$STAGE" = "coverage" ]; then
  ##############################################################################
  # Dependencies of the coverage report job, which only collates what the
  # 'test' stage jobs measured

  if [ "$HOST_OS" = "linux" ] && [ "$DISTRO_ID" = "ubuntu" ]; then
    PACKAGES=(
      lcov
    )
    apt-get-retry update
    apt-get-retry install --yes "${PACKAGES[@]}"
  fi
elif [ "$STAGE" = "rtlmeter-run" ]; then
  ##############################################################################
  # Dependencies of the RTLMeter jobs, which compile and run designs with an
  # already built Verilator, so they need its runtime prerequisites only

  if [ "$HOST_OS" = "linux" ] && [ "$DISTRO_ID" = "ubuntu" ]; then
    PACKAGES=(
      ccache
      libfl-dev
      libjemalloc-dev
      libsystemc-dev
      mold
    )
    apt-get-retry update
    apt-get-retry install --yes "${PACKAGES[@]}"
  fi
else
  ##############################################################################
  # Unknown build stage
  fatal "Unknown stage '$STAGE'"
fi

# Report where the tools we may have installed live (ok if some are missing)
set +x
echo "Tools:"
for bin in autoconf bear bison ccache flex gdb help2man jq lcov mold perl wavediff z3; do
  echo -n "  $bin: "
  which "$bin" || echo "Not found"
done