3 * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted only as authorized by the OpenLDAP
8 * Public License. A copy of this license is available at
9 * http://www.OpenLDAP.org/license.html or in file LICENSE in the
10 * top-level directory of the distribution.
12 /* ldbm.h - ldap dbm compatibility routine header file */
17 #include <ldap_cdefs.h>
19 /* dummy DB_ENV for non Berkeley DB */
20 #if !defined( LDBM_USE_DBBTREE ) && !defined( LDBM_USE_DBHASH )
24 #if defined( LDBM_USE_DBBTREE ) || defined( LDBM_USE_DBHASH )
26 /*****************************************************************
28 * use berkeley db btree or hash package *
30 *****************************************************************/
31 #include <sys/types.h>
45 #ifndef DB_VERSION_MAJOR
46 # define DB_VERSION_MAJOR 1
48 #ifndef DB_VERSION_MINOR
49 # define DB_VERSION_MINOR 85
52 #if DB_VERSION_MAJOR >= 2
53 # define R_NOOVERWRITE DB_NOOVERWRITE
54 # ifndef DEFAULT_DB_PAGE_SIZE
55 # define DEFAULT_DB_PAGE_SIZE 4096
72 #if DB_VERSION_MAJOR >= 2
73 typedef DBC LDBMCursor;
75 # define LDBM_READER DB_RDONLY
76 # define LDBM_WRITER 0x00000 /* hopefully */
77 # if defined( HAVE_BERKELEY_DB_THREAD )
78 # define LDBM_WRCREAT (DB_NOMMAP|DB_CREATE|DB_THREAD)
79 # define LDBM_NEWDB (DB_TRUNCATE|DB_CREATE|DB_THREAD)
81 # define LDBM_WRCREAT (DB_NOMMAP|DB_CREATE)
82 # define LDBM_NEWDB (DB_TRUNCATE|DB_CREATE)
86 typedef void LDBMCursor;
87 # define LDBM_READER O_RDONLY
88 # define LDBM_WRITER O_RDWR
89 # define LDBM_WRCREAT (O_RDWR|O_CREAT)
90 # define LDBM_NEWDB (O_RDWR|O_TRUNC|O_CREAT)
98 #define LDBM_LOCKING 0
99 #define LDBM_NOLOCKING 0
101 /* for ldbm_insert */
102 #define LDBM_INSERT R_NOOVERWRITE
103 #define LDBM_REPLACE 0
105 #ifdef LDBM_USE_DBBTREE
106 # define LDBM_ORDERED 1
107 # define LDBM_SUFFIX ".dbb"
108 # define DB_TYPE DB_BTREE
110 # define LDBM_SUFFIX ".dbh"
111 # define DB_TYPE DB_HASH
114 #elif defined( HAVE_GDBM )
116 /*****************************************************************
118 * use gdbm if possible *
120 *****************************************************************/
127 typedef Datum LDBMCursor;
128 typedef GDBM_FILE LDBM;
133 #define LDBM_READER GDBM_READER
134 #define LDBM_WRITER GDBM_WRITER
135 #define LDBM_WRCREAT GDBM_WRCREAT
136 #define LDBM_NEWDB GDBM_NEWDB
139 #define LDBM_NOSYNC GDBM_FAST
141 #define LDBM_NOSYNC 0
145 #define LDBM_SYNC GDBM_SYNC
150 #define LDBM_LOCKING 0
152 #define LDBM_NOLOCKING GDBM_NOLOCK
154 #define LDBM_NOLOCKING 0
157 #define LDBM_SUFFIX ".gdbm"
159 /* for ldbm_insert */
160 #define LDBM_INSERT GDBM_INSERT
161 #define LDBM_REPLACE GDBM_REPLACE
163 #elif defined( HAVE_MDBM )
165 /*****************************************************************
167 * use mdbm if possible *
169 *****************************************************************/
176 typedef int LDBMCursor;
181 #include <sys/types.h>
182 #include <sys/stat.h>
186 #define LDBM_READER O_RDONLY
187 #define LDBM_WRITER O_RDWR
188 #define LDBM_WRCREAT (O_RDWR|O_CREAT)
189 #define LDBM_NEWDB (O_RDWR|O_TRUNC|O_CREAT)
192 #define LDBM_NOSYNC 0
193 #define LDBM_LOCKING 0
194 #define LDBM_NOLOCKING 0
196 #define LDBM_SUFFIX ".mdbm"
198 /* for ldbm_insert */
199 #define LDBM_INSERT MDBM_INSERT
200 #define LDBM_REPLACE MDBM_REPLACE
202 #elif defined( HAVE_NDBM )
204 /*****************************************************************
206 * if none of the above use ndbm, the standard unix thing *
208 *****************************************************************/
219 typedef int LDBMCursor;
225 #define LDBM_READER O_RDONLY
226 #define LDBM_WRITER O_WRONLY
227 #define LDBM_WRCREAT (O_RDWR|O_CREAT)
228 #define LDBM_NEWDB (O_RDWR|O_TRUNC|O_CREAT)
230 #define LDBM_NOSYNC 0
232 #define LDBM_NOLOCK 0
235 #define LDBM_SUFFIX ".ndbm"
237 /* for ldbm_insert */
238 #define LDBM_INSERT DBM_INSERT
239 #define LDBM_REPLACE DBM_REPLACE
245 LDAP_LDBM_F (int) ldbm_initialize( const char * );
246 LDAP_LDBM_F (int) ldbm_shutdown( void );
248 LDAP_LDBM_F (DB_ENV*) ldbm_initialize_env(const char *, int dbcachesize, int *envdirok);
249 LDAP_LDBM_F (void) ldbm_shutdown_env(DB_ENV *);
251 LDAP_LDBM_F (int) ldbm_errno( LDBM ldbm );
252 LDAP_LDBM_F (LDBM) ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize );
253 LDAP_LDBM_F (void) ldbm_close( LDBM ldbm );
254 LDAP_LDBM_F (void) ldbm_sync( LDBM ldbm );
255 LDAP_LDBM_F (void) ldbm_datum_free( LDBM ldbm, Datum data );
256 LDAP_LDBM_F (Datum) ldbm_datum_dup( LDBM ldbm, Datum data );
257 LDAP_LDBM_F (Datum) ldbm_fetch( LDBM ldbm, Datum key );
258 LDAP_LDBM_F (int) ldbm_store( LDBM ldbm, Datum key, Datum data, int flags );
259 LDAP_LDBM_F (int) ldbm_delete( LDBM ldbm, Datum key );
261 LDAP_LDBM_F (Datum) ldbm_firstkey( LDBM ldbm, LDBMCursor **cursor );
262 LDAP_LDBM_F (Datum) ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *cursor );
264 /* initialization of Datum structures */
265 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
266 LDAP_LDBM_F (void *) ldbm_malloc( size_t size );
267 # define ldbm_datum_init(d) ((void)memset(&(d), '\0', sizeof(Datum)))
269 # define ldbm_datum_init(d) ((void)0)
270 #endif /* HAVE_BERKELEY_DB */
274 #endif /* _ldbm_h_ */