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