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 /* _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
87 /* Flags for UMTX_OP_CV_WAIT */
88 #define CVWAIT_CHECK_UNPARKING 0x01
89 #define CVWAIT_ABSTIME 0x02
90 #define CVWAIT_CLOCKID 0x04
91
92 #define UMTX_ABSTIME 0x01
93
94 #define UMTX_CHECK_UNPARKING CVWAIT_CHECK_UNPARKING
95
96 #ifndef _KERNEL
97
98 int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2);
99
100 #else
101
102 /*
103 * The umtx_key structure is used by both the Linux futex code and the
104 * umtx implementation to map userland addresses to unique keys.
105 */
106
107 enum {
108 TYPE_SIMPLE_WAIT,
109 TYPE_CV,
110 TYPE_SEM,
111 TYPE_SIMPLE_LOCK,
112 TYPE_NORMAL_UMUTEX,
113 TYPE_PI_UMUTEX,
114 TYPE_PP_UMUTEX,
115 TYPE_RWLOCK,
116 TYPE_FUTEX
117 };
118
119 /* Key to represent a unique userland synchronous object */
120 struct umtx_key {
121 int hash;
122 int type;
123 int shared;
124 union {
125 struct {
126 struct vm_object *object;
127 uintptr_t offset;
128 } shared;
129 struct {
130 struct vmspace *vs;
131 uintptr_t addr;
132 } private;
133 struct {
134 void *a;
135 uintptr_t b;
136 } both;
137 } info;
138 };
139
140 #define THREAD_SHARE 0
141 #define PROCESS_SHARE 1
142 #define AUTO_SHARE 2
143
144 struct thread;
145
146 static inline int
umtx_key_match(const struct umtx_key * k1,const struct umtx_key * k2)147 umtx_key_match(const struct umtx_key *k1, const struct umtx_key *k2)
148 {
149 return (k1->type == k2->type &&
150 k1->info.both.a == k2->info.both.a &&
151 k1->info.both.b == k2->info.both.b);
152 }
153
154 int umtx_copyin_timeout(const void *, struct timespec *);
155 int umtx_key_get(const void *, int, int, struct umtx_key *);
156 void umtx_key_release(struct umtx_key *);
157 struct umtx_q *umtxq_alloc(void);
158 void umtxq_free(struct umtx_q *);
159 int kern_umtx_wake(struct thread *, void *, int, int);
160 void umtx_pi_adjust(struct thread *, u_char);
161 void umtx_thread_init(struct thread *);
162 void umtx_thread_fini(struct thread *);
163 void umtx_thread_alloc(struct thread *);
164 void umtx_thread_exit(struct thread *);
165 #endif /* !_KERNEL */
166 #endif /* !_SYS_UMTX_H_ */
167