folly/io/async/EventBase.cpp

   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 #ifndef __STDC_FORMAT_MACROS
  18 #define __STDC_FORMAT_MACROS
  19 #endif
  20
  21 #include <folly/io/async/EventBase.h>
  22
  23 #include <folly/ThreadName.h>
  24 #include <folly/io/async/NotificationQueue.h>
  25
  26 #include <condition_variable>
  27 #include <fcntl.h>
  28 #include <mutex>
  29 #include <pthread.h>
  30 #include <unistd.h>
  31
  32 namespace {
  33
  34 using folly::EventBase;
  35
  36 class FunctionLoopCallback : public EventBase::LoopCallback {
  37  public:
  38   explicit FunctionLoopCallback(EventBase::Func&& function)
  39       : function_(std::move(function)) {}
  40
  41   void runLoopCallback() noexcept override {
  42     function_();
  43     delete this;
  44   }
  45
  46  private:
  47   EventBase::Func function_;
  48 };
  49 }
  50
  51 namespace folly {
  52
  53 /*
  54  * EventBase::FunctionRunner
  55  */
  56
  57 class EventBase::FunctionRunner
  58     : public NotificationQueue<EventBase::Func>::Consumer {
  59  public:
  60   void messageAvailable(Func&& msg) override {
  61     // In libevent2, internal events do not break the loop.
  62     // Most users would expect loop(), followed by runInEventBaseThread(),
  63     // to break the loop and check if it should exit or not.
  64     // To have similar bejaviour to libevent1.4, tell the loop to break here.
  65     // Note that loop() may still continue to loop, but it will also check the
  66     // stop_ flag as well as runInLoop callbacks, etc.
  67     event_base_loopbreak(getEventBase()->evb_);
  68
  69     if (!msg) {
  70       // terminateLoopSoon() sends a null message just to
  71       // wake up the loop.  We can ignore these messages.
  72       return;
  73     }
  74
  75     // The function should never throw an exception, because we have no
  76     // way of knowing what sort of error handling to perform.
  77     //
  78     // If it does throw, log a message and abort the program.
  79     try {
  80       msg();
  81     } catch (const std::exception& ex) {
  82       LOG(ERROR) << "runInEventBaseThread() function threw a "
  83                  << typeid(ex).name() << " exception: " << ex.what();
  84       abort();
  85     } catch (...) {
  86       LOG(ERROR) << "runInEventBaseThread() function threw an exception";
  87       abort();
  88     }
  89   }
  90 };
  91
  92 /*
  93  * EventBase::CobTimeout methods
  94  */
  95
  96 void EventBase::CobTimeout::timeoutExpired() noexcept {
  97   // For now, we just swallow any exceptions that the callback threw.
  98   try {
  99     cob_();
 100   } catch (const std::exception& ex) {
 101     LOG(ERROR) << "EventBase::runAfterDelay() callback threw "
 102                << typeid(ex).name() << " exception: " << ex.what();
 103   } catch (...) {
 104     LOG(ERROR) << "EventBase::runAfterDelay() callback threw non-exception "
 105                << "type";
 106   }
 107
 108   // The CobTimeout object was allocated on the heap by runAfterDelay(),
 109   // so delete it now that the it has fired.
 110   delete this;
 111 }
 112
 113
 114 // The interface used to libevent is not thread-safe.  Calls to
 115 // event_init() and event_base_free() directly modify an internal
 116 // global 'current_base', so a mutex is required to protect this.
 117 //
 118 // event_init() should only ever be called once.  Subsequent calls
 119 // should be made to event_base_new().  We can recognise that
 120 // event_init() has already been called by simply inspecting current_base.
 121 static std::mutex libevent_mutex_;
 122
 123 /*
 124  * EventBase methods
 125  */
 126
 127 EventBase::EventBase(bool enableTimeMeasurement)
 128   : runOnceCallbacks_(nullptr)
 129   , stop_(false)
 130   , loopThread_()
 131   , queue_(nullptr)
 132   , fnRunner_(nullptr)
 133   , maxLatency_(0)
 134   , avgLoopTime_(2000000)
 135   , maxLatencyLoopTime_(avgLoopTime_)
 136   , enableTimeMeasurement_(enableTimeMeasurement)
 137   , nextLoopCnt_(-40)       // Early wrap-around so bugs will manifest soon
 138   , latestLoopCnt_(nextLoopCnt_)
 139   , startWork_(0)
 140   , observer_(nullptr)
 141   , observerSampleCount_(0)
 142   , executionObserver_(nullptr) {
 143   struct event ev;
 144   {
 145     std::lock_guard<std::mutex> lock(libevent_mutex_);
 146
 147     // The value 'current_base' (libevent 1) or
 148     // 'event_global_current_base_' (libevent 2) is filled in by event_set(),
 149     // allowing examination of its value without an explicit reference here.
 150     // If ev.ev_base is NULL, then event_init() must be called, otherwise
 151     // call event_base_new().
 152     event_set(&ev, 0, 0, nullptr, nullptr);
 153     if (!ev.ev_base) {
 154       evb_ = event_init();
 155     }
 156   }
 157
 158   if (ev.ev_base) {
 159     evb_ = event_base_new();
 160   }
 161
 162   if (UNLIKELY(evb_ == nullptr)) {
 163     LOG(ERROR) << "EventBase(): Failed to init event base.";
 164     folly::throwSystemError("error in EventBase::EventBase()");
 165   }
 166   VLOG(5) << "EventBase(): Created.";
 167   initNotificationQueue();
 168   RequestContext::saveContext();
 169 }
 170
 171 // takes ownership of the event_base
 172 EventBase::EventBase(event_base* evb, bool enableTimeMeasurement)
 173   : runOnceCallbacks_(nullptr)
 174   , stop_(false)
 175   , loopThread_()
 176   , evb_(evb)
 177   , queue_(nullptr)
 178   , fnRunner_(nullptr)
 179   , maxLatency_(0)
 180   , avgLoopTime_(2000000)
 181   , maxLatencyLoopTime_(avgLoopTime_)
 182   , enableTimeMeasurement_(enableTimeMeasurement)
 183   , nextLoopCnt_(-40)       // Early wrap-around so bugs will manifest soon
 184   , latestLoopCnt_(nextLoopCnt_)
 185   , startWork_(0)
 186   , observer_(nullptr)
 187   , observerSampleCount_(0)
 188   , executionObserver_(nullptr) {
 189   if (UNLIKELY(evb_ == nullptr)) {
 190     LOG(ERROR) << "EventBase(): Pass nullptr as event base.";
 191     throw std::invalid_argument("EventBase(): event base cannot be nullptr");
 192   }
 193   initNotificationQueue();
 194   RequestContext::saveContext();
 195 }
 196
 197 EventBase::~EventBase() {
 198   // Keep looping until all keep-alive handles are released. Each keep-alive
 199   // handle signals that some external code will still schedule some work on
 200   // this EventBase (so it's not safe to destroy it).
 201   while (!loopKeepAlive_.unique()) {
 202     applyLoopKeepAlive();
 203     loopOnce();
 204   }
 205
 206   // Call all destruction callbacks, before we start cleaning up our state.
 207   while (!onDestructionCallbacks_.empty()) {
 208     LoopCallback* callback = &onDestructionCallbacks_.front();
 209     onDestructionCallbacks_.pop_front();
 210     callback->runLoopCallback();
 211   }
 212
 213   // Delete any unfired callback objects, so that we don't leak memory
 214   // (Note that we don't fire them.  The caller is responsible for cleaning up
 215   // its own data structures if it destroys the EventBase with unfired events
 216   // remaining.)
 217   while (!pendingCobTimeouts_.empty()) {
 218     CobTimeout* timeout = &pendingCobTimeouts_.front();
 219     delete timeout;
 220   }
 221
 222   while (!runBeforeLoopCallbacks_.empty()) {
 223     delete &runBeforeLoopCallbacks_.front();
 224   }
 225
 226   (void) runLoopCallbacks(false);
 227
 228   if (!fnRunner_->consumeUntilDrained()) {
 229     LOG(ERROR) << "~EventBase(): Unable to drain notification queue";
 230   }
 231
 232   // Stop consumer before deleting NotificationQueue
 233   fnRunner_->stopConsuming();
 234   {
 235     std::lock_guard<std::mutex> lock(libevent_mutex_);
 236     event_base_free(evb_);
 237   }
 238
 239   while (!runAfterDrainCallbacks_.empty()) {
 240     LoopCallback* callback = &runAfterDrainCallbacks_.front();
 241     runAfterDrainCallbacks_.pop_front();
 242     callback->runLoopCallback();
 243   }
 244
 245   {
 246     std::lock_guard<std::mutex> lock(localStorageMutex_);
 247     for (auto storage : localStorageToDtor_) {
 248       storage->onEventBaseDestruction(*this);
 249     }
 250   }
 251   VLOG(5) << "EventBase(): Destroyed.";
 252 }
 253
 254 int EventBase::getNotificationQueueSize() const {
 255   return queue_->size();
 256 }
 257
 258 void EventBase::setMaxReadAtOnce(uint32_t maxAtOnce) {
 259   fnRunner_->setMaxReadAtOnce(maxAtOnce);
 260 }
 261
 262 // Set smoothing coefficient for loop load average; input is # of milliseconds
 263 // for exp(-1) decay.
 264 void EventBase::setLoadAvgMsec(uint32_t ms) {
 265   assert(enableTimeMeasurement_);
 266   uint64_t us = 1000 * ms;
 267   if (ms > 0) {
 268     maxLatencyLoopTime_.setTimeInterval(us);
 269     avgLoopTime_.setTimeInterval(us);
 270   } else {
 271     LOG(ERROR) << "non-positive arg to setLoadAvgMsec()";
 272   }
 273 }
 274
 275 void EventBase::resetLoadAvg(double value) {
 276   assert(enableTimeMeasurement_);
 277   avgLoopTime_.reset(value);
 278   maxLatencyLoopTime_.reset(value);
 279 }
 280
 281 static std::chrono::milliseconds
 282 getTimeDelta(std::chrono::steady_clock::time_point* prev) {
 283   auto result = std::chrono::steady_clock::now() - *prev;
 284   *prev = std::chrono::steady_clock::now();
 285
 286   return std::chrono::duration_cast<std::chrono::milliseconds>(result);
 287 }
 288
 289 void EventBase::waitUntilRunning() {
 290   while (!isRunning()) {
 291     sched_yield();
 292   }
 293 }
 294
 295 // enters the event_base loop -- will only exit when forced to
 296 bool EventBase::loop() {
 297   return loopBody();
 298 }
 299
 300 bool EventBase::loopOnce(int flags) {
 301   return loopBody(flags | EVLOOP_ONCE);
 302 }
 303
 304 bool EventBase::loopBody(int flags) {
 305   VLOG(5) << "EventBase(): Starting loop.";
 306   int res = 0;
 307   bool ranLoopCallbacks;
 308   bool blocking = !(flags & EVLOOP_NONBLOCK);
 309   bool once = (flags & EVLOOP_ONCE);
 310
 311   // time-measurement variables.
 312   std::chrono::steady_clock::time_point prev;
 313   int64_t idleStart = 0;
 314   int64_t busy;
 315   int64_t idle;
 316
 317   loopThread_.store(pthread_self(), std::memory_order_release);
 318
 319   if (!name_.empty()) {
 320     setThreadName(name_);
 321   }
 322
 323   if (enableTimeMeasurement_) {
 324     prev = std::chrono::steady_clock::now();
 325     idleStart = std::chrono::duration_cast<std::chrono::microseconds>(
 326       std::chrono::steady_clock::now().time_since_epoch()).count();
 327   }
 328
 329   while (!stop_.load(std::memory_order_acquire)) {
 330     applyLoopKeepAlive();
 331     ++nextLoopCnt_;
 332
 333     // Run the before loop callbacks
 334     LoopCallbackList callbacks;
 335     callbacks.swap(runBeforeLoopCallbacks_);
 336
 337     while(!callbacks.empty()) {
 338       auto* item = &callbacks.front();
 339       callbacks.pop_front();
 340       item->runLoopCallback();
 341     }
 342
 343     // nobody can add loop callbacks from within this thread if
 344     // we don't have to handle anything to start with...
 345     if (blocking && loopCallbacks_.empty()) {
 346       res = event_base_loop(evb_, EVLOOP_ONCE);
 347     } else {
 348       res = event_base_loop(evb_, EVLOOP_ONCE | EVLOOP_NONBLOCK);
 349     }
 350
 351     ranLoopCallbacks = runLoopCallbacks();
 352
 353     if (enableTimeMeasurement_) {
 354       busy = std::chrono::duration_cast<std::chrono::microseconds>(
 355         std::chrono::steady_clock::now().time_since_epoch()).count() -
 356         startWork_;
 357       idle = startWork_ - idleStart;
 358
 359       avgLoopTime_.addSample(idle, busy);
 360       maxLatencyLoopTime_.addSample(idle, busy);
 361
 362       if (observer_) {
 363         if (observerSampleCount_++ == observer_->getSampleRate()) {
 364           observerSampleCount_ = 0;
 365           observer_->loopSample(busy, idle);
 366         }
 367       }
 368
 369       VLOG(11) << "EventBase "  << this         << " did not timeout "
 370         " loop time guess: "    << busy + idle  <<
 371         " idle time: "          << idle         <<
 372         " busy time: "          << busy         <<
 373         " avgLoopTime: "        << avgLoopTime_.get() <<
 374         " maxLatencyLoopTime: " << maxLatencyLoopTime_.get() <<
 375         " maxLatency_: "        << maxLatency_ <<
 376         " notificationQueueSize: " << getNotificationQueueSize() <<
 377         " nothingHandledYet(): "<< nothingHandledYet();
 378
 379       // see if our average loop time has exceeded our limit
 380       if ((maxLatency_ > 0) &&
 381           (maxLatencyLoopTime_.get() > double(maxLatency_))) {
 382         maxLatencyCob_();
 383         // back off temporarily -- don't keep spamming maxLatencyCob_
 384         // if we're only a bit over the limit
 385         maxLatencyLoopTime_.dampen(0.9);
 386       }
 387
 388       // Our loop run did real work; reset the idle timer
 389       idleStart = std::chrono::duration_cast<std::chrono::microseconds>(
 390         std::chrono::steady_clock::now().time_since_epoch()).count();
 391     } else {
 392       VLOG(11) << "EventBase " << this << " did not timeout";
 393     }
 394
 395     // If the event loop indicate that there were no more events, and
 396     // we also didn't have any loop callbacks to run, there is nothing left to
 397     // do.
 398     if (res != 0 && !ranLoopCallbacks) {
 399       // Since Notification Queue is marked 'internal' some events may not have
 400       // run.  Run them manually if so, and continue looping.
 401       //
 402       if (getNotificationQueueSize() > 0) {
 403         fnRunner_->handlerReady(0);
 404       } else {
 405         break;
 406       }
 407     }
 408
 409     if (enableTimeMeasurement_) {
 410       VLOG(5) << "EventBase " << this << " loop time: " <<
 411         getTimeDelta(&prev).count();
 412     }
 413
 414     if (once) {
 415       break;
 416     }
 417   }
 418   // Reset stop_ so loop() can be called again
 419   stop_ = false;
 420
 421   if (res < 0) {
 422     LOG(ERROR) << "EventBase: -- error in event loop, res = " << res;
 423     return false;
 424   } else if (res == 1) {
 425     VLOG(5) << "EventBase: ran out of events (exiting loop)!";
 426   } else if (res > 1) {
 427     LOG(ERROR) << "EventBase: unknown event loop result = " << res;
 428     return false;
 429   }
 430
 431   loopThread_.store({}, std::memory_order_release);
 432
 433   VLOG(5) << "EventBase(): Done with loop.";
 434   return true;
 435 }
 436
 437 void EventBase::applyLoopKeepAlive() {
 438   if (loopKeepAliveActive_ && loopKeepAlive_.unique()) {
 439     // Restore the notification queue internal flag
 440     fnRunner_->stopConsuming();
 441     fnRunner_->startConsumingInternal(this, queue_.get());
 442     loopKeepAliveActive_ = false;
 443   } else if (!loopKeepAliveActive_ && !loopKeepAlive_.unique()) {
 444     // Update the notification queue event to treat it as a normal
 445     // (non-internal) event.  The notification queue event always remains
 446     // installed, and the main loop won't exit with it installed.
 447     fnRunner_->stopConsuming();
 448     fnRunner_->startConsuming(this, queue_.get());
 449     loopKeepAliveActive_ = true;
 450   }
 451 }
 452
 453 void EventBase::loopForever() {
 454   bool ret;
 455   {
 456     SCOPE_EXIT {
 457       applyLoopKeepAlive();
 458       loopForeverActive_ = false;
 459     };
 460     loopForeverActive_ = true;
 461     // Make sure notification queue events are treated as normal events.
 462     auto loopKeepAlive = loopKeepAlive_;
 463     ret = loop();
 464   }
 465
 466   if (!ret) {
 467     folly::throwSystemError("error in EventBase::loopForever()");
 468   }
 469 }
 470
 471 void EventBase::bumpHandlingTime() {
 472   if (!enableTimeMeasurement_) {
 473     return;
 474   }
 475
 476   VLOG(11) << "EventBase " << this << " " << __PRETTY_FUNCTION__ <<
 477     " (loop) latest " << latestLoopCnt_ << " next " << nextLoopCnt_;
 478   if (nothingHandledYet()) {
 479     latestLoopCnt_ = nextLoopCnt_;
 480     // set the time
 481     startWork_ = std::chrono::duration_cast<std::chrono::microseconds>(
 482                      std::chrono::steady_clock::now().time_since_epoch())
 483                      .count();
 484
 485     VLOG(11) << "EventBase " << this << " " << __PRETTY_FUNCTION__
 486              << " (loop) startWork_ " << startWork_;
 487   }
 488 }
 489
 490 void EventBase::terminateLoopSoon() {
 491   VLOG(5) << "EventBase(): Received terminateLoopSoon() command.";
 492
 493   // Set stop to true, so the event loop will know to exit.
 494   // TODO: We should really use an atomic operation here with a release
 495   // barrier.
 496   stop_ = true;
 497
 498   // Call event_base_loopbreak() so that libevent will exit the next time
 499   // around the loop.
 500   event_base_loopbreak(evb_);
 501
 502   // If terminateLoopSoon() is called from another thread,
 503   // the EventBase thread might be stuck waiting for events.
 504   // In this case, it won't wake up and notice that stop_ is set until it
 505   // receives another event.  Send an empty frame to the notification queue
 506   // so that the event loop will wake up even if there are no other events.
 507   //
 508   // We don't care about the return value of trySendFrame().  If it fails
 509   // this likely means the EventBase already has lots of events waiting
 510   // anyway.
 511   try {
 512     queue_->putMessage(nullptr);
 513   } catch (...) {
 514     // We don't care if putMessage() fails.  This likely means
 515     // the EventBase already has lots of events waiting anyway.
 516   }
 517 }
 518
 519 void EventBase::runInLoop(LoopCallback* callback, bool thisIteration) {
 520   DCHECK(isInEventBaseThread());
 521   callback->cancelLoopCallback();
 522   callback->context_ = RequestContext::saveContext();
 523   if (runOnceCallbacks_ != nullptr && thisIteration) {
 524     runOnceCallbacks_->push_back(*callback);
 525   } else {
 526     loopCallbacks_.push_back(*callback);
 527   }
 528 }
 529
 530 void EventBase::runInLoop(Func cob, bool thisIteration) {
 531   DCHECK(isInEventBaseThread());
 532   auto wrapper = new FunctionLoopCallback(std::move(cob));
 533   wrapper->context_ = RequestContext::saveContext();
 534   if (runOnceCallbacks_ != nullptr && thisIteration) {
 535     runOnceCallbacks_->push_back(*wrapper);
 536   } else {
 537     loopCallbacks_.push_back(*wrapper);
 538   }
 539 }
 540
 541 void EventBase::runAfterDrain(Func cob) {
 542   auto callback = new FunctionLoopCallback(std::move(cob));
 543   std::lock_guard<std::mutex> lg(runAfterDrainCallbacksMutex_);
 544   callback->cancelLoopCallback();
 545   runAfterDrainCallbacks_.push_back(*callback);
 546 }
 547
 548 void EventBase::runOnDestruction(LoopCallback* callback) {
 549   std::lock_guard<std::mutex> lg(onDestructionCallbacksMutex_);
 550   callback->cancelLoopCallback();
 551   onDestructionCallbacks_.push_back(*callback);
 552 }
 553
 554 void EventBase::runBeforeLoop(LoopCallback* callback) {
 555   DCHECK(isInEventBaseThread());
 556   callback->cancelLoopCallback();
 557   runBeforeLoopCallbacks_.push_back(*callback);
 558 }
 559
 560 bool EventBase::runInEventBaseThread(Func fn) {
 561   // Send the message.
 562   // It will be received by the FunctionRunner in the EventBase's thread.
 563
 564   // We try not to schedule nullptr callbacks
 565   if (!fn) {
 566     LOG(ERROR) << "EventBase " << this
 567                << ": Scheduling nullptr callbacks is not allowed";
 568     return false;
 569   }
 570
 571   // Short-circuit if we are already in our event base
 572   if (inRunningEventBaseThread()) {
 573     runInLoop(std::move(fn));
 574     return true;
 575
 576   }
 577
 578   try {
 579     queue_->putMessage(std::move(fn));
 580   } catch (const std::exception& ex) {
 581     LOG(ERROR) << "EventBase " << this << ": failed to schedule function "
 582                << "for EventBase thread: " << ex.what();
 583     return false;
 584   }
 585
 586   return true;
 587 }
 588
 589 bool EventBase::runInEventBaseThreadAndWait(Func fn) {
 590   if (inRunningEventBaseThread()) {
 591     LOG(ERROR) << "EventBase " << this << ": Waiting in the event loop is not "
 592                << "allowed";
 593     return false;
 594   }
 595
 596   bool ready = false;
 597   std::mutex m;
 598   std::condition_variable cv;
 599   runInEventBaseThread([&] {
 600       SCOPE_EXIT {
 601         std::unique_lock<std::mutex> l(m);
 602         ready = true;
 603         cv.notify_one();
 604         // We cannot release the lock before notify_one, because a spurious
 605         // wakeup in the waiting thread may lead to cv and m going out of scope
 606         // prematurely.
 607       };
 608       fn();
 609   });
 610   std::unique_lock<std::mutex> l(m);
 611   cv.wait(l, [&] { return ready; });
 612
 613   return true;
 614 }
 615
 616 bool EventBase::runImmediatelyOrRunInEventBaseThreadAndWait(Func fn) {
 617   if (isInEventBaseThread()) {
 618     fn();
 619     return true;
 620   } else {
 621     return runInEventBaseThreadAndWait(std::move(fn));
 622   }
 623 }
 624
 625 void EventBase::runAfterDelay(
 626     Func cob,
 627     uint32_t milliseconds,
 628     TimeoutManager::InternalEnum in) {
 629   if (!tryRunAfterDelay(std::move(cob), milliseconds, in)) {
 630     folly::throwSystemError(
 631       "error in EventBase::runAfterDelay(), failed to schedule timeout");
 632   }
 633 }
 634
 635 bool EventBase::tryRunAfterDelay(
 636     Func cob,
 637     uint32_t milliseconds,
 638     TimeoutManager::InternalEnum in) {
 639   CobTimeout* timeout = new CobTimeout(this, std::move(cob), in);
 640   if (!timeout->scheduleTimeout(milliseconds)) {
 641     delete timeout;
 642     return false;
 643   }
 644   pendingCobTimeouts_.push_back(*timeout);
 645   return true;
 646 }
 647
 648 bool EventBase::runLoopCallbacks(bool setContext) {
 649   if (!loopCallbacks_.empty()) {
 650     bumpHandlingTime();
 651     // Swap the loopCallbacks_ list with a temporary list on our stack.
 652     // This way we will only run callbacks scheduled at the time
 653     // runLoopCallbacks() was invoked.
 654     //
 655     // If any of these callbacks in turn call runInLoop() to schedule more
 656     // callbacks, those new callbacks won't be run until the next iteration
 657     // around the event loop.  This prevents runInLoop() callbacks from being
 658     // able to start file descriptor and timeout based events.
 659     LoopCallbackList currentCallbacks;
 660     currentCallbacks.swap(loopCallbacks_);
 661     runOnceCallbacks_ = &currentCallbacks;
 662
 663     while (!currentCallbacks.empty()) {
 664       LoopCallback* callback = &currentCallbacks.front();
 665       currentCallbacks.pop_front();
 666       if (setContext) {
 667         RequestContext::setContext(callback->context_);
 668       }
 669       callback->runLoopCallback();
 670     }
 671
 672     runOnceCallbacks_ = nullptr;
 673     return true;
 674   }
 675   return false;
 676 }
 677
 678 void EventBase::initNotificationQueue() {
 679   // Infinite size queue
 680   queue_.reset(new NotificationQueue<Func>());
 681
 682   // We allocate fnRunner_ separately, rather than declaring it directly
 683   // as a member of EventBase solely so that we don't need to include
 684   // NotificationQueue.h from EventBase.h
 685   fnRunner_.reset(new FunctionRunner());
 686
 687   // Mark this as an internal event, so event_base_loop() will return if
 688   // there are no other events besides this one installed.
 689   //
 690   // Most callers don't care about the internal notification queue used by
 691   // EventBase.  The queue is always installed, so if we did count the queue as
 692   // an active event, loop() would never exit with no more events to process.
 693   // Users can use loopForever() if they do care about the notification queue.
 694   // (This is useful for EventBase threads that do nothing but process
 695   // runInEventBaseThread() notifications.)
 696   fnRunner_->startConsumingInternal(this, queue_.get());
 697 }
 698
 699 void EventBase::SmoothLoopTime::setTimeInterval(uint64_t timeInterval) {
 700   expCoeff_ = -1.0/timeInterval;
 701   VLOG(11) << "expCoeff_ " << expCoeff_ << " " << __PRETTY_FUNCTION__;
 702 }
 703
 704 void EventBase::SmoothLoopTime::reset(double value) {
 705   value_ = value;
 706 }
 707
 708 void EventBase::SmoothLoopTime::addSample(int64_t idle, int64_t busy) {
 709     /*
 710      * Position at which the busy sample is considered to be taken.
 711      * (Allows to quickly skew our average without editing much code)
 712      */
 713     enum BusySamplePosition {
 714       RIGHT = 0,  // busy sample placed at the end of the iteration
 715       CENTER = 1, // busy sample placed at the middle point of the iteration
 716       LEFT = 2,   // busy sample placed at the beginning of the iteration
 717     };
 718
 719   // See http://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average
 720   // and D676020 for more info on this calculation.
 721   VLOG(11) << "idle " << idle << " oldBusyLeftover_ " << oldBusyLeftover_ <<
 722               " idle + oldBusyLeftover_ " << idle + oldBusyLeftover_ <<
 723               " busy " << busy << " " << __PRETTY_FUNCTION__;
 724   idle += oldBusyLeftover_ + busy;
 725   oldBusyLeftover_ = (busy * BusySamplePosition::CENTER) / 2;
 726   idle -= oldBusyLeftover_;
 727
 728   double coeff = exp(idle * expCoeff_);
 729   value_ *= coeff;
 730   value_ += (1.0 - coeff) * busy;
 731 }
 732
 733 bool EventBase::nothingHandledYet() const noexcept {
 734   VLOG(11) << "latest " << latestLoopCnt_ << " next " << nextLoopCnt_;
 735   return (nextLoopCnt_ != latestLoopCnt_);
 736 }
 737
 738 void EventBase::attachTimeoutManager(AsyncTimeout* obj,
 739                                       InternalEnum internal) {
 740
 741   struct event* ev = obj->getEvent();
 742   assert(ev->ev_base == nullptr);
 743
 744   event_base_set(getLibeventBase(), ev);
 745   if (internal == AsyncTimeout::InternalEnum::INTERNAL) {
 746     // Set the EVLIST_INTERNAL flag
 747     event_ref_flags(ev) |= EVLIST_INTERNAL;
 748   }
 749 }
 750
 751 void EventBase::detachTimeoutManager(AsyncTimeout* obj) {
 752   cancelTimeout(obj);
 753   struct event* ev = obj->getEvent();
 754   ev->ev_base = nullptr;
 755 }
 756
 757 bool EventBase::scheduleTimeout(AsyncTimeout* obj,
 758                                  TimeoutManager::timeout_type timeout) {
 759   assert(isInEventBaseThread());
 760   // Set up the timeval and add the event
 761   struct timeval tv;
 762   tv.tv_sec = timeout.count() / 1000LL;
 763   tv.tv_usec = (timeout.count() % 1000LL) * 1000LL;
 764
 765   struct event* ev = obj->getEvent();
 766   if (event_add(ev, &tv) < 0) {
 767     LOG(ERROR) << "EventBase: failed to schedule timeout: " << strerror(errno);
 768     return false;
 769   }
 770
 771   return true;
 772 }
 773
 774 void EventBase::cancelTimeout(AsyncTimeout* obj) {
 775   assert(isInEventBaseThread());
 776   struct event* ev = obj->getEvent();
 777   if (EventUtil::isEventRegistered(ev)) {
 778     event_del(ev);
 779   }
 780 }
 781
 782 void EventBase::setName(const std::string& name) {
 783   assert(isInEventBaseThread());
 784   name_ = name;
 785
 786   if (isRunning()) {
 787     setThreadName(loopThread_.load(std::memory_order_relaxed),
 788                   name_);
 789   }
 790 }
 791
 792 const std::string& EventBase::getName() {
 793   assert(isInEventBaseThread());
 794   return name_;
 795 }
 796
 797 const char* EventBase::getLibeventVersion() { return event_get_version(); }
 798 const char* EventBase::getLibeventMethod() { return event_get_method(); }
 799
 800 } // folly