Struct xgadget::gadget::Gadget

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

Gadget instructions (data) coupled with occurrence addresses for full and partial matches (metadata). Gadgets sortable by lowest occurrence address. Hash and equality consider only gadget instructions, not occurrence addresses (fast de-duplication via sets).

Implementations

impl<'a> Gadget<'a>

pub fn new(instrs: Vec<Instruction>, occurrence_addrs: BTreeSet<u64>) -> Self

Convenience constructor for single-binary gadgets.

Arguments

• instrs - instructions, should be sorted in execution order.
• occurrence_addrs - Addresses where gadget appears.

pub fn new_multi_bin(
    instrs: Vec<Instruction>,
    full_matches: BTreeSet<u64>,
    bin_cnt: usize
) -> Self

Constructor for multi-binary gadgets.

Arguments

• instrs - instructions, should be sorted in execution order.
• full_matches - full match addresses (same in all binaries).
• bin_cnt - count of binaries for which this gadget tracks full/partial matches.

pub fn instrs(&self) -> &[Instruction]

Get a instructions

pub fn last_instr(&self) -> Option<&Instruction>

Get tail

pub fn full_matches(&self) -> &BTreeSet<u64>

Get a full matches

pub fn partial_matches(&self) -> &BTreeMap<u64, Vec<&'a Binary>>

Get partial matches

pub fn first_full_match(&self) -> Option<u64>

Get first full match

pub fn bin_cnt(&self) -> usize

Get count of binaries for which this gadget tracks partial matches

pub fn add_partial_match(&mut self, addr: u64, bin: &'a Binary)

Add a new partial match address/binary tuple

pub fn fmt_instrs(
    &self,
    att_syntax: bool,
    color: bool
) -> Box<dyn DisplayLen + Send>

String format gadget instructions

pub fn fmt_first_full_match_addr(
    &self,
    color: bool
) -> Option<Box<dyn DisplayLen + Send>>

String format first full match address, if any

pub fn fmt_partial_match_addrs(
    &self,
    color: bool
) -> Option<Box<dyn DisplayLen + Send>>

String format partial match addresses, if any

pub fn fmt_best_match_addrs(
    &self,
    color: bool
) -> Option<Box<dyn DisplayLen + Send>>

String format match addresses, prioritizing full matches over partial, if any

pub fn fmt_for_filter(&self, att_syntax: bool) -> String

pub fn fmt(
    &self,
    att_syntax: bool,
    color: bool
) -> Option<(Box<dyn DisplayLen + Send>, Box<dyn DisplayLen + Send>)>

Format a single gadget, return an (instrs, addr(s)) tuple Returns None is the gadget has no full or partial matches across binaries.

Trait Implementations

impl<'a> Clone for Gadget<'a>

fn clone(&self) -> Gadget<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Gadget<'a>

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

Formats the value using the given formatter.

impl Eq for Gadget<'_>

impl Hash for Gadget<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Gadget<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Gadget<'_>> for Gadget<'_>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Gadget<'_>> for Gadget<'_>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.