LibXR::DatabaseRawSequential Class Reference

适用于不支持逆序写入的 Flash 存储的数据库实现 Database implementation for Flash storage that does not support reverse writing. More...

#include <raw_sequential.hpp>

Inheritance diagram for LibXR::DatabaseRawSequential:

Collaboration diagram for LibXR::DatabaseRawSequential:

Public Member Functions
	DatabaseRawSequential (Flash &flash, size_t max_buffer_size=256)
	构造函数，初始化 Flash 存储和缓冲区 Constructor initializing Flash storage and buffer.
void	Init ()
	初始化数据库存储区，确保主备块正确 Initialize database storage, ensuring main and backup blocks are valid.
void	Save ()
	保存当前缓冲区内容到 Flash Save the current buffer content to Flash.
void	Load ()
	从 Flash 加载数据到缓冲区 Load data from Flash into the buffer.
void	Restore ()
	还原存储数据，清空 Flash 区域 Restore storage data, clearing Flash memory area.
ErrorCode	Get (Database::KeyBase &key) override
	获取数据库中的键值 Retrieve the key's value from the database.
ErrorCode	Set (KeyBase &key, RawData data) override
	设置数据库中的键值 Set the key's value in the database.
ErrorCode	Add (KeyBase &key) override
	添加新键到数据库 Add a new key to the database.

Detailed Description

适用于不支持逆序写入的 Flash 存储的数据库实现 Database implementation for Flash storage that does not support reverse writing.

此类管理 Flash 内存区域中的键值存储，其中数据只能顺序写入。 它维护一个备份系统，以防止数据损坏。 This class manages key-value storage in a Flash memory region where data can only be written sequentially. It maintains a backup system to prevent data corruption.

Note

若底层 Flash 读写擦失败，当前实现视为不可恢复故障并直接触发 REQUIRE。 If the underlying Flash read, write, or erase operation fails, the current implementation treats it as an unrecoverable fault and triggers REQUIRE immediately.

Definition at line 28 of file raw_sequential.hpp.

Constructor & Destructor Documentation

DatabaseRawSequential()

DatabaseRawSequential::DatabaseRawSequential ( Flash & flash, size_t max_buffer_size = 256 )

explicit

构造函数，初始化 Flash 存储和缓冲区 Constructor initializing Flash storage and buffer.

Parameters

flash	目标 Flash 存储设备 / Target Flash storage device.
max_buffer_size	最大缓冲区大小，默认 256 字节 Maximum buffer size, default is 256 bytes.

Note

包含动态内存分配。 Contains dynamic memory allocation.

max_buffer_size 必须不超过整片 Flash 容量的一半。 max_buffer_size must not exceed half of the total flash capacity.

Definition at line 11 of file raw_sequential.cpp.

    : flash_(flash), max_buffer_size_(max_buffer_size)
{
  ASSERT(flash.MinEraseSize() * 2 <= flash.Size());
  ASSERT(max_buffer_size <= flash.Size() / 2);
  auto block_num = static_cast<size_t>(flash.Size() / flash.MinEraseSize());
  block_size_ = block_num / 2 * flash.MinEraseSize();
  buffer_ = new uint8_t[max_buffer_size];
 
  Init();
}

Member Function Documentation

Add()

ErrorCode LibXR::DatabaseRawSequential::Add ( KeyBase & key )

inlineoverridevirtual

添加新键到数据库 Add a new key to the database.

Parameters

key	需要添加的键 / Key to add.

Returns

操作结果 / Operation result.

Implements LibXR::Database.

Definition at line 99 of file raw_sequential.hpp.

  {
    return AddKey(key.name_, key.raw_data_.addr_, key.raw_data_.size_);
  }

Get()

ErrorCode DatabaseRawSequential::Get ( Database::KeyBase & key )

overridevirtual

获取数据库中的键值 Retrieve the key's value from the database.

Parameters

key	需要获取的键 / Key to retrieve.

Returns

找到且记录大小与键一致时返回 ErrorCode::OK；键不存在返回 ErrorCode::NOT_FOUND；记录大小与键不一致返回 ErrorCode::FAILED Returns ErrorCode::OK if found with a matching size, ErrorCode::NOT_FOUND if the key does not exist, ErrorCode::FAILED if the stored size differs.

Implements LibXR::Database.

Definition at line 136 of file raw_sequential.cpp.

{
  auto ans = SearchKey(key.name_);
  if (!ans)
  {
    return ErrorCode::NOT_FOUND;
  }
 
  KeyInfo key_buffer;
  ReadFlashOrExit(ans, key_buffer);
 
  if (key.raw_data_.size_ != key_buffer.GetDataSize())
  {
    return ErrorCode::FAILED;
  }
 
  GetKeyData(ans, key.raw_data_);
 
  return ErrorCode::OK;
}

Init()

void DatabaseRawSequential::Init

(

)

初始化数据库存储区，确保主备块正确 Initialize database storage, ensuring main and backup blocks are valid.

Definition at line 82 of file raw_sequential.cpp.

{
  Memory::FastSet(buffer_, 0xFF, max_buffer_size_);
  FlashInfo* flash_data_ = reinterpret_cast<FlashInfo*>(buffer_);
  flash_data_->header = FLASH_HEADER;
  flash_data_->key = {0, 0, 0};
  buffer_[max_buffer_size_ - 1] = CHECKSUM_BYTE;
 
  if (!IsBlockInited(BlockType::BACKUP) || IsBlockError(BlockType::BACKUP))
  {
    InitBlock(BlockType::BACKUP);
  }
 
  if (IsBlockError(BlockType::MAIN))
  {
    if (IsBlockEmpty(BlockType::BACKUP))
    {
      InitBlock(BlockType::MAIN);
    }
    else
    {
      ReadFlashOrExit(block_size_, {buffer_, max_buffer_size_});
      EraseFlashOrExit(0, block_size_);
      WriteFlashOrExit(0, {buffer_, max_buffer_size_});
    }
  }
 
  Load();
}

Load()

void DatabaseRawSequential::Load

(

)

从 Flash 加载数据到缓冲区 Load data from Flash into the buffer.

Definition at line 121 of file raw_sequential.cpp.

{ ReadFlashOrExit(0, {buffer_, max_buffer_size_}); }

Restore()

void DatabaseRawSequential::Restore

(

)

还原存储数据，清空 Flash 区域 Restore storage data, clearing Flash memory area.

Definition at line 123 of file raw_sequential.cpp.

{
  Memory::FastSet(buffer_, 0xFF, max_buffer_size_);
  FlashInfo* flash_data_ = reinterpret_cast<FlashInfo*>(buffer_);
  flash_data_->header = FLASH_HEADER;
  flash_data_->key = {0, 0, 0};
  buffer_[max_buffer_size_ - 1] = CHECKSUM_BYTE;
  EraseFlashOrExit(0, block_size_);
  EraseFlashOrExit(block_size_, block_size_);
  WriteFlashOrExit(0, {buffer_, max_buffer_size_});
  WriteFlashOrExit(block_size_, {buffer_, max_buffer_size_});
}

Save()

void DatabaseRawSequential::Save

(

)

保存当前缓冲区内容到 Flash Save the current buffer content to Flash.

Definition at line 112 of file raw_sequential.cpp.

{
  EraseFlashOrExit(block_size_, block_size_);
  WriteFlashOrExit(block_size_, {buffer_, max_buffer_size_});
 
  EraseFlashOrExit(0, block_size_);
  WriteFlashOrExit(0, {buffer_, max_buffer_size_});
}

Set()

ErrorCode LibXR::DatabaseRawSequential::Set ( KeyBase & key, RawData data )

inlineoverridevirtual

设置数据库中的键值 Set the key's value in the database.

Parameters

key	目标键 / Target key.
data	需要存储的新值 / New value to store.

Returns

操作结果 / Operation result.

Implements LibXR::Database.

Definition at line 88 of file raw_sequential.hpp.

  {
    return SetKey(key.name_, data.addr_, data.size_);
  }

---

The documentation for this class was generated from the following files:

• src/middleware/database/raw_sequential.hpp
• src/middleware/database/raw_sequential.cpp