Make: Formatting CMake

Author: ashvardanian

.cmake-format.py

@@ -0,0 +1,19 @@
+# -----------------------------
+# Options effecting formatting.
+# -----------------------------
+with section("format"):
+    # How wide to allow formatted cmake files
+    line_width = 120
+
+    # How many spaces to tab for indent
+    tab_size = 4
+
+    # If true, separate flow control names from their parentheses with a space
+    separate_ctrl_name_with_space = True
+
+    # If true, separate function names from parentheses with a space
+    separate_fn_name_with_space = False
+
+    # If a statement is wrapped to more than one line, than dangle the closing
+    # parenthesis on its own line.
+    dangle_parens = True

CMakeLists.txt

@@ -1,8 +1,10 @@
 # Let's use a recent CMake version:
-# 3.16+ for native sanitizers support
-# 3.17+ for `FindCUDAToolkit`
-# 3.18 for BLAS::BLAS target
-# 3.25.2 for CUDA20 support
+#
+# * 3.16+ for native sanitizers support
+# * 3.17+ for `FindCUDAToolkit`
+# * 3.18 for BLAS::BLAS target
+# * 3.25.2 for CUDA20 support
+#
 # The good news is that Ubuntu 24.04 comes with 3.28!
 cmake_minimum_required(VERSION 3.25.2 FATAL_ERROR)
 
@@ -14,7 +16,8 @@ project(
     VERSION 0.3.5
     LANGUAGES CXX
     DESCRIPTION "Parallel Reductions Benchmark for CPUs & GPUs"
-    HOMEPAGE_URL "https://github.com/ashvardanian/ParallelReductionsBenchmark")
+    HOMEPAGE_URL "https://github.com/ashvardanian/ParallelReductionsBenchmark"
+)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED YES)
@@ -30,9 +33,9 @@ message(STATUS "CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
 message(STATUS "----------------------------------------")
 
 # Default to Release if no build type is set:
-if(NOT CMAKE_BUILD_TYPE)
+if (NOT CMAKE_BUILD_TYPE)
     set(CMAKE_BUILD_TYPE Release)
-endif()
+endif ()
 
 # ------------------------------------------------------------------------------
 # Detect CUDA Support
@@ -41,13 +44,13 @@ set(ENABLE_CUDA OFF)
 include(CheckLanguage)
 check_language(CUDA)
 
-if(CMAKE_CUDA_COMPILER)
+if (CMAKE_CUDA_COMPILER)
     enable_language(CUDA)
     set(ENABLE_CUDA ON)
     message(STATUS "CUDA detected! Using compiler: ${CMAKE_CUDA_COMPILER}")
-else()
+else ()
     message(STATUS "CUDA not detected. Skipping CUDA-specific builds.")
-endif()
+endif ()
 
 # ------------------------------------------------------------------------------
 # Options
@@ -56,13 +59,13 @@ option(USE_INTEL_TBB "Use Intel TBB for parallel STL algorithms" ON)
 option(USE_NVIDIA_CCCL "Use Nvidia CCCL for CUDA acceleration" ON)
 
 # Enable or disable options based on system and CUDA support
-if(ENABLE_CUDA)
+if (ENABLE_CUDA)
     set(USE_NVIDIA_CCCL ON)
     set(USE_INTEL_TBB OFF) # Prioritize CUDA acceleration
-elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+elseif (CMAKE_SYSTEM_NAME STREQUAL "Linux")
     set(USE_NVIDIA_CCCL OFF) # Can't compile CCCL w/o CUDA
     set(USE_INTEL_TBB ON) # Default to TBB on Linux without CUDA
-endif()
+endif ()
 
 message(STATUS "USE_INTEL_TBB: ${USE_INTEL_TBB}")
 message(STATUS "USE_NVIDIA_CCCL: ${USE_NVIDIA_CCCL}")
@@ -101,43 +104,45 @@ set(BENCHMARK_ENABLE_GTEST_TESTS OFF)
 set(BENCHMARK_USE_BUNDLED_GTEST ON)
 FetchContent_MakeAvailable(benchmark)
 
-# Intel TBB for "Parallel STL" algorithms
-# https://github.com/oneapi-src/oneTBB/tree/onetbb_2021
-if(USE_INTEL_TBB)
+# Intel TBB for "Parallel STL" algorithms: https://github.com/oneapi-src/oneTBB/tree/onetbb_2021
+if (USE_INTEL_TBB)
     FetchContent_Declare(
         IntelTBB
         GIT_REPOSITORY https://github.com/uxlfoundation/oneTBB.git
         GIT_TAG master
     )
 
     # Suppress TBB's own tests:
-    set(TBB_TEST OFF CACHE BOOL "Do not build TBB tests" FORCE)
+    set(TBB_TEST
+        OFF
+        CACHE BOOL "Do not build TBB tests" FORCE
+    )
     FetchContent_MakeAvailable(IntelTBB)
 
     # ------------------------------------------------------------------------------
     # TBB fix for -Wstringop-overflow warnings treated as errors
     # ------------------------------------------------------------------------------
-    # The TBB library target is typically called "tbb". We can explicitly disable
-    # the `stringop-overflow` warning for TBB only:
-    if(TARGET tbb)
-        if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+    # The TBB library target is typically called "tbb". We can explicitly disable the `stringop-overflow` warning for
+    # TBB only:
+    if (TARGET tbb)
+        if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
             target_compile_options(tbb PRIVATE -Wno-stringop-overflow)
-        endif()
-    endif()
-endif()
+        endif ()
+    endif ()
+endif ()
 
 # Nvidia's CUDA Core Compute Libraries for GPU acceleration
-if(USE_NVIDIA_CCCL)
-    # CUB, Thrust, and other libraries of interest are now included into the
-    # CUDA Toolkit, so we don't need this anymore:
+if (USE_NVIDIA_CCCL)
+    # CUB, Thrust, and other libraries of interest are now included into the CUDA Toolkit, so we don't need this
+    # anymore:
     #
     # FetchContent_Declare(NvidiaCCCL GIT_REPOSITORY https://github.com/nvidia/cccl.git)
     # FetchContent_MakeAvailable(NvidiaCCCL)
     find_package(CUDAToolkit REQUIRED)
     message(STATUS "CUDA Toolkit Version: ${CUDAToolkit_VERSION}")
     message(STATUS "CUDA Toolkit Include Path: ${CUDAToolkit_INCLUDE_DIRS}")
     message(STATUS "CUDA Toolkit Libraries Path: ${CUDAToolkit_LIBRARY_DIR}")
-endif()
+endif ()
 
 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g")
 set(CMAKE_CUDA_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g")
@@ -149,54 +154,62 @@ set(CMAKE_GCC_FLAGS "${CMAKE_GCC_FLAGS} -march=native -fopenmp")
 add_executable(reduce_bench reduce_bench.cpp)
 target_link_libraries(reduce_bench PRIVATE benchmark::benchmark fmt::fmt Threads::Threads BLAS::BLAS)
 
-if(USE_INTEL_TBB)
+if (USE_INTEL_TBB)
     target_link_libraries(reduce_bench PRIVATE TBB::tbb)
-endif()
+endif ()
 
-if(USE_NVIDIA_CCCL)
+if (USE_NVIDIA_CCCL)
     target_link_libraries(reduce_bench PRIVATE CUDA::cudart CUDA::cublas)
-endif()
+endif ()
 
-if(OpenMP_FOUND)
+if (OpenMP_FOUND)
     target_link_libraries(reduce_bench PRIVATE OpenMP::OpenMP_CXX)
-endif()
+endif ()
 
-if(OpenCL_FOUND)
+if (OpenCL_FOUND)
     target_link_libraries(reduce_bench PRIVATE OpenCL::OpenCL)
-endif()
+endif ()
 
 # On Linux we use libnuma for NUMA support.
-if(UNIX AND NOT APPLE)
-    find_path(NUMA_INCLUDE_DIRS
+if (UNIX AND NOT APPLE)
+    find_path(
+        NUMA_INCLUDE_DIRS
         NAMES numa.h
         HINTS $ENV{HOME}/local/include /opt/local/include /usr/local/include /usr/include
     )
 
-    find_library(NUMA_LIBRARIES
+    find_library(
+        NUMA_LIBRARIES
         NAMES numa
-        HINTS $ENV{HOME}/local/lib64 $ENV{HOME}/local/lib /usr/local/lib64 /usr/local/lib /opt/local/lib64 /opt/local/lib /usr/lib64 /usr/lib
-        /usr/lib/x86_64-linux-gnu/
-        /usr/lib/aarch64-linux-gnu/
+        HINTS $ENV{HOME}/local/lib64
+              $ENV{HOME}/local/lib
+              /usr/local/lib64
+              /usr/local/lib
+              /opt/local/lib64
+              /opt/local/lib
+              /usr/lib64
+              /usr/lib
+              /usr/lib/x86_64-linux-gnu/
+              /usr/lib/aarch64-linux-gnu/
     )
 
     include(FindPackageHandleStandardArgs)
     find_package_handle_standard_args(NUMA DEFAULT_MSG NUMA_LIBRARIES NUMA_INCLUDE_DIRS)
 
-    if(NUMA_FOUND)
+    if (NUMA_FOUND)
         message(STATUS "Found NUMA: includes=${NUMA_INCLUDE_DIRS}, library=${NUMA_LIBRARIES}")
         target_include_directories(reduce_bench PRIVATE ${NUMA_INCLUDE_DIRS})
         target_link_libraries(reduce_bench PRIVATE ${NUMA_LIBRARIES})
-    else()
+    else ()
         message(WARNING "NUMA library not found.")
         message(WARNING "Please install it using your package manager:")
         message(WARNING "    Debian/Ubuntu: sudo apt-get install libnuma1 libnuma-dev")
         message(WARNING "    RHEL/CentOS: sudo yum install numactl numactl-devel")
-    endif()
-endif()
+    endif ()
+endif ()
 
-# List of all possible compiler IDs:
-# https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
-if(CMAKE_CUDA_COMPILER_ID STREQUAL "NVIDIA" OR CMAKE_CUDA_COMPILER_ID STREQUAL "NVHPC")
+# List of all possible compiler IDs: https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
+if (CMAKE_CUDA_COMPILER_ID STREQUAL "NVIDIA" OR CMAKE_CUDA_COMPILER_ID STREQUAL "NVHPC")
     enable_language(CUDA)
     message("-- Detected Nvidia Compiler")
     set_property(SOURCE reduce_bench.cpp PROPERTY LANGUAGE CUDA)
@@ -208,7 +221,7 @@ if(CMAKE_CUDA_COMPILER_ID STREQUAL "NVIDIA" OR CMAKE_CUDA_COMPILER_ID STREQUAL "
     set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} --expt-relaxed-constexpr --extended-lambda")
     set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -gencode arch=compute_86,code=sm_86")
 
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" AND 0)
+elseif (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" AND 0)
     set(METAL_SRC ${CMAKE_CURRENT_SOURCE_DIR}/reduce_metal.msl)
     set(METALLIB_OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/reduce_metal.metallib)
 
@@ -222,23 +235,13 @@ elseif(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" AND 0)
     )
 
     # Create a pseudo target to build the metallib
-    add_custom_target(MetalLibBuild ALL
-        DEPENDS ${METALLIB_OUTPUT}
-    )
+    add_custom_target(MetalLibBuild ALL DEPENDS ${METALLIB_OUTPUT})
 
     enable_language(OBJCXX)
     set_property(SOURCE reduce_metal.hpp PROPERTY LANGUAGE OBJCXX)
     set_property(SOURCE reduce_bench.cpp PROPERTY LANGUAGE OBJCXX)
-    target_link_libraries(reduce_bench
-        PRIVATE
-        "-framework Metal"
-        "-framework Foundation"
-    )
-    set_source_files_properties(
-        reduce_bench.cpp
-        PROPERTIES
-        COMPILE_FLAGS "-x objective-c++ -fobjc-arc"
-    )
+    target_link_libraries(reduce_bench PRIVATE "-framework Metal" "-framework Foundation")
+    set_source_files_properties(reduce_bench.cpp PROPERTIES COMPILE_FLAGS "-x objective-c++ -fobjc-arc")
 
     # Make sure reduce_bench depends on MetalLibBuild so the .metallib is built first
     add_dependencies(reduce_bench MetalLibBuild)
@@ -247,19 +250,17 @@ elseif(CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" AND 0)
     add_custom_command(
         TARGET reduce_bench
         POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E copy_if_different
-        ${METALLIB_OUTPUT}
-        $<TARGET_FILE_DIR:reduce_bench>
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different ${METALLIB_OUTPUT} $<TARGET_FILE_DIR:reduce_bench>
     )
 
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+elseif (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
     message("-- Detected Clang Compiler")
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
+elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     message("-- Detected GCC Compiler")
     set(CMAKE_CXX_FLAGS "${CMAKE_GCC_FLAGS}")
 
-elseif(CMAKE_CXX_COMPILER_ID STREQUAL "Intel" OR CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
+elseif (CMAKE_CXX_COMPILER_ID STREQUAL "Intel" OR CMAKE_CXX_COMPILER_ID STREQUAL "IntelLLVM")
     message("-- Detected Intel Compiler")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -w")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ferror-limit=1")
-endif()
+endif ()