Enable startup profiling by Win x64 stack sampling profiler

base/profiler/stack_sampling_profiler.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 "base/profiler/stack_sampling_profiler.h"
 
 #include <algorithm>
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/memory/singleton.h"
 #include "base/synchronization/lock.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/timer/elapsed_timer.h"
 
 template <typename T> struct DefaultSingletonTraits;
 
 namespace base {
 
 namespace {
 
-// Thread-safe singleton class that stores collected profiles waiting to be
-// processed.
-class PendingProfiles {
+// Singleton class responsible for providing the default processing for profiles
+// (i.e. for profiles generated by profilers without their own completed
+// callback).
+class DefaultProfileProcessor {
  public:
-  PendingProfiles();
-  ~PendingProfiles();
+  using CompletedCallback = StackSamplingProfiler::CompletedCallback;
 
-  static PendingProfiles* GetInstance();
+  DefaultProfileProcessor();
+  ~DefaultProfileProcessor();
 
-  // Appends |profiles|. This function is thread safe.
-  void PutProfiles(const std::vector<StackSamplingProfiler::Profile>& profiles);
-  // Gets the pending profiles into *|profiles|. This function is thread safe.
+  static DefaultProfileProcessor* GetInstance();
+
+  // Sets the callback to use for processing profiles captured without a
+  // per-profiler completed callback. Pending completed profiles are stored in
+  // this object until a non-null callback is provided here. This function is
+  // thread-safe.
+  void SetCompletedCallback(CompletedCallback callback);
+
+  // Processes |profiles|. This function is thread safe.
+  void ProcessProfiles(
+      const std::vector<StackSamplingProfiler::Profile>& profiles);
+
+ private:
+  // Gets the pending profiles into *|profiles|, with proper locking.
   void GetProfiles(std::vector<StackSamplingProfiler::Profile>* profiles);
 
- private:
+  // Gets the current completed callback, with proper locking.
+  CompletedCallback GetCompletedCallback() const;
+
+  mutable Lock callback_lock_;
+  CompletedCallback default_completed_callback_;
+
   Lock profiles_lock_;
   std::vector<StackSamplingProfiler::Profile> profiles_;
 
-  DISALLOW_COPY_AND_ASSIGN(PendingProfiles);
+  DISALLOW_COPY_AND_ASSIGN(DefaultProfileProcessor);
 };
 
-PendingProfiles::PendingProfiles() {}
+DefaultProfileProcessor::DefaultProfileProcessor() {}
 
-PendingProfiles::~PendingProfiles() {}
+DefaultProfileProcessor::~DefaultProfileProcessor() {}
 
 // static
-PendingProfiles* PendingProfiles::GetInstance() {
-  return Singleton<PendingProfiles>::get();
+DefaultProfileProcessor* DefaultProfileProcessor::GetInstance() {
+  return Singleton<DefaultProfileProcessor>::get();
 }
 
-void PendingProfiles::PutProfiles(
-    const std::vector<StackSamplingProfiler::Profile>& profiles) {
-  AutoLock scoped_lock(profiles_lock_);
-  profiles_.insert(profiles_.end(), profiles.begin(), profiles.end());
+void DefaultProfileProcessor::SetCompletedCallback(CompletedCallback callback) {
+  {
+    AutoLock scoped_lock(callback_lock_);
+    default_completed_callback_ = callback;
+  }
+
+  if (!callback.is_null()) {
+    // Provide any pending profiles to the callback immediately.
+    std::vector<StackSamplingProfiler::Profile> profiles;
+    GetProfiles(&profiles);
+    if (!profiles.empty())
+      callback.Run(profiles);
+  }
 }
 
-void PendingProfiles::GetProfiles(
+void DefaultProfileProcessor::ProcessProfiles(
+    const std::vector<StackSamplingProfiler::Profile>& profiles) {
+  CompletedCallback callback = GetCompletedCallback();
+
+  // Store pending profiles if we don't have a valid callback.
+  if (!callback.is_null()) {
+    callback.Run(profiles);
+  } else {
+    AutoLock scoped_lock(profiles_lock_);
+    profiles_.insert(profiles_.end(), profiles.begin(), profiles.end());
+  }
+}
+
+void DefaultProfileProcessor::GetProfiles(
     std::vector<StackSamplingProfiler::Profile>* profiles) {
   profiles->clear();
 
   AutoLock scoped_lock(profiles_lock_);
   profiles_.swap(*profiles);
 }
+
+DefaultProfileProcessor::CompletedCallback
+DefaultProfileProcessor::GetCompletedCallback() const {
+  AutoLock scoped_lock(callback_lock_);
+  return default_completed_callback_;
+}
 }  // namespace
 
 StackSamplingProfiler::Module::Module() : base_address(nullptr) {}
 StackSamplingProfiler::Module::Module(const void* base_address,
                                       const std::string& id,
                                       const FilePath& filename)
     : base_address(base_address), id(id), filename(filename) {}
 
 StackSamplingProfiler::Module::~Module() {}
 
 StackSamplingProfiler::Frame::Frame()
     : instruction_pointer(nullptr),
       module_index(-1) {}
 
 StackSamplingProfiler::Frame::Frame(const void* instruction_pointer,
                                     int module_index)
     : instruction_pointer(instruction_pointer),
       module_index(module_index) {}
 
 StackSamplingProfiler::Frame::~Frame() {}
 
 StackSamplingProfiler::Profile::Profile() : preserve_sample_ordering(false) {}
 
 StackSamplingProfiler::Profile::~Profile() {}
 
 class StackSamplingProfiler::SamplingThread : public PlatformThread::Delegate {
  public:
   // Samples stacks using |native_sampler|. When complete, invokes
-  // |profiles_callback| with the collected profiles. |profiles_callback| must
-  // be thread-safe and may consume the contents of the vector.
-  SamplingThread(
-      scoped_ptr<NativeStackSampler> native_sampler,
-      const SamplingParams& params,
-      Callback<void(const std::vector<Profile>&)> completed_callback);
+  // |completed_callback| with the collected profiles. |completed_callback| must
+  // be thread-safe.
+  SamplingThread(scoped_ptr<NativeStackSampler> native_sampler,
+                 const SamplingParams& params,
+                 CompletedCallback completed_callback);
   ~SamplingThread() override;
 
   // Implementation of PlatformThread::Delegate:
   void ThreadMain() override;
 
   void Stop();
 
  private:
   // Collects a profile from a single burst. Returns true if the profile was
   // collected, or false if collection was stopped before it completed.
   bool CollectProfile(Profile* profile, TimeDelta* elapsed_time);
   // Collects profiles from all bursts, or until the sampling is stopped. If
-  // stopped before complete, |profiles| will contains only full bursts.
+  // stopped before complete, |profiles| will contain only full bursts.
   void CollectProfiles(std::vector<Profile>* profiles);
 
   scoped_ptr<NativeStackSampler> native_sampler_;
 
   const SamplingParams params_;
 
   WaitableEvent stop_event_;
 
-  Callback<void(const std::vector<Profile>&)> completed_callback_;
+  CompletedCallback completed_callback_;
 
   DISALLOW_COPY_AND_ASSIGN(SamplingThread);
 };
 
 StackSamplingProfiler::SamplingThread::SamplingThread(
     scoped_ptr<NativeStackSampler> native_sampler,
     const SamplingParams& params,
-    Callback<void(const std::vector<Profile>&)> completed_callback)
+    CompletedCallback completed_callback)
     : native_sampler_(native_sampler.Pass()),
       params_(params),
       stop_event_(false, false),
       completed_callback_(completed_callback) {
 }
 
 StackSamplingProfiler::SamplingThread::~SamplingThread() {}
 
 void StackSamplingProfiler::SamplingThread::ThreadMain() {
   PlatformThread::SetName("Chrome_SamplingProfilerThread");
@@ skipping 75 matching lines @@
       burst_interval(TimeDelta::FromMilliseconds(10000)),
       samples_per_burst(300),
       sampling_interval(TimeDelta::FromMilliseconds(100)),
       preserve_sample_ordering(false) {
 }
 
 StackSamplingProfiler::StackSamplingProfiler(PlatformThreadId thread_id,
                                              const SamplingParams& params)
     : thread_id_(thread_id), params_(params) {}
 
-StackSamplingProfiler::~StackSamplingProfiler() {}
+StackSamplingProfiler::StackSamplingProfiler(PlatformThreadId thread_id,
+                                             const SamplingParams& params,
+                                             CompletedCallback callback)
+    : thread_id_(thread_id), params_(params), completed_callback_(callback) {}
+
+StackSamplingProfiler::~StackSamplingProfiler() {
+  Stop();
+  if (!sampling_thread_handle_.is_null())
+    PlatformThread::Join(sampling_thread_handle_);
+}
 
 void StackSamplingProfiler::Start() {
-  native_sampler_ = NativeStackSampler::Create(thread_id_);
-  if (!native_sampler_)
+  scoped_ptr<NativeStackSampler> native_sampler(
+      NativeStackSampler::Create(thread_id_));
+  if (!native_sampler)
     return;
 
+  CompletedCallback callback =
+      !completed_callback_.is_null() ? completed_callback_ :
+      Bind(&DefaultProfileProcessor::ProcessProfiles,
+           Unretained(DefaultProfileProcessor::GetInstance()));
+
   sampling_thread_.reset(
-      new SamplingThread(
-          native_sampler_.Pass(), params_,
-          (custom_completed_callback_.is_null() ?
-           Bind(&PendingProfiles::PutProfiles,
-                Unretained(PendingProfiles::GetInstance())) :
-           custom_completed_callback_)));
-  if (!PlatformThread::CreateNonJoinable(0, sampling_thread_.get()))
+      new SamplingThread(native_sampler.Pass(), params_, callback));
+  if (!PlatformThread::Create(0, sampling_thread_.get(),
+                              &sampling_thread_handle_))
     LOG(ERROR) << "failed to create thread";
 }
 
 void StackSamplingProfiler::Stop() {
   if (sampling_thread_)
     sampling_thread_->Stop();
 }
 
 // static
-void StackSamplingProfiler::GetPendingProfiles(std::vector<Profile>* profiles) {
-  PendingProfiles::GetInstance()->GetProfiles(profiles);
-}
-
-void StackSamplingProfiler::SetCustomCompletedCallback(
-    Callback<void(const std::vector<Profile>&)> callback) {
-  custom_completed_callback_ = callback;
+void StackSamplingProfiler::SetDefaultCompletedCallback(
+    CompletedCallback callback) {
+  DefaultProfileProcessor::GetInstance()->SetCompletedCallback(callback);
 }
 
 bool operator==(const StackSamplingProfiler::Frame &a,
                 const StackSamplingProfiler::Frame &b) {
   return a.instruction_pointer == b.instruction_pointer &&
       a.module_index == b.module_index;
 }
 
 bool operator<(const StackSamplingProfiler::Frame &a,
                const StackSamplingProfiler::Frame &b) {
   return (a.module_index < b.module_index) ||
       (a.module_index == b.module_index &&
        a.instruction_pointer < b.instruction_pointer);
 }
 
 }  // namespace base