region_format.h

Go to the documentation of this file.

#ifndef LIBCLOD_REGION_FORMAT_H
#define LIBCLOD_REGION_FORMAT_H
 
#include <clod/lib.h>
#include <stddef.h>
#include <stdint.h>
 

typedef bool clod_rfmt_file_sync(size_t size, void *user);
 
struct clod_rfmt;
struct clod_rfmt_opts;

enum clod_rfmt_result {
    CLOD_RFMT_OK = 0,
    CLOD_RFMT_ALLOCATION_FAILURE = 1,
    CLOD_RFMT_TIMEOUT = 2,
    CLOD_RFMT_OTHER = 3,
    CLOD_RFMT_INVALID = 4,
    CLOD_RFMT_MISUSE = 5,
    CLOD_RFMT_OTHER_MISUSE = 6,
    CLOD_RFMT_FILE_MANAGE_ERROR = 7,
    CLOD_RFMT_FILE_SYNC_ERROR = 8
};

struct clod_rfmt_opts {
    uint32_t dead_lock_timeout_ms;

    bool (*file_manage)(uint8_t **data, size_t *size, const size_t *new_size, void *user);

    bool (*file_sync)(size_t size, void *user);

    void *(*malloc_func)(size_t size, void *user);

    void (*free_func)(void *ptr, void *user);

    void *user;
};

CLOD_API CLOD_NONNULL(1, 2, 3)
enum clod_rfmt_result clod_rfmt_init_new(
    struct clod_rfmt **rfmt_out,
    struct clod_rfmt_opts *opts,
    char *chunk_filename_prefix,
    char *chunk_filename_extension,
    uint32_t sector_size
);

CLOD_API CLOD_NONNULL(1)
enum clod_rfmt_result clod_rfmt_init_rw(struct clod_rfmt **rfmt_out, struct clod_rfmt_opts *opts);

CLOD_API CLOD_NONNULL(1)
enum clod_rfmt_result clod_rfmt_init_ro(struct clod_rfmt **rfmt_out, struct clod_rfmt_opts *opts);

CLOD_API CLOD_NONNULL(1)
enum clod_rfmt_result clod_rfmt_free(struct clod_rfmt *rfmt);
 
CLOD_API CLOD_NONNULL(1)
enum clod_rfmt_result clod_rfmt_lock_acquire(struct clod_rfmt *rfmt, uint32_t index);
 
CLOD_API CLOD_NONNULL(1)
enum clod_rfmt_result clod_rfmt_lock_refresh(struct clod_rfmt *rfmt, uint32_t index);

#endif