xref: /freebsd-10.0-release/lib/libthr/thread/thr_cond.c

/*
 * Copyright (c) 2005 David Xu <davidxu@freebsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice unmodified, this list of conditions, and the following
 *    disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD: head/lib/libthr/thread/thr_cond.c 144518 2005-04-02 01:20:00Z davidxu $
 */

#include <stdlib.h>
#include <errno.h>
#include <string.h>
#include <pthread.h>
#include <limits.h>

#include "thr_private.h"

/*
 * Prototypes
 */
static int cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr);
static int cond_wait_common(pthread_cond_t *cond, pthread_mutex_t *mutex,
		    const struct timespec *abstime, int cancel);
static int cond_signal_common(pthread_cond_t *cond, int broadcast);

/*
 * Double underscore versions are cancellation points.  Single underscore
 * versions are not and are provided for libc internal usage (which
 * shouldn't introduce cancellation points).
 */
__weak_reference(__pthread_cond_wait, pthread_cond_wait);
__weak_reference(__pthread_cond_timedwait, pthread_cond_timedwait);

__weak_reference(_pthread_cond_init, pthread_cond_init);
__weak_reference(_pthread_cond_destroy, pthread_cond_destroy);
__weak_reference(_pthread_cond_signal, pthread_cond_signal);
__weak_reference(_pthread_cond_broadcast, pthread_cond_broadcast);

static int
cond_init(pthread_cond_t *cond, const pthread_condattr_t *cond_attr)
{
	pthread_cond_t	pcond;
	int             rval = 0;

	if ((pcond = (pthread_cond_t)
	    malloc(sizeof(struct pthread_cond))) == NULL) {
		rval = ENOMEM;
	} else {
		/*
		 * Initialise the condition variable structure:
		 */
		_thr_umtx_init(&pcond->c_lock);
		pcond->c_seqno = 0;
		pcond->c_waiters = 0;
		pcond->c_wakeups = 0;
		if (cond_attr == NULL || *cond_attr == NULL) {
			pcond->c_pshared = 0;
			pcond->c_clockid = CLOCK_REALTIME;
		} else {
			pcond->c_pshared = (*cond_attr)->c_pshared;
			pcond->c_clockid = (*cond_attr)->c_clockid;
		}
		*cond = pcond;
	}
	/* Return the completion status: */
	return (rval);
}

static int
init_static(struct pthread *thread, pthread_cond_t *cond)
{
	int ret;

	THR_LOCK_ACQUIRE(thread, &_cond_static_lock);

	if (*cond == NULL)
		ret = cond_init(cond, NULL);
	else
		ret = 0;

	THR_LOCK_RELEASE(thread, &_cond_static_lock);

	return (ret);
}

int
_pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *cond_attr)
{

	*cond = NULL;
	return (cond_init(cond, cond_attr));
}

int
_pthread_cond_destroy(pthread_cond_t *cond)
{
	struct pthread_cond	*cv;
	struct pthread		*curthread = _get_curthread();
	int			rval = 0;

	if (*cond == NULL)
		rval = EINVAL;
	else {
		/* Lock the condition variable structure: */
		THR_LOCK_ACQUIRE(curthread, &(*cond)->c_lock);
		if ((*cond)->c_waiters + (*cond)->c_wakeups != 0) {
			THR_LOCK_RELEASE(curthread, &(*cond)->c_lock);
			return (EBUSY);
		}

		/*
		 * NULL the caller's pointer now that the condition
		 * variable has been destroyed:
		 */
		cv = *cond;
		*cond = NULL;

		/* Unlock the condition variable structure: */
		THR_LOCK_RELEASE(curthread, &cv->c_lock);

		/* Free the cond lock structure: */

		/*
		 * Free the memory allocated for the condition
		 * variable structure:
		 */
		free(cv);

	}
	/* Return the completion status: */
	return (rval);
}

struct cond_cancel_info
{
	pthread_mutex_t	*mutex;
	pthread_cond_t	*cond;
	long		seqno;
};

static void
cond_cancel_handler(void *arg)
{
	struct pthread *curthread = _get_curthread();
	struct cond_cancel_info *cci = (struct cond_cancel_info *)arg;
	pthread_cond_t cv;

	cv = *(cci->cond);
	THR_LOCK_ACQUIRE(curthread, &cv->c_lock);
	if (cv->c_seqno != cci->seqno && cv->c_wakeups != 0) {
		if (cv->c_waiters > 0) {
			cv->c_seqno++;
			_thr_umtx_wake(&cv->c_seqno, 1);
		} else
			cv->c_wakeups--;
	} else {
		cv->c_waiters--;
	}
	THR_LOCK_RELEASE(curthread, &cv->c_lock);

	_mutex_cv_lock(cci->mutex);
}

static int
cond_wait_common(pthread_cond_t *cond, pthread_mutex_t *mutex,
	const struct timespec *abstime, int cancel)
{
	struct pthread	*curthread = _get_curthread();
	struct timespec ts, ts2, *tsp;
	struct cond_cancel_info cci;
	pthread_cond_t  cv;
	long		seq, oldseq;
	int		oldcancel;
	int		ret = 0;

	/*
	 * If the condition variable is statically initialized,
	 * perform the dynamic initialization:
	 */
	if (__predict_false(*cond == NULL &&
	    (ret = init_static(curthread, cond)) != 0))
		return (ret);

	cv = *cond;
	THR_LOCK_ACQUIRE(curthread, &cv->c_lock);
	ret = _mutex_cv_unlock(mutex);
	if (ret) {
		THR_LOCK_RELEASE(curthread, &cv->c_lock);
		return (ret);
	}
	oldseq = seq = cv->c_seqno;
	cci.mutex = mutex;
	cci.cond  = cond;
	cci.seqno = oldseq;

	cv->c_waiters++;
	do {
		THR_LOCK_RELEASE(curthread, &cv->c_lock);

		if (abstime != NULL) {
			clock_gettime(cv->c_clockid, &ts);
			TIMESPEC_SUB(&ts2, abstime, &ts);
			tsp = &ts2;
		} else
			tsp = NULL;

		if (cancel) {
			THR_CLEANUP_PUSH(curthread, cond_cancel_handler, &cci);
			oldcancel = _thr_cancel_enter(curthread);
			ret = _thr_umtx_wait(&cv->c_seqno, seq, tsp);
			_thr_cancel_leave(curthread, oldcancel);
			THR_CLEANUP_POP(curthread, 0);
		} else {
			ret = _thr_umtx_wait(&cv->c_seqno, seq, tsp);
		}

		THR_LOCK_ACQUIRE(curthread, &cv->c_lock);
		seq = cv->c_seqno;
		if (abstime != NULL && ret == ETIMEDOUT)
			break;

		/*
		 * loop if we have never been told to wake up
		 * or we lost a race.
		 */
	} while (seq == oldseq || cv->c_wakeups == 0);

	if (seq != oldseq && cv->c_wakeups != 0) {
		cv->c_wakeups--;
		ret = 0;
	} else {
		cv->c_waiters--;
	}
	THR_LOCK_RELEASE(curthread, &cv->c_lock);
	_mutex_cv_lock(mutex);
	return (ret);
}

int
_pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
{

	return (cond_wait_common(cond, mutex, NULL, 0));
}

int
__pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
{

	return (cond_wait_common(cond, mutex, NULL, 1));
}

int
_pthread_cond_timedwait(pthread_cond_t * cond, pthread_mutex_t * mutex,
		       const struct timespec * abstime)
{

	if (abstime == NULL || abstime->tv_sec < 0 || abstime->tv_nsec < 0 ||
	    abstime->tv_nsec >= 1000000000)
		return (EINVAL);

	return (cond_wait_common(cond, mutex, abstime, 0));
}

int
__pthread_cond_timedwait(pthread_cond_t *cond, pthread_mutex_t *mutex,
		       const struct timespec *abstime)
{

	if (abstime == NULL || abstime->tv_sec < 0 || abstime->tv_nsec < 0 ||
	    abstime->tv_nsec >= 1000000000)
		return (EINVAL);

	return (cond_wait_common(cond, mutex, abstime, 1));
}

static int
cond_signal_common(pthread_cond_t *cond, int broadcast)
{
	struct pthread	*curthread = _get_curthread();
	pthread_cond_t	cv;
	int		ret = 0, oldwaiters;

	/*
	 * If the condition variable is statically initialized, perform dynamic
	 * initialization.
	 */
	if (__predict_false(*cond == NULL &&
	    (ret = init_static(curthread, cond)) != 0))
		return (ret);

	cv = *cond;
	/* Lock the condition variable structure. */
	THR_LOCK_ACQUIRE(curthread, &cv->c_lock);
	if (cv->c_waiters) {
		if (!broadcast) {
			cv->c_wakeups++;
			cv->c_waiters--;
			cv->c_seqno++;
			_thr_umtx_wake(&cv->c_seqno, 1);
		} else {
			oldwaiters = cv->c_waiters;
			cv->c_wakeups += cv->c_waiters;
			cv->c_waiters = 0;
			cv->c_seqno++;
			_thr_umtx_wake(&cv->c_seqno, oldwaiters);
		}
	}
	THR_LOCK_RELEASE(curthread, &cv->c_lock);
	return (ret);
}

int
_pthread_cond_signal(pthread_cond_t * cond)
{

	return (cond_signal_common(cond, 0));
}

int
_pthread_cond_broadcast(pthread_cond_t * cond)
{

	return (cond_signal_common(cond, 1));
}