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
|
/*
* Copyright (C) 2006 Apple Computer, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_TIMER_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_TIMER_H_
#include "base/location.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/single_thread_task_runner.h"
#include "base/time/time.h"
#include "third_party/blink/renderer/platform/heap/handle.h"
#include "third_party/blink/renderer/platform/heap/persistent.h"
#include "third_party/blink/renderer/platform/platform_export.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/sanitizers.h"
#include "third_party/blink/renderer/platform/wtf/threading.h"
namespace blink {
// Time intervals are all in seconds.
class PLATFORM_EXPORT TimerBase {
public:
explicit TimerBase(scoped_refptr<base::SingleThreadTaskRunner>);
virtual ~TimerBase();
void Start(base::TimeDelta next_fire_interval,
base::TimeDelta repeat_interval,
const base::Location&);
void StartRepeating(base::TimeDelta repeat_interval,
const base::Location& caller) {
Start(repeat_interval, repeat_interval, caller);
}
void StartOneShot(base::TimeDelta interval, const base::Location& caller) {
Start(interval, base::TimeDelta(), caller);
}
// Timer cancellation is fast enough that you shouldn't have to worry
// about it unless you're canceling tens of thousands of tasks.
virtual void Stop();
bool IsActive() const;
const base::Location& GetLocation() const { return location_; }
base::TimeDelta NextFireInterval() const;
base::TimeDelta RepeatInterval() const { return repeat_interval_; }
void AugmentRepeatInterval(base::TimeDelta delta) {
base::TimeTicks now = TimerCurrentTimeTicks();
SetNextFireTime(now,
std::max(next_fire_time_ - now + delta, base::TimeDelta()));
repeat_interval_ += delta;
}
void MoveToNewTaskRunner(scoped_refptr<base::SingleThreadTaskRunner>);
struct PLATFORM_EXPORT Comparator {
bool operator()(const TimerBase* a, const TimerBase* b) const;
};
protected:
virtual void Fired() = 0;
virtual base::OnceClosure BindTimerClosure(
base::WeakPtr<TimerBase> weak_ptr) {
return WTF::Bind(&TimerBase::RunInternal, std::move(weak_ptr));
}
void RunInternal();
private:
base::TimeTicks TimerCurrentTimeTicks() const;
void SetNextFireTime(base::TimeTicks now, base::TimeDelta delay);
base::TimeTicks next_fire_time_; // 0 if inactive
base::TimeDelta repeat_interval_; // 0 if not repeating
base::Location location_;
scoped_refptr<base::SingleThreadTaskRunner> web_task_runner_;
#if DCHECK_IS_ON()
base::PlatformThreadId thread_;
#endif
// Used for invalidating tasks at arbitrary times and after the timer has been
// destructed.
base::WeakPtrFactory<TimerBase> weak_ptr_factory_{this};
DISALLOW_COPY_AND_ASSIGN(TimerBase);
};
template <typename TimerFiredClass>
class TaskRunnerTimer : public TimerBase {
public:
using TimerFiredFunction = void (TimerFiredClass::*)(TimerBase*);
TaskRunnerTimer(scoped_refptr<base::SingleThreadTaskRunner> web_task_runner,
TimerFiredClass* o,
TimerFiredFunction f)
: TimerBase(std::move(web_task_runner)), object_(o), function_(f) {
static_assert(!WTF::IsGarbageCollectedType<TimerFiredClass>::value,
"Use HeapTaskRunnerTimer with garbage-collected types.");
}
~TaskRunnerTimer() override = default;
protected:
void Fired() override { (object_->*function_)(this); }
private:
TimerFiredClass* object_;
TimerFiredFunction function_;
};
template <typename TimerFiredClass>
class HeapTaskRunnerTimer final : public TimerBase {
DISALLOW_NEW();
public:
using TimerFiredFunction = void (TimerFiredClass::*)(TimerBase*);
HeapTaskRunnerTimer(
scoped_refptr<base::SingleThreadTaskRunner> web_task_runner,
TimerFiredClass* object,
TimerFiredFunction function)
: TimerBase(std::move(web_task_runner)),
object_(object),
function_(function) {
static_assert(
WTF::IsGarbageCollectedType<TimerFiredClass>::value,
"HeapTaskRunnerTimer can only be used with garbage-collected types.");
}
~HeapTaskRunnerTimer() final = default;
void Trace(Visitor* visitor) const { visitor->Trace(object_); }
protected:
void Fired() final { (object_->*function_)(this); }
base::OnceClosure BindTimerClosure(base::WeakPtr<TimerBase> weak_ptr) final {
return WTF::Bind(&HeapTaskRunnerTimer::RunInternalTrampoline,
std::move(weak_ptr), WrapWeakPersistent(object_.Get()));
}
private:
// Trampoline used for garbage-collected timer version also checks whether the
// object has been deemed as dead by the GC but not yet reclaimed. Dead
// objects that have not been reclaimed yet must not be touched (which is
// enforced by ASAN poisoning).
static void RunInternalTrampoline(base::WeakPtr<TimerBase> weak_ptr,
TimerFiredClass* object) {
// - {weak_ptr} is invalidated upon request and when the timer is destroyed.
// - {object} is null when the garbage collector deemed the timer as
// unreachable.
if (weak_ptr && object) {
static_cast<HeapTaskRunnerTimer*>(weak_ptr.get())->RunInternal();
}
}
WeakMember<TimerFiredClass> object_;
TimerFiredFunction function_;
};
NO_SANITIZE_ADDRESS
inline bool TimerBase::IsActive() const {
#if DCHECK_IS_ON()
DCHECK_EQ(thread_, CurrentThread());
#endif
return weak_ptr_factory_.HasWeakPtrs();
}
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_TIMER_H_
|
