osfmk/arm/simple_lock.h

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