ra8-firmware/ra8__vmem__stream_8h_source.html

#pragma once


#ifdef __cplusplus

extern "C" {

#endif


#include <stddef.h>

#include <stdint.h>


#include "ra8_err.h"

#include "ra8_vmem.h"


typedef struct {

  ra8_vmem_t* vm;

  uint32_t    object_id;

  uint32_t    frame_bytes;

  uint64_t    size;

} ra8_vmem_stream_t;


[[nodiscard]] ra8_err_t

ra8_vmem_stream_init(ra8_vmem_stream_t* st, ra8_vmem_t* vm, uint32_t object_id, uint64_t size);


size_t ra8_vmem_stream_read(void* ctx, uint64_t offset, void* buf, size_t len);


#ifdef __cplusplus

}

#endif

ra8_err.h
Error Code Definitions for ra8-firmware.

ra8_err_t
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546

ra8_vmem.h
Byte-range page cache with SLRU eviction (Layer 2, #147).

ra8_vmem_stream_init
ra8_err_t ra8_vmem_stream_init(ra8_vmem_stream_t *st, ra8_vmem_t *vm, uint32_t object_id, uint64_t size)
Bind a page-cached paged object to the byte-stream reader.
Definition ra8_vmem_stream.c:33

ra8_vmem_stream_read
size_t ra8_vmem_stream_read(void *ctx, uint64_t offset, void *buf, size_t len)
Read len bytes at absolute offset through the page cache.
Definition ra8_vmem_stream.c:51

ra8_vmem_stream_t
Binds one page-cached object to the byte-stream read adapter.
Definition ra8_vmem_stream.h:59

ra8_vmem_stream_t::object_id
uint32_t object_id
Paged object id registered in the cache's source.
Definition ra8_vmem_stream.h:61

ra8_vmem_stream_t::vm
ra8_vmem_t * vm
Initialised page cache (fixed pool = RAM budget).
Definition ra8_vmem_stream.h:60

ra8_vmem_stream_t::size
uint64_t size
Object length in bytes.
Definition ra8_vmem_stream.h:63

ra8_vmem_stream_t::frame_bytes
uint32_t frame_bytes
Cache frame size, cached from vm->cfg at init.
Definition ra8_vmem_stream.h:62

ra8_vmem_t
Page-cache state (caller-owned; treat as private).
Definition ra8_vmem.h:179