fbsdcompat/spinlock.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
  25  * All rights reserved.
  26  *
  27  * Redistribution and use in source and binary forms, with or without
  28  * modification, are permitted provided that the following conditions
  29  * are met:
  30  * 1. Redistributions of source code must retain the above copyright
  31  *    notice, this list of conditions and the following disclaimer.
  32  * 2. Redistributions in binary form must reproduce the above copyright
  33  *    notice, this list of conditions and the following disclaimer in the
  34  *    documentation and/or other materials provided with the distribution.
  35  * 3. All advertising materials mentioning features or use of this software
  36  *    must display the following acknowledgement:
  37  *      This product includes software developed by John Birrell.
  38  * 4. Neither the name of the author nor the names of any co-contributors
  39  *    may be used to endorse or promote products derived from this software
  40  *    without specific prior written permission.
  41  *
  42  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  43  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  44  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  45  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  46  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  47  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  48  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  49  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  50  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  51  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  52  * SUCH DAMAGE.
  53  *
  54  * $FreeBSD: src/lib/libc/include/spinlock.h,v 1.5 2002/03/21 22:47:52 obrien Exp $
  55  *
  56  * Lock definitions used in both libc and libpthread.
  57  *
  58  */
  59
  60 #ifndef _SPINLOCK_H_
  61 #define _SPINLOCK_H_
  62 #ifdef __APPLE__
  63 #include <os/lock.h>
  64
  65 typedef os_unfair_lock spinlock_t;
  66
  67 #define _SPINLOCK_INITIALIZER   OS_UNFAIR_LOCK_INIT
  68
  69 #define _SPINLOCK(_lck)                                                 \
  70     do {                                                                \
  71         os_unfair_lock_lock(_lck);                                      \
  72     } while (0)
  73
  74 #define _SPINUNLOCK(_lck)                                               \
  75     do {                                                                \
  76         os_unfair_lock_unlock(_lck);                                    \
  77     } while (0)
  78
  79 #else /* ! __APPLE__ */
  80 #include <sys/cdefs.h>
  81 #include <sys/types.h>
  82
  83 /*
  84  * Lock structure with room for debugging information.
  85  */
  86 typedef struct {
  87         volatile long   access_lock;
  88         volatile long   lock_owner;
  89         volatile char   *fname;
  90         volatile int    lineno;
  91 } spinlock_t;
  92
  93 #define _SPINLOCK_INITIALIZER   { 0, 0, 0, 0 }
  94
  95 #define _SPINUNLOCK(_lck)       (_lck)->access_lock = 0
  96 #ifdef  _LOCK_DEBUG
  97 #define _SPINLOCK(_lck)         _spinlock_debug(_lck, __FILE__, __LINE__)
  98 #else
  99 #define _SPINLOCK(_lck)         _spinlock(_lck)
 100 #endif
 101
 102 /*
 103  * Thread function prototype definitions:
 104  */
 105 __BEGIN_DECLS
 106 long    _atomic_lock(volatile long *);
 107 void    _spinlock(spinlock_t *);
 108 void    _spinlock_debug(spinlock_t *, char *, int);
 109 __END_DECLS
 110
 111 #endif /* __APPLE__ */
 112
 113 #endif /* _SPINLOCK_H_ */