threadpool.h File Reference

#include <pthread.h>

Go to the source code of this file.

Typedefs
typedef pthread_t	gwtthread_t
typedef pthread_mutex_t	gwtlock_t
typedef pthread_cond_t	gwtcond_t
typedef void *	gwtreturn_t
typedef struct threadpool_t	threadpool_t

Enumerations
enum	threadpool_error_t { threadpool_lock_failure = -2 , threadpool_queue_full = -3 , threadpool_shutdown = -4 , threadpool_thread_failure = -5 }

Functions
threadpool_t *	new_threadpool (const uint32_t thread_count, const uint32_t queue_size)
	ANN2 (1, 2) bool threadpool_add(threadpool_t *pool
ANN void	free_threadpool (threadpool_t *pool)
static ANN int	gwt_lock (gwtlock_t *lock)
static ANN int	gwt_unlock (gwtlock_t *lock)
static ANN void	gwt_join (gwtthread_t thread)
static ANN void	gwt_wait (gwtcond_t *cond, gwtlock_t *lock)
static ANN int	gwt_broadcast (gwtcond_t *cond)
static ANN int	gwt_signal (gwtcond_t *cond)
static ANN int	gwt_lock_ini (gwtlock_t *lock)
static ANN void	gwt_lock_end (gwtlock_t *lock)
static ANN int	gwt_cond_ini (gwtcond_t *cond)
static ANN void	gwt_cond_end (gwtcond_t *cond)
static ANN bool	gwt_create (gwtthread_t *thread, gwtreturn_t(*fun)(void *), void *arg)

Variables
void(*	routine )(void *)
void void *	arg

Typedef Documentation

gwtcond_t

typedef pthread_cond_t gwtcond_t

Definition at line 13 of file threadpool.h.

gwtlock_t

typedef pthread_mutex_t gwtlock_t

Definition at line 12 of file threadpool.h.

gwtreturn_t

typedef void* gwtreturn_t

Definition at line 14 of file threadpool.h.

gwtthread_t

typedef pthread_t gwtthread_t

Definition at line 11 of file threadpool.h.

threadpool_t

typedef struct threadpool_t threadpool_t

Definition at line 17 of file threadpool.h.

Enumeration Type Documentation

threadpool_error_t

enum threadpool_error_t

Enumerator
threadpool_lock_failure
threadpool_queue_full
threadpool_shutdown
threadpool_thread_failure

Definition at line 19 of file threadpool.h.

             {
  threadpool_lock_failure   = -2,
  threadpool_queue_full     = -3,
  threadpool_shutdown       = -4,
  threadpool_thread_failure = -5
} threadpool_error_t;

Function Documentation

ANN2()

ANN2	(	1	,
		2	)

free_threadpool()

ANN void free_threadpool

(

threadpool_t *

pool

)

Definition at line 100 of file threadpool.c.

                                          {
  (void)gwt_lock(&p->lock);
  p->shutdown = true;
  gwt_broadcast(&p->cond);
  (void)gwt_unlock(&p->lock);
  if(p->threads) {
    for(uint32_t i = 0; i < p->started; i++)
      gwt_join(p->threads[i]);
    free(p->threads);
  }
  if(p->queue) free(p->queue);
  if(p->has_lock) gwt_lock_end(&p->lock);
  if(p->has_cond) gwt_cond_end(&p->cond);
}

gwt_broadcast()

static ANN int gwt_broadcast ( gwtcond_t * cond )

inlinestatic

Definition at line 83 of file threadpool.h.

                                                     {
  return pthread_cond_broadcast(cond);
}

gwt_cond_end()

static ANN void gwt_cond_end ( gwtcond_t * cond )

inlinestatic

Definition at line 101 of file threadpool.h.

                                                     {
  pthread_cond_destroy(cond); // int
}

gwt_cond_ini()

static ANN int gwt_cond_ini ( gwtcond_t * cond )

inlinestatic

Definition at line 98 of file threadpool.h.

                                                    {
  return pthread_cond_init(cond, NULL);
}

gwt_create()

static ANN bool gwt_create ( gwtthread_t * thread, gwtreturn_t(*)(void *) fun, void * arg )

inlinestatic

Definition at line 104 of file threadpool.h.

                                                                                             {
  return pthread_create(thread, NULL, fun, arg); // int
}

gwt_join()

static ANN void gwt_join ( gwtthread_t thread )

inlinestatic

Definition at line 77 of file threadpool.h.

                                                    {
  pthread_join(thread, NULL);
}

gwt_lock()

static ANN int gwt_lock ( gwtlock_t * lock )

inlinestatic

Definition at line 71 of file threadpool.h.

                                                {
  return pthread_mutex_lock(lock);
}

gwt_lock_end()

static ANN void gwt_lock_end ( gwtlock_t * lock )

inlinestatic

Definition at line 95 of file threadpool.h.

                                                     {
  pthread_mutex_destroy(lock); // int
}

gwt_lock_ini()

static ANN int gwt_lock_ini ( gwtlock_t * lock )

inlinestatic

Definition at line 89 of file threadpool.h.

                                                    {
  pthread_mutexattr_t attr;
  pthread_mutexattr_init(&attr);
  pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
  return pthread_mutex_init(lock, &attr);
}

gwt_signal()

static ANN int gwt_signal ( gwtcond_t * cond )

inlinestatic

Definition at line 86 of file threadpool.h.

                                                  {
  return pthread_cond_signal(cond);
}

gwt_unlock()

static ANN int gwt_unlock ( gwtlock_t * lock )

inlinestatic

Definition at line 74 of file threadpool.h.

                                                  {
  return pthread_mutex_unlock(lock);
}

gwt_wait()

static ANN void gwt_wait ( gwtcond_t * cond, gwtlock_t * lock )

inlinestatic

Definition at line 80 of file threadpool.h.

                                                                  {
  pthread_cond_wait(cond, lock);
}

new_threadpool()

threadpool_t * new_threadpool	(	const uint32_t	thread_count,
		const uint32_t	queue_size )

Definition at line 66 of file threadpool.c.

                                                                                     {
  threadpool_t *p = malloc(sizeof(threadpool_t));
  if(!p) return NULL;
  p->head = p->tail = p->active = 0;
  p->shutdown = p->has_lock = p->has_cond = false;
  p->started = 0;
  p->queue_size = queue_size;
  if(alloc(p, thread_count, queue_size) || !utils(p) ||
     !start(p, thread_count)) {
    free_threadpool(p);
    return NULL;
  }
  return p;
}

Variable Documentation

arg

void void* arg

Definition at line 27 of file threadpool.h.

routine

void(* routine) (void *)

(

void *

)

Definition at line 27 of file threadpool.h.