Implement pthread_spin_lock.
[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 spinlock has the following meaning:
26      0: spinlock is free
27      1: spinlock is taken, no thread is waiting on it
28   ADDR: psinlock 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(pthread_spinlock_t * 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       /* Make sure the store in p_nextlock completes before performing
58          the compare-and-swap */
59       MEMORY_BARRIER();
60     }
61   } while(! compare_and_swap(&lock->__status, oldstatus, newstatus,
62                              &lock->__spinlock));
63
64   /* Suspend with guard against spurious wakeup.
65      This can happen in pthread_cond_timedwait_relative, when the thread
66      wakes up due to timeout and is still on the condvar queue, and then
67      locks the queue to remove itself. At that point it may still be on the
68      queue, and may be resumed by a condition signal. */
69
70   if (oldstatus != 0) {
71     for (;;) {
72       suspend(self);
73       if (self->p_nextlock != NULL) {
74         /* Count resumes that don't belong to us. */
75         spurious_wakeup_count++;
76         continue;
77       }
78       break;
79     }
80   }
81
82   /* Put back any resumes we caught that don't belong to us. */
83   while (spurious_wakeup_count--)
84     restart(self);
85
86   return 0;
87 }
88 int __pthread_spin_lock(pthread_spinlock_t * lock)
89 {
90   __pthread_lock (lock, NULL);
91   return 0;
92 }
93 weak_alias (__pthread_spin_lock, pthread_spin_lock)
94
95 int __pthread_spin_unlock(pthread_spinlock_t * lock)
96 {
97   long oldstatus;
98   pthread_descr thr, * ptr, * maxptr;
99   int maxprio;
100
101 again:
102   oldstatus = lock->__status;
103   if (oldstatus == 0 || oldstatus == 1) {
104     /* No threads are waiting for this lock.  Please note that we also
105        enter this case if the lock is not taken at all.  If this wouldn't
106        be done here we would crash further down.  */
107     if (! compare_and_swap(&lock->__status, oldstatus, 0, &lock->__spinlock))
108       goto again;
109     return 0;
110   }
111   /* Find thread in waiting queue with maximal priority */
112   ptr = (pthread_descr *) &lock->__status;
113   thr = (pthread_descr) oldstatus;
114   maxprio = 0;
115   maxptr = ptr;
116   while (thr != (pthread_descr) 1) {
117     if (thr->p_priority >= maxprio) {
118       maxptr = ptr;
119       maxprio = thr->p_priority;
120     }
121     ptr = &(thr->p_nextlock);
122     /* Prevent reordering of the load of lock->__status above and the
123        load of *ptr below, as well as reordering of *ptr between
124        several iterations of the while loop.  Some processors (e.g.
125        multiprocessor Alphas) could perform such reordering even though
126        the loads are dependent. */
127     MEMORY_BARRIER();
128     thr = *ptr;
129   }
130   /* Prevent reordering of the load of lock->__status above and
131      thr->p_nextlock below */
132   MEMORY_BARRIER();
133   /* Remove max prio thread from waiting list. */
134   if (maxptr == (pthread_descr *) &lock->__status) {
135     /* If max prio thread is at head, remove it with compare-and-swap
136        to guard against concurrent lock operation */
137     thr = (pthread_descr) oldstatus;
138     if (! compare_and_swap(&lock->__status,
139                            oldstatus, (long)(thr->p_nextlock),
140                            &lock->__spinlock))
141       goto again;
142   } else {
143     /* No risk of concurrent access, remove max prio thread normally */
144     thr = *maxptr;
145     *maxptr = thr->p_nextlock;
146   }
147   /* Prevent reordering of store to *maxptr above and store to thr->p_nextlock
148      below */
149   MEMORY_BARRIER();
150   /* Wake up the selected waiting thread */
151   thr->p_nextlock = NULL;
152   restart(thr);
153
154   return 0;
155 }
156 weak_alias (__pthread_spin_unlock, pthread_spin_unlock)
157
158
159 int __pthread_spin_trylock (pthread_spinlock_t *lock)
160 {
161   return __pthread_trylock (lock);
162 }
163 weak_alias (__pthread_spin_trylock, pthread_spin_trylock)
164
165 int __pthread_spin_init(pthread_spinlock_t *lock, int pshared)
166 {
167   if (pshared != 0)
168     return ENOSYS;
169
170   __pthread_init_lock (lock);
171   return 0;
172 }
173 weak_alias (__pthread_spin_init, pthread_spin_init)
174
175 int __pthread_spin_destroy(pthread_spinlock_t *lock)
176 {
177   /* Nothing to do.  */
178   return 0;
179 }
180 weak_alias (__pthread_spin_destroy, pthread_spin_destroy)
181
182 /* Compare-and-swap emulation with a spinlock */
183
184 #ifdef TEST_FOR_COMPARE_AND_SWAP
185 int __pthread_has_cas = 0;
186 #endif
187
188 #if !defined HAS_COMPARE_AND_SWAP || defined TEST_FOR_COMPARE_AND_SWAP
189
190 static void __pthread_acquire(int * spinlock);
191
192 int __pthread_compare_and_swap(long * ptr, long oldval, long newval,
193                                int * spinlock)
194 {
195   int res;
196   if (testandset(spinlock)) __pthread_acquire(spinlock);
197   if (*ptr == oldval) {
198     *ptr = newval; res = 1;
199   } else {
200     res = 0;
201   }
202   /* Prevent reordering of store to *ptr above and store to *spinlock below */
203   MEMORY_BARRIER();
204   *spinlock = 0;
205   return res;
206 }
207
208 /* This function is called if the inlined test-and-set
209    in __pthread_compare_and_swap() failed */
210
211 /* The retry strategy is as follows:
212    - We test and set the spinlock MAX_SPIN_COUNT times, calling
213      sched_yield() each time.  This gives ample opportunity for other
214      threads with priority >= our priority to make progress and
215      release the spinlock.
216    - If a thread with priority < our priority owns the spinlock,
217      calling sched_yield() repeatedly is useless, since we're preventing
218      the owning thread from making progress and releasing the spinlock.
219      So, after MAX_SPIN_LOCK attemps, we suspend the calling thread
220      using nanosleep().  This again should give time to the owning thread
221      for releasing the spinlock.
222      Notice that the nanosleep() interval must not be too small,
223      since the kernel does busy-waiting for short intervals in a realtime
224      process (!).  The smallest duration that guarantees thread
225      suspension is currently 2ms.
226    - When nanosleep() returns, we try again, doing MAX_SPIN_COUNT
227      sched_yield(), then sleeping again if needed. */
228
229 static void __pthread_acquire(int * spinlock)
230 {
231   int cnt = 0;
232   struct timespec tm;
233
234   while (testandset(spinlock)) {
235     if (cnt < MAX_SPIN_COUNT) {
236       sched_yield();
237       cnt++;
238     } else {
239       tm.tv_sec = 0;
240       tm.tv_nsec = SPIN_SLEEP_DURATION;
241       nanosleep(&tm, NULL);
242       cnt = 0;
243     }
244   }
245 }
246
247 #endif