folly/PicoSpinLock.h

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /*
  18  * N.B. You most likely do _not_ want to use PicoSpinLock or any other
  19  * kind of spinlock.  Consider MicroLock instead.
  20  *
  21  * In short, spinlocks in preemptive multi-tasking operating systems
  22  * have serious problems and fast mutexes like std::mutex are almost
  23  * certainly the better choice, because letting the OS scheduler put a
  24  * thread to sleep is better for system responsiveness and throughput
  25  * than wasting a timeslice repeatedly querying a lock held by a
  26  * thread that's blocked, and you can't prevent userspace
  27  * programs blocking.
  28  *
  29  * Spinlocks in an operating system kernel make much more sense than
  30  * they do in userspace.
  31  */
  32
  33 #pragma once
  34 #define FOLLY_PICO_SPIN_LOCK_H_
  35
  36 /*
  37  * @author Keith Adams <kma@fb.com>
  38  * @author Jordan DeLong <delong.j@fb.com>
  39  */
  40
  41 #include <array>
  42 #include <atomic>
  43 #include <cinttypes>
  44 #include <cstdlib>
  45 #include <folly/Portability.h>
  46 #include <mutex>
  47 #include <type_traits>
  48
  49 #include <glog/logging.h>
  50 #include <folly/detail/Sleeper.h>
  51
  52 #if !FOLLY_X64 && !FOLLY_A64 && !FOLLY_PPC64
  53 # error "PicoSpinLock.h is currently x64, aarch64 and ppc64 only."
  54 #endif
  55
  56 namespace folly {
  57
  58 /*
  59  * Spin lock on a single bit in an integral type.  You can use this
  60  * with 16, 32, or 64-bit integral types.
  61  *
  62  * This is useful if you want a small lock and already have an int
  63  * with a bit in it that you aren't using.  But note that it can't be
  64  * as small as MicroSpinLock (1 byte), if you don't already have a
  65  * convenient int with an unused bit lying around to put it on.
  66  *
  67  * To construct these, either use init() or zero initialize.  We don't
  68  * have a real constructor because we want this to be a POD type so we
  69  * can put it into packed structs.
  70  */
  71 template<class IntType, int Bit = sizeof(IntType) * 8 - 1>
  72 struct PicoSpinLock {
  73   // Internally we deal with the unsigned version of the type.
  74   typedef typename std::make_unsigned<IntType>::type UIntType;
  75
  76   static_assert(std::is_integral<IntType>::value,
  77                 "PicoSpinLock needs an integral type");
  78   static_assert(sizeof(IntType) == 2 || sizeof(IntType) == 4 ||
  79                   sizeof(IntType) == 8,
  80                 "PicoSpinLock can't work on integers smaller than 2 bytes");
  81
  82  public:
  83   static const UIntType kLockBitMask_ = UIntType(1) << Bit;
  84   UIntType lock_;
  85
  86   /*
  87    * You must call this function before using this class, if you
  88    * default constructed it.  If you zero-initialized it you can
  89    * assume the PicoSpinLock is in a valid unlocked state with
  90    * getData() == 0.
  91    *
  92    * (This doesn't use a constructor because we want to be a POD.)
  93    */
  94   void init(IntType initialValue = 0) {
  95     CHECK(!(initialValue & kLockBitMask_));
  96     lock_ = UIntType(initialValue);
  97   }
  98
  99   /*
 100    * Returns the value of the integer we using for our lock, except
 101    * with the bit we are using as a lock cleared, regardless of
 102    * whether the lock is held.
 103    *
 104    * It is 'safe' to call this without holding the lock.  (As in: you
 105    * get the same guarantees for simultaneous accesses to an integer
 106    * as you normally get.)
 107    */
 108   IntType getData() const {
 109     return static_cast<IntType>(lock_ & ~kLockBitMask_);
 110   }
 111
 112   /*
 113    * Set the value of the other bits in our integer.
 114    *
 115    * Don't use this when you aren't holding the lock, unless it can be
 116    * guaranteed that no other threads may be trying to use this.
 117    */
 118   void setData(IntType w) {
 119     CHECK(!(w & kLockBitMask_));
 120     lock_ = UIntType((lock_ & kLockBitMask_) | w);
 121   }
 122
 123   /*
 124    * Try to get the lock without blocking: returns whether or not we
 125    * got it.
 126    */
 127   bool try_lock() const {
 128     bool ret = false;
 129
 130 #ifdef _MSC_VER
 131     switch (sizeof(IntType)) {
 132       case 2:
 133         // There is no _interlockedbittestandset16 for some reason :(
 134         ret = _InterlockedOr16(
 135             (volatile short*)&lock_, (short)kLockBitMask_) & kLockBitMask_;
 136         break;
 137       case 4:
 138         ret = _interlockedbittestandset((volatile long*)&lock_, Bit);
 139         break;
 140       case 8:
 141         ret = _interlockedbittestandset64((volatile long long*)&lock_, Bit);
 142         break;
 143     }
 144 #elif FOLLY_X64
 145 #define FB_DOBTS(size)                                  \
 146   asm volatile("lock; bts" #size " %1, (%2); setnc %0"  \
 147                : "=r" (ret)                             \
 148                : "i" (Bit),                             \
 149                  "r" (&lock_)                           \
 150                : "memory", "flags")
 151
 152     switch (sizeof(IntType)) {
 153     case 2: FB_DOBTS(w); break;
 154     case 4: FB_DOBTS(l); break;
 155     case 8: FB_DOBTS(q); break;
 156     }
 157
 158 #undef FB_DOBTS
 159 #elif FOLLY_A64
 160     ret = __atomic_fetch_or(&lock_, 1 << Bit, __ATOMIC_SEQ_CST);
 161 #elif FOLLY_PPC64
 162 #define FB_DOBTS(size)                                 \
 163     asm volatile("\teieio\n"                           \
 164                  "\tl" #size "arx 14,0,%[lockPtr]\n"   \
 165                  "\tli 15,1\n"                         \
 166                  "\tsldi 15,15,%[bit]\n"               \
 167                  "\tand. 16,15,14\n"                   \
 168                  "\tbne 0f\n"                          \
 169                  "\tor 14,14,15\n"                     \
 170                  "\tst" #size "cx. 14,0,%[lockPtr]\n"  \
 171                  "\tbne 0f\n"                          \
 172                  "\tori %[output],%[output],1\n"       \
 173                  "\tisync\n"                           \
 174                  "0:\n"                                \
 175                  : [output] "+r" (ret)                 \
 176                  : [lockPtr] "r"(&lock_),              \
 177                    [bit] "i" (Bit)                     \
 178                  : "cr0", "memory", "r14", "r15", "r16")
 179
 180     switch (sizeof(IntType)) {
 181     case 2: FB_DOBTS(h); break;
 182     case 4: FB_DOBTS(w); break;
 183     case 8: FB_DOBTS(d); break;
 184     }
 185
 186 #undef FB_DOBTS
 187 #else
 188 #error "x86 aarch64 ppc64 only"
 189 #endif
 190
 191     return ret;
 192   }
 193
 194   /*
 195    * Block until we can acquire the lock.  Uses Sleeper to wait.
 196    */
 197   void lock() const {
 198     detail::Sleeper sleeper;
 199     while (!try_lock()) {
 200       sleeper.wait();
 201     }
 202   }
 203
 204   /*
 205    * Release the lock, without changing the value of the rest of the
 206    * integer.
 207    */
 208   void unlock() const {
 209 #ifdef _MSC_VER
 210     switch (sizeof(IntType)) {
 211       case 2:
 212         // There is no _interlockedbittestandreset16 for some reason :(
 213         _InterlockedAnd16((volatile short*)&lock_, (short)~kLockBitMask_);
 214         break;
 215       case 4:
 216         _interlockedbittestandreset((volatile long*)&lock_, Bit);
 217         break;
 218       case 8:
 219         _interlockedbittestandreset64((volatile long long*)&lock_, Bit);
 220         break;
 221     }
 222 #elif FOLLY_X64
 223 #define FB_DOBTR(size)                          \
 224   asm volatile("lock; btr" #size " %0, (%1)"    \
 225                :                                \
 226                : "i" (Bit),                     \
 227                  "r" (&lock_)                   \
 228                : "memory", "flags")
 229
 230
 231     // Reads and writes can not be reordered wrt locked instructions,
 232     // so we don't need a memory fence here.
 233     switch (sizeof(IntType)) {
 234     case 2: FB_DOBTR(w); break;
 235     case 4: FB_DOBTR(l); break;
 236     case 8: FB_DOBTR(q); break;
 237     }
 238
 239 #undef FB_DOBTR
 240 #elif FOLLY_A64
 241     __atomic_fetch_and(&lock_, ~(1 << Bit), __ATOMIC_SEQ_CST);
 242 #elif FOLLY_PPC64
 243 #define FB_DOBTR(size)                                 \
 244     asm volatile("\teieio\n"                           \
 245                  "0:  l" #size "arx 14,0,%[lockPtr]\n" \
 246                  "\tli 15,1\n"                         \
 247                  "\tsldi 15,15,%[bit]\n"               \
 248                  "\txor 14,14,15\n"                    \
 249                  "\tst" #size "cx. 14,0,%[lockPtr]\n"  \
 250                  "\tbne 0b\n"                          \
 251                  "\tisync\n"                           \
 252                  :                                     \
 253                  : [lockPtr] "r"(&lock_),              \
 254                    [bit] "i" (Bit)                     \
 255                  : "cr0", "memory", "r14", "r15")
 256
 257     switch (sizeof(IntType)) {
 258     case 2: FB_DOBTR(h); break;
 259     case 4: FB_DOBTR(w); break;
 260     case 8: FB_DOBTR(d); break;
 261     }
 262
 263 #undef FB_DOBTR
 264 #else
 265 # error "x64 aarch64 ppc64 only"
 266 #endif
 267   }
 268 };
 269
 270 }