include/db.h

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