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 & TDB_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;
 170         unsigned v;
 171         const char *hash_alg;
 172         uint32_t magic1, magic2;
 173
 174         if (!(tdb = (struct tdb1_context *)calloc(1, sizeof *tdb))) {
 175                 /* Can't log this */
 176                 errno = ENOMEM;
 177                 goto fail;
 178         }
 179         tdb1_io_init(tdb);
 180         tdb->fd = -1;
 181         tdb->name = NULL;
 182         tdb->map_ptr = NULL;
 183         tdb->flags = tdb1_flags;
 184         tdb->open_flags = open_flags;
 185         if (log_ctx) {
 186                 tdb->log_fn = log_ctx->log_fn;
 187                 tdb->log_data = log_ctx->log_private;
 188         } else
 189                 tdb->log_fn = NULL;
 190
 191         if (name == NULL && (tdb1_flags & TDB_INTERNAL)) {
 192                 name = "__TDB1_INTERNAL__";
 193         }
 194
 195         if (name == NULL) {
 196                 tdb->name = (char *)"__NULL__";
 197                 tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 198                            "tdb1_open_ex: called with name == NULL");
 199                 tdb->name = NULL;
 200                 errno = EINVAL;
 201                 goto fail;
 202         }
 203
 204         /* now make a copy of the name, as the caller memory might went away */
 205         if (!(tdb->name = (char *)strdup(name))) {
 206                 /*
 207                  * set the name as the given string, so that tdb1_name() will
 208                  * work in case of an error.
 209                  */
 210                 tdb->name = (char *)name;
 211                 tdb_logerr(tdb, TDB_ERR_OOM, TDB_LOG_ERROR,
 212                            "tdb1_open_ex: can't strdup(%s)", name);
 213                 tdb->name = NULL;
 214                 errno = ENOMEM;
 215                 goto fail;
 216         }
 217
 218         if (hash_fn) {
 219                 tdb->hash_fn = hash_fn;
 220                 if (hash_fn == tdb1_incompatible_hash)
 221                         hash_alg = "tdb1_incompatible_hash";
 222                 else
 223                         hash_alg = "the user defined";
 224         } else {
 225                 tdb->hash_fn = tdb1_old_hash;
 226                 hash_alg = "default";
 227         }
 228
 229         /* cache the page size */
 230         tdb->page_size = getpagesize();
 231         if (tdb->page_size <= 0) {
 232                 tdb->page_size = 0x2000;
 233         }
 234
 235         /* FIXME: Used to be 5 for TDB_VOLATILE. */
 236         tdb->max_dead_records = 0;
 237
 238         if ((open_flags & O_ACCMODE) == O_WRONLY) {
 239                 tdb_logerr(tdb, TDB_ERR_EINVAL, TDB_LOG_USE_ERROR,
 240                            "tdb1_open_ex: can't open tdb %s write-only",
 241                            name);
 242                 errno = EINVAL;
 243                 goto fail;
 244         }
 245
 246         if (hash_size == 0)
 247                 hash_size = TDB1_DEFAULT_HASH_SIZE;
 248         if ((open_flags & O_ACCMODE) == O_RDONLY) {
 249                 tdb->read_only = 1;
 250                 /* read only databases don't do locking */
 251                 tdb->flags |= TDB_NOLOCK;
 252         }
 253
 254         /* internal databases don't mmap or lock, and start off cleared */
 255         if (tdb->flags & TDB_INTERNAL) {
 256                 tdb->flags |= (TDB_NOLOCK | TDB_NOMMAP);
 257                 if (tdb1_new_database(tdb, hash_size) != 0) {
 258                         tdb_logerr(tdb, tdb->last_error, TDB_LOG_ERROR,
 259                                    "tdb1_open_ex: tdb1_new_database failed!");
 260                         goto fail;
 261                 }
 262                 goto internal;
 263         }
 264
 265         if ((tdb->fd = open(name, open_flags, mode)) == -1) {
 266                 tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 267                            "tdb1_open_ex: could not open file %s: %s",
 268                            name, strerror(errno));
 269                 goto fail;      /* errno set by open(2) */
 270         }
 271
 272         /* on exec, don't inherit the fd */
 273         v = fcntl(tdb->fd, F_GETFD, 0);
 274         fcntl(tdb->fd, F_SETFD, v | FD_CLOEXEC);
 275
 276         /* ensure there is only one process initialising at once */
 277         if (tdb1_nest_lock(tdb, TDB1_OPEN_LOCK, F_WRLCK, TDB_LOCK_WAIT) == -1) {
 278                 tdb_logerr(tdb, tdb->last_error, TDB_LOG_ERROR,
 279                            "tdb1_open_ex: failed to get open lock on %s: %s",
 280                            name, strerror(errno));
 281                 goto fail;      /* errno set by tdb1_brlock */
 282         }
 283
 284         errno = 0;
 285         if (read(tdb->fd, &tdb->header, sizeof(tdb->header)) != sizeof(tdb->header)
 286             || strcmp(tdb->header.magic_food, TDB_MAGIC_FOOD) != 0) {
 287                 if (!(open_flags & O_CREAT) || tdb1_new_database(tdb, hash_size) == -1) {
 288                         if (errno == 0) {
 289                                 errno = EIO; /* ie bad format or something */
 290                         }
 291                         goto fail;
 292                 }
 293                 rev = (tdb->flags & TDB_CONVERT);
 294         } else if (tdb->header.version != TDB1_VERSION
 295                    && !(rev = (tdb->header.version==TDB1_BYTEREV(TDB1_VERSION)))) {
 296                 /* wrong version */
 297                 errno = EIO;
 298                 goto fail;
 299         }
 300         if (!rev)
 301                 tdb->flags &= ~TDB_CONVERT;
 302         else {
 303                 tdb->flags |= TDB_CONVERT;
 304                 tdb1_convert(&tdb->header, sizeof(tdb->header));
 305         }
 306         if (fstat(tdb->fd, &st) == -1)
 307                 goto fail;
 308
 309         if (tdb->header.rwlocks != 0 &&
 310             tdb->header.rwlocks != TDB1_HASH_RWLOCK_MAGIC) {
 311                 tdb_logerr(tdb, TDB_ERR_CORRUPT, TDB_LOG_ERROR,
 312                            "tdb1_open_ex: spinlocks no longer supported");
 313                 goto fail;
 314         }
 315
 316         if ((tdb->header.magic1_hash == 0) && (tdb->header.magic2_hash == 0)) {
 317                 /* older TDB without magic hash references */
 318                 tdb->hash_fn = tdb1_old_hash;
 319         } else if (!check_header_hash(tdb, &magic1, &magic2)) {
 320                 tdb_logerr(tdb, TDB_ERR_CORRUPT, TDB_LOG_USE_ERROR,
 321                            "tdb1_open_ex: "
 322                            "%s was not created with %s hash function we are using\n"
 323                            "magic1_hash[0x%08X %s 0x%08X] "
 324                            "magic2_hash[0x%08X %s 0x%08X]",
 325                            name, hash_alg,
 326                            tdb->header.magic1_hash,
 327                            (tdb->header.magic1_hash == magic1) ? "==" : "!=",
 328                            magic1,
 329                            tdb->header.magic2_hash,
 330                            (tdb->header.magic2_hash == magic2) ? "==" : "!=",
 331                            magic2);
 332                 errno = EINVAL;
 333                 goto fail;
 334         }
 335
 336         /* Is it already in the open list?  If so, fail. */
 337         if (tdb1_already_open(st.st_dev, st.st_ino)) {
 338                 tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_USE_ERROR,
 339                            "tdb1_open_ex: "
 340                            "%s (%d,%d) is already open in this process",
 341                            name, (int)st.st_dev, (int)st.st_ino);
 342                 errno = EBUSY;
 343                 goto fail;
 344         }
 345
 346         tdb->map_size = st.st_size;
 347         tdb->device = st.st_dev;
 348         tdb->inode = st.st_ino;
 349         tdb1_mmap(tdb);
 350
 351         /* if needed, run recovery */
 352         if (tdb1_transaction_recover(tdb) == -1) {
 353                 goto fail;
 354         }
 355
 356  internal:
 357         /* Internal (memory-only) databases skip all the code above to
 358          * do with disk files, and resume here by releasing their
 359          * open lock and hooking into the active list. */
 360         if (tdb1_nest_unlock(tdb, TDB1_OPEN_LOCK, F_WRLCK) == -1) {
 361                 goto fail;
 362         }
 363         tdb->next = tdb1s;
 364         tdb1s = tdb;
 365         return tdb;
 366
 367  fail:
 368         { int save_errno = errno;
 369
 370         if (!tdb)
 371                 return NULL;
 372
 373         if (tdb->map_ptr) {
 374                 if (tdb->flags & TDB_INTERNAL)
 375                         SAFE_FREE(tdb->map_ptr);
 376                 else
 377                         tdb1_munmap(tdb);
 378         }
 379         if (tdb->fd != -1)
 380                 if (close(tdb->fd) != 0)
 381                         tdb_logerr(tdb, TDB_ERR_IO, TDB_LOG_ERROR,
 382                                    "tdb1_open_ex: failed to close tdb->fd on error!");
 383         SAFE_FREE(tdb->lockrecs);
 384         SAFE_FREE(tdb->name);
 385         SAFE_FREE(tdb);
 386         errno = save_errno;
 387         return NULL;
 388         }
 389 }
 390
 391 /*
 392  * Set the maximum number of dead records per hash chain
 393  */
 394
 395 void tdb1_set_max_dead(struct tdb1_context *tdb, int max_dead)
 396 {
 397         tdb->max_dead_records = max_dead;
 398 }
 399
 400 /**
 401  * Close a database.
 402  *
 403  * @returns -1 for error; 0 for success.
 404  **/
 405 int tdb1_close(struct tdb1_context *tdb)
 406 {
 407         struct tdb1_context **i;
 408         int ret = 0;
 409
 410         if (tdb->transaction) {
 411                 tdb1_transaction_cancel(tdb);
 412         }
 413
 414         if (tdb->map_ptr) {
 415                 if (tdb->flags & TDB_INTERNAL)
 416                         SAFE_FREE(tdb->map_ptr);
 417                 else
 418                         tdb1_munmap(tdb);
 419         }
 420         SAFE_FREE(tdb->name);
 421         if (tdb->fd != -1) {
 422                 ret = close(tdb->fd);
 423                 tdb->fd = -1;
 424         }
 425         SAFE_FREE(tdb->lockrecs);
 426
 427         /* Remove from contexts list */
 428         for (i = &tdb1s; *i; i = &(*i)->next) {
 429                 if (*i == tdb) {
 430                         *i = tdb->next;
 431                         break;
 432                 }
 433         }
 434
 435         memset(tdb, 0, sizeof(*tdb));
 436         SAFE_FREE(tdb);
 437
 438         return ret;
 439 }