Fix typo

[openldap] / libraries / libldap_r / rdwr.c

diff --git a/libraries/libldap_r/rdwr.c b/libraries/libldap_r/rdwr.c
index 34b2253cd6ef9be241dc981885632395d3a19a42..ef90061915535245253aea34dc933c4eb3084aaf 100644 (file)
--- a/libraries/libldap_r/rdwr.c
+++ b/libraries/libldap_r/rdwr.c
@@ -1,3 +1,4 @@
+/* $OpenLDAP$ */
 /*
 ** This is an improved implementation of Reader/Writer locks does
 ** not protect writers from starvation.  That is, if a writer is
@@ -6,48 +7,86 @@
 **
 ** Does not support cancellation nor does any status checking.
 */
-
-/********************************************************
- * Adapted from:
+/* Adapted from publically available examples for:
  *     "Programming with Posix Threads"
- *             by David R Butenhof
- *             Addison-Wesley 
- ********************************************************
+ *             by David R Butenhof, Addison-Wesley 
+ *             http://cseng.aw.com/bookpage.taf?ISBN=0-201-63392-2
  */
 
 #include "portable.h"
 
-#include <stdlib.h>
+#include <ac/stdlib.h>
 
 #include <ac/errno.h>
 #include <ac/string.h>
+#include <ac/time.h>
 
+#include "ldap-int.h"
 #include "ldap_pvt_thread.h"
 
+/*
+ * implementations that provide their own compatible 
+ * reader/writer locks define LDAP_THREAD_HAVE_RDWR
+ * in ldap_pvt_thread.h
+ */
+#ifndef LDAP_THREAD_HAVE_RDWR
+
+struct ldap_int_thread_rdwr_s {
+       ldap_pvt_thread_mutex_t ltrw_mutex;
+       ldap_pvt_thread_cond_t ltrw_read;       /* wait for read */
+       ldap_pvt_thread_cond_t ltrw_write;      /* wait for write */
+       int ltrw_valid;
+#define LDAP_PVT_THREAD_RDWR_VALID 0x0bad
+       int ltrw_r_active;
+       int ltrw_w_active;
+       int ltrw_r_wait;
+       int ltrw_w_wait;
+};
+
 int 
-ldap_pvt_thread_rdwr_init( ldap_pvt_thread_rdwr_t *rw )
+ldap_pvt_thread_rdwr_init( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       memset( rw, 0, sizeof(ldap_pvt_thread_rdwr_t) );
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+
+       rw = (struct ldap_int_thread_rdwr_s *) LDAP_CALLOC( 1,
+               sizeof( struct ldap_int_thread_rdwr_s ) );
 
        /* we should check return results */
        ldap_pvt_thread_mutex_init( &rw->ltrw_mutex );
        ldap_pvt_thread_cond_init( &rw->ltrw_read );
        ldap_pvt_thread_cond_init( &rw->ltrw_write );
 
-       rw->ltrw_valid = LDAP_PVT_THREAD_RDWR_VALUE;
+       rw->ltrw_valid = LDAP_PVT_THREAD_RDWR_VALID;
+
+       *rwlock = rw;
        return 0;
 }
 
 int 
-ldap_pvt_thread_rdwr_destroy( ldap_pvt_thread_rdwr_t *rw )
+ldap_pvt_thread_rdwr_destroy( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        /* active threads? */
-       if( rw->ltrw_r_active > 0 || rw->ltrw_w_active > 1) {
+       if( rw->ltrw_r_active > 0 || rw->ltrw_w_active > 0) {
                ldap_pvt_thread_mutex_unlock( &rw->ltrw_mutex );
                return LDAP_PVT_THREAD_EBUSY;
        }
@@ -60,24 +99,38 @@ ldap_pvt_thread_rdwr_destroy( ldap_pvt_thread_rdwr_t *rw )
 
        rw->ltrw_valid = 0;
 
-#ifdef SLAP_CLEANUP
        ldap_pvt_thread_mutex_unlock( &rw->ltrw_mutex );
-#endif
+
        ldap_pvt_thread_mutex_destroy( &rw->ltrw_mutex );
        ldap_pvt_thread_cond_destroy( &rw->ltrw_read );
        ldap_pvt_thread_cond_destroy( &rw->ltrw_write );
 
+       LDAP_FREE(rw);
+       *rwlock = NULL;
        return 0;
 }
 
-int ldap_pvt_thread_rdwr_rlock( ldap_pvt_thread_rdwr_t *rw )
+int ldap_pvt_thread_rdwr_rlock( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
-       if( rw->ltrw_w_active > 1 ) {
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
+       if( rw->ltrw_w_active > 0 ) {
                /* writer is active */
 
                rw->ltrw_r_wait++;
@@ -85,9 +138,10 @@ int ldap_pvt_thread_rdwr_rlock( ldap_pvt_thread_rdwr_t *rw )
                do {
                        ldap_pvt_thread_cond_wait(
                                &rw->ltrw_read, &rw->ltrw_mutex );
-               } while( rw->ltrw_w_active > 1 );
+               } while( rw->ltrw_w_active > 0 );
 
                rw->ltrw_r_wait--;
+               assert( rw->ltrw_r_wait >= 0 ); 
        }
 
        rw->ltrw_r_active++;
@@ -97,14 +151,27 @@ int ldap_pvt_thread_rdwr_rlock( ldap_pvt_thread_rdwr_t *rw )
        return 0;
 }
 
-int ldap_pvt_thread_rdwr_rtrylock( ldap_pvt_thread_rdwr_t *rw )
+int ldap_pvt_thread_rdwr_rtrylock( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
-       if( rw->ltrw_w_active > 1) {
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
+       if( rw->ltrw_w_active > 0) {
                ldap_pvt_thread_mutex_unlock( &rw->ltrw_mutex );
                return LDAP_PVT_THREAD_EBUSY;
        }
@@ -116,15 +183,28 @@ int ldap_pvt_thread_rdwr_rtrylock( ldap_pvt_thread_rdwr_t *rw )
        return 0;
 }
 
-int ldap_pvt_thread_rdwr_runlock( ldap_pvt_thread_rdwr_t *rw )
+int ldap_pvt_thread_rdwr_runlock( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
        rw->ltrw_r_active--;
 
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        if (rw->ltrw_r_active == 0 && rw->ltrw_w_wait > 0 ) {
                ldap_pvt_thread_cond_signal( &rw->ltrw_write );
        }
@@ -134,13 +214,26 @@ int ldap_pvt_thread_rdwr_runlock( ldap_pvt_thread_rdwr_t *rw )
        return 0;
 }
 
-int ldap_pvt_thread_rdwr_wlock( ldap_pvt_thread_rdwr_t *rw )
+int ldap_pvt_thread_rdwr_wlock( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        if ( rw->ltrw_w_active > 0 || rw->ltrw_r_active > 0 ) {
                rw->ltrw_w_wait++;
 
@@ -150,6 +243,7 @@ int ldap_pvt_thread_rdwr_wlock( ldap_pvt_thread_rdwr_t *rw )
                } while ( rw->ltrw_w_active > 0 || rw->ltrw_r_active > 0 );
 
                rw->ltrw_w_wait--;
+               assert( rw->ltrw_w_wait >= 0 ); 
        }
 
        rw->ltrw_w_active++;
@@ -159,13 +253,26 @@ int ldap_pvt_thread_rdwr_wlock( ldap_pvt_thread_rdwr_t *rw )
        return 0;
 }
 
-int ldap_pvt_thread_rdwr_wtrylock( ldap_pvt_thread_rdwr_t *rw )
+int ldap_pvt_thread_rdwr_wtrylock( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        if ( rw->ltrw_w_active > 0 || rw->ltrw_r_active > 0 ) {
                ldap_pvt_thread_mutex_unlock( &rw->ltrw_mutex );
                return LDAP_PVT_THREAD_EBUSY;
@@ -178,15 +285,28 @@ int ldap_pvt_thread_rdwr_wtrylock( ldap_pvt_thread_rdwr_t *rw )
        return 0;
 }
 
-int ldap_pvt_thread_rdwr_wunlock( ldap_pvt_thread_rdwr_t *rw )
+int ldap_pvt_thread_rdwr_wunlock( ldap_pvt_thread_rdwr_t *rwlock )
 {
-       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALUE )
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+
+       if( rw->ltrw_valid != LDAP_PVT_THREAD_RDWR_VALID )
                return LDAP_PVT_THREAD_EINVAL;
 
        ldap_pvt_thread_mutex_lock( &rw->ltrw_mutex );
 
        rw->ltrw_w_active--;
 
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        if (rw->ltrw_r_wait > 0) {
                ldap_pvt_thread_cond_broadcast( &rw->ltrw_read );
 
@@ -199,7 +319,7 @@ int ldap_pvt_thread_rdwr_wunlock( ldap_pvt_thread_rdwr_t *rw )
        return 0;
 }
 
-#ifdef LDAP_DEBUG
+#ifdef LDAP_RDWR_DEBUG
 
 /* just for testing, 
  * return 0 if false, suitable for assert(ldap_pvt_thread_rdwr_Xchk(rdwr))
@@ -211,20 +331,58 @@ int ldap_pvt_thread_rdwr_wunlock( ldap_pvt_thread_rdwr_t *rw )
  * a lock are caught.
  */
 
-int ldap_pvt_thread_rdwr_readers(ldap_pvt_thread_rdwr_t *rw)
+int ldap_pvt_thread_rdwr_readers(ldap_pvt_thread_rdwr_t *rwlock)
 {
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        return( rw->ltrw_r_active );
 }
 
-int ldap_pvt_thread_rdwr_writers(ldap_pvt_thread_rdwr_t *rw)
+int ldap_pvt_thread_rdwr_writers(ldap_pvt_thread_rdwr_t *rwlock)
 {
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        return( rw->ltrw_w_active );
 }
 
-int ldap_pvt_thread_rdwr_active(ldap_pvt_thread_rdwr_t *rw)
+int ldap_pvt_thread_rdwr_active(ldap_pvt_thread_rdwr_t *rwlock)
 {
+       struct ldap_int_thread_rdwr_s *rw;
+
+       assert( rwlock != NULL );
+       rw = *rwlock;
+
+       assert( rw != NULL );
+       assert( rw->ltrw_valid == LDAP_PVT_THREAD_RDWR_VALID );
+       assert( rw->ltrw_w_active >= 0 ); 
+       assert( rw->ltrw_w_wait >= 0 ); 
+       assert( rw->ltrw_r_active >= 0 ); 
+       assert( rw->ltrw_r_wait >= 0 ); 
+
        return(ldap_pvt_thread_rdwr_readers(rw) +
               ldap_pvt_thread_rdwr_writers(rw));
 }
 
 #endif /* LDAP_DEBUG */
+
+#endif /* LDAP_THREAD_HAVE_RDWR */