(__pthread_lock): Add new parameter. Use it instead of local variable
[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_nextwaiting 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
44   do {
45     oldstatus = lock->__status;
46     if (oldstatus == 0) {
47       newstatus = 1;
48     } else {
49       if (self == NULL)
50         self = thread_self();
51       newstatus = (long) self;
52     }
53     if (self != NULL)
54       THREAD_SETMEM(self, p_nextwaiting, (pthread_descr) oldstatus);
55   } while(! compare_and_swap(&lock->__status, oldstatus, newstatus,
56                              &lock->__spinlock));
57   if (oldstatus != 0) suspend(self);
58 }
59
60 void internal_function __pthread_unlock(struct _pthread_fastlock * lock)
61 {
62   long oldstatus;
63   pthread_descr thr, * ptr, * maxptr;
64   int maxprio;
65
66 again:
67   oldstatus = lock->__status;
68   if (oldstatus == 1) {
69     /* No threads are waiting for this lock */
70     if (! compare_and_swap(&lock->__status, 1, 0, &lock->__spinlock))
71       goto again;
72     return;
73   }
74   /* Find thread in waiting queue with maximal priority */
75   ptr = (pthread_descr *) &lock->__status;
76   thr = (pthread_descr) oldstatus;
77   maxprio = 0;
78   maxptr = ptr;
79   while (thr != (pthread_descr) 1) {
80     if (thr->p_priority >= maxprio) {
81       maxptr = ptr;
82       maxprio = thr->p_priority;
83     }
84     ptr = &(thr->p_nextwaiting);
85     thr = *ptr;
86   }
87   /* Remove max prio thread from waiting list. */
88   if (maxptr == (pthread_descr *) &lock->__status) {
89     /* If max prio thread is at head, remove it with compare-and-swap
90        to guard against concurrent lock operation */
91     thr = (pthread_descr) oldstatus;
92     if (! compare_and_swap(&lock->__status,
93                            oldstatus, (long)(thr->p_nextwaiting),
94                            &lock->__spinlock))
95       goto again;
96   } else {
97     /* No risk of concurrent access, remove max prio thread normally */
98     thr = *maxptr;
99     *maxptr = thr->p_nextwaiting;
100   }
101   /* Wake up the selected waiting thread */
102   thr->p_nextwaiting = NULL;
103   restart(thr);
104 }
105
106 /* Compare-and-swap emulation with a spinlock */
107
108 #ifdef TEST_FOR_COMPARE_AND_SWAP
109 int __pthread_has_cas = 0;
110 #endif
111
112 #if !defined HAS_COMPARE_AND_SWAP || defined TEST_FOR_COMPARE_AND_SWAP
113
114 static void __pthread_acquire(int * spinlock);
115
116 int __pthread_compare_and_swap(long * ptr, long oldval, long newval,
117                                int * spinlock)
118 {
119   int res;
120   if (testandset(spinlock)) __pthread_acquire(spinlock);
121   if (*ptr == oldval) {
122     *ptr = newval; res = 1;
123   } else {
124     res = 0;
125   }
126   *spinlock = 0;
127   return res;
128 }
129
130 /* This function is called if the inlined test-and-set
131    in __pthread_compare_and_swap() failed */
132
133 /* The retry strategy is as follows:
134    - We test and set the spinlock MAX_SPIN_COUNT times, calling
135      sched_yield() each time.  This gives ample opportunity for other
136      threads with priority >= our priority to make progress and
137      release the spinlock.
138    - If a thread with priority < our priority owns the spinlock,
139      calling sched_yield() repeatedly is useless, since we're preventing
140      the owning thread from making progress and releasing the spinlock.
141      So, after MAX_SPIN_LOCK attemps, we suspend the calling thread
142      using nanosleep().  This again should give time to the owning thread
143      for releasing the spinlock.
144      Notice that the nanosleep() interval must not be too small,
145      since the kernel does busy-waiting for short intervals in a realtime
146      process (!).  The smallest duration that guarantees thread
147      suspension is currently 2ms.
148    - When nanosleep() returns, we try again, doing MAX_SPIN_COUNT
149      sched_yield(), then sleeping again if needed. */
150
151 static void __pthread_acquire(int * spinlock)
152 {
153   int cnt = 0;
154   struct timespec tm;
155
156   while (testandset(spinlock)) {
157     if (cnt < MAX_SPIN_COUNT) {
158       sched_yield();
159       cnt++;
160     } else {
161       tm.tv_sec = 0;
162       tm.tv_nsec = SPIN_SLEEP_DURATION;
163       nanosleep(&tm, NULL);
164       cnt = 0;
165     }
166   }
167 }
168
169 #endif