Caller-allocated FTL handle binding the wrapper to the raw device. More...

#include <ra8_ftl.h>

Collaboration diagram for ra8_ftl_t:

Data Fields
const ra8_io_blockdev_t *	raw
	Underlying erase-before-write dev.
uint16_t *	map
	logical->physical map (private).
ra8_ftl_pblock_t *	pblocks
	Per-physical metadata (private).
uint8_t *	scratch
	512-byte copy scratch (private).
uint32_t	logical_blocks
	Blocks presented to FAT (private).
uint32_t	physical_blocks
	Blocks in the raw dev (private).
uint8_t	erase_value
	Raw medium erase byte (private).

Detailed Description

Caller-allocated FTL handle binding the wrapper to the raw device.

Zero-initialise (= {}) and pass to ra8_ftl_init, which validates the underlying device, records the caller-provided storage, and prepares the cold-start mapping. Treat the fields as private; drive the FTL through the ra8_ftl_* functions and the block device produced by ra8_ftl_as_blockdev. The handle, the underlying device, and all caller storage must out-live every call made through them.

Invariant: logical_blocks < physical_blocks (at least one spare block).; map has logical_blocks entries; pblocks has physical_blocks entries.

Since: 0.1.0

Definition at line 190 of file ra8_ftl.h.

Field Documentation

◆ erase_value

uint8_t ra8_ftl_t::erase_value

Raw medium erase byte (private).

Definition at line 197 of file ra8_ftl.h.

Referenced by internal_dev_get_caps(), internal_read_one(), and ra8_ftl_init().

◆ logical_blocks

uint32_t ra8_ftl_t::logical_blocks

Blocks presented to FAT (private).

Definition at line 195 of file ra8_ftl.h.

Referenced by internal_bounds(), internal_decode_commit(), internal_dev_get_caps(), internal_disjoint(), internal_encode(), internal_native_window(), internal_reset_tables(), internal_validate_header(), internal_validate_wire(), internal_wire_window(), ra8_ftl_checkpoint_size(), ra8_ftl_init(), and ra8_ftl_phys_of().

◆ map

uint16_t* ra8_ftl_t::map

logical->physical map (private).

Definition at line 192 of file ra8_ftl.h.

Referenced by internal_decode_commit(), internal_dev_erase(), internal_disjoint(), internal_encode(), internal_native_window(), internal_read_one(), internal_ready(), internal_reset_tables(), internal_write_one(), ra8_ftl_init(), and ra8_ftl_phys_of().

◆ pblocks

ra8_ftl_pblock_t* ra8_ftl_t::pblocks

Per-physical metadata (private).

Definition at line 193 of file ra8_ftl.h.

Referenced by internal_alloc_blank(), internal_decode_commit(), internal_dev_erase(), internal_disjoint(), internal_encode(), internal_native_window(), internal_pick_free(), internal_ready(), internal_reclaim_stale(), internal_reset_tables(), internal_write_one(), ra8_ftl_init(), and ra8_ftl_wear_stats().

◆ physical_blocks

uint32_t ra8_ftl_t::physical_blocks

Blocks in the raw dev (private).

Definition at line 196 of file ra8_ftl.h.

Referenced by internal_decode_commit(), internal_disjoint(), internal_encode(), internal_pick_free(), internal_reclaim_stale(), internal_reset_tables(), internal_validate_header(), internal_validate_native(), internal_validate_wire(), internal_window_mark(), ra8_ftl_checkpoint_size(), ra8_ftl_init(), and ra8_ftl_wear_stats().

◆ raw

const ra8_io_blockdev_t* ra8_ftl_t::raw

Underlying erase-before-write dev.

Definition at line 191 of file ra8_ftl.h.

Referenced by internal_alloc_blank(), internal_dev_sync(), internal_read_one(), internal_ready(), internal_reclaim_stale(), internal_write_one(), ra8_ftl_as_blockdev(), and ra8_ftl_init().

◆ scratch

uint8_t* ra8_ftl_t::scratch

512-byte copy scratch (private).

Definition at line 194 of file ra8_ftl.h.

Referenced by internal_disjoint(), internal_native_window(), internal_ready(), internal_window_mark(), internal_wire_window(), and ra8_ftl_init().

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

libs/ra8_ftl/inc/ra8_ftl.h

Data Fields