xref: /freebsd/sys/compat/linux/linux_futex.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*	$NetBSD: linux_futex.h,v 1.2 2005/12/11 12:20:19 christos Exp $ */
2 
3 /*-
4  * SPDX-License-Identifier: BSD-4-Clause
5  *
6  * Copyright (c) 2005 Emmanuel Dreyfus, all rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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
21  *    permission.
22  *
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.
34  */
35 
36 #ifndef _LINUX_FUTEX_H
37 #define _LINUX_FUTEX_H
38 
39 #define LINUX_FUTEX_WAIT		 0
40 #define LINUX_FUTEX_WAKE		 1
41 #define LINUX_FUTEX_FD			 2	/* unused */
42 #define LINUX_FUTEX_REQUEUE		 3
43 #define LINUX_FUTEX_CMP_REQUEUE		 4
44 #define LINUX_FUTEX_WAKE_OP		 5
45 #define LINUX_FUTEX_LOCK_PI		 6
46 #define LINUX_FUTEX_UNLOCK_PI		 7
47 #define LINUX_FUTEX_TRYLOCK_PI		 8
48 #define LINUX_FUTEX_WAIT_BITSET		 9
49 #define LINUX_FUTEX_WAKE_BITSET		10
50 #define LINUX_FUTEX_WAIT_REQUEUE_PI	11
51 #define LINUX_FUTEX_CMP_REQUEUE_PI	12
52 #define LINUX_FUTEX_LOCK_PI2		13
53 
54 #define LINUX_FUTEX_PRIVATE_FLAG	128
55 #define LINUX_FUTEX_CLOCK_REALTIME	256
56 
57 #define LINUX_FUTEX_CMD_MASK		~(LINUX_FUTEX_PRIVATE_FLAG | \
58 					    LINUX_FUTEX_CLOCK_REALTIME)
59 
60 #define FUTEX_OP_SET            0	/* *(int *)UADDR2 = OPARG; */
61 #define FUTEX_OP_ADD            1	/* *(int *)UADDR2 += OPARG; */
62 #define FUTEX_OP_OR             2	/* *(int *)UADDR2 |= OPARG; */
63 #define FUTEX_OP_ANDN           3	/* *(int *)UADDR2 &= ~OPARG; */
64 #define FUTEX_OP_XOR            4	/* *(int *)UADDR2 ^= OPARG; */
65 
66 #define FUTEX_OP_OPARG_SHIFT    8	/* Use (1 << OPARG) instead of OPARG.  */
67 
68 #define FUTEX_OP_CMP_EQ         0	/* if (oldval == CMPARG) wake */
69 #define FUTEX_OP_CMP_NE         1	/* if (oldval != CMPARG) wake */
70 #define FUTEX_OP_CMP_LT         2	/* if (oldval < CMPARG) wake */
71 #define FUTEX_OP_CMP_LE         3	/* if (oldval <= CMPARG) wake */
72 #define FUTEX_OP_CMP_GT         4	/* if (oldval > CMPARG) wake */
73 #define FUTEX_OP_CMP_GE         5	/* if (oldval >= CMPARG) wake */
74 
75 #define	FUTEX_WAITERS		0x80000000
76 #define	FUTEX_OWNER_DIED	0x40000000
77 #define	FUTEX_TID_MASK		0x3fffffff
78 #define	FUTEX_BITSET_MATCH_ANY	0xffffffff
79 
80 /* robust futexes */
81 struct linux_robust_list {
82 	l_uintptr_t			next;
83 };
84 
85 struct linux_robust_list_head {
86 	struct linux_robust_list	list;
87 	l_long				futex_offset;
88 	l_uintptr_t			pending_list;
89 };
90 
91 int futex_xchgl(int oparg, uint32_t *uaddr, int *oldval);
92 int futex_addl(int oparg, uint32_t *uaddr, int *oldval);
93 int futex_orl(int oparg, uint32_t *uaddr, int *oldval);
94 int futex_andl(int oparg, uint32_t *uaddr, int *oldval);
95 int futex_xorl(int oparg, uint32_t *uaddr, int *oldval);
96 int futex_wake(struct thread *td, uint32_t *uaddr, int val, bool shared);
97 void	release_futexes(struct thread *,
98 			struct linux_emuldata *);
99 
100 #endif	/* !_LINUX_FUTEX_H */
101