Adding support for the brk system call
[akaros.git] / kern / include / ros / memlayout.h
1 #ifndef ROS_INC_MEMLAYOUT_H
2 #define ROS_INC_MEMLAYOUT_H
3
4 #ifndef __ASSEMBLER__
5 #include <ros/common.h>
6 #include <arch/mmu.h>
7 #endif /* not __ASSEMBLER__ */
8
9 /*
10  * This file contains definitions for memory management in our OS,
11  * which are relevant to both the kernel and user-mode software.
12  */
13
14 /*
15  * Virtual memory map:                                Permissions
16  *                                                    kernel/user
17  *
18  *    4 Gig -------->  +------------------------------+
19  *                     |                              | RW/--
20  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21  *                     :              .               :
22  *                     :              .               :
23  *                     :              .               :
24  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| RW/--
25  *                     |                              | RW/--
26  *                     |   Remapped Physical Memory   | RW/--
27  *                     |                              | RW/--
28  *    KERNBASE ----->  +------------------------------+ 0xc0000000
29  *                     |  Cur. Page Table (Kern. RW)  | RW/--  PTSIZE
30  *    VPT,KSTACKTOP--> +------------------------------+ 0xbfc00000      --+
31  *                     |         Kernel Stack         | RW/--  KSTKSIZE   |
32  *                     | - - - - - - - - - - - - - - -|                 PTSIZE
33  *                     |      Invalid Memory (*)      | --/--             |
34  *    ULIM      ---->  +------------------------------+ 0xbf800000      --+
35  *                     |  Cur. Page Table (User R-)   | R-/R-  PTSIZE
36  *    UVPT      ---->  +------------------------------+ 0xbf400000      --+
37  *                     | Unmapped (expandable region) |                   |
38  *                     |                              | R-/R-            PTSIZE
39  *                     |     Per-Process R/O Info     |                   |
40  * UTOP, UINFO  ---->  +------------------------------+ 0xbf000000      --+
41  *                     | Unmapped (expandable region) |                   |
42  *                     |                              | RW/RW            PTSIZE
43  *                     |     Per-Process R/W Data     |                   |
44  *    UDATA     ---->  +------------------------------+ 0xbec00000      --+
45  *                     |    Global Shared R/W Data    | RW/RW  PGSIZE
46  * UXSTACKTOP,UGDATA ->+------------------------------+ 0xbebff000
47  *                     |     User Exception Stack     | RW/RW  PGSIZE
48  *                     +------------------------------+ 0xbebfe000
49  *                     |       Empty Memory (*)       | --/--  PGSIZE
50  *    USTACKTOP  --->  +------------------------------+ 0xbebfd000
51  *                     |      Normal User Stack       | RW/RW  256*PGSIZE (1MB)
52  *                     +------------------------------+ 0xbeafd000
53  *                     |       Empty Memory (*)       | --/--  PGSIZE
54  *    USTACKBOT  --->  +------------------------------+ 0xbeafc000
55  *                     |                              |
56  *                     |                              |
57  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58  *                     .                              .
59  *                     .                              .
60  *                     .                              .
61  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
62  *                     |     Program Data & Heap      |
63  *    UTEXT -------->  +------------------------------+ 0x00800000
64  *    PFTEMP ------->  |       Empty Memory (*)       |        PTSIZE
65  *                     |                              |
66  *    UTEMP -------->  +------------------------------+ 0x00400000      --+
67  *                     |       Empty Memory (*)       |                   |
68  *                     | - - - - - - - - - - - - - - -|                   |
69  *                     |  User STAB Data (optional)   |                 PTSIZE
70  *    USTABDATA ---->  +------------------------------+ 0x00200000        |
71  *                     |       Empty Memory (*)       |                   |
72  *    0 ------------>  +------------------------------+                 --+
73  *
74  * (*) Note: The kernel ensures that "Invalid Memory" (ULIM) is *never*
75  *     mapped.  "Empty Memory" is normally unmapped, but user programs may
76  *     map pages there if desired.  ROS user programs map pages temporarily
77  *     at UTEMP.
78  */
79
80
81 // All physical memory mapped at this address
82 #define KERNBASE        0xC0000000
83
84 // Use this if needed in annotations
85 #define IVY_KERNBASE (0xC000U << 16)
86
87 // At IOPHYSMEM (640K) there is a 384K hole for I/O.  From the kernel,
88 // IOPHYSMEM can be addressed at KERNBASE + IOPHYSMEM.  The hole ends
89 // at physical address EXTPHYSMEM.
90 #define IOPHYSMEM       0x0A0000
91 #define VGAPHYSMEM      0x0A0000
92 #define DEVPHYSMEM      0x0C0000
93 #define BIOSPHYSMEM     0x0F0000
94 #define EXTPHYSMEM      0x100000
95
96 // Virtual page table.  Entry PDX(VPT) in the PD contains a pointer to
97 // the page directory itself, thereby turning the PD into a page table,
98 // which maps all the PTEs containing the page mappings for the entire
99 // virtual address space into that 4 Meg region starting at VPT.
100 #define VPT             (KERNBASE - PTSIZE)
101 #define KSTACKTOP       VPT
102 #define KSTKSHIFT       (PGSHIFT+3)             // KSTKSIZE == 8*PGSIZE
103 #define KSTKSIZE        (1 << KSTKSHIFT)        // size of a kernel stack
104 #define ULIM            (KSTACKTOP - PTSIZE)
105
106 /*
107  * User read-only mappings! Anything below here til UTOP are readonly to user.
108  * They are global pages mapped in at env allocation time.
109  */
110
111 // Same as VPT but read-only for users
112 #define UVPT            (ULIM - PTSIZE)
113
114 /*
115  * Top of user VM. User can manipulate VA from UTOP-1 and down!
116  */
117
118 // Top of user-accessible VM
119 #define UTOP            (UVPT - PTSIZE)
120 // Read-only, per-process shared info structures
121 #define UINFO           UTOP
122
123 // Read-write, per-process shared page for sending asynchronous 
124 // syscalls to the kernel
125 #define UDATA    (UTOP - PTSIZE)
126
127 // Read-write, global page.  Shared by all processes.  Can't be trusted.
128 #define UGDATA   (UDATA - PGSIZE)
129
130 // Top of one-page user exception stack
131 #define UXSTACKTOP      UGDATA
132 // Next page left invalid to guard against exception stack overflow; then:
133 // Top of normal user stack
134 #define USTACKTOP       (UXSTACKTOP - 2*PGSIZE)
135 // Maximum stack depth preallocated to 1MB
136 #define USTACK_NUM_PAGES        256
137 // Next page left invalid to guard against stack overflow
138 // Maximum bottom of normal user stack
139 #define USTACKBOT       (USTACKTOP - (USTACK_NUM_PAGES+1)*PGSIZE)
140
141 // Where user programs generally begin
142 #define UTEXT           (2*PTSIZE)
143
144 // Used for temporary page mappings.  Typed 'void*' for convenience
145 #define UTEMP           ((void*) PTSIZE)
146 // Used for temporary page mappings for the user page-fault handler
147 // (should not conflict with other temporary page mappings)
148 #define PFTEMP          (UTEMP + PTSIZE - PGSIZE)
149 // The location of the user-level STABS data structure
150 #define USTABDATA       (PTSIZE / 2)
151
152
153 #ifndef __ASSEMBLER__
154
155 /*
156  * The page directory entry corresponding to the virtual address range
157  * [VPT, VPT + PTSIZE) points to the page directory itself.  Thus, the page
158  * directory is treated as a page table as well as a page directory.
159  *
160  * One result of treating the page directory as a page table is that all PTEs
161  * can be accessed through a "virtual page table" at virtual address VPT (to
162  * which vpt is set in entry.S).  The PTE for page number N is stored in
163  * vpt[N].  (It's worth drawing a diagram of this!)
164  *
165  * A second consequence is that the contents of the current page directory
166  * will always be available at virtual address (VPT + (VPT >> PGSHIFT)), to
167  * which vpd is set in entry.S.
168  */
169 typedef uint32_t pte_t;
170 typedef uint32_t pde_t;
171
172 #ifdef __IVY__
173 #pragma cilnoremove("vpt_lock", "vpd_lock")
174 #endif
175 extern volatile uint32_t vpt_lock;
176 extern volatile uint32_t vpd_lock;
177
178 extern volatile pte_t SLOCKED(&vpt_lock) (COUNT(PTSIZE) SREADONLY vpt)[]; // VA of "virtual page table"
179 extern volatile pde_t SLOCKED(&vpd_lock) (COUNT(PTSIZE) SREADONLY vpd)[]; // VA of current page directory
180
181 #endif /* !__ASSEMBLER__ */
182 #endif /* !ROS_INC_MEMLAYOUT_H */