db/btree/bt_close.c

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