folly/futures/ManualExecutor.h

   1 /*
   2  * Copyright 2017 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
  17 #pragma once
  18
  19 #include <cstdio>
  20 #include <memory>
  21 #include <mutex>
  22 #include <queue>
  23
  24 #include <folly/LifoSem.h>
  25 #include <folly/executors/DrivableExecutor.h>
  26 #include <folly/executors/ScheduledExecutor.h>
  27
  28 namespace folly {
  29   /// A ManualExecutor only does work when you turn the crank, by calling
  30   /// run() or indirectly with makeProgress() or waitFor().
  31   ///
  32   /// The clock for a manual executor starts at 0 and advances only when you
  33   /// ask it to. i.e. time is also under manual control.
  34   ///
  35   /// NB No attempt has been made to make anything other than add and schedule
  36   /// threadsafe.
  37   class ManualExecutor : public DrivableExecutor,
  38                          public ScheduledExecutor {
  39    public:
  40     void add(Func) override;
  41
  42     /// Do work. Returns the number of functions that were executed (maybe 0).
  43     /// Non-blocking, in the sense that we don't wait for work (we can't
  44     /// control whether one of the functions blocks).
  45     /// This is stable, it will not chase an ever-increasing tail of work.
  46     /// This also means, there may be more work available to perform at the
  47     /// moment that this returns.
  48     size_t run();
  49
  50     /// Wait for work to do.
  51     void wait();
  52
  53     /// Wait for work to do, and do it.
  54     void makeProgress() {
  55       wait();
  56       run();
  57     }
  58
  59     /// Implements DrivableExecutor
  60     void drive() override {
  61       makeProgress();
  62     }
  63
  64     /// makeProgress until this Future is ready.
  65     template <class F> void waitFor(F const& f) {
  66       // TODO(5427828)
  67 #if 0
  68       while (!f.isReady())
  69         makeProgress();
  70 #else
  71       while (!f.isReady()) {
  72         run();
  73       }
  74 #endif
  75
  76     }
  77
  78     void scheduleAt(Func&& f, TimePoint const& t) override {
  79       std::lock_guard<std::mutex> lock(lock_);
  80       scheduledFuncs_.emplace(t, std::move(f));
  81       sem_.post();
  82     }
  83
  84     /// Advance the clock. The clock never advances on its own.
  85     /// Advancing the clock causes some work to be done, if work is available
  86     /// to do (perhaps newly available because of the advanced clock).
  87     /// If dur is <= 0 this is a noop.
  88     void advance(Duration const& dur) {
  89       advanceTo(now_ + dur);
  90     }
  91
  92     /// Advance the clock to this absolute time. If t is <= now(),
  93     /// this is a noop.
  94     void advanceTo(TimePoint const& t);
  95
  96     TimePoint now() override { return now_; }
  97
  98     /// Flush the function queue. Destroys all stored functions without
  99     /// executing them. Returns number of removed functions.
 100     std::size_t clear() {
 101       std::queue<Func> funcs;
 102       std::priority_queue<ScheduledFunc> scheduled_funcs;
 103
 104       {
 105         std::lock_guard<std::mutex> lock(lock_);
 106         funcs_.swap(funcs);
 107         scheduledFuncs_.swap(scheduled_funcs);
 108       }
 109
 110       return funcs.size() + scheduled_funcs.size();
 111     }
 112
 113    private:
 114     std::mutex lock_;
 115     std::queue<Func> funcs_;
 116     LifoSem sem_;
 117
 118     // helper class to enable ordering of scheduled events in the priority
 119     // queue
 120     struct ScheduledFunc {
 121       TimePoint time;
 122       size_t ordinal;
 123       Func mutable func;
 124
 125       ScheduledFunc(TimePoint const& t, Func&& f)
 126         : time(t), func(std::move(f))
 127       {
 128         static size_t seq = 0;
 129         ordinal = seq++;
 130       }
 131
 132       bool operator<(ScheduledFunc const& b) const {
 133         // Earlier-scheduled things must be *higher* priority
 134         // in the max-based std::priority_queue
 135         if (time == b.time) {
 136           return ordinal > b.ordinal;
 137         }
 138         return time > b.time;
 139       }
 140
 141       Func&& moveOutFunc() const {
 142         return std::move(func);
 143       }
 144     };
 145     std::priority_queue<ScheduledFunc> scheduledFuncs_;
 146     TimePoint now_ = TimePoint::min();
 147   };
 148
 149 }