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;
54 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL ) {
55 AC_MEMCPY( dup.dptr, data.dptr, data.dsize );
61 static int ldbm_initialized = 0;
63 #ifdef HAVE_BERKELEY_DB_THREAD
64 #define LDBM_LOCK ((void) 0)
65 #define LDBM_UNLOCK ((void) 0)
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))
73 /*******************************************************************
75 * Create some special functions to initialize Berkeley DB for *
76 * versions greater than 2. *
78 *******************************************************************/
79 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
82 ldbm_malloc( size_t size )
84 return( calloc( 1, size ));
88 #include <ac/syslog.h>
92 ldbm_db_errcall( const char *prefix, char *message )
95 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
99 /* a dbEnv for BERKELEYv2 */
100 DB_ENV *ldbm_Env = NULL;
102 int ldbm_initialize( const char* home )
107 if(ldbm_initialized++) return 1;
109 #ifndef HAVE_BERKELEY_DB_THREAD
110 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
113 #if DB_VERSION_MAJOR < 3
114 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
116 if( ldbm_Env == NULL ) return 1;
118 ldbm_Env->db_errcall = ldbm_db_errcall;
119 ldbm_Env->db_errpfx = "==>";
124 envFlags = DB_CREATE;
126 /* add optional flags */
128 envFlags |= DB_PRIVATE;
131 #ifdef HAVE_BERKELEY_DB_THREAD
132 envFlags |= DB_THREAD | DB_INIT_CDB | DB_INIT_MPOOL;
133 #ifdef DB_MPOOL_PRIVATE
134 envFlags |= DB_MPOOL_PRIVATE;
138 #if DB_VERSION_MAJOR >= 3
139 err = db_env_create( &ldbm_Env, 0 );
141 envFlags |= DB_USE_ENVIRON;
142 err = db_appinit( home, NULL, ldbm_Env, envFlags );
149 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
152 #if DB_VERSION_MAJOR >= 3
153 "ldbm_initialize(): FATAL error in db_env_create() : %s\n",
155 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
162 #if DB_VERSION_MAJOR > 2
163 ldbm_Env->set_errcall( ldbm_Env, ldbm_db_errcall );
164 ldbm_Env->set_errpfx( ldbm_Env, "==>" );
166 #ifdef HAVE_BERKELEY_DB_THREAD
167 envFlags |= DB_INIT_CDB | DB_INIT_MPOOL;
169 envFlags |= DB_USE_ENVIRON;
171 #if (DB_VERSION_MAJOR > 3) || (DB_VERSION_MINOR >= 1)
172 err = ldbm_Env->open( ldbm_Env, home, envFlags, 0 );
174 err = ldbm_Env->open( ldbm_Env, home, NULL, envFlags, 0 );
181 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
183 "ldbm_initialize(): FATAL error in dbEnv->open() : %s\n",
186 ldbm_Env->close( ldbm_Env, 0 );
194 int ldbm_shutdown( void )
196 if( !ldbm_initialized ) return 1;
198 #if DB_VERSION_MAJOR >= 3
199 ldbm_Env->close( ldbm_Env, 0 );
201 db_appexit( ldbm_Env );
204 #ifndef HAVE_BERKELEY_DB_THREAD
205 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
211 #else /* some DB other than Berkeley V2 or greater */
213 int ldbm_initialize( const char * home )
215 if(ldbm_initialized++) return 1;
217 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
222 int ldbm_shutdown( void )
224 if( !ldbm_initialized ) return 1;
226 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
231 #endif /* HAVE_BERKELEY_DB */
234 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
236 /*****************************************************************
238 * use berkeley db hash or btree package *
240 *****************************************************************/
243 ldbm_open( char *name, int rw, int mode, int dbcachesize )
247 #if DB_VERSION_MAJOR >= 3
252 err = db_create( &ret, ldbm_Env, 0 );
254 (void)ret->close(ret, 0);
258 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
259 ret->set_malloc( ret, ldbm_malloc );
261 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
266 (void)ret->close(ret, 0);
270 #elif DB_VERSION_MAJOR >= 2
273 memset( &dbinfo, '\0', sizeof( dbinfo ));
275 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
277 * BerkeleyDB 2.4 do not allow db_cachesize
278 * to be specified if an DB_ENV is.
281 /* set db_cachesize of MPOOL is NOT being used. */
282 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
283 dbinfo.db_cachesize = dbcachesize;
287 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
288 dbinfo.db_malloc = ldbm_malloc;
291 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
299 if ( DB_TYPE == DB_HASH ) {
300 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
301 hinfo.cachesize = dbcachesize;
303 } else if ( DB_TYPE == DB_BTREE ) {
304 memset( (char *) &binfo, '\0', sizeof(binfo) );
305 binfo.cachesize = dbcachesize;
312 ret = dbopen( name, rw, mode, DB_TYPE, info );
320 ldbm_close( LDBM ldbm )
323 #if DB_VERSION_MAJOR >= 3
324 ldbm->close( ldbm, 0 );
325 #elif DB_VERSION_MAJOR >= 2
326 (*ldbm->close)( ldbm, 0 );
328 (*ldbm->close)( ldbm );
334 ldbm_sync( LDBM ldbm )
337 (*ldbm->sync)( ldbm, 0 );
342 ldbm_fetch( LDBM ldbm, Datum key )
349 #if DB_VERSION_MAJOR >= 3
350 ldbm_datum_init( data );
352 data.flags = DB_DBT_MALLOC;
354 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
355 ldbm_datum_free( ldbm, data );
360 #elif DB_VERSION_MAJOR >= 2
361 ldbm_datum_init( data );
363 data.flags = DB_DBT_MALLOC;
365 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
366 ldbm_datum_free( ldbm, data );
372 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
373 /* Berkeley DB 1.85 don't malloc the data for us */
374 /* duplicate it for to ensure reentrancy */
375 data = ldbm_datum_dup( ldbm, data );
388 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
394 #if DB_VERSION_MAJOR >= 3
395 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
398 #elif DB_VERSION_MAJOR >= 2
399 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
402 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
405 if ( flags & LDBM_SYNC )
406 (*ldbm->sync)( ldbm, 0 );
414 ldbm_delete( LDBM ldbm, Datum key )
420 #if DB_VERSION_MAJOR >= 3
421 rc = ldbm->del( ldbm, NULL, &key, 0 );
423 #elif DB_VERSION_MAJOR >= 2
424 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
427 rc = (*ldbm->del)( ldbm, &key, 0 );
429 (*ldbm->sync)( ldbm, 0 );
437 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
441 #if DB_VERSION_MAJOR >= 2
444 ldbm_datum_init( key );
445 ldbm_datum_init( data );
447 key.flags = data.flags = DB_DBT_MALLOC;
451 /* acquire a cursor for the DB */
452 # if DB_VERSION_MAJOR >= 3
453 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
454 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
455 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
457 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
460 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
467 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
468 ldbm_datum_free( ldbm, data );
476 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
477 key = ldbm_datum_dup( ldbm, key );
485 #if DB_VERSION_MAJOR >= 2
495 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
499 #if DB_VERSION_MAJOR >= 2
500 ldbm_datum_init( data );
502 ldbm_datum_free( ldbm, key );
503 key.flags = data.flags = DB_DBT_MALLOC;
507 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
508 ldbm_datum_free( ldbm, data );
516 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
517 key = ldbm_datum_dup( ldbm, key );
531 ldbm_errno( LDBM ldbm )
536 /******************************************************************
538 * END Berkeley section *
540 ******************************************************************/
542 #elif defined( HAVE_GDBM )
544 #ifdef HAVE_ST_BLKSIZE
545 #include <sys/stat.h>
548 /*****************************************************************
552 *****************************************************************/
555 ldbm_open( char *name, int rw, int mode, int dbcachesize )
558 #ifdef HAVE_ST_BLKSIZE
564 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
569 #ifdef HAVE_ST_BLKSIZE
570 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
571 dbcachesize /= st.st_blksize;
572 if( dbcachesize == 0 ) dbcachesize = 1;
573 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
576 if ( dbcachesize > 0 ) {
578 if( dbcachesize == 0 ) dbcachesize = 1;
579 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
589 ldbm_close( LDBM ldbm )
597 ldbm_sync( LDBM ldbm )
605 ldbm_fetch( LDBM ldbm, Datum key )
610 d = gdbm_fetch( ldbm, key );
617 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
622 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
623 if ( flags & LDBM_SYNC )
631 ldbm_delete( LDBM ldbm, Datum key )
636 rc = gdbm_delete( ldbm, key );
644 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
649 d = gdbm_firstkey( ldbm );
652 if ( d.dptr != NULL ) {
653 *dbcp = (Datum *) malloc( sizeof( Datum ) );
654 **dbcp = ldbm_datum_dup( ldbm, d );
661 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
666 d = gdbm_nextkey( ldbm, *dbcp );
669 ldbm_datum_free( ldbm, *dbcp );
671 if ( d.dptr != NULL ) {
672 *dbcp = ldbm_datum_dup( ldbm, d );
681 ldbm_errno( LDBM ldbm )
694 /* MMAPED DBM HASHING DATABASE */
696 #include <ac/string.h>
698 /* #define MDBM_DEBUG */
705 /* #define MDBM_CHAIN */
712 #define mdbm_store mdbm_chain_store
713 #define mdbm_fetch mdbm_chain_fetch
714 #define mdbm_delete mdbm_chain_delete
715 #define mdbm_first mdbm_chain_first
716 #define mdbm_next mdbm_chain_next
720 #define MDBM_PG_SZ (4*1024)
722 /*****************************************************************
726 *****************************************************************/
729 ldbm_open( char *name, int rw, int mode, int dbcachesize )
735 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
736 name ? name : "NULL", rw, mode, dbcachesize );
740 LDBM_LOCK; /* We need locking here, this is the only non-thread
741 * safe function we have.
744 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
748 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
756 (void)mdbm_set_chain(db);
762 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
774 ldbm_close( LDBM ldbm )
777 /* Open and close are not reentrant so we need to use locks here */
781 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
790 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
800 ldbm_sync( LDBM ldbm )
802 /* XXX: Not sure if this is re-entrant need to check code, if so
803 * you can leave LOCKS out.
812 #define MAX_MDBM_RETRY 5
815 ldbm_fetch( LDBM ldbm, Datum key )
821 /* This hack is needed because MDBM does not take keys
822 * which begin with NULL when working in the chaining
829 k.key.dsize = key.dsize + 1;
830 k.key.dptr = malloc(k.key.dsize);
832 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
842 d = mdbm_fetch( ldbm, k );
846 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 AC_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 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
942 rc = mdbm_delete( ldbm, int_key );
956 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
961 size_t sz = MDBM_PAGE_SIZE(ldbm);
970 in.key.dsize = sz; /* Assume first key in one pg */
971 in.key.dptr = malloc(sz);
973 in.val.dptr = NULL; /* Don't need data just key */
979 out = fptr( ldbm, in );
981 if (out.key.dsize > 0) {
982 ret.dsize = out.key.dsize - delta;
984 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
989 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1001 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1003 return ldbm_get_next( ldbm, mdbm_first );
1007 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1010 * don't know if this will affect the LDAP server operation
1011 * but mdbm cannot take and input key.
1014 return ldbm_get_next( ldbm, mdbm_next );
1018 ldbm_errno( LDBM ldbm )
1020 /* XXX: best we can do with current mdbm interface */
1027 #elif defined( HAVE_NDBM )
1029 /*****************************************************************
1031 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1033 *****************************************************************/
1037 ldbm_open( char *name, int rw, int mode, int dbcachesize )
1042 ldbm = dbm_open( name, rw, mode );
1049 ldbm_close( LDBM ldbm )
1058 ldbm_sync( LDBM ldbm )
1064 ldbm_fetch( LDBM ldbm, Datum key )
1069 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1076 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1081 rc = dbm_store( ldbm, key, data, flags );
1088 ldbm_delete( LDBM ldbm, Datum key )
1093 rc = dbm_delete( ldbm, key );
1100 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1105 d = dbm_firstkey( ldbm );
1112 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1117 d = dbm_nextkey( ldbm );
1124 ldbm_errno( LDBM ldbm )
1129 err = dbm_error( ldbm );