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)TDB_MAGIC) << 6)
68 #define TDB_HASH_MAGIC (0xA1ABE11A01092008ULL)
69 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
70 #define TDB_RECOVERY_INVALID_MAGIC (0x0)
72 #define TDB_OFF_ERR ((tdb_off_t)-1)
74 /* Prevent others from opening the file. */
75 #define TDB_OPEN_LOCK 0
76 /* Doing a transaction. */
77 #define TDB_TRANSACTION_LOCK 1
79 #define TDB_EXPANSION_LOCK 2
80 /* Hash chain locks. */
81 #define TDB_HASH_LOCK_START 3
83 /* Range for hash locks. */
84 #define TDB_HASH_LOCK_RANGE_BITS 30
85 #define TDB_HASH_LOCK_RANGE (1 << TDB_HASH_LOCK_RANGE_BITS)
87 /* We have 1024 entries in the top level. */
88 #define TDB_TOPLEVEL_HASH_BITS 10
89 /* And 64 entries in each sub-level: thus 64 bits exactly after 9 levels. */
90 #define TDB_SUBLEVEL_HASH_BITS 6
91 /* And 8 entries in each group, ie 8 groups per sublevel. */
92 #define TDB_HASH_GROUP_BITS 3
94 /* We start with a 64k-sized zone. */
95 #define INITIAL_ZONE_BITS 16
96 /* Try to create zones at least 32 times larger than allocations. */
97 #define TDB_COMFORT_FACTOR_BITS 5
99 /* We steal bits from the offsets to store hash info. */
100 #define TDB_OFF_HASH_GROUP_MASK ((1ULL << TDB_HASH_GROUP_BITS) - 1)
101 /* We steal this many upper bits, giving a maximum offset of 64 exabytes. */
102 #define TDB_OFF_UPPER_STEAL 8
103 #define TDB_OFF_UPPER_STEAL_EXTRA 7
104 #define TDB_OFF_UPPER_STEAL_TRUNCBIT 1
105 /* If this is set, hash is truncated (only 1 bit is valid). */
106 #define TDB_OFF_HASH_TRUNCATED_BIT 56
107 /* The bit number where we store next level of hash. */
108 #define TDB_OFF_HASH_EXTRA_BIT 57
109 /* Convenience mask to get actual offset. */
110 #define TDB_OFF_MASK \
111 (((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1) - TDB_OFF_HASH_GROUP_MASK)
113 /* We have to be able to fit a free record here. */
114 #define TDB_MIN_DATA_LEN \
115 (sizeof(struct tdb_free_record) - sizeof(struct tdb_used_record))
117 /* We ensure buckets up to size 1 << (zone_bits - TDB_COMFORT_FACTOR_BITS). */
118 /* FIXME: test this matches size_to_bucket! */
119 #define BUCKETS_FOR_ZONE(zone_bits) ((zone_bits) + 2 - TDB_COMFORT_FACTOR_BITS)
122 static inline uint64_t bswap_64(uint64_t x)
124 return (((x&0x000000FFULL)<<56)
125 | ((x&0x0000FF00ULL)<<48)
126 | ((x&0x00FF0000ULL)<<40)
127 | ((x&0xFF000000ULL)<<32)
128 | ((x>>8)&0xFF000000ULL)
129 | ((x>>16)&0x00FF0000ULL)
130 | ((x>>24)&0x0000FF00ULL)
131 | ((x>>32)&0x000000FFULL));
135 struct tdb_used_record {
136 /* For on-disk compatibility, we avoid bitfields:
141 zone_bits: 6 (lowest)
143 uint64_t magic_and_meta;
144 /* The bottom key_len_bits*2 are key length, rest is data length. */
145 uint64_t key_and_data_len;
148 static inline unsigned rec_key_bits(const struct tdb_used_record *r)
150 return ((r->magic_and_meta >> 43) & ((1 << 5)-1)) * 2;
153 static inline uint64_t rec_key_length(const struct tdb_used_record *r)
155 return r->key_and_data_len & ((1ULL << rec_key_bits(r)) - 1);
158 static inline uint64_t rec_data_length(const struct tdb_used_record *r)
160 return r->key_and_data_len >> rec_key_bits(r);
163 static inline uint64_t rec_extra_padding(const struct tdb_used_record *r)
165 return (r->magic_and_meta >> 11) & 0xFFFFFFFF;
168 static inline unsigned int rec_zone_bits(const struct tdb_used_record *r)
170 return r->magic_and_meta & ((1 << 6) - 1);
173 static inline uint32_t rec_hash(const struct tdb_used_record *r)
175 return (r->magic_and_meta >> 6) & ((1 << 5) - 1);
178 static inline uint16_t rec_magic(const struct tdb_used_record *r)
180 return (r->magic_and_meta >> 48);
183 struct tdb_free_record {
184 uint64_t magic_and_meta; /* Bottom 6 bits are zone bits. */
185 uint64_t data_len; /* Not counting these two fields. */
186 /* This is why the minimum record size is 16 bytes. */
190 static inline unsigned int frec_zone_bits(const struct tdb_free_record *f)
192 return f->magic_and_meta & ((1 << 6) - 1);
195 static inline uint64_t frec_magic(const struct tdb_free_record *f)
197 return f->magic_and_meta & ~((1ULL << 6) - 1);
200 /* Each zone has its set of free lists at the head.
202 * For each zone we have a series of per-size buckets, and a final bucket for
204 struct free_zone_header {
205 /* How much does this zone cover? */
207 /* tdb_off_t buckets[free_buckets + 1] */
210 /* this is stored at the front of every database */
212 char magic_food[64]; /* for /etc/magic */
213 /* FIXME: Make me 32 bit? */
214 uint64_t version; /* version of the code */
215 uint64_t hash_test; /* result of hashing HASH_MAGIC. */
216 uint64_t hash_seed; /* "random" seed written at creation time. */
218 tdb_off_t reserved[28];
220 /* Top level hash table. */
221 tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
224 /* Information about a particular (locked) hash entry. */
226 /* Full hash value of entry. */
228 /* Start and length of lock acquired. */
229 tdb_off_t hlock_start;
230 tdb_len_t hlock_range;
231 /* Start of hash group. */
232 tdb_off_t group_start;
233 /* Bucket we belong in. */
234 unsigned int home_bucket;
235 /* Bucket we (or an empty space) were found in. */
236 unsigned int found_bucket;
237 /* How many bits of the hash are already used. */
238 unsigned int hash_used;
239 /* Current working group. */
240 tdb_off_t group[1 << TDB_HASH_GROUP_BITS];
243 struct traverse_info {
244 struct traverse_level {
246 /* We ignore groups here, and treat it as a big array. */
248 unsigned int total_buckets;
249 } levels[64 / TDB_SUBLEVEL_HASH_BITS];
250 unsigned int num_levels;
251 unsigned int toplevel_group;
252 /* This makes delete-everything-inside-traverse work as expected. */
256 enum tdb_lock_flags {
257 /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
260 /* If set, don't log an error on failure. */
264 struct tdb_lock_type {
271 /* Filename of the database. */
274 /* Mmap (if any), or malloc (for TDB_INTERNAL). */
277 /* Are we accessing directly? (debugging check). */
280 /* Open file descriptor (undefined for TDB_INTERNAL). */
283 /* How much space has been mapped (<= current file size) */
286 /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
289 /* mmap read only? */
292 /* Error code for last tdb error. */
293 enum TDB_ERROR ecode;
295 /* the flags passed to tdb_open, for tdb_reopen. */
298 /* Logging function */
307 /* Set if we are in a transaction. */
308 struct tdb_transaction *transaction;
310 /* What zone of the tdb to use, for spreading load. */
312 /* Cached copy of zone header. */
313 struct free_zone_header zhdr;
315 /* IO methods: changes for transactions. */
316 const struct tdb_methods *methods;
318 /* Lock information */
319 struct tdb_lock_type allrecord_lock;
320 uint64_t num_lockrecs;
321 struct tdb_lock_type *lockrecs;
323 /* Single list of all TDBs, to avoid multiple opens. */
324 struct tdb_context *next;
330 int (*read)(struct tdb_context *, tdb_off_t, void *, tdb_len_t);
331 int (*write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
332 int (*oob)(struct tdb_context *, tdb_off_t, bool);
333 int (*expand_file)(struct tdb_context *, tdb_len_t);
340 void tdb_hash_init(struct tdb_context *tdb);
342 /* Hash random memory. */
343 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
346 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
348 /* Find and lock a hash entry (or where it would be). */
349 tdb_off_t find_and_lock(struct tdb_context *tdb,
353 struct tdb_used_record *rec,
354 struct traverse_info *tinfo);
356 int replace_in_hash(struct tdb_context *tdb,
360 int add_to_hash(struct tdb_context *tdb, struct hash_info *h,
363 int delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
366 bool is_subhash(tdb_off_t val);
369 int tdb_zone_init(struct tdb_context *tdb);
371 /* If this fails, try tdb_expand. */
372 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
373 uint64_t hash, bool growing);
375 /* Put this record in a free list. */
376 int add_free_record(struct tdb_context *tdb, unsigned int zone_bits,
377 tdb_off_t off, tdb_len_t len_with_header);
379 /* Set up header for a used record. */
380 int set_header(struct tdb_context *tdb,
381 struct tdb_used_record *rec,
382 uint64_t keylen, uint64_t datalen,
383 uint64_t actuallen, uint64_t hash,
384 unsigned int zone_bits);
386 /* Used by tdb_check to verify. */
387 unsigned int size_to_bucket(unsigned int free_buckets, tdb_len_t data_len);
388 tdb_off_t bucket_off(tdb_off_t zone_off, tdb_off_t bucket);
391 /* Initialize tdb->methods. */
392 void tdb_io_init(struct tdb_context *tdb);
394 /* Convert endian of the buffer if required. */
395 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
397 /* Unmap and try to map the tdb. */
398 void tdb_munmap(struct tdb_context *tdb);
399 void tdb_mmap(struct tdb_context *tdb);
401 /* Either make a copy into pad and return that, or return ptr into mmap.
402 * Converts endian (ie. will use pad in that case). */
403 void *tdb_get(struct tdb_context *tdb, tdb_off_t off, void *pad, size_t len);
405 /* Either alloc a copy, or give direct access. Release frees or noop. */
406 const void *tdb_access_read(struct tdb_context *tdb,
407 tdb_off_t off, tdb_len_t len, bool convert);
408 void *tdb_access_write(struct tdb_context *tdb,
409 tdb_off_t off, tdb_len_t len, bool convert);
411 /* Release result of tdb_access_read/write. */
412 void tdb_access_release(struct tdb_context *tdb, const void *p);
413 /* Commit result of tdb_acces_write. */
414 int tdb_access_commit(struct tdb_context *tdb, void *p);
416 /* Convenience routine to get an offset. */
417 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
419 /* Write an offset at an offset. */
420 int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
422 /* Clear an ondisk area. */
423 int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
425 /* Return a non-zero offset between >= start < end in this array (or end). */
426 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
431 /* Return a zero offset in this array, or num. */
432 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
435 /* Even on files, we can get partial writes due to signals. */
436 bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off);
437 bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off);
438 bool tdb_read_all(int fd, void *buf, size_t len);
440 /* Allocate and make a copy of some offset. */
441 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
443 /* Writes a converted copy of a record. */
444 int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
445 const void *rec, size_t len);
447 /* Reads record and converts it */
448 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
449 void *rec, size_t len);
453 void tdb_lock_init(struct tdb_context *tdb);
455 /* Lock/unlock a range of hashes. */
456 int tdb_lock_hashes(struct tdb_context *tdb,
457 tdb_off_t hash_lock, tdb_len_t hash_range,
458 int ltype, enum tdb_lock_flags waitflag);
459 int tdb_unlock_hashes(struct tdb_context *tdb,
461 tdb_len_t hash_range, int ltype);
463 /* Lock/unlock a particular free bucket. */
464 int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
465 enum tdb_lock_flags waitflag);
466 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
468 /* Do we have any locks? */
469 bool tdb_has_locks(struct tdb_context *tdb);
471 /* Lock entire database. */
472 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
473 enum tdb_lock_flags flags, bool upgradable);
474 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
476 /* Serialize db open. */
477 int tdb_lock_open(struct tdb_context *tdb);
478 void tdb_unlock_open(struct tdb_context *tdb);
480 /* Serialize db expand. */
481 int tdb_lock_expand(struct tdb_context *tdb, int ltype);
482 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
483 bool tdb_has_expansion_lock(struct tdb_context *tdb);
487 int first_in_hash(struct tdb_context *tdb, int ltype,
488 struct traverse_info *tinfo,
489 TDB_DATA *kbuf, size_t *dlen);
490 int next_in_hash(struct tdb_context *tdb, int ltype,
491 struct traverse_info *tinfo,
492 TDB_DATA *kbuf, size_t *dlen);
496 /* Low-level locking primitives. */
497 int tdb_nest_lock(struct tdb_context *tdb, tdb_off_t offset, int ltype,
498 enum tdb_lock_flags flags);
499 int tdb_nest_unlock(struct tdb_context *tdb, tdb_off_t offset, int ltype);
501 int tdb_munmap(struct tdb_context *tdb);
502 void tdb_mmap(struct tdb_context *tdb);
503 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
504 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
505 bool tdb_have_locks(struct tdb_context *tdb);
506 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
507 int tdb_brlock(struct tdb_context *tdb,
508 int rw_type, tdb_off_t offset, size_t len,
509 enum tdb_lock_flags flags);
510 int tdb_brunlock(struct tdb_context *tdb,
511 int rw_type, tdb_off_t offset, size_t len);
512 bool tdb_have_extra_locks(struct tdb_context *tdb);
513 void tdb_release_extra_locks(struct tdb_context *tdb);
514 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
515 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
516 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
517 enum tdb_lock_flags flags, bool upgradable);
518 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
519 int tdb_allrecord_upgrade(struct tdb_context *tdb);
520 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
521 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
522 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
523 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
524 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
525 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct tdb_record *rec);
526 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
527 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
528 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
529 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
530 bool tdb_needs_recovery(struct tdb_context *tdb);
531 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
532 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
533 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct tdb_record *rec);
534 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
535 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
536 tdb_off_t offset, tdb_len_t len,
537 int (*parser)(TDB_DATA key, TDB_DATA data,
540 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
541 struct tdb_record *rec);
542 void tdb_io_init(struct tdb_context *tdb);
543 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
544 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
545 struct tdb_record *rec);
549 void tdb_trace(struct tdb_context *tdb, const char *op);
550 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
551 void tdb_trace_open(struct tdb_context *tdb, const char *op,
552 unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
553 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
554 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
555 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
557 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
558 TDB_DATA rec, int ret);
559 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
560 TDB_DATA rec, TDB_DATA ret);
561 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
562 TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
564 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
565 TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
567 #define tdb_trace(tdb, op)
568 #define tdb_trace_seqnum(tdb, seqnum, op)
569 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
570 #define tdb_trace_ret(tdb, op, ret)
571 #define tdb_trace_retrec(tdb, op, ret)
572 #define tdb_trace_1rec(tdb, op, rec)
573 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
574 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
575 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
576 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
577 #endif /* !TDB_TRACE */