git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/id2entry.c

   1 /* id2entry.c - routines to deal with the id2entry database */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2005 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 #include "portable.h"
  18
  19 #include <stdio.h>
  20 #include <ac/string.h>
  21
  22 #include "back-bdb.h"
  23
  24 static int bdb_id2entry_put(
  25         BackendDB *be,
  26         DB_TXN *tid,
  27         Entry *e,
  28         int flag )
  29 {
  30         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
  31         DB *db = bdb->bi_id2entry->bdi_db;
  32         DBT key, data;
  33         struct berval bv;
  34         int rc;
  35         ID nid;
  36 #ifdef BDB_HIER
  37         struct berval odn, ondn;
  38
  39         /* We only store rdns, and they go in the dn2id database. */
  40
  41         odn = e->e_name; ondn = e->e_nname;
  42
  43         e->e_name = slap_empty_bv;
  44         e->e_nname = slap_empty_bv;
  45 #endif
  46         DBTzero( &key );
  47
  48         /* Store ID in BigEndian format */
  49         key.data = &nid;
  50         key.size = sizeof(ID);
  51         BDB_ID2DISK( e->e_id, &nid );
  52
  53         rc = entry_encode( e, &bv );
  54 #ifdef BDB_HIER
  55         e->e_name = odn; e->e_nname = ondn;
  56 #endif
  57         if( rc != LDAP_SUCCESS ) {
  58                 return -1;
  59         }
  60
  61         DBTzero( &data );
  62         bv2DBT( &bv, &data );
  63
  64         rc = db->put( db, tid, &key, &data, flag );
  65
  66         free( bv.bv_val );
  67         return rc;
  68 }
  69
  70 /*
  71  * This routine adds (or updates) an entry on disk.
  72  * The cache should be already be updated.
  73  */
  74
  75
  76 int bdb_id2entry_add(
  77         BackendDB *be,
  78         DB_TXN *tid,
  79         Entry *e )
  80 {
  81         return bdb_id2entry_put(be, tid, e, DB_NOOVERWRITE);
  82 }
  83
  84 int bdb_id2entry_update(
  85         BackendDB *be,
  86         DB_TXN *tid,
  87         Entry *e )
  88 {
  89         return bdb_id2entry_put(be, tid, e, 0);
  90 }
  91
  92 int bdb_id2entry(
  93         BackendDB *be,
  94         DB_TXN *tid,
  95         ID id,
  96         Entry **e )
  97 {
  98         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
  99         DB *db = bdb->bi_id2entry->bdi_db;
 100         DBT key, data;
 101         struct berval bv;
 102         int rc = 0;
 103         ID nid;
 104
 105         *e = NULL;
 106
 107         DBTzero( &key );
 108         key.data = &nid;
 109         key.size = sizeof(ID);
 110         BDB_ID2DISK( id, &nid );
 111
 112         DBTzero( &data );
 113         data.flags = DB_DBT_MALLOC;
 114
 115         /* fetch it */
 116         rc = db->get( db, tid, &key, &data, bdb->bi_db_opflags );
 117
 118         if( rc != 0 ) {
 119                 return rc;
 120         }
 121
 122         DBT2bv( &data, &bv );
 123
 124 #ifdef SLAP_ZONE_ALLOC
 125         rc = entry_decode(&bv, e, bdb->bi_cache.c_zctx);
 126 #else
 127         rc = entry_decode(&bv, e);
 128 #endif
 129
 130         if( rc == 0 ) {
 131                 (*e)->e_id = id;
 132         } else {
 133                 /* only free on error. On success, the entry was
 134                  * decoded in place.
 135                  */
 136 #ifndef SLAP_ZONE_ALLOC
 137                 ch_free(data.data);
 138 #endif
 139         }
 140 #ifdef SLAP_ZONE_ALLOC
 141         ch_free(data.data);
 142 #endif
 143
 144         return rc;
 145 }
 146
 147 int bdb_id2entry_delete(
 148         BackendDB *be,
 149         DB_TXN *tid,
 150         Entry *e )
 151 {
 152         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
 153         DB *db = bdb->bi_id2entry->bdi_db;
 154         DBT key;
 155         int rc;
 156         ID nid;
 157
 158         DBTzero( &key );
 159         key.data = &nid;
 160         key.size = sizeof(ID);
 161         BDB_ID2DISK( e->e_id, &nid );
 162
 163         /* delete from database */
 164         rc = db->del( db, tid, &key, 0 );
 165
 166         return rc;
 167 }
 168
 169 #ifdef SLAP_ZONE_ALLOC
 170 int bdb_entry_return(
 171         struct bdb_info *bdb,
 172         Entry *e,
 173         int zseq
 174 )
 175 #else
 176 int bdb_entry_return(
 177         Entry *e
 178 )
 179 #endif
 180 {
 181 #ifdef SLAP_ZONE_ALLOC
 182         if (!slap_zn_validate(bdb->bi_cache.c_zctx, e, zseq)) {
 183                 return 0;
 184         }
 185 #endif
 186         /* Our entries are allocated in two blocks; the data comes from
 187          * the db itself and the Entry structure and associated pointers
 188          * are allocated in entry_decode. The db data pointer is saved
 189          * in e_bv. Since the Entry structure is allocated as a single
 190          * block, e_attrs is always a fixed offset from e. The exception
 191          * is when an entry has been modified, in which case we also need
 192          * to free e_attrs.
 193          */
 194
 195 #ifdef LDAP_COMP_MATCH
 196         comp_tree_free( e->e_attrs );
 197 #endif
 198         if( !e->e_bv.bv_val ) { /* Entry added by do_add */
 199                 entry_free( e );
 200                 return 0;
 201         }
 202         if( (void *) e->e_attrs != (void *) (e+1)) {
 203                 attrs_free( e->e_attrs );
 204         }
 205
 206         /* See if the DNs were changed by modrdn */
 207         if( e->e_nname.bv_val < e->e_bv.bv_val || e->e_nname.bv_val >
 208                 e->e_bv.bv_val + e->e_bv.bv_len ) {
 209                 ch_free(e->e_name.bv_val);
 210                 ch_free(e->e_nname.bv_val);
 211                 e->e_name.bv_val = NULL;
 212                 e->e_nname.bv_val = NULL;
 213         }
 214 #ifndef SLAP_ZONE_ALLOC
 215         /* In tool mode the e_bv buffer is realloc'd, leave it alone */
 216         if( !(slapMode & SLAP_TOOL_MODE) ) {
 217                 free( e->e_bv.bv_val );
 218         }
 219 #endif /* !SLAP_ZONE_ALLOC */
 220
 221 #ifdef SLAP_ZONE_ALLOC
 222         slap_zn_free( e, bdb->bi_cache.c_zctx );
 223 #else
 224         free( e );
 225 #endif
 226
 227         return 0;
 228 }
 229
 230 int bdb_entry_release(
 231         Operation *op,
 232         Entry *e,
 233         int rw )
 234 {
 235         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 236         struct bdb_op_info *boi = NULL;
 237
 238         /* slapMode : SLAP_SERVER_MODE, SLAP_TOOL_MODE,
 239                         SLAP_TRUNCATE_MODE, SLAP_UNDEFINED_MODE */
 240
 241         if ( slapMode == SLAP_SERVER_MODE ) {
 242                 /* If not in our cache, just free it */
 243                 if ( !e->e_private ) {
 244 #ifdef SLAP_ZONE_ALLOC
 245                         return bdb_entry_return( bdb, e, -1 );
 246 #else
 247                         return bdb_entry_return( e );
 248 #endif
 249                 }
 250                 /* free entry and reader or writer lock */
 251                 if ( op ) {
 252                         boi = (struct bdb_op_info *)op->o_private;
 253                 }
 254                 /* lock is freed with txn */
 255                 if ( !boi || boi->boi_txn ) {
 256                         bdb_unlocked_cache_return_entry_rw( &bdb->bi_cache, e, rw );
 257                 } else {
 258                         struct bdb_lock_info *bli, *prev;
 259                         for ( prev=(struct bdb_lock_info *)&boi->boi_locks,
 260                                 bli = boi->boi_locks; bli; prev=bli, bli=bli->bli_next ) {
 261                                 if ( bli->bli_id == e->e_id ) {
 262                                         bdb_cache_return_entry_rw( bdb->bi_dbenv, &bdb->bi_cache,
 263                                                 e, rw, &bli->bli_lock );
 264                                         prev->bli_next = bli->bli_next;
 265                                         op->o_tmpfree( bli, op->o_tmpmemctx );
 266                                         break;
 267                                 }
 268                         }
 269                         if ( !boi->boi_locks ) {
 270                                 op->o_tmpfree( boi, op->o_tmpmemctx );
 271                                 op->o_private = NULL;
 272                         }
 273                 }
 274         } else {
 275 #ifdef SLAP_ZONE_ALLOC
 276                 int zseq = -1;
 277                 if (e->e_private != NULL) {
 278                         BEI(e)->bei_e = NULL;
 279                         zseq = BEI(e)->bei_zseq;
 280                 }
 281 #else
 282                 if (e->e_private != NULL)
 283                         BEI(e)->bei_e = NULL;
 284 #endif
 285                 e->e_private = NULL;
 286 #ifdef SLAP_ZONE_ALLOC
 287                 bdb_entry_return ( bdb, e, zseq );
 288 #else
 289                 bdb_entry_return ( e );
 290 #endif
 291         }
 292
 293         return 0;
 294 }
 295
 296 /* return LDAP_SUCCESS IFF we can retrieve the specified entry.
 297  */
 298 int bdb_entry_get(
 299         Operation *op,
 300         struct berval *ndn,
 301         ObjectClass *oc,
 302         AttributeDescription *at,
 303         int rw,
 304         Entry **ent )
 305 {
 306         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 307         struct bdb_op_info *boi = NULL;
 308         DB_TXN *txn = NULL;
 309         Entry *e = NULL;
 310         EntryInfo *ei;
 311         int     rc;
 312         const char *at_name = at ? at->ad_cname.bv_val : "(null)";
 313
 314         u_int32_t       locker = 0;
 315         DB_LOCK         lock;
 316         int             free_lock_id = 0;
 317
 318         Debug( LDAP_DEBUG_ARGS,
 319                 "=> bdb_entry_get: ndn: \"%s\"\n", ndn->bv_val, 0, 0 );
 320         Debug( LDAP_DEBUG_ARGS,
 321                 "=> bdb_entry_get: oc: \"%s\", at: \"%s\"\n",
 322                 oc ? oc->soc_cname.bv_val : "(null)", at_name, 0);
 323
 324         if( op ) boi = (struct bdb_op_info *) op->o_private;
 325         if( boi != NULL && op->o_bd->be_private == boi->boi_bdb->be_private ) {
 326                 txn = boi->boi_txn;
 327                 locker = boi->boi_locker;
 328         }
 329
 330         if ( txn != NULL ) {
 331                 locker = TXN_ID ( txn );
 332         } else if ( !locker ) {
 333                 rc = LOCK_ID ( bdb->bi_dbenv, &locker );
 334                 free_lock_id = 1;
 335                 switch(rc) {
 336                 case 0:
 337                         break;
 338                 default:
 339                         return LDAP_OTHER;
 340                 }
 341         }
 342
 343 dn2entry_retry:
 344         /* can we find entry */
 345         rc = bdb_dn2entry( op, txn, ndn, &ei, 0, locker, &lock );
 346         switch( rc ) {
 347         case DB_NOTFOUND:
 348         case 0:
 349                 break;
 350         case DB_LOCK_DEADLOCK:
 351         case DB_LOCK_NOTGRANTED:
 352                 /* the txn must abort and retry */
 353                 if ( txn ) {
 354                         boi->boi_err = rc;
 355                         return LDAP_BUSY;
 356                 }
 357                 ldap_pvt_thread_yield();
 358                 goto dn2entry_retry;
 359         default:
 360                 if ( boi ) boi->boi_err = rc;
 361                 if ( free_lock_id ) {
 362                         LOCK_ID_FREE( bdb->bi_dbenv, locker );
 363                 }
 364                 return (rc != LDAP_BUSY) ? LDAP_OTHER : LDAP_BUSY;
 365         }
 366         if (ei) e = ei->bei_e;
 367         if (e == NULL) {
 368                 Debug( LDAP_DEBUG_ACL,
 369                         "=> bdb_entry_get: cannot find entry: \"%s\"\n",
 370                                 ndn->bv_val, 0, 0 );
 371                 if ( free_lock_id ) {
 372                         LOCK_ID_FREE( bdb->bi_dbenv, locker );
 373                 }
 374                 return LDAP_NO_SUCH_OBJECT;
 375         }
 376
 377         Debug( LDAP_DEBUG_ACL,
 378                 "=> bdb_entry_get: found entry: \"%s\"\n",
 379                 ndn->bv_val, 0, 0 );
 380
 381         /* find attribute values */
 382         if( is_entry_alias( e ) ) {
 383                 Debug( LDAP_DEBUG_ACL,
 384                         "<= bdb_entry_get: entry is an alias\n", 0, 0, 0 );
 385                 rc = LDAP_ALIAS_PROBLEM;
 386                 goto return_results;
 387         }
 388
 389         if( is_entry_referral( e ) ) {
 390                 Debug( LDAP_DEBUG_ACL,
 391                         "<= bdb_entry_get: entry is a referral\n", 0, 0, 0 );
 392                 rc = LDAP_REFERRAL;
 393                 goto return_results;
 394         }
 395
 396         if ( oc && !is_entry_objectclass( e, oc, 0 )) {
 397                 Debug( LDAP_DEBUG_ACL,
 398                         "<= bdb_entry_get: failed to find objectClass %s\n",
 399                         oc->soc_cname.bv_val, 0, 0 );
 400                 rc = LDAP_NO_SUCH_ATTRIBUTE;
 401                 goto return_results;
 402         }
 403
 404 return_results:
 405         if( rc != LDAP_SUCCESS ) {
 406                 /* free entry */
 407                 bdb_cache_return_entry_rw(bdb->bi_dbenv, &bdb->bi_cache, e, rw, &lock);
 408
 409         } else {
 410                 if ( slapMode == SLAP_SERVER_MODE ) {
 411                         *ent = e;
 412                         /* big drag. we need a place to store a read lock so we can
 413                          * release it later?? If we're in a txn, nothing is needed
 414                          * here because the locks will go away with the txn.
 415                          */
 416                         if ( op ) {
 417                                 if ( !boi ) {
 418                                         boi = op->o_tmpcalloc(1,sizeof(struct bdb_op_info),op->o_tmpmemctx);
 419                                         boi->boi_bdb = op->o_bd;
 420                                         op->o_private = boi;
 421                                 }
 422                                 if ( !boi->boi_txn ) {
 423                                         struct bdb_lock_info *bli;
 424                                         bli = op->o_tmpalloc( sizeof(struct bdb_lock_info),
 425                                                 op->o_tmpmemctx );
 426                                         bli->bli_next = boi->boi_locks;
 427                                         bli->bli_id = e->e_id;
 428                                         bli->bli_lock = lock;
 429                                         boi->boi_locks = bli;
 430                                 }
 431                         }
 432                 } else {
 433                         *ent = entry_dup( e );
 434                         bdb_cache_return_entry_rw(bdb->bi_dbenv, &bdb->bi_cache, e, rw, &lock);
 435                 }
 436         }
 437
 438         if ( free_lock_id ) {
 439                 LOCK_ID_FREE( bdb->bi_dbenv, locker );
 440         }
 441
 442         Debug( LDAP_DEBUG_TRACE,
 443                 "bdb_entry_get: rc=%d\n",
 444                 rc, 0, 0 );
 445         return(rc);
 446 }