git.ozlabs.org Git - ccan/blob - ccan/tdb2/open.c

   1  /*
   2    Trivial Database 2: opening and closing TDBs
   3    Copyright (C) Rusty Russell 2010
   4
   5    This library is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU Lesser General Public
   7    License as published by the Free Software Foundation; either
   8    version 3 of the License, or (at your option) any later version.
   9
  10    This library is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    Lesser General Public License for more details.
  14
  15    You should have received a copy of the GNU Lesser General Public
  16    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17 */
  18 #include "private.h"
  19 #include <ccan/hash/hash.h>
  20 #include <assert.h>
  21
  22 /* all lock info, to detect double-opens (fcntl file don't nest!) */
  23 static struct tdb_file *files = NULL;
  24
  25 static struct tdb_file *find_file(dev_t device, ino_t ino)
  26 {
  27         struct tdb_file *i;
  28
  29         for (i = files; i; i = i->next) {
  30                 if (i->device == device && i->inode == ino) {
  31                         i->refcnt++;
  32                         break;
  33                 }
  34         }
  35         return i;
  36 }
  37
  38 static bool read_all(int fd, void *buf, size_t len)
  39 {
  40         while (len) {
  41                 ssize_t ret;
  42                 ret = read(fd, buf, len);
  43                 if (ret < 0)
  44                         return false;
  45                 if (ret == 0) {
  46                         /* ETOOSHORT? */
  47                         errno = EWOULDBLOCK;
  48                         return false;
  49                 }
  50                 buf = (char *)buf + ret;
  51                 len -= ret;
  52         }
  53         return true;
  54 }
  55
  56 static uint64_t random_number(struct tdb_context *tdb)
  57 {
  58         int fd;
  59         uint64_t ret = 0;
  60         struct timeval now;
  61
  62         fd = open("/dev/urandom", O_RDONLY);
  63         if (fd >= 0) {
  64                 if (read_all(fd, &ret, sizeof(ret))) {
  65                         close(fd);
  66                         return ret;
  67                 }
  68                 close(fd);
  69         }
  70         /* FIXME: Untested!  Based on Wikipedia protocol description! */
  71         fd = open("/dev/egd-pool", O_RDWR);
  72         if (fd >= 0) {
  73                 /* Command is 1, next byte is size we want to read. */
  74                 char cmd[2] = { 1, sizeof(uint64_t) };
  75                 if (write(fd, cmd, sizeof(cmd)) == sizeof(cmd)) {
  76                         char reply[1 + sizeof(uint64_t)];
  77                         int r = read(fd, reply, sizeof(reply));
  78                         if (r > 1) {
  79                                 /* Copy at least some bytes. */
  80                                 memcpy(&ret, reply+1, r - 1);
  81                                 if (reply[0] == sizeof(uint64_t)
  82                                     && r == sizeof(reply)) {
  83                                         close(fd);
  84                                         return ret;
  85                                 }
  86                         }
  87                 }
  88                 close(fd);
  89         }
  90
  91         /* Fallback: pid and time. */
  92         gettimeofday(&now, NULL);
  93         ret = getpid() * 100132289ULL + now.tv_sec * 1000000ULL + now.tv_usec;
  94         tdb_logerr(tdb, TDB_SUCCESS, TDB_LOG_WARNING,
  95                    "tdb_open: random from getpid and time");
  96         return ret;
  97 }
  98
  99 struct new_database {
 100         struct tdb_header hdr;
 101         struct tdb_freetable ftable;
 102 };
 103
 104 /* initialise a new database */
 105 static enum TDB_ERROR tdb_new_database(struct tdb_context *tdb,
 106                                        struct tdb_attribute_seed *seed,
 107                                        struct tdb_header *hdr)
 108 {
 109         /* We make it up in memory, then write it out if not internal */
 110         struct new_database newdb;
 111         unsigned int magic_len;
 112         ssize_t rlen;
 113         enum TDB_ERROR ecode;
 114
 115         /* Fill in the header */
 116         newdb.hdr.version = TDB_VERSION;
 117         if (seed)
 118                 newdb.hdr.hash_seed = seed->seed;
 119         else
 120                 newdb.hdr.hash_seed = random_number(tdb);
 121         newdb.hdr.hash_test = TDB_HASH_MAGIC;
 122         newdb.hdr.hash_test = tdb->hash_fn(&newdb.hdr.hash_test,
 123                                            sizeof(newdb.hdr.hash_test),
 124                                            newdb.hdr.hash_seed,
 125                                            tdb->hash_data);
 126         newdb.hdr.recovery = 0;
 127         newdb.hdr.features_used = newdb.hdr.features_offered = TDB_FEATURE_MASK;
 128         newdb.hdr.seqnum = 0;
 129         memset(newdb.hdr.reserved, 0, sizeof(newdb.hdr.reserved));
 130         /* Initial hashes are empty. */
 131         memset(newdb.hdr.hashtable, 0, sizeof(newdb.hdr.hashtable));
 132
 133         /* Free is empty. */
 134         newdb.hdr.free_table = offsetof(struct new_database, ftable);
 135         memset(&newdb.ftable, 0, sizeof(newdb.ftable));
 136         ecode = set_header(NULL, &newdb.ftable.hdr, TDB_FTABLE_MAGIC, 0,
 137                            sizeof(newdb.ftable) - sizeof(newdb.ftable.hdr),
 138                            sizeof(newdb.ftable) - sizeof(newdb.ftable.hdr),
 139                            0);
 140         if (ecode != TDB_SUCCESS) {
 141                 return ecode;
 142         }
 143
 144         /* Magic food */
 145         memset(newdb.hdr.magic_food, 0, sizeof(newdb.hdr.magic_food));
 146         strcpy(newdb.hdr.magic_food, TDB_MAGIC_FOOD);
 147
 148         /* This creates an endian-converted database, as if read from disk */
 149         magic_len = sizeof(newdb.hdr.magic_food);
 150         tdb_convert(tdb,
 151                     (char *)&newdb.hdr + magic_len, sizeof(newdb) - magic_len);
 152
 153         *hdr = newdb.hdr;
 154
 155         if (tdb->flags & TDB_INTERNAL) {
 156                 tdb->file->map_size = sizeof(newdb);
 157                 tdb->file->map_ptr = malloc(tdb->file->map_size);
 158                 if (!tdb->file->map_ptr) {
 159                         return tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
 160                                           "tdb_new_database:"
 161                                           " failed to allocate");
 162                 }
 163                 memcpy(tdb->file->map_ptr, &newdb, tdb->file->map_size);
 164                 return TDB_SUCCESS;
 165         }
 166         if (lseek(tdb->file->fd, 0, SEEK_SET) == -1) {
 167                 return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 168                                   "tdb_new_database:"
 169                                   " failed to seek: %s", strerror(errno));
 170         }
 171
 172         if (ftruncate(tdb->file->fd, 0) == -1) {
 173                 return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 174                                   "tdb_new_database:"
 175                                   " failed to truncate: %s", strerror(errno));
 176         }
 177
 178         rlen = write(tdb->file->fd, &newdb, sizeof(newdb));
 179         if (rlen != sizeof(newdb)) {
 180                 if (rlen >= 0)
 181                         errno = ENOSPC;
 182                 return tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 183                                   "tdb_new_database: %zi writing header: %s",
 184                                   rlen, strerror(errno));
 185         }
 186         return TDB_SUCCESS;
 187 }
 188
 189 static enum TDB_ERROR tdb_new_file(struct tdb_context *tdb)
 190 {
 191         tdb->file = malloc(sizeof(*tdb->file));
 192         if (!tdb->file)
 193                 return tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
 194                                   "tdb_open: cannot alloc tdb_file structure");
 195         tdb->file->num_lockrecs = 0;
 196         tdb->file->lockrecs = NULL;
 197         tdb->file->allrecord_lock.count = 0;
 198         tdb->file->refcnt = 1;
 199         return TDB_SUCCESS;
 200 }
 201
 202 enum TDB_ERROR tdb_set_attribute(struct tdb_context *tdb,
 203                                  const union tdb_attribute *attr)
 204 {
 205         switch (attr->base.attr) {
 206         case TDB_ATTRIBUTE_LOG:
 207                 tdb->log_fn = attr->log.fn;
 208                 tdb->log_data = attr->log.data;
 209                 break;
 210         case TDB_ATTRIBUTE_HASH:
 211         case TDB_ATTRIBUTE_SEED:
 212         case TDB_ATTRIBUTE_OPENHOOK:
 213                 return tdb->last_error
 214                         = tdb_logerr(tdb, TDB_ERR_EINVAL,
 215                                      TDB_LOG_USE_ERROR,
 216                                      "tdb_set_attribute:"
 217                                      " cannot set %s after opening",
 218                                      attr->base.attr == TDB_ATTRIBUTE_HASH
 219                                      ? "TDB_ATTRIBUTE_HASH"
 220                                      : attr->base.attr == TDB_ATTRIBUTE_SEED
 221                                      ? "TDB_ATTRIBUTE_SEED"
 222                                      : "TDB_ATTRIBUTE_OPENHOOK");
 223         case TDB_ATTRIBUTE_STATS:
 224                 return tdb->last_error
 225                         = tdb_logerr(tdb, TDB_ERR_EINVAL,
 226                                      TDB_LOG_USE_ERROR,
 227                                      "tdb_set_attribute:"
 228                                      " cannot set TDB_ATTRIBUTE_STATS");
 229         case TDB_ATTRIBUTE_FLOCK:
 230                 tdb->lock_fn = attr->flock.lock;
 231                 tdb->unlock_fn = attr->flock.unlock;
 232                 tdb->lock_data = attr->flock.data;
 233                 break;
 234         default:
 235                 return tdb->last_error
 236                         = tdb_logerr(tdb, TDB_ERR_EINVAL,
 237                                      TDB_LOG_USE_ERROR,
 238                                      "tdb_set_attribute:"
 239                                      " unknown attribute type %u",
 240                                      attr->base.attr);
 241         }
 242         return TDB_SUCCESS;
 243 }
 244
 245 static uint64_t jenkins_hash(const void *key, size_t length, uint64_t seed,
 246                              void *unused)
 247 {
 248         uint64_t ret;
 249         /* hash64_stable assumes lower bits are more important; they are a
 250          * slightly better hash.  We use the upper bits first, so swap them. */
 251         ret = hash64_stable((const unsigned char *)key, length, seed);
 252         return (ret >> 32) | (ret << 32);
 253 }
 254
 255 enum TDB_ERROR tdb_get_attribute(struct tdb_context *tdb,
 256                                  union tdb_attribute *attr)
 257 {
 258         switch (attr->base.attr) {
 259         case TDB_ATTRIBUTE_LOG:
 260                 if (!tdb->log_fn)
 261                         return tdb->last_error = TDB_ERR_NOEXIST;
 262                 attr->log.fn = tdb->log_fn;
 263                 attr->log.data = tdb->log_data;
 264                 break;
 265         case TDB_ATTRIBUTE_HASH:
 266                 attr->hash.fn = tdb->hash_fn;
 267                 attr->hash.data = tdb->hash_data;
 268                 break;
 269         case TDB_ATTRIBUTE_SEED:
 270                 attr->seed.seed = tdb->hash_seed;
 271                 break;
 272         case TDB_ATTRIBUTE_OPENHOOK:
 273                 return tdb->last_error
 274                         = tdb_logerr(tdb, TDB_ERR_EINVAL,
 275                                      TDB_LOG_USE_ERROR,
 276                                      "tdb_get_attribute:"
 277                                      " cannot get TDB_ATTRIBUTE_OPENHOOK");
 278         case TDB_ATTRIBUTE_STATS: {
 279                 size_t size = attr->stats.size;
 280                 if (size > tdb->stats.size)
 281                         size = tdb->stats.size;
 282                 memcpy(&attr->stats, &tdb->stats, size);
 283                 break;
 284         }
 285         case TDB_ATTRIBUTE_FLOCK:
 286                 attr->flock.lock = tdb->lock_fn;
 287                 attr->flock.unlock = tdb->unlock_fn;
 288                 attr->flock.data = tdb->lock_data;
 289                 break;
 290         default:
 291                 return tdb->last_error
 292                         = tdb_logerr(tdb, TDB_ERR_EINVAL,
 293                                      TDB_LOG_USE_ERROR,
 294                                      "tdb_get_attribute:"
 295                                      " unknown attribute type %u",
 296                                      attr->base.attr);
 297         }
 298         attr->base.next = NULL;
 299         return TDB_SUCCESS;
 300 }
 301
 302 void tdb_unset_attribute(struct tdb_context *tdb,
 303                          enum tdb_attribute_type type)
 304 {
 305         switch (type) {
 306         case TDB_ATTRIBUTE_LOG:
 307                 tdb->log_fn = NULL;
 308                 break;
 309         case TDB_ATTRIBUTE_HASH:
 310         case TDB_ATTRIBUTE_SEED:
 311         case TDB_ATTRIBUTE_OPENHOOK:
 312                 tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 313                            "tdb_unset_attribute: cannot unset %s after opening",
 314                            type == TDB_ATTRIBUTE_HASH
 315                            ? "TDB_ATTRIBUTE_HASH"
 316                            : type == TDB_ATTRIBUTE_SEED
 317                            ? "TDB_ATTRIBUTE_SEED"
 318                            : "TDB_ATTRIBUTE_OPENHOOK");
 319                 break;
 320         case TDB_ATTRIBUTE_STATS:
 321                 tdb_logerr(tdb, TDB_ERR_EINVAL,
 322                            TDB_LOG_USE_ERROR,
 323                            "tdb_unset_attribute:"
 324                            "cannot unset TDB_ATTRIBUTE_STATS");
 325                 break;
 326         case TDB_ATTRIBUTE_FLOCK:
 327                 tdb->lock_fn = tdb_fcntl_lock;
 328                 tdb->unlock_fn = tdb_fcntl_unlock;
 329                 break;
 330         default:
 331                 tdb_logerr(tdb, TDB_ERR_EINVAL,
 332                            TDB_LOG_USE_ERROR,
 333                            "tdb_unset_attribute: unknown attribute type %u",
 334                            type);
 335         }
 336 }
 337
 338 struct tdb_context *tdb_open(const char *name, int tdb_flags,
 339                              int open_flags, mode_t mode,
 340                              union tdb_attribute *attr)
 341 {
 342         struct tdb_context *tdb;
 343         struct stat st;
 344         int saved_errno = 0;
 345         uint64_t hash_test;
 346         unsigned v;
 347         ssize_t rlen;
 348         struct tdb_header hdr;
 349         struct tdb_attribute_seed *seed = NULL;
 350         struct tdb_attribute_openhook *openhook = NULL;
 351         tdb_bool_err berr;
 352         enum TDB_ERROR ecode;
 353         int openlock;
 354
 355         tdb = malloc(sizeof(*tdb) + (name ? strlen(name) + 1 : 0));
 356         if (!tdb) {
 357                 /* Can't log this */
 358                 errno = ENOMEM;
 359                 return NULL;
 360         }
 361         /* Set name immediately for logging functions. */
 362         if (name) {
 363                 tdb->name = strcpy((char *)(tdb + 1), name);
 364         } else {
 365                 tdb->name = NULL;
 366         }
 367         tdb->direct_access = 0;
 368         tdb->flags = tdb_flags;
 369         tdb->log_fn = NULL;
 370         tdb->transaction = NULL;
 371         tdb->access = NULL;
 372         tdb->last_error = TDB_SUCCESS;
 373         tdb->file = NULL;
 374         tdb->lock_fn = tdb_fcntl_lock;
 375         tdb->unlock_fn = tdb_fcntl_unlock;
 376         tdb->hash_fn = jenkins_hash;
 377         memset(&tdb->stats, 0, sizeof(tdb->stats));
 378         tdb->stats.base.attr = TDB_ATTRIBUTE_STATS;
 379         tdb->stats.size = sizeof(tdb->stats);
 380         tdb_io_init(tdb);
 381
 382         while (attr) {
 383                 switch (attr->base.attr) {
 384                 case TDB_ATTRIBUTE_HASH:
 385                         tdb->hash_fn = attr->hash.fn;
 386                         tdb->hash_data = attr->hash.data;
 387                         break;
 388                 case TDB_ATTRIBUTE_SEED:
 389                         seed = &attr->seed;
 390                         break;
 391                 case TDB_ATTRIBUTE_OPENHOOK:
 392                         openhook = &attr->openhook;
 393                         break;
 394                 default:
 395                         /* These are set as normal. */
 396                         ecode = tdb_set_attribute(tdb, attr);
 397                         if (ecode != TDB_SUCCESS)
 398                                 goto fail;
 399                 }
 400                 attr = attr->base.next;
 401         }
 402
 403         if (tdb_flags & ~(TDB_INTERNAL | TDB_NOLOCK | TDB_NOMMAP | TDB_CONVERT
 404                           | TDB_NOSYNC | TDB_SEQNUM | TDB_ALLOW_NESTING)) {
 405                 ecode = tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 406                                    "tdb_open: unknown flags %u", tdb_flags);
 407                 goto fail;
 408         }
 409
 410         if ((open_flags & O_ACCMODE) == O_WRONLY) {
 411                 ecode = tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 412                                    "tdb_open: can't open tdb %s write-only",
 413                                    name);
 414                 goto fail;
 415         }
 416
 417         if ((open_flags & O_ACCMODE) == O_RDONLY) {
 418                 tdb->read_only = true;
 419                 tdb->mmap_flags = PROT_READ;
 420                 openlock = F_RDLCK;
 421         } else {
 422                 tdb->read_only = false;
 423                 tdb->mmap_flags = PROT_READ | PROT_WRITE;
 424                 openlock = F_WRLCK;
 425         }
 426
 427         /* internal databases don't need any of the rest. */
 428         if (tdb->flags & TDB_INTERNAL) {
 429                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
 430                 ecode = tdb_new_file(tdb);
 431                 if (ecode != TDB_SUCCESS) {
 432                         goto fail;
 433                 }
 434                 tdb->file->fd = -1;
 435                 ecode = tdb_new_database(tdb, seed, &hdr);
 436                 if (ecode != TDB_SUCCESS) {
 437                         goto fail;
 438                 }
 439                 tdb_convert(tdb, &hdr.hash_seed, sizeof(hdr.hash_seed));
 440                 tdb->hash_seed = hdr.hash_seed;
 441                 tdb_ftable_init(tdb);
 442                 return tdb;
 443         }
 444
 445         if (stat(name, &st) != -1)
 446                 tdb->file = find_file(st.st_dev, st.st_ino);
 447
 448         if (!tdb->file) {
 449                 int fd;
 450
 451                 if ((fd = open(name, open_flags, mode)) == -1) {
 452                         /* errno set by open(2) */
 453                         saved_errno = errno;
 454                         tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 455                                    "tdb_open: could not open file %s: %s",
 456                                    name, strerror(errno));
 457                         goto fail_errno;
 458                 }
 459
 460                 /* on exec, don't inherit the fd */
 461                 v = fcntl(fd, F_GETFD, 0);
 462                 fcntl(fd, F_SETFD, v | FD_CLOEXEC);
 463
 464                 if (fstat(fd, &st) == -1) {
 465                         saved_errno = errno;
 466                         tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 467                                    "tdb_open: could not stat open %s: %s",
 468                                    name, strerror(errno));
 469                         close(fd);
 470                         goto fail_errno;
 471                 }
 472
 473                 ecode = tdb_new_file(tdb);
 474                 if (ecode != TDB_SUCCESS) {
 475                         close(fd);
 476                         goto fail;
 477                 }
 478
 479                 tdb->file->next = files;
 480                 tdb->file->fd = fd;
 481                 tdb->file->device = st.st_dev;
 482                 tdb->file->inode = st.st_ino;
 483                 tdb->file->map_ptr = NULL;
 484                 tdb->file->map_size = sizeof(struct tdb_header);
 485         }
 486
 487         /* ensure there is only one process initialising at once */
 488         ecode = tdb_lock_open(tdb, openlock, TDB_LOCK_WAIT|TDB_LOCK_NOCHECK);
 489         if (ecode != TDB_SUCCESS) {
 490                 saved_errno = errno;
 491                 goto fail_errno;
 492         }
 493
 494         /* call their open hook if they gave us one. */
 495         if (openhook) {
 496                 ecode = openhook->fn(tdb->file->fd, openhook->data);
 497                 if (ecode != TDB_SUCCESS) {
 498                         tdb_logerr(tdb, ecode, TDB_LOG_ERROR,
 499                                    "tdb_open: open hook failed");
 500                         goto fail;
 501                 }
 502                 open_flags |= O_CREAT;
 503         }
 504
 505         /* If they used O_TRUNC, read will return 0. */
 506         rlen = pread(tdb->file->fd, &hdr, sizeof(hdr), 0);
 507         if (rlen == 0 && (open_flags & O_CREAT)) {
 508                 ecode = tdb_new_database(tdb, seed, &hdr);
 509                 if (ecode != TDB_SUCCESS) {
 510                         goto fail;
 511                 }
 512         } else if (rlen < 0) {
 513                 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 514                                    "tdb_open: error %s reading %s",
 515                                    strerror(errno), name);
 516                 goto fail;
 517         } else if (rlen < sizeof(hdr)
 518                    || strcmp(hdr.magic_food, TDB_MAGIC_FOOD) != 0) {
 519                 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 520                                    "tdb_open: %s is not a tdb file", name);
 521                 goto fail;
 522         }
 523
 524         if (hdr.version != TDB_VERSION) {
 525                 if (hdr.version == bswap_64(TDB_VERSION))
 526                         tdb->flags |= TDB_CONVERT;
 527                 else {
 528                         /* wrong version */
 529                         ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 530                                            "tdb_open:"
 531                                            " %s is unknown version 0x%llx",
 532                                            name, (long long)hdr.version);
 533                         goto fail;
 534                 }
 535         } else if (tdb->flags & TDB_CONVERT) {
 536                 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 537                                    "tdb_open:"
 538                                    " %s does not need TDB_CONVERT",
 539                                    name);
 540                 goto fail;
 541         }
 542
 543         tdb_convert(tdb, &hdr, sizeof(hdr));
 544         tdb->hash_seed = hdr.hash_seed;
 545         hash_test = TDB_HASH_MAGIC;
 546         hash_test = tdb_hash(tdb, &hash_test, sizeof(hash_test));
 547         if (hdr.hash_test != hash_test) {
 548                 /* wrong hash variant */
 549                 ecode = tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 550                                    "tdb_open:"
 551                                    " %s uses a different hash function",
 552                                    name);
 553                 goto fail;
 554         }
 555
 556         /* Clear any features we don't understand. */
 557         if ((open_flags & O_ACCMODE) != O_RDONLY) {
 558                 hdr.features_used &= TDB_FEATURE_MASK;
 559                 ecode = tdb_write_convert(tdb, offsetof(struct tdb_header,
 560                                                         features_used),
 561                                           &hdr.features_used,
 562                                           sizeof(hdr.features_used));
 563                 if (ecode != TDB_SUCCESS)
 564                         goto fail;
 565         }
 566
 567         tdb_unlock_open(tdb, openlock);
 568
 569         /* This make sure we have current map_size and mmap. */
 570         ecode = tdb->methods->oob(tdb, tdb->file->map_size + 1, true);
 571         if (unlikely(ecode != TDB_SUCCESS))
 572                 goto fail;
 573
 574         /* Now it's fully formed, recover if necessary. */
 575         berr = tdb_needs_recovery(tdb);
 576         if (unlikely(berr != false)) {
 577                 if (berr < 0) {
 578                         ecode = berr;
 579                         goto fail;
 580                 }
 581                 ecode = tdb_lock_and_recover(tdb);
 582                 if (ecode != TDB_SUCCESS) {
 583                         goto fail;
 584                 }
 585         }
 586
 587         ecode = tdb_ftable_init(tdb);
 588         if (ecode != TDB_SUCCESS) {
 589                 goto fail;
 590         }
 591
 592         /* Add to linked list if we're new. */
 593         if (tdb->file->refcnt == 1)
 594                 files = tdb->file;
 595         return tdb;
 596
 597  fail:
 598         /* Map ecode to some logical errno. */
 599         switch (ecode) {
 600         case TDB_ERR_CORRUPT:
 601         case TDB_ERR_IO:
 602                 saved_errno = EIO;
 603                 break;
 604         case TDB_ERR_LOCK:
 605                 saved_errno = EWOULDBLOCK;
 606                 break;
 607         case TDB_ERR_OOM:
 608                 saved_errno = ENOMEM;
 609                 break;
 610         case TDB_ERR_EINVAL:
 611                 saved_errno = EINVAL;
 612                 break;
 613         default:
 614                 saved_errno = EINVAL;
 615                 break;
 616         }
 617
 618 fail_errno:
 619 #ifdef TDB_TRACE
 620         close(tdb->tracefd);
 621 #endif
 622         if (tdb->file) {
 623                 tdb_lock_cleanup(tdb);
 624                 if (--tdb->file->refcnt == 0) {
 625                         assert(tdb->file->num_lockrecs == 0);
 626                         if (tdb->file->map_ptr) {
 627                                 if (tdb->flags & TDB_INTERNAL) {
 628                                         free(tdb->file->map_ptr);
 629                                 } else
 630                                         tdb_munmap(tdb->file);
 631                         }
 632                         if (close(tdb->file->fd) != 0)
 633                                 tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 634                                            "tdb_open: failed to close tdb fd"
 635                                            " on error: %s", strerror(errno));
 636                         free(tdb->file->lockrecs);
 637                         free(tdb->file);
 638                 }
 639         }
 640
 641         free(tdb);
 642         errno = saved_errno;
 643         return NULL;
 644 }
 645
 646 int tdb_close(struct tdb_context *tdb)
 647 {
 648         int ret = 0;
 649
 650         tdb_trace(tdb, "tdb_close");
 651
 652         if (tdb->transaction) {
 653                 tdb_transaction_cancel(tdb);
 654         }
 655
 656         if (tdb->file->map_ptr) {
 657                 if (tdb->flags & TDB_INTERNAL)
 658                         free(tdb->file->map_ptr);
 659                 else
 660                         tdb_munmap(tdb->file);
 661         }
 662         if (tdb->file) {
 663                 struct tdb_file **i;
 664
 665                 tdb_lock_cleanup(tdb);
 666                 if (--tdb->file->refcnt == 0) {
 667                         ret = close(tdb->file->fd);
 668
 669                         /* Remove from files list */
 670                         for (i = &files; *i; i = &(*i)->next) {
 671                                 if (*i == tdb->file) {
 672                                         *i = tdb->file->next;
 673                                         break;
 674                                 }
 675                         }
 676                         free(tdb->file->lockrecs);
 677                         free(tdb->file);
 678                 }
 679         }
 680
 681 #ifdef TDB_TRACE
 682         close(tdb->tracefd);
 683 #endif
 684         free(tdb);
 685
 686         return ret;
 687 }