lib/tdb/common/open.c

   1  /*
   2    Unix SMB/CIFS implementation.
   3
   4    trivial database library
   5
   6    Copyright (C) Andrew Tridgell              1999-2005
   7    Copyright (C) Paul `Rusty' Russell              2000
   8    Copyright (C) Jeremy Allison                    2000-2003
   9
  10      ** NOTE! The following LGPL license applies to the tdb
  11      ** library. This does NOT imply that all of Samba is released
  12      ** under the LGPL
  13
  14    This library is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU Lesser General Public
  16    License as published by the Free Software Foundation; either
  17    version 3 of the License, or (at your option) any later version.
  18
  19    This library is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  22    Lesser General Public License for more details.
  23
  24    You should have received a copy of the GNU Lesser General Public
  25    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  26 */
  27
  28 #include "tdb_private.h"
  29
  30 /* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
  31 static struct tdb_context *tdbs = NULL;
  32
  33 /* We use two hashes to double-check they're using the right hash function. */
  34 void tdb_header_hash(struct tdb_context *tdb,
  35                      uint32_t *magic1_hash, uint32_t *magic2_hash)
  36 {
  37         TDB_DATA hash_key;
  38         uint32_t tdb_magic = TDB_MAGIC;
  39
  40         hash_key.dptr = (unsigned char *)TDB_MAGIC_FOOD;
  41         hash_key.dsize = sizeof(TDB_MAGIC_FOOD);
  42         *magic1_hash = tdb->hash_fn(&hash_key);
  43
  44         hash_key.dptr = (unsigned char *)CONVERT(tdb_magic);
  45         hash_key.dsize = sizeof(tdb_magic);
  46         *magic2_hash = tdb->hash_fn(&hash_key);
  47
  48         /* Make sure at least one hash is non-zero! */
  49         if (*magic1_hash == 0 && *magic2_hash == 0)
  50                 *magic1_hash = 1;
  51 }
  52
  53 /* initialise a new database with a specified hash size */
  54 static int tdb_new_database(struct tdb_context *tdb, int hash_size)
  55 {
  56         struct tdb_header *newdb;
  57         size_t size;
  58         int ret = -1;
  59
  60         /* We make it up in memory, then write it out if not internal */
  61         size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
  62         if (!(newdb = (struct tdb_header *)calloc(size, 1))) {
  63                 tdb->ecode = TDB_ERR_OOM;
  64                 return -1;
  65         }
  66
  67         /* Fill in the header */
  68         newdb->version = TDB_VERSION;
  69         newdb->hash_size = hash_size;
  70
  71         tdb_header_hash(tdb, &newdb->magic1_hash, &newdb->magic2_hash);
  72
  73         if (tdb->flags & TDB_INTERNAL) {
  74                 tdb->map_size = size;
  75                 tdb->map_ptr = (char *)newdb;
  76                 memcpy(&tdb->header, newdb, sizeof(tdb->header));
  77                 /* Convert the `ondisk' version if asked. */
  78                 CONVERT(*newdb);
  79                 return 0;
  80         }
  81         if (lseek(tdb->fd, 0, SEEK_SET) == -1)
  82                 goto fail;
  83
  84         if (ftruncate(tdb->fd, 0) == -1)
  85                 goto fail;
  86
  87         /* This creates an endian-converted header, as if read from disk */
  88         CONVERT(*newdb);
  89         memcpy(&tdb->header, newdb, sizeof(tdb->header));
  90         /* Don't endian-convert the magic food! */
  91         memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
  92         /* we still have "ret == -1" here */
  93         if (tdb_write_all(tdb->fd, newdb, size))
  94                 ret = 0;
  95
  96   fail:
  97         SAFE_FREE(newdb);
  98         return ret;
  99 }
 100
 101
 102
 103 static int tdb_already_open(dev_t device,
 104                             ino_t ino)
 105 {
 106         struct tdb_context *i;
 107
 108         for (i = tdbs; i; i = i->next) {
 109                 if (i->device == device && i->inode == ino) {
 110                         return 1;
 111                 }
 112         }
 113
 114         return 0;
 115 }
 116
 117 /* open the database, creating it if necessary
 118
 119    The open_flags and mode are passed straight to the open call on the
 120    database file. A flags value of O_WRONLY is invalid. The hash size
 121    is advisory, use zero for a default value.
 122
 123    Return is NULL on error, in which case errno is also set.  Don't
 124    try to call tdb_error or tdb_errname, just do strerror(errno).
 125
 126    @param name may be NULL for internal databases. */
 127 struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags,
 128                       int open_flags, mode_t mode)
 129 {
 130         return tdb_open_ex(name, hash_size, tdb_flags, open_flags, mode, NULL, NULL);
 131 }
 132
 133 /* a default logging function */
 134 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
 135 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...)
 136 {
 137 }
 138
 139
 140 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
 141                                 int open_flags, mode_t mode,
 142                                 const struct tdb_logging_context *log_ctx,
 143                                 tdb_hash_func hash_fn)
 144 {
 145         struct tdb_context *tdb;
 146         struct stat st;
 147         int rev = 0, locked = 0;
 148         unsigned char *vp;
 149         uint32_t vertest;
 150         unsigned v;
 151         uint32_t magic1_hash;
 152         uint32_t magic2_hash;
 153         const char *hash_alg;
 154
 155         if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
 156                 /* Can't log this */
 157                 errno = ENOMEM;
 158                 goto fail;
 159         }
 160         tdb_io_init(tdb);
 161         tdb->fd = -1;
 162 #ifdef TDB_TRACE
 163         tdb->tracefd = -1;
 164 #endif
 165         tdb->name = NULL;
 166         tdb->map_ptr = NULL;
 167         tdb->flags = tdb_flags;
 168         tdb->open_flags = open_flags;
 169         if (log_ctx) {
 170                 tdb->log = *log_ctx;
 171         } else {
 172                 tdb->log.log_fn = null_log_fn;
 173                 tdb->log.log_private = NULL;
 174         }
 175
 176         if (hash_fn) {
 177                 tdb->hash_fn = hash_fn;
 178                 hash_alg = "user defined";
 179         } else {
 180                 tdb->hash_fn = tdb_old_hash;
 181                 hash_alg = "default";
 182         }
 183
 184         /* cache the page size */
 185         tdb->page_size = getpagesize();
 186         if (tdb->page_size <= 0) {
 187                 tdb->page_size = 0x2000;
 188         }
 189
 190         tdb->max_dead_records = (tdb_flags & TDB_VOLATILE) ? 5 : 0;
 191
 192         if ((open_flags & O_ACCMODE) == O_WRONLY) {
 193                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: can't open tdb %s write-only\n",
 194                          name));
 195                 errno = EINVAL;
 196                 goto fail;
 197         }
 198
 199         if (hash_size == 0)
 200                 hash_size = DEFAULT_HASH_SIZE;
 201         if ((open_flags & O_ACCMODE) == O_RDONLY) {
 202                 tdb->read_only = 1;
 203                 /* read only databases don't do locking or clear if first */
 204                 tdb->flags |= TDB_NOLOCK;
 205                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
 206         }
 207
 208         if ((tdb->flags & TDB_ALLOW_NESTING) &&
 209             (tdb->flags & TDB_DISALLOW_NESTING)) {
 210                 tdb->ecode = TDB_ERR_NESTING;
 211                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
 212                         "allow_nesting and disallow_nesting are not allowed together!"));
 213                 errno = EINVAL;
 214                 goto fail;
 215         }
 216
 217         if (getenv("TDB_NO_FSYNC")) {
 218                 tdb->flags |= TDB_NOSYNC;
 219         }
 220
 221         /*
 222          * TDB_ALLOW_NESTING is the default behavior.
 223          * Note: this may change in future versions!
 224          */
 225         if (!(tdb->flags & TDB_DISALLOW_NESTING)) {
 226                 tdb->flags |= TDB_ALLOW_NESTING;
 227         }
 228
 229         /* internal databases don't mmap or lock, and start off cleared */
 230         if (tdb->flags & TDB_INTERNAL) {
 231                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
 232                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
 233                 if (tdb_new_database(tdb, hash_size) != 0) {
 234                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
 235                         goto fail;
 236                 }
 237                 goto internal;
 238         }
 239
 240         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
 241                 TDB_LOG((tdb, TDB_DEBUG_WARNING, "tdb_open_ex: could not open file %s: %s\n",
 242                          name, strerror(errno)));
 243                 goto fail;      /* errno set by open(2) */
 244         }
 245
 246         /* on exec, don't inherit the fd */
 247         v = fcntl(tdb->fd, F_GETFD, 0);
 248         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 249
 250         /* ensure there is only one process initialising at once */
 251         if (tdb_nest_lock(tdb, OPEN_LOCK, F_WRLCK, TDB_LOCK_WAIT) == -1) {
 252                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get open lock on %s: %s\n",
 253                          name, strerror(errno)));
 254                 goto fail;      /* errno set by tdb_brlock */
 255         }
 256
 257         /* we need to zero database if we are the only one with it open */
 258         if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
 259             (!tdb->read_only) &&
 260             (locked = (tdb_nest_lock(tdb, ACTIVE_LOCK, F_WRLCK, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE) == 0))) {
 261                 open_flags |= O_CREAT;
 262                 if (ftruncate(tdb->fd, 0) == -1) {
 263                         TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
 264                                  "failed to truncate %s: %s\n",
 265                                  name, strerror(errno)));
 266                         goto fail; /* errno set by ftruncate */
 267                 }
 268         }
 269
 270         errno = 0;
 271         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
 272             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0) {
 273                 if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
 274                         if (errno == 0) {
 275                                 errno = EIO; /* ie bad format or something */
 276                         }
 277                         goto fail;
 278                 }
 279                 rev = (tdb->flags & TDB_CONVERT);
 280         } else if (tdb->header.version != TDB_VERSION
 281                    && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION)))) {
 282                 /* wrong version */
 283                 errno = EIO;
 284                 goto fail;
 285         }
 286         vp = (unsigned char *)&tdb->header.version;
 287         vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
 288                   (((uint32_t)vp[2]) << 8) | (uint32_t)vp[3];
 289         tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
 290         if (!rev)
 291                 tdb->flags &= ~TDB_CONVERT;
 292         else {
 293                 tdb->flags |= TDB_CONVERT;
 294                 tdb_convert(&tdb->header, sizeof(tdb->header));
 295         }
 296         if (fstat(tdb->fd, &st) == -1)
 297                 goto fail;
 298
 299         if (tdb->header.rwlocks != 0) {
 300                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: spinlocks no longer supported\n"));
 301                 goto fail;
 302         }
 303
 304         tdb_header_hash(tdb, &magic1_hash, &magic2_hash);
 305
 306         if ((tdb->header.magic1_hash == 0) && (tdb->header.magic2_hash == 0)) {
 307                 /* older TDB without magic hash references */
 308         } else if ((tdb->header.magic1_hash != magic1_hash) ||
 309                    (tdb->header.magic2_hash != magic2_hash)) {
 310                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
 311                          "%s was not created with the %s hash function we are using\n"
 312                          "magic1_hash[0x%08X %s 0x%08X] "
 313                          "magic2_hash[0x%08X %s 0x%08X]\n",
 314                          name, hash_alg,
 315                          tdb->header.magic1_hash,
 316                          (tdb->header.magic1_hash == magic1_hash) ? "==" : "!=",
 317                          magic1_hash,
 318                          tdb->header.magic2_hash,
 319                          (tdb->header.magic2_hash == magic2_hash) ? "==" : "!=",
 320                          magic2_hash));
 321                 errno = EINVAL;
 322                 goto fail;
 323         }
 324
 325         /* Is it already in the open list?  If so, fail. */
 326         if (tdb_already_open(st.st_dev, st.st_ino)) {
 327                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
 328                          "%s (%d,%d) is already open in this process\n",
 329                          name, (int)st.st_dev, (int)st.st_ino));
 330                 errno = EBUSY;
 331                 goto fail;
 332         }
 333
 334         if (!(tdb->name = (char *)strdup(name))) {
 335                 errno = ENOMEM;
 336                 goto fail;
 337         }
 338
 339         tdb->map_size = st.st_size;
 340         tdb->device = st.st_dev;
 341         tdb->inode = st.st_ino;
 342         tdb_mmap(tdb);
 343         if (locked) {
 344                 if (tdb_nest_unlock(tdb, ACTIVE_LOCK, F_WRLCK, false) == -1) {
 345                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
 346                                  "failed to release ACTIVE_LOCK on %s: %s\n",
 347                                  name, strerror(errno)));
 348                         goto fail;
 349                 }
 350
 351         }
 352
 353         /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
 354            we didn't get the initial exclusive lock as we need to let all other
 355            users know we're using it. */
 356
 357         if (tdb_flags & TDB_CLEAR_IF_FIRST) {
 358                 /* leave this lock in place to indicate it's in use */
 359                 if (tdb_nest_lock(tdb, ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {
 360                         goto fail;
 361                 }
 362         }
 363
 364         /* if needed, run recovery */
 365         if (tdb_transaction_recover(tdb) == -1) {
 366                 goto fail;
 367         }
 368
 369 #ifdef TDB_TRACE
 370         {
 371                 char tracefile[strlen(name) + 32];
 372
 373                 snprintf(tracefile, sizeof(tracefile),
 374                          "%s.trace.%li", name, (long)getpid());
 375                 tdb->tracefd = open(tracefile, O_WRONLY|O_CREAT|O_EXCL, 0600);
 376                 if (tdb->tracefd >= 0) {
 377                         tdb_enable_seqnum(tdb);
 378                         tdb_trace_open(tdb, "tdb_open", hash_size, tdb_flags,
 379                                        open_flags);
 380                 } else
 381                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to open trace file %s!\n", tracefile));
 382         }
 383 #endif
 384
 385  internal:
 386         /* Internal (memory-only) databases skip all the code above to
 387          * do with disk files, and resume here by releasing their
 388          * open lock and hooking into the active list. */
 389         if (tdb_nest_unlock(tdb, OPEN_LOCK, F_WRLCK, false) == -1) {
 390                 goto fail;
 391         }
 392         tdb->next = tdbs;
 393         tdbs = tdb;
 394         return tdb;
 395
 396  fail:
 397         { int save_errno = errno;
 398
 399         if (!tdb)
 400                 return NULL;
 401
 402 #ifdef TDB_TRACE
 403         close(tdb->tracefd);
 404 #endif
 405         if (tdb->map_ptr) {
 406                 if (tdb->flags & TDB_INTERNAL)
 407                         SAFE_FREE(tdb->map_ptr);
 408                 else
 409                         tdb_munmap(tdb);
 410         }
 411         SAFE_FREE(tdb->name);
 412         if (tdb->fd != -1)
 413                 if (close(tdb->fd) != 0)
 414                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));
 415         SAFE_FREE(tdb->lockrecs);
 416         SAFE_FREE(tdb);
 417         errno = save_errno;
 418         return NULL;
 419         }
 420 }
 421
 422 /*
 423  * Set the maximum number of dead records per hash chain
 424  */
 425
 426 void tdb_set_max_dead(struct tdb_context *tdb, int max_dead)
 427 {
 428         tdb->max_dead_records = max_dead;
 429 }
 430
 431 /**
 432  * Close a database.
 433  *
 434  * @returns -1 for error; 0 for success.
 435  **/
 436 int tdb_close(struct tdb_context *tdb)
 437 {
 438         struct tdb_context **i;
 439         int ret = 0;
 440
 441         if (tdb->transaction) {
 442                 tdb_transaction_cancel(tdb);
 443         }
 444         tdb_trace(tdb, "tdb_close");
 445
 446         if (tdb->map_ptr) {
 447                 if (tdb->flags & TDB_INTERNAL)
 448                         SAFE_FREE(tdb->map_ptr);
 449                 else
 450                         tdb_munmap(tdb);
 451         }
 452         SAFE_FREE(tdb->name);
 453         if (tdb->fd != -1) {
 454                 ret = close(tdb->fd);
 455                 tdb->fd = -1;
 456         }
 457         SAFE_FREE(tdb->lockrecs);
 458
 459         /* Remove from contexts list */
 460         for (i = &tdbs; *i; i = &(*i)->next) {
 461                 if (*i == tdb) {
 462                         *i = tdb->next;
 463                         break;
 464                 }
 465         }
 466
 467 #ifdef TDB_TRACE
 468         close(tdb->tracefd);
 469 #endif
 470         memset(tdb, 0, sizeof(*tdb));
 471         SAFE_FREE(tdb);
 472
 473         return ret;
 474 }
 475
 476 /* register a loging function */
 477 void tdb_set_logging_function(struct tdb_context *tdb,
 478                               const struct tdb_logging_context *log_ctx)
 479 {
 480         tdb->log = *log_ctx;
 481 }
 482
 483 void *tdb_get_logging_private(struct tdb_context *tdb)
 484 {
 485         return tdb->log.log_private;
 486 }
 487
 488 static int tdb_reopen_internal(struct tdb_context *tdb, bool active_lock)
 489 {
 490 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
 491         !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
 492         struct stat st;
 493 #endif
 494
 495         if (tdb->flags & TDB_INTERNAL) {
 496                 return 0; /* Nothing to do. */
 497         }
 498
 499         if (tdb_have_extra_locks(tdb)) {
 500                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
 501                 goto fail;
 502         }
 503
 504         if (tdb->transaction != 0) {
 505                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed inside a transaction\n"));
 506                 goto fail;
 507         }
 508
 509 /* If we have real pread & pwrite, we can skip reopen. */
 510 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
 511         !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
 512         if (tdb_munmap(tdb) != 0) {
 513                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
 514                 goto fail;
 515         }
 516         if (close(tdb->fd) != 0)
 517                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
 518         tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
 519         if (tdb->fd == -1) {
 520                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
 521                 goto fail;
 522         }
 523         if (fstat(tdb->fd, &st) != 0) {
 524                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
 525                 goto fail;
 526         }
 527         if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
 528                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: file dev/inode has changed!\n"));
 529                 goto fail;
 530         }
 531         tdb_mmap(tdb);
 532 #endif /* fake pread or pwrite */
 533
 534         /* We may still think we hold the active lock. */
 535         tdb->num_lockrecs = 0;
 536         SAFE_FREE(tdb->lockrecs);
 537
 538         if (active_lock && tdb_nest_lock(tdb, ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {
 539                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
 540                 goto fail;
 541         }
 542
 543         return 0;
 544
 545 fail:
 546         tdb_close(tdb);
 547         return -1;
 548 }
 549
 550 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
 551    seek pointer from our parent and to re-establish locks */
 552 int tdb_reopen(struct tdb_context *tdb)
 553 {
 554         return tdb_reopen_internal(tdb, tdb->flags & TDB_CLEAR_IF_FIRST);
 555 }
 556
 557 /* reopen all tdb's */
 558 int tdb_reopen_all(int parent_longlived)
 559 {
 560         struct tdb_context *tdb;
 561
 562         for (tdb=tdbs; tdb; tdb = tdb->next) {
 563                 bool active_lock = (tdb->flags & TDB_CLEAR_IF_FIRST);
 564
 565                 /*
 566                  * If the parent is longlived (ie. a
 567                  * parent daemon architecture), we know
 568                  * it will keep it's active lock on a
 569                  * tdb opened with CLEAR_IF_FIRST. Thus
 570                  * for child processes we don't have to
 571                  * add an active lock. This is essential
 572                  * to improve performance on systems that
 573                  * keep POSIX locks as a non-scalable data
 574                  * structure in the kernel.
 575                  */
 576                 if (parent_longlived) {
 577                         /* Ensure no clear-if-first. */
 578                         active_lock = false;
 579                 }
 580
 581                 if (tdb_reopen_internal(tdb, active_lock) != 0)
 582                         return -1;
 583         }
 584
 585         return 0;
 586 }