[ENHANCE] Update Project Structure and CMake

Author: root

.gitignore

@@ -10,13 +10,9 @@ __pycache__/
 .Python
 build/
 develop-eggs/
-dist/
 downloads/
 eggs/
 .eggs/
-/lib/
-lib64/
-parts/
 sdist/
 var/
 wheels/
@@ -162,6 +158,6 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
-/src/pmpp/_torch_ops
+/pmpp/_torch_ops
 vcpkg_installed
 /tmp

README.md

@@ -65,6 +65,9 @@ To build the C++ part only:
 bash scripts/build.sh
 ```
 
+> 📝**NOTE**  
+> See "[cmake-parameters.md](csrc/cmake/cmake-parameters.md)" for details about setting up the build process.
+
 You will find "./build/lib/libPmppTorchOps.so" which is the operator library and "./build/test/pmpp_test" which is the test executable (with gtest).
 
 Execute the test executable to test the library manually:
@@ -77,11 +80,12 @@ Note that the test is already integrated into CMake build system (with ctest); I
 
 ```bash
 # $BUILD_DIR is "./build" by default
+# Set `GTEST_COLOR` to yes or no to enable or disable colored output
 
 # If the library has not been build, target `all` before `check` is required
-GTEST_COLOR=yes cmake --build $BUILD_DIR -j $(nproc) --target all check
+cmake --build $BUILD_DIR -j $(nproc) --target all check
 # Or if the library has been build, `check` is enough
-GTEST_COLOR=yes cmake --build $BUILD_DIR -j $(nproc) --target check
+cmake --build $BUILD_DIR -j $(nproc) --target check
 ```
 
 To build and install the python package `pmpp` in current activated conda environment (pmpp operator library would be built automatically if it has not been built yet):

csrc/CMakeLists.txt

@@ -5,14 +5,13 @@ cmake_minimum_required(VERSION 3.30)
 project(PMPP VERSION 1.0.0)
 
 # Common utility functions
-include(${PROJECT_SOURCE_DIR}/cmake/utils/logging.cmake)
 include(${PROJECT_SOURCE_DIR}/cmake/utils/common.cmake)
 
 log_info("CMake Tookchain File Path: ${CMAKE_TOOLCHAIN_FILE}")
 
 set_default_values(
     PROJECT_NAMESPACE "pmpp::"
-    FORCE_COLORED_OUTPUT ON
+    STDOUT_IS_TERMINAL OFF
 )
 
 # Utility functions for installing libraries:
@@ -35,13 +34,6 @@ find_package(yaml-cpp CONFIG REQUIRED)
 enable_testing()
 find_package(GTest CONFIG REQUIRED)
 
-if (${FORCE_COLORED_OUTPUT})
-    add_compile_options(
-        $<$<CXX_COMPILER_ID:GNU>:-fdiagnostics-color=always>
-        $<$<CXX_COMPILER_ID:Clang>:-fcolor-diagnostics>
-    )
-endif ()
-
 add_subdirectory(${PROJECT_SOURCE_DIR}/lib)
 add_subdirectory(${PROJECT_SOURCE_DIR}/test)
 

csrc/cmake/cmake-parameters.md

@@ -2,23 +2,23 @@
 
 ## Required Parameters
 
-- `[ENV]{CUDA_HOME}`/`[ENV]{CUDA_DIR}`: CUDA toolkit installation path.  
+- `CUDA_HOME`/`CUDA_DIR`/`ENV{CUDA_HOME}`/`ENV{CUDA_DIR}`: CUDA toolkit installation path.  
   See: [cmake/libraries/cuda.cmake](../cmake/libraries/libcuda.cmake).
 
 ## Optional Parameters
 
 - `CMAKE_CUDA_STANDARD`: CUDA standard.  
   See: [cmake/compilers/cuda-compiler-configs.cmake](../cmake/compilers/cuda-compiler-configs.cmake).  
   Default: *Auto-Detect*.  
-  Possible values: `14`, `17`, `20`, `23`.
+  Possible values: `20`, `23`.
 - `CMAKE_CXX_SCAN_FOR_MODULES`: Whether to use C++ modules.  
   See: [cmake/compilers/cxx-compiler-configs.cmake](../cmake/compilers/cxx-compiler-configs.cmake).  
   Default: `OFF`.  
   Possible values: `ON`, `OFF`.
 - `CMAKE_CXX_STANDARD`: C++ standard.  
   See: [cmake/compilers/cxx-compiler-configs.cmake](../cmake/compilers/cxx-compiler-configs.cmake).  
   Default: *Auto-Detect*.  
-  Possible values: `14`, `17`, `20`, `23`.
+  Possible values: `20`, `23`.
 - `CMAKE_EXECUTABLE_SUFFIX`: Executable suffix.  
   See: [CMakelists.txt](../CMakeLists.txt).  
   Default: `.exe`.
@@ -38,4 +38,8 @@
   Default: `pmpp`;
 - `STACK_SIZE`: Stack size for the executable targets (if any).  
   See: [cmake/compilers/cxx-compiler-configs.cmake](../cmake/compilers/cxx-compiler-configs.cmake).  
-  Default: `1048576` (Bytes).
+  Default: `1048576` (Bytes).
+- `STDOUT_IS_TERMINAL`: Whether the standard output is a terminal.  
+  See: [CMakelists.txt](../CMakeLists.txt).  
+  Default: `OFF`.  
+  Possible values: `ON`, `OFF`.

csrc/cmake/compilers/cuda-compiler-configs.cmake

@@ -2,7 +2,7 @@
 # @file compiler-configs-cuda.cmake
 # @brief Compiler configurations for cuda.
 #
-# @note Several parameters SHOULD be set BEFORE including this file:
+# @note Values SHOULD be set BEFORE including this file:
 #         - `ENV{NVCC_CCBIN}`: CUDA Compiler bindir. Default: auto-detected.
 #         - `CMAKE_CUDA_STANDARD`: CUDA Standard. Default: 20.
 # ==================================================================================================

csrc/cmake/compilers/cxx-compiler-configs.cmake

@@ -2,7 +2,9 @@
 # @file compiler-configs-cpp.cmake
 # @brief Compiler configurations for the host.
 #
-# @note Several parameters SHOULD be set BEFORE including this file:
+# @note Values MUST be set BEFORE including this file:
+#         - `STDOUT_IS_TERMINAL`: Whether stdout is a terminal.
+#       Values SHOULD be set BEFORE including this file:
 #         - `ENV{CXX}`: C++ Compiler. Default: auto-detected.
 #         - `CMAKE_CXX_STANDARD`: C++ Standard. Default: 20.
 #         - `CMAKE_CXX_SCAN_FOR_MODULES`: Whether to use modules. Default: OFF.
@@ -12,18 +14,18 @@
 include(${PROJECT_SOURCE_DIR}/cmake/utils/common.cmake)
 
 enable_language(CXX)
-set_default_values(CMAKE_CXX_SCAN_FOR_MODULES OFF)
 
-# Generate compile_commands.json in build directory
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set_default_values(
+    CMAKE_EXPORT_COMPILE_COMMANDS ON
+    CMAKE_CXX_STANDARD            20
+    CMAKE_CXX_STANDARD_REQUIRED   ON
+    CMAKE_CXX_SCAN_FOR_MODULES    OFF
+    STACK_SIZE                    1048576
+)
 
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
 log_info("CMAKE_CXX_STANDARD: ${CMAKE_CXX_STANDARD}")
-
-# Set stack size
-if(NOT DEFINED STACK_SIZE)
-    set(STACK_SIZE 1048576)  # 1MB by default
-endif()
+log_info("CMAKE_CXX_SCAN_FOR_MODULES: ${CMAKE_CXX_SCAN_FOR_MODULES}")
+log_info("STACK_SIZE: ${STACK_SIZE}")
 
 # Compiler flags for MSVC
 if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
@@ -54,8 +56,16 @@ elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     else()
         string(APPEND CMAKE_EXE_LINKER_FLAGS " -Wl,-zstack-size=${STACK_SIZE}")
     endif()
-# @todo @jamesnulliu
-# |- Add compiler flags for other compilers
+# [TODO] @jamesnulliu
+#   Support more compilers
 else()
     log_fatal("Unsupported compiler")
+endif()
+
+if(STDOUT_IS_TERMINAL)
+    add_compile_options(
+        $<$<CXX_COMPILER_ID:GNU>:-fdiagnostics-color=always>
+        $<$<CXX_COMPILER_ID:Clang>:-fcolor-diagnostics>
+        $<$<CXX_COMPILER_ID:MSVC>:/FC>
+    )
 endif()

csrc/cmake/libraries/libcuda.cmake

@@ -2,8 +2,8 @@
 # @brief Enable CUDA support.
 # @see "https://cliutils.gitlab.io/modern-cmake/chapters/packages/CUDA.html"
 # 
-# @note Several parameters should be set before including this file:
-#       - [ENV]{CUDA_HOME}/[ENV]{CUDA_DIR}:
+# @note Values should be set before including this file:
+#       - CUDA_HOME/CUDA_DIR/ENV{CUDA_HOME}/ENV{CUDA_DIR}:
 #             Path to spdlog libaray installation path.
 # ==================================================================================================
 
@@ -19,7 +19,5 @@ set(CUDA_CMAKE_PREFIX_PATH "${CUDA_HOME}/lib64/cmake")
 list(APPEND CMAKE_PREFIX_PATH ${CUDA_CMAKE_PREFIX_PATH})
 
 # Find the CUDA package
-# @see 
-# |- All imported targets: 
-# |- "https://cmake.org/cmake/help/git-stage/module/FindCUDAToolkit.html#imported-targets"
+# [SEE] All imported targets: https://cmake.org/cmake/help/git-stage/module/FindCUDAToolkit.html#imported-targets
 find_package(CUDAToolkit REQUIRED)

csrc/cmake/libraries/libpython.cmake

@@ -1,4 +1,4 @@
-# @see "https://cmake.org/cmake/help/latest/module/FindPython.html"
+# [SEE] "https://cmake.org/cmake/help/latest/module/FindPython.html"
 find_package(
     Python 
     REQUIRED 

csrc/cmake/libraries/libspdlog.cmake

@@ -12,4 +12,4 @@ list(APPEND CMAKE_PREFIX_PATH ${PYTORCH_CMAKE_PREFIX_PATH})
 
 find_package(Torch REQUIRED)
 
-set(CMAKE_CUDA_FLAGS_DEBUG "${CMAKE_CUDA_FLAGS_DEBUG} -DTORCH_USE_CUDA_DSA=1")
+set(CMAKE_CUDA_FLAGS_DEBUG "${CMAKE_CUDA_FLAGS_DEBUG}")