osfmk/ppc/simple_lock.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56
  57 #ifdef  KERNEL_PRIVATE
  58
  59 #ifndef _PPC_SIMPLE_LOCK_TYPES_H_
  60 #define _PPC_SIMPLE_LOCK_TYPES_H_
  61
  62 #ifdef  KERNEL_PRIVATE
  63 #include <mach/boolean.h>
  64 #include <kern/kern_types.h>
  65
  66 #include <sys/appleapiopts.h>
  67 #ifdef  MACH_KERNEL_PRIVATE
  68 #include <ppc/hw_lock_types.h>
  69 #include <ppc/locks.h>
  70 #include <mach_ldebug.h>
  71 #endif
  72
  73 #ifdef MACH_KERNEL_PRIVATE
  74
  75 #if MACH_LDEBUG
  76 #define USLOCK_DEBUG 1
  77 #else
  78 #define USLOCK_DEBUG 0
  79 #endif
  80
  81 #if     !USLOCK_DEBUG
  82
  83 typedef lck_spin_t usimple_lock_data_t, *usimple_lock_t;
  84
  85 #else
  86
  87 typedef struct uslock_debug {
  88         void                    *lock_pc;       /* pc where lock operation began    */
  89         void                    *lock_thread;   /* thread that acquired lock */
  90         unsigned long   duration[2];
  91         unsigned short  state;
  92         unsigned char   lock_cpu;
  93         void                    *unlock_thread; /* last thread to release lock */
  94         unsigned char   unlock_cpu;
  95         void                    *unlock_pc;     /* pc where lock operation ended    */
  96 } uslock_debug;
  97
  98 typedef struct {
  99         hw_lock_data_t  interlock;      /* must be first... see lock.c */
 100         unsigned short  lock_type;      /* must be second... see lock.c */
 101 #define USLOCK_TAG      0x5353
 102         uslock_debug    debug;
 103 } usimple_lock_data_t, *usimple_lock_t;
 104
 105 #endif  /* USLOCK_DEBUG */
 106
 107 #else
 108
 109 typedef struct slock {
 110         unsigned int    lock_data[10];
 111 } usimple_lock_data_t, *usimple_lock_t;
 112
 113 #endif  /* MACH_KERNEL_PRIVATE */
 114
 115 #define USIMPLE_LOCK_NULL       ((usimple_lock_t) 0)
 116
 117 #if !defined(decl_simple_lock_data)
 118
 119 typedef usimple_lock_data_t     *simple_lock_t;
 120 typedef usimple_lock_data_t     simple_lock_data_t;
 121
 122 #define decl_simple_lock_data(class,name) \
 123         class   simple_lock_data_t      name;
 124
 125 #endif  /* !defined(decl_simple_lock_data) */
 126
 127 #ifdef  MACH_KERNEL_PRIVATE
 128 #if     !MACH_LDEBUG
 129
 130 #define MACHINE_SIMPLE_LOCK
 131
 132 extern void                                             ppc_usimple_lock_init(simple_lock_t,unsigned short);
 133 extern void                                             ppc_usimple_lock(simple_lock_t);
 134 extern void                                             ppc_usimple_unlock_rwmb(simple_lock_t);
 135 extern void                                             ppc_usimple_unlock_rwcmb(simple_lock_t);
 136 extern unsigned int                             ppc_usimple_lock_try(simple_lock_t);
 137
 138 #define simple_lock_init(l,t)   ppc_usimple_lock_init(l,t)
 139 #define simple_lock(l)                  ppc_usimple_lock(l)
 140 #define simple_unlock(l)                ppc_usimple_unlock_rwcmb(l)
 141 #define simple_unlock_rwmb(l)   ppc_usimple_unlock_rwmb(l)
 142 #define simple_lock_try(l)              ppc_usimple_lock_try(l)
 143 #define simple_lock_addr(l)             (&(l))
 144 #define thread_sleep_simple_lock(l, e, i) \
 145                                                                 thread_sleep_fast_usimple_lock((l), (e), (i))
 146 #endif  /* !MACH_LDEBUG */
 147
 148 extern unsigned int             hw_lock_bit(
 149                                         unsigned int *,
 150                                         unsigned int,
 151                                         unsigned int);
 152
 153 extern unsigned int             hw_cpu_sync(
 154                                         unsigned int *,
 155                                         unsigned int);
 156
 157 extern unsigned int             hw_cpu_wcng(
 158                                         unsigned int *,
 159                                         unsigned int,
 160                                         unsigned int);
 161
 162 extern unsigned int             hw_lock_mbits(
 163                                         unsigned int *,
 164                                         unsigned int,
 165                                         unsigned int,
 166                                         unsigned int,
 167                                         unsigned int);
 168
 169 void                            hw_unlock_bit(
 170                                         unsigned int *,
 171                                         unsigned int);
 172
 173 #endif  /* MACH_KERNEL_PRIVATE */
 174 #endif  /* KERNEL_PRIVATE */
 175
 176 #endif /* !_PPC_SIMPLE_LOCK_TYPES_H_ */
 177
 178 #endif  /* KERNEL_PRIVATE */