v8::HeapSnapshot Class Reference

HeapSnapshots record the state of the JS heap at some moment. More...

#include <v8-profiler.h>

Collaboration diagram for v8::HeapSnapshot:

Public Types
enum	SerializationFormat { kJSON = 0 }

Public Member Functions
unsigned	GetUid () const
	Returns heap snapshot UID (assigned by the profiler.) More...
Handle< String >	GetTitle () const
	Returns heap snapshot title. More...
const HeapGraphNode *	GetRoot () const
	Returns the root node of the heap graph. More...
const HeapGraphNode *	GetNodeById (SnapshotObjectId id) const
	Returns a node by its id. More...
int	GetNodesCount () const
	Returns total nodes count in the snapshot. More...
const HeapGraphNode *	GetNode (int index) const
	Returns a node by index. More...
SnapshotObjectId	GetMaxSnapshotJSObjectId () const
	Returns a max seen JS object Id. More...
void	Delete ()
	Deletes the snapshot and removes it from HeapProfiler's list. More...
void	Serialize (OutputStream *stream, SerializationFormat format) const
	Prepare a serialized representation of the snapshot. More...

Detailed Description

HeapSnapshots record the state of the JS heap at some moment.

Definition at line 303 of file v8-profiler.h.

Member Enumeration Documentation

SerializationFormat

enum v8::HeapSnapshot::SerializationFormat

Enumerator
kJSON

Definition at line 305 of file v8-profiler.h.

                           {
    kJSON = 0  // See format description near 'Serialize' method.
  };

Member Function Documentation

Delete()

void v8::HeapSnapshot::Delete

(

)

Deletes the snapshot and removes it from HeapProfiler's list.

All pointers to nodes, edges and paths previously returned become invalid.

Definition at line 7309 of file api.cc.

                          {
  i::Isolate* isolate = i::Isolate::Current();
  if (isolate->heap_profiler()->GetSnapshotsCount() > 1) {
    ToInternal(this)->Delete();
  } else {
    // If this is the last snapshot, clean up all accessory data as well.
    isolate->heap_profiler()->DeleteAllSnapshots();
  }
}

References v8::internal::HeapProfiler::DeleteAllSnapshots(), v8::internal::HeapProfiler::GetSnapshotsCount(), v8::internal::Isolate::heap_profiler(), and v8::ToInternal().

Here is the call graph for this function:

GetMaxSnapshotJSObjectId()

SnapshotObjectId v8::HeapSnapshot::GetMaxSnapshotJSObjectId

(

)

const

Returns a max seen JS object Id.

Definition at line 7354 of file api.cc.

                                                              {
  return ToInternal(this)->max_snapshot_js_object_id();
}

References v8::ToInternal().

Here is the call graph for this function:

GetNode()

const HeapGraphNode * v8::HeapSnapshot::GetNode

(

int

index

)

const

Returns a node by index.

Definition at line 7348 of file api.cc.

                                                          {
  return reinterpret_cast<const HeapGraphNode*>(
      &ToInternal(this)->entries().at(index));
}

References v8::ToInternal().

Here is the call graph for this function:

GetNodeById()

const HeapGraphNode * v8::HeapSnapshot::GetNodeById

(

SnapshotObjectId

id

)

const

Returns a node by its id.

Definition at line 7337 of file api.cc.

                                                                        {
  return reinterpret_cast<const HeapGraphNode*>(
      ToInternal(this)->GetEntryById(id));
}

References v8::ToInternal().

Here is the call graph for this function:

GetNodesCount()

int v8::HeapSnapshot::GetNodesCount

(

)

const

Returns total nodes count in the snapshot.

Definition at line 7343 of file api.cc.

                                      {
  return ToInternal(this)->entries().length();
}

References v8::ToInternal().

Here is the call graph for this function:

GetRoot()

const HeapGraphNode * v8::HeapSnapshot::GetRoot

(

)

const

Returns the root node of the heap graph.

Definition at line 7332 of file api.cc.

                                                 {
  return reinterpret_cast<const HeapGraphNode*>(ToInternal(this)->root());
}

References v8::ToInternal().

Here is the call graph for this function:

GetTitle()

Handle< String > v8::HeapSnapshot::GetTitle

(

)

const

Returns heap snapshot title.

Definition at line 7325 of file api.cc.

                                            {
  i::Isolate* isolate = i::Isolate::Current();
  return ToApiHandle<String>(
      isolate->factory()->InternalizeUtf8String(ToInternal(this)->title()));
}

References v8::internal::Isolate::factory(), and v8::ToInternal().

Here is the call graph for this function:

GetUid()

unsigned v8::HeapSnapshot::GetUid

(

)

const

Returns heap snapshot UID (assigned by the profiler.)

Definition at line 7320 of file api.cc.

                                    {
  return ToInternal(this)->uid();
}

References v8::ToInternal().

Here is the call graph for this function:

Serialize()

void v8::HeapSnapshot::Serialize	(	OutputStream *	stream,
		HeapSnapshot::SerializationFormat	format
	)		const

Prepare a serialized representation of the snapshot.

The result is written into the stream provided in chunks of specified size. The total length of the serialized snapshot is unknown in advance, it can be roughly equal to JS heap size (that means, it can be really big - tens of megabytes).

For the JSON format, heap contents are represented as an object with the following structure:

{ snapshot: { title: "...", uid: nnn, meta: { meta-info }, node_count: nnn, edge_count: nnn }, nodes: [nodes array], edges: [edges array], strings: [strings array] }

Nodes reference strings, other nodes, and edges by their indexes in corresponding arrays.

Definition at line 7359 of file api.cc.

                                                                           {
  Utils::ApiCheck(format == kJSON,
                  "v8::HeapSnapshot::Serialize",
                  "Unknown serialization format");
  Utils::ApiCheck(stream->GetChunkSize() > 0,
                  "v8::HeapSnapshot::Serialize",
                  "Invalid stream chunk size");
  i::HeapSnapshotJSONSerializer serializer(ToInternal(this));
  serializer.Serialize(stream);
}

References v8::Utils::ApiCheck(), v8::OutputStream::GetChunkSize(), v8::internal::HeapSnapshotJSONSerializer::Serialize(), and v8::ToInternal().

Here is the call graph for this function:

---

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

• /mnt/V8SourceCode/include/v8-profiler.h
• /mnt/V8SourceCode/src/api.cc