5 Unix SMB/CIFS implementation.
7 trivial database library (version 1 compat functions)
9 Copyright (C) Andrew Tridgell 1999-2004
10 Copyright (C) Rusty Russell 2011
12 ** NOTE! The following LGPL license applies to the tdb
13 ** library. This does NOT imply that all of Samba is released
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.
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.
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/>.
33 #include <sys/types.h>
38 /** Flags to tdb1_store() */
39 #define TDB1_REPLACE 1 /** Unused */
40 #define TDB1_INSERT 2 /** Don't overwrite an existing entry */
41 #define TDB1_MODIFY 3 /** Don't create an existing entry */
43 /** Flags for tdb1_open() */
44 #define TDB1_DEFAULT 0 /** just a readability place holder */
45 #define TDB1_CLEAR_IF_FIRST 1 /** If this is the first open, wipe the db */
46 #define TDB1_INTERNAL 2 /** Don't store on disk */
47 #define TDB1_NOLOCK 4 /** Don't do any locking */
48 #define TDB1_NOMMAP 8 /** Don't use mmap */
49 #define TDB1_CONVERT 16 /** Convert endian (internal use) */
50 #define TDB1_BIGENDIAN 32 /** Header is big-endian (internal use) */
51 #define TDB1_NOSYNC 64 /** Don't use synchronous transactions */
52 #define TDB1_SEQNUM 128 /** Maintain a sequence number */
53 #define TDB1_VOLATILE 256 /** Activate the per-hashchain freelist, default 5 */
54 #define TDB1_ALLOW_NESTING 512 /** Allow transactions to nest */
55 #define TDB1_DISALLOW_NESTING 1024 /** Disallow transactions to nest */
56 #define TDB1_INCOMPATIBLE_HASH 2048 /** Better hashing: can't be opened by tdb < 1.2.6. */
58 /** The tdb data structure */
59 typedef struct TDB1_DATA {
64 /** This is the context structure that is returned from a db open. */
65 typedef struct tdb1_context TDB1_CONTEXT;
67 typedef int (*tdb1_traverse_func)(struct tdb1_context *, TDB1_DATA, TDB1_DATA, void *);
68 typedef void (*tdb1_log_func)(struct tdb1_context *, enum tdb_log_level, enum TDB_ERROR,
69 const char *, void *);
70 typedef unsigned int (*tdb1_hash_func)(TDB1_DATA *key);
72 struct tdb1_logging_context {
77 struct tdb1_context *tdb1_open(const char *name, int hash_size, int tdb1_flags,
78 int open_flags, mode_t mode);
80 struct tdb1_context *tdb1_open_ex(const char *name, int hash_size, int tdb1_flags,
81 int open_flags, mode_t mode,
82 const struct tdb1_logging_context *log_ctx,
83 tdb1_hash_func hash_fn);
85 void tdb1_set_max_dead(struct tdb1_context *tdb, int max_dead);
87 TDB1_DATA tdb1_fetch(struct tdb1_context *tdb, TDB1_DATA key);
89 int tdb1_parse_record(struct tdb1_context *tdb, TDB1_DATA key,
90 int (*parser)(TDB1_DATA key, TDB1_DATA data,
94 int tdb1_delete(struct tdb1_context *tdb, TDB1_DATA key);
96 int tdb1_store(struct tdb1_context *tdb, TDB1_DATA key, TDB1_DATA dbuf, int flag);
98 int tdb1_append(struct tdb1_context *tdb, TDB1_DATA key, TDB1_DATA new_dbuf);
100 int tdb1_close(struct tdb1_context *tdb);
102 TDB1_DATA tdb1_firstkey(struct tdb1_context *tdb);
104 TDB1_DATA tdb1_nextkey(struct tdb1_context *tdb, TDB1_DATA key);
106 int tdb1_traverse(struct tdb1_context *tdb, tdb1_traverse_func fn, void *private_data);
108 int tdb1_traverse_read(struct tdb1_context *tdb, tdb1_traverse_func fn, void *private_data);
110 int tdb1_exists(struct tdb1_context *tdb, TDB1_DATA key);
112 int tdb1_lockall(struct tdb1_context *tdb);
114 int tdb1_unlockall(struct tdb1_context *tdb);
116 int tdb1_lockall_read(struct tdb1_context *tdb);
118 int tdb1_unlockall_read(struct tdb1_context *tdb);
120 int tdb1_transaction_start(struct tdb1_context *tdb);
122 int tdb1_transaction_prepare_commit(struct tdb1_context *tdb);
124 int tdb1_transaction_commit(struct tdb1_context *tdb);
126 int tdb1_transaction_cancel(struct tdb1_context *tdb);
128 int tdb1_get_seqnum(struct tdb1_context *tdb);
130 int tdb1_hash_size(struct tdb1_context *tdb);
132 void tdb1_increment_seqnum_nonblock(struct tdb1_context *tdb);
134 unsigned int tdb1_jenkins_hash(TDB1_DATA *key);
136 int tdb1_check(struct tdb1_context *tdb,
137 int (*check) (TDB1_DATA key, TDB1_DATA data, void *private_data),
140 /* @} ******************************************************************/
142 /* Low level locking functions: use with care */
143 int tdb1_chainlock(struct tdb1_context *tdb, TDB1_DATA key);
144 int tdb1_chainunlock(struct tdb1_context *tdb, TDB1_DATA key);
145 int tdb1_chainlock_read(struct tdb1_context *tdb, TDB1_DATA key);
146 int tdb1_chainunlock_read(struct tdb1_context *tdb, TDB1_DATA key);
149 /* wipe and repack */
150 int tdb1_wipe_all(struct tdb1_context *tdb);
151 int tdb1_repack(struct tdb1_context *tdb);
153 /* Debug functions. Not used in production. */
154 char *tdb1_summary(struct tdb1_context *tdb);
156 extern TDB1_DATA tdb1_null;