osfmk/kern/simple_lock.h

   1 /*
   2  * Copyright (c) 2000-2005 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  * Copyright (C) 1998 Apple Computer
  30  * All Rights Reserved
  31  */
  32 /*
  33  * @OSF_COPYRIGHT@
  34  */
  35 /*
  36  * Mach Operating System
  37  * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
  38  * All Rights Reserved.
  39  *
  40  * Permission to use, copy, modify and distribute this software and its
  41  * documentation is hereby granted, provided that both the copyright
  42  * notice and this permission notice appear in all copies of the
  43  * software, derivative works or modified versions, and any portions
  44  * thereof, and that both notices appear in supporting documentation.
  45  *
  46  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  47  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  48  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  49  *
  50  * Carnegie Mellon requests users of this software to return to
  51  *
  52  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  53  *  School of Computer Science
  54  *  Carnegie Mellon University
  55  *  Pittsburgh PA 15213-3890
  56  *
  57  * any improvements or extensions that they make and grant Carnegie Mellon
  58  * the rights to redistribute these changes.
  59  */
  60 /*
  61  *      File:   kern/simple_lock.h (derived from kern/lock.h)
  62  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  63  *      Date:   1985
  64  *
  65  *      Atomic primitives and Simple Locking primitives definitions
  66  */
  67
  68 #ifdef  KERNEL_PRIVATE
  69
  70 #ifndef _KERN_SIMPLE_LOCK_H_
  71 #define _KERN_SIMPLE_LOCK_H_
  72
  73 #include <sys/cdefs.h>
  74 #include <mach/boolean.h>
  75 #include <kern/kern_types.h>
  76 #include <machine/simple_lock.h>
  77
  78 #ifdef  MACH_KERNEL_PRIVATE
  79 #include <mach_ldebug.h>
  80
  81 extern void                     hw_lock_init(
  82                                         hw_lock_t);
  83
  84 extern void                     hw_lock_lock(
  85                                         hw_lock_t);
  86
  87 extern void                     hw_lock_lock_nopreempt(
  88                                         hw_lock_t);
  89
  90 extern void                     hw_lock_unlock(
  91                                         hw_lock_t);
  92
  93 extern void                     hw_lock_unlock_nopreempt(
  94                                         hw_lock_t);
  95
  96 extern unsigned int             hw_lock_to(
  97                                         hw_lock_t,
  98                                         uint64_t);
  99
 100 extern unsigned int             hw_lock_try(
 101                                         hw_lock_t);
 102
 103 extern unsigned int             hw_lock_try_nopreempt(
 104                                         hw_lock_t);
 105
 106 extern unsigned int             hw_lock_held(
 107                                         hw_lock_t);
 108
 109 #endif  /* MACH_KERNEL_PRIVATE */
 110
 111 __BEGIN_DECLS
 112
 113 extern uint32_t                 hw_atomic_add(
 114                                         volatile uint32_t       *dest,
 115                                         uint32_t        delt);
 116
 117 extern uint32_t                 hw_atomic_sub(
 118                                         volatile uint32_t       *dest,
 119                                         uint32_t        delt);
 120
 121 extern uint32_t                 hw_atomic_or(
 122                                         volatile uint32_t       *dest,
 123                                         uint32_t        mask);
 124
 125 extern uint32_t                 hw_atomic_and(
 126                                         volatile uint32_t       *dest,
 127                                         uint32_t        mask);
 128
 129 /*
 130  * Variant of hw_atomic_or which doesn't return a value; potentially
 131  * more efficient on some platforms.
 132  */
 133 extern void                     hw_atomic_or_noret(
 134                                         volatile uint32_t       *dest,
 135                                         uint32_t        mask);
 136 /*
 137  * Variant of hw_atomic_and which doesn't return a value; potentially
 138  * more efficient on some platforms.
 139  */
 140
 141 extern void                     hw_atomic_and_noret(
 142                                         volatile uint32_t       *dest,
 143                                         uint32_t        mask);
 144
 145 extern uint32_t                 hw_compare_and_store(
 146                                         uint32_t        oldval,
 147                                         uint32_t        newval,
 148                                         volatile uint32_t       *dest);
 149
 150 extern void                     hw_queue_atomic(
 151                                         unsigned int *anchor,
 152                                         unsigned int *elem,
 153                                         unsigned int disp);
 154
 155 extern void                     hw_queue_atomic_list(
 156                                         unsigned int *anchor,
 157                                         unsigned int *first,
 158                                         unsigned int *last,
 159                                         unsigned int disp);
 160
 161 extern unsigned int             *hw_dequeue_atomic(
 162                                         unsigned int *anchor,
 163                                         unsigned int disp);
 164
 165 extern void                     usimple_lock_init(
 166                                         usimple_lock_t,
 167                                         unsigned short);
 168
 169 extern void                     usimple_lock(
 170                                         usimple_lock_t);
 171
 172 extern void                     usimple_unlock(
 173                                         usimple_lock_t);
 174
 175 extern unsigned int             usimple_lock_try(
 176                                         usimple_lock_t);
 177
 178 extern void             usimple_lock_try_lock_loop(
 179                                         usimple_lock_t);
 180
 181 __END_DECLS
 182
 183 #define ETAP_NO_TRACE   0
 184 #define ETAP_IO_AHA             0
 185
 186 /*
 187  * If we got to here and we still don't have simple_lock_init
 188  * defined, then we must either be outside the osfmk component,
 189  * running on a true SMP, or need debug.
 190  */
 191 #if !defined(simple_lock_init)
 192 #define simple_lock_init(l,t)   usimple_lock_init(l,t)
 193 #define simple_lock(l)          usimple_lock(l)
 194 #define simple_unlock(l)        usimple_unlock(l)
 195 #define simple_lock_try(l)      usimple_lock_try(l)
 196 #define simple_lock_try_lock_loop(l)    usimple_lock_try_lock_loop(l)
 197 #define simple_lock_addr(l)     (&(l))
 198 #endif /* !defined(simple_lock_init) */
 199
 200 #endif /*!_KERN_SIMPLE_LOCK_H_*/
 201
 202 #endif  /* KERNEL_PRIVATE */