cppgc::subtle::HeapState Class Reference

#include <heap-state.h>

Static Public Member Functions
static bool	IsMarking (const HeapHandle &heap_handle)
static bool	IsSweeping (const HeapHandle &heap_handle)
static bool	IsSweepingOnOwningThread (const HeapHandle &heap_handle)
static bool	IsInAtomicPause (const HeapHandle &heap_handle)
static bool	PreviousGCWasConservative (const HeapHandle &heap_handle)

Detailed Description

Helpers to peek into heap-internal state.

Member Function Documentation

IsInAtomicPause()

static bool cppgc::subtle::HeapState::IsInAtomicPause ( const HeapHandle &  heap_handle )

static

Returns whether the garbage collector is in the atomic pause, i.e., the mutator is stopped from running. This API is experimental and is expected to be removed in future.

Parameters

heap_handle

The corresponding heap.

Returns

true if the garbage collector is currently in the atomic pause, and false otherwise.

IsMarking()

static bool cppgc::subtle::HeapState::IsMarking ( const HeapHandle &  heap_handle )

static

Returns whether the garbage collector is marking. This API is experimental and is expected to be removed in future.

Parameters

heap_handle

The corresponding heap.

Returns

true if the garbage collector is currently marking, and false otherwise.

IsSweeping()

static bool cppgc::subtle::HeapState::IsSweeping ( const HeapHandle &  heap_handle )

static

IsSweepingOnOwningThread()

static bool cppgc::subtle::HeapState::IsSweepingOnOwningThread ( const HeapHandle &  heap_handle )

static

PreviousGCWasConservative()

static bool cppgc::subtle::HeapState::PreviousGCWasConservative ( const HeapHandle &  heap_handle )

static

Returns whether the last garbage collection was finalized conservatively (i.e., with a non-empty stack). This API is experimental and is expected to be removed in future.

Parameters

heap_handle

The corresponding heap.

Returns

true if the last garbage collection was finalized conservatively, and false otherwise.

---

The documentation for this class was generated from the following file:

• include/cppgc/heap-state.h