folly/fibers/Semaphore.h

   1 /*
   2  * Copyright 2016 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 #pragma once
  17
  18 #include <folly/Synchronized.h>
  19 #include <folly/fibers/Baton.h>
  20
  21 namespace folly {
  22 namespace fibers {
  23
  24 /*
  25  * Fiber-compatible semaphore. Will safely block fibers that wait when no
  26  * tokens are available and wake fibers when signalled.
  27  */
  28 class Semaphore {
  29  public:
  30   explicit Semaphore(size_t tokenCount) : tokens_(tokenCount) {}
  31
  32   Semaphore(const Semaphore&) = delete;
  33   Semaphore(Semaphore&&) = delete;
  34   Semaphore& operator=(const Semaphore&) = delete;
  35   Semaphore& operator=(Semaphore&&) = delete;
  36
  37   /*
  38    * Release a token in the semaphore. Signal the waiter if necessary.
  39    */
  40   void signal();
  41
  42   /*
  43    * Wait for capacity in the semaphore.
  44    */
  45   void wait();
  46
  47  private:
  48   bool waitSlow();
  49   bool signalSlow();
  50
  51   // Atomic counter
  52   std::atomic<int64_t> tokens_;
  53   folly::Synchronized<std::queue<folly::fibers::Baton*>> waitList_;
  54 };
  55
  56 } // namespace fibers
  57 } // namespace folly