Say where the license can be found.
[kopensolaris-gnu/glibc.git] / db2 / db_185.h
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
9  *      The Regents of the University of California.  All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed by the University of
22  *      California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *      @(#)db_185.h.src        8.3 (Sleepycat) 7/27/97
40  */
41
42 #ifndef _DB_185_H_
43 #define _DB_185_H_
44
45 #include <sys/types.h>
46
47 #include <limits.h>
48
49 /*
50  * XXX
51  * Handle function prototypes and the keyword "const".  This steps on name
52  * space that DB doesn't control, but all of the other solutions are worse.
53  */
54 #undef  __P
55 #if defined(__STDC__) || defined(__cplusplus)
56 #define __P(protos)     protos          /* ANSI C prototypes */
57 #else
58 #define const
59 #define __P(protos)     ()              /* K&R C preprocessor */
60 #endif
61
62 #define RET_ERROR       -1              /* Return values. */
63 #define RET_SUCCESS      0
64 #define RET_SPECIAL      1
65
66 #ifndef __BIT_TYPES_DEFINED__
67 #define __BIT_TYPES_DEFINED__
68
69
70
71
72
73 #endif
74
75 #define MAX_PAGE_NUMBER 0xffffffff      /* >= # of pages in a file */
76 typedef u_int32_t       pgno_t;
77 #define MAX_PAGE_OFFSET 65535           /* >= # of bytes in a page */
78 typedef u_int16_t       indx_t;
79 #define MAX_REC_NUMBER  0xffffffff      /* >= # of records in a tree */
80 typedef u_int32_t       recno_t;
81
82 /* Key/data structure -- a Data-Base Thang. */
83 typedef struct {
84         void    *data;                  /* data */
85         size_t   size;                  /* data length */
86 } DBT;
87
88 /* Routine flags. */
89 #define R_CURSOR        1               /* del, put, seq */
90 #define __R_UNUSED      2               /* UNUSED */
91 #define R_FIRST         3               /* seq */
92 #define R_IAFTER        4               /* put (RECNO) */
93 #define R_IBEFORE       5               /* put (RECNO) */
94 #define R_LAST          6               /* seq (BTREE, RECNO) */
95 #define R_NEXT          7               /* seq */
96 #define R_NOOVERWRITE   8               /* put */
97 #define R_PREV          9               /* seq (BTREE, RECNO) */
98 #define R_SETCURSOR     10              /* put (RECNO) */
99 #define R_RECNOSYNC     11              /* sync (RECNO) */
100
101 typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
102
103 /* Access method description structure. */
104 typedef struct __db {
105         DBTYPE type;                    /* Underlying db type. */
106         int (*close)    __P((struct __db *));
107         int (*del)      __P((const struct __db *, const DBT *, u_int));
108         int (*get)      __P((const struct __db *, const DBT *, DBT *, u_int));
109         int (*put)      __P((const struct __db *, DBT *, const DBT *, u_int));
110         int (*seq)      __P((const struct __db *, DBT *, DBT *, u_int));
111         int (*sync)     __P((const struct __db *, u_int));
112         void *internal;                 /* Access method private. */
113         int (*fd)       __P((const struct __db *));
114 } DB;
115
116 #define BTREEMAGIC      0x053162
117 #define BTREEVERSION    3
118
119 /* Structure used to pass parameters to the btree routines. */
120 typedef struct {
121 #define R_DUP           0x01    /* duplicate keys */
122         u_long  flags;
123         u_int   cachesize;      /* bytes to cache */
124         int     maxkeypage;     /* maximum keys per page */
125         int     minkeypage;     /* minimum keys per page */
126         u_int   psize;          /* page size */
127         int     (*compare)      /* comparison function */
128             __P((const DBT *, const DBT *));
129         size_t  (*prefix)       /* prefix function */
130             __P((const DBT *, const DBT *));
131         int     lorder;         /* byte order */
132 } BTREEINFO;
133
134 #define HASHMAGIC       0x061561
135 #define HASHVERSION     2
136
137 /* Structure used to pass parameters to the hashing routines. */
138 typedef struct {
139         u_int   bsize;          /* bucket size */
140         u_int   ffactor;        /* fill factor */
141         u_int   nelem;          /* number of elements */
142         u_int   cachesize;      /* bytes to cache */
143         u_int32_t               /* hash function */
144                 (*hash) __P((const void *, size_t));
145         int     lorder;         /* byte order */
146 } HASHINFO;
147
148 /* Structure used to pass parameters to the record routines. */
149 typedef struct {
150 #define R_FIXEDLEN      0x01    /* fixed-length records */
151 #define R_NOKEY         0x02    /* key not required */
152 #define R_SNAPSHOT      0x04    /* snapshot the input */
153         u_long  flags;
154         u_int   cachesize;      /* bytes to cache */
155         u_int   psize;          /* page size */
156         int     lorder;         /* byte order */
157         size_t  reclen;         /* record length (fixed-length records) */
158         u_char  bval;           /* delimiting byte (variable-length records */
159         char    *bfname;        /* btree file name */
160 } RECNOINFO;
161
162 #if defined(__cplusplus)
163 extern "C" {
164 #endif
165 DB *__dbopen __P((const char *, int, int, DBTYPE, const void *));
166 DB *dbopen __P((const char *, int, int, DBTYPE, const void *));
167
168 #if defined(__cplusplus)
169 };
170 #endif
171 #endif /* !_DB_185_H_ */