Struct xgadget::gadget::Gadget

pub struct Gadget<'a> {
    pub instrs: Vec<DecodedInstruction>,
    pub full_matches: BTreeSet<u64>,
    pub partial_matches: BTreeMap<u64, Vec<&'a Binary>>,
}

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).

Fields

instrs: Vec<DecodedInstruction>

full_matches: BTreeSet<u64>

partial_matches: BTreeMap<u64, Vec<&'a Binary>>

Implementations

impl<'a> Gadget<'a>

pub fn new(
    instrs: Vec<DecodedInstruction>,
    full_matches: BTreeSet<u64>
) -> Gadget<'a>

Assumes instructions are correctly sorted, address guaranteed to be sorted

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

Get tail

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> Eq for Gadget<'_>

impl<'_> Hash for Gadget<'_>

SET DE-DUPLICATION PERFORMANCE (see http://cglab.ca/~abeinges/blah/hash-rs/):

• SipHash 2-4 (default): Resistant to an advanced form of DDoS attack, but slow.

  • Important for parsing untrusted inputs (e.g. network data), but not for our tool (it parses local binaries)
  • We default to FxHash to run about 30% faster
  • TODO (tnballo): HOWEVER an optional build config macro enables SipHash 2-4 (for parsing untrusted binaries, e.g. malware)
  • That's paranoid, malware doesn't control hashing logic for our lib's decoding structs

• Fowler-Noll-Vo, aka FNV: fastest option, but only for small key sizes. Our key, Veczydis::DecodedInstruction, is large and scales proportionally with the flag --max-len (gadget instr count).

  • Not a good choice.

• FxHash: fast, non-cryptographic hash used in Firefox and maintained by the Rust Core team. Our default for approximately 30% speed gains via "drop-in" replacement.

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

Feeds this value into the given [Hasher].

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]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

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]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]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]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]fn gt(&self, other: &Rhs) -> bool

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

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

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