Struct range_action_map::RangeActionMap

pub struct RangeActionMap<SegmentType: Segment> {
    pub segments: BTreeMap<usize, RangeArea<SegmentType>>,
    /* private fields */
}

一个数据结构，维护互不相交的左闭右开区间。 其中每个区间有一个 usize 大小的可修改的属性，在用于内存管理时，它一般是 PTEFlags (尽管这个结构只需要u8，但我们希望这个属性至少可以放下一个 raw_pointer 以便扩展其他用途)。

RangeActionMap 主要提供以下操作：

• unmap(start, end)：拆分/缩短/删除部分现有区间，空出[start, end) 这一段。
• mprotect(start, end)：修改所有区间与 [start,end) 相交的部分的属性。没有被 [start, end) 覆盖的区间会被拆分。
• mmap_fixed(start, end)：unmap(start, end)，并插入一个(用户给定的)新区间在[start, end)。
• mmap_anywhere(hint, len)：不修改任何区间，寻找一个长为 len 且左端点不小于 hint 的空位，并插入一个(用户给定的)新区间，返回插入位置的左端点。

还提供以下接口：

• find(pos: usize)：查询一个点是否在某个区间在，如果在，返回它的引用。
• .iter() .iter_mut()：迭代器支持。
• impl Debug：可以用 Debug 属性输出所有区间信息(需要用户提供的底层 SegmentType 实现 Debug)。

RangeActionMap 需要一个实现 trait Segment 的类型，至少实现删除、拆分、修改三个操作：

• remove()：删除这段区间
• split(pos)：从pos位置把当前区间拆成两段区间(pos 参数为全局的绝对位置而非区间内位置)
• modify(new_flags)：修改区间的属性

此外，RangeActionMap创建时要求传入一个 ArgsType，它实际上是一个 usize。这个值会在每次操作时传递给底层区间

Example

/// 定义一个区间结构，内部只保存左右端点
struct Seg(usize, usize);
let mut ram = RangeActionMap::<Seg>::new(ArgsType::default());
/// 分配一段区间，注意区间是**左闭右开**的
ram.mmap_fixed(0x3000, 0x7000, || { Seg(0x3000, 0x7000) });
assert!(ram.find(0x2111).is_none());
assert!(ram.find(0x3000).is_some());
assert!(ram.find(0x5678).is_some());
assert!(ram.find(0x7000).is_none());
 
/// 实现 Segment
impl Segment for Seg {
    fn remove(&mut self, args: ArgsType) {}
    fn modify(&mut self, new_flag: IdentType, args: ArgsType) {}
    fn split(&mut self, pos: usize, args: ArgsType) -> Self {
        let right_end = self.1;
        self.1 = pos;
        Self(pos, right_end)
    }
}

Fields

segments: BTreeMap<usize, RangeArea<SegmentType>>

Implementations

impl<SegmentType: Segment> RangeActionMap<SegmentType>

pub fn new(args: ArgsType) -> Self

创建一个空的区间树。

传入的 args 会在每次操作时传递给底层的区间。 (如果用于内存管理，推荐传入页表位置)

此外，也可在 ./defs.rs 修改 ArgsType 的定义，以传递不同的参数

pub fn find<'a>(&'a self, pos: usize) -> Option<&'a SegmentType>

查询某个地址是否在一个区间内，如是则返回区间引用，否则返回 None

pub fn iter<'a>(&'a self) -> RangeActionMapIter<'a, SegmentType>

通过迭代器访问每个区间的引用

pub fn iter_mut<'a>(&'a mut self) -> RangeActionMapIterMut<'a, SegmentType>

通过迭代器访问每个区间的可变引用

pub fn mmap_anywhere(
    &mut self,
    hint: usize,
    len: usize,
    f: impl FnOnce(usize) -> SegmentType
) -> Option<usize>

插入一段长度为 len 的区间，且区间左端点位置不小于 hint。

• 如找到这样的区间，则会执行 f(start: usize) 获取区间实例， 然后返回 Some(start) 表示区间左端点；
• 否则，**不会执行 f **，并返回 None

Example

/// 定义一个区间结构，内部只保存左右端点
struct Seg(usize, usize);
/// 实现 Segment
impl Segment for Seg {
    fn remove(&mut self, args: ArgsType) {}
    fn modify(&mut self, new_flag: IdentType, args: ArgsType) {}
    fn split(&mut self, pos: usize, args: ArgsType) -> Self {
        let right_end = self.1;
        self.1 = pos;
        Self(pos, right_end)
    }
}
let mut map: RangeActionMap<Seg> = RangeActionMap::new(0);
/// 申请一个长为 10 的区间，要求左端点不小于 10123，获得[10123,10133)
assert_eq!(Some(10123), map.mmap_anywhere(10123, 10, |start| Seg(start, start+10)));
/// 申请一个长为 10 的区间，要求左端点不小于 140，获得[10140,10150)
assert_eq!(Some(10140), map.mmap_anywhere(10140, 10, |start| Seg(start, start+10)));
/// 申请一个长为 10 的区间，要求左端点不小于 120，获得[10150, 10160)。
/// 这是因为[10123,10133)和[10140,10150)已有区间，第一个满足要求的空区间只能从 10150 开始
assert_eq!(Some(10150), map.mmap_anywhere(10120, 10, |start| Seg(start, start+10)));

pub fn mmap_fixed(
    &mut self,
    start: usize,
    end: usize,
    f: impl FnOnce() -> SegmentType
) -> Option<usize>

尝试插入一个区间。如插入成功，返回插入后的起始地址

• 如区间在 [LOWER_LIMIT, UPPER_LIMIT] 范围内，则会：
• • unmap(start, end)，
• • 然后执行 f(start: usize) ，
• • 然后返回 Some(start) 表示区间左端点；
• 否则，**不会执行 f **，并返回 None

pub fn unmap(&mut self, start: usize, end: usize)

删除映射，空出 [start, end) 这段区间。

这可能导致一些区间被缩短或拆分

pub fn mprotect(&mut self, start: usize, end: usize, new_flags: IdentType)

调整所有和已知区间相交的区间，修改 [start, end) 段的权限。 它可以直接当作 mprotect 使用

pub fn find_free_area(&self, hint: usize, len: usize) -> Option<usize>

Trait Implementations

impl<SegmentType: Segment + Debug> Debug for RangeActionMap<SegmentType>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.