Implements Windows system tracing.

content/browser/tracing/tracing_controller_impl.cc

-// Copyright 2013 The Chromium Authors. All rights reserved.
+// Copyright (c) 2013 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/tracing_controller_impl.h"
 
 #include "base/bind.h"
 #include "base/debug/trace_event.h"
 #include "base/file_util.h"
 #include "base/json/string_escape.h"
 #include "base/strings/string_number_conversions.h"
 #include "content/browser/tracing/trace_message_filter.h"
 #include "content/browser/tracing/tracing_ui.h"
 #include "content/common/child_process_messages.h"
 #include "content/public/browser/browser_message_filter.h"
 #include "content/public/common/content_switches.h"
 
 #if defined(OS_CHROMEOS)
 #include "chromeos/dbus/dbus_thread_manager.h"
 #include "chromeos/dbus/debug_daemon_client.h"
 #endif
 
+#if defined(OS_WIN)
+#include "content/browser/tracing/etw_system_event_consumer_win.h"
+#endif
+
 using base::debug::TraceLog;
 
 namespace content {
 
 namespace {
 
 base::LazyInstance<TracingControllerImpl>::Leaky g_controller =
     LAZY_INSTANCE_INITIALIZER;
 
 }  // namespace
@@ skipping 61 matching lines @@
   const char* preamble = "{\"traceEvents\": [";
   size_t written = fwrite(preamble, strlen(preamble), 1, file_);
   DCHECK(written == 1);
 }
 
 void TracingControllerImpl::ResultFile::WriteTask(
     const scoped_refptr<base::RefCountedString>& events_str_ptr) {
   if (!file_ || !events_str_ptr->data().size())
     return;
 
-  // If there is already a result in the file, then put a commma
+  // If there is already a result in the file, then put a comma
   // before the next batch of results.
   if (has_at_least_one_result_) {
     size_t written = fwrite(",", 1, 1, file_);
     DCHECK(written == 1);
   }
   has_at_least_one_result_ = true;
   size_t written = fwrite(events_str_ptr->data().c_str(),
                           events_str_ptr->data().size(), 1,
                           file_);
   DCHECK(written == 1);
 }
 
 void TracingControllerImpl::ResultFile::WriteSystemTraceTask(
     const scoped_refptr<base::RefCountedString>& events_str_ptr) {
   system_trace_ = events_str_ptr;
 }
 
 void TracingControllerImpl::ResultFile::CloseTask(
     const base::Closure& callback) {
   if (!file_)
     return;
 
   const char* trailevents = "]";
   size_t written = fwrite(trailevents, strlen(trailevents), 1, file_);
   DCHECK(written == 1);
 
   if (system_trace_) {
+#if defined(OS_WIN)
+    // The Windows kernel events are kept into a JSon format stored as string
+    // and must not be escaped.
+    std::string json_string = system_trace_->data();
+#else
     std::string json_string = base::GetQuotedJSONString(system_trace_->data());
+#endif
 
-    const char* systemTraceHead = ", \"systemTraceEvents\": ";
+    const char* systemTraceHead = ",\n\"systemTraceEvents\": ";
     written = fwrite(systemTraceHead, strlen(systemTraceHead), 1, file_);
     DCHECK(written == 1);
 
     written = fwrite(json_string.data(), json_string.size(), 1, file_);
     DCHECK(written == 1);
 
     system_trace_ = NULL;
   }
 
   const char* trailout = "}";
   written = fwrite(trailout, strlen(trailout), 1, file_);
   DCHECK(written == 1);
   base::CloseFile(file_);
   file_ = NULL;
 
   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, callback);
 }
 
 
 TracingControllerImpl::TracingControllerImpl() :
     pending_disable_recording_ack_count_(0),
     pending_capture_monitoring_snapshot_ack_count_(0),
     pending_trace_buffer_percent_full_ack_count_(0),
     maximum_trace_buffer_percent_full_(0),
     // Tracing may have been enabled by ContentMainRunner if kTraceStartup
     // is specified in command line.
-#if defined(OS_CHROMEOS)
+#if defined(OS_CHROMEOS) || defined(OS_WIN)
     is_system_tracing_(false),
 #endif
     is_recording_(TraceLog::GetInstance()->IsEnabled()),
     is_monitoring_(false) {
 }
 
 TracingControllerImpl::~TracingControllerImpl() {
   // This is a Leaky instance.
   NOTREACHED();
 }
@@ skipping 55 matching lines @@
 
 #if defined(OS_ANDROID)
   if (pending_get_categories_done_callback_.is_null())
     TraceLog::GetInstance()->AddClockSyncMetadataEvent();
 #endif
 
   options_ = options;
   int trace_options = (options & RECORD_CONTINUOUSLY) ?
       TraceLog::RECORD_CONTINUOUSLY : TraceLog::RECORD_UNTIL_FULL;
   if (options & ENABLE_SAMPLING) {
-    trace_options |=  TraceLog::ENABLE_SAMPLING;
+    trace_options |= TraceLog::ENABLE_SAMPLING;
   }
+
+  if (options & ENABLE_SYSTRACE) {
 #if defined(OS_CHROMEOS)
-  if (options & ENABLE_SYSTRACE) {
     DCHECK(!is_system_tracing_);
     chromeos::DBusThreadManager::Get()->GetDebugDaemonClient()->
       StartSystemTracing();
     is_system_tracing_ = true;
+#elif defined(OS_WIN)
+    DCHECK(!is_system_tracing_);
+    is_system_tracing_ =
+        EtwSystemEventConsumer::GetInstance()->StartSystemTracing();
+#endif
   }
-#endif
+
 
   base::Closure on_enable_recording_done_callback =
       base::Bind(&TracingControllerImpl::OnEnableRecordingDone,
                  base::Unretained(this),
-                 category_filter,trace_options, callback);
+                 category_filter, trace_options, callback);
   BrowserThread::PostTask(BrowserThread::FILE, FROM_HERE,
       base::Bind(&TracingControllerImpl::SetEnabledOnFileThread,
                  base::Unretained(this),
                  category_filter,
                  base::debug::TraceLog::RECORDING_MODE,
                  trace_options,
                  on_enable_recording_done_callback));
   return true;
 }
 
@@ skipping 156 matching lines @@
   if (!callback.is_null())
     callback.Run();
 }
 
 void TracingControllerImpl::GetMonitoringStatus(
     bool* out_enabled,
     std::string* out_category_filter,
     TracingController::Options* out_options) {
   *out_enabled = is_monitoring_;
   *out_category_filter =
-    TraceLog::GetInstance()->GetCurrentCategoryFilter().ToString();
+      TraceLog::GetInstance()->GetCurrentCategoryFilter().ToString();
   *out_options = options_;
 }
 
 bool TracingControllerImpl::CaptureMonitoringSnapshot(
     const base::FilePath& result_file_path,
     const TracingFileResultCallback& callback) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 
   if (!can_disable_monitoring())
     return false;
@@ skipping 222 matching lines @@
   OnDisableRecordingComplete();
 }
 
 void TracingControllerImpl::OnDisableRecordingComplete() {
   // All acks (including from the subprocesses and the local trace) have been
   // received.
   is_recording_ = false;
 
 #if defined(OS_CHROMEOS)
   if (is_system_tracing_) {
+    // Disable system tracing.
+    is_system_tracing_ = false;
+
     // Disable system tracing now that the local trace has shutdown.
     // This must be done last because we potentially need to push event
     // records into the system event log for synchronizing system event
     // timestamps with chrome event timestamps--and since the system event
     // log is a ring-buffer (on linux) adding them at the end is the only
     // way we're confident we'll have them in the final result.
-    is_system_tracing_ = false;
     chromeos::DBusThreadManager::Get()->GetDebugDaemonClient()->
       RequestStopSystemTracing(
           base::Bind(&TracingControllerImpl::OnEndSystemTracingAcked,
                      base::Unretained(this)));
     return;
   }
+#elif defined(OS_WIN)
+  if (is_system_tracing_) {
+    // Disable system tracing.
+    is_system_tracing_ = false;
+
+
+    // Stop kernel tracing and flush events.
+    EtwSystemEventConsumer::GetInstance()->StopSystemTracing(
+        base::Bind(&TracingControllerImpl::OnEndSystemTracingAcked,
+                   base::Unretained(this)));
+    return;
+  }
 #endif
 
   // Trigger callback if one is set.
   if (!pending_get_categories_done_callback_.is_null()) {
     pending_get_categories_done_callback_.Run(known_category_groups_);
     pending_get_categories_done_callback_.Reset();
   } else if (result_file_) {
     result_file_->Close(
         base::Bind(&TracingControllerImpl::OnResultFileClosed,
                    base::Unretained(this)));
   }
 }
 
 void TracingControllerImpl::OnResultFileClosed() {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 
   if (!result_file_)
     return;
 
   if (!pending_disable_recording_done_callback_.is_null()) {
     pending_disable_recording_done_callback_.Run(result_file_->path());
     pending_disable_recording_done_callback_.Reset();
   }
   result_file_.reset();
 }
 
-#if defined(OS_CHROMEOS)
+#if defined(OS_CHROMEOS) || defined(OS_WIN)
 void TracingControllerImpl::OnEndSystemTracingAcked(
     const scoped_refptr<base::RefCountedString>& events_str_ptr) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
 
   if (result_file_)
     result_file_->WriteSystemTrace(events_str_ptr);
 
   DCHECK(!is_system_tracing_);
   OnDisableRecordingComplete();
 }
@@ skipping 145 matching lines @@
     BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
         base::Bind(&TracingControllerImpl::OnWatchEventMatched,
                    base::Unretained(this)));
     return;
   }
 
   if (!watch_event_callback_.is_null())
     watch_event_callback_.Run();
 }
 
-void TracingControllerImpl::RegisterTracingUI(TracingUI* tracing_ui)
-{
+void TracingControllerImpl::RegisterTracingUI(TracingUI* tracing_ui) {
   DCHECK(tracing_uis_.find(tracing_ui) == tracing_uis_.end());
   tracing_uis_.insert(tracing_ui);
 }
 
-void TracingControllerImpl::UnregisterTracingUI(TracingUI* tracing_ui)
-{
+void TracingControllerImpl::UnregisterTracingUI(TracingUI* tracing_ui) {
   std::set<TracingUI*>::iterator it = tracing_uis_.find(tracing_ui);
   DCHECK(it != tracing_uis_.end());
   tracing_uis_.erase(it);
 }
 
-void TracingControllerImpl::OnMonitoringStateChanged(bool is_monitoring)
-{
+void TracingControllerImpl::OnMonitoringStateChanged(bool is_monitoring) {
   if (is_monitoring_ == is_monitoring)
     return;
 
   is_monitoring_ = is_monitoring;
 #if !defined(OS_ANDROID)
   for (std::set<TracingUI*>::iterator it = tracing_uis_.begin();
        it != tracing_uis_.end(); it++) {
     (*it)->OnMonitoringStateChanged(is_monitoring);
   }
 #endif
 }
 
 }  // namespace content