Struct frida_gum::stalker::Stalker

pub struct Stalker<'a> { /* fields omitted */ }

Code tracing engine interface.

Implementations

impl<'a> Stalker<'a>

pub fn is_supported(_gum: &Gum) -> bool

Checks if the Stalker is supported on the current platform.

pub fn new<'b>(gum: &'b Gum) -> Stalker<'_> where
    'b: 'a, 

Create a new Stalker.

This call has the overhead of checking if the Stalker is available on the current platform, as creating a Stalker on an unsupported platform results in unwanted behaviour.

pub fn exclude(&mut self, range: &MemoryRange)

Exclude a range of address from the Stalker engine.

This exclusion will prevent the Stalker from tracing into the memory range, reducing instrumentation overhead as well as potential noise from the [EventSink].

pub fn set_trust_threshold(&mut self, threshold: i32)

Set how many times a piece of code needs to be executed before it is assumed it can be trusted to not mutate.

Specify -1 for no trust (slow), 0 to trust code from the get-go, and N to trust code after it has been executed N times. Defaults to 1.

pub fn get_trust_threshold(&self) -> i32

Get the Stalker trust treshold, see Stalker::set_trust_threshold() for more details.

pub fn flush(&mut self)

Flush all buffered events.

pub fn stop(&mut self)

pub fn garbage_collect(&mut self) -> bool

Free accumulated memory at a safe point after Stalker::unfollow_me().

This is needed to avoid race-conditions where the thread just unfollowed is executing its last instructions.

pub fn follow_me(&mut self, transformer: Transformer<'_>)

Begin the Stalker on the current thread.

A Transformer must be specified, and will be updated with all events.

pub fn unfollow_me(&mut self)

Stop stalking the current thread.

pub fn is_following_me(&mut self) -> bool

Check if the Stalker is running on the current thread.

Trait Implementations

impl<'a> Drop for Stalker<'a>

pub fn drop(&mut self)

Executes the destructor for this type.