renamed and cleaned up export header files to match linux convention
[lunaix-os.git] / lunaix-os / includes / lunaix / mm / mm.h
1 #ifndef __LUNAIX_MM_H
2 #define __LUNAIX_MM_H
3
4 #include <lunaix/types.h>
5 #include <lunaix/ds/llist.h>
6
7 #include <asm/pagetable.h>
8
9 #include <usr/lunaix/mman.h>
10
11 /**
12  * @brief 私有区域,该区域中的页无法进行任何形式的共享。
13  *
14  */
15 #define REGION_PRIVATE MAP_EXCLUSIVE
16
17 /**
18  * @brief
19  * 读共享区域,该区域中的页可以被两个进程之间读共享,但任何写操作须应用Copy-On-Write
20  * 等价于 POSIX 的 MAP_PRIVATE
21  *
22  */
23 #define REGION_RSHARED MAP_PRIVATE
24
25 /**
26  * @brief
27  * 写共享区域,该区域中的页可以被两个进程之间读共享,任何的写操作无需执行Copy-On-Write
28  * 等价于 POSIX 的 MAP_SHARED
29  */
30 #define REGION_WSHARED MAP_SHARED
31
32 #define REGION_PERM_MASK 0x1c
33 #define REGION_MODE_MASK 0x3
34
35 #define REGION_READ PROT_READ
36 #define REGION_WRITE PROT_WRITE
37 #define REGION_EXEC PROT_EXEC
38 #define REGION_ANON MAP_ANON
39 #define REGION_RW REGION_READ | REGION_WRITE
40 #define REGION_KERNEL (1 << 31)
41
42 #define REGION_TYPE_CODE (1 << 16)
43 #define REGION_TYPE_GENERAL (2 << 16)
44 #define REGION_TYPE_HEAP (3 << 16)
45 #define REGION_TYPE_STACK (4 << 16)
46 #define REGION_TYPE_VARS (5 << 16)
47
48 struct mm_region
49 {
50     struct llist_header head; // must be first field!
51     struct proc_mm* proc_vms;
52
53     // file mapped to this region
54     struct v_file* mfile;
55     // mapped file offset
56     off_t foff;
57     // mapped file length
58
59     ptr_t start;
60     ptr_t end;
61     u32_t attr;
62     size_t flen;
63
64     void** index; // fast reference, to accelerate access to this very region.
65
66     void* data;
67     // when a region is copied
68     void (*region_copied)(struct mm_region*);
69     // when a region is unmapped
70     void (*destruct_region)(struct mm_region*);
71 };
72
73
74 #endif /* __LUNAIX_MM_H */