This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Assume we have C89 memset()
[perl5.git] / ext / SDBM_File / sdbm.h
1 /*
2  * sdbm - ndbm work-alike hashed database library
3  * based on Per-Ake Larson's Dynamic Hashing algorithms. BIT 18 (1978).
4  * author: oz@nexus.yorku.ca
5  * status: public domain. 
6  */
7 #define DBLKSIZ 4096
8 #define PBLKSIZ 1024
9 #define PAIRMAX 1008                    /* arbitrary on PBLKSIZ-N */
10 #define SPLTMAX 10                      /* maximum allowed splits */
11                                         /* for a single insertion */
12 #ifdef VMS
13 #define DIRFEXT ".sdbm_dir"
14 #else
15 #define DIRFEXT ".dir"
16 #endif
17 #define PAGFEXT ".pag"
18
19 typedef struct {
20         int dirf;                      /* directory file descriptor */
21         int pagf;                      /* page file descriptor */
22         int flags;                     /* status/error flags, see below */
23         long maxbno;                   /* size of dirfile in bits */
24         long curbit;                   /* current bit number */
25         long hmask;                    /* current hash mask */
26         long blkptr;                   /* current block for nextkey */
27         int keyptr;                    /* current key for nextkey */
28         long blkno;                    /* current page to read/write */
29         long pagbno;                   /* current page in pagbuf */
30         char pagbuf[PBLKSIZ];          /* page file block buffer */
31         long dirbno;                   /* current block in dirbuf */
32         char dirbuf[DBLKSIZ];          /* directory file block buffer */
33 } DBM;
34
35 #define DBM_RDONLY      0x1            /* data base open read-only */
36 #define DBM_IOERR       0x2            /* data base I/O error */
37
38 /*
39  * utility macros
40  */
41 #define sdbm_rdonly(db)         ((db)->flags & DBM_RDONLY)
42 #define sdbm_error(db)          ((db)->flags & DBM_IOERR)
43
44 #define sdbm_clearerr(db)       ((db)->flags &= ~DBM_IOERR)  /* ouch */
45
46 #define sdbm_dirfno(db) ((db)->dirf)
47 #define sdbm_pagfno(db) ((db)->pagf)
48
49 typedef struct {
50         const char *dptr;
51         int dsize;
52 } datum;
53
54 extern const datum nullitem;
55
56 #if defined(__STDC__) || defined(__cplusplus) || defined(CAN_PROTOTYPE)
57 #define proto(p) p
58 #else
59 #define proto(p) ()
60 #endif
61
62 /*
63  * flags to sdbm_store
64  */
65 #define DBM_INSERT      0
66 #define DBM_REPLACE     1
67
68 /*
69  * ndbm interface
70  */
71 extern DBM *sdbm_open proto((char *, int, int));
72 extern void sdbm_close proto((DBM *));
73 extern datum sdbm_fetch proto((DBM *, datum));
74 extern int sdbm_delete proto((DBM *, datum));
75 extern int sdbm_store proto((DBM *, datum, datum, int));
76 extern datum sdbm_firstkey proto((DBM *));
77 extern datum sdbm_nextkey proto((DBM *));
78 extern int sdbm_exists proto((DBM *, datum));
79
80 /*
81  * other
82  */
83 extern DBM *sdbm_prep proto((char *, char *, int, int));
84 extern long sdbm_hash proto((const char *, int));
85
86 #ifndef SDBM_ONLY
87 #define dbm_open sdbm_open
88 #define dbm_close sdbm_close
89 #define dbm_fetch sdbm_fetch
90 #define dbm_store sdbm_store
91 #define dbm_delete sdbm_delete
92 #define dbm_firstkey sdbm_firstkey
93 #define dbm_nextkey sdbm_nextkey
94 #define dbm_error sdbm_error
95 #define dbm_clearerr sdbm_clearerr
96 #endif
97
98 /* Most of the following is stolen from perl.h.  We don't include
99    perl.h here because we just want the portability parts of perl.h,
100    not everything else.
101 */
102 #ifndef H_PERL  /* Include guard */
103 #include "embed.h"  /* Follow all the global renamings. */
104
105 /*
106  * The following contortions are brought to you on behalf of all the
107  * standards, semi-standards, de facto standards, not-so-de-facto standards
108  * of the world, as well as all the other botches anyone ever thought of.
109  * The basic theory is that if we work hard enough here, the rest of the
110  * code can be a lot prettier.  Well, so much for theory.  Sorry, Henry...
111  */
112
113 #include <errno.h>
114 #ifdef HAS_SOCKET
115 #   ifdef I_NET_ERRNO
116 #     include <net/errno.h>
117 #   endif
118 #endif
119
120 #if defined(__STDC__) || defined(_AIX) || defined(__stdc__) || defined(__cplusplus)
121 # define STANDARD_C 1
122 #endif
123
124 #include <stdio.h>
125 #include <ctype.h>
126 #include <setjmp.h>
127
128 #if defined(I_UNISTD)
129 #include <unistd.h>
130 #endif
131
132 #ifdef VMS
133 #  include <file.h>
134 #  include <unixio.h>
135 #endif
136
137 #ifdef I_SYS_PARAM
138 #   if !defined(MSDOS) && !defined(WIN32) && !defined(VMS)
139 #       ifdef PARAM_NEEDS_TYPES
140 #           include <sys/types.h>
141 #       endif
142 #       include <sys/param.h>
143 #   endif
144 #endif
145
146 #ifndef _TYPES_         /* If types.h defines this it's easy. */
147 #   ifndef major                /* Does everyone's types.h define this? */
148 #       include <sys/types.h>
149 #   endif
150 #endif
151
152 #include <sys/stat.h>
153
154 #ifndef SEEK_SET
155 # ifdef L_SET
156 #  define SEEK_SET      L_SET
157 # else
158 #  define SEEK_SET      0  /* Wild guess. */
159 # endif
160 #endif
161
162 /* Use all the "standard" definitions? */
163 #if defined(STANDARD_C) && defined(I_STDLIB)
164 #   include <stdlib.h>
165 #endif /* STANDARD_C */
166
167 #define MEM_SIZE Size_t
168
169 /* This comes after <stdlib.h> so we don't try to change the standard
170  * library prototypes; we'll use our own instead. */
171
172 #if defined(MYMALLOC) && !defined(PERL_POLLUTE_MALLOC)
173 #  define malloc  Perl_malloc
174 #  define calloc  Perl_calloc
175 #  define realloc Perl_realloc
176 #  define free    Perl_mfree
177
178 #ifdef __cplusplus
179 extern "C" {
180 #endif
181
182 Malloc_t Perl_malloc proto((MEM_SIZE nbytes));
183 Malloc_t Perl_calloc proto((MEM_SIZE elements, MEM_SIZE size));
184 Malloc_t Perl_realloc proto((Malloc_t where, MEM_SIZE nbytes));
185 Free_t   Perl_mfree proto((Malloc_t where));
186
187 #ifdef __cplusplus
188 }
189 #endif
190
191 #endif /* MYMALLOC */
192
193 #ifdef I_STRING
194 # ifndef __ultrix__
195 #  include <string.h>
196 # endif
197 #else
198 # include <strings.h>
199 #endif
200
201 #ifdef I_MEMORY
202 #include <memory.h>
203 #endif      
204
205 #ifdef __cplusplus
206 #define HAS_MEMCPY
207 #endif
208
209 #ifdef HAS_MEMCPY
210 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
211 #    ifndef memcpy
212         extern char * memcpy proto((char*, char*, int));
213 #    endif
214 #  endif
215 #else
216 #   ifndef memcpy
217 #       ifdef HAS_BCOPY
218 #           define memcpy(d,s,l) bcopy(s,d,l)
219 #       else
220 #           define memcpy(d,s,l) my_bcopy(s,d,l)
221 #       endif
222 #   endif
223 #endif /* HAS_MEMCPY */
224
225 #define memzero(d,l) memset(d,0,l)
226
227 #if defined(mips) && defined(ultrix) && !defined(__STDC__)
228 #   undef HAS_MEMCMP
229 #endif
230
231 #if defined(HAS_MEMCMP) && defined(HAS_SANE_MEMCMP)
232 #  if !defined(STANDARD_C) && !defined(I_STRING) && !defined(I_MEMORY)
233 #    ifndef memcmp
234         extern int memcmp proto((char*, char*, int));
235 #    endif
236 #  endif
237 #  ifdef BUGGY_MSC
238 #    pragma function(memcmp)
239 #  endif
240 #else
241 #   ifndef memcmp
242         /* maybe we should have included the full embedding header... */
243 #       define memcmp Perl_my_memcmp
244 #ifndef __cplusplus
245         extern int memcmp proto((char*, char*, int));
246 #endif
247 #   endif
248 #endif /* HAS_MEMCMP */
249
250 #ifndef HAS_BCMP
251 #   ifndef bcmp
252 #       define bcmp(s1,s2,l) memcmp(s1,s2,l)
253 #   endif
254 #endif /* !HAS_BCMP */
255
256 #ifdef HAS_MEMCMP
257 #  define memNE(s1,s2,l) (memcmp(s1,s2,l))
258 #  define memEQ(s1,s2,l) (!memcmp(s1,s2,l))
259 #else
260 #  define memNE(s1,s2,l) (bcmp(s1,s2,l))
261 #  define memEQ(s1,s2,l) (!bcmp(s1,s2,l))
262 #endif
263
264 #ifdef I_NETINET_IN
265 #  ifdef VMS
266 #    include <in.h>
267 #  else
268 #    include <netinet/in.h>
269 #  endif
270 #endif
271
272 #endif /* Include guard */
273