git.ozlabs.org Git - ccan/blob - 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 100 times larger than needed. */
  96 #define TDB_EXTENSION_FACTOR 100
  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_prev; /* TDB_OFF_UPPER_STEAL bits magic, then prev */
 177         uint64_t flist_and_len; /* Len not counting these two fields. */
 178         /* This is why the minimum record size is 8 bytes.  */
 179         uint64_t next;
 180 };
 181
 182 static inline uint64_t frec_prev(const struct tdb_free_record *f)
 183 {
 184         return f->magic_and_prev & ((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1);
 185 }
 186
 187 static inline uint64_t frec_magic(const struct tdb_free_record *f)
 188 {
 189         return f->magic_and_prev >> (64 - TDB_OFF_UPPER_STEAL);
 190 }
 191
 192 static inline uint64_t frec_len(const struct tdb_free_record *f)
 193 {
 194         return f->flist_and_len & ((1ULL << (64 - TDB_OFF_UPPER_STEAL))-1);
 195 }
 196
 197 static inline unsigned frec_flist(const struct tdb_free_record *f)
 198 {
 199         return f->flist_and_len >> (64 - TDB_OFF_UPPER_STEAL);
 200 }
 201
 202 struct tdb_recovery_record {
 203         uint64_t magic;
 204         /* Length of record. */
 205         uint64_t max_len;
 206         /* Length used. */
 207         uint64_t len;
 208         /* Old length of file before transaction. */
 209         uint64_t eof;
 210 };
 211
 212 /* this is stored at the front of every database */
 213 struct tdb_header {
 214         char magic_food[64]; /* for /etc/magic */
 215         /* FIXME: Make me 32 bit? */
 216         uint64_t version; /* version of the code */
 217         uint64_t hash_test; /* result of hashing HASH_MAGIC. */
 218         uint64_t hash_seed; /* "random" seed written at creation time. */
 219         tdb_off_t free_list; /* (First) free list. */
 220         tdb_off_t recovery; /* Transaction recovery area. */
 221
 222         tdb_off_t reserved[26];
 223
 224         /* Top level hash table. */
 225         tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
 226 };
 227
 228 struct tdb_freelist {
 229         struct tdb_used_record hdr;
 230         tdb_off_t next;
 231         tdb_off_t buckets[TDB_FREE_BUCKETS];
 232 };
 233
 234 /* Information about a particular (locked) hash entry. */
 235 struct hash_info {
 236         /* Full hash value of entry. */
 237         uint64_t h;
 238         /* Start and length of lock acquired. */
 239         tdb_off_t hlock_start;
 240         tdb_len_t hlock_range;
 241         /* Start of hash group. */
 242         tdb_off_t group_start;
 243         /* Bucket we belong in. */
 244         unsigned int home_bucket;
 245         /* Bucket we (or an empty space) were found in. */
 246         unsigned int found_bucket;
 247         /* How many bits of the hash are already used. */
 248         unsigned int hash_used;
 249         /* Current working group. */
 250         tdb_off_t group[1 << TDB_HASH_GROUP_BITS];
 251 };
 252
 253 struct traverse_info {
 254         struct traverse_level {
 255                 tdb_off_t hashtable;
 256                 /* We ignore groups here, and treat it as a big array. */
 257                 unsigned entry;
 258                 unsigned int total_buckets;
 259         } levels[64 / TDB_SUBLEVEL_HASH_BITS];
 260         unsigned int num_levels;
 261         unsigned int toplevel_group;
 262         /* This makes delete-everything-inside-traverse work as expected. */
 263         tdb_off_t prev;
 264 };
 265
 266 enum tdb_lock_flags {
 267         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
 268         TDB_LOCK_NOWAIT = 0,
 269         TDB_LOCK_WAIT = 1,
 270         /* If set, don't log an error on failure. */
 271         TDB_LOCK_PROBE = 2,
 272         /* If set, don't check for recovery (used by recovery code). */
 273         TDB_LOCK_NOCHECK = 4,
 274 };
 275
 276 struct tdb_lock_type {
 277         uint32_t off;
 278         uint32_t count;
 279         uint32_t ltype;
 280 };
 281
 282 struct tdb_context {
 283         /* Filename of the database. */
 284         const char *name;
 285
 286         /* Mmap (if any), or malloc (for TDB_INTERNAL). */
 287         void *map_ptr;
 288
 289         /* Are we accessing directly? (debugging check). */
 290         int direct_access;
 291
 292          /* Open file descriptor (undefined for TDB_INTERNAL). */
 293         int fd;
 294
 295         /* How much space has been mapped (<= current file size) */
 296         tdb_len_t map_size;
 297
 298         /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
 299         bool read_only;
 300
 301         /* mmap read only? */
 302         int mmap_flags;
 303
 304         /* Error code for last tdb error. */
 305         enum TDB_ERROR ecode;
 306
 307         /* the flags passed to tdb_open, for tdb_reopen. */
 308         uint32_t flags;
 309
 310         /* Logging function */
 311         tdb_logfn_t log;
 312         void *log_priv;
 313
 314         /* Hash function. */
 315         tdb_hashfn_t khash;
 316         void *hash_priv;
 317         uint64_t hash_seed;
 318
 319         /* Set if we are in a transaction. */
 320         struct tdb_transaction *transaction;
 321
 322         /* What freelist are we using? */
 323         uint64_t flist_off;
 324         unsigned int flist;
 325
 326         /* IO methods: changes for transactions. */
 327         const struct tdb_methods *methods;
 328
 329         /* Lock information */
 330         struct tdb_lock_type allrecord_lock;
 331         uint64_t num_lockrecs;
 332         struct tdb_lock_type *lockrecs;
 333
 334         /* Single list of all TDBs, to avoid multiple opens. */
 335         struct tdb_context *next;
 336         dev_t device;
 337         ino_t inode;
 338 };
 339
 340 struct tdb_methods {
 341         int (*read)(struct tdb_context *, tdb_off_t, void *, tdb_len_t);
 342         int (*write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
 343         int (*oob)(struct tdb_context *, tdb_off_t, bool);
 344         int (*expand_file)(struct tdb_context *, tdb_len_t);
 345         void *(*direct)(struct tdb_context *, tdb_off_t, size_t);
 346 };
 347
 348 /*
 349   internal prototypes
 350 */
 351 /* hash.c: */
 352 void tdb_hash_init(struct tdb_context *tdb);
 353
 354 /* Hash random memory. */
 355 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
 356
 357 /* Hash on disk. */
 358 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
 359
 360 /* Find and lock a hash entry (or where it would be). */
 361 tdb_off_t find_and_lock(struct tdb_context *tdb,
 362                         struct tdb_data key,
 363                         int ltype,
 364                         struct hash_info *h,
 365                         struct tdb_used_record *rec,
 366                         struct traverse_info *tinfo);
 367
 368 int replace_in_hash(struct tdb_context *tdb,
 369                     struct hash_info *h,
 370                     tdb_off_t new_off);
 371
 372 int add_to_hash(struct tdb_context *tdb, struct hash_info *h,
 373                 tdb_off_t new_off);
 374
 375 int delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
 376
 377 /* For tdb_check */
 378 bool is_subhash(tdb_off_t val);
 379
 380 /* free.c: */
 381 int tdb_flist_init(struct tdb_context *tdb);
 382
 383 /* check.c needs these to iterate through free lists. */
 384 tdb_off_t first_flist(struct tdb_context *tdb);
 385 tdb_off_t next_flist(struct tdb_context *tdb, tdb_off_t flist);
 386
 387 /* If this fails, try tdb_expand. */
 388 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
 389                 uint64_t hash, bool growing);
 390
 391 /* Put this record in a free list. */
 392 int add_free_record(struct tdb_context *tdb,
 393                     tdb_off_t off, tdb_len_t len_with_header);
 394
 395 /* Set up header for a used record. */
 396 int set_used_header(struct tdb_context *tdb,
 397                     struct tdb_used_record *rec,
 398                     uint64_t keylen, uint64_t datalen,
 399                     uint64_t actuallen, unsigned hashlow);
 400
 401 /* Used by tdb_check to verify. */
 402 unsigned int size_to_bucket(tdb_len_t data_len);
 403 tdb_off_t bucket_off(tdb_off_t flist_off, unsigned bucket);
 404
 405 /* Used by tdb_summary */
 406 size_t dead_space(struct tdb_context *tdb, tdb_off_t off);
 407
 408 /* io.c: */
 409 /* Initialize tdb->methods. */
 410 void tdb_io_init(struct tdb_context *tdb);
 411
 412 /* Convert endian of the buffer if required. */
 413 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
 414
 415 /* Unmap and try to map the tdb. */
 416 void tdb_munmap(struct tdb_context *tdb);
 417 void tdb_mmap(struct tdb_context *tdb);
 418
 419 /* Either make a copy into pad and return that, or return ptr into mmap.
 420  * Converts endian (ie. will use pad in that case). */
 421 void *tdb_get(struct tdb_context *tdb, tdb_off_t off, void *pad, size_t len);
 422
 423 /* Either alloc a copy, or give direct access.  Release frees or noop. */
 424 const void *tdb_access_read(struct tdb_context *tdb,
 425                             tdb_off_t off, tdb_len_t len, bool convert);
 426 void *tdb_access_write(struct tdb_context *tdb,
 427                        tdb_off_t off, tdb_len_t len, bool convert);
 428
 429 /* Release result of tdb_access_read/write. */
 430 void tdb_access_release(struct tdb_context *tdb, const void *p);
 431 /* Commit result of tdb_acces_write. */
 432 int tdb_access_commit(struct tdb_context *tdb, void *p);
 433
 434 /* Convenience routine to get an offset. */
 435 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
 436
 437 /* Write an offset at an offset. */
 438 int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
 439
 440 /* Clear an ondisk area. */
 441 int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
 442
 443 /* Return a non-zero offset between >= start < end in this array (or end). */
 444 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
 445                                tdb_off_t base,
 446                                uint64_t start,
 447                                uint64_t end);
 448
 449 /* Return a zero offset in this array, or num. */
 450 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
 451                             uint64_t num);
 452
 453 /* Even on files, we can get partial writes due to signals. */
 454 bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off);
 455 bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off);
 456 bool tdb_read_all(int fd, void *buf, size_t len);
 457
 458 /* Allocate and make a copy of some offset. */
 459 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
 460
 461 /* Writes a converted copy of a record. */
 462 int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
 463                       const void *rec, size_t len);
 464
 465 /* Reads record and converts it */
 466 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
 467                      void *rec, size_t len);
 468
 469
 470 /* lock.c: */
 471 void tdb_lock_init(struct tdb_context *tdb);
 472
 473 /* Lock/unlock a range of hashes. */
 474 int tdb_lock_hashes(struct tdb_context *tdb,
 475                     tdb_off_t hash_lock, tdb_len_t hash_range,
 476                     int ltype, enum tdb_lock_flags waitflag);
 477 int tdb_unlock_hashes(struct tdb_context *tdb,
 478                       tdb_off_t hash_lock,
 479                       tdb_len_t hash_range, int ltype);
 480
 481 /* Lock/unlock a particular free bucket. */
 482 int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
 483                          enum tdb_lock_flags waitflag);
 484 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
 485
 486 /* Serialize transaction start. */
 487 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
 488 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
 489
 490 /* Do we have any hash locks (ie. via tdb_chainlock) ? */
 491 bool tdb_has_hash_locks(struct tdb_context *tdb);
 492
 493 /* Lock entire database. */
 494 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
 495                        enum tdb_lock_flags flags, bool upgradable);
 496 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
 497 int tdb_allrecord_upgrade(struct tdb_context *tdb);
 498
 499 /* Serialize db open. */
 500 int tdb_lock_open(struct tdb_context *tdb, enum tdb_lock_flags flags);
 501 void tdb_unlock_open(struct tdb_context *tdb);
 502 bool tdb_has_open_lock(struct tdb_context *tdb);
 503
 504 /* Serialize db expand. */
 505 int tdb_lock_expand(struct tdb_context *tdb, int ltype);
 506 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
 507 bool tdb_has_expansion_lock(struct tdb_context *tdb);
 508
 509 /* If it needs recovery, grab all the locks and do it. */
 510 int tdb_lock_and_recover(struct tdb_context *tdb);
 511
 512 /* traverse.c: */
 513 int first_in_hash(struct tdb_context *tdb, int ltype,
 514                   struct traverse_info *tinfo,
 515                   TDB_DATA *kbuf, size_t *dlen);
 516 int next_in_hash(struct tdb_context *tdb, int ltype,
 517                  struct traverse_info *tinfo,
 518                  TDB_DATA *kbuf, size_t *dlen);
 519
 520 /* transaction.c: */
 521 int tdb_transaction_recover(struct tdb_context *tdb);
 522 bool tdb_needs_recovery(struct tdb_context *tdb);
 523
 524 #ifdef TDB_TRACE
 525 void tdb_trace(struct tdb_context *tdb, const char *op);
 526 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
 527 void tdb_trace_open(struct tdb_context *tdb, const char *op,
 528                     unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
 529 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
 530 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
 531 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
 532                     TDB_DATA rec);
 533 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
 534                         TDB_DATA rec, int ret);
 535 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
 536                            TDB_DATA rec, TDB_DATA ret);
 537 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
 538                              TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
 539                              int ret);
 540 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
 541                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
 542 #else
 543 #define tdb_trace(tdb, op)
 544 #define tdb_trace_seqnum(tdb, seqnum, op)
 545 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
 546 #define tdb_trace_ret(tdb, op, ret)
 547 #define tdb_trace_retrec(tdb, op, ret)
 548 #define tdb_trace_1rec(tdb, op, rec)
 549 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
 550 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
 551 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
 552 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
 553 #endif /* !TDB_TRACE */
 554
 555 #endif