[Rearrange source folders] (#94)

- move qnn_executor_runner to examples/backend/qualcomm
- move qualcomm/runtime/wrappers to qualcomm/aot/wrappers
- move qualcomm/runtime/python to qualcomm/aot/python
- change file structure in README accordingly

Author: Hsu, Hao-Wei (Ian)

CMakeLists.txt

@@ -303,6 +303,7 @@ endif()
 option(EXECUTORCH_BUILD_QNN "Build the backends/qualcomm directory" OFF)
 if(EXECUTORCH_BUILD_QNN)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/qualcomm)
+  add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/examples/backend/qualcomm)
 endif()
 
 # Add selective build subdirectory

backends/qualcomm/CMakeLists.txt

@@ -15,7 +15,7 @@ get_filename_component(EXECUTORCH_SOURCE_DIR
                        "${CMAKE_CURRENT_LIST_DIR}/../.."
                        ABSOLUTE)
 get_filename_component(QNN_EXECUTORCH_ROOT_DIR
-                       ${CMAKE_CURRENT_LIST_DIR}/runtime
+                       ${CMAKE_CURRENT_LIST_DIR}
                        ABSOLUTE)
 # Let files say "include <executorch/path/to/header.h>".
 get_filename_component(_common_include_directories
@@ -25,13 +25,16 @@ get_filename_component(_common_include_directories
 if(NOT DEFINED QNN_SDK_ROOT)
     message(FATAL_ERROR
             "Please define QNN_SDK_ROOT, e.g. cmake <..> -DQNN_SDK_ROOT=<...>")
+elseif(CMAKE_TOOLCHAIN_FILE MATCHES ".*ios\.toolchain\.cmake$")
+    message(FATAL_ERROR
+            "ios is not supported by Qualcomm AI Engine Direct")
 endif()
 
 message(STATUS "Using qnn sdk root ${QNN_SDK_ROOT}")
 message(STATUS "Using EXECUTORCH_SOURCE_DIR ${EXECUTORCH_SOURCE_DIR}")
 
 if(${ANDROID})
-  find_library(android_log log)
+    find_library(android_log log)
 endif()
 
 add_compile_options("-Wall" "-Werror" "-Wno-sign-compare")
@@ -56,12 +59,12 @@ endif()
 
 
 include_directories(
-  BEFORE
-  ${_common_include_directories}
+    BEFORE
+    ${_common_include_directories}
 )
 include_directories(
-  BEFORE
-  ${QNN_SDK_ROOT}/include/QNN
+    BEFORE
+    ${QNN_SDK_ROOT}/include/QNN
 )
 
 #
@@ -179,77 +182,52 @@ target_link_options_shared_lib(qnn_executorch_backend)
 # add sources
 #
 add_subdirectory(
-    ${QNN_EXECUTORCH_ROOT_DIR}
+    ${QNN_EXECUTORCH_ROOT_DIR}/runtime
     ${CMAKE_CURRENT_BINARY_DIR}/qnn_executorch
 )
 add_subdirectory(
-    ${QNN_EXECUTORCH_ROOT_DIR}/backends
+    ${QNN_EXECUTORCH_ROOT_DIR}/runtime/backends
     ${CMAKE_CURRENT_BINARY_DIR}/qnn_executorch/backends
 )
 add_subdirectory(
-    ${QNN_EXECUTORCH_ROOT_DIR}/wrappers
+    ${QNN_EXECUTORCH_ROOT_DIR}/aot/wrappers
     ${CMAKE_CURRENT_BINARY_DIR}/qnn_executorch/wrappers
 )
 
 # QNN pybind
 if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64")
-  add_subdirectory(${EXECUTORCH_SOURCE_DIR}/third-party/pybind11
-                   ${CMAKE_CURRENT_BINARY_DIR}/pybind11)
-  add_library(PyQnnManagerAdaptor MODULE)
-  add_library(PyQnnWrapperAdaptor MODULE)
-
-  target_link_libraries(PyQnnManagerAdaptor
-      PRIVATE
-      pybind11::module
-      pybind11::lto
-      qnn_manager
-      qnn_executorch_header
-      executorch
-  )
-  target_link_libraries(PyQnnWrapperAdaptor
-      PRIVATE
-      pybind11::module
-      pybind11::lto
-      wrappers
-      qnn_logging
-      qnn_executorch_header
-  )
-
-  pybind11_extension(PyQnnManagerAdaptor)
-  pybind11_extension(PyQnnWrapperAdaptor)
-  if(NOT MSVC AND NOT ${CMAKE_BUILD_TYPE} MATCHES Debug|RelWithDebInfo)
-      # Strip unnecessary sections of the binary
-      pybind11_strip(PyQnnManagerAdaptor)
-      pybind11_strip(PyQnnWrapperAdaptor)
-  endif()
-
-  add_subdirectory(
-  ${QNN_EXECUTORCH_ROOT_DIR}/python
-  ${CMAKE_CURRENT_BINARY_DIR}/qnn_executorch/python
-  )
-endif()
-
-# ios can only build library but not binary
-# though Qualcomm doesn't support ios :)
-if(NOT CMAKE_TOOLCHAIN_FILE MATCHES ".*ios\.toolchain\.cmake$")
-  #
-  # qnn_executor_runner: Like executor_runner but with QNN, the binary will
-  # be at ${CMAKE_BINARY_DIR}/backends/qualcomm
-  #
-  set(_qnn_executor_runner__srcs ${_executor_runner__srcs})
-  list(TRANSFORM _qnn_executor_runner__srcs PREPEND "${EXECUTORCH_SOURCE_DIR}/")
-  list(FILTER _qnn_executor_runner__srcs EXCLUDE REGEX ".*executor_runner.cpp$")
-  list(
-    PREPEND
-    _qnn_executor_runner__srcs
-    ${CMAKE_CURRENT_LIST_DIR}/executor_runner/qnn_executor_runner.cpp
-  )
-  add_executable(qnn_executor_runner ${_qnn_executor_runner__srcs})
-  target_link_libraries(qnn_executor_runner
-    ${_executor_runner_libs}
-    qnn_executorch_backend
-    gflags
-  )
-  target_compile_options(qnn_executor_runner PUBLIC ${_common_compile_options})
+    add_subdirectory(${EXECUTORCH_SOURCE_DIR}/third-party/pybind11
+                    ${CMAKE_CURRENT_BINARY_DIR}/pybind11)
+    add_library(PyQnnManagerAdaptor MODULE)
+    add_library(PyQnnWrapperAdaptor MODULE)
+
+    target_link_libraries(PyQnnManagerAdaptor
+        PRIVATE
+        pybind11::module
+        pybind11::lto
+        qnn_manager
+        qnn_executorch_header
+        executorch
+    )
+    target_link_libraries(PyQnnWrapperAdaptor
+        PRIVATE
+        pybind11::module
+        pybind11::lto
+        wrappers
+        qnn_logging
+        qnn_executorch_header
+    )
+
+    pybind11_extension(PyQnnManagerAdaptor)
+    pybind11_extension(PyQnnWrapperAdaptor)
+    if(NOT MSVC AND NOT ${CMAKE_BUILD_TYPE} MATCHES Debug|RelWithDebInfo)
+        # Strip unnecessary sections of the binary
+        pybind11_strip(PyQnnManagerAdaptor)
+        pybind11_strip(PyQnnWrapperAdaptor)
+    endif()
+
+    add_subdirectory(
+        ${QNN_EXECUTORCH_ROOT_DIR}/aot/python
+        ${CMAKE_CURRENT_BINARY_DIR}/qnn_executorch/python
+    )
 endif()
-

backends/qualcomm/README.md

@@ -8,38 +8,47 @@ This backend is implemented on the top of
 [Qualcomm AI Engine Direct SDK](https://developer.qualcomm.com/software/qualcomm-ai-engine-direct-sdk).
 Please follow [setup](setup.md) to setup environment, build, and run executorch models by this backend.
 
-# Delegate options
+## Delegate Options
 
 Please check `generate_qnn_executorch_compiler_spec()` in
 [utils.py](./utils/utils.py) for supported SoC and inference type.
 
-### supported chipset
+### Supported Chipset
 - Snapdragon 8 Gen 1
 - Snapdragon 8 Gen 1+
 - Snapdragon 8 Gen 2
 
-### supported inference type
+### Supported Inference Type
 - Quantized
 - FP16
 
-# Directory Structure
+## Directory Structure
 
 ```
 backends/qualcomm
+├── aot # Codes for generating QNN context binary (AoT Part).
+|   ├── wrappers # Wrapper of QNN data structures for ease of use.
+|   └── python # Python interface for using QNN libraries.
 ├── builders # Codes for lowering each operators (AoT Part).
-├── examples # Examples to run QNN backends.
 ├── partition # QNN Partitioner (AoT Part).
 ├── passes # Various passes helping lower models to QNN backend (AoT Part).
 ├── python # Places to put pybind artifacts for accessing QNN APIs, structures, etc (AoT Part).
 ├── runtime # Here is QNN runtime responsbile for compiling a model on x64.
-|           # Meanwhile, this is also the runtime responsbile for executing compiled
-|           # models on a device (Device Part).
+|   |       # Meanwhile, this is also the runtime responsbile for executing compiled
+|   |       # models on a device.
+|   └── backends # Backends supported by QNN.
+|       └── htpbackend
+|           ├── aarch64 # Configuration required to run on device. (Device Part).
+|           └── x86_64 # Configuration required to compile graph on host. (AoT Part).
 ├── scripts # Misc supporting scripts, not related to core functionality.
 ├── tests # Unit tests and model tests go here.
 └── utils # Miscellaneous utilities.
+
+examples/backend
+└── qualcomm # Examples to run QNN backends.
 ```
 
-# Examples
+## Examples
 
 Please see this [README.md](../../examples/backend/qualcomm/README.md).
 

backends/qualcomm/runtime/python/CMakeLists.txt renamed to backends/qualcomm/aot/python/CMakeLists.txt

@@ -5,9 +5,9 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree.
  */
+#include <executorch/backends/qualcomm/aot/python/PyQnnWrapperAdaptor.h>
 #include <executorch/backends/qualcomm/runtime/Logging.h>
 #include <executorch/backends/qualcomm/runtime/QnnExecuTorch.h>
-#include <executorch/backends/qualcomm/runtime/python/PyQnnWrapperAdaptor.h>
 #include <pybind11/numpy.h>
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>

backends/qualcomm/runtime/python/PyQnnManagerAdaptor.cpp renamed to backends/qualcomm/aot/python/PyQnnManagerAdaptor.cpp

@@ -7,9 +7,9 @@
  */
 #pragma once
 
+#include <executorch/backends/qualcomm/aot/wrappers/OpWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 #include <executorch/backends/qualcomm/runtime/Logging.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/OpWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
 #include <pybind11/numpy.h>
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>

backends/qualcomm/runtime/python/PyQnnWrapperAdaptor.cpp renamed to backends/qualcomm/aot/python/PyQnnWrapperAdaptor.cpp

@@ -5,7 +5,7 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree.
  */
-#include <executorch/backends/qualcomm/runtime/wrappers/OpWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/OpWrapper.h>
 namespace torch {
 namespace executor {
 namespace qnn {

backends/qualcomm/runtime/python/PyQnnWrapperAdaptor.h renamed to backends/qualcomm/aot/python/PyQnnWrapperAdaptor.h

@@ -7,11 +7,11 @@
  */
 #pragma once
 
-#include <executorch/backends/qualcomm/runtime/wrappers/ParamWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/QuantizeParamsWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/ScalarParamWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorParamWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/ParamWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/QuantizeParamsWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/ScalarParamWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/TensorParamWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 
 #include <cstdint>
 #include <memory>

backends/qualcomm/runtime/wrappers/CMakeLists.txt renamed to backends/qualcomm/aot/wrappers/CMakeLists.txt

@@ -5,8 +5,8 @@
  * This source code is licensed under the BSD-style license found in the
  * LICENSE file in the root directory of this source tree.
  */
+#include <executorch/backends/qualcomm/aot/wrappers/QuantizeParamsWrapper.h>
 #include <executorch/backends/qualcomm/runtime/Logging.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/QuantizeParamsWrapper.h>
 namespace torch {
 namespace executor {
 namespace qnn {

backends/qualcomm/runtime/wrappers/OpWrapper.cpp renamed to backends/qualcomm/aot/wrappers/OpWrapper.cpp

@@ -7,7 +7,7 @@
  */
 #pragma once
 
-#include <executorch/backends/qualcomm/runtime/wrappers/ParamWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/ParamWrapper.h>
 #include <executorch/runtime/core/error.h>
 namespace torch {
 namespace executor {

backends/qualcomm/runtime/wrappers/OpWrapper.h renamed to backends/qualcomm/aot/wrappers/OpWrapper.h

@@ -7,8 +7,8 @@
  */
 #pragma once
 
-#include <executorch/backends/qualcomm/runtime/wrappers/ParamWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/ParamWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 #include <executorch/runtime/core/error.h>
 
 #include <memory>

backends/qualcomm/runtime/wrappers/ParamWrapper.h renamed to backends/qualcomm/aot/wrappers/ParamWrapper.h

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 
 #include <atomic>
 #include <cstring>

backends/qualcomm/runtime/wrappers/QuantizeParamsWrapper.cpp renamed to backends/qualcomm/aot/wrappers/QuantizeParamsWrapper.cpp

@@ -7,8 +7,8 @@
  */
 #pragma once
 
+#include <executorch/backends/qualcomm/aot/wrappers/QuantizeParamsWrapper.h>
 #include <executorch/backends/qualcomm/runtime/Logging.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/QuantizeParamsWrapper.h>
 #include <executorch/runtime/core/error.h>
 
 #include <memory>

backends/qualcomm/runtime/wrappers/QuantizeParamsWrapper.h renamed to backends/qualcomm/aot/wrappers/QuantizeParamsWrapper.h

@@ -7,9 +7,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 #include <executorch/backends/qualcomm/runtime/QnnExecuTorchBackend.h>
 #include <executorch/backends/qualcomm/runtime/QnnManager.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
 
 #include <array>
 #include <string>

backends/qualcomm/runtime/wrappers/ScalarParamWrapper.h renamed to backends/qualcomm/aot/wrappers/ScalarParamWrapper.h

@@ -7,11 +7,11 @@
  */
 #pragma once
 
+#include <executorch/backends/qualcomm/aot/wrappers/OpWrapper.h>
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 #include <executorch/backends/qualcomm/runtime/Logging.h>
 #include <executorch/backends/qualcomm/runtime/QnnExecuTorch.h>
 #include <executorch/backends/qualcomm/runtime/backends/QnnBackendFactory.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/OpWrapper.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
 #include <executorch/runtime/core/error.h>
 
 #include <memory>

backends/qualcomm/runtime/wrappers/TensorParamWrapper.h renamed to backends/qualcomm/aot/wrappers/TensorParamWrapper.h

@@ -7,10 +7,10 @@
  */
 #pragma once
 
+#include <executorch/backends/qualcomm/aot/wrappers/TensorWrapper.h>
 #include <executorch/backends/qualcomm/runtime/Logging.h>
 #include <executorch/backends/qualcomm/runtime/backends/QnnContextCommon.h>
 #include <executorch/backends/qualcomm/runtime/backends/QnnImplementation.h>
-#include <executorch/backends/qualcomm/runtime/wrappers/TensorWrapper.h>
 
 #include <vector>