gcmole-test.cc 10.5 KB
Newer Older
1 2 3 4
// 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.

5
#include "src/execution/isolate.h"
6 7
#include "src/handles/handles-inl.h"
#include "src/handles/handles.h"
8
#include "src/heap/local-heap.h"
9 10
#include "src/objects/foreign-inl.h"
#include "src/objects/managed.h"
11 12 13 14 15 16
#include "src/objects/maybe-object.h"
#include "src/objects/object-macros.h"

namespace v8 {
namespace internal {

17 18
// ------- Test simple argument evaluation order problems ---------

19 20
void Safepoint() { LocalHeap::Current()->Safepoint(); }

21 22 23 24 25 26
Handle<Object> CauseGC(Handle<Object> obj, Isolate* isolate) {
  isolate->heap()->CollectGarbage(OLD_SPACE, GarbageCollectionReason::kTesting);

  return obj;
}

27 28 29 30 31 32 33 34 35 36 37 38
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));
}

39
void TwoArgumentsFunction(Object a, Object b) {
40 41
  a.Print();
  b.Print();
42 43 44 45 46
}

void TestTwoArguments(Isolate* isolate) {
  Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
  Handle<JSObject> obj2 = isolate->factory()->NewJSObjectWithNullProto();
47
  // Should cause warning.
48 49 50 51 52 53 54 55 56 57 58
  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();
59
  // Should cause warning.
60 61 62 63
  TwoSizeTArgumentsFunction(sizeof(*CauseGC(obj1, isolate)),
                            sizeof(*CauseGC(obj2, isolate)));
}

64 65
// --------- Test problems with method arguments ----------

66 67
class SomeObject : public Object {
 public:
68
  void Method(Object a) { a.Print(); }
69

70 71 72 73 74
  SomeObject& operator=(const Object& b) {
    this->Print();
    return *this;
  }

75 76 77 78 79 80 81 82 83
  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();
84
  // Should cause warning.
85
  so->Method(*CauseGC(obj1, isolate));
86 87
  // Should cause warning.
  so->Method(CauseGCRaw(*obj1, isolate));
88 89
}

90 91 92
void TestOperatorCall(Isolate* isolate) {
  SomeObject obj;
  Handle<JSObject> obj1 = isolate->factory()->NewJSObjectWithNullProto();
93
  // Should not cause warning.
94 95 96
  obj = *CauseGC(obj1, isolate);
}

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
// --------- 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));
}

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
// --------- 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();
}

167 168 169 170 171 172 173 174
void TestDeadVarBecauseOfSafepointAnalysis(Isolate* isolate) {
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
  Safepoint();

  // Should cause warning.
  raw_obj.Print();
}

175 176 177
void TestGuardedDeadVarAnalysis(Isolate* isolate) {
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();

178 179 180 181 182 183 184 185 186 187 188 189 190
  // 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();

191
  // Note: having DisallowGarbageCollection with the same function as CauseGC
192
  // normally doesn't make sense, but we want to test whether the guards
193
  // are recognized by GCMole.
194
  DisallowGarbageCollection no_gc;
195 196
  CauseGCRaw(raw_obj, isolate);

197
  // Should cause warning.
198 199 200
  raw_obj.Print();
}

201 202 203
void TestGuardedAgainstSafepointDeadVarAnalysis(Isolate* isolate) {
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();

204 205 206 207 208 209 210 211 212 213 214 215 216
  // 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();

217
  // Note: having DisallowGarbageCollection with the same function as CauseGC
218
  // normally doesn't make sense, but we want to test whether the guards
219 220 221 222
  // are recognized by GCMole.
  DisallowGarbageCollection no_gc;
  Safepoint();

223
  // Should cause warning.
224 225 226
  raw_obj.Print();
}

227
void TestGuardedAgainstSafepointDeadVarAnalysis3(Isolate* isolate) {
228
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  // 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();
}
244

245 246
void TestOnlyHeapGuardedDeadVarAnalysisInCompound(Isolate* isolate) {
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
247 248
  // {DisallowHeapAccess} has a {DisallowHeapAllocation}, but no
  // {DisallowSafepoints}, so it could see objects move due to safepoints.
249 250
  DisallowHeapAccess no_gc;
  CauseGCRaw(raw_obj, isolate);
251 252 253
  // Should cause warning.
  raw_obj.Print();
}
254

255 256 257 258 259 260 261 262 263
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;
264
  // Should cause warning.
265 266 267 268 269
  raw_obj.Print();
}

void TestGuardedDeadVarAnalysisNested(JSObject raw_obj, Isolate* isolate) {
  CauseGCRaw(raw_obj, isolate);
270
  // Should cause warning.
271 272 273 274
  raw_obj.Print();
}

void TestGuardedDeadVarAnalysisCaller(Isolate* isolate) {
275
  DisableGCMole no_gc_mole;
276
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
277 278 279 280 281 282 283 284 285 286 287 288
  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();
}
289

290 291 292
void TestGuardedDeadVarAnalysisCaller3(Isolate* isolate) {
  DisallowHeapAccess no_gc;
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
293
  TestGuardedDeadVarAnalysisNested(raw_obj, isolate);
294 295 296
  // Should cause warning.
  raw_obj.Print();
}
297

298 299 300 301
void TestGuardedDeadVarAnalysisCaller4(Isolate* isolate) {
  JSObject raw_obj = *isolate->factory()->NewJSObjectWithNullProto();
  TestGuardedDeadVarAnalysisNested(raw_obj, isolate);
  // Should cause warning.
302
  raw_obj.Print();
303 304 305
}

JSObject GuardedAllocation(Isolate* isolate) {
306
  DisallowGarbageCollection no_gc;
307 308 309
  return *isolate->factory()->NewJSObjectWithNullProto();
}

310 311 312 313 314
JSObject GuardedAllocation2(Isolate* isolate) {
  DisableGCMole no_gc_mole;
  return *isolate->factory()->NewJSObjectWithNullProto();
}

315 316 317 318 319 320 321
void TestNestedDeadVarAnalysis(Isolate* isolate) {
  JSObject raw_obj = GuardedAllocation(isolate);
  CauseGCRaw(raw_obj, isolate);
  // Should cause warning.
  raw_obj.Print();
}

322 323 324 325 326 327 328 329
void TestNestedDeadVarAnalysis2(Isolate* isolate) {
  DisableGCMole no_gc_mole;
  JSObject raw_obj = GuardedAllocation(isolate);
  CauseGCRaw(raw_obj, isolate);
  // Shouldn't cause warning.
  raw_obj.Print();
}

330 331 332 333 334 335
// 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.
336
  DisallowGarbageCollection no_gc;
337 338 339 340
  // Should cause warning.
  raw_obj.Print();
}

341 342 343 344 345 346 347 348 349 350 351
// 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();
}

352 353
}  // namespace internal
}  // namespace v8