[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.
 * 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.9 2009/03/04 00:58:04 delphij 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(const char *fname, int flags, int mode, const RECNOINFO *openinfo,
    int dflags)
{
	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(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.
e9ce8d39 A	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
9385eb3d A	33	#if defined(LIBC_SCCS) && !defined(lint)
	34	static char sccsid[] = "@(#)rec_open.c 8.10 (Berkeley) 9/1/94";
	35	#endif /* LIBC_SCCS and not lint */
	36	#include <sys/cdefs.h>
1f2f436a	37	__FBSDID("$FreeBSD: src/lib/libc/db/recno/rec_open.c,v 1.9 2009/03/04 00:58:04 delphij Exp $");
e9ce8d39	38
59e0d9fe	39	#include "namespace.h"
e9ce8d39	40	#include <sys/types.h>
9385eb3d	41	#include <sys/mman.h>
e9ce8d39 A	42	#include <sys/stat.h>
e9ce8d39 A	43
e9ce8d39 A	44	#include <errno.h>
	45	#include <fcntl.h>
	46	#include <limits.h>
	47	#include <stddef.h>
	48	#include <stdio.h>
	49	#include <unistd.h>
59e0d9fe	50	#include "un-namespace.h"
e9ce8d39 A	51
	52	#include <db.h>
	53	#include "recno.h"
	54
	55	DB *
1f2f436a A	56	__rec_open(const char fname, int flags, int mode, const RECNOINFO openinfo,
1f2f436a A	57	int dflags)
e9ce8d39 A	58	{
	59	BTREE *t;
	60	BTREEINFO btopeninfo;
	61	DB *dbp;
	62	PAGE *h;
	63	struct stat sb;
	64	int rfd, sverrno;
	65
	66	/* Open the user's file -- if this fails, we're done. */
59e0d9fe	67	if (fname != NULL && (rfd = _open(fname, flags, mode)) < 0)
e9ce8d39 A	68	return (NULL);
	69
	70	/* Create a btree in memory (backed by disk). */
	71	dbp = NULL;
	72	if (openinfo) {
	73	if (openinfo->flags & ~(R_FIXEDLEN \| R_NOKEY \| R_SNAPSHOT))
	74	goto einval;
	75	btopeninfo.flags = 0;
	76	btopeninfo.cachesize = openinfo->cachesize;
	77	btopeninfo.maxkeypage = 0;
	78	btopeninfo.minkeypage = 0;
	79	btopeninfo.psize = openinfo->psize;
	80	btopeninfo.compare = NULL;
	81	btopeninfo.prefix = NULL;
	82	btopeninfo.lorder = openinfo->lorder;
	83	dbp = __bt_open(openinfo->bfname,
	84	O_RDWR, S_IRUSR \| S_IWUSR, &btopeninfo, dflags);
	85	} else
	86	dbp = __bt_open(NULL, O_RDWR, S_IRUSR \| S_IWUSR, NULL, dflags);
	87	if (dbp == NULL)
	88	goto err;
	89
	90	/*
	91	* Some fields in the tree structure are recno specific. Fill them
	92	* in and make the btree structure look like a recno structure. We
	93	* don't change the bt_ovflsize value, it's close enough and slightly
	94	* bigger.
	95	*/
	96	t = dbp->internal;
	97	if (openinfo) {
	98	if (openinfo->flags & R_FIXEDLEN) {
9385eb3d	99	F_SET(t, R_FIXLEN);
e9ce8d39 A	100	t->bt_reclen = openinfo->reclen;
	101	if (t->bt_reclen == 0)
	102	goto einval;
	103	}
	104	t->bt_bval = openinfo->bval;
	105	} else
	106	t->bt_bval = '\n';
	107
9385eb3d	108	F_SET(t, R_RECNO);
e9ce8d39	109	if (fname == NULL)
9385eb3d	110	F_SET(t, R_EOF \| R_INMEM);
e9ce8d39 A	111	else
e9ce8d39 A	112	t->bt_rfd = rfd;
e9ce8d39 A	113
	114	if (fname != NULL) {
	115	/*
	116	* In 4.4BSD, stat(2) returns true for ISSOCK on pipes.
	117	* Unfortunately, that's not portable, so we use lseek
	118	* and check the errno values.
	119	*/
	120	errno = 0;
	121	if (lseek(rfd, (off_t)0, SEEK_CUR) == -1 && errno == ESPIPE) {
	122	switch (flags & O_ACCMODE) {
	123	case O_RDONLY:
9385eb3d	124	F_SET(t, R_RDONLY);
e9ce8d39 A	125	break;
	126	default:
	127	goto einval;
	128	}
	129	slow: if ((t->bt_rfp = fdopen(rfd, "r")) == NULL)
	130	goto err;
9385eb3d	131	F_SET(t, R_CLOSEFP);
e9ce8d39	132	t->bt_irec =
9385eb3d	133	F_ISSET(t, R_FIXLEN) ? __rec_fpipe : __rec_vpipe;
e9ce8d39 A	134	} else {
	135	switch (flags & O_ACCMODE) {
	136	case O_RDONLY:
9385eb3d	137	F_SET(t, R_RDONLY);
e9ce8d39 A	138	break;
	139	case O_RDWR:
	140	break;
	141	default:
	142	goto einval;
	143	}
	144
59e0d9fe	145	if (_fstat(rfd, &sb))
e9ce8d39 A	146	goto err;
	147	/*
	148	* Kluge -- we'd like to test to see if the file is too
	149	* big to mmap. Since, we don't know what size or type
	150	* off_t's or size_t's are, what the largest unsigned
	151	* integral type is, or what random insanity the local
	152	* C compiler will perpetrate, doing the comparison in
	153	* a portable way is flatly impossible. Hope that mmap
	154	* fails if the file is too large.
	155	*/
	156	if (sb.st_size == 0)
9385eb3d	157	F_SET(t, R_EOF);
e9ce8d39	158	else {
9385eb3d A	159	#ifdef MMAP_NOT_AVAILABLE
	160	/*
	161	* XXX
	162	* Mmap doesn't work correctly on many current
	163	* systems. In particular, it can fail subtly,
	164	* with cache coherency problems. Don't use it
	165	* for now.
	166	*/
e9ce8d39	167	t->bt_msize = sb.st_size;
9385eb3d A	168	if ((t->bt_smap = mmap(NULL, t->bt_msize,
	169	PROT_READ, MAP_PRIVATE, rfd,
	170	(off_t)0)) == MAP_FAILED)
e9ce8d39 A	171	goto slow;
	172	t->bt_cmap = t->bt_smap;
	173	t->bt_emap = t->bt_smap + sb.st_size;
9385eb3d	174	t->bt_irec = F_ISSET(t, R_FIXLEN) ?
e9ce8d39	175	__rec_fmap : __rec_vmap;
9385eb3d A	176	F_SET(t, R_MEMMAPPED);
	177	#else
	178	goto slow;
	179	#endif
e9ce8d39 A	180	}
	181	}
	182	}
	183
	184	/* Use the recno routines. */
	185	dbp->close = __rec_close;
	186	dbp->del = __rec_delete;
	187	dbp->fd = __rec_fd;
	188	dbp->get = __rec_get;
	189	dbp->put = __rec_put;
	190	dbp->seq = __rec_seq;
	191	dbp->sync = __rec_sync;
	192
	193	/* If the root page was created, reset the flags. */
	194	if ((h = mpool_get(t->bt_mp, P_ROOT, 0)) == NULL)
	195	goto err;
	196	if ((h->flags & P_TYPE) == P_BLEAF) {
9385eb3d A	197	F_CLR(h, P_TYPE);
9385eb3d A	198	F_SET(h, P_RLEAF);
e9ce8d39 A	199	mpool_put(t->bt_mp, h, MPOOL_DIRTY);
	200	} else
	201	mpool_put(t->bt_mp, h, 0);
	202
	203	if (openinfo && openinfo->flags & R_SNAPSHOT &&
9385eb3d	204	!F_ISSET(t, R_EOF \| R_INMEM) &&
e9ce8d39	205	t->bt_irec(t, MAX_REC_NUMBER) == RET_ERROR)
1f2f436a	206	goto err;
e9ce8d39 A	207	return (dbp);
	208
	209	einval: errno = EINVAL;
	210	err: sverrno = errno;
	211	if (dbp != NULL)
	212	(void)__bt_close(dbp);
	213	if (fname != NULL)
59e0d9fe	214	(void)_close(rfd);
e9ce8d39 A	215	errno = sverrno;
	216	return (NULL);
	217	}
	218
	219	int
1f2f436a	220	__rec_fd(const DB *dbp)
e9ce8d39 A	221	{
	222	BTREE *t;
	223
	224	t = dbp->internal;
	225
	226	/* Toss any page pinned across calls. */
	227	if (t->bt_pinned != NULL) {
	228	mpool_put(t->bt_mp, t->bt_pinned, 0);
	229	t->bt_pinned = NULL;
	230	}
	231
	232	/* In-memory database can't have a file descriptor. */
9385eb3d	233	if (F_ISSET(t, R_INMEM)) {
e9ce8d39 A	234	errno = ENOENT;
	235	return (-1);
	236	}
	237	return (t->bt_rfd);
	238	}