1 /* 2 * Copyright (c) 2014 Imre Vadász 3 * Copyright (c) 2014-2020 François Tigeot <ftigeot@wolfpond.org> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice unmodified, this list of conditions, and the following 11 * disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef _LINUX_WAIT_H_ 29 #define _LINUX_WAIT_H_ 30 31 #include <linux/list.h> 32 #include <linux/stddef.h> 33 #include <linux/spinlock.h> 34 #include <asm/current.h> 35 36 typedef struct __wait_queue wait_queue_t; 37 38 typedef int (*wait_queue_func_t)(wait_queue_t *wait, unsigned mode, int flags, void *key); 39 40 int default_wake_function(wait_queue_t *wait, unsigned mode, int flags, void *key); 41 int autoremove_wake_function(wait_queue_t *wait, unsigned mode, int sync, void *key); 42 43 struct __wait_queue { 44 unsigned int flags; 45 void *private; 46 wait_queue_func_t func; 47 struct list_head task_list; 48 }; 49 50 typedef struct { 51 struct lock lock; 52 struct list_head task_list; 53 } wait_queue_head_t; 54 55 static inline void 56 init_waitqueue_head(wait_queue_head_t *eq) 57 { 58 lockinit(&eq->lock, "lwq", 0, LK_CANRECURSE); 59 INIT_LIST_HEAD(&eq->task_list); 60 } 61 62 void __wake_up_core(wait_queue_head_t *q, int num_to_wake_up); 63 64 static inline void 65 wake_up(wait_queue_head_t *q) 66 { 67 lockmgr(&q->lock, LK_EXCLUSIVE); 68 __wake_up_core(q, 1); 69 lockmgr(&q->lock, LK_RELEASE); 70 wakeup_one(q); 71 } 72 73 static inline void 74 wake_up_all(wait_queue_head_t *q) 75 { 76 lockmgr(&q->lock, LK_EXCLUSIVE); 77 __wake_up_core(q, 0); 78 lockmgr(&q->lock, LK_RELEASE); 79 wakeup(q); 80 } 81 82 void wake_up_bit(void *, int); 83 84 #define wake_up_all_locked(eq) __wake_up_core(eq, 0) 85 86 #define wake_up_interruptible(eq) wake_up(eq) 87 #define wake_up_interruptible_all(eq) wake_up_all(eq) 88 89 void __wait_event_prefix(wait_queue_head_t *wq, int flags); 90 void prepare_to_wait(wait_queue_head_t *q, wait_queue_t *wait, int state); 91 void finish_wait(wait_queue_head_t *q, wait_queue_t *wait); 92 93 /* 94 * wait_event_interruptible_timeout: 95 * - The process is put to sleep until the condition evaluates to true. 96 * - The condition is checked each time the waitqueue wq is woken up. 97 * - wake_up has to be called after changing any variable that could change 98 * the result of the wait condition. 99 * 100 * returns: 101 * - 0 if the timeout elapsed 102 * - the remaining jiffies if the condition evaluated to true before 103 * the timeout elapsed. 104 * - remaining jiffies are always at least 1 105 * - -ERESTARTSYS if interrupted by a signal (when PCATCH is set in flags) 106 */ 107 #define __wait_event_common(wq, condition, timeout_jiffies, flags, \ 108 locked) \ 109 ({ \ 110 int start_jiffies, elapsed_jiffies, remaining_jiffies, ret; \ 111 bool timeout_expired = false; \ 112 bool interrupted = false; \ 113 long retval; \ 114 wait_queue_t tmp_wq; \ 115 \ 116 start_jiffies = ticks; \ 117 INIT_LIST_HEAD(&tmp_wq.task_list); \ 118 \ 119 while (1) { \ 120 __wait_event_prefix(&wq, flags); \ 121 \ 122 if (condition) \ 123 break; \ 124 \ 125 ret = tsleep(&wq, flags, "lwe", timeout_jiffies); \ 126 if (ret == EINTR || ret == ERESTART) { \ 127 interrupted = true; \ 128 break; \ 129 } \ 130 if (ret == EWOULDBLOCK) { \ 131 timeout_expired = true; \ 132 break; \ 133 } \ 134 } \ 135 \ 136 elapsed_jiffies = ticks - start_jiffies; \ 137 remaining_jiffies = timeout_jiffies - elapsed_jiffies; \ 138 if (remaining_jiffies <= 0) \ 139 remaining_jiffies = 1; \ 140 \ 141 if (timeout_expired) \ 142 retval = 0; \ 143 else if (interrupted) \ 144 retval = -ERESTARTSYS; \ 145 else if (timeout_jiffies > 0) \ 146 retval = remaining_jiffies; \ 147 else \ 148 retval = 1; \ 149 \ 150 finish_wait(&wq, &tmp_wq); \ 151 retval; \ 152 }) 153 154 #define wait_event(wq, condition) \ 155 __wait_event_common(wq, condition, 0, 0, false) 156 157 #define wait_event_timeout(wq, condition, timeout) \ 158 __wait_event_common(wq, condition, timeout, 0, false) 159 160 #define wait_event_interruptible(wq, condition) \ 161 ({ \ 162 long retval; \ 163 \ 164 retval = __wait_event_common(wq, condition, 0, PCATCH, false); \ 165 if (retval != -ERESTARTSYS) \ 166 retval = 0; \ 167 retval; \ 168 }) 169 170 #define wait_event_interruptible_locked(wq, condition) \ 171 ({ \ 172 long retval; \ 173 \ 174 retval = __wait_event_common(wq, condition, 0, PCATCH, true); \ 175 if (retval != -ERESTARTSYS) \ 176 retval = 0; \ 177 retval; \ 178 }) 179 180 #define wait_event_interruptible_timeout(wq, condition, timeout) \ 181 __wait_event_common(wq, condition, timeout, PCATCH, false) 182 183 static inline int 184 waitqueue_active(wait_queue_head_t *q) 185 { 186 return !list_empty(&q->task_list); 187 } 188 189 #define DEFINE_WAIT(name) \ 190 wait_queue_t name = { \ 191 .private = current, \ 192 .task_list = LIST_HEAD_INIT((name).task_list), \ 193 .func = autoremove_wake_function, \ 194 } 195 196 static inline void 197 __add_wait_queue(wait_queue_head_t *head, wait_queue_t *new) 198 { 199 list_add(&new->task_list, &head->task_list); 200 } 201 202 static inline void 203 add_wait_queue(wait_queue_head_t *head, wait_queue_t *wq) 204 { 205 lockmgr(&head->lock, LK_EXCLUSIVE); 206 __add_wait_queue(head, wq); 207 lockmgr(&head->lock, LK_RELEASE); 208 } 209 210 #define DECLARE_WAIT_QUEUE_HEAD(name) \ 211 wait_queue_head_t name = { \ 212 .lock = LOCK_INITIALIZER("name", 0, LK_CANRECURSE), \ 213 .task_list = { &(name).task_list, &(name).task_list } \ 214 } 215 216 static inline void 217 __remove_wait_queue(wait_queue_head_t *head, wait_queue_t *old) 218 { 219 list_del(&old->task_list); 220 } 221 222 static inline void 223 remove_wait_queue(wait_queue_head_t *head, wait_queue_t *wq) 224 { 225 lockmgr(&head->lock, LK_EXCLUSIVE); 226 __remove_wait_queue(head, wq); 227 lockmgr(&head->lock, LK_RELEASE); 228 } 229 230 static inline void 231 __add_wait_queue_tail(wait_queue_head_t *wqh, wait_queue_t *wq) 232 { 233 list_add_tail(&wq->task_list, &wqh->task_list); 234 } 235 236 int wait_on_bit_timeout(unsigned long *word, int bit, 237 unsigned mode, unsigned long timeout); 238 239 #endif /* _LINUX_WAIT_H_ */ 240