Add cmake-format to CI

.gersemirc

@@ -0,0 +1,10 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/BlankSpruce/gersemi/master/gersemi/configuration.schema.json
+
+color: false
+definitions: []
+indent: 4
+line_length: 80
+list_expansion: favour-inlining
+quiet: false
+unsafe: false
+workers: 12

.github/workflows/linting.yml

@@ -3,16 +3,35 @@ name: Linting
 on:
  push:
  branches:
- - develop
- - main
- - 'release/rocm-rel*'
+  - develop
+  - main
+  - 'release/rocm-rel*'
  pull_request:
  branches:
- - develop
- - main
- - 'release/roc-rel*'
+  - develop
+  - main
+  - 'release/rocm-rel*'
 
 jobs:
  call-workflow-passing-data:
  name: Documentation
  uses: ROCm/rocm-docs-core/.github/workflows/linting.yml@develop
+
+ cmake-formatting:
+ name: CMake File Formatting
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Install dependencies
+ run: |
+ sudo apt-get update
+ sudo apt-get install -y python3-pip
+ python3 -m pip install gersemi
+ - name: Run gersemi
+ run: |
+ gersemi --check .
+ if [ $? -ne 0 ]; then
+ echo "CMake files are not formatted correctly. Please run gersemi ..."
+ echo "For example: \`gersemi -i .\`"
+ exit 1
+ fi

Applications/bitonic_sort/CMakeLists.txt

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2023-2024 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,7 +30,9 @@ set(GPU_RUNTIMES "HIP" "CUDA")
 set_property(CACHE GPU_RUNTIME PROPERTY STRINGS ${GPU_RUNTIMES})
 
 if(NOT "${GPU_RUNTIME}" IN_LIST GPU_RUNTIMES)
- set(ERROR_MESSAGE "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA.")
+ set(ERROR_MESSAGE
+ "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA."
+ )
  message(FATAL_ERROR ${ERROR_MESSAGE})
 endif()
 
@@ -40,9 +42,17 @@ set(CMAKE_${GPU_RUNTIME}_EXTENSIONS OFF)
 set(CMAKE_${GPU_RUNTIME}_STANDARD_REQUIRED ON)
 
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 list(APPEND CMAKE_PREFIX_PATH "${ROCM_ROOT}")

Applications/convolution/CMakeLists.txt

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2023-2024 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,7 +30,9 @@ set(GPU_RUNTIMES "HIP" "CUDA")
 set_property(CACHE GPU_RUNTIME PROPERTY STRINGS ${GPU_RUNTIMES})
 
 if(NOT "${GPU_RUNTIME}" IN_LIST GPU_RUNTIMES)
- set(ERROR_MESSAGE "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA.")
+ set(ERROR_MESSAGE
+ "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA."
+ )
  message(FATAL_ERROR ${ERROR_MESSAGE})
 endif()
 
@@ -40,9 +42,17 @@ set(CMAKE_${GPU_RUNTIME}_EXTENSIONS OFF)
 set(CMAKE_${GPU_RUNTIME}_STANDARD_REQUIRED ON)
 
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 list(APPEND CMAKE_PREFIX_PATH "${ROCM_ROOT}")

Applications/floyd_warshall/CMakeLists.txt

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2022-2023 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2022-2024 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,7 +30,9 @@ set(GPU_RUNTIMES "HIP" "CUDA")
 set_property(CACHE GPU_RUNTIME PROPERTY STRINGS ${GPU_RUNTIMES})
 
 if(NOT "${GPU_RUNTIME}" IN_LIST GPU_RUNTIMES)
- set(ERROR_MESSAGE "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA.")
+ set(ERROR_MESSAGE
+ "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA."
+ )
  message(FATAL_ERROR ${ERROR_MESSAGE})
 endif()
 
@@ -40,9 +42,17 @@ set(CMAKE_${GPU_RUNTIME}_EXTENSIONS OFF)
 set(CMAKE_${GPU_RUNTIME}_STANDARD_REQUIRED ON)
 
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 list(APPEND CMAKE_PREFIX_PATH "${ROCM_ROOT}")

Applications/histogram/CMakeLists.txt

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2023-2024 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,7 +30,9 @@ set(GPU_RUNTIMES "HIP" "CUDA")
 set_property(CACHE GPU_RUNTIME PROPERTY STRINGS ${GPU_RUNTIMES})
 
 if(NOT "${GPU_RUNTIME}" IN_LIST GPU_RUNTIMES)
- set(ERROR_MESSAGE "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA.")
+ set(ERROR_MESSAGE
+ "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA."
+ )
  message(FATAL_ERROR ${ERROR_MESSAGE})
 endif()
 
@@ -40,9 +42,17 @@ set(CMAKE_${GPU_RUNTIME}_EXTENSIONS OFF)
 set(CMAKE_${GPU_RUNTIME}_STANDARD_REQUIRED ON)
 
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 list(APPEND CMAKE_PREFIX_PATH "${ROCM_ROOT}")

Applications/monte_carlo_pi/CMakeLists.txt

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2023-2024 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,7 +30,10 @@ set(GPU_RUNTIMES "HIP" "CUDA")
 set_property(CACHE GPU_RUNTIME PROPERTY STRINGS ${GPU_RUNTIMES})
 
 if(NOT "${GPU_RUNTIME}" IN_LIST GPU_RUNTIMES)
- message(FATAL_ERROR "Only the following values are accepted for GPU_RUNTIME: ${GPU_RUNTIMES}")
+ message(
+ FATAL_ERROR
+ "Only the following values are accepted for GPU_RUNTIME: ${GPU_RUNTIMES}"
+ )
 endif()
 
 enable_language(${GPU_RUNTIME})
@@ -39,9 +42,17 @@ set(CMAKE_${GPU_RUNTIME}_EXTENSIONS OFF)
 set(CMAKE_${GPU_RUNTIME}_STANDARD_REQUIRED ON)
 
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 list(APPEND CMAKE_PREFIX_PATH "${ROCM_ROOT}")

Applications/prefix_sum/CMakeLists.txt

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2023-2024 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -30,7 +30,9 @@ set(GPU_RUNTIMES "HIP" "CUDA")
 set_property(CACHE GPU_RUNTIME PROPERTY STRINGS ${GPU_RUNTIMES})
 
 if(NOT "${GPU_RUNTIME}" IN_LIST GPU_RUNTIMES)
- set(ERROR_MESSAGE "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA.")
+ set(ERROR_MESSAGE
+ "GPU_RUNTIME is set to \"${GPU_RUNTIME}\".\nGPU_RUNTIME must be either HIP or CUDA."
+ )
  message(FATAL_ERROR ${ERROR_MESSAGE})
 endif()
 
@@ -40,9 +42,17 @@ set(CMAKE_${GPU_RUNTIME}_EXTENSIONS OFF)
 set(CMAKE_${GPU_RUNTIME}_STANDARD_REQUIRED ON)
 
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 list(APPEND CMAKE_PREFIX_PATH "${ROCM_ROOT}")

HIP-Basic/CMakeLists.txt

@@ -25,49 +25,64 @@ project(HIP-Basic LANGUAGES CXX)
 
 # ROCm installation path
 if(WIN32)
- set(ROCM_ROOT "$ENV{HIP_PATH}" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "$ENV{HIP_PATH}"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 else()
- set(ROCM_ROOT "/opt/rocm" CACHE PATH "Root directory of the ROCm installation")
+ set(ROCM_ROOT
+ "/opt/rocm"
+ CACHE PATH
+ "Root directory of the ROCm installation"
+ )
 endif()
 
 # Only supported on HIP (not CUDA)
 if(NOT "${GPU_RUNTIME}" STREQUAL "CUDA")
-
  # Make sure the dependencies can be found before building.
  find_program(
- LLVM_DIS_COMMAND llvm-dis
+ LLVM_DIS_COMMAND
+ llvm-dis
  PATH_SUFFIXES bin
- PATHS
- ${ROCM_ROOT}/llvm
- ${CMAKE_INSTALL_PREFIX}/llvm)
+ PATHS ${ROCM_ROOT}/llvm ${CMAKE_INSTALL_PREFIX}/llvm
+ )
  find_program(
- OFFLOAD_BUNDLER_COMMAND clang-offload-bundler
+ OFFLOAD_BUNDLER_COMMAND
+ clang-offload-bundler
  PATH_SUFFIXES bin
- PATHS
- ${ROCM_ROOT}/llvm
- ${CMAKE_INSTALL_PREFIX}/llvm)
+ PATHS ${ROCM_ROOT}/llvm ${CMAKE_INSTALL_PREFIX}/llvm
+ )
  find_program(
- LLVM_MC_COMMAND llvm-mc
+ LLVM_MC_COMMAND
+ llvm-mc
  PATH_SUFFIXES bin
- PATHS
- ${ROCM_ROOT}/llvm
- ${CMAKE_INSTALL_PREFIX}/llvm)
+ PATHS ${ROCM_ROOT}/llvm ${CMAKE_INSTALL_PREFIX}/llvm
+ )
 
  if(LLVM_DIS_COMMAND AND OFFLOAD_BUNDLER_COMMAND AND LLVM_MC_COMMAND)
- add_subdirectory(llvm_ir_to_executable)
- else() 
- message("'llvm-dis', 'llvm-mc', or 'clang-offload-bundler' not found, not building assembly example.")
+ add_subdirectory(llvm_ir_to_executable)
+ else()
+ message(
+ "'llvm-dis', 'llvm-mc', or 'clang-offload-bundler' not found, not building assembly example."
+ )
  if(NOT WIN32)
- message(" These tools can be found in the 'rocm-llvm-dev' package.")
+ message(
+ " These tools can be found in the 'rocm-llvm-dev' package."
+ )
  endif()
  endif()
 
  if(OFFLOAD_BUNDLER_COMMAND AND LLVM_MC_COMMAND)
  add_subdirectory(assembly_to_executable)
  else()
- message("'llvm-mc' or 'clang-offload-bundler' not found, not building LLVM IR example.")
+ message(
+ "'llvm-mc' or 'clang-offload-bundler' not found, not building LLVM IR example."
+ )
  if(NOT WIN32)
- message(" These tools can be found in the 'rocm-llvm-dev' package.")
+ message(
+ " These tools can be found in the 'rocm-llvm-dev' package."
+ )
  endif()
  endif()