Add missing queue header file (bug #1626)
[asterisk/asterisk.git] / db1-ast / 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 1
38
39 #include <sys/types.h>
40 #include <sys/cdefs.h>
41
42 #include <limits.h>
43
44 #ifdef __DBINTERFACE_PRIVATE
45 #include <compat.h>
46 #endif
47
48 #define RET_ERROR       -1              /* Return values. */
49 #define RET_SUCCESS      0
50 #define RET_SPECIAL      1
51
52 #ifndef __BIT_TYPES_DEFINED__
53 #define __BIT_TYPES_DEFINED__
54 #if (!defined(__FreeBSD__) && !defined(__APPLE__))
55 typedef __signed char              int8_t;
56 typedef unsigned char            u_int8_t;
57 typedef short                     int16_t;
58 typedef unsigned short          u_int16_t;
59 typedef int                       int32_t;
60 typedef unsigned int            u_int32_t;
61 #ifdef WE_DONT_NEED_QUADS
62 typedef long long                 int64_t;
63 typedef unsigned long long      u_int64_t;
64 #endif
65 #endif /* __FreeBSD__ */
66 #endif
67
68 #define MAX_PAGE_NUMBER 0xffffffff      /* >= # of pages in a file */
69 typedef u_int32_t       pgno_t;
70 #define MAX_PAGE_OFFSET 65535           /* >= # of bytes in a page */
71 typedef u_int16_t       indx_t;
72 #define MAX_REC_NUMBER  0xffffffff      /* >= # of records in a tree */
73 typedef u_int32_t       recno_t;
74
75 /* Key/data structure -- a Data-Base Thang. */
76 typedef struct {
77         void    *data;                  /* data */
78         size_t   size;                  /* data length */
79 } DBT;
80
81 /* Routine flags. */
82 #define R_CURSOR        1               /* del, put, seq */
83 #define __R_UNUSED      2               /* UNUSED */
84 #define R_FIRST         3               /* seq */
85 #define R_IAFTER        4               /* put (RECNO) */
86 #define R_IBEFORE       5               /* put (RECNO) */
87 #define R_LAST          6               /* seq (BTREE, RECNO) */
88 #define R_NEXT          7               /* seq */
89 #define R_NOOVERWRITE   8               /* put */
90 #define R_PREV          9               /* seq (BTREE, RECNO) */
91 #define R_SETCURSOR     10              /* put (RECNO) */
92 #define R_RECNOSYNC     11              /* sync (RECNO) */
93
94 typedef enum { DB_BTREE, DB_HASH, DB_RECNO } DBTYPE;
95
96 /*
97  * !!!
98  * The following flags are included in the dbopen(3) call as part of the
99  * open(2) flags.  In order to avoid conflicts with the open flags, start
100  * at the top of the 16 or 32-bit number space and work our way down.  If
101  * the open flags were significantly expanded in the future, it could be
102  * a problem.  Wish I'd left another flags word in the dbopen call.
103  *
104  * !!!
105  * None of this stuff is implemented yet.  The only reason that it's here
106  * is so that the access methods can skip copying the key/data pair when
107  * the DB_LOCK flag isn't set.
108  */
109 #if UINT_MAX > 65535
110 #define DB_LOCK         0x20000000      /* Do locking. */
111 #define DB_SHMEM        0x40000000      /* Use shared memory. */
112 #define DB_TXN          0x80000000      /* Do transactions. */
113 #else
114 #define DB_LOCK             0x2000      /* Do locking. */
115 #define DB_SHMEM            0x4000      /* Use shared memory. */
116 #define DB_TXN              0x8000      /* Do transactions. */
117 #endif
118
119 /* Access method description structure. */
120 typedef struct __db {
121         DBTYPE type;                    /* Underlying db type. */
122         int (*close)    __P((struct __db *));
123         int (*del)      __P((const struct __db *, const DBT *, u_int));
124         int (*get)      __P((const struct __db *, const DBT *, DBT *, u_int));
125         int (*put)      __P((const struct __db *, DBT *, const DBT *, u_int));
126         int (*seq)      __P((const struct __db *, DBT *, DBT *, u_int));
127         int (*sync)     __P((const struct __db *, u_int));
128         void *internal;                 /* Access method private. */
129         int (*fd)       __P((const struct __db *));
130 } DB;
131
132 #define BTREEMAGIC      0x053162
133 #define BTREEVERSION    3
134
135 /* Structure used to pass parameters to the btree routines. */
136 typedef struct {
137 #define R_DUP           0x01    /* duplicate keys */
138         u_long  flags;
139         u_int   cachesize;      /* bytes to cache */
140         int     maxkeypage;     /* maximum keys per page */
141         int     minkeypage;     /* minimum keys per page */
142         u_int   psize;          /* page size */
143         int     (*compare)      /* comparison function */
144             __P((const DBT *, const DBT *));
145         size_t  (*prefix)       /* prefix function */
146             __P((const DBT *, const DBT *));
147         int     lorder;         /* byte order */
148 } BTREEINFO;
149
150 #define HASHMAGIC       0x061561
151 #define HASHVERSION     2
152
153 /* Structure used to pass parameters to the hashing routines. */
154 typedef struct {
155         u_int   bsize;          /* bucket size */
156         u_int   ffactor;        /* fill factor */
157         u_int   nelem;          /* number of elements */
158         u_int   cachesize;      /* bytes to cache */
159         u_int32_t               /* hash function */
160                 (*hash) __P((const void *, size_t));
161         int     lorder;         /* byte order */
162 } HASHINFO;
163
164 /* Structure used to pass parameters to the record routines. */
165 typedef struct {
166 #define R_FIXEDLEN      0x01    /* fixed-length records */
167 #define R_NOKEY         0x02    /* key not required */
168 #define R_SNAPSHOT      0x04    /* snapshot the input */
169         u_long  flags;
170         u_int   cachesize;      /* bytes to cache */
171         u_int   psize;          /* page size */
172         int     lorder;         /* byte order */
173         size_t  reclen;         /* record length (fixed-length records) */
174         u_char  bval;           /* delimiting byte (variable-length records */
175         char    *bfname;        /* btree file name */ 
176 } RECNOINFO;
177
178 #ifdef __DBINTERFACE_PRIVATE
179 /*
180  * Little endian <==> big endian 32-bit swap macros.
181  *      M_32_SWAP       swap a memory location
182  *      P_32_SWAP       swap a referenced memory location
183  *      P_32_COPY       swap from one location to another
184  */
185 #define M_32_SWAP(a) {                                                  \
186         u_int32_t _tmp = a;                                             \
187         ((char *)&a)[0] = ((char *)&_tmp)[3];                           \
188         ((char *)&a)[1] = ((char *)&_tmp)[2];                           \
189         ((char *)&a)[2] = ((char *)&_tmp)[1];                           \
190         ((char *)&a)[3] = ((char *)&_tmp)[0];                           \
191 }
192 #define P_32_SWAP(a) {                                                  \
193         u_int32_t _tmp = *(u_int32_t *)a;                               \
194         ((char *)a)[0] = ((char *)&_tmp)[3];                            \
195         ((char *)a)[1] = ((char *)&_tmp)[2];                            \
196         ((char *)a)[2] = ((char *)&_tmp)[1];                            \
197         ((char *)a)[3] = ((char *)&_tmp)[0];                            \
198 }
199 #define P_32_COPY(a, b) {                                               \
200         ((char *)&(b))[0] = ((char *)&(a))[3];                          \
201         ((char *)&(b))[1] = ((char *)&(a))[2];                          \
202         ((char *)&(b))[2] = ((char *)&(a))[1];                          \
203         ((char *)&(b))[3] = ((char *)&(a))[0];                          \
204 }
205
206 /*
207  * Little endian <==> big endian 16-bit swap macros.
208  *      M_16_SWAP       swap a memory location
209  *      P_16_SWAP       swap a referenced memory location
210  *      P_16_COPY       swap from one location to another
211  */
212 #define M_16_SWAP(a) {                                                  \
213         u_int16_t _tmp = a;                                             \
214         ((char *)&a)[0] = ((char *)&_tmp)[1];                           \
215         ((char *)&a)[1] = ((char *)&_tmp)[0];                           \
216 }
217 #define P_16_SWAP(a) {                                                  \
218         u_int16_t _tmp = *(u_int16_t *)a;                               \
219         ((char *)a)[0] = ((char *)&_tmp)[1];                            \
220         ((char *)a)[1] = ((char *)&_tmp)[0];                            \
221 }
222 #define P_16_COPY(a, b) {                                               \
223         ((char *)&(b))[0] = ((char *)&(a))[1];                          \
224         ((char *)&(b))[1] = ((char *)&(a))[0];                          \
225 }
226 #endif
227
228 __BEGIN_DECLS
229 DB *__dbopen __P((const char *, int, int, DBTYPE, const void *));
230 DB *dbopen __P((const char *, int, int, DBTYPE, const void *));
231
232 #ifdef __DBINTERFACE_PRIVATE
233 DB      *__bt_open __P((const char *, int, int, const BTREEINFO *, int));
234 DB      *__hash_open __P((const char *, int, int, const HASHINFO *, int));
235 DB      *__rec_open __P((const char *, int, int, const RECNOINFO *, int));
236 void     __dbpanic __P((DB *dbp));
237 #endif
238 __END_DECLS
239
240 #endif /* db.h */