changes from Tim: cmake, config, MATLAB, version & date, SuiteSparse_… #39
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Build SuiteSparse using the root CMakeLists.txt | |
name: root-cmakelists | |
on: | |
workflow_dispatch: | |
push: | |
branches-ignore: | |
- '**/dev2' | |
- '**/*dev2' | |
pull_request: | |
concurrency: ci-root-cmakelists-${{ github.ref }} | |
env: | |
# string with name of libraries that are installed | |
INSTALLED_LIBS: "SuiteSparse_config:AMD:COLAMD:SPEX" | |
jobs: | |
ubuntu: | |
# For available GitHub-hosted runners, see: | |
# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners | |
runs-on: ubuntu-latest | |
name: ubuntu (${{ matrix.compiler }} ${{ matrix.cuda }} CUDA, ${{ matrix.link }}) | |
strategy: | |
# Allow other runners in the matrix to continue if some fail | |
fail-fast: false | |
matrix: | |
compiler: [gcc, clang] | |
cuda: [without] | |
# cuda: [with, without] | |
link: [both] | |
include: | |
- compiler: gcc | |
compiler-pkgs: "g++ gcc" | |
cc: "gcc" | |
cxx: "g++" | |
- compiler: clang | |
compiler-pkgs: "clang libomp-dev" | |
cc: "clang" | |
cxx: "clang++" | |
# Clang seems to generally require less cache size (smaller object files?). | |
- compiler: gcc | |
ccache-max: 600M | |
- compiler: clang | |
ccache-max: 500M | |
- cuda: without | |
# - cuda: with | |
# cuda-pkgs: "nvidia-cuda-dev nvidia-cuda-toolkit" | |
# cuda-cmake-flags: | |
# -DSUITESPARSE_USE_CUDA=ON | |
# -DSUITESPARSE_USE_STRICT=ON | |
# -DCUDAToolkit_INCLUDE_DIRS="/usr/include" | |
# -DCMAKE_CUDA_COMPILER_LAUNCHER="ccache" | |
- compiler: gcc | |
compiler-pkgs: "g++ gcc" | |
cc: "gcc" | |
cxx: "g++" | |
ccache-max: 600M | |
cuda: without | |
# cuda: with | |
# cuda-pkgs: "nvidia-cuda-dev nvidia-cuda-toolkit" | |
# cuda-cmake-flags: | |
# -DSUITESPARSE_USE_CUDA=ON | |
# -DSUITESPARSE_USE_STRICT=ON | |
# -DCUDAToolkit_INCLUDE_DIRS="/usr/include" | |
# -DCMAKE_CUDA_COMPILER_LAUNCHER="ccache" | |
link: static | |
link-cmake-flags: | |
-DBUILD_SHARED_LIBS=OFF | |
-DBUILD_STATIC_LIBS=ON | |
env: | |
CC: ${{ matrix.cc }} | |
CXX: ${{ matrix.cxx }} | |
steps: | |
- name: get CPU information | |
run: lscpu | |
- name: checkout repository | |
uses: actions/checkout@v4 | |
- name: install dependencies | |
env: | |
COMPILER_PKGS: ${{ matrix.compiler-pkgs }} | |
CUDA_PKGS: ${{ matrix.cuda-pkgs }} | |
run: | | |
sudo apt -qq update | |
sudo apt install -y ${COMPILER_PKGS} autoconf automake ccache cmake \ | |
dvipng gfortran libgmp-dev liblapack-dev libmpfr-dev \ | |
libopenblas-dev ${CUDA_PKGS} | |
- name: prepare ccache | |
# create key with human readable timestamp | |
# used in action/cache/restore and action/cache/save steps | |
id: ccache-prepare | |
run: | | |
echo "key=ccache:ubuntu:root:${{ matrix.compiler }}:${{ matrix.cuda }}:${{ matrix.link }}:${{ github.ref }}:$(date +"%Y-%m-%d_%H-%M-%S"):${{ github.sha }}" >> $GITHUB_OUTPUT | |
- name: restore ccache | |
# setup the GitHub cache used to maintain the ccache from one job to the next | |
uses: actions/cache/restore@v4 | |
with: | |
path: ~/.ccache | |
key: ${{ steps.ccache-prepare.outputs.key }} | |
# Prefer caches from the same branch. Fall back to caches from the dev branch. | |
restore-keys: | | |
ccache:ubuntu:root:${{ matrix.compiler }}:${{ matrix.cuda }}:${{ matrix.link }}:${{ github.ref }} | |
ccache:ubuntu:root:${{ matrix.compiler }}:${{ matrix.cuda }}:${{ matrix.link }} | |
- name: create empty libraries | |
# This is to work around a bug in nvlink. | |
# See: https://forums.developer.nvidia.com/t/nvlink-fatal-could-not-open-input-file-when-linking-with-empty-static-library/208517 | |
if: matrix.cuda == 'with' | |
run: | | |
touch empty.c | |
gcc -fPIC -c empty.c -oempty.o | |
ar rcsv libdl.a empty.o | |
ar rcsv librt.a empty.o | |
ar rcsv libpthread.a empty.o | |
# overwrite system libraries with "valid" empty libraries | |
sudo mv ./libdl.a /usr/lib/x86_64-linux-gnu/libdl.a | |
sudo mv ./librt.a /usr/lib/x86_64-linux-gnu/librt.a | |
sudo mv ./libpthread.a /usr/lib/x86_64-linux-gnu/libpthread.a | |
- name: configure ccache | |
env: | |
CCACHE_MAX: ${{ matrix.ccache-max }} | |
run: | | |
test -d ~/.ccache || mkdir ~/.ccache | |
echo "max_size = $CCACHE_MAX" >> ~/.ccache/ccache.conf | |
echo "compression = true" >> ~/.ccache/ccache.conf | |
ccache -s | |
echo "/usr/lib/ccache" >> $GITHUB_PATH | |
- name: check auto-dependency resolution | |
# no need to check this with all runners. One is enough. | |
if: ${{ matrix.cc == 'gcc' && matrix.cuda == 'without' }} | |
run: | | |
mkdir -p ${GITHUB_WORKSPACE}/build-dep && cd ${GITHUB_WORKSPACE}/build-dep | |
IFS=':' read -r -a libs <<< "${INSTALLED_LIBS}" | |
for lib in "${libs[@]}"; do | |
printf "::group:: \033[0;32m==>\033[0m Configuring to build only \033[0;32m${lib}\033[0m\n" | |
cmake --fresh \ | |
-DCMAKE_BUILD_TYPE="Release" \ | |
-DBLA_VENDOR="OpenBLAS" \ | |
-DSUITESPARSE_ENABLE_PROJECTS="${lib,,}" \ | |
.. | |
echo "::endgroup::" | |
done | |
- name: configure | |
run: | | |
mkdir -p ${GITHUB_WORKSPACE}/build && cd ${GITHUB_WORKSPACE}/build | |
cmake -DCMAKE_BUILD_TYPE="Release" \ | |
-DCMAKE_INSTALL_PREFIX=".." \ | |
-DCMAKE_C_COMPILER_LAUNCHER="ccache" \ | |
-DCMAKE_CXX_COMPILER_LAUNCHER="ccache" \ | |
-DCMAKE_Fortran_COMPILER_LAUNCHER="ccache" \ | |
-DBLA_VENDOR="OpenBLAS" \ | |
-DSUITESPARSE_DEMOS=OFF \ | |
-DBUILD_TESTING=OFF \ | |
${{ matrix.cuda-cmake-flags }} \ | |
${{ matrix.link-cmake-flags }} \ | |
.. | |
- name: build libraries | |
run: | | |
cd ${GITHUB_WORKSPACE}/build | |
cmake --build . | |
- name: build demos | |
run: | | |
printf "::group:: \033[0;32m==>\033[0m Configuring for demos\n" | |
cd ${GITHUB_WORKSPACE}/build | |
cmake -DSUITESPARSE_DEMOS=ON -DBUILD_TESTING=ON .. | |
echo "::endgroup::" | |
printf "::group:: \033[0;32m==>\033[0m Building demos\n" | |
cd ${GITHUB_WORKSPACE}/build | |
cmake --build . | |
echo "::endgroup::" | |
# FIXME: How to run the demos without Makefile? | |
- name: ccache status | |
continue-on-error: true | |
run: ccache -s | |
- name: save ccache | |
# Save the cache after we are done (successfully) building. | |
# This helps to retain the ccache even if the subsequent steps are failing. | |
uses: actions/cache/save@v4 | |
with: | |
path: ~/.ccache | |
key: ${{ steps.ccache-prepare.outputs.key }} | |
- name: check | |
run: | | |
cd ${GITHUB_WORKSPACE}/build | |
ctest . || ctest . --rerun-failed --output-on-failure | |
- name: install | |
run: | | |
printf "\033[0;32m==>\033[0m Installing libraries\n" | |
cd ${GITHUB_WORKSPACE}/build | |
cmake --install . | |
- name: test Config | |
run: | | |
IFS=':' read -r -a libs <<< "${INSTALLED_LIBS}" | |
for lib in "${libs[@]}"; do | |
printf "::group:: \033[0;32m==>\033[0m Building Config.cmake with library \033[0;32m${lib}\033[0m\n" | |
cd ${GITHUB_WORKSPACE}/TestConfig/${lib} | |
cd build | |
cmake \ | |
-DCMAKE_PREFIX_PATH="${GITHUB_WORKSPACE}/lib/cmake" \ | |
.. | |
cmake --build . --config Release | |
echo "::endgroup::" | |
done | |
msvc: | |
# For available GitHub-hosted runners, see: | |
# https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners | |
runs-on: windows-latest | |
name: msvc (${{ matrix.cc }} ${{ matrix.openmp }} OpenMP ${{ matrix.cuda }} CUDA, ${{ matrix.link }}) | |
defaults: | |
run: | |
# Use bash as default shell | |
shell: bash -el {0} | |
strategy: | |
# Allow other runners in the matrix to continue if some fail | |
fail-fast: false | |
matrix: | |
openmp: [with, without] | |
cuda: [without] | |
link: [both] | |
cc: [cl] | |
include: | |
- openmp: without | |
openmp-cmake-flags: "-DSUITESPARSE_USE_OPENMP=OFF" | |
# - openmp: with | |
cuda: without | |
# cuda: with | |
# cuda-cmake-flags: | |
# -DSUITESPARSE_USE_CUDA=ON | |
# -DCMAKE_CUDA_COMPILER_LAUNCHER="ccache" | |
# link: both | |
# cc: cl | |
- openmp: with | |
cuda: without | |
# cuda: with | |
# cuda-cmake-flags: | |
# -DSUITESPARSE_USE_CUDA=ON | |
# -DCMAKE_CUDA_COMPILER_LAUNCHER="ccache" | |
link: static | |
link-cmake-flags: | |
-DBUILD_SHARED_LIBS=OFF | |
-DBUILD_STATIC_LIBS=ON | |
cc: cl | |
- openmp: with | |
cuda: without | |
link: both | |
cc: clang-cl | |
env: | |
CHERE_INVOKING: 1 | |
steps: | |
- name: get CPU name | |
shell: pwsh | |
run : | | |
Get-CIMInstance -Class Win32_Processor | Select-Object -Property Name | |
- name: checkout repository | |
uses: actions/checkout@v4 | |
- uses: conda-incubator/setup-miniconda@v3 | |
with: | |
auto-update-conda: true | |
- name: cache conda packages | |
id: conda-cache | |
uses: actions/cache/restore@v4 | |
with: | |
path: C:/Miniconda/envs/test | |
key: conda:msvc | |
- name: install packages with conda | |
if: ${{ steps.conda-cache.outputs.cache-hit != 'true' }} | |
run: | | |
echo ${{ steps.conda-cache.outputs.cache-hit }} | |
conda info | |
conda list | |
conda install -y -c intel mkl-devel | |
conda install -y -c conda-forge --override-channels ccache | |
- name: save conda cache | |
if: ${{ steps.conda-cache.outputs.cache-hit != 'true' }} | |
uses: actions/cache/save@v4 | |
with: | |
path: C:/Miniconda/envs/test | |
key: ${{ steps.conda-cache.outputs.cache-primary-key }} | |
- name: install libraries from MSYS2 | |
uses: msys2/setup-msys2@v2 | |
with: | |
update: true | |
# Use pre-installed version to save disc space on partition with source. | |
release: false | |
install: >- | |
mingw-w64-ucrt-x86_64-gmp | |
mingw-w64-ucrt-x86_64-mpfr | |
mingw-w64-ucrt-x86_64-python | |
msystem: UCRT64 | |
- uses: Jimver/[email protected] | |
name: install CUDA toolkit | |
if: matrix.cuda == 'with' | |
id: cuda-toolkit | |
with: | |
cuda: '12.2.0' | |
#See https://docs.nvidia.com/cuda/cuda-installation-guide-microsoft-windows/index.html#install-the-cuda-software | |
method: 'local' | |
# Do not cache the installer (~3 GiB). It doesn't speed up the | |
# installation significantly. And we need the space for ccache. | |
use-github-cache: 'false' | |
- name: setup build environment | |
# get packages from MSYS2 | |
# Copy only relevant parts to avoid picking up headers and libraries | |
# that are thought for MinGW only. | |
run: | | |
mkdir -p ./dependencies/{bin,lib,include} | |
# GMP | |
cp C:/msys64/ucrt64/bin/libgmp*.dll ./dependencies/bin/ | |
cp C:/msys64/ucrt64/include/gmp.h ./dependencies/include/ | |
cp C:/msys64/ucrt64/lib/libgmp.dll.a ./dependencies/lib/gmp.lib | |
# MPFR | |
cp C:/msys64/ucrt64/bin/libmpfr*.dll ./dependencies/bin/ | |
cp C:/msys64/ucrt64/include/mpf2mpfr.h ./dependencies/include/ | |
cp C:/msys64/ucrt64/include/mpfr.h ./dependencies/include/ | |
cp C:/msys64/ucrt64/lib/libmpfr.dll.a ./dependencies/lib/mpfr.lib | |
# run-time dependencies | |
cp C:/msys64/ucrt64/bin/libgcc_s_seh*.dll ./dependencies/bin/ | |
cp C:/msys64/ucrt64/bin/libwinpthread*.dll ./dependencies/bin/ | |
# create environment variable for easier access | |
echo "CCACHE=C:/Miniconda/envs/test/Library/bin/ccache.exe" >> ${GITHUB_ENV} | |
- name: prepare ccache | |
# create key with human readable timestamp | |
# used in action/cache/restore and action/cache/save steps | |
id: ccache-prepare | |
shell: msys2 {0} | |
run: | | |
echo "ccachedir=$(cygpath -m $(${CCACHE} -k cache_dir))" >> $GITHUB_OUTPUT | |
echo "key=ccache:msvc:root:${{ matrix.cc }}:${{ matrix.openmp }}:${{ matrix.cuda }}:${{ matrix.link }}:${{ github.ref }}:$(date +"%Y-%m-%d_%H-%M-%S"):${{ github.sha }}" >> $GITHUB_OUTPUT | |
- name: restore ccache | |
# Setup the GitHub cache used to maintain the ccache from one job to the next | |
uses: actions/cache/restore@v4 | |
with: | |
path: ${{ steps.ccache-prepare.outputs.ccachedir }} | |
key: ${{ steps.ccache-prepare.outputs.key }} | |
# Prefer caches from the same branch. Fall back to caches from the dev branch. | |
restore-keys: | | |
ccache:msvc:root:${{ matrix.cc }}:${{ matrix.openmp }}:${{ matrix.cuda }}:${{ matrix.link }}:${{ github.ref }} | |
ccache:msvc:root:${{ matrix.cc }}:${{ matrix.openmp }}:${{ matrix.cuda }}:${{ matrix.link }}: | |
- name: configure ccache | |
# Limit the maximum size and switch on compression to avoid exceeding the total disk or cache quota. | |
run: | | |
test -d ${{ steps.ccache-prepare.outputs.ccachedir }} || mkdir -p ${{ steps.ccache-prepare.outputs.ccachedir }} | |
echo "max_size = 250M" > ${{ steps.ccache-prepare.outputs.ccachedir }}/ccache.conf | |
echo "compression = true" >> ${{ steps.ccache-prepare.outputs.ccachedir }}/ccache.conf | |
${CCACHE} -p | |
${CCACHE} -s | |
- name: setup MSVC toolchain | |
uses: ilammy/msvc-dev-cmd@v1 | |
- name: configure | |
run: | | |
declare -a _extra_config | |
if [ ${{ matrix.cuda }} = 'with' ]; then | |
_extra_config+=(-DCUDAToolkit_ROOT="$(cygpath -m "${{ steps.cuda-toolkit.outputs.CUDA_PATH }}")") | |
_extra_config+=(-DCMAKE_CUDA_COMPILER="$(cygpath -m "${{ steps.cuda-toolkit.outputs.CUDA_PATH }}")/bin/nvcc.exe") | |
fi | |
mkdir -p ${GITHUB_WORKSPACE}/build && cd ${GITHUB_WORKSPACE}/build | |
cmake -G"Ninja Multi-Config" \ | |
-DCMAKE_C_COMPILER=${{ matrix.cc }} \ | |
-DCMAKE_CXX_COMPILER=${{ matrix.cc }} \ | |
-DCMAKE_BUILD_TYPE="Release" \ | |
-DCMAKE_INSTALL_PREFIX=".." \ | |
-DCMAKE_PREFIX_PATH="C:/Miniconda/envs/test/Library;${GITHUB_WORKSPACE}/dependencies" \ | |
-DCMAKE_C_COMPILER_LAUNCHER="ccache" \ | |
-DCMAKE_CXX_COMPILER_LAUNCHER="ccache" \ | |
-DCMAKE_Fortran_COMPILER_LAUNCHER="ccache" \ | |
-DSUITESPARSE_USE_FORTRAN=OFF \ | |
-DBLA_VENDOR="All" \ | |
-DPython_EXECUTABLE="C:/msys64/ucrt64/bin/python.exe" \ | |
-DSUITESPARSE_DEMOS=OFF \ | |
-DBUILD_TESTING=OFF \ | |
${{ matrix.openmp-cmake-flags }} \ | |
${{ matrix.cuda-cmake-flags }} \ | |
${{ matrix.link-cmake-flags }} \ | |
"${_extra_config[@]}" \ | |
.. | |
- name: build libraries | |
run: | | |
cd ${GITHUB_WORKSPACE}/build | |
cmake --build . --config Release | |
- name: build demos | |
run: | | |
printf "::group:: \033[0;32m==>\033[0m Configuring for demos\n" | |
cd ${GITHUB_WORKSPACE}/build | |
cmake -DSUITESPARSE_DEMOS=ON -DBUILD_TESTING=ON .. | |
echo "::endgroup::" | |
printf "::group:: \033[0;32m==>\033[0m Building demos\n" | |
cd ${GITHUB_WORKSPACE}/build | |
cmake --build . --config Release | |
echo "::endgroup::" | |
# FIXME: How to run the demos without Makefile? | |
- name: ccache status | |
continue-on-error: true | |
run: ${CCACHE} -s | |
- name: save ccache | |
# Save the cache after we are done (successfully) building | |
# This helps to retain the ccache even if the subsequent steps are failing. | |
uses: actions/cache/save@v4 | |
with: | |
path: ${{ steps.ccache-prepare.outputs.ccachedir }} | |
key: ${{ steps.ccache-prepare.outputs.key }} | |
- name: check | |
run: | | |
cd ${GITHUB_WORKSPACE}/build | |
PATH="${GITHUB_WORKSPACE}/bin;${GITHUB_WORKSPACE}/dependencies/bin;C:/msys64/ucrt64/bin;${PATH}" \ | |
ctest -C Release . || ctest -C Release . --rerun-failed --output-on-failure | |
- name: install | |
run: | | |
printf "\033[0;32m==>\033[0m Installing libraries\n" | |
cd ${GITHUB_WORKSPACE}/build | |
cmake --install . | |
- name: test Config | |
run: | | |
IFS=':' read -r -a libs <<< "${INSTALLED_LIBS}" | |
for lib in "${libs[@]}"; do | |
printf "::group:: \033[0;32m==>\033[0m Building with Config.cmake with library \033[0;32m${lib}\033[0m\n" | |
cd ${GITHUB_WORKSPACE}/TestConfig/${lib} | |
cd build | |
cmake -G"Ninja Multi-Config" \ | |
-DCMAKE_C_COMPILER=${{ matrix.cc }} \ | |
-DCMAKE_CXX_COMPILER=${{ matrix.cc }} \ | |
-DCMAKE_PREFIX_PATH="${GITHUB_WORKSPACE}/lib/cmake;C:/Miniconda/envs/test/Library;${GITHUB_WORKSPACE}/dependencies" \ | |
.. | |
cmake --build . --config Release | |
echo "::endgroup::" | |
done |