Support parallel captures from the StackSamplingProfiler.

base/profiler/stack_sampling_profiler_unittest.cc

 // 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 <utility>
@@ skipping 605 matching lines @@
       sample, &TargetThread::SignalAndWaitUntilSignaled);
   ASSERT_TRUE(loc != sample.frames.end())
       << "Function at "
       << MaybeFixupFunctionAddressForILT(reinterpret_cast<const void*>(
              &TargetThread::SignalAndWaitUntilSignaled))
       << " was not found in stack:\n"
       << FormatSampleForDiagnosticOutput(sample, profile.modules);
   FilePath executable_path;
   EXPECT_TRUE(PathService::Get(FILE_EXE, &executable_path));
   EXPECT_EQ(executable_path, profile.modules[loc->module_index].filename);
+
+  // Ensure the sampling thread is still running at this point.
+  ASSERT_TRUE(StackSamplingProfiler::IsSamplingThreadRunningForTesting());
+
+  // Shutdown the sampler as though the process were about to exit.
+  StackSamplingProfiler::Shutdown();
+  EXPECT_FALSE(StackSamplingProfiler::IsSamplingThreadRunningForTesting());
+
+  // Shutdown is a permanent thing in general but this needs to be undone so
+  // other tests can run.
+  StackSamplingProfiler::UndoShutdownForTesting();
+  EXPECT_FALSE(StackSamplingProfiler::IsSamplingThreadRunningForTesting());
 }
 
 // Checks that annotations are recorded in samples.
 #if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
 #define MAYBE_Annotations Annotations
 #else
 #define MAYBE_Annotations DISABLED_Annotations
 #endif
 TEST(StackSamplingProfilerTest, MAYBE_Annotations) {
   StackSamplingProfiler::ResetAnnotationsForTesting();
@@ skipping 210 matching lines @@
         target_thread_id, params, Bind(&SaveProfiles, Unretained(&profiles))));
     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 we can destroy the thread under test while profiling.
+#if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
+#define MAYBE_DestroyThreadWhileProfiling DestroyThreadWhileProfiling
+#else
+#define MAYBE_DestroyThreadWhileProfiling DISABLED_DestroyThreadWhileProfiling
+#endif
+TEST(StackSamplingProfilerTest, MAYBE_DestroyThreadWhileProfiling) {
+  // Set up a thread for testing.
+  StackConfiguration stack_config(StackConfiguration::NORMAL);
+  TargetThread target_thread(stack_config);
+  PlatformThreadHandle target_thread_handle;
+  ASSERT_TRUE(PlatformThread::Create(0, &target_thread, &target_thread_handle));
+
+  // Set up the sampler: 10 samples, 1 second apart
+  SamplingParams params;
+  params.sampling_interval = TimeDelta::FromSeconds(1);
+  params.samples_per_burst = 10;
+  std::vector<CallStackProfile> profiles;
+  WaitableEvent sampling_thread_completed(
+      WaitableEvent::ResetPolicy::MANUAL,
+      WaitableEvent::InitialState::NOT_SIGNALED);
+  const StackSamplingProfiler::CompletedCallback callback =
+      Bind(&SaveProfilesAndSignalEvent, Unretained(&profiles),
+           Unretained(&sampling_thread_completed));
+
+  // Start the thread and the sampler and wait a short while.
+  target_thread.WaitForThreadStart();
+  StackSamplingProfiler profiler(target_thread.id(), params, callback);
+  profiler.Start();
+
+  // Delay a short while so some samples will get collected.
+  PlatformThread::Sleep(TimeDelta::FromSeconds(3));

[Mike Wittman, 2017/01/31 22:14:27]

Coordinating threads via sleep will cause this test to be flaky when run under
load. We should do proper coordination via WaitableEvents to guarantee the
expected test behavior. I think this should be possible by adding calls into the
TestDelegate within the profiler at appropriate coordination points, and
supplying a TestDelegate implementation in the test that waits for the expected
events (e.g. thread has terminated).

[bcwhite, 2017/02/01 14:47:29]

I'll look at that.

[bcwhite, 2017/02/01 17:53:10]

Done.

+
+  // Stop the target thread.
+  target_thread.SignalThreadToFinish();
+  PlatformThread::Join(target_thread_handle);
+
+  // Wait a bit longer and ensure that the sampler completes.
+  PlatformThread::Sleep(TimeDelta::FromSeconds(2));
+
+  ASSERT_EQ(1U, profiles.size());
+  EXPECT_LT(1U, profiles[0].samples.size());
+  EXPECT_GT(9U, profiles[0].samples.size());
+}
+
 // Checks that the same profiler may be run multiple times.
 #if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
 #define MAYBE_CanRunMultipleTimes CanRunMultipleTimes
 #else
 #define MAYBE_CanRunMultipleTimes DISABLED_CanRunMultipleTimes
 #endif
 TEST(StackSamplingProfilerTest, MAYBE_CanRunMultipleTimes) {
+  StackSamplingProfiler::SetSamplingThreadIdleShutdownTimeForTesting(0);
+
   SamplingParams params;
   params.sampling_interval = TimeDelta::FromMilliseconds(0);
   params.samples_per_burst = 1;
 
   std::vector<CallStackProfile> profiles;
   CaptureProfiles(params, AVeryLongTimeDelta(), &profiles);
   ASSERT_EQ(1u, profiles.size());
 
   profiles.clear();
   CaptureProfiles(params, AVeryLongTimeDelta(), &profiles);
   ASSERT_EQ(1u, profiles.size());
+
+  // Capture thread should still be running at this point.
+  ASSERT_TRUE(StackSamplingProfiler::IsSamplingThreadRunningForTesting());
+
+  // Initiate an "idle" shutdown.  The task will be run immediately but on
+  // another thread so wait for it to complete.
+  StackSamplingProfiler::InitiateSamplingThreadIdleShutdownForTesting();
+  while (StackSamplingProfiler::IsSamplingThreadRunningForTesting())
+    PlatformThread::YieldCurrentThread();
+
+  // Ensure another capture will start the sampling thread and run.
+  profiles.clear();
+  CaptureProfiles(params, AVeryLongTimeDelta(), &profiles);
+  ASSERT_EQ(1u, profiles.size());
+  EXPECT_TRUE(StackSamplingProfiler::IsSamplingThreadRunningForTesting());
 }
 
 // Checks that requests to start profiling while another profile is taking place
 // are ignored.
 #if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
 #define MAYBE_ConcurrentProfiling ConcurrentProfiling
 #else
 #define MAYBE_ConcurrentProfiling DISABLED_ConcurrentProfiling
 #endif
 TEST(StackSamplingProfilerTest, MAYBE_ConcurrentProfiling) {
   WithTargetThread([](PlatformThreadId target_thread_id) {
     SamplingParams params[2];
     params[0].initial_delay = TimeDelta::FromMilliseconds(10);
-    params[0].sampling_interval = TimeDelta::FromMilliseconds(0);
-    params[0].samples_per_burst = 1;
+    params[0].sampling_interval = TimeDelta::FromMilliseconds(1);
+    params[0].samples_per_burst = 10;
 
-    params[1].sampling_interval = TimeDelta::FromMilliseconds(0);
-    params[1].samples_per_burst = 1;
+    params[0].initial_delay = TimeDelta::FromMilliseconds(10);
+    params[1].sampling_interval = TimeDelta::FromMilliseconds(1);
+    params[1].samples_per_burst = 10;
 
     CallStackProfiles profiles[2];
     std::vector<std::unique_ptr<WaitableEvent>> sampling_completed(2);
     std::vector<std::unique_ptr<StackSamplingProfiler>> profiler(2);
     for (int i = 0; i < 2; ++i) {
       sampling_completed[i] =
           MakeUnique<WaitableEvent>(WaitableEvent::ResetPolicy::AUTOMATIC,
                                     WaitableEvent::InitialState::NOT_SIGNALED);
       const StackSamplingProfiler::CompletedCallback callback =
           Bind(&SaveProfilesAndSignalEvent, Unretained(&profiles[i]),
@@ skipping 10 matching lines @@
     std::transform(
         sampling_completed.begin(), sampling_completed.end(),
         sampling_completed_rawptrs.begin(),
         [](const std::unique_ptr<WaitableEvent>& elem) { return elem.get(); });
     // Wait for one profiler to finish.
     size_t completed_profiler =
         WaitableEvent::WaitMany(sampling_completed_rawptrs.data(), 2);
     EXPECT_EQ(1u, profiles[completed_profiler].size());
 
     size_t other_profiler = 1 - completed_profiler;
-    // Give the other profiler a chance to run and observe that it hasn't.
-    EXPECT_FALSE(sampling_completed[other_profiler]->TimedWait(
-        TimeDelta::FromMilliseconds(25)));
-
-    // Start the other profiler again and it should run.
-    profiler[other_profiler]->Start();
-    sampling_completed[other_profiler]->Wait();
-    EXPECT_EQ(1u, profiles[other_profiler].size());
+    // Give the other profiler a chance to finish and verify it does no.
+    EXPECT_TRUE(sampling_completed[other_profiler]->TimedWait(
+        TimeDelta::FromMilliseconds(250)));
   });
 }
 
 // Checks that a stack that runs through another library produces a stack with
 // the expected functions.
 #if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
 #define MAYBE_OtherLibrary OtherLibrary
 #else
 #define MAYBE_OtherLibrary DISABLED_OtherLibrary
 #endif
@@ skipping 77 matching lines @@
 #if defined(STACK_SAMPLING_PROFILER_SUPPORTED)
 #define MAYBE_UnloadedLibrary UnloadedLibrary
 #else
 #define MAYBE_UnloadedLibrary DISABLED_UnloadedLibrary
 #endif
 TEST(StackSamplingProfilerTest, MAYBE_UnloadedLibrary) {
   TestLibraryUnload(true);
 }
 
 }  // namespace base