2 * Copyright 2014 Facebook, Inc.
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 #include <folly/io/async/AsyncTimeout.h>
20 #include <folly/io/async/DelayedDestruction.h>
22 #include <boost/intrusive/list.hpp>
23 #include <glog/logging.h>
33 * Hashed Hierarchical Wheel Timer
36 * TAsyncTimeout - a single timeout.
37 * HHWheelTimer - a set of efficient timeouts with different interval,
38 * but timeouts are not exact.
40 * All of the above are O(1) in insertion, tick update and cancel
42 * This implementation ticks once every 10ms.
43 * We model timers as the number of ticks until the next
44 * due event. We allow 32-bits of space to track this
45 * due interval, and break that into 4 regions of 8 bits.
46 * Each region indexes into a bucket of 256 lists.
48 * Bucket 0 represents those events that are due the soonest.
49 * Each tick causes us to look at the next list in a bucket.
50 * The 0th list in a bucket is special; it means that it is time to
51 * flush the timers from the next higher bucket and schedule them
52 * into a different bucket.
54 * This technique results in a very cheap mechanism for
55 * maintaining time and timers, provided that we can maintain
56 * a consistent rate of ticks.
58 class HHWheelTimer : private folly::AsyncTimeout,
59 public folly::DelayedDestruction {
61 typedef std::unique_ptr<HHWheelTimer, Destructor> UniquePtr;
64 * A callback to be notified when a timeout has expired.
75 * timeoutExpired() is invoked when the timeout has expired.
77 virtual void timeoutExpired() noexcept = 0;
79 /// This callback was canceled. The default implementation is to just
80 /// proxy to `timeoutExpired` but if you care about the difference between
81 /// the timeout finishing or being canceled you can override this.
82 virtual void callbackCanceled() noexcept {
87 * Cancel the timeout, if it is running.
89 * If the timeout is not scheduled, cancelTimeout() does nothing.
91 void cancelTimeout() {
92 if (wheel_ == nullptr) {
93 // We're not scheduled, so there's nothing to do.
100 * Return true if this timeout is currently scheduled, and false otherwise.
102 bool isScheduled() const {
103 return wheel_ != nullptr;
108 * Don't override this unless you're doing a test. This is mainly here so
109 * that we can override it to simulate lag in steady_clock.
111 virtual std::chrono::milliseconds getCurTime() {
112 return std::chrono::duration_cast<std::chrono::milliseconds>(
113 std::chrono::steady_clock::now().time_since_epoch());
117 // Get the time remaining until this timeout expires
118 std::chrono::milliseconds getTimeRemaining(
119 std::chrono::milliseconds now) const {
120 if (now >= expiration_) {
121 return std::chrono::milliseconds(0);
123 return expiration_ - now;
126 void setScheduled(HHWheelTimer* wheel,
127 std::chrono::milliseconds);
128 void cancelTimeoutImpl();
130 HHWheelTimer* wheel_;
131 std::chrono::milliseconds expiration_;
133 typedef boost::intrusive::list_member_hook<
134 boost::intrusive::link_mode<boost::intrusive::auto_unlink> > ListHook;
138 typedef boost::intrusive::list<
140 boost::intrusive::member_hook<Callback, ListHook, &Callback::hook_>,
141 boost::intrusive::constant_time_size<false> > List;
143 std::shared_ptr<RequestContext> context_;
145 // Give HHWheelTimer direct access to our members so it can take care
146 // of scheduling/cancelling.
147 friend class HHWheelTimer;
151 * Create a new HHWheelTimer with the specified interval.
153 static int DEFAULT_TICK_INTERVAL;
154 explicit HHWheelTimer(folly::EventBase* eventBase,
155 std::chrono::milliseconds intervalMS =
156 std::chrono::milliseconds(DEFAULT_TICK_INTERVAL));
159 * Destroy the HHWheelTimer.
161 * A HHWheelTimer should only be destroyed when there are no more
162 * callbacks pending in the set. (If it helps you may use cancelAll() to
163 * cancel all pending timeouts explicitly before calling this.)
165 virtual void destroy();
168 * Cancel all outstanding timeouts
170 * @returns the number of timeouts that were cancelled.
175 * Get the tick interval for this HHWheelTimer.
177 * Returns the tick interval in milliseconds.
179 std::chrono::milliseconds getTickInterval() const {
184 * Schedule the specified Callback to be invoked after the
185 * specified timeout interval.
187 * If the callback is already scheduled, this cancels the existing timeout
188 * before scheduling the new timeout.
190 void scheduleTimeout(Callback* callback,
191 std::chrono::milliseconds timeout);
192 void scheduleTimeoutImpl(Callback* callback,
193 std::chrono::milliseconds timeout);
196 void scheduleTimeoutFn(F fn, std::chrono::milliseconds timeout) {
197 struct Wrapper : Callback {
198 Wrapper(F f) : fn_(std::move(f)) {}
199 void timeoutExpired() noexcept override {
202 } catch (std::exception const& e) {
203 LOG(ERROR) << "HHWheelTimer timeout callback threw an exception: "
206 LOG(ERROR) << "HHWheelTimer timeout callback threw a non-exception.";
212 Wrapper* w = new Wrapper(std::move(fn));
213 scheduleTimeout(w, timeout);
217 * Return the number of currently pending timeouts
219 uint64_t count() const {
224 * This turns on more exact timing. By default the wheel timer
225 * increments its cached time only once everyN (default) ticks.
227 * With catchupEveryN at 1, timeouts will only be delayed until the
228 * next tick, at which point all overdue timeouts are called. The
229 * wheel timer is approximately 2x slower with this set to 1.
231 * Load testing in opt mode showed skew was about 1% with no catchup.
233 void setCatchupEveryN(uint32_t everyN) {
234 catchupEveryN_ = everyN;
237 bool isDetachable() const {
238 return !folly::AsyncTimeout::isScheduled();
241 using folly::AsyncTimeout::attachEventBase;
242 using folly::AsyncTimeout::detachEventBase;
243 using folly::AsyncTimeout::getTimeoutManager;
247 * Protected destructor.
249 * Use destroy() instead. See the comments in DelayedDestruction for more
252 virtual ~HHWheelTimer();
255 // Forbidden copy constructor and assignment operator
256 HHWheelTimer(HHWheelTimer const &) = delete;
257 HHWheelTimer& operator=(HHWheelTimer const &) = delete;
259 // Methods inherited from TAsyncTimeout
260 virtual void timeoutExpired() noexcept;
262 std::chrono::milliseconds interval_;
264 static constexpr int WHEEL_BUCKETS = 4;
265 static constexpr int WHEEL_BITS = 8;
266 static constexpr unsigned int WHEEL_SIZE = (1 << WHEEL_BITS);
267 static constexpr unsigned int WHEEL_MASK = (WHEEL_SIZE - 1);
268 static constexpr uint32_t LARGEST_SLOT = 0xffffffffUL;
270 typedef Callback::List CallbackList;
271 CallbackList buckets_[WHEEL_BUCKETS][WHEEL_SIZE];
273 int64_t timeToWheelTicks(std::chrono::milliseconds t) {
274 return t.count() / interval_.count();
277 bool cascadeTimers(int bucket, int tick);
280 std::chrono::milliseconds now_;
282 static constexpr uint32_t DEFAULT_CATCHUP_EVERY_N = 10;
284 uint32_t catchupEveryN_;
285 uint32_t expirationsSinceCatchup_;
286 bool processingCallbacksGuard_;