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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
content / browser / renderer_host / spare_render_process_host_manager_browsertest.cc [blame]
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <utility>
#include "base/callback_list.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/scoped_feature_list.h"
#include "base/test/test_mock_time_task_runner.h"
#include "base/test/test_timeouts.h"
#include "base/time/time.h"
#include "content/browser/renderer_host/render_process_host_impl.h"
#include "content/browser/renderer_host/spare_render_process_host_manager_impl.h"
#include "content/public/test/browser_task_environment.h"
#include "content/public/test/browser_test.h"
#include "content/public/test/content_browser_test.h"
#include "content/public/test/content_browser_test_content_browser_client.h"
#include "content/public/test/content_browser_test_utils.h"
#include "content/public/test/no_renderer_crashes_assertion.h"
#include "content/public/test/test_service.mojom.h"
#include "content/public/test/test_utils.h"
#include "content/shell/browser/shell.h"
#include "content/shell/browser/shell_browser_context.h"
#include "content/shell/browser/shell_content_browser_client.h"
#include "content/test/content_browser_test_utils_internal.h"
#include "net/dns/mock_host_resolver.h"
#include "testing/gtest/include/gtest/gtest.h"
namespace content {
class SpareRenderProcessHostManagerTest : public ContentBrowserTest,
public RenderProcessHostObserver {
public:
SpareRenderProcessHostManagerTest() {
// The AndroidWarmUpSpareRendererWithTimeout will stop
// PrepareForFutureRequests from creating a delayed process. Disable so that
// we can test the defer behavior.
feature_list_.InitAndDisableFeature(
features::kAndroidWarmUpSpareRendererWithTimeout);
}
protected:
void SetUpOnMainThread() override {
// Support multiple sites on the test server.
host_resolver()->AddRule("*", "127.0.0.1");
}
void SetUpCommandLine(base::CommandLine* command_line) override {
// Platforms that don't isolate sites won't create spare processes and
// the test will fail. Therefore, enforce the site isolation here.
IsolateAllSitesForTesting(command_line);
}
void SetProcessExitCallback(RenderProcessHost* rph,
base::OnceClosure callback) {
Observe(rph);
process_exit_callback_ = std::move(callback);
}
void Observe(RenderProcessHost* rph) {
DCHECK(!observation_.IsObserving());
observation_.Observe(rph);
}
void CreateSpareRendererWithoutTimeout() {
SpareRenderProcessHostManagerImpl::Get().WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
}
void CreateSpareRendererWithTimeout(base::TimeDelta timeout) {
SpareRenderProcessHostManagerImpl::Get().WarmupSpare(
ShellContentBrowserClient::Get()->browser_context(), timeout);
}
// RenderProcessHostObserver:
void RenderProcessExited(RenderProcessHost* host,
const ChildProcessTerminationInfo& info) override {
if (process_exit_callback_) {
std::move(process_exit_callback_).Run();
}
}
void RenderProcessHostDestroyed(RenderProcessHost* host) override {
observation_.Reset();
}
private:
base::ScopedObservation<RenderProcessHost, RenderProcessHostObserver>
observation_{this};
base::OnceClosure process_exit_callback_;
base::test::ScopedFeatureList feature_list_;
};
// This test verifies the creation of a deferred spare renderer. It checks two
// conditions:
// 1. A spare renderer is created successfully under standard conditions.
// 2. No spare renderer is created if the browser context is destroyed.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
DeferredSpareProcess) {
constexpr base::TimeDelta kDelay = base::Seconds(1);
base::HistogramTester histogram_tester;
scoped_refptr<base::TestMockTimeTaskRunner> task_runner =
new base::TestMockTimeTaskRunner();
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
base::ScopedAllowBlockingForTesting allow_blocking;
auto browser_context = std::make_unique<ShellBrowserContext>(true);
// Check that a spare renderer is created successfully under standard
// conditions.
SpareRenderProcessHostStartedObserver spare_started_observer;
spare_manager.PrepareForFutureRequests(browser_context.get(), kDelay);
EXPECT_TRUE(spare_manager.GetSpares().empty());
// Wait until the renderer process is successfully started.
spare_started_observer.WaitForSpareRenderProcessStarted();
// The spare renderer should be started.
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
histogram_tester.ExpectTotalCount(
"BrowserRenderProcessHost.SpareProcessStartupTime", 1);
histogram_tester.ExpectTotalCount(
"BrowserRenderProcessHost.SpareProcessDelayTime", 1);
// Reset the spare renderer manager.
spare_manager.CleanupSparesForTesting();
EXPECT_TRUE(spare_manager.GetSpares().empty());
// Check that no spare renderer is created if the browser context is
// destroyed.
spare_manager.PrepareForFutureRequests(browser_context.get(), kDelay);
browser_context.reset();
RunAllTasksUntilIdle();
// The spare renderer shouldn't be created.
EXPECT_TRUE(spare_manager.GetSpares().empty());
histogram_tester.ExpectTotalCount(
"BrowserRenderProcessHost.SpareProcessStartupTime", 1);
histogram_tester.ExpectTotalCount(
"BrowserRenderProcessHost.SpareProcessDelayTime", 1);
}
// The test verifies the deferred render process creation is only overridden
// when WarmupSpare is called without a timeout
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
WarmupSpareDuringDefer) {
constexpr base::TimeDelta kDelay = base::Seconds(1);
base::HistogramTester histogram_tester;
scoped_refptr<base::TestMockTimeTaskRunner> task_runner =
new base::TestMockTimeTaskRunner();
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.SetDeferTimerTaskRunnerForTesting(task_runner);
auto* browser_context = ShellContentBrowserClient::Get()->browser_context();
// Check that a delayed spare render host creation will be cancelled if
// WarmupSpare is called without a timeout.
spare_manager.PrepareForFutureRequests(browser_context, kDelay);
spare_manager.WarmupSpare(browser_context);
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
histogram_tester.ExpectTotalCount(
"BrowserRenderProcessHost.SpareProcessDelayTime", 1);
// Reset the spare renderer manager.
spare_manager.CleanupSparesForTesting();
EXPECT_TRUE(spare_manager.GetSpares().empty());
// Check that a delayed spare render host creation will not be cancelled if
// WarmupSpare is called with a timeout.
constexpr base::TimeDelta kTimeout = base::Milliseconds(500);
spare_manager.PrepareForFutureRequests(browser_context, kDelay);
spare_manager.WarmupSpare(browser_context, kTimeout);
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
task_runner->FastForwardBy(kTimeout);
EXPECT_TRUE(spare_manager.GetSpares().empty());
task_runner->FastForwardBy(kDelay - kTimeout);
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
spare_manager.CleanupSparesForTesting();
}
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRenderProcessHostTaken) {
ASSERT_TRUE(embedded_test_server()->Start());
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
Shell* window = CreateBrowser();
EXPECT_TRUE(NavigateToURL(window, test_url));
EXPECT_EQ(spare_renderer,
window->web_contents()->GetPrimaryMainFrame()->GetProcess());
// The old spare render process host should no longer be available.
if (!spare_manager.GetSpares().empty()) {
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
EXPECT_NE(spare_renderer, spare_manager.GetSpares()[0]);
}
// Check if a fresh spare is available (depending on the operating mode).
if (RenderProcessHostImpl::IsSpareProcessKeptAtAllTimes()) {
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
} else {
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
}
}
// Verifies that creating a spare renderer without a timeout
// will create a spare renderer and destroy it after the timeout.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
CreateWithTimeoutDestroyedAfterTimeout) {
scoped_refptr<base::TestMockTimeTaskRunner> task_runner =
new base::TestMockTimeTaskRunner();
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.SetDeferTimerTaskRunnerForTesting(task_runner);
base::TimeDelta kTimeout = base::Seconds(1);
// Setup a spare renderer with a timeout
CreateSpareRendererWithTimeout(kTimeout);
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
// After the timeout the spare renderer shall be destroyed
task_runner->FastForwardBy(kTimeout);
base::RunLoop().RunUntilIdle();
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
}
// Verifies that creating a spare renderer without a timeout
// shall compare the timeout with the current renderer.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
MultipleCreateOverrideBehavior) {
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
scoped_refptr<base::TestMockTimeTaskRunner> task_runner =
new base::TestMockTimeTaskRunner();
spare_manager.SetDeferTimerTaskRunnerForTesting(task_runner);
base::TimeDelta kTimeoutShort = base::Seconds(1);
base::TimeDelta kTimeoutLong = base::Seconds(2);
// Setup a spare renderer without a timeout
CreateSpareRendererWithoutTimeout();
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* created_renderer = spare_manager.GetSpares()[0];
EXPECT_NE(nullptr, created_renderer);
// Creating a spare renderer with a timeout shall not override
// the timeout.
CreateSpareRendererWithTimeout(kTimeoutShort);
task_runner->FastForwardBy(kTimeoutShort);
base::RunLoop().RunUntilIdle();
// Verify that the spare render process itself does not get recreated
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
EXPECT_EQ(created_renderer, spare_manager.GetSpares()[0]);
spare_manager.CleanupSparesForTesting();
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
// Setup a spare renderer with a timeout
CreateSpareRendererWithTimeout(kTimeoutShort);
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
created_renderer = spare_manager.GetSpares()[0];
EXPECT_NE(nullptr, created_renderer);
// Creating a spare renderer without a timeout cancels the timer.
CreateSpareRendererWithoutTimeout();
task_runner->FastForwardBy(kTimeoutShort);
base::RunLoop().RunUntilIdle();
// Verify that the spare render process itself does not get recreated
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
EXPECT_EQ(created_renderer, spare_manager.GetSpares()[0]);
spare_manager.CleanupSparesForTesting();
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
// First create a spare renderer with a long timeout
CreateSpareRendererWithTimeout(kTimeoutLong);
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
created_renderer = spare_manager.GetSpares()[0];
EXPECT_NE(nullptr, created_renderer);
// Creating a spare renderer with a short timeout shall not override
// the timeout.
CreateSpareRendererWithTimeout(kTimeoutShort);
task_runner->FastForwardBy(kTimeoutShort);
base::RunLoop().RunUntilIdle();
// Verify that the spare render process itself does not get recreated
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
EXPECT_EQ(created_renderer, spare_manager.GetSpares()[0]);
// The spare renderer shall be destroyed after the long timeout.
task_runner->FastForwardBy(kTimeoutLong - kTimeoutShort);
base::RunLoop().RunUntilIdle();
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
// First create a spare renderer with a short timeout
CreateSpareRendererWithTimeout(kTimeoutShort);
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
created_renderer = spare_manager.GetSpares()[0];
EXPECT_NE(nullptr, created_renderer);
// Creating a spare renderer with a long timeout shall override
// the timeout.
CreateSpareRendererWithTimeout(kTimeoutLong);
task_runner->FastForwardBy(kTimeoutShort);
base::RunLoop().RunUntilIdle();
// Verify that the spare render process itself does not get recreated
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
EXPECT_EQ(created_renderer, spare_manager.GetSpares()[0]);
// The spare renderer shall be destroyed after the long timeout.
task_runner->FastForwardBy(kTimeoutLong - kTimeoutShort);
base::RunLoop().RunUntilIdle();
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
}
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRenderProcessHostNotTaken) {
ASSERT_TRUE(embedded_test_server()->Start());
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->off_the_record_browser_context());
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
Shell* window = CreateBrowser();
EXPECT_TRUE(NavigateToURL(window, test_url));
// There should have been another process created for the navigation.
EXPECT_NE(spare_renderer,
window->web_contents()->GetPrimaryMainFrame()->GetProcess());
// Check if a fresh spare is available (depending on the operating mode).
// Note this behavior is identical to what would have happened if the
// RenderProcessHost were taken.
if (RenderProcessHostImpl::IsSpareProcessKeptAtAllTimes()) {
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
} else {
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
}
}
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRenderProcessHostKilled) {
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
mojo::Remote<mojom::TestService> service;
ASSERT_NE(nullptr, spare_renderer);
spare_renderer->BindReceiver(service.BindNewPipeAndPassReceiver());
base::RunLoop run_loop;
SetProcessExitCallback(spare_renderer, run_loop.QuitClosure());
// Should reply with a bad message and cause process death.
{
ScopedAllowRendererCrashes scoped_allow_renderer_crashes(spare_renderer);
service->DoSomething(base::DoNothing());
run_loop.Run();
}
// The spare RenderProcessHost should disappear when its process dies.
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
}
// A mock ContentBrowserClient that only considers a spare renderer to be a
// suitable host.
class SpareRendererContentBrowserClient
: public ContentBrowserTestContentBrowserClient {
public:
bool IsSuitableHost(RenderProcessHost* process_host,
const GURL& site_url) override {
const auto& spares = SpareRenderProcessHostManagerImpl::Get().GetSpares();
if (!spares.empty()) {
return base::Contains(spares, process_host);
}
return true;
}
};
// A mock ContentBrowserClient that only considers a non-spare renderer to be a
// suitable host, but otherwise tries to reuse processes.
class NonSpareRendererContentBrowserClient
: public ContentBrowserTestContentBrowserClient {
public:
NonSpareRendererContentBrowserClient() = default;
NonSpareRendererContentBrowserClient(
const NonSpareRendererContentBrowserClient&) = delete;
NonSpareRendererContentBrowserClient& operator=(
const NonSpareRendererContentBrowserClient&) = delete;
bool IsSuitableHost(RenderProcessHost* process_host,
const GURL& site_url) override {
return !process_host->IsSpare();
}
bool ShouldTryToUseExistingProcessHost(BrowserContext* context,
const GURL& url) override {
return true;
}
std::optional<SpareProcessRefusedByEmbedderReason>
ShouldUseSpareRenderProcessHost(BrowserContext* browser_context,
const GURL& site_url) override {
return SpareProcessRefusedByEmbedderReason::DefaultDisabled;
}
};
// Test that the spare renderer works correctly when the limit on the maximum
// number of processes is small.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRendererSurpressedMaxProcesses) {
ASSERT_TRUE(embedded_test_server()->Start());
SpareRendererContentBrowserClient browser_client;
RenderProcessHost::SetMaxRendererProcessCount(1);
// A process is created with shell startup, so with a maximum of one renderer
// process the spare RPH should not be created.
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
// A spare RPH should be created with a max of 2 renderer processes.
RenderProcessHost::SetMaxRendererProcessCount(2);
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
EXPECT_NE(nullptr, spare_renderer);
// Thanks to the injected SpareRendererContentBrowserClient and the limit on
// processes, the spare RPH will always be used via GetExistingProcessHost()
// rather than picked up via MaybeTakeSpareRenderProcessHost().
GURL test_url = embedded_test_server()->GetURL("/simple_page.html");
Shell* new_window = CreateBrowser();
EXPECT_TRUE(NavigateToURL(new_window, test_url));
// Outside of RenderProcessHostImpl::IsSpareProcessKeptAtAllTimes mode, the
// spare RPH should have been dropped during CreateBrowser() and given to the
// new window. OTOH, even in the IsSpareProcessKeptAtAllTimes mode, the spare
// shouldn't be created because of the low process limit.
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
EXPECT_EQ(spare_renderer,
new_window->web_contents()->GetPrimaryMainFrame()->GetProcess());
// Revert to the default process limit and original ContentBrowserClient.
RenderProcessHost::SetMaxRendererProcessCount(0);
}
// Check that the spare renderer is dropped if an existing process is reused.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRendererOnProcessReuse) {
ASSERT_TRUE(embedded_test_server()->Start());
NonSpareRendererContentBrowserClient browser_client;
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
EXPECT_NE(nullptr, spare_renderer);
// This should reuse the existing process.
Shell* new_browser = CreateBrowser();
EXPECT_EQ(shell()->web_contents()->GetPrimaryMainFrame()->GetProcess(),
new_browser->web_contents()->GetPrimaryMainFrame()->GetProcess());
EXPECT_NE(spare_renderer,
new_browser->web_contents()->GetPrimaryMainFrame()->GetProcess());
if (RenderProcessHostImpl::IsSpareProcessKeptAtAllTimes()) {
EXPECT_EQ(spare_manager.GetSpares().size(), 1u);
} else {
EXPECT_EQ(spare_manager.GetSpares().size(), 0u);
}
// The launcher thread reads state from browser_client, need to wait for it to
// be done before resetting the browser client. crbug.com/742533.
base::WaitableEvent launcher_thread_done(
base::WaitableEvent::ResetPolicy::MANUAL,
base::WaitableEvent::InitialState::NOT_SIGNALED);
GetProcessLauncherTaskRunner()->PostTask(
FROM_HERE,
base::BindOnce([](base::WaitableEvent* done) { done->Signal(); },
base::Unretained(&launcher_thread_done)));
ASSERT_TRUE(launcher_thread_done.TimedWait(TestTimeouts::action_timeout()));
}
// Verifies that the spare renderer maintained by SpareRenderProcessHostManager
// is correctly destroyed during browser shutdown. This test is an analogue
// to the //chrome-layer FastShutdown.SpareRenderProcessHost test.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRenderProcessHostDuringShutdown) {
content::SpareRenderProcessHostManagerImpl::Get().WarmupSpare(
shell()->web_contents()->GetBrowserContext());
// The verification is that there are no DCHECKs anywhere during test tear
// down.
}
// Verifies that the spare renderer maintained by SpareRenderProcessHostManager
// is correctly destroyed when closing the last content shell.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareRendererDuringClosing) {
content::SpareRenderProcessHostManagerImpl::Get().WarmupSpare(
shell()->web_contents()->GetBrowserContext());
shell()->web_contents()->Close();
// The verification is that there are no DCHECKs or UaF anywhere during test
// tear down.
}
// Verifies that the destroy timeout triggered after closing
// is correctly handled.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
DestroyTimeoutDuringClosing) {
base::TimeDelta kTimeout = base::Seconds(1);
scoped_refptr<base::TestMockTimeTaskRunner> task_runner =
new base::TestMockTimeTaskRunner();
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.SetDeferTimerTaskRunnerForTesting(task_runner);
spare_manager.WarmupSpare(shell()->web_contents()->GetBrowserContext(),
kTimeout);
shell()->web_contents()->Close();
task_runner->FastForwardBy(kTimeout);
base::RunLoop().RunUntilIdle();
// The verification is that there are no DCHECKs or UaF anywhere during test
// tear down.
}
// This test verifies that SpareRenderProcessHostManager correctly accounts
// for StoragePartition differences when handing out the spare process.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareProcessVsCustomStoragePartition) {
ASSERT_TRUE(embedded_test_server()->Start());
// Provide custom storage partition for test sites.
GURL test_url = embedded_test_server()->GetURL("a.com", "/simple_page.html");
CustomStoragePartitionBrowserClient modified_client(GURL("http://a.com/"));
BrowserContext* browser_context =
ShellContentBrowserClient::Get()->browser_context();
scoped_refptr<SiteInstance> test_site_instance =
SiteInstance::CreateForURL(browser_context, test_url);
StoragePartition* default_storage =
browser_context->GetDefaultStoragePartition();
StoragePartition* custom_storage =
browser_context->GetStoragePartition(test_site_instance.get());
EXPECT_NE(default_storage, custom_storage);
// Open a test window - it should be associated with the default storage
// partition.
Shell* window = CreateBrowser();
RenderProcessHost* old_process =
window->web_contents()->GetPrimaryMainFrame()->GetProcess();
EXPECT_EQ(default_storage, old_process->GetStoragePartition());
// Warm up the spare process - it should be associated with the default
// storage partition.
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(browser_context);
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
ASSERT_TRUE(spare_renderer);
EXPECT_EQ(default_storage, spare_renderer->GetStoragePartition());
// Navigate to a URL that requires a custom storage partition.
EXPECT_TRUE(NavigateToURL(window, test_url));
RenderProcessHost* new_process =
window->web_contents()->GetPrimaryMainFrame()->GetProcess();
// Requirement to use a custom storage partition should force a process swap.
EXPECT_NE(new_process, old_process);
// The new process should be associated with the custom storage partition.
EXPECT_EQ(custom_storage, new_process->GetStoragePartition());
// And consequently, the spare shouldn't have been used.
EXPECT_NE(spare_renderer, new_process);
}
class RenderProcessHostObserverCounter : public RenderProcessHostObserver {
public:
explicit RenderProcessHostObserverCounter(RenderProcessHost* host) {
host->AddObserver(this);
observing_ = true;
observed_host_ = host;
}
RenderProcessHostObserverCounter(const RenderProcessHostObserverCounter&) =
delete;
RenderProcessHostObserverCounter& operator=(
const RenderProcessHostObserverCounter&) = delete;
~RenderProcessHostObserverCounter() override {
if (observing_) {
observed_host_->RemoveObserver(this);
}
}
void RenderProcessExited(RenderProcessHost* host,
const ChildProcessTerminationInfo& info) override {
DCHECK(observing_);
DCHECK_EQ(host, observed_host_);
exited_count_++;
}
void RenderProcessHostDestroyed(RenderProcessHost* host) override {
DCHECK(observing_);
DCHECK_EQ(host, observed_host_);
destroyed_count_++;
host->RemoveObserver(this);
observing_ = false;
observed_host_ = nullptr;
}
int exited_count() const { return exited_count_; }
int destroyed_count() const { return destroyed_count_; }
private:
int exited_count_ = 0;
int destroyed_count_ = 0;
bool observing_ = false;
raw_ptr<RenderProcessHost> observed_host_ = nullptr;
};
// Check that the spare renderer is properly destroyed via DisableRefCounts().
// Note: DisableRefCounts() used to be called DisableKeepAliveRefCount();
// the name if this test is left unchanged to avoid disrupt any tracking
// tools (e.g. flakiness) that might reference the old name.
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest,
SpareVsDisableKeepAliveRefCount) {
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
base::RunLoop().RunUntilIdle();
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
RenderProcessHostObserverCounter counter(spare_renderer);
RenderProcessHostWatcher process_watcher(
spare_renderer, RenderProcessHostWatcher::WATCH_FOR_HOST_DESTRUCTION);
spare_renderer->DisableRefCounts();
process_watcher.Wait();
EXPECT_TRUE(process_watcher.did_exit_normally());
// An important part of test verification is that UaF doesn't happen in the
// next revolution of the message pump - without extra care in the
// SpareRenderProcessHostManager RenderProcessHost::Cleanup could be called
// twice leading to a crash caused by double-free flavour of UaF in
// base::DeleteHelper<...>::DoDelete.
base::RunLoop().RunUntilIdle();
DCHECK_EQ(1, counter.exited_count());
DCHECK_EQ(1, counter.destroyed_count());
}
// Check that the spare renderer is properly destroyed via DisableRefCounts().
IN_PROC_BROWSER_TEST_F(SpareRenderProcessHostManagerTest, SpareVsFastShutdown) {
auto& spare_manager = SpareRenderProcessHostManagerImpl::Get();
ASSERT_EQ(spare_manager.GetSpares().size(), 0u);
spare_manager.WarmupSpare(
ShellContentBrowserClient::Get()->browser_context());
base::RunLoop().RunUntilIdle();
ASSERT_EQ(spare_manager.GetSpares().size(), 1u);
RenderProcessHost* spare_renderer = spare_manager.GetSpares()[0];
RenderProcessHostObserverCounter counter(spare_renderer);
RenderProcessHostWatcher process_watcher(
spare_renderer, RenderProcessHostWatcher::WATCH_FOR_HOST_DESTRUCTION);
spare_renderer->FastShutdownIfPossible();
process_watcher.Wait();
EXPECT_TRUE(process_watcher.did_exit_normally());
// An important part of test verification is that UaF doesn't happen in the
// next revolution of the message pump - without extra care in the
// SpareRenderProcessHostManager RenderProcessHost::Cleanup could be called
// twice leading to a crash caused by double-free flavour of UaF in
// base::DeleteHelper<...>::DoDelete.
base::RunLoop().RunUntilIdle();
DCHECK_EQ(1, counter.exited_count());
DCHECK_EQ(1, counter.destroyed_count());
}
} // namespace content