xref: /freebsd/lib/libc/db/btree/bt_close.c (revision c05ac53b8bbbbd998e18c6544011dd90f0f082da)
158f0484fSRodney W. Grimes /*-
2f1e396bcSPaul Traina  * Copyright (c) 1990, 1993, 1994
358f0484fSRodney W. Grimes  *	The Regents of the University of California.  All rights reserved.
458f0484fSRodney W. Grimes  *
558f0484fSRodney W. Grimes  * This code is derived from software contributed to Berkeley by
658f0484fSRodney W. Grimes  * Mike Olson.
758f0484fSRodney W. Grimes  *
858f0484fSRodney W. Grimes  * Redistribution and use in source and binary forms, with or without
958f0484fSRodney W. Grimes  * modification, are permitted provided that the following conditions
1058f0484fSRodney W. Grimes  * are met:
1158f0484fSRodney W. Grimes  * 1. Redistributions of source code must retain the above copyright
1258f0484fSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer.
1358f0484fSRodney W. Grimes  * 2. Redistributions in binary form must reproduce the above copyright
1458f0484fSRodney W. Grimes  *    notice, this list of conditions and the following disclaimer in the
1558f0484fSRodney W. Grimes  *    documentation and/or other materials provided with the distribution.
1658f0484fSRodney W. Grimes  * 3. All advertising materials mentioning features or use of this software
1758f0484fSRodney W. Grimes  *    must display the following acknowledgement:
1858f0484fSRodney W. Grimes  *	This product includes software developed by the University of
1958f0484fSRodney W. Grimes  *	California, Berkeley and its contributors.
2058f0484fSRodney W. Grimes  * 4. Neither the name of the University nor the names of its contributors
2158f0484fSRodney W. Grimes  *    may be used to endorse or promote products derived from this software
2258f0484fSRodney W. Grimes  *    without specific prior written permission.
2358f0484fSRodney W. Grimes  *
2458f0484fSRodney W. Grimes  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2558f0484fSRodney W. Grimes  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2658f0484fSRodney W. Grimes  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2758f0484fSRodney W. Grimes  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2858f0484fSRodney W. Grimes  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2958f0484fSRodney W. Grimes  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3058f0484fSRodney W. Grimes  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3158f0484fSRodney W. Grimes  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3258f0484fSRodney W. Grimes  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3358f0484fSRodney W. Grimes  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3458f0484fSRodney W. Grimes  * SUCH DAMAGE.
3592927338SJason Evans  *
3692927338SJason Evans  * $FreeBSD$
3758f0484fSRodney W. Grimes  */
3858f0484fSRodney W. Grimes 
3958f0484fSRodney W. Grimes #if defined(LIBC_SCCS) && !defined(lint)
40f1e396bcSPaul Traina static char sccsid[] = "@(#)bt_close.c	8.7 (Berkeley) 8/17/94";
4158f0484fSRodney W. Grimes #endif /* LIBC_SCCS and not lint */
4258f0484fSRodney W. Grimes 
43d201fe46SDaniel Eischen #include "namespace.h"
4458f0484fSRodney W. Grimes #include <sys/param.h>
4558f0484fSRodney W. Grimes 
4658f0484fSRodney W. Grimes #include <errno.h>
4758f0484fSRodney W. Grimes #include <stdio.h>
4858f0484fSRodney W. Grimes #include <stdlib.h>
4958f0484fSRodney W. Grimes #include <string.h>
5058f0484fSRodney W. Grimes #include <unistd.h>
51d201fe46SDaniel Eischen #include "un-namespace.h"
5258f0484fSRodney W. Grimes 
5358f0484fSRodney W. Grimes #include <db.h>
5458f0484fSRodney W. Grimes #include "btree.h"
5558f0484fSRodney W. Grimes 
56c05ac53bSDavid E. O'Brien static int bt_meta(BTREE *);
5758f0484fSRodney W. Grimes 
5858f0484fSRodney W. Grimes /*
5958f0484fSRodney W. Grimes  * BT_CLOSE -- Close a btree.
6058f0484fSRodney W. Grimes  *
6158f0484fSRodney W. Grimes  * Parameters:
6258f0484fSRodney W. Grimes  *	dbp:	pointer to access method
6358f0484fSRodney W. Grimes  *
6458f0484fSRodney W. Grimes  * Returns:
6558f0484fSRodney W. Grimes  *	RET_ERROR, RET_SUCCESS
6658f0484fSRodney W. Grimes  */
6758f0484fSRodney W. Grimes int
6858f0484fSRodney W. Grimes __bt_close(dbp)
6958f0484fSRodney W. Grimes 	DB *dbp;
7058f0484fSRodney W. Grimes {
7158f0484fSRodney W. Grimes 	BTREE *t;
7258f0484fSRodney W. Grimes 	int fd;
7358f0484fSRodney W. Grimes 
7458f0484fSRodney W. Grimes 	t = dbp->internal;
7558f0484fSRodney W. Grimes 
7658f0484fSRodney W. Grimes 	/* Toss any page pinned across calls. */
7758f0484fSRodney W. Grimes 	if (t->bt_pinned != NULL) {
7858f0484fSRodney W. Grimes 		mpool_put(t->bt_mp, t->bt_pinned, 0);
7958f0484fSRodney W. Grimes 		t->bt_pinned = NULL;
8058f0484fSRodney W. Grimes 	}
8158f0484fSRodney W. Grimes 
82f1e396bcSPaul Traina 	/* Sync the tree. */
8358f0484fSRodney W. Grimes 	if (__bt_sync(dbp, 0) == RET_ERROR)
8458f0484fSRodney W. Grimes 		return (RET_ERROR);
8558f0484fSRodney W. Grimes 
86f1e396bcSPaul Traina 	/* Close the memory pool. */
8758f0484fSRodney W. Grimes 	if (mpool_close(t->bt_mp) == RET_ERROR)
8858f0484fSRodney W. Grimes 		return (RET_ERROR);
8958f0484fSRodney W. Grimes 
90f1e396bcSPaul Traina 	/* Free random memory. */
91f1e396bcSPaul Traina 	if (t->bt_cursor.key.data != NULL) {
92f1e396bcSPaul Traina 		free(t->bt_cursor.key.data);
93f1e396bcSPaul Traina 		t->bt_cursor.key.size = 0;
94f1e396bcSPaul Traina 		t->bt_cursor.key.data = NULL;
95f1e396bcSPaul Traina 	}
96f1e396bcSPaul Traina 	if (t->bt_rkey.data) {
97f1e396bcSPaul Traina 		free(t->bt_rkey.data);
98f1e396bcSPaul Traina 		t->bt_rkey.size = 0;
99f1e396bcSPaul Traina 		t->bt_rkey.data = NULL;
100f1e396bcSPaul Traina 	}
101f1e396bcSPaul Traina 	if (t->bt_rdata.data) {
102f1e396bcSPaul Traina 		free(t->bt_rdata.data);
103f1e396bcSPaul Traina 		t->bt_rdata.size = 0;
104f1e396bcSPaul Traina 		t->bt_rdata.data = NULL;
105f1e396bcSPaul Traina 	}
10658f0484fSRodney W. Grimes 
10758f0484fSRodney W. Grimes 	fd = t->bt_fd;
10858f0484fSRodney W. Grimes 	free(t);
10958f0484fSRodney W. Grimes 	free(dbp);
1109233c4d9SJason Evans 	return (_close(fd) ? RET_ERROR : RET_SUCCESS);
11158f0484fSRodney W. Grimes }
11258f0484fSRodney W. Grimes 
11358f0484fSRodney W. Grimes /*
11458f0484fSRodney W. Grimes  * BT_SYNC -- sync the btree to disk.
11558f0484fSRodney W. Grimes  *
11658f0484fSRodney W. Grimes  * Parameters:
11758f0484fSRodney W. Grimes  *	dbp:	pointer to access method
11858f0484fSRodney W. Grimes  *
11958f0484fSRodney W. Grimes  * Returns:
12058f0484fSRodney W. Grimes  *	RET_SUCCESS, RET_ERROR.
12158f0484fSRodney W. Grimes  */
12258f0484fSRodney W. Grimes int
12358f0484fSRodney W. Grimes __bt_sync(dbp, flags)
12458f0484fSRodney W. Grimes 	const DB *dbp;
12558f0484fSRodney W. Grimes 	u_int flags;
12658f0484fSRodney W. Grimes {
12758f0484fSRodney W. Grimes 	BTREE *t;
12858f0484fSRodney W. Grimes 	int status;
12958f0484fSRodney W. Grimes 
13058f0484fSRodney W. Grimes 	t = dbp->internal;
13158f0484fSRodney W. Grimes 
13258f0484fSRodney W. Grimes 	/* Toss any page pinned across calls. */
13358f0484fSRodney W. Grimes 	if (t->bt_pinned != NULL) {
13458f0484fSRodney W. Grimes 		mpool_put(t->bt_mp, t->bt_pinned, 0);
13558f0484fSRodney W. Grimes 		t->bt_pinned = NULL;
13658f0484fSRodney W. Grimes 	}
13758f0484fSRodney W. Grimes 
13858f0484fSRodney W. Grimes 	/* Sync doesn't currently take any flags. */
13958f0484fSRodney W. Grimes 	if (flags != 0) {
14058f0484fSRodney W. Grimes 		errno = EINVAL;
14158f0484fSRodney W. Grimes 		return (RET_ERROR);
14258f0484fSRodney W. Grimes 	}
14358f0484fSRodney W. Grimes 
144f1e396bcSPaul Traina 	if (F_ISSET(t, B_INMEM | B_RDONLY) || !F_ISSET(t, B_MODIFIED))
14558f0484fSRodney W. Grimes 		return (RET_SUCCESS);
14658f0484fSRodney W. Grimes 
147f1e396bcSPaul Traina 	if (F_ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
14858f0484fSRodney W. Grimes 		return (RET_ERROR);
14958f0484fSRodney W. Grimes 
15058f0484fSRodney W. Grimes 	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
151f1e396bcSPaul Traina 		F_CLR(t, B_MODIFIED);
15258f0484fSRodney W. Grimes 
15358f0484fSRodney W. Grimes 	return (status);
15458f0484fSRodney W. Grimes }
15558f0484fSRodney W. Grimes 
15658f0484fSRodney W. Grimes /*
15758f0484fSRodney W. Grimes  * BT_META -- write the tree meta data to disk.
15858f0484fSRodney W. Grimes  *
15958f0484fSRodney W. Grimes  * Parameters:
16058f0484fSRodney W. Grimes  *	t:	tree
16158f0484fSRodney W. Grimes  *
16258f0484fSRodney W. Grimes  * Returns:
16358f0484fSRodney W. Grimes  *	RET_ERROR, RET_SUCCESS
16458f0484fSRodney W. Grimes  */
16558f0484fSRodney W. Grimes static int
16658f0484fSRodney W. Grimes bt_meta(t)
16758f0484fSRodney W. Grimes 	BTREE *t;
16858f0484fSRodney W. Grimes {
16958f0484fSRodney W. Grimes 	BTMETA m;
17058f0484fSRodney W. Grimes 	void *p;
17158f0484fSRodney W. Grimes 
17258f0484fSRodney W. Grimes 	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
17358f0484fSRodney W. Grimes 		return (RET_ERROR);
17458f0484fSRodney W. Grimes 
17558f0484fSRodney W. Grimes 	/* Fill in metadata. */
176f1e396bcSPaul Traina 	m.magic = BTREEMAGIC;
177f1e396bcSPaul Traina 	m.version = BTREEVERSION;
178f1e396bcSPaul Traina 	m.psize = t->bt_psize;
179f1e396bcSPaul Traina 	m.free = t->bt_free;
180f1e396bcSPaul Traina 	m.nrecs = t->bt_nrecs;
181f1e396bcSPaul Traina 	m.flags = F_ISSET(t, SAVEMETA);
18258f0484fSRodney W. Grimes 
18358f0484fSRodney W. Grimes 	memmove(p, &m, sizeof(BTMETA));
18458f0484fSRodney W. Grimes 	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
18558f0484fSRodney W. Grimes 	return (RET_SUCCESS);
18658f0484fSRodney W. Grimes }
187