1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

//! # VTIL-RustParser
//!
//! An in-place parser for VTIL files written in Rust.
//!
//! You can learn more about VTIL [here](https://github.com/vtil-project/VTIL-Core#introduction)
//! on the main GitHub page.
//!
//! # Examples
//! For a simple example of loading a VTIL file and reading out some basic data:
//! ```
//! # use vtil_parser::Result;
//! use vtil_parser::{VTILReader, ArchitectureIdentifier};
//!
//! # fn main() -> Result<()> {
//! let routine = VTILReader::from_path("resources/big.vtil")?;
//! assert_eq!(routine.header().arch_id(), ArchitectureIdentifier::Amd64);
//! # Ok(())
//! # }
//! ```
//!
//! For a more complex example, iterating over IL instructions:
//! ```
//! # use vtil_parser::Result;
//! use vtil_parser::{VTILReader, Operand, RegisterFlags};
//!
//! # fn main() -> Result<()> {
//! let routine = VTILReader::from_path("resources/big.vtil")?;
//!
//! for basic_block in routine.explored_blocks().iter().take(1) {
//!     for instr in basic_block.instructions().iter().take(1) {
//!         assert_eq!(instr.name(), "ldd");
//!         assert_eq!(instr.operands().len(), 3);
//!
//!         if let Operand::Reg(reg) = &instr.operands()[1] {
//!             assert!(reg.flags().contains(RegisterFlags::PHYSICAL));
//!         } else { unreachable!() }
//!
//!         if let Operand::Imm(imm) = &instr.operands()[2] {
//!             assert_eq!(imm.i64(), 0);
//!         } else { unreachable!() }
//!
//!         assert_eq!(instr.vip(), 0x9b833);
//!     }
//! }
//! # Ok(())
//! # }
//! ```

#![deny(missing_docs)]

use memmap::{Mmap, MmapOptions};
use ouroboros::self_referencing;
use scroll::Pread;
use std::fs::File;
use std::marker::PhantomData;
use std::path::Path;

#[macro_use]
extern crate bitflags;

mod error;
pub use error::Error;

mod parse;
pub use parse::*;

mod arch_info;

#[doc(hidden)]
pub type Result<T> = std::result::Result<T, error::Error>;

#[self_referencing(no_doc)]
/// VTIL container
pub struct VTIL<T: 'static> {
    source: Box<T>,
    #[borrows(source)]
    pub(crate) inner: VTILInner<'this>,
    phantom: PhantomData<T>,
}

impl<T> VTIL<T> {
    /// Header containing metadata about the VTIL container
    pub fn header(&self) -> &Header {
        self.inner.header()
    }

    /// The entry virtual instruction pointer for this VTIL routine
    pub fn vip(&self) -> &Vip {
        self.inner.vip()
    }

    /// Metadata regarding the calling conventions of the VTIL routine
    pub fn routine_convention(&self) -> &RoutineConvention {
        self.inner.routine_convention()
    }

    /// Metadata regarding the calling conventions of the VTIL subroutine
    pub fn subroutine_convention(&self) -> &SubroutineConvention {
        self.inner.subroutine_convention()
    }

    /// All special subroutine calling conventions in the top-level VTIL routine
    pub fn spec_subroutine_conventions(&self) -> &Vec<SubroutineConvention> {
        self.inner.spec_subroutine_conventions()
    }

    /// Reachable [`BasicBlock`]s generated during a code-discovery analysis
    /// pass
    pub fn explored_blocks(&self) -> &Vec<BasicBlock> {
        self.inner.explored_blocks()
    }
}

/// Reader for VTIL containers
pub struct VTILReader;

impl VTILReader {
    /// Tries to load VTIL from the given path
    pub fn from_path<P: AsRef<Path>>(path: P) -> Result<VTIL<Mmap>> {
        let source = Box::new(unsafe { MmapOptions::new().map(&File::open(path.as_ref())?)? });
        VTILTryBuilder {
            source,
            inner_builder: |source| source.pread_with::<VTILInner>(0, scroll::LE),
            phantom: PhantomData,
        }
        .try_build()
    }

    /// Loads VTIL from a `Vec<u8>`
    pub fn from_vec<B: AsRef<[u8]>>(source: B) -> Result<VTIL<B>> {
        VTILTryBuilder {
            source: Box::new(source),
            inner_builder: |source| source.as_ref().pread_with::<VTILInner>(0, scroll::LE),
            phantom: PhantomData,
        }
        .try_build()
    }
}