xref: /freebsd/lib/libc/db/btree/bt_close.c (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
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. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #if defined(LIBC_SCCS) && !defined(lint)
34 static char sccsid[] = "@(#)bt_close.c	8.7 (Berkeley) 8/17/94";
35 #endif /* LIBC_SCCS and not lint */
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38 
39 #include "namespace.h"
40 #include <sys/param.h>
41 
42 #include <errno.h>
43 #include <stdio.h>
44 #include <stdlib.h>
45 #include <string.h>
46 #include <unistd.h>
47 #include "un-namespace.h"
48 
49 #include <db.h>
50 #include "btree.h"
51 
52 static int bt_meta(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(DB *dbp)
65 {
66 	BTREE *t;
67 	int fd;
68 
69 	t = dbp->internal;
70 
71 	/* Toss any page pinned across calls. */
72 	if (t->bt_pinned != NULL) {
73 		mpool_put(t->bt_mp, t->bt_pinned, 0);
74 		t->bt_pinned = NULL;
75 	}
76 
77 	/* Sync the tree. */
78 	if (__bt_sync(dbp, 0) == RET_ERROR)
79 		return (RET_ERROR);
80 
81 	/* Close the memory pool. */
82 	if (mpool_close(t->bt_mp) == RET_ERROR)
83 		return (RET_ERROR);
84 
85 	/* Free random memory. */
86 	if (t->bt_cursor.key.data != NULL) {
87 		free(t->bt_cursor.key.data);
88 		t->bt_cursor.key.size = 0;
89 		t->bt_cursor.key.data = NULL;
90 	}
91 	if (t->bt_rkey.data) {
92 		free(t->bt_rkey.data);
93 		t->bt_rkey.size = 0;
94 		t->bt_rkey.data = NULL;
95 	}
96 	if (t->bt_rdata.data) {
97 		free(t->bt_rdata.data);
98 		t->bt_rdata.size = 0;
99 		t->bt_rdata.data = NULL;
100 	}
101 
102 	fd = t->bt_fd;
103 	free(t);
104 	free(dbp);
105 	return (_close(fd) ? RET_ERROR : RET_SUCCESS);
106 }
107 
108 /*
109  * BT_SYNC -- sync the btree to disk.
110  *
111  * Parameters:
112  *	dbp:	pointer to access method
113  *
114  * Returns:
115  *	RET_SUCCESS, RET_ERROR.
116  */
117 int
118 __bt_sync(const DB *dbp, u_int flags)
119 {
120 	BTREE *t;
121 	int status;
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 (F_ISSET(t, B_INMEM | B_RDONLY) ||
138 	    !F_ISSET(t, B_MODIFIED | B_METADIRTY))
139 		return (RET_SUCCESS);
140 
141 	if (F_ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
142 		return (RET_ERROR);
143 
144 	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
145 		F_CLR(t, B_MODIFIED);
146 
147 	return (status);
148 }
149 
150 /*
151  * BT_META -- write the tree meta data to disk.
152  *
153  * Parameters:
154  *	t:	tree
155  *
156  * Returns:
157  *	RET_ERROR, RET_SUCCESS
158  */
159 static int
160 bt_meta(BTREE *t)
161 {
162 	BTMETA m;
163 	void *p;
164 
165 	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
166 		return (RET_ERROR);
167 
168 	/* Fill in metadata. */
169 	m.magic = BTREEMAGIC;
170 	m.version = BTREEVERSION;
171 	m.psize = t->bt_psize;
172 	m.free = t->bt_free;
173 	m.nrecs = t->bt_nrecs;
174 	m.flags = F_ISSET(t, SAVEMETA);
175 
176 	memmove(p, &m, sizeof(BTMETA));
177 	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
178 	return (RET_SUCCESS);
179 }
180