use crate::{Pte, VmMeta, PPN};
use core::marker::PhantomData;

/// 页表项属性。
///
/// 页表项属性一定完全包含在页表项中，所以独立的页表项属性实现为一个无法获取地址的页表项。
#[derive(Clone, Copy, PartialEq, Eq, Hash, Debug)]
#[repr(transparent)]
pub struct VmFlags<Meta: VmMeta>(pub usize, PhantomData<Meta>);

impl<Meta: VmMeta> VmFlags<Meta> {
    /// 将 `raw` 整数转化为一个页表项属性。
    ///
    /// # Safety
    ///
    /// 调用者需要保证 `raw` 里不表示属性的位全是零。
    #[inline]
    pub const unsafe fn from_raw(raw: usize) -> Self {
        Self(raw, PhantomData)
    }

    /// 如果页表项指向一个页而非子页表，返回 `true`。
    #[inline]
    pub fn is_leaf(self) -> bool {
        Meta::is_leaf(self.0)
    }

    /// 如果页表项指向一个非 0 级的页，返回 `true`。
    #[inline]
    pub fn is_huge(self, level: usize) -> bool {
        Meta::is_huge(self.0, level)
    }

    /// 如果页表项有效，返回 `true`。
    #[inline]
    pub fn valid(self) -> bool {
        Meta::is_valid(self.0)
    }

    /// 构造具有 `self` 页表项属性，并指向 `ppn` 物理页的页表项。
    #[inline]
    pub fn build_pte(mut self, ppn: PPN<Meta>) -> Pte<Meta> {
        Meta::set_ppn(&mut self.0, ppn);
        Pte(self.0, PhantomData)
    }
}