forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
scoped_blocking_call_unittest.cc
807 lines (651 loc) · 28.4 KB
/
scoped_blocking_call_unittest.cc
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
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/threading/scoped_blocking_call.h"
#include <memory>
#include <utility>
#include <vector>
#include "base/barrier_closure.h"
#include "base/bind.h"
#include "base/callback.h"
#include "base/macros.h"
#include "base/task/thread_pool/environment_config.h"
#include "base/task/thread_pool/thread_pool_impl.h"
#include "base/test/bind_test_util.h"
#include "base/test/gtest_util.h"
#include "base/test/task_environment.h"
#include "base/test/test_waitable_event.h"
#include "base/threading/scoped_blocking_call_internal.h"
#include "base/threading/thread_restrictions.h"
#include "build/build_config.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using testing::ElementsAre;
namespace base {
namespace {
class MockBlockingObserver : public internal::BlockingObserver {
public:
MockBlockingObserver() = default;
MOCK_METHOD1(BlockingStarted, void(BlockingType));
MOCK_METHOD0(BlockingTypeUpgraded, void());
MOCK_METHOD0(BlockingEnded, void());
private:
DISALLOW_COPY_AND_ASSIGN(MockBlockingObserver);
};
class ScopedBlockingCallTest : public testing::Test {
protected:
ScopedBlockingCallTest() {
internal::SetBlockingObserverForCurrentThread(&observer_);
}
~ScopedBlockingCallTest() override {
internal::ClearBlockingObserverForCurrentThread();
}
testing::StrictMock<MockBlockingObserver> observer_;
private:
DISALLOW_COPY_AND_ASSIGN(ScopedBlockingCallTest);
};
} // namespace
TEST_F(ScopedBlockingCallTest, MayBlock) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::MAY_BLOCK));
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::MAY_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
EXPECT_CALL(observer_, BlockingEnded());
}
TEST_F(ScopedBlockingCallTest, WillBlock) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::WILL_BLOCK));
ScopedBlockingCall scoped_blocking_call(FROM_HERE, BlockingType::WILL_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
EXPECT_CALL(observer_, BlockingEnded());
}
TEST_F(ScopedBlockingCallTest, MayBlockWillBlock) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::MAY_BLOCK));
ScopedBlockingCall scoped_blocking_call_a(FROM_HERE, BlockingType::MAY_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
{
EXPECT_CALL(observer_, BlockingTypeUpgraded());
ScopedBlockingCall scoped_blocking_call_b(FROM_HERE,
BlockingType::WILL_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
}
EXPECT_CALL(observer_, BlockingEnded());
}
TEST_F(ScopedBlockingCallTest, WillBlockMayBlock) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::WILL_BLOCK));
ScopedBlockingCall scoped_blocking_call_a(FROM_HERE,
BlockingType::WILL_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
{
ScopedBlockingCall scoped_blocking_call_b(FROM_HERE,
BlockingType::MAY_BLOCK);
}
EXPECT_CALL(observer_, BlockingEnded());
}
TEST_F(ScopedBlockingCallTest, MayBlockMayBlock) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::MAY_BLOCK));
ScopedBlockingCall scoped_blocking_call_a(FROM_HERE, BlockingType::MAY_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
{
ScopedBlockingCall scoped_blocking_call_b(FROM_HERE,
BlockingType::MAY_BLOCK);
}
EXPECT_CALL(observer_, BlockingEnded());
}
TEST_F(ScopedBlockingCallTest, WillBlockWillBlock) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::WILL_BLOCK));
ScopedBlockingCall scoped_blocking_call_a(FROM_HERE,
BlockingType::WILL_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
{
ScopedBlockingCall scoped_blocking_call_b(FROM_HERE,
BlockingType::WILL_BLOCK);
}
EXPECT_CALL(observer_, BlockingEnded());
}
TEST_F(ScopedBlockingCallTest, MayBlockWillBlockTwice) {
EXPECT_CALL(observer_, BlockingStarted(BlockingType::MAY_BLOCK));
ScopedBlockingCall scoped_blocking_call_a(FROM_HERE, BlockingType::MAY_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
{
EXPECT_CALL(observer_, BlockingTypeUpgraded());
ScopedBlockingCall scoped_blocking_call_b(FROM_HERE,
BlockingType::WILL_BLOCK);
testing::Mock::VerifyAndClear(&observer_);
{
ScopedBlockingCall scoped_blocking_call_c(FROM_HERE,
BlockingType::MAY_BLOCK);
ScopedBlockingCall scoped_blocking_call_d(FROM_HERE,
BlockingType::WILL_BLOCK);
}
}
EXPECT_CALL(observer_, BlockingEnded());
}
TEST(ScopedBlockingCallDestructionOrderTest, InvalidDestructionOrder) {
auto scoped_blocking_call_a =
std::make_unique<ScopedBlockingCall>(FROM_HERE, BlockingType::WILL_BLOCK);
auto scoped_blocking_call_b =
std::make_unique<ScopedBlockingCall>(FROM_HERE, BlockingType::WILL_BLOCK);
EXPECT_DCHECK_DEATH({ scoped_blocking_call_a.reset(); });
}
class ScopedBlockingCallIOJankMonitoringTest : public testing::Test {
public:
ScopedBlockingCallIOJankMonitoringTest() = default;
void SetUp() override {
// Note 1: While EnableIOJankMonitoringForProcess() is documented as being
// only callable once per process. The call to CancelMonitoringForTesting()
// in TearDown() makes it okay to call this in multiple tests in a row
// within a single process.
// Note 2: No need to check TimeTicks::IsConsistentAcrossProcesses() in
// spite of EnableIOJankMonitoringForProcess()'s requirement as
// TimeSource::MOCK_TIME avoids usage of the system clock and avoids the
// issue.
EnableIOJankMonitoringForProcess(BindLambdaForTesting(
[&](int janky_intervals_per_minute, int total_janks_per_minute) {
reports_.push_back(
{janky_intervals_per_minute, total_janks_per_minute});
}));
}
void TearDown() override {
internal::IOJankMonitoringWindow::CancelMonitoringForTesting();
}
protected:
// A member initialized before |task_environment_| that forces worker threads
// to be started synchronously. This avoids a tricky race where Linux invokes
// SetCurrentThreadPriority() from early main, before invoking ThreadMain and
// yielding control to the thread pool impl. That causes a ScopedBlockingCall
// in platform_thread_linux.cc:SetThreadCgroupForThreadPriority and interferes
// with this test. This solution is quite intrusive but is the simplest we can
// do for this unique corner case.
struct SetSynchronousThreadStart {
SetSynchronousThreadStart() {
internal::ThreadPoolImpl::SetSynchronousThreadStartForTesting(true);
}
~SetSynchronousThreadStart() {
internal::ThreadPoolImpl::SetSynchronousThreadStartForTesting(false);
}
} set_synchronous_thread_start_;
// The registered lambda above may report to this from any thread. It is
// nonetheless safe to read this from the test body as
// TaskEnvironment+MOCK_TIME advances the test in lock steps.
std::vector<std::pair<int, int>> reports_;
test::TaskEnvironment task_environment_{
test::TaskEnvironment::TimeSource::MOCK_TIME};
};
TEST_F(ScopedBlockingCallIOJankMonitoringTest, Basic) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
// Advance precisely to the end of this window.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow - kJankTiming);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 7)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, NestedDoesntMatter) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
ScopedBlockingCall nested(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
// Jump to the next window.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 7)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, ManyInAWindow) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
constexpr auto kIdleTiming = TimeDelta::FromSeconds(3);
for (int i = 0; i < 3; ++i) {
{
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
task_environment_.FastForwardBy(kIdleTiming);
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
// Complete the current window.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow -
(kJankTiming + kIdleTiming) * 3);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7 * 3, 7 * 3)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, OverlappingMultipleWindows) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kMonitoringWindow * 3 +
internal::IOJankMonitoringWindow::kIOJankInterval * 5;
{
ScopedBlockingCall blocked_for_3windows(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
// Fast-forward by another window with no active blocking calls.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
// 3 windows janky for their full breadth and 1 window janky for 5 seconds.
EXPECT_THAT(reports_,
ElementsAre(std::make_pair(60, 60), std::make_pair(60, 60),
std::make_pair(60, 60), std::make_pair(5, 5)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, InstantUnblockReportsZero) {
{ ScopedBlockingCall instant_unblock(FROM_HERE, BlockingType::MAY_BLOCK); }
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
// No blocking call in next window also reports zero.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_,
ElementsAre(std::make_pair(0, 0), std::make_pair(0, 0)));
}
// Start the jank mid-interval; that interval shouldn't be counted but the last
// incomplete interval will count.
TEST_F(ScopedBlockingCallIOJankMonitoringTest, Jank7sMidInterval) {
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kIOJankInterval / 3);
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 7)));
}
// Start the jank mid-interval; that interval shouldn't be counted but the
// second one should be despite being incomplete.
TEST_F(ScopedBlockingCallIOJankMonitoringTest, Jank1sMidInterval) {
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kIOJankInterval / 3);
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval;
{
ScopedBlockingCall blocked_for_1s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(1, 1)));
}
// Start mid-interval and perform an operation that overlaps into the next one
// but is under the jank timing.
TEST_F(ScopedBlockingCallIOJankMonitoringTest, NoJankMidInterval) {
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kIOJankInterval / 3);
{
ScopedBlockingCall non_janky(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kIOJankInterval -
TimeDelta::FromMilliseconds(1));
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, MultiThreaded) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
// Every worker needs to block for precise clock management; hence we can't
// test beyond the TaskEnvironment's capacity.
const int kNumJankyTasks =
test::TaskEnvironment::kNumForegroundThreadPoolThreads;
TestWaitableEvent all_threads_blocked;
auto on_thread_blocked = BarrierClosure(
kNumJankyTasks,
BindOnce(&TestWaitableEvent::Signal, Unretained(&all_threads_blocked)));
TestWaitableEvent resume_all_threads;
for (int i = 0; i < kNumJankyTasks; ++i) {
base::ThreadPool::PostTask(
FROM_HERE, {MayBlock()}, BindLambdaForTesting([&]() {
ScopedBlockingCall blocked_until_signal(FROM_HERE,
BlockingType::MAY_BLOCK);
on_thread_blocked.Run();
ScopedAllowBaseSyncPrimitivesForTesting allow_wait;
resume_all_threads.Wait();
}));
}
all_threads_blocked.Wait();
task_environment_.AdvanceClock(kJankTiming);
resume_all_threads.Signal();
task_environment_.RunUntilIdle();
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
// Still only 7 janky internals, but more overall janks.
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 7 * kNumJankyTasks)));
}
// 3 janks of 3 seconds; overlapping but starting 1 second apart from each
// other.
TEST_F(ScopedBlockingCallIOJankMonitoringTest, MultiThreadedOverlapped) {
static const int kNumJankyTasks = 3;
static_assert(
kNumJankyTasks <= test::TaskEnvironment::kNumForegroundThreadPoolThreads,
"");
TestWaitableEvent next_task_is_blocked(WaitableEvent::ResetPolicy::AUTOMATIC);
TestWaitableEvent resume_thread[kNumJankyTasks] = {};
TestWaitableEvent exited_blocking_scope[kNumJankyTasks] = {};
auto blocking_task = BindLambdaForTesting([&](int task_index) {
{
// Simulate jank until |resume_thread[task_index]| is signaled.
ScopedBlockingCall blocked_until_signal(FROM_HERE,
BlockingType::MAY_BLOCK);
next_task_is_blocked.Signal();
ScopedAllowBaseSyncPrimitivesForTesting allow_wait;
resume_thread[task_index].Wait();
}
exited_blocking_scope[task_index].Signal();
});
// [0-1]s
base::ThreadPool::PostTask(FROM_HERE, {MayBlock()},
BindOnce(blocking_task, 0));
next_task_is_blocked.Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kIOJankInterval);
// [1-2]s
base::ThreadPool::PostTask(FROM_HERE, {MayBlock()},
BindOnce(blocking_task, 1));
next_task_is_blocked.Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kIOJankInterval);
// [2-3]s
base::ThreadPool::PostTask(FROM_HERE, {MayBlock()},
BindOnce(blocking_task, 2));
next_task_is_blocked.Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kIOJankInterval);
// [3-6]s
for (int i = 0; i < kNumJankyTasks; ++i) {
resume_thread[i].Signal();
exited_blocking_scope[i].Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kIOJankInterval);
}
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
// 9s of total janks spread across 5 intervals.
EXPECT_THAT(reports_, ElementsAre(std::make_pair(5, 9)));
}
// 3 janks of 180 seconds; overlapping but starting 60s apart from each other.
// First one starting at 10 seconds (can't start later than that or we'll trip
// the kTimeDiscrepancyTimeout per TaskEnvironment's inability to RunUntilIdle()
// with pending blocked tasks).
#if defined(OS_LINUX) || defined(OS_CHROMEOS)
// https://crbug.com/1071166
#define MAYBE_MultiThreadedOverlappedWindows \
DISABLED_MultiThreadedOverlappedWindows
#else
#define MAYBE_MultiThreadedOverlappedWindows MultiThreadedOverlappedWindows
#endif
TEST_F(ScopedBlockingCallIOJankMonitoringTest,
MAYBE_MultiThreadedOverlappedWindows) {
static const int kNumJankyTasks = 3;
static_assert(
kNumJankyTasks <= test::TaskEnvironment::kNumForegroundThreadPoolThreads,
"");
TestWaitableEvent next_task_is_blocked(WaitableEvent::ResetPolicy::AUTOMATIC);
TestWaitableEvent resume_thread[kNumJankyTasks] = {};
TestWaitableEvent exited_blocking_scope[kNumJankyTasks] = {};
auto blocking_task = BindLambdaForTesting([&](int task_index) {
{
// Simulate jank until |resume_thread[task_index]| is signaled.
ScopedBlockingCall blocked_until_signal(FROM_HERE,
BlockingType::MAY_BLOCK);
next_task_is_blocked.Signal();
ScopedAllowBaseSyncPrimitivesForTesting allow_wait;
resume_thread[task_index].Wait();
}
exited_blocking_scope[task_index].Signal();
});
// [0-10s] (minus 1 ms to avoid reaching the timeout; this also tests the
// logic that intervals are rounded down to the starting interval (e.g.
// interval 9/60 in this case)).
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kTimeDiscrepancyTimeout -
TimeDelta::FromMilliseconds(1));
// [10-70]s
base::ThreadPool::PostTask(FROM_HERE, {MayBlock()},
BindOnce(blocking_task, 0));
next_task_is_blocked.Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kMonitoringWindow);
// [70-130]s
base::ThreadPool::PostTask(FROM_HERE, {MayBlock()},
BindOnce(blocking_task, 1));
next_task_is_blocked.Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kMonitoringWindow);
// [130-190]s
base::ThreadPool::PostTask(FROM_HERE, {MayBlock()},
BindOnce(blocking_task, 2));
next_task_is_blocked.Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kMonitoringWindow);
// [190-370]s
for (int i = 0; i < kNumJankyTasks; ++i) {
resume_thread[i].Signal();
exited_blocking_scope[i].Wait();
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kMonitoringWindow);
}
// Already past the last window (relevant events end at 360s); flush the
// pending ripe delayed task that will complete the last window.
task_environment_.RunUntilIdle();
// 540s(180s*3) of total janks spread across 300 intervals in 6 windows.
// Distributed as such (zoomed out to 6 intervals per window):
// [011111]
// [122222]
// [233333]
// [322222]
// [21111]
// [100000]
// Starting at the 9th interval per the 10s-1ms offset start.
EXPECT_THAT(reports_,
ElementsAre(std::make_pair(51, 51), std::make_pair(60, 111),
std::make_pair(60, 171), std::make_pair(60, 129),
std::make_pair(60, 69), std::make_pair(9, 9)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, CancellationAcrossSleep) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kJankTiming);
}
// Jump just beyond the kTimeDiscrepancyTimeout for the next window.
task_environment_.AdvanceClock(
internal::IOJankMonitoringWindow::kMonitoringWindow +
internal::IOJankMonitoringWindow::kTimeDiscrepancyTimeout - kJankTiming);
task_environment_.RunUntilIdle();
// Window was canceled and previous jank was not reported.
EXPECT_THAT(reports_, ElementsAre());
// The second window should be independent and need a full kMonitoringWindow
// to elapse before reporting.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow -
TimeDelta::FromSeconds(1));
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(TimeDelta::FromSeconds(1));
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, SleepWithLongJank) {
{
ScopedBlockingCall blocked_through_sleep(FROM_HERE,
BlockingType::MAY_BLOCK);
// Fast-forward 2 full windows and almost to the end of the 3rd.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow * 3 -
TimeDelta::FromSeconds(1));
// Simulate a "sleep" over the timeout threshold.
task_environment_.AdvanceClock(
TimeDelta::FromSeconds(1) +
internal::IOJankMonitoringWindow::kTimeDiscrepancyTimeout);
}
// Two full jank windows are reported when the ScopedBlokcingCall unwinds but
// the 3rd is canceled.
EXPECT_THAT(reports_,
ElementsAre(std::make_pair(60, 60), std::make_pair(60, 60)));
// The 4th window has a new |start_time| so completing the "remaining delta"
// doesn't cause a report from the cancelled 3rd window.
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow -
TimeDelta::FromSeconds(1));
EXPECT_THAT(reports_,
ElementsAre(std::make_pair(60, 60), std::make_pair(60, 60)));
// Completing the whole 4th window generates a report.
task_environment_.FastForwardBy(TimeDelta::FromSeconds(1));
EXPECT_THAT(reports_,
ElementsAre(std::make_pair(60, 60), std::make_pair(60, 60),
std::make_pair(0, 0)));
}
// Verifies that blocking calls on background workers aren't monitored.
// Platforms where !CanUseBackgroundPriorityForWorkerThread() will still monitor
// this jank (as it may interfere with other foreground work).
TEST_F(ScopedBlockingCallIOJankMonitoringTest, BackgroundBlockingCallsIgnored) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
TestWaitableEvent task_running;
TestWaitableEvent resume_task;
base::ThreadPool::PostTask(
FROM_HERE, {TaskPriority::BEST_EFFORT, MayBlock()},
BindLambdaForTesting([&]() {
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_running.Signal();
ScopedAllowBaseSyncPrimitivesForTesting allow_wait;
resume_task.Wait();
}));
task_running.Wait();
task_environment_.AdvanceClock(kJankTiming);
resume_task.Signal();
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
if (internal::CanUseBackgroundPriorityForWorkerThread())
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
else
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 7)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest,
BackgroundAndForegroundCallsMixed) {
constexpr auto kJankTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
TestWaitableEvent tasks_running;
auto on_task_running = BarrierClosure(
2, BindOnce(&TestWaitableEvent::Signal, Unretained(&tasks_running)));
TestWaitableEvent resume_tasks;
base::ThreadPool::PostTask(
FROM_HERE, {TaskPriority::BEST_EFFORT, MayBlock()},
BindLambdaForTesting([&]() {
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
on_task_running.Run();
ScopedAllowBaseSyncPrimitivesForTesting allow_wait;
resume_tasks.Wait();
}));
base::ThreadPool::PostTask(
FROM_HERE, {TaskPriority::USER_BLOCKING, MayBlock()},
BindLambdaForTesting([&]() {
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
on_task_running.Run();
ScopedAllowBaseSyncPrimitivesForTesting allow_wait;
resume_tasks.Wait();
}));
tasks_running.Wait();
task_environment_.AdvanceClock(kJankTiming);
resume_tasks.Signal();
// No janks reported before the monitoring window completes.
EXPECT_THAT(reports_, ElementsAre());
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
if (internal::CanUseBackgroundPriorityForWorkerThread())
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 7)));
else
EXPECT_THAT(reports_, ElementsAre(std::make_pair(7, 14)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, WillBlockNotMonitored) {
constexpr auto kBlockedTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_7s(FROM_HERE, BlockingType::WILL_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
}
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest,
NestedWillBlockCancelsMonitoring) {
constexpr auto kBlockedTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_14s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
ScopedBlockingCall will_block_for_7s(FROM_HERE, BlockingType::WILL_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
}
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, NestedMayBlockIgnored) {
constexpr auto kBlockedTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_14s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
ScopedBlockingCall may_block_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
}
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(14, 14)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest, BaseSyncPrimitivesNotMonitored) {
constexpr auto kBlockedTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
// Even with MAY_BLOCK; base-sync-primitives aren't considered I/O jank
// (base-sync-primitives induced janks/hangs are captured by other tools,
// like Slow Reports and HangWatcher).
internal::ScopedBlockingCallWithBaseSyncPrimitives
base_sync_primitives_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
}
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
}
TEST_F(ScopedBlockingCallIOJankMonitoringTest,
NestedBaseSyncPrimitivesCancels) {
constexpr auto kBlockedTiming =
internal::IOJankMonitoringWindow::kIOJankInterval * 7;
{
ScopedBlockingCall blocked_for_14s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
internal::ScopedBlockingCallWithBaseSyncPrimitives
base_sync_primitives_for_7s(FROM_HERE, BlockingType::MAY_BLOCK);
task_environment_.FastForwardBy(kBlockedTiming);
}
task_environment_.FastForwardBy(
internal::IOJankMonitoringWindow::kMonitoringWindow);
EXPECT_THAT(reports_, ElementsAre(std::make_pair(0, 0)));
}
} // namespace base