]> git.sur5r.net Git - openldap/blobdiff - libraries/libldap_r/tpool.c
ITS#8605 - spelling fixes
[openldap] / libraries / libldap_r / tpool.c
index d9f575db3fbc10291f1241be18eb65bd5210a0f4..b1cb01635151a3b78b48d15c4762a598023e969c 100644 (file)
@@ -1,7 +1,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 1998-2013 The OpenLDAP Foundation.
+ * Copyright 1998-2017 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
 
 #ifndef LDAP_THREAD_HAVE_TPOOL
 
+#ifndef CACHELINE
+#define CACHELINE      64
+#endif
+
 /* Thread-specific key with data and optional free function */
 typedef struct ldap_int_tpool_key_s {
        void *ltk_key;
@@ -62,8 +66,6 @@ typedef struct ldap_int_thread_userctx_s {
 
 
 /* Simple {thread ID -> context} hash table; key=ctx->ltu_id.
- * Protected by ldap_pvt_thread_pool_mutex except during pauses,
- * when it is read-only (used by pool_purgekey and pool_context).
  * Protected by ldap_pvt_thread_pool_mutex.
  */
 static struct {
@@ -88,21 +90,28 @@ typedef struct ldap_int_thread_task_s {
        } ltt_next;
        ldap_pvt_thread_start_t *ltt_start_routine;
        void *ltt_arg;
+       struct ldap_int_thread_poolq_s *ltt_queue;
 } ldap_int_thread_task_t;
 
 typedef LDAP_STAILQ_HEAD(tcq, ldap_int_thread_task_s) ldap_int_tpool_plist_t;
 
 struct ldap_int_thread_poolq_s {
+       void *ltp_free;
+
        struct ldap_int_thread_pool_s *ltp_pool;
 
-       /* protect members below, and protect thread_keys[] during pauses */
+       /* protect members below */
        ldap_pvt_thread_mutex_t ltp_mutex;
 
-       /* not paused and something to do for pool_<wrapper/pause/destroy>() */
+       /* not paused and something to do for pool_<wrapper/pause/destroy>()
+        * Used for normal pool operation, to synch between submitter and
+        * worker threads. Not used for pauses. In normal operation multiple
+        * queues can rendezvous without acquiring the main pool lock.
+        */
        ldap_pvt_thread_cond_t ltp_cond;
 
        /* ltp_pause == 0 ? &ltp_pending_list : &empty_pending_list,
-        * maintaned to reduce work for pool_wrapper()
+        * maintained to reduce work for pool_wrapper()
         */
        ldap_int_tpool_plist_t *ltp_work_list;
 
@@ -110,7 +119,7 @@ struct ldap_int_thread_poolq_s {
        ldap_int_tpool_plist_t ltp_pending_list;
        LDAP_SLIST_HEAD(tcl, ldap_int_thread_task_s) ltp_free_list;
 
-       /* Max number of threads in pool, or 0 for default (LDAP_MAXTHR) */
+       /* Max number of threads in this queue */
        int ltp_max_count;
 
        /* Max pending + paused + idle tasks, negated when ltp_finishing */
@@ -118,25 +127,28 @@ struct ldap_int_thread_poolq_s {
 
        int ltp_pending_count;          /* Pending + paused + idle tasks */
        int ltp_active_count;           /* Active, not paused/idle tasks */
-       int ltp_open_count;                     /* Number of threads, negated when ltp_pause */
+       int ltp_open_count;                     /* Number of threads */
        int ltp_starting;                       /* Currently starting threads */
 };
 
 struct ldap_int_thread_pool_s {
        LDAP_STAILQ_ENTRY(ldap_int_thread_pool_s) ltp_next;
 
-       struct ldap_int_thread_poolq_s *ltp_wqs;
+       struct ldap_int_thread_poolq_s **ltp_wqs;
 
        /* number of poolqs */
        int ltp_numqs;
 
-       /* protect members below, and protect thread_keys[] during pauses */
+       /* protect members below */
        ldap_pvt_thread_mutex_t ltp_mutex;
 
-       /* not paused and something to do for pool_<wrapper/pause/destroy>() */
+       /* paused and waiting for resume
+        * When a pause is in effect all workers switch to waiting on
+        * this cond instead of their per-queue cond.
+        */
        ldap_pvt_thread_cond_t ltp_cond;
 
-       /* ltp_active_count <= 1 && ltp_pause */
+       /* ltp_active_queues < 1 && ltp_pause */
        ldap_pvt_thread_cond_t ltp_pcond;
 
        /* number of active queues */
@@ -224,33 +236,56 @@ ldap_pvt_thread_pool_init_q (
 
        *tpool = NULL;
        pool = (ldap_pvt_thread_pool_t) LDAP_CALLOC(1,
-               sizeof(struct ldap_int_thread_pool_s) +
-               numqs * sizeof(struct ldap_int_thread_poolq_s));
+               sizeof(struct ldap_int_thread_pool_s));
 
        if (pool == NULL) return(-1);
 
-       pool->ltp_wqs = (struct ldap_int_thread_poolq_s *)(pool+1);
+       pool->ltp_wqs = LDAP_MALLOC(numqs * sizeof(struct ldap_int_thread_poolq_s *));
+       if (pool->ltp_wqs == NULL) {
+               LDAP_FREE(pool);
+               return(-1);
+       }
+
+       for (i=0; i<numqs; i++) {
+               char *ptr = LDAP_CALLOC(1, sizeof(struct ldap_int_thread_poolq_s) + CACHELINE-1);
+               if (ptr == NULL) {
+                       for (--i; i>=0; i--)
+                               LDAP_FREE(pool->ltp_wqs[i]->ltp_free);
+                       LDAP_FREE(pool->ltp_wqs);
+                       LDAP_FREE(pool);
+                       return(-1);
+               }
+               pool->ltp_wqs[i] = (struct ldap_int_thread_poolq_s *)(((size_t)ptr + CACHELINE-1) & ~(CACHELINE-1));
+               pool->ltp_wqs[i]->ltp_free = ptr;
+       }
+
        pool->ltp_numqs = numqs;
        pool->ltp_conf_max_count = max_threads;
        if ( !max_threads )
                max_threads = LDAP_MAXTHR;
 
        rc = ldap_pvt_thread_mutex_init(&pool->ltp_mutex);
-       if (rc != 0)
+       if (rc != 0) {
+fail:
+               for (i=0; i<numqs; i++)
+                       LDAP_FREE(pool->ltp_wqs[i]->ltp_free);
+               LDAP_FREE(pool->ltp_wqs);
+               LDAP_FREE(pool);
                return(rc);
+       }
 
        rc = ldap_pvt_thread_cond_init(&pool->ltp_cond);
        if (rc != 0)
-               return(rc);
+               goto fail;
 
        rc = ldap_pvt_thread_cond_init(&pool->ltp_pcond);
        if (rc != 0)
-               return(rc);
+               goto fail;
 
        rem_thr = max_threads % numqs;
        rem_pend = max_pending % numqs;
        for ( i=0; i<numqs; i++ ) {
-               pq = &pool->ltp_wqs[i];
+               pq = pool->ltp_wqs[i];
                pq->ltp_pool = pool;
                rc = ldap_pvt_thread_mutex_init(&pq->ltp_mutex);
                if (rc != 0)
@@ -303,25 +338,21 @@ ldap_pvt_thread_pool_init (
        return ldap_pvt_thread_pool_init_q( tpool, max_threads, max_pending, 1 );
 }
 
-static int
-ldap_int_poolq_hash(
-       struct ldap_int_thread_pool_s *pool,
-       void *arg )
+/* Submit a task to be performed by the thread pool */
+int
+ldap_pvt_thread_pool_submit (
+       ldap_pvt_thread_pool_t *tpool,
+       ldap_pvt_thread_start_t *start_routine, void *arg )
 {
-       int i = 0, j;
-       unsigned char *ptr = (unsigned char *)&arg;
-       /* dumb hash of arg to choose a queue */
-       for (j=0; j<sizeof(arg); j++)
-               i += *ptr++;
-       i %= pool->ltp_numqs;
-       return i;
+       return ldap_pvt_thread_pool_submit2( tpool, start_routine, arg, NULL );
 }
 
 /* Submit a task to be performed by the thread pool */
 int
-ldap_pvt_thread_pool_submit (
+ldap_pvt_thread_pool_submit2 (
        ldap_pvt_thread_pool_t *tpool,
-       ldap_pvt_thread_start_t *start_routine, void *arg )
+       ldap_pvt_thread_start_t *start_routine, void *arg,
+       void **cookie )
 {
        struct ldap_int_thread_pool_s *pool;
        struct ldap_int_thread_poolq_s *pq;
@@ -337,25 +368,39 @@ ldap_pvt_thread_pool_submit (
        if (pool == NULL)
                return(-1);
 
-       if ( pool->ltp_numqs > 1 )
-               i = ldap_int_poolq_hash( pool, arg );
-       else
+       if ( pool->ltp_numqs > 1 ) {
+               int min = pool->ltp_wqs[0]->ltp_max_pending + pool->ltp_wqs[0]->ltp_max_count;
+               int min_x = 0, cnt;
+               for ( i = 0; i < pool->ltp_numqs; i++ ) {
+                       /* take first queue that has nothing active */
+                       if ( !pool->ltp_wqs[i]->ltp_active_count ) {
+                               min_x = i;
+                               break;
+                       }
+                       cnt = pool->ltp_wqs[i]->ltp_active_count + pool->ltp_wqs[i]->ltp_pending_count;
+                       if ( cnt < min ) {
+                               min = cnt;
+                               min_x = i;
+                       }
+               }
+               i = min_x;
+       } else
                i = 0;
 
        j = i;
        while(1) {
-               ldap_pvt_thread_mutex_lock(&pool->ltp_wqs[i].ltp_mutex);
-               if (pool->ltp_wqs[i].ltp_pending_count < pool->ltp_wqs[i].ltp_max_pending) {
+               ldap_pvt_thread_mutex_lock(&pool->ltp_wqs[i]->ltp_mutex);
+               if (pool->ltp_wqs[i]->ltp_pending_count < pool->ltp_wqs[i]->ltp_max_pending) {
                        break;
                }
-               ldap_pvt_thread_mutex_unlock(&pool->ltp_wqs[i].ltp_mutex);
+               ldap_pvt_thread_mutex_unlock(&pool->ltp_wqs[i]->ltp_mutex);
                i++;
                i %= pool->ltp_numqs;
                if ( i == j )
                        return -1;
        }
 
-       pq = &pool->ltp_wqs[i];
+       pq = pool->ltp_wqs[i];
        task = LDAP_SLIST_FIRST(&pq->ltp_free_list);
        if (task) {
                LDAP_SLIST_REMOVE_HEAD(&pq->ltp_free_list, ltt_next.l);
@@ -367,6 +412,9 @@ ldap_pvt_thread_pool_submit (
 
        task->ltt_start_routine = start_routine;
        task->ltt_arg = arg;
+       task->ltt_queue = pq;
+       if ( cookie )
+               *cookie = task;
 
        pq->ltp_pending_count++;
        LDAP_STAILQ_INSERT_TAIL(&pq->ltp_pending_list, task, ltt_next.q);
@@ -441,29 +489,22 @@ no_task( void *ctx, void *arg )
  */
 int
 ldap_pvt_thread_pool_retract (
-       ldap_pvt_thread_pool_t *tpool,
-       ldap_pvt_thread_start_t *start_routine, void *arg )
+       void *cookie )
 {
-       struct ldap_int_thread_pool_s *pool;
+       ldap_int_thread_task_t *task, *ttmp;
        struct ldap_int_thread_poolq_s *pq;
-       ldap_int_thread_task_t *task;
-       int i;
 
-       if (tpool == NULL)
+       if (cookie == NULL)
                return(-1);
 
-       pool = *tpool;
-
-       if (pool == NULL)
+       ttmp = cookie;
+       pq = ttmp->ltt_queue;
+       if (pq == NULL)
                return(-1);
 
-       i = ldap_int_poolq_hash( pool, arg );
-       pq = &pool->ltp_wqs[i];
-
        ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
        LDAP_STAILQ_FOREACH(task, &pq->ltp_pending_list, ltt_next.q)
-               if (task->ltt_start_routine == start_routine &&
-                       task->ltt_arg == arg) {
+               if (task == ttmp) {
                        /* Could LDAP_STAILQ_REMOVE the task, but that
                         * walks ltp_pending_list again to find it.
                         */
@@ -475,6 +516,75 @@ ldap_pvt_thread_pool_retract (
        return task != NULL;
 }
 
+/* Set number of work queues in this pool. Should not be
+ * more than the number of CPUs. */
+int
+ldap_pvt_thread_pool_queues(
+       ldap_pvt_thread_pool_t *tpool,
+       int numqs )
+{
+       struct ldap_int_thread_pool_s *pool;
+       struct ldap_int_thread_poolq_s *pq;
+       int i, rc, rem_thr, rem_pend;
+
+       if (numqs < 1 || tpool == NULL)
+               return(-1);
+
+       pool = *tpool;
+
+       if (pool == NULL)
+               return(-1);
+
+       if (numqs < pool->ltp_numqs) {
+               for (i=numqs; i<pool->ltp_numqs; i++)
+                       pool->ltp_wqs[i]->ltp_max_count = 0;
+       } else if (numqs > pool->ltp_numqs) {
+               struct ldap_int_thread_poolq_s **wqs;
+               wqs = LDAP_REALLOC(pool->ltp_wqs, numqs * sizeof(struct ldap_int_thread_poolq_s *));
+               if (wqs == NULL)
+                       return(-1);
+               pool->ltp_wqs = wqs;
+               for (i=pool->ltp_numqs; i<numqs; i++) {
+                       char *ptr = LDAP_CALLOC(1, sizeof(struct ldap_int_thread_poolq_s) + CACHELINE-1);
+                       if (ptr == NULL) {
+                               for (; i<numqs; i++)
+                                       pool->ltp_wqs[i] = NULL;
+                               return(-1);
+                       }
+                       pq = (struct ldap_int_thread_poolq_s *)(((size_t)ptr + CACHELINE-1) & ~(CACHELINE-1));
+                       pq->ltp_free = ptr;
+                       pool->ltp_wqs[i] = pq;
+                       pq->ltp_pool = pool;
+                       rc = ldap_pvt_thread_mutex_init(&pq->ltp_mutex);
+                       if (rc != 0)
+                               return(rc);
+                       rc = ldap_pvt_thread_cond_init(&pq->ltp_cond);
+                       if (rc != 0)
+                               return(rc);
+                       LDAP_STAILQ_INIT(&pq->ltp_pending_list);
+                       pq->ltp_work_list = &pq->ltp_pending_list;
+                       LDAP_SLIST_INIT(&pq->ltp_free_list);
+               }
+       }
+       rem_thr = pool->ltp_max_count % numqs;
+       rem_pend = pool->ltp_max_pending % numqs;
+       for ( i=0; i<numqs; i++ ) {
+               pq = pool->ltp_wqs[i];
+               pq->ltp_max_count = pool->ltp_max_count / numqs;
+               if ( rem_thr ) {
+                       pq->ltp_max_count++;
+                       rem_thr--;
+               }
+               pq->ltp_max_pending = pool->ltp_max_pending / numqs;
+               if ( rem_pend ) {
+                       pq->ltp_max_pending++;
+                       rem_pend--;
+               }
+       }
+       pool->ltp_numqs = numqs;
+       return 0;
+}
+
 /* Set max #threads.  value <= 0 means max supported #threads (LDAP_MAXTHR) */
 int
 ldap_pvt_thread_pool_maxthreads(
@@ -505,14 +615,12 @@ ldap_pvt_thread_pool_maxthreads(
        max_threads /= pool->ltp_numqs;
 
        for (i=0; i<pool->ltp_numqs; i++) {
-               pq = &pool->ltp_wqs[i];
-               ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
+               pq = pool->ltp_wqs[i];
                pq->ltp_max_count = max_threads;
                if (remthr) {
                        pq->ltp_max_count++;
                        remthr--;
                }
-               ldap_pvt_thread_mutex_unlock(&pq->ltp_mutex);
        }
        return(0);
 }
@@ -565,7 +673,7 @@ ldap_pvt_thread_pool_query(
                        int i;
                        count = 0;
                        for (i=0; i<pool->ltp_numqs; i++) {
-                               struct ldap_int_thread_poolq_s *pq = &pool->ltp_wqs[i];
+                               struct ldap_int_thread_poolq_s *pq = pool->ltp_wqs[i];
                                ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
                                switch(param) {
                                        case LDAP_PVT_THREAD_POOL_PARAM_OPEN:
@@ -608,7 +716,7 @@ ldap_pvt_thread_pool_query(
                else {
                        int i;
                        for (i=0; i<pool->ltp_numqs; i++)
-                               if (pool->ltp_wqs[i].ltp_pending_count) break;
+                               if (pool->ltp_wqs[i]->ltp_pending_count) break;
                        if (i<pool->ltp_numqs)
                                *((char **)value) = "finishing";
                        else
@@ -699,7 +807,7 @@ ldap_pvt_thread_pool_destroy ( ldap_pvt_thread_pool_t *tpool, int run_pending )
        ldap_pvt_thread_mutex_unlock(&pool->ltp_mutex);
 
        for (i=0; i<pool->ltp_numqs; i++) {
-               pq = &pool->ltp_wqs[i];
+               pq = pool->ltp_wqs[i];
                ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
                if (pq->ltp_max_pending > 0)
                        pq->ltp_max_pending = -pq->ltp_max_pending;
@@ -729,6 +837,13 @@ ldap_pvt_thread_pool_destroy ( ldap_pvt_thread_pool_t *tpool, int run_pending )
        ldap_pvt_thread_cond_destroy(&pool->ltp_pcond);
        ldap_pvt_thread_cond_destroy(&pool->ltp_cond);
        ldap_pvt_thread_mutex_destroy(&pool->ltp_mutex);
+       for (i=0; i<pool->ltp_numqs; i++) {
+               pq = pool->ltp_wqs[i];
+               if (pq->ltp_free) {
+                       LDAP_FREE(pq->ltp_free);
+               }
+       }
+       LDAP_FREE(pool->ltp_wqs);
        LDAP_FREE(pool);
        *tpool = NULL;
        ldap_int_has_thread_pool = 0;
@@ -746,7 +861,7 @@ ldap_int_thread_pool_wrapper (
        ldap_int_tpool_plist_t *work_list;
        ldap_int_thread_userctx_t ctx, *kctx;
        unsigned i, keyslot, hash;
-       int global_lock = 0;
+       int pool_lock = 0, freeme = 0;
 
        assert(pool != NULL);
 
@@ -791,7 +906,7 @@ ldap_int_thread_pool_wrapper (
                                if (pool->ltp_pause) {
                                        ldap_pvt_thread_mutex_unlock(&pq->ltp_mutex);
                                        ldap_pvt_thread_mutex_lock(&pool->ltp_mutex);
-                                       global_lock = 1;
+                                       pool_lock = 1;
                                        if (--(pool->ltp_active_queues) < 1) {
                                                /* Notify pool_pause it is the sole active thread. */
                                                ldap_pvt_thread_cond_signal(&pool->ltp_pcond);
@@ -819,12 +934,12 @@ ldap_int_thread_pool_wrapper (
                                 * Just use pthread_cond_timedwait() if we want to
                                 * check idle time.
                                 */
-                               if (global_lock) {
+                               if (pool_lock) {
                                        ldap_pvt_thread_cond_wait(&pool->ltp_cond, &pool->ltp_mutex);
                                        if (!pool->ltp_pause) {
                                                ldap_pvt_thread_mutex_unlock(&pool->ltp_mutex);
                                                ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
-                                               global_lock = 0;
+                                               pool_lock = 0;
                                        }
                                } else
                                        ldap_pvt_thread_cond_wait(&pq->ltp_cond, &pq->ltp_mutex);
@@ -833,10 +948,10 @@ ldap_int_thread_pool_wrapper (
                                task = LDAP_STAILQ_FIRST(work_list);
                        } while (task == NULL);
 
-                       if (global_lock) {
+                       if (pool_lock) {
                                ldap_pvt_thread_mutex_unlock(&pool->ltp_mutex);
                                ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
-                               global_lock = 0;
+                               pool_lock = 0;
                        }
                        pq->ltp_active_count++;
                }
@@ -862,15 +977,25 @@ ldap_int_thread_pool_wrapper (
        ldap_pvt_thread_mutex_unlock(&ldap_pvt_thread_pool_mutex);
 
        pq->ltp_open_count--;
-       /* let pool_destroy know we're all done */
-       if (pq->ltp_open_count == 0)
-               ldap_pvt_thread_cond_signal(&pq->ltp_cond);
+       if (pq->ltp_open_count == 0) {
+               if (pool->ltp_finishing)
+                       /* let pool_destroy know we're all done */
+                       ldap_pvt_thread_cond_signal(&pq->ltp_cond);
+               else
+                       freeme = 1;
+       }
 
-       if (global_lock)
+       if (pool_lock)
                ldap_pvt_thread_mutex_unlock(&pool->ltp_mutex);
        else
                ldap_pvt_thread_mutex_unlock(&pq->ltp_mutex);
 
+       if (freeme) {
+               ldap_pvt_thread_cond_destroy(&pq->ltp_cond);
+               ldap_pvt_thread_mutex_destroy(&pq->ltp_mutex);
+               LDAP_FREE(pq->ltp_free);
+               pq->ltp_free = NULL;
+       }
        ldap_pvt_thread_exit(NULL);
        return(NULL);
 }
@@ -906,6 +1031,8 @@ handle_pause( ldap_pvt_thread_pool_t *tpool, int pause_type )
        {
                ldap_int_thread_userctx_t *ctx = ldap_pvt_thread_pool_context();
                pq = ctx->ltu_pq;
+               if ( !pq )
+                       return(-1);
        }
 
        /* Let pool_unidle() ignore requests for new pauses */
@@ -958,7 +1085,7 @@ handle_pause( ldap_pvt_thread_pool_t *tpool, int pause_type )
                pool->ltp_active_queues = 0;
 
                for (i=0; i<pool->ltp_numqs; i++)
-                       if (&pool->ltp_wqs[i] == pq) break;
+                       if (pool->ltp_wqs[i] == pq) break;
 
                ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
                /* temporarily remove ourself from active count */
@@ -966,13 +1093,10 @@ handle_pause( ldap_pvt_thread_pool_t *tpool, int pause_type )
 
                j=i;
                do {
-                       pq = &pool->ltp_wqs[j];
+                       pq = pool->ltp_wqs[j];
                        if (j != i)
                                ldap_pvt_thread_mutex_lock(&pq->ltp_mutex);
 
-                       /* Let ldap_pvt_thread_pool_submit() through to its ltp_pause test,
-                        * and do not finish threads in ldap_pvt_thread_pool_wrapper() */
-                       pq->ltp_open_count = -pq->ltp_open_count;
                        /* Hide pending tasks from ldap_pvt_thread_pool_wrapper() */
                        pq->ltp_work_list = &empty_pending_list;
 
@@ -991,7 +1115,7 @@ handle_pause( ldap_pvt_thread_pool_t *tpool, int pause_type )
                        ldap_pvt_thread_cond_wait(&pool->ltp_pcond, &pool->ltp_mutex);
 
                /* restore us to active count */
-               pool->ltp_wqs[i].ltp_active_count++;
+               pool->ltp_wqs[i]->ltp_active_count++;
 
                assert(pool->ltp_pause == WANT_PAUSE);
                pool->ltp_pause = PAUSED;
@@ -1058,9 +1182,7 @@ ldap_pvt_thread_pool_resume (
        assert(pool->ltp_pause == PAUSED);
        pool->ltp_pause = 0;
        for (i=0; i<pool->ltp_numqs; i++) {
-               pq = &pool->ltp_wqs[i];
-               if (pq->ltp_open_count <= 0) /* true when paused, but be paranoid */
-                       pq->ltp_open_count = -pq->ltp_open_count;
+               pq = pool->ltp_wqs[i];
                pq->ltp_work_list = &pq->ltp_pending_list;
                ldap_pvt_thread_cond_broadcast(&pq->ltp_cond);
        }