/*-
* See the file LICENSE for redistribution information.
*
* Copyright (c) 1996, 1997, 1998
* Sleepycat Software. All rights reserved.
*/
/*
* Copyright (c) 1990, 1993, 1994, 1995, 1996
* Keith Bostic. All rights reserved.
*/
/*
* Copyright (c) 1990, 1993, 1994, 1995
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include "config.h"
#ifndef lint
#endif /* not lint */
#ifndef NO_SYSTEM_INCLUDES
#include <errno.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#endif
#include "db_int.h"
#include "shqueue.h"
#include "db_page.h"
#include "db_shash.h"
#include "db_swap.h"
#include "btree.h"
#include "hash.h"
#include "mp.h"
#include "db_am.h"
#include "common_ext.h"
/*
* If the metadata page has the flag set, set the local flag. If the page
* does NOT have the flag set, return EINVAL if the user's dbinfo argument
* caused us to already set the local flag.
*/
if ((meta_flags) & (m_name)) \
else \
"%s: %s specified in dbinfo argument but not set in file", \
goto einval; \
} \
}
/*
* db_open --
* Main library interface to the DB access methods.
*/
int
const char *fname;
int mode;
{
/* Validate arguments. */
#ifdef HAVE_SPINLOCKS
#else
#endif
return (ret);
/*
* You can't specify threads during the db_open() if the
* environment wasn't configured with them.
*/
"environment not created using DB_THREAD");
return (EINVAL);
}
/*
* Specifying a cachesize to db_open(3), after creating an
* environment with DB_INIT_MPOOL, is a common mistake.
*/
"cachesize will be ignored if environment exists");
return (EINVAL);
}
}
/* Allocate the DB structure, reference the DB_ENV structure. */
return (ret);
/* Initialize for error return. */
need_fileid = 1;
/* Random initialization. */
goto err;
/* Convert the db_open(3) flags. */
/* Convert the dbinfo structure flags. */
/*
* !!!
* We can't check for illegal flags until we know what type
* of open we're doing.
*/
}
/*
* Set based on the dbenv fields, although no logging or transactions
* are possible for temporary files.
*/
else
}
/* Set the common fields. */
} else {
/*
* We don't want anything that's not a power-of-2, as we rely
* on that for alignment of various types on the pages.
*/
goto einval;
}
else {
goto einval;
}
}
}
/* Fill in the default file mode. */
if (mode == 0)
/* Check if the user wants us to swap byte order. */
case 0:
break;
case DB_SWAPBYTES:
break;
default:
goto err;
}
/*
* If we have a file name, try and read the first page, figure out
* what type of file it is, and initialize everything we can based
* on that file's meta-data page.
*
* XXX
* We don't actually expect zero-length strings as arguments. We
* do the check, permitting them, because scripting languages, e.g.,
* the Tcl test suite, doesn't know anything about passing NULL's.
*/
/* Get the real file name. */
goto err;
/*
* Open the backing file. We need to make sure that multiple
* processes attempting to create the file at the same time
* are properly ordered so that only one of them creates the
* "unique" file id, so we open it O_EXCL and O_CREAT so two
* simultaneous attempts to create the region will return
* failure in one of the attempts. If we're one of the ones
* that fail, we simply retry without the O_CREAT flag, which
* will require that the meta-data page exist.
*/
retry_cnt = 0;
goto open_retry;
} else {
goto err;
}
} else
goto err;
}
/*
* Use the optimum I/O size as the pagesize if a pagesize not
* specified. Some filesystems have 64K as their optimum I/O
* size, but as that results in impossibly large default cache
* sizes, we limit the default pagesize to 16K.
*/
goto err;
}
if (iopsize < 512)
iopsize = 512;
/*
* Sheer paranoia, but we don't want anything that's
* not a power-of-2, as we rely on that for alignment
* of various types on the pages.
*/
}
/*
* Try and read the first disk sector -- this code assumes
* that the meta-data for all access methods fits in 512
* bytes, and that no database will be smaller than that.
*/
goto err;
if (LF_ISSET(DB_FCNTL_LOCKING))
else
(void)__os_close(fd);
fd = -1;
if (nr != 0) {
"%s: unexpected file format", fname);
goto einval;
}
/*
* The only way we can reach here with the DB_CREATE
* flag set is if we created the file. If that's not
* the case, then a) someone else created the file
* but has not yet written out the meta-data page, or
* b) we truncated the file (DB_TRUNCATE) leaving it
* zero-length. In the case of a), we want to sleep
* and give the file creator some time to write the
* metadata page. In the case of b), charge forward.
* Note, there is a race in the case of two processes
* opening the file with the DB_TRUNCATE flag set at
* roughly the same time, and they could theoretically
* hurt each other, although it's pretty unlikely.
*/
if (retry_cnt++ < 3 &&
__os_sleep(1, 0);
goto open_retry;
}
if (type == DB_UNKNOWN) {
"%s: DBTYPE of unknown with empty file",
fname);
goto einval;
}
goto empty;
}
/*
* A found file overrides some user information. We'll check
* for possible error conditions based on conflicts between
* the file and the user's arguments below.
*/
swapped = 0;
case DB_BTREEMAGIC:
goto einval;
goto err;
"%s: unsupported btree version number %lu",
goto einval;
}
goto err;
} else {
}
/* Copy the file's unique id. */
need_fileid = 0;
break;
case DB_HASHMAGIC:
goto einval;
goto err;
"%s: unsupported hash version number %lu",
goto einval;
}
goto err;
/* Copy the file's unique id. */
need_fileid = 0;
break;
default:
if (swapped) {
goto einval;
}
swapped = 1;
goto retry;
}
} else {
if (type == DB_UNKNOWN) {
"DBTYPE of unknown without existing file");
goto einval;
}
}
empty: /*
* By the time we get here we've either set the type or we're taking
* it from the user.
*/
/*
* Set the page size to the best value for I/O to this file. Don't
* overflow the page offset type. The page size must be db_indx_t
* aligned and >= MIN_PAGE_SIZE.
*
* XXX
* Should we be checking for a page size that's not a multiple of 512?
*/
}
goto einval;
}
/*
* If no mpool supplied by the application, attach to a local,
* created buffer pool.
*
* XXX
* If the user has a DB_ENV structure, we have to use a temporary
* one so that we don't step on their values. If the user doesn't,
* we have to create one, and keep it around until the call to the
* memp_close() function. This is all so the mpool functions get
* the error stuff right.
*/
goto err;
restore = 0;
} else {
restore = 1;
}
/*
* the page size.
*/
else {
cachesize +=
}
goto err;
if (restore)
} else
goto err;
goto err;
/*
* If we don't already have one, get a unique file ID. If the file
* is a temporary file, then we have to create a unique file ID --
* no backing file will be created until the mpool cache is filled
* forcing it to go to disk. The created ID must never match any
* potential real file ID -- we know it won't because real file IDs
* storing a 4-byte locker ID.
*
* XXX
* Store the file id in the locker structure -- we can get it from
* there as necessary, and it saves having two copies.
*/
if (need_fileid)
goto err;
} else
goto err;
/* No further use for the real name. */
/*
* Open a backing file in the memory pool.
*
* If we need to process the file's pages on I/O, set the file type.
* If it's a hash file, always call pgin and pgout routines. This
* means that hash files can never be mapped into process memory. If
* it's a btree file and requires swapping, we need to page the file
* in and out. This has to be right -- we can't mmap files that are
* being paged in and out.
*/
else
/*
* Set up additional memp_fopen information.
*/
finfo.lsn_offset = 0;
goto err;
/*
* XXX
* We need a per-thread mutex that lives in shared memory -- HP-UX
* can't allocate mutexes in malloc'd memory. Allocate it from the
* shared memory region, since it's the only one that is guaranteed
* to exist.
*/
goto err;
/*
* Since we only get here if DB_THREAD was specified, we know
* we have spinlocks and no file offset argument is needed.
*/
}
/* Get a log file id. */
goto err;
/* Call the real open function. */
switch (type) {
case DB_BTREE:
goto err;
goto err;
goto err;
break;
case DB_HASH:
goto err;
goto err;
break;
case DB_RECNO:
#define DB_INFO_FLAGS \
goto err;
goto err;
break;
default:
abort();
}
return (0);
err: /* Close the file descriptor. */
if (fd != -1)
(void)__os_close(fd);
/* Discard the log file id. */
if (dbp->log_fileid != 0)
/* Close the memory pool file. */
/* If the memory pool was local, close it. */
/* If we allocated a DB_ENV, discard it. */
return (ret);
}
/*
* __db_close --
* Close a DB tree.
*
* PUBLIC: int __db_close __P((DB *, u_int32_t));
*/
int
{
/* Validate arguments. */
return (ret);
/* Sync the underlying file. */
/*
* Go through the active cursors and call the cursor recycle routine,
* which resolves pending operations and moves the cursors onto the
* free list. Then, walk the free list and call the cursor destroy
* routine.
*/
/* Call the access specific close function. */
/* Sync the memory pool. */
/* Close the memory pool file. */
/* If the memory pool was local, close it. */
}
/* Discard the log file id. */
/* If we allocated a DB_ENV, discard it. */
/* Free the DB. */
return (ret);
}