fune/xpcom/threads/DelayedRunnable.cpp
Andreas Pehrson 6f3e18ab53 Bug 1746361 - Gecko Profiler: Track wrapped runnables throughout the tree. r=gerald
The Runnable markers in the profilers are handy, but miss many types of
runnables. This includes most of those that wrap another runnable and run that
at a (possibly) later time.

AbstractThread, TaskDispatcher and TaskQueue does this for e.g. tail dispatched
tasks.

TaskQueueWrapper does this when wrapping webrtc tasks (and Mozilla Runnables) to
be run in a Mozilla TaskQueue with some overhead on the stack.

DelayedRunnable wraps a runnable to be run after a timeout.

It would perhaps be better in many cases to ignore the intermediate runnables,
but I haven't seen a straight forward way to achieve this.

More detailed data could be added on a case by case basis, for instance the
delay for a DelayedRunnable (incl. actual vs. target delay) or the scope of a
task in which a tail-dispatched runnable was dispatched. But this is also true
for the status quo (for instance the time from dispatch to run) so I leave these
ideas as future work.

Differential Revision: https://phabricator.services.mozilla.com/D135027
2022-01-05 15:26:24 +00:00

76 lines
2.2 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "DelayedRunnable.h"
#include "mozilla/ProfilerRunnable.h"
namespace mozilla {
DelayedRunnable::DelayedRunnable(already_AddRefed<nsIEventTarget> aTarget,
already_AddRefed<nsIRunnable> aRunnable,
uint32_t aDelay)
: mozilla::Runnable("DelayedRunnable"),
mTarget(aTarget),
mObserver(do_QueryInterface(mTarget)),
mWrappedRunnable(aRunnable),
mDelayedFrom(TimeStamp::NowLoRes()),
mDelay(aDelay) {
MOZ_DIAGNOSTIC_ASSERT(mObserver,
"Target must implement nsIDelayedRunnableObserver");
}
nsresult DelayedRunnable::Init() {
mObserver->OnDelayedRunnableCreated(this);
return NS_NewTimerWithCallback(getter_AddRefs(mTimer), this, mDelay,
nsITimer::TYPE_ONE_SHOT, mTarget);
}
void DelayedRunnable::CancelTimer() {
MOZ_ASSERT(mTarget->IsOnCurrentThread());
mTimer->Cancel();
}
NS_IMETHODIMP DelayedRunnable::Run() {
MOZ_ASSERT(mTimer, "DelayedRunnable without Init?");
// Already ran?
if (!mWrappedRunnable) {
return NS_OK;
}
// Are we too early?
if ((mozilla::TimeStamp::NowLoRes() - mDelayedFrom).ToMilliseconds() <
mDelay) {
if (mObserver) {
mObserver->OnDelayedRunnableScheduled(this);
}
return NS_OK; // Let the nsITimer run us.
}
mTimer->Cancel();
return DoRun();
}
NS_IMETHODIMP DelayedRunnable::Notify(nsITimer* aTimer) {
// If we already ran, the timer should have been canceled.
MOZ_ASSERT(mWrappedRunnable);
if (mObserver) {
mObserver->OnDelayedRunnableRan(this);
}
return DoRun();
}
nsresult DelayedRunnable::DoRun() {
nsCOMPtr<nsIRunnable> r = std::move(mWrappedRunnable);
AUTO_PROFILE_FOLLOWING_RUNNABLE(r);
return r->Run();
}
NS_IMPL_ISUPPORTS_INHERITED(DelayedRunnable, Runnable, nsITimerCallback)
} // namespace mozilla