Skip to content
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

Jump to bottom

[ESP32] Use nvs iterator to check if key exists #16885

Merged
merged 2 commits into from
Apr 1, 2022
Merged

[ESP32] Use nvs iterator to check if key exists #16885

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0665676
[ESP32] Use nvs iterator to check if key exists
shubhamdp Mar 31, 2022
6a8d3f7
Comment explaining why no need to release iterator in NULL case
shubhamdp Apr 1, 2022
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
84 changes: 10 additions & 74 deletions src/platform/ESP32/ESP32Config.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,82 +318,18 @@ CHIP_ERROR ESP32Config::ClearConfigValue(Key key)

bool ESP32Config::ConfigValueExists(Key key)
{
ScopedNvsHandle handle;

if (handle.Open(key.Namespace, NVS_READONLY) != CHIP_NO_ERROR)
{
return false;
}

// This code is a rather unfortunate consequence of the limitations
// in the ESP NVS API. As defined, there is no API for determining
// whether a particular key exists. Furthermore, calling one of the
// nvs_get_* APIs will result in a ESP_ERR_NVS_NOT_FOUND in the case
// where the key exists, but the requested data type does not match.
// (This is true despite the existence of the ESP_ERR_NVS_TYPE_MISMATCH
// error, which would seem to be the obvious correct response).
//
// Thus the solution is to exhaustively check for the key using
// each possible value type.
esp_err_t err;
{
uint8_t v;
err = nvs_get_u8(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
int8_t v;
err = nvs_get_i8(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
uint16_t v;
err = nvs_get_u16(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
nvs_iterator_t iterator = nvs_entry_find(NVS_DEFAULT_PART_NAME, key.Namespace, NVS_TYPE_ANY);
for (; iterator; iterator = nvs_entry_next(iterator))
{
int16_t v;
err = nvs_get_i16(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
uint32_t v;
err = nvs_get_u32(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
int32_t v;
err = nvs_get_i32(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
uint64_t v;
err = nvs_get_u64(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
int64_t v;
err = nvs_get_i64(handle, key.Name, &v);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
size_t sz;
err = nvs_get_str(handle, key.Name, NULL, &sz);
}
if (err == ESP_ERR_NVS_NOT_FOUND)
{
size_t sz;
err = nvs_get_blob(handle, key.Name, NULL, &sz);
}

// In the case of blob and string, ESP_ERR_NVS_INVALID_LENGTH means
// the key exists.
if (err == ESP_ERR_NVS_INVALID_LENGTH)
{
err = ESP_OK;
nvs_entry_info_t info;
nvs_entry_info(iterator, &info);
if (strcmp(info.key, key.Name) == 0)
{
nvs_release_iterator(iterator);
shubhamdp marked this conversation as resolved.
Show resolved Hide resolved
return true;
}
}

return err == ESP_OK;
return false;
}

CHIP_ERROR ESP32Config::EnsureNamespace(const char * ns)
Expand Down