1 /* ldbm.c - ldap dbm compatibility routines */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 /* Patched for Berkeley DB version 2.0; /KSp; 98/02/23
10 * - DB version 2.6.4b ; 1998/12/28, /KSp
11 * - DB_DBT_MALLOC ; 1998/03/22, /KSp
12 * - basic implementation; 1998/02/23, /KSp
21 #include <ac/stdlib.h>
22 #include <ac/string.h>
26 #include "ldap_pvt_thread.h"
29 ldbm_datum_free( LDBM ldbm, Datum data )
33 memset( &data, '\0', sizeof( Datum ));
40 ldbm_datum_dup( LDBM ldbm, Datum data )
44 ldbm_datum_init( dup );
46 if ( data.dsize == 0 ) {
52 dup.dsize = data.dsize;
53 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL )
54 memcpy( dup.dptr, data.dptr, data.dsize );
59 static int ldbm_initialized = 0;
61 #ifdef HAVE_BERKELEY_DB_THREAD
62 #define LDBM_LOCK ((void)0)
63 #define LDBM_UNLOCK ((void)0)
66 /* Only DB2 or DB3 with DB_THREAD is thread-free */
67 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
68 #define LDBM_LOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
69 #define LDBM_UNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
75 /*******************************************************************
77 * Create some special functions to initialize Berkeley DB for *
78 * versions greater than 2. *
80 *******************************************************************/
81 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
85 ldbm_malloc( size_t size )
87 return( calloc( 1, size ));
91 #include <ac/syslog.h>
95 ldbm_db_errcall( const char *prefix, char *message )
98 syslog( LOG_INFO, "ldbm_db_errcall(): %s %s", prefix, message );
102 /* a dbEnv for BERKELEYv2 */
103 DB_ENV *ldbm_Env = NULL;
105 int ldbm_initialize( void )
110 if(ldbm_initialized++) return 1;
112 #if DB_VERSION_MAJOR < 3
113 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
115 if( ldbm_Env == NULL ) return 1;
117 ldbm_Env->db_errcall = ldbm_db_errcall;
118 ldbm_Env->db_errpfx = "==>";
124 #if defined( HAVE_BERKELEY_DB_THREAD )
129 #if DB_VERSION_MAJOR >= 3
130 err = db_env_create( &ldbm_Env, 0 );
131 #elif DB_VERSION_MAJOR >= 2
132 err = db_appinit( NULL, NULL, ldbm_Env, envFlags );
139 sprintf( error, "%ld\n", (long) err );
141 sprintf( error, "%s\n", strerror( err ));
145 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
151 #if DB_VERSION_MAJOR >= 3
152 ldbm_Env->set_errcall( ldbm_Env, ldbm_db_errcall );
153 ldbm_Env->set_errpfx( ldbm_Env, "==>" );
155 envFlags |= DB_INIT_MPOOL;
156 err = ldbm_Env->open( ldbm_Env, NULL, NULL, envFlags, 0 );
162 sprintf( error, "%ld\n", (long) err );
164 sprintf( error, "%s\n", strerror( err ));
168 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
171 ldbm_Env->close( ldbm_Env, 0 );
179 int ldbm_shutdown( void )
181 if( !ldbm_initialized ) return 1;
183 #if DB_VERSION_MAJOR >= 3
184 ldbm_Env->close( ldbm_Env, 0 );
186 db_appexit( ldbm_Env );
192 #else /* some DB other than Berkeley V2 or greater */
194 int ldbm_initialize( void )
196 if(ldbm_initialized++) return 1;
198 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
203 int ldbm_shutdown( void )
205 if( !ldbm_initialized ) return 1;
207 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
212 #endif /* ifdef HAVE_BERKELEY_DB */
215 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
217 /*****************************************************************
219 * use berkeley db hash or btree package *
221 *****************************************************************/
224 ldbm_open( char *name, int rw, int mode, int dbcachesize )
228 #if DB_VERSION_MAJOR >= 3
231 err = db_create( &ret, ldbm_Env, 0 );
237 sprintf( error, "%ld\n", (long) err );
239 sprintf( error, "%s\n", strerror( err ));
241 (void)ret->close(ret, 0);
245 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
246 ret->set_malloc( ret, ldbm_malloc );
247 ret->set_cachesize( ret, 0, dbcachesize, 0 );
248 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
255 sprintf( error, "%ld\n", (long) err );
257 sprintf( error, "%s\n", strerror( err ));
259 (void)ret->close(ret, 0);
263 #elif DB_VERSION_MAJOR >= 2
266 memset( &dbinfo, '\0', sizeof( dbinfo ));
268 #if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
269 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
271 * BerkeleyDB 2.4 do not allow db_cachesize
272 * to be specified if an DB_ENV is.
275 /* set db_cachesize of MPOOL is NOT being used. */
276 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL ))
277 dbinfo.db_cachesize = dbcachesize;
280 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
281 dbinfo.db_malloc = ldbm_malloc;
284 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
292 if ( DB_TYPE == DB_HASH ) {
293 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
294 hinfo.cachesize = dbcachesize;
296 } else if ( DB_TYPE == DB_BTREE ) {
297 memset( (char *) &binfo, '\0', sizeof(binfo) );
298 binfo.cachesize = dbcachesize;
305 ret = dbopen( name, rw, mode, DB_TYPE, info );
314 ldbm_close( LDBM ldbm )
317 #if DB_VERSION_MAJOR >= 3
318 ldbm->close( ldbm, 0 );
319 #elif DB_VERSION_MAJOR >= 2
320 (*ldbm->close)( ldbm, 0 );
322 (*ldbm->close)( ldbm );
328 ldbm_sync( LDBM ldbm )
331 (*ldbm->sync)( ldbm, 0 );
336 ldbm_fetch( LDBM ldbm, Datum key )
342 #if DB_VERSION_MAJOR >= 3
343 ldbm_datum_init( data );
345 data.flags = DB_DBT_MALLOC;
347 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
348 ldbm_datum_free( ldbm, data );
350 #elif DB_VERSION_MAJOR >= 2
351 ldbm_datum_init( data );
353 data.flags = DB_DBT_MALLOC;
355 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
356 ldbm_datum_free( ldbm, data );
358 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
359 /* Berkeley DB 1.85 don't malloc the data for us */
360 /* duplicate it for to ensure reentrancy */
361 data = ldbm_datum_dup( ldbm, data );
374 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
380 #if DB_VERSION_MAJOR >= 3
381 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
387 sprintf( error, "%ld\n", (long) rc );
389 sprintf( error, "%s\n", strerror( rc ));
394 #elif DB_VERSION_MAJOR >= 2
395 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
398 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
401 if ( flags & LDBM_SYNC )
402 (*ldbm->sync)( ldbm, 0 );
410 ldbm_delete( LDBM ldbm, Datum key )
416 #if DB_VERSION_MAJOR >= 3
417 rc = ldbm->del( ldbm, NULL, &key, 0 );
419 #elif DB_VERSION_MAJOR >= 2
420 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
423 rc = (*ldbm->del)( ldbm, &key, 0 );
425 (*ldbm->sync)( ldbm, 0 );
433 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
437 #if DB_VERSION_MAJOR >= 2
440 ldbm_datum_init( key );
441 ldbm_datum_init( data );
443 key.flags = data.flags = DB_DBT_MALLOC;
447 /* acquire a cursor for the DB */
448 # if DB_VERSION_MAJOR >= 3
449 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
450 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
451 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
453 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
456 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
463 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
464 ldbm_datum_free( ldbm, data );
472 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
473 key = ldbm_datum_dup( ldbm, key );
481 #if DB_VERSION_MAJOR >= 2
491 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
495 #if DB_VERSION_MAJOR >= 2
496 ldbm_datum_init( data );
498 ldbm_datum_free( ldbm, key );
499 key.flags = data.flags = DB_DBT_MALLOC;
503 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
504 ldbm_datum_free( ldbm, data );
512 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
513 key = ldbm_datum_dup( ldbm, key );
527 ldbm_errno( LDBM ldbm )
532 /******************************************************************
534 * END Berkeley section *
536 ******************************************************************/
538 #elif defined( HAVE_GDBM )
540 #ifdef HAVE_ST_BLKSIZE
541 #include <sys/stat.h>
544 /*****************************************************************
548 *****************************************************************/
551 ldbm_open( char *name, int rw, int mode, int dbcachesize )
554 #ifdef HAVE_ST_BLKSIZE
560 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
565 #ifdef HAVE_ST_BLKSIZE
566 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
567 dbcachesize /= st.st_blksize;
568 if( dbcachesize == 0 ) dbcachesize = 1;
569 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
572 if ( dbcachesize > 0 ) {
574 if( dbcachesize == 0 ) dbcachesize = 1;
575 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
585 ldbm_close( LDBM ldbm )
593 ldbm_sync( LDBM ldbm )
601 ldbm_fetch( LDBM ldbm, Datum key )
606 d = gdbm_fetch( ldbm, key );
613 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
618 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
619 if ( flags & LDBM_SYNC )
627 ldbm_delete( LDBM ldbm, Datum key )
632 rc = gdbm_delete( ldbm, key );
640 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
645 d = gdbm_firstkey( ldbm );
648 if ( d.dptr != NULL ) {
649 *dbcp = (Datum *) malloc( sizeof( Datum ) );
650 **dbcp = ldbm_datum_dup( ldbm, d );
657 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
662 d = gdbm_nextkey( ldbm, *dbcp );
665 ldbm_datum_free( ldbm, *dbcp );
667 if ( d.dptr != NULL ) {
668 *dbcp = ldbm_datum_dup( ldbm, d );
677 ldbm_errno( LDBM ldbm )
690 /* MMAPED DBM HASHING DATABASE */
692 #include <ac/string.h>
694 /* #define MDBM_DEBUG */
701 /* #define MDBM_CHAIN */
708 #define mdbm_store mdbm_chain_store
709 #define mdbm_fetch mdbm_chain_fetch
710 #define mdbm_delete mdbm_chain_delete
711 #define mdbm_first mdbm_chain_first
712 #define mdbm_next mdbm_chain_next
716 #define MDBM_PG_SZ (4*1024)
718 /*****************************************************************
722 *****************************************************************/
725 ldbm_open( char *name, int rw, int mode, int dbcachesize )
731 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
732 name ? name : "NULL", rw, mode, dbcachesize );
736 LDBM_LOCK; /* We need locking here, this is the only non-thread
737 * safe function we have.
740 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
744 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
752 (void)mdbm_set_chain(db);
758 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
770 ldbm_close( LDBM ldbm )
773 /* Open and close are not reentrant so we need to use locks here */
777 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
786 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
796 ldbm_sync( LDBM ldbm )
799 /* XXX: Not sure if this is re-entrant need to check code, if so
800 * you can leave LOCKS out.
810 #define MAX_MDBM_RETRY 5
813 ldbm_fetch( LDBM ldbm, Datum key )
819 /* This hack is needed because MDBM does not take keys
820 * which begin with NULL when working in the chaining
827 k.key.dsize = key.dsize + 1;
828 k.key.dptr = malloc(k.key.dsize);
830 memcpy( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
840 d = mdbm_fetch( ldbm, k );
844 if ( k.val.dptr != NULL ) {
850 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
852 k.val.dsize = d.dsize;
853 d = mdbm_fetch( ldbm, k );
862 }/* if ( d.dsize > 0 ) */
864 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
880 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
883 Datum int_key; /* Internal key */
887 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
888 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
895 int_key.dsize = key.dsize + 1;
896 int_key.dptr = malloc( int_key.dsize );
897 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
898 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
903 rc = mdbm_store( ldbm, int_key, data, flags );
904 if ( flags & LDBM_SYNC ) {
911 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
926 ldbm_delete( LDBM ldbm, Datum key )
934 int_key.dsize = key.dsize + 1;
935 int_key.dptr = malloc(int_key.dsize);
936 *(int_key.dptr) = 'l';
937 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
942 rc = mdbm_delete( ldbm, int_key );
957 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
963 size_t sz = MDBM_PAGE_SIZE(ldbm);
972 in.key.dsize = sz; /* Assume first key in one pg */
973 in.key.dptr = malloc(sz);
975 in.val.dptr = NULL; /* Don't need data just key */
981 out = fptr( ldbm, in );
983 if (out.key.dsize > 0) {
985 ret.dsize = out.key.dsize - delta;
986 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
993 memcpy(ret.dptr, (void *)(out.key.dptr + delta),
1012 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1015 return ldbm_get_next( ldbm, mdbm_first );
1023 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1027 * don't know if this will affect the LDAP server opertaion
1028 * but mdbm cannot take and input key.
1031 return ldbm_get_next( ldbm, mdbm_next );
1036 ldbm_errno( LDBM ldbm )
1038 /* XXX: best we can do with current mdbm interface */
1046 #elif defined( HAVE_NDBM )
1048 /*****************************************************************
1050 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1052 *****************************************************************/
1056 ldbm_open( char *name, int rw, int mode, int dbcachesize )
1061 ldbm = dbm_open( name, rw, mode );
1068 ldbm_close( LDBM ldbm )
1077 ldbm_sync( LDBM ldbm )
1083 ldbm_fetch( LDBM ldbm, Datum key )
1088 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1095 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1100 rc = dbm_store( ldbm, key, data, flags );
1107 ldbm_delete( LDBM ldbm, Datum key )
1112 rc = dbm_delete( ldbm, key );
1119 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1124 d = dbm_firstkey( ldbm );
1131 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1136 d = dbm_nextkey( ldbm );
1143 ldbm_errno( LDBM ldbm )
1148 err = dbm_error( ldbm );