Rename __pthread_spin_unlock back to __pthread_unlock.
[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(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       /* 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
87 int __pthread_unlock(struct _pthread_fastlock * lock)
88 {
89   long oldstatus;
90   pthread_descr thr, * ptr, * maxptr;
91   int maxprio;
92
93 again:
94   oldstatus = lock->__status;
95   if (oldstatus == 0 || oldstatus == 1) {
96     /* No threads are waiting for this lock.  Please note that we also
97        enter this case if the lock is not taken at all.  If this wouldn't
98        be done here we would crash further down.  */
99     if (! compare_and_swap(&lock->__status, oldstatus, 0, &lock->__spinlock))
100       goto again;
101     return 0;
102   }
103   /* Find thread in waiting queue with maximal priority */
104   ptr = (pthread_descr *) &lock->__status;
105   thr = (pthread_descr) oldstatus;
106   maxprio = 0;
107   maxptr = ptr;
108   while (thr != (pthread_descr) 1) {
109     if (thr->p_priority >= maxprio) {
110       maxptr = ptr;
111       maxprio = thr->p_priority;
112     }
113     ptr = &(thr->p_nextlock);
114     /* Prevent reordering of the load of lock->__status above and the
115        load of *ptr below, as well as reordering of *ptr between
116        several iterations of the while loop.  Some processors (e.g.
117        multiprocessor Alphas) could perform such reordering even though
118        the loads are dependent. */
119     READ_MEMORY_BARRIER();
120     thr = *ptr;
121   }
122   /* Prevent reordering of the load of lock->__status above and
123      thr->p_nextlock below */
124   READ_MEMORY_BARRIER();
125   /* Remove max prio thread from waiting list. */
126   if (maxptr == (pthread_descr *) &lock->__status) {
127     /* If max prio thread is at head, remove it with compare-and-swap
128        to guard against concurrent lock operation */
129     thr = (pthread_descr) oldstatus;
130     if (! compare_and_swap(&lock->__status,
131                            oldstatus, (long)(thr->p_nextlock),
132                            &lock->__spinlock))
133       goto again;
134   } else {
135     /* No risk of concurrent access, remove max prio thread normally */
136     thr = *maxptr;
137     *maxptr = thr->p_nextlock;
138   }
139   /* Prevent reordering of store to *maxptr above and store to thr->p_nextlock
140      below */
141   WRITE_MEMORY_BARRIER();
142   /* Wake up the selected waiting thread */
143   thr->p_nextlock = NULL;
144   restart(thr);
145
146   return 0;
147 }
148
149
150 /* Compare-and-swap emulation with a spinlock */
151
152 #ifdef TEST_FOR_COMPARE_AND_SWAP
153 int __pthread_has_cas = 0;
154 #endif
155
156 #if !defined HAS_COMPARE_AND_SWAP || defined TEST_FOR_COMPARE_AND_SWAP
157
158 static void __pthread_acquire(int * spinlock);
159
160 int __pthread_compare_and_swap(long * ptr, long oldval, long newval,
161                                int * spinlock)
162 {
163   int res;
164   if (testandset(spinlock)) __pthread_acquire(spinlock);
165   if (*ptr == oldval) {
166     *ptr = newval; res = 1;
167   } else {
168     res = 0;
169   }
170   /* Prevent reordering of store to *ptr above and store to *spinlock below */
171   WRITE_MEMORY_BARRIER();
172   *spinlock = 0;
173   return res;
174 }
175
176 /* This function is called if the inlined test-and-set
177    in __pthread_compare_and_swap() failed */
178
179 /* The retry strategy is as follows:
180    - We test and set the spinlock MAX_SPIN_COUNT times, calling
181      sched_yield() each time.  This gives ample opportunity for other
182      threads with priority >= our priority to make progress and
183      release the spinlock.
184    - If a thread with priority < our priority owns the spinlock,
185      calling sched_yield() repeatedly is useless, since we're preventing
186      the owning thread from making progress and releasing the spinlock.
187      So, after MAX_SPIN_LOCK attemps, we suspend the calling thread
188      using nanosleep().  This again should give time to the owning thread
189      for releasing the spinlock.
190      Notice that the nanosleep() interval must not be too small,
191      since the kernel does busy-waiting for short intervals in a realtime
192      process (!).  The smallest duration that guarantees thread
193      suspension is currently 2ms.
194    - When nanosleep() returns, we try again, doing MAX_SPIN_COUNT
195      sched_yield(), then sleeping again if needed. */
196
197 static void __pthread_acquire(int * spinlock)
198 {
199   int cnt = 0;
200   struct timespec tm;
201
202   while (testandset(spinlock)) {
203     if (cnt < MAX_SPIN_COUNT) {
204       sched_yield();
205       cnt++;
206     } else {
207       tm.tv_sec = 0;
208       tm.tv_nsec = SPIN_SLEEP_DURATION;
209       nanosleep(&tm, NULL);
210       cnt = 0;
211     }
212   }
213 }
214
215 #endif