1 /* SPDX-License-Identifier: GPL-2.0 */ 1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* 2 /*
3 * Glibc independent futex library for testing 3 * Glibc independent futex library for testing kernel functionality.
4 * Shamelessly stolen from Darren Hart <dvhltc 4 * Shamelessly stolen from Darren Hart <dvhltc@us.ibm.com>
5 * http://git.kernel.org/cgit/linux/kernel/ 5 * http://git.kernel.org/cgit/linux/kernel/git/dvhart/futextest.git/
6 */ 6 */
7 7
8 #ifndef _FUTEX_H 8 #ifndef _FUTEX_H
9 #define _FUTEX_H 9 #define _FUTEX_H
10 10
11 #include <unistd.h> 11 #include <unistd.h>
12 #include <sys/syscall.h> 12 #include <sys/syscall.h>
13 #include <sys/types.h> 13 #include <sys/types.h>
14 #include <linux/futex.h> 14 #include <linux/futex.h>
15 15
16 struct bench_futex_parameters { 16 struct bench_futex_parameters {
17 bool silent; 17 bool silent;
18 bool fshared; 18 bool fshared;
19 bool mlockall; 19 bool mlockall;
20 bool multi; /* lock-pi */ 20 bool multi; /* lock-pi */
21 bool pi; /* requeue-pi */ 21 bool pi; /* requeue-pi */
22 bool broadcast; /* requeue */ 22 bool broadcast; /* requeue */
23 unsigned int runtime; /* seconds*/ 23 unsigned int runtime; /* seconds*/
24 unsigned int nthreads; 24 unsigned int nthreads;
25 unsigned int nfutexes; 25 unsigned int nfutexes;
26 unsigned int nwakes; 26 unsigned int nwakes;
27 unsigned int nrequeue; 27 unsigned int nrequeue;
28 }; 28 };
29 29
30 /** 30 /**
31 * futex_syscall() - SYS_futex syscall wrapper !! 31 * futex() - SYS_futex syscall wrapper
32 * @uaddr: address of first futex 32 * @uaddr: address of first futex
33 * @op: futex op code 33 * @op: futex op code
34 * @val: typically expected value of ua 34 * @val: typically expected value of uaddr, but varies by op
35 * @timeout: typically an absolute struct t 35 * @timeout: typically an absolute struct timespec (except where noted
36 * otherwise). Overloaded by some 36 * otherwise). Overloaded by some ops
37 * @uaddr2: address of second futex for so 37 * @uaddr2: address of second futex for some ops
38 * @val3: varies by op 38 * @val3: varies by op
39 * @opflags: flags to be bitwise OR'd with 39 * @opflags: flags to be bitwise OR'd with op, such as FUTEX_PRIVATE_FLAG
40 * 40 *
41 * futex_syscall() is used by all the followin !! 41 * futex() is used by all the following futex op wrappers. It can also be
42 * used for misuse and abuse testing. Generall 42 * used for misuse and abuse testing. Generally, the specific op wrappers
43 * should be used instead. !! 43 * should be used instead. It is a macro instead of an static inline function as
>> 44 * some of the types over overloaded (timeout is used for nr_requeue for
>> 45 * example).
44 * 46 *
45 * These argument descriptions are the default 47 * These argument descriptions are the defaults for all
46 * like-named arguments in the following wrapp 48 * like-named arguments in the following wrappers except where noted below.
47 */ 49 */
48 static inline int !! 50 #define futex(uaddr, op, val, timeout, uaddr2, val3, opflags) \
49 futex_syscall(volatile u_int32_t *uaddr, int o !! 51 syscall(SYS_futex, uaddr, op | opflags, val, timeout, uaddr2, val3)
50 volatile u_int32_t *uaddr2, int <<
51 { <<
52 return syscall(SYS_futex, uaddr, op | <<
53 } <<
54 <<
55 static inline int <<
56 futex_syscall_nr_requeue(volatile u_int32_t *u <<
57 volatile u_int32_t *u <<
58 { <<
59 return syscall(SYS_futex, uaddr, op | <<
60 } <<
61 52
62 /** 53 /**
63 * futex_wait() - block on uaddr with optional 54 * futex_wait() - block on uaddr with optional timeout
64 * @timeout: relative timeout 55 * @timeout: relative timeout
65 */ 56 */
66 static inline int 57 static inline int
67 futex_wait(u_int32_t *uaddr, u_int32_t val, st 58 futex_wait(u_int32_t *uaddr, u_int32_t val, struct timespec *timeout, int opflags)
68 { 59 {
69 return futex_syscall(uaddr, FUTEX_WAIT !! 60 return futex(uaddr, FUTEX_WAIT, val, timeout, NULL, 0, opflags);
70 } 61 }
71 62
72 /** 63 /**
73 * futex_wake() - wake one or more tasks block 64 * futex_wake() - wake one or more tasks blocked on uaddr
74 * @nr_wake: wake up to this many tasks 65 * @nr_wake: wake up to this many tasks
75 */ 66 */
76 static inline int 67 static inline int
77 futex_wake(u_int32_t *uaddr, int nr_wake, int 68 futex_wake(u_int32_t *uaddr, int nr_wake, int opflags)
78 { 69 {
79 return futex_syscall(uaddr, FUTEX_WAKE !! 70 return futex(uaddr, FUTEX_WAKE, nr_wake, NULL, NULL, 0, opflags);
80 } 71 }
81 72
82 /** 73 /**
83 * futex_lock_pi() - block on uaddr as a PI mu 74 * futex_lock_pi() - block on uaddr as a PI mutex
84 */ 75 */
85 static inline int 76 static inline int
86 futex_lock_pi(u_int32_t *uaddr, struct timespe 77 futex_lock_pi(u_int32_t *uaddr, struct timespec *timeout, int opflags)
87 { 78 {
88 return futex_syscall(uaddr, FUTEX_LOCK !! 79 return futex(uaddr, FUTEX_LOCK_PI, 0, timeout, NULL, 0, opflags);
89 } 80 }
90 81
91 /** 82 /**
92 * futex_unlock_pi() - release uaddr as a PI m 83 * futex_unlock_pi() - release uaddr as a PI mutex, waking the top waiter
93 */ 84 */
94 static inline int 85 static inline int
95 futex_unlock_pi(u_int32_t *uaddr, int opflags) 86 futex_unlock_pi(u_int32_t *uaddr, int opflags)
96 { 87 {
97 return futex_syscall(uaddr, FUTEX_UNLO !! 88 return futex(uaddr, FUTEX_UNLOCK_PI, 0, NULL, NULL, 0, opflags);
98 } 89 }
99 90
100 /** 91 /**
101 * futex_cmp_requeue() - requeue tasks from uad 92 * futex_cmp_requeue() - requeue tasks from uaddr to uaddr2
102 * @nr_wake: wake up to this many tasks 93 * @nr_wake: wake up to this many tasks
103 * @nr_requeue: requeue up to this many tas 94 * @nr_requeue: requeue up to this many tasks
104 */ 95 */
105 static inline int 96 static inline int
106 futex_cmp_requeue(u_int32_t *uaddr, u_int32_t 97 futex_cmp_requeue(u_int32_t *uaddr, u_int32_t val, u_int32_t *uaddr2, int nr_wake,
107 int nr_requeue, int opflags) 98 int nr_requeue, int opflags)
108 { 99 {
109 return futex_syscall_nr_requeue(uaddr, !! 100 return futex(uaddr, FUTEX_CMP_REQUEUE, nr_wake, nr_requeue, uaddr2,
110 val, o !! 101 val, opflags);
111 } 102 }
112 103
113 /** 104 /**
114 * futex_wait_requeue_pi() - block on uaddr an 105 * futex_wait_requeue_pi() - block on uaddr and prepare to requeue to uaddr2
115 * @uaddr: non-PI futex source 106 * @uaddr: non-PI futex source
116 * @uaddr2: PI futex target 107 * @uaddr2: PI futex target
117 * 108 *
118 * This is the first half of the requeue_pi me 109 * This is the first half of the requeue_pi mechanism. It shall always be
119 * paired with futex_cmp_requeue_pi(). 110 * paired with futex_cmp_requeue_pi().
120 */ 111 */
121 static inline int 112 static inline int
122 futex_wait_requeue_pi(u_int32_t *uaddr, u_int3 113 futex_wait_requeue_pi(u_int32_t *uaddr, u_int32_t val, u_int32_t *uaddr2,
123 struct timespec *timeout 114 struct timespec *timeout, int opflags)
124 { 115 {
125 return futex_syscall(uaddr, FUTEX_WAIT !! 116 return futex(uaddr, FUTEX_WAIT_REQUEUE_PI, val, timeout, uaddr2, 0,
126 opflags); !! 117 opflags);
127 } 118 }
128 119
129 /** 120 /**
130 * futex_cmp_requeue_pi() - requeue tasks from 121 * futex_cmp_requeue_pi() - requeue tasks from uaddr to uaddr2
131 * @uaddr: non-PI futex source 122 * @uaddr: non-PI futex source
132 * @uaddr2: PI futex target 123 * @uaddr2: PI futex target
133 * @nr_requeue: requeue up to this many tasks 124 * @nr_requeue: requeue up to this many tasks
134 * 125 *
135 * This is the second half of the requeue_pi m 126 * This is the second half of the requeue_pi mechanism. It shall always be
136 * paired with futex_wait_requeue_pi(). The fi 127 * paired with futex_wait_requeue_pi(). The first waker is always awoken.
137 */ 128 */
138 static inline int 129 static inline int
139 futex_cmp_requeue_pi(u_int32_t *uaddr, u_int32 130 futex_cmp_requeue_pi(u_int32_t *uaddr, u_int32_t val, u_int32_t *uaddr2,
140 int nr_requeue, int opfla 131 int nr_requeue, int opflags)
141 { 132 {
142 return futex_syscall_nr_requeue(uaddr, !! 133 return futex(uaddr, FUTEX_CMP_REQUEUE_PI, 1, nr_requeue, uaddr2,
143 val, o !! 134 val, opflags);
144 } 135 }
145 136
146 #endif /* _FUTEX_H */ 137 #endif /* _FUTEX_H */
147 138
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.