Skip to content

feat(rocfft): add the generated Fortran binding in bindings/fortran/rocfft - #12366

Draft
amontoison wants to merge 8 commits into
ROCm:developfrom
amontoison:users/amontoison/rocfft-fortran-bindings
Draft

amontoison wants to merge 8 commits into
ROCm:developfrom
amontoison:users/amontoison/rocfft-fortran-bindings

Conversation

@amontoison

@amontoison amontoison commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Implements RFC0015, Fortran Bindings Split (update) for rocFFT: bindings/fortran/rocfft/ is a standalone CMake project that builds the generated Fortran binding against an installed rocFFT. The library is untouched: no option, no add_subdirectory, no change to projects/rocfft/.

Draft until ROCm/rocm-systems#11923 (HIP Fortran binding, which the tests use) merges.

What lands

  • bindings/fortran/rocfft/rocfft.F90 (721 lines, generated with ROCm/rocm-fortran-generator 9c8b3e4 from the rocFFT headers, marked linguist-generated): one module rocfft with the bind(C) interfaces, the enum constants, the rocfftCheck helper and array overloads; plans, descriptions, execution info, fields and bricks are plain type(c_ptr).
  • metadata/rocfft.toml: the generator metadata it was generated with.
  • test/: 36 CTest tests, 18 .f03 tests of the C interfaces and 18 .f08 tests of the array overloads (registered as <name>_f2008). rocfft_field_brick_z and its _f2008 variant skip (return code 77) on fewer than two GPUs. They also install: the executables in bin/, and a CTestTestfile.cmake with the same tests and properties in bin/rocfft-fortran/, for ctest --test-dir.
  • CMakeLists.txt, the rocfft-fortran config template, cmake/ROCmFortranCompiler.cmake (the same in every binding: ROCm's amdflang is preferred over the first compiler on PATH unless CMAKE_Fortran_COMPILER or FC is set), cmake/toolchains/ and the binding's CHANGELOG.md.
  • .github/CODEOWNERS: /bindings/fortran/rocfft/ @ROCm/rocm-fortran-maintainers @ROCm/fft-reviewers.
  • .github/repos-config.json: a bindings/fortran entry, so CI detects changes to the binding. Each binding PR appends its entry at the end of the list, so all but the first to merge need a trivial rebase.

A consumer uses find_package(rocfft-fortran) and links roc::rocfft_fortran. The archive and .mod files install per compiler under lib/fortran/<compiler>/ and include/fortran/<compiler>/; ROCFFT_FORTRAN_COMPILER_DIR names that directory. The archive has one section per procedure, so a program linked with -Wl,--gc-sections keeps only the wrappers it calls.

Options

Option Default Effect
BUILD_FORTRAN_BINDINGS ${UNIX} builds the binding; skipped without a Fortran compiler
BUILD_FORTRAN_CLIENTS ON builds and installs the tests in test/; off under BUILD_ADDRESS_SANITIZER
FORTRAN_ARRAY_INTERFACES assumed-shape none / assumed-shape / assumed-rank array overloads

In TheRock

ROCm/TheRock#9446 builds bindings/fortran/rocfft as the rocfft-fortran subproject against the rocFFT it built, with -DBUILD_FORTRAN_BINDINGS=ON -DBUILD_FORTRAN_CLIENTS=${THEROCK_BUILD_TESTING}, ships it in the fft-fortran artifact and runs the installed tests in its rocfft-fortran GPU test job.

Follow-ups

rocFFT never shipped a Fortran module, so there is nothing to deprecate.

Build and test

From the repository root, with $PREFIX the install prefix:

lib=rocfft
cmake -S bindings/fortran/$lib -B build/$lib-fortran \
  -DCMAKE_PREFIX_PATH="/opt/rocm;$HIP_FORTRAN_PREFIX" -DCMAKE_INSTALL_PREFIX="$PREFIX"
cmake --build build/$lib-fortran
ctest --test-dir build/$lib-fortran
cmake --install build/$lib-fortran
ctest --test-dir "$PREFIX/bin/$lib-fortran"

$HIP_FORTRAN_PREFIX holds the HIP Fortran binding (hip-fortran) built with the same compiler; without it the tests are skipped.

Verification

Standalone against ROCm 10.1 with amdflang on one GPU: 36 tests, 34 pass, 2 skipped.

JIRA ID: ROCM-31390

@therock-pr-bot

therock-pr-bot Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

✅ All Checks Passed — Ready for Review

Check Status Details
📝 PR Description ✅ Pass —
⛔ Forbidden Files ✅ Pass —
🧪 Unit Test ✅ Pass PR does not contain code files — Unit Test auto-passed
🔎 pre-commit ✅ Pass —
🚫 Draft PR 🔜 To Be Enabled —
🚩 Feature Flag 🔜 To Be Enabled —
📊 Code Coverage 🔜 To Be Enabled —
🤖 therock-pr-bot ✅ Pass —

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

@therock-pr-bot

therock-pr-bot Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

🎉 All checks passed! This PR is ready for review.

@codecov

codecov Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #12366      +/-   ##
===========================================
+ Coverage    75.95%   75.98%   +0.03%     
===========================================
  Files         2880     2880              
  Lines       479025   479016       -9     
  Branches     71958    71953       -5     
===========================================
+ Hits        363828   363952     +124     
+ Misses       90338    90126     -212     
- Partials     24859    24938      +79     
Flag Coverage Δ *Carryforward flag
TensileLite-CPP 48.93% <ø> (ø) Carriedforward from bd90590
TensileLite-Unit 83.68% <ø> (ø) Carriedforward from bd90590
hipBLAS 90.62% <ø> (ø) Carriedforward from bd90590
hipBLASLt 64.43% <ø> (ø) Carriedforward from bd90590
hipCUB 82.68% <ø> (ø) Carriedforward from bd90590
hipDNN 86.78% <ø> (ø) Carriedforward from bd90590
hipFFT 42.00% <ø> (ø) Carriedforward from bd90590
hipRAND 76.12% <ø> (ø) Carriedforward from bd90590
hipSOLVER 69.67% <ø> (ø) Carriedforward from bd90590
hipSPARSE 86.99% <ø> (ø) Carriedforward from bd90590
rocBLAS 68.73% <ø> (ø) Carriedforward from bd90590
rocFFT 48.48% <ø> (+0.39%) ⬆️
rocRAND 57.30% <ø> (ø) Carriedforward from bd90590
rocSOLVER 76.74% <ø> (ø) Carriedforward from bd90590
rocSPARSE 76.92% <ø> (ø) Carriedforward from bd90590
rocThrust 93.15% <ø> (ø) Carriedforward from bd90590

*This pull request uses carry forward flags. Click here to find out more.
see 47 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch from f2a3a9c to f0038a7 Compare September 25, 2026 04:37
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch 2 times, most recently from 08ad616 to db76704 Compare September 28, 2026 03:49
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch from db76704 to 397c344 Compare September 29, 2026 03:14
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch from d345993 to e3bd7b1 Compare October 4, 2026 03:45
@amontoison amontoison changed the title feat(rocfft): add generated Fortran bindings (RFC0014) feat(rocfft): add generated Fortran bindings Oct 4, 2026
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch from e3bd7b1 to 45b431e Compare October 5, 2026 05:13
Add fortran/rocfft.F90, the rocfft module generated from the C headers
by the rocm-fortran generator under RFC0019 (ROCm/TheRock#8122). It
is committed next to the headers, is not edited by hand, and
.gitattributes marks it linguist-generated.
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch from 45b431e to bb8f4fc Compare October 22, 2026 13:23
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch 2 times, most recently from 77e8328 to 41d4fef Compare October 22, 2026 15:33
Build fortran/rocfft.F90 as roc::rocfft_fortran from fortran/, a CMake
project of its own that the root adds. BUILD_FORTRAN_BINDINGS (default
${UNIX}), BUILD_FORTRAN_CLIENTS (default ON) and
FORTRAN_ARRAY_INTERFACES (default assumed-shape) control it, and
ROCFFT_BUILD_FORTRAN_* override per library. The .mod and the archive
install per compiler under <includedir>/fortran/<compiler> and
<libdir>/fortran/<compiler>, beside a rocfft-fortran config package.

fortran/test/ adds 18 CTest tests labelled gpu; they use hip and skip
until ROCm/rocm-systems#11923 lands. rocFFT had no Fortran module
before, so nothing is removed.

Refs: ROCm/TheRock#8122 (RFC0019)
@amontoison
amontoison force-pushed the users/amontoison/rocfft-fortran-bindings branch from 41d4fef to 22b04f8 Compare October 22, 2026 18:14
The rocFFT Fortran binding consumes rocFFT's public API and builds
standalone against an installed rocFFT, so it moves out of the library
into bindings/fortran/rocfft, the tree every monorepo and TheRock use for
the Fortran bindings (RFC0015). Nothing is wired into the library build
any more: the library is back to its state on develop.

- bindings/fortran/rocfft reads rocFFT's version from projects/rocfft
- the binding has its own .gitattributes and CHANGELOG.md
- CODEOWNERS: /bindings/fortran/rocfft/, same owners
- repos-config.json: register bindings/fortran/rocfft so CI detects changes
@github-actions github-actions Bot added github actions project: none Does not target any component labels Nov 3, 2026
@amontoison amontoison changed the title feat(rocfft): add generated Fortran bindings feat(rocfft): add the generated Fortran binding in bindings/fortran/rocfft Nov 3, 2026
Regenerate bindings/fortran/rocfft with rocm-fortran-generator 9c8b3e4, and
commit its metadata in bindings/fortran/rocfft/metadata/, where the generator
reads it from a checkout, instead of the copy kept in the generator.
Install the test executables in bin/, and a CTestTestfile.cmake in
bin/rocfft-fortran/ with the same tests and properties as the build tree,
so that ctest --test-dir runs them from an install, as TheRock's test
jobs do for the libraries.
The binding is built against an installed rocFFT and is never added to the
library's build, so drop what only served that: the per-library
BUILD_FORTRAN_* overrides, the PARENT_SCOPE results, the ROCM_HAVE_FORTRAN
shortcut, the gating on the library's client and test options, and the
comments about the root. Find the Fortran compiler through the
cmake/ROCmFortranCompiler.cmake shared by all the bindings, and require
CMake 3.19.
…ortran

The package files went to lib/cmake/rocfft, the C library's directory, with a forwarder in lib/cmake/rocfft-fortran. rocRAND and hipRAND install their own legacy <lib>-fortran-config.cmake there, so the files overlapped. Install the config, targets and version files directly where find_package(<package>) looks, as the HIP and ROCTx bindings do, and drop the forwarder.
… recursion

rocm-cmake's generated rocfft-config.cmake is to include
lib/cmake/rocfft-fortran/rocfft-fortran-config.cmake after its targets
(ROCm/rocm-cmake#303). Skip find_dependency(rocfft) when rocfft is the
package being found, not only when roc::rocfft is already imported, so
that include never re-enters rocfft-config.cmake.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant