[ONNXIFI]Add extension to be implementable (onnx#1796)

* add onnxifi extension function in onnxifi_op

* add cmake summary

Author: zrphercule

CMakeLists.txt

@@ -23,6 +23,7 @@ option(ONNX_WERROR "Build with Werror" OFF)
 option(ONNX_COVERAGE "Build with coverage instrumentation" OFF)
 option(ONNX_BUILD_TESTS "Build ONNX C++ APIs Tests" OFF)
 option(ONNX_USE_LITE_PROTO "Use lite protobuf instead of full." OFF)
+option(ONNXIFI_ENABLE_EXT "Enable onnxifi extensions." OFF)
 if(DEFINED ENV{ONNX_ML})
   set(DEFAULT_ONNX_ML $ENV{ONNX_ML})
 else()
@@ -543,6 +544,11 @@ endif()
 
 # ---[ ONNXIFI dummy backend
 add_library(onnxifi_dummy SHARED onnx/onnxifi_dummy.c)
+
+if(ONNXIFI_ENABLE_EXT)
+  add_definitions(-DONNXIFI_ENABLE_EXT=ON)
+endif()
+
 target_include_directories(onnxifi_dummy PRIVATE
   $<BUILD_INTERFACE:${ONNX_ROOT}>
   $<INSTALL_INTERFACE:include>)
@@ -584,9 +590,11 @@ if(NOT ANDROID AND NOT IOS)
   install(TARGETS onnxifi_wrapper
     EXPORT ONNXTargets DESTINATION lib)
 endif()
+
 if(ONNXIFI_DUMMY_BACKEND)
   add_definitions(-DONNXIFI_DUMMY_BACKEND=1)
 endif()
+
 if(ONNX_BUILD_TESTS)
   include(${ONNX_ROOT}/cmake/unittest.cmake)
 endif()

cmake/summary.cmake

@@ -21,6 +21,7 @@ function (onnx_print_configuration_summary)
   message(STATUS "  ONNX_BUILD_BENCHMARKS : ${ONNX_BUILD_BENCHMARKS}")
   message(STATUS "  ONNX_USE_LITE_PROTO   : ${ONNX_USE_LITE_PROTO}")
   message(STATUS "  ONNXIFI_DUMMY_BACKEND : ${ONNXIFI_DUMMY_BACKEND}")
+  message(STATUS "  ONNXIFI_ENABLE_EXT    : ${ONNXIFI_ENABLE_EXT}")
   message(STATUS "")
   message(STATUS "  Protobuf compiler     : ${PROTOBUF_PROTOC_EXECUTABLE}")
   message(STATUS "  Protobuf includes     : ${PROTOBUF_INCLUDE_DIRS}")

onnx/backend/test/cpp/driver_test.cc

@@ -2,6 +2,7 @@
 
 #include "onnx/checker.h"
 #include "onnx/onnxifi.h"
+#include "onnx/onnxifi_ext.h"
 #include "onnx/onnxifi_loader.h"
 #include "onnx/string_utils.h"
 
@@ -322,6 +323,17 @@ class ONNXCppDriverTest : public ::testing::TestWithParam<
                 true);
           }
         }
+/*
+ * Examine functions in onnxifi_ext
+ */
+#ifdef ONNXIFI_ENABLE_EXT
+        onnxExtensionFunctionPointer* f;
+        ASSERT_TRUE(IsGtestAssertMemorySafeSuccess(
+            lib.onnxGetExtensionFunctionAddress(
+                backendID, "onnxGetExtensionFunctionAddress", f),
+            NULL,
+            lib));
+#endif
       }
       ASSERT_TRUE(IsGtestAssertMemorySafeSuccess(
           lib.onnxReleaseGraph(graph), NULL, lib));

onnx/onnxifi_dummy.c

@@ -7,6 +7,11 @@
 #include <math.h>
 
 #include "onnx/onnxifi.h"
+#include "onnx/onnxifi_ext.h"
+
+/*
+ * ONNXIFI Functions
+ */
 
 ONNXIFI_PUBLIC ONNXIFI_CHECK_RESULT onnxStatus ONNXIFI_ABI
 onnxGetBackendIDs(onnxBackendID* backendIDs, size_t* numBackends) {
@@ -136,3 +141,56 @@ ONNXIFI_PUBLIC ONNXIFI_CHECK_RESULT onnxStatus ONNXIFI_ABI
 onnxReleaseGraph(onnxGraph graph) {
   return ONNXIFI_STATUS_SUCCESS;
 }
+
+/*
+ * ONNXIFI Extension Functions
+ */
+
+/*
+ * This is the function list and the number of functions in onnxifi_ext
+ * we have in this backend. It should be a subset of ALL_EXT_FUNCTION_LIST
+ * in onnxifi_ext.h
+ */
+const int extension_function_number = 2;
+const char* extension_function_list[] = {"onnxGetExtensionFunctionAddress",
+                                         "onnxSetIOAndRunGraph"};
+
+ONNXIFI_PUBLIC ONNXIFI_CHECK_RESULT onnxStatus ONNXIFI_ABI
+onnxGetExtensionFunctionAddress(
+    onnxBackendID backendID,
+    const char* name,
+    onnxExtensionFunctionPointer* function) {
+  if (name == NULL || function == NULL) {
+    return ONNXIFI_STATUS_INVALID_POINTER;
+  }
+  *function = NULL;
+  int i;
+  for (i = 0; i < extension_function_number; i++) {
+    /* target function found */
+    if (strcmp(name, extension_function_list[i]) == 0) {
+      switch (i) {
+        case 0:
+          *function = &onnxGetExtensionFunctionAddress;
+          break;
+        case 1:
+          *function = &onnxSetIOAndRunGraph;
+          break;
+      }
+    }
+  }
+
+  if (*function == NULL) {
+    return ONNXIFI_STATUS_UNIDENTIFIED_NAME;
+  }
+  return ONNXIFI_STATUS_SUCCESS;
+}
+
+ONNXIFI_PUBLIC ONNXIFI_CHECK_RESULT onnxStatus ONNXIFI_ABI onnxSetIOAndRunGraph(
+    onnxGraph graph,
+    uint32_t inputsCount,
+    const onnxTensorDescriptorV1* inputDescriptors,
+    uint32_t outputsCount,
+    const onnxTensorDescriptorV1* outputDescriptors,
+    onnxMemoryFenceV1* outputFence) {
+  return ONNXIFI_STATUS_SUCCESS;
+}

onnx/onnxifi_ext.h

@@ -7,6 +7,14 @@
 extern "C" {
 #endif
 
+/*
+ * This is the super set of all extension functions we support in onnxifi.
+ * All backend should support a subset of function of this list.
+ */
+static const int ALL_EXT_FUNCTION_NUMBER = 2;
+static const char* ALL_EXT_FUNCTION_LIST[] = {"onnxGetExtensionFunctionAddress",
+                                              "onnxSetIOAndRunGraph"};
+
 /**
  * Generic ONNXIFI extension function pointer.
  *

onnx/onnxifi_loader.c

@@ -48,7 +48,11 @@ static const char onnxifi_function_names[] =
     "onnxInitGraph\0"
     "onnxSetGraphIO\0"
     "onnxRunGraph\0"
-    "onnxReleaseGraph\0";
+    "onnxReleaseGraph\0"
+#ifdef ONNXIFI_ENABLE_EXT
+    "onnxGetExtensionFunctionAddress\0"
+#endif
+    ;
 
 int ONNXIFI_ABI onnxifi_load(
   uint32_t flags,

onnx/onnxifi_loader.h

@@ -4,7 +4,11 @@
 #include "onnx/onnxifi.h"
 #include "onnx/onnxifi_ext.h"
 
+#ifdef ONNXIFI_ENABLE_EXT
+#define ONNXIFI_LOADER_FUNCTION_COUNT 16
+#else
 #define ONNXIFI_LOADER_FUNCTION_COUNT 15
+#endif
 
 #define ONNXIFI_LOADER_FLAG_VERSION_MASK 0xFF
 #define ONNXIFI_LOADER_FLAG_VERSION_1_0 0x01
@@ -49,6 +53,9 @@ struct onnxifi_library {
       onnxSetGraphIOFunction onnxSetGraphIO;
       onnxRunGraphFunction onnxRunGraph;
       onnxReleaseGraphFunction onnxReleaseGraph;
+#ifdef ONNXIFI_ENABLE_EXT
+      onnxGetExtensionFunctionAddressFunction onnxGetExtensionFunctionAddress;
+#endif
     };
     void* functions[ONNXIFI_LOADER_FUNCTION_COUNT];
   };