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 #include "config.h"
  22 #include <stdint.h>
  23 #include <stdbool.h>
  24 #include <stdlib.h>
  25 #include <stddef.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 <ccan/tdb2/tdb2.h>
  36 #include <ccan/likely/likely.h>
  37 #include <ccan/compiler/compiler.h>
  38 #if 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 #define TDB_MAGIC_FOOD "TDB file\n"
  64 #define TDB_VERSION ((uint64_t)(0x26011967 + 7))
  65 #define TDB_USED_MAGIC ((uint64_t)0x1999)
  66 #define TDB_HTABLE_MAGIC ((uint64_t)0x1888)
  67 #define TDB_CHAIN_MAGIC ((uint64_t)0x1777)
  68 #define TDB_FTABLE_MAGIC ((uint64_t)0x1666)
  69 #define TDB_FREE_MAGIC ((uint64_t)0xFE)
  70 #define TDB_HASH_MAGIC (0xA1ABE11A01092008ULL)
  71 #define TDB_RECOVERY_MAGIC (0xf53bc0e7ad124589ULL)
  72 #define TDB_RECOVERY_INVALID_MAGIC (0x0ULL)
  73
  74 #define TDB_OFF_IS_ERR(off) unlikely(off >= (tdb_off_t)TDB_ERR_LAST)
  75
  76 /* Packing errors into pointers and v.v. */
  77 #define TDB_PTR_IS_ERR(ptr) \
  78         unlikely((void *)(ptr) >= (void *)(long)TDB_ERR_LAST)
  79 #define TDB_PTR_ERR(p) ((enum TDB_ERROR)(long)(p))
  80 #define TDB_ERR_PTR(err) ((void *)(long)(err))
  81
  82 /* Common case of returning true, false or -ve error. */
  83 typedef int tdb_bool_err;
  84
  85 /* Prevent others from opening the file. */
  86 #define TDB_OPEN_LOCK 0
  87 /* Doing a transaction. */
  88 #define TDB_TRANSACTION_LOCK 1
  89 /* Expanding file. */
  90 #define TDB_EXPANSION_LOCK 2
  91 /* Hash chain locks. */
  92 #define TDB_HASH_LOCK_START 3
  93
  94 /* Range for hash locks. */
  95 #define TDB_HASH_LOCK_RANGE_BITS 30
  96 #define TDB_HASH_LOCK_RANGE (1 << TDB_HASH_LOCK_RANGE_BITS)
  97
  98 /* We have 1024 entries in the top level. */
  99 #define TDB_TOPLEVEL_HASH_BITS 10
 100 /* And 64 entries in each sub-level: thus 64 bits exactly after 9 levels. */
 101 #define TDB_SUBLEVEL_HASH_BITS 6
 102 /* And 8 entries in each group, ie 8 groups per sublevel. */
 103 #define TDB_HASH_GROUP_BITS 3
 104 /* This is currently 10: beyond this we chain. */
 105 #define TDB_MAX_LEVELS (1+(64-TDB_TOPLEVEL_HASH_BITS) / TDB_SUBLEVEL_HASH_BITS)
 106
 107 /* Extend file by least 100 times larger than needed. */
 108 #define TDB_EXTENSION_FACTOR 100
 109
 110 /* We steal bits from the offsets to store hash info. */
 111 #define TDB_OFF_HASH_GROUP_MASK ((1ULL << TDB_HASH_GROUP_BITS) - 1)
 112 /* We steal this many upper bits, giving a maximum offset of 64 exabytes. */
 113 #define TDB_OFF_UPPER_STEAL 8
 114 #define   TDB_OFF_UPPER_STEAL_EXTRA 7
 115 /* The bit number where we store extra hash bits. */
 116 #define TDB_OFF_HASH_EXTRA_BIT 57
 117 #define TDB_OFF_UPPER_STEAL_SUBHASH_BIT 56
 118
 119 /* Additional features we understand.  Currently: none. */
 120 #define TDB_FEATURE_MASK ((uint64_t)0)
 121
 122 /* The bit number where we store the extra hash bits. */
 123 /* Convenience mask to get actual offset. */
 124 #define TDB_OFF_MASK \
 125         (((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1) - TDB_OFF_HASH_GROUP_MASK)
 126
 127 /* How many buckets in a free list: see size_to_bucket(). */
 128 #define TDB_FREE_BUCKETS (64 - TDB_OFF_UPPER_STEAL)
 129
 130 /* We have to be able to fit a free record here. */
 131 #define TDB_MIN_DATA_LEN        \
 132         (sizeof(struct tdb_free_record) - sizeof(struct tdb_used_record))
 133
 134 /* Indicates this entry is not on an flist (can happen during coalescing) */
 135 #define TDB_FTABLE_NONE ((1ULL << TDB_OFF_UPPER_STEAL) - 1)
 136
 137 #if !HAVE_BSWAP_64
 138 static inline uint64_t bswap_64(uint64_t x)
 139 {
 140         return (((x&0x000000FFULL)<<56)
 141                 | ((x&0x0000FF00ULL)<<48)
 142                 | ((x&0x00FF0000ULL)<<40)
 143                 | ((x&0xFF000000ULL)<<32)
 144                 | ((x>>8)&0xFF000000ULL)
 145                 | ((x>>16)&0x00FF0000ULL)
 146                 | ((x>>24)&0x0000FF00ULL)
 147                 | ((x>>32)&0x000000FFULL));
 148 }
 149 #endif
 150
 151 struct tdb_used_record {
 152         /* For on-disk compatibility, we avoid bitfields:
 153            magic: 16,        (highest)
 154            key_len_bits: 5,
 155            extra_padding: 32
 156            hash_bits: 11
 157         */
 158         uint64_t magic_and_meta;
 159         /* The bottom key_len_bits*2 are key length, rest is data length. */
 160         uint64_t key_and_data_len;
 161 };
 162
 163 static inline unsigned rec_key_bits(const struct tdb_used_record *r)
 164 {
 165         return ((r->magic_and_meta >> 43) & ((1 << 5)-1)) * 2;
 166 }
 167
 168 static inline uint64_t rec_key_length(const struct tdb_used_record *r)
 169 {
 170         return r->key_and_data_len & ((1ULL << rec_key_bits(r)) - 1);
 171 }
 172
 173 static inline uint64_t rec_data_length(const struct tdb_used_record *r)
 174 {
 175         return r->key_and_data_len >> rec_key_bits(r);
 176 }
 177
 178 static inline uint64_t rec_extra_padding(const struct tdb_used_record *r)
 179 {
 180         return (r->magic_and_meta >> 11) & 0xFFFFFFFF;
 181 }
 182
 183 static inline uint32_t rec_hash(const struct tdb_used_record *r)
 184 {
 185         return r->magic_and_meta & ((1 << 11) - 1);
 186 }
 187
 188 static inline uint16_t rec_magic(const struct tdb_used_record *r)
 189 {
 190         return (r->magic_and_meta >> 48);
 191 }
 192
 193 struct tdb_free_record {
 194         uint64_t magic_and_prev; /* TDB_OFF_UPPER_STEAL bits magic, then prev */
 195         uint64_t ftable_and_len; /* Len not counting these two fields. */
 196         /* This is why the minimum record size is 8 bytes.  */
 197         uint64_t next;
 198 };
 199
 200 static inline uint64_t frec_prev(const struct tdb_free_record *f)
 201 {
 202         return f->magic_and_prev & ((1ULL << (64 - TDB_OFF_UPPER_STEAL)) - 1);
 203 }
 204
 205 static inline uint64_t frec_magic(const struct tdb_free_record *f)
 206 {
 207         return f->magic_and_prev >> (64 - TDB_OFF_UPPER_STEAL);
 208 }
 209
 210 static inline uint64_t frec_len(const struct tdb_free_record *f)
 211 {
 212         return f->ftable_and_len & ((1ULL << (64 - TDB_OFF_UPPER_STEAL))-1);
 213 }
 214
 215 static inline unsigned frec_ftable(const struct tdb_free_record *f)
 216 {
 217         return f->ftable_and_len >> (64 - TDB_OFF_UPPER_STEAL);
 218 }
 219
 220 struct tdb_recovery_record {
 221         uint64_t magic;
 222         /* Length of record. */
 223         uint64_t max_len;
 224         /* Length used. */
 225         uint64_t len;
 226         /* Old length of file before transaction. */
 227         uint64_t eof;
 228 };
 229
 230 /* If we bottom out of the subhashes, we chain. */
 231 struct tdb_chain {
 232         tdb_off_t rec[1 << TDB_HASH_GROUP_BITS];
 233         tdb_off_t next;
 234 };
 235
 236 /* this is stored at the front of every database */
 237 struct tdb_header {
 238         char magic_food[64]; /* for /etc/magic */
 239         /* FIXME: Make me 32 bit? */
 240         uint64_t version; /* version of the code */
 241         uint64_t hash_test; /* result of hashing HASH_MAGIC. */
 242         uint64_t hash_seed; /* "random" seed written at creation time. */
 243         tdb_off_t free_table; /* (First) free table. */
 244         tdb_off_t recovery; /* Transaction recovery area. */
 245
 246         uint64_t features_used; /* Features all writers understand */
 247         uint64_t features_offered; /* Features offered */
 248
 249         tdb_off_t reserved[24];
 250
 251         /* Top level hash table. */
 252         tdb_off_t hashtable[1ULL << TDB_TOPLEVEL_HASH_BITS];
 253 };
 254
 255 struct tdb_freetable {
 256         struct tdb_used_record hdr;
 257         tdb_off_t next;
 258         tdb_off_t buckets[TDB_FREE_BUCKETS];
 259 };
 260
 261 /* Information about a particular (locked) hash entry. */
 262 struct hash_info {
 263         /* Full hash value of entry. */
 264         uint64_t h;
 265         /* Start and length of lock acquired. */
 266         tdb_off_t hlock_start;
 267         tdb_len_t hlock_range;
 268         /* Start of hash group. */
 269         tdb_off_t group_start;
 270         /* Bucket we belong in. */
 271         unsigned int home_bucket;
 272         /* Bucket we (or an empty space) were found in. */
 273         unsigned int found_bucket;
 274         /* How many bits of the hash are already used. */
 275         unsigned int hash_used;
 276         /* Current working group. */
 277         tdb_off_t group[1 << TDB_HASH_GROUP_BITS];
 278 };
 279
 280 struct traverse_info {
 281         struct traverse_level {
 282                 tdb_off_t hashtable;
 283                 /* We ignore groups here, and treat it as a big array. */
 284                 unsigned entry;
 285                 unsigned int total_buckets;
 286         } levels[TDB_MAX_LEVELS + 1];
 287         unsigned int num_levels;
 288         unsigned int toplevel_group;
 289         /* This makes delete-everything-inside-traverse work as expected. */
 290         tdb_off_t prev;
 291 };
 292
 293 enum tdb_lock_flags {
 294         /* WAIT == F_SETLKW, NOWAIT == F_SETLK */
 295         TDB_LOCK_NOWAIT = 0,
 296         TDB_LOCK_WAIT = 1,
 297         /* If set, don't log an error on failure. */
 298         TDB_LOCK_PROBE = 2,
 299         /* If set, don't check for recovery (used by recovery code). */
 300         TDB_LOCK_NOCHECK = 4,
 301 };
 302
 303 struct tdb_lock {
 304         struct tdb_context *owner;
 305         uint32_t off;
 306         uint32_t count;
 307         uint32_t ltype;
 308 };
 309
 310 /* This is only needed for tdb_access_commit, but used everywhere to
 311  * simplify. */
 312 struct tdb_access_hdr {
 313         struct tdb_access_hdr *next;
 314         tdb_off_t off;
 315         tdb_len_t len;
 316         bool convert;
 317 };
 318
 319 struct tdb_file {
 320         /* Single list of all TDBs, to detect multiple opens. */
 321         struct tdb_file *next;
 322
 323         /* How many are sharing us? */
 324         unsigned int refcnt;
 325
 326         /* Mmap (if any), or malloc (for TDB_INTERNAL). */
 327         void *map_ptr;
 328
 329         /* How much space has been mapped (<= current file size) */
 330         tdb_len_t map_size;
 331
 332         /* The file descriptor (-1 for TDB_INTERNAL). */
 333         int fd;
 334
 335         /* Lock information */
 336         struct tdb_lock allrecord_lock;
 337         size_t num_lockrecs;
 338         struct tdb_lock *lockrecs;
 339
 340         /* Identity of this file. */
 341         dev_t device;
 342         ino_t inode;
 343 };
 344
 345 struct tdb_context {
 346         /* Filename of the database. */
 347         const char *name;
 348
 349         /* Are we accessing directly? (debugging check). */
 350         int direct_access;
 351
 352         /* Operating read-only? (Opened O_RDONLY, or in traverse_read) */
 353         bool read_only;
 354
 355         /* mmap read only? */
 356         int mmap_flags;
 357
 358         /* Error code for last tdb error. */
 359         enum TDB_ERROR ecode;
 360
 361         /* the flags passed to tdb_open, for tdb_reopen. */
 362         uint32_t flags;
 363
 364         /* Logging function */
 365         void (*logfn)(struct tdb_context *tdb,
 366                       enum tdb_log_level level,
 367                       void *log_private,
 368                       const char *message);
 369         void *log_private;
 370
 371         /* Hash function. */
 372         uint64_t (*khash)(const void *key, size_t len, uint64_t seed, void *);
 373         void *hash_priv;
 374         uint64_t hash_seed;
 375
 376         /* Set if we are in a transaction. */
 377         struct tdb_transaction *transaction;
 378
 379         /* What free table are we using? */
 380         tdb_off_t ftable_off;
 381         unsigned int ftable;
 382
 383         /* IO methods: changes for transactions. */
 384         const struct tdb_methods *methods;
 385
 386         struct tdb_attribute_stats *stats;
 387
 388         /* Direct access information */
 389         struct tdb_access_hdr *access;
 390
 391         /* The actual file information */
 392         struct tdb_file *file;
 393 };
 394
 395 struct tdb_methods {
 396         enum TDB_ERROR (*tread)(struct tdb_context *, tdb_off_t, void *,
 397                                 tdb_len_t);
 398         enum TDB_ERROR (*twrite)(struct tdb_context *, tdb_off_t, const void *,
 399                                  tdb_len_t);
 400         enum TDB_ERROR (*oob)(struct tdb_context *, tdb_off_t, bool);
 401         enum TDB_ERROR (*expand_file)(struct tdb_context *, tdb_len_t);
 402         void *(*direct)(struct tdb_context *, tdb_off_t, size_t, bool);
 403 };
 404
 405 /*
 406   internal prototypes
 407 */
 408 /* hash.c: */
 409 void tdb_hash_init(struct tdb_context *tdb);
 410
 411 tdb_bool_err first_in_hash(struct tdb_context *tdb,
 412                            struct traverse_info *tinfo,
 413                            TDB_DATA *kbuf, size_t *dlen);
 414
 415 tdb_bool_err next_in_hash(struct tdb_context *tdb,
 416                           struct traverse_info *tinfo,
 417                           TDB_DATA *kbuf, size_t *dlen);
 418
 419 /* Hash random memory. */
 420 uint64_t tdb_hash(struct tdb_context *tdb, const void *ptr, size_t len);
 421
 422 /* Hash on disk. */
 423 uint64_t hash_record(struct tdb_context *tdb, tdb_off_t off);
 424
 425 /* Find and lock a hash entry (or where it would be). */
 426 tdb_off_t find_and_lock(struct tdb_context *tdb,
 427                         struct tdb_data key,
 428                         int ltype,
 429                         struct hash_info *h,
 430                         struct tdb_used_record *rec,
 431                         struct traverse_info *tinfo);
 432
 433 enum TDB_ERROR replace_in_hash(struct tdb_context *tdb,
 434                                struct hash_info *h,
 435                                tdb_off_t new_off);
 436
 437 enum TDB_ERROR add_to_hash(struct tdb_context *tdb, struct hash_info *h,
 438                            tdb_off_t new_off);
 439
 440 enum TDB_ERROR delete_from_hash(struct tdb_context *tdb, struct hash_info *h);
 441
 442 /* For tdb_check */
 443 bool is_subhash(tdb_off_t val);
 444
 445 /* free.c: */
 446 enum TDB_ERROR tdb_ftable_init(struct tdb_context *tdb);
 447
 448 /* check.c needs these to iterate through free lists. */
 449 tdb_off_t first_ftable(struct tdb_context *tdb);
 450 tdb_off_t next_ftable(struct tdb_context *tdb, tdb_off_t ftable);
 451
 452 /* This returns space or -ve error number. */
 453 tdb_off_t alloc(struct tdb_context *tdb, size_t keylen, size_t datalen,
 454                 uint64_t hash, unsigned magic, bool growing);
 455
 456 /* Put this record in a free list. */
 457 enum TDB_ERROR add_free_record(struct tdb_context *tdb,
 458                                tdb_off_t off, tdb_len_t len_with_header);
 459
 460 /* Set up header for a used/ftable/htable/chain record. */
 461 enum TDB_ERROR set_header(struct tdb_context *tdb,
 462                           struct tdb_used_record *rec,
 463                           unsigned magic, uint64_t keylen, uint64_t datalen,
 464                           uint64_t actuallen, unsigned hashlow);
 465
 466 /* Used by tdb_check to verify. */
 467 unsigned int size_to_bucket(tdb_len_t data_len);
 468 tdb_off_t bucket_off(tdb_off_t ftable_off, unsigned bucket);
 469
 470 /* Used by tdb_summary */
 471 tdb_off_t dead_space(struct tdb_context *tdb, tdb_off_t off);
 472
 473 /* io.c: */
 474 /* Initialize tdb->methods. */
 475 void tdb_io_init(struct tdb_context *tdb);
 476
 477 /* Convert endian of the buffer if required. */
 478 void *tdb_convert(const struct tdb_context *tdb, void *buf, tdb_len_t size);
 479
 480 /* Unmap and try to map the tdb. */
 481 void tdb_munmap(struct tdb_file *file);
 482 void tdb_mmap(struct tdb_context *tdb);
 483
 484 /* Either alloc a copy, or give direct access.  Release frees or noop. */
 485 const void *tdb_access_read(struct tdb_context *tdb,
 486                             tdb_off_t off, tdb_len_t len, bool convert);
 487 void *tdb_access_write(struct tdb_context *tdb,
 488                        tdb_off_t off, tdb_len_t len, bool convert);
 489
 490 /* Release result of tdb_access_read/write. */
 491 void tdb_access_release(struct tdb_context *tdb, const void *p);
 492 /* Commit result of tdb_acces_write. */
 493 enum TDB_ERROR tdb_access_commit(struct tdb_context *tdb, void *p);
 494
 495 /* Convenience routine to get an offset. */
 496 tdb_off_t tdb_read_off(struct tdb_context *tdb, tdb_off_t off);
 497
 498 /* Write an offset at an offset. */
 499 enum TDB_ERROR tdb_write_off(struct tdb_context *tdb, tdb_off_t off,
 500                              tdb_off_t val);
 501
 502 /* Clear an ondisk area. */
 503 enum TDB_ERROR zero_out(struct tdb_context *tdb, tdb_off_t off, tdb_len_t len);
 504
 505 /* Return a non-zero offset between >= start < end in this array (or end). */
 506 tdb_off_t tdb_find_nonzero_off(struct tdb_context *tdb,
 507                                tdb_off_t base,
 508                                uint64_t start,
 509                                uint64_t end);
 510
 511 /* Return a zero offset in this array, or num. */
 512 tdb_off_t tdb_find_zero_off(struct tdb_context *tdb, tdb_off_t off,
 513                             uint64_t num);
 514
 515 /* Allocate and make a copy of some offset. */
 516 void *tdb_alloc_read(struct tdb_context *tdb, tdb_off_t offset, tdb_len_t len);
 517
 518 /* Writes a converted copy of a record. */
 519 enum TDB_ERROR tdb_write_convert(struct tdb_context *tdb, tdb_off_t off,
 520                                  const void *rec, size_t len);
 521
 522 /* Reads record and converts it */
 523 enum TDB_ERROR tdb_read_convert(struct tdb_context *tdb, tdb_off_t off,
 524                                 void *rec, size_t len);
 525
 526 /* Adds a stat, if it's in range. */
 527 void add_stat_(struct tdb_context *tdb, uint64_t *stat, size_t val);
 528 #define add_stat(tdb, statname, val)                                    \
 529         do {                                                            \
 530                 if (unlikely((tdb)->stats))                             \
 531                         add_stat_((tdb), &(tdb)->stats->statname, (val)); \
 532         } while (0)
 533
 534 /* lock.c: */
 535 /* Lock/unlock a range of hashes. */
 536 enum TDB_ERROR tdb_lock_hashes(struct tdb_context *tdb,
 537                                tdb_off_t hash_lock, tdb_len_t hash_range,
 538                                int ltype, enum tdb_lock_flags waitflag);
 539 enum TDB_ERROR tdb_unlock_hashes(struct tdb_context *tdb,
 540                                  tdb_off_t hash_lock,
 541                                  tdb_len_t hash_range, int ltype);
 542
 543 /* For closing the file. */
 544 void tdb_unlock_all(struct tdb_context *tdb);
 545
 546 /* Lock/unlock a particular free bucket. */
 547 enum TDB_ERROR tdb_lock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off,
 548                                     enum tdb_lock_flags waitflag);
 549 void tdb_unlock_free_bucket(struct tdb_context *tdb, tdb_off_t b_off);
 550
 551 /* Serialize transaction start. */
 552 enum TDB_ERROR tdb_transaction_lock(struct tdb_context *tdb, int ltype);
 553 void tdb_transaction_unlock(struct tdb_context *tdb, int ltype);
 554
 555 /* Do we have any hash locks (ie. via tdb_chainlock) ? */
 556 bool tdb_has_hash_locks(struct tdb_context *tdb);
 557
 558 /* Lock entire database. */
 559 enum TDB_ERROR tdb_allrecord_lock(struct tdb_context *tdb, int ltype,
 560                                   enum tdb_lock_flags flags, bool upgradable);
 561 void tdb_allrecord_unlock(struct tdb_context *tdb, int ltype);
 562 enum TDB_ERROR tdb_allrecord_upgrade(struct tdb_context *tdb);
 563
 564 /* Serialize db open. */
 565 enum TDB_ERROR tdb_lock_open(struct tdb_context *tdb,
 566                              enum tdb_lock_flags flags);
 567 void tdb_unlock_open(struct tdb_context *tdb);
 568 bool tdb_has_open_lock(struct tdb_context *tdb);
 569
 570 /* Serialize db expand. */
 571 enum TDB_ERROR tdb_lock_expand(struct tdb_context *tdb, int ltype);
 572 void tdb_unlock_expand(struct tdb_context *tdb, int ltype);
 573 bool tdb_has_expansion_lock(struct tdb_context *tdb);
 574
 575 /* If it needs recovery, grab all the locks and do it. */
 576 enum TDB_ERROR tdb_lock_and_recover(struct tdb_context *tdb);
 577
 578 /* transaction.c: */
 579 enum TDB_ERROR tdb_transaction_recover(struct tdb_context *tdb);
 580 tdb_bool_err tdb_needs_recovery(struct tdb_context *tdb);
 581
 582 /* tdb.c: */
 583 enum TDB_ERROR COLD tdb_logerr(struct tdb_context *tdb,
 584                                enum TDB_ERROR ecode,
 585                                enum tdb_log_level level,
 586                                const char *fmt, ...);
 587
 588 #ifdef TDB_TRACE
 589 void tdb_trace(struct tdb_context *tdb, const char *op);
 590 void tdb_trace_seqnum(struct tdb_context *tdb, uint32_t seqnum, const char *op);
 591 void tdb_trace_open(struct tdb_context *tdb, const char *op,
 592                     unsigned hash_size, unsigned tdb_flags, unsigned open_flags);
 593 void tdb_trace_ret(struct tdb_context *tdb, const char *op, int ret);
 594 void tdb_trace_retrec(struct tdb_context *tdb, const char *op, TDB_DATA ret);
 595 void tdb_trace_1rec(struct tdb_context *tdb, const char *op,
 596                     TDB_DATA rec);
 597 void tdb_trace_1rec_ret(struct tdb_context *tdb, const char *op,
 598                         TDB_DATA rec, int ret);
 599 void tdb_trace_1rec_retrec(struct tdb_context *tdb, const char *op,
 600                            TDB_DATA rec, TDB_DATA ret);
 601 void tdb_trace_2rec_flag_ret(struct tdb_context *tdb, const char *op,
 602                              TDB_DATA rec1, TDB_DATA rec2, unsigned flag,
 603                              int ret);
 604 void tdb_trace_2rec_retrec(struct tdb_context *tdb, const char *op,
 605                            TDB_DATA rec1, TDB_DATA rec2, TDB_DATA ret);
 606 #else
 607 #define tdb_trace(tdb, op)
 608 #define tdb_trace_seqnum(tdb, seqnum, op)
 609 #define tdb_trace_open(tdb, op, hash_size, tdb_flags, open_flags)
 610 #define tdb_trace_ret(tdb, op, ret)
 611 #define tdb_trace_retrec(tdb, op, ret)
 612 #define tdb_trace_1rec(tdb, op, rec)
 613 #define tdb_trace_1rec_ret(tdb, op, rec, ret)
 614 #define tdb_trace_1rec_retrec(tdb, op, rec, ret)
 615 #define tdb_trace_2rec_flag_ret(tdb, op, rec1, rec2, flag, ret)
 616 #define tdb_trace_2rec_retrec(tdb, op, rec1, rec2, ret)
 617 #endif /* !TDB_TRACE */
 618
 619 #endif