Refactorized for Metal framework impl

CMakeLists.txt

@@ -6,10 +6,37 @@ set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_BUILD_TYPE RelWithDebInfo)
 
-set(TI_WITH_VULKAN ON) # Vulkan is always on.
+# Entry points.
+option(TI_AOT_DEMO_WITH_HEADLESS "Generate HEADLESS entry point" OFF)
+option(TI_AOT_DEMO_WITH_GLFW "Generate GLFW windowed entry point" OFF)
+option(TI_AOT_DEMO_WITH_ANDROID_APP "Generate Android APP entry point" OFF)
+option(TI_AOT_DEMO_WITH_COCOA_APP "Generate Cocoa APP entry point" OFF)
+
+# Rendering framework.
+option(TI_FRAMEWORK_BACKEND "Rendering framework to use (`vulkan` or `metal`, case sensitive)" "vulkan")
+
+# Taichi runtime backends.
+option(TI_WITH_VULKAN "Compile with VULKAN backend" OFF)
 option(TI_WITH_CPU "Compile with CPU backend" OFF)
 option(TI_WITH_CUDA "Compile with CUDA backend" OFF)
 option(TI_WITH_OPENGL "Compile with OPENGL backend" OFF)
+option(TI_WITH_METAL "Compile with METAL backend" OFF)
+
+if(TI_FRAMEWORK_BACKEND STREQUAL "vulkan")
+    if(NOT TI_WITH_VULKAN)
+        set(TI_WITH_VULKAN ON)
+        message("-- Forced TI_WITH_VULKAN=ON because TI_FRAMEWORK_BACKEND=vulkan")
+    endif()
+    set(TI_FRAMEWORK_BACKEND_VULKAN ON)
+endif()
+
+if(TI_FRAMEWORK_BACKEND STREQUAL "metal")
+    if(NOT TI_WITH_METAL)
+        set(TI_WITH_METAL ON)
+        message("-- Forced TI_WITH_METAL=ON because TI_FRAMEWORK_BACKEND=metal")
+    endif()
+    set(TI_FRAMEWORK_BACKEND_METAL ON)
+endif()
 
 # 1. Configure Environments and Third-party Libraries
 include("cmake/env.cmake")
@@ -41,6 +68,7 @@ set(HEADLESS_DEMO_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/headless)
 set(GLFW_DEMO_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/glfw)
 set(ANDROID_APP_DEMO_OUTPUT_DIRECTORY
     ${CMAKE_SOURCE_DIR}/framework/android/app/src/main/jniLibs/arm64-v8a)
+set(COCOA_APP_DEMO_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/cocoa)
 
 add_subdirectory(1_hello_world)
 add_subdirectory(1_hello_world_with_interop)
@@ -52,6 +80,15 @@ add_subdirectory(6_taichi_sparse)
 add_subdirectory(7_comet)
 
 # 5. Install runtime libraries
-install_shared_libraries(${GLFW_DEMO_OUTPUT_DIRECTORY})
-install_shared_libraries(${HEADLESS_DEMO_OUTPUT_DIRECTORY})
-install_shared_libraries(${ANDROID_APP_DEMO_OUTPUT_DIRECTORY})
+if(TI_AOT_DEMO_WITH_HEADLESS)
+    install_shared_libraries(${HEADLESS_DEMO_OUTPUT_DIRECTORY})
+endif()
+if(TI_AOT_DEMO_WITH_GLFW)
+    install_shared_libraries(${GLFW_DEMO_OUTPUT_DIRECTORY})
+endif()
+if(TI_AOT_DEMO_WITH_ANDROID_APP)
+    install_shared_libraries(${ANDROID_APP_DEMO_OUTPUT_DIRECTORY})
+endif()
+if(TI_AOT_DEMO_WITH_COCOA_APP)
+    install_shared_libraries(${COCOA_APP_DEMO_OUTPUT_DIRECTORY})
+endif()

ci/test_config.json

@@ -1,7 +1,12 @@
 {
 
 "github": {
-    "cmake_args" : ["-DTI_WITH_CPU=ON"],
+    "cmake_args" : [
+        "-DTI_FRAMEWORK_BACKEND=vulkan",
+        "-DTI_AOT_DEMO_WITH_HEADLESS=ON",
+        "-DTI_WITH_VULKAN=ON",
+        "-DTI_WITH_CPU=ON"
+    ],
     "tests": [
         ["tutorial/E0_tutorial_cgraph",                   "",              ""],
         ["tutorial/E0_tutorial_kernel",                   "",              ""],
@@ -18,7 +23,13 @@
 },
 
 "linux": {
-    "cmake_args" : ["-DTI_WITH_CUDA=ON", "-DTI_WITH_CPU=ON"],
+    "cmake_args" : [
+        "-DTI_FRAMEWORK_BACKEND=vulkan",
+        "-DTI_AOT_DEMO_WITH_HEADLESS=ON",
+        "-DTI_WITH_VULKAN=ON",
+        "-DTI_WITH_CUDA=ON",
+        "-DTI_WITH_CPU=ON"
+    ],
     "tests": [
         ["tutorial/E0_tutorial_cgraph",                   "",              ""],
         ["tutorial/E0_tutorial_kernel",                   "",              ""],
@@ -42,7 +53,11 @@
 },
 
 "android": {
-    "cmake_args" : [],
+    "cmake_args" : [
+        "-DTI_FRAMEWORK_BACKEND=vulkan",
+        "-DTI_AOT_DEMO_WITH_HEADLESS=ON",
+        "-DTI_WITH_VULKAN=ON"
+    ],
     "tests": [
         ["tutorial/E0_tutorial_cgraph",                   "",              ""],
         ["tutorial/E0_tutorial_kernel",                   "",              ""],

cmake/demo.cmake

@@ -16,20 +16,19 @@ endfunction()
 
 # Internal
 function(add_headless_demo NAME DEMO_PATH TAICHI_AOT_DEMO_TARGET)
-    set(ENTRY_PATH ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/entry_points/headless.cpp)
+    set(ENTRY_PATH ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/${TI_FRAMEWORK_BACKEND}/entry_points/headless.cpp)
     add_entrance(${ENTRY_PATH} ${DEMO_PATH} ${HEADLESS_DEMO_OUTPUT_DIRECTORY} ${TAICHI_AOT_DEMO_TARGET})
 endfunction()
 
 
 # Internal
 function(add_glfw_demo NAME DEMO_PATH TAICHI_AOT_DEMO_TARGET)
-    set(ENTRY_PATH ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/entry_points/glfw.cpp)
+    set(ENTRY_PATH ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/${TI_FRAMEWORK_BACKEND}/entry_points/glfw.cpp)
     add_entrance(${ENTRY_PATH} ${DEMO_PATH} ${GLFW_DEMO_OUTPUT_DIRECTORY} ${TAICHI_AOT_DEMO_TARGET})
 
     target_link_libraries(${TAICHI_AOT_DEMO_TARGET} PUBLIC glfw)
     target_include_directories(${TAICHI_AOT_DEMO_TARGET} PUBLIC
         ${PROJECT_SOURCE_DIR}/external/glfw/include)
-    target_compile_definitions(${TAICHI_AOT_DEMO_TARGET} PUBLIC TI_AOT_DEMO_WITH_GLFW=1)
 endfunction()
 
 #Internal
@@ -40,8 +39,8 @@ function(add_android_app_demo NAME DEMO_PATH TAICHI_AOT_DEMO_TARGET)
     # In CMake we only do the first step. See `build-android-apps` for the
     # second.
     set(ENTRY_PATH
-        ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/entry_points/android.cpp
-        ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/entry_points/android_impl.c)
+        ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/${TI_FRAMEWORK_BACKEND}/entry_points/android.cpp
+        ${PROJECT_SOURCE_DIR}/framework/src/taichi/aot_demo/${TI_FRAMEWORK_BACKEND}/entry_points/android_impl.c)
     add_library(${TAICHI_AOT_DEMO_TARGET} SHARED ${ENTRY_PATH} ${DEMO_PATH})
 
     set_target_properties(${TAICHI_AOT_DEMO_TARGET} PROPERTIES
@@ -50,7 +49,6 @@ function(add_android_app_demo NAME DEMO_PATH TAICHI_AOT_DEMO_TARGET)
     target_link_libraries(${TAICHI_AOT_DEMO_TARGET} PUBLIC android log ${RENDER_FRAMEWORK_TARGET})
     target_include_directories(${TAICHI_AOT_DEMO_TARGET} PUBLIC
         ${ANDROID_NDK}/sources/android/native_app_glue)
-    target_compile_definitions(${TAICHI_AOT_DEMO_TARGET} PUBLIC TI_AOT_DEMO_WITH_ANDROID_APP=1)
 endfunction()
 
 
@@ -59,30 +57,36 @@ function(add_demo NAME DEMO_PATH)
     set(GLFW_AOT_DEMO_TARGET E${NAME}_glfw)
     set(ANDROID_APP_AOT_DEMO_TARGET E${NAME}_android)
 
-    add_headless_demo(${NAME} ${DEMO_PATH} ${HEADLESS_AOT_DEMO_TARGET})
-    if(NOT ANDROID)
+    if(TI_AOT_DEMO_WITH_HEADLESS)
+        add_headless_demo(${NAME} ${DEMO_PATH} ${HEADLESS_AOT_DEMO_TARGET})
+    endif()
+    if(TI_AOT_DEMO_WITH_GLFW)
         add_glfw_demo(${NAME} ${DEMO_PATH} ${GLFW_AOT_DEMO_TARGET})
     endif()
-    if (ANDROID)
+    if(TI_AOT_DEMO_WITH_ANDROID_APP)
         add_android_app_demo(${NAME} ${DEMO_PATH} ${ANDROID_APP_AOT_DEMO_TARGET})
     endif()
 endfunction()
 
 
 function(generate_aot_files NAME PYTHON_SCRIPT_PATH ARCH)
-    if(NOT TI_WITH_CUDA AND ARCH STREQUAL "cuda")
+    if(NOT TI_WITH_VULKAN AND ARCH MATCHES "vulkan")
+        return()
+    endif()
+
+    if(NOT TI_WITH_CUDA AND ARCH MATCHES "cuda")
         return()
     endif()
 
-    if(NOT TI_WITH_CPU AND ARCH STREQUAL "x64")
+    if(NOT TI_WITH_CPU AND ARCH MATCHES "x64")
         return()
     endif()
 
-    if(NOT TI_WITH_OPENGL AND ARCH STREQUAL "opengl")
+    if(NOT TI_WITH_OPENGL AND ARCH MATCHES "opengl")
         return()
     endif()
 
-    if (NOT ANDROID AND ARCH MATCHES "android")
+    if(NOT TI_AOT_DEMO_WITH_ANDROID_APP AND ARCH MATCHES "android")
         return()
     endif()
 
@@ -97,17 +101,19 @@ function(generate_aot_files NAME PYTHON_SCRIPT_PATH ARCH)
             VERBATIM)
     endif()
 
-    # Copy binary assets to android asset directory.
-    set(DUMMY_TARGET2 ${NAME}_${ARCH}_DUMMY_TARGET2)
-    add_custom_target(${DUMMY_TARGET2} ALL)
-    if(ANDROID)
-        add_custom_command(
-            TARGET ${DUMMY_TARGET2}
-            DEPENDS ${DUMMY_TARGET}
-            COMMAND ${CMAKE_COMMAND}
-            ARGS -E copy_directory
-                ${CMAKE_CURRENT_SOURCE_DIR}/assets
-                ${PROJECT_SOURCE_DIR}/framework/android/app/src/main/assets/${NAME}/assets
-            VERBATIM)
+    if(TI_AOT_DEMO_WITH_ANDROID_APP)
+        # Copy binary assets to android asset directory.
+        set(DUMMY_TARGET2 ${NAME}_${ARCH}_DUMMY_TARGET2)
+        add_custom_target(${DUMMY_TARGET2} ALL)
+        if(ANDROID)
+            add_custom_command(
+                TARGET ${DUMMY_TARGET2}
+                DEPENDS ${DUMMY_TARGET}
+                COMMAND ${CMAKE_COMMAND}
+                ARGS -E copy_directory
+                    ${CMAKE_CURRENT_SOURCE_DIR}/assets
+                    ${PROJECT_SOURCE_DIR}/framework/android/app/src/main/assets/${NAME}/assets
+                VERBATIM)
+        endif()
     endif()
 endfunction()

cmake/env.cmake

@@ -13,11 +13,24 @@ function(configure_environment)
 endfunction()
 
 function(configure_third_party)
-    add_subdirectory(external)
+    add_library(GraphiT STATIC
+        ${PROJECT_SOURCE_DIR}/external/graphi-t/include/gft/args.hpp
+        ${PROJECT_SOURCE_DIR}/external/graphi-t/include/gft/util.hpp
+        ${PROJECT_SOURCE_DIR}/external/graphi-t/src/gft/args.cpp
+        ${PROJECT_SOURCE_DIR}/external/graphi-t/src/gft/util.cpp)
+    target_include_directories(GraphiT PUBLIC
+        ${PROJECT_SOURCE_DIR}/external/graphi-t/include)
+
+    find_package(Taichi REQUIRED)
+
+    # Request third-party libraries to build static libs only.
+    set(BUILD_TESTING OFF)
+    set(BUILD_STATIC_LIBS ON)
+    add_subdirectory(${PROJECT_SOURCE_DIR}/external/glm glm)
 
     # Compile for Backward-cpp
-    if(NOT ANDROID)
-        add_subdirectory("${CMAKE_SOURCE_DIR}/external/backward-cpp")
+    if(NOT ANDROID AND NOT IOS)
+        add_subdirectory(${PROJECT_SOURCE_DIR}/external/backward-cpp)
     endif()
 endfunction()
 

external/CMakeLists.txt

@@ -1,9 +1 @@
-if (NOT ANDROID)
-    add_subdirectory(glfw)
-endif()
-add_subdirectory(VulkanMemoryAllocator)
-add_subdirectory(glslang)
 
-set(BUILD_TESTING OFF)
-set(BUILD_STATIC_LIBS ON)
-add_subdirectory(glm)