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