ra8_vmem.h

Go to the documentation of this file.

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

typedef ra8_err_t (*ra8_vmem_loader_fn)(void*    ctx,
                                        uint32_t object_id,
                                        uint64_t offset,
                                        uint8_t* frame,
                                        uint32_t frame_bytes);

typedef ra8_keycache_cell_t ra8_vmem_frame_t;

typedef struct {
  uint32_t object_id; 
  uint64_t offset;    
} ra8_vmem_key_t;

typedef struct {
  uint8_t*           frame_mem;     
  uint32_t           frame_bytes;   
  uint32_t           frame_count;   
  ra8_vmem_frame_t*  meta;          
  ra8_vmem_key_t*    keys;          
  int32_t*           buckets;       
  uint32_t           bucket_count;  
  ra8_vmem_loader_fn loader;        
  void*              loader_ctx;    
  uint8_t            protected_pct; 
} ra8_vmem_cfg_t;

typedef struct {
  ra8_vmem_cfg_t cfg;           
  ra8_keycache_t kc;            
  uint32_t       protected_cap; 
} ra8_vmem_t;

[[nodiscard]] ra8_err_t ra8_vmem_init(ra8_vmem_t* vm, const ra8_vmem_cfg_t* cfg);

[[nodiscard]] ra8_err_t
ra8_vmem_get(ra8_vmem_t* vm, uint32_t object_id, uint64_t offset, void** out_page);

[[nodiscard]] ra8_err_t ra8_vmem_put(ra8_vmem_t* vm, void* page);

[[nodiscard]] ra8_err_t ra8_vmem_prefetch(ra8_vmem_t* vm, uint32_t object_id, uint64_t offset);

[[nodiscard]] ra8_err_t ra8_vmem_stats(const ra8_vmem_t* vm,
                                       uint32_t*         out_hits,
                                       uint32_t*         out_misses,
                                       uint32_t*         out_evictions);
 
#ifdef __cplusplus
}
#endif