1 /*- 2 * Copyright (c) 2002, Jeffrey Roberson <jeff@freebsd.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice unmodified, this list of conditions, and the following 10 * disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 * 28 */ 29 30 #ifndef _SYS_UMTX_H_ 31 #define _SYS_UMTX_H_ 32 33 #include <sys/_umtx.h> 34 35 #define USYNC_PROCESS_SHARED 0x0001 /* Process shared sync objs */ 36 37 #define UMUTEX_UNOWNED 0x0 38 #define UMUTEX_CONTESTED 0x80000000U 39 40 #define UMUTEX_PRIO_INHERIT 0x0004 /* Priority inherited mutex */ 41 #define UMUTEX_PRIO_PROTECT 0x0008 /* Priority protect mutex */ 42 43 /* urwlock flags */ 44 #define URWLOCK_PREFER_READER 0x0002 45 46 #define URWLOCK_WRITE_OWNER 0x80000000U 47 #define URWLOCK_WRITE_WAITERS 0x40000000U 48 #define URWLOCK_READ_WAITERS 0x20000000U 49 #define URWLOCK_MAX_READERS 0x1fffffffU 50 #define URWLOCK_READER_COUNT(c) ((c) & URWLOCK_MAX_READERS) 51 52 /* _usem flags */ 53 #define SEM_NAMED 0x0002 54 55 /* op code for _umtx_op */ 56 #define UMTX_OP_RESERVED0 0 57 #define UMTX_OP_RESERVED1 1 58 #define UMTX_OP_WAIT 2 59 #define UMTX_OP_WAKE 3 60 #define UMTX_OP_MUTEX_TRYLOCK 4 61 #define UMTX_OP_MUTEX_LOCK 5 62 #define UMTX_OP_MUTEX_UNLOCK 6 63 #define UMTX_OP_SET_CEILING 7 64 #define UMTX_OP_CV_WAIT 8 65 #define UMTX_OP_CV_SIGNAL 9 66 #define UMTX_OP_CV_BROADCAST 10 67 #define UMTX_OP_WAIT_UINT 11 68 #define UMTX_OP_RW_RDLOCK 12 69 #define UMTX_OP_RW_WRLOCK 13 70 #define UMTX_OP_RW_UNLOCK 14 71 #define UMTX_OP_WAIT_UINT_PRIVATE 15 72 #define UMTX_OP_WAKE_PRIVATE 16 73 #define UMTX_OP_MUTEX_WAIT 17 74 #define UMTX_OP_MUTEX_WAKE 18 /* deprecated */ 75 #define UMTX_OP_SEM_WAIT 19 76 #define UMTX_OP_SEM_WAKE 20 77 #define UMTX_OP_NWAKE_PRIVATE 21 78 #define UMTX_OP_MUTEX_WAKE2 22 79 #define UMTX_OP_MAX 23 80 81 /* Flags for UMTX_OP_CV_WAIT */ 82 #define CVWAIT_CHECK_UNPARKING 0x01 83 #define CVWAIT_ABSTIME 0x02 84 #define CVWAIT_CLOCKID 0x04 85 86 #define UMTX_ABSTIME 0x01 87 88 #define UMTX_CHECK_UNPARKING CVWAIT_CHECK_UNPARKING 89 90 #ifndef _KERNEL 91 92 int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2); 93 94 #else 95 96 /* 97 * The umtx_key structure is used by both the Linux futex code and the 98 * umtx implementation to map userland addresses to unique keys. 99 */ 100 101 enum { 102 TYPE_SIMPLE_WAIT, 103 TYPE_CV, 104 TYPE_SEM, 105 TYPE_SIMPLE_LOCK, 106 TYPE_NORMAL_UMUTEX, 107 TYPE_PI_UMUTEX, 108 TYPE_PP_UMUTEX, 109 TYPE_RWLOCK, 110 TYPE_FUTEX 111 }; 112 113 /* Key to represent a unique userland synchronous object */ 114 struct umtx_key { 115 int hash; 116 int type; 117 int shared; 118 union { 119 struct { 120 struct vm_object *object; 121 uintptr_t offset; 122 } shared; 123 struct { 124 struct vmspace *vs; 125 uintptr_t addr; 126 } private; 127 struct { 128 void *a; 129 uintptr_t b; 130 } both; 131 } info; 132 }; 133 134 #define THREAD_SHARE 0 135 #define PROCESS_SHARE 1 136 #define AUTO_SHARE 2 137 138 struct thread; 139 140 static inline int 141 umtx_key_match(const struct umtx_key *k1, const struct umtx_key *k2) 142 { 143 return (k1->type == k2->type && 144 k1->info.both.a == k2->info.both.a && 145 k1->info.both.b == k2->info.both.b); 146 } 147 148 int umtx_copyin_timeout(const void *, struct timespec *); 149 int umtx_key_get(void *, int, int, struct umtx_key *); 150 void umtx_key_release(struct umtx_key *); 151 struct umtx_q *umtxq_alloc(void); 152 void umtxq_free(struct umtx_q *); 153 int kern_umtx_wake(struct thread *, void *, int, int); 154 void umtx_pi_adjust(struct thread *, u_char); 155 void umtx_thread_init(struct thread *); 156 void umtx_thread_fini(struct thread *); 157 void umtx_thread_alloc(struct thread *); 158 void umtx_thread_exit(struct thread *); 159 #endif /* !_KERNEL */ 160 #endif /* !_SYS_UMTX_H_ */ 161