xref: /xnu-8020.101.4/osfmk/i386/simple_lock.h (revision e7776783b89a353188416a9a346c6cdb4928faad)
1 /*
2  * Copyright (c) 2019 Apple 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  [email protected]
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/simple_lock_types.h
58  *	Author:	Avadis Tevanian, Jr., Michael Wayne Young
59  *	Date:	1985
60  *
61  *	Simple lock data type definitions
62  */
63 #ifdef  KERNEL_PRIVATE
64 
65 #ifndef _I386_SIMPLE_LOCK_TYPES_H_
66 #define _I386_SIMPLE_LOCK_TYPES_H_
67 
68 #include <mach/boolean.h>
69 #include <kern/kern_types.h>
70 
71 #include <sys/appleapiopts.h>
72 #if defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE)
73 #include <i386/hw_lock_types.h>
74 #include <mach_ldebug.h>
75 
76 extern uint64_t LockTimeOutTSC; /* Lock timeout in TSC ticks */
77 extern uint32_t LockTimeOutUsec;/* Lock timeout in microseconds */
78 extern uint64_t LockTimeOut;    /* Lock timeout in absolute time */
79 
80 #if     MACH_LDEBUG
81 #define USLOCK_DEBUG 1
82 #else
83 #define USLOCK_DEBUG 0
84 #endif  /* USLOCK_DEBUG */
85 
86 typedef struct uslock_debug {
87 	void                    *lock_pc;       /* pc where lock operation began    */
88 	void                    *lock_thread;   /* thread that acquired lock */
89 	void                    *unlock_thread; /* last thread to release lock */
90 	void                    *unlock_pc;     /* pc where lock operation ended    */
91 	unsigned long   duration[2];
92 	unsigned short  state;
93 	unsigned char   lock_cpu;
94 	unsigned char   unlock_cpu;
95 } uslock_debug;
96 
97 typedef struct slock {
98 	hw_lock_data_t  interlock;      /* must be first... see lock.c */
99 #if     USLOCK_DEBUG
100 	unsigned short  lock_type;      /* must be second... see lock.c */
101 #define USLOCK_TAG      0x5353
102 	uslock_debug    debug;
103 #endif
104 } usimple_lock_data_t, *usimple_lock_t;
105 
106 extern void                     i386_lock_unlock_with_flush(
107 	hw_lock_t);
108 #else
109 
110 typedef struct slock {
111 	unsigned long   lock_data[10];
112 } usimple_lock_data_t, *usimple_lock_t;
113 
114 #endif  /* defined(MACH_KERNEL_PRIVATE) && defined(__APPLE_API_PRIVATE) */
115 
116 #define USIMPLE_LOCK_NULL       ((usimple_lock_t) 0)
117 
118 #if !defined(decl_simple_lock_data)
119 typedef usimple_lock_data_t     *simple_lock_t;
120 typedef usimple_lock_data_t     simple_lock_data_t;
121 
122 #define decl_simple_lock_data(class, name) \
123 	class	simple_lock_data_t	name
124 
125 #endif  /* !defined(decl_simple_lock_data) */
126 
127 #endif /* !_I386_SIMPLE_LOCK_TYPES_H_ */
128 
129 #endif  /* KERNEL_PRIVATE */
130