#include <v8-profiler.h>
Classes | |
| struct | HeapSnapshotOptions |
| class | ObjectNameResolver |
Public Types | |
| enum | SamplingFlags { kSamplingNoFlags = 0 , kSamplingForceGC = 1 << 0 , kSamplingIncludeObjectsCollectedByMajorGC = 1 << 1 , kSamplingIncludeObjectsCollectedByMinorGC = 1 << 2 } |
| enum class | HeapSnapshotMode { kRegular , kExposeInternals } |
| enum class | NumericsMode { kHideNumericValues , kExposeNumericValues } |
| typedef void(* | BuildEmbedderGraphCallback) (v8::Isolate *isolate, v8::EmbedderGraph *graph, void *data) |
| using | GetDetachednessCallback = EmbedderGraph::Node::Detachedness(*)(v8::Isolate *isolate, const v8::Local< v8::Value > &v8_value, uint16_t class_id, void *data) |
Static Public Attributes | |
| static const SnapshotObjectId | kUnknownObjectId = 0 |
| static const uint16_t | kPersistentHandleNoClassId = 0 |
Interface for controlling heap profiling. Instance of the profiler can be retrieved using v8::Isolate::GetHeapProfiler.
| typedef void(* v8::HeapProfiler::BuildEmbedderGraphCallback) (v8::Isolate *isolate, v8::EmbedderGraph *graph, void *data) |
Callback function invoked during heap snapshot generation to retrieve the embedder object graph. The callback should use graph->AddEdge(..) to add references between the objects. The callback must not trigger garbage collection in V8.
| using v8::HeapProfiler::GetDetachednessCallback = EmbedderGraph::Node::Detachedness (*)( v8::Isolate* isolate, const v8::Local<v8::Value>& v8_value, uint16_t class_id, void* data) |
Callback function invoked during heap snapshot generation to retrieve the detachedness state of a JS object referenced by a TracedReference.
The callback takes Local<Value> as parameter to allow the embedder to unpack the TracedReference into a Local and reuse that Local for different purposes.
|
strong |
|
strong |
| void v8::HeapProfiler::AddBuildEmbedderGraphCallback | ( | BuildEmbedderGraphCallback | callback, |
| void * | data | ||
| ) |
| void v8::HeapProfiler::ClearObjectIds | ( | ) |
Clears internal map from SnapshotObjectId to heap object. The new objects will not be added into it unless a heap snapshot is taken or heap object tracking is kicked off.
| const char * v8::HeapProfiler::CopyNameForHeapSnapshot | ( | const char * | name | ) |
Allocates a copy of the provided string within the heap snapshot generator and returns a pointer to the copy. May only be called during heap snapshot generation.
| void v8::HeapProfiler::DeleteAllHeapSnapshots | ( | ) |
Deletes all snapshots taken. All previously returned pointers to snapshots and their contents become invalid after this call.
| Local< Value > v8::HeapProfiler::FindObjectById | ( | SnapshotObjectId | id | ) |
Returns heap object with given SnapshotObjectId if the object is alive, otherwise empty handle is returned.
| AllocationProfile * v8::HeapProfiler::GetAllocationProfile | ( | ) |
Returns the sampled profile of allocations allocated (and still live) since StartSamplingHeapProfiler was called. The ownership of the pointer is transferred to the caller. Returns nullptr if sampling heap profiler is not active.
Obtains list of Detached JS Wrapper Objects. This functon calls garbage collection, then iterates over traced handles in the isolate
| const HeapSnapshot * v8::HeapProfiler::GetHeapSnapshot | ( | int | index | ) |
Returns a snapshot by index.
| SnapshotObjectId v8::HeapProfiler::GetHeapStats | ( | OutputStream * | stream, |
| int64_t * | timestamp_us = nullptr |
||
| ) |
Adds a new time interval entry to the aggregated statistics array. The time interval entry contains information on the current heap objects population size. The method also updates aggregated statistics and reports updates for all previous time intervals via the OutputStream object. Updates on each time interval are provided as a stream of the HeapStatsUpdate structure instances. If |timestamp_us| is supplied, timestamp of the new entry will be written into it. The return value of the function is the last seen heap object Id.
StartTrackingHeapObjects must be called before the first call to this method.
| SnapshotObjectId v8::HeapProfiler::GetObjectId | ( | Local< Value > | value | ) |
Returns SnapshotObjectId for a heap object referenced by |value| if it has been seen by the heap profiler, kUnknownObjectId otherwise.
| SnapshotObjectId v8::HeapProfiler::GetObjectId | ( | NativeObject | value | ) |
Returns SnapshotObjectId for a native object referenced by |value| if it has been seen by the heap profiler, kUnknownObjectId otherwise.
| int v8::HeapProfiler::GetSnapshotCount | ( | ) |
Returns the number of snapshots taken.
| bool v8::HeapProfiler::IsTakingSnapshot | ( | ) |
Returns whether the heap profiler is currently taking a snapshot.
| void v8::HeapProfiler::QueryObjects | ( | v8::Local< v8::Context > | context, |
| QueryObjectPredicate * | predicate, | ||
| std::vector< v8::Global< v8::Object > > * | objects | ||
| ) |
| void v8::HeapProfiler::RemoveBuildEmbedderGraphCallback | ( | BuildEmbedderGraphCallback | callback, |
| void * | data | ||
| ) |
| void v8::HeapProfiler::SetGetDetachednessCallback | ( | GetDetachednessCallback | callback, |
| void * | data | ||
| ) |
| bool v8::HeapProfiler::StartSamplingHeapProfiler | ( | uint64_t | sample_interval = 512 *1024, |
| int | stack_depth = 16, |
||
| SamplingFlags | flags = kSamplingNoFlags |
||
| ) |
Starts gathering a sampling heap profile. A sampling heap profile is similar to tcmalloc's heap profiler and Go's mprof. It samples object allocations and builds an online 'sampling' heap profile. At any point in time, this profile is expected to be a representative sample of objects currently live in the system. Each sampled allocation includes the stack trace at the time of allocation, which makes this really useful for memory leak detection.
This mechanism is intended to be cheap enough that it can be used in production with minimal performance overhead.
Allocations are sampled using a randomized Poisson process. On average, one allocation will be sampled every |sample_interval| bytes allocated. The |stack_depth| parameter controls the maximum number of stack frames to be captured on each allocation.
NOTE: Support for native allocations doesn't exist yet, but is anticipated in the future.
Objects allocated before the sampling is started will not be included in the profile.
Returns false if a sampling heap profiler is already running.
| void v8::HeapProfiler::StartTrackingHeapObjects | ( | bool | track_allocations = false | ) |
Starts tracking of heap objects population statistics. After calling this method, all heap objects relocations done by the garbage collector are being registered.
|track_allocations| parameter controls whether stack trace of each allocation in the heap will be recorded and reported as part of HeapSnapshot.
| void v8::HeapProfiler::StopSamplingHeapProfiler | ( | ) |
Stops the sampling heap profile and discards the current profile.
| void v8::HeapProfiler::StopTrackingHeapObjects | ( | ) |
Stops tracking of heap objects population statistics, cleans up all collected data. StartHeapObjectsTracking must be called again prior to calling GetHeapStats next time.
| const HeapSnapshot * v8::HeapProfiler::TakeHeapSnapshot | ( | ActivityControl * | control, |
| ObjectNameResolver * | global_object_name_resolver = nullptr, |
||
| bool | hide_internals = true, |
||
| bool | capture_numeric_value = false |
||
| ) |
Takes a heap snapshot. See HeapSnapshotOptions for details on the parameters.
| const HeapSnapshot * v8::HeapProfiler::TakeHeapSnapshot | ( | const HeapSnapshotOptions & | options = HeapSnapshotOptions() | ) |
Takes a heap snapshot.
|
static |
Default value of persistent handle class ID. Must not be used to define a class. Can be used to reset a class of a persistent handle.
|
static |
A constant for invalid SnapshotObjectId. GetSnapshotObjectId will return it in case heap profiler cannot find id for the object passed as parameter. HeapSnapshot::GetNodeById will always return NULL for such id.