xref: /freebsd/lib/libc/db/btree/bt_close.c (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1990, 1993, 1994
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Mike Olson.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #if defined(LIBC_SCCS) && !defined(lint)
36 static char sccsid[] = "@(#)bt_close.c	8.7 (Berkeley) 8/17/94";
37 #endif /* LIBC_SCCS and not lint */
38 #include "namespace.h"
39 #include <sys/param.h>
40 
41 #include <errno.h>
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <unistd.h>
46 #include "un-namespace.h"
47 
48 #include <db.h>
49 #include "btree.h"
50 
51 static int bt_meta(BTREE *);
52 
53 /*
54  * BT_CLOSE -- Close a btree.
55  *
56  * Parameters:
57  *	dbp:	pointer to access method
58  *
59  * Returns:
60  *	RET_ERROR, RET_SUCCESS
61  */
62 int
63 __bt_close(DB *dbp)
64 {
65 	BTREE *t;
66 	int fd;
67 
68 	t = dbp->internal;
69 
70 	/* Toss any page pinned across calls. */
71 	if (t->bt_pinned != NULL) {
72 		mpool_put(t->bt_mp, t->bt_pinned, 0);
73 		t->bt_pinned = NULL;
74 	}
75 
76 	/* Sync the tree. */
77 	if (__bt_sync(dbp, 0) == RET_ERROR)
78 		return (RET_ERROR);
79 
80 	/* Close the memory pool. */
81 	if (mpool_close(t->bt_mp) == RET_ERROR)
82 		return (RET_ERROR);
83 
84 	/* Free random memory. */
85 	if (t->bt_cursor.key.data != NULL) {
86 		free(t->bt_cursor.key.data);
87 		t->bt_cursor.key.size = 0;
88 		t->bt_cursor.key.data = NULL;
89 	}
90 	if (t->bt_rkey.data) {
91 		free(t->bt_rkey.data);
92 		t->bt_rkey.size = 0;
93 		t->bt_rkey.data = NULL;
94 	}
95 	if (t->bt_rdata.data) {
96 		free(t->bt_rdata.data);
97 		t->bt_rdata.size = 0;
98 		t->bt_rdata.data = NULL;
99 	}
100 
101 	fd = t->bt_fd;
102 	free(t);
103 	free(dbp);
104 	return (_close(fd) ? RET_ERROR : RET_SUCCESS);
105 }
106 
107 /*
108  * BT_SYNC -- sync the btree to disk.
109  *
110  * Parameters:
111  *	dbp:	pointer to access method
112  *
113  * Returns:
114  *	RET_SUCCESS, RET_ERROR.
115  */
116 int
117 __bt_sync(const DB *dbp, u_int flags)
118 {
119 	BTREE *t;
120 	int status;
121 
122 	t = dbp->internal;
123 
124 	/* Toss any page pinned across calls. */
125 	if (t->bt_pinned != NULL) {
126 		mpool_put(t->bt_mp, t->bt_pinned, 0);
127 		t->bt_pinned = NULL;
128 	}
129 
130 	/* Sync doesn't currently take any flags. */
131 	if (flags != 0) {
132 		errno = EINVAL;
133 		return (RET_ERROR);
134 	}
135 
136 	if (F_ISSET(t, B_INMEM | B_RDONLY) ||
137 	    !F_ISSET(t, B_MODIFIED | B_METADIRTY))
138 		return (RET_SUCCESS);
139 
140 	if (F_ISSET(t, B_METADIRTY) && bt_meta(t) == RET_ERROR)
141 		return (RET_ERROR);
142 
143 	if ((status = mpool_sync(t->bt_mp)) == RET_SUCCESS)
144 		F_CLR(t, B_MODIFIED);
145 
146 	return (status);
147 }
148 
149 /*
150  * BT_META -- write the tree meta data to disk.
151  *
152  * Parameters:
153  *	t:	tree
154  *
155  * Returns:
156  *	RET_ERROR, RET_SUCCESS
157  */
158 static int
159 bt_meta(BTREE *t)
160 {
161 	BTMETA m;
162 	void *p;
163 
164 	if ((p = mpool_get(t->bt_mp, P_META, 0)) == NULL)
165 		return (RET_ERROR);
166 
167 	/* Fill in metadata. */
168 	m.magic = BTREEMAGIC;
169 	m.version = BTREEVERSION;
170 	m.psize = t->bt_psize;
171 	m.free = t->bt_free;
172 	m.nrecs = t->bt_nrecs;
173 	m.flags = F_ISSET(t, SAVEMETA);
174 
175 	memmove(p, &m, sizeof(BTMETA));
176 	mpool_put(t->bt_mp, p, MPOOL_DIRTY);
177 	return (RET_SUCCESS);
178 }
179