db/btree/bt_close.c

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