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) ((unsigned int)&((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_ALIGNMENT 4
86 #define DEFAULT_HASH_SIZE 131
87 #define FREELIST_TOP (sizeof(struct tdb_header))
88 #define TDB_ALIGN(x,a) (((x) + (a)-1) & ~((a)-1))
89 #define TDB_BYTEREV(x) (((((x)&0xff)<<24)|((x)&0xFF00)<<8)|(((x)>>8)&0xFF00)|((x)>>24))
90 #define TDB_DEAD(r) ((r)->magic == TDB_DEAD_MAGIC)
91 #define TDB_BAD_MAGIC(r) ((r)->magic != TDB_MAGIC && !TDB_DEAD(r))
92 #define TDB_HASH_TOP(hash) (FREELIST_TOP + (BUCKET(hash)+1)*sizeof(tdb_off_t))
93 #define TDB_HASHTABLE_SIZE(tdb) ((tdb->header.hash_size+1)*sizeof(tdb_off_t))
94 #define TDB_DATA_START(hash_size) (TDB_HASH_TOP(hash_size-1) + sizeof(tdb_off_t))
95 #define TDB_RECOVERY_HEAD offsetof(struct tdb_header, recovery_start)
96 #define TDB_SEQNUM_OFS offsetof(struct tdb_header, sequence_number)
97 #define TDB_PAD_BYTE 0x42
98 #define TDB_PAD_U32 0x42424242
100 /* NB assumes there is a local variable called "tdb" that is the
101 * current context, also takes doubly-parenthesized print-style
103 #define TDB_LOG(x) tdb->log.log_fn x
106 void tdb_trace(struct tdb_context *tdb, const char *op);
107 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
108 void tdb_trace_open(struct tdb_context *tdb, const char *op,
109 unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
110 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
111 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
112 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
114 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
115 TDB_DATA rec, int ret);
116 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
117 TDB_DATA rec, TDB_DATA ret);
118 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
119 TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
121 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
122 TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
124 #define tdb_trace(tdb, op)
125 #define tdb_trace_seqnum(tdb, seqnum, op)
126 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
127 #define tdb_trace_ret(tdb, op, ret)
128 #define tdb_trace_retrec(tdb, op, ret)
129 #define tdb_trace_1rec(tdb, op, rec)
130 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
131 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
132 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
133 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
134 #endif /* !TDB_TRACE */
138 #define ACTIVE_LOCK 4
139 #define TRANSACTION_LOCK 8
141 /* free memory if the pointer is valid and zero the pointer */
143 #define SAFE_FREE(x) do { if ((x) != NULL) {free(x); (x)=NULL;} } while(0)
146 #define BUCKET(hash) ((hash) % tdb->header.hash_size)
148 #define DOCONV() (tdb->flags & TDB_CONVERT)
149 #define CONVERT(x) (DOCONV() ? tdb_convert(&x, sizeof(x)) : &x)
152 /* the body of the database is made of one tdb_record for the free space
153 plus a separate data list for each hash value */
155 tdb_off_t next; /* offset of the next record in the list */
156 tdb_len_t rec_len; /* total byte length of record */
157 tdb_len_t key_len; /* byte length of key */
158 tdb_len_t data_len; /* byte length of data */
159 uint32_t full_hash; /* the full 32 bit hash of the key */
160 uint32_t magic; /* try to catch errors */
161 /* the following union is implied:
163 char record[rec_len];
168 uint32_t totalsize; (tailer)
174 /* this is stored at the front of every database */
176 char magic_food[32]; /* for /etc/magic */
177 uint32_t version; /* version of the code */
178 uint32_t hash_size; /* number of hash entries */
179 tdb_off_t rwlocks; /* obsolete - kept to detect old formats */
180 tdb_off_t recovery_start; /* offset of transaction recovery region */
181 tdb_off_t sequence_number; /* used when TDB_SEQNUM is set */
182 tdb_off_t reserved[29];
185 struct tdb_lock_type {
191 struct tdb_traverse_lock {
192 struct tdb_traverse_lock *next;
198 enum tdb_lock_flags {
199 /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
202 /* If set, don't log an error on failure. */
204 /* If set, don't actually lock at all. */
205 TDB_LOCK_MARK_ONLY = 4,
209 int (*tdb_read)(struct tdb_context *, tdb_off_t , void *, tdb_len_t , int );
210 int (*tdb_write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
211 void (*next_hash_chain)(struct tdb_context *, uint32_t *);
212 int (*tdb_oob)(struct tdb_context *, tdb_off_t , int );
213 int (*tdb_expand_file)(struct tdb_context *, tdb_off_t , tdb_off_t );
217 char *name; /* the name of the database */
218 void *map_ptr; /* where it is currently mapped */
219 int fd; /* open file descriptor for the database */
220 tdb_len_t map_size; /* how much space has been mapped */
221 int read_only; /* opened read-only */
222 int traverse_read; /* read-only traversal */
223 int traverse_write; /* read-write traversal */
224 struct tdb_lock_type allrecord_lock; /* .offset == upgradable */
226 struct tdb_lock_type *lockrecs; /* only real locks, all with count>0 */
227 enum TDB_ERROR ecode; /* error code for last tdb error */
228 struct tdb_header header; /* a cached copy of the header */
229 uint32_t flags; /* the flags passed to tdb_open */
230 struct tdb_traverse_lock travlocks; /* current traversal locks */
231 struct tdb_context *next; /* all tdbs to avoid multiple opens */
232 dev_t device; /* uniquely identifies this tdb */
233 ino_t inode; /* uniquely identifies this tdb */
234 struct tdb_logging_context log;
235 unsigned int (*hash_fn)(TDB_DATA *key);
236 int open_flags; /* flags used in the open - needed by reopen */
237 const struct tdb_methods *methods;
238 struct tdb_transaction *transaction;
240 int max_dead_records;
244 volatile sig_atomic_t *interrupt_sig_ptr;
251 int tdb_munmap(struct tdb_context *tdb);
252 void tdb_mmap(struct tdb_context *tdb);
253 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
254 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
255 int tdb_nest_lock(struct tdb_context *tdb, uint32_t offset, int ltype,
256 enum tdb_lock_flags flags);
257 int tdb_nest_unlock(struct tdb_context *tdb, uint32_t offset, int ltype,
259 bool tdb_have_locks(struct tdb_context *tdb);
260 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
261 int tdb_brlock(struct tdb_context *tdb,
262 int rw_type, tdb_off_t offset, size_t len,
263 enum tdb_lock_flags flags);
264 int tdb_brunlock(struct tdb_context *tdb,
265 int rw_type, tdb_off_t offset, size_t len);
266 bool tdb_have_extra_locks(struct tdb_context *tdb);
267 void tdb_release_extra_locks(struct tdb_context *tdb);
268 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
269 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
270 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
271 enum tdb_lock_flags flags, bool upgradable);
272 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype, bool mark_lock);
273 int tdb_allrecord_upgrade(struct tdb_context *tdb);
274 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
275 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
276 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
277 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
278 void *tdb_convert(void *buf, uint32_t size);
279 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
280 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct tdb_record *rec);
281 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
282 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
283 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
284 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
285 bool tdb_needs_recovery(struct tdb_context *tdb);
286 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
287 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
288 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct tdb_record *rec);
289 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
290 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
291 tdb_off_t offset, tdb_len_t len,
292 int (*parser)(TDB_DATA key, TDB_DATA data,
295 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
296 struct tdb_record *rec);
297 void tdb_io_init(struct tdb_context *tdb);
298 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
299 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
300 struct tdb_record *rec);