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