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

//! This module contains functions and structs helpful for building a complete analysis pipeline
//! starting from the binary file path.

mod results;
pub use results::AnalysisResults;

use crate::intermediate_representation::{Project, RuntimeMemoryImage};
use crate::prelude::*;
use crate::utils::debug;
use crate::utils::log::LogMessage;
use crate::utils::{binary::BareMetalConfig, ghidra::get_project_from_ghidra};
use std::path::Path;

/// Disassemble the given binary and parse it to a [`Project`] struct.
///
/// If successful, returns the binary file (as a byte vector), the parsed project struct,
/// and a vector of log messages generated during the process.
pub fn disassemble_binary(
    binary_file_path: &Path,
    bare_metal_config_opt: Option<BareMetalConfig>,
    debug_settings: &debug::Settings,
) -> Result<(Vec<u8>, Project, Vec<LogMessage>), Error> {
    let binary: Vec<u8> =
        std::fs::read(binary_file_path).context("Could not read from binary file path {}")?;
    let (mut project, mut all_logs) = get_project_from_ghidra(
        binary_file_path,
        &binary[..],
        bare_metal_config_opt.clone(),
        debug_settings,
    )?;

    // Normalize the project and gather log messages generated from it.
    debug_settings.print(&project.program.term, debug::Stage::Ir(debug::IrForm::Raw));
    all_logs.append(&mut project.normalize_basic());
    debug_settings.print(
        &project.program.term,
        debug::Stage::Ir(debug::IrForm::Normalized),
    );
    all_logs.append(&mut project.normalize_optimize());
    debug_settings.print(
        &project.program.term,
        debug::Stage::Ir(debug::IrForm::Optimized),
    );

    // Generate the representation of the runtime memory image of the binary
    let mut runtime_memory_image = if let Some(bare_metal_config) = bare_metal_config_opt.as_ref() {
        RuntimeMemoryImage::new_from_bare_metal(&binary, bare_metal_config)
            .context("Error while generating runtime memory image.")?
    } else {
        RuntimeMemoryImage::new(&binary).context("Error while generating runtime memory image.")?
    };
    if project.program.term.address_base_offset != 0 {
        // We adjust the memory addresses once globally
        // so that other analyses do not have to adjust their addresses.
        runtime_memory_image.add_global_memory_offset(project.program.term.address_base_offset);
    }
    project.runtime_memory_image = runtime_memory_image;

    Ok((binary, project, all_logs))
}