v8/test/unittests/heap/unified-heap-utils.h
Michael Lippautz 78ffd6e875 cppgc-js: Add WrapperDescriptor
WrapperDescriptor is used to describe how JS wrapper objects can be
inspected to find C++ wrappable objects. In addition, to specifying
which embedder fields are used to find type and instance, the
descriptor also provides and embedder id that identifies
garbage-collected objects. It is expected that the first field of the
type is a uint16_t with that id.

Bug: chromium:1056170
Change-Id: I9cf8d79db972f2dea023114fd5a567e89a3bf373
Reviewed-on: https://chromium-review.googlesource.com/c/v8/v8/+/2688399
Reviewed-by: Ulan Degenbaev <ulan@chromium.org>
Reviewed-by: Omer Katz <omerkatz@chromium.org>
Commit-Queue: Michael Lippautz <mlippautz@chromium.org>
Cr-Commit-Position: refs/heads/master@{#72657}
2021-02-11 13:28:27 +00:00

74 lines
2.6 KiB
C++

// Copyright 2020 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.
#ifndef V8_UNITTESTS_HEAP_UNIFIED_HEAP_UTILS_H_
#define V8_UNITTESTS_HEAP_UNIFIED_HEAP_UTILS_H_
#include "include/cppgc/heap.h"
#include "include/v8-cppgc.h"
#include "include/v8.h"
#include "test/unittests/heap/heap-utils.h"
namespace v8 {
class CppHeap;
namespace internal {
class CppHeap;
class UnifiedHeapTest : public TestWithHeapInternals {
public:
UnifiedHeapTest();
~UnifiedHeapTest() override = default;
void CollectGarbageWithEmbedderStack(cppgc::Heap::SweepingType sweeping_type =
cppgc::Heap::SweepingType::kAtomic);
void CollectGarbageWithoutEmbedderStack(
cppgc::Heap::SweepingType sweeping_type =
cppgc::Heap::SweepingType::kAtomic);
CppHeap& cpp_heap() const;
cppgc::AllocationHandle& allocation_handle();
private:
std::unique_ptr<v8::CppHeap> cpp_heap_;
};
class WrapperHelper {
public:
static constexpr size_t kWrappableTypeEmbedderIndex = 0;
static constexpr size_t kWrappableInstanceEmbedderIndex = 1;
// Id that identifies types that should be traced.
static constexpr uint16_t kTracedEmbedderId = uint16_t{0xA50F};
static constexpr WrapperDescriptor DefaultWrapperDescriptor() {
return WrapperDescriptor(kWrappableTypeEmbedderIndex,
kWrappableInstanceEmbedderIndex,
kTracedEmbedderId);
}
// Sets up a V8 API object so that it points back to a C++ object. The setup
// used is recognized by the GC and references will be followed for liveness
// analysis (marking) as well as tooling (snapshot).
static v8::Local<v8::Object> CreateWrapper(v8::Local<v8::Context> context,
void* wrappable_type,
void* wrappable_object,
const char* class_name = "");
// Resets the connection of a wrapper (JS) to its wrappable (C++), meaning
// that the wrappable object is not longer kept alive by the wrapper object.
static void ResetWrappableConnection(v8::Local<v8::Object> api_object);
// Sets up the connection of a wrapper (JS) to its wrappable (C++). Does not
// emit any possibly needed write barrier.
static void SetWrappableConnection(v8::Local<v8::Object> api_object, void*,
void*);
};
} // namespace internal
} // namespace v8
#endif // V8_UNITTESTS_HEAP_UNIFIED_HEAP_UTILS_H_