2007-11-11 Mike Hommey <mh+webkit@glandium.org>
[WebKit-https.git] / JavaScriptCore / wtf / TCSpinLock.h
1 // Copyright (c) 2005, Google Inc.
2 // All rights reserved.
3 // 
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 // 
8 //     * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 //     * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
13 // distribution.
14 //     * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
17 // 
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30 // ---
31 // Author: Sanjay Ghemawat <opensource@google.com>
32
33 #ifndef TCMALLOC_INTERNAL_SPINLOCK_H__
34 #define TCMALLOC_INTERNAL_SPINLOCK_H__
35
36 #if (PLATFORM(X86) || PLATFORM(PPC)) && (COMPILER(GCC) || COMPILER(MSVC))
37
38 #include <time.h>       /* For nanosleep() */
39
40 #include <sched.h>      /* For sched_yield() */
41
42 #if HAVE(STDINT_H)
43 #include <stdint.h>
44 #elif HAVE(INTTYPES_H)
45 #include <inttypes.h>
46 #else
47 #include <sys/types.h>
48 #endif
49 #include <stdlib.h>     /* for abort() */
50
51 #if COMPILER(MSVC)
52 #define WIN32_LEAN_AND_MEAN
53 #include <windows.h>
54 #endif
55
56 static void TCMalloc_SlowLock(volatile unsigned int* lockword);
57
58 // The following is a struct so that it can be initialized at compile time
59 struct TCMalloc_SpinLock {
60   volatile unsigned int private_lockword_;
61
62   inline void Init() { private_lockword_ = 0; }
63   inline void Finalize() { }
64     
65   inline void Lock() {
66     int r;
67 #if COMPILER(GCC)
68 #if PLATFORM(X86)
69     __asm__ __volatile__
70       ("xchgl %0, %1"
71        : "=r"(r), "=m"(private_lockword_)
72        : "0"(1), "m"(private_lockword_)
73        : "memory");
74 #else
75     volatile unsigned int *lockword_ptr = &private_lockword_;
76     __asm__ __volatile__
77         ("1: lwarx %0, 0, %1\n\t"
78          "stwcx. %2, 0, %1\n\t"
79          "bne- 1b\n\t"
80          "isync"
81          : "=&r" (r), "=r" (lockword_ptr)
82          : "r" (1), "1" (lockword_ptr)
83          : "memory");
84 #endif
85 #elif COMPILER(MSVC)
86     __asm {
87         mov eax, this    ; store &private_lockword_ (which is this+0) in eax
88         mov ebx, 1       ; store 1 in ebx
89         xchg [eax], ebx  ; exchange private_lockword_ and 1
90         mov r, ebx       ; store old value of private_lockword_ in r
91     }
92 #endif
93     if (r) TCMalloc_SlowLock(&private_lockword_);
94   }
95
96   inline void Unlock() {
97 #if COMPILER(GCC)
98 #if PLATFORM(X86)
99     __asm__ __volatile__
100       ("movl $0, %0"
101        : "=m"(private_lockword_)
102        : "m" (private_lockword_)
103        : "memory");
104 #else
105     __asm__ __volatile__
106       ("isync\n\t"
107        "eieio\n\t"
108        "stw %1, %0"
109        : "=m" (private_lockword_)
110        : "r" (0)
111        : "memory");
112 #endif
113 #elif COMPILER(MSVC)
114       __asm {
115           mov eax, this  ; store &private_lockword_ (which is this+0) in eax
116           mov [eax], 0   ; set private_lockword_ to 0
117       }
118 #endif
119   }
120
121 #ifdef WTF_CHANGES  
122   inline bool IsLocked() {
123     return private_lockword_ != 0;
124   }
125 #endif
126 };
127
128 #define SPINLOCK_INITIALIZER { 0 }
129
130 static void TCMalloc_SlowLock(volatile unsigned int* lockword) {
131   sched_yield();        // Yield immediately since fast path failed
132   while (true) {
133     int r;
134 #if COMPILER(GCC)
135 #if PLATFORM(X86)
136     __asm__ __volatile__
137       ("xchgl %0, %1"
138        : "=r"(r), "=m"(*lockword)
139        : "0"(1), "m"(*lockword)
140        : "memory");
141
142 #else
143     int tmp = 1;
144     __asm__ __volatile__
145         ("1: lwarx %0, 0, %1\n\t"
146          "stwcx. %2, 0, %1\n\t"
147          "bne- 1b\n\t"
148          "isync"
149          : "=&r" (r), "=r" (lockword)
150          : "r" (tmp), "1" (lockword)
151          : "memory");
152 #endif
153 #elif COMPILER(MSVC)
154     __asm {
155         mov eax, lockword     ; assign lockword into eax
156         mov ebx, 1            ; assign 1 into ebx
157         xchg [eax], ebx       ; exchange *lockword and 1
158         mov r, ebx            ; store old value of *lockword in r
159     }
160 #endif
161     if (!r) {
162       return;
163     }
164
165     // This code was adapted from the ptmalloc2 implementation of
166     // spinlocks which would sched_yield() upto 50 times before
167     // sleeping once for a few milliseconds.  Mike Burrows suggested
168     // just doing one sched_yield() outside the loop and always
169     // sleeping after that.  This change helped a great deal on the
170     // performance of spinlocks under high contention.  A test program
171     // with 10 threads on a dual Xeon (four virtual processors) went
172     // from taking 30 seconds to 16 seconds.
173
174     // Sleep for a few milliseconds
175 #if COMPILER(MSVC)
176     Sleep(2);
177 #else
178     struct timespec tm;
179     tm.tv_sec = 0;
180     tm.tv_nsec = 2000001;
181     nanosleep(&tm, NULL);
182 #endif
183   }
184 }
185
186 #else
187
188 #include <pthread.h>
189
190 // Portable version
191 struct TCMalloc_SpinLock {
192   pthread_mutex_t private_lock_;
193
194   inline void Init() {
195     if (pthread_mutex_init(&private_lock_, NULL) != 0) abort();
196   }
197   inline void Finalize() {
198     if (pthread_mutex_destroy(&private_lock_) != 0) abort();
199   }
200   inline void Lock() {
201     if (pthread_mutex_lock(&private_lock_) != 0) abort();
202   }
203   inline void Unlock() {
204     if (pthread_mutex_unlock(&private_lock_) != 0) abort();
205   }
206 };
207
208 #define SPINLOCK_INITIALIZER { PTHREAD_MUTEX_INITIALIZER }
209
210 #endif
211
212 // Corresponding locker object that arranges to acquire a spinlock for
213 // the duration of a C++ scope.
214 class TCMalloc_SpinLockHolder {
215  private:
216   TCMalloc_SpinLock* lock_;
217  public:
218   inline explicit TCMalloc_SpinLockHolder(TCMalloc_SpinLock* l)
219     : lock_(l) { l->Lock(); }
220   inline ~TCMalloc_SpinLockHolder() { lock_->Unlock(); }
221 };
222
223 // Short-hands for convenient use by tcmalloc.cc
224 typedef TCMalloc_SpinLock SpinLock;
225 typedef TCMalloc_SpinLockHolder SpinLockHolder;
226
227 #endif  // TCMALLOC_INTERNAL_SPINLOCK_H__