2 * Copyright 2017 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <folly/experimental/FunctionScheduler.h>
21 #include <folly/Conv.h>
22 #include <folly/Random.h>
23 #include <folly/String.h>
24 #include <folly/ThreadName.h>
26 using std::chrono::milliseconds;
27 using std::chrono::steady_clock;
33 struct ConstIntervalFunctor {
34 const milliseconds constInterval;
36 explicit ConstIntervalFunctor(milliseconds interval)
37 : constInterval(interval) {
38 if (interval < milliseconds::zero()) {
39 throw std::invalid_argument(
41 "time interval must be non-negative");
45 milliseconds operator()() const { return constInterval; }
48 struct PoissonDistributionFunctor {
49 std::default_random_engine generator;
50 std::poisson_distribution<int> poissonRandom;
52 explicit PoissonDistributionFunctor(double meanPoissonMs)
53 : poissonRandom(meanPoissonMs) {
54 if (meanPoissonMs < 0.0) {
55 throw std::invalid_argument(
57 "Poisson mean interval must be non-negative");
61 milliseconds operator()() { return milliseconds(poissonRandom(generator)); }
64 struct UniformDistributionFunctor {
65 std::default_random_engine generator;
66 std::uniform_int_distribution<milliseconds::rep> dist;
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(
74 "min time interval must be less or equal than max interval");
76 if (minInterval < milliseconds::zero()) {
77 throw std::invalid_argument(
79 "time interval must be non-negative");
83 milliseconds operator()() { return milliseconds(dist(generator)); }
86 } // anonymous namespace
88 FunctionScheduler::FunctionScheduler() {}
90 FunctionScheduler::~FunctionScheduler() {
91 // make sure to stop the thread (if running)
95 void FunctionScheduler::addFunction(Function<void()>&& cb,
96 milliseconds interval,
98 milliseconds startDelay) {
101 ConstIntervalFunctor(interval),
103 to<std::string>(interval.count(), "ms"),
108 void FunctionScheduler::addFunction(Function<void()>&& cb,
109 milliseconds interval,
110 const LatencyDistribution& latencyDistr,
112 milliseconds startDelay) {
113 if (latencyDistr.isPoisson) {
116 PoissonDistributionFunctor(latencyDistr.poissonMean),
118 to<std::string>(latencyDistr.poissonMean, "ms (Poisson mean)"),
122 addFunction(std::move(cb), interval, nameID, startDelay);
126 void FunctionScheduler::addFunctionOnce(
127 Function<void()>&& cb,
129 milliseconds startDelay) {
132 ConstIntervalFunctor(milliseconds::zero()),
139 void FunctionScheduler::addFunctionUniformDistribution(
140 Function<void()>&& cb,
141 milliseconds minInterval,
142 milliseconds maxInterval,
144 milliseconds startDelay) {
147 UniformDistributionFunctor(minInterval, maxInterval),
150 "[", minInterval.count(), " , ", maxInterval.count(), "] ms"),
155 void FunctionScheduler::addFunctionGenericDistribution(
156 Function<void()>&& cb,
157 IntervalDistributionFunc&& intervalFunc,
158 const std::string& nameID,
159 const std::string& intervalDescr,
160 milliseconds startDelay) {
163 std::move(intervalFunc),
170 void FunctionScheduler::addFunctionInternal(
171 Function<void()>&& cb,
172 IntervalDistributionFunc&& intervalFunc,
173 const std::string& nameID,
174 const std::string& intervalDescr,
175 milliseconds startDelay,
178 throw std::invalid_argument(
179 "FunctionScheduler: Scheduled function must be set");
182 throw std::invalid_argument(
183 "FunctionScheduler: interval distribution function must be set");
185 if (startDelay < milliseconds::zero()) {
186 throw std::invalid_argument(
187 "FunctionScheduler: start delay must be non-negative");
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 \"",
197 "\" already exists"));
200 if (currentFunction_ && currentFunction_->name == nameID) {
201 throw std::invalid_argument(to<std::string>(
202 "FunctionScheduler: a function named \"", nameID, "\" already exists"));
209 std::move(intervalFunc),
216 bool FunctionScheduler::cancelFunction(StringPiece nameID) {
217 std::unique_lock<std::mutex> l(mutex_);
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;
226 for (auto it = functions_.begin(); it != functions_.end(); ++it) {
227 if (it->isValid() && it->name == nameID) {
228 cancelFunction(l, it);
235 bool FunctionScheduler::cancelFunctionAndWait(StringPiece nameID) {
236 std::unique_lock<std::mutex> l(mutex_);
238 auto* currentFunction = currentFunction_;
239 if (currentFunction && currentFunction->name == nameID) {
240 runningCondvar_.wait(l, [currentFunction, this]() {
241 return currentFunction != currentFunction_;
245 for (auto it = functions_.begin(); it != functions_.end(); ++it) {
246 if (it->isValid() && it->name == nameID) {
247 cancelFunction(l, it);
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());
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.
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.
269 // We're not running, so functions_ doesn't need to be maintained in heap
271 functions_.erase(it);
275 void FunctionScheduler::cancelAllFunctions() {
276 std::unique_lock<std::mutex> l(mutex_);
278 currentFunction_ = nullptr;
281 void FunctionScheduler::cancelAllFunctionsAndWait() {
282 std::unique_lock<std::mutex> l(mutex_);
283 if (currentFunction_) {
284 runningCondvar_.wait(l, [this]() { return currentFunction_ == nullptr; });
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
296 currentFunction_ = nullptr;
297 addFunctionToHeap(l, std::move(*funcPtrCopy));
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));
315 bool FunctionScheduler::start() {
316 std::unique_lock<std::mutex> l(mutex_);
321 VLOG(1) << "Starting FunctionScheduler with " << functions_.size()
323 auto now = steady_clock::now();
324 // Reset the next run time. for all functions.
325 // note: this is needed since one can shutdown() and start() again
326 for (auto& f : functions_) {
327 f.resetNextRunTime(now);
328 VLOG(1) << " - func: " << (f.name.empty() ? "(anon)" : f.name.c_str())
329 << ", period = " << f.intervalDescr
330 << ", delay = " << f.startDelay.count() << "ms";
332 std::make_heap(functions_.begin(), functions_.end(), fnCmp_);
334 thread_ = std::thread([&] { this->run(); });
340 bool FunctionScheduler::shutdown() {
342 std::lock_guard<std::mutex> g(mutex_);
348 runningCondvar_.notify_one();
354 void FunctionScheduler::run() {
355 std::unique_lock<std::mutex> lock(mutex_);
357 if (!threadName_.empty()) {
358 folly::setThreadName(threadName_);
362 // If we have nothing to run, wait until a function is added or until we
364 if (functions_.empty()) {
365 runningCondvar_.wait(lock);
369 auto now = steady_clock::now();
371 // Move the next function to run to the end of functions_
372 std::pop_heap(functions_.begin(), functions_.end(), fnCmp_);
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();
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();
387 // Re-add the function to the heap, and wait until we actually
389 std::push_heap(functions_.begin(), functions_.end(), fnCmp_);
390 runningCondvar_.wait_for(lock, sleepTime);
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());
400 // The function to run will be at the end of functions_ already.
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();
408 VLOG(5) << func.name << "function has been canceled while waiting";
411 currentFunction_ = &func;
413 // Update the function's next run time.
415 // This allows scheduler to catch up
416 func.setNextRunTimeSteady();
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);
426 // Release the lock while we invoke the user's function
429 // Invoke the function
431 VLOG(5) << "Now running " << func.name;
433 } catch (const std::exception& ex) {
434 LOG(ERROR) << "Error running the scheduled function <"
435 << func.name << ">: " << exceptionStr(ex);
438 // Re-acquire the lock
441 if (!currentFunction_) {
442 // The function was cancelled while we were running it.
443 // We shouldn't reschedule it;
446 if (currentFunction_->runOnce) {
447 // Don't reschedule if the function only needed to run once.
448 currentFunction_ = nullptr;
451 // Clear currentFunction_
452 CHECK_EQ(currentFunction_, &func);
453 currentFunction_ = nullptr;
455 // Re-insert the function into our functions_ heap.
456 // We only maintain the heap property while running_ is set. (running_ may
457 // have been cleared while we were invoking the user's function.)
458 functions_.push_back(std::move(func));
460 std::push_heap(functions_.begin(), functions_.end(), fnCmp_);
464 void FunctionScheduler::addFunctionToHeap(
465 const std::unique_lock<std::mutex>& lock,
467 // This function should only be called with mutex_ already locked.
468 DCHECK(lock.mutex() == &mutex_);
469 DCHECK(lock.owns_lock());
471 functions_.emplace_back(std::move(func));
473 functions_.back().resetNextRunTime(steady_clock::now());
474 std::push_heap(functions_.begin(), functions_.end(), fnCmp_);
475 // Signal the running thread to wake up and see if it needs to change
476 // its current scheduling decision.
477 runningCondvar_.notify_one();
481 void FunctionScheduler::setThreadName(StringPiece threadName) {
482 std::unique_lock<std::mutex> l(mutex_);
483 threadName_ = threadName.str();