fobos

[project]
name       = FUNDAL
version    = VERSION
summary    = Fortran UNified Device Acceleration Library
repository = https://github.com/szaghi/FUNDAL
website    = https://szaghi.github.io/FUNDAL
email      = stefano.zaghi@gmail.it
authors    = Stefano Zaghi

# user-tunable variables (FoBiS fobos variables)
[common-variables]
# AMD GPU target architecture(s) for amdflang OpenMP offload.
# Set to match your GPU, e.g. gfx90a, gfx942, gfx1100, or a comma-separated list.
# This is the default value; it can be completely overwritten from the CLI by
# selecting one of the [varset:*] sections below, e.g.
#   FoBiS.py build -mode fundal-test-omp-amd --varset gfx1100
$GPU_ARCH = gfx942

# CLI-selectable GPU architecture overrides.
# Each varset fully replaces $GPU_ARCH (last-write-wins); pick one with --varset.
[varset:gfx906]
$GPU_ARCH = gfx906

[varset:gfx908]
$GPU_ARCH = gfx908

[varset:gfx90a]
$GPU_ARCH = gfx90a

[varset:gfx940]
$GPU_ARCH = gfx940

[varset:gfx942]
$GPU_ARCH = gfx942

[varset:gfx950]
$GPU_ARCH = gfx950

[varset:gfx1030]
$GPU_ARCH = gfx1030

[varset:gfx1100]
$GPU_ARCH = gfx1100

[modes]
# the first mode is the default (`fobis build`, scripts/install.sh): a library build that any gfortran can do
modes = fundal-lib-gnu
        fundal-test-nvf
        fundal-test-oac-nvf
        fundal-test-oac-nvf-debug
        fundal-test-oac-mpi-nvf
        fundal-test-oac-mpi-nvf-debug
        fundal-test-gnu
        fundal-test-oac-gnu
        fundal-test-oac-mpi-gnu
        fundal-test-amd
        fundal-test-omp-amd
        fundal-test-omp-mpi-amd
        fundal-test-ifx
        fundal-test-omp-ifx
        fundal-test-omp-mpi-ifx
        fundal-void-nvf
        fundal-void-oac-nvf
        fundal-void-gnu
        fundal-void-oac-gnu
        fundal-void-amd
        fundal-void-omp-amd
        fundal-void-ifx
        fundal-void-omp-ifx

# modes to build library and tests
[fundal-lib-gnu]
help      = Build the FUNDAL static library with GNU, compile-time CPU mode (default mode)
template  = template-gnu
src       = ./src/lib/
target    = fundal.F90
mklib     = static
output    = libfundal.a
build_dir = ./build/fobis-lib-gnu/

[fundal-test-nvf]
help          = Build FUNDAL tests with NVF
template      = template-nvf
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-oac-nvf]
help          = Build FUNDAL tests with OpenACC-NVF
template      = template-oac-nvf
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-oac-nvf-debug]
help          = Build FUNDAL tests with OpenACC-NVF in debug mode
template      = template-oac-nvf-debug
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-oac-mpi-nvf]
help     = Build FUNDAL tests with OpenACC-MPI-NVF
template = template-oac-nvf
mpi      = True
src      = ./src/

[fundal-test-oac-mpi-nvf-debug]
help     = Build FUNDAL tests with OpenACC-MPI-NVF in debug mode
template = template-oac-nvf-debug
mpi      = True
src      = ./src/

[fundal-test-gnu]
help          = Build FUNDAL tests with GNU
template      = template-gnu
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-oac-gnu]
help          = Build FUNDAL tests with OpenACC-GNU
template      = template-oac-gnu
src           = ./src/
exclude_dirs  = ./src/tests/mpi/ ./src/tests/laplace/ ./src/tests/precision/

[fundal-test-oac-mpi-gnu]
help     = Build FUNDAL tests with OpenACC-MPI-GNU
template = template-oac-gnu
mpi      = True
src      = ./src/

[fundal-test-amd]
help          = Build FUNDAL tests with AMD Flang
template      = template-amd
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-omp-amd]
help          = Build FUNDAL tests with OpenMP-AMD Flang
template      = template-omp-amd
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-omp-mpi-amd]
help     = Build FUNDAL tests with OpenMP-MPI-AMD Flang
template = template-omp-amd
mpi      = True
src      = ./src/


[fundal-test-ifx]
help          = Build FUNDAL tests with IFX
template      = template-ifx
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-omp-ifx]
help          = Build FUNDAL tests with OpenMP-IFX
template      = template-omp-ifx
src           = ./src/
exclude_dirs  = ./src/tests/mpi/

[fundal-test-omp-mpi-ifx]
help     = Build FUNDAL tests with OpenMP-MPI-IFX
template = template-omp-ifx
mpi      = True
src      = ./src/

# void modes to build a specified target/src (-t/-src must be passed by CLI)

[fundal-void-nvf]
help     = Build a specified target/src with NVF (no pragmas)
template = template-nvf

[fundal-void-oac-nvf]
help     = Build a specified target/src with OpenACC-NVF
template = template-oac-nvf

[fundal-void-gnu]
help     = Build a specified target/src with GNU (no pragmas)
template = template-gnu

[fundal-void-oac-gnu]
help     = Build a specified target/src with OpenACC-GNU
template = template-oac-gnu

[fundal-void-amd]
help     = Build a specified target/src with AMD Flang (no pragmas)
template = template-amd

[fundal-void-omp-amd]
help     = Build a specified target/src with OpenMP-AMD Flang
template = template-omp-amd

[fundal-void-ifx]
help     = Build a specified target/src with IFX (no pragmas)
template = template-ifx

[fundal-void-omp-ifx]
help     = Build a specified target/src with OpenMP-IFX
template = template-omp-ifx

# templates

[template-base]
mod_dir   = ./mod/
obj_dir   = ./obj/
build_dir = ./exe/
colors    = True
quiet     = False
log       = True
jobs      = 4

[template-nvf]
template = template-base
compiler = nvfortran
preproc  = -DCOMPILER_NVF
cflags   = -cpp -c -fast -Minfo=all
lflags   = -Minfo=all

[template-oac-nvf]
template = template-base
compiler = nvfortran
preproc  = -DCOMPILER_NVF -DDEV_OAC
cflags   = -cpp -c -acc -gpu=cc89 -fast -Minfo=all
lflags   = -acc -gpu=cc89 -fast -Minfo=all

[template-oac-nvf-debug]
template = template-oac-nvf
cflags   = -cpp -c -acc -gpu=cc89 -Minfo=all -C -g
lflags   = -acc -gpu=cc89 -Minfo=all -C -g

[template-gnu]
template = template-base
compiler = gnu
preproc  = -DCOMPILER_GNU
cflags   = -cpp -c
lflags   = -cpp

[template-oac-gnu]
template = template-base
compiler = gnu
preproc  = -DCOMPILER_GNU -DDEV_OAC
cflags   = -cpp -c -fopenacc
lflags   = -fopenacc

[template-oac-gnu-debug]
template  = template-oac-gnu
cflags    = -cpp -c -fopenacc -g -fcheck=all -fbacktrace
lflags    = -fopenacc -g -fcheck=all -fbacktrace

[template-amd]
template = template-base
compiler  = amd
cflags    = -c -cpp
lflags    = -cpp
openmp    = True

[template-omp-amd]
# DEV_HIP enables the HIP-->Fortran interfaces (device memory status, etc.) and
# links the HIP runtime (libamdhip64). It is set ONLY for AMD builds: the same
# OpenMP-offload backend (DEV_OMP) is also used by Intel IFX, which must NOT link
# HIP libraries (they are not available outside the AMD/ROCm stack).
# NOTE: the HIP runtime is found through the shell environment (LIBRARY_PATH at
# link time, LD_LIBRARY_PATH at run time), which a sourced ROCm environment
# populates from $ROCM_PATH. FoBiS runs the compiler with shell=False and does
# not expand environment variables in flags, so no path is hardcoded here; make
# sure $ROCM_PATH (and the ROCm lib dir) are in your environment before building.
template = template-base
compiler = amd
preproc  = -DDEV_OMP -DDEV_HIP
cflags   = -c -cpp --offload-arch=$GPU_ARCH
lflags   = -cpp --offload-arch=$GPU_ARCH -lamdhip64
openmp   = True

[template-ifx]
template = template-base
compiler = intel_nextgen
cflags   = -c -cpp
lflags   = -cpp
openmp   = True

[template-omp-ifx]
template       = template-base
compiler       = intel_nextgen
preproc        = -DDEV_OMP
cflags         = -c -cpp
lflags         = -cpp
openmp         = True
openmp_offload = True

# aux rules
[rule-run-tests]
help   = Run all tests
rule_1 = scripts/run_tests.sh

[rule-build-run-tests-oac-nvf]
help   = Build and Run all tests with OpenACC-NVF
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-test-oac-nvf
rule_3 = fobis rule --ex run-tests

[rule-build-run-tests-omp-ifx]
help   = Build and Run all tests with OpenMP-IFX
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-test-omp-ifx
rule_3 = fobis rule --ex run-tests

[rule-build-run-tests-oac-gnu]
help   = Build and Run all tests with OpenACC-GNU
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-test-oac-gnu
rule_3 = fobis rule --ex run-tests

[rule-build-run-tests-omp-amd]
help   = Build and Run all tests with OpenMP-AMD Flang
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-test-omp-amd
rule_3 = fobis rule --ex run-tests

[rule-build-laplace-baseline-nvf]
help   = Build laplace test with NVF (without pragmas)
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-nvf --target src/tests/laplace/fundal_laplace_baseline.F90 --src src/

[rule-build-laplace-oac-nvf]
help   = Build laplace test with OpenACC-NVF
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-oac-nvf --target src/tests/laplace/fundal_laplace_dev_inline.F90 --src src/
rule_4 = fobis build --mode fundal-void-oac-nvf --target src/tests/laplace/fundal_laplace_dev_routine.F90 --src src/

[rule-build-laplace-baseline-ifx]
help   = Build laplace test with IFX (without pragmas)
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-ifx --target src/tests/laplace/fundal_laplace_baseline.F90 --src src/

[rule-build-laplace-omp-ifx]
help   = Build laplace test with OpenMP-ifx
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-omp-ifx --target src/tests/laplace/fundal_laplace_dev_inline.F90 --src src/
rule_4 = fobis build --mode fundal-void-omp-ifx --target src/tests/laplace/fundal_laplace_dev_routine.F90 --src src/

[rule-build-laplace-baseline-gnu]
help   = Build laplace test with GNU (without pragmas)
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-gnu --target src/tests/laplace/fundal_laplace_baseline.F90 --src src/

[rule-build-laplace-oac-gnu]
help   = Build laplace test with OpenACC-GNU
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-oac-gnu --target src/tests/laplace/fundal_laplace_dev_inline.F90 --src src/
rule_3 = fobis build --mode fundal-void-oac-gnu --target src/tests/laplace/fundal_laplace_dev_routine.F90 --src src/

[rule-build-laplace-baseline-amd]
help   = Build laplace test with AMD Flang (without pragmas)
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-amd --target src/tests/laplace/fundal_laplace_baseline.F90 --src src/

[rule-build-laplace-omp-amd]
help   = Build laplace test with OpenMP-AMD Flang
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-omp-amd --target src/tests/laplace/fundal_laplace_dev_inline.F90 --src src/
rule_4 = fobis build --mode fundal-void-omp-amd --target src/tests/laplace/fundal_laplace_dev_routine.F90 --src src/

[rule-build-assign-lb-oac-nvf]
help   = Build assign with lower-bounds-passed test with OpenACC-NVF
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-oac-nvf --target src/tests/fundal_assign_lb_test.F90 --src src/

[rule-build-memcpy-tra-oac-nvf]
help   = Build memcpy transposed test with OpenACC-NVF
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-oac-nvf --target src/tests/fundal_memcpy_transposed_test.F90 --src src/

[rule-build-compilers-proofs-oac-nvf]
help   = Build compilers proofs test with OpenACC-NVF
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-oac-nvf --target ./compilers_proofs/oac/test_deviceptr.f90
rule_3 = fobis build --mode fundal-void-oac-nvf --target ./compilers_proofs/oac/test_present.f90

[rule-build-compilers-proofs-oac-gnu]
help   = Build compilers proofs test with OpenACC-GNU
rule_1 = fobis clean
rule_2 = fobis build --mode fundal-void-oac-gnu --target ./compilers_proofs/oac/test_deviceptr.f90
rule_3 = fobis build --mode fundal-void-oac-gnu --target ./compilers_proofs/oac/test_present.f90

[rule-makedoc]
help   = Build documentation with formal + VitePress
rule_1 = formal generate --mirror-sources --diagrams --project docs/ford.md --output docs/api
rule_2 = cd docs && npm install && npm run docs:build

[rule-deldoc]
help = Delete documentation build artifacts
rule = rm -rf docs/.vitepress/dist/ docs/.vitepress/cache/ docs/api/

[rule-delexe]
help = Delete exes
rule = rm -rf exe/

[rule-clean]
help = Clean the project tree
rule_1 = fobis rule --ex deldoc
rule_2 = fobis rule --ex delexe
rule_3 = rm -f *.gcov

[rule-maketar]
help = Make tar archive of the project
rule = tar --xform="s%^%FUNDAL/%" -czf FUNDAL.tar.gz *

[rule-makecoverage]
help   = Perform coverage analysis
rule_1 = fobis rule --ex delexe
rule_2 = fobis build --mode fundal-test-oac-gnu --coverage
rule_3 = fobis rule --ex run-tests
rule_4 = ./scripts/compute-coverage.sh

[rule-makecoverage-analysis]
help   = Perform coverage analysis and saving reports in markdown
rule_1 = fobis rule --ex makecoverage
rule_2 = fobis rule --gcov-analyzer docs/guide/ --gcov-analyzer coverage-analysis
rule_3 = rm -f *.gcov