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 <sys/time.h>
  27 #include <sys/mman.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30 #include <string.h>
  31 #include <errno.h>
  32 #include <stdio.h>
  33 #include <utime.h>
  34 #include <unistd.h>
  35 #include "config.h"
  36 #include <ccan/tdb2/tdb2.h>
  37 #include <ccan/likely/likely.h>
  38 #ifdef HAVE_BYTESWAP_H
  39 #include <byteswap.h>
  40 #endif
  41
  42 #ifndef TEST_IT
  43 #define TEST_IT(cond)
  44 #endif
  45
  46 /* #define TDB_TRACE 1 */
  47
  48 #ifndef __STRING
  49 #define __STRING(x)    #x
  50 #endif
  51
  52 #ifndef __STRINGSTRING
  53 #define __STRINGSTRING(x) __STRING(x)
  54 #endif
  55
  56 #ifndef __location__
  57 #define __location__ __FILE__ ":" __STRINGSTRING(__LINE__)
  58 #endif
  59
  60 typedef uint64_t tdb_len_t;
  61 typedef uint64_t tdb_off_t;
  62
  63 #ifndef offsetof
  64 #define offsetof(t,f) ((unsigned int)&((t *)0)->f)
  65 #endif
  66
  67 #define TDB_MAGIC_FOOD "TDB file\n"
  68 #define TDB_VERSION ((uint64_t)(0x26011967 + 7))
  69 #define TDB_MAGIC ((uint64_t)0x1999)
  70 #define TDB_FREE_MAGIC ((~(uint64_t)TDB_MAGIC) << 6)
  71 #define TDB_HASH_MAGIC (0xA1ABE11A01092008ULL)
  72 #define TDB_RECOVERY_MAGIC (0xf53bc0e7U)
  73 #define TDB_RECOVERY_INVALID_MAGIC (0x0)
  74
  75 #define TDB_OFF_ERR ((tdb_off_t)-1)
  76
  77 /* Prevent others from opening the file. */
  78 #define TDB_OPEN_LOCK 0
  79 /* Doing a transaction. */
  80 #define TDB_TRANSACTION_LOCK 1
  81 /* Expanding file. */
  82 #define TDB_EXPANSION_LOCK 2
  83 /* Hash chain locks. */
  84 #define TDB_HASH_LOCK_START 3
  85
  86 /* We start wih 256 hash buckets, and a 64k-sized zone. */
  87 #define INITIAL_HASH_BITS 8
  88 #define INITIAL_ZONE_BITS 16
  89
  90 /* Try to create zones at least 32 times larger than allocations. */
  91 #define TDB_COMFORT_FACTOR_BITS 5
  92
  93 /* We ensure buckets up to size 1 << (zone_bits - TDB_COMFORT_FACTOR_BITS). */
  94 /* FIXME: test this matches size_to_bucket! */
  95 #define BUCKETS_FOR_ZONE(zone_bits) ((zone_bits) + 2 - TDB_COMFORT_FACTOR_BITS)
  96
  97 #if !HAVE_BSWAP_64
  98 static inline uint64_t bswap_64(uint64_t x)
  99 {
 100         return (((x&0x000000FFULL)<<56)
 101                 | ((x&0x0000FF00ULL)<<48)
 102                 | ((x&0x00FF0000ULL)<<40)
 103                 | ((x&0xFF000000ULL)<<32)
 104                 | ((x>>8)&0xFF000000ULL)
 105                 | ((x>>16)&0x00FF0000ULL)
 106                 | ((x>>24)&0x0000FF00ULL)
 107                 | ((x>>32)&0x000000FFULL));
 108 }
 109 #endif
 110
 111 struct tdb_used_record {
 112         /* For on-disk compatibility, we avoid bitfields:
 113            magic: 16,        (highest)
 114            key_len_bits: 5,
 115            extra_padding: 32
 116            hash_bits: 5,
 117            zone_bits: 6 (lowest)
 118         */
 119         uint64_t magic_and_meta;
 120         /* The bottom key_len_bits*2 are key length, rest is data length. */
 121         uint64_t key_and_data_len;
 122 };
 123
 124 static inline unsigned rec_key_bits(const struct tdb_used_record *r)
 125 {
 126         return ((r->magic_and_meta >> 43) & ((1 << 5)-1)) * 2;
 127 }
 128
 129 static inline uint64_t rec_key_length(const struct tdb_used_record *r)
 130 {
 131         return r->key_and_data_len & ((1ULL << rec_key_bits(r)) - 1);
 132 }
 133
 134 static inline uint64_t rec_data_length(const struct tdb_used_record *r)
 135 {
 136         return r->key_and_data_len >> rec_key_bits(r);
 137 }
 138
 139 static inline uint64_t rec_extra_padding(const struct tdb_used_record *r)
 140 {
 141         return (r->magic_and_meta >> 11) & 0xFFFFFFFF;
 142 }
 143
 144 static inline unsigned int rec_zone_bits(const struct tdb_used_record *r)
 145 {
 146         return r->magic_and_meta & ((1 << 6) - 1);
 147 }
 148
 149 static inline uint32_t rec_hash(const struct tdb_used_record *r)
 150 {
 151         return (r->magic_and_meta >> 6) & ((1 << 5) - 1);
 152 }
 153
 154 static inline uint16_t rec_magic(const struct tdb_used_record *r)
 155 {
 156         return (r->magic_and_meta >> 48);
 157 }
 158
 159 struct tdb_free_record {
 160         uint64_t magic_and_meta; /* Bottom 6 bits are zone bits. */
 161         uint64_t data_len; /* Not counting these two fields. */
 162         /* This is why the minimum record size is 16 bytes.  */
 163         uint64_t next, prev;
 164 };
 165
 166 static inline unsigned int frec_zone_bits(const struct tdb_free_record *f)
 167 {
 168         return f->magic_and_meta & ((1 << 6) - 1);
 169 }
 170
 171 static inline uint64_t frec_magic(const struct tdb_free_record *f)
 172 {
 173         return f->magic_and_meta & ~((1ULL << 6) - 1);
 174 }
 175
 176 /* These parts can change while we have db open. */
 177 struct tdb_header_volatile {
 178         uint64_t generation; /* Makes sure it changes on every update. */
 179         uint64_t hash_bits; /* Entries in hash table. */
 180         uint64_t hash_off; /* Offset of hash table. */
 181 };
 182
 183 /* this is stored at the front of every database */
 184 struct tdb_header {
 185         char magic_food[32]; /* for /etc/magic */
 186         /* FIXME: Make me 32 bit? */
 187         uint64_t version; /* version of the code */
 188         uint64_t hash_test; /* result of hashing HASH_MAGIC. */
 189         uint64_t hash_seed; /* "random" seed written at creation time. */
 190
 191         struct tdb_header_volatile v;
 192
 193         tdb_off_t reserved[19];
 194 };
 195
 196 /* Each zone has its set of free lists at the head.
 197  *
 198  * For each zone we have a series of per-size buckets, and a final bucket for
 199  * "too big". */
 200 struct free_zone_header {
 201         /* How much does this zone cover? */
 202         uint64_t zone_bits;
 203         /* tdb_off_t buckets[free_buckets + 1] */
 204 };
 205
 206 enum tdb_lock_flags {
 207         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
 208         TDB_LOCK_NOWAIT = 0,
 209         TDB_LOCK_WAIT = 1,
 210         /* If set, don't log an error on failure. */
 211         TDB_LOCK_PROBE = 2,
 212 };
 213
 214 struct tdb_lock_type {
 215         uint32_t off;
 216         uint32_t count;
 217         uint32_t ltype;
 218 };
 219
 220 struct tdb_context {
 221         /* Filename of the database. */
 222         const char *name;
 223
 224         /* Mmap (if any), or malloc (for TDB_INTERNAL). */
 225         void *map_ptr;
 226
 227          /* Open file descriptor (undefined for TDB_INTERNAL). */
 228         int fd;
 229
 230         /* How much space has been mapped (<= current file size) */
 231         tdb_len_t map_size;
 232
 233         /* Opened read-only? */
 234         bool read_only;
 235
 236         /* Error code for last tdb error. */
 237         enum TDB_ERROR ecode;
 238
 239         /* A cached copy of the header */
 240         struct tdb_header header;
 241         /* (for debugging). */
 242         bool header_uptodate;
 243
 244         /* the flags passed to tdb_open, for tdb_reopen. */
 245         uint32_t flags;
 246
 247         /* Logging function */
 248         tdb_logfn_t log;
 249         void *log_priv;
 250
 251         /* Hash function. */
 252         tdb_hashfn_t khash;
 253         void *hash_priv;
 254
 255         /* Set if we are in a transaction. */
 256         struct tdb_transaction *transaction;
 257
 258         /* What zone of the tdb to use, for spreading load. */
 259         uint64_t zone_off;
 260         /* Cached copy of zone header. */
 261         struct free_zone_header zhdr;
 262
 263         /* IO methods: changes for transactions. */
 264         const struct tdb_methods *methods;
 265
 266         /* Lock information */
 267         struct tdb_lock_type allrecord_lock;
 268         uint64_t num_lockrecs;
 269         struct tdb_lock_type *lockrecs;
 270
 271         /* Single list of all TDBs, to avoid multiple opens. */
 272         struct tdb_context *next;
 273         dev_t device;
 274         ino_t inode;
 275 };
 276
 277 struct tdb_methods {
 278         int (*read)(struct tdb_context *, tdb_off_t, void *, tdb_len_t);
 279         int (*write)(struct tdb_context *, tdb_off_t, const void *, tdb_len_t);
 280         int (*oob)(struct tdb_context *, tdb_off_t, bool);
 281         int (*expand_file)(struct tdb_context *, tdb_len_t);
 282 };
 283
 284 /*
 285   internal prototypes
 286 */
 287 /* tdb.c: */
 288 /* Returns true if header changed (and updates it). */
 289 bool header_changed(struct tdb_context *tdb);
 290
 291 /* Commit header to disk. */
 292 int write_header(struct tdb_context *tdb);
 293
 294 /* Hash random memory. */
 295 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
 296
 297 /* offset of hash table entry for this list/hash value */
 298 tdb_off_t hash_off(struct tdb_context *tdb, uint64_t list);
 299
 300
 301 /* free.c: */
 302 int tdb_zone_init(struct tdb_context *tdb);
 303
 304 /* If this fails, try tdb_expand. */
 305 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
 306                 uint64_t hash, bool growing);
 307
 308 /* Put this record in a free list. */
 309 int add_free_record(struct tdb_context *tdb, unsigned int zone_bits,
 310                     tdb_off_t off, tdb_len_t len_with_header);
 311
 312 /* Set up header for a used record. */
 313 int set_header(struct tdb_context *tdb,
 314                struct tdb_used_record *rec,
 315                uint64_t keylen, uint64_t datalen,
 316                uint64_t actuallen, uint64_t hash,
 317                unsigned int zone_bits);
 318
 319 /* Used by tdb_check to verify. */
 320 unsigned int size_to_bucket(unsigned int free_buckets, tdb_len_t data_len);
 321 tdb_off_t bucket_off(tdb_off_t zone_off, tdb_off_t bucket);
 322
 323 /* io.c: */
 324 /* Initialize tdb->methods. */
 325 void tdb_io_init(struct tdb_context *tdb);
 326
 327 /* Convert endian of the buffer if required. */
 328 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
 329
 330 /* Unmap and try to map the tdb. */
 331 void tdb_munmap(struct tdb_context *tdb);
 332 void tdb_mmap(struct tdb_context *tdb);
 333
 334 /* Either make a copy into pad and return that, or return ptr into mmap.
 335  * Converts endian (ie. will use pad in that case). */
 336 void *tdb_get(struct tdb_context *tdb, tdb_off_t off, void *pad, size_t len);
 337
 338 /* Either alloc a copy, or give direct access.  Release frees or noop. */
 339 const void *tdb_access_read(struct tdb_context *tdb,
 340                             tdb_off_t off, tdb_len_t len, bool convert);
 341 void tdb_access_release(struct tdb_context *tdb, const void *p);
 342
 343 /* Convenience routine to get an offset. */
 344 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
 345
 346 /* Write an offset at an offset. */
 347 int tdb_write_off(struct tdb_context *tdb, tdb_off_t off, tdb_off_t val);
 348
 349 /* Clear an ondisk area. */
 350 int zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
 351
 352 /* Return a non-zero offset in this array, or num. */
 353 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb, tdb_off_t off,
 354                                uint64_t num);
 355
 356 /* Return a zero offset in this array, or num. */
 357 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
 358                             uint64_t num);
 359
 360 /* Even on files, we can get partial writes due to signals. */
 361 bool tdb_pwrite_all(int fd, const void *buf, size_t len, tdb_off_t off);
 362 bool tdb_pread_all(int fd, void *buf, size_t len, tdb_off_t off);
 363 bool tdb_read_all(int fd, void *buf, size_t len);
 364
 365 /* Allocate and make a copy of some offset. */
 366 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
 367
 368 /* Writes a converted copy of a record. */
 369 int tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
 370                       const void *rec, size_t len);
 371
 372 /* Reads record and converts it */
 373 int tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
 374                      void *rec, size_t len);
 375
 376 /* Hash on disk. */
 377 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
 378
 379 /* lock.c: */
 380 void tdb_lock_init(struct tdb_context *tdb);
 381
 382 /* Lock/unlock a particular hash list. */
 383 tdb_off_t tdb_lock_list(struct tdb_context *tdb, uint64_t hash,
 384                         int ltype, enum tdb_lock_flags waitflag);
 385 int tdb_unlock_list(struct tdb_context *tdb, tdb_off_t list, int ltype);
 386
 387 /* Lock/unlock a particular free bucket. */
 388 int tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
 389                          enum tdb_lock_flags waitflag);
 390 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
 391
 392 /* Do we have any locks? */
 393 bool tdb_has_locks(struct tdb_context *tdb);
 394
 395 /* Lock entire database. */
 396 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
 397                        enum tdb_lock_flags flags, bool upgradable);
 398 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
 399
 400 /* Serialize db open. */
 401 int tdb_lock_open(struct tdb_context *tdb);
 402 void tdb_unlock_open(struct tdb_context *tdb);
 403
 404 /* Serialize db expand. */
 405 int tdb_lock_expand(struct tdb_context *tdb, int ltype);
 406 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
 407
 408
 409 #if 0
 410 /* Low-level locking primitives. */
 411 int tdb_nest_lock(struct tdb_context *tdb, tdb_off_t offset, int ltype,
 412                   enum tdb_lock_flags flags);
 413 int tdb_nest_unlock(struct tdb_context *tdb, tdb_off_t offset, int ltype);
 414
 415 int tdb_munmap(struct tdb_context *tdb);
 416 void tdb_mmap(struct tdb_context *tdb);
 417 int tdb_lock(struct tdb_context *tdb, int list, int ltype);
 418 int tdb_lock_nonblock(struct tdb_context *tdb, int list, int ltype);
 419 bool tdb_have_locks(struct tdb_context *tdb);
 420 int tdb_unlock(struct tdb_context *tdb, int list, int ltype);
 421 int tdb_brlock(struct tdb_context *tdb,
 422                int rw_type, tdb_off_t offset, size_t len,
 423                enum tdb_lock_flags flags);
 424 int tdb_brunlock(struct tdb_context *tdb,
 425                  int rw_type, tdb_off_t offset, size_t len);
 426 bool tdb_have_extra_locks(struct tdb_context *tdb);
 427 void tdb_release_extra_locks(struct tdb_context *tdb);
 428 int tdb_transaction_lock(struct tdb_context *tdb, int ltype);
 429 int tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
 430 int tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
 431                        enum tdb_lock_flags flags, bool upgradable);
 432 int tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
 433 int tdb_allrecord_upgrade(struct tdb_context *tdb);
 434 int tdb_write_lock_record(struct tdb_context *tdb, tdb_off_t off);
 435 int tdb_write_unlock_record(struct tdb_context *tdb, tdb_off_t off);
 436 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 437 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 438 int tdb_free(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
 439 tdb_off_t tdb_allocate(struct tdb_context *tdb, tdb_len_t length, struct tdb_record *rec);
 440 int tdb_ofs_read(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 441 int tdb_ofs_write(struct tdb_context *tdb, tdb_off_t offset, tdb_off_t *d);
 442 int tdb_lock_record(struct tdb_context *tdb, tdb_off_t off);
 443 int tdb_unlock_record(struct tdb_context *tdb, tdb_off_t off);
 444 bool tdb_needs_recovery(struct tdb_context *tdb);
 445 int tdb_rec_read(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
 446 int tdb_rec_write(struct tdb_context *tdb, tdb_off_t offset, struct tdb_record *rec);
 447 int tdb_do_delete(struct tdb_context *tdb, tdb_off_t rec_ptr, struct tdb_record *rec);
 448 unsigned char *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
 449 int tdb_parse_data(struct tdb_context *tdb, TDB_DATA key,
 450                    tdb_off_t offset, tdb_len_t len,
 451                    int (*parser)(TDB_DATA key, TDB_DATA data,
 452                                  void *private_data),
 453                    void *private_data);
 454 tdb_off_t tdb_find_lock_hash(struct tdb_context *tdb, TDB_DATA key, uint32_t hash, int locktype,
 455                            struct tdb_record *rec);
 456 void tdb_io_init(struct tdb_context *tdb);
 457 int tdb_expand(struct tdb_context *tdb, tdb_off_t size);
 458 int tdb_rec_free_read(struct tdb_context *tdb, tdb_off_t off,
 459                       struct tdb_record *rec);
 460 #endif
 461
 462 #ifdef TDB_TRACE
 463 void tdb_trace(struct tdb_context *tdb, const char *op);
 464 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
 465 void tdb_trace_open(struct tdb_context *tdb, const char *op,
 466                     unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
 467 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
 468 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
 469 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
 470                     TDB_DATA rec);
 471 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
 472                         TDB_DATA rec, int ret);
 473 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
 474                            TDB_DATA rec, TDB_DATA ret);
 475 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
 476                              TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
 477                              int ret);
 478 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
 479                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
 480 #else
 481 #define tdb_trace(tdb, op)
 482 #define tdb_trace_seqnum(tdb, seqnum, op)
 483 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
 484 #define tdb_trace_ret(tdb, op, ret)
 485 #define tdb_trace_retrec(tdb, op, ret)
 486 #define tdb_trace_1rec(tdb, op, rec)
 487 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
 488 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
 489 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
 490 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
 491 #endif /* !TDB_TRACE */
 492
 493 #endif