folly/experimental/FunctionScheduler.cpp

   1 /*
   2  * Copyright 2017 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 #include <folly/experimental/FunctionScheduler.h>
  18
  19 #include <random>
  20
  21 #include <folly/Conv.h>
  22 #include <folly/Random.h>
  23 #include <folly/String.h>
  24 #include <folly/ThreadName.h>
  25
  26 using std::chrono::milliseconds;
  27 using std::chrono::steady_clock;
  28
  29 namespace folly {
  30
  31 namespace {
  32
  33 struct ConstIntervalFunctor {
  34   const milliseconds constInterval;
  35
  36   explicit ConstIntervalFunctor(milliseconds interval)
  37       : constInterval(interval) {
  38     if (interval < milliseconds::zero()) {
  39       throw std::invalid_argument(
  40           "FunctionScheduler: "
  41           "time interval must be non-negative");
  42     }
  43   }
  44
  45   milliseconds operator()() const { return constInterval; }
  46 };
  47
  48 struct PoissonDistributionFunctor {
  49   std::default_random_engine generator;
  50   std::poisson_distribution<int> poissonRandom;
  51
  52   explicit PoissonDistributionFunctor(double meanPoissonMs)
  53       : poissonRandom(meanPoissonMs) {
  54     if (meanPoissonMs < 0.0) {
  55       throw std::invalid_argument(
  56           "FunctionScheduler: "
  57           "Poisson mean interval must be non-negative");
  58     }
  59   }
  60
  61   milliseconds operator()() { return milliseconds(poissonRandom(generator)); }
  62 };
  63
  64 struct UniformDistributionFunctor {
  65   std::default_random_engine generator;
  66   std::uniform_int_distribution<milliseconds::rep> dist;
  67
  68   UniformDistributionFunctor(milliseconds minInterval, milliseconds maxInterval)
  69       : generator(Random::rand32()),
  70         dist(minInterval.count(), maxInterval.count()) {
  71     if (minInterval > maxInterval) {
  72       throw std::invalid_argument(
  73           "FunctionScheduler: "
  74           "min time interval must be less or equal than max interval");
  75     }
  76     if (minInterval < milliseconds::zero()) {
  77       throw std::invalid_argument(
  78           "FunctionScheduler: "
  79           "time interval must be non-negative");
  80     }
  81   }
  82
  83   milliseconds operator()() { return milliseconds(dist(generator)); }
  84 };
  85
  86 } // anonymous namespace
  87
  88 FunctionScheduler::FunctionScheduler() {}
  89
  90 FunctionScheduler::~FunctionScheduler() {
  91   // make sure to stop the thread (if running)
  92   shutdown();
  93 }
  94
  95 void FunctionScheduler::addFunction(Function<void()>&& cb,
  96                                     milliseconds interval,
  97                                     StringPiece nameID,
  98                                     milliseconds startDelay) {
  99   addFunctionInternal(
 100       std::move(cb),
 101       ConstIntervalFunctor(interval),
 102       nameID.str(),
 103       to<std::string>(interval.count(), "ms"),
 104       startDelay,
 105       false /*runOnce*/);
 106 }
 107
 108 void FunctionScheduler::addFunction(Function<void()>&& cb,
 109                                     milliseconds interval,
 110                                     const LatencyDistribution& latencyDistr,
 111                                     StringPiece nameID,
 112                                     milliseconds startDelay) {
 113   if (latencyDistr.isPoisson) {
 114     addFunctionInternal(
 115         std::move(cb),
 116         PoissonDistributionFunctor(latencyDistr.poissonMean),
 117         nameID.str(),
 118         to<std::string>(latencyDistr.poissonMean, "ms (Poisson mean)"),
 119         startDelay,
 120         false /*runOnce*/);
 121   } else {
 122     addFunction(std::move(cb), interval, nameID, startDelay);
 123   }
 124 }
 125
 126 void FunctionScheduler::addFunctionOnce(
 127     Function<void()>&& cb,
 128     StringPiece nameID,
 129     milliseconds startDelay) {
 130   addFunctionInternal(
 131       std::move(cb),
 132       ConstIntervalFunctor(milliseconds::zero()),
 133       nameID.str(),
 134       "once",
 135       startDelay,
 136       true /*runOnce*/);
 137 }
 138
 139 void FunctionScheduler::addFunctionUniformDistribution(
 140     Function<void()>&& cb,
 141     milliseconds minInterval,
 142     milliseconds maxInterval,
 143     StringPiece nameID,
 144     milliseconds startDelay) {
 145   addFunctionInternal(
 146       std::move(cb),
 147       UniformDistributionFunctor(minInterval, maxInterval),
 148       nameID.str(),
 149       to<std::string>(
 150           "[", minInterval.count(), " , ", maxInterval.count(), "] ms"),
 151       startDelay,
 152       false /*runOnce*/);
 153 }
 154
 155 void FunctionScheduler::addFunctionGenericDistribution(
 156     Function<void()>&& cb,
 157     IntervalDistributionFunc&& intervalFunc,
 158     const std::string& nameID,
 159     const std::string& intervalDescr,
 160     milliseconds startDelay) {
 161   addFunctionInternal(
 162       std::move(cb),
 163       std::move(intervalFunc),
 164       nameID,
 165       intervalDescr,
 166       startDelay,
 167       false /*runOnce*/);
 168 }
 169
 170 void FunctionScheduler::addFunctionInternal(
 171     Function<void()>&& cb,
 172     IntervalDistributionFunc&& intervalFunc,
 173     const std::string& nameID,
 174     const std::string& intervalDescr,
 175     milliseconds startDelay,
 176     bool runOnce) {
 177   if (!cb) {
 178     throw std::invalid_argument(
 179         "FunctionScheduler: Scheduled function must be set");
 180   }
 181   if (!intervalFunc) {
 182     throw std::invalid_argument(
 183         "FunctionScheduler: interval distribution function must be set");
 184   }
 185   if (startDelay < milliseconds::zero()) {
 186     throw std::invalid_argument(
 187         "FunctionScheduler: start delay must be non-negative");
 188   }
 189
 190   std::unique_lock<std::mutex> l(mutex_);
 191   // check if the nameID is unique
 192   for (const auto& f : functions_) {
 193     if (f.isValid() && f.name == nameID) {
 194       throw std::invalid_argument(
 195           to<std::string>("FunctionScheduler: a function named \"",
 196                           nameID,
 197                           "\" already exists"));
 198     }
 199   }
 200   if (currentFunction_ && currentFunction_->name == nameID) {
 201     throw std::invalid_argument(to<std::string>(
 202         "FunctionScheduler: a function named \"", nameID, "\" already exists"));
 203   }
 204
 205   addFunctionToHeap(
 206       l,
 207       RepeatFunc(
 208           std::move(cb),
 209           std::move(intervalFunc),
 210           nameID,
 211           intervalDescr,
 212           startDelay,
 213           runOnce));
 214 }
 215
 216 bool FunctionScheduler::cancelFunction(StringPiece nameID) {
 217   std::unique_lock<std::mutex> l(mutex_);
 218
 219   if (currentFunction_ && currentFunction_->name == nameID) {
 220     // This function is currently being run. Clear currentFunction_
 221     // The running thread will see this and won't reschedule the function.
 222     currentFunction_ = nullptr;
 223     return true;
 224   }
 225
 226   for (auto it = functions_.begin(); it != functions_.end(); ++it) {
 227     if (it->isValid() && it->name == nameID) {
 228       cancelFunction(l, it);
 229       return true;
 230     }
 231   }
 232   return false;
 233 }
 234
 235 bool FunctionScheduler::cancelFunctionAndWait(StringPiece nameID) {
 236   std::unique_lock<std::mutex> l(mutex_);
 237
 238   auto* currentFunction = currentFunction_;
 239   if (currentFunction && currentFunction->name == nameID) {
 240     runningCondvar_.wait(l, [currentFunction, this]() {
 241       return currentFunction != currentFunction_;
 242     });
 243   }
 244
 245   for (auto it = functions_.begin(); it != functions_.end(); ++it) {
 246     if (it->isValid() && it->name == nameID) {
 247       cancelFunction(l, it);
 248       return true;
 249     }
 250   }
 251   return false;
 252 }
 253
 254 void FunctionScheduler::cancelFunction(const std::unique_lock<std::mutex>& l,
 255                                        FunctionHeap::iterator it) {
 256   // This function should only be called with mutex_ already locked.
 257   DCHECK(l.mutex() == &mutex_);
 258   DCHECK(l.owns_lock());
 259
 260   if (running_) {
 261     // Internally gcc has an __adjust_heap() function to fill in a hole in the
 262     // heap.  Unfortunately it isn't part of the standard API.
 263     //
 264     // For now we just leave the RepeatFunc in our heap, but mark it as unused.
 265     // When its nextTimeInterval comes up, the runner thread will pop it from
 266     // the heap and simply throw it away.
 267     it->cancel();
 268   } else {
 269     // We're not running, so functions_ doesn't need to be maintained in heap
 270     // order.
 271     functions_.erase(it);
 272   }
 273 }
 274
 275 void FunctionScheduler::cancelAllFunctions() {
 276   std::unique_lock<std::mutex> l(mutex_);
 277   functions_.clear();
 278   currentFunction_ = nullptr;
 279 }
 280
 281 void FunctionScheduler::cancelAllFunctionsAndWait() {
 282   std::unique_lock<std::mutex> l(mutex_);
 283   if (currentFunction_) {
 284     runningCondvar_.wait(l, [this]() { return currentFunction_ == nullptr; });
 285   }
 286   functions_.clear();
 287 }
 288
 289 bool FunctionScheduler::resetFunctionTimer(StringPiece nameID) {
 290   std::unique_lock<std::mutex> l(mutex_);
 291   if (currentFunction_ && currentFunction_->name == nameID) {
 292     RepeatFunc* funcPtrCopy = currentFunction_;
 293     // This function is currently being run. Clear currentFunction_
 294     // to avoid rescheduling it, and add the function again to honor the
 295     // startDelay.
 296     currentFunction_ = nullptr;
 297     addFunctionToHeap(l, std::move(*funcPtrCopy));
 298     return true;
 299   }
 300
 301   // Since __adjust_heap() isn't a part of the standard API, there's no way to
 302   // fix the heap ordering if we adjust the key (nextRunTime) for the existing
 303   // RepeatFunc. Instead, we just cancel it and add an identical object.
 304   for (auto it = functions_.begin(); it != functions_.end(); ++it) {
 305     if (it->isValid() && it->name == nameID) {
 306       RepeatFunc funcCopy(std::move(*it));
 307       cancelFunction(l, it);
 308       addFunctionToHeap(l, std::move(funcCopy));
 309       return true;
 310     }
 311   }
 312   return false;
 313 }
 314
 315 bool FunctionScheduler::start() {
 316   std::unique_lock<std::mutex> l(mutex_);
 317   if (running_) {
 318     return false;
 319   }
 320
 321   running_ = true;
 322
 323   VLOG(1) << "Starting FunctionScheduler with " << functions_.size()
 324           << " functions.";
 325   auto now = steady_clock::now();
 326   // Reset the next run time. for all functions.
 327   // note: this is needed since one can shutdown() and start() again
 328   for (auto& f : functions_) {
 329     f.resetNextRunTime(now);
 330     VLOG(1) << "   - func: " << (f.name.empty() ? "(anon)" : f.name.c_str())
 331             << ", period = " << f.intervalDescr
 332             << ", delay = " << f.startDelay.count() << "ms";
 333   }
 334   std::make_heap(functions_.begin(), functions_.end(), fnCmp_);
 335
 336   thread_ = std::thread([&] { this->run(); });
 337   return true;
 338 }
 339
 340 bool FunctionScheduler::shutdown() {
 341   {
 342     std::lock_guard<std::mutex> g(mutex_);
 343     if (!running_) {
 344       return false;
 345     }
 346
 347     running_ = false;
 348     runningCondvar_.notify_one();
 349   }
 350   thread_.join();
 351   return true;
 352 }
 353
 354 void FunctionScheduler::run() {
 355   std::unique_lock<std::mutex> lock(mutex_);
 356
 357   if (!threadName_.empty()) {
 358     folly::setThreadName(threadName_);
 359   }
 360
 361   while (running_) {
 362     // If we have nothing to run, wait until a function is added or until we
 363     // are stopped.
 364     if (functions_.empty()) {
 365       runningCondvar_.wait(lock);
 366       continue;
 367     }
 368
 369     auto now = steady_clock::now();
 370
 371     // Move the next function to run to the end of functions_
 372     std::pop_heap(functions_.begin(), functions_.end(), fnCmp_);
 373
 374     // Check to see if the function was cancelled.
 375     // If so, just remove it and continue around the loop.
 376     if (!functions_.back().isValid()) {
 377       functions_.pop_back();
 378       continue;
 379     }
 380
 381     auto sleepTime = functions_.back().getNextRunTime() - now;
 382     if (sleepTime < milliseconds::zero()) {
 383       // We need to run this function now
 384       runOneFunction(lock, now);
 385       runningCondvar_.notify_all();
 386     } else {
 387       // Re-add the function to the heap, and wait until we actually
 388       // need to run it.
 389       std::push_heap(functions_.begin(), functions_.end(), fnCmp_);
 390       runningCondvar_.wait_for(lock, sleepTime);
 391     }
 392   }
 393 }
 394
 395 void FunctionScheduler::runOneFunction(std::unique_lock<std::mutex>& lock,
 396                                        steady_clock::time_point now) {
 397   DCHECK(lock.mutex() == &mutex_);
 398   DCHECK(lock.owns_lock());
 399
 400   // The function to run will be at the end of functions_ already.
 401   //
 402   // Fully remove it from functions_ now.
 403   // We need to release mutex_ while we invoke this function, and we need to
 404   // maintain the heap property on functions_ while mutex_ is unlocked.
 405   RepeatFunc func(std::move(functions_.back()));
 406   functions_.pop_back();
 407   if (!func.cb) {
 408     VLOG(5) << func.name << "function has been canceled while waiting";
 409     return;
 410   }
 411   currentFunction_ = &func;
 412
 413   // Update the function's next run time.
 414   if (steady_) {
 415     // This allows scheduler to catch up
 416     func.setNextRunTimeSteady();
 417   } else {
 418     // Note that we set nextRunTime based on the current time where we started
 419     // the function call, rather than the time when the function finishes.
 420     // This ensures that we call the function once every time interval, as
 421     // opposed to waiting time interval seconds between calls.  (These can be
 422     // different if the function takes a significant amount of time to run.)
 423     func.setNextRunTimeStrict(now);
 424   }
 425
 426   // Release the lock while we invoke the user's function
 427   lock.unlock();
 428
 429   // Invoke the function
 430   try {
 431     VLOG(5) << "Now running " << func.name;
 432     func.cb();
 433   } catch (const std::exception& ex) {
 434     LOG(ERROR) << "Error running the scheduled function <"
 435       << func.name << ">: " << exceptionStr(ex);
 436   }
 437
 438   // Re-acquire the lock
 439   lock.lock();
 440
 441   if (!currentFunction_) {
 442     // The function was cancelled while we were running it.
 443     // We shouldn't reschedule it;
 444     return;
 445   }
 446   if (currentFunction_->runOnce) {
 447     // Don't reschedule if the function only needed to run once.
 448     return;
 449   }
 450   // Clear currentFunction_
 451   CHECK_EQ(currentFunction_, &func);
 452   currentFunction_ = nullptr;
 453
 454   // Re-insert the function into our functions_ heap.
 455   // We only maintain the heap property while running_ is set.  (running_ may
 456   // have been cleared while we were invoking the user's function.)
 457   functions_.push_back(std::move(func));
 458   if (running_) {
 459     std::push_heap(functions_.begin(), functions_.end(), fnCmp_);
 460   }
 461 }
 462
 463 void FunctionScheduler::addFunctionToHeap(
 464     const std::unique_lock<std::mutex>& lock,
 465     RepeatFunc&& func) {
 466   // This function should only be called with mutex_ already locked.
 467   DCHECK(lock.mutex() == &mutex_);
 468   DCHECK(lock.owns_lock());
 469
 470   functions_.emplace_back(std::move(func));
 471   if (running_) {
 472     functions_.back().resetNextRunTime(steady_clock::now());
 473     std::push_heap(functions_.begin(), functions_.end(), fnCmp_);
 474     // Signal the running thread to wake up and see if it needs to change
 475     // its current scheduling decision.
 476     runningCondvar_.notify_one();
 477   }
 478 }
 479
 480 void FunctionScheduler::setThreadName(StringPiece threadName) {
 481   std::unique_lock<std::mutex> l(mutex_);
 482   threadName_ = threadName.str();
 483 }
 484
 485 }