8601a9a48e6497d0a93e3dfefe702ef897053a8e
[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 #include <ccan/compiler/compiler.h>
40 #ifdef HAVE_BYTESWAP_H
41 #include <byteswap.h>
42 #endif
43
44 #ifndef TEST_IT
45 #define TEST_IT(cond)
46 #endif
47
48 /* #define TDB_TRACE 1 */
49
50 #ifndef __STRING
51 #define __STRING(x)    #x
52 #endif
53
54 #ifndef __STRINGSTRING
55 #define __STRINGSTRING(x) __STRING(x)
56 #endif
57
58 #ifndef __location__
59 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
60 #endif
61
62 typedef uint64_t tdb_len_t;
63 typedef uint64_t tdb_off_t;
64
65 #define TDB_MAGIC_FOOD "TDB file\n"
66 #define TDB_VERSION ((uint64_t)(0x26011967 + 7))
67 #define TDB_MAGIC ((uint64_t)0x1999)
68 #define TDB_FREE_MAGIC ((uint64_t)0xFE)
69 #define TDB_COALESCING_MAGIC ((uint64_t)0xFD)
70 #define TDB_HASH_MAGIC (0xA1ABE11A01092008ULL)
71 #define TDB_RECOVERY_MAGIC (0xf53bc0e7ad124589ULL)
72 #define TDB_RECOVERY_INVALID_MAGIC (0x0ULL)
73
74 #define TDB_OFF_ERR ((tdb_off_t)-1)
75
76 /* Prevent others from opening the file. */
77 #define TDB_OPEN_LOCK 0
78 /* Doing a transaction. */
79 #define TDB_TRANSACTION_LOCK 1
80 /* Expanding file. */
81 #define TDB_EXPANSION_LOCK 2
82 /* Hash chain locks. */
83 #define TDB_HASH_LOCK_START 3
84
85 /* Range for hash locks. */
86 #define TDB_HASH_LOCK_RANGE_BITS 30
87 #define TDB_HASH_LOCK_RANGE (1 << TDB_HASH_LOCK_RANGE_BITS)
88
89 /* We have 1024 entries in the top level. */
90 #define TDB_TOPLEVEL_HASH_BITS 10
91 /* And 64 entries in each sub-level: thus 64 bits exactly after 9 levels. */
92 #define TDB_SUBLEVEL_HASH_BITS 6
93 /* And 8 entries in each group, ie 8 groups per sublevel. */
94 #define TDB_HASH_GROUP_BITS 3
95
96 /* Extend file by least 100 times larger than needed. */
97 #define TDB_EXTENSION_FACTOR 100
98
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 /* The bit number where we store extra hash bits. */
105 #define TDB_OFF_HASH_EXTRA_BIT 57
106 #define TDB_OFF_UPPER_STEAL_SUBHASH_BIT 56
107
108 /* The bit number where we store the extra hash bits. */
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)
112
113 /* How many buckets in a free list: see size_to_bucket(). */
114 #define TDB_FREE_BUCKETS (64 - TDB_OFF_UPPER_STEAL)
115
116 /* We have to be able to fit a free record here. */
117 #define TDB_MIN_DATA_LEN        \
118         (sizeof(struct tdb_free_record) - sizeof(struct tdb_used_record))
119
120 #if !HAVE_BSWAP_64
121 static inline uint64_t bswap_64(uint64_t x)
122 {
123         return (((x&0x000000FFULL)<<56)
124                 | ((x&0x0000FF00ULL)<<48)
125                 | ((x&0x00FF0000ULL)<<40)
126                 | ((x&0xFF000000ULL)<<32)
127                 | ((x>>8)&0xFF000000ULL)
128                 | ((x>>16)&0x00FF0000ULL)
129                 | ((x>>24)&0x0000FF00ULL)
130                 | ((x>>32)&0x000000FFULL));
131 }
132 #endif
133
134 struct tdb_used_record {
135         /* For on-disk compatibility, we avoid bitfields:
136            magic: 16,        (highest)
137            key_len_bits: 5,
138            extra_padding: 32
139            hash_bits: 11
140         */
141         uint64_t magic_and_meta;
142         /* The bottom key_len_bits*2 are key length, rest is data length. */
143         uint64_t key_and_data_len;
144 };
145
146 static inline unsigned rec_key_bits(const struct tdb_used_record *r)
147 {
148         return ((r->magic_and_meta >> 43) & ((1 << 5)-1)) * 2;
149 }
150
151 static inline uint64_t rec_key_length(const struct tdb_used_record *r)
152 {
153         return r->key_and_data_len & ((1ULL << rec_key_bits(r)) - 1);
154 }
155
156 static inline uint64_t rec_data_length(const struct tdb_used_record *r)
157 {
158         return r->key_and_data_len >> rec_key_bits(r);
159 }
160
161 static inline uint64_t rec_extra_padding(const struct tdb_used_record *r)
162 {
163         return (r->magic_and_meta >> 11) & 0xFFFFFFFF;
164 }
165
166 static inline uint32_t rec_hash(const struct tdb_used_record *r)
167 {
168         return r->magic_and_meta & ((1 << 11) - 1);
169 }
170
171 static inline uint16_t rec_magic(const struct tdb_used_record *r)
172 {
173         return (r->magic_and_meta >> 48);
174 }
175
176 struct tdb_free_record {
177         uint64_t magic_and_prev; /* TDB_OFF_UPPER_STEAL bits magic, then prev */
178         uint64_t flist_and_len; /* Len not counting these two fields. */
179         /* This is why the minimum record size is 8 bytes.  */
180         uint64_t next;
181 };
182
183 static inline uint64_t frec_prev(const struct tdb_free_record *f)
184 {
185         return f->magic_and_prev & ((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1);
186 }
187
188 static inline uint64_t frec_magic(const struct tdb_free_record *f)
189 {
190         return f->magic_and_prev >> (64 - TDB_OFF_UPPER_STEAL);
191 }
192
193 static inline uint64_t frec_len(const struct tdb_free_record *f)
194 {
195         return f->flist_and_len & ((1ULL << (64 - TDB_OFF_UPPER_STEAL))-1);
196 }
197
198 static inline unsigned frec_flist(const struct tdb_free_record *f)
199 {
200         return f->flist_and_len >> (64 - TDB_OFF_UPPER_STEAL);
201 }
202
203 struct tdb_recovery_record {
204         uint64_t magic;
205         /* Length of record. */
206         uint64_t max_len;
207         /* Length used. */
208         uint64_t len;
209         /* Old length of file before transaction. */
210         uint64_t eof;
211 };
212
213 /* this is stored at the front of every database */
214 struct tdb_header {
215         char magic_food[64]; /* for /etc/magic */
216         /* FIXME: Make me 32 bit? */
217         uint64_t version; /* version of the code */
218         uint64_t hash_test; /* result of hashing HASH_MAGIC. */
219         uint64_t hash_seed; /* "random" seed written at creation time. */
220         tdb_off_t free_list; /* (First) free list. */
221         tdb_off_t recovery; /* Transaction recovery area. */
222
223         tdb_off_t reserved[26];
224
225         /* Top level hash table. */
226         tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
227 };
228
229 struct tdb_freelist {
230         struct tdb_used_record hdr;
231         tdb_off_t next;
232         tdb_off_t buckets[TDB_FREE_BUCKETS];
233 };
234
235 /* Information about a particular (locked) hash entry. */
236 struct hash_info {
237         /* Full hash value of entry. */
238         uint64_t h;
239         /* Start and length of lock acquired. */
240         tdb_off_t hlock_start;
241         tdb_len_t hlock_range;
242         /* Start of hash group. */
243         tdb_off_t group_start;
244         /* Bucket we belong in. */
245         unsigned int home_bucket;
246         /* Bucket we (or an empty space) were found in. */
247         unsigned int found_bucket;
248         /* How many bits of the hash are already used. */
249         unsigned int hash_used;
250         /* Current working group. */
251         tdb_off_t group[1 << TDB_HASH_GROUP_BITS];
252 };
253
254 struct traverse_info {
255         struct traverse_level {
256                 tdb_off_t hashtable;
257                 /* We ignore groups here, and treat it as a big array. */
258                 unsigned entry;
259                 unsigned int total_buckets;
260         } levels[64 / TDB_SUBLEVEL_HASH_BITS];
261         unsigned int num_levels;
262         unsigned int toplevel_group;
263         /* This makes delete-everything-inside-traverse work as expected. */
264         tdb_off_t prev;
265 };
266
267 enum tdb_lock_flags {
268         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
269         TDB_LOCK_NOWAIT = 0,
270         TDB_LOCK_WAIT = 1,
271         /* If set, don't log an error on failure. */
272         TDB_LOCK_PROBE = 2,
273         /* If set, don't check for recovery (used by recovery code). */
274         TDB_LOCK_NOCHECK = 4,
275 };
276
277 struct tdb_lock_type {
278         uint32_t off;
279         uint32_t count;
280         uint32_t ltype;
281 };
282
283 struct tdb_context {
284         /* Filename of the database. */
285         const char *name;
286
287         /* Mmap (if any), or malloc (for TDB_INTERNAL). */
288         void *map_ptr;
289
290         /* Are we accessing directly? (debugging check). */
291         int direct_access;
292
293          /* Open file descriptor (undefined for TDB_INTERNAL). */
294         int fd;
295
296         /* How much space has been mapped (<= current file size) */
297         tdb_len_t map_size;
298
299         /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
300         bool read_only;
301
302         /* mmap read only? */
303         int mmap_flags;
304
305         /* Error code for last tdb error. */
306         enum TDB_ERROR ecode; 
307
308         /* the flags passed to tdb_open, for tdb_reopen. */
309         uint32_t flags;
310
311         /* Logging function */
312         tdb_logfn_t logfn;
313         void *log_private;
314
315         /* Hash function. */
316         tdb_hashfn_t khash;
317         void *hash_priv;
318         uint64_t hash_seed;
319
320         /* Set if we are in a transaction. */
321         struct tdb_transaction *transaction;
322         
323         /* What freelist are we using? */
324         uint64_t flist_off;
325         unsigned int flist;
326
327         /* IO methods: changes for transactions. */
328         const struct tdb_methods *methods;
329
330         /* Lock information */
331         struct tdb_lock_type allrecord_lock;
332         size_t num_lockrecs;
333         struct tdb_lock_type *lockrecs;
334
335         struct tdb_attribute_stats *stats;
336
337         /* Single list of all TDBs, to avoid multiple opens. */
338         struct tdb_context *next;
339         dev_t device;   
340         ino_t inode;
341 };
342
343 struct tdb_methods {
344         int (*read)(struct tdb_context *, tdb_off_t, void *, tdb_len_t);
345         int (*write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
346         int (*oob)(struct tdb_context *, tdb_off_t, bool);
347         int (*expand_file)(struct tdb_context *, tdb_len_t);
348         void *(*direct)(struct tdb_context *, tdb_off_t, size_t);
349 };
350
351 /*
352   internal prototypes
353 */
354 /* hash.c: */
355 void tdb_hash_init(struct tdb_context *tdb);
356
357 /* Hash random memory. */
358 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
359
360 /* Hash on disk. */
361 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
362
363 /* Find and lock a hash entry (or where it would be). */
364 tdb_off_t find_and_lock(struct tdb_context *tdb,
365                         struct tdb_data key,
366                         int ltype,
367                         struct hash_info *h,
368                         struct tdb_used_record *rec,
369                         struct traverse_info *tinfo);
370
371 int replace_in_hash(struct tdb_context *tdb,
372                     struct hash_info *h,
373                     tdb_off_t new_off);
374
375 int add_to_hash(struct tdb_context *tdb, struct hash_info *h,
376                 tdb_off_t new_off);
377
378 int delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
379
380 /* For tdb_check */
381 bool is_subhash(tdb_off_t val);
382
383 /* free.c: */
384 int tdb_flist_init(struct tdb_context *tdb);
385
386 /* check.c needs these to iterate through free lists. */
387 tdb_off_t first_flist(struct tdb_context *tdb);
388 tdb_off_t next_flist(struct tdb_context *tdb, tdb_off_t flist);
389
390 /* If this fails, try tdb_expand. */
391 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
392                 uint64_t hash, bool growing);
393
394 /* Put this record in a free list. */
395 int add_free_record(struct tdb_context *tdb,
396                     tdb_off_t off, tdb_len_t len_with_header);
397
398 /* Set up header for a used record. */
399 int set_used_header(struct tdb_context *tdb,
400                     struct tdb_used_record *rec,
401                     uint64_t keylen, uint64_t datalen,
402                     uint64_t actuallen, unsigned hashlow);
403
404 /* Used by tdb_check to verify. */
405 unsigned int size_to_bucket(tdb_len_t data_len);
406 tdb_off_t bucket_off(tdb_off_t flist_off, unsigned bucket);
407
408 /* Used by tdb_summary */
409 size_t dead_space(struct tdb_context *tdb, tdb_off_t off);
410
411 /* io.c: */
412 /* Initialize tdb->methods. */
413 void tdb_io_init(struct tdb_context *tdb);
414
415 /* Convert endian of the buffer if required. */
416 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
417
418 /* Unmap and try to map the tdb. */
419 void tdb_munmap(struct tdb_context *tdb);
420 void tdb_mmap(struct tdb_context *tdb);
421
422 /* Either alloc a copy, or give direct access.  Release frees or noop. */
423 const void *tdb_access_read(struct tdb_context *tdb,
424                             tdb_off_t off, tdb_len_t len, bool convert);
425 void *tdb_access_write(struct tdb_context *tdb,
426                        tdb_off_t off, tdb_len_t len, bool convert);
427
428 /* Is this pointer direct?  (Otherwise it's malloced) */
429 bool is_direct(const struct tdb_context *tdb, const void *p);
430
431 /* Release result of tdb_access_read/write. */
432 void tdb_access_release(struct tdb_context *tdb, const void *p);
433 /* Commit result of tdb_acces_write. */
434 int tdb_access_commit(struct tdb_context *tdb, void *p);
435
436 /* Convenience routine to get an offset. */
437 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
438
439 /* Write an offset at an offset. */
440 int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
441
442 /* Clear an ondisk area. */
443 int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
444
445 /* Return a non-zero offset between >= start < end in this array (or end). */
446 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
447                                tdb_off_t base,
448                                uint64_t start,
449                                uint64_t end);
450
451 /* Return a zero offset in this array, or num. */
452 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
453                             uint64_t num);
454
455 /* Even on files, we can get partial writes due to signals. */
456 bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off);
457 bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off);
458 bool tdb_read_all(int fd, void *buf, size_t len);
459
460 /* Allocate and make a copy of some offset. */
461 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
462
463 /* Writes a converted copy of a record. */
464 int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
465                       const void *rec, size_t len);
466
467 /* Reads record and converts it */
468 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
469                      void *rec, size_t len);
470
471 /* Adds a stat, if it's in range. */
472 void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val);
473 #define add_stat(tdb, statname, val)                                    \
474         do {                                                            \
475                 if (unlikely((tdb)->stats))                             \
476                         add_stat_((tdb), &(tdb)->stats->statname, (val)); \
477         } while (0)
478
479 /* lock.c: */
480 void tdb_lock_init(struct tdb_context *tdb);
481
482 /* Lock/unlock a range of hashes. */
483 int tdb_lock_hashes(struct tdb_context *tdb,
484                     tdb_off_t hash_lock, tdb_len_t hash_range,
485                     int ltype, enum tdb_lock_flags waitflag);
486 int tdb_unlock_hashes(struct tdb_context *tdb,
487                       tdb_off_t hash_lock,
488                       tdb_len_t hash_range, int ltype);
489
490 /* Lock/unlock a particular free bucket. */
491 int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
492                          enum tdb_lock_flags waitflag);
493 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
494
495 /* Serialize transaction start. */
496 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
497 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
498
499 /* Do we have any hash locks (ie. via tdb_chainlock) ? */
500 bool tdb_has_hash_locks(struct tdb_context *tdb);
501
502 /* Lock entire database. */
503 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
504                        enum tdb_lock_flags flags, bool upgradable);
505 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
506 int tdb_allrecord_upgrade(struct tdb_context *tdb);
507
508 /* Serialize db open. */
509 int tdb_lock_open(struct tdb_context *tdb, enum tdb_lock_flags flags);
510 void tdb_unlock_open(struct tdb_context *tdb);
511 bool tdb_has_open_lock(struct tdb_context *tdb);
512
513 /* Serialize db expand. */
514 int tdb_lock_expand(struct tdb_context *tdb, int ltype);
515 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
516 bool tdb_has_expansion_lock(struct tdb_context *tdb);
517
518 /* If it needs recovery, grab all the locks and do it. */
519 int tdb_lock_and_recover(struct tdb_context *tdb);
520
521 /* traverse.c: */
522 int first_in_hash(struct tdb_context *tdb, int ltype,
523                   struct traverse_info *tinfo,
524                   TDB_DATA *kbuf, size_t *dlen);
525 int next_in_hash(struct tdb_context *tdb, int ltype,
526                  struct traverse_info *tinfo,
527                  TDB_DATA *kbuf, size_t *dlen);
528
529 /* transaction.c: */
530 int tdb_transaction_recover(struct tdb_context *tdb);
531 bool tdb_needs_recovery(struct tdb_context *tdb);
532
533 /* tdb.c: */
534 void COLD tdb_logerr(struct tdb_context *tdb,
535                      enum TDB_ERROR ecode,
536                      enum tdb_debug_level level,
537                      const char *fmt, ...);
538
539 #ifdef TDB_TRACE
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,
547                     TDB_DATA rec);
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,
554                              int ret);
555 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
556                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
557 #else
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 */
569
570 #endif