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         ssize_t written;
  60
  61         /* We make it up in memory, then write it out if not internal */
  62         size = sizeof(struct tdb_header) + (hash_size+1)*sizeof(tdb_off_t);
  63         if (!(newdb = (struct tdb_header *)calloc(size, 1)))
  64                 return TDB_ERRCODE(TDB_ERR_OOM, -1);
  65
  66         /* Fill in the header */
  67         newdb->version = TDB_VERSION;
  68         newdb->hash_size = hash_size;
  69
  70         tdb_header_hash(tdb, &newdb->magic1_hash, &newdb->magic2_hash);
  71
  72         if (tdb->flags & TDB_INTERNAL) {
  73                 tdb->map_size = size;
  74                 tdb->map_ptr = (char *)newdb;
  75                 memcpy(&tdb->header, newdb, sizeof(tdb->header));
  76                 /* Convert the `ondisk' version if asked. */
  77                 CONVERT(*newdb);
  78                 return 0;
  79         }
  80         if (lseek(tdb->fd, 0, SEEK_SET) == -1)
  81                 goto fail;
  82
  83         if (ftruncate(tdb->fd, 0) == -1)
  84                 goto fail;
  85
  86         /* This creates an endian-converted header, as if read from disk */
  87         CONVERT(*newdb);
  88         memcpy(&tdb->header, newdb, sizeof(tdb->header));
  89         /* Don't endian-convert the magic food! */
  90         memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
  91         /* we still have "ret == -1" here */
  92         written = write(tdb->fd, newdb, size);
  93         if (written == size) {
  94                 ret = 0;
  95         } else if (written != -1) {
  96                 /* call write once again, this usually should return -1 and
  97                  * set errno appropriately */
  98                 size -= written;
  99                 written = write(tdb->fd, newdb+written, size);
 100                 if (written == size) {
 101                 ret = 0;
 102                 } else if (written >= 0) {
 103                         /* a second incomplete write - we give up.
 104                          * guessing the errno... */
 105                         errno = ENOSPC;
 106                 }
 107         }
 108
 109   fail:
 110         SAFE_FREE(newdb);
 111         return ret;
 112 }
 113
 114
 115
 116 static int tdb_already_open(dev_t device,
 117                             ino_t ino)
 118 {
 119         struct tdb_context *i;
 120
 121         for (i = tdbs; i; i = i->next) {
 122                 if (i->device == device && i->inode == ino) {
 123                         return 1;
 124                 }
 125         }
 126
 127         return 0;
 128 }
 129
 130 /* open the database, creating it if necessary
 131
 132    The open_flags and mode are passed straight to the open call on the
 133    database file. A flags value of O_WRONLY is invalid. The hash size
 134    is advisory, use zero for a default value.
 135
 136    Return is NULL on error, in which case errno is also set.  Don't
 137    try to call tdb_error or tdb_errname, just do strerror(errno).
 138
 139    @param name may be NULL for internal databases. */
 140 struct tdb_context *tdb_open(const char *name, int hash_size, int tdb_flags,
 141                       int open_flags, mode_t mode)
 142 {
 143         return tdb_open_ex(name, hash_size, tdb_flags, open_flags, mode, NULL, NULL);
 144 }
 145
 146 /* a default logging function */
 147 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...) PRINTF_ATTRIBUTE(3, 4);
 148 static void null_log_fn(struct tdb_context *tdb, enum tdb_debug_level level, const char *fmt, ...)
 149 {
 150 }
 151
 152
 153 struct tdb_context *tdb_open_ex(const char *name, int hash_size, int tdb_flags,
 154                                 int open_flags, mode_t mode,
 155                                 const struct tdb_logging_context *log_ctx,
 156                                 tdb_hash_func hash_fn)
 157 {
 158         struct tdb_context *tdb;
 159         struct stat st;
 160         int rev = 0, locked = 0;
 161         unsigned char *vp;
 162         uint32_t vertest;
 163         unsigned v;
 164         uint32_t magic1_hash;
 165         uint32_t magic2_hash;
 166         const char *hash_alg;
 167
 168         if (!(tdb = (struct tdb_context *)calloc(1, sizeof *tdb))) {
 169                 /* Can't log this */
 170                 errno = ENOMEM;
 171                 goto fail;
 172         }
 173         tdb_io_init(tdb);
 174         tdb->fd = -1;
 175         tdb->name = NULL;
 176         tdb->map_ptr = NULL;
 177         tdb->flags = tdb_flags;
 178         tdb->open_flags = open_flags;
 179         if (log_ctx) {
 180                 tdb->log = *log_ctx;
 181         } else {
 182                 tdb->log.log_fn = null_log_fn;
 183                 tdb->log.log_private = NULL;
 184         }
 185
 186         if (hash_fn) {
 187                 tdb->hash_fn = hash_fn;
 188                 hash_alg = "user defined";
 189         } else {
 190                 tdb->hash_fn = tdb_old_hash;
 191                 hash_alg = "default";
 192         }
 193
 194         /* cache the page size */
 195         tdb->page_size = getpagesize();
 196         if (tdb->page_size <= 0) {
 197                 tdb->page_size = 0x2000;
 198         }
 199
 200         tdb->max_dead_records = (tdb_flags & TDB_VOLATILE) ? 5 : 0;
 201
 202         if ((open_flags & O_ACCMODE) == O_WRONLY) {
 203                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: can't open tdb %s write-only\n",
 204                          name));
 205                 errno = EINVAL;
 206                 goto fail;
 207         }
 208
 209         if (hash_size == 0)
 210                 hash_size = DEFAULT_HASH_SIZE;
 211         if ((open_flags & O_ACCMODE) == O_RDONLY) {
 212                 tdb->read_only = 1;
 213                 /* read only databases don't do locking or clear if first */
 214                 tdb->flags |= TDB_NOLOCK;
 215                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
 216         }
 217
 218         /* internal databases don't mmap or lock, and start off cleared */
 219         if (tdb->flags & TDB_INTERNAL) {
 220                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
 221                 tdb->flags &= ~TDB_CLEAR_IF_FIRST;
 222                 if (tdb_new_database(tdb, hash_size) != 0) {
 223                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: tdb_new_database failed!"));
 224                         goto fail;
 225                 }
 226                 goto internal;
 227         }
 228
 229         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
 230                 TDB_LOG((tdb, TDB_DEBUG_WARNING, "tdb_open_ex: could not open file %s: %s\n",
 231                          name, strerror(errno)));
 232                 goto fail;      /* errno set by open(2) */
 233         }
 234
 235         /* on exec, don't inherit the fd */
 236         v = fcntl(tdb->fd, F_GETFD, 0);
 237         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 238
 239         /* ensure there is only one process initialising at once */
 240         if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_WRLCK, F_SETLKW, 0, 1) == -1) {
 241                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to get global lock on %s: %s\n",
 242                          name, strerror(errno)));
 243                 goto fail;      /* errno set by tdb_brlock */
 244         }
 245
 246         /* we need to zero database if we are the only one with it open */
 247         if ((tdb_flags & TDB_CLEAR_IF_FIRST) &&
 248             (!tdb->read_only) &&
 249             (locked = (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_WRLCK, F_SETLK, 0, 1) == 0))) {
 250                 open_flags |= O_CREAT;
 251                 if (ftruncate(tdb->fd, 0) == -1) {
 252                         TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
 253                                  "failed to truncate %s: %s\n",
 254                                  name, strerror(errno)));
 255                         goto fail; /* errno set by ftruncate */
 256                 }
 257         }
 258
 259         errno = 0;
 260         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
 261             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0
 262             || (tdb->header.version != TDB_VERSION
 263                 && !(rev = (tdb->header.version==TDB_BYTEREV(TDB_VERSION))))) {
 264                 /* its not a valid database - possibly initialise it */
 265                 if (!(open_flags & O_CREAT) || tdb_new_database(tdb, hash_size) == -1) {
 266                         if (errno == 0) {
 267                         errno = EIO; /* ie bad format or something */
 268                         }
 269                         goto fail;
 270                 }
 271                 rev = (tdb->flags & TDB_CONVERT);
 272         }
 273         vp = (unsigned char *)&tdb->header.version;
 274         vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
 275                   (((uint32_t)vp[2]) << 8) | (uint32_t)vp[3];
 276         tdb->flags |= (vertest==TDB_VERSION) ? TDB_BIGENDIAN : 0;
 277         if (!rev)
 278                 tdb->flags &= ~TDB_CONVERT;
 279         else {
 280                 tdb->flags |= TDB_CONVERT;
 281                 tdb_convert(&tdb->header, sizeof(tdb->header));
 282         }
 283         if (fstat(tdb->fd, &st) == -1)
 284                 goto fail;
 285
 286         if (tdb->header.rwlocks != 0) {
 287                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: spinlocks no longer supported\n"));
 288                 goto fail;
 289         }
 290
 291         tdb_header_hash(tdb, &magic1_hash, &magic2_hash);
 292
 293         if ((tdb->header.magic1_hash == 0) && (tdb->header.magic2_hash == 0)) {
 294                 /* older TDB without magic hash references */
 295         } else if ((tdb->header.magic1_hash != magic1_hash) ||
 296                    (tdb->header.magic2_hash != magic2_hash)) {
 297                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_open_ex: "
 298                          "%s was not created with the %s hash function we are using\n"
 299                          "magic1_hash[0x%08X %s 0x%08X] "
 300                          "magic2_hash[0x%08X %s 0x%08X]\n",
 301                          name, hash_alg,
 302                          tdb->header.magic1_hash,
 303                          (tdb->header.magic1_hash == magic1_hash) ? "==" : "!=",
 304                          magic1_hash,
 305                          tdb->header.magic2_hash,
 306                          (tdb->header.magic2_hash == magic2_hash) ? "==" : "!=",
 307                          magic2_hash));
 308                 errno = EINVAL;
 309                 goto fail;
 310         }
 311
 312         /* Is it already in the open list?  If so, fail. */
 313         if (tdb_already_open(st.st_dev, st.st_ino)) {
 314                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
 315                          "%s (%d,%d) is already open in this process\n",
 316                          name, (int)st.st_dev, (int)st.st_ino));
 317                 errno = EBUSY;
 318                 goto fail;
 319         }
 320
 321         if (!(tdb->name = (char *)strdup(name))) {
 322                 errno = ENOMEM;
 323                 goto fail;
 324         }
 325
 326         tdb->map_size = st.st_size;
 327         tdb->device = st.st_dev;
 328         tdb->inode = st.st_ino;
 329         tdb_mmap(tdb);
 330         if (locked) {
 331                 if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_UNLCK, F_SETLK, 0, 1) == -1) {
 332                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: "
 333                                  "failed to take ACTIVE_LOCK on %s: %s\n",
 334                                  name, strerror(errno)));
 335                         goto fail;
 336                 }
 337
 338         }
 339
 340         /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
 341            we didn't get the initial exclusive lock as we need to let all other
 342            users know we're using it. */
 343
 344         if (tdb_flags & TDB_CLEAR_IF_FIRST) {
 345                 /* leave this lock in place to indicate it's in use */
 346                 if (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0, 1) == -1)
 347                         goto fail;
 348         }
 349
 350         /* if needed, run recovery */
 351         if (tdb_transaction_recover(tdb) == -1) {
 352                 goto fail;
 353         }
 354
 355  internal:
 356         /* Internal (memory-only) databases skip all the code above to
 357          * do with disk files, and resume here by releasing their
 358          * global lock and hooking into the active list. */
 359         if (tdb->methods->tdb_brlock(tdb, GLOBAL_LOCK, F_UNLCK, F_SETLKW, 0, 1) == -1)
 360                 goto fail;
 361         tdb->next = tdbs;
 362         tdbs = tdb;
 363         return tdb;
 364
 365  fail:
 366         { int save_errno = errno;
 367
 368         if (!tdb)
 369                 return NULL;
 370
 371         if (tdb->map_ptr) {
 372                 if (tdb->flags & TDB_INTERNAL)
 373                         SAFE_FREE(tdb->map_ptr);
 374                 else
 375                         tdb_munmap(tdb);
 376         }
 377         SAFE_FREE(tdb->name);
 378         if (tdb->fd != -1)
 379                 if (close(tdb->fd) != 0)
 380                         TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_open_ex: failed to close tdb->fd on error!\n"));
 381         SAFE_FREE(tdb);
 382         errno = save_errno;
 383         return NULL;
 384         }
 385 }
 386
 387 /*
 388  * Set the maximum number of dead records per hash chain
 389  */
 390
 391 void tdb_set_max_dead(struct tdb_context *tdb, int max_dead)
 392 {
 393         tdb->max_dead_records = max_dead;
 394 }
 395
 396 /**
 397  * Close a database.
 398  *
 399  * @returns -1 for error; 0 for success.
 400  **/
 401 int tdb_close(struct tdb_context *tdb)
 402 {
 403         struct tdb_context **i;
 404         int ret = 0;
 405
 406         if (tdb->transaction) {
 407                 tdb_transaction_cancel(tdb);
 408         }
 409
 410         if (tdb->map_ptr) {
 411                 if (tdb->flags & TDB_INTERNAL)
 412                         SAFE_FREE(tdb->map_ptr);
 413                 else
 414                         tdb_munmap(tdb);
 415         }
 416         SAFE_FREE(tdb->name);
 417         if (tdb->fd != -1)
 418                 ret = close(tdb->fd);
 419         SAFE_FREE(tdb->lockrecs);
 420
 421         /* Remove from contexts list */
 422         for (i = &tdbs; *i; i = &(*i)->next) {
 423                 if (*i == tdb) {
 424                         *i = tdb->next;
 425                         break;
 426                 }
 427         }
 428
 429         memset(tdb, 0, sizeof(*tdb));
 430         SAFE_FREE(tdb);
 431
 432         return ret;
 433 }
 434
 435 /* register a loging function */
 436 void tdb_set_logging_function(struct tdb_context *tdb,
 437                               const struct tdb_logging_context *log_ctx)
 438 {
 439         tdb->log = *log_ctx;
 440 }
 441
 442 void *tdb_get_logging_private(struct tdb_context *tdb)
 443 {
 444         return tdb->log.log_private;
 445 }
 446
 447 /* reopen a tdb - this can be used after a fork to ensure that we have an independent
 448    seek pointer from our parent and to re-establish locks */
 449 int tdb_reopen(struct tdb_context *tdb)
 450 {
 451         struct stat st;
 452
 453         if (tdb->flags & TDB_INTERNAL) {
 454                 return 0; /* Nothing to do. */
 455         }
 456
 457         if (tdb->num_locks != 0 || tdb->global_lock.count) {
 458                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed with locks held\n"));
 459                 goto fail;
 460         }
 461
 462         if (tdb->transaction != 0) {
 463                 TDB_LOG((tdb, TDB_DEBUG_ERROR, "tdb_reopen: reopen not allowed inside a transaction\n"));
 464                 goto fail;
 465         }
 466
 467 /* If we have real pread & pwrite, we can skip reopen. */
 468 #if !defined(LIBREPLACE_PREAD_NOT_REPLACED) || \
 469         !defined(LIBREPLACE_PWRITE_NOT_REPLACED)
 470         if (tdb_munmap(tdb) != 0) {
 471                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: munmap failed (%s)\n", strerror(errno)));
 472                 goto fail;
 473         }
 474         if (close(tdb->fd) != 0)
 475                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: WARNING closing tdb->fd failed!\n"));
 476         tdb->fd = open(tdb->name, tdb->open_flags & ~(O_CREAT|O_TRUNC), 0);
 477         if (tdb->fd == -1) {
 478                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: open failed (%s)\n", strerror(errno)));
 479                 goto fail;
 480         }
 481         if (fstat(tdb->fd, &st) != 0) {
 482                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: fstat failed (%s)\n", strerror(errno)));
 483                 goto fail;
 484         }
 485         if (st.st_ino != tdb->inode || st.st_dev != tdb->device) {
 486                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: file dev/inode has changed!\n"));
 487                 goto fail;
 488         }
 489         tdb_mmap(tdb);
 490 #endif /* fake pread or pwrite */
 491
 492         if ((tdb->flags & TDB_CLEAR_IF_FIRST) &&
 493             (tdb->methods->tdb_brlock(tdb, ACTIVE_LOCK, F_RDLCK, F_SETLKW, 0, 1) == -1)) {
 494                 TDB_LOG((tdb, TDB_DEBUG_FATAL, "tdb_reopen: failed to obtain active lock\n"));
 495                 goto fail;
 496         }
 497
 498         return 0;
 499
 500 fail:
 501         tdb_close(tdb);
 502         return -1;
 503 }
 504
 505 /* reopen all tdb's */
 506 int tdb_reopen_all(int parent_longlived)
 507 {
 508         struct tdb_context *tdb;
 509
 510         for (tdb=tdbs; tdb; tdb = tdb->next) {
 511                 /*
 512                  * If the parent is longlived (ie. a
 513                  * parent daemon architecture), we know
 514                  * it will keep it's active lock on a
 515                  * tdb opened with CLEAR_IF_FIRST. Thus
 516                  * for child processes we don't have to
 517                  * add an active lock. This is essential
 518                  * to improve performance on systems that
 519                  * keep POSIX locks as a non-scalable data
 520                  * structure in the kernel.
 521                  */
 522                 if (parent_longlived) {
 523                         /* Ensure no clear-if-first. */
 524                         tdb->flags &= ~TDB_CLEAR_IF_FIRST;
 525                 }
 526
 527                 if (tdb_reopen(tdb) != 0)
 528                         return -1;
 529         }
 530
 531         return 0;
 532 }