osfmk/kern/lock.h

   1 /*
   2  * Copyright (c) 2000-2005 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  *      File:   kern/lock.h
  60  *      Author: Avadis Tevanian, Jr., Michael Wayne Young
  61  *      Date:   1985
  62  *
  63  *      Higher Level Locking primitives definitions
  64  */
  65
  66 #ifdef  KERNEL_PRIVATE
  67
  68 #ifndef _KERN_LOCK_H_
  69 #define _KERN_LOCK_H_
  70
  71 #include <kern/simple_lock.h>
  72 #include <machine/lock.h>
  73 #include <sys/cdefs.h>
  74
  75 __BEGIN_DECLS
  76
  77 #ifndef MACH_KERNEL_PRIVATE
  78
  79 typedef struct __mutex__ mutex_t;
  80
  81 #else   /* MACH_KERNEL_PRIVATE */
  82
  83 #define decl_mutex_data(class,name)     class mutex_t name;
  84 #define mutex_addr(m)                   (&(m))
  85
  86 extern void                     mutex_init(
  87                                                 mutex_t         *mutex,
  88                                                 unsigned short  tag);
  89
  90 #endif  /* MACH_KERNEL_PRIVATE */
  91
  92 extern mutex_t          *mutex_alloc(
  93                                                 unsigned short  tag);
  94
  95 extern void                     mutex_free(
  96                                                 mutex_t         *mutex);
  97
  98 extern void                     mutex_lock(
  99                                                 mutex_t         *mutex);
 100
 101 extern void                     mutex_unlock(
 102                                                 mutex_t         *mutex);
 103
 104 extern boolean_t        mutex_try(
 105                                                 mutex_t         *mutex);
 106
 107 extern void                     mutex_pause(void);
 108
 109 #define MA_OWNED        0x01
 110 #define MA_NOTOWNED     0x02
 111
 112 void                            _mutex_assert (
 113                                                 mutex_t         *mutex,
 114                                                 unsigned int    what);
 115
 116 #define mutex_assert(a, b)      _mutex_assert(a, b)
 117
 118 #ifndef MACH_KERNEL_PRIVATE
 119
 120 typedef struct __lock__ lock_t;
 121
 122 #else   /* MACH_KERNEL_PRIVATE */
 123
 124 extern void                     lock_init(
 125                                                 lock_t          *lock,
 126                                                 boolean_t       can_sleep,
 127                                                 unsigned short  tag0,
 128                                                 unsigned short  tag1);
 129
 130 #endif  /* MACH_KERNEL_PRIVATE */
 131
 132 extern lock_t            *lock_alloc(
 133                                                 boolean_t       can_sleep,
 134                                                 unsigned short  tag0,
 135                                                 unsigned short  tag1);
 136
 137 extern void                      lock_free(
 138                                                 lock_t          *lock);
 139
 140 extern void                     lock_write(
 141                                                 lock_t          *lock);
 142
 143 extern void                     lock_read(
 144                                                 lock_t          *lock);
 145
 146 extern void                     lock_done(
 147                                                 lock_t          *lock);
 148
 149 extern void                     lock_write_to_read(
 150                                                 lock_t          *lock);
 151
 152 #define lock_read_done(l)               lock_done(l)
 153 #define lock_write_done(l)              lock_done(l)
 154
 155 extern boolean_t         lock_read_to_write(
 156                                                 lock_t          *lock);
 157
 158
 159 /* Sleep, unlocking and then relocking a usimple_lock in the process */
 160 extern wait_result_t    thread_sleep_usimple_lock(
 161                                                         event_t                         event,
 162                                                         usimple_lock_t          lock,
 163                                                         wait_interrupt_t        interruptible);
 164
 165 /* Sleep, unlocking and then relocking a mutex in the process */
 166 extern wait_result_t    thread_sleep_mutex(
 167                                                         event_t                         event,
 168                                                         mutex_t                         *mutex,
 169                                                         wait_interrupt_t        interruptible);
 170
 171 /* Sleep with a deadline, unlocking and then relocking a mutex in the process */
 172 extern wait_result_t    thread_sleep_mutex_deadline(
 173                                                         event_t                         event,
 174                                                         mutex_t                         *mutex,
 175                                                         uint64_t                        deadline,
 176                                                         wait_interrupt_t        interruptible);
 177
 178 /* Sleep, unlocking and then relocking a write lock in the process */
 179 extern wait_result_t    thread_sleep_lock_write(
 180                                                         event_t                         event,
 181                                                         lock_t                          *lock,
 182                                                         wait_interrupt_t        interruptible);
 183 __END_DECLS
 184
 185 #ifdef  MACH_KERNEL_PRIVATE
 186
 187 extern wait_result_t    thread_sleep_fast_usimple_lock(
 188                                                         event_t                                 event,
 189                                                         simple_lock_t                   lock,
 190                                                         wait_interrupt_t                 interruptible);
 191 #endif  /* MACH_KERNEL_PRIVATE */
 192
 193 #endif  /* _KERN_LOCK_H_ */
 194
 195 #endif  /* KERNEL_PRIVATE */