umtx.h revision 273604
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: head/sys/sys/umtx.h 273604 2014-10-24 20:02:44Z jhb $ 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/* _usem2 count field */ 56#define USEM_HAS_WAITERS 0x80000000U 57#define USEM_MAX_COUNT 0x7fffffffU 58#define USEM_COUNT(c) ((c) & USEM_MAX_COUNT) 59 60/* op code for _umtx_op */ 61#define UMTX_OP_RESERVED0 0 62#define UMTX_OP_RESERVED1 1 63#define UMTX_OP_WAIT 2 64#define UMTX_OP_WAKE 3 65#define UMTX_OP_MUTEX_TRYLOCK 4 66#define UMTX_OP_MUTEX_LOCK 5 67#define UMTX_OP_MUTEX_UNLOCK 6 68#define UMTX_OP_SET_CEILING 7 69#define UMTX_OP_CV_WAIT 8 70#define UMTX_OP_CV_SIGNAL 9 71#define UMTX_OP_CV_BROADCAST 10 72#define UMTX_OP_WAIT_UINT 11 73#define UMTX_OP_RW_RDLOCK 12 74#define UMTX_OP_RW_WRLOCK 13 75#define UMTX_OP_RW_UNLOCK 14 76#define UMTX_OP_WAIT_UINT_PRIVATE 15 77#define UMTX_OP_WAKE_PRIVATE 16 78#define UMTX_OP_MUTEX_WAIT 17 79#define UMTX_OP_MUTEX_WAKE 18 /* deprecated */ 80#define UMTX_OP_SEM_WAIT 19 /* deprecated */ 81#define UMTX_OP_SEM_WAKE 20 /* deprecated */ 82#define UMTX_OP_NWAKE_PRIVATE 21 83#define UMTX_OP_MUTEX_WAKE2 22 84#define UMTX_OP_SEM2_WAIT 23 85#define UMTX_OP_SEM2_WAKE 24 86#define UMTX_OP_MAX 25 87 88/* Flags for UMTX_OP_CV_WAIT */ 89#define CVWAIT_CHECK_UNPARKING 0x01 90#define CVWAIT_ABSTIME 0x02 91#define CVWAIT_CLOCKID 0x04 92 93#define UMTX_ABSTIME 0x01 94 95#define UMTX_CHECK_UNPARKING CVWAIT_CHECK_UNPARKING 96 97#ifndef _KERNEL 98 99int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2); 100 101#else 102 103/* 104 * The umtx_key structure is used by both the Linux futex code and the 105 * umtx implementation to map userland addresses to unique keys. 106 */ 107 108enum { 109 TYPE_SIMPLE_WAIT, 110 TYPE_CV, 111 TYPE_SEM, 112 TYPE_SIMPLE_LOCK, 113 TYPE_NORMAL_UMUTEX, 114 TYPE_PI_UMUTEX, 115 TYPE_PP_UMUTEX, 116 TYPE_RWLOCK, 117 TYPE_FUTEX 118}; 119 120/* Key to represent a unique userland synchronous object */ 121struct umtx_key { 122 int hash; 123 int type; 124 int shared; 125 union { 126 struct { 127 struct vm_object *object; 128 uintptr_t offset; 129 } shared; 130 struct { 131 struct vmspace *vs; 132 uintptr_t addr; 133 } private; 134 struct { 135 void *a; 136 uintptr_t b; 137 } both; 138 } info; 139}; 140 141#define THREAD_SHARE 0 142#define PROCESS_SHARE 1 143#define AUTO_SHARE 2 144 145struct thread; 146 147static inline int 148umtx_key_match(const struct umtx_key *k1, const struct umtx_key *k2) 149{ 150 return (k1->type == k2->type && 151 k1->info.both.a == k2->info.both.a && 152 k1->info.both.b == k2->info.both.b); 153} 154 155int umtx_copyin_timeout(const void *, struct timespec *); 156int umtx_key_get(void *, int, int, struct umtx_key *); 157void umtx_key_release(struct umtx_key *); 158struct umtx_q *umtxq_alloc(void); 159void umtxq_free(struct umtx_q *); 160int kern_umtx_wake(struct thread *, void *, int, int); 161void umtx_pi_adjust(struct thread *, u_char); 162void umtx_thread_init(struct thread *); 163void umtx_thread_fini(struct thread *); 164void umtx_thread_alloc(struct thread *); 165void umtx_thread_exit(struct thread *); 166#endif /* !_KERNEL */ 167#endif /* !_SYS_UMTX_H_ */ 168