page_table/
flags.rs

1use crate::{Pte, VmMeta, PPN};
2use core::{
3    marker::PhantomData,
4    ops::{BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign},
5};
6
7/// 页表项属性。
8///
9/// 页表项属性一定完全包含在页表项中,所以独立的页表项属性实现为一个无法获取地址的页表项。
10#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
11#[repr(transparent)]
12pub struct VmFlags<Meta: VmMeta>(usize, PhantomData<Meta>);
13
14impl<Meta: VmMeta> VmFlags<Meta> {
15    /// 空页表项属性。
16    pub const ZERO: Self = Self(0, PhantomData);
17
18    /// 表示页表项有效的属性。
19    pub const VALID: Self = Self(Meta::VALID_FLAG, PhantomData);
20
21    /// 将 `raw` 整数转化为一个页表项属性。
22    ///
23    /// # Safety
24    ///
25    /// 调用者需要保证 `raw` 里不表示属性的位全是零。
26    #[inline]
27    pub const unsafe fn from_raw(raw: usize) -> Self {
28        Self(raw, PhantomData)
29    }
30
31    /// 取出值。
32    #[inline]
33    pub const fn val(self) -> usize {
34        self.0
35    }
36
37    /// 判断是否包含所有指定的位。
38    #[inline]
39    pub const fn contains(self, flags: VmFlags<Meta>) -> bool {
40        self.0 & flags.0 == flags.0
41    }
42
43    /// 如果页表项指向一个页而非子页表,返回 `true`。
44    #[inline]
45    pub fn is_leaf(self) -> bool {
46        Meta::is_leaf(self.0)
47    }
48
49    /// 如果页表项指向一个非 0 级的页,返回 `true`。
50    #[inline]
51    pub fn is_huge(self, level: usize) -> bool {
52        Meta::is_huge(self.0, level)
53    }
54
55    /// 如果页表项有效,返回 `true`。
56    #[inline]
57    pub fn valid(self) -> bool {
58        Meta::is_valid(self.0)
59    }
60
61    /// 构造具有 `self` 页表项属性,并指向 `ppn` 物理页的页表项。
62    #[inline]
63    pub fn build_pte(mut self, ppn: PPN<Meta>) -> Pte<Meta> {
64        Meta::set_ppn(&mut self.0, ppn);
65        Pte(self.0, PhantomData)
66    }
67}
68
69impl<Meta: VmMeta> BitAnd for VmFlags<Meta> {
70    type Output = Self;
71
72    #[inline]
73    fn bitand(self, rhs: Self) -> Self::Output {
74        Self(self.0 & rhs.0, PhantomData)
75    }
76}
77
78impl<Meta: VmMeta> BitOr for VmFlags<Meta> {
79    type Output = Self;
80
81    #[inline]
82    fn bitor(self, rhs: Self) -> Self::Output {
83        Self(self.0 | rhs.0, PhantomData)
84    }
85}
86
87impl<Meta: VmMeta> BitXor for VmFlags<Meta> {
88    type Output = Self;
89
90    #[inline]
91    fn bitxor(self, rhs: Self) -> Self::Output {
92        Self(self.0 ^ rhs.0, PhantomData)
93    }
94}
95
96impl<Meta: VmMeta> BitAndAssign for VmFlags<Meta> {
97    #[inline]
98    fn bitand_assign(&mut self, rhs: Self) {
99        self.0 &= rhs.0;
100    }
101}
102
103impl<Meta: VmMeta> BitOrAssign for VmFlags<Meta> {
104    #[inline]
105    fn bitor_assign(&mut self, rhs: Self) {
106        self.0 |= rhs.0;
107    }
108}
109
110impl<Meta: VmMeta> BitXorAssign for VmFlags<Meta> {
111    #[inline]
112    fn bitxor_assign(&mut self, rhs: Self) {
113        self.0 ^= rhs.0;
114    }
115}