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