[apple/xnu.git] / osfmk / kern / lock.h

/*
 * Copyright (c) 2000-2005 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989,1988,1987 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */
/*
 *	File:	kern/lock.h
 *	Author:	Avadis Tevanian, Jr., Michael Wayne Young
 *	Date:	1985
 *
 *	Higher Level Locking primitives definitions
 */

#ifdef	KERNEL_PRIVATE

#ifndef	_KERN_LOCK_H_
#define	_KERN_LOCK_H_

#include <kern/simple_lock.h>
#include <machine/lock.h>
#include <sys/cdefs.h>

__BEGIN_DECLS

#ifndef	MACH_KERNEL_PRIVATE

typedef struct __mutex__ mutex_t;

#else	/* MACH_KERNEL_PRIVATE */

#define	decl_mutex_data(class,name)	class mutex_t name;
#define mutex_addr(m)			(&(m))

extern void			mutex_init(
						mutex_t		*mutex,
						unsigned short	tag);

#endif	/* MACH_KERNEL_PRIVATE */

extern mutex_t		*mutex_alloc(
						unsigned short	tag);

extern void			mutex_free(
						mutex_t		*mutex);

extern void			mutex_lock(
						mutex_t		*mutex);

extern void			mutex_unlock(
						mutex_t		*mutex);

extern boolean_t	mutex_try(
						mutex_t		*mutex);

extern void			mutex_pause(void);

#define MA_OWNED        0x01
#define MA_NOTOWNED     0x02
 
void 				_mutex_assert (
						mutex_t		*mutex,
						unsigned int	what);

#define mutex_assert(a, b)	_mutex_assert(a, b)

#ifndef	MACH_KERNEL_PRIVATE

typedef struct __lock__ lock_t;

#else	/* MACH_KERNEL_PRIVATE */

extern void			lock_init(
						lock_t		*lock,
						boolean_t	can_sleep,
						unsigned short	tag0,
						unsigned short	tag1);

#endif	/* MACH_KERNEL_PRIVATE */

extern lock_t		 *lock_alloc(
						boolean_t	can_sleep, 
						unsigned short	tag0, 
						unsigned short	tag1);

extern void			 lock_free(
						lock_t 		*lock);

extern void			lock_write(
						lock_t		*lock);

extern void			lock_read(
						lock_t		*lock);

extern void			lock_done(
						lock_t		*lock);

extern void			lock_write_to_read(
						lock_t		*lock);

#define	lock_read_done(l)		lock_done(l)
#define	lock_write_done(l)		lock_done(l)

extern boolean_t	 lock_read_to_write(
						lock_t		*lock);


/* Sleep, unlocking and then relocking a usimple_lock in the process */
extern wait_result_t	thread_sleep_usimple_lock(
							event_t				event,
							usimple_lock_t		lock,
							wait_interrupt_t	interruptible);

/* Sleep, unlocking and then relocking a mutex in the process */
extern wait_result_t	thread_sleep_mutex(
							event_t				event,
							mutex_t				*mutex,
							wait_interrupt_t	interruptible);
										
/* Sleep with a deadline, unlocking and then relocking a mutex in the process */
extern wait_result_t	thread_sleep_mutex_deadline(
							event_t				event,
							mutex_t				*mutex,
							uint64_t			deadline,
							wait_interrupt_t	interruptible);

/* Sleep, unlocking and then relocking a write lock in the process */
extern wait_result_t	thread_sleep_lock_write(
							event_t				event,
							lock_t				*lock,
							wait_interrupt_t	interruptible);
__END_DECLS

#ifdef	MACH_KERNEL_PRIVATE

extern wait_result_t	thread_sleep_fast_usimple_lock(
							event_t					event,
							simple_lock_t			lock,
							wait_interrupt_t		 interruptible);
#endif	/* MACH_KERNEL_PRIVATE */

#endif	/* _KERN_LOCK_H_ */

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