-
Notifications
You must be signed in to change notification settings - Fork 596
[3/N] Add update function in backend interface #11391
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
cccclai
wants to merge
6
commits into
gh/cccclai/23/base
Choose a base branch
from
gh/cccclai/23/head
base: gh/cccclai/23/base
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c4a952a
[3/N] Add update function in backend interface
cccclai f2249b3
Update on "[3/N] Add update function in backend interface"
cccclai ea2d27b
Update on "[3/N] Add update function in backend interface"
cccclai efa67f3
Update on "[3/N] Add update function in backend interface"
cccclai a7cc325
Update on "[3/N] Add update function in backend interface"
cccclai 5d11e43
Update on "[3/N] Add update function in backend interface"
cccclai File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,286 @@ | ||
/* | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* All rights reserved. | ||
* | ||
* 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/runtime/backend/interface.h> | ||
#include <executorch/runtime/platform/runtime.h> | ||
|
||
#include <gtest/gtest.h> | ||
|
||
using namespace ::testing; | ||
using executorch::runtime::BackendInterface; | ||
using executorch::runtime::Result; | ||
using executorch::runtime::DelegateHandle; | ||
using executorch::runtime::FreeableBuffer; | ||
using executorch::runtime::BackendInitContext; | ||
using executorch::runtime::CompileSpec; | ||
using executorch::runtime::ArrayRef; | ||
using executorch::runtime::Error; | ||
using executorch::runtime::BackendExecutionContext; | ||
using executorch::runtime::EValue; | ||
using executorch::runtime::BackendUpdateContext; | ||
using executorch::runtime::BackendOption; | ||
using executorch::runtime::BackendOptions; | ||
using executorch::runtime::Backend; | ||
using executorch::runtime::StrKey; | ||
using executorch::runtime::IntKey; | ||
using executorch::runtime::BoolKey; | ||
using executorch::runtime::get_backend_class; | ||
using executorch::runtime::MemoryAllocator; | ||
|
||
class MockBackend : public BackendInterface { | ||
public: | ||
~MockBackend() override = default; | ||
|
||
bool is_available() const override { return true; } | ||
|
||
Result<DelegateHandle*> init( | ||
BackendInitContext& context, | ||
FreeableBuffer* processed, | ||
ArrayRef<CompileSpec> compile_specs) const override { | ||
init_called = true; | ||
return nullptr; | ||
} | ||
|
||
Error execute( | ||
BackendExecutionContext& context, | ||
DelegateHandle* handle, | ||
EValue** args) const override { | ||
execute_count++; | ||
return Error::Ok; | ||
} | ||
|
||
Error set_option( | ||
BackendUpdateContext& context, | ||
const executorch::runtime::Span<BackendOption>& backend_options) override { | ||
set_option_count++; | ||
int sucess_update = 0; | ||
for (const auto& backend_option : backend_options) { | ||
if (strcmp(backend_option.key, "Backend") == 0) { | ||
if (std::holds_alternative<const char*>(backend_option.value)) { | ||
// Store the value in our member variable | ||
target_backend = std::get<const char*>(backend_option.value); | ||
sucess_update++; | ||
} | ||
} else if (strcmp(backend_option.key, "NumberOfThreads") == 0) { | ||
if (std::holds_alternative<int>(backend_option.value)) { | ||
num_threads = std::get<int>(backend_option.value); | ||
sucess_update++; | ||
} | ||
} else if (strcmp(backend_option.key, "Debug") == 0) { | ||
if (std::holds_alternative<bool>(backend_option.value)) { | ||
debug = std::get<bool>(backend_option.value); | ||
sucess_update++; | ||
} | ||
} | ||
} | ||
if (sucess_update == backend_options.size()) { | ||
return Error::Ok; | ||
} | ||
return Error::InvalidArgument; | ||
} | ||
|
||
// Mutable allows modification in const methods | ||
mutable std::optional<std::string> target_backend; | ||
mutable int num_threads = 0; | ||
mutable bool debug = false; | ||
|
||
// State tracking | ||
mutable bool init_called = false; | ||
mutable int execute_count = 0; | ||
mutable int set_option_count = 0; | ||
}; | ||
|
||
class BackendInterfaceUpdateTest : public ::testing::Test { | ||
protected: | ||
|
||
void SetUp() override { | ||
// Since these tests cause ET_LOG to be called, the PAL must be initialized | ||
// first. | ||
executorch::runtime::runtime_init(); | ||
mock_backend = std::make_unique<MockBackend>(); | ||
// static Error register_success = register_executor_backend(); | ||
} | ||
|
||
std::unique_ptr<MockBackend> mock_backend; | ||
BackendOptions<5> options; | ||
}; | ||
|
||
TEST_F(BackendInterfaceUpdateTest, HandlesInvalidOption) { | ||
BackendUpdateContext context; | ||
|
||
// Test invalid key case | ||
BackendOption invalid_option{ | ||
"InvalidKey", | ||
"None" | ||
}; | ||
|
||
// Create a span from the single option | ||
Error err = mock_backend->set_option(context, invalid_option); | ||
EXPECT_EQ(err, Error::InvalidArgument); | ||
|
||
} | ||
|
||
TEST_F(BackendInterfaceUpdateTest, HandlesStringOption) { | ||
BackendUpdateContext context; | ||
options.set_option(StrKey("Backend"), "GPU"); | ||
// // Create a backend option to pass to update | ||
|
||
EXPECT_EQ(mock_backend->target_backend, std::nullopt); | ||
|
||
// Test successful update | ||
Error err = mock_backend->set_option(context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
EXPECT_EQ(mock_backend->target_backend, "GPU"); | ||
} | ||
|
||
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; | ||
|
||
int expected_num_threads = 4; | ||
|
||
// Create a backend option to pass to update | ||
options.set_option(IntKey("NumberOfThreads"), expected_num_threads); | ||
|
||
// Test successful update | ||
Error err = mock_backend->set_option(context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
EXPECT_EQ(mock_backend->num_threads, expected_num_threads); | ||
} | ||
|
||
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; | ||
|
||
options.set_option(BoolKey("Debug"), true); | ||
|
||
// Test successful update | ||
Error err = mock_backend->set_option(context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
EXPECT_EQ(mock_backend->debug, true); | ||
} | ||
|
||
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; | ||
|
||
options.set_option(BoolKey("Debug"), true); | ||
options.set_option(IntKey("NumberOfThreads"), 4); | ||
options.set_option(StrKey("Backend"), "GPU"); | ||
|
||
// Test successful update | ||
Error err = mock_backend->set_option(context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
EXPECT_EQ(mock_backend->debug, true); | ||
EXPECT_EQ(mock_backend->num_threads, 4); | ||
EXPECT_EQ(mock_backend->target_backend, "GPU"); | ||
} | ||
|
||
TEST_F(BackendInterfaceUpdateTest, UpdateBeforeInit) { | ||
BackendUpdateContext update_context; | ||
MemoryAllocator memory_allocator{MemoryAllocator(0, nullptr)}; | ||
|
||
BackendInitContext init_context(&memory_allocator); | ||
|
||
// Create backend option | ||
options.set_option(StrKey("Backend"), "GPU"); | ||
|
||
// Update before init | ||
Error err = mock_backend->set_option(update_context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
// Now call init | ||
FreeableBuffer* processed = nullptr; // Not used in mock | ||
ArrayRef<CompileSpec> compile_specs; // Empty | ||
auto handle_or_error = mock_backend->init(init_context, processed, compile_specs); | ||
EXPECT_EQ(handle_or_error.error(), Error::Ok); | ||
|
||
// Verify state | ||
EXPECT_TRUE(mock_backend->init_called); | ||
EXPECT_EQ(mock_backend->set_option_count, 1); | ||
EXPECT_EQ(mock_backend->execute_count, 0); | ||
ASSERT_TRUE(mock_backend->target_backend.has_value()); | ||
EXPECT_STREQ(mock_backend->target_backend.value().c_str(), "GPU"); | ||
} | ||
|
||
TEST_F(BackendInterfaceUpdateTest, UpdateAfterInitBeforeExecute) { | ||
BackendUpdateContext update_context; | ||
MemoryAllocator init_memory_allocator{MemoryAllocator(0, nullptr)}; | ||
BackendInitContext init_context(&init_memory_allocator); | ||
BackendExecutionContext execute_context; | ||
|
||
// First call init | ||
FreeableBuffer* processed = nullptr; | ||
ArrayRef<CompileSpec> compile_specs; | ||
auto handle_or_error = mock_backend->init(init_context, processed, compile_specs); | ||
EXPECT_TRUE(handle_or_error.ok()); | ||
|
||
// Verify init called but execute not called | ||
EXPECT_TRUE(mock_backend->init_called); | ||
EXPECT_EQ(mock_backend->execute_count, 0); | ||
|
||
// Now update | ||
options.set_option(StrKey("Backend"), "CPU"); | ||
Error err = mock_backend->set_option(update_context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
// Now execute | ||
DelegateHandle* handle = handle_or_error.get(); | ||
EValue** args = nullptr; // Not used in mock | ||
err = mock_backend->execute(execute_context, handle, args); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
// Verify state | ||
EXPECT_EQ(mock_backend->set_option_count, 1); | ||
EXPECT_EQ(mock_backend->execute_count, 1); | ||
ASSERT_TRUE(mock_backend->target_backend.has_value()); | ||
EXPECT_STREQ(mock_backend->target_backend.value().c_str(), "CPU"); | ||
} | ||
|
||
TEST_F(BackendInterfaceUpdateTest, UpdateBetweenExecutes) { | ||
BackendUpdateContext update_context; | ||
MemoryAllocator init_memory_allocator{MemoryAllocator(0, nullptr)}; | ||
BackendInitContext init_context(&init_memory_allocator); | ||
BackendExecutionContext execute_context; | ||
|
||
// Initialize | ||
FreeableBuffer* processed = nullptr; | ||
ArrayRef<CompileSpec> compile_specs; | ||
auto handle_or_error = mock_backend->init(init_context, processed, compile_specs); | ||
EXPECT_TRUE(handle_or_error.ok()); | ||
DelegateHandle* handle = handle_or_error.get(); | ||
|
||
// First execute | ||
EValue** args = nullptr; | ||
Error err = mock_backend->execute(execute_context, handle, args); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
// Update between executes | ||
options.set_option(StrKey("Backend"), "NPU"); | ||
err = mock_backend->set_option(update_context, options.view()); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
// Second execute | ||
err = mock_backend->execute(execute_context, handle, args); | ||
EXPECT_EQ(err, Error::Ok); | ||
|
||
// Verify state | ||
EXPECT_EQ(mock_backend->set_option_count, 1); | ||
EXPECT_EQ(mock_backend->execute_count, 2); | ||
ASSERT_TRUE(mock_backend->target_backend.has_value()); | ||
EXPECT_STREQ(mock_backend->target_backend.value().c_str(), "NPU"); | ||
} |
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are all these tests but I am not sure if they are meanigfully testing anything? do you need all of them?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's helpful to make sure we know each option inside the backend is updated successfully, and they are isolated.