]> git.sur5r.net Git - openldap/blobdiff - include/ldbm.h
Fix typo
[openldap] / include / ldbm.h
index 95bd55ffa7ca277a137e4bbc4e40792ab8ac46a0..68b143208b1d1dd8c541bd6e382368f406124771 100644 (file)
+/* $OpenLDAP$ */
+/*
+ * Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms are permitted only
+ * as authorized by the OpenLDAP Public License.  A copy of this
+ * license is available at http://www.OpenLDAP.org/license.html or
+ * in file LICENSE in the top-level directory of the distribution.
+ */
 /* ldbm.h - ldap dbm compatibility routine header file */
 
 #ifndef _LDBM_H_
 #define _LDBM_H_
 
-#ifdef LDBM_USE_GDBM
+#include <ldap_cdefs.h>
+
+#if defined( LDBM_USE_DBBTREE ) || defined( LDBM_USE_DBHASH )
 
 /*****************************************************************
  *                                                               *
- * use gdbm if possible                                          *
+ * use berkeley db btree or hash package                         *
  *                                                               *
  *****************************************************************/
+#include <sys/types.h>
+#include <limits.h>
+#include <fcntl.h>
 
-#include <gdbm.h>
+#ifdef HAVE_DB_185_H
+#      include <db_185.h>
+#else
+#      ifdef HAVE_DB1_DB_H
+#              include <db1/db.h>
+#      else
+#              include <db.h>
+#      endif
+#endif
 
-typedef datum          Datum;
+#ifndef DB_VERSION_MAJOR
+#  define DB_VERSION_MAJOR 1
+#endif
+#ifndef DB_VERSION_MINOR
+#  define DB_VERSION_MINOR 85
+#endif
 
-typedef GDBM_FILE      LDBM;
+#if DB_VERSION_MAJOR >= 2
+#      define R_NOOVERWRITE DB_NOOVERWRITE
+#      ifndef DEFAULT_DB_PAGE_SIZE
+#              define DEFAULT_DB_PAGE_SIZE 4096
+#      endif
+#endif
+
+
+LDAP_BEGIN_DECL
+
+typedef DBT    Datum;
+#define dsize  size
+#define dptr   data
+
+typedef DB     *LDBM;
 
-extern gdbm_error      gdbm_errno;
 
 /* for ldbm_open */
-#define LDBM_READER    GDBM_READER
-#define LDBM_WRITER    GDBM_WRITER
-#define LDBM_WRCREAT   GDBM_WRCREAT
-#define LDBM_NEWDB     GDBM_NEWDB
-#define LDBM_FAST      GDBM_FAST
+#if DB_VERSION_MAJOR >= 2
+typedef DBC    LDBMCursor;
+
+#      define LDBM_READER      DB_RDONLY
+#      define LDBM_WRITER      0x00000      /* hopefully */
+# if defined( HAVE_BERKELEY_DB_THREAD )
+#      define LDBM_WRCREAT     (DB_NOMMAP|DB_CREATE|DB_THREAD)
+#      define LDBM_NEWDB       (DB_TRUNCATE|DB_CREATE|DB_THREAD)
+# else
+#      define LDBM_WRCREAT     (DB_NOMMAP|DB_CREATE)
+#      define LDBM_NEWDB       (DB_TRUNCATE|DB_CREATE)
+# endif
+
+#else
+typedef void LDBMCursor;
+#      define LDBM_READER      O_RDONLY
+#      define LDBM_WRITER      O_RDWR
+#      define LDBM_WRCREAT     (O_RDWR|O_CREAT)
+#      define LDBM_NEWDB       (O_RDWR|O_TRUNC|O_CREAT)
+#endif
 
-#define LDBM_SUFFIX    ".gdbm"
+LDAP_END_DECL
+
+/* for ldbm_open */
+#define LDBM_NOSYNC    0
+#define LDBM_SYNC      0
+#define LDBM_LOCKING   0
+#define LDBM_NOLOCKING 0
 
 /* for ldbm_insert */
-#define LDBM_INSERT    GDBM_INSERT
-#define LDBM_REPLACE   GDBM_REPLACE
-#define LDBM_SYNC      0x80000000
+#define LDBM_INSERT    R_NOOVERWRITE
+#define LDBM_REPLACE   0
 
-#else /* end of gdbm */
+#ifdef LDBM_USE_DBBTREE
+#      define LDBM_ORDERED     1
+#      define LDBM_SUFFIX      ".dbb"
+#      define DB_TYPE          DB_BTREE
+#else
+#      define LDBM_SUFFIX      ".dbh"
+#      define DB_TYPE          DB_HASH
+#endif
 
-#ifdef LDBM_USE_DBHASH
+#elif defined( HAVE_GDBM )
 
 /*****************************************************************
  *                                                               *
- * use berkeley db hash package                                  *
+ * use gdbm if possible                                          *
  *                                                               *
  *****************************************************************/
 
-#include <sys/types.h>
-#include <limits.h>
-#include <fcntl.h>
-#include <db.h>
+#include <gdbm.h>
 
-typedef DBT    Datum;
-#define dsize  size
-#define dptr   data
+LDAP_BEGIN_DECL
 
-typedef DB     *LDBM;
+typedef datum          Datum;
+typedef Datum LDBMCursor;
+typedef GDBM_FILE      LDBM;
+
+extern gdbm_error      gdbm_errno;
 
-#define DB_TYPE                DB_HASH
+LDAP_END_DECL
 
 /* for ldbm_open */
-#define LDBM_READER    O_RDONLY
-#define LDBM_WRITER    O_RDWR
-#define LDBM_WRCREAT   (O_RDWR|O_CREAT)
-#define LDBM_NEWDB     (O_RDWR|O_TRUNC|O_CREAT)
-#define LDBM_FAST      0
+#define LDBM_READER    GDBM_READER
+#define LDBM_WRITER    GDBM_WRITER
+#define LDBM_WRCREAT   GDBM_WRCREAT
+#define LDBM_NEWDB     GDBM_NEWDB
 
-#define LDBM_SUFFIX    ".dbh"
+#ifdef GDBM_FAST
+#define LDBM_NOSYNC    GDBM_FAST
+#else
+#define LDBM_NOSYNC    0
+#endif
 
-/* for ldbm_insert */
-#define LDBM_INSERT    R_NOOVERWRITE
-#define LDBM_REPLACE   0
-#define LDBM_SYNC      0x80000000
+#ifdef GDBM_SYNC
+#define LDBM_SYNC      GDBM_SYNC
+#else
+#define LDBM_SYNC      0
+#endif
 
-extern int     errno;
+#define LDBM_LOCKING   0
+#ifdef GDBM_NOLOCK
+#define LDBM_NOLOCKING GDBM_NOLOCK
+#else
+#define LDBM_NOLOCKING 0
+#endif
 
-#else /* end of db hash */
+#define LDBM_SUFFIX    ".gdbm"
 
-#ifdef LDBM_USE_DBBTREE
+/* for ldbm_insert */
+#define LDBM_INSERT    GDBM_INSERT
+#define LDBM_REPLACE   GDBM_REPLACE
+
+#elif defined( HAVE_MDBM )
 
 /*****************************************************************
  *                                                               *
- * use berkeley db btree package                                 *
+ * use mdbm if possible                                          *
  *                                                               *
  *****************************************************************/
 
-#include <sys/types.h>
-#include <limits.h>
-#include <fcntl.h>
-#include <db.h>
+#include <mdbm.h>
 
-typedef DBT    Datum;
-#define dsize  size
-#define dptr   data
+LDAP_BEGIN_DECL
 
-typedef DB     *LDBM;
+typedef datum          Datum;
+typedef int LDBMCursor;
+typedef MDBM           *LDBM;
 
-#define DB_TYPE                DB_BTREE
+LDAP_END_DECL
+    
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
 
 /* for ldbm_open */
 #define LDBM_READER    O_RDONLY
 #define LDBM_WRITER    O_RDWR
 #define LDBM_WRCREAT   (O_RDWR|O_CREAT)
 #define LDBM_NEWDB     (O_RDWR|O_TRUNC|O_CREAT)
-#define LDBM_FAST      0
-
-#define LDBM_SUFFIX    ".dbb"
-#define LDBM_ORDERED   1
 
-/* for ldbm_insert */
-#define LDBM_INSERT    R_NOOVERWRITE
-#define LDBM_REPLACE   0
-#define LDBM_SYNC      0x80000000
+#define LDBM_SYNC      0
+#define LDBM_NOSYNC    0
+#define LDBM_LOCKING   0
+#define LDBM_NOLOCKING 0
 
-extern int     errno;
+#define LDBM_SUFFIX    ".mdbm"
 
-#else /* end of db btree */
+/* for ldbm_insert */
+#define LDBM_INSERT    MDBM_INSERT
+#define LDBM_REPLACE   MDBM_REPLACE
 
-#ifdef LDBM_USE_NDBM
+#elif defined( HAVE_NDBM )
 
 /*****************************************************************
  *                                                               *
@@ -123,43 +202,64 @@ extern int        errno;
  *****************************************************************/
 
 #include <ndbm.h>
-#ifndef O_RDONLY
+
+#ifdef HAVE_FCNTL_H
 #include <fcntl.h>
 #endif
 
-typedef datum  Datum;
+LDAP_BEGIN_DECL
 
+typedef datum  Datum;
+typedef int LDBMCursor;
 typedef DBM    *LDBM;
 
+LDAP_END_DECL
+
 /* for ldbm_open */
 #define LDBM_READER    O_RDONLY
 #define LDBM_WRITER    O_WRONLY
 #define LDBM_WRCREAT   (O_RDWR|O_CREAT)
 #define LDBM_NEWDB     (O_RDWR|O_TRUNC|O_CREAT)
-#define LDBM_FAST      0
+
+#define LDBM_NOSYNC    0
+#define LDBM_SYNC      0
+#define LDBM_NOLOCK    0
+#define LDBM_SYNC      0
 
 #define LDBM_SUFFIX    ".ndbm"
 
 /* for ldbm_insert */
 #define LDBM_INSERT    DBM_INSERT
 #define LDBM_REPLACE   DBM_REPLACE
-#define LDBM_SYNC      0
 
-#endif /* ndbm */
-#endif /* db hash */
-#endif /* db btree */
-#endif /* gdbm */
-
-LDBM   ldbm_open( char *name, int rw, int mode, int dbcachesize );
-void   ldbm_close( LDBM ldbm );
-void   ldbm_sync( LDBM ldbm );
-void   ldbm_datum_free( LDBM ldbm, Datum data );
-Datum  ldbm_datum_dup( LDBM ldbm, Datum data );
-Datum  ldbm_fetch( LDBM ldbm, Datum key );
-int    ldbm_store( LDBM ldbm, Datum key, Datum data, int flags );
-int    ldbm_delete( LDBM ldbm, Datum key );
-Datum  ldbm_firstkey( LDBM ldbm );
-Datum  ldbm_nextkey( LDBM ldbm, Datum key );
-int    ldbm_errno( LDBM ldbm );
+#endif
+
+LDAP_BEGIN_DECL
+
+LDAP_LDBM_F (int) ldbm_initialize( void );
+LDAP_LDBM_F (int) ldbm_shutdown( void );
+
+LDAP_LDBM_F (int) ldbm_errno( LDBM ldbm );
+LDAP_LDBM_F (LDBM) ldbm_open( char *name, int rw, int mode, int dbcachesize );
+LDAP_LDBM_F (void) ldbm_close( LDBM ldbm );
+LDAP_LDBM_F (void) ldbm_sync( LDBM ldbm );
+LDAP_LDBM_F (void) ldbm_datum_free( LDBM ldbm, Datum data );
+LDAP_LDBM_F (Datum) ldbm_datum_dup( LDBM ldbm, Datum data );
+LDAP_LDBM_F (Datum) ldbm_fetch( LDBM ldbm, Datum key );
+LDAP_LDBM_F (int) ldbm_store( LDBM ldbm, Datum key, Datum data, int flags );
+LDAP_LDBM_F (int) ldbm_delete( LDBM ldbm, Datum key );
+
+LDAP_LDBM_F (Datum) ldbm_firstkey( LDBM ldbm, LDBMCursor **cursor );
+LDAP_LDBM_F (Datum) ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *cursor );
+
+/* initialization of Datum structures */
+#if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
+       LDAP_LDBM_F (void *) ldbm_malloc( size_t size );
+#   define ldbm_datum_init(d) ((void)memset(&(d), '\0', sizeof(Datum)))
+#else
+#   define ldbm_datum_init(d) ((void)0)
+#endif  /* HAVE_BERKELEY_DB */
+
+LDAP_END_DECL
 
 #endif /* _ldbm_h_ */