5626292fc462690ac4c372e1a0d53d497f585e0e
[openafs.git] / src / afs / LINUX / osi_sleep.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #include <afsconfig.h>
11 #include "afs/param.h"
12
13 RCSID
14     ("$Header$");
15
16 #include "afs/sysincludes.h"    /* Standard vendor system headers */
17 #include "afsincludes.h"        /* Afs-based standard headers */
18 #include "afs/afs_stats.h"      /* afs statistics */
19
20 #if defined(FREEZER_H_EXISTS)
21 #include <linux/freezer.h>
22 #endif
23
24 static int osi_TimedSleep(char *event, afs_int32 ams, int aintok);
25
26 static char waitV, dummyV;
27
28 void
29 afs_osi_InitWaitHandle(struct afs_osi_WaitHandle *achandle)
30 {
31     AFS_STATCNT(osi_InitWaitHandle);
32     achandle->proc = (caddr_t) 0;
33 }
34
35 /* cancel osi_Wait */
36 void
37 afs_osi_CancelWait(struct afs_osi_WaitHandle *achandle)
38 {
39     caddr_t proc;
40
41     AFS_STATCNT(osi_CancelWait);
42     proc = achandle->proc;
43     if (proc == 0)
44         return;
45     achandle->proc = (caddr_t) 0;       /* so dude can figure out he was signalled */
46     afs_osi_Wakeup(&waitV);
47 }
48
49 /* afs_osi_Wait
50  * Waits for data on ahandle, or ams ms later.  ahandle may be null.
51  * Returns 0 if timeout and EINTR if signalled.
52  */
53 int
54 afs_osi_Wait(afs_int32 ams, struct afs_osi_WaitHandle *ahandle, int aintok)
55 {
56     afs_int32 endTime;
57     int code;
58
59     AFS_STATCNT(osi_Wait);
60     endTime = osi_Time() + (ams / 1000);
61     if (ahandle)
62         ahandle->proc = (caddr_t) current;
63
64     do {
65         AFS_ASSERT_GLOCK();
66         code = osi_TimedSleep(&waitV, ams, 1);
67         if (code)
68             break;
69         if (ahandle && (ahandle->proc == (caddr_t) 0)) {
70             /* we've been signalled */
71             break;
72         }
73     } while (osi_Time() < endTime);
74     return code;
75 }
76
77
78
79
80 typedef struct afs_event {
81     struct afs_event *next;     /* next in hash chain */
82     char *event;                /* lwp event: an address */
83     int refcount;               /* Is it in use? */
84     int seq;                    /* Sequence number: this is incremented
85                                  * by wakeup calls; wait will not return until
86                                  * it changes */
87 #if defined(AFS_LINUX24_ENV)
88     wait_queue_head_t cond;
89 #else
90     struct wait_queue *cond;
91 #endif
92 } afs_event_t;
93
94 #define HASHSIZE 128
95 afs_event_t *afs_evhasht[HASHSIZE];     /* Hash table for events */
96 #define afs_evhash(event)       (afs_uint32) ((((long)event)>>2) & (HASHSIZE-1));
97 int afs_evhashcnt = 0;
98
99 /* Get and initialize event structure corresponding to lwp event (i.e. address)
100  * */
101 static afs_event_t *
102 afs_getevent(char *event)
103 {
104     afs_event_t *evp, *newp = 0;
105     int hashcode;
106
107     AFS_ASSERT_GLOCK();
108     hashcode = afs_evhash(event);
109     evp = afs_evhasht[hashcode];
110     while (evp) {
111         if (evp->event == event) {
112             evp->refcount++;
113             return evp;
114         }
115         if (evp->refcount == 0)
116             newp = evp;
117         evp = evp->next;
118     }
119     if (!newp)
120         return NULL;
121
122     newp->event = event;
123     newp->refcount = 1;
124     return newp;
125 }
126
127 /* afs_addevent -- allocates a new event for the address.  It isn't returned;
128  *     instead, afs_getevent should be called again.  Thus, the real effect of
129  *     this routine is to add another event to the hash bucket for this
130  *     address.
131  *
132  * Locks:
133  *     Called with GLOCK held. However the function might drop
134  *     GLOCK when it calls osi_AllocSmallSpace for allocating
135  *     a new event (In Linux, the allocator drops GLOCK to avoid
136  *     a deadlock).
137  */
138
139 static void
140 afs_addevent(char *event)
141 {
142     int hashcode;
143     afs_event_t *newp;
144
145     AFS_ASSERT_GLOCK();
146     hashcode = afs_evhash(event);
147     newp = osi_linux_alloc(sizeof(afs_event_t), 0);
148     afs_evhashcnt++;
149     newp->next = afs_evhasht[hashcode];
150     afs_evhasht[hashcode] = newp;
151 #if defined(AFS_LINUX24_ENV)
152     init_waitqueue_head(&newp->cond);
153 #else
154     init_waitqueue(&newp->cond);
155 #endif
156     newp->seq = 0;
157     newp->event = &dummyV;      /* Dummy address for new events */
158     newp->refcount = 0;
159 }
160
161 #ifndef set_current_state
162 #define set_current_state(x)            current->state = (x);
163 #endif
164
165 /* Release the specified event */
166 #define relevent(evp) ((evp)->refcount--)
167
168 /* afs_osi_SleepSig
169  *
170  * Waits for an event to be notified, returning early if a signal
171  * is received.  Returns EINTR if signaled, and 0 otherwise.
172  */
173 int
174 afs_osi_SleepSig(void *event)
175 {
176     struct afs_event *evp;
177     int seq, retval;
178 #ifdef DECLARE_WAITQUEUE
179     DECLARE_WAITQUEUE(wait, current);
180 #else
181     struct wait_queue wait = { current, NULL };
182 #endif
183
184     evp = afs_getevent(event);
185     if (!evp) {
186         afs_addevent(event);
187         evp = afs_getevent(event);
188     }
189
190     seq = evp->seq;
191     retval = 0;
192
193     add_wait_queue(&evp->cond, &wait);
194     while (seq == evp->seq) {
195         set_current_state(TASK_INTERRUPTIBLE);
196         AFS_ASSERT_GLOCK();
197         AFS_GUNLOCK();
198         schedule();
199 #ifdef AFS_LINUX26_ENV
200 #ifdef CONFIG_PM
201         if (
202 #ifdef PF_FREEZE
203             current->flags & PF_FREEZE
204 #else
205 #if defined(STRUCT_TASK_STRUCT_HAS_TODO)
206             !current->todo
207 #else
208             test_ti_thread_flag(current->thread_info, TIF_FREEZE)
209 #endif
210 #endif
211             )
212 #ifdef LINUX_REFRIGERATOR_TAKES_PF_FREEZE
213             refrigerator(PF_FREEZE);
214 #else
215             refrigerator();
216 #endif
217 #endif
218 #endif
219         AFS_GLOCK();
220         if (signal_pending(current)) {
221             retval = EINTR;
222             break;
223         }
224     }
225     remove_wait_queue(&evp->cond, &wait);
226     set_current_state(TASK_RUNNING);
227
228     relevent(evp);
229     return retval;
230 }
231
232 /* afs_osi_Sleep -- waits for an event to be notified, ignoring signals.
233  * - NOTE: that on Linux, there are circumstances in which TASK_INTERRUPTIBLE
234  *   can wake up, even if all signals are blocked
235  * - TODO: handle signals correctly by passing an indication back to the
236  *   caller that the wait has been interrupted and the stack should be cleaned
237  *   up preparatory to signal delivery
238  */
239 void
240 afs_osi_Sleep(void *event)
241 {
242     sigset_t saved_set;
243
244     SIG_LOCK(current);
245     saved_set = current->blocked;
246     sigfillset(&current->blocked);
247     RECALC_SIGPENDING(current);
248     SIG_UNLOCK(current);
249
250     afs_osi_SleepSig(event);
251
252     SIG_LOCK(current);
253     current->blocked = saved_set;
254     RECALC_SIGPENDING(current);
255     SIG_UNLOCK(current);
256 }
257
258 /* osi_TimedSleep
259  * 
260  * Arguments:
261  * event - event to sleep on
262  * ams --- max sleep time in milliseconds
263  * aintok - 1 if should sleep interruptibly
264  *
265  * Returns 0 if timeout, EINTR if signalled, and EGAIN if it might
266  * have raced.
267  */
268 static int
269 osi_TimedSleep(char *event, afs_int32 ams, int aintok)
270 {
271     int code = 0;
272     long ticks = (ams * HZ / 1000) + 1;
273     struct afs_event *evp;
274 #ifdef DECLARE_WAITQUEUE
275     DECLARE_WAITQUEUE(wait, current);
276 #else
277     struct wait_queue wait = { current, NULL };
278 #endif
279
280     evp = afs_getevent(event);
281     if (!evp) {
282         afs_addevent(event);
283         evp = afs_getevent(event);
284     }
285
286     add_wait_queue(&evp->cond, &wait);
287     set_current_state(TASK_INTERRUPTIBLE);
288     /* always sleep TASK_INTERRUPTIBLE to keep load average
289      * from artifically increasing. */
290     AFS_GUNLOCK();
291
292     if (aintok) {
293         if (schedule_timeout(ticks))
294             code = EINTR;
295     } else
296         schedule_timeout(ticks);
297 #ifdef AFS_LINUX26_ENV
298 #ifdef CONFIG_PM
299     if (
300 #ifdef PF_FREEZE
301             current->flags & PF_FREEZE
302 #else
303 #if defined(STRUCT_TASK_STRUCT_HAS_TODO)
304             !current->todo
305 #else
306             test_ti_thread_flag(current->thread_info, TIF_FREEZE)
307 #endif
308 #endif
309             )
310 #ifdef LINUX_REFRIGERATOR_TAKES_PF_FREEZE
311         refrigerator(PF_FREEZE);
312 #else
313         refrigerator();
314 #endif
315 #endif
316 #endif
317
318     AFS_GLOCK();
319     remove_wait_queue(&evp->cond, &wait);
320     set_current_state(TASK_RUNNING);
321
322     relevent(evp);
323
324     return code;
325 }
326
327
328 int
329 afs_osi_Wakeup(void *event)
330 {
331     int ret = 2;
332     struct afs_event *evp;
333
334     evp = afs_getevent(event);
335     if (!evp)                   /* No sleepers */
336         return 1;
337
338     if (evp->refcount > 1) {
339         evp->seq++;
340         wake_up(&evp->cond);
341         ret = 0;
342     }
343     relevent(evp);
344     return ret;
345 }