3 * Copyright 1998,1999 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms are permitted only
7 * as authorized by the OpenLDAP Public License. A copy of this
8 * license is available at http://www.OpenLDAP.org/license.html or
9 * in file LICENSE in the top-level directory of the distribution.
11 /* ldbm.h - ldap dbm compatibility routine header file */
16 #include <ldap_cdefs.h>
18 #if defined( LDBM_USE_DBBTREE ) || defined( LDBM_USE_DBHASH )
20 /*****************************************************************
22 * use berkeley db btree or hash package *
24 *****************************************************************/
26 #include <sys/types.h>
38 # ifdef HAVE_BERKELEY_DB2
39 # define R_NOOVERWRITE DB_NOOVERWRITE
40 # define DEFAULT_DB_PAGE_SIZE 1024
55 #ifdef HAVE_BERKELEY_DB2
56 typedef DBC LDBMCursor;
58 # define LDBM_READER DB_RDONLY
59 # define LDBM_WRITER 0x00000 /* hopefully */
60 # ifdef HAVE_BERKELEY_DB2_DB_THREAD
61 # define LDBM_WRCREAT (DB_NOMMAP|DB_CREATE|DB_THREAD)
62 # define LDBM_NEWDB (DB_TRUNCATE|DB_CREATE|DB_THREAD)
64 # define LDBM_WRCREAT (DB_NOMMAP|DB_CREATE)
65 # define LDBM_NEWDB (DB_TRUNCATE|DB_CREATE)
69 typedef int LDBMCursor;
70 # define LDBM_READER O_RDONLY
71 # define LDBM_WRITER O_RDWR
72 # define LDBM_WRCREAT (O_RDWR|O_CREAT)
73 # define LDBM_NEWDB (O_RDWR|O_TRUNC|O_CREAT)
81 #define LDBM_LOCKING 0
82 #define LDBM_NOLOCKING 0
85 #define LDBM_INSERT R_NOOVERWRITE
86 #define LDBM_REPLACE 0
88 #ifdef LDBM_USE_DBBTREE
89 # define LDBM_ORDERED 1
90 # define LDBM_SUFFIX ".dbb"
91 # define DB_TYPE DB_BTREE
93 # define LDBM_SUFFIX ".dbh"
94 # define DB_TYPE DB_HASH
97 #elif defined( HAVE_GDBM )
99 /*****************************************************************
101 * use gdbm if possible *
103 *****************************************************************/
110 typedef int LDBMCursor;
111 typedef GDBM_FILE LDBM;
113 extern gdbm_error gdbm_errno;
118 #define LDBM_READER GDBM_READER
119 #define LDBM_WRITER GDBM_WRITER
120 #define LDBM_WRCREAT GDBM_WRCREAT
121 #define LDBM_NEWDB GDBM_NEWDB
124 #define LDBM_NOSYNC GDBM_FAST
126 #define LDBM_NOSYNC 0
130 #define LDBM_SYNC GDBM_SYNC
135 #define LDBM_LOCKING 0
137 #define LDBM_NOLOCKING GDBM_NOLOCK
140 #define LDBM_SUFFIX ".gdbm"
142 /* for ldbm_insert */
143 #define LDBM_INSERT GDBM_INSERT
144 #define LDBM_REPLACE GDBM_REPLACE
146 #elif defined( HAVE_MDBM )
148 /*****************************************************************
150 * use mdbm if possible *
152 *****************************************************************/
159 typedef int LDBMCursor;
164 #include <sys/types.h>
165 #include <sys/stat.h>
169 #define LDBM_READER O_RDONLY
170 #define LDBM_WRITER O_RDWR
171 #define LDBM_WRCREAT (O_RDWR|O_CREAT)
172 #define LDBM_NEWDB (O_RDWR|O_TRUNC|O_CREAT)
175 #define LDBM_NOSYNC 0
176 #define LDBM_LOCKING 0
177 #define LDBM_NOLOCKING 0
179 #define LDBM_SUFFIX ".mdbm"
181 /* for ldbm_insert */
182 #define LDBM_INSERT MDBM_INSERT
183 #define LDBM_REPLACE MDBM_REPLACE
185 #elif defined( HAVE_NDBM )
187 /*****************************************************************
189 * if none of the above use ndbm, the standard unix thing *
191 *****************************************************************/
202 typedef int LDBMCursor;
208 #define LDBM_READER O_RDONLY
209 #define LDBM_WRITER O_WRONLY
210 #define LDBM_WRCREAT (O_RDWR|O_CREAT)
211 #define LDBM_NEWDB (O_RDWR|O_TRUNC|O_CREAT)
213 #define LDBM_NOSYNC 0
215 #define LDBM_NOLOCK 0
218 #define LDBM_SUFFIX ".ndbm"
220 /* for ldbm_insert */
221 #define LDBM_INSERT DBM_INSERT
222 #define LDBM_REPLACE DBM_REPLACE
228 LIBLDBM_F (int) ldbm_initialize( void );
229 LIBLDBM_F (int) ldbm_shutdown( void );
231 LIBLDBM_F (int) ldbm_errno( LDBM ldbm );
232 LIBLDBM_F (LDBM) ldbm_open( char *name, int rw, int mode, int dbcachesize );
233 LIBLDBM_F (void) ldbm_close( LDBM ldbm );
234 LIBLDBM_F (void) ldbm_sync( LDBM ldbm );
235 LIBLDBM_F (void) ldbm_datum_free( LDBM ldbm, Datum data );
236 LIBLDBM_F (Datum) ldbm_datum_dup( LDBM ldbm, Datum data );
237 LIBLDBM_F (Datum) ldbm_fetch( LDBM ldbm, Datum key );
238 LIBLDBM_F (int) ldbm_store( LDBM ldbm, Datum key, Datum data, int flags );
239 LIBLDBM_F (int) ldbm_delete( LDBM ldbm, Datum key );
241 LIBLDBM_F (Datum) ldbm_firstkey( LDBM ldbm, LDBMCursor **cursor );
242 LIBLDBM_F (Datum) ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *cursor );
244 /* initialization of Datum structures */
245 #ifdef HAVE_BERKELEY_DB2
246 LIBLDBM_F (void *) ldbm_malloc( size_t size );
247 # define ldbm_datum_init(d) ((void)memset(&(d), 0, sizeof(Datum)))
249 # define ldbm_datum_init(d) ((void)0)
250 #endif /* HAVE_BERKELEY_DB2 */
254 #endif /* _ldbm_h_ */