4 Trivial Database 2: private types and prototypes
5 Copyright (C) Rusty Russell 2010
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 3 of the License, or (at your option) any later version.
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #define _XOPEN_SOURCE 500
22 #define _FILE_OFFSET_BITS 64
37 #include <ccan/tdb2/tdb2.h>
38 #include <ccan/likely/likely.h>
39 #ifdef HAVE_BYTESWAP_H
47 /* #define TDB_TRACE 1 */
50 #define __STRING(x) #x
53 #ifndef __STRINGSTRING
54 #define __STRINGSTRING(x) __STRING(x)
58 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
61 typedef uint64_t tdb_len_t;
62 typedef uint64_t tdb_off_t;
64 #define TDB_MAGIC_FOOD "TDB file\n"
65 #define TDB_VERSION ((uint64_t)(0x26011967 + 7))
66 #define TDB_MAGIC ((uint64_t)0x1999)
67 #define TDB_FREE_MAGIC ((uint64_t)0xFE)
68 #define TDB_COALESCING_MAGIC ((uint64_t)0xFD)
69 #define TDB_HASH_MAGIC (0xA1ABE11A01092008ULL)
70 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
71 #define TDB_RECOVERY_INVALID_MAGIC (0x0)
73 #define TDB_OFF_ERR ((tdb_off_t)-1)
75 /* Prevent others from opening the file. */
76 #define TDB_OPEN_LOCK 0
77 /* Doing a transaction. */
78 #define TDB_TRANSACTION_LOCK 1
80 #define TDB_EXPANSION_LOCK 2
81 /* Hash chain locks. */
82 #define TDB_HASH_LOCK_START 3
84 /* Range for hash locks. */
85 #define TDB_HASH_LOCK_RANGE_BITS 30
86 #define TDB_HASH_LOCK_RANGE (1 << TDB_HASH_LOCK_RANGE_BITS)
88 /* We have 1024 entries in the top level. */
89 #define TDB_TOPLEVEL_HASH_BITS 10
90 /* And 64 entries in each sub-level: thus 64 bits exactly after 9 levels. */
91 #define TDB_SUBLEVEL_HASH_BITS 6
92 /* And 8 entries in each group, ie 8 groups per sublevel. */
93 #define TDB_HASH_GROUP_BITS 3
95 /* Extend file by least 32 times larger than needed. */
96 #define TDB_EXTENSION_FACTOR 32
98 /* We steal bits from the offsets to store hash info. */
99 #define TDB_OFF_HASH_GROUP_MASK ((1ULL << TDB_HASH_GROUP_BITS) - 1)
100 /* We steal this many upper bits, giving a maximum offset of 64 exabytes. */
101 #define TDB_OFF_UPPER_STEAL 8
102 #define TDB_OFF_UPPER_STEAL_EXTRA 7
103 #define TDB_OFF_UPPER_STEAL_TRUNCBIT 1
104 /* If this is set, hash is truncated (only 1 bit is valid). */
105 #define TDB_OFF_HASH_TRUNCATED_BIT 56
106 /* The bit number where we store next level of hash. */
107 #define TDB_OFF_HASH_EXTRA_BIT 57
108 /* Convenience mask to get actual offset. */
109 #define TDB_OFF_MASK \
110 (((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1) - TDB_OFF_HASH_GROUP_MASK)
112 /* How many buckets in a free list: see size_to_bucket(). */
113 #define TDB_FREE_BUCKETS (64 - TDB_OFF_UPPER_STEAL)
115 /* We have to be able to fit a free record here. */
116 #define TDB_MIN_DATA_LEN \
117 (sizeof(struct tdb_free_record) - sizeof(struct tdb_used_record))
120 static inline uint64_t bswap_64(uint64_t x)
122 return (((x&0x000000FFULL)<<56)
123 | ((x&0x0000FF00ULL)<<48)
124 | ((x&0x00FF0000ULL)<<40)
125 | ((x&0xFF000000ULL)<<32)
126 | ((x>>8)&0xFF000000ULL)
127 | ((x>>16)&0x00FF0000ULL)
128 | ((x>>24)&0x0000FF00ULL)
129 | ((x>>32)&0x000000FFULL));
133 struct tdb_used_record {
134 /* For on-disk compatibility, we avoid bitfields:
140 uint64_t magic_and_meta;
141 /* The bottom key_len_bits*2 are key length, rest is data length. */
142 uint64_t key_and_data_len;
145 static inline unsigned rec_key_bits(const struct tdb_used_record *r)
147 return ((r->magic_and_meta >> 43) & ((1 << 5)-1)) * 2;
150 static inline uint64_t rec_key_length(const struct tdb_used_record *r)
152 return r->key_and_data_len & ((1ULL << rec_key_bits(r)) - 1);
155 static inline uint64_t rec_data_length(const struct tdb_used_record *r)
157 return r->key_and_data_len >> rec_key_bits(r);
160 static inline uint64_t rec_extra_padding(const struct tdb_used_record *r)
162 return (r->magic_and_meta >> 11) & 0xFFFFFFFF;
165 static inline uint32_t rec_hash(const struct tdb_used_record *r)
167 return r->magic_and_meta & ((1 << 11) - 1);
170 static inline uint16_t rec_magic(const struct tdb_used_record *r)
172 return (r->magic_and_meta >> 48);
175 struct tdb_free_record {
176 uint64_t magic_and_meta; /* TDB_OFF_UPPER_STEAL bits of magic */
177 uint64_t data_len; /* Not counting these two fields. */
178 /* This is why the minimum record size is 16 bytes. */
182 static inline uint64_t frec_magic(const struct tdb_free_record *f)
184 return f->magic_and_meta >> (64 - TDB_OFF_UPPER_STEAL);
187 static inline uint64_t frec_flist(const struct tdb_free_record *f)
189 return f->magic_and_meta & ((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1);
192 /* this is stored at the front of every database */
194 char magic_food[64]; /* for /etc/magic */
195 /* FIXME: Make me 32 bit? */
196 uint64_t version; /* version of the code */
197 uint64_t hash_test; /* result of hashing HASH_MAGIC. */
198 uint64_t hash_seed; /* "random" seed written at creation time. */
199 tdb_off_t free_list; /* (First) free list. */
201 tdb_off_t reserved[27];
203 /* Top level hash table. */
204 tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
207 struct tdb_freelist {
208 struct tdb_used_record hdr;
210 tdb_off_t buckets[TDB_FREE_BUCKETS];
213 /* Information about a particular (locked) hash entry. */
215 /* Full hash value of entry. */
217 /* Start and length of lock acquired. */
218 tdb_off_t hlock_start;
219 tdb_len_t hlock_range;
220 /* Start of hash group. */
221 tdb_off_t group_start;
222 /* Bucket we belong in. */
223 unsigned int home_bucket;
224 /* Bucket we (or an empty space) were found in. */
225 unsigned int found_bucket;
226 /* How many bits of the hash are already used. */
227 unsigned int hash_used;
228 /* Current working group. */
229 tdb_off_t group[1 << TDB_HASH_GROUP_BITS];
232 struct traverse_info {
233 struct traverse_level {
235 /* We ignore groups here, and treat it as a big array. */
237 unsigned int total_buckets;
238 } levels[64 / TDB_SUBLEVEL_HASH_BITS];
239 unsigned int num_levels;
240 unsigned int toplevel_group;
241 /* This makes delete-everything-inside-traverse work as expected. */
245 enum tdb_lock_flags {
246 /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
249 /* If set, don't log an error on failure. */
253 struct tdb_lock_type {
260 /* Filename of the database. */
263 /* Mmap (if any), or malloc (for TDB_INTERNAL). */
266 /* Are we accessing directly? (debugging check). */
269 /* Open file descriptor (undefined for TDB_INTERNAL). */
272 /* How much space has been mapped (<= current file size) */
275 /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
278 /* mmap read only? */
281 /* Error code for last tdb error. */
282 enum TDB_ERROR ecode;
284 /* the flags passed to tdb_open, for tdb_reopen. */
287 /* Logging function */
296 /* Set if we are in a transaction. */
297 struct tdb_transaction *transaction;
299 /* What freelist are we using? */
302 /* IO methods: changes for transactions. */
303 const struct tdb_methods *methods;
305 /* Lock information */
306 struct tdb_lock_type allrecord_lock;
307 uint64_t num_lockrecs;
308 struct tdb_lock_type *lockrecs;
310 /* Single list of all TDBs, to avoid multiple opens. */
311 struct tdb_context *next;
317 int (*read)(struct tdb_context *, tdb_off_t, void *, tdb_len_t);
318 int (*write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
319 int (*oob)(struct tdb_context *, tdb_off_t, bool);
320 int (*expand_file)(struct tdb_context *, tdb_len_t);
321 void *(*direct)(struct tdb_context *, tdb_off_t, size_t);
328 void tdb_hash_init(struct tdb_context *tdb);
330 /* Hash random memory. */
331 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
334 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
336 /* Find and lock a hash entry (or where it would be). */
337 tdb_off_t find_and_lock(struct tdb_context *tdb,
341 struct tdb_used_record *rec,
342 struct traverse_info *tinfo);
344 int replace_in_hash(struct tdb_context *tdb,
348 int add_to_hash(struct tdb_context *tdb, struct hash_info *h,
351 int delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
354 bool is_subhash(tdb_off_t val);
357 int tdb_flist_init(struct tdb_context *tdb);
359 /* check.c needs these to iterate through free lists. */
360 tdb_off_t first_flist(struct tdb_context *tdb);
361 tdb_off_t next_flist(struct tdb_context *tdb, tdb_off_t flist);
363 /* If this fails, try tdb_expand. */
364 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
365 uint64_t hash, bool growing);
367 /* Put this record in a free list. */
368 int add_free_record(struct tdb_context *tdb,
369 tdb_off_t off, tdb_len_t len_with_header);
371 /* Set up header for a used record. */
372 int set_header(struct tdb_context *tdb,
373 struct tdb_used_record *rec,
374 uint64_t keylen, uint64_t datalen,
375 uint64_t actuallen, unsigned hashlow);
377 /* Used by tdb_check to verify. */
378 unsigned int size_to_bucket(tdb_len_t data_len);
379 tdb_off_t bucket_off(tdb_off_t flist_off, unsigned bucket);
382 /* Initialize tdb->methods. */
383 void tdb_io_init(struct tdb_context *tdb);
385 /* Convert endian of the buffer if required. */
386 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
388 /* Unmap and try to map the tdb. */
389 void tdb_munmap(struct tdb_context *tdb);
390 void tdb_mmap(struct tdb_context *tdb);
392 /* Either make a copy into pad and return that, or return ptr into mmap.
393 * Converts endian (ie. will use pad in that case). */
394 void *tdb_get(struct tdb_context *tdb, tdb_off_t off, void *pad, size_t len);
396 /* Either alloc a copy, or give direct access. Release frees or noop. */
397 const void *tdb_access_read(struct tdb_context *tdb,
398 tdb_off_t off, tdb_len_t len, bool convert);
399 void *tdb_access_write(struct tdb_context *tdb,
400 tdb_off_t off, tdb_len_t len, bool convert);
402 /* Release result of tdb_access_read/write. */
403 void tdb_access_release(struct tdb_context *tdb, const void *p);
404 /* Commit result of tdb_acces_write. */
405 int tdb_access_commit(struct tdb_context *tdb, void *p);
407 /* Convenience routine to get an offset. */
408 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
410 /* Write an offset at an offset. */
411 int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
413 /* Clear an ondisk area. */
414 int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
416 /* Return a non-zero offset between >= start < end in this array (or end). */
417 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
422 /* Return a zero offset in this array, or num. */
423 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
426 /* Even on files, we can get partial writes due to signals. */
427 bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off);
428 bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off);
429 bool tdb_read_all(int fd, void *buf, size_t len);
431 /* Allocate and make a copy of some offset. */
432 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
434 /* Writes a converted copy of a record. */
435 int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
436 const void *rec, size_t len);
438 /* Reads record and converts it */
439 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
440 void *rec, size_t len);
444 void tdb_lock_init(struct tdb_context *tdb);
446 /* Lock/unlock a range of hashes. */
447 int tdb_lock_hashes(struct tdb_context *tdb,
448 tdb_off_t hash_lock, tdb_len_t hash_range,
449 int ltype, enum tdb_lock_flags waitflag);
450 int tdb_unlock_hashes(struct tdb_context *tdb,
452 tdb_len_t hash_range, int ltype);
454 /* Lock/unlock a particular free bucket. */
455 int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
456 enum tdb_lock_flags waitflag);
457 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
459 /* Do we have any locks? */
460 bool tdb_has_locks(struct tdb_context *tdb);
462 /* Lock entire database. */
463 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
464 enum tdb_lock_flags flags, bool upgradable);
465 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
467 /* Serialize db open. */
468 int tdb_lock_open(struct tdb_context *tdb);
469 void tdb_unlock_open(struct tdb_context *tdb);
471 /* Serialize db expand. */
472 int tdb_lock_expand(struct tdb_context *tdb, int ltype);
473 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
474 bool tdb_has_expansion_lock(struct tdb_context *tdb);
478 int first_in_hash(struct tdb_context *tdb, int ltype,
479 struct traverse_info *tinfo,
480 TDB_DATA *kbuf, size_t *dlen);
481 int next_in_hash(struct tdb_context *tdb, int ltype,
482 struct traverse_info *tinfo,
483 TDB_DATA *kbuf, size_t *dlen);
487 /* Low-level locking primitives. */
488 int tdb_nest_lock(struct tdb_context *tdb, tdb_off_t offset, int ltype,
489 enum tdb_lock_flags flags);
490 int tdb_nest_unlock(struct tdb_context *tdb, tdb_off_t offset, int ltype);
492 int tdb_munmap(struct tdb_context *tdb);
493 void tdb_mmap(struct tdb_context *tdb);
494 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
495 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
496 bool tdb_have_locks(struct tdb_context *tdb);
497 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
498 int tdb_brlock(struct tdb_context *tdb,
499 int rw_type, tdb_off_t offset, size_t len,
500 enum tdb_lock_flags flags);
501 int tdb_brunlock(struct tdb_context *tdb,
502 int rw_type, tdb_off_t offset, size_t len);
503 bool tdb_have_extra_locks(struct tdb_context *tdb);
504 void tdb_release_extra_locks(struct tdb_context *tdb);
505 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
506 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
507 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
508 enum tdb_lock_flags flags, bool upgradable);
509 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
510 int tdb_allrecord_upgrade(struct tdb_context *tdb);
511 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
512 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
513 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
514 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
515 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
516 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct tdb_record *rec);
517 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
518 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
519 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
520 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
521 bool tdb_needs_recovery(struct tdb_context *tdb);
522 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
523 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
524 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct tdb_record *rec);
525 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
526 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
527 tdb_off_t offset, tdb_len_t len,
528 int (*parser)(TDB_DATA key, TDB_DATA data,
531 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
532 struct tdb_record *rec);
533 void tdb_io_init(struct tdb_context *tdb);
534 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
535 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
536 struct tdb_record *rec);
540 void tdb_trace(struct tdb_context *tdb, const char *op);
541 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
542 void tdb_trace_open(struct tdb_context *tdb, const char *op,
543 unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
544 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
545 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
546 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
548 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
549 TDB_DATA rec, int ret);
550 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
551 TDB_DATA rec, TDB_DATA ret);
552 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
553 TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
555 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
556 TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
558 #define tdb_trace(tdb, op)
559 #define tdb_trace_seqnum(tdb, seqnum, op)
560 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
561 #define tdb_trace_ret(tdb, op, ret)
562 #define tdb_trace_retrec(tdb, op, ret)
563 #define tdb_trace_1rec(tdb, op, rec)
564 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
565 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
566 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
567 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
568 #endif /* !TDB_TRACE */