-
Notifications
You must be signed in to change notification settings - Fork 54
/
Thread.cpp
511 lines (423 loc) · 14.1 KB
/
Thread.cpp
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
/* -*- 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 "Thread.h"
#include "ipc/ChildIPC.h"
#include "mozilla/Atomics.h"
#include "mozilla/Maybe.h"
#include "mozilla/StaticMutex.h"
#include "mozilla/ThreadLocal.h"
#include "ChunkAllocator.h"
#include "MemorySnapshot.h"
#include "ProcessRewind.h"
#include "SpinLock.h"
#include "ThreadSnapshot.h"
namespace mozilla {
namespace recordreplay {
///////////////////////////////////////////////////////////////////////////////
// Thread Organization
///////////////////////////////////////////////////////////////////////////////
static MOZ_THREAD_LOCAL(Thread*) gTlsThreadKey;
/* static */ Monitor* Thread::gMonitor;
/* static */ Thread* Thread::Current() {
MOZ_ASSERT(IsRecordingOrReplaying());
Thread* thread = gTlsThreadKey.get();
if (!thread && IsReplaying()) {
// Disable system threads when replaying.
WaitForeverNoIdle();
}
return thread;
}
/* static */ bool Thread::CurrentIsMainThread() {
Thread* thread = Current();
return thread && thread->IsMainThread();
}
void Thread::BindToCurrent() {
MOZ_ASSERT(!mStackBase);
gTlsThreadKey.set(this);
mNativeId = pthread_self();
size_t size = pthread_get_stacksize_np(mNativeId);
uint8_t* base = (uint8_t*)pthread_get_stackaddr_np(mNativeId) - size;
// Lock if we will be notifying later on. We don't do this for the main
// thread because we haven't initialized enough state yet that we can use
// a monitor.
Maybe<MonitorAutoLock> lock;
if (mId != MainThreadId) {
lock.emplace(*gMonitor);
}
mStackBase = base;
mStackSize = size;
// Notify WaitUntilInitialized if it is waiting for this thread to start.
if (mId != MainThreadId) {
gMonitor->NotifyAll();
}
}
// All threads, indexed by the thread ID.
static Thread* gThreads;
/* static */ Thread* Thread::GetById(size_t aId) {
MOZ_ASSERT(aId);
MOZ_ASSERT(aId <= MaxThreadId);
return &gThreads[aId];
}
/* static */ Thread* Thread::GetByNativeId(NativeThreadId aNativeId) {
for (size_t id = MainThreadId; id <= MaxRecordedThreadId; id++) {
Thread* thread = GetById(id);
if (thread->mNativeId == aNativeId) {
return thread;
}
}
return nullptr;
}
/* static */ Thread* Thread::GetByStackPointer(void* aSp) {
if (!gThreads) {
return nullptr;
}
for (size_t i = MainThreadId; i <= MaxThreadId; i++) {
Thread* thread = &gThreads[i];
if (MemoryContains(thread->mStackBase, thread->mStackSize, aSp)) {
return thread;
}
}
return nullptr;
}
/* static */ void Thread::InitializeThreads() {
gThreads = new Thread[MaxThreadId + 1];
for (size_t i = MainThreadId; i <= MaxThreadId; i++) {
Thread* thread = &gThreads[i];
PodZero(thread);
new (thread) Thread();
thread->mId = i;
if (i <= MaxRecordedThreadId) {
thread->mEvents = gRecordingFile->OpenStream(StreamName::Event, i);
}
DirectCreatePipe(&thread->mNotifyfd, &thread->mIdlefd);
}
if (!gTlsThreadKey.init()) {
MOZ_CRASH();
}
}
/* static */ void Thread::WaitUntilInitialized(Thread* aThread) {
MonitorAutoLock lock(*gMonitor);
while (!aThread->mStackBase) {
gMonitor->Wait();
}
}
/* static */ void Thread::ThreadMain(void* aArgument) {
MOZ_ASSERT(IsRecordingOrReplaying());
Thread* thread = (Thread*)aArgument;
MOZ_ASSERT(thread->mId > MainThreadId);
thread->BindToCurrent();
while (true) {
// Wait until this thread has been given a start routine.
while (true) {
{
MonitorAutoLock lock(*gMonitor);
if (thread->mStart) {
break;
}
}
Wait();
}
{
Maybe<AutoPassThroughThreadEvents> pt;
if (!thread->IsRecordedThread()) pt.emplace();
thread->mStart(thread->mStartArg);
}
MonitorAutoLock lock(*gMonitor);
// Clear the start routine to indicate to other threads that this one has
// finished executing.
thread->mStart = nullptr;
thread->mStartArg = nullptr;
// Notify any other thread waiting for this to finish in JoinThread.
gMonitor->NotifyAll();
}
}
/* static */ void Thread::SpawnAllThreads() {
MOZ_ASSERT(AreThreadEventsPassedThrough());
InitializeThreadSnapshots(MaxRecordedThreadId + 1);
gMonitor = new Monitor();
// All Threads are spawned up front. This allows threads to be scanned
// (e.g. in ReplayUnlock) without worrying about racing with other threads
// being spawned.
for (size_t i = MainThreadId + 1; i <= MaxRecordedThreadId; i++) {
SpawnThread(GetById(i));
}
}
// The number of non-recorded threads that have been spawned.
static Atomic<size_t, SequentiallyConsistent, Behavior::DontPreserve>
gNumNonRecordedThreads;
/* static */ Thread* Thread::SpawnNonRecordedThread(Callback aStart,
void* aArgument) {
if (IsMiddleman()) {
DirectSpawnThread(aStart, aArgument);
return nullptr;
}
size_t id = MaxRecordedThreadId + ++gNumNonRecordedThreads;
MOZ_RELEASE_ASSERT(id <= MaxThreadId);
Thread* thread = GetById(id);
thread->mStart = aStart;
thread->mStartArg = aArgument;
SpawnThread(thread);
return thread;
}
/* static */ void Thread::SpawnThread(Thread* aThread) {
DirectSpawnThread(ThreadMain, aThread);
WaitUntilInitialized(aThread);
}
/* static */ NativeThreadId Thread::StartThread(Callback aStart,
void* aArgument,
bool aNeedsJoin) {
Thread* thread = Thread::Current();
RecordingEventSection res(thread);
if (!res.CanAccessEvents()) {
return 0;
}
MonitorAutoLock lock(*gMonitor);
size_t id = 0;
if (IsRecording()) {
// Look for an idle thread.
for (id = MainThreadId + 1; id <= MaxRecordedThreadId; id++) {
Thread* targetThread = Thread::GetById(id);
if (!targetThread->mStart && !targetThread->mNeedsJoin) {
break;
}
}
if (id >= MaxRecordedThreadId) {
child::ReportFatalError(Nothing(), "Too many threads");
}
MOZ_RELEASE_ASSERT(id <= MaxRecordedThreadId);
}
thread->Events().RecordOrReplayThreadEvent(ThreadEvent::CreateThread);
thread->Events().RecordOrReplayScalar(&id);
Thread* targetThread = GetById(id);
// Block until the thread is ready for a new start routine.
while (targetThread->mStart) {
MOZ_RELEASE_ASSERT(IsReplaying());
gMonitor->Wait();
}
targetThread->mStart = aStart;
targetThread->mStartArg = aArgument;
targetThread->mNeedsJoin = aNeedsJoin;
// Notify the thread in case it is waiting for a start routine under
// ThreadMain.
Notify(id);
return targetThread->mNativeId;
}
void Thread::Join() {
MOZ_ASSERT(!AreThreadEventsPassedThrough());
EnsureNotDivergedFromRecording();
while (true) {
MonitorAutoLock lock(*gMonitor);
if (!mStart) {
MOZ_RELEASE_ASSERT(mNeedsJoin);
mNeedsJoin = false;
break;
}
gMonitor->Wait();
}
}
///////////////////////////////////////////////////////////////////////////////
// Thread Public API Accessors
///////////////////////////////////////////////////////////////////////////////
extern "C" {
MOZ_EXPORT void RecordReplayInterface_InternalBeginPassThroughThreadEvents() {
MOZ_ASSERT(IsRecordingOrReplaying());
if (!gInitializationFailureMessage) {
Thread::Current()->SetPassThrough(true);
}
}
MOZ_EXPORT void RecordReplayInterface_InternalEndPassThroughThreadEvents() {
MOZ_ASSERT(IsRecordingOrReplaying());
if (!gInitializationFailureMessage) {
Thread::Current()->SetPassThrough(false);
}
}
MOZ_EXPORT bool RecordReplayInterface_InternalAreThreadEventsPassedThrough() {
MOZ_ASSERT(IsRecordingOrReplaying());
// If initialization fails, pass through all thread events until we're able
// to report the problem to the middleman and die.
if (gInitializationFailureMessage) {
return true;
}
Thread* thread = Thread::Current();
return !thread || thread->PassThroughEvents();
}
MOZ_EXPORT void RecordReplayInterface_InternalBeginDisallowThreadEvents() {
MOZ_ASSERT(IsRecordingOrReplaying());
Thread::Current()->BeginDisallowEvents();
}
MOZ_EXPORT void RecordReplayInterface_InternalEndDisallowThreadEvents() {
MOZ_ASSERT(IsRecordingOrReplaying());
Thread::Current()->EndDisallowEvents();
}
MOZ_EXPORT bool RecordReplayInterface_InternalAreThreadEventsDisallowed() {
MOZ_ASSERT(IsRecordingOrReplaying());
Thread* thread = Thread::Current();
return thread && thread->AreEventsDisallowed();
}
} // extern "C"
///////////////////////////////////////////////////////////////////////////////
// Thread Coordination
///////////////////////////////////////////////////////////////////////////////
/* static */ void Thread::WaitForIdleThreads() {
MOZ_RELEASE_ASSERT(CurrentIsMainThread());
MonitorAutoLock lock(*gMonitor);
for (size_t i = MainThreadId + 1; i <= MaxRecordedThreadId; i++) {
Thread* thread = GetById(i);
thread->mShouldIdle = true;
thread->mUnrecordedWaitNotified = false;
}
while (true) {
bool done = true;
for (size_t i = MainThreadId + 1; i <= MaxRecordedThreadId; i++) {
Thread* thread = GetById(i);
if (!thread->mIdle) {
done = false;
// Check if there is a callback we can invoke to get this thread to
// make progress. The mUnrecordedWaitOnlyWhenDiverged flag is used to
// avoid perturbing the behavior of threads that may or may not be
// waiting on an unrecorded resource, depending on whether they have
// diverged from the recording yet.
if (thread->mUnrecordedWaitCallback &&
!thread->mUnrecordedWaitNotified) {
// Set this flag before releasing the idle lock. Otherwise it's
// possible the thread could call NotifyUnrecordedWait while we
// aren't holding the lock, and we would set the flag afterwards
// without first invoking the callback.
thread->mUnrecordedWaitNotified = true;
// Release the idle lock here to avoid any risk of deadlock.
std::function<void()> callback = thread->mUnrecordedWaitCallback;
{
MonitorAutoUnlock unlock(*gMonitor);
AutoPassThroughThreadEvents pt;
callback();
}
// Releasing the global lock means that we need to start over
// checking whether there are any idle threads. By marking this
// thread as having been notified we have made progress, however.
done = true;
i = MainThreadId;
}
}
}
if (done) {
break;
}
MonitorAutoUnlock unlock(*gMonitor);
WaitNoIdle();
}
}
/* static */ void Thread::ResumeSingleIdleThread(size_t aId) {
GetById(aId)->mShouldIdle = false;
Notify(aId);
}
/* static */ void Thread::ResumeIdleThreads() {
MOZ_RELEASE_ASSERT(CurrentIsMainThread());
for (size_t i = MainThreadId + 1; i <= MaxRecordedThreadId; i++) {
ResumeSingleIdleThread(i);
}
}
void Thread::NotifyUnrecordedWait(
const std::function<void()>& aNotifyCallback) {
if (IsMainThread()) {
return;
}
MonitorAutoLock lock(*gMonitor);
if (mUnrecordedWaitCallback) {
// Per the documentation for NotifyUnrecordedWait, we need to call the
// routine after a notify, even if the routine has been called already
// since the main thread started to wait for idle replay threads.
mUnrecordedWaitNotified = false;
} else {
MOZ_RELEASE_ASSERT(!mUnrecordedWaitNotified);
}
mUnrecordedWaitCallback = aNotifyCallback;
// The main thread might be able to make progress now by calling the routine
// if it is waiting for idle replay threads.
if (mShouldIdle) {
Notify(MainThreadId);
}
}
bool Thread::MaybeWaitForCheckpointSave(
const std::function<void()>& aReleaseCallback) {
MOZ_RELEASE_ASSERT(!PassThroughEvents());
if (IsMainThread()) {
return false;
}
MonitorAutoLock lock(*gMonitor);
if (!mShouldIdle) {
return false;
}
aReleaseCallback();
while (mShouldIdle) {
MonitorAutoUnlock unlock(*gMonitor);
Wait();
}
return true;
}
/* static */ void Thread::WaitNoIdle() {
Thread* thread = Current();
uint8_t data = 0;
size_t read = DirectRead(thread->mIdlefd, &data, 1);
MOZ_RELEASE_ASSERT(read == 1);
}
/* static */ void Thread::Wait() {
Thread* thread = Current();
MOZ_ASSERT(!thread->mIdle);
MOZ_ASSERT(thread->IsRecordedThread() && !thread->PassThroughEvents());
if (thread->IsMainThread()) {
WaitNoIdle();
return;
}
// The state saved for a thread needs to match up with the most recent
// point at which it became idle, so that when the main thread saves the
// stacks from all threads it saves those stacks at the right point.
// SaveThreadState might trigger thread events, so make sure they are
// passed through.
thread->SetPassThrough(true);
int stackSeparator = 0;
if (!SaveThreadState(thread->Id(), &stackSeparator)) {
// We just restored a checkpoint, notify the main thread since it is waiting
// for all threads to restore their stacks.
Notify(MainThreadId);
}
thread->mIdle = true;
if (thread->mShouldIdle) {
// Notify the main thread that we just became idle.
Notify(MainThreadId);
}
do {
// Do the actual waiting for another thread to notify this one.
WaitNoIdle();
// Rewind this thread if the main thread told us to do so. The main
// thread is responsible for rewinding its own stack.
if (ShouldRestoreThreadStack(thread->Id())) {
RestoreThreadStack(thread->Id());
Unreachable();
}
} while (thread->mShouldIdle);
thread->mIdle = false;
thread->SetPassThrough(false);
}
/* static */ void Thread::WaitForever() {
while (true) {
Wait();
}
Unreachable();
}
/* static */ void Thread::WaitForeverNoIdle() {
FileHandle writeFd, readFd;
DirectCreatePipe(&writeFd, &readFd);
while (true) {
uint8_t data;
DirectRead(readFd, &data, 1);
}
}
/* static */ void Thread::Notify(size_t aId) {
uint8_t data = 0;
DirectWrite(GetById(aId)->mNotifyfd, &data, 1);
}
} // namespace recordreplay
} // namespace mozilla