folly/fibers/FiberManager-inl.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 #pragma once
  17
  18 #include <cassert>
  19
  20 #include <folly/CPortability.h>
  21 #include <folly/Memory.h>
  22 #include <folly/Optional.h>
  23 #include <folly/Portability.h>
  24 #include <folly/ScopeGuard.h>
  25 #ifdef __APPLE__
  26 #include <folly/ThreadLocal.h>
  27 #endif
  28 #include <folly/fibers/Baton.h>
  29 #include <folly/fibers/Fiber.h>
  30 #include <folly/fibers/LoopController.h>
  31 #include <folly/fibers/Promise.h>
  32 #include <folly/futures/Promise.h>
  33 #include <folly/futures/Try.h>
  34
  35 namespace folly {
  36 namespace fibers {
  37
  38 namespace {
  39
  40 inline FiberManager::Options preprocessOptions(FiberManager::Options opts) {
  41 #ifdef FOLLY_SANITIZE_ADDRESS
  42   /* ASAN needs a lot of extra stack space.
  43      16x is a conservative estimate, 8x also worked with tests
  44      where it mattered.  Note that overallocating here does not necessarily
  45      increase RSS, since unused memory is pretty much free. */
  46   opts.stackSize *= 16;
  47 #endif
  48   return opts;
  49 }
  50
  51 } // anonymous
  52
  53 inline void FiberManager::ensureLoopScheduled() {
  54   if (isLoopScheduled_) {
  55     return;
  56   }
  57
  58   isLoopScheduled_ = true;
  59   loopController_->schedule();
  60 }
  61
  62 inline intptr_t FiberManager::activateFiber(Fiber* fiber) {
  63   DCHECK_EQ(activeFiber_, (Fiber*)nullptr);
  64
  65 #ifdef FOLLY_SANITIZE_ADDRESS
  66   registerFiberActivationWithAsan(fiber);
  67 #endif
  68
  69   activeFiber_ = fiber;
  70   return jumpContext(&mainContext_, &fiber->fcontext_, fiber->data_);
  71 }
  72
  73 inline intptr_t FiberManager::deactivateFiber(Fiber* fiber) {
  74   DCHECK_EQ(activeFiber_, fiber);
  75
  76 #ifdef FOLLY_SANITIZE_ADDRESS
  77   registerFiberDeactivationWithAsan(fiber);
  78 #endif
  79
  80   activeFiber_ = nullptr;
  81   return jumpContext(&fiber->fcontext_, &mainContext_, 0);
  82 }
  83
  84 inline void FiberManager::runReadyFiber(Fiber* fiber) {
  85   SCOPE_EXIT {
  86     assert(currentFiber_ == nullptr);
  87     assert(activeFiber_ == nullptr);
  88   };
  89
  90   assert(
  91       fiber->state_ == Fiber::NOT_STARTED ||
  92       fiber->state_ == Fiber::READY_TO_RUN);
  93   currentFiber_ = fiber;
  94   fiber->rcontext_ = RequestContext::setContext(std::move(fiber->rcontext_));
  95   if (observer_) {
  96     observer_->starting(reinterpret_cast<uintptr_t>(fiber));
  97   }
  98
  99   while (fiber->state_ == Fiber::NOT_STARTED ||
 100          fiber->state_ == Fiber::READY_TO_RUN) {
 101     activateFiber(fiber);
 102     if (fiber->state_ == Fiber::AWAITING_IMMEDIATE) {
 103       try {
 104         immediateFunc_();
 105       } catch (...) {
 106         exceptionCallback_(std::current_exception(), "running immediateFunc_");
 107       }
 108       immediateFunc_ = nullptr;
 109       fiber->state_ = Fiber::READY_TO_RUN;
 110     }
 111   }
 112
 113   if (fiber->state_ == Fiber::AWAITING) {
 114     awaitFunc_(*fiber);
 115     awaitFunc_ = nullptr;
 116     if (observer_) {
 117       observer_->stopped(reinterpret_cast<uintptr_t>(fiber));
 118     }
 119     currentFiber_ = nullptr;
 120     fiber->rcontext_ = RequestContext::setContext(std::move(fiber->rcontext_));
 121   } else if (fiber->state_ == Fiber::INVALID) {
 122     assert(fibersActive_ > 0);
 123     --fibersActive_;
 124     // Making sure that task functor is deleted once task is complete.
 125     // NOTE: we must do it on main context, as the fiber is not
 126     // running at this point.
 127     fiber->func_ = nullptr;
 128     fiber->resultFunc_ = nullptr;
 129     if (fiber->finallyFunc_) {
 130       try {
 131         fiber->finallyFunc_();
 132       } catch (...) {
 133         exceptionCallback_(std::current_exception(), "running finallyFunc_");
 134       }
 135       fiber->finallyFunc_ = nullptr;
 136     }
 137     // Make sure LocalData is not accessible from its destructor
 138     if (observer_) {
 139       observer_->stopped(reinterpret_cast<uintptr_t>(fiber));
 140     }
 141     currentFiber_ = nullptr;
 142     fiber->rcontext_ = RequestContext::setContext(std::move(fiber->rcontext_));
 143     fiber->localData_.reset();
 144     fiber->rcontext_.reset();
 145
 146     if (fibersPoolSize_ < options_.maxFibersPoolSize ||
 147         options_.fibersPoolResizePeriodMs > 0) {
 148       fibersPool_.push_front(*fiber);
 149       ++fibersPoolSize_;
 150     } else {
 151       delete fiber;
 152       assert(fibersAllocated_ > 0);
 153       --fibersAllocated_;
 154     }
 155   } else if (fiber->state_ == Fiber::YIELDED) {
 156     if (observer_) {
 157       observer_->stopped(reinterpret_cast<uintptr_t>(fiber));
 158     }
 159     currentFiber_ = nullptr;
 160     fiber->rcontext_ = RequestContext::setContext(std::move(fiber->rcontext_));
 161     fiber->state_ = Fiber::READY_TO_RUN;
 162     yieldedFibers_.push_back(*fiber);
 163   }
 164 }
 165
 166 inline bool FiberManager::loopUntilNoReady() {
 167   if (UNLIKELY(!alternateSignalStackRegistered_)) {
 168     registerAlternateSignalStack();
 169   }
 170
 171   // Support nested FiberManagers
 172   auto originalFiberManager = this;
 173   std::swap(currentFiberManager_, originalFiberManager);
 174
 175   SCOPE_EXIT {
 176     isLoopScheduled_ = false;
 177     if (!readyFibers_.empty()) {
 178       ensureLoopScheduled();
 179     }
 180     std::swap(currentFiberManager_, originalFiberManager);
 181     CHECK_EQ(this, originalFiberManager);
 182   };
 183
 184   bool hadRemoteFiber = true;
 185   while (hadRemoteFiber) {
 186     hadRemoteFiber = false;
 187
 188     while (!readyFibers_.empty()) {
 189       auto& fiber = readyFibers_.front();
 190       readyFibers_.pop_front();
 191       runReadyFiber(&fiber);
 192     }
 193
 194     remoteReadyQueue_.sweep([this, &hadRemoteFiber](Fiber* fiber) {
 195       runReadyFiber(fiber);
 196       hadRemoteFiber = true;
 197     });
 198
 199     remoteTaskQueue_.sweep([this, &hadRemoteFiber](RemoteTask* taskPtr) {
 200       std::unique_ptr<RemoteTask> task(taskPtr);
 201       auto fiber = getFiber();
 202       if (task->localData) {
 203         fiber->localData_ = *task->localData;
 204       }
 205       fiber->rcontext_ = std::move(task->rcontext);
 206
 207       fiber->setFunction(std::move(task->func));
 208       fiber->data_ = reinterpret_cast<intptr_t>(fiber);
 209       if (observer_) {
 210         observer_->runnable(reinterpret_cast<uintptr_t>(fiber));
 211       }
 212       runReadyFiber(fiber);
 213       hadRemoteFiber = true;
 214     });
 215   }
 216
 217   if (observer_) {
 218     for (auto& yielded : yieldedFibers_) {
 219       observer_->runnable(reinterpret_cast<uintptr_t>(&yielded));
 220     }
 221   }
 222   readyFibers_.splice(readyFibers_.end(), yieldedFibers_);
 223
 224   return fibersActive_ > 0;
 225 }
 226
 227 // We need this to be in a struct, not inlined in addTask, because clang crashes
 228 // otherwise.
 229 template <typename F>
 230 struct FiberManager::AddTaskHelper {
 231   class Func;
 232
 233   static constexpr bool allocateInBuffer =
 234       sizeof(Func) <= Fiber::kUserBufferSize;
 235
 236   class Func {
 237    public:
 238     Func(F&& func, FiberManager& fm) : func_(std::forward<F>(func)), fm_(fm) {}
 239
 240     void operator()() {
 241       try {
 242         func_();
 243       } catch (...) {
 244         fm_.exceptionCallback_(
 245             std::current_exception(), "running Func functor");
 246       }
 247       if (allocateInBuffer) {
 248         this->~Func();
 249       } else {
 250         delete this;
 251       }
 252     }
 253
 254    private:
 255     F func_;
 256     FiberManager& fm_;
 257   };
 258 };
 259
 260 template <typename F>
 261 void FiberManager::addTask(F&& func) {
 262   typedef AddTaskHelper<F> Helper;
 263
 264   auto fiber = getFiber();
 265   initLocalData(*fiber);
 266
 267   if (Helper::allocateInBuffer) {
 268     auto funcLoc = static_cast<typename Helper::Func*>(fiber->getUserBuffer());
 269     new (funcLoc) typename Helper::Func(std::forward<F>(func), *this);
 270
 271     fiber->setFunction(std::ref(*funcLoc));
 272   } else {
 273     auto funcLoc = new typename Helper::Func(std::forward<F>(func), *this);
 274
 275     fiber->setFunction(std::ref(*funcLoc));
 276   }
 277
 278   fiber->data_ = reinterpret_cast<intptr_t>(fiber);
 279   readyFibers_.push_back(*fiber);
 280   if (observer_) {
 281     observer_->runnable(reinterpret_cast<uintptr_t>(fiber));
 282   }
 283
 284   ensureLoopScheduled();
 285 }
 286
 287 template <typename F>
 288 auto FiberManager::addTaskFuture(F&& func) -> folly::Future<
 289     typename folly::Unit::Lift<typename std::result_of<F()>::type>::type> {
 290   using T = typename std::result_of<F()>::type;
 291   using FutureT = typename folly::Unit::Lift<T>::type;
 292
 293   folly::Promise<FutureT> p;
 294   auto f = p.getFuture();
 295   addTaskFinally(
 296       [func = std::forward<F>(func)]() mutable { return func(); },
 297       [p = std::move(p)](folly::Try<T> && t) mutable {
 298         p.setTry(std::move(t));
 299       });
 300   return f;
 301 }
 302
 303 template <typename F>
 304 void FiberManager::addTaskRemote(F&& func) {
 305   auto task = [&]() {
 306     auto currentFm = getFiberManagerUnsafe();
 307     if (currentFm && currentFm->currentFiber_ &&
 308         currentFm->localType_ == localType_) {
 309       return folly::make_unique<RemoteTask>(
 310           std::forward<F>(func), currentFm->currentFiber_->localData_);
 311     }
 312     return folly::make_unique<RemoteTask>(std::forward<F>(func));
 313   }();
 314   auto insertHead = [&]() {
 315     return remoteTaskQueue_.insertHead(task.release());
 316   };
 317   loopController_->scheduleThreadSafe(std::ref(insertHead));
 318 }
 319
 320 template <typename F>
 321 auto FiberManager::addTaskRemoteFuture(F&& func) -> folly::Future<
 322     typename folly::Unit::Lift<typename std::result_of<F()>::type>::type> {
 323   folly::Promise<
 324       typename folly::Unit::Lift<typename std::result_of<F()>::type>::type>
 325       p;
 326   auto f = p.getFuture();
 327   addTaskRemote(
 328       [ p = std::move(p), func = std::forward<F>(func), this ]() mutable {
 329         auto t = folly::makeTryWith(std::forward<F>(func));
 330         runInMainContext([&]() { p.setTry(std::move(t)); });
 331       });
 332   return f;
 333 }
 334
 335 template <typename X>
 336 struct IsRvalueRefTry {
 337   static const bool value = false;
 338 };
 339 template <typename T>
 340 struct IsRvalueRefTry<folly::Try<T>&&> {
 341   static const bool value = true;
 342 };
 343
 344 // We need this to be in a struct, not inlined in addTaskFinally, because clang
 345 // crashes otherwise.
 346 template <typename F, typename G>
 347 struct FiberManager::AddTaskFinallyHelper {
 348   class Func;
 349
 350   typedef typename std::result_of<F()>::type Result;
 351
 352   class Finally {
 353    public:
 354     Finally(G finally, FiberManager& fm)
 355         : finally_(std::move(finally)), fm_(fm) {}
 356
 357     void operator()() {
 358       try {
 359         finally_(std::move(*result_));
 360       } catch (...) {
 361         fm_.exceptionCallback_(
 362             std::current_exception(), "running Finally functor");
 363       }
 364
 365       if (allocateInBuffer) {
 366         this->~Finally();
 367       } else {
 368         delete this;
 369       }
 370     }
 371
 372    private:
 373     friend class Func;
 374
 375     G finally_;
 376     folly::Optional<folly::Try<Result>> result_;
 377     FiberManager& fm_;
 378   };
 379
 380   class Func {
 381    public:
 382     Func(F func, Finally& finally)
 383         : func_(std::move(func)), result_(finally.result_) {}
 384
 385     void operator()() {
 386       result_ = folly::makeTryWith(std::move(func_));
 387
 388       if (allocateInBuffer) {
 389         this->~Func();
 390       } else {
 391         delete this;
 392       }
 393     }
 394
 395    private:
 396     F func_;
 397     folly::Optional<folly::Try<Result>>& result_;
 398   };
 399
 400   static constexpr bool allocateInBuffer =
 401       sizeof(Func) + sizeof(Finally) <= Fiber::kUserBufferSize;
 402 };
 403
 404 template <typename F, typename G>
 405 void FiberManager::addTaskFinally(F&& func, G&& finally) {
 406   typedef typename std::result_of<F()>::type Result;
 407
 408   static_assert(
 409       IsRvalueRefTry<typename FirstArgOf<G>::type>::value,
 410       "finally(arg): arg must be Try<T>&&");
 411   static_assert(
 412       std::is_convertible<
 413           Result,
 414           typename std::remove_reference<
 415               typename FirstArgOf<G>::type>::type::element_type>::value,
 416       "finally(Try<T>&&): T must be convertible from func()'s return type");
 417
 418   auto fiber = getFiber();
 419   initLocalData(*fiber);
 420
 421   typedef AddTaskFinallyHelper<
 422       typename std::decay<F>::type,
 423       typename std::decay<G>::type>
 424       Helper;
 425
 426   if (Helper::allocateInBuffer) {
 427     auto funcLoc = static_cast<typename Helper::Func*>(fiber->getUserBuffer());
 428     auto finallyLoc =
 429         static_cast<typename Helper::Finally*>(static_cast<void*>(funcLoc + 1));
 430
 431     new (finallyLoc) typename Helper::Finally(std::forward<G>(finally), *this);
 432     new (funcLoc) typename Helper::Func(std::forward<F>(func), *finallyLoc);
 433
 434     fiber->setFunctionFinally(std::ref(*funcLoc), std::ref(*finallyLoc));
 435   } else {
 436     auto finallyLoc =
 437         new typename Helper::Finally(std::forward<G>(finally), *this);
 438     auto funcLoc =
 439         new typename Helper::Func(std::forward<F>(func), *finallyLoc);
 440
 441     fiber->setFunctionFinally(std::ref(*funcLoc), std::ref(*finallyLoc));
 442   }
 443
 444   fiber->data_ = reinterpret_cast<intptr_t>(fiber);
 445   readyFibers_.push_back(*fiber);
 446   if (observer_) {
 447     observer_->runnable(reinterpret_cast<uintptr_t>(fiber));
 448   }
 449
 450   ensureLoopScheduled();
 451 }
 452
 453 template <typename F>
 454 typename std::result_of<F()>::type FiberManager::runInMainContext(F&& func) {
 455   if (UNLIKELY(activeFiber_ == nullptr)) {
 456     return func();
 457   }
 458
 459   typedef typename std::result_of<F()>::type Result;
 460
 461   folly::Try<Result> result;
 462   auto f = [&func, &result]() mutable {
 463     result = folly::makeTryWith(std::forward<F>(func));
 464   };
 465
 466   immediateFunc_ = std::ref(f);
 467   activeFiber_->preempt(Fiber::AWAITING_IMMEDIATE);
 468
 469   return std::move(result).value();
 470 }
 471
 472 inline FiberManager& FiberManager::getFiberManager() {
 473   assert(currentFiberManager_ != nullptr);
 474   return *currentFiberManager_;
 475 }
 476
 477 inline FiberManager* FiberManager::getFiberManagerUnsafe() {
 478   return currentFiberManager_;
 479 }
 480
 481 inline bool FiberManager::hasActiveFiber() const {
 482   return activeFiber_ != nullptr;
 483 }
 484
 485 inline void FiberManager::yield() {
 486   assert(currentFiberManager_ == this);
 487   assert(activeFiber_ != nullptr);
 488   assert(activeFiber_->state_ == Fiber::RUNNING);
 489   activeFiber_->preempt(Fiber::YIELDED);
 490 }
 491
 492 template <typename T>
 493 T& FiberManager::local() {
 494   if (std::type_index(typeid(T)) == localType_ && currentFiber_) {
 495     return currentFiber_->localData_.get<T>();
 496   }
 497   return localThread<T>();
 498 }
 499
 500 template <typename T>
 501 T& FiberManager::localThread() {
 502 #ifndef __APPLE__
 503   static thread_local T t;
 504   return t;
 505 #else // osx doesn't support thread_local
 506   static ThreadLocal<T> t;
 507   return *t;
 508 #endif
 509 }
 510
 511 inline void FiberManager::initLocalData(Fiber& fiber) {
 512   auto fm = getFiberManagerUnsafe();
 513   if (fm && fm->currentFiber_ && fm->localType_ == localType_) {
 514     fiber.localData_ = fm->currentFiber_->localData_;
 515   }
 516   fiber.rcontext_ = RequestContext::saveContext();
 517 }
 518
 519 template <typename LocalT>
 520 FiberManager::FiberManager(
 521     LocalType<LocalT>,
 522     std::unique_ptr<LoopController> loopController__,
 523     Options options)
 524     : loopController_(std::move(loopController__)),
 525       stackAllocator_(options.useGuardPages),
 526       options_(preprocessOptions(std::move(options))),
 527       exceptionCallback_([](std::exception_ptr eptr, std::string context) {
 528         try {
 529           std::rethrow_exception(eptr);
 530         } catch (const std::exception& e) {
 531           LOG(DFATAL) << "Exception " << typeid(e).name() << " with message '"
 532                       << e.what() << "' was thrown in "
 533                       << "FiberManager with context '" << context << "'";
 534         } catch (...) {
 535           LOG(DFATAL) << "Unknown exception was thrown in FiberManager with "
 536                       << "context '" << context << "'";
 537         }
 538       }),
 539       timeoutManager_(std::make_shared<TimeoutController>(*loopController_)),
 540       fibersPoolResizer_(*this),
 541       localType_(typeid(LocalT)) {
 542   loopController_->setFiberManager(this);
 543 }
 544
 545 template <typename F>
 546 typename FirstArgOf<F>::type::value_type inline await(F&& func) {
 547   typedef typename FirstArgOf<F>::type::value_type Result;
 548
 549   return Promise<Result>::await(std::forward<F>(func));
 550 }
 551 }
 552 }