JavaScriptCore:
[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 #include "config.h"
37
38 #if (PLATFORM(X86) || PLATFORM(PPC)) && COMPILER(GCC)
39
40 #include <time.h>       /* For nanosleep() */
41
42 #include <sched.h>      /* For sched_yield() */
43
44 #if HAVE(STDINT_H)
45 #include <stdint.h>
46 #elif HAVE(INTTYPES_H)
47 #include <inttypes.h>
48 #else
49 #include <sys/types.h>
50 #endif
51 #include <stdlib.h>     /* for abort() */
52
53 static void TCMalloc_SlowLock(volatile unsigned int* lockword);
54
55 // The following is a struct so that it can be initialized at compile time
56 struct TCMalloc_SpinLock {
57   volatile unsigned int private_lockword_;
58
59   inline void Init() { private_lockword_ = 0; }
60   inline void Finalize() { }
61     
62   inline void Lock() {
63     int r;
64 #if PLATFORM(X86)
65     __asm__ __volatile__
66       ("xchgl %0, %1"
67        : "=r"(r), "=m"(private_lockword_)
68        : "0"(1), "m"(private_lockword_)
69        : "memory");
70 #else
71     volatile unsigned int *lockword_ptr = &private_lockword_;
72     __asm__ __volatile__
73         ("1: lwarx %0, 0, %1\n\t"
74          "stwcx. %2, 0, %1\n\t"
75          "bne- 1b\n\t"
76          "isync"
77          : "=&r" (r), "=r" (lockword_ptr)
78          : "r" (1), "1" (lockword_ptr)
79          : "memory");
80 #endif
81     if (r) TCMalloc_SlowLock(&private_lockword_);
82   }
83
84   inline void Unlock() {
85 #if PLATFORM(X86)
86     __asm__ __volatile__
87       ("movl $0, %0"
88        : "=m"(private_lockword_)
89        : "m" (private_lockword_)
90        : "memory");
91 #else
92     __asm__ __volatile__
93       ("isync\n\t"
94        "eieio\n\t"
95        "stw %1, %0"
96        : "=o" (private_lockword_) 
97        : "r" (0)
98        : "memory");
99 #endif
100   }
101
102 #ifdef WTF_CHANGES  
103   inline bool IsLocked() {
104     return private_lockword_ != 0;
105   }
106 #endif
107 };
108
109 #define SPINLOCK_INITIALIZER { 0 }
110
111 static void TCMalloc_SlowLock(volatile unsigned int* lockword) {
112   sched_yield();        // Yield immediately since fast path failed
113   while (true) {
114     int r;
115 #if PLATFORM(X86)
116     __asm__ __volatile__
117       ("xchgl %0, %1"
118        : "=r"(r), "=m"(*lockword)
119        : "0"(1), "m"(*lockword)
120        : "memory");
121
122 #else
123     int tmp = 1;
124     __asm__ __volatile__
125         ("1: lwarx %0, 0, %1\n\t"
126          "stwcx. %2, 0, %1\n\t"
127          "bne- 1b\n\t"
128          "isync"
129          : "=&r" (r), "=r" (lockword)
130          : "r" (tmp), "1" (lockword)
131          : "memory");
132 #endif
133     if (!r) {
134       return;
135     }
136
137     // This code was adapted from the ptmalloc2 implementation of
138     // spinlocks which would sched_yield() upto 50 times before
139     // sleeping once for a few milliseconds.  Mike Burrows suggested
140     // just doing one sched_yield() outside the loop and always
141     // sleeping after that.  This change helped a great deal on the
142     // performance of spinlocks under high contention.  A test program
143     // with 10 threads on a dual Xeon (four virtual processors) went
144     // from taking 30 seconds to 16 seconds.
145
146     // Sleep for a few milliseconds
147     struct timespec tm;
148     tm.tv_sec = 0;
149     tm.tv_nsec = 2000001;
150     nanosleep(&tm, NULL);
151   }
152 }
153
154 #else
155
156 #include <pthread.h>
157
158 // Portable version
159 struct TCMalloc_SpinLock {
160   pthread_mutex_t private_lock_;
161
162   inline void Init() {
163     if (pthread_mutex_init(&private_lock_, NULL) != 0) abort();
164   }
165   inline void Finalize() {
166     if (pthread_mutex_destroy(&private_lock_) != 0) abort();
167   }
168   inline void Lock() {
169     if (pthread_mutex_lock(&private_lock_) != 0) abort();
170   }
171   inline void Unlock() {
172     if (pthread_mutex_unlock(&private_lock_) != 0) abort();
173   }
174 };
175
176 #define SPINLOCK_INITIALIZER { PTHREAD_MUTEX_INITIALIZER }
177
178 #endif
179
180 // Corresponding locker object that arranges to acquire a spinlock for
181 // the duration of a C++ scope.
182 class TCMalloc_SpinLockHolder {
183  private:
184   TCMalloc_SpinLock* lock_;
185  public:
186   inline explicit TCMalloc_SpinLockHolder(TCMalloc_SpinLock* l)
187     : lock_(l) { l->Lock(); }
188   inline ~TCMalloc_SpinLockHolder() { lock_->Unlock(); }
189 };
190
191 // Short-hands for convenient use by tcmalloc.cc
192 typedef TCMalloc_SpinLock SpinLock;
193 typedef TCMalloc_SpinLockHolder SpinLockHolder;
194
195 #endif  // TCMALLOC_INTERNAL_SPINLOCK_H__