git.ozlabs.org Git - ccan/blob - ccan/tdb2/tdb1_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 "tdb1_private.h"
  29
  30 /* all contexts, to ensure no double-opens (fcntl locks don't nest!) */
  31 static struct tdb1_context *tdb1s = NULL;
  32
  33 /* We use two hashes to double-check they're using the right hash function. */
  34 void tdb1_header_hash(struct tdb1_context *tdb,
  35                      uint32_t *magic1_hash, uint32_t *magic2_hash)
  36 {
  37         TDB_DATA hash_key;
  38         uint32_t tdb1_magic = TDB1_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 *)TDB1_CONV(tdb1_magic);
  45         hash_key.dsize = sizeof(tdb1_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 tdb1_new_database(struct tdb1_context *tdb, int hash_size)
  55 {
  56         struct tdb1_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 tdb1_header) + (hash_size+1)*sizeof(tdb1_off_t);
  62         if (!(newdb = (struct tdb1_header *)calloc(size, 1))) {
  63                 tdb->last_error = TDB_ERR_OOM;
  64                 return -1;
  65         }
  66
  67         /* Fill in the header */
  68         newdb->version = TDB1_VERSION;
  69         newdb->hash_size = hash_size;
  70
  71         tdb1_header_hash(tdb, &newdb->magic1_hash, &newdb->magic2_hash);
  72
  73         /* Make sure older tdbs (which don't check the magic hash fields)
  74          * will refuse to open this TDB. */
  75         if (tdb->hash_fn == tdb1_incompatible_hash)
  76                 newdb->rwlocks = TDB1_HASH_RWLOCK_MAGIC;
  77
  78         if (tdb->flags & TDB1_INTERNAL) {
  79                 tdb->map_size = size;
  80                 tdb->map_ptr = (char *)newdb;
  81                 memcpy(&tdb->header, newdb, sizeof(tdb->header));
  82                 /* Convert the `ondisk' version if asked. */
  83                 TDB1_CONV(*newdb);
  84                 return 0;
  85         }
  86         if (lseek(tdb->fd, 0, SEEK_SET) == -1)
  87                 goto fail;
  88
  89         if (ftruncate(tdb->fd, 0) == -1)
  90                 goto fail;
  91
  92         /* This creates an endian-converted header, as if read from disk */
  93         TDB1_CONV(*newdb);
  94         memcpy(&tdb->header, newdb, sizeof(tdb->header));
  95         /* Don't endian-convert the magic food! */
  96         memcpy(newdb->magic_food, TDB_MAGIC_FOOD, strlen(TDB_MAGIC_FOOD)+1);
  97         /* we still have "ret == -1" here */
  98         if (tdb1_write_all(tdb->fd, newdb, size))
  99                 ret = 0;
 100
 101   fail:
 102         SAFE_FREE(newdb);
 103         return ret;
 104 }
 105
 106
 107
 108 static int tdb1_already_open(dev_t device,
 109                             ino_t ino)
 110 {
 111         struct tdb1_context *i;
 112
 113         for (i = tdb1s; 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 tdb1_error or tdb1_errname, just do strerror(errno).
 130
 131    @param name may be NULL for internal databases. */
 132 struct tdb1_context *tdb1_open(const char *name, int hash_size, int tdb1_flags,
 133                       int open_flags, mode_t mode)
 134 {
 135         return tdb1_open_ex(name, hash_size, tdb1_flags, open_flags, mode, NULL, NULL);
 136 }
 137
 138 static bool hash_correct(struct tdb1_context *tdb,
 139                          uint32_t *m1, uint32_t *m2)
 140 {
 141         tdb1_header_hash(tdb, m1, m2);
 142         return (tdb->header.magic1_hash == *m1 &&
 143                 tdb->header.magic2_hash == *m2);
 144 }
 145
 146 static bool check_header_hash(struct tdb1_context *tdb,
 147                               uint32_t *m1, uint32_t *m2)
 148 {
 149         if (hash_correct(tdb, m1, m2))
 150                 return true;
 151
 152         /* If they use one inbuilt, try the other inbuilt hash. */
 153         if (tdb->hash_fn == tdb1_old_hash)
 154                 tdb->hash_fn = tdb1_incompatible_hash;
 155         else if (tdb->hash_fn == tdb1_incompatible_hash)
 156                 tdb->hash_fn = tdb1_old_hash;
 157         else
 158                 return false;
 159         return hash_correct(tdb, m1, m2);
 160 }
 161
 162 struct tdb1_context *tdb1_open_ex(const char *name, int hash_size, int tdb1_flags,
 163                                 int open_flags, mode_t mode,
 164                                 const struct tdb1_logging_context *log_ctx,
 165                                 tdb1_hash_func hash_fn)
 166 {
 167         struct tdb1_context *tdb;
 168         struct stat st;
 169         int rev = 0, locked = 0;
 170         unsigned char *vp;
 171         uint32_t vertest;
 172         unsigned v;
 173         const char *hash_alg;
 174         uint32_t magic1, magic2;
 175
 176         if (!(tdb = (struct tdb1_context *)calloc(1, sizeof *tdb))) {
 177                 /* Can't log this */
 178                 errno = ENOMEM;
 179                 goto fail;
 180         }
 181         tdb1_io_init(tdb);
 182         tdb->fd = -1;
 183         tdb->name = NULL;
 184         tdb->map_ptr = NULL;
 185         tdb->flags = tdb1_flags;
 186         tdb->open_flags = open_flags;
 187         if (log_ctx) {
 188                 tdb->log_fn = log_ctx->log_fn;
 189                 tdb->log_data = log_ctx->log_private;
 190         } else
 191                 tdb->log_fn = NULL;
 192
 193         if (name == NULL && (tdb1_flags & TDB1_INTERNAL)) {
 194                 name = "__TDB1_INTERNAL__";
 195         }
 196
 197         if (name == NULL) {
 198                 tdb->name = (char *)"__NULL__";
 199                 tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 200                            "tdb1_open_ex: called with name == NULL");
 201                 tdb->name = NULL;
 202                 errno = EINVAL;
 203                 goto fail;
 204         }
 205
 206         /* now make a copy of the name, as the caller memory might went away */
 207         if (!(tdb->name = (char *)strdup(name))) {
 208                 /*
 209                  * set the name as the given string, so that tdb1_name() will
 210                  * work in case of an error.
 211                  */
 212                 tdb->name = (char *)name;
 213                 tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
 214                            "tdb1_open_ex: can't strdup(%s)", name);
 215                 tdb->name = NULL;
 216                 errno = ENOMEM;
 217                 goto fail;
 218         }
 219
 220         if (hash_fn) {
 221                 tdb->hash_fn = hash_fn;
 222                 if (hash_fn == tdb1_incompatible_hash)
 223                         hash_alg = "tdb1_incompatible_hash";
 224                 else
 225                         hash_alg = "the user defined";
 226         } else {
 227                 tdb->hash_fn = tdb1_old_hash;
 228                 hash_alg = "default";
 229         }
 230
 231         /* cache the page size */
 232         tdb->page_size = getpagesize();
 233         if (tdb->page_size <= 0) {
 234                 tdb->page_size = 0x2000;
 235         }
 236
 237         tdb->max_dead_records = (tdb1_flags & TDB1_VOLATILE) ? 5 : 0;
 238
 239         if ((open_flags & O_ACCMODE) == O_WRONLY) {
 240                 tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 241                            "tdb1_open_ex: can't open tdb %s write-only",
 242                            name);
 243                 errno = EINVAL;
 244                 goto fail;
 245         }
 246
 247         if (hash_size == 0)
 248                 hash_size = TDB1_DEFAULT_HASH_SIZE;
 249         if ((open_flags & O_ACCMODE) == O_RDONLY) {
 250                 tdb->read_only = 1;
 251                 /* read only databases don't do locking or clear if first */
 252                 tdb->flags |= TDB1_NOLOCK;
 253                 tdb->flags &= ~TDB1_CLEAR_IF_FIRST;
 254         }
 255
 256         if ((tdb->flags & TDB1_ALLOW_NESTING) &&
 257             (tdb->flags & TDB1_DISALLOW_NESTING)) {
 258                 tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 259                            "tdb1_open_ex: "
 260                            "allow_nesting and disallow_nesting are not allowed together!");
 261                 errno = EINVAL;
 262                 goto fail;
 263         }
 264
 265         /*
 266          * TDB1_ALLOW_NESTING is the default behavior.
 267          * Note: this may change in future versions!
 268          */
 269         if (!(tdb->flags & TDB1_DISALLOW_NESTING)) {
 270                 tdb->flags |= TDB1_ALLOW_NESTING;
 271         }
 272
 273         /* internal databases don't mmap or lock, and start off cleared */
 274         if (tdb->flags & TDB1_INTERNAL) {
 275                 tdb->flags |= (TDB1_NOLOCK | TDB1_NOMMAP);
 276                 tdb->flags &= ~TDB1_CLEAR_IF_FIRST;
 277                 if (tdb1_new_database(tdb, hash_size) != 0) {
 278                         tdb_logerr(tdb, tdb->last_error, TDB_LOG_ERROR,
 279                                    "tdb1_open_ex: tdb1_new_database failed!");
 280                         goto fail;
 281                 }
 282                 goto internal;
 283         }
 284
 285         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
 286                 tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 287                            "tdb1_open_ex: could not open file %s: %s",
 288                            name, strerror(errno));
 289                 goto fail;      /* errno set by open(2) */
 290         }
 291
 292         /* on exec, don't inherit the fd */
 293         v = fcntl(tdb->fd, F_GETFD, 0);
 294         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 295
 296         /* ensure there is only one process initialising at once */
 297         if (tdb1_nest_lock(tdb, TDB1_OPEN_LOCK, F_WRLCK, TDB_LOCK_WAIT) == -1) {
 298                 tdb_logerr(tdb, tdb->last_error, TDB_LOG_ERROR,
 299                            "tdb1_open_ex: failed to get open lock on %s: %s",
 300                            name, strerror(errno));
 301                 goto fail;      /* errno set by tdb1_brlock */
 302         }
 303
 304         /* we need to zero database if we are the only one with it open */
 305         if ((tdb1_flags & TDB1_CLEAR_IF_FIRST) &&
 306             (!tdb->read_only) &&
 307             (locked = (tdb1_nest_lock(tdb, TDB1_ACTIVE_LOCK, F_WRLCK, TDB_LOCK_NOWAIT|TDB_LOCK_PROBE) == 0))) {
 308                 open_flags |= O_CREAT;
 309                 if (ftruncate(tdb->fd, 0) == -1) {
 310                         tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 311                                    "tdb1_open_ex: "
 312                                    "failed to truncate %s: %s",
 313                                    name, strerror(errno));
 314                         goto fail; /* errno set by ftruncate */
 315                 }
 316         }
 317
 318         errno = 0;
 319         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
 320             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0) {
 321                 if (!(open_flags & O_CREAT) || tdb1_new_database(tdb, hash_size) == -1) {
 322                         if (errno == 0) {
 323                                 errno = EIO; /* ie bad format or something */
 324                         }
 325                         goto fail;
 326                 }
 327                 rev = (tdb->flags & TDB1_CONVERT);
 328         } else if (tdb->header.version != TDB1_VERSION
 329                    && !(rev = (tdb->header.version==TDB1_BYTEREV(TDB1_VERSION)))) {
 330                 /* wrong version */
 331                 errno = EIO;
 332                 goto fail;
 333         }
 334         vp = (unsigned char *)&tdb->header.version;
 335         vertest = (((uint32_t)vp[0]) << 24) | (((uint32_t)vp[1]) << 16) |
 336                   (((uint32_t)vp[2]) << 8) | (uint32_t)vp[3];
 337         tdb->flags |= (vertest==TDB1_VERSION) ? TDB1_BIGENDIAN : 0;
 338         if (!rev)
 339                 tdb->flags &= ~TDB1_CONVERT;
 340         else {
 341                 tdb->flags |= TDB1_CONVERT;
 342                 tdb1_convert(&tdb->header, sizeof(tdb->header));
 343         }
 344         if (fstat(tdb->fd, &st) == -1)
 345                 goto fail;
 346
 347         if (tdb->header.rwlocks != 0 &&
 348             tdb->header.rwlocks != TDB1_HASH_RWLOCK_MAGIC) {
 349                 tdb_logerr(tdb, TDB_ERR_CORRUPT, TDB_LOG_ERROR,
 350                            "tdb1_open_ex: spinlocks no longer supported");
 351                 goto fail;
 352         }
 353
 354         if ((tdb->header.magic1_hash == 0) && (tdb->header.magic2_hash == 0)) {
 355                 /* older TDB without magic hash references */
 356                 tdb->hash_fn = tdb1_old_hash;
 357         } else if (!check_header_hash(tdb, &magic1, &magic2)) {
 358                 tdb_logerr(tdb, TDB_ERR_CORRUPT, TDB_LOG_USE_ERROR,
 359                            "tdb1_open_ex: "
 360                            "%s was not created with %s hash function we are using\n"
 361                            "magic1_hash[0x%08X %s 0x%08X] "
 362                            "magic2_hash[0x%08X %s 0x%08X]",
 363                            name, hash_alg,
 364                            tdb->header.magic1_hash,
 365                            (tdb->header.magic1_hash == magic1) ? "==" : "!=",
 366                            magic1,
 367                            tdb->header.magic2_hash,
 368                            (tdb->header.magic2_hash == magic2) ? "==" : "!=",
 369                            magic2);
 370                 errno = EINVAL;
 371                 goto fail;
 372         }
 373
 374         /* Is it already in the open list?  If so, fail. */
 375         if (tdb1_already_open(st.st_dev, st.st_ino)) {
 376                 tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_USE_ERROR,
 377                            "tdb1_open_ex: "
 378                            "%s (%d,%d) is already open in this process",
 379                            name, (int)st.st_dev, (int)st.st_ino);
 380                 errno = EBUSY;
 381                 goto fail;
 382         }
 383
 384         tdb->map_size = st.st_size;
 385         tdb->device = st.st_dev;
 386         tdb->inode = st.st_ino;
 387         tdb1_mmap(tdb);
 388         if (locked) {
 389                 if (tdb1_nest_unlock(tdb, TDB1_ACTIVE_LOCK, F_WRLCK) == -1) {
 390                         tdb_logerr(tdb, tdb->last_error, TDB_LOG_ERROR,
 391                                    "tdb1_open_ex: "
 392                                    "failed to release ACTIVE_LOCK on %s: %s",
 393                                    name, strerror(errno));
 394                         goto fail;
 395                 }
 396
 397         }
 398
 399         /* We always need to do this if the CLEAR_IF_FIRST flag is set, even if
 400            we didn't get the initial exclusive lock as we need to let all other
 401            users know we're using it. */
 402
 403         if (tdb1_flags & TDB1_CLEAR_IF_FIRST) {
 404                 /* leave this lock in place to indicate it's in use */
 405                 if (tdb1_nest_lock(tdb, TDB1_ACTIVE_LOCK, F_RDLCK, TDB_LOCK_WAIT) == -1) {
 406                         goto fail;
 407                 }
 408         }
 409
 410         /* if needed, run recovery */
 411         if (tdb1_transaction_recover(tdb) == -1) {
 412                 goto fail;
 413         }
 414
 415  internal:
 416         /* Internal (memory-only) databases skip all the code above to
 417          * do with disk files, and resume here by releasing their
 418          * open lock and hooking into the active list. */
 419         if (tdb1_nest_unlock(tdb, TDB1_OPEN_LOCK, F_WRLCK) == -1) {
 420                 goto fail;
 421         }
 422         tdb->next = tdb1s;
 423         tdb1s = tdb;
 424         return tdb;
 425
 426  fail:
 427         { int save_errno = errno;
 428
 429         if (!tdb)
 430                 return NULL;
 431
 432         if (tdb->map_ptr) {
 433                 if (tdb->flags & TDB1_INTERNAL)
 434                         SAFE_FREE(tdb->map_ptr);
 435                 else
 436                         tdb1_munmap(tdb);
 437         }
 438         if (tdb->fd != -1)
 439                 if (close(tdb->fd) != 0)
 440                         tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 441                                    "tdb1_open_ex: failed to close tdb->fd on error!");
 442         SAFE_FREE(tdb->lockrecs);
 443         SAFE_FREE(tdb->name);
 444         SAFE_FREE(tdb);
 445         errno = save_errno;
 446         return NULL;
 447         }
 448 }
 449
 450 /*
 451  * Set the maximum number of dead records per hash chain
 452  */
 453
 454 void tdb1_set_max_dead(struct tdb1_context *tdb, int max_dead)
 455 {
 456         tdb->max_dead_records = max_dead;
 457 }
 458
 459 /**
 460  * Close a database.
 461  *
 462  * @returns -1 for error; 0 for success.
 463  **/
 464 int tdb1_close(struct tdb1_context *tdb)
 465 {
 466         struct tdb1_context **i;
 467         int ret = 0;
 468
 469         if (tdb->transaction) {
 470                 tdb1_transaction_cancel(tdb);
 471         }
 472
 473         if (tdb->map_ptr) {
 474                 if (tdb->flags & TDB1_INTERNAL)
 475                         SAFE_FREE(tdb->map_ptr);
 476                 else
 477                         tdb1_munmap(tdb);
 478         }
 479         SAFE_FREE(tdb->name);
 480         if (tdb->fd != -1) {
 481                 ret = close(tdb->fd);
 482                 tdb->fd = -1;
 483         }
 484         SAFE_FREE(tdb->lockrecs);
 485
 486         /* Remove from contexts list */
 487         for (i = &tdb1s; *i; i = &(*i)->next) {
 488                 if (*i == tdb) {
 489                         *i = tdb->next;
 490                         break;
 491                 }
 492         }
 493
 494         memset(tdb, 0, sizeof(*tdb));
 495         SAFE_FREE(tdb);
 496
 497         return ret;
 498 }