xref: /freebsd/lib/libc/db/btree/bt_close.c (revision 3a31b7eb32ad60e1e05b2b2e184ff47e4afbb874)
1 /*-
2  * Copyright (c) 1990, 1993, 1994
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  * $FreeBSD$
37  */
38 
39 #if defined(LIBC_SCCS) && !defined(lint)
40 static char sccsid[] = "@(#)bt_close.c	8.7 (Berkeley) 8/17/94";
41 #endif /* LIBC_SCCS and not lint */
42 
43 #include "namespace.h"
44 #include <sys/param.h>
45 
46 #include <errno.h>
47 #include <stdio.h>
48 #include <stdlib.h>
49 #include <string.h>
50 #include <unistd.h>
51 #include "un-namespace.h"
52 
53 #include <db.h>
54 #include "btree.h"
55 
56 static int bt_meta __P((BTREE *));
57 
58 /*
59  * BT_CLOSE -- Close a btree.
60  *
61  * Parameters:
62  *	dbp:	pointer to access method
63  *
64  * Returns:
65  *	RET_ERROR, RET_SUCCESS
66  */
67 int
68 __bt_close(dbp)
69 	DB *dbp;
70 {
71 	BTREE *t;
72 	int fd;
73 
74 	t = dbp->internal;
75 
76 	/* Toss any page pinned across calls. */
77 	if (t->bt_pinned != NULL) {
78 		mpool_put(t->bt_mp, t->bt_pinned, 0);
79 		t->bt_pinned = NULL;
80 	}
81 
82 	/* Sync the tree. */
83 	if (__bt_sync(dbp, 0) == RET_ERROR)
84 		return (RET_ERROR);
85 
86 	/* Close the memory pool. */
87 	if (mpool_close(t->bt_mp) == RET_ERROR)
88 		return (RET_ERROR);
89 
90 	/* Free random memory. */
91 	if (t->bt_cursor.key.data != NULL) {
92 		free(t->bt_cursor.key.data);
93 		t->bt_cursor.key.size = 0;
94 		t->bt_cursor.key.data = NULL;
95 	}
96 	if (t->bt_rkey.data) {
97 		free(t->bt_rkey.data);
98 		t->bt_rkey.size = 0;
99 		t->bt_rkey.data = NULL;
100 	}
101 	if (t->bt_rdata.data) {
102 		free(t->bt_rdata.data);
103 		t->bt_rdata.size = 0;
104 		t->bt_rdata.data = NULL;
105 	}
106 
107 	fd = t->bt_fd;
108 	free(t);
109 	free(dbp);
110 	return (_close(fd) ? RET_ERROR : RET_SUCCESS);
111 }
112 
113 /*
114  * BT_SYNC -- sync the btree to disk.
115  *
116  * Parameters:
117  *	dbp:	pointer to access method
118  *
119  * Returns:
120  *	RET_SUCCESS, RET_ERROR.
121  */
122 int
123 __bt_sync(dbp, flags)
124 	const DB *dbp;
125 	u_int flags;
126 {
127 	BTREE *t;
128 	int status;
129 
130 	t = dbp->internal;
131 
132 	/* Toss any page pinned across calls. */
133 	if (t->bt_pinned != NULL) {
134 		mpool_put(t->bt_mp, t->bt_pinned, 0);
135 		t->bt_pinned = NULL;
136 	}
137 
138 	/* Sync doesn't currently take any flags. */
139 	if (flags != 0) {
140 		errno = EINVAL;
141 		return (RET_ERROR);
142 	}
143 
144 	if (F_ISSET(t, B_INMEM | B_RDONLY) || !F_ISSET(t, B_MODIFIED))
145 		return (RET_SUCCESS);
146 
147 	if (F_ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
148 		return (RET_ERROR);
149 
150 	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
151 		F_CLR(t, B_MODIFIED);
152 
153 	return (status);
154 }
155 
156 /*
157  * BT_META -- write the tree meta data to disk.
158  *
159  * Parameters:
160  *	t:	tree
161  *
162  * Returns:
163  *	RET_ERROR, RET_SUCCESS
164  */
165 static int
166 bt_meta(t)
167 	BTREE *t;
168 {
169 	BTMETA m;
170 	void *p;
171 
172 	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
173 		return (RET_ERROR);
174 
175 	/* Fill in metadata. */
176 	m.magic = BTREEMAGIC;
177 	m.version = BTREEVERSION;
178 	m.psize = t->bt_psize;
179 	m.free = t->bt_free;
180 	m.nrecs = t->bt_nrecs;
181 	m.flags = F_ISSET(t, SAVEMETA);
182 
183 	memmove(p, &m, sizeof(BTMETA));
184 	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
185 	return (RET_SUCCESS);
186 }
187