File: trace_event_agent.cc

package info (click to toggle)
chromium-browser 70.0.3538.110-1~deb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,619,476 kB
  • sloc: cpp: 13,024,755; ansic: 1,349,823; python: 916,672; xml: 314,489; java: 280,047; asm: 276,936; perl: 75,771; objc: 66,634; sh: 45,860; cs: 28,354; php: 11,064; makefile: 10,911; yacc: 9,109; tcl: 8,403; ruby: 4,065; lex: 1,779; pascal: 1,411; lisp: 1,055; awk: 41; jsp: 39; sed: 17; sql: 3
file content (219 lines) | stat: -rw-r--r-- 7,538 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
// Copyright 2017 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 "services/tracing/public/cpp/trace_event_agent.h"

#include <string>
#include <utility>
#include <vector>

#include "base/bind.h"
#include "base/memory/ref_counted.h"
#include "base/memory/ref_counted_memory.h"
#include "base/no_destructor.h"
#include "base/strings/string_util.h"
#include "base/threading/thread_checker.h"
#include "base/time/time.h"
#include "base/trace_event/trace_log.h"
#include "base/values.h"
#include "build/build_config.h"
#include "services/service_manager/public/cpp/connector.h"
#include "services/tracing/public/cpp/tracing_features.h"
#include "services/tracing/public/mojom/constants.mojom.h"

#if 0
#define PERFETTO_AVAILABLE
#include "services/tracing/public/cpp/perfetto/producer_client.h"
#include "services/tracing/public/cpp/perfetto/trace_event_data_source.h"
#include "third_party/perfetto/include/perfetto/tracing/core/trace_writer.h"
#include "third_party/perfetto/protos/perfetto/trace/chrome/chrome_trace_event.pbzero.h"
#include "third_party/perfetto/protos/perfetto/trace/trace_packet.pbzero.h"
#endif

namespace {

const char kTraceEventLabel[] = "traceEvents";

}  // namespace

namespace tracing {

#if defined(PERFETTO_AVAILABLE)

namespace {

ProducerClient* GetProducerClient() {
  static base::NoDestructor<ProducerClient> producer_client;
  return producer_client.get();
}

}  // namespace

class PerfettoTraceEventAgent : public TraceEventAgent {
 public:
  PerfettoTraceEventAgent(service_manager::Connector* connector,
                          bool request_clock_sync_marker_on_android)
      : TraceEventAgent(connector, request_clock_sync_marker_on_android) {
    mojom::PerfettoServicePtr perfetto_service;
    connector->BindInterface(mojom::kServiceName, &perfetto_service);

    GetProducerClient()->CreateMojoMessagepipes(base::BindOnce(
        [](mojom::PerfettoServicePtr perfetto_service,
           mojom::ProducerClientPtr producer_client_pipe,
           mojom::ProducerHostRequest producer_host_pipe) {
          perfetto_service->ConnectToProducerHost(
              std::move(producer_client_pipe), std::move(producer_host_pipe));
        },
        std::move(perfetto_service)));

    GetProducerClient()->AddDataSource(TraceEventDataSource::GetInstance());
  }

  void AddMetadataGeneratorFunction(
      MetadataGeneratorFunction generator) override {
    // Instantiate and register the metadata data source on the first
    // call.
    static TraceEventMetadataSource* metadata_source = []() {
      static base::NoDestructor<TraceEventMetadataSource> instance;
      GetProducerClient()->AddDataSource(instance.get());
      return instance.get();
    }();

    metadata_source->AddGeneratorFunction(generator);
  }
};
#endif

// static
std::unique_ptr<TraceEventAgent> TraceEventAgent::Create(
    service_manager::Connector* connector,
    bool request_clock_sync_marker_on_android) {
  std::unique_ptr<TraceEventAgent> new_agent;

  if (TracingUsesPerfettoBackend()) {
#if defined(PERFETTO_AVAILABLE)
    new_agent = std::make_unique<PerfettoTraceEventAgent>(
        connector, request_clock_sync_marker_on_android);
#else
    LOG(ERROR) << "Perfetto is not yet available for this platform; falling "
                  "back to using legacy TraceLog";
#endif
  }

  // Use legacy tracing if we're on an unsupported platform or the feature flag
  // is disabled.
  if (!new_agent) {
    new_agent = std::make_unique<LegacyTraceEventAgent>(
        connector, request_clock_sync_marker_on_android);
  }

  return new_agent;
}

TraceEventAgent::TraceEventAgent(service_manager::Connector* connector,
                                 bool request_clock_sync_marker_on_android)
    : BaseAgent(connector,
                kTraceEventLabel,
                mojom::TraceDataType::ARRAY,
#if defined(OS_ANDROID)
                request_clock_sync_marker_on_android,
#else
                false,
#endif
                base::trace_event::TraceLog::GetInstance()->process_id()) {
}

TraceEventAgent::~TraceEventAgent() = default;

void TraceEventAgent::RequestClockSyncMarker(
    const std::string& sync_id,
    Agent::RequestClockSyncMarkerCallback callback) {
#if defined(OS_ANDROID)
  base::trace_event::TraceLog::GetInstance()->AddClockSyncMetadataEvent();
  std::move(callback).Run(base::TimeTicks(), base::TimeTicks());
#else
  NOTREACHED();
#endif
}

void TraceEventAgent::GetCategories(GetCategoriesCallback callback) {
  std::vector<std::string> category_vector;
  base::trace_event::TraceLog::GetInstance()->GetKnownCategoryGroups(
      &category_vector);
  std::move(callback).Run(base::JoinString(category_vector, ","));
}

LegacyTraceEventAgent::LegacyTraceEventAgent(
    service_manager::Connector* connector,
    bool request_clock_sync_marker_on_android)
    : TraceEventAgent(connector, request_clock_sync_marker_on_android),
      enabled_tracing_modes_(0) {
  DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
}

LegacyTraceEventAgent::~LegacyTraceEventAgent() {
  DCHECK(!trace_log_needs_me_);
}

void LegacyTraceEventAgent::AddMetadataGeneratorFunction(
    MetadataGeneratorFunction generator) {
  DCHECK_CALLED_ON_VALID_THREAD(thread_checker_);
  metadata_generator_functions_.push_back(generator);
}

void LegacyTraceEventAgent::StartTracing(const std::string& config,
                                         base::TimeTicks coordinator_time,
                                         StartTracingCallback callback) {
  DCHECK(!recorder_);
#if defined(__native_client__)
  // NaCl and system times are offset by a bit, so subtract some time from
  // the captured timestamps. The value might be off by a bit due to messaging
  // latency.
  base::TimeDelta time_offset = TRACE_TIME_TICKS_NOW() - coordinator_time;
  TraceLog::GetInstance()->SetTimeOffset(time_offset);
#endif
  enabled_tracing_modes_ = base::trace_event::TraceLog::RECORDING_MODE;
  const base::trace_event::TraceConfig trace_config(config);
  if (!trace_config.event_filters().empty())
    enabled_tracing_modes_ |= base::trace_event::TraceLog::FILTERING_MODE;
  base::trace_event::TraceLog::GetInstance()->SetEnabled(
      trace_config, enabled_tracing_modes_);
  std::move(callback).Run(true);
}

void LegacyTraceEventAgent::StopAndFlush(mojom::RecorderPtr recorder) {
  DCHECK(!recorder_);
  recorder_ = std::move(recorder);
  base::trace_event::TraceLog::GetInstance()->SetDisabled(
      enabled_tracing_modes_);
  enabled_tracing_modes_ = 0;
  for (const auto& generator : metadata_generator_functions_) {
    auto metadata = generator.Run();
    if (metadata)
      recorder_->AddMetadata(std::move(*metadata));
  }
  trace_log_needs_me_ = true;
  base::trace_event::TraceLog::GetInstance()->Flush(base::Bind(
      &LegacyTraceEventAgent::OnTraceLogFlush, base::Unretained(this)));
}

void LegacyTraceEventAgent::RequestBufferStatus(
    RequestBufferStatusCallback callback) {
  base::trace_event::TraceLogStatus status =
      base::trace_event::TraceLog::GetInstance()->GetStatus();
  std::move(callback).Run(status.event_capacity, status.event_count);
}

void LegacyTraceEventAgent::OnTraceLogFlush(
    const scoped_refptr<base::RefCountedString>& events_str,
    bool has_more_events) {
  if (!events_str->data().empty())
    recorder_->AddChunk(events_str->data());
  if (!has_more_events) {
    trace_log_needs_me_ = false;
    recorder_.reset();
  }
}

}  // namespace tracing