[ENHANCE] Update Project Structure and CMake

jamesnulliu · jamesnulliu · commit 5ad8466b6e34 · 2025-02-25T06:16:20.000Z
diff --git a/.gitignore b/.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
diff --git a/README.md b/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):
diff --git a/csrc/CMakeLists.txt b/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)
 
diff --git a/csrc/cmake/cmake-parameters.md b/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; Controls the output color.
+  See: [CMakelists.txt](../CMakeLists.txt); [cmake/compilers/cxx-compiler-configs.cmake](../cmake/compilers/cxx-compiler-configs.cmake); [cmake/utils/logging.cmake](../cmake/utils/logging.cmake).  
+  Default: `OFF`.  
+  Possible values: `ON`, `OFF`.
diff --git a/csrc/cmake/compilers/cuda-compiler-configs.cmake b/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.
 # ==================================================================================================
diff --git a/csrc/cmake/compilers/cxx-compiler-configs.cmake b/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()
diff --git a/csrc/cmake/libraries/libcuda.cmake b/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)
diff --git a/csrc/cmake/libraries/libpython.cmake b/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 
diff --git a/csrc/cmake/libraries/libspdlog.cmake b/csrc/cmake/libraries/libspdlog.cmake
diff --git a/csrc/cmake/libraries/libtorch.cmake b/csrc/cmake/libraries/libtorch.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}")
diff --git a/csrc/cmake/utils/common.cmake b/csrc/cmake/utils/common.cmake
@@ -2,7 +2,7 @@ include(${CMAKE_CURRENT_LIST_DIR}/logging.cmake)
 
 # @func  set_default_values(<var1> <value1> <var2> <value2> ...)
 # @brief Set default values for variables;
-# The variable will not be overwrite if it already has a value.
+# @note  The variable will not be overwritten if it is already defined.
 function(set_default_values)
     math(EXPR ARG_COUNT "${ARGC} % 2")
 
diff --git a/csrc/cmake/utils/logging.cmake b/csrc/cmake/utils/logging.cmake
@@ -3,25 +3,38 @@
 # @brief Compiler configurations for cuda.
 #
 # @note This file shoule NEVER include any other file (to avoid circular dependencies).
+#
+# @note Values MUST be set BEFORE including this file:
+#         - `STDOUT_IS_TERMINAL`: Whether stdout is a terminal.
 # ==================================================================================================
 
-string(ASCII 27 Esc)
-
-set(LOG_RED "${Esc}[0;31m")
-set(LOG_GREEN "${Esc}[0;32m")
-set(LOG_YELLOW "${Esc}[0;33m")
-set(LOG_BLUE "${Esc}[0;34m")
-set(LOG_PURPLE "${Esc}[0;35m")
-set(LOG_CYAN "${Esc}[0;36m")
-set(LOG_WHITE "${Esc}[0;37m")
-set(LOG_RESET "${Esc}[m")
+if(STDOUT_IS_TERMINAL)
+    string(ASCII 27 Esc)
+    set(LOG_RED "${Esc}[0;31m")
+    set(LOG_GREEN "${Esc}[0;32m")
+    set(LOG_YELLOW "${Esc}[0;33m")
+    set(LOG_BLUE "${Esc}[0;34m")
+    set(LOG_PURPLE "${Esc}[0;35m")
+    set(LOG_CYAN "${Esc}[0;36m")
+    set(LOG_WHITE "${Esc}[0;37m")
+    set(LOG_RESET "${Esc}[m")
+else()
+    set(LOG_RED "")
+    set(LOG_GREEN "")
+    set(LOG_YELLOW "")
+    set(LOG_BLUE "")
+    set(LOG_PURPLE "")
+    set(LOG_CYAN "")
+    set(LOG_WHITE "")
+    set(LOG_RESET "")
+endif()
 
 if(NOT DEFINED LOG_PREFIX)
-    set(LOG_PREFIX "${LOG_PURPLE}pmpp${LOG_RESET}")
+    set(LOG_PREFIX "pmpp")
 endif()
 
 function(log_info msg)
-    message(STATUS "[${LOG_PREFIX}|${LOG_GREEN}INFO${LOG_RESET}] >>> ${msg}")
+    message(STATUS "[${LOG_PURPLE}${LOG_PREFIX}${LOG_RESET}|${LOG_GREEN}INFO${LOG_RESET}] >>> ${msg}")
 endfunction()
 
 function(log_warning msg)
diff --git a/csrc/cmake/vcpkg-triplets/x64-linux.cmake b/csrc/cmake/vcpkg-triplets/x64-linux.cmake
@@ -4,11 +4,15 @@ set(VCPKG_LIBRARY_LINKAGE static)
 
 set(VCPKG_CMAKE_SYSTEM_NAME Linux)
 
-execute_process(
-    COMMAND python -c "import torch; print(torch.__version__.split('+')[0])"
-    OUTPUT_VARIABLE TORCH_VERSION
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-)
+if(NOT DEFINED ENV{TORCH_VERSION})
+    execute_process(
+        COMMAND python -c "import torch; print(torch.__version__.split('+')[0])"
+        OUTPUT_VARIABLE TORCH_VERSION
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+    )
+else()
+    set(TORCH_VERSION $ENV{TORCH_VERSION})
+endif()
 
 # Convert version string to comparable number
 string(REPLACE "." ";" VERSION_LIST ${TORCH_VERSION})
diff --git a/pmpp/__init__.py b/pmpp/__init__.py
diff --git a/pmpp/models/__init__.py b/pmpp/models/__init__.py
diff --git a/pmpp/models/attention.py b/pmpp/models/attention.py
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -4,6 +4,7 @@ set -e  # Exit on error
 
 export CC=gcc
 export CXX=g++
+export TORCH_VERSION=2.6.0
 
 SOURCE_DIR=./csrc
 BUILD_DIR=./build
@@ -13,6 +14,14 @@ CUDA_STANDARD=20
 BUILD_SHARED_LIBS=OFF
 VCPKG_HOME=$VCPKG_HOME
 
+if [ -t 1 ]; then
+    STDOUT_IS_TERMINAL=ON
+    export GTEST_COLOR=yes
+else
+    STDOUT_IS_TERMINAL=OFF
+    export GTEST_COLOR=no
+fi
+
 while [[ $# -gt 0 ]]; do
     case $1 in
         -S|--source-dir)
@@ -41,11 +50,11 @@ done
 
 cmake -S $SOURCE_DIR -B $BUILD_DIR -G Ninja \
     -DCMAKE_TOOLCHAIN_FILE="$VCPKG_HOME/scripts/buildsystems/vcpkg.cmake" \
+    -DVCPKG_TARGET_TRIPLET="x64-linux" \
+    -DVCPKG_OVERLAY_TRIPLETS="csrc/cmake/vcpkg-triplets" \
+    -DSTDOUT_IS_TERMINAL=$STDOUT_IS_TERMINAL \
     -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
     -DCMAKE_CXX_STANDARD=$CXX_STANDARD \
-    -DCMAKE_CUDA_STANDARD=$CUDA_STANDARD  \
-    -DVCPKG_TARGET_TRIPLET="x64-linux" \
-    -DVCPKG_OVERLAY_TRIPLETS="csrc/cmake/vcpkg-triplets"
+    -DCMAKE_CUDA_STANDARD=$CUDA_STANDARD 
 
-GTEST_COLOR=yes \
 cmake --build $BUILD_DIR --parallel 12 --target all check
diff --git a/setup.py b/setup.py
@@ -1,7 +1,6 @@
 from pathlib import Path
 import shutil
 import sys
-from os import path as osp
 import subprocess
 from setuptools import find_namespace_packages, setup, Extension, find_packages
 from setuptools.command.build_ext import build_ext
@@ -17,7 +16,7 @@
 # Path to the c/c++ source directory:
 CSRC_DIR = Path(SETUP_DIR, "csrc")
 # Where to install the op library:
-TORCH_OPS_DIR = Path(SETUP_DIR, "src", PKG_NAME, "_torch_ops")
+TORCH_OPS_DIR = Path(SETUP_DIR, PKG_NAME, "_torch_ops")
 
 
 class CMakeExtension(Extension):
@@ -103,7 +102,7 @@ def run(self):
         "build_py": BuildPy,
         "bdist_wheel": BDistWheel,
     },
-    packages=find_namespace_packages(where="./src"),
-    package_dir={"pmpp": "./src/pmpp"},
+    packages=find_namespace_packages(where="."),
+    package_dir={"pmpp": "./pmpp"},
     package_data={"pmpp": ["_torch_ops/lib/*.so", "_torch_ops/lib/*.dll"]},
 )

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`# @file compiler-configs-cuda.cmake`
`3`	`3`	`# @brief Compiler configurations for cuda.`
`4`	`4`	`#`
`5`		`-# @note Several parameters SHOULD be set BEFORE including this file:`
	`5`	`+# @note Values SHOULD be set BEFORE including this file:`
`6`	`6`	# - `ENV{NVCC_CCBIN}`: CUDA Compiler bindir. Default: auto-detected.
`7`	`7`	# - `CMAKE_CUDA_STANDARD`: CUDA Standard. Default: 20.
`8`	`8`	`# ==================================================================================================`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# @see "https://cmake.org/cmake/help/latest/module/FindPython.html"`
	`1`	`+# [SEE] "https://cmake.org/cmake/help/latest/module/FindPython.html"`
`2`	`2`	`find_package(`
`3`	`3`	`Python`
`4`	`4`	`REQUIRED`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@ list(APPEND CMAKE_PREFIX_PATH ${PYTORCH_CMAKE_PREFIX_PATH})`
`12`	`12`
`13`	`13`	`find_package(Torch REQUIRED)`
`14`	`14`
`15`		`-set(CMAKE_CUDA_FLAGS_DEBUG "${CMAKE_CUDA_FLAGS_DEBUG} -DTORCH_USE_CUDA_DSA=1")`
	`15`	`+set(CMAKE_CUDA_FLAGS_DEBUG "${CMAKE_CUDA_FLAGS_DEBUG}")`