]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/i386/lock.h
xnu-7195.50.7.100.1.tar.gz
[apple/xnu.git] / osfmk / i386 / lock.h
index 8f31c69bb03f1720fbd59c59016c88912c9ab688..bdd42a5afcb0e31d57435d2d782944812a2ddcc5 100644 (file)
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
- * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
- * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
- * 
- * @APPLE_LICENSE_HEADER_END@
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (C) 1998 Apple Computer
 /*
  * @OSF_COPYRIGHT@
  */
-/* 
+/*
  * Mach Operating System
  * Copyright (c) 1991,1990 Carnegie Mellon University
  * All Rights Reserved.
- * 
+ *
  * Permission to use, copy, modify and distribute this software and its
  * documentation is hereby granted, provided that both the copyright
  * notice and this permission notice appear in all copies of the
  * software, derivative works or modified versions, and any portions
  * thereof, and that both notices appear in supporting documentation.
- * 
+ *
  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
- * 
+ *
  * Carnegie Mellon requests users of this software to return to
- * 
+ *
  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  *  School of Computer Science
  *  Carnegie Mellon University
  *  Pittsburgh PA 15213-3890
- * 
+ *
  * any improvements or extensions that they make and grant Carnegie Mellon
  * the rights to redistribute these changes.
  */
 /*
  * Machine-dependent simple locks for the i386.
  */
-#ifdef KERNEL_PRIVATE
-
-#ifndef        _I386_LOCK_H_
-#define        _I386_LOCK_H_
-
-#include <sys/appleapiopts.h>
-
-#ifdef __APPLE_API_PRIVATE
-
-#ifdef MACH_KERNEL_PRIVATE
-
-#include <kern/macro_help.h>
-#include <kern/assert.h>
-#include <i386/hw_lock_types.h>
-#include <i386/locks.h>
-
-#include <mach_rt.h>
-#include <mach_ldebug.h>
-
-typedef struct {
-       lck_mtx_t       lck_mtx;        /* inlined lck_mtx, need to be first */
-#if     MACH_LDEBUG     
-       int                             type;
-#define MUTEX_TAG       0x4d4d
-       vm_offset_t             pc;
-       vm_offset_t             thread;
-#endif  /* MACH_LDEBUG */
-} mutex_t;
-
-typedef struct {
-       decl_simple_lock_data(,interlock) /* "hardware" interlock field */
-       volatile unsigned int
-               read_count:16,  /* No. of accepted readers */
-               want_upgrade:1, /* Read-to-write upgrade waiting */
-               want_write:1,   /* Writer is waiting, or locked for write */ 
-               waiting:1,              /* Someone is sleeping on lock */
-       can_sleep:1;            /* Can attempts to lock go to sleep? */
-} lock_t;
-
-extern unsigned int LockTimeOut;                       /* Number of hardware ticks of a lock timeout */
-
-
-#if defined(__GNUC__)
-
-/*
- *     General bit-lock routines.
- */
-
-#define        bit_lock(bit,l)                                                 \
-       __asm__ volatile("      jmp     1f      \n                      \
-                       0:      btl     %0, %1  \n                      \
-                               jb      0b      \n                      \
-                       1:      lock            \n                      \
-                               btsl    %0,%1   \n                      \
-                               jb      0b"                     :       \
-                                                               :       \
-                       "r" (bit), "m" (*(volatile int *)(l))   :       \
-                       "memory");
-
-#define        bit_unlock(bit,l)                                               \
-       __asm__ volatile("      lock            \n                      \
-                               btrl    %0,%1"                  :       \
-                                                               :       \
-                       "r" (bit), "m" (*(volatile int *)(l)));
-
-/*
- *      Set or clear individual bits in a long word.
- *      The locked access is needed only to lock access
- *      to the word, not to individual bits.
- */
-
-#define        i_bit_set(bit,l)                                                \
-       __asm__ volatile("      lock            \n                      \
-                               btsl    %0,%1"                  :       \
-                                                               :       \
-                       "r" (bit), "m" (*(volatile int *)(l)));
-
-#define        i_bit_clear(bit,l)                                              \
-       __asm__ volatile("      lock            \n                      \
-                               btrl    %0,%1"                  :       \
-                                                               :       \
-                       "r" (bit), "m" (*(volatile int *)(l)));
-
-static inline unsigned long i_bit_isset(unsigned int test, volatile unsigned long *word)
-{
-       int     bit;
-
-       __asm__ volatile("btl %2,%1\n\tsbbl %0,%0" : "=r" (bit)
-               : "m" (word), "ir" (test));
-       return bit;
-}
-
-static inline char     xchgb(volatile char * cp, char new);
-
-static inline void     atomic_incl(long * p, long delta);
-static inline void     atomic_incs(short * p, short delta);
-static inline void     atomic_incb(char * p, char delta);
-
-static inline void     atomic_decl(long * p, long delta);
-static inline void     atomic_decs(short * p, short delta);
-static inline void     atomic_decb(char * p, char delta);
-
-static inline long     atomic_getl(long * p);
-static inline short    atomic_gets(short * p);
-static inline char     atomic_getb(char * p);
-
-static inline void     atomic_setl(long * p, long value);
-static inline void     atomic_sets(short * p, short value);
-static inline void     atomic_setb(char * p, char value);
-
-static inline char     xchgb(volatile char * cp, char new)
-{
-       register char   old = new;
-
-       __asm__ volatile ("     xchgb   %0,%2"                  :
-                       "=q" (old)                              :
-                       "0" (new), "m" (*(volatile char *)cp) : "memory");
-       return (old);
-}
-
-/*
- * Compare and exchange:
- * - returns failure (0) if the location did not contain the old value,
- * - returns success (1) if the location was set to the new value.
- */
-static inline uint32_t
-atomic_cmpxchg(uint32_t *p, uint32_t old, uint32_t new)
-{
-       uint32_t res = old;
-
-       asm volatile(
-               "lock;  cmpxchgl        %1,%2;  \n\t"
-               "       setz            %%al;   \n\t"
-               "       movzbl          %%al,%0"
-               : "+a" (res)    /* %0: old value to compare, returns success */
-               : "r" (new),    /* %1: new value to set */
-                 "m" (*(p))    /* %2: memory address */
-               : "memory");
-       return (res);
-}
-
-static inline uint64_t
-atomic_load64(uint64_t *quadp)
-{
-       uint64_t ret;
-
-       asm volatile(
-               "       lock; cmpxchg8b %1"
-               : "=A" (ret)
-               : "m" (*quadp), "a" (0), "d" (0), "b" (0), "c" (0));
-       return (ret);
-}
-
-static inline uint64_t
-atomic_loadstore64(uint64_t *quadp, uint64_t new)
-{
-       uint64_t ret;
-
-       ret = *quadp;
-       asm volatile(
-               "1:                             \n\t"
-               "       lock; cmpxchg8b %1      \n\t"
-               "       jnz     1b"
-               : "+A" (ret)
-               : "m" (*quadp),
-                 "b" ((uint32_t)new), "c" ((uint32_t)(new >> 32)));
-       return (ret);
-}
-
-static inline void     atomic_incl(long * p, long delta)
-{
-       __asm__ volatile ("     lock            \n              \
-                               addl    %0,%1"          :       \
-                                                       :       \
-                               "r" (delta), "m" (*(volatile long *)p));
-}
-
-static inline void     atomic_incs(short * p, short delta)
-{
-       __asm__ volatile ("     lock            \n              \
-                               addw    %0,%1"          :       \
-                                                       :       \
-                               "q" (delta), "m" (*(volatile short *)p));
-}
-
-static inline void     atomic_incb(char * p, char delta)
-{
-       __asm__ volatile ("     lock            \n              \
-                               addb    %0,%1"          :       \
-                                                       :       \
-                               "q" (delta), "m" (*(volatile char *)p));
-}
-
-static inline void     atomic_decl(long * p, long delta)
-{
-       __asm__ volatile ("     lock            \n              \
-                               subl    %0,%1"          :       \
-                                                       :       \
-                               "r" (delta), "m" (*(volatile long *)p));
-}
-
-static inline int      atomic_decl_and_test(long * p, long delta)
-{
-       uint8_t ret;
-       asm volatile (
-               "       lock            \n\t"
-               "       subl    %1,%2   \n\t"
-               "       sete    %0"
-               : "=qm" (ret)
-               : "r" (delta), "m" (*(volatile long *)p));
-       return ret;
-}
-
-static inline void     atomic_decs(short * p, short delta)
-{
-       __asm__ volatile ("     lock            \n              \
-                               subw    %0,%1"          :       \
-                                                       :       \
-                               "q" (delta), "m" (*(volatile short *)p));
-}
-
-static inline void     atomic_decb(char * p, char delta)
-{
-       __asm__ volatile ("     lock            \n              \
-                               subb    %0,%1"          :       \
-                                                       :       \
-                               "q" (delta), "m" (*(volatile char *)p));
-}
-
-static inline long     atomic_getl(long * p)
-{
-       return (*p);
-}
-
-static inline short    atomic_gets(short * p)
-{
-       return (*p);
-}
-
-static inline char     atomic_getb(char * p)
-{
-       return (*p);
-}
-
-static inline void     atomic_setl(long * p, long value)
-{
-       *p = value;
-}
-
-static inline void     atomic_sets(short * p, short value)
-{
-       *p = value;
-}
-
-static inline void     atomic_setb(char * p, char value)
-{
-       *p = value;
-}
-
-
-#else  /* !defined(__GNUC__) */
-
-extern void    i_bit_set(
-       int index,
-       void *addr);
-
-extern void    i_bit_clear(
-       int index,
-       void *addr);
-
-extern void bit_lock(
-       int index,
-       void *addr);
-
-extern void bit_unlock(
-       int index,
-       void *addr);
-
-/*
- * All other routines defined in __GNUC__ case lack
- * definitions otherwise. - XXX
- */
-
-#endif /* !defined(__GNUC__) */
-
-extern void            kernel_preempt_check (void);
+#ifdef  KERNEL_PRIVATE
 
-#endif /* MACH_KERNEL_PRIVATE */
+#ifndef _I386_LOCK_H_
+#define _I386_LOCK_H_
 
-#endif /* __APLE_API_PRIVATE */
+#warning This header is deprecated. Use <kern/locks.h> instead.
 
-#endif /* _I386_LOCK_H_ */
+#endif  /* _I386_LOCK_H_ */
 
-#endif /* KERNEL_PRIVATE */
+#endif  /* KERNEL_PRIVATE */