#include <heap-statistics.h>

Collaboration diagram for cppgc::HeapStatistics:

Classes
struct	FreeListStatistics

struct	ObjectStatsEntry

struct	PageStatistics

struct	SpaceStatistics

Public Types
enum	DetailLevel : uint8_t { kBrief , kDetailed }

Public Attributes
size_t	committed_size_bytes = 0

size_t	resident_size_bytes = 0

size_t	used_size_bytes = 0

size_t	pooled_memory_size_bytes = 0

DetailLevel	detail_level

std::vector< SpaceStatistics >	space_stats

std::vector< std::string >	type_names

Detailed Description

HeapStatistics contains memory consumption and utilization statistics for a cppgc heap.

Member Enumeration Documentation

◆ DetailLevel

enum cppgc::HeapStatistics::DetailLevel : uint8_t

Specifies the detail level of the heap statistics. Brief statistics contain only the top-level allocated and used memory statistics for the entire heap. Detailed statistics also contain a break down per space and page, as well as freelist statistics and object type histograms. Note that used memory reported by brief statistics and detailed statistics might differ slightly.

Enumerator
kBrief
kDetailed

Member Data Documentation

◆ committed_size_bytes

size_t cppgc::HeapStatistics::committed_size_bytes = 0

Overall committed amount of memory for the heap.

◆ detail_level

DetailLevel cppgc::HeapStatistics::detail_level

Detail level of this HeapStatistics.

◆ pooled_memory_size_bytes

size_t cppgc::HeapStatistics::pooled_memory_size_bytes = 0

Memory retained in the page pool, not used directly by the heap.

◆ resident_size_bytes

size_t cppgc::HeapStatistics::resident_size_bytes = 0

Resident amount of memory held by the heap.

◆ space_stats

std::vector<SpaceStatistics> cppgc::HeapStatistics::space_stats

Statistics for each of the spaces in the heap. Filled only when detail_level is DetailLevel::kDetailed.

◆ type_names

std::vector<std::string> cppgc::HeapStatistics::type_names

Vector of cppgc::GarbageCollected type names.

◆ used_size_bytes

size_t cppgc::HeapStatistics::used_size_bytes = 0

Amount of memory actually used on the heap.

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

include/cppgc/heap-statistics.h

Classes

Public Types

Public Attributes