Merge branch 'master' into net-dev
[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 <arch/types.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  *                     |          RO PAGES            | R-/R-  PTSIZE
38  *    UPAGES    ---->  +------------------------------+ 0xbf000000      --+
39  *                     |  Unmapped (future expansion) | --/--             |
40  *                     +------------------------------+ 0xbec01000      PTSIZE
41  *                     |     Per-Process R/O Info     | R-/R-  PGSIZE     |
42  * UTOP, UINFO  ---->  +------------------------------+ 0xbec00000      --+
43  *                     |     Async Syscall Ring       | RW/RW  PGSIZE     |
44  *   USYSCALL   ---->  +------------------------------+ 0xbebff000        |
45  *                     |     Async Sysevent Ring      | RW/RW  PGSIZE     |
46  *   USYSEVENT  ---->  +------------------------------+ 0xbebfe000      PTSIZE
47  *                     |      Global Shared Page      | RW/RW  PGSIZE     |
48  *     UGDATA   ---->  +------------------------------+ 0xbebfd000        |
49  *                     |  Unmapped (future expansion) | --/--             |
50  *   UXSTACKTOP ---->  +------------------------------+ 0xbe800000      --+
51  *                     |     User Exception Stack     | RW/RW  PGSIZE
52  *                     +------------------------------+ 0xbe7ff000
53  *                     |       Empty Memory (*)       | --/--  PGSIZE
54  *    USTACKTOP  --->  +------------------------------+ 0xbe7fe000
55  *                     |      Normal User Stack       | RW/RW  PGSIZE
56  *                     +------------------------------+ 0xbe7fd000
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 // All physical memory mapped at this address
84 #define KERNBASE        0xC0000000
85
86 // At IOPHYSMEM (640K) there is a 384K hole for I/O.  From the kernel,
87 // IOPHYSMEM can be addressed at KERNBASE + IOPHYSMEM.  The hole ends
88 // at physical address EXTPHYSMEM.
89 #define IOPHYSMEM       0x0A0000
90 #define VGAPHYSMEM      0x0A0000
91 #define DEVPHYSMEM      0x0C0000
92 #define BIOSPHYSMEM     0x0F0000
93 #define EXTPHYSMEM      0x100000
94
95 // Virtual page table.  Entry PDX(VPT) in the PD contains a pointer to
96 // the page directory itself, thereby turning the PD into a page table,
97 // which maps all the PTEs containing the page mappings for the entire
98 // virtual address space into that 4 Meg region starting at VPT.
99 #define VPT             (KERNBASE - PTSIZE)
100 #define KSTACKTOP       VPT
101 #define KSTKSHIFT       (PGSHIFT+3)             // KSTKSIZE == 8*PGSIZE
102 #define KSTKSIZE        (1 << KSTKSHIFT)        // size of a kernel stack
103 #define ULIM            (KSTACKTOP - PTSIZE)
104
105 /*
106  * User read-only mappings! Anything below here til UTOP are readonly to user.
107  * They are global pages mapped in at env allocation time.
108  */
109
110 // Same as VPT but read-only for users
111 #define UVPT            (ULIM - PTSIZE)
112 // Read-only copies of the Page structures
113 #define UPAGES          (UVPT - PTSIZE)
114 // Read-only, per-process shared info structures
115 #define UINFO           (UPAGES - PTSIZE)
116 #define UINFO_PAGES 1
117
118 /*
119  * Top of user VM. User can manipulate VA from UTOP-1 and down!
120  */
121
122 // Top of user-accessible VM
123 #define UTOP            UINFO
124
125 // Read-write, per-process shared page for sending asynchronous 
126 // syscalls to the kernel
127 #define USYSCALL    (UTOP - PGSIZE)
128
129 // Read-write, per-process shared page for receiving asynchronous 
130 // sysevents from the kernel
131 #define USYSEVENT   (USYSCALL - PGSIZE)
132
133 // Read-write, global page.  Shared by all processes.  Can't be trusted.
134 #define UGDATA   (USYSEVENT - PGSIZE)
135
136 // Top of one-page user exception stack
137 #define UXSTACKTOP      (UTOP - PTSIZE)
138 // Next page left invalid to guard against exception stack overflow; then:
139 // Top of normal user stack
140 #define USTACKTOP       (UXSTACKTOP - 2*PGSIZE)
141
142 // Where user programs generally begin
143 #define UTEXT           (2*PTSIZE)
144
145 // Used for temporary page mappings.  Typed 'void*' for convenience
146 #define UTEMP           ((void*) PTSIZE)
147 // Used for temporary page mappings for the user page-fault handler
148 // (should not conflict with other temporary page mappings)
149 #define PFTEMP          (UTEMP + PTSIZE - PGSIZE)
150 // The location of the user-level STABS data structure
151 #define USTABDATA       (PTSIZE / 2)
152
153
154 #ifndef __ASSEMBLER__
155
156 /*
157  * The page directory entry corresponding to the virtual address range
158  * [VPT, VPT + PTSIZE) points to the page directory itself.  Thus, the page
159  * directory is treated as a page table as well as a page directory.
160  *
161  * One result of treating the page directory as a page table is that all PTEs
162  * can be accessed through a "virtual page table" at virtual address VPT (to
163  * which vpt is set in entry.S).  The PTE for page number N is stored in
164  * vpt[N].  (It's worth drawing a diagram of this!)
165  *
166  * A second consequence is that the contents of the current page directory
167  * will always be available at virtual address (VPT + (VPT >> PGSHIFT)), to
168  * which vpd is set in entry.S.
169  */
170 typedef uint32_t pte_t;
171 typedef uint32_t pde_t;
172
173 extern volatile pte_t vpt[];     // VA of "virtual page table"
174 extern volatile pde_t vpd[];     // VA of current page directory
175
176 #endif /* !__ASSEMBLER__ */
177 #endif /* !ROS_INC_MEMLAYOUT_H */