TCSpinLock.h 6.46 KB
Newer Older
mjs's avatar
mjs committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
// Copyright (c) 2005, Google Inc.
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// 
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// ---
// Author: Sanjay Ghemawat <opensource@google.com>

#ifndef TCMALLOC_INTERNAL_SPINLOCK_H__
#define TCMALLOC_INTERNAL_SPINLOCK_H__

36
#if (PLATFORM(X86) || PLATFORM(PPC)) && (COMPILER(GCC) || COMPILER(MSVC))
mjs's avatar
mjs committed
37

mjs's avatar
mjs committed
38
#include <time.h>       /* For nanosleep() */
mjs's avatar
mjs committed
39

mjs's avatar
mjs committed
40
#include <sched.h>      /* For sched_yield() */
mjs's avatar
mjs committed
41

mjs's avatar
mjs committed
42
#if HAVE(STDINT_H)
mjs's avatar
mjs committed
43
#include <stdint.h>
mjs's avatar
mjs committed
44
#elif HAVE(INTTYPES_H)
mjs's avatar
mjs committed
45 46 47 48
#include <inttypes.h>
#else
#include <sys/types.h>
#endif
49
#include <stdlib.h>     /* for abort() */
mjs's avatar
mjs committed
50

51 52 53 54 55
#if COMPILER(MSVC)
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#endif

mjs's avatar
mjs committed
56 57 58 59 60 61 62 63 64 65 66
static void TCMalloc_SlowLock(volatile unsigned int* lockword);

// The following is a struct so that it can be initialized at compile time
struct TCMalloc_SpinLock {
  volatile unsigned int private_lockword_;

  inline void Init() { private_lockword_ = 0; }
  inline void Finalize() { }
    
  inline void Lock() {
    int r;
67
#if COMPILER(GCC)
mjs's avatar
mjs committed
68
#if PLATFORM(X86)
mjs's avatar
mjs committed
69 70 71 72 73
    __asm__ __volatile__
      ("xchgl %0, %1"
       : "=r"(r), "=m"(private_lockword_)
       : "0"(1), "m"(private_lockword_)
       : "memory");
mjs's avatar
mjs committed
74 75 76 77 78 79 80 81 82 83
#else
    volatile unsigned int *lockword_ptr = &private_lockword_;
    __asm__ __volatile__
        ("1: lwarx %0, 0, %1\n\t"
         "stwcx. %2, 0, %1\n\t"
         "bne- 1b\n\t"
         "isync"
         : "=&r" (r), "=r" (lockword_ptr)
         : "r" (1), "1" (lockword_ptr)
         : "memory");
84 85 86 87 88 89 90 91
#endif
#elif COMPILER(MSVC)
    __asm {
        mov eax, this    ; store &private_lockword_ (which is this+0) in eax
        mov ebx, 1       ; store 1 in ebx
        xchg [eax], ebx  ; exchange private_lockword_ and 1
        mov r, ebx       ; store old value of private_lockword_ in r
    }
mjs's avatar
mjs committed
92
#endif
mjs's avatar
mjs committed
93 94 95 96
    if (r) TCMalloc_SlowLock(&private_lockword_);
  }

  inline void Unlock() {
97
#if COMPILER(GCC)
mjs's avatar
mjs committed
98
#if PLATFORM(X86)
mjs's avatar
mjs committed
99 100 101 102 103
    __asm__ __volatile__
      ("movl $0, %0"
       : "=m"(private_lockword_)
       : "m" (private_lockword_)
       : "memory");
mjs's avatar
mjs committed
104 105 106 107 108
#else
    __asm__ __volatile__
      ("isync\n\t"
       "eieio\n\t"
       "stw %1, %0"
109
       : "=o" (private_lockword_) 
mjs's avatar
mjs committed
110 111
       : "r" (0)
       : "memory");
112 113 114 115 116 117
#endif
#elif COMPILER(MSVC)
      __asm {
          mov eax, this  ; store &private_lockword_ (which is this+0) in eax
          mov [eax], 0   ; set private_lockword_ to 0
      }
mjs's avatar
mjs committed
118
#endif
mjs's avatar
mjs committed
119
  }
ggaren's avatar
ggaren committed
120 121 122 123 124 125

#ifdef WTF_CHANGES  
  inline bool IsLocked() {
    return private_lockword_ != 0;
  }
#endif
mjs's avatar
mjs committed
126 127 128 129 130 131 132 133
};

#define SPINLOCK_INITIALIZER { 0 }

static void TCMalloc_SlowLock(volatile unsigned int* lockword) {
  sched_yield();        // Yield immediately since fast path failed
  while (true) {
    int r;
134
#if COMPILER(GCC)
mjs's avatar
mjs committed
135
#if PLATFORM(X86)
mjs's avatar
mjs committed
136 137 138 139 140
    __asm__ __volatile__
      ("xchgl %0, %1"
       : "=r"(r), "=m"(*lockword)
       : "0"(1), "m"(*lockword)
       : "memory");
mjs's avatar
mjs committed
141 142 143 144 145 146 147 148 149 150 151

#else
    int tmp = 1;
    __asm__ __volatile__
        ("1: lwarx %0, 0, %1\n\t"
         "stwcx. %2, 0, %1\n\t"
         "bne- 1b\n\t"
         "isync"
         : "=&r" (r), "=r" (lockword)
         : "r" (tmp), "1" (lockword)
         : "memory");
152 153 154 155 156 157 158 159
#endif
#elif COMPILER(MSVC)
    __asm {
        mov eax, lockword     ; assign lockword into eax
        mov ebx, 1            ; assign 1 into ebx
        xchg [eax], ebx       ; exchange *lockword and 1
        mov r, ebx            ; store old value of *lockword in r
    }
mjs's avatar
mjs committed
160
#endif
mjs's avatar
mjs committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174
    if (!r) {
      return;
    }

    // This code was adapted from the ptmalloc2 implementation of
    // spinlocks which would sched_yield() upto 50 times before
    // sleeping once for a few milliseconds.  Mike Burrows suggested
    // just doing one sched_yield() outside the loop and always
    // sleeping after that.  This change helped a great deal on the
    // performance of spinlocks under high contention.  A test program
    // with 10 threads on a dual Xeon (four virtual processors) went
    // from taking 30 seconds to 16 seconds.

    // Sleep for a few milliseconds
175 176 177
#if COMPILER(MSVC)
    Sleep(2);
#else
mjs's avatar
mjs committed
178 179 180 181
    struct timespec tm;
    tm.tv_sec = 0;
    tm.tv_nsec = 2000001;
    nanosleep(&tm, NULL);
182
#endif
mjs's avatar
mjs committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  }
}

#else

#include <pthread.h>

// Portable version
struct TCMalloc_SpinLock {
  pthread_mutex_t private_lock_;

  inline void Init() {
    if (pthread_mutex_init(&private_lock_, NULL) != 0) abort();
  }
  inline void Finalize() {
    if (pthread_mutex_destroy(&private_lock_) != 0) abort();
  }
  inline void Lock() {
    if (pthread_mutex_lock(&private_lock_) != 0) abort();
  }
  inline void Unlock() {
    if (pthread_mutex_unlock(&private_lock_) != 0) abort();
  }
};

#define SPINLOCK_INITIALIZER { PTHREAD_MUTEX_INITIALIZER }

#endif

// Corresponding locker object that arranges to acquire a spinlock for
// the duration of a C++ scope.
class TCMalloc_SpinLockHolder {
 private:
  TCMalloc_SpinLock* lock_;
 public:
  inline explicit TCMalloc_SpinLockHolder(TCMalloc_SpinLock* l)
    : lock_(l) { l->Lock(); }
  inline ~TCMalloc_SpinLockHolder() { lock_->Unlock(); }
};

// Short-hands for convenient use by tcmalloc.cc
typedef TCMalloc_SpinLock SpinLock;
typedef TCMalloc_SpinLockHolder SpinLockHolder;

#endif  // TCMALLOC_INTERNAL_SPINLOCK_H__