git.sur5r.net Git - openldap/blob - include/ldbm.h

   1 /* $OpenLDAP$ */
   2 /*
   3  * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
   4  * All rights reserved.
   5  *
   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.
  11  */
  12 /* ldbm.h - ldap dbm compatibility routine header file */
  13
  14 #ifndef _LDBM_H_
  15 #define _LDBM_H_
  16
  17 #include <ldap_cdefs.h>
  18
  19 /* dummy DB_ENV for non Berkeley DB */
  20 #if !defined( LDBM_USE_DBBTREE ) && !defined( LDBM_USE_DBHASH )
  21 #  define DB_ENV void
  22 #endif
  23
  24 #if defined( LDBM_USE_DBBTREE ) || defined( LDBM_USE_DBHASH )
  25
  26 /*****************************************************************
  27  *                                                               *
  28  * use berkeley db btree or hash package                         *
  29  *                                                               *
  30  *****************************************************************/
  31 #include <sys/types.h>
  32 #include <limits.h>
  33 #include <fcntl.h>
  34
  35 #ifdef HAVE_DB_185_H
  36 #       include <db_185.h>
  37 #else
  38 #       ifdef HAVE_DB1_DB_H
  39 #               include <db1/db.h>
  40 #       else
  41 #               include <db.h>
  42 #       endif
  43 #endif
  44
  45 #ifndef DB_VERSION_MAJOR
  46 #  define DB_VERSION_MAJOR 1
  47 #endif
  48 #ifndef DB_VERSION_MINOR
  49 #  define DB_VERSION_MINOR 85
  50 #endif
  51
  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
  56 #       endif
  57 #else
  58 #  define DB_ENV void
  59 #endif
  60
  61
  62 LDAP_BEGIN_DECL
  63
  64 typedef DBT     Datum;
  65 #define dsize   size
  66 #define dptr    data
  67
  68 typedef DB      *LDBM;
  69
  70
  71 /* for ldbm_open */
  72 #if DB_VERSION_MAJOR >= 2
  73 typedef DBC     LDBMCursor;
  74
  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)
  80 # else
  81 #       define LDBM_WRCREAT     (DB_NOMMAP|DB_CREATE)
  82 #       define LDBM_NEWDB       (DB_TRUNCATE|DB_CREATE)
  83 # endif
  84
  85 #else
  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)
  91 #endif
  92
  93 LDAP_END_DECL
  94
  95 /* for ldbm_open */
  96 #define LDBM_NOSYNC     0
  97 #define LDBM_SYNC       0
  98 #define LDBM_LOCKING    0
  99 #define LDBM_NOLOCKING  0
 100
 101 /* for ldbm_insert */
 102 #define LDBM_INSERT     R_NOOVERWRITE
 103 #define LDBM_REPLACE    0
 104
 105 #ifdef LDBM_USE_DBBTREE
 106 #       define LDBM_ORDERED     1
 107 #       define LDBM_SUFFIX      ".dbb"
 108 #       define DB_TYPE          DB_BTREE
 109 #else
 110 #       define LDBM_SUFFIX      ".dbh"
 111 #       define DB_TYPE          DB_HASH
 112 #endif
 113
 114 #elif defined( HAVE_GDBM )
 115
 116 /*****************************************************************
 117  *                                                               *
 118  * use gdbm if possible                                          *
 119  *                                                               *
 120  *****************************************************************/
 121
 122 #include <gdbm.h>
 123
 124 LDAP_BEGIN_DECL
 125
 126 typedef datum           Datum;
 127 typedef Datum LDBMCursor;
 128 typedef GDBM_FILE       LDBM;
 129
 130 LDAP_END_DECL
 131
 132 /* for ldbm_open */
 133 #define LDBM_READER     GDBM_READER
 134 #define LDBM_WRITER     GDBM_WRITER
 135 #define LDBM_WRCREAT    GDBM_WRCREAT
 136 #define LDBM_NEWDB      GDBM_NEWDB
 137
 138 #ifdef GDBM_FAST
 139 #define LDBM_NOSYNC     GDBM_FAST
 140 #else
 141 #define LDBM_NOSYNC     0
 142 #endif
 143
 144 #ifdef GDBM_SYNC
 145 #define LDBM_SYNC       GDBM_SYNC
 146 #else
 147 #define LDBM_SYNC       0
 148 #endif
 149
 150 #define LDBM_LOCKING    0
 151 #ifdef GDBM_NOLOCK
 152 #define LDBM_NOLOCKING  GDBM_NOLOCK
 153 #else
 154 #define LDBM_NOLOCKING  0
 155 #endif
 156
 157 #define LDBM_SUFFIX     ".gdbm"
 158
 159 /* for ldbm_insert */
 160 #define LDBM_INSERT     GDBM_INSERT
 161 #define LDBM_REPLACE    GDBM_REPLACE
 162
 163 #elif defined( HAVE_MDBM )
 164
 165 /*****************************************************************
 166  *                                                               *
 167  * use mdbm if possible                                          *
 168  *                                                               *
 169  *****************************************************************/
 170
 171 #include <mdbm.h>
 172
 173 LDAP_BEGIN_DECL
 174
 175 typedef datum           Datum;
 176 typedef int LDBMCursor;
 177 typedef MDBM            *LDBM;
 178
 179 LDAP_END_DECL
 180
 181 #include <sys/types.h>
 182 #include <sys/stat.h>
 183 #include <fcntl.h>
 184
 185 /* for ldbm_open */
 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)
 190
 191 #define LDBM_SYNC       0
 192 #define LDBM_NOSYNC     0
 193 #define LDBM_LOCKING    0
 194 #define LDBM_NOLOCKING  0
 195
 196 #define LDBM_SUFFIX     ".mdbm"
 197
 198 /* for ldbm_insert */
 199 #define LDBM_INSERT     MDBM_INSERT
 200 #define LDBM_REPLACE    MDBM_REPLACE
 201
 202 #elif defined( HAVE_NDBM )
 203
 204 /*****************************************************************
 205  *                                                               *
 206  * if none of the above use ndbm, the standard unix thing        *
 207  *                                                               *
 208  *****************************************************************/
 209
 210 #include <ndbm.h>
 211
 212 #ifdef HAVE_FCNTL_H
 213 #include <fcntl.h>
 214 #endif
 215
 216 LDAP_BEGIN_DECL
 217
 218 typedef datum   Datum;
 219 typedef int LDBMCursor;
 220 typedef DBM     *LDBM;
 221
 222 LDAP_END_DECL
 223
 224 /* for ldbm_open */
 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)
 229
 230 #define LDBM_NOSYNC     0
 231 #define LDBM_SYNC       0
 232 #define LDBM_NOLOCK     0
 233 #define LDBM_SYNC       0
 234
 235 #define LDBM_SUFFIX     ".ndbm"
 236
 237 /* for ldbm_insert */
 238 #define LDBM_INSERT     DBM_INSERT
 239 #define LDBM_REPLACE    DBM_REPLACE
 240
 241 #endif
 242
 243 LDAP_BEGIN_DECL
 244
 245 LDAP_LDBM_F (int) ldbm_initialize( const char * );
 246 LDAP_LDBM_F (int) ldbm_shutdown( void );
 247
 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 *);
 250
 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 );
 260
 261 LDAP_LDBM_F (Datum) ldbm_firstkey( LDBM ldbm, LDBMCursor **cursor );
 262 LDAP_LDBM_F (Datum) ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *cursor );
 263
 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)))
 268 #else
 269 #   define ldbm_datum_init(d) ((void)0)
 270 #endif  /* HAVE_BERKELEY_DB */
 271
 272 LDAP_END_DECL
 273
 274 #endif /* _ldbm_h_ */