git.sur5r.net Git - openldap/blob - libraries/libmdb/mdb.h

   1 #ifndef _MDB_H_
   2 #define _MDB_H_
   3
   4 #include <sys/types.h>
   5
   6 struct MDB_cursor;
   7 struct MDB_txn;
   8 struct MDB_env;
   9
  10 typedef struct MDB_cursor MDB_cursor;
  11 typedef struct MDB_txn MDB_txn;
  12 typedef struct MDB_env MDB_env;
  13
  14 typedef unsigned int    MDB_dbi;
  15
  16 typedef struct MDB_val {
  17         void            *mv_data;
  18         size_t           mv_size;
  19 } MDB_val;
  20
  21 typedef int  (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
  22 typedef void (MDB_rel_func)(void *ptr, void *oldptr);
  23
  24 #define MDB_NOOVERWRITE  1
  25
  26 typedef enum MDB_cursor_op {            /* cursor operations */
  27         MDB_CURSOR,                             /* position at given key */
  28         MDB_CURSOR_EXACT,               /* position at key, or fail */
  29         MDB_FIRST,
  30         MDB_NEXT,
  31         MDB_LAST,                               /* not implemented */
  32         MDB_PREV                                /* not implemented */
  33 } MDB_cursor_op;
  34
  35 /* return codes */
  36 #define MDB_FAIL                -1
  37 #define MDB_SUCCESS      0
  38
  39 /* DB flags */
  40 #define MDB_REVERSEKEY  0x02            /* use reverse string keys */
  41 #define MDB_DUPSORT             0x04            /* use sorted duplicates */
  42
  43 /* environment flags */
  44 #define MDB_FIXEDMAP    0x01            /* mmap at a fixed address */
  45 #define MDB_NOSYNC              0x10000         /* don't fsync after commit */
  46 #define MDB_RDONLY              0x20000         /* read only */
  47
  48 /* DB or env flags */
  49 #define MDB_CREATE              0x40000         /* create if not present */
  50
  51 typedef struct MDB_stat {
  52         unsigned int    ms_psize;
  53         unsigned int    ms_depth;
  54         unsigned long   ms_branch_pages;
  55         unsigned long   ms_leaf_pages;
  56         unsigned long   ms_overflow_pages;
  57         unsigned long   ms_entries;
  58 } MDB_stat;
  59
  60 int  mdbenv_create(MDB_env **env);
  61 int  mdbenv_open(MDB_env *env, const char *path, unsigned int flags, mode_t mode);
  62 int  mdbenv_stat(MDB_env *env, MDB_stat *stat);
  63 void mdbenv_close(MDB_env *env);
  64 int  mdbenv_get_flags(MDB_env *env, unsigned int *flags);
  65 int  mdbenv_get_path(MDB_env *env, const char **path);
  66 int  mdbenv_set_mapsize(MDB_env *env, size_t size);
  67 int  mdbenv_set_maxreaders(MDB_env *env, int readers);
  68 int  mdbenv_get_maxreaders(MDB_env *env, int *readers);
  69 int  mdbenv_set_maxdbs(MDB_env *env, int dbs);
  70 int  mdbenv_sync(MDB_env *env);
  71
  72 int  mdb_txn_begin(MDB_env *env, int rdonly, MDB_txn **txn);
  73 int  mdb_txn_commit(MDB_txn *txn);
  74 void mdb_txn_abort(MDB_txn *txn);
  75
  76 int  mdb_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
  77 int  mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
  78 void mdb_close(MDB_txn *txn, MDB_dbi dbi);
  79
  80 int  mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
  81 int  mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
  82 int  mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
  83
  84 int  mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
  85 int  mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
  86                             unsigned int flags);
  87 int  mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
  88
  89 int  mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
  90 void mdb_cursor_close(MDB_cursor *cursor);
  91 int  mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
  92                             MDB_cursor_op op);
  93
  94 int  mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
  95
  96 #endif /* _MDB_H_ */