-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Hexagon] Do not auto-build apps when building TVM (#9970)
* [Hexagon] Do not auto-build apps when building TVM
The Hexagon cmakes have recently become unwieldy due to a complex
network of dependencies between various automatically built components.
This was in large part because of trying to automatically build some
apps, which then tried to build TVM runtimes again, but with their
own configurations.
This patch removes the ability to automatically build any Hexagon-
-related apps from the main TVM build. The following cmake options
are now deprecated:
- `USE_HEXAGON_LAUNCHER`
- `USE_HEXAGON_PROXY_RPC`
In order to build the binaries needed for HexagonLauncher from
tvm.contrib.hexagon:
- Build TVM+runtime for x86, with codegen for Hexagon enabled.
This can be done via `USE_HEXAGON_DEVICE=sim` or `target`.
- Build Android runtime and tvm_rpc with `-DUSE_RPC=ON`,
`-DUSE_CPP_RPC=ON`, and `-DUSE_HEXAGON_RPC=ON`.
- Build Hexagon runtime with `-DUSE_HEXAGON_RPC=ON`, and
`-DBUILD_STATIC_RUNTIME=ON`.
* Add README.md
* Restart CI
* Add optional variable to set output directory- Loading branch information
Krzysztof Parzyszek
authored
Jan 24, 2022
1 parent
6f2b35f
commit 73bbfbb
Showing
6 changed files
with
232 additions
and
442 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| cmake_minimum_required(VERSION 3.2) | ||
|
|
||
| project(hexagon_api) | ||
|
|
||
| include(ExternalProject) | ||
|
|
||
| # Required variables: | ||
| # ANDROID_ABI | ||
| # ANDROID_PLATFORM | ||
| # USE_ANDROID_TOOLCHAIN (Android toolchain .cmake file) | ||
| # USE_HEXAGON_ARCH | ||
| # USE_HEXAGON_SDK | ||
| # USE_HEXAGON_TOOLCHAIN (Path to Hexagon toolchain ending with "Tools") | ||
| # Optional variable: | ||
| # USE_OUTPUT_BINARY_DIR (Path to copy the output binaries to) | ||
|
|
||
| set(TVM_SOURCE_DIR "${CMAKE_SOURCE_DIR}/../..") | ||
|
|
||
| if(DEFINED USE_OUTPUT_BINARY_DIR) | ||
| set(HEXAGON_API_BINARY_DIR "${USE_OUTPUT_BINARY_DIR}") | ||
| else() | ||
| set(HEXAGON_API_BINARY_DIR "${CMAKE_BINARY_DIR}/hexagon_rpc") | ||
| endif() | ||
| file(MAKE_DIRECTORY ${HEXAGON_API_BINARY_DIR}) | ||
|
|
||
| # Build Android binaries: | ||
| # - libtvm_runtime.so | ||
| # - tvm_rpc_android | ||
|
|
||
| ExternalProject_Add(android_tvm_runtime_rpc | ||
| SOURCE_DIR "${TVM_SOURCE_DIR}" | ||
| BUILD_COMMAND $(MAKE) runtime tvm_rpc | ||
| CMAKE_ARGS | ||
| "-DCMAKE_TOOLCHAIN_FILE=${USE_ANDROID_TOOLCHAIN}" | ||
| "-DANDROID_PLATFORM=${ANDROID_PLATFORM}" | ||
| "-DANDROID_ABI=${ANDROID_ABI}" | ||
| "-DUSE_HEXAGON_SDK=${USE_HEXAGON_SDK}" | ||
| "-DUSE_HEXAGON_ARCH=${USE_HEXAGON_ARCH}" | ||
| "-DCMAKE_CXX_STANDARD=14" | ||
| "-DUSE_LIBBACKTRACE=OFF" | ||
| "-DUSE_LLVM=OFF" | ||
| "-DUSE_RPC=ON" | ||
| "-DUSE_CPP_RPC=ON" | ||
| "-DUSE_HEXAGON_RPC=ON" | ||
| INSTALL_COMMAND "" | ||
| BUILD_ALWAYS ON | ||
| ) | ||
| ExternalProject_Get_Property(android_tvm_runtime_rpc BINARY_DIR) | ||
| ExternalProject_Add_Step(android_tvm_runtime_rpc copy_runtime | ||
| COMMAND ${CMAKE_COMMAND} -E copy_if_different | ||
| ${BINARY_DIR}/libtvm_runtime.so | ||
| ${HEXAGON_API_BINARY_DIR} | ||
| DEPENDEES install | ||
| ) | ||
| ExternalProject_Add_Step(android_tvm_runtime_rpc copy_rpc_server | ||
| COMMAND ${CMAKE_COMMAND} -E copy_if_different | ||
| ${BINARY_DIR}/tvm_rpc | ||
| ${HEXAGON_API_BINARY_DIR}/tvm_rpc_android | ||
| DEPENDEES install | ||
| ) | ||
|
|
||
|
|
||
| # Build Hexagon binaries: | ||
| # - libhexagon_rpc_skel.so | ||
| # - libtvm_runtime.a | ||
|
|
||
| ExternalProject_Add(hexagon_tvm_runtime_rpc | ||
| SOURCE_DIR "${TVM_SOURCE_DIR}" | ||
| BUILD_COMMAND $(MAKE) runtime | ||
| CMAKE_ARGS | ||
| "-DCMAKE_C_COMPILER=${USE_HEXAGON_TOOLCHAIN}/bin/hexagon-clang" | ||
| "-DCMAKE_CXX_COMPILER=${USE_HEXAGON_TOOLCHAIN}/bin/hexagon-clang++" | ||
| "-DUSE_HEXAGON_SDK=${USE_HEXAGON_SDK}" | ||
| "-DUSE_HEXAGON_ARCH=${USE_HEXAGON_ARCH}" | ||
| "-DUSE_LIBBACKTRACE=OFF" | ||
| "-DUSE_RPC=OFF" | ||
| "-DUSE_HEXAGON_RPC=ON" | ||
| "-DBUILD_STATIC_RUNTIME=ON" | ||
| INSTALL_COMMAND "" | ||
| BUILD_ALWAYS ON | ||
| ) | ||
| ExternalProject_Get_Property(hexagon_tvm_runtime_rpc BINARY_DIR) | ||
| ExternalProject_Add_Step(hexagon_tvm_runtime_rpc copy_binaries | ||
| COMMAND ${CMAKE_COMMAND} -E copy_if_different | ||
| ${BINARY_DIR}/libtvm_runtime.a | ||
| ${BINARY_DIR}/libhexagon_rpc_skel.so | ||
| ${HEXAGON_API_BINARY_DIR} | ||
| DEPENDEES install | ||
| ) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| <!--- Licensed to the Apache Software Foundation (ASF) under one --> | ||
| <!--- or more contributor license agreements. See the NOTICE file --> | ||
| <!--- distributed with this work for additional information --> | ||
| <!--- regarding copyright ownership. The ASF licenses this file --> | ||
| <!--- to you under the Apache License, Version 2.0 (the --> | ||
| <!--- "License"); you may not use this file except in compliance --> | ||
| <!--- with the License. You may obtain a copy of the License at --> | ||
|
|
||
| <!--- http://www.apache.org/licenses/LICENSE-2.0 --> | ||
|
|
||
| <!--- Unless required by applicable law or agreed to in writing, --> | ||
| <!--- software distributed under the License is distributed on an --> | ||
| <!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY --> | ||
| <!--- KIND, either express or implied. See the License for the --> | ||
| <!--- specific language governing permissions and limitations --> | ||
| <!--- under the License. --> | ||
|
|
||
| # Hexagon API app | ||
|
|
||
| This is a meta-app that build the necessary binaries for use with | ||
| the `HexagonLauncher` utility from `tvm.contrib.hexagon`. | ||
|
|
||
| It will build the TVM runtime for Android, the RPC server application | ||
| for Android, and the RPC library for Hexagon with the TVM runtime for | ||
| Hexagon built into it. | ||
|
|
||
| ## Configuration | ||
|
|
||
| There is a set of configuration variables that are required for cmake: | ||
| - `ANDROID_ABI`: Set this to `arm64-v8a`. | ||
| - `ANDROID_PLATFORM`: This can be `android-28`. | ||
| - `USE_ANDROID_TOOLCHAIN`: The path to the Android toolchain file, i.e. | ||
| `android.toolchain.cmake`. This file is a part of the Android NDK. | ||
| - `USE_HEXAGON_ARCH`: The version string of the Hexagon architecture | ||
| to use, i.e. vNN. The typical setting would be `v68` or later. | ||
| - `USE_HEXAGON_SDK`: The path to the Hexagon SDK. Set this path in such | ||
| a way that `${USE_HEXAGON_SDK}/setup_sdk_env.source` exists. | ||
| - `USE_HEXAGON_TOOLCHAIN`: Path to Hexagon toolchain. It can be the | ||
| Hexagon toolchain included in the SDK, for example | ||
| `${USE_HEXAGON_TOOLCHAIN}/tools/HEXAGON_Tools/x.y.z/Tools`. The `x.y.z` | ||
| in the path is the toolchain version number, which is specific to the | ||
| version of the SDK. | ||
|
|
||
| Additionally, the variable `USE_OUTPUT_BINARY_DIR` can be set to indicate | ||
| the location where the generated binaries will be placed. If not set, it | ||
| defaults to `hexagon_rpc` subdirectory in the current build directory. | ||
|
|
||
|
|
||
| ## Build | ||
|
|
||
| The build will generate the following binaries: | ||
| - `tvm_runtime.so`: TVM runtime for Android (shared library). | ||
| - `tvm_rpc_android`: RPC server for Android. | ||
| - `libhexagon_rpc_skel.so`: RPC library for Hexagon. | ||
| - `libtvm_runtime.a`: TVM runtime for Hexagon (static library). | ||
|
|
||
| The RPC library for Hexagon contains the TVM runtime, so the static | ||
| TVM runtime for Hexagon is not strictly necessary. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.