Move MetricsService final log collection tasks to client.

chrome/browser/metrics/chrome_metrics_service_client.cc

 // Copyright 2014 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 "chrome/browser/metrics/chrome_metrics_service_client.h"
 
+#include "base/bind.h"
 #include "base/logging.h"
+#include "base/threading/platform_thread.h"
+#include "base/time/time.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/google/google_util.h"
+#include "chrome/browser/memory_details.h"
 #include "chrome/browser/ui/browser_otr_state.h"
 #include "chrome/common/chrome_version_info.h"
 #include "chrome/common/crash_keys.h"
+#include "chrome/common/render_messages.h"
+#include "content/public/browser/histogram_fetcher.h"
+#include "content/public/browser/render_process_host.h"
+
+#if !defined(OS_ANDROID)
+#include "chrome/browser/service_process/service_process_control.h"
+#endif
 
 namespace {
 
+// This specifies the amount of time to wait for all renderers to send their
+// data.
+const int kMaxHistogramGatheringWaitDuration = 60000;  // 60 seconds.
+
 metrics::SystemProfileProto::Channel AsProtobufChannel(
     chrome::VersionInfo::Channel channel) {
   switch (channel) {
     case chrome::VersionInfo::CHANNEL_UNKNOWN:
       return metrics::SystemProfileProto::CHANNEL_UNKNOWN;
     case chrome::VersionInfo::CHANNEL_CANARY:
       return metrics::SystemProfileProto::CHANNEL_CANARY;
     case chrome::VersionInfo::CHANNEL_DEV:
       return metrics::SystemProfileProto::CHANNEL_DEV;
     case chrome::VersionInfo::CHANNEL_BETA:
       return metrics::SystemProfileProto::CHANNEL_BETA;
     case chrome::VersionInfo::CHANNEL_STABLE:
       return metrics::SystemProfileProto::CHANNEL_STABLE;
   }
   NOTREACHED();
   return metrics::SystemProfileProto::CHANNEL_UNKNOWN;
 }
 
+// Check to see that we're being called on only one thread.
+bool IsSingleThreaded() {
+  static base::PlatformThreadId thread_id = 0;
+  if (!thread_id)
+    thread_id = base::PlatformThread::CurrentId();
+  return base::PlatformThread::CurrentId() == thread_id;
+}

[Ilya Sherman, 2014/05/21 14:22:55]

I hadn't realized what this method does.  Seems like we could use a
base::ThreadChecker instead?  (There's another concept in the MetricsService
that has a similar name, that has to do with running during startup or
shutdown.)

[Alexei Svitkine (slow), 2014/05/21 14:32:48]

Right you are! Somehow I totally forgot about base::ThreadChecker... Done.

+
+// Handles asynchronous fetching of memory details.
+// Will run the provided task after finished.
+class MetricsMemoryDetails : public MemoryDetails {
+ public:
+  explicit MetricsMemoryDetails(const base::Closure& callback)
+      : callback_(callback) {}
+
+  virtual void OnDetailsAvailable() OVERRIDE {
+    base::MessageLoop::current()->PostTask(FROM_HERE, callback_);
+  }
+
+ private:
+  virtual ~MetricsMemoryDetails() {}
+
+  base::Closure callback_;
+
+  DISALLOW_COPY_AND_ASSIGN(MetricsMemoryDetails);
+};
+
 }  // namespace
 
-ChromeMetricsServiceClient::ChromeMetricsServiceClient() {
+ChromeMetricsServiceClient::ChromeMetricsServiceClient()
+    : waiting_for_final_log_collection_step_(false),
+      num_async_histogram_fetches_in_progress_(0),
+      weak_ptr_factory_(this) {
+  DCHECK(IsSingleThreaded());
 }
 
 ChromeMetricsServiceClient::~ChromeMetricsServiceClient() {
+  DCHECK(IsSingleThreaded());
 }
 
 void ChromeMetricsServiceClient::SetClientID(const std::string& client_id) {
   crash_keys::SetClientID(client_id);
 }
 
 bool ChromeMetricsServiceClient::IsOffTheRecordSessionActive() {
   return !chrome::IsOffTheRecordSessionActive();
 }
 
 std::string ChromeMetricsServiceClient::GetApplicationLocale() {
   return g_browser_process->GetApplicationLocale();
 }
 
 bool ChromeMetricsServiceClient::GetBrand(std::string* brand_code) {
   return google_util::GetBrand(brand_code);
 }
 
 metrics::SystemProfileProto::Channel ChromeMetricsServiceClient::GetChannel() {
   return AsProtobufChannel(chrome::VersionInfo::GetChannel());
 }
 
 std::string ChromeMetricsServiceClient::GetVersionString() {
   // TODO(asvitkine): Move over from metrics_log.cc
   return std::string();
 }
+
+void ChromeMetricsServiceClient::CollectFinalMetrics(
+    const base::Closure& done_callback) {
+  DCHECK(IsSingleThreaded());
+
+  final_log_collection_done_callback_ = done_callback;
+
+  // Begin the multi-step process of collecting memory usage histograms:
+  // First spawn a task to collect the memory details; when that task is
+  // finished, it will call OnMemoryDetailCollectionDone. That will in turn
+  // call HistogramSynchronization to collect histograms from all renderers and
+  // then call OnHistogramSynchronizationDone to continue processing.
+  DCHECK(!waiting_for_final_log_collection_step_);
+  waiting_for_final_log_collection_step_ = true;
+
+  base::Closure callback =
+      base::Bind(&ChromeMetricsServiceClient::OnMemoryDetailCollectionDone,
+                 weak_ptr_factory_.GetWeakPtr());
+
+  scoped_refptr<MetricsMemoryDetails> details(
+      new MetricsMemoryDetails(callback));
+  details->StartFetch(MemoryDetails::UPDATE_USER_METRICS);
+
+  // Collect WebCore cache information to put into a histogram.
+  for (content::RenderProcessHost::iterator i(
+          content::RenderProcessHost::AllHostsIterator());
+       !i.IsAtEnd(); i.Advance()) {
+    i.GetCurrentValue()->Send(new ChromeViewMsg_GetCacheResourceStats());
+  }
+}
+
+void ChromeMetricsServiceClient::OnMemoryDetailCollectionDone() {
+  DCHECK(IsSingleThreaded());
+
+  // This function should only be called as the callback from an ansynchronous
+  // step.
+  DCHECK(waiting_for_final_log_collection_step_);
+
+  // Create a callback_task for OnHistogramSynchronizationDone.
+  base::Closure callback = base::Bind(
+      &ChromeMetricsServiceClient::OnHistogramSynchronizationDone,
+      weak_ptr_factory_.GetWeakPtr());
+
+  base::TimeDelta timeout =
+      base::TimeDelta::FromMilliseconds(kMaxHistogramGatheringWaitDuration);
+
+  DCHECK_EQ(num_async_histogram_fetches_in_progress_, 0);
+
+#if defined(OS_ANDROID)
+  // Android has no service process.
+  num_async_histogram_fetches_in_progress_ = 1;
+#else  // OS_ANDROID
+  num_async_histogram_fetches_in_progress_ = 2;
+  // Run requests to service and content in parallel.
+  if (!ServiceProcessControl::GetInstance()->GetHistograms(callback, timeout)) {
+    // Assume |num_async_histogram_fetches_in_progress_| is not changed by
+    // |GetHistograms()|.
+    DCHECK_EQ(num_async_histogram_fetches_in_progress_, 2);
+    // Assign |num_async_histogram_fetches_in_progress_| above and decrement it
+    // here to make code work even if |GetHistograms()| fired |callback|.
+    --num_async_histogram_fetches_in_progress_;
+  }
+#endif  // OS_ANDROID
+
+  // Set up the callback to task to call after we receive histograms from all
+  // child processes. |timeout| specifies how long to wait before absolutely
+  // calling us back on the task.
+  content::FetchHistogramsAsynchronously(base::MessageLoop::current(), callback,
+                                         timeout);
+}
+
+void ChromeMetricsServiceClient::OnHistogramSynchronizationDone() {
+  DCHECK(IsSingleThreaded());
+
+  // This function should only be called as the callback from an ansynchronous
+  // step.
+  DCHECK(waiting_for_final_log_collection_step_);
+  DCHECK_GT(num_async_histogram_fetches_in_progress_, 0);
+
+  // Check if all expected requests finished.
+  if (--num_async_histogram_fetches_in_progress_ > 0)
+    return;
+
+  waiting_for_final_log_collection_step_ = false;
+  final_log_collection_done_callback_.Run();
+}
+