1 /* $NetBSD: linux_futex.c,v 1.7 2006/07/24 19:01:49 manu Exp $ */
4 * Copyright (c) 2009-2016 Dmitry Chagin
5 * Copyright (c) 2005 Emmanuel Dreyfus
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by Emmanuel Dreyfus
19 * 4. The name of the author may not be used to endorse or promote
20 * products derived from this software without specific prior written
23 * THIS SOFTWARE IS PROVIDED BY THE THE AUTHOR AND CONTRIBUTORS ``AS IS''
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
25 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
39 __KERNEL_RCSID(1, "$NetBSD: linux_futex.c,v 1.7 2006/07/24 19:01:49 manu Exp $");
42 #include "opt_compat.h"
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/imgact.h>
47 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/mutex.h>
54 #include <sys/queue.h>
55 #include <sys/sched.h>
59 #include <vm/vm_extern.h>
62 #include <machine/../linux32/linux.h>
63 #include <machine/../linux32/linux32_proto.h>
65 #include <machine/../linux/linux.h>
66 #include <machine/../linux/linux_proto.h>
68 #include <compat/linux/linux_dtrace.h>
69 #include <compat/linux/linux_emul.h>
70 #include <compat/linux/linux_futex.h>
71 #include <compat/linux/linux_timer.h>
72 #include <compat/linux/linux_util.h>
75 LIN_SDT_PROVIDER_DECLARE(LINUX_DTRACE);
78 * Futex part for the special DTrace module "locks".
80 LIN_SDT_PROBE_DEFINE1(locks, futex_mtx, locked, "struct mtx *");
81 LIN_SDT_PROBE_DEFINE1(locks, futex_mtx, unlock, "struct mtx *");
86 LIN_SDT_PROBE_DEFINE1(futex, futex, create, "struct sx *");
87 LIN_SDT_PROBE_DEFINE1(futex, futex, destroy, "struct sx *");
90 * DTrace probes in this module.
92 LIN_SDT_PROBE_DEFINE2(futex, futex_put, entry, "struct futex *",
93 "struct waiting_proc *");
94 LIN_SDT_PROBE_DEFINE3(futex, futex_put, destroy, "uint32_t *", "uint32_t",
96 LIN_SDT_PROBE_DEFINE3(futex, futex_put, unlock, "uint32_t *", "uint32_t",
98 LIN_SDT_PROBE_DEFINE0(futex, futex_put, return);
99 LIN_SDT_PROBE_DEFINE3(futex, futex_get0, entry, "uint32_t *", "struct futex **",
101 LIN_SDT_PROBE_DEFINE1(futex, futex_get0, umtx_key_get_error, "int");
102 LIN_SDT_PROBE_DEFINE3(futex, futex_get0, shared, "uint32_t *", "uint32_t",
104 LIN_SDT_PROBE_DEFINE1(futex, futex_get0, null, "uint32_t *");
105 LIN_SDT_PROBE_DEFINE3(futex, futex_get0, new, "uint32_t *", "uint32_t", "int");
106 LIN_SDT_PROBE_DEFINE1(futex, futex_get0, return, "int");
107 LIN_SDT_PROBE_DEFINE3(futex, futex_get, entry, "uint32_t *",
108 "struct waiting_proc **", "struct futex **");
109 LIN_SDT_PROBE_DEFINE0(futex, futex_get, error);
110 LIN_SDT_PROBE_DEFINE1(futex, futex_get, return, "int");
111 LIN_SDT_PROBE_DEFINE3(futex, futex_sleep, entry, "struct futex *",
112 "struct waiting_proc **", "struct timespec *");
113 LIN_SDT_PROBE_DEFINE5(futex, futex_sleep, requeue_error, "int", "uint32_t *",
114 "struct waiting_proc *", "uint32_t *", "uint32_t");
115 LIN_SDT_PROBE_DEFINE3(futex, futex_sleep, sleep_error, "int", "uint32_t *",
116 "struct waiting_proc *");
117 LIN_SDT_PROBE_DEFINE1(futex, futex_sleep, return, "int");
118 LIN_SDT_PROBE_DEFINE3(futex, futex_wake, entry, "struct futex *", "int",
120 LIN_SDT_PROBE_DEFINE3(futex, futex_wake, iterate, "uint32_t",
121 "struct waiting_proc *", "uint32_t");
122 LIN_SDT_PROBE_DEFINE1(futex, futex_wake, wakeup, "struct waiting_proc *");
123 LIN_SDT_PROBE_DEFINE1(futex, futex_wake, return, "int");
124 LIN_SDT_PROBE_DEFINE4(futex, futex_requeue, entry, "struct futex *", "int",
125 "struct futex *", "int");
126 LIN_SDT_PROBE_DEFINE1(futex, futex_requeue, wakeup, "struct waiting_proc *");
127 LIN_SDT_PROBE_DEFINE3(futex, futex_requeue, requeue, "uint32_t *",
128 "struct waiting_proc *", "uint32_t");
129 LIN_SDT_PROBE_DEFINE1(futex, futex_requeue, return, "int");
130 LIN_SDT_PROBE_DEFINE4(futex, futex_wait, entry, "struct futex *",
131 "struct waiting_proc **", "struct timespec *", "uint32_t");
132 LIN_SDT_PROBE_DEFINE1(futex, futex_wait, sleep_error, "int");
133 LIN_SDT_PROBE_DEFINE1(futex, futex_wait, return, "int");
134 LIN_SDT_PROBE_DEFINE3(futex, futex_atomic_op, entry, "struct thread *",
136 LIN_SDT_PROBE_DEFINE4(futex, futex_atomic_op, decoded_op, "int", "int", "int",
138 LIN_SDT_PROBE_DEFINE0(futex, futex_atomic_op, missing_access_check);
139 LIN_SDT_PROBE_DEFINE1(futex, futex_atomic_op, unimplemented_op, "int");
140 LIN_SDT_PROBE_DEFINE1(futex, futex_atomic_op, unimplemented_cmp, "int");
141 LIN_SDT_PROBE_DEFINE1(futex, futex_atomic_op, return, "int");
142 LIN_SDT_PROBE_DEFINE2(futex, linux_sys_futex, entry, "struct thread *",
143 "struct linux_sys_futex_args *");
144 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unimplemented_clockswitch);
145 LIN_SDT_PROBE_DEFINE1(futex, linux_sys_futex, copyin_error, "int");
146 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, invalid_cmp_requeue_use);
147 LIN_SDT_PROBE_DEFINE3(futex, linux_sys_futex, debug_wait, "uint32_t *",
148 "uint32_t", "uint32_t");
149 LIN_SDT_PROBE_DEFINE4(futex, linux_sys_futex, debug_wait_value_neq,
150 "uint32_t *", "uint32_t", "int", "uint32_t");
151 LIN_SDT_PROBE_DEFINE3(futex, linux_sys_futex, debug_wake, "uint32_t *",
152 "uint32_t", "uint32_t");
153 LIN_SDT_PROBE_DEFINE5(futex, linux_sys_futex, debug_cmp_requeue, "uint32_t *",
154 "uint32_t", "uint32_t", "uint32_t *", "struct l_timespec *");
155 LIN_SDT_PROBE_DEFINE2(futex, linux_sys_futex, debug_cmp_requeue_value_neq,
157 LIN_SDT_PROBE_DEFINE5(futex, linux_sys_futex, debug_wake_op, "uint32_t *",
158 "int", "uint32_t", "uint32_t *", "uint32_t");
159 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unhandled_efault);
160 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unimplemented_lock_pi);
161 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unimplemented_unlock_pi);
162 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unimplemented_trylock_pi);
163 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, deprecated_requeue);
164 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unimplemented_wait_requeue_pi);
165 LIN_SDT_PROBE_DEFINE0(futex, linux_sys_futex, unimplemented_cmp_requeue_pi);
166 LIN_SDT_PROBE_DEFINE1(futex, linux_sys_futex, unknown_operation, "int");
167 LIN_SDT_PROBE_DEFINE1(futex, linux_sys_futex, return, "int");
168 LIN_SDT_PROBE_DEFINE2(futex, linux_set_robust_list, entry, "struct thread *",
169 "struct linux_set_robust_list_args *");
170 LIN_SDT_PROBE_DEFINE0(futex, linux_set_robust_list, size_error);
171 LIN_SDT_PROBE_DEFINE1(futex, linux_set_robust_list, return, "int");
172 LIN_SDT_PROBE_DEFINE2(futex, linux_get_robust_list, entry, "struct thread *",
173 "struct linux_get_robust_list_args *");
174 LIN_SDT_PROBE_DEFINE1(futex, linux_get_robust_list, copyout_error, "int");
175 LIN_SDT_PROBE_DEFINE1(futex, linux_get_robust_list, return, "int");
176 LIN_SDT_PROBE_DEFINE3(futex, handle_futex_death, entry,
177 "struct linux_emuldata *", "uint32_t *", "unsigned int");
178 LIN_SDT_PROBE_DEFINE1(futex, handle_futex_death, copyin_error, "int");
179 LIN_SDT_PROBE_DEFINE1(futex, handle_futex_death, return, "int");
180 LIN_SDT_PROBE_DEFINE3(futex, fetch_robust_entry, entry,
181 "struct linux_robust_list **", "struct linux_robust_list **",
183 LIN_SDT_PROBE_DEFINE1(futex, fetch_robust_entry, copyin_error, "int");
184 LIN_SDT_PROBE_DEFINE1(futex, fetch_robust_entry, return, "int");
185 LIN_SDT_PROBE_DEFINE2(futex, release_futexes, entry, "struct thread *",
186 "struct linux_emuldata *");
187 LIN_SDT_PROBE_DEFINE1(futex, release_futexes, copyin_error, "int");
188 LIN_SDT_PROBE_DEFINE0(futex, release_futexes, return);
192 struct waiting_proc {
194 struct futex *wp_futex;
195 TAILQ_ENTRY(waiting_proc) wp_list;
200 uint32_t *f_uaddr; /* user-supplied value, for debug */
201 struct umtx_key f_key;
204 LIST_ENTRY(futex) f_list;
205 TAILQ_HEAD(lf_waiting_proc, waiting_proc) f_waiting_proc;
208 struct futex_list futex_list;
210 #define FUTEX_LOCK(f) mtx_lock(&(f)->f_lck)
211 #define FUTEX_LOCKED(f) mtx_owned(&(f)->f_lck)
212 #define FUTEX_UNLOCK(f) mtx_unlock(&(f)->f_lck)
213 #define FUTEX_INIT(f) do { \
214 mtx_init(&(f)->f_lck, "ftlk", NULL, \
216 LIN_SDT_PROBE1(futex, futex, create, \
219 #define FUTEX_DESTROY(f) do { \
220 LIN_SDT_PROBE1(futex, futex, destroy, \
222 mtx_destroy(&(f)->f_lck); \
224 #define FUTEX_ASSERT_LOCKED(f) mtx_assert(&(f)->f_lck, MA_OWNED)
225 #define FUTEX_ASSERT_UNLOCKED(f) mtx_assert(&(f)->f_lck, MA_NOTOWNED)
227 struct mtx futex_mtx; /* protects the futex list */
228 #define FUTEXES_LOCK do { \
229 mtx_lock(&futex_mtx); \
230 LIN_SDT_PROBE1(locks, futex_mtx, \
231 locked, &futex_mtx); \
233 #define FUTEXES_UNLOCK do { \
234 LIN_SDT_PROBE1(locks, futex_mtx, \
235 unlock, &futex_mtx); \
236 mtx_unlock(&futex_mtx); \
239 /* flags for futex_get() */
240 #define FUTEX_CREATE_WP 0x1 /* create waiting_proc */
241 #define FUTEX_DONTCREATE 0x2 /* don't create futex if not exists */
242 #define FUTEX_DONTEXISTS 0x4 /* return EINVAL if futex exists */
243 #define FUTEX_SHARED 0x8 /* shared futex */
244 #define FUTEX_DONTLOCK 0x10 /* don't lock futex */
247 #define FUTEX_WP_REQUEUED 0x1 /* wp requeued - wp moved from wp_list
248 * of futex where thread sleep to wp_list
251 #define FUTEX_WP_REMOVED 0x2 /* wp is woken up and removed from futex
252 * wp_list to prevent double wakeup.
255 static void futex_put(struct futex *, struct waiting_proc *);
256 static int futex_get0(uint32_t *, struct futex **f, uint32_t);
257 static int futex_get(uint32_t *, struct waiting_proc **, struct futex **,
259 static int futex_sleep(struct futex *, struct waiting_proc *, struct timespec *);
260 static int futex_wake(struct futex *, int, uint32_t);
261 static int futex_requeue(struct futex *, int, struct futex *, int);
262 static int futex_copyin_timeout(int, struct l_timespec *, int,
264 static int futex_wait(struct futex *, struct waiting_proc *, struct timespec *,
266 static void futex_lock(struct futex *);
267 static void futex_unlock(struct futex *);
268 static int futex_atomic_op(struct thread *, int, uint32_t *);
269 static int handle_futex_death(struct linux_emuldata *, uint32_t *,
271 static int fetch_robust_entry(struct linux_robust_list **,
272 struct linux_robust_list **, unsigned int *);
275 int futex_xchgl(int oparg, uint32_t *uaddr, int *oldval);
276 int futex_addl(int oparg, uint32_t *uaddr, int *oldval);
277 int futex_orl(int oparg, uint32_t *uaddr, int *oldval);
278 int futex_andl(int oparg, uint32_t *uaddr, int *oldval);
279 int futex_xorl(int oparg, uint32_t *uaddr, int *oldval);
283 futex_copyin_timeout(int op, struct l_timespec *luts, int clockrt,
286 struct l_timespec lts;
290 error = copyin(luts, <s, sizeof(lts));
294 error = linux_to_native_timespec(ts, <s);
297 if (ts->tv_nsec < 0 || ts->tv_nsec >= 1000000000)
302 timespecsub(ts, &kts);
303 } else if (op == LINUX_FUTEX_WAIT_BITSET) {
305 timespecsub(ts, &kts);
311 futex_put(struct futex *f, struct waiting_proc *wp)
313 LIN_SDT_PROBE2(futex, futex_put, entry, f, wp);
316 if ((wp->wp_flags & FUTEX_WP_REMOVED) == 0)
317 TAILQ_REMOVE(&f->f_waiting_proc, wp, wp_list);
318 free(wp, M_FUTEX_WP);
322 if (--f->f_refcount == 0) {
323 LIST_REMOVE(f, f_list);
328 LIN_SDT_PROBE3(futex, futex_put, destroy, f->f_uaddr,
329 f->f_refcount, f->f_key.shared);
330 LINUX_CTR3(sys_futex, "futex_put destroy uaddr %p ref %d "
331 "shared %d", f->f_uaddr, f->f_refcount, f->f_key.shared);
332 umtx_key_release(&f->f_key);
336 LIN_SDT_PROBE0(futex, futex_put, return);
340 LIN_SDT_PROBE3(futex, futex_put, unlock, f->f_uaddr, f->f_refcount,
342 LINUX_CTR3(sys_futex, "futex_put uaddr %p ref %d shared %d",
343 f->f_uaddr, f->f_refcount, f->f_key.shared);
348 LIN_SDT_PROBE0(futex, futex_put, return);
352 futex_get0(uint32_t *uaddr, struct futex **newf, uint32_t flags)
354 struct futex *f, *tmpf;
358 LIN_SDT_PROBE3(futex, futex_get0, entry, uaddr, newf, flags);
362 error = umtx_key_get(uaddr, TYPE_FUTEX, (flags & FUTEX_SHARED) ?
363 AUTO_SHARE : THREAD_SHARE, &key);
365 LIN_SDT_PROBE1(futex, futex_get0, umtx_key_get_error, error);
366 LIN_SDT_PROBE1(futex, futex_get0, return, error);
371 LIST_FOREACH(f, &futex_list, f_list) {
372 if (umtx_key_match(&f->f_key, &key)) {
374 if (FUTEX_LOCKED(tmpf))
379 if (flags & FUTEX_DONTEXISTS) {
381 umtx_key_release(&key);
383 LIN_SDT_PROBE1(futex, futex_get0, return,
389 * Increment refcount of the found futex to
390 * prevent it from deallocation before FUTEX_LOCK()
394 umtx_key_release(&key);
396 if ((flags & FUTEX_DONTLOCK) == 0)
399 LIN_SDT_PROBE3(futex, futex_get0, shared, uaddr,
400 f->f_refcount, f->f_key.shared);
401 LINUX_CTR3(sys_futex, "futex_get uaddr %p ref %d shared %d",
402 uaddr, f->f_refcount, f->f_key.shared);
404 LIN_SDT_PROBE1(futex, futex_get0, return, 0);
409 if (flags & FUTEX_DONTCREATE) {
411 umtx_key_release(&key);
412 LIN_SDT_PROBE1(futex, futex_get0, null, uaddr);
413 LINUX_CTR1(sys_futex, "futex_get uaddr %p null", uaddr);
415 LIN_SDT_PROBE1(futex, futex_get0, return, 0);
421 tmpf = malloc(sizeof(*tmpf), M_FUTEX, M_WAITOK | M_ZERO);
422 tmpf->f_uaddr = uaddr;
424 tmpf->f_refcount = 1;
425 tmpf->f_bitset = FUTEX_BITSET_MATCH_ANY;
427 TAILQ_INIT(&tmpf->f_waiting_proc);
430 * Lock the new futex before an insert into the futex_list
431 * to prevent futex usage by other.
433 if ((flags & FUTEX_DONTLOCK) == 0)
438 LIST_INSERT_HEAD(&futex_list, tmpf, f_list);
441 LIN_SDT_PROBE3(futex, futex_get0, new, uaddr, tmpf->f_refcount,
443 LINUX_CTR3(sys_futex, "futex_get uaddr %p ref %d shared %d new",
444 uaddr, tmpf->f_refcount, tmpf->f_key.shared);
447 LIN_SDT_PROBE1(futex, futex_get0, return, 0);
452 futex_get(uint32_t *uaddr, struct waiting_proc **wp, struct futex **f,
457 LIN_SDT_PROBE3(futex, futex_get, entry, uaddr, wp, f);
459 if (flags & FUTEX_CREATE_WP) {
460 *wp = malloc(sizeof(struct waiting_proc), M_FUTEX_WP, M_WAITOK);
463 error = futex_get0(uaddr, f, flags);
465 LIN_SDT_PROBE0(futex, futex_get, error);
467 if (flags & FUTEX_CREATE_WP)
468 free(*wp, M_FUTEX_WP);
470 LIN_SDT_PROBE1(futex, futex_get, return, error);
473 if (flags & FUTEX_CREATE_WP) {
474 TAILQ_INSERT_HEAD(&(*f)->f_waiting_proc, *wp, wp_list);
475 (*wp)->wp_futex = *f;
478 LIN_SDT_PROBE1(futex, futex_get, return, error);
483 futex_lock(struct futex *f)
486 LINUX_CTR3(sys_futex, "futex_lock uaddr %p ref %d shared %d",
487 f->f_uaddr, f->f_refcount, f->f_key.shared);
488 FUTEX_ASSERT_UNLOCKED(f);
493 futex_unlock(struct futex *f)
496 LINUX_CTR3(sys_futex, "futex_unlock uaddr %p ref %d shared %d",
497 f->f_uaddr, f->f_refcount, f->f_key.shared);
498 FUTEX_ASSERT_LOCKED(f);
503 futex_sleep(struct futex *f, struct waiting_proc *wp, struct timespec *ts)
506 sbintime_t sbt, prec, tmp;
510 FUTEX_ASSERT_LOCKED(f);
513 if (uts.tv_sec > INT32_MAX / 2) {
514 over = uts.tv_sec - INT32_MAX / 2;
518 if (TIMESEL(&sbt, tmp))
527 LIN_SDT_PROBE3(futex, futex_sleep, entry, f, wp, sbt);
528 LINUX_CTR4(sys_futex, "futex_sleep enter uaddr %p wp %p timo %ld ref %d",
529 f->f_uaddr, wp, sbt, f->f_refcount);
531 error = msleep_sbt(wp, &f->f_lck, PCATCH, "futex", sbt, prec, C_ABSOLUTE);
532 if (wp->wp_flags & FUTEX_WP_REQUEUED) {
533 KASSERT(f != wp->wp_futex, ("futex != wp_futex"));
536 LIN_SDT_PROBE5(futex, futex_sleep, requeue_error, error,
537 f->f_uaddr, wp, wp->wp_futex->f_uaddr,
538 wp->wp_futex->f_refcount);
541 LINUX_CTR5(sys_futex, "futex_sleep out error %d uaddr %p wp"
542 " %p requeued uaddr %p ref %d",
543 error, f->f_uaddr, wp, wp->wp_futex->f_uaddr,
544 wp->wp_futex->f_refcount);
550 LIN_SDT_PROBE3(futex, futex_sleep, sleep_error, error,
553 LINUX_CTR3(sys_futex, "futex_sleep out error %d uaddr %p wp %p",
554 error, f->f_uaddr, wp);
559 LIN_SDT_PROBE1(futex, futex_sleep, return, error);
564 futex_wake(struct futex *f, int n, uint32_t bitset)
566 struct waiting_proc *wp, *wpt;
569 LIN_SDT_PROBE3(futex, futex_wake, entry, f, n, bitset);
572 LIN_SDT_PROBE1(futex, futex_wake, return, EINVAL);
576 FUTEX_ASSERT_LOCKED(f);
577 TAILQ_FOREACH_SAFE(wp, &f->f_waiting_proc, wp_list, wpt) {
578 LIN_SDT_PROBE3(futex, futex_wake, iterate, f->f_uaddr, wp,
580 LINUX_CTR3(sys_futex, "futex_wake uaddr %p wp %p ref %d",
581 f->f_uaddr, wp, f->f_refcount);
583 * Unless we find a matching bit in
584 * the bitset, continue searching.
586 if (!(wp->wp_futex->f_bitset & bitset))
589 wp->wp_flags |= FUTEX_WP_REMOVED;
590 TAILQ_REMOVE(&f->f_waiting_proc, wp, wp_list);
591 LIN_SDT_PROBE1(futex, futex_wake, wakeup, wp);
597 LIN_SDT_PROBE1(futex, futex_wake, return, count);
602 futex_requeue(struct futex *f, int n, struct futex *f2, int n2)
604 struct waiting_proc *wp, *wpt;
607 LIN_SDT_PROBE4(futex, futex_requeue, entry, f, n, f2, n2);
609 FUTEX_ASSERT_LOCKED(f);
610 FUTEX_ASSERT_LOCKED(f2);
612 TAILQ_FOREACH_SAFE(wp, &f->f_waiting_proc, wp_list, wpt) {
614 LINUX_CTR2(sys_futex, "futex_req_wake uaddr %p wp %p",
616 wp->wp_flags |= FUTEX_WP_REMOVED;
617 TAILQ_REMOVE(&f->f_waiting_proc, wp, wp_list);
618 LIN_SDT_PROBE1(futex, futex_requeue, wakeup, wp);
621 LIN_SDT_PROBE3(futex, futex_requeue, requeue,
622 f->f_uaddr, wp, f2->f_uaddr);
623 LINUX_CTR3(sys_futex, "futex_requeue uaddr %p wp %p to %p",
624 f->f_uaddr, wp, f2->f_uaddr);
625 wp->wp_flags |= FUTEX_WP_REQUEUED;
626 /* Move wp to wp_list of f2 futex */
627 TAILQ_REMOVE(&f->f_waiting_proc, wp, wp_list);
628 TAILQ_INSERT_HEAD(&f2->f_waiting_proc, wp, wp_list);
631 * Thread which sleeps on wp after waking should
632 * acquire f2 lock, so increment refcount of f2 to
633 * prevent it from premature deallocation.
644 LIN_SDT_PROBE1(futex, futex_requeue, return, count);
649 futex_wait(struct futex *f, struct waiting_proc *wp, struct timespec *ts,
654 LIN_SDT_PROBE4(futex, futex_wait, entry, f, wp, ts, bitset);
657 LIN_SDT_PROBE1(futex, futex_wait, return, EINVAL);
661 f->f_bitset = bitset;
662 error = futex_sleep(f, wp, ts);
664 LIN_SDT_PROBE1(futex, futex_wait, sleep_error, error);
665 if (error == EWOULDBLOCK)
668 LIN_SDT_PROBE1(futex, futex_wait, return, error);
673 futex_atomic_op(struct thread *td, int encoded_op, uint32_t *uaddr)
675 int op = (encoded_op >> 28) & 7;
676 int cmp = (encoded_op >> 24) & 15;
677 int oparg = (encoded_op << 8) >> 20;
678 int cmparg = (encoded_op << 20) >> 20;
681 LIN_SDT_PROBE3(futex, futex_atomic_op, entry, td, encoded_op, uaddr);
683 if (encoded_op & (FUTEX_OP_OPARG_SHIFT << 28))
686 LIN_SDT_PROBE4(futex, futex_atomic_op, decoded_op, op, cmp, oparg,
689 /* XXX: Linux verifies access here and returns EFAULT */
690 LIN_SDT_PROBE0(futex, futex_atomic_op, missing_access_check);
694 ret = futex_xchgl(oparg, uaddr, &oldval);
697 ret = futex_addl(oparg, uaddr, &oldval);
700 ret = futex_orl(oparg, uaddr, &oldval);
703 ret = futex_andl(~oparg, uaddr, &oldval);
706 ret = futex_xorl(oparg, uaddr, &oldval);
709 LIN_SDT_PROBE1(futex, futex_atomic_op, unimplemented_op, op);
715 LIN_SDT_PROBE1(futex, futex_atomic_op, return, ret);
720 case FUTEX_OP_CMP_EQ:
721 ret = (oldval == cmparg);
723 case FUTEX_OP_CMP_NE:
724 ret = (oldval != cmparg);
726 case FUTEX_OP_CMP_LT:
727 ret = (oldval < cmparg);
729 case FUTEX_OP_CMP_GE:
730 ret = (oldval >= cmparg);
732 case FUTEX_OP_CMP_LE:
733 ret = (oldval <= cmparg);
735 case FUTEX_OP_CMP_GT:
736 ret = (oldval > cmparg);
739 LIN_SDT_PROBE1(futex, futex_atomic_op, unimplemented_cmp, cmp);
743 LIN_SDT_PROBE1(futex, futex_atomic_op, return, ret);
748 linux_sys_futex(struct thread *td, struct linux_sys_futex_args *args)
750 int clockrt, nrwake, op_ret, ret;
751 struct linux_pemuldata *pem;
752 struct waiting_proc *wp;
753 struct futex *f, *f2;
754 struct timespec uts, *ts;
758 LIN_SDT_PROBE2(futex, linux_sys_futex, entry, td, args);
760 if (args->op & LINUX_FUTEX_PRIVATE_FLAG) {
762 args->op &= ~LINUX_FUTEX_PRIVATE_FLAG;
764 flags = FUTEX_SHARED;
767 * Currently support for switching between CLOCK_MONOTONIC and
768 * CLOCK_REALTIME is not present. However Linux forbids the use of
769 * FUTEX_CLOCK_REALTIME with any op except FUTEX_WAIT_BITSET and
770 * FUTEX_WAIT_REQUEUE_PI.
772 clockrt = args->op & LINUX_FUTEX_CLOCK_REALTIME;
773 args->op = args->op & ~LINUX_FUTEX_CLOCK_REALTIME;
774 if (clockrt && args->op != LINUX_FUTEX_WAIT_BITSET &&
775 args->op != LINUX_FUTEX_WAIT_REQUEUE_PI) {
776 LIN_SDT_PROBE0(futex, linux_sys_futex,
777 unimplemented_clockswitch);
778 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
786 case LINUX_FUTEX_WAIT:
787 args->val3 = FUTEX_BITSET_MATCH_ANY;
790 case LINUX_FUTEX_WAIT_BITSET:
791 LIN_SDT_PROBE3(futex, linux_sys_futex, debug_wait, args->uaddr,
792 args->val, args->val3);
793 LINUX_CTR3(sys_futex, "WAIT uaddr %p val 0x%x bitset 0x%x",
794 args->uaddr, args->val, args->val3);
796 if (args->timeout != NULL) {
797 error = futex_copyin_timeout(args->op, args->timeout,
800 LIN_SDT_PROBE1(futex, linux_sys_futex, copyin_error,
802 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
810 error = futex_get(args->uaddr, &wp, &f,
811 flags | FUTEX_CREATE_WP);
813 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
817 error = copyin_nofault(args->uaddr, &val, sizeof(val));
820 error = copyin(args->uaddr, &val, sizeof(val));
823 LIN_SDT_PROBE1(futex, linux_sys_futex, copyin_error,
825 LINUX_CTR1(sys_futex, "WAIT copyin failed %d",
827 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
830 if (val != args->val) {
831 LIN_SDT_PROBE4(futex, linux_sys_futex,
832 debug_wait_value_neq, args->uaddr, args->val, val,
834 LINUX_CTR3(sys_futex,
835 "WAIT uaddr %p val 0x%x != uval 0x%x",
836 args->uaddr, args->val, val);
839 LIN_SDT_PROBE1(futex, linux_sys_futex, return,
841 return (EWOULDBLOCK);
844 error = futex_wait(f, wp, ts, args->val3);
847 case LINUX_FUTEX_WAKE:
848 args->val3 = FUTEX_BITSET_MATCH_ANY;
851 case LINUX_FUTEX_WAKE_BITSET:
852 LIN_SDT_PROBE3(futex, linux_sys_futex, debug_wake, args->uaddr,
853 args->val, args->val3);
854 LINUX_CTR3(sys_futex, "WAKE uaddr %p nrwake 0x%x bitset 0x%x",
855 args->uaddr, args->val, args->val3);
857 error = futex_get(args->uaddr, NULL, &f,
858 flags | FUTEX_DONTCREATE);
860 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
865 td->td_retval[0] = 0;
867 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
870 td->td_retval[0] = futex_wake(f, args->val, args->val3);
874 case LINUX_FUTEX_CMP_REQUEUE:
875 LIN_SDT_PROBE5(futex, linux_sys_futex, debug_cmp_requeue,
876 args->uaddr, args->val, args->val3, args->uaddr2,
878 LINUX_CTR5(sys_futex, "CMP_REQUEUE uaddr %p "
879 "nrwake 0x%x uval 0x%x uaddr2 %p nrequeue 0x%x",
880 args->uaddr, args->val, args->val3, args->uaddr2,
884 * Linux allows this, we would not, it is an incorrect
885 * usage of declared ABI, so return EINVAL.
887 if (args->uaddr == args->uaddr2) {
888 LIN_SDT_PROBE0(futex, linux_sys_futex,
889 invalid_cmp_requeue_use);
890 LIN_SDT_PROBE1(futex, linux_sys_futex, return, EINVAL);
895 error = futex_get(args->uaddr, NULL, &f, flags | FUTEX_DONTLOCK);
897 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
902 * To avoid deadlocks return EINVAL if second futex
903 * exists at this time.
905 * Glibc fall back to FUTEX_WAKE in case of any error
906 * returned by FUTEX_CMP_REQUEUE.
908 error = futex_get(args->uaddr2, NULL, &f2,
909 flags | FUTEX_DONTEXISTS | FUTEX_DONTLOCK);
913 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
918 error = copyin_nofault(args->uaddr, &val, sizeof(val));
922 error = copyin(args->uaddr, &val, sizeof(val));
925 LIN_SDT_PROBE1(futex, linux_sys_futex, copyin_error,
927 LINUX_CTR1(sys_futex, "CMP_REQUEUE copyin failed %d",
929 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
932 if (val != args->val3) {
933 LIN_SDT_PROBE2(futex, linux_sys_futex,
934 debug_cmp_requeue_value_neq, args->val, val);
935 LINUX_CTR2(sys_futex, "CMP_REQUEUE val 0x%x != uval 0x%x",
940 LIN_SDT_PROBE1(futex, linux_sys_futex, return, EAGAIN);
944 nrwake = (int)(unsigned long)args->timeout;
945 td->td_retval[0] = futex_requeue(f, args->val, f2, nrwake);
950 case LINUX_FUTEX_WAKE_OP:
951 LIN_SDT_PROBE5(futex, linux_sys_futex, debug_wake_op,
952 args->uaddr, args->op, args->val, args->uaddr2, args->val3);
953 LINUX_CTR5(sys_futex, "WAKE_OP "
954 "uaddr %p nrwake 0x%x uaddr2 %p op 0x%x nrwake2 0x%x",
955 args->uaddr, args->val, args->uaddr2, args->val3,
959 error = futex_get(args->uaddr, NULL, &f, flags | FUTEX_DONTLOCK);
961 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
965 if (args->uaddr != args->uaddr2)
966 error = futex_get(args->uaddr2, NULL, &f2,
967 flags | FUTEX_DONTLOCK);
971 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
978 * This function returns positive number as results and
981 save = vm_fault_disable_pagefaults();
982 op_ret = futex_atomic_op(td, args->val3, args->uaddr2);
983 vm_fault_enable_pagefaults(save);
985 LINUX_CTR2(sys_futex, "WAKE_OP atomic_op uaddr %p ret 0x%x",
986 args->uaddr, op_ret);
992 error = copyin(args->uaddr2, &val, sizeof(val));
995 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
999 ret = futex_wake(f, args->val, args->val3);
1003 nrwake = (int)(unsigned long)args->timeout;
1006 op_ret += futex_wake(f2, nrwake, args->val3);
1008 op_ret += futex_wake(f, nrwake, args->val3);
1013 futex_put(f2, NULL);
1015 td->td_retval[0] = ret;
1018 case LINUX_FUTEX_LOCK_PI:
1019 /* not yet implemented */
1020 pem = pem_find(td->td_proc);
1021 if ((pem->flags & LINUX_XUNSUP_FUTEXPIOP) == 0) {
1024 "unsupported futex_pi op\n");
1025 pem->flags |= LINUX_XUNSUP_FUTEXPIOP;
1026 LIN_SDT_PROBE0(futex, linux_sys_futex,
1027 unimplemented_lock_pi);
1029 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
1032 case LINUX_FUTEX_UNLOCK_PI:
1033 /* not yet implemented */
1034 pem = pem_find(td->td_proc);
1035 if ((pem->flags & LINUX_XUNSUP_FUTEXPIOP) == 0) {
1038 "unsupported futex_pi op\n");
1039 pem->flags |= LINUX_XUNSUP_FUTEXPIOP;
1040 LIN_SDT_PROBE0(futex, linux_sys_futex,
1041 unimplemented_unlock_pi);
1043 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
1046 case LINUX_FUTEX_TRYLOCK_PI:
1047 /* not yet implemented */
1048 pem = pem_find(td->td_proc);
1049 if ((pem->flags & LINUX_XUNSUP_FUTEXPIOP) == 0) {
1052 "unsupported futex_pi op\n");
1053 pem->flags |= LINUX_XUNSUP_FUTEXPIOP;
1054 LIN_SDT_PROBE0(futex, linux_sys_futex,
1055 unimplemented_trylock_pi);
1057 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
1060 case LINUX_FUTEX_REQUEUE:
1062 * Glibc does not use this operation since version 2.3.3,
1063 * as it is racy and replaced by FUTEX_CMP_REQUEUE operation.
1064 * Glibc versions prior to 2.3.3 fall back to FUTEX_WAKE when
1065 * FUTEX_REQUEUE returned EINVAL.
1067 pem = pem_find(td->td_proc);
1068 if ((pem->flags & LINUX_XDEPR_REQUEUEOP) == 0) {
1071 "unsupported futex_requeue op\n");
1072 pem->flags |= LINUX_XDEPR_REQUEUEOP;
1073 LIN_SDT_PROBE0(futex, linux_sys_futex,
1074 deprecated_requeue);
1077 LIN_SDT_PROBE1(futex, linux_sys_futex, return, EINVAL);
1080 case LINUX_FUTEX_WAIT_REQUEUE_PI:
1081 /* not yet implemented */
1082 pem = pem_find(td->td_proc);
1083 if ((pem->flags & LINUX_XUNSUP_FUTEXPIOP) == 0) {
1086 "unsupported futex_pi op\n");
1087 pem->flags |= LINUX_XUNSUP_FUTEXPIOP;
1088 LIN_SDT_PROBE0(futex, linux_sys_futex,
1089 unimplemented_wait_requeue_pi);
1091 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
1094 case LINUX_FUTEX_CMP_REQUEUE_PI:
1095 /* not yet implemented */
1096 pem = pem_find(td->td_proc);
1097 if ((pem->flags & LINUX_XUNSUP_FUTEXPIOP) == 0) {
1100 "unsupported futex_pi op\n");
1101 pem->flags |= LINUX_XUNSUP_FUTEXPIOP;
1102 LIN_SDT_PROBE0(futex, linux_sys_futex,
1103 unimplemented_cmp_requeue_pi);
1105 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
1110 "linux_sys_futex: unknown op %d\n", args->op);
1111 LIN_SDT_PROBE1(futex, linux_sys_futex, unknown_operation,
1113 LIN_SDT_PROBE1(futex, linux_sys_futex, return, ENOSYS);
1117 LIN_SDT_PROBE1(futex, linux_sys_futex, return, error);
1122 linux_set_robust_list(struct thread *td, struct linux_set_robust_list_args *args)
1124 struct linux_emuldata *em;
1126 LIN_SDT_PROBE2(futex, linux_set_robust_list, entry, td, args);
1128 if (args->len != sizeof(struct linux_robust_list_head)) {
1129 LIN_SDT_PROBE0(futex, linux_set_robust_list, size_error);
1130 LIN_SDT_PROBE1(futex, linux_set_robust_list, return, EINVAL);
1135 em->robust_futexes = args->head;
1137 LIN_SDT_PROBE1(futex, linux_set_robust_list, return, 0);
1142 linux_get_robust_list(struct thread *td, struct linux_get_robust_list_args *args)
1144 struct linux_emuldata *em;
1145 struct linux_robust_list_head *head;
1146 l_size_t len = sizeof(struct linux_robust_list_head);
1150 LIN_SDT_PROBE2(futex, linux_get_robust_list, entry, td, args);
1154 KASSERT(em != NULL, ("get_robust_list: emuldata notfound.\n"));
1155 head = em->robust_futexes;
1157 td2 = tdfind(args->pid, -1);
1159 LIN_SDT_PROBE1(futex, linux_get_robust_list, return,
1163 if (SV_PROC_ABI(td2->td_proc) != SV_ABI_LINUX) {
1164 LIN_SDT_PROBE1(futex, linux_get_robust_list, return,
1166 PROC_UNLOCK(td2->td_proc);
1171 KASSERT(em != NULL, ("get_robust_list: emuldata notfound.\n"));
1173 if (priv_check(td, PRIV_CRED_SETUID) ||
1174 priv_check(td, PRIV_CRED_SETEUID) ||
1175 p_candebug(td, td2->td_proc)) {
1176 PROC_UNLOCK(td2->td_proc);
1178 LIN_SDT_PROBE1(futex, linux_get_robust_list, return,
1182 head = em->robust_futexes;
1184 PROC_UNLOCK(td2->td_proc);
1187 error = copyout(&len, args->len, sizeof(l_size_t));
1189 LIN_SDT_PROBE1(futex, linux_get_robust_list, copyout_error,
1191 LIN_SDT_PROBE1(futex, linux_get_robust_list, return, EFAULT);
1195 error = copyout(&head, args->head, sizeof(head));
1197 LIN_SDT_PROBE1(futex, linux_get_robust_list, copyout_error,
1201 LIN_SDT_PROBE1(futex, linux_get_robust_list, return, error);
1206 handle_futex_death(struct linux_emuldata *em, uint32_t *uaddr,
1209 uint32_t uval, nval, mval;
1213 LIN_SDT_PROBE3(futex, handle_futex_death, entry, em, uaddr, pi);
1216 error = copyin(uaddr, &uval, 4);
1218 LIN_SDT_PROBE1(futex, handle_futex_death, copyin_error, error);
1219 LIN_SDT_PROBE1(futex, handle_futex_death, return, EFAULT);
1222 if ((uval & FUTEX_TID_MASK) == em->em_tid) {
1223 mval = (uval & FUTEX_WAITERS) | FUTEX_OWNER_DIED;
1224 nval = casuword32(uaddr, uval, mval);
1227 LIN_SDT_PROBE1(futex, handle_futex_death, return,
1235 if (!pi && (uval & FUTEX_WAITERS)) {
1236 error = futex_get(uaddr, NULL, &f,
1237 FUTEX_DONTCREATE | FUTEX_SHARED);
1239 LIN_SDT_PROBE1(futex, handle_futex_death,
1244 futex_wake(f, 1, FUTEX_BITSET_MATCH_ANY);
1250 LIN_SDT_PROBE1(futex, handle_futex_death, return, 0);
1255 fetch_robust_entry(struct linux_robust_list **entry,
1256 struct linux_robust_list **head, unsigned int *pi)
1261 LIN_SDT_PROBE3(futex, fetch_robust_entry, entry, entry, head, pi);
1263 error = copyin((const void *)head, &uentry, sizeof(l_ulong));
1265 LIN_SDT_PROBE1(futex, fetch_robust_entry, copyin_error, error);
1266 LIN_SDT_PROBE1(futex, fetch_robust_entry, return, EFAULT);
1270 *entry = (void *)(uentry & ~1UL);
1273 LIN_SDT_PROBE1(futex, fetch_robust_entry, return, 0);
1277 /* This walks the list of robust futexes releasing them. */
1279 release_futexes(struct thread *td, struct linux_emuldata *em)
1281 struct linux_robust_list_head *head = NULL;
1282 struct linux_robust_list *entry, *next_entry, *pending;
1283 unsigned int limit = 2048, pi, next_pi, pip;
1284 l_long futex_offset;
1287 LIN_SDT_PROBE2(futex, release_futexes, entry, td, em);
1289 head = em->robust_futexes;
1292 LIN_SDT_PROBE0(futex, release_futexes, return);
1296 if (fetch_robust_entry(&entry, PTRIN(&head->list.next), &pi)) {
1297 LIN_SDT_PROBE0(futex, release_futexes, return);
1301 error = copyin(&head->futex_offset, &futex_offset,
1302 sizeof(futex_offset));
1304 LIN_SDT_PROBE1(futex, release_futexes, copyin_error, error);
1305 LIN_SDT_PROBE0(futex, release_futexes, return);
1309 if (fetch_robust_entry(&pending, PTRIN(&head->pending_list), &pip)) {
1310 LIN_SDT_PROBE0(futex, release_futexes, return);
1314 while (entry != &head->list) {
1315 rc = fetch_robust_entry(&next_entry, PTRIN(&entry->next), &next_pi);
1317 if (entry != pending)
1318 if (handle_futex_death(em,
1319 (uint32_t *)((caddr_t)entry + futex_offset), pi)) {
1320 LIN_SDT_PROBE0(futex, release_futexes, return);
1324 LIN_SDT_PROBE0(futex, release_futexes, return);
1334 sched_relinquish(curthread);
1338 handle_futex_death(em, (uint32_t *)((caddr_t)pending + futex_offset), pip);
1340 LIN_SDT_PROBE0(futex, release_futexes, return);