lib/tdb: add tdb_check()
[ira/wip.git] / lib / tdb / include / tdb.h
1 #ifndef __TDB_H__
2 #define __TDB_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 #include "signal.h"
34
35 /* flags to tdb_store() */
36 #define TDB_REPLACE 1           /* Unused */
37 #define TDB_INSERT 2            /* Don't overwrite an existing entry */
38 #define TDB_MODIFY 3            /* Don't create an existing entry    */
39
40 /* flags for tdb_open() */
41 #define TDB_DEFAULT 0 /* just a readability place holder */
42 #define TDB_CLEAR_IF_FIRST 1
43 #define TDB_INTERNAL 2 /* don't store on disk */
44 #define TDB_NOLOCK   4 /* don't do any locking */
45 #define TDB_NOMMAP   8 /* don't use mmap */
46 #define TDB_CONVERT 16 /* convert endian (internal use) */
47 #define TDB_BIGENDIAN 32 /* header is big-endian (internal use) */
48 #define TDB_NOSYNC   64 /* don't use synchronous transactions */
49 #define TDB_SEQNUM   128 /* maintain a sequence number */
50 #define TDB_VOLATILE   256 /* Activate the per-hashchain freelist, default 5 */
51
52 /* error codes */
53 enum TDB_ERROR {TDB_SUCCESS=0, TDB_ERR_CORRUPT, TDB_ERR_IO, TDB_ERR_LOCK, 
54                 TDB_ERR_OOM, TDB_ERR_EXISTS, TDB_ERR_NOLOCK, TDB_ERR_LOCK_TIMEOUT,
55                 TDB_ERR_NOEXIST, TDB_ERR_EINVAL, TDB_ERR_RDONLY};
56
57 /* debugging uses one of the following levels */
58 enum tdb_debug_level {TDB_DEBUG_FATAL = 0, TDB_DEBUG_ERROR, 
59                       TDB_DEBUG_WARNING, TDB_DEBUG_TRACE};
60
61 typedef struct TDB_DATA {
62         unsigned char *dptr;
63         size_t dsize;
64 } TDB_DATA;
65
66 #ifndef PRINTF_ATTRIBUTE
67 #if (__GNUC__ >= 3)
68 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
69  * the parameter containing the format, and a2 the index of the first
70  * argument. Note that some gcc 2.x versions don't handle this
71  * properly **/
72 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
73 #else
74 #define PRINTF_ATTRIBUTE(a1, a2)
75 #endif
76 #endif
77
78 /* this is the context structure that is returned from a db open */
79 typedef struct tdb_context TDB_CONTEXT;
80
81 typedef int (*tdb_traverse_func)(struct tdb_context *, TDB_DATA, TDB_DATA, void *);
82 typedef void (*tdb_log_func)(struct tdb_context *, enum tdb_debug_level, const char *, ...) PRINTF_ATTRIBUTE(3, 4);
83 typedef unsigned int (*tdb_hash_func)(TDB_DATA *key);
84
85 struct tdb_logging_context {
86         tdb_log_func log_fn;
87         void *log_private;
88 };
89
90 struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags,
91                       int open_flags, mode_t mode);
92 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
93                          int open_flags, mode_t mode,
94                          const struct tdb_logging_context *log_ctx,
95                          tdb_hash_func hash_fn);
96 void tdb_set_max_dead(struct tdb_context *tdb, int max_dead);
97
98 int tdb_reopen(struct tdb_context *tdb);
99 int tdb_reopen_all(int parent_longlived);
100 void tdb_set_logging_function(struct tdb_context *tdb, const struct tdb_logging_context *log_ctx);
101 enum TDB_ERROR tdb_error(struct tdb_context *tdb);
102 const char *tdb_errorstr(struct tdb_context *tdb);
103 TDB_DATA tdb_fetch(struct tdb_context *tdb, TDB_DATA key);
104 int tdb_parse_record(struct tdb_context *tdb, TDB_DATA key,
105                      int (*parser)(TDB_DATA key, TDB_DATA data,
106                                    void *private_data),
107                      void *private_data);
108 int tdb_delete(struct tdb_context *tdb, TDB_DATA key);
109 int tdb_store(struct tdb_context *tdb, TDB_DATA key, TDB_DATA dbuf, int flag);
110 int tdb_append(struct tdb_context *tdb, TDB_DATA key, TDB_DATA new_dbuf);
111 int tdb_close(struct tdb_context *tdb);
112 TDB_DATA tdb_firstkey(struct tdb_context *tdb);
113 TDB_DATA tdb_nextkey(struct tdb_context *tdb, TDB_DATA key);
114 int tdb_traverse(struct tdb_context *tdb, tdb_traverse_func fn, void *);
115 int tdb_traverse_read(struct tdb_context *tdb, tdb_traverse_func fn, void *);
116 int tdb_exists(struct tdb_context *tdb, TDB_DATA key);
117 int tdb_lockall(struct tdb_context *tdb);
118 int tdb_lockall_nonblock(struct tdb_context *tdb);
119 int tdb_unlockall(struct tdb_context *tdb);
120 int tdb_lockall_read(struct tdb_context *tdb);
121 int tdb_lockall_read_nonblock(struct tdb_context *tdb);
122 int tdb_unlockall_read(struct tdb_context *tdb);
123 int tdb_lockall_mark(struct tdb_context *tdb);
124 int tdb_lockall_unmark(struct tdb_context *tdb);
125 const char *tdb_name(struct tdb_context *tdb);
126 int tdb_fd(struct tdb_context *tdb);
127 tdb_log_func tdb_log_fn(struct tdb_context *tdb);
128 void *tdb_get_logging_private(struct tdb_context *tdb);
129 int tdb_transaction_start(struct tdb_context *tdb);
130 int tdb_transaction_prepare_commit(struct tdb_context *tdb);
131 int tdb_transaction_commit(struct tdb_context *tdb);
132 int tdb_transaction_cancel(struct tdb_context *tdb);
133 int tdb_transaction_recover(struct tdb_context *tdb);
134 int tdb_get_seqnum(struct tdb_context *tdb);
135 int tdb_hash_size(struct tdb_context *tdb);
136 size_t tdb_map_size(struct tdb_context *tdb);
137 int tdb_get_flags(struct tdb_context *tdb);
138 void tdb_add_flags(struct tdb_context *tdb, unsigned flag);
139 void tdb_remove_flags(struct tdb_context *tdb, unsigned flag);
140 void tdb_enable_seqnum(struct tdb_context *tdb);
141 void tdb_increment_seqnum_nonblock(struct tdb_context *tdb);
142 int tdb_check(struct tdb_context *tdb,
143               int (*check)(TDB_DATA key, TDB_DATA data, void *private_data),
144               void *private_data);
145
146 /* Low level locking functions: use with care */
147 int tdb_chainlock(struct tdb_context *tdb, TDB_DATA key);
148 int tdb_chainlock_nonblock(struct tdb_context *tdb, TDB_DATA key);
149 int tdb_chainunlock(struct tdb_context *tdb, TDB_DATA key);
150 int tdb_chainlock_read(struct tdb_context *tdb, TDB_DATA key);
151 int tdb_chainunlock_read(struct tdb_context *tdb, TDB_DATA key);
152 int tdb_chainlock_mark(struct tdb_context *tdb, TDB_DATA key);
153 int tdb_chainlock_unmark(struct tdb_context *tdb, TDB_DATA key);
154
155 void tdb_setalarm_sigptr(struct tdb_context *tdb, volatile sig_atomic_t *sigptr);
156
157 /* wipe and repack */
158 int tdb_wipe_all(struct tdb_context *tdb);
159 int tdb_repack(struct tdb_context *tdb);
160
161 /* Debug functions. Not used in production. */
162 void tdb_dump_all(struct tdb_context *tdb);
163 int tdb_printfreelist(struct tdb_context *tdb);
164 int tdb_validate_freelist(struct tdb_context *tdb, int *pnum_entries);
165 int tdb_freelist_size(struct tdb_context *tdb);
166
167 extern TDB_DATA tdb_null;
168
169 #ifdef  __cplusplus
170 }
171 #endif
172
173 #endif /* tdb.h */