Implement Reactive Configuration in Background Tracing

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/macros.h"
+#include "base/time/time.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"
+
+namespace content {
+
+namespace {
+
+base::LazyInstance<BackgroundTracingManagerImpl>::Leaky g_controller =
+    LAZY_INSTANCE_INITIALIZER;
+
+}  // namespace
+
+BackgroundTracingManagerImpl::TraceDataEndpointWrapper::
+    TraceDataEndpointWrapper(base::Callback<
+        void(scoped_refptr<base::RefCountedString>)> done_callback)
+    : done_callback_(done_callback) {
+}
+
+BackgroundTracingManagerImpl::TraceDataEndpointWrapper::
+    ~TraceDataEndpointWrapper() {
+}
+
+void BackgroundTracingManagerImpl::TraceDataEndpointWrapper::
+    ReceiveTraceFinalContents(const std::string& file_contents) {
+  std::string tmp = file_contents;
+  scoped_refptr<base::RefCountedString> contents_ptr =
+      base::RefCountedString::TakeString(&tmp);
+
+  BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
+                          base::Bind(done_callback_, contents_ptr));
+}
+
+BackgroundTracingManagerImpl::TracingTimer::
+    TracingTimer(StartedFinalizingCallback callback) : callback_(callback) {
+}
+
+BackgroundTracingManagerImpl::TracingTimer::~TracingTimer() {
+}
+
+void BackgroundTracingManagerImpl::TracingTimer::StartTimer() {
+  tracing_timer_.Start(FROM_HERE, base::TimeDelta::FromSeconds(10), this,
+      &BackgroundTracingManagerImpl::TracingTimer::TracingTimerFired);
+}
+
+void BackgroundTracingManagerImpl::TracingTimer::CancelTimer() {

[shatch, 2015/05/21 15:59:06]

This isn't referenced anywhere.

+  tracing_timer_.Stop();
+}
+
+void BackgroundTracingManagerImpl::TracingTimer::TracingTimerFired() {
+  BackgroundTracingManagerImpl::GetInstance()->BeginFinalizing(callback_);

[shatch, 2015/05/21 15:59:05]

Both TriggerNamedEvent and this can trigger a BeginFinalizing call, if you get
this sequence:

BackgroundTracingManager::TriggerNamedEvent("foo"); <- EnableRecording
BackgroundTracingManager::TriggerNamedEvent("foo"); <- BeginFinalizing
BackgroundTracingManager::TracingTimer::TracingTimerFired -> BeginFinalizing
again?

You call BeginFinalizing twice, think you need to kill the timer.

+}
+
+BackgroundTracingManager* BackgroundTracingManager::GetInstance() {
+  return BackgroundTracingManagerImpl::GetInstance();
+}
+
+BackgroundTracingManagerImpl* BackgroundTracingManagerImpl::GetInstance() {
+  return g_controller.Pointer();
+}
+
+BackgroundTracingManagerImpl::BackgroundTracingManagerImpl()
+    : is_gathering_(false),
+      is_tracing_(false),
+      requires_anonymized_data_(true),
+      trigger_handle_ids_(0) {
+  data_endpoint_wrapper_ = new TraceDataEndpointWrapper(
+      base::Bind(&BackgroundTracingManagerImpl::OnFinalizeStarted,
+                 base::Unretained(this)));
+}
+
+BackgroundTracingManagerImpl::~BackgroundTracingManagerImpl() {
+  NOTREACHED();
+}
+
+void BackgroundTracingManagerImpl::WhenIdle(
+    base::Callback<void()> idle_callback) {
+  CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+  idle_callback_ = idle_callback;
+}
+
+bool BackgroundTracingManagerImpl::IsSupportedConfig(
+    BackgroundTracingConfig* config) {
+  // No config is just fine, we just don't do anything.
+  if (!config)
+    return true;
+
+  if (config->mode == BackgroundTracingConfig::PREEMPTIVE_TRACING_MODE) {
+    BackgroundTracingPreemptiveConfig* preemptive_config =
+        static_cast<BackgroundTracingPreemptiveConfig*>(config);
+    const std::vector<BackgroundTracingPreemptiveConfig::MonitoringRule>&
+        configs = preemptive_config->configs;
+    for (size_t i = 0; i < configs.size(); ++i) {
+      if (configs[i].type !=
+          BackgroundTracingPreemptiveConfig::
+              MONITOR_AND_DUMP_WHEN_TRIGGER_NAMED)
+        return false;
+    }
+  }
+
+  if (config->mode == BackgroundTracingConfig::REACTIVE_TRACING_MODE) {
+    BackgroundTracingReactiveConfig* reactive_config =
+        static_cast<BackgroundTracingReactiveConfig*>(config);
+    const std::vector<BackgroundTracingReactiveConfig::TracingRule>&
+        configs = reactive_config->configs;
+    for (size_t i = 0; i < configs.size(); ++i) {
+      if (configs[i].type !=
+          BackgroundTracingReactiveConfig::
+              TRACE_ON_MANUAL_TRIGGER_UNTIL_10S_OR_NEXT_TRIGGER_OR_FULL)
+        return false;
+    }
+  }
+
+  return true;
+}
+
+bool BackgroundTracingManagerImpl::SetActiveScenario(
+    scoped_ptr<BackgroundTracingConfig> config,
+    const BackgroundTracingManager::ReceiveCallback& receive_callback,
+    bool requires_anonymized_data) {
+  CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+  if (is_tracing_)
+    return false;
+
+  if (!IsSupportedConfig(config.get()))
+    return false;
+
+  // No point in tracing if there's nowhere to send it.
+  if (config && receive_callback.is_null())
+    return false;
+
+  config_ = config.Pass();
+  receive_callback_ = receive_callback;
+  requires_anonymized_data_ = requires_anonymized_data;
+
+  EnableRecordingIfConfigNeedsIt();
+
+  return true;
+}
+
+void BackgroundTracingManagerImpl::EnableRecordingIfConfigNeedsIt() {
+  if (!config_)
+    return;
+
+  if (config_->mode == BackgroundTracingConfig::PREEMPTIVE_TRACING_MODE) {
+    EnableRecording(GetCategoryFilterForCategoryPreset(
+        static_cast<BackgroundTracingPreemptiveConfig*>(config_.get())
+            ->category_preset));
+  } else {
+    // There is nothing to do in case of reactive tracing.
+  }
+}
+
+bool BackgroundTracingManagerImpl::IsAbleToTriggerTracing(
+    TriggerHandle handle) const {
+  if (!config_)
+    return false;
+
+  // If the last trace is still uploading, we don't allow a new one to trigger.
+  if (is_gathering_)
+    return false;
+
+  if (!IsTriggerHandleValid(handle)) {
+    return false;
+  }
+
+  std::string trigger_name = GetTriggerNameFromHandle(handle);
+
+  if (config_->mode == BackgroundTracingConfig::PREEMPTIVE_TRACING_MODE) {
+    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) {
+      if (configs[i].type != BackgroundTracingPreemptiveConfig::
+                                 MONITOR_AND_DUMP_WHEN_TRIGGER_NAMED)
+        continue;
+
+      if (trigger_name == configs[i].named_trigger_info.trigger_name) {
+        return true;
+      }
+    }
+  } else {
+    BackgroundTracingReactiveConfig* reactive_config =
+        static_cast<BackgroundTracingReactiveConfig*>(config_.get());
+
+    const std::vector<BackgroundTracingReactiveConfig::TracingRule>&
+        configs = reactive_config->configs;
+
+    for (size_t i = 0; i < configs.size(); ++i) {
+      if (configs[i].type !=
+              BackgroundTracingReactiveConfig::
+                  TRACE_ON_MANUAL_TRIGGER_UNTIL_10S_OR_NEXT_TRIGGER_OR_FULL)
+        continue;
+      if (trigger_name == configs[i].trigger_name) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+
+
+
+void BackgroundTracingManagerImpl::TriggerNamedEvent(
+    BackgroundTracingManagerImpl::TriggerHandle handle,
+    StartedFinalizingCallback callback) {
+  if (!content::BrowserThread::CurrentlyOn(content::BrowserThread::UI)) {
+    content::BrowserThread::PostTask(
+        content::BrowserThread::UI, FROM_HERE,
+        base::Bind(&BackgroundTracingManagerImpl::TriggerNamedEvent,
+                   base::Unretained(this), handle, callback));
+    return;
+  }
+
+  if (!IsAbleToTriggerTracing(handle)) {
+    if (!callback.is_null())
+      callback.Run(false);
+    return;
+  }
+
+  if (config_->mode == BackgroundTracingConfig::PREEMPTIVE_TRACING_MODE) {
+    BeginFinalizing(callback);
+  } else {
+    if (is_tracing_) {
+      BeginFinalizing(callback);

[shatch, 2015/05/21 15:59:06]

Just wondering, does deep reports need to know or care about whether a call to
TriggerNamedEvent triggers an EnableRecording or BeginFinalizing?

[fmeawad, 2015/05/21 16:09:38]

No. The idea is to collect as many as we can, but feedback is not needed.

+      return;
+    } else {
+      //TODO(fmeawad): Currently we only have BENCHMARD_DEEP for reactive mode,
+      // but this code need to be generalized.
+      EnableRecording(
+          GetCategoryFilterForCategoryPreset(

[shatch, 2015/05/21 15:59:06]

BackgroundTracingReactiveConfig::TracingRule has a category_preset.

[fmeawad, 2015/05/21 16:09:38]

Yes, see todo above.

+              BackgroundTracingConfig::CategoryPreset::BENCHMARK_DEEP));
+
+      TracingTimer* timer = new TracingTimer(callback);

[shatch, 2015/05/21 15:59:06]

Maybe change this to a scoped_ptr member?

[fmeawad, 2015/05/21 16:09:38]

Yes, that is the plan.

+      timer->StartTimer();
+    }
+  }
+}
+
+BackgroundTracingManagerImpl::TriggerHandle
+BackgroundTracingManagerImpl::RegisterTriggerType(const char* trigger_name) {
+  CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+
+  trigger_handle_ids_ += 1;
+
+  trigger_handles_.insert(
+      std::pair<TriggerHandle, std::string>(trigger_handle_ids_, trigger_name));
+
+  return static_cast<TriggerHandle>(trigger_handle_ids_);
+}
+
+bool BackgroundTracingManagerImpl::IsTriggerHandleValid(
+    BackgroundTracingManager::TriggerHandle handle) const {
+  return trigger_handles_.find(handle) != trigger_handles_.end();
+}
+
+std::string BackgroundTracingManagerImpl::GetTriggerNameFromHandle(
+    BackgroundTracingManager::TriggerHandle handle) const {
+  CHECK(IsTriggerHandleValid(handle));
+  return trigger_handles_.find(handle)->second;
+}
+
+void BackgroundTracingManagerImpl::GetTriggerNameList(
+    std::vector<std::string>* trigger_names) {
+  for (std::map<TriggerHandle, std::string>::iterator it =
+           trigger_handles_.begin();
+       it != trigger_handles_.end(); ++it)
+    trigger_names->push_back(it->second);
+}
+
+void BackgroundTracingManagerImpl::InvalidateTriggerHandlesForTesting() {
+  trigger_handles_.clear();
+}
+
+void BackgroundTracingManagerImpl::EnableRecording(
+    base::trace_event::CategoryFilter category_filter) {
+  is_tracing_ = TracingController::GetInstance()->EnableRecording(
+      category_filter,
+      base::trace_event::TraceOptions(base::trace_event::RECORD_CONTINUOUSLY),
+      TracingController::EnableRecordingDoneCallback());
+}
+
+void BackgroundTracingManagerImpl::OnFinalizeStarted(
+    scoped_refptr<base::RefCountedString> file_contents) {
+  CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+
+  if (!receive_callback_.is_null())
+    receive_callback_.Run(
+        file_contents.get(),
+        base::Bind(&BackgroundTracingManagerImpl::OnFinalizeComplete,
+                   base::Unretained(this)));
+}
+
+void BackgroundTracingManagerImpl::OnTracingTimeout() {

[shatch, 2015/05/21 15:59:06]

Is this reference somewhere? What does it do?

+
+}
+
+void BackgroundTracingManagerImpl::OnFinalizeComplete() {
+  if (!BrowserThread::CurrentlyOn(BrowserThread::UI)) {
+    BrowserThread::PostTask(
+        BrowserThread::UI, FROM_HERE,
+        base::Bind(&BackgroundTracingManagerImpl::OnFinalizeComplete,
+                   base::Unretained(this)));
+    return;
+  }
+
+  CHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+
+  is_gathering_ = false;
+
+  if (!idle_callback_.is_null())
+    idle_callback_.Run();
+
+  // Now that a trace has completed, we may need to enable recording again.
+  EnableRecordingIfConfigNeedsIt();
+}
+
+void BackgroundTracingManagerImpl::BeginFinalizing(
+    StartedFinalizingCallback callback) {
+  is_gathering_ = true;
+  is_tracing_ = false;
+
+  content::TracingController::GetInstance()->DisableRecording(
+      content::TracingController::CreateCompressedStringSink(
+          data_endpoint_wrapper_));
+
+  if (!callback.is_null())
+    callback.Run(true);
+}
+
+base::trace_event::CategoryFilter
+BackgroundTracingManagerImpl::GetCategoryFilterForCategoryPreset(
+    BackgroundTracingConfig::CategoryPreset preset) const {
+  switch (preset) {
+    case BackgroundTracingConfig::CategoryPreset::BENCHMARK:
+      return base::trace_event::CategoryFilter(
+          "benchmark,"
+          "disabled-by-default-toplevel.flow,"
+          "disabled-by-default-ipc.flow");
+    case BackgroundTracingConfig::CategoryPreset::BENCHMARK_DEEP:
+      return base::trace_event::CategoryFilter(
+          "*,disabled-by-default-blink.debug.layout");
+  }
+  NOTREACHED();
+  return base::trace_event::CategoryFilter();
+}
+
+BackgroundTracingConfig* BackgroundTracingConfig::FromDict(
+    const base::DictionaryValue* dict) {
+  // TODO(simonhatch): Implement this.
+  CHECK(false);
+  return NULL;
+}
+
+void BackgroundTracingConfig::IntoDict(const BackgroundTracingConfig* config,
+                                       base::DictionaryValue* dict) {
+  // TODO(simonhatch): Implement this.
+  CHECK(false);
+}
+
+}  // namspace content