osfmk/ppc/simple_lock.h

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