Skip to content

Commit

Permalink
Fix provisioning (#110)
Browse files Browse the repository at this point in the history 
* Refactor NVS implementation to avoid UB
  • Loading branch information
@Barabas5532
Barabas5532 authored Feb 1, 2024
1 parent c2d9183 commit 1ae7b44
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 167 deletions.
84 changes: 26 additions & 58 deletions firmware/components/esp_persistence/include/esp_crud.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,27 +58,30 @@ class EspCrud final : public persistence::Crud<std::span<uint8_t>>
: part_name{a_part_name},
namespace_name{a_namespace_name}
{
ESP_ERROR_CHECK(nvs_open(namespace_name, NVS_READWRITE, &nvs_handle));

ESP_LOGI(TAG,
"Started EspCrud for partition %s namespace %s with handle "
"%" PRIu32,
part_name,
namespace_name,
nvs_handle);
}

~EspCrud() final { nvs_close(nvs_handle); }

[[nodiscard]] int create(const std::span<uint8_t> &data,
uint32_t &id_out) override
{
nvs_handle_t nvs_handle;
esp_err_t err;
int rc = -1;

// start at 0 in case last ID has not been saved to NVS
uint32_t id = 0;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_open(namespace_name, NVS_READWRITE, &nvs_handle));
if(err != ESP_OK)
goto out;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_get_u32(nvs_handle, last_id_name, &id));
if(err != ESP_OK && err != ESP_ERR_NVS_NOT_FOUND)
goto out;
return -1;

id++;
id_out = id;
Expand All @@ -87,123 +90,87 @@ class EspCrud final : public persistence::Crud<std::span<uint8_t>>
err = nvs_set_blob(
nvs_handle, id_to_key(id).c_str(), data.data(), data.size()));
if(err != ESP_OK)
goto out;
return -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_set_u32(nvs_handle, last_id_name, id));
if(err != ESP_OK && err != ESP_ERR_NVS_NOT_FOUND)
goto out;
return -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(err = nvs_commit(nvs_handle));
if(err != ESP_OK)
goto out;
return -1;

rc = 0;

out:
nvs_close(nvs_handle);
return rc;
return 0;
}

/// \return non-zero on error
[[nodiscard]] int read(uint32_t id, std::span<uint8_t> &buffer) override
{
nvs_handle_t nvs_handle;
esp_err_t err;
std::size_t required_size = 0;
int rc = -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_open(namespace_name, NVS_READONLY, &nvs_handle));
if(err != ESP_OK)
goto out;

// query the required size
ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_get_blob(
nvs_handle, id_to_key(id).c_str(), nullptr, &required_size));
if(err != ESP_OK)
goto out;
return -1;

if(required_size > buffer.size())
{
ESP_LOGE(TAG,
"Not enough space in the output buffer. Need %zu, got %zu",
required_size,
buffer.size());
goto out;
return -1;
}

ESP_ERROR_CHECK_WITHOUT_ABORT(err = nvs_get_blob(nvs_handle,
id_to_key(id).c_str(),
buffer.data(),
&required_size));
if(err != ESP_OK)
goto out;
return -1;

buffer = buffer.subspan(0, required_size);
rc = 0;
out:
nvs_close(nvs_handle);
return rc;
return 0;
};

/// \return non-zero on error
[[nodiscard]] int update(uint32_t id,
const std::span<uint8_t> &data) override
{
nvs_handle_t nvs_handle;
esp_err_t err;
int rc = -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_open(namespace_name, NVS_READWRITE, &nvs_handle));
if(err != ESP_OK)
goto out;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_set_blob(
nvs_handle, id_to_key(id).c_str(), data.data(), data.size()));
if(err != ESP_OK)
goto out;
return -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(err = nvs_commit(nvs_handle));
if(err != ESP_OK)
goto out;

rc = 0;
return -1;

out:
nvs_close(nvs_handle);
return rc;
return 0;
};

/// \return non-zero on error
[[nodiscard]] int destroy(uint32_t id) override
{
nvs_handle_t nvs_handle;
esp_err_t err;
int rc = -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_open(namespace_name, NVS_READWRITE, &nvs_handle));
if(err != ESP_OK)
goto out;

ESP_ERROR_CHECK_WITHOUT_ABORT(
err = nvs_erase_key(nvs_handle, id_to_key(id).c_str()));
if(err != ESP_OK)
goto out;
return -1;

ESP_ERROR_CHECK_WITHOUT_ABORT(err = nvs_commit(nvs_handle));
if(err != ESP_OK)
goto out;

rc = 0;
return -1;

out:
nvs_close(nvs_handle);
return rc;
return 0;
};

void for_each(etl::delegate<void(uint32_t, const std::span<uint8_t> &)>
Expand Down Expand Up @@ -401,6 +368,7 @@ class EspCrud final : public persistence::Crud<std::span<uint8_t>>

const char *const part_name;
const char *const namespace_name;
nvs_handle_t nvs_handle = 0;

static constexpr char last_id_name[] = "last_id";
static constexpr char TAG[] = "esp_crud";
Expand Down
9 changes: 8 additions & 1 deletion firmware/components/esp_persistence/include/esp_persistence.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#pragma once

#include "persistence.h"
#include <nvs.h>

namespace shrapnel::persistence {

Expand All @@ -30,15 +31,21 @@ namespace shrapnel::persistence {
class EspStorage final : public Storage
{
public:
EspStorage();
~EspStorage();

[[nodiscard]] int save(const char *key, std::span<uint8_t> data) override;
[[nodiscard]] int save(const char *key, etl::string_view data) override;
[[nodiscard]] int save(const char *key, uint32_t data) override;
[[nodiscard]] virtual int save(const char *key, float data) override;
[[nodiscard]] int save(const char *key, float data) override;

[[nodiscard]] int load(const char *key, std::span<uint8_t> &data) override;
[[nodiscard]] int load(const char *key, etl::istring &data) override;
[[nodiscard]] int load(const char *key, uint32_t &data) override;
[[nodiscard]] int load(const char *key, float &data) override;

private:
nvs_handle_t nvs_handle = 0;
};

} // namespace shrapnel::persistence
Loading

0 comments on commit 1ae7b44

Please sign in to comment.