1*d994eebbSguenther /* $OpenBSD: db.h,v 1.12 2015/10/17 21:48:42 guenther Exp $ */ 2df930be7Sderaadt /* $NetBSD: db.h,v 1.13 1994/10/26 00:55:48 cgd Exp $ */ 3df930be7Sderaadt 4df930be7Sderaadt /*- 5df930be7Sderaadt * Copyright (c) 1990, 1993, 1994 6df930be7Sderaadt * The Regents of the University of California. All rights reserved. 7df930be7Sderaadt * 8df930be7Sderaadt * Redistribution and use in source and binary forms, with or without 9df930be7Sderaadt * modification, are permitted provided that the following conditions 10df930be7Sderaadt * are met: 11df930be7Sderaadt * 1. Redistributions of source code must retain the above copyright 12df930be7Sderaadt * notice, this list of conditions and the following disclaimer. 13df930be7Sderaadt * 2. Redistributions in binary form must reproduce the above copyright 14df930be7Sderaadt * notice, this list of conditions and the following disclaimer in the 15df930be7Sderaadt * documentation and/or other materials provided with the distribution. 16e33d3bd3Smillert * 3. Neither the name of the University nor the names of its contributors 17df930be7Sderaadt * may be used to endorse or promote products derived from this software 18df930be7Sderaadt * without specific prior written permission. 19df930be7Sderaadt * 20df930be7Sderaadt * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21df930be7Sderaadt * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22df930be7Sderaadt * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23df930be7Sderaadt * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24df930be7Sderaadt * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25df930be7Sderaadt * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26df930be7Sderaadt * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27df930be7Sderaadt * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28df930be7Sderaadt * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29df930be7Sderaadt * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30df930be7Sderaadt * SUCH DAMAGE. 31df930be7Sderaadt * 32df930be7Sderaadt * @(#)db.h 8.7 (Berkeley) 6/16/94 33df930be7Sderaadt */ 34df930be7Sderaadt 35df930be7Sderaadt #ifndef _DB_H_ 36df930be7Sderaadt #define _DB_H_ 37df930be7Sderaadt 38df930be7Sderaadt #include <sys/types.h> 39df930be7Sderaadt 40df930be7Sderaadt #include <limits.h> 41df930be7Sderaadt 42df930be7Sderaadt #define RET_ERROR -1 /* Return values. */ 43df930be7Sderaadt #define RET_SUCCESS 0 44df930be7Sderaadt #define RET_SPECIAL 1 45df930be7Sderaadt 46df930be7Sderaadt #define MAX_PAGE_NUMBER 0xffffffff /* >= # of pages in a file */ 47df930be7Sderaadt typedef u_int32_t pgno_t; 48df930be7Sderaadt #define MAX_PAGE_OFFSET 65535 /* >= # of bytes in a page */ 49df930be7Sderaadt typedef u_int16_t indx_t; 50df930be7Sderaadt #define MAX_REC_NUMBER 0xffffffff /* >= # of records in a tree */ 51df930be7Sderaadt typedef u_int32_t recno_t; 52df930be7Sderaadt 53df930be7Sderaadt /* Key/data structure -- a Data-Base Thang. */ 54df930be7Sderaadt typedef struct { 55df930be7Sderaadt void *data; /* data */ 56df930be7Sderaadt size_t size; /* data length */ 57df930be7Sderaadt } DBT; 58df930be7Sderaadt 59df930be7Sderaadt /* Routine flags. */ 60df930be7Sderaadt #define R_CURSOR 1 /* del, put, seq */ 61df930be7Sderaadt #define __R_UNUSED 2 /* UNUSED */ 62df930be7Sderaadt #define R_FIRST 3 /* seq */ 63df930be7Sderaadt #define R_IAFTER 4 /* put (RECNO) */ 64df930be7Sderaadt #define R_IBEFORE 5 /* put (RECNO) */ 65df930be7Sderaadt #define R_LAST 6 /* seq (BTREE, RECNO) */ 66df930be7Sderaadt #define R_NEXT 7 /* seq */ 67df930be7Sderaadt #define R_NOOVERWRITE 8 /* put */ 68df930be7Sderaadt #define R_PREV 9 /* seq (BTREE, RECNO) */ 69df930be7Sderaadt #define R_SETCURSOR 10 /* put (RECNO) */ 70df930be7Sderaadt #define R_RECNOSYNC 11 /* sync (RECNO) */ 71df930be7Sderaadt 72df930be7Sderaadt typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE; 73df930be7Sderaadt 74df930be7Sderaadt /* 75df930be7Sderaadt * !!! 76df930be7Sderaadt * The following flags are included in the dbopen(3) call as part of the 77df930be7Sderaadt * open(2) flags. In order to avoid conflicts with the open flags, start 78df930be7Sderaadt * at the top of the 16 or 32-bit number space and work our way down. If 79df930be7Sderaadt * the open flags were significantly expanded in the future, it could be 80df930be7Sderaadt * a problem. Wish I'd left another flags word in the dbopen call. 81df930be7Sderaadt * 82df930be7Sderaadt * !!! 83df930be7Sderaadt * None of this stuff is implemented yet. The only reason that it's here 84df930be7Sderaadt * is so that the access methods can skip copying the key/data pair when 85df930be7Sderaadt * the DB_LOCK flag isn't set. 86df930be7Sderaadt */ 87df930be7Sderaadt #if UINT_MAX > 65535 88df930be7Sderaadt #define DB_LOCK 0x20000000 /* Do locking. */ 89df930be7Sderaadt #define DB_SHMEM 0x40000000 /* Use shared memory. */ 90df930be7Sderaadt #define DB_TXN 0x80000000 /* Do transactions. */ 91df930be7Sderaadt #else 92df930be7Sderaadt #define DB_LOCK 0x2000 /* Do locking. */ 93df930be7Sderaadt #define DB_SHMEM 0x4000 /* Use shared memory. */ 94df930be7Sderaadt #define DB_TXN 0x8000 /* Do transactions. */ 95df930be7Sderaadt #endif 96df930be7Sderaadt 97df930be7Sderaadt /* Access method description structure. */ 98df930be7Sderaadt typedef struct __db { 99df930be7Sderaadt DBTYPE type; /* Underlying db type. */ 100c72b5b24Smillert int (*close)(struct __db *); 101d1f942abSespie int (*del)(const struct __db *, const DBT *, unsigned int); 102d1f942abSespie int (*get)(const struct __db *, const DBT *, DBT *, unsigned int); 103d1f942abSespie int (*put)(const struct __db *, DBT *, const DBT *, unsigned int); 104d1f942abSespie int (*seq)(const struct __db *, DBT *, DBT *, unsigned int); 105d1f942abSespie int (*sync)(const struct __db *, unsigned int); 106df930be7Sderaadt void *internal; /* Access method private. */ 107c72b5b24Smillert int (*fd)(const struct __db *); 108df930be7Sderaadt } DB; 109df930be7Sderaadt 110df930be7Sderaadt #define BTREEMAGIC 0x053162 111df930be7Sderaadt #define BTREEVERSION 3 112df930be7Sderaadt 113df930be7Sderaadt /* Structure used to pass parameters to the btree routines. */ 114df930be7Sderaadt typedef struct { 115df930be7Sderaadt #define R_DUP 0x01 /* duplicate keys */ 116d1f942abSespie unsigned long flags; 117d1f942abSespie unsigned int cachesize; /* bytes to cache */ 118df930be7Sderaadt int maxkeypage; /* maximum keys per page */ 119df930be7Sderaadt int minkeypage; /* minimum keys per page */ 120d1f942abSespie unsigned int psize; /* page size */ 121df930be7Sderaadt int (*compare) /* comparison function */ 122c72b5b24Smillert (const DBT *, const DBT *); 123df930be7Sderaadt size_t (*prefix) /* prefix function */ 124c72b5b24Smillert (const DBT *, const DBT *); 125df930be7Sderaadt int lorder; /* byte order */ 126df930be7Sderaadt } BTREEINFO; 127df930be7Sderaadt 128df930be7Sderaadt #define HASHMAGIC 0x061561 129df930be7Sderaadt #define HASHVERSION 2 130df930be7Sderaadt 131df930be7Sderaadt /* Structure used to pass parameters to the hashing routines. */ 132df930be7Sderaadt typedef struct { 133d1f942abSespie unsigned int bsize; /* bucket size */ 134d1f942abSespie unsigned int ffactor; /* fill factor */ 135d1f942abSespie unsigned int nelem; /* number of elements */ 136d1f942abSespie unsigned int cachesize; /* bytes to cache */ 137df930be7Sderaadt u_int32_t /* hash function */ 138c72b5b24Smillert (*hash)(const void *, size_t); 139df930be7Sderaadt int lorder; /* byte order */ 140df930be7Sderaadt } HASHINFO; 141df930be7Sderaadt 142df930be7Sderaadt /* Structure used to pass parameters to the record routines. */ 143df930be7Sderaadt typedef struct { 144df930be7Sderaadt #define R_FIXEDLEN 0x01 /* fixed-length records */ 145df930be7Sderaadt #define R_NOKEY 0x02 /* key not required */ 146df930be7Sderaadt #define R_SNAPSHOT 0x04 /* snapshot the input */ 147d1f942abSespie unsigned long flags; 148d1f942abSespie unsigned int cachesize; /* bytes to cache */ 149d1f942abSespie unsigned int psize; /* page size */ 150df930be7Sderaadt int lorder; /* byte order */ 151d1f942abSespie size_t reclen; /* record length 152d1f942abSespie (fixed-length records) */ 153d1f942abSespie unsigned char bval; /* delimiting byte 154d1f942abSespie (variable-length records) */ 155df930be7Sderaadt char *bfname; /* btree file name */ 156df930be7Sderaadt } RECNOINFO; 157df930be7Sderaadt 158df930be7Sderaadt __BEGIN_DECLS 159c72b5b24Smillert DB *dbopen(const char *, int, int, DBTYPE, const void *); 160bb64080bSguenther __END_DECLS 161df930be7Sderaadt #endif /* !_DB_H_ */ 162