| // Copyright 2019 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 "base/files/file_util.h" |
| #include "base/json/json_reader.h" |
| #include "base/run_loop.h" |
| #include "base/test/scoped_feature_list.h" |
| #include "base/test/test_timeouts.h" |
| #include "base/threading/thread_restrictions.h" |
| #include "base/threading/thread_task_runner_handle.h" |
| #include "build/build_config.h" |
| #include "components/tracing/common/trace_startup_config.h" |
| #include "components/tracing/common/tracing_switches.h" |
| #include "content/browser/tracing/startup_tracing_controller.h" |
| #include "content/browser/tracing/tracing_controller_impl.h" |
| #include "content/public/test/browser_test.h" |
| #include "content/public/test/content_browser_test.h" |
| #include "content/public/test/content_browser_test_utils.h" |
| #include "services/tracing/perfetto/privacy_filtering_check.h" |
| #include "services/tracing/public/cpp/perfetto/trace_event_data_source.h" |
| #include "services/tracing/public/cpp/trace_startup.h" |
| #include "services/tracing/public/cpp/tracing_features.h" |
| |
| namespace content { |
| |
| namespace { |
| |
| // Wait until |condition| returns true. |
| void WaitForCondition(base::RepeatingCallback<bool()> condition, |
| const std::string& description) { |
| const base::TimeDelta kTimeout = base::TimeDelta::FromSeconds(30); |
| const base::TimeTicks start_time = base::TimeTicks::Now(); |
| while (!condition.Run() && (base::TimeTicks::Now() - start_time < kTimeout)) { |
| base::RunLoop run_loop; |
| base::ThreadTaskRunnerHandle::Get()->PostDelayedTask( |
| FROM_HERE, run_loop.QuitClosure(), TestTimeouts::tiny_timeout()); |
| run_loop.Run(); |
| } |
| ASSERT_TRUE(condition.Run()) |
| << "Timeout waiting for condition: " << description; |
| } |
| |
| } // namespace |
| |
| class StartupTracingInProcessTest : public ContentBrowserTest { |
| public: |
| StartupTracingInProcessTest() { |
| scoped_feature_list_.InitWithFeatures( |
| /*enabled_features=*/{features::kTracingServiceInProcess}, |
| /*disabled_features=*/{}); |
| } |
| |
| private: |
| base::test::ScopedFeatureList scoped_feature_list_; |
| }; |
| |
| class LargeTraceEventData : public base::trace_event::ConvertableToTraceFormat { |
| public: |
| LargeTraceEventData() = default; |
| ~LargeTraceEventData() override = default; |
| |
| const size_t kLargeMessageSize = 100 * 1024; |
| void AppendAsTraceFormat(std::string* out) const override { |
| std::string large_string(kLargeMessageSize, '.'); |
| out->append(large_string); |
| } |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(LargeTraceEventData); |
| }; |
| |
| // This will fill a massive amount of startup tracing data into a |
| // StartupTraceWriter, which Perfetto will then have to sync copy into |
| // the SMB once the full tracing service starts up. This is to catch common |
| // deadlocks. |
| IN_PROC_BROWSER_TEST_F(StartupTracingInProcessTest, TestFilledStartupBuffer) { |
| auto config = tracing::TraceStartupConfig::GetInstance() |
| ->GetDefaultBrowserStartupConfig(); |
| config.SetTraceBufferSizeInEvents(0); |
| config.SetTraceBufferSizeInKb(0); |
| |
| CHECK(tracing::EnableStartupTracingForProcess( |
| config, |
| /*privacy_filtering_enabled=*/false)); |
| |
| for (int i = 0; i < 1024; ++i) { |
| auto data = std::make_unique<LargeTraceEventData>(); |
| TRACE_EVENT1("toplevel", "bar", "data", std::move(data)); |
| } |
| |
| config.SetTraceBufferSizeInKb(32); |
| |
| base::RunLoop wait_for_tracing; |
| TracingControllerImpl::GetInstance()->StartTracing( |
| config, wait_for_tracing.QuitClosure()); |
| wait_for_tracing.Run(); |
| |
| EXPECT_TRUE(NavigateToURL(shell(), GetTestUrl("", "title1.html"))); |
| |
| base::RunLoop wait_for_stop; |
| TracingControllerImpl::GetInstance()->StopTracing( |
| TracingController::CreateStringEndpoint(base::BindOnce( |
| [](base::OnceClosure quit_callback, |
| std::unique_ptr<std::string> data) { |
| std::move(quit_callback).Run(); |
| }, |
| wait_for_stop.QuitClosure()))); |
| wait_for_stop.Run(); |
| } |
| |
| namespace { |
| |
| enum class FinishType { |
| kWaitForTimeout, |
| kStopExplicitly, |
| }; |
| |
| std::ostream& operator<<(std::ostream& o, FinishType type) { |
| switch (type) { |
| case FinishType::kStopExplicitly: |
| o << "Stop"; |
| return o; |
| case FinishType::kWaitForTimeout: |
| o << "Wait"; |
| return o; |
| } |
| } |
| |
| enum class OutputType { |
| kProto, |
| kJSON, |
| }; |
| |
| std::ostream& operator<<(std::ostream& o, OutputType type) { |
| switch (type) { |
| case OutputType::kJSON: |
| o << "json"; |
| return o; |
| case OutputType::kProto: |
| o << "proto"; |
| return o; |
| } |
| } |
| |
| enum class OutputLocation { |
| // Write trace to a given file. |
| kGivenFile, |
| // Write trace into a given directory (basename will be set to trace1 before |
| // starting). |
| kDirectoryWithDefaultBasename, |
| // Write trace into a given directory (basename will be set to trace1 before |
| // starting, and updated to trace2 before calling Stop()). |
| kDirectoryWithBasenameUpdatedBeforeStop, |
| }; |
| |
| std::ostream& operator<<(std::ostream& o, OutputLocation type) { |
| switch (type) { |
| case OutputLocation::kGivenFile: |
| o << "file"; |
| return o; |
| case OutputLocation::kDirectoryWithDefaultBasename: |
| o << "dir/trace1"; |
| return o; |
| case OutputLocation::kDirectoryWithBasenameUpdatedBeforeStop: |
| o << "dir/trace2"; |
| return o; |
| } |
| } |
| |
| } // namespace |
| |
| class StartupTracingTest |
| : public ContentBrowserTest, |
| public testing::WithParamInterface< |
| std::tuple<FinishType, OutputType, OutputLocation>> { |
| public: |
| StartupTracingTest() = default; |
| |
| void SetUpCommandLine(base::CommandLine* command_line) override { |
| command_line->AppendSwitch(switches::kTraceStartup); |
| if (GetFinishType() == FinishType::kWaitForTimeout) { |
| command_line->AppendSwitchASCII(switches::kTraceStartupDuration, "3"); |
| } else { |
| command_line->AppendSwitchASCII(switches::kTraceStartupDuration, "0"); |
| } |
| command_line->AppendSwitchASCII(switches::kTraceStartupFormat, |
| GetOutputTypeAsString()); |
| |
| if (GetOutputLocation() == OutputLocation::kGivenFile) { |
| base::CreateTemporaryFile(&temp_file_path_); |
| } else { |
| base::CreateNewTempDirectory(base::FilePath::StringType(), |
| &temp_file_path_); |
| temp_file_path_ = temp_file_path_.AsEndingWithSeparator(); |
| } |
| |
| command_line->AppendSwitchASCII(switches::kEnableTracingOutput, |
| temp_file_path_.AsUTF8Unsafe()); |
| |
| if (GetOutputLocation() != OutputLocation::kGivenFile) { |
| // --enable-tracing-format switch should be initialised before |
| // calling SetDefaultBasenameForTest, which forces the creation of |
| // TraceStartupConfig, which queries the command line flags and |
| // stores the snapshot. |
| StartupTracingController::GetInstance().SetDefaultBasenameForTest( |
| "trace1", |
| StartupTracingController::ExtensionType::kAppendAppropriate); |
| } |
| } |
| |
| FinishType GetFinishType() { return std::get<0>(GetParam()); } |
| |
| OutputType GetOutputType() { return std::get<1>(GetParam()); } |
| |
| std::string GetOutputTypeAsString() { |
| switch (GetOutputType()) { |
| case OutputType::kJSON: |
| return "json"; |
| case OutputType::kProto: |
| return "proto"; |
| } |
| } |
| |
| OutputLocation GetOutputLocation() { return std::get<2>(GetParam()); } |
| |
| base::FilePath GetExpectedPath() { |
| std::string filename; |
| |
| switch (GetOutputLocation()) { |
| case OutputLocation::kGivenFile: |
| return temp_file_path_; |
| case OutputLocation::kDirectoryWithDefaultBasename: |
| filename = "trace1"; |
| break; |
| case OutputLocation::kDirectoryWithBasenameUpdatedBeforeStop: |
| filename = "trace2"; |
| break; |
| } |
| |
| // Renames are not supported together with timeouts. |
| if (GetFinishType() == FinishType::kWaitForTimeout) |
| filename = "trace1"; |
| |
| return temp_file_path_.AppendASCII(filename + "." + |
| GetOutputTypeAsString()); |
| } |
| |
| void CheckOutput(base::FilePath path) { |
| std::string trace; |
| base::ScopedAllowBlockingForTesting allow_blocking; |
| ASSERT_TRUE(base::ReadFileToString(path, &trace)) |
| << "Failed to read file " << path; |
| |
| if (GetOutputType() == OutputType::kJSON) { |
| EXPECT_TRUE(base::JSONReader::Read(trace)); |
| } |
| |
| // Both proto and json should have the trace event name recorded somewhere |
| // as a substring. |
| EXPECT_TRUE(trace.find("StartupTracingController::Start") != |
| std::string::npos); |
| } |
| |
| void Wait() { |
| if (GetFinishType() == FinishType::kWaitForTimeout) { |
| WaitForCondition(base::BindRepeating([]() { |
| return StartupTracingController::GetInstance() |
| .is_finished_for_testing(); |
| }), |
| "finish file write"); |
| } else { |
| StartupTracingController::GetInstance().WaitUntilStopped(); |
| } |
| } |
| |
| protected: |
| base::FilePath temp_file_path_; |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(StartupTracingTest); |
| }; |
| |
| INSTANTIATE_TEST_SUITE_P( |
| All, |
| StartupTracingTest, |
| testing::Combine( |
| testing::Values(FinishType::kStopExplicitly, |
| FinishType::kWaitForTimeout), |
| testing::Values(OutputType::kJSON, OutputType::kProto), |
| testing::Values( |
| OutputLocation::kGivenFile, |
| OutputLocation::kDirectoryWithDefaultBasename, |
| OutputLocation::kDirectoryWithBasenameUpdatedBeforeStop))); |
| |
| // Failing on Android/Win ASAN, Linux TSAN. crbug.com/1041392 |
| #if (defined(OS_ANDROID) && defined(ADDRESS_SANITIZER)) || \ |
| (defined(OS_WIN) && defined(ADDRESS_SANITIZER)) || \ |
| ((defined(OS_LINUX) || defined(OS_CHROMEOS)) && defined(THREAD_SANITIZER)) |
| #define MAYBE_TestEnableTracing DISABLED_TestStartupTracing |
| #else |
| #define MAYBE_TestEnableTracing TestStartupTracing |
| #endif |
| IN_PROC_BROWSER_TEST_P(StartupTracingTest, TestEnableTracing) { |
| EXPECT_TRUE(NavigateToURL(shell(), GetTestUrl("", "title1.html"))); |
| |
| if (GetOutputLocation() == |
| OutputLocation::kDirectoryWithBasenameUpdatedBeforeStop) { |
| StartupTracingController::GetInstance().SetDefaultBasenameForTest( |
| "trace2", StartupTracingController::ExtensionType::kAppendAppropriate); |
| } |
| |
| Wait(); |
| |
| CheckOutput(GetExpectedPath()); |
| } |
| |
| } // namespace content |