lib/libc/db/btree/bt_open.c

   1 /*-
   2  * Copyright (c) 1990, 1993, 1994
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Mike Olson.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #if defined(LIBC_SCCS) && !defined(lint)
  34 static char sccsid[] = "@(#)bt_open.c   8.10 (Berkeley) 8/17/94";
  35 #endif /* LIBC_SCCS and not lint */
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 /*
  40  * Implementation of btree access method for 4.4BSD.
  41  *
  42  * The design here was originally based on that of the btree access method
  43  * used in the Postgres database system at UC Berkeley.  This implementation
  44  * is wholly independent of the Postgres code.
  45  */
  46
  47 #include "namespace.h"
  48 #include <sys/param.h>
  49 #include <sys/stat.h>
  50
  51 #include <errno.h>
  52 #include <fcntl.h>
  53 #include <limits.h>
  54 #include <signal.h>
  55 #include <stdio.h>
  56 #include <stdlib.h>
  57 #include <string.h>
  58 #include <unistd.h>
  59 #include "un-namespace.h"
  60
  61 #include <db.h>
  62 #include "btree.h"
  63
  64 #ifdef DEBUG
  65 #undef  MINPSIZE
  66 #define MINPSIZE        128
  67 #endif
  68
  69 static int byteorder(void);
  70 static int nroot(BTREE *);
  71 static int tmp(void);
  72
  73 /*
  74  * __BT_OPEN -- Open a btree.
  75  *
  76  * Creates and fills a DB struct, and calls the routine that actually
  77  * opens the btree.
  78  *
  79  * Parameters:
  80  *      fname:  filename (NULL for in-memory trees)
  81  *      flags:  open flag bits
  82  *      mode:   open permission bits
  83  *      b:      BTREEINFO pointer
  84  *
  85  * Returns:
  86  *      NULL on failure, pointer to DB on success.
  87  *
  88  */
  89 DB *
  90 __bt_open(fname, flags, mode, openinfo, dflags)
  91         const char *fname;
  92         int flags, mode, dflags;
  93         const BTREEINFO *openinfo;
  94 {
  95         struct stat sb;
  96         BTMETA m;
  97         BTREE *t;
  98         BTREEINFO b;
  99         DB *dbp;
 100         pgno_t ncache;
 101         ssize_t nr;
 102         int machine_lorder;
 103
 104         t = NULL;
 105
 106         /*
 107          * Intention is to make sure all of the user's selections are okay
 108          * here and then use them without checking.  Can't be complete, since
 109          * we don't know the right page size, lorder or flags until the backing
 110          * file is opened.  Also, the file's page size can cause the cachesize
 111          * to change.
 112          */
 113         machine_lorder = byteorder();
 114         if (openinfo) {
 115                 b = *openinfo;
 116
 117                 /* Flags: R_DUP. */
 118                 if (b.flags & ~(R_DUP))
 119                         goto einval;
 120
 121                 /*
 122                  * Page size must be indx_t aligned and >= MINPSIZE.  Default
 123                  * page size is set farther on, based on the underlying file
 124                  * transfer size.
 125                  */
 126                 if (b.psize &&
 127                     (b.psize < MINPSIZE || b.psize > MAX_PAGE_OFFSET + 1 ||
 128                     b.psize & (sizeof(indx_t) - 1) ))
 129                         goto einval;
 130
 131                 /* Minimum number of keys per page; absolute minimum is 2. */
 132                 if (b.minkeypage) {
 133                         if (b.minkeypage < 2)
 134                                 goto einval;
 135                 } else
 136                         b.minkeypage = DEFMINKEYPAGE;
 137
 138                 /* If no comparison, use default comparison and prefix. */
 139                 if (b.compare == NULL) {
 140                         b.compare = __bt_defcmp;
 141                         if (b.prefix == NULL)
 142                                 b.prefix = __bt_defpfx;
 143                 }
 144
 145                 if (b.lorder == 0)
 146                         b.lorder = machine_lorder;
 147         } else {
 148                 b.compare = __bt_defcmp;
 149                 b.cachesize = 0;
 150                 b.flags = 0;
 151                 b.lorder = machine_lorder;
 152                 b.minkeypage = DEFMINKEYPAGE;
 153                 b.prefix = __bt_defpfx;
 154                 b.psize = 0;
 155         }
 156
 157         /* Check for the ubiquitous PDP-11. */
 158         if (b.lorder != BIG_ENDIAN && b.lorder != LITTLE_ENDIAN)
 159                 goto einval;
 160
 161         /* Allocate and initialize DB and BTREE structures. */
 162         if ((t = (BTREE *)calloc(1, sizeof(BTREE))) == NULL)
 163                 goto err;
 164         t->bt_fd = -1;                  /* Don't close unopened fd on error. */
 165         t->bt_lorder = b.lorder;
 166         t->bt_order = NOT;
 167         t->bt_cmp = b.compare;
 168         t->bt_pfx = b.prefix;
 169         t->bt_rfd = -1;
 170
 171         if ((t->bt_dbp = dbp = (DB *)calloc(1, sizeof(DB))) == NULL)
 172                 goto err;
 173         if (t->bt_lorder != machine_lorder)
 174                 F_SET(t, B_NEEDSWAP);
 175
 176         dbp->type = DB_BTREE;
 177         dbp->internal = t;
 178         dbp->close = __bt_close;
 179         dbp->del = __bt_delete;
 180         dbp->fd = __bt_fd;
 181         dbp->get = __bt_get;
 182         dbp->put = __bt_put;
 183         dbp->seq = __bt_seq;
 184         dbp->sync = __bt_sync;
 185
 186         /*
 187          * If no file name was supplied, this is an in-memory btree and we
 188          * open a backing temporary file.  Otherwise, it's a disk-based tree.
 189          */
 190         if (fname) {
 191                 switch (flags & O_ACCMODE) {
 192                 case O_RDONLY:
 193                         F_SET(t, B_RDONLY);
 194                         break;
 195                 case O_RDWR:
 196                         break;
 197                 case O_WRONLY:
 198                 default:
 199                         goto einval;
 200                 }
 201
 202                 if ((t->bt_fd = _open(fname, flags, mode)) < 0)
 203                         goto err;
 204
 205         } else {
 206                 if ((flags & O_ACCMODE) != O_RDWR)
 207                         goto einval;
 208                 if ((t->bt_fd = tmp()) == -1)
 209                         goto err;
 210                 F_SET(t, B_INMEM);
 211         }
 212
 213         if (_fcntl(t->bt_fd, F_SETFD, 1) == -1)
 214                 goto err;
 215
 216         if (_fstat(t->bt_fd, &sb))
 217                 goto err;
 218         if (sb.st_size) {
 219                 if ((nr = _read(t->bt_fd, &m, sizeof(BTMETA))) < 0)
 220                         goto err;
 221                 if (nr != sizeof(BTMETA))
 222                         goto eftype;
 223
 224                 /*
 225                  * Read in the meta-data.  This can change the notion of what
 226                  * the lorder, page size and flags are, and, when the page size
 227                  * changes, the cachesize value can change too.  If the user
 228                  * specified the wrong byte order for an existing database, we
 229                  * don't bother to return an error, we just clear the NEEDSWAP
 230                  * bit.
 231                  */
 232                 if (m.magic == BTREEMAGIC)
 233                         F_CLR(t, B_NEEDSWAP);
 234                 else {
 235                         F_SET(t, B_NEEDSWAP);
 236                         M_32_SWAP(m.magic);
 237                         M_32_SWAP(m.version);
 238                         M_32_SWAP(m.psize);
 239                         M_32_SWAP(m.free);
 240                         M_32_SWAP(m.nrecs);
 241                         M_32_SWAP(m.flags);
 242                 }
 243                 if (m.magic != BTREEMAGIC || m.version != BTREEVERSION)
 244                         goto eftype;
 245                 if (m.psize < MINPSIZE || m.psize > MAX_PAGE_OFFSET + 1 ||
 246                     m.psize & (sizeof(indx_t) - 1) )
 247                         goto eftype;
 248                 if (m.flags & ~SAVEMETA)
 249                         goto eftype;
 250                 b.psize = m.psize;
 251                 F_SET(t, m.flags);
 252                 t->bt_free = m.free;
 253                 t->bt_nrecs = m.nrecs;
 254         } else {
 255                 /*
 256                  * Set the page size to the best value for I/O to this file.
 257                  * Don't overflow the page offset type.
 258                  */
 259                 if (b.psize == 0) {
 260                         b.psize = sb.st_blksize;
 261                         if (b.psize < MINPSIZE)
 262                                 b.psize = MINPSIZE;
 263                         if (b.psize > MAX_PAGE_OFFSET + 1)
 264                                 b.psize = MAX_PAGE_OFFSET + 1;
 265                 }
 266
 267                 /* Set flag if duplicates permitted. */
 268                 if (!(b.flags & R_DUP))
 269                         F_SET(t, B_NODUPS);
 270
 271                 t->bt_free = P_INVALID;
 272                 t->bt_nrecs = 0;
 273                 F_SET(t, B_METADIRTY);
 274         }
 275
 276         t->bt_psize = b.psize;
 277
 278         /* Set the cache size; must be a multiple of the page size. */
 279         if (b.cachesize && b.cachesize & (b.psize - 1) )
 280                 b.cachesize += (~b.cachesize & (b.psize - 1) ) + 1;
 281         if (b.cachesize < b.psize * MINCACHE)
 282                 b.cachesize = b.psize * MINCACHE;
 283
 284         /* Calculate number of pages to cache. */
 285         ncache = (b.cachesize + t->bt_psize - 1) / t->bt_psize;
 286
 287         /*
 288          * The btree data structure requires that at least two keys can fit on
 289          * a page, but other than that there's no fixed requirement.  The user
 290          * specified a minimum number per page, and we translated that into the
 291          * number of bytes a key/data pair can use before being placed on an
 292          * overflow page.  This calculation includes the page header, the size
 293          * of the index referencing the leaf item and the size of the leaf item
 294          * structure.  Also, don't let the user specify a minkeypage such that
 295          * a key/data pair won't fit even if both key and data are on overflow
 296          * pages.
 297          */
 298         t->bt_ovflsize = (t->bt_psize - BTDATAOFF) / b.minkeypage -
 299             (sizeof(indx_t) + NBLEAFDBT(0, 0));
 300         if (t->bt_ovflsize < NBLEAFDBT(NOVFLSIZE, NOVFLSIZE) + sizeof(indx_t))
 301                 t->bt_ovflsize =
 302                     NBLEAFDBT(NOVFLSIZE, NOVFLSIZE) + sizeof(indx_t);
 303
 304         /* Initialize the buffer pool. */
 305         if ((t->bt_mp =
 306             mpool_open(NULL, t->bt_fd, t->bt_psize, ncache)) == NULL)
 307                 goto err;
 308         if (!F_ISSET(t, B_INMEM))
 309                 mpool_filter(t->bt_mp, __bt_pgin, __bt_pgout, t);
 310
 311         /* Create a root page if new tree. */
 312         if (nroot(t) == RET_ERROR)
 313                 goto err;
 314
 315         /* Global flags. */
 316         if (dflags & DB_LOCK)
 317                 F_SET(t, B_DB_LOCK);
 318         if (dflags & DB_SHMEM)
 319                 F_SET(t, B_DB_SHMEM);
 320         if (dflags & DB_TXN)
 321                 F_SET(t, B_DB_TXN);
 322
 323         return (dbp);
 324
 325 einval: errno = EINVAL;
 326         goto err;
 327
 328 eftype: errno = EFTYPE;
 329         goto err;
 330
 331 err:    if (t) {
 332                 if (t->bt_dbp)
 333                         free(t->bt_dbp);
 334                 if (t->bt_fd != -1)
 335                         (void)_close(t->bt_fd);
 336                 free(t);
 337         }
 338         return (NULL);
 339 }
 340
 341 /*
 342  * NROOT -- Create the root of a new tree.
 343  *
 344  * Parameters:
 345  *      t:      tree
 346  *
 347  * Returns:
 348  *      RET_ERROR, RET_SUCCESS
 349  */
 350 static int
 351 nroot(t)
 352         BTREE *t;
 353 {
 354         PAGE *meta, *root;
 355         pgno_t npg;
 356
 357         if ((meta = mpool_get(t->bt_mp, 0, 0)) != NULL) {
 358                 mpool_put(t->bt_mp, meta, 0);
 359                 return (RET_SUCCESS);
 360         }
 361         if (errno != EINVAL)            /* It's OK to not exist. */
 362                 return (RET_ERROR);
 363         errno = 0;
 364
 365         if ((meta = mpool_new(t->bt_mp, &npg)) == NULL)
 366                 return (RET_ERROR);
 367
 368         if ((root = mpool_new(t->bt_mp, &npg)) == NULL)
 369                 return (RET_ERROR);
 370
 371         if (npg != P_ROOT)
 372                 return (RET_ERROR);
 373         root->pgno = npg;
 374         root->prevpg = root->nextpg = P_INVALID;
 375         root->lower = BTDATAOFF;
 376         root->upper = t->bt_psize;
 377         root->flags = P_BLEAF;
 378         memset(meta, 0, t->bt_psize);
 379         mpool_put(t->bt_mp, meta, MPOOL_DIRTY);
 380         mpool_put(t->bt_mp, root, MPOOL_DIRTY);
 381         return (RET_SUCCESS);
 382 }
 383
 384 static int
 385 tmp()
 386 {
 387         sigset_t set, oset;
 388         int fd;
 389         char *envtmp = NULL;
 390         char path[MAXPATHLEN];
 391
 392         if (issetugid() == 0)
 393                 envtmp = getenv("TMPDIR");
 394         (void)snprintf(path,
 395             sizeof(path), "%s/bt.XXXXXXXXXX", envtmp ? envtmp : "/tmp");
 396
 397         (void)sigfillset(&set);
 398         (void)_sigprocmask(SIG_BLOCK, &set, &oset);
 399         if ((fd = mkstemp(path)) != -1)
 400                 (void)unlink(path);
 401         (void)_sigprocmask(SIG_SETMASK, &oset, NULL);
 402         return(fd);
 403 }
 404
 405 static int
 406 byteorder()
 407 {
 408         u_int32_t x;
 409         u_char *p;
 410
 411         x = 0x01020304;
 412         p = (u_char *)&x;
 413         switch (*p) {
 414         case 1:
 415                 return (BIG_ENDIAN);
 416         case 4:
 417                 return (LITTLE_ENDIAN);
 418         default:
 419                 return (0);
 420         }
 421 }
 422
 423 int
 424 __bt_fd(dbp)
 425         const DB *dbp;
 426 {
 427         BTREE *t;
 428
 429         t = dbp->internal;
 430
 431         /* Toss any page pinned across calls. */
 432         if (t->bt_pinned != NULL) {
 433                 mpool_put(t->bt_mp, t->bt_pinned, 0);
 434                 t->bt_pinned = NULL;
 435         }
 436
 437         /* In-memory database can't have a file descriptor. */
 438         if (F_ISSET(t, B_INMEM)) {
 439                 errno = ENOENT;
 440                 return (-1);
 441         }
 442         return (t->bt_fd);
 443 }