binaryninja/binary_view/
memory_map.rs

use crate::binary_view::BinaryView;
use crate::data_buffer::DataBuffer;
use crate::file_accessor::FileAccessor;
use crate::rc::Ref;
use crate::segment::SegmentFlags;
use crate::string::{BnStrCompatible, BnString};
use binaryninjacore_sys::*;
use std::ffi::c_char;

#[derive(PartialEq, Eq, Hash)]
pub struct MemoryMap {
    view: Ref<BinaryView>,
}

impl MemoryMap {
    pub fn new(view: Ref<BinaryView>) -> Self {
        Self { view }
    }

    // TODO: There does not seem to be a way to enumerate memory regions.

    /// JSON string representation of the base [`MemoryMap`], consisting of unresolved auto and user segments.
    pub fn base_description(&self) -> String {
        let desc_raw = unsafe { BNGetBaseMemoryMapDescription(self.view.handle) };
        unsafe { BnString::from_raw(desc_raw) }.to_string()
    }

    /// JSON string representation of the [`MemoryMap`].
    pub fn description(&self) -> String {
        let desc_raw = unsafe { BNGetMemoryMapDescription(self.view.handle) };
        unsafe { BnString::from_raw(desc_raw) }.to_string()
    }

    // When enabled, the memory map will present a simplified, logical view that merges and abstracts virtual memory
    // regions based on criteria such as contiguity and flag consistency. This view is designed to provide a higher-level
    // representation for user analysis, hiding underlying mapping details.
    //
    // When disabled, the memory map will revert to displaying the virtual view, which corresponds directly to the individual
    // segments mapped from the raw file without any merging or abstraction.
    pub fn set_logical_enabled(&mut self, enabled: bool) {
        unsafe { BNSetLogicalMemoryMapEnabled(self.view.handle, enabled) };
    }

    pub fn add_binary_memory_region(
        &mut self,
        name: impl BnStrCompatible,
        start: u64,
        view: &BinaryView,
        segment_flags: Option<SegmentFlags>,
    ) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNAddBinaryMemoryRegion(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                start,
                view.handle,
                segment_flags.unwrap_or_default().into_raw(),
            )
        }
    }

    pub fn add_data_memory_region(
        &mut self,
        name: impl BnStrCompatible,
        start: u64,
        data: &DataBuffer,
        segment_flags: Option<SegmentFlags>,
    ) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNAddDataMemoryRegion(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                start,
                data.as_raw(),
                segment_flags.unwrap_or_default().into_raw(),
            )
        }
    }

    pub fn add_remote_memory_region(
        &mut self,
        name: impl BnStrCompatible,
        start: u64,
        accessor: &mut FileAccessor,
        segment_flags: Option<SegmentFlags>,
    ) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNAddRemoteMemoryRegion(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                start,
                &mut accessor.api_object,
                segment_flags.unwrap_or_default().into_raw(),
            )
        }
    }

    pub fn remove_memory_region(&mut self, name: impl BnStrCompatible) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNRemoveMemoryRegion(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
            )
        }
    }

    pub fn active_memory_region_at(&self, addr: u64) -> BnString {
        unsafe {
            let name_raw = BNGetActiveMemoryRegionAt(self.view.handle, addr);
            BnString::from_raw(name_raw)
        }
    }

    pub fn memory_region_flags(&self, name: impl BnStrCompatible) -> SegmentFlags {
        let name_raw = name.into_bytes_with_nul();
        let flags_raw = unsafe {
            BNGetMemoryRegionFlags(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
            )
        };
        SegmentFlags::from_raw(flags_raw)
    }

    pub fn set_memory_region_flags(
        &mut self,
        name: impl BnStrCompatible,
        flags: SegmentFlags,
    ) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNSetMemoryRegionFlags(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                flags.into_raw(),
            )
        }
    }

    pub fn is_memory_region_enabled(&self, name: impl BnStrCompatible) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNIsMemoryRegionEnabled(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
            )
        }
    }

    pub fn set_memory_region_enabled(&mut self, name: impl BnStrCompatible, enabled: bool) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNSetMemoryRegionEnabled(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                enabled,
            )
        }
    }

    // TODO: Should we just call this is_memory_region_relocatable?
    pub fn is_memory_region_rebaseable(&self, name: impl BnStrCompatible) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNIsMemoryRegionRebaseable(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
            )
        }
    }

    pub fn set_memory_region_rebaseable(
        &mut self,
        name: impl BnStrCompatible,
        enabled: bool,
    ) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNSetMemoryRegionRebaseable(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                enabled,
            )
        }
    }

    pub fn memory_region_fill(&self, name: impl BnStrCompatible) -> u8 {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNGetMemoryRegionFill(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
            )
        }
    }

    pub fn set_memory_region_fill(&mut self, name: impl BnStrCompatible, fill: u8) -> bool {
        let name_raw = name.into_bytes_with_nul();
        unsafe {
            BNSetMemoryRegionFill(
                self.view.handle,
                name_raw.as_ref().as_ptr() as *const c_char,
                fill,
            )
        }
    }

    pub fn reset(&mut self) {
        unsafe { BNResetMemoryMap(self.view.handle) }
    }
}
binaryninja/binary_view/memory_map.rs

binaryninja/binary_view/
memory_map.rs
