[apple/xnu.git] / osfmk / i386 / locks.h

/*
 * Copyright (c) 2004-2007 Apple 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@
 */

#ifndef	_I386_LOCKS_H_
#define	_I386_LOCKS_H_

#include <sys/appleapiopts.h>
#include <kern/kern_types.h>

#ifdef	MACH_KERNEL_PRIVATE

#include <i386/hw_lock_types.h>

extern	unsigned int	LcksOpts;

#define enaLkDeb		0x00000001	/* Request debug in default attribute */
#define enaLkStat		0x00000002	/* Request statistic in default attribute */

#endif /* MACH_KERNEL_PRIVATE */

#if	defined(MACH_KERNEL_PRIVATE)
typedef struct {
	volatile uintptr_t	interlock;
#if	MACH_LDEBUG
	unsigned long   lck_spin_pad[9];	/* XXX - usimple_lock_data_t */
#endif
} lck_spin_t;

#define	LCK_SPIN_TAG_DESTROYED		0x00002007	/* lock marked as Destroyed */

#else /* MACH_KERNEL_PRIVATE */
#ifdef	KERNEL_PRIVATE
typedef struct {
	unsigned long    opaque[10];
} lck_spin_t;
#else /* KERNEL_PRIVATE */
typedef	struct __lck_spin_t__	lck_spin_t;
#endif
#endif

#ifdef	MACH_KERNEL_PRIVATE
/* The definition of this structure, including the layout of the
 * state bitfield, is tailored to the asm implementation in i386_lock.s
 */
typedef struct _lck_mtx_ {
	union {
		struct {
			volatile uintptr_t		lck_mtxd_owner;
			union {
				struct {
					volatile uint32_t
						lck_mtxd_waiters:16,
						lck_mtxd_pri:8,
						lck_mtxd_ilocked:1,
						lck_mtxd_mlocked:1,
						lck_mtxd_promoted:1,
						lck_mtxd_spin:1,
						lck_mtxd_is_ext:1,
						lck_mtxd_pad3:3;
				};
					uint32_t	lck_mtxd_state;
			};
#if	defined(__x86_64__)
			/* Pad field used as a canary, initialized to ~0 */
			uint32_t			lck_mtxd_pad32;
#endif			
		} lck_mtxd;
		struct {
			struct _lck_mtx_ext_		*lck_mtxi_ptr;
			uint32_t			lck_mtxi_tag;
#if	defined(__x86_64__)				
			uint32_t			lck_mtxi_pad32;
#endif			
		} lck_mtxi;
	} lck_mtx_sw;
} lck_mtx_t;

#define	lck_mtx_owner	lck_mtx_sw.lck_mtxd.lck_mtxd_owner
#define	lck_mtx_waiters	lck_mtx_sw.lck_mtxd.lck_mtxd_waiters
#define	lck_mtx_pri	lck_mtx_sw.lck_mtxd.lck_mtxd_pri
#define	lck_mtx_promoted lck_mtx_sw.lck_mtxd.lck_mtxd_promoted
#define lck_mtx_is_ext  lck_mtx_sw.lck_mtxd.lck_mtxd_is_ext

#define lck_mtx_tag	lck_mtx_sw.lck_mtxi.lck_mtxi_tag
#define lck_mtx_ptr	lck_mtx_sw.lck_mtxi.lck_mtxi_ptr
#define lck_mtx_state	lck_mtx_sw.lck_mtxd.lck_mtxd_state
/* This pattern must subsume the interlocked, mlocked and spin bits */
#define	LCK_MTX_TAG_INDIRECT			0x07ff1007	/* lock marked as Indirect  */
#define	LCK_MTX_TAG_DESTROYED			0x07fe2007	/* lock marked as Destroyed */

/* Adaptive spin before blocking */
extern unsigned int	MutexSpin;
extern int		lck_mtx_lock_spinwait_x86(lck_mtx_t *mutex);
extern void		lck_mtx_lock_wait_x86(lck_mtx_t *mutex);
extern void		lck_mtx_lock_acquire_x86(lck_mtx_t *mutex);
extern void		lck_mtx_unlock_wakeup_x86(lck_mtx_t *mutex, int prior_lock_state);

extern void		lck_mtx_lock_mark_destroyed(lck_mtx_t *mutex);
extern int		lck_mtx_lock_grab_mutex(lck_mtx_t *mutex);

extern void		hw_lock_byte_init(volatile uint8_t *lock_byte);
extern void		hw_lock_byte_lock(volatile uint8_t *lock_byte);
extern void		hw_lock_byte_unlock(volatile uint8_t *lock_byte);

typedef struct {
	unsigned int		type;
#ifdef __x86_64__
	unsigned int		pad4;
#endif
	vm_offset_t		pc;
	vm_offset_t		thread;
} lck_mtx_deb_t;

#define MUTEX_TAG       0x4d4d

typedef struct {
	unsigned int		lck_mtx_stat_data;
} lck_mtx_stat_t;

typedef struct _lck_mtx_ext_ {
	lck_mtx_t		lck_mtx;
	struct _lck_grp_	*lck_mtx_grp;
	unsigned int		lck_mtx_attr;
#ifdef __x86_64__
	unsigned int		lck_mtx_pad1;
#endif
	lck_mtx_deb_t		lck_mtx_deb;
	uint64_t		lck_mtx_stat;
#ifdef __x86_64__
	unsigned int		lck_mtx_pad2[2];
#endif
} lck_mtx_ext_t;

#define	LCK_MTX_ATTR_DEBUG	0x1
#define	LCK_MTX_ATTR_DEBUGb	0
#define	LCK_MTX_ATTR_STAT	0x2
#define	LCK_MTX_ATTR_STATb	1

#else /* MACH_KERNEL_PRIVATE */
#ifdef	XNU_KERNEL_PRIVATE
typedef struct {
	unsigned long		opaque[2];
} lck_mtx_t;

typedef struct {
	unsigned long		opaque[10];
} lck_mtx_ext_t;
#else
#ifdef	KERNEL_PRIVATE
typedef struct {
	unsigned long		opaque[2];
} lck_mtx_t;

typedef struct {
	unsigned long		opaque[10];
} lck_mtx_ext_t;

#else
typedef struct __lck_mtx_t__		lck_mtx_t;
typedef struct __lck_mtx_ext_t__	lck_mtx_ext_t;
#endif
#endif
#endif

#ifdef	MACH_KERNEL_PRIVATE
#pragma pack(1)		/* Make sure the structure stays as we defined it */
typedef struct _lck_rw_t_internal_ {
	volatile uint16_t	lck_rw_shared_count;	/* No. of accepted readers */
	volatile uint8_t	lck_rw_interlock; 	/* Interlock byte */
	volatile uint8_t
				lck_rw_priv_excl:1,	/* Writers prioritized if set */
				lck_rw_want_upgrade:1,	/* Read-to-write upgrade waiting */
				lck_rw_want_write:1,	/* Writer waiting or locked for write */
				lck_r_waiting:1,	/* Reader is sleeping on lock */
				lck_w_waiting:1,	/* Writer is sleeping on lock */
				lck_rw_can_sleep:1,	/* Can attempts to lock go to sleep? */
				lck_rw_padb6:2; 		/* padding */

	uint32_t		lck_rw_tag; /* This can be obsoleted when stats
					     * are in
					     */
	uint32_t		lck_rw_pad8;
#ifdef __x86_64__
	uint32_t		lck_rw_pad12;
#endif
} lck_rw_t;
#pragma pack()

#define	LCK_RW_ATTR_DEBUG	0x1
#define	LCK_RW_ATTR_DEBUGb	0
#define	LCK_RW_ATTR_STAT	0x2
#define	LCK_RW_ATTR_STATb	1
#define LCK_RW_ATTR_READ_PRI	0x3
#define LCK_RW_ATTR_READ_PRIb	2
#define	LCK_RW_ATTR_DIS_THREAD	0x40000000
#define	LCK_RW_ATTR_DIS_THREADb	30
#define	LCK_RW_ATTR_DIS_MYLOCK	0x10000000
#define	LCK_RW_ATTR_DIS_MYLOCKb	28

#define	LCK_RW_TAG_DESTROYED		0x00002007	/* lock marked as Destroyed */

#else
#ifdef	KERNEL_PRIVATE
#pragma pack(1)
typedef struct {
	uint32_t		opaque[3];
#ifdef	__x86_64__
	uint32_t		opaque4;
#endif
} lck_rw_t;
#pragma pack()
#else
typedef struct __lck_rw_t__	lck_rw_t;
#endif
#endif

#endif	/* _I386_LOCKS_H_ */
Commit	Line	Data
91447636	1	/*
2d21ac55	2	* Copyright (c) 2004-2007 Apple Inc. All rights reserved.
91447636	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	5	*
2d21ac55 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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636 A	27	*/
	28
	29	#ifndef _I386_LOCKS_H_
	30	#define _I386_LOCKS_H_
	31
	32	#include <sys/appleapiopts.h>
	33	#include <kern/kern_types.h>
	34
	35	#ifdef MACH_KERNEL_PRIVATE
	36
	37	#include <i386/hw_lock_types.h>
	38
	39	extern unsigned int LcksOpts;
	40
	41	#define enaLkDeb 0x00000001 /* Request debug in default attribute */
	42	#define enaLkStat 0x00000002 /* Request statistic in default attribute */
	43
6d2010ae	44	#endif /* MACH_KERNEL_PRIVATE */
91447636	45
6d2010ae	46	#if defined(MACH_KERNEL_PRIVATE)
91447636	47	typedef struct {
6d2010ae A	48	volatile uintptr_t interlock;
	49	#if MACH_LDEBUG
	50	unsigned long lck_spin_pad[9]; /* XXX - usimple_lock_data_t */
	51	#endif
91447636 A	52	} lck_spin_t;
	53
	54	#define LCK_SPIN_TAG_DESTROYED 0x00002007 /* lock marked as Destroyed */
	55
6d2010ae	56	#else /* MACH_KERNEL_PRIVATE */
91447636 A	57	#ifdef KERNEL_PRIVATE
91447636 A	58	typedef struct {
b0d623f7	59	unsigned long opaque[10];
91447636	60	} lck_spin_t;
6d2010ae	61	#else /* KERNEL_PRIVATE */
91447636 A	62	typedef struct __lck_spin_t__ lck_spin_t;
	63	#endif
	64	#endif
	65
	66	#ifdef MACH_KERNEL_PRIVATE
6d2010ae A	67	/* The definition of this structure, including the layout of the
	68	* state bitfield, is tailored to the asm implementation in i386_lock.s
	69	*/
91447636 A	70	typedef struct _lck_mtx_ {
	71	union {
	72	struct {
b0d623f7	73	volatile uintptr_t lck_mtxd_owner;
6d2010ae A	74	union {
	75	struct {
	76	volatile uint32_t
	77	lck_mtxd_waiters:16,
	78	lck_mtxd_pri:8,
	79	lck_mtxd_ilocked:1,
	80	lck_mtxd_mlocked:1,
	81	lck_mtxd_promoted:1,
	82	lck_mtxd_spin:1,
	83	lck_mtxd_is_ext:1,
	84	lck_mtxd_pad3:3;
	85	};
	86	uint32_t lck_mtxd_state;
	87	};
	88	#if defined(__x86_64__)
	89	/* Pad field used as a canary, initialized to ~0 */
	90	uint32_t lck_mtxd_pad32;
	91	#endif
91447636 A	92	} lck_mtxd;
91447636 A	93	struct {
2d21ac55	94	struct _lck_mtx_ext_ *lck_mtxi_ptr;
6d2010ae A	95	uint32_t lck_mtxi_tag;
	96	#if defined(__x86_64__)
	97	uint32_t lck_mtxi_pad32;
	98	#endif
91447636 A	99	} lck_mtxi;
	100	} lck_mtx_sw;
	101	} lck_mtx_t;
	102
b0d623f7	103	#define lck_mtx_owner lck_mtx_sw.lck_mtxd.lck_mtxd_owner
91447636 A	104	#define lck_mtx_waiters lck_mtx_sw.lck_mtxd.lck_mtxd_waiters
91447636 A	105	#define lck_mtx_pri lck_mtx_sw.lck_mtxd.lck_mtxd_pri
b0d623f7	106	#define lck_mtx_promoted lck_mtx_sw.lck_mtxd.lck_mtxd_promoted
6d2010ae	107	#define lck_mtx_is_ext lck_mtx_sw.lck_mtxd.lck_mtxd_is_ext
91447636 A	108
	109	#define lck_mtx_tag lck_mtx_sw.lck_mtxi.lck_mtxi_tag
	110	#define lck_mtx_ptr lck_mtx_sw.lck_mtxi.lck_mtxi_ptr
6d2010ae A	111	#define lck_mtx_state lck_mtx_sw.lck_mtxd.lck_mtxd_state
	112	/* This pattern must subsume the interlocked, mlocked and spin bits */
	113	#define LCK_MTX_TAG_INDIRECT 0x07ff1007 /* lock marked as Indirect */
	114	#define LCK_MTX_TAG_DESTROYED 0x07fe2007 /* lock marked as Destroyed */
91447636	115
0c530ab8 A	116	/* Adaptive spin before blocking */
0c530ab8 A	117	extern unsigned int MutexSpin;
b0d623f7 A	118	extern int lck_mtx_lock_spinwait_x86(lck_mtx_t *mutex);
	119	extern void lck_mtx_lock_wait_x86(lck_mtx_t *mutex);
	120	extern void lck_mtx_lock_acquire_x86(lck_mtx_t *mutex);
6d2010ae	121	extern void lck_mtx_unlock_wakeup_x86(lck_mtx_t *mutex, int prior_lock_state);
2d21ac55	122
b0d623f7	123	extern void lck_mtx_lock_mark_destroyed(lck_mtx_t *mutex);
b0d623f7	124	extern int lck_mtx_lock_grab_mutex(lck_mtx_t *mutex);
0c530ab8	125
316670eb A	126	extern void hw_lock_byte_init(volatile uint8_t *lock_byte);
	127	extern void hw_lock_byte_lock(volatile uint8_t *lock_byte);
	128	extern void hw_lock_byte_unlock(volatile uint8_t *lock_byte);
0c530ab8	129
91447636 A	130	typedef struct {
91447636 A	131	unsigned int type;
b0d623f7 A	132	#ifdef __x86_64__
	133	unsigned int pad4;
	134	#endif
91447636 A	135	vm_offset_t pc;
	136	vm_offset_t thread;
	137	} lck_mtx_deb_t;
	138
	139	#define MUTEX_TAG 0x4d4d
	140
	141	typedef struct {
	142	unsigned int lck_mtx_stat_data;
	143	} lck_mtx_stat_t;
	144
	145	typedef struct _lck_mtx_ext_ {
	146	lck_mtx_t lck_mtx;
	147	struct _lck_grp_ *lck_mtx_grp;
	148	unsigned int lck_mtx_attr;
b0d623f7 A	149	#ifdef __x86_64__
	150	unsigned int lck_mtx_pad1;
	151	#endif
91447636	152	lck_mtx_deb_t lck_mtx_deb;
2d21ac55	153	uint64_t lck_mtx_stat;
b0d623f7 A	154	#ifdef __x86_64__
	155	unsigned int lck_mtx_pad2[2];
	156	#endif
91447636 A	157	} lck_mtx_ext_t;
	158
	159	#define LCK_MTX_ATTR_DEBUG 0x1
0c530ab8	160	#define LCK_MTX_ATTR_DEBUGb 0
91447636	161	#define LCK_MTX_ATTR_STAT 0x2
0c530ab8	162	#define LCK_MTX_ATTR_STATb 1
91447636	163
6d2010ae A	164	#else /* MACH_KERNEL_PRIVATE */
	165	#ifdef XNU_KERNEL_PRIVATE
	166	typedef struct {
	167	unsigned long opaque[2];
	168	} lck_mtx_t;
	169
	170	typedef struct {
	171	unsigned long opaque[10];
	172	} lck_mtx_ext_t;
91447636 A	173	#else
	174	#ifdef KERNEL_PRIVATE
	175	typedef struct {
6d2010ae	176	unsigned long opaque[2];
91447636	177	} lck_mtx_t;
b0d623f7 A	178
	179	typedef struct {
	180	unsigned long opaque[10];
	181	} lck_mtx_ext_t;
	182
91447636	183	#else
b0d623f7 A	184	typedef struct __lck_mtx_t__ lck_mtx_t;
b0d623f7 A	185	typedef struct __lck_mtx_ext_t__ lck_mtx_ext_t;
91447636 A	186	#endif
91447636 A	187	#endif
6d2010ae	188	#endif
91447636 A	189
91447636 A	190	#ifdef MACH_KERNEL_PRIVATE
2d21ac55	191	#pragma pack(1) /* Make sure the structure stays as we defined it */
b0d623f7	192	typedef struct _lck_rw_t_internal_ {
2d21ac55	193	volatile uint16_t lck_rw_shared_count; /* No. of accepted readers */
316670eb	194	volatile uint8_t lck_rw_interlock; /* Interlock byte */
2d21ac55 A	195	volatile uint8_t
	196	lck_rw_priv_excl:1, /* Writers prioritized if set */
	197	lck_rw_want_upgrade:1, /* Read-to-write upgrade waiting */
	198	lck_rw_want_write:1, /* Writer waiting or locked for write */
	199	lck_r_waiting:1, /* Reader is sleeping on lock */
	200	lck_w_waiting:1, /* Writer is sleeping on lock */
	201	lck_rw_can_sleep:1, /* Can attempts to lock go to sleep? */
b0d623f7	202	lck_rw_padb6:2; /* padding */
2d21ac55	203
b0d623f7	204	uint32_t lck_rw_tag; /* This can be obsoleted when stats
2d21ac55 A	205	* are in
2d21ac55 A	206	*/
b0d623f7 A	207	uint32_t lck_rw_pad8;
	208	#ifdef __x86_64__
	209	uint32_t lck_rw_pad12;
	210	#endif
91447636	211	} lck_rw_t;
2d21ac55	212	#pragma pack()
91447636	213
0c530ab8 A	214	#define LCK_RW_ATTR_DEBUG 0x1
	215	#define LCK_RW_ATTR_DEBUGb 0
	216	#define LCK_RW_ATTR_STAT 0x2
	217	#define LCK_RW_ATTR_STATb 1
	218	#define LCK_RW_ATTR_READ_PRI 0x3
	219	#define LCK_RW_ATTR_READ_PRIb 2
	220	#define LCK_RW_ATTR_DIS_THREAD 0x40000000
	221	#define LCK_RW_ATTR_DIS_THREADb 30
	222	#define LCK_RW_ATTR_DIS_MYLOCK 0x10000000
	223	#define LCK_RW_ATTR_DIS_MYLOCKb 28
	224
91447636 A	225	#define LCK_RW_TAG_DESTROYED 0x00002007 /* lock marked as Destroyed */
	226
	227	#else
	228	#ifdef KERNEL_PRIVATE
b0d623f7	229	#pragma pack(1)
91447636	230	typedef struct {
b0d623f7 A	231	uint32_t opaque[3];
	232	#ifdef __x86_64__
	233	uint32_t opaque4;
	234	#endif
91447636	235	} lck_rw_t;
b0d623f7	236	#pragma pack()
91447636 A	237	#else
	238	typedef struct __lck_rw_t__ lck_rw_t;
	239	#endif
	240	#endif
	241
	242	#endif /* _I386_LOCKS_H_ */