TermApp/app/src/main/cpp/yamc/yamc_latch.hpp

/*
 * yamc_latch.hpp
 *
 * MIT License
 *
 * Copyright (c) 2019 yohhoy
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef YAMC_LATCH_HPP_
#define YAMC_LATCH_HPP_

#include <cassert>
#include <cstddef>
#include <condition_variable>
#include <limits>
#include <mutex>


/*
 * Latches in C++20 Standard Library
 *
 * - yamc::latch
 */
namespace yamc {

class latch {
  std::ptrdiff_t counter_;
  mutable std::condition_variable cv_;
  mutable std::mutex mtx_;

public:
  static constexpr ptrdiff_t (max)() noexcept
  {
    return (std::numeric_limits<ptrdiff_t>::max)();
  }

  /*constexpr*/ explicit latch(std::ptrdiff_t expected)
    : counter_(expected)
  {
    assert(0 <= expected && expected < (max)());
  }

  ~latch() = default;

  latch(const latch&) = delete;
  latch& operator=(const latch&) = delete;

  void count_down(std::ptrdiff_t update = 1)
  {
    std::lock_guard<decltype(mtx_)> lk(mtx_);
    assert(0 <= update && update <= counter_);
    counter_ -= update;
    if (counter_ == 0) {
      cv_.notify_all();
    }
  }

  bool try_wait() const noexcept
  {
    std::lock_guard<decltype(mtx_)> lk(mtx_);
    // no spurious failure
    return (counter_ == 0);
  }

  void wait() const
  {
    std::unique_lock<decltype(mtx_)> lk(mtx_);
    while (counter_ != 0) {
      cv_.wait(lk);
    }
  }

  void arrive_and_wait(std::ptrdiff_t update = 1)
  {
    std::unique_lock<decltype(mtx_)> lk(mtx_);
    // equivalent to { count_down(update); wait(); }
    assert(0 <= update && update <= counter_);
    counter_ -= update;
    if (counter_ == 0) {
      cv_.notify_all();
    }
    while (counter_ != 0) {
      cv_.wait(lk);
    }
  }
};

} // namespace yamc

#endif