2 * Copyright 2017 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.
30 #include <unordered_map>
31 #include <unordered_set>
34 #include <boost/intrusive/list.hpp>
35 #include <boost/utility.hpp>
37 #include <folly/Executor.h>
38 #include <folly/Function.h>
39 #include <folly/Portability.h>
40 #include <folly/ScopeGuard.h>
41 #include <folly/experimental/ExecutionObserver.h>
42 #include <folly/futures/DrivableExecutor.h>
43 #include <folly/io/async/AsyncTimeout.h>
44 #include <folly/io/async/HHWheelTimer.h>
45 #include <folly/io/async/Request.h>
46 #include <folly/io/async/TimeoutManager.h>
47 #include <glog/logging.h>
49 #include <event.h> // libevent
53 using Cob = Func; // defined in folly/Executor.h
54 template <typename MessageT>
55 class NotificationQueue;
58 class EventBaseLocalBase;
60 class EventBaseLocalBaseBase {
62 virtual void onEventBaseDestruction(EventBase& evb) = 0;
63 virtual ~EventBaseLocalBaseBase() = default;
69 class EventBaseObserver {
71 virtual ~EventBaseObserver() = default;
73 virtual uint32_t getSampleRate() const = 0;
75 virtual void loopSample(
76 int64_t busyTime, int64_t idleTime) = 0;
79 // Helper class that sets and retrieves the EventBase associated with a given
80 // request via RequestContext. See Request.h for that mechanism.
81 class RequestEventBase : public RequestData {
83 static EventBase* get() {
84 auto data = dynamic_cast<RequestEventBase*>(
85 RequestContext::get()->getContextData(kContextDataName));
92 static void set(EventBase* eb) {
93 RequestContext::get()->setContextData(
95 std::unique_ptr<RequestEventBase>(new RequestEventBase(eb)));
99 explicit RequestEventBase(EventBase* eb) : eb_(eb) {}
101 static constexpr const char* kContextDataName{"EventBase"};
104 class VirtualEventBase;
107 * This class is a wrapper for all asynchronous I/O processing functionality
109 * EventBase provides a main loop that notifies EventHandler callback objects
110 * when I/O is ready on a file descriptor, and notifies AsyncTimeout objects
111 * when a specified timeout has expired. More complex, higher-level callback
112 * mechanisms can then be built on top of EventHandler and AsyncTimeout.
114 * A EventBase object can only drive an event loop for a single thread. To
115 * take advantage of multiple CPU cores, most asynchronous I/O servers have one
116 * thread per CPU, and use a separate EventBase for each thread.
118 * In general, most EventBase methods may only be called from the thread
119 * running the EventBase's loop. There are a few exceptions to this rule, for
120 * methods that are explicitly intended to allow communication with a
121 * EventBase from other threads. When it is safe to call a method from
122 * another thread it is explicitly listed in the method comments.
124 class EventBase : private boost::noncopyable,
125 public TimeoutManager,
126 public DrivableExecutor {
128 using Func = folly::Function<void()>;
129 using FuncRef = folly::FunctionRef<void()>;
132 * A callback interface to use with runInLoop()
134 * Derive from this class if you need to delay some code execution until the
135 * next iteration of the event loop. This allows you to schedule code to be
136 * invoked from the top-level of the loop, after your immediate callers have
139 * If a LoopCallback object is destroyed while it is scheduled to be run in
140 * the next loop iteration, it will automatically be cancelled.
143 : public boost::intrusive::list_base_hook<
144 boost::intrusive::link_mode<boost::intrusive::auto_unlink>> {
146 virtual ~LoopCallback() = default;
148 virtual void runLoopCallback() noexcept = 0;
149 void cancelLoopCallback() {
153 bool isLoopCallbackScheduled() const {
158 typedef boost::intrusive::list<
160 boost::intrusive::constant_time_size<false> > List;
162 // EventBase needs access to LoopCallbackList (and therefore to hook_)
163 friend class EventBase;
164 friend class VirtualEventBase;
165 std::shared_ptr<RequestContext> context_;
168 class FunctionLoopCallback : public LoopCallback {
170 explicit FunctionLoopCallback(Func&& function)
171 : function_(std::move(function)) {}
173 void runLoopCallback() noexcept override {
182 // Like FunctionLoopCallback, but saves one allocation. Use with caution.
184 // The caller is responsible for maintaining the lifetime of this callback
185 // until after the point at which the contained function is called.
186 class StackFunctionLoopCallback : public LoopCallback {
188 explicit StackFunctionLoopCallback(Func&& function)
189 : function_(std::move(function)) {}
190 void runLoopCallback() noexcept override {
191 Func(std::move(function_))();
199 * Create a new EventBase object.
201 * @param enableTimeMeasurement Informs whether this event base should measure
202 * time. Disabling it would likely improve
203 * performance, but will disable some features
204 * that relies on time-measurement, including:
205 * observer, max latency and avg loop time.
207 explicit EventBase(bool enableTimeMeasurement = true);
210 * Create a new EventBase object that will use the specified libevent
211 * event_base object to drive the event loop.
213 * The EventBase will take ownership of this event_base, and will call
214 * event_base_free(evb) when the EventBase is destroyed.
216 * @param enableTimeMeasurement Informs whether this event base should measure
217 * time. Disabling it would likely improve
218 * performance, but will disable some features
219 * that relies on time-measurement, including:
220 * observer, max latency and avg loop time.
222 explicit EventBase(event_base* evb, bool enableTimeMeasurement = true);
226 * Runs the event loop.
228 * loop() will loop waiting for I/O or timeouts and invoking EventHandler
229 * and AsyncTimeout callbacks as their events become ready. loop() will
230 * only return when there are no more events remaining to process, or after
231 * terminateLoopSoon() has been called.
233 * loop() may be called again to restart event processing after a previous
234 * call to loop() or loopForever() has returned.
236 * Returns true if the loop completed normally (if it processed all
237 * outstanding requests, or if terminateLoopSoon() was called). If an error
238 * occurs waiting for events, false will be returned.
243 * Wait for some events to become active, run them, then return.
245 * When EVLOOP_NONBLOCK is set in flags, the loop won't block if there
246 * are not any events to process.
248 * This is useful for callers that want to run the loop manually.
250 * Returns the same result as loop().
252 bool loopOnce(int flags = 0);
255 * Runs the event loop.
257 * loopForever() behaves like loop(), except that it keeps running even if
258 * when there are no more user-supplied EventHandlers or AsyncTimeouts
259 * registered. It will only return after terminateLoopSoon() has been
262 * This is useful for callers that want to wait for other threads to call
263 * runInEventBaseThread(), even when there are no other scheduled events.
265 * loopForever() may be called again to restart event processing after a
266 * previous call to loop() or loopForever() has returned.
268 * Throws a std::system_error if an error occurs.
273 * Causes the event loop to exit soon.
275 * This will cause an existing call to loop() or loopForever() to stop event
276 * processing and return, even if there are still events remaining to be
279 * It is safe to call terminateLoopSoon() from another thread to cause loop()
280 * to wake up and return in the EventBase loop thread. terminateLoopSoon()
281 * may also be called from the loop thread itself (for example, a
282 * EventHandler or AsyncTimeout callback may call terminateLoopSoon() to
283 * cause the loop to exit after the callback returns.) If the loop is not
284 * running, this will cause the next call to loop to terminate soon after
285 * starting. If a loop runs out of work (and so terminates on its own)
286 * concurrently with a call to terminateLoopSoon(), this may cause a race
289 * Note that the caller is responsible for ensuring that cleanup of all event
290 * callbacks occurs properly. Since terminateLoopSoon() causes the loop to
291 * exit even when there are pending events present, there may be remaining
292 * callbacks present waiting to be invoked. If the loop is later restarted
293 * pending events will continue to be processed normally, however if the
294 * EventBase is destroyed after calling terminateLoopSoon() it is the
295 * caller's responsibility to ensure that cleanup happens properly even if
296 * some outstanding events are never processed.
298 void terminateLoopSoon();
301 * Adds the given callback to a queue of things run after the current pass
302 * through the event loop completes. Note that if this callback calls
303 * runInLoop() the new callback won't be called until the main event loop
304 * has gone through a cycle.
306 * This method may only be called from the EventBase's thread. This
307 * essentially allows an event handler to schedule an additional callback to
308 * be invoked after it returns.
310 * Use runInEventBaseThread() to schedule functions from another thread.
312 * The thisIteration parameter makes this callback run in this loop
313 * iteration, instead of the next one, even if called from a
314 * runInLoop callback (normal io callbacks that call runInLoop will
315 * always run in this iteration). This was originally added to
316 * support detachEventBase, as a user callback may have called
317 * terminateLoopSoon(), but we want to make sure we detach. Also,
318 * detachEventBase almost always must be called from the base event
319 * loop to ensure the stack is unwound, since most users of
320 * EventBase are not thread safe.
322 * Ideally we would not need thisIteration, and instead just use
323 * runInLoop with loop() (instead of terminateLoopSoon).
325 void runInLoop(LoopCallback* callback, bool thisIteration = false);
328 * Convenience function to call runInLoop() with a folly::Function.
330 * This creates a LoopCallback object to wrap the folly::Function, and invoke
331 * the folly::Function when the loop callback fires. This is slightly more
332 * expensive than defining your own LoopCallback, but more convenient in
333 * areas that aren't too performance sensitive.
335 * This method may only be called from the EventBase's thread. This
336 * essentially allows an event handler to schedule an additional callback to
337 * be invoked after it returns.
339 * Use runInEventBaseThread() to schedule functions from another thread.
341 void runInLoop(Func c, bool thisIteration = false);
344 * Adds the given callback to a queue of things run before destruction
345 * of current EventBase.
347 * This allows users of EventBase that run in it, but don't control it,
348 * to be notified before EventBase gets destructed.
350 * Note: will be called from the thread that invoked EventBase destructor,
351 * before the final run of loop callbacks.
353 void runOnDestruction(LoopCallback* callback);
356 * Adds a callback that will run immediately *before* the event loop.
357 * This is very similar to runInLoop(), but will not cause the loop to break:
358 * For example, this callback could be used to get loop times.
360 void runBeforeLoop(LoopCallback* callback);
363 * Run the specified function in the EventBase's thread.
365 * This method is thread-safe, and may be called from another thread.
367 * If runInEventBaseThread() is called when the EventBase loop is not
368 * running, the function call will be delayed until the next time the loop is
371 * If runInEventBaseThread() returns true the function has successfully been
372 * scheduled to run in the loop thread. However, if the loop is terminated
373 * (and never later restarted) before it has a chance to run the requested
374 * function, the function will be run upon the EventBase's destruction.
376 * If two calls to runInEventBaseThread() are made from the same thread, the
377 * functions will always be run in the order that they were scheduled.
378 * Ordering between functions scheduled from separate threads is not
381 * @param fn The function to run. The function must not throw any
383 * @param arg An argument to pass to the function.
385 * @return Returns true if the function was successfully scheduled, or false
386 * if there was an error scheduling the function.
388 template <typename T>
389 bool runInEventBaseThread(void (*fn)(T*), T* arg);
392 * Run the specified function in the EventBase's thread
394 * This version of runInEventBaseThread() takes a folly::Function object.
395 * Note that this may be less efficient than the version that takes a plain
396 * function pointer and void* argument, if moving the function is expensive
397 * (e.g., if it wraps a lambda which captures some values with expensive move
400 * If the loop is terminated (and never later restarted) before it has a
401 * chance to run the requested function, the function will be run upon the
402 * EventBase's destruction.
404 * The function must not throw any exceptions.
406 bool runInEventBaseThread(Func fn);
409 * Like runInEventBaseThread, but the caller waits for the callback to be
412 template <typename T>
413 bool runInEventBaseThreadAndWait(void (*fn)(T*), T* arg);
416 * Like runInEventBaseThread, but the caller waits for the callback to be
419 bool runInEventBaseThreadAndWait(FuncRef fn);
422 * Like runInEventBaseThreadAndWait, except if the caller is already in the
423 * event base thread, the functor is simply run inline.
425 template <typename T>
426 bool runImmediatelyOrRunInEventBaseThreadAndWait(void (*fn)(T*), T* arg);
429 * Like runInEventBaseThreadAndWait, except if the caller is already in the
430 * event base thread, the functor is simply run inline.
432 bool runImmediatelyOrRunInEventBaseThreadAndWait(FuncRef fn);
435 * Set the maximum desired latency in us and provide a callback which will be
436 * called when that latency is exceeded.
437 * OBS: This functionality depends on time-measurement.
439 void setMaxLatency(std::chrono::microseconds maxLatency, Func maxLatencyCob) {
440 assert(enableTimeMeasurement_);
441 maxLatency_ = maxLatency;
442 maxLatencyCob_ = std::move(maxLatencyCob);
446 * Set smoothing coefficient for loop load average; # of milliseconds
447 * for exp(-1) (1/2.71828...) decay.
449 void setLoadAvgMsec(std::chrono::milliseconds ms);
452 * reset the load average to a desired value
454 void resetLoadAvg(double value = 0.0);
457 * Get the average loop time in microseconds (an exponentially-smoothed ave)
459 double getAvgLoopTime() const {
460 assert(enableTimeMeasurement_);
461 return avgLoopTime_.get();
465 * check if the event base loop is running.
467 bool isRunning() const {
468 return loopThread_.load(std::memory_order_relaxed) != std::thread::id();
472 * wait until the event loop starts (after starting the event loop thread).
474 void waitUntilRunning();
476 size_t getNotificationQueueSize() const;
478 void setMaxReadAtOnce(uint32_t maxAtOnce);
481 * Verify that current thread is the EventBase thread, if the EventBase is
484 bool isInEventBaseThread() const {
485 auto tid = loopThread_.load(std::memory_order_relaxed);
486 return tid == std::thread::id() || tid == std::this_thread::get_id();
489 bool inRunningEventBaseThread() const {
490 return loopThread_.load(std::memory_order_relaxed) ==
491 std::this_thread::get_id();
494 HHWheelTimer& timer() {
496 wheelTimer_ = HHWheelTimer::newTimer(this);
498 return *wheelTimer_.get();
501 // --------- interface to underlying libevent base ------------
502 // Avoid using these functions if possible. These functions are not
503 // guaranteed to always be present if we ever provide alternative EventBase
504 // implementations that do not use libevent internally.
505 event_base* getLibeventBase() const { return evb_; }
506 static const char* getLibeventVersion();
507 static const char* getLibeventMethod();
510 * only EventHandler/AsyncTimeout subclasses and ourselves should
513 * This is used to mark the beginning of a new loop cycle by the
514 * first handler fired within that cycle.
517 void bumpHandlingTime() override final;
519 class SmoothLoopTime {
521 explicit SmoothLoopTime(std::chrono::microseconds timeInterval)
522 : expCoeff_(-1.0 / timeInterval.count()),
524 oldBusyLeftover_(0) {
525 VLOG(11) << "expCoeff_ " << expCoeff_ << " " << __PRETTY_FUNCTION__;
528 void setTimeInterval(std::chrono::microseconds timeInterval);
529 void reset(double value = 0.0);
532 std::chrono::microseconds idle,
533 std::chrono::microseconds busy);
539 void dampen(double factor) {
546 std::chrono::microseconds oldBusyLeftover_;
549 void setObserver(const std::shared_ptr<EventBaseObserver>& observer) {
550 assert(enableTimeMeasurement_);
551 observer_ = observer;
554 const std::shared_ptr<EventBaseObserver>& getObserver() {
559 * Setup execution observation/instrumentation for every EventHandler
560 * executed in this EventBase.
562 * @param executionObserver EventHandle's execution observer.
564 void setExecutionObserver(ExecutionObserver* observer) {
565 executionObserver_ = observer;
569 * Gets the execution observer associated with this EventBase.
571 ExecutionObserver* getExecutionObserver() {
572 return executionObserver_;
576 * Set the name of the thread that runs this event base.
578 void setName(const std::string& name);
581 * Returns the name of the thread that runs this event base.
583 const std::string& getName();
585 /// Implements the Executor interface
586 void add(Cob fn) override {
587 // runInEventBaseThread() takes a const&,
588 // so no point in doing std::move here.
589 runInEventBaseThread(std::move(fn));
592 /// Implements the DrivableExecutor interface
593 void drive() override {
594 // We can't use loopKeepAlive() here since LoopKeepAlive token can only be
595 // released inside a loop.
596 ++loopKeepAliveCount_;
598 --loopKeepAliveCount_;
603 /// Returns you a handle which make loop() behave like loopForever() until
604 /// destroyed. loop() will return to its original behavior only when all
605 /// loop keep-alives are released. Loop holder is safe to release only from
606 /// EventBase thread.
607 KeepAlive getKeepAliveToken() override {
608 if (inRunningEventBaseThread()) {
609 loopKeepAliveCount_++;
611 loopKeepAliveCountAtomic_.fetch_add(1, std::memory_order_relaxed);
613 return makeKeepAlive();
617 void attachTimeoutManager(
619 TimeoutManager::InternalEnum internal) override final;
621 void detachTimeoutManager(AsyncTimeout* obj) override final;
623 bool scheduleTimeout(AsyncTimeout* obj, TimeoutManager::timeout_type timeout)
626 void cancelTimeout(AsyncTimeout* obj) override final;
628 bool isInTimeoutManagerThread() override final {
629 return isInEventBaseThread();
633 void keepAliveRelease() override {
634 DCHECK(isInEventBaseThread());
635 loopKeepAliveCount_--;
639 void applyLoopKeepAlive();
641 ssize_t loopKeepAliveCount();
644 * Helper function that tells us whether we have already handled
645 * some event/timeout/callback in this loop iteration.
647 bool nothingHandledYet() const noexcept;
649 typedef LoopCallback::List LoopCallbackList;
650 class FunctionRunner;
652 bool loopBody(int flags = 0);
654 // executes any callbacks queued by runInLoop(); returns false if none found
655 bool runLoopCallbacks();
657 void initNotificationQueue();
659 // should only be accessed through public getter
660 HHWheelTimer::UniquePtr wheelTimer_;
662 LoopCallbackList loopCallbacks_;
663 LoopCallbackList runBeforeLoopCallbacks_;
664 LoopCallbackList onDestructionCallbacks_;
666 // This will be null most of the time, but point to currentCallbacks
667 // if we are in the middle of running loop callbacks, such that
668 // runInLoop(..., true) will always run in the current loop
670 LoopCallbackList* runOnceCallbacks_;
672 // stop_ is set by terminateLoopSoon() and is used by the main loop
673 // to determine if it should exit
674 std::atomic<bool> stop_;
676 // The ID of the thread running the main loop.
677 // std::thread::id{} if loop is not running.
678 std::atomic<std::thread::id> loopThread_;
680 // pointer to underlying event_base class doing the heavy lifting
683 // A notification queue for runInEventBaseThread() to use
684 // to send function requests to the EventBase thread.
685 std::unique_ptr<NotificationQueue<Func>> queue_;
686 std::unique_ptr<FunctionRunner> fnRunner_;
687 ssize_t loopKeepAliveCount_{0};
688 std::atomic<ssize_t> loopKeepAliveCountAtomic_{0};
689 bool loopKeepAliveActive_{false};
691 // limit for latency in microseconds (0 disables)
692 std::chrono::microseconds maxLatency_;
694 // exponentially-smoothed average loop time for latency-limiting
695 SmoothLoopTime avgLoopTime_;
697 // smoothed loop time used to invoke latency callbacks; differs from
698 // avgLoopTime_ in that it's scaled down after triggering a callback
699 // to reduce spamminess
700 SmoothLoopTime maxLatencyLoopTime_;
702 // callback called when latency limit is exceeded
705 // Enables/disables time measurements in loopBody(). if disabled, the
706 // following functionality that relies on time-measurement, will not
707 // be supported: avg loop time, observer and max latency.
708 const bool enableTimeMeasurement_;
710 // Wrap-around loop counter to detect beginning of each loop
711 uint64_t nextLoopCnt_;
712 uint64_t latestLoopCnt_;
713 std::chrono::steady_clock::time_point startWork_;
714 // Prevent undefined behavior from invoking event_base_loop() reentrantly.
715 // This is needed since many projects use libevent-1.4, which lacks commit
716 // b557b175c00dc462c1fce25f6e7dd67121d2c001 from
717 // https://github.com/libevent/libevent/.
718 bool invokingLoop_{false};
720 // Observer to export counters
721 std::shared_ptr<EventBaseObserver> observer_;
722 uint32_t observerSampleCount_;
724 // EventHandler's execution observer.
725 ExecutionObserver* executionObserver_;
727 // Name of the thread running this EventBase
730 // allow runOnDestruction() to be called from any threads
731 std::mutex onDestructionCallbacksMutex_;
733 // see EventBaseLocal
734 friend class detail::EventBaseLocalBase;
735 template <typename T> friend class EventBaseLocal;
736 std::mutex localStorageMutex_;
737 std::unordered_map<uint64_t, std::shared_ptr<void>> localStorage_;
738 std::unordered_set<detail::EventBaseLocalBaseBase*> localStorageToDtor_;
741 template <typename T>
742 bool EventBase::runInEventBaseThread(void (*fn)(T*), T* arg) {
743 return runInEventBaseThread([=] { fn(arg); });
746 template <typename T>
747 bool EventBase::runInEventBaseThreadAndWait(void (*fn)(T*), T* arg) {
748 return runInEventBaseThreadAndWait([=] { fn(arg); });
751 template <typename T>
752 bool EventBase::runImmediatelyOrRunInEventBaseThreadAndWait(
755 return runImmediatelyOrRunInEventBaseThreadAndWait([=] { fn(arg); });