Skip to content

Commit d1c80e1

Browse files
cccclaicccclai
committed
[1/N] Add BackendOptions class
Introduce backend option as discussed in #10216 Step 1: Introducd Backend Option class In later stage, it will be plugged in with the rest of the stack. Differential Revision: [D75993712](https://our.internmc.facebook.com/intern/diff/D75993712/) ghstack-source-id: 288273758 Pull Request resolved: #11389
1 parent af0a246 commit d1c80e1

File tree

4 files changed

+318
-1
lines changed

4 files changed

+318
-1
lines changed

‎runtime/backend/backend_options.h

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#include <cstddef>
10+
#include <cstring>
11+
#include <executorch/runtime/core/error.h>
12+
13+
namespace executorch {
14+
namespace runtime {
15+
16+
// Strongly-typed option key template
17+
// Wraps a string key with type information for type-safe option access
18+
template <typename T>
19+
struct OptionKey {
20+
const char* key; // String identifier for the option
21+
constexpr explicit OptionKey(const char* k) : key(k) {}
22+
};
23+
24+
// Supported option data types
25+
enum class OptionType { BOOL, INT, STRING };
26+
27+
// Union-like container for option values (only one member is valid per option)
28+
struct OptionValue {
29+
bool bool_value; // Storage for boolean values
30+
int int_value; // Storage for integer values
31+
const char* string_value; // Storage for string values
32+
};
33+
34+
// Represents a single backend configuration option
35+
struct BackendOption {
36+
const char* key; // Name of the option
37+
OptionType type; // Data type of the option
38+
OptionValue value; // Current value of the option
39+
};
40+
41+
// Fixed-capacity container for backend options with type-safe access
42+
// MaxCapacity: Maximum number of options this container can hold
43+
template <size_t MaxCapacity>
44+
class BackendOptions {
45+
public:
46+
// Initialize with zero options
47+
BackendOptions() : size(0) {}
48+
49+
// Type-safe setters ---------------------------------------------------
50+
51+
/// Sets or updates a boolean option
52+
/// @param key: Typed option key
53+
/// @param value: Boolean value to set
54+
void set_option(OptionKey<bool> key, bool value) {
55+
set_option_internal(key.key, OptionType::BOOL, {.bool_value = value});
56+
}
57+
58+
/// Sets or updates an integer option
59+
/// @param key: Typed option key
60+
/// @param value: Integer value to set
61+
void set_option(OptionKey<int> key, int value) {
62+
set_option_internal(key.key, OptionType::INT, {.int_value = value});
63+
}
64+
65+
/// Sets or updates a string option
66+
/// @param key: Typed option key
67+
/// @param value: Null-terminated string value to set
68+
void set_option(OptionKey<const char*> key, const char* value) {
69+
set_option_internal(key.key, OptionType::STRING, {.string_value = value});
70+
}
71+
72+
// Type-safe getters ---------------------------------------------------
73+
74+
/// Retrieves a boolean option value
75+
/// @param key: Typed option key
76+
/// @param out_value: Reference to store retrieved value
77+
/// @return: Error code (Ok on success)
78+
executorch::runtime::Error get_option(OptionKey<bool> key, bool& out_value)
79+
const {
80+
OptionValue val{};
81+
executorch::runtime::Error err =
82+
get_option_internal(key.key, OptionType::BOOL, val);
83+
if (err == executorch::runtime::Error::Ok) {
84+
out_value = val.bool_value;
85+
}
86+
return err;
87+
}
88+
89+
/// Retrieves an integer option value
90+
/// @param key: Typed option key
91+
/// @param out_value: Reference to store retrieved value
92+
/// @return: Error code (Ok on success)
93+
executorch::runtime::Error get_option(OptionKey<int> key, int& out_value)
94+
const {
95+
OptionValue val{};
96+
executorch::runtime::Error err =
97+
get_option_internal(key.key, OptionType::INT, val);
98+
if (err == executorch::runtime::Error::Ok) {
99+
out_value = val.int_value;
100+
}
101+
return err;
102+
}
103+
104+
/// Retrieves a string option value
105+
/// @param key: Typed option key
106+
/// @param out_value: Reference to store retrieved pointer
107+
/// @return: Error code (Ok on success)
108+
executorch::runtime::Error get_option(
109+
OptionKey<const char*> key,
110+
const char*& out_value) const {
111+
OptionValue val{};
112+
executorch::runtime::Error err =
113+
get_option_internal(key.key, OptionType::STRING, val);
114+
if (err == executorch::runtime::Error::Ok) {
115+
out_value = val.string_value;
116+
}
117+
return err;
118+
}
119+
120+
private:
121+
BackendOption options[MaxCapacity]{}; // Storage for options
122+
size_t size; // Current number of options
123+
124+
// Internal helper to set/update an option
125+
void
126+
set_option_internal(const char* key, OptionType type, OptionValue value) {
127+
// Update existing key if found
128+
for (size_t i = 0; i < size; ++i) {
129+
if (strcmp(options[i].key, key) == 0) {
130+
options[i].type = type;
131+
options[i].value = value;
132+
return;
133+
}
134+
}
135+
// Add new option if capacity allows
136+
if (size < MaxCapacity) {
137+
options[size++] = {key, type, value};
138+
}
139+
}
140+
141+
// Internal helper to get an option value with type checking
142+
executorch::runtime::Error get_option_internal(
143+
const char* key,
144+
OptionType expected_type,
145+
OptionValue& out) const {
146+
for (size_t i = 0; i < size; ++i) {
147+
if (strcmp(options[i].key, key) == 0) {
148+
// Verify type matches expectation
149+
if (options[i].type != expected_type) {
150+
return executorch::runtime::Error::InvalidArgument;
151+
}
152+
out = options[i].value;
153+
return executorch::runtime::Error::Ok;
154+
}
155+
}
156+
return executorch::runtime::Error::NotFound; // Key not found
157+
}
158+
};
159+
160+
// Helper functions for creating typed option keys --------------------------
161+
162+
/// Creates a boolean option key
163+
constexpr OptionKey<bool> BoolKey(const char* k) {
164+
return OptionKey<bool>(k);
165+
}
166+
167+
/// Creates an integer option key
168+
constexpr OptionKey<int> IntKey(const char* k) {
169+
return OptionKey<int>(k);
170+
}
171+
172+
/// Creates a string option key
173+
constexpr OptionKey<const char*> StrKey(const char* k) {
174+
return OptionKey<const char*>(k);
175+
}
176+
} // namespace runtime
177+
} // namespace executorch

‎runtime/backend/targets.bzl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ def define_common_targets():
1717
exported_headers = [
1818
"backend_execution_context.h",
1919
"backend_init_context.h",
20+
"backend_options.h",
2021
"interface.h",
2122
],
2223
preprocessor_flags = ["-DUSE_ATEN_LIB"] if aten_mode else [],

‎runtime/backend/test/backend_options_test.cpp

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
/*
2+
* Copyright (c) Meta Platforms, Inc. and affiliates.
3+
* All rights reserved.
4+
*
5+
* This source code is licensed under the BSD-style license found in the
6+
* LICENSE file in the root directory of this source tree.
7+
*/
8+
9+
#include <executorch/runtime/backend/backend_options.h>
10+
#include <executorch/runtime/platform/runtime.h>
11+
12+
#include <gtest/gtest.h>
13+
14+
using namespace ::testing;
15+
using executorch::runtime::BackendOptions;
16+
using executorch::runtime::BoolKey;
17+
using executorch::runtime::IntKey;
18+
using executorch::runtime::OptionKey;
19+
using executorch::runtime::StrKey;
20+
using executorch::runtime::Error;
21+
22+
class BackendOptionsTest : public ::testing::Test {
23+
protected:
24+
void SetUp() override {
25+
// Since these tests cause ET_LOG to be called, the PAL must be initialized
26+
// first.
27+
executorch::runtime::runtime_init();
28+
}
29+
BackendOptions<5> options; // Capacity of 5 for testing limits
30+
};
31+
32+
// Test basic string functionality
33+
TEST_F(BackendOptionsTest, HandlesStringOptions) {
34+
// Set and retrieve valid string
35+
options.set_option(StrKey("backend_type"), "GPU");
36+
const char* result = nullptr;
37+
EXPECT_EQ(options.get_option(StrKey("backend_type"), result), Error::Ok);
38+
EXPECT_STREQ(result, "GPU");
39+
40+
// Update existing key
41+
options.set_option(StrKey("backend_type"), "CPU");
42+
EXPECT_EQ(options.get_option(StrKey("backend_type"), result), Error::Ok);
43+
EXPECT_STREQ(result, "CPU");
44+
}
45+
46+
// Test boolean options
47+
TEST_F(BackendOptionsTest, HandlesBoolOptions) {
48+
options.set_option(BoolKey("debug"), true);
49+
bool debug = false;
50+
EXPECT_EQ(options.get_option(BoolKey("debug"), debug), Error::Ok);
51+
EXPECT_TRUE(debug);
52+
53+
// Test false value
54+
options.set_option(BoolKey("verbose"), false);
55+
EXPECT_EQ(options.get_option(BoolKey("verbose"), debug), Error::Ok);
56+
EXPECT_FALSE(debug);
57+
}
58+
59+
// Test integer options
60+
TEST_F(BackendOptionsTest, HandlesIntOptions) {
61+
options.set_option(IntKey("num_threads"), 256);
62+
int size = 0;
63+
EXPECT_EQ(options.get_option(IntKey("num_threads"), size), Error::Ok);
64+
EXPECT_EQ(size, 256);
65+
}
66+
67+
// Test error conditions
68+
TEST_F(BackendOptionsTest, HandlesErrors) {
69+
// Non-existent key
70+
bool dummy_bool;
71+
EXPECT_EQ(
72+
options.get_option(BoolKey("missing"), dummy_bool), Error::NotFound);
73+
74+
// Type mismatch
75+
options.set_option(IntKey("threshold"), 100);
76+
const char* dummy_str = nullptr;
77+
EXPECT_EQ(
78+
options.get_option(StrKey("threshold"), dummy_str),
79+
Error::InvalidArgument);
80+
81+
// Null value handling
82+
options.set_option(StrKey("nullable"), nullptr);
83+
EXPECT_EQ(options.get_option(StrKey("nullable"), dummy_str), Error::Ok);
84+
EXPECT_EQ(dummy_str, nullptr);
85+
}
86+
87+
// Test capacity limits
88+
TEST_F(BackendOptionsTest, HandlesCapacity) {
89+
// Use persistent storage for keys
90+
std::vector<std::string> keys = {"key0", "key1", "key2", "key3", "key4"};
91+
92+
// Fill to capacity with persistent keys
93+
for (int i = 0; i < 5; i++) {
94+
options.set_option(IntKey(keys[i].c_str()), i);
95+
}
96+
97+
// Verify all exist
98+
int value;
99+
for (int i = 0; i < 5; i++) {
100+
EXPECT_EQ(options.get_option(IntKey(keys[i].c_str()), value), Error::Ok);
101+
EXPECT_EQ(value, i);
102+
}
103+
104+
// Add beyond capacity - should fail
105+
const char* overflow_key = "overflow";
106+
options.set_option(IntKey(overflow_key), 99);
107+
EXPECT_EQ(options.get_option(IntKey(overflow_key), value), Error::NotFound);
108+
109+
// Update existing within capacity
110+
options.set_option(IntKey(keys[2].c_str()), 222);
111+
EXPECT_EQ(options.get_option(IntKey(keys[2].c_str()), value), Error::Ok);
112+
EXPECT_EQ(value, 222);
113+
}
114+
115+
// Test type-specific keys
116+
TEST_F(BackendOptionsTest, EnforcesKeyTypes) {
117+
// Same key name - later set operations overwrite earlier ones
118+
options.set_option(BoolKey("flag"), true);
119+
options.set_option(IntKey("flag"), 123); // Overwrites the boolean entry
120+
121+
bool bval;
122+
int ival;
123+
124+
// Boolean get should fail - type was overwritten to INT
125+
EXPECT_EQ(options.get_option(BoolKey("flag"), bval), Error::InvalidArgument);
126+
127+
// Integer get should succeed with correct value
128+
EXPECT_EQ(options.get_option(IntKey("flag"), ival), Error::Ok);
129+
EXPECT_EQ(ival, 123);
130+
}

‎runtime/backend/test/targets.bzl

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1+
load("@fbsource//xplat/executorch/build:runtime_wrapper.bzl", "runtime")
2+
13
def define_common_targets():
24
"""Defines targets that should be shared between fbcode and xplat.
35
46
The directory containing this targets.bzl file should also contain both
57
TARGETS and BUCK files that call this function.
68
"""
7-
pass
9+
runtime.cxx_test(
10+
name = "backend_options_test",
11+
srcs = ["backend_options_test.cpp"],
12+
deps = [
13+
"//executorch/runtime/core:core",
14+
"//executorch/runtime/backend:interface",
15+
],
16+
)

0 commit comments

Comments
 (0)