oraluben commented on code in PR #300:
URL: https://github.com/apache/tvm-ffi/pull/300#discussion_r2629861930
##########
cmake/Utils/EmbedCubin.cmake:
##########
@@ -15,205 +15,163 @@
# specific language governing permissions and limitations
# under the License.
+# Do not let cmake to link cudart.
+set(CMAKE_CUDA_RUNTIME_LIBRARY None)
+
+# We need this to simulate `CUDA_{CUBIN,FATBIN}_COMPILATION` in
`add_tvm_ffi_{cubin,fatbin}`, to
+# copy `a.cu.o` to `a.cubin`/`a.fatbin`.
+set(COPY_SCRIPT "${CMAKE_BINARY_DIR}/cuda_copy_utils.cmake")
+file(
+ WRITE ${COPY_SCRIPT}
+ "
+# Arguments: OBJECTS (semicolon-separated list), OUT_DIR, EXT
+string(REPLACE \"\\\"\" \"\" ext_strip \"\${EXT}\")
+string(REPLACE \"\\\"\" \"\" out_dir_strip \"\${OUT_DIR}\")
+foreach(obj_raw \${OBJECTS})
+ string(REPLACE \"\\\"\" \"\" obj \"\${obj_raw}\")
+
+ # Extract filename: /path/to/kernel.cu.o -> kernel
+ # Note: CMake objects are usually named source.cu.o, so we strip extensions
twice.
+ get_filename_component(fname \${obj} NAME_WE)
+ get_filename_component(fname \${fname} NAME_WE)
+
+ # If OUT_DIR is provided, use it. Otherwise, use the object's directory.
+ if(NOT out_dir_strip STREQUAL \"\")
+ set(final_dir \"\${out_dir_strip}\")
+ else()
+ get_filename_component(final_dir \${obj} DIRECTORY)
+ endif()
+
+ message(\"Copying \${obj} -> \${final_dir}/\${fname}.\${ext_strip}\")
+ execute_process(
+ COMMAND \${CMAKE_COMMAND} -E copy_if_different
+ \"\${obj}\"
+ \"\${final_dir}/\${fname}.\${ext_strip}\"
+ )
+endforeach()
+"
+)
+
# ~~~
-# tvm_ffi_generate_cubin(
-# OUTPUT <output_cubin_file>
-# SOURCE <cuda_source_file>
-# [ARCH <architecture>]
-# [OPTIONS <extra_nvcc_options>...]
-# [DEPENDS <additional_dependencies>...]
-# )
+# add_tvm_ffi_cubin(<target_name> CUDA <source_file>)
#
-# Compiles a CUDA source file to CUBIN format using nvcc.
+# Creates an object library that compiles CUDA source to CUBIN format.
+# This function uses CMake's native CUDA support and respects
CMAKE_CUDA_ARCHITECTURES.
+# This is a compatibility util for cmake < 3.27, user can create
+# cmake target with `CUDA_CUBIN_COMPILATION` for cmake >= 3.27.
#
# Parameters:
-# OUTPUT: Path to the output CUBIN file (e.g., kernel.cubin)
-# SOURCE: Path to the CUDA source file (e.g., kernel.cu)
-# ARCH: Target GPU architecture (default: native for auto-detection)
-# Examples: sm_75, sm_80, sm_86, compute_80, native
-# OPTIONS: Additional nvcc compiler options (e.g., -O3, --use_fast_math)
-# DEPENDS: Optional additional dependencies
-#
-# The function will:
-# 1. Find the CUDA compiler (nvcc)
-# 2. Compile the SOURCE to CUBIN with specified architecture and options
-# 3. Create the output CUBIN file
+# target_name: Name of the object library target
+# CUDA: One CUDA source file
#
# Example:
-# tvm_ffi_generate_cubin(
-# OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/kernel.cubin
-# SOURCE src/kernel.cu
-# ARCH native
-# OPTIONS -O3 --use_fast_math
-# )
+# add_tvm_ffi_cubin(my_kernel_cubin CUDA kernel.cu)
# ~~~
-
-# cmake-lint: disable=C0111,C0103
-function (tvm_ffi_generate_cubin)
- # Parse arguments
- set(options "")
- set(oneValueArgs OUTPUT SOURCE ARCH)
- set(multiValueArgs OPTIONS DEPENDS)
- cmake_parse_arguments(ARG "${options}" "${oneValueArgs}" "${multiValueArgs}"
${ARGN})
-
- # Validate required arguments
- if (NOT ARG_OUTPUT)
- message(FATAL_ERROR "tvm_ffi_generate_cubin: OUTPUT is required")
- endif ()
- if (NOT ARG_SOURCE)
- message(FATAL_ERROR "tvm_ffi_generate_cubin: SOURCE is required")
+function (add_tvm_ffi_cubin target_name)
+ cmake_parse_arguments(ARG "" "CUDA" "" ${ARGN})
+ if (NOT ARG_CUDA)
+ message(FATAL_ERROR "add_tvm_ffi_cubin: CUDA source is required")
endif ()
- # Default architecture to native if not specified
- if (NOT ARG_ARCH)
- set(ARG_ARCH "native")
- endif ()
+ add_library(${target_name} OBJECT ${ARG_CUDA})
+ target_compile_options(${target_name} PRIVATE
$<$<COMPILE_LANGUAGE:CUDA>:--cubin>)
- # Ensure CUDA compiler is available
- if (NOT CMAKE_CUDA_COMPILER)
- message(
- FATAL_ERROR
- "tvm_ffi_generate_cubin: CMAKE_CUDA_COMPILER not found. Enable CUDA
language in project()."
- )
+ add_custom_target(
+ ${target_name}_bin ALL
+ COMMAND ${CMAKE_COMMAND} -DOBJECTS="$<TARGET_OBJECTS:${target_name}>"
-DOUT_DIR="" -DEXT="cubin"
+ -P "${COPY_SCRIPT}"
+ DEPENDS ${target_name}
+ COMMENT "Generating .cubin files for ${target_name}"
+ VERBATIM
+ )
+endfunction ()
+
+# ~~~
+# add_tvm_ffi_fatbin(<target_name> CUDA <source_file>)
+#
+# Creates an object library that compiles CUDA source to FATBIN format.
+# This function uses CMake's native CUDA support and respects
CMAKE_CUDA_ARCHITECTURES.
+# This is a compatibility util for cmake < 3.27, user can create
+# cmake target with `CUDA_FATBIN_COMPILATION` for cmake >= 3.27.
+#
+# Parameters:
+# target_name: Name of the object library target
+# CUDA: One CUDA source file
+#
+# Example:
+# add_tvm_ffi_fatbin(my_kernel_cubin CUDA kernel.cu)
+# ~~~
+function (add_tvm_ffi_fatbin target_name)
+ cmake_parse_arguments(ARG "" "CUDA" "" ${ARGN})
+ if (NOT ARG_CUDA)
+ message(FATAL_ERROR "add_tvm_ffi_fatbin: CUDA source is required")
endif ()
- # Get absolute paths
- get_filename_component(ARG_SOURCE_ABS "${ARG_SOURCE}" ABSOLUTE)
- get_filename_component(ARG_OUTPUT_ABS "${ARG_OUTPUT}" ABSOLUTE)
+ add_library(${target_name} OBJECT ${ARG_CUDA})
+ target_compile_options(${target_name} PRIVATE
$<$<COMPILE_LANGUAGE:CUDA>:--fatbin>)
- # Build nvcc command
- add_custom_command(
- OUTPUT "${ARG_OUTPUT_ABS}"
- COMMAND ${CMAKE_CUDA_COMPILER} --cubin -arch=${ARG_ARCH} ${ARG_OPTIONS}
"${ARG_SOURCE_ABS}" -o
- "${ARG_OUTPUT_ABS}"
- DEPENDS "${ARG_SOURCE_ABS}" ${ARG_DEPENDS}
- COMMENT "Compiling ${ARG_SOURCE} to CUBIN (arch: ${ARG_ARCH})"
+ add_custom_target(
+ ${target_name}_bin ALL
+ COMMAND ${CMAKE_COMMAND} -DOBJECTS="$<TARGET_OBJECTS:${target_name}>"
-DOUT_DIR=""
+ -DEXT="fatbin" -P "${COPY_SCRIPT}"
+ DEPENDS ${target_name}
+ COMMENT "Generating .fatbin files for ${target_name}"
VERBATIM
)
endfunction ()
# ~~~
-# tvm_ffi_embed_cubin(
-# OUTPUT <output_object_file>
-# SOURCE <source_file>
-# CUBIN <cubin_file>
-# NAME <symbol_name>
-# [DEPENDS <additional_dependencies>...]
-# )
+# tvm_ffi_embed_bin_into(<target_name> <library_name>
+# BIN <cubin_or_fatbin>
+# INTERMEDIATE_FILE <intermediate_path>)
#
-# Compiles a C++ source file and embeds a CUBIN file into it, creating a
-# combined object file that can be linked into a shared library or executable.
+# Embed one cubin/fatbin into given target with specified library name,
+# can be loaded with `TVM_FFI_EMBED_CUBIN(library_name)`.
+# Can only have one object in target and one cubin/fatbin.
#
-# Parameters:
-# OUTPUT: Path to the output object file (e.g., lib_embedded_with_cubin.o)
-# SOURCE: Path to the C++ source file that uses TVM_FFI_EMBED_CUBIN macro
-# CUBIN: Path to the CUBIN file to embed (can be a file path or a custom
target output)
-# NAME: Name used in the TVM_FFI_EMBED_CUBIN macro (e.g., "env" for
TVM_FFI_EMBED_CUBIN(env))
-# DEPENDS: Optional additional dependencies (e.g., custom targets)
+# The reason of this design is to integrate with cmake's workflow.
#
-# The function will:
-# 1. Compile the SOURCE file to an intermediate object file
-# 2. Use the tvm_ffi.utils.embed_cubin Python utility to merge the object
file
-# with the CUBIN data
-# 3. Create symbols: __tvm_ffi__cubin_<NAME> and __tvm_ffi__cubin_<NAME>_end
+# Parameters:
+# target_name: Name of the object library target
+# library_name: Name of the kernel library
+# BIN: CUBIN or FATBIN file
+# INTERMEDIATE_FILE: Optional, location to copy original object file to.
Review Comment:
`tvm_ffi_embed_bin_into` injects into the building workflow of target
`<target_name>`, overwrites the original object file before linking.
`INTERMEDIATE_FILE` is the location where original object file would be copy
to. I hope this could help users who want to access the original file.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
