[go: up one dir, main page]

region 3.0.2

Cross-platform virtual memory API
Documentation 
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

use crate::{Error, Protection, Region, Result};
use mach2::vm_prot::*;

pub struct QueryIter {
  region_address: mach2::vm_types::mach_vm_address_t,
  upper_bound: usize,
}

impl QueryIter {
  pub fn new(origin: *const (), size: usize) -> Result<QueryIter> {
    Ok(QueryIter {
      region_address: origin as _,
      upper_bound: (origin as usize).saturating_add(size),
    })
  }

  pub fn upper_bound(&self) -> usize {
    self.upper_bound
  }
}

impl Iterator for QueryIter {
  type Item = Result<Region>;

  fn next(&mut self) -> Option<Self::Item> {
    // The possible memory share modes
    const SHARE_MODES: [u8; 3] = [
      mach2::vm_region::SM_SHARED,
      mach2::vm_region::SM_TRUESHARED,
      mach2::vm_region::SM_SHARED_ALIASED,
    ];

    // Check if the search area has been passed
    if self.region_address as usize >= self.upper_bound {
      return None;
    }

    let mut region_size: mach2::vm_types::mach_vm_size_t = 0;

    let mut info: mach2::vm_region::vm_region_submap_info_64 =
      mach2::vm_region::vm_region_submap_info_64::default();

    let mut depth = u32::MAX;
    let result = unsafe {
      mach2::vm::mach_vm_region_recurse(
        mach2::traps::mach_task_self(),
        &mut self.region_address,
        &mut region_size,
        &mut depth,
        (&mut info as *mut _) as mach2::vm_region::vm_region_recurse_info_t,
        &mut mach2::vm_region::vm_region_submap_info_64::count(),
      )
    };

    match result {
      // The end of the process' address space has been reached
      mach2::kern_return::KERN_INVALID_ADDRESS => None,
      mach2::kern_return::KERN_SUCCESS => {
        // The returned region may have a different address than the request
        if self.region_address as usize >= self.upper_bound {
          return None;
        }

        let region = Region {
          base: self.region_address as *const _,
          guarded: (info.user_tag == mach2::vm_statistics::VM_MEMORY_GUARD),
          protection: Protection::from_native(info.protection),
          max_protection: Protection::from_native(info.max_protection),
          shared: SHARE_MODES.contains(&info.share_mode),
          size: region_size as usize,
          ..Default::default()
        };

        self.region_address = self.region_address.saturating_add(region_size);
        Some(Ok(region))
      }
      _ => Some(Err(Error::MachCall(result))),
    }
  }
}

impl Protection {
  fn from_native(protection: vm_prot_t) -> Self {
    const MAPPINGS: &[(vm_prot_t, Protection)] = &[
      (VM_PROT_READ, Protection::READ),
      (VM_PROT_WRITE, Protection::WRITE),
      (VM_PROT_EXECUTE, Protection::EXECUTE),
    ];

    MAPPINGS
      .iter()
      .filter(|(flag, _)| protection & *flag == *flag)
      .fold(Protection::NONE, |acc, (_, prot)| acc | *prot)
  }
}

#[cfg(test)]
mod tests {
  use super::*;

  #[test]
  fn protection_flags_are_mapped_from_native() {
    let rw = VM_PROT_READ | VM_PROT_WRITE;
    let rwx = rw | VM_PROT_EXECUTE;

    assert_eq!(Protection::from_native(0), Protection::NONE);
    assert_eq!(Protection::from_native(VM_PROT_READ), Protection::READ);
    assert_eq!(Protection::from_native(rw), Protection::READ_WRITE);
    assert_eq!(Protection::from_native(rwx), Protection::READ_WRITE_EXECUTE);
  }
}