[Tracing Clock Sync] Add TracingAgent interface in Chrome

content/browser/tracing/tracing_controller_impl_data_sinks.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/tracing_controller_impl.h"
 
 #include "base/bind.h"
 #include "base/files/file_util.h"
 #include "base/json/json_writer.h"
 #include "content/public/browser/browser_thread.h"
 #include "third_party/zlib/zlib.h"
 
 namespace content {
 
 namespace {
 
+const char kChromeTraceLabel[] = "traceEvents";
+const char kMetadataTraceLabel[] = "metadata";
+
 class StringTraceDataEndpoint : public TracingController::TraceDataEndpoint {
  public:
   typedef base::Callback<void(scoped_ptr<const base::DictionaryValue>,
                               base::RefCountedString*)> CompletionCallback;
 
   explicit StringTraceDataEndpoint(CompletionCallback callback)
       : completion_callback_(callback) {}
 
   void ReceiveTraceFinalContents(
       scoped_ptr<const base::DictionaryValue> metadata,
@@ skipping 84 matching lines @@
 
 class StringTraceDataSink : public TracingController::TraceDataSink {
  public:
   explicit StringTraceDataSink(
       scoped_refptr<TracingController::TraceDataEndpoint> endpoint)
       : endpoint_(endpoint) {}
 
   void AddTraceChunk(const std::string& chunk) override {
     std::string trace_string;
     if (trace_.empty())
-      trace_string = "{\"traceEvents\":[";
+      trace_string = "{\"" + std::string(kChromeTraceLabel) + "\":[";
     else
       trace_string = ",";
     trace_string += chunk;
 
     AddTraceChunkAndPassToEndpoint(trace_string);
   }
 
   void AddTraceChunkAndPassToEndpoint(const std::string& chunk) {
     trace_ += chunk;
 
     endpoint_->ReceiveTraceChunk(chunk);
   }
 
-  void SetSystemTrace(const std::string& data) override {
-    system_trace_ = data;
-  }
-
-  void SetPowerTrace(const std::string& data) override { power_trace_ = data; }
-
   void Close() override {
     AddTraceChunkAndPassToEndpoint("]");
-    if (!system_trace_.empty())
-      AddTraceChunkAndPassToEndpoint(",\"systemTraceEvents\": " +
-                                     system_trace_);
+
+    for (auto const &it : GetAdditionalTracingAgentTrace())
+      AddTraceChunkAndPassToEndpoint(",\"" + it.first + "\": " + it.second);
+
     std::string metadataJSON;
     if (base::JSONWriter::Write(GetMetadata(), &metadataJSON) &&
-        !metadataJSON.empty())
-      AddTraceChunkAndPassToEndpoint(",\"metadata\": " + metadataJSON);
-    if (!power_trace_.empty()) {
-      AddTraceChunkAndPassToEndpoint(",\"powerTraceAsString\": " +
-                                     power_trace_);
+        !metadataJSON.empty()) {
+      AddTraceChunkAndPassToEndpoint(
+          ",\"" + std::string(kMetadataTraceLabel) + "\": " + metadataJSON);
     }
 
     AddTraceChunkAndPassToEndpoint("}");
 
     scoped_ptr<const base::DictionaryValue> metadata(GetMetadata().DeepCopy());
     endpoint_->ReceiveTraceFinalContents(metadata.Pass(), trace_);
   }
 
  private:
   ~StringTraceDataSink() override {}
 
   scoped_refptr<TracingController::TraceDataEndpoint> endpoint_;
   std::string trace_;
-  std::string system_trace_;
-  std::string power_trace_;
 
   DISALLOW_COPY_AND_ASSIGN(StringTraceDataSink);
 };
 
 class CompressedStringTraceDataSink : public TracingController::TraceDataSink {
  public:
   explicit CompressedStringTraceDataSink(
       scoped_refptr<TracingController::TraceDataEndpoint> endpoint)
       : endpoint_(endpoint), already_tried_open_(false) {}
 
   void AddTraceChunk(const std::string& chunk) override {
     std::string tmp = chunk;
     scoped_refptr<base::RefCountedString> chunk_ptr =
         base::RefCountedString::TakeString(&tmp);
     BrowserThread::PostTask(
         BrowserThread::FILE, FROM_HERE,
         base::Bind(&CompressedStringTraceDataSink::AddTraceChunkOnFileThread,
                    this, chunk_ptr));
   }
 
-  void SetSystemTrace(const std::string& data) override {
-    system_trace_ = data;
-  }
-
-  void SetPowerTrace(const std::string& data) override { power_trace_ = data; }
-
   void Close() override {
     BrowserThread::PostTask(
         BrowserThread::FILE, FROM_HERE,
         base::Bind(&CompressedStringTraceDataSink::CloseOnFileThread, this));
   }
 
  private:
   ~CompressedStringTraceDataSink() override {}
 
   bool OpenZStreamOnFileThread() {
@@ skipping 17 matching lines @@
                               8,  // memLevel = 8 is default.
                               Z_DEFAULT_STRATEGY);
     return result == 0;
   }
 
   void AddTraceChunkOnFileThread(
       const scoped_refptr<base::RefCountedString> chunk_ptr) {
     DCHECK_CURRENTLY_ON(BrowserThread::FILE);
     std::string trace;
     if (compressed_trace_data_.empty())
-      trace = "{\"traceEvents\":[";
+      trace = "{\"" + std::string(kChromeTraceLabel) + "\":[";
     else
       trace = ",";
     trace += chunk_ptr->data();
     AddTraceChunkAndCompressOnFileThread(trace, false);
   }
 
   void AddTraceChunkAndCompressOnFileThread(const std::string& chunk,
                                             bool finished) {
     DCHECK_CURRENTLY_ON(BrowserThread::FILE);
     if (!OpenZStreamOnFileThread())
@@ skipping 21 matching lines @@
         endpoint_->ReceiveTraceChunk(compressed_chunk);
       }
     } while (stream_->avail_out == 0);
   }
 
   void CloseOnFileThread() {
     DCHECK_CURRENTLY_ON(BrowserThread::FILE);
     if (!OpenZStreamOnFileThread())
       return;
 
-    if (compressed_trace_data_.empty())
-      AddTraceChunkAndCompressOnFileThread("{\"traceEvents\":[", false);
+    if (compressed_trace_data_.empty()) {
+      AddTraceChunkAndCompressOnFileThread(
+          "{\"" + std::string(kChromeTraceLabel) + "\":[", false);
+    }
+    AddTraceChunkAndCompressOnFileThread("]", false);
 
-    AddTraceChunkAndCompressOnFileThread("]", false);
-    if (!system_trace_.empty()) {
+    for (auto const &it : GetAdditionalTracingAgentTrace()) {
       AddTraceChunkAndCompressOnFileThread(
-          ",\"systemTraceEvents\": " + system_trace_, false);
+          ",\"" + it.first + "\": " + it.second, false);
     }
+
     std::string metadataJSON;
     if (base::JSONWriter::Write(GetMetadata(), &metadataJSON) &&
         !metadataJSON.empty()) {
-      AddTraceChunkAndCompressOnFileThread(",\"metadata\": " + metadataJSON,
-                                           false);
-    }
-    if (!power_trace_.empty()) {
       AddTraceChunkAndCompressOnFileThread(
-          ",\"powerTraceAsString\": " + power_trace_, false);
+          ",\"" + std::string(kMetadataTraceLabel) + "\": " + metadataJSON,
+          false);
     }
     AddTraceChunkAndCompressOnFileThread("}", true);
 
     deflateEnd(stream_.get());
     stream_.reset();
 
     scoped_ptr<const base::DictionaryValue> metadata(GetMetadata().DeepCopy());
     endpoint_->ReceiveTraceFinalContents(metadata.Pass(),
                                          compressed_trace_data_);
   }
 
   scoped_refptr<TracingController::TraceDataEndpoint> endpoint_;
   scoped_ptr<z_stream> stream_;
   bool already_tried_open_;
   std::string compressed_trace_data_;
-  std::string system_trace_;
-  std::string power_trace_;
 
   DISALLOW_COPY_AND_ASSIGN(CompressedStringTraceDataSink);
 };
 
 }  // namespace
 
+TracingController::TraceDataSink::TraceDataSink() {}
+
+TracingController::TraceDataSink::~TraceDataSink() {}
+
+void TracingController::TraceDataSink::AddAgentTrace(
+    const std::string& trace_label,
+    const std::string& trace_data) {
+  DCHECK(additional_tracing_agent_trace_.find(trace_label) ==
+         additional_tracing_agent_trace_.end());
+  additional_tracing_agent_trace_[trace_label] = trace_data;
+}
+
+const std::map<std::string, std::string>&
+    TracingController::TraceDataSink::GetAdditionalTracingAgentTrace() const {
+  return additional_tracing_agent_trace_;
+}
+
 void TracingController::TraceDataSink::AddMetadata(
     const base::DictionaryValue& data) {
   metadata_.MergeDictionary(&data);
 }
 
 const base::DictionaryValue&
     TracingController::TraceDataSink::GetMetadata() const {
   return metadata_;
 }
 
@@ skipping 24 matching lines @@
   return new StringTraceDataEndpoint(callback);
 }
 
 scoped_refptr<TracingController::TraceDataEndpoint>
 TracingController::CreateFileEndpoint(const base::FilePath& file_path,
                                       const base::Closure& callback) {
   return new FileTraceDataEndpoint(file_path, callback);
 }
 
 }  // namespace content