ra8_decomp_limits.h

Go to the documentation of this file.

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

typedef enum : uint64_t {
  k_ra8_decomp_def_output_bytes = 64ULL * 1024ULL * 1024ULL, 
  k_ra8_decomp_def_max_ratio    = 1024U,                     
  k_ra8_decomp_def_ratio_grace  = 64U * 1024U,               
  k_ra8_decomp_def_max_entries  = 4096U,                     
  k_ra8_decomp_def_max_iters    = 1048576U,                  
  k_ra8_decomp_def_max_depth    = 2U,                        
} ra8_decomp_defaults_t;

typedef struct {
  uint64_t max_output_bytes;  
  uint32_t max_ratio;         
  uint32_t ratio_grace_bytes; 
  uint32_t max_entries;       
  uint32_t max_iterations;    
  uint8_t  max_depth;         
} ra8_decomp_limits_t;

typedef struct {
  ra8_decomp_limits_t limits;    
  uint64_t            out_bytes; 
  uint64_t            in_bytes;  
  uint32_t            entries;   
  uint32_t            iters;     
  uint8_t             depth;     
} ra8_decomp_budget_t;

[[nodiscard]] ra8_decomp_limits_t ra8_decomp_limits_default(void);

[[nodiscard]] ra8_err_t ra8_decomp_budget_init(ra8_decomp_budget_t*       b,
                                               const ra8_decomp_limits_t* limits);

[[nodiscard]] ra8_err_t
ra8_decomp_budget_charge_output(ra8_decomp_budget_t* b, uint64_t in_total, uint64_t out_delta);

[[nodiscard]] ra8_err_t ra8_decomp_budget_charge_entry(ra8_decomp_budget_t* b);

[[nodiscard]] ra8_err_t ra8_decomp_budget_charge_iter(ra8_decomp_budget_t* b);

[[nodiscard]] ra8_err_t ra8_decomp_budget_enter(ra8_decomp_budget_t* b);

void ra8_decomp_budget_leave(ra8_decomp_budget_t* b);

[[nodiscard]] ra8_err_t
ra8_decomp_check_declared(const ra8_decomp_limits_t* limits, uint64_t comp_size, uint64_t out_size);

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

[[nodiscard]] ra8_err_t
ra8_decomp_zip_entry_preflight(ra8_decomp_read_fn read, void* ctx, uint64_t archive_size);
 
#ifdef __cplusplus
}
#endif