tdb2: make summary command handle recovery "dead zone"
[ccan] / ccan / tdb2 / private.h
1 #ifndef TDB_PRIVATE_H
2 #define TDB_PRIVATE_H
3  /* 
4    Trivial Database 2: private types and prototypes
5    Copyright (C) Rusty Russell 2010
6
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.
11
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.
16
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/>.
19 */
20
21 #define _XOPEN_SOURCE 500
22 #define _FILE_OFFSET_BITS 64
23 #include <stdint.h>
24 #include <stdbool.h>
25 #include <stdlib.h>
26 #include <stddef.h>
27 #include <sys/time.h>
28 #include <sys/mman.h>
29 #include <unistd.h>
30 #include <fcntl.h>
31 #include <string.h>
32 #include <errno.h>
33 #include <stdio.h>
34 #include <utime.h>
35 #include <unistd.h>
36 #include "config.h"
37 #include <ccan/tdb2/tdb2.h>
38 #include <ccan/likely/likely.h>
39 #ifdef HAVE_BYTESWAP_H
40 #include <byteswap.h>
41 #endif
42
43 #ifndef TEST_IT
44 #define TEST_IT(cond)
45 #endif
46
47 /* #define TDB_TRACE 1 */
48
49 #ifndef __STRING
50 #define __STRING(x)    #x
51 #endif
52
53 #ifndef __STRINGSTRING
54 #define __STRINGSTRING(x) __STRING(x)
55 #endif
56
57 #ifndef __location__
58 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
59 #endif
60
61 typedef uint64_t tdb_len_t;
62 typedef uint64_t tdb_off_t;
63
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 (0xf53bc0e7ad124589ULL)
71 #define TDB_RECOVERY_INVALID_MAGIC (0x0ULL)
72
73 #define TDB_OFF_ERR ((tdb_off_t)-1)
74
75 /* Prevent others from opening the file. */
76 #define TDB_OPEN_LOCK 0
77 /* Doing a transaction. */
78 #define TDB_TRANSACTION_LOCK 1
79 /* Expanding file. */
80 #define TDB_EXPANSION_LOCK 2
81 /* Hash chain locks. */
82 #define TDB_HASH_LOCK_START 3
83
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)
87
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
94
95 /* Extend file by least 32 times larger than needed. */
96 #define TDB_EXTENSION_FACTOR 32
97
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)
111
112 /* How many buckets in a free list: see size_to_bucket(). */
113 #define TDB_FREE_BUCKETS (64 - TDB_OFF_UPPER_STEAL)
114
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))
118
119 #if !HAVE_BSWAP_64
120 static inline uint64_t bswap_64(uint64_t x)
121 {
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));
130 }
131 #endif
132
133 struct tdb_used_record {
134         /* For on-disk compatibility, we avoid bitfields:
135            magic: 16,        (highest)
136            key_len_bits: 5,
137            extra_padding: 32
138            hash_bits: 11
139         */
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;
143 };
144
145 static inline unsigned rec_key_bits(const struct tdb_used_record *r)
146 {
147         return ((r->magic_and_meta >> 43) & ((1 << 5)-1)) * 2;
148 }
149
150 static inline uint64_t rec_key_length(const struct tdb_used_record *r)
151 {
152         return r->key_and_data_len & ((1ULL << rec_key_bits(r)) - 1);
153 }
154
155 static inline uint64_t rec_data_length(const struct tdb_used_record *r)
156 {
157         return r->key_and_data_len >> rec_key_bits(r);
158 }
159
160 static inline uint64_t rec_extra_padding(const struct tdb_used_record *r)
161 {
162         return (r->magic_and_meta >> 11) & 0xFFFFFFFF;
163 }
164
165 static inline uint32_t rec_hash(const struct tdb_used_record *r)
166 {
167         return r->magic_and_meta & ((1 << 11) - 1);
168 }
169
170 static inline uint16_t rec_magic(const struct tdb_used_record *r)
171 {
172         return (r->magic_and_meta >> 48);
173 }
174
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.  */
179         uint64_t next, prev;
180 };
181
182 static inline uint64_t frec_magic(const struct tdb_free_record *f)
183 {
184         return f->magic_and_meta >> (64 - TDB_OFF_UPPER_STEAL);
185 }
186
187 static inline uint64_t frec_flist(const struct tdb_free_record *f)
188 {
189         return f->magic_and_meta & ((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1);
190 }
191
192 struct tdb_recovery_record {
193         uint64_t magic;
194         /* Length of record. */
195         uint64_t max_len;
196         /* Length used. */
197         uint64_t len;
198         /* Old length of file before transaction. */
199         uint64_t eof;
200 };
201
202 /* this is stored at the front of every database */
203 struct tdb_header {
204         char magic_food[64]; /* for /etc/magic */
205         /* FIXME: Make me 32 bit? */
206         uint64_t version; /* version of the code */
207         uint64_t hash_test; /* result of hashing HASH_MAGIC. */
208         uint64_t hash_seed; /* "random" seed written at creation time. */
209         tdb_off_t free_list; /* (First) free list. */
210         tdb_off_t recovery; /* Transaction recovery area. */
211
212         tdb_off_t reserved[26];
213
214         /* Top level hash table. */
215         tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
216 };
217
218 struct tdb_freelist {
219         struct tdb_used_record hdr;
220         tdb_off_t next;
221         tdb_off_t buckets[TDB_FREE_BUCKETS];
222 };
223
224 /* Information about a particular (locked) hash entry. */
225 struct hash_info {
226         /* Full hash value of entry. */
227         uint64_t h;
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];
241 };
242
243 struct traverse_info {
244         struct traverse_level {
245                 tdb_off_t hashtable;
246                 /* We ignore groups here, and treat it as a big array. */
247                 unsigned entry;
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. */
253         tdb_off_t prev;
254 };
255
256 enum tdb_lock_flags {
257         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
258         TDB_LOCK_NOWAIT = 0,
259         TDB_LOCK_WAIT = 1,
260         /* If set, don't log an error on failure. */
261         TDB_LOCK_PROBE = 2,
262         /* If set, don't check for recovery (used by recovery code). */
263         TDB_LOCK_NOCHECK = 4,
264 };
265
266 struct tdb_lock_type {
267         uint32_t off;
268         uint32_t count;
269         uint32_t ltype;
270 };
271
272 struct tdb_context {
273         /* Filename of the database. */
274         const char *name;
275
276         /* Mmap (if any), or malloc (for TDB_INTERNAL). */
277         void *map_ptr;
278
279         /* Are we accessing directly? (debugging check). */
280         int direct_access;
281
282          /* Open file descriptor (undefined for TDB_INTERNAL). */
283         int fd;
284
285         /* How much space has been mapped (<= current file size) */
286         tdb_len_t map_size;
287
288         /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
289         bool read_only;
290
291         /* mmap read only? */
292         int mmap_flags;
293
294         /* Error code for last tdb error. */
295         enum TDB_ERROR ecode; 
296
297         /* the flags passed to tdb_open, for tdb_reopen. */
298         uint32_t flags;
299
300         /* Logging function */
301         tdb_logfn_t log;
302         void *log_priv;
303
304         /* Hash function. */
305         tdb_hashfn_t khash;
306         void *hash_priv;
307         uint64_t hash_seed;
308
309         /* Set if we are in a transaction. */
310         struct tdb_transaction *transaction;
311         
312         /* What freelist are we using? */
313         uint64_t flist_off;
314
315         /* IO methods: changes for transactions. */
316         const struct tdb_methods *methods;
317
318         /* Lock information */
319         struct tdb_lock_type allrecord_lock;
320         uint64_t num_lockrecs;
321         struct tdb_lock_type *lockrecs;
322
323         /* Single list of all TDBs, to avoid multiple opens. */
324         struct tdb_context *next;
325         dev_t device;   
326         ino_t inode;
327 };
328
329 struct tdb_methods {
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);
334         void *(*direct)(struct tdb_context *, tdb_off_t, size_t);
335 };
336
337 /*
338   internal prototypes
339 */
340 /* hash.c: */
341 void tdb_hash_init(struct tdb_context *tdb);
342
343 /* Hash random memory. */
344 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
345
346 /* Hash on disk. */
347 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
348
349 /* Find and lock a hash entry (or where it would be). */
350 tdb_off_t find_and_lock(struct tdb_context *tdb,
351                         struct tdb_data key,
352                         int ltype,
353                         struct hash_info *h,
354                         struct tdb_used_record *rec,
355                         struct traverse_info *tinfo);
356
357 int replace_in_hash(struct tdb_context *tdb,
358                     struct hash_info *h,
359                     tdb_off_t new_off);
360
361 int add_to_hash(struct tdb_context *tdb, struct hash_info *h,
362                 tdb_off_t new_off);
363
364 int delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
365
366 /* For tdb_check */
367 bool is_subhash(tdb_off_t val);
368
369 /* free.c: */
370 int tdb_flist_init(struct tdb_context *tdb);
371
372 /* check.c needs these to iterate through free lists. */
373 tdb_off_t first_flist(struct tdb_context *tdb);
374 tdb_off_t next_flist(struct tdb_context *tdb, tdb_off_t flist);
375
376 /* If this fails, try tdb_expand. */
377 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
378                 uint64_t hash, bool growing);
379
380 /* Put this record in a free list. */
381 int add_free_record(struct tdb_context *tdb,
382                     tdb_off_t off, tdb_len_t len_with_header);
383
384 /* Set up header for a used record. */
385 int set_header(struct tdb_context *tdb,
386                struct tdb_used_record *rec,
387                uint64_t keylen, uint64_t datalen,
388                uint64_t actuallen, unsigned hashlow);
389
390 /* Used by tdb_check to verify. */
391 unsigned int size_to_bucket(tdb_len_t data_len);
392 tdb_off_t bucket_off(tdb_off_t flist_off, unsigned bucket);
393
394 /* Used by tdb_summary */
395 size_t dead_space(struct tdb_context *tdb, tdb_off_t off);
396
397 /* io.c: */
398 /* Initialize tdb->methods. */
399 void tdb_io_init(struct tdb_context *tdb);
400
401 /* Convert endian of the buffer if required. */
402 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
403
404 /* Unmap and try to map the tdb. */
405 void tdb_munmap(struct tdb_context *tdb);
406 void tdb_mmap(struct tdb_context *tdb);
407
408 /* Either make a copy into pad and return that, or return ptr into mmap.
409  * Converts endian (ie. will use pad in that case). */
410 void *tdb_get(struct tdb_context *tdb, tdb_off_t off, void *pad, size_t len);
411
412 /* Either alloc a copy, or give direct access.  Release frees or noop. */
413 const void *tdb_access_read(struct tdb_context *tdb,
414                             tdb_off_t off, tdb_len_t len, bool convert);
415 void *tdb_access_write(struct tdb_context *tdb,
416                        tdb_off_t off, tdb_len_t len, bool convert);
417
418 /* Release result of tdb_access_read/write. */
419 void tdb_access_release(struct tdb_context *tdb, const void *p);
420 /* Commit result of tdb_acces_write. */
421 int tdb_access_commit(struct tdb_context *tdb, void *p);
422
423 /* Convenience routine to get an offset. */
424 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
425
426 /* Write an offset at an offset. */
427 int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
428
429 /* Clear an ondisk area. */
430 int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
431
432 /* Return a non-zero offset between >= start < end in this array (or end). */
433 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
434                                tdb_off_t base,
435                                uint64_t start,
436                                uint64_t end);
437
438 /* Return a zero offset in this array, or num. */
439 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
440                             uint64_t num);
441
442 /* Even on files, we can get partial writes due to signals. */
443 bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off);
444 bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off);
445 bool tdb_read_all(int fd, void *buf, size_t len);
446
447 /* Allocate and make a copy of some offset. */
448 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
449
450 /* Writes a converted copy of a record. */
451 int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
452                       const void *rec, size_t len);
453
454 /* Reads record and converts it */
455 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
456                      void *rec, size_t len);
457
458
459 /* lock.c: */
460 void tdb_lock_init(struct tdb_context *tdb);
461
462 /* Lock/unlock a range of hashes. */
463 int tdb_lock_hashes(struct tdb_context *tdb,
464                     tdb_off_t hash_lock, tdb_len_t hash_range,
465                     int ltype, enum tdb_lock_flags waitflag);
466 int tdb_unlock_hashes(struct tdb_context *tdb,
467                       tdb_off_t hash_lock,
468                       tdb_len_t hash_range, int ltype);
469
470 /* Lock/unlock a particular free bucket. */
471 int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
472                          enum tdb_lock_flags waitflag);
473 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
474
475 /* Serialize transaction start. */
476 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
477 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
478
479 /* Do we have any hash locks (ie. via tdb_chainlock) ? */
480 bool tdb_has_hash_locks(struct tdb_context *tdb);
481
482 /* Lock entire database. */
483 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
484                        enum tdb_lock_flags flags, bool upgradable);
485 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
486 int tdb_allrecord_upgrade(struct tdb_context *tdb);
487
488 /* Serialize db open. */
489 int tdb_lock_open(struct tdb_context *tdb, enum tdb_lock_flags flags);
490 void tdb_unlock_open(struct tdb_context *tdb);
491 bool tdb_has_open_lock(struct tdb_context *tdb);
492
493 /* Serialize db expand. */
494 int tdb_lock_expand(struct tdb_context *tdb, int ltype);
495 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
496 bool tdb_has_expansion_lock(struct tdb_context *tdb);
497
498 /* If it needs recovery, grab all the locks and do it. */
499 int tdb_lock_and_recover(struct tdb_context *tdb);
500
501 /* traverse.c: */
502 int first_in_hash(struct tdb_context *tdb, int ltype,
503                   struct traverse_info *tinfo,
504                   TDB_DATA *kbuf, size_t *dlen);
505 int next_in_hash(struct tdb_context *tdb, int ltype,
506                  struct traverse_info *tinfo,
507                  TDB_DATA *kbuf, size_t *dlen);
508
509 /* transaction.c: */
510 int tdb_transaction_recover(struct tdb_context *tdb);
511 bool tdb_needs_recovery(struct tdb_context *tdb);
512
513 #ifdef TDB_TRACE
514 void tdb_trace(struct tdb_context *tdb, const char *op);
515 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
516 void tdb_trace_open(struct tdb_context *tdb, const char *op,
517                     unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
518 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
519 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
520 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
521                     TDB_DATA rec);
522 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
523                         TDB_DATA rec, int ret);
524 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
525                            TDB_DATA rec, TDB_DATA ret);
526 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
527                              TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
528                              int ret);
529 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
530                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
531 #else
532 #define tdb_trace(tdb, op)
533 #define tdb_trace_seqnum(tdb, seqnum, op)
534 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
535 #define tdb_trace_ret(tdb, op, ret)
536 #define tdb_trace_retrec(tdb, op, ret)
537 #define tdb_trace_1rec(tdb, op, rec)
538 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
539 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
540 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
541 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
542 #endif /* !TDB_TRACE */
543
544 #endif