external/bsd/openldap/dist/servers/slapd/back-bdb/id2entry.c

   1 /* id2entry.c - routines to deal with the id2entry database */
   2 /* $OpenLDAP: pkg/ldap/servers/slapd/back-bdb/id2entry.c,v 1.72.2.6 2008/05/01 21:39:35 quanah Exp $ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2008 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 #include <ac/errno.h>
  22
  23 #include "back-bdb.h"
  24
  25 static int bdb_id2entry_put(
  26         BackendDB *be,
  27         DB_TXN *tid,
  28         Entry *e,
  29         int flag )
  30 {
  31         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
  32         DB *db = bdb->bi_id2entry->bdi_db;
  33         DBT key, data;
  34         struct berval bv;
  35         int rc;
  36         ID nid;
  37 #ifdef BDB_HIER
  38         struct berval odn, ondn;
  39
  40         /* We only store rdns, and they go in the dn2id database. */
  41
  42         odn = e->e_name; ondn = e->e_nname;
  43
  44         e->e_name = slap_empty_bv;
  45         e->e_nname = slap_empty_bv;
  46 #endif
  47         DBTzero( &key );
  48
  49         /* Store ID in BigEndian format */
  50         key.data = &nid;
  51         key.size = sizeof(ID);
  52         BDB_ID2DISK( e->e_id, &nid );
  53
  54         rc = entry_encode( e, &bv );
  55 #ifdef BDB_HIER
  56         e->e_name = odn; e->e_nname = ondn;
  57 #endif
  58         if( rc != LDAP_SUCCESS ) {
  59                 return -1;
  60         }
  61
  62         DBTzero( &data );
  63         bv2DBT( &bv, &data );
  64
  65         rc = db->put( db, tid, &key, &data, flag );
  66
  67         free( bv.bv_val );
  68         return rc;
  69 }
  70
  71 /*
  72  * This routine adds (or updates) an entry on disk.
  73  * The cache should be already be updated.
  74  */
  75
  76
  77 int bdb_id2entry_add(
  78         BackendDB *be,
  79         DB_TXN *tid,
  80         Entry *e )
  81 {
  82         return bdb_id2entry_put(be, tid, e, DB_NOOVERWRITE);
  83 }
  84
  85 int bdb_id2entry_update(
  86         BackendDB *be,
  87         DB_TXN *tid,
  88         Entry *e )
  89 {
  90         return bdb_id2entry_put(be, tid, e, 0);
  91 }
  92
  93 int bdb_id2entry(
  94         BackendDB *be,
  95         DB_TXN *tid,
  96         BDB_LOCKER locker,
  97         ID id,
  98         Entry **e )
  99 {
 100         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
 101         DB *db = bdb->bi_id2entry->bdi_db;
 102         DBT key, data;
 103         DBC *cursor;
 104         EntryHeader eh;
 105         char buf[16];
 106         int rc = 0, off;
 107         ID nid;
 108
 109         *e = NULL;
 110
 111         DBTzero( &key );
 112         key.data = &nid;
 113         key.size = sizeof(ID);
 114         BDB_ID2DISK( id, &nid );
 115
 116         DBTzero( &data );
 117         data.flags = DB_DBT_USERMEM | DB_DBT_PARTIAL;
 118
 119         /* fetch it */
 120         rc = db->cursor( db, tid, &cursor, bdb->bi_db_opflags );
 121         if ( rc ) return rc;
 122
 123         /* Use our own locker if needed */
 124         if ( !tid && locker ) {
 125                 CURSOR_SETLOCKER( cursor, locker );
 126         }
 127
 128         /* Get the nattrs / nvals counts first */
 129         data.ulen = data.dlen = sizeof(buf);
 130         data.data = buf;
 131         rc = cursor->c_get( cursor, &key, &data, DB_SET );
 132         if ( rc ) goto finish;
 133
 134
 135         eh.bv.bv_val = buf;
 136         eh.bv.bv_len = data.size;
 137         rc = entry_header( &eh );
 138         if ( rc ) goto finish;
 139
 140         /* Get the size */
 141         data.flags ^= DB_DBT_PARTIAL;
 142         data.ulen = 0;
 143         rc = cursor->c_get( cursor, &key, &data, DB_CURRENT );
 144         if ( rc != DB_BUFFER_SMALL ) goto finish;
 145
 146         /* Allocate a block and retrieve the data */
 147         off = eh.data - eh.bv.bv_val;
 148         eh.bv.bv_len = eh.nvals * sizeof( struct berval ) + data.size;
 149         eh.bv.bv_val = ch_malloc( eh.bv.bv_len );
 150         eh.data = eh.bv.bv_val + eh.nvals * sizeof( struct berval );
 151         data.data = eh.data;
 152         data.ulen = data.size;
 153
 154         /* skip past already parsed nattr/nvals */
 155         eh.data += off;
 156
 157         rc = cursor->c_get( cursor, &key, &data, DB_CURRENT );
 158
 159 finish:
 160         cursor->c_close( cursor );
 161
 162         if( rc != 0 ) {
 163                 return rc;
 164         }
 165
 166 #ifdef SLAP_ZONE_ALLOC
 167         rc = entry_decode(&eh, e, bdb->bi_cache.c_zctx);
 168 #else
 169         rc = entry_decode(&eh, e);
 170 #endif
 171
 172         if( rc == 0 ) {
 173                 (*e)->e_id = id;
 174         } else {
 175                 /* only free on error. On success, the entry was
 176                  * decoded in place.
 177                  */
 178 #ifndef SLAP_ZONE_ALLOC
 179                 ch_free(eh.bv.bv_val);
 180 #endif
 181         }
 182 #ifdef SLAP_ZONE_ALLOC
 183         ch_free(eh.bv.bv_val);
 184 #endif
 185
 186         return rc;
 187 }
 188
 189 int bdb_id2entry_delete(
 190         BackendDB *be,
 191         DB_TXN *tid,
 192         Entry *e )
 193 {
 194         struct bdb_info *bdb = (struct bdb_info *) be->be_private;
 195         DB *db = bdb->bi_id2entry->bdi_db;
 196         DBT key;
 197         int rc;
 198         ID nid;
 199
 200         DBTzero( &key );
 201         key.data = &nid;
 202         key.size = sizeof(ID);
 203         BDB_ID2DISK( e->e_id, &nid );
 204
 205         /* delete from database */
 206         rc = db->del( db, tid, &key, 0 );
 207
 208         return rc;
 209 }
 210
 211 int bdb_entry_return(
 212         Entry *e
 213 )
 214 {
 215         /* Our entries are allocated in two blocks; the data comes from
 216          * the db itself and the Entry structure and associated pointers
 217          * are allocated in entry_decode. The db data pointer is saved
 218          * in e_bv.
 219          */
 220         if ( e->e_bv.bv_val ) {
 221                 /* See if the DNs were changed by modrdn */
 222                 if( e->e_nname.bv_val < e->e_bv.bv_val || e->e_nname.bv_val >
 223                         e->e_bv.bv_val + e->e_bv.bv_len ) {
 224                         ch_free(e->e_name.bv_val);
 225                         ch_free(e->e_nname.bv_val);
 226                 }
 227                 e->e_name.bv_val = NULL;
 228                 e->e_nname.bv_val = NULL;
 229                 /* In tool mode the e_bv buffer is realloc'd, leave it alone */
 230                 if( !(slapMode & SLAP_TOOL_MODE) ) {
 231                         free( e->e_bv.bv_val );
 232                 }
 233                 BER_BVZERO( &e->e_bv );
 234         }
 235         entry_free( e );
 236         return 0;
 237 }
 238
 239 int bdb_entry_release(
 240         Operation *op,
 241         Entry *e,
 242         int rw )
 243 {
 244         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 245         struct bdb_op_info *boi;
 246         OpExtra *oex;
 247
 248         /* slapMode : SLAP_SERVER_MODE, SLAP_TOOL_MODE,
 249                         SLAP_TRUNCATE_MODE, SLAP_UNDEFINED_MODE */
 250
 251         if ( slapMode == SLAP_SERVER_MODE ) {
 252                 /* If not in our cache, just free it */
 253                 if ( !e->e_private ) {
 254 #ifdef SLAP_ZONE_ALLOC
 255                         return bdb_entry_return( bdb, e, -1 );
 256 #else
 257                         return bdb_entry_return( e );
 258 #endif
 259                 }
 260                 /* free entry and reader or writer lock */
 261                 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
 262                         if ( oex->oe_key == bdb ) break;
 263                 }
 264                 boi = (struct bdb_op_info *)oex;
 265
 266                 /* lock is freed with txn */
 267                 if ( !boi || boi->boi_txn ) {
 268                         bdb_unlocked_cache_return_entry_rw( bdb, e, rw );
 269                 } else {
 270                         struct bdb_lock_info *bli, *prev;
 271                         for ( prev=(struct bdb_lock_info *)&boi->boi_locks,
 272                                 bli = boi->boi_locks; bli; prev=bli, bli=bli->bli_next ) {
 273                                 if ( bli->bli_id == e->e_id ) {
 274                                         bdb_cache_return_entry_rw( bdb, e, rw, &bli->bli_lock );
 275                                         prev->bli_next = bli->bli_next;
 276                                         op->o_tmpfree( bli, op->o_tmpmemctx );
 277                                         break;
 278                                 }
 279                         }
 280                         if ( !boi->boi_locks ) {
 281                                 LDAP_SLIST_REMOVE( &op->o_extra, &boi->boi_oe, OpExtra, oe_next );
 282                                 op->o_tmpfree( boi, op->o_tmpmemctx );
 283                         }
 284                 }
 285         } else {
 286 #ifdef SLAP_ZONE_ALLOC
 287                 int zseq = -1;
 288                 if (e->e_private != NULL) {
 289                         BEI(e)->bei_e = NULL;
 290                         zseq = BEI(e)->bei_zseq;
 291                 }
 292 #else
 293                 if (e->e_private != NULL)
 294                         BEI(e)->bei_e = NULL;
 295 #endif
 296                 e->e_private = NULL;
 297 #ifdef SLAP_ZONE_ALLOC
 298                 bdb_entry_return ( bdb, e, zseq );
 299 #else
 300                 bdb_entry_return ( e );
 301 #endif
 302         }
 303
 304         return 0;
 305 }
 306
 307 /* return LDAP_SUCCESS IFF we can retrieve the specified entry.
 308  */
 309 int bdb_entry_get(
 310         Operation *op,
 311         struct berval *ndn,
 312         ObjectClass *oc,
 313         AttributeDescription *at,
 314         int rw,
 315         Entry **ent )
 316 {
 317         struct bdb_info *bdb = (struct bdb_info *) op->o_bd->be_private;
 318         struct bdb_op_info *boi = NULL;
 319         DB_TXN *txn = NULL;
 320         Entry *e = NULL;
 321         EntryInfo *ei;
 322         int     rc;
 323         const char *at_name = at ? at->ad_cname.bv_val : "(null)";
 324
 325         BDB_LOCKER      locker = 0;
 326         DB_LOCK         lock;
 327         int             free_lock_id = 0;
 328
 329         Debug( LDAP_DEBUG_ARGS,
 330                 "=> bdb_entry_get: ndn: \"%s\"\n", ndn->bv_val, 0, 0 );
 331         Debug( LDAP_DEBUG_ARGS,
 332                 "=> bdb_entry_get: oc: \"%s\", at: \"%s\"\n",
 333                 oc ? oc->soc_cname.bv_val : "(null)", at_name, 0);
 334
 335         if( op ) {
 336                 OpExtra *oex;
 337                 LDAP_SLIST_FOREACH( oex, &op->o_extra, oe_next ) {
 338                         if ( oex->oe_key == bdb ) break;
 339                 }
 340                 boi = (struct bdb_op_info *)oex;
 341                 if ( boi )
 342                         txn = boi->boi_txn;
 343         }
 344
 345         if ( txn != NULL ) {
 346                 locker = TXN_ID ( txn );
 347         } else {
 348                 rc = LOCK_ID ( bdb->bi_dbenv, &locker );
 349                 free_lock_id = 1;
 350                 switch(rc) {
 351                 case 0:
 352                         break;
 353                 default:
 354                         return LDAP_OTHER;
 355                 }
 356         }
 357
 358 dn2entry_retry:
 359         /* can we find entry */
 360         rc = bdb_dn2entry( op, txn, ndn, &ei, 0, locker, &lock );
 361         switch( rc ) {
 362         case DB_NOTFOUND:
 363         case 0:
 364                 break;
 365         case DB_LOCK_DEADLOCK:
 366         case DB_LOCK_NOTGRANTED:
 367                 /* the txn must abort and retry */
 368                 if ( txn ) {
 369                         boi->boi_err = rc;
 370                         return LDAP_BUSY;
 371                 }
 372                 ldap_pvt_thread_yield();
 373                 goto dn2entry_retry;
 374         default:
 375                 if ( boi ) boi->boi_err = rc;
 376                 if ( free_lock_id ) {
 377                         LOCK_ID_FREE( bdb->bi_dbenv, locker );
 378                 }
 379                 return (rc != LDAP_BUSY) ? LDAP_OTHER : LDAP_BUSY;
 380         }
 381         if (ei) e = ei->bei_e;
 382         if (e == NULL) {
 383                 Debug( LDAP_DEBUG_ACL,
 384                         "=> bdb_entry_get: cannot find entry: \"%s\"\n",
 385                                 ndn->bv_val, 0, 0 );
 386                 if ( free_lock_id ) {
 387                         LOCK_ID_FREE( bdb->bi_dbenv, locker );
 388                 }
 389                 return LDAP_NO_SUCH_OBJECT;
 390         }
 391
 392         Debug( LDAP_DEBUG_ACL,
 393                 "=> bdb_entry_get: found entry: \"%s\"\n",
 394                 ndn->bv_val, 0, 0 );
 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, 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_oe.oe_key = bdb;
 420                                         LDAP_SLIST_INSERT_HEAD( &op->o_extra, &boi->boi_oe, oe_next );
 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, 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 }