Struct AndroidSdkSyspropGuardConfig

pub struct AndroidSdkSyspropGuardConfig {
    pub surfaceflinger_skia_track_events: Option<bool>,
    pub hwui_skia_track_events: Option<bool>,
    pub hwui_package_name_filter: Vec<String>,
}

Data source that controls the system properties used to guard initialization of track_event producers (i.e. Skia) in apps using HWUI, and certain processes like SurfaceFlinger.

This data source only tells Skia to initialized the Perfetto SDK and start routing data to the Track Event system instead of ATrace. For those events to actually show up in a trace, the track_event data source must be used as well. The Perfetto SDK cannot be de-initialized, so some long-lived apps and processes may need to be restarted for Skia to revert to using ATrace if Track Events are no longer desired.

In addition to switching Skia to use Perfetto’s track_event data source, this “guard” also controls Skia’s “broad tracing”, which removes Skia’s internal tracing constraints and allows the track_event config to specify which categories should be traced. Filtering to the “skia.always” category tag in a track_event config can be used to re-enable the standard constraints typically used with ATrace.

Data source name: android.sdk_sysprop_guard Introduced in Android 14 (U) QPR1. Next id: 4

Fields

surfaceflinger_skia_track_events: Option<bool>

If true, configures SurfaceFlinger to initialize Skia’s Perfetto integration with the track_event data source in RenderEngine. If false or omitted, the simpler ATrace fallback is used.

NOTE: once enabled, Skia will only revert to ATrace if SurfaceFlinger is restarted.

Specifically this sets the following system properties:

• debug.tracing.ctl.renderengine.skia_tracing_enabled
• debug.tracing.ctl.renderengine.skia_use_perfetto_track_events

Does not affect actual track_event data collection, which must be configured seperately.

hwui_skia_track_events: Option<bool>

If true, configures HWUI apps to initialize Skia’s Perfetto integration with the track_event data source. hwui_package_name_filter can be used to control which apps are affected. If false or omitted, the simpler ATrace fallback is used.

NOTE: once enabled, Skia will only revert to ATrace if the app is restarted.

ATTENTION: affects ALL HWUI APPS if hwui_package_name_filter is not set! If filtering is NOT set, this controls these GLOBAL system properties:

• debug.tracing.ctl.hwui.skia_tracing_enabled
• debug.tracing.ctl.hwui.skia_use_perfetto_track_events If filtering IS set, this controls these APP-SPECIFIC system properties, for each package listed in the filter:
• debug.tracing.ctl.hwui.skia_tracing_enabled.<package.name>
• debug.tracing.ctl.hwui.skia_use_perfetto_track_events.<package.name>

Does not affect actual track_event data collection, which must be configured seperately.

hwui_package_name_filter: Vec<String>

If non-empty, hwui_skia_track_events applies to only the packages listed. Otherwise, hwui_skia_track_events applies globally to all HWUI apps.

Implementations

impl AndroidSdkSyspropGuardConfig

pub fn surfaceflinger_skia_track_events(&self) -> bool

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

pub fn hwui_skia_track_events(&self) -> bool

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

Trait Implementations

impl Clone for AndroidSdkSyspropGuardConfig

fn clone(&self) -> AndroidSdkSyspropGuardConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AndroidSdkSyspropGuardConfig

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

Formats the value using the given formatter.

impl Default for AndroidSdkSyspropGuardConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for AndroidSdkSyspropGuardConfig

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 AndroidSdkSyspropGuardConfig

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