ra8_keycache.h

Go to the documentation of this file.

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

typedef enum : uint8_t {
  k_ra8_keycache_evict_lru  = 0U, 
  k_ra8_keycache_evict_slru = 1U, 
} ra8_keycache_evict_t;

typedef uint32_t (*ra8_keycache_hash_fn)(const void* key, uint32_t key_bytes, void* ctx);

typedef ra8_err_t (*ra8_keycache_render_fn)(void*       ctx,
                                            const void* key,
                                            uint8_t*    cell,
                                            uint32_t    cell_bytes,
                                            void*       user);

typedef struct {
  int32_t  prev;      
  int32_t  next;      
  int32_t  hash_next; 
  uint16_t pin_count; 
  uint8_t  seg;       
  uint8_t  valid;     
} ra8_keycache_cell_t;

typedef struct {
  uint8_t*               cell_mem;      
  uint32_t               cell_bytes;    
  uint32_t               cell_count;    
  uint8_t*               key_mem;       
  uint32_t               key_bytes;     
  uint8_t*               user_mem;      
  uint32_t               user_bytes;    
  ra8_keycache_cell_t*   meta;          
  int32_t*               buckets;       
  uint32_t               bucket_count;  
  ra8_keycache_render_fn render;        
  void*                  render_ctx;    
  ra8_keycache_evict_t   evict;         
  uint8_t                protected_pct; 
  ra8_keycache_hash_fn   hash;          
  void*                  hash_ctx;      
} ra8_keycache_cfg_t;

typedef struct {
  ra8_keycache_cfg_t cfg;             
  int32_t            pb_head;         
  int32_t            pb_tail;         
  int32_t            pt_head;         
  int32_t            pt_tail;         
  uint32_t           protected_count; 
  uint32_t           protected_cap;   
  uint32_t           hits;            
  uint32_t           misses;          
  uint32_t           evictions;       
} ra8_keycache_t;

typedef struct {
  uint8_t* data; 
  void*    user; 
} ra8_keycache_view_t;

[[nodiscard]] ra8_err_t ra8_keycache_init(ra8_keycache_t* kc, const ra8_keycache_cfg_t* cfg);

[[nodiscard]] ra8_err_t
ra8_keycache_get(ra8_keycache_t* kc, const void* key, ra8_keycache_view_t* out_view);

[[nodiscard]] ra8_err_t ra8_keycache_prefetch(ra8_keycache_t* kc, const void* key);

[[nodiscard]] ra8_err_t ra8_keycache_put(ra8_keycache_t* kc, const uint8_t* data);

[[nodiscard]] ra8_err_t ra8_keycache_stats(const ra8_keycache_t* kc,
                                           uint32_t*             out_hits,
                                           uint32_t*             out_misses,
                                           uint32_t*             out_evictions);
 
#ifdef __cplusplus
}
#endif