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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
|
// Copyright 2012 The Chromium Authors
// 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_ui.h"
#include <stddef.h>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "base/base64.h"
#include "base/command_line.h"
#include "base/format_macros.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/json/json_reader.h"
#include "base/json/json_writer.h"
#include "base/memory/ref_counted_memory.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/string_split.h"
#include "base/strings/string_util.h"
#include "base/trace_event/trace_event.h"
#include "base/values.h"
#include "content/browser/tracing/tracing_controller_impl.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/storage_partition.h"
#include "content/public/browser/tracing_controller.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_ui.h"
#include "content/public/browser/web_ui_data_source.h"
#include "content/public/common/content_client.h"
#include "content/public/common/url_constants.h"
#include "services/tracing/public/cpp/perfetto/perfetto_config.h"
#include "services/tracing/public/cpp/perfetto/perfetto_session.h"
#include "third_party/perfetto/include/perfetto/tracing/tracing.h"
#include "third_party/perfetto/protos/perfetto/common/trace_stats.gen.h"
namespace content {
namespace {
constexpr char kStreamFormat[] = "stream_format";
constexpr char kStreamFormatProtobuf[] = "protobuf";
constexpr char kStreamFormatJSON[] = "json";
perfetto::TracingSession* g_tracing_session = nullptr;
void OnGotCategories(WebUIDataSource::GotDataCallback callback,
const std::set<std::string>& category_set) {
base::Value::List category_list;
for (const std::string& category : category_set) {
category_list.Append(category);
}
auto res = base::MakeRefCounted<base::RefCountedString>();
base::JSONWriter::Write(category_list, &res->as_string());
std::move(callback).Run(res);
}
void OnRecordingEnabledAck(WebUIDataSource::GotDataCallback callback);
bool BeginRecording(const std::string& data64,
WebUIDataSource::GotDataCallback callback) {
base::trace_event::TraceConfig trace_config("", "");
std::string stream_format;
if (!TracingUI::GetTracingOptions(data64, trace_config, stream_format))
return false;
// TODO(skyostil): Migrate all use cases from TracingController to Perfetto.
if (stream_format == kStreamFormatProtobuf) {
delete g_tracing_session;
g_tracing_session =
perfetto::Tracing::NewTrace(perfetto::BackendType::kCustomBackend)
.release();
g_tracing_session->Setup(tracing::GetDefaultPerfettoConfig(trace_config));
auto shared_callback = base::MakeRefCounted<
base::RefCountedData<WebUIDataSource::GotDataCallback>>(
std::move(callback));
g_tracing_session->SetOnStartCallback([shared_callback] {
OnRecordingEnabledAck(std::move(shared_callback->data));
});
g_tracing_session->Start();
return true;
}
return TracingController::GetInstance()->StartTracing(
trace_config,
base::BindOnce(&OnRecordingEnabledAck, std::move(callback)));
}
void OnTraceBufferUsageResult(WebUIDataSource::GotDataCallback callback,
float percent_full,
size_t approximate_event_count) {
std::string str = base::NumberToString(percent_full);
std::move(callback).Run(
base::MakeRefCounted<base::RefCountedString>(std::move(str)));
}
bool GetTraceBufferUsage(WebUIDataSource::GotDataCallback callback) {
if (g_tracing_session) {
// |callback| is move-only, so in order to pass it through a copied lambda
// we need to temporarily move it on the heap.
auto shared_callback = base::MakeRefCounted<
base::RefCountedData<WebUIDataSource::GotDataCallback>>(
std::move(callback));
g_tracing_session->GetTraceStats(
[shared_callback](
perfetto::TracingSession::GetTraceStatsCallbackArgs args) {
std::string usage;
perfetto::protos::gen::TraceStats trace_stats;
if (args.success &&
trace_stats.ParseFromArray(args.trace_stats_data.data(),
args.trace_stats_data.size())) {
double percent_full = tracing::GetTraceBufferUsage(trace_stats);
usage = base::NumberToString(percent_full);
}
std::move(shared_callback->data)
.Run(base::MakeRefCounted<base::RefCountedString>(
std::move(usage)));
});
return true;
}
return TracingController::GetInstance()->GetTraceBufferUsage(
base::BindOnce(OnTraceBufferUsageResult, std::move(callback)));
}
void ReadProtobufTraceData(
scoped_refptr<TracingController::TraceDataEndpoint> endpoint,
perfetto::TracingSession::ReadTraceCallbackArgs args) {
if (args.size) {
auto data_string = std::make_unique<std::string>(args.data, args.size);
endpoint->ReceiveTraceChunk(std::move(data_string));
}
if (!args.has_more)
endpoint->ReceivedTraceFinalContents();
}
void TracingCallbackWrapperBase64(WebUIDataSource::GotDataCallback callback,
std::unique_ptr<std::string> data) {
base::RefCountedString* data_base64 = new base::RefCountedString();
data_base64->as_string() = base::Base64Encode(*data);
std::move(callback).Run(data_base64);
}
bool EndRecording(WebUIDataSource::GotDataCallback callback) {
if (!TracingController::GetInstance()->IsTracing() && !g_tracing_session)
return false;
scoped_refptr<TracingController::TraceDataEndpoint> data_endpoint =
TracingControllerImpl::CreateCompressedStringEndpoint(
TracingControllerImpl::CreateCallbackEndpoint(base::BindOnce(
TracingCallbackWrapperBase64, std::move(callback))),
false /* compress_with_background_priority */);
if (g_tracing_session) {
perfetto::TracingSession* session = g_tracing_session;
g_tracing_session = nullptr;
session->SetOnStopCallback([session, data_endpoint] {
session->ReadTrace(
[session, data_endpoint](
perfetto::TracingSession::ReadTraceCallbackArgs args) {
ReadProtobufTraceData(data_endpoint, args);
if (!args.has_more)
delete session;
});
});
session->Stop();
return true;
}
return TracingController::GetInstance()->StopTracing(data_endpoint);
}
void OnRecordingEnabledAck(WebUIDataSource::GotDataCallback callback) {
std::move(callback).Run(base::MakeRefCounted<base::RefCountedString>());
}
bool OnBeginJSONRequest(const std::string& path,
WebUIDataSource::GotDataCallback callback) {
if (path == "json/categories") {
return TracingController::GetInstance()->GetCategories(
base::BindOnce(OnGotCategories, std::move(callback)));
}
const char kBeginRecordingPath[] = "json/begin_recording?";
if (base::StartsWith(path, kBeginRecordingPath,
base::CompareCase::SENSITIVE)) {
std::string data = path.substr(strlen(kBeginRecordingPath));
return BeginRecording(data, std::move(callback));
}
if (path == "json/get_buffer_percent_full") {
return GetTraceBufferUsage(std::move(callback));
}
if (path == "json/end_recording_compressed") {
return EndRecording(std::move(callback));
}
LOG(ERROR) << "Unhandled request to " << path;
return false;
}
bool OnShouldHandleRequest(const std::string& path) {
return base::StartsWith(path, "json/", base::CompareCase::SENSITIVE);
}
void OnTracingRequest(const std::string& path,
WebUIDataSource::GotDataCallback callback) {
DCHECK(OnShouldHandleRequest(path));
// OnBeginJSONRequest() only runs |callback| if it returns true. But it needs
// to take ownership of |callback| even though it won't call |callback|
// sometimes, as it binds |callback| into other callbacks before it makes that
// decision. So we must give it one copy and keep one ourselves.
auto split_callback = base::SplitOnceCallback(std::move(callback));
if (!OnBeginJSONRequest(path, std::move(split_callback.first))) {
std::string error("##ERROR##");
std::move(split_callback.second)
.Run(base::MakeRefCounted<base::RefCountedString>(std::move(error)));
}
}
} // namespace
////////////////////////////////////////////////////////////////////////////////
//
// TracingUI
//
////////////////////////////////////////////////////////////////////////////////
TracingUI::TracingUI(WebUI* web_ui) : WebUIController(web_ui) {
// Set up the chrome://tracing/ source.
WebUIDataSource* source = WebUIDataSource::CreateAndAdd(
web_ui->GetWebContents()->GetBrowserContext(), kChromeUITracingHost);
source->DisableTrustedTypesCSP();
source->UseStringsJs();
source->SetRequestFilter(base::BindRepeating(OnShouldHandleRequest),
base::BindRepeating(OnTracingRequest));
}
TracingUI::~TracingUI() = default;
// static
bool TracingUI::GetTracingOptions(const std::string& data64,
base::trace_event::TraceConfig& trace_config,
std::string& out_stream_format) {
std::string data;
if (!base::Base64Decode(data64, &data)) {
LOG(ERROR) << "Options were not base64 encoded.";
return false;
}
std::optional<base::Value> options = base::JSONReader::Read(data);
if (!options) {
LOG(ERROR) << "Options were not valid JSON";
return false;
}
base::Value::Dict* options_dict = options->GetIfDict();
if (!options_dict) {
LOG(ERROR) << "Options must be dict";
return false;
}
if (const std::string* stream_format =
options_dict->FindString(kStreamFormat)) {
out_stream_format = *stream_format;
} else {
out_stream_format = kStreamFormatJSON;
}
// New-style options dictionary.
trace_config = base::trace_event::TraceConfig(*options_dict);
return true;
}
} // namespace content
|