ra8_cache_store.h

Go to the documentation of this file.

#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

struct LX_NOR_FLASH_STRUCT;

typedef unsigned int (*ra8_cache_store_nor_init_fn)(struct LX_NOR_FLASH_STRUCT* nor_flash);

typedef enum : uint16_t {
  k_ra8_cache_store_sector_bytes = 512U, 
  k_ra8_cache_store_min_sectors  = 8U,   
  k_ra8_cache_store_overprov_pct = 20U,  
  k_ra8_cache_store_max_overprov = 90U,  
} ra8_cache_store_geom_t;

typedef enum : uint8_t {
  k_ra8_cache_store_flag_none   = 0U,      
  k_ra8_cache_store_flag_in_use = 1U << 0, 
  k_ra8_cache_store_flag_pinned = 1U << 1, 
} ra8_cache_store_flag_t;

typedef struct {
  uint32_t key;          
  uint32_t start_sector; 
  uint32_t byte_len;     
  uint16_t sector_count; 
  uint8_t  flags;        
  uint8_t  reserved;     
} ra8_cache_store_entry_t;

typedef struct {
  struct LX_NOR_FLASH_STRUCT* flash;           
  ra8_cache_store_entry_t*    index;           
  uint8_t*                    staging;         
  uint16_t                    index_cap;       
  uint16_t                    checkpoint_dirs; 
  uint32_t                    logical_sectors; 
  uint32_t                    log_start;       
  uint32_t                    data_capacity;   
  uint32_t                    live_sectors;    
  uint32_t                    next_seq;        
  uint8_t                     flash_state;     
  bool                        inited;          
} ra8_cache_store_t;

typedef struct {
  const ra8_cache_store_t* store;        
  uint32_t                 data_start;   
  uint32_t                 data_sectors; 
  uint32_t                 byte_len;     
} ra8_cache_store_reader_t;

typedef struct {
  struct LX_NOR_FLASH_STRUCT* nor_flash;         
  ra8_cache_store_nor_init_fn nor_driver_init;   
  const char*                 name;              
  ra8_cache_store_entry_t*    index;             
  uint8_t*                    staging;           
  uint32_t                    staging_bytes;     
  uint32_t                    logical_sectors;   
  uint16_t                    index_cap;         
  uint8_t                     overprovision_pct; 
  bool                        format;            
} ra8_cache_store_cfg_t;

[[nodiscard]] ra8_err_t ra8_cache_store_init(ra8_cache_store_t*           store,
                                             const ra8_cache_store_cfg_t* cfg);

[[nodiscard]] ra8_err_t
ra8_cache_store_put(ra8_cache_store_t* store, uint32_t key, const uint8_t* data, uint32_t len);

[[nodiscard]] ra8_err_t ra8_cache_store_get(const ra8_cache_store_t*  store,
                                            uint32_t                  key,
                                            ra8_cache_store_reader_t* out_reader);

ra8_err_t ra8_cache_store_read(void* ctx, uint64_t offset, uint8_t* buf, uint32_t len);

[[nodiscard]] ra8_err_t ra8_cache_store_evict(ra8_cache_store_t* store, uint32_t key);

[[nodiscard]] ra8_err_t ra8_cache_store_pin(ra8_cache_store_t* store, uint32_t key, bool pin);

[[nodiscard]] ra8_err_t ra8_cache_store_sync(ra8_cache_store_t* store);

[[nodiscard]] ra8_err_t ra8_cache_store_close(ra8_cache_store_t* store);
 
#ifdef __cplusplus
}
#endif