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

   1 /* mdb.h - memory-mapped database library header file */
   2 /*
   3  * Copyright 2011 Howard Chu, Symas Corp.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted only as authorized by the OpenLDAP
   8  * Public License.
   9  *
  10  * A copy of this license is available in the file LICENSE in the
  11  * top-level directory of the distribution or, alternatively, at
  12  * <http://www.OpenLDAP.org/license.html>.
  13  *
  14  * This code is derived from btree.c written by Martin Hedenfalk.
  15  *
  16  * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
  17  *
  18  * Permission to use, copy, modify, and distribute this software for any
  19  * purpose with or without fee is hereby granted, provided that the above
  20  * copyright notice and this permission notice appear in all copies.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  23  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  25  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  26  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  27  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  28  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  29  */
  30 #ifndef _MDB_H_
  31 #define _MDB_H_
  32
  33 #include <sys/types.h>
  34
  35 #define MDB_VERSION_MAJOR       0
  36 #define MDB_VERSION_MINOR       8
  37 #define MDB_VERSION_PATCH       0
  38 #define MDB_VERSION_FULL        ((MDB_VERSION_MAJOR << 24) | (MDB_VERSION_MINOR << 16) | MDB_VERSION_PATCH)
  39
  40 struct MDB_cursor;
  41 struct MDB_txn;
  42 struct MDB_env;
  43
  44 typedef struct MDB_cursor MDB_cursor;
  45 typedef struct MDB_txn MDB_txn;
  46 typedef struct MDB_env MDB_env;
  47
  48 typedef unsigned int    MDB_dbi;
  49
  50 typedef struct MDB_val {
  51         size_t           mv_size;
  52         void            *mv_data;
  53 } MDB_val;
  54
  55 typedef int  (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
  56 typedef void (MDB_rel_func)(void *ptr, void *oldptr);
  57
  58 #define MDB_NOOVERWRITE 0x10
  59 #define MDB_NODUPDATA   0x20
  60 #define MDB_DEL_DUP             0x40
  61
  62 typedef enum MDB_cursor_op {            /* cursor operations */
  63         MDB_FIRST,
  64         MDB_GET_BOTH,                   /* position at key/data */
  65         MDB_GET_BOTH_RANGE,             /* position at key, nearest data */
  66         MDB_LAST,
  67         MDB_NEXT,
  68         MDB_NEXT_DUP,
  69         MDB_NEXT_NODUP,
  70         MDB_PREV,
  71         MDB_PREV_DUP,
  72         MDB_PREV_NODUP,
  73         MDB_SET,                                /* position at key, or fail */
  74         MDB_SET_RANGE                   /* position at given key */
  75 } MDB_cursor_op;
  76
  77 /* return codes */
  78 #define MDB_SUCCESS      0
  79 #define MDB_FAIL                -1
  80 #define MDB_KEYEXIST    -2
  81 #define MDB_NOTFOUND    -3
  82 #define MDB_VERSION_MISMATCH    -4
  83
  84 /* DB flags */
  85 #define MDB_REVERSEKEY  0x02            /* use reverse string keys */
  86 #define MDB_DUPSORT             0x04            /* use sorted duplicates */
  87 #define MDB_INTEGERKEY  0x08            /* numeric keys in native byte order */
  88
  89 /* environment flags */
  90 #define MDB_FIXEDMAP    0x01            /* mmap at a fixed address */
  91 #define MDB_NOSYNC              0x10000         /* don't fsync after commit */
  92 #define MDB_RDONLY              0x20000         /* read only */
  93
  94 /* DB or env flags */
  95 #define MDB_CREATE              0x40000         /* create if not present */
  96
  97 typedef struct MDB_stat {
  98         unsigned int    ms_psize;
  99         unsigned int    ms_depth;
 100         unsigned long   ms_branch_pages;
 101         unsigned long   ms_leaf_pages;
 102         unsigned long   ms_overflow_pages;
 103         unsigned long   ms_entries;
 104 } MDB_stat;
 105
 106 int  mdbenv_create(MDB_env **env);
 107 int  mdbenv_open(MDB_env *env, const char *path, unsigned int flags, mode_t mode);
 108 int  mdbenv_stat(MDB_env *env, MDB_stat *stat);
 109 int  mdbenv_sync(MDB_env *env);
 110 void mdbenv_close(MDB_env *env);
 111 int  mdbenv_get_flags(MDB_env *env, unsigned int *flags);
 112 int  mdbenv_get_path(MDB_env *env, const char **path);
 113 int  mdbenv_set_mapsize(MDB_env *env, size_t size);
 114 int  mdbenv_set_maxreaders(MDB_env *env, int readers);
 115 int  mdbenv_get_maxreaders(MDB_env *env, int *readers);
 116 int  mdbenv_set_maxdbs(MDB_env *env, int dbs);
 117
 118 int  mdb_txn_begin(MDB_env *env, int rdonly, MDB_txn **txn);
 119 int  mdb_txn_commit(MDB_txn *txn);
 120 void mdb_txn_abort(MDB_txn *txn);
 121
 122 int  mdb_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
 123 int  mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
 124 void mdb_close(MDB_txn *txn, MDB_dbi dbi);
 125
 126 int  mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
 127 int  mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
 128 int  mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
 129
 130 int  mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
 131 int  mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
 132                             unsigned int flags);
 133 int  mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
 134                             unsigned int flags);
 135
 136 int  mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
 137 void mdb_cursor_close(MDB_cursor *cursor);
 138 int  mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
 139                             MDB_cursor_op op);
 140 int  mdb_cursor_count(MDB_cursor *cursor, unsigned long *countp);
 141
 142 int  mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
 143
 144 #endif /* _MDB_H_ */