refactor: one more step towards arch-agnostic design
[lunaix-os.git] / lunaix-os / includes / lunaix / mm / mm.h
1 #ifndef __LUNAIX_MM_H
2 #define __LUNAIX_MM_H
3
4 #include <lunaix/ds/llist.h>
5 #include <lunaix/ds/mutex.h>
6 #include <lunaix/fs.h>
7 #include <lunaix/types.h>
8
9 #include <usr/lunaix/mann_flags.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
41 #define REGION_TYPE_CODE (1 << 16)
42 #define REGION_TYPE_GENERAL (2 << 16)
43 #define REGION_TYPE_HEAP (3 << 16)
44 #define REGION_TYPE_STACK (4 << 16)
45 #define REGION_TYPE_VARS (5 << 16)
46
47 struct proc_mm;
48
49 struct mm_region
50 {
51     struct llist_header head; // must be first field!
52     struct proc_mm* proc_vms;
53
54     // file mapped to this region
55     struct v_file* mfile;
56     // mapped file offset
57     off_t foff;
58     // mapped file length
59     u32_t flen;
60
61     ptr_t start;
62     ptr_t end;
63     u32_t attr;
64
65     void** index; // fast reference, to accelerate access to this very region.
66
67     void* data;
68     // when a region is copied
69     void (*region_copied)(struct mm_region*);
70     // when a region is unmapped
71     void (*destruct_region)(struct mm_region*);
72 };
73
74 static inline void
75 mm_index(void** index, struct mm_region* target)
76 {
77     *index = (void*)target;
78     target->index = index;
79 }
80
81 typedef struct llist_header vm_regions_t;
82
83 struct proc_mm
84 {
85     vm_regions_t regions;
86     struct mm_region* heap;
87     struct mm_region* stack;
88     pid_t pid;
89 };
90
91 #endif /* __LUNAIX_MM_H */