5 Unix SMB/CIFS implementation.
7 trivial database library
9 Copyright (C) Andrew Tridgell 1999-2004
11 ** NOTE! The following LGPL license applies to the tdb
12 ** library. This does NOT imply that all of Samba is released
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.
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.
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/>.
35 #include <sys/types.h>
38 /* For sig_atomic_t. */
44 /* flags to tdb_store() */
45 #define TDB_REPLACE 1 /* Unused */
46 #define TDB_INSERT 2 /* Don't overwrite an existing entry */
47 #define TDB_MODIFY 3 /* Don't create an existing entry */
49 /* flags for tdb_open() */
50 #define TDB_DEFAULT 0 /* just a readability place holder */
51 #define TDB_CLEAR_IF_FIRST 1
52 #define TDB_INTERNAL 2 /* don't store on disk */
53 #define TDB_NOLOCK 4 /* don't do any locking */
54 #define TDB_NOMMAP 8 /* don't use mmap */
55 #define TDB_CONVERT 16 /* convert endian */
56 #define TDB_NOSYNC 64 /* don't use synchronous transactions */
57 #define TDB_SEQNUM 128 /* maintain a sequence number */
58 #define TDB_VOLATILE 256 /* Activate the per-hashchain freelist, default 5 */
59 #define TDB_ALLOW_NESTING 512 /* Allow transactions to nest */
60 #define TDB_DISALLOW_NESTING 1024 /* Disallow transactions to nest */
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_NOLOCK, TDB_ERR_LOCK_TIMEOUT,
65 TDB_ERR_NOEXIST, TDB_ERR_EINVAL, TDB_ERR_RDONLY,
68 /* debugging uses one of the following levels */
69 enum tdb_debug_level {TDB_DEBUG_FATAL = 0, TDB_DEBUG_ERROR,
70 TDB_DEBUG_WARNING, TDB_DEBUG_TRACE};
72 typedef struct tdb_data {
77 #ifndef PRINTF_ATTRIBUTE
79 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
80 * the parameter containing the format, and a2 the index of the first
81 * argument. Note that some gcc 2.x versions don't handle this
83 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
85 #define PRINTF_ATTRIBUTE(a1, a2)
91 /* FIXME: Make typesafe */
92 typedef void (*tdb_logfn_t)(struct tdb_context *, enum tdb_debug_level, void *priv, const char *, ...) PRINTF_ATTRIBUTE(4, 5);
93 typedef uint64_t (*tdb_hashfn_t)(const void *key, size_t len, uint64_t seed,
96 enum tdb_attribute_type {
97 TDB_ATTRIBUTE_LOG = 0,
98 TDB_ATTRIBUTE_HASH = 1
101 struct tdb_attribute_base {
102 enum tdb_attribute_type attr;
103 union tdb_attribute *next;
106 struct tdb_attribute_log {
107 struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_LOG */
112 struct tdb_attribute_hash {
113 struct tdb_attribute_base base; /* .attr = TDB_ATTRIBUTE_HASH */
114 tdb_hashfn_t hash_fn;
118 union tdb_attribute {
119 struct tdb_attribute_base base;
120 struct tdb_attribute_log log;
121 struct tdb_attribute_hash hash;
124 struct tdb_context *tdb_open(const char *name, int tdb_flags,
125 int open_flags, mode_t mode,
126 union tdb_attribute *attributes);
128 struct tdb_data tdb_fetch(struct tdb_context *tdb, struct tdb_data key);
129 int tdb_delete(struct tdb_context *tdb, struct tdb_data key);
130 int tdb_store(struct tdb_context *tdb, struct tdb_data key, struct tdb_data dbuf, int flag);
131 int tdb_append(struct tdb_context *tdb, struct tdb_data key, struct tdb_data dbuf);
132 int tdb_close(struct tdb_context *tdb);
133 int tdb_check(struct tdb_context *tdb,
134 int (*check)(TDB_DATA key, TDB_DATA data, void *private_data),
137 enum TDB_ERROR tdb_error(struct tdb_context *tdb);
139 extern struct tdb_data tdb_null;