[apple/libc.git] / db / recno / FreeBSD / rec_open.c

/*-
 * Copyright (c) 1990, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Mike Olson.
 *
 * 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
 *    documentation and/or other materials provided with the distribution.
 * 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.
 */

#if defined(LIBC_SCCS) && !defined(lint)
static char sccsid[] = "@(#)rec_open.c	8.10 (Berkeley) 9/1/94";
#endif /* LIBC_SCCS and not lint */
#include <sys/cdefs.h>
__FBSDID("$FreeBSD: src/lib/libc/db/recno/rec_open.c,v 1.6 2002/03/22 21:52:02 obrien Exp $");

#include "namespace.h"
#include <sys/types.h>
#include <sys/mman.h>
#include <sys/stat.h>

#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <stddef.h>
#include <stdio.h>
#include <unistd.h>
#include "un-namespace.h"

#include <db.h>
#include "recno.h"

DB *
__rec_open(fname, flags, mode, openinfo, dflags)
	const char *fname;
	int flags, mode, dflags;
	const RECNOINFO *openinfo;
{
	BTREE *t;
	BTREEINFO btopeninfo;
	DB *dbp;
	PAGE *h;
	struct stat sb;
	int rfd, sverrno;

	/* Open the user's file -- if this fails, we're done. */
	if (fname != NULL && (rfd = _open(fname, flags, mode)) < 0)
		return (NULL);

	/* Create a btree in memory (backed by disk). */
	dbp = NULL;
	if (openinfo) {
		if (openinfo->flags & ~(R_FIXEDLEN | R_NOKEY | R_SNAPSHOT))
			goto einval;
		btopeninfo.flags = 0;
		btopeninfo.cachesize = openinfo->cachesize;
		btopeninfo.maxkeypage = 0;
		btopeninfo.minkeypage = 0;
		btopeninfo.psize = openinfo->psize;
		btopeninfo.compare = NULL;
		btopeninfo.prefix = NULL;
		btopeninfo.lorder = openinfo->lorder;
		dbp = __bt_open(openinfo->bfname,
		    O_RDWR, S_IRUSR | S_IWUSR, &btopeninfo, dflags);
	} else
		dbp = __bt_open(NULL, O_RDWR, S_IRUSR | S_IWUSR, NULL, dflags);
	if (dbp == NULL)
		goto err;

	/*
	 * Some fields in the tree structure are recno specific.  Fill them
	 * in and make the btree structure look like a recno structure.  We
	 * don't change the bt_ovflsize value, it's close enough and slightly
	 * bigger.
	 */
	t = dbp->internal;
	if (openinfo) {
		if (openinfo->flags & R_FIXEDLEN) {
			F_SET(t, R_FIXLEN);
			t->bt_reclen = openinfo->reclen;
			if (t->bt_reclen == 0)
				goto einval;
		}
		t->bt_bval = openinfo->bval;
	} else
		t->bt_bval = '\n';

	F_SET(t, R_RECNO);
	if (fname == NULL)
		F_SET(t, R_EOF | R_INMEM);
	else
		t->bt_rfd = rfd;

	if (fname != NULL) {
		/*
		 * In 4.4BSD, stat(2) returns true for ISSOCK on pipes.
		 * Unfortunately, that's not portable, so we use lseek
		 * and check the errno values.
		 */
		errno = 0;
		if (lseek(rfd, (off_t)0, SEEK_CUR) == -1 && errno == ESPIPE) {
			switch (flags & O_ACCMODE) {
			case O_RDONLY:
				F_SET(t, R_RDONLY);
				break;
			default:
				goto einval;
			}
slow:			if ((t->bt_rfp = fdopen(rfd, "r")) == NULL)
				goto err;
			F_SET(t, R_CLOSEFP);
			t->bt_irec =
			    F_ISSET(t, R_FIXLEN) ? __rec_fpipe : __rec_vpipe;
		} else {
			switch (flags & O_ACCMODE) {
			case O_RDONLY:
				F_SET(t, R_RDONLY);
				break;
			case O_RDWR:
				break;
			default:
				goto einval;
			}

			if (_fstat(rfd, &sb))
				goto err;
			/*
			 * Kluge -- we'd like to test to see if the file is too
			 * big to mmap.  Since, we don't know what size or type
			 * off_t's or size_t's are, what the largest unsigned
			 * integral type is, or what random insanity the local
			 * C compiler will perpetrate, doing the comparison in
			 * a portable way is flatly impossible.  Hope that mmap
			 * fails if the file is too large.
			 */
			if (sb.st_size == 0)
				F_SET(t, R_EOF);
			else {
#ifdef MMAP_NOT_AVAILABLE
				/*
				 * XXX
				 * Mmap doesn't work correctly on many current
				 * systems.  In particular, it can fail subtly,
				 * with cache coherency problems.  Don't use it
				 * for now.
				 */
				t->bt_msize = sb.st_size;
				if ((t->bt_smap = mmap(NULL, t->bt_msize,
				    PROT_READ, MAP_PRIVATE, rfd,
				    (off_t)0)) == MAP_FAILED)
					goto slow;
				t->bt_cmap = t->bt_smap;
				t->bt_emap = t->bt_smap + sb.st_size;
				t->bt_irec = F_ISSET(t, R_FIXLEN) ?
				    __rec_fmap : __rec_vmap;
				F_SET(t, R_MEMMAPPED);
#else
				goto slow;
#endif
			}
		}
	}

	/* Use the recno routines. */
	dbp->close = __rec_close;
	dbp->del = __rec_delete;
	dbp->fd = __rec_fd;
	dbp->get = __rec_get;
	dbp->put = __rec_put;
	dbp->seq = __rec_seq;
	dbp->sync = __rec_sync;

	/* If the root page was created, reset the flags. */
	if ((h = mpool_get(t->bt_mp, P_ROOT, 0)) == NULL)
		goto err;
	if ((h->flags & P_TYPE) == P_BLEAF) {
		F_CLR(h, P_TYPE);
		F_SET(h, P_RLEAF);
		mpool_put(t->bt_mp, h, MPOOL_DIRTY);
	} else
		mpool_put(t->bt_mp, h, 0);

	if (openinfo && openinfo->flags & R_SNAPSHOT &&
	    !F_ISSET(t, R_EOF | R_INMEM) &&
	    t->bt_irec(t, MAX_REC_NUMBER) == RET_ERROR)
                goto err;
	return (dbp);

einval:	errno = EINVAL;
err:	sverrno = errno;
	if (dbp != NULL)
		(void)__bt_close(dbp);
	if (fname != NULL)
		(void)_close(rfd);
	errno = sverrno;
	return (NULL);
}

int
__rec_fd(dbp)
	const DB *dbp;
{
	BTREE *t;

	t = dbp->internal;

	/* Toss any page pinned across calls. */
	if (t->bt_pinned != NULL) {
		mpool_put(t->bt_mp, t->bt_pinned, 0);
		t->bt_pinned = NULL;
	}

	/* In-memory database can't have a file descriptor. */
	if (F_ISSET(t, R_INMEM)) {
		errno = ENOENT;
		return (-1);
	}
	return (t->bt_rfd);
}
Commit	Line	Data
9385eb3d A	1	/*-
9385eb3d A	2	* Copyright (c) 1990, 1993, 1994
e9ce8d39 A	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	* 3. All advertising materials mentioning features or use of this software
	17	* must display the following acknowledgement:
	18	* This product includes software developed by the University of
	19	* California, Berkeley and its contributors.
	20	* 4. Neither the name of the University nor the names of its contributors
	21	* may be used to endorse or promote products derived from this software
	22	* without specific prior written permission.
	23	*
	24	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	25	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	28	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	29	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	30	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	31	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	32	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	33	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	34	* SUCH DAMAGE.
	35	*/
	36
9385eb3d A	37	#if defined(LIBC_SCCS) && !defined(lint)
	38	static char sccsid[] = "@(#)rec_open.c 8.10 (Berkeley) 9/1/94";
	39	#endif /* LIBC_SCCS and not lint */
	40	#include <sys/cdefs.h>
59e0d9fe	41	__FBSDID("$FreeBSD: src/lib/libc/db/recno/rec_open.c,v 1.6 2002/03/22 21:52:02 obrien Exp $");
e9ce8d39	42
59e0d9fe	43	#include "namespace.h"
e9ce8d39	44	#include <sys/types.h>
9385eb3d	45	#include <sys/mman.h>
e9ce8d39 A	46	#include <sys/stat.h>
e9ce8d39 A	47
e9ce8d39 A	48	#include <errno.h>
	49	#include <fcntl.h>
	50	#include <limits.h>
	51	#include <stddef.h>
	52	#include <stdio.h>
	53	#include <unistd.h>
59e0d9fe	54	#include "un-namespace.h"
e9ce8d39 A	55
	56	#include <db.h>
	57	#include "recno.h"
	58
	59	DB *
	60	__rec_open(fname, flags, mode, openinfo, dflags)
	61	const char *fname;
	62	int flags, mode, dflags;
	63	const RECNOINFO *openinfo;
	64	{
	65	BTREE *t;
	66	BTREEINFO btopeninfo;
	67	DB *dbp;
	68	PAGE *h;
	69	struct stat sb;
	70	int rfd, sverrno;
	71
	72	/* Open the user's file -- if this fails, we're done. */
59e0d9fe	73	if (fname != NULL && (rfd = _open(fname, flags, mode)) < 0)
e9ce8d39 A	74	return (NULL);
	75
	76	/* Create a btree in memory (backed by disk). */
	77	dbp = NULL;
	78	if (openinfo) {
	79	if (openinfo->flags & ~(R_FIXEDLEN \| R_NOKEY \| R_SNAPSHOT))
	80	goto einval;
	81	btopeninfo.flags = 0;
	82	btopeninfo.cachesize = openinfo->cachesize;
	83	btopeninfo.maxkeypage = 0;
	84	btopeninfo.minkeypage = 0;
	85	btopeninfo.psize = openinfo->psize;
	86	btopeninfo.compare = NULL;
	87	btopeninfo.prefix = NULL;
	88	btopeninfo.lorder = openinfo->lorder;
	89	dbp = __bt_open(openinfo->bfname,
	90	O_RDWR, S_IRUSR \| S_IWUSR, &btopeninfo, dflags);
	91	} else
	92	dbp = __bt_open(NULL, O_RDWR, S_IRUSR \| S_IWUSR, NULL, dflags);
	93	if (dbp == NULL)
	94	goto err;
	95
	96	/*
	97	* Some fields in the tree structure are recno specific. Fill them
	98	* in and make the btree structure look like a recno structure. We
	99	* don't change the bt_ovflsize value, it's close enough and slightly
	100	* bigger.
	101	*/
	102	t = dbp->internal;
	103	if (openinfo) {
	104	if (openinfo->flags & R_FIXEDLEN) {
9385eb3d	105	F_SET(t, R_FIXLEN);
e9ce8d39 A	106	t->bt_reclen = openinfo->reclen;
	107	if (t->bt_reclen == 0)
	108	goto einval;
	109	}
	110	t->bt_bval = openinfo->bval;
	111	} else
	112	t->bt_bval = '\n';
	113
9385eb3d	114	F_SET(t, R_RECNO);
e9ce8d39	115	if (fname == NULL)
9385eb3d	116	F_SET(t, R_EOF \| R_INMEM);
e9ce8d39 A	117	else
e9ce8d39 A	118	t->bt_rfd = rfd;
e9ce8d39 A	119
	120	if (fname != NULL) {
	121	/*
	122	* In 4.4BSD, stat(2) returns true for ISSOCK on pipes.
	123	* Unfortunately, that's not portable, so we use lseek
	124	* and check the errno values.
	125	*/
	126	errno = 0;
	127	if (lseek(rfd, (off_t)0, SEEK_CUR) == -1 && errno == ESPIPE) {
	128	switch (flags & O_ACCMODE) {
	129	case O_RDONLY:
9385eb3d	130	F_SET(t, R_RDONLY);
e9ce8d39 A	131	break;
	132	default:
	133	goto einval;
	134	}
	135	slow: if ((t->bt_rfp = fdopen(rfd, "r")) == NULL)
	136	goto err;
9385eb3d	137	F_SET(t, R_CLOSEFP);
e9ce8d39	138	t->bt_irec =
9385eb3d	139	F_ISSET(t, R_FIXLEN) ? __rec_fpipe : __rec_vpipe;
e9ce8d39 A	140	} else {
	141	switch (flags & O_ACCMODE) {
	142	case O_RDONLY:
9385eb3d	143	F_SET(t, R_RDONLY);
e9ce8d39 A	144	break;
	145	case O_RDWR:
	146	break;
	147	default:
	148	goto einval;
	149	}
	150
59e0d9fe	151	if (_fstat(rfd, &sb))
e9ce8d39 A	152	goto err;
	153	/*
	154	* Kluge -- we'd like to test to see if the file is too
	155	* big to mmap. Since, we don't know what size or type
	156	* off_t's or size_t's are, what the largest unsigned
	157	* integral type is, or what random insanity the local
	158	* C compiler will perpetrate, doing the comparison in
	159	* a portable way is flatly impossible. Hope that mmap
	160	* fails if the file is too large.
	161	*/
	162	if (sb.st_size == 0)
9385eb3d	163	F_SET(t, R_EOF);
e9ce8d39	164	else {
9385eb3d A	165	#ifdef MMAP_NOT_AVAILABLE
	166	/*
	167	* XXX
	168	* Mmap doesn't work correctly on many current
	169	* systems. In particular, it can fail subtly,
	170	* with cache coherency problems. Don't use it
	171	* for now.
	172	*/
e9ce8d39	173	t->bt_msize = sb.st_size;
9385eb3d A	174	if ((t->bt_smap = mmap(NULL, t->bt_msize,
	175	PROT_READ, MAP_PRIVATE, rfd,
	176	(off_t)0)) == MAP_FAILED)
e9ce8d39 A	177	goto slow;
	178	t->bt_cmap = t->bt_smap;
	179	t->bt_emap = t->bt_smap + sb.st_size;
9385eb3d	180	t->bt_irec = F_ISSET(t, R_FIXLEN) ?
e9ce8d39	181	__rec_fmap : __rec_vmap;
9385eb3d A	182	F_SET(t, R_MEMMAPPED);
	183	#else
	184	goto slow;
	185	#endif
e9ce8d39 A	186	}
	187	}
	188	}
	189
	190	/* Use the recno routines. */
	191	dbp->close = __rec_close;
	192	dbp->del = __rec_delete;
	193	dbp->fd = __rec_fd;
	194	dbp->get = __rec_get;
	195	dbp->put = __rec_put;
	196	dbp->seq = __rec_seq;
	197	dbp->sync = __rec_sync;
	198
	199	/* If the root page was created, reset the flags. */
	200	if ((h = mpool_get(t->bt_mp, P_ROOT, 0)) == NULL)
	201	goto err;
	202	if ((h->flags & P_TYPE) == P_BLEAF) {
9385eb3d A	203	F_CLR(h, P_TYPE);
9385eb3d A	204	F_SET(h, P_RLEAF);
e9ce8d39 A	205	mpool_put(t->bt_mp, h, MPOOL_DIRTY);
	206	} else
	207	mpool_put(t->bt_mp, h, 0);
	208
	209	if (openinfo && openinfo->flags & R_SNAPSHOT &&
9385eb3d	210	!F_ISSET(t, R_EOF \| R_INMEM) &&
e9ce8d39 A	211	t->bt_irec(t, MAX_REC_NUMBER) == RET_ERROR)
	212	goto err;
	213	return (dbp);
	214
	215	einval: errno = EINVAL;
	216	err: sverrno = errno;
	217	if (dbp != NULL)
	218	(void)__bt_close(dbp);
	219	if (fname != NULL)
59e0d9fe	220	(void)_close(rfd);
e9ce8d39 A	221	errno = sverrno;
	222	return (NULL);
	223	}
	224
	225	int
	226	__rec_fd(dbp)
	227	const DB *dbp;
	228	{
	229	BTREE *t;
	230
	231	t = dbp->internal;
	232
	233	/* Toss any page pinned across calls. */
	234	if (t->bt_pinned != NULL) {
	235	mpool_put(t->bt_mp, t->bt_pinned, 0);
	236	t->bt_pinned = NULL;
	237	}
	238
	239	/* In-memory database can't have a file descriptor. */
9385eb3d	240	if (F_ISSET(t, R_INMEM)) {
e9ce8d39 A	241	errno = ENOENT;
	242	return (-1);
	243	}
	244	return (t->bt_rfd);
	245	}