Update on "[3/N] Add get_option/set_option function in backend interface"

cccclai · cccclai · commit 1ce04a34d030 · 2025-06-17T23:05:05.000-07:00
Add update function in backend interface class. The update function will receive the backend options from dispatched by the ET runtime. ET runtime's logic: loop over each backend and it's corresponding backend options, dispatch the backend options to the corresponding backend Next step, will add update API in the method and then module exported-using-ghexport Differential Revision: [D75919242](https://our.internmc.facebook.com/intern/diff/D75919242/) Differential Revision: [D75919242](https://our.internmc.facebook.com/intern/diff/D75919242) [ghstack-poisoned]
diff --git a/runtime/backend/backend_option_context.h b/runtime/backend/backend_option_context.h
@@ -14,12 +14,12 @@
 namespace executorch {
 namespace ET_RUNTIME_NAMESPACE {
 /**
- * BackendUpdateContext will be used to inject runtime info for to initialize
+ * BackendOptionContext will be used to inject runtime info for to initialize
  * delegate.
  */
-class BackendUpdateContext final {
+class BackendOptionContext final {
  public:
-  explicit BackendUpdateContext(){}
+  explicit BackendOptionContext(){}
 };
 
 } // namespace ET_RUNTIME_NAMESPACE
@@ -29,6 +29,6 @@ namespace torch {
 namespace executor {
 // TODO(T197294990): Remove these deprecated aliases once all users have moved
 // to the new `::executorch` namespaces.
-using ::executorch::ET_RUNTIME_NAMESPACE::BackendUpdateContext;
+using ::executorch::ET_RUNTIME_NAMESPACE::BackendOptionContext;
 } // namespace executor
 } // namespace torch
diff --git a/runtime/backend/interface.h b/runtime/backend/interface.h
@@ -13,7 +13,7 @@
 #include <executorch/runtime/backend/backend_execution_context.h>
 #include <executorch/runtime/backend/backend_init_context.h>
 #include <executorch/runtime/backend/options.h>
-#include <executorch/runtime/backend/backend_update_context.h>
+#include <executorch/runtime/backend/backend_option_context.h>
 #include <executorch/runtime/core/array_ref.h>
 #include <executorch/runtime/core/error.h>
 #include <executorch/runtime/core/evalue.h>
@@ -111,7 +111,7 @@ class BackendInterface {
    * @retval Error::Ok if successful.
    */
   ET_NODISCARD virtual Error set_option(
-      BackendUpdateContext& context,
+      BackendOptionContext& context,
       const executorch::runtime::Span<BackendOption>& backend_options) {
     return Error::Ok;
   };
@@ -127,7 +127,7 @@ class BackendInterface {
    * @retval Error::Ok if successful.
    */
   ET_NODISCARD virtual Error get_option(
-      BackendUpdateContext& context,
+      BackendOptionContext& context,
       executorch::runtime::Span<BackendOption>& backend_options) {
     return Error::Ok;
   };
diff --git a/runtime/backend/targets.bzl b/runtime/backend/targets.bzl
@@ -17,7 +17,7 @@ def define_common_targets():
             exported_headers = [
                 "backend_execution_context.h",
                 "backend_init_context.h",
-                "backend_update_context.h",
+                "backend_option_context.h",
                 "options.h",
                 "interface.h",
             ],
diff --git a/runtime/backend/test/backend_interface_update_test.cpp b/runtime/backend/test/backend_interface_update_test.cpp
@@ -22,7 +22,7 @@ using executorch::runtime::ArrayRef;
 using executorch::runtime::Error;
 using executorch::runtime::BackendExecutionContext;
 using executorch::runtime::EValue;
-using executorch::runtime::BackendUpdateContext;
+using executorch::runtime::BackendOptionContext;
 using executorch::runtime::BackendOption;
 using executorch::runtime::BackendOptions;
 using executorch::runtime::Backend;
@@ -55,7 +55,7 @@ class MockBackend : public BackendInterface {
       }
   
       Error set_option(
-          BackendUpdateContext& context,
+          BackendOptionContext& context,
           const executorch::runtime::Span<BackendOption>& backend_options) override {
           set_option_count++;
           int sucess_update = 0;
@@ -111,7 +111,7 @@ class MockBackend : public BackendInterface {
 };
 
 TEST_F(BackendInterfaceUpdateTest, HandlesInvalidOption) {
-  BackendUpdateContext context;
+  BackendOptionContext context;
   
   // Test invalid key case
   BackendOption invalid_option{
@@ -126,7 +126,7 @@ TEST_F(BackendInterfaceUpdateTest, HandlesInvalidOption) {
 }
 
  TEST_F(BackendInterfaceUpdateTest, HandlesStringOption) {
-  BackendUpdateContext context;
+  BackendOptionContext context;
   options.set_option(StrKey("Backend"), "GPU");  
   // // Create a backend option to pass to update
 
@@ -143,7 +143,7 @@ TEST_F(BackendInterfaceUpdateTest, HandlesIntOption) {
   // Check the default num_threads value is 0
   EXPECT_EQ(mock_backend->debug, false);
   // Create a mock context (needs to be defined or mocked)
-  BackendUpdateContext context;
+  BackendOptionContext context;
 
   int expected_num_threads = 4;
   
@@ -160,7 +160,7 @@ TEST_F(BackendInterfaceUpdateTest, HandlesBoolOption) {
   // Check the default num_threads value is 0
   EXPECT_EQ(mock_backend->debug, false);
   // Create a mock context (needs to be defined or mocked)
-  BackendUpdateContext context;
+  BackendOptionContext context;
   
   options.set_option(BoolKey("Debug"), true);  
   
@@ -175,7 +175,7 @@ TEST_F(BackendInterfaceUpdateTest, HandlesMultipleOptions) {
   // Check the default num_threads value is 0
   EXPECT_EQ(mock_backend->debug, false);
   // Create a mock context (needs to be defined or mocked)
-  BackendUpdateContext context;
+  BackendOptionContext context;
   
   options.set_option(BoolKey("Debug"), true);
   options.set_option(IntKey("NumberOfThreads"), 4);  
@@ -191,7 +191,7 @@ TEST_F(BackendInterfaceUpdateTest, HandlesMultipleOptions) {
 }
 
 TEST_F(BackendInterfaceUpdateTest, UpdateBeforeInit) {
-  BackendUpdateContext update_context;
+  BackendOptionContext option_context;
   MemoryAllocator memory_allocator{MemoryAllocator(0, nullptr)};
 
   BackendInitContext init_context(&memory_allocator);
@@ -200,7 +200,7 @@ TEST_F(BackendInterfaceUpdateTest, UpdateBeforeInit) {
   options.set_option(StrKey("Backend"), "GPU");
   
   // Update before init
-  Error err = mock_backend->set_option(update_context, options.view());
+  Error err = mock_backend->set_option(option_context, options.view());
   EXPECT_EQ(err, Error::Ok);
     
   // Now call init
@@ -218,7 +218,7 @@ TEST_F(BackendInterfaceUpdateTest, UpdateBeforeInit) {
 }
 
 TEST_F(BackendInterfaceUpdateTest, UpdateAfterInitBeforeExecute) {
-  BackendUpdateContext update_context;
+  BackendOptionContext option_context;
   MemoryAllocator init_memory_allocator{MemoryAllocator(0, nullptr)};
   BackendInitContext init_context(&init_memory_allocator);
   BackendExecutionContext execute_context;
@@ -235,7 +235,7 @@ TEST_F(BackendInterfaceUpdateTest, UpdateAfterInitBeforeExecute) {
   
   // Now update
   options.set_option(StrKey("Backend"), "CPU");
-  Error err = mock_backend->set_option(update_context, options.view());
+  Error err = mock_backend->set_option(option_context, options.view());
   EXPECT_EQ(err, Error::Ok);
   
   // Now execute
@@ -252,7 +252,7 @@ TEST_F(BackendInterfaceUpdateTest, UpdateAfterInitBeforeExecute) {
 }
 
 TEST_F(BackendInterfaceUpdateTest, UpdateBetweenExecutes) {
-  BackendUpdateContext update_context;
+  BackendOptionContext option_context;
   MemoryAllocator init_memory_allocator{MemoryAllocator(0, nullptr)};
   BackendInitContext init_context(&init_memory_allocator);
   BackendExecutionContext execute_context;
@@ -271,7 +271,7 @@ TEST_F(BackendInterfaceUpdateTest, UpdateBetweenExecutes) {
   
   // Update between executes
   options.set_option(StrKey("Backend"), "NPU");
-  err = mock_backend->set_option(update_context, options.view());
+  err = mock_backend->set_option(option_context, options.view());
   EXPECT_EQ(err, Error::Ok);
   
   // Second execute
