git.ozlabs.org Git - ccan/blob - ccan/tdb2/tdb2.h

   1 #ifndef CCAN_TDB2_H
   2 #define CCAN_TDB2_H
   3
   4 /*
   5    Unix SMB/CIFS implementation.
   6
   7    trivial database library
   8
   9    Copyright (C) Andrew Tridgell 1999-2004
  10
  11      ** NOTE! The following LGPL license applies to the tdb
  12      ** library. This does NOT imply that all of Samba is released
  13      ** under the LGPL
  14
  15    This library is free software; you can redistribute it and/or
  16    modify it under the terms of the GNU Lesser General Public
  17    License as published by the Free Software Foundation; either
  18    version 3 of the License, or (at your option) any later version.
  19
  20    This library is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23    Lesser General Public License for more details.
  24
  25    You should have received a copy of the GNU Lesser General Public
  26    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  27 */
  28
  29 #ifdef  __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 #ifndef _SAMBA_BUILD_
  34 /* For mode_t */
  35 #include <sys/types.h>
  36 /* For O_* flags. */
  37 #include <sys/stat.h>
  38 /* For sig_atomic_t. */
  39 #include <signal.h>
  40 /* For uint64_t */
  41 #include <stdint.h>
  42 #endif
  43 #include <ccan/compiler/compiler.h>
  44
  45 /* flags to tdb_store() */
  46 #define TDB_REPLACE 1           /* Unused */
  47 #define TDB_INSERT 2            /* Don't overwrite an existing entry */
  48 #define TDB_MODIFY 3            /* Don't create an existing entry    */
  49
  50 /* flags for tdb_open() */
  51 #define TDB_DEFAULT 0 /* just a readability place holder */
  52 #define TDB_CLEAR_IF_FIRST 1
  53 #define TDB_INTERNAL 2 /* don't store on disk */
  54 #define TDB_NOLOCK   4 /* don't do any locking */
  55 #define TDB_NOMMAP   8 /* don't use mmap */
  56 #define TDB_CONVERT 16 /* convert endian */
  57 #define TDB_NOSYNC   64 /* don't use synchronous transactions */
  58 #define TDB_SEQNUM   128 /* maintain a sequence number */
  59 #define TDB_VOLATILE   256 /* Activate the per-hashchain freelist, default 5 */
  60 #define TDB_ALLOW_NESTING 512 /* Allow transactions to nest */
  61
  62 /* error codes */
  63 enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK,
  64                 TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOEXIST,
  65                 TDB_ERR_EINVAL, TDB_ERR_RDONLY, TDB_ERR_NESTING };
  66
  67 /* flags for tdb_summary. Logical or to combine. */
  68 enum tdb_summary_flags { TDB_SUMMARY_HISTOGRAMS = 1 };
  69
  70 /* debugging uses one of the following levels */
  71 enum tdb_debug_level {TDB_DEBUG_FATAL = 0, TDB_DEBUG_ERROR,
  72                       TDB_DEBUG_WARNING, TDB_DEBUG_TRACE};
  73
  74 typedef struct tdb_data {
  75         unsigned char *dptr;
  76         size_t dsize;
  77 } TDB_DATA;
  78
  79 struct tdb_context;
  80
  81 /* FIXME: Make typesafe */
  82 typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void *);
  83 typedef void (*tdb_logfn_t)(struct tdb_context *, enum tdb_debug_level, void *priv, const char *, ...) PRINTF_FMT(4, 5);
  84 typedef uint64_t (*tdb_hashfn_t)(const void *key, size_t len, uint64_t seed,
  85                                  void *priv);
  86
  87 enum tdb_attribute_type {
  88         TDB_ATTRIBUTE_LOG = 0,
  89         TDB_ATTRIBUTE_HASH = 1,
  90         TDB_ATTRIBUTE_SEED = 2,
  91         TDB_ATTRIBUTE_STATS = 3
  92 };
  93
  94 struct tdb_attribute_base {
  95         enum tdb_attribute_type attr;
  96         union tdb_attribute *next;
  97 };
  98
  99 struct tdb_attribute_log {
 100         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_LOG */
 101         tdb_logfn_t log_fn;
 102         void *log_private;
 103 };
 104
 105 struct tdb_attribute_hash {
 106         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_HASH */
 107         tdb_hashfn_t hash_fn;
 108         void *hash_private;
 109 };
 110
 111 struct tdb_attribute_seed {
 112         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_SEED */
 113         uint64_t seed;
 114 };
 115
 116 struct tdb_attribute_stats {
 117         struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_STATS */
 118         size_t size; /* = sizeof(struct tdb_attribute_stats) */
 119         uint64_t allocs;
 120         uint64_t   alloc_subhash;
 121         uint64_t   alloc_bucket_exact;
 122         uint64_t   alloc_bucket_max;
 123         uint64_t   alloc_leftover;
 124         uint64_t   alloc_coalesce_tried;
 125         uint64_t     alloc_coalesce_lockfail;
 126         uint64_t     alloc_coalesce_race;
 127         uint64_t     alloc_coalesce_succeeded;
 128         uint64_t        alloc_coalesce_num_merged;
 129         uint64_t expands;
 130         uint64_t frees;
 131         uint64_t locks;
 132         uint64_t    lock_lowlevel;
 133         uint64_t    lock_nonblock;
 134 };
 135
 136 union tdb_attribute {
 137         struct tdb_attribute_base base;
 138         struct tdb_attribute_log log;
 139         struct tdb_attribute_hash hash;
 140         struct tdb_attribute_seed seed;
 141         struct tdb_attribute_stats stats;
 142 };
 143
 144 struct tdb_context *tdb_open(const char *name, int tdb_flags,
 145                              int open_flags, mode_t mode,
 146                              union tdb_attribute *attributes);
 147
 148 struct tdb_data tdb_fetch(struct tdb_context *tdb, struct tdb_data key);
 149 int tdb_delete(struct tdb_context *tdb, struct tdb_data key);
 150 int tdb_store(struct tdb_context *tdb, struct tdb_data key, struct tdb_data dbuf, int flag);
 151 int tdb_append(struct tdb_context *tdb, struct tdb_data key, struct tdb_data dbuf);
 152 int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key);
 153 int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key);
 154 int64_t tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *p);
 155 int64_t tdb_traverse_read(struct tdb_context *tdb,
 156                           tdb_traverse_func fn, void *p);
 157 TDB_DATA tdb_firstkey(struct tdb_context *tdb);
 158 TDB_DATA tdb_nextkey(struct tdb_context *tdb, TDB_DATA key);
 159 int tdb_close(struct tdb_context *tdb);
 160 int tdb_check(struct tdb_context *tdb,
 161               int (*check)(TDB_DATA key, TDB_DATA data, void *private_data),
 162               void *private_data);
 163
 164 enum TDB_ERROR tdb_error(struct tdb_context *tdb);
 165 const char *tdb_errorstr(struct tdb_context *tdb);
 166
 167 int tdb_transaction_start(struct tdb_context *tdb);
 168 void tdb_transaction_cancel(struct tdb_context *tdb);
 169 int tdb_transaction_prepare_commit(struct tdb_context *tdb);
 170 int tdb_transaction_commit(struct tdb_context *tdb);
 171
 172 char *tdb_summary(struct tdb_context *tdb, enum tdb_summary_flags flags);
 173
 174 extern struct tdb_data tdb_null;
 175
 176 #ifdef  __cplusplus
 177 }
 178 #endif
 179
 180 #endif /* tdb2.h */