folly/io/async/HHWheelTimer.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
  17 #pragma once
  18
  19 #include <folly/Optional.h>
  20 #include <folly/io/async/AsyncTimeout.h>
  21 #include <folly/io/async/DelayedDestruction.h>
  22
  23 #include <boost/intrusive/list.hpp>
  24 #include <glog/logging.h>
  25
  26 #include <chrono>
  27 #include <cstddef>
  28 #include <list>
  29 #include <memory>
  30
  31 namespace folly {
  32
  33 /**
  34  * Hashed Hierarchical Wheel Timer
  35  *
  36  * We model timers as the number of ticks until the next
  37  * due event.  We allow 32-bits of space to track this
  38  * due interval, and break that into 4 regions of 8 bits.
  39  * Each region indexes into a bucket of 256 lists.
  40  *
  41  * Bucket 0 represents those events that are due the soonest.
  42  * Each tick causes us to look at the next list in a bucket.
  43  * The 0th list in a bucket is special; it means that it is time to
  44  * flush the timers from the next higher bucket and schedule them
  45  * into a different bucket.
  46  *
  47  * This technique results in a very cheap mechanism for
  48  * maintaining time and timers.
  49  *
  50  * Unlike the original timer wheel paper, this implementation does
  51  * *not* tick constantly, and instead calculates the exact next wakeup
  52  * time.
  53  */
  54 class HHWheelTimer : private folly::AsyncTimeout,
  55                      public folly::DelayedDestruction {
  56  public:
  57   // This type has always been a misnomer, because it is not a unique pointer.
  58   using UniquePtr = std::unique_ptr<HHWheelTimer, Destructor>;
  59   using SharedPtr = std::shared_ptr<HHWheelTimer>;
  60
  61   template <typename... Args>
  62   static UniquePtr newTimer(Args&&... args) {
  63     return UniquePtr(new HHWheelTimer(std::forward<Args>(args)...));
  64   }
  65
  66   /**
  67    * A callback to be notified when a timeout has expired.
  68    */
  69   class Callback {
  70    public:
  71     Callback()
  72       : wheel_(nullptr)
  73       , expiration_(0) {}
  74
  75     virtual ~Callback();
  76
  77     /**
  78      * timeoutExpired() is invoked when the timeout has expired.
  79      */
  80     virtual void timeoutExpired() noexcept = 0;
  81
  82     /// This callback was canceled. The default implementation is to just
  83     /// proxy to `timeoutExpired` but if you care about the difference between
  84     /// the timeout finishing or being canceled you can override this.
  85     virtual void callbackCanceled() noexcept {
  86       timeoutExpired();
  87     }
  88
  89     /**
  90      * Cancel the timeout, if it is running.
  91      *
  92      * If the timeout is not scheduled, cancelTimeout() does nothing.
  93      */
  94     void cancelTimeout() {
  95       if (wheel_ == nullptr) {
  96         // We're not scheduled, so there's nothing to do.
  97         return;
  98       }
  99       cancelTimeoutImpl();
 100     }
 101
 102     /**
 103      * Return true if this timeout is currently scheduled, and false otherwise.
 104      */
 105     bool isScheduled() const {
 106       return wheel_ != nullptr;
 107     }
 108
 109    protected:
 110     /**
 111      * Don't override this unless you're doing a test. This is mainly here so
 112      * that we can override it to simulate lag in steady_clock.
 113      */
 114     virtual std::chrono::milliseconds getCurTime() {
 115       return std::chrono::duration_cast<std::chrono::milliseconds>(
 116         std::chrono::steady_clock::now().time_since_epoch());
 117     }
 118
 119    private:
 120     // Get the time remaining until this timeout expires
 121     std::chrono::milliseconds getTimeRemaining(
 122           std::chrono::milliseconds now) const {
 123       if (now >= expiration_) {
 124         return std::chrono::milliseconds(0);
 125       }
 126       return expiration_ - now;
 127     }
 128
 129     void setScheduled(HHWheelTimer* wheel,
 130                       std::chrono::milliseconds);
 131     void cancelTimeoutImpl();
 132
 133     HHWheelTimer* wheel_;
 134     std::chrono::milliseconds expiration_;
 135
 136     typedef boost::intrusive::list_member_hook<
 137       boost::intrusive::link_mode<boost::intrusive::auto_unlink> > ListHook;
 138
 139     ListHook hook_;
 140
 141     typedef boost::intrusive::list<
 142       Callback,
 143       boost::intrusive::member_hook<Callback, ListHook, &Callback::hook_>,
 144       boost::intrusive::constant_time_size<false> > List;
 145
 146     std::shared_ptr<RequestContext> context_;
 147
 148     // Give HHWheelTimer direct access to our members so it can take care
 149     // of scheduling/cancelling.
 150     friend class HHWheelTimer;
 151   };
 152
 153   /**
 154    * Create a new HHWheelTimer with the specified interval and the
 155    * default timeout value set.
 156    *
 157    * Objects created using this version of constructor can be used
 158    * to schedule both variable interval timeouts using
 159    * scheduleTimeout(callback, timeout) method, and default
 160    * interval timeouts using scheduleTimeout(callback) method.
 161    */
 162   static int DEFAULT_TICK_INTERVAL;
 163   explicit HHWheelTimer(
 164       folly::TimeoutManager* timeoutManager,
 165       std::chrono::milliseconds intervalMS =
 166           std::chrono::milliseconds(DEFAULT_TICK_INTERVAL),
 167       AsyncTimeout::InternalEnum internal = AsyncTimeout::InternalEnum::NORMAL,
 168       std::chrono::milliseconds defaultTimeoutMS =
 169           std::chrono::milliseconds(-1));
 170
 171   /**
 172    * Cancel all outstanding timeouts
 173    *
 174    * @returns the number of timeouts that were cancelled.
 175    */
 176   size_t cancelAll();
 177
 178   /**
 179    * Get the tick interval for this HHWheelTimer.
 180    *
 181    * Returns the tick interval in milliseconds.
 182    */
 183   std::chrono::milliseconds getTickInterval() const {
 184     return interval_;
 185   }
 186
 187   /**
 188    * Get the default timeout interval for this HHWheelTimer.
 189    *
 190    * Returns the timeout interval in milliseconds.
 191    */
 192   std::chrono::milliseconds getDefaultTimeout() const {
 193     return defaultTimeout_;
 194   }
 195
 196   /**
 197    * Schedule the specified Callback to be invoked after the
 198    * specified timeout interval.
 199    *
 200    * If the callback is already scheduled, this cancels the existing timeout
 201    * before scheduling the new timeout.
 202    */
 203   void scheduleTimeout(Callback* callback,
 204                        std::chrono::milliseconds timeout);
 205   void scheduleTimeoutImpl(Callback* callback,
 206                        std::chrono::milliseconds timeout);
 207
 208   /**
 209    * Schedule the specified Callback to be invoked after the
 210    * default timeout interval.
 211    *
 212    * If the callback is already scheduled, this cancels the existing timeout
 213    * before scheduling the new timeout.
 214    *
 215    * This method uses CHECK() to make sure that the default timeout was
 216    * specified on the object initialization.
 217    */
 218   void scheduleTimeout(Callback* callback);
 219
 220   template <class F>
 221   void scheduleTimeoutFn(F fn, std::chrono::milliseconds timeout) {
 222     struct Wrapper : Callback {
 223       Wrapper(F f) : fn_(std::move(f)) {}
 224       void timeoutExpired() noexcept override {
 225         try {
 226           fn_();
 227         } catch (std::exception const& e) {
 228           LOG(ERROR) << "HHWheelTimer timeout callback threw an exception: "
 229             << e.what();
 230         } catch (...) {
 231           LOG(ERROR) << "HHWheelTimer timeout callback threw a non-exception.";
 232         }
 233         delete this;
 234       }
 235       F fn_;
 236     };
 237     Wrapper* w = new Wrapper(std::move(fn));
 238     scheduleTimeout(w, timeout);
 239   }
 240
 241   /**
 242    * Return the number of currently pending timeouts
 243    */
 244   uint64_t count() const {
 245     return count_;
 246   }
 247
 248   bool isDetachable() const {
 249     return !folly::AsyncTimeout::isScheduled();
 250   }
 251
 252   using folly::AsyncTimeout::attachEventBase;
 253   using folly::AsyncTimeout::detachEventBase;
 254   using folly::AsyncTimeout::getTimeoutManager;
 255
 256  protected:
 257   /**
 258    * Protected destructor.
 259    *
 260    * Use destroy() instead.  See the comments in DelayedDestruction for more
 261    * details.
 262    */
 263   virtual ~HHWheelTimer();
 264
 265  private:
 266   // Forbidden copy constructor and assignment operator
 267   HHWheelTimer(HHWheelTimer const &) = delete;
 268   HHWheelTimer& operator=(HHWheelTimer const &) = delete;
 269
 270   // Methods inherited from AsyncTimeout
 271   virtual void timeoutExpired() noexcept;
 272
 273   std::chrono::milliseconds interval_;
 274   std::chrono::milliseconds defaultTimeout_;
 275
 276   static constexpr int WHEEL_BUCKETS = 4;
 277   static constexpr int WHEEL_BITS = 8;
 278   static constexpr unsigned int WHEEL_SIZE = (1 << WHEEL_BITS);
 279   static constexpr unsigned int WHEEL_MASK = (WHEEL_SIZE - 1);
 280   static constexpr uint32_t LARGEST_SLOT = 0xffffffffUL;
 281
 282   typedef Callback::List CallbackList;
 283   CallbackList buckets_[WHEEL_BUCKETS][WHEEL_SIZE];
 284
 285   int64_t timeToWheelTicks(std::chrono::milliseconds t) {
 286     return t.count() / interval_.count();
 287   }
 288
 289   bool cascadeTimers(int bucket, int tick);
 290   int64_t lastTick_;
 291   int64_t expireTick_;
 292   uint64_t count_;
 293   std::chrono::milliseconds startTime_;
 294
 295   int64_t calcNextTick();
 296
 297   void scheduleNextTimeout();
 298
 299   bool* processingCallbacksGuard_;
 300   CallbackList timeouts; // Timeouts queued to run
 301
 302   std::chrono::milliseconds getCurTime() {
 303     return std::chrono::duration_cast<std::chrono::milliseconds>(
 304         std::chrono::steady_clock::now().time_since_epoch());
 305   }
 306 };
 307
 308 } // folly