class Concurrent::ReentrantReadWriteLock

Experimental RBS support (using type sampling data from the type_fusion project).

# sig/concurrent-ruby/concurrent/atomic/reentrant_read_write_lock.rbs

class Concurrent::ReentrantReadWriteLock < Concurrent::Synchronization::Object
  def acquire_read_lock: () -> true
end

@see docs.oracle.com/javase/7/docs/api/java/util/concurrent/locks/ReentrantReadWriteLock.html java.util.concurrent.ReentrantReadWriteLock
lock.with_write_lock { data.modify! }
lock.with_read_lock { data.retrieve }
lock = Concurrent::ReentrantReadWriteLock.new
@example
This implementation was inspired by ‘java.util.concurrent.ReentrantReadWriteLock`.
# another thread could potentially acquire a write lock.
# Now the current thread is not holding either a read or write lock, so
lock.release_read_lock
# lock. So other threads can take read locks, but not a write lock.
# At this point, the current thread is holding only a read lock, not a write
lock.release_write_lock
lock.acquire_read_lock
lock.acquire_write_lock
lock = Concurrent::ReentrantReadWriteLock.new
@example
the following code is legal:
necessary to release them in the same order they were acquired. In other words,
If both read and write locks are acquired by the same thread, it is not strictly
having both read and write lock a releasing just the write lock.
read lock and then write lock and that the lock can be downgraded by first
to proceed. Therefore the lock can be upgraded by first acquiring
actually let it go, allowing other threads which might have been waiting
write) lock is released as many times as it was acquired, will the thread
also acquire a read lock OR a write lock more than once. Only when the read (or
A thread can acquire both a read and write lock at the same time. A thread can
will also wait (so writers are not starved).
starts waiting to obtain a write lock, any additional readers that come along
will block until all the readers release their locks. However, once a thread
If another thread has taken a read lock, any thread which wants a write lock
Hence, the write lock can also be called an “exclusive” lock.)
(And while the “write” lock is taken, no read locks can be obtained either.
Allows any number of concurrent readers, but only one concurrent writer
Re-entrant read-write lock implementation

def acquire_read_lock

Experimental RBS support (using type sampling data from the type_fusion project).

def acquire_read_lock: () -> true

This signature was generated using 1 sample from 1 application.

Raises:
  • (Concurrent::ResourceLimitError) - if the maximum number of readers

Returns:
  • (Boolean) - true if the lock is successfully acquired
def acquire_read_lock
  if (held = @HeldCount.value) > 0
    # If we already have a lock, there's no need to wait
    if held & READ_LOCK_MASK == 0
      # But we do need to update the counter, if we were holding a write
      #   lock but not a read lock
      @Counter.update { |c| c + 1 }
    end
    @HeldCount.value = held + 1
    return true
  end
  while true
    c = @Counter.value
    raise ResourceLimitError.new('Too many reader threads') if max_readers?(c)
    # If a writer is waiting OR running when we first queue up, we need to wait
    if waiting_or_running_writer?(c)
      # Before going to sleep, check again with the ReadQueue mutex held
      @ReadQueue.synchronize do
        @ReadQueue.ns_wait if waiting_or_running_writer?
      end
      # Note: the above 'synchronize' block could have used #wait_until,
      #   but that waits repeatedly in a loop, checking the wait condition
      #   each time it wakes up (to protect against spurious wakeups)
      # But we are already in a loop, which is only broken when we successfully
      #   acquire the lock! So we don't care about spurious wakeups, and would
      #   rather not pay the extra overhead of using #wait_until
      # After a reader has waited once, they are allowed to "barge" ahead of waiting writers
      # But if a writer is *running*, the reader still needs to wait (naturally)
      while true
        c = @Counter.value
        if running_writer?(c)
          @ReadQueue.synchronize do
            @ReadQueue.ns_wait if running_writer?
          end
        elsif @Counter.compare_and_set(c, c+1)
          @HeldCount.value = held + 1
          return true
        end
      end
    elsif @Counter.compare_and_set(c, c+1)
      @HeldCount.value = held + 1
      return true
    end
  end
end

def acquire_write_lock

Raises:
  • (Concurrent::ResourceLimitError) - if the maximum number of writers

Returns:
  • (Boolean) - true if the lock is successfully acquired
def acquire_write_lock
  if (held = @HeldCount.value) >= WRITE_LOCK_HELD
    # if we already have a write (exclusive) lock, there's no need to wait
    @HeldCount.value = held + WRITE_LOCK_HELD
    return true
  end
  while true
    c = @Counter.value
    raise ResourceLimitError.new('Too many writer threads') if max_writers?(c)
    # To go ahead and take the lock without waiting, there must be no writer
    #   running right now, AND no writers who came before us still waiting to
    #   acquire the lock
    # Additionally, if any read locks have been taken, we must hold all of them
    if held > 0 && @Counter.compare_and_set(1, c+RUNNING_WRITER)
      # If we are the only one reader and successfully swap the RUNNING_WRITER bit on, then we can go ahead
      @HeldCount.value = held + WRITE_LOCK_HELD
      return true
    elsif @Counter.compare_and_set(c, c+WAITING_WRITER)
      while true
        # Now we have successfully incremented, so no more readers will be able to increment
        #   (they will wait instead)
        # However, readers OR writers could decrement right here
        @WriteQueue.synchronize do
          # So we have to do another check inside the synchronized section
          # If a writer OR another reader is running, then go to sleep
          c = @Counter.value
          @WriteQueue.ns_wait if running_writer?(c) || running_readers(c) != held
        end
        # Note: if you are thinking of replacing the above 'synchronize' block
        # with #wait_until, read the comment in #acquire_read_lock first!
        # We just came out of a wait
        # If we successfully turn the RUNNING_WRITER bit on with an atomic swap,
        #   then we are OK to stop waiting and go ahead
        # Otherwise go back and wait again
        c = @Counter.value
        if !running_writer?(c) &&
           running_readers(c) == held &&
           @Counter.compare_and_set(c, c+RUNNING_WRITER-WAITING_WRITER)
          @HeldCount.value = held + WRITE_LOCK_HELD
          return true
        end
      end
    end
  end
end

def initialize

Create a new `ReentrantReadWriteLock` in the unlocked state.
def initialize
  super()
  @Counter    = AtomicFixnum.new(0)       # single integer which represents lock state
  @ReadQueue  = Synchronization::Lock.new # used to queue waiting readers
  @WriteQueue = Synchronization::Lock.new # used to queue waiting writers
  @HeldCount  = LockLocalVar.new(0) # indicates # of R & W locks held by this thread
end

def max_readers?(c = @Counter.value)

@!visibility private
def max_readers?(c = @Counter.value)
  (c & MAX_READERS) == MAX_READERS
end

def max_writers?(c = @Counter.value)

@!visibility private
def max_writers?(c = @Counter.value)
  (c & MAX_WRITERS) == MAX_WRITERS
end

def release_read_lock

Returns:
  • (Boolean) - true if the lock is successfully released
def release_read_lock
  held = @HeldCount.value = @HeldCount.value - 1
  rlocks_held = held & READ_LOCK_MASK
  if rlocks_held == 0
    c = @Counter.update { |counter| counter - 1 }
    # If one or more writers were waiting, and we were the last reader, wake a writer up
    if waiting_or_running_writer?(c) && running_readers(c) == 0
      @WriteQueue.signal
    end
  elsif rlocks_held == READ_LOCK_MASK
    raise IllegalOperationError, "Cannot release a read lock which is not held"
  end
  true
end

def release_write_lock

Returns:
  • (Boolean) - true if the lock is successfully released
def release_write_lock
  held = @HeldCount.value = @HeldCount.value - WRITE_LOCK_HELD
  wlocks_held = held & WRITE_LOCK_MASK
  if wlocks_held == 0
    c = @Counter.update { |counter| counter - RUNNING_WRITER }
    @ReadQueue.broadcast
    @WriteQueue.signal if waiting_writers(c) > 0
  elsif wlocks_held == WRITE_LOCK_MASK
    raise IllegalOperationError, "Cannot release a write lock which is not held"
  end
  true
end

def running_readers(c = @Counter.value)

@!visibility private
def running_readers(c = @Counter.value)
  c & MAX_READERS
end

def running_readers?(c = @Counter.value)

@!visibility private
def running_readers?(c = @Counter.value)
  (c & MAX_READERS) > 0
end

def running_writer?(c = @Counter.value)

@!visibility private
def running_writer?(c = @Counter.value)
  c >= RUNNING_WRITER
end

def try_read_lock

Returns:
  • (Boolean) - true if the lock is successfully acquired
def try_read_lock
  if (held = @HeldCount.value) > 0
    if held & READ_LOCK_MASK == 0
      # If we hold a write lock, but not a read lock...
      @Counter.update { |c| c + 1 }
    end
    @HeldCount.value = held + 1
    return true
  else
    c = @Counter.value
    if !waiting_or_running_writer?(c) && @Counter.compare_and_set(c, c+1)
      @HeldCount.value = held + 1
      return true
    end
  end
  false
end

def try_write_lock

Returns:
  • (Boolean) - true if the lock is successfully acquired
def try_write_lock
  if (held = @HeldCount.value) >= WRITE_LOCK_HELD
    @HeldCount.value = held + WRITE_LOCK_HELD
    return true
  else
    c = @Counter.value
    if !waiting_or_running_writer?(c) &&
       running_readers(c) == held &&
       @Counter.compare_and_set(c, c+RUNNING_WRITER)
       @HeldCount.value = held + WRITE_LOCK_HELD
      return true
    end
  end
  false
end

def waiting_or_running_writer?(c = @Counter.value)

@!visibility private
def waiting_or_running_writer?(c = @Counter.value)
  c >= WAITING_WRITER
end

def waiting_writers(c = @Counter.value)

@!visibility private
def waiting_writers(c = @Counter.value)
  (c & MAX_WRITERS) >> READER_BITS
end

def with_read_lock

Raises:
  • (Concurrent::ResourceLimitError) - if the maximum number of readers
  • (ArgumentError) - when no block is given.

Returns:
  • (Object) - the result of the block operation.

Other tags:
    Yield: - the task to be performed within the lock.
def with_read_lock
  raise ArgumentError.new('no block given') unless block_given?
  acquire_read_lock
  begin
    yield
  ensure
    release_read_lock
  end
end

def with_write_lock

Raises:
  • (Concurrent::ResourceLimitError) - if the maximum number of readers
  • (ArgumentError) - when no block is given.

Returns:
  • (Object) - the result of the block operation.

Other tags:
    Yield: - the task to be performed within the lock.
def with_write_lock
  raise ArgumentError.new('no block given') unless block_given?
  acquire_write_lock
  begin
    yield
  ensure
    release_write_lock
  end
end