Redesigned how cancellation unblocks a thread from internal
[kopensolaris-gnu/glibc.git] / linuxthreads / spinlock.c
1 /* Linuxthreads - a simple clone()-based implementation of Posix        */
2 /* threads for Linux.                                                   */
3 /* Copyright (C) 1998 Xavier Leroy (Xavier.Leroy@inria.fr)              */
4 /*                                                                      */
5 /* This program is free software; you can redistribute it and/or        */
6 /* modify it under the terms of the GNU Library General Public License  */
7 /* as published by the Free Software Foundation; either version 2       */
8 /* of the License, or (at your option) any later version.               */
9 /*                                                                      */
10 /* This program is distributed in the hope that it will be useful,      */
11 /* but WITHOUT ANY WARRANTY; without even the implied warranty of       */
12 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        */
13 /* GNU Library General Public License for more details.                 */
14
15 /* Internal locks */
16
17 #include <errno.h>
18 #include <sched.h>
19 #include <time.h>
20 #include "pthread.h"
21 #include "internals.h"
22 #include "spinlock.h"
23 #include "restart.h"
24
25 /* The status field of a fastlock has the following meaning:
26      0: fastlock is free
27      1: fastlock is taken, no thread is waiting on it
28   ADDR: fastlock is taken, ADDR is address of thread descriptor for
29         first waiting thread, other waiting threads are linked via
30         their p_nextlock field.
31    The waiting list is not sorted by priority order.
32    Actually, we always insert at top of list (sole insertion mode
33    that can be performed without locking).
34    For __pthread_unlock, we perform a linear search in the list
35    to find the highest-priority, oldest waiting thread.
36    This is safe because there are no concurrent __pthread_unlock
37    operations -- only the thread that locked the mutex can unlock it. */
38
39 void internal_function __pthread_lock(struct _pthread_fastlock * lock,
40                                       pthread_descr self)
41 {
42   long oldstatus, newstatus;
43   int spurious_wakeup_count = 0;
44
45   do {
46     oldstatus = lock->__status;
47     if (oldstatus == 0) {
48       newstatus = 1;
49     } else {
50       if (self == NULL)
51         self = thread_self();
52       newstatus = (long) self;
53     }
54     if (self != NULL) {
55       ASSERT(self->p_nextlock == NULL);
56       THREAD_SETMEM(self, p_nextlock, (pthread_descr) oldstatus);
57     }
58   } while(! compare_and_swap(&lock->__status, oldstatus, newstatus,
59                              &lock->__spinlock));
60
61   /* Suspend with guard against spurious wakeup. 
62      This can happen in pthread_cond_timedwait_relative, when the thread
63      wakes up due to timeout and is still on the condvar queue, and then
64      locks the queue to remove itself. At that point it may still be on the
65      queue, and may be resumed by a condition signal. */
66
67   if (oldstatus != 0) {
68     for (;;) {
69       suspend(self);
70       if (self->p_nextlock != NULL) {
71         /* Count resumes that don't belong to us. */
72         spurious_wakeup_count++;
73         continue;
74       }
75       break;
76     }
77   }
78
79   /* Put back any resumes we caught that don't belong to us. */
80   while (spurious_wakeup_count--)
81     restart(self);
82 }
83
84 void internal_function __pthread_unlock(struct _pthread_fastlock * lock)
85 {
86   long oldstatus;
87   pthread_descr thr, * ptr, * maxptr;
88   int maxprio;
89
90 again:
91   oldstatus = lock->__status;
92   if (oldstatus == 0 || oldstatus == 1) {
93     /* No threads are waiting for this lock.  Please note that we also
94        enter this case if the lock is not taken at all.  If this wouldn't
95        be done here we would crash further down.  */
96     if (! compare_and_swap(&lock->__status, oldstatus, 0, &lock->__spinlock))
97       goto again;
98     return;
99   }
100   /* Find thread in waiting queue with maximal priority */
101   ptr = (pthread_descr *) &lock->__status;
102   thr = (pthread_descr) oldstatus;
103   maxprio = 0;
104   maxptr = ptr;
105   while (thr != (pthread_descr) 1) {
106     if (thr->p_priority >= maxprio) {
107       maxptr = ptr;
108       maxprio = thr->p_priority;
109     }
110     ptr = &(thr->p_nextlock);
111     thr = *ptr;
112   }
113   /* Remove max prio thread from waiting list. */
114   if (maxptr == (pthread_descr *) &lock->__status) {
115     /* If max prio thread is at head, remove it with compare-and-swap
116        to guard against concurrent lock operation */
117     thr = (pthread_descr) oldstatus;
118     if (! compare_and_swap(&lock->__status,
119                            oldstatus, (long)(thr->p_nextlock),
120                            &lock->__spinlock))
121       goto again;
122   } else {
123     /* No risk of concurrent access, remove max prio thread normally */
124     thr = *maxptr;
125     *maxptr = thr->p_nextlock;
126   }
127   /* Wake up the selected waiting thread */
128   thr->p_nextlock = NULL;
129   restart(thr);
130 }
131
132 /* Compare-and-swap emulation with a spinlock */
133
134 #ifdef TEST_FOR_COMPARE_AND_SWAP
135 int __pthread_has_cas = 0;
136 #endif
137
138 #if !defined HAS_COMPARE_AND_SWAP || defined TEST_FOR_COMPARE_AND_SWAP
139
140 static void __pthread_acquire(int * spinlock);
141
142 int __pthread_compare_and_swap(long * ptr, long oldval, long newval,
143                                int * spinlock)
144 {
145   int res;
146   if (testandset(spinlock)) __pthread_acquire(spinlock);
147   if (*ptr == oldval) {
148     *ptr = newval; res = 1;
149   } else {
150     res = 0;
151   }
152   *spinlock = 0;
153   return res;
154 }
155
156 /* This function is called if the inlined test-and-set
157    in __pthread_compare_and_swap() failed */
158
159 /* The retry strategy is as follows:
160    - We test and set the spinlock MAX_SPIN_COUNT times, calling
161      sched_yield() each time.  This gives ample opportunity for other
162      threads with priority >= our priority to make progress and
163      release the spinlock.
164    - If a thread with priority < our priority owns the spinlock,
165      calling sched_yield() repeatedly is useless, since we're preventing
166      the owning thread from making progress and releasing the spinlock.
167      So, after MAX_SPIN_LOCK attemps, we suspend the calling thread
168      using nanosleep().  This again should give time to the owning thread
169      for releasing the spinlock.
170      Notice that the nanosleep() interval must not be too small,
171      since the kernel does busy-waiting for short intervals in a realtime
172      process (!).  The smallest duration that guarantees thread
173      suspension is currently 2ms.
174    - When nanosleep() returns, we try again, doing MAX_SPIN_COUNT
175      sched_yield(), then sleeping again if needed. */
176
177 static void __pthread_acquire(int * spinlock)
178 {
179   int cnt = 0;
180   struct timespec tm;
181
182   while (testandset(spinlock)) {
183     if (cnt < MAX_SPIN_COUNT) {
184       sched_yield();
185       cnt++;
186     } else {
187       tm.tv_sec = 0;
188       tm.tv_nsec = SPIN_SLEEP_DURATION;
189       nanosleep(&tm, NULL);
190       cnt = 0;
191     }
192   }
193 }
194
195 #endif