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
224
225
226
227
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set sw=2 ts=8 et 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 "ChannelEventQueue.h"
#include "mozilla/Assertions.h"
#include "mozilla/Unused.h"
#include "nsIChannel.h"
#include "mozilla/dom/Document.h"
#include "nsThreadUtils.h"
namespace mozilla {
namespace net {
ChannelEvent* ChannelEventQueue::TakeEvent() {
mMutex.AssertCurrentThreadOwns();
MOZ_ASSERT(mFlushing);
if (mSuspended || mEventQueue.IsEmpty()) {
return nullptr;
}
UniquePtr<ChannelEvent> event(std::move(mEventQueue[0]));
mEventQueue.RemoveElementAt(0);
return event.release();
}
void ChannelEventQueue::FlushQueue() {
// Events flushed could include destruction of channel (and our own
// destructor) unless we make sure its refcount doesn't drop to 0 while this
// method is running.
nsCOMPtr<nsISupports> kungFuDeathGrip;
{
MutexAutoLock lock(mMutex);
kungFuDeathGrip = mOwner;
}
mozilla::Unused << kungFuDeathGrip; // Not used in this function
#ifdef DEBUG
{
MutexAutoLock lock(mMutex);
MOZ_ASSERT(mFlushing);
}
#endif // DEBUG
bool needResumeOnOtherThread = false;
while (true) {
UniquePtr<ChannelEvent> event;
{
MutexAutoLock lock(mMutex);
event.reset(TakeEvent());
if (!event) {
MOZ_ASSERT(mFlushing);
mFlushing = false;
MOZ_ASSERT(mEventQueue.IsEmpty() || (mSuspended || !!mForcedCount));
break;
}
}
nsCOMPtr<nsIEventTarget> target = event->GetEventTarget();
MOZ_ASSERT(target);
bool isCurrentThread = false;
nsresult rv = target->IsOnCurrentThread(&isCurrentThread);
if (NS_WARN_IF(NS_FAILED(rv))) {
// Simply run this event on current thread if we are not sure about it
// in release channel, or assert in Aurora/Nightly channel.
MOZ_DIAGNOSTIC_ASSERT(false);
isCurrentThread = true;
}
if (!isCurrentThread) {
// Next event needs to run on another thread. Put it back to
// the front of the queue can try resume on that thread.
Suspend();
PrependEvent(std::move(event));
needResumeOnOtherThread = true;
{
MutexAutoLock lock(mMutex);
MOZ_ASSERT(mFlushing);
mFlushing = false;
MOZ_ASSERT(!mEventQueue.IsEmpty());
}
break;
}
event->Run();
} // end of while(true)
// The flush procedure is aborted because next event cannot be run on current
// thread. We need to resume the event processing right after flush procedure
// is finished.
// Note: we cannot call Resume() while "mFlushing == true" because
// CompleteResume will not trigger FlushQueue while there is an ongoing flush.
if (needResumeOnOtherThread) {
Resume();
}
}
void ChannelEventQueue::Suspend() {
MutexAutoLock lock(mMutex);
SuspendInternal();
}
void ChannelEventQueue::SuspendInternal() {
mMutex.AssertCurrentThreadOwns();
mSuspended = true;
mSuspendCount++;
}
void ChannelEventQueue::Resume() {
MutexAutoLock lock(mMutex);
ResumeInternal();
}
void ChannelEventQueue::ResumeInternal() {
mMutex.AssertCurrentThreadOwns();
// Resuming w/o suspend: error in debug mode, ignore in build
MOZ_ASSERT(mSuspendCount > 0);
if (mSuspendCount <= 0) {
return;
}
if (!--mSuspendCount) {
if (mEventQueue.IsEmpty() || !!mForcedCount) {
// Nothing in queue to flush or waiting for AutoEventEnqueuer to
// finish the force enqueue period, simply clear the flag.
mSuspended = false;
return;
}
// Hold a strong reference of mOwner to avoid the channel release
// before CompleteResume was executed.
class CompleteResumeRunnable : public Runnable {
public:
explicit CompleteResumeRunnable(ChannelEventQueue* aQueue,
nsISupports* aOwner)
: Runnable("CompleteResumeRunnable"),
mQueue(aQueue),
mOwner(aOwner) {}
NS_IMETHOD Run() override {
mQueue->CompleteResume();
return NS_OK;
}
private:
virtual ~CompleteResumeRunnable() = default;
RefPtr<ChannelEventQueue> mQueue;
nsCOMPtr<nsISupports> mOwner;
};
if (!mOwner) {
return;
}
// Worker thread requires a CancelableRunnable.
RefPtr<Runnable> event = new CompleteResumeRunnable(this, mOwner);
nsCOMPtr<nsIEventTarget> target;
target = mEventQueue[0]->GetEventTarget();
MOZ_ASSERT(target);
Unused << NS_WARN_IF(
NS_FAILED(target->Dispatch(event.forget(), NS_DISPATCH_NORMAL)));
}
}
bool ChannelEventQueue::MaybeSuspendIfEventsAreSuppressed() {
// We only ever need to suppress events on the main thread, since this is
// where content scripts can run.
if (!NS_IsMainThread()) {
return false;
}
// Only suppress events for queues associated with XHRs, as these can cause
// content scripts to run.
if (mHasCheckedForXMLHttpRequest && !mForXMLHttpRequest) {
return false;
}
mMutex.AssertCurrentThreadOwns();
nsCOMPtr<nsIChannel> channel(do_QueryInterface(mOwner));
if (!channel) {
return false;
}
nsCOMPtr<nsILoadInfo> loadInfo = channel->LoadInfo();
// Figure out if this is for an XHR, if we haven't done so already.
if (!mHasCheckedForXMLHttpRequest) {
nsContentPolicyType contentType = loadInfo->InternalContentPolicyType();
mForXMLHttpRequest =
(contentType == nsIContentPolicy::TYPE_INTERNAL_XMLHTTPREQUEST);
mHasCheckedForXMLHttpRequest = true;
if (!mForXMLHttpRequest) {
return false;
}
}
// Suspend the queue if the associated document has suppressed event handling,
// *and* it is not in the middle of a synchronous operation that might require
// XHR events to be processed (such as a synchronous XHR).
RefPtr<dom::Document> document;
loadInfo->GetLoadingDocument(getter_AddRefs(document));
if (document && document->EventHandlingSuppressed() &&
!document->IsInSyncOperation()) {
document->AddSuspendedChannelEventQueue(this);
SuspendInternal();
return true;
}
return false;
}
} // namespace net
} // namespace mozilla
|
