Removed KSTACKTOP
[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 #endif /* not __ASSEMBLER__ */
7
8 #include <ros/arch/mmu.h>
9
10 /*
11  * This file contains definitions for memory management in our OS,
12  * which are relevant to both the kernel and user-mode software.
13  */
14
15 /* Note: this map is out of date, esp for the 64 bit layout */
16 /*
17  * Virtual memory map:                                Permissions
18  *                                                    kernel/user
19  *
20  *    4 Gig -------->  +------------------------------+
21  *                     |                              | RW/--
22  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  *                     :              .               :
24  *                     :              .               :
25  *                     :              .               :
26  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| RW/--
27  *                     |                              | RW/--
28  *                     |   Remapped Physical Memory   | RW/--
29  *                     |                              | RW/--
30  *    KERNBASE ----->  +------------------------------+ 0xc0000000
31  *                     |  Cur. Page Table (Kern. RW)  | RW/--  PTSIZE
32  *    VPT          --> +------------------------------+ 0xbfc00000      --+
33  *                     |                              |                   |
34  *                     |                              |                 PTSIZE
35  *                     |      Invalid Memory (*)      | --/--             |
36  *    ULIM      ---->  +------------------------------+ 0xbf800000      --+
37  *                     |  Cur. Page Table (User R-)   | R-/R-  PTSIZE
38  *    UVPT      ---->  +------------------------------+ 0xbf400000      --+
39  *                     | Unmapped (expandable region) |                   |
40  *                     |                              | R-/R-            PTSIZE
41  *                     |     Per-Process R/O Info     |                   |
42  * UTOP, UINFO  ---->  +------------------------------+ 0xbf000000      --+
43  *                     | Unmapped (expandable region) |                   |
44  *                     |                              | RW/RW            PTSIZE
45  *                     |     Per-Process R/W Data     |                   |
46  *    UDATA     ---->  +------------------------------+ 0xbec00000      --+
47  *    UMAPTOP,         |    Global Shared R/W Data    | RW/RW  PGSIZE
48  * UXSTACKTOP,UGDATA ->+------------------------------+ 0xbebff000
49  *                     |     User Exception Stack     | RW/RW  PGSIZE
50  *                     +------------------------------+ 0xbebfe000
51  *                     |       Empty Memory (*)       | --/--  PGSIZE
52  *    USTACKTOP  --->  +------------------------------+ 0xbebfd000
53  *                     |      Normal User Stack       | RW/RW  256*PGSIZE (1MB)
54  *                     +------------------------------+ 0xbeafd000
55  *                     |       Empty Memory (*)       | --/--  PGSIZE
56  *    USTACKBOT  --->  +------------------------------+ 0xbeafc000
57  *                     |                              |
58  *                     |                              |
59  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60  *                     .                              .
61  *                     .                              .
62  *                     .                              .
63  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
64  *                     |     Program Data & Heap      |
65  *    UTEXT -------->  +------------------------------+ 0x00800000
66  *    PFTEMP ------->  |       Empty Memory (*)       |        PTSIZE
67  *                     |                              |
68  *    UTEMP -------->  +------------------------------+ 0x00400000      --+
69  *                     |       Empty Memory (*)       |                   |
70  *                     | - - - - - - - - - - - - - - -|                   |
71  *                     |  User STAB Data (optional)   |                 PTSIZE
72  *    USTABDATA ---->  +------------------------------+ 0x00200000        |
73  *                     |       Empty Memory (*)       |                   |
74  *    0 ------------>  +------------------------------+                 --+
75  *
76  * (*) Note: The kernel ensures that "Invalid Memory" (ULIM) is *never*
77  *     mapped.  "Empty Memory" is normally unmapped, but user programs may
78  *     map pages there if desired.  ROS user programs map pages temporarily
79  *     at UTEMP.
80  */
81
82
83 // At IOPHYSMEM (640K) there is a 384K hole for I/O.  From the kernel,
84 // IOPHYSMEM can be addressed at KERNBASE + IOPHYSMEM.  The hole ends
85 // at physical address EXTPHYSMEM.
86 #define IOPHYSMEM       0x0A0000
87 #define VGAPHYSMEM      0x0A0000
88 #define DEVPHYSMEM      0x0C0000
89 #define BIOSPHYSMEM     0x0F0000
90 #define EXTPHYSMEM      0x100000
91
92 // Virtual page table.  Entry PDX(VPT) in the PD contains a pointer to
93 // the page directory itself, thereby turning the PD into a page table,
94 // which maps all the PTEs containing the page mappings for the entire
95 // virtual address space into that 4 Meg region starting at VPT.
96 #define VPT             (KERNBASE - PTSIZE)
97 #define KSTKSHIFT       (PGSHIFT+3)             // KSTKSIZE == 8*PGSIZE
98 #define KSTKSIZE        (1 << KSTKSHIFT)        // size of a kernel stack
99
100 /*
101  * User read-only mappings! Anything below here til UTOP are readonly to user.
102  * They are global pages mapped in at env allocation time.
103  */
104
105 // Same as VPT but read-only for users
106 #define UVPT            (ULIM - PTSIZE)
107
108 /*
109  * Top of user VM. User can manipulate VA from UTOP-1 and down!
110  */
111
112 // Top of user-accessible VM
113 #define UTOP            (UVPT - PTSIZE)
114 // Read-only, per-process shared info structures
115 #define UINFO           UTOP
116
117 // Read-write, per-process shared page for sending asynchronous 
118 // syscalls to the kernel
119 #define UDATA    (UTOP - PTSIZE)
120
121 // Read-write, global page.  Shared by all processes.  Can't be trusted.
122 #define UGDATA   (UDATA - PGSIZE)
123
124 // Top of one-page user exception stack
125 #define UXSTACKTOP      UGDATA
126 /* Limit of what is mmap()/munmap()-able */
127 #define UMAPTOP UXSTACKTOP
128 // Next page left invalid to guard against exception stack overflow; then:
129 // Top of normal user stack
130 #define USTACKTOP       (UXSTACKTOP - 2*PGSIZE)
131 // Maximum stack depth preallocated to 1MB
132 #define USTACK_NUM_PAGES        256
133 // Next page left invalid to guard against stack overflow
134 // Maximum bottom of normal user stack
135 #define USTACKBOT       (USTACKTOP - (USTACK_NUM_PAGES+1)*PGSIZE)
136
137 // Arbitrary boundary between the break and the start of
138 // memory returned by calls to mmap with addr = 0
139 #define BRK_END 0x40000000
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
170 #ifdef __IVY__
171 #pragma cilnoremove("vpt_lock", "vpd_lock")
172 #endif
173 extern volatile uint32_t vpt_lock;
174 extern volatile uint32_t vpd_lock;
175
176 extern volatile pte_t SLOCKED(&vpt_lock) (COUNT(PTSIZE) SREADONLY vpt)[]; // VA of "virtual page table"
177 extern volatile pde_t SLOCKED(&vpd_lock) (COUNT(PTSIZE) SREADONLY vpd)[]; // VA of current page directory
178
179 #endif /* !__ASSEMBLER__ */
180 #endif /* !ROS_INC_MEMLAYOUT_H */