DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (409f3966645a)

VCS Links

Line Code
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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_recordreplay_SpinLock_h
#define mozilla_recordreplay_SpinLock_h

#include "mozilla/Assertions.h"
#include "mozilla/Atomics.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/GuardObjects.h"

#include <sched.h>

namespace mozilla {
namespace recordreplay {

// This file provides a couple of primitive lock implementations that are
// implemented using atomic operations. Using these locks does not write to any
// heap locations other than the lock's members, nor will it call any system
// locking APIs. These locks are used in places where reentrance into APIs
// needs to be avoided, or where writes to heap memory are not allowed.

// A basic spin lock.
class SpinLock
{
public:
  inline void Lock();
  inline void Unlock();

private:
  Atomic<bool, SequentiallyConsistent, Behavior::DontPreserve> mLocked;
};

// A basic read/write spin lock. This lock permits either multiple readers and
// no writers, or one writer.
class ReadWriteSpinLock
{
public:
  inline void ReadLock();
  inline void ReadUnlock();
  inline void WriteLock();
  inline void WriteUnlock();

private:
  SpinLock mLock; // Protects mReaders.
  int32_t mReaders; // -1 when in use for writing.
};

// RAII class to lock a spin lock.
struct MOZ_RAII AutoSpinLock
{
  explicit AutoSpinLock(SpinLock& aLock)
    : mLock(aLock)
  {
    mLock.Lock();
  }

  ~AutoSpinLock()
  {
    mLock.Unlock();
  }

private:
  SpinLock& mLock;
};

// RAII class to lock a read/write spin lock for reading.
struct AutoReadSpinLock
{
  explicit AutoReadSpinLock(ReadWriteSpinLock& aLock)
    : mLock(aLock)
  {
    mLock.ReadLock();
  }

  ~AutoReadSpinLock()
  {
    mLock.ReadUnlock();
  }

private:
  ReadWriteSpinLock& mLock;
};

// RAII class to lock a read/write spin lock for writing.
struct AutoWriteSpinLock
{
  explicit AutoWriteSpinLock(ReadWriteSpinLock& aLock)
    : mLock(aLock)
  {
    mLock.WriteLock();
  }

  ~AutoWriteSpinLock()
  {
    mLock.WriteUnlock();
  }

private:
  ReadWriteSpinLock& mLock;
};

///////////////////////////////////////////////////////////////////////////////
// Inline definitions
///////////////////////////////////////////////////////////////////////////////

// Try to yield execution to another thread.
static inline void
ThreadYield()
{
  sched_yield();
}

inline void
SpinLock::Lock()
{
  while (mLocked.exchange(true)) {
    ThreadYield();
  }
}

inline void
SpinLock::Unlock()
{
  DebugOnly<bool> rv = mLocked.exchange(false);
  MOZ_ASSERT(rv);
}

inline void
ReadWriteSpinLock::ReadLock()
{
  while (true) {
    AutoSpinLock ex(mLock);
    if (mReaders != -1) {
      mReaders++;
      return;
    }
  }
}

inline void
ReadWriteSpinLock::ReadUnlock()
{
  AutoSpinLock ex(mLock);
  MOZ_ASSERT(mReaders > 0);
  mReaders--;
}

inline void
ReadWriteSpinLock::WriteLock()
{
  while (true) {
    AutoSpinLock ex(mLock);
    if (mReaders == 0) {
      mReaders = -1;
      return;
    }
  }
}

inline void
ReadWriteSpinLock::WriteUnlock()
{
  AutoSpinLock ex(mLock);
  MOZ_ASSERT(mReaders == -1);
  mReaders = 0;
}

} // namespace recordreplay
} // namespace mozilla

#endif // mozilla_recordreplay_SpinLock_h