Annotation of src/include/db.h, Revision 1.1
1.1 ! deraadt 1: /* $NetBSD: db.h,v 1.13 1994/10/26 00:55:48 cgd Exp $ */
! 2:
! 3: /*-
! 4: * Copyright (c) 1990, 1993, 1994
! 5: * The Regents of the University of California. All rights reserved.
! 6: *
! 7: * Redistribution and use in source and binary forms, with or without
! 8: * modification, are permitted provided that the following conditions
! 9: * are met:
! 10: * 1. Redistributions of source code must retain the above copyright
! 11: * notice, this list of conditions and the following disclaimer.
! 12: * 2. Redistributions in binary form must reproduce the above copyright
! 13: * notice, this list of conditions and the following disclaimer in the
! 14: * documentation and/or other materials provided with the distribution.
! 15: * 3. All advertising materials mentioning features or use of this software
! 16: * must display the following acknowledgement:
! 17: * This product includes software developed by the University of
! 18: * California, Berkeley and its contributors.
! 19: * 4. Neither the name of the University nor the names of its contributors
! 20: * may be used to endorse or promote products derived from this software
! 21: * without specific prior written permission.
! 22: *
! 23: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
! 24: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
! 25: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
! 26: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
! 27: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
! 28: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
! 29: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
! 30: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
! 31: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
! 32: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
! 33: * SUCH DAMAGE.
! 34: *
! 35: * @(#)db.h 8.7 (Berkeley) 6/16/94
! 36: */
! 37:
! 38: #ifndef _DB_H_
! 39: #define _DB_H_
! 40:
! 41: #include <sys/types.h>
! 42: #include <sys/cdefs.h>
! 43:
! 44: #include <limits.h>
! 45:
! 46: #define RET_ERROR -1 /* Return values. */
! 47: #define RET_SUCCESS 0
! 48: #define RET_SPECIAL 1
! 49:
! 50: #ifndef __BIT_TYPES_DEFINED__
! 51: #define __BIT_TYPES_DEFINED__
! 52: typedef __signed char int8_t;
! 53: typedef unsigned char u_int8_t;
! 54: typedef short int16_t;
! 55: typedef unsigned short u_int16_t;
! 56: typedef int int32_t;
! 57: typedef unsigned int u_int32_t;
! 58: #ifdef WE_DONT_NEED_QUADS
! 59: typedef long long int64_t;
! 60: typedef unsigned long long u_int64_t;
! 61: #endif
! 62: #endif
! 63:
! 64: #define MAX_PAGE_NUMBER 0xffffffff /* >= # of pages in a file */
! 65: typedef u_int32_t pgno_t;
! 66: #define MAX_PAGE_OFFSET 65535 /* >= # of bytes in a page */
! 67: typedef u_int16_t indx_t;
! 68: #define MAX_REC_NUMBER 0xffffffff /* >= # of records in a tree */
! 69: typedef u_int32_t recno_t;
! 70:
! 71: /* Key/data structure -- a Data-Base Thang. */
! 72: typedef struct {
! 73: void *data; /* data */
! 74: size_t size; /* data length */
! 75: } DBT;
! 76:
! 77: /* Routine flags. */
! 78: #define R_CURSOR 1 /* del, put, seq */
! 79: #define __R_UNUSED 2 /* UNUSED */
! 80: #define R_FIRST 3 /* seq */
! 81: #define R_IAFTER 4 /* put (RECNO) */
! 82: #define R_IBEFORE 5 /* put (RECNO) */
! 83: #define R_LAST 6 /* seq (BTREE, RECNO) */
! 84: #define R_NEXT 7 /* seq */
! 85: #define R_NOOVERWRITE 8 /* put */
! 86: #define R_PREV 9 /* seq (BTREE, RECNO) */
! 87: #define R_SETCURSOR 10 /* put (RECNO) */
! 88: #define R_RECNOSYNC 11 /* sync (RECNO) */
! 89:
! 90: typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
! 91:
! 92: /*
! 93: * !!!
! 94: * The following flags are included in the dbopen(3) call as part of the
! 95: * open(2) flags. In order to avoid conflicts with the open flags, start
! 96: * at the top of the 16 or 32-bit number space and work our way down. If
! 97: * the open flags were significantly expanded in the future, it could be
! 98: * a problem. Wish I'd left another flags word in the dbopen call.
! 99: *
! 100: * !!!
! 101: * None of this stuff is implemented yet. The only reason that it's here
! 102: * is so that the access methods can skip copying the key/data pair when
! 103: * the DB_LOCK flag isn't set.
! 104: */
! 105: #if UINT_MAX > 65535
! 106: #define DB_LOCK 0x20000000 /* Do locking. */
! 107: #define DB_SHMEM 0x40000000 /* Use shared memory. */
! 108: #define DB_TXN 0x80000000 /* Do transactions. */
! 109: #else
! 110: #define DB_LOCK 0x2000 /* Do locking. */
! 111: #define DB_SHMEM 0x4000 /* Use shared memory. */
! 112: #define DB_TXN 0x8000 /* Do transactions. */
! 113: #endif
! 114:
! 115: /* Access method description structure. */
! 116: typedef struct __db {
! 117: DBTYPE type; /* Underlying db type. */
! 118: int (*close) __P((struct __db *));
! 119: int (*del) __P((const struct __db *, const DBT *, u_int));
! 120: int (*get) __P((const struct __db *, const DBT *, DBT *, u_int));
! 121: int (*put) __P((const struct __db *, DBT *, const DBT *, u_int));
! 122: int (*seq) __P((const struct __db *, DBT *, DBT *, u_int));
! 123: int (*sync) __P((const struct __db *, u_int));
! 124: void *internal; /* Access method private. */
! 125: int (*fd) __P((const struct __db *));
! 126: } DB;
! 127:
! 128: #define BTREEMAGIC 0x053162
! 129: #define BTREEVERSION 3
! 130:
! 131: /* Structure used to pass parameters to the btree routines. */
! 132: typedef struct {
! 133: #define R_DUP 0x01 /* duplicate keys */
! 134: u_long flags;
! 135: u_int cachesize; /* bytes to cache */
! 136: int maxkeypage; /* maximum keys per page */
! 137: int minkeypage; /* minimum keys per page */
! 138: u_int psize; /* page size */
! 139: int (*compare) /* comparison function */
! 140: __P((const DBT *, const DBT *));
! 141: size_t (*prefix) /* prefix function */
! 142: __P((const DBT *, const DBT *));
! 143: int lorder; /* byte order */
! 144: } BTREEINFO;
! 145:
! 146: #define HASHMAGIC 0x061561
! 147: #define HASHVERSION 2
! 148:
! 149: /* Structure used to pass parameters to the hashing routines. */
! 150: typedef struct {
! 151: u_int bsize; /* bucket size */
! 152: u_int ffactor; /* fill factor */
! 153: u_int nelem; /* number of elements */
! 154: u_int cachesize; /* bytes to cache */
! 155: u_int32_t /* hash function */
! 156: (*hash) __P((const void *, size_t));
! 157: int lorder; /* byte order */
! 158: } HASHINFO;
! 159:
! 160: /* Structure used to pass parameters to the record routines. */
! 161: typedef struct {
! 162: #define R_FIXEDLEN 0x01 /* fixed-length records */
! 163: #define R_NOKEY 0x02 /* key not required */
! 164: #define R_SNAPSHOT 0x04 /* snapshot the input */
! 165: u_long flags;
! 166: u_int cachesize; /* bytes to cache */
! 167: u_int psize; /* page size */
! 168: int lorder; /* byte order */
! 169: size_t reclen; /* record length (fixed-length records) */
! 170: u_char bval; /* delimiting byte (variable-length records */
! 171: char *bfname; /* btree file name */
! 172: } RECNOINFO;
! 173:
! 174: #ifdef __DBINTERFACE_PRIVATE
! 175: /*
! 176: * Little endian <==> big endian 32-bit swap macros.
! 177: * M_32_SWAP swap a memory location
! 178: * P_32_SWAP swap a referenced memory location
! 179: * P_32_COPY swap from one location to another
! 180: */
! 181: #define M_32_SWAP(a) { \
! 182: u_int32_t _tmp = a; \
! 183: ((char *)&a)[0] = ((char *)&_tmp)[3]; \
! 184: ((char *)&a)[1] = ((char *)&_tmp)[2]; \
! 185: ((char *)&a)[2] = ((char *)&_tmp)[1]; \
! 186: ((char *)&a)[3] = ((char *)&_tmp)[0]; \
! 187: }
! 188: #define P_32_SWAP(a) { \
! 189: u_int32_t _tmp = *(u_int32_t *)a; \
! 190: ((char *)a)[0] = ((char *)&_tmp)[3]; \
! 191: ((char *)a)[1] = ((char *)&_tmp)[2]; \
! 192: ((char *)a)[2] = ((char *)&_tmp)[1]; \
! 193: ((char *)a)[3] = ((char *)&_tmp)[0]; \
! 194: }
! 195: #define P_32_COPY(a, b) { \
! 196: ((char *)&(b))[0] = ((char *)&(a))[3]; \
! 197: ((char *)&(b))[1] = ((char *)&(a))[2]; \
! 198: ((char *)&(b))[2] = ((char *)&(a))[1]; \
! 199: ((char *)&(b))[3] = ((char *)&(a))[0]; \
! 200: }
! 201:
! 202: /*
! 203: * Little endian <==> big endian 16-bit swap macros.
! 204: * M_16_SWAP swap a memory location
! 205: * P_16_SWAP swap a referenced memory location
! 206: * P_16_COPY swap from one location to another
! 207: */
! 208: #define M_16_SWAP(a) { \
! 209: u_int16_t _tmp = a; \
! 210: ((char *)&a)[0] = ((char *)&_tmp)[1]; \
! 211: ((char *)&a)[1] = ((char *)&_tmp)[0]; \
! 212: }
! 213: #define P_16_SWAP(a) { \
! 214: u_int16_t _tmp = *(u_int16_t *)a; \
! 215: ((char *)a)[0] = ((char *)&_tmp)[1]; \
! 216: ((char *)a)[1] = ((char *)&_tmp)[0]; \
! 217: }
! 218: #define P_16_COPY(a, b) { \
! 219: ((char *)&(b))[0] = ((char *)&(a))[1]; \
! 220: ((char *)&(b))[1] = ((char *)&(a))[0]; \
! 221: }
! 222: #endif
! 223:
! 224: __BEGIN_DECLS
! 225: DB *dbopen __P((const char *, int, int, DBTYPE, const void *));
! 226:
! 227: #ifdef __DBINTERFACE_PRIVATE
! 228: DB *__bt_open __P((const char *, int, int, const BTREEINFO *, int));
! 229: DB *__hash_open __P((const char *, int, int, const HASHINFO *, int));
! 230: DB *__rec_open __P((const char *, int, int, const RECNOINFO *, int));
! 231: void __dbpanic __P((DB *dbp));
! 232: #endif
! 233: __END_DECLS
! 234: #endif /* !_DB_H_ */
![[BACK]](/icons/back.gif){kind=icon}
Return to db.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / include