9ebe73cf6e8cf54101649c96bb4f729d5d638d9d
[kopensolaris-gnu/glibc.git] / db2 / db / db.c
1 /*-
2  * See the file LICENSE for redistribution information.
3  *
4  * Copyright (c) 1996, 1997
5  *      Sleepycat Software.  All rights reserved.
6  */
7 /*
8  * Copyright (c) 1990, 1993, 1994, 1995, 1996
9  *      Keith Bostic.  All rights reserved.
10  */
11 /*
12  * Copyright (c) 1990, 1993, 1994, 1995
13  *      The Regents of the University of California.  All rights reserved.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  * 3. All advertising materials mentioning features or use of this software
24  *    must display the following acknowledgement:
25  *      This product includes software developed by the University of
26  *      California, Berkeley and its contributors.
27  * 4. Neither the name of the University nor the names of its contributors
28  *    may be used to endorse or promote products derived from this software
29  *    without specific prior written permission.
30  *
31  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
32  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
35  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41  * SUCH DAMAGE.
42  */
43
44 #include "config.h"
45
46 #ifndef lint
47 static const char sccsid[] = "@(#)db.c  10.41 (Sleepycat) 9/23/97";
48 #endif /* not lint */
49
50 #ifndef NO_SYSTEM_INCLUDES
51 #include <sys/types.h>
52 #include <sys/stat.h>
53
54 #include <errno.h>
55 #include <fcntl.h>
56 #include <stddef.h>
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <string.h>
60 #include <unistd.h>
61 #endif
62
63 #include "db_int.h"
64 #include "shqueue.h"
65 #include "db_page.h"
66 #include "db_shash.h"
67 #include "db_swap.h"
68 #include "btree.h"
69 #include "hash.h"
70 #include "mp.h"
71 #include "db_am.h"
72 #include "common_ext.h"
73
74 static int db_close __P((DB *, int));
75 static int db_fd __P((DB *, int *));
76
77 /*
78  * If the metadata page has the flag set, set the local flag.  If the page
79  * does NOT have the flag set, return EINVAL if the user's dbinfo argument
80  * caused us to already set the local flag.
81  */
82 #define DBINFO_FCHK(dbp, fn, meta_flags, m_name, dbp_name) {            \
83         if ((meta_flags) & (m_name))                                    \
84                 F_SET(dbp, dbp_name);                                   \
85         else                                                            \
86                 if (F_ISSET(dbp, dbp_name)) {                           \
87                         __db_err(dbenv,                                 \
88             "%s: %s specified in dbinfo argument but not set in file",  \
89                             fname, fn);                                 \
90                         goto einval;                                    \
91                 }                                                       \
92 }
93
94 /*
95  * db_open --
96  *      Main library interface to the DB access methods.
97  */
98 int
99 db_open(fname, type, flags, mode, dbenv, dbinfo, dbpp)
100         const char *fname;
101         DBTYPE type;
102         int flags, mode;
103         DB_ENV *dbenv;
104         DB_INFO *dbinfo;
105         DB **dbpp;
106 {
107         BTMETA *btm;
108         DB *dbp;
109         DBT pgcookie;
110         DB_ENV *envp, t_dbenv;
111         DB_PGINFO pginfo;
112         HASHHDR *hashm;
113         off_t io;
114         size_t cachesize;
115         ssize_t nr;
116         int fd, ftype, need_fileid, restore, ret, retry_cnt, swapped;
117         char *real_name, mbuf[512];
118
119         /* Validate arguments. */
120 #ifdef HAVE_SPINLOCKS
121 #define OKFLAGS (DB_CREATE | DB_NOMMAP | DB_RDONLY | DB_THREAD | DB_TRUNCATE)
122 #else
123 #define OKFLAGS (DB_CREATE | DB_NOMMAP | DB_RDONLY | DB_TRUNCATE)
124 #endif
125         if ((ret = __db_fchk(dbenv, "db_open", flags, OKFLAGS)) != 0)
126                 return (ret);
127
128         /* Initialize for error return. */
129         fd = -1;
130         need_fileid = 1;
131         real_name = NULL;
132
133         /* Allocate the DB structure, reference the DB_ENV structure. */
134         if ((dbp = (DB *)calloc(1, sizeof(DB))) == NULL) {
135                 __db_err(dbenv, "%s", strerror(ENOMEM));
136                 return (ENOMEM);
137         }
138         dbp->dbenv = dbenv;
139
140         /* Convert the db_open(3) flags. */
141         if (LF_ISSET(DB_RDONLY))
142                 F_SET(dbp, DB_AM_RDONLY);
143         if (LF_ISSET(DB_THREAD))
144                 F_SET(dbp, DB_AM_THREAD);
145
146         /* Convert the dbinfo structure flags. */
147         if (dbinfo != NULL) {
148                 /*
149                  * !!!
150                  * We can't check for illegal flags until we know what type
151                  * of open we're doing.
152                  */
153                 if (F_ISSET(dbinfo, DB_DELIMITER))
154                         F_SET(dbp, DB_RE_DELIMITER);
155                 if (F_ISSET(dbinfo, DB_DUP))
156                         F_SET(dbp, DB_AM_DUP);
157                 if (F_ISSET(dbinfo, DB_FIXEDLEN))
158                         F_SET(dbp, DB_RE_FIXEDLEN);
159                 if (F_ISSET(dbinfo, DB_PAD))
160                         F_SET(dbp, DB_RE_PAD);
161                 if (F_ISSET(dbinfo, DB_RECNUM))
162                         F_SET(dbp, DB_BT_RECNUM);
163                 if (F_ISSET(dbinfo, DB_RENUMBER))
164                         F_SET(dbp, DB_RE_RENUMBER);
165                 if (F_ISSET(dbinfo, DB_SNAPSHOT))
166                         F_SET(dbp, DB_RE_SNAPSHOT);
167         }
168
169         /*
170          * Always set the master and initialize the queues, so we can
171          * use these fields without checking the thread bit.
172          */
173         dbp->master = dbp;
174         LIST_INIT(&dbp->handleq);
175         LIST_INSERT_HEAD(&dbp->handleq, dbp, links);
176         TAILQ_INIT(&dbp->curs_queue);
177
178         /*
179          * Set based on the dbenv fields, although no logging or transactions
180          * are possible for temporary files.
181          */
182         if (dbenv != NULL) {
183                 if (dbenv->lk_info != NULL)
184                         F_SET(dbp, DB_AM_LOCKING);
185                 if (fname != NULL && dbenv->lg_info != NULL)
186                         F_SET(dbp, DB_AM_LOGGING);
187         }
188
189         /* Set the common fields. */
190         if (dbinfo == NULL) {
191                 dbp->pgsize = 0;
192                 dbp->db_malloc = NULL;
193         } else {
194                 dbp->pgsize = dbinfo->db_pagesize;
195                 dbp->db_malloc = dbinfo->db_malloc;
196         }
197
198         /* Fill in the default file mode. */
199         if (mode == 0)
200                 mode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP;
201
202         /* Check if the user wants us to swap byte order. */
203         if (dbinfo != NULL)
204                 switch (ret = __db_byteorder(dbenv, dbinfo->db_lorder)) {
205                 case 0:
206                         break;
207                 case DB_SWAPBYTES:
208                         F_SET(dbp, DB_AM_SWAP);
209                         break;
210                 default:
211                         goto err;
212                 }
213
214         /*
215          * If we have a file name, try and read the first page, figure out
216          * what type of file it is, and initialize everything we can based
217          * on that file's meta-data page.
218          *
219          * XXX
220          * We don't actually expect zero-length strings as arguments.  We
221          * do the check, permitting them, because scripting languages, e.g.,
222          * the Tcl test suite, doesn't know anything about passing NULL's.
223          */
224         if (fname != NULL && fname[0] != '\0') {
225                 /* Get the real file name. */
226                 if ((ret = __db_appname(dbenv,
227                      DB_APP_DATA, NULL, fname, NULL, &real_name)) != 0)
228                         goto err;
229
230                 /*
231                  * Open the backing file.  We need to make sure that multiple
232                  * processes attempting to create the file at the same time
233                  * are properly ordered so that only one of them creates the
234                  * "unique" file id, so we open it O_EXCL and O_CREAT so two
235                  * simultaneous attempts to create the region will return
236                  * failure in one of the attempts.  If we're one of the ones
237                  * that fail, we simply retry without the O_CREAT flag, which
238                  * will require that the meta-data page exist.
239                  */
240                 retry_cnt = 0;
241 open_retry:     if (LF_ISSET(DB_CREATE)) {
242                         if ((ret = __db_fdopen(real_name, flags | DB_EXCL,
243                             OKFLAGS | DB_EXCL, mode, &fd)) != 0)
244                                 if (ret == EEXIST) {
245                                         LF_CLR(DB_CREATE);
246                                         goto open_retry;
247                                 } else {
248                                         __db_err(dbenv,
249                                             "%s: %s", fname, strerror(ret));
250                                         goto err;
251                                 }
252                 } else
253                         if ((ret = __db_fdopen(real_name,
254                             flags, OKFLAGS, mode, &fd)) != 0) {
255                                 __db_err(dbenv, "%s: %s", fname, strerror(ret));
256                                 goto err;
257                         }
258
259                 /*
260                  * Use the optimum I/O size as the pagesize if a pagesize not
261                  * specified.  Some filesystems have 64K as their optimum I/O
262                  * size, but as that results in impossibly large default cache
263                  * sizes, we limit the default pagesize to 16K.
264                  */
265                 if (dbp->pgsize == 0) {
266                         if ((ret =
267                             __db_stat(dbenv, real_name, fd, NULL, &io)) != 0)
268                                 goto err;
269                         if (io < 512)
270                                 io = 512;
271                         if (io > 16 * 1024)
272                                 io = 16 * 1024;
273                         dbp->pgsize = io;
274                         F_SET(dbp, DB_AM_PGDEF);
275                 }
276
277                 /*
278                  * Try and read the first disk sector -- this code assumes
279                  * that the meta-data for all access methods fits in 512
280                  * bytes, and that no database will be smaller than that.
281                  */
282                 if ((ret = __db_read(fd, mbuf, sizeof(mbuf), &nr)) != 0)
283                         goto err;
284
285                 /* The fd is no longer needed. */
286                 (void)__db_close(fd);
287                 fd = -1;
288
289                 if (nr != sizeof(mbuf)) {
290                         if (nr != 0) {
291                                 __db_err(dbenv,
292                                     "%s: unexpected file format", fname);
293                                 goto einval;
294                         }
295                         /*
296                          * The only way we can reach here with the DB_CREATE
297                          * flag set is if we created the file.  If that's not
298                          * the case, then a) someone else created the file
299                          * but has not yet written out the meta-data page, or
300                          * b) we truncated the file (DB_TRUNCATE) leaving it
301                          * zero-length.  In the case of a), we want to sleep
302                          * and give the file creator some time to write the
303                          * metadata page.  In the case of b), charge forward.
304                          * Note, there is a race in the case of two processes
305                          * opening the file with the DB_TRUNCATE flag set at
306                          * roughly the same time, and they could theoretically
307                          * hurt each other, although it's pretty unlikely.
308                          */
309                         if (retry_cnt++ < 3 &&
310                             !LF_ISSET(DB_CREATE | DB_TRUNCATE)) {
311                                 __db_sleep(1, 0);
312                                 goto open_retry;
313                         }
314                         if (type == DB_UNKNOWN) {
315                                 __db_err(dbenv,
316                                     "%s: DBTYPE of unknown with empty file",
317                                     fname);
318                                 goto einval;
319                         }
320                         goto empty;
321                 }
322
323                 /*
324                  * A found file overrides some user information.  We'll check
325                  * for possible error conditions based on conflicts between
326                  * the file and the user's arguments below.
327                  */
328                 swapped = 0;
329                 F_CLR(dbp, DB_AM_SWAP);
330
331 retry:          switch (((BTMETA *)mbuf)->magic) {
332                 case DB_BTREEMAGIC:
333                         if (type != DB_BTREE &&
334                             type != DB_RECNO && type != DB_UNKNOWN)
335                                 goto einval;
336
337                         btm = (BTMETA *)mbuf;
338                         if (swapped && (ret = __bam_mswap((PAGE *)btm)) != 0)
339                                 goto err;
340
341                         if (btm->version < DB_BTREEOLDVER ||
342                             btm->version > DB_BTREEVERSION) {
343                                 __db_err(dbenv,
344                                     "%s: unsupported btree version number %lu",
345                                     fname, (u_long)btm->version);
346                                 goto einval;
347                         }
348                         dbp->pgsize = btm->pagesize;
349                         F_CLR(dbp, DB_AM_PGDEF);
350
351                         if ((ret = __db_fchk(dbenv,
352                             "db_open", btm->flags, BTM_MASK)) != 0)
353                                 goto err;
354                         DBINFO_FCHK(dbp, "DB_DUP",
355                             btm->flags, BTM_DUP, DB_AM_DUP);
356                         if (F_ISSET(btm, BTM_RECNO)) {
357                                 DBINFO_FCHK(dbp, "DB_FIXEDLEN",
358                                     btm->flags, BTM_FIXEDLEN, DB_RE_FIXEDLEN);
359                                 DBINFO_FCHK(dbp, "DB_RENUMBER",
360                                     btm->flags, BTM_RENUMBER, DB_RE_RENUMBER);
361                                 type = DB_RECNO;
362                         } else {
363                                 DBINFO_FCHK(dbp, "DB_RECNUM",
364                                     btm->flags, BTM_RECNUM, DB_BT_RECNUM);
365                                 type = DB_BTREE;
366                         }
367
368                         /* Copy the file's unique id. */
369                         need_fileid = 0;
370                         memcpy(dbp->lock.fileid, btm->uid, DB_FILE_ID_LEN);
371                         break;
372                 case DB_HASHMAGIC:
373                         if (type != DB_HASH && type != DB_UNKNOWN)
374                                 goto einval;
375
376                         hashm = (HASHHDR *)mbuf;
377                         if (swapped && (ret = __ham_mswap((PAGE *)hashm)) != 0)
378                                 goto err;
379
380                         if (hashm->version < DB_HASHOLDVER ||
381                             hashm->version > DB_HASHVERSION) {
382                                 __db_err(dbenv,
383                                     "%s: unsupported hash version number %lu",
384                                     fname, hashm->version);
385                                 goto einval;
386                         }
387                         dbp->pgsize = hashm->pagesize;
388                         F_CLR(dbp, DB_AM_PGDEF);
389
390                         if ((ret = __db_fchk(dbenv,
391                             "db_open", hashm->flags, DB_HASH_DUP)) != 0)
392                                 goto err;
393                         DBINFO_FCHK(dbp, "DB_DUP",
394                             hashm->flags, DB_HASH_DUP, DB_AM_DUP);
395                         type = DB_HASH;
396
397                         /* Copy the file's unique id. */
398                         need_fileid = 0;
399                         memcpy(dbp->lock.fileid, hashm->uid, DB_FILE_ID_LEN);
400                         break;
401                 default:
402                         if (swapped) {
403                                 __db_err(dbenv, "unrecognized file type");
404                                 goto einval;
405                         }
406                         M_32_SWAP(((BTMETA *)mbuf)->magic);
407                         F_SET(dbp, DB_AM_SWAP);
408
409                         swapped = 1;
410                         goto retry;
411                 }
412         } else {
413                 fname = real_name = NULL;
414
415                 if (type == DB_UNKNOWN) {
416                         __db_err(dbenv,
417                             "DBTYPE of unknown without existing file");
418                         goto einval;
419                 }
420                 F_SET(dbp, DB_AM_INMEM);
421         }
422
423 empty:  /*
424          * By the time we get here we've either set the type or we're taking
425          * it from the user.
426          */
427         dbp->type = type;
428
429         /*
430          * Set the page size to the best value for I/O to this file.  Don't
431          * overflow the page offset type.  The page size must be db_indx_t
432          * aligned and >= MIN_PAGE_SIZE.
433          *
434          * XXX
435          * Should we be checking for a page size that's not a multiple of 512?
436          */
437         if (dbp->pgsize == 0) {
438                 F_SET(dbp, DB_AM_PGDEF);
439                 dbp->pgsize = 8 * 1024;
440         }
441         if (dbp->pgsize < DB_MIN_PGSIZE ||
442             dbp->pgsize > DB_MAX_PGSIZE ||
443             dbp->pgsize & (sizeof(db_indx_t) - 1)) {
444                 __db_err(dbenv, "illegal page size");
445                 goto einval;
446         }
447
448         /*
449          * Set and/or correct the cache size; must be a multiple of the
450          * page size.
451          */
452         if (dbinfo == NULL || dbinfo->db_cachesize == 0)
453                 cachesize = dbp->pgsize * DB_MINCACHE;
454         else {
455                 cachesize = dbinfo->db_cachesize;
456                 if (cachesize & (dbp->pgsize - 1))
457                         cachesize += (~cachesize & (dbp->pgsize - 1)) + 1;
458                 if (cachesize < dbp->pgsize * DB_MINCACHE)
459                         cachesize = dbp->pgsize * DB_MINCACHE;
460                 if (cachesize < 20 * 1024)
461                         cachesize = 20 * 1024;
462         }
463
464         /*
465          * If no mpool supplied by the application, attach to a local,
466          * created buffer pool.
467          *
468          * XXX
469          * If the user has a DB_ENV structure, we have to use a temporary
470          * one so that we don't step on their values.  If the user doesn't,
471          * we have to create one, and keep it around until the call to the
472          * memp_close() function.  This is all so the mpool functions get
473          * the error stuff right.
474          */
475         if (dbenv == NULL || dbenv->mp_info == NULL) {
476                 F_SET(dbp, DB_AM_MLOCAL);
477
478                 if (dbenv == NULL) {
479                         if ((dbp->mp_dbenv =
480                             (DB_ENV *)calloc(sizeof(DB_ENV), 1)) == NULL) {
481                                 ret = ENOMEM;
482                                 goto err;
483                         }
484
485                         envp = dbp->mp_dbenv;
486                         restore = 0;
487                 } else {
488                         t_dbenv = *dbenv;
489
490                         envp = dbenv;
491                         restore = 1;
492                 }
493                 envp->mp_size = cachesize;
494                 F_SET(envp, DB_MPOOL_PRIVATE);
495                 if ((ret = memp_open(NULL,
496                     DB_CREATE, S_IRUSR | S_IWUSR, envp, &dbp->mp)) != 0)
497                         goto err;
498                 if (restore)
499                         *dbenv = t_dbenv;
500         } else
501                 dbp->mp = dbenv->mp_info;
502
503         /* Register DB's pgin/pgout functions. */
504         if ((ret = memp_register(dbp->mp,
505             DB_FTYPE_BTREE, __bam_pgin, __bam_pgout)) != 0)
506                 goto err;
507         if ((ret = memp_register(dbp->mp,
508             DB_FTYPE_HASH, __ham_pgin, __ham_pgout)) != 0)
509                 goto err;
510
511         /*
512          * If we don't already have one, get a unique file ID.  If the file
513          * is a temporary file, then we have to create a unique file ID --
514          * no backing file will be created until the mpool cache is filled
515          * forcing it to go to disk.  The created ID must never match any
516          * potential real file ID -- we know it won't because real file IDs
517          * contain a time stamp after the dev/ino pair, and we're simply
518          * storing a 4-byte locker ID.
519          *
520          * XXX
521          * Store the file id in the locker structure -- we can get it from
522          * there as necessary, and it saves having two copies.
523          */
524         if (need_fileid)
525                 if (fname == NULL) {
526                         memset(dbp->lock.fileid, 0, DB_FILE_ID_LEN);
527                         if (F_ISSET(dbp, DB_AM_LOCKING) &&
528                             (ret = lock_id(dbenv->lk_info,
529                             (u_int32_t *)dbp->lock.fileid)) != 0)
530                                 goto err;
531                 } else
532                         if ((ret = __db_fileid(dbenv,
533                             real_name, 1, dbp->lock.fileid)) != 0)
534                                 goto err;
535
536         /* No further use for the real name. */
537         if (real_name != NULL)
538                 FREES(real_name);
539         real_name = NULL;
540
541         /*
542          * Open a backing file in the memory pool.
543          *
544          * If we need to process the file's pages on I/O, set the file type.
545          * If it's a hash file, always call pgin and pgout routines.  This
546          * means that hash files can never be mapped into process memory.  If
547          * it's a btree file and requires swapping, we need to page the file
548          * in and out.  This has to be right -- we can't mmap files that are
549          * being paged in and out.
550          */
551         if (type == DB_HASH)
552                 ftype = DB_FTYPE_HASH;
553         else
554                 ftype = F_ISSET(dbp, DB_AM_SWAP) ? DB_FTYPE_BTREE : 0;
555         pginfo.db_pagesize = dbp->pgsize;
556         pginfo.needswap = F_ISSET(dbp, DB_AM_SWAP);
557         pgcookie.data = &pginfo;
558         pgcookie.size = sizeof(DB_PGINFO);
559
560         if ((ret = memp_fopen(dbp->mp, fname, ftype,
561             F_ISSET(dbp, DB_AM_RDONLY) ? DB_RDONLY : 0, 0, dbp->pgsize,
562             0, &pgcookie, dbp->lock.fileid, &dbp->mpf)) != 0)
563                 goto err;
564
565         /*
566          * XXX
567          * Truly spectacular layering violation.  We need a per-thread mutex
568          * that lives in shared memory (thanks, HP-UX!) and so we acquire a
569          * pointer to the mpool one.
570          */
571         if (F_ISSET(dbp, DB_AM_THREAD))
572                 dbp->mutexp = dbp->mpf->mutexp;
573
574         /* Get a log file id. */
575         if (F_ISSET(dbp, DB_AM_LOGGING) &&
576             (ret = log_register(dbenv->lg_info,
577             dbp, fname, type, &dbp->log_fileid)) != 0)
578                 goto err;
579
580         /*
581          * Get a locker id for this DB, and build the lock cookie: the first
582          * db_pgno_t bytes are the page number, the next N bytes are the file
583          * id.
584          */
585         if (F_ISSET(dbp, DB_AM_LOCKING)) {
586                 if ((ret = lock_id(dbenv->lk_info, &dbp->locker)) != 0)
587                         goto err;
588                 dbp->lock_dbt.size = sizeof(dbp->lock);
589                 dbp->lock_dbt.data = &dbp->lock;
590         }
591
592         /* Call the real open function. */
593         switch (type) {
594         case DB_BTREE:
595                 if (dbinfo != NULL && (ret = __db_fchk(dbenv,
596                     "db_open", dbinfo->flags, DB_RECNUM | DB_DUP)) != 0)
597                         goto err;
598                 if (dbinfo != NULL && (ret = __db_fcchk(dbenv,
599                     "db_open", dbinfo->flags, DB_DUP, DB_RECNUM)) != 0)
600                         goto err;
601                 if ((ret = __bam_open(dbp, type, dbinfo)) != 0)
602                         goto err;
603                 break;
604         case DB_HASH:
605                 if (dbinfo != NULL && (ret = __db_fchk(dbenv,
606                     "db_open", dbinfo->flags, DB_DUP)) != 0)
607                         goto err;
608                 if ((ret = __ham_open(dbp, dbinfo)) != 0)
609                         goto err;
610                 break;
611         case DB_RECNO:
612 #define DB_INFO_FLAGS \
613         (DB_DELIMITER | DB_FIXEDLEN | DB_PAD | DB_RENUMBER | DB_SNAPSHOT)
614                 if (dbinfo != NULL && (ret = __db_fchk(dbenv,
615                     "db_open", dbinfo->flags, DB_INFO_FLAGS)) != 0)
616                         goto err;
617                 if ((ret = __ram_open(dbp, type, dbinfo)) != 0)
618                         goto err;
619                 break;
620         default:
621                 abort();
622         }
623
624         /* Call a local close routine. */
625         dbp->close = db_close;
626         dbp->fd = db_fd;
627
628         *dbpp = dbp;
629         return (0);
630
631 einval: ret = EINVAL;
632 err:    /* Close the file descriptor. */
633         if (fd != -1)
634                 (void)__db_close(fd);
635
636         /* Discard the log file id. */
637         if (dbp->log_fileid != 0)
638                 (void)log_unregister(dbenv->lg_info, dbp->log_fileid);
639
640         /* Close the memory pool file. */
641         if (dbp->mpf != NULL)
642                 (void)memp_fclose(dbp->mpf);
643
644         /* If the memory pool was local, close it. */
645         if (F_ISSET(dbp, DB_AM_MLOCAL) && dbp->mp != NULL)
646                 (void)memp_close(dbp->mp);
647
648         /* If we allocated a DB_ENV, discard it. */
649         if (dbp->mp_dbenv != NULL)
650                 FREE(dbp->mp_dbenv, sizeof(DB_ENV));
651
652         if (real_name != NULL)
653                 FREES(real_name);
654         if (dbp != NULL)
655                 FREE(dbp, sizeof(DB));
656
657         return (ret);
658 }
659
660 /*
661  * db_close --
662  *      Close a DB tree.
663  */
664 static int
665 db_close(dbp, flags)
666         DB *dbp;
667         int flags;
668 {
669         DBC *dbc;
670         DB *tdbp;
671         int ret, t_ret;
672
673         /* Validate arguments. */
674         if ((ret = __db_fchk(dbp->dbenv, "db_close", flags, DB_NOSYNC)) != 0)
675                 return (ret);
676
677         /* Sync the underlying file. */
678         if (!LF_ISSET(DB_NOSYNC) &&
679             (t_ret = dbp->sync(dbp, 0)) != 0 && ret == 0)
680                 ret = t_ret;
681
682         /*
683          * Call the underlying access method close routine for all the
684          * cursors and handles.
685          */
686         for (tdbp = LIST_FIRST(&dbp->handleq);
687             tdbp != NULL; tdbp = LIST_NEXT(tdbp, links)) {
688                 while ((dbc = TAILQ_FIRST(&tdbp->curs_queue)) != NULL)
689                         switch (tdbp->type) {
690                         case DB_BTREE:
691                                 if ((t_ret =
692                                     __bam_c_iclose(tdbp, dbc)) != 0 && ret == 0)
693                                         ret = t_ret;
694                                 break;
695                         case DB_HASH:
696                                 if ((t_ret =
697                                     __ham_c_iclose(tdbp, dbc)) != 0 && ret == 0)
698                                         ret = t_ret;
699                                 break;
700                         case DB_RECNO:
701                                 if ((t_ret =
702                                     __ram_c_iclose(tdbp, dbc)) != 0 && ret == 0)
703                                         ret = t_ret;
704                                 break;
705                         default:
706                                 abort();
707                         }
708
709                 switch (tdbp->type) {
710                 case DB_BTREE:
711                         if ((t_ret = __bam_close(tdbp)) != 0 && ret == 0)
712                                 ret = t_ret;
713                         break;
714                 case DB_HASH:
715                         if ((t_ret = __ham_close(tdbp)) != 0 && ret == 0)
716                                 ret = t_ret;
717                         break;
718                 case DB_RECNO:
719                         if ((t_ret = __ram_close(tdbp)) != 0 && ret == 0)
720                                 ret = t_ret;
721                         break;
722                 default:
723                         abort();
724                 }
725         }
726
727         /* Sync the memory pool. */
728         if ((t_ret = memp_fsync(dbp->mpf)) != 0 && ret == 0)
729                 ret = t_ret;
730
731         /* Close the memory pool file. */
732         if ((t_ret = memp_fclose(dbp->mpf)) != 0 && ret == 0)
733                 ret = t_ret;
734
735         /* If the memory pool was local, close it. */
736         if (F_ISSET(dbp, DB_AM_MLOCAL) &&
737             (t_ret = memp_close(dbp->mp)) != 0 && ret == 0)
738                 ret = t_ret;
739
740         /* Discard the log file id. */
741         if (F_ISSET(dbp, DB_AM_LOGGING))
742                 (void)log_unregister(dbp->dbenv->lg_info, dbp->log_fileid);
743
744         /* Discard the lock cookie for all handles. */
745         for (tdbp = LIST_FIRST(&dbp->handleq);
746             tdbp != NULL; tdbp = LIST_NEXT(tdbp, links))
747                 if (F_ISSET(tdbp, DB_AM_LOCKING)) {
748 #ifdef DEBUG
749                         DB_LOCKREQ request;
750
751                         /*
752                          * If we're running tests, display any locks currently
753                          * held.  It's possible that some applications may hold
754                          * locks for long periods, e.g., conference room locks,
755                          * but the DB tests should never close holding locks.
756                          */
757                         request.op = DB_LOCK_DUMP;
758                         if ((t_ret = lock_vec(tdbp->dbenv->lk_info,
759                             tdbp->locker, 0, &request, 1, NULL)) != 0 &&
760                             ret == 0)
761                                 ret = EAGAIN;
762 #endif
763                 }
764
765         /* If we allocated a DB_ENV, discard it. */
766         if (dbp->mp_dbenv != NULL)
767                 FREE(dbp->mp_dbenv, sizeof(DB_ENV));
768
769         /* Free all of the DB's. */
770         LIST_REMOVE(dbp, links);
771         while ((tdbp = LIST_FIRST(&dbp->handleq)) != NULL) {
772                 LIST_REMOVE(tdbp, links);
773                 FREE(tdbp, sizeof(*tdbp));
774         }
775         FREE(dbp, sizeof(*dbp));
776
777         return (ret);
778 }
779
780 /*
781  * db_fd --
782  *      Return a file descriptor for flock'ing.
783  */
784 static int
785 db_fd(dbp, fdp)
786         DB *dbp;
787         int *fdp;
788 {
789         /* In-memory database can't have a file descriptor. */
790         if (F_ISSET(dbp, DB_AM_INMEM))
791                 return (ENOENT);
792
793         /*
794          * XXX
795          * Truly spectacular layering violation.  As we don't open the
796          * underlying file until we need it, it may not be initialized.
797          */
798         if ((*fdp = dbp->mpf->fd) == -1)
799                 return (ENOENT);
800         return (0);
801 }
802
803 /*
804  * __db_pgerr --
805  *      Error when unable to retrieve a specified page.
806  *
807  * PUBLIC: int __db_pgerr __P((DB *, db_pgno_t));
808  */
809 int
810 __db_pgerr(dbp, pgno)
811         DB *dbp;
812         db_pgno_t pgno;
813 {
814         __db_err(dbp->dbenv,
815             "unable to create/retrieve page %lu", (u_long)pgno);
816         return (__db_panic(dbp));
817 }
818
819 /*
820  * __db_pgfmt --
821  *      Error when a page has the wrong format.
822  *
823  * PUBLIC: int __db_pgfmt __P((DB *, db_pgno_t));
824  */
825 int
826 __db_pgfmt(dbp, pgno)
827         DB *dbp;
828         db_pgno_t pgno;
829 {
830         __db_err(dbp->dbenv,
831             "page %lu: illegal page type or format", (u_long)pgno);
832         return (__db_panic(dbp));
833 }