buffer.h

Go to the documentation of this file.

#pragma once
#include <ascii-chat/buffer/budget.h>
 
#include <ascii-chat/asciichat_errno.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

typedef struct buffer_domain buffer_domain_t;
 
#define BUFFER_DEFAULT_ALIGNMENT 64u
#define BUFFER_PROCESS_LIMIT ((size_t)512 * 1024 * 1024)
#define BUFFER_CONTROL_RESERVE ((size_t)8 * 1024 * 1024)
#define BUFFER_DOMAIN_LIMIT (BUFFER_PROCESS_LIMIT - BUFFER_CONTROL_RESERVE)
 
typedef struct {
  size_t limit_bytes; 
  size_t cache_bytes; 
  uint64_t idle_ns;   
  bool control;       
} buffer_domain_config_t;
 
typedef struct {
  size_t reserved_bytes;
  size_t live_bytes;
  size_t requested_bytes;
  size_t cached_bytes;
  size_t peak_bytes;
  size_t outstanding;
  uint64_t hits;
  uint64_t allocations;
  uint64_t failures;
} buffer_stats_t;

asciichat_error_t buffer_domain_create(const buffer_domain_config_t *config, buffer_domain_t **out);
void buffer_domain_close(buffer_domain_t **domain);
void buffer_domain_trim(buffer_domain_t *domain);
void buffer_domain_stats(buffer_domain_t *domain, buffer_stats_t *out);
void buffer_domain_log_stats(buffer_domain_t *domain, const char *name);
size_t buffer_process_reserved(void);

asciichat_error_t buffer_budget_reserve(buffer_budget_t *budget, size_t bytes);
void buffer_budget_release(buffer_budget_t *budget);

asciichat_error_t buffer_acquire(buffer_domain_t *domain, size_t size, size_t alignment, void **out);
void *buffer_alloc(buffer_domain_t *domain, size_t size);
size_t buffer_capacity(const void *data);
size_t buffer_size(const void *data);
asciichat_error_t buffer_set_size(void *data, size_t size);
const void *buffer_share(const void *data);
bool buffer_is_unique(const void *data);
void buffer_unref(const void *data);
#define buffer_release(data)                                                                                           \
  do {                                                                                                                 \
    __typeof__(&(data)) buffer_slot__ = &(data);                                                                       \
    buffer_unref(*buffer_slot__);                                                                                      \
    *buffer_slot__ = NULL;                                                                                             \
  } while (0)

typedef struct {
  void *data;
  size_t length;
} buffer_workspace_t;

asciichat_error_t buffer_workspace_reserve(buffer_workspace_t *workspace, buffer_domain_t *domain, size_t capacity);
void buffer_workspace_destroy(buffer_workspace_t *workspace);

void buffer_system_init(void);
void buffer_system_cleanup(void);
buffer_domain_t *buffer_default_domain(void);
buffer_domain_t *buffer_control_domain(void);