4 Unix SMB/CIFS implementation.
6 trivial database library - private includes
8 Copyright (C) Andrew Tridgell 2005
10 ** NOTE! The following LGPL license applies to the tdb
11 ** library. This does NOT imply that all of Samba is released
14 This library is free software; you can redistribute it and/or
15 modify it under the terms of the GNU Lesser General Public
16 License as published by the Free Software Foundation; either
17 version 3 of the License, or (at your option) any later version.
19 This library is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public
25 License along with this library; if not, see <http://www.gnu.org/licenses/>.
30 #include "system/filesys.h"
31 #include "system/time.h"
32 #include "system/shmem.h"
33 #include "system/select.h"
34 #include "system/wait.h"
36 #define _XOPEN_SOURCE 500
37 #define _FILE_OFFSET_BITS 64
53 /* #define TDB_TRACE 1 */
56 #define __STRING(x) #x
59 #ifndef __STRINGSTRING
60 #define __STRINGSTRING(x) __STRING(x)
64 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
68 #define getpagesize() 0x2000
71 typedef uint32_t tdb_len_t;
72 typedef uint32_t tdb_off_t;
75 #define offsetof(t,f) ((size_t)&((t *)0)->f)
78 #define TDB_MAGIC_FOOD "TDB file\n"
79 #define TDB_VERSION (0x26011967 + 6)
80 #define TDB_MAGIC (0x26011999U)
81 #define TDB_FREE_MAGIC (~TDB_MAGIC)
82 #define TDB_DEAD_MAGIC (0xFEE1DEAD)
83 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
84 #define TDB_RECOVERY_INVALID_MAGIC (0x0)
85 #define TDB_HASH_RWLOCK_MAGIC (0xbad1a51U)
86 #define TDB_ALIGNMENT 4
87 #define DEFAULT_HASH_SIZE 131
88 #define FREELIST_TOP (sizeof(struct tdb_header))
89 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
90 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
91 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
92 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
93 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
94 #define TDB_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb_off_t))
95 #define TDB_DATA_START(hash_size) (TDB_HASH_TOP(hash_size-1) + sizeof(tdb_off_t))
96 #define TDB_RECOVERY_HEAD offsetof(struct tdb_header, recovery_start)
97 #define TDB_SEQNUM_OFS offsetof(struct tdb_header, sequence_number)
98 #define TDB_PAD_BYTE 0x42
99 #define TDB_PAD_U32 0x42424242
101 /* NB assumes there is a local variable called "tdb" that is the
102 * current context, also takes doubly-parenthesized print-style
104 #define TDB_LOG(x) tdb->log.log_fn x
107 void tdb_trace(struct tdb_context *tdb, const char *op);
108 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
109 void tdb_trace_open(struct tdb_context *tdb, const char *op,
110 unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
111 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
112 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
113 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
115 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
116 TDB_DATA rec, int ret);
117 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
118 TDB_DATA rec, TDB_DATA ret);
119 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
120 TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
122 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
123 TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
125 #define tdb_trace(tdb, op)
126 #define tdb_trace_seqnum(tdb, seqnum, op)
127 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
128 #define tdb_trace_ret(tdb, op, ret)
129 #define tdb_trace_retrec(tdb, op, ret)
130 #define tdb_trace_1rec(tdb, op, rec)
131 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
132 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
133 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
134 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
135 #endif /* !TDB_TRACE */
139 #define ACTIVE_LOCK 4
140 #define TRANSACTION_LOCK 8
142 /* free memory if the pointer is valid and zero the pointer */
144 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
147 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
149 #define DOCONV() (tdb->flags & TDB_CONVERT)
150 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
153 /* the body of the database is made of one tdb_record for the free space
154 plus a separate data list for each hash value */
156 tdb_off_t next; /* offset of the next record in the list */
157 tdb_len_t rec_len; /* total byte length of record */
158 tdb_len_t key_len; /* byte length of key */
159 tdb_len_t data_len; /* byte length of data */
160 uint32_t full_hash; /* the full 32 bit hash of the key */
161 uint32_t magic; /* try to catch errors */
162 /* the following union is implied:
164 char record[rec_len];
169 uint32_t totalsize; (tailer)
175 /* this is stored at the front of every database */
177 char magic_food[32]; /* for /etc/magic */
178 uint32_t version; /* version of the code */
179 uint32_t hash_size; /* number of hash entries */
180 tdb_off_t rwlocks; /* obsolete - kept to detect old formats */
181 tdb_off_t recovery_start; /* offset of transaction recovery region */
182 tdb_off_t sequence_number; /* used when TDB_SEQNUM is set */
183 uint32_t magic1_hash; /* hash of TDB_MAGIC_FOOD. */
184 uint32_t magic2_hash; /* hash of TDB_MAGIC. */
185 tdb_off_t reserved[27];
188 struct tdb_lock_type {
194 struct tdb_traverse_lock {
195 struct tdb_traverse_lock *next;
201 enum tdb_lock_flags {
202 /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
205 /* If set, don't log an error on failure. */
207 /* If set, don't actually lock at all. */
208 TDB_LOCK_MARK_ONLY = 4,
212 int (*tdb_read)(struct tdb_context *, tdb_off_t , void *, tdb_len_t , int );
213 int (*tdb_write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
214 void (*next_hash_chain)(struct tdb_context *, uint32_t *);
215 int (*tdb_oob)(struct tdb_context *, tdb_off_t , int );
216 int (*tdb_expand_file)(struct tdb_context *, tdb_off_t , tdb_off_t );
220 char *name; /* the name of the database */
221 void *map_ptr; /* where it is currently mapped */
222 int fd; /* open file descriptor for the database */
223 tdb_len_t map_size; /* how much space has been mapped */
224 int read_only; /* opened read-only */
225 int traverse_read; /* read-only traversal */
226 int traverse_write; /* read-write traversal */
227 struct tdb_lock_type allrecord_lock; /* .offset == upgradable */
229 struct tdb_lock_type *lockrecs; /* only real locks, all with count>0 */
230 enum TDB_ERROR ecode; /* error code for last tdb error */
231 struct tdb_header header; /* a cached copy of the header */
232 uint32_t flags; /* the flags passed to tdb_open */
233 struct tdb_traverse_lock travlocks; /* current traversal locks */
234 struct tdb_context *next; /* all tdbs to avoid multiple opens */
235 dev_t device; /* uniquely identifies this tdb */
236 ino_t inode; /* uniquely identifies this tdb */
237 struct tdb_logging_context log;
238 unsigned int (*hash_fn)(TDB_DATA *key);
239 int open_flags; /* flags used in the open - needed by reopen */
240 const struct tdb_methods *methods;
241 struct tdb_transaction *transaction;
243 int max_dead_records;
247 volatile sig_atomic_t *interrupt_sig_ptr;
254 int tdb_munmap(struct tdb_context *tdb);
255 void tdb_mmap(struct tdb_context *tdb);
256 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
257 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
258 int tdb_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
259 enum tdb_lock_flags flags);
260 int tdb_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype,
262 bool tdb_have_locks(struct tdb_context *tdb);
263 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
264 int tdb_brlock(struct tdb_context *tdb,
265 int rw_type, tdb_off_t offset, size_t len,
266 enum tdb_lock_flags flags);
267 int tdb_brunlock(struct tdb_context *tdb,
268 int rw_type, tdb_off_t offset, size_t len);
269 bool tdb_have_extra_locks(struct tdb_context *tdb);
270 void tdb_release_extra_locks(struct tdb_context *tdb);
271 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
272 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
273 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
274 enum tdb_lock_flags flags, bool upgradable);
275 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype, bool mark_lock);
276 int tdb_allrecord_upgrade(struct tdb_context *tdb);
277 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
278 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
279 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
280 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
281 void *tdb_convert(void *buf, uint32_t size);
282 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
283 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct tdb_record *rec);
284 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
285 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
286 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
287 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
288 bool tdb_needs_recovery(struct tdb_context *tdb);
289 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
290 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
291 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct tdb_record *rec);
292 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
293 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
294 tdb_off_t offset, tdb_len_t len,
295 int (*parser)(TDB_DATA key, TDB_DATA data,
298 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
299 struct tdb_record *rec);
300 void tdb_io_init(struct tdb_context *tdb);
301 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
302 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
303 struct tdb_record *rec);
304 void tdb_header_hash(struct tdb_context *tdb,
305 uint32_t *magic1_hash, uint32_t *magic2_hash);
306 unsigned int tdb_old_hash(TDB_DATA *key);