cppgc Namespace Reference

Namespaces
	internal
	subtle
	testing

Data Structures
struct	AdditionalBytes
class	CustomSpace
class	CustomSpaceBase
struct	CustomSpaceIndex
class	DefaultPlatform
struct	EphemeronPair
class	GarbageCollected
class	GarbageCollectedMixin
class	Heap
struct	HeapStatistics
class	LivenessBroker
class	MakeGarbageCollectedTrait
class	MakeGarbageCollectedTraitBase
class	NameProvider
class	Platform
struct	PostConstructionCallbackTrait
class	ProcessHeapStatistics
class	SourceLocation
struct	SpaceTrait
struct	TraceDescriptor
struct	TraceTrait
struct	TraceTrait< Member< T > >
struct	TraceTrait< v8::TracedReference< T > >
class	Visitor

Typedefs
template<typename T >
using	Member = internal::BasicMember< T, internal::StrongMemberTag, internal::DijkstraWriteBarrierPolicy >
template<typename T >
using	WeakMember = internal::BasicMember< T, internal::WeakMemberTag, internal::DijkstraWriteBarrierPolicy >
template<typename T >
using	UntracedMember = internal::BasicMember< T, internal::UntracedMemberTag, internal::NoWriteBarrierPolicy >
template<typename T >
using	Persistent = internal::BasicPersistent< T, internal::StrongPersistentPolicy >
template<typename T >
using	WeakPersistent = internal::BasicPersistent< T, internal::WeakPersistentPolicy >
using	IdleTask = v8::IdleTask
using	JobHandle = v8::JobHandle
using	JobDelegate = v8::JobDelegate
using	JobTask = v8::JobTask
using	PageAllocator = v8::PageAllocator
using	Task = v8::Task
using	TaskPriority = v8::TaskPriority
using	TaskRunner = v8::TaskRunner
using	TracingController = v8::TracingController
using	TraceCallback = void(*)(Visitor *visitor, const void *object)
using	WeakCallback = void(*)(const LivenessBroker &, const void *)

Enumerations
enum	EmbedderStackState { kMayContainHeapPointers, kNoHeapPointers }

Functions
template<typename T , typename... Args>
T *	MakeGarbageCollected (AllocationHandle &handle, Args &&... args)
template<typename T , typename... Args>
T *	MakeGarbageCollected (AllocationHandle &handle, AdditionalBytes additional_bytes, Args &&... args)
V8_EXPORT void	InitializeProcess (PageAllocator *page_allocator)
V8_EXPORT void	ShutdownProcess ()

Variables
constexpr internal::SentinelPointer	kSentinelPointer
template<typename T >
constexpr bool	IsGarbageCollectedMixinTypeV
template<typename T >
constexpr bool	IsGarbageCollectedTypeV
template<typename T >
constexpr bool	IsGarbageCollectedOrMixinTypeV
template<typename T >
constexpr bool	IsGarbageCollectedWithMixinTypeV
template<typename T >
constexpr bool	IsMemberTypeV = internal::IsMemberType<T>::value
template<typename T >
constexpr bool	IsUntracedMemberTypeV = internal::IsUntracedMemberType<T>::value
template<typename T >
constexpr bool	IsWeakMemberTypeV = internal::IsWeakMemberType<T>::value
template<typename T >
constexpr bool	IsWeakV = internal::IsWeak<T>::value

Detailed Description

cppgc - A C++ garbage collection library.

Typedef Documentation

IdleTask

using IdleTask = v8::IdleTask

Definition at line 15 of file platform.h.

JobDelegate

using JobDelegate = v8::JobDelegate

Definition at line 17 of file platform.h.

JobHandle

using JobHandle = v8::JobHandle

Definition at line 16 of file platform.h.

JobTask

using JobTask = v8::JobTask

Definition at line 18 of file platform.h.

Member

using Member = internal::BasicMember<T, internal::StrongMemberTag, internal::DijkstraWriteBarrierPolicy>

Members are used in classes to contain strong pointers to other garbage collected objects. All Member fields of a class must be traced in the class' trace method.

Definition at line 245 of file member.h.

PageAllocator

using PageAllocator = v8::PageAllocator

Definition at line 19 of file platform.h.

Persistent

using Persistent = internal::BasicPersistent<T, internal::StrongPersistentPolicy>

Persistent is a way to create a strong pointer from an off-heap object to another on-heap object. As long as the Persistent handle is alive the GC will keep the object pointed to alive. The Persistent handle is always a GC root from the point of view of the GC. Persistent must be constructed and destructed in the same thread.

Definition at line 351 of file persistent.h.

Task

using Task = v8::Task

Definition at line 20 of file platform.h.

TaskPriority

using TaskPriority = v8::TaskPriority

Definition at line 21 of file platform.h.

TaskRunner

using TaskRunner = v8::TaskRunner

Definition at line 22 of file platform.h.

TraceCallback

using TraceCallback = void (*)(Visitor* visitor, const void* object)

Callback for invoking tracing on a given object.

Parameters

visitor	The visitor to dispatch to.
object	The object to invoke tracing on.

Definition at line 34 of file trace-trait.h.

TracingController

using TracingController = v8::TracingController

Definition at line 23 of file platform.h.

UntracedMember

using UntracedMember = internal::BasicMember<T, internal::UntracedMemberTag, internal::NoWriteBarrierPolicy>

UntracedMember is a pointer to an on-heap object that is not traced for some reason. Do not use this unless you know what you are doing. Keeping raw pointers to on-heap objects is prohibited unless used from stack. Pointee must be kept alive through other means.

Definition at line 267 of file member.h.

WeakCallback

using WeakCallback = void (*)(const LivenessBroker&, const void*)

Definition at line 33 of file visitor.h.

WeakMember

using WeakMember = internal::BasicMember<T, internal::WeakMemberTag, internal::DijkstraWriteBarrierPolicy>

WeakMember is similar to Member in that it is used to point to other garbage collected objects. However instead of creating a strong pointer to the object, the WeakMember creates a weak pointer, which does not keep the pointee alive. Hence if all pointers to to a heap allocated object are weak the object will be garbage collected. At the time of GC the weak pointers will automatically be set to null.

Definition at line 257 of file member.h.

WeakPersistent

using WeakPersistent = internal::BasicPersistent<T, internal::WeakPersistentPolicy>

WeakPersistent is a way to create a weak pointer from an off-heap object to an on-heap object. The pointer is automatically cleared when the pointee gets collected. WeakPersistent must be constructed and destructed in the same thread.

Definition at line 361 of file persistent.h.

Enumeration Type Documentation

EmbedderStackState

enum EmbedderStackState

strong

Indicator for the stack state of the embedder.

Enumerator
kMayContainHeapPointers	Stack may contain interesting heap pointers.
kNoHeapPointers	Stack does not contain any interesting heap pointers.

Definition at line 16 of file common.h.

Function Documentation

InitializeProcess()

V8_EXPORT void cppgc::InitializeProcess

(

PageAllocator *

page_allocator

)

Process-global initialization of the garbage collector. Must be called before creating a Heap.

Can be called multiple times when paired with ShutdownProcess().

Parameters

page_allocator

The allocator used for maintaining meta data. Must not change between multiple calls to InitializeProcess.

MakeGarbageCollected() [1/2]

T* cppgc::MakeGarbageCollected	(	AllocationHandle &	handle,
		AdditionalBytes	additional_bytes,
		Args &&...	args
	)

Constructs a managed object of type T where T transitively inherits from GarbageCollected. Created objects will have additional bytes appended to it. Allocated memory would suffice for sizeof(T) + additional_bytes.

Parameters

additional_bytes	Denotes how many bytes to append to T.
args	List of arguments with which an instance of T will be constructed.

Returns

an instance of type T.

Definition at line 219 of file allocation.h.

MakeGarbageCollected() [2/2]

T* cppgc::MakeGarbageCollected	(	AllocationHandle &	handle,
		Args &&...	args
	)

Constructs a managed object of type T where T transitively inherits from GarbageCollected.

Parameters

args	List of arguments with which an instance of T will be constructed.

Returns

an instance of type T.

Definition at line 201 of file allocation.h.

ShutdownProcess()

V8_EXPORT void cppgc::ShutdownProcess

(

)

Must be called after destroying the last used heap. Some process-global metadata may not be returned and reused upon a subsequent InitializeProcess() call.

Variable Documentation

IsGarbageCollectedMixinTypeV

constexpr bool IsGarbageCollectedMixinTypeV

constexpr

Initial value:

=
    internal::IsGarbageCollectedMixinType<T>::value

Value is true for types that inherit from GarbageCollectedMixin but not GarbageCollected<T> (i.e., they are free mixins), and false otherwise.

Definition at line 174 of file type-traits.h.

IsGarbageCollectedOrMixinTypeV

constexpr bool IsGarbageCollectedOrMixinTypeV

constexpr

Initial value:

=
    internal::IsGarbageCollectedOrMixinType<T>::value

Value is true for types that inherit from either GarbageCollected<T> or GarbageCollectedMixin, and false otherwise.

Definition at line 190 of file type-traits.h.

IsGarbageCollectedTypeV

constexpr bool IsGarbageCollectedTypeV

constexpr

Initial value:

=
    internal::IsGarbageCollectedType<T>::value

Value is true for types that inherit from GarbageCollected<T>, and false otherwise.

Definition at line 182 of file type-traits.h.

IsGarbageCollectedWithMixinTypeV

constexpr bool IsGarbageCollectedWithMixinTypeV

constexpr

Initial value:

=
    internal::IsGarbageCollectedWithMixinType<T>::value

Value is true for types that inherit from GarbageCollected<T> and GarbageCollectedMixin, and false otherwise.

Definition at line 198 of file type-traits.h.

IsMemberTypeV

constexpr bool IsMemberTypeV = internal::IsMemberType<T>::value

constexpr

Value is true for types of type Member<T>, and false otherwise.

Definition at line 205 of file type-traits.h.

IsUntracedMemberTypeV

constexpr bool IsUntracedMemberTypeV = internal::IsUntracedMemberType<T>::value

constexpr

Value is true for types of type UntracedMember<T>, and false otherwise.

Definition at line 211 of file type-traits.h.

IsWeakMemberTypeV

constexpr bool IsWeakMemberTypeV = internal::IsWeakMemberType<T>::value

constexpr

Value is true for types of type WeakMember<T>, and false otherwise.

Definition at line 217 of file type-traits.h.

IsWeakV

constexpr bool IsWeakV = internal::IsWeak<T>::value

constexpr

Value is true for types that are considered weak references, and false otherwise.

Definition at line 224 of file type-traits.h.

kSentinelPointer

constexpr internal::SentinelPointer kSentinelPointer

constexpr

Definition at line 28 of file sentinel-pointer.h.

Referenced by WriteBarrierTypeForNonCagedHeapPolicy::ValueModeDispatch< WriteBarrier::ValueMode::kValuePresent >::Get(), LivenessBroker::IsHeapObjectAlive(), Visitor::Trace(), and Visitor::TraceStrongly().