[apple/libc.git] / db / btree / bt_close.c

/*
 * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*-
 * 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[] = "@(#)bt_close.c	8.7 (Berkeley) 8/17/94";
#endif /* LIBC_SCCS and not lint */
#include <sys/cdefs.h>
#ifndef __APPLE_
#endif

#include <sys/param.h>

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

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

static int bt_meta(BTREE *);

/*
 * BT_CLOSE -- Close a btree.
 *
 * Parameters:
 *	dbp:	pointer to access method
 *
 * Returns:
 *	RET_ERROR, RET_SUCCESS
 */
int
__bt_close(dbp)
	DB *dbp;
{
	BTREE *t;
	int fd;

	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;
	}

	/* Sync the tree. */
	if (__bt_sync(dbp, 0) == RET_ERROR)
		return (RET_ERROR);

	/* Close the memory pool. */
	if (mpool_close(t->bt_mp) == RET_ERROR)
		return (RET_ERROR);

	/* Free random memory. */
	if (t->bt_cursor.key.data != NULL) {
		free(t->bt_cursor.key.data);
		t->bt_cursor.key.size = 0;
		t->bt_cursor.key.data = NULL;
	}
	if (t->bt_rkey.data) {
		free(t->bt_rkey.data);
		t->bt_rkey.size = 0;
		t->bt_rkey.data = NULL;
	}
	if (t->bt_rdata.data) {
		free(t->bt_rdata.data);
		t->bt_rdata.size = 0;
		t->bt_rdata.data = NULL;
	}

	fd = t->bt_fd;
	free(t);
	free(dbp);
	return (close(fd) ? RET_ERROR : RET_SUCCESS);
}

/*
 * BT_SYNC -- sync the btree to disk.
 *
 * Parameters:
 *	dbp:	pointer to access method
 *
 * Returns:
 *	RET_SUCCESS, RET_ERROR.
 */
int
__bt_sync(dbp, flags)
	const DB *dbp;
	u_int flags;
{
	BTREE *t;
	int status;

	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;
	}

	/* Sync doesn't currently take any flags. */
	if (flags != 0) {
		errno = EINVAL;
		return (RET_ERROR);
	}

	if (F_ISSET(t, B_INMEM | B_RDONLY) || !F_ISSET(t, B_MODIFIED))
		return (RET_SUCCESS);

	if (F_ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
		return (RET_ERROR);

	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
		F_CLR(t, B_MODIFIED);

	return (status);
}

/*
 * BT_META -- write the tree meta data to disk.
 *
 * Parameters:
 *	t:	tree
 *
 * Returns:
 *	RET_ERROR, RET_SUCCESS
 */
static int
bt_meta(t)
	BTREE *t;
{
	BTMETA m;
	void *p;

	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
		return (RET_ERROR);

	/* Fill in metadata. */
	m.magic = BTREEMAGIC;
	m.version = BTREEVERSION;
	m.psize = t->bt_psize;
	m.free = t->bt_free;
	m.nrecs = t->bt_nrecs;
	m.flags = F_ISSET(t, SAVEMETA);

	memmove(p, &m, sizeof(BTMETA));
	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
	return (RET_SUCCESS);
}
Commit	Line	Data
e9ce8d39	1	/*
9385eb3d	2	* Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
e9ce8d39 A	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
734aad71	6	* Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
e9ce8d39	7	*
734aad71 A	8	* This file contains Original Code and/or Modifications of Original Code
	9	* as defined in and that are subject to the Apple Public Source License
	10	* Version 2.0 (the 'License'). You may not use this file except in
	11	* compliance with the License. Please obtain a copy of the License at
	12	* http://www.opensource.apple.com/apsl/ and read it before using this
	13	* file.
	14	*
	15	* The Original Code and all software distributed under the License are
	16	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
e9ce8d39 A	17	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
e9ce8d39 A	18	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71 A	19	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	20	* Please see the License for the specific language governing rights and
	21	* limitations under the License.
e9ce8d39 A	22	*
	23	* @APPLE_LICENSE_HEADER_END@
	24	*/
9385eb3d A	25	/*-
9385eb3d A	26	* Copyright (c) 1990, 1993, 1994
e9ce8d39 A	27	* The Regents of the University of California. All rights reserved.
	28	*
	29	* This code is derived from software contributed to Berkeley by
	30	* Mike Olson.
	31	*
	32	* Redistribution and use in source and binary forms, with or without
	33	* modification, are permitted provided that the following conditions
	34	* are met:
	35	* 1. Redistributions of source code must retain the above copyright
	36	* notice, this list of conditions and the following disclaimer.
	37	* 2. Redistributions in binary form must reproduce the above copyright
	38	* notice, this list of conditions and the following disclaimer in the
	39	* documentation and/or other materials provided with the distribution.
	40	* 3. All advertising materials mentioning features or use of this software
	41	* must display the following acknowledgement:
	42	* This product includes software developed by the University of
	43	* California, Berkeley and its contributors.
	44	* 4. Neither the name of the University nor the names of its contributors
	45	* may be used to endorse or promote products derived from this software
	46	* without specific prior written permission.
	47	*
	48	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	49	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	50	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	51	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	52	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	53	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	54	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	55	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	56	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	57	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	58	* SUCH DAMAGE.
	59	*/
	60
9385eb3d A	61	#if defined(LIBC_SCCS) && !defined(lint)
	62	static char sccsid[] = "@(#)bt_close.c 8.7 (Berkeley) 8/17/94";
	63	#endif /* LIBC_SCCS and not lint */
	64	#include <sys/cdefs.h>
	65	#ifndef __APPLE_
	66	#endif
e9ce8d39 A	67
	68	#include <sys/param.h>
	69
	70	#include <errno.h>
	71	#include <stdio.h>
	72	#include <stdlib.h>
	73	#include <string.h>
	74	#include <unistd.h>
	75
	76	#include <db.h>
	77	#include "btree.h"
	78
9385eb3d	79	static int bt_meta(BTREE *);
e9ce8d39 A	80
	81	/*
	82	* BT_CLOSE -- Close a btree.
	83	*
	84	* Parameters:
	85	* dbp: pointer to access method
	86	*
	87	* Returns:
	88	* RET_ERROR, RET_SUCCESS
	89	*/
	90	int
	91	__bt_close(dbp)
	92	DB *dbp;
	93	{
	94	BTREE *t;
	95	int fd;
	96
	97	t = dbp->internal;
	98
	99	/* Toss any page pinned across calls. */
	100	if (t->bt_pinned != NULL) {
	101	mpool_put(t->bt_mp, t->bt_pinned, 0);
	102	t->bt_pinned = NULL;
	103	}
	104
9385eb3d	105	/* Sync the tree. */
e9ce8d39 A	106	if (__bt_sync(dbp, 0) == RET_ERROR)
	107	return (RET_ERROR);
	108
9385eb3d	109	/* Close the memory pool. */
e9ce8d39 A	110	if (mpool_close(t->bt_mp) == RET_ERROR)
	111	return (RET_ERROR);
	112
9385eb3d A	113	/* Free random memory. */
	114	if (t->bt_cursor.key.data != NULL) {
	115	free(t->bt_cursor.key.data);
	116	t->bt_cursor.key.size = 0;
	117	t->bt_cursor.key.data = NULL;
	118	}
	119	if (t->bt_rkey.data) {
	120	free(t->bt_rkey.data);
	121	t->bt_rkey.size = 0;
	122	t->bt_rkey.data = NULL;
	123	}
	124	if (t->bt_rdata.data) {
	125	free(t->bt_rdata.data);
	126	t->bt_rdata.size = 0;
	127	t->bt_rdata.data = NULL;
	128	}
e9ce8d39 A	129
	130	fd = t->bt_fd;
	131	free(t);
	132	free(dbp);
	133	return (close(fd) ? RET_ERROR : RET_SUCCESS);
	134	}
	135
	136	/*
	137	* BT_SYNC -- sync the btree to disk.
	138	*
	139	* Parameters:
	140	* dbp: pointer to access method
	141	*
	142	* Returns:
	143	* RET_SUCCESS, RET_ERROR.
	144	*/
	145	int
	146	__bt_sync(dbp, flags)
	147	const DB *dbp;
	148	u_int flags;
	149	{
	150	BTREE *t;
	151	int status;
e9ce8d39 A	152
	153	t = dbp->internal;
	154
	155	/* Toss any page pinned across calls. */
	156	if (t->bt_pinned != NULL) {
	157	mpool_put(t->bt_mp, t->bt_pinned, 0);
	158	t->bt_pinned = NULL;
	159	}
	160
	161	/* Sync doesn't currently take any flags. */
	162	if (flags != 0) {
	163	errno = EINVAL;
	164	return (RET_ERROR);
	165	}
	166
9385eb3d	167	if (F_ISSET(t, B_INMEM \| B_RDONLY) \|\| !F_ISSET(t, B_MODIFIED))
e9ce8d39 A	168	return (RET_SUCCESS);
e9ce8d39 A	169
9385eb3d	170	if (F_ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
e9ce8d39 A	171	return (RET_ERROR);
e9ce8d39 A	172
e9ce8d39	173	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
9385eb3d A	174	F_CLR(t, B_MODIFIED);
9385eb3d A	175
e9ce8d39 A	176	return (status);
	177	}
	178
	179	/*
	180	* BT_META -- write the tree meta data to disk.
	181	*
	182	* Parameters:
	183	* t: tree
	184	*
	185	* Returns:
	186	* RET_ERROR, RET_SUCCESS
	187	*/
	188	static int
	189	bt_meta(t)
	190	BTREE *t;
	191	{
	192	BTMETA m;
	193	void *p;
	194
	195	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
	196	return (RET_ERROR);
	197
	198	/* Fill in metadata. */
9385eb3d A	199	m.magic = BTREEMAGIC;
	200	m.version = BTREEVERSION;
	201	m.psize = t->bt_psize;
	202	m.free = t->bt_free;
	203	m.nrecs = t->bt_nrecs;
	204	m.flags = F_ISSET(t, SAVEMETA);
e9ce8d39 A	205
	206	memmove(p, &m, sizeof(BTMETA));
	207	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
	208	return (RET_SUCCESS);
	209	}