1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* 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 "MediaTimer.h"
#include <math.h>
#include "mozilla/AwakeTimeStamp.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/RefPtr.h"
#include "mozilla/SharedThreadPool.h"
#include "nsComponentManagerUtils.h"
#include "nsThreadUtils.h"
namespace mozilla {
template <typename T>
MediaTimer<T>::MediaTimer(bool aFuzzy)
: mMonitor("MediaTimer Monitor"),
mCreationTimeStamp(T::Now()),
mUpdateScheduled(false),
mFuzzy(aFuzzy) {
TIMER_LOG("MediaTimer::MediaTimer");
// Use the SharedThreadPool to create an nsIThreadPool with a maximum of one
// thread, which is equivalent to an nsIThread for our purposes.
RefPtr<SharedThreadPool> threadPool(
SharedThreadPool::Get("MediaTimer"_ns, 1));
mThread = threadPool.get();
mTimer = NS_NewTimer(mThread);
}
template <typename T>
void MediaTimer<T>::DispatchDestroy() {
// Hold a strong reference to the thread so that it doesn't get deleted in
// Destroy(), which may run completely before the stack if Dispatch() begins
// to unwind.
nsCOMPtr<nsIEventTarget> thread = mThread;
nsresult rv =
thread->Dispatch(NewNonOwningRunnableMethod("MediaTimer::Destroy", this,
&MediaTimer::Destroy),
NS_DISPATCH_NORMAL);
MOZ_DIAGNOSTIC_ASSERT(NS_SUCCEEDED(rv));
(void)rv;
(void)rv;
}
// Runs on the timer thread.
template <typename T>
void MediaTimer<T>::Destroy() {
MOZ_ASSERT(OnMediaTimerThread());
TIMER_LOG("MediaTimer::Destroy");
// Reject any outstanding entries.
{
MonitorAutoLock lock(mMonitor);
Reject();
// Cancel the timer if necessary.
CancelTimerIfArmed();
}
delete this;
}
template <typename T>
bool MediaTimer<T>::OnMediaTimerThread() {
bool rv = false;
mThread->IsOnCurrentThread(&rv);
return rv;
}
template <typename T>
RefPtr<MediaTimerPromise> MediaTimer<T>::WaitFor(
const typename T::DurationType& aDuration, StaticString aCallSite) {
return WaitUntil(T::Now() + aDuration, aCallSite);
}
template <typename T>
RefPtr<MediaTimerPromise> MediaTimer<T>::WaitUntil(const T& aTimeStamp,
StaticString aCallSite) {
MonitorAutoLock mon(mMonitor);
TIMER_LOG("MediaTimer::WaitUntil %" PRId64, RelativeMicroseconds(aTimeStamp));
Entry e(aTimeStamp, aCallSite);
RefPtr<MediaTimerPromise> p = e.mPromise.get();
mEntries.push(e);
ScheduleUpdate();
return p;
}
template <typename T>
void MediaTimer<T>::Cancel() {
MonitorAutoLock mon(mMonitor);
TIMER_LOG("MediaTimer::Cancel");
Reject();
}
template <typename T>
void MediaTimer<T>::ScheduleUpdate() {
mMonitor.AssertCurrentThreadOwns();
if (mUpdateScheduled) {
return;
}
mUpdateScheduled = true;
nsresult rv = mThread->Dispatch(
NewRunnableMethod("MediaTimer::Update", this, &MediaTimer::Update),
NS_DISPATCH_NORMAL);
MOZ_DIAGNOSTIC_ASSERT(NS_SUCCEEDED(rv));
(void)rv;
(void)rv;
}
template <typename T>
void MediaTimer<T>::Update() {
MonitorAutoLock mon(mMonitor);
UpdateLocked();
}
template <typename T>
bool MediaTimer<T>::IsExpired(const T& aTarget, const T& aNow) {
MOZ_ASSERT(OnMediaTimerThread());
mMonitor.AssertCurrentThreadOwns();
// Treat this timer as expired in fuzzy mode even if it is fired
// slightly (< 1ms) before the schedule target. So we don't need to schedule
// a timer with very small timeout again when the client doesn't need a
// high-res timer.
T t = mFuzzy ? aTarget - T::DurationType::FromMilliseconds(1) : aTarget;
return t <= aNow;
}
template <typename T>
void MediaTimer<T>::UpdateLocked() {
MOZ_ASSERT(OnMediaTimerThread());
mMonitor.AssertCurrentThreadOwns();
mUpdateScheduled = false;
TIMER_LOG("MediaTimer::UpdateLocked");
// Resolve all the promises whose time is up.
T now = T::Now();
while (!mEntries.empty() && IsExpired(mEntries.top().mTimeStamp, now)) {
mEntries.top().mPromise->Resolve(true, __func__);
DebugOnly<T> poppedTimeStamp = mEntries.top().mTimeStamp;
mEntries.pop();
MOZ_ASSERT_IF(!mEntries.empty(),
*&poppedTimeStamp <= mEntries.top().mTimeStamp);
}
// If we've got no more entries, cancel any pending timer and bail out.
if (mEntries.empty()) {
CancelTimerIfArmed();
return;
}
// We've got more entries - (re)arm the timer for the soonest one.
if (!TimerIsArmed() ||
mEntries.top().mTimeStamp < mCurrentTimerTarget.value()) {
CancelTimerIfArmed();
ArmTimer(mEntries.top().mTimeStamp, now);
}
}
template <typename T>
void MediaTimer<T>::Reject() {
mMonitor.AssertCurrentThreadOwns();
while (!mEntries.empty()) {
mEntries.top().mPromise->Reject(false, __func__);
mEntries.pop();
}
}
template <typename T>
/* static */ void MediaTimer<T>::TimerCallback(nsITimer* aTimer,
void* aClosure) {
static_cast<MediaTimer<T>*>(aClosure)->TimerFired();
}
template <typename T>
void MediaTimer<T>::TimerFired() {
MonitorAutoLock mon(mMonitor);
MOZ_ASSERT(OnMediaTimerThread());
mCurrentTimerTarget = Nothing();
UpdateLocked();
}
template <typename T>
void MediaTimer<T>::ArmTimer(const T& aTarget, const T& aNow) {
MOZ_DIAGNOSTIC_ASSERT(!TimerIsArmed());
MOZ_DIAGNOSTIC_ASSERT(aTarget > aNow);
const typename T::DurationType delay = aTarget - aNow;
TIMER_LOG("MediaTimer::ArmTimer delay=%.3fms", delay.ToMilliseconds());
mCurrentTimerTarget.emplace(aTarget);
TimeDuration duration =
TimeDuration::FromMicroseconds(delay.ToMicroseconds());
MOZ_ALWAYS_SUCCEEDS(mTimer->InitHighResolutionWithNamedFuncCallback(
&TimerCallback, this, duration, nsITimer::TYPE_ONE_SHOT,
"MediaTimer::TimerCallback"_ns));
}
template <typename T>
bool MediaTimer<T>::TimerIsArmed() {
return mCurrentTimerTarget.isSome();
}
template <typename T>
void MediaTimer<T>::CancelTimerIfArmed() {
MOZ_ASSERT(OnMediaTimerThread());
if (TimerIsArmed()) {
TIMER_LOG("MediaTimer::CancelTimerIfArmed canceling timer");
mTimer->Cancel();
mCurrentTimerTarget = Nothing();
}
}
template class MediaTimer<AwakeTimeStamp>;
template class MediaTimer<TimeStamp>;
} // namespace mozilla
|