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