Slow Reports - Add message filter to trigger background traces from child processes.

content/browser/tracing/background_tracing_manager_impl.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 "content/browser/tracing/background_tracing_manager_impl.h"
 
 #include "base/json/json_writer.h"
 #include "base/macros.h"
 #include "base/metrics/histogram_macros.h"
 #include "base/metrics/statistics_recorder.h"
 #include "base/time/time.h"
+#include "components/tracing/tracing_messages.h"
+#include "content/browser/tracing/trace_message_filter.h"
 #include "content/public/browser/background_tracing_preemptive_config.h"
 #include "content/public/browser/background_tracing_reactive_config.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/tracing_delegate.h"
 #include "content/public/common/content_client.h"
 
 namespace content {
 
 namespace {
@@ skipping 58 matching lines @@
 BackgroundTracingManagerImpl* BackgroundTracingManagerImpl::GetInstance() {
   return g_controller.Pointer();
 }
 
 BackgroundTracingManagerImpl::BackgroundTracingManagerImpl()
     : delegate_(GetContentClient()->browser()->GetTracingDelegate()),
       is_gathering_(false),
       is_tracing_(false),
       requires_anonymized_data_(true),
       trigger_handle_ids_(0) {
+  TracingControllerImpl::GetInstance()->SetTraceMessageFilterAddedCallback(
+      base::Bind(&BackgroundTracingManagerImpl::OnTraceMessageFilterAdded,
+                 base::Unretained(this)));

[dcheng, 2015/07/23 21:11:33]

Why is it safe to use Unretained here? This callback isn't cleared in the dtor,
for instance: what keeps it from getting called after this is destroyed?

[shatch, 2015/07/23 23:06:51]

This is a leaky instance, we shouldn't hit the dtor.

 }
 
 BackgroundTracingManagerImpl::~BackgroundTracingManagerImpl() {
   NOTREACHED();
 }
 
 void BackgroundTracingManagerImpl::WhenIdle(
     base::Callback<void()> idle_callback) {
   CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   idle_callback_ = idle_callback;
@@ skipping 53 matching lines @@
             MONITOR_AND_DUMP_WHEN_SPECIFIC_HISTOGRAM_AND_VALUE) {
       continue;
     }
 
     if (mode == CLEAR_CALLBACKS) {
       base::StatisticsRecorder::ClearCallback(
           configs[i].histogram_trigger_info.histogram_name);
     } else {
       base::StatisticsRecorder::SetCallback(
           configs[i].histogram_trigger_info.histogram_name,
-          base::Bind(&BackgroundTracingManagerImpl::OnHistogramChanged,
+          base::Bind(&BackgroundTracingManagerImpl::OnHistogramChangedCallback,
                      base::Unretained(this),
                      configs[i].histogram_trigger_info.histogram_name,
                      configs[i].histogram_trigger_info.histogram_value));
     }
   }
+
+  SetupFiltersFromConfig(mode);
 }
 
-void BackgroundTracingManagerImpl::OnHistogramChanged(
-    const std::string& histogram_name,
-    base::Histogram::Sample reference_value,
-    base::Histogram::Sample actual_value) {
+void BackgroundTracingManagerImpl::OnHistogramTrigger(
+    const std::string& histogram_name) {
   if (!content::BrowserThread::CurrentlyOn(content::BrowserThread::UI)) {
     content::BrowserThread::PostTask(
         content::BrowserThread::UI, FROM_HERE,
-        base::Bind(&BackgroundTracingManagerImpl::OnHistogramChanged,
-                   base::Unretained(this), histogram_name, reference_value,
-                   actual_value));
+        base::Bind(&BackgroundTracingManagerImpl::OnHistogramTrigger,
+                   base::Unretained(this), histogram_name));
     return;
   }
 
   CHECK(config_ &&
         config_->mode == BackgroundTracingConfig::PREEMPTIVE_TRACING_MODE);
 
+  if (!is_tracing_ || is_gathering_)
+    return;
+
+  BackgroundTracingPreemptiveConfig* preemptive_config =
+      static_cast<BackgroundTracingPreemptiveConfig*>(config_.get());
+  const std::vector<BackgroundTracingPreemptiveConfig::MonitoringRule>&
+      configs = preemptive_config->configs;
+  for (size_t i = 0; i < configs.size(); ++i) {

[dcheng, 2015/07/23 21:11:33]

for (const auto& config : preemptive_config->configs)?

[shatch, 2015/07/23 23:06:51]

Oh neat, didn't realize this was recommended now, thanks!

+    if (configs[i].type !=
+        BackgroundTracingPreemptiveConfig::
+            MONITOR_AND_DUMP_WHEN_SPECIFIC_HISTOGRAM_AND_VALUE) {
+      continue;
+    }
+
+    if (configs[i].histogram_trigger_info.histogram_name == histogram_name) {
+      RecordBackgroundTracingMetric(PREEMPTIVE_TRIGGERED);
+      BeginFinalizing(StartedFinalizingCallback());
+    }
+  }
+}
+
+void BackgroundTracingManagerImpl::OnHistogramChangedCallback(
+    const std::string& histogram_name,
+    base::Histogram::Sample reference_value,
+    base::Histogram::Sample actual_value) {
   if (reference_value > actual_value)
     return;
 
-  if (!is_tracing_ || is_gathering_)
-    return;
-
-  RecordBackgroundTracingMetric(PREEMPTIVE_TRIGGERED);
-  BeginFinalizing(StartedFinalizingCallback());
+  OnHistogramTrigger(histogram_name);
 }
 
 bool BackgroundTracingManagerImpl::SetActiveScenario(
     scoped_ptr<BackgroundTracingConfig> config,
     const BackgroundTracingManager::ReceiveCallback& receive_callback,
     DataFiltering data_filtering) {
   CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
   RecordBackgroundTracingMetric(SCENARIO_ACTIVATION_REQUESTED);
 
   if (is_tracing_)
@@ skipping 36 matching lines @@
   EnableRecordingIfConfigNeedsIt();
 
   RecordBackgroundTracingMetric(SCENARIO_ACTIVATED_SUCCESSFULLY);
   return true;
 }
 
 bool BackgroundTracingManagerImpl::HasActiveScenarioForTesting() {
   return config_;
 }
 
+void BackgroundTracingManagerImpl::OnTraceMessageFilterAdded(
+    TraceMessageFilter* filter) {
+  DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+  SetupFilterFromConfig(filter, BIND_CALLBACKS);
+}
+
+void BackgroundTracingManagerImpl::SetupFiltersFromConfig(
+    BackgroundTracingManagerImpl::SetupUMACallMode mode) {
+  TracingControllerImpl::TraceMessageFilterSet filters;
+  TracingControllerImpl::GetInstance()->GetTraceMessageFilters(&filters);
+
+  for (auto it = filters.begin(); it != filters.end(); ++it)

[dcheng, 2015/07/23 21:11:33]

for (auto& filter : filters)

[shatch, 2015/07/23 23:06:51]

Done.

+    SetupFilterFromConfig(*it, mode);
+}
+
+void BackgroundTracingManagerImpl::SetupFilterFromConfig(
+    scoped_refptr<TraceMessageFilter> filter,
+    BackgroundTracingManagerImpl::SetupUMACallMode mode) {
+  if (!config_ ||
+      config_->mode != BackgroundTracingConfig::PREEMPTIVE_TRACING_MODE)
+    return;
+
+  BackgroundTracingPreemptiveConfig* preemptive_config =
+      static_cast<BackgroundTracingPreemptiveConfig*>(config_.get());
+
+  const std::vector<BackgroundTracingPreemptiveConfig::MonitoringRule>&
+      configs = preemptive_config->configs;
+
+  for (size_t i = 0; i < configs.size(); ++i) {

[dcheng, 2015/07/23 21:11:33]

Ditto: use a for each.

[shatch, 2015/07/23 23:06:51]

Done.

+    if (configs[i].type !=
+        BackgroundTracingPreemptiveConfig::
+            MONITOR_AND_DUMP_WHEN_SPECIFIC_HISTOGRAM_AND_VALUE) {
+      continue;
+    }
+
+    if (mode == CLEAR_CALLBACKS) {
+      filter->Send(new TracingMsg_ClearUMACallback(
+          configs[i].histogram_trigger_info.histogram_name));
+    } else {
+      filter->Send(new TracingMsg_SetUMACallback(
+          configs[i].histogram_trigger_info.histogram_name,
+          configs[i].histogram_trigger_info.histogram_value));
+    }
+  }
+}
+
 void BackgroundTracingManagerImpl::ValidateStartupScenario() {
   if (!config_ || !delegate_)
     return;
 
   if (!delegate_->IsAllowedToBeginBackgroundScenario(
           *config_.get(), requires_anonymized_data_)) {
     AbortScenario();
   }
 }
 
@@ skipping 250 matching lines @@
     RecordBackgroundTracingMetric(FINALIZATION_DISALLOWED);
   }
 
   content::TracingController::GetInstance()->DisableRecording(trace_data_sink);
 
   if (!callback.is_null())
     callback.Run(is_allowed_finalization);
 }
 
 void BackgroundTracingManagerImpl::AbortScenario() {
+  SetupUMACallbacks(CLEAR_CALLBACKS);
+
   is_tracing_ = false;
   config_.reset();
 
   content::TracingController::GetInstance()->DisableRecording(nullptr);
 }
 
 std::string
 BackgroundTracingManagerImpl::GetCategoryFilterStringForCategoryPreset(
     BackgroundTracingConfig::CategoryPreset preset) const {
   switch (preset) {
     case BackgroundTracingConfig::CategoryPreset::BENCHMARK:
       return "benchmark,toplevel";
     case BackgroundTracingConfig::CategoryPreset::BENCHMARK_DEEP:
       return "*,disabled-by-default-benchmark.detailed";
   }
   NOTREACHED();
   return "";
 }
 
 }  // namspace content