|
| 1 | +# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 | +# All rights reserved. |
| 3 | +# |
| 4 | +# This source code is licensed under the BSD-style license found in the |
| 5 | +# LICENSE file in the root directory of this source tree. |
| 6 | + |
| 7 | +# ### Editing this file ### |
| 8 | +# |
| 9 | +# This file should be formatted with |
| 10 | +# ~~~ |
| 11 | +# cmake-format -i CMakeLists.txt |
| 12 | +# ~~~ |
| 13 | +# It should also be cmake-lint clean. |
| 14 | +# |
| 15 | +# The targets in this file will be built if EXECUTORCH_BUILD_VULKAN is ON |
| 16 | + |
| 17 | +cmake_minimum_required(VERSION 3.19) |
| 18 | +project(executorch) |
| 19 | + |
| 20 | +find_package(executorch CONFIG REQUIRED COMPONENTS vulkan_backend) |
| 21 | +find_package(GTest CONFIG REQUIRED) |
| 22 | + |
| 23 | +if(NOT EXECUTORCH_ROOT) |
| 24 | + set(EXECUTORCH_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/../../../..) |
| 25 | +endif() |
| 26 | + |
| 27 | +# Include this file to access target_link_options_shared_lib This is required to |
| 28 | +# provide access to target_link_options_shared_lib which allows libraries to be |
| 29 | +# linked with the --whole-archive flag. This is required for libraries that |
| 30 | +# perform dynamic registration via static initialization. |
| 31 | +include(${EXECUTORCH_ROOT}/tools/cmake/Utils.cmake) |
| 32 | + |
| 33 | +get_torch_base_path(TORCH_BASE_PATH) |
| 34 | +message(STATUS "torch base path: ${TORCH_BASE_PATH}") |
| 35 | + |
| 36 | +# Only build tests if Vulkan was compiled |
| 37 | +find_library(LIB_VULKAN_BACKEND vulkan_backend) |
| 38 | +find_library(LIB_TORCH torch ${TORCH_BASE_PATH}/lib) |
| 39 | +find_library(LIB_TORCH_CPU torch_cpu ${TORCH_BASE_PATH}/lib) |
| 40 | +find_library(LIB_C10 c10 ${TORCH_BASE_PATH}/lib) |
| 41 | + |
| 42 | +message(STATUS "Vulkan backend lib ${LIB_VULKAN_BACKEND}") |
| 43 | +message(STATUS "Torch ${LIB_TORCH}") |
| 44 | + |
| 45 | +if(NOT PYTHON_EXECUTABLE) |
| 46 | + set(PYTHON_EXECUTABLE python3) |
| 47 | +endif() |
| 48 | + |
| 49 | +# Third party include paths |
| 50 | + |
| 51 | +set(VULKAN_THIRD_PARTY_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../third-party) |
| 52 | + |
| 53 | +set(GTEST_INCLUDE_PATH |
| 54 | + ${EXECUTORCH_ROOT}/third-party/googletest/googletest/include |
| 55 | +) |
| 56 | +set(VULKAN_HEADERS_PATH ${VULKAN_THIRD_PARTY_PATH}/Vulkan-Headers/include) |
| 57 | +set(VOLK_PATH ${VULKAN_THIRD_PARTY_PATH}/volk) |
| 58 | +set(VMA_PATH ${VULKAN_THIRD_PARTY_PATH}/VulkanMemoryAllocator) |
| 59 | + |
| 60 | +set(COMMON_INCLUDES |
| 61 | + ${EXECUTORCH_ROOT}/.. |
| 62 | + ${VULKAN_HEADERS_PATH} |
| 63 | + ${VOLK_PATH} |
| 64 | + ${VMA_PATH} |
| 65 | + ${GTEST_INCLUDE_PATH} |
| 66 | + ${TORCH_BASE_PATH}/include |
| 67 | + ${TORCH_BASE_PATH}/include/torch/csrc/api/include |
| 68 | +) |
| 69 | + |
| 70 | +target_link_options_shared_lib(vulkan_backend) |
| 71 | + |
| 72 | +function(vulkan_op_test test_name test_src) |
| 73 | + set(extra_deps ${ARGN}) |
| 74 | + |
| 75 | + add_executable(${test_name} ${test_src}) |
| 76 | + target_include_directories(${test_name} PRIVATE ${COMMON_INCLUDES}) |
| 77 | + target_link_libraries( |
| 78 | + ${test_name} |
| 79 | + PRIVATE GTest::gtest_main |
| 80 | + vulkan_backend |
| 81 | + executorch |
| 82 | + ${LIB_TORCH} |
| 83 | + ${LIB_TORCH_CPU} |
| 84 | + ${LIB_C10} |
| 85 | + ${extra_deps} |
| 86 | + ) |
| 87 | + |
| 88 | + add_test(${test_name} ${test_name}) |
| 89 | +endfunction() |
| 90 | + |
| 91 | +if(LIB_VULKAN_BACKEND AND LIB_TORCH) |
| 92 | + find_library( |
| 93 | + CUSTOM_OPS_LIB custom_ops_aot_lib |
| 94 | + HINTS ${CMAKE_INSTALL_PREFIX}/executorch/extension/llm/custom_ops |
| 95 | + ) |
| 96 | + if(CUSTOM_OPS_LIB) |
| 97 | + vulkan_op_test( |
| 98 | + vulkan_sdpa_test ${CMAKE_CURRENT_SOURCE_DIR}/sdpa_test.cpp |
| 99 | + ${CUSTOM_OPS_LIB} |
| 100 | + ) |
| 101 | + else() |
| 102 | + message( |
| 103 | + STATUS "Skip building sdpa_test because custom_ops_aot_lib is not found" |
| 104 | + ) |
| 105 | + endif() |
| 106 | + vulkan_op_test( |
| 107 | + vulkan_rope_test ${CMAKE_CURRENT_SOURCE_DIR}/rotary_embedding_test.cpp |
| 108 | + ) |
| 109 | + vulkan_op_test( |
| 110 | + vulkan_linear_weight_int4_test |
| 111 | + ${CMAKE_CURRENT_SOURCE_DIR}/linear_weight_int4_test.cpp |
| 112 | + ) |
| 113 | + |
| 114 | + # Only build generated op tests if a path to tags.yaml and |
| 115 | + # native_functions.yaml is provided. These files are required for codegen. |
| 116 | + if(TORCH_OPS_YAML_PATH) |
| 117 | + set(GENERATED_VULKAN_TESTS_CPP_PATH ${CMAKE_CURRENT_BINARY_DIR}/vk_gen_cpp) |
| 118 | + |
| 119 | + # Generated operator correctness tests |
| 120 | + |
| 121 | + set(generated_test_cpp ${GENERATED_VULKAN_TESTS_CPP_PATH}/op_tests.cpp) |
| 122 | + |
| 123 | + add_custom_command( |
| 124 | + COMMENT "Generating Vulkan operator correctness tests" |
| 125 | + OUTPUT ${generated_test_cpp} |
| 126 | + COMMAND |
| 127 | + ${PYTHON_EXECUTABLE} |
| 128 | + ${EXECUTORCH_ROOT}/backends/vulkan/test/op_tests/generate_op_correctness_tests.py |
| 129 | + -o ${GENERATED_VULKAN_TESTS_CPP_PATH} --tags-path |
| 130 | + ${TORCH_OPS_YAML_PATH}/tags.yaml --aten-yaml-path |
| 131 | + ${TORCH_OPS_YAML_PATH}/native_functions.yaml |
| 132 | + DEPENDS ${EXECUTORCH_ROOT}/backends/vulkan/test/op_tests/**/*.py |
| 133 | + ) |
| 134 | + |
| 135 | + vulkan_op_test(vulkan_op_correctness_tests ${generated_test_cpp}) |
| 136 | + |
| 137 | + # Generated operator benchmarks (only built in google benchmark is |
| 138 | + # installed) |
| 139 | + find_package(benchmark CONFIG) |
| 140 | + |
| 141 | + if(benchmark_FOUND) |
| 142 | + set(generated_benchmark_cpp |
| 143 | + ${GENERATED_VULKAN_TESTS_CPP_PATH}/op_benchmarks.cpp |
| 144 | + ) |
| 145 | + |
| 146 | + add_custom_command( |
| 147 | + COMMENT "Generating Vulkan operator benchmarks" |
| 148 | + OUTPUT ${generated_benchmark_cpp} |
| 149 | + COMMAND |
| 150 | + ${PYTHON_EXECUTABLE} |
| 151 | + ${EXECUTORCH_ROOT}/backends/vulkan/test/op_tests/generate_op_benchmarks.py |
| 152 | + -o ${GENERATED_VULKAN_TESTS_CPP_PATH} --tags-path |
| 153 | + ${TORCH_OPS_YAML_PATH}/tags.yaml --aten-yaml-path |
| 154 | + ${TORCH_OPS_YAML_PATH}/native_functions.yaml |
| 155 | + DEPENDS ${EXECUTORCH_ROOT}/backends/vulkan/test/op_tests/**/*.py |
| 156 | + ) |
| 157 | + |
| 158 | + vulkan_op_test(vulkan_op_benchmarks ${generated_benchmark_cpp}) |
| 159 | + endif() |
| 160 | + else() |
| 161 | + message( |
| 162 | + STATUS |
| 163 | + "Skipping generated operator correctness tests and benchmarks. Please specify TORCH_OPS_YAML_PATH to build these tests." |
| 164 | + ) |
| 165 | + endif() |
| 166 | +endif() |
0 commit comments