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