Remove rocFile

.github/workflows/build-ais.yml

@@ -55,7 +55,7 @@ jobs:
               cp -R /mnt/ais /ais
               mkdir /ais/build
             '
-      - name: Generate build files for hipFile and rocFile targeting the AMD platform (amdclang++)
+      - name: Generate build files for hipFile targeting the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \
@@ -70,7 +70,7 @@ jobs:
                 -DBUILD_CODE_COVERAGE=ON \
                 ..
             '
-      - name: Build hipFile and rocFile for the AMD platform (amdclang++)
+      - name: Build hipFile for the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \
@@ -79,7 +79,7 @@ jobs:
             /bin/bash -c '
               cmake --build . --parallel
             '
-      - name: Test hipFile and rocFile for the AMD platform (amdclang++)
+      - name: Test hipFile for the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \
@@ -157,7 +157,7 @@ jobs:
               cp -R /mnt/ais /ais
               mkdir /ais/build
             '
-      - name: Generate build files for hipFile and rocFile targeting the AMD platform (${{ matrix.alternate_compilers }})
+      - name: Generate build files for hipFile targeting the AMD platform (${{ matrix.alternate_compilers }})
         run: |
           docker exec \
             -t \
@@ -171,7 +171,7 @@ jobs:
                 -DBUILD_AIS_DOCS=ON \
                 ..
             '
-      - name: Build hipFile and rocFile for the AMD platform (${{ matrix.alternate_compilers }})
+      - name: Build hipFile for the AMD platform (${{ matrix.alternate_compilers }})
         run: |
           docker exec \
             -t \
@@ -226,7 +226,7 @@ jobs:
               cp -R /mnt/ais /ais
               mkdir /ais/build
             '
-      - name: Generate build files for hipFile and rocFile targeting the AMD platform (amdclang++)
+      - name: Generate build files for hipFile targeting the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \
@@ -240,7 +240,7 @@ jobs:
                 -DBUILD_AIS_DOCS=ON \
                 ..
             '
-      - name: Build hipFile and rocFile for the AMD platform (amdclang++)
+      - name: Build hipFile for the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \
@@ -249,7 +249,7 @@ jobs:
             /bin/bash -c '
               cmake --build . --parallel
             '
-      - name: Run hipFile and rocFile system tests for the AMD platform (amdclang++)
+      - name: Run hipFile system tests for the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \
@@ -258,7 +258,7 @@ jobs:
             /bin/bash -c '
               ctest -V -L "system" --parallel
             '
-      - name: Stress tests for hipFile and rocFile targeting the AMD platform (amdclang++)
+      - name: Stress tests for hipFile targeting the AMD platform (amdclang++)
         run: |
           docker exec \
             -t \

CHANGELOG.md

@@ -1,15 +1,16 @@
-# Changelog for hipFile/rocFile
+# Changelog for hipFile
 
 ## UNRELEASED - hipFile 0.2.0
 ### Added
 
 ### Changed
 
 ### Removed
+* The rocFile library has been completely removed and the code is now a part of hipFile.
 * The hipify patch was removed. You can get hipify with hipFile support at https://github.com/derobins/HIPIFY/tree/hipFile.
 
 ### Limitations
-* The batch API calls are not supported w/ a rocFile backend
-* The async API calls are not supported w/ a rocFile backend
+* The batch API calls are not supported w/ an AMD backend
+* The async API calls are not supported w/ an AMD backend
 
 ### Known issues

CMakeLists.txt

@@ -16,8 +16,6 @@ endif()
 
 # Set the library version in a variable so we can use
 # it in *.in files and avoid version mismatch.
-#
-# The versions number of rocFile and hipFile are identical
 set(AIS_LIBRARY_MAJOR 0)
 set(AIS_LIBRARY_MINOR 2)
 set(AIS_LIBRARY_PATCH 0)
@@ -81,6 +79,15 @@ if(NOT CMAKE_HIP_PLATFORM STREQUAL "amd" AND NOT CMAKE_HIP_PLATFORM STREQUAL "nv
     message(FATAL_ERROR "Invalid CMAKE_HIP_PLATFORM: '${CMAKE_HIP_PLATFORM}'. Allowed values are 'amd' or 'nvidia'.")
 endif()
 
+# Set the platform variable
+if(CMAKE_HIP_PLATFORM STREQUAL "nvidia")
+    set(BUILD_AMD_DETAIL OFF)
+    set(BUILD_NVIDIA_DETAIL ON)
+else()
+    set(BUILD_AMD_DETAIL ON)
+    set(BUILD_NVIDIA_DETAIL OFF)
+endif()
+
 #-----------------------------------------------------------------------------
 # Include our custom CMake code in the module path
 #-----------------------------------------------------------------------------
@@ -119,7 +126,7 @@ include(AISAddLibraries)
 #-----------------------------------------------------------------------------
 # Code coverage (via llvm-cov)
 #
-# To use with the hipFile/rocFile libraries:
+# To use with the hipFile library:
 #   - Build with BUILD_CODE_COVERAGE set to ON
 #   - Run `ctest .`
 #
@@ -156,15 +163,6 @@ include(AISIWYU)
 #-------------------
 include(AISSanitizers)
 
-#-------------------
-# Platform defaults
-#-------------------
-if(CMAKE_HIP_PLATFORM STREQUAL "nvidia")
-    set(BUILD_ROCFILE OFF)
-else()
-    set(BUILD_ROCFILE ON)
-endif()
-
 #-----------------------
 # aiscp example program
 #-----------------------
@@ -173,7 +171,7 @@ option(BUILD_AISCP "Build aiscp example program" ON)
 #------
 # docs
 #------
-option(BUILD_AIS_DOCS "Build the rocFile/hipFile docs (requires Doxygen)" OFF)
+option(BUILD_AIS_DOCS "Build the hipFile docs (requires Doxygen)" OFF)
 
 #-----------------------------------------------------------------------------
 # Find important packages for building the software
@@ -194,10 +192,10 @@ else()
 endif()
 
 # Find the cuFile library and headers on NVIDIA
-if(CMAKE_HIP_PLATFORM STREQUAL "nvidia")
+if(BUILD_NVIDIA_DETAIL)
     find_package(CUDAToolkit REQUIRED)
 
-    if(CMAKE_HIP_PLATFORM STREQUAL "nvidia" AND CMAKE_VERSION VERSION_LESS "3.28")
+    if(CMAKE_VERSION VERSION_LESS "3.28")
         enable_language(CUDA)
         # Set a default architecture if not provided.
         if(NOT CMAKE_CUDA_ARCHITECTURES)
@@ -219,9 +217,6 @@ endif()
 #-----------------------------------------------------------------------------
 # Subdirectories to configure/build
 #-----------------------------------------------------------------------------
-if(BUILD_ROCFILE)
-    add_subdirectory(rocfile)
-endif()
 add_subdirectory(hipfile)
 if(BUILD_AIS_DOCS)
     add_subdirectory(docs)

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to hipFile/rocFile
+# Contributing to hipFile
 
 Thank you for contributing! This guide outlines the development workflow,
 contribution standards, and best practices when working on hipFile.

INSTALL.md

@@ -1,6 +1,6 @@
-# Install guide for hipFile / rocFile
+# Install guide for hipFile
 
-## Building hipFile and rocFile
+## Building hipFile
 
 > [!NOTE]
 > hipFile is alpha software that has undergone testing on limited hardware. It may not work on your system at this time.
@@ -57,18 +57,18 @@ Sanitizer options
 
 `ctest .` will run all tests.
 
-You can filter on test labels using the `-L` option. We currently have `hipfile` and `rocfile` labels for each library and `unit`, `system`, and `stress` labels for the different test types. Multiple `-L` options form an *and*. A `|` can be used for an *or*.
+You can filter on test labels using the `-L` option. We currently have `hipfile` and `internal` labels for the public API and its internals, respectively, and `unit`, `system`, and `stress` labels for the different test types. Multiple `-L` options form an *and*. A `|` can be used for an *or*.
 
-`ctest . -L rocfile -L unit` runs all unit tests in the rocFile library.
+`ctest . -L internal -L unit` runs all the internal library unit tests.
 `ctest . -L 'system|unit'` runs all system or unit tests.
 
 You can filter on test names using the `-R` option. This option supports wildcards.
 
-`ctest . -R RocFileBuffer.get_buffer_makes_temporary_buffer` runs the specified test.
-`ctest . -R 'RocFileBuffer*'` runs all tests that start with RocFileBuffer.
+`ctest . -R HipFileBuffer.get_buffer_makes_temporary_buffer` runs the specified test.
+`ctest . -R 'HipFileBuffer*'` runs all tests that start with HipFileBuffer.
 
 ### Install and package
-The hipFile and rocFile libraries can be installed with CMake. The default
+The hipFile library can be installed with CMake. The default
 install prefix is still the CMake default of `/usr/local`.
 
 `cmake --install .`

README.md

@@ -1,4 +1,4 @@
-# hipFile / rocFile
+# hipFile
 
 > [!CAUTION] 
 > This release is an *early-access* software technology preview. Running production workloads is *not* recommended.
@@ -9,7 +9,7 @@
 
 AMD Infinity Storage library that supports IO directly to the GPU
 
-## Building hipFile and rocFile
+## Building hipFile
 
 See the INSTALL.md file in the project root for a list of supported
 hardware and compilers as well as build and install instructions.

SECURITY.md

@@ -1,8 +1,8 @@
 # Security Policy
 
 ## Reporting a vulnerability
-If you have discovered a security vulnerability in the hipFile or rocFile
-libraries, please do NOT report it publicly using a GitHub issue. Instead,
+If you have discovered a security vulnerability in the hipFile library,
+please do NOT report it publicly using a GitHub issue. Instead,
 you should report the issue via the AMD Product Security website:
 
 https://www.amd.com/en/resources/product-security.html

STYLEGUIDE.md

@@ -1,4 +1,4 @@
-# hipFile/rocFile Style Guide
+# hipFile Style Guide
 
 ## File and Directory Structure
 ### Organization

cmake/AISAddExecutable.cmake

@@ -15,9 +15,9 @@ include(AISCompilerOptions)
 # NOTE: Assumes AIS target libraries are named <foo>_(static|shared)
 #
 # NOTE: This isn't the most robust function. It's mainly intended
-#       to reduce code duplication in rocFile/hipFile. For example,
-#       DEPS is for passing the rocFile dependency to hipFile and
-#       won't work for passing general library dependencies.
+#       to reduce code duplication. For example, DEPS is for passing
+#       the hipFile shared/static dependency and won't work for passing
+#       general library dependencies.
 function(ais_add_executable)
 
     # Parse arguments

cmake/AISAddLibraries.cmake

@@ -13,21 +13,13 @@ include(CheckLinkerFlag)
 #   LIBINCL  <path>                             Path to installed include files (e.g., hipfile.h)
 #   SYSINCLS [path1 [path2 ...]]                Paths to other include dirs
 #   SRCS     [src1 [src2 ...]]                  The source files
-#   DEPS     [dependency1 [dependency2 ...]]    List of AIS target library dependencies
 #   LIBS     [lib1, [lib2 ...]]                 List of external library dependencies
-#
-# NOTE: Assumes internal library dependencies are named <foo>_(static|shared)
-#
-# NOTE: This isn't the most robust function. It's mainly intended to reduce
-#       code duplication in rocFile/hipFile. For example, DEPS is for passing
-#       the rocFile internal library dependency to hipFile and won't work for
-#       passing general library dependencies.
 function(ais_add_libraries)
 
     # Parse arguments
     set(options) # None at this time
     set(oneValueArgs NAME DETAIL LIBINCL)
-    set(multiValueArgs SRCS DEPS SYSINCLS LIBS)
+    set(multiValueArgs SRCS SYSINCLS LIBS)
     cmake_parse_arguments(arg "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
 
     # Convenience names
@@ -48,18 +40,6 @@ function(ais_add_libraries)
     set_target_properties(${shared_name} PROPERTIES VERSION ${AIS_LIBRARY_VERSION})
     set_target_properties(${shared_name} PROPERTIES SOVERSION ${AIS_LIBRARY_SOVERSION})
 
-    # Add dependencies on internal targets
-    foreach(dep IN LISTS arg_DEPS)
-        add_dependencies(${static_name} "${dep}_static")
-        add_dependencies(${shared_name} "${dep}_shared")
-
-        target_link_libraries(${static_name} PRIVATE "${dep}_static")
-        target_link_libraries(${shared_name} PRIVATE "${dep}_shared")
-
-        # The object library needs to see the headers for any dependencies
-        target_link_libraries(${object_name} PUBLIC "${dep}_shared")
-    endforeach()
-
     # Add dependencies on external libraries
     foreach(lib IN LISTS arg_LIBS)
         find_library(LIBRARY_PATH NAMES ${lib})

cmake/AISCompilerOptions.cmake

@@ -12,7 +12,7 @@ function(ais_set_compiler_flags target)
     foreach(source IN LISTS sources)
         get_source_file_property(language ${source} LANGUAGE)
         # CMake HIP language prior to 3.28 only supports AMD, so change LANGUAGE to CUDA for HIP files
-        if(CMAKE_HIP_PLATFORM STREQUAL "nvidia" AND CMAKE_VERSION VERSION_LESS "3.28" AND language STREQUAL HIP)
+        if(BUILD_NVIDIA_DETAIL AND CMAKE_VERSION VERSION_LESS "3.28" AND language STREQUAL HIP)
             set_source_files_properties(${source} PROPERTIES LANGUAGE "CUDA")
             set(language CUDA)
             message(STATUS "Setting ${source} LANGUAGE to CUDA because CMake < 3.28")

cmake/AISInstall.cmake

@@ -2,46 +2,26 @@
 #
 # SPDX-License-Identifier: MIT
 
-# Install hipFile and rocFile
+# Install hipFile
 
 # From the rocm-cmake repo
 include(ROCMInstallTargets)
 include(ROCMCreatePackage)
 
-
 # Install the package
-if(BUILD_ROCFILE)
-    rocm_install(TARGETS rocfile_static)
-    rocm_install(TARGETS rocfile_shared)
-endif()
 rocm_install(TARGETS hipfile_static)
 rocm_install(TARGETS hipfile_shared)
 
 # Install the headers
-if(BUILD_ROCFILE)
-    rocm_install(
-        DIRECTORY ${CMAKE_SOURCE_DIR}/rocfile/include/
-        DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-    )
-endif()
 rocm_install(
     DIRECTORY ${CMAKE_SOURCE_DIR}/hipfile/include/
     DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
 )
 
-# Always install the hipfile-types.h file
-rocm_install(
-    FILES ${CMAKE_SOURCE_DIR}/shared/hipfile-types.h
-    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
-)
-
 # rocm_package_add_dependencies() line should go here
 # when we have dependencies
 
 # Export the targets
-if(BUILD_ROCFILE)
-    set(target_list ${target_list} roc::rocfile_shared roc::rocfile_static)
-endif()
 set(target_list ${target_list} roc::hipfile_shared roc::hipfile_static)
 
 rocm_export_targets(

docs/CMakeLists.txt

@@ -52,6 +52,3 @@ function(ais_add_docs_target AIS_DOC_PRETTY_NAME)
 endfunction()
 
 ais_add_docs_target("hipFile")
-if(BUILD_ROCFILE)
-    ais_add_docs_target("rocFile")
-endif()