lib/libc/include/spinlock.h

   1 /*
   2  * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the author nor the names of any co-contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  *
  31  * Lock definitions used in both libc and libpthread.
  32  *
  33  */
  34
  35 #ifndef _SPINLOCK_H_
  36 #define _SPINLOCK_H_
  37 #include <sys/cdefs.h>
  38 #include <sys/types.h>
  39
  40 /*
  41  * Lock structure with room for debugging information.
  42  */
  43 struct _spinlock {
  44         volatile long   access_lock;
  45         volatile long   lock_owner;
  46         volatile char   *fname;
  47         volatile int    lineno;
  48 };
  49 typedef struct _spinlock spinlock_t;
  50
  51 #define _SPINLOCK_INITIALIZER   { 0, 0, 0, 0 }
  52
  53 #define _SPINUNLOCK(_lck)       _spinunlock(_lck);
  54 #ifdef  _LOCK_DEBUG
  55 #define _SPINLOCK(_lck)         _spinlock_debug(_lck, __FILE__, __LINE__)
  56 #else
  57 #define _SPINLOCK(_lck)         _spinlock(_lck)
  58 #endif
  59
  60 /*
  61  * Thread function prototype definitions:
  62  */
  63 __BEGIN_DECLS
  64 long    _atomic_lock(volatile long *);
  65 void    _spinlock(spinlock_t *);
  66 void    _spinunlock(spinlock_t *);
  67 void    _spinlock_debug(spinlock_t *, char *, int);
  68 __END_DECLS
  69
  70 #endif /* _SPINLOCK_H_ */