folly/io/async/EventBase.cpp

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