Whamcloud - gitweb
8fac3db8131a059d436d5db84fcaaf2244f7d9b7
[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                 /* We have to do this here because some signals */      \
225                 /* are not blockable - ie from strace(1).       */      \
226                 /* In these cases we want to schedule_timeout() */      \
227                 /* again, because we don't want that to return  */      \
228                 /* -EINTR when the RPC actually succeeded.      */      \
229                 /* the recalc_sigpending() below will deliver the */    \
230                 /* signal properly.                             */      \
231                 if (signal_pending(current)) {                          \
232                         spin_lock_irqsave(&current->sighand->siglock,   \
233                                           flags);                       \
234                         clear_tsk_thread_flag(current, TIF_SIGPENDING); \
235                         spin_unlock_irqrestore(&current->sighand->siglock,\
236                                                flags);                  \
237                 }                                                       \
238                 cmd;                                                    \
239         }                                                               \
240         finish_wait(&wq_head, &__wq_entry);                             \
241         cfs_restore_sigs(__blocked);                                    \
242         __ret;                                                          \
243 })
244
245 #define wait_event_idle(wq_head, condition)                             \
246 do {                                                                    \
247         might_sleep();                                                  \
248         if (!(condition))                                               \
249                 ___wait_event_idle(wq_head, condition, 0, 0, schedule());\
250 } while (0)
251
252 #define wait_event_idle_exclusive(wq_head, condition)                   \
253 do {                                                                    \
254         might_sleep();                                                  \
255         if (!(condition))                                               \
256                 ___wait_event_idle(wq_head, condition, 1, 0, schedule());\
257 } while (0)
258
259 #define __wait_event_idle_exclusive_timeout(wq_head, condition, timeout)\
260         ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition),   \
261                            1, timeout,                                  \
262                            __ret = schedule_timeout(__ret))
263
264 #define wait_event_idle_exclusive_timeout(wq_head, condition, timeout)  \
265 ({                                                                      \
266         long __ret = timeout;                                           \
267         might_sleep();                                                  \
268         if (!___wait_cond_timeout1(condition))                          \
269                 __ret = __wait_event_idle_exclusive_timeout(            \
270                         wq_head, condition, timeout);                   \
271         __ret;                                                          \
272 })
273
274 #define __wait_event_idle_exclusive_timeout_cmd(wq_head, condition,     \
275                                                 timeout, cmd1, cmd2)    \
276         ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition),   \
277                            1, timeout,                                  \
278                            cmd1; __ret = schedule_timeout(__ret); cmd2)
279
280 #define wait_event_idle_exclusive_timeout_cmd(wq_head, condition, timeout,\
281                                               cmd1, cmd2)               \
282 ({                                                                      \
283         long __ret = timeout;                                           \
284         might_sleep();                                                  \
285         if (!___wait_cond_timeout1(condition))                          \
286                 __ret = __wait_event_idle_exclusive_timeout_cmd(        \
287                         wq_head, condition, timeout, cmd1, cmd2);       \
288         __ret;                                                          \
289 })
290
291 #define __wait_event_idle_timeout(wq_head, condition, timeout)          \
292         ___wait_event_idle(wq_head, ___wait_cond_timeout1(condition),   \
293                            0, timeout,                                  \
294                            __ret = schedule_timeout(__ret))
295
296 #define wait_event_idle_timeout(wq_head, condition, timeout)            \
297 ({                                                                      \
298         long __ret = timeout;                                           \
299         might_sleep();                                                  \
300         if (!___wait_cond_timeout1(condition))                          \
301                 __ret = __wait_event_idle_timeout(wq_head, condition,   \
302                                                   timeout);             \
303         __ret;                                                          \
304 })
305
306 #else /* TASK_IDLE */
307 #ifndef wait_event_idle
308 /**
309  * wait_event_idle - wait for a condition without contributing to system load
310  * @wq_head: the waitqueue to wait on
311  * @condition: a C expression for the event to wait for
312  *
313  * The process is put to sleep (TASK_IDLE) until the
314  * @condition evaluates to true.
315  * The @condition is checked each time the waitqueue @wq_head is woken up.
316  *
317  * wake_up() has to be called after changing any variable that could
318  * change the result of the wait condition.
319  *
320  */
321 #define wait_event_idle(wq_head, condition)                             \
322 do {                                                                    \
323         might_sleep();                                                  \
324         if (!(condition))                                               \
325                 ___wait_event(wq_head, condition, TASK_IDLE, 0, 0,      \
326                               schedule());                              \
327 } while (0)
328 #endif
329 #ifndef wait_event_idle_exclusive
330 /**
331  * wait_event_idle_exclusive - wait for a condition without contributing to
332  *               system load
333  * @wq_head: the waitqueue to wait on
334  * @condition: a C expression for the event to wait for
335  *
336  * The process is put to sleep (TASK_IDLE) until the
337  * @condition evaluates to true.
338  * The @condition is checked each time the waitqueue @wq_head is woken up.
339  *
340  * The process is put on the wait queue with an WQ_FLAG_EXCLUSIVE flag
341  * set thus if other processes wait on the same list, when this
342  * process is woken further processes are not considered.
343  *
344  * wake_up() has to be called after changing any variable that could
345  * change the result of the wait condition.
346  *
347  */
348 #define wait_event_idle_exclusive(wq_head, condition)                   \
349 do {                                                                    \
350         might_sleep();                                                  \
351         if (!(condition))                                               \
352                 ___wait_event(wq_head, condition, TASK_IDLE, 1, 0,      \
353                               schedule());                              \
354 } while (0)
355 #endif
356 #ifndef wait_event_idle_exclusive_timeout
357 /**
358  * wait_event_idle_exclusive_timeout - sleep without load until a condition
359  *                       becomes true or a timeout elapses
360  * @wq_head: the waitqueue to wait on
361  * @condition: a C expression for the event to wait for
362  * @timeout: timeout, in jiffies
363  *
364  * The process is put to sleep (TASK_IDLE) until the
365  * @condition evaluates to true. The @condition is checked each time
366  * the waitqueue @wq_head is woken up.
367  *
368  * The process is put on the wait queue with an WQ_FLAG_EXCLUSIVE flag
369  * set thus if other processes wait on the same list, when this
370  * process is woken further processes are not considered.
371  *
372  * wake_up() has to be called after changing any variable that could
373  * change the result of the wait condition.
374  *
375  * Returns:
376  * 0 if the @condition evaluated to %false after the @timeout elapsed,
377  * 1 if the @condition evaluated to %true after the @timeout elapsed,
378  * or the remaining jiffies (at least 1) if the @condition evaluated
379  * to %true before the @timeout elapsed.
380  */
381 #define wait_event_idle_exclusive_timeout(wq_head, condition, timeout)  \
382 ({                                                                      \
383         long __ret = timeout;                                           \
384         might_sleep();                                                  \
385         if (!___wait_cond_timeout1(condition))                          \
386                 __ret = __wait_event_idle_exclusive_timeout(wq_head,    \
387                                                             condition,  \
388                                                             timeout);   \
389         __ret;                                                          \
390 })
391 #endif
392 #ifndef wait_event_idle_exclusive_timeout_cmd
393 #define __wait_event_idle_exclusive_timeout_cmd(wq_head, condition,     \
394                                                 timeout, cmd1, cmd2)    \
395         ___wait_event(wq_head, ___wait_cond_timeout1(condition),        \
396                       TASK_IDLE, 1, timeout,                            \
397                       cmd1; __ret = schedule_timeout(__ret); cmd2)
398
399 #define wait_event_idle_exclusive_timeout_cmd(wq_head, condition, timeout,\
400                                               cmd1, cmd2)               \
401 ({                                                                      \
402         long __ret = timeout;                                           \
403         might_sleep();                                                  \
404         if (!___wait_cond_timeout1(condition))                          \
405                 __ret = __wait_event_idle_exclusive_timeout_cmd(        \
406                         wq_head, condition, timeout, cmd1, cmd2);       \
407         __ret;                                                          \
408 })
409 #endif
410
411 #ifndef wait_event_idle_timeout
412
413 #define __wait_event_idle_timeout(wq_head, condition, timeout)          \
414         ___wait_event(wq_head, ___wait_cond_timeout1(condition),        \
415                       TASK_IDLE, 0, timeout,                            \
416                       __ret = schedule_timeout(__ret))
417
418 /**
419  * wait_event_idle_timeout - sleep without load until a condition becomes
420  *                           true or a timeout elapses
421  * @wq_head: the waitqueue to wait on
422  * @condition: a C expression for the event to wait for
423  * @timeout: timeout, in jiffies
424  *
425  * The process is put to sleep (TASK_IDLE) until the
426  * @condition evaluates to true. The @condition is checked each time
427  * the waitqueue @wq_head is woken up.
428  *
429  * wake_up() has to be called after changing any variable that could
430  * change the result of the wait condition.
431  *
432  * Returns:
433  * 0 if the @condition evaluated to %false after the @timeout elapsed,
434  * 1 if the @condition evaluated to %true after the @timeout elapsed,
435  * or the remaining jiffies (at least 1) if the @condition evaluated
436  * to %true before the @timeout elapsed.
437  */
438 #define wait_event_idle_timeout(wq_head, condition, timeout)            \
439 ({                                                                      \
440         long __ret = timeout;                                           \
441         might_sleep();                                                  \
442         if (!___wait_cond_timeout1(condition))                          \
443                 __ret = __wait_event_idle_timeout(wq_head, condition,   \
444                                                   timeout);             \
445         __ret;                                                          \
446 })
447 #endif
448 #endif /* TASK_IDLE */
449
450 /* ___wait_event_lifo is used for lifo exclusive 'idle' waits */
451 #ifdef TASK_NOLOAD
452
453 #define ___wait_event_lifo(wq_head, condition, ret, cmd)                \
454 ({                                                                      \
455         wait_queue_entry_t       __wq_entry;                            \
456         long __ret = ret;       /* explicit shadow */                   \
457                                                                         \
458         init_wait(&__wq_entry);                                         \
459         __wq_entry.flags =  WQ_FLAG_EXCLUSIVE;                          \
460         for (;;) {                                                      \
461                 prepare_to_wait_exclusive_head(&wq_head, &__wq_entry);  \
462                 prepare_to_wait_event(&wq_head, &__wq_entry, TASK_IDLE);\
463                                                                         \
464                 if (condition)                                          \
465                         break;                                          \
466                                                                         \
467                 cmd;                                                    \
468         }                                                               \
469         finish_wait(&wq_head, &__wq_entry);                             \
470         __ret;                                                          \
471 })
472 #else
473 #define ___wait_event_lifo(wq_head, condition, ret, cmd)                \
474 ({                                                                      \
475         wait_queue_entry_t __wq_entry;                                  \
476         unsigned long flags;                                            \
477         long __ret = ret;       /* explicit shadow */                   \
478         sigset_t __blocked;                                             \
479                                                                         \
480         __blocked = cfs_block_sigsinv(0);                               \
481         init_wait(&__wq_entry);                                         \
482         __wq_entry.flags = WQ_FLAG_EXCLUSIVE;                           \
483         for (;;) {                                                      \
484                 prepare_to_wait_exclusive_head(&wq_head, &__wq_entry);  \
485                 prepare_to_wait_event(&wq_head, &__wq_entry,            \
486                                       TASK_INTERRUPTIBLE);              \
487                                                                         \
488                 if (condition)                                          \
489                         break;                                          \
490                 /* See justification in ___wait_event_idle */           \
491                 if (signal_pending(current)) {                          \
492                         spin_lock_irqsave(&current->sighand->siglock,   \
493                                           flags);                       \
494                         clear_tsk_thread_flag(current, TIF_SIGPENDING); \
495                         spin_unlock_irqrestore(&current->sighand->siglock,\
496                                                flags);                  \
497                 }                                                       \
498                 cmd;                                                    \
499         }                                                               \
500         cfs_restore_sigs(__blocked);                                    \
501         finish_wait(&wq_head, &__wq_entry);                             \
502         __ret;                                                          \
503 })
504 #endif
505
506 #define wait_event_idle_exclusive_lifo(wq_head, condition)              \
507 do {                                                                    \
508         might_sleep();                                                  \
509         if (!(condition))                                               \
510                 ___wait_event_lifo(wq_head, condition, 0, schedule());  \
511 } while (0)
512
513 #define __wait_event_idle_lifo_timeout(wq_head, condition, timeout)     \
514         ___wait_event_lifo(wq_head, ___wait_cond_timeout1(condition),   \
515                            timeout,                                     \
516                            __ret = schedule_timeout(__ret))
517
518 #define wait_event_idle_exclusive_lifo_timeout(wq_head, condition, timeout)\
519 ({                                                                      \
520         long __ret = timeout;                                           \
521         might_sleep();                                                  \
522         if (!___wait_cond_timeout1(condition))                          \
523                 __ret = __wait_event_idle_lifo_timeout(wq_head,         \
524                                                        condition,       \
525                                                        timeout);        \
526         __ret;                                                          \
527 })
528
529 /* l_wait_event_abortable() is a bit like wait_event_killable()
530  * except there is a fixed set of signals which will abort:
531  * LUSTRE_FATAL_SIGS
532  */
533 #define LUSTRE_FATAL_SIGS                                        \
534         (sigmask(SIGKILL) | sigmask(SIGINT) | sigmask(SIGTERM) | \
535          sigmask(SIGQUIT) | sigmask(SIGALRM))
536
537 #define l_wait_event_abortable(wq, condition)                           \
538 ({                                                                      \
539         sigset_t __new_blocked, __old_blocked;                          \
540         int __ret = 0;                                                  \
541         siginitsetinv(&__new_blocked, LUSTRE_FATAL_SIGS);               \
542         sigprocmask(SIG_BLOCK, &__new_blocked, &__old_blocked);         \
543         __ret = wait_event_interruptible(wq, condition);                \
544         sigprocmask(SIG_SETMASK, &__old_blocked, NULL);                 \
545         __ret;                                                          \
546 })
547
548 #define l_wait_event_abortable_timeout(wq, condition, timeout)          \
549 ({                                                                      \
550         sigset_t __new_blocked, __old_blocked;                          \
551         int __ret = 0;                                                  \
552         siginitsetinv(&__new_blocked, LUSTRE_FATAL_SIGS);               \
553         sigprocmask(SIG_BLOCK, &__new_blocked, &__old_blocked);         \
554         __ret = wait_event_interruptible_timeout(wq, condition, timeout);\
555         sigprocmask(SIG_SETMASK, &__old_blocked, NULL);                 \
556         __ret;                                                          \
557 })
558
559 #define l_wait_event_abortable_exclusive(wq, condition)                 \
560 ({                                                                      \
561         sigset_t __new_blocked, __old_blocked;                          \
562         int __ret = 0;                                                  \
563         siginitsetinv(&__new_blocked, LUSTRE_FATAL_SIGS);               \
564         sigprocmask(SIG_BLOCK, &__new_blocked, &__old_blocked);         \
565         __ret = wait_event_interruptible_exclusive(wq, condition);      \
566         sigprocmask(SIG_SETMASK, &__old_blocked, NULL);                 \
567         __ret;                                                          \
568 })
569
570 #endif /* __LICBFS_LINUX_WAIT_BIT_H */