Struct JavaHprofConfig

pub struct JavaHprofConfig {
    pub process_cmdline: Vec<String>,
    pub pid: Vec<u64>,
    pub target_installed_by: Vec<String>,
    pub continuous_dump_config: Option<ContinuousDumpConfig>,
    pub min_anonymous_memory_kb: Option<u32>,
    pub dump_smaps: Option<bool>,
    pub ignored_types: Vec<String>,
}

Configuration for managed app heap graph snapshots.

Fields

process_cmdline: Vec<String>

Command line allowlist, matched against the /proc//cmdline (not the comm string). The semantics of this field were changed since its original introduction.

On Android T+ (13+), this field can specify a single wildcard (*), and the profiler will attempt to match it in two possible ways:

• if the pattern starts with a ‘/’, then it is matched against the first segment of the cmdline (i.e. argv0). For example “/bin/e*” would match “/bin/echo”.
• otherwise the pattern is matched against the part of argv0 corresponding to the binary name (this is unrelated to /proc/pid/exe). For example “echo” would match “/bin/echo”.

On Android S (12) and below, both this pattern and /proc/pid/cmdline get normalized prior to an exact string comparison. Normalization is as follows: (1) trim everything beyond the first null or “@” byte; (2) if the string contains forward slashes, trim everything up to and including the last one.

Implementation note: in either case, at most 511 characters of cmdline are considered.

pid: Vec<u64>

For watermark based triggering or local debugging.

target_installed_by: Vec<String>

Only profile target if it was installed by one of the packages given. Special values are:

• @system: installed on the system partition
• @product: installed on the product partition
• @null: sideloaded Supported on Android 12+.

continuous_dump_config: Option<ContinuousDumpConfig>

Dump at a predefined interval.

min_anonymous_memory_kb: Option<u32>

Do not profile processes whose anon RSS + swap < given value.

dump_smaps: Option<bool>

Include the process’ /proc/self/smaps. This only shows maps that:

• start with /system
• start with /vendor
• start with /data/app
• contain “extracted in memory from Y”, where Y matches any of the above

ignored_types: Vec<String>

Exclude objects of the following types from the profile. This can be useful if lots of uninteresting objects, e.g. “sun.misc.Cleaner”.

Implementations

impl JavaHprofConfig

pub fn min_anonymous_memory_kb(&self) -> u32

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

pub fn dump_smaps(&self) -> bool

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

Trait Implementations

impl Clone for JavaHprofConfig

fn clone(&self) -> JavaHprofConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JavaHprofConfig

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

Formats the value using the given formatter.

impl Default for JavaHprofConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for JavaHprofConfig

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 JavaHprofConfig

fn eq(&self, other: &JavaHprofConfig) -> 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 JavaHprofConfig