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

   1 #ifndef TDB1_H
   2 #define TDB1_H
   3
   4 /*
   5    Unix SMB/CIFS implementation.
   6
   7    trivial database library (version 1 compat functions)
   8
   9    Copyright (C) Andrew Tridgell 1999-2004
  10    Copyright (C) Rusty Russell 2011
  11
  12      ** NOTE! The following LGPL license applies to the tdb
  13      ** library. This does NOT imply that all of Samba is released
  14      ** under the LGPL
  15
  16    This library is free software; you can redistribute it and/or
  17    modify it under the terms of the GNU Lesser General Public
  18    License as published by the Free Software Foundation; either
  19    version 3 of the License, or (at your option) any later version.
  20
  21    This library is distributed in the hope that it will be useful,
  22    but WITHOUT ANY WARRANTY; without even the implied warranty of
  23    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24    Lesser General Public License for more details.
  25
  26    You should have received a copy of the GNU Lesser General Public
  27    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  28 */
  29
  30 #ifndef _SAMBA_BUILD_
  31 /* For mode_t */
  32 #include <sys/types.h>
  33 /* For O_* flags. */
  34 #include <sys/stat.h>
  35 #endif
  36
  37 /** Flags to tdb1_store() */
  38 #define TDB1_REPLACE 1          /** Unused */
  39 #define TDB1_INSERT 2           /** Don't overwrite an existing entry */
  40 #define TDB1_MODIFY 3           /** Don't create an existing entry    */
  41
  42 /** Flags for tdb1_open() */
  43 #define TDB1_DEFAULT 0 /** just a readability place holder */
  44 #define TDB1_CLEAR_IF_FIRST 1 /** If this is the first open, wipe the db */
  45 #define TDB1_INTERNAL 2 /** Don't store on disk */
  46 #define TDB1_NOLOCK   4 /** Don't do any locking */
  47 #define TDB1_NOMMAP   8 /** Don't use mmap */
  48 #define TDB1_CONVERT 16 /** Convert endian (internal use) */
  49 #define TDB1_BIGENDIAN 32 /** Header is big-endian (internal use) */
  50 #define TDB1_NOSYNC   64 /** Don't use synchronous transactions */
  51 #define TDB1_SEQNUM   128 /** Maintain a sequence number */
  52 #define TDB1_VOLATILE   256 /** Activate the per-hashchain freelist, default 5 */
  53 #define TDB1_ALLOW_NESTING 512 /** Allow transactions to nest */
  54 #define TDB1_DISALLOW_NESTING 1024 /** Disallow transactions to nest */
  55 #define TDB1_INCOMPATIBLE_HASH 2048 /** Better hashing: can't be opened by tdb < 1.2.6. */
  56
  57 /** The tdb error codes */
  58 enum TDB1_ERROR {TDB1_SUCCESS=0, TDB1_ERR_CORRUPT, TDB1_ERR_IO, TDB1_ERR_LOCK,
  59                 TDB1_ERR_OOM, TDB1_ERR_EXISTS, TDB1_ERR_NOLOCK, TDB1_ERR_LOCK_TIMEOUT,
  60                 TDB1_ERR_NOEXIST, TDB1_ERR_EINVAL, TDB1_ERR_RDONLY,
  61                 TDB1_ERR_NESTING};
  62
  63 /** Debugging uses one of the following levels */
  64 enum tdb1_debug_level {TDB1_DEBUG_FATAL = 0, TDB1_DEBUG_ERROR,
  65                       TDB1_DEBUG_WARNING, TDB1_DEBUG_TRACE};
  66
  67 /** The tdb data structure */
  68 typedef struct TDB1_DATA {
  69         unsigned char *dptr;
  70         size_t dsize;
  71 } TDB1_DATA;
  72
  73 #ifndef PRINTF_ATTRIBUTE
  74 #if (__GNUC__ >= 3)
  75 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
  76  * the parameter containing the format, and a2 the index of the first
  77  * argument. Note that some gcc 2.x versions don't handle this
  78  * properly **/
  79 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
  80 #else
  81 #define PRINTF_ATTRIBUTE(a1, a2)
  82 #endif
  83 #endif
  84
  85 /** This is the context structure that is returned from a db open. */
  86 typedef struct tdb1_context TDB1_CONTEXT;
  87
  88 typedef int (*tdb1_traverse_func)(struct tdb1_context *, TDB1_DATA, TDB1_DATA, void *);
  89 typedef void (*tdb1_log_func)(struct tdb1_context *, enum tdb1_debug_level, const char *, ...) PRINTF_ATTRIBUTE(3, 4);
  90 typedef unsigned int (*tdb1_hash_func)(TDB1_DATA *key);
  91
  92 struct tdb1_logging_context {
  93         tdb1_log_func log_fn;
  94         void *log_private;
  95 };
  96
  97 struct tdb1_context *tdb1_open(const char *name, int hash_size, int tdb1_flags,
  98                       int open_flags, mode_t mode);
  99
 100 struct tdb1_context *tdb1_open_ex(const char *name, int hash_size, int tdb1_flags,
 101                          int open_flags, mode_t mode,
 102                          const struct tdb1_logging_context *log_ctx,
 103                          tdb1_hash_func hash_fn);
 104
 105 void tdb1_set_max_dead(struct tdb1_context *tdb, int max_dead);
 106
 107 TDB1_DATA tdb1_fetch(struct tdb1_context *tdb, TDB1_DATA key);
 108
 109 int tdb1_parse_record(struct tdb1_context *tdb, TDB1_DATA key,
 110                               int (*parser)(TDB1_DATA key, TDB1_DATA data,
 111                                             void *private_data),
 112                               void *private_data);
 113
 114 int tdb1_delete(struct tdb1_context *tdb, TDB1_DATA key);
 115
 116 int tdb1_store(struct tdb1_context *tdb, TDB1_DATA key, TDB1_DATA dbuf, int flag);
 117
 118 int tdb1_append(struct tdb1_context *tdb, TDB1_DATA key, TDB1_DATA new_dbuf);
 119
 120 int tdb1_close(struct tdb1_context *tdb);
 121
 122 TDB1_DATA tdb1_firstkey(struct tdb1_context *tdb);
 123
 124 TDB1_DATA tdb1_nextkey(struct tdb1_context *tdb, TDB1_DATA key);
 125
 126 int tdb1_traverse(struct tdb1_context *tdb, tdb1_traverse_func fn, void *private_data);
 127
 128 int tdb1_traverse_read(struct tdb1_context *tdb, tdb1_traverse_func fn, void *private_data);
 129
 130 int tdb1_exists(struct tdb1_context *tdb, TDB1_DATA key);
 131
 132 int tdb1_lockall(struct tdb1_context *tdb);
 133
 134 int tdb1_unlockall(struct tdb1_context *tdb);
 135
 136 int tdb1_lockall_read(struct tdb1_context *tdb);
 137
 138 int tdb1_unlockall_read(struct tdb1_context *tdb);
 139
 140 tdb1_log_func tdb1_log_fn(struct tdb1_context *tdb);
 141
 142 int tdb1_transaction_start(struct tdb1_context *tdb);
 143
 144 int tdb1_transaction_prepare_commit(struct tdb1_context *tdb);
 145
 146 int tdb1_transaction_commit(struct tdb1_context *tdb);
 147
 148 int tdb1_transaction_cancel(struct tdb1_context *tdb);
 149
 150 int tdb1_get_seqnum(struct tdb1_context *tdb);
 151
 152 int tdb1_hash_size(struct tdb1_context *tdb);
 153
 154 void tdb1_increment_seqnum_nonblock(struct tdb1_context *tdb);
 155
 156 unsigned int tdb1_jenkins_hash(TDB1_DATA *key);
 157
 158 int tdb1_check(struct tdb1_context *tdb,
 159               int (*check) (TDB1_DATA key, TDB1_DATA data, void *private_data),
 160               void *private_data);
 161
 162 /* @} ******************************************************************/
 163
 164 /* Low level locking functions: use with care */
 165 int tdb1_chainlock(struct tdb1_context *tdb, TDB1_DATA key);
 166 int tdb1_chainunlock(struct tdb1_context *tdb, TDB1_DATA key);
 167 int tdb1_chainlock_read(struct tdb1_context *tdb, TDB1_DATA key);
 168 int tdb1_chainunlock_read(struct tdb1_context *tdb, TDB1_DATA key);
 169
 170
 171 /* wipe and repack */
 172 int tdb1_wipe_all(struct tdb1_context *tdb);
 173 int tdb1_repack(struct tdb1_context *tdb);
 174
 175 /* Debug functions. Not used in production. */
 176 char *tdb1_summary(struct tdb1_context *tdb);
 177
 178 extern TDB1_DATA tdb1_null;
 179
 180 #endif /* tdb1.h */