bsd/sys/ulock.h

   1 /*
   2  * Copyright (c) 2015 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 #ifndef _SYS_ULOCK_H
  30 #define _SYS_ULOCK_H
  31
  32 #include <mach/mach_port.h>
  33 #include <sys/cdefs.h>
  34 #include <stdint.h>
  35
  36 __BEGIN_DECLS
  37
  38 #if PRIVATE
  39
  40 #ifdef XNU_KERNEL_PRIVATE
  41 extern mach_port_name_t ipc_entry_name_mask(mach_port_name_t name);
  42
  43 static __inline mach_port_name_t
  44 ulock_owner_value_to_port_name(uint32_t uval)
  45 {
  46         /*
  47          * userland uses the least significant bits for flags as these are
  48          * never used in the mach port name, and are generally always set by
  49          * the ipc_entry code in the kernel. Here we reconstruct a mach port
  50          * name that we can use in the kernel.
  51          */
  52         return ipc_entry_name_mask((mach_port_name_t)uval);
  53 }
  54 #else
  55 static __inline mach_port_name_t
  56 ulock_owner_value_to_port_name(uint32_t uval)
  57 {
  58         return uval | 0x3;
  59 }
  60 #endif
  61
  62 #ifndef KERNEL
  63
  64 extern int __ulock_wait(uint32_t operation, void *addr, uint64_t value,
  65     uint32_t timeout);             /* timeout is specified in microseconds */
  66 extern int __ulock_wake(uint32_t operation, void *addr, uint64_t wake_value);
  67
  68 #endif /* !KERNEL */
  69
  70 /*
  71  * operation bits [7, 0] contain the operation code.
  72  *
  73  * NOTE: make sure to add logic for handling any new
  74  *       types to kdp_ulock_find_owner()
  75  */
  76 #define UL_COMPARE_AND_WAIT             1
  77 #define UL_UNFAIR_LOCK                  2
  78 #define UL_COMPARE_AND_WAIT_SHARED      3
  79 #define UL_UNFAIR_LOCK64_SHARED         4
  80 #define UL_COMPARE_AND_WAIT64           5
  81 #define UL_COMPARE_AND_WAIT64_SHARED    6
  82 /* obsolete names */
  83 #define UL_OSSPINLOCK                   UL_COMPARE_AND_WAIT
  84 #define UL_HANDOFFLOCK                  UL_UNFAIR_LOCK
  85 /* These operation code are only implemented in (DEVELOPMENT || DEBUG) kernels */
  86 #define UL_DEBUG_SIMULATE_COPYIN_FAULT  253
  87 #define UL_DEBUG_HASH_DUMP_ALL          254
  88 #define UL_DEBUG_HASH_DUMP_PID          255
  89
  90 /*
  91  * operation bits [15, 8] contain the flags for __ulock_wake
  92  */
  93 #define ULF_WAKE_ALL                    0x00000100
  94 #define ULF_WAKE_THREAD                 0x00000200
  95
  96 /*
  97  * operation bits [23, 16] contain the flags for __ulock_wait
  98  *
  99  * @const ULF_WAIT_WORKQ_DATA_CONTENTION
 100  * The waiter is contending on this lock for synchronization around global data.
 101  * This causes the workqueue subsystem to not create new threads to offset for
 102  * waiters on this lock.
 103  *
 104  * @const ULF_WAIT_CANCEL_POINT
 105  * This wait is a cancelation point
 106  *
 107  * @const ULF_WAIT_ADAPTIVE_SPIN
 108  * Use adaptive spinning when the thread that currently holds the unfair lock
 109  * is on core.
 110  */
 111 #define ULF_WAIT_WORKQ_DATA_CONTENTION  0x00010000
 112 #define ULF_WAIT_CANCEL_POINT           0x00020000
 113 #define ULF_WAIT_ADAPTIVE_SPIN          0x00040000
 114
 115 /*
 116  * operation bits [31, 24] contain the generic flags
 117  */
 118 #define ULF_NO_ERRNO                    0x01000000
 119
 120 /*
 121  * masks
 122  */
 123 #define UL_OPCODE_MASK          0x000000FF
 124 #define UL_FLAGS_MASK           0xFFFFFF00
 125 #define ULF_GENERIC_MASK        0xFFFF0000
 126
 127 #define ULF_WAIT_MASK           (ULF_NO_ERRNO | \
 128                                  ULF_WAIT_WORKQ_DATA_CONTENTION | \
 129                                  ULF_WAIT_CANCEL_POINT | ULF_WAIT_ADAPTIVE_SPIN)
 130
 131 #define ULF_WAKE_MASK           (ULF_NO_ERRNO | \
 132                                  ULF_WAKE_ALL | \
 133                                  ULF_WAKE_THREAD)
 134
 135 #endif /* PRIVATE */
 136
 137 __END_DECLS
 138
 139 #endif