umtx.h revision 302408
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: stable/11/sys/sys/umtx.h 300043 2016-05-17 09:56:22Z kib $ 27 * 28 */ 29 30#ifndef _SYS_UMTX_H_ 31#define _SYS_UMTX_H_ 32 33#include <sys/_umtx.h> 34 35/* Common lock flags */ 36#define USYNC_PROCESS_SHARED 0x0001 /* Process shared sync objs */ 37 38/* umutex flags */ 39#define UMUTEX_PRIO_INHERIT 0x0004 /* Priority inherited mutex */ 40#define UMUTEX_PRIO_PROTECT 0x0008 /* Priority protect mutex */ 41#define UMUTEX_ROBUST 0x0010 /* Robust mutex */ 42#define UMUTEX_NONCONSISTENT 0x0020 /* Robust locked but not consistent */ 43 44/* 45 * The umutex.m_lock values and bits. The m_owner is the word which 46 * serves as the lock. Its high bit is the contention indicator and 47 * rest of bits records the owner TID. TIDs values start with PID_MAX 48 * + 2 and end by INT32_MAX. The low range [1..PID_MAX] is guaranteed 49 * to be useable as the special markers. 50 */ 51#define UMUTEX_UNOWNED 0x0 52#define UMUTEX_CONTESTED 0x80000000U 53#define UMUTEX_RB_OWNERDEAD (UMUTEX_CONTESTED | 0x10) 54#define UMUTEX_RB_NOTRECOV (UMUTEX_CONTESTED | 0x11) 55 56/* urwlock flags */ 57#define URWLOCK_PREFER_READER 0x0002 58 59#define URWLOCK_WRITE_OWNER 0x80000000U 60#define URWLOCK_WRITE_WAITERS 0x40000000U 61#define URWLOCK_READ_WAITERS 0x20000000U 62#define URWLOCK_MAX_READERS 0x1fffffffU 63#define URWLOCK_READER_COUNT(c) ((c) & URWLOCK_MAX_READERS) 64 65/* _usem flags */ 66#define SEM_NAMED 0x0002 67 68/* _usem2 count field */ 69#define USEM_HAS_WAITERS 0x80000000U 70#define USEM_MAX_COUNT 0x7fffffffU 71#define USEM_COUNT(c) ((c) & USEM_MAX_COUNT) 72 73/* op code for _umtx_op */ 74#define UMTX_OP_RESERVED0 0 75#define UMTX_OP_RESERVED1 1 76#define UMTX_OP_WAIT 2 77#define UMTX_OP_WAKE 3 78#define UMTX_OP_MUTEX_TRYLOCK 4 79#define UMTX_OP_MUTEX_LOCK 5 80#define UMTX_OP_MUTEX_UNLOCK 6 81#define UMTX_OP_SET_CEILING 7 82#define UMTX_OP_CV_WAIT 8 83#define UMTX_OP_CV_SIGNAL 9 84#define UMTX_OP_CV_BROADCAST 10 85#define UMTX_OP_WAIT_UINT 11 86#define UMTX_OP_RW_RDLOCK 12 87#define UMTX_OP_RW_WRLOCK 13 88#define UMTX_OP_RW_UNLOCK 14 89#define UMTX_OP_WAIT_UINT_PRIVATE 15 90#define UMTX_OP_WAKE_PRIVATE 16 91#define UMTX_OP_MUTEX_WAIT 17 92#define UMTX_OP_MUTEX_WAKE 18 /* deprecated */ 93#define UMTX_OP_SEM_WAIT 19 /* deprecated */ 94#define UMTX_OP_SEM_WAKE 20 /* deprecated */ 95#define UMTX_OP_NWAKE_PRIVATE 21 96#define UMTX_OP_MUTEX_WAKE2 22 97#define UMTX_OP_SEM2_WAIT 23 98#define UMTX_OP_SEM2_WAKE 24 99#define UMTX_OP_SHM 25 100#define UMTX_OP_ROBUST_LISTS 26 101 102/* Flags for UMTX_OP_CV_WAIT */ 103#define CVWAIT_CHECK_UNPARKING 0x01 104#define CVWAIT_ABSTIME 0x02 105#define CVWAIT_CLOCKID 0x04 106 107#define UMTX_ABSTIME 0x01 108 109#define UMTX_CHECK_UNPARKING CVWAIT_CHECK_UNPARKING 110 111/* Flags for UMTX_OP_SHM */ 112#define UMTX_SHM_CREAT 0x0001 113#define UMTX_SHM_LOOKUP 0x0002 114#define UMTX_SHM_DESTROY 0x0004 115#define UMTX_SHM_ALIVE 0x0008 116 117struct umtx_robust_lists_params { 118 uintptr_t robust_list_offset; 119 uintptr_t robust_priv_list_offset; 120 uintptr_t robust_inact_offset; 121}; 122 123#ifndef _KERNEL 124 125int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2); 126 127#else 128 129/* 130 * The umtx_key structure is used by both the Linux futex code and the 131 * umtx implementation to map userland addresses to unique keys. 132 */ 133 134enum { 135 TYPE_SIMPLE_WAIT, 136 TYPE_CV, 137 TYPE_SEM, 138 TYPE_SIMPLE_LOCK, 139 TYPE_NORMAL_UMUTEX, 140 TYPE_PI_UMUTEX, 141 TYPE_PP_UMUTEX, 142 TYPE_RWLOCK, 143 TYPE_FUTEX, 144 TYPE_SHM, 145 TYPE_PI_ROBUST_UMUTEX, 146 TYPE_PP_ROBUST_UMUTEX, 147}; 148 149/* Key to represent a unique userland synchronous object */ 150struct umtx_key { 151 int hash; 152 int type; 153 int shared; 154 union { 155 struct { 156 struct vm_object *object; 157 uintptr_t offset; 158 } shared; 159 struct { 160 struct vmspace *vs; 161 uintptr_t addr; 162 } private; 163 struct { 164 void *a; 165 uintptr_t b; 166 } both; 167 } info; 168}; 169 170#define THREAD_SHARE 0 171#define PROCESS_SHARE 1 172#define AUTO_SHARE 2 173 174struct thread; 175 176static inline int 177umtx_key_match(const struct umtx_key *k1, const struct umtx_key *k2) 178{ 179 return (k1->type == k2->type && 180 k1->info.both.a == k2->info.both.a && 181 k1->info.both.b == k2->info.both.b); 182} 183 184int umtx_copyin_timeout(const void *, struct timespec *); 185int umtx_key_get(const void *, int, int, struct umtx_key *); 186void umtx_key_release(struct umtx_key *); 187struct umtx_q *umtxq_alloc(void); 188void umtxq_free(struct umtx_q *); 189int kern_umtx_wake(struct thread *, void *, int, int); 190void umtx_pi_adjust(struct thread *, u_char); 191void umtx_thread_init(struct thread *); 192void umtx_thread_fini(struct thread *); 193void umtx_thread_alloc(struct thread *); 194void umtx_thread_exit(struct thread *); 195#endif /* !_KERNEL */ 196#endif /* !_SYS_UMTX_H_ */ 197