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
|
/* -*- 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/. */
#ifndef mozilla_dom_timeout_h
#define mozilla_dom_timeout_h
#include "mozilla/dom/PopupBlocker.h"
#include "mozilla/dom/TimeoutHandler.h"
#include "mozilla/LinkedList.h"
#include "mozilla/TimeStamp.h"
#include "nsGlobalWindowInner.h"
#include "nsCycleCollectionParticipant.h"
#include "nsTHashMap.h"
#include "GeckoProfiler.h"
namespace mozilla::dom {
/*
* Timeout struct that holds information about each script
* timeout. Holds a strong reference to an nsITimeoutHandler, which
* abstracts the language specific cruft.
*/
class Timeout final : protected LinkedListElement<RefPtr<Timeout>> {
public:
Timeout();
NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(Timeout)
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(Timeout)
enum class Reason : uint8_t {
eTimeoutOrInterval,
eIdleCallbackTimeout,
eAbortSignalTimeout,
eDelayedWebTaskTimeout,
};
struct TimeoutIdAndReason {
uint32_t mId;
Reason mReason;
};
class TimeoutHashKey : public PLDHashEntryHdr {
public:
typedef const TimeoutIdAndReason& KeyType;
typedef const TimeoutIdAndReason* KeyTypePointer;
explicit TimeoutHashKey(KeyTypePointer aKey) : mValue(*aKey) {}
TimeoutHashKey(TimeoutHashKey&& aOther)
: PLDHashEntryHdr(std::move(aOther)),
mValue(std::move(aOther.mValue)) {}
~TimeoutHashKey() = default;
KeyType GetKey() const { return mValue; }
bool KeyEquals(KeyTypePointer aKey) const {
return aKey->mId == mValue.mId && aKey->mReason == mValue.mReason;
}
static KeyTypePointer KeyToPointer(KeyType aKey) { return &aKey; }
static PLDHashNumber HashKey(KeyTypePointer aKey) {
return aKey->mId | (static_cast<uint8_t>(aKey->mReason) << 31);
}
enum { ALLOW_MEMMOVE = true };
private:
const TimeoutIdAndReason mValue;
};
class TimeoutSet : public nsTHashMap<TimeoutHashKey, Timeout*> {
public:
NS_INLINE_DECL_REFCOUNTING(TimeoutSet);
private:
~TimeoutSet() = default;
};
void SetWhenOrTimeRemaining(const TimeStamp& aBaseTime,
const TimeDuration& aDelay);
// Can only be called when not frozen.
const TimeStamp& When() const;
const TimeStamp& SubmitTime() const;
// Can only be called when frozen.
const TimeDuration& TimeRemaining() const;
void SetTimeoutContainer(TimeoutSet* aTimeouts) {
MOZ_ASSERT(mTimeoutId != 0);
TimeoutIdAndReason key = {mTimeoutId, mReason};
if (mTimeouts) {
mTimeouts->Remove(key);
}
mTimeouts = aTimeouts;
if (mTimeouts) {
mTimeouts->InsertOrUpdate(key, this);
}
}
// Override some LinkedListElement methods so that remove()
// calls can call SetTimeoutContainer.
Timeout* getNext() { return LinkedListElement<RefPtr<Timeout>>::getNext(); }
void setNext(Timeout* aNext) {
return LinkedListElement<RefPtr<Timeout>>::setNext(aNext);
}
Timeout* getPrevious() {
return LinkedListElement<RefPtr<Timeout>>::getPrevious();
}
void remove() {
SetTimeoutContainer(nullptr);
LinkedListElement<RefPtr<Timeout>>::remove();
}
UniquePtr<ProfileChunkedBuffer> TakeProfilerBacktrace() {
return std::move(mCause);
}
private:
// mWhen and mTimeRemaining can't be in a union, sadly, because they
// have constructors.
// Nominal time to run this timeout. Use only when timeouts are not
// frozen.
TimeStamp mWhen;
// Remaining time to wait. Used only when timeouts are frozen.
TimeDuration mTimeRemaining;
// Time that the timeout started, restarted, or was frozen. Useful for
// logging time from (virtual) start of a timer until the time it fires
// (or is cancelled, etc)
TimeStamp mSubmitTime;
~Timeout() { SetTimeoutContainer(nullptr); }
public:
// Public member variables in this section. Please don't add to this list
// or mix methods with these. The interleaving public/private sections
// is necessary as we migrate members to private while still trying to
// keep decent binary packing.
// Window for which this timeout fires
RefPtr<nsGlobalWindowInner> mWindow;
// The language-specific information about the callback.
RefPtr<TimeoutHandler> mScriptHandler;
RefPtr<TimeoutSet> mTimeouts;
// Interval
TimeDuration mInterval;
UniquePtr<ProfileChunkedBuffer> mCause;
// Returned as value of setTimeout()
uint32_t mTimeoutId;
// Identifies which firing level this Timeout is being processed in
// when sync loops trigger nested firing.
uint32_t mFiringId;
#ifdef DEBUG
int64_t mFiringIndex;
#endif
// The popup state at timeout creation time if not created from
// another timeout
PopupBlocker::PopupControlState mPopupState;
// Used to allow several reasons for setting a timeout, where each
// 'Reason' value is using a possibly overlapping set of id:s.
Reason mReason;
// Between 0 and DOM_CLAMP_TIMEOUT_NESTING_LEVEL. Currently we don't
// care about nesting levels beyond that value.
uint8_t mNestingLevel;
// True if the timeout was cleared
bool mCleared;
// True if this is one of the timeouts that are currently running
bool mRunning;
// True if this is a repeating/interval timer
bool mIsInterval;
protected:
friend class LinkedList<RefPtr<Timeout>>;
friend class LinkedListElement<RefPtr<Timeout>>;
};
} // namespace mozilla::dom
#endif // mozilla_dom_timeout_h
|
