Enum cwe_checker_lib::intermediate_representation::Jmp

pub enum Jmp {
    Branch(Tid),
    BranchInd(Expression),
    CBranch {
        target: Tid,
        condition: Expression,
    },
    Call {
        target: Tid,
        return_: Option<Tid>,
    },
    CallInd {
        target: Expression,
        return_: Option<Tid>,
    },
    Return(Expression),
    CallOther {
        description: String,
        return_: Option<Tid>,
    },
}

A Jmp instruction affects the control flow of a program, i.e. it may change the instruction pointer. With the exception of CallOther, it has no other side effects.

Jmp instructions carry some semantic information with it, like whether a jump is intra- or interprocedural. Note that this semantic information may not always be correct.

Variants

Branch(Tid)

A direct intraprocedural jump to the targeted Blk term identifier.

BranchInd(Expression)

An indirect intraprocedural jump to the address that the given expression evaluates to.

CBranch

Fields

target: Tid

The term ID of the target block of the jump.

condition: Expression

The jump is only taken if this expression evaluates to true, (i.e. not zero).

A direct intraprocedural jump that is only taken if the condition evaluates to true (i.e. not zero).

Call

Fields

target: Tid

The term ID of the target subroutine (Sub) or extern symbol of the call.

return_: Option<Tid>

The term ID of the block that the called function returns to. May be None if it is assumed that the called function never returns.

A direct interprocedural jump representing a subroutine call.

Note that this is syntactically equivalent to a Jmp::Branch.

CallInd

Fields

target: Expression

An expression computing the target address of the call.

return_: Option<Tid>

The term ID of the block that the called function returns to. May be None if it is assumed that the called function never returns.

An indirect interprocedural jump to the address the target expression evaluates to and representing a subroutine call.

Note that this is syntactically equivalent to a Jmp::BranchInd.

Return(Expression)

A indirect interprocedural jump indicating a return from a subroutine.

Note that this is syntactically equivalent to a Jmp::BranchInd.

CallOther

Fields

description: String

A description of the side effect.

return_: Option<Tid>

The block term identifier of the block where the disassembler assumes that execution will continue after handling of the side effect.

This instruction is used for all side effects that are not representable by other instructions or not supported by the disassembler.

E.g. syscalls and other interrupts are mapped to CallOther. Assembly instructions that the disassembler does not support are also mapped to CallOther. One can use the description field to match for and handle known side effects (e.g. syscalls).

Trait Implementations

impl Clone for Jmp

fn clone(&self) -> Jmp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Jmp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Jmp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Jmp

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

Formats the value using the given formatter.

impl From<Jmp> for Jmp

fn from(jmp: Jmp) -> IrJmp

Convert a P-Code jump to the internally used IR.

impl Hash for Jmp

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Jmp

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Jmp

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Jmp

impl StructuralEq for Jmp

impl StructuralPartialEq for Jmp