]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/result.c
Partial revert of f30269f5d2e4bb5ee7486fe6542078d1b59dba6d
[openldap] / servers / slapd / result.c
index 33a5ee1c5f844e415a6e9cb125063f20c9e1b13f..854e822017ea13032de9e0a54846af181a2b7b1a 100644 (file)
@@ -2,7 +2,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 1998-2009 The OpenLDAP Foundation.
+ * Copyright 1998-2012 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -132,6 +132,153 @@ slap_req2res( ber_tag_t tag )
        return tag;
 }
 
+/* SlapReply debugging, prodo-slap.h overrides it in OpenLDAP releases */
+#if defined(LDAP_TEST) || (defined(USE_RS_ASSERT) && (USE_RS_ASSERT))
+
+int rs_suppress_assert = 0;
+
+/* RS_ASSERT() helper function */
+void rs_assert_(const char*file, unsigned line, const char*fn, const char*cond)
+{
+       int no_assert = rs_suppress_assert, save_errno = errno;
+       const char *s;
+
+       if ( no_assert >= 0 ) {
+               if ( no_assert == 0 && (s = getenv( "NO_RS_ASSERT" )) && *s ) {
+                       no_assert = rs_suppress_assert = atoi( s );
+               }
+               if ( no_assert > 0 ) {
+                       errno = save_errno;
+                       return;
+               }
+       }
+
+#ifdef rs_assert_      /* proto-slap.h #defined away the fn parameter */
+       fprintf( stderr,"%s:%u: "  "RS_ASSERT(%s) failed.\n", file,line,cond );
+#else
+       fprintf( stderr,"%s:%u: %s: RS_ASSERT(%s) failed.\n", file,line,fn,cond );
+#endif
+       fflush( stderr );
+
+       errno = save_errno;
+       /* $NO_RS_ASSERT > 0: ignore rs_asserts, 0: abort, < 0: just warn */
+       if ( !no_assert /* from $NO_RS_ASSERT */ ) abort();
+}
+
+/* SlapReply is consistent */
+void
+(rs_assert_ok)( const SlapReply *rs )
+{
+       const slap_mask_t flags = rs->sr_flags;
+
+       if ( flags & REP_ENTRY_MASK ) {
+               RS_ASSERT( !(flags & REP_ENTRY_MUSTRELEASE)
+                       || !(flags & (REP_ENTRY_MASK ^ REP_ENTRY_MUSTRELEASE)) );
+               RS_ASSERT( rs->sr_entry != NULL );
+               RS_ASSERT( (1 << rs->sr_type) &
+                       ((1 << REP_SEARCH) | (1 << REP_SEARCHREF) |
+                        (1 << REP_RESULT) | (1 << REP_GLUE_RESULT)) );
+       }
+#if defined(USE_RS_ASSERT) && (USE_RS_ASSERT) > 1 /* TODO: Enable when safe */
+       if ( (flags & (REP_MATCHED_MASK | REP_REF_MASK | REP_CTRLS_MASK)) ) {
+               RS_ASSERT( !(flags & REP_MATCHED_MASK) || rs->sr_matched );
+               RS_ASSERT( !(flags & REP_CTRLS_MASK  ) || rs->sr_ctrls   );
+               /* Note: LDAP_REFERRAL + !sr_ref is OK, becomes LDAP_NO_SUCH_OBJECT */
+       }
+#if (USE_RS_ASSERT) > 2
+       if ( rs->sr_err == LDAP_SUCCESS ) {
+               RS_ASSERT( rs->sr_text == NULL );
+               RS_ASSERT( rs->sr_matched == NULL );
+       }
+#endif
+#endif
+}
+
+/* Ready for calling a new backend operation */
+void
+(rs_assert_ready)( const SlapReply *rs )
+{
+       RS_ASSERT( !rs->sr_entry   );
+#if defined(USE_RS_ASSERT) && (USE_RS_ASSERT) > 1 /* TODO: Enable when safe */
+       RS_ASSERT( !rs->sr_text    );
+       RS_ASSERT( !rs->sr_ref     );
+       RS_ASSERT( !rs->sr_matched );
+       RS_ASSERT( !rs->sr_ctrls   );
+       RS_ASSERT( !rs->sr_flags   );
+#if (USE_RS_ASSERT) > 2
+       RS_ASSERT( rs->sr_err == LDAP_SUCCESS );
+#endif
+#else
+       RS_ASSERT( !(rs->sr_flags & REP_ENTRY_MASK) );
+#endif
+}
+
+/* Backend operation done */
+void
+(rs_assert_done)( const SlapReply *rs )
+{
+#if defined(USE_RS_ASSERT) && (USE_RS_ASSERT) > 1 /* TODO: Enable when safe */
+       RS_ASSERT( !(rs->sr_flags & ~(REP_ENTRY_MODIFIABLE|REP_NO_OPERATIONALS)) );
+       rs_assert_ok( rs );
+#else
+       RS_ASSERT( !(rs->sr_flags & REP_ENTRY_MUSTFLUSH) );
+#endif
+}
+
+#endif /* LDAP_TEST || USE_RS_ASSERT */
+
+/* Reset a used SlapReply whose contents has been flushed (freed/released) */
+void
+(rs_reinit)( SlapReply *rs, slap_reply_t type )
+{
+       rs_reinit( rs, type );          /* proto-slap.h macro */
+}
+
+/* Obey and clear rs->sr_flags & REP_ENTRY_MASK.  Clear sr_entry if freed. */
+void
+rs_flush_entry( Operation *op, SlapReply *rs, slap_overinst *on )
+{
+       rs_assert_ok( rs );
+
+       if ( (rs->sr_flags & REP_ENTRY_MUSTFLUSH) && rs->sr_entry != NULL ) {
+               if ( !(rs->sr_flags & REP_ENTRY_MUSTRELEASE) ) {
+                       entry_free( rs->sr_entry );
+               } else if ( on != NULL ) {
+                       overlay_entry_release_ov( op, rs->sr_entry, 0, on );
+               } else {
+                       be_entry_release_rw( op, rs->sr_entry, 0 );
+               }
+               rs->sr_entry = NULL;
+       }
+
+       rs->sr_flags &= ~REP_ENTRY_MASK;
+}
+
+/* Set rs->sr_entry after obeying and clearing sr_flags & REP_ENTRY_MASK. */
+void
+rs_replace_entry( Operation *op, SlapReply *rs, slap_overinst *on, Entry *e )
+{
+       rs_flush_entry( op, rs, on );
+       rs->sr_entry = e;
+}
+
+/*
+ * Ensure rs->sr_entry is modifiable, by duplicating it if necessary.
+ * Obey sr_flags.  Set REP_ENTRY_<MODIFIABLE, and MUSTBEFREED if duplicated>.
+ * Return nonzero if rs->sr_entry was replaced.
+ */
+int
+rs_entry2modifiable( Operation *op, SlapReply *rs, slap_overinst *on )
+{
+       if ( rs->sr_flags & REP_ENTRY_MODIFIABLE ) {
+               rs_assert_ok( rs );
+               return 0;
+       }
+       rs_replace_entry( op, rs, on, entry_dup( rs->sr_entry ));
+       rs->sr_flags |= REP_ENTRY_MODIFIABLE | REP_ENTRY_MUSTBEFREED;
+       return 1;
+}
+
 static long send_ldap_ber(
        Operation *op,
        BerElement *ber )
@@ -222,9 +369,11 @@ static long send_ldap_ber(
 
                ldap_pvt_thread_mutex_unlock( &conn->c_write1_mutex );
                ldap_pvt_thread_mutex_unlock( &conn->c_mutex );
+               ldap_pvt_thread_pool_idle( &connection_pool );
                ldap_pvt_thread_cond_wait( &conn->c_write2_cv, &conn->c_write2_mutex );
                conn->c_writewaiter = 0;
                ldap_pvt_thread_mutex_unlock( &conn->c_write2_mutex );
+               ldap_pvt_thread_pool_unidle( &connection_pool );
                ldap_pvt_thread_mutex_lock( &conn->c_write1_mutex );
                if ( conn->c_writers < 0 ) {
                        ret = 0;
@@ -423,7 +572,8 @@ send_ldap_response(
        int             rc = LDAP_SUCCESS;
        long    bytes;
 
-       if (( rs->sr_err == SLAPD_ABANDON || op->o_abandon ) && !op->o_cancel ) {
+       /* op was actually aborted, bypass everything if client didn't Cancel */
+       if (( rs->sr_err == SLAPD_ABANDON ) && !op->o_cancel ) {
                rc = SLAPD_ABANDON;
                goto clean2;
        }
@@ -435,6 +585,12 @@ send_ldap_response(
                }
        }
 
+       /* op completed, connection aborted, bypass sending response */
+       if ( op->o_abandon && !op->o_cancel ) {
+               rc = SLAPD_ABANDON;
+               goto clean2;
+       }
+
 #ifdef LDAP_CONNECTIONLESS
        if (op->o_conn && op->o_conn->c_is_udp)
                ber = op->o_res_ber;
@@ -613,15 +769,18 @@ send_ldap_disconnect( Operation   *op, SlapReply *rs )
        || (e) == LDAP_STRONG_AUTH_REQUIRED \
        || (e) == LDAP_UNAVAILABLE )
 
+       Debug( LDAP_DEBUG_TRACE,
+               "send_ldap_disconnect %d:%s\n",
+               rs->sr_err, rs->sr_text ? rs->sr_text : "", NULL );
        assert( LDAP_UNSOLICITED_ERROR( rs->sr_err ) );
 
+       /* TODO: Flush the entry if sr_type == REP_SEARCH/REP_SEARCHREF? */
+       RS_ASSERT( !(rs->sr_flags & REP_ENTRY_MASK) );
+       rs->sr_flags &= ~REP_ENTRY_MASK;        /* paranoia */
+
        rs->sr_type = REP_EXTENDED;
        rs->sr_rspdata = NULL;
 
-       Debug( LDAP_DEBUG_TRACE,
-               "send_ldap_disconnect %d:%s\n",
-               rs->sr_err, rs->sr_text ? rs->sr_text : "", NULL );
-
        if ( op->o_protocol < LDAP_VERSION3 ) {
                rs->sr_rspoid = NULL;
                rs->sr_tag = slap_req2res( op->o_tag );
@@ -654,25 +813,20 @@ slap_send_ldap_result( Operation *op, SlapReply *rs )
        if ( rs->sr_err == SLAPD_ABANDON || op->o_abandon )
                goto abandon;
 
-       assert( !LDAP_API_ERROR( rs->sr_err ) );
-
        Debug( LDAP_DEBUG_TRACE,
                "send_ldap_result: %s p=%d\n",
                op->o_log_prefix, op->o_protocol, 0 );
-
        Debug( LDAP_DEBUG_ARGS,
                "send_ldap_result: err=%d matched=\"%s\" text=\"%s\"\n",
                rs->sr_err, rs->sr_matched ? rs->sr_matched : "",
                rs->sr_text ? rs->sr_text : "" );
-
-
        if( rs->sr_ref ) {
                Debug( LDAP_DEBUG_ARGS,
                        "send_ldap_result: referral=\"%s\"\n",
                        rs->sr_ref[0].bv_val ? rs->sr_ref[0].bv_val : "NULL",
                        NULL, NULL );
        }
-
+       assert( !LDAP_API_ERROR( rs->sr_err ) );
        assert( rs->sr_err != LDAP_PARTIAL_RESULTS );
 
        if ( rs->sr_err == LDAP_REFERRAL ) {
@@ -725,11 +879,14 @@ abandon:
 void
 send_ldap_sasl( Operation *op, SlapReply *rs )
 {
-       rs->sr_type = REP_SASL;
        Debug( LDAP_DEBUG_TRACE, "send_ldap_sasl: err=%d len=%ld\n",
                rs->sr_err,
                rs->sr_sasldata ? (long) rs->sr_sasldata->bv_len : -1, NULL );
 
+       RS_ASSERT( !(rs->sr_flags & REP_ENTRY_MASK) );
+       rs->sr_flags &= ~REP_ENTRY_MASK;        /* paranoia */
+
+       rs->sr_type = REP_SASL;
        rs->sr_tag = slap_req2res( op->o_tag );
        rs->sr_msgid = (rs->sr_tag != LBER_SEQUENCE) ? op->o_msgid : 0;
 
@@ -744,14 +901,16 @@ send_ldap_sasl( Operation *op, SlapReply *rs )
 void
 slap_send_ldap_extended( Operation *op, SlapReply *rs )
 {
-       rs->sr_type = REP_EXTENDED;
-
        Debug( LDAP_DEBUG_TRACE,
                "send_ldap_extended: err=%d oid=%s len=%ld\n",
                rs->sr_err,
                rs->sr_rspoid ? rs->sr_rspoid : "",
                rs->sr_rspdata != NULL ? rs->sr_rspdata->bv_len : 0 );
 
+       RS_ASSERT( !(rs->sr_flags & REP_ENTRY_MASK) );
+       rs->sr_flags &= ~REP_ENTRY_MASK;        /* paranoia */
+
+       rs->sr_type = REP_EXTENDED;
        rs->sr_tag = slap_req2res( op->o_tag );
        rs->sr_msgid = (rs->sr_tag != LBER_SEQUENCE) ? op->o_msgid : 0;
 
@@ -766,12 +925,16 @@ slap_send_ldap_extended( Operation *op, SlapReply *rs )
 void
 slap_send_ldap_intermediate( Operation *op, SlapReply *rs )
 {
-       rs->sr_type = REP_INTERMEDIATE;
        Debug( LDAP_DEBUG_TRACE,
                "send_ldap_intermediate: err=%d oid=%s len=%ld\n",
                rs->sr_err,
                rs->sr_rspoid ? rs->sr_rspoid : "",
                rs->sr_rspdata != NULL ? rs->sr_rspdata->bv_len : 0 );
+
+       RS_ASSERT( !(rs->sr_flags & REP_ENTRY_MASK) );
+       rs->sr_flags &= ~REP_ENTRY_MASK;        /* paranoia */
+
+       rs->sr_type = REP_INTERMEDIATE;
        rs->sr_tag = LDAP_RES_INTERMEDIATE;
        rs->sr_msgid = op->o_msgid;
        if ( send_ldap_response( op, rs ) == SLAP_CB_CONTINUE ) {
@@ -810,19 +973,21 @@ slap_send_search_entry( Operation *op, SlapReply *rs )
         */
        char **e_flags = NULL;
 
+       rs->sr_type = REP_SEARCH;
+
        if ( op->ors_slimit >= 0 && rs->sr_nentries >= op->ors_slimit ) {
-               return LDAP_SIZELIMIT_EXCEEDED;
+               rc = LDAP_SIZELIMIT_EXCEEDED;
+               goto error_return;
        }
 
        /* Every 64 entries, check for thread pool pause */
        if ( ( ( rs->sr_nentries & 0x3f ) == 0x3f ) &&
                ldap_pvt_thread_pool_pausing( &connection_pool ) > 0 )
        {
-               return LDAP_BUSY;
+               rc = LDAP_BUSY;
+               goto error_return;
        }
 
-       rs->sr_type = REP_SEARCH;
-
        /* eventually will loop through generated operational attribute types
         * currently implemented types include:
         *      entryDN, subschemaSubentry, and hasSubordinates */
@@ -888,7 +1053,8 @@ slap_send_search_entry( Operation *op, SlapReply *rs )
 #endif
        if ( op->o_res_ber ) {
                /* read back control */
-           rc = ber_printf( ber, "{O{" /*}}*/, &rs->sr_entry->e_name );
+           rc = ber_printf( ber, "t{O{" /*}}*/,
+                       LDAP_RES_SEARCH_ENTRY, &rs->sr_entry->e_name );
        } else {
            rc = ber_printf( ber, "{it{O{" /*}}}*/, op->o_msgid,
                        LDAP_RES_SEARCH_ENTRY, &rs->sr_entry->e_name );
@@ -1139,6 +1305,10 @@ slap_send_search_entry( Operation *op, SlapReply *rs )
                                {
                                        continue;
                                }
+                               /* if DSA-specific and replicating, skip */
+                               if ( op->o_sync != SLAP_CONTROL_NONE &&
+                                       desc->ad_type->sat_usage == LDAP_SCHEMA_DSA_OPERATION )
+                                       continue;
                        } else {
                                if ( !userattrs && !ad_inlist( desc, rs->sr_attrs ) ) {
                                        continue;
@@ -1250,11 +1420,7 @@ slap_send_search_entry( Operation *op, SlapReply *rs )
        Statslog( LDAP_DEBUG_STATS2, "%s ENTRY dn=\"%s\"\n",
            op->o_log_prefix, rs->sr_entry->e_nname.bv_val, 0, 0, 0 );
 
-       if ( rs->sr_flags & REP_ENTRY_MUSTRELEASE ) {
-               be_entry_release_rw( op, rs->sr_entry, 0 );
-               rs->sr_flags ^= REP_ENTRY_MUSTRELEASE;
-               rs->sr_entry = NULL;
-       }
+       rs_flush_entry( op, rs, NULL );
 
        if ( op->o_res_ber == NULL ) {
                bytes = send_ldap_ber( op, ber );
@@ -1291,25 +1457,25 @@ error_return:;
                slap_sl_free( e_flags, op->o_tmpmemctx );
        }
 
+       /* FIXME: Can break if rs now contains an extended response */
        if ( rs->sr_operational_attrs ) {
                attrs_free( rs->sr_operational_attrs );
                rs->sr_operational_attrs = NULL;
        }
        rs->sr_attr_flags = SLAP_ATTRS_UNDEFINED;
 
-       /* FIXME: I think rs->sr_type should be explicitly set to
-        * REP_SEARCH here. That's what it was when we entered this
-        * function. send_ldap_error may have changed it, but we
-        * should set it back so that the cleanup functions know
-        * what they're doing.
-        */
-       if ( op->o_tag == LDAP_REQ_SEARCH && rs->sr_type == REP_SEARCH 
-               && rs->sr_entry 
-               && ( rs->sr_flags & REP_ENTRY_MUSTBEFREED ) ) 
-       {
-               entry_free( rs->sr_entry );
-               rs->sr_entry = NULL;
-               rs->sr_flags &= ~REP_ENTRY_MUSTBEFREED;
+       if ( op->o_tag == LDAP_REQ_SEARCH && rs->sr_type == REP_SEARCH ) {
+               rs_flush_entry( op, rs, NULL );
+       } else {
+               RS_ASSERT( (rs->sr_flags & REP_ENTRY_MASK) == 0 );
+       }
+
+       if ( rs->sr_flags & REP_CTRLS_MUSTBEFREED ) {
+               rs->sr_flags ^= REP_CTRLS_MUSTBEFREED; /* paranoia */
+               if ( rs->sr_ctrls ) {
+                       slap_free_ctrls( op, rs->sr_ctrls );
+                       rs->sr_ctrls = NULL;
+               }
        }
 
        return( rc );
@@ -1420,12 +1586,7 @@ slap_send_search_reference( Operation *op, SlapReply *rs )
        }
 
        rc = 0;
-       if ( rs->sr_flags & REP_ENTRY_MUSTRELEASE ) {
-               assert( rs->sr_entry != NULL );
-               be_entry_release_rw( op, rs->sr_entry, 0 );
-               rs->sr_flags ^= REP_ENTRY_MUSTRELEASE;
-               rs->sr_entry = NULL;
-       }
+       rs_flush_entry( op, rs, NULL );
 
 #ifdef LDAP_CONNECTIONLESS
        if (!op->o_conn || op->o_conn->c_is_udp == 0) {
@@ -1461,11 +1622,23 @@ slap_send_search_reference( Operation *op, SlapReply *rs )
 
        Debug( LDAP_DEBUG_TRACE, "<= send_search_reference\n", 0, 0, 0 );
 
+       if ( 0 ) {
 rel:
+           rs_flush_entry( op, rs, NULL );
+       }
+
        if ( op->o_callback ) {
                (void)slap_cleanup_play( op, rs );
        }
 
+       if ( rs->sr_flags & REP_CTRLS_MUSTBEFREED ) {
+               rs->sr_flags ^= REP_CTRLS_MUSTBEFREED; /* paranoia */
+               if ( rs->sr_ctrls ) {
+                       slap_free_ctrls( op, rs->sr_ctrls );
+                       rs->sr_ctrls = NULL;
+               }
+       }
+
        return rc;
 }
 
@@ -1527,15 +1700,16 @@ str2result(
                                continue;
                        }
 
-                       while ( isspace( (unsigned char) next[ 0 ] ) ) next++;
-                       if ( next[ 0 ] != '\0' ) {
+                       while ( isspace( (unsigned char) next[ 0 ] ) && next[ 0 ] != '\n' )
+                               next++;
+                       if ( next[ 0 ] != '\0' && next[ 0 ] != '\n' ) {
                                Debug( LDAP_DEBUG_ANY, "str2result (%s) extra cruft after value\n",
                                    s, 0, 0 );
                                rc = -1;
                                continue;
                        }
 
-                       /* FIXME: what if it's larger that max int? */
+                       /* FIXME: what if it's larger than max int? */
                        *code = (int)retcode;
 
                } else if ( strncasecmp( s, "matched", STRLENOF( "matched" ) ) == 0 ) {
@@ -1591,6 +1765,7 @@ int slap_read_controls(
        myop.o_res_ber = ber;
        myop.o_callback = NULL;
        myop.ors_slimit = 1;
+       myop.ors_attrsonly = 0;
 
        rc = slap_send_search_entry( &myop, rs );
        if( rc ) return rc;