Return to simplelock.h CVS log

Up to [local] / sys / sys

Initial revision

/*	$OpenBSD: simplelock.h,v 1.11 2004/06/13 21:49:28 niklas Exp $	*/

#ifndef _SIMPLELOCK_H_
#define _SIMPLELOCK_H_

#ifdef MULTIPROCESSOR
#include <machine/lock.h>
#endif

/*
 * A simple spin lock.
 *
 * This structure only sets one bit of data, but is sized based on the
 * minimum word size that can be operated on by the hardware test-and-set
 * instruction. It is only needed for multiprocessors, as uniprocessors
 * will always run to completion or a sleep. It is an error to hold one
 * of these locks while a process is sleeping.
 */
struct simplelock {
#ifdef MULTIPROCESSOR
	__cpu_simple_lock_t lock_data;
#else
	int	lock_data;
#endif
};

#ifdef _KERNEL

/*
 * We can't debug locks when we use them in real life.
 */
#if defined(MULTIPROCESSOR) && defined(LOCKDEBUG)
#undef LOCKDEBUG
#endif

#if !defined(MULTIPROCESSOR) || 1

#define SLOCK_LOCKED 1
#define SLOCK_UNLOCKED 0

#ifndef LOCKDEBUG

#define	simple_lock(lkp)
#define	simple_lock_try(lkp)	(1)	/* always succeeds */
#define	simple_unlock(lkp)
#define simple_lock_assert(lkp)

static __inline void simple_lock_init(struct simplelock *lkp)
{

	lkp->lock_data = SLOCK_UNLOCKED;
}

#else

void _simple_unlock(__volatile struct simplelock *, const char *, int);
int _simple_lock_try(__volatile struct simplelock *, const char *, int);
void _simple_lock(__volatile struct simplelock *, const char *, int);
void _simple_lock_assert(__volatile struct simplelock *, int, const char *, int);

void simple_lock_init(struct simplelock *);
#define simple_unlock(lkp) _simple_unlock(lkp, __FILE__, __LINE__)
#define simple_lock_try(lkp) _simple_lock_try(lkp, __FILE__, __LINE__)
#define simple_lock(lkp) _simple_lock(lkp, __FILE__, __LINE__)
#define simple_lock_assert(lkp, state) _simple_lock_assert(lkp, state, __FILE__, __LINE__)

#endif /* !defined(LOCKDEBUG) */

#else  /* MULTIPROCESSOR */

/*
 * The simple-lock routines are the primitives out of which the lock
 * package is built. The machine-dependent code must implement an
 * atomic test_and_set operation that indivisibly sets the simple lock
 * to non-zero and returns its old value. It also assumes that the
 * setting of the lock to zero below is indivisible. Simple locks may
 * only be used for exclusive locks.
 */

static __inline void simple_lock_init(struct simplelock *lkp)
{
	__cpu_simple_lock_init(&lkp->lock_data);
}

static __inline void simple_lock(__volatile struct simplelock *lkp)
{
	__cpu_simple_lock(&lkp->lock_data);
}

static __inline int simple_lock_try(__volatile struct simplelock *lkp)
{
	return (__cpu_simple_lock_try(&lkp->lock_data));
}

static __inline void simple_unlock(__volatile struct simplelock *lkp)
{
	__cpu_simple_unlock(&lkp->lock_data);
}
#endif /* MULTIPROCESSOR */

#endif /* _KERNEL */

#endif /* !_SIMPLELOCK_H_ */