Whamcloud - gitweb
LU-9859 libcfs: simplify linux-prim.c
[fs/lustre-release.git] / libcfs / include / libcfs / linux / linux-wait.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __LIBCFS_LINUX_WAIT_BIT_H
3 #define __LIBCFS_LINUX_WAIT_BIT_H
4
5 /* Make sure we can see if we have TASK_NOLOAD */
6 #include <linux/sched.h>
7 /*
8  * Linux wait-bit related types and methods:
9  */
10 #ifdef HAVE_WAIT_BIT_HEADER_H
11 #include <linux/wait_bit.h>
12 #endif
13 #include <linux/wait.h>
14
15 #ifndef HAVE_WAIT_QUEUE_ENTRY
16 #define wait_queue_entry_t wait_queue_t
17 #endif
18
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;
23 };
24
25 #define ___wait_is_interruptible(state)                                         \
26         (!__builtin_constant_p(state) ||                                        \
27                 state == TASK_INTERRUPTIBLE || state == TASK_KILLABLE)          \
28
29 #endif /* ! HAVE_WAIT_BIT_HEADER_H */
30
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);
34 #endif
35
36 /* ___wait_cond_timeout changed number of args in v3.12-rc1-78-g35a2af94c7ce
37  * so let's define our own ___wait_cond_timeout1
38  */
39
40 #define ___wait_cond_timeout1(condition)                                \
41 ({                                                                      \
42         bool __cond = (condition);                                      \
43         if (__cond && !__ret)                                           \
44                 __ret = 1;                                              \
45         __cond || !__ret;                                               \
46 })
47
48 #ifndef HAVE_CLEAR_AND_WAKE_UP_BIT
49 /**
50  * clear_and_wake_up_bit - clear a bit and wake up anyone waiting on that bit
51  *
52  * @bit: the bit of the word being waited on
53  * @word: the word being waited on, a kernel virtual address
54  *
55  * You can use this helper if bitflags are manipulated atomically rather than
56  * non-atomically under a lock.
57  */
58 static inline void clear_and_wake_up_bit(int bit, void *word)
59 {
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);
64 }
65 #endif /* ! HAVE_CLEAR_AND_WAKE_UP_BIT */
66
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);
73
74 #define ___wait_var_event(var, condition, state, exclusive, ret, cmd)   \
75 ({                                                                      \
76         __label__ __out;                                                \
77         wait_queue_head_t *__wq_head = __var_waitqueue(var);            \
78         struct wait_bit_queue_entry __wbq_entry;                        \
79         long __ret = ret; /* explicit shadow */                         \
80                                                                         \
81         init_wait_var_entry(&__wbq_entry, var,                          \
82                             exclusive ? WQ_FLAG_EXCLUSIVE : 0);         \
83         for (;;) {                                                      \
84                 long __int = prepare_to_wait_event(__wq_head,           \
85                                                    &__wbq_entry.wq_entry, \
86                                                    state);              \
87                 if (condition)                                          \
88                         break;                                          \
89                                                                         \
90                 if (___wait_is_interruptible(state) && __int) {         \
91                         __ret = __int;                                  \
92                         goto __out;                                     \
93                 }                                                       \
94                                                                         \
95                 cmd;                                                    \
96         }                                                               \
97         finish_wait(__wq_head, &__wbq_entry.wq_entry);                  \
98 __out:  __ret;                                                          \
99 })
100
101 #define __wait_var_event(var, condition)                                \
102         ___wait_var_event(var, condition, TASK_UNINTERRUPTIBLE, 0, 0,   \
103                           schedule())
104
105 #define wait_var_event(var, condition)                                  \
106 do {                                                                    \
107         might_sleep();                                                  \
108         if (condition)                                                  \
109                 break;                                                  \
110         __wait_var_event(var, condition);                               \
111 } while (0)
112
113 #define __wait_var_event_killable(var, condition)                       \
114         ___wait_var_event(var, condition, TASK_KILLABLE, 0, 0,          \
115                           schedule())
116
117 #define wait_var_event_killable(var, condition)                         \
118 ({                                                                      \
119         int __ret = 0;                                                  \
120         might_sleep();                                                  \
121         if (!(condition))                                               \
122                 __ret = __wait_var_event_killable(var, condition);      \
123         __ret;                                                          \
124 })
125
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))
130
131 #define wait_var_event_timeout(var, condition, timeout)                 \
132 ({                                                                      \
133         long __ret = timeout;                                           \
134         might_sleep();                                                  \
135         if (!___wait_cond_timeout1(condition))                          \
136                 __ret = __wait_var_event_timeout(var, condition, timeout); \
137         __ret;                                                          \
138 })
139 #endif /* ! HAVE_WAIT_VAR_EVENT */
140
141 /*
142  * prepare_to_wait_event() does not support an exclusive
143  * lifo wait.
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.
147  */
148 static inline void prepare_to_wait_exclusive_head(
149         wait_queue_head_t *waitq, wait_queue_entry_t *link)
150 {
151         unsigned long flags;
152
153         spin_lock_irqsave(&(waitq->lock), flags);
154 #ifdef HAVE_WAIT_QUEUE_ENTRY_LIST
155         if (list_empty(&link->entry))
156 #else
157         if (list_empty(&link->task_list))
158 #endif
159                 __add_wait_queue_exclusive(waitq, link);
160         spin_unlock_irqrestore(&((waitq)->lock), flags);
161 }
162
163 #ifndef ___wait_event
164 /*
165  * The below macro ___wait_event() has an explicit shadow of the __ret
166  * variable when used from the wait_event_*() macros.
167  *
168  * This is so that both can use the ___wait_cond_timeout1() construct
169  * to wrap the condition.
170  *
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
173  * otherwise.
174  */
175
176 #define ___wait_event(wq_head, condition, state, exclusive, ret, cmd)   \
177 ({                                                                      \
178         __label__ __out;                                                \
179         wait_queue_entry_ __wq_entry;                                   \
180         long __ret = ret;       /* explicit shadow */                   \
181                                                                         \
182         init_wait(&__wq_entry);                                         \
183         if (exclusive)                                                  \
184                 __wq_entry.flags = WQ_FLAG_EXCLUSIVE                    \
185         for (;;) {                                                      \
186                 long __int = prepare_to_wait_event(&wq_head,            \
187                                                   &__wq_entry, state);  \
188                                                                         \
189                 if (condition)                                          \
190                         break;                                          \
191                                                                         \
192                 if (___wait_is_interruptible(state) && __int) {         \
193                         __ret = __int;                                  \
194                         goto __out;                                     \
195                 }                                                       \
196                                                                         \
197                 cmd;                                                    \
198         }                                                               \
199         finish_wait(&wq_head, &__wq_entry);                             \
200 __out:  __ret;                                                          \
201 })
202 #endif
203
204 #ifndef TASK_NOLOAD
205
206 #define ___wait_event_idle(wq_head, condition, exclusive, ret, cmd)     \
207 ({                                                                      \
208         wait_queue_entry_t __wq_entry;                                  \
209         unsigned long flags;                                            \
210         long __ret = ret;       /* explicit shadow */                   \
211         sigset_t __blocked;                                             \
212                                                                         \
213         __blocked = cfs_block_sigsinv(0);                               \
214         init_wait(&__wq_entry);                                         \
215         if (exclusive)                                                  \
216                 __wq_entry.flags = WQ_FLAG_EXCLUSIVE;                   \
217         for (;;) {                                                      \
218                 prepare_to_wait_event(&wq_head,                         \
219                                    &__wq_entry,                         \
220                                    TASK_INTERRUPTIBLE);                 \
221                                                                         \
222                 if (condition)                                          \
223                         break;                                          \
224                 /* See justification in __l_wait_event */               \
225                 if (signal_pending(current)) {                          \
226                         spin_lock_irqsave(&current->sighand->siglock,   \
227                                           flags);                       \
228                         clear_tsk_thread_flag(current, TIF_SIGPENDING); \
229                         spin_unlock_irqrestore(&current->sighand->siglock,\
230                                                flags);                  \
231                 }                                                       \
232                 cmd;                                                    \
233         }                                                               \
234         finish_wait(&wq_head, &__wq_entry);                             \
235         cfs_restore_sigs(__blocked);                                    \
236         __ret;                                                          \
237 })
238
239 #define wait_event_idle(wq_head, condition)                             \
240 do {                                                                    \
241         might_sleep();                                                  \
242         if (!(condition))                                               \
243                 ___wait_event_idle(wq_head, condition, 0, 0, schedule());\
244 } while (0)
245
246 #define wait_event_idle_exclusive(wq_head, condition)                   \
247 do {                                                                    \
248         might_sleep();                                                  \
249         if (!(condition))                                               \
250                 ___wait_event_idle(wq_head, condition, 1, 0, schedule());\
251 } while (0)
252
253 #define __wait_event_idle_exclusive_timeout(wq_head, condition, timeout)\
254         ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition),   \
255                            1, timeout,                                  \
256                            __ret = schedule_timeout(__ret))
257
258 #define wait_event_idle_exclusive_timeout(wq_head, condition, timeout)  \
259 ({                                                                      \
260         long __ret = timeout;                                           \
261         might_sleep();                                                  \
262         if (!___wait_cond_timeout1(condition))                          \
263                 __ret = __wait_event_idle_exclusive_timeout(            \
264                         wq_head, condition, timeout);                   \
265         __ret;                                                          \
266 })
267
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),   \
271                            1, timeout,                                  \
272                            cmd1; __ret = schedule_timeout(__ret); cmd2)
273
274 #define wait_event_idle_exclusive_timeout_cmd(wq_head, condition, timeout,\
275                                               cmd1, cmd2)               \
276 ({                                                                      \
277         long __ret = timeout;                                           \
278         might_sleep();                                                  \
279         if (!___wait_cond_timeout1(condition))                          \
280                 __ret = __wait_event_idle_exclusive_timeout_cmd(        \
281                         wq_head, condition, timeout, cmd1, cmd2);       \
282         __ret;                                                          \
283 })
284
285 #define __wait_event_idle_timeout(wq_head, condition, timeout)          \
286         ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition),   \
287                            0, timeout,                                  \
288                            __ret = schedule_timeout(__ret))
289
290 #define wait_event_idle_timeout(wq_head, condition, timeout)            \
291 ({                                                                      \
292         long __ret = timeout;                                           \
293         might_sleep();                                                  \
294         if (!___wait_cond_timeout1(condition))                          \
295                 __ret = __wait_event_idle_timeout(wq_head, condition,   \
296                                                   timeout);             \
297         __ret;                                                          \
298 })
299
300 #else /* TASK_IDLE */
301 #ifndef wait_event_idle
302 /**
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
306  *
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.
310  *
311  * wake_up() has to be called after changing any variable that could
312  * change the result of the wait condition.
313  *
314  */
315 #define wait_event_idle(wq_head, condition)                             \
316 do {                                                                    \
317         might_sleep();                                                  \
318         if (!(condition))                                               \
319                 ___wait_event(wq_head, condition, TASK_IDLE, 0, 0,      \
320                               schedule());                              \
321 } while (0)
322 #endif
323 #ifndef wait_event_idle_exclusive
324 /**
325  * wait_event_idle_exclusive - wait for a condition without contributing to
326  *               system load
327  * @wq_head: the waitqueue to wait on
328  * @condition: a C expression for the event to wait for
329  *
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.
333  *
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.
337  *
338  * wake_up() has to be called after changing any variable that could
339  * change the result of the wait condition.
340  *
341  */
342 #define wait_event_idle_exclusive(wq_head, condition)                   \
343 do {                                                                    \
344         might_sleep();                                                  \
345         if (!(condition))                                               \
346                 ___wait_event(wq_head, condition, TASK_IDLE, 1, 0,      \
347                               schedule());                              \
348 } while (0)
349 #endif
350 #ifndef wait_event_idle_exclusive_timeout
351 /**
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
357  *
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.
361  *
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.
365  *
366  * wake_up() has to be called after changing any variable that could
367  * change the result of the wait condition.
368  *
369  * Returns:
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.
374  */
375 #define wait_event_idle_exclusive_timeout(wq_head, condition, timeout)  \
376 ({                                                                      \
377         long __ret = timeout;                                           \
378         might_sleep();                                                  \
379         if (!___wait_cond_timeout1(condition))                          \
380                 __ret = __wait_event_idle_exclusive_timeout(wq_head,    \
381                                                             condition,  \
382                                                             timeout);   \
383         __ret;                                                          \
384 })
385 #endif
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)
392
393 #define wait_event_idle_exclusive_timeout_cmd(wq_head, condition, timeout,\
394                                               cmd1, cmd2)               \
395 ({                                                                      \
396         long __ret = timeout;                                           \
397         might_sleep();                                                  \
398         if (!___wait_cond_timeout1(condition))                          \
399                 __ret = __wait_event_idle_exclusive_timeout_cmd(        \
400                         wq_head, condition, timeout, cmd1, cmd2);       \
401         __ret;                                                          \
402 })
403 #endif
404
405 #ifndef wait_event_idle_timeout
406
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))
411
412 /**
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
418  *
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.
422  *
423  * wake_up() has to be called after changing any variable that could
424  * change the result of the wait condition.
425  *
426  * Returns:
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.
431  */
432 #define wait_event_idle_timeout(wq_head, condition, timeout)            \
433 ({                                                                      \
434         long __ret = timeout;                                           \
435         might_sleep();                                                  \
436         if (!___wait_cond_timeout1(condition))                          \
437                 __ret = __wait_event_idle_timeout(wq_head, condition,   \
438                                                   timeout);             \
439         __ret;                                                          \
440 })
441 #endif
442 #endif /* TASK_IDLE */
443
444 /* ___wait_event_lifo is used for lifo exclusive 'idle' waits */
445 #ifdef TASK_NOLOAD
446
447 #define ___wait_event_lifo(wq_head, condition, ret, cmd)                \
448 ({                                                                      \
449         wait_queue_entry_t       __wq_entry;                            \
450         long __ret = ret;       /* explicit shadow */                   \
451                                                                         \
452         init_wait(&__wq_entry);                                         \
453         __wq_entry.flags =  WQ_FLAG_EXCLUSIVE;                          \
454         for (;;) {                                                      \
455                 prepare_to_wait_exclusive_head(&wq_head, &__wq_entry);  \
456                 prepare_to_wait_event(&wq_head, &__wq_entry, TASK_IDLE);\
457                                                                         \
458                 if (condition)                                          \
459                         break;                                          \
460                                                                         \
461                 cmd;                                                    \
462         }                                                               \
463         finish_wait(&wq_head, &__wq_entry);                             \
464         __ret;                                                          \
465 })
466 #else
467 #define ___wait_event_lifo(wq_head, condition, ret, cmd)                \
468 ({                                                                      \
469         wait_queue_entry_t __wq_entry;                                  \
470         unsigned long flags;                                            \
471         long __ret = ret;       /* explicit shadow */                   \
472         sigset_t __blocked;                                             \
473                                                                         \
474         __blocked = cfs_block_sigsinv(0);                               \
475         init_wait(&__wq_entry);                                         \
476         __wq_entry.flags = WQ_FLAG_EXCLUSIVE;                           \
477         for (;;) {                                                      \
478                 prepare_to_wait_exclusive_head(&wq_head, &__wq_entry);  \
479                 prepare_to_wait_event(&wq_head, &__wq_entry,            \
480                                       TASK_INTERRUPTIBLE);              \
481                                                                         \
482                 if (condition)                                          \
483                         break;                                          \
484                 /* See justification in __l_wait_event */               \
485                 if (signal_pending(current)) {                          \
486                         spin_lock_irqsave(&current->sighand->siglock,   \
487                                           flags);                       \
488                         clear_tsk_thread_flag(current, TIF_SIGPENDING); \
489                         spin_unlock_irqrestore(&current->sighand->siglock,\
490                                                flags);                  \
491                 }                                                       \
492                 cmd;                                                    \
493         }                                                               \
494         cfs_restore_sigs(__blocked);                                    \
495         finish_wait(&wq_head, &__wq_entry);                             \
496         __ret;                                                          \
497 })
498 #endif
499
500 #define wait_event_idle_exclusive_lifo(wq_head, condition)              \
501 do {                                                                    \
502         might_sleep();                                                  \
503         if (!(condition))                                               \
504                 ___wait_event_lifo(wq_head, condition, 0, schedule());  \
505 } while (0)
506
507 #define __wait_event_idle_lifo_timeout(wq_head, condition, timeout)     \
508         ___wait_event_lifo(wq_head, ___wait_cond_timeout1(condition),   \
509                            timeout,                                     \
510                            __ret = schedule_timeout(__ret))
511
512 #define wait_event_idle_exclusive_lifo_timeout(wq_head, condition, timeout)\
513 ({                                                                      \
514         long __ret = timeout;                                           \
515         might_sleep();                                                  \
516         if (!___wait_cond_timeout1(condition))                          \
517                 __ret = __wait_event_idle_lifo_timeout(wq_head,         \
518                                                        condition,       \
519                                                        timeout);        \
520         __ret;                                                          \
521 })
522
523 /* l_wait_event_abortable() is a bit like wait_event_killable()
524  * except there is a fixed set of signals which will abort:
525  * LUSTRE_FATAL_SIGS
526  */
527 #define LUSTRE_FATAL_SIGS                                        \
528         (sigmask(SIGKILL) | sigmask(SIGINT) | sigmask(SIGTERM) | \
529          sigmask(SIGQUIT) | sigmask(SIGALRM))
530
531 #define l_wait_event_abortable(wq, condition)                           \
532 ({                                                                      \
533         sigset_t __new_blocked, __old_blocked;                          \
534         int __ret = 0;                                                  \
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);                 \
539         __ret;                                                          \
540 })
541
542 #define l_wait_event_abortable_timeout(wq, condition, timeout)          \
543 ({                                                                      \
544         sigset_t __new_blocked, __old_blocked;                          \
545         int __ret = 0;                                                  \
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);                 \
550         __ret;                                                          \
551 })
552
553 #define l_wait_event_abortable_exclusive(wq, condition)                 \
554 ({                                                                      \
555         sigset_t __new_blocked, __old_blocked;                          \
556         int __ret = 0;                                                  \
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);                 \
561         __ret;                                                          \
562 })
563
564 #endif /* __LICBFS_LINUX_WAIT_BIT_H */