Struct ProfilePacket

pub struct ProfilePacket {
    pub strings: Vec<InternedString>,
    pub mappings: Vec<Mapping>,
    pub frames: Vec<Frame>,
    pub callstacks: Vec<Callstack>,
    pub process_dumps: Vec<ProcessHeapSamples>,
    pub continued: Option<bool>,
    pub index: Option<u64>,
}

The packet emitted by heapprofd for each heap snapshot. A snapshot can involve more than one ProfilePacket if the snapshot is big (when |continued| is true). The cardinality and grouping is as follows: A ProfilePacket contains:

• 1+ per-process heap snapshots (ProcessHeapSamples). Normally there is only one heap per process (the main malloc/free heap), but there can be more if the process is using the heapprofd API to profile custom allocators.
• Globally interned strings, mappings and frames (to allow de-duplicating frames/mapping in common between different processes). A ProcessHeapSamples contains:
• The process and heap identifier.
• A number of HeapSample, one for each callsite that had some alloc/frees.
• Statistics about heapprofd internals (e.g., sampling/unwinding timings). A HeapSample contains statistics about callsites:
• Total number of bytes allocated and freed from that callsite.
• Total number of alloc/free calls sampled.
• Stats at the local maximum when dump_at_max = true. See https://perfetto.dev/docs/data-sources/native-heap-profiler for more.

Fields

strings: Vec<InternedString>

The following interning tables are only used in Android version Q. In newer versions, these tables are in InternedData (see protos/perfetto/trace/interned_data) and are shared across multiple ProfilePackets. For backwards compatibility, consumers need to first look up interned data in the tables within the ProfilePacket, and then, if they are empty, look up in the InternedData instead.

mappings: Vec<Mapping>

frames: Vec<Frame>

callstacks: Vec<Callstack>

process_dumps: Vec<ProcessHeapSamples>

continued: Option<bool>

If this is true, the next ProfilePacket in this package_sequence_id is a continuation of this one. To get all samples for a process, accummulate its ProcessHeapSamples.samples until you see continued=false.

index: Option<u64>

Index of this ProfilePacket on its package_sequence_id. Can be used to detect dropped data. Verify these are consecutive.

Implementations

impl ProfilePacket

pub fn continued(&self) -> bool

Returns the value of continued, or the default value if continued is unset.

pub fn index(&self) -> u64

Returns the value of index, or the default value if index is unset.

Trait Implementations

impl Clone for ProfilePacket

fn clone(&self) -> ProfilePacket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProfilePacket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProfilePacket

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProfilePacket

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ProfilePacket

fn eq(&self, other: &ProfilePacket) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProfilePacket