]> git.sur5r.net Git - openldap/blobdiff - servers/slapd/result.c
Add link to FAQ entry on BDB tuning
[openldap] / servers / slapd / result.c
index f256888426dd159aa977e7874dd959ee527ea67e..f14e17972de2230e9eb878926ae672b44ec8ca39 100644 (file)
@@ -2,7 +2,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 1998-2005 The OpenLDAP Foundation.
+ * Copyright 1998-2006 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -286,6 +286,144 @@ send_ldap_controls( Operation *o, BerElement *ber, LDAPControl **c )
        return rc;
 }
 
+/*
+ * slap_response_play()
+ *
+ * plays the callback list; rationale: a callback can
+ *   - remove itself from the list, by setting op->o_callback = NULL;
+ *     malloc()'ed callbacks should free themselves from inside the
+ *     sc_response() function.
+ *   - replace itself with another (list of) callback(s), by setting
+ *     op->o_callback = a new (list of) callback(s); in this case, it
+ *     is the callback's responsibility to to append existing subsequent
+ *     callbacks to the end of the list that is passed to the sc_response()
+ *     function.
+ *   - modify the list of subsequent callbacks by modifying the value
+ *     of the sc_next field from inside the sc_response() function; this
+ *     case does not require any handling from inside slap_response_play()
+ *
+ * To stop execution of the playlist, the sc_response() function must return
+ * a value different from SLAP_SC_CONTINUE.
+ *
+ * The same applies to slap_cleanup_play(); only, there is no means to stop
+ * execution of the playlist, since all cleanup functions must be called.
+ */
+static int
+slap_response_play(
+       Operation *op,
+       SlapReply *rs )
+{
+       int rc;
+
+#ifdef LDAP_DEVEL
+       slap_callback   *sc = op->o_callback, **scp;
+
+       rc = SLAP_CB_CONTINUE;
+       for ( scp = &sc; *scp; ) {
+               slap_callback *sc_next = (*scp)->sc_next, **sc_nextp = &(*scp)->sc_next;
+
+               op->o_callback = *scp;
+               if ( op->o_callback->sc_response ) {
+                       rc = op->o_callback->sc_response( op, rs );
+                       if ( op->o_callback == NULL ) {
+                               /* the callback has been removed;
+                                * repair the list */
+                               *scp = sc_next;
+                               sc_nextp = scp;
+
+                       } else if ( op->o_callback != *scp ) {
+                               /* a new callback has been inserted
+                                * in place of the existing one; repair the list */
+                               *scp = op->o_callback;
+                               sc_nextp = scp;
+                       }
+                       if ( rc != SLAP_CB_CONTINUE ) break;
+               }
+               scp = sc_nextp;
+       }
+
+       op->o_callback = sc;
+#else /* ! LDAP_DEVEL */
+       slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
+
+       rc = SLAP_CB_CONTINUE;
+       for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
+               sc_next = op->o_callback->sc_next;
+               if ( op->o_callback->sc_response ) {
+                       slap_callback *sc2 = op->o_callback;
+                       rc = op->o_callback->sc_response( op, rs );
+                       if ( op->o_callback != sc2 ) {
+                               *sc_prev = op->o_callback;
+                       }
+                       if ( rc != SLAP_CB_CONTINUE || !op->o_callback ) break;
+                       if ( op->o_callback != sc2 ) continue;
+               }
+               sc_prev = &op->o_callback->sc_next;
+       }
+
+       op->o_callback = sc;
+#endif /* ! LDAP_DEVEL */
+
+       return rc;
+}
+
+static int
+slap_cleanup_play(
+       Operation *op,
+       SlapReply *rs )
+{
+#ifdef LDAP_DEVEL
+       slap_callback   *sc = op->o_callback, **scp;
+
+       for ( scp = &sc; *scp; ) {
+               slap_callback *sc_next = (*scp)->sc_next, **sc_nextp = &(*scp)->sc_next;
+
+               op->o_callback = *scp;
+               if ( op->o_callback->sc_cleanup ) {
+                       (void)op->o_callback->sc_cleanup( op, rs );
+                       if ( op->o_callback == NULL ) {
+                               /* the callback has been removed;
+                                * repair the list */
+                               *scp = sc_next;
+                               sc_nextp = scp;
+
+                       } else if ( op->o_callback != *scp ) {
+                               /* a new callback has been inserted
+                                * after the existing one; repair the list */
+                               /* a new callback has been inserted
+                                * in place of the existing one; repair the list */
+                               *scp = op->o_callback;
+                               sc_nextp = scp;
+                       }
+                       /* don't care about the result; do all cleanup */
+               }
+               scp = sc_nextp;
+       }
+
+       op->o_callback = sc;
+#else /* ! LDAP_DEVEL */
+       slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
+
+       for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
+               sc_next = op->o_callback->sc_next;
+               if ( op->o_callback->sc_cleanup ) {
+                       slap_callback *sc2 = op->o_callback;
+                       (void)op->o_callback->sc_cleanup( op, rs );
+                       if ( op->o_callback != sc2 ) {
+                               *sc_prev = op->o_callback;
+                       }
+                       if ( !op->o_callback ) break;
+                       if ( op->o_callback != sc2 ) continue;
+               }
+               sc_prev = &op->o_callback->sc_next;
+       }
+
+       op->o_callback = sc;
+#endif /* ! LDAP_DEVEL */
+
+       return LDAP_SUCCESS;
+}
+
 static int
 send_ldap_response(
        Operation *op,
@@ -302,25 +440,10 @@ send_ldap_response(
        }
 
        if ( op->o_callback ) {
-               slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
-
-               rc = SLAP_CB_CONTINUE;
-               for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
-                       sc_next = op->o_callback->sc_next;
-                       if ( op->o_callback->sc_response ) {
-                               slap_callback *sc2 = op->o_callback;
-                               rc = op->o_callback->sc_response( op, rs );
-                               if ( op->o_callback != sc2 ) {
-                                       *sc_prev = op->o_callback;
-                               }
-                               if ( rc != SLAP_CB_CONTINUE || !op->o_callback ) break;
-                               if ( op->o_callback != sc2 ) continue;
-                       }
-                       sc_prev = &op->o_callback->sc_next;
+               rc = slap_response_play( op, rs );
+               if ( rc != SLAP_CB_CONTINUE ) {
+                       goto clean2;
                }
-
-               op->o_callback = sc;
-               if ( rc != SLAP_CB_CONTINUE ) goto clean2;
        }
 
 #ifdef LDAP_CONNECTIONLESS
@@ -458,25 +581,9 @@ cleanup:;
 
 clean2:;
        if ( op->o_callback ) {
-               slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
-
-               for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
-                       sc_next = op->o_callback->sc_next;
-                       if ( op->o_callback->sc_cleanup ) {
-                               slap_callback *sc2 = op->o_callback;
-                               (void)op->o_callback->sc_cleanup( op, rs );
-                               if ( op->o_callback != sc2 ) {
-                                       *sc_prev = op->o_callback;
-                               }
-                               if ( !op->o_callback ) break;
-                               if ( op->o_callback != sc2 ) continue;
-                       }
-                       sc_prev = &op->o_callback->sc_next;
-               }
-               op->o_callback = sc;
+               (void)slap_cleanup_play( op, rs );
        }
 
-
        if ( rs->sr_matched && rs->sr_flags & REP_MATCHED_MUSTBEFREED ) {
                free( (char *)rs->sr_matched );
                rs->sr_matched = NULL;
@@ -715,26 +822,10 @@ slap_send_search_entry( Operation *op, SlapReply *rs )
        }
 
        if ( op->o_callback ) {
-               slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
-
-               rc = SLAP_CB_CONTINUE;
-               for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next )
-               {
-                       sc_next = op->o_callback->sc_next;
-                       if ( op->o_callback->sc_response ) {
-                               slap_callback *sc2 = op->o_callback;
-                               rc = op->o_callback->sc_response( op, rs );
-                               if ( op->o_callback != sc2 ) {
-                                       *sc_prev = op->o_callback;
-                               }
-                               if ( rc != SLAP_CB_CONTINUE || !op->o_callback ) break;
-                               if ( op->o_callback != sc2 ) continue;
-                       }
-                       sc_prev = &op->o_callback->sc_next;
+               rc = slap_response_play( op, rs );
+               if ( rc != SLAP_CB_CONTINUE ) {
+                       goto error_return;
                }
-
-               op->o_callback = sc;
-               if ( rc != SLAP_CB_CONTINUE ) goto error_return;
        }
 
        Debug( LDAP_DEBUG_TRACE, "=> send_search_entry: conn %lu dn=\"%s\"%s\n",
@@ -1173,22 +1264,7 @@ slap_send_search_entry( Operation *op, SlapReply *rs )
 
 error_return:;
        if ( op->o_callback ) {
-               slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
-
-               for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
-                       sc_next = op->o_callback->sc_next;
-                       if ( op->o_callback->sc_cleanup ) {
-                               slap_callback *sc2 = op->o_callback;
-                               (void)op->o_callback->sc_cleanup( op, rs );
-                               if ( op->o_callback != sc2 ) {
-                                       *sc_prev = op->o_callback;
-                               }
-                               if ( !op->o_callback ) break;
-                               if ( op->o_callback != sc2 ) continue;
-                       }
-                       sc_prev = &op->o_callback->sc_next;
-               }
-               op->o_callback = sc;
+               (void)slap_cleanup_play( op, rs );
        }
 
        if ( e_flags ) {
@@ -1232,25 +1308,10 @@ slap_send_search_reference( Operation *op, SlapReply *rs )
 
        rs->sr_type = REP_SEARCHREF;
        if ( op->o_callback ) {
-               slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
-
-               rc = SLAP_CB_CONTINUE;
-               for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
-                       sc_next = op->o_callback->sc_next;
-                       if ( op->o_callback->sc_response ) {
-                               slap_callback *sc2 = op->o_callback;
-                               rc = op->o_callback->sc_response( op, rs );
-                               if ( op->o_callback != sc2 ) {
-                                       *sc_prev = op->o_callback;
-                               }
-                               if ( rc != SLAP_CB_CONTINUE || !op->o_callback ) break;
-                               if ( op->o_callback != sc2 ) continue;
-                       }
-                       sc_prev = &op->o_callback->sc_next;
+               rc = slap_response_play( op, rs );
+               if ( rc != SLAP_CB_CONTINUE ) {
+                       goto rel;
                }
-
-               op->o_callback = sc;
-               if ( rc != SLAP_CB_CONTINUE ) goto rel;
        }
 
        Debug( LDAP_DEBUG_TRACE,
@@ -1376,22 +1437,7 @@ slap_send_search_reference( Operation *op, SlapReply *rs )
 
 rel:
        if ( op->o_callback ) {
-               slap_callback   *sc = op->o_callback, **sc_prev = &sc, *sc_next;
-
-               for ( sc_next = op->o_callback; sc_next; op->o_callback = sc_next) {
-                       sc_next = op->o_callback->sc_next;
-                       if ( op->o_callback->sc_cleanup ) {
-                               slap_callback *sc2 = op->o_callback;
-                               (void)op->o_callback->sc_cleanup( op, rs );
-                               if ( op->o_callback != sc2 ) {
-                                       *sc_prev = op->o_callback;
-                               }
-                               if ( rc != SLAP_CB_CONTINUE || !op->o_callback ) break;
-                               if ( op->o_callback != sc2 ) continue;
-                       }
-                       sc_prev = &op->o_callback->sc_next;
-               }
-               op->o_callback = sc;
+               (void)slap_cleanup_play( op, rs );
        }
 
        return rc;