Skip to content

Fix set_external_context() during state kInit #3102

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 3, 2025
Merged

Fix set_external_context() during state kInit #3102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ace1384
Fix set_external_context() during state kInit
ddavis-2015 May 7, 2025
e05f0ae
Merge branch 'main' into external-context
mergify[bot] Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion tensorflow/lite/micro/micro_interpreter_context.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,8 @@ void MicroInterpreterContext::SetScratchBufferHandles(

TfLiteStatus MicroInterpreterContext::set_external_context(
void* external_context_payload) {
TFLITE_DCHECK(state_ == InterpreterState::kPrepare ||
TFLITE_DCHECK(state_ == InterpreterState::kInit ||
state_ == InterpreterState::kPrepare ||
state_ == InterpreterState::kInvoke);
if (external_context_payload == nullptr ||
external_context_payload_ != nullptr) {
Expand Down
36 changes: 31 additions & 5 deletions tensorflow/lite/micro/micro_interpreter_context_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ struct TestExternalContextPayloadData {

TF_LITE_MICRO_TESTS_BEGIN

// Ensures that a regular set and get pair works ok.
TF_LITE_MICRO_TEST(TestSetGetExternalContextSuccess) {
// Ensures that a regular set and get pair works ok during state kInvoke.
TF_LITE_MICRO_TEST(TestSetGetExternalContextSuccessInvoke) {
tflite::MicroInterpreterContext micro_context =
tflite::CreateMicroInterpreterContext();
micro_context.SetInterpreterState(
Expand All @@ -70,19 +70,36 @@ TF_LITE_MICRO_TEST(TestSetGetExternalContextSuccess) {
micro_context.external_context());

// What is returned should be the same as what is set.
TF_LITE_MICRO_EXPECT((void*)returned_external_context == (void*)(&payload));
TF_LITE_MICRO_EXPECT(returned_external_context == &payload);
}

TF_LITE_MICRO_TEST(TestGetExternalContextWithoutSetShouldReturnNull) {
// Ensures that a regular set and get pair works ok during state kInit.
TF_LITE_MICRO_TEST(TestSetGetExternalContextSuccessInit) {
tflite::MicroInterpreterContext micro_context =
tflite::CreateMicroInterpreterContext();
micro_context.SetInterpreterState(
tflite::MicroInterpreterContext::InterpreterState::kInit);

tflite::TestExternalContextPayloadData payload;
TF_LITE_MICRO_EXPECT_EQ(kTfLiteOk,
micro_context.set_external_context(&payload));

tflite::TestExternalContextPayloadData* returned_external_context =
reinterpret_cast<tflite::TestExternalContextPayloadData*>(
micro_context.external_context());

// What is returned should be the same as what is set.
TF_LITE_MICRO_EXPECT(returned_external_context == &payload);
}

TF_LITE_MICRO_TEST(TestGetExternalContextWithoutSetShouldReturnNull) {
tflite::MicroInterpreterContext micro_context =
tflite::CreateMicroInterpreterContext();

void* returned_external_context = micro_context.external_context();

// Return a null if nothing is set before.
TF_LITE_MICRO_EXPECT((void*)returned_external_context == (nullptr));
TF_LITE_MICRO_EXPECT(returned_external_context == nullptr);
}

TF_LITE_MICRO_TEST(TestSetExternalContextCanOnlyBeCalledOnce) {
Expand All @@ -98,6 +115,15 @@ TF_LITE_MICRO_TEST(TestSetExternalContextCanOnlyBeCalledOnce) {
// Another set should fail.
TF_LITE_MICRO_EXPECT_EQ(kTfLiteError,
micro_context.set_external_context(&payload));

// Null set should fail.
TF_LITE_MICRO_EXPECT_EQ(kTfLiteError,
micro_context.set_external_context(nullptr));
tflite::TestExternalContextPayloadData* returned_external_context =
reinterpret_cast<tflite::TestExternalContextPayloadData*>(
micro_context.external_context());
// Payload should be unchanged.
TF_LITE_MICRO_EXPECT(&payload == returned_external_context);
}

TF_LITE_MICRO_TEST(TestSetExternalContextToNullShouldFail) {
Expand Down