CI: Overhaul CI rules for MSVC and disable GraphBLAS JIT compiler with clang #1

Workflow file for this run

.github/workflows/root-cmakelists-msvc.yaml at f95d8e5

	# Build SuiteSparse using the root CMakeLists.txt using MSVC (or compatible compilers)

	name: root-cmakelists-msvc

	on:
	workflow_dispatch:
	push:
	branches-ignore:
	- '**/dev2'
	- '*/dev2'
	pull_request:

	concurrency: ci-root-cmakelists-msvc-${{ github.ref }}

	env:
	# string with name of libraries that are installed
	INSTALLED_LIBS: "SuiteSparse_config:Mongoose:AMD:BTF:CAMD:CCOLAMD:COLAMD:CHOLMOD:CXSparse:LDL:KLU:UMFPACK:ParU:RBio:SPQR:SPEX:GraphBLAS:LAGraph"

	jobs:

	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]
	cuda: [with]
	link: [both]
	cc: [cl]
	cxx: [cl]
	include:
	- openmp: with
	cuda: with
	link: both
	cc: cl
	cxx: cl
	- openmp: with
	cuda: without
	link: both
	cc: cl
	cxx: cl
	- openmp: without
	cuda: without
	link: both
	cc: cl
	cxx: cl
	- openmp: with
	cuda: with
	link: static
	cc: cl
	cxx: cl
	- openmp: with
	cuda: without
	link: both
	cc: clang-cl
	cxx: clang-cl
	- openmp: with
	cuda: without
	link: both
	cc: clang
	cxx: clang++

	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:netlib: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 conda-forge --override-channels ccache m2w64-gcc-libs
	conda install -y -c conda-forge/label/lapack_rc --override-channels liblapack=3.11

	- 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.5.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")
	# MSVC 19.40 is still Visual Studio 2022.
	# Suppress erroneous version check.
	_extra_config+=(-DCMAKE_CUDA_FLAGS=-allow-unsupported-compiler)
	fi
	if [[ ${{ matrix.cc }} == clang* ]]; then
	# Move away (old) clang/clang++ and clang-cl that would be in PATH
	# to make sure that we use the one that matches the MSVC runtime.
	mv C:/Program\ Files/LLVM C:/Program\ Files/LLVM_old
	fi
	mkdir -p ${GITHUB_WORKSPACE}/build && cd ${GITHUB_WORKSPACE}/build
	cmake -G"Ninja Multi-Config" \
	-DCMAKE_C_COMPILER=${{ matrix.cc }} \
	-DCMAKE_CXX_COMPILER=${{ matrix.cxx }} \
	-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 \
	-DSUITESPARSE_C_TO_FORTRAN="(name,NAME) name##_" \
	-DPython_EXECUTABLE="C:/msys64/ucrt64/bin/python.exe" \
	-DSUITESPARSE_DEMOS=OFF \
	-DBUILD_TESTING=OFF \
	-DSUITESPARSE_USE_OPENMP=${{ matrix.openmp == 'without' && 'OFF' \|\| 'ON' }} \
	${{ matrix.cuda == 'with'
	&& '-DSUITESPARSE_USE_CUDA=ON \
	-DCMAKE_CUDA_COMPILER_LAUNCHER="ccache"'
	\|\| '' }} \
	${{ matrix.link == 'static'
	&& '-DBUILD_SHARED_LIBS=OFF -DBUILD_STATIC_LIBS=ON'
	\|\| '' }} \
	-DGRAPHBLAS_USE_JIT=${{ (matrix.cc == 'clang' \|\| matrix.cc == 'clang-cl') && 'OFF' \|\| 'ON' }} \
	"${_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: build example
	run: \|
	cd ${GITHUB_WORKSPACE}/Example/build
	printf "::group::\033[0;32m==>\033[0m Configuring example\n"
	cmake -G"Ninja Multi-Config" \
	-DCMAKE_C_COMPILER=${{ matrix.cc }} \
	-DCMAKE_CXX_COMPILER=${{ matrix.cxx }} \
	-DCMAKE_PREFIX_PATH="${GITHUB_WORKSPACE}/lib/cmake;C:/Miniconda/envs/test/Library;${GITHUB_WORKSPACE}/dependencies" \
	-DBLA_VENDOR="All" \
	-DSUITESPARSE_USE_OPENMP=${{ matrix.openmp == 'without' && 'OFF' \|\| 'ON' }} \
	..
	echo "::endgroup::"
	printf "::group::\033[0;32m==>\033[0m Building example\n"
	cmake --build . --config Release
	echo "::endgroup::"
	printf "::group::\033[0;32m==>\033[0m Executing example\n"
	if [ -f ./my_demo -a -f ./my_cxx_demo ]; then
	printf "\033[1;35m C binary with shared libraries\033[0m\n"
	PATH="${GITHUB_WORKSPACE}/bin;${GITHUB_WORKSPACE}/dependencies/bin;${PATH}" \
	./Release/my_demo
	printf "\033[1;35m C++ binary with shared libraries\033[0m\n"
	PATH="${GITHUB_WORKSPACE}/bin;${GITHUB_WORKSPACE}/dependencies/bin;${PATH}" \
	./Release/my_cxx_demo
	fi
	# We don't build a static version of GraphBLAS in CI.
	# So we need to prepare the environment also for the following tests.
	# Additionally, gmp, mpfr and BLAS are always shared libraries.
	printf "\033[1;35m C binary with statically linked libraries\033[0m\n"
	PATH="${GITHUB_WORKSPACE}/bin;${GITHUB_WORKSPACE}/dependencies/bin;${PATH}" \
	./Release/my_demo_static
	printf "\033[1;35m C++ binary with statically linked libraries\033[0m\n"
	PATH="${GITHUB_WORKSPACE}/bin;${GITHUB_WORKSPACE}/dependencies/bin;${PATH}" \
	./Release/my_cxx_demo_static
	echo "::endgroup::"

	- 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.cxx }} \
	-DCMAKE_PREFIX_PATH="${GITHUB_WORKSPACE}/lib/cmake;C:/Miniconda/envs/test/Library;${GITHUB_WORKSPACE}/dependencies" \
	..
	cmake --build . --config Release
	echo "::endgroup::"
	done

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CI: Overhaul CI rules for MSVC and disable GraphBLAS JIT compiler with clang #1

Workflow file

CI: Overhaul CI rules for MSVC and disable GraphBLAS JIT compiler with clang #1

Jobs

Run details

Workflow file for this run