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