store_interface.h

Go to the documentation of this file.

 
 
#ifndef VOLK_STORE_INTERFACE_H
#define VOLK_STORE_INTERFACE_H
 
#include "volksdata/buffer.h"
 


typedef enum {
    VOLK_STORE_PERM     = 1<<0,   
 
    VOLK_STORE_CTX      = 1<<1,   
 
    VOLK_STORE_IDX      = 1<<2,   
 
    VOLK_STORE_TXN      = 1<<3,   
 
    VOLK_STORE_COW      = 1<<4,   
 
    VOLK_STORE_EMBED    = 1<<5,   
} VOLK_StoreFeature;
 

typedef enum {
    VOLK_STORE_TXN_RO     = 1<<0, 
} VOLK_StoreFlags;
 
 
/*
 * Store function types.
 */

typedef VOLK_rc (*store_setup_fn_t)(const char *id, bool clear);
 

typedef void * (*store_new_fn_t)(const char *id, size_t size);
 

typedef void (*store_free_fn_t)(void *store);
 

typedef size_t (*store_size_fn_t)(const void *store);
 

typedef char * (*store_id_fn_t)(const void *store);
 
 
#if 0
typedef VOLK_rc (*store_stat_fn_t)(void *store, void *stat);
#endif
 

typedef VOLK_rc (*store_txn_begin_fn_t)(
        void *store, VOLK_StoreFlags flags, void **txn);
 

typedef VOLK_rc (*store_txn_commit_fn_t)(void *txn);
 

typedef void (*store_txn_abort_fn_t)(void *txn);
 

typedef VOLK_rc (*store_update_ctx_fn_t)(
        void *store, const VOLK_Buffer *old_c, const VOLK_Buffer *new_c,
        void *udata);
 

typedef void * (*store_add_init_fn_t)(
        void *store, const VOLK_Buffer *sc, void *udata);
 

typedef VOLK_rc (*store_add_iter_fn_t)(
        void *it, const VOLK_BufferTriple * sspo);
 

typedef void (*store_add_abort_fn_t)(void *it);
 

typedef VOLK_rc (*store_add_done_fn_t)(void *it);
 

typedef VOLK_rc (*store_add_term_fn_t)(
        void *store, const VOLK_Buffer *sterm, void *udata);
 
 
/*
 * Iterator function types.
 */

typedef void * (*store_lookup_fn_t)(
        void *store,
        const VOLK_Buffer *ss, const VOLK_Buffer *sp, const VOLK_Buffer *so,
        const VOLK_Buffer *sc, void *udata, size_t *ct);
 

typedef bool (*store_trp_exist_fn_t)(
        void *store, const VOLK_BufferTriple *sspo, const VOLK_Buffer *sc);
 

typedef VOLK_rc (*iter_next_fn_t)(
        void *it, VOLK_BufferTriple *sspo, VOLK_Buffer **ctx);
 

typedef void (*iter_free_fn_t)(void * it);
 

typedef void * (*iter_txn_fn_t)(void *it);
 

typedef VOLK_rc (*store_remove_fn_t)(
        void *store,
        const VOLK_Buffer *ss, const VOLK_Buffer *sp, const VOLK_Buffer *so,
        const VOLK_Buffer *sc, void *udata, size_t *ct);
 

typedef VOLK_Buffer ** (*store_ctx_list_fn_t)(void *store, void *txn);
 
 
 
/*
 * Iterface type definitions.
 */

typedef struct store_if_t {
    // Basic properties.
    char                name[16];       
    VOLK_StoreFeature   features;       
 
    // Allocation, setup and deallocation.
    store_setup_fn_t    setup_fn;       
    store_new_fn_t      new_fn;         
    store_free_fn_t     free_fn;        
 
    // Metadata.
    store_size_fn_t     size_fn;        
    store_id_fn_t       id_fn;          
 
    // Transaction control.
    store_txn_begin_fn_t txn_begin_fn;  
    store_txn_commit_fn_t txn_commit_fn; 
    store_txn_abort_fn_t txn_abort_fn;  
 
    //Context setting.
    store_update_ctx_fn_t update_ctx_fn; 
 
    // Addition.
    store_add_init_fn_t add_init_fn;    
    store_add_iter_fn_t add_iter_fn;    
    store_add_abort_fn_t add_abort_fn;  
    store_add_done_fn_t add_done_fn;    
    store_add_term_fn_t add_term_fn;    
 
    // Look up.
    store_lookup_fn_t   lookup_fn;      
    //store_trp_exist_fn_t exist_fn;      ///< Check if a triple exists.
    iter_next_fn_t      lu_next_fn;     
    iter_free_fn_t      lu_free_fn;     
    iter_txn_fn_t       iter_txn_fn;    
 
    // Removal.
    store_remove_fn_t   remove_fn;      
 
    // Context.
    store_ctx_list_fn_t ctx_list_fn;    
} VOLK_StoreInt;
 
 
/*
 * Template for a new store and iterator implementation.
 * These should be placed in the .c file where the interface functions are
 * defined, and declared as `extern` in the related .h file.
 
const VOLK_StoreInt my_store_int = {
    .name           = "My Store", // Truncated to 15 chars.
    .features       = VOLK_STORE_PERM | VOLK_STORE_IDX,
 
    .setup_fn       = my_setup_fn,
    .new_fn         = my_new_fn,
    .free_fn        = my_free_fn,
 
    .size_fn        = my_size_fn,
    .id_fn          = my_id_fn,
 
    .txn_begin_fn   = my_txn_begin_fn,
    .txn_commit_fn  = my_txn_commit_fn,
    .txn_abort_fn   = my_txn_abort_fn,
 
    .ctx_update_fn  = my_ctx_update_fn,
 
    .add_init_fn    = my_init_fn,
    .add_iter_fn    = my_iter_fn,
    .add_abort_fn   = my_add_abort_fn,
    .add_done_fn    = my_add_done_fn,
    .add_term_fn    = my_add_term_fn,
 
    .lookup_fn      = my_lookup_fn,
    .lu_next_fn     = my_iter_next_fn,
    .lu_free_fn     = my_iter_free_fn,
    .iter_txn_fn    = my_iter_txn_fn,
 
    .remove_fn      = my_remove_fn,
 
    .ctx_list_fn   = my_ctx_list_fn,
};
*/

 
#endif  // VOLK_STORE_INTERFACE_H