sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-10-31 07:03:55 +00:00
Code Issues Releases Wiki Activity

[esp8266] Reduce preference memory usage by 40% through field optimization (#10557)

Browse Source
This commit is contained in:
J. Nick Koston
2025-09-04 02:46:50 -05:00
committed by GitHub
parent 8fb6420b1c
commit 101d553df9
1 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
esphome/components/esp8266/preferences.cpp
View File

@@ -1,6 +1,7 @@
#ifdef USE_ESP8266 #ifdef USE_ESP8266
#include <c_types.h> #include <c_types.h>
#include <cinttypes>
extern "C" { extern "C" {
#include "spi_flash.h" #include "spi_flash.h"
} }
@@ -119,16 +120,16 @@ static bool load_from_rtc(size_t offset, uint32_t *data, size_t len) {
class ESP8266PreferenceBackend : public ESPPreferenceBackend { class ESP8266PreferenceBackend : public ESPPreferenceBackend {
public: public:
size_t offset = 0;
uint32_t type = 0; uint32_t type = 0;
uint16_t offset = 0;
uint8_t length_words = 0; // Max 255 words (1020 bytes of data)
bool in_flash = false; bool in_flash = false;
size_t length_words = 0;
bool save(const uint8_t *data, size_t len) override { bool save(const uint8_t *data, size_t len) override {
if (bytes_to_words(len) != length_words) { if (bytes_to_words(len) != length_words) {
return false; return false;
} }
size_t buffer_size = length_words + 1; size_t buffer_size = static_cast<size_t>(length_words) + 1;
std::unique_ptr<uint32_t[]> buffer(new uint32_t[buffer_size]()); // Note the () for zero-initialization std::unique_ptr<uint32_t[]> buffer(new uint32_t[buffer_size]()); // Note the () for zero-initialization
memcpy(buffer.get(), data, len); memcpy(buffer.get(), data, len);
buffer[length_words] = calculate_crc(buffer.get(), buffer.get() + length_words, type); buffer[length_words] = calculate_crc(buffer.get(), buffer.get() + length_words, type);
@@ -142,7 +143,7 @@ class ESP8266PreferenceBackend : public ESPPreferenceBackend {
if (bytes_to_words(len) != length_words) { if (bytes_to_words(len) != length_words) {
return false; return false;
} }
size_t buffer_size = length_words + 1; size_t buffer_size = static_cast<size_t>(length_words) + 1;
std::unique_ptr<uint32_t[]> buffer(new uint32_t[buffer_size]()); std::unique_ptr<uint32_t[]> buffer(new uint32_t[buffer_size]());
bool ret = in_flash ? load_from_flash(offset, buffer.get(), buffer_size) bool ret = in_flash ? load_from_flash(offset, buffer.get(), buffer_size)
: load_from_rtc(offset, buffer.get(), buffer_size); : load_from_rtc(offset, buffer.get(), buffer_size);
@@ -176,15 +177,19 @@ class ESP8266Preferences : public ESPPreferences {
ESPPreferenceObject make_preference(size_t length, uint32_t type, bool in_flash) override { ESPPreferenceObject make_preference(size_t length, uint32_t type, bool in_flash) override {
uint32_t length_words = bytes_to_words(length); uint32_t length_words = bytes_to_words(length);
if (length_words > 255) {
ESP_LOGE(TAG, "Preference too large: %" PRIu32 " words > 255", length_words);
return {};
}
if (in_flash) { if (in_flash) {
uint32_t start = current_flash_offset; uint32_t start = current_flash_offset;
uint32_t end = start + length_words + 1; uint32_t end = start + length_words + 1;
if (end > ESP8266_FLASH_STORAGE_SIZE) if (end > ESP8266_FLASH_STORAGE_SIZE)
return {}; return {};
auto *pref = new ESP8266PreferenceBackend(); // NOLINT(cppcoreguidelines-owning-memory) auto *pref = new ESP8266PreferenceBackend(); // NOLINT(cppcoreguidelines-owning-memory)
pref->offset = start; pref->offset = static_cast<uint16_t>(start);
pref->type = type; pref->type = type;
pref->length_words = length_words; pref->length_words = static_cast<uint8_t>(length_words);
pref->in_flash = true; pref->in_flash = true;
current_flash_offset = end; current_flash_offset = end;
return {pref}; return {pref};
@@ -210,9 +215,9 @@ class ESP8266Preferences : public ESPPreferences {
uint32_t rtc_offset = in_normal ? start + 32 : start - 96; uint32_t rtc_offset = in_normal ? start + 32 : start - 96;
auto *pref = new ESP8266PreferenceBackend(); // NOLINT(cppcoreguidelines-owning-memory) auto *pref = new ESP8266PreferenceBackend(); // NOLINT(cppcoreguidelines-owning-memory)
pref->offset = rtc_offset; pref->offset = static_cast<uint16_t>(rtc_offset);
pref->type = type; pref->type = type;
pref->length_words = length_words; pref->length_words = static_cast<uint8_t>(length_words);
pref->in_flash = false; pref->in_flash = false;
current_offset += length_words + 1; current_offset += length_words + 1;
return pref; return pref;