refactor: one more step towards arch-agnostic design

[lunaix-os.git] / lunaix-os / includes / lunaix / mm / vmm.h

diff --git a/lunaix-os/includes/lunaix/mm/vmm.h b/lunaix-os/includes/lunaix/mm/vmm.h
index 844eb0ec31c61430c099e928da29e61f7141fb4f..3f102db3fe3d20b0ba3d4287f624f817422a97ac 100644 (file)
--- a/lunaix-os/includes/lunaix/mm/vmm.h
+++ b/lunaix-os/includes/lunaix/mm/vmm.h
@@ -1,10 +1,31 @@
 #ifndef __LUNAIX_VMM_H
 #define __LUNAIX_VMM_H
 #include <lunaix/mm/page.h>
+#include <lunaix/process.h>
 #include <stddef.h>
 #include <stdint.h>
 // Virtual memory manager
 
+#define VMAP_NULL 0
+
+/**
+ * @brief 映射模式：忽略已存在映射
+ *
+ */
+#define VMAP_IGNORE 1
+
+/**
+ * @brief 映射模式：不作实际映射。该功能用于预留出特定的地址空间
+ *
+ */
+#define VMAP_NOMAP 2
+
+/**
+ * @brief 规定下一个可用页映射应当限定在指定的4MB地址空间内
+ *
+ */
+#define VALLOC_PDE 1
+
 /**
  * @brief 初始化虚拟内存管理器
  *
@@ -21,86 +42,109 @@ x86_page_table*
 vmm_init_pd();
 
 /**
- * @brief 尝试建立一个映射关系。映射指定的物理页地址至虚拟页地址，如果指定的虚拟页地址已被占用
- * 则尝试寻找新的可用地址（改地址总是大于指定的地址）。
- *
- * @param vpn 虚拟页地址
- * @param pa 物理页地址
- * @param dattr PDE 的属性
- * @param tattr PTE 的属性
- * @return 虚拟页地址，如不成功，则为 NULL
+ * @brief 在指定地址空间中，添加一个映射
+ *
+ * @param mnt 地址空间挂载点
+ * @param va 虚拟地址
+ * @param pa 物理地址
+ * @param attr 映射属性
+ * @return int
  */
-void*
-vmm_map_page(void* va, void* pa, pt_attr tattr);
+int
+vmm_set_mapping(ptr_t mnt, ptr_t va, ptr_t pa, pt_attr attr, int options);
 
 /**
- * @brief 建立一个映射关系，映射指定的物理页地址至虚拟页地址。如果指定的虚拟页地址已被占用，
- * 则覆盖。
- *
- * @param va 虚拟页地址
- * @param pa 物理页地址
- * @param dattr PDE 的属性
- * @param tattr PTE 的属性
- * @return 虚拟页地址
+ * @brief 删除一个映射
+ *
+ * @param mnt
+ * @param pid
+ * @param va
+ * @return int
  */
-void*
-vmm_fmap_page(void* va, void* pa, pt_attr tattr);
+ptr_t
+vmm_del_mapping(ptr_t mnt, ptr_t va);
 
 /**
- * @brief å°\9dè¯\95为ä¸\80个è\99\9aæ\8b\9f页å\9c°å\9d\80å\88\9b建ä¸\80个å\8f¯ç\94¨ç\9a\84ç\89©ç\90\86页映射
+ * @brief å\9c¨å½\93å\89\8dè\99\9aæ\8b\9få\9c°å\9d\80空é\97´é\87\8cæ\9f¥æ\89¾ä¸\80个映射
  *
- * @param va 虚拟页地址
- * @return 物理页地址，如不成功，则为 NULL
+ * @param va 虚拟地址
+ * @param mapping 映射相关属性
  */
-void*
-vmm_alloc_page(void* va, pt_attr tattr);
-
+int
+vmm_lookup(ptr_t va, v_mapping* mapping);
 
 /**
- * @brief å°\9dè¯\95å\88\86é\85\8då¤\9a个è¿\9eç»­ç\9a\84è\99\9aæ\8b\9f页
- * 
- * @param va 起始虚拟地址
- * @param sz 大小（必须为4K对齐）
- * @param tattr 属性
- * @return int 是否成功
+ * @brief å\9c¨æ\8c\87å®\9aç\9a\84è\99\9aæ\8b\9få\9c°å\9d\80空é\97´é\87\8cæ\9f¥æ\89¾ä¸\80个æ\98 å°\84
+ *
+ * @param mnt 地址空间锚定点
+ * @param va 虚拟地址
+ * @param mapping 映射相关属性
+ * @return int
  */
 int
-vmm_alloc_pages(void* va, size_t sz, pt_attr tattr);
+vmm_lookupat(ptr_t mnt, ptr_t va, v_mapping* mapping);
 
 /**
- * @brief 设置一个映射，如果映射已存在，则忽略。
- * 
- * @param va 
- * @param pa 
- * @param attr 
+ * @brief (COW) 为虚拟页创建副本。
+ *
+ * @return void* 包含虚拟页副本的物理页地址。
+ *
  */
-void
-vmm_set_mapping(void* va, void* pa, pt_attr attr);
+ptr_t
+vmm_dup_page(pid_t pid, ptr_t pa);
+
+ptr_t
+vmm_dup_vmspace(pid_t pid);
 
 /**
- * @brief 删除一个映射
+ * @brief 挂载另一个虚拟地址空间至当前虚拟地址空间
  *
- * @param vpn
+ * @param pde 页目录的物理地址
+ * @return ptr_t
  */
-void
-vmm_unmap_page(void* va);
+ptr_t
+vmm_mount_pd(ptr_t mnt, ptr_t pde);
 
 /**
- * @brief å°\86è\99\9aæ\8b\9få\9c°å\9d\80ç¿»è¯\91为å\85¶å¯¹åº\94ç\9a\84ç\89©ç\90\86æ\98 å°\84
+ * @brief å\8d¸è½½å·²æ\8c\82è½½ç\9a\84è\99\9aæ\8b\9få\9c°å\9d\80空é\97´
  *
- * @param va 虚拟地址
- * @return void* 物理地址，如映射不存在，则为NULL
  */
+ptr_t
+vmm_unmount_pd(ptr_t mnt);
+
 void*
-vmm_v2p(void* va);
+vmm_ioremap(ptr_t paddr, size_t size);
+
+void*
+vmm_next_free(ptr_t start, int options);
+
+/**
+ * @brief 将连续的物理地址空间映射到内核虚拟地址空间
+ *
+ * @param paddr 物理地址空间的基地址
+ * @param size 物理地址空间的大小
+ * @return void*
+ */
+void*
+vmm_vmap(ptr_t paddr, size_t size, pt_attr attr);
+
+/**
+ * @brief 将当前地址空间的虚拟地址转译为物理地址。
+ *
+ * @param va 虚拟地址
+ * @return void*
+ */
+ptr_t
+vmm_v2p(ptr_t va);
 
 /**
- * @brief 查找一个映射
+ * @brief 将指定地址空间的虚拟地址转译为物理地址
  *
+ * @param mnt 地址空间锚定点
  * @param va 虚拟地址
- * @return v_mapping 映射相关属性
+ * @return void*
  */
-v_mapping
-vmm_lookup(void* va);
+ptr_t
+vmm_v2pat(ptr_t mnt, ptr_t va);
 
 #endif /* __LUNAIX_VMM_H */