1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LIBCFS_LINUX_WAIT_BIT_H
3 #define __LIBCFS_LINUX_WAIT_BIT_H
5 /* Make sure we can see if we have TASK_NOLOAD */
6 #include <linux/sched.h>
8 * Linux wait-bit related types and methods:
10 #ifdef HAVE_WAIT_BIT_HEADER_H
11 #include <linux/wait_bit.h>
13 #include <linux/wait.h>
15 #ifndef HAVE_WAIT_QUEUE_ENTRY
16 #define wait_queue_entry_t wait_queue_t
19 #ifndef HAVE_WAIT_BIT_HEADER_H
20 struct wait_bit_queue_entry {
21 struct wait_bit_key key;
22 wait_queue_entry_t wq_entry;
25 #define ___wait_is_interruptible(state) \
26 (!__builtin_constant_p(state) || \
27 state == TASK_INTERRUPTIBLE || state == TASK_KILLABLE) \
29 #endif /* ! HAVE_WAIT_BIT_HEADER_H */
31 #ifndef HAVE_PREPARE_TO_WAIT_EVENT
32 extern long prepare_to_wait_event(wait_queue_head_t *wq_head,
33 wait_queue_entry_t *wq_entry, int state);
36 /* ___wait_cond_timeout changed number of args in v3.12-rc1-78-g35a2af94c7ce
37 * so let's define our own ___wait_cond_timeout1
40 #define ___wait_cond_timeout1(condition) \
42 bool __cond = (condition); \
43 if (__cond && !__ret) \
48 #ifndef HAVE_CLEAR_AND_WAKE_UP_BIT
50 * clear_and_wake_up_bit - clear a bit and wake up anyone waiting on that bit
52 * @bit: the bit of the word being waited on
53 * @word: the word being waited on, a kernel virtual address
55 * You can use this helper if bitflags are manipulated atomically rather than
56 * non-atomically under a lock.
58 static inline void clear_and_wake_up_bit(int bit, void *word)
60 clear_bit_unlock(bit, word);
61 /* See wake_up_bit() for which memory barrier you need to use. */
62 smp_mb__after_atomic();
63 wake_up_bit(word, bit);
65 #endif /* ! HAVE_CLEAR_AND_WAKE_UP_BIT */
67 #ifndef HAVE_WAIT_VAR_EVENT
68 extern void __init wait_bit_init(void);
69 extern void init_wait_var_entry(struct wait_bit_queue_entry *wbq_entry,
70 void *var, int flags);
71 extern void wake_up_var(void *var);
72 extern wait_queue_head_t *__var_waitqueue(void *p);
74 #define ___wait_var_event(var, condition, state, exclusive, ret, cmd) \
77 wait_queue_head_t *__wq_head = __var_waitqueue(var); \
78 struct wait_bit_queue_entry __wbq_entry; \
79 long __ret = ret; /* explicit shadow */ \
81 init_wait_var_entry(&__wbq_entry, var, \
82 exclusive ? WQ_FLAG_EXCLUSIVE : 0); \
84 long __int = prepare_to_wait_event(__wq_head, \
85 &__wbq_entry.wq_entry, \
90 if (___wait_is_interruptible(state) && __int) { \
97 finish_wait(__wq_head, &__wbq_entry.wq_entry); \
101 #define __wait_var_event(var, condition) \
102 ___wait_var_event(var, condition, TASK_UNINTERRUPTIBLE, 0, 0, \
105 #define wait_var_event(var, condition) \
110 __wait_var_event(var, condition); \
113 #define __wait_var_event_killable(var, condition) \
114 ___wait_var_event(var, condition, TASK_KILLABLE, 0, 0, \
117 #define wait_var_event_killable(var, condition) \
122 __ret = __wait_var_event_killable(var, condition); \
126 #define __wait_var_event_timeout(var, condition, timeout) \
127 ___wait_var_event(var, ___wait_cond_timeout1(condition), \
128 TASK_UNINTERRUPTIBLE, 0, timeout, \
129 __ret = schedule_timeout(__ret))
131 #define wait_var_event_timeout(var, condition, timeout) \
133 long __ret = timeout; \
135 if (!___wait_cond_timeout1(condition)) \
136 __ret = __wait_var_event_timeout(var, condition, timeout); \
139 #endif /* ! HAVE_WAIT_VAR_EVENT */
142 * prepare_to_wait_event() does not support an exclusive
144 * However it will not relink the wait_queue_entry if
145 * it is already linked. So we link to the head of the
146 * queue here, and it will stay there.
148 static inline void prepare_to_wait_exclusive_head(
149 wait_queue_head_t *waitq, wait_queue_entry_t *link)
153 spin_lock_irqsave(&(waitq->lock), flags);
154 #ifdef HAVE_WAIT_QUEUE_ENTRY_LIST
155 if (list_empty(&link->entry))
157 if (list_empty(&link->task_list))
159 __add_wait_queue_exclusive(waitq, link);
160 spin_unlock_irqrestore(&((waitq)->lock), flags);
163 #ifndef ___wait_event
165 * The below macro ___wait_event() has an explicit shadow of the __ret
166 * variable when used from the wait_event_*() macros.
168 * This is so that both can use the ___wait_cond_timeout1() construct
169 * to wrap the condition.
171 * The type inconsistency of the wait_event_*() __ret variable is also
172 * on purpose; we use long where we can return timeout values and int
176 #define ___wait_event(wq_head, condition, state, exclusive, ret, cmd) \
179 wait_queue_entry_ __wq_entry; \
180 long __ret = ret; /* explicit shadow */ \
182 init_wait(&__wq_entry); \
184 __wq_entry.flags = WQ_FLAG_EXCLUSIVE \
186 long __int = prepare_to_wait_event(&wq_head, \
187 &__wq_entry, state); \
192 if (___wait_is_interruptible(state) && __int) { \
199 finish_wait(&wq_head, &__wq_entry); \
206 #define ___wait_event_idle(wq_head, condition, exclusive, ret, cmd) \
208 wait_queue_entry_t __wq_entry; \
209 unsigned long flags; \
210 long __ret = ret; /* explicit shadow */ \
211 sigset_t __blocked; \
213 __blocked = cfs_block_sigsinv(0); \
214 init_wait(&__wq_entry); \
216 __wq_entry.flags = WQ_FLAG_EXCLUSIVE; \
218 prepare_to_wait_event(&wq_head, \
220 TASK_INTERRUPTIBLE); \
224 /* See justification in __l_wait_event */ \
225 if (signal_pending(current)) { \
226 spin_lock_irqsave(¤t->sighand->siglock, \
228 clear_tsk_thread_flag(current, TIF_SIGPENDING); \
229 spin_unlock_irqrestore(¤t->sighand->siglock,\
234 finish_wait(&wq_head, &__wq_entry); \
235 cfs_restore_sigs(__blocked); \
239 #define wait_event_idle(wq_head, condition) \
243 ___wait_event_idle(wq_head, condition, 0, 0, schedule());\
246 #define wait_event_idle_exclusive(wq_head, condition) \
250 ___wait_event_idle(wq_head, condition, 1, 0, schedule());\
253 #define __wait_event_idle_exclusive_timeout(wq_head, condition, timeout)\
254 ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition), \
256 __ret = schedule_timeout(__ret))
258 #define wait_event_idle_exclusive_timeout(wq_head, condition, timeout) \
260 long __ret = timeout; \
262 if (!___wait_cond_timeout1(condition)) \
263 __ret = __wait_event_idle_exclusive_timeout( \
264 wq_head, condition, timeout); \
268 #define __wait_event_idle_exclusive_timeout_cmd(wq_head, condition, \
269 timeout, cmd1, cmd2) \
270 ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition), \
272 cmd1; __ret = schedule_timeout(__ret); cmd2)
274 #define wait_event_idle_exclusive_timeout_cmd(wq_head, condition, timeout,\
277 long __ret = timeout; \
279 if (!___wait_cond_timeout1(condition)) \
280 __ret = __wait_event_idle_exclusive_timeout_cmd( \
281 wq_head, condition, timeout, cmd1, cmd2); \
285 #define __wait_event_idle_timeout(wq_head, condition, timeout) \
286 ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition), \
288 __ret = schedule_timeout(__ret))
290 #define wait_event_idle_timeout(wq_head, condition, timeout) \
292 long __ret = timeout; \
294 if (!___wait_cond_timeout1(condition)) \
295 __ret = __wait_event_idle_timeout(wq_head, condition, \
300 #else /* TASK_IDLE */
301 #ifndef wait_event_idle
303 * wait_event_idle - wait for a condition without contributing to system load
304 * @wq_head: the waitqueue to wait on
305 * @condition: a C expression for the event to wait for
307 * The process is put to sleep (TASK_IDLE) until the
308 * @condition evaluates to true.
309 * The @condition is checked each time the waitqueue @wq_head is woken up.
311 * wake_up() has to be called after changing any variable that could
312 * change the result of the wait condition.
315 #define wait_event_idle(wq_head, condition) \
319 ___wait_event(wq_head, condition, TASK_IDLE, 0, 0, \
323 #ifndef wait_event_idle_exclusive
325 * wait_event_idle_exclusive - wait for a condition without contributing to
327 * @wq_head: the waitqueue to wait on
328 * @condition: a C expression for the event to wait for
330 * The process is put to sleep (TASK_IDLE) until the
331 * @condition evaluates to true.
332 * The @condition is checked each time the waitqueue @wq_head is woken up.
334 * The process is put on the wait queue with an WQ_FLAG_EXCLUSIVE flag
335 * set thus if other processes wait on the same list, when this
336 * process is woken further processes are not considered.
338 * wake_up() has to be called after changing any variable that could
339 * change the result of the wait condition.
342 #define wait_event_idle_exclusive(wq_head, condition) \
346 ___wait_event(wq_head, condition, TASK_IDLE, 1, 0, \
350 #ifndef wait_event_idle_exclusive_timeout
352 * wait_event_idle_exclusive_timeout - sleep without load until a condition
353 * becomes true or a timeout elapses
354 * @wq_head: the waitqueue to wait on
355 * @condition: a C expression for the event to wait for
356 * @timeout: timeout, in jiffies
358 * The process is put to sleep (TASK_IDLE) until the
359 * @condition evaluates to true. The @condition is checked each time
360 * the waitqueue @wq_head is woken up.
362 * The process is put on the wait queue with an WQ_FLAG_EXCLUSIVE flag
363 * set thus if other processes wait on the same list, when this
364 * process is woken further processes are not considered.
366 * wake_up() has to be called after changing any variable that could
367 * change the result of the wait condition.
370 * 0 if the @condition evaluated to %false after the @timeout elapsed,
371 * 1 if the @condition evaluated to %true after the @timeout elapsed,
372 * or the remaining jiffies (at least 1) if the @condition evaluated
373 * to %true before the @timeout elapsed.
375 #define wait_event_idle_exclusive_timeout(wq_head, condition, timeout) \
377 long __ret = timeout; \
379 if (!___wait_cond_timeout1(condition)) \
380 __ret = __wait_event_idle_exclusive_timeout(wq_head, \
386 #ifndef wait_event_idle_exclusive_timeout_cmd
387 #define __wait_event_idle_exclusive_timeout_cmd(wq_head, condition, \
388 timeout, cmd1, cmd2) \
389 ___wait_event(wq_head, ___wait_cond_timeout1(condition), \
390 TASK_IDLE, 1, timeout, \
391 cmd1; __ret = schedule_timeout(__ret); cmd2)
393 #define wait_event_idle_exclusive_timeout_cmd(wq_head, condition, timeout,\
396 long __ret = timeout; \
398 if (!___wait_cond_timeout1(condition)) \
399 __ret = __wait_event_idle_exclusive_timeout_cmd( \
400 wq_head, condition, timeout, cmd1, cmd2); \
405 #ifndef wait_event_idle_timeout
407 #define __wait_event_idle_timeout(wq_head, condition, timeout) \
408 ___wait_event(wq_head, ___wait_cond_timeout1(condition), \
409 TASK_IDLE, 0, timeout, \
410 __ret = schedule_timeout(__ret))
413 * wait_event_idle_timeout - sleep without load until a condition becomes
414 * true or a timeout elapses
415 * @wq_head: the waitqueue to wait on
416 * @condition: a C expression for the event to wait for
417 * @timeout: timeout, in jiffies
419 * The process is put to sleep (TASK_IDLE) until the
420 * @condition evaluates to true. The @condition is checked each time
421 * the waitqueue @wq_head is woken up.
423 * wake_up() has to be called after changing any variable that could
424 * change the result of the wait condition.
427 * 0 if the @condition evaluated to %false after the @timeout elapsed,
428 * 1 if the @condition evaluated to %true after the @timeout elapsed,
429 * or the remaining jiffies (at least 1) if the @condition evaluated
430 * to %true before the @timeout elapsed.
432 #define wait_event_idle_timeout(wq_head, condition, timeout) \
434 long __ret = timeout; \
436 if (!___wait_cond_timeout1(condition)) \
437 __ret = __wait_event_idle_timeout(wq_head, condition, \
442 #endif /* TASK_IDLE */
444 /* ___wait_event_lifo is used for lifo exclusive 'idle' waits */
447 #define ___wait_event_lifo(wq_head, condition, ret, cmd) \
449 wait_queue_entry_t __wq_entry; \
450 long __ret = ret; /* explicit shadow */ \
452 init_wait(&__wq_entry); \
453 __wq_entry.flags = WQ_FLAG_EXCLUSIVE; \
455 prepare_to_wait_exclusive_head(&wq_head, &__wq_entry); \
456 prepare_to_wait_event(&wq_head, &__wq_entry, TASK_IDLE);\
463 finish_wait(&wq_head, &__wq_entry); \
467 #define ___wait_event_lifo(wq_head, condition, ret, cmd) \
469 wait_queue_entry_t __wq_entry; \
470 unsigned long flags; \
471 long __ret = ret; /* explicit shadow */ \
472 sigset_t __blocked; \
474 __blocked = cfs_block_sigsinv(0); \
475 init_wait(&__wq_entry); \
476 __wq_entry.flags = WQ_FLAG_EXCLUSIVE; \
478 prepare_to_wait_exclusive_head(&wq_head, &__wq_entry); \
479 prepare_to_wait_event(&wq_head, &__wq_entry, \
480 TASK_INTERRUPTIBLE); \
484 /* See justification in __l_wait_event */ \
485 if (signal_pending(current)) { \
486 spin_lock_irqsave(¤t->sighand->siglock, \
488 clear_tsk_thread_flag(current, TIF_SIGPENDING); \
489 spin_unlock_irqrestore(¤t->sighand->siglock,\
494 cfs_restore_sigs(__blocked); \
495 finish_wait(&wq_head, &__wq_entry); \
500 #define wait_event_idle_exclusive_lifo(wq_head, condition) \
504 ___wait_event_lifo(wq_head, condition, 0, schedule()); \
507 #define __wait_event_idle_lifo_timeout(wq_head, condition, timeout) \
508 ___wait_event_lifo(wq_head, ___wait_cond_timeout1(condition), \
510 __ret = schedule_timeout(__ret))
512 #define wait_event_idle_exclusive_lifo_timeout(wq_head, condition, timeout)\
514 long __ret = timeout; \
516 if (!___wait_cond_timeout1(condition)) \
517 __ret = __wait_event_idle_lifo_timeout(wq_head, \
523 /* l_wait_event_abortable() is a bit like wait_event_killable()
524 * except there is a fixed set of signals which will abort:
527 #define LUSTRE_FATAL_SIGS \
528 (sigmask(SIGKILL) | sigmask(SIGINT) | sigmask(SIGTERM) | \
529 sigmask(SIGQUIT) | sigmask(SIGALRM))
531 #define l_wait_event_abortable(wq, condition) \
533 sigset_t __new_blocked, __old_blocked; \
535 siginitsetinv(&__new_blocked, LUSTRE_FATAL_SIGS); \
536 sigprocmask(SIG_BLOCK, &__new_blocked, &__old_blocked); \
537 __ret = wait_event_interruptible(wq, condition); \
538 sigprocmask(SIG_SETMASK, &__old_blocked, NULL); \
542 #define l_wait_event_abortable_timeout(wq, condition, timeout) \
544 sigset_t __new_blocked, __old_blocked; \
546 siginitsetinv(&__new_blocked, LUSTRE_FATAL_SIGS); \
547 sigprocmask(SIG_BLOCK, &__new_blocked, &__old_blocked); \
548 __ret = wait_event_interruptible_timeout(wq, condition, timeout);\
549 sigprocmask(SIG_SETMASK, &__old_blocked, NULL); \
553 #define l_wait_event_abortable_exclusive(wq, condition) \
555 sigset_t __new_blocked, __old_blocked; \
557 siginitsetinv(&__new_blocked, LUSTRE_FATAL_SIGS); \
558 sigprocmask(SIG_BLOCK, &__new_blocked, &__old_blocked); \
559 __ret = wait_event_interruptible_exclusive(wq, condition); \
560 sigprocmask(SIG_SETMASK, &__old_blocked, NULL); \
564 #endif /* __LICBFS_LINUX_WAIT_BIT_H */