blob: b11eac8704fad8001b8a65f55351d00411cbffbd [file] [log] [blame]
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "gin/v8_isolate_memory_dump_provider.h"
#include <memory>
#include "base/containers/contains.h"
#include "base/task/single_thread_task_runner.h"
#include "base/task/thread_pool/thread_pool_instance.h"
#include "base/trace_event/process_memory_dump.h"
#include "base/trace_event/trace_event.h"
#include "build/build_config.h"
#include "gin/public/isolate_holder.h"
#include "gin/test/v8_test.h"
#include "v8/include/v8-initialization.h"
namespace gin {
class V8MemoryDumpProviderTest : public V8Test {
void SetUp() override {
// Sets the track objects flag for dumping object statistics. Set this
// before initializing V8, because flags should not be modified after
// initialization. Also, setting the flag as early as possible ensures more
// precise numbers.
v8::V8::SetFlagsFromString("--track-gc-object-stats");
V8Test::SetUp();
}
};
class V8MemoryDumpProviderWorkerTest : public V8MemoryDumpProviderTest {
protected:
std::unique_ptr<IsolateHolder> CreateIsolateHolder() const override {
return std::make_unique<gin::IsolateHolder>(
base::SingleThreadTaskRunner::GetCurrentDefault(),
gin::IsolateHolder::IsolateType::kBlinkWorkerThread);
}
};
// Checks if the dump provider runs without crashing and dumps root objects.
TEST_F(V8MemoryDumpProviderTest, DumpStatistics) {
base::trace_event::MemoryDumpArgs dump_args = {
base::trace_event::MemoryDumpLevelOfDetail::kDetailed};
std::unique_ptr<base::trace_event::ProcessMemoryDump> process_memory_dump(
new base::trace_event::ProcessMemoryDump(dump_args));
instance_->isolate_memory_dump_provider_for_testing()->OnMemoryDump(
dump_args, process_memory_dump.get());
const base::trace_event::ProcessMemoryDump::AllocatorDumpsMap&
allocator_dumps = process_memory_dump->allocator_dumps();
bool did_dump_isolate_stats = false;
bool did_dump_space_stats = false;
bool did_dump_objects_stats = false;
for (const auto& name_dump : allocator_dumps) {
const std::string& name = name_dump.first;
if (base::Contains(name, "v8/main")) {
did_dump_isolate_stats = true;
}
if (base::Contains(name, "v8/main/heap")) {
did_dump_space_stats = true;
}
if (base::Contains(name, "v8/main/heap_objects")) {
did_dump_objects_stats = true;
}
}
ASSERT_TRUE(did_dump_isolate_stats);
ASSERT_TRUE(did_dump_space_stats);
ASSERT_TRUE(did_dump_objects_stats);
}
TEST_F(V8MemoryDumpProviderTest, DumpGlobalHandlesSize) {
base::trace_event::MemoryDumpArgs dump_args = {
base::trace_event::MemoryDumpLevelOfDetail::kBackground};
std::unique_ptr<base::trace_event::ProcessMemoryDump> process_memory_dump(
new base::trace_event::ProcessMemoryDump(dump_args));
instance_->isolate_memory_dump_provider_for_testing()->OnMemoryDump(
dump_args, process_memory_dump.get());
const base::trace_event::ProcessMemoryDump::AllocatorDumpsMap&
allocator_dumps = process_memory_dump->allocator_dumps();
bool did_dump_global_handles = false;
for (const auto& name_dump : allocator_dumps) {
const std::string& name = name_dump.first;
if (base::Contains(name, "v8/main/global_handles")) {
did_dump_global_handles = true;
}
}
ASSERT_TRUE(did_dump_global_handles);
}
TEST_F(V8MemoryDumpProviderTest, DumpContextStatistics) {
base::trace_event::MemoryDumpArgs dump_args = {
base::trace_event::MemoryDumpLevelOfDetail::kLight};
std::unique_ptr<base::trace_event::ProcessMemoryDump> process_memory_dump(
new base::trace_event::ProcessMemoryDump(dump_args));
instance_->isolate_memory_dump_provider_for_testing()->OnMemoryDump(
dump_args, process_memory_dump.get());
const base::trace_event::ProcessMemoryDump::AllocatorDumpsMap&
allocator_dumps = process_memory_dump->allocator_dumps();
bool did_dump_detached_contexts = false;
bool did_dump_native_contexts = false;
for (const auto& name_dump : allocator_dumps) {
const std::string& name = name_dump.first;
if (base::Contains(name, "main/contexts/detached_context")) {
did_dump_detached_contexts = true;
}
if (base::Contains(name, "main/contexts/native_context")) {
did_dump_native_contexts = true;
}
}
ASSERT_TRUE(did_dump_detached_contexts);
ASSERT_TRUE(did_dump_native_contexts);
}
TEST_F(V8MemoryDumpProviderWorkerTest, DumpContextStatistics) {
base::trace_event::MemoryDumpArgs dump_args = {
base::trace_event::MemoryDumpLevelOfDetail::kLight};
std::unique_ptr<base::trace_event::ProcessMemoryDump> process_memory_dump(
new base::trace_event::ProcessMemoryDump(dump_args));
instance_->isolate_memory_dump_provider_for_testing()->OnMemoryDump(
dump_args, process_memory_dump.get());
const base::trace_event::ProcessMemoryDump::AllocatorDumpsMap&
allocator_dumps = process_memory_dump->allocator_dumps();
bool did_dump_detached_contexts = false;
bool did_dump_native_contexts = false;
for (const auto& name_dump : allocator_dumps) {
const std::string& name = name_dump.first;
if (base::Contains(name, "workers/contexts/detached_context/isolate_0x")) {
did_dump_detached_contexts = true;
}
if (base::Contains(name, "workers/contexts/native_context/isolate_0x")) {
did_dump_native_contexts = true;
}
}
ASSERT_TRUE(did_dump_detached_contexts);
ASSERT_TRUE(did_dump_native_contexts);
}
TEST_F(V8MemoryDumpProviderTest, DumpCodeStatistics) {
// Code stats are disabled unless this category is enabled.
base::trace_event::TraceLog::GetInstance()->SetEnabled(
base::trace_event::TraceConfig(
TRACE_DISABLED_BY_DEFAULT("memory-infra.v8.code_stats"), ""),
base::trace_event::TraceLog::RECORDING_MODE);
base::trace_event::MemoryDumpArgs dump_args = {
base::trace_event::MemoryDumpLevelOfDetail::kLight};
std::unique_ptr<base::trace_event::ProcessMemoryDump> process_memory_dump(
new base::trace_event::ProcessMemoryDump(dump_args));
instance_->isolate_memory_dump_provider_for_testing()->OnMemoryDump(
dump_args, process_memory_dump.get());
const base::trace_event::ProcessMemoryDump::AllocatorDumpsMap&
allocator_dumps = process_memory_dump->allocator_dumps();
bool did_dump_bytecode_size = false;
bool did_dump_code_size = false;
bool did_dump_external_scripts_size = false;
bool did_dump_cpu_profiler_metadata_size = false;
for (const auto& name_dump : allocator_dumps) {
const std::string& name = name_dump.first;
if (base::Contains(name, "code_stats")) {
for (const base::trace_event::MemoryAllocatorDump::Entry& entry :
name_dump.second->entries()) {
if (base::Contains(entry.name, "bytecode_and_metadata_size")) {
did_dump_bytecode_size = true;
} else if (base::Contains(entry.name, "code_and_metadata_size")) {
did_dump_code_size = true;
} else if (base::Contains(entry.name, "external_script_source_size")) {
did_dump_external_scripts_size = true;
} else if (base::Contains(entry.name, "cpu_profiler_metadata_size")) {
did_dump_cpu_profiler_metadata_size = true;
}
}
}
}
base::trace_event::TraceLog::GetInstance()->SetDisabled();
ASSERT_TRUE(did_dump_bytecode_size);
ASSERT_TRUE(did_dump_code_size);
ASSERT_TRUE(did_dump_external_scripts_size);
ASSERT_TRUE(did_dump_cpu_profiler_metadata_size);
}
// Tests that a deterministic memory dump request performs a GC.
TEST_F(V8MemoryDumpProviderTest, Deterministic) {
base::trace_event::MemoryDumpArgs dump_args = {
base::trace_event::MemoryDumpLevelOfDetail::kLight,
base::trace_event::MemoryDumpDeterminism::kForceGc};
std::unique_ptr<base::trace_event::ProcessMemoryDump> process_memory_dump(
new base::trace_event::ProcessMemoryDump(dump_args));
// Allocate an object that has only a weak reference.
v8::Global<v8::Object> weak_ref;
{
v8::HandleScope scope(instance_->isolate());
v8::Local<v8::Object> object = v8::Object::New(instance_->isolate());
weak_ref.Reset(instance_->isolate(), object);
weak_ref.SetWeak();
}
// Deterministic memory dump should trigger GC.
instance_->isolate_memory_dump_provider_for_testing()->OnMemoryDump(
dump_args, process_memory_dump.get());
// GC reclaimed the object.
ASSERT_TRUE(weak_ref.IsEmpty());
}
} // namespace gin