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 #ifdef KERNEL_PRIVATE 58 59 #ifndef _ARM_SIMPLE_LOCK_TYPES_H_ 60 #define _ARM_SIMPLE_LOCK_TYPES_H_ 61 62 #include <kern/lock_group.h> 63 64 #ifdef KERNEL_PRIVATE 65 #include <mach/boolean.h> 66 #include <kern/lock_types.h> 67 #include <sys/appleapiopts.h> 68 #ifdef MACH_KERNEL_PRIVATE 69 #include <arm/locks.h> 70 #include <mach_ldebug.h> 71 #endif 72 73 #ifdef MACH_KERNEL_PRIVATE 74 75 extern machine_timeout_t LockTimeOut; /* Number of hardware ticks of a lock timeout */ 76 extern machine_timeout_t LockTimeOutUsec; /* Number of microseconds for lock timeout */ 77 78 typedef lck_spin_t usimple_lock_data_t, *usimple_lock_t; 79 #else /* MACH_KERNEL_PRIVATE */ 80 81 #if defined(__arm__) 82 typedef struct slock { 83 unsigned int lock_data[10]; 84 } usimple_lock_data_t, *usimple_lock_t; 85 #elif defined(__arm64__) 86 /* 87 * ARM64_TODO: this is quite a waste of space (and a 88 * poorly packed data structure). See if anyone's 89 * using these outside of osfmk. 90 * NOTE: only osfmk uses this structure in xnu-2624 91 */ 92 typedef struct slock { 93 uint64_t lock_data[9]; 94 } usimple_lock_data_t, *usimple_lock_t; 95 #else 96 #error Unknown architecture. 97 #endif 98 99 #endif /* MACH_KERNEL_PRIVATE */ 100 101 #define USIMPLE_LOCK_NULL ((usimple_lock_t) 0) 102 103 #if !defined(decl_simple_lock_data) 104 105 typedef usimple_lock_data_t *simple_lock_t; 106 typedef usimple_lock_data_t simple_lock_data_t; 107 108 #define decl_simple_lock_data(class, name) \ 109 class simple_lock_data_t name 110 111 #endif /* !defined(decl_simple_lock_data) */ 112 113 #ifdef MACH_KERNEL_PRIVATE 114 115 #define MACHINE_SIMPLE_LOCK 116 117 extern void arm_usimple_lock_init(simple_lock_t, __unused unsigned short); 118 119 #define simple_lock_init(l, t) arm_usimple_lock_init(l,t) 120 121 #if LCK_GRP_USE_ARG 122 #define simple_lock(l, grp) lck_spin_lock_grp(l, grp) 123 #define simple_lock_nopreempt(l, grp) lck_spin_lock_nopreempt_grp(l, grp) 124 #define simple_lock_try(l, grp) lck_spin_try_lock_grp(l, grp) 125 #define simple_lock_try_nopreempt(l, grp) lck_spin_try_lock_nopreempt_grp(l, grp) 126 #else 127 #define simple_lock(l, grp) lck_spin_lock(l) 128 #define simple_lock_nopreempt(l, grp) lck_spin_lock_nopreempt(l) 129 #define simple_lock_try(l, grp) lck_spin_try_lock(l) 130 #define simple_lock_try_nopreempt(l, grp) lck_spin_try_lock_nopreempt(l) 131 #endif /* LCK_GRP_USE_ARG */ 132 133 #define simple_unlock(l) lck_spin_unlock(l) 134 #define simple_unlock_nopreempt(l) lck_spin_unlock_nopreempt(l) 135 136 #define simple_lock_try_lock_loop(l, grp) simple_lock(l, grp) 137 138 #define simple_lock_addr(l) (&(l)) 139 #define simple_lock_assert(l, t) lck_spin_assert(l,t) 140 #define kdp_simple_lock_is_acquired(l) kdp_lck_spin_is_acquired(l) 141 142 #endif /* MACH_KERNEL_PRIVATE */ 143 #endif /* KERNEL_PRIVATE */ 144 145 #endif /* !_ARM_SIMPLE_LOCK_TYPES_H_ */ 146 147 #endif /* KERNEL_PRIVATE */ 148