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