ra8_cache_store_internal.h

Go to the documentation of this file.

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

typedef enum : uint32_t {
  k_ra8_cs_super_magic    = 0x52435331U, 
  k_ra8_cs_entry_magic    = 0x52435345U, 
  k_ra8_cs_format_version = 1U,          
  k_ra8_cs_dir_ent_bytes  = 16U,         
  k_ra8_cs_dir_per_sector = 32U,         
  k_ra8_cs_crc32_poly     = 0xEDB88320U, 
  k_ra8_cs_crc32_seed     = 0xFFFFFFFFU, 
} ra8_cs_media_const_t;

typedef enum : uint32_t {
  k_ra8_cs_dirty = 0U, 
  k_ra8_cs_clean = 1U, 
} ra8_cs_clean_t;

typedef struct {
  uint32_t magic;           
  uint32_t version;         
  uint32_t seq;             
  uint32_t clean;           
  uint32_t entry_count;     
  uint32_t live_sectors;    
  uint32_t next_seq;        
  uint32_t log_start;       
  uint32_t data_capacity;   
  uint32_t logical_sectors; 
  uint32_t crc;             
} ra8_cs_super_t;

typedef struct {
  uint32_t magic;        
  uint32_t seq;          
  uint32_t key;          
  uint32_t byte_len;     
  uint32_t start_sector; 
  uint16_t sector_count; 
  uint16_t flags;        
  uint32_t hdr_crc;      
} ra8_cs_entry_hdr_t;

typedef struct {
  uint32_t key;          
  uint32_t start_sector; 
  uint32_t byte_len;     
  uint16_t sector_count; 
  uint16_t flags;        
} ra8_cs_dir_ent_t;
 
static_assert(sizeof(ra8_cs_dir_ent_t) == (uint32_t)k_ra8_cs_dir_ent_bytes,
              "directory entry layout pinned at 16 bytes");
static_assert(sizeof(ra8_cs_entry_hdr_t) <= (uint32_t)k_ra8_cache_store_sector_bytes,
              "entry header must fit one sector");
static_assert(sizeof(ra8_cs_super_t) <= (uint32_t)k_ra8_cache_store_sector_bytes,
              "superblock must fit one sector");

RA8_PRIV uint32_t priv_cache_store_crc32(const uint8_t* data, uint32_t len);

RA8_PRIV ra8_err_t priv_cache_store_sector_read(const ra8_cache_store_t* store,
                                                uint32_t                 sector,
                                                uint8_t*                 out512);

RA8_PRIV ra8_err_t priv_cache_store_sector_write(ra8_cache_store_t* store,
                                                 uint32_t           sector,
                                                 const uint8_t*     in512);

RA8_PRIV ra8_err_t priv_cache_store_sector_release(ra8_cache_store_t* store, uint32_t sector);

RA8_PRIV int32_t priv_cache_store_index_find(const ra8_cache_store_t* store, uint32_t key);

RA8_PRIV int32_t priv_cache_store_index_add(ra8_cache_store_t* store,
                                            uint32_t           key,
                                            uint32_t           start_sector,
                                            uint16_t           sector_count,
                                            uint32_t           byte_len,
                                            bool               pinned);

RA8_PRIV ra8_err_t priv_cache_store_super_write(ra8_cache_store_t* store, uint32_t clean);

RA8_PRIV ra8_err_t priv_cache_store_dir_save(ra8_cache_store_t* store, uint32_t* out_entry_count);
 
#ifdef __cplusplus
}
#endif