lief 1.0.0

//! Module related to assembly instructions

use lief_ffi as ffi;

use bitflags::bitflags;

use crate::to_slice;

use crate::Error;
use crate::common::FromFFI;
use crate::to_conv_result;

use super::aarch64;
use super::arm;
use super::ebpf;
use super::mips;
use super::powerpc;
use super::riscv;
use super::x86;

bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct MemoryAccess: u64 {
        const NONE = 0;
        const READ = 1 << 0;
        const WRITE = 1 << 1;
    }
}

/// This trait is shared by all [`Instructions`] supported by LIEF
pub trait Instruction: std::fmt::Display {
    #[doc(hidden)]
    fn as_generic(&self) -> &ffi::asm_Instruction;

    /// Address of the instruction
    fn address(&self) -> u64 {
        self.as_generic().address()
    }

    /// Size of the instruction in bytes
    fn size(&self) -> u64 {
        self.as_generic().size()
    }

    /// Raw bytes of the current instruction
    fn raw(&self) -> &[u8] {
        to_slice!(self.as_generic().raw());
    }

    /// Instruction mnemonic (e.g. `br`)
    fn mnemonic(&self) -> String {
        self.as_generic().mnemonic().to_string()
    }

    /// Same as the [`Display`](std::fmt::Display) representation (i.e.
    /// [`ToString::to_string`]) but without the address as prefix
    fn to_string_no_address(&self) -> String {
        self.as_generic().to_string_no_address().to_string()
    }

    /// True if the instruction is a call
    fn is_call(&self) -> bool {
        self.as_generic().is_call()
    }

    /// True if the instruction marks the end of a basic block
    fn is_terminator(&self) -> bool {
        self.as_generic().is_terminator()
    }

    /// True if the instruction is a branch
    fn is_branch(&self) -> bool {
        self.as_generic().is_branch()
    }

    /// True if the instruction is a syscall
    fn is_syscall(&self) -> bool {
        self.as_generic().is_syscall()
    }

    /// True if the instruction performs a memory access
    fn is_memory_access(&self) -> bool {
        self.as_generic().is_memory_access()
    }

    /// True if the instruction is a register to register move.
    fn is_move_reg(&self) -> bool {
        self.as_generic().is_move_reg()
    }

    /// True if the instruction performs an arithmetic addition.
    fn is_add(&self) -> bool {
        self.as_generic().is_add()
    }

    /// True if the instruction is a trap.
    ///
    /// - On `x86/x86-64` this includes the `ud1/ud2` instructions
    /// - On `AArch64` this includes the `brk/udf` instructions
    fn is_trap(&self) -> bool {
        self.as_generic().is_trap()
    }

    /// True if the instruction prevents executing the instruction
    /// that immediatly follows the current. This includes return
    /// or unconditional branch instructions
    fn is_barrier(&self) -> bool {
        self.as_generic().is_barrier()
    }

    /// True if the instruction is a return
    fn is_return(&self) -> bool {
        self.as_generic().is_return()
    }

    /// True if the instruction is and indirect branch.
    ///
    /// This includes instructions that branch through a register (e.g. `jmp rax`,
    /// `br x1`).
    fn is_indirect_branch(&self) -> bool {
        self.as_generic().is_indirect_branch()
    }

    /// True if the instruction is **conditionally** jumping to the next
    /// instruction **or** an instruction into some other basic block.
    fn is_conditional_branch(&self) -> bool {
        self.as_generic().is_conditional_branch()
    }

    /// True if the instruction is jumping (**unconditionally**) to some other
    /// basic block.
    fn is_unconditional_branch(&self) -> bool {
        self.as_generic().is_unconditional_branch()
    }

    /// True if the instruction is a comparison
    fn is_compare(&self) -> bool {
        self.as_generic().is_compare()
    }

    /// True if the instruction is moving an immediate
    fn is_move_immediate(&self) -> bool {
        self.as_generic().is_move_immediate()
    }

    /// True if the instruction is doing a bitcast
    fn is_bitcast(&self) -> bool {
        self.as_generic().is_bitcast()
    }

    /// Memory access flags
    fn memory_access(&self) -> MemoryAccess {
        MemoryAccess::from_bits_truncate(self.as_generic().memory_access())
    }

    /// Given a [`Instruction::is_branch`] instruction, try to evaluate the address of the
    /// destination.
    fn branch_target(&self) -> Result<u64, Error> {
        to_conv_result!(
            ffi::asm_Instruction::branch_target,
            self.as_generic(),
            |value| value
        );
    }
}

/// All instruction variants supported by LIEF
pub enum Instructions {
    /// An AArch64 instruction
    AArch64(aarch64::Instruction),

    /// A x86/x86-64 instruction
    X86(x86::Instruction),

    /// An ARM/thumb instruction
    ARM(arm::Instruction),

    /// An eBPF instruction
    EBPF(ebpf::Instruction),

    /// A PowerPC (ppc64/ppc32) instruction
    PowerPC(powerpc::Instruction),

    /// A Mips (mips32/mips64) instruction
    Mips(mips::Instruction),

    /// A RISC-V (32 or 64 bit) instruction
    RiscV(riscv::Instruction),

    /// A generic instruction that doesn't have an extended structure
    Generic(Generic),
}

impl FromFFI<ffi::asm_Instruction> for Instructions {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::asm_Instruction>) -> Self {
        unsafe {
            let inst_ref = ptr.as_ref().unwrap();
            if ffi::asm_aarch64_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_aarch64_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::AArch64(aarch64::Instruction::from_ffi(raw));
            } else if ffi::asm_x86_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_x86_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::X86(x86::Instruction::from_ffi(raw));
            } else if ffi::asm_arm_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_arm_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::ARM(arm::Instruction::from_ffi(raw));
            } else if ffi::asm_mips_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_mips_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::Mips(mips::Instruction::from_ffi(raw));
            } else if ffi::asm_powerpc_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_powerpc_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::PowerPC(powerpc::Instruction::from_ffi(raw));
            } else if ffi::asm_riscv_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_riscv_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::RiscV(riscv::Instruction::from_ffi(raw));
            } else if ffi::asm_ebpf_Instruction::classof(inst_ref) {
                let raw = {
                    type From = cxx::UniquePtr<ffi::asm_Instruction>;
                    type To = cxx::UniquePtr<ffi::asm_ebpf_Instruction>;
                    std::mem::transmute::<From, To>(ptr)
                };
                return Instructions::EBPF(ebpf::Instruction::from_ffi(raw));
            }
            Instructions::Generic(Generic::from_ffi(ptr))
        }
    }
}

impl Instruction for Instructions {
    #[doc(hidden)]
    fn as_generic(&self) -> &ffi::asm_Instruction {
        match &self {
            Instructions::Generic(inst) => inst.as_generic(),
            Instructions::AArch64(inst) => inst.as_generic(),
            Instructions::X86(inst) => inst.as_generic(),
            Instructions::ARM(inst) => inst.as_generic(),
            Instructions::Mips(inst) => inst.as_generic(),
            Instructions::PowerPC(inst) => inst.as_generic(),
            Instructions::EBPF(inst) => inst.as_generic(),
            Instructions::RiscV(inst) => inst.as_generic(),
        }
    }
}

impl std::fmt::Display for Instructions {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.as_generic().to_string())
    }
}

/// Generic Instruction
pub struct Generic {
    ptr: cxx::UniquePtr<ffi::asm_Instruction>,
}

impl FromFFI<ffi::asm_Instruction> for Generic {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::asm_Instruction>) -> Self {
        Self { ptr }
    }
}

impl Instruction for Generic {
    #[doc(hidden)]
    fn as_generic(&self) -> &ffi::asm_Instruction {
        self.ptr.as_ref().unwrap()
    }
}

impl std::fmt::Display for Generic {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.as_generic().to_string())
    }
}