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

/*
 * Copyright (c) 2000 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/simple_lock_types.h
 *	Author:	Avadis Tevanian, Jr., Michael Wayne Young
 *	Date:	1985
 *
 *	Simple lock data type definitions
 */
#ifdef	KERNEL_PRIVATE

#ifndef	_I386_SIMPLE_LOCK_TYPES_H_
#define	_I386_SIMPLE_LOCK_TYPES_H_

#include <mach/boolean.h>
#include <kern/kern_types.h>

#include <sys/appleapiopts.h>
#if defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE)
#include <i386/hw_lock_types.h>
#include <mach_ldebug.h>

#if	MACH_LDEBUG
#define	USLOCK_DEBUG 1
#else
#define	USLOCK_DEBUG 0
#endif	/* USLOCK_DEBUG */

typedef struct uslock_debug {
	void			*lock_pc;	/* pc where lock operation began    */
	void			*lock_thread;	/* thread that acquired lock */
	void			*unlock_thread;	/* last thread to release lock */
	void			*unlock_pc;	/* pc where lock operation ended    */
	unsigned long	duration[2];
	unsigned short	state;
	unsigned char	lock_cpu;
	unsigned char	unlock_cpu;
} uslock_debug;

typedef struct slock {
	hw_lock_data_t	interlock;	/* must be first... see lock.c */
#if	USLOCK_DEBUG
	unsigned short	lock_type;	/* must be second... see lock.c */
#define USLOCK_TAG	0x5353
	uslock_debug	debug;
#endif
} usimple_lock_data_t, *usimple_lock_t;

extern void			i386_lock_unlock_with_flush(
					hw_lock_t);
#else

typedef	struct slock {
	unsigned long	lock_data[10];
} usimple_lock_data_t, *usimple_lock_t;

#endif	/* defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE) */

#define	USIMPLE_LOCK_NULL	((usimple_lock_t) 0)

#if !defined(decl_simple_lock_data)
typedef usimple_lock_data_t	*simple_lock_t;
typedef usimple_lock_data_t	simple_lock_data_t;

#define	decl_simple_lock_data(class,name) \
	class	simple_lock_data_t	name;

#endif	/* !defined(decl_simple_lock_data) */

#endif /* !_I386_SIMPLE_LOCK_TYPES_H_ */

#endif	/* KERNEL_PRIVATE */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
8f6c56a5	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@
1c79356b A	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	/*
91447636 A	57	* File: kern/simple_lock_types.h
	58	* Author: Avadis Tevanian, Jr., Michael Wayne Young
	59	* Date: 1985
	60	*
	61	* Simple lock data type definitions
1c79356b	62	*/
91447636	63	#ifdef KERNEL_PRIVATE
1c79356b	64
91447636 A	65	#ifndef _I386_SIMPLE_LOCK_TYPES_H_
91447636 A	66	#define _I386_SIMPLE_LOCK_TYPES_H_
1c79356b A	67
1c79356b A	68	#include <mach/boolean.h>
1c79356b A	69	#include <kern/kern_types.h>
1c79356b A	70
9bccf70c	71	#include <sys/appleapiopts.h>
91447636 A	72	#if defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE)
	73	#include <i386/hw_lock_types.h>
	74	#include <mach_ldebug.h>
91447636 A	75
	76	#if MACH_LDEBUG
	77	#define USLOCK_DEBUG 1
	78	#else
	79	#define USLOCK_DEBUG 0
	80	#endif /* USLOCK_DEBUG */
	81
	82	typedef struct uslock_debug {
	83	void lock_pc; / pc where lock operation began */
	84	void lock_thread; / thread that acquired lock */
6d2010ae A	85	void unlock_thread; / last thread to release lock */
6d2010ae A	86	void unlock_pc; / pc where lock operation ended */
91447636 A	87	unsigned long duration[2];
	88	unsigned short state;
	89	unsigned char lock_cpu;
91447636	90	unsigned char unlock_cpu;
91447636	91	} uslock_debug;
9bccf70c	92
91447636 A	93	typedef struct slock {
91447636 A	94	hw_lock_data_t interlock; /* must be first... see lock.c */
6d2010ae	95	#if USLOCK_DEBUG
91447636 A	96	unsigned short lock_type; /* must be second... see lock.c */
	97	#define USLOCK_TAG 0x5353
	98	uslock_debug debug;
6d2010ae	99	#endif
91447636	100	} usimple_lock_data_t, *usimple_lock_t;
9bccf70c	101
0c530ab8 A	102	extern void i386_lock_unlock_with_flush(
0c530ab8 A	103	hw_lock_t);
91447636	104	#else
1c79356b	105
91447636	106	typedef struct slock {
b0d623f7	107	unsigned long lock_data[10];
91447636	108	} usimple_lock_data_t, *usimple_lock_t;
1c79356b	109
91447636	110	#endif /* defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE) */
1c79356b	111
91447636	112	#define USIMPLE_LOCK_NULL ((usimple_lock_t) 0)
0b4e3aa0	113
91447636 A	114	#if !defined(decl_simple_lock_data)
	115	typedef usimple_lock_data_t *simple_lock_t;
	116	typedef usimple_lock_data_t simple_lock_data_t;
1c79356b	117
91447636 A	118	#define decl_simple_lock_data(class,name) \
91447636 A	119	class simple_lock_data_t name;
1c79356b	120
91447636	121	#endif /* !defined(decl_simple_lock_data) */
0b4e3aa0	122
91447636	123	#endif /* !_I386_SIMPLE_LOCK_TYPES_H_ */
9bccf70c	124
91447636	125	#endif /* KERNEL_PRIVATE */