ra8_cs_entry_hdr_t Struct Reference

On-flash entry header at a run's first logical sector. More...

#include <ra8_cache_store_internal.h>

Data Fields
uint32_t	magic
	k_ra8_cs_entry_magic.
uint32_t	seq
	Append sequence number (monotonic).
uint32_t	key
	Content key (source CRC-32).
uint32_t	byte_len
	Payload length in bytes.
uint32_t	start_sector
	This header's own logical sector (self-anchor).
uint16_t	sector_count
	Run length (header + payload sectors).
uint16_t	flags
	Persisted flags (pinned bit).
uint32_t	hdr_crc
	CRC-32 over the six fields above.

Detailed Description

On-flash entry header at a run's first logical sector.

Written last in a put (after the payload sectors), so its presence certifies a complete append. Stores its own start_sector so a stray payload sector cannot masquerade as a header during a scan.

Invariant

hdr_crc == CRC-32 over the preceding fields; sector_count >= 1.

Since

0.1.0

Definition at line 108 of file ra8_cache_store_internal.h.

Field Documentation

byte_len

uint32_t ra8_cs_entry_hdr_t::byte_len

Payload length in bytes.

Definition at line 112 of file ra8_cache_store_internal.h.

Referenced by internal_scan_accept().

flags

uint16_t ra8_cs_entry_hdr_t::flags

Persisted flags (pinned bit).

Definition at line 115 of file ra8_cache_store_internal.h.

Referenced by internal_scan_accept().

hdr_crc

uint32_t ra8_cs_entry_hdr_t::hdr_crc

CRC-32 over the six fields above.

Definition at line 116 of file ra8_cache_store_internal.h.

Referenced by internal_hdr_read(), and internal_write_entry().

key

uint32_t ra8_cs_entry_hdr_t::key

Content key (source CRC-32).

Definition at line 111 of file ra8_cache_store_internal.h.

Referenced by internal_scan_accept().

magic

uint32_t ra8_cs_entry_hdr_t::magic

k_ra8_cs_entry_magic.

Definition at line 109 of file ra8_cache_store_internal.h.

Referenced by internal_hdr_read().

sector_count

uint16_t ra8_cs_entry_hdr_t::sector_count

Run length (header + payload sectors).

Definition at line 114 of file ra8_cache_store_internal.h.

Referenced by internal_hdr_read(), internal_scan_accept(), and internal_scan_log().

seq

uint32_t ra8_cs_entry_hdr_t::seq

Append sequence number (monotonic).

Definition at line 110 of file ra8_cache_store_internal.h.

Referenced by internal_scan_accept().

start_sector

uint32_t ra8_cs_entry_hdr_t::start_sector

This header's own logical sector (self-anchor).

Definition at line 113 of file ra8_cache_store_internal.h.

Referenced by internal_hdr_read(), and internal_scan_accept().

---

The documentation for this struct was generated from the following file:

• libs/ra8_cache_store/src/ra8_cache_store_internal.h