xroad_storage.h

Go to the documentation of this file.

 
#pragma once
 
#include "xroad_storage_fwd.h"
#include <common/xroad_common_fwd.h>
#include <common/xroad_common_types.h>
#include <common/xroad_string.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum
{
   xroad_storage_flags_zero_space    = 1, 
   xroad_storage_flags_memory_locked = 2, 
   xroad_storage_flags_debug         = 4, 
   xroad_storage_flags_clear         = 8  
} xroad_storage_flags_t;
 
xroad_errno_t xroad_storage_create(uint32_t id, xroad_str_t path, uint32_t row_size, size_t rows_at_page,
      size_t heap_page_size, uint32_t flags);
 
void xroad_storage_destroy(xroad_storage_t* storage);
 
const xroad_storage_info_t* xroad_storage_get_info(xroad_storage_t* storage);
 
xroad_storage_stat_t xroad_storage_get_stat(xroad_storage_t* storage);
 
xroad_str_t xroad_storage_get_err();
 
xroad_str_t xroad_storage_get_name(xroad_storage_t* storage);
 
xroad_storage_t* xroad_storage_open(xroad_str_t path, uint32_t row_size);
 
xroad_errno_t xroad_storage_resize(xroad_storage_t* storage, uint32_t row_size);
 
xroad_errno_t xroad_storage_drop(xroad_str_t path);
 
xroad_errno_t xroad_storage_clear(xroad_storage_t* storage, bool force);
 
void* xroad_storage_create_row(xroad_storage_t* storage, xroad_row_id_t* id);
 
void* xroad_storage_get_row(xroad_storage_t* storage, xroad_row_id_t row_id);
 
xroad_cursor_t* xroad_storage_create_cursor(xroad_storage_t* storage);
 
void xroad_storage_destroy_cursor(xroad_cursor_t* cursor);
 
void* xroad_storage_cursor_get_next(xroad_cursor_t* cursor);
void* xroad_storage_cursor_get_prev(xroad_cursor_t* cursor);
void* xroad_storage_cursor_get_first(xroad_cursor_t* cursor);
void* xroad_storage_cursor_get_last(xroad_cursor_t* cursor);
 
void* xroad_storage_cursor_offset(xroad_cursor_t* cursor, int64_t offset);
 
void* xroad_storage_copy_row(xroad_storage_t* storage, xroad_row_id_t from, xroad_row_id_t to);
 
#define xroad_storage_heap_alloc(storage, sz, data, ...) \
   xroad_storage_heap_alloc_va(storage, sz, data, ##__VA_ARGS__ , 0)
 
storage_heap_ref_t xroad_storage_heap_alloc_va(
      xroad_storage_t* storage, uint32_t sz, storage_heap_data_t* data, ...) __nonnull((1));
 
xroad_errno_t xroad_storage_heap_free(xroad_storage_t* storage, storage_heap_ref_t ref);
 
#define xroad_storage_heap_realloc(storage, ref, sz, data, ...) \
   xroad_storage_heap_realloc_va(storage, ref, sz, data, ##__VA_ARGS__ ,0)
 
storage_heap_ref_t xroad_storage_heap_realloc_va(
      xroad_storage_t* storage, uint64_t ref, uint32_t sz, storage_heap_data_t* data, ...) __nonnull((1));
 
storage_heap_data_t xroad_storage_heap_get(xroad_storage_t* storage, storage_heap_ref_t ref) __nonnull((1));
 
xroad_errno_t xroad_storage_check_deadlock(xroad_storage_t* storage, bool force_unlock);
 
xroad_errno_t xroad_storage_verify(xroad_str_t path, bool dump_heap);
 
xroad_errno_t xroad_storage_add_page(xroad_storage_t* storage, xroad_storage_page_type_t ptype);
 
#ifdef __cplusplus
}
#endif