cppgc::subtle::HeapState Class Reference

#include <heap-state.h>

Collaboration diagram for cppgc::subtle::HeapState:

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)

Private Member Functions
	HeapState ()=delete

Detailed Description

Helpers to peek into heap-internal state.

Definition at line 19 of file heap-state.h.

Constructor & Destructor Documentation

HeapState()

cppgc::subtle::HeapState::HeapState ( )

privatedelete

Member Function Documentation

IsInAtomicPause()

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.

Definition at line 32 of file heap-state.cc.

Here is the call graph for this function:

IsMarking()

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.

Definition at line 13 of file heap-state.cc.

Here is the call graph for this function:

IsSweeping()

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

static

Definition at line 20 of file heap-state.cc.

Here is the call graph for this function:

IsSweepingOnOwningThread()

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

static

Definition at line 25 of file heap-state.cc.

Here is the call graph for this function:

PreviousGCWasConservative()

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.

Definition at line 37 of file heap-state.cc.

Here is the call graph for this function:

---

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

• include/cppgc/heap-state.h
• src/heap/cppgc/heap-state.cc