xref: /freebsd/lib/libc/db/btree/bt_close.c (revision afe61c15161c324a7af299a9b8457aba5afc92db)
1 /*-
2  * Copyright (c) 1990, 1993
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 
37 #if defined(LIBC_SCCS) && !defined(lint)
38 static char sccsid[] = "@(#)bt_close.c	8.3 (Berkeley) 2/21/94";
39 #endif /* LIBC_SCCS and not lint */
40 
41 #include <sys/param.h>
42 
43 #include <errno.h>
44 #include <stdio.h>
45 #include <stdlib.h>
46 #include <string.h>
47 #include <unistd.h>
48 
49 #include <db.h>
50 #include "btree.h"
51 
52 static int bt_meta __P((BTREE *));
53 
54 /*
55  * BT_CLOSE -- Close a btree.
56  *
57  * Parameters:
58  *	dbp:	pointer to access method
59  *
60  * Returns:
61  *	RET_ERROR, RET_SUCCESS
62  */
63 int
64 __bt_close(dbp)
65 	DB *dbp;
66 {
67 	BTREE *t;
68 	int fd;
69 
70 	t = dbp->internal;
71 
72 	/* Toss any page pinned across calls. */
73 	if (t->bt_pinned != NULL) {
74 		mpool_put(t->bt_mp, t->bt_pinned, 0);
75 		t->bt_pinned = NULL;
76 	}
77 
78 	/*
79 	 * Delete any already deleted record that we've been saving
80 	 * because the cursor pointed to it.
81 	 */
82 	if (ISSET(t, B_DELCRSR) && __bt_crsrdel(t, &t->bt_bcursor))
83 		return (RET_ERROR);
84 
85 	if (__bt_sync(dbp, 0) == RET_ERROR)
86 		return (RET_ERROR);
87 
88 	if (mpool_close(t->bt_mp) == RET_ERROR)
89 		return (RET_ERROR);
90 
91 	if (t->bt_stack)
92 		free(t->bt_stack);
93 	if (t->bt_kbuf)
94 		free(t->bt_kbuf);
95 	if (t->bt_dbuf)
96 		free(t->bt_dbuf);
97 
98 	fd = t->bt_fd;
99 	free(t);
100 	free(dbp);
101 	return (close(fd) ? RET_ERROR : RET_SUCCESS);
102 }
103 
104 /*
105  * BT_SYNC -- sync the btree to disk.
106  *
107  * Parameters:
108  *	dbp:	pointer to access method
109  *
110  * Returns:
111  *	RET_SUCCESS, RET_ERROR.
112  */
113 int
114 __bt_sync(dbp, flags)
115 	const DB *dbp;
116 	u_int flags;
117 {
118 	BTREE *t;
119 	int status;
120 	PAGE *h;
121 	void *p;
122 
123 	t = dbp->internal;
124 
125 	/* Toss any page pinned across calls. */
126 	if (t->bt_pinned != NULL) {
127 		mpool_put(t->bt_mp, t->bt_pinned, 0);
128 		t->bt_pinned = NULL;
129 	}
130 
131 	/* Sync doesn't currently take any flags. */
132 	if (flags != 0) {
133 		errno = EINVAL;
134 		return (RET_ERROR);
135 	}
136 
137 	if (ISSET(t, B_INMEM | B_RDONLY) || !ISSET(t, B_MODIFIED))
138 		return (RET_SUCCESS);
139 
140 	if (ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
141 		return (RET_ERROR);
142 
143 	/*
144 	 * Nastiness.  If the cursor has been marked for deletion, but not
145 	 * actually deleted, we have to make a copy of the page, delete the
146 	 * key/data item, sync the file, and then restore the original page
147 	 * contents.
148 	 */
149 	if (ISSET(t, B_DELCRSR)) {
150 		if ((p = (void *)malloc(t->bt_psize)) == NULL)
151 			return (RET_ERROR);
152 		if ((h = mpool_get(t->bt_mp, t->bt_bcursor.pgno, 0)) == NULL)
153 			return (RET_ERROR);
154 		memmove(p, h, t->bt_psize);
155 		if ((status =
156 		    __bt_dleaf(t, h, t->bt_bcursor.index)) == RET_ERROR)
157 			goto ecrsr;
158 		mpool_put(t->bt_mp, h, MPOOL_DIRTY);
159 	}
160 
161 	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
162 		CLR(t, B_MODIFIED);
163 
164 ecrsr:	if (ISSET(t, B_DELCRSR)) {
165 		if ((h = mpool_get(t->bt_mp, t->bt_bcursor.pgno, 0)) == NULL)
166 			return (RET_ERROR);
167 		memmove(h, p, t->bt_psize);
168 		free(p);
169 		mpool_put(t->bt_mp, h, MPOOL_DIRTY);
170 	}
171 	return (status);
172 }
173 
174 /*
175  * BT_META -- write the tree meta data to disk.
176  *
177  * Parameters:
178  *	t:	tree
179  *
180  * Returns:
181  *	RET_ERROR, RET_SUCCESS
182  */
183 static int
184 bt_meta(t)
185 	BTREE *t;
186 {
187 	BTMETA m;
188 	void *p;
189 
190 	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
191 		return (RET_ERROR);
192 
193 	/* Fill in metadata. */
194 	m.m_magic = BTREEMAGIC;
195 	m.m_version = BTREEVERSION;
196 	m.m_psize = t->bt_psize;
197 	m.m_free = t->bt_free;
198 	m.m_nrecs = t->bt_nrecs;
199 	m.m_flags = t->bt_flags & SAVEMETA;
200 
201 	memmove(p, &m, sizeof(BTMETA));
202 	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
203 	return (RET_SUCCESS);
204 }
205