require "fiber"
require "fiber/pointer_linked_list_node"
require "crystal/spin_lock"

# Suspend execution until a collection of fibers are finished.
#
# The wait group is a declarative counter of how many concurrent fibers have
# been started. Each such fiber is expected to call `#done` to report that they
# are finished doing their work. Whenever the counter reaches zero the waiters
# will be resumed.
#
# This is a simpler and more efficient alternative to using a `Channel(Nil)`
# then looping a number of times until we received N messages to resume
# execution.
#
# Basic example:
#
# ```
# require "wait_group"
# wg = WaitGroup.new(5)
#
# 5.times do
#   spawn do
#     do_something
#   ensure
#     wg.done # the fiber has finished
#   end
# end
#
# # suspend the current fiber until the 5 fibers are done
# wg.wait
# ```
class WaitGroup
  # Yields a `WaitGroup` instance and waits at the end of the block for all of
  # the work enqueued inside it to complete.
  #
  # ```
  # WaitGroup.wait do |wg|
  #   items.each do |item|
  #     wg.spawn { process item }
  #   end
  # end
  # ```
  def self.wait(&) : Nil
    instance = new
    yield instance
    instance.wait
  end

  def initialize(n : Int32 = 0)
    @waiting = Crystal::PointerLinkedList(Fiber::PointerLinkedListNode).new
    @lock = Crystal::SpinLock.new
    @counter = Atomic(Int32).new(n)
  end

  # Increment the counter by 1, perform the work inside the block in a separate
  # fiber, decrementing the counter after it completes or raises. Returns the
  # `Fiber` that was spawned.
  #
  # ```
  # wg = WaitGroup.new
  # wg.spawn { do_something }
  # wg.wait
  # ```
  def spawn(*, name : String? = nil, &block) : Fiber
    add
    ::spawn(name: name) do
      block.call
    ensure
      done
    end
  end

  # Increments the counter by how many fibers we want to wait for.
  #
  # A negative value decrements the counter. When the counter reaches zero,
  # all waiting fibers will be resumed.
  # Raises `RuntimeError` if the counter reaches a negative value.
  #
  # Can be called at any time, allowing concurrent fibers to add more fibers to
  # wait for, but they must always do so before calling `#done` that would
  # decrement the counter, to make sure that the counter may never inadvertently
  # reach zero before all fibers are done.
  def add(n : Int32 = 1) : Nil
    counter = @counter.get(:acquire)

    loop do
      raise RuntimeError.new("Negative WaitGroup counter") if counter < 0

      counter, success = @counter.compare_and_set(counter, counter + n, :acquire_release, :acquire)
      break if success
    end

    new_counter = counter + n
    return if new_counter > 0

    @lock.sync do
      @waiting.consume_each do |node|
        node.value.enqueue
      end
    end

    raise RuntimeError.new("Negative WaitGroup counter") if new_counter < 0
  end

  # Decrements the counter by one. Must be called by concurrent fibers once they
  # have finished processing. When the counter reaches zero, all waiting fibers
  # will be resumed.
  def done : Nil
    add(-1)
  end

  # Suspends the current fiber until the counter reaches zero, at which point
  # the fiber will be resumed.
  #
  # Can be called from different fibers.
  def wait : Nil
    return if done?

    waiting = Fiber::PointerLinkedListNode.new(Fiber.current)

    @lock.sync do
      # must check again to avoid a race condition where #done may have
      # decremented the counter to zero between the above check and #wait
      # acquiring the lock; we'd push the current fiber to the wait list that
      # would never be resumed (oops)
      return if done?

      @waiting.push(pointerof(waiting))
    end

    Fiber.suspend

    return if done?
    raise RuntimeError.new("Positive WaitGroup counter (early wake up?)")
  end

  private def done?
    counter = @counter.get(:acquire)
    raise RuntimeError.new("Negative WaitGroup counter") if counter < 0
    counter == 0
  end
end
