Allow getting all backend names (#8520)

Summary:

Allow getting all backends name in both python and c++

Reviewed By: larryliu0820

Differential Revision: D69691354

Author: cccclai

extension/pybindings/portable_lib.py

@@ -37,6 +37,7 @@
     # Disable "imported but unused" (F401) checks.
     _create_profile_block,  # noqa: F401
     _dump_profile_results,  # noqa: F401
+    _get_backend_names,  # noqa: F401
     _get_operator_names,  # noqa: F401
     _load_bundled_program_from_buffer,  # noqa: F401
     _load_for_executorch,  # noqa: F401

extension/pybindings/pybindings.cpp

@@ -23,6 +23,7 @@
 #include <executorch/extension/data_loader/buffer_data_loader.h>
 #include <executorch/extension/data_loader/mmap_data_loader.h>
 #include <executorch/extension/memory_allocator/malloc_memory_allocator.h>
+#include <executorch/runtime/backend/interface.h>
 #include <executorch/runtime/core/data_loader.h>
 #include <executorch/runtime/core/exec_aten/util/scalar_type_util.h>
 #include <executorch/runtime/executor/method.h>
@@ -87,10 +88,13 @@ using ::executorch::extension::BufferDataLoader;
 using ::executorch::extension::MallocMemoryAllocator;
 using ::executorch::extension::MmapDataLoader;
 using ::executorch::runtime::ArrayRef;
+using ::executorch::runtime::Backend;
 using ::executorch::runtime::DataLoader;
 using ::executorch::runtime::Error;
 using ::executorch::runtime::EValue;
 using ::executorch::runtime::EventTracerDebugLogLevel;
+using ::executorch::runtime::get_backend_name;
+using ::executorch::runtime::get_num_registered_backends;
 using ::executorch::runtime::get_registered_kernels;
 using ::executorch::runtime::HierarchicalAllocator;
 using ::executorch::runtime::Kernel;
@@ -975,6 +979,19 @@ py::list get_operator_names() {
   return res;
 }
 
+py::list get_backend_names() {
+  size_t n_of_registered_backends = get_num_registered_backends();
+  py::list res;
+  for (size_t i = 0; i < n_of_registered_backends; i++) {
+    auto backend_name_res = get_backend_name(i);
+    THROW_IF_ERROR(backend_name_res.error(), "Failed to get backend name");
+    auto backend_name = backend_name_res.get();
+    printf("backend name: %s\n", backend_name);
+    res.append(backend_name);
+  }
+  return res;
+}
+
 } // namespace
 
 PYBIND11_MODULE(EXECUTORCH_PYTHON_MODULE_NAME, m) {
@@ -1028,6 +1045,7 @@ PYBIND11_MODULE(EXECUTORCH_PYTHON_MODULE_NAME, m) {
             prof_result.num_bytes);
       },
       call_guard);
+  m.def("_get_backend_names", &get_backend_names, call_guard);
   m.def("_get_operator_names", &get_operator_names);
   m.def("_create_profile_block", &create_profile_block, call_guard);
   m.def(

extension/pybindings/pybindings.pyi

@@ -211,6 +211,15 @@ def _load_bundled_program_from_buffer(
     """
     ...
 
+@experimental("This API is experimental and subject to change without notice.")
+def _get_backend_names() -> List[str]:
+    """
+    .. warning::
+
+        This API is experimental and subject to change without notice.
+    """
+    ...
+
 @experimental("This API is experimental and subject to change without notice.")
 def _get_operator_names() -> List[str]:
     """

extension/pybindings/test/TARGETS

@@ -47,3 +47,11 @@ runtime.python_test(
         "//executorch/kernels/quantized:aot_lib",
     ],
 )
+
+runtime.python_test(
+    name = "test_backend_pybinding",
+    srcs = ["test_backend_pybinding.py"],
+    deps = [
+        "//executorch/extension/pybindings:portable_lib",
+    ],
+)

extension/pybindings/test/test_backend_pybinding.py

@@ -0,0 +1,12 @@
+import unittest
+
+from executorch.extension.pybindings.portable_lib import _get_backend_names
+
+
+class TestBackendsPybinding(unittest.TestCase):
+    def test_backend_name_list(
+        self,
+    ) -> None:
+        all_backend_name = _get_backend_names()
+        self.assertGreaterEqual(len(all_backend_name), 1)
+        self.assertIn("XnnpackBackend", all_backend_name)

runtime/__init__.py

@@ -125,6 +125,21 @@ def load_method(self, name: str) -> Optional[Method]:
         return self._methods.get(name, None)
 
 
+class BackendRegistry:
+    """The registry of backends that are available to the runtime."""
+
+    def __init__(self, legacy_module: ModuleType) -> None:
+        # TODO: Expose the kernel callables to Python.
+        self._legacy_module = legacy_module
+
+    @property
+    def _get_backend_names(self) -> Set[str]:
+        """
+        Returns the names of all registered backends as a list of strings.
+        """
+        return self._legacy_module._get_backend_names()
+
+
 class OperatorRegistry:
     """The registry of operators that are available to the runtime."""
 

runtime/backend/interface.cpp

@@ -55,5 +55,16 @@ Error register_backend(const Backend& backend) {
   return Error::Ok;
 }
 
+size_t get_num_registered_backends() {
+  return num_registered_backends;
+}
+
+Result<const char*> get_backend_name(size_t index) {
+  if (index >= num_registered_backends) {
+    return Error::BackendTableAccessFail;
+  }
+  return registered_backends[index].name;
+}
+
 } // namespace runtime
 } // namespace executorch

runtime/backend/interface.h

@@ -18,6 +18,7 @@
 #include <executorch/runtime/core/freeable_buffer.h>
 #include <executorch/runtime/core/memory_allocator.h>
 #include <executorch/runtime/core/result.h>
+#include <executorch/runtime/core/span.h>
 #include <executorch/runtime/platform/compiler.h>
 
 namespace executorch {
@@ -139,6 +140,16 @@ struct Backend {
  */
 ET_NODISCARD Error register_backend(const Backend& backend);
 
+/**
+ * Returns the number of registered backends.
+ */
+size_t get_num_registered_backends();
+
+/**
+ * Returns the backend name at the given index.
+ */
+Result<const char*> get_backend_name(size_t index);
+
 } // namespace runtime
 } // namespace executorch
 

runtime/core/error.h

@@ -93,6 +93,9 @@ enum class Error : error_code_t {
   /// Execute stage: The handle is invalid.
   DelegateInvalidHandle = 0x32,
 
+  /// Backend registration: trying to access an invalid index in the backend
+  /// registration table.
+  BackendTableAccessFail = 0x33,
 };
 
 } // namespace runtime