forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
stack_sampling_profiler_unittest.cc
1526 lines (1299 loc) · 60.1 KB
/
stack_sampling_profiler_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
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2015 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 <stddef.h>
#include <stdint.h>
#include <cstdlib>
#include <memory>
#include <set>
#include <utility>
#include <vector>
#include "base/bind.h"
#include "base/callback.h"
#include "base/compiler_specific.h"
#include "base/files/file_util.h"
#include "base/location.h"
#include "base/macros.h"
#include "base/memory/ptr_util.h"
#include "base/metrics/metrics_hashes.h"
#include "base/profiler/profiler_buildflags.h"
#include "base/profiler/sample_metadata.h"
#include "base/profiler/stack_sampler.h"
#include "base/profiler/stack_sampling_profiler.h"
#include "base/profiler/stack_sampling_profiler_test_util.h"
#include "base/profiler/unwinder.h"
#include "base/ranges/algorithm.h"
#include "base/run_loop.h"
#include "base/scoped_native_library.h"
#include "base/strings/utf_string_conversions.h"
#include "base/synchronization/lock.h"
#include "base/synchronization/waitable_event.h"
#include "base/test/bind.h"
#include "base/threading/simple_thread.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "testing/gtest/include/gtest/gtest.h"
#if defined(OS_WIN)
#include <intrin.h>
#include <malloc.h>
#include <windows.h>
#else
#include <alloca.h>
#endif
// STACK_SAMPLING_PROFILER_SUPPORTED is used to conditionally enable the tests
// below for supported platforms (currently Win x64 and Mac x64).
#if (defined(OS_WIN) && defined(ARCH_CPU_X86_64)) || \
(defined(OS_MAC) && defined(ARCH_CPU_X86_64)) || \
(defined(OS_ANDROID) && BUILDFLAG(ENABLE_ARM_CFI_TABLE))
#define STACK_SAMPLING_PROFILER_SUPPORTED 1
#endif
namespace base {
#if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
#define PROFILER_TEST_F(TestClass, TestName) TEST_F(TestClass, TestName)
#else
#define PROFILER_TEST_F(TestClass, TestName) \
TEST_F(TestClass, DISABLED_##TestName)
#endif
using SamplingParams = StackSamplingProfiler::SamplingParams;
namespace {
// State provided to the ProfileBuilder's ApplyMetadataRetrospectively function.
struct RetrospectiveMetadata {
TimeTicks period_start;
TimeTicks period_end;
MetadataRecorder::Item item;
};
// Profile consists of a set of samples and other sampling information.
struct Profile {
// The collected samples.
std::vector<std::vector<Frame>> samples;
// The number of invocations of RecordMetadata().
int record_metadata_count;
// The retrospective metadata requests.
std::vector<RetrospectiveMetadata> retrospective_metadata;
// Duration of this profile.
TimeDelta profile_duration;
// Time between samples.
TimeDelta sampling_period;
};
// The callback type used to collect a profile. The passed Profile is move-only.
// Other threads, including the UI thread, may block on callback completion so
// this should run as quickly as possible.
using ProfileCompletedCallback = OnceCallback<void(Profile)>;
// TestProfileBuilder collects samples produced by the profiler.
class TestProfileBuilder : public ProfileBuilder {
public:
TestProfileBuilder(ModuleCache* module_cache,
ProfileCompletedCallback callback);
~TestProfileBuilder() override;
// ProfileBuilder:
ModuleCache* GetModuleCache() override;
void RecordMetadata(
const MetadataRecorder::MetadataProvider& metadata_provider) override;
void ApplyMetadataRetrospectively(
TimeTicks period_start,
TimeTicks period_end,
const MetadataRecorder::Item& item) override;
void OnSampleCompleted(std::vector<Frame> sample,
TimeTicks sample_timestamp) override;
void OnProfileCompleted(TimeDelta profile_duration,
TimeDelta sampling_period) override;
private:
ModuleCache* module_cache_;
// The set of recorded samples.
std::vector<std::vector<Frame>> samples_;
// The number of invocations of RecordMetadata().
int record_metadata_count_ = 0;
// The retrospective metadata requests.
std::vector<RetrospectiveMetadata> retrospective_metadata_;
// Callback made when sampling a profile completes.
ProfileCompletedCallback callback_;
DISALLOW_COPY_AND_ASSIGN(TestProfileBuilder);
};
TestProfileBuilder::TestProfileBuilder(ModuleCache* module_cache,
ProfileCompletedCallback callback)
: module_cache_(module_cache), callback_(std::move(callback)) {}
TestProfileBuilder::~TestProfileBuilder() = default;
ModuleCache* TestProfileBuilder::GetModuleCache() {
return module_cache_;
}
void TestProfileBuilder::RecordMetadata(
const MetadataRecorder::MetadataProvider& metadata_provider) {
++record_metadata_count_;
}
void TestProfileBuilder::ApplyMetadataRetrospectively(
TimeTicks period_start,
TimeTicks period_end,
const MetadataRecorder::Item& item) {
retrospective_metadata_.push_back(
RetrospectiveMetadata{period_start, period_end, item});
}
void TestProfileBuilder::OnSampleCompleted(std::vector<Frame> sample,
TimeTicks sample_timestamp) {
samples_.push_back(std::move(sample));
}
void TestProfileBuilder::OnProfileCompleted(TimeDelta profile_duration,
TimeDelta sampling_period) {
std::move(callback_).Run(Profile{samples_, record_metadata_count_,
retrospective_metadata_, profile_duration,
sampling_period});
}
// Unloads |library| and returns when it has completed unloading. Unloading a
// library is asynchronous on Windows, so simply calling UnloadNativeLibrary()
// is insufficient to ensure it's been unloaded.
void SynchronousUnloadNativeLibrary(NativeLibrary library) {
UnloadNativeLibrary(library);
#if defined(OS_WIN)
// NativeLibrary is a typedef for HMODULE, which is actually the base address
// of the module.
uintptr_t module_base_address = reinterpret_cast<uintptr_t>(library);
HMODULE module_handle;
// Keep trying to get the module handle until the call fails.
while (::GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS |
GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
reinterpret_cast<LPCTSTR>(module_base_address),
&module_handle) ||
::GetLastError() != ERROR_MOD_NOT_FOUND) {
PlatformThread::Sleep(TimeDelta::FromMilliseconds(1));
}
#elif defined(OS_APPLE) || defined(OS_ANDROID)
// Unloading a library on Mac and Android is synchronous.
#else
NOTIMPLEMENTED();
#endif
}
void WithTargetThread(ProfileCallback profile_callback) {
UnwindScenario scenario(BindRepeating(&CallWithPlainFunction));
WithTargetThread(&scenario, std::move(profile_callback));
}
struct TestProfilerInfo {
TestProfilerInfo(SamplingProfilerThreadToken thread_token,
const SamplingParams& params,
ModuleCache* module_cache,
StackSamplerTestDelegate* delegate = nullptr)
: completed(WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED),
profiler(thread_token,
params,
std::make_unique<TestProfileBuilder>(
module_cache,
BindLambdaForTesting([this](Profile result_profile) {
profile = std::move(result_profile);
completed.Signal();
})),
CreateCoreUnwindersFactoryForTesting(module_cache),
RepeatingClosure(),
delegate) {}
// The order here is important to ensure objects being referenced don't get
// destructed until after the objects referencing them.
Profile profile;
WaitableEvent completed;
StackSamplingProfiler profiler;
private:
DISALLOW_COPY_AND_ASSIGN(TestProfilerInfo);
};
// Captures samples as specified by |params| on the TargetThread, and returns
// them. Waits up to |profiler_wait_time| for the profiler to complete.
std::vector<std::vector<Frame>> CaptureSamples(const SamplingParams& params,
TimeDelta profiler_wait_time,
ModuleCache* module_cache) {
std::vector<std::vector<Frame>> samples;
WithTargetThread(BindLambdaForTesting(
[&](SamplingProfilerThreadToken target_thread_token) {
TestProfilerInfo info(target_thread_token, params, module_cache);
info.profiler.Start();
info.completed.TimedWait(profiler_wait_time);
info.profiler.Stop();
info.completed.Wait();
samples = std::move(info.profile.samples);
}));
return samples;
}
// Waits for one of multiple samplings to complete.
size_t WaitForSamplingComplete(
const std::vector<std::unique_ptr<TestProfilerInfo>>& infos) {
// Map unique_ptrs to something that WaitMany can accept.
std::vector<WaitableEvent*> sampling_completed_rawptrs(infos.size());
ranges::transform(infos, sampling_completed_rawptrs.begin(),
[](const std::unique_ptr<TestProfilerInfo>& info) {
return &info.get()->completed;
});
// Wait for one profiler to finish.
return WaitableEvent::WaitMany(sampling_completed_rawptrs.data(),
sampling_completed_rawptrs.size());
}
// Returns a duration that is longer than the test timeout. We would use
// TimeDelta::Max() but https://crbug.com/465948.
TimeDelta AVeryLongTimeDelta() {
return TimeDelta::FromDays(1);
}
// Tests the scenario where the library is unloaded after copying the stack, but
// before walking it. If |wait_until_unloaded| is true, ensures that the
// asynchronous library loading has completed before walking the stack. If
// false, the unloading may still be occurring during the stack walk.
void TestLibraryUnload(bool wait_until_unloaded, ModuleCache* module_cache) {
// Test delegate that supports intervening between the copying of the stack
// and the walking of the stack.
class StackCopiedSignaler : public StackSamplerTestDelegate {
public:
StackCopiedSignaler(WaitableEvent* stack_copied,
WaitableEvent* start_stack_walk,
bool wait_to_walk_stack)
: stack_copied_(stack_copied),
start_stack_walk_(start_stack_walk),
wait_to_walk_stack_(wait_to_walk_stack) {}
void OnPreStackWalk() override {
stack_copied_->Signal();
if (wait_to_walk_stack_)
start_stack_walk_->Wait();
}
private:
WaitableEvent* const stack_copied_;
WaitableEvent* const start_stack_walk_;
const bool wait_to_walk_stack_;
};
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(0);
params.samples_per_profile = 1;
NativeLibrary other_library = LoadOtherLibrary();
UnwindScenario scenario(
BindRepeating(&CallThroughOtherLibrary, Unretained(other_library)));
UnwindScenario::SampleEvents events;
TargetThread target_thread(
BindLambdaForTesting([&]() { scenario.Execute(&events); }));
PlatformThreadHandle target_thread_handle;
EXPECT_TRUE(PlatformThread::Create(0, &target_thread, &target_thread_handle));
events.ready_for_sample.Wait();
WaitableEvent sampling_thread_completed(
WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED);
Profile profile;
WaitableEvent stack_copied(WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED);
WaitableEvent start_stack_walk(WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED);
StackCopiedSignaler test_delegate(&stack_copied, &start_stack_walk,
wait_until_unloaded);
StackSamplingProfiler profiler(
target_thread.thread_token(), params,
std::make_unique<TestProfileBuilder>(
module_cache,
BindLambdaForTesting(
[&profile, &sampling_thread_completed](Profile result_profile) {
profile = std::move(result_profile);
sampling_thread_completed.Signal();
})),
CreateCoreUnwindersFactoryForTesting(module_cache), RepeatingClosure(),
&test_delegate);
profiler.Start();
// Wait for the stack to be copied and the target thread to be resumed.
stack_copied.Wait();
// Cause the target thread to finish, so that it's no longer executing code in
// the library we're about to unload.
events.sample_finished.Signal();
PlatformThread::Join(target_thread_handle);
// Unload the library now that it's not being used.
if (wait_until_unloaded)
SynchronousUnloadNativeLibrary(other_library);
else
UnloadNativeLibrary(other_library);
// Let the stack walk commence after unloading the library, if we're waiting
// on that event.
start_stack_walk.Signal();
// Wait for the sampling thread to complete and fill out |profile|.
sampling_thread_completed.Wait();
// Look up the sample.
ASSERT_EQ(1u, profile.samples.size());
const std::vector<Frame>& sample = profile.samples[0];
if (wait_until_unloaded) {
// We expect the stack to look something like this, with the frame in the
// now-unloaded library having a null module.
//
// ... WaitableEvent and system frames ...
// WaitForSample()
// TargetThread::OtherLibraryCallback
// <frame in unloaded library>
EXPECT_EQ(nullptr, sample.back().module)
<< "Stack:\n"
<< FormatSampleForDiagnosticOutput(sample);
ExpectStackContains(sample, {scenario.GetWaitForSampleAddressRange()});
ExpectStackDoesNotContain(sample,
{scenario.GetSetupFunctionAddressRange(),
scenario.GetOuterFunctionAddressRange()});
} else {
// We didn't wait for the asynchronous unloading to complete, so the results
// are non-deterministic: if the library finished unloading we should have
// the same stack as |wait_until_unloaded|, if not we should have the full
// stack. The important thing is that we should not crash.
if (!sample.back().module) {
// This is the same case as |wait_until_unloaded|.
ExpectStackContains(sample, {scenario.GetWaitForSampleAddressRange()});
ExpectStackDoesNotContain(sample,
{scenario.GetSetupFunctionAddressRange(),
scenario.GetOuterFunctionAddressRange()});
return;
}
ExpectStackContains(sample, {scenario.GetWaitForSampleAddressRange(),
scenario.GetSetupFunctionAddressRange(),
scenario.GetOuterFunctionAddressRange()});
}
}
// Provide a suitable (and clean) environment for the tests below. All tests
// must use this class to ensure that proper clean-up is done and thus be
// usable in a later test.
class StackSamplingProfilerTest : public testing::Test {
public:
void SetUp() override {
// The idle-shutdown time is too long for convenient (and accurate) testing.
// That behavior is checked instead by artificially triggering it through
// the TestPeer.
StackSamplingProfiler::TestPeer::DisableIdleShutdown();
}
void TearDown() override {
// Be a good citizen and clean up after ourselves. This also re-enables the
// idle-shutdown behavior.
StackSamplingProfiler::TestPeer::Reset();
}
protected:
ModuleCache* module_cache() { return &module_cache_; }
private:
ModuleCache module_cache_;
};
} // namespace
// Checks that the basic expected information is present in sampled frames.
//
// macOS ASAN is not yet supported - crbug.com/718628.
//
// TODO(https://crbug.com/1100175): Enable this test again for Android with
// ASAN. This is now disabled because the android-asan bot fails.
#if (defined(ADDRESS_SANITIZER) && defined(OS_APPLE)) || \
(defined(ADDRESS_SANITIZER) && defined(OS_ANDROID))
#define MAYBE_Basic DISABLED_Basic
#else
#define MAYBE_Basic Basic
#endif
PROFILER_TEST_F(StackSamplingProfilerTest, MAYBE_Basic) {
UnwindScenario scenario(BindRepeating(&CallWithPlainFunction));
const std::vector<Frame>& sample = SampleScenario(&scenario, module_cache());
// Check that all the modules are valid.
for (const auto& frame : sample)
EXPECT_NE(nullptr, frame.module);
// The stack should contain a full unwind.
ExpectStackContains(sample, {scenario.GetWaitForSampleAddressRange(),
scenario.GetSetupFunctionAddressRange(),
scenario.GetOuterFunctionAddressRange()});
}
// A simple unwinder that always generates one frame then aborts the stack walk.
class TestAuxUnwinder : public Unwinder {
public:
TestAuxUnwinder(const Frame& frame_to_report,
base::RepeatingClosure add_initial_modules_callback)
: frame_to_report_(frame_to_report),
add_initial_modules_callback_(std::move(add_initial_modules_callback)) {
}
TestAuxUnwinder(const TestAuxUnwinder&) = delete;
TestAuxUnwinder& operator=(const TestAuxUnwinder&) = delete;
void InitializeModules() override {
if (add_initial_modules_callback_)
add_initial_modules_callback_.Run();
}
bool CanUnwindFrom(const Frame& current_frame) const override { return true; }
UnwindResult TryUnwind(RegisterContext* thread_context,
uintptr_t stack_top,
std::vector<Frame>* stack) const override {
stack->push_back(frame_to_report_);
return UnwindResult::ABORTED;
}
private:
const Frame frame_to_report_;
base::RepeatingClosure add_initial_modules_callback_;
};
// Checks that the profiler handles stacks containing dynamically-allocated
// stack memory.
// macOS ASAN is not yet supported - crbug.com/718628.
// Android is not supported since Chrome unwind tables don't support dynamic
// frames.
#if (defined(ADDRESS_SANITIZER) && defined(OS_APPLE)) || defined(OS_ANDROID)
#define MAYBE_Alloca DISABLED_Alloca
#else
#define MAYBE_Alloca Alloca
#endif
PROFILER_TEST_F(StackSamplingProfilerTest, MAYBE_Alloca) {
UnwindScenario scenario(BindRepeating(&CallWithAlloca));
const std::vector<Frame>& sample = SampleScenario(&scenario, module_cache());
// The stack should contain a full unwind.
ExpectStackContains(sample, {scenario.GetWaitForSampleAddressRange(),
scenario.GetSetupFunctionAddressRange(),
scenario.GetOuterFunctionAddressRange()});
}
// Checks that a stack that runs through another library produces a stack with
// the expected functions.
// macOS ASAN is not yet supported - crbug.com/718628.
// Android is not supported when EXCLUDE_UNWIND_TABLES |other_library| doesn't
// have unwind tables.
// TODO(https://crbug.com/1100175): Enable this test again for Android with
// ASAN. This is now disabled because the android-asan bot fails.
#if (defined(ADDRESS_SANITIZER) && defined(OS_APPLE)) || \
(defined(OS_ANDROID) && BUILDFLAG(EXCLUDE_UNWIND_TABLES)) || \
(defined(OS_ANDROID) && defined(ADDRESS_SANITIZER))
#define MAYBE_OtherLibrary DISABLED_OtherLibrary
#else
#define MAYBE_OtherLibrary OtherLibrary
#endif
PROFILER_TEST_F(StackSamplingProfilerTest, MAYBE_OtherLibrary) {
ScopedNativeLibrary other_library(LoadOtherLibrary());
UnwindScenario scenario(
BindRepeating(&CallThroughOtherLibrary, Unretained(other_library.get())));
const std::vector<Frame>& sample = SampleScenario(&scenario, module_cache());
// The stack should contain a full unwind.
ExpectStackContains(sample, {scenario.GetWaitForSampleAddressRange(),
scenario.GetSetupFunctionAddressRange(),
scenario.GetOuterFunctionAddressRange()});
}
// Checks that a stack that runs through a library that is unloading produces a
// stack, and doesn't crash.
// Unloading is synchronous on the Mac, so this test is inapplicable.
// Android is not supported when EXCLUDE_UNWIND_TABLES |other_library| doesn't
// have unwind tables.
// TODO(https://crbug.com/1100175): Enable this test again for Android with
// ASAN. This is now disabled because the android-asan bot fails.
#if defined(OS_APPLE) || \
(defined(OS_ANDROID) && BUILDFLAG(EXCLUDE_UNWIND_TABLES)) || \
(defined(OS_ANDROID) && defined(ADDRESS_SANITIZER))
#define MAYBE_UnloadingLibrary DISABLED_UnloadingLibrary
#else
#define MAYBE_UnloadingLibrary UnloadingLibrary
#endif
PROFILER_TEST_F(StackSamplingProfilerTest, MAYBE_UnloadingLibrary) {
TestLibraryUnload(false, module_cache());
}
// Checks that a stack that runs through a library that has been unloaded
// produces a stack, and doesn't crash.
// macOS ASAN is not yet supported - crbug.com/718628.
// Android is not supported since modules are found before unwinding.
#if (defined(ADDRESS_SANITIZER) && defined(OS_APPLE)) || defined(OS_ANDROID)
#define MAYBE_UnloadedLibrary DISABLED_UnloadedLibrary
#else
#define MAYBE_UnloadedLibrary UnloadedLibrary
#endif
PROFILER_TEST_F(StackSamplingProfilerTest, MAYBE_UnloadedLibrary) {
TestLibraryUnload(true, module_cache());
}
// Checks that a profiler can stop/destruct without ever having started.
PROFILER_TEST_F(StackSamplingProfilerTest, StopWithoutStarting) {
WithTargetThread(BindLambdaForTesting(
[this](SamplingProfilerThreadToken target_thread_token) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(0);
params.samples_per_profile = 1;
Profile profile;
WaitableEvent sampling_completed(
WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED);
StackSamplingProfiler profiler(
target_thread_token, params,
std::make_unique<TestProfileBuilder>(
module_cache(),
BindLambdaForTesting(
[&profile, &sampling_completed](Profile result_profile) {
profile = std::move(result_profile);
sampling_completed.Signal();
})),
CreateCoreUnwindersFactoryForTesting(module_cache()));
profiler.Stop(); // Constructed but never started.
EXPECT_FALSE(sampling_completed.IsSignaled());
}));
}
// Checks that its okay to stop a profiler before it finishes even when the
// sampling thread continues to run.
PROFILER_TEST_F(StackSamplingProfilerTest, StopSafely) {
// Test delegate that counts samples.
class SampleRecordedCounter : public StackSamplerTestDelegate {
public:
SampleRecordedCounter() = default;
void OnPreStackWalk() override {
AutoLock lock(lock_);
++count_;
}
size_t Get() {
AutoLock lock(lock_);
return count_;
}
private:
Lock lock_;
size_t count_ = 0;
};
WithTargetThread(
BindLambdaForTesting([](SamplingProfilerThreadToken target_thread_token) {
SamplingParams params[2];
// Providing an initial delay makes it more likely that both will be
// scheduled before either starts to run. Once started, samples will
// run ordered by their scheduled, interleaved times regardless of
// whatever interval the thread wakes up.
params[0].initial_delay = TimeDelta::FromMilliseconds(10);
params[0].sampling_interval = TimeDelta::FromMilliseconds(1);
params[0].samples_per_profile = 100000;
params[1].initial_delay = TimeDelta::FromMilliseconds(10);
params[1].sampling_interval = TimeDelta::FromMilliseconds(1);
params[1].samples_per_profile = 100000;
SampleRecordedCounter samples_recorded[size(params)];
ModuleCache module_cache1, module_cache2;
TestProfilerInfo profiler_info0(target_thread_token, params[0],
&module_cache1, &samples_recorded[0]);
TestProfilerInfo profiler_info1(target_thread_token, params[1],
&module_cache2, &samples_recorded[1]);
profiler_info0.profiler.Start();
profiler_info1.profiler.Start();
// Wait for both to start accumulating samples. Using a WaitableEvent is
// possible but gets complicated later on because there's no way of
// knowing if 0 or 1 additional sample will be taken after Stop() and
// thus no way of knowing how many Wait() calls to make on it.
while (samples_recorded[0].Get() == 0 || samples_recorded[1].Get() == 0)
PlatformThread::Sleep(TimeDelta::FromMilliseconds(1));
// Ensure that the first sampler can be safely stopped while the second
// continues to run. The stopped first profiler will still have a
// RecordSampleTask pending that will do nothing when executed because
// the collection will have been removed by Stop().
profiler_info0.profiler.Stop();
profiler_info0.completed.Wait();
size_t count0 = samples_recorded[0].Get();
size_t count1 = samples_recorded[1].Get();
// Waiting for the second sampler to collect a couple samples ensures
// that the pending RecordSampleTask for the first has executed because
// tasks are always ordered by their next scheduled time.
while (samples_recorded[1].Get() < count1 + 2)
PlatformThread::Sleep(TimeDelta::FromMilliseconds(1));
// Ensure that the first profiler didn't do anything since it was
// stopped.
EXPECT_EQ(count0, samples_recorded[0].Get());
}));
}
// Checks that no sample are captured if the profiling is stopped during the
// initial delay.
PROFILER_TEST_F(StackSamplingProfilerTest, StopDuringInitialDelay) {
SamplingParams params;
params.initial_delay = TimeDelta::FromSeconds(60);
std::vector<std::vector<Frame>> samples =
CaptureSamples(params, TimeDelta::FromMilliseconds(0), module_cache());
EXPECT_TRUE(samples.empty());
}
// Checks that tasks can be stopped before completion and incomplete samples are
// captured.
PROFILER_TEST_F(StackSamplingProfilerTest, StopDuringInterSampleInterval) {
// Test delegate that counts samples.
class SampleRecordedEvent : public StackSamplerTestDelegate {
public:
SampleRecordedEvent()
: sample_recorded_(WaitableEvent::ResetPolicy::MANUAL,
WaitableEvent::InitialState::NOT_SIGNALED) {}
void OnPreStackWalk() override { sample_recorded_.Signal(); }
void WaitForSample() { sample_recorded_.Wait(); }
private:
WaitableEvent sample_recorded_;
};
WithTargetThread(BindLambdaForTesting(
[this](SamplingProfilerThreadToken target_thread_token) {
SamplingParams params;
params.sampling_interval = AVeryLongTimeDelta();
params.samples_per_profile = 2;
SampleRecordedEvent samples_recorded;
TestProfilerInfo profiler_info(target_thread_token, params,
module_cache(), &samples_recorded);
profiler_info.profiler.Start();
// Wait for profiler to start accumulating samples.
samples_recorded.WaitForSample();
// Ensure that it can stop safely.
profiler_info.profiler.Stop();
profiler_info.completed.Wait();
EXPECT_EQ(1u, profiler_info.profile.samples.size());
}));
}
PROFILER_TEST_F(StackSamplingProfilerTest, GetNextSampleTime_NormalExecution) {
const auto& GetNextSampleTime =
StackSamplingProfiler::TestPeer::GetNextSampleTime;
const TimeTicks scheduled_current_sample_time = TimeTicks::UnixEpoch();
const TimeDelta sampling_interval = TimeDelta::FromMilliseconds(10);
// When executing the sample at exactly the scheduled time the next sample
// should be one interval later.
EXPECT_EQ(scheduled_current_sample_time + sampling_interval,
GetNextSampleTime(scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time));
// When executing the sample less than half an interval after the scheduled
// time the next sample also should be one interval later.
EXPECT_EQ(scheduled_current_sample_time + sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 0.4 * sampling_interval));
// When executing the sample less than half an interval before the scheduled
// time the next sample also should be one interval later. This is not
// expected to occur in practice since delayed tasks never run early.
EXPECT_EQ(scheduled_current_sample_time + sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time - 0.4 * sampling_interval));
}
PROFILER_TEST_F(StackSamplingProfilerTest, GetNextSampleTime_DelayedExecution) {
const auto& GetNextSampleTime =
StackSamplingProfiler::TestPeer::GetNextSampleTime;
const TimeTicks scheduled_current_sample_time = TimeTicks::UnixEpoch();
const TimeDelta sampling_interval = TimeDelta::FromMilliseconds(10);
// When executing the sample between 0.5 and 1.5 intervals after the scheduled
// time the next sample should be two intervals later.
EXPECT_EQ(scheduled_current_sample_time + 2 * sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 0.6 * sampling_interval));
EXPECT_EQ(scheduled_current_sample_time + 2 * sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 1.0 * sampling_interval));
EXPECT_EQ(scheduled_current_sample_time + 2 * sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 1.4 * sampling_interval));
// Similarly when executing the sample between 9.5 and 10.5 intervals after
// the scheduled time the next sample should be 11 intervals later.
EXPECT_EQ(scheduled_current_sample_time + 11 * sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 9.6 * sampling_interval));
EXPECT_EQ(scheduled_current_sample_time + 11 * sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 10.0 * sampling_interval));
EXPECT_EQ(scheduled_current_sample_time + 11 * sampling_interval,
GetNextSampleTime(
scheduled_current_sample_time, sampling_interval,
scheduled_current_sample_time + 10.4 * sampling_interval));
}
// Checks that we can destroy the profiler while profiling.
PROFILER_TEST_F(StackSamplingProfilerTest, DestroyProfilerWhileProfiling) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(10);
Profile profile;
WithTargetThread(BindLambdaForTesting([&, this](SamplingProfilerThreadToken
target_thread_token) {
std::unique_ptr<StackSamplingProfiler> profiler;
auto profile_builder = std::make_unique<TestProfileBuilder>(
module_cache(),
BindLambdaForTesting([&profile](Profile result_profile) {
profile = std::move(result_profile);
}));
profiler = std::make_unique<StackSamplingProfiler>(
target_thread_token, params, std::move(profile_builder),
CreateCoreUnwindersFactoryForTesting(module_cache()));
profiler->Start();
profiler.reset();
// Wait longer than a sample interval to catch any use-after-free actions by
// the profiler thread.
PlatformThread::Sleep(TimeDelta::FromMilliseconds(50));
}));
}
// Checks that the different profilers may be run.
PROFILER_TEST_F(StackSamplingProfilerTest, CanRunMultipleProfilers) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(0);
params.samples_per_profile = 1;
std::vector<std::vector<Frame>> samples =
CaptureSamples(params, AVeryLongTimeDelta(), module_cache());
ASSERT_EQ(1u, samples.size());
samples = CaptureSamples(params, AVeryLongTimeDelta(), module_cache());
ASSERT_EQ(1u, samples.size());
}
// Checks that a sampler can be started while another is running.
PROFILER_TEST_F(StackSamplingProfilerTest, MultipleStart) {
WithTargetThread(
BindLambdaForTesting([](SamplingProfilerThreadToken target_thread_token) {
SamplingParams params1;
params1.initial_delay = AVeryLongTimeDelta();
params1.samples_per_profile = 1;
ModuleCache module_cache1;
TestProfilerInfo profiler_info1(target_thread_token, params1,
&module_cache1);
SamplingParams params2;
params2.sampling_interval = TimeDelta::FromMilliseconds(1);
params2.samples_per_profile = 1;
ModuleCache module_cache2;
TestProfilerInfo profiler_info2(target_thread_token, params2,
&module_cache2);
profiler_info1.profiler.Start();
profiler_info2.profiler.Start();
profiler_info2.completed.Wait();
EXPECT_EQ(1u, profiler_info2.profile.samples.size());
}));
}
// Checks that the profile duration and the sampling interval are calculated
// correctly. Also checks that RecordMetadata() is invoked each time a sample
// is recorded.
PROFILER_TEST_F(StackSamplingProfilerTest, ProfileGeneralInfo) {
WithTargetThread(BindLambdaForTesting(
[this](SamplingProfilerThreadToken target_thread_token) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(1);
params.samples_per_profile = 3;
TestProfilerInfo profiler_info(target_thread_token, params,
module_cache());
profiler_info.profiler.Start();
profiler_info.completed.Wait();
EXPECT_EQ(3u, profiler_info.profile.samples.size());
// The profile duration should be greater than the total sampling
// intervals.
EXPECT_GT(profiler_info.profile.profile_duration,
profiler_info.profile.sampling_period * 3);
EXPECT_EQ(TimeDelta::FromMilliseconds(1),
profiler_info.profile.sampling_period);
// The number of invocations of RecordMetadata() should be equal to the
// number of samples recorded.
EXPECT_EQ(3, profiler_info.profile.record_metadata_count);
}));
}
// Checks that the sampling thread can shut down.
PROFILER_TEST_F(StackSamplingProfilerTest, SamplerIdleShutdown) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(0);
params.samples_per_profile = 1;
std::vector<std::vector<Frame>> samples =
CaptureSamples(params, AVeryLongTimeDelta(), module_cache());
ASSERT_EQ(1u, samples.size());
// Capture thread should still be running at this point.
ASSERT_TRUE(StackSamplingProfiler::TestPeer::IsSamplingThreadRunning());
// Initiate an "idle" shutdown and ensure it happens. Idle-shutdown was
// disabled by the test fixture so the test will fail due to a timeout if
// it does not exit.
StackSamplingProfiler::TestPeer::PerformSamplingThreadIdleShutdown(false);
// While the shutdown has been initiated, the actual exit of the thread still
// happens asynchronously. Watch until the thread actually exits. This test
// will time-out in the case of failure.
while (StackSamplingProfiler::TestPeer::IsSamplingThreadRunning())
PlatformThread::Sleep(TimeDelta::FromMilliseconds(1));
}
// Checks that additional requests will restart a stopped profiler.
PROFILER_TEST_F(StackSamplingProfilerTest,
WillRestartSamplerAfterIdleShutdown) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(0);
params.samples_per_profile = 1;
std::vector<std::vector<Frame>> samples =
CaptureSamples(params, AVeryLongTimeDelta(), module_cache());
ASSERT_EQ(1u, samples.size());
// Capture thread should still be running at this point.
ASSERT_TRUE(StackSamplingProfiler::TestPeer::IsSamplingThreadRunning());
// Post a ShutdownTask on the sampling thread which, when executed, will
// mark the thread as EXITING and begin shut down of the thread.
StackSamplingProfiler::TestPeer::PerformSamplingThreadIdleShutdown(false);
// Ensure another capture will start the sampling thread and run.
samples = CaptureSamples(params, AVeryLongTimeDelta(), module_cache());
ASSERT_EQ(1u, samples.size());
EXPECT_TRUE(StackSamplingProfiler::TestPeer::IsSamplingThreadRunning());
}
// Checks that it's safe to stop a task after it's completed and the sampling
// thread has shut-down for being idle.
PROFILER_TEST_F(StackSamplingProfilerTest, StopAfterIdleShutdown) {
WithTargetThread(BindLambdaForTesting(
[this](SamplingProfilerThreadToken target_thread_token) {
SamplingParams params;
params.sampling_interval = TimeDelta::FromMilliseconds(1);
params.samples_per_profile = 1;
TestProfilerInfo profiler_info(target_thread_token, params,
module_cache());
profiler_info.profiler.Start();
profiler_info.completed.Wait();
// Capture thread should still be running at this point.
ASSERT_TRUE(StackSamplingProfiler::TestPeer::IsSamplingThreadRunning());
// Perform an idle shutdown.
StackSamplingProfiler::TestPeer::PerformSamplingThreadIdleShutdown(
false);
// Stop should be safe though its impossible to know at this moment if
// the sampling thread has completely exited or will just "stop soon".
profiler_info.profiler.Stop();
}));
}
// Checks that profilers can run both before and after the sampling thread has
// started.
PROFILER_TEST_F(StackSamplingProfilerTest,
ProfileBeforeAndAfterSamplingThreadRunning) {
WithTargetThread(
BindLambdaForTesting([](SamplingProfilerThreadToken target_thread_token) {
ModuleCache module_cache1;
ModuleCache module_cache2;
std::vector<std::unique_ptr<TestProfilerInfo>> profiler_infos;
profiler_infos.push_back(std::make_unique<TestProfilerInfo>(
target_thread_token,
SamplingParams{
/*initial_delay=*/AVeryLongTimeDelta(),
/*samples_per_profile=*/1,
/*sampling_interval=*/TimeDelta::FromMilliseconds(1)},
&module_cache1));
profiler_infos.push_back(std::make_unique<TestProfilerInfo>(
target_thread_token,
SamplingParams{
/*initial_delay=*/TimeDelta::FromMilliseconds(0),
/*samples_per_profile=*/1,
/*sampling_interval=*/TimeDelta::FromMilliseconds(1)},
&module_cache2));
// First profiler is started when there has never been a sampling
// thread.
EXPECT_FALSE(
StackSamplingProfiler::TestPeer::IsSamplingThreadRunning());
profiler_infos[0]->profiler.Start();
// Second profiler is started when sampling thread is already running.
EXPECT_TRUE(StackSamplingProfiler::TestPeer::IsSamplingThreadRunning());
profiler_infos[1]->profiler.Start();
// Only the second profiler should finish before test times out.
size_t completed_profiler = WaitForSamplingComplete(profiler_infos);