v8/tools/gcmole/gcmole-test.cc
Michael Achenbach 43fd63554e [gcmole] Add regression test with multiple safepoints
Bug: v8:13536
Change-Id: I1cac6a34b6948f7e5365c5454ad6d3f928d906d4
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/4134164
Commit-Queue: Michael Achenbach <machenbach@chromium.org>
Reviewed-by: Leszek Swirski <leszeks@chromium.org>
Cr-Commit-Position: refs/heads/main@{#85111}
2023-01-05 09:47:58 +00:00

364 lines
11 KiB
C++

// Copyright 2019 the V8 project 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 "src/execution/isolate.h"
#include "src/handles/handles-inl.h"
#include "src/handles/handles.h"
#include "src/heap/local-heap.h"
#include "src/objects/foreign-inl.h"
#include "src/objects/managed.h"
#include "src/objects/maybe-object.h"
#include "src/objects/object-macros.h"
namespace v8 {
namespace internal {
// ------- Test simple argument evaluation order problems ---------
void Safepoint() { LocalHeap::Current()->Safepoint(); }
Handle<Object> CauseGC(Handle<Object> obj, Isolate* isolate) {
isolate->heap()->CollectGarbage(OLD_SPACE, GarbageCollectionReason::kTesting);
return obj;
}
Object CauseGCRaw(Object obj, Isolate* isolate) {
isolate->heap()->CollectGarbage(OLD_SPACE, GarbageCollectionReason::kTesting);
return obj;
}
Managed<Smi> CauseGCManaged(int i, Isolate* isolate) {
isolate->heap()->CollectGarbage(OLD_SPACE, GarbageCollectionReason::kTesting);
return Managed<Smi>::cast(Smi::FromInt(i));
}
void TwoArgumentsFunction(Object a, Object b) {
a.Print();
b.Print();
}
void TestTwoArguments(Isolate* isolate) {
Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
Handle<JSObject> obj2 = isolate->factory()->NewJSObjectWithNullProto();
// Should cause warning.
TwoArgumentsFunction(*CauseGC(obj1, isolate), *CauseGC(obj2, isolate));
}
void TwoSizeTArgumentsFunction(size_t a, size_t b) {
USE(a);
USE(b);
}
void TestTwoSizeTArguments(Isolate* isolate) {
Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
Handle<JSObject> obj2 = isolate->factory()->NewJSObjectWithNullProto();
// Should cause warning.
TwoSizeTArgumentsFunction(sizeof(*CauseGC(obj1, isolate)),
sizeof(*CauseGC(obj2, isolate)));
}
// --------- Test problems with method arguments ----------
class SomeObject : public Object {
public:
void Method(Object a) { a.Print(); }
SomeObject& operator=(const Object& b) {
this->Print();
return *this;
}
DECL_CAST(SomeObject)
OBJECT_CONSTRUCTORS(SomeObject, Object);
};
void TestMethodCall(Isolate* isolate) {
SomeObject obj;
Handle<SomeObject> so = handle(obj, isolate);
Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
// Should cause warning.
so->Method(*CauseGC(obj1, isolate));
// Should cause warning.
so->Method(CauseGCRaw(*obj1, isolate));
}
void TestOperatorCall(Isolate* isolate) {
SomeObject obj;
Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
// Should not cause warning.
obj = *CauseGC(obj1, isolate);
}
// --------- Test for templated sub-classes of Object ----------
void TestFollowingTemplates(Isolate* isolate) {
// Should cause warning.
CauseGCManaged(42, isolate);
}
// --------- Test for correctly resolving virtual methods ----------
class BaseObject {
public:
virtual Handle<Object> VirtualCauseGC(Handle<Object> obj, Isolate* isolate) {
return obj;
}
};
class DerivedObject : public BaseObject {
public:
Handle<Object> VirtualCauseGC(Handle<Object> obj, Isolate* isolate) override {
isolate->heap()->CollectGarbage(OLD_SPACE,
GarbageCollectionReason::kTesting);
return obj;
}
};
void TestFollowingVirtualFunctions(Isolate* isolate) {
DerivedObject derived;
BaseObject* base = &derived;
Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
SomeObject so;
Handle<SomeObject> so_handle = handle(so, isolate);
// Should cause warning.
so_handle->Method(*derived.VirtualCauseGC(obj1, isolate));
// Should cause warning.
so_handle->Method(*base->VirtualCauseGC(obj1, isolate));
}
// --------- Test for correctly resolving static methods ----------
class SomeClass {
public:
static Handle<Object> StaticCauseGC(Handle<Object> obj, Isolate* isolate) {
isolate->heap()->CollectGarbage(OLD_SPACE,
GarbageCollectionReason::kTesting);
return obj;
}
};
void TestFollowingStaticFunctions(Isolate* isolate) {
SomeObject so;
Handle<SomeObject> so_handle = handle(so, isolate);
Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
// Should cause warning.
so_handle->Method(*SomeClass::StaticCauseGC(obj1, isolate));
}
// --------- Test basic dead variable analysis ----------
void TestDeadVarAnalysis(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
CauseGCRaw(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestDeadVarBecauseOfSafepointAnalysis(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
Safepoint();
// Should cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysis(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// Note: having DisableGCMole with the same function as CauseGC
// normally doesn't make sense, but we want to test whether the guards
// are recognized by GCMole.
DisableGCMole no_gc_mole;
CauseGCRaw(raw_obj, isolate);
// Shouldn't cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysis2(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// Note: having DisallowGarbageCollection with the same function as CauseGC
// normally doesn't make sense, but we want to test whether the guards
// are recognized by GCMole.
DisallowGarbageCollection no_gc;
CauseGCRaw(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestGuardedAgainstSafepointDeadVarAnalysis(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// Note: having DisableGCMole with the same function as CauseGC
// normally doesn't make sense, but we want to test whether the guards
// are recognized by GCMole.
DisableGCMole no_gc_mole;
Safepoint();
// Shouldn't cause warning.
raw_obj.Print();
}
void TestGuardedAgainstSafepointDeadVarAnalysis2(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// Note: having DisallowGarbageCollection with the same function as CauseGC
// normally doesn't make sense, but we want to test whether the guards
// are recognized by GCMole.
DisallowGarbageCollection no_gc;
Safepoint();
// Should cause warning.
raw_obj.Print();
}
void TestGuardedAgainstSafepointDeadVarAnalysis3(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// Note: having DisallowGarbageCollection with the same function as CauseGC
// normally doesn't make sense, but we want to test whether the guards
// are recognized by GCMole.
DisallowGarbageCollection no_gc;
Safepoint();
// Should cause warning.
raw_obj.Print();
{
DisableGCMole no_gc_mole;
// Shouldn't cause warning.
raw_obj.Print();
}
// Should cause warning.
raw_obj.Print();
}
void TestOnlyHeapGuardedDeadVarAnalysisInCompound(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// {DisallowHeapAccess} has a {DisallowHeapAllocation}, but no
// {DisallowSafepoints}, so it could see objects move due to safepoints.
DisallowHeapAccess no_gc;
CauseGCRaw(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestOnlyHeapGuardedDeadVarAnalysisInCompound2(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
// {DisallowHeapAccess} has a {DisallowHeapAllocation}, but no
// {DisallowSafepoints}, so it could see objects move due to safepoints.
DisallowHeapAccess no_gc;
CauseGCRaw(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
DisableGCMole no_gc_mole;
// Should cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysisNested(JSObject raw_obj, Isolate* isolate) {
CauseGCRaw(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysisCaller(Isolate* isolate) {
DisableGCMole no_gc_mole;
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
TestGuardedDeadVarAnalysisNested(raw_obj, isolate);
// Shouldn't cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysisCaller2(Isolate* isolate) {
DisallowGarbageCollection no_gc;
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
TestGuardedDeadVarAnalysisNested(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysisCaller3(Isolate* isolate) {
DisallowHeapAccess no_gc;
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
TestGuardedDeadVarAnalysisNested(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysisCaller4(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
TestGuardedDeadVarAnalysisNested(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
JSObject GuardedAllocation(Isolate* isolate) {
DisallowGarbageCollection no_gc;
return *isolate->factory()->NewJSObjectWithNullProto();
}
JSObject GuardedAllocation2(Isolate* isolate) {
DisableGCMole no_gc_mole;
return *isolate->factory()->NewJSObjectWithNullProto();
}
void TestNestedDeadVarAnalysis(Isolate* isolate) {
JSObject raw_obj = GuardedAllocation(isolate);
CauseGCRaw(raw_obj, isolate);
// Should cause warning.
raw_obj.Print();
}
void TestNestedDeadVarAnalysis2(Isolate* isolate) {
DisableGCMole no_gc_mole;
JSObject raw_obj = GuardedAllocation(isolate);
CauseGCRaw(raw_obj, isolate);
// Shouldn't cause warning.
raw_obj.Print();
}
// Test that putting a guard in the middle of the function doesn't
// mistakenly cover the whole scope of the raw variable.
void TestGuardedDeadVarAnalysisMidFunction(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
CauseGCRaw(raw_obj, isolate);
// Guarding the rest of the function from triggering a GC.
DisallowGarbageCollection no_gc;
// Should cause warning.
raw_obj.Print();
}
// Test that putting a guard in the middle of the function doesn't
// mistakenly cover the whole scope of the raw variable.
void TestGuardedDeadVarAnalysisMidFunction2(Isolate* isolate) {
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
CauseGCRaw(raw_obj, isolate);
// Guarding the rest of the function from triggering a GC.
DisableGCMole no_gc_mole;
// Should cause warning.
raw_obj.Print();
}
void TestGuardedDeadVarAnalysisMultipleSafepoints(Isolate* isolate) {
// TODO(https://crbug.com/v8/13536): The analysis points to this safepoint,
// while it should point to the one below.
Safepoint();
JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
DisallowGarbageCollection no_gc;
Safepoint();
raw_obj.Print();
}
} // namespace internal
} // namespace v8